@osdk/widget.client 2.1.0

package/CHANGELOG.md

@@ -0,0 +1,516 @@
+# @osdk/widget.client
+
+## 2.1.0
+
+### Patch Changes
+
+- 322c5bc: Simulated release
+- a1f5bdc: Adds react 19 as valid peer deps
+- 317b555: Release
+- Updated dependencies [322c5bc]
+- Updated dependencies [322c5bc]
+- Updated dependencies [b61e9f5]
+- Updated dependencies [7416ce4]
+- Updated dependencies [1ba3871]
+- Updated dependencies [12843cb]
+- Updated dependencies [18ba34f]
+- Updated dependencies [cdd3154]
+- Updated dependencies [56aa502]
+- Updated dependencies [abe4897]
+- Updated dependencies [63b2e63]
+- Updated dependencies [cddfbf9]
+- Updated dependencies [5a12181]
+- Updated dependencies [2ce3659]
+- Updated dependencies [7416ce4]
+- Updated dependencies [26c2d95]
+- Updated dependencies [430dee3]
+- Updated dependencies [397f906]
+- Updated dependencies [488b51c]
+- Updated dependencies [fccd9ac]
+- Updated dependencies [5665b18]
+- Updated dependencies [761e69d]
+- Updated dependencies [889e84b]
+- Updated dependencies [62e5965]
+- Updated dependencies [ed69666]
+- Updated dependencies [c92fe73]
+- Updated dependencies [2517750]
+- Updated dependencies [4183a55]
+- Updated dependencies [1e16dcb]
+- Updated dependencies [70b4464]
+- Updated dependencies [2f6206c]
+- Updated dependencies [81c0d8c]
+- Updated dependencies [81c0d8c]
+- Updated dependencies [791e655]
+- Updated dependencies [317b555]
+- Updated dependencies [879b6c3]
+- Updated dependencies [63b2e63]
+- Updated dependencies [2517750]
+- Updated dependencies [1e16dcb]
+- Updated dependencies [f4370e3]
+- Updated dependencies [ea4e4b1]
+- Updated dependencies [a146ce4]
+- Updated dependencies [cc380b5]
+- Updated dependencies [e873024]
+- Updated dependencies [88591f7]
+- Updated dependencies [751e5b3]
+- Updated dependencies [805df40]
+- Updated dependencies [fe0cc43]
+- Updated dependencies [2517750]
+- Updated dependencies [5467a0f]
+- Updated dependencies [2517750]
+- Updated dependencies [63b2e63]
+  - @osdk/client@2.2.0
+  - @osdk/widget.client.unstable@2.1.0
+
+## 2.1.0-beta.11
+
+### Patch Changes
+
+- Updated dependencies [4183a55]
+  - @osdk/client@2.2.0-beta.23
+  - @osdk/widget.api.unstable@2.1.0-beta.11
+
+## 2.1.0-beta.10
+
+### Minor Changes
+
+- 317b555: Release
+
+### Patch Changes
+
+- Updated dependencies [317b555]
+  - @osdk/widget.api.unstable@2.1.0-beta.10
+  - @osdk/client@2.2.0-beta.21
+
+## 2.1.0-beta.9
+
+### Patch Changes
+
+- Updated dependencies [889e84b]
+  - @osdk/client@2.2.0-beta.20
+  - @osdk/widget.api.unstable@2.1.0-beta.9
+
+## 2.1.0-beta.8
+
+### Patch Changes
+
+- Updated dependencies [b61e9f5]
+- Updated dependencies [abe4897]
+- Updated dependencies [5a12181]
+- Updated dependencies [430dee3]
+- Updated dependencies [70b4464]
+- Updated dependencies [791e655]
+- Updated dependencies [751e5b3]
+  - @osdk/client@2.2.0-beta.17
+  - @osdk/widget.api.unstable@2.1.0-beta.8
+
+## 2.1.0-beta.7
+
+### Patch Changes
+
+- @osdk/client@2.2.0-beta.16
+- @osdk/widget.api.unstable@2.1.0-beta.7
+
+## 2.1.0-beta.6
+
+### Patch Changes
+
+- Updated dependencies [2ce3659]
+- Updated dependencies [488b51c]
+- Updated dependencies [e873024]
+- Updated dependencies [88591f7]
+  - @osdk/client@2.2.0-beta.13
+  - @osdk/widget.api.unstable@2.1.0-beta.6
+
+## 2.1.0-beta.5
+
+### Patch Changes
+
+- Updated dependencies [c92fe73]
+  - @osdk/client@2.2.0-beta.12
+  - @osdk/widget.api.unstable@2.1.0-beta.5
+
+## 2.1.0-beta.4
+
+### Patch Changes
+
+- Updated dependencies [81c0d8c]
+- Updated dependencies [81c0d8c]
+  - @osdk/client@2.2.0-beta.10
+  - @osdk/widget.api.unstable@2.1.0-beta.4
+
+## 2.1.0-beta.3
+
+### Patch Changes
+
+- Updated dependencies [7416ce4]
+- Updated dependencies [7416ce4]
+- Updated dependencies [879b6c3]
+- Updated dependencies [805df40]
+  - @osdk/client@2.2.0-beta.7
+  - @osdk/widget.api.unstable@2.1.0-beta.3
+
+## 2.1.0-beta.2
+
+### Patch Changes
+
+- Updated dependencies [cddfbf9]
+- Updated dependencies [ea4e4b1]
+  - @osdk/client@2.2.0-beta.6
+  - @osdk/widget.api.unstable@2.1.0-beta.2
+
+## 2.0.0
+
+### Major Changes
+
+- 5a4ebd7: Bump unstable widget packages to v1 to avoid undesired v0.x version behavior
+
+### Minor Changes
+
+- 009650f: Add initial views API
+- 5f36612: Add support for events
+- 9d35a1f: Remove unused imports
+- c691c8b: Package now has experimental support for commonjs
+- 314ae66: Move from "views" naming to "widgets"
+- 21d2dd1: Add fetch proxy
+- 01c02e5: Add vite plugin to parse out parameter config into a generated config file
+- 121475a: Release versions 1.1.0 of Custom Widget client libraries
+- 83e7ea3: Move from a single-widget to widget set model for custom widget libraries
+- e4839b9: Add target type to widget manifest
+- 7d1355e: Initial release of widget API
+
+### Patch Changes
+
+- Updated dependencies [966d408]
+- Updated dependencies [b773513]
+- Updated dependencies [5a4ebd7]
+- Updated dependencies [cddc196]
+- Updated dependencies [d794c19]
+- Updated dependencies [05febf4]
+- Updated dependencies [55c05f2]
+- Updated dependencies [a06ec35]
+- Updated dependencies [0dc40b0]
+- Updated dependencies [009650f]
+- Updated dependencies [3703d81]
+- Updated dependencies [6f50516]
+- Updated dependencies [25fd9f0]
+- Updated dependencies [11a05cc]
+- Updated dependencies [7865cb6]
+- Updated dependencies [e6fbd94]
+- Updated dependencies [9c4efe6]
+- Updated dependencies [0a7c747]
+- Updated dependencies [f0b519d]
+- Updated dependencies [3ea2e79]
+- Updated dependencies [5f36612]
+- Updated dependencies [1812118]
+- Updated dependencies [d927a1d]
+- Updated dependencies [bc1761c]
+- Updated dependencies [656f975]
+- Updated dependencies [f1145ff]
+- Updated dependencies [1c59d93]
+- Updated dependencies [f446d0c]
+- Updated dependencies [c80ca45]
+- Updated dependencies [bb8b219]
+- Updated dependencies [44e62f6]
+- Updated dependencies [03f95eb]
+- Updated dependencies [91cfa3a]
+- Updated dependencies [94463b6]
+- Updated dependencies [14624f7]
+- Updated dependencies [1a89f23]
+- Updated dependencies [9d35a1f]
+- Updated dependencies [c691c8b]
+- Updated dependencies [314ae66]
+- Updated dependencies [749cf69]
+- Updated dependencies [f03e39f]
+- Updated dependencies [d464009]
+- Updated dependencies [21d2dd1]
+- Updated dependencies [11088aa]
+- Updated dependencies [720218d]
+- Updated dependencies [01c02e5]
+- Updated dependencies [9298f75]
+- Updated dependencies [eb27b54]
+- Updated dependencies [7a95618]
+- Updated dependencies [f34b3d4]
+- Updated dependencies [d88fdb9]
+- Updated dependencies [8eb2378]
+- Updated dependencies [acbfab9]
+- Updated dependencies [c9da74c]
+- Updated dependencies [27f0f77]
+- Updated dependencies [015279b]
+- Updated dependencies [62c1d63]
+- Updated dependencies [3c9ac22]
+- Updated dependencies [91cfa3a]
+- Updated dependencies [e86e91d]
+- Updated dependencies [abfe4b3]
+- Updated dependencies [121475a]
+- Updated dependencies [27866a8]
+- Updated dependencies [0cd1603]
+- Updated dependencies [a7a4aef]
+- Updated dependencies [e5fe7c0]
+- Updated dependencies [1b2e8c9]
+- Updated dependencies [9f3807c]
+- Updated dependencies [d12c92b]
+- Updated dependencies [0c56d21]
+- Updated dependencies [7c13070]
+- Updated dependencies [e548b9b]
+- Updated dependencies [6671a39]
+- Updated dependencies [83e7ea3]
+- Updated dependencies [5e78575]
+- Updated dependencies [ee6224b]
+- Updated dependencies [1dc0228]
+- Updated dependencies [fa02ebf]
+- Updated dependencies [9af346e]
+- Updated dependencies [d3b3f35]
+- Updated dependencies [c682504]
+- Updated dependencies [9018dc2]
+- Updated dependencies [a6c320d]
+- Updated dependencies [e4839b9]
+- Updated dependencies [8026baf]
+- Updated dependencies [6b6c8a1]
+- Updated dependencies [c537e2d]
+- Updated dependencies [3fc2ee6]
+- Updated dependencies [0d8ac3b]
+- Updated dependencies [73fa373]
+- Updated dependencies [8e6a5f4]
+- Updated dependencies [7d1355e]
+- Updated dependencies [09eaf24]
+- Updated dependencies [71dfb4c]
+- Updated dependencies [2d5e648]
+- Updated dependencies [c4f88a8]
+- Updated dependencies [d665147]
+- Updated dependencies [f19da8e]
+  - @osdk/client@2.1.0
+  - @osdk/widget.api.unstable@2.0.0
+
+## 2.0.0-beta.16
+
+### Patch Changes
+
+- Updated dependencies [966d408]
+- Updated dependencies [f03e39f]
+- Updated dependencies [0d8ac3b]
+- Updated dependencies [2d5e648]
+  - @osdk/client@2.1.0-beta.30
+  - @osdk/widget.api.unstable@2.0.0-beta.16
+
+## 2.0.0-beta.15
+
+### Patch Changes
+
+- Updated dependencies [f1145ff]
+- Updated dependencies [8026baf]
+  - @osdk/client@2.1.0-beta.29
+  - @osdk/widget.api.unstable@2.0.0-beta.15
+
+## 2.0.0-beta.14
+
+### Patch Changes
+
+- @osdk/widget.api.unstable@2.0.0-beta.14
+
+## 2.0.0-beta.13
+
+### Minor Changes
+
+- 121475a: Release versions 1.1.0 of Custom Widget client libraries
+
+### Patch Changes
+
+- Updated dependencies [f446d0c]
+- Updated dependencies [121475a]
+  - @osdk/client@2.1.0-beta.28
+  - @osdk/widget.api.unstable@2.0.0-beta.13
+
+## 2.0.0-beta.12
+
+### Patch Changes
+
+- @osdk/client@2.1.0-beta.27
+- @osdk/widget-api.unstable@2.0.0-beta.12
+
+## 2.0.0-beta.11
+
+### Patch Changes
+
+- Updated dependencies [7865cb6]
+- Updated dependencies [e6fbd94]
+- Updated dependencies [9c4efe6]
+- Updated dependencies [44e62f6]
+- Updated dependencies [94463b6]
+- Updated dependencies [f19da8e]
+  - @osdk/client@2.1.0-beta.26
+  - @osdk/widget.api.unstable@2.0.0-beta.11
+
+## 2.0.0-beta.10
+
+### Patch Changes
+
+- Updated dependencies [c80ca45]
+  - @osdk/client@2.1.0-beta.25
+  - @osdk/widget.api.unstable@2.0.0-beta.10
+
+## 2.0.0-beta.9
+
+### Minor Changes
+
+- c691c8b: Package now has experimental support for commonjs
+
+### Patch Changes
+
+- Updated dependencies [03f95eb]
+- Updated dependencies [c691c8b]
+- Updated dependencies [3c9ac22]
+  - @osdk/client@2.1.0-beta.24
+  - @osdk/widget.api.unstable@2.0.0-beta.9
+
+## 2.0.0-beta.8
+
+### Minor Changes
+
+- 83e7ea3: Move from a single-widget to widget set model for custom widget libraries
+
+### Patch Changes
+
+- Updated dependencies [d794c19]
+- Updated dependencies [f0b519d]
+- Updated dependencies [7a95618]
+- Updated dependencies [62c1d63]
+- Updated dependencies [83e7ea3]
+- Updated dependencies [3fc2ee6]
+- Updated dependencies [d665147]
+  - @osdk/client@2.1.0-beta.23
+  - @osdk/widget.api.unstable@2.0.0-beta.8
+
+## 2.0.0-beta.7
+
+### Patch Changes
+
+- Updated dependencies [c9da74c]
+- Updated dependencies [73fa373]
+  - @osdk/client@2.1.0-beta.22
+  - @osdk/widget.api.unstable@2.0.0-beta.7
+
+## 2.0.0-beta.6
+
+### Minor Changes
+
+- 314ae66: Move from "views" naming to "widgets"
+
+### Patch Changes
+
+- Updated dependencies [3ea2e79]
+- Updated dependencies [656f975]
+- Updated dependencies [314ae66]
+- Updated dependencies [f34b3d4]
+- Updated dependencies [e86e91d]
+  - @osdk/client@2.1.0-beta.21
+  - @osdk/widget.api.unstable@2.0.0-beta.6
+
+## 2.0.0-beta.5
+
+### Minor Changes
+
+- 9d35a1f: Remove unused imports
+
+### Patch Changes
+
+- Updated dependencies [b773513]
+- Updated dependencies [9d35a1f]
+- Updated dependencies [abfe4b3]
+- Updated dependencies [c537e2d]
+  - @osdk/client@2.1.0-beta.20
+  - @osdk/widget.api.unstable@2.0.0-beta.5
+
+## 2.0.0-beta.4
+
+### Major Changes
+
+- 5a4ebd7: Bump unstable widget packages to v1 to avoid undesired v0.x version behavior
+
+### Patch Changes
+
+- Updated dependencies [5a4ebd7]
+- Updated dependencies [cddc196]
+- Updated dependencies [720218d]
+- Updated dependencies [eb27b54]
+- Updated dependencies [27f0f77]
+- Updated dependencies [a7a4aef]
+- Updated dependencies [6671a39]
+- Updated dependencies [a6c320d]
+  - @osdk/widget.api.unstable@2.0.0-beta.4
+  - @osdk/client@2.1.0-beta.19
+
+## 0.3.0-beta.3
+
+### Patch Changes
+
+- @osdk/client@2.1.0-beta.18
+- @osdk/widget.api.unstable@0.3.0-beta.3
+
+## 0.3.0-beta.2
+
+### Patch Changes
+
+- @osdk/client@2.1.0-beta.17
+- @osdk/widget.api.unstable@0.3.0-beta.2
+
+## 0.3.0-beta.1
+
+### Patch Changes
+
+- Updated dependencies [e5fe7c0]
+  - @osdk/client@2.1.0-beta.16
+  - @osdk/widget.api.unstable@0.3.0-beta.1
+
+## 0.2.0
+
+### Minor Changes
+
+- e4839b9: Add target type to widget manifest
+
+### Patch Changes
+
+- Updated dependencies [1c59d93]
+- Updated dependencies [e4839b9]
+  - @osdk/client@2.1.0-beta.15
+  - @osdk/widget.api.unstable@0.2.0-beta.0
+
+## 0.1.0
+
+### Patch Changes
+
+- Updated dependencies [0a7c747]
+- Updated dependencies [91cfa3a]
+- Updated dependencies [015279b]
+- Updated dependencies [91cfa3a]
+- Updated dependencies [0c56d21]
+- Updated dependencies [6b6c8a1]
+  - @osdk/client@2.1.0-beta.14
+  - @osdk/widget.api.unstable@0.1.0-beta.2
+
+## 0.1.0-beta.1
+
+### Minor Changes
+
+- 21d2dd1: Add fetch proxy
+
+### Patch Changes
+
+- Updated dependencies [21d2dd1]
+- Updated dependencies [7c13070]
+- Updated dependencies [c4f88a8]
+  - @osdk/widget.api.unstable@0.1.0-beta.1
+  - @osdk/client@2.1.0-beta.13
+
+## 0.1.0-beta.0
+
+### Minor Changes
+
+- 01c02e5: Add vite plugin to parse out parameter config into a generated config file
+- 7d1355e: Initial release of widget API
+
+### Patch Changes
+
+- Updated dependencies [01c02e5]
+- Updated dependencies [7d1355e]
+  - @osdk/widget.api.unstable@0.1.0-beta.0

package/build/browser/client.js

@@ -0,0 +1,128 @@
+/*
+ * Copyright 2024 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { HostMessage, visitHostMessage } from "@osdk/widget.api";
+import { META_TAG_HOST_ORIGIN } from "@osdk/widget.api";
+import invariant from "tiny-invariant";
+import { FoundryHostEventTarget } from "./host.js";
+export function createFoundryWidgetClient() {
+  if ("__PALANTIR_WIDGET_API__" in window) {
+    return _createFoundryWidgetClient(window.__PALANTIR_WIDGET_API__);
+  }
+  // todo: drop support for sandbox v1
+  return _createFoundryWidgetClientLegacy();
+}
+function _createFoundryWidgetClient(widgetApi) {
+  const hostEventTarget = new FoundryHostEventTarget();
+  const listenForHostMessages = event => {
+    visitHostMessage(event.detail, {
+      "host.update-parameters": payload => {
+        hostEventTarget.dispatchEventMessage("host.update-parameters", payload);
+      },
+      _unknown: () => {
+        // Do nothing
+      }
+    });
+  };
+  const sendMessageToHost = message => {
+    widgetApi.sendMessage(message);
+  };
+  return {
+    hostEventTarget,
+    ready: () => {
+      sendMessageToHost({
+        type: "widget.ready",
+        payload: {
+          apiVersion: HostMessage.Version
+        }
+      });
+    },
+    emitEvent: (eventId, payload) => {
+      sendMessageToHost({
+        type: "widget.emit-event",
+        payload: {
+          eventId,
+          ...payload
+        }
+      });
+    },
+    sendMessage: sendMessageToHost,
+    subscribe: () => {
+      widgetApi.addEventListener("message", listenForHostMessages);
+    },
+    unsubscribe: () => {
+      widgetApi.removeEventListener("message", listenForHostMessages);
+    }
+  };
+}
+
+// todo: drop support for sandbox v1
+function _createFoundryWidgetClientLegacy() {
+  !window.parent ? process.env.NODE_ENV !== "production" ? invariant(false, "[FoundryWidgetClient] Must be run in an iframe") : invariant(false) : void 0;
+  const parentWindow = window.parent;
+  const metaTag = document.querySelector(`meta[name="${META_TAG_HOST_ORIGIN}"]`);
+  !metaTag ? process.env.NODE_ENV !== "production" ? invariant(false, "[FoundryWidgetClient] Missing host origin meta tag " + META_TAG_HOST_ORIGIN) : invariant(false) : void 0;
+  const hostOrigin = metaTag.getAttribute("content");
+  !hostOrigin ? process.env.NODE_ENV !== "production" ? invariant(false, "[FoundryWidgetClient] Missing host origin meta tag content") : invariant(false) : void 0;
+  const hostEventTarget = new FoundryHostEventTarget();
+  const listenForHostMessages = event => {
+    visitHostMessage(event.data, {
+      "host.update-parameters": payload => {
+        hostEventTarget.dispatchEventMessage("host.update-parameters", payload);
+      },
+      _unknown: () => {
+        // Do nothing
+      }
+    });
+  };
+  const sendMessageToHost = message => {
+    parentWindow.postMessage(message, hostOrigin);
+  };
+  return {
+    hostEventTarget,
+    ready: () => {
+      sendMessageToHost({
+        type: "widget.ready",
+        payload: {
+          apiVersion: HostMessage.Version
+        }
+      });
+    },
+    emitEvent: (eventId, payload) => {
+      sendMessageToHost({
+        type: "widget.emit-event",
+        payload: {
+          eventId,
+          ...payload
+        }
+      });
+    },
+    sendMessage: sendMessageToHost,
+    subscribe: () => {
+      window.addEventListener("message", event => {
+        if (event.origin !== hostOrigin) {
+          // Reject messages that aren't coming from the configured host
+          return;
+        }
+        listenForHostMessages(event);
+      });
+    },
+    unsubscribe: () => {
+      window.removeEventListener("message", listenForHostMessages);
+    }
+  };
+}
+//# sourceMappingURL=client.js.map

package/build/browser/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","names":["HostMessage","visitHostMessage","META_TAG_HOST_ORIGIN","invariant","FoundryHostEventTarget","createFoundryWidgetClient","window","_createFoundryWidgetClient","__PALANTIR_WIDGET_API__","_createFoundryWidgetClientLegacy","widgetApi","hostEventTarget","listenForHostMessages","event","detail","payload","dispatchEventMessage","_unknown","sendMessageToHost","message","sendMessage","ready","type","apiVersion","Version","emitEvent","eventId","subscribe","addEventListener","unsubscribe","removeEventListener","parent","process","env","NODE_ENV","parentWindow","metaTag","document","querySelector","hostOrigin","getAttribute","data","postMessage","origin"],"sources":["client.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  HostMessage,\n  visitHostMessage,\n  type WidgetConfig,\n  type WidgetMessage,\n} from \"@osdk/widget.api\";\nimport { META_TAG_HOST_ORIGIN } from \"@osdk/widget.api\";\nimport invariant from \"tiny-invariant\";\nimport { FoundryHostEventTarget } from \"./host.js\";\n\nexport interface FoundryWidgetClient<C extends WidgetConfig<C[\"parameters\"]>> {\n  /**\n   * Notifies the host that this client is ready to receive the first parameter values\n   */\n  ready: () => void;\n\n  /**\n   * Emits an event with the given ID and payload\n   */\n  emitEvent: <M extends WidgetMessage.EmitEvent<C>>(\n    eventId: M[\"payload\"][\"eventId\"],\n    payload: Omit<M[\"payload\"], \"eventId\">,\n  ) => void;\n\n  /**\n   * Sends a message to the parent frame.\n   * It is recommended to use the convenience methods for individual messages (e.g. ready or emitEvent) instead\n   */\n  sendMessage: <M extends WidgetMessage<C>>(message: M) => void;\n\n  /**\n   * Subscribes to events from the host, invoking the listener when a message is received\n   */\n  subscribe: () => void;\n\n  /**\n   * Unsubscribes a previously subscribed listener from host events, if one exists\n   */\n  unsubscribe: () => void;\n\n  /**\n   * Event targets on which you can subscribe to specific host messages\n   */\n  hostEventTarget: FoundryHostEventTarget<C>;\n}\n\nexport function createFoundryWidgetClient<\n  C extends WidgetConfig<C[\"parameters\"]>,\n>(): FoundryWidgetClient<C> {\n  if (\"__PALANTIR_WIDGET_API__\" in window) {\n    return _createFoundryWidgetClient<C>(\n      window.__PALANTIR_WIDGET_API__ as PalantirWidgetApi<C>,\n    );\n  }\n  // todo: drop support for sandbox v1\n  return _createFoundryWidgetClientLegacy<C>();\n}\n\ninterface PalantirWidgetApiEvents<C extends WidgetConfig<C[\"parameters\"]>> {\n  message: CustomEvent<HostMessage<C>>;\n}\n\ninterface PalantirWidgetApi<C extends WidgetConfig<C[\"parameters\"]>> {\n  sendMessage: <M extends WidgetMessage<C>>(message: M) => void;\n  addEventListener<K extends keyof PalantirWidgetApiEvents<C>>(\n    type: K,\n    listener: (ev: PalantirWidgetApiEvents<C>[K]) => any,\n    options?: boolean | AddEventListenerOptions,\n  ): void;\n  removeEventListener<K extends keyof PalantirWidgetApiEvents<C>>(\n    type: K,\n    listener: (ev: PalantirWidgetApiEvents<C>[K]) => any,\n    options?: boolean | EventListenerOptions,\n  ): void;\n}\n\nfunction _createFoundryWidgetClient<\n  C extends WidgetConfig<C[\"parameters\"]>,\n>(\n  widgetApi: PalantirWidgetApi<C>,\n): FoundryWidgetClient<C> {\n  const hostEventTarget = new FoundryHostEventTarget<C>();\n\n  const listenForHostMessages = (event: CustomEvent<HostMessage<C>>) => {\n    visitHostMessage(event.detail, {\n      \"host.update-parameters\": (payload) => {\n        hostEventTarget.dispatchEventMessage(\"host.update-parameters\", payload);\n      },\n      _unknown: () => {\n        // Do nothing\n      },\n    });\n  };\n  const sendMessageToHost = <M extends WidgetMessage<C>>(message: M) => {\n    widgetApi.sendMessage(message);\n  };\n\n  return {\n    hostEventTarget,\n    ready: () => {\n      sendMessageToHost({\n        type: \"widget.ready\",\n        payload: {\n          apiVersion: HostMessage.Version,\n        },\n      });\n    },\n    emitEvent: (eventId, payload) => {\n      sendMessageToHost({\n        type: \"widget.emit-event\",\n        payload: {\n          eventId,\n          ...payload,\n        },\n      });\n    },\n    sendMessage: sendMessageToHost,\n    subscribe: () => {\n      widgetApi.addEventListener(\"message\", listenForHostMessages);\n    },\n    unsubscribe: () => {\n      widgetApi.removeEventListener(\"message\", listenForHostMessages);\n    },\n  };\n}\n\n// todo: drop support for sandbox v1\nfunction _createFoundryWidgetClientLegacy<\n  C extends WidgetConfig<C[\"parameters\"]>,\n>(): FoundryWidgetClient<C> {\n  invariant(window.parent, \"[FoundryWidgetClient] Must be run in an iframe\");\n  const parentWindow = window.parent;\n  const metaTag = document.querySelector(\n    `meta[name=\"${META_TAG_HOST_ORIGIN}\"]`,\n  );\n  invariant(\n    metaTag,\n    \"[FoundryWidgetClient] Missing host origin meta tag \"\n      + META_TAG_HOST_ORIGIN,\n  );\n  const hostOrigin = metaTag.getAttribute(\"content\");\n  invariant(\n    hostOrigin,\n    \"[FoundryWidgetClient] Missing host origin meta tag content\",\n  );\n  const hostEventTarget = new FoundryHostEventTarget<C>();\n\n  const listenForHostMessages = (event: MessageEvent<HostMessage<C>>) => {\n    visitHostMessage(event.data, {\n      \"host.update-parameters\": (payload) => {\n        hostEventTarget.dispatchEventMessage(\"host.update-parameters\", payload);\n      },\n      _unknown: () => {\n        // Do nothing\n      },\n    });\n  };\n  const sendMessageToHost = <M extends WidgetMessage<C>>(message: M) => {\n    parentWindow.postMessage(message, hostOrigin);\n  };\n\n  return {\n    hostEventTarget,\n    ready: () => {\n      sendMessageToHost({\n        type: \"widget.ready\",\n        payload: {\n          apiVersion: HostMessage.Version,\n        },\n      });\n    },\n    emitEvent: (eventId, payload) => {\n      sendMessageToHost({\n        type: \"widget.emit-event\",\n        payload: {\n          eventId,\n          ...payload,\n        },\n      });\n    },\n    sendMessage: sendMessageToHost,\n    subscribe: () => {\n      window.addEventListener(\"message\", (event) => {\n        if (event.origin !== hostOrigin) {\n          // Reject messages that aren't coming from the configured host\n          return;\n        }\n        listenForHostMessages(event);\n      });\n    },\n    unsubscribe: () => {\n      window.removeEventListener(\"message\", listenForHostMessages);\n    },\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SACEA,WAAW,EACXC,gBAAgB,QAGX,kBAAkB;AACzB,SAASC,oBAAoB,QAAQ,kBAAkB;AACvD,OAAOC,SAAS,MAAM,gBAAgB;AACtC,SAASC,sBAAsB,QAAQ,WAAW;AAsClD,OAAO,SAASC,yBAAyBA,CAAA,EAEb;EAC1B,IAAI,yBAAyB,IAAIC,MAAM,EAAE;IACvC,OAAOC,0BAA0B,CAC/BD,MAAM,CAACE,uBACT,CAAC;EACH;EACA;EACA,OAAOC,gCAAgC,CAAI,CAAC;AAC9C;AAoBA,SAASF,0BAA0BA,CAGjCG,SAA+B,EACP;EACxB,MAAMC,eAAe,GAAG,IAAIP,sBAAsB,CAAI,CAAC;EAEvD,MAAMQ,qBAAqB,GAAIC,KAAkC,IAAK;IACpEZ,gBAAgB,CAACY,KAAK,CAACC,MAAM,EAAE;MAC7B,wBAAwB,EAAGC,OAAO,IAAK;QACrCJ,eAAe,CAACK,oBAAoB,CAAC,wBAAwB,EAAED,OAAO,CAAC;MACzE,CAAC;MACDE,QAAQ,EAAEA,CAAA,KAAM;QACd;MAAA;IAEJ,CAAC,CAAC;EACJ,CAAC;EACD,MAAMC,iBAAiB,GAAgCC,OAAU,IAAK;IACpET,SAAS,CAACU,WAAW,CAACD,OAAO,CAAC;EAChC,CAAC;EAED,OAAO;IACLR,eAAe;IACfU,KAAK,EAAEA,CAAA,KAAM;MACXH,iBAAiB,CAAC;QAChBI,IAAI,EAAE,cAAc;QACpBP,OAAO,EAAE;UACPQ,UAAU,EAAEvB,WAAW,CAACwB;QAC1B;MACF,CAAC,CAAC;IACJ,CAAC;IACDC,SAAS,EAAEA,CAACC,OAAO,EAAEX,OAAO,KAAK;MAC/BG,iBAAiB,CAAC;QAChBI,IAAI,EAAE,mBAAmB;QACzBP,OAAO,EAAE;UACPW,OAAO;UACP,GAAGX;QACL;MACF,CAAC,CAAC;IACJ,CAAC;IACDK,WAAW,EAAEF,iBAAiB;IAC9BS,SAAS,EAAEA,CAAA,KAAM;MACfjB,SAAS,CAACkB,gBAAgB,CAAC,SAAS,EAAEhB,qBAAqB,CAAC;IAC9D,CAAC;IACDiB,WAAW,EAAEA,CAAA,KAAM;MACjBnB,SAAS,CAACoB,mBAAmB,CAAC,SAAS,EAAElB,qBAAqB,CAAC;IACjE;EACF,CAAC;AACH;;AAEA;AACA,SAASH,gCAAgCA,CAAA,EAEb;EAC1B,CAAUH,MAAM,CAACyB,MAAM,GAAAC,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAvB/B,SAAS,QAAgB,gDAAgD,IAAzEA,SAAS;EACT,MAAMgC,YAAY,GAAG7B,MAAM,CAACyB,MAAM;EAClC,MAAMK,OAAO,GAAGC,QAAQ,CAACC,aAAa,CACpC,cAAcpC,oBAAoB,IACpC,CAAC;EACD,CACEkC,OAAO,GAAAJ,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBADT/B,SAAS,QAEP,qDAAqD,GACjDD,oBAAoB,IAH1BC,SAAS;EAKT,MAAMoC,UAAU,GAAGH,OAAO,CAACI,YAAY,CAAC,SAAS,CAAC;EAClD,CACED,UAAU,GAAAP,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBADZ/B,SAAS,QAEP,4DAA4D,IAF9DA,SAAS;EAIT,MAAMQ,eAAe,GAAG,IAAIP,sBAAsB,CAAI,CAAC;EAEvD,MAAMQ,qBAAqB,GAAIC,KAAmC,IAAK;IACrEZ,gBAAgB,CAACY,KAAK,CAAC4B,IAAI,EAAE;MAC3B,wBAAwB,EAAG1B,OAAO,IAAK;QACrCJ,eAAe,CAACK,oBAAoB,CAAC,wBAAwB,EAAED,OAAO,CAAC;MACzE,CAAC;MACDE,QAAQ,EAAEA,CAAA,KAAM;QACd;MAAA;IAEJ,CAAC,CAAC;EACJ,CAAC;EACD,MAAMC,iBAAiB,GAAgCC,OAAU,IAAK;IACpEgB,YAAY,CAACO,WAAW,CAACvB,OAAO,EAAEoB,UAAU,CAAC;EAC/C,CAAC;EAED,OAAO;IACL5B,eAAe;IACfU,KAAK,EAAEA,CAAA,KAAM;MACXH,iBAAiB,CAAC;QAChBI,IAAI,EAAE,cAAc;QACpBP,OAAO,EAAE;UACPQ,UAAU,EAAEvB,WAAW,CAACwB;QAC1B;MACF,CAAC,CAAC;IACJ,CAAC;IACDC,SAAS,EAAEA,CAACC,OAAO,EAAEX,OAAO,KAAK;MAC/BG,iBAAiB,CAAC;QAChBI,IAAI,EAAE,mBAAmB;QACzBP,OAAO,EAAE;UACPW,OAAO;UACP,GAAGX;QACL;MACF,CAAC,CAAC;IACJ,CAAC;IACDK,WAAW,EAAEF,iBAAiB;IAC9BS,SAAS,EAAEA,CAAA,KAAM;MACfrB,MAAM,CAACsB,gBAAgB,CAAC,SAAS,EAAGf,KAAK,IAAK;QAC5C,IAAIA,KAAK,CAAC8B,MAAM,KAAKJ,UAAU,EAAE;UAC/B;UACA;QACF;QACA3B,qBAAqB,CAACC,KAAK,CAAC;MAC9B,CAAC,CAAC;IACJ,CAAC;IACDgB,WAAW,EAAEA,CAAA,KAAM;MACjBvB,MAAM,CAACwB,mBAAmB,CAAC,SAAS,EAAElB,qBAAqB,CAAC;IAC9D;EACF,CAAC;AACH","ignoreList":[]}

package/build/browser/host.js

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2024 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export class FoundryHostEventTarget extends EventTarget {
+  addEventListener(type, callback, options) {
+    super.addEventListener(type, callback, options);
+  }
+  removeEventListener(type, callback, options) {
+    super.removeEventListener(type, callback, options);
+  }
+  dispatchEventMessage(type, payload) {
+    this.dispatchEvent(new CustomEvent(type, {
+      detail: payload
+    }));
+  }
+}
+//# sourceMappingURL=host.js.map

package/build/browser/host.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"host.js","names":["FoundryHostEventTarget","EventTarget","addEventListener","type","callback","options","removeEventListener","dispatchEventMessage","payload","dispatchEvent","CustomEvent","detail"],"sources":["host.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { HostMessage, WidgetConfig } from \"@osdk/widget.api\";\n\nexport interface HostMessageEventListener<P extends HostMessage.Payload> {\n  (event: CustomEvent<P>): void;\n}\n\nexport interface HostMessageEventListenerObject<P extends HostMessage.Payload> {\n  handleEvent(object: CustomEvent<P>): void;\n}\n\nexport class FoundryHostEventTarget<\n  C extends WidgetConfig<C[\"parameters\"]>,\n> extends EventTarget {\n  addEventListener<T extends HostMessage<C>[\"type\"]>(\n    type: T,\n    callback:\n      | HostMessageEventListener<\n        (HostMessage<C> & { type: T })[\"payload\"]\n      >\n      | HostMessageEventListenerObject<\n        (HostMessage<C> & { type: T })[\"payload\"]\n      >\n      | null,\n    options?: AddEventListenerOptions | boolean,\n  ): void {\n    super.addEventListener(type, callback as EventListener, options);\n  }\n\n  removeEventListener<T extends HostMessage<C>[\"type\"]>(\n    type: T,\n    callback:\n      | HostMessageEventListener<\n        (HostMessage<C> & { type: T })[\"payload\"]\n      >\n      | HostMessageEventListenerObject<\n        (HostMessage<C> & { type: T })[\"payload\"]\n      >\n      | null,\n    options?: EventListenerOptions | boolean,\n  ): void {\n    super.removeEventListener(type, callback as EventListener, options);\n  }\n\n  public dispatchEventMessage<T extends HostMessage<C>[\"type\"]>(\n    type: T,\n    payload: (HostMessage<C> & { type: T })[\"payload\"],\n  ): void {\n    this.dispatchEvent(\n      new CustomEvent<HostMessage.Payload>(type, {\n        detail: payload,\n      }),\n    );\n  }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA,OAAO,MAAMA,sBAAsB,SAEzBC,WAAW,CAAC;EACpBC,gBAAgBA,CACdC,IAAO,EACPC,QAOQ,EACRC,OAA2C,EACrC;IACN,KAAK,CAACH,gBAAgB,CAACC,IAAI,EAAEC,QAAQ,EAAmBC,OAAO,CAAC;EAClE;EAEAC,mBAAmBA,CACjBH,IAAO,EACPC,QAOQ,EACRC,OAAwC,EAClC;IACN,KAAK,CAACC,mBAAmB,CAACH,IAAI,EAAEC,QAAQ,EAAmBC,OAAO,CAAC;EACrE;EAEOE,oBAAoBA,CACzBJ,IAAO,EACPK,OAAkD,EAC5C;IACN,IAAI,CAACC,aAAa,CAChB,IAAIC,WAAW,CAAsBP,IAAI,EAAE;MACzCQ,MAAM,EAAEH;IACV,CAAC,CACH,CAAC;EACH;AACF","ignoreList":[]}