@vltpkg/pick-manifest 0.0.0-0.1730239248325

package/LICENSE

@@ -0,0 +1,15 @@
+Copyright (c) vlt technology, Inc.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+   Subject to the terms and conditions of this license, each copyright holder and contributor hereby grants to those receiving rights under this license a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except for failure to satisfy the conditions of this license) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer this software, where such license applies only to those patent claims, already acquired or hereafter acquired, licensable by such copyright holder or contributor that are necessarily infringed by:
+
+(a) their Contribution(s) (the licensed copyrights of copyright holders and non-copyrightable additions of contributors, in source or binary form) alone; or
+(b) combination of their Contribution(s) with the work of authorship to which such Contribution(s) was added by such copyright holder or contributor, if, at the time the Contribution is added, such addition causes such combination to be necessarily infringed. The patent license shall not apply to any other combinations which include the Contribution.
+Except as expressly stated above, no rights or licenses from any copyright holder or contributor is granted under this license, whether expressly, by implication, estoppel or otherwise.
+
+DISCLAIMER
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1 @@
+# `@vltpkg/pick-manifest`

package/dist/esm/index.d.ts

@@ -0,0 +1,34 @@
+import { Range, Version } from '@vltpkg/semver';
+import { Spec } from '@vltpkg/spec';
+import { Manifest, Packument, RevDoc, RevDocEntry } from '@vltpkg/types';
+export type PickManifestOptions = {
+    tag?: string;
+    before?: Date | number | string;
+    'node-version'?: string;
+    os?: NodeJS.Platform;
+    arch?: NodeJS.Architecture;
+};
+export type Manifestish = Manifest | RevDocEntry;
+export type Packumentish = Packument | RevDoc;
+export type PickManifestish<T extends Packumentish> = T extends RevDoc ? RevDocEntry : Manifest;
+export type ManiCheck<T extends Packumentish> = {
+    version: Version;
+    deprecated: boolean;
+    platform: boolean;
+    prerelease: boolean;
+    mani: PickManifestish<T>;
+};
+/**
+ * Call with a manifest and the node version and process platform/arch
+ * to check whether a version is suitable for the current platform.
+ */
+export declare const platformCheck: (mani: Manifestish, nodeVersion: Version | string, wantOs?: NodeJS.Process["platform"], wantArch?: NodeJS.Process["arch"]) => boolean;
+/**
+ * Choose the most appropriate manifest from a packument.
+ *
+ * If `before` is set in the options, then the packument MUST
+ * be a full non-minified Packument object. Otherwise, a minified packument
+ * is fine.
+ */
+export declare function pickManifest<T extends Packumentish>(packument: T, wanted: Range | Spec | string, opts?: PickManifestOptions): PickManifestish<T> | undefined;
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAS,KAAK,EAAa,OAAO,EAAE,MAAM,gBAAgB,CAAA;AACjE,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACnC,OAAO,EACL,QAAQ,EACR,SAAS,EACT,MAAM,EACN,WAAW,EACZ,MAAM,eAAe,CAAA;AAItB,MAAM,MAAM,mBAAmB,GAAG;IAChC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAAA;IAC/B,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC,YAAY,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAA;AAChD,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,MAAM,CAAA;AAC7C,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,YAAY,IAChD,CAAC,SAAS,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAA;AAC3C,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,YAAY,IAAI;IAC9C,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,OAAO,CAAA;IACnB,QAAQ,EAAE,OAAO,CAAA;IACjB,UAAU,EAAE,OAAO,CAAA;IACnB,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;CACzB,CAAA;AAwCD;;;GAGG;AACH,eAAO,MAAM,aAAa,SAClB,WAAW,eACJ,OAAO,GAAG,MAAM,WACpB,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,aACxB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAChC,OAWF,CAAA;AAoBD;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,YAAY,EACjD,SAAS,EAAE,CAAC,EACZ,MAAM,EAAE,KAAK,GAAG,IAAI,GAAG,MAAM,EAC7B,IAAI,GAAE,mBAAwB,GAC7B,eAAe,CAAC,CAAC,CAAC,GAAG,SAAS,CA6IhC"}

package/dist/esm/index.js

@@ -0,0 +1,195 @@
+import { error } from '@vltpkg/error-cause';
+import { parse, Range, satisfies, Version } from '@vltpkg/semver';
+import { Spec } from '@vltpkg/spec';
+const parsedNodeVersion = Version.parse(process.version);
+const isBefore = (version, before, verTimes) => {
+    if (!verTimes || !version || !before)
+        return true;
+    const time = version && verTimes[version];
+    return !!time && Date.parse(time) <= before;
+};
+const checkList = (value, list) => {
+    if (typeof list === 'string') {
+        list = [list];
+    }
+    // invalid list is equivalent to 'any'
+    if (!Array.isArray(list))
+        return true;
+    if (list.length === 1 && list[0] === 'any') {
+        return true;
+    }
+    // match none of the negated values, and at least one of the
+    // non-negated values, if any are present.
+    let negated = 0;
+    let match = false;
+    for (const entry of list) {
+        const negate = entry.startsWith('!');
+        const test = negate ? entry.slice(1) : entry;
+        if (negate) {
+            negated++;
+            if (value === test) {
+                return false;
+            }
+        }
+        else {
+            match = match || value === test;
+        }
+    }
+    return match || negated === list.length;
+};
+/**
+ * Call with a manifest and the node version and process platform/arch
+ * to check whether a version is suitable for the current platform.
+ */
+export const platformCheck = (mani, nodeVersion, wantOs, wantArch) => {
+    const { engines, os, cpu } = mani;
+    if (engines) {
+        const { node } = engines;
+        if (node && !satisfies(nodeVersion, node, true)) {
+            return false;
+        }
+    }
+    if (wantOs && !checkList(wantOs, os))
+        return false;
+    if (wantArch && !checkList(wantArch, cpu))
+        return false;
+    return true;
+};
+const versionOk = (packument, version, nodeVersion, os, arch, before) => {
+    const mani = packument.versions[version];
+    /* c8 ignore next */
+    if (!mani)
+        return false;
+    const { time } = packument;
+    return (isBefore(version, before, time) &&
+        platformCheck(mani, nodeVersion, os, arch));
+};
+/**
+ * Choose the most appropriate manifest from a packument.
+ *
+ * If `before` is set in the options, then the packument MUST
+ * be a full non-minified Packument object. Otherwise, a minified packument
+ * is fine.
+ */
+export function pickManifest(packument, wanted, opts = {}) {
+    const { tag = 'latest', before, 'node-version': nodeVersion, os = process.platform, arch = process.arch, } = opts;
+    const nv = !nodeVersion ? parsedNodeVersion : Version.parse(nodeVersion);
+    // cast since 'time' might not be present on minified packuments
+    const { name, time: verTimes, versions = {}, 'dist-tags': distTags = {}, } = packument;
+    const time = before && verTimes ? +new Date(before) : Infinity;
+    let range = undefined;
+    let spec = undefined;
+    if (typeof wanted === 'object') {
+        if (wanted instanceof Spec) {
+            const f = wanted.final;
+            range = f.range;
+            spec = f;
+        }
+        else {
+            range = wanted;
+        }
+    }
+    else {
+        spec = Spec.parse(`${name}@${wanted}`).final;
+        range = spec.range;
+    }
+    if (!range) {
+        if (!spec?.distTag) {
+            throw error('Only dist-tag or semver range specs are supported', { spec });
+        }
+        // if there is an explicit dist tag, we must get that version.
+        const ver = distTags[spec.distTag];
+        if (!ver)
+            return undefined;
+        // if the version in the dist-tags is before the before date, then
+        // we use that.  Otherwise, we get the highest precedence version
+        // prior to the dist-tag.
+        const mani = versions[ver];
+        if (mani && versionOk(packument, ver, nv, os, arch, time)) {
+            return mani;
+        }
+        else {
+            range = new Range(`<=${ver}`);
+        }
+    }
+    if (range.isAny)
+        range = new Range('*', true);
+    // if the range is *, then we prefer the 'latest' if available
+    // but skip this if it should be avoided, in that case we have
+    // to try a little harder.
+    const defaultVer = distTags[tag];
+    const defTagVersion = defaultVer ? Version.parse(defaultVer) : undefined;
+    if (defaultVer &&
+        (range.isAny || defTagVersion?.satisfies(range)) &&
+        versionOk(packument, defaultVer, nv, os, arch, time)) {
+        return versions[defaultVer];
+    }
+    // ok, actually have to scan the list
+    const entries = Object.entries(versions);
+    if (!entries.length) {
+        return undefined;
+    }
+    let found = undefined;
+    let foundIsDefTag = false;
+    for (const [ver, mani] of entries) {
+        if (time && verTimes && !isBefore(ver, time, verTimes)) {
+            continue;
+        }
+        const version = parse(ver);
+        if (!version?.satisfies(range)) {
+            continue;
+        }
+        const mc = {
+            version,
+            deprecated: !!mani.deprecated,
+            platform: platformCheck(mani, nv, os, arch),
+            prerelease: !!version.prerelease?.length,
+            mani,
+        };
+        if (!found) {
+            found = mc;
+            if (defTagVersion?.equals(found.version)) {
+                foundIsDefTag = true;
+            }
+            continue;
+        }
+        const mok = !mc.deprecated && mc.platform;
+        const fok = !found.deprecated && found.platform;
+        if (mok !== fok) {
+            if (mok) {
+                found = mc;
+                foundIsDefTag = !!defTagVersion?.equals(mc.version);
+            }
+        }
+        else if (mc.platform !== found.platform) {
+            if (mc.platform) {
+                found = mc;
+                foundIsDefTag = !!defTagVersion?.equals(mc.version);
+            }
+        }
+        else if (mc.deprecated !== found.deprecated) {
+            if (!mc.deprecated) {
+                found = mc;
+                /* c8 ignore next */
+                foundIsDefTag = !!defTagVersion?.equals(mc.version);
+            }
+        }
+        else if (found.prerelease !== mc.prerelease) {
+            if (!mc.prerelease) {
+                found = mc;
+                /* c8 ignore next */
+                foundIsDefTag = !!defTagVersion?.equals(mc.version);
+            }
+        }
+        else if (defTagVersion?.equals(mc.version)) {
+            found = mc;
+            foundIsDefTag = true;
+        }
+        else if (mc.version.greaterThan(found.version) &&
+            !foundIsDefTag) {
+            found = mc;
+        }
+    }
+    return found?.mani;
+}
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAC3C,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AACjE,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAQnC,MAAM,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;AAsBxD,MAAM,QAAQ,GAAG,CACf,OAAe,EACf,MAAe,EACf,QAAiC,EACxB,EAAE;IACX,IAAI,CAAC,QAAQ,IAAI,CAAC,OAAO,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,CAAA;IACjD,MAAM,IAAI,GAAG,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAA;IACzC,OAAO,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,MAAM,CAAA;AAC7C,CAAC,CAAA;AAED,MAAM,SAAS,GAAG,CAAC,KAAa,EAAE,IAAwB,EAAE,EAAE;IAC5D,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,IAAI,GAAG,CAAC,IAAI,CAAC,CAAA;IACf,CAAC;IACD,sCAAsC;IACtC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAA;IACrC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;QAC3C,OAAO,IAAI,CAAA;IACb,CAAC;IACD,4DAA4D;IAC5D,0CAA0C;IAC1C,IAAI,OAAO,GAAG,CAAC,CAAA;IACf,IAAI,KAAK,GAAG,KAAK,CAAA;IACjB,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;QACpC,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;QAC5C,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,EAAE,CAAA;YACT,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBACnB,OAAO,KAAK,CAAA;YACd,CAAC;QACH,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,KAAK,IAAI,KAAK,KAAK,IAAI,CAAA;QACjC,CAAC;IACH,CAAC;IACD,OAAO,KAAK,IAAI,OAAO,KAAK,IAAI,CAAC,MAAM,CAAA;AACzC,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,IAAiB,EACjB,WAA6B,EAC7B,MAAmC,EACnC,QAAiC,EACxB,EAAE;IACX,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IACjC,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAA;QACxB,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;YAChD,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IACD,IAAI,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;QAAE,OAAO,KAAK,CAAA;IAClD,IAAI,QAAQ,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC;QAAE,OAAO,KAAK,CAAA;IACvD,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAED,MAAM,SAAS,GAAG,CAChB,SAAuB,EACvB,OAAe,EACf,WAAoB,EACpB,EAA8B,EAC9B,IAA4B,EAC5B,MAAe,EACf,EAAE;IACF,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;IACxC,oBAAoB;IACpB,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAA;IACvB,MAAM,EAAE,IAAI,EAAE,GAAG,SAAS,CAAA;IAC1B,OAAO,CACL,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC;QAC/B,aAAa,CAAC,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,IAAI,CAAC,CAC3C,CAAA;AACH,CAAC,CAAA;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAC1B,SAAY,EACZ,MAA6B,EAC7B,OAA4B,EAAE;IAE9B,MAAM,EACJ,GAAG,GAAG,QAAQ,EACd,MAAM,EACN,cAAc,EAAE,WAAW,EAC3B,EAAE,GAAG,OAAO,CAAC,QAAQ,EACrB,IAAI,GAAG,OAAO,CAAC,IAAI,GACpB,GAAG,IAAI,CAAA;IACR,MAAM,EAAE,GACN,CAAC,WAAW,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;IAE/D,gEAAgE;IAChE,MAAM,EACJ,IAAI,EACJ,IAAI,EAAE,QAAQ,EACd,QAAQ,GAAG,EAAE,EACb,WAAW,EAAE,QAAQ,GAAG,EAAE,GAC3B,GAAG,SAAS,CAAA;IAEb,MAAM,IAAI,GAAG,MAAM,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAA;IAC9D,IAAI,KAAK,GAAsB,SAAS,CAAA;IACxC,IAAI,IAAI,GAAqB,SAAS,CAAA;IACtC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,IAAI,MAAM,YAAY,IAAI,EAAE,CAAC;YAC3B,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAA;YACtB,KAAK,GAAG,CAAC,CAAC,KAAK,CAAA;YACf,IAAI,GAAG,CAAC,CAAA;QACV,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,MAAM,CAAA;QAChB,CAAC;IACH,CAAC;SAAM,CAAC;QACN,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,IAAI,MAAM,EAAE,CAAC,CAAC,KAAK,CAAA;QAC5C,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;IACpB,CAAC;IAED,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC;YACnB,MAAM,KAAK,CACT,mDAAmD,EACnD,EAAE,IAAI,EAAE,CACT,CAAA;QACH,CAAC;QACD,8DAA8D;QAC9D,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAClC,IAAI,CAAC,GAAG;YAAE,OAAO,SAAS,CAAA;QAC1B,kEAAkE;QAClE,iEAAiE;QACjE,yBAAyB;QACzB,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAA;QAC1B,IAAI,IAAI,IAAI,SAAS,CAAC,SAAS,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;YAC1D,OAAO,IAA0B,CAAA;QACnC,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,IAAI,KAAK,CAAC,KAAK,GAAG,EAAE,CAAC,CAAA;QAC/B,CAAC;IACH,CAAC;IAED,IAAI,KAAK,CAAC,KAAK;QAAE,KAAK,GAAG,IAAI,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;IAE7C,8DAA8D;IAC9D,8DAA8D;IAC9D,0BAA0B;IAC1B,MAAM,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAA;IAChC,MAAM,aAAa,GACjB,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACpD,IACE,UAAU;QACV,CAAC,KAAK,CAAC,KAAK,IAAI,aAAa,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;QAChD,SAAS,CAAC,SAAS,EAAE,UAAU,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,EACpD,CAAC;QACD,OAAO,QAAQ,CAAC,UAAU,CAAuB,CAAA;IACnD,CAAC;IAED,qCAAqC;IACrC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IAExC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACpB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,IAAI,KAAK,GAA6B,SAAS,CAAA;IAC/C,IAAI,aAAa,GAAG,KAAK,CAAA;IAEzB,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,OAAO,EAAE,CAAC;QAClC,IAAI,IAAI,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC;YACvD,SAAQ;QACV,CAAC;QACD,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,CAAA;QAC1B,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/B,SAAQ;QACV,CAAC;QACD,MAAM,EAAE,GAAG;YACT,OAAO;YACP,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU;YAC7B,QAAQ,EAAE,aAAa,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC;YAC3C,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM;YACxC,IAAI;SACL,CAAA;QACD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,GAAG,EAAE,CAAA;YACV,IAAI,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;gBACzC,aAAa,GAAG,IAAI,CAAA;YACtB,CAAC;YACD,SAAQ;QACV,CAAC;QAED,MAAM,GAAG,GAAG,CAAC,EAAE,CAAC,UAAU,IAAI,EAAE,CAAC,QAAQ,CAAA;QACzC,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,QAAQ,CAAA;QAE/C,IAAI,GAAG,KAAK,GAAG,EAAE,CAAC;YAChB,IAAI,GAAG,EAAE,CAAC;gBACR,KAAK,GAAG,EAAE,CAAA;gBACV,aAAa,GAAG,CAAC,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,CAAA;YACrD,CAAC;QACH,CAAC;aAAM,IAAI,EAAE,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,EAAE,CAAC;YAC1C,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC;gBAChB,KAAK,GAAG,EAAE,CAAA;gBACV,aAAa,GAAG,CAAC,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,CAAA;YACrD,CAAC;QACH,CAAC;aAAM,IAAI,EAAE,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,EAAE,CAAC;YAC9C,IAAI,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC;gBACnB,KAAK,GAAG,EAAE,CAAA;gBACV,oBAAoB;gBACpB,aAAa,GAAG,CAAC,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,CAAA;YACrD,CAAC;QACH,CAAC;aAAM,IAAI,KAAK,CAAC,UAAU,KAAK,EAAE,CAAC,UAAU,EAAE,CAAC;YAC9C,IAAI,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC;gBACnB,KAAK,GAAG,EAAE,CAAA;gBACV,oBAAoB;gBACpB,aAAa,GAAG,CAAC,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,CAAA;YACrD,CAAC;QACH,CAAC;aAAM,IAAI,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7C,KAAK,GAAG,EAAE,CAAA;YACV,aAAa,GAAG,IAAI,CAAA;QACtB,CAAC;aAAM,IACL,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC;YACrC,CAAC,aAAa,EACd,CAAC;YACD,KAAK,GAAG,EAAE,CAAA;QACZ,CAAC;IACH,CAAC;IACD,OAAO,KAAK,EAAE,IAAI,CAAA;AACpB,CAAC","sourcesContent":["import { error } from '@vltpkg/error-cause'\nimport { parse, Range, satisfies, Version } from '@vltpkg/semver'\nimport { Spec } from '@vltpkg/spec'\nimport {\n  Manifest,\n  Packument,\n  RevDoc,\n  RevDocEntry,\n} from '@vltpkg/types'\n\nconst parsedNodeVersion = Version.parse(process.version)\n\nexport type PickManifestOptions = {\n  tag?: string\n  before?: Date | number | string\n  'node-version'?: string\n  os?: NodeJS.Platform\n  arch?: NodeJS.Architecture\n}\n\nexport type Manifestish = Manifest | RevDocEntry\nexport type Packumentish = Packument | RevDoc\nexport type PickManifestish<T extends Packumentish> =\n  T extends RevDoc ? RevDocEntry : Manifest\nexport type ManiCheck<T extends Packumentish> = {\n  version: Version\n  deprecated: boolean\n  platform: boolean\n  prerelease: boolean\n  mani: PickManifestish<T>\n}\n\nconst isBefore = (\n  version: string,\n  before?: number,\n  verTimes?: Record<string, string>,\n): boolean => {\n  if (!verTimes || !version || !before) return true\n  const time = version && verTimes[version]\n  return !!time && Date.parse(time) <= before\n}\n\nconst checkList = (value: string, list?: string[] | string) => {\n  if (typeof list === 'string') {\n    list = [list]\n  }\n  // invalid list is equivalent to 'any'\n  if (!Array.isArray(list)) return true\n  if (list.length === 1 && list[0] === 'any') {\n    return true\n  }\n  // match none of the negated values, and at least one of the\n  // non-negated values, if any are present.\n  let negated = 0\n  let match = false\n  for (const entry of list) {\n    const negate = entry.startsWith('!')\n    const test = negate ? entry.slice(1) : entry\n    if (negate) {\n      negated++\n      if (value === test) {\n        return false\n      }\n    } else {\n      match = match || value === test\n    }\n  }\n  return match || negated === list.length\n}\n\n/**\n * Call with a manifest and the node version and process platform/arch\n * to check whether a version is suitable for the current platform.\n */\nexport const platformCheck = (\n  mani: Manifestish,\n  nodeVersion: Version | string,\n  wantOs?: NodeJS.Process['platform'],\n  wantArch?: NodeJS.Process['arch'],\n): boolean => {\n  const { engines, os, cpu } = mani\n  if (engines) {\n    const { node } = engines\n    if (node && !satisfies(nodeVersion, node, true)) {\n      return false\n    }\n  }\n  if (wantOs && !checkList(wantOs, os)) return false\n  if (wantArch && !checkList(wantArch, cpu)) return false\n  return true\n}\n\nconst versionOk = (\n  packument: Packumentish,\n  version: string,\n  nodeVersion: Version,\n  os: NodeJS.Process['platform'],\n  arch: NodeJS.Process['arch'],\n  before?: number,\n) => {\n  const mani = packument.versions[version]\n  /* c8 ignore next */\n  if (!mani) return false\n  const { time } = packument\n  return (\n    isBefore(version, before, time) &&\n    platformCheck(mani, nodeVersion, os, arch)\n  )\n}\n\n/**\n * Choose the most appropriate manifest from a packument.\n *\n * If `before` is set in the options, then the packument MUST\n * be a full non-minified Packument object. Otherwise, a minified packument\n * is fine.\n */\nexport function pickManifest<T extends Packumentish>(\n  packument: T,\n  wanted: Range | Spec | string,\n  opts: PickManifestOptions = {},\n): PickManifestish<T> | undefined {\n  const {\n    tag = 'latest',\n    before,\n    'node-version': nodeVersion,\n    os = process.platform,\n    arch = process.arch,\n  } = opts\n  const nv =\n    !nodeVersion ? parsedNodeVersion : Version.parse(nodeVersion)\n\n  // cast since 'time' might not be present on minified packuments\n  const {\n    name,\n    time: verTimes,\n    versions = {},\n    'dist-tags': distTags = {},\n  } = packument\n\n  const time = before && verTimes ? +new Date(before) : Infinity\n  let range: Range | undefined = undefined\n  let spec: Spec | undefined = undefined\n  if (typeof wanted === 'object') {\n    if (wanted instanceof Spec) {\n      const f = wanted.final\n      range = f.range\n      spec = f\n    } else {\n      range = wanted\n    }\n  } else {\n    spec = Spec.parse(`${name}@${wanted}`).final\n    range = spec.range\n  }\n\n  if (!range) {\n    if (!spec?.distTag) {\n      throw error(\n        'Only dist-tag or semver range specs are supported',\n        { spec },\n      )\n    }\n    // if there is an explicit dist tag, we must get that version.\n    const ver = distTags[spec.distTag]\n    if (!ver) return undefined\n    // if the version in the dist-tags is before the before date, then\n    // we use that.  Otherwise, we get the highest precedence version\n    // prior to the dist-tag.\n    const mani = versions[ver]\n    if (mani && versionOk(packument, ver, nv, os, arch, time)) {\n      return mani as PickManifestish<T>\n    } else {\n      range = new Range(`<=${ver}`)\n    }\n  }\n\n  if (range.isAny) range = new Range('*', true)\n\n  // if the range is *, then we prefer the 'latest' if available\n  // but skip this if it should be avoided, in that case we have\n  // to try a little harder.\n  const defaultVer = distTags[tag]\n  const defTagVersion =\n    defaultVer ? Version.parse(defaultVer) : undefined\n  if (\n    defaultVer &&\n    (range.isAny || defTagVersion?.satisfies(range)) &&\n    versionOk(packument, defaultVer, nv, os, arch, time)\n  ) {\n    return versions[defaultVer] as PickManifestish<T>\n  }\n\n  // ok, actually have to scan the list\n  const entries = Object.entries(versions)\n\n  if (!entries.length) {\n    return undefined\n  }\n\n  let found: ManiCheck<T> | undefined = undefined\n  let foundIsDefTag = false\n\n  for (const [ver, mani] of entries) {\n    if (time && verTimes && !isBefore(ver, time, verTimes)) {\n      continue\n    }\n    const version = parse(ver)\n    if (!version?.satisfies(range)) {\n      continue\n    }\n    const mc = {\n      version,\n      deprecated: !!mani.deprecated,\n      platform: platformCheck(mani, nv, os, arch),\n      prerelease: !!version.prerelease?.length,\n      mani,\n    }\n    if (!found) {\n      found = mc\n      if (defTagVersion?.equals(found.version)) {\n        foundIsDefTag = true\n      }\n      continue\n    }\n\n    const mok = !mc.deprecated && mc.platform\n    const fok = !found.deprecated && found.platform\n\n    if (mok !== fok) {\n      if (mok) {\n        found = mc\n        foundIsDefTag = !!defTagVersion?.equals(mc.version)\n      }\n    } else if (mc.platform !== found.platform) {\n      if (mc.platform) {\n        found = mc\n        foundIsDefTag = !!defTagVersion?.equals(mc.version)\n      }\n    } else if (mc.deprecated !== found.deprecated) {\n      if (!mc.deprecated) {\n        found = mc\n        /* c8 ignore next */\n        foundIsDefTag = !!defTagVersion?.equals(mc.version)\n      }\n    } else if (found.prerelease !== mc.prerelease) {\n      if (!mc.prerelease) {\n        found = mc\n        /* c8 ignore next */\n        foundIsDefTag = !!defTagVersion?.equals(mc.version)\n      }\n    } else if (defTagVersion?.equals(mc.version)) {\n      found = mc\n      foundIsDefTag = true\n    } else if (\n      mc.version.greaterThan(found.version) &&\n      !foundIsDefTag\n    ) {\n      found = mc\n    }\n  }\n  return found?.mani\n}\n"]}

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@vltpkg/pick-manifest",
+  "description": "Choose a manifest from a packument",
+  "version": "0.0.0-0.1730239248325",
+  "tshy": {
+    "selfLink": false,
+    "dialects": [
+      "esm"
+    ],
+    "exports": {
+      "./package.json": "./package.json",
+      ".": "./src/index.ts"
+    }
+  },
+  "dependencies": {
+    "@vltpkg/error-cause": "0.0.0-0.1730239248325",
+    "@vltpkg/semver": "0.0.0-0.1730239248325",
+    "@vltpkg/spec": "0.0.0-0.1730239248325",
+    "@vltpkg/types": "0.0.0-0.1730239248325"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.8.0",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^22.4.1",
+    "eslint": "^9.8.0",
+    "npm-pick-manifest": "^9.1.0",
+    "prettier": "^3.3.2",
+    "tap": "^21.0.1",
+    "tshy": "^3.0.2",
+    "typescript": "^5.5.4",
+    "typescript-eslint": "^8.0.1",
+    "@vltpkg/benchmark": "0.0.0-0"
+  },
+  "license": "BSD-2-Clause-Patent",
+  "engines": {
+    "node": "20 || >=22"
+  },
+  "tap": {
+    "extends": "../../tap-config.yaml"
+  },
+  "prettier": "../../.prettierrc.js",
+  "module": "./dist/esm/index.js",
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prebenchmark": "pnpm vlt-benchmark-download-fixtures",
+    "benchmark": "node scripts/benchmark.js",
+    "format": "prettier --write . --log-level warn --ignore-path ../../.prettierignore --cache",
+    "format:check": "prettier --check . --ignore-path ../../.prettierignore --cache",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
+    "presnap": "tshy",
+    "snap": "tap",
+    "pretest": "tshy",
+    "test": "tap"
+  }
+}