@sanity/cli-build 0.0.0-20260612071721 → 0.0.0-20260612074408

package/dist/_exports/_internal/federation.d.ts

@@ -0,0 +1,300 @@
+import { z } from "zod/mini";
+
+/**
+ * User-facing input for `unstable_defineApp`. Excludes the internal
+ * `applicationType` — that field is validated by the schema but is not part of
+ * the public surface (Sanity-owned apps set it via `@ts-expect-error`).
+ * @public
+ */
+export declare type DefineAppInput = Omit<
+  z.output<typeof DefineAppInputSchema>,
+  "applicationType"
+>;
+
+/**
+ * Runtime-validation schema for `unstable_defineApp`. Validates the full shape
+ * including the internal `applicationType`; the user-facing `DefineAppInput`
+ * type below omits that field.
+ * @internal
+ */
+declare const DefineAppInputSchema: z.ZodMiniObject<
+  {
+    applicationType: z.ZodMiniOptional<
+      z.ZodMiniEnum<{
+        coreApp: "coreApp";
+        studio: "studio";
+        canvas: "canvas";
+        dashboard: "dashboard";
+        "media-library": "media-library";
+        system: "system";
+      }>
+    >;
+    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>>;
+    name: z.ZodMiniString<string>;
+    organizationId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    priority: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+    services: z.ZodMiniOptional<
+      z.ZodMiniArray<
+        z.ZodMiniDiscriminatedUnion<
+          [
+            z.ZodMiniObject<
+              {
+                name: z.ZodMiniString<string>;
+                src: z.ZodMiniString<string>;
+                type: z.ZodMiniLiteral<"worker">;
+              },
+              z.core.$strip
+            >,
+          ],
+          "type"
+        >
+      >
+    >;
+    title: z.ZodMiniString<string>;
+    views: z.ZodMiniOptional<
+      z.ZodMiniArray<
+        z.ZodMiniDiscriminatedUnion<
+          [
+            z.ZodMiniObject<
+              {
+                name: z.ZodMiniString<string>;
+                src: z.ZodMiniString<string>;
+                type: z.ZodMiniLiteral<"panel">;
+              },
+              z.core.$strip
+            >,
+          ],
+          "type"
+        >
+      >
+    >;
+  },
+  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
+ */
+export declare interface DefineAppResult extends DefineAppInput {
+  readonly [WORKBENCH_APP]: true;
+}
+
+/**
+ * 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,
+> {
+  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;
+}
+
+/**
+ * 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";
+}>;
+
+/**
+ * Every supported interface type — the first argument to `unstable_defineView`.
+ * The build's component registry (`VIEW_COMPONENTS`, which expands a view into
+ * one render artifact per component) ships with the vite plugin.
+ * @public
+ */
+export declare type InterfaceType = "panel";
+
+/**
+ * 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.
+ * @public
+ */
+export declare interface PanelViewComponents {
+  panel: ViewComponent<PanelViewProps>;
+  title: ViewComponent<PanelViewProps>;
+}
+
+/**
+ * Props a panel component receives: its interface record, minus the
+ * service-assigned `id`/`deployment_id` a local dev server can't provide. Mirrors
+ * the `panel` record the workbench host renders from (the wire format owned by
+ * `@sanity/workbench`); drift is guarded by the stamped contract version.
+ * @public
+ */
+export declare type PanelViewProps = ViewComponentBaseProps<{
+  entry_point: string;
+  interface_type: "panel";
+  name: string;
+}>;
+
+/**
+ * Contract version stamped on every defined service. Lets the workbench host
+ * and the generated worker artifact evolve the service contract without
+ * breaking already-deployed services; bumped only on a breaking change.
+ * @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.
+ * @public
+ */
+export declare type ServiceCallback = (
+  context: ServiceContext,
+) => (() => void) | void;
+
+/** The callback shape each service type defines, keyed by type. */
+declare interface ServiceCallbacksByType {
+  worker: ServiceCallback;
+}
+
+/**
+ * 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 interface ServiceContext {
+  readonly service: ServiceInfo;
+}
+
+/**
+ * The service's own declaration, surfaced to the callback.
+ * @public
+ */
+export declare interface ServiceInfo {
+  readonly name: string;
+  readonly type: string;
+}
+
+/**
+ * Every supported service type — the first argument to `unstable_defineService`.
+ * Add a service type by adding its declaration schema below and registering it
+ * here.
+ * @public
+ */
+export declare type ServiceType = "worker";
+
+/**
+ * Declare a Sanity Workbench application. Identity at runtime — returns the same
+ * object reference, tagged with the workbench brand. Field validation (the
+ * `name` 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;
+
+/**
+ * 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.
+ * @public
+ */
+export declare function unstable_defineView<TType extends InterfaceType>(
+  type: TType,
+  components: ViewComponentsByType[TType],
+): DefinedView<TType>;
+
+/**
+ * Contract version stamped on every defined view — lets the host and the
+ * generated artifact evolve the contract without breaking deployed views.
+ * @internal
+ */
+declare const VIEW_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
+ */
+declare type ViewComponent<TProps> = (props: TProps) => unknown;
+
+/**
+ * Props every view component receives, whatever its type. Per-type props
+ * compose from this, so a prop added here reaches every view.
+ * @public
+ */
+declare interface ViewComponentBaseProps<TView> {
+  view: TView;
+}
+
+/**
+ * The components each interface type exposes, keyed by type.
+ * @public
+ */
+export declare interface ViewComponentsByType {
+  panel: PanelViewComponents;
+}
+
+/**
+ * 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;
+
+export {};

package/dist/_exports/_internal/federation.js

@@ -0,0 +1,15 @@
+// Browser-safe module-federation extension API — the canonical source for the
+// `unstable_define*` authoring helpers and their contract. Lives in
+// `@sanity/cli-build` (alongside the vite plugin that consumes the same
+// contract) so there is a single source of truth; `@sanity/cli` re-exports it on
+// its public `.` and `/runtime` entries (→ `sanity/cli` and `sanity`).
+//
+// This entry's module graph is zod-only — no `node:*`, no `@sanity/cli-core`, no
+// vite — so `@sanity/cli/runtime` re-exporting it stays browser-safe under
+// per-entry resolution, exactly as the Node-only `./vite` and `./_internal/*`
+// entries don't leak into it.
+export { unstable_defineApp } from '../../workbench/defineApp.js';
+export { unstable_defineService } from '../../workbench/defineService.js';
+export { unstable_defineView } from '../../workbench/defineView.js';
+
+//# sourceMappingURL=federation.js.map

package/dist/_exports/_internal/federation.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/_exports/_internal/federation.ts"],"sourcesContent":["// Browser-safe module-federation extension API — the canonical source for the\n// `unstable_define*` authoring helpers and their contract. Lives in\n// `@sanity/cli-build` (alongside the vite plugin that consumes the same\n// contract) so there is a single source of truth; `@sanity/cli` re-exports it on\n// its public `.` and `/runtime` entries (→ `sanity/cli` and `sanity`).\n//\n// This entry's module graph is zod-only — no `node:*`, no `@sanity/cli-core`, no\n// vite — so `@sanity/cli/runtime` re-exporting it stays browser-safe under\n// per-entry resolution, exactly as the Node-only `./vite` and `./_internal/*`\n// entries don't leak into it.\nexport type {InterfaceType, ServiceType} from '../../workbench/contract.js'\nexport {unstable_defineApp} from '../../workbench/defineApp.js'\nexport type {DefineAppInput, DefineAppResult, DockGroup} from '../../workbench/defineApp.js'\nexport {unstable_defineService} from '../../workbench/defineService.js'\nexport type {\n  DefinedService,\n  ServiceCallback,\n  ServiceContext,\n  ServiceInfo,\n} from '../../workbench/defineService.js'\nexport {unstable_defineView} from '../../workbench/defineView.js'\nexport type {\n  DefinedView,\n  PanelComponent,\n  PanelViewComponents,\n  PanelViewProps,\n  ViewComponentsByType,\n} from '../../workbench/defineView.js'\n"],"names":["unstable_defineApp","unstable_defineService","unstable_defineView"],"mappings":"AAAA,8EAA8E;AAC9E,oEAAoE;AACpE,wEAAwE;AACxE,iFAAiF;AACjF,uEAAuE;AACvE,EAAE;AACF,iFAAiF;AACjF,2EAA2E;AAC3E,8EAA8E;AAC9E,8BAA8B;AAE9B,SAAQA,kBAAkB,QAAO,+BAA8B;AAE/D,SAAQC,sBAAsB,QAAO,mCAAkC;AAOvE,SAAQC,mBAAmB,QAAO,gCAA+B"}

package/dist/workbench/contract.js

@@ -0,0 +1,55 @@
+import { z } from 'zod/mini';
+// The shared kernel of the module-federation extension contract: the supported
+// view/service types, the contract versions the helpers stamp, and the
+// declaration schemas an app author writes in `unstable_defineApp({views, services})`.
+//
+// Lives in `@sanity/cli-build` (alongside the vite plugin that consumes the same
+// contract) so there is a single source of truth. `zod/mini` is used throughout
+// cli-build to keep bundles small.
+/**
+ * Contract version stamped on every defined view — lets the host and the
+ * generated artifact evolve the contract without breaking deployed views.
+ * @internal
+ */ export const VIEW_CONTRACT_VERSION = 1;
+/**
+ * Contract version stamped on every defined service. Lets the workbench host
+ * and the generated worker artifact evolve the service contract without
+ * breaking already-deployed services; bumped only on a breaking change.
+ * @internal
+ */ export const SERVICE_CONTRACT_VERSION = 1;
+/**
+ * Fields every extension declaration shares — a view or a service. The shape is
+ * identical (`name` + `src`); `kind` only tailors the validation message. Each
+ * declaration adds its `type` discriminator on top.
+ */ function extensionDeclarationFields(kind) {
+    const pattern = /^[a-zA-Z0-9_-]+$/;
+    return {
+        name: z.string().check(z.regex(pattern, `${kind} \`name\` must match ${pattern}`)),
+        src: z.string()
+    };
+}
+/** What an author writes for a `panel` in `unstable_defineApp({views})`. */ const PanelViewSchema = z.object({
+    type: z.literal('panel'),
+    ...extensionDeclarationFields('View')
+});
+/**
+ * The `{type, name, src}` an app declares for a view, discriminated by `type`.
+ * Persisted to the application service on deploy; never part of the app manifest.
+ * @internal
+ */ export const InterfaceDeclarationSchema = z.discriminatedUnion('type', [
+    PanelViewSchema
+]);
+/** Declaration schema for a `worker` service — what a developer writes in `unstable_defineApp({services})`. */ const WorkerServiceSchema = z.object({
+    type: z.literal('worker'),
+    ...extensionDeclarationFields('Service')
+});
+/**
+ * A service declared on an app, discriminated by `type`. Metadata only; built
+ * into a worker artifact and persisted to the application service on deploy,
+ * never part of the app manifest.
+ * @internal
+ */ export const ServiceDeclarationSchema = z.discriminatedUnion('type', [
+    WorkerServiceSchema
+]);
+
+//# sourceMappingURL=contract.js.map

package/dist/workbench/contract.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/workbench/contract.ts"],"sourcesContent":["import {z} from 'zod/mini'\n\n// The shared kernel of the module-federation extension contract: the supported\n// view/service types, the contract versions the helpers stamp, and the\n// declaration schemas an app author writes in `unstable_defineApp({views, services})`.\n//\n// Lives in `@sanity/cli-build` (alongside the vite plugin that consumes the same\n// contract) so there is a single source of truth. `zod/mini` is used throughout\n// cli-build to keep bundles small.\n\n/**\n * Contract version stamped on every defined view — lets the host and the\n * generated artifact evolve the contract without breaking deployed views.\n * @internal\n */\nexport const VIEW_CONTRACT_VERSION = 1\n\n/**\n * Contract version stamped on every defined service. Lets the workbench host\n * and the generated worker artifact evolve the service contract without\n * breaking already-deployed services; bumped only on a breaking change.\n * @internal\n */\nexport const SERVICE_CONTRACT_VERSION = 1\n\n/**\n * A view component. The return is opaque so the runtime helpers carry no React\n * dependency — the generated artifact renders it with the app's own React.\n * @public\n */\nexport type ViewComponent<TProps> = (props: TProps) => unknown\n\n/**\n * Props every view component receives, whatever its type. Per-type props\n * compose from this, so a prop added here reaches every view.\n * @public\n */\nexport interface ViewComponentBaseProps<TView> {\n  view: TView\n}\n\n/**\n * Every supported interface type — the first argument to `unstable_defineView`.\n * The build's component registry (`VIEW_COMPONENTS`, which expands a view into\n * one render artifact per component) ships with the vite plugin.\n * @public\n */\nexport type InterfaceType = 'panel'\n\n/**\n * Every supported service type — the first argument to `unstable_defineService`.\n * Add a service type by adding its declaration schema below and registering it\n * here.\n * @public\n */\nexport type ServiceType = 'worker'\n\n/**\n * Fields every extension declaration shares — a view or a service. The shape is\n * identical (`name` + `src`); `kind` only tailors the validation message. Each\n * declaration adds its `type` discriminator on top.\n */\nfunction extensionDeclarationFields(kind: 'Service' | 'View') {\n  const pattern = /^[a-zA-Z0-9_-]+$/\n  return {\n    name: z.string().check(z.regex(pattern, `${kind} \\`name\\` must match ${pattern}`)),\n    src: z.string(),\n  }\n}\n\n/** What an author writes for a `panel` in `unstable_defineApp({views})`. */\nconst PanelViewSchema = z.object({\n  type: z.literal('panel'),\n  ...extensionDeclarationFields('View'),\n})\n\n/**\n * The `{type, name, src}` an app declares for a view, discriminated by `type`.\n * Persisted to the application service on deploy; never part of the app manifest.\n * @internal\n */\nexport const InterfaceDeclarationSchema = z.discriminatedUnion('type', [PanelViewSchema])\n\n/** Declaration schema for a `worker` service — what a developer writes in `unstable_defineApp({services})`. */\nconst WorkerServiceSchema = z.object({\n  type: z.literal('worker'),\n  ...extensionDeclarationFields('Service'),\n})\n\n/**\n * A service declared on an app, discriminated by `type`. Metadata only; built\n * into a worker artifact and persisted to the application service on deploy,\n * never part of the app manifest.\n * @internal\n */\nexport const ServiceDeclarationSchema = z.discriminatedUnion('type', [WorkerServiceSchema])\n"],"names":["z","VIEW_CONTRACT_VERSION","SERVICE_CONTRACT_VERSION","extensionDeclarationFields","kind","pattern","name","string","check","regex","src","PanelViewSchema","object","type","literal","InterfaceDeclarationSchema","discriminatedUnion","WorkerServiceSchema","ServiceDeclarationSchema"],"mappings":"AAAA,SAAQA,CAAC,QAAO,WAAU;AAE1B,+EAA+E;AAC/E,uEAAuE;AACvE,uFAAuF;AACvF,EAAE;AACF,iFAAiF;AACjF,gFAAgF;AAChF,mCAAmC;AAEnC;;;;CAIC,GACD,OAAO,MAAMC,wBAAwB,EAAC;AAEtC;;;;;CAKC,GACD,OAAO,MAAMC,2BAA2B,EAAC;AAkCzC;;;;CAIC,GACD,SAASC,2BAA2BC,IAAwB;IAC1D,MAAMC,UAAU;IAChB,OAAO;QACLC,MAAMN,EAAEO,MAAM,GAAGC,KAAK,CAACR,EAAES,KAAK,CAACJ,SAAS,GAAGD,KAAK,qBAAqB,EAAEC,SAAS;QAChFK,KAAKV,EAAEO,MAAM;IACf;AACF;AAEA,0EAA0E,GAC1E,MAAMI,kBAAkBX,EAAEY,MAAM,CAAC;IAC/BC,MAAMb,EAAEc,OAAO,CAAC;IAChB,GAAGX,2BAA2B,OAAO;AACvC;AAEA;;;;CAIC,GACD,OAAO,MAAMY,6BAA6Bf,EAAEgB,kBAAkB,CAAC,QAAQ;IAACL;CAAgB,EAAC;AAEzF,6GAA6G,GAC7G,MAAMM,sBAAsBjB,EAAEY,MAAM,CAAC;IACnCC,MAAMb,EAAEc,OAAO,CAAC;IAChB,GAAGX,2BAA2B,UAAU;AAC1C;AAEA;;;;;CAKC,GACD,OAAO,MAAMe,2BAA2BlB,EAAEgB,kBAAkB,CAAC,QAAQ;IAACC;CAAoB,EAAC"}

package/dist/workbench/defineApp.js

@@ -0,0 +1,83 @@
+import { z } from 'zod/mini';
+import { InterfaceDeclarationSchema, ServiceDeclarationSchema } from './contract.js';
+/** Allowed characters for an app `name`. */ const APP_NAME_PATTERN = /^[a-zA-Z0-9_-]+$/;
+/**
+ * Internal application discriminator. Sanity-owned singleton apps only;
+ * validated by the schema but excluded from the public `DefineAppInput` type.
+ */ const ApplicationType = z.enum([
+    'coreApp',
+    'studio',
+    'canvas',
+    'dashboard',
+    'media-library',
+    'system'
+]);
+/** Dock groups an app can place itself into. */ const DockGroupSchema = z.enum([
+    'dock.system',
+    'dock.applications',
+    'dock.user'
+]);
+/**
+ * Runtime-validation schema for `unstable_defineApp`. Validates the full shape
+ * including the internal `applicationType`; the user-facing `DefineAppInput`
+ * type below omits that field.
+ * @internal
+ */ export const DefineAppInputSchema = z.object({
+    /**
+     * Internal — Sanity-owned singleton apps only. Validated here but excluded
+     * from the public `DefineAppInput` type.
+     * @internal
+     */ applicationType: z.optional(ApplicationType),
+    /**
+     * App entrypoint module. Defaults to `./src/App.tsx` when omitted. The build
+     * derives the app's navigable `app` view from it. SDK apps only — setting it
+     * on a studio is rejected (studio app views are not yet implemented).
+     */ entry: z.optional(z.string()),
+    /** Dock group to render in. Defaults to `dock.applications` when omitted. */ group: z.optional(DockGroupSchema),
+    /** Optional icon override (path to an SVG). Wins over manifest/studio icon. */ icon: z.optional(z.string()),
+    /** Unique app identifier — matches `/^[a-zA-Z0-9_-]+$/`. */ name: z.string().check(z.regex(APP_NAME_PATTERN, 'App `name` must match /^[a-zA-Z0-9_-]+$/')),
+    /** Organization that owns the app — required to run and deploy an SDK app. */ organizationId: z.optional(z.string()),
+    /** Sort position within the group, ascending. Defaults to `100` when omitted. */ priority: z.optional(z.number()),
+    /**
+     * Background services the app runs (e.g. a `worker` emitting dock badges).
+     * Metadata only — built into worker artifacts and persisted to the
+     * application service on deploy, not into the app manifest. Service `name`s
+     * must be unique within the app.
+     */ services: z.optional(z.array(ServiceDeclarationSchema).check(z.refine((services)=>new Set(services.map((service)=>service.name)).size === services.length, 'Service `name` must be unique within an app'))),
+    /** User-facing app title. Wins over studio.config.ts title on merge. */ title: z.string(),
+    /**
+     * Views the app exposes (e.g. dock panels). Metadata only — built into
+     * render artifacts and persisted to the application service on deploy, not
+     * into the app manifest. View `name`s must be unique within the app.
+     */ views: z.optional(z.array(InterfaceDeclarationSchema).check(z.refine((views)=>new Set(views.map((view)=>view.name)).size === views.length, 'View `name` must be unique within an app')))
+}).check(// Studio app views are not implemented yet. A studio that declares `entry`
+// (the SDK app-view entrypoint) is rejected here rather than silently
+// generating one; studios keep navigating via their existing render path.
+z.refine((input)=>!(input.applicationType === 'studio' && input.entry !== undefined), {
+    error: 'App views for studios are not implemented yet',
+    path: [
+        'entry'
+    ]
+}));
+/**
+ * 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.
+ */ const WORKBENCH_APP = Symbol.for('sanity.workbench.defineApp');
+/**
+ * Declare a Sanity Workbench application. Identity at runtime — returns the same
+ * object reference, tagged with the workbench brand. Field validation (the
+ * `name` pattern etc.) runs at build time in the CLI via `DefineAppInputSchema`;
+ * this helper stays a thin, pure identity wrapper.
+ * @public
+ */ export function unstable_defineApp(input) {
+    return Object.defineProperty(input, WORKBENCH_APP, {
+        configurable: false,
+        enumerable: false,
+        value: true,
+        writable: false
+    });
+}
+
+//# sourceMappingURL=defineApp.js.map

package/dist/workbench/defineApp.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/workbench/defineApp.ts"],"sourcesContent":["import {z} from 'zod/mini'\n\nimport {InterfaceDeclarationSchema, ServiceDeclarationSchema} from './contract.js'\n\n/** Allowed characters for an app `name`. */\nconst APP_NAME_PATTERN = /^[a-zA-Z0-9_-]+$/\n\n/**\n * Internal application discriminator. Sanity-owned singleton apps only;\n * validated by the schema but excluded from the public `DefineAppInput` type.\n */\nconst ApplicationType = z.enum([\n  'coreApp',\n  'studio',\n  'canvas',\n  'dashboard',\n  'media-library',\n  'system',\n])\n\n/** Dock groups an app can place itself into. */\nconst DockGroupSchema = z.enum(['dock.system', 'dock.applications', 'dock.user'])\n\n/**\n * Dock group identifier. The API does not block a user app from declaring a\n * reserved group (e.g. `dock.system`); priority conventions keep Sanity-owned\n * apps ahead.\n * @public\n */\nexport type DockGroup = z.output<typeof DockGroupSchema>\n\n/**\n * Runtime-validation schema for `unstable_defineApp`. Validates the full shape\n * including the internal `applicationType`; the user-facing `DefineAppInput`\n * type below omits that field.\n * @internal\n */\nexport const DefineAppInputSchema = z\n  .object({\n    /**\n     * Internal — Sanity-owned singleton apps only. Validated here but excluded\n     * from the public `DefineAppInput` type.\n     * @internal\n     */\n    applicationType: z.optional(ApplicationType),\n    /**\n     * App entrypoint module. Defaults to `./src/App.tsx` when omitted. The build\n     * derives the app's navigable `app` view from it. SDK apps only — setting it\n     * on a studio is rejected (studio app views are not yet implemented).\n     */\n    entry: z.optional(z.string()),\n    /** Dock group to render in. Defaults to `dock.applications` when omitted. */\n    group: z.optional(DockGroupSchema),\n    /** Optional icon override (path to an SVG). Wins over manifest/studio icon. */\n    icon: z.optional(z.string()),\n    /** Unique app identifier — matches `/^[a-zA-Z0-9_-]+$/`. */\n    name: z.string().check(z.regex(APP_NAME_PATTERN, 'App `name` must match /^[a-zA-Z0-9_-]+$/')),\n    /** Organization that owns the app — required to run and deploy an SDK app. */\n    organizationId: z.optional(z.string()),\n    /** Sort position within the group, ascending. Defaults to `100` when omitted. */\n    priority: z.optional(z.number()),\n    /**\n     * Background services the app runs (e.g. a `worker` emitting dock badges).\n     * Metadata only — built into worker artifacts and persisted to the\n     * application service on deploy, not into the app manifest. Service `name`s\n     * must be unique within the app.\n     */\n    services: z.optional(\n      z\n        .array(ServiceDeclarationSchema)\n        .check(\n          z.refine(\n            (services) => new Set(services.map((service) => service.name)).size === services.length,\n            'Service `name` must be unique within an app',\n          ),\n        ),\n    ),\n    /** User-facing app title. Wins over studio.config.ts title on merge. */\n    title: z.string(),\n    /**\n     * Views the app exposes (e.g. dock panels). Metadata only — built into\n     * render artifacts and persisted to the application service on deploy, not\n     * into the app manifest. View `name`s must be unique within the app.\n     */\n    views: z.optional(\n      z\n        .array(InterfaceDeclarationSchema)\n        .check(\n          z.refine(\n            (views) => new Set(views.map((view) => view.name)).size === views.length,\n            'View `name` must be unique within an app',\n          ),\n        ),\n    ),\n  })\n  .check(\n    // Studio app views are not implemented yet. A studio that declares `entry`\n    // (the SDK app-view entrypoint) is rejected here rather than silently\n    // generating one; studios keep navigating via their existing render path.\n    z.refine((input) => !(input.applicationType === 'studio' && input.entry !== undefined), {\n      error: 'App views for studios are not implemented yet',\n      path: ['entry'],\n    }),\n  )\n\n/**\n * User-facing input for `unstable_defineApp`. Excludes the internal\n * `applicationType` — that field is validated by the schema but is not part of\n * the public surface (Sanity-owned apps set it via `@ts-expect-error`).\n * @public\n */\nexport type DefineAppInput = Omit<z.output<typeof DefineAppInputSchema>, 'applicationType'>\n\n/**\n * Nominal brand the CLI discriminates on to enable the workbench build/deploy\n * codepath. Registered via `Symbol.for` so the marker survives module-realm\n * boundaries — `@sanity/cli-core` re-derives the same global symbol with\n * `Symbol.for` rather than importing it, so it stays internal to this module.\n */\nconst WORKBENCH_APP: unique symbol = Symbol.for('sanity.workbench.defineApp')\n\n/**\n * The branded result of `unstable_defineApp`. Carries the same fields as the\n * input plus the internal brand — users only ever see `DefineAppInput`.\n * @public\n */\nexport interface DefineAppResult extends DefineAppInput {\n  readonly [WORKBENCH_APP]: true\n}\n\n/**\n * Declare a Sanity Workbench application. Identity at runtime — returns the same\n * object reference, tagged with the workbench brand. Field validation (the\n * `name` pattern etc.) runs at build time in the CLI via `DefineAppInputSchema`;\n * this helper stays a thin, pure identity wrapper.\n * @public\n */\nexport function unstable_defineApp(input: DefineAppInput): DefineAppResult {\n  return Object.defineProperty(input, WORKBENCH_APP, {\n    configurable: false,\n    enumerable: false,\n    value: true,\n    writable: false,\n  }) as DefineAppResult\n}\n"],"names":["z","InterfaceDeclarationSchema","ServiceDeclarationSchema","APP_NAME_PATTERN","ApplicationType","enum","DockGroupSchema","DefineAppInputSchema","object","applicationType","optional","entry","string","group","icon","name","check","regex","organizationId","priority","number","services","array","refine","Set","map","service","size","length","title","views","view","input","undefined","error","path","WORKBENCH_APP","Symbol","for","unstable_defineApp","Object","defineProperty","configurable","enumerable","value","writable"],"mappings":"AAAA,SAAQA,CAAC,QAAO,WAAU;AAE1B,SAAQC,0BAA0B,EAAEC,wBAAwB,QAAO,gBAAe;AAElF,0CAA0C,GAC1C,MAAMC,mBAAmB;AAEzB;;;CAGC,GACD,MAAMC,kBAAkBJ,EAAEK,IAAI,CAAC;IAC7B;IACA;IACA;IACA;IACA;IACA;CACD;AAED,8CAA8C,GAC9C,MAAMC,kBAAkBN,EAAEK,IAAI,CAAC;IAAC;IAAe;IAAqB;CAAY;AAUhF;;;;;CAKC,GACD,OAAO,MAAME,uBAAuBP,EACjCQ,MAAM,CAAC;IACN;;;;KAIC,GACDC,iBAAiBT,EAAEU,QAAQ,CAACN;IAC5B;;;;KAIC,GACDO,OAAOX,EAAEU,QAAQ,CAACV,EAAEY,MAAM;IAC1B,2EAA2E,GAC3EC,OAAOb,EAAEU,QAAQ,CAACJ;IAClB,6EAA6E,GAC7EQ,MAAMd,EAAEU,QAAQ,CAACV,EAAEY,MAAM;IACzB,0DAA0D,GAC1DG,MAAMf,EAAEY,MAAM,GAAGI,KAAK,CAAChB,EAAEiB,KAAK,CAACd,kBAAkB;IACjD,4EAA4E,GAC5Ee,gBAAgBlB,EAAEU,QAAQ,CAACV,EAAEY,MAAM;IACnC,+EAA+E,GAC/EO,UAAUnB,EAAEU,QAAQ,CAACV,EAAEoB,MAAM;IAC7B;;;;;KAKC,GACDC,UAAUrB,EAAEU,QAAQ,CAClBV,EACGsB,KAAK,CAACpB,0BACNc,KAAK,CACJhB,EAAEuB,MAAM,CACN,CAACF,WAAa,IAAIG,IAAIH,SAASI,GAAG,CAAC,CAACC,UAAYA,QAAQX,IAAI,GAAGY,IAAI,KAAKN,SAASO,MAAM,EACvF;IAIR,sEAAsE,GACtEC,OAAO7B,EAAEY,MAAM;IACf;;;;KAIC,GACDkB,OAAO9B,EAAEU,QAAQ,CACfV,EACGsB,KAAK,CAACrB,4BACNe,KAAK,CACJhB,EAAEuB,MAAM,CACN,CAACO,QAAU,IAAIN,IAAIM,MAAML,GAAG,CAAC,CAACM,OAASA,KAAKhB,IAAI,GAAGY,IAAI,KAAKG,MAAMF,MAAM,EACxE;AAIV,GACCZ,KAAK,CACJ,2EAA2E;AAC3E,sEAAsE;AACtE,0EAA0E;AAC1EhB,EAAEuB,MAAM,CAAC,CAACS,QAAU,CAAEA,CAAAA,MAAMvB,eAAe,KAAK,YAAYuB,MAAMrB,KAAK,KAAKsB,SAAQ,GAAI;IACtFC,OAAO;IACPC,MAAM;QAAC;KAAQ;AACjB,IACD;AAUH;;;;;CAKC,GACD,MAAMC,gBAA+BC,OAAOC,GAAG,CAAC;AAWhD;;;;;;CAMC,GACD,OAAO,SAASC,mBAAmBP,KAAqB;IACtD,OAAOQ,OAAOC,cAAc,CAACT,OAAOI,eAAe;QACjDM,cAAc;QACdC,YAAY;QACZC,OAAO;QACPC,UAAU;IACZ;AACF"}

package/dist/workbench/defineService.js

@@ -0,0 +1,19 @@
+import { SERVICE_CONTRACT_VERSION } from './contract.js';
+/**
+ * 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 function unstable_defineService(type, run) {
+    return {
+        run,
+        type,
+        version: SERVICE_CONTRACT_VERSION
+    };
+}
+
+//# sourceMappingURL=defineService.js.map

package/dist/workbench/defineService.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/workbench/defineService.ts"],"sourcesContent":["import {SERVICE_CONTRACT_VERSION, type ServiceType} from './contract.js'\n\n/**\n * The service's own declaration, surfaced to the callback.\n * @public\n */\nexport interface ServiceInfo {\n  readonly name: string\n  readonly type: string\n}\n\n/**\n * Context every service callback receives when its worker starts. Mirrors how a\n * view component receives its `view` — the service receives its own `service`.\n * @public\n */\nexport interface ServiceContext {\n  readonly service: ServiceInfo\n}\n\n/**\n * A service callback. Runs once inside the worker on start; returns an optional\n * disposer the host calls before terminating the worker.\n * @public\n */\nexport type ServiceCallback = (context: ServiceContext) => (() => void) | void\n\n/** The callback shape each service type defines, keyed by type. */\ninterface ServiceCallbacksByType {\n  worker: ServiceCallback\n}\n\n/**\n * The result of `unstable_defineService`: the author's callback, the service\n * type, and the internal contract version the worker artifact targets.\n * @public\n */\nexport interface DefinedService<TType extends ServiceType = ServiceType> {\n  readonly run: ServiceCallbacksByType[TType]\n  readonly type: TType\n  /** @internal */\n  readonly version: typeof SERVICE_CONTRACT_VERSION\n}\n\n/**\n * Define a Sanity Workbench background service. The first argument narrows the\n * callback shape — `\"worker\"` runs the callback inside a Web Worker, where it\n * can emit dock-badge updates and return a disposer.\n *\n * Identity at runtime: returns the callback tagged with its type and the contract\n * version, for the CLI build to generate a worker artifact from. Used as the\n * default export of a service's `src` file.\n * @public\n */\nexport function unstable_defineService<TType extends ServiceType>(\n  type: TType,\n  run: ServiceCallbacksByType[TType],\n): DefinedService<TType> {\n  return {run, type, version: SERVICE_CONTRACT_VERSION}\n}\n"],"names":["SERVICE_CONTRACT_VERSION","unstable_defineService","type","run","version"],"mappings":"AAAA,SAAQA,wBAAwB,QAAyB,gBAAe;AA4CxE;;;;;;;;;CASC,GACD,OAAO,SAASC,uBACdC,IAAW,EACXC,GAAkC;IAElC,OAAO;QAACA;QAAKD;QAAME,SAASJ;IAAwB;AACtD"}

package/dist/workbench/defineView.js

@@ -0,0 +1,19 @@
+import { VIEW_CONTRACT_VERSION } from './contract.js';
+/**
+ * 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 function unstable_defineView(type, components) {
+    return {
+        components,
+        type,
+        version: VIEW_CONTRACT_VERSION
+    };
+}
+
+//# sourceMappingURL=defineView.js.map

package/dist/workbench/defineView.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/workbench/defineView.ts"],"sourcesContent":["import {\n  type InterfaceType,\n  VIEW_CONTRACT_VERSION,\n  type ViewComponent,\n  type ViewComponentBaseProps,\n} from './contract.js'\n\n/**\n * Props a panel component receives: its interface record, minus the\n * service-assigned `id`/`deployment_id` a local dev server can't provide. Mirrors\n * the `panel` record the workbench host renders from (the wire format owned by\n * `@sanity/workbench`); drift is guarded by the stamped contract version.\n * @public\n */\nexport type PanelViewProps = ViewComponentBaseProps<{\n  entry_point: string\n  interface_type: 'panel'\n  name: string\n}>\n\n/**\n * The component slots a `panel` view exposes — each its own module-federation\n * island, typed with the panel props.\n * @public\n */\nexport interface PanelViewComponents {\n  panel: ViewComponent<PanelViewProps>\n  title: ViewComponent<PanelViewProps>\n}\n\n/**\n * A panel's view-component slot — the module-federation expose for one island.\n * @public\n */\nexport type PanelComponent = keyof PanelViewComponents\n\n/**\n * The components each interface type exposes, keyed by type.\n * @public\n */\nexport interface ViewComponentsByType {\n  panel: PanelViewComponents\n}\n\n/**\n * The result of `unstable_defineView`: the author's component(s), the view type,\n * and the internal contract version the build artifact targets.\n * @public\n */\nexport interface DefinedView<TType extends InterfaceType = InterfaceType> {\n  readonly components: ViewComponentsByType[TType]\n  readonly type: TType\n  /** @internal */\n  readonly version: typeof VIEW_CONTRACT_VERSION\n}\n\n/**\n * Define a Sanity Workbench view. The first argument narrows the component shape\n * and the props each component receives — `\"panel\"` yields a `{title, panel}`\n * record whose components are typed with the panel props.\n *\n * Returns the component(s) tagged with their type and the contract version, for\n * the CLI build to generate render artifacts from. Used as the default export of\n * a view's `src` file.\n * @public\n */\nexport function unstable_defineView<TType extends InterfaceType>(\n  type: TType,\n  components: ViewComponentsByType[TType],\n): DefinedView<TType> {\n  return {components, type, version: VIEW_CONTRACT_VERSION}\n}\n"],"names":["VIEW_CONTRACT_VERSION","unstable_defineView","type","components","version"],"mappings":"AAAA,SAEEA,qBAAqB,QAGhB,gBAAe;AAmDtB;;;;;;;;;CASC,GACD,OAAO,SAASC,oBACdC,IAAW,EACXC,UAAuC;IAEvC,OAAO;QAACA;QAAYD;QAAME,SAASJ;IAAqB;AAC1D"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/cli-build",
-  "version": "0.0.0-20260612071721",
+  "version": "0.0.0-20260612074408",
   "description": "Internal Sanity package for building studios and apps",
   "keywords": [
     "cli",
@@ -36,6 +36,10 @@
       "source": "./src/_exports/_internal/extract.ts",
       "default": "./dist/_exports/_internal/extract.js"
     },
+    "./_internal/federation": {
+      "source": "./src/_exports/_internal/federation.ts",
+      "default": "./dist/_exports/_internal/federation.js"
+    },
     "./package.json": "./package.json"
   },
   "publishConfig": {
@@ -62,7 +66,7 @@
     "semver": "^7.8.1",
     "vite": "^8.0.16",
     "zod": "^4.4.3",
-    "@sanity/cli-core": "^0.0.0-20260612071721"
+    "@sanity/cli-core": "^0.0.0-20260612074408"
   },
   "devDependencies": {
     "@eslint/compat": "^2.1.0",
@@ -89,7 +93,7 @@
     "vitest": "^4.1.8",
     "@repo/package.config": "0.0.1",
     "@repo/tsconfig": "3.70.0",
-    "@sanity/cli-test": "0.0.0-20260612071721",
+    "@sanity/cli-test": "0.0.0-20260612074408",
     "@sanity/eslint-config-cli": "^1.1.2"
   },
   "peerDependencies": {