feat: update

Author: btea

docs/content/2.guide/1.features.md

@@ -158,19 +158,26 @@ Make sure to replace `TYPE` with one of the options listed below and `YOUR_PACKA
 
 You can further customize your badges by appending query parameters to the badge URL.
 
-##### `colorA`
+##### `labelColor`
 
 Overrides the default label color. You can pass a standard hex code (with or without the `#` prefix).
 
 - **Default**: `#0a0a0a`
-- **Usage**: `?colorA=HEX_CODE`
+- **Usage**: `?labelColor=HEX_CODE`
 
-##### `colorB`
+##### `label`
+
+Overrides the default label text. You can pass any string to customize the label displayed on the badge.
+
+- **Default**: Depends on the badge type (e.g., "version", "downloads/mo").
+- **Usage**: `?label=YOUR_LABEL`
+
+##### `color`
 
 Overrides the default strategy color. You can pass a standard hex code (with or without the `#` prefix).
 
 - **Default**: Depends on the badge type (e.g., version is blue, downloads are orange).
-- **Usage**: `?colorB=HEX_CODE`
+- **Usage**: `?color=HEX_CODE`
 
 | Example        | URL                                    |
 | :------------- | :------------------------------------- |

server/api/registry/badge/[type]/[...pkg].get.ts

@@ -12,9 +12,10 @@ const BUNDLEPHOBIA_API = 'https://bundlephobia.com/api/size'
 const NPMS_API = 'https://api.npms.io/v2/package'
 
 const QUERY_SCHEMA = v.object({
-  colorA: v.optional(v.string()),
+  color: v.optional(v.string()),
   name: v.optional(v.string()),
-  colorB: v.optional(v.string()),
+  labelColor: v.optional(v.string()),
+  label: v.optional(v.string()),
 })
 
 const COLORS = {
@@ -263,9 +264,10 @@ export default defineCachedEventHandler(
       })
 
       const queryParams = v.safeParse(QUERY_SCHEMA, query)
-      const userColor = queryParams.success ? queryParams.output.colorB : undefined
-      const userColorLeft = queryParams.success ? queryParams.output.colorA : undefined
+      const userColor = queryParams.success ? queryParams.output.color : undefined
+      const labelColor = queryParams.success ? queryParams.output.labelColor : undefined
       const showName = queryParams.success && queryParams.output.name === 'true'
+      const userLabel = queryParams.success ? queryParams.output.label : undefined
 
       const badgeTypeResult = v.safeParse(BadgeTypeSchema, typeParam)
       const strategyKey = badgeTypeResult.success ? badgeTypeResult.output : 'version'
@@ -276,13 +278,13 @@ export default defineCachedEventHandler(
       const pkgData = await fetchNpmPackage(packageName)
       const strategyResult = await strategy(pkgData, requestedVersion)
 
-      const finalLabel = showName ? packageName : strategyResult.label
+      const finalLabel = userLabel ? userLabel : showName ? packageName : strategyResult.label
       const finalValue = strategyResult.value
 
       const rawColor = userColor ?? strategyResult.color
       const finalColor = rawColor?.startsWith('#') ? rawColor : `#${rawColor}`
 
-      const rawLeftColor = userColorLeft ?? '#0a0a0a'
+      const rawLeftColor = labelColor ?? '#0a0a0a'
       const finalLeftColor = rawLeftColor?.startsWith('#') ? rawLeftColor : `#${rawLeftColor}`
 
       const leftWidth = measureTextWidth(finalLabel)

test/e2e/badge.spec.ts

@@ -102,22 +102,30 @@ test.describe('badge API', () => {
     })
   })
 
-  test('custom colorA parameter is applied to SVG', async ({ page, baseURL }) => {
+  test('custom labelColor parameter is applied to SVG', async ({ page, baseURL }) => {
     const customColor = '00ff00'
-    const url = toLocalUrl(baseURL, `/api/registry/badge/version/nuxt?colorA=${customColor}`)
+    const url = toLocalUrl(baseURL, `/api/registry/badge/version/nuxt?labelColor=${customColor}`)
     const { body } = await fetchBadge(page, url)
 
     expect(body).toContain(`fill="#${customColor}"`)
   })
 
-  test('custom colorB parameter is applied to SVG', async ({ page, baseURL }) => {
+  test('custom color parameter is applied to SVG', async ({ page, baseURL }) => {
     const customColor = 'ff69b4'
-    const url = toLocalUrl(baseURL, `/api/registry/badge/version/nuxt?colorB=${customColor}`)
+    const url = toLocalUrl(baseURL, `/api/registry/badge/version/nuxt?color=${customColor}`)
     const { body } = await fetchBadge(page, url)
 
     expect(body).toContain(`fill="#${customColor}"`)
   })
 
+  test('custom label parameter is applied to SVG', async ({ page, baseURL }) => {
+    const customLabel = 'my-label'
+    const url = toLocalUrl(baseURL, `/api/registry/badge/version/nuxt?label=${customLabel}`)
+    const { body } = await fetchBadge(page, url)
+
+    expect(body).toContain(customLabel)
+  })
+
   test('invalid badge type defaults to version strategy', async ({ page, baseURL }) => {
     const url = toLocalUrl(baseURL, '/api/registry/badge/invalid-type/nuxt')
     const { body } = await fetchBadge(page, url)