refined the routing for the changelog info api & latest will now only be cached for 2 hours while versioned stays 24 hours

Author: WilcoSp

app/composables/usePackageChangelog.ts

@@ -8,7 +8,6 @@ export function usePackageChangelog(
     const name = toValue(packageName)
     if (!name) return 'data:text/json,null' // returns null
     const ver = toValue(version)
-    const base = `/api/changelog/info/${name}`
-    return ver ? `${base}/v/${ver}` : base
+    return `/api/changelog/info/${name}/v/${ver || 'latest'}`
   })
 }

app/pages/package-changelog/[[org]]/[name].vue

@@ -170,13 +170,11 @@ defineOgImageComponent('Default', {
               :viewOnGit
             />
           </LazyChangelogMarkdown>
-
-          <!-- <p class="mt-5" v-else-></p> -->
         </template>
         <template #fallback>
           <section class="flex flex-col gap-2 py-3">
             <SkeletonBlock class="h-8 w-40 rounded" />
-            <ul class="ms-3 list-disc my-[1rem] ps-[1.5rem] marker:color-[--border-hover]">
+            <ul class="ms-3 list-disc my-[1rem] ps-[1.5rem] marker:color-border-hover">
               <li class="mb-1" v-for="_n in 5">
                 <SkeletonBlock class="h-7 w-full max-w-2xl rounded" />
               </li>

server/api/changelog/info/[...pkg].get.ts

@@ -0,0 +1,45 @@
+import type { ExtendedPackageJson } from '#shared/utils/package-analysis'
+import { VersionSchema, PackageNameSchema } from '#shared/schemas/package'
+import { ERROR_PACKAGE_DETECT_CHANGELOG, NPM_REGISTRY } from '#shared/utils/constants'
+import * as v from 'valibot'
+import { detectChangelog } from '~~/server/utils/changelog/detectChangelog'
+
+function getChangelogRouteParams(event: Parameters<typeof getRouterParam>[0]) {
+  const org = getRouterParam(event, 'org')
+  const name = getRouterParam(event, 'name')
+  const rawVersion = getRouterParam(event, 'version')
+  const rawPackageName = org ? `${org}/${name}` : name
+
+  return { rawVersion, rawPackageName }
+}
+
+// setting cache options
+export const defaultChangelogCacheOptions: Parameters<typeof defineCachedEventHandler>[1] = {
+  maxAge: CACHE_MAX_AGE_ONE_DAY, // 24 hours
+  swr: true,
+  getKey: event => {
+    const { rawPackageName = '', rawVersion = 'latest' } = getChangelogRouteParams(event)
+    return `changelogInfo:v1:${rawPackageName.trim().replaceAll('/', ':')}:${rawVersion.trim()}`
+  },
+  shouldBypassCache: () => import.meta.dev,
+}
+
+// handler
+export default defineCachedEventHandler(async event => {
+  const { rawPackageName, rawVersion } = getChangelogRouteParams(event)
+
+  try {
+    const packageName = v.parse(PackageNameSchema, rawPackageName)
+    const version = v.parse(v.optional(VersionSchema), rawVersion)
+    const encodedName = encodePackageName(packageName)
+    const versionSuffix = version ? `/${version}` : '/latest'
+    const pkg = await $fetch<ExtendedPackageJson>(`${NPM_REGISTRY}/${encodedName}${versionSuffix}`)
+
+    return await detectChangelog(pkg)
+  } catch (error) {
+    handleApiError(error, {
+      statusCode: 502,
+      message: ERROR_PACKAGE_DETECT_CHANGELOG,
+    })
+  }
+}, defaultChangelogCacheOptions)

server/api/changelog/info/[name]/v/[version].get.ts

@@ -0,0 +1,6 @@
+import eventHandler, { defaultChangelogCacheOptions } from './[version].get'
+
+export default defineCachedEventHandler(eventHandler, {
+  ...defaultChangelogCacheOptions,
+  maxAge: CACHE_MAX_AGE_ONE_HOUR * 2,
+})

server/api/changelog/info/[name]/v/latest.get.ts

@@ -0,0 +1 @@
+export { default } from '../../../[name]/v/[version].get'

server/api/changelog/info/[org]/[name]/v/[version].get.ts

@@ -0,0 +1 @@
+export { default } from '../../../[name]/v/latest.get'

server/api/changelog/info/[org]/[name]/v/latest.get.ts

@@ -19,7 +19,7 @@ export const PackageNameSchema = v.pipe(
  * Enforces a SemVer-like pattern to prevent directory traversal or complex injection attacks
  * includes: alphanumeric, dots, underscores, dashes, and plus signs (for build metadata)
  */
-const VersionSchema = v.pipe(
+export const VersionSchema = v.pipe(
   v.string(),
   v.nonEmpty('Version is required'),
   v.regex(/^[\w.+-]+$/, 'Invalid version format'),