Files
shields/services/pub/pub.service.js
T
jNullj cb34c2fb62 refactor: rename deprecatedService to retiredService [*****] (#11803)
* refactor: rename deprecatedService to retiredService

- Updated all instances of deprecatedService to retiredService in service implementations, tests, and documentation.
- Changed attribute names from isDeprecated to isRetired in relevant schemas and service definitions.
- Adjusted tests and documentation to reflect the new terminology and ensure consistency.

* docs: rename deprecating-badges.md to retiring-badges.md

* refactor: rename files deprecated-service to retired-service

* refactor: update terminology from deprecated to retired in badge documentation
2026-05-10 23:11:05 +03:00

80 lines
1.8 KiB
JavaScript

import Joi from 'joi'
import { latest, renderVersionBadge } from '../version.js'
import {
BaseJsonService,
retiredService,
pathParam,
queryParam,
} from '../index.js'
import { baseDescription } from './pub-common.js'
const schema = Joi.object({
versions: Joi.array()
.items(Joi.object({ version: Joi.string().required() }))
.required(),
}).required()
const queryParamSchema = Joi.object({
include_prereleases: Joi.equal(''),
}).required()
class PubVersion extends BaseJsonService {
static category = 'version'
static route = {
base: 'pub/v',
pattern: ':packageName',
queryParamSchema,
}
static openApi = {
'/pub/v/{packageName}': {
get: {
summary: 'Pub Version',
description: baseDescription,
parameters: [
pathParam({
name: 'packageName',
example: 'box2d',
}),
queryParam({
name: 'include_prereleases',
schema: { type: 'boolean' },
example: null,
}),
],
},
},
}
static defaultBadgeData = { label: 'pub' }
async fetch({ packageName }) {
return this._requestJson({
schema,
url: `https://pub.dev/api/packages/${packageName}`,
})
}
async handle({ packageName }, queryParams) {
const data = await this.fetch({ packageName })
const includePre = queryParams.include_prereleases !== undefined
const versions = data.versions.map(x => x.version)
const version = latest(versions, { pre: includePre })
return renderVersionBadge({ version })
}
}
const PubVersionRedirector = retiredService({
category: 'version',
label: 'pub',
route: {
base: 'pub/vpre',
pattern: ':packageName',
},
dateAdded: new Date('2025-12-20'),
issueUrl: 'https://github.com/badges/shields/pull/11583',
})
export { PubVersion, PubVersionRedirector }