@sanity/workbench-cli 1.1.3 → 1.2.0

package/dist/_exports/build.d.ts

@@ -4,13 +4,14 @@ import { z } from "zod/mini";
 
 /**
  * User-facing input for `unstable_defineApp`. Excludes the internal
- * `applicationType` — that field is validated by the schema but is not part of
- * the public surface (Sanity-owned apps set it via `@ts-expect-error`).
+ * `applicationType`, `isSingleton`, and `installationConfig` — validated by the
+ * schema but not part of the public surface (Sanity-owned apps set them via
+ * `@ts-expect-error`).
  * @public
  */
 declare type DefineAppInput = Omit<
   z.output<typeof DefineAppInputSchema>,
-  "applicationType"
+  "applicationType" | "installationConfig" | "isSingleton"
 >;
 
 /**
@@ -23,11 +24,11 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
   {
     applicationType: z.ZodMiniOptional<
       z.ZodMiniEnum<{
+        "media-library": "media-library";
         coreApp: "coreApp";
         studio: "studio";
         canvas: "canvas";
         dashboard: "dashboard";
-        "media-library": "media-library";
       }>
     >;
     entry: z.ZodMiniOptional<z.ZodMiniString<string>>;
@@ -39,6 +40,31 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
       }>
     >;
     icon: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    installationConfig: z.ZodMiniOptional<
+      z.ZodMiniDiscriminatedUnion<
+        [
+          z.ZodMiniObject<
+            {
+              appType: z.ZodMiniLiteral<"media-library">;
+              fields: z.ZodMiniArray<
+                z.ZodMiniObject<
+                  {
+                    public: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+                    title: z.ZodMiniString<string>;
+                    name: z.ZodMiniString<string>;
+                    src: z.ZodMiniString<string>;
+                  },
+                  z.core.$strip
+                >
+              >;
+            },
+            z.core.$strip
+          >,
+        ],
+        "appType"
+      >
+    >;
+    isSingleton: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
     name: z.ZodMiniString<string>;
     organizationId: z.ZodMiniString<string>;
     priority: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
@@ -81,8 +107,21 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
   z.core.$strip
 >;
 
+/**
+ * The branded result of `unstable_defineApp`. Carries the same fields as the
+ * input plus the internal brand — users only ever see `DefineAppInput`.
+ * @public
+ */
+declare interface DefineAppResult extends DefineAppInput {
+  readonly [WORKBENCH_APP]: true;
+}
+
 /** @public */
 declare interface ResolvedWorkbenchApp {
+  /** A Sanity-owned singleton (e.g. the Media Library) — deploys its config, not an application. */
+  readonly isSingleton: boolean;
+  /** The app's unique `name` from `unstable_defineApp`. */
+  readonly name: string;
   /** Background worker services the app declares. */
   readonly services: NonNullable<DefineAppInput["services"]>;
   /** Dock panel views the app declares. */
@@ -91,6 +130,8 @@ declare interface ResolvedWorkbenchApp {
   readonly applicationType?: string;
   /** SDK app-view entrypoint, when declared. */
   readonly entry?: string;
+  /** Deploys on its own path, separate from the interfaces. */
+  readonly installationConfig?: WorkbenchApp["installationConfig"];
 }
 
 /**
@@ -101,6 +142,34 @@ export declare function resolveWorkbenchApp(
   cliConfig: CliConfig | null | undefined,
 ): ResolvedWorkbenchApp | null;
 
+/**
+ * Nominal brand the CLI discriminates on to enable the workbench build/deploy
+ * codepath. Registered via `Symbol.for` so the marker survives module-realm
+ * boundaries — `@sanity/cli-core` re-derives the same global symbol with
+ * `Symbol.for` rather than importing it, so it stays internal to this module.
+ */
+declare const WORKBENCH_APP: unique symbol;
+
+/**
+ * A branded app as the CLI reads it — the full schema shape, including the
+ * internal fields `DefineAppInput` omits. Schema-derived so the narrowing
+ * can't drift from what the schema validates.
+ * @public
+ */
+declare type WorkbenchApp = DefineAppResult &
+  z.output<typeof DefineAppInputSchema>;
+
+/**
+ * Bundled so adding a declaration family touches this type and the artifact
+ * expanders, not every hop of build/dev plumbing in between.
+ * @internal
+ */
+export declare interface WorkbenchExposes {
+  installationConfig?: WorkbenchApp["installationConfig"];
+  services?: DefineAppInput["services"];
+  views?: DefineAppInput["views"];
+}
+
 declare interface WorkbenchViteOptions {
   /** Project root — read for the federation remote name, and the plugin workDir. */
   cwd: string;
@@ -113,12 +182,11 @@ declare interface WorkbenchViteOptions {
     relativeConfigLocation: string | null;
     relativeEntry: string | null;
   };
+  /** The app's bus identity, stamped into its modules for `@sanity/runtime`. */
+  appId?: string;
+  exposes?: WorkbenchExposes;
   /** App (vs studio) build — selects the discriminated federation option shape. */
   isApp?: boolean;
-  /** Declared background services. */
-  services?: DefineAppInput["services"];
-  /** Declared dock views. */
-  views?: DefineAppInput["views"];
 }
 
 /** Build the Vite plugins for a workbench app's module-federation remote. */

package/dist/_exports/build.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/_exports/build.ts"],"sourcesContent":["// Node-only build entry: the module-federation Vite plugins that\n// `@sanity/cli-build`'s `getViteConfig` swaps in for a workbench app, plus the\n// resolver the build reads declared views/services from. The build needs no\n// deploy-time guards, so it takes the bare `resolveWorkbenchApp` — the guarded\n// view (`getWorkbench`) is the deploy entry's export.\n\nexport {workbenchVitePlugins} from '../actions/build/vite/workbench-vite-plugins.js'\nexport {resolveWorkbenchApp} from '../resolveWorkbenchApp.js'\n"],"names":["workbenchVitePlugins","resolveWorkbenchApp"],"mappings":"AAAA,iEAAiE;AACjE,+EAA+E;AAC/E,4EAA4E;AAC5E,+EAA+E;AAC/E,sDAAsD;AAEtD,SAAQA,oBAAoB,QAAO,kDAAiD;AACpF,SAAQC,mBAAmB,QAAO,4BAA2B"}
+{"version":3,"sources":["../../src/_exports/build.ts"],"sourcesContent":["// Node-only build entry: the module-federation Vite plugins that\n// `@sanity/cli-build`'s `getViteConfig` swaps in for a workbench app, plus the\n// resolver the build reads declared views/services from. The build needs no\n// deploy-time guards, so it takes the bare `resolveWorkbenchApp` — the guarded\n// view (`getWorkbench`) is the deploy entry's export.\n\nexport {workbenchVitePlugins} from '../actions/build/vite/workbench-vite-plugins.js'\nexport {resolveWorkbenchApp, type WorkbenchExposes} from '../resolveWorkbenchApp.js'\n"],"names":["workbenchVitePlugins","resolveWorkbenchApp"],"mappings":"AAAA,iEAAiE;AACjE,+EAA+E;AAC/E,4EAA4E;AAC5E,+EAA+E;AAC/E,sDAAsD;AAEtD,SAAQA,oBAAoB,QAAO,kDAAiD;AACpF,SAAQC,mBAAmB,QAA8B,4BAA2B"}

package/dist/_exports/deploy.d.ts

@@ -1,15 +1,25 @@
 import { CliConfig } from "@sanity/cli-core";
+import { Output } from "@sanity/cli-core";
 import { z } from "zod/mini";
 
+/**
+ * Throws unless `sourceDir` is a directory holding a federation build.
+ * Workbench builds emit a module-federation remote instead of a static SPA,
+ * so the usual `index.html` contract doesn't apply — `mf-manifest.json` is the
+ * marker that `sanity build` produced a federation build.
+ */
+export declare function checkBuiltOutput(sourceDir: string): Promise<void>;
+
 /**
  * User-facing input for `unstable_defineApp`. Excludes the internal
- * `applicationType` — that field is validated by the schema but is not part of
- * the public surface (Sanity-owned apps set it via `@ts-expect-error`).
+ * `applicationType`, `isSingleton`, and `installationConfig` — validated by the
+ * schema but not part of the public surface (Sanity-owned apps set them via
+ * `@ts-expect-error`).
  * @public
  */
 declare type DefineAppInput = Omit<
   z.output<typeof DefineAppInputSchema>,
-  "applicationType"
+  "applicationType" | "installationConfig" | "isSingleton"
 >;
 
 /**
@@ -22,11 +32,11 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
   {
     applicationType: z.ZodMiniOptional<
       z.ZodMiniEnum<{
+        "media-library": "media-library";
         coreApp: "coreApp";
         studio: "studio";
         canvas: "canvas";
         dashboard: "dashboard";
-        "media-library": "media-library";
       }>
     >;
     entry: z.ZodMiniOptional<z.ZodMiniString<string>>;
@@ -38,6 +48,31 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
       }>
     >;
     icon: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    installationConfig: z.ZodMiniOptional<
+      z.ZodMiniDiscriminatedUnion<
+        [
+          z.ZodMiniObject<
+            {
+              appType: z.ZodMiniLiteral<"media-library">;
+              fields: z.ZodMiniArray<
+                z.ZodMiniObject<
+                  {
+                    public: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+                    title: z.ZodMiniString<string>;
+                    name: z.ZodMiniString<string>;
+                    src: z.ZodMiniString<string>;
+                  },
+                  z.core.$strip
+                >
+              >;
+            },
+            z.core.$strip
+          >,
+        ],
+        "appType"
+      >
+    >;
+    isSingleton: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
     name: z.ZodMiniString<string>;
     organizationId: z.ZodMiniString<string>;
     priority: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
@@ -80,28 +115,60 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
   z.core.$strip
 >;
 
+/**
+ * The branded result of `unstable_defineApp`. Carries the same fields as the
+ * input plus the internal brand — users only ever see `DefineAppInput`.
+ * @public
+ */
+declare interface DefineAppResult extends DefineAppInput {
+  readonly [WORKBENCH_APP]: true;
+}
+
 declare interface DeployableWorkbenchApp extends ResolvedWorkbenchApp {
   /**
-   * Throws when the app declares nothing the build can expose — no entry, view
-   * or service. A federated app with none would ship a remote with nothing to
-   * load, so deploy gates on this before any prompts or API calls.
+   * Throws when the app exposes nothing (no entry, view, service, or config) —
+   * the remote would have nothing to load. Gated before any prompt or API call.
    */
   assertDeployable(): void;
   /**
-   * Throws unless `sourceDir` is a directory holding a federation build.
-   * Workbench builds emit a module-federation remote instead of a static SPA,
-   * so the usual `index.html` contract doesn't apply — `mf-manifest.json` is the
-   * marker that `sanity build` produced a federation build.
+   * Validates the app's declared views into the application-service payload.
+   * Throws when a view declaration is malformed.
+   */
+  buildViewDeploymentPayload(applicationId: string): ViewDeploymentPayload;
+  /**
+   * A singleton (the Media Library) that carries an installation config — deploy
+   * persists the config to the org's installation. Independent of the interfaces,
+   * which register regardless; non-singletons never carry a config.
    */
-  checkBuiltOutput(sourceDir: string): Promise<void>;
+  deploySingletonInstallationConfig: boolean;
+  /** Declares something to host as an application — an entry, view, or service. */
+  hasInterfaces: boolean;
 }
 
+/**
+ * Upload the built module-federation remote to the installation as its config
+ * snapshot. `installationId` is resolved by the caller so `--dry-run` never
+ * reaches this mutating step.
+ * @internal
+ */
+export declare function deployInstallationConfig(options: {
+  appType: string;
+  installationId: string;
+  output: Output;
+  sourceDir: string;
+  version: string;
+}): Promise<void>;
+
 export declare function getWorkbench(
   cliConfig: CliConfig | null | undefined,
 ): DeployableWorkbenchApp | null;
 
 /** @public */
 declare interface ResolvedWorkbenchApp {
+  /** A Sanity-owned singleton (e.g. the Media Library) — deploys its config, not an application. */
+  readonly isSingleton: boolean;
+  /** The app's unique `name` from `unstable_defineApp`. */
+  readonly name: string;
   /** Background worker services the app declares. */
   readonly services: NonNullable<DefineAppInput["services"]>;
   /** Dock panel views the app declares. */
@@ -110,6 +177,78 @@ declare interface ResolvedWorkbenchApp {
   readonly applicationType?: string;
   /** SDK app-view entrypoint, when declared. */
   readonly entry?: string;
+  /** Deploys on its own path, separate from the interfaces. */
+  readonly installationConfig?: WorkbenchApp["installationConfig"];
 }
 
+/**
+ * The org's active installation for an app type, or `undefined` when none is
+ * installed. Read-only, so `--dry-run` can report deployability.
+ * @internal
+ */
+export declare function resolveInstallationId(options: {
+  appType: string;
+  organizationId: string;
+}): Promise<string | undefined>;
+
+/**
+ * A report heading and item list for a config; a media library's `fields` are
+ * one of potentially many shapes.
+ * @internal
+ */
+export declare function summarizeInstallationConfig(config: {
+  appType: string;
+  fields: {
+    name: string;
+    title: string;
+  }[];
+}): string;
+
+declare type ViewDeploymentPayload = z.infer<
+  typeof viewDeploymentPayloadSchema
+>;
+
+/**
+ * Payload registering an app's views with the application service on deploy.
+ *
+ * Phase 1 stub: the service that stores views does not exist yet, so the
+ * payload is validated and logged only — never sent. Builds the contract the
+ * application-service endpoint will accept.
+ */
+declare const viewDeploymentPayloadSchema: z.ZodMiniObject<
+  {
+    applicationId: z.ZodMiniString<string>;
+    views: z.ZodMiniArray<
+      z.ZodMiniObject<
+        {
+          name: z.ZodMiniString<string>;
+          src: z.ZodMiniString<string>;
+          type: z.ZodMiniEnum<{
+            panel: "panel";
+          }>;
+        },
+        z.core.$loose
+      >
+    >;
+  },
+  z.core.$strip
+>;
+
+/**
+ * Nominal brand the CLI discriminates on to enable the workbench build/deploy
+ * codepath. Registered via `Symbol.for` so the marker survives module-realm
+ * boundaries — `@sanity/cli-core` re-derives the same global symbol with
+ * `Symbol.for` rather than importing it, so it stays internal to this module.
+ */
+declare const WORKBENCH_APP: unique symbol;
+
+/**
+ * A branded app as the CLI reads it — the full schema shape, including the
+ * internal fields `DefineAppInput` omits. Schema-derived so the narrowing
+ * can't drift from what the schema validates.
+ * @public
+ */
+declare type WorkbenchApp = DefineAppResult &
+  z.output<typeof DefineAppInputSchema>;
+
 export {};

package/dist/_exports/deploy.js

@@ -1,6 +1,5 @@
-// Node-only deploy entry: the workbench-app accessor with the deploy-time guards
-// (`assertDeployable`, `checkBuiltOutput`) the deploy command runs before
-// shipping. Built on the same shared resolver as the build accessor.
+export { checkBuiltOutput } from '../actions/deploy/checkBuiltOutput.js';
+export { deployInstallationConfig, resolveInstallationId, summarizeInstallationConfig } from '../actions/deploy/deployInstallationConfig.js';
 export { getWorkbench } from '../actions/deploy/getWorkbench.js';
 
 //# sourceMappingURL=deploy.js.map

package/dist/_exports/deploy.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/_exports/deploy.ts"],"sourcesContent":["// Node-only deploy entry: the workbench-app accessor with the deploy-time guards\n// (`assertDeployable`, `checkBuiltOutput`) the deploy command runs before\n// shipping. Built on the same shared resolver as the build accessor.\nexport {getWorkbench} from '../actions/deploy/getWorkbench.js'\n"],"names":["getWorkbench"],"mappings":"AAAA,iFAAiF;AACjF,0EAA0E;AAC1E,qEAAqE;AACrE,SAAQA,YAAY,QAAO,oCAAmC"}
+{"version":3,"sources":["../../src/_exports/deploy.ts"],"sourcesContent":["export {checkBuiltOutput} from '../actions/deploy/checkBuiltOutput.js'\nexport {\n  deployInstallationConfig,\n  resolveInstallationId,\n  summarizeInstallationConfig,\n} from '../actions/deploy/deployInstallationConfig.js'\nexport {getWorkbench} from '../actions/deploy/getWorkbench.js'\n"],"names":["checkBuiltOutput","deployInstallationConfig","resolveInstallationId","summarizeInstallationConfig","getWorkbench"],"mappings":"AAAA,SAAQA,gBAAgB,QAAO,wCAAuC;AACtE,SACEC,wBAAwB,EACxBC,qBAAqB,EACrBC,2BAA2B,QACtB,gDAA+C;AACtD,SAAQC,YAAY,QAAO,oCAAmC"}

package/dist/_exports/dev.d.ts

@@ -32,6 +32,28 @@ declare const devServerManifestSchema: z.ZodMiniObject<
   {
     host: z.ZodMiniString<string>;
     id: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    installationConfigs: z.ZodMiniOptional<
+      z.ZodMiniArray<
+        z.ZodMiniObject<
+          {
+            appType: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            fields: z.ZodMiniArray<
+              z.ZodMiniObject<
+                {
+                  name: z.ZodMiniString<string>;
+                  public: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+                  src: z.ZodMiniString<string>;
+                  title: z.ZodMiniString<string>;
+                },
+                z.core.$strip
+              >
+            >;
+            moduleName: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          },
+          z.core.$strip
+        >
+      >
+    >;
     interfaces: z.ZodMiniOptional<
       z.ZodMiniArray<
         z.ZodMiniObject<

package/dist/_exports/index.d.ts

@@ -2,13 +2,14 @@ import { z } from "zod/mini";
 
 /**
  * User-facing input for `unstable_defineApp`. Excludes the internal
- * `applicationType` — that field is validated by the schema but is not part of
- * the public surface (Sanity-owned apps set it via `@ts-expect-error`).
+ * `applicationType`, `isSingleton`, and `installationConfig` — validated by the
+ * schema but not part of the public surface (Sanity-owned apps set them via
+ * `@ts-expect-error`).
  * @public
  */
 export declare type DefineAppInput = Omit<
   z.output<typeof DefineAppInputSchema>,
-  "applicationType"
+  "applicationType" | "installationConfig" | "isSingleton"
 >;
 
 /**
@@ -21,11 +22,11 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
   {
     applicationType: z.ZodMiniOptional<
       z.ZodMiniEnum<{
+        "media-library": "media-library";
         coreApp: "coreApp";
         studio: "studio";
         canvas: "canvas";
         dashboard: "dashboard";
-        "media-library": "media-library";
       }>
     >;
     entry: z.ZodMiniOptional<z.ZodMiniString<string>>;
@@ -37,6 +38,31 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
       }>
     >;
     icon: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    installationConfig: z.ZodMiniOptional<
+      z.ZodMiniDiscriminatedUnion<
+        [
+          z.ZodMiniObject<
+            {
+              appType: z.ZodMiniLiteral<"media-library">;
+              fields: z.ZodMiniArray<
+                z.ZodMiniObject<
+                  {
+                    public: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+                    title: z.ZodMiniString<string>;
+                    name: z.ZodMiniString<string>;
+                    src: z.ZodMiniString<string>;
+                  },
+                  z.core.$strip
+                >
+              >;
+            },
+            z.core.$strip
+          >,
+        ],
+        "appType"
+      >
+    >;
+    isSingleton: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
     name: z.ZodMiniString<string>;
     organizationId: z.ZodMiniString<string>;
     priority: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
@@ -116,6 +142,16 @@ export declare interface DefinedView<
   readonly version: typeof VIEW_CONTRACT_VERSION;
 }
 
+/**
+ * Sanity-owned singleton, so authors don't name or title the app — only `organizationId` is required.
+ * @public
+ */
+export declare interface DefineMediaLibraryInput {
+  /** Organization that owns the media library — the CLI runs and deploys against it. */
+  organizationId: string;
+  fields?: MediaLibraryField[];
+}
+
 /**
  * Dock group identifier. The API does not block a user app from declaring a
  * reserved group (e.g. `dock.system`); priority conventions keep Sanity-owned
@@ -131,11 +167,28 @@ declare const DockGroupSchema: z.ZodMiniEnum<{
   "dock.user": "dock.user";
 }>;
 
+/** @public */
+export declare type InterfaceType = keyof typeof VIEW_COMPONENTS;
+
 /**
- * Every supported interface type — the first argument to `unstable_defineView`.
+ * Whether `app` is a branded `unstable_defineApp(...)` result — the sole
+ * workbench opt-in.
  * @public
  */
-export declare type InterfaceType = keyof typeof VIEW_COMPONENTS;
+export declare function isWorkbenchApp(app: unknown): app is WorkbenchApp;
+
+/**
+ * One custom field a media library exposes. `src` default-exports a `defineField(...)` schema type.
+ * @public
+ */
+export declare interface MediaLibraryField {
+  /** Unique within the media library. */
+  name: string;
+  src: string;
+  title: string;
+  /** Readable outside the owning organization. */
+  public?: boolean;
+}
 
 /**
  * A panel's view-component slot — the module-federation expose for one island.
@@ -166,12 +219,7 @@ export declare type PanelViewProps = ViewComponentBaseProps<{
   name: string;
 }>;
 
-/**
- * Contract version stamped on every defined service. Lets the workbench host
- * and the generated worker artifact evolve the service contract without
- * breaking already-deployed services; bumped only on a breaking change.
- * @internal
- */
+/** @internal */
 declare const SERVICE_CONTRACT_VERSION = 1;
 
 /**
@@ -206,12 +254,7 @@ export declare interface ServiceInfo {
   readonly type: string;
 }
 
-/**
- * Every supported service type — the first argument to `unstable_defineService`.
- * Add a service type by adding its declaration schema below and registering it
- * here.
- * @public
- */
+/** @public */
 export declare type ServiceType = "worker";
 
 /**
@@ -225,6 +268,14 @@ export declare function unstable_defineApp(
   input: DefineAppInput,
 ): DefineAppResult;
 
+/**
+ * Declare the Sanity Media Library as a workbench app — a singleton whose `fields` become its installation config.
+ * @public
+ */
+export declare function unstable_defineMediaLibrary(
+  input: DefineMediaLibraryInput,
+): DefineAppResult;
+
 /**
  * Define a Sanity Workbench background service. The first argument narrows the
  * callback shape — `"worker"` runs the callback inside a Web Worker, where it
@@ -256,20 +307,15 @@ export declare function unstable_defineView<TType extends InterfaceType>(
 ): DefinedView<TType>;
 
 /**
- * Component slots each interface type exposes, in render order — the source of
- * truth for {@link InterfaceType} and for the build (the vite plugin expands a
- * view into one render artifact per component). Add a type by registering it here.
+ * Component slots each interface type exposes, in render order. Source of truth
+ * for {@link InterfaceType} and the build; add a type by registering it here.
  * @internal
  */
 declare const VIEW_COMPONENTS: {
   readonly panel: readonly ["title", "panel"];
 };
 
-/**
- * Contract version stamped on every defined view — lets the host and the
- * generated artifact evolve the contract without breaking deployed views.
- * @internal
- */
+/** @internal */
 declare const VIEW_CONTRACT_VERSION = 1;
 
 /**
@@ -279,11 +325,7 @@ declare const VIEW_CONTRACT_VERSION = 1;
  */
 declare type ViewComponent<TProps> = (props: TProps) => unknown;
 
-/**
- * Props every view component receives, whatever its type. Per-type props
- * compose from this, so a prop added here reaches every view.
- * @public
- */
+/** @public */
 declare interface ViewComponentBaseProps<TView> {
   view: TView;
 }
@@ -304,4 +346,13 @@ export declare interface ViewComponentsByType {
  */
 declare const WORKBENCH_APP: unique symbol;
 
+/**
+ * A branded app as the CLI reads it — the full schema shape, including the
+ * internal fields `DefineAppInput` omits. Schema-derived so the narrowing
+ * can't drift from what the schema validates.
+ * @public
+ */
+export declare type WorkbenchApp = DefineAppResult &
+  z.output<typeof DefineAppInputSchema>;
+
 export {};

package/dist/_exports/index.js

@@ -1,14 +1,4 @@
-// Public, browser-safe entry for `@sanity/workbench-cli` — the authoring API app
-// authors call from `sanity.cli.ts` (re-exported by `sanity/cli` and the
-// `sanity` runtime entry). Calling `unstable_defineApp` is the *sole* workbench
-// opt-in: it stamps the global brand `Symbol.for('sanity.workbench.defineApp')`,
-// which the CLI discriminates on (see `isWorkbenchApp` in `@sanity/cli-core`).
-//
-// This module graph must stay browser-safe: zod-only, no `node:*`, no vite, no
-// `@sanity/cli-core`. View/service `src` files bundle to the browser, so anything
-// reachable from here ships in the frontend bundle. The Node-only build glue
-// lives behind the separate `./vite` entry and never leaks in.
-export { unstable_defineApp } from '../defineApp.js';
+export { isWorkbenchApp, unstable_defineApp, unstable_defineMediaLibrary } from '../defineApp.js';
 export { unstable_defineService } from '../defineService.js';
 export { unstable_defineView } from '../defineView.js';
 

package/dist/_exports/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/_exports/index.ts"],"sourcesContent":["// Public, browser-safe entry for `@sanity/workbench-cli` — the authoring API app\n// authors call from `sanity.cli.ts` (re-exported by `sanity/cli` and the\n// `sanity` runtime entry). Calling `unstable_defineApp` is the *sole* workbench\n// opt-in: it stamps the global brand `Symbol.for('sanity.workbench.defineApp')`,\n// which the CLI discriminates on (see `isWorkbenchApp` in `@sanity/cli-core`).\n//\n// This module graph must stay browser-safe: zod-only, no `node:*`, no vite, no\n// `@sanity/cli-core`. View/service `src` files bundle to the browser, so anything\n// reachable from here ships in the frontend bundle. The Node-only build glue\n// lives behind the separate `./vite` entry and never leaks in.\nexport type {InterfaceType, ServiceType} from '../contract.js'\nexport {unstable_defineApp} from '../defineApp.js'\nexport type {DefineAppInput, DefineAppResult, DockGroup} from '../defineApp.js'\nexport {unstable_defineService} from '../defineService.js'\nexport type {\n  DefinedService,\n  ServiceCallback,\n  ServiceContext,\n  ServiceInfo,\n} from '../defineService.js'\nexport {unstable_defineView} from '../defineView.js'\nexport type {\n  DefinedView,\n  PanelComponent,\n  PanelViewComponents,\n  PanelViewProps,\n  ViewComponentsByType,\n} from '../defineView.js'\n"],"names":["unstable_defineApp","unstable_defineService","unstable_defineView"],"mappings":"AAAA,iFAAiF;AACjF,yEAAyE;AACzE,gFAAgF;AAChF,iFAAiF;AACjF,+EAA+E;AAC/E,EAAE;AACF,+EAA+E;AAC/E,kFAAkF;AAClF,6EAA6E;AAC7E,+DAA+D;AAE/D,SAAQA,kBAAkB,QAAO,kBAAiB;AAElD,SAAQC,sBAAsB,QAAO,sBAAqB;AAO1D,SAAQC,mBAAmB,QAAO,mBAAkB"}
+{"version":3,"sources":["../../src/_exports/index.ts"],"sourcesContent":["export type {InterfaceType, ServiceType} from '../contract.js'\nexport {isWorkbenchApp, unstable_defineApp, unstable_defineMediaLibrary} from '../defineApp.js'\nexport type {\n  DefineAppInput,\n  DefineAppResult,\n  DefineMediaLibraryInput,\n  DockGroup,\n  MediaLibraryField,\n  WorkbenchApp,\n} from '../defineApp.js'\nexport {unstable_defineService} from '../defineService.js'\nexport type {\n  DefinedService,\n  ServiceCallback,\n  ServiceContext,\n  ServiceInfo,\n} from '../defineService.js'\nexport {unstable_defineView} from '../defineView.js'\nexport type {\n  DefinedView,\n  PanelComponent,\n  PanelViewComponents,\n  PanelViewProps,\n  ViewComponentsByType,\n} from '../defineView.js'\n"],"names":["isWorkbenchApp","unstable_defineApp","unstable_defineMediaLibrary","unstable_defineService","unstable_defineView"],"mappings":"AACA,SAAQA,cAAc,EAAEC,kBAAkB,EAAEC,2BAA2B,QAAO,kBAAiB;AAS/F,SAAQC,sBAAsB,QAAO,sBAAqB;AAO1D,SAAQC,mBAAmB,QAAO,mBAAkB"}

package/dist/actions/build/artifact.js

@@ -1,3 +1,4 @@
+import { installationConfigArtifacts } from './configs/artifact.js';
 import { serviceArtifacts } from './services/artifact.js';
 import { viewArtifacts } from './views/artifact.js';
 /**
@@ -15,14 +16,14 @@ import { viewArtifacts } from './views/artifact.js';
     return exposes;
 }
 /**
- * Expand a workbench app's declared views and services into the flat artifact
- * set the federation build writes and exposes — the single place that composes
- * the per-type expanders, so the expose mapping and the file writing read from
- * one expansion rather than re-deriving it.
- */ export function workbenchArtifacts(options) {
+ * Expand what the app exposes into the flat artifact set the federation build
+ * writes — the single place that composes the per-type expanders, so the expose
+ * mapping and the file writing read from one expansion.
+ */ export function workbenchArtifacts(exposes) {
     return [
-        ...viewArtifacts(options.views),
-        ...serviceArtifacts(options.services ?? [])
+        ...viewArtifacts(exposes.views ?? []),
+        ...serviceArtifacts(exposes.services ?? []),
+        ...installationConfigArtifacts(exposes.installationConfig)
     ];
 }