@vltpkg/graph 0.0.0-0.1730239248325

package/dist/esm/graph.js

@@ -0,0 +1,301 @@
+import { getId, joinDepIDTuple } from '@vltpkg/dep-id';
+import { error } from '@vltpkg/error-cause';
+import { satisfies } from '@vltpkg/satisfies';
+import { Spec } from '@vltpkg/spec';
+import { inspect } from 'util';
+import { lockfileData } from './lockfile/save.js';
+import { Node } from './node.js';
+const kCustomInspect = Symbol.for('nodejs.util.inspect.custom');
+// this is always the same, but we don't hard code it as a string,
+// in case the DepID module needs to change its delimiter again ever.
+const mainDepID = joinDepIDTuple(['file', '.']);
+export class Graph {
+    get [Symbol.toStringTag]() {
+        return '@vltpkg/graph.Graph';
+    }
+    #options;
+    #nodeOptions;
+    /**
+     * A {@link Monorepo} instance, used for managing workspaces.
+     */
+    monorepo;
+    /**
+     * An inventory with all manifests related to an install.
+     */
+    manifests;
+    /**
+     * A set of all edges in this graph.
+     */
+    edges = new Set();
+    /**
+     * Map registered dep ids to the node that represent them in the graph.
+     */
+    nodes = new Map();
+    /**
+     * Map of nodes by their name
+     */
+    nodesByName = new Map();
+    /**
+     * Cached resolutions for spec lookups
+     */
+    resolutions = new Map();
+    /**
+     * Reverse map of resolutions
+     */
+    resolutionsReverse = new Map();
+    /**
+     * A set of importer nodes in this graph.
+     */
+    importers = new Set();
+    /**
+     * The {@link Node} that represents the project root `package.json`.
+     */
+    mainImporter;
+    /**
+     * A set of extraneous dependencies found when building the graph.
+     */
+    extraneousDependencies = new Set();
+    /**
+     * The root of the project this graph represents
+     */
+    projectRoot;
+    constructor(options) {
+        const { mainManifest, manifests, monorepo, projectRoot } = options;
+        this.#options = options;
+        this.manifests = manifests ?? new Map();
+        this.projectRoot = projectRoot;
+        this.#nodeOptions = {
+            ...this.#options,
+            graph: this,
+        };
+        // add the project root node
+        const mainImporterLocation = '.';
+        const mainImporterSpec = Spec.parse(mainManifest.name || '(root)', mainImporterLocation);
+        const mainImporter = this.addNode(mainDepID, mainManifest, mainImporterSpec);
+        mainImporter.setImporterLocation(mainImporterLocation);
+        mainImporter.mainImporter = true;
+        this.mainImporter = mainImporter;
+        this.importers.add(mainImporter);
+        this.manifests.set(mainImporter.id, mainManifest);
+        // uses the monorepo instance in order to retrieve info on
+        // workspaces and create importer nodes for each of them
+        this.monorepo = monorepo;
+        if (this.monorepo) {
+            for (const ws of this.monorepo) {
+                const wsNode = this.addNode(ws.id, ws.manifest, undefined, ws.name);
+                wsNode.setImporterLocation(`./${ws.path}`);
+                if (wsNode.manifest) {
+                    this.manifests.set(wsNode.id, wsNode.manifest);
+                }
+                this.importers.add(wsNode);
+            }
+        }
+    }
+    /**
+     * Delete all nodes that are unreachable from the importers.
+     * The collection of deleted nodes is returned.
+     *
+     * NOTE: This can be extremely slow for large graphs, and is almost always
+     * unnecessary! Only call when it is known that some unreachable nodes may
+     * have been created, for example when deleting the unneeded subgraph when an
+     * optional node fails to resolve/install.
+     */
+    gc() {
+        const { nodes } = this;
+        this.nodes = new Map();
+        const marked = new Set(this.importers);
+        for (const imp of marked) {
+            // don't delete the importer!
+            nodes.delete(imp.id);
+            this.nodes.set(imp.id, imp);
+            for (const { to } of imp.edgesOut.values()) {
+                if (!to || marked.has(to))
+                    continue;
+                marked.add(to);
+                nodes.delete(to.id);
+                this.nodes.set(to.id, to);
+            }
+        }
+        for (const node of nodes.values()) {
+            this.removeNode(node);
+        }
+        return nodes;
+    }
+    /**
+     * Create a new edge between two nodes of the graph in case both exist,
+     * in case the destination node does not exists, then a dangling edge,
+     * pointing to nothing will be created to represent that missing dependency.
+     */
+    addEdge(type, spec, from, to) {
+        // fix any nameless spec
+        if (spec.name === '(unknown)') {
+            if (to) {
+                spec.name = to.name /* c8 ignore next */ || '(unknown)';
+                spec.spec = `${to.name}@${spec.bareSpec}`;
+            }
+            else {
+                throw error('Impossible to place a missing, nameless dependency', { spec });
+            }
+        }
+        const existing = from.edgesOut.get(spec.name);
+        if (existing) {
+            const edge = existing;
+            if (edge.type === type &&
+                edge.spec.bareSpec === spec.bareSpec) {
+                if (to && to !== edge.to) {
+                    edge.to = to;
+                    edge.to.edgesIn.add(edge);
+                }
+                return edge;
+            }
+            this.edges.delete(edge);
+        }
+        const f = from;
+        const edgeOut = f.addEdgesTo(type, spec, to);
+        this.edges.add(edgeOut);
+        return edgeOut;
+    }
+    /**
+     * Find an existing node to satisfy a dependency
+     */
+    findResolution(spec, fromNode) {
+        const f = spec.final;
+        // if it's a file: dep, then the fromNode location matters
+        const fromPref = f.type === 'file' ? fromNode.location + ' : ' : '';
+        const sf = fromPref + String(f);
+        const cached = this.resolutions.get(sf);
+        if (cached)
+            return cached;
+        const nbn = this.nodesByName.get(f.name);
+        if (!nbn)
+            return undefined;
+        for (const node of nbn) {
+            if (satisfies(node.id, f, fromNode.location, this.projectRoot, this.monorepo)) {
+                this.resolutions.set(sf, node);
+                // always set by now, because the node was added at some point
+                this.resolutionsReverse.get(node)?.add(sf);
+                return node;
+            }
+        }
+    }
+    /**
+     * Create a new node in the graph.
+     */
+    addNode(id, manifest, spec, name, version) {
+        const node = new Node(this.#nodeOptions, id, manifest, spec, name, version);
+        this.nodes.set(node.id, node);
+        const nbn = this.nodesByName.get(node.name) ?? new Set();
+        nbn.add(node);
+        this.nodesByName.set(node.name, nbn);
+        if (spec) {
+            const f = String(spec.final);
+            // if it's a file: type, then that is fromNode-specific,
+            // so we can't shortcut add it here.
+            if (spec.final.type !== 'file') {
+                this.resolutions.set(f, node);
+                const rrev = this.resolutionsReverse.get(node) ?? new Set();
+                rrev.add(f);
+                this.resolutionsReverse.set(node, rrev);
+            }
+        }
+        if (manifest) {
+            this.manifests.set(node.id, manifest);
+        }
+        return node;
+    }
+    /**
+     * Place a new package into the graph representation, creating the new
+     * edges and possibly new nodes that are to be expected when traversing
+     * the graph in a top-down direction, e.g: from importers to leafs.
+     *
+     * For different uses that are not a direct top-down traversal of the graph
+     * consider using `addNode()` and `addEdge()` instead.
+     */
+    placePackage(fromNode, depType, spec, manifest, id) {
+        // if no manifest is available, then create an edge that has no
+        // reference to any other node, representing a missing dependency
+        if (!manifest && !id) {
+            this.addEdge(depType, spec, fromNode);
+            return;
+        }
+        // flags set on the node we're about to create or find.
+        const flags = {
+            dev: fromNode.dev || depType === 'dev',
+            optional: fromNode.optional ||
+                depType === 'optional' ||
+                depType === 'peerOptional',
+        };
+        const depId = id || (manifest && getId(spec, manifest));
+        /* c8 ignore start - should not be possible */
+        if (!depId) {
+            throw error('Could not find dep id when placing package', {
+                spec,
+                manifest,
+            });
+        }
+        /* c8 ignore stop */
+        // if a node for this package is already represented by a node
+        // in the graph, then just creates a new edge to that node
+        const toFoundNode = this.nodes.get(depId);
+        if (toFoundNode) {
+            this.addEdge(depType, spec, fromNode, toFoundNode);
+            // the current only stays dev/optional if this dep lets it remain so
+            // if it's not already, we don't make it dev or optional.
+            toFoundNode.dev &&= flags.dev;
+            toFoundNode.optional &&= flags.optional;
+            return toFoundNode;
+        }
+        // creates a new node and edges to its parent
+        const toNode = this.addNode(depId, manifest);
+        toNode.registry = spec.registry;
+        toNode.dev = flags.dev;
+        toNode.optional = flags.optional;
+        this.addEdge(depType, spec, fromNode, toNode);
+        return toNode;
+    }
+    /**
+     * Removes a node and its relevant edges from the graph.
+     *
+     * If a replacement is provided, then any edges that were previously
+     * pointing to the removed node will be directed to the replacement,
+     * if it is valid to do so.
+     */
+    removeNode(node, replacement) {
+        this.nodes.delete(node.id);
+        const nbn = this.nodesByName.get(node.name);
+        // if it's the last one, just remove the set
+        if (nbn?.size === 1)
+            this.nodesByName.delete(node.name);
+        else
+            nbn?.delete(node);
+        for (const r of this.resolutionsReverse.get(node) ?? new Set()) {
+            this.resolutions.delete(r);
+        }
+        this.resolutionsReverse.delete(node);
+        this.manifests.delete(node.id);
+        for (const edge of node.edgesOut.values()) {
+            this.edges.delete(edge);
+        }
+        for (const edge of node.edgesIn) {
+            if (replacement &&
+                satisfies(replacement.id, edge.spec, edge.from.location, this.projectRoot, this.monorepo)) {
+                edge.to = replacement;
+            }
+            else {
+                edge.to = undefined;
+            }
+        }
+    }
+    toJSON() {
+        return lockfileData({
+            ...this.#options,
+            graph: this,
+            saveManifests: true,
+        });
+    }
+    [kCustomInspect](_, options) {
+        const data = this.toJSON();
+        return `${this[Symbol.toStringTag]} ${inspect(data, options)}`;
+    }
+}
+//# sourceMappingURL=graph.js.map

package/dist/esm/graph.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"graph.js","sourceRoot":"","sources":["../../src/graph.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,cAAc,EAAc,MAAM,gBAAgB,CAAA;AAClE,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,IAAI,EAAoB,MAAM,cAAc,CAAA;AAGrD,OAAO,EAAE,OAAO,EAAkB,MAAM,MAAM,CAAA;AAG9C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EAAE,IAAI,EAAe,MAAM,WAAW,CAAA;AAG7C,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAA;AAE/D,kEAAkE;AAClE,qEAAqE;AACrE,MAAM,SAAS,GAAG,cAAc,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;AAuB/C,MAAM,OAAO,KAAK;IAChB,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACtB,OAAO,qBAAqB,CAAA;IAC9B,CAAC;IAED,QAAQ,CAAc;IAEtB,YAAY,CAAa;IAEzB;;OAEG;IACH,QAAQ,CAAW;IAEnB;;OAEG;IACH,SAAS,CAAmB;IAE5B;;OAEG;IACH,KAAK,GAAG,IAAI,GAAG,EAAQ,CAAA;IAEvB;;OAEG;IACH,KAAK,GAAG,IAAI,GAAG,EAAe,CAAA;IAE9B;;OAEG;IACH,WAAW,GAAG,IAAI,GAAG,EAAqB,CAAA;IAE1C;;OAEG;IACH,WAAW,GAAG,IAAI,GAAG,EAAgB,CAAA;IAErC;;OAEG;IACH,kBAAkB,GAAG,IAAI,GAAG,EAAqB,CAAA;IAEjD;;OAEG;IACH,SAAS,GAAG,IAAI,GAAG,EAAQ,CAAA;IAE3B;;OAEG;IACH,YAAY,CAAM;IAElB;;OAEG;IACH,sBAAsB,GAAG,IAAI,GAAG,EAAQ,CAAA;IAExC;;OAEG;IACH,WAAW,CAAQ;IAEnB,YAAY,OAAqB;QAC/B,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,OAAO,CAAA;QAClE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;QACvB,IAAI,CAAC,SAAS,GAAG,SAAS,IAAI,IAAI,GAAG,EAAE,CAAA;QACvC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,YAAY,GAAG;YAClB,GAAG,IAAI,CAAC,QAAQ;YAChB,KAAK,EAAE,IAAI;SACZ,CAAA;QAED,4BAA4B;QAC5B,MAAM,oBAAoB,GAAG,GAAG,CAAA;QAChC,MAAM,gBAAgB,GAAG,IAAI,CAAC,KAAK,CACjC,YAAY,CAAC,IAAI,IAAI,QAAQ,EAC7B,oBAAoB,CACrB,CAAA;QACD,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAC/B,SAAS,EACT,YAAY,EACZ,gBAAgB,CACjB,CAAA;QACD,YAAY,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAA;QACtD,YAAY,CAAC,YAAY,GAAG,IAAI,CAAA;QAChC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;QAChC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;QAChC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,EAAE,YAAY,CAAC,CAAA;QAEjD,0DAA0D;QAC1D,wDAAwD;QACxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CACzB,EAAE,CAAC,EAAE,EACL,EAAE,CAAC,QAAQ,EACX,SAAS,EACT,EAAE,CAAC,IAAI,CACR,CAAA;gBACD,MAAM,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC,CAAA;gBAC1C,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;oBACpB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;gBAChD,CAAC;gBACD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;YAC5B,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,EAAE;QACA,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAA;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,EAAE,CAAA;QACtB,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACtC,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;YACzB,6BAA6B;YAC7B,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YACpB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;YAC3B,KAAK,MAAM,EAAE,EAAE,EAAE,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC;gBAC3C,IAAI,CAAC,EAAE,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;oBAAE,SAAQ;gBACnC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;gBACd,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAA;gBACnB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;YAC3B,CAAC;QACH,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC;YAClC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;QACvB,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;OAIG;IACH,OAAO,CACL,IAAyB,EACzB,IAAU,EACV,IAAc,EACd,EAAa;QAEb,wBAAwB;QACxB,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YAC9B,IAAI,EAAE,EAAE,CAAC;gBACP,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC,IAAI,CAAC,oBAAoB,IAAI,WAAW,CAAA;gBACvD,IAAI,CAAC,IAAI,GAAG,GAAG,EAAE,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAA;YAC3C,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,CACT,oDAAoD,EACpD,EAAE,IAAI,EAAE,CACT,CAAA;YACH,CAAC;QACH,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC7C,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,IAAI,GAAG,QAAgB,CAAA;YAC7B,IACE,IAAI,CAAC,IAAI,KAAK,IAAI;gBAClB,IAAI,CAAC,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ,EACpC,CAAC;gBACD,IAAI,EAAE,IAAI,EAAE,KAAK,IAAI,CAAC,EAAE,EAAE,CAAC;oBACzB,IAAI,CAAC,EAAE,GAAG,EAAU,CAAA;oBACpB,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;gBAC3B,CAAC;gBACD,OAAO,IAAI,CAAA;YACb,CAAC;YACD,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QACzB,CAAC;QACD,MAAM,CAAC,GAAG,IAAY,CAAA;QACtB,MAAM,OAAO,GAAG,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,EAAsB,CAAC,CAAA;QAChE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QACvB,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,IAAU,EAAE,QAAc;QACvC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAA;QACpB,0DAA0D;QAC1D,MAAM,QAAQ,GACZ,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;QACpD,MAAM,EAAE,GAAG,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;QAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QACvC,IAAI,MAAM;YAAE,OAAO,MAAM,CAAA;QACzB,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;QACxC,IAAI,CAAC,GAAG;YAAE,OAAO,SAAS,CAAA;QAC1B,KAAK,MAAM,IAAI,IAAI,GAAG,EAAE,CAAC;YACvB,IACE,SAAS,CACP,IAAI,CAAC,EAAE,EACP,CAAC,EACD,QAAQ,CAAC,QAAQ,EACjB,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,QAAQ,CACd,EACD,CAAC;gBACD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;gBAC9B,8DAA8D;gBAC9D,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAA;gBAC1C,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,OAAO,CACL,EAAU,EACV,QAAmB,EACnB,IAAW,EACX,IAAa,EACb,OAAgB;QAEhB,MAAM,IAAI,GAAG,IAAI,IAAI,CACnB,IAAI,CAAC,YAAY,EACjB,EAAE,EACF,QAAQ,EACR,IAAI,EACJ,IAAI,EACJ,OAAO,CACR,CAAA;QACD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;QAC7B,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,EAAE,CAAA;QACxD,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACb,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;QACpC,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAC5B,wDAAwD;YACxD,oCAAoC;YACpC,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBAC/B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA;gBAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,EAAE,CAAA;gBAC3D,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;gBACX,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;YACzC,CAAC;QACH,CAAC;QACD,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;QACvC,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CACV,QAAc,EACd,OAA4B,EAC5B,IAAU,EACV,QAAmB,EACnB,EAAU;QAEV,+DAA+D;QAC/D,iEAAiE;QACjE,IAAI,CAAC,QAAQ,IAAI,CAAC,EAAE,EAAE,CAAC;YACrB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;YACrC,OAAM;QACR,CAAC;QAED,uDAAuD;QACvD,MAAM,KAAK,GAAG;YACZ,GAAG,EAAE,QAAQ,CAAC,GAAG,IAAI,OAAO,KAAK,KAAK;YACtC,QAAQ,EACN,QAAQ,CAAC,QAAQ;gBACjB,OAAO,KAAK,UAAU;gBACtB,OAAO,KAAK,cAAc;SAC7B,CAAA;QAED,MAAM,KAAK,GAAG,EAAE,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAA;QAEvD,8CAA8C;QAC9C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,KAAK,CAAC,4CAA4C,EAAE;gBACxD,IAAI;gBACJ,QAAQ;aACT,CAAC,CAAA;QACJ,CAAC;QACD,oBAAoB;QAEpB,8DAA8D;QAC9D,0DAA0D;QAC1D,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QACzC,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAA;YAClD,oEAAoE;YACpE,yDAAyD;YACzD,WAAW,CAAC,GAAG,KAAK,KAAK,CAAC,GAAG,CAAA;YAC7B,WAAW,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,CAAA;YACvC,OAAO,WAAW,CAAA;QACpB,CAAC;QAED,6CAA6C;QAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QAC5C,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;QAC/B,MAAM,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAA;QACtB,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAA;QAChC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAA;QAC7C,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,IAAU,EAAE,WAAkB;QACvC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC3C,4CAA4C;QAC5C,IAAI,GAAG,EAAE,IAAI,KAAK,CAAC;YAAE,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;;YAClD,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;QACtB,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,EAAE,EAAE,CAAC;YAC/D,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;QAC5B,CAAC;QACD,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QACpC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAC9B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC;YAC1C,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QACzB,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAChC,IACE,WAAW;gBACX,SAAS,CACP,WAAW,CAAC,EAAE,EACd,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,IAAI,CAAC,QAAQ,EAClB,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,QAAQ,CACd,EACD,CAAC;gBACD,IAAI,CAAC,EAAE,GAAG,WAAW,CAAA;YACvB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,EAAE,GAAG,SAAS,CAAA;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM;QACJ,OAAO,YAAY,CAAC;YAClB,GAAG,IAAI,CAAC,QAAQ;YAChB,KAAK,EAAE,IAAI;YACX,aAAa,EAAE,IAAI;SACpB,CAAC,CAAA;IACJ,CAAC;IAED,CAAC,cAAc,CAAC,CAAC,CAAS,EAAE,OAAuB;QACjD,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,CAAA;QAC1B,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAA;IAChE,CAAC;CACF","sourcesContent":["import { getId, joinDepIDTuple, type DepID } from '@vltpkg/dep-id'\nimport { error } from '@vltpkg/error-cause'\nimport { satisfies } from '@vltpkg/satisfies'\nimport { Spec, type SpecOptions } from '@vltpkg/spec'\nimport { type Manifest } from '@vltpkg/types'\nimport { Monorepo } from '@vltpkg/workspaces'\nimport { inspect, InspectOptions } from 'util'\nimport { DependencyTypeShort } from './dependencies.js'\nimport { type Edge } from './edge.js'\nimport { lockfileData } from './lockfile/save.js'\nimport { Node, NodeOptions } from './node.js'\nimport { GraphLike, NodeLike } from './types.js'\n\nconst kCustomInspect = Symbol.for('nodejs.util.inspect.custom')\n\n// this is always the same, but we don't hard code it as a string,\n// in case the DepID module needs to change its delimiter again ever.\nconst mainDepID = joinDepIDTuple(['file', '.'])\n\nexport type ManifestInventory = Map<DepID, Manifest>\n\nexport type GraphOptions = SpecOptions & {\n  /**\n   * The main importer manifest info.\n   */\n  mainManifest: Manifest\n  /**\n   * An inventory of seen manifests.\n   */\n  manifests?: ManifestInventory\n  /**\n   * A {@link Monorepo} object, for managing workspaces\n   */\n  monorepo?: Monorepo\n  /**\n   * Root of the project this graph represents\n   */\n  projectRoot: string\n}\n\nexport class Graph implements GraphLike {\n  get [Symbol.toStringTag]() {\n    return '@vltpkg/graph.Graph'\n  }\n\n  #options: GraphOptions\n\n  #nodeOptions: NodeOptions\n\n  /**\n   * A {@link Monorepo} instance, used for managing workspaces.\n   */\n  monorepo?: Monorepo\n\n  /**\n   * An inventory with all manifests related to an install.\n   */\n  manifests: ManifestInventory\n\n  /**\n   * A set of all edges in this graph.\n   */\n  edges = new Set<Edge>()\n\n  /**\n   * Map registered dep ids to the node that represent them in the graph.\n   */\n  nodes = new Map<DepID, Node>()\n\n  /**\n   * Map of nodes by their name\n   */\n  nodesByName = new Map<string, Set<Node>>()\n\n  /**\n   * Cached resolutions for spec lookups\n   */\n  resolutions = new Map<string, Node>()\n\n  /**\n   * Reverse map of resolutions\n   */\n  resolutionsReverse = new Map<Node, Set<string>>()\n\n  /**\n   * A set of importer nodes in this graph.\n   */\n  importers = new Set<Node>()\n\n  /**\n   * The {@link Node} that represents the project root `package.json`.\n   */\n  mainImporter: Node\n\n  /**\n   * A set of extraneous dependencies found when building the graph.\n   */\n  extraneousDependencies = new Set<Edge>()\n\n  /**\n   * The root of the project this graph represents\n   */\n  projectRoot: string\n\n  constructor(options: GraphOptions) {\n    const { mainManifest, manifests, monorepo, projectRoot } = options\n    this.#options = options\n    this.manifests = manifests ?? new Map()\n    this.projectRoot = projectRoot\n    this.#nodeOptions = {\n      ...this.#options,\n      graph: this,\n    }\n\n    // add the project root node\n    const mainImporterLocation = '.'\n    const mainImporterSpec = Spec.parse(\n      mainManifest.name || '(root)',\n      mainImporterLocation,\n    )\n    const mainImporter = this.addNode(\n      mainDepID,\n      mainManifest,\n      mainImporterSpec,\n    )\n    mainImporter.setImporterLocation(mainImporterLocation)\n    mainImporter.mainImporter = true\n    this.mainImporter = mainImporter\n    this.importers.add(mainImporter)\n    this.manifests.set(mainImporter.id, mainManifest)\n\n    // uses the monorepo instance in order to retrieve info on\n    // workspaces and create importer nodes for each of them\n    this.monorepo = monorepo\n    if (this.monorepo) {\n      for (const ws of this.monorepo) {\n        const wsNode = this.addNode(\n          ws.id,\n          ws.manifest,\n          undefined,\n          ws.name,\n        )\n        wsNode.setImporterLocation(`./${ws.path}`)\n        if (wsNode.manifest) {\n          this.manifests.set(wsNode.id, wsNode.manifest)\n        }\n        this.importers.add(wsNode)\n      }\n    }\n  }\n\n  /**\n   * Delete all nodes that are unreachable from the importers.\n   * The collection of deleted nodes is returned.\n   *\n   * NOTE: This can be extremely slow for large graphs, and is almost always\n   * unnecessary! Only call when it is known that some unreachable nodes may\n   * have been created, for example when deleting the unneeded subgraph when an\n   * optional node fails to resolve/install.\n   */\n  gc() {\n    const { nodes } = this\n    this.nodes = new Map()\n    const marked = new Set(this.importers)\n    for (const imp of marked) {\n      // don't delete the importer!\n      nodes.delete(imp.id)\n      this.nodes.set(imp.id, imp)\n      for (const { to } of imp.edgesOut.values()) {\n        if (!to || marked.has(to)) continue\n        marked.add(to)\n        nodes.delete(to.id)\n        this.nodes.set(to.id, to)\n      }\n    }\n    for (const node of nodes.values()) {\n      this.removeNode(node)\n    }\n    return nodes\n  }\n\n  /**\n   * Create a new edge between two nodes of the graph in case both exist,\n   * in case the destination node does not exists, then a dangling edge,\n   * pointing to nothing will be created to represent that missing dependency.\n   */\n  addEdge(\n    type: DependencyTypeShort,\n    spec: Spec,\n    from: NodeLike,\n    to?: NodeLike,\n  ) {\n    // fix any nameless spec\n    if (spec.name === '(unknown)') {\n      if (to) {\n        spec.name = to.name /* c8 ignore next */ || '(unknown)'\n        spec.spec = `${to.name}@${spec.bareSpec}`\n      } else {\n        throw error(\n          'Impossible to place a missing, nameless dependency',\n          { spec },\n        )\n      }\n    }\n    const existing = from.edgesOut.get(spec.name)\n    if (existing) {\n      const edge = existing as Edge\n      if (\n        edge.type === type &&\n        edge.spec.bareSpec === spec.bareSpec\n      ) {\n        if (to && to !== edge.to) {\n          edge.to = to as Node\n          edge.to.edgesIn.add(edge)\n        }\n        return edge\n      }\n      this.edges.delete(edge)\n    }\n    const f = from as Node\n    const edgeOut = f.addEdgesTo(type, spec, to as Node | undefined)\n    this.edges.add(edgeOut)\n    return edgeOut\n  }\n\n  /**\n   * Find an existing node to satisfy a dependency\n   */\n  findResolution(spec: Spec, fromNode: Node) {\n    const f = spec.final\n    // if it's a file: dep, then the fromNode location matters\n    const fromPref =\n      f.type === 'file' ? fromNode.location + ' : ' : ''\n    const sf = fromPref + String(f)\n    const cached = this.resolutions.get(sf)\n    if (cached) return cached\n    const nbn = this.nodesByName.get(f.name)\n    if (!nbn) return undefined\n    for (const node of nbn) {\n      if (\n        satisfies(\n          node.id,\n          f,\n          fromNode.location,\n          this.projectRoot,\n          this.monorepo,\n        )\n      ) {\n        this.resolutions.set(sf, node)\n        // always set by now, because the node was added at some point\n        this.resolutionsReverse.get(node)?.add(sf)\n        return node\n      }\n    }\n  }\n\n  /**\n   * Create a new node in the graph.\n   */\n  addNode(\n    id?: DepID,\n    manifest?: Manifest,\n    spec?: Spec,\n    name?: string,\n    version?: string,\n  ) {\n    const node = new Node(\n      this.#nodeOptions,\n      id,\n      manifest,\n      spec,\n      name,\n      version,\n    )\n    this.nodes.set(node.id, node)\n    const nbn = this.nodesByName.get(node.name) ?? new Set()\n    nbn.add(node)\n    this.nodesByName.set(node.name, nbn)\n    if (spec) {\n      const f = String(spec.final)\n      // if it's a file: type, then that is fromNode-specific,\n      // so we can't shortcut add it here.\n      if (spec.final.type !== 'file') {\n        this.resolutions.set(f, node)\n        const rrev = this.resolutionsReverse.get(node) ?? new Set()\n        rrev.add(f)\n        this.resolutionsReverse.set(node, rrev)\n      }\n    }\n    if (manifest) {\n      this.manifests.set(node.id, manifest)\n    }\n    return node\n  }\n\n  /**\n   * Place a new package into the graph representation, creating the new\n   * edges and possibly new nodes that are to be expected when traversing\n   * the graph in a top-down direction, e.g: from importers to leafs.\n   *\n   * For different uses that are not a direct top-down traversal of the graph\n   * consider using `addNode()` and `addEdge()` instead.\n   */\n  placePackage(\n    fromNode: Node,\n    depType: DependencyTypeShort,\n    spec: Spec,\n    manifest?: Manifest,\n    id?: DepID,\n  ) {\n    // if no manifest is available, then create an edge that has no\n    // reference to any other node, representing a missing dependency\n    if (!manifest && !id) {\n      this.addEdge(depType, spec, fromNode)\n      return\n    }\n\n    // flags set on the node we're about to create or find.\n    const flags = {\n      dev: fromNode.dev || depType === 'dev',\n      optional:\n        fromNode.optional ||\n        depType === 'optional' ||\n        depType === 'peerOptional',\n    }\n\n    const depId = id || (manifest && getId(spec, manifest))\n\n    /* c8 ignore start - should not be possible */\n    if (!depId) {\n      throw error('Could not find dep id when placing package', {\n        spec,\n        manifest,\n      })\n    }\n    /* c8 ignore stop */\n\n    // if a node for this package is already represented by a node\n    // in the graph, then just creates a new edge to that node\n    const toFoundNode = this.nodes.get(depId)\n    if (toFoundNode) {\n      this.addEdge(depType, spec, fromNode, toFoundNode)\n      // the current only stays dev/optional if this dep lets it remain so\n      // if it's not already, we don't make it dev or optional.\n      toFoundNode.dev &&= flags.dev\n      toFoundNode.optional &&= flags.optional\n      return toFoundNode\n    }\n\n    // creates a new node and edges to its parent\n    const toNode = this.addNode(depId, manifest)\n    toNode.registry = spec.registry\n    toNode.dev = flags.dev\n    toNode.optional = flags.optional\n    this.addEdge(depType, spec, fromNode, toNode)\n    return toNode\n  }\n\n  /**\n   * Removes a node and its relevant edges from the graph.\n   *\n   * If a replacement is provided, then any edges that were previously\n   * pointing to the removed node will be directed to the replacement,\n   * if it is valid to do so.\n   */\n  removeNode(node: Node, replacement?: Node) {\n    this.nodes.delete(node.id)\n    const nbn = this.nodesByName.get(node.name)\n    // if it's the last one, just remove the set\n    if (nbn?.size === 1) this.nodesByName.delete(node.name)\n    else nbn?.delete(node)\n    for (const r of this.resolutionsReverse.get(node) ?? new Set()) {\n      this.resolutions.delete(r)\n    }\n    this.resolutionsReverse.delete(node)\n    this.manifests.delete(node.id)\n    for (const edge of node.edgesOut.values()) {\n      this.edges.delete(edge)\n    }\n    for (const edge of node.edgesIn) {\n      if (\n        replacement &&\n        satisfies(\n          replacement.id,\n          edge.spec,\n          edge.from.location,\n          this.projectRoot,\n          this.monorepo,\n        )\n      ) {\n        edge.to = replacement\n      } else {\n        edge.to = undefined\n      }\n    }\n  }\n\n  toJSON() {\n    return lockfileData({\n      ...this.#options,\n      graph: this,\n      saveManifests: true,\n    })\n  }\n\n  [kCustomInspect](_: number, options: InspectOptions) {\n    const data = this.toJSON()\n    return `${this[Symbol.toStringTag]} ${inspect(data, options)}`\n  }\n}\n"]}

package/dist/esm/ideal/add-nodes.d.ts

@@ -0,0 +1,19 @@
+import { PackageInfoClient } from '@vltpkg/package-info';
+import { SpecOptions } from '@vltpkg/spec';
+import { PathScurry } from 'path-scurry';
+import { BuildIdealAddOptions, BuildIdealFromGraphOptions } from './types.js';
+export type AddNodesOptions = BuildIdealAddOptions & BuildIdealFromGraphOptions & SpecOptions & {
+    /**
+     * A {@link PathScurry} instance based on the `projectRoot` path
+     */
+    scurry: PathScurry;
+    /**
+     * A {@link PackageInfoClient} instance to read manifest info from.
+     */
+    packageInfo: PackageInfoClient;
+};
+/**
+ * Add new nodes in the given `graph` for dependencies specified at `add`.
+ */
+export declare const addNodes: ({ add, graph, packageInfo, scurry, ...specOptions }: AddNodesOptions) => Promise<void>;
+//# sourceMappingURL=add-nodes.d.ts.map

package/dist/esm/ideal/add-nodes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-nodes.d.ts","sourceRoot":"","sources":["../../../src/ideal/add-nodes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAExC,OAAO,EACL,oBAAoB,EACpB,0BAA0B,EAC3B,MAAM,YAAY,CAAA;AAEnB,MAAM,MAAM,eAAe,GAAG,oBAAoB,GAChD,0BAA0B,GAC1B,WAAW,GAAG;IACZ;;OAEG;IACH,MAAM,EAAE,UAAU,CAAA;IAElB;;OAEG;IACH,WAAW,EAAE,iBAAiB,CAAA;CAC/B,CAAA;AAEH;;GAEG;AACH,eAAO,MAAM,QAAQ,wDAMlB,eAAe,kBA8BjB,CAAA"}

package/dist/esm/ideal/add-nodes.js

@@ -0,0 +1,28 @@
+import { error } from '@vltpkg/error-cause';
+import { appendNodes } from './append-nodes.js';
+/**
+ * Add new nodes in the given `graph` for dependencies specified at `add`.
+ */
+export const addNodes = async ({ add, graph, packageInfo, scurry, ...specOptions }) => {
+    const seen = new Set();
+    // iterates on the list of dependencies per importer updating
+    // the graph using metadata fetch from the registry manifest files
+    for (const [depID, dependencies] of add) {
+        const importer = graph.nodes.get(depID);
+        if (!importer) {
+            throw error('Could not find importer', { found: depID });
+        }
+        // Removes any edges and nodes that are currently part of the
+        // graph but are also in the list of dependencies to be installed
+        const deps = [...dependencies.values()];
+        for (const { spec } of deps) {
+            const node = importer.edgesOut.get(spec.name)?.to;
+            if (node)
+                graph.removeNode(node);
+        }
+        // Add new nodes for packages defined in the dependencies list fetching
+        // metadata from the registry manifests and updating the graph
+        await appendNodes(packageInfo, graph, importer, deps, scurry, specOptions, seen);
+    }
+};
+//# sourceMappingURL=add-nodes.js.map

package/dist/esm/ideal/add-nodes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-nodes.js","sourceRoot":"","sources":["../../../src/ideal/add-nodes.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAI3C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAoB/C;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,EAAE,EAC7B,GAAG,EACH,KAAK,EACL,WAAW,EACX,MAAM,EACN,GAAG,WAAW,EACE,EAAE,EAAE;IACpB,MAAM,IAAI,GAAG,IAAI,GAAG,EAAS,CAAA;IAC7B,6DAA6D;IAC7D,kEAAkE;IAClE,KAAK,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,IAAI,GAAG,EAAE,CAAC;QACxC,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QACvC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,KAAK,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAA;QAC1D,CAAC;QAED,6DAA6D;QAC7D,iEAAiE;QACjE,MAAM,IAAI,GAAG,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,CAAA;QACvC,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAA;YACjD,IAAI,IAAI;gBAAE,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;QAClC,CAAC;QAED,uEAAuE;QACvE,8DAA8D;QAC9D,MAAM,WAAW,CACf,WAAW,EACX,KAAK,EACL,QAAQ,EACR,IAAI,EACJ,MAAM,EACN,WAAW,EACX,IAAI,CACL,CAAA;IACH,CAAC;AACH,CAAC,CAAA","sourcesContent":["import { DepID } from '@vltpkg/dep-id'\nimport { error } from '@vltpkg/error-cause'\nimport { PackageInfoClient } from '@vltpkg/package-info'\nimport { SpecOptions } from '@vltpkg/spec'\nimport { PathScurry } from 'path-scurry'\nimport { appendNodes } from './append-nodes.js'\nimport {\n  BuildIdealAddOptions,\n  BuildIdealFromGraphOptions,\n} from './types.js'\n\nexport type AddNodesOptions = BuildIdealAddOptions &\n  BuildIdealFromGraphOptions &\n  SpecOptions & {\n    /**\n     * A {@link PathScurry} instance based on the `projectRoot` path\n     */\n    scurry: PathScurry\n\n    /**\n     * A {@link PackageInfoClient} instance to read manifest info from.\n     */\n    packageInfo: PackageInfoClient\n  }\n\n/**\n * Add new nodes in the given `graph` for dependencies specified at `add`.\n */\nexport const addNodes = async ({\n  add,\n  graph,\n  packageInfo,\n  scurry,\n  ...specOptions\n}: AddNodesOptions) => {\n  const seen = new Set<DepID>()\n  // iterates on the list of dependencies per importer updating\n  // the graph using metadata fetch from the registry manifest files\n  for (const [depID, dependencies] of add) {\n    const importer = graph.nodes.get(depID)\n    if (!importer) {\n      throw error('Could not find importer', { found: depID })\n    }\n\n    // Removes any edges and nodes that are currently part of the\n    // graph but are also in the list of dependencies to be installed\n    const deps = [...dependencies.values()]\n    for (const { spec } of deps) {\n      const node = importer.edgesOut.get(spec.name)?.to\n      if (node) graph.removeNode(node)\n    }\n\n    // Add new nodes for packages defined in the dependencies list fetching\n    // metadata from the registry manifests and updating the graph\n    await appendNodes(\n      packageInfo,\n      graph,\n      importer,\n      deps,\n      scurry,\n      specOptions,\n      seen,\n    )\n  }\n}\n"]}

package/dist/esm/ideal/append-nodes.d.ts

@@ -0,0 +1,9 @@
+import { DepID } from '@vltpkg/dep-id';
+import { PackageInfoClient } from '@vltpkg/package-info';
+import { type SpecOptions } from '@vltpkg/spec';
+import { PathScurry } from 'path-scurry';
+import { Dependency } from '../dependencies.js';
+import { Graph } from '../graph.js';
+import { Node } from '../node.js';
+export declare const appendNodes: (packageInfo: PackageInfoClient, graph: Graph, fromNode: Node, deps: Dependency[], scurry: PathScurry, options: SpecOptions, seen: Set<DepID>) => Promise<void>;
+//# sourceMappingURL=append-nodes.d.ts.map

package/dist/esm/ideal/append-nodes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"append-nodes.d.ts","sourceRoot":"","sources":["../../../src/ideal/append-nodes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAkB,MAAM,gBAAgB,CAAA;AAEtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAQ,KAAK,WAAW,EAAE,MAAM,cAAc,CAAA;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EACL,UAAU,EAIX,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACnC,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AAuDjC,eAAO,MAAM,WAAW,gBACT,iBAAiB,SACvB,KAAK,YACF,IAAI,QACR,UAAU,EAAE,UACV,UAAU,WACT,WAAW,QACd,GAAG,CAAC,KAAK,CAAC,kBA+GjB,CAAA"}

package/dist/esm/ideal/append-nodes.js

@@ -0,0 +1,121 @@
+import { joinDepIDTuple } from '@vltpkg/dep-id';
+import { error } from '@vltpkg/error-cause';
+import { Spec } from '@vltpkg/spec';
+import { longDependencyTypes, shorten, } from '../dependencies.js';
+import { removeOptionalSubgraph } from '../remove-optional-subgraph.js';
+/**
+ * Only install devDeps for git dependencies and importers
+ * Everything else always gets installed
+ */
+const shouldInstallDepType = (node, depType) => depType !== 'devDependencies' ||
+    node.importer ||
+    node.id.startsWith('git');
+/**
+ * Retrieve the {@link DepID} and location for a `file:` type {@link Node}.
+ */
+const getFileTypeInfo = (spec, fromNode, scurry) => {
+    const f = spec.final;
+    if (f.type !== 'file')
+        return;
+    /* c8 ignore start - should be impossible */
+    if (!f.file) {
+        throw error('no path on file specifier', { spec });
+    }
+    /* c8 ignore stop */
+    // Given that both linked folders and local tarballs (both defined with
+    // usage of the `file:` spec prefix) location needs to be relative to their
+    // parents, build the expected path and use it for both location and id
+    const target = scurry.cwd.resolve(fromNode.location).resolve(f.file);
+    const path = target.relativePosix();
+    const id = joinDepIDTuple(['file', path]);
+    return {
+        path,
+        id,
+        isDirectory: !!target.lstatSync()?.isDirectory(),
+    };
+};
+const isStringArray = (a) => Array.isArray(a) && !a.some(b => typeof b !== 'string');
+export const appendNodes = async (packageInfo, graph, fromNode, deps, scurry, options, seen) => {
+    /* c8 ignore next */
+    if (seen.has(fromNode.id))
+        return;
+    seen.add(fromNode.id);
+    await Promise.all(deps.map(async ({ spec, type }) => {
+        // see if there's a satisfying node in the graph currently
+        const fileTypeInfo = getFileTypeInfo(spec, fromNode, scurry);
+        const existingNode = graph.findResolution(spec, fromNode);
+        if (existingNode) {
+            graph.addEdge(type, spec, fromNode, existingNode);
+            return;
+        }
+        const edgeOptional = type === 'optional' || type === 'peerOptional';
+        const mani = await packageInfo
+            .manifest(spec, { from: scurry.resolve(fromNode.location) })
+            .catch((er) => {
+            // optional deps ignored if inaccessible
+            if (edgeOptional || fromNode.optional) {
+                return undefined;
+            }
+            throw er;
+        });
+        if (!mani) {
+            if (!edgeOptional && fromNode.isOptional()) {
+                // failed resolution of a non-optional dep of an optional node
+                // have to clean up the dependents
+                removeOptionalSubgraph(graph, fromNode);
+                return;
+            }
+            else if (edgeOptional) {
+                // failed resolution of an optional dep, just ignore it,
+                // nothing to prune because we never added it in the first place.
+                return;
+            }
+            else {
+                throw error('failed to resolve dependency', {
+                    spec,
+                    from: fromNode.location,
+                });
+            }
+        }
+        const node = graph.placePackage(fromNode, type, spec, mani, fileTypeInfo?.id);
+        /* c8 ignore start - not possible, already ensured manifest */
+        if (!node) {
+            throw error('failed to place package', {
+                from: fromNode.location,
+                spec,
+            });
+        }
+        /* c8 ignore stop */
+        if (fileTypeInfo?.path && fileTypeInfo.isDirectory) {
+            node.location = fileTypeInfo.path;
+        }
+        node.setResolved();
+        const nestedAppends = [];
+        const bundleDeps = node.manifest?.bundleDependencies;
+        const bundled = new Set((node.id.startsWith('git') ||
+            node.importer ||
+            !isStringArray(bundleDeps)) ?
+            []
+            : bundleDeps);
+        for (const depTypeName of longDependencyTypes) {
+            const depRecord = mani[depTypeName];
+            if (depRecord && shouldInstallDepType(node, depTypeName)) {
+                const nextDeps = Object.entries(depRecord)
+                    .filter(([name]) => !bundled.has(name))
+                    .map(([name, bareSpec]) => ({
+                    // if foo:a@1 depends on b@2, then it must be foo:b@2
+                    spec: Spec.parse(name, bareSpec, {
+                        ...options,
+                        registry: spec.registry,
+                    }),
+                    type: shorten(depTypeName, name, mani),
+                }));
+                if (nextDeps.length) {
+                    nestedAppends.push(appendNodes(packageInfo, graph, node, nextDeps, scurry, options, seen));
+                }
+            }
+        }
+        await Promise.all(nestedAppends);
+    }));
+};
+//# sourceMappingURL=append-nodes.js.map

package/dist/esm/ideal/append-nodes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"append-nodes.js","sourceRoot":"","sources":["../../../src/ideal/append-nodes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,cAAc,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAE3C,OAAO,EAAE,IAAI,EAAoB,MAAM,cAAc,CAAA;AAErD,OAAO,EAGL,mBAAmB,EACnB,OAAO,GACR,MAAM,oBAAoB,CAAA;AAG3B,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAA;AAQvE;;;GAGG;AACH,MAAM,oBAAoB,GAAG,CAC3B,IAAU,EACV,OAA2B,EAC3B,EAAE,CACF,OAAO,KAAK,iBAAiB;IAC7B,IAAI,CAAC,QAAQ;IACb,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;AAE3B;;GAEG;AACH,MAAM,eAAe,GAAG,CACtB,IAAU,EACV,QAAc,EACd,MAAkB,EACQ,EAAE;IAC5B,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAA;IACpB,IAAI,CAAC,CAAC,IAAI,KAAK,MAAM;QAAE,OAAM;IAE7B,4CAA4C;IAC5C,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACZ,MAAM,KAAK,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,CAAC,CAAA;IACpD,CAAC;IACD,oBAAoB;IAEpB,uEAAuE;IACvE,2EAA2E;IAC3E,uEAAuE;IACvE,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;IACpE,MAAM,IAAI,GAAG,MAAM,CAAC,aAAa,EAAE,CAAA;IACnC,MAAM,EAAE,GAAG,cAAc,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAA;IAEzC,OAAO;QACL,IAAI;QACJ,EAAE;QACF,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,WAAW,EAAE;KACjD,CAAA;AACH,CAAC,CAAA;AAED,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,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,EAC9B,WAA8B,EAC9B,KAAY,EACZ,QAAc,EACd,IAAkB,EAClB,MAAkB,EAClB,OAAoB,EACpB,IAAgB,EAChB,EAAE;IACF,oBAAoB;IACpB,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;QAAE,OAAM;IACjC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;IAErB,MAAM,OAAO,CAAC,GAAG,CACf,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE;QAChC,0DAA0D;QAC1D,MAAM,YAAY,GAAG,eAAe,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAA;QAC5D,MAAM,YAAY,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QACzD,IAAI,YAAY,EAAE,CAAC;YACjB,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAA;YACjD,OAAM;QACR,CAAC;QACD,MAAM,YAAY,GAChB,IAAI,KAAK,UAAU,IAAI,IAAI,KAAK,cAAc,CAAA;QAChD,MAAM,IAAI,GAAG,MAAM,WAAW;aAC3B,QAAQ,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;aAC3D,KAAK,CAAC,CAAC,EAAW,EAAE,EAAE;YACrB,wCAAwC;YACxC,IAAI,YAAY,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBACtC,OAAO,SAAS,CAAA;YAClB,CAAC;YACD,MAAM,EAAE,CAAA;QACV,CAAC,CAAC,CAAA;QAEJ,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,CAAC,YAAY,IAAI,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC;gBAC3C,8DAA8D;gBAC9D,kCAAkC;gBAClC,sBAAsB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;gBACvC,OAAM;YACR,CAAC;iBAAM,IAAI,YAAY,EAAE,CAAC;gBACxB,wDAAwD;gBACxD,iEAAiE;gBACjE,OAAM;YACR,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,CAAC,8BAA8B,EAAE;oBAC1C,IAAI;oBACJ,IAAI,EAAE,QAAQ,CAAC,QAAQ;iBACxB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAED,MAAM,IAAI,GAAG,KAAK,CAAC,YAAY,CAC7B,QAAQ,EACR,IAAI,EACJ,IAAI,EACJ,IAAI,EACJ,YAAY,EAAE,EAAE,CACjB,CAAA;QAED,8DAA8D;QAC9D,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,KAAK,CAAC,yBAAyB,EAAE;gBACrC,IAAI,EAAE,QAAQ,CAAC,QAAQ;gBACvB,IAAI;aACL,CAAC,CAAA;QACJ,CAAC;QACD,oBAAoB;QAEpB,IAAI,YAAY,EAAE,IAAI,IAAI,YAAY,CAAC,WAAW,EAAE,CAAC;YACnD,IAAI,CAAC,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAA;QACnC,CAAC;QACD,IAAI,CAAC,WAAW,EAAE,CAAA;QAClB,MAAM,aAAa,GAAuB,EAAE,CAAA;QAE5C,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,EAAE,kBAAkB,CAAA;QACpD,MAAM,OAAO,GAAG,IAAI,GAAG,CACrB,CACE,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC;YACzB,IAAI,CAAC,QAAQ;YACb,CAAC,aAAa,CAAC,UAAU,CAAC,CAC3B,CAAC,CAAC;YACD,EAAE;YACJ,CAAC,CAAC,UAAU,CACb,CAAA;QACD,KAAK,MAAM,WAAW,IAAI,mBAAmB,EAAE,CAAC;YAC9C,MAAM,SAAS,GACb,IAAI,CAAC,WAAW,CAAC,CAAA;YAEnB,IAAI,SAAS,IAAI,oBAAoB,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC;gBACzD,MAAM,QAAQ,GAAiB,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC;qBACrD,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;qBACtC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC;oBAC1B,qDAAqD;oBACrD,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE;wBAC/B,GAAG,OAAO;wBACV,QAAQ,EAAE,IAAI,CAAC,QAAQ;qBACxB,CAAC;oBACF,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,CAAC;iBACvC,CAAC,CAAC,CAAA;gBACL,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;oBACpB,aAAa,CAAC,IAAI,CAChB,WAAW,CACT,WAAW,EACX,KAAK,EACL,IAAI,EACJ,QAAQ,EACR,MAAM,EACN,OAAO,EACP,IAAI,CACL,CACF,CAAA;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAA;IAClC,CAAC,CAAC,CACH,CAAA;AACH,CAAC,CAAA","sourcesContent":["import { DepID, joinDepIDTuple } from '@vltpkg/dep-id'\nimport { error } from '@vltpkg/error-cause'\nimport { PackageInfoClient } from '@vltpkg/package-info'\nimport { Spec, type SpecOptions } from '@vltpkg/spec'\nimport { PathScurry } from 'path-scurry'\nimport {\n  Dependency,\n  DependencyTypeLong,\n  longDependencyTypes,\n  shorten,\n} from '../dependencies.js'\nimport { Graph } from '../graph.js'\nimport { Node } from '../node.js'\nimport { removeOptionalSubgraph } from '../remove-optional-subgraph.js'\n\ntype FileTypeInfo = {\n  id: DepID\n  path: string\n  isDirectory: boolean\n}\n\n/**\n * Only install devDeps for git dependencies and importers\n * Everything else always gets installed\n */\nconst shouldInstallDepType = (\n  node: Node,\n  depType: DependencyTypeLong,\n) =>\n  depType !== 'devDependencies' ||\n  node.importer ||\n  node.id.startsWith('git')\n\n/**\n * Retrieve the {@link DepID} and location for a `file:` type {@link Node}.\n */\nconst getFileTypeInfo = (\n  spec: Spec,\n  fromNode: Node,\n  scurry: PathScurry,\n): FileTypeInfo | undefined => {\n  const f = spec.final\n  if (f.type !== 'file') return\n\n  /* c8 ignore start - should be impossible */\n  if (!f.file) {\n    throw error('no path on file specifier', { spec })\n  }\n  /* c8 ignore stop */\n\n  // Given that both linked folders and local tarballs (both defined with\n  // usage of the `file:` spec prefix) location needs to be relative to their\n  // parents, build the expected path and use it for both location and id\n  const target = scurry.cwd.resolve(fromNode.location).resolve(f.file)\n  const path = target.relativePosix()\n  const id = joinDepIDTuple(['file', path])\n\n  return {\n    path,\n    id,\n    isDirectory: !!target.lstatSync()?.isDirectory(),\n  }\n}\n\nconst isStringArray = (a: unknown): a is string[] =>\n  Array.isArray(a) && !a.some(b => typeof b !== 'string')\n\nexport const appendNodes = async (\n  packageInfo: PackageInfoClient,\n  graph: Graph,\n  fromNode: Node,\n  deps: Dependency[],\n  scurry: PathScurry,\n  options: SpecOptions,\n  seen: Set<DepID>,\n) => {\n  /* c8 ignore next */\n  if (seen.has(fromNode.id)) return\n  seen.add(fromNode.id)\n\n  await Promise.all(\n    deps.map(async ({ spec, type }) => {\n      // see if there's a satisfying node in the graph currently\n      const fileTypeInfo = getFileTypeInfo(spec, fromNode, scurry)\n      const existingNode = graph.findResolution(spec, fromNode)\n      if (existingNode) {\n        graph.addEdge(type, spec, fromNode, existingNode)\n        return\n      }\n      const edgeOptional =\n        type === 'optional' || type === 'peerOptional'\n      const mani = await packageInfo\n        .manifest(spec, { from: scurry.resolve(fromNode.location) })\n        .catch((er: unknown) => {\n          // optional deps ignored if inaccessible\n          if (edgeOptional || fromNode.optional) {\n            return undefined\n          }\n          throw er\n        })\n\n      if (!mani) {\n        if (!edgeOptional && fromNode.isOptional()) {\n          // failed resolution of a non-optional dep of an optional node\n          // have to clean up the dependents\n          removeOptionalSubgraph(graph, fromNode)\n          return\n        } else if (edgeOptional) {\n          // failed resolution of an optional dep, just ignore it,\n          // nothing to prune because we never added it in the first place.\n          return\n        } else {\n          throw error('failed to resolve dependency', {\n            spec,\n            from: fromNode.location,\n          })\n        }\n      }\n\n      const node = graph.placePackage(\n        fromNode,\n        type,\n        spec,\n        mani,\n        fileTypeInfo?.id,\n      )\n\n      /* c8 ignore start - not possible, already ensured manifest */\n      if (!node) {\n        throw error('failed to place package', {\n          from: fromNode.location,\n          spec,\n        })\n      }\n      /* c8 ignore stop */\n\n      if (fileTypeInfo?.path && fileTypeInfo.isDirectory) {\n        node.location = fileTypeInfo.path\n      }\n      node.setResolved()\n      const nestedAppends: Promise<unknown>[] = []\n\n      const bundleDeps = node.manifest?.bundleDependencies\n      const bundled = new Set<string>(\n        (\n          node.id.startsWith('git') ||\n          node.importer ||\n          !isStringArray(bundleDeps)\n        ) ?\n          []\n        : bundleDeps,\n      )\n      for (const depTypeName of longDependencyTypes) {\n        const depRecord: Record<string, string> | undefined =\n          mani[depTypeName]\n\n        if (depRecord && shouldInstallDepType(node, depTypeName)) {\n          const nextDeps: Dependency[] = Object.entries(depRecord)\n            .filter(([name]) => !bundled.has(name))\n            .map(([name, bareSpec]) => ({\n              // if foo:a@1 depends on b@2, then it must be foo:b@2\n              spec: Spec.parse(name, bareSpec, {\n                ...options,\n                registry: spec.registry,\n              }),\n              type: shorten(depTypeName, name, mani),\n            }))\n          if (nextDeps.length) {\n            nestedAppends.push(\n              appendNodes(\n                packageInfo,\n                graph,\n                node,\n                nextDeps,\n                scurry,\n                options,\n                seen,\n              ),\n            )\n          }\n        }\n      }\n      await Promise.all(nestedAppends)\n    }),\n  )\n}\n"]}

package/dist/esm/ideal/build-ideal-from-starting-graph.d.ts

@@ -0,0 +1,15 @@
+import { Graph } from '../graph.js';
+import { AddNodesOptions } from './add-nodes.js';
+import { RemoveNodesOptions } from './remove-nodes.js';
+export type BuildIdealFromStartingGraphOptions = AddNodesOptions & RemoveNodesOptions & {
+    projectRoot: string;
+};
+/**
+ * Builds an ideal {@link Graph} representing the dependencies that
+ * should be present in order to fulfill the requirements defined
+ * by the `package.json` and `vlt-lock.json` files using the `graph` set
+ * in options as a starting point. Also add / remove any dependencies
+ * listed in the `add` and `remove` properties.
+ */
+export declare const buildIdealFromStartingGraph: (options: BuildIdealFromStartingGraphOptions) => Promise<Graph>;
+//# sourceMappingURL=build-ideal-from-starting-graph.d.ts.map

package/dist/esm/ideal/build-ideal-from-starting-graph.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-ideal-from-starting-graph.d.ts","sourceRoot":"","sources":["../../../src/ideal/build-ideal-from-starting-graph.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAEnC,OAAO,EAAE,eAAe,EAAY,MAAM,gBAAgB,CAAA;AAC1D,OAAO,EAAE,kBAAkB,EAAe,MAAM,mBAAmB,CAAA;AAEnE,MAAM,MAAM,kCAAkC,GAAG,eAAe,GAC9D,kBAAkB,GAAG;IACnB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,2BAA2B,YAC7B,kCAAkC,KAC1C,OAAO,CAAC,KAAK,CAqBf,CAAA"}

package/dist/esm/ideal/build-ideal-from-starting-graph.js

@@ -0,0 +1,28 @@
+import { getImporterSpecs } from './get-importer-specs.js';
+import { addNodes } from './add-nodes.js';
+import { removeNodes } from './remove-nodes.js';
+/**
+ * Builds an ideal {@link Graph} representing the dependencies that
+ * should be present in order to fulfill the requirements defined
+ * by the `package.json` and `vlt-lock.json` files using the `graph` set
+ * in options as a starting point. Also add / remove any dependencies
+ * listed in the `add` and `remove` properties.
+ */
+export const buildIdealFromStartingGraph = async (options) => {
+    // Gets a map of dependencies that are keyed to its importer node ids,
+    // merging values already found in the graph with user specified values.
+    // Any dependencies that are already satisfied in the starting `graph`
+    // are going to be pruned from the resulting object.
+    const importerSpecs = getImporterSpecs(options);
+    // add nodes, fetching remote manifests for each dependency to be added
+    await addNodes({ ...options, ...importerSpecs });
+    // move things into their default locations, if possible
+    for (const node of options.graph.nodes.values()) {
+        node.setDefaultLocation();
+    }
+    // removes any dependencies that are listed in the `remove` option
+    removeNodes(options);
+    options.graph.gc();
+    return options.graph;
+};
+//# sourceMappingURL=build-ideal-from-starting-graph.js.map

package/dist/esm/ideal/build-ideal-from-starting-graph.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-ideal-from-starting-graph.js","sourceRoot":"","sources":["../../../src/ideal/build-ideal-from-starting-graph.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,EAAmB,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAC1D,OAAO,EAAsB,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAOnE;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,KAAK,EAC9C,OAA2C,EAC3B,EAAE;IAClB,sEAAsE;IACtE,wEAAwE;IACxE,sEAAsE;IACtE,oDAAoD;IACpD,MAAM,aAAa,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAA;IAE/C,uEAAuE;IACvE,MAAM,QAAQ,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,aAAa,EAAE,CAAC,CAAA;IAEhD,wDAAwD;IACxD,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC;QAChD,IAAI,CAAC,kBAAkB,EAAE,CAAA;IAC3B,CAAC;IAED,kEAAkE;IAClE,WAAW,CAAC,OAAO,CAAC,CAAA;IAEpB,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,CAAA;IAElB,OAAO,OAAO,CAAC,KAAK,CAAA;AACtB,CAAC,CAAA","sourcesContent":["import { Graph } from '../graph.js'\nimport { getImporterSpecs } from './get-importer-specs.js'\nimport { AddNodesOptions, addNodes } from './add-nodes.js'\nimport { RemoveNodesOptions, removeNodes } from './remove-nodes.js'\n\nexport type BuildIdealFromStartingGraphOptions = AddNodesOptions &\n  RemoveNodesOptions & {\n    projectRoot: string\n  }\n\n/**\n * Builds an ideal {@link Graph} representing the dependencies that\n * should be present in order to fulfill the requirements defined\n * by the `package.json` and `vlt-lock.json` files using the `graph` set\n * in options as a starting point. Also add / remove any dependencies\n * listed in the `add` and `remove` properties.\n */\nexport const buildIdealFromStartingGraph = async (\n  options: BuildIdealFromStartingGraphOptions,\n): Promise<Graph> => {\n  // Gets a map of dependencies that are keyed to its importer node ids,\n  // merging values already found in the graph with user specified values.\n  // Any dependencies that are already satisfied in the starting `graph`\n  // are going to be pruned from the resulting object.\n  const importerSpecs = getImporterSpecs(options)\n\n  // add nodes, fetching remote manifests for each dependency to be added\n  await addNodes({ ...options, ...importerSpecs })\n\n  // move things into their default locations, if possible\n  for (const node of options.graph.nodes.values()) {\n    node.setDefaultLocation()\n  }\n\n  // removes any dependencies that are listed in the `remove` option\n  removeNodes(options)\n\n  options.graph.gc()\n\n  return options.graph\n}\n"]}