@sigmacomputing/react-embed-sdk 0.4.0 → 0.5.0

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { WorkbookErrorEvent, WorkbookLoadedEvent, WorkbookDataLoadedEvent, WorkbookVariableOnChangeEvent, WorkbookTableCellSelectEvent, WorkbookPublishedEvent, WorkbookFullScreenEvent, WorkbookPageHeightEvent, WorkbookSelectedNodeEvent, WorkbookPivotTableCellSelectEvent, WorkbookChartValueSelectEvent, WorkbookCurrentVariablesEvent, WorkbookBookmarkOnCreateEvent, WorkbookChartErrorEvent, WorkbookExploreKeyOnChangeEvent, WorkbookBookmarkOnChangeEvent, UrlOnChangeEvent, WorkbookIdOnChangeEvent, WorkbookBookmarkCreateEvent } from '@sigmacomputing/embed-sdk';
+import { WorkbookErrorEvent, WorkbookLoadedEvent, WorkbookDataLoadedEvent, WorkbookVariableOnChangeEvent, WorkbookTableCellSelectEvent, WorkbookPublishedEvent, WorkbookFullScreenEvent, WorkbookPageHeightEvent, WorkbookSelectedNodeEvent, WorkbookPivotTableCellSelectEvent, WorkbookChartValueSelectEvent, WorkbookCurrentVariablesEvent, WorkbookBookmarkOnCreateEvent, WorkbookChartErrorEvent, WorkbookExploreKeyOnChangeEvent, WorkbookBookmarkOnChangeEvent, UrlOnChangeEvent, WorkbookIdOnChangeEvent, ActionOutboundEvent, WorkbookBookmarkCreateEvent } from '@sigmacomputing/embed-sdk';
 export * from '@sigmacomputing/embed-sdk';
 
 /**
@@ -156,6 +156,16 @@ declare function useWorkbookExploreKeyOnChange(iframeRef: React.RefObject<HTMLIF
 declare function useWorkbookBookmarkOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkChange: (event: WorkbookBookmarkOnChangeEvent) => void): void;
 declare function useUrlOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onUrlChange: (event: UrlOnChangeEvent) => void): void;
 declare function useWorkbookIdOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onIdChange: (event: WorkbookIdOnChangeEvent) => void): void;
+/**
+ *  Listen for an action outbound event, and execute the
+ *  given callback when it occurs.
+ *
+ * You can setup your own outbound action by using the
+ * "Generate JavaScript event" action. For more details,
+ * see [docs](https://help.sigmacomputing.com/docs/intro-to-actions).
+ *
+ */
+declare function useActionOutbound(iframeRef: React.RefObject<HTMLIFrameElement>, onActionOutbound: (event: ActionOutboundEvent) => void): void;
 
 declare function getWorkbookVariables(iframeRef: React.RefObject<HTMLIFrameElement>): void;
 declare function updateWorkbookVariables(iframeRef: React.RefObject<HTMLIFrameElement>, variables: Record<string, string>): void;
@@ -165,4 +175,4 @@ declare function updateWorkbookFullscreen(iframeRef: React.RefObject<HTMLIFrameE
 declare function updateWorkbookSelectedNodeId(iframeRef: React.RefObject<HTMLIFrameElement>, nodeId: string, nodeType: "element" | "page"): void;
 declare function updateWorkbookSharingLink(iframeRef: React.RefObject<HTMLIFrameElement>, sharingLink: string | null, sharingExplorationLink?: string | null): void;
 
-export { createWorkbookBookmark, getWorkbookVariables, updateWorkbookBookmark, updateWorkbookFullscreen, updateWorkbookSelectedNodeId, updateWorkbookSharingLink, updateWorkbookVariables, usePageHeight, useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPivotTableCellSelect, useWorkbookPublished, useWorkbookSelectedNode, useWorkbookVariables };
+export { createWorkbookBookmark, getWorkbookVariables, updateWorkbookBookmark, updateWorkbookFullscreen, updateWorkbookSelectedNodeId, updateWorkbookSharingLink, updateWorkbookVariables, useActionOutbound, usePageHeight, useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPivotTableCellSelect, useWorkbookPublished, useWorkbookSelectedNode, useWorkbookVariables };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { WorkbookErrorEvent, WorkbookLoadedEvent, WorkbookDataLoadedEvent, WorkbookVariableOnChangeEvent, WorkbookTableCellSelectEvent, WorkbookPublishedEvent, WorkbookFullScreenEvent, WorkbookPageHeightEvent, WorkbookSelectedNodeEvent, WorkbookPivotTableCellSelectEvent, WorkbookChartValueSelectEvent, WorkbookCurrentVariablesEvent, WorkbookBookmarkOnCreateEvent, WorkbookChartErrorEvent, WorkbookExploreKeyOnChangeEvent, WorkbookBookmarkOnChangeEvent, UrlOnChangeEvent, WorkbookIdOnChangeEvent, WorkbookBookmarkCreateEvent } from '@sigmacomputing/embed-sdk';
+import { WorkbookErrorEvent, WorkbookLoadedEvent, WorkbookDataLoadedEvent, WorkbookVariableOnChangeEvent, WorkbookTableCellSelectEvent, WorkbookPublishedEvent, WorkbookFullScreenEvent, WorkbookPageHeightEvent, WorkbookSelectedNodeEvent, WorkbookPivotTableCellSelectEvent, WorkbookChartValueSelectEvent, WorkbookCurrentVariablesEvent, WorkbookBookmarkOnCreateEvent, WorkbookChartErrorEvent, WorkbookExploreKeyOnChangeEvent, WorkbookBookmarkOnChangeEvent, UrlOnChangeEvent, WorkbookIdOnChangeEvent, ActionOutboundEvent, WorkbookBookmarkCreateEvent } from '@sigmacomputing/embed-sdk';
 export * from '@sigmacomputing/embed-sdk';
 
 /**
@@ -156,6 +156,16 @@ declare function useWorkbookExploreKeyOnChange(iframeRef: React.RefObject<HTMLIF
 declare function useWorkbookBookmarkOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkChange: (event: WorkbookBookmarkOnChangeEvent) => void): void;
 declare function useUrlOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onUrlChange: (event: UrlOnChangeEvent) => void): void;
 declare function useWorkbookIdOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onIdChange: (event: WorkbookIdOnChangeEvent) => void): void;
+/**
+ *  Listen for an action outbound event, and execute the
+ *  given callback when it occurs.
+ *
+ * You can setup your own outbound action by using the
+ * "Generate JavaScript event" action. For more details,
+ * see [docs](https://help.sigmacomputing.com/docs/intro-to-actions).
+ *
+ */
+declare function useActionOutbound(iframeRef: React.RefObject<HTMLIFrameElement>, onActionOutbound: (event: ActionOutboundEvent) => void): void;
 
 declare function getWorkbookVariables(iframeRef: React.RefObject<HTMLIFrameElement>): void;
 declare function updateWorkbookVariables(iframeRef: React.RefObject<HTMLIFrameElement>, variables: Record<string, string>): void;
@@ -165,4 +175,4 @@ declare function updateWorkbookFullscreen(iframeRef: React.RefObject<HTMLIFrameE
 declare function updateWorkbookSelectedNodeId(iframeRef: React.RefObject<HTMLIFrameElement>, nodeId: string, nodeType: "element" | "page"): void;
 declare function updateWorkbookSharingLink(iframeRef: React.RefObject<HTMLIFrameElement>, sharingLink: string | null, sharingExplorationLink?: string | null): void;
 
-export { createWorkbookBookmark, getWorkbookVariables, updateWorkbookBookmark, updateWorkbookFullscreen, updateWorkbookSelectedNodeId, updateWorkbookSharingLink, updateWorkbookVariables, usePageHeight, useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPivotTableCellSelect, useWorkbookPublished, useWorkbookSelectedNode, useWorkbookVariables };
+export { createWorkbookBookmark, getWorkbookVariables, updateWorkbookBookmark, updateWorkbookFullscreen, updateWorkbookSelectedNodeId, updateWorkbookSharingLink, updateWorkbookVariables, useActionOutbound, usePageHeight, useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPivotTableCellSelect, useWorkbookPublished, useWorkbookSelectedNode, useWorkbookVariables };

package/dist/index.js

@@ -27,6 +27,7 @@ __export(src_exports, {
   updateWorkbookSelectedNodeId: () => updateWorkbookSelectedNodeId,
   updateWorkbookSharingLink: () => updateWorkbookSharingLink,
   updateWorkbookVariables: () => updateWorkbookVariables,
+  useActionOutbound: () => useActionOutbound,
   usePageHeight: () => usePageHeight,
   useSigmaIframe: () => useSigmaIframe,
   useTableCellSelect: () => useTableCellSelect,
@@ -309,6 +310,18 @@ function useWorkbookIdOnChange(iframeRef, onIdChange) {
     return () => window.removeEventListener("message", listener);
   }, [iframeRef, onIdChange]);
 }
+function useActionOutbound(iframeRef, onActionOutbound) {
+  (0, import_react.useEffect)(() => {
+    const listener = (event) => {
+      if (!iframeRef.current) {
+        return;
+      }
+      (0, import_embed_sdk.actionOutboundListener)(event, iframeRef.current, onActionOutbound);
+    };
+    window.addEventListener("message", listener);
+    return () => window.removeEventListener("message", listener);
+  }, [iframeRef, onActionOutbound]);
+}
 
 // src/use-sigma-iframe.ts
 function useSigmaIframe() {
@@ -445,6 +458,7 @@ function updateWorkbookSharingLink(iframeRef, sharingLink, sharingExplorationLin
   updateWorkbookSelectedNodeId,
   updateWorkbookSharingLink,
   updateWorkbookVariables,
+  useActionOutbound,
   usePageHeight,
   useSigmaIframe,
   useTableCellSelect,

package/dist/index.mjs

@@ -20,7 +20,8 @@ import {
   workbookExploreKeyOnChangeListener,
   workbookBookmarkOnChangeListener,
   urlOnChangeListener,
-  workbookIdOnChangeListener
+  workbookIdOnChangeListener,
+  actionOutboundListener
 } from "@sigmacomputing/embed-sdk";
 import { useEffect } from "react";
 function useWorkbookLoaded(iframeRef, onLoaded) {
@@ -275,6 +276,18 @@ function useWorkbookIdOnChange(iframeRef, onIdChange) {
     return () => window.removeEventListener("message", listener);
   }, [iframeRef, onIdChange]);
 }
+function useActionOutbound(iframeRef, onActionOutbound) {
+  useEffect(() => {
+    const listener = (event) => {
+      if (!iframeRef.current) {
+        return;
+      }
+      actionOutboundListener(event, iframeRef.current, onActionOutbound);
+    };
+    window.addEventListener("message", listener);
+    return () => window.removeEventListener("message", listener);
+  }, [iframeRef, onActionOutbound]);
+}
 
 // src/use-sigma-iframe.ts
 function useSigmaIframe() {
@@ -422,6 +435,7 @@ export {
   updateWorkbookSelectedNodeId,
   updateWorkbookSharingLink,
   updateWorkbookVariables,
+  useActionOutbound,
   usePageHeight,
   useSigmaIframe,
   useTableCellSelect,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sigmacomputing/react-embed-sdk",
   "author": "sigmacomputing",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "React JavaScript SDK to interact with Sigma Computing's Embed API",
   "license": "MIT",
   "repository": {
@@ -35,11 +35,11 @@
     "@types/react": "^18.3.3",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
-    "@sigmacomputing/typescript-config": "0.0.0",
-    "@sigmacomputing/eslint-config": "0.0.0"
+    "@sigmacomputing/eslint-config": "0.0.0",
+    "@sigmacomputing/typescript-config": "0.0.0"
   },
   "dependencies": {
-    "@sigmacomputing/embed-sdk": "0.4.0"
+    "@sigmacomputing/embed-sdk": "0.5.0"
   },
   "scripts": {
     "prepublish": "pnpm build",