npq 3.2.2 → 3.3.0

package/lib/helpers/packageRepoUtils.js

@@ -51,6 +51,28 @@ class PackageRepoUtils {
   parsePackageVersion(version) {
     return semver.coerce(version)
   }
+
+  async getSemVer(packageName, packageVersion) {
+    if (semver.valid(packageVersion)) {
+      return packageVersion
+    } else {
+      // this is probably an alias such as `latest` that we need to match
+      // via dist-tags:
+      const packageInfo = await this.getPackageInfo(packageName)
+
+      if (packageInfo['dist-tags'] === undefined) {
+        throw new Error(`could not find dist-tags for package ${packageName}`)
+      }
+
+      if (packageInfo['dist-tags'][packageVersion] === undefined) {
+        throw new Error(`could not find dist-tag ${packageVersion} for package ${packageName}`)
+      }
+
+      const semverVersion = packageInfo['dist-tags'][packageVersion]
+
+      return semverVersion
+    }
+  }
 }
 
 module.exports = PackageRepoUtils

package/lib/marshalls/author.marshall.js

@@ -34,9 +34,14 @@ class Marshall extends BaseMarshall {
     // published, date diff, etc into the package repo utils
     const pakument = await this.packageRepoUtils.getPackageInfo(pkg.packageName)
 
+    const packageVersion = await this.packageRepoUtils.getSemVer(
+      pkg.packageName,
+      pkg.packageVersion
+    )
+
     // @TODO fix to work for both explicit versions (1.0.0) and also
     // for dis-tags (latest)
-    const npmUser = pakument.versions[pkg.packageVersion]._npmUser
+    const npmUser = pakument.versions[packageVersion]._npmUser
     if (!npmUser || !npmUser.email) {
       throw new Error('could not determine publishing user for this package version')
     }
@@ -46,7 +51,7 @@ class Marshall extends BaseMarshall {
     }
 
     let firstVersionForUser = null
-    const versionPublishedDateString = pakument.time[pkg.packageVersion]
+    const versionPublishedDateString = pakument.time[packageVersion]
     for (const [version, versionMetadata] of Object.entries(pakument.versions)) {
       if (versionMetadata._npmUser && versionMetadata._npmUser.email === npmUser.email) {
         firstVersionForUser = versionMetadata
@@ -54,9 +59,9 @@ class Marshall extends BaseMarshall {
       }
     }
 
-    if (!firstVersionForUser || firstVersionForUser.version === pkg.packageVersion) {
+    if (!firstVersionForUser || firstVersionForUser.version === packageVersion) {
       throw new Error(
-        `The user ${npmUser.name} <${npmUser.email}> published this package for the first time only ${dateDiffInDays} days ago. Proceed with care.`
+        `This is first version the user ${npmUser.name} <${npmUser.email}> published this package`
       )
     }
 
@@ -70,7 +75,7 @@ class Marshall extends BaseMarshall {
 
     if (dateDiffInDays <= 30) {
       throw new Error(
-        `The user ${npmUser.name} <${npmUser.email}> published this package for the first time only ${dateDiffInDays} days ago. Proceed with care.`
+        `The user ${npmUser.name} <${npmUser.email}> published this package for the first time only ${dateDiffInDays} days ago.`
       )
     }
 

package/lib/marshalls/provenance.marshall.js

@@ -32,6 +32,10 @@ class Marshall extends BaseMarshall {
 
         validationMetadata.name = packageName
         validationMetadata.version = packageVersion
+
+        if (!validationMetadata.version) {
+          throw new Error('Unable to find version or dist-tag for package')
+        }
       })
       .then(() => {
         return this.fetchRegistryKeys()
@@ -48,15 +52,16 @@ class Marshall extends BaseMarshall {
       })
       .then((metadata) => {
         if (!metadata || !metadata._attestations) {
-          throw new Warning(
-            'the package was published without any attestations. Proceed with care.'
-          )
+          throw new Warning('the package was published without any attestations.')
         }
 
         const attestations = metadata._attestations
 
         return attestations
       })
+      .catch((error) => {
+        throw new Error(`Unable to verify provenance: ${error.message}`)
+      })
   }
 
   fetchRegistryKeys() {

package/lib/marshalls/signatures.marshall.js

@@ -32,6 +32,9 @@ class Marshall extends BaseMarshall {
       .then((metadata) => {
         return metadata
       })
+      .catch((error) => {
+        throw new Error(`Unable to grab package manifest: ${error.message}`)
+      })
   }
 
   fetchRegistryKeys() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npq",
-  "version": "3.2.2",
+  "version": "3.3.0",
   "description": "marshall your npm/npm package installs with high quality and class 🎖",
   "bin": {
     "npq": "./bin/npq.js",
@@ -10,6 +10,7 @@
     "lint": "eslint . --ignore-path .gitignore && npm run lint:lockfile",
     "lint:lockfile": "lockfile-lint --path package-lock.json --type npm --validate-https --allowed-hosts npm npm",
     "test": "NODE_OPTIONS=\"--experimental-vm-modules\" jest",
+    "build": "node scripts/build.js",
     "test:watch": "NODE_OPTIONS=\"--experimental-vm-modules\" jest --watch",
     "coverage:view": "opn coverage/lcov-report/index.html",
     "commit": "git-cz",

package/scripts/build.js

@@ -0,0 +1,25 @@
+const fs = require('fs/promises')
+const path = require('path')
+
+const TOP_PACKAGES_ASSET_URL =
+  'https://github.com/lirantal/npm-rank/releases/download/latest/list-package-names.json'
+
+const TOP_PACKAGES_FILE_PATH = path.join(__dirname, '../data/top-packages.json')
+
+async function downloadTopPackages() {
+  const response = await fetch(TOP_PACKAGES_ASSET_URL)
+  const data = await response.json()
+  return data
+}
+
+async function saveTopPackagesToFile() {
+  const topPackages = await downloadTopPackages()
+  await fs.writeFile(TOP_PACKAGES_FILE_PATH, JSON.stringify(topPackages, null, 2))
+}
+
+async function main() {
+  const topPackages = await downloadTopPackages()
+  await saveTopPackagesToFile()
+}
+
+main()