@vltpkg/cli-sdk 0.0.0-8 → 1.0.0-rc.1

package/dist/esm/commands/build.d.ts

@@ -0,0 +1,25 @@
+import type { BuildResult } from '@vltpkg/graph';
+import type { CommandFn, CommandUsage } from '../index.ts';
+export declare const views: {
+    readonly human: (result: BuildResult) => string;
+    readonly json: (result: BuildResult) => {
+        success: {
+            id: import("@vltpkg/dep-id").DepID;
+            name: string;
+            version: string | undefined;
+        }[];
+        failure: {
+            id: import("@vltpkg/dep-id").DepID;
+            name: string;
+            version: string | undefined;
+        }[];
+        message: string;
+    };
+};
+export declare const usage: CommandUsage;
+/**
+ * Build command implementation. Runs any required "postinstall"
+ * lifecycle scripts and binary linking.
+ */
+export declare const command: CommandFn<BuildResult>;
+//# sourceMappingURL=build.d.ts.map

package/dist/esm/commands/build.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../../src/commands/build.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAQ,MAAM,eAAe,CAAA;AAGtD,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAI1D,eAAO,MAAM,KAAK;6BACA,WAAW,KAAG,MAAM;4BAqBrB,WAAW;;;;;;;;;;;;;CAqBW,CAAA;AAEvC,eAAO,MAAM,KAAK,EAAE,YAsBhB,CAAA;AAWJ;;;GAGG;AACH,eAAO,MAAM,OAAO,EAAE,SAAS,CAAC,WAAW,CAqC1C,CAAA"}

package/dist/esm/commands/build.js

@@ -0,0 +1,102 @@
+import { build } from '@vltpkg/graph';
+import { error } from '@vltpkg/error-cause';
+import { commandUsage } from "../config/usage.js";
+import { isErrorWithCause } from '@vltpkg/types';
+export const views = {
+    human: (result) => {
+        const successCount = result.success.length;
+        const failureCount = result.failure.length;
+        const messages = [];
+        if (successCount > 0) {
+            messages.push(`🔨 Built ${successCount} package${successCount === 1 ? '' : 's'} successfully.`);
+        }
+        else {
+            messages.push('📦 All packages are already built.');
+        }
+        if (failureCount > 0) {
+            messages.push(`🔎 ${failureCount} optional package${ /* c8 ignore next */failureCount === 1 ? '' : 's'} failed to build.`);
+        }
+        return messages.join('\n');
+    },
+    json: (result) => {
+        const successList = result.success.map(node => ({
+            id: node.id,
+            name: node.name,
+            version: node.version,
+        }));
+        const failureList = result.failure.map(node => ({
+            id: node.id,
+            name: node.name,
+            version: node.version,
+        }));
+        return {
+            success: successList,
+            failure: failureList,
+            message: successList.length > 0 ?
+                `Built ${successList.length} package${successList.length === 1 ? '' : 's'}.`
+                : 'No packages needed building.',
+        };
+    },
+};
+export const usage = () => commandUsage({
+    command: 'build',
+    usage: ['[query]', '[--target=<query>]'],
+    description: `Build the project based on the current dependency graph.
+
+    This command processes the installed packages in node_modules and runs
+    any necessary build steps, such as lifecycle scripts and binary linking.
+    
+    The build process is idempotent and will only perform work that is
+    actually needed based on the current state of the dependency graph.
+    
+    Use --target option or provide a query as a positional argument to filter
+    packages using DSS query language syntax, otherwise it will target
+    all packages with scripts (:scripts) by default.`,
+    options: {
+        target: {
+            value: '<query>',
+            description: 'Query selector to filter packages using DSS syntax.',
+        },
+    },
+});
+const isGraphRunError = (error) => typeof error === 'object' &&
+    error !== null &&
+    'code' in error &&
+    error.code === 'GRAPHRUN_TRAVERSAL' &&
+    'node' in error;
+/**
+ * Build command implementation. Runs any required "postinstall"
+ * lifecycle scripts and binary linking.
+ */
+export const command = async (conf) => {
+    const { options, projectRoot } = conf;
+    try {
+        // Get target from option or first positional, default to all scripts
+        const targetOption = conf.get('target');
+        const targetPositional = conf.positionals[0];
+        const target = targetOption ||
+            targetPositional ||
+            ':scripts:not(:built):not(:malware)';
+        // Run the build process using the graph build function
+        const result = await build({
+            ...options,
+            projectRoot,
+            packageJson: options.packageJson,
+            monorepo: options.monorepo,
+            scurry: options.scurry,
+            target,
+        });
+        return result;
+    }
+    catch (cause) {
+        const graphRunError = isErrorWithCause(cause) && isGraphRunError(cause.cause) ?
+            cause.cause
+            : undefined;
+        if (graphRunError?.code === 'GRAPHRUN_TRAVERSAL') {
+            throw error('Build failed:\n  Failed to build package: ' +
+                `${graphRunError.node.name}@${graphRunError.node.version}`, { cause });
+        }
+        throw error('Build failed', { cause });
+    }
+};
+//# sourceMappingURL=build.js.map

package/dist/esm/commands/build.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build.js","sourceRoot":"","sources":["../../../src/commands/build.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAErC,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAGjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAEhD,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,KAAK,EAAE,CAAC,MAAmB,EAAU,EAAE;QACrC,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAA;QAC1C,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAA;QAC1C,MAAM,QAAQ,GAAa,EAAE,CAAA;QAE7B,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;YACrB,QAAQ,CAAC,IAAI,CACX,YAAY,YAAY,WAAW,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,gBAAgB,CACjF,CAAA;QACH,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAA;QACrD,CAAC;QAED,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;YACrB,QAAQ,CAAC,IAAI,CACX,MAAM,YAAY,oBAAoB,CAAA,oBAAqB,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAC5G,CAAA;QACH,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC5B,CAAC;IACD,IAAI,EAAE,CAAC,MAAmB,EAAE,EAAE;QAC5B,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC9C,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAC,CAAA;QACH,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC9C,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAC,CAAA;QAEH,OAAO;YACL,OAAO,EAAE,WAAW;YACpB,OAAO,EAAE,WAAW;YACpB,OAAO,EACL,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBACtB,SAAS,WAAW,CAAC,MAAM,WAAW,WAAW,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG;gBAC9E,CAAC,CAAC,8BAA8B;SACnC,CAAA;IACH,CAAC;CACoC,CAAA;AAEvC,MAAM,CAAC,MAAM,KAAK,GAAiB,GAAG,EAAE,CACtC,YAAY,CAAC;IACX,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE,CAAC,SAAS,EAAE,oBAAoB,CAAC;IACxC,WAAW,EAAE;;;;;;;;;;qDAUoC;IACjD,OAAO,EAAE;QACP,MAAM,EAAE;YACN,KAAK,EAAE,SAAS;YAChB,WAAW,EACT,qDAAqD;SACxD;KACF;CACF,CAAC,CAAA;AAEJ,MAAM,eAAe,GAAG,CACtB,KAAc,EACiC,EAAE,CACjD,OAAO,KAAK,KAAK,QAAQ;IACzB,KAAK,KAAK,IAAI;IACd,MAAM,IAAI,KAAK;IACf,KAAK,CAAC,IAAI,KAAK,oBAAoB;IACnC,MAAM,IAAI,KAAK,CAAA;AAEjB;;;GAGG;AACH,MAAM,CAAC,MAAM,OAAO,GAA2B,KAAK,EAAC,IAAI,EAAC,EAAE;IAC1D,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI,CAAA;IAErC,IAAI,CAAC;QACH,qEAAqE;QACrE,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACvC,MAAM,gBAAgB,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;QAC5C,MAAM,MAAM,GACV,YAAY;YACZ,gBAAgB;YAChB,oCAAoC,CAAA;QAEtC,uDAAuD;QACvD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC;YACzB,GAAG,OAAO;YACV,WAAW;YACX,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM;SACP,CAAC,CAAA;QAEF,OAAO,MAAM,CAAA;IACf,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,aAAa,GACjB,gBAAgB,CAAC,KAAK,CAAC,IAAI,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YACvD,KAAK,CAAC,KAAK;YACb,CAAC,CAAC,SAAS,CAAA;QACb,IAAI,aAAa,EAAE,IAAI,KAAK,oBAAoB,EAAE,CAAC;YACjD,MAAM,KAAK,CACT,4CAA4C;gBAC1C,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,IAAI,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,EAC5D,EAAE,KAAK,EAAE,CACV,CAAA;QACH,CAAC;QACD,MAAM,KAAK,CAAC,cAAc,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;IACxC,CAAC;AACH,CAAC,CAAA","sourcesContent":["import { build } from '@vltpkg/graph'\nimport type { BuildResult, Node } from '@vltpkg/graph'\nimport { error } from '@vltpkg/error-cause'\nimport { commandUsage } from '../config/usage.ts'\nimport type { CommandFn, CommandUsage } from '../index.ts'\nimport type { Views } from '../view.ts'\nimport { isErrorWithCause } from '@vltpkg/types'\n\nexport const views = {\n  human: (result: BuildResult): string => {\n    const successCount = result.success.length\n    const failureCount = result.failure.length\n    const messages: string[] = []\n\n    if (successCount > 0) {\n      messages.push(\n        `🔨 Built ${successCount} package${successCount === 1 ? '' : 's'} successfully.`,\n      )\n    } else {\n      messages.push('📦 All packages are already built.')\n    }\n\n    if (failureCount > 0) {\n      messages.push(\n        `🔎 ${failureCount} optional package${/* c8 ignore next */ failureCount === 1 ? '' : 's'} failed to build.`,\n      )\n    }\n\n    return messages.join('\\n')\n  },\n  json: (result: BuildResult) => {\n    const successList = result.success.map(node => ({\n      id: node.id,\n      name: node.name,\n      version: node.version,\n    }))\n    const failureList = result.failure.map(node => ({\n      id: node.id,\n      name: node.name,\n      version: node.version,\n    }))\n\n    return {\n      success: successList,\n      failure: failureList,\n      message:\n        successList.length > 0 ?\n          `Built ${successList.length} package${successList.length === 1 ? '' : 's'}.`\n        : 'No packages needed building.',\n    }\n  },\n} as const satisfies Views<BuildResult>\n\nexport const usage: CommandUsage = () =>\n  commandUsage({\n    command: 'build',\n    usage: ['[query]', '[--target=<query>]'],\n    description: `Build the project based on the current dependency graph.\n\n    This command processes the installed packages in node_modules and runs\n    any necessary build steps, such as lifecycle scripts and binary linking.\n    \n    The build process is idempotent and will only perform work that is\n    actually needed based on the current state of the dependency graph.\n    \n    Use --target option or provide a query as a positional argument to filter\n    packages using DSS query language syntax, otherwise it will target\n    all packages with scripts (:scripts) by default.`,\n    options: {\n      target: {\n        value: '<query>',\n        description:\n          'Query selector to filter packages using DSS syntax.',\n      },\n    },\n  })\n\nconst isGraphRunError = (\n  error: unknown,\n): error is Error & { code: string; node: Node } =>\n  typeof error === 'object' &&\n  error !== null &&\n  'code' in error &&\n  error.code === 'GRAPHRUN_TRAVERSAL' &&\n  'node' in error\n\n/**\n * Build command implementation. Runs any required \"postinstall\"\n * lifecycle scripts and binary linking.\n */\nexport const command: CommandFn<BuildResult> = async conf => {\n  const { options, projectRoot } = conf\n\n  try {\n    // Get target from option or first positional, default to all scripts\n    const targetOption = conf.get('target')\n    const targetPositional = conf.positionals[0]\n    const target =\n      targetOption ||\n      targetPositional ||\n      ':scripts:not(:built):not(:malware)'\n\n    // Run the build process using the graph build function\n    const result = await build({\n      ...options,\n      projectRoot,\n      packageJson: options.packageJson,\n      monorepo: options.monorepo,\n      scurry: options.scurry,\n      target,\n    })\n\n    return result\n  } catch (cause) {\n    const graphRunError =\n      isErrorWithCause(cause) && isGraphRunError(cause.cause) ?\n        cause.cause\n      : undefined\n    if (graphRunError?.code === 'GRAPHRUN_TRAVERSAL') {\n      throw error(\n        'Build failed:\\n  Failed to build package: ' +\n          `${graphRunError.node.name}@${graphRunError.node.version}`,\n        { cause },\n      )\n    }\n    throw error('Build failed', { cause })\n  }\n}\n"]}

package/dist/esm/commands/cache.d.ts

@@ -0,0 +1,65 @@
+import { CacheEntry } from '@vltpkg/registry-client';
+import type { LoadedConfig } from '../config/index.ts';
+import type { CommandFn, CommandUsage } from '../index.ts';
+import type { ViewOptions, Views } from '../view.ts';
+import { ViewClass } from '../view.ts';
+export type CacheMap = Record<string, ReturnType<CacheEntry['toJSON']>>;
+export type CacheSubcommands = keyof (typeof usageDef)['subcommands'];
+export declare class CacheView extends ViewClass {
+    constructor(options: ViewOptions, conf: LoadedConfig);
+    stdout(...args: unknown[]): void;
+}
+export declare const views: Views<void | CacheMap>;
+declare const usageDef: {
+    readonly command: "cache";
+    readonly usage: "<command> [flags]";
+    readonly description: "Work with vlt cache folders";
+    readonly subcommands: {
+        readonly add: {
+            readonly usage: "<package-spec> [<package-spec>...]";
+            readonly description: "Resolve the referenced package identifiers and ensure they\n                    are cached.";
+        };
+        readonly ls: {
+            readonly usage: "[<key>...]";
+            readonly description: "Show cache entries. If no keys are provided, then a list of\n                    available keys will be printed. If one or more keys are\n                    provided, then details will be shown for the specified\n                    items.";
+        };
+        readonly info: {
+            readonly usage: "<key>";
+            readonly description: "Print metadata details for the specified cache key to\n                    stderr, and the response body to stdout.";
+        };
+        readonly clean: {
+            readonly usage: "[<key>...]";
+            readonly description: "Purge expired cache entries. If one or more keys are\n                    provided, then only those cache entries will be\n                    considered.";
+        };
+        readonly delete: {
+            readonly usage: "<key> [<key>...]";
+            readonly description: "Purge items explicitly, whether expired or not.  If one or\n                    more keys are provided, then only those cache entries will\n                    be considered.";
+        };
+        readonly 'delete-before': {
+            readonly usage: "<date>";
+            readonly description: "Purge all cache items from before a given date. Date can be\n                    provided in any format that JavaScript can parse.";
+        };
+        readonly 'delete-all': {
+            readonly usage: "";
+            readonly description: "Delete the entire cache folder to make vlt slower.";
+        };
+    };
+    readonly examples: {
+        readonly 'vlt cache ls https://registry.npmjs.org/typescript': {
+            readonly description: "Show cache metadata for a given registry URL";
+        };
+        readonly 'vlt cache add eslint@latest': {
+            readonly description: "Add a given package specifier to the cache by fetching\n                    its resolved value.";
+        };
+        readonly 'vlt cache info https://registry.npmjs.org/eslint/-/eslint-9.25.1.tgz > eslint.tgz': {
+            readonly description: "Print the cache metadata to stderr, and write the tarball\n                    on stdout, redirecting to a file.";
+        };
+        readonly 'vlt cache delete-before 2025-01-01': {
+            readonly description: "Delete all entries created before Jan 1, 2025";
+        };
+    };
+};
+export declare const usage: CommandUsage;
+export declare const command: CommandFn<void | CacheMap>;
+export {};
+//# sourceMappingURL=cache.d.ts.map

package/dist/esm/commands/cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../../src/commands/cache.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAIpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAGtD,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1D,OAAO,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEtC,MAAM,MAAM,QAAQ,GAAG,MAAM,CAC3B,MAAM,EACN,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CACjC,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,QAAQ,CAAC,CAAC,aAAa,CAAC,CAAA;AAGrE,qBAAa,SAAU,SAAQ,SAAS;gBAC1B,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY;IAIpD,MAAM,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE;CAG1B;AAED,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,IAAI,GAAG,QAAQ,CAExC,CAAA;AAED,QAAA,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoE6B,CAAA;AAE3C,eAAO,MAAM,KAAK,EAAE,YAA2C,CAAA;AAE/D,eAAO,MAAM,OAAO,EAAE,SAAS,CAAC,IAAI,GAAG,QAAQ,CAgC9C,CAAA"}

package/dist/esm/commands/cache.js

@@ -0,0 +1,257 @@
+import { error } from '@vltpkg/error-cause';
+import { CacheEntry } from '@vltpkg/registry-client';
+import { Spec } from '@vltpkg/spec';
+import { mkdir, rm } from 'node:fs/promises';
+import prettyBytes from 'pretty-bytes';
+import { commandUsage } from "../config/usage.js";
+import { stderr, stdout } from "../output.js";
+import { ViewClass } from "../view.js";
+let view;
+export class CacheView extends ViewClass {
+    constructor(options, conf) {
+        super(options, conf);
+        view = this;
+    }
+    stdout(...args) {
+        stdout(...args);
+    }
+}
+export const views = {
+    human: CacheView,
+};
+const usageDef = {
+    command: 'cache',
+    usage: '<command> [flags]',
+    description: 'Work with vlt cache folders',
+    subcommands: {
+        add: {
+            usage: '<package-spec> [<package-spec>...]',
+            description: `Resolve the referenced package identifiers and ensure they
+                    are cached.`,
+        },
+        ls: {
+            usage: '[<key>...]',
+            description: `Show cache entries. If no keys are provided, then a list of
+                    available keys will be printed. If one or more keys are
+                    provided, then details will be shown for the specified
+                    items.`,
+        },
+        info: {
+            usage: '<key>',
+            description: `Print metadata details for the specified cache key to
+                    stderr, and the response body to stdout.`,
+        },
+        clean: {
+            usage: '[<key>...]',
+            description: `Purge expired cache entries. If one or more keys are
+                    provided, then only those cache entries will be
+                    considered.`,
+        },
+        delete: {
+            usage: '<key> [<key>...]',
+            description: `Purge items explicitly, whether expired or not.  If one or
+                    more keys are provided, then only those cache entries will
+                    be considered.`,
+        },
+        'delete-before': {
+            usage: '<date>',
+            description: `Purge all cache items from before a given date. Date can be
+                    provided in any format that JavaScript can parse.`,
+        },
+        'delete-all': {
+            usage: '',
+            description: `Delete the entire cache folder to make vlt slower.`,
+        },
+    },
+    examples: {
+        'vlt cache ls https://registry.npmjs.org/typescript': {
+            description: `Show cache metadata for a given registry URL`,
+        },
+        'vlt cache add eslint@latest': {
+            description: `Add a given package specifier to the cache by fetching
+                    its resolved value.`,
+        },
+        'vlt cache info https://registry.npmjs.org/eslint/-/eslint-9.25.1.tgz > eslint.tgz': {
+            description: `Print the cache metadata to stderr, and write the tarball
+                    on stdout, redirecting to a file.`,
+        },
+        'vlt cache delete-before 2025-01-01': {
+            description: 'Delete all entries created before Jan 1, 2025',
+        },
+    },
+};
+export const usage = () => commandUsage(usageDef);
+export const command = async (conf) => {
+    const [sub, ...args] = conf.positionals;
+    switch (sub) {
+        case 'ls':
+            return ls(conf, args, view);
+        case 'info':
+            return info(conf, args, view);
+        case 'add':
+            return add(conf, args, view);
+        case 'clean':
+            return clean(conf, args, view);
+        case 'delete':
+            return deleteKeys(conf, args, view);
+        case 'delete-before':
+            return deleteBefore(conf, args, view);
+        case 'delete-all':
+            return deleteAll(conf, args, view);
+        default: {
+            throw error('Unrecognized cache command', {
+                code: 'EUSAGE',
+                found: sub,
+                validOptions: Object.keys(usageDef.subcommands),
+            });
+        }
+    }
+};
+const ls = async (conf, keys, view) => keys.length ?
+    await fetchKeys(conf, keys, (entry, key) => {
+        view?.stdout(key.includes(' ') ? JSON.stringify(key) : key, entry);
+        return true;
+    }, view)
+    : await fetchAll(conf, (_, key) => {
+        view?.stdout(key.includes(' ') ? JSON.stringify(key) : key);
+        return true;
+    });
+const info = async (conf, keys, view) => {
+    const [key] = keys;
+    if (keys.length !== 1 || !key) {
+        throw error('Must provide exactly one cache key', {
+            code: 'EUSAGE',
+        });
+    }
+    await fetchKeys(conf, [key], (entry, key) => {
+        stderr(
+        /* c8 ignore next */
+        key.includes(' ') ? JSON.stringify(key) : key, entry);
+        if (entry.isJSON) {
+            stdout(JSON.stringify(entry.body, null, 2));
+            /* c8 ignore start - annoying to test, corrupts TAP output */
+        }
+        else {
+            process.stdout.write(entry.body);
+        }
+        /* c8 ignore stop */
+        return true;
+    }, view);
+};
+const fetchAll = async (conf, test) => {
+    const rc = conf.options.packageInfo.registryClient;
+    const { cache } = rc;
+    const map = {};
+    for await (const [key, val] of cache) {
+        const entry = CacheEntry.decode(val);
+        if (!test(entry, key, val))
+            continue;
+        map[key] = entry.toJSON();
+    }
+    return map;
+};
+const fetchKeys = async (conf, keys, test, view) => {
+    const rc = conf.options.packageInfo.registryClient;
+    const { cache } = rc;
+    const map = {};
+    const results = await Promise.all(keys.map(async (key) => {
+        return [key, await cache.fetch(key)];
+    }));
+    for (const [key, val] of results) {
+        if (!val) {
+            view?.stdout('Not found:', key);
+        }
+        else {
+            const entry = CacheEntry.decode(val);
+            if (!test(entry, key, val))
+                continue;
+            map[key] = entry.toJSON();
+        }
+    }
+    return map;
+};
+const deleteEntries = async (conf, keys, test, view) => {
+    const rc = conf.options.packageInfo.registryClient;
+    const { cache } = rc;
+    let count = 0;
+    let size = 0;
+    const testAction = (entry, key, val) => {
+        if (!test(entry)) {
+            return false;
+        }
+        count++;
+        const s = val.byteLength + key.length;
+        cache.delete(key, true, entry.integrity);
+        const k = key.includes(' ') ? JSON.stringify(key) : key;
+        view?.stdout('-', k, s);
+        size += s;
+        return true;
+    };
+    const map = await (keys.length ?
+        fetchKeys(conf, keys, testAction, view)
+        : fetchAll(conf, testAction));
+    const pb = prettyBytes(size, { binary: true });
+    const s = count === 1 ? '' : 's';
+    await cache.promise();
+    view?.stdout(`Removed ${count} item${s} totalling ${pb}`);
+    return map;
+};
+const clean = async (conf, keys, view) => deleteEntries(conf, keys, entry => !entry.valid, view);
+const deleteBefore = async (conf, args, view) => {
+    if (!args.length) {
+        throw error('Must provide a date to delete before', {
+            code: 'EUSAGE',
+        });
+    }
+    const now = new Date();
+    const before = new Date(args.join(' '));
+    if (before >= now) {
+        throw error('Cannot delete cache entries from the future', {
+            code: 'EUSAGE',
+            found: before,
+        });
+    }
+    return deleteEntries(conf, [], entry => !!entry.date && entry.date < before, view);
+};
+const deleteKeys = async (conf, keys, view) => {
+    if (!keys.length) {
+        throw error('Must provide cache keys to delete', {
+            code: 'EUSAGE',
+        });
+    }
+    return deleteEntries(conf, keys, () => true, view);
+};
+const deleteAll = async (conf, _, view) => {
+    const { cache } = conf.options.packageInfo.registryClient;
+    await rm(cache.path(), { recursive: true, force: true });
+    await mkdir(cache.path(), { recursive: true });
+    view?.stdout('Deleted all cache entries.');
+};
+const add = async (conf, specs, view) => {
+    if (!specs.length) {
+        throw error('Must provide specs to add to the cache', {
+            code: 'EUSAGE',
+        });
+    }
+    const { packageInfo } = conf.options;
+    const promises = [];
+    for (const spec of specs) {
+        const p = packageInfo
+            .resolve(Spec.parseArgs(spec, conf.options), {
+            staleWhileRevalidate: false,
+        })
+            .then(async (r) => {
+            const { resolved, integrity } = r;
+            await packageInfo.registryClient.request(resolved, {
+                ...conf.options,
+                integrity,
+                staleWhileRevalidate: false,
+                query: undefined,
+            });
+            view?.stdout('+', spec, r.resolved);
+        });
+        promises.push(p);
+    }
+    await Promise.all(promises);
+};
+//# sourceMappingURL=cache.js.map

package/dist/esm/commands/cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.js","sourceRoot":"","sources":["../../../src/commands/cache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACpD,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACnC,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAA;AAC5C,OAAO,WAAW,MAAM,cAAc,CAAA;AAGtC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEjD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAStC,IAAI,IAAe,CAAA;AACnB,MAAM,OAAO,SAAU,SAAQ,SAAS;IACtC,YAAY,OAAoB,EAAE,IAAkB;QAClD,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;QACpB,IAAI,GAAG,IAAI,CAAA;IACb,CAAC;IACD,MAAM,CAAC,GAAG,IAAe;QACvB,MAAM,CAAC,GAAG,IAAI,CAAC,CAAA;IACjB,CAAC;CACF;AAED,MAAM,CAAC,MAAM,KAAK,GAA2B;IAC3C,KAAK,EAAE,SAAS;CACjB,CAAA;AAED,MAAM,QAAQ,GAAG;IACf,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE,mBAAmB;IAC1B,WAAW,EAAE,6BAA6B;IAE1C,WAAW,EAAE;QACX,GAAG,EAAE;YACH,KAAK,EAAE,oCAAoC;YAC3C,WAAW,EAAE;gCACa;SAC3B;QAED,EAAE,EAAE;YACF,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE;;;2BAGQ;SACtB;QAED,IAAI,EAAE;YACJ,KAAK,EAAE,OAAO;YACd,WAAW,EAAE;6DAC0C;SACxD;QAED,KAAK,EAAE;YACL,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE;;gCAEa;SAC3B;QAED,MAAM,EAAE;YACN,KAAK,EAAE,kBAAkB;YACzB,WAAW,EAAE;;mCAEgB;SAC9B;QAED,eAAe,EAAE;YACf,KAAK,EAAE,QAAQ;YACf,WAAW,EAAE;sEACmD;SACjE;QAED,YAAY,EAAE;YACZ,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,oDAAoD;SAClE;KACF;IACD,QAAQ,EAAE;QACR,oDAAoD,EAAE;YACpD,WAAW,EAAE,8CAA8C;SAC5D;QACD,6BAA6B,EAAE;YAC7B,WAAW,EAAE;wCACqB;SACnC;QACD,mFAAmF,EACjF;YACE,WAAW,EAAE;sDACiC;SAC/C;QACH,oCAAoC,EAAE;YACpC,WAAW,EAAE,+CAA+C;SAC7D;KACF;CACwC,CAAA;AAE3C,MAAM,CAAC,MAAM,KAAK,GAAiB,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;AAE/D,MAAM,CAAC,MAAM,OAAO,GAA+B,KAAK,EAAC,IAAI,EAAC,EAAE;IAC9D,MAAM,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,WAAW,CAAA;IACvC,QAAQ,GAAG,EAAE,CAAC;QACZ,KAAK,IAAI;YACP,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QAE7B,KAAK,MAAM;YACT,OAAO,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QAE/B,KAAK,KAAK;YACR,OAAO,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QAE9B,KAAK,OAAO;YACV,OAAO,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QAEhC,KAAK,QAAQ;YACX,OAAO,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QAErC,KAAK,eAAe;YAClB,OAAO,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QAEvC,KAAK,YAAY;YACf,OAAO,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QAEpC,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,KAAK,CAAC,4BAA4B,EAAE;gBACxC,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,GAAG;gBACV,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;aAChD,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;AACH,CAAC,CAAA;AAED,MAAM,EAAE,GAAG,KAAK,EACd,IAAkB,EAClB,IAAc,EACd,IAAgB,EACG,EAAE,CACrB,IAAI,CAAC,MAAM,CAAC,CAAC;IACX,MAAM,SAAS,CACb,IAAI,EACJ,IAAI,EACJ,CAAC,KAAiB,EAAE,GAAW,EAAE,EAAE;QACjC,IAAI,EAAE,MAAM,CACV,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAC7C,KAAK,CACN,CAAA;QACD,OAAO,IAAI,CAAA;IACb,CAAC,EACD,IAAI,CACL;IACH,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;QAC9B,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QAC3D,OAAO,IAAI,CAAA;IACb,CAAC,CAAC,CAAA;AAEN,MAAM,IAAI,GAAG,KAAK,EAChB,IAAkB,EAClB,IAAc,EACd,IAAgB,EACD,EAAE;IACjB,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;IAClB,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAC9B,MAAM,KAAK,CAAC,oCAAoC,EAAE;YAChD,IAAI,EAAE,QAAQ;SACf,CAAC,CAAA;IACJ,CAAC;IACD,MAAM,SAAS,CACb,IAAI,EACJ,CAAC,GAAG,CAAC,EACL,CAAC,KAAiB,EAAE,GAAW,EAAE,EAAE;QACjC,MAAM;QACJ,oBAAoB;QACpB,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAC7C,KAAK,CACN,CAAA;QACD,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;YAC3C,6DAA6D;QAC/D,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAc,CAAC,CAAA;QAC5C,CAAC;QACD,oBAAoB;QACpB,OAAO,IAAI,CAAA;IACb,CAAC,EACD,IAAI,CACL,CAAA;AACH,CAAC,CAAA;AAED,MAAM,QAAQ,GAAG,KAAK,EACpB,IAAkB,EAClB,IAA8D,EAC9D,EAAE;IACF,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAA;IAClD,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,CAAA;IACpB,MAAM,GAAG,GAAa,EAAE,CAAA;IACxB,IAAI,KAAK,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,KAAK,EAAE,CAAC;QACrC,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACpC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC;YAAE,SAAQ;QACpC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAA;IAC3B,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED,MAAM,SAAS,GAAG,KAAK,EACrB,IAAkB,EAClB,IAAc,EACd,IAA8D,EAC9D,IAAgB,EAChB,EAAE;IACF,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAA;IAClD,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,CAAA;IACpB,MAAM,GAAG,GAAa,EAAE,CAAA;IACxB,MAAM,OAAO,GAAmC,MAAM,OAAO,CAAC,GAAG,CAC/D,IAAI,CAAC,GAAG,CAAC,KAAK,EAAC,GAAG,EAAC,EAAE;QACnB,OAAO,CAAC,GAAG,EAAE,MAAM,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;IACtC,CAAC,CAAC,CACH,CAAA;IACD,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,OAAO,EAAE,CAAC;QACjC,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,IAAI,EAAE,MAAM,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;QACjC,CAAC;aAAM,CAAC;YACN,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YACpC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC;gBAAE,SAAQ;YACpC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAA;QAC3B,CAAC;IACH,CAAC;IAED,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED,MAAM,aAAa,GAAG,KAAK,EACzB,IAAkB,EAClB,IAAc,EACd,IAAoC,EACpC,IAAgB,EAChB,EAAE;IACF,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAA;IAClD,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,CAAA;IAEpB,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,IAAI,IAAI,GAAG,CAAC,CAAA;IACZ,MAAM,UAAU,GAAG,CACjB,KAAiB,EACjB,GAAW,EACX,GAAW,EACX,EAAE;QACF,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACjB,OAAO,KAAK,CAAA;QACd,CAAC;QACD,KAAK,EAAE,CAAA;QACP,MAAM,CAAC,GAAG,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC,MAAM,CAAA;QACrC,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAA;QACxC,MAAM,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA;QACvD,IAAI,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QACvB,IAAI,IAAI,CAAC,CAAA;QACT,OAAO,IAAI,CAAA;IACb,CAAC,CAAA;IAED,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC9B,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC;QACzC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAA;IAE7B,MAAM,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;IAE9C,MAAM,CAAC,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAA;IAChC,MAAM,KAAK,CAAC,OAAO,EAAE,CAAA;IACrB,IAAI,EAAE,MAAM,CAAC,WAAW,KAAK,QAAQ,CAAC,cAAc,EAAE,EAAE,CAAC,CAAA;IACzD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED,MAAM,KAAK,GAAG,KAAK,EACjB,IAAkB,EAClB,IAAc,EACd,IAAgB,EAChB,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;AAE3D,MAAM,YAAY,GAAG,KAAK,EACxB,IAAkB,EAClB,IAAc,EACd,IAAgB,EAChB,EAAE;IACF,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,MAAM,KAAK,CAAC,sCAAsC,EAAE;YAClD,IAAI,EAAE,QAAQ;SACf,CAAC,CAAA;IACJ,CAAC;IACD,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAA;IACtB,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;IACvC,IAAI,MAAM,IAAI,GAAG,EAAE,CAAC;QAClB,MAAM,KAAK,CAAC,6CAA6C,EAAE;YACzD,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,MAAM;SACd,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,aAAa,CAClB,IAAI,EACJ,EAAE,EACF,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,GAAG,MAAM,EAC5C,IAAI,CACL,CAAA;AACH,CAAC,CAAA;AAED,MAAM,UAAU,GAAG,KAAK,EACtB,IAAkB,EAClB,IAAc,EACd,IAAgB,EAChB,EAAE;IACF,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,MAAM,KAAK,CAAC,mCAAmC,EAAE;YAC/C,IAAI,EAAE,QAAQ;SACf,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;AACpD,CAAC,CAAA;AAED,MAAM,SAAS,GAAG,KAAK,EACrB,IAAkB,EAClB,CAAW,EACX,IAAgB,EAChB,EAAE;IACF,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAA;IACzD,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IACxD,MAAM,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IAC9C,IAAI,EAAE,MAAM,CAAC,4BAA4B,CAAC,CAAA;AAC5C,CAAC,CAAA;AAED,MAAM,GAAG,GAAG,KAAK,EACf,IAAkB,EAClB,KAAe,EACf,IAAgB,EAChB,EAAE;IACF,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAClB,MAAM,KAAK,CAAC,wCAAwC,EAAE;YACpD,IAAI,EAAE,QAAQ;SACf,CAAC,CAAA;IACJ,CAAC;IACD,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;IACpC,MAAM,QAAQ,GAAoB,EAAE,CAAA;IAEpC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,CAAC,GAAG,WAAW;aAClB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE;YAC3C,oBAAoB,EAAE,KAAK;SAC5B,CAAC;aACD,IAAI,CAAC,KAAK,EAAC,CAAC,EAAC,EAAE;YACd,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,CAAC,CAAA;YACjC,MAAM,WAAW,CAAC,cAAc,CAAC,OAAO,CAAC,QAAQ,EAAE;gBACjD,GAAG,IAAI,CAAC,OAAO;gBACf,SAAS;gBACT,oBAAoB,EAAE,KAAK;gBAC3B,KAAK,EAAE,SAAS;aACjB,CAAC,CAAA;YACF,IAAI,EAAE,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAA;QACrC,CAAC,CAAC,CAAA;QAEJ,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAClB,CAAC;IAED,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;AAC7B,CAAC,CAAA","sourcesContent":["import { error } from '@vltpkg/error-cause'\nimport { CacheEntry } from '@vltpkg/registry-client'\nimport { Spec } from '@vltpkg/spec'\nimport { mkdir, rm } from 'node:fs/promises'\nimport prettyBytes from 'pretty-bytes'\nimport type { LoadedConfig } from '../config/index.ts'\nimport type { CommandUsageDefinition } from '../config/usage.ts'\nimport { commandUsage } from '../config/usage.ts'\nimport type { CommandFn, CommandUsage } from '../index.ts'\nimport { stderr, stdout } from '../output.ts'\nimport type { ViewOptions, Views } from '../view.ts'\nimport { ViewClass } from '../view.ts'\n\nexport type CacheMap = Record<\n  string,\n  ReturnType<CacheEntry['toJSON']>\n>\n\nexport type CacheSubcommands = keyof (typeof usageDef)['subcommands']\n\nlet view: CacheView\nexport class CacheView extends ViewClass {\n  constructor(options: ViewOptions, conf: LoadedConfig) {\n    super(options, conf)\n    view = this\n  }\n  stdout(...args: unknown[]) {\n    stdout(...args)\n  }\n}\n\nexport const views: Views<void | CacheMap> = {\n  human: CacheView,\n}\n\nconst usageDef = {\n  command: 'cache',\n  usage: '<command> [flags]',\n  description: 'Work with vlt cache folders',\n\n  subcommands: {\n    add: {\n      usage: '<package-spec> [<package-spec>...]',\n      description: `Resolve the referenced package identifiers and ensure they\n                    are cached.`,\n    },\n\n    ls: {\n      usage: '[<key>...]',\n      description: `Show cache entries. If no keys are provided, then a list of\n                    available keys will be printed. If one or more keys are\n                    provided, then details will be shown for the specified\n                    items.`,\n    },\n\n    info: {\n      usage: '<key>',\n      description: `Print metadata details for the specified cache key to\n                    stderr, and the response body to stdout.`,\n    },\n\n    clean: {\n      usage: '[<key>...]',\n      description: `Purge expired cache entries. If one or more keys are\n                    provided, then only those cache entries will be\n                    considered.`,\n    },\n\n    delete: {\n      usage: '<key> [<key>...]',\n      description: `Purge items explicitly, whether expired or not.  If one or\n                    more keys are provided, then only those cache entries will\n                    be considered.`,\n    },\n\n    'delete-before': {\n      usage: '<date>',\n      description: `Purge all cache items from before a given date. Date can be\n                    provided in any format that JavaScript can parse.`,\n    },\n\n    'delete-all': {\n      usage: '',\n      description: `Delete the entire cache folder to make vlt slower.`,\n    },\n  },\n  examples: {\n    'vlt cache ls https://registry.npmjs.org/typescript': {\n      description: `Show cache metadata for a given registry URL`,\n    },\n    'vlt cache add eslint@latest': {\n      description: `Add a given package specifier to the cache by fetching\n                    its resolved value.`,\n    },\n    'vlt cache info https://registry.npmjs.org/eslint/-/eslint-9.25.1.tgz > eslint.tgz':\n      {\n        description: `Print the cache metadata to stderr, and write the tarball\n                    on stdout, redirecting to a file.`,\n      },\n    'vlt cache delete-before 2025-01-01': {\n      description: 'Delete all entries created before Jan 1, 2025',\n    },\n  },\n} as const satisfies CommandUsageDefinition\n\nexport const usage: CommandUsage = () => commandUsage(usageDef)\n\nexport const command: CommandFn<void | CacheMap> = async conf => {\n  const [sub, ...args] = conf.positionals\n  switch (sub) {\n    case 'ls':\n      return ls(conf, args, view)\n\n    case 'info':\n      return info(conf, args, view)\n\n    case 'add':\n      return add(conf, args, view)\n\n    case 'clean':\n      return clean(conf, args, view)\n\n    case 'delete':\n      return deleteKeys(conf, args, view)\n\n    case 'delete-before':\n      return deleteBefore(conf, args, view)\n\n    case 'delete-all':\n      return deleteAll(conf, args, view)\n\n    default: {\n      throw error('Unrecognized cache command', {\n        code: 'EUSAGE',\n        found: sub,\n        validOptions: Object.keys(usageDef.subcommands),\n      })\n    }\n  }\n}\n\nconst ls = async (\n  conf: LoadedConfig,\n  keys: string[],\n  view?: CacheView,\n): Promise<CacheMap> =>\n  keys.length ?\n    await fetchKeys(\n      conf,\n      keys,\n      (entry: CacheEntry, key: string) => {\n        view?.stdout(\n          key.includes(' ') ? JSON.stringify(key) : key,\n          entry,\n        )\n        return true\n      },\n      view,\n    )\n  : await fetchAll(conf, (_, key) => {\n      view?.stdout(key.includes(' ') ? JSON.stringify(key) : key)\n      return true\n    })\n\nconst info = async (\n  conf: LoadedConfig,\n  keys: string[],\n  view?: CacheView,\n): Promise<void> => {\n  const [key] = keys\n  if (keys.length !== 1 || !key) {\n    throw error('Must provide exactly one cache key', {\n      code: 'EUSAGE',\n    })\n  }\n  await fetchKeys(\n    conf,\n    [key],\n    (entry: CacheEntry, key: string) => {\n      stderr(\n        /* c8 ignore next */\n        key.includes(' ') ? JSON.stringify(key) : key,\n        entry,\n      )\n      if (entry.isJSON) {\n        stdout(JSON.stringify(entry.body, null, 2))\n        /* c8 ignore start - annoying to test, corrupts TAP output */\n      } else {\n        process.stdout.write(entry.body as Buffer)\n      }\n      /* c8 ignore stop */\n      return true\n    },\n    view,\n  )\n}\n\nconst fetchAll = async (\n  conf: LoadedConfig,\n  test: (entry: CacheEntry, key: string, val: Buffer) => boolean,\n) => {\n  const rc = conf.options.packageInfo.registryClient\n  const { cache } = rc\n  const map: CacheMap = {}\n  for await (const [key, val] of cache) {\n    const entry = CacheEntry.decode(val)\n    if (!test(entry, key, val)) continue\n    map[key] = entry.toJSON()\n  }\n  return map\n}\n\nconst fetchKeys = async (\n  conf: LoadedConfig,\n  keys: string[],\n  test: (entry: CacheEntry, key: string, buf: Buffer) => boolean,\n  view?: CacheView,\n) => {\n  const rc = conf.options.packageInfo.registryClient\n  const { cache } = rc\n  const map: CacheMap = {}\n  const results: [string, Buffer | undefined][] = await Promise.all(\n    keys.map(async key => {\n      return [key, await cache.fetch(key)]\n    }),\n  )\n  for (const [key, val] of results) {\n    if (!val) {\n      view?.stdout('Not found:', key)\n    } else {\n      const entry = CacheEntry.decode(val)\n      if (!test(entry, key, val)) continue\n      map[key] = entry.toJSON()\n    }\n  }\n\n  return map\n}\n\nconst deleteEntries = async (\n  conf: LoadedConfig,\n  keys: string[],\n  test: (entry: CacheEntry) => boolean,\n  view?: CacheView,\n) => {\n  const rc = conf.options.packageInfo.registryClient\n  const { cache } = rc\n\n  let count = 0\n  let size = 0\n  const testAction = (\n    entry: CacheEntry,\n    key: string,\n    val: Buffer,\n  ) => {\n    if (!test(entry)) {\n      return false\n    }\n    count++\n    const s = val.byteLength + key.length\n    cache.delete(key, true, entry.integrity)\n    const k = key.includes(' ') ? JSON.stringify(key) : key\n    view?.stdout('-', k, s)\n    size += s\n    return true\n  }\n\n  const map = await (keys.length ?\n    fetchKeys(conf, keys, testAction, view)\n  : fetchAll(conf, testAction))\n\n  const pb = prettyBytes(size, { binary: true })\n\n  const s = count === 1 ? '' : 's'\n  await cache.promise()\n  view?.stdout(`Removed ${count} item${s} totalling ${pb}`)\n  return map\n}\n\nconst clean = async (\n  conf: LoadedConfig,\n  keys: string[],\n  view?: CacheView,\n) => deleteEntries(conf, keys, entry => !entry.valid, view)\n\nconst deleteBefore = async (\n  conf: LoadedConfig,\n  args: string[],\n  view?: CacheView,\n) => {\n  if (!args.length) {\n    throw error('Must provide a date to delete before', {\n      code: 'EUSAGE',\n    })\n  }\n  const now = new Date()\n  const before = new Date(args.join(' '))\n  if (before >= now) {\n    throw error('Cannot delete cache entries from the future', {\n      code: 'EUSAGE',\n      found: before,\n    })\n  }\n  return deleteEntries(\n    conf,\n    [],\n    entry => !!entry.date && entry.date < before,\n    view,\n  )\n}\n\nconst deleteKeys = async (\n  conf: LoadedConfig,\n  keys: string[],\n  view?: CacheView,\n) => {\n  if (!keys.length) {\n    throw error('Must provide cache keys to delete', {\n      code: 'EUSAGE',\n    })\n  }\n  return deleteEntries(conf, keys, () => true, view)\n}\n\nconst deleteAll = async (\n  conf: LoadedConfig,\n  _: string[],\n  view?: CacheView,\n) => {\n  const { cache } = conf.options.packageInfo.registryClient\n  await rm(cache.path(), { recursive: true, force: true })\n  await mkdir(cache.path(), { recursive: true })\n  view?.stdout('Deleted all cache entries.')\n}\n\nconst add = async (\n  conf: LoadedConfig,\n  specs: string[],\n  view?: CacheView,\n) => {\n  if (!specs.length) {\n    throw error('Must provide specs to add to the cache', {\n      code: 'EUSAGE',\n    })\n  }\n  const { packageInfo } = conf.options\n  const promises: Promise<void>[] = []\n\n  for (const spec of specs) {\n    const p = packageInfo\n      .resolve(Spec.parseArgs(spec, conf.options), {\n        staleWhileRevalidate: false,\n      })\n      .then(async r => {\n        const { resolved, integrity } = r\n        await packageInfo.registryClient.request(resolved, {\n          ...conf.options,\n          integrity,\n          staleWhileRevalidate: false,\n          query: undefined,\n        })\n        view?.stdout('+', spec, r.resolved)\n      })\n\n    promises.push(p)\n  }\n\n  await Promise.all(promises)\n}\n"]}

package/dist/esm/commands/ci.d.ts

@@ -0,0 +1,11 @@
+import { InstallReporter } from './install/reporter.ts';
+import type { CommandFn, CommandUsage } from '../index.ts';
+import type { InstallResult } from './install.ts';
+export type CIResult = Omit<InstallResult, 'buildQueue'>;
+export declare const usage: CommandUsage;
+export declare const views: {
+    readonly json: (i: CIResult) => import("@vltpkg/graph").LockfileData;
+    readonly human: typeof InstallReporter;
+};
+export declare const command: CommandFn<CIResult>;
+//# sourceMappingURL=ci.d.ts.map

package/dist/esm/commands/ci.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ci.d.ts","sourceRoot":"","sources":["../../../src/commands/ci.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAEjD,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,CAAA;AAExD,eAAO,MAAM,KAAK,EAAE,YAWhB,CAAA;AAEJ,eAAO,MAAM,KAAK;;;CAGkB,CAAA;AAEpC,eAAO,MAAM,OAAO,EAAE,SAAS,CAAC,QAAQ,CAavC,CAAA"}

package/dist/esm/commands/ci.js

@@ -0,0 +1,32 @@
+import { install } from '@vltpkg/graph';
+import { commandUsage } from "../config/usage.js";
+import { InstallReporter } from "./install/reporter.js";
+export const usage = () => commandUsage({
+    command: 'ci',
+    usage: '',
+    description: `Clean install from lockfile. Deletes node_modules and installs 
+                  dependencies exactly as specified in vlt-lock.json. This is 
+                  similar to running 'vlt install --expect-lockfile' but performs 
+                  a clean install by removing node_modules first.`,
+    examples: {
+        '': { description: 'Clean install from lockfile' },
+    },
+});
+export const views = {
+    json: i => i.graph.toJSON(),
+    human: InstallReporter,
+};
+export const command = async (conf) => {
+    const ciOptions = {
+        ...conf.options,
+        // allow all scripts by default on ci (unless user specifies a filter)
+        allowScripts: conf.get('allow-scripts') ?? '*',
+        expectLockfile: true,
+        frozenLockfile: true,
+        cleanInstall: true,
+        lockfileOnly: conf.options['lockfile-only'],
+    };
+    const { graph } = await install(ciOptions);
+    return { graph };
+};
+//# sourceMappingURL=ci.js.map

package/dist/esm/commands/ci.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ci.js","sourceRoot":"","sources":["../../../src/commands/ci.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAOvD,MAAM,CAAC,MAAM,KAAK,GAAiB,GAAG,EAAE,CACtC,YAAY,CAAC;IACX,OAAO,EAAE,IAAI;IACb,KAAK,EAAE,EAAE;IACT,WAAW,EAAE;;;kEAGiD;IAC9D,QAAQ,EAAE;QACR,EAAE,EAAE,EAAE,WAAW,EAAE,6BAA6B,EAAE;KACnD;CACF,CAAC,CAAA;AAEJ,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE;IAC3B,KAAK,EAAE,eAAe;CACY,CAAA;AAEpC,MAAM,CAAC,MAAM,OAAO,GAAwB,KAAK,EAAC,IAAI,EAAC,EAAE;IACvD,MAAM,SAAS,GAAG;QAChB,GAAG,IAAI,CAAC,OAAO;QACf,sEAAsE;QACtE,YAAY,EAAE,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,GAAG;QAC9C,cAAc,EAAE,IAAI;QACpB,cAAc,EAAE,IAAI;QACpB,YAAY,EAAE,IAAI;QAClB,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC;KAC5C,CAAA;IAED,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,CAAA;IAC1C,OAAO,EAAE,KAAK,EAAE,CAAA;AAClB,CAAC,CAAA","sourcesContent":["import { install } from '@vltpkg/graph'\nimport { commandUsage } from '../config/usage.ts'\nimport { InstallReporter } from './install/reporter.ts'\nimport type { CommandFn, CommandUsage } from '../index.ts'\nimport type { Views } from '../view.ts'\nimport type { InstallResult } from './install.ts'\n\nexport type CIResult = Omit<InstallResult, 'buildQueue'>\n\nexport const usage: CommandUsage = () =>\n  commandUsage({\n    command: 'ci',\n    usage: '',\n    description: `Clean install from lockfile. Deletes node_modules and installs \n                  dependencies exactly as specified in vlt-lock.json. This is \n                  similar to running 'vlt install --expect-lockfile' but performs \n                  a clean install by removing node_modules first.`,\n    examples: {\n      '': { description: 'Clean install from lockfile' },\n    },\n  })\n\nexport const views = {\n  json: i => i.graph.toJSON(),\n  human: InstallReporter,\n} as const satisfies Views<CIResult>\n\nexport const command: CommandFn<CIResult> = async conf => {\n  const ciOptions = {\n    ...conf.options,\n    // allow all scripts by default on ci (unless user specifies a filter)\n    allowScripts: conf.get('allow-scripts') ?? '*',\n    expectLockfile: true,\n    frozenLockfile: true,\n    cleanInstall: true,\n    lockfileOnly: conf.options['lockfile-only'],\n  }\n\n  const { graph } = await install(ciOptions)\n  return { graph }\n}\n"]}

package/dist/esm/commands/config.d.ts

@@ -1,5 +1,6 @@
-import type { RecordPairs } from '../config/index.ts';
 import type { CommandFn, CommandUsage } from '../index.ts';
+import type { Views } from '../view.ts';
+export declare const views: Views;
 export declare const usage: CommandUsage;
-export declare const command: CommandFn<string | number | boolean | void | string[] | RecordPairs>;
+export declare const command: CommandFn;
 //# sourceMappingURL=config.d.ts.map

package/dist/esm/commands/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/commands/config.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAGV,WAAW,EACZ,MAAM,oBAAoB,CAAA;AAE3B,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1D,eAAO,MAAM,KAAK,EAAE,YA8ChB,CAAA;AAEJ,eAAO,MAAM,OAAO,EAAE,SAAS,CAC7B,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,MAAM,EAAE,GAAG,WAAW,CA+B1D,CAAA"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/commands/config.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC1D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAKvC,eAAO,MAAM,KAAK,EAAE,KAUM,CAAA;AAE1B,eAAO,MAAM,KAAK,EAAE,YAwDhB,CAAA;AAEJ,eAAO,MAAM,OAAO,EAAE,SA8DrB,CAAA"}