@sanity/workbench 0.0.1-alpha.0 → 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/index.cjs

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: !0 });
-var jsxRuntime = require("react/jsx-runtime"), react = require("react"), client = require("react-dom/client");
-function Workbench(_props) {
-  return /* @__PURE__ */ jsxRuntime.jsx("h1", { children: "Hello World" });
-}
-function renderWorkbench(rootElement, config, options) {
-  if (!rootElement)
-    throw new Error("Missing root element to mount application into");
-  const root = client.createRoot(rootElement), workbench = /* @__PURE__ */ jsxRuntime.jsx(Workbench, { config });
-  return root.render(
-    options?.reactStrictMode ? /* @__PURE__ */ jsxRuntime.jsx(react.StrictMode, { children: workbench }) : workbench
-  ), () => root.unmount();
-}
-exports.renderWorkbench = renderWorkbench;
-//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","sources":["../src/index.tsx"],"sourcesContent":["import { StrictMode } from \"react\";\nimport { createRoot } from \"react-dom/client\";\n\ninterface WorkbenchProps {\n  config: undefined;\n}\n\nfunction Workbench(_props: WorkbenchProps) {\n  return <h1>Hello World</h1>;\n}\n\ninterface RenderWorkbenchOptions {\n  reactStrictMode: boolean;\n}\n\nexport function renderWorkbench(\n  rootElement: HTMLElement,\n  config: Config,\n  options?: RenderWorkbenchOptions,\n): () => void {\n  if (!rootElement) {\n    throw new Error(\"Missing root element to mount application into\");\n  }\n\n  const root = createRoot(rootElement);\n  const workbench = <Workbench config={config} />;\n\n  root.render(\n    options?.reactStrictMode ? <StrictMode>{workbench}</StrictMode> : workbench,\n  );\n\n  return () => root.unmount();\n}\n\nexport type Config = WorkbenchProps[\"config\"];\n"],"names":["jsx","createRoot","StrictMode"],"mappings":";;;AAOA,SAAS,UAAU,QAAwB;AACzC,SAAOA,2BAAAA,IAAC,QAAG,UAAA,cAAA,CAAW;AACxB;AAMO,SAAS,gBACd,aACA,QACA,SACY;AACZ,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,gDAAgD;AAGlE,QAAM,OAAOC,OAAAA,WAAW,WAAW,GAC7B,YAAYD,+BAAC,aAAU,QAAgB;AAE7C,SAAA,KAAK;AAAA,IACH,SAAS,kBAAkBA,+BAACE,MAAAA,YAAA,EAAY,qBAAU,IAAgB;AAAA,EAAA,GAG7D,MAAM,KAAK,QAAA;AACpB;;"}

package/dist/index.js

@@ -1,18 +0,0 @@
-import { jsx } from "react/jsx-runtime";
-import { StrictMode } from "react";
-import { createRoot } from "react-dom/client";
-function Workbench(_props) {
-  return /* @__PURE__ */ jsx("h1", { children: "Hello World" });
-}
-function renderWorkbench(rootElement, config, options) {
-  if (!rootElement)
-    throw new Error("Missing root element to mount application into");
-  const root = createRoot(rootElement), workbench = /* @__PURE__ */ jsx(Workbench, { config });
-  return root.render(
-    options?.reactStrictMode ? /* @__PURE__ */ jsx(StrictMode, { children: workbench }) : workbench
-  ), () => root.unmount();
-}
-export {
-  renderWorkbench
-};
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sources":["../src/index.tsx"],"sourcesContent":["import { StrictMode } from \"react\";\nimport { createRoot } from \"react-dom/client\";\n\ninterface WorkbenchProps {\n  config: undefined;\n}\n\nfunction Workbench(_props: WorkbenchProps) {\n  return <h1>Hello World</h1>;\n}\n\ninterface RenderWorkbenchOptions {\n  reactStrictMode: boolean;\n}\n\nexport function renderWorkbench(\n  rootElement: HTMLElement,\n  config: Config,\n  options?: RenderWorkbenchOptions,\n): () => void {\n  if (!rootElement) {\n    throw new Error(\"Missing root element to mount application into\");\n  }\n\n  const root = createRoot(rootElement);\n  const workbench = <Workbench config={config} />;\n\n  root.render(\n    options?.reactStrictMode ? <StrictMode>{workbench}</StrictMode> : workbench,\n  );\n\n  return () => root.unmount();\n}\n\nexport type Config = WorkbenchProps[\"config\"];\n"],"names":[],"mappings":";;;AAOA,SAAS,UAAU,QAAwB;AACzC,SAAO,oBAAC,QAAG,UAAA,cAAA,CAAW;AACxB;AAMO,SAAS,gBACd,aACA,QACA,SACY;AACZ,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,gDAAgD;AAGlE,QAAM,OAAO,WAAW,WAAW,GAC7B,YAAY,oBAAC,aAAU,QAAgB;AAE7C,SAAA,KAAK;AAAA,IACH,SAAS,kBAAkB,oBAAC,YAAA,EAAY,qBAAU,IAAgB;AAAA,EAAA,GAG7D,MAAM,KAAK,QAAA;AACpB;"}

package/src/index.tsx

@@ -1,35 +0,0 @@
-import { StrictMode } from "react";
-import { createRoot } from "react-dom/client";
-
-interface WorkbenchProps {
-  config: undefined;
-}
-
-function Workbench(_props: WorkbenchProps) {
-  return <h1>Hello World</h1>;
-}
-
-interface RenderWorkbenchOptions {
-  reactStrictMode: boolean;
-}
-
-export function renderWorkbench(
-  rootElement: HTMLElement,
-  config: Config,
-  options?: RenderWorkbenchOptions,
-): () => void {
-  if (!rootElement) {
-    throw new Error("Missing root element to mount application into");
-  }
-
-  const root = createRoot(rootElement);
-  const workbench = <Workbench config={config} />;
-
-  root.render(
-    options?.reactStrictMode ? <StrictMode>{workbench}</StrictMode> : workbench,
-  );
-
-  return () => root.unmount();
-}
-
-export type Config = WorkbenchProps["config"];