@sigmacomputing/react-embed-sdk 0.2.6 → 0.2.8

package/dist/index.d.mts

@@ -54,6 +54,30 @@ declare function useSigmaIframe(): {
  */
 declare function usePageHeight(iframeRef: React.RefObject<HTMLIFrameElement>): number | undefined;
 
+/**
+ * A hook that returns functions to get and set the variables in a workbook.
+ * @example
+ * ```
+ * function MyEmbed() {
+ *   const { getVariables, setVariables } = useWorkbookVariables(iframeRef);
+ *   return (
+ *    <>
+ *     <button onClick={() => setVariables({ foo: "bar" })}>Set Variables</button>
+ *     <button onClick={() => const variable = await getVariables()}>Get Variables</button>
+ *     <iframe
+ *       ref={iframeRef}
+ *       src="https://app.sigmacomputing.com/embed"
+ *     />
+ *    <>
+ *   );
+ * }
+ * ```
+ */
+declare const useWorkbookVariables: (iframeRef: React.RefObject<HTMLIFrameElement>) => {
+    getVariables: () => Promise<unknown>;
+    setVariables: (variables: Record<string, string>) => void;
+};
+
 /**
  * Listen for a workbook loaded event, and execute the given callback when it occurs.
  *
@@ -134,4 +158,4 @@ declare function useWorkbookBookmarkOnChange(iframeRef: React.RefObject<HTMLIFra
 declare function useUrlOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onUrlChange: (event: UrlOnChangeEvent) => void): void;
 declare function useWorkbookIdOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onIdChange: (event: WorkbookIdOnChangeEvent) => void): void;
 
-export { usePageHeight, useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPageSelectedNode, useWorkbookPivotTableCellSelect, useWorkbookPublished };
+export { usePageHeight, useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPageSelectedNode, useWorkbookPivotTableCellSelect, useWorkbookPublished, useWorkbookVariables };

package/dist/index.d.ts

@@ -54,6 +54,30 @@ declare function useSigmaIframe(): {
  */
 declare function usePageHeight(iframeRef: React.RefObject<HTMLIFrameElement>): number | undefined;
 
+/**
+ * A hook that returns functions to get and set the variables in a workbook.
+ * @example
+ * ```
+ * function MyEmbed() {
+ *   const { getVariables, setVariables } = useWorkbookVariables(iframeRef);
+ *   return (
+ *    <>
+ *     <button onClick={() => setVariables({ foo: "bar" })}>Set Variables</button>
+ *     <button onClick={() => const variable = await getVariables()}>Get Variables</button>
+ *     <iframe
+ *       ref={iframeRef}
+ *       src="https://app.sigmacomputing.com/embed"
+ *     />
+ *    <>
+ *   );
+ * }
+ * ```
+ */
+declare const useWorkbookVariables: (iframeRef: React.RefObject<HTMLIFrameElement>) => {
+    getVariables: () => Promise<unknown>;
+    setVariables: (variables: Record<string, string>) => void;
+};
+
 /**
  * Listen for a workbook loaded event, and execute the given callback when it occurs.
  *
@@ -134,4 +158,4 @@ declare function useWorkbookBookmarkOnChange(iframeRef: React.RefObject<HTMLIFra
 declare function useUrlOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onUrlChange: (event: UrlOnChangeEvent) => void): void;
 declare function useWorkbookIdOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onIdChange: (event: WorkbookIdOnChangeEvent) => void): void;
 
-export { usePageHeight, useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPageSelectedNode, useWorkbookPivotTableCellSelect, useWorkbookPublished };
+export { usePageHeight, useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPageSelectedNode, useWorkbookPivotTableCellSelect, useWorkbookPublished, useWorkbookVariables };

package/dist/index.js

@@ -39,7 +39,8 @@ __export(src_exports, {
   useWorkbookPageHeight: () => useWorkbookPageHeight,
   useWorkbookPageSelectedNode: () => useWorkbookPageSelectedNode,
   useWorkbookPivotTableCellSelect: () => useWorkbookPivotTableCellSelect,
-  useWorkbookPublished: () => useWorkbookPublished
+  useWorkbookPublished: () => useWorkbookPublished,
+  useWorkbookVariables: () => useWorkbookVariables
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -332,6 +333,55 @@ function usePageHeight(iframeRef) {
   });
   return height;
 }
+
+// src/mutations.ts
+var import_react4 = require("react");
+var import_embed_sdk2 = require("@sigmacomputing/embed-sdk");
+var useWorkbookVariables = (iframeRef) => {
+  const [state, setState] = (0, import_react4.useState)();
+  const getVariables = (0, import_react4.useCallback)(() => {
+    if (!iframeRef.current) {
+      throw new Error("iframe is not available");
+    }
+    (0, import_embed_sdk2.workbookVariablesList)(iframeRef.current);
+    const promise = new Promise((resolve) => {
+      setState({ state: "pending", callback: resolve });
+    });
+    return promise;
+  }, [iframeRef]);
+  const setVariables = (0, import_react4.useCallback)(
+    (variables) => {
+      if (!iframeRef.current) {
+        throw new Error("iframe is not available");
+      }
+      (0, import_embed_sdk2.workbookVariablesUpdate)(iframeRef.current, variables);
+    },
+    [iframeRef]
+  );
+  (0, import_react4.useEffect)(() => {
+    if (!iframeRef.current)
+      return;
+    const listener = (event) => {
+      if (!iframeRef.current) {
+        return;
+      }
+      (0, import_embed_sdk2.workbookCurrentVariablesListener)(event, iframeRef.current, (event2) => {
+        if ((state == null ? void 0 : state.state) === "pending") {
+          setState({ state: "success", variables: event2.variables });
+          state.callback(event2.variables);
+        }
+      });
+    };
+    window.addEventListener("message", listener);
+    return () => {
+      window.removeEventListener("message", listener);
+    };
+  }, [iframeRef, state]);
+  return {
+    getVariables,
+    setVariables
+  };
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   usePageHeight,
@@ -353,5 +403,6 @@ function usePageHeight(iframeRef) {
   useWorkbookPageHeight,
   useWorkbookPageSelectedNode,
   useWorkbookPivotTableCellSelect,
-  useWorkbookPublished
+  useWorkbookPublished,
+  useWorkbookVariables
 });

package/dist/index.mjs

@@ -306,6 +306,59 @@ function usePageHeight(iframeRef) {
   });
   return height;
 }
+
+// src/mutations.ts
+import { useCallback as useCallback2, useEffect as useEffect2, useState as useState3 } from "react";
+import {
+  workbookVariablesList,
+  workbookCurrentVariablesListener as workbookCurrentVariablesListener2,
+  workbookVariablesUpdate
+} from "@sigmacomputing/embed-sdk";
+var useWorkbookVariables = (iframeRef) => {
+  const [state, setState] = useState3();
+  const getVariables = useCallback2(() => {
+    if (!iframeRef.current) {
+      throw new Error("iframe is not available");
+    }
+    workbookVariablesList(iframeRef.current);
+    const promise = new Promise((resolve) => {
+      setState({ state: "pending", callback: resolve });
+    });
+    return promise;
+  }, [iframeRef]);
+  const setVariables = useCallback2(
+    (variables) => {
+      if (!iframeRef.current) {
+        throw new Error("iframe is not available");
+      }
+      workbookVariablesUpdate(iframeRef.current, variables);
+    },
+    [iframeRef]
+  );
+  useEffect2(() => {
+    if (!iframeRef.current)
+      return;
+    const listener = (event) => {
+      if (!iframeRef.current) {
+        return;
+      }
+      workbookCurrentVariablesListener2(event, iframeRef.current, (event2) => {
+        if ((state == null ? void 0 : state.state) === "pending") {
+          setState({ state: "success", variables: event2.variables });
+          state.callback(event2.variables);
+        }
+      });
+    };
+    window.addEventListener("message", listener);
+    return () => {
+      window.removeEventListener("message", listener);
+    };
+  }, [iframeRef, state]);
+  return {
+    getVariables,
+    setVariables
+  };
+};
 export {
   usePageHeight,
   useSigmaIframe,
@@ -326,5 +379,6 @@ export {
   useWorkbookPageHeight,
   useWorkbookPageSelectedNode,
   useWorkbookPivotTableCellSelect,
-  useWorkbookPublished
+  useWorkbookPublished,
+  useWorkbookVariables
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sigmacomputing/react-embed-sdk",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "description": "React JavaScript SDK to interact with Sigma Computing's Embed API",
   "author": "sigmacomputing",
   "license": "ISC",
@@ -23,7 +23,7 @@
     "@sigmacomputing/typescript-config": "0.0.0"
   },
   "dependencies": {
-    "@sigmacomputing/embed-sdk": "0.2.6"
+    "@sigmacomputing/embed-sdk": "0.2.8"
   },
   "scripts": {
     "prepublish": "pnpm build",