@vltpkg/graph 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,33 @@
+# `@vltpkg/graph`
+
+This is the graph library responsible for representing the packages
+that are involved in a given install.
+
+## API
+
+### `actual.load({ projectRoot: string }): Graph`
+
+Recursively loads the `node_modules` folder found at `projectRoot` in order to
+create a graph representation of the current installed packages.
+
+### `async ideal.build({ projectRoot: string }): Promise<Graph>`
+
+This method returns a new `Graph` object, reading from the `package.json`
+file located at `projectRoot` dir and building up the graph representation
+of nodes and edges from the files read from the local file system.
+
+### `lockfile.load({ mainManifest: Manifest, projectRoot: string }): Graph`
+
+Loads the lockfile file found at `projectRoot` and returns the graph.
+
+## USAGE
+
+Here's a quick example of how to use the `@vltpkg/graph.ideal.build` method to
+build a graph representation of the install defined at the `projectRoot`
+directory.
+
+```
+import { ideal } from '@vltpkg/graph'
+
+const graph = await ideal.build({ projectRoot: process.cwd() })
+```

package/dist/esm/actual/load.d.ts

@@ -0,0 +1,54 @@
+import { PackageJson } from '@vltpkg/package-json';
+import { SpecOptions } from '@vltpkg/spec';
+import { Manifest } from '@vltpkg/types';
+import { Monorepo } from '@vltpkg/workspaces';
+import { Path, PathScurry } from 'path-scurry';
+import { Graph } from '../graph.js';
+export type LoadOptions = SpecOptions & {
+    /**
+     * The project root dirname.
+     */
+    projectRoot: string;
+    /**
+     * The project root manifest.
+     */
+    mainManifest?: Manifest;
+    /**
+     * A {@link Monorepo} object, for managing workspaces
+     */
+    monorepo?: Monorepo;
+    /**
+     * A {@link PackageJson} object, for sharing manifest caches
+     */
+    packageJson: PackageJson;
+    /**
+     * A {@link PathScurry} object, for use in globs
+     */
+    scurry: PathScurry;
+    /**
+     * If set to `false`, `actual.load` will not load any `package.json`
+     * files while traversing the file system.
+     *
+     * The resulting {@link Graph} from loading with `loadManifests=false`
+     * has no information on dependency types or the specs defined and
+     * no information on missing and extraneous dependencies.
+     */
+    loadManifests?: boolean;
+    /**
+     * If set to `true`, then do not shortcut the process by reading the
+     * hidden lockfile at `node_modules/.vlt-lock.json`
+     */
+    skipHiddenLockfile?: boolean;
+};
+export type ReadEntry = {
+    alias: string;
+    name: string;
+    realpath: Path;
+};
+/**
+ * Read the file system looking for `node_modules` folders and
+ * returns a new {@link Graph} that represents the relationship
+ * between the dependencies found.
+ */
+export declare const load: (options: LoadOptions) => Graph;
+//# sourceMappingURL=load.d.ts.map

package/dist/esm/actual/load.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../../../src/actual/load.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,EAAQ,WAAW,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAC7C,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAM9C,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAInC,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG;IACtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAA;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAA;IACxB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAA;IAClB;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,IAAI,CAAA;CACf,CAAA;AA6QD;;;;GAIG;AACH,eAAO,MAAM,IAAI,YAAa,WAAW,KAAG,KAqD3C,CAAA"}

package/dist/esm/actual/load.js

@@ -0,0 +1,243 @@
+import { asDepID, hydrate, joinDepIDTuple, } from '@vltpkg/dep-id';
+import { Spec } from '@vltpkg/spec';
+import { longDependencyTypes, shorten, } from '../dependencies.js';
+import { Graph } from '../graph.js';
+import { loadHidden } from '../lockfile/load.js';
+const pathBasedType = new Set(['file', 'workspace']);
+const isPathBasedType = (type) => pathBasedType.has(type);
+const getPathBasedId = (spec, path) => isPathBasedType(spec.type) ?
+    joinDepIDTuple([spec.type, path])
+    : undefined;
+/**
+ * Retrieve the {@link DepID} for a given package from its location.
+ */
+const findDepID = ({ parent, name }) => parent?.name === '.vlt' ? asDepID(name)
+    : parent?.isCWD === false ? findDepID(parent)
+        : undefined;
+/**
+ * Retrieves the closest `node_modules` parent {@link Path} found.
+ */
+const findNodeModules = ({ parent, name, isCWD, }) => parent?.name === 'node_modules' ? parent
+    : parent && name !== '.vlt' && !isCWD ? findNodeModules(parent)
+        : undefined;
+/**
+ * Retrieves the scoped-normalized package name from its {@link Path}.
+ */
+const findName = ({ parent, name }) => parent?.name.startsWith('@') ? `${parent.name}/${name}` : name;
+const isStringArray = (a) => Array.isArray(a) && !a.some(b => typeof b !== 'string');
+/*
+ * Retrieves a map of all dependencies, of all types, that can be iterated
+ * on and consulted when parsing the directory contents of the current node.
+ */
+const getDeps = (node) => {
+    const dependencies = new Map();
+    const bundleDeps = node.manifest?.bundleDependencies ?? [];
+    // if it's an importer, bundleDeps are just normal. if it's a dep,
+    // then they're ignored entirely.
+    const bundled = (!node.importer &&
+        !node.id.startsWith('git') &&
+        isStringArray(bundleDeps)) ?
+        new Set(bundleDeps)
+        : new Set();
+    for (const depType of longDependencyTypes) {
+        const obj = node.manifest?.[depType];
+        // only care about devDeps for importers and git or symlink deps
+        // technically this will also include devDeps for tarball file: specs,
+        // but that is likely rare enough to not worry about too much.
+        if (depType === 'devDependencies' &&
+            !node.importer &&
+            !node.id.startsWith('git') &&
+            !node.id.startsWith('file')) {
+            continue;
+        }
+        if (obj) {
+            for (const [name, bareSpec] of Object.entries(obj)) {
+                // if it's a bundled dependency, we just ignore it entirely.
+                if (bundled.has(name))
+                    continue;
+                dependencies.set(name, {
+                    name,
+                    type: depType,
+                    bareSpec,
+                    registry: node.registry,
+                });
+            }
+        }
+    }
+    return dependencies;
+};
+/**
+ * Reads the current directory defined at `currDir` and looks for folder
+ * names and their realpath resolution, normalizing scoped package names
+ * and removing any invalid symlinks from the list of items that should
+ * be parsed through in order to build the graph.
+ */
+const readDir = (scurry, currDir, fromNodeName) => {
+    const res = new Set();
+    for (const entry of scurry.readdirSync(currDir)) {
+        // ignore any hidden files / folders
+        if (entry.name.startsWith('.'))
+            continue;
+        // scope folder found, it will need to be read and iterated over
+        // in order to find any scoped packages inside
+        if (entry.name.startsWith('@')) {
+            const scopedItems = readDir(scurry, entry, fromNodeName);
+            for (const scopedItem of scopedItems) {
+                res.add(scopedItem);
+            }
+            continue;
+        }
+        // skip anything that isn't a symlink, it's not an edge
+        if (!entry.isSymbolicLink())
+            continue;
+        // we'll need to learn what is the real path for this entry in order
+        // to retrieve the `location` and `id` properties for the node, if a
+        // realpath is not found just move on to the next element
+        const realpath = entry.realpathSync();
+        if (!realpath) {
+            continue;
+        }
+        // infer both the alias and proper package names, including scopes
+        const alias = findName(entry);
+        const name = findName(realpath);
+        res.add({
+            alias,
+            name,
+            realpath,
+        });
+    }
+    return res;
+};
+/**
+ * Parses the files located at `currDir` and place packages found inside
+ * as dependencies of `fromNode`, building the instantiated `graph`.
+ */
+const parseDir = (options, scurry, packageJson, depsFound, graph, fromNode, currDir) => {
+    const { loadManifests } = options;
+    const dependencies = getDeps(fromNode);
+    const seenDeps = new Set();
+    const readItems = readDir(scurry, currDir, fromNode.name);
+    for (const { alias, name, realpath } of readItems) {
+        let node;
+        // tracks what dependencies have been seen
+        // so that we can mark missing dependencies
+        seenDeps.add(alias);
+        // places the package in the graph reading
+        // its manifest only if necessary
+        if (!loadManifests) {
+            const depId = findDepID(realpath);
+            if (depId) {
+                const h = hydrate(depId, alias, {
+                    ...options,
+                    registry: fromNode.registry,
+                });
+                // graphs build with no manifest have no notion of
+                // dependency types and or spec definitions since those
+                // would have to be parsed from a manifest
+                node = graph.placePackage(fromNode, 'prod', // defaults to prod deps
+                h, // uses spec from hydrated id
+                {
+                    name,
+                    ...(h.registrySpec ?
+                        { version: h.registrySpec } // adds version if available
+                        : null),
+                }, depId);
+            }
+        }
+        // retrieve references to the current folder name found in `fromNode`
+        // manifest listed dependencies, removing it from the map will leave
+        // a list of missing dependencies at the end of the iteration
+        const deps = dependencies.get(alias);
+        // in case this graph is skipping manifests, this next block might
+        // still need to execute, thus actually loading a manifest file, for
+        // edge-cases such as loading a linked node that is not going to have
+        // DepID info available in its realpath or extraneous nodes
+        if (!node) {
+            const mani = packageJson.read(realpath.fullpath());
+            // declares fallback default values for both depType and bareSpec
+            // in order to support loadManifests=false fallback for link nodes
+            const type = deps?.type || 'dependencies';
+            const bareSpec = deps?.bareSpec || '*';
+            const depType = shorten(type, alias, fromNode.manifest);
+            const spec = Spec.parse(alias, bareSpec, {
+                ...options,
+                registry: fromNode.registry,
+            });
+            const maybeId = getPathBasedId(spec, realpath.relativePosix());
+            node = graph.placePackage(fromNode, depType, spec, mani, maybeId);
+        }
+        if (node) {
+            // If a found dependency is not declared in any of the original
+            // node dependencies, then add an edge to the graph pointing to it
+            // and mark it as extraneous.
+            //
+            // This only makes sense if full manifests are being loaded
+            // so that we have reference to dependencies info.
+            if (loadManifests && !deps) {
+                const [edge] = node.edgesIn;
+                if (edge) {
+                    graph.extraneousDependencies.add(edge);
+                }
+            }
+            // for a succesfully created node, add its location
+            // property and queue up to read its dependencies
+            node.location = `./${realpath.relativePosix()}`;
+            const node_modules = findNodeModules(realpath);
+            // queue items up to continue parsing dirs in case a node was succesfully
+            // placed in the graph and its node_modules folder was correctly found
+            if (node_modules) {
+                depsFound.set(node, node_modules);
+            }
+        }
+    }
+    // any remaining dependencies that have not been found
+    // when reading the directory should be marked as missing
+    for (const { name, type, bareSpec } of dependencies.values()) {
+        if (!seenDeps.has(name)) {
+            const depType = shorten(type, name, fromNode.manifest);
+            const spec = Spec.parse(name, bareSpec, {
+                ...options,
+                registry: fromNode.registry,
+            });
+            graph.placePackage(fromNode, depType, spec);
+        }
+    }
+};
+/**
+ * Read the file system looking for `node_modules` folders and
+ * returns a new {@link Graph} that represents the relationship
+ * between the dependencies found.
+ */
+export const load = (options) => {
+    // TODO: once hidden lockfile is more reliable, default to false here
+    const { skipHiddenLockfile = true, projectRoot, packageJson, scurry, monorepo, } = options;
+    const mainManifest = options.mainManifest ?? packageJson.read(projectRoot);
+    if (!skipHiddenLockfile) {
+        try {
+            const graph = loadHidden({
+                projectRoot,
+                mainManifest,
+                packageJson,
+                monorepo,
+                scurry,
+            });
+            // TODO: check mtime of lockfile vs .vlt folder
+            return graph;
+        }
+        catch { }
+    }
+    const graph = new Graph({ ...options, mainManifest });
+    const depsFound = new Map();
+    // starts the list of initial folders to parse using the importer nodes
+    for (const importer of graph.importers) {
+        depsFound.set(importer, scurry.cwd.resolve(`${importer.location}/node_modules`));
+    }
+    // breadth-first traversal of the file system tree reading deps found
+    // starting from the node_modules folder of every importer in order to
+    // find the actual installed dependencies at each location
+    for (const [node, path] of depsFound.entries()) {
+        parseDir(options, scurry, packageJson, depsFound, graph, node, path);
+    }
+    return graph;
+};
+//# sourceMappingURL=load.js.map

package/dist/esm/actual/load.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"load.js","sourceRoot":"","sources":["../../../src/actual/load.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAEP,OAAO,EACP,cAAc,GACf,MAAM,gBAAgB,CAAA;AAEvB,OAAO,EAAE,IAAI,EAAe,MAAM,cAAc,CAAA;AAIhD,OAAO,EACL,mBAAmB,EAEnB,OAAO,GACR,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AA8ChD,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAA;AACpD,MAAM,eAAe,GAAG,CACtB,IAAY,EACkB,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;AAC1D,MAAM,cAAc,GAAG,CACrB,IAAU,EACV,IAAY,EACO,EAAE,CACrB,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1B,cAAc,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnC,CAAC,CAAC,SAAS,CAAA;AAEb;;GAEG;AACH,MAAM,SAAS,GAAG,CAAC,EAAE,MAAM,EAAE,IAAI,EAAQ,EAAqB,EAAE,CAC9D,MAAM,EAAE,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACvC,CAAC,CAAC,MAAM,EAAE,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC;QAC7C,CAAC,CAAC,SAAS,CAAA;AAEb;;GAEG;AACH,MAAM,eAAe,GAAG,CAAC,EACvB,MAAM,EACN,IAAI,EACJ,KAAK,GACA,EAAoB,EAAE,CAC3B,MAAM,EAAE,IAAI,KAAK,cAAc,CAAC,CAAC,CAAC,MAAM;IACxC,CAAC,CAAC,MAAM,IAAI,IAAI,KAAK,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,CAAC;QAC/D,CAAC,CAAC,SAAS,CAAA;AAEb;;GAEG;AACH,MAAM,QAAQ,GAAG,CAAC,EAAE,MAAM,EAAE,IAAI,EAAQ,EAAU,EAAE,CAClD,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;AAEhE,MAAM,aAAa,GAAG,CAAC,CAAU,EAAiB,EAAE,CAClD,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAA;AAEzD;;;GAGG;AACH,MAAM,OAAO,GAAG,CAAC,IAAU,EAAE,EAAE;IAC7B,MAAM,YAAY,GAAG,IAAI,GAAG,EAAyB,CAAA;IACrD,MAAM,UAAU,GAAY,IAAI,CAAC,QAAQ,EAAE,kBAAkB,IAAI,EAAE,CAAA;IACnE,kEAAkE;IAClE,iCAAiC;IACjC,MAAM,OAAO,GACX,CACE,CAAC,IAAI,CAAC,QAAQ;QACd,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC;QAC1B,aAAa,CAAC,UAAU,CAAC,CAC1B,CAAC,CAAC;QACD,IAAI,GAAG,CAAC,UAAU,CAAC;QACrB,CAAC,CAAC,IAAI,GAAG,EAAU,CAAA;IACrB,KAAK,MAAM,OAAO,IAAI,mBAAmB,EAAE,CAAC;QAC1C,MAAM,GAAG,GACP,IAAI,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,CAAA;QAC1B,gEAAgE;QAChE,sEAAsE;QACtE,8DAA8D;QAC9D,IACE,OAAO,KAAK,iBAAiB;YAC7B,CAAC,IAAI,CAAC,QAAQ;YACd,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC;YAC1B,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAC3B,CAAC;YACD,SAAQ;QACV,CAAC;QACD,IAAI,GAAG,EAAE,CAAC;YACR,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnD,4DAA4D;gBAC5D,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC;oBAAE,SAAQ;gBAC/B,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE;oBACrB,IAAI;oBACJ,IAAI,EAAE,OAAO;oBACb,QAAQ;oBACR,QAAQ,EAAE,IAAI,CAAC,QAAQ;iBACxB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,YAAY,CAAA;AACrB,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,OAAO,GAAG,CACd,MAAkB,EAClB,OAAa,EACb,YAAqB,EACrB,EAAE;IACF,MAAM,GAAG,GAAG,IAAI,GAAG,EAAa,CAAA;IAChC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;QAChD,oCAAoC;QACpC,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,SAAQ;QAExC,gEAAgE;QAChE,8CAA8C;QAC9C,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC/B,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,CAAA;YACxD,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;gBACrC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;YACrB,CAAC;YACD,SAAQ;QACV,CAAC;QAED,uDAAuD;QACvD,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE;YAAE,SAAQ;QAErC,oEAAoE;QACpE,oEAAoE;QACpE,yDAAyD;QACzD,MAAM,QAAQ,GAAG,KAAK,CAAC,YAAY,EAAE,CAAA;QACrC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,SAAQ;QACV,CAAC;QAED,kEAAkE;QAClE,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;QAC7B,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAC/B,GAAG,CAAC,GAAG,CAAC;YACN,KAAK;YACL,IAAI;YACJ,QAAQ;SACT,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,QAAQ,GAAG,CACf,OAAoB,EACpB,MAAkB,EAClB,WAAwB,EACxB,SAA0B,EAC1B,KAAY,EACZ,QAAc,EACd,OAAa,EACb,EAAE;IACF,MAAM,EAAE,aAAa,EAAE,GAAG,OAAO,CAAA;IACjC,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IACtC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAA;IAClC,MAAM,SAAS,GAAmB,OAAO,CACvC,MAAM,EACN,OAAO,EACP,QAAQ,CAAC,IAAI,CACd,CAAA;IAED,KAAK,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,SAAS,EAAE,CAAC;QAClD,IAAI,IAAI,CAAA;QAER,0CAA0C;QAC1C,2CAA2C;QAC3C,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QAEnB,0CAA0C;QAC1C,iCAAiC;QACjC,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAA;YAEjC,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,CAAC,GAAG,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE;oBAC9B,GAAG,OAAO;oBACV,QAAQ,EAAE,QAAQ,CAAC,QAAQ;iBAC5B,CAAC,CAAA;gBAEF,kDAAkD;gBAClD,uDAAuD;gBACvD,0CAA0C;gBAC1C,IAAI,GAAG,KAAK,CAAC,YAAY,CACvB,QAAQ,EACR,MAAM,EAAE,wBAAwB;gBAChC,CAAC,EAAE,6BAA6B;gBAChC;oBACE,IAAI;oBACJ,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;wBAClB,EAAE,OAAO,EAAE,CAAC,CAAC,YAAY,EAAE,CAAC,4BAA4B;wBAC1D,CAAC,CAAC,IAAI,CAAC;iBACR,EACD,KAAK,CACN,CAAA;YACH,CAAC;QACH,CAAC;QAED,qEAAqE;QACrE,oEAAoE;QACpE,6DAA6D;QAC7D,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QAEpC,kEAAkE;QAClE,oEAAoE;QACpE,qEAAqE;QACrE,2DAA2D;QAC3D,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAA;YAClD,iEAAiE;YACjE,kEAAkE;YAClE,MAAM,IAAI,GAAG,IAAI,EAAE,IAAI,IAAI,cAAc,CAAA;YACzC,MAAM,QAAQ,GAAG,IAAI,EAAE,QAAQ,IAAI,GAAG,CAAA;YAEtC,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAA;YACvD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE;gBACvC,GAAG,OAAO;gBACV,QAAQ,EAAE,QAAQ,CAAC,QAAQ;aAC5B,CAAC,CAAA;YACF,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAA;YAC9D,IAAI,GAAG,KAAK,CAAC,YAAY,CACvB,QAAQ,EACR,OAAO,EACP,IAAI,EACJ,IAAI,EACJ,OAAO,CACR,CAAA;QACH,CAAC;QAED,IAAI,IAAI,EAAE,CAAC;YACT,+DAA+D;YAC/D,kEAAkE;YAClE,6BAA6B;YAC7B,EAAE;YACF,2DAA2D;YAC3D,kDAAkD;YAClD,IAAI,aAAa,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC3B,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAA;gBAC3B,IAAI,IAAI,EAAE,CAAC;oBACT,KAAK,CAAC,sBAAsB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;gBACxC,CAAC;YACH,CAAC;YAED,mDAAmD;YACnD,iDAAiD;YACjD,IAAI,CAAC,QAAQ,GAAG,KAAK,QAAQ,CAAC,aAAa,EAAE,EAAE,CAAA;YAC/C,MAAM,YAAY,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAA;YAE9C,yEAAyE;YACzE,sEAAsE;YACtE,IAAI,YAAY,EAAE,CAAC;gBACjB,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;YACnC,CAAC;QACH,CAAC;IACH,CAAC;IAED,sDAAsD;IACtD,yDAAyD;IACzD,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC;QAC7D,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAA;YACtD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE;gBACtC,GAAG,OAAO;gBACV,QAAQ,EAAE,QAAQ,CAAC,QAAQ;aAC5B,CAAC,CAAA;YACF,KAAK,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAA;QAC7C,CAAC;IACH,CAAC;AACH,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,OAAoB,EAAS,EAAE;IAClD,qEAAqE;IACrE,MAAM,EACJ,kBAAkB,GAAG,IAAI,EACzB,WAAW,EACX,WAAW,EACX,MAAM,EACN,QAAQ,GACT,GAAG,OAAO,CAAA;IACX,MAAM,YAAY,GAChB,OAAO,CAAC,YAAY,IAAI,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IAEvD,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACxB,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,UAAU,CAAC;gBACvB,WAAW;gBACX,YAAY;gBACZ,WAAW;gBACX,QAAQ;gBACR,MAAM;aACP,CAAC,CAAA;YACF,+CAA+C;YAC/C,OAAO,KAAK,CAAA;QACd,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACZ,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,YAAY,EAAE,CAAC,CAAA;IACrD,MAAM,SAAS,GAAG,IAAI,GAAG,EAAc,CAAA;IAEvC,uEAAuE;IACvE,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;QACvC,SAAS,CAAC,GAAG,CACX,QAAQ,EACR,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,QAAQ,eAAe,CAAC,CACxD,CAAA;IACH,CAAC;IAED,qEAAqE;IACrE,sEAAsE;IACtE,0DAA0D;IAC1D,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,SAAS,CAAC,OAAO,EAAE,EAAE,CAAC;QAC/C,QAAQ,CACN,OAAO,EACP,MAAM,EACN,WAAW,EACX,SAAS,EACT,KAAK,EACL,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC,CAAA","sourcesContent":["import {\n  asDepID,\n  DepID,\n  hydrate,\n  joinDepIDTuple,\n} from '@vltpkg/dep-id'\nimport { PackageJson } from '@vltpkg/package-json'\nimport { Spec, SpecOptions } from '@vltpkg/spec'\nimport { Manifest } from '@vltpkg/types'\nimport { Monorepo } from '@vltpkg/workspaces'\nimport { Path, PathScurry } from 'path-scurry'\nimport {\n  longDependencyTypes,\n  RawDependency,\n  shorten,\n} from '../dependencies.js'\nimport { Graph } from '../graph.js'\nimport { loadHidden } from '../lockfile/load.js'\nimport { Node } from '../node.js'\n\nexport type LoadOptions = SpecOptions & {\n  /**\n   * The project root dirname.\n   */\n  projectRoot: string\n  /**\n   * The project root manifest.\n   */\n  mainManifest?: Manifest\n  /**\n   * A {@link Monorepo} object, for managing workspaces\n   */\n  monorepo?: Monorepo\n  /**\n   * A {@link PackageJson} object, for sharing manifest caches\n   */\n  packageJson: PackageJson\n  /**\n   * A {@link PathScurry} object, for use in globs\n   */\n  scurry: PathScurry\n  /**\n   * If set to `false`, `actual.load` will not load any `package.json`\n   * files while traversing the file system.\n   *\n   * The resulting {@link Graph} from loading with `loadManifests=false`\n   * has no information on dependency types or the specs defined and\n   * no information on missing and extraneous dependencies.\n   */\n  loadManifests?: boolean\n  /**\n   * If set to `true`, then do not shortcut the process by reading the\n   * hidden lockfile at `node_modules/.vlt-lock.json`\n   */\n  skipHiddenLockfile?: boolean\n}\n\nexport type ReadEntry = {\n  alias: string\n  name: string\n  realpath: Path\n}\n\nconst pathBasedType = new Set(['file', 'workspace'])\nconst isPathBasedType = (\n  type: string,\n): type is 'file' | 'workspace' => pathBasedType.has(type)\nconst getPathBasedId = (\n  spec: Spec,\n  path: string,\n): DepID | undefined =>\n  isPathBasedType(spec.type) ?\n    joinDepIDTuple([spec.type, path])\n  : undefined\n\n/**\n * Retrieve the {@link DepID} for a given package from its location.\n */\nconst findDepID = ({ parent, name }: Path): DepID | undefined =>\n  parent?.name === '.vlt' ? asDepID(name)\n  : parent?.isCWD === false ? findDepID(parent)\n  : undefined\n\n/**\n * Retrieves the closest `node_modules` parent {@link Path} found.\n */\nconst findNodeModules = ({\n  parent,\n  name,\n  isCWD,\n}: Path): Path | undefined =>\n  parent?.name === 'node_modules' ? parent\n  : parent && name !== '.vlt' && !isCWD ? findNodeModules(parent)\n  : undefined\n\n/**\n * Retrieves the scoped-normalized package name from its {@link Path}.\n */\nconst findName = ({ parent, name }: Path): string =>\n  parent?.name.startsWith('@') ? `${parent.name}/${name}` : name\n\nconst isStringArray = (a: unknown): a is string[] =>\n  Array.isArray(a) && !a.some(b => typeof b !== 'string')\n\n/*\n * Retrieves a map of all dependencies, of all types, that can be iterated\n * on and consulted when parsing the directory contents of the current node.\n */\nconst getDeps = (node: Node) => {\n  const dependencies = new Map<string, RawDependency>()\n  const bundleDeps: unknown = node.manifest?.bundleDependencies ?? []\n  // if it's an importer, bundleDeps are just normal. if it's a dep,\n  // then they're ignored entirely.\n  const bundled =\n    (\n      !node.importer &&\n      !node.id.startsWith('git') &&\n      isStringArray(bundleDeps)\n    ) ?\n      new Set(bundleDeps)\n    : new Set<string>()\n  for (const depType of longDependencyTypes) {\n    const obj: Record<string, string> | undefined =\n      node.manifest?.[depType]\n    // only care about devDeps for importers and git or symlink deps\n    // technically this will also include devDeps for tarball file: specs,\n    // but that is likely rare enough to not worry about too much.\n    if (\n      depType === 'devDependencies' &&\n      !node.importer &&\n      !node.id.startsWith('git') &&\n      !node.id.startsWith('file')\n    ) {\n      continue\n    }\n    if (obj) {\n      for (const [name, bareSpec] of Object.entries(obj)) {\n        // if it's a bundled dependency, we just ignore it entirely.\n        if (bundled.has(name)) continue\n        dependencies.set(name, {\n          name,\n          type: depType,\n          bareSpec,\n          registry: node.registry,\n        })\n      }\n    }\n  }\n  return dependencies\n}\n\n/**\n * Reads the current directory defined at `currDir` and looks for folder\n * names and their realpath resolution, normalizing scoped package names\n * and removing any invalid symlinks from the list of items that should\n * be parsed through in order to build the graph.\n */\nconst readDir = (\n  scurry: PathScurry,\n  currDir: Path,\n  fromNodeName?: string,\n) => {\n  const res = new Set<ReadEntry>()\n  for (const entry of scurry.readdirSync(currDir)) {\n    // ignore any hidden files / folders\n    if (entry.name.startsWith('.')) continue\n\n    // scope folder found, it will need to be read and iterated over\n    // in order to find any scoped packages inside\n    if (entry.name.startsWith('@')) {\n      const scopedItems = readDir(scurry, entry, fromNodeName)\n      for (const scopedItem of scopedItems) {\n        res.add(scopedItem)\n      }\n      continue\n    }\n\n    // skip anything that isn't a symlink, it's not an edge\n    if (!entry.isSymbolicLink()) continue\n\n    // we'll need to learn what is the real path for this entry in order\n    // to retrieve the `location` and `id` properties for the node, if a\n    // realpath is not found just move on to the next element\n    const realpath = entry.realpathSync()\n    if (!realpath) {\n      continue\n    }\n\n    // infer both the alias and proper package names, including scopes\n    const alias = findName(entry)\n    const name = findName(realpath)\n    res.add({\n      alias,\n      name,\n      realpath,\n    })\n  }\n  return res\n}\n\n/**\n * Parses the files located at `currDir` and place packages found inside\n * as dependencies of `fromNode`, building the instantiated `graph`.\n */\nconst parseDir = (\n  options: LoadOptions,\n  scurry: PathScurry,\n  packageJson: PackageJson,\n  depsFound: Map<Node, Path>,\n  graph: Graph,\n  fromNode: Node,\n  currDir: Path,\n) => {\n  const { loadManifests } = options\n  const dependencies = getDeps(fromNode)\n  const seenDeps = new Set<string>()\n  const readItems: Set<ReadEntry> = readDir(\n    scurry,\n    currDir,\n    fromNode.name,\n  )\n\n  for (const { alias, name, realpath } of readItems) {\n    let node\n\n    // tracks what dependencies have been seen\n    // so that we can mark missing dependencies\n    seenDeps.add(alias)\n\n    // places the package in the graph reading\n    // its manifest only if necessary\n    if (!loadManifests) {\n      const depId = findDepID(realpath)\n\n      if (depId) {\n        const h = hydrate(depId, alias, {\n          ...options,\n          registry: fromNode.registry,\n        })\n\n        // graphs build with no manifest have no notion of\n        // dependency types and or spec definitions since those\n        // would have to be parsed from a manifest\n        node = graph.placePackage(\n          fromNode,\n          'prod', // defaults to prod deps\n          h, // uses spec from hydrated id\n          {\n            name,\n            ...(h.registrySpec ?\n              { version: h.registrySpec } // adds version if available\n            : null),\n          },\n          depId,\n        )\n      }\n    }\n\n    // retrieve references to the current folder name found in `fromNode`\n    // manifest listed dependencies, removing it from the map will leave\n    // a list of missing dependencies at the end of the iteration\n    const deps = dependencies.get(alias)\n\n    // in case this graph is skipping manifests, this next block might\n    // still need to execute, thus actually loading a manifest file, for\n    // edge-cases such as loading a linked node that is not going to have\n    // DepID info available in its realpath or extraneous nodes\n    if (!node) {\n      const mani = packageJson.read(realpath.fullpath())\n      // declares fallback default values for both depType and bareSpec\n      // in order to support loadManifests=false fallback for link nodes\n      const type = deps?.type || 'dependencies'\n      const bareSpec = deps?.bareSpec || '*'\n\n      const depType = shorten(type, alias, fromNode.manifest)\n      const spec = Spec.parse(alias, bareSpec, {\n        ...options,\n        registry: fromNode.registry,\n      })\n      const maybeId = getPathBasedId(spec, realpath.relativePosix())\n      node = graph.placePackage(\n        fromNode,\n        depType,\n        spec,\n        mani,\n        maybeId,\n      )\n    }\n\n    if (node) {\n      // If a found dependency is not declared in any of the original\n      // node dependencies, then add an edge to the graph pointing to it\n      // and mark it as extraneous.\n      //\n      // This only makes sense if full manifests are being loaded\n      // so that we have reference to dependencies info.\n      if (loadManifests && !deps) {\n        const [edge] = node.edgesIn\n        if (edge) {\n          graph.extraneousDependencies.add(edge)\n        }\n      }\n\n      // for a succesfully created node, add its location\n      // property and queue up to read its dependencies\n      node.location = `./${realpath.relativePosix()}`\n      const node_modules = findNodeModules(realpath)\n\n      // queue items up to continue parsing dirs in case a node was succesfully\n      // placed in the graph and its node_modules folder was correctly found\n      if (node_modules) {\n        depsFound.set(node, node_modules)\n      }\n    }\n  }\n\n  // any remaining dependencies that have not been found\n  // when reading the directory should be marked as missing\n  for (const { name, type, bareSpec } of dependencies.values()) {\n    if (!seenDeps.has(name)) {\n      const depType = shorten(type, name, fromNode.manifest)\n      const spec = Spec.parse(name, bareSpec, {\n        ...options,\n        registry: fromNode.registry,\n      })\n      graph.placePackage(fromNode, depType, spec)\n    }\n  }\n}\n\n/**\n * Read the file system looking for `node_modules` folders and\n * returns a new {@link Graph} that represents the relationship\n * between the dependencies found.\n */\nexport const load = (options: LoadOptions): Graph => {\n  // TODO: once hidden lockfile is more reliable, default to false here\n  const {\n    skipHiddenLockfile = true,\n    projectRoot,\n    packageJson,\n    scurry,\n    monorepo,\n  } = options\n  const mainManifest =\n    options.mainManifest ?? packageJson.read(projectRoot)\n\n  if (!skipHiddenLockfile) {\n    try {\n      const graph = loadHidden({\n        projectRoot,\n        mainManifest,\n        packageJson,\n        monorepo,\n        scurry,\n      })\n      // TODO: check mtime of lockfile vs .vlt folder\n      return graph\n    } catch {}\n  }\n\n  const graph = new Graph({ ...options, mainManifest })\n  const depsFound = new Map<Node, Path>()\n\n  // starts the list of initial folders to parse using the importer nodes\n  for (const importer of graph.importers) {\n    depsFound.set(\n      importer,\n      scurry.cwd.resolve(`${importer.location}/node_modules`),\n    )\n  }\n\n  // breadth-first traversal of the file system tree reading deps found\n  // starting from the node_modules folder of every importer in order to\n  // find the actual installed dependencies at each location\n  for (const [node, path] of depsFound.entries()) {\n    parseDir(\n      options,\n      scurry,\n      packageJson,\n      depsFound,\n      graph,\n      node,\n      path,\n    )\n  }\n\n  return graph\n}\n"]}

package/dist/esm/browser.d.ts

@@ -0,0 +1,9 @@
+import { asDependencyTypeShort } from './dependencies.js';
+import { getBooleanFlagsFromNum } from './lockfile/types.js';
+import { stringifyNode } from './stringify-node.js';
+declare const lockfile: {
+    loadEdges: (graph: import("./types.js").GraphLike, edges: import("./lockfile/types.js").LockfileData["edges"], options: import("@vltpkg/spec").SpecOptions) => void;
+    loadNodes: (graph: import("./types.js").GraphLike, nodes: import("./lockfile/types.js").LockfileData["nodes"]) => void;
+};
+export { asDependencyTypeShort, getBooleanFlagsFromNum, lockfile, stringifyNode, };
+//# sourceMappingURL=browser.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../src/browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AACzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAInD,QAAA,MAAM,QAAQ;;;CAGb,CAAA;AAED,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,QAAQ,EACR,aAAa,GACd,CAAA"}

package/dist/esm/browser.js

@@ -0,0 +1,11 @@
+import { asDependencyTypeShort } from './dependencies.js';
+import { getBooleanFlagsFromNum } from './lockfile/types.js';
+import { stringifyNode } from './stringify-node.js';
+import { loadEdges } from './lockfile/load-edges.js';
+import { loadNodes } from './lockfile/load-nodes.js';
+const lockfile = {
+    loadEdges,
+    loadNodes,
+};
+export { asDependencyTypeShort, getBooleanFlagsFromNum, lockfile, stringifyNode, };
+//# sourceMappingURL=browser.js.map

package/dist/esm/browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../../src/browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AACzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAEpD,MAAM,QAAQ,GAAG;IACf,SAAS;IACT,SAAS;CACV,CAAA;AAED,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,QAAQ,EACR,aAAa,GACd,CAAA","sourcesContent":["import { asDependencyTypeShort } from './dependencies.js'\nimport { getBooleanFlagsFromNum } from './lockfile/types.js'\nimport { stringifyNode } from './stringify-node.js'\nimport { loadEdges } from './lockfile/load-edges.js'\nimport { loadNodes } from './lockfile/load-nodes.js'\n\nconst lockfile = {\n  loadEdges,\n  loadNodes,\n}\n\nexport {\n  asDependencyTypeShort,\n  getBooleanFlagsFromNum,\n  lockfile,\n  stringifyNode,\n}\n"]}

package/dist/esm/dependencies.d.ts

@@ -0,0 +1,69 @@
+import type { DepID } from '@vltpkg/dep-id';
+import { type Spec } from '@vltpkg/spec';
+import { type Manifest } from '@vltpkg/types';
+/**
+ * Name of the package.json keys used to define different types of dependencies.
+ */
+export type DependencyTypeLong = 'dependencies' | 'devDependencies' | 'optionalDependencies' | 'peerDependencies';
+/**
+ * Unique keys that define different types of dependencies relationship.
+ */
+export type DependencyTypeShort = 'dev' | 'optional' | 'peer' | 'peerOptional' | 'prod';
+export declare const isDependencyTypeShort: (obj: any) => obj is DependencyTypeShort;
+export declare const asDependencyTypeShort: (obj: any) => DependencyTypeShort;
+/**
+ * Dependency entries info as defined in a package.json file.
+ */
+export type RawDependency = {
+    name: string;
+    bareSpec: string;
+    type: DependencyTypeLong;
+    registry?: string;
+};
+/**
+ * Parsed dependency entries info.
+ */
+export type Dependency = {
+    /**
+     * The parsed {@link Spec} object describing the dependency requirements.
+     */
+    spec: Spec;
+    /**
+     * The {@link DependencyTypeShort}, describing the type of dependency.
+     */
+    type: DependencyTypeShort;
+};
+/**
+ * A `Map` in which keys are {@link DepID} linking to another `Map` in which
+ * keys are the dependency names and values are {@link Dependency}. This
+ * structure represents dependencies that need to be added to the importer
+ * represented by {@link DepID}.
+ */
+export type AddImportersDependenciesMap = Map<DepID, Map<string, Dependency>>;
+/**
+ * A `Map` object representing nodes to be removed from the ideal graph.
+ * Each {@link DepID} key represents an importer node and the `Set` of
+ * dependency names to be removed from its dependency list.
+ */
+export type RemoveImportersDependenciesMap = Map<DepID, Set<string>>;
+export declare const isDependency: (obj: any) => obj is Dependency;
+export declare const asDependency: (obj: any) => Dependency;
+/**
+ * A set of the possible long dependency type names,
+ * as used in `package.json` files.
+ */
+export declare const longDependencyTypes: Set<DependencyTypeLong>;
+/**
+ * A set of the short type keys used to represent dependency relationships.
+ */
+export declare const shortDependencyTypes: Set<DependencyTypeShort>;
+/**
+ * Maps between long form names usually used in `package.json` files
+ * to a corresponding short form name, used in lockfiles.
+ */
+export declare const dependencyTypes: Map<DependencyTypeLong, DependencyTypeShort>;
+/**
+ * Get the {@link DependencyTypeShort} from a {@link DependencyTypeLong}.
+ */
+export declare const shorten: (typeLong: DependencyTypeLong, name?: string, manifest?: Manifest) => DependencyTypeShort;
+//# sourceMappingURL=dependencies.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dependencies.d.ts","sourceRoot":"","sources":["../../src/dependencies.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAE3C,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,eAAe,CAAA;AAE7C;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,cAAc,GACd,iBAAiB,GACjB,sBAAsB,GACtB,kBAAkB,CAAA;AAEtB;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC3B,KAAK,GACL,UAAU,GACV,MAAM,GACN,cAAc,GACd,MAAM,CAAA;AAEV,eAAO,MAAM,qBAAqB,QAC3B,GAAG,KACP,GAAG,IAAI,mBAAoD,CAAA;AAE9D,eAAO,MAAM,qBAAqB,QAC3B,GAAG,KACP,mBAQF,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,kBAAkB,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAA;IACV;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAA;CAC1B,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,2BAA2B,GAAG,GAAG,CAC3C,KAAK,EACL,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CACxB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,8BAA8B,GAAG,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAA;AAEpE,eAAO,MAAM,YAAY,QAAS,GAAG,KAAG,GAAG,IAAI,UAEmB,CAAA;AAElE,eAAO,MAAM,YAAY,QAAS,GAAG,KAAG,UAKvC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,yBAK9B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,0BAM/B,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,8CAQ1B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,aACR,kBAAkB,SACrB,MAAM,aACF,QAAQ,KAClB,mBAkBF,CAAA"}

package/dist/esm/dependencies.js

@@ -0,0 +1,71 @@
+import { error } from '@vltpkg/error-cause';
+export const isDependencyTypeShort = (obj) => shortDependencyTypes.has(obj);
+export const asDependencyTypeShort = (obj) => {
+    if (!isDependencyTypeShort(obj)) {
+        throw error('Invalid dependency type', {
+            found: obj,
+            validOptions: [...shortDependencyTypes],
+        });
+    }
+    return obj;
+};
+export const isDependency = (obj) => 
+// TODO: it would be nice to have a @vltpkg/spec.isSpec method
+obj?.spec?.type && obj?.type && isDependencyTypeShort(obj?.type);
+export const asDependency = (obj) => {
+    if (!isDependency(obj)) {
+        throw error('Invalid dependency', { found: obj });
+    }
+    return obj;
+};
+/**
+ * A set of the possible long dependency type names,
+ * as used in `package.json` files.
+ */
+export const longDependencyTypes = new Set([
+    'dependencies',
+    'devDependencies',
+    'peerDependencies',
+    'optionalDependencies',
+]);
+/**
+ * A set of the short type keys used to represent dependency relationships.
+ */
+export const shortDependencyTypes = new Set([
+    'prod',
+    'dev',
+    'peer',
+    'optional',
+    'peerOptional',
+]);
+/**
+ * Maps between long form names usually used in `package.json` files
+ * to a corresponding short form name, used in lockfiles.
+ */
+export const dependencyTypes = new Map([
+    ['dependencies', 'prod'],
+    ['devDependencies', 'dev'],
+    ['peerDependencies', 'peer'],
+    ['optionalDependencies', 'optional'],
+]);
+/**
+ * Get the {@link DependencyTypeShort} from a {@link DependencyTypeLong}.
+ */
+export const shorten = (typeLong, name, manifest) => {
+    const shortName = dependencyTypes.get(typeLong);
+    if (!shortName) {
+        throw error('Invalid dependency type name', {
+            found: typeLong,
+            validOptions: [...longDependencyTypes],
+        });
+    }
+    if (shortName !== 'peer') {
+        return shortName;
+    }
+    if (name &&
+        manifest?.peerDependenciesMeta?.[name]?.optional === true) {
+        return 'peerOptional';
+    }
+    return 'peer';
+};
+//# sourceMappingURL=dependencies.js.map

package/dist/esm/dependencies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dependencies.js","sourceRoot":"","sources":["../../src/dependencies.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAuB3C,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,GAAQ,EACoB,EAAE,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;AAE9D,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,GAAQ,EACa,EAAE;IACvB,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC;QAChC,MAAM,KAAK,CAAC,yBAAyB,EAAE;YACrC,KAAK,EAAE,GAAG;YACV,YAAY,EAAE,CAAC,GAAG,oBAAoB,CAAC;SACxC,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AA4CD,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,GAAQ,EAAqB,EAAE;AAC1D,8DAA8D;AAC9D,GAAG,EAAE,IAAI,EAAE,IAAI,IAAI,GAAG,EAAE,IAAI,IAAI,qBAAqB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;AAElE,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,GAAQ,EAAc,EAAE;IACnD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,KAAK,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;IACnD,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAqB;IAC7D,cAAc;IACd,iBAAiB;IACjB,kBAAkB;IAClB,sBAAsB;CACvB,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAsB;IAC/D,MAAM;IACN,KAAK;IACL,MAAM;IACN,UAAU;IACV,cAAc;CACf,CAAC,CAAA;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,GAAG,CAGpC;IACA,CAAC,cAAc,EAAE,MAAM,CAAC;IACxB,CAAC,iBAAiB,EAAE,KAAK,CAAC;IAC1B,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAC5B,CAAC,sBAAsB,EAAE,UAAU,CAAC;CACrC,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CACrB,QAA4B,EAC5B,IAAa,EACb,QAAmB,EACE,EAAE;IACvB,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IAC/C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,KAAK,CAAC,8BAA8B,EAAE;YAC1C,KAAK,EAAE,QAAQ;YACf,YAAY,EAAE,CAAC,GAAG,mBAAmB,CAAC;SACvC,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;QACzB,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,IACE,IAAI;QACJ,QAAQ,EAAE,oBAAoB,EAAE,CAAC,IAAI,CAAC,EAAE,QAAQ,KAAK,IAAI,EACzD,CAAC;QACD,OAAO,cAAc,CAAA;IACvB,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA","sourcesContent":["import type { DepID } from '@vltpkg/dep-id'\nimport { error } from '@vltpkg/error-cause'\nimport { type Spec } from '@vltpkg/spec'\nimport { type Manifest } from '@vltpkg/types'\n\n/**\n * Name of the package.json keys used to define different types of dependencies.\n */\nexport type DependencyTypeLong =\n  | 'dependencies'\n  | 'devDependencies'\n  | 'optionalDependencies'\n  | 'peerDependencies'\n\n/**\n * Unique keys that define different types of dependencies relationship.\n */\nexport type DependencyTypeShort =\n  | 'dev'\n  | 'optional'\n  | 'peer'\n  | 'peerOptional'\n  | 'prod'\n\nexport const isDependencyTypeShort = (\n  obj: any,\n): obj is DependencyTypeShort => shortDependencyTypes.has(obj)\n\nexport const asDependencyTypeShort = (\n  obj: any,\n): DependencyTypeShort => {\n  if (!isDependencyTypeShort(obj)) {\n    throw error('Invalid dependency type', {\n      found: obj,\n      validOptions: [...shortDependencyTypes],\n    })\n  }\n  return obj\n}\n\n/**\n * Dependency entries info as defined in a package.json file.\n */\nexport type RawDependency = {\n  name: string\n  bareSpec: string\n  type: DependencyTypeLong\n  registry?: string\n}\n\n/**\n * Parsed dependency entries info.\n */\nexport type Dependency = {\n  /**\n   * The parsed {@link Spec} object describing the dependency requirements.\n   */\n  spec: Spec\n  /**\n   * The {@link DependencyTypeShort}, describing the type of dependency.\n   */\n  type: DependencyTypeShort\n}\n\n/**\n * A `Map` in which keys are {@link DepID} linking to another `Map` in which\n * keys are the dependency names and values are {@link Dependency}. This\n * structure represents dependencies that need to be added to the importer\n * represented by {@link DepID}.\n */\nexport type AddImportersDependenciesMap = Map<\n  DepID,\n  Map<string, Dependency>\n>\n\n/**\n * A `Map` object representing nodes to be removed from the ideal graph.\n * Each {@link DepID} key represents an importer node and the `Set` of\n * dependency names to be removed from its dependency list.\n */\nexport type RemoveImportersDependenciesMap = Map<DepID, Set<string>>\n\nexport const isDependency = (obj: any): obj is Dependency =>\n  // TODO: it would be nice to have a @vltpkg/spec.isSpec method\n  obj?.spec?.type && obj?.type && isDependencyTypeShort(obj?.type)\n\nexport const asDependency = (obj: any): Dependency => {\n  if (!isDependency(obj)) {\n    throw error('Invalid dependency', { found: obj })\n  }\n  return obj\n}\n\n/**\n * A set of the possible long dependency type names,\n * as used in `package.json` files.\n */\nexport const longDependencyTypes = new Set<DependencyTypeLong>([\n  'dependencies',\n  'devDependencies',\n  'peerDependencies',\n  'optionalDependencies',\n])\n\n/**\n * A set of the short type keys used to represent dependency relationships.\n */\nexport const shortDependencyTypes = new Set<DependencyTypeShort>([\n  'prod',\n  'dev',\n  'peer',\n  'optional',\n  'peerOptional',\n])\n\n/**\n * Maps between long form names usually used in `package.json` files\n * to a corresponding short form name, used in lockfiles.\n */\nexport const dependencyTypes = new Map<\n  DependencyTypeLong,\n  DependencyTypeShort\n>([\n  ['dependencies', 'prod'],\n  ['devDependencies', 'dev'],\n  ['peerDependencies', 'peer'],\n  ['optionalDependencies', 'optional'],\n])\n\n/**\n * Get the {@link DependencyTypeShort} from a {@link DependencyTypeLong}.\n */\nexport const shorten = (\n  typeLong: DependencyTypeLong,\n  name?: string,\n  manifest?: Manifest,\n): DependencyTypeShort => {\n  const shortName = dependencyTypes.get(typeLong)\n  if (!shortName) {\n    throw error('Invalid dependency type name', {\n      found: typeLong,\n      validOptions: [...longDependencyTypes],\n    })\n  }\n  if (shortName !== 'peer') {\n    return shortName\n  }\n  if (\n    name &&\n    manifest?.peerDependenciesMeta?.[name]?.optional === true\n  ) {\n    return 'peerOptional'\n  }\n  return 'peer'\n}\n"]}

package/dist/esm/diff.d.ts

@@ -0,0 +1,49 @@
+import { InspectOptions } from 'node:util';
+import { Edge } from './edge.js';
+import { Graph } from './graph.js';
+import { Node } from './node.js';
+declare const kCustomInspect: unique symbol;
+/**
+ * A Diff object is a representation of a set of changes from one
+ * graph to another, typically from the actual graph as it is reified
+ * on disk, to an intended ideal graph.
+ *
+ * The naming convention can get a bit confusing here, because it's a
+ * set of directed changes from one set of directed objects to another.
+ *
+ * Within the context the Diff object, `from` is the Graph we're coming from,
+ * and `to` is the Graph we're trying to create.
+ */
+export declare class Diff {
+    from: Graph;
+    to: Graph;
+    projectRoot: string;
+    /**
+     * If changes need to be made later for failures of optional nodes,
+     * set this flag so that we know to call graph.gc() at the appropriate time.
+     */
+    hadOptionalFailures: boolean;
+    /**
+     * Collection of nodes to add and delete
+     */
+    nodes: {
+        /** Nodes in the `to` graph that are not in the `from` graph */
+        add: Set<Node>;
+        /** Nodes in the `from` graph that are not in the `to` graph */
+        delete: Set<Node>;
+    };
+    /**
+     * Collection of nodes to add and delete
+     */
+    edges: {
+        /** Edges in the `to` graph that are not found in the `from` graph */
+        add: Set<Edge>;
+        /** Edges in the `from` graph that are not found in the `to` graph */
+        delete: Set<Edge>;
+    };
+    get [Symbol.toStringTag](): string;
+    constructor(from: Graph, to: Graph);
+    [kCustomInspect](_: number, options?: InspectOptions): string;
+}
+export {};
+//# sourceMappingURL=diff.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"diff.d.ts","sourceRoot":"","sources":["../../src/diff.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAOhC,QAAA,MAAM,cAAc,eAA2C,CAAA;AAE/D;;;;;;;;;;GAUG;AACH,qBAAa,IAAI;IACf,IAAI,EAAE,KAAK,CAAA;IACX,EAAE,EAAE,KAAK,CAAA;IAET,WAAW,EAAE,MAAM,CAAA;IAEnB;;;OAGG;IACH,mBAAmB,UAAQ;IAE3B;;OAEG;IACH,KAAK;QACH,+DAA+D;;QAE/D,+DAA+D;;MAEhE;IAED;;OAEG;IACH,KAAK;QACH,qEAAqE;;QAErE,qEAAqE;;MAEtE;IAED,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,WAEvB;gBAEW,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK;IAyClC,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,MAAM;CAuC9D"}