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

package/dist/_internal.d.ts

@@ -1,4 +1,6 @@
 /**
+ * Workbench configuration.
+ *
  * @public
  */
 export declare type Config = undefined;
@@ -21,6 +23,8 @@ export declare function renderWorkbench(
 ): Promise<() => void>;
 
 /**
+ * Options for rendering the workbench.
+ *
  * @public
  */
 export declare interface RenderWorkbenchOptions {

package/dist/_internal.js

@@ -1,5 +1,5 @@
 import { createInstance } from "@sanity/federation/runtime";
-const REMOTE_NAME = "workbench-remote", REMOTE_MODULE = "./App";
+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");

package/dist/_internal.js.map

@@ -1 +1 @@
-{"version":3,"file":"_internal.js","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":[],"mappings":";AAEA,MAAM,cAAc,oBACd,gBAAgB;AAiCtB,eAAsB,gBACpB,aACA,QACA,SACqB;AACrB,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,gDAAgD;AAGlE,QAAM,YAAY,YAAY,IAAI;AAClC,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,iDAAiD;AAGnE,QAAM,KAAK,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;"}
+{"version":3,"file":"_internal.js","sources":["../src/_internal/render.ts"],"sourcesContent":["import { createInstance } from \"@sanity/federation/runtime\";\n\n/**\n * Workbench configuration.\n *\n * @public\n */\nexport type Config = undefined;\n\n/**\n * Options for rendering the workbench.\n *\n * @public\n */\nexport interface RenderWorkbenchOptions {\n  reactStrictMode?: boolean;\n}\n\ndeclare global {\n  interface ImportMetaEnv {\n    readonly SANITY_INTERNAL_WORKBENCH_REMOTE_URL: string;\n  }\n  interface ImportMeta {\n    readonly env: ImportMetaEnv;\n  }\n}\n\nconst REMOTE_NAME = \"workbench-remote\";\nconst REMOTE_MODULE = \"App\";\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\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":[],"mappings":";AA2BA,MAAM,cAAc,oBACd,gBAAgB;AAqBtB,eAAsB,gBACpB,aACA,QACA,SACqB;AACrB,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,gDAAgD;AAGlE,QAAM,YAAY,YAAY,IAAI;AAElC,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,iDAAiD;AAGnE,QAAM,KAAK,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workbench",
-  "version": "0.1.0-alpha.1",
+  "version": "0.1.0-alpha.2",
   "description": "Workbench component for the Sanity Content Operating System",
   "keywords": [],
   "homepage": "https://github.com/sanity-io/workbench/packages/@sanity/workbench#readme",
@@ -21,14 +21,13 @@
   "sideEffects": false,
   "exports": {
     "./_internal": {
-      "source": "./src/_internal/index.ts",
-      "require": "./dist/_internal.cjs",
+      "source": "./src/_exports/_internal.ts",
       "default": "./dist/_internal.js"
     },
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@sanity/federation": "0.1.0-alpha.1"
+    "@sanity/federation": "0.1.0-alpha.2"
   },
   "devDependencies": {
     "@sanity/pkg-utils": "^9.2.3",

package/src/_exports/_internal.ts

@@ -0,0 +1 @@
+export * from "../_internal";

package/src/_internal/render.test.ts

@@ -0,0 +1,18 @@
+import { describe, expect, it } from "vitest";
+
+import { renderWorkbench } from "./render";
+
+describe("renderWorkbench", () => {
+  it("throws when rootElement is missing", async () => {
+    await expect(
+      renderWorkbench(null as unknown as HTMLElement),
+    ).rejects.toThrow("Missing root element to mount application into");
+  });
+
+  it("throws when SANITY_INTERNAL_WORKBENCH_REMOTE_URL is not set", async () => {
+    const el = document.createElement("div");
+    await expect(renderWorkbench(el)).rejects.toThrow(
+      "SANITY_INTERNAL_WORKBENCH_REMOTE_URL is not set",
+    );
+  });
+});

package/src/_internal/render.ts

@@ -1,20 +1,33 @@
 import { createInstance } from "@sanity/federation/runtime";
 
-const REMOTE_NAME = "workbench-remote";
-const REMOTE_MODULE = "./App";
-
 /**
+ * Workbench configuration.
+ *
  * @public
  */
 export type Config = undefined;
 
 /**
+ * Options for rendering the workbench.
+ *
  * @public
  */
 export interface RenderWorkbenchOptions {
   reactStrictMode?: boolean;
 }
 
+declare global {
+  interface ImportMetaEnv {
+    readonly SANITY_INTERNAL_WORKBENCH_REMOTE_URL: string;
+  }
+  interface ImportMeta {
+    readonly env: ImportMetaEnv;
+  }
+}
+
+const REMOTE_NAME = "workbench-remote";
+const REMOTE_MODULE = "App";
+
 interface RemoteModule {
   render(
     rootElement: HTMLElement,
@@ -44,6 +57,7 @@ export async function renderWorkbench(
   }
 
   const remoteUrl = import.meta.env.SANITY_INTERNAL_WORKBENCH_REMOTE_URL;
+
   if (!remoteUrl) {
     throw new Error("SANITY_INTERNAL_WORKBENCH_REMOTE_URL is not set");
   }

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;
-}