@vltpkg/graph 0.0.0-0.1730239248325

package/dist/esm/types.d.ts

@@ -0,0 +1,39 @@
+import type { DepID } from '@vltpkg/dep-id';
+import type { Manifest } from '@vltpkg/types';
+import type { Spec } from '@vltpkg/spec';
+import type { SpecLikeBase } from '@vltpkg/spec';
+import type { DependencyTypeShort } from './dependencies.js';
+export interface EdgeLike {
+    name: string;
+    from: NodeLike;
+    spec: SpecLikeBase;
+    to?: NodeLike;
+    type: DependencyTypeShort;
+}
+export interface GraphLike {
+    importers: Set<NodeLike>;
+    mainImporter: NodeLike;
+    projectRoot: string;
+    nodes: Map<DepID, NodeLike>;
+    edges: Set<EdgeLike>;
+    addEdge: (type: DependencyTypeShort, spec: Spec, from: NodeLike, to?: NodeLike) => EdgeLike;
+    addNode: (id?: DepID, manifest?: Manifest, spec?: Spec, name?: string, version?: string) => NodeLike;
+}
+export interface NodeLike {
+    id: DepID;
+    edgesIn: Set<EdgeLike>;
+    edgesOut: Map<string, EdgeLike>;
+    location?: string;
+    manifest?: Manifest | null;
+    name?: string | null;
+    version?: string | null;
+    integrity?: string | null;
+    resolved?: string | null;
+    importer: boolean;
+    graph: GraphLike;
+    mainImporter: boolean;
+    projectRoot: string;
+    dev: boolean;
+    optional: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAC7C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AAE5D,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,QAAQ,CAAA;IACd,IAAI,EAAE,YAAY,CAAA;IAClB,EAAE,CAAC,EAAE,QAAQ,CAAA;IACb,IAAI,EAAE,mBAAmB,CAAA;CAC1B;AAED,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAA;IACxB,YAAY,EAAE,QAAQ,CAAA;IACtB,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;IAC3B,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAA;IACpB,OAAO,EAAE,CACP,IAAI,EAAE,mBAAmB,EACzB,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,QAAQ,EACd,EAAE,CAAC,EAAE,QAAQ,KACV,QAAQ,CAAA;IACb,OAAO,EAAE,CACP,EAAE,CAAC,EAAE,KAAK,EACV,QAAQ,CAAC,EAAE,QAAQ,EACnB,IAAI,CAAC,EAAE,IAAI,EACX,IAAI,CAAC,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,MAAM,KACb,QAAQ,CAAA;CACd;AAED,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,KAAK,CAAA;IACT,OAAO,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAA;IACtB,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAA;IAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,QAAQ,EAAE,OAAO,CAAA;IACjB,KAAK,EAAE,SAAS,CAAA;IAChB,YAAY,EAAE,OAAO,CAAA;IACrB,WAAW,EAAE,MAAM,CAAA;IACnB,GAAG,EAAE,OAAO,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;CAClB"}

package/dist/esm/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { DepID } from '@vltpkg/dep-id'\nimport type { Manifest } from '@vltpkg/types'\nimport type { Spec } from '@vltpkg/spec'\nimport type { SpecLikeBase } from '@vltpkg/spec'\nimport type { DependencyTypeShort } from './dependencies.js'\n\nexport interface EdgeLike {\n  name: string\n  from: NodeLike\n  spec: SpecLikeBase\n  to?: NodeLike\n  type: DependencyTypeShort\n}\n\nexport interface GraphLike {\n  importers: Set<NodeLike>\n  mainImporter: NodeLike\n  projectRoot: string\n  nodes: Map<DepID, NodeLike>\n  edges: Set<EdgeLike>\n  addEdge: (\n    type: DependencyTypeShort,\n    spec: Spec,\n    from: NodeLike,\n    to?: NodeLike,\n  ) => EdgeLike\n  addNode: (\n    id?: DepID,\n    manifest?: Manifest,\n    spec?: Spec,\n    name?: string,\n    version?: string,\n  ) => NodeLike\n}\n\nexport interface NodeLike {\n  id: DepID\n  edgesIn: Set<EdgeLike>\n  edgesOut: Map<string, EdgeLike>\n  location?: string\n  manifest?: Manifest | null\n  name?: string | null\n  version?: string | null\n  integrity?: string | null\n  resolved?: string | null\n  importer: boolean\n  graph: GraphLike\n  mainImporter: boolean\n  projectRoot: string\n  dev: boolean\n  optional: boolean\n}\n"]}

package/dist/esm/visualization/human-readable-output.d.ts

@@ -0,0 +1,25 @@
+import { EdgeLike, NodeLike } from '../types.js';
+import type { ChalkInstance } from 'chalk';
+export type TreeItem = {
+    name?: string | null;
+    edge: EdgeLike | undefined;
+    node: NodeLike | undefined;
+    prefix: string;
+    padding: string;
+    hasSibling: boolean;
+    deduped: boolean;
+    include: boolean;
+    parent: TreeItem | undefined;
+};
+export type HumanReadableOutputOptions = {
+    edges: EdgeLike[];
+    importers: Set<NodeLike>;
+    nodes: NodeLike[];
+    colors?: ChalkInstance;
+    highlightSelection: boolean;
+};
+/**
+ * Returns a human-readable output of the graph.
+ */
+export declare function humanReadableOutput(options: HumanReadableOutputOptions): string | null | undefined;
+//# sourceMappingURL=human-readable-output.d.ts.map

package/dist/esm/visualization/human-readable-output.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"human-readable-output.d.ts","sourceRoot":"","sources":["../../../src/visualization/human-readable-output.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAChD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAY1C,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC1B,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,OAAO,CAAA;IACnB,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,EAAE,QAAQ,EAAE,CAAA;IACjB,SAAS,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAA;IACxB,KAAK,EAAE,QAAQ,EAAE,CAAA;IACjB,MAAM,CAAC,EAAE,aAAa,CAAA;IACtB,kBAAkB,EAAE,OAAO,CAAA;CAC5B,CAAA;AA6DD;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,0BAA0B,6BAsGpC"}

package/dist/esm/visualization/human-readable-output.js

@@ -0,0 +1,132 @@
+import { splitDepID } from '@vltpkg/dep-id';
+const chars = new Map(Object.entries({
+    connection: '─',
+    down: '│',
+    'last-child': '└',
+    'middle-child': '├',
+    t: '┬',
+}));
+const isSelected = (options, edge, node) => !!((!node || options.nodes.includes(node)) &&
+    (!edge || options.edges.includes(edge)));
+/**
+ * Returns a map of tree items to be printed.
+ */
+const getTreeItems = (initialItems, options) => {
+    const seenNodes = new Set();
+    const treeItems = new Map();
+    const traverse = new Set(initialItems);
+    for (const item of traverse) {
+        if (item.node) {
+            if (seenNodes.has(item.node)) {
+                item.deduped = true;
+                continue;
+            }
+            seenNodes.add(item.node);
+            const edges = [...item.node.edgesOut.values()].sort(i => Number(i.to?.importer));
+            for (const edge of edges) {
+                const toItems = treeItems.get(edge) ?? new Map();
+                const nextItem = {
+                    edge,
+                    node: edge.to,
+                    hasSibling: false,
+                    padding: '',
+                    prefix: '',
+                    deduped: false,
+                    include: isSelected(options, edge, edge.to),
+                    parent: item,
+                };
+                toItems.set(edge.to, nextItem);
+                treeItems.set(edge, toItems);
+                traverse.add(nextItem);
+            }
+        }
+    }
+    for (const item of [...traverse].reverse()) {
+        if (item.include && item.parent) {
+            item.parent.include = true;
+        }
+    }
+    return treeItems;
+};
+/**
+ * Returns a human-readable output of the graph.
+ */
+export function humanReadableOutput(options) {
+    const { colors, importers } = options;
+    const noop = (s) => s;
+    const { dim = noop, red = noop, reset = noop, yellow = noop, } = colors ?? {};
+    const initialItems = new Set();
+    for (const importer of importers) {
+        initialItems.add({
+            name: importer.name,
+            edge: undefined,
+            node: importer,
+            prefix: '',
+            padding: '',
+            hasSibling: false,
+            deduped: false,
+            include: isSelected(options, undefined, importer),
+            parent: undefined,
+        });
+    }
+    const treeItems = getTreeItems(initialItems, options);
+    let res = '';
+    const traverse = (item) => {
+        let header = '';
+        let content = '';
+        const depIdTuple = item.node?.id && splitDepID(item.node.id);
+        const hasCustomReg = depIdTuple?.[0] === 'registry' && depIdTuple[1];
+        const name = hasCustomReg ? `${depIdTuple[1]}:${item.name}` : item.name;
+        const decoratedName = (options.highlightSelection &&
+            isSelected(options, item.edge, item.node)) ?
+            yellow(name)
+            : name;
+        if (!item.node && item.include) {
+            const missing = item.edge?.type.endsWith('ptional') ?
+                dim('(missing optional)')
+                : red('(missing)');
+            return `${item.padding}${item.prefix}${decoratedName} ${missing}\n`;
+        }
+        const deduped = item.deduped ? ` ${dim('(deduped)')}` : '';
+        header += `${item.padding}${item.prefix}${decoratedName}${deduped}\n`;
+        // deduped items need not to be printed or traversed
+        if (!item.deduped) {
+            const edges = item.node ? [...item.node.edgesOut.values()] : [];
+            const nextItems = edges.map(i => treeItems.get(i)?.get(i.to));
+            const includedItems = nextItems.filter(i => i?.include);
+            for (const nextItem of nextItems) {
+                /* c8 ignore next -- impossible but TS doesn't know that */
+                if (!nextItem)
+                    continue;
+                const parent = item;
+                const isLast = includedItems.indexOf(nextItem) === includedItems.length - 1;
+                const toName = nextItem.node?.version ?
+                    `${nextItem.node.name}@${nextItem.node.version}`
+                    : nextItem.node?.name;
+                const nextChar = isLast ? 'last-child' : 'middle-child';
+                nextItem.name =
+                    (nextItem.node?.name &&
+                        nextItem.edge?.name !== nextItem.edge?.to?.name) ?
+                        `${nextItem.edge?.name} (${toName})`
+                        : `${nextItem.edge?.name}@${nextItem.node?.version || nextItem.edge?.spec.bareSpec}`;
+                nextItem.padding =
+                    parent.prefix.length ?
+                        `${parent.padding}${parent.hasSibling ? chars.get('down') : ' '} `
+                        : '';
+                nextItem.prefix = `${chars.get(nextChar)}${chars.get('connection')}${chars.get('connection')} `;
+                nextItem.hasSibling = !isLast;
+                content += traverse(nextItem);
+            }
+        }
+        const regularConnection = `${chars.get('connection')} `;
+        const parentConnection = `${chars.get('t')} `;
+        return item.include ?
+            `${content ? header.replace(regularConnection, parentConnection) : header}${content}`
+            : '';
+    };
+    for (const item of initialItems) {
+        res += traverse(item);
+    }
+    return reset(res);
+}
+//# sourceMappingURL=human-readable-output.js.map

package/dist/esm/visualization/human-readable-output.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"human-readable-output.js","sourceRoot":"","sources":["../../../src/visualization/human-readable-output.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAI3C,MAAM,KAAK,GAAG,IAAI,GAAG,CACnB,MAAM,CAAC,OAAO,CAAC;IACb,UAAU,EAAE,GAAG;IACf,IAAI,EAAE,GAAG;IACT,YAAY,EAAE,GAAG;IACjB,cAAc,EAAE,GAAG;IACnB,CAAC,EAAE,GAAG;CACP,CAAC,CACH,CAAA;AAsBD,MAAM,UAAU,GAAG,CACjB,OAAmC,EACnC,IAAe,EACf,IAAe,EACf,EAAE,CACF,CAAC,CAAC,CACA,CAAC,CAAC,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC,CAAC,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CACxC,CAAA;AAEH;;GAEG;AACH,MAAM,YAAY,GAAG,CACnB,YAA2B,EAC3B,OAAmC,EACnC,EAAE;IACF,MAAM,SAAS,GAAG,IAAI,GAAG,EAAY,CAAA;IACrC,MAAM,SAAS,GAAG,IAAI,GAAG,EAGtB,CAAA;IACH,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAW,YAAY,CAAC,CAAA;IAChD,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;QAC5B,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,IAAI,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC7B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;gBACnB,SAAQ;YACV,CAAC;YACD,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACxB,MAAM,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CACtD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,QAAQ,CAAC,CACvB,CAAA;YACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,EAAE,CAAA;gBAChD,MAAM,QAAQ,GAAa;oBACzB,IAAI;oBACJ,IAAI,EAAE,IAAI,CAAC,EAAE;oBACb,UAAU,EAAE,KAAK;oBACjB,OAAO,EAAE,EAAE;oBACX,MAAM,EAAE,EAAE;oBACV,OAAO,EAAE,KAAK;oBACd,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;oBAC3C,MAAM,EAAE,IAAI;iBACb,CAAA;gBACD,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;gBAC9B,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;gBAC5B,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;YACxB,CAAC;QACH,CAAC;IACH,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;QAC3C,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAA;QAC5B,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,OAAmC;IAEnC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAA;IACrC,MAAM,IAAI,GAAG,CAAC,CAAiB,EAAE,EAAE,CAAC,CAAC,CAAA;IACrC,MAAM,EACJ,GAAG,GAAG,IAAI,EACV,GAAG,GAAG,IAAI,EACV,KAAK,GAAG,IAAI,EACZ,MAAM,GAAG,IAAI,GACd,GAAG,MAAM,IAAI,EAAE,CAAA;IAChB,MAAM,YAAY,GAAG,IAAI,GAAG,EAAY,CAAA;IACxC,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,YAAY,CAAC,GAAG,CAAC;YACf,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,EAAE;YACV,OAAO,EAAE,EAAE;YACX,UAAU,EAAE,KAAK;YACjB,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC;YACjD,MAAM,EAAE,SAAS;SAClB,CAAC,CAAA;IACJ,CAAC;IACD,MAAM,SAAS,GAAG,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;IAErD,IAAI,GAAG,GAAG,EAAE,CAAA;IACZ,MAAM,QAAQ,GAAG,CAAC,IAAc,EAAE,EAAE;QAClC,IAAI,MAAM,GAAG,EAAE,CAAA;QACf,IAAI,OAAO,GAAG,EAAE,CAAA;QAEhB,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAC5D,MAAM,YAAY,GAChB,UAAU,EAAE,CAAC,CAAC,CAAC,KAAK,UAAU,IAAI,UAAU,CAAC,CAAC,CAAC,CAAA;QACjD,MAAM,IAAI,GACR,YAAY,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAA;QAC5D,MAAM,aAAa,GACjB,CACE,OAAO,CAAC,kBAAkB;YAC1B,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAC1C,CAAC,CAAC;YACD,MAAM,CAAC,IAAI,CAAC;YACd,CAAC,CAAC,IAAI,CAAA;QACR,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAC/B,MAAM,OAAO,GACX,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;gBACnC,GAAG,CAAC,oBAAoB,CAAC;gBAC3B,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;YACpB,OAAO,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,GAAG,aAAa,IAAI,OAAO,IAAI,CAAA;QACrE,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;QAC1D,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,GAAG,aAAa,GAAG,OAAO,IAAI,CAAA;QAErE,oDAAoD;QACpD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;YAC/D,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;YAC7D,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;YAEvD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBACjC,2DAA2D;gBAC3D,IAAI,CAAC,QAAQ;oBAAE,SAAQ;gBAEvB,MAAM,MAAM,GAAG,IAAI,CAAA;gBACnB,MAAM,MAAM,GACV,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,aAAa,CAAC,MAAM,GAAG,CAAC,CAAA;gBAC9D,MAAM,MAAM,GACV,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;oBACtB,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE;oBAClD,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;gBACvB,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,cAAc,CAAA;gBAEvD,QAAQ,CAAC,IAAI;oBACX,CACE,QAAQ,CAAC,IAAI,EAAE,IAAI;wBACnB,QAAQ,CAAC,IAAI,EAAE,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,CAChD,CAAC,CAAC;wBACD,GAAG,QAAQ,CAAC,IAAI,EAAE,IAAI,KAAK,MAAM,GAAG;wBACtC,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,EAAE,IAAI,IAAI,QAAQ,CAAC,IAAI,EAAE,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAA;gBACtF,QAAQ,CAAC,OAAO;oBACd,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;wBACpB,GAAG,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG;wBACpE,CAAC,CAAC,EAAE,CAAA;gBACN,QAAQ,CAAC,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAA;gBAC/F,QAAQ,CAAC,UAAU,GAAG,CAAC,MAAM,CAAA;gBAE7B,OAAO,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAAA;YAC/B,CAAC;QACH,CAAC;QAED,MAAM,iBAAiB,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAA;QACvD,MAAM,gBAAgB,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAA;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACjB,GAAG,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,OAAO,EAAE;YACvF,CAAC,CAAC,EAAE,CAAA;IACR,CAAC,CAAA;IAED,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QAChC,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAA;IACvB,CAAC;IACD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAA;AACnB,CAAC","sourcesContent":["import { splitDepID } from '@vltpkg/dep-id'\nimport { EdgeLike, NodeLike } from '../types.js'\nimport type { ChalkInstance } from 'chalk'\n\nconst chars = new Map(\n  Object.entries({\n    connection: '─',\n    down: '│',\n    'last-child': '└',\n    'middle-child': '├',\n    t: '┬',\n  }),\n)\n\nexport type TreeItem = {\n  name?: string | null\n  edge: EdgeLike | undefined\n  node: NodeLike | undefined\n  prefix: string\n  padding: string\n  hasSibling: boolean\n  deduped: boolean\n  include: boolean\n  parent: TreeItem | undefined\n}\n\nexport type HumanReadableOutputOptions = {\n  edges: EdgeLike[]\n  importers: Set<NodeLike>\n  nodes: NodeLike[]\n  colors?: ChalkInstance\n  highlightSelection: boolean\n}\n\nconst isSelected = (\n  options: HumanReadableOutputOptions,\n  edge?: EdgeLike,\n  node?: NodeLike,\n) =>\n  !!(\n    (!node || options.nodes.includes(node)) &&\n    (!edge || options.edges.includes(edge))\n  )\n\n/**\n * Returns a map of tree items to be printed.\n */\nconst getTreeItems = (\n  initialItems: Set<TreeItem>,\n  options: HumanReadableOutputOptions,\n) => {\n  const seenNodes = new Set<NodeLike>()\n  const treeItems = new Map<\n    EdgeLike | undefined,\n    Map<NodeLike | undefined, TreeItem>\n  >()\n  const traverse = new Set<TreeItem>(initialItems)\n  for (const item of traverse) {\n    if (item.node) {\n      if (seenNodes.has(item.node)) {\n        item.deduped = true\n        continue\n      }\n      seenNodes.add(item.node)\n      const edges = [...item.node.edgesOut.values()].sort(i =>\n        Number(i.to?.importer),\n      )\n      for (const edge of edges) {\n        const toItems = treeItems.get(edge) ?? new Map()\n        const nextItem: TreeItem = {\n          edge,\n          node: edge.to,\n          hasSibling: false,\n          padding: '',\n          prefix: '',\n          deduped: false,\n          include: isSelected(options, edge, edge.to),\n          parent: item,\n        }\n        toItems.set(edge.to, nextItem)\n        treeItems.set(edge, toItems)\n        traverse.add(nextItem)\n      }\n    }\n  }\n  for (const item of [...traverse].reverse()) {\n    if (item.include && item.parent) {\n      item.parent.include = true\n    }\n  }\n  return treeItems\n}\n\n/**\n * Returns a human-readable output of the graph.\n */\nexport function humanReadableOutput(\n  options: HumanReadableOutputOptions,\n) {\n  const { colors, importers } = options\n  const noop = (s?: string | null) => s\n  const {\n    dim = noop,\n    red = noop,\n    reset = noop,\n    yellow = noop,\n  } = colors ?? {}\n  const initialItems = new Set<TreeItem>()\n  for (const importer of importers) {\n    initialItems.add({\n      name: importer.name,\n      edge: undefined,\n      node: importer,\n      prefix: '',\n      padding: '',\n      hasSibling: false,\n      deduped: false,\n      include: isSelected(options, undefined, importer),\n      parent: undefined,\n    })\n  }\n  const treeItems = getTreeItems(initialItems, options)\n\n  let res = ''\n  const traverse = (item: TreeItem) => {\n    let header = ''\n    let content = ''\n\n    const depIdTuple = item.node?.id && splitDepID(item.node.id)\n    const hasCustomReg =\n      depIdTuple?.[0] === 'registry' && depIdTuple[1]\n    const name =\n      hasCustomReg ? `${depIdTuple[1]}:${item.name}` : item.name\n    const decoratedName =\n      (\n        options.highlightSelection &&\n        isSelected(options, item.edge, item.node)\n      ) ?\n        yellow(name)\n      : name\n    if (!item.node && item.include) {\n      const missing =\n        item.edge?.type.endsWith('ptional') ?\n          dim('(missing optional)')\n        : red('(missing)')\n      return `${item.padding}${item.prefix}${decoratedName} ${missing}\\n`\n    }\n\n    const deduped = item.deduped ? ` ${dim('(deduped)')}` : ''\n    header += `${item.padding}${item.prefix}${decoratedName}${deduped}\\n`\n\n    // deduped items need not to be printed or traversed\n    if (!item.deduped) {\n      const edges = item.node ? [...item.node.edgesOut.values()] : []\n      const nextItems = edges.map(i => treeItems.get(i)?.get(i.to))\n      const includedItems = nextItems.filter(i => i?.include)\n\n      for (const nextItem of nextItems) {\n        /* c8 ignore next -- impossible but TS doesn't know that */\n        if (!nextItem) continue\n\n        const parent = item\n        const isLast =\n          includedItems.indexOf(nextItem) === includedItems.length - 1\n        const toName =\n          nextItem.node?.version ?\n            `${nextItem.node.name}@${nextItem.node.version}`\n          : nextItem.node?.name\n        const nextChar = isLast ? 'last-child' : 'middle-child'\n\n        nextItem.name =\n          (\n            nextItem.node?.name &&\n            nextItem.edge?.name !== nextItem.edge?.to?.name\n          ) ?\n            `${nextItem.edge?.name} (${toName})`\n          : `${nextItem.edge?.name}@${nextItem.node?.version || nextItem.edge?.spec.bareSpec}`\n        nextItem.padding =\n          parent.prefix.length ?\n            `${parent.padding}${parent.hasSibling ? chars.get('down') : ' '} `\n          : ''\n        nextItem.prefix = `${chars.get(nextChar)}${chars.get('connection')}${chars.get('connection')} `\n        nextItem.hasSibling = !isLast\n\n        content += traverse(nextItem)\n      }\n    }\n\n    const regularConnection = `${chars.get('connection')} `\n    const parentConnection = `${chars.get('t')} `\n    return item.include ?\n        `${content ? header.replace(regularConnection, parentConnection) : header}${content}`\n      : ''\n  }\n\n  for (const item of initialItems) {\n    res += traverse(item)\n  }\n  return reset(res)\n}\n"]}

package/dist/esm/visualization/json-output.d.ts

@@ -0,0 +1,37 @@
+import { DepID } from '@vltpkg/dep-id';
+import { EdgeLike, NodeLike } from '../types.js';
+/**
+ * A JSON output item describes a package that is present in the install
+ * graph. It represents an edge plus it's linking Node.
+ */
+export type JSONOutputItem = {
+    /**
+     * The name of the package.
+     */
+    name: string;
+    /**
+     * A reference to the id of the Node that this package is linked from.
+     */
+    fromID?: DepID;
+    /**
+     * The dependency spec definition for this package.
+     */
+    spec?: string;
+    /**
+     * The package type.
+     */
+    type?: EdgeLike['type'];
+    /**
+     * A representation of the package object that fulfills this dependency.
+     */
+    to?: NodeLike;
+};
+export type JSONOutputOptions = {
+    edges: EdgeLike[];
+    nodes: NodeLike[];
+};
+/**
+ * Returns a JSON string representation of the graph.
+ */
+export declare function jsonOutput({ edges, nodes }: JSONOutputOptions): string;
+//# sourceMappingURL=json-output.d.ts.map

package/dist/esm/visualization/json-output.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-output.d.ts","sourceRoot":"","sources":["../../../src/visualization/json-output.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AACtC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAEhD;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAA;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACvB;;OAEG;IACH,EAAE,CAAC,EAAE,QAAQ,CAAA;CACd,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,QAAQ,EAAE,CAAA;IACjB,KAAK,EAAE,QAAQ,EAAE,CAAA;CAClB,CAAA;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,iBAAiB,UA0B7D"}

package/dist/esm/visualization/json-output.js

@@ -0,0 +1,28 @@
+/**
+ * Returns a JSON string representation of the graph.
+ */
+export function jsonOutput({ edges, nodes }) {
+    const res = [];
+    // Collects importer nodes as edgeless json output items
+    for (const node of nodes) {
+        if (node.importer) {
+            res.push({
+                /* c8 ignore next - name can't be missing but ts won't know */
+                name: node.name || node.id,
+                to: node,
+            });
+        }
+    }
+    // Collects edge & it's linked nodes as json output items
+    for (const edge of edges) {
+        res.push({
+            name: edge.name,
+            fromID: edge.from.id,
+            spec: String(edge.spec),
+            type: edge.type,
+            to: edge.to,
+        });
+    }
+    return JSON.stringify(res, null, 2);
+}
+//# sourceMappingURL=json-output.js.map

package/dist/esm/visualization/json-output.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-output.js","sourceRoot":"","sources":["../../../src/visualization/json-output.ts"],"names":[],"mappings":"AAmCA;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,EAAE,KAAK,EAAE,KAAK,EAAqB;IAC5D,MAAM,GAAG,GAAqB,EAAE,CAAA;IAEhC,wDAAwD;IACxD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,GAAG,CAAC,IAAI,CAAC;gBACP,8DAA8D;gBAC9D,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE;gBAC1B,EAAE,EAAE,IAAI;aACT,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,yDAAyD;IACzD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,GAAG,CAAC,IAAI,CAAC;YACP,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE;YACpB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;YACvB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,EAAE,EAAE,IAAI,CAAC,EAAE;SACZ,CAAC,CAAA;IACJ,CAAC;IAED,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;AACrC,CAAC","sourcesContent":["import { DepID } from '@vltpkg/dep-id'\nimport { EdgeLike, NodeLike } from '../types.js'\n\n/**\n * A JSON output item describes a package that is present in the install\n * graph. It represents an edge plus it's linking Node.\n */\nexport type JSONOutputItem = {\n  /**\n   * The name of the package.\n   */\n  name: string\n  /**\n   * A reference to the id of the Node that this package is linked from.\n   */\n  fromID?: DepID\n  /**\n   * The dependency spec definition for this package.\n   */\n  spec?: string\n  /**\n   * The package type.\n   */\n  type?: EdgeLike['type']\n  /**\n   * A representation of the package object that fulfills this dependency.\n   */\n  to?: NodeLike\n}\n\nexport type JSONOutputOptions = {\n  edges: EdgeLike[]\n  nodes: NodeLike[]\n}\n\n/**\n * Returns a JSON string representation of the graph.\n */\nexport function jsonOutput({ edges, nodes }: JSONOutputOptions) {\n  const res: JSONOutputItem[] = []\n\n  // Collects importer nodes as edgeless json output items\n  for (const node of nodes) {\n    if (node.importer) {\n      res.push({\n        /* c8 ignore next - name can't be missing but ts won't know */\n        name: node.name || node.id,\n        to: node,\n      })\n    }\n  }\n\n  // Collects edge & it's linked nodes as json output items\n  for (const edge of edges) {\n    res.push({\n      name: edge.name,\n      fromID: edge.from.id,\n      spec: String(edge.spec),\n      type: edge.type,\n      to: edge.to,\n    })\n  }\n\n  return JSON.stringify(res, null, 2)\n}\n"]}

package/dist/esm/visualization/mermaid-output.d.ts

@@ -0,0 +1,11 @@
+import { EdgeLike, NodeLike } from '../types.js';
+export type MermaidOutputOptions = {
+    edges: EdgeLike[];
+    importers: Set<NodeLike>;
+    nodes: NodeLike[];
+};
+/**
+ * Returns a mermaid string representation of the graph.
+ */
+export declare function mermaidOutput({ edges, importers, nodes, }: MermaidOutputOptions): string;
+//# sourceMappingURL=mermaid-output.d.ts.map

package/dist/esm/visualization/mermaid-output.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mermaid-output.d.ts","sourceRoot":"","sources":["../../../src/visualization/mermaid-output.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAEhD,MAAM,MAAM,oBAAoB,GAAG;IACjC,KAAK,EAAE,QAAQ,EAAE,CAAA;IACjB,SAAS,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAA;IACxB,KAAK,EAAE,QAAQ,EAAE,CAAA;CAClB,CAAA;AAsDD;;GAEG;AACH,wBAAgB,aAAa,CAAC,EAC5B,KAAK,EACL,SAAS,EACT,KAAK,GACN,EAAE,oBAAoB,UA0CtB"}

package/dist/esm/visualization/mermaid-output.js

@@ -0,0 +1,68 @@
+import { Edge } from '../edge.js';
+import { Node } from '../node.js';
+let missingCount = 0;
+const nodeLabel = (node) => `"${String(node).replaceAll('@', '#64;')}"`;
+function parseNode(seenNodes, includedItems, node) {
+    if (seenNodes.has(node.id) || !includedItems.get(node)) {
+        return '';
+    }
+    seenNodes.add(node.id);
+    const edges = [...node.edgesOut.values()]
+        .map(e => parseEdge(seenNodes, includedItems, e))
+        .filter(Boolean)
+        .join('\n');
+    return `${encodeURIComponent(node.id)}(${nodeLabel(node)})${edges.length ? '\n' : ''}${edges}`;
+}
+function parseEdge(seenNodes, includedItems, edge) {
+    if (!includedItems.get(edge)) {
+        return '';
+    }
+    const edgeResult = `${encodeURIComponent(edge.from.id)}(${nodeLabel(edge.from)})` +
+        ` -->|"${String(edge.spec).replaceAll('@', '#64;')} (${edge.type})"| `;
+    const missingLabel = edge.type.endsWith('ptional') ? 'Missing Optional' : 'Missing';
+    if (!edge.to) {
+        return edgeResult + `missing-${missingCount++}(${missingLabel})\n`;
+    }
+    return (edgeResult +
+        `${encodeURIComponent(edge.to.id)}(${nodeLabel(edge.to)})\n` +
+        parseNode(seenNodes, includedItems, edge.to));
+}
+/**
+ * Returns a mermaid string representation of the graph.
+ */
+export function mermaidOutput({ edges, importers, nodes, }) {
+    const seen = new Set();
+    const includedItems = new Map();
+    const traverse = new Set([...importers].map(i => ({ self: i, parent: undefined })));
+    for (const item of traverse) {
+        if (seen.has(item.self))
+            continue;
+        seen.add(item.self);
+        if (item.self instanceof Edge) {
+            if (edges.includes(item.self)) {
+                includedItems.set(item.self, true);
+            }
+            if (item.self.to) {
+                traverse.add({ self: item.self.to, parent: item.self });
+            }
+        }
+        if (item.self instanceof Node) {
+            if (nodes.includes(item.self)) {
+                includedItems.set(item.self, true);
+            }
+            for (const edge of item.self.edgesOut.values()) {
+                traverse.add({ self: edge, parent: item.self });
+            }
+        }
+    }
+    for (const item of [...traverse].reverse()) {
+        if (includedItems.has(item.self) && item.parent) {
+            includedItems.set(item.parent, true);
+        }
+    }
+    return ('flowchart TD\n' +
+        [...importers]
+            .map(i => parseNode(new Set(), includedItems, i))
+            .join('\n'));
+}
+//# sourceMappingURL=mermaid-output.js.map

package/dist/esm/visualization/mermaid-output.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mermaid-output.js","sourceRoot":"","sources":["../../../src/visualization/mermaid-output.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AAcjC,IAAI,YAAY,GAAG,CAAC,CAAA;AAEpB,MAAM,SAAS,GAAG,CAAC,IAAc,EAAE,EAAE,CACnC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAA;AAE7C,SAAS,SAAS,CAChB,SAAqB,EACrB,aAAgD,EAChD,IAAc;IAEd,IAAI,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QACvD,OAAO,EAAE,CAAA;IACX,CAAC;IACD,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACtB,MAAM,KAAK,GAAW,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;SAC9C,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;SAChD,MAAM,CAAC,OAAO,CAAC;SACf,IAAI,CAAC,IAAI,CAAC,CAAA;IACb,OAAO,GAAG,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,CAAA;AAChG,CAAC;AAED,SAAS,SAAS,CAChB,SAAqB,EACrB,aAAgD,EAChD,IAAc;IAEd,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7B,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,UAAU,GACd,GAAG,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;QAC9D,SAAS,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC,IAAI,MAAM,CAAA;IAExE,MAAM,YAAY,GAChB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAA;IAChE,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;QACb,OAAO,UAAU,GAAG,WAAW,YAAY,EAAE,IAAI,YAAY,KAAK,CAAA;IACpE,CAAC;IAED,OAAO,CACL,UAAU;QACV,GAAG,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK;QAC5D,SAAS,CAAC,SAAS,EAAE,aAAa,EAAE,IAAI,CAAC,EAAE,CAAC,CAC7C,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,EAC5B,KAAK,EACL,SAAS,EACT,KAAK,GACgB;IACrB,MAAM,IAAI,GAAG,IAAI,GAAG,EAAuB,CAAA;IAC3C,MAAM,aAAa,GAAG,IAAI,GAAG,EAAgC,CAAA;IAC7D,MAAM,QAAQ,GAAG,IAAI,GAAG,CACtB,CAAC,GAAG,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC,CAC1D,CAAA;IAED,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;QAC5B,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC;YAAE,SAAQ;QACjC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEnB,IAAI,IAAI,CAAC,IAAI,YAAY,IAAI,EAAE,CAAC;YAC9B,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;YACpC,CAAC;YACD,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;gBACjB,QAAQ,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;YACzD,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,YAAY,IAAI,EAAE,CAAC;YAC9B,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;YACpC,CAAC;YACD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC;gBAC/C,QAAQ,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;YACjD,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;QAC3C,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChD,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QACtC,CAAC;IACH,CAAC;IAED,OAAO,CACL,gBAAgB;QAChB,CAAC,GAAG,SAAS,CAAC;aACX,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,GAAG,EAAS,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;aACvD,IAAI,CAAC,IAAI,CAAC,CACd,CAAA;AACH,CAAC","sourcesContent":["import { DepID } from '@vltpkg/dep-id'\nimport { Edge } from '../edge.js'\nimport { Node } from '../node.js'\nimport { EdgeLike, NodeLike } from '../types.js'\n\nexport type MermaidOutputOptions = {\n  edges: EdgeLike[]\n  importers: Set<NodeLike>\n  nodes: NodeLike[]\n}\n\ntype TraverseItem = {\n  self: EdgeLike | NodeLike\n  parent: EdgeLike | NodeLike | undefined\n}\n\nlet missingCount = 0\n\nconst nodeLabel = (node: NodeLike) =>\n  `\"${String(node).replaceAll('@', '#64;')}\"`\n\nfunction parseNode(\n  seenNodes: Set<DepID>,\n  includedItems: Map<EdgeLike | NodeLike, boolean>,\n  node: NodeLike,\n) {\n  if (seenNodes.has(node.id) || !includedItems.get(node)) {\n    return ''\n  }\n  seenNodes.add(node.id)\n  const edges: string = [...node.edgesOut.values()]\n    .map(e => parseEdge(seenNodes, includedItems, e))\n    .filter(Boolean)\n    .join('\\n')\n  return `${encodeURIComponent(node.id)}(${nodeLabel(node)})${edges.length ? '\\n' : ''}${edges}`\n}\n\nfunction parseEdge(\n  seenNodes: Set<DepID>,\n  includedItems: Map<EdgeLike | NodeLike, boolean>,\n  edge: EdgeLike,\n) {\n  if (!includedItems.get(edge)) {\n    return ''\n  }\n\n  const edgeResult =\n    `${encodeURIComponent(edge.from.id)}(${nodeLabel(edge.from)})` +\n    ` -->|\"${String(edge.spec).replaceAll('@', '#64;')} (${edge.type})\"| `\n\n  const missingLabel =\n    edge.type.endsWith('ptional') ? 'Missing Optional' : 'Missing'\n  if (!edge.to) {\n    return edgeResult + `missing-${missingCount++}(${missingLabel})\\n`\n  }\n\n  return (\n    edgeResult +\n    `${encodeURIComponent(edge.to.id)}(${nodeLabel(edge.to)})\\n` +\n    parseNode(seenNodes, includedItems, edge.to)\n  )\n}\n\n/**\n * Returns a mermaid string representation of the graph.\n */\nexport function mermaidOutput({\n  edges,\n  importers,\n  nodes,\n}: MermaidOutputOptions) {\n  const seen = new Set<EdgeLike | NodeLike>()\n  const includedItems = new Map<EdgeLike | NodeLike, boolean>()\n  const traverse = new Set<TraverseItem>(\n    [...importers].map(i => ({ self: i, parent: undefined })),\n  )\n\n  for (const item of traverse) {\n    if (seen.has(item.self)) continue\n    seen.add(item.self)\n\n    if (item.self instanceof Edge) {\n      if (edges.includes(item.self)) {\n        includedItems.set(item.self, true)\n      }\n      if (item.self.to) {\n        traverse.add({ self: item.self.to, parent: item.self })\n      }\n    }\n\n    if (item.self instanceof Node) {\n      if (nodes.includes(item.self)) {\n        includedItems.set(item.self, true)\n      }\n      for (const edge of item.self.edgesOut.values()) {\n        traverse.add({ self: edge, parent: item.self })\n      }\n    }\n  }\n\n  for (const item of [...traverse].reverse()) {\n    if (includedItems.has(item.self) && item.parent) {\n      includedItems.set(item.parent, true)\n    }\n  }\n\n  return (\n    'flowchart TD\\n' +\n    [...importers]\n      .map(i => parseNode(new Set<DepID>(), includedItems, i))\n      .join('\\n')\n  )\n}\n"]}

package/dist/esm/visualization/object-like-output.d.ts

@@ -0,0 +1,3 @@
+import { GraphLike } from '../types.js';
+export declare function objectLikeOutput(graph: GraphLike): string;
+//# sourceMappingURL=object-like-output.d.ts.map

package/dist/esm/visualization/object-like-output.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-like-output.d.ts","sourceRoot":"","sources":["../../../src/visualization/object-like-output.ts"],"names":[],"mappings":"AACA,OAAO,EAAY,SAAS,EAAY,MAAM,aAAa,CAAA;AAyD3D,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,SAAS,UAOhD"}

package/dist/esm/visualization/object-like-output.js

@@ -0,0 +1,49 @@
+import { inspect } from 'node:util';
+function parseNode(seenNodes, graph, node) {
+    ;
+    node[inspect.custom] = () => {
+        const res = 'Node ' +
+            inspect(seenNodes.has(node) ?
+                { ref: node.id }
+                : {
+                    id: node.id,
+                    location: node.location,
+                    ...(node.importer ? { importer: true } : null),
+                    ...(node.dev ? { dev: true } : null),
+                    ...(node.optional ? { optional: true } : null),
+                    ...(node.resolved ? { resolved: node.resolved } : null),
+                    ...(node.integrity ?
+                        { integrity: node.integrity }
+                        : null),
+                    ...(node.edgesOut.size ?
+                        {
+                            edgesOut: [...node.edgesOut.values()].map(i => {
+                                seenNodes.add(node);
+                                return parseEdge(seenNodes, graph, i);
+                            }),
+                        }
+                        : (seenNodes.add(node), null)),
+                }, { depth: Infinity });
+        return res;
+    };
+    return node;
+}
+function parseEdge(seenNodes, graph, edge) {
+    ;
+    edge[inspect.custom] = () => {
+        const missingNode = `[missing package]: <${edge.name}@${edge.spec.bareSpec}>`;
+        const toLabel = edge.to ?
+            inspect(parseNode(seenNodes, graph, edge.to), {
+                depth: Infinity,
+            })
+            : missingNode;
+        return `Edge spec(${String(edge.spec)}) -${edge.type}-> to: ${toLabel}`;
+    };
+    return edge;
+}
+export function objectLikeOutput(graph) {
+    const seenNodes = new Set();
+    const importers = [...graph.importers];
+    return inspect(importers.map(i => parseNode(seenNodes, graph, i)), { depth: Infinity });
+}
+//# sourceMappingURL=object-like-output.js.map

package/dist/esm/visualization/object-like-output.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-like-output.js","sourceRoot":"","sources":["../../../src/visualization/object-like-output.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAGnC,SAAS,SAAS,CAChB,SAAwB,EACxB,KAAgB,EAChB,IAAc;IAEd,CAAC;IAAC,IAAY,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,GAAW,EAAE;QAC5C,MAAM,GAAG,GACP,OAAO;YACP,OAAO,CACL,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;gBACnB,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE;gBAClB,CAAC,CAAC;oBACE,EAAE,EAAE,IAAI,CAAC,EAAE;oBACX,QAAQ,EAAE,IAAI,CAAC,QAAQ;oBACvB,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;oBAC9C,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;oBACpC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;oBAC9C,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;oBACvD,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;wBAClB,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE;wBAC/B,CAAC,CAAC,IAAI,CAAC;oBACP,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;wBACtB;4BACE,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;gCAC5C,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;gCACnB,OAAO,SAAS,CAAC,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;4BACvC,CAAC,CAAC;yBACH;wBACH,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;iBAC/B,EACH,EAAE,KAAK,EAAE,QAAQ,EAAE,CACpB,CAAA;QACH,OAAO,GAAG,CAAA;IACZ,CAAC,CAAA;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,SAAS,CAChB,SAAwB,EACxB,KAAgB,EAChB,IAAc;IAEd,CAAC;IAAC,IAAY,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,GAAG,EAAE;QACpC,MAAM,WAAW,GAAG,uBAAuB,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAA;QAC7E,MAAM,OAAO,GACX,IAAI,CAAC,EAAE,CAAC,CAAC;YACP,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,EAAE;gBAC5C,KAAK,EAAE,QAAQ;aAChB,CAAC;YACJ,CAAC,CAAC,WAAW,CAAA;QACf,OAAO,aAAa,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,UAAU,OAAO,EAAE,CAAA;IACzE,CAAC,CAAA;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,KAAgB;IAC/C,MAAM,SAAS,GAAG,IAAI,GAAG,EAAY,CAAA;IACrC,MAAM,SAAS,GAAG,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,CAAA;IACtC,OAAO,OAAO,CACZ,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAClD,EAAE,KAAK,EAAE,QAAQ,EAAE,CACpB,CAAA;AACH,CAAC","sourcesContent":["import { inspect } from 'node:util'\nimport { EdgeLike, GraphLike, NodeLike } from '../types.js'\n\nfunction parseNode(\n  seenNodes: Set<NodeLike>,\n  graph: GraphLike,\n  node: NodeLike,\n) {\n  ;(node as any)[inspect.custom] = (): string => {\n    const res =\n      'Node ' +\n      inspect(\n        seenNodes.has(node) ?\n          { ref: node.id }\n        : {\n            id: node.id,\n            location: node.location,\n            ...(node.importer ? { importer: true } : null),\n            ...(node.dev ? { dev: true } : null),\n            ...(node.optional ? { optional: true } : null),\n            ...(node.resolved ? { resolved: node.resolved } : null),\n            ...(node.integrity ?\n              { integrity: node.integrity }\n            : null),\n            ...(node.edgesOut.size ?\n              {\n                edgesOut: [...node.edgesOut.values()].map(i => {\n                  seenNodes.add(node)\n                  return parseEdge(seenNodes, graph, i)\n                }),\n              }\n            : (seenNodes.add(node), null)),\n          },\n        { depth: Infinity },\n      )\n    return res\n  }\n  return node\n}\n\nfunction parseEdge(\n  seenNodes: Set<NodeLike>,\n  graph: GraphLike,\n  edge: EdgeLike,\n) {\n  ;(edge as any)[inspect.custom] = () => {\n    const missingNode = `[missing package]: <${edge.name}@${edge.spec.bareSpec}>`\n    const toLabel: string =\n      edge.to ?\n        inspect(parseNode(seenNodes, graph, edge.to), {\n          depth: Infinity,\n        })\n      : missingNode\n    return `Edge spec(${String(edge.spec)}) -${edge.type}-> to: ${toLabel}`\n  }\n  return edge\n}\n\nexport function objectLikeOutput(graph: GraphLike) {\n  const seenNodes = new Set<NodeLike>()\n  const importers = [...graph.importers]\n  return inspect(\n    importers.map(i => parseNode(seenNodes, graph, i)),\n    { depth: Infinity },\n  )\n}\n"]}

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@vltpkg/graph",
+  "description": "A library that helps understanding & expressing what happens on an install",
+  "version": "0.0.0-0.1730239248325",
+  "tshy": {
+    "selfLink": false,
+    "dialects": [
+      "esm"
+    ],
+    "exports": {
+      "./package.json": "./package.json",
+      ".": "./src/index.ts",
+      "./browser": "./src/browser.ts"
+    }
+  },
+  "dependencies": {
+    "graph-run": "^1.0.4",
+    "path-scurry": "^2.0.0",
+    "promise-call-limit": "^3.0.2",
+    "@vltpkg/dep-id": "0.0.0-0.1730239248325",
+    "@vltpkg/package-json": "0.0.0-0.1730239248325",
+    "@vltpkg/error-cause": "0.0.0-0.1730239248325",
+    "@vltpkg/pick-manifest": "0.0.0-0.1730239248325",
+    "@vltpkg/registry-client": "0.0.0-0.1730239248325",
+    "@vltpkg/rollback-remove": "0.0.0-0.1730239248325",
+    "@vltpkg/satisfies": "0.0.0-0.1730239248325",
+    "@vltpkg/semver": "0.0.0-0.1730239248325",
+    "@vltpkg/package-info": "0.0.0-0.1730239248325",
+    "@vltpkg/types": "0.0.0-0.1730239248325",
+    "@vltpkg/run": "0.0.0-0.1730239248325",
+    "@vltpkg/fast-split": "0.0.0-0.1730239248325",
+    "@vltpkg/spec": "0.0.0-0.1730239248325",
+    "@vltpkg/workspaces": "0.0.0-0.1730239248325"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.8.0",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^22.4.1",
+    "chalk": "^5.3.0",
+    "eslint": "^9.8.0",
+    "prettier": "^3.3.2",
+    "tap": "^21.0.1",
+    "tar": "^7.4.3",
+    "tshy": "^3.0.2",
+    "typescript": "^5.5.4",
+    "typescript-eslint": "^8.0.1"
+  },
+  "license": "BSD-2-Clause-Patent",
+  "engines": {
+    "node": "20 || >=22"
+  },
+  "tap": {
+    "extends": "../../tap-config.yaml"
+  },
+  "prettier": "../../.prettierrc.js",
+  "module": "./dist/esm/index.js",
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      }
+    },
+    "./browser": {
+      "import": {
+        "types": "./dist/esm/browser.d.ts",
+        "default": "./dist/esm/browser.js"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "format": "prettier --write . --log-level warn --ignore-path ../../.prettierignore --cache",
+    "format:check": "prettier --check . --ignore-path ../../.prettierignore --cache",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
+    "presnap": "tshy",
+    "snap": "tap",
+    "pretest": "tshy",
+    "test": "tap"
+  }
+}