@sanity/workbench-cli 2.0.1 → 2.0.2

package/dist/_exports/build.d.ts

@@ -1,248 +1,5 @@
-import { AppVisibility } from "@sanity/cli-core";
-import { CliConfig } from "@sanity/cli-core";
+import { n as WorkbenchExposes, r as resolveWorkbenchApp, t as ResolvedWorkbenchApp } from "./resolveWorkbenchApp-DqFqET9E.js";
 import { PluginOption } from "vite";
-import { z } from "zod/mini";
-
-/** The `asset_source` variant of an app's `views`. @public */
-declare type AssetSourceView = Extract<
-  NonNullable<z.output<typeof DefineAppInputSchema>["views"]>[number],
-  {
-    type: "asset_source";
-  }
->;
-
-/**
- * The `build`/`start` id — a hash of the app's declared shape (its identity, not
- * its code), so the bundle inlined by `sanity build` and the registry entry
- * advertised by `sanity start` resolve to the same id. `sanity deploy` resolves
- * its own id from the applications API.
- */
-export declare function buildAppId(app: ResolvedWorkbenchApp): Promise<string>;
-
-/**
- * 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;
-};
-
-/** @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;
-}
-
-/**
- * Resolve the workbench app for a CLI config, or `null` for a plain project.
- * @public
- */
-export declare function resolveWorkbenchApp(
-  cliConfig: CliConfig | null | undefined,
-): ResolvedWorkbenchApp | null;
-
-/** The `tile` variant of an app's `views`. @public */
-declare type TileView = Extract<
-  NonNullable<z.output<typeof DefineAppInputSchema>["views"]>[number],
-  {
-    type: "tile";
-  }
->;
-
-/**
- * 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 {
-  config?: WorkbenchApp["config"];
-  services?: DefineAppInput["services"];
-  views?: DefineAppInput["views"];
-}
-
 /**
  * Dep pre-bundling inputs for a workbench app's dev server.
  *
@@ -267,7 +24,7 @@ export declare interface WorkbenchExposes {
  * @param exposes - The app's declared views/services/config.
  * @internal
  */
-export declare function workbenchOptimizeDeps(options: {
+declare function workbenchOptimizeDeps(options: {
   appSources: readonly string[];
   cwd: string;
   exposes?: WorkbenchExposes;
@@ -275,8 +32,7 @@ export declare function workbenchOptimizeDeps(options: {
   entries: string[];
   include: string[];
 };
-
-declare interface WorkbenchViteOptions {
+interface WorkbenchViteOptions {
   /** Project root — read for the federation remote name, and the plugin workDir. */
   cwd: string;
   /**
@@ -294,10 +50,14 @@ declare interface WorkbenchViteOptions {
   /** App (vs studio) build — selects the discriminated federation option shape. */
   isApp?: boolean;
 }
-
 /** Build the Vite plugins for a workbench app's module-federation remote. */
-export declare function workbenchVitePlugins(
-  options: WorkbenchViteOptions,
-): Promise<PluginOption>;
-
-export {};
+declare function workbenchVitePlugins(options: WorkbenchViteOptions): Promise<PluginOption>;
+/**
+ * The `build`/`start` id — a hash of the app's declared shape (its identity, not
+ * its code), so the bundle inlined by `sanity build` and the registry entry
+ * advertised by `sanity start` resolve to the same id. `sanity deploy` resolves
+ * its own id from the applications API.
+ */
+declare function buildAppId(app: ResolvedWorkbenchApp): Promise<string>;
+export { type WorkbenchExposes, buildAppId, resolveWorkbenchApp, workbenchOptimizeDeps, workbenchVitePlugins };
+//# sourceMappingURL=build.d.ts.map

package/dist/_exports/contract-DyG11fQ7.d.ts

@@ -0,0 +1,45 @@
+import { z } from "zod/mini";
+/** @internal */
+declare const VIEW_CONTRACT_VERSION = 1;
+/** @internal */
+declare const SERVICE_CONTRACT_VERSION = 1;
+/**
+ * A view component. The return is opaque so the runtime helpers carry no React
+ * dependency — the generated artifact renders it with the app's own React.
+ * @public
+ */
+type ViewComponent<TProps> = (props: TProps) => unknown;
+/** @public */
+interface ViewComponentBaseProps<TView> {
+  view: TView;
+}
+/**
+ * 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 asset_source: readonly ["asset_source"];
+  readonly panel: readonly ["title", "panel"];
+  readonly tile: readonly ["tile"];
+};
+/** @public */
+type InterfaceType = keyof typeof VIEW_COMPONENTS;
+/**
+ * A tile's footprint family — the shape it occupies on the dashboard. Modelled
+ * on iOS WidgetKit families, not a linear scale: `banner` is full-width and
+ * shallow, which a `small`→`large` magnitude can't express. The host maps a
+ * family to a layout slot; the component reads it to render per footprint.
+ * @public
+ */
+declare const TileSizeSchema: z.ZodMiniEnum<{
+  small: "small";
+  large: "large";
+  banner: "banner";
+}>;
+/** @public */
+type TileSize = z.infer<typeof TileSizeSchema>;
+/** @public */
+type ServiceType = 'worker';
+export { VIEW_CONTRACT_VERSION as a, TileSize as i, SERVICE_CONTRACT_VERSION as n, ViewComponent as o, ServiceType as r, ViewComponentBaseProps as s, InterfaceType as t };
+//# sourceMappingURL=contract-DyG11fQ7.d.ts.map

package/dist/_exports/defineApp-r_CmoZfS.d.ts

@@ -0,0 +1,169 @@
+import { z } from "zod/mini";
+/** Dock groups an app can place itself into. */
+declare const DockGroupSchema: z.ZodMiniEnum<{
+  "dock.system": "dock.system";
+  "dock.applications": "dock.applications";
+  "dock.user": "dock.user";
+}>;
+/**
+ * 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
+ * apps ahead.
+ * @public
+ */
+type DockGroup = z.output<typeof DockGroupSchema>;
+/**
+ * Runtime-validation schema for `unstable_defineApp`.
+ * @internal
+ */
+declare const DefineAppInputSchema: z.ZodMiniObject<{
+  applicationType: z.ZodMiniOptional<z.ZodMiniEnum<{
+    coreApp: "coreApp";
+    studio: "studio";
+    canvas: "canvas";
+    dashboard: "dashboard";
+    "media-library": "media-library";
+  }>>;
+  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 `asset_source` variant of an app's `views`. @public */
+type AssetSourceView = Extract<NonNullable<z.output<typeof DefineAppInputSchema>['views']>[number], {
+  type: 'asset_source';
+}>;
+/** The `tile` variant of an app's `views`. @public */
+type TileView = Extract<NonNullable<z.output<typeof DefineAppInputSchema>['views']>[number], {
+  type: 'tile';
+}>;
+/**
+ * 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
+ */
+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)[];
+});
+/**
+ * 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;
+/**
+ * The branded result of `unstable_defineApp`. Carries the same fields as the
+ * input plus the internal brand — users only ever see `DefineAppInput`.
+ * @public
+ */
+type DefineAppResult = DefineAppInput & {
+  readonly [WORKBENCH_APP]: true;
+};
+/**
+ * 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
+ */
+type WorkbenchApp = DefineAppResult & z.output<typeof DefineAppInputSchema>;
+/**
+ * Whether `app` is a branded `unstable_defineApp(...)` result — the sole
+ * workbench opt-in.
+ * @public
+ */
+declare function isWorkbenchApp(app: unknown): app is WorkbenchApp;
+/**
+ * Declare a Sanity Workbench application. Identity at runtime — returns the same
+ * object reference, tagged with the workbench brand. Field validation (the
+ * `slug` pattern etc.) runs at build time in the CLI via `DefineAppInputSchema`;
+ * this helper stays a thin, pure identity wrapper.
+ * @public
+ */
+declare function unstable_defineApp(input: DefineAppInput): DefineAppResult;
+/**
+ * One custom field a media library exposes. `src` default-exports a `defineField(...)` schema type.
+ * @public
+ */
+interface MediaLibraryField {
+  /** Unique within the media library. */
+  name: string;
+  src: string;
+  title: string;
+  /** Readable outside the owning organization. */
+  public?: boolean;
+}
+/**
+ * Sanity-owned singleton, so authors don't name or title the app — only `organizationId` is required.
+ * @public
+ */
+interface DefineMediaLibraryInput {
+  /** Organization that owns the media library — the CLI runs and deploys against it. */
+  organizationId: string;
+  fields?: MediaLibraryField[];
+}
+/**
+ * Declare the Sanity Media Library as a workbench app — a singleton whose `fields` become its config.
+ * @public
+ */
+declare function unstable_defineMediaLibrary(input: DefineMediaLibraryInput): DefineAppResult;
+export { MediaLibraryField as a, unstable_defineApp as c, DockGroup as i, unstable_defineMediaLibrary as l, DefineAppResult as n, WorkbenchApp as o, DefineMediaLibraryInput as r, isWorkbenchApp as s, DefineAppInput as t };
+//# sourceMappingURL=defineApp-r_CmoZfS.d.ts.map