@sanity/workbench 0.1.0-alpha.1 → 0.1.0-alpha.10

package/src/core/user-applications/user-application.ts

@@ -0,0 +1,181 @@
+// eslint-disable-next-line no-restricted-imports
+import type { Resource as ProtocolResource } from "@sanity/message-protocol";
+import { z } from "zod";
+
+import {
+  AbstractApplication,
+  type AbstractApplicationType,
+} from "../applications/application";
+import type { CoreAppUserApplicationManifest } from "./core-app";
+import type { ClientManifest } from "./studios/schemas";
+
+/**
+ * User application ID schema, branded for type safety.
+ * @public
+ */
+export const UserApplicationId = z
+  .string()
+  .nonempty()
+  .brand("UserApplicationId");
+
+/**
+ * User application ID type, branded for type safety.
+ * @public
+ */
+export type UserApplicationId = z.output<typeof UserApplicationId>;
+
+/**
+ * Validates and brands a string as a UserApplicationId.
+ * @public
+ */
+export function brandUserApplicationId(id: string): UserApplicationId {
+  return UserApplicationId.parse(id);
+}
+
+const LocalUserApplicationBase = z.object({
+  host: z.string(),
+  port: z.number(),
+  /** The `deployment.appId` from the application's `sanity.cli.ts`, when set. */
+  id: z.string().optional(),
+});
+
+/**
+ * Raw data for a local application discovered by the CLI dev server.
+ *
+ * The CLI forwards the full studio or app manifest so the workbench can
+ * derive icons, titles, workspaces and schema references the same way it
+ * does for deployed applications. The manifest shape is discriminated on
+ * `type`: studios receive a `ClientManifest`, core apps a `CoreAppUserApplicationManifest`.
+ *
+ * When set on a `UserApplication`, `isLocal` is `true` and `url`/`isFederated`
+ * honour the local dev-server instead of the deployed application's host.
+ *
+ * @public
+ */
+export const LocalUserApplication = z.discriminatedUnion("type", [
+  LocalUserApplicationBase.extend({
+    type: z.literal("studio"),
+    manifest: z.custom<ClientManifest>().optional(),
+  }),
+  LocalUserApplicationBase.extend({
+    type: z.literal("coreApp"),
+    manifest: z.custom<CoreAppUserApplicationManifest>().optional(),
+  }),
+]);
+
+/**
+ * @public
+ */
+export type LocalUserApplication = z.output<typeof LocalUserApplication>;
+
+/**
+ * @public
+ */
+export const UserApplicationBase = z.object({
+  id: UserApplicationId,
+  appHost: z.string(),
+  urlType: z.enum(["internal", "external"]),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+  dashboardStatus: z.enum(["default", "disabled"]),
+});
+
+/**
+ * @public
+ */
+export type UserApplicationBase = z.output<typeof UserApplicationBase>;
+
+/**
+ * @public
+ */
+export const ActiveDeployment = z.object({
+  id: z.string(),
+  version: z.string(),
+  isActiveDeployment: z.boolean(),
+  userApplicationId: z.string(),
+  isAutoUpdating: z.boolean(),
+  size: z.number(),
+  deployedAt: z.string(),
+  deployedBy: z.string(),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+});
+
+/**
+ * @public
+ */
+export abstract class UserApplication<
+  TUserApplication extends UserApplicationBase,
+  TType extends Extract<AbstractApplicationType, "coreApp" | "studio">,
+  TProtocolResource extends ProtocolResource = Extract<
+    ProtocolResource,
+    { type: TType }
+  >,
+> extends AbstractApplication<TType, TProtocolResource> {
+  readonly application: TUserApplication;
+
+  readonly id: UserApplicationId;
+
+  /**
+   * For local applications (`isLocal === true`), the deployed application
+   * that shares the same `id` — if one was passed at construction. `null`
+   * for deployed applications or when no remote twin was provided.
+   */
+  readonly remoteApplication: this | null;
+
+  readonly #isLocal: boolean;
+
+  constructor(
+    application: TUserApplication,
+    type: TType,
+    options: {
+      isLocal?: boolean;
+      remoteApplication?: UserApplication<
+        TUserApplication,
+        TType,
+        TProtocolResource
+      > | null;
+    } = {},
+  ) {
+    super(type);
+    this.application = application;
+    this.id = brandUserApplicationId(application.id);
+    this.#isLocal = options.isLocal ?? false;
+    this.remoteApplication =
+      (options.remoteApplication as this | undefined) ?? null;
+  }
+
+  abstract get subtitle(): string | undefined;
+
+  /**
+   * Local dev servers are rendered as federated remotes; deployed applications
+   * are rendered in an iframe.
+   */
+  get isFederated(): boolean {
+    return this.isLocal;
+  }
+
+  override get isLocal(): boolean {
+    return this.#isLocal;
+  }
+
+  /**
+   * @returns A fully resolved URL instance for the application.
+   * For internal applications, constructs a URL using the Sanity studio domain
+   * pattern resolved from the environment at the consuming app's build time.
+   * For external applications (including local dev servers), returns the
+   * provided app host as a URL.
+   */
+  get url(): URL {
+    if (this.application.urlType === "internal") {
+      if (import.meta.env.VITE_SANITY_ENV === "production") {
+        return new URL(`https://${this.application.appHost}.sanity.studio`);
+      }
+      return new URL(
+        `https://${this.application.appHost}.studio.${import.meta.env.VITE_SANITY_DOMAIN}`,
+      );
+    }
+
+    return new URL(this.application.appHost);
+  }
+}

package/src/vite-env.d.ts

@@ -0,0 +1,8 @@
+interface ImportMetaEnv {
+  readonly VITE_SANITY_ENV: "production" | "staging";
+  readonly VITE_SANITY_DOMAIN: "sanity.work" | "sanity.io";
+}
+
+interface ImportMeta {
+  readonly env: ImportMetaEnv;
+}

package/dist/_internal.cjs

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: !0 });
-var runtime = require("@sanity/federation/runtime");
-const REMOTE_NAME = "workbench-remote", REMOTE_MODULE = "./App";
-async function renderWorkbench(rootElement, config, options) {
-  if (!rootElement)
-    throw new Error("Missing root element to mount application into");
-  const remoteUrl = (void 0).SANITY_INTERNAL_WORKBENCH_REMOTE_URL;
-  if (!remoteUrl)
-    throw new Error("SANITY_INTERNAL_WORKBENCH_REMOTE_URL is not set");
-  const mf = runtime.createInstance({
-    name: "sanity-workbench"
-  });
-  mf.registerRemotes([
-    {
-      name: REMOTE_NAME,
-      entry: remoteUrl
-    }
-  ]);
-  let remoteModule;
-  try {
-    remoteModule = await mf.loadRemote(
-      `${REMOTE_NAME}/${REMOTE_MODULE}`
-    );
-  } catch (error) {
-    throw new Error(
-      `Failed to load remote workbench module from "${remoteUrl}"`,
-      { cause: error }
-    );
-  }
-  if (!remoteModule || typeof remoteModule.render != "function")
-    throw new Error(
-      `Remote module from "${remoteUrl}" did not expose a render function`
-    );
-  return remoteModule.render(rootElement, config, options);
-}
-exports.renderWorkbench = renderWorkbench;
-//# sourceMappingURL=_internal.cjs.map

package/dist/_internal.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"_internal.cjs","sources":["../src/_internal/render.ts"],"sourcesContent":["import { createInstance } from \"@sanity/federation/runtime\";\n\nconst REMOTE_NAME = \"workbench-remote\";\nconst REMOTE_MODULE = \"./App\";\n\n/**\n * @public\n */\nexport type Config = undefined;\n\n/**\n * @public\n */\nexport interface RenderWorkbenchOptions {\n  reactStrictMode?: boolean;\n}\n\ninterface RemoteModule {\n  render(\n    rootElement: HTMLElement,\n    config?: Config,\n    options?: RenderWorkbenchOptions,\n  ): () => void;\n}\n\n/**\n * Creates a Module Federation instance, loads a remote workbench\n * application, and renders it into the provided root element.\n *\n * @param rootElement - The DOM element to render into\n * @param config - Workbench configuration (reserved for future use)\n * @param options - Rendering options forwarded to the remote\n * @returns A cleanup function that unmounts the remote application\n *\n * @public\n */\nexport async function renderWorkbench(\n  rootElement: HTMLElement,\n  config?: Config,\n  options?: RenderWorkbenchOptions,\n): Promise<() => void> {\n  if (!rootElement) {\n    throw new Error(\"Missing root element to mount application into\");\n  }\n\n  const remoteUrl = import.meta.env.SANITY_INTERNAL_WORKBENCH_REMOTE_URL;\n  if (!remoteUrl) {\n    throw new Error(\"SANITY_INTERNAL_WORKBENCH_REMOTE_URL is not set\");\n  }\n\n  const mf = createInstance({\n    name: \"sanity-workbench\",\n  });\n\n  mf.registerRemotes([\n    {\n      name: REMOTE_NAME,\n      entry: remoteUrl,\n    },\n  ]);\n\n  let remoteModule: RemoteModule | null;\n  try {\n    remoteModule = await mf.loadRemote<RemoteModule>(\n      `${REMOTE_NAME}/${REMOTE_MODULE}`,\n    );\n  } catch (error) {\n    throw new Error(\n      `Failed to load remote workbench module from \"${remoteUrl}\"`,\n      { cause: error },\n    );\n  }\n\n  if (!remoteModule || typeof remoteModule.render !== \"function\") {\n    throw new Error(\n      `Remote module from \"${remoteUrl}\" did not expose a render function`,\n    );\n  }\n\n  return remoteModule.render(rootElement, config, options);\n}\n"],"names":["createInstance"],"mappings":";;;AAEA,MAAM,cAAc,oBACd,gBAAgB;AAiCtB,eAAsB,gBACpB,aACA,QACA,SACqB;AACrB,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,gDAAgD;AAGlE,QAAM,YAAY,SAAgB;AAClC,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,iDAAiD;AAGnE,QAAM,KAAKA,QAAAA,eAAe;AAAA,IACxB,MAAM;AAAA,EAAA,CACP;AAED,KAAG,gBAAgB;AAAA,IACjB;AAAA,MACE,MAAM;AAAA,MACN,OAAO;AAAA,IAAA;AAAA,EACT,CACD;AAED,MAAI;AACJ,MAAI;AACF,mBAAe,MAAM,GAAG;AAAA,MACtB,GAAG,WAAW,IAAI,aAAa;AAAA,IAAA;AAAA,EAEnC,SAAS,OAAO;AACd,UAAM,IAAI;AAAA,MACR,gDAAgD,SAAS;AAAA,MACzD,EAAE,OAAO,MAAA;AAAA,IAAM;AAAA,EAEnB;AAEA,MAAI,CAAC,gBAAgB,OAAO,aAAa,UAAW;AAClD,UAAM,IAAI;AAAA,MACR,uBAAuB,SAAS;AAAA,IAAA;AAIpC,SAAO,aAAa,OAAO,aAAa,QAAQ,OAAO;AACzD;;"}

package/dist/_internal.d.cts

@@ -1,30 +0,0 @@
-/**
- * @public
- */
-export declare type Config = undefined;
-
-/**
- * Creates a Module Federation instance, loads a remote workbench
- * application, and renders it into the provided root element.
- *
- * @param rootElement - The DOM element to render into
- * @param config - Workbench configuration (reserved for future use)
- * @param options - Rendering options forwarded to the remote
- * @returns A cleanup function that unmounts the remote application
- *
- * @public
- */
-export declare function renderWorkbench(
-  rootElement: HTMLElement,
-  config?: Config,
-  options?: RenderWorkbenchOptions,
-): Promise<() => void>;
-
-/**
- * @public
- */
-export declare interface RenderWorkbenchOptions {
-  reactStrictMode?: boolean;
-}
-
-export {};

package/src/env.d.ts

@@ -1,7 +0,0 @@
-interface ImportMetaEnv {
-  readonly SANITY_INTERNAL_WORKBENCH_REMOTE_URL: string;
-}
-
-interface ImportMeta {
-  readonly env: ImportMetaEnv;
-}