@sanity/workbench-cli 2.0.0 → 2.0.2

package/dist/_exports/preview.d.ts

@@ -1,187 +1,6 @@
-import { CliConfig } from "@sanity/cli-core";
-import { Output } from "@sanity/cli-core";
-import { z } from "zod/mini";
-
-/**
- * A manifest describing a running dev server process (studio or app).
- * Stored as `~/.sanity/dev-servers/<pid>.json`.
- *
- * The workbench singleton is tracked separately via the lock file — see
- * `acquireWorkbenchLock` and `readWorkbenchLock` below.
- */
-declare type DevServerManifest = z.infer<typeof devServerManifestSchema>;
-
-declare const devServerManifestSchema: z.ZodMiniObject<
-  {
-    configs: 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
-              >
-            >;
-            id: z.ZodMiniString<string>;
-            moduleName: z.ZodMiniOptional<z.ZodMiniString<string>>;
-            version: z.ZodMiniString<string>;
-          },
-          z.core.$strip
-        >
-      >
-    >;
-    host: z.ZodMiniString<string>;
-    id: z.ZodMiniOptional<z.ZodMiniString<string>>;
-    interfaces: z.ZodMiniOptional<
-      z.ZodMiniArray<
-        z.ZodMiniDiscriminatedUnion<
-          [
-            z.ZodMiniObject<
-              {
-                metadata: z.ZodMiniNullable<
-                  z.ZodMiniObject<
-                    {
-                      group: z.ZodMiniOptional<z.ZodMiniString<string>>;
-                      priority: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
-                    },
-                    z.core.$strip
-                  >
-                >;
-                type: z.ZodMiniLiteral<"app">;
-                id: z.ZodMiniString<string>;
-                moduleId: z.ZodMiniString<string>;
-                name: z.ZodMiniString<string>;
-                src: z.ZodMiniString<string>;
-                title: z.ZodMiniString<string>;
-                version: z.ZodMiniOptional<z.ZodMiniString<string>>;
-              },
-              z.core.$strip
-            >,
-            z.ZodMiniObject<
-              {
-                metadata: z.ZodMiniNull;
-                type: z.ZodMiniLiteral<"panel">;
-                id: z.ZodMiniString<string>;
-                moduleId: z.ZodMiniString<string>;
-                name: z.ZodMiniString<string>;
-                src: z.ZodMiniString<string>;
-                title: z.ZodMiniString<string>;
-                version: z.ZodMiniOptional<z.ZodMiniString<string>>;
-              },
-              z.core.$strip
-            >,
-            z.ZodMiniObject<
-              {
-                metadata: z.ZodMiniNull;
-                type: z.ZodMiniLiteral<"asset_source">;
-                id: z.ZodMiniString<string>;
-                moduleId: z.ZodMiniString<string>;
-                name: z.ZodMiniString<string>;
-                src: z.ZodMiniString<string>;
-                title: z.ZodMiniString<string>;
-                version: z.ZodMiniOptional<z.ZodMiniString<string>>;
-              },
-              z.core.$strip
-            >,
-            z.ZodMiniObject<
-              {
-                metadata: z.ZodMiniObject<
-                  {
-                    priority: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
-                    size: z.ZodMiniEnum<{
-                      small: "small";
-                      large: "large";
-                      banner: "banner";
-                    }>;
-                  },
-                  z.core.$strip
-                >;
-                type: z.ZodMiniLiteral<"tile">;
-                id: z.ZodMiniString<string>;
-                moduleId: z.ZodMiniString<string>;
-                name: z.ZodMiniString<string>;
-                src: z.ZodMiniString<string>;
-                title: z.ZodMiniString<string>;
-                version: z.ZodMiniOptional<z.ZodMiniString<string>>;
-              },
-              z.core.$strip
-            >,
-            z.ZodMiniObject<
-              {
-                metadata: z.ZodMiniNull;
-                type: z.ZodMiniLiteral<"worker">;
-                id: z.ZodMiniString<string>;
-                moduleId: z.ZodMiniString<string>;
-                name: z.ZodMiniString<string>;
-                src: z.ZodMiniString<string>;
-                title: z.ZodMiniString<string>;
-                version: z.ZodMiniOptional<z.ZodMiniString<string>>;
-              },
-              z.core.$strip
-            >,
-          ],
-          "type"
-        >
-      >
-    >;
-    manifest: z.ZodMiniOptional<
-      z.ZodMiniUnion<
-        readonly [
-          z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniUnknown>,
-          z.ZodMiniObject<
-            {
-              group: z.ZodMiniOptional<z.ZodMiniString<string>>;
-              icon: z.ZodMiniOptional<z.ZodMiniString<string>>;
-              priority: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
-              slug: z.ZodMiniOptional<z.ZodMiniString<string>>;
-              title: z.ZodMiniOptional<z.ZodMiniString<string>>;
-              version: z.ZodMiniString<string>;
-            },
-            z.core.$strip
-          >,
-        ]
-      >
-    >;
-    manifestUpdatedAt: z.ZodMiniOptional<z.ZodMiniString<string>>;
-    pid: z.ZodMiniNumber<number>;
-    port: z.ZodMiniNumber<number>;
-    projectId: z.ZodMiniOptional<z.ZodMiniString<string>>;
-    startedAt: z.ZodMiniString<string>;
-    type: z.ZodMiniEnum<{
-      coreApp: "coreApp";
-      studio: "studio";
-    }>;
-    version: z.ZodMiniLiteral<1>;
-    workDir: z.ZodMiniString<string>;
-  },
-  z.core.$strip
->;
-
-/**
- * `sanity start` for a workbench app: serve a production build the way dev serves
- * a live one. The same singleton workbench shell renders it and the same registry
- * advertises it — only the remote differs, static files from the build output
- * instead of a live Vite dev server. There's no config watcher or rebuild: a
- * build is fixed, so nothing re-syncs.
- *
- * A running workbench claims the configured port, so the built remote binds the
- * next one. Without one the remote takes the configured port and announces its
- * own URL.
- */
-export declare function startWorkbenchPreview(
-  options: StartWorkbenchPreviewOptions,
-): Promise<{
-  close: () => Promise<void>;
-}>;
-
-export declare interface StartWorkbenchPreviewOptions {
+import { t as DevServerManifest } from "./registry-DI7hnTof.js";
+import { CliConfig, Output } from "@sanity/cli-core";
+interface StartWorkbenchPreviewOptions {
   /** Directory for the workbench Vite server's dependency cache. */
   cacheDir: string;
   /** CLI-domain `app.id`/`deployment.appId` deprecation check, run before registering. */
@@ -191,7 +10,7 @@ export declare interface StartWorkbenchPreviewOptions {
   extractManifest: (params: {
     configPath: string;
     workDir: string;
-  }) => Promise<DevServerManifest["manifest"]>;
+  }) => Promise<DevServerManifest['manifest']>;
   httpHost: string;
   httpPort: number;
   isApp: boolean;
@@ -201,5 +20,19 @@ export declare interface StartWorkbenchPreviewOptions {
   reactStrictMode: boolean;
   workDir: string;
 }
-
-export {};
+/**
+ * `sanity start` for a workbench app: serve a production build the way dev serves
+ * a live one. The same singleton workbench shell renders it and the same registry
+ * advertises it — only the remote differs, static files from the build output
+ * instead of a live Vite dev server. There's no config watcher or rebuild: a
+ * build is fixed, so nothing re-syncs.
+ *
+ * A running workbench claims the configured port, so the built remote binds the
+ * next one. Without one the remote takes the configured port and announces its
+ * own URL.
+ */
+declare function startWorkbenchPreview(options: StartWorkbenchPreviewOptions): Promise<{
+  close: () => Promise<void>;
+}>;
+export { type StartWorkbenchPreviewOptions, startWorkbenchPreview };
+//# sourceMappingURL=preview.d.ts.map

package/dist/_exports/registry-DI7hnTof.d.ts

@@ -0,0 +1,102 @@
+import { z } from "zod/mini";
+declare const devServerManifestSchema: z.ZodMiniObject<{
+  configs: 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>>;
+    id: z.ZodMiniString<string>;
+    moduleName: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    version: z.ZodMiniString<string>;
+  }, z.core.$strip>>>;
+  host: z.ZodMiniString<string>;
+  id: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  interfaces: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+    metadata: z.ZodMiniNullable<z.ZodMiniObject<{
+      group: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      priority: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+    }, z.core.$strip>>;
+    type: z.ZodMiniLiteral<"app">;
+    id: z.ZodMiniString<string>;
+    moduleId: z.ZodMiniString<string>;
+    name: z.ZodMiniString<string>;
+    src: z.ZodMiniString<string>;
+    title: z.ZodMiniString<string>;
+    version: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  }, z.core.$strip>, z.ZodMiniObject<{
+    metadata: z.ZodMiniNull;
+    type: z.ZodMiniLiteral<"panel">;
+    id: z.ZodMiniString<string>;
+    moduleId: z.ZodMiniString<string>;
+    name: z.ZodMiniString<string>;
+    src: z.ZodMiniString<string>;
+    title: z.ZodMiniString<string>;
+    version: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  }, z.core.$strip>, z.ZodMiniObject<{
+    metadata: z.ZodMiniNull;
+    type: z.ZodMiniLiteral<"asset_source">;
+    id: z.ZodMiniString<string>;
+    moduleId: z.ZodMiniString<string>;
+    name: z.ZodMiniString<string>;
+    src: z.ZodMiniString<string>;
+    title: z.ZodMiniString<string>;
+    version: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  }, z.core.$strip>, z.ZodMiniObject<{
+    metadata: z.ZodMiniObject<{
+      priority: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+      size: z.ZodMiniEnum<{
+        small: "small";
+        large: "large";
+        banner: "banner";
+      }>;
+    }, z.core.$strip>;
+    type: z.ZodMiniLiteral<"tile">;
+    id: z.ZodMiniString<string>;
+    moduleId: z.ZodMiniString<string>;
+    name: z.ZodMiniString<string>;
+    src: z.ZodMiniString<string>;
+    title: z.ZodMiniString<string>;
+    version: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  }, z.core.$strip>, z.ZodMiniObject<{
+    metadata: z.ZodMiniNull;
+    type: z.ZodMiniLiteral<"worker">;
+    id: z.ZodMiniString<string>;
+    moduleId: z.ZodMiniString<string>;
+    name: z.ZodMiniString<string>;
+    src: z.ZodMiniString<string>;
+    title: z.ZodMiniString<string>;
+    version: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  }, z.core.$strip>], "type">>>;
+  manifest: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniUnknown>, z.ZodMiniObject<{
+    group: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    icon: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    priority: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+    slug: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    title: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    version: z.ZodMiniString<string>;
+  }, z.core.$strip>]>>;
+  manifestUpdatedAt: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  pid: z.ZodMiniNumber<number>;
+  port: z.ZodMiniNumber<number>;
+  projectId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  startedAt: z.ZodMiniString<string>;
+  type: z.ZodMiniEnum<{
+    coreApp: "coreApp";
+    studio: "studio";
+  }>;
+  version: z.ZodMiniLiteral<1>;
+  workDir: z.ZodMiniString<string>;
+}, z.core.$strip>;
+/**
+ * A manifest describing a running dev server process (studio or app).
+ * Stored as `~/.sanity/dev-servers/<pid>.json`.
+ *
+ * The workbench singleton is tracked separately via the lock file — see
+ * `acquireWorkbenchLock` and `readWorkbenchLock` below.
+ */
+type DevServerManifest = z.infer<typeof devServerManifestSchema>;
+export { DevServerManifest as t };
+//# sourceMappingURL=registry-DI7hnTof.d.ts.map

package/dist/_exports/resolveWorkbenchApp-DqFqET9E.d.ts

@@ -0,0 +1,41 @@
+import { o as WorkbenchApp, t as DefineAppInput } from "./defineApp-r_CmoZfS.js";
+import { AppVisibility, CliConfig } from "@sanity/cli-core";
+/**
+ * Bundled so adding a declaration family touches this type and the artifact
+ * expanders, not every hop of build/dev plumbing in between.
+ * @internal
+ */
+interface WorkbenchExposes {
+  config?: WorkbenchApp['config'];
+  services?: DefineAppInput['services'];
+  views?: DefineAppInput['views'];
+}
+/** @public */
+interface ResolvedWorkbenchApp {
+  /** Organization that owns the app — part of its build-id identity. */
+  readonly organizationId: string;
+  /** Background worker services the app declares. */
+  readonly services: NonNullable<DefineAppInput['services']>;
+  readonly slug: string;
+  /** Dock panel views the app declares. */
+  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;
+  /** Path to the app's icon SVG, resolved and shipped to Brett on deploy. */
+  readonly icon?: string;
+  /** Explicit singleton flag (a Sanity-owned app); `undefined` when the app doesn't set it. */
+  readonly isSingleton?: boolean;
+  /** Dashboard visibility declared by the app; `undefined` when unset. */
+  readonly visibility?: AppVisibility;
+}
+/**
+ * Resolve the workbench app for a CLI config, or `null` for a plain project.
+ * @public
+ */
+declare function resolveWorkbenchApp(cliConfig: CliConfig | null | undefined): ResolvedWorkbenchApp | null;
+export { WorkbenchExposes as n, resolveWorkbenchApp as r, ResolvedWorkbenchApp as t };
+//# sourceMappingURL=resolveWorkbenchApp-DqFqET9E.d.ts.map

package/dist/_exports/summarizeInterfaces-DBGiAwNT.d.ts

@@ -0,0 +1,62 @@
+import { n as WorkbenchExposes, t as ResolvedWorkbenchApp } from "./resolveWorkbenchApp-DqFqET9E.js";
+import { CliConfig } from "@sanity/cli-core";
+import { z } from "zod/mini";
+/**
+ * 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";
+      asset_source: "asset_source";
+      tile: "tile";
+    }>;
+  }, z.core.$loose>>;
+}, z.core.$strip>;
+type ViewDeploymentPayload = z.infer<typeof viewDeploymentPayloadSchema>;
+interface DeployableWorkbenchApp extends ResolvedWorkbenchApp {
+  /**
+   * 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;
+  /**
+   * 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 config — deploy
+   * persists the config to the org's installation. Independent of the interfaces,
+   * which register regardless; non-singletons never carry a config.
+   */
+  deploySingletonConfig: boolean;
+  /** Declares something to host as an application — an entry, view, or service. */
+  hasInterfaces: boolean;
+}
+declare function getWorkbench(cliConfig: CliConfig | null | undefined): DeployableWorkbenchApp | null;
+/** A view or service as the deploy report and `--json` output surface it. */
+interface DeployedInterface {
+  name: string;
+  src: string;
+  title: string;
+  type: string;
+}
+/**
+ * One report line per non-empty group, alongside the records `--json` reports.
+ * @internal
+ */
+declare function summarizeInterfaces({ services, views }: WorkbenchExposes): {
+  lines: string[];
+  services: DeployedInterface[];
+  views: DeployedInterface[];
+};
+export { getWorkbench as i, summarizeInterfaces as n, DeployableWorkbenchApp as r, DeployedInterface as t };
+//# sourceMappingURL=summarizeInterfaces-DBGiAwNT.d.ts.map