@vltpkg/satisfies 1.0.0-rc.23 → 1.0.0-rc.24

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import type { DepID, DepIDTuple } from '@vltpkg/dep-id';
+import { Spec } from '@vltpkg/spec';
+import { Monorepo } from '@vltpkg/workspaces';
+/**
+ * Return true if the node referenced by this DepID would satisfy the
+ * supplied Spec object.
+ */
+export declare const satisfies: (id: DepID | undefined, spec: Spec, fromLocation?: string, projectRoot?: string, monorepo?: Monorepo) => boolean;
+export declare const satisfiesTuple: (tuple: DepIDTuple, spec: Spec, fromLocation?: string, projectRoot?: string, monorepo?: Monorepo) => boolean;

package/dist/index.js

@@ -0,0 +1,121 @@
+import { splitDepID } from '@vltpkg/dep-id';
+import { error } from '@vltpkg/error-cause';
+import { parse, Version } from '@vltpkg/semver';
+import { defaultRegistryName, Spec } from '@vltpkg/spec';
+import { Monorepo } from '@vltpkg/workspaces';
+import { relative, resolve } from 'node:path';
+/**
+ * Return true if the node referenced by this DepID would satisfy the
+ * supplied Spec object.
+ */
+export const satisfies = (id, spec, fromLocation = process.cwd(), projectRoot = process.cwd(), monorepo) => !!id &&
+    satisfiesTuple(splitDepID(id), spec, fromLocation, projectRoot, monorepo);
+export const satisfiesTuple = (tuple, spec, fromLocation = process.cwd(), projectRoot = process.cwd(), monorepo) => {
+    const { options } = spec;
+    spec = spec.final;
+    const [type, first, second] = tuple;
+    if (spec.type !== type)
+        return false;
+    switch (spec.type) {
+        case 'registry': {
+            /* c8 ignore start - should be impossible */
+            if (!first) {
+                // must be from the default registry
+                if (spec.registry !== options.registry) {
+                    return false;
+                }
+                /* c8 ignore stop */
+            }
+            else {
+                let namedRegistry = options.registries[first];
+                /* c8 ignore next 3 */
+                if (!namedRegistry && first === defaultRegistryName) {
+                    namedRegistry = options.registry;
+                }
+                if (namedRegistry && namedRegistry !== spec.registry) {
+                    // we know the name, and it's not the registry being used
+                    return false;
+                }
+                else if (!namedRegistry && first !== spec.registry) {
+                    // an explicit registry URL, but does not match
+                    return false;
+                }
+            }
+            /* c8 ignore next */
+            if (!second)
+                throw error('Invalid DepID', { found: tuple });
+            const [name, version] = parseNameVer(second);
+            return (
+            // mismatched name always invalid
+            name !== spec.name || !version ? false
+                // if just a dist-tag, assume valid
+                : !spec.range ? true
+                    : spec.range.test(Version.parse(version)));
+        }
+        case 'file': {
+            /* c8 ignore next - should be impossible */
+            if (spec.file === undefined)
+                return false;
+            const resolvedSpec = resolve(projectRoot, fromLocation, spec.file);
+            const resolvedId = resolve(projectRoot, first);
+            // valid if the relative path is '', refers to the same path
+            return !relative(resolvedSpec, resolvedId);
+        }
+        case 'workspace': {
+            monorepo ??= Monorepo.load(projectRoot);
+            /* c8 ignore next */
+            if (!spec.workspace)
+                return false;
+            const fromID = monorepo.get(first);
+            const fromSpec = monorepo.get(spec.workspace);
+            if (fromID !== fromSpec || !fromSpec || !fromID)
+                return false;
+            if (!spec.range)
+                return true;
+            const v = parse(fromID.manifest.version ?? '');
+            return !!v && spec.range.test(v);
+        }
+        case 'remote': {
+            return spec.remoteURL === first;
+        }
+        case 'git': {
+            const { gitRemote, gitSelectorParsed = {}, gitSelector, gitCommittish, namedGitHost, namedGitHostPath, } = spec;
+            if (gitRemote !== first) {
+                if (namedGitHost && namedGitHostPath) {
+                    const ngh = `${namedGitHost}:`;
+                    if (first.startsWith(ngh)) {
+                        if (first !== ngh + namedGitHostPath)
+                            return false;
+                    }
+                    else
+                        return false;
+                }
+                else
+                    return false;
+            }
+            if (gitSelector && !second)
+                return false;
+            /* c8 ignore next - always set to something, even if empty */
+            const [parsed, committish] = Spec.parseGitSelector(second ?? '');
+            if (gitCommittish && committish)
+                return committish.startsWith(gitCommittish);
+            for (const [k, v] of Object.entries(gitSelectorParsed)) {
+                if (parsed[k] !== v)
+                    return false;
+            }
+            return true;
+        }
+        /* c8 ignore start */
+        default: {
+            throw error('Invalid spec type', { spec });
+        }
+    }
+    /* c8 ignore stop */
+};
+const parseNameVer = (nv) => {
+    const at = nv.lastIndexOf('@');
+    // if it's 0, means @scoped without a version
+    return at <= 0 ?
+        [nv, '']
+        : [nv.substring(0, at), nv.substring(at + 1)];
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vltpkg/satisfies",
   "description": "method for determining if a DepID satisfies a Spec",
-  "version": "1.0.0-rc.23",
+  "version": "1.0.0-rc.24",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vltpkg/vltpkg.git",
@@ -12,11 +12,11 @@
     "email": "support@vlt.sh"
   },
   "dependencies": {
-    "@vltpkg/dep-id": "1.0.0-rc.23",
-    "@vltpkg/error-cause": "1.0.0-rc.23",
-    "@vltpkg/semver": "1.0.0-rc.23",
-    "@vltpkg/spec": "1.0.0-rc.23",
-    "@vltpkg/workspaces": "1.0.0-rc.23"
+    "@vltpkg/dep-id": "1.0.0-rc.24",
+    "@vltpkg/error-cause": "1.0.0-rc.24",
+    "@vltpkg/semver": "1.0.0-rc.24",
+    "@vltpkg/spec": "1.0.0-rc.24",
+    "@vltpkg/workspaces": "1.0.0-rc.24"
   },
   "devDependencies": {
     "@eslint/js": "^9.39.1",