@sanity/workbench-cli 2.0.1 → 2.1.0

package/dist/_exports/index.d.ts

@@ -1,281 +1,54 @@
+import { a as MediaLibraryField, c as unstable_defineApp, i as DockGroup, l as unstable_defineMediaLibrary, n as DefineAppResult, o as WorkbenchApp, r as DefineMediaLibraryInput, s as isWorkbenchApp, t as DefineAppInput } from "./defineApp-DSvQx8rf.js";
+import { a as VIEW_CONTRACT_VERSION, i as TileSize, n as SERVICE_CONTRACT_VERSION, o as ViewComponent, r as ServiceType, s as ViewComponentBaseProps, t as InterfaceType } from "./contract-DyG11fQ7.js";
 import { AssetSourceComponentProps } from "@sanity/types";
-import { z } from "zod/mini";
-
 /**
- * An asset source's view-component slot — the module-federation expose for its
- * one island.
- * @public
- */
-export declare type AssetSourceComponent = keyof AssetSourceViewComponents;
-
-/** 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 component slots an `asset_source` view exposes — a single picker island,
- * typed with the studio asset-source props it renders behind. The props are
- * `@sanity/types`' `AssetSourceComponentProps` directly, so an authored picker
- * receives exactly what a studio `AssetSource.component` does.
+ * The service's own declaration, surfaced to the callback.
  * @public
  */
-export declare interface AssetSourceViewComponents {
-  asset_source: ViewComponent<AssetSourceComponentProps>;
+interface ServiceInfo {
+  readonly name: string;
+  readonly type: 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.
+ * Context every service callback receives when its worker starts. Mirrors how a
+ * view component receives its `view` — the service receives its own `service`.
  * @public
  */
-export 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
->;
-
+interface ServiceContext {
+  readonly service: ServiceInfo;
+}
 /**
- * The branded result of `unstable_defineApp`. Carries the same fields as the
- * input plus the internal brand — users only ever see `DefineAppInput`.
+ * A service callback. Runs once inside the worker on start; returns an optional
+ * disposer the host calls before terminating the worker.
  * @public
  */
-export declare type DefineAppResult = DefineAppInput & {
-  readonly [WORKBENCH_APP]: true;
-};
-
+type ServiceCallback = (context: ServiceContext) => (() => void) | void;
+/** The callback shape each service type defines, keyed by type. */
+interface ServiceCallbacksByType {
+  worker: ServiceCallback;
+}
 /**
  * The result of `unstable_defineService`: the author's callback, the service
  * type, and the internal contract version the worker artifact targets.
  * @public
  */
-export declare interface DefinedService<
-  TType extends ServiceType = ServiceType,
-> {
+interface DefinedService<TType extends ServiceType = ServiceType> {
   readonly run: ServiceCallbacksByType[TType];
   readonly type: TType;
   /** @internal */
   readonly version: typeof SERVICE_CONTRACT_VERSION;
 }
-
-/**
- * The result of `unstable_defineView`: the author's component(s), the view type,
- * and the internal contract version the build artifact targets.
- * @public
- */
-export declare interface DefinedView<
-  TType extends InterfaceType = InterfaceType,
-> {
-  readonly components: ViewComponentsByType[TType];
-  readonly type: TType;
-  /** @internal */
-  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
- * apps ahead.
- * @public
- */
-export declare type DockGroup = z.output<typeof DockGroupSchema>;
-
-/** 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";
-}>;
-
-/** @public */
-export declare type InterfaceType = keyof typeof VIEW_COMPONENTS;
-
-/**
- * Whether `app` is a branded `unstable_defineApp(...)` result — the sole
- * workbench opt-in.
- * @public
- */
-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.
- * @public
- */
-export declare type PanelComponent = keyof PanelViewComponents;
-
-/**
- * The component slots a `panel` view exposes — each its own module-federation
- * island, typed with the panel props.
+ * Define a Sanity Workbench background service. The first argument narrows the
+ * callback shape — `"worker"` runs the callback inside a Web Worker, where it
+ * can emit dock-badge updates and return a disposer.
+ *
+ * Identity at runtime: returns the callback tagged with its type and the contract
+ * version, for the CLI build to generate a worker artifact from. Used as the
+ * default export of a service's `src` file.
  * @public
  */
-export declare interface PanelViewComponents {
-  panel: ViewComponent<PanelViewProps>;
-  title: ViewComponent<PanelViewProps>;
-}
-
+declare function unstable_defineService<TType extends ServiceType>(type: TType, run: ServiceCallbacksByType[TType]): DefinedService<TType>;
 /**
  * Props a panel component receives: its interface record, minus the
  * service-assigned `id`/`deployment_id` a local dev server can't provide. Mirrors
@@ -283,90 +56,42 @@ export declare interface PanelViewComponents {
  * `@sanity/workbench`); drift is guarded by the stamped contract version.
  * @public
  */
-export declare type PanelViewProps = ViewComponentBaseProps<{
+type PanelViewProps = ViewComponentBaseProps<{
   name: string;
   src: string;
   title: string;
-  type: "panel";
+  type: 'panel';
 }>;
-
-/** @internal */
-declare const SERVICE_CONTRACT_VERSION = 1;
-
 /**
- * A service callback. Runs once inside the worker on start; returns an optional
- * disposer the host calls before terminating the worker.
+ * The component slots a `panel` view exposes — each its own module-federation
+ * island, typed with the panel props.
  * @public
  */
-export declare type ServiceCallback = (
-  context: ServiceContext,
-) => (() => void) | void;
-
-/** The callback shape each service type defines, keyed by type. */
-declare interface ServiceCallbacksByType {
-  worker: ServiceCallback;
+interface PanelViewComponents {
+  panel: ViewComponent<PanelViewProps>;
+  title: ViewComponent<PanelViewProps>;
 }
-
 /**
- * Context every service callback receives when its worker starts. Mirrors how a
- * view component receives its `view` — the service receives its own `service`.
+ * A panel's view-component slot — the module-federation expose for one island.
  * @public
  */
-export declare interface ServiceContext {
-  readonly service: ServiceInfo;
-}
-
+type PanelComponent = keyof PanelViewComponents;
 /**
- * The service's own declaration, surfaced to the callback.
+ * The component slots an `asset_source` view exposes — a single picker island,
+ * typed with the studio asset-source props it renders behind. The props are
+ * `@sanity/types`' `AssetSourceComponentProps` directly, so an authored picker
+ * receives exactly what a studio `AssetSource.component` does.
  * @public
  */
-export declare interface ServiceInfo {
-  readonly name: string;
-  readonly type: string;
+interface AssetSourceViewComponents {
+  asset_source: ViewComponent<AssetSourceComponentProps>;
 }
-
-/** @public */
-export declare type ServiceType = "worker";
-
 /**
- * A tile's view-component slot — the module-federation expose for its one island.
- * @public
- */
-export declare type TileComponent = keyof TileViewComponents;
-
-/** @public */
-export declare type TileSize = z.infer<typeof TileSizeSchema>;
-
-/**
- * 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";
-}>;
-
-/** The `tile` variant of an app's `views`. @public */
-declare type TileView = Extract<
-  NonNullable<z.output<typeof DefineAppInputSchema>["views"]>[number],
-  {
-    type: "tile";
-  }
->;
-
-/**
- * The component slot a `tile` view exposes — a single island, typed with the
- * tile props.
+ * An asset source's view-component slot — the module-federation expose for its
+ * one island.
  * @public
  */
-export declare interface TileViewComponents {
-  tile: ViewComponent<TileViewProps>;
-}
-
+type AssetSourceComponent = keyof AssetSourceViewComponents;
 /**
  * Props a tile component receives: its own interface record (name/src/title/
  * type) plus its footprint `size`, so it can render per family. Mirrors the
@@ -374,114 +99,56 @@ export declare interface TileViewComponents {
  * contract version. Placement `priority` is host-only metadata, not surfaced here.
  * @public
  */
-export declare type TileViewProps = ViewComponentBaseProps<{
+type TileViewProps = ViewComponentBaseProps<{
   name: string;
   size: TileSize;
   src: string;
   title: string;
-  type: "tile";
+  type: 'tile';
 }>;
-
-/**
- * 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
- */
-export declare function unstable_defineApp(
-  input: DefineAppInput,
-): DefineAppResult;
-
-/**
- * Declare the Sanity Media Library as a workbench app — a singleton whose `fields` become its 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
- * can emit dock-badge updates and return a disposer.
- *
- * Identity at runtime: returns the callback tagged with its type and the contract
- * version, for the CLI build to generate a worker artifact from. Used as the
- * default export of a service's `src` file.
- * @public
- */
-export declare function unstable_defineService<TType extends ServiceType>(
-  type: TType,
-  run: ServiceCallbacksByType[TType],
-): DefinedService<TType>;
-
 /**
- * Define a Sanity Workbench view. The first argument narrows the component shape
- * and the props each component receives — `"panel"` yields a `{title, panel}`
- * record whose components are typed with the panel props.
- *
- * Returns the component(s) tagged with their type and the contract version, for
- * the CLI build to generate render artifacts from. Used as the default export of
- * a view's `src` file.
+ * The component slot a `tile` view exposes — a single island, typed with the
+ * tile props.
  * @public
  */
-export declare function unstable_defineView<TType extends InterfaceType>(
-  type: TType,
-  components: ViewComponentsByType[TType],
-): DefinedView<TType>;
-
-/**
- * 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"];
-};
-
-/** @internal */
-declare const VIEW_CONTRACT_VERSION = 1;
-
+interface TileViewComponents {
+  tile: ViewComponent<TileViewProps>;
+}
 /**
- * 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.
+ * A tile's view-component slot — the module-federation expose for its one island.
  * @public
  */
-declare type ViewComponent<TProps> = (props: TProps) => unknown;
-
-/** @public */
-declare interface ViewComponentBaseProps<TView> {
-  view: TView;
-}
-
+type TileComponent = keyof TileViewComponents;
 /**
  * The components each interface type exposes, keyed by type.
  * @public
  */
-export declare interface ViewComponentsByType {
+interface ViewComponentsByType {
   asset_source: AssetSourceViewComponents;
   panel: PanelViewComponents;
   tile: TileViewComponents;
 }
-
 /**
- * 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.
+ * The result of `unstable_defineView`: the author's component(s), the view type,
+ * and the internal contract version the build artifact targets.
+ * @public
  */
-declare const WORKBENCH_APP: unique symbol;
-
+interface DefinedView<TType extends InterfaceType = InterfaceType> {
+  readonly components: ViewComponentsByType[TType];
+  readonly type: TType;
+  /** @internal */
+  readonly version: typeof VIEW_CONTRACT_VERSION;
+}
 /**
- * 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.
+ * Define a Sanity Workbench view. The first argument narrows the component shape
+ * and the props each component receives — `"panel"` yields a `{title, panel}`
+ * record whose components are typed with the panel props.
+ *
+ * Returns the component(s) tagged with their type and the contract version, for
+ * the CLI build to generate render artifacts from. Used as the default export of
+ * a view's `src` file.
  * @public
  */
-export declare type WorkbenchApp = DefineAppResult &
-  z.output<typeof DefineAppInputSchema>;
-
-export {};
+declare function unstable_defineView<TType extends InterfaceType>(type: TType, components: ViewComponentsByType[TType]): DefinedView<TType>;
+export { type AssetSourceComponent, type AssetSourceViewComponents, type DefineAppInput, type DefineAppResult, type DefineMediaLibraryInput, type DefinedService, type DefinedView, type DockGroup, type InterfaceType, type MediaLibraryField, type PanelComponent, type PanelViewComponents, type PanelViewProps, type ServiceCallback, type ServiceContext, type ServiceInfo, type ServiceType, type TileComponent, type TileSize, type TileViewComponents, type TileViewProps, type ViewComponentsByType, type WorkbenchApp, isWorkbenchApp, unstable_defineApp, unstable_defineMediaLibrary, unstable_defineService, unstable_defineView };
+//# sourceMappingURL=index.d.ts.map

package/dist/_exports/init.d.ts

@@ -1,14 +1,10 @@
-export declare function toAppSlug(value: string): string | null;
-
 /** App scaffold — `entry` auto-declares the navigable app view. */
-export declare const workbenchAppConfigTemplate =
-  "\nimport {defineCliConfig, unstable_defineApp} from 'sanity/cli'\n\nexport default defineCliConfig({\n  app: unstable_defineApp({\n    title: '%title%',\n    slug: '%slug%',\n    organizationId: '%organizationId%',\n    entry: '%entry%',\n  }),\n})\n";
-
+declare const workbenchAppConfigTemplate = "\nimport {defineCliConfig, unstable_defineApp} from 'sanity/cli'\n\nexport default defineCliConfig({\n  app: unstable_defineApp({\n    title: '%title%',\n    slug: '%slug%',\n    organizationId: '%organizationId%',\n    entry: '%entry%',\n  }),\n})\n";
 /**
  * Studio scaffold — brands with slug/title only, no `entry` (studio app views
  * aren't implemented yet).
  */
-export declare const workbenchStudioConfigTemplate =
-  "\nimport {defineCliConfig, unstable_defineApp} from 'sanity/cli'\n\nexport default defineCliConfig({\n  api: {\n    projectId: '%projectId%',\n    dataset: '%dataset%'\n  },\n  app: unstable_defineApp({\n    title: '%title%',\n    slug: '%slug%',\n    organizationId: '%organizationId%',\n  }),\n  deployment: {\n    /**\n     * Enable auto-updates for studios.\n     * Learn more at https://www.sanity.io/docs/studio/latest-version-of-sanity#k47faf43faf56\n     */\n    autoUpdates: __BOOL__autoUpdates__,\n  },\n})\n";
-
-export {};
+declare const workbenchStudioConfigTemplate = "\nimport {defineCliConfig, unstable_defineApp} from 'sanity/cli'\n\nexport default defineCliConfig({\n  api: {\n    projectId: '%projectId%',\n    dataset: '%dataset%'\n  },\n  app: unstable_defineApp({\n    title: '%title%',\n    slug: '%slug%',\n    organizationId: '%organizationId%',\n  }),\n  deployment: {\n    /**\n     * Enable auto-updates for studios.\n     * Learn more at https://www.sanity.io/docs/studio/latest-version-of-sanity#k47faf43faf56\n     */\n    autoUpdates: __BOOL__autoUpdates__,\n  },\n})\n";
+declare function toAppSlug(value: string): string | null;
+export { toAppSlug, workbenchAppConfigTemplate, workbenchStudioConfigTemplate };
+//# sourceMappingURL=init.d.ts.map