@sanity/workbench-cli 1.8.0 → 1.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workbench-cli",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "Internal implementation detail of the Sanity CLI's unstable workbench support. Not intended for direct use.",
   "homepage": "https://github.com/sanity-io/cli",
   "bugs": "https://github.com/sanity-io/cli/issues",
@@ -53,17 +53,18 @@
     "access": "public"
   },
   "dependencies": {
-    "@module-federation/vite": "1.19.1",
+    "@module-federation/vite": "1.20.1",
+    "@sanity/types": "^6.7.0",
     "@vitejs/plugin-react": "^6.0.3",
     "form-data": "^4.0.5",
     "tar-fs": "^3.1.2",
     "vite": "^8.1.5",
     "zod": "^4.4.3",
-    "@sanity/cli-core": "^2.7.0"
+    "@sanity/cli-core": "^2.8.0"
   },
   "devDependencies": {
     "@eslint/compat": "^2.1.0",
-    "@sanity/pkg-utils": "^11.0.9",
+    "@sanity/pkg-utils": "^11.0.17",
     "@swc/cli": "^0.8.1",
     "@swc/core": "^1.15.43",
     "@types/node": "^22.20.0",

package/dist/actions/deploy/buildExposes.js

@@ -1,72 +0,0 @@
-import { interfaceModuleId } from '../../contract.js';
-/**
- * The interface records deploy sends: the app view (only when `exposesAppView`),
- * every view, and every service.
- * @internal
- */ export function buildExposes(exposes, { appName, appTitle, exposesAppView, version }) {
-    const records = [];
-    if (exposesAppView) {
-        records.push({
-            metadata: null,
-            moduleId: interfaceModuleId('app', appName),
-            name: appName,
-            title: appTitle,
-            type: 'app',
-            version
-        });
-    }
-    for (const view of exposes.views ?? []){
-        records.push({
-            metadata: null,
-            moduleId: interfaceModuleId('panel', view.name),
-            name: view.name,
-            title: view.title ?? view.name,
-            type: 'panel',
-            version
-        });
-    }
-    for (const service of exposes.services ?? []){
-        records.push({
-            metadata: null,
-            moduleId: interfaceModuleId('worker', service.name),
-            name: service.name,
-            title: service.title ?? service.name,
-            type: 'worker',
-            version
-        });
-    }
-    return records;
-}
-const label = (item)=>item.title === item.name ? item.name : `${item.title} (${item.name})`;
-/**
- * One `Title (name): src` report line per declared entry point.
- * @internal
- */ export function summarizeExposeGroup(heading, items) {
-    return `${heading}:\n${items.map((item)=>`  ${label(item)}: ${item.src}`).join('\n')}`;
-}
-/**
- * The deploy summary of an app's exposes: the structured records (for `--json`)
- * and one report line per non-empty group (for the human report).
- * @internal
- */ export function summarizeExposes({ services, views }) {
-    const toExpose = (decl)=>({
-            name: decl.name,
-            src: decl.src,
-            title: decl.title ?? decl.name,
-            type: decl.type
-        });
-    const viewExposes = (views ?? []).map((view)=>toExpose(view));
-    const serviceExposes = (services ?? []).map((service)=>toExpose(service));
-    const lines = [];
-    if (viewExposes.length > 0) lines.push(summarizeExposeGroup('Views', viewExposes));
-    if (serviceExposes.length > 0) lines.push(summarizeExposeGroup('Services', serviceExposes));
-    return {
-        exposes: [
-            ...viewExposes,
-            ...serviceExposes
-        ],
-        lines
-    };
-}
-
-//# sourceMappingURL=buildExposes.js.map

package/dist/actions/deploy/buildExposes.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/actions/deploy/buildExposes.ts"],"sourcesContent":["import {interfaceModuleId} from '../../contract.js'\nimport {type WorkbenchExposes} from '../../resolveWorkbenchApp.js'\nimport {type BrettInterface} from '../../services/applications.js'\n\ninterface BuildExposesContext {\n  appName: string\n  appTitle: string\n  /** Whether the build exposes the app view (`./App`) — apps with an `entry`, and every studio. */\n  exposesAppView: boolean\n  version: string\n}\n\n/**\n * The interface records deploy sends: the app view (only when `exposesAppView`),\n * every view, and every service.\n * @internal\n */\nexport function buildExposes(\n  exposes: WorkbenchExposes,\n  {appName, appTitle, exposesAppView, version}: BuildExposesContext,\n): BrettInterface[] {\n  const records: BrettInterface[] = []\n  if (exposesAppView) {\n    records.push({\n      metadata: null,\n      moduleId: interfaceModuleId('app', appName),\n      name: appName,\n      title: appTitle,\n      type: 'app',\n      version,\n    })\n  }\n  for (const view of exposes.views ?? []) {\n    records.push({\n      metadata: null,\n      moduleId: interfaceModuleId('panel', view.name),\n      name: view.name,\n      title: view.title ?? view.name,\n      type: 'panel',\n      version,\n    })\n  }\n  for (const service of exposes.services ?? []) {\n    records.push({\n      metadata: null,\n      moduleId: interfaceModuleId('worker', service.name),\n      name: service.name,\n      title: service.title ?? service.name,\n      type: 'worker',\n      version,\n    })\n  }\n  return records\n}\n\n/** A view or service as the deploy report and `--json` output surface it. */\nexport interface DeployedExpose {\n  name: string\n  src: string\n  title: string\n  type: string\n}\n\nconst label = (item: {name: string; title: string}) =>\n  item.title === item.name ? item.name : `${item.title} (${item.name})`\n\n/**\n * One `Title (name): src` report line per declared entry point.\n * @internal\n */\nexport function summarizeExposeGroup(\n  heading: string,\n  items: readonly {name: string; src: string; title: string}[],\n): string {\n  return `${heading}:\\n${items.map((item) => `  ${label(item)}: ${item.src}`).join('\\n')}`\n}\n\n/**\n * The deploy summary of an app's exposes: the structured records (for `--json`)\n * and one report line per non-empty group (for the human report).\n * @internal\n */\nexport function summarizeExposes({services, views}: WorkbenchExposes): {\n  exposes: DeployedExpose[]\n  lines: string[]\n} {\n  const toExpose = (decl: {\n    name: string\n    src: string\n    title?: string\n    type: string\n  }): DeployedExpose => ({\n    name: decl.name,\n    src: decl.src,\n    title: decl.title ?? decl.name,\n    type: decl.type,\n  })\n  const viewExposes = (views ?? []).map((view) => toExpose(view))\n  const serviceExposes = (services ?? []).map((service) => toExpose(service))\n\n  const lines: string[] = []\n  if (viewExposes.length > 0) lines.push(summarizeExposeGroup('Views', viewExposes))\n  if (serviceExposes.length > 0) lines.push(summarizeExposeGroup('Services', serviceExposes))\n  return {exposes: [...viewExposes, ...serviceExposes], lines}\n}\n"],"names":["interfaceModuleId","buildExposes","exposes","appName","appTitle","exposesAppView","version","records","push","metadata","moduleId","name","title","type","view","views","service","services","label","item","summarizeExposeGroup","heading","items","map","src","join","summarizeExposes","toExpose","decl","viewExposes","serviceExposes","lines","length"],"mappings":"AAAA,SAAQA,iBAAiB,QAAO,oBAAmB;AAYnD;;;;CAIC,GACD,OAAO,SAASC,aACdC,OAAyB,EACzB,EAACC,OAAO,EAAEC,QAAQ,EAAEC,cAAc,EAAEC,OAAO,EAAsB;IAEjE,MAAMC,UAA4B,EAAE;IACpC,IAAIF,gBAAgB;QAClBE,QAAQC,IAAI,CAAC;YACXC,UAAU;YACVC,UAAUV,kBAAkB,OAAOG;YACnCQ,MAAMR;YACNS,OAAOR;YACPS,MAAM;YACNP;QACF;IACF;IACA,KAAK,MAAMQ,QAAQZ,QAAQa,KAAK,IAAI,EAAE,CAAE;QACtCR,QAAQC,IAAI,CAAC;YACXC,UAAU;YACVC,UAAUV,kBAAkB,SAASc,KAAKH,IAAI;YAC9CA,MAAMG,KAAKH,IAAI;YACfC,OAAOE,KAAKF,KAAK,IAAIE,KAAKH,IAAI;YAC9BE,MAAM;YACNP;QACF;IACF;IACA,KAAK,MAAMU,WAAWd,QAAQe,QAAQ,IAAI,EAAE,CAAE;QAC5CV,QAAQC,IAAI,CAAC;YACXC,UAAU;YACVC,UAAUV,kBAAkB,UAAUgB,QAAQL,IAAI;YAClDA,MAAMK,QAAQL,IAAI;YAClBC,OAAOI,QAAQJ,KAAK,IAAII,QAAQL,IAAI;YACpCE,MAAM;YACNP;QACF;IACF;IACA,OAAOC;AACT;AAUA,MAAMW,QAAQ,CAACC,OACbA,KAAKP,KAAK,KAAKO,KAAKR,IAAI,GAAGQ,KAAKR,IAAI,GAAG,GAAGQ,KAAKP,KAAK,CAAC,EAAE,EAAEO,KAAKR,IAAI,CAAC,CAAC,CAAC;AAEvE;;;CAGC,GACD,OAAO,SAASS,qBACdC,OAAe,EACfC,KAA4D;IAE5D,OAAO,GAAGD,QAAQ,GAAG,EAAEC,MAAMC,GAAG,CAAC,CAACJ,OAAS,CAAC,EAAE,EAAED,MAAMC,MAAM,EAAE,EAAEA,KAAKK,GAAG,EAAE,EAAEC,IAAI,CAAC,OAAO;AAC1F;AAEA;;;;CAIC,GACD,OAAO,SAASC,iBAAiB,EAACT,QAAQ,EAAEF,KAAK,EAAmB;IAIlE,MAAMY,WAAW,CAACC,OAKK,CAAA;YACrBjB,MAAMiB,KAAKjB,IAAI;YACfa,KAAKI,KAAKJ,GAAG;YACbZ,OAAOgB,KAAKhB,KAAK,IAAIgB,KAAKjB,IAAI;YAC9BE,MAAMe,KAAKf,IAAI;QACjB,CAAA;IACA,MAAMgB,cAAc,AAACd,CAAAA,SAAS,EAAE,AAAD,EAAGQ,GAAG,CAAC,CAACT,OAASa,SAASb;IACzD,MAAMgB,iBAAiB,AAACb,CAAAA,YAAY,EAAE,AAAD,EAAGM,GAAG,CAAC,CAACP,UAAYW,SAASX;IAElE,MAAMe,QAAkB,EAAE;IAC1B,IAAIF,YAAYG,MAAM,GAAG,GAAGD,MAAMvB,IAAI,CAACY,qBAAqB,SAASS;IACrE,IAAIC,eAAeE,MAAM,GAAG,GAAGD,MAAMvB,IAAI,CAACY,qBAAqB,YAAYU;IAC3E,OAAO;QAAC5B,SAAS;eAAI2B;eAAgBC;SAAe;QAAEC;IAAK;AAC7D"}

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

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/actions/dev/deriveInterfaces.ts"],"sourcesContent":["import {type CliConfig} from '@sanity/cli-core'\n\nimport {\n  interfaceModuleId,\n  MEDIA_LIBRARY_CONFIG_CONTRACT_VERSION,\n  SERVICE_CONTRACT_VERSION,\n  VIEW_CONTRACT_VERSION,\n} from '../../contract.js'\nimport {isWorkbenchApp, readConfig} from '../../defineApp.js'\nimport {FEDERATION_FILE_NAME, RUNTIME_DIR} from '../build/vite/constants.js'\nimport {type DevServerManifest} from './registry.js'\n\n/** What a studio exposes as `./App` — the generated entry that renders `sanity.config.ts`. */\nconst GENERATED_ENTRY = `./${RUNTIME_DIR}/${FEDERATION_FILE_NAME}.jsx`\n\n/** One forwarded interface record on the dev-server registry entry. */\nexport type DevServerInterface = NonNullable<DevServerManifest['interfaces']>[number]\n\n/** One forwarded config on the dev-server registry entry. */\nexport type DevServerConfig = NonNullable<DevServerManifest['configs']>[number]\n\n/**\n * Map a workbench app's declarations to its registry interface records. A studio\n * that declares `entry` is rejected (studio app views aren't implemented yet).\n */\nexport function deriveInterfaces(\n  app: CliConfig['app'],\n  options: {isApp: boolean},\n): DevServerInterface[] | undefined {\n  if (!isWorkbenchApp(app)) return undefined\n\n  if (!options.isApp && app.entry !== undefined) {\n    throw new Error('App views for studios are not implemented yet')\n  }\n\n  const interfaceId = (type: string, name: string): string => `${app.name}-${type}-${name}`\n\n  const views = (app.views ?? []).map(\n    (view): DevServerInterface => ({\n      id: interfaceId('panel', view.name),\n      metadata: null,\n      moduleId: interfaceModuleId('panel', view.name),\n      name: view.name,\n      src: view.src,\n      title: view.title ?? view.name,\n      type: 'panel',\n      version: String(VIEW_CONTRACT_VERSION),\n    }),\n  )\n\n  const services = (app.services ?? []).map(\n    (service): DevServerInterface => ({\n      id: interfaceId('worker', service.name),\n      metadata: null,\n      moduleId: interfaceModuleId('worker', service.name),\n      name: service.name,\n      src: service.src,\n      title: service.title ?? service.name,\n      type: 'worker',\n      version: String(SERVICE_CONTRACT_VERSION),\n    }),\n  )\n\n  // Tracks what the build exposes as `./App`: an app's declared `entry`, and a\n  // studio's generated entry. A dock-only app (no `entry`) exposes none.\n  const appEntry = options.isApp ? app.entry : GENERATED_ENTRY\n\n  const appView: DevServerInterface[] =\n    appEntry === undefined\n      ? []\n      : [\n          {\n            id: interfaceId('app', app.name),\n            metadata: null,\n            moduleId: interfaceModuleId('app', app.name),\n            name: app.name,\n            src: appEntry,\n            title: app.title,\n            type: 'app',\n          },\n        ]\n\n  return [...views, ...services, ...appView]\n}\n\n/**\n * The named source files a config's generated module is built from, dispatched\n * per app type — the projection the exposes-set id keys on, so the generic HMR\n * tracker owns none of the per-type shape. Throws on an app type it can't\n * handle, so a new config family has to register its shape here.\n */\nexport function deriveConfigEntries(config: DevServerConfig): {name: string; src: string}[] {\n  switch (config.appType) {\n    case 'media-library': {\n      return config.fields.map((field) => ({name: field.name, src: field.src}))\n    }\n    default: {\n      throw new Error(`Cannot derive entries for unknown config appType: ${config.appType}`)\n    }\n  }\n}\n\n/**\n * The fields' schema *values* can't serialize — the workbench loads them from\n * the federation module. `src` stays on so the exposes-set id keys on it and a\n * repoint rebuilds. `appType` routes the config to the singleton (no app id to\n * key on). `id` is a content hash of the entry — it fills the\n * installation-config id slot deployed apps get from the applications API,\n * and the workbench keys change detection on it. `version` is a string, like\n * the one Brett returns on a deployed `activeConfig`.\n */\nexport async function deriveConfigs(app: CliConfig['app']): Promise<DevServerConfig[]> {\n  if (!isWorkbenchApp(app)) return []\n  const config = readConfig(app)\n  if (!config) return []\n  const entry = {\n    appType: config.appType,\n    fields: config.fields.map((field) => ({\n      name: field.name,\n      public: field.public,\n      src: field.src,\n      title: field.title,\n    })),\n    moduleName: app.name,\n    version: String(MEDIA_LIBRARY_CONFIG_CONTRACT_VERSION),\n  }\n  return [{...entry, id: await contentHash(JSON.stringify(entry))}]\n}\n\n/**\n * SHA-256 of a string, as hex, via the Web Crypto API — available in both Node\n * and the browser. `node:crypto` can't be used: the Vite dev server's dep scan\n * pulls this module into the browser graph.\n */\nasync function contentHash(input: string): Promise<string> {\n  // eslint-disable-next-line n/no-unsupported-features/node-builtins -- the Web Crypto global is available on our Node target and in the browser\n  const digest = await globalThis.crypto.subtle.digest('SHA-256', new TextEncoder().encode(input))\n  return Array.from(new Uint8Array(digest), (byte) => byte.toString(16).padStart(2, '0')).join('')\n}\n"],"names":["interfaceModuleId","MEDIA_LIBRARY_CONFIG_CONTRACT_VERSION","SERVICE_CONTRACT_VERSION","VIEW_CONTRACT_VERSION","isWorkbenchApp","readConfig","FEDERATION_FILE_NAME","RUNTIME_DIR","GENERATED_ENTRY","deriveInterfaces","app","options","undefined","isApp","entry","Error","interfaceId","type","name","views","map","view","id","metadata","moduleId","src","title","version","String","services","service","appEntry","appView","deriveConfigEntries","config","appType","fields","field","deriveConfigs","public","moduleName","contentHash","JSON","stringify","input","digest","globalThis","crypto","subtle","TextEncoder","encode","Array","from","Uint8Array","byte","toString","padStart","join"],"mappings":"AAEA,SACEA,iBAAiB,EACjBC,qCAAqC,EACrCC,wBAAwB,EACxBC,qBAAqB,QAChB,oBAAmB;AAC1B,SAAQC,cAAc,EAAEC,UAAU,QAAO,qBAAoB;AAC7D,SAAQC,oBAAoB,EAAEC,WAAW,QAAO,6BAA4B;AAG5E,4FAA4F,GAC5F,MAAMC,kBAAkB,CAAC,EAAE,EAAED,YAAY,CAAC,EAAED,qBAAqB,IAAI,CAAC;AAQtE;;;CAGC,GACD,OAAO,SAASG,iBACdC,GAAqB,EACrBC,OAAyB;IAEzB,IAAI,CAACP,eAAeM,MAAM,OAAOE;IAEjC,IAAI,CAACD,QAAQE,KAAK,IAAIH,IAAII,KAAK,KAAKF,WAAW;QAC7C,MAAM,IAAIG,MAAM;IAClB;IAEA,MAAMC,cAAc,CAACC,MAAcC,OAAyB,GAAGR,IAAIQ,IAAI,CAAC,CAAC,EAAED,KAAK,CAAC,EAAEC,MAAM;IAEzF,MAAMC,QAAQ,AAACT,CAAAA,IAAIS,KAAK,IAAI,EAAE,AAAD,EAAGC,GAAG,CACjC,CAACC,OAA8B,CAAA;YAC7BC,IAAIN,YAAY,SAASK,KAAKH,IAAI;YAClCK,UAAU;YACVC,UAAUxB,kBAAkB,SAASqB,KAAKH,IAAI;YAC9CA,MAAMG,KAAKH,IAAI;YACfO,KAAKJ,KAAKI,GAAG;YACbC,OAAOL,KAAKK,KAAK,IAAIL,KAAKH,IAAI;YAC9BD,MAAM;YACNU,SAASC,OAAOzB;QAClB,CAAA;IAGF,MAAM0B,WAAW,AAACnB,CAAAA,IAAImB,QAAQ,IAAI,EAAE,AAAD,EAAGT,GAAG,CACvC,CAACU,UAAiC,CAAA;YAChCR,IAAIN,YAAY,UAAUc,QAAQZ,IAAI;YACtCK,UAAU;YACVC,UAAUxB,kBAAkB,UAAU8B,QAAQZ,IAAI;YAClDA,MAAMY,QAAQZ,IAAI;YAClBO,KAAKK,QAAQL,GAAG;YAChBC,OAAOI,QAAQJ,KAAK,IAAII,QAAQZ,IAAI;YACpCD,MAAM;YACNU,SAASC,OAAO1B;QAClB,CAAA;IAGF,6EAA6E;IAC7E,uEAAuE;IACvE,MAAM6B,WAAWpB,QAAQE,KAAK,GAAGH,IAAII,KAAK,GAAGN;IAE7C,MAAMwB,UACJD,aAAanB,YACT,EAAE,GACF;QACE;YACEU,IAAIN,YAAY,OAAON,IAAIQ,IAAI;YAC/BK,UAAU;YACVC,UAAUxB,kBAAkB,OAAOU,IAAIQ,IAAI;YAC3CA,MAAMR,IAAIQ,IAAI;YACdO,KAAKM;YACLL,OAAOhB,IAAIgB,KAAK;YAChBT,MAAM;QACR;KACD;IAEP,OAAO;WAAIE;WAAUU;WAAaG;KAAQ;AAC5C;AAEA;;;;;CAKC,GACD,OAAO,SAASC,oBAAoBC,MAAuB;IACzD,OAAQA,OAAOC,OAAO;QACpB,KAAK;YAAiB;gBACpB,OAAOD,OAAOE,MAAM,CAAChB,GAAG,CAAC,CAACiB,QAAW,CAAA;wBAACnB,MAAMmB,MAAMnB,IAAI;wBAAEO,KAAKY,MAAMZ,GAAG;oBAAA,CAAA;YACxE;QACA;YAAS;gBACP,MAAM,IAAIV,MAAM,CAAC,kDAAkD,EAAEmB,OAAOC,OAAO,EAAE;YACvF;IACF;AACF;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAeG,cAAc5B,GAAqB;IACvD,IAAI,CAACN,eAAeM,MAAM,OAAO,EAAE;IACnC,MAAMwB,SAAS7B,WAAWK;IAC1B,IAAI,CAACwB,QAAQ,OAAO,EAAE;IACtB,MAAMpB,QAAQ;QACZqB,SAASD,OAAOC,OAAO;QACvBC,QAAQF,OAAOE,MAAM,CAAChB,GAAG,CAAC,CAACiB,QAAW,CAAA;gBACpCnB,MAAMmB,MAAMnB,IAAI;gBAChBqB,QAAQF,MAAME,MAAM;gBACpBd,KAAKY,MAAMZ,GAAG;gBACdC,OAAOW,MAAMX,KAAK;YACpB,CAAA;QACAc,YAAY9B,IAAIQ,IAAI;QACpBS,SAASC,OAAO3B;IAClB;IACA,OAAO;QAAC;YAAC,GAAGa,KAAK;YAAEQ,IAAI,MAAMmB,YAAYC,KAAKC,SAAS,CAAC7B;QAAO;KAAE;AACnE;AAEA;;;;CAIC,GACD,eAAe2B,YAAYG,KAAa;IACtC,+IAA+I;IAC/I,MAAMC,SAAS,MAAMC,WAAWC,MAAM,CAACC,MAAM,CAACH,MAAM,CAAC,WAAW,IAAII,cAAcC,MAAM,CAACN;IACzF,OAAOO,MAAMC,IAAI,CAAC,IAAIC,WAAWR,SAAS,CAACS,OAASA,KAAKC,QAAQ,CAAC,IAAIC,QAAQ,CAAC,GAAG,MAAMC,IAAI,CAAC;AAC/F"}