feat: added npm package scores

Author: AbderrahmenMHEMED

app/components/Package/ScoreGauges.vue

@@ -0,0 +1,66 @@
+<script setup lang="ts">
+const props = defineProps<{
+  packageName: string
+}>()
+
+const { data: score, status } = usePackageScore(() => props.packageName)
+
+const scoreMetrics = computed(() => {
+  if (!score.value) return []
+  return [
+    {
+      key: 'quality',
+      value: score.value.detail.quality * 100,
+      label: $t('package.scores.quality'),
+    },
+    {
+      key: 'popularity',
+      value: score.value.detail.popularity * 100,
+      label: $t('package.scores.popularity'),
+    },
+    {
+      key: 'maintenance',
+      value: score.value.detail.maintenance * 100,
+      label: $t('package.scores.maintenance'),
+    },
+  ]
+})
+
+function getScoreColor(percentage: number): string {
+  if (percentage < 40) return 'oklch(0.55 0.12 25)'
+  if (percentage < 70) return 'oklch(0.6 0.1 85)'
+  return 'oklch(0.55 0.1 145)'
+}
+</script>
+
+<template>
+  <CollapsibleSection id="scores" :title="$t('package.scores.title')">
+    <template #actions>
+      <TooltipApp :text="$t('package.scores.source')">
+        <span class="i-carbon:information w-3.5 h-3.5 text-fg-subtle" aria-hidden="true" />
+      </TooltipApp>
+    </template>
+    <div v-if="status === 'pending'" class="flex flex-col gap-2">
+      <div v-for="i in 3" :key="i" class="flex items-center gap-3">
+        <SkeletonInline class="w-24 h-3" />
+        <SkeletonInline class="flex-1 h-3 rounded-full" />
+        <SkeletonInline class="w-8 h-3" />
+      </div>
+    </div>
+    <div v-else-if="score" class="flex flex-col gap-2">
+      <div v-for="metric in scoreMetrics" :key="metric.key" class="flex items-center gap-3">
+        <span class="w-24 text-xs text-fg-subtle">{{ metric.label }}</span>
+        <div class="flex-1 h-1.5 bg-border-subtle rounded-full overflow-hidden">
+          <div
+            class="h-full rounded-full"
+            :style="{ width: `${metric.value}%`, background: getScoreColor(metric.value) }"
+          />
+        </div>
+        <span class="w-8 text-xs font-mono text-fg-muted text-right">
+          {{ Math.round(metric.value) }}%
+        </span>
+      </div>
+    </div>
+    <p v-else class="text-fg-subtle text-sm">{{ $t('package.scores.unavailable') }}</p>
+  </CollapsibleSection>
+</template>

app/composables/npm/usePackageScore.ts

@@ -0,0 +1,5 @@
+import type { NpmsScore } from '#server/api/registry/score/[...pkg].get'
+
+export function usePackageScore(name: MaybeRefOrGetter<string>) {
+  return useLazyFetch<NpmsScore>(() => `/api/registry/score/${toValue(name)}`)
+}

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

@@ -1101,6 +1101,9 @@ defineOgImageComponent('Package', {
           <!-- Download stats -->
           <PackageWeeklyDownloadStats :packageName :createdIso="pkg?.time?.created ?? null" />
 
+          <!-- Package scores -->
+          <PackageScoreGauges :packageName />
+
           <!-- Playground links -->
           <PackagePlaygrounds
             v-if="readmeData?.playgroundLinks?.length"

i18n/locales/en.json

@@ -287,6 +287,14 @@
       "download_file": "Download {fileType}",
       "toggle_annotator": "Toggle annotator"
     },
+    "scores": {
+      "title": "Scores",
+      "quality": "Quality",
+      "popularity": "Popularity",
+      "maintenance": "Maintenance",
+      "unavailable": "Score data unavailable",
+      "source": "Scores from npms.io"
+    },
     "install_scripts": {
       "title": "Install Scripts",
       "script_label": "(script)",

lunaria/files/en-GB.json

@@ -287,6 +287,14 @@
       "download_file": "Download {fileType}",
       "toggle_annotator": "Toggle annotator"
     },
+    "scores": {
+      "title": "Scores",
+      "quality": "Quality",
+      "popularity": "Popularity",
+      "maintenance": "Maintenance",
+      "unavailable": "Score data unavailable",
+      "source": "Scores from npms.io"
+    },
     "install_scripts": {
       "title": "Install Scripts",
       "script_label": "(script)",

lunaria/files/en-US.json

@@ -287,6 +287,14 @@
       "download_file": "Download {fileType}",
       "toggle_annotator": "Toggle annotator"
     },
+    "scores": {
+      "title": "Scores",
+      "quality": "Quality",
+      "popularity": "Popularity",
+      "maintenance": "Maintenance",
+      "unavailable": "Score data unavailable",
+      "source": "Scores from npms.io"
+    },
     "install_scripts": {
       "title": "Install Scripts",
       "script_label": "(script)",

server/api/registry/score/[...pkg].get.ts

@@ -0,0 +1,49 @@
+import * as v from 'valibot'
+import { PackageRouteParamsSchema } from '#shared/schemas/package'
+import { CACHE_MAX_AGE_ONE_HOUR } from '#shared/utils/constants'
+
+const NPMS_API = 'https://api.npms.io/v2/package'
+
+export interface NpmsScore {
+  final: number
+  detail: {
+    quality: number
+    popularity: number
+    maintenance: number
+  }
+}
+
+export default defineCachedEventHandler(
+  async event => {
+    const pkgParamSegments = getRouterParam(event, 'pkg')?.split('/') ?? []
+    const { rawPackageName } = parsePackageParams(pkgParamSegments)
+
+    try {
+      const { packageName } = v.parse(PackageRouteParamsSchema, {
+        packageName: rawPackageName,
+      })
+
+      const response = await fetch(`${NPMS_API}/${encodeURIComponent(packageName)}`)
+
+      if (!response.ok) {
+        throw createError({ statusCode: response.status, message: 'Failed to fetch npms score' })
+      }
+
+      const data = await response.json()
+      return data.score as NpmsScore
+    } catch (error: unknown) {
+      handleApiError(error, {
+        statusCode: 502,
+        message: 'Failed to fetch package score from npms.io',
+      })
+    }
+  },
+  {
+    maxAge: CACHE_MAX_AGE_ONE_HOUR,
+    swr: true,
+    getKey: event => {
+      const pkg = getRouterParam(event, 'pkg') ?? ''
+      return `npms-score:${pkg}`
+    },
+  },
+)