@vltpkg/graph 0.0.0-9 → 1.0.0-rc.10

package/dist/esm/lockfile/save.js.map

@@ -1 +1 @@
-{"version":3,"file":"save.js","sourceRoot":"","sources":["../../../src/lockfile/save.ts"],"names":[],"mappings":"AACA,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,cAAc,CAAA;AAErB,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAClD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAI5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAoB/C,MAAM,WAAW,GAAG,CAClB,KAAqB,EACrB,aAAuB,EACvB,QAAiB,EACjB,EAAE;IACF,gEAAgE;IAChE,mEAAmE;IACnE,MAAM,GAAG,GAAW,CAAC,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC7D,2DAA2D;IAC3D,MAAM,YAAY,GAAW,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAC7C,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,CAC/B,CAAA;IAED,MAAM,GAAG,GAAgC,EAAE,CAAA;IAC3C,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QAChC,MAAM,cAAc,GAClB,IAAI,CAAC,QAAQ,IAAI,QAAQ,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;QAClE,MAAM,QAAQ,GAAG,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAA;QAC3D,2DAA2D;QAC3D,MAAM,QAAQ,GACZ,CACE,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC;YAC1B,IAAI,CAAC,QAAQ,CAAC,QAAQ,CACpB,qBAAqB;gBACnB,IAAI,CAAC,EAAE;gBACP,gBAAgB;gBAChB,IAAI,CAAC,IAAI,CACZ,CACF,CAAC,CAAC;YACD,SAAS;YACX,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAA;QAEjB,MAAM,KAAK,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAA;QACtC,MAAM,YAAY,GAAiB,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;QAErD,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAA;QAClC,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YACb,YAAY,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAA;QAC5B,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YACb,YAAY,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAA;QAC5B,CAAC;QAED,IAAI,aAAa,EAAE,CAAC;YAClB,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAA;QACjC,CAAC;QAED,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,YAAY,CAAA;IAC7B,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED,MAAM,WAAW,GAAG,CAAC,KAAgB,EAAiB,EAAE,CACtD,MAAM,CAAC,WAAW,CAChB,CAAC,GAAG,KAAK,CAAC;KACP,IAAI,CACH,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;AACP,4DAA4D;AAC5D,oDAAoD;AACpD,mBAAmB;AACnB,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACjD,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC;IACxC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC;IAClC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAEjD;KACA,GAAG,CAAC,CAAC,IAAI,EAAwC,EAAE,CAAC;IACnD,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;IACnC,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,GAAG,IAAI,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,SAAS,EAAE;CACxE,CAAC,CACL,CAAA;AAEH,MAAM,oBAAoB,GAAG,CAC3B,UAAmB,EACmB,EAAE,CACxC,CAAC,CAAC,CAAC,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAA;AAElD,MAAM,kBAAkB,GAAG,CACzB,YAAoC,EACpC,KAA6B,EAC7B,EAAE;IACF,MAAM,GAAG,GAA2B,EAAE,CAAA;IACtC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,GAAG,CAAC,KAAK,KAAK,EAAE,CAAC;YACtD,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;QAClB,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,EAC3B,KAAK,EACL,WAAW,EAAE,QAAQ,EACrB,mBAAmB,EAAE,eAAe,EACpC,QAAQ,EACR,UAAU,EACV,aAAa,EACb,kBAAkB,EAAE,eAAe,GACvB,EAAgB,EAAE;IAC9B,MAAM,aAAa,GACjB,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC9B,kBAAkB,CAAC,eAAe,EAAE,QAAQ,CAAC;QAC/C,CAAC,CAAC,SAAS,CAAA;IACb,MAAM,oBAAoB,GACxB,oBAAoB,CAAC,eAAe,CAAC,CAAC,CAAC;QACrC,kBAAkB,CAAC,sBAAsB,EAAE,eAAe,CAAC;QAC7D,CAAC,CAAC,SAAS,CAAA;IACb,MAAM,eAAe,GACnB,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC;QAChC,kBAAkB,CAAC,iBAAiB,EAAE,UAAU,CAAC;QACnD,CAAC,CAAC,SAAS,CAAA;IACb,MAAM,oBAAoB,GACxB,oBAAoB,CAAC,eAAe,CAAC,CAAC,CAAC;QACrC,kBAAkB,CAAC,sBAAsB,EAAE,eAAe,CAAC;QAC7D,CAAC,CAAC,SAAS,CAAA;IACb,MAAM,QAAQ,GAAG,CAAC,KAAyC,EAAE,EAAE,CAC7D,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAA;IACpC,OAAO;QACL,OAAO,EAAE;YACP,GAAG,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC;gBAClC,EAAE,kBAAkB,EAAE,oBAAoB,EAAE;gBAC9C,CAAC,CAAC,SAAS,CAAC;YACZ,GAAG,CAAC,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,eAAe,CAAC,CAAC;gBAC1D,EAAE,QAAQ,EAAE;gBACd,CAAC,CAAC,SAAS,CAAC;YACZ,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;gBACxB,EAAE,UAAU,EAAE,eAAe,EAAE;gBACjC,CAAC,CAAC,SAAS,CAAC;YACZ,GAAG,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC;gBAC3B,EAAE,WAAW,EAAE,aAAa,EAAE;gBAChC,CAAC,CAAC,SAAS,CAAC;YACZ,GAAG,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC;gBAClC,EAAE,mBAAmB,EAAE,oBAAoB,EAAE;gBAC/C,CAAC,CAAC,SAAS,CAAC;SACb;QACD,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,QAAQ,CAAC;QACjE,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC;KAChC,CAAA;AACH,CAAC,CAAA;AAED,kDAAkD;AAClD,MAAM,WAAW,GAAG,CAAC,UAAkB,EAAE,EAAE;IACzC,MAAM,GAAG,GAAG,GAAG,UAAU,IAAI,CAAA;IAC7B,MAAM,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;IAClD,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,CAAA;IAClB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,GAAG,CAAC,IAAI,CACN,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,SAAS,EAAE,GAAG,CAAC,CAC3D,CAAA;IACH,CAAC;IACD,OAAO,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;AACjC,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,QAAQ,GAAG,CACtB,IAAkB,EAClB,QAAgB,EAChB,aAAa,GAAG,KAAK,EACrB,EAAE;IACF,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;IAC1C,MAAM,OAAO,GAAG,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;IACxD,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;AAClC,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,OAAoB,EAAE,EAAE;IAC3C,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAA;IACzB,MAAM,IAAI,GAAG,YAAY,CAAC,EAAE,GAAG,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAA;IAC/D,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,eAAe,CAAC,CAAA;IAC5D,OAAO,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAA;AACxC,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,OAAoB,EAAE,EAAE;IACjD,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAA;IACzB,MAAM,IAAI,GAAG,YAAY,CAAC,EAAE,GAAG,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAA;IAC9D,MAAM,QAAQ,GAAG,OAAO,CACtB,KAAK,CAAC,WAAW,EACjB,6BAA6B,CAC9B,CAAA;IACD,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IACjD,OAAO,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAA;AACvC,CAAC,CAAA","sourcesContent":["import type { DepID } from '@vltpkg/dep-id'\nimport {\n  defaultRegistry,\n  defaultRegistries,\n  defaultGitHosts,\n  defaultGitHostArchives,\n  defaultScopeRegistries,\n} from '@vltpkg/spec'\nimport type { SpecOptions } from '@vltpkg/spec'\nimport { mkdirSync, writeFileSync } from 'node:fs'\nimport { dirname, resolve } from 'node:path'\nimport type { Edge } from '../edge.ts'\nimport type { Graph } from '../graph.ts'\nimport type { Node } from '../node.ts'\nimport { getFlagNumFromNode } from './types.ts'\nimport type {\n  LockfileData,\n  LockfileEdgeKey,\n  LockfileEdges,\n  LockfileEdgeValue,\n  LockfileNode,\n} from './types.ts'\n\nexport type SaveOptions = SpecOptions & {\n  /**\n   * The graph to be stored in the lockfile.\n   */\n  graph: Graph\n  /**\n   * Should it save manifest data in the lockfile?\n   */\n  saveManifests?: boolean\n}\n\nconst formatNodes = (\n  nodes: Iterable<Node>,\n  saveManifests?: boolean,\n  registry?: string,\n) => {\n  // we do not store importers in the lockfile, though we do store\n  // their edges. when we load, we always read workspaces/main fresh.\n  const arr: Node[] = [...nodes].filter(node => !node.importer)\n  // nodes are sorted in order to have a deterministic result\n  const orderedNodes: Node[] = arr.sort((a, b) =>\n    a.id.localeCompare(b.id, 'en'),\n  )\n\n  const res: Record<DepID, LockfileNode> = {}\n  for (const node of orderedNodes) {\n    const customRegistry =\n      node.resolved && registry && !node.resolved.startsWith(registry)\n    const resolved = customRegistry ? node.resolved : undefined\n    // if it's in a location other than the default, stash that\n    const location =\n      (\n        node.id.startsWith('file') ||\n        node.location.endsWith(\n          '/node_modules/.vlt/' +\n            node.id +\n            '/node_modules/' +\n            node.name,\n        )\n      ) ?\n        undefined\n      : node.location\n\n    const flags = getFlagNumFromNode(node)\n    const lockfileNode: LockfileNode = [flags, node.name]\n\n    if (node.integrity) {\n      lockfileNode[2] = node.integrity\n    }\n\n    if (resolved) {\n      lockfileNode[3] = resolved\n    }\n\n    if (location) {\n      lockfileNode[4] = location\n    }\n\n    if (saveManifests) {\n      lockfileNode[5] = node.manifest\n    }\n\n    res[node.id] = lockfileNode\n  }\n  return res\n}\n\nconst formatEdges = (edges: Set<Edge>): LockfileEdges =>\n  Object.fromEntries(\n    [...edges]\n      .sort(\n        (a, b) =>\n          /* c8 ignore start - nondeterminstic and annoying to test */\n          // sort importers to the top, then alphabetically by\n          // id, type, target\n          Number(b.from.importer) - Number(a.from.importer) ||\n          a.from.id.localeCompare(b.from.id, 'en') ||\n          a.type.localeCompare(b.type, 'en') ||\n          (a.to?.id ?? '').localeCompare(b.to?.id ?? ''),\n        /* c8 ignore stop */\n      )\n      .map((edge): [LockfileEdgeKey, LockfileEdgeValue] => [\n        `${edge.from.id} ${edge.spec.name}`,\n        `${edge.type} ${edge.spec.bareSpec || '*'} ${edge.to?.id ?? 'MISSING'}`,\n      ]),\n  )\n\nconst isRecordStringString = (\n  registries: unknown,\n): registries is Record<string, string> =>\n  !(!registries || typeof registries === 'string')\n\nconst removeDefaultItems = (\n  defaultItems: Record<string, string>,\n  items: Record<string, string>,\n) => {\n  const res: Record<string, string> = {}\n  for (const [key, value] of Object.entries(items)) {\n    if (!defaultItems[key] || defaultItems[key] !== value) {\n      res[key] = value\n    }\n  }\n  return res\n}\n\nexport const lockfileData = ({\n  graph,\n  'git-hosts': gitHosts,\n  'git-host-archives': gitHostArchives,\n  registry,\n  registries,\n  saveManifests,\n  'scope-registries': scopeRegistries,\n}: SaveOptions): LockfileData => {\n  const cleanGitHosts =\n    isRecordStringString(gitHosts) ?\n      removeDefaultItems(defaultGitHosts, gitHosts)\n    : undefined\n  const cleanGitHostArchives =\n    isRecordStringString(gitHostArchives) ?\n      removeDefaultItems(defaultGitHostArchives, gitHostArchives)\n    : undefined\n  const cleanRegistries =\n    isRecordStringString(registries) ?\n      removeDefaultItems(defaultRegistries, registries)\n    : undefined\n  const cleanScopeRegistries =\n    isRecordStringString(scopeRegistries) ?\n      removeDefaultItems(defaultScopeRegistries, scopeRegistries)\n    : undefined\n  const hasItems = (clean: Record<string, string> | undefined) =>\n    clean && Object.keys(clean).length\n  return {\n    options: {\n      ...(hasItems(cleanScopeRegistries) ?\n        { 'scope-registries': cleanScopeRegistries }\n      : undefined),\n      ...(registry !== undefined && registry !== defaultRegistry ?\n        { registry }\n      : undefined),\n      ...(hasItems(registries) ?\n        { registries: cleanRegistries }\n      : undefined),\n      ...(hasItems(cleanGitHosts) ?\n        { 'git-hosts': cleanGitHosts }\n      : undefined),\n      ...(hasItems(cleanGitHostArchives) ?\n        { 'git-host-archives': cleanGitHostArchives }\n      : undefined),\n    },\n    nodes: formatNodes(graph.nodes.values(), saveManifests, registry),\n    edges: formatEdges(graph.edges),\n  }\n}\n\n// renders each node / edge as a single line entry\nconst extraFormat = (jsonString: string) => {\n  const str = `${jsonString}\\n`\n  const [init, ...parts] = str.split('  \"nodes\": {')\n  const res = [init]\n  for (const part of parts) {\n    res.push(\n      part.replaceAll('\\n      ', '').replaceAll('\\n    ]', ']'),\n    )\n  }\n  return res.join('  \"nodes\": {')\n}\n\nexport const saveData = (\n  data: LockfileData,\n  fileName: string,\n  saveManifests = false,\n) => {\n  const json = JSON.stringify(data, null, 2)\n  const content = saveManifests ? json : extraFormat(json)\n  writeFileSync(fileName, content)\n}\n\nexport const save = (options: SaveOptions) => {\n  const { graph } = options\n  const data = lockfileData({ ...options, saveManifests: false })\n  const fileName = resolve(graph.projectRoot, 'vlt-lock.json')\n  return saveData(data, fileName, false)\n}\n\nexport const saveHidden = (options: SaveOptions) => {\n  const { graph } = options\n  const data = lockfileData({ ...options, saveManifests: true })\n  const fileName = resolve(\n    graph.projectRoot,\n    'node_modules/.vlt-lock.json',\n  )\n  mkdirSync(dirname(fileName), { recursive: true })\n  return saveData(data, fileName, true)\n}\n"]}
+{"version":3,"file":"save.js","sourceRoot":"","sources":["../../../src/lockfile/save.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,+BAA+B,EAC/B,oBAAoB,GACrB,MAAM,eAAe,CAAA;AACtB,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EACjB,eAAe,EACf,sBAAsB,GACvB,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAClD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAC5C,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AAetE,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAyB3C,MAAM,WAAW,GAAG,CAClB,KAAqB,EACrB,aAAuB,EACvB,aAAuB,EACvB,QAAiB,EACjB,sBAAgC,EAChC,EAAE;IACF,gEAAgE;IAChE,mEAAmE;IACnE,MAAM,GAAG,GAAW,CAAC,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC7D,2DAA2D;IAC3D,MAAM,YAAY,GAAW,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAC7C,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,CAC/B,CAAA;IAED,MAAM,GAAG,GAAgC,EAAE,CAAA;IAC3C,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QAChC,MAAM,cAAc,GAClB,IAAI,CAAC,QAAQ,IAAI,QAAQ,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;QAClE,MAAM,QAAQ,GAAG,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAA;QAC3D,2DAA2D;QAC3D,MAAM,QAAQ,GACZ,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;YAC/C,SAAS;YACX,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAA;QAEjB,MAAM,KAAK,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAA;QACtC,MAAM,YAAY,GAAiB,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;QAErD,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAA;QAClC,CAAC;QAED,uCAAuC;QACvC,uCAAuC;QACvC,IAAI,QAAQ,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9C,YAAY,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAA;QAC5B,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YACb,YAAY,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAA;QAC5B,CAAC;QAED,IAAI,aAAa,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnC,YAAY,CAAC,CAAC,CAAC,GAAG,+BAA+B,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YAEhE,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACtC,YAAY,CAAC,CAAC,CAAC,GAAG,+BAA+B,CAC/C,IAAI,CAAC,WAAW,CACjB,CAAA;YACH,CAAC;QACH,CAAC;QAED,oEAAoE;QACpE,IAAI,sBAAsB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC7C,MAAM,KAAK,CAAC,6BAA6B,IAAI,CAAC,EAAE,GAAG,CAAC,CAAA;QACtD,CAAC;QAED,mEAAmE;QACnE,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnC,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAA4B,CAAA;QACrD,CAAC;QAED,6BAA6B;QAC7B,IAAI,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;YAC/C,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAA;QAC7B,CAAC;QAED,qCAAqC;QACrC,IAAI,aAAa,EAAE,CAAC;YAClB,MAAM,UAAU,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAA;YAC9C,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;gBAC7B,YAAY,CAAC,CAAC,CAAC,GAAG,UAAU,CAAA;YAC9B,CAAC;QACH,CAAC;QAED,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,YAAY,CAAA;IAC7B,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED,MAAM,WAAW,GAAG,CAAC,KAAgB,EAAiB,EAAE,CACtD,MAAM,CAAC,WAAW,CAChB,CAAC,GAAG,KAAK,CAAC;KACP,IAAI,CACH,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;AACP,4DAA4D;AAC5D,oDAAoD;AACpD,mBAAmB;AACnB,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACjD,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC;IACxC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC;IAClC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAEjD;KACA,GAAG,CAAC,CAAC,IAAI,EAAwC,EAAE,CAAC;IACnD,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;IACnC,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,GAAG,IAAI,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,SAAS,EAAE;CACxE,CAAC,CACL,CAAA;AAEH,MAAM,kBAAkB,GAAG,CACzB,YAAoC,EACpC,KAA6B,EAC7B,EAAE;IACF,MAAM,GAAG,GAA2B,EAAE,CAAA;IACtC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,GAAG,CAAC,KAAK,KAAK,EAAE,CAAC;YACtD,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;QAClB,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,EAC3B,KAAK,EACL,OAAO,EACP,QAAQ,EACR,WAAW,EAAE,QAAQ,EACrB,mBAAmB,EAAE,eAAe,EACpC,SAAS,EACT,QAAQ,EACR,UAAU,EACV,aAAa,EACb,aAAa,EACb,kBAAkB,EAAE,eAAe,EACnC,gBAAgB,EAAE,aAAa,EAC/B,sBAAsB,GACV,EAAgB,EAAE;IAC9B,MAAM,aAAa,GACjB,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC9B,kBAAkB,CAAC,eAAe,EAAE,QAAQ,CAAC;QAC/C,CAAC,CAAC,SAAS,CAAA;IACb,MAAM,oBAAoB,GACxB,oBAAoB,CAAC,eAAe,CAAC,CAAC,CAAC;QACrC,kBAAkB,CAAC,sBAAsB,EAAE,eAAe,CAAC;QAC7D,CAAC,CAAC,SAAS,CAAA;IACb,MAAM,cAAc,GAClB,SAAS,IAAI,oBAAoB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QACnD,SAAS,CAAC,MAAM;QAClB,CAAC,CAAC,SAAS,CAAA;IACb,MAAM,eAAe,GACnB,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC;QAChC,kBAAkB,CAAC,iBAAiB,EAAE,UAAU,CAAC;QACnD,CAAC,CAAC,SAAS,CAAA;IACb,MAAM,oBAAoB,GACxB,oBAAoB,CAAC,eAAe,CAAC,CAAC,CAAC;QACrC,kBAAkB,CAAC,sBAAsB,EAAE,eAAe,CAAC;QAC7D,CAAC,CAAC,SAAS,CAAA;IACb,MAAM,kBAAkB,GACtB,oBAAoB,CAAC,aAAa,CAAC,CAAC,CAAC;QACnC,kBAAkB,CAAC,oBAAoB,EAAE,aAAa,CAAC;QACzD,CAAC,CAAC,SAAS,CAAA;IACb,MAAM,QAAQ,GAAG,CAAC,KAA0C,EAAE,EAAE,CAC9D,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAA;IACpC,OAAO;QACL,eAAe,EAAE,CAAC;QAClB,OAAO,EAAE;YACP,GAAG,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC;gBAC5B,EAAE,SAAS,EAAE,cAAc,EAAE;gBAC/B,CAAC,CAAC,EAAE,CAAC;YACL,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACzC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3C,GAAG,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC;gBAClC,EAAE,kBAAkB,EAAE,oBAAoB,EAAE;gBAC9C,CAAC,CAAC,SAAS,CAAC;YACZ,GAAG,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC;gBAChC,EAAE,gBAAgB,EAAE,kBAAkB,EAAE;gBAC1C,CAAC,CAAC,SAAS,CAAC;YACZ,GAAG,CAAC,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,eAAe,CAAC,CAAC;gBAC1D,EAAE,QAAQ,EAAE;gBACd,CAAC,CAAC,SAAS,CAAC;YACZ,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;gBACxB,EAAE,UAAU,EAAE,eAAe,EAAE;gBACjC,CAAC,CAAC,SAAS,CAAC;YACZ,GAAG,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC;gBAC3B,EAAE,WAAW,EAAE,aAAa,EAAE;gBAChC,CAAC,CAAC,SAAS,CAAC;YACZ,GAAG,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC;gBAClC,EAAE,mBAAmB,EAAE,oBAAoB,EAAE;gBAC/C,CAAC,CAAC,SAAS,CAAC;SACb;QACD,KAAK,EAAE,WAAW,CAChB,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,EACpB,aAAa,EACb,aAAa,EACb,QAAQ,EACR,sBAAsB,CACvB;QACD,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC;KAChC,CAAA;AACH,CAAC,CAAA;AAED,kDAAkD;AAClD,MAAM,WAAW,GAAG,CAAC,UAAkB,EAAE,EAAE;IACzC,MAAM,GAAG,GAAG,GAAG,UAAU,IAAI,CAAA;IAC7B,MAAM,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;IAClD,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,CAAA;IAClB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,GAAG,CAAC,IAAI,CACN,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,SAAS,EAAE,GAAG,CAAC,CAC3D,CAAA;IACH,CAAC;IACD,OAAO,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;AACjC,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,QAAQ,GAAG,CACtB,IAAkB,EAClB,QAAgB,EAChB,aAAa,GAAG,KAAK,EACf,EAAE;IACR,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;IAC1C,MAAM,OAAO,GAAG,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;IACxD,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;AAClC,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,IAAI,GAAG,CAClB,OAA2C,EACrC,EAAE;IACR,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAA;IACzB,MAAM,IAAI,GAAG,YAAY,CAAC,EAAE,GAAG,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAA;IAC/D,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,eAAe,CAAC,CAAA;IAC5D,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAA;AACjC,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,OAA6D,EACvD,EAAE;IACR,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAA;IACzB,IAAI,IAA8B,CAAA;IAElC,IAAI,CAAC;QACH,IAAI,GAAG,YAAY,CAAC;YAClB,GAAG,OAAO;YACV,aAAa,EAAE,IAAI;YACnB,aAAa,EAAE,IAAI;YACnB,sBAAsB,EAAE,IAAI;SAC7B,CAAC,CAAA;IACJ,CAAC;IAAC,MAAM,CAAC,CAAA,CAAC;IAEV,IAAI,CAAC,IAAI;QAAE,OAAM;IAEjB,MAAM,QAAQ,GAAG,OAAO,CACtB,KAAK,CAAC,WAAW,EACjB,6BAA6B,CAC9B,CAAA;IACD,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IACjD,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAA;AAChC,CAAC,CAAA","sourcesContent":["import {\n  expandNormalizedManifestSymbols,\n  isRecordStringString,\n} from '@vltpkg/types'\nimport {\n  defaultGitHostArchives,\n  defaultGitHosts,\n  defaultJsrRegistries,\n  defaultRegistries,\n  defaultRegistry,\n  defaultScopeRegistries,\n} from '@vltpkg/spec'\nimport { mkdirSync, writeFileSync } from 'node:fs'\nimport { dirname, resolve } from 'node:path'\nimport { getFlagNumFromNode, getBuildStateFromNode } from './types.ts'\nimport type { DepID } from '@vltpkg/dep-id'\nimport type { SpecOptions } from '@vltpkg/spec'\nimport type { Edge } from '../edge.ts'\nimport type { Graph } from '../graph.ts'\nimport type { Node } from '../node.ts'\nimport type {\n  LockfileData,\n  LockfileEdgeKey,\n  LockfileEdges,\n  LockfileEdgeValue,\n  LockfileNode,\n  LockfilePlatform,\n} from './types.ts'\nimport type { GraphModifier } from '../modifiers.ts'\nimport { error } from '@vltpkg/error-cause'\n\nexport type SaveOptions = SpecOptions & {\n  /**\n   * The graph to be stored in the lockfile.\n   */\n  graph: Graph\n  /**\n   * The graph modifiers helper object.\n   */\n  modifiers?: GraphModifier\n  /**\n   * Should it save manifest data in the lockfile?\n   */\n  saveManifests?: boolean\n  /**\n   * Should it save build state data in the lockfile?\n   */\n  saveBuildData?: boolean\n  /**\n   * Should it throw an error if a manifest is missing?\n   */\n  throwOnMissingManifest?: boolean\n}\n\nconst formatNodes = (\n  nodes: Iterable<Node>,\n  saveManifests?: boolean,\n  saveBuildData?: boolean,\n  registry?: string,\n  throwOnMissingManifest?: boolean,\n) => {\n  // we do not store importers in the lockfile, though we do store\n  // their edges. when we load, we always read workspaces/main fresh.\n  const arr: Node[] = [...nodes].filter(node => !node.importer)\n  // nodes are sorted in order to have a deterministic result\n  const orderedNodes: Node[] = arr.sort((a, b) =>\n    a.id.localeCompare(b.id, 'en'),\n  )\n\n  const res: Record<DepID, LockfileNode> = {}\n  for (const node of orderedNodes) {\n    const customRegistry =\n      node.resolved && registry && !node.resolved.startsWith(registry)\n    const resolved = customRegistry ? node.resolved : undefined\n    // if it's in a location other than the default, stash that\n    const location =\n      node.id.startsWith('file') || node.inVltStore() ?\n        undefined\n      : node.location\n\n    const flags = getFlagNumFromNode(node)\n    const lockfileNode: LockfileNode = [flags, node.name]\n\n    if (node.integrity) {\n      lockfileNode[2] = node.integrity\n    }\n\n    // skip resolved for remote nodes since\n    // these are already part of the dep id\n    if (resolved && !node.id.startsWith('remote')) {\n      lockfileNode[3] = resolved\n    }\n\n    if (location) {\n      lockfileNode[4] = location\n    }\n\n    if (saveManifests && node.manifest) {\n      lockfileNode[5] = expandNormalizedManifestSymbols(node.manifest)\n\n      if (node.confused && node.rawManifest) {\n        lockfileNode[6] = expandNormalizedManifestSymbols(\n          node.rawManifest,\n        )\n      }\n    }\n\n    // Throw an error if a manifest is missing and the option is enabled\n    if (throwOnMissingManifest && !node.manifest) {\n      throw error(`Missing manifest for node ${node.id}.`)\n    }\n\n    // Always save platform data for optional dependencies if available\n    if (node.optional && node.platform) {\n      lockfileNode[7] = node.platform as LockfilePlatform\n    }\n\n    // Save bin data if available\n    if (node.bins && Object.keys(node.bins).length) {\n      lockfileNode[8] = node.bins\n    }\n\n    // Save build state data if requested\n    if (saveBuildData) {\n      const buildState = getBuildStateFromNode(node)\n      if (buildState !== undefined) {\n        lockfileNode[9] = buildState\n      }\n    }\n\n    res[node.id] = lockfileNode\n  }\n  return res\n}\n\nconst formatEdges = (edges: Set<Edge>): LockfileEdges =>\n  Object.fromEntries(\n    [...edges]\n      .sort(\n        (a, b) =>\n          /* c8 ignore start - nondeterminstic and annoying to test */\n          // sort importers to the top, then alphabetically by\n          // id, type, target\n          Number(b.from.importer) - Number(a.from.importer) ||\n          a.from.id.localeCompare(b.from.id, 'en') ||\n          a.type.localeCompare(b.type, 'en') ||\n          (a.to?.id ?? '').localeCompare(b.to?.id ?? ''),\n        /* c8 ignore stop */\n      )\n      .map((edge): [LockfileEdgeKey, LockfileEdgeValue] => [\n        `${edge.from.id} ${edge.spec.name}`,\n        `${edge.type} ${edge.spec.bareSpec || '*'} ${edge.to?.id ?? 'MISSING'}`,\n      ]),\n  )\n\nconst removeDefaultItems = (\n  defaultItems: Record<string, string>,\n  items: Record<string, string>,\n) => {\n  const res: Record<string, string> = {}\n  for (const [key, value] of Object.entries(items)) {\n    if (!defaultItems[key] || defaultItems[key] !== value) {\n      res[key] = value\n    }\n  }\n  return res\n}\n\nexport const lockfileData = ({\n  graph,\n  catalog,\n  catalogs,\n  'git-hosts': gitHosts,\n  'git-host-archives': gitHostArchives,\n  modifiers,\n  registry,\n  registries,\n  saveManifests,\n  saveBuildData,\n  'scope-registries': scopeRegistries,\n  'jsr-registries': jsrRegistries,\n  throwOnMissingManifest,\n}: SaveOptions): LockfileData => {\n  const cleanGitHosts =\n    isRecordStringString(gitHosts) ?\n      removeDefaultItems(defaultGitHosts, gitHosts)\n    : undefined\n  const cleanGitHostArchives =\n    isRecordStringString(gitHostArchives) ?\n      removeDefaultItems(defaultGitHostArchives, gitHostArchives)\n    : undefined\n  const cleanModifiers =\n    modifiers && isRecordStringString(modifiers.config) ?\n      modifiers.config\n    : undefined\n  const cleanRegistries =\n    isRecordStringString(registries) ?\n      removeDefaultItems(defaultRegistries, registries)\n    : undefined\n  const cleanScopeRegistries =\n    isRecordStringString(scopeRegistries) ?\n      removeDefaultItems(defaultScopeRegistries, scopeRegistries)\n    : undefined\n  const cleanJsrRegistries =\n    isRecordStringString(jsrRegistries) ?\n      removeDefaultItems(defaultJsrRegistries, jsrRegistries)\n    : undefined\n  const hasItems = (clean: Record<string, unknown> | undefined) =>\n    clean && Object.keys(clean).length\n  return {\n    lockfileVersion: 0,\n    options: {\n      ...(hasItems(cleanModifiers) ?\n        { modifiers: cleanModifiers }\n      : {}),\n      ...(hasItems(catalog) ? { catalog } : {}),\n      ...(hasItems(catalogs) ? { catalogs } : {}),\n      ...(hasItems(cleanScopeRegistries) ?\n        { 'scope-registries': cleanScopeRegistries }\n      : undefined),\n      ...(hasItems(cleanJsrRegistries) ?\n        { 'jsr-registries': cleanJsrRegistries }\n      : undefined),\n      ...(registry !== undefined && registry !== defaultRegistry ?\n        { registry }\n      : undefined),\n      ...(hasItems(registries) ?\n        { registries: cleanRegistries }\n      : undefined),\n      ...(hasItems(cleanGitHosts) ?\n        { 'git-hosts': cleanGitHosts }\n      : undefined),\n      ...(hasItems(cleanGitHostArchives) ?\n        { 'git-host-archives': cleanGitHostArchives }\n      : undefined),\n    },\n    nodes: formatNodes(\n      graph.nodes.values(),\n      saveManifests,\n      saveBuildData,\n      registry,\n      throwOnMissingManifest,\n    ),\n    edges: formatEdges(graph.edges),\n  }\n}\n\n// renders each node / edge as a single line entry\nconst extraFormat = (jsonString: string) => {\n  const str = `${jsonString}\\n`\n  const [init, ...parts] = str.split('  \"nodes\": {')\n  const res = [init]\n  for (const part of parts) {\n    res.push(\n      part.replaceAll('\\n      ', '').replaceAll('\\n    ]', ']'),\n    )\n  }\n  return res.join('  \"nodes\": {')\n}\n\nexport const saveData = (\n  data: LockfileData,\n  fileName: string,\n  saveManifests = false,\n): void => {\n  const json = JSON.stringify(data, null, 2)\n  const content = saveManifests ? json : extraFormat(json)\n  writeFileSync(fileName, content)\n}\n\nexport const save = (\n  options: Omit<SaveOptions, 'saveManifests'>,\n): void => {\n  const { graph } = options\n  const data = lockfileData({ ...options, saveManifests: false })\n  const fileName = resolve(graph.projectRoot, 'vlt-lock.json')\n  saveData(data, fileName, false)\n}\n\nexport const saveHidden = (\n  options: Omit<SaveOptions, 'saveManifests' | 'saveBuildData'>,\n): void => {\n  const { graph } = options\n  let data: LockfileData | undefined\n\n  try {\n    data = lockfileData({\n      ...options,\n      saveManifests: true,\n      saveBuildData: true,\n      throwOnMissingManifest: true,\n    })\n  } catch {}\n\n  if (!data) return\n\n  const fileName = resolve(\n    graph.projectRoot,\n    'node_modules/.vlt-lock.json',\n  )\n  mkdirSync(dirname(fileName), { recursive: true })\n  saveData(data, fileName, true)\n}\n"]}

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

@@ -1,6 +1,14 @@
 import type { DepID } from '@vltpkg/dep-id';
 import type { Spec, SpecOptions } from '@vltpkg/spec';
-import type { Integrity, Manifest, DependencyTypeShort } from '@vltpkg/types';
+import type { Integrity, NormalizedManifest, DependencyTypeShort } from '@vltpkg/types';
+/**
+ * Platform requirements for a lockfile node
+ */
+export type LockfilePlatform = {
+    engines?: Record<string, string>;
+    os?: string[] | string;
+    cpu?: string[] | string;
+};
 /**
  * This is the main type definition for the contents of the
  * `vlt-lock.json` file.
@@ -9,14 +17,17 @@ import type { Integrity, Manifest, DependencyTypeShort } from '@vltpkg/types';
  * a {@link Graph} representing a previous install.
  */
 export type LockfileData = {
-    options: SpecOptions;
+    lockfileVersion: number;
+    options: SpecOptions & {
+        modifiers?: Record<string, string> | undefined;
+    };
     nodes: Record<DepID, LockfileNode>;
     edges: LockfileEdges;
 };
 export declare const getFlagNumFromNode: (node: {
     optional?: boolean;
     dev?: boolean;
-}) => 0 | 1 | 3 | 2;
+}) => 1 | 0 | 2 | 3;
 export declare const getBooleanFlagsFromNum: (flags: LockfileNodeFlags) => {
     dev: boolean;
     optional: boolean;
@@ -29,6 +40,21 @@ export declare const LockfileNodeFlagDevOptional = 3;
  * Bit flags indicating whether a node is optional and/or dev.
  */
 export type LockfileNodeFlags = 0 | 1 | 2 | 3;
+/**
+ * Build state constants for lockfile nodes
+ */
+export declare const BuildStateNone: undefined;
+export declare const BuildStateNeeded = 1;
+export declare const BuildStateBuilt = 2;
+export declare const BuildStateFailed = 3;
+/**
+ * Build state for a node - tracks whether it needs building, has been built, or failed
+ */
+export type LockfileBuildState = undefined | 1 | 2 | 3;
+export declare const getBuildStateFromNode: (node: {
+    buildState?: "none" | "needed" | "built" | "failed";
+}) => LockfileBuildState;
+export declare const getBuildStateFromNum: (state: LockfileBuildState) => "none" | "needed" | "built" | "failed";
 /**
  * Lockfile representation of a node from the install graph.
  */
@@ -38,7 +64,11 @@ export type LockfileNode = [
     integrity?: Integrity | null,
     resolved?: string | null,
     location?: string | null,
-    manifest?: Manifest | null
+    manifest?: NormalizedManifest | null,
+    rawManifest?: NormalizedManifest | null,
+    platform?: LockfilePlatform | null,
+    bins?: Record<string, string> | null,
+    buildState?: LockfileBuildState | null
 ];
 /**
  * Lockfile edges are stored as a record object where the key

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/lockfile/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AACrD,OAAO,KAAK,EACV,SAAS,EACT,QAAQ,EACR,mBAAmB,EACpB,MAAM,eAAe,CAAA;AAGtB;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,WAAW,CAAA;IACpB,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAA;IAClC,KAAK,EAAE,aAAa,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,kBAAkB,SAAU;IACvC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,GAAG,CAAC,EAAE,OAAO,CAAA;CACd,kBAIuB,CAAA;AAExB,eAAO,MAAM,sBAAsB,UAAW,iBAAiB;;;CAG7D,CAAA;AAEF,eAAO,MAAM,oBAAoB,IAAI,CAAA;AACrC,eAAO,MAAM,wBAAwB,IAAI,CAAA;AACzC,eAAO,MAAM,mBAAmB,IAAI,CAAA;AACpC,eAAO,MAAM,2BAA2B,IAAI,CAAA;AAE5C;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;AAE7C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,iBAAiB;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IACpB,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI;IAC5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;IACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;IACxB,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI;CAC3B,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,CAAC,GAAG,EAAE,eAAe,GAAG,iBAAiB,CAAA;CAC1C,CAAA;AAED,4BAA4B;AAC5B,MAAM,MAAM,eAAe,GAAG,GAAG,KAAK,IAAI,MAAM,EAAE,CAAA;AAElD,8BAA8B;AAC9B,MAAM,MAAM,iBAAiB,GAC3B,GAAG,mBAAmB,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,GAAG,SAAS,EAAE,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/lockfile/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AACrD,OAAO,KAAK,EACV,SAAS,EACT,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,eAAe,CAAA;AAGtB;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IACtB,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;CACxB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,eAAe,EAAE,MAAM,CAAA;IACvB,OAAO,EAAE,WAAW,GAAG;QACrB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAA;KAC/C,CAAA;IACD,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAA;IAClC,KAAK,EAAE,aAAa,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,kBAAkB,SAAU;IACvC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,GAAG,CAAC,EAAE,OAAO,CAAA;CACd,kBAIuB,CAAA;AAExB,eAAO,MAAM,sBAAsB,UAAW,iBAAiB;;;CAG7D,CAAA;AAEF,eAAO,MAAM,oBAAoB,IAAI,CAAA;AACrC,eAAO,MAAM,wBAAwB,IAAI,CAAA;AACzC,eAAO,MAAM,mBAAmB,IAAI,CAAA;AACpC,eAAO,MAAM,2BAA2B,IAAI,CAAA;AAE5C;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;AAE7C;;GAEG;AACH,eAAO,MAAM,cAAc,WAAY,CAAA;AACvC,eAAO,MAAM,gBAAgB,IAAI,CAAA;AACjC,eAAO,MAAM,eAAe,IAAI,CAAA;AAChC,eAAO,MAAM,gBAAgB,IAAI,CAAA;AAEjC;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;AAEtD,eAAO,MAAM,qBAAqB,SAAU;IAC1C,UAAU,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;CACpD,KAAG,kBAWH,CAAA;AAED,eAAO,MAAM,oBAAoB,UACxB,kBAAkB,KACxB,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,QAWhC,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,iBAAiB;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IACpB,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI;IAC5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;IACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;IACxB,QAAQ,CAAC,EAAE,kBAAkB,GAAG,IAAI;IACpC,WAAW,CAAC,EAAE,kBAAkB,GAAG,IAAI;IACvC,QAAQ,CAAC,EAAE,gBAAgB,GAAG,IAAI;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI;IACpC,UAAU,CAAC,EAAE,kBAAkB,GAAG,IAAI;CACvC,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,CAAC,GAAG,EAAE,eAAe,GAAG,iBAAiB,CAAA;CAC1C,CAAA;AAED,4BAA4B;AAC5B,MAAM,MAAM,eAAe,GAAG,GAAG,KAAK,IAAI,MAAM,EAAE,CAAA;AAElD,8BAA8B;AAC9B,MAAM,MAAM,iBAAiB,GAC3B,GAAG,mBAAmB,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,GAAG,SAAS,EAAE,CAAA"}

package/dist/esm/lockfile/types.js

@@ -10,4 +10,35 @@ export const LockfileNodeFlagNone = 0;
 export const LockfileNodeFlagOptional = 1;
 export const LockfileNodeFlagDev = 2;
 export const LockfileNodeFlagDevOptional = 3;
+/**
+ * Build state constants for lockfile nodes
+ */
+export const BuildStateNone = undefined;
+export const BuildStateNeeded = 1;
+export const BuildStateBuilt = 2;
+export const BuildStateFailed = 3;
+export const getBuildStateFromNode = (node) => {
+    switch (node.buildState) {
+        case 'needed':
+            return BuildStateNeeded;
+        case 'built':
+            return BuildStateBuilt;
+        case 'failed':
+            return BuildStateFailed;
+        default:
+            return BuildStateNone;
+    }
+};
+export const getBuildStateFromNum = (state) => {
+    switch (state) {
+        case BuildStateNeeded:
+            return 'needed';
+        case BuildStateBuilt:
+            return 'built';
+        case BuildStateFailed:
+            return 'failed';
+        default:
+            return 'none';
+    }
+};
 //# sourceMappingURL=types.js.map

package/dist/esm/lockfile/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/lockfile/types.ts"],"names":[],"mappings":"AAsBA,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,IAGlC,EAAE,EAAE,CACH,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,2BAA2B;IACvD,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,wBAAwB;QAC1C,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,mBAAmB;YAChC,CAAC,CAAC,oBAAoB,CAAA;AAExB,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,KAAwB,EAAE,EAAE,CAAC,CAAC;IACnE,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,mBAAmB,CAAC;IACpC,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,wBAAwB,CAAC;CAC/C,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAA;AACrC,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAA;AACzC,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAA;AACpC,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAA","sourcesContent":["import type { DepID } from '@vltpkg/dep-id'\nimport type { Spec, SpecOptions } from '@vltpkg/spec'\nimport type {\n  Integrity,\n  Manifest,\n  DependencyTypeShort,\n} from '@vltpkg/types'\nimport type { Graph } from '../graph.ts'\n\n/**\n * This is the main type definition for the contents of the\n * `vlt-lock.json` file.\n *\n * The nodes and edges information from the lockfile are used to reconstruct\n * a {@link Graph} representing a previous install.\n */\nexport type LockfileData = {\n  options: SpecOptions\n  nodes: Record<DepID, LockfileNode>\n  edges: LockfileEdges\n}\n\nexport const getFlagNumFromNode = (node: {\n  optional?: boolean\n  dev?: boolean\n}) =>\n  node.optional && node.dev ? LockfileNodeFlagDevOptional\n  : node.optional ? LockfileNodeFlagOptional\n  : node.dev ? LockfileNodeFlagDev\n  : LockfileNodeFlagNone\n\nexport const getBooleanFlagsFromNum = (flags: LockfileNodeFlags) => ({\n  dev: !!(flags & LockfileNodeFlagDev),\n  optional: !!(flags & LockfileNodeFlagOptional),\n})\n\nexport const LockfileNodeFlagNone = 0\nexport const LockfileNodeFlagOptional = 1\nexport const LockfileNodeFlagDev = 2\nexport const LockfileNodeFlagDevOptional = 3\n\n/**\n * Bit flags indicating whether a node is optional and/or dev.\n */\nexport type LockfileNodeFlags = 0 | 1 | 2 | 3\n\n/**\n * Lockfile representation of a node from the install graph.\n */\nexport type LockfileNode = [\n  flags: LockfileNodeFlags,\n  name?: string | null,\n  integrity?: Integrity | null,\n  resolved?: string | null,\n  location?: string | null,\n  manifest?: Manifest | null,\n]\n\n/**\n * Lockfile edges are stored as a record object where the key\n * is `${from.id} ${spec.name}` and the value is\n * `${type} ${spec.bareSpec} ${to.id | 'MISSING'}`\n *\n * Storing them in a record like this means that we are guaranteed to\n * never end up with duplicates, and a standard `JSON.stringify()`\n * will nicely print them out one line per edge.\n */\nexport type LockfileEdges = {\n  [key: LockfileEdgeKey]: LockfileEdgeValue\n}\n\n/** `${from} ${dep name}` */\nexport type LockfileEdgeKey = `${DepID} ${string}`\n\n/** `${type} ${spec} ${to}` */\nexport type LockfileEdgeValue =\n  `${DependencyTypeShort} ${Spec['bareSpec']} ${DepID | 'MISSING'}`\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/lockfile/types.ts"],"names":[],"mappings":"AAkCA,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,IAGlC,EAAE,EAAE,CACH,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,2BAA2B;IACvD,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,wBAAwB;QAC1C,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,mBAAmB;YAChC,CAAC,CAAC,oBAAoB,CAAA;AAExB,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,KAAwB,EAAE,EAAE,CAAC,CAAC;IACnE,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,mBAAmB,CAAC;IACpC,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,wBAAwB,CAAC;CAC/C,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAA;AACrC,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAA;AACzC,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAA;AACpC,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAA;AAO5C;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,SAAS,CAAA;AACvC,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAA;AACjC,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAA;AAChC,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAA;AAOjC,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,IAErC,EAAsB,EAAE;IACvB,QAAQ,IAAI,CAAC,UAAU,EAAE,CAAC;QACxB,KAAK,QAAQ;YACX,OAAO,gBAAgB,CAAA;QACzB,KAAK,OAAO;YACV,OAAO,eAAe,CAAA;QACxB,KAAK,QAAQ;YACX,OAAO,gBAAgB,CAAA;QACzB;YACE,OAAO,cAAc,CAAA;IACzB,CAAC;AACH,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,KAAyB,EACe,EAAE;IAC1C,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,gBAAgB;YACnB,OAAO,QAAQ,CAAA;QACjB,KAAK,eAAe;YAClB,OAAO,OAAO,CAAA;QAChB,KAAK,gBAAgB;YACnB,OAAO,QAAQ,CAAA;QACjB;YACE,OAAO,MAAM,CAAA;IACjB,CAAC;AACH,CAAC,CAAA","sourcesContent":["import type { DepID } from '@vltpkg/dep-id'\nimport type { Spec, SpecOptions } from '@vltpkg/spec'\nimport type {\n  Integrity,\n  NormalizedManifest,\n  DependencyTypeShort,\n} from '@vltpkg/types'\nimport type { Graph } from '../graph.ts'\n\n/**\n * Platform requirements for a lockfile node\n */\nexport type LockfilePlatform = {\n  engines?: Record<string, string>\n  os?: string[] | string\n  cpu?: string[] | string\n}\n\n/**\n * This is the main type definition for the contents of the\n * `vlt-lock.json` file.\n *\n * The nodes and edges information from the lockfile are used to reconstruct\n * a {@link Graph} representing a previous install.\n */\nexport type LockfileData = {\n  lockfileVersion: number\n  options: SpecOptions & {\n    modifiers?: Record<string, string> | undefined\n  }\n  nodes: Record<DepID, LockfileNode>\n  edges: LockfileEdges\n}\n\nexport const getFlagNumFromNode = (node: {\n  optional?: boolean\n  dev?: boolean\n}) =>\n  node.optional && node.dev ? LockfileNodeFlagDevOptional\n  : node.optional ? LockfileNodeFlagOptional\n  : node.dev ? LockfileNodeFlagDev\n  : LockfileNodeFlagNone\n\nexport const getBooleanFlagsFromNum = (flags: LockfileNodeFlags) => ({\n  dev: !!(flags & LockfileNodeFlagDev),\n  optional: !!(flags & LockfileNodeFlagOptional),\n})\n\nexport const LockfileNodeFlagNone = 0\nexport const LockfileNodeFlagOptional = 1\nexport const LockfileNodeFlagDev = 2\nexport const LockfileNodeFlagDevOptional = 3\n\n/**\n * Bit flags indicating whether a node is optional and/or dev.\n */\nexport type LockfileNodeFlags = 0 | 1 | 2 | 3\n\n/**\n * Build state constants for lockfile nodes\n */\nexport const BuildStateNone = undefined\nexport const BuildStateNeeded = 1\nexport const BuildStateBuilt = 2\nexport const BuildStateFailed = 3\n\n/**\n * Build state for a node - tracks whether it needs building, has been built, or failed\n */\nexport type LockfileBuildState = undefined | 1 | 2 | 3\n\nexport const getBuildStateFromNode = (node: {\n  buildState?: 'none' | 'needed' | 'built' | 'failed'\n}): LockfileBuildState => {\n  switch (node.buildState) {\n    case 'needed':\n      return BuildStateNeeded\n    case 'built':\n      return BuildStateBuilt\n    case 'failed':\n      return BuildStateFailed\n    default:\n      return BuildStateNone\n  }\n}\n\nexport const getBuildStateFromNum = (\n  state: LockfileBuildState,\n): 'none' | 'needed' | 'built' | 'failed' => {\n  switch (state) {\n    case BuildStateNeeded:\n      return 'needed'\n    case BuildStateBuilt:\n      return 'built'\n    case BuildStateFailed:\n      return 'failed'\n    default:\n      return 'none'\n  }\n}\n\n/**\n * Lockfile representation of a node from the install graph.\n */\nexport type LockfileNode = [\n  flags: LockfileNodeFlags,\n  name?: string | null,\n  integrity?: Integrity | null,\n  resolved?: string | null,\n  location?: string | null,\n  manifest?: NormalizedManifest | null,\n  rawManifest?: NormalizedManifest | null,\n  platform?: LockfilePlatform | null,\n  bins?: Record<string, string> | null,\n  buildState?: LockfileBuildState | null,\n]\n\n/**\n * Lockfile edges are stored as a record object where the key\n * is `${from.id} ${spec.name}` and the value is\n * `${type} ${spec.bareSpec} ${to.id | 'MISSING'}`\n *\n * Storing them in a record like this means that we are guaranteed to\n * never end up with duplicates, and a standard `JSON.stringify()`\n * will nicely print them out one line per edge.\n */\nexport type LockfileEdges = {\n  [key: LockfileEdgeKey]: LockfileEdgeValue\n}\n\n/** `${from} ${dep name}` */\nexport type LockfileEdgeKey = `${DepID} ${string}`\n\n/** `${type} ${spec} ${to}` */\nexport type LockfileEdgeValue =\n  `${DependencyTypeShort} ${Spec['bareSpec']} ${DepID | 'MISSING'}`\n"]}

package/dist/esm/modifiers.d.ts

@@ -0,0 +1,189 @@
+import { Spec } from '@vltpkg/spec';
+import type { ModifierBreadcrumb, ModifierInteractiveBreadcrumb } from '@vltpkg/dss-breadcrumb';
+import type { SpecOptions } from '@vltpkg/spec';
+import type { NormalizedManifest } from '@vltpkg/types';
+import type { Edge } from './edge.ts';
+import type { Node } from './node.ts';
+import type { Dependency } from './dependencies.ts';
+/**
+ * Loaded modifiers configuration as described in the `vlt.json` file.
+ */
+export type GraphModifierLoadedConfig = {
+    modifiers: GraphModifierConfigObject;
+};
+/**
+ * Type definition for the modifiers configuration object
+ */
+export type GraphModifierConfigObject = Record<string, string>;
+/**
+ * Info needed to define a graph modifier.
+ */
+export type BaseModifierEntry = {
+    type: 'edge' | 'node';
+    query: string;
+    breadcrumb: ModifierBreadcrumb;
+    value: string | NormalizedManifest;
+    refs: Set<{
+        name: string;
+        from: Node;
+    }>;
+};
+/**
+ * Extra info to define specifically a graph edge modifier.
+ */
+export type EdgeModifierEntry = BaseModifierEntry & {
+    type: 'edge';
+    spec: Spec;
+    value: string;
+};
+/**
+ * Extra info to define the graph node modifier.
+ */
+export type NodeModifierEntry = BaseModifierEntry & {
+    type: 'node';
+    manifest: NormalizedManifest;
+};
+/**
+ * A graph modifier entry, which can be either an edge or a node modifier.
+ */
+export type ModifierEntry = EdgeModifierEntry | NodeModifierEntry;
+/**
+ * An object to track modifiers that have matched an initial part of the
+ * breadcrumb. It holds pointers to both nodes and edges matched in the
+ * current traversed graph on top of the modifier info and the breadcrumb
+ * state that is used to track the current state of the parsing.
+ */
+export type ModifierActiveEntry = {
+    /**
+     * The modifier this active entry is working with.
+     */
+    modifier: ModifierEntry;
+    /**
+     * The breadcrumb that is used to track the current state of the parsing.
+     */
+    interactiveBreadcrumb: ModifierInteractiveBreadcrumb;
+    /**
+     * The first node to be affected by this modifier.
+     */
+    originalFrom: Node;
+    /**
+     * The original edge that is being replaced with this entry.
+     */
+    originalEdge?: Edge;
+    /**
+     * The modified edge that is being used to replace the original edge.
+     */
+    modifiedEdge?: Edge;
+};
+/**
+ * Class representing loaded modifiers configuration for a project.
+ *
+ * Instances of this class can be used as a helper to modify the graph
+ * during the graph build ideal traversal time.
+ *
+ * ```
+ * const modifier = new GraphModifier(options)
+ * modifier.load(options)
+ * ```
+ *
+ * The `tryImporter` method can be used to register the initial importer
+ * node along with any modifier that includes an importer selector, e.g:
+ * `modifier.tryImporter(graph.mainImporter)`
+ *
+ * When traversing the graph, use the `tryNewDependency` method to check
+ * if a given dependency spec to the current traversed node has matching
+ * registered modifiers, e.g:
+ * `const entries = modifier.tryNewDependency(fromNode, depSpec)`
+ *
+ * Use `updateActiveEntry` to update a given active modifier entry state
+ * with the current node of the graph being traversed. e.g:
+ * ```
+ * for (const entry of entries)
+ *   modifier.updateActiveEntry(fromNode, entry)
+ * ```
+ */
+export declare class GraphModifier {
+    #private;
+    /**
+     * A set of currently active modifiers, which are being parsed.
+     */
+    activeModifiers: Set<ModifierActiveEntry>;
+    /** A set of all modifier string values loaded from vlt.json */
+    modifierNames: Set<string>;
+    constructor(options: SpecOptions);
+    /**
+     * Load the modifiers definitions from vlt.json,
+     * converting the result into a GraphModifierConfigObject
+     */
+    get config(): GraphModifierConfigObject;
+    /**
+     * Loads the modifiers defined in `vlt.json` into memory.
+     */
+    load(options: SpecOptions): void;
+    /**
+     * Try matching the provided node against the top-level selectors. In case
+     * a match is found it will also register the active entry modifier and
+     * update the active entry to the current importer node.
+     */
+    tryImporter(importer: Node): void;
+    /**
+     * Try matching the provided node and spec to the current
+     * active parsing modifier entries along with possible starting-level
+     * modifiers.
+     *
+     * Any entries in which the breachcrumb have already reached its last
+     * element will be prioritized, along with checking for specificity,
+     * the complete entry with the highest specificity will be returned or just
+     * the entry with the highest specificity if no complete entry is found.
+     * Returns `undefined` if no matching entry is found.
+     *
+     * This method works with the assumption that it's going to be called
+     * during a graph traversal, such that any ascendent has been checked
+     * and the active modifier entry state has been updated in the previous
+     * iteration.
+     */
+    tryNewDependency(from: Node, spec: Spec): ModifierActiveEntry | undefined;
+    /**
+     * Returns the set of {@link ModifierActiveEntry} instances that matches
+     * the provided {@link Dependency} specs for a given node.
+     *
+     * This method is mostly a helper to {@link GraphModifier.tryNewDependency}
+     * that handles the registered modifiers traversal lookup.
+     */
+    tryDependencies(from: Node, dependencies: Dependency[] | Edge[]): Map<string, ModifierActiveEntry>;
+    /**
+     * Updates an active entry state keeping track of items in the multi-level
+     * active entries map. If the current breadcrumb state shows there's no more
+     * items left, then we deregister the modifier.
+     */
+    updateActiveEntry(from: Node, active: ModifierActiveEntry): void;
+    /**
+     * Creates a new active modifier.
+     */
+    newModifier(from: Node, modifier: ModifierEntry): ModifierActiveEntry;
+    /**
+     * Removes a previously registered modifier from the active entries.
+     */
+    deregisterModifier(modifier: ModifierEntry): void;
+    /**
+     * Operates in previously registered nodes and edges in order to put
+     * back in place any of the original edges that were referenced to in
+     * active (ongoing) breadcrumb parsing entries that were never completed.
+     *
+     * This method can be used to easily rollback any pending operations
+     * once the graph traversal is done.
+     */
+    rollbackActiveEntries(): void;
+    /**
+     * Convenience method to instantiate and load in one call.
+     * Returns undefined if the project does not have a vlt.json file,
+     * otherwise returns the loaded Modifiers instance.
+     */
+    static maybeLoad(options: SpecOptions): GraphModifier | undefined;
+    /**
+     * Convenience method to instantiate and load in one call.
+     * Throws if called on a directory that does not have a vlt.json file.
+     */
+    static load(options: SpecOptions): GraphModifier;
+}
+//# sourceMappingURL=modifiers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"modifiers.d.ts","sourceRoot":"","sources":["../../src/modifiers.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAOnC,OAAO,KAAK,EACV,kBAAkB,EAClB,6BAA6B,EAC9B,MAAM,wBAAwB,CAAA;AAC/B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC/C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AACvD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAEnD;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,SAAS,EAAE,yBAAyB,CAAA;CACrC,CAAA;AAED;;GAEG;AAEH,MAAM,MAAM,yBAAyB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAE9D;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;IACrB,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,kBAAkB,CAAA;IAC9B,KAAK,EAAE,MAAM,GAAG,kBAAkB,CAAA;IAClC,IAAI,EAAE,GAAG,CAAC;QACR,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,EAAE,IAAI,CAAA;KACX,CAAC,CAAA;CACH,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,iBAAiB,GAAG;IAClD,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,IAAI,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,iBAAiB,GAAG;IAClD,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,kBAAkB,CAAA;CAC7B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,GAAG,iBAAiB,CAAA;AAEjE;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAA;IACvB;;OAEG;IACH,qBAAqB,EAAE,6BAA6B,CAAA;IACpD;;OAEG;IACH,YAAY,EAAE,IAAI,CAAA;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,CAAA;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,CAAA;CACpB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,aAAa;;IA2BxB;;OAEG;IACH,eAAe,2BAAiC;IAChD,+DAA+D;IAC/D,aAAa,cAAoB;gBAErB,OAAO,EAAE,WAAW;IAIhC;;;OAGG;IACH,IAAI,MAAM,IAAI,yBAAyB,CAItC;IAED;;OAEG;IACH,IAAI,CAAC,OAAO,EAAE,WAAW;IAkDzB;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,IAAI;IAwB1B;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CACd,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,IAAI,GACT,mBAAmB,GAAG,SAAS;IAiElC;;;;;;OAMG;IACH,eAAe,CACb,IAAI,EAAE,IAAI,EACV,YAAY,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAClC,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAWnC;;;;OAIG;IACH,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,mBAAmB,GAAG,IAAI;IA6BhE;;OAEG;IACH,WAAW,CACT,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE,aAAa,GACtB,mBAAmB;IAQtB;;OAEG;IACH,kBAAkB,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAmBjD;;;;;;;OAOG;IACH,qBAAqB,IAAI,IAAI;IAc7B;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW;IAMrC;;;OAGG;IACH,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW;CAGjC"}