feat: global version category prefix query param [amo archlinux aur bower cdnjs chromewebstore cocoapods conan conda cookbook cpan cran crates ctan curseforge debian dockerVersion dub eclipsemarketplace elmpackage f-droid factorio fedora feedz flathub galaxytoolshed gem gitea]

core/base-service/base.js

@@ -20,7 +20,7 @@ import {
   Deprecated,
 } from './errors.js'
 import { fetch } from './got.js'
-import { getEnum } from './openapi.js'
+import { getEnum, categoryGlobalQueryParams } from './openapi.js'
 import {
   makeFullUrl,
   assertValidRoute,
@@ -203,6 +203,25 @@ class BaseService {
     }
   }
 
+  static addGlobalCategoryQueryParams() {
+    if (!categoryGlobalQueryParams[this.category.toLowerCase()]) {
+      return
+    }
+    for (const path of Object.values(this.openApi)) {
+      path?.get?.parameters.push(
+        ...categoryGlobalQueryParams[this.category.toLowerCase()].openApiParams,
+      )
+    }
+    if (this.route.queryParamSchema) {
+      this.route.queryParamSchema = this.route.queryParamSchema.concat(
+        categoryGlobalQueryParams[this.category.toLowerCase()].joiSchema,
+      )
+    } else {
+      this.route.queryParamSchema =
+        categoryGlobalQueryParams[this.category.toLowerCase()].joiSchema
+    }
+  }
+
   static getDefinition() {
     const { category, name, isDeprecated, openApi } = this
     const { base, format, pattern } = this.route

core/base-service/loader.js

@@ -67,6 +67,8 @@ async function loadServiceClasses(servicePaths) {
         serviceClass.serviceFamily = servicePath
           .replace(serviceDir, '')
           .split(path.sep)[1]
+        // add global category specific query params
+        serviceClass.addGlobalCategoryQueryParams()
         serviceClass.validateDefinition()
         return serviceClasses.push(serviceClass)
       }

core/base-service/openapi.js

@@ -1,3 +1,5 @@
+import Joi from 'joi'
+
 /**
  * Functions for publishing the shields.io URL schema as an OpenAPI Document
  *
@@ -17,6 +19,21 @@ const globalParamRefs = [
   { $ref: '#/components/parameters/link' },
 ]
 
+const categoryGlobalQueryParams = {
+  version: {
+    openApiParams: queryParams({
+      name: 'versionPrefix',
+      example: 'v',
+      schema: { type: 'string' },
+      description:
+        'Overide version prefix. Can be used to remove default v prefix or replace it.',
+    }),
+    joiSchema: Joi.object({
+      versionPrefix: Joi.string(),
+    }).required(),
+  },
+}
+
 function getCodeSamples(altText) {
   return [
     {
@@ -72,18 +89,37 @@ function addGlobalProperties(endpoints) {
   return paths
 }
 
+function addCategoryProperties(endpoints, category) {
+  if (!categoryGlobalQueryParams[category.name.toLowerCase()]) {
+    return endpoints
+  }
+  const paths = {}
+  for (const key of Object.keys(endpoints)) {
+    paths[key] = endpoints[key]
+    const additionalParams =
+      categoryGlobalQueryParams[category.name.toLowerCase()]?.openApiParams ||
+      []
+    paths[key].get.parameters = [
+      ...paths[key].get.parameters,
+      ...additionalParams,
+    ]
+    paths[key].get['x-code-samples'] = getCodeSamples(paths[key].get.summary)
+  }
+  return paths
+}
+
 function sortPaths(obj) {
   const entries = Object.entries(obj)
   entries.sort((a, b) => a[1].get.summary.localeCompare(b[1].get.summary))
   return Object.fromEntries(entries)
 }
 
-function services2openapi(services, sort) {
+function services2openapi(services, category, sort) {
   const paths = {}
   for (const service of services) {
-    for (const [key, value] of Object.entries(
-      addGlobalProperties(service.openApi),
-    )) {
+    let servicePaths = addCategoryProperties(service.openApi, category)
+    servicePaths = addGlobalProperties(servicePaths)
+    for (const [key, value] of Object.entries(servicePaths)) {
       if (key in paths) {
         throw new Error(`Conflicting route: ${key}`)
       }
@@ -214,7 +250,7 @@ function category2openapi({ category, services, sort = false }) {
         },
       },
     },
-    paths: services2openapi(services, sort),
+    paths: services2openapi(services, category, sort),
   }
 
   return spec
@@ -355,4 +391,5 @@ export {
   pathParams,
   queryParam,
   queryParams,
+  categoryGlobalQueryParams,
 }

services/amo/amo-version.service.js

@@ -16,8 +16,11 @@ export default class AmoVersion extends BaseAmoService {
     },
   }
 
-  async handle({ addonId }) {
+  async handle({ addonId }, { versionPrefix }) {
     const data = await this.fetch({ addonId })
-    return renderVersionBadge({ version: data.current_version.version })
+    return renderVersionBadge({
+      version: data.current_version.version,
+      prefix: versionPrefix,
+    })
   }
 }

services/archlinux/archlinux.service.js

@@ -37,7 +37,7 @@ export default class ArchLinux extends BaseJsonService {
 
   static defaultBadgeData = { label: 'arch linux' }
 
-  async handle({ repository, architecture, packageName }) {
+  async handle({ repository, architecture, packageName }, { versionPrefix }) {
     const data = await this._requestJson({
       schema,
       url: `https://www.archlinux.org/packages/${encodeURIComponent(
@@ -46,6 +46,6 @@ export default class ArchLinux extends BaseJsonService {
         packageName,
       )}/json/`,
     })
-    return renderVersionBadge({ version: data.pkgver })
+    return renderVersionBadge({ version: data.pkgver, prefix: versionPrefix })
   }
 }

services/aur/aur.service.js

@@ -169,18 +169,23 @@ class AurVersion extends BaseAurService {
 
   static _cacheLength = 3600
 
-  static render({ version, outOfDate }) {
+  static render({ version, outOfDate, versionPrefix }) {
     const color = outOfDate === null ? 'blue' : 'orange'
-    return renderVersionBadge({ version, versionFormatter: () => color })
+    return renderVersionBadge({
+      version,
+      versionFormatter: () => color,
+      prefix: versionPrefix,
+    })
   }
 
-  async handle({ packageName }) {
+  async handle({ packageName }, { versionPrefix }) {
     const {
       results: [{ Version: version, OutOfDate: outOfDate }],
     } = await this.fetch({ packageName })
     return this.constructor.render({
       version,
       outOfDate,
+      versionPrefix,
     })
   }
 }

services/bower/bower-version.service.js

@@ -30,10 +30,10 @@ export default class BowerVersion extends BaseBowerService {
     return version
   }
 
-  async handle({ packageName }) {
+  async handle({ packageName }, { versionPrefix }) {
     const data = await this.fetch({ packageName })
     const version = this.constructor.transform(data)
 
-    return renderVersionBadge({ version })
+    return renderVersionBadge({ version, prefix: versionPrefix })
   }
 }

services/cdnjs/cdnjs.service.js

@@ -25,10 +25,6 @@ export default class Cdnjs extends BaseJsonService {
 
   static defaultBadgeData = { label: 'cdnjs' }
 
-  static render({ version }) {
-    return renderVersionBadge({ version })
-  }
-
   async fetch({ library }) {
     const url = `https://api.cdnjs.com/libraries/${library}?fields=version`
     return this._requestJson({
@@ -37,7 +33,7 @@ export default class Cdnjs extends BaseJsonService {
     })
   }
 
-  async handle({ library }) {
+  async handle({ library }, { versionPrefix }) {
     const json = await this.fetch({ library })
 
     if (Object.keys(json).length === 0) {
@@ -46,6 +42,6 @@ export default class Cdnjs extends BaseJsonService {
       throw new NotFound()
     }
 
-    return this.constructor.render({ version: json.version })
+    return renderVersionBadge({ version: json.version, prefix: versionPrefix })
   }
 }

services/chrome-web-store/chrome-web-store-version.service.js

@@ -20,12 +20,12 @@ export default class ChromeWebStoreVersion extends BaseChromeWebStoreService {
 
   static defaultBadgeData = { label: 'chrome web store' }
 
-  async handle({ storeId }) {
+  async handle({ storeId }, { versionPrefix }) {
     const chromeWebStore = await this.fetch({ storeId })
     const version = chromeWebStore.version()
     if (version == null) {
       throw new NotFound({ prettyMessage: 'not found' })
     }
-    return renderVersionBadge({ version })
+    return renderVersionBadge({ version, prefix: versionPrefix })
   }
 }

services/cocoapods/cocoapods-version.service.js

@@ -20,8 +20,8 @@ export default class CocoapodsVersion extends BaseCocoaPodsService {
 
   static defaultBadgeData = { label: 'pod' }
 
-  async handle({ spec }) {
+  async handle({ spec }, { versionPrefix }) {
     const { version } = await this.fetch({ spec })
-    return renderVersionBadge({ version })
+    return renderVersionBadge({ version, prefix: versionPrefix })
   }
 }

services/conan/conan-version.service.js

@@ -24,7 +24,7 @@ export default class ConanVersion extends ConditionalGithubAuthV3Service {
 
   static defaultBadgeData = { label: 'conan' }
 
-  async handle({ packageName }) {
+  async handle({ packageName }, { versionPrefix }) {
     const configContent = await fetchRepoContent(this, {
       user: 'conan-io',
       repo: 'conan-center-index',
@@ -34,6 +34,6 @@ export default class ConanVersion extends ConditionalGithubAuthV3Service {
 
     const version = parseLatestVersionFromConfig(configContent)
 
-    return renderVersionBadge({ version })
+    return renderVersionBadge({ version, prefix: versionPrefix })
   }
 }

services/conda/conda-version.service.js

@@ -32,12 +32,13 @@ export default class CondaVersion extends BaseCondaService {
     },
   }
 
-  async handle({ variant, channel, packageName }) {
+  async handle({ variant, channel, packageName }, { versionPrefix }) {
     const json = await this.fetch({ channel, packageName })
     const defaultLabel = variant === 'vn' ? channel : `conda | ${channel}`
     return renderVersionBadge({
       version: json.latest_version,
       defaultLabel,
+      prefix: versionPrefix,
     })
   }
 }

services/cookbook/cookbook.service.js

@@ -27,8 +27,8 @@ export default class Cookbook extends BaseJsonService {
     return this._requestJson({ schema, url })
   }
 
-  async handle({ cookbook }) {
+  async handle({ cookbook }, { versionPrefix }) {
     const { version } = await this.fetch({ cookbook })
-    return renderVersionBadge({ version })
+    return renderVersionBadge({ version, prefix: versionPrefix })
   }
 }

services/cpan/cpan-version.service.js

@@ -19,8 +19,8 @@ export default class CpanVersion extends BaseCpanService {
     },
   }
 
-  async handle({ packageName }) {
+  async handle({ packageName }, { versionPrefix }) {
     const { version } = await this.fetch({ packageName })
-    return renderVersionBadge({ version })
+    return renderVersionBadge({ version, prefix: versionPrefix })
   }
 }

services/cran/cran.service.js

@@ -62,13 +62,9 @@ class CranVersion extends BaseCranService {
     },
   }
 
-  static render({ version }) {
-    return renderVersionBadge({ version })
-  }
-
-  async handle({ packageName }) {
+  async handle({ packageName }, { versionPrefix }) {
     const data = await this.fetch({ packageName })
-    return this.constructor.render({ version: data.Version })
+    return renderVersionBadge({ version: data.Version, prefix: versionPrefix })
   }
 }
 

services/crates/crates-version.service.js

@@ -19,9 +19,9 @@ export default class CratesVersion extends BaseCratesService {
     },
   }
 
-  async handle({ crate }) {
+  async handle({ crate }, { versionPrefix }) {
     const json = await this.fetch({ crate })
     const version = this.constructor.getLatestVersion(json)
-    return renderVersionBadge({ version })
+    return renderVersionBadge({ version, prefix: versionPrefix })
   }
 }

services/ctan/ctan.service.js

@@ -72,21 +72,18 @@ class CtanVersion extends BaseCtanService {
     },
   }
 
-  static render({ version }) {
-    return renderVersionBadge({ version })
-  }
-
-  async handle({ library }) {
+  async handle({ library }, { versionPrefix }) {
     const json = await this.fetch({ library })
     const version = json.version.number
     if (version !== '') {
-      return renderVersionBadge({ version })
+      return renderVersionBadge({ version, prefix: versionPrefix })
     } else {
       const date = json.version.date
       if (date !== '') {
         return renderVersionBadge({
           version: date,
           versionFormatter: color => 'blue',
+          prefix: versionPrefix,
         })
       } else {
         return new InvalidResponse({

services/curseforge/curseforge-version.service.js

@@ -25,8 +25,8 @@ export default class CurseForgeVersion extends BaseCurseForgeService {
 
   static defaultBadgeData = { label: 'version' }
 
-  async handle({ projectId }) {
+  async handle({ projectId }, { versionPrefix }) {
     const { version } = await this.fetchMod({ projectId })
-    return renderVersionBadge({ version })
+    return renderVersionBadge({ version, prefix: versionPrefix })
   }
 }

services/debian/debian.service.js

@@ -57,7 +57,10 @@ export default class Debian extends BaseJsonService {
 
   static defaultBadgeData = { label: 'debian' }
 
-  async handle({ packageName, distribution = defaultDistribution }) {
+  async handle(
+    { packageName, distribution = defaultDistribution },
+    { versionPrefix },
+  ) {
     const data = await this._requestJson({
       schema,
       url: 'https://api.ftp-master.debian.org/madison',
@@ -84,6 +87,9 @@ export default class Debian extends BaseJsonService {
       throw new NotFound()
     }
     const versions = Object.keys(packageData[distKeys[0]])
-    return renderVersionBadge({ version: latest(versions) })
+    return renderVersionBadge({
+      version: latest(versions),
+      prefix: versionPrefix,
+    })
   }
 }