@sanity/workbench-cli 1.3.0 → 1.4.0

package/dist/actions/undeploy/workbenchUndeployAdapter.js

@@ -0,0 +1,150 @@
+import { deleteApplication, getApplication, getApplicationUrl, getWorkbenchUrl } from '../../services/applications.js';
+import { deleteConfig, listConfigs } from '../../services/installations.js';
+import { summarizeExposes } from '../deploy/buildExposes.js';
+import { resolveInstallationId, summarizeConfig } from '../deploy/deployConfig.js';
+/**
+ * The undeploy adapter for workbench apps, mirroring what a workbench deploy
+ * creates: apps that expose interfaces delete their Brett application (the
+ * server soft-deletes its deployments and refuses singletons with active
+ * installations); a singleton without interfaces — the media library — deletes
+ * its installation's config snapshots instead.
+ */ export function createWorkbenchUndeployAdapter(options) {
+    const { appId, organizationId, type, workbench } = options;
+    // Keyed on singleton-ness, not on a locally declared config, so an undeploy
+    // still reaches the server's config snapshots after the fields are removed
+    // from sanity.cli.ts.
+    const configOnly = !!workbench.isSingleton && !workbench.hasInterfaces;
+    // Workbench-internal, so kept off the reported target; resolveTarget stashes it for the delete.
+    let installationId;
+    return {
+        resolveTarget: async ()=>{
+            if (!configOnly) return resolveApplicationTarget({
+                appId,
+                type,
+                workbench
+            });
+            const resolved = await resolveConfigTarget({
+                organizationId,
+                workbench
+            });
+            installationId = resolved.installationId;
+            return resolved.resolution;
+        },
+        type,
+        async undeploy (target) {
+            if (target.deletes === 'config') {
+                if (!installationId) throw new Error('No installation resolved for the config undeploy');
+                for (const snapshot of target.configs){
+                    await deleteConfig(installationId, snapshot.id);
+                }
+                return;
+            }
+            await deleteApplication(target.id);
+        }
+    };
+}
+async function resolveApplicationTarget({ appId, type, workbench }) {
+    if (!appId) {
+        return {
+            message: 'No `deployment.appId` configured',
+            solution: 'Add `deployment.appId` to sanity.cli.ts',
+            type: 'none'
+        };
+    }
+    const application = await getApplication(appId);
+    if (!application) {
+        return {
+            message: 'Application with the given ID does not exist',
+            type: 'none'
+        };
+    }
+    const { exposes, lines } = summarizeExposes(workbench);
+    return {
+        target: {
+            activeDeployment: null,
+            appHost: application.slug,
+            createdAt: null,
+            deletes: 'application',
+            id: application.id,
+            interfaces: exposes,
+            organizationId: application.organizationId,
+            projectId: null,
+            summary: [
+                ...lines,
+                ...workbench.isSingleton === undefined ? [] : [
+                    `Singleton: ${workbench.isSingleton}`
+                ]
+            ],
+            title: application.title,
+            type,
+            url: getApplicationUrl({
+                ...application,
+                type
+            })
+        },
+        type: 'found'
+    };
+}
+async function resolveConfigTarget({ organizationId, workbench }) {
+    const config = workbench.config;
+    const appType = config?.appType ?? workbench.applicationType;
+    if (!appType) throw new Error('The app declares no app type to resolve its installation');
+    if (!organizationId) {
+        throw new Error('sanity.cli.ts does not contain an organization identifier ("app.organizationId"), which is required to resolve the installation');
+    }
+    const installationId = await resolveInstallationId({
+        appType,
+        organizationId
+    });
+    if (!installationId) {
+        return {
+            resolution: {
+                message: `No active "${appType}" installation for organization "${organizationId}"`,
+                type: 'none'
+            }
+        };
+    }
+    const configs = await listConfigs(installationId);
+    if (configs.length === 0) {
+        return {
+            installationId,
+            resolution: {
+                message: `No deployed config for the "${appType}" installation`,
+                type: 'none'
+            }
+        };
+    }
+    // At most one snapshot is active (served); the rest are deactivated history.
+    const active = configs.find((snapshot)=>snapshot.isActive);
+    return {
+        installationId,
+        resolution: {
+            target: {
+                activeDeployment: active ? {
+                    deployedAt: active.createdAt ?? '',
+                    deployedBy: active.deployedBy ?? ''
+                } : null,
+                appHost: null,
+                configs: configs.map((snapshot)=>({
+                        createdAt: snapshot.createdAt ?? null,
+                        deployedBy: snapshot.deployedBy ?? null,
+                        id: snapshot.id
+                    })),
+                createdAt: configs.at(-1)?.createdAt ?? null,
+                deletes: 'config',
+                id: null,
+                organizationId,
+                projectId: null,
+                summary: config ? [
+                    summarizeConfig(config)
+                ] : undefined,
+                title: workbench.name,
+                type: 'coreApp',
+                url: getWorkbenchUrl(organizationId)
+            },
+            type: 'found'
+        }
+    };
+}
+
+//# sourceMappingURL=workbenchUndeployAdapter.js.map

package/dist/actions/undeploy/workbenchUndeployAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/actions/undeploy/workbenchUndeployAdapter.ts"],"sourcesContent":["import {\n  type UndeployAdapter,\n  type UndeployApplicationTarget,\n  type UndeployConfigTarget,\n  type UndeployTargetResolution,\n} from '@sanity/cli-core/undeploy'\n\nimport {\n  deleteApplication,\n  getApplication,\n  getApplicationUrl,\n  getWorkbenchUrl,\n} from '../../services/applications.js'\nimport {deleteConfig, listConfigs} from '../../services/installations.js'\nimport {type DeployedExpose, summarizeExposes} from '../deploy/buildExposes.js'\nimport {resolveInstallationId, summarizeConfig} from '../deploy/deployConfig.js'\nimport {type DeployableWorkbenchApp} from '../deploy/getWorkbench.js'\n\n/** The workbench extension of the shared target; serializes into `--json` as-is. */\nexport type WorkbenchUndeployTarget =\n  | (UndeployApplicationTarget & {\n      /** Interfaces (views and services) registered by the application. */\n      interfaces: DeployedExpose[]\n    })\n  | (UndeployConfigTarget & {\n      /** The deployed config snapshots an undeploy deletes. */\n      configs: {\n        createdAt: string | null\n        deployedBy: string | null\n        id: string\n      }[]\n    })\n\n/**\n * The undeploy adapter for workbench apps, mirroring what a workbench deploy\n * creates: apps that expose interfaces delete their Brett application (the\n * server soft-deletes its deployments and refuses singletons with active\n * installations); a singleton without interfaces — the media library — deletes\n * its installation's config snapshots instead.\n */\nexport function createWorkbenchUndeployAdapter(options: {\n  appId: string | undefined\n  organizationId: string | undefined\n  type: 'coreApp' | 'studio'\n  workbench: DeployableWorkbenchApp\n}): UndeployAdapter<WorkbenchUndeployTarget> {\n  const {appId, organizationId, type, workbench} = options\n  // Keyed on singleton-ness, not on a locally declared config, so an undeploy\n  // still reaches the server's config snapshots after the fields are removed\n  // from sanity.cli.ts.\n  const configOnly = !!workbench.isSingleton && !workbench.hasInterfaces\n  // Workbench-internal, so kept off the reported target; resolveTarget stashes it for the delete.\n  let installationId: string | undefined\n\n  return {\n    resolveTarget: async () => {\n      if (!configOnly) return resolveApplicationTarget({appId, type, workbench})\n      const resolved = await resolveConfigTarget({organizationId, workbench})\n      installationId = resolved.installationId\n      return resolved.resolution\n    },\n    type,\n    async undeploy(target) {\n      if (target.deletes === 'config') {\n        if (!installationId) throw new Error('No installation resolved for the config undeploy')\n        for (const snapshot of target.configs) {\n          await deleteConfig(installationId, snapshot.id)\n        }\n        return\n      }\n      await deleteApplication(target.id)\n    },\n  }\n}\n\nasync function resolveApplicationTarget({\n  appId,\n  type,\n  workbench,\n}: {\n  appId: string | undefined\n  type: 'coreApp' | 'studio'\n  workbench: DeployableWorkbenchApp\n}): Promise<UndeployTargetResolution<WorkbenchUndeployTarget>> {\n  if (!appId) {\n    return {\n      message: 'No `deployment.appId` configured',\n      solution: 'Add `deployment.appId` to sanity.cli.ts',\n      type: 'none',\n    }\n  }\n\n  const application = await getApplication(appId)\n  if (!application) {\n    return {message: 'Application with the given ID does not exist', type: 'none'}\n  }\n\n  const {exposes, lines} = summarizeExposes(workbench)\n  return {\n    target: {\n      activeDeployment: null,\n      appHost: application.slug,\n      createdAt: null,\n      deletes: 'application',\n      id: application.id,\n      interfaces: exposes,\n      organizationId: application.organizationId,\n      projectId: null,\n      summary: [\n        ...lines,\n        ...(workbench.isSingleton === undefined ? [] : [`Singleton: ${workbench.isSingleton}`]),\n      ],\n      title: application.title,\n      type,\n      url: getApplicationUrl({...application, type}),\n    },\n    type: 'found',\n  }\n}\n\nasync function resolveConfigTarget({\n  organizationId,\n  workbench,\n}: {\n  organizationId: string | undefined\n  workbench: DeployableWorkbenchApp\n}): Promise<{\n  installationId?: string\n  resolution: UndeployTargetResolution<WorkbenchUndeployTarget>\n}> {\n  const config = workbench.config\n  const appType = config?.appType ?? workbench.applicationType\n  if (!appType) throw new Error('The app declares no app type to resolve its installation')\n  if (!organizationId) {\n    throw new Error(\n      'sanity.cli.ts does not contain an organization identifier (\"app.organizationId\"), which is required to resolve the installation',\n    )\n  }\n\n  const installationId = await resolveInstallationId({appType, organizationId})\n  if (!installationId) {\n    return {\n      resolution: {\n        message: `No active \"${appType}\" installation for organization \"${organizationId}\"`,\n        type: 'none',\n      },\n    }\n  }\n\n  const configs = await listConfigs(installationId)\n  if (configs.length === 0) {\n    return {\n      installationId,\n      resolution: {\n        message: `No deployed config for the \"${appType}\" installation`,\n        type: 'none',\n      },\n    }\n  }\n\n  // At most one snapshot is active (served); the rest are deactivated history.\n  const active = configs.find((snapshot) => snapshot.isActive)\n  return {\n    installationId,\n    resolution: {\n      target: {\n        activeDeployment: active\n          ? {deployedAt: active.createdAt ?? '', deployedBy: active.deployedBy ?? ''}\n          : null,\n        appHost: null,\n        configs: configs.map((snapshot) => ({\n          createdAt: snapshot.createdAt ?? null,\n          deployedBy: snapshot.deployedBy ?? null,\n          id: snapshot.id,\n        })),\n        createdAt: configs.at(-1)?.createdAt ?? null,\n        deletes: 'config',\n        id: null,\n        organizationId,\n        projectId: null,\n        summary: config ? [summarizeConfig(config)] : undefined,\n        title: workbench.name,\n        type: 'coreApp',\n        url: getWorkbenchUrl(organizationId),\n      },\n      type: 'found',\n    },\n  }\n}\n"],"names":["deleteApplication","getApplication","getApplicationUrl","getWorkbenchUrl","deleteConfig","listConfigs","summarizeExposes","resolveInstallationId","summarizeConfig","createWorkbenchUndeployAdapter","options","appId","organizationId","type","workbench","configOnly","isSingleton","hasInterfaces","installationId","resolveTarget","resolveApplicationTarget","resolved","resolveConfigTarget","resolution","undeploy","target","deletes","Error","snapshot","configs","id","message","solution","application","exposes","lines","activeDeployment","appHost","slug","createdAt","interfaces","projectId","summary","undefined","title","url","config","appType","applicationType","length","active","find","isActive","deployedAt","deployedBy","map","at","name"],"mappings":"AAOA,SACEA,iBAAiB,EACjBC,cAAc,EACdC,iBAAiB,EACjBC,eAAe,QACV,iCAAgC;AACvC,SAAQC,YAAY,EAAEC,WAAW,QAAO,kCAAiC;AACzE,SAA6BC,gBAAgB,QAAO,4BAA2B;AAC/E,SAAQC,qBAAqB,EAAEC,eAAe,QAAO,4BAA2B;AAkBhF;;;;;;CAMC,GACD,OAAO,SAASC,+BAA+BC,OAK9C;IACC,MAAM,EAACC,KAAK,EAAEC,cAAc,EAAEC,IAAI,EAAEC,SAAS,EAAC,GAAGJ;IACjD,4EAA4E;IAC5E,2EAA2E;IAC3E,sBAAsB;IACtB,MAAMK,aAAa,CAAC,CAACD,UAAUE,WAAW,IAAI,CAACF,UAAUG,aAAa;IACtE,gGAAgG;IAChG,IAAIC;IAEJ,OAAO;QACLC,eAAe;YACb,IAAI,CAACJ,YAAY,OAAOK,yBAAyB;gBAACT;gBAAOE;gBAAMC;YAAS;YACxE,MAAMO,WAAW,MAAMC,oBAAoB;gBAACV;gBAAgBE;YAAS;YACrEI,iBAAiBG,SAASH,cAAc;YACxC,OAAOG,SAASE,UAAU;QAC5B;QACAV;QACA,MAAMW,UAASC,MAAM;YACnB,IAAIA,OAAOC,OAAO,KAAK,UAAU;gBAC/B,IAAI,CAACR,gBAAgB,MAAM,IAAIS,MAAM;gBACrC,KAAK,MAAMC,YAAYH,OAAOI,OAAO,CAAE;oBACrC,MAAMzB,aAAac,gBAAgBU,SAASE,EAAE;gBAChD;gBACA;YACF;YACA,MAAM9B,kBAAkByB,OAAOK,EAAE;QACnC;IACF;AACF;AAEA,eAAeV,yBAAyB,EACtCT,KAAK,EACLE,IAAI,EACJC,SAAS,EAKV;IACC,IAAI,CAACH,OAAO;QACV,OAAO;YACLoB,SAAS;YACTC,UAAU;YACVnB,MAAM;QACR;IACF;IAEA,MAAMoB,cAAc,MAAMhC,eAAeU;IACzC,IAAI,CAACsB,aAAa;QAChB,OAAO;YAACF,SAAS;YAAgDlB,MAAM;QAAM;IAC/E;IAEA,MAAM,EAACqB,OAAO,EAAEC,KAAK,EAAC,GAAG7B,iBAAiBQ;IAC1C,OAAO;QACLW,QAAQ;YACNW,kBAAkB;YAClBC,SAASJ,YAAYK,IAAI;YACzBC,WAAW;YACXb,SAAS;YACTI,IAAIG,YAAYH,EAAE;YAClBU,YAAYN;YACZtB,gBAAgBqB,YAAYrB,cAAc;YAC1C6B,WAAW;YACXC,SAAS;mBACJP;mBACCrB,UAAUE,WAAW,KAAK2B,YAAY,EAAE,GAAG;oBAAC,CAAC,WAAW,EAAE7B,UAAUE,WAAW,EAAE;iBAAC;aACvF;YACD4B,OAAOX,YAAYW,KAAK;YACxB/B;YACAgC,KAAK3C,kBAAkB;gBAAC,GAAG+B,WAAW;gBAAEpB;YAAI;QAC9C;QACAA,MAAM;IACR;AACF;AAEA,eAAeS,oBAAoB,EACjCV,cAAc,EACdE,SAAS,EAIV;IAIC,MAAMgC,SAAShC,UAAUgC,MAAM;IAC/B,MAAMC,UAAUD,QAAQC,WAAWjC,UAAUkC,eAAe;IAC5D,IAAI,CAACD,SAAS,MAAM,IAAIpB,MAAM;IAC9B,IAAI,CAACf,gBAAgB;QACnB,MAAM,IAAIe,MACR;IAEJ;IAEA,MAAMT,iBAAiB,MAAMX,sBAAsB;QAACwC;QAASnC;IAAc;IAC3E,IAAI,CAACM,gBAAgB;QACnB,OAAO;YACLK,YAAY;gBACVQ,SAAS,CAAC,WAAW,EAAEgB,QAAQ,iCAAiC,EAAEnC,eAAe,CAAC,CAAC;gBACnFC,MAAM;YACR;QACF;IACF;IAEA,MAAMgB,UAAU,MAAMxB,YAAYa;IAClC,IAAIW,QAAQoB,MAAM,KAAK,GAAG;QACxB,OAAO;YACL/B;YACAK,YAAY;gBACVQ,SAAS,CAAC,4BAA4B,EAAEgB,QAAQ,cAAc,CAAC;gBAC/DlC,MAAM;YACR;QACF;IACF;IAEA,6EAA6E;IAC7E,MAAMqC,SAASrB,QAAQsB,IAAI,CAAC,CAACvB,WAAaA,SAASwB,QAAQ;IAC3D,OAAO;QACLlC;QACAK,YAAY;YACVE,QAAQ;gBACNW,kBAAkBc,SACd;oBAACG,YAAYH,OAAOX,SAAS,IAAI;oBAAIe,YAAYJ,OAAOI,UAAU,IAAI;gBAAE,IACxE;gBACJjB,SAAS;gBACTR,SAASA,QAAQ0B,GAAG,CAAC,CAAC3B,WAAc,CAAA;wBAClCW,WAAWX,SAASW,SAAS,IAAI;wBACjCe,YAAY1B,SAAS0B,UAAU,IAAI;wBACnCxB,IAAIF,SAASE,EAAE;oBACjB,CAAA;gBACAS,WAAWV,QAAQ2B,EAAE,CAAC,CAAC,IAAIjB,aAAa;gBACxCb,SAAS;gBACTI,IAAI;gBACJlB;gBACA6B,WAAW;gBACXC,SAASI,SAAS;oBAACtC,gBAAgBsC;iBAAQ,GAAGH;gBAC9CC,OAAO9B,UAAU2C,IAAI;gBACrB5C,MAAM;gBACNgC,KAAK1C,gBAAgBS;YACvB;YACAC,MAAM;QACR;IACF;AACF"}

package/dist/defineView.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/defineView.ts"],"sourcesContent":["import {\n  type InterfaceType,\n  VIEW_CONTRACT_VERSION,\n  type ViewComponent,\n  type ViewComponentBaseProps,\n} from './contract.js'\n\n/**\n * Props a panel component receives: its interface record, minus the\n * service-assigned `id`/`deployment_id` a local dev server can't provide. Mirrors\n * the `panel` record the workbench host renders from (the wire format owned by\n * `@sanity/workbench`); drift is guarded by the stamped contract version.\n * @public\n */\nexport type PanelViewProps = ViewComponentBaseProps<{\n  entry_point: string\n  interface_type: 'panel'\n  name: string\n}>\n\n/**\n * The component slots a `panel` view exposes — each its own module-federation\n * island, typed with the panel props.\n * @public\n */\nexport interface PanelViewComponents {\n  panel: ViewComponent<PanelViewProps>\n  title: ViewComponent<PanelViewProps>\n}\n\n/**\n * A panel's view-component slot — the module-federation expose for one island.\n * @public\n */\nexport type PanelComponent = keyof PanelViewComponents\n\n/**\n * The components each interface type exposes, keyed by type.\n * @public\n */\nexport interface ViewComponentsByType {\n  panel: PanelViewComponents\n}\n\n/**\n * The result of `unstable_defineView`: the author's component(s), the view type,\n * and the internal contract version the build artifact targets.\n * @public\n */\nexport interface DefinedView<TType extends InterfaceType = InterfaceType> {\n  readonly components: ViewComponentsByType[TType]\n  readonly type: TType\n  /** @internal */\n  readonly version: typeof VIEW_CONTRACT_VERSION\n}\n\n/**\n * Define a Sanity Workbench view. The first argument narrows the component shape\n * and the props each component receives — `\"panel\"` yields a `{title, panel}`\n * record whose components are typed with the panel props.\n *\n * Returns the component(s) tagged with their type and the contract version, for\n * the CLI build to generate render artifacts from. Used as the default export of\n * a view's `src` file.\n * @public\n */\nexport function unstable_defineView<TType extends InterfaceType>(\n  type: TType,\n  components: ViewComponentsByType[TType],\n): DefinedView<TType> {\n  return {components, type, version: VIEW_CONTRACT_VERSION}\n}\n"],"names":["VIEW_CONTRACT_VERSION","unstable_defineView","type","components","version"],"mappings":"AAAA,SAEEA,qBAAqB,QAGhB,gBAAe;AAmDtB;;;;;;;;;CASC,GACD,OAAO,SAASC,oBACdC,IAAW,EACXC,UAAuC;IAEvC,OAAO;QAACA;QAAYD;QAAME,SAASJ;IAAqB;AAC1D"}
+{"version":3,"sources":["../src/defineView.ts"],"sourcesContent":["import {\n  type InterfaceType,\n  VIEW_CONTRACT_VERSION,\n  type ViewComponent,\n  type ViewComponentBaseProps,\n} from './contract.js'\n\n/**\n * Props a panel component receives: its interface record, minus the\n * service-assigned `id`/`deployment_id` a local dev server can't provide. Mirrors\n * the `panel` record the workbench host renders from (the wire format owned by\n * `@sanity/workbench`); drift is guarded by the stamped contract version.\n * @public\n */\nexport type PanelViewProps = ViewComponentBaseProps<{\n  name: string\n  src: string\n  title: string\n  type: 'panel'\n}>\n\n/**\n * The component slots a `panel` view exposes — each its own module-federation\n * island, typed with the panel props.\n * @public\n */\nexport interface PanelViewComponents {\n  panel: ViewComponent<PanelViewProps>\n  title: ViewComponent<PanelViewProps>\n}\n\n/**\n * A panel's view-component slot — the module-federation expose for one island.\n * @public\n */\nexport type PanelComponent = keyof PanelViewComponents\n\n/**\n * The components each interface type exposes, keyed by type.\n * @public\n */\nexport interface ViewComponentsByType {\n  panel: PanelViewComponents\n}\n\n/**\n * The result of `unstable_defineView`: the author's component(s), the view type,\n * and the internal contract version the build artifact targets.\n * @public\n */\nexport interface DefinedView<TType extends InterfaceType = InterfaceType> {\n  readonly components: ViewComponentsByType[TType]\n  readonly type: TType\n  /** @internal */\n  readonly version: typeof VIEW_CONTRACT_VERSION\n}\n\n/**\n * Define a Sanity Workbench view. The first argument narrows the component shape\n * and the props each component receives — `\"panel\"` yields a `{title, panel}`\n * record whose components are typed with the panel props.\n *\n * Returns the component(s) tagged with their type and the contract version, for\n * the CLI build to generate render artifacts from. Used as the default export of\n * a view's `src` file.\n * @public\n */\nexport function unstable_defineView<TType extends InterfaceType>(\n  type: TType,\n  components: ViewComponentsByType[TType],\n): DefinedView<TType> {\n  return {components, type, version: VIEW_CONTRACT_VERSION}\n}\n"],"names":["VIEW_CONTRACT_VERSION","unstable_defineView","type","components","version"],"mappings":"AAAA,SAEEA,qBAAqB,QAGhB,gBAAe;AAoDtB;;;;;;;;;CASC,GACD,OAAO,SAASC,oBACdC,IAAW,EACXC,UAAuC;IAEvC,OAAO;QAACA;QAAYD;QAAME,SAASJ;IAAqB;AAC1D"}

package/dist/services/apiVersion.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/services/apiVersion.ts"],"sourcesContent":["// The app endpoints (applications + installations) live behind the\n// experimental `vX` version; a dated version returns 501.\nexport const APP_WORKBENCH_API_VERSION = 'vX'\n"],"names":["APP_WORKBENCH_API_VERSION"],"mappings":"AAAA,mEAAmE;AACnE,0DAA0D;AAC1D,OAAO,MAAMA,4BAA4B,KAAI"}

package/dist/services/applications.js

@@ -0,0 +1,100 @@
+import { PassThrough } from 'node:stream';
+import { getGlobalCliClient } from '@sanity/cli-core';
+import { isStaging } from '@sanity/cli-core/util';
+import FormData from 'form-data';
+import { APP_WORKBENCH_API_VERSION } from './apiVersion.js';
+export function getWorkbenchUrl(organizationId) {
+    return `https://${organizationId}.${isStaging() ? 'run.sanity.work' : 'sanity.run'}`;
+}
+/** Where a deployed application is served on its organization's workbench. */ export function getApplicationUrl(application) {
+    const segment = application.type === 'studio' ? 'studio' : 'application';
+    return `${getWorkbenchUrl(application.organizationId)}/${segment}/${application.id}`;
+}
+async function getClient() {
+    return getGlobalCliClient({
+        apiVersion: APP_WORKBENCH_API_VERSION,
+        requireUser: true
+    });
+}
+export async function getApplication(applicationId) {
+    const client = await getClient();
+    try {
+        return await client.request({
+            uri: `/applications/${applicationId}`
+        });
+    } catch (err) {
+        if (err?.statusCode === 404) return null;
+        throw err;
+    }
+}
+/** Create an application and its first deployment in one call. */ export async function createApplication(options) {
+    const { interfaces, isSingleton, organizationId, projectId, slug, tarball, title, type, version, workspaces } = options;
+    const formData = new FormData();
+    formData.append('type', type);
+    formData.append('title', title);
+    formData.append('organizationId', organizationId);
+    formData.append('slug', slug);
+    if (isSingleton !== undefined) formData.append('isSingleton', String(isSingleton));
+    // Studio config is set once, at create — it's immutable on redeploy.
+    if (projectId) appendJson(formData, 'config', {
+        studio: {
+            projectId
+        }
+    });
+    appendDeploymentParts(formData, {
+        interfaces,
+        tarball,
+        version,
+        workspaces
+    });
+    return request(`/applications`, formData);
+}
+/** Deploy a new active version to an existing application. */ export async function createDeployment(options) {
+    const { applicationId, interfaces, isAutoUpdating, tarball, version, workspaces } = options;
+    const formData = new FormData();
+    formData.append('isAutoUpdating', isAutoUpdating.toString());
+    appendDeploymentParts(formData, {
+        interfaces,
+        tarball,
+        version,
+        workspaces
+    });
+    return request(`/applications/${applicationId}/deployments`, formData);
+}
+/** Soft-deletes the application and all its deployments; already deleted counts as done. */ export async function deleteApplication(applicationId) {
+    const client = await getClient();
+    try {
+        await client.request({
+            method: 'DELETE',
+            uri: `/applications/${applicationId}`
+        });
+    } catch (err) {
+        if (err?.statusCode !== 404) throw err;
+    }
+}
+function appendDeploymentParts(formData, { interfaces, tarball, version, workspaces }) {
+    formData.append('version', version);
+    appendJson(formData, 'interfaces', interfaces);
+    // Studio-only — the server rejects a workspaces part on non-studio types.
+    if (workspaces?.length) appendJson(formData, 'workspaces', workspaces);
+    formData.append('tarball', tarball, {
+        contentType: 'application/gzip',
+        filename: 'app.tar.gz'
+    });
+}
+/** Structured parts must arrive as JSON so the server parses them. */ function appendJson(formData, name, value) {
+    formData.append(name, JSON.stringify(value), {
+        contentType: 'application/json'
+    });
+}
+async function request(uri, formData) {
+    const client = await getClient();
+    return client.request({
+        body: formData.pipe(new PassThrough()),
+        headers: formData.getHeaders(),
+        method: 'POST',
+        uri
+    });
+}
+
+//# sourceMappingURL=applications.js.map

package/dist/services/applications.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/services/applications.ts"],"sourcesContent":["import {PassThrough} from 'node:stream'\nimport {type Gzip} from 'node:zlib'\n\nimport {getGlobalCliClient} from '@sanity/cli-core'\nimport {isStaging} from '@sanity/cli-core/util'\nimport FormData from 'form-data'\n\nimport {APP_WORKBENCH_API_VERSION} from './apiVersion.js'\n\nexport type ApplicationType = 'coreApp' | 'studio'\n\nexport interface Application {\n  id: string\n  organizationId: string\n  slug: string | null\n  title: string\n  type: ApplicationType\n}\n\n/**\n * An interface as Brett stores it: the declared `type` (validated server-side,\n * not here) and the remote-relative `moduleId` the workbench loads it by — the\n * host prepends the app's own id.\n * @internal\n */\nexport interface BrettInterface {\n  moduleId: string\n  name: string\n  title: string\n  type: string\n  version: string\n}\n\n/** A studio workspace as Brett stores it. */\nexport interface BrettWorkspace {\n  dataset: string\n  projectId: string\n\n  basePath?: string\n  icon?: string\n  name?: string\n  subtitle?: string\n  title?: string\n}\n\nexport function getWorkbenchUrl(organizationId: string): string {\n  return `https://${organizationId}.${isStaging() ? 'run.sanity.work' : 'sanity.run'}`\n}\n\n/** Where a deployed application is served on its organization's workbench. */\nexport function getApplicationUrl(\n  application: Pick<Application, 'id' | 'organizationId' | 'type'>,\n): string {\n  const segment = application.type === 'studio' ? 'studio' : 'application'\n  return `${getWorkbenchUrl(application.organizationId)}/${segment}/${application.id}`\n}\n\nasync function getClient() {\n  return getGlobalCliClient({apiVersion: APP_WORKBENCH_API_VERSION, requireUser: true})\n}\n\nexport async function getApplication(applicationId: string): Promise<Application | null> {\n  const client = await getClient()\n  try {\n    return await client.request({uri: `/applications/${applicationId}`})\n  } catch (err) {\n    if ((err as {statusCode?: number})?.statusCode === 404) return null\n    throw err\n  }\n}\n\n/** Create an application and its first deployment in one call. */\nexport async function createApplication(options: {\n  interfaces: readonly BrettInterface[]\n  isSingleton?: boolean\n  organizationId: string\n  projectId?: string\n  slug: string\n  tarball: Gzip\n  title: string\n  type: ApplicationType\n  version: string\n  workspaces?: readonly BrettWorkspace[]\n}): Promise<Application> {\n  const {\n    interfaces,\n    isSingleton,\n    organizationId,\n    projectId,\n    slug,\n    tarball,\n    title,\n    type,\n    version,\n    workspaces,\n  } = options\n  const formData = new FormData()\n  formData.append('type', type)\n  formData.append('title', title)\n  formData.append('organizationId', organizationId)\n  formData.append('slug', slug)\n  if (isSingleton !== undefined) formData.append('isSingleton', String(isSingleton))\n  // Studio config is set once, at create — it's immutable on redeploy.\n  if (projectId) appendJson(formData, 'config', {studio: {projectId}})\n  appendDeploymentParts(formData, {interfaces, tarball, version, workspaces})\n  return request(`/applications`, formData)\n}\n\n/** Deploy a new active version to an existing application. */\nexport async function createDeployment(options: {\n  applicationId: string\n  interfaces: readonly BrettInterface[]\n  isAutoUpdating: boolean\n  tarball: Gzip\n  version: string\n  workspaces?: readonly BrettWorkspace[]\n}): Promise<{id: string}> {\n  const {applicationId, interfaces, isAutoUpdating, tarball, version, workspaces} = options\n  const formData = new FormData()\n  formData.append('isAutoUpdating', isAutoUpdating.toString())\n  appendDeploymentParts(formData, {interfaces, tarball, version, workspaces})\n  return request(`/applications/${applicationId}/deployments`, formData)\n}\n\n/** Soft-deletes the application and all its deployments; already deleted counts as done. */\nexport async function deleteApplication(applicationId: string): Promise<void> {\n  const client = await getClient()\n  try {\n    await client.request({method: 'DELETE', uri: `/applications/${applicationId}`})\n  } catch (err) {\n    if ((err as {statusCode?: number})?.statusCode !== 404) throw err\n  }\n}\n\nfunction appendDeploymentParts(\n  formData: FormData,\n  {\n    interfaces,\n    tarball,\n    version,\n    workspaces,\n  }: {\n    interfaces: readonly BrettInterface[]\n    tarball: Gzip\n    version: string\n    workspaces?: readonly BrettWorkspace[]\n  },\n): void {\n  formData.append('version', version)\n  appendJson(formData, 'interfaces', interfaces)\n  // Studio-only — the server rejects a workspaces part on non-studio types.\n  if (workspaces?.length) appendJson(formData, 'workspaces', workspaces)\n  formData.append('tarball', tarball, {contentType: 'application/gzip', filename: 'app.tar.gz'})\n}\n\n/** Structured parts must arrive as JSON so the server parses them. */\nfunction appendJson(formData: FormData, name: string, value: unknown): void {\n  formData.append(name, JSON.stringify(value), {contentType: 'application/json'})\n}\n\nasync function request<T>(uri: string, formData: FormData): Promise<T> {\n  const client = await getClient()\n  return client.request({\n    body: formData.pipe(new PassThrough()),\n    headers: formData.getHeaders(),\n    method: 'POST',\n    uri,\n  })\n}\n"],"names":["PassThrough","getGlobalCliClient","isStaging","FormData","APP_WORKBENCH_API_VERSION","getWorkbenchUrl","organizationId","getApplicationUrl","application","segment","type","id","getClient","apiVersion","requireUser","getApplication","applicationId","client","request","uri","err","statusCode","createApplication","options","interfaces","isSingleton","projectId","slug","tarball","title","version","workspaces","formData","append","undefined","String","appendJson","studio","appendDeploymentParts","createDeployment","isAutoUpdating","toString","deleteApplication","method","length","contentType","filename","name","value","JSON","stringify","body","pipe","headers","getHeaders"],"mappings":"AAAA,SAAQA,WAAW,QAAO,cAAa;AAGvC,SAAQC,kBAAkB,QAAO,mBAAkB;AACnD,SAAQC,SAAS,QAAO,wBAAuB;AAC/C,OAAOC,cAAc,YAAW;AAEhC,SAAQC,yBAAyB,QAAO,kBAAiB;AAsCzD,OAAO,SAASC,gBAAgBC,cAAsB;IACpD,OAAO,CAAC,QAAQ,EAAEA,eAAe,CAAC,EAAEJ,cAAc,oBAAoB,cAAc;AACtF;AAEA,4EAA4E,GAC5E,OAAO,SAASK,kBACdC,WAAgE;IAEhE,MAAMC,UAAUD,YAAYE,IAAI,KAAK,WAAW,WAAW;IAC3D,OAAO,GAAGL,gBAAgBG,YAAYF,cAAc,EAAE,CAAC,EAAEG,QAAQ,CAAC,EAAED,YAAYG,EAAE,EAAE;AACtF;AAEA,eAAeC;IACb,OAAOX,mBAAmB;QAACY,YAAYT;QAA2BU,aAAa;IAAI;AACrF;AAEA,OAAO,eAAeC,eAAeC,aAAqB;IACxD,MAAMC,SAAS,MAAML;IACrB,IAAI;QACF,OAAO,MAAMK,OAAOC,OAAO,CAAC;YAACC,KAAK,CAAC,cAAc,EAAEH,eAAe;QAAA;IACpE,EAAE,OAAOI,KAAK;QACZ,IAAI,AAACA,KAA+BC,eAAe,KAAK,OAAO;QAC/D,MAAMD;IACR;AACF;AAEA,gEAAgE,GAChE,OAAO,eAAeE,kBAAkBC,OAWvC;IACC,MAAM,EACJC,UAAU,EACVC,WAAW,EACXnB,cAAc,EACdoB,SAAS,EACTC,IAAI,EACJC,OAAO,EACPC,KAAK,EACLnB,IAAI,EACJoB,OAAO,EACPC,UAAU,EACX,GAAGR;IACJ,MAAMS,WAAW,IAAI7B;IACrB6B,SAASC,MAAM,CAAC,QAAQvB;IACxBsB,SAASC,MAAM,CAAC,SAASJ;IACzBG,SAASC,MAAM,CAAC,kBAAkB3B;IAClC0B,SAASC,MAAM,CAAC,QAAQN;IACxB,IAAIF,gBAAgBS,WAAWF,SAASC,MAAM,CAAC,eAAeE,OAAOV;IACrE,qEAAqE;IACrE,IAAIC,WAAWU,WAAWJ,UAAU,UAAU;QAACK,QAAQ;YAACX;QAAS;IAAC;IAClEY,sBAAsBN,UAAU;QAACR;QAAYI;QAASE;QAASC;IAAU;IACzE,OAAOb,QAAQ,CAAC,aAAa,CAAC,EAAEc;AAClC;AAEA,4DAA4D,GAC5D,OAAO,eAAeO,iBAAiBhB,OAOtC;IACC,MAAM,EAACP,aAAa,EAAEQ,UAAU,EAAEgB,cAAc,EAAEZ,OAAO,EAAEE,OAAO,EAAEC,UAAU,EAAC,GAAGR;IAClF,MAAMS,WAAW,IAAI7B;IACrB6B,SAASC,MAAM,CAAC,kBAAkBO,eAAeC,QAAQ;IACzDH,sBAAsBN,UAAU;QAACR;QAAYI;QAASE;QAASC;IAAU;IACzE,OAAOb,QAAQ,CAAC,cAAc,EAAEF,cAAc,YAAY,CAAC,EAAEgB;AAC/D;AAEA,0FAA0F,GAC1F,OAAO,eAAeU,kBAAkB1B,aAAqB;IAC3D,MAAMC,SAAS,MAAML;IACrB,IAAI;QACF,MAAMK,OAAOC,OAAO,CAAC;YAACyB,QAAQ;YAAUxB,KAAK,CAAC,cAAc,EAAEH,eAAe;QAAA;IAC/E,EAAE,OAAOI,KAAK;QACZ,IAAI,AAACA,KAA+BC,eAAe,KAAK,MAAMD;IAChE;AACF;AAEA,SAASkB,sBACPN,QAAkB,EAClB,EACER,UAAU,EACVI,OAAO,EACPE,OAAO,EACPC,UAAU,EAMX;IAEDC,SAASC,MAAM,CAAC,WAAWH;IAC3BM,WAAWJ,UAAU,cAAcR;IACnC,0EAA0E;IAC1E,IAAIO,YAAYa,QAAQR,WAAWJ,UAAU,cAAcD;IAC3DC,SAASC,MAAM,CAAC,WAAWL,SAAS;QAACiB,aAAa;QAAoBC,UAAU;IAAY;AAC9F;AAEA,oEAAoE,GACpE,SAASV,WAAWJ,QAAkB,EAAEe,IAAY,EAAEC,KAAc;IAClEhB,SAASC,MAAM,CAACc,MAAME,KAAKC,SAAS,CAACF,QAAQ;QAACH,aAAa;IAAkB;AAC/E;AAEA,eAAe3B,QAAWC,GAAW,EAAEa,QAAkB;IACvD,MAAMf,SAAS,MAAML;IACrB,OAAOK,OAAOC,OAAO,CAAC;QACpBiC,MAAMnB,SAASoB,IAAI,CAAC,IAAIpD;QACxBqD,SAASrB,SAASsB,UAAU;QAC5BX,QAAQ;QACRxB;IACF;AACF"}

package/dist/services/installations.js

@@ -0,0 +1,63 @@
+import { PassThrough } from 'node:stream';
+import { getGlobalCliClient } from '@sanity/cli-core';
+import FormData from 'form-data';
+import { APP_WORKBENCH_API_VERSION } from './apiVersion.js';
+async function getClient() {
+    return getGlobalCliClient({
+        apiVersion: APP_WORKBENCH_API_VERSION,
+        requireUser: true
+    });
+}
+/** The org's active singleton installation, matched on its slug. */ export async function resolveSingletonInstallationId(organizationId, slug) {
+    const client = await getClient();
+    // `limit=none` returns every installation in one response, no pagination.
+    const { data } = await client.request({
+        query: {
+            limit: 'none',
+            organizationId
+        },
+        uri: '/installations'
+    });
+    return data.find((item)=>item.application?.slug === slug)?.id;
+}
+/** Upload a config snapshot to the installation as a multipart tarball. */ export async function createConfig(installationId, { tarball, version }) {
+    const formData = new FormData();
+    formData.append('version', version);
+    formData.append('tarball', tarball, {
+        contentType: 'application/gzip',
+        filename: 'installation-config.tar.gz'
+    });
+    const client = await getClient();
+    await client.request({
+        body: formData.pipe(new PassThrough()),
+        headers: formData.getHeaders(),
+        method: 'POST',
+        uri: `/installations/${installationId}/configs`
+    });
+}
+/** The installation's deployed config snapshots, newest first. */ export async function listConfigs(installationId) {
+    const client = await getClient();
+    const { data } = await client.request({
+        query: {
+            limit: 'none'
+        },
+        uri: `/installations/${installationId}/configs`
+    });
+    return data;
+}
+/**
+ * Soft-deletes one config snapshot; its content is purged once superseded.
+ * Already deleted counts as done, so a partially-failed undeploy can re-run.
+ */ export async function deleteConfig(installationId, configId) {
+    const client = await getClient();
+    try {
+        await client.request({
+            method: 'DELETE',
+            uri: `/installations/${installationId}/configs/${configId}`
+        });
+    } catch (err) {
+        if (err?.statusCode !== 404) throw err;
+    }
+}
+
+//# sourceMappingURL=installations.js.map

package/dist/services/installations.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/services/installations.ts"],"sourcesContent":["import {PassThrough} from 'node:stream'\nimport {type Gzip} from 'node:zlib'\n\nimport {getGlobalCliClient} from '@sanity/cli-core'\nimport FormData from 'form-data'\n\nimport {APP_WORKBENCH_API_VERSION} from './apiVersion.js'\n\nexport interface ConfigSnapshot {\n  id: string\n\n  createdAt?: string\n  deployedBy?: string\n  /** Whether this snapshot is the one being served; at most one per installation. */\n  isActive?: boolean\n}\n\ninterface InstallationListItem {\n  id: string\n\n  application?: {slug?: string}\n}\n\nasync function getClient() {\n  return getGlobalCliClient({apiVersion: APP_WORKBENCH_API_VERSION, requireUser: true})\n}\n\n/** The org's active singleton installation, matched on its slug. */\nexport async function resolveSingletonInstallationId(\n  organizationId: string,\n  slug: string,\n): Promise<string | undefined> {\n  const client = await getClient()\n  // `limit=none` returns every installation in one response, no pagination.\n  const {data}: {data: InstallationListItem[]} = await client.request({\n    query: {limit: 'none', organizationId},\n    uri: '/installations',\n  })\n  return data.find((item) => item.application?.slug === slug)?.id\n}\n\n/** Upload a config snapshot to the installation as a multipart tarball. */\nexport async function createConfig(\n  installationId: string,\n  {tarball, version}: {tarball: Gzip; version: string},\n): Promise<void> {\n  const formData = new FormData()\n  formData.append('version', version)\n  formData.append('tarball', tarball, {\n    contentType: 'application/gzip',\n    filename: 'installation-config.tar.gz',\n  })\n\n  const client = await getClient()\n  await client.request({\n    body: formData.pipe(new PassThrough()),\n    headers: formData.getHeaders(),\n    method: 'POST',\n    uri: `/installations/${installationId}/configs`,\n  })\n}\n\n/** The installation's deployed config snapshots, newest first. */\nexport async function listConfigs(installationId: string): Promise<ConfigSnapshot[]> {\n  const client = await getClient()\n  const {data}: {data: ConfigSnapshot[]} = await client.request({\n    query: {limit: 'none'},\n    uri: `/installations/${installationId}/configs`,\n  })\n  return data\n}\n\n/**\n * Soft-deletes one config snapshot; its content is purged once superseded.\n * Already deleted counts as done, so a partially-failed undeploy can re-run.\n */\nexport async function deleteConfig(installationId: string, configId: string): Promise<void> {\n  const client = await getClient()\n  try {\n    await client.request({\n      method: 'DELETE',\n      uri: `/installations/${installationId}/configs/${configId}`,\n    })\n  } catch (err) {\n    if ((err as {statusCode?: number})?.statusCode !== 404) throw err\n  }\n}\n"],"names":["PassThrough","getGlobalCliClient","FormData","APP_WORKBENCH_API_VERSION","getClient","apiVersion","requireUser","resolveSingletonInstallationId","organizationId","slug","client","data","request","query","limit","uri","find","item","application","id","createConfig","installationId","tarball","version","formData","append","contentType","filename","body","pipe","headers","getHeaders","method","listConfigs","deleteConfig","configId","err","statusCode"],"mappings":"AAAA,SAAQA,WAAW,QAAO,cAAa;AAGvC,SAAQC,kBAAkB,QAAO,mBAAkB;AACnD,OAAOC,cAAc,YAAW;AAEhC,SAAQC,yBAAyB,QAAO,kBAAiB;AAiBzD,eAAeC;IACb,OAAOH,mBAAmB;QAACI,YAAYF;QAA2BG,aAAa;IAAI;AACrF;AAEA,kEAAkE,GAClE,OAAO,eAAeC,+BACpBC,cAAsB,EACtBC,IAAY;IAEZ,MAAMC,SAAS,MAAMN;IACrB,0EAA0E;IAC1E,MAAM,EAACO,IAAI,EAAC,GAAmC,MAAMD,OAAOE,OAAO,CAAC;QAClEC,OAAO;YAACC,OAAO;YAAQN;QAAc;QACrCO,KAAK;IACP;IACA,OAAOJ,KAAKK,IAAI,CAAC,CAACC,OAASA,KAAKC,WAAW,EAAET,SAASA,OAAOU;AAC/D;AAEA,yEAAyE,GACzE,OAAO,eAAeC,aACpBC,cAAsB,EACtB,EAACC,OAAO,EAAEC,OAAO,EAAmC;IAEpD,MAAMC,WAAW,IAAItB;IACrBsB,SAASC,MAAM,CAAC,WAAWF;IAC3BC,SAASC,MAAM,CAAC,WAAWH,SAAS;QAClCI,aAAa;QACbC,UAAU;IACZ;IAEA,MAAMjB,SAAS,MAAMN;IACrB,MAAMM,OAAOE,OAAO,CAAC;QACnBgB,MAAMJ,SAASK,IAAI,CAAC,IAAI7B;QACxB8B,SAASN,SAASO,UAAU;QAC5BC,QAAQ;QACRjB,KAAK,CAAC,eAAe,EAAEM,eAAe,QAAQ,CAAC;IACjD;AACF;AAEA,gEAAgE,GAChE,OAAO,eAAeY,YAAYZ,cAAsB;IACtD,MAAMX,SAAS,MAAMN;IACrB,MAAM,EAACO,IAAI,EAAC,GAA6B,MAAMD,OAAOE,OAAO,CAAC;QAC5DC,OAAO;YAACC,OAAO;QAAM;QACrBC,KAAK,CAAC,eAAe,EAAEM,eAAe,QAAQ,CAAC;IACjD;IACA,OAAOV;AACT;AAEA;;;CAGC,GACD,OAAO,eAAeuB,aAAab,cAAsB,EAAEc,QAAgB;IACzE,MAAMzB,SAAS,MAAMN;IACrB,IAAI;QACF,MAAMM,OAAOE,OAAO,CAAC;YACnBoB,QAAQ;YACRjB,KAAK,CAAC,eAAe,EAAEM,eAAe,SAAS,EAAEc,UAAU;QAC7D;IACF,EAAE,OAAOC,KAAK;QACZ,IAAI,AAACA,KAA+BC,eAAe,KAAK,MAAMD;IAChE;AACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workbench-cli",
-  "version": "1.3.0",
+  "version": "1.4.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",
@@ -39,6 +39,10 @@
       "source": "./src/_exports/init.ts",
       "default": "./dist/_exports/init.js"
     },
+    "./undeploy": {
+      "source": "./src/_exports/undeploy.ts",
+      "default": "./dist/_exports/undeploy.js"
+    },
     "./package.json": "./package.json"
   },
   "publishConfig": {
@@ -51,7 +55,7 @@
     "tar-fs": "^3.1.2",
     "vite": "^8.1.3",
     "zod": "^4.4.3",
-    "@sanity/cli-core": "^2.3.0"
+    "@sanity/cli-core": "^2.4.0"
   },
   "devDependencies": {
     "@eslint/compat": "^2.1.0",

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

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/actions/deploy/apiVersion.ts"],"sourcesContent":["// The app endpoints (applications + installations) live behind the\n// experimental `vX` version; a dated version returns 501.\nexport const APP_WORKBENCH_API_VERSION = 'vX'\n"],"names":["APP_WORKBENCH_API_VERSION"],"mappings":"AAAA,mEAAmE;AACnE,0DAA0D;AAC1D,OAAO,MAAMA,4BAA4B,KAAI"}