@vltpkg/package-info 1.0.0-rc.32 → 1.0.0-rc.33

package/dist/index.d.ts

@@ -28,6 +28,15 @@ export type PackageInfoClientOptions = RegistryClientOptions & SpecOptions & {
 export type PackageInfoClientRequestOptions = PickManifestOptions & RegistryClientRequestOptions & {
     /** dir to resolve `file://` specifiers against. Defaults to projectRoot. */
     from?: string;
+    /**
+     * When true, requests the full packument document from the registry
+     * instead of the abbreviated "corgi" format. Use this when you need
+     * fields like `time`, `maintainers`, or `_rev` that are stripped
+     * from the abbreviated response.
+     *
+     * Defaults to `false` (abbreviated packument for faster installs).
+     */
+    fullPackument?: boolean;
 };
 export type PackageInfoClientExtractOptions = PackageInfoClientRequestOptions & {
     integrity?: Integrity;

package/dist/index.js

@@ -18,6 +18,13 @@ const xdg = new XDG('vlt');
 export const delimiter = '~';
 // the maximum duration of a manifest cache file
 const manifestCacheMaxAge = 5 * 60 * 1000;
+/**
+ * There is no default registry. Anything that needs to build a registry
+ * URL fails with a `ECONFIG` error when none has been configured.
+ */
+const noRegistryError = (spec) => error('No registry configured to resolve this spec. Set "registry" in ' +
+    'vlt.json, pass --registry, or run `vlt login --registry=<url>`. ' +
+    'See https://docs.vlt.sh/cli', { code: 'ECONFIG', spec });
 export class PackageInfoClient {
     #registryClient;
     #projectRoot;
@@ -29,6 +36,7 @@ export class PackageInfoClient {
     #trustedIntegrities = new Map();
     #manifestCacheMinAge = Date.now() - manifestCacheMaxAge;
     #cachePath;
+    #packumentPromises = new Map();
     get registryClient() {
         if (!this.#registryClient) {
             this.#registryClient = new RegistryClient(this.options);
@@ -109,7 +117,10 @@ export class PackageInfoClient {
                         ...(useCache === false ? { useCache } : {}),
                     });
                     if (response.statusCode !== 200) {
-                        throw this.#resolveError(spec, options, 'failed to fetch tarball', {
+                        throw this.#resolveError(spec, options, `Registry returned HTTP ${response.statusCode} when ` +
+                            `fetching the tarball for ${spec}. The resolved version ` +
+                            `may have been unpublished, or the registry may be ` +
+                            `misconfigured or unreachable.`, {
                             url: r.resolved,
                             response,
                         });
@@ -272,7 +283,7 @@ export class PackageInfoClient {
         if (options.arch) {
             extra += `${delimiter}arch:${options.arch}`;
         }
-        return encodeURIComponent(`${spec.registry}${delimiter}${spec}${extra}`);
+        return encodeURIComponent(`${spec.registry ?? ''}${delimiter}${spec}${extra}`);
     }
     /**
      * Conditionally return the path to the manifest cache file. The logic
@@ -293,30 +304,6 @@ export class PackageInfoClient {
         const key = this.#manifestCacheKey(f, options);
         return pathResolve(this.#cachePath, 'package-info', key);
     }
-    async #registryManifestRequest(spec, options) {
-        const { registry, name, registrySpec } = spec.final;
-        /* c8 ignore start */
-        if (!spec.range?.isSingle || !registrySpec) {
-            throw this.#resolveError(spec, options, 'failed to request manifest', { spec });
-        }
-        /* c8 ignore stop */
-        const possibleLeadingChars = ['=', '^', '~', 'v'];
-        const hasLeadingRange = possibleLeadingChars.some(char => registrySpec.startsWith(char));
-        const version = hasLeadingRange ? registrySpec.slice(1) : registrySpec;
-        const pakuURL = new URL(`${name}/${version}`, registry);
-        const response = await this.registryClient.request(pakuURL, {
-            headers: {
-                accept: 'application/json',
-            },
-        });
-        if (response.statusCode !== 200) {
-            throw this.#resolveError(spec, options, 'failed to fetch manifest', {
-                url: pakuURL,
-                response,
-            });
-        }
-        return response.json();
-    }
     async tarball(spec, options = {}) {
         if (typeof spec === 'string')
             spec = Spec.parse(spec, this.options);
@@ -325,10 +312,14 @@ export class PackageInfoClient {
             case 'registry': {
                 const { dist } = await this.manifest(spec, options);
                 if (!dist)
-                    throw this.#resolveError(spec, options, 'no dist object found in manifest');
+                    throw this.#resolveError(spec, options, `The registry manifest for ${spec} has no "dist" section, ` +
+                        `so no tarball can be resolved. The package version may be ` +
+                        `malformed or unpublished.`);
                 const { tarball, integrity } = dist;
                 if (!tarball) {
-                    throw this.#resolveError(spec, options, 'no tarball found in manifest.dist');
+                    throw this.#resolveError(spec, options, `The registry manifest for ${spec} is missing a tarball URL ` +
+                        `(dist.tarball). The package version may be malformed or ` +
+                        `unpublished in this registry.`);
                 }
                 const fetchTarball = async (useCache) => {
                     const trustIntegrity = this.#trustedIntegrities.get(tarball) === integrity;
@@ -339,7 +330,10 @@ export class PackageInfoClient {
                         ...(useCache === false ? { useCache } : {}),
                     });
                     if (response.statusCode !== 200) {
-                        throw this.#resolveError(spec, options, 'failed to fetch tarball', { response, url: tarball });
+                        throw this.#resolveError(spec, options, `Registry returned HTTP ${response.statusCode} when ` +
+                            `fetching the tarball for ${spec} at ${tarball}. The ` +
+                            `version may have been unpublished, or the registry may ` +
+                            `be misconfigured or unreachable.`, { response, url: tarball });
                     }
                     // if we don't already trust it, but it's valid, start
                     // trusting it
@@ -474,9 +468,7 @@ export class PackageInfoClient {
                         // Cache miss, fetch from packument
                     }
                 }
-                const mani = spec.range?.isSingle ?
-                    await this.#registryManifestRequest(spec, options)
-                    : pickManifest(await this.packument(f, options), spec, options);
+                const mani = pickManifest(await this.packument(f, options), spec, options);
                 if (!mani)
                     throw this.#resolveError(spec, options);
                 // Cache the manifest data
@@ -606,22 +598,44 @@ export class PackageInfoClient {
             }
             case 'registry': {
                 const { registry, name } = f;
-                const pakuURL = new URL(name, registry);
-                const response = await this.registryClient.request(pakuURL, {
-                    headers: {
-                        accept: 'application/json',
-                    },
-                });
-                if (response.statusCode !== 200) {
-                    throw this.#resolveError(spec, options, 'failed to fetch packument', {
-                        url: pakuURL,
-                        response,
-                    });
+                if (!registry)
+                    throw noRegistryError(spec);
+                // Full packument requests bypass coalescing since they
+                // return different data than the abbreviated format.
+                if (options.fullPackument) {
+                    const pakuURL = new URL(name, registry);
+                    return this.#fetchPackument(spec, options, pakuURL);
                 }
-                return response.json();
+                const packumentKey = `${registry}${name}`;
+                const inflight = this.#packumentPromises.get(packumentKey);
+                if (inflight)
+                    return inflight;
+                const pakuURL = new URL(name, registry);
+                const promise = this.#fetchPackument(spec, options, pakuURL);
+                this.#packumentPromises.set(packumentKey, promise);
+                // Clean up once settled so we don't leak memory.
+                // Use .then/.catch instead of .finally to avoid creating
+                // an unhandled rejection from the derived promise.
+                promise.then(() => this.#packumentPromises.delete(packumentKey), () => this.#packumentPromises.delete(packumentKey));
+                return promise;
             }
         }
     }
+    async #fetchPackument(spec, options, pakuURL) {
+        const accept = options.fullPackument ?
+            'application/json'
+            : 'application/vnd.npm.install-v1+json; q=1.0, application/json; q=0.8, */*';
+        const response = await this.registryClient.request(pakuURL, {
+            headers: { accept },
+        });
+        if (response.statusCode !== 200) {
+            throw this.#resolveError(spec, options, 'failed to fetch packument', {
+                url: pakuURL,
+                response,
+            });
+        }
+        return response.json();
+    }
     async resolve(spec, options = {}) {
         const memoKey = String(spec);
         if (typeof spec === 'string')

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vltpkg/package-info",
   "description": "Resolve and fetch package metadata and tarballs",
-  "version": "1.0.0-rc.32",
+  "version": "1.0.0-rc.33",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vltpkg/vltpkg.git",
@@ -13,16 +13,16 @@
     "url": "http://vlt.sh"
   },
   "dependencies": {
-    "@vltpkg/error-cause": "1.0.0-rc.32",
-    "@vltpkg/git": "1.0.0-rc.32",
-    "@vltpkg/package-json": "1.0.0-rc.32",
-    "@vltpkg/pick-manifest": "1.0.0-rc.32",
-    "@vltpkg/registry-client": "1.0.0-rc.32",
-    "@vltpkg/spec": "1.0.0-rc.32",
-    "@vltpkg/tar": "1.0.0-rc.32",
-    "@vltpkg/types": "1.0.0-rc.32",
-    "@vltpkg/workspaces": "1.0.0-rc.32",
-    "@vltpkg/xdg": "1.0.0-rc.32",
+    "@vltpkg/error-cause": "1.0.0-rc.33",
+    "@vltpkg/git": "1.0.0-rc.33",
+    "@vltpkg/package-json": "1.0.0-rc.33",
+    "@vltpkg/pick-manifest": "1.0.0-rc.33",
+    "@vltpkg/registry-client": "1.0.0-rc.33",
+    "@vltpkg/spec": "1.0.0-rc.33",
+    "@vltpkg/tar": "1.0.0-rc.33",
+    "@vltpkg/types": "1.0.0-rc.33",
+    "@vltpkg/workspaces": "1.0.0-rc.33",
+    "@vltpkg/xdg": "1.0.0-rc.33",
     "ssri": "^13.0.0",
     "tar": "^7.5.2"
   },
@@ -31,8 +31,8 @@
     "@types/node": "^22.19.2",
     "@types/pacote": "^11.1.8",
     "@vltpkg/benchmark": "0.0.0",
-    "@vltpkg/cache-unzip": "1.0.0-rc.32",
-    "@vltpkg/vlt-json": "1.0.0-rc.32",
+    "@vltpkg/cache-unzip": "1.0.0-rc.33",
+    "@vltpkg/vlt-json": "1.0.0-rc.33",
     "eslint": "^9.39.1",
     "pacote": "^21.0.4",
     "prettier": "^3.7.4",
@@ -73,5 +73,12 @@
   },
   "files": [
     "dist"
-  ]
+  ],
+  "bugs": [
+    {
+      "type": "link",
+      "url": "https://github.com/vltpkg/vltpkg/issues"
+    }
+  ],
+  "homepage": "https://github.com/vltpkg/vltpkg/tree/main/src/package-info#readme"
 }