@sanity/workbench 0.1.0-alpha.5 → 0.1.0-alpha.6

package/dist/_internal.js

@@ -23,11 +23,11 @@ async function renderWorkbench(rootElement, config, options) {
   }).loadRemote(
     `${REMOTE_NAME}/${REMOTE_MODULE}`
   );
-  if (!remoteModule || typeof remoteModule.setup != "function")
+  if (!remoteModule || typeof remoteModule.render != "function")
     throw new Error(
-      `Remote module "${REMOTE_NAME}/${REMOTE_MODULE}" did not expose a setup function`
+      `Remote module "${REMOTE_NAME}/${REMOTE_MODULE}" did not expose a render function`
     );
-  return remoteModule.setup(config, options).render(rootElement);
+  return remoteModule.render(rootElement, { config }, options);
 }
 export {
   renderWorkbench

package/dist/_internal.js.map

@@ -1 +1 @@
-{"version":3,"file":"_internal.js","sources":["../src/_internal/render.ts"],"sourcesContent":["import { createInstance } from \"@sanity/federation/runtime\";\nimport { log } from \"@sanity/federation/runtime/plugins/log\";\nimport { createLogger } from \"../log\";\n\nconst logger = createLogger({\n  namespace: \"sanity-workbench\",\n  logLevel: \"debug\",\n});\n\n/**\n * Workbench configuration.\n *\n * @public\n */\nexport type Config = {\n  /**\n   * The organization ID to use when rendering the workbench.\n   */\n  organizationId: string | undefined;\n};\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\n/**\n * Module defining the remote workbench application.\n *\n * @internal\n */\ninterface WorkbenchRemoteModule {\n  setup: (\n    config?: Config,\n    options?: RenderWorkbenchOptions,\n  ) => {\n    render(rootElement: HTMLElement): () => void;\n  };\n}\n\nconst REMOTE_NAME = \"workbench-remote\";\nconst REMOTE_MODULE = \"App\";\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) {\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    plugins: [log(logger.debug)],\n\n    remotes: [\n      {\n        name: REMOTE_NAME,\n        entry: remoteUrl,\n      },\n    ],\n  });\n\n  let remoteModule = await mf.loadRemote<WorkbenchRemoteModule>(\n    `${REMOTE_NAME}/${REMOTE_MODULE}`,\n  );\n\n  if (!remoteModule || typeof remoteModule.setup !== \"function\") {\n    throw new Error(\n      `Remote module \"${REMOTE_NAME}/${REMOTE_MODULE}\" did not expose a setup function`,\n    );\n  }\n\n  const instance = remoteModule.setup(config, options);\n\n  return instance.render(rootElement);\n}\n"],"names":[],"mappings":";;;AAIA,MAAM,SAAS,aAAa;AAAA,EAC1B,WAAW;AAAA,EACX,UAAU;AACZ,CAAC,GA8CK,cAAc,oBACd,gBAAgB;AAatB,eAAsB,gBACpB,aACA,QACA,SACA;AACA,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,gDAAgD;AAGlE,QAAM,YAAY,YAAY,IAAI;AAElC,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,iDAAiD;AAenE,MAAI,eAAe,MAZR,eAAe;AAAA,IACxB,MAAM;AAAA,IACN,SAAS,CAAC,IAAI,OAAO,KAAK,CAAC;AAAA,IAE3B,SAAS;AAAA,MACP;AAAA,QACE,MAAM;AAAA,QACN,OAAO;AAAA,MAAA;AAAA,IACT;AAAA,EACF,CACD,EAE2B;AAAA,IAC1B,GAAG,WAAW,IAAI,aAAa;AAAA,EAAA;AAGjC,MAAI,CAAC,gBAAgB,OAAO,aAAa,SAAU;AACjD,UAAM,IAAI;AAAA,MACR,kBAAkB,WAAW,IAAI,aAAa;AAAA,IAAA;AAMlD,SAFiB,aAAa,MAAM,QAAQ,OAAO,EAEnC,OAAO,WAAW;AACpC;"}
+{"version":3,"file":"_internal.js","sources":["../src/_internal/render.ts"],"sourcesContent":["import { createInstance } from \"@sanity/federation/runtime\";\nimport { log } from \"@sanity/federation/runtime/plugins/log\";\nimport { createLogger } from \"../log\";\n\nconst logger = createLogger({\n  namespace: \"sanity-workbench\",\n  logLevel: \"debug\",\n});\n\n/**\n * Workbench configuration.\n *\n * @public\n */\nexport type Config = {\n  /**\n   * The organization ID to use when rendering the workbench.\n   */\n  organizationId: string | undefined;\n};\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\n/**\n * Module defining the remote workbench application.\n *\n * @internal\n */\ninterface WorkbenchRemoteModule {\n  render: (\n    rootElement: HTMLElement,\n    props: { config?: Config },\n    options?: RenderWorkbenchOptions,\n  ) => () => void;\n}\n\nconst REMOTE_NAME = \"workbench-remote\";\nconst REMOTE_MODULE = \"App\";\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) {\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    plugins: [log(logger.debug)],\n\n    remotes: [\n      {\n        name: REMOTE_NAME,\n        entry: remoteUrl,\n      },\n    ],\n  });\n\n  let remoteModule = await mf.loadRemote<WorkbenchRemoteModule>(\n    `${REMOTE_NAME}/${REMOTE_MODULE}`,\n  );\n\n  if (!remoteModule || typeof remoteModule.render !== \"function\") {\n    throw new Error(\n      `Remote module \"${REMOTE_NAME}/${REMOTE_MODULE}\" did not expose a render function`,\n    );\n  }\n\n  return remoteModule.render(rootElement, { config }, options);\n}\n"],"names":[],"mappings":";;;AAIA,MAAM,SAAS,aAAa;AAAA,EAC1B,WAAW;AAAA,EACX,UAAU;AACZ,CAAC,GA6CK,cAAc,oBACd,gBAAgB;AAatB,eAAsB,gBACpB,aACA,QACA,SACA;AACA,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,gDAAgD;AAGlE,QAAM,YAAY,YAAY,IAAI;AAElC,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,iDAAiD;AAenE,MAAI,eAAe,MAZR,eAAe;AAAA,IACxB,MAAM;AAAA,IACN,SAAS,CAAC,IAAI,OAAO,KAAK,CAAC;AAAA,IAE3B,SAAS;AAAA,MACP;AAAA,QACE,MAAM;AAAA,QACN,OAAO;AAAA,MAAA;AAAA,IACT;AAAA,EACF,CACD,EAE2B;AAAA,IAC1B,GAAG,WAAW,IAAI,aAAa;AAAA,EAAA;AAGjC,MAAI,CAAC,gBAAgB,OAAO,aAAa,UAAW;AAClD,UAAM,IAAI;AAAA,MACR,kBAAkB,WAAW,IAAI,aAAa;AAAA,IAAA;AAIlD,SAAO,aAAa,OAAO,aAAa,EAAE,OAAA,GAAU,OAAO;AAC7D;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workbench",
-  "version": "0.1.0-alpha.5",
+  "version": "0.1.0-alpha.6",
   "description": "Workbench component for the Sanity Content Operating System",
   "keywords": [],
   "homepage": "https://github.com/sanity-io/workbench/packages/@sanity/workbench#readme",
@@ -31,7 +31,7 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@sanity/federation": "0.1.0-alpha.4"
+    "@sanity/federation": "0.1.0-alpha.5"
   },
   "devDependencies": {
     "@sanity/pkg-utils": "^9.2.3",

package/src/_internal/render.ts

@@ -43,12 +43,11 @@ declare global {
  * @internal
  */
 interface WorkbenchRemoteModule {
-  setup: (
-    config?: Config,
+  render: (
+    rootElement: HTMLElement,
+    props: { config?: Config },
     options?: RenderWorkbenchOptions,
-  ) => {
-    render(rootElement: HTMLElement): () => void;
-  };
+  ) => () => void;
 }
 
 const REMOTE_NAME = "workbench-remote";
@@ -96,13 +95,11 @@ export async function renderWorkbench(
     `${REMOTE_NAME}/${REMOTE_MODULE}`,
   );
 
-  if (!remoteModule || typeof remoteModule.setup !== "function") {
+  if (!remoteModule || typeof remoteModule.render !== "function") {
     throw new Error(
-      `Remote module "${REMOTE_NAME}/${REMOTE_MODULE}" did not expose a setup function`,
+      `Remote module "${REMOTE_NAME}/${REMOTE_MODULE}" did not expose a render function`,
     );
   }
 
-  const instance = remoteModule.setup(config, options);
-
-  return instance.render(rootElement);
+  return remoteModule.render(rootElement, { config }, options);
 }