@sanity/cli 6.0.0-alpha.17 → 6.0.0-alpha.19

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/cli",
-  "version": "6.0.0-alpha.17",
+  "version": "6.0.0-alpha.19",
   "description": "Sanity CLI tool for managing Sanity projects and organizations",
   "keywords": [
     "sanity",
@@ -49,24 +49,25 @@
   ],
   "dependencies": {
     "@babel/traverse": "^7.29.0",
-    "@oclif/core": "^4.8.0",
+    "@oclif/core": "^4.8.2",
     "@oclif/plugin-help": "^6.2.37",
     "@oclif/plugin-not-found": "^3.2.74",
     "@rexxars/gitconfiglocal": "^3.0.1",
     "@sanity/client": "^7.16.0",
     "@sanity/codegen": "^5.10.1",
     "@sanity/descriptors": "^1.3.0",
-    "@sanity/export": "^6.0.5",
+    "@sanity/export": "^6.1.0",
     "@sanity/generate-help-url": "^4.0.0",
     "@sanity/id-utils": "^1.0.0",
-    "@sanity/import": "^4.1.2",
+    "@sanity/import": "^4.1.3",
     "@sanity/migrate": "^5.2.5",
-    "@sanity/runtime-cli": "^13.4.1",
-    "@sanity/schema": "^5.12.0",
+    "@sanity/runtime-cli": "^14.2.0",
+    "@sanity/schema": "^5.13.0",
     "@sanity/telemetry": "^0.8.1",
     "@sanity/template-validator": "^3.0.0",
-    "@sanity/types": "^5.12.0",
-    "@sanity/ui": "^3.1.11",
+    "@sanity/types": "^5.13.0",
+    "@sanity/ui": "^3.1.13",
+    "@sanity/worker-channels": "^2.0.0",
     "@vercel/frameworks": "3.8.4",
     "@vercel/fs-detectors": "5.5.2",
     "@vitejs/plugin-react": "^5.1.4",
@@ -82,7 +83,6 @@
     "git-user-info": "^2.0.3",
     "gunzip-maybe": "^1.4.2",
     "import-meta-resolve": "^4.2.0",
-    "install-peerdeps": "^3.0.7",
     "is-installed-globally": "^1.0.0",
     "is-tar": "^1.0.0",
     "isomorphic-dompurify": "^2.32.0",
@@ -93,10 +93,11 @@
     "nanoid": "^5.1.5",
     "node-html-parser": "^7.0.1",
     "oneline": "^2.0.0",
-    "open": "^10.1.0",
+    "open": "^11.0.0",
     "p-map": "^7.0.3",
     "package-directory": "^8.1.0",
     "peek-stream": "^1.1.3",
+    "picomatch": "^4.0.3",
     "pluralize-esm": "^9.0.5",
     "preferred-pm": "^4.1.1",
     "pretty-ms": "^9.3.0",
@@ -111,28 +112,29 @@
     "semver": "^7.7.2",
     "semver-compare": "^1.0.0",
     "smol-toml": "^1.6.0",
-    "tar": "^7.5.6",
+    "tar": "^7.5.9",
     "tar-fs": "^3.1.0",
     "tar-stream": "^3.1.7",
     "tinyglobby": "^0.2.15",
     "tsx": "^4.21.0",
     "vite": "^7.3.1",
-    "which": "^5.0.0",
+    "which": "^6.0.1",
     "zod": "^4.3.6",
-    "@sanity/cli-core": "0.1.0-alpha.16"
+    "@sanity/cli-core": "0.1.0-alpha.18"
   },
   "devDependencies": {
     "@eslint/compat": "^2.0.2",
-    "@sanity/pkg-utils": "^10.4.4",
+    "@sanity/pkg-utils": "^10.4.6",
     "@swc/cli": "^0.8.0",
-    "@swc/core": "^1.15.11",
+    "@swc/core": "^1.15.17",
     "@types/babel__traverse": "^7.28.0",
     "@types/debug": "^4.1.12",
     "@types/gunzip-maybe": "^1.4.3",
     "@types/lodash-es": "^4.17.12",
     "@types/minimist": "^1.2.5",
-    "@types/node": "^20.19.33",
+    "@types/node": "^20.19.35",
     "@types/react": "^19.2.14",
+    "@types/picomatch": "^4.0.2",
     "@types/react-dom": "^19.2.3",
     "@types/react-is": "^19.2.0",
     "@types/semver": "^7.7.1",
@@ -141,22 +143,21 @@
     "@types/tar-stream": "^3.1.4",
     "@types/which": "^3.0.4",
     "@vitest/coverage-istanbul": "^4.0.18",
-    "@vitest/utils": "^4.0.18",
     "babel-plugin-react-compiler": "^1.0.0",
-    "eslint": "^9.39.2",
+    "eslint": "^9.39.3",
     "nock": "^14.0.11",
-    "oclif": "^4.22.79",
+    "oclif": "^4.22.81",
     "prettier": "^3.8.1",
     "publint": "^0.3.17",
     "rimraf": "^6.0.1",
-    "sanity": "^5.12.0",
+    "sanity": "^5.13.0",
     "typescript": "^5.9.3",
     "vite-tsconfig-paths": "^6.1.1",
     "vitest": "^4.0.18",
     "@repo/package.config": "0.0.1",
     "@repo/tsconfig": "3.70.0",
-    "@sanity/cli-test": "0.0.2-alpha.15",
-    "@sanity/eslint-config-cli": "0.0.0-alpha.2"
+    "@sanity/cli-test": "0.1.0-alpha.16",
+    "@sanity/eslint-config-cli": "0.0.0-alpha.4"
   },
   "engines": {
     "node": ">=20.19.1 <22 || >=22.12"

package/dist/actions/dev/getCoreAppUrl.js

@@ -1,10 +0,0 @@
-import { getSanityUrl } from '@sanity/cli-core';
-export function getCoreAppURL({ httpHost = 'localhost', httpPort = 3333, organizationId }) {
-    const url = `http://${httpHost}:${httpPort}`;
-    const params = new URLSearchParams({
-        dev: url
-    });
-    return `${getSanityUrl()}/@${organizationId}?${params.toString()}`;
-}
-
-//# sourceMappingURL=getCoreAppUrl.js.map

package/dist/actions/dev/getCoreAppUrl.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/actions/dev/getCoreAppUrl.ts"],"sourcesContent":["import {getSanityUrl} from '@sanity/cli-core'\n\nexport function getCoreAppURL({\n  httpHost = 'localhost',\n  httpPort = 3333,\n  organizationId,\n}: {\n  httpHost?: string\n  httpPort?: number\n  organizationId: string\n}): string {\n  const url = `http://${httpHost}:${httpPort}`\n  const params = new URLSearchParams({dev: url})\n\n  return `${getSanityUrl()}/@${organizationId}?${params.toString()}`\n}\n"],"names":["getSanityUrl","getCoreAppURL","httpHost","httpPort","organizationId","url","params","URLSearchParams","dev","toString"],"mappings":"AAAA,SAAQA,YAAY,QAAO,mBAAkB;AAE7C,OAAO,SAASC,cAAc,EAC5BC,WAAW,WAAW,EACtBC,WAAW,IAAI,EACfC,cAAc,EAKf;IACC,MAAMC,MAAM,CAAC,OAAO,EAAEH,SAAS,CAAC,EAAEC,UAAU;IAC5C,MAAMG,SAAS,IAAIC,gBAAgB;QAACC,KAAKH;IAAG;IAE5C,OAAO,GAAGL,eAAe,EAAE,EAAEI,eAAe,CAAC,EAAEE,OAAOG,QAAQ,IAAI;AACpE"}

package/dist/actions/schema/schemaStoreTypes.js

@@ -1,19 +0,0 @@
-/**
- * There is more context locally to decide how and when to log, depending on flags;
- * we therefore let actions log as soon as possible, possibly stopping stack unwinding.
- * This gives us more control over the color and detail of the error message, as well as ensuring
- * we dont double-log errors up the chain.
- *
- * Depending on flags, store actions can fail without throwing; to allow control flow to continue,
- * even in the face of failure (--schema-required ture/false for store)
- *
- * It is up to action to make this distinction based on flags.
- *
- * However, we _do_ want to ensure correct exit code on commands (0 vs 1), so
- * CLI command chains are stopped if a store command fails.
- *
- * Invalid flags will always throw.
- *
- */ export { };
-
-//# sourceMappingURL=schemaStoreTypes.js.map

package/dist/actions/schema/schemaStoreTypes.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/actions/schema/schemaStoreTypes.ts"],"sourcesContent":["/**\n * There is more context locally to decide how and when to log, depending on flags;\n * we therefore let actions log as soon as possible, possibly stopping stack unwinding.\n * This gives us more control over the color and detail of the error message, as well as ensuring\n * we dont double-log errors up the chain.\n *\n * Depending on flags, store actions can fail without throwing; to allow control flow to continue,\n * even in the face of failure (--schema-required ture/false for store)\n *\n * It is up to action to make this distinction based on flags.\n *\n * However, we _do_ want to ensure correct exit code on commands (0 vs 1), so\n * CLI command chains are stopped if a store command fails.\n *\n * Invalid flags will always throw.\n *\n */\nexport type SchemaStoreActionResult = 'failure' | 'success'\n"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;CAgBC,GACD,WAA2D"}

package/dist/actions/schema/utils/manifestExtractor.js

@@ -1,29 +0,0 @@
-import { styleText } from 'node:util';
-import { extractManifestSafe } from '../../manifest/extractManifest.js';
-import { FlagValidationError } from './schemaStoreValidation.js';
-export async function ensureManifestExtractSatisfied(args) {
-    const { extractManifest, manifestDir, manifestSafe, output, schemaRequired } = args;
-    if (!extractManifest) {
-        return true;
-    }
-    try {
-        // a successful manifest extract will write a new manifest file, which manifestReader will then read from disk
-        const error = await extractManifestSafe({
-            outPath: manifestDir,
-            output
-        });
-        if (!manifestSafe && error) {
-            throw error;
-        }
-        return true;
-    } catch (err) {
-        if (schemaRequired || err instanceof FlagValidationError) {
-            throw err;
-        } else {
-            output.log(styleText('gray', `↳ Failed to extract manifest:\n  ${err.message}`));
-            return false;
-        }
-    }
-}
-
-//# sourceMappingURL=manifestExtractor.js.map

package/dist/actions/schema/utils/manifestExtractor.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/actions/schema/utils/manifestExtractor.ts"],"sourcesContent":["import {styleText} from 'node:util'\n\nimport {type Output} from '@sanity/cli-core'\n\nimport {extractManifestSafe} from '../../manifest/extractManifest.js'\nimport {FlagValidationError} from './schemaStoreValidation.js'\n\nexport async function ensureManifestExtractSatisfied(args: {\n  extractManifest: boolean\n  manifestDir: string\n  manifestSafe?: boolean\n  output: Output\n  schemaRequired?: boolean\n  workDir: string\n}) {\n  const {extractManifest, manifestDir, manifestSafe, output, schemaRequired} = args\n  if (!extractManifest) {\n    return true\n  }\n  try {\n    // a successful manifest extract will write a new manifest file, which manifestReader will then read from disk\n    const error = await extractManifestSafe({\n      outPath: manifestDir,\n      output,\n    })\n\n    if (!manifestSafe && error) {\n      throw error\n    }\n\n    return true\n  } catch (err) {\n    if (schemaRequired || err instanceof FlagValidationError) {\n      throw err\n    } else {\n      output.log(styleText('gray', `↳ Failed to extract manifest:\\n  ${err.message}`))\n      return false\n    }\n  }\n}\n"],"names":["styleText","extractManifestSafe","FlagValidationError","ensureManifestExtractSatisfied","args","extractManifest","manifestDir","manifestSafe","output","schemaRequired","error","outPath","err","log","message"],"mappings":"AAAA,SAAQA,SAAS,QAAO,YAAW;AAInC,SAAQC,mBAAmB,QAAO,oCAAmC;AACrE,SAAQC,mBAAmB,QAAO,6BAA4B;AAE9D,OAAO,eAAeC,+BAA+BC,IAOpD;IACC,MAAM,EAACC,eAAe,EAAEC,WAAW,EAAEC,YAAY,EAAEC,MAAM,EAAEC,cAAc,EAAC,GAAGL;IAC7E,IAAI,CAACC,iBAAiB;QACpB,OAAO;IACT;IACA,IAAI;QACF,8GAA8G;QAC9G,MAAMK,QAAQ,MAAMT,oBAAoB;YACtCU,SAASL;YACTE;QACF;QAEA,IAAI,CAACD,gBAAgBG,OAAO;YAC1B,MAAMA;QACR;QAEA,OAAO;IACT,EAAE,OAAOE,KAAK;QACZ,IAAIH,kBAAkBG,eAAeV,qBAAqB;YACxD,MAAMU;QACR,OAAO;YACLJ,OAAOK,GAAG,CAACb,UAAU,QAAQ,CAAC,iCAAiC,EAAEY,IAAIE,OAAO,EAAE;YAC9E,OAAO;QACT;IACF;AACF"}

package/dist/actions/schema/utils/manifestReader.js

@@ -1,71 +0,0 @@
-import { readFile, stat } from 'node:fs/promises';
-import path, { join, resolve } from 'node:path';
-import { styleText } from 'node:util';
-import { MANIFEST_FILENAME } from '../../manifest/extractManifest.js';
-/**
- * The manifest reader will try to read manifest and workspace schema files _once_ and cache a successful result.
- * If you need to re-read the manifest from disk, create a new instance.
- */ export const createManifestReader = ({ manifestDir, output, workDir })=>{
-    let parsedManifest;
-    const parsedWorkspaces = {};
-    const getManifest = async ()=>{
-        if (parsedManifest) {
-            return parsedManifest?.parsedJson;
-        }
-        const staticPath = resolve(join(workDir, manifestDir));
-        const manifestFile = path.join(staticPath, MANIFEST_FILENAME);
-        const result = await parseJsonFile(manifestFile);
-        if (!result) {
-            throw new Error(`Manifest does not exist at ${manifestFile}. To create the manifest file, omit --no-extract-manifest or run "sanity manifest extract" first.`);
-        }
-        output.log(styleText('gray', `↳ Read manifest from ${manifestFile} (last modified: ${result.lastModified})`));
-        parsedManifest = result;
-        return result.parsedJson;
-    };
-    const getWorkspaceSchema = async (workspaceName)=>{
-        if (parsedWorkspaces[workspaceName]) {
-            return parsedWorkspaces[workspaceName]?.parsedJson;
-        }
-        const manifest = await getManifest();
-        if (!manifest) {
-            throw new Error('Manifest is required to read workspace schema.');
-        }
-        const workspaceManifest = manifest.workspaces.find((workspace)=>workspace.name === workspaceName);
-        if (!workspaceManifest) {
-            throw new Error(`No workspace named "${workspaceName}" found in manifest.`);
-        }
-        const workspaceSchemaFile = path.join(manifestDir, workspaceManifest.schema);
-        const result = await parseJsonFile(workspaceSchemaFile);
-        if (!result) {
-            throw new Error(`Workspace schema file at "${workspaceSchemaFile}" does not exist.`);
-        }
-        parsedWorkspaces[workspaceName] = result;
-        return result.parsedJson;
-    };
-    return {
-        getManifest,
-        getWorkspaceSchema
-    };
-};
-async function parseJsonFile(filePath) {
-    let stats;
-    try {
-        stats = await stat(filePath);
-    } catch  {
-        // file does not exist
-        return undefined;
-    }
-    const content = await readFile(filePath, 'utf8');
-    const lastModified = stats.mtime.toISOString();
-    const json = JSON.parse(content);
-    if (!json) {
-        throw new Error(`JSON file "${filePath}" was empty.`);
-    }
-    return {
-        lastModified,
-        parsedJson: json,
-        path: filePath
-    };
-}
-
-//# sourceMappingURL=manifestReader.js.map

package/dist/actions/schema/utils/manifestReader.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/actions/schema/utils/manifestReader.ts"],"sourcesContent":["import {type Stats} from 'node:fs'\nimport {readFile, stat} from 'node:fs/promises'\nimport path, {join, resolve} from 'node:path'\nimport {styleText} from 'node:util'\n\nimport {type Output} from '@sanity/cli-core'\n\nimport {MANIFEST_FILENAME} from '../../manifest/extractManifest.js'\nimport {type CreateManifest, type ManifestSchemaType} from '../../manifest/types.js'\n\ntype CreateManifestReaderFactory = (args: {\n  manifestDir: string\n  output: Output\n  workDir: string\n}) => CreateManifestReader\n\nexport interface CreateManifestReader {\n  getManifest: () => Promise<CreateManifest>\n  getWorkspaceSchema: (workspaceName: string) => Promise<ManifestSchemaType[]>\n}\n\ninterface JsonFileParseSuccess<T> {\n  lastModified: string\n  parsedJson: T\n  path: string\n}\n\n/**\n * The manifest reader will try to read manifest and workspace schema files _once_ and cache a successful result.\n * If you need to re-read the manifest from disk, create a new instance.\n */\nexport const createManifestReader: CreateManifestReaderFactory = ({\n  manifestDir,\n  output,\n  workDir,\n}) => {\n  let parsedManifest: JsonFileParseSuccess<CreateManifest>\n  const parsedWorkspaces: Record<string, JsonFileParseSuccess<ManifestSchemaType[]> | undefined> =\n    {}\n\n  const getManifest: CreateManifestReader['getManifest'] = async () => {\n    if (parsedManifest) {\n      return parsedManifest?.parsedJson\n    }\n\n    const staticPath = resolve(join(workDir, manifestDir))\n    const manifestFile = path.join(staticPath, MANIFEST_FILENAME)\n\n    const result = await parseJsonFile<CreateManifest>(manifestFile)\n    if (!result) {\n      throw new Error(\n        `Manifest does not exist at ${manifestFile}. To create the manifest file, omit --no-extract-manifest or run \"sanity manifest extract\" first.`,\n      )\n    }\n\n    output.log(\n      styleText(\n        'gray',\n        `↳ Read manifest from ${manifestFile} (last modified: ${result.lastModified})`,\n      ),\n    )\n\n    parsedManifest = result\n    return result.parsedJson\n  }\n\n  const getWorkspaceSchema: CreateManifestReader['getWorkspaceSchema'] = async (workspaceName) => {\n    if (parsedWorkspaces[workspaceName]) {\n      return parsedWorkspaces[workspaceName]?.parsedJson\n    }\n    const manifest = await getManifest()\n    if (!manifest) {\n      throw new Error('Manifest is required to read workspace schema.')\n    }\n\n    const workspaceManifest = manifest.workspaces.find(\n      (workspace) => workspace.name === workspaceName,\n    )\n\n    if (!workspaceManifest) {\n      throw new Error(`No workspace named \"${workspaceName}\" found in manifest.`)\n    }\n\n    const workspaceSchemaFile = path.join(manifestDir, workspaceManifest.schema)\n    const result = await parseJsonFile<ManifestSchemaType[]>(workspaceSchemaFile)\n    if (!result) {\n      throw new Error(`Workspace schema file at \"${workspaceSchemaFile}\" does not exist.`)\n    }\n    parsedWorkspaces[workspaceName] = result\n    return result.parsedJson\n  }\n  return {\n    getManifest,\n    getWorkspaceSchema,\n  }\n}\n\nasync function parseJsonFile<T>(filePath: string): Promise<JsonFileParseSuccess<T> | undefined> {\n  let stats: Stats\n  try {\n    stats = await stat(filePath)\n  } catch {\n    // file does not exist\n    return undefined\n  }\n  const content = await readFile(filePath, 'utf8')\n  const lastModified = stats.mtime.toISOString()\n  const json = JSON.parse(content) as T\n  if (!json) {\n    throw new Error(`JSON file \"${filePath}\" was empty.`)\n  }\n  return {\n    lastModified,\n    parsedJson: json,\n    path: filePath,\n  }\n}\n"],"names":["readFile","stat","path","join","resolve","styleText","MANIFEST_FILENAME","createManifestReader","manifestDir","output","workDir","parsedManifest","parsedWorkspaces","getManifest","parsedJson","staticPath","manifestFile","result","parseJsonFile","Error","log","lastModified","getWorkspaceSchema","workspaceName","manifest","workspaceManifest","workspaces","find","workspace","name","workspaceSchemaFile","schema","filePath","stats","undefined","content","mtime","toISOString","json","JSON","parse"],"mappings":"AACA,SAAQA,QAAQ,EAAEC,IAAI,QAAO,mBAAkB;AAC/C,OAAOC,QAAOC,IAAI,EAAEC,OAAO,QAAO,YAAW;AAC7C,SAAQC,SAAS,QAAO,YAAW;AAInC,SAAQC,iBAAiB,QAAO,oCAAmC;AAoBnE;;;CAGC,GACD,OAAO,MAAMC,uBAAoD,CAAC,EAChEC,WAAW,EACXC,MAAM,EACNC,OAAO,EACR;IACC,IAAIC;IACJ,MAAMC,mBACJ,CAAC;IAEH,MAAMC,cAAmD;QACvD,IAAIF,gBAAgB;YAClB,OAAOA,gBAAgBG;QACzB;QAEA,MAAMC,aAAaX,QAAQD,KAAKO,SAASF;QACzC,MAAMQ,eAAed,KAAKC,IAAI,CAACY,YAAYT;QAE3C,MAAMW,SAAS,MAAMC,cAA8BF;QACnD,IAAI,CAACC,QAAQ;YACX,MAAM,IAAIE,MACR,CAAC,2BAA2B,EAAEH,aAAa,iGAAiG,CAAC;QAEjJ;QAEAP,OAAOW,GAAG,CACRf,UACE,QACA,CAAC,qBAAqB,EAAEW,aAAa,iBAAiB,EAAEC,OAAOI,YAAY,CAAC,CAAC,CAAC;QAIlFV,iBAAiBM;QACjB,OAAOA,OAAOH,UAAU;IAC1B;IAEA,MAAMQ,qBAAiE,OAAOC;QAC5E,IAAIX,gBAAgB,CAACW,cAAc,EAAE;YACnC,OAAOX,gBAAgB,CAACW,cAAc,EAAET;QAC1C;QACA,MAAMU,WAAW,MAAMX;QACvB,IAAI,CAACW,UAAU;YACb,MAAM,IAAIL,MAAM;QAClB;QAEA,MAAMM,oBAAoBD,SAASE,UAAU,CAACC,IAAI,CAChD,CAACC,YAAcA,UAAUC,IAAI,KAAKN;QAGpC,IAAI,CAACE,mBAAmB;YACtB,MAAM,IAAIN,MAAM,CAAC,oBAAoB,EAAEI,cAAc,oBAAoB,CAAC;QAC5E;QAEA,MAAMO,sBAAsB5B,KAAKC,IAAI,CAACK,aAAaiB,kBAAkBM,MAAM;QAC3E,MAAMd,SAAS,MAAMC,cAAoCY;QACzD,IAAI,CAACb,QAAQ;YACX,MAAM,IAAIE,MAAM,CAAC,0BAA0B,EAAEW,oBAAoB,iBAAiB,CAAC;QACrF;QACAlB,gBAAgB,CAACW,cAAc,GAAGN;QAClC,OAAOA,OAAOH,UAAU;IAC1B;IACA,OAAO;QACLD;QACAS;IACF;AACF,EAAC;AAED,eAAeJ,cAAiBc,QAAgB;IAC9C,IAAIC;IACJ,IAAI;QACFA,QAAQ,MAAMhC,KAAK+B;IACrB,EAAE,OAAM;QACN,sBAAsB;QACtB,OAAOE;IACT;IACA,MAAMC,UAAU,MAAMnC,SAASgC,UAAU;IACzC,MAAMX,eAAeY,MAAMG,KAAK,CAACC,WAAW;IAC5C,MAAMC,OAAOC,KAAKC,KAAK,CAACL;IACxB,IAAI,CAACG,MAAM;QACT,MAAM,IAAInB,MAAM,CAAC,WAAW,EAAEa,SAAS,YAAY,CAAC;IACtD;IACA,OAAO;QACLX;QACAP,YAAYwB;QACZpC,MAAM8B;IACR;AACF"}

package/dist/util/workerChannels.js

@@ -1,172 +0,0 @@
-/**
- * A simple queue that has two primary methods: `push(message)` and
- * `await next()`. This message queue is used by the "receiver" of the worker
- * channel and this class handles buffering incoming messages if the worker is
- * producing faster than the parent as well as returning a promise if there is
- * no message yet in the queue when the parent awaits `next()`.
- */ class MessageQueue {
-    queue = [];
-    resolver = null;
-    end() {
-        if (this.resolver) {
-            this.resolver({
-                done: true,
-                value: undefined
-            });
-        }
-    }
-    next() {
-        if (this.queue.length > 0) {
-            return Promise.resolve({
-                done: false,
-                value: this.queue.shift()
-            });
-        }
-        return new Promise((resolve)=>this.resolver = resolve);
-    }
-    push(message) {
-        if (this.resolver) {
-            this.resolver({
-                done: false,
-                value: message
-            });
-            this.resolver = null;
-        } else {
-            this.queue.push(message);
-        }
-    }
-}
-function isWorkerChannelMessage(message) {
-    if (typeof message !== 'object') return false;
-    if (!message) return false;
-    if (!('type' in message)) return false;
-    if (typeof message.type !== 'string') return false;
-    const types = [
-        'event',
-        'emission',
-        'end'
-    ];
-    return types.includes(message.type);
-}
-/**
- * Creates a "worker channel receiver" that subscribes to incoming messages
- * from the given worker and returns promises for worker channel events and
- * async iterators for worker channel streams.
- */ export function createReceiver(worker) {
-    const _events = new Map();
-    const _streams = new Map();
-    const errors = new MessageQueue();
-    const eventQueue = (name)=>{
-        const queue = _events.get(name) ?? new MessageQueue();
-        if (!_events.has(name)) _events.set(name, queue);
-        return queue;
-    };
-    const streamQueue = (name)=>{
-        const queue = _streams.get(name) ?? new MessageQueue();
-        if (!_streams.has(name)) _streams.set(name, queue);
-        return queue;
-    };
-    const handleMessage = (message)=>{
-        if (!isWorkerChannelMessage(message)) return;
-        if (message.type === 'event') eventQueue(message.name).push(message);
-        if (message.type === 'emission') streamQueue(message.name).push(message);
-        if (message.type === 'end') streamQueue(message.name).end();
-    };
-    const handleError = (error)=>{
-        errors.push({
-            error,
-            type: 'error'
-        });
-    };
-    worker.addListener('message', handleMessage);
-    worker.addListener('error', handleError);
-    return {
-        dispose: ()=>{
-            worker.removeListener('message', handleMessage);
-            worker.removeListener('error', handleError);
-            return worker.terminate();
-        },
-        event: new Proxy({}, {
-            get: (target, name)=>{
-                if (typeof name !== 'string') return target[name];
-                const eventReceiver = async ()=>{
-                    const { value } = await Promise.race([
-                        eventQueue(name).next(),
-                        errors.next()
-                    ]);
-                    if (value.type === 'error') throw value.error;
-                    return value.payload;
-                };
-                return eventReceiver;
-            }
-        }),
-        stream: new Proxy({}, {
-            get: (target, prop)=>{
-                if (typeof prop !== 'string') return target[prop];
-                const name = prop // alias for better typescript narrowing
-                ;
-                async function* streamReceiver() {
-                    while(true){
-                        const { done, value } = await Promise.race([
-                            streamQueue(name).next(),
-                            errors.next()
-                        ]);
-                        if (done) return;
-                        if (value.type === 'error') throw value.error;
-                        yield value.payload;
-                    }
-                }
-                return streamReceiver;
-            }
-        })
-    };
-}
-/**
- * Creates a "worker channel reporter" that sends messages to the given
- * `parentPort` to be received by a worker channel receiver.
- */ export function createReporter(parentPort) {
-    if (!parentPort) {
-        throw new Error('parentPart was falsy');
-    }
-    return {
-        event: new Proxy({}, {
-            get: (target, name)=>{
-                if (typeof name !== 'string') return target[name];
-                const eventReporter = (payload)=>{
-                    const message = {
-                        name,
-                        payload,
-                        type: 'event'
-                    };
-                    parentPort.postMessage(message);
-                };
-                return eventReporter;
-            }
-        }),
-        stream: new Proxy({}, {
-            get: (target, name)=>{
-                if (typeof name !== 'string') return target[name];
-                const streamReporter = {
-                    emit: (payload)=>{
-                        const message = {
-                            name,
-                            payload,
-                            type: 'emission'
-                        };
-                        parentPort.postMessage(message);
-                    },
-                    end: ()=>{
-                        const message = {
-                            name,
-                            type: 'end'
-                        };
-                        parentPort.postMessage(message);
-                    }
-                };
-                return streamReporter;
-            }
-        })
-    };
-}
-
-//# sourceMappingURL=workerChannels.js.map

package/dist/util/workerChannels.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/util/workerChannels.ts"],"sourcesContent":["import {type MessagePort, type Worker} from 'node:worker_threads'\n\ntype StreamReporter<TPayload = unknown> = {emit: (payload: TPayload) => void; end: () => void}\ntype EventReporter<TPayload = unknown> = (payload: TPayload) => void\ntype EventReceiver<TPayload = unknown> = () => Promise<TPayload>\ntype StreamReceiver<TPayload = unknown> = () => AsyncIterable<TPayload>\n\ntype EventKeys<TWorkerChannel extends WorkerChannel> = {\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  [K in keyof TWorkerChannel]: TWorkerChannel[K] extends WorkerChannelEvent<any> ? K : never\n}[keyof TWorkerChannel]\ntype StreamKeys<TWorkerChannel extends WorkerChannel> = {\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  [K in keyof TWorkerChannel]: TWorkerChannel[K] extends WorkerChannelStream<any> ? K : never\n}[keyof TWorkerChannel]\n\ntype EventMessage<TPayload = unknown> = {name: string; payload: TPayload; type: 'event'}\ntype StreamEmissionMessage<TPayload = unknown> = {name: string; payload: TPayload; type: 'emission'}\ntype StreamEndMessage = {name: string; type: 'end'}\ntype WorkerChannelMessage = EventMessage | StreamEmissionMessage | StreamEndMessage\n\n/**\n * Represents the definition of a \"worker channel\" to report progress from the\n * worker to the parent. Worker channels can define named events or streams and\n * the worker will report events and streams while the parent will await them.\n * This allows the control flow of the parent to follow the control flow of the\n * worker 1-to-1.\n */\nexport type WorkerChannel<\n  TWorkerChannel extends Record<\n    string,\n    WorkerChannelEvent<unknown> | WorkerChannelStream<unknown>\n  > = Record<string, WorkerChannelEvent<unknown> | WorkerChannelStream<unknown>>,\n> = TWorkerChannel\n\nexport type WorkerChannelEvent<TPayload = void> = {payload: TPayload; type: 'event'}\nexport type WorkerChannelStream<TPayload = void> = {\n  payload: TPayload\n  type: 'stream'\n}\n\ninterface WorkerChannelReporter<TWorkerChannel extends WorkerChannel> {\n  event: {\n    [K in EventKeys<TWorkerChannel>]: TWorkerChannel[K] extends WorkerChannelEvent<infer TPayload>\n      ? EventReporter<TPayload>\n      : void\n  }\n  stream: {\n    [K in StreamKeys<TWorkerChannel>]: TWorkerChannel[K] extends WorkerChannelStream<infer TPayload>\n      ? StreamReporter<TPayload>\n      : void\n  }\n}\n\nexport interface WorkerChannelReceiver<TWorkerChannel extends WorkerChannel> {\n  // TODO: good candidate for [Symbol.asyncDispose] when our tooling better supports it\n  dispose: () => Promise<number>\n  event: {\n    [K in EventKeys<TWorkerChannel>]: TWorkerChannel[K] extends WorkerChannelEvent<infer TPayload>\n      ? EventReceiver<TPayload>\n      : void\n  }\n  stream: {\n    [K in StreamKeys<TWorkerChannel>]: TWorkerChannel[K] extends WorkerChannelStream<infer TPayload>\n      ? StreamReceiver<TPayload>\n      : void\n  }\n}\n\n/**\n * A simple queue that has two primary methods: `push(message)` and\n * `await next()`. This message queue is used by the \"receiver\" of the worker\n * channel and this class handles buffering incoming messages if the worker is\n * producing faster than the parent as well as returning a promise if there is\n * no message yet in the queue when the parent awaits `next()`.\n */\nclass MessageQueue<T> {\n  queue: T[] = []\n  resolver: ((result: IteratorResult<T>) => void) | null = null\n\n  end() {\n    if (this.resolver) {\n      this.resolver({done: true, value: undefined})\n    }\n  }\n\n  next(): Promise<IteratorResult<T>> {\n    if (this.queue.length > 0) {\n      return Promise.resolve({done: false, value: this.queue.shift()!})\n    }\n\n    return new Promise((resolve) => (this.resolver = resolve))\n  }\n\n  push(message: T) {\n    if (this.resolver) {\n      this.resolver({done: false, value: message})\n      this.resolver = null\n    } else {\n      this.queue.push(message)\n    }\n  }\n}\n\nfunction isWorkerChannelMessage(message: unknown): message is WorkerChannelMessage {\n  if (typeof message !== 'object') return false\n  if (!message) return false\n  if (!('type' in message)) return false\n  if (typeof message.type !== 'string') return false\n  const types: string[] = ['event', 'emission', 'end'] satisfies WorkerChannelMessage['type'][]\n  return types.includes(message.type)\n}\n\n/**\n * Creates a \"worker channel receiver\" that subscribes to incoming messages\n * from the given worker and returns promises for worker channel events and\n * async iterators for worker channel streams.\n */\nexport function createReceiver<TWorkerChannel extends WorkerChannel>(\n  worker: Worker,\n): WorkerChannelReceiver<TWorkerChannel> {\n  const _events = new Map<string, MessageQueue<EventMessage>>()\n  const _streams = new Map<string, MessageQueue<StreamEmissionMessage>>()\n  const errors = new MessageQueue<{error: unknown; type: 'error'}>()\n\n  const eventQueue = (name: string) => {\n    const queue = _events.get(name) ?? new MessageQueue()\n    if (!_events.has(name)) _events.set(name, queue)\n    return queue\n  }\n\n  const streamQueue = (name: string) => {\n    const queue = _streams.get(name) ?? new MessageQueue()\n    if (!_streams.has(name)) _streams.set(name, queue)\n    return queue\n  }\n\n  const handleMessage = (message: unknown) => {\n    if (!isWorkerChannelMessage(message)) return\n    if (message.type === 'event') eventQueue(message.name).push(message)\n    if (message.type === 'emission') streamQueue(message.name).push(message)\n    if (message.type === 'end') streamQueue(message.name).end()\n  }\n\n  const handleError = (error: unknown) => {\n    errors.push({error, type: 'error'})\n  }\n\n  worker.addListener('message', handleMessage)\n  worker.addListener('error', handleError)\n\n  return {\n    dispose: () => {\n      worker.removeListener('message', handleMessage)\n      worker.removeListener('error', handleError)\n      return worker.terminate()\n    },\n    event: new Proxy({} as WorkerChannelReceiver<TWorkerChannel>['event'], {\n      get: (target, name) => {\n        if (typeof name !== 'string') return target[name as keyof typeof target]\n\n        const eventReceiver: EventReceiver = async () => {\n          const {value} = await Promise.race([eventQueue(name).next(), errors.next()])\n          if (value.type === 'error') throw value.error\n          return value.payload\n        }\n\n        return eventReceiver\n      },\n    }),\n    stream: new Proxy({} as WorkerChannelReceiver<TWorkerChannel>['stream'], {\n      get: (target, prop) => {\n        if (typeof prop !== 'string') return target[prop as keyof typeof target]\n        const name = prop // alias for better typescript narrowing\n\n        async function* streamReceiver() {\n          while (true) {\n            const {done, value} = await Promise.race([streamQueue(name).next(), errors.next()])\n            if (done) return\n            if (value.type === 'error') throw value.error\n            yield value.payload\n          }\n        }\n\n        return streamReceiver satisfies StreamReceiver\n      },\n    }),\n  }\n}\n\n/**\n * Creates a \"worker channel reporter\" that sends messages to the given\n * `parentPort` to be received by a worker channel receiver.\n */\nexport function createReporter<TWorkerChannel extends WorkerChannel>(\n  parentPort: MessagePort | null,\n): WorkerChannelReporter<TWorkerChannel> {\n  if (!parentPort) {\n    throw new Error('parentPart was falsy')\n  }\n\n  return {\n    event: new Proxy({} as WorkerChannelReporter<TWorkerChannel>['event'], {\n      get: (target, name) => {\n        if (typeof name !== 'string') return target[name as keyof typeof target]\n\n        const eventReporter: EventReporter = (payload) => {\n          const message: EventMessage = {name, payload, type: 'event'}\n          parentPort.postMessage(message)\n        }\n\n        return eventReporter\n      },\n    }),\n    stream: new Proxy({} as WorkerChannelReporter<TWorkerChannel>['stream'], {\n      get: (target, name) => {\n        if (typeof name !== 'string') return target[name as keyof typeof target]\n\n        const streamReporter: StreamReporter = {\n          emit: (payload) => {\n            const message: StreamEmissionMessage = {name, payload, type: 'emission'}\n            parentPort.postMessage(message)\n          },\n          end: () => {\n            const message: StreamEndMessage = {name, type: 'end'}\n            parentPort.postMessage(message)\n          },\n        }\n\n        return streamReporter\n      },\n    }),\n  }\n}\n"],"names":["MessageQueue","queue","resolver","end","done","value","undefined","next","length","Promise","resolve","shift","push","message","isWorkerChannelMessage","type","types","includes","createReceiver","worker","_events","Map","_streams","errors","eventQueue","name","get","has","set","streamQueue","handleMessage","handleError","error","addListener","dispose","removeListener","terminate","event","Proxy","target","eventReceiver","race","payload","stream","prop","streamReceiver","createReporter","parentPort","Error","eventReporter","postMessage","streamReporter","emit"],"mappings":"AAqEA;;;;;;CAMC,GACD,MAAMA;IACJC,QAAa,EAAE,CAAA;IACfC,WAAyD,KAAI;IAE7DC,MAAM;QACJ,IAAI,IAAI,CAACD,QAAQ,EAAE;YACjB,IAAI,CAACA,QAAQ,CAAC;gBAACE,MAAM;gBAAMC,OAAOC;YAAS;QAC7C;IACF;IAEAC,OAAmC;QACjC,IAAI,IAAI,CAACN,KAAK,CAACO,MAAM,GAAG,GAAG;YACzB,OAAOC,QAAQC,OAAO,CAAC;gBAACN,MAAM;gBAAOC,OAAO,IAAI,CAACJ,KAAK,CAACU,KAAK;YAAG;QACjE;QAEA,OAAO,IAAIF,QAAQ,CAACC,UAAa,IAAI,CAACR,QAAQ,GAAGQ;IACnD;IAEAE,KAAKC,OAAU,EAAE;QACf,IAAI,IAAI,CAACX,QAAQ,EAAE;YACjB,IAAI,CAACA,QAAQ,CAAC;gBAACE,MAAM;gBAAOC,OAAOQ;YAAO;YAC1C,IAAI,CAACX,QAAQ,GAAG;QAClB,OAAO;YACL,IAAI,CAACD,KAAK,CAACW,IAAI,CAACC;QAClB;IACF;AACF;AAEA,SAASC,uBAAuBD,OAAgB;IAC9C,IAAI,OAAOA,YAAY,UAAU,OAAO;IACxC,IAAI,CAACA,SAAS,OAAO;IACrB,IAAI,CAAE,CAAA,UAAUA,OAAM,GAAI,OAAO;IACjC,IAAI,OAAOA,QAAQE,IAAI,KAAK,UAAU,OAAO;IAC7C,MAAMC,QAAkB;QAAC;QAAS;QAAY;KAAM;IACpD,OAAOA,MAAMC,QAAQ,CAACJ,QAAQE,IAAI;AACpC;AAEA;;;;CAIC,GACD,OAAO,SAASG,eACdC,MAAc;IAEd,MAAMC,UAAU,IAAIC;IACpB,MAAMC,WAAW,IAAID;IACrB,MAAME,SAAS,IAAIvB;IAEnB,MAAMwB,aAAa,CAACC;QAClB,MAAMxB,QAAQmB,QAAQM,GAAG,CAACD,SAAS,IAAIzB;QACvC,IAAI,CAACoB,QAAQO,GAAG,CAACF,OAAOL,QAAQQ,GAAG,CAACH,MAAMxB;QAC1C,OAAOA;IACT;IAEA,MAAM4B,cAAc,CAACJ;QACnB,MAAMxB,QAAQqB,SAASI,GAAG,CAACD,SAAS,IAAIzB;QACxC,IAAI,CAACsB,SAASK,GAAG,CAACF,OAAOH,SAASM,GAAG,CAACH,MAAMxB;QAC5C,OAAOA;IACT;IAEA,MAAM6B,gBAAgB,CAACjB;QACrB,IAAI,CAACC,uBAAuBD,UAAU;QACtC,IAAIA,QAAQE,IAAI,KAAK,SAASS,WAAWX,QAAQY,IAAI,EAAEb,IAAI,CAACC;QAC5D,IAAIA,QAAQE,IAAI,KAAK,YAAYc,YAAYhB,QAAQY,IAAI,EAAEb,IAAI,CAACC;QAChE,IAAIA,QAAQE,IAAI,KAAK,OAAOc,YAAYhB,QAAQY,IAAI,EAAEtB,GAAG;IAC3D;IAEA,MAAM4B,cAAc,CAACC;QACnBT,OAAOX,IAAI,CAAC;YAACoB;YAAOjB,MAAM;QAAO;IACnC;IAEAI,OAAOc,WAAW,CAAC,WAAWH;IAC9BX,OAAOc,WAAW,CAAC,SAASF;IAE5B,OAAO;QACLG,SAAS;YACPf,OAAOgB,cAAc,CAAC,WAAWL;YACjCX,OAAOgB,cAAc,CAAC,SAASJ;YAC/B,OAAOZ,OAAOiB,SAAS;QACzB;QACAC,OAAO,IAAIC,MAAM,CAAC,GAAqD;YACrEZ,KAAK,CAACa,QAAQd;gBACZ,IAAI,OAAOA,SAAS,UAAU,OAAOc,MAAM,CAACd,KAA4B;gBAExE,MAAMe,gBAA+B;oBACnC,MAAM,EAACnC,KAAK,EAAC,GAAG,MAAMI,QAAQgC,IAAI,CAAC;wBAACjB,WAAWC,MAAMlB,IAAI;wBAAIgB,OAAOhB,IAAI;qBAAG;oBAC3E,IAAIF,MAAMU,IAAI,KAAK,SAAS,MAAMV,MAAM2B,KAAK;oBAC7C,OAAO3B,MAAMqC,OAAO;gBACtB;gBAEA,OAAOF;YACT;QACF;QACAG,QAAQ,IAAIL,MAAM,CAAC,GAAsD;YACvEZ,KAAK,CAACa,QAAQK;gBACZ,IAAI,OAAOA,SAAS,UAAU,OAAOL,MAAM,CAACK,KAA4B;gBACxE,MAAMnB,OAAOmB,KAAK,wCAAwC;;gBAE1D,gBAAgBC;oBACd,MAAO,KAAM;wBACX,MAAM,EAACzC,IAAI,EAAEC,KAAK,EAAC,GAAG,MAAMI,QAAQgC,IAAI,CAAC;4BAACZ,YAAYJ,MAAMlB,IAAI;4BAAIgB,OAAOhB,IAAI;yBAAG;wBAClF,IAAIH,MAAM;wBACV,IAAIC,MAAMU,IAAI,KAAK,SAAS,MAAMV,MAAM2B,KAAK;wBAC7C,MAAM3B,MAAMqC,OAAO;oBACrB;gBACF;gBAEA,OAAOG;YACT;QACF;IACF;AACF;AAEA;;;CAGC,GACD,OAAO,SAASC,eACdC,UAA8B;IAE9B,IAAI,CAACA,YAAY;QACf,MAAM,IAAIC,MAAM;IAClB;IAEA,OAAO;QACLX,OAAO,IAAIC,MAAM,CAAC,GAAqD;YACrEZ,KAAK,CAACa,QAAQd;gBACZ,IAAI,OAAOA,SAAS,UAAU,OAAOc,MAAM,CAACd,KAA4B;gBAExE,MAAMwB,gBAA+B,CAACP;oBACpC,MAAM7B,UAAwB;wBAACY;wBAAMiB;wBAAS3B,MAAM;oBAAO;oBAC3DgC,WAAWG,WAAW,CAACrC;gBACzB;gBAEA,OAAOoC;YACT;QACF;QACAN,QAAQ,IAAIL,MAAM,CAAC,GAAsD;YACvEZ,KAAK,CAACa,QAAQd;gBACZ,IAAI,OAAOA,SAAS,UAAU,OAAOc,MAAM,CAACd,KAA4B;gBAExE,MAAM0B,iBAAiC;oBACrCC,MAAM,CAACV;wBACL,MAAM7B,UAAiC;4BAACY;4BAAMiB;4BAAS3B,MAAM;wBAAU;wBACvEgC,WAAWG,WAAW,CAACrC;oBACzB;oBACAV,KAAK;wBACH,MAAMU,UAA4B;4BAACY;4BAAMV,MAAM;wBAAK;wBACpDgC,WAAWG,WAAW,CAACrC;oBACzB;gBACF;gBAEA,OAAOsC;YACT;QACF;IACF;AACF"}