@osdk/widget.client-react 2.1.0

package/build/browser/utils/initializeParameters.js

@@ -0,0 +1,28 @@
+/*
+ * 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.
+ */
+
+/**
+ * Utility function to initialize a map of parameter values to either a loading or not-started loading state
+ */
+export function initializeParameters(config, initialLoadingState) {
+  return Object.fromEntries(Object.entries(config.parameters).map(([key, parameterConfig]) => [key, {
+    type: parameterConfig.type,
+    value: {
+      type: initialLoadingState
+    }
+  }]));
+}
+//# sourceMappingURL=initializeParameters.js.map

package/build/browser/utils/initializeParameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initializeParameters.js","names":["initializeParameters","config","initialLoadingState","Object","fromEntries","entries","parameters","map","key","parameterConfig","type","value"],"sources":["initializeParameters.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 { AsyncParameterValueMap, WidgetConfig } from \"@osdk/widget.client\";\n\n/**\n * Utility function to initialize a map of parameter values to either a loading or not-started loading state\n */\nexport function initializeParameters<C extends WidgetConfig<C[\"parameters\"]>>(\n  config: C,\n  initialLoadingState: \"loading\" | \"not-started\",\n): AsyncParameterValueMap<C> {\n  return Object.fromEntries(\n    Object.entries(config.parameters).map(([key, parameterConfig]) => [\n      key,\n      { type: parameterConfig.type, value: { type: initialLoadingState } },\n    ]),\n  ) as AsyncParameterValueMap<C>;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA;AACA;AACA;AACA,OAAO,SAASA,oBAAoBA,CAClCC,MAAS,EACTC,mBAA8C,EACnB;EAC3B,OAAOC,MAAM,CAACC,WAAW,CACvBD,MAAM,CAACE,OAAO,CAACJ,MAAM,CAACK,UAAU,CAAC,CAACC,GAAG,CAAC,CAAC,CAACC,GAAG,EAAEC,eAAe,CAAC,KAAK,CAChED,GAAG,EACH;IAAEE,IAAI,EAAED,eAAe,CAACC,IAAI;IAAEC,KAAK,EAAE;MAAED,IAAI,EAAER;IAAoB;EAAE,CAAC,CACrE,CACH,CAAC;AACH","ignoreList":[]}

package/build/cjs/index.cjs

@@ -0,0 +1,132 @@
+'use strict';
+
+var widget_client = require('@osdk/widget.client');
+var React2 = require('react');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var React2__default = /*#__PURE__*/_interopDefault(React2);
+
+// src/client.tsx
+var FoundryWidgetContext = /* @__PURE__ */ React2__default.default.createContext({
+  emitEvent: () => {
+  },
+  hostEventTarget: new widget_client.FoundryHostEventTarget(),
+  asyncParameterValues: {},
+  parameters: {
+    state: "not-started",
+    values: {}
+  }
+});
+function useFoundryWidgetContext() {
+  return React2.useContext(FoundryWidgetContext);
+}
+(function(_useFoundryWidgetContext) {
+  function withTypes() {
+    return () => {
+      return useFoundryWidgetContext();
+    };
+  }
+  _useFoundryWidgetContext.withTypes = withTypes;
+})(useFoundryWidgetContext || (useFoundryWidgetContext = {}));
+
+// src/utils/initializeParameters.ts
+function initializeParameters(config, initialLoadingState) {
+  return Object.fromEntries(Object.entries(config.parameters).map(([key, parameterConfig]) => [key, {
+    type: parameterConfig.type,
+    value: {
+      type: initialLoadingState
+    }
+  }]));
+}
+
+// src/client.tsx
+var FoundryWidget = ({
+  children,
+  config,
+  initialValues
+}) => {
+  const client = React2.useMemo(() => widget_client.createFoundryWidgetClient(), []);
+  const [asyncParameterValues, setAsyncParameterValues] = React2__default.default.useState(initialValues ?? initializeParameters(config, "not-started"));
+  const [allParameterValues, setAllParameterValues] = React2__default.default.useState({
+    type: "not-started"
+  });
+  React2.useEffect(() => {
+    client.subscribe();
+    client.hostEventTarget.addEventListener("host.update-parameters", (payload) => {
+      setAsyncParameterValues((currentParameters) => ({
+        ...currentParameters,
+        ...payload.detail.parameters
+      }));
+      setAllParameterValues((currentParameters) => {
+        let aggregatedLoadedState = "loaded";
+        let firstError;
+        const newParameterValues = {};
+        for (const key in payload.detail.parameters) {
+          const value = payload.detail.parameters[key].value;
+          if (value.type === "failed") {
+            aggregatedLoadedState = "failed";
+            firstError = firstError ?? value.error;
+            newParameterValues[key] = value.value;
+            continue;
+          }
+          if (value.type === "loading" && aggregatedLoadedState !== "failed") {
+            aggregatedLoadedState = "loading";
+            continue;
+          }
+          if (value.type === "reloading" && aggregatedLoadedState !== "failed" && aggregatedLoadedState !== "loading") {
+            aggregatedLoadedState = "reloading";
+            newParameterValues[key] = value.value;
+            continue;
+          }
+          if (value.type === "not-started" && aggregatedLoadedState !== "failed" && aggregatedLoadedState !== "loading" && aggregatedLoadedState !== "reloading") {
+            aggregatedLoadedState = "not-started";
+          }
+          if (value.type === "loaded") {
+            newParameterValues[key] = value.value;
+          }
+        }
+        const currentParameterValue = currentParameters.type !== "not-started" && currentParameters.type !== "loading" ? currentParameters.value : {};
+        if (aggregatedLoadedState !== "not-started" && aggregatedLoadedState !== "loading") {
+          const updatedValue = {
+            ...currentParameterValue,
+            ...newParameterValues
+          };
+          return aggregatedLoadedState === "failed" ? {
+            type: aggregatedLoadedState,
+            value: updatedValue,
+            error: firstError ?? new Error("Failed to load parameters")
+          } : {
+            type: aggregatedLoadedState,
+            value: updatedValue
+          };
+        } else {
+          return {
+            type: aggregatedLoadedState
+          };
+        }
+      });
+    });
+    client.ready();
+    return () => {
+      client.unsubscribe();
+    };
+  }, []);
+  return /* @__PURE__ */ React2__default.default.createElement(FoundryWidgetContext.Provider, {
+    value: {
+      emitEvent: client.emitEvent,
+      hostEventTarget: client.hostEventTarget,
+      asyncParameterValues,
+      parameters: {
+        values: allParameterValues.value ?? {},
+        state: allParameterValues.type
+      }
+      // Unfortunately the context is statically defined so we can't use the generic type, hence the cast
+    }
+  }, children);
+};
+
+exports.FoundryWidget = FoundryWidget;
+exports.useFoundryWidgetContext = useFoundryWidgetContext;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/build/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/context.ts","../../src/utils/initializeParameters.ts","../../src/client.tsx"],"names":["FoundryHostEventTarget","useContext","useMemo","createFoundryWidgetClient","React","useEffect"],"mappings":";;;;;;;;;;AAkBO,IAAM,oBAAA,2CAA0C,aAAc,CAAA;AAAA,EACnE,WAAW,MAAM;AAAA,GAAC;AAAA,EAClB,eAAA,EAAiB,IAAIA,oCAAuB,EAAA;AAAA,EAC5C,sBAAsB,EAAC;AAAA,EACvB,UAAY,EAAA;AAAA,IACV,KAAO,EAAA,aAAA;AAAA,IACP,QAAQ;AAAC;AAEb,CAAC,CAAA;AAKM,SAAS,uBAA0B,GAAA;AACxC,EAAA,OAAOC,kBAAW,oBAAoB,CAAA;AACxC;AAAA,CACC,SAAU,wBAA0B,EAAA;AACnC,EAAA,SAAS,SAAY,GAAA;AACnB,IAAA,OAAO,MAAM;AACX,MAAA,OAAO,uBAAwB,EAAA;AAAA,KACjC;AAAA;AAEF,EAAA,wBAAA,CAAyB,SAAY,GAAA,SAAA;AACvC,CAAG,EAAA,uBAAA,KAA4B,uBAA0B,GAAA,EAAG,CAAA,CAAA;;;ACtBrD,SAAS,oBAAA,CAAqB,QAAQ,mBAAqB,EAAA;AAChE,EAAA,OAAO,MAAO,CAAA,WAAA,CAAY,MAAO,CAAA,OAAA,CAAQ,OAAO,UAAU,CAAA,CAAE,GAAI,CAAA,CAAC,CAAC,GAAA,EAAK,eAAe,CAAA,KAAM,CAAC,GAAK,EAAA;AAAA,IAChG,MAAM,eAAgB,CAAA,IAAA;AAAA,IACtB,KAAO,EAAA;AAAA,MACL,IAAM,EAAA;AAAA;AACR,GACD,CAAC,CAAC,CAAA;AACL;;;ACHO,IAAM,gBAAgB,CAAC;AAAA,EAC5B,QAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAM,KAAA;AACJ,EAAA,MAAM,SAASC,cAAQ,CAAA,MAAMC,uCAA0B,EAAA,EAAG,EAAE,CAAA;AAC5D,EAAM,MAAA,CAAC,oBAAsB,EAAA,uBAAuB,CAAIC,GAAAA,uBAAAA,CAAM,SAAS,aAAiB,IAAA,oBAAA,CAAqB,MAAQ,EAAA,aAAa,CAAC,CAAA;AACnI,EAAA,MAAM,CAAC,kBAAA,EAAoB,qBAAqB,CAAA,GAAIA,wBAAM,QAAS,CAAA;AAAA,IACjE,IAAM,EAAA;AAAA,GACP,CAAA;AACD,EAAAC,gBAAA,CAAU,MAAM;AACd,IAAA,MAAA,CAAO,SAAU,EAAA;AACjB,IAAO,MAAA,CAAA,eAAA,CAAgB,gBAAiB,CAAA,wBAAA,EAA0B,CAAW,OAAA,KAAA;AAC3E,MAAA,uBAAA,CAAwB,CAAsB,iBAAA,MAAA;AAAA,QAC5C,GAAG,iBAAA;AAAA,QACH,GAAG,QAAQ,MAAO,CAAA;AAAA,OAClB,CAAA,CAAA;AACF,MAAA,qBAAA,CAAsB,CAAqB,iBAAA,KAAA;AACzC,QAAA,IAAI,qBAAwB,GAAA,QAAA;AAC5B,QAAI,IAAA,UAAA;AACJ,QAAA,MAAM,qBAAqB,EAAC;AAC5B,QAAW,KAAA,MAAA,GAAA,IAAO,OAAQ,CAAA,MAAA,CAAO,UAAY,EAAA;AAC3C,UAAA,MAAM,KAAQ,GAAA,OAAA,CAAQ,MAAO,CAAA,UAAA,CAAW,GAAG,CAAE,CAAA,KAAA;AAE7C,UAAI,IAAA,KAAA,CAAM,SAAS,QAAU,EAAA;AAC3B,YAAwB,qBAAA,GAAA,QAAA;AACxB,YAAA,UAAA,GAAa,cAAc,KAAM,CAAA,KAAA;AACjC,YAAmB,kBAAA,CAAA,GAAG,IAAI,KAAM,CAAA,KAAA;AAChC,YAAA;AAAA;AAGF,UAAA,IAAI,KAAM,CAAA,IAAA,KAAS,SAAa,IAAA,qBAAA,KAA0B,QAAU,EAAA;AAClE,YAAwB,qBAAA,GAAA,SAAA;AACxB,YAAA;AAAA;AAGF,UAAA,IAAI,MAAM,IAAS,KAAA,WAAA,IAAe,qBAA0B,KAAA,QAAA,IAAY,0BAA0B,SAAW,EAAA;AAC3G,YAAwB,qBAAA,GAAA,WAAA;AACxB,YAAmB,kBAAA,CAAA,GAAG,IAAI,KAAM,CAAA,KAAA;AAChC,YAAA;AAAA;AAEF,UAAI,IAAA,KAAA,CAAM,SAAS,aAAiB,IAAA,qBAAA,KAA0B,YAAY,qBAA0B,KAAA,SAAA,IAAa,0BAA0B,WAAa,EAAA;AACtJ,YAAwB,qBAAA,GAAA,aAAA;AAAA;AAE1B,UAAI,IAAA,KAAA,CAAM,SAAS,QAAU,EAAA;AAC3B,YAAmB,kBAAA,CAAA,GAAG,IAAI,KAAM,CAAA,KAAA;AAAA;AAClC;AAEF,QAAM,MAAA,qBAAA,GAAwB,kBAAkB,IAAS,KAAA,aAAA,IAAiB,kBAAkB,IAAS,KAAA,SAAA,GAAY,iBAAkB,CAAA,KAAA,GAAQ,EAAC;AAC5I,QAAI,IAAA,qBAAA,KAA0B,aAAiB,IAAA,qBAAA,KAA0B,SAAW,EAAA;AAClF,UAAA,MAAM,YAAe,GAAA;AAAA,YACnB,GAAG,qBAAA;AAAA,YACH,GAAG;AAAA,WACL;AACA,UAAA,OAAO,0BAA0B,QAAW,GAAA;AAAA,YAC1C,IAAM,EAAA,qBAAA;AAAA,YACN,KAAO,EAAA,YAAA;AAAA,YACP,KAAO,EAAA,UAAA,IAAc,IAAI,KAAA,CAAM,2BAA2B;AAAA,WACxD,GAAA;AAAA,YACF,IAAM,EAAA,qBAAA;AAAA,YACN,KAAO,EAAA;AAAA,WACT;AAAA,SACK,MAAA;AACL,UAAO,OAAA;AAAA,YACL,IAAM,EAAA;AAAA,WACR;AAAA;AACF,OACD,CAAA;AAAA,KACF,CAAA;AACD,IAAA,MAAA,CAAO,KAAM,EAAA;AACb,IAAA,OAAO,MAAM;AACX,MAAA,MAAA,CAAO,WAAY,EAAA;AAAA,KACrB;AAAA,GACF,EAAG,EAAE,CAAA;AACL,EAAA,uBAAoBD,uBAAAA,CAAM,aAAc,CAAA,oBAAA,CAAqB,QAAU,EAAA;AAAA,IACrE,KAAO,EAAA;AAAA,MACL,WAAW,MAAO,CAAA,SAAA;AAAA,MAClB,iBAAiB,MAAO,CAAA,eAAA;AAAA,MACxB,oBAAA;AAAA,MACA,UAAY,EAAA;AAAA,QACV,MAAA,EAAQ,kBAAmB,CAAA,KAAA,IAAS,EAAC;AAAA,QACrC,OAAO,kBAAmB,CAAA;AAAA;AAC5B;AAAA;AAEF,KACC,QAAQ,CAAA;AACb","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\nimport { FoundryHostEventTarget } from \"@osdk/widget.client\";\nimport React, { useContext } from \"react\";\nexport const FoundryWidgetContext = /*#__PURE__*/React.createContext({\n  emitEvent: () => {},\n  hostEventTarget: new FoundryHostEventTarget(),\n  asyncParameterValues: {},\n  parameters: {\n    state: \"not-started\",\n    values: {}\n  }\n});\n\n/**\n * @returns The current FoundryWidgetClientContext, in the context of your specific parameter configuration\n */\nexport function useFoundryWidgetContext() {\n  return useContext(FoundryWidgetContext);\n}\n(function (_useFoundryWidgetContext) {\n  function withTypes() {\n    return () => {\n      return useFoundryWidgetContext();\n    };\n  }\n  _useFoundryWidgetContext.withTypes = withTypes;\n})(useFoundryWidgetContext || (useFoundryWidgetContext = {}));","/*\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\n/**\n * Utility function to initialize a map of parameter values to either a loading or not-started loading state\n */\nexport function initializeParameters(config, initialLoadingState) {\n  return Object.fromEntries(Object.entries(config.parameters).map(([key, parameterConfig]) => [key, {\n    type: parameterConfig.type,\n    value: {\n      type: initialLoadingState\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 { createFoundryWidgetClient } from \"@osdk/widget.client\";\nimport React, { useEffect, useMemo } from \"react\";\nimport { FoundryWidgetContext } from \"./context.js\";\nimport { initializeParameters } from \"./utils/initializeParameters.js\";\n/**\n * Handles subscribing to messages from the host Foundry UI and updating the widget's parameter values accordingly via React context\n */\nexport const FoundryWidget = ({\n  children,\n  config,\n  initialValues\n}) => {\n  const client = useMemo(() => createFoundryWidgetClient(), []);\n  const [asyncParameterValues, setAsyncParameterValues] = React.useState(initialValues ?? initializeParameters(config, \"not-started\"));\n  const [allParameterValues, setAllParameterValues] = React.useState({\n    type: \"not-started\"\n  });\n  useEffect(() => {\n    client.subscribe();\n    client.hostEventTarget.addEventListener(\"host.update-parameters\", payload => {\n      setAsyncParameterValues(currentParameters => ({\n        ...currentParameters,\n        ...payload.detail.parameters\n      }));\n      setAllParameterValues(currentParameters => {\n        let aggregatedLoadedState = \"loaded\";\n        let firstError;\n        const newParameterValues = {};\n        for (const key in payload.detail.parameters) {\n          const value = payload.detail.parameters[key].value;\n          // If any fails, consider the whole thing failed\n          if (value.type === \"failed\") {\n            aggregatedLoadedState = \"failed\";\n            firstError = firstError ?? value.error;\n            newParameterValues[key] = value.value;\n            continue;\n          }\n          // If any is loading, consider all of it loading unless we have failed somewhere\n          if (value.type === \"loading\" && aggregatedLoadedState !== \"failed\") {\n            aggregatedLoadedState = \"loading\";\n            continue;\n          }\n          // If any is reloading, consider it loading unless something is failed or loading for the first time\n          if (value.type === \"reloading\" && aggregatedLoadedState !== \"failed\" && aggregatedLoadedState !== \"loading\") {\n            aggregatedLoadedState = \"reloading\";\n            newParameterValues[key] = value.value;\n            continue;\n          }\n          if (value.type === \"not-started\" && aggregatedLoadedState !== \"failed\" && aggregatedLoadedState !== \"loading\" && aggregatedLoadedState !== \"reloading\") {\n            aggregatedLoadedState = \"not-started\";\n          }\n          if (value.type === \"loaded\") {\n            newParameterValues[key] = value.value;\n          }\n        }\n        const currentParameterValue = currentParameters.type !== \"not-started\" && currentParameters.type !== \"loading\" ? currentParameters.value : {};\n        if (aggregatedLoadedState !== \"not-started\" && aggregatedLoadedState !== \"loading\") {\n          const updatedValue = {\n            ...currentParameterValue,\n            ...newParameterValues\n          };\n          return aggregatedLoadedState === \"failed\" ? {\n            type: aggregatedLoadedState,\n            value: updatedValue,\n            error: firstError ?? new Error(\"Failed to load parameters\")\n          } : {\n            type: aggregatedLoadedState,\n            value: updatedValue\n          };\n        } else {\n          return {\n            type: aggregatedLoadedState\n          };\n        }\n      });\n    });\n    client.ready();\n    return () => {\n      client.unsubscribe();\n    };\n  }, []);\n  return /*#__PURE__*/React.createElement(FoundryWidgetContext.Provider, {\n    value: {\n      emitEvent: client.emitEvent,\n      hostEventTarget: client.hostEventTarget,\n      asyncParameterValues,\n      parameters: {\n        values: allParameterValues.value ?? {},\n        state: allParameterValues.type\n      }\n      // Unfortunately the context is statically defined so we can't use the generic type, hence the cast\n    }\n  }, children);\n};"]}

package/build/cjs/index.d.cts

@@ -0,0 +1,45 @@
+import { WidgetConfig, AsyncParameterValueMap, FoundryWidgetClient, FoundryHostEventTarget, ParameterValueMap, AsyncValue } from '@osdk/widget.client';
+import React from 'react';
+
+interface FoundryWidgetProps<C extends WidgetConfig<C["parameters"]>> {
+    children: React.ReactNode;
+    /**
+     * Parameter configuration for the widget
+     */
+    config: C;
+    /**
+     * Customize what the initial value of each parameter should be
+     *
+     * @default Sets all parameters to the "not-started" loading state
+     */
+    initialValues?: AsyncParameterValueMap<C>;
+}
+/**
+ * Handles subscribing to messages from the host Foundry UI and updating the widget's parameter values accordingly via React context
+ */
+declare const FoundryWidget: <C extends WidgetConfig<C["parameters"]>>({ children, config, initialValues, }: FoundryWidgetProps<C>) => React.ReactElement<FoundryWidgetProps<C>>;
+
+interface FoundryWidgetClientContext<C extends WidgetConfig<C["parameters"]>> {
+    emitEvent: FoundryWidgetClient<C>["emitEvent"];
+    hostEventTarget: FoundryHostEventTarget<C>;
+    /**
+     * Object where the individual parameters have their async state represented
+     */
+    asyncParameterValues: AsyncParameterValueMap<C>;
+    /**
+     * Convenience object that aggregates the value of all parameters, accounting for their loading states
+     */
+    parameters: {
+        values: Partial<ParameterValueMap<C>>;
+        state: AsyncValue<ParameterValueMap<C>>["type"];
+    };
+}
+/**
+ * @returns The current FoundryWidgetClientContext, in the context of your specific parameter configuration
+ */
+declare function useFoundryWidgetContext<C extends WidgetConfig<C["parameters"]>>(): FoundryWidgetClientContext<C>;
+declare namespace useFoundryWidgetContext {
+    function withTypes<C extends WidgetConfig<C["parameters"]>>(): () => FoundryWidgetClientContext<C>;
+}
+
+export { FoundryWidget, type FoundryWidgetClientContext, useFoundryWidgetContext };

package/build/esm/client.js

@@ -0,0 +1,111 @@
+/*
+ * 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 { createFoundryWidgetClient } from "@osdk/widget.client";
+import React, { useEffect, useMemo } from "react";
+import { FoundryWidgetContext } from "./context.js";
+import { initializeParameters } from "./utils/initializeParameters.js";
+/**
+ * Handles subscribing to messages from the host Foundry UI and updating the widget's parameter values accordingly via React context
+ */
+export const FoundryWidget = ({
+  children,
+  config,
+  initialValues
+}) => {
+  const client = useMemo(() => createFoundryWidgetClient(), []);
+  const [asyncParameterValues, setAsyncParameterValues] = React.useState(initialValues ?? initializeParameters(config, "not-started"));
+  const [allParameterValues, setAllParameterValues] = React.useState({
+    type: "not-started"
+  });
+  useEffect(() => {
+    client.subscribe();
+    client.hostEventTarget.addEventListener("host.update-parameters", payload => {
+      setAsyncParameterValues(currentParameters => ({
+        ...currentParameters,
+        ...payload.detail.parameters
+      }));
+      setAllParameterValues(currentParameters => {
+        let aggregatedLoadedState = "loaded";
+        let firstError;
+        const newParameterValues = {};
+        for (const key in payload.detail.parameters) {
+          const value = payload.detail.parameters[key].value;
+          // If any fails, consider the whole thing failed
+          if (value.type === "failed") {
+            aggregatedLoadedState = "failed";
+            firstError = firstError ?? value.error;
+            newParameterValues[key] = value.value;
+            continue;
+          }
+          // If any is loading, consider all of it loading unless we have failed somewhere
+          if (value.type === "loading" && aggregatedLoadedState !== "failed") {
+            aggregatedLoadedState = "loading";
+            continue;
+          }
+          // If any is reloading, consider it loading unless something is failed or loading for the first time
+          if (value.type === "reloading" && aggregatedLoadedState !== "failed" && aggregatedLoadedState !== "loading") {
+            aggregatedLoadedState = "reloading";
+            newParameterValues[key] = value.value;
+            continue;
+          }
+          if (value.type === "not-started" && aggregatedLoadedState !== "failed" && aggregatedLoadedState !== "loading" && aggregatedLoadedState !== "reloading") {
+            aggregatedLoadedState = "not-started";
+          }
+          if (value.type === "loaded") {
+            newParameterValues[key] = value.value;
+          }
+        }
+        const currentParameterValue = currentParameters.type !== "not-started" && currentParameters.type !== "loading" ? currentParameters.value : {};
+        if (aggregatedLoadedState !== "not-started" && aggregatedLoadedState !== "loading") {
+          const updatedValue = {
+            ...currentParameterValue,
+            ...newParameterValues
+          };
+          return aggregatedLoadedState === "failed" ? {
+            type: aggregatedLoadedState,
+            value: updatedValue,
+            error: firstError ?? new Error("Failed to load parameters")
+          } : {
+            type: aggregatedLoadedState,
+            value: updatedValue
+          };
+        } else {
+          return {
+            type: aggregatedLoadedState
+          };
+        }
+      });
+    });
+    client.ready();
+    return () => {
+      client.unsubscribe();
+    };
+  }, []);
+  return /*#__PURE__*/React.createElement(FoundryWidgetContext.Provider, {
+    value: {
+      emitEvent: client.emitEvent,
+      hostEventTarget: client.hostEventTarget,
+      asyncParameterValues,
+      parameters: {
+        values: allParameterValues.value ?? {},
+        state: allParameterValues.type
+      }
+      // Unfortunately the context is statically defined so we can't use the generic type, hence the cast
+    }
+  }, children);
+};
+//# sourceMappingURL=client.js.map

package/build/esm/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","names":["createFoundryWidgetClient","React","useEffect","useMemo","FoundryWidgetContext","initializeParameters","FoundryWidget","children","config","initialValues","client","asyncParameterValues","setAsyncParameterValues","useState","allParameterValues","setAllParameterValues","type","subscribe","hostEventTarget","addEventListener","payload","currentParameters","detail","parameters","aggregatedLoadedState","firstError","newParameterValues","key","value","error","currentParameterValue","updatedValue","Error","ready","unsubscribe","createElement","Provider","emitEvent","values","state"],"sources":["client.tsx"],"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 {\n  AsyncParameterValueMap,\n  AsyncValue,\n  ParameterConfig,\n  ParameterValueMap,\n  WidgetConfig,\n} from \"@osdk/widget.client\";\nimport { createFoundryWidgetClient } from \"@osdk/widget.client\";\nimport React, { useEffect, useMemo } from \"react\";\nimport type { FoundryWidgetClientContext } from \"./context.js\";\nimport { FoundryWidgetContext } from \"./context.js\";\nimport { initializeParameters } from \"./utils/initializeParameters.js\";\n\ninterface FoundryWidgetProps<C extends WidgetConfig<C[\"parameters\"]>> {\n  children: React.ReactNode;\n\n  /**\n   * Parameter configuration for the widget\n   */\n  config: C;\n\n  /**\n   * Customize what the initial value of each parameter should be\n   *\n   * @default Sets all parameters to the \"not-started\" loading state\n   */\n  initialValues?: AsyncParameterValueMap<C>;\n}\n\n/**\n * Handles subscribing to messages from the host Foundry UI and updating the widget's parameter values accordingly via React context\n */\nexport const FoundryWidget = <C extends WidgetConfig<C[\"parameters\"]>>({\n  children,\n  config,\n  initialValues,\n}: FoundryWidgetProps<C>): React.ReactElement<FoundryWidgetProps<C>> => {\n  const client = useMemo(() => createFoundryWidgetClient<C>(), []);\n  const [asyncParameterValues, setAsyncParameterValues] = React.useState<\n    AsyncParameterValueMap<C>\n  >(initialValues ?? initializeParameters(config, \"not-started\"));\n  const [allParameterValues, setAllParameterValues] = React.useState<\n    AsyncValue<ParameterValueMap<C>>\n  >({\n    type: \"not-started\",\n  });\n\n  useEffect(() => {\n    client.subscribe();\n    client.hostEventTarget.addEventListener(\n      \"host.update-parameters\",\n      (payload) => {\n        setAsyncParameterValues((currentParameters) => ({\n          ...currentParameters,\n          ...payload.detail.parameters,\n        }));\n        setAllParameterValues((currentParameters) => {\n          let aggregatedLoadedState: AsyncValue<any>[\"type\"] = \"loaded\";\n          let firstError: Error | undefined;\n          const newParameterValues: ParameterValueMap<\n            WidgetConfig<ParameterConfig>\n          > = {};\n          for (const key in payload.detail.parameters) {\n            const value = payload.detail.parameters[key].value;\n            // If any fails, consider the whole thing failed\n            if (value.type === \"failed\") {\n              aggregatedLoadedState = \"failed\";\n              firstError = firstError ?? value.error;\n              newParameterValues[key as any] = value.value as any;\n              continue;\n            }\n            // If any is loading, consider all of it loading unless we have failed somewhere\n            if (\n              value.type === \"loading\"\n              && aggregatedLoadedState !== \"failed\"\n            ) {\n              aggregatedLoadedState = \"loading\";\n              continue;\n            }\n            // If any is reloading, consider it loading unless something is failed or loading for the first time\n            if (\n              value.type === \"reloading\"\n              && aggregatedLoadedState !== \"failed\"\n              && aggregatedLoadedState !== \"loading\"\n            ) {\n              aggregatedLoadedState = \"reloading\";\n              newParameterValues[key as any] = value.value as any;\n              continue;\n            }\n            if (\n              value.type === \"not-started\"\n              && aggregatedLoadedState !== \"failed\"\n              && aggregatedLoadedState !== \"loading\"\n              && aggregatedLoadedState !== \"reloading\"\n            ) {\n              aggregatedLoadedState = \"not-started\";\n            }\n\n            if (value.type === \"loaded\") {\n              newParameterValues[key as any] = value.value as any;\n            }\n          }\n          const currentParameterValue = currentParameters.type !== \"not-started\"\n              && currentParameters.type !== \"loading\"\n            ? currentParameters.value\n            : {};\n          if (\n            aggregatedLoadedState !== \"not-started\"\n            && aggregatedLoadedState !== \"loading\"\n          ) {\n            const updatedValue = {\n              ...currentParameterValue,\n              ...newParameterValues,\n            } as ParameterValueMap<C>;\n            return aggregatedLoadedState === \"failed\"\n              ? {\n                type: aggregatedLoadedState,\n                value: updatedValue,\n                error: firstError ?? new Error(\"Failed to load parameters\"),\n              }\n              : {\n                type: aggregatedLoadedState,\n                value: updatedValue,\n              };\n          } else {\n            return { type: aggregatedLoadedState };\n          }\n        });\n      },\n    );\n    client.ready();\n    return () => {\n      client.unsubscribe();\n    };\n  }, []);\n\n  return (\n    <FoundryWidgetContext.Provider\n      value={{\n        emitEvent: client.emitEvent,\n        hostEventTarget: client.hostEventTarget,\n        asyncParameterValues,\n        parameters: {\n          values: allParameterValues.value ?? {},\n          state: allParameterValues.type,\n        },\n        // Unfortunately the context is statically defined so we can't use the generic type, hence the cast\n      } as FoundryWidgetClientContext<WidgetConfig<ParameterConfig>>}\n    >\n      {children}\n    </FoundryWidgetContext.Provider>\n  );\n};\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA,SAASA,yBAAyB,QAAQ,qBAAqB;AAC/D,OAAOC,KAAK,IAAIC,SAAS,EAAEC,OAAO,QAAQ,OAAO;AAEjD,SAASC,oBAAoB,QAAQ,cAAc;AACnD,SAASC,oBAAoB,QAAQ,iCAAiC;AAkBtE;AACA;AACA;AACA,OAAO,MAAMC,aAAa,GAAGA,CAA0C;EACrEC,QAAQ;EACRC,MAAM;EACNC;AACqB,CAAC,KAAgD;EACtE,MAAMC,MAAM,GAAGP,OAAO,CAAC,MAAMH,yBAAyB,CAAI,CAAC,EAAE,EAAE,CAAC;EAChE,MAAM,CAACW,oBAAoB,EAAEC,uBAAuB,CAAC,GAAGX,KAAK,CAACY,QAAQ,CAEpEJ,aAAa,IAAIJ,oBAAoB,CAACG,MAAM,EAAE,aAAa,CAAC,CAAC;EAC/D,MAAM,CAACM,kBAAkB,EAAEC,qBAAqB,CAAC,GAAGd,KAAK,CAACY,QAAQ,CAEhE;IACAG,IAAI,EAAE;EACR,CAAC,CAAC;EAEFd,SAAS,CAAC,MAAM;IACdQ,MAAM,CAACO,SAAS,CAAC,CAAC;IAClBP,MAAM,CAACQ,eAAe,CAACC,gBAAgB,CACrC,wBAAwB,EACvBC,OAAO,IAAK;MACXR,uBAAuB,CAAES,iBAAiB,KAAM;QAC9C,GAAGA,iBAAiB;QACpB,GAAGD,OAAO,CAACE,MAAM,CAACC;MACpB,CAAC,CAAC,CAAC;MACHR,qBAAqB,CAAEM,iBAAiB,IAAK;QAC3C,IAAIG,qBAA8C,GAAG,QAAQ;QAC7D,IAAIC,UAA6B;QACjC,MAAMC,kBAEL,GAAG,CAAC,CAAC;QACN,KAAK,MAAMC,GAAG,IAAIP,OAAO,CAACE,MAAM,CAACC,UAAU,EAAE;UAC3C,MAAMK,KAAK,GAAGR,OAAO,CAACE,MAAM,CAACC,UAAU,CAACI,GAAG,CAAC,CAACC,KAAK;UAClD;UACA,IAAIA,KAAK,CAACZ,IAAI,KAAK,QAAQ,EAAE;YAC3BQ,qBAAqB,GAAG,QAAQ;YAChCC,UAAU,GAAGA,UAAU,IAAIG,KAAK,CAACC,KAAK;YACtCH,kBAAkB,CAACC,GAAG,CAAQ,GAAGC,KAAK,CAACA,KAAY;YACnD;UACF;UACA;UACA,IACEA,KAAK,CAACZ,IAAI,KAAK,SAAS,IACrBQ,qBAAqB,KAAK,QAAQ,EACrC;YACAA,qBAAqB,GAAG,SAAS;YACjC;UACF;UACA;UACA,IACEI,KAAK,CAACZ,IAAI,KAAK,WAAW,IACvBQ,qBAAqB,KAAK,QAAQ,IAClCA,qBAAqB,KAAK,SAAS,EACtC;YACAA,qBAAqB,GAAG,WAAW;YACnCE,kBAAkB,CAACC,GAAG,CAAQ,GAAGC,KAAK,CAACA,KAAY;YACnD;UACF;UACA,IACEA,KAAK,CAACZ,IAAI,KAAK,aAAa,IACzBQ,qBAAqB,KAAK,QAAQ,IAClCA,qBAAqB,KAAK,SAAS,IACnCA,qBAAqB,KAAK,WAAW,EACxC;YACAA,qBAAqB,GAAG,aAAa;UACvC;UAEA,IAAII,KAAK,CAACZ,IAAI,KAAK,QAAQ,EAAE;YAC3BU,kBAAkB,CAACC,GAAG,CAAQ,GAAGC,KAAK,CAACA,KAAY;UACrD;QACF;QACA,MAAME,qBAAqB,GAAGT,iBAAiB,CAACL,IAAI,KAAK,aAAa,IAC/DK,iBAAiB,CAACL,IAAI,KAAK,SAAS,GACvCK,iBAAiB,CAACO,KAAK,GACvB,CAAC,CAAC;QACN,IACEJ,qBAAqB,KAAK,aAAa,IACpCA,qBAAqB,KAAK,SAAS,EACtC;UACA,MAAMO,YAAY,GAAG;YACnB,GAAGD,qBAAqB;YACxB,GAAGJ;UACL,CAAyB;UACzB,OAAOF,qBAAqB,KAAK,QAAQ,GACrC;YACAR,IAAI,EAAEQ,qBAAqB;YAC3BI,KAAK,EAAEG,YAAY;YACnBF,KAAK,EAAEJ,UAAU,IAAI,IAAIO,KAAK,CAAC,2BAA2B;UAC5D,CAAC,GACC;YACAhB,IAAI,EAAEQ,qBAAqB;YAC3BI,KAAK,EAAEG;UACT,CAAC;QACL,CAAC,MAAM;UACL,OAAO;YAAEf,IAAI,EAAEQ;UAAsB,CAAC;QACxC;MACF,CAAC,CAAC;IACJ,CACF,CAAC;IACDd,MAAM,CAACuB,KAAK,CAAC,CAAC;IACd,OAAO,MAAM;MACXvB,MAAM,CAACwB,WAAW,CAAC,CAAC;IACtB,CAAC;EACH,CAAC,EAAE,EAAE,CAAC;EAEN,oBACEjC,KAAA,CAAAkC,aAAA,CAAC/B,oBAAoB,CAACgC,QAAQ;IAC5BR,KAAK,EAAE;MACLS,SAAS,EAAE3B,MAAM,CAAC2B,SAAS;MAC3BnB,eAAe,EAAER,MAAM,CAACQ,eAAe;MACvCP,oBAAoB;MACpBY,UAAU,EAAE;QACVe,MAAM,EAAExB,kBAAkB,CAACc,KAAK,IAAI,CAAC,CAAC;QACtCW,KAAK,EAAEzB,kBAAkB,CAACE;MAC5B;MACA;IACF;EAA+D,GAE9DT,QAC4B,CAAC;AAEpC,CAAC","ignoreList":[]}

package/build/esm/context.js

@@ -0,0 +1,42 @@
+/*
+ * 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 { FoundryHostEventTarget } from "@osdk/widget.client";
+import React, { useContext } from "react";
+export const FoundryWidgetContext = /*#__PURE__*/React.createContext({
+  emitEvent: () => {},
+  hostEventTarget: new FoundryHostEventTarget(),
+  asyncParameterValues: {},
+  parameters: {
+    state: "not-started",
+    values: {}
+  }
+});
+
+/**
+ * @returns The current FoundryWidgetClientContext, in the context of your specific parameter configuration
+ */
+export function useFoundryWidgetContext() {
+  return useContext(FoundryWidgetContext);
+}
+(function (_useFoundryWidgetContext) {
+  _useFoundryWidgetContext.withTypes = function () {
+    return () => {
+      return useFoundryWidgetContext();
+    };
+  };
+})(useFoundryWidgetContext || (useFoundryWidgetContext = {}));
+//# sourceMappingURL=context.js.map

package/build/esm/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","names":["FoundryHostEventTarget","React","useContext","FoundryWidgetContext","createContext","emitEvent","hostEventTarget","asyncParameterValues","parameters","state","values","useFoundryWidgetContext","_useFoundryWidgetContext","withTypes"],"sources":["context.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  type AsyncParameterValueMap,\n  type AsyncValue,\n  FoundryHostEventTarget,\n  type FoundryWidgetClient,\n  type ParameterConfig,\n  type ParameterValueMap,\n  type WidgetConfig,\n} from \"@osdk/widget.client\";\nimport React, { useContext } from \"react\";\n\nexport interface FoundryWidgetClientContext<\n  C extends WidgetConfig<C[\"parameters\"]>,\n> {\n  emitEvent: FoundryWidgetClient<C>[\"emitEvent\"];\n  hostEventTarget: FoundryHostEventTarget<C>;\n\n  /**\n   * Object where the individual parameters have their async state represented\n   */\n  asyncParameterValues: AsyncParameterValueMap<C>;\n\n  /**\n   * Convenience object that aggregates the value of all parameters, accounting for their loading states\n   */\n  parameters: {\n    values: Partial<ParameterValueMap<C>>;\n    state: AsyncValue<ParameterValueMap<C>>[\"type\"];\n  };\n}\n\nexport const FoundryWidgetContext: React.Context<\n  FoundryWidgetClientContext<WidgetConfig<ParameterConfig>>\n> = React.createContext<\n  FoundryWidgetClientContext<WidgetConfig<ParameterConfig>>\n>({\n  emitEvent: () => {},\n  hostEventTarget: new FoundryHostEventTarget<WidgetConfig<ParameterConfig>>(),\n  asyncParameterValues: {},\n  parameters: {\n    state: \"not-started\",\n    values: {},\n  },\n});\n\n/**\n * @returns The current FoundryWidgetClientContext, in the context of your specific parameter configuration\n */\nexport function useFoundryWidgetContext<\n  C extends WidgetConfig<C[\"parameters\"]>,\n>() {\n  return useContext(FoundryWidgetContext) as FoundryWidgetClientContext<C>;\n}\n\nexport namespace useFoundryWidgetContext {\n  export function withTypes<\n    C extends WidgetConfig<C[\"parameters\"]>,\n  >(): () => FoundryWidgetClientContext<C> {\n    return () => {\n      return useFoundryWidgetContext<C>();\n    };\n  }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAGEA,sBAAsB,QAKjB,qBAAqB;AAC5B,OAAOC,KAAK,IAAIC,UAAU,QAAQ,OAAO;AAsBzC,OAAO,MAAMC,oBAEZ,gBAAGF,KAAK,CAACG,aAAa,CAErB;EACAC,SAAS,EAAEA,CAAA,KAAM,CAAC,CAAC;EACnBC,eAAe,EAAE,IAAIN,sBAAsB,CAAgC,CAAC;EAC5EO,oBAAoB,EAAE,CAAC,CAAC;EACxBC,UAAU,EAAE;IACVC,KAAK,EAAE,aAAa;IACpBC,MAAM,EAAE,CAAC;EACX;AACF,CAAC,CAAC;;AAEF;AACA;AACA;AACA,OAAO,SAASC,uBAAuBA,CAAA,EAEnC;EACF,OAAOT,UAAU,CAACC,oBAAoB,CAAC;AACzC;AAAC,WAAAS,wBAAA;EAAAA,wBAAA,CAAAC,SAAA,GAGQ,YAEkC;IACvC,OAAO,MAAM;MACX,OAAOF,uBAAuB,CAAI,CAAC;IACrC,CAAC;EACH,CAAC;AAAA,GAPcA,uBAAuB,KAAvBA,uBAAuB","ignoreList":[]}

package/build/esm/index.js

@@ -0,0 +1,19 @@
+/*
+ * 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 { FoundryWidget } from "./client.js";
+export { useFoundryWidgetContext } from "./context.js";
+//# sourceMappingURL=index.js.map

package/build/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["FoundryWidget","useFoundryWidgetContext"],"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 { FoundryWidget } from \"./client.js\";\nexport { useFoundryWidgetContext } from \"./context.js\";\nexport type { FoundryWidgetClientContext } from \"./context.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,aAAa,QAAQ,aAAa;AAC3C,SAASC,uBAAuB,QAAQ,cAAc","ignoreList":[]}

package/build/esm/utils/initializeParameters.js

@@ -0,0 +1,28 @@
+/*
+ * 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.
+ */
+
+/**
+ * Utility function to initialize a map of parameter values to either a loading or not-started loading state
+ */
+export function initializeParameters(config, initialLoadingState) {
+  return Object.fromEntries(Object.entries(config.parameters).map(([key, parameterConfig]) => [key, {
+    type: parameterConfig.type,
+    value: {
+      type: initialLoadingState
+    }
+  }]));
+}
+//# sourceMappingURL=initializeParameters.js.map

package/build/esm/utils/initializeParameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initializeParameters.js","names":["initializeParameters","config","initialLoadingState","Object","fromEntries","entries","parameters","map","key","parameterConfig","type","value"],"sources":["initializeParameters.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 { AsyncParameterValueMap, WidgetConfig } from \"@osdk/widget.client\";\n\n/**\n * Utility function to initialize a map of parameter values to either a loading or not-started loading state\n */\nexport function initializeParameters<C extends WidgetConfig<C[\"parameters\"]>>(\n  config: C,\n  initialLoadingState: \"loading\" | \"not-started\",\n): AsyncParameterValueMap<C> {\n  return Object.fromEntries(\n    Object.entries(config.parameters).map(([key, parameterConfig]) => [\n      key,\n      { type: parameterConfig.type, value: { type: initialLoadingState } },\n    ]),\n  ) as AsyncParameterValueMap<C>;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA;AACA;AACA;AACA,OAAO,SAASA,oBAAoBA,CAClCC,MAAS,EACTC,mBAA8C,EACnB;EAC3B,OAAOC,MAAM,CAACC,WAAW,CACvBD,MAAM,CAACE,OAAO,CAACJ,MAAM,CAACK,UAAU,CAAC,CAACC,GAAG,CAAC,CAAC,CAACC,GAAG,EAAEC,eAAe,CAAC,KAAK,CAChED,GAAG,EACH;IAAEE,IAAI,EAAED,eAAe,CAACC,IAAI;IAAEC,KAAK,EAAE;MAAED,IAAI,EAAER;IAAoB;EAAE,CAAC,CACrE,CACH,CAAC;AACH","ignoreList":[]}

package/build/types/client.d.ts

@@ -0,0 +1,20 @@
+import type { AsyncParameterValueMap, WidgetConfig } from "@osdk/widget.client";
+import React from "react";
+interface FoundryWidgetProps<C extends WidgetConfig<C["parameters"]>> {
+	children: React.ReactNode;
+	/**
+	* Parameter configuration for the widget
+	*/
+	config: C;
+	/**
+	* Customize what the initial value of each parameter should be
+	*
+	* @default Sets all parameters to the "not-started" loading state
+	*/
+	initialValues?: AsyncParameterValueMap<C>;
+}
+/**
+* Handles subscribing to messages from the host Foundry UI and updating the widget's parameter values accordingly via React context
+*/
+export declare const FoundryWidget: <C extends WidgetConfig<C["parameters"]>>({ children, config, initialValues }: FoundryWidgetProps<C>) => React.ReactElement<FoundryWidgetProps<C>>;
+export {};

package/build/types/client.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cACE,wBAIA,oBACK,qBAAsB;AAE7B,OAAO,WAAmC,OAAQ;UAKxC,mBAAmB,UAAU,aAAa,EAAE,gBAAgB;CACpE,UAAU,MAAM;;;;CAKhB,QAAQ;;;;;;CAOR,gBAAgB,uBAAuB;AACxC;;;;AAKD,OAAO,cAAM,gBAAiB,UAAU,aAAa,EAAE,gBAAgB,EACrE,UACA,QACA,eACsB,EAArB,mBAAmB,OAAK,MAAM,aAAa,mBAAmB","names":[],"sources":["../../src/client.tsx"],"version":3,"file":"client.d.ts"}

package/build/types/context.d.ts

@@ -0,0 +1,25 @@
+import { type AsyncParameterValueMap, type AsyncValue, FoundryHostEventTarget, type FoundryWidgetClient, type ParameterConfig, type ParameterValueMap, type WidgetConfig } from "@osdk/widget.client";
+import React from "react";
+export interface FoundryWidgetClientContext<C extends WidgetConfig<C["parameters"]>> {
+	emitEvent: FoundryWidgetClient<C>["emitEvent"];
+	hostEventTarget: FoundryHostEventTarget<C>;
+	/**
+	* Object where the individual parameters have their async state represented
+	*/
+	asyncParameterValues: AsyncParameterValueMap<C>;
+	/**
+	* Convenience object that aggregates the value of all parameters, accounting for their loading states
+	*/
+	parameters: {
+		values: Partial<ParameterValueMap<C>>
+		state: AsyncValue<ParameterValueMap<C>>["type"]
+	};
+}
+export declare const FoundryWidgetContext: React.Context<FoundryWidgetClientContext<WidgetConfig<ParameterConfig>>>;
+/**
+* @returns The current FoundryWidgetClientContext, in the context of your specific parameter configuration
+*/
+export declare function useFoundryWidgetContext<C extends WidgetConfig<C["parameters"]>>(): FoundryWidgetClientContext<C>;
+export declare namespace useFoundryWidgetContext {
+	function withTypes<C extends WidgetConfig<C["parameters"]>>(): () => FoundryWidgetClientContext<C>;
+}

package/build/types/context.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cACO,6BACA,YACL,6BACK,0BACA,sBACA,wBACA,oBACA,qBAAsB;AAC7B,OAAO,WAA2B,OAAQ;AAE1C,iBAAiB,2BACf,UAAU,aAAa,EAAE,gBACzB;CACA,WAAW,oBAAoB,GAAG;CAClC,iBAAiB,uBAAuB;;;;CAKxC,sBAAsB,uBAAuB;;;;CAK7C,YAAY;EACV,QAAQ,QAAQ,kBAAkB;EAClC,OAAO,WAAW,kBAAkB,IAAI;CACzC;AACF;AAED,OAAO,cAAMA,sBAAsB,MAAM,QACvC,2BAA2B,aAAa;;;;AAgB1C,OAAO,iBAAS,wBACd,UAAU,aAAa,EAAE,mBAEkB,2BAA2B;AAGxE,yBAAiB;CACR,SAAS,UACd,UAAU,aAAa,EAAE,yBAChB,2BAA2B","names":["FoundryWidgetContext: React.Context<\n  FoundryWidgetClientContext<WidgetConfig<ParameterConfig>>\n>"],"sources":["../../src/context.ts"],"version":3,"file":"context.d.ts"}

package/build/types/index.d.ts

@@ -0,0 +1,3 @@
+export { FoundryWidget } from "./client.js";
+export { useFoundryWidgetContext } from "./context.js";
+export type { FoundryWidgetClientContext } from "./context.js";

package/build/types/index.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,SAAS,qBAAqB;AAC9B,SAAS,+BAA+B;AACxC,cAAc,kCAAkC","names":[],"sources":["../../src/index.ts"],"version":3,"file":"index.d.ts"}

package/build/types/utils/initializeParameters.d.ts

@@ -0,0 +1,5 @@
+import type { AsyncParameterValueMap, WidgetConfig } from "@osdk/widget.client";
+/**
+* Utility function to initialize a map of parameter values to either a loading or not-started loading state
+*/
+export declare function initializeParameters<C extends WidgetConfig<C["parameters"]>>(config: C, initialLoadingState: "loading" | "not-started"): AsyncParameterValueMap<C>;

package/build/types/utils/initializeParameters.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,wBAAwB,oBAAoB,qBAAsB;;;;AAKhF,OAAO,iBAAS,qBAAqB,UAAU,aAAa,EAAE,gBAC5DA,QAAQ,GACRC,qBAAqB,YAAY,gBAChC,uBAAuB","names":["config: C","initialLoadingState: \"loading\" | \"not-started\""],"sources":["../../../src/utils/initializeParameters.ts"],"version":3,"file":"initializeParameters.d.ts"}