@sanity/workbench-cli 2.2.3 → 2.2.4

package/dist/_exports/build.d.ts

@@ -1,4 +1,4 @@
-import { a as resolveWorkbenchApp, i as WorkbenchExposes, n as resolveWorkbenchConfig, r as ResolvedWorkbenchApp, t as ResolvedMediaLibraryConfig } from "./resolveWorkbenchConfig-6iznHbED.js";
+import { a as resolveWorkbenchApp, i as WorkbenchExposes, n as resolveWorkbenchConfig, r as ResolvedWorkbenchApp, t as ResolvedMediaLibraryConfig } from "./resolveWorkbenchConfig-0Crh5P9n.js";
 import { PluginOption } from "vite";
 /**
  * Dep pre-bundling inputs for a workbench app's dev server.

package/dist/_exports/{defineApp-DldjQwq6.d.ts → defineApp-Dmrf4GjS.d.ts}

@@ -214,6 +214,7 @@ declare const DefineAppInputSchema: z.ZodMiniObject<{
   }, z.core.$strip>>;
   entry: z.ZodMiniOptional<z.ZodMiniString<string>>;
   icon: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  isSingleton: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
   name: z.ZodMiniOptional<z.ZodMiniString<string>>;
   organizationId: z.ZodMiniString<string>;
   slug: z.ZodMiniString<string>;
@@ -275,10 +276,10 @@ declare const DefineAppInputSchema: z.ZodMiniObject<{
 }, z.core.$strip>;
 /**
  * User-facing input for `defineApplication`. Excludes the internal
- * `applicationType`.
+ * `applicationType` and `isSingleton`.
  * @public
  */
-type DefineAppInput = Omit<z.output<typeof DefineAppInputSchema>, 'applicationType'>;
+type DefineAppInput = Omit<z.output<typeof DefineAppInputSchema>, 'applicationType' | 'isSingleton'>;
 /**
  * Nominal brand the CLI discriminates on to enable the workbench build/deploy
  * codepath. Registered via `Symbol.for` so the marker survives module-realm
@@ -372,4 +373,4 @@ declare function isWorkbenchConfig(app: unknown): app is WorkbenchConfig;
  */
 declare function unstable_defineMediaLibrary(input: DefineMediaLibraryInput): WorkbenchConfig;
 export { WorkbenchConfigValue as A, VIEW_CONTRACT_VERSION as C, ViewSurface as D, ViewDeclaration as E, defineWindowView as F, definePanelView as M, defineTileView as N, WebWorker as O, defineWebWorker as P, TileView as S, ViewComponentBaseProps as T, DockGroup as _, WorkbenchApp as a, ServiceType as b, isWorkbenchApp as c, AssetSourceView as d, DefineAssetSourceViewInput as f, DefineWindowViewInput as g, DefineWebWorkerInput as h, MediaLibraryField as i, defineAssetSourceView as j, WindowView as k, isWorkbenchConfig as l, DefineTileViewInput as m, DefineAppResult as n, WorkbenchConfig as o, DefinePanelViewInput as p, DefineMediaLibraryInput as r, defineApplication as s, DefineAppInput as t, unstable_defineMediaLibrary as u, PanelView as v, ViewComponent as w, TileSize as x, SERVICE_CONTRACT_VERSION as y };
-//# sourceMappingURL=defineApp-DldjQwq6.d.ts.map
+//# sourceMappingURL=defineApp-Dmrf4GjS.d.ts.map

package/dist/_exports/deploy.d.ts

@@ -1,6 +1,6 @@
-import "./defineApp-DldjQwq6.js";
-import { n as resolveWorkbenchConfig, t as ResolvedMediaLibraryConfig } from "./resolveWorkbenchConfig-6iznHbED.js";
-import { a as DeployableWorkbenchApp, i as summarizeInterfaces, n as DeployedView, o as getWorkbench, r as DeployedWebWorker, t as DeployedInterface } from "./summarizeInterfaces-CjkeWwkY.js";
+import "./defineApp-Dmrf4GjS.js";
+import { n as resolveWorkbenchConfig, t as ResolvedMediaLibraryConfig } from "./resolveWorkbenchConfig-0Crh5P9n.js";
+import { a as DeployableWorkbenchApp, i as summarizeInterfaces, n as DeployedView, o as getWorkbench, r as DeployedWebWorker, t as DeployedInterface } from "./summarizeInterfaces-CaYUOK3F.js";
 import { AppVisibility, CliConfig, Output } from "@sanity/cli-core";
 import "node:zlib";
 /**
@@ -117,6 +117,7 @@ interface CreatedApplication {
  * @internal
  */
 declare function createCoreApp(options: {
+  isSingleton?: boolean;
   name?: string;
   organizationId: string;
   slug: string;

package/dist/_exports/index.d.ts

@@ -1,4 +1,4 @@
-import { C as VIEW_CONTRACT_VERSION, D as ViewSurface, E as ViewDeclaration, F as defineWindowView, M as definePanelView, N as defineTileView, O as WebWorker, P as defineWebWorker, S as TileView, T as ViewComponentBaseProps, _ as DockGroup, a as WorkbenchApp, b as ServiceType, c as isWorkbenchApp, d as AssetSourceView, f as DefineAssetSourceViewInput, g as DefineWindowViewInput, h as DefineWebWorkerInput, i as MediaLibraryField, j as defineAssetSourceView, k as WindowView, l as isWorkbenchConfig, m as DefineTileViewInput, n as DefineAppResult, o as WorkbenchConfig, p as DefinePanelViewInput, r as DefineMediaLibraryInput, s as defineApplication, t as DefineAppInput, u as unstable_defineMediaLibrary, v as PanelView, w as ViewComponent, x as TileSize, y as SERVICE_CONTRACT_VERSION } from "./defineApp-DldjQwq6.js";
+import { C as VIEW_CONTRACT_VERSION, D as ViewSurface, E as ViewDeclaration, F as defineWindowView, M as definePanelView, N as defineTileView, O as WebWorker, P as defineWebWorker, S as TileView, T as ViewComponentBaseProps, _ as DockGroup, a as WorkbenchApp, b as ServiceType, c as isWorkbenchApp, d as AssetSourceView, f as DefineAssetSourceViewInput, g as DefineWindowViewInput, h as DefineWebWorkerInput, i as MediaLibraryField, j as defineAssetSourceView, k as WindowView, l as isWorkbenchConfig, m as DefineTileViewInput, n as DefineAppResult, o as WorkbenchConfig, p as DefinePanelViewInput, r as DefineMediaLibraryInput, s as defineApplication, t as DefineAppInput, u as unstable_defineMediaLibrary, v as PanelView, w as ViewComponent, x as TileSize, y as SERVICE_CONTRACT_VERSION } from "./defineApp-Dmrf4GjS.js";
 import { AssetSourceComponentProps } from "@sanity/types";
 /**
  * The service's own declaration, surfaced to the callback.

package/dist/_exports/{resolveWorkbenchConfig-6iznHbED.d.ts → resolveWorkbenchConfig-0Crh5P9n.d.ts}

@@ -1,4 +1,4 @@
-import { A as WorkbenchConfigValue, t as DefineAppInput } from "./defineApp-DldjQwq6.js";
+import { A as WorkbenchConfigValue, t as DefineAppInput } from "./defineApp-Dmrf4GjS.js";
 import { AppVisibility, CliConfig } from "@sanity/cli-core";
 /**
  * Bundled so adding a declaration family touches this type and the artifact
@@ -31,6 +31,8 @@ interface ResolvedWorkbenchApp {
   readonly entry?: string;
   /** Path to the app's icon SVG, resolved and shipped to Brett on deploy. */
   readonly icon?: string;
+  /** Explicit singleton flag for Sanity-owned apps. */
+  readonly isSingleton?: boolean;
   /** Dashboard visibility declared by the app; `undefined` when unset. */
   readonly visibility?: AppVisibility;
 }
@@ -57,4 +59,4 @@ interface ResolvedMediaLibraryConfig {
  */
 declare function resolveWorkbenchConfig(cliConfig: CliConfig | null | undefined): ResolvedMediaLibraryConfig | null;
 export { resolveWorkbenchApp as a, WorkbenchExposes as i, resolveWorkbenchConfig as n, ResolvedWorkbenchApp as r, ResolvedMediaLibraryConfig as t };
-//# sourceMappingURL=resolveWorkbenchConfig-6iznHbED.d.ts.map
+//# sourceMappingURL=resolveWorkbenchConfig-0Crh5P9n.d.ts.map

package/dist/_exports/{summarizeInterfaces-CjkeWwkY.d.ts → summarizeInterfaces-CaYUOK3F.d.ts}

@@ -1,5 +1,5 @@
-import { D as ViewSurface, b as ServiceType } from "./defineApp-DldjQwq6.js";
-import { i as WorkbenchExposes, r as ResolvedWorkbenchApp } from "./resolveWorkbenchConfig-6iznHbED.js";
+import { D as ViewSurface, b as ServiceType } from "./defineApp-Dmrf4GjS.js";
+import { i as WorkbenchExposes, r as ResolvedWorkbenchApp } from "./resolveWorkbenchConfig-0Crh5P9n.js";
 import { CliConfig } from "@sanity/cli-core";
 import { z } from "zod/mini";
 /**
@@ -62,4 +62,4 @@ declare function summarizeInterfaces({ views, webWorkers }: WorkbenchExposes): {
   views: DeployedView[];
 };
 export { DeployableWorkbenchApp as a, summarizeInterfaces as i, DeployedView as n, getWorkbench as o, DeployedWebWorker as r, DeployedInterface as t };
-//# sourceMappingURL=summarizeInterfaces-CjkeWwkY.d.ts.map
+//# sourceMappingURL=summarizeInterfaces-CaYUOK3F.d.ts.map

package/dist/_exports/undeploy.d.ts

@@ -1,5 +1,5 @@
-import { t as ResolvedMediaLibraryConfig } from "./resolveWorkbenchConfig-6iznHbED.js";
-import { a as DeployableWorkbenchApp, n as DeployedView, r as DeployedWebWorker } from "./summarizeInterfaces-CjkeWwkY.js";
+import { t as ResolvedMediaLibraryConfig } from "./resolveWorkbenchConfig-0Crh5P9n.js";
+import { a as DeployableWorkbenchApp, n as DeployedView, r as DeployedWebWorker } from "./summarizeInterfaces-CaYUOK3F.js";
 import "node:zlib";
 import { UndeployAdapter, UndeployApplicationTarget, UndeployConfigTarget } from "@sanity/cli-core/undeploy";
 interface ConfigSnapshot {

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/actions/deploy/deployWorkbenchApp.ts"],"sourcesContent":["import {basename, dirname} from 'node:path'\nimport {createGzip} from 'node:zlib'\n\nimport {type AppVisibility, type CliConfig} from '@sanity/cli-core'\nimport {spinner} from '@sanity/cli-core/ux'\nimport {pack} from 'tar-fs'\n\nimport {type DerivedInterface, deriveInterfaces} from '../../deriveInterfaces.js'\nimport {\n  type Application,\n  type BrettAccess,\n  type BrettInterface,\n  type BrettWorkspace,\n  createApplication,\n  createDeployment,\n  deleteApplication,\n  updateApplication,\n} from '../../services/applications.js'\n\n/**\n * `rollback` undoes the creation, so a later failure leaves no record stranded at the slug.\n * @internal\n */\nexport interface CreatedApplication {\n  application: Application\n  rollback: () => Promise<void>\n}\n\nfunction toBrettInterface(iface: DerivedInterface, version: string): BrettInterface {\n  const {id: _id, src: _src, ...declaration} = iface\n  if ('type' in declaration) return {...declaration, version}\n\n  switch (declaration.surface) {\n    case 'app': {\n      const {surface, ...view} = declaration\n      return {...view, type: surface, version}\n    }\n    case 'asset_source': {\n      const {surface, ...view} = declaration\n      return {...view, type: surface, version}\n    }\n    case 'panel': {\n      const {surface, ...view} = declaration\n      return {...view, type: surface, version}\n    }\n    case 'tile': {\n      const {surface, ...view} = declaration\n      return {...view, type: surface, version}\n    }\n  }\n}\n\n/**\n * Create a coreApp record (no deployment), so the CLI can build with its id\n * before shipping the first deployment. First deploy only.\n * @internal\n */\nexport async function createCoreApp(options: {\n  name?: string\n  organizationId: string\n  slug: string\n  title: string\n  visibility?: AppVisibility\n}): Promise<CreatedApplication> {\n  const spin = spinner('Creating application...').start()\n  try {\n    const application = await createApplication({...options, type: 'coreApp'})\n    spin.succeed()\n    return {application, rollback: () => deleteApplication(application.id)}\n  } catch (error) {\n    spin.fail()\n    throw error\n  }\n}\n\n/**\n * Create a studio record (no deployment).\n * @internal\n */\nexport async function createStudio(options: {\n  name?: string\n  organizationId: string\n  projectId: string | undefined\n  slug: string\n  title: string\n  visibility?: AppVisibility\n}): Promise<CreatedApplication> {\n  const spin = spinner('Creating studio...').start()\n  try {\n    const application = await createApplication({...options, type: 'studio'})\n    spin.succeed()\n    return {application, rollback: () => deleteApplication(application.id)}\n  } catch (error) {\n    spin.fail()\n    throw error\n  }\n}\n\n/**\n * Ship a deployment to an already-created (or `deployment.appId`) application,\n * then sync its mutable metadata (`title`, and `icon`/`visibility` when set)\n * from config. The deploy endpoint ignores these, so a redeploy patches them\n * here alongside the new deployment.\n *\n * `onDeployed` fires the instant the deployment is live, before the metadata\n * sync — so a caller can disarm a create-time rollback that must not delete an\n * application once it has an active deployment.\n * @internal\n */\nexport async function deployWorkbenchApp(options: {\n  access?: readonly BrettAccess[]\n  app: CliConfig['app']\n  applicationId: string\n  icon?: string\n  isApp: boolean\n  isAutoUpdating: boolean\n  label?: string\n  onDeployed?: () => void\n  sourceDir: string\n  title: string\n  version: string\n  visibility?: AppVisibility\n  workspaces?: readonly BrettWorkspace[]\n}): Promise<void> {\n  const {\n    access,\n    app,\n    applicationId,\n    icon,\n    isApp,\n    isAutoUpdating,\n    label = 'Deploying...',\n    onDeployed,\n    sourceDir,\n    title,\n    version,\n    visibility,\n    workspaces,\n  } = options\n  const tarball = pack(dirname(sourceDir), {entries: [basename(sourceDir)]}).pipe(createGzip())\n\n  const spin = spinner(label).start()\n  try {\n    await createDeployment({\n      access,\n      applicationId,\n      // Brett assigns the id and resolves modules by `moduleId`, so neither travels.\n      interfaces: deriveInterfaces(app, {appTitle: title, isApp}).map((iface) =>\n        toBrettInterface(iface, version),\n      ),\n      isAutoUpdating,\n      tarball,\n      version,\n      workspaces,\n    })\n    onDeployed?.()\n    await updateApplication(applicationId, {\n      title,\n      ...(icon ? {icon} : {}),\n      ...(visibility ? {visibility} : {}),\n    })\n    spin.succeed()\n  } catch (error) {\n    spin.clear()\n    throw error\n  }\n}\n"],"names":["basename","dirname","createGzip","spinner","pack","deriveInterfaces","createApplication","createDeployment","deleteApplication","updateApplication","toBrettInterface","iface","version","id","_id","src","_src","declaration","surface","view","type","createCoreApp","options","spin","start","application","succeed","rollback","error","fail","createStudio","deployWorkbenchApp","access","app","applicationId","icon","isApp","isAutoUpdating","label","onDeployed","sourceDir","title","visibility","workspaces","tarball","entries","pipe","interfaces","appTitle","map","clear"],"mappings":"AAAA,SAAQA,QAAQ,EAAEC,OAAO,QAAO,YAAW;AAC3C,SAAQC,UAAU,QAAO,YAAW;AAGpC,SAAQC,OAAO,QAAO,sBAAqB;AAC3C,SAAQC,IAAI,QAAO,SAAQ;AAE3B,SAA+BC,gBAAgB,QAAO,4BAA2B;AACjF,SAKEC,iBAAiB,EACjBC,gBAAgB,EAChBC,iBAAiB,EACjBC,iBAAiB,QACZ,iCAAgC;AAWvC,SAASC,iBAAiBC,KAAuB,EAAEC,OAAe;IAChE,MAAM,EAACC,IAAIC,GAAG,EAAEC,KAAKC,IAAI,EAAE,GAAGC,aAAY,GAAGN;IAC7C,IAAI,UAAUM,aAAa,OAAO;QAAC,GAAGA,WAAW;QAAEL;IAAO;IAE1D,OAAQK,YAAYC,OAAO;QACzB,KAAK;YAAO;gBACV,MAAM,EAACA,OAAO,EAAE,GAAGC,MAAK,GAAGF;gBAC3B,OAAO;oBAAC,GAAGE,IAAI;oBAAEC,MAAMF;oBAASN;gBAAO;YACzC;QACA,KAAK;YAAgB;gBACnB,MAAM,EAACM,OAAO,EAAE,GAAGC,MAAK,GAAGF;gBAC3B,OAAO;oBAAC,GAAGE,IAAI;oBAAEC,MAAMF;oBAASN;gBAAO;YACzC;QACA,KAAK;YAAS;gBACZ,MAAM,EAACM,OAAO,EAAE,GAAGC,MAAK,GAAGF;gBAC3B,OAAO;oBAAC,GAAGE,IAAI;oBAAEC,MAAMF;oBAASN;gBAAO;YACzC;QACA,KAAK;YAAQ;gBACX,MAAM,EAACM,OAAO,EAAE,GAAGC,MAAK,GAAGF;gBAC3B,OAAO;oBAAC,GAAGE,IAAI;oBAAEC,MAAMF;oBAASN;gBAAO;YACzC;IACF;AACF;AAEA;;;;CAIC,GACD,OAAO,eAAeS,cAAcC,OAMnC;IACC,MAAMC,OAAOpB,QAAQ,2BAA2BqB,KAAK;IACrD,IAAI;QACF,MAAMC,cAAc,MAAMnB,kBAAkB;YAAC,GAAGgB,OAAO;YAAEF,MAAM;QAAS;QACxEG,KAAKG,OAAO;QACZ,OAAO;YAACD;YAAaE,UAAU,IAAMnB,kBAAkBiB,YAAYZ,EAAE;QAAC;IACxE,EAAE,OAAOe,OAAO;QACdL,KAAKM,IAAI;QACT,MAAMD;IACR;AACF;AAEA;;;CAGC,GACD,OAAO,eAAeE,aAAaR,OAOlC;IACC,MAAMC,OAAOpB,QAAQ,sBAAsBqB,KAAK;IAChD,IAAI;QACF,MAAMC,cAAc,MAAMnB,kBAAkB;YAAC,GAAGgB,OAAO;YAAEF,MAAM;QAAQ;QACvEG,KAAKG,OAAO;QACZ,OAAO;YAACD;YAAaE,UAAU,IAAMnB,kBAAkBiB,YAAYZ,EAAE;QAAC;IACxE,EAAE,OAAOe,OAAO;QACdL,KAAKM,IAAI;QACT,MAAMD;IACR;AACF;AAEA;;;;;;;;;;CAUC,GACD,OAAO,eAAeG,mBAAmBT,OAcxC;IACC,MAAM,EACJU,MAAM,EACNC,GAAG,EACHC,aAAa,EACbC,IAAI,EACJC,KAAK,EACLC,cAAc,EACdC,QAAQ,cAAc,EACtBC,UAAU,EACVC,SAAS,EACTC,KAAK,EACL7B,OAAO,EACP8B,UAAU,EACVC,UAAU,EACX,GAAGrB;IACJ,MAAMsB,UAAUxC,KAAKH,QAAQuC,YAAY;QAACK,SAAS;YAAC7C,SAASwC;SAAW;IAAA,GAAGM,IAAI,CAAC5C;IAEhF,MAAMqB,OAAOpB,QAAQmC,OAAOd,KAAK;IACjC,IAAI;QACF,MAAMjB,iBAAiB;YACrByB;YACAE;YACA,+EAA+E;YAC/Ea,YAAY1C,iBAAiB4B,KAAK;gBAACe,UAAUP;gBAAOL;YAAK,GAAGa,GAAG,CAAC,CAACtC,QAC/DD,iBAAiBC,OAAOC;YAE1ByB;YACAO;YACAhC;YACA+B;QACF;QACAJ;QACA,MAAM9B,kBAAkByB,eAAe;YACrCO;YACA,GAAIN,OAAO;gBAACA;YAAI,IAAI,CAAC,CAAC;YACtB,GAAIO,aAAa;gBAACA;YAAU,IAAI,CAAC,CAAC;QACpC;QACAnB,KAAKG,OAAO;IACd,EAAE,OAAOE,OAAO;QACdL,KAAK2B,KAAK;QACV,MAAMtB;IACR;AACF"}
+{"version":3,"sources":["../../../src/actions/deploy/deployWorkbenchApp.ts"],"sourcesContent":["import {basename, dirname} from 'node:path'\nimport {createGzip} from 'node:zlib'\n\nimport {type AppVisibility, type CliConfig} from '@sanity/cli-core'\nimport {spinner} from '@sanity/cli-core/ux'\nimport {pack} from 'tar-fs'\n\nimport {type DerivedInterface, deriveInterfaces} from '../../deriveInterfaces.js'\nimport {\n  type Application,\n  type BrettAccess,\n  type BrettInterface,\n  type BrettWorkspace,\n  createApplication,\n  createDeployment,\n  deleteApplication,\n  updateApplication,\n} from '../../services/applications.js'\n\n/**\n * `rollback` undoes the creation, so a later failure leaves no record stranded at the slug.\n * @internal\n */\nexport interface CreatedApplication {\n  application: Application\n  rollback: () => Promise<void>\n}\n\nfunction toBrettInterface(iface: DerivedInterface, version: string): BrettInterface {\n  const {id: _id, src: _src, ...declaration} = iface\n  if ('type' in declaration) return {...declaration, version}\n\n  switch (declaration.surface) {\n    case 'app': {\n      const {surface, ...view} = declaration\n      return {...view, type: surface, version}\n    }\n    case 'asset_source': {\n      const {surface, ...view} = declaration\n      return {...view, type: surface, version}\n    }\n    case 'panel': {\n      const {surface, ...view} = declaration\n      return {...view, type: surface, version}\n    }\n    case 'tile': {\n      const {surface, ...view} = declaration\n      return {...view, type: surface, version}\n    }\n  }\n}\n\n/**\n * Create a coreApp record (no deployment), so the CLI can build with its id\n * before shipping the first deployment. First deploy only.\n * @internal\n */\nexport async function createCoreApp(options: {\n  isSingleton?: boolean\n  name?: string\n  organizationId: string\n  slug: string\n  title: string\n  visibility?: AppVisibility\n}): Promise<CreatedApplication> {\n  const spin = spinner('Creating application...').start()\n  try {\n    const application = await createApplication({...options, type: 'coreApp'})\n    spin.succeed()\n    return {application, rollback: () => deleteApplication(application.id)}\n  } catch (error) {\n    spin.fail()\n    throw error\n  }\n}\n\n/**\n * Create a studio record (no deployment).\n * @internal\n */\nexport async function createStudio(options: {\n  name?: string\n  organizationId: string\n  projectId: string | undefined\n  slug: string\n  title: string\n  visibility?: AppVisibility\n}): Promise<CreatedApplication> {\n  const spin = spinner('Creating studio...').start()\n  try {\n    const application = await createApplication({...options, type: 'studio'})\n    spin.succeed()\n    return {application, rollback: () => deleteApplication(application.id)}\n  } catch (error) {\n    spin.fail()\n    throw error\n  }\n}\n\n/**\n * Ship a deployment to an already-created (or `deployment.appId`) application,\n * then sync its mutable metadata (`title`, and `icon`/`visibility` when set)\n * from config. The deploy endpoint ignores these, so a redeploy patches them\n * here alongside the new deployment.\n *\n * `onDeployed` fires the instant the deployment is live, before the metadata\n * sync — so a caller can disarm a create-time rollback that must not delete an\n * application once it has an active deployment.\n * @internal\n */\nexport async function deployWorkbenchApp(options: {\n  access?: readonly BrettAccess[]\n  app: CliConfig['app']\n  applicationId: string\n  icon?: string\n  isApp: boolean\n  isAutoUpdating: boolean\n  label?: string\n  onDeployed?: () => void\n  sourceDir: string\n  title: string\n  version: string\n  visibility?: AppVisibility\n  workspaces?: readonly BrettWorkspace[]\n}): Promise<void> {\n  const {\n    access,\n    app,\n    applicationId,\n    icon,\n    isApp,\n    isAutoUpdating,\n    label = 'Deploying...',\n    onDeployed,\n    sourceDir,\n    title,\n    version,\n    visibility,\n    workspaces,\n  } = options\n  const tarball = pack(dirname(sourceDir), {entries: [basename(sourceDir)]}).pipe(createGzip())\n\n  const spin = spinner(label).start()\n  try {\n    await createDeployment({\n      access,\n      applicationId,\n      // Brett assigns the id and resolves modules by `moduleId`, so neither travels.\n      interfaces: deriveInterfaces(app, {appTitle: title, isApp}).map((iface) =>\n        toBrettInterface(iface, version),\n      ),\n      isAutoUpdating,\n      tarball,\n      version,\n      workspaces,\n    })\n    onDeployed?.()\n    await updateApplication(applicationId, {\n      title,\n      ...(icon ? {icon} : {}),\n      ...(visibility ? {visibility} : {}),\n    })\n    spin.succeed()\n  } catch (error) {\n    spin.clear()\n    throw error\n  }\n}\n"],"names":["basename","dirname","createGzip","spinner","pack","deriveInterfaces","createApplication","createDeployment","deleteApplication","updateApplication","toBrettInterface","iface","version","id","_id","src","_src","declaration","surface","view","type","createCoreApp","options","spin","start","application","succeed","rollback","error","fail","createStudio","deployWorkbenchApp","access","app","applicationId","icon","isApp","isAutoUpdating","label","onDeployed","sourceDir","title","visibility","workspaces","tarball","entries","pipe","interfaces","appTitle","map","clear"],"mappings":"AAAA,SAAQA,QAAQ,EAAEC,OAAO,QAAO,YAAW;AAC3C,SAAQC,UAAU,QAAO,YAAW;AAGpC,SAAQC,OAAO,QAAO,sBAAqB;AAC3C,SAAQC,IAAI,QAAO,SAAQ;AAE3B,SAA+BC,gBAAgB,QAAO,4BAA2B;AACjF,SAKEC,iBAAiB,EACjBC,gBAAgB,EAChBC,iBAAiB,EACjBC,iBAAiB,QACZ,iCAAgC;AAWvC,SAASC,iBAAiBC,KAAuB,EAAEC,OAAe;IAChE,MAAM,EAACC,IAAIC,GAAG,EAAEC,KAAKC,IAAI,EAAE,GAAGC,aAAY,GAAGN;IAC7C,IAAI,UAAUM,aAAa,OAAO;QAAC,GAAGA,WAAW;QAAEL;IAAO;IAE1D,OAAQK,YAAYC,OAAO;QACzB,KAAK;YAAO;gBACV,MAAM,EAACA,OAAO,EAAE,GAAGC,MAAK,GAAGF;gBAC3B,OAAO;oBAAC,GAAGE,IAAI;oBAAEC,MAAMF;oBAASN;gBAAO;YACzC;QACA,KAAK;YAAgB;gBACnB,MAAM,EAACM,OAAO,EAAE,GAAGC,MAAK,GAAGF;gBAC3B,OAAO;oBAAC,GAAGE,IAAI;oBAAEC,MAAMF;oBAASN;gBAAO;YACzC;QACA,KAAK;YAAS;gBACZ,MAAM,EAACM,OAAO,EAAE,GAAGC,MAAK,GAAGF;gBAC3B,OAAO;oBAAC,GAAGE,IAAI;oBAAEC,MAAMF;oBAASN;gBAAO;YACzC;QACA,KAAK;YAAQ;gBACX,MAAM,EAACM,OAAO,EAAE,GAAGC,MAAK,GAAGF;gBAC3B,OAAO;oBAAC,GAAGE,IAAI;oBAAEC,MAAMF;oBAASN;gBAAO;YACzC;IACF;AACF;AAEA;;;;CAIC,GACD,OAAO,eAAeS,cAAcC,OAOnC;IACC,MAAMC,OAAOpB,QAAQ,2BAA2BqB,KAAK;IACrD,IAAI;QACF,MAAMC,cAAc,MAAMnB,kBAAkB;YAAC,GAAGgB,OAAO;YAAEF,MAAM;QAAS;QACxEG,KAAKG,OAAO;QACZ,OAAO;YAACD;YAAaE,UAAU,IAAMnB,kBAAkBiB,YAAYZ,EAAE;QAAC;IACxE,EAAE,OAAOe,OAAO;QACdL,KAAKM,IAAI;QACT,MAAMD;IACR;AACF;AAEA;;;CAGC,GACD,OAAO,eAAeE,aAAaR,OAOlC;IACC,MAAMC,OAAOpB,QAAQ,sBAAsBqB,KAAK;IAChD,IAAI;QACF,MAAMC,cAAc,MAAMnB,kBAAkB;YAAC,GAAGgB,OAAO;YAAEF,MAAM;QAAQ;QACvEG,KAAKG,OAAO;QACZ,OAAO;YAACD;YAAaE,UAAU,IAAMnB,kBAAkBiB,YAAYZ,EAAE;QAAC;IACxE,EAAE,OAAOe,OAAO;QACdL,KAAKM,IAAI;QACT,MAAMD;IACR;AACF;AAEA;;;;;;;;;;CAUC,GACD,OAAO,eAAeG,mBAAmBT,OAcxC;IACC,MAAM,EACJU,MAAM,EACNC,GAAG,EACHC,aAAa,EACbC,IAAI,EACJC,KAAK,EACLC,cAAc,EACdC,QAAQ,cAAc,EACtBC,UAAU,EACVC,SAAS,EACTC,KAAK,EACL7B,OAAO,EACP8B,UAAU,EACVC,UAAU,EACX,GAAGrB;IACJ,MAAMsB,UAAUxC,KAAKH,QAAQuC,YAAY;QAACK,SAAS;YAAC7C,SAASwC;SAAW;IAAA,GAAGM,IAAI,CAAC5C;IAEhF,MAAMqB,OAAOpB,QAAQmC,OAAOd,KAAK;IACjC,IAAI;QACF,MAAMjB,iBAAiB;YACrByB;YACAE;YACA,+EAA+E;YAC/Ea,YAAY1C,iBAAiB4B,KAAK;gBAACe,UAAUP;gBAAOL;YAAK,GAAGa,GAAG,CAAC,CAACtC,QAC/DD,iBAAiBC,OAAOC;YAE1ByB;YACAO;YACAhC;YACA+B;QACF;QACAJ;QACA,MAAM9B,kBAAkByB,eAAe;YACrCO;YACA,GAAIN,OAAO;gBAACA;YAAI,IAAI,CAAC,CAAC;YACtB,GAAIO,aAAa;gBAACA;YAAU,IAAI,CAAC,CAAC;QACpC;QACAnB,KAAKG,OAAO;IACd,EAAE,OAAOE,OAAO;QACdL,KAAK2B,KAAK;QACV,MAAMtB;IACR;AACF"}

package/dist/defineApp.js

@@ -35,6 +35,7 @@ import { DockSchema, InterfaceDeclarationSchema, ServiceDeclarationSchema } from
      * on a studio is rejected (studio app views are not yet implemented).
      */ entry: z.optional(z.string("must be a path to the app's entry file")),
     /** Optional icon override (path to an SVG). Wins over manifest/studio icon. */ icon: z.optional(z.string()),
+    /** Sanity-owned app deployed once and installed per org. @internal */ isSingleton: z.optional(z.boolean()),
     /**
      * Stable identity, distinct from the `slug` address. Defaults to `slug` when
      * omitted. Identity keys — the build id and derived interface ids — are built

package/dist/defineApp.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/defineApp.ts"],"sourcesContent":["import {z} from 'zod/mini'\n\nimport {APP_SLUG_PATTERN} from './appSlug.js'\nimport {DockSchema, InterfaceDeclarationSchema, ServiceDeclarationSchema} from './contract.js'\n\n/**\n * Dashboard visibility values. Mirrors `APP_VISIBILITIES` in `@sanity/cli-core`\n * (which can't be imported here — pulling the barrel into this lean module bloats\n * the config-load path). Kept in sync by a type test in `defineApp.test.ts`.\n */\nconst APP_VISIBILITIES = ['default', 'unlisted', 'disabled'] as const\n\n/**\n * Internal application discriminator. Sanity-owned singleton apps only;\n * validated by the schema but excluded from the public `DefineAppInput` type.\n */\nconst ApplicationType = z.enum(['coreApp', 'studio', 'canvas', 'dashboard'])\n\n/**\n * Runtime-validation schema for `defineApplication`.\n * @internal\n */\nexport const DefineAppInputSchema = z\n  .object({\n    /**\n     * Internal — Sanity-owned singleton apps only. Validated here but excluded\n     * from the public `DefineAppInput` type.\n     * @internal\n     */\n    applicationType: z.optional(ApplicationType),\n    /** Default placement inherited by panel and window views. */\n    dock: z.optional(DockSchema),\n    /**\n     * App entrypoint module. Defaults to `./src/App.tsx` when omitted. The build\n     * derives the app's navigable `app` view from it. SDK apps only — setting it\n     * on a studio is rejected (studio app views are not yet implemented).\n     */\n    entry: z.optional(z.string(\"must be a path to the app's entry file\")),\n    /** Optional icon override (path to an SVG). Wins over manifest/studio icon. */\n    icon: z.optional(z.string()),\n    /**\n     * Stable identity, distinct from the `slug` address. Defaults to `slug` when\n     * omitted. Identity keys — the build id and derived interface ids — are built\n     * from this, so renaming the slug no longer changes identity.\n     */\n    name: z.optional(\n      z\n        .string()\n        .check(\n          z.regex(\n            APP_SLUG_PATTERN,\n            'App `name` must be lowercase alphanumerics and hyphens, starting with a letter and ending with an alphanumeric',\n          ),\n        ),\n    ),\n    /** Organization that owns the app — the workbench runs and deploys against it. */\n    organizationId: z.string(\n      \"App `organizationId` is required — pass the owning organization's ID to `defineApplication`\",\n    ),\n    slug: z\n      .string('App `slug` is required — the hostname the application is created at on deploy')\n      .check(\n        z.regex(\n          APP_SLUG_PATTERN,\n          'App `slug` must be lowercase alphanumerics and hyphens, starting with a letter and ending with an alphanumeric',\n        ),\n      ),\n    /** User-facing app title. Wins over studio.config.ts title on merge. */\n    title: z.string(),\n    /** Views the app exposes (e.g. a window, dock panels, and tiles). */\n    views: z.optional(z.array(InterfaceDeclarationSchema, 'must be an array of views')),\n    /** Dashboard visibility of the app. Defaults to `default` when omitted. */\n    visibility: z.optional(z.enum(APP_VISIBILITIES)),\n    /** Background web workers the app runs. */\n    webWorkers: z.optional(z.array(ServiceDeclarationSchema, 'must be an array of web workers')),\n  })\n  .check(\n    z.refine((input) => {\n      const names = [\n        ...(input.entry === undefined ? [] : [input.name ?? input.slug]),\n        ...(input.views ?? []).map((view) => view.name),\n        ...(input.webWorkers ?? []).map((webWorker) => webWorker.name),\n      ]\n      return new Set(names).size === names.length\n    }, '`name` must be unique across views and web workers. Rename one of the duplicates.'),\n    // Studio app views are not implemented yet. A studio that declares `entry`\n    // (the SDK app-view entrypoint) is rejected here rather than silently\n    // generating one; studios keep navigating via their existing render path.\n    z.refine((input) => !(input.applicationType === 'studio' && input.entry !== undefined), {\n      error: 'App views for studios are not implemented yet',\n      path: ['entry'],\n    }),\n  )\n\n/**\n * User-facing input for `defineApplication`. Excludes the internal\n * `applicationType`.\n * @public\n */\nexport type DefineAppInput = Omit<z.output<typeof DefineAppInputSchema>, 'applicationType'>\n\n/**\n * Nominal brand the CLI discriminates on to enable the workbench build/deploy\n * codepath. Registered via `Symbol.for` so the marker survives module-realm\n * boundaries — `@sanity/cli-core` re-derives the same global symbol with\n * `Symbol.for` rather than importing it, so it stays internal to this module.\n */\nconst WORKBENCH_APP: unique symbol = Symbol.for('sanity.workbench.defineApp')\n\n/**\n * The branded result of `defineApplication`. Carries the same fields as the\n * input plus the internal brand — users only ever see `DefineAppInput`.\n * @public\n */\nexport type DefineAppResult = DefineAppInput & {readonly [WORKBENCH_APP]: true}\n\n/**\n * A branded app as the CLI reads it — the full schema shape, including the\n * internal fields `DefineAppInput` omits. Schema-derived so the narrowing\n * can't drift from what the schema validates.\n * @public\n */\nexport type WorkbenchApp = DefineAppResult & z.output<typeof DefineAppInputSchema>\n\n/**\n * Whether `app` is a branded `defineApplication(...)` result — the sole\n * workbench opt-in.\n * @public\n */\nexport function isWorkbenchApp(app: unknown): app is WorkbenchApp {\n  return typeof app === 'object' && app !== null && WORKBENCH_APP in app\n}\n\n/**\n * Declare a Sanity Workbench application. Identity at runtime — returns the same\n * object reference, tagged with the workbench brand. Field validation (the\n * `slug` pattern etc.) runs at build time in the CLI via `DefineAppInputSchema`;\n * this helper stays a thin, pure identity wrapper.\n * @public\n */\nexport function defineApplication(input: DefineAppInput): DefineAppResult {\n  return Object.defineProperty(input, WORKBENCH_APP, {\n    configurable: false,\n    enumerable: false,\n    value: true,\n    writable: false,\n  }) as DefineAppResult\n}\n\n/**\n * One custom field a media library exposes. `src` default-exports a `defineField(...)` schema type.\n * @public\n */\nexport interface MediaLibraryField {\n  /** Unique within the media library. */\n  name: string\n  src: string\n  title: string\n\n  /** Readable outside the owning organization. */\n  public?: boolean\n}\n\n/**\n * Sanity-owned singleton, so authors don't name or title the app — only `organizationId` is required.\n * @public\n */\nexport interface DefineMediaLibraryInput {\n  /** Organization that owns the media library — the CLI runs and deploys against it. */\n  organizationId: string\n\n  fields?: MediaLibraryField[]\n}\n\n/**\n * Nominal brand the CLI discriminates a config on. A config is *not* an app: it\n * carries no `slug`/`title`/application identity, only a target `appType`, its\n * owning `organizationId`, and its `fields`. Registered via `Symbol.for` so the\n * marker survives module-realm boundaries — `@sanity/cli-core` re-derives the\n * same global symbol rather than importing it.\n */\nconst WORKBENCH_CONFIG: unique symbol = Symbol.for('sanity.workbench.defineConfig')\n\n/**\n * A branded workbench config as the CLI reads it: bound to its target app by\n * `appType`, not carrying its own app identity. The deploy/undeploy/build paths\n * discriminate it via {@link isWorkbenchConfig}.\n * @public\n */\nexport interface WorkbenchConfig {\n  appType: 'media-library'\n  fields: MediaLibraryField[]\n  organizationId: string\n  readonly [WORKBENCH_CONFIG]: true\n}\n\n/**\n * Whether `app` is a branded `unstable_defineMediaLibrary(...)` config — a\n * config-carrier rather than an app. Configs live in `cliConfig.app` alongside\n * apps but resolve through `resolveWorkbenchConfig`, not `resolveWorkbenchApp`.\n * @public\n */\nexport function isWorkbenchConfig(app: unknown): app is WorkbenchConfig {\n  return typeof app === 'object' && app !== null && WORKBENCH_CONFIG in app\n}\n\n/**\n * Declare the Sanity Media Library config. The Media Library is a Sanity-owned\n * singleton, so this is not an app — it carries no slug or title, only the\n * target `appType`, its owning organization, and the `fields` it contributes to\n * the installation's config.\n * @public\n */\nexport function unstable_defineMediaLibrary(input: DefineMediaLibraryInput): WorkbenchConfig {\n  return Object.defineProperty(\n    {appType: 'media-library', fields: input.fields ?? [], organizationId: input.organizationId},\n    WORKBENCH_CONFIG,\n    {configurable: false, enumerable: false, value: true, writable: false},\n  ) as WorkbenchConfig\n}\n"],"names":["z","APP_SLUG_PATTERN","DockSchema","InterfaceDeclarationSchema","ServiceDeclarationSchema","APP_VISIBILITIES","ApplicationType","enum","DefineAppInputSchema","object","applicationType","optional","dock","entry","string","icon","name","check","regex","organizationId","slug","title","views","array","visibility","webWorkers","refine","input","names","undefined","map","view","webWorker","Set","size","length","error","path","WORKBENCH_APP","Symbol","for","isWorkbenchApp","app","defineApplication","Object","defineProperty","configurable","enumerable","value","writable","WORKBENCH_CONFIG","isWorkbenchConfig","unstable_defineMediaLibrary","appType","fields"],"mappings":"AAAA,SAAQA,CAAC,QAAO,WAAU;AAE1B,SAAQC,gBAAgB,QAAO,eAAc;AAC7C,SAAQC,UAAU,EAAEC,0BAA0B,EAAEC,wBAAwB,QAAO,gBAAe;AAE9F;;;;CAIC,GACD,MAAMC,mBAAmB;IAAC;IAAW;IAAY;CAAW;AAE5D;;;CAGC,GACD,MAAMC,kBAAkBN,EAAEO,IAAI,CAAC;IAAC;IAAW;IAAU;IAAU;CAAY;AAE3E;;;CAGC,GACD,OAAO,MAAMC,uBAAuBR,EACjCS,MAAM,CAAC;IACN;;;;KAIC,GACDC,iBAAiBV,EAAEW,QAAQ,CAACL;IAC5B,2DAA2D,GAC3DM,MAAMZ,EAAEW,QAAQ,CAACT;IACjB;;;;KAIC,GACDW,OAAOb,EAAEW,QAAQ,CAACX,EAAEc,MAAM,CAAC;IAC3B,6EAA6E,GAC7EC,MAAMf,EAAEW,QAAQ,CAACX,EAAEc,MAAM;IACzB;;;;KAIC,GACDE,MAAMhB,EAAEW,QAAQ,CACdX,EACGc,MAAM,GACNG,KAAK,CACJjB,EAAEkB,KAAK,CACLjB,kBACA;IAIR,gFAAgF,GAChFkB,gBAAgBnB,EAAEc,MAAM,CACtB;IAEFM,MAAMpB,EACHc,MAAM,CAAC,iFACPG,KAAK,CACJjB,EAAEkB,KAAK,CACLjB,kBACA;IAGN,sEAAsE,GACtEoB,OAAOrB,EAAEc,MAAM;IACf,mEAAmE,GACnEQ,OAAOtB,EAAEW,QAAQ,CAACX,EAAEuB,KAAK,CAACpB,4BAA4B;IACtD,yEAAyE,GACzEqB,YAAYxB,EAAEW,QAAQ,CAACX,EAAEO,IAAI,CAACF;IAC9B,yCAAyC,GACzCoB,YAAYzB,EAAEW,QAAQ,CAACX,EAAEuB,KAAK,CAACnB,0BAA0B;AAC3D,GACCa,KAAK,CACJjB,EAAE0B,MAAM,CAAC,CAACC;IACR,MAAMC,QAAQ;WACRD,MAAMd,KAAK,KAAKgB,YAAY,EAAE,GAAG;YAACF,MAAMX,IAAI,IAAIW,MAAMP,IAAI;SAAC;WAC5D,AAACO,CAAAA,MAAML,KAAK,IAAI,EAAE,AAAD,EAAGQ,GAAG,CAAC,CAACC,OAASA,KAAKf,IAAI;WAC3C,AAACW,CAAAA,MAAMF,UAAU,IAAI,EAAE,AAAD,EAAGK,GAAG,CAAC,CAACE,YAAcA,UAAUhB,IAAI;KAC9D;IACD,OAAO,IAAIiB,IAAIL,OAAOM,IAAI,KAAKN,MAAMO,MAAM;AAC7C,GAAG,sFACH,2EAA2E;AAC3E,sEAAsE;AACtE,0EAA0E;AAC1EnC,EAAE0B,MAAM,CAAC,CAACC,QAAU,CAAEA,CAAAA,MAAMjB,eAAe,KAAK,YAAYiB,MAAMd,KAAK,KAAKgB,SAAQ,GAAI;IACtFO,OAAO;IACPC,MAAM;QAAC;KAAQ;AACjB,IACD;AASH;;;;;CAKC,GACD,MAAMC,gBAA+BC,OAAOC,GAAG,CAAC;AAiBhD;;;;CAIC,GACD,OAAO,SAASC,eAAeC,GAAY;IACzC,OAAO,OAAOA,QAAQ,YAAYA,QAAQ,QAAQJ,iBAAiBI;AACrE;AAEA;;;;;;CAMC,GACD,OAAO,SAASC,kBAAkBhB,KAAqB;IACrD,OAAOiB,OAAOC,cAAc,CAAClB,OAAOW,eAAe;QACjDQ,cAAc;QACdC,YAAY;QACZC,OAAO;QACPC,UAAU;IACZ;AACF;AA2BA;;;;;;CAMC,GACD,MAAMC,mBAAkCX,OAAOC,GAAG,CAAC;AAenD;;;;;CAKC,GACD,OAAO,SAASW,kBAAkBT,GAAY;IAC5C,OAAO,OAAOA,QAAQ,YAAYA,QAAQ,QAAQQ,oBAAoBR;AACxE;AAEA;;;;;;CAMC,GACD,OAAO,SAASU,4BAA4BzB,KAA8B;IACxE,OAAOiB,OAAOC,cAAc,CAC1B;QAACQ,SAAS;QAAiBC,QAAQ3B,MAAM2B,MAAM,IAAI,EAAE;QAAEnC,gBAAgBQ,MAAMR,cAAc;IAAA,GAC3F+B,kBACA;QAACJ,cAAc;QAAOC,YAAY;QAAOC,OAAO;QAAMC,UAAU;IAAK;AAEzE"}
+{"version":3,"sources":["../src/defineApp.ts"],"sourcesContent":["import {z} from 'zod/mini'\n\nimport {APP_SLUG_PATTERN} from './appSlug.js'\nimport {DockSchema, InterfaceDeclarationSchema, ServiceDeclarationSchema} from './contract.js'\n\n/**\n * Dashboard visibility values. Mirrors `APP_VISIBILITIES` in `@sanity/cli-core`\n * (which can't be imported here — pulling the barrel into this lean module bloats\n * the config-load path). Kept in sync by a type test in `defineApp.test.ts`.\n */\nconst APP_VISIBILITIES = ['default', 'unlisted', 'disabled'] as const\n\n/**\n * Internal application discriminator. Sanity-owned singleton apps only;\n * validated by the schema but excluded from the public `DefineAppInput` type.\n */\nconst ApplicationType = z.enum(['coreApp', 'studio', 'canvas', 'dashboard'])\n\n/**\n * Runtime-validation schema for `defineApplication`.\n * @internal\n */\nexport const DefineAppInputSchema = z\n  .object({\n    /**\n     * Internal — Sanity-owned singleton apps only. Validated here but excluded\n     * from the public `DefineAppInput` type.\n     * @internal\n     */\n    applicationType: z.optional(ApplicationType),\n    /** Default placement inherited by panel and window views. */\n    dock: z.optional(DockSchema),\n    /**\n     * App entrypoint module. Defaults to `./src/App.tsx` when omitted. The build\n     * derives the app's navigable `app` view from it. SDK apps only — setting it\n     * on a studio is rejected (studio app views are not yet implemented).\n     */\n    entry: z.optional(z.string(\"must be a path to the app's entry file\")),\n    /** Optional icon override (path to an SVG). Wins over manifest/studio icon. */\n    icon: z.optional(z.string()),\n    /** Sanity-owned app deployed once and installed per org. @internal */\n    isSingleton: z.optional(z.boolean()),\n    /**\n     * Stable identity, distinct from the `slug` address. Defaults to `slug` when\n     * omitted. Identity keys — the build id and derived interface ids — are built\n     * from this, so renaming the slug no longer changes identity.\n     */\n    name: z.optional(\n      z\n        .string()\n        .check(\n          z.regex(\n            APP_SLUG_PATTERN,\n            'App `name` must be lowercase alphanumerics and hyphens, starting with a letter and ending with an alphanumeric',\n          ),\n        ),\n    ),\n    /** Organization that owns the app — the workbench runs and deploys against it. */\n    organizationId: z.string(\n      \"App `organizationId` is required — pass the owning organization's ID to `defineApplication`\",\n    ),\n    slug: z\n      .string('App `slug` is required — the hostname the application is created at on deploy')\n      .check(\n        z.regex(\n          APP_SLUG_PATTERN,\n          'App `slug` must be lowercase alphanumerics and hyphens, starting with a letter and ending with an alphanumeric',\n        ),\n      ),\n    /** User-facing app title. Wins over studio.config.ts title on merge. */\n    title: z.string(),\n    /** Views the app exposes (e.g. a window, dock panels, and tiles). */\n    views: z.optional(z.array(InterfaceDeclarationSchema, 'must be an array of views')),\n    /** Dashboard visibility of the app. Defaults to `default` when omitted. */\n    visibility: z.optional(z.enum(APP_VISIBILITIES)),\n    /** Background web workers the app runs. */\n    webWorkers: z.optional(z.array(ServiceDeclarationSchema, 'must be an array of web workers')),\n  })\n  .check(\n    z.refine((input) => {\n      const names = [\n        ...(input.entry === undefined ? [] : [input.name ?? input.slug]),\n        ...(input.views ?? []).map((view) => view.name),\n        ...(input.webWorkers ?? []).map((webWorker) => webWorker.name),\n      ]\n      return new Set(names).size === names.length\n    }, '`name` must be unique across views and web workers. Rename one of the duplicates.'),\n    // Studio app views are not implemented yet. A studio that declares `entry`\n    // (the SDK app-view entrypoint) is rejected here rather than silently\n    // generating one; studios keep navigating via their existing render path.\n    z.refine((input) => !(input.applicationType === 'studio' && input.entry !== undefined), {\n      error: 'App views for studios are not implemented yet',\n      path: ['entry'],\n    }),\n  )\n\n/**\n * User-facing input for `defineApplication`. Excludes the internal\n * `applicationType` and `isSingleton`.\n * @public\n */\nexport type DefineAppInput = Omit<\n  z.output<typeof DefineAppInputSchema>,\n  'applicationType' | 'isSingleton'\n>\n\n/**\n * Nominal brand the CLI discriminates on to enable the workbench build/deploy\n * codepath. Registered via `Symbol.for` so the marker survives module-realm\n * boundaries — `@sanity/cli-core` re-derives the same global symbol with\n * `Symbol.for` rather than importing it, so it stays internal to this module.\n */\nconst WORKBENCH_APP: unique symbol = Symbol.for('sanity.workbench.defineApp')\n\n/**\n * The branded result of `defineApplication`. Carries the same fields as the\n * input plus the internal brand — users only ever see `DefineAppInput`.\n * @public\n */\nexport type DefineAppResult = DefineAppInput & {readonly [WORKBENCH_APP]: true}\n\n/**\n * A branded app as the CLI reads it — the full schema shape, including the\n * internal fields `DefineAppInput` omits. Schema-derived so the narrowing\n * can't drift from what the schema validates.\n * @public\n */\nexport type WorkbenchApp = DefineAppResult & z.output<typeof DefineAppInputSchema>\n\n/**\n * Whether `app` is a branded `defineApplication(...)` result — the sole\n * workbench opt-in.\n * @public\n */\nexport function isWorkbenchApp(app: unknown): app is WorkbenchApp {\n  return typeof app === 'object' && app !== null && WORKBENCH_APP in app\n}\n\n/**\n * Declare a Sanity Workbench application. Identity at runtime — returns the same\n * object reference, tagged with the workbench brand. Field validation (the\n * `slug` pattern etc.) runs at build time in the CLI via `DefineAppInputSchema`;\n * this helper stays a thin, pure identity wrapper.\n * @public\n */\nexport function defineApplication(input: DefineAppInput): DefineAppResult {\n  return Object.defineProperty(input, WORKBENCH_APP, {\n    configurable: false,\n    enumerable: false,\n    value: true,\n    writable: false,\n  }) as DefineAppResult\n}\n\n/**\n * One custom field a media library exposes. `src` default-exports a `defineField(...)` schema type.\n * @public\n */\nexport interface MediaLibraryField {\n  /** Unique within the media library. */\n  name: string\n  src: string\n  title: string\n\n  /** Readable outside the owning organization. */\n  public?: boolean\n}\n\n/**\n * Sanity-owned singleton, so authors don't name or title the app — only `organizationId` is required.\n * @public\n */\nexport interface DefineMediaLibraryInput {\n  /** Organization that owns the media library — the CLI runs and deploys against it. */\n  organizationId: string\n\n  fields?: MediaLibraryField[]\n}\n\n/**\n * Nominal brand the CLI discriminates a config on. A config is *not* an app: it\n * carries no `slug`/`title`/application identity, only a target `appType`, its\n * owning `organizationId`, and its `fields`. Registered via `Symbol.for` so the\n * marker survives module-realm boundaries — `@sanity/cli-core` re-derives the\n * same global symbol rather than importing it.\n */\nconst WORKBENCH_CONFIG: unique symbol = Symbol.for('sanity.workbench.defineConfig')\n\n/**\n * A branded workbench config as the CLI reads it: bound to its target app by\n * `appType`, not carrying its own app identity. The deploy/undeploy/build paths\n * discriminate it via {@link isWorkbenchConfig}.\n * @public\n */\nexport interface WorkbenchConfig {\n  appType: 'media-library'\n  fields: MediaLibraryField[]\n  organizationId: string\n  readonly [WORKBENCH_CONFIG]: true\n}\n\n/**\n * Whether `app` is a branded `unstable_defineMediaLibrary(...)` config — a\n * config-carrier rather than an app. Configs live in `cliConfig.app` alongside\n * apps but resolve through `resolveWorkbenchConfig`, not `resolveWorkbenchApp`.\n * @public\n */\nexport function isWorkbenchConfig(app: unknown): app is WorkbenchConfig {\n  return typeof app === 'object' && app !== null && WORKBENCH_CONFIG in app\n}\n\n/**\n * Declare the Sanity Media Library config. The Media Library is a Sanity-owned\n * singleton, so this is not an app — it carries no slug or title, only the\n * target `appType`, its owning organization, and the `fields` it contributes to\n * the installation's config.\n * @public\n */\nexport function unstable_defineMediaLibrary(input: DefineMediaLibraryInput): WorkbenchConfig {\n  return Object.defineProperty(\n    {appType: 'media-library', fields: input.fields ?? [], organizationId: input.organizationId},\n    WORKBENCH_CONFIG,\n    {configurable: false, enumerable: false, value: true, writable: false},\n  ) as WorkbenchConfig\n}\n"],"names":["z","APP_SLUG_PATTERN","DockSchema","InterfaceDeclarationSchema","ServiceDeclarationSchema","APP_VISIBILITIES","ApplicationType","enum","DefineAppInputSchema","object","applicationType","optional","dock","entry","string","icon","isSingleton","boolean","name","check","regex","organizationId","slug","title","views","array","visibility","webWorkers","refine","input","names","undefined","map","view","webWorker","Set","size","length","error","path","WORKBENCH_APP","Symbol","for","isWorkbenchApp","app","defineApplication","Object","defineProperty","configurable","enumerable","value","writable","WORKBENCH_CONFIG","isWorkbenchConfig","unstable_defineMediaLibrary","appType","fields"],"mappings":"AAAA,SAAQA,CAAC,QAAO,WAAU;AAE1B,SAAQC,gBAAgB,QAAO,eAAc;AAC7C,SAAQC,UAAU,EAAEC,0BAA0B,EAAEC,wBAAwB,QAAO,gBAAe;AAE9F;;;;CAIC,GACD,MAAMC,mBAAmB;IAAC;IAAW;IAAY;CAAW;AAE5D;;;CAGC,GACD,MAAMC,kBAAkBN,EAAEO,IAAI,CAAC;IAAC;IAAW;IAAU;IAAU;CAAY;AAE3E;;;CAGC,GACD,OAAO,MAAMC,uBAAuBR,EACjCS,MAAM,CAAC;IACN;;;;KAIC,GACDC,iBAAiBV,EAAEW,QAAQ,CAACL;IAC5B,2DAA2D,GAC3DM,MAAMZ,EAAEW,QAAQ,CAACT;IACjB;;;;KAIC,GACDW,OAAOb,EAAEW,QAAQ,CAACX,EAAEc,MAAM,CAAC;IAC3B,6EAA6E,GAC7EC,MAAMf,EAAEW,QAAQ,CAACX,EAAEc,MAAM;IACzB,oEAAoE,GACpEE,aAAahB,EAAEW,QAAQ,CAACX,EAAEiB,OAAO;IACjC;;;;KAIC,GACDC,MAAMlB,EAAEW,QAAQ,CACdX,EACGc,MAAM,GACNK,KAAK,CACJnB,EAAEoB,KAAK,CACLnB,kBACA;IAIR,gFAAgF,GAChFoB,gBAAgBrB,EAAEc,MAAM,CACtB;IAEFQ,MAAMtB,EACHc,MAAM,CAAC,iFACPK,KAAK,CACJnB,EAAEoB,KAAK,CACLnB,kBACA;IAGN,sEAAsE,GACtEsB,OAAOvB,EAAEc,MAAM;IACf,mEAAmE,GACnEU,OAAOxB,EAAEW,QAAQ,CAACX,EAAEyB,KAAK,CAACtB,4BAA4B;IACtD,yEAAyE,GACzEuB,YAAY1B,EAAEW,QAAQ,CAACX,EAAEO,IAAI,CAACF;IAC9B,yCAAyC,GACzCsB,YAAY3B,EAAEW,QAAQ,CAACX,EAAEyB,KAAK,CAACrB,0BAA0B;AAC3D,GACCe,KAAK,CACJnB,EAAE4B,MAAM,CAAC,CAACC;IACR,MAAMC,QAAQ;WACRD,MAAMhB,KAAK,KAAKkB,YAAY,EAAE,GAAG;YAACF,MAAMX,IAAI,IAAIW,MAAMP,IAAI;SAAC;WAC5D,AAACO,CAAAA,MAAML,KAAK,IAAI,EAAE,AAAD,EAAGQ,GAAG,CAAC,CAACC,OAASA,KAAKf,IAAI;WAC3C,AAACW,CAAAA,MAAMF,UAAU,IAAI,EAAE,AAAD,EAAGK,GAAG,CAAC,CAACE,YAAcA,UAAUhB,IAAI;KAC9D;IACD,OAAO,IAAIiB,IAAIL,OAAOM,IAAI,KAAKN,MAAMO,MAAM;AAC7C,GAAG,sFACH,2EAA2E;AAC3E,sEAAsE;AACtE,0EAA0E;AAC1ErC,EAAE4B,MAAM,CAAC,CAACC,QAAU,CAAEA,CAAAA,MAAMnB,eAAe,KAAK,YAAYmB,MAAMhB,KAAK,KAAKkB,SAAQ,GAAI;IACtFO,OAAO;IACPC,MAAM;QAAC;KAAQ;AACjB,IACD;AAYH;;;;;CAKC,GACD,MAAMC,gBAA+BC,OAAOC,GAAG,CAAC;AAiBhD;;;;CAIC,GACD,OAAO,SAASC,eAAeC,GAAY;IACzC,OAAO,OAAOA,QAAQ,YAAYA,QAAQ,QAAQJ,iBAAiBI;AACrE;AAEA;;;;;;CAMC,GACD,OAAO,SAASC,kBAAkBhB,KAAqB;IACrD,OAAOiB,OAAOC,cAAc,CAAClB,OAAOW,eAAe;QACjDQ,cAAc;QACdC,YAAY;QACZC,OAAO;QACPC,UAAU;IACZ;AACF;AA2BA;;;;;;CAMC,GACD,MAAMC,mBAAkCX,OAAOC,GAAG,CAAC;AAenD;;;;;CAKC,GACD,OAAO,SAASW,kBAAkBT,GAAY;IAC5C,OAAO,OAAOA,QAAQ,YAAYA,QAAQ,QAAQQ,oBAAoBR;AACxE;AAEA;;;;;;CAMC,GACD,OAAO,SAASU,4BAA4BzB,KAA8B;IACxE,OAAOiB,OAAOC,cAAc,CAC1B;QAACQ,SAAS;QAAiBC,QAAQ3B,MAAM2B,MAAM,IAAI,EAAE;QAAEnC,gBAAgBQ,MAAMR,cAAc;IAAA,GAC3F+B,kBACA;QAACJ,cAAc;QAAOC,YAAY;QAAOC,OAAO;QAAMC,UAAU;IAAK;AAEzE"}

package/dist/resolveWorkbenchApp.js

@@ -21,6 +21,9 @@ import { formatWorkbenchAppErrors, validateWorkbenchApp } from './validateWorkbe
         applicationType: app.applicationType,
         entry: app.entry,
         icon: app.icon,
+        ...app.isSingleton === undefined ? {} : {
+            isSingleton: app.isSingleton
+        },
         // Identity defaults to the address, so existing apps behave identically.
         name: app.name ?? app.slug,
         organizationId: app.organizationId,

package/dist/resolveWorkbenchApp.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/resolveWorkbenchApp.ts"],"sourcesContent":["// Package-internal shared resolver: turn a CLI config's branded\n// `defineApplication` app into its declared interfaces, or `null` for a plain\n// project — and for a config (a branded `unstable_defineMediaLibrary`), which\n// is not an app. The build and deploy accessors (actions/build, actions/deploy)\n// each build their command-specific view on top of this one brand-check +\n// extraction, so the discrimination lives in exactly one place.\n\nimport {type AppVisibility, type CliConfig} from '@sanity/cli-core'\n\nimport {type WorkbenchConfigValue} from './contract.js'\nimport {type DefineAppInput, isWorkbenchApp} from './defineApp.js'\nimport {formatWorkbenchAppErrors, validateWorkbenchApp} from './validateWorkbenchApp.js'\n\n/**\n * Bundled so adding a declaration family touches this type and the artifact\n * expanders, not every hop of build/dev plumbing in between. `config` is sourced\n * from `resolveWorkbenchConfig` (a config is not an app), not from this resolver.\n * @internal\n */\nexport interface WorkbenchExposes {\n  config?: WorkbenchConfigValue\n  views?: DefineAppInput['views']\n  webWorkers?: DefineAppInput['webWorkers']\n}\n\n/** @public */\nexport interface ResolvedWorkbenchApp {\n  /**\n   * Stable identity, distinct from the `slug` address. Defaults to `slug`, and is\n   * what every identity key (build id, interface ids) is built from.\n   */\n  readonly name: string\n  /** Organization that owns the app — part of its build-id identity. */\n  readonly organizationId: string\n  readonly slug: string\n\n  /** Views the app declares. */\n  readonly views: NonNullable<DefineAppInput['views']>\n\n  /** Background web workers the app declares. */\n  readonly webWorkers: NonNullable<DefineAppInput['webWorkers']>\n\n  /** Resolved app kind — `studio` or one of the SDK app types. */\n  readonly applicationType?: string\n  /** SDK app-view entrypoint, when declared. */\n  readonly entry?: string\n  /** Path to the app's icon SVG, resolved and shipped to Brett on deploy. */\n  readonly icon?: string\n  /** Dashboard visibility declared by the app; `undefined` when unset. */\n  readonly visibility?: AppVisibility\n}\n\n/**\n * Resolve the workbench app for a CLI config, or `null` for a plain project or a\n * config (which is not an app — read it with `resolveWorkbenchConfig`).\n * @public\n */\nexport function resolveWorkbenchApp(\n  cliConfig: CliConfig | null | undefined,\n): ResolvedWorkbenchApp | null {\n  const app = cliConfig?.app\n  // A config carries a distinct brand, so `isWorkbenchApp` is false for it — it\n  // resolves to `null` here, like a plain project.\n  if (!isWorkbenchApp(app)) return null\n\n  const errors = validateWorkbenchApp(app)\n  if (errors.length > 0) throw new Error(formatWorkbenchAppErrors(errors))\n\n  return {\n    applicationType: app.applicationType,\n    entry: app.entry,\n    icon: app.icon,\n    // Identity defaults to the address, so existing apps behave identically.\n    name: app.name ?? app.slug,\n    organizationId: app.organizationId,\n    slug: app.slug,\n    views: app.views ?? [],\n    visibility: app.visibility,\n    webWorkers: app.webWorkers ?? [],\n  }\n}\n"],"names":["isWorkbenchApp","formatWorkbenchAppErrors","validateWorkbenchApp","resolveWorkbenchApp","cliConfig","app","errors","length","Error","applicationType","entry","icon","name","slug","organizationId","views","visibility","webWorkers"],"mappings":"AAAA,gEAAgE;AAChE,8EAA8E;AAC9E,8EAA8E;AAC9E,gFAAgF;AAChF,0EAA0E;AAC1E,gEAAgE;AAKhE,SAA6BA,cAAc,QAAO,iBAAgB;AAClE,SAAQC,wBAAwB,EAAEC,oBAAoB,QAAO,4BAA2B;AAyCxF;;;;CAIC,GACD,OAAO,SAASC,oBACdC,SAAuC;IAEvC,MAAMC,MAAMD,WAAWC;IACvB,8EAA8E;IAC9E,iDAAiD;IACjD,IAAI,CAACL,eAAeK,MAAM,OAAO;IAEjC,MAAMC,SAASJ,qBAAqBG;IACpC,IAAIC,OAAOC,MAAM,GAAG,GAAG,MAAM,IAAIC,MAAMP,yBAAyBK;IAEhE,OAAO;QACLG,iBAAiBJ,IAAII,eAAe;QACpCC,OAAOL,IAAIK,KAAK;QAChBC,MAAMN,IAAIM,IAAI;QACd,yEAAyE;QACzEC,MAAMP,IAAIO,IAAI,IAAIP,IAAIQ,IAAI;QAC1BC,gBAAgBT,IAAIS,cAAc;QAClCD,MAAMR,IAAIQ,IAAI;QACdE,OAAOV,IAAIU,KAAK,IAAI,EAAE;QACtBC,YAAYX,IAAIW,UAAU;QAC1BC,YAAYZ,IAAIY,UAAU,IAAI,EAAE;IAClC;AACF"}
+{"version":3,"sources":["../src/resolveWorkbenchApp.ts"],"sourcesContent":["// Package-internal shared resolver: turn a CLI config's branded\n// `defineApplication` app into its declared interfaces, or `null` for a plain\n// project — and for a config (a branded `unstable_defineMediaLibrary`), which\n// is not an app. The build and deploy accessors (actions/build, actions/deploy)\n// each build their command-specific view on top of this one brand-check +\n// extraction, so the discrimination lives in exactly one place.\n\nimport {type AppVisibility, type CliConfig} from '@sanity/cli-core'\n\nimport {type WorkbenchConfigValue} from './contract.js'\nimport {type DefineAppInput, isWorkbenchApp} from './defineApp.js'\nimport {formatWorkbenchAppErrors, validateWorkbenchApp} from './validateWorkbenchApp.js'\n\n/**\n * Bundled so adding a declaration family touches this type and the artifact\n * expanders, not every hop of build/dev plumbing in between. `config` is sourced\n * from `resolveWorkbenchConfig` (a config is not an app), not from this resolver.\n * @internal\n */\nexport interface WorkbenchExposes {\n  config?: WorkbenchConfigValue\n  views?: DefineAppInput['views']\n  webWorkers?: DefineAppInput['webWorkers']\n}\n\n/** @public */\nexport interface ResolvedWorkbenchApp {\n  /**\n   * Stable identity, distinct from the `slug` address. Defaults to `slug`, and is\n   * what every identity key (build id, interface ids) is built from.\n   */\n  readonly name: string\n  /** Organization that owns the app — part of its build-id identity. */\n  readonly organizationId: string\n  readonly slug: string\n\n  /** Views the app declares. */\n  readonly views: NonNullable<DefineAppInput['views']>\n\n  /** Background web workers the app declares. */\n  readonly webWorkers: NonNullable<DefineAppInput['webWorkers']>\n\n  /** Resolved app kind — `studio` or one of the SDK app types. */\n  readonly applicationType?: string\n  /** SDK app-view entrypoint, when declared. */\n  readonly entry?: string\n  /** Path to the app's icon SVG, resolved and shipped to Brett on deploy. */\n  readonly icon?: string\n  /** Explicit singleton flag for Sanity-owned apps. */\n  readonly isSingleton?: boolean\n  /** Dashboard visibility declared by the app; `undefined` when unset. */\n  readonly visibility?: AppVisibility\n}\n\n/**\n * Resolve the workbench app for a CLI config, or `null` for a plain project or a\n * config (which is not an app — read it with `resolveWorkbenchConfig`).\n * @public\n */\nexport function resolveWorkbenchApp(\n  cliConfig: CliConfig | null | undefined,\n): ResolvedWorkbenchApp | null {\n  const app = cliConfig?.app\n  // A config carries a distinct brand, so `isWorkbenchApp` is false for it — it\n  // resolves to `null` here, like a plain project.\n  if (!isWorkbenchApp(app)) return null\n\n  const errors = validateWorkbenchApp(app)\n  if (errors.length > 0) throw new Error(formatWorkbenchAppErrors(errors))\n\n  return {\n    applicationType: app.applicationType,\n    entry: app.entry,\n    icon: app.icon,\n    ...(app.isSingleton === undefined ? {} : {isSingleton: app.isSingleton}),\n    // Identity defaults to the address, so existing apps behave identically.\n    name: app.name ?? app.slug,\n    organizationId: app.organizationId,\n    slug: app.slug,\n    views: app.views ?? [],\n    visibility: app.visibility,\n    webWorkers: app.webWorkers ?? [],\n  }\n}\n"],"names":["isWorkbenchApp","formatWorkbenchAppErrors","validateWorkbenchApp","resolveWorkbenchApp","cliConfig","app","errors","length","Error","applicationType","entry","icon","isSingleton","undefined","name","slug","organizationId","views","visibility","webWorkers"],"mappings":"AAAA,gEAAgE;AAChE,8EAA8E;AAC9E,8EAA8E;AAC9E,gFAAgF;AAChF,0EAA0E;AAC1E,gEAAgE;AAKhE,SAA6BA,cAAc,QAAO,iBAAgB;AAClE,SAAQC,wBAAwB,EAAEC,oBAAoB,QAAO,4BAA2B;AA2CxF;;;;CAIC,GACD,OAAO,SAASC,oBACdC,SAAuC;IAEvC,MAAMC,MAAMD,WAAWC;IACvB,8EAA8E;IAC9E,iDAAiD;IACjD,IAAI,CAACL,eAAeK,MAAM,OAAO;IAEjC,MAAMC,SAASJ,qBAAqBG;IACpC,IAAIC,OAAOC,MAAM,GAAG,GAAG,MAAM,IAAIC,MAAMP,yBAAyBK;IAEhE,OAAO;QACLG,iBAAiBJ,IAAII,eAAe;QACpCC,OAAOL,IAAIK,KAAK;QAChBC,MAAMN,IAAIM,IAAI;QACd,GAAIN,IAAIO,WAAW,KAAKC,YAAY,CAAC,IAAI;YAACD,aAAaP,IAAIO,WAAW;QAAA,CAAC;QACvE,yEAAyE;QACzEE,MAAMT,IAAIS,IAAI,IAAIT,IAAIU,IAAI;QAC1BC,gBAAgBX,IAAIW,cAAc;QAClCD,MAAMV,IAAIU,IAAI;QACdE,OAAOZ,IAAIY,KAAK,IAAI,EAAE;QACtBC,YAAYb,IAAIa,UAAU;QAC1BC,YAAYd,IAAIc,UAAU,IAAI,EAAE;IAClC;AACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workbench-cli",
-  "version": "2.2.3",
+  "version": "2.2.4",
   "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",
@@ -57,20 +57,20 @@
     "access": "public"
   },
   "dependencies": {
-    "@module-federation/runtime": "2.8.2",
-    "@module-federation/vite": "1.20.7",
+    "@module-federation/runtime": "2.9.0",
+    "@module-federation/vite": "1.21.0",
     "@sanity/types": "^6.7.0",
-    "@vitejs/plugin-react": "^6.1.0",
+    "@vitejs/plugin-react": "^6.1.1",
     "form-data": "^4.0.5",
     "rxjs": "^7.8.2",
     "tar-fs": "^3.1.2",
-    "vite": "^8.2.1",
+    "vite": "^8.2.2",
     "zod": "^4.4.3",
-    "@sanity/cli-core": "^3.5.0"
+    "@sanity/cli-core": "^3.5.1"
   },
   "devDependencies": {
     "@eslint/compat": "^2.1.0",
-    "@sanity/pkg-utils": "^12.2.0",
+    "@sanity/pkg-utils": "^12.3.4",
     "@swc/cli": "^0.8.1",
     "@swc/core": "^1.15.43",
     "@types/node": "^22.20.0",