@sanity/workbench-cli 2.0.1 → 2.1.0

package/dist/_exports/deploy.d.ts

@@ -1,37 +1,92 @@
-import { AppVisibility } from "@sanity/cli-core";
-import { CliConfig } from "@sanity/cli-core";
-import { Output } from "@sanity/cli-core";
-import { z } from "zod/mini";
-
-export declare interface Application {
+import { i as getWorkbench, n as summarizeInterfaces, r as DeployableWorkbenchApp, t as DeployedInterface } from "./summarizeInterfaces-DLsq6P43.js";
+import "./contract-DyG11fQ7.js";
+import { AppVisibility, CliConfig, Output } from "@sanity/cli-core";
+import "node:zlib";
+/**
+ * Throws unless `sourceDir` is a directory holding 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.
+ */
+declare function checkBuiltOutput(sourceDir: string): Promise<void>;
+/**
+ * The org's active installation for an app type, or `undefined` when none is
+ * installed. Read-only, so `--dry-run` can report deployability.
+ * @internal
+ */
+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
+ */
+declare function summarizeConfig(config: {
+  appType: string;
+  fields: {
+    name: string;
+    src: string;
+    title: string;
+  }[];
+}): string;
+/**
+ * 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
+ */
+declare function deployConfig(options: {
+  appType: string;
+  installationId: string;
+  organizationId: string;
+  output: Output;
+  sourceDir: string;
+  version: string;
+}): Promise<void>;
+/** What a workbench app contributes to a deploy payload. */
+interface WorkbenchDeployPayload {
+  slug: string;
+  title: string;
+  /** Media-library config summary. */
+  config?: string;
+  isSingleton?: boolean;
+  services?: DeployedInterface[];
+  views?: DeployedInterface[];
+  visibility?: string;
+}
+/**
+ * Gated once so a plain app can't pick up a stray key: without a workbench
+ * there is nothing to contribute. `views` and `services` travel together.
+ */
+declare function toWorkbenchPayload(workbench: DeployableWorkbenchApp | null, { config, interfaces, title }: {
+  config?: string;
+  interfaces: {
+    services: DeployedInterface[];
+    views: DeployedInterface[];
+  } | null;
+  title: string;
+}): Partial<WorkbenchDeployPayload>;
+type ApplicationType = 'coreApp' | 'studio';
+interface Application {
   id: string;
   organizationId: string;
   slug: string | null;
   title: string;
   type: ApplicationType;
 }
-
-declare type ApplicationType = "coreApp" | "studio";
-
-/** The `asset_source` variant of an app's `views`. @public */
-declare type AssetSourceView = Extract<
-  NonNullable<z.output<typeof DefineAppInputSchema>["views"]>[number],
-  {
-    type: "asset_source";
-  }
->;
-
 /**
  * A resource a deployment may interact with, as Brett stores it. Per-deployment
  * and forbidden for singletons (the server 400s).
  */
-export declare interface BrettAccess {
+interface BrettAccess {
   resourceId: string;
-  resourceType: "canvas" | "dashboard" | "dataset" | "media-library";
+  resourceType: 'canvas' | 'dashboard' | 'dataset' | 'media-library';
 }
-
 /** A studio workspace as Brett stores it. */
-export declare interface BrettWorkspace {
+interface BrettWorkspace {
   dataset: string;
   projectId: string;
   /** Lexicon schema descriptor id; Brett requires one per workspace. */
@@ -42,251 +97,43 @@ export declare interface BrettWorkspace {
   subtitle?: string;
   title?: string;
 }
-
+declare function getWorkbenchUrl(organizationId: string): string;
+/** Where a deployed application is served on its organization's workbench. */
+declare function getApplicationUrl(application: Pick<Application, 'id' | 'organizationId' | 'type'>): string;
+declare function getApplication(applicationId: string): Promise<Application | null>;
+/** Every application in an organization, in one page (`limit=none`). */
+declare function listApplications(organizationId: string): Promise<Application[]>;
 /**
- * Throws unless `sourceDir` is a directory holding 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.
+ * `rollback` undoes the creation, so a later failure leaves no record stranded at the slug.
+ * @internal
  */
-export declare function checkBuiltOutput(sourceDir: string): Promise<void>;
-
+interface CreatedApplication {
+  application: Application;
+  rollback: () => Promise<void>;
+}
 /**
  * Create a coreApp record (no deployment), so the CLI can build with its id
  * before shipping the first deployment. First deploy only.
  * @internal
  */
-export declare function createCoreApp(options: {
+declare function createCoreApp(options: {
   isSingleton?: boolean;
   organizationId: string;
   slug: string;
   title: string;
   visibility?: AppVisibility;
 }): Promise<CreatedApplication>;
-
-/**
- * `rollback` undoes the creation, so a later failure leaves no record stranded at the slug.
- * @internal
- */
-export declare interface CreatedApplication {
-  application: Application;
-  rollback: () => Promise<void>;
-}
-
 /**
  * Create a studio record (no deployment).
  * @internal
  */
-export declare function createStudio(options: {
+declare function createStudio(options: {
   organizationId: string;
   projectId: string | undefined;
   slug: string;
   title: string;
   visibility?: AppVisibility;
 }): Promise<CreatedApplication>;
-
-/**
- * User-facing input for `unstable_defineApp`. Excludes the internal
- * `applicationType`, `isSingleton`, and `config` — validated by the schema but
- * not part of the public surface (Sanity-owned apps set them via
- * `@ts-expect-error`). A union: an app declares an app `entry` (navigable) or
- * panel `views`, never both — but `asset_source` and `tile` views are separate
- * kinds and may accompany either.
- * @public
- */
-declare type DefineAppInput = Omit<
-  z.output<typeof DefineAppInputSchema>,
-  "applicationType" | "config" | "entry" | "isSingleton" | "views"
-> &
-  (
-    | {
-        entry?: never;
-        views?: NonNullable<z.output<typeof DefineAppInputSchema>["views"]>;
-      }
-    | {
-        entry?: string;
-        views?: (AssetSourceView | TileView)[];
-      }
-  );
-
-/**
- * Runtime-validation schema for `unstable_defineApp`.
- * @internal
- */
-declare const DefineAppInputSchema: z.ZodMiniObject<
-  {
-    applicationType: z.ZodMiniOptional<
-      z.ZodMiniEnum<{
-        "media-library": "media-library";
-        coreApp: "coreApp";
-        studio: "studio";
-        canvas: "canvas";
-        dashboard: "dashboard";
-      }>
-    >;
-    config: 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"
-      >
-    >;
-    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>>;
-    organizationId: z.ZodMiniString<string>;
-    priority: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
-    services: z.ZodMiniOptional<
-      z.ZodMiniArray<
-        z.ZodMiniDiscriminatedUnion<
-          [
-            z.ZodMiniObject<
-              {
-                title: z.ZodMiniString<string>;
-                name: z.ZodMiniString<string>;
-                src: z.ZodMiniString<string>;
-                type: z.ZodMiniLiteral<"worker">;
-              },
-              z.core.$strip
-            >,
-          ],
-          "type"
-        >
-      >
-    >;
-    slug: z.ZodMiniString<string>;
-    title: z.ZodMiniString<string>;
-    views: z.ZodMiniOptional<
-      z.ZodMiniArray<
-        z.ZodMiniDiscriminatedUnion<
-          [
-            z.ZodMiniObject<
-              {
-                title: z.ZodMiniString<string>;
-                name: z.ZodMiniString<string>;
-                src: z.ZodMiniString<string>;
-                type: z.ZodMiniLiteral<"panel">;
-              },
-              z.core.$strip
-            >,
-            z.ZodMiniObject<
-              {
-                title: z.ZodMiniString<string>;
-                name: z.ZodMiniString<string>;
-                src: z.ZodMiniString<string>;
-                type: z.ZodMiniLiteral<"asset_source">;
-              },
-              z.core.$strip
-            >,
-            z.ZodMiniObject<
-              {
-                priority: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
-                size: z.ZodMiniEnum<{
-                  small: "small";
-                  large: "large";
-                  banner: "banner";
-                }>;
-                title: z.ZodMiniString<string>;
-                name: z.ZodMiniString<string>;
-                src: z.ZodMiniString<string>;
-                type: z.ZodMiniLiteral<"tile">;
-              },
-              z.core.$strip
-            >,
-          ],
-          "type"
-        >
-      >
-    >;
-    visibility: z.ZodMiniOptional<
-      z.ZodMiniEnum<{
-        default: "default";
-        unlisted: "unlisted";
-        disabled: "disabled";
-      }>
-    >;
-  },
-  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 type DefineAppResult = DefineAppInput & {
-  readonly [WORKBENCH_APP]: true;
-};
-
-declare 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;
-}
-
-/**
- * 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 deployConfig(options: {
-  appType: string;
-  installationId: string;
-  organizationId: string;
-  output: Output;
-  sourceDir: string;
-  version: string;
-}): Promise<void>;
-
-/** A view or service as the deploy report and `--json` output surface it. */
-export declare interface DeployedInterface {
-  name: string;
-  src: string;
-  title: string;
-  type: string;
-}
-
 /**
  * Ship a deployment to an already-created (or `deployment.appId`) application,
  * then sync its mutable metadata (`title`, and `icon`/`visibility` when set)
@@ -298,9 +145,9 @@ export declare interface DeployedInterface {
  * application once it has an active deployment.
  * @internal
  */
-export declare function deployWorkbenchApp(options: {
+declare function deployWorkbenchApp(options: {
   access?: readonly BrettAccess[];
-  app: CliConfig["app"];
+  app: CliConfig['app'];
   applicationId: string;
   icon?: string;
   isApp: boolean;
@@ -313,185 +160,5 @@ export declare function deployWorkbenchApp(options: {
   visibility?: AppVisibility;
   workspaces?: readonly BrettWorkspace[];
 }): Promise<void>;
-
-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;
-
-/** Every application in an organization, in one page (`limit=none`). */
-export declare function listApplications(
-  organizationId: string,
-): Promise<Application[]>;
-
-/** @public */
-declare 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;
-}
-
-/**
- * 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 summarizeConfig(config: {
-  appType: string;
-  fields: {
-    name: string;
-    src: string;
-    title: string;
-  }[];
-}): string;
-
-/**
- * One report line per non-empty group, alongside the records `--json` reports.
- * @internal
- */
-export declare function summarizeInterfaces({
-  services,
-  views,
-}: WorkbenchExposes): {
-  lines: string[];
-  services: DeployedInterface[];
-  views: DeployedInterface[];
-};
-
-/** The `tile` variant of an app's `views`. @public */
-declare type TileView = Extract<
-  NonNullable<z.output<typeof DefineAppInputSchema>["views"]>[number],
-  {
-    type: "tile";
-  }
->;
-
-/**
- * Gated once so a plain app can't pick up a stray key: without a workbench
- * there is nothing to contribute. `views` and `services` travel together.
- */
-export declare function toWorkbenchPayload(
-  workbench: DeployableWorkbenchApp | null,
-  {
-    config,
-    interfaces,
-    title,
-  }: {
-    config?: string;
-    interfaces: {
-      services: DeployedInterface[];
-      views: DeployedInterface[];
-    } | null;
-    title: string;
-  },
-): Partial<WorkbenchDeployPayload>;
-
-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<{
-            asset_source: "asset_source";
-            panel: "panel";
-            tile: "tile";
-          }>;
-        },
-        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>;
-
-/** What a workbench app contributes to a deploy payload. */
-export declare interface WorkbenchDeployPayload {
-  slug: string;
-  title: string;
-  /** Media-library config summary. */
-  config?: string;
-  isSingleton?: boolean;
-  services?: DeployedInterface[];
-  views?: DeployedInterface[];
-  visibility?: string;
-}
-
-/**
- * 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 {};
+export { type Application, type BrettAccess, type BrettWorkspace, type CreatedApplication, type DeployedInterface, type WorkbenchDeployPayload, checkBuiltOutput, createCoreApp, createStudio, deployConfig, deployWorkbenchApp, getApplication, getApplicationUrl, getWorkbench, getWorkbenchUrl, listApplications, resolveInstallationId, summarizeConfig, summarizeInterfaces, toWorkbenchPayload };
+//# sourceMappingURL=deploy.d.ts.map