@sanity/workbench-cli 1.2.0 → 1.4.0

package/dist/_exports/build.d.ts

@@ -4,14 +4,14 @@ import { z } from "zod/mini";
 
 /**
  * User-facing input for `unstable_defineApp`. Excludes the internal
- * `applicationType`, `isSingleton`, and `installationConfig` — validated by the
+ * `applicationType`, `isSingleton`, and `config` — 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" | "installationConfig" | "isSingleton"
+  "applicationType" | "config" | "isSingleton"
 >;
 
 /**
@@ -31,16 +31,7 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
         dashboard: "dashboard";
       }>
     >;
-    entry: z.ZodMiniOptional<z.ZodMiniString<string>>;
-    group: z.ZodMiniOptional<
-      z.ZodMiniEnum<{
-        "dock.system": "dock.system";
-        "dock.applications": "dock.applications";
-        "dock.user": "dock.user";
-      }>
-    >;
-    icon: z.ZodMiniOptional<z.ZodMiniString<string>>;
-    installationConfig: z.ZodMiniOptional<
+    config: z.ZodMiniOptional<
       z.ZodMiniDiscriminatedUnion<
         [
           z.ZodMiniObject<
@@ -64,6 +55,15 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
         "appType"
       >
     >;
+    entry: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    group: z.ZodMiniOptional<
+      z.ZodMiniEnum<{
+        "dock.system": "dock.system";
+        "dock.applications": "dock.applications";
+        "dock.user": "dock.user";
+      }>
+    >;
+    icon: z.ZodMiniOptional<z.ZodMiniString<string>>;
     isSingleton: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
     name: z.ZodMiniString<string>;
     organizationId: z.ZodMiniString<string>;
@@ -74,6 +74,7 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
           [
             z.ZodMiniObject<
               {
+                title: z.ZodMiniOptional<z.ZodMiniString<string>>;
                 name: z.ZodMiniString<string>;
                 src: z.ZodMiniString<string>;
                 type: z.ZodMiniLiteral<"worker">;
@@ -85,6 +86,7 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
         >
       >
     >;
+    slug: z.ZodMiniOptional<z.ZodMiniString<string>>;
     title: z.ZodMiniString<string>;
     views: z.ZodMiniOptional<
       z.ZodMiniArray<
@@ -92,6 +94,7 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
           [
             z.ZodMiniObject<
               {
+                title: z.ZodMiniOptional<z.ZodMiniString<string>>;
                 name: z.ZodMiniString<string>;
                 src: z.ZodMiniString<string>;
                 type: z.ZodMiniLiteral<"panel">;
@@ -118,8 +121,6 @@ declare interface DefineAppResult extends DefineAppInput {
 
 /** @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. */
@@ -128,10 +129,14 @@ declare interface ResolvedWorkbenchApp {
   readonly views: NonNullable<DefineAppInput["views"]>;
   /** Resolved app kind — `studio` or one of the SDK app types. */
   readonly applicationType?: string;
+  /** Deploys on its own path, separate from the interfaces. */
+  readonly config?: WorkbenchApp["config"];
   /** SDK app-view entrypoint, when declared. */
   readonly entry?: string;
-  /** Deploys on its own path, separate from the interfaces. */
-  readonly installationConfig?: WorkbenchApp["installationConfig"];
+  /** Explicit singleton flag (a Sanity-owned app); `undefined` when the app doesn't set it. */
+  readonly isSingleton?: boolean;
+  /** Hostname the application is created at on first deploy. */
+  readonly slug?: string;
 }
 
 /**
@@ -165,7 +170,7 @@ declare type WorkbenchApp = DefineAppResult &
  * @internal
  */
 export declare interface WorkbenchExposes {
-  installationConfig?: WorkbenchApp["installationConfig"];
+  config?: WorkbenchApp["config"];
   services?: DefineAppInput["services"];
   views?: DefineAppInput["views"];
 }

package/dist/_exports/deploy.d.ts

@@ -2,24 +2,78 @@ import { CliConfig } from "@sanity/cli-core";
 import { Output } from "@sanity/cli-core";
 import { z } from "zod/mini";
 
+export declare interface Application {
+  id: string;
+  organizationId: string;
+  slug: string | null;
+  title: string;
+  type: ApplicationType;
+}
+
+declare type ApplicationType = "coreApp" | "studio";
+
+/**
+ * An interface as Brett stores it: the declared `type` (validated server-side,
+ * not here) and the remote-relative `moduleId` the workbench loads it by — the
+ * host prepends the app's own id.
+ * @internal
+ */
+export declare interface BrettInterface {
+  moduleId: string;
+  name: string;
+  title: string;
+  type: string;
+  version: string;
+}
+
+/** A studio workspace as Brett stores it. */
+export declare interface BrettWorkspace {
+  dataset: string;
+  projectId: string;
+  basePath?: string;
+  icon?: string;
+  name?: string;
+  subtitle?: string;
+  title?: string;
+}
+
+/**
+ * The interface records deploy sends: the app view (only when `exposesAppView`),
+ * every view, and every service.
+ * @internal
+ */
+export declare function buildExposes(
+  exposes: WorkbenchExposes,
+  { appName, appTitle, exposesAppView, version }: BuildExposesContext,
+): BrettInterface[];
+
+declare interface BuildExposesContext {
+  appName: string;
+  appTitle: string;
+  /** Whether the build exposes the app view (`./App`) — apps with an `entry`, and every studio. */
+  exposesAppView: boolean;
+  version: string;
+}
+
 /**
  * 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.
+ * A workbench build always emits a module-federation remote, and may
+ * additionally emit a standalone `index.html` SPA (workbench remotes). Either
+ * way `mf-manifest.json` is the reliable marker that `sanity build` produced a
+ * federation build, so that — not `index.html` — is what we check for.
  */
 export declare function checkBuiltOutput(sourceDir: string): Promise<void>;
 
 /**
  * User-facing input for `unstable_defineApp`. Excludes the internal
- * `applicationType`, `isSingleton`, and `installationConfig` — validated by the
+ * `applicationType`, `isSingleton`, and `config` — 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" | "installationConfig" | "isSingleton"
+  "applicationType" | "config" | "isSingleton"
 >;
 
 /**
@@ -39,16 +93,7 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
         dashboard: "dashboard";
       }>
     >;
-    entry: z.ZodMiniOptional<z.ZodMiniString<string>>;
-    group: z.ZodMiniOptional<
-      z.ZodMiniEnum<{
-        "dock.system": "dock.system";
-        "dock.applications": "dock.applications";
-        "dock.user": "dock.user";
-      }>
-    >;
-    icon: z.ZodMiniOptional<z.ZodMiniString<string>>;
-    installationConfig: z.ZodMiniOptional<
+    config: z.ZodMiniOptional<
       z.ZodMiniDiscriminatedUnion<
         [
           z.ZodMiniObject<
@@ -72,6 +117,15 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
         "appType"
       >
     >;
+    entry: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    group: z.ZodMiniOptional<
+      z.ZodMiniEnum<{
+        "dock.system": "dock.system";
+        "dock.applications": "dock.applications";
+        "dock.user": "dock.user";
+      }>
+    >;
+    icon: z.ZodMiniOptional<z.ZodMiniString<string>>;
     isSingleton: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
     name: z.ZodMiniString<string>;
     organizationId: z.ZodMiniString<string>;
@@ -82,6 +136,7 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
           [
             z.ZodMiniObject<
               {
+                title: z.ZodMiniOptional<z.ZodMiniString<string>>;
                 name: z.ZodMiniString<string>;
                 src: z.ZodMiniString<string>;
                 type: z.ZodMiniLiteral<"worker">;
@@ -93,6 +148,7 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
         >
       >
     >;
+    slug: z.ZodMiniOptional<z.ZodMiniString<string>>;
     title: z.ZodMiniString<string>;
     views: z.ZodMiniOptional<
       z.ZodMiniArray<
@@ -100,6 +156,7 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
           [
             z.ZodMiniObject<
               {
+                title: z.ZodMiniOptional<z.ZodMiniString<string>>;
                 name: z.ZodMiniString<string>;
                 src: z.ZodMiniString<string>;
                 type: z.ZodMiniLiteral<"panel">;
@@ -136,11 +193,11 @@ declare interface DeployableWorkbenchApp extends ResolvedWorkbenchApp {
    */
   buildViewDeploymentPayload(applicationId: string): ViewDeploymentPayload;
   /**
-   * A singleton (the Media Library) that carries an installation config — deploy
+   * A singleton (the Media Library) that carries an config — deploy
    * persists the config to the org's installation. Independent of the interfaces,
    * which register regardless; non-singletons never carry a config.
    */
-  deploySingletonInstallationConfig: boolean;
+  deploySingletonConfig: boolean;
   /** Declares something to host as an application — an entry, view, or service. */
   hasInterfaces: boolean;
 }
@@ -151,22 +208,82 @@ declare interface DeployableWorkbenchApp extends ResolvedWorkbenchApp {
  * reaches this mutating step.
  * @internal
  */
-export declare function deployInstallationConfig(options: {
+export declare function deployConfig(options: {
   appType: string;
   installationId: string;
+  organizationId: string;
   output: Output;
   sourceDir: string;
   version: string;
 }): Promise<void>;
 
+/**
+ * Deploy a workbench coreApp through Brett: redeploy when `appId` is set,
+ * otherwise create the application at `slug`. Returns the application id for the
+ * shell to report.
+ * @internal
+ */
+export declare function deployCoreApp(options: {
+  appId: string | undefined;
+  interfaces: readonly BrettInterface[];
+  isAutoUpdating: boolean;
+  isSingleton?: boolean;
+  organizationId: string;
+  slug: string;
+  sourceDir: string;
+  title: string;
+  version: string;
+}): Promise<{
+  applicationId: string;
+}>;
+
+/** A view or service as the deploy report and `--json` output surface it. */
+export declare interface DeployedExpose {
+  name: string;
+  src: string;
+  title: string;
+  type: string;
+}
+
+/**
+ * Deploy a workbench studio through Brett: redeploy when `appId` is set,
+ * otherwise create the studio at `studioHost`. Returns the application id for
+ * the shell to report; a missing `studioHost` on create is a usage error.
+ * @internal
+ */
+export declare function deployStudio(options: {
+  appId: string | undefined;
+  interfaces: readonly BrettInterface[];
+  isAutoUpdating: boolean;
+  organizationId: string;
+  output: Output;
+  projectId: string | undefined;
+  sourceDir: string;
+  studioHost: string | undefined;
+  title: string;
+  version: string;
+  workspaces: readonly BrettWorkspace[];
+}): Promise<{
+  applicationId: string;
+}>;
+
+export declare function getApplication(
+  applicationId: string,
+): Promise<Application | null>;
+
+/** Where a deployed application is served on its organization's workbench. */
+export declare function getApplicationUrl(
+  application: Pick<Application, "id" | "organizationId" | "type">,
+): string;
+
 export declare function getWorkbench(
   cliConfig: CliConfig | null | undefined,
 ): DeployableWorkbenchApp | null;
 
+export declare function getWorkbenchUrl(organizationId: string): string;
+
 /** @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. */
@@ -175,10 +292,14 @@ declare interface ResolvedWorkbenchApp {
   readonly views: NonNullable<DefineAppInput["views"]>;
   /** Resolved app kind — `studio` or one of the SDK app types. */
   readonly applicationType?: string;
+  /** Deploys on its own path, separate from the interfaces. */
+  readonly config?: WorkbenchApp["config"];
   /** SDK app-view entrypoint, when declared. */
   readonly entry?: string;
-  /** Deploys on its own path, separate from the interfaces. */
-  readonly installationConfig?: WorkbenchApp["installationConfig"];
+  /** Explicit singleton flag (a Sanity-owned app); `undefined` when the app doesn't set it. */
+  readonly isSingleton?: boolean;
+  /** Hostname the application is created at on first deploy. */
+  readonly slug?: string;
 }
 
 /**
@@ -196,14 +317,28 @@ export declare function resolveInstallationId(options: {
  * one of potentially many shapes.
  * @internal
  */
-export declare function summarizeInstallationConfig(config: {
+export declare function summarizeConfig(config: {
   appType: string;
   fields: {
     name: string;
+    src: string;
     title: string;
   }[];
 }): string;
 
+/**
+ * The deploy summary of an app's exposes: the structured records (for `--json`)
+ * and one report line per non-empty group (for the human report).
+ * @internal
+ */
+export declare function summarizeExposes({
+  services,
+  views,
+}: WorkbenchExposes): {
+  exposes: DeployedExpose[];
+  lines: string[];
+};
+
 declare type ViewDeploymentPayload = z.infer<
   typeof viewDeploymentPayloadSchema
 >;
@@ -251,4 +386,15 @@ declare const WORKBENCH_APP: unique symbol;
 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
+ */
+declare interface WorkbenchExposes {
+  config?: WorkbenchApp["config"];
+  services?: DefineAppInput["services"];
+  views?: DefineAppInput["views"];
+}
+
 export {};

package/dist/_exports/deploy.js

@@ -1,5 +1,8 @@
+export { buildExposes, summarizeExposes } from '../actions/deploy/buildExposes.js';
 export { checkBuiltOutput } from '../actions/deploy/checkBuiltOutput.js';
-export { deployInstallationConfig, resolveInstallationId, summarizeInstallationConfig } from '../actions/deploy/deployInstallationConfig.js';
+export { deployConfig, resolveInstallationId, summarizeConfig } from '../actions/deploy/deployConfig.js';
+export { deployCoreApp, deployStudio } from '../actions/deploy/deployWorkbenchApp.js';
 export { getWorkbench } from '../actions/deploy/getWorkbench.js';
+export { getApplication, getApplicationUrl, getWorkbenchUrl } from '../services/applications.js';
 
 //# sourceMappingURL=deploy.js.map

package/dist/_exports/deploy.js.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"sources":["../../src/_exports/deploy.ts"],"sourcesContent":["export {\n  buildExposes,\n  type DeployedExpose,\n  summarizeExposes,\n} from '../actions/deploy/buildExposes.js'\nexport {checkBuiltOutput} from '../actions/deploy/checkBuiltOutput.js'\nexport {\n  deployConfig,\n  resolveInstallationId,\n  summarizeConfig,\n} from '../actions/deploy/deployConfig.js'\nexport {deployCoreApp, deployStudio} from '../actions/deploy/deployWorkbenchApp.js'\nexport {getWorkbench} from '../actions/deploy/getWorkbench.js'\nexport {\n  type Application,\n  type BrettInterface,\n  type BrettWorkspace,\n  getApplication,\n  getApplicationUrl,\n  getWorkbenchUrl,\n} from '../services/applications.js'\n"],"names":["buildExposes","summarizeExposes","checkBuiltOutput","deployConfig","resolveInstallationId","summarizeConfig","deployCoreApp","deployStudio","getWorkbench","getApplication","getApplicationUrl","getWorkbenchUrl"],"mappings":"AAAA,SACEA,YAAY,EAEZC,gBAAgB,QACX,oCAAmC;AAC1C,SAAQC,gBAAgB,QAAO,wCAAuC;AACtE,SACEC,YAAY,EACZC,qBAAqB,EACrBC,eAAe,QACV,oCAAmC;AAC1C,SAAQC,aAAa,EAAEC,YAAY,QAAO,0CAAyC;AACnF,SAAQC,YAAY,QAAO,oCAAmC;AAC9D,SAIEC,cAAc,EACdC,iBAAiB,EACjBC,eAAe,QACV,8BAA6B"}

package/dist/_exports/dev.d.ts

@@ -30,9 +30,7 @@ declare type DevServerManifest = z.infer<typeof devServerManifestSchema>;
 
 declare const devServerManifestSchema: z.ZodMiniObject<
   {
-    host: z.ZodMiniString<string>;
-    id: z.ZodMiniOptional<z.ZodMiniString<string>>;
-    installationConfigs: z.ZodMiniOptional<
+    configs: z.ZodMiniOptional<
       z.ZodMiniArray<
         z.ZodMiniObject<
           {
@@ -48,19 +46,25 @@ declare const devServerManifestSchema: z.ZodMiniObject<
                 z.core.$strip
               >
             >;
+            id: z.ZodMiniString<string>;
             moduleName: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            version: z.ZodMiniNumber<number>;
           },
           z.core.$strip
         >
       >
     >;
+    host: z.ZodMiniString<string>;
+    id: z.ZodMiniOptional<z.ZodMiniString<string>>;
     interfaces: z.ZodMiniOptional<
       z.ZodMiniArray<
         z.ZodMiniObject<
           {
-            entry_point: z.ZodMiniString<string>;
-            interface_type: z.ZodMiniString<string>;
             name: z.ZodMiniString<string>;
+            src: z.ZodMiniString<string>;
+            title: z.ZodMiniString<string>;
+            type: z.ZodMiniString<string>;
+            version: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
           },
           z.core.$strip
         >

package/dist/_exports/index.d.ts

@@ -2,14 +2,14 @@ import { z } from "zod/mini";
 
 /**
  * User-facing input for `unstable_defineApp`. Excludes the internal
- * `applicationType`, `isSingleton`, and `installationConfig` — validated by the
+ * `applicationType`, `isSingleton`, and `config` — 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" | "installationConfig" | "isSingleton"
+  "applicationType" | "config" | "isSingleton"
 >;
 
 /**
@@ -29,16 +29,7 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
         dashboard: "dashboard";
       }>
     >;
-    entry: z.ZodMiniOptional<z.ZodMiniString<string>>;
-    group: z.ZodMiniOptional<
-      z.ZodMiniEnum<{
-        "dock.system": "dock.system";
-        "dock.applications": "dock.applications";
-        "dock.user": "dock.user";
-      }>
-    >;
-    icon: z.ZodMiniOptional<z.ZodMiniString<string>>;
-    installationConfig: z.ZodMiniOptional<
+    config: z.ZodMiniOptional<
       z.ZodMiniDiscriminatedUnion<
         [
           z.ZodMiniObject<
@@ -62,6 +53,15 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
         "appType"
       >
     >;
+    entry: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    group: z.ZodMiniOptional<
+      z.ZodMiniEnum<{
+        "dock.system": "dock.system";
+        "dock.applications": "dock.applications";
+        "dock.user": "dock.user";
+      }>
+    >;
+    icon: z.ZodMiniOptional<z.ZodMiniString<string>>;
     isSingleton: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
     name: z.ZodMiniString<string>;
     organizationId: z.ZodMiniString<string>;
@@ -72,6 +72,7 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
           [
             z.ZodMiniObject<
               {
+                title: z.ZodMiniOptional<z.ZodMiniString<string>>;
                 name: z.ZodMiniString<string>;
                 src: z.ZodMiniString<string>;
                 type: z.ZodMiniLiteral<"worker">;
@@ -83,6 +84,7 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
         >
       >
     >;
+    slug: z.ZodMiniOptional<z.ZodMiniString<string>>;
     title: z.ZodMiniString<string>;
     views: z.ZodMiniOptional<
       z.ZodMiniArray<
@@ -90,6 +92,7 @@ declare const DefineAppInputSchema: z.ZodMiniObject<
           [
             z.ZodMiniObject<
               {
+                title: z.ZodMiniOptional<z.ZodMiniString<string>>;
                 name: z.ZodMiniString<string>;
                 src: z.ZodMiniString<string>;
                 type: z.ZodMiniLiteral<"panel">;
@@ -214,9 +217,10 @@ export declare interface PanelViewComponents {
  * @public
  */
 export declare type PanelViewProps = ViewComponentBaseProps<{
-  entry_point: string;
-  interface_type: "panel";
   name: string;
+  src: string;
+  title: string;
+  type: "panel";
 }>;
 
 /** @internal */
@@ -269,7 +273,7 @@ export declare function unstable_defineApp(
 ): DefineAppResult;
 
 /**
- * Declare the Sanity Media Library as a workbench app — a singleton whose `fields` become its installation config.
+ * Declare the Sanity Media Library as a workbench app — a singleton whose `fields` become its config.
  * @public
  */
 export declare function unstable_defineMediaLibrary(