@osdk/widget.client 2.1.0

package/build/browser/host.test.js

@@ -0,0 +1,113 @@
+/*
+ * 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 { defineConfig } from "@osdk/widget.api";
+import { describe, expectTypeOf, it } from "vitest";
+import { FoundryHostEventTarget } from "./host.js";
+describe("FoundryHostEventTarget", () => {
+  it("should narrow the event payload based on host message type for addEventListener", () => {
+    defineConfig({
+      id: "widgetId",
+      name: "Widget Name",
+      description: "Widget Description",
+      type: "workshop",
+      parameters: {
+        test: {
+          displayName: "Testing",
+          type: "array",
+          subType: "boolean"
+        },
+        test2: {
+          displayName: "Testing 2",
+          type: "array",
+          subType: "string"
+        },
+        test3: {
+          displayName: "Testing 3",
+          type: "number"
+        }
+      },
+      events: {
+        myEvent: {
+          displayName: "My Event",
+          parameterUpdateIds: ["test"]
+        }
+      }
+    });
+    const hostTarget = new FoundryHostEventTarget();
+    hostTarget.addEventListener("host.update-parameters", event => {
+      expectTypeOf(event.detail).toMatchTypeOf();
+    });
+  });
+  it("should narrow the event payload based on host message type for removeEventListener", () => {
+    defineConfig({
+      id: "widgetId",
+      name: "Widget Name",
+      description: "Widget Description",
+      type: "workshop",
+      parameters: {
+        test: {
+          displayName: "Testing",
+          type: "array",
+          subType: "boolean"
+        },
+        test2: {
+          displayName: "Testing 2",
+          type: "array",
+          subType: "string"
+        },
+        test3: {
+          displayName: "Testing 3",
+          type: "number"
+        }
+      },
+      events: {
+        myEvent: {
+          displayName: "My Event",
+          parameterUpdateIds: ["test"]
+        }
+      }
+    });
+    const hostTarget = new FoundryHostEventTarget();
+    hostTarget.removeEventListener("host.update-parameters", event => {
+      expectTypeOf(event.detail).toMatchTypeOf();
+    });
+  });
+  it("should narrow the event payload when dispatching an event", () => {
+    defineConfig({
+      id: "widgetId",
+      name: "Widget Name",
+      description: "Widget Description",
+      type: "workshop",
+      parameters: {
+        test: {
+          displayName: "Testing",
+          type: "array",
+          subType: "boolean"
+        }
+      },
+      events: {
+        myEvent: {
+          displayName: "My Event",
+          parameterUpdateIds: ["test"]
+        }
+      }
+    });
+    new FoundryHostEventTarget();
+    expectTypeOf().toMatchTypeOf();
+  });
+});
+//# sourceMappingURL=host.test.js.map

package/build/browser/host.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"host.test.js","names":["defineConfig","describe","expectTypeOf","it","FoundryHostEventTarget","id","name","description","type","parameters","test","displayName","subType","test2","test3","events","myEvent","parameterUpdateIds","hostTarget","addEventListener","event","detail","toMatchTypeOf","removeEventListener"],"sources":["host.test.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 } from \"@osdk/widget.api\";\nimport { defineConfig } from \"@osdk/widget.api\";\nimport { describe, expectTypeOf, it } from \"vitest\";\nimport type { HostMessageEventListener } from \"./host.js\";\nimport { FoundryHostEventTarget } from \"./host.js\";\n\ndescribe(\"FoundryHostEventTarget\", () => {\n  it(\"should narrow the event payload based on host message type for addEventListener\", () => {\n    const test = defineConfig({\n      id: \"widgetId\",\n      name: \"Widget Name\",\n      description: \"Widget Description\",\n      type: \"workshop\",\n      parameters: {\n        test: {\n          displayName: \"Testing\",\n          type: \"array\",\n          subType: \"boolean\",\n        },\n        test2: {\n          displayName: \"Testing 2\",\n          type: \"array\",\n          subType: \"string\",\n        },\n        test3: {\n          displayName: \"Testing 3\",\n          type: \"number\",\n        },\n      },\n      events: {\n        myEvent: {\n          displayName: \"My Event\",\n          parameterUpdateIds: [\"test\"],\n        },\n      },\n    });\n\n    const hostTarget = new FoundryHostEventTarget<typeof test>();\n    hostTarget.addEventListener(\"host.update-parameters\", (event) => {\n      expectTypeOf(event.detail).toMatchTypeOf<\n        HostMessage.Payload.UpdateParameters<typeof test>\n      >();\n    });\n  });\n\n  it(\"should narrow the event payload based on host message type for removeEventListener\", () => {\n    const test = defineConfig({\n      id: \"widgetId\",\n      name: \"Widget Name\",\n      description: \"Widget Description\",\n      type: \"workshop\",\n      parameters: {\n        test: {\n          displayName: \"Testing\",\n          type: \"array\",\n          subType: \"boolean\",\n        },\n        test2: {\n          displayName: \"Testing 2\",\n          type: \"array\",\n          subType: \"string\",\n        },\n        test3: {\n          displayName: \"Testing 3\",\n          type: \"number\",\n        },\n      },\n      events: {\n        myEvent: {\n          displayName: \"My Event\",\n          parameterUpdateIds: [\"test\"],\n        },\n      },\n    });\n\n    const hostTarget = new FoundryHostEventTarget<typeof test>();\n    const listener: HostMessageEventListener<\n      HostMessage.Payload.UpdateParameters<typeof test>\n    > = (event) => {\n      expectTypeOf(event.detail).toMatchTypeOf<\n        HostMessage.Payload.UpdateParameters<typeof test>\n      >();\n    };\n\n    hostTarget.removeEventListener(\"host.update-parameters\", listener);\n  });\n\n  it(\"should narrow the event payload when dispatching an event\", () => {\n    const test = defineConfig({\n      id: \"widgetId\",\n      name: \"Widget Name\",\n      description: \"Widget Description\",\n      type: \"workshop\",\n      parameters: {\n        test: {\n          displayName: \"Testing\",\n          type: \"array\",\n          subType: \"boolean\",\n        },\n      },\n      events: {\n        myEvent: {\n          displayName: \"My Event\",\n          parameterUpdateIds: [\"test\"],\n        },\n      },\n    });\n\n    const hostTarget = new FoundryHostEventTarget<typeof test>();\n    type dispatchUpdateMessage = Parameters<\n      typeof hostTarget.dispatchEventMessage<\"host.update-parameters\">\n    >[1];\n    expectTypeOf<dispatchUpdateMessage>().toMatchTypeOf<\n      HostMessage.Payload.UpdateParameters<typeof test>\n    >();\n  });\n});\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,YAAY,QAAQ,kBAAkB;AAC/C,SAASC,QAAQ,EAAEC,YAAY,EAAEC,EAAE,QAAQ,QAAQ;AAEnD,SAASC,sBAAsB,QAAQ,WAAW;AAElDH,QAAQ,CAAC,wBAAwB,EAAE,MAAM;EACvCE,EAAE,CAAC,iFAAiF,EAAE,MAAM;IAC7EH,YAAY,CAAC;MACxBK,EAAE,EAAE,UAAU;MACdC,IAAI,EAAE,aAAa;MACnBC,WAAW,EAAE,oBAAoB;MACjCC,IAAI,EAAE,UAAU;MAChBC,UAAU,EAAE;QACVC,IAAI,EAAE;UACJC,WAAW,EAAE,SAAS;UACtBH,IAAI,EAAE,OAAO;UACbI,OAAO,EAAE;QACX,CAAC;QACDC,KAAK,EAAE;UACLF,WAAW,EAAE,WAAW;UACxBH,IAAI,EAAE,OAAO;UACbI,OAAO,EAAE;QACX,CAAC;QACDE,KAAK,EAAE;UACLH,WAAW,EAAE,WAAW;UACxBH,IAAI,EAAE;QACR;MACF,CAAC;MACDO,MAAM,EAAE;QACNC,OAAO,EAAE;UACPL,WAAW,EAAE,UAAU;UACvBM,kBAAkB,EAAE,CAAC,MAAM;QAC7B;MACF;IACF,CAAC,CAAC;IAEF,MAAMC,UAAU,GAAG,IAAId,sBAAsB,CAAc,CAAC;IAC5Dc,UAAU,CAACC,gBAAgB,CAAC,wBAAwB,EAAGC,KAAK,IAAK;MAC/DlB,YAAY,CAACkB,KAAK,CAACC,MAAM,CAAC,CAACC,aAAa,CAEtC,CAAC;IACL,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFnB,EAAE,CAAC,oFAAoF,EAAE,MAAM;IAChFH,YAAY,CAAC;MACxBK,EAAE,EAAE,UAAU;MACdC,IAAI,EAAE,aAAa;MACnBC,WAAW,EAAE,oBAAoB;MACjCC,IAAI,EAAE,UAAU;MAChBC,UAAU,EAAE;QACVC,IAAI,EAAE;UACJC,WAAW,EAAE,SAAS;UACtBH,IAAI,EAAE,OAAO;UACbI,OAAO,EAAE;QACX,CAAC;QACDC,KAAK,EAAE;UACLF,WAAW,EAAE,WAAW;UACxBH,IAAI,EAAE,OAAO;UACbI,OAAO,EAAE;QACX,CAAC;QACDE,KAAK,EAAE;UACLH,WAAW,EAAE,WAAW;UACxBH,IAAI,EAAE;QACR;MACF,CAAC;MACDO,MAAM,EAAE;QACNC,OAAO,EAAE;UACPL,WAAW,EAAE,UAAU;UACvBM,kBAAkB,EAAE,CAAC,MAAM;QAC7B;MACF;IACF,CAAC,CAAC;IAEF,MAAMC,UAAU,GAAG,IAAId,sBAAsB,CAAc,CAAC;IAS5Dc,UAAU,CAACK,mBAAmB,CAAC,wBAAwB,EANlDH,KAAK,IAAK;MACblB,YAAY,CAACkB,KAAK,CAACC,MAAM,CAAC,CAACC,aAAa,CAEtC,CAAC;IACL,CAEiE,CAAC;EACpE,CAAC,CAAC;EAEFnB,EAAE,CAAC,2DAA2D,EAAE,MAAM;IACvDH,YAAY,CAAC;MACxBK,EAAE,EAAE,UAAU;MACdC,IAAI,EAAE,aAAa;MACnBC,WAAW,EAAE,oBAAoB;MACjCC,IAAI,EAAE,UAAU;MAChBC,UAAU,EAAE;QACVC,IAAI,EAAE;UACJC,WAAW,EAAE,SAAS;UACtBH,IAAI,EAAE,OAAO;UACbI,OAAO,EAAE;QACX;MACF,CAAC;MACDG,MAAM,EAAE;QACNC,OAAO,EAAE;UACPL,WAAW,EAAE,UAAU;UACvBM,kBAAkB,EAAE,CAAC,MAAM;QAC7B;MACF;IACF,CAAC,CAAC;IAEiB,IAAIb,sBAAsB,CAAc,CAAC;IAI5DF,YAAY,CAAwB,CAAC,CAACoB,aAAa,CAEjD,CAAC;EACL,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/build/browser/index.js

@@ -0,0 +1,20 @@
+/*
+ * 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 { defineConfig, HostMessage, isHostParametersUpdatedMessage } from "@osdk/widget.api";
+export { createFoundryWidgetClient } from "./client.js";
+export { FoundryHostEventTarget } from "./host.js";
+//# sourceMappingURL=index.js.map

package/build/browser/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["defineConfig","HostMessage","isHostParametersUpdatedMessage","createFoundryWidgetClient","FoundryHostEventTarget"],"sources":["index.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\nexport type {\n  AsyncFailedValue,\n  AsyncLoadedValue,\n  AsyncLoadingValue,\n  AsyncNotStartedLoadingValue,\n  AsyncParameterValueMap,\n  AsyncReloadingValue,\n  AsyncValue,\n  EventId,\n  EventParameterValueMap,\n  ParameterConfig,\n  ParameterValue,\n  ParameterValueMap,\n  WidgetConfig,\n  WidgetMessage,\n} from \"@osdk/widget.api\";\nexport {\n  defineConfig,\n  HostMessage,\n  isHostParametersUpdatedMessage,\n} from \"@osdk/widget.api\";\nexport { createFoundryWidgetClient } from \"./client.js\";\nexport type { FoundryWidgetClient } from \"./client.js\";\nexport { FoundryHostEventTarget } from \"./host.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAkBA,SACEA,YAAY,EACZC,WAAW,EACXC,8BAA8B,QACzB,kBAAkB;AACzB,SAASC,yBAAyB,QAAQ,aAAa;AAEvD,SAASC,sBAAsB,QAAQ,WAAW","ignoreList":[]}

package/build/cjs/index.cjs

@@ -0,0 +1,145 @@
+'use strict';
+
+var widget_api = require('@osdk/widget.api');
+var invariant = require('tiny-invariant');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var invariant__default = /*#__PURE__*/_interopDefault(invariant);
+
+// src/index.ts
+
+// src/host.ts
+var FoundryHostEventTarget = class 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
+    }));
+  }
+};
+
+// src/client.ts
+function createFoundryWidgetClient() {
+  if ("__PALANTIR_WIDGET_API__" in window) {
+    return _createFoundryWidgetClient(window.__PALANTIR_WIDGET_API__);
+  }
+  return _createFoundryWidgetClientLegacy();
+}
+function _createFoundryWidgetClient(widgetApi) {
+  const hostEventTarget = new FoundryHostEventTarget();
+  const listenForHostMessages = (event) => {
+    widget_api.visitHostMessage(event.detail, {
+      "host.update-parameters": (payload) => {
+        hostEventTarget.dispatchEventMessage("host.update-parameters", payload);
+      },
+      _unknown: () => {
+      }
+    });
+  };
+  const sendMessageToHost = (message) => {
+    widgetApi.sendMessage(message);
+  };
+  return {
+    hostEventTarget,
+    ready: () => {
+      sendMessageToHost({
+        type: "widget.ready",
+        payload: {
+          apiVersion: widget_api.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);
+    }
+  };
+}
+function _createFoundryWidgetClientLegacy() {
+  !window.parent ? process.env.NODE_ENV !== "production" ? invariant__default.default(false, "[FoundryWidgetClient] Must be run in an iframe") : invariant__default.default(false) : void 0;
+  const parentWindow = window.parent;
+  const metaTag = document.querySelector(`meta[name="${widget_api.META_TAG_HOST_ORIGIN}"]`);
+  !metaTag ? process.env.NODE_ENV !== "production" ? invariant__default.default(false, "[FoundryWidgetClient] Missing host origin meta tag " + widget_api.META_TAG_HOST_ORIGIN) : invariant__default.default(false) : void 0;
+  const hostOrigin = metaTag.getAttribute("content");
+  !hostOrigin ? process.env.NODE_ENV !== "production" ? invariant__default.default(false, "[FoundryWidgetClient] Missing host origin meta tag content") : invariant__default.default(false) : void 0;
+  const hostEventTarget = new FoundryHostEventTarget();
+  const listenForHostMessages = (event) => {
+    widget_api.visitHostMessage(event.data, {
+      "host.update-parameters": (payload) => {
+        hostEventTarget.dispatchEventMessage("host.update-parameters", payload);
+      },
+      _unknown: () => {
+      }
+    });
+  };
+  const sendMessageToHost = (message) => {
+    parentWindow.postMessage(message, hostOrigin);
+  };
+  return {
+    hostEventTarget,
+    ready: () => {
+      sendMessageToHost({
+        type: "widget.ready",
+        payload: {
+          apiVersion: widget_api.HostMessage.Version
+        }
+      });
+    },
+    emitEvent: (eventId, payload) => {
+      sendMessageToHost({
+        type: "widget.emit-event",
+        payload: {
+          eventId,
+          ...payload
+        }
+      });
+    },
+    sendMessage: sendMessageToHost,
+    subscribe: () => {
+      window.addEventListener("message", (event) => {
+        if (event.origin !== hostOrigin) {
+          return;
+        }
+        listenForHostMessages(event);
+      });
+    },
+    unsubscribe: () => {
+      window.removeEventListener("message", listenForHostMessages);
+    }
+  };
+}
+
+Object.defineProperty(exports, "HostMessage", {
+  enumerable: true,
+  get: function () { return widget_api.HostMessage; }
+});
+Object.defineProperty(exports, "defineConfig", {
+  enumerable: true,
+  get: function () { return widget_api.defineConfig; }
+});
+Object.defineProperty(exports, "isHostParametersUpdatedMessage", {
+  enumerable: true,
+  get: function () { return widget_api.isHostParametersUpdatedMessage; }
+});
+exports.FoundryHostEventTarget = FoundryHostEventTarget;
+exports.createFoundryWidgetClient = createFoundryWidgetClient;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/build/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/host.ts","../../src/client.ts"],"names":["visitHostMessage","HostMessage","invariant","META_TAG_HOST_ORIGIN"],"mappings":";;;;;;;;;;;;AAgBa,IAAA,sBAAA,GAAN,cAAqC,WAAY,CAAA;AAAA,EACtD,gBAAA,CAAiB,IAAM,EAAA,QAAA,EAAU,OAAS,EAAA;AACxC,IAAM,KAAA,CAAA,gBAAA,CAAiB,IAAM,EAAA,QAAA,EAAU,OAAO,CAAA;AAAA;AAChD,EACA,mBAAA,CAAoB,IAAM,EAAA,QAAA,EAAU,OAAS,EAAA;AAC3C,IAAM,KAAA,CAAA,mBAAA,CAAoB,IAAM,EAAA,QAAA,EAAU,OAAO,CAAA;AAAA;AACnD,EACA,oBAAA,CAAqB,MAAM,OAAS,EAAA;AAClC,IAAK,IAAA,CAAA,aAAA,CAAc,IAAI,WAAA,CAAY,IAAM,EAAA;AAAA,MACvC,MAAQ,EAAA;AAAA,KACT,CAAC,CAAA;AAAA;AAEN;;;ACRO,SAAS,yBAA4B,GAAA;AAC1C,EAAA,IAAI,6BAA6B,MAAQ,EAAA;AACvC,IAAO,OAAA,0BAAA,CAA2B,OAAO,uBAAuB,CAAA;AAAA;AAGlE,EAAA,OAAO,gCAAiC,EAAA;AAC1C;AACA,SAAS,2BAA2B,SAAW,EAAA;AAC7C,EAAM,MAAA,eAAA,GAAkB,IAAI,sBAAuB,EAAA;AACnD,EAAA,MAAM,wBAAwB,CAAS,KAAA,KAAA;AACrC,IAAAA,2BAAA,CAAiB,MAAM,MAAQ,EAAA;AAAA,MAC7B,0BAA0B,CAAW,OAAA,KAAA;AACnC,QAAgB,eAAA,CAAA,oBAAA,CAAqB,0BAA0B,OAAO,CAAA;AAAA,OACxE;AAAA,MACA,UAAU,MAAM;AAAA;AAEhB,KACD,CAAA;AAAA,GACH;AACA,EAAA,MAAM,oBAAoB,CAAW,OAAA,KAAA;AACnC,IAAA,SAAA,CAAU,YAAY,OAAO,CAAA;AAAA,GAC/B;AACA,EAAO,OAAA;AAAA,IACL,eAAA;AAAA,IACA,OAAO,MAAM;AACX,MAAkB,iBAAA,CAAA;AAAA,QAChB,IAAM,EAAA,cAAA;AAAA,QACN,OAAS,EAAA;AAAA,UACP,YAAYC,sBAAY,CAAA;AAAA;AAC1B,OACD,CAAA;AAAA,KACH;AAAA,IACA,SAAA,EAAW,CAAC,OAAA,EAAS,OAAY,KAAA;AAC/B,MAAkB,iBAAA,CAAA;AAAA,QAChB,IAAM,EAAA,mBAAA;AAAA,QACN,OAAS,EAAA;AAAA,UACP,OAAA;AAAA,UACA,GAAG;AAAA;AACL,OACD,CAAA;AAAA,KACH;AAAA,IACA,WAAa,EAAA,iBAAA;AAAA,IACb,WAAW,MAAM;AACf,MAAU,SAAA,CAAA,gBAAA,CAAiB,WAAW,qBAAqB,CAAA;AAAA,KAC7D;AAAA,IACA,aAAa,MAAM;AACjB,MAAU,SAAA,CAAA,mBAAA,CAAoB,WAAW,qBAAqB,CAAA;AAAA;AAChE,GACF;AACF;AAGA,SAAS,gCAAmC,GAAA;AAC1C,EAAA,CAAC,MAAO,CAAA,MAAA,GAAS,OAAQ,CAAA,GAAA,CAAI,QAAa,KAAA,YAAA,GAAeC,0BAAU,CAAA,KAAA,EAAO,gDAAgD,CAAA,GAAIA,0BAAU,CAAA,KAAK,CAAI,GAAA,MAAA;AACjJ,EAAA,MAAM,eAAe,MAAO,CAAA,MAAA;AAC5B,EAAA,MAAM,OAAU,GAAA,QAAA,CAAS,aAAc,CAAA,CAAA,WAAA,EAAcC,+BAAoB,CAAI,EAAA,CAAA,CAAA;AAC7E,EAAA,CAAC,OAAU,GAAA,OAAA,CAAQ,GAAI,CAAA,QAAA,KAAa,YAAe,GAAAD,0BAAA,CAAU,KAAO,EAAA,qDAAA,GAAwDC,+BAAoB,CAAA,GAAID,0BAAU,CAAA,KAAK,CAAI,GAAA,MAAA;AACvK,EAAM,MAAA,UAAA,GAAa,OAAQ,CAAA,YAAA,CAAa,SAAS,CAAA;AACjD,EAAC,CAAA,UAAA,GAAa,OAAQ,CAAA,GAAA,CAAI,QAAa,KAAA,YAAA,GAAeA,0BAAU,CAAA,KAAA,EAAO,4DAA4D,CAAA,GAAIA,0BAAU,CAAA,KAAK,CAAI,GAAA,MAAA;AAC1J,EAAM,MAAA,eAAA,GAAkB,IAAI,sBAAuB,EAAA;AACnD,EAAA,MAAM,wBAAwB,CAAS,KAAA,KAAA;AACrC,IAAAF,2BAAA,CAAiB,MAAM,IAAM,EAAA;AAAA,MAC3B,0BAA0B,CAAW,OAAA,KAAA;AACnC,QAAgB,eAAA,CAAA,oBAAA,CAAqB,0BAA0B,OAAO,CAAA;AAAA,OACxE;AAAA,MACA,UAAU,MAAM;AAAA;AAEhB,KACD,CAAA;AAAA,GACH;AACA,EAAA,MAAM,oBAAoB,CAAW,OAAA,KAAA;AACnC,IAAa,YAAA,CAAA,WAAA,CAAY,SAAS,UAAU,CAAA;AAAA,GAC9C;AACA,EAAO,OAAA;AAAA,IACL,eAAA;AAAA,IACA,OAAO,MAAM;AACX,MAAkB,iBAAA,CAAA;AAAA,QAChB,IAAM,EAAA,cAAA;AAAA,QACN,OAAS,EAAA;AAAA,UACP,YAAYC,sBAAY,CAAA;AAAA;AAC1B,OACD,CAAA;AAAA,KACH;AAAA,IACA,SAAA,EAAW,CAAC,OAAA,EAAS,OAAY,KAAA;AAC/B,MAAkB,iBAAA,CAAA;AAAA,QAChB,IAAM,EAAA,mBAAA;AAAA,QACN,OAAS,EAAA;AAAA,UACP,OAAA;AAAA,UACA,GAAG;AAAA;AACL,OACD,CAAA;AAAA,KACH;AAAA,IACA,WAAa,EAAA,iBAAA;AAAA,IACb,WAAW,MAAM;AACf,MAAO,MAAA,CAAA,gBAAA,CAAiB,WAAW,CAAS,KAAA,KAAA;AAC1C,QAAI,IAAA,KAAA,CAAM,WAAW,UAAY,EAAA;AAE/B,UAAA;AAAA;AAEF,QAAA,qBAAA,CAAsB,KAAK,CAAA;AAAA,OAC5B,CAAA;AAAA,KACH;AAAA,IACA,aAAa,MAAM;AACjB,MAAO,MAAA,CAAA,mBAAA,CAAoB,WAAW,qBAAqB,CAAA;AAAA;AAC7D,GACF;AACF","file":"index.cjs","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\nexport class FoundryHostEventTarget extends EventTarget {\n  addEventListener(type, callback, options) {\n    super.addEventListener(type, callback, options);\n  }\n  removeEventListener(type, callback, options) {\n    super.removeEventListener(type, callback, options);\n  }\n  dispatchEventMessage(type, payload) {\n    this.dispatchEvent(new CustomEvent(type, {\n      detail: payload\n    }));\n  }\n}","/*\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 { HostMessage, visitHostMessage } from \"@osdk/widget.api\";\nimport { META_TAG_HOST_ORIGIN } from \"@osdk/widget.api\";\nimport invariant from \"tiny-invariant\";\nimport { FoundryHostEventTarget } from \"./host.js\";\nexport function createFoundryWidgetClient() {\n  if (\"__PALANTIR_WIDGET_API__\" in window) {\n    return _createFoundryWidgetClient(window.__PALANTIR_WIDGET_API__);\n  }\n  // todo: drop support for sandbox v1\n  return _createFoundryWidgetClientLegacy();\n}\nfunction _createFoundryWidgetClient(widgetApi) {\n  const hostEventTarget = new FoundryHostEventTarget();\n  const listenForHostMessages = event => {\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 = message => {\n    widgetApi.sendMessage(message);\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  !window.parent ? process.env.NODE_ENV !== \"production\" ? invariant(false, \"[FoundryWidgetClient] Must be run in an iframe\") : invariant(false) : void 0;\n  const parentWindow = window.parent;\n  const metaTag = document.querySelector(`meta[name=\"${META_TAG_HOST_ORIGIN}\"]`);\n  !metaTag ? process.env.NODE_ENV !== \"production\" ? invariant(false, \"[FoundryWidgetClient] Missing host origin meta tag \" + META_TAG_HOST_ORIGIN) : invariant(false) : void 0;\n  const hostOrigin = metaTag.getAttribute(\"content\");\n  !hostOrigin ? process.env.NODE_ENV !== \"production\" ? invariant(false, \"[FoundryWidgetClient] Missing host origin meta tag content\") : invariant(false) : void 0;\n  const hostEventTarget = new FoundryHostEventTarget();\n  const listenForHostMessages = event => {\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 = message => {\n    parentWindow.postMessage(message, hostOrigin);\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}"]}

package/build/cjs/index.d.cts

@@ -0,0 +1,55 @@
+import { WidgetConfig, HostMessage, WidgetMessage } from '@osdk/widget.api';
+export { AsyncFailedValue, AsyncLoadedValue, AsyncLoadingValue, AsyncNotStartedLoadingValue, AsyncParameterValueMap, AsyncReloadingValue, AsyncValue, EventId, EventParameterValueMap, HostMessage, ParameterConfig, ParameterValue, ParameterValueMap, WidgetConfig, WidgetMessage, defineConfig, isHostParametersUpdatedMessage } from '@osdk/widget.api';
+
+interface HostMessageEventListener<P extends HostMessage.Payload> {
+    (event: CustomEvent<P>): void;
+}
+interface HostMessageEventListenerObject<P extends HostMessage.Payload> {
+    handleEvent(object: CustomEvent<P>): void;
+}
+declare class FoundryHostEventTarget<C extends WidgetConfig<C["parameters"]>> extends EventTarget {
+    addEventListener<T extends HostMessage<C>["type"]>(type: T, callback: HostMessageEventListener<(HostMessage<C> & {
+        type: T;
+    })["payload"]> | HostMessageEventListenerObject<(HostMessage<C> & {
+        type: T;
+    })["payload"]> | null, options?: AddEventListenerOptions | boolean): void;
+    removeEventListener<T extends HostMessage<C>["type"]>(type: T, callback: HostMessageEventListener<(HostMessage<C> & {
+        type: T;
+    })["payload"]> | HostMessageEventListenerObject<(HostMessage<C> & {
+        type: T;
+    })["payload"]> | null, options?: EventListenerOptions | boolean): void;
+    dispatchEventMessage<T extends HostMessage<C>["type"]>(type: T, payload: (HostMessage<C> & {
+        type: T;
+    })["payload"]): void;
+}
+
+interface FoundryWidgetClient<C extends WidgetConfig<C["parameters"]>> {
+    /**
+     * Notifies the host that this client is ready to receive the first parameter values
+     */
+    ready: () => void;
+    /**
+     * Emits an event with the given ID and payload
+     */
+    emitEvent: <M extends WidgetMessage.EmitEvent<C>>(eventId: M["payload"]["eventId"], payload: Omit<M["payload"], "eventId">) => void;
+    /**
+     * Sends a message to the parent frame.
+     * It is recommended to use the convenience methods for individual messages (e.g. ready or emitEvent) instead
+     */
+    sendMessage: <M extends WidgetMessage<C>>(message: M) => void;
+    /**
+     * Subscribes to events from the host, invoking the listener when a message is received
+     */
+    subscribe: () => void;
+    /**
+     * Unsubscribes a previously subscribed listener from host events, if one exists
+     */
+    unsubscribe: () => void;
+    /**
+     * Event targets on which you can subscribe to specific host messages
+     */
+    hostEventTarget: FoundryHostEventTarget<C>;
+}
+declare function createFoundryWidgetClient<C extends WidgetConfig<C["parameters"]>>(): FoundryWidgetClient<C>;
+
+export { FoundryHostEventTarget, type FoundryWidgetClient, createFoundryWidgetClient };

package/build/esm/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/esm/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/esm/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/esm/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":[]}