the changelog info api endpoint will now give the info when a changelog.md is being used.

Author: WilcoSp

app/composables/usePackageChangelog.ts

@@ -4,7 +4,7 @@ export function usePackageChangelog(
   packageName: MaybeRefOrGetter<string>,
   version?: MaybeRefOrGetter<string | null | undefined>,
 ) {
-  return useLazyFetch<ChangelogInfo | false>(() => {
+  return useLazyFetch<ChangelogInfo>(() => {
     const name = toValue(packageName)
     const ver = toValue(version)
     const base = `/api/changelog/info/${name}`

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

@@ -195,7 +195,11 @@ const { data: skillsData } = useLazyFetch<SkillsListResponse>(
 
 const { data: packageAnalysis } = usePackageAnalysis(packageName, requestedVersion)
 const { data: moduleReplacement } = useModuleReplacement(packageName)
-const { data: hasChangelog } = usePackageChangelog(packageName, requestedVersion)
+const { data: changelog } = usePackageChangelog(packageName, requestedVersion)
+
+const hasChangelog = computed(
+  () => changelog.value?.type == 'release' || changelog.value?.type == 'md',
+)
 
 const {
   data: resolvedVersion,
@@ -883,7 +887,7 @@ const showSkeleton = shallowRef(false)
                 {{ $t('package.links.issues') }}
               </LinkBase>
             </li>
-            <li v-if="!!hasChangelog && resolvedVersion">
+            <li v-if="!!changelog && resolvedVersion">
               <LinkBase
                 classicon="i-carbon:warning"
                 :to="{ name: 'changes', params: { path: [pkg.name, 'v', resolvedVersion] } }"

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

@@ -31,12 +31,12 @@ export default defineCachedEventHandler(
       })
     }
   },
-  // {
-  //   maxAge: CACHE_MAX_AGE_ONE_DAY, // 24 hours - analysis rarely changes
-  //   swr: true,
-  //   getKey: event => {
-  //     const pkg = getRouterParam(event, 'pkg') ?? ''
-  //     return `changelog:v1:${pkg.replace(/\/+$/, '').trim()}`
-  //   },
-  // },
+  {
+    maxAge: CACHE_MAX_AGE_ONE_DAY, // 24 hours
+    swr: true,
+    getKey: event => {
+      const pkg = getRouterParam(event, 'pkg') ?? ''
+      return `changelogInfo:pr1:${pkg.replace(/\/+$/, '').trim()}`
+    },
+  },
 )

server/api/changelog/releases/[provider]/[owner]/[repo].ts

@@ -52,7 +52,7 @@ async function getReleasesFromGithub(owner: string, repo: string) {
       id: r.id,
       // replace single \n within <p> like with Vue's releases
       html: html?.replace(/(?<!>)\n/g, '<br>') ?? null,
-      title: r.name ?? r.tag,
+      title: r.name || r.tag,
       draft: r.draft,
       prerelease: r.prerelease,
       toc,

server/utils/changelog/detectChangelog.ts

@@ -1,4 +1,5 @@
-import type { ChangelogReleaseInfo } from '~~/shared/types/changelog'
+import type { ChangelogReleaseInfo, ChangelogMarkdownInfo } from '~~/shared/types/changelog'
+import { ERROR_CHANGELOG_NOT_FOUND } from '~~/shared/utils/constants'
 import { type RepoRef, parseRepoUrl } from '~~/shared/utils/git-providers'
 import type { ExtendedPackageJson } from '~~/shared/utils/package-analysis'
 // ChangelogInfo
@@ -22,9 +23,16 @@ export async function detectChangelog(
     return false
   }
 
-  const releaseInfo = await checkReleases(repoRef)
+  const changelog = (await checkReleases(repoRef)) || (await checkChangelogFile(repoRef))
 
-  return releaseInfo || checkChangelogFile(repoRef)
+  if (changelog) {
+    return changelog
+  }
+
+  throw createError({
+    statusCode: 404,
+    statusMessage: ERROR_CHANGELOG_NOT_FOUND,
+  })
 }
 
 /**
@@ -69,13 +77,23 @@ function getLatestReleaseUrl(ref: RepoRef): null | string[] {
   return null
 }
 
-const CHANGELOG_FILENAMES = ['changelog', 'history', 'changes', 'news', 'releases'] as const
+const EXTENSIONS = ['.md', ''] as const
 
-async function checkChangelogFile(ref: RepoRef) {
-  const checkUrls = getChangelogUrls(ref)
+const CHANGELOG_FILENAMES = ['changelog', 'releases', 'changes', 'history', 'news']
+  .map(fileName => {
+    const fileNameUpperCase = fileName.toUpperCase()
+    return EXTENSIONS.map(ext => [`${fileNameUpperCase}${ext}`, `${fileName}${ext}`])
+  })
+  .flat(3)
 
-  for (const checkUrl of checkUrls ?? []) {
-    const exists = await fetch(checkUrl, {
+async function checkChangelogFile(ref: RepoRef): Promise<ChangelogMarkdownInfo | false> {
+  const baseUrl = getBaseFileUrl(ref)
+  if (!baseUrl) {
+    return false
+  }
+
+  for (const fileName of CHANGELOG_FILENAMES) {
+    const exists = await fetch(`${baseUrl}/${fileName}`, {
       headers: {
         // GitHub API requires User-Agent
         'User-Agent': 'npmx.dev',
@@ -85,32 +103,16 @@ async function checkChangelogFile(ref: RepoRef) {
       .then(r => r.ok)
       .catch(() => false)
     if (exists) {
-      console.log('exists', checkUrl)
-      return true
+      return {
+        type: 'md',
+        provider: ref.provider,
+        path: fileName,
+      } satisfies ChangelogMarkdownInfo
     }
   }
   return false
 }
 
-function getChangelogUrls(ref: RepoRef) {
-  const baseUrl = getBaseFileUrl(ref)
-  if (!baseUrl) {
-    return
-  }
-
-  return CHANGELOG_FILENAMES.flatMap(fileName => {
-    const fileNameUpCase = fileName.toUpperCase()
-    return [
-      `${baseUrl}/${fileNameUpCase}.md`,
-      `${baseUrl}/${fileName}.md`,
-      `${baseUrl}/${fileNameUpCase}`,
-      `${baseUrl}/${fileName}`,
-      `${baseUrl}/${fileNameUpCase}.txt`,
-      `${baseUrl}/${fileName}.txt`,
-    ]
-  })
-}
-
 function getBaseFileUrl(ref: RepoRef) {
   switch (ref.provider) {
     case 'github':

shared/types/changelog.ts

@@ -13,7 +13,7 @@ export interface ChangelogMarkdownInfo {
   /**
    * location within the repository
    */
-  location: string
+  path: string
 }
 
 export type ChangelogInfo = ChangelogReleaseInfo | ChangelogMarkdownInfo

shared/utils/constants.ts

@@ -35,6 +35,8 @@ export const ERROR_GRAVATAR_FETCH_FAILED = 'Failed to fetch Gravatar profile.'
 export const ERROR_GRAVATAR_EMAIL_UNAVAILABLE = "User's email not accessible."
 export const ERROR_NEED_REAUTH = 'User needs to reauthenticate'
 
+export const ERROR_CHANGELOG_NOT_FOUND =
+  'No releases or changelogs have been found for this package'
 export const ERROR_CHANGELOG_RELEASES_FAILED = 'Failed to get releases'
 export const THROW_INCOMPLETE_PARAM = "Couldn't do request due to incomplete parameters"