@vltpkg/output 1.0.0-rc.22 → 1.0.0-rc.24

package/dist/error.d.ts

@@ -0,0 +1,27 @@
+export type ErrorCause = Record<string, unknown> & {
+    cause?: ErrorCause;
+};
+export type ParsedError = {
+    name: string;
+    message: string;
+    stack?: string;
+    cause?: ErrorCause | ParsedError;
+    [key: string]: unknown;
+};
+/**
+ * Parse an unknown value into an error. Will also take enumerable properties
+ * from legacy style Node errors and treat them as the cause.
+ */
+export declare const parseError: (err: unknown) => null | ParsedError;
+/**
+ * Find the root error from an unknown value, optionally matching a code.
+ */
+export declare const findRootError: (v: unknown, match?: {
+    code?: string;
+}) => ParsedError | null;
+/**
+ * Find the root error from an unknown value and throw if one is not found.
+ */
+export declare const asRootError: (v: unknown, match?: {
+    code?: string;
+}) => Omit<ParsedError, "cause"> & Required<Pick<ParsedError, "cause">>;

package/dist/error.js

@@ -0,0 +1,45 @@
+import { isError, isObject } from '@vltpkg/types';
+/**
+ * Parse an unknown value into an error. Will also take enumerable properties
+ * from legacy style Node errors and treat them as the cause.
+ */
+export const parseError = (err) => {
+    if (!isError(err)) {
+        return null;
+    }
+    // Assume that if the error has enumerable properties, then
+    // it is a legacy error and does not also have a cause.
+    const enumerable = Object.fromEntries(Object.entries(err));
+    if (Object.keys(enumerable).length) {
+        err.cause = enumerable;
+        return err;
+    }
+    if (isObject(err.cause)) {
+        if (isError(err.cause.cause)) {
+            err.cause.cause = parseError(err.cause.cause);
+        }
+    }
+    else if (isError(err.cause)) {
+        err.cause = parseError(err.cause);
+    }
+    return err;
+};
+/**
+ * Find the root error from an unknown value, optionally matching a code.
+ */
+export const findRootError = (v, match) => {
+    const err = parseError(v);
+    return !err || (match?.code && err.cause?.code !== match.code) ?
+        null
+        : err;
+};
+/**
+ * Find the root error from an unknown value and throw if one is not found.
+ */
+export const asRootError = (v, match) => {
+    const err = findRootError(v, match);
+    if (!err)
+        throw v;
+    err.cause = err.cause ?? {};
+    return err;
+};

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+export type Events = {
+    request: {
+        url: URL | string;
+        state: 'start' | 'complete' | '304' | 'cache' | 'stale';
+    };
+    graphStep: {
+        step: 'build' | 'actual' | 'reify';
+        state: 'start' | 'stop';
+    };
+};
+export declare class OutputEmitter {
+    private emitter;
+    emit<T extends keyof Events>(eventName: T, payload: Events[T]): void;
+    on<T extends keyof Events>(eventName: T, handler: (payload: Events[T]) => void): void;
+    off<T extends keyof Events>(eventName: T, handler: (payload: Events[T]) => void): void;
+}
+export declare const emitter: OutputEmitter;
+export declare const logRequest: (url: URL | string, state: Events["request"]["state"]) => void;
+export declare const graphStep: (step: Events["graphStep"]["step"]) => () => void;

package/dist/index.js

@@ -0,0 +1,23 @@
+import EventEmitter from 'node:events';
+export class OutputEmitter {
+    emitter = new EventEmitter();
+    emit(eventName, payload) {
+        this.emitter.emit(eventName, payload);
+    }
+    on(eventName, handler) {
+        this.emitter.on(eventName, handler);
+    }
+    off(eventName, handler) {
+        this.emitter.off(eventName, handler);
+    }
+}
+// Exported event emitter to coordinate events.
+// There must be one version of output across the entire CLI.
+export const emitter = new OutputEmitter();
+export const logRequest = (url, state) => {
+    emitter.emit('request', { url, state });
+};
+export const graphStep = (step) => {
+    emitter.emit('graphStep', { step, state: 'start' });
+    return () => emitter.emit('graphStep', { step, state: 'stop' });
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vltpkg/output",
   "description": "Generate output from the vlt CLI",
-  "version": "1.0.0-rc.22",
+  "version": "1.0.0-rc.24",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vltpkg/vltpkg.git",
@@ -12,7 +12,7 @@
     "email": "support@vlt.sh"
   },
   "dependencies": {
-    "@vltpkg/types": "1.0.0-rc.22"
+    "@vltpkg/types": "1.0.0-rc.24"
   },
   "devDependencies": {
     "@eslint/js": "^9.39.1",
@@ -43,18 +43,18 @@
     "extends": "../../tap-config.yaml"
   },
   "prettier": "../../.prettierrc.js",
-  "module": "./src/index.ts",
+  "module": "./dist/index.js",
   "type": "module",
   "exports": {
     "./package.json": "./package.json",
     ".": {
       "import": {
-        "default": "./src/index.ts"
+        "default": "./dist/index.js"
       }
     },
     "./error": {
       "import": {
-        "default": "./src/error.ts"
+        "default": "./dist/error.js"
       }
     }
   },