@sigmacomputing/react-embed-sdk 0.3.3 → 0.5.0

package/README.md

@@ -0,0 +1,327 @@
+## Getting Started
+
+To use the react-embed-sdk in your project, you can install it using your node package manager.
+
+**Using npm:**
+
+```code
+npm install @sigmacomputing/react-embed-sdk
+```
+
+**yarn:**
+
+```code
+yarn add @sigmacomputing/react-embed-sdk
+```
+
+**pnpm:**
+
+```code
+pnpm add @sigmacomputing/react-embed-sdk
+```
+
+## Documentation
+
+### Hooks
+
+The library provides hooks that combine the lower level [listeners](#listeners) and [mutations](#mutations) to provide a more ergonomic API.
+
+#### useSigmaIframe
+
+A hook that returns a ref to be used with a Sigma iframe element, and the loading and error state of the embed.
+
+```typescript
+useSigmaIframe(): {
+  iframeRef: React.RefObject<HTMLIFrameElement>;
+  loading: boolean;
+  error: WorkbookErrorEvent | null;
+  variables: Record<string, string> | undefined;
+}
+```
+
+Example usage:
+
+```tsx
+function MyEmbed() {
+  const { iframeRef, loading, error } = useSigmaIframe();
+  return (
+    <>
+      {loading && <p>Loading...</p>}
+      {error && <p>Error: {error.message}</p>}
+      <iframe
+        className={loading || error ? "hidden" : "show"}
+        ref={iframeRef}
+        {/* The embed url to load */}
+        src="https://app.sigmacomputing.com/embed"
+      />
+    </>
+  );
+}
+```
+
+#### useWorkbookVariables
+
+A hook that returns functions to get and set the variables in a workbook.
+
+```typescript
+useWorkbookVariables(iframeRef: React.RefObject<HTMLIFrameElement>): {
+  getVariables: () => Promise<Record<string, string>>;
+  setVariables: (variables: Record<string, string>) => void;
+}
+```
+
+Example usage:
+
+```tsx
+function MyEmbed() {
+  const { getVariables, setVariables } = useWorkbookVariables(iframeRef);
+  return (
+    <>
+      <button onClick={() => setVariables({ foo: "bar" }))} name="set-variables">Set Filters</button>
+      <button
+        onClick={async () => {
+          const variable = await getVariables();
+        }}
+        name="get-variables"
+      >
+        Get Filters
+      </button>
+      <iframe ref={iframeRef} src="https://app.sigmacomputing.com/embed" />
+    </>
+  );
+}
+```
+
+#### usePageHeight
+
+A hook that returns the height of the page in the iframe. This HAS to be used with the responsive_height [URL Parameter](https://help.sigmacomputing.com/docs/embed-url-parameters).
+
+```typescript
+usePageHeight(iframeRef: React.RefObject<HTMLIFrameElement>): number | undefined
+```
+
+Example usage:
+
+```tsx
+function MyEmbed() {
+  const { iframeRef } = useSigmaIframe();
+  const height = usePageHeight(iframeRef);
+  return (
+    <>
+      <iframe
+        style={{ height }}
+        ref={iframeRef}
+        src="https://app.sigmacomputing.com/embed?:responsive_height=true"
+      />
+    </>
+  );
+}
+```
+
+### Listeners
+
+These are functions that can be used to listen for events from the embed, and react to them.
+
+#### useWorkbookLoaded
+
+Listen for a workbook loaded event, and execute the given callback when it occurs.
+
+```typescript
+useWorkbookLoaded(iframeRef: React.RefObject<HTMLIFrameElement>, onLoaded: (event: WorkbookLoadedEvent) => void)
+```
+
+#### useWorkbookError
+
+Listen for a workbook error event, and execute the given callback when it occurs.
+
+```typescript
+useWorkbookError(iframeRef: React.RefObject<HTMLIFrameElement>, onError: (event: WorkbookErrorEvent) => void)
+```
+
+#### useWorkbookDataLoaded
+
+Listen for a workbook data loaded event, and execute the given callback when it occurs.
+
+```typescript
+useWorkbookDataLoaded(iframeRef: React.RefObject<HTMLIFrameElement>, onDataLoaded: (event: WorkbookDataLoadedEvent) => void)
+```
+
+#### useVariableChange
+
+Listen for a workbook variable change event, and execute the given callback when it occurs.
+
+```typescript
+useVariableChange(iframeRef: React.RefObject<HTMLIFrameElement>, onVariableChange: (event: WorkbookVariableOnChangeEvent) => void)
+```
+
+#### useTableCellSelect
+
+Listen for a table cell select event, and execute the given callback when it occurs.
+
+```typescript
+useTableCellSelect(iframeRef: React.RefObject<HTMLIFrameElement>, onTableCellSelect: (event: WorkbookTableCellSelectEvent) => void)
+```
+
+#### useWorkbookPublished
+
+Listen for a workbook published event, and execute the given callback when it occurs.
+
+```typescript
+useWorkbookPublished(iframeRef: React.RefObject<HTMLIFrameElement>, onWorkbookPublished: (event: WorkbookPublishedEvent) => void)
+```
+
+#### useWorkbookFullScreen
+
+Listen for a workbook full screen event, and execute the given callback when it occurs.
+
+```typescript
+useWorkbookFullScreen(iframeRef: React.RefObject<HTMLIFrameElement>, onFullScreen: (event: WorkbookFullScreenEvent) => void)
+```
+
+#### useWorkbookPageHeight
+
+Listen for a workbook page height event, and execute the given callback when it occurs. Needs to be used with the responsive_height [URL Parameter](https://help.sigmacomputing.com/docs/embed-url-parameters).
+
+```typescript
+useWorkbookPageHeight(iframeRef: React.RefObject<HTMLIFrameElement>, onPageHeight: (event: WorkbookPageHeightEvent) => void)
+```
+
+#### useWorkbookSelectedNode
+
+Listen for a workbook selected node event, and execute the given callback when it occurs.
+
+```typescript
+useWorkbookSelectedNode(iframeRef: React.RefObject<HTMLIFrameElement>, onPageSelectedNode: (event: WorkbookSelectedNodeEvent) => void)
+```
+
+#### useWorkbookPivotTableCellSelect
+
+Listen for a pivot table cell select event, and execute the given callback when it occurs.
+
+```typescript
+useWorkbookPivotTableCellSelect(iframeRef: React.RefObject<HTMLIFrameElement>, onPivotTableCellSelect: (event: WorkbookPivotTableCellSelectEvent) => void)
+```
+
+#### useWorkbookChartValueSelect
+
+Listen for a chart value select event, and execute the given callback when it occurs.
+
+```typescript
+useWorkbookChartValueSelect(iframeRef: React.RefObject<HTMLIFrameElement>, onChartValueSelect: (event: WorkbookChartValueSelectEvent) => void)
+```
+
+#### useWorkbookCurrentVariables
+
+Listen for a workbook current variables event, and execute the given callback when it occurs. This is to be used when `workbookVariablesList` is called.
+
+```typescript
+useWorkbookCurrentVariables(iframeRef: React.RefObject<HTMLIFrameElement>, onCurrentVariables: (event: WorkbookCurrentVariablesEvent) => void)
+```
+
+#### useWorkbookBookmarkOnCreate
+
+Listen for a workbook bookmark create event, and execute the given callback when it occurs.
+
+```typescript
+useWorkbookBookmarkOnCreate(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkCreate: (event: WorkbookBookmarkOnCreateEvent) => void)
+```
+
+#### useWorkbookChartError
+
+Listen for a workbook chart error event, and execute the given callback when it occurs.
+
+```typescript
+useWorkbookChartError(iframeRef: React.RefObject<HTMLIFrameElement>, onChartError: (event: WorkbookChartErrorEvent) => void)
+```
+
+#### useWorkbookExploreKeyOnChange
+
+Listen for a workbook explore key change event, and execute the given callback when it occurs.
+
+```typescript
+useWorkbookExploreKeyOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onExploreKeyOnChange: (event: WorkbookExploreKeyOnChangeEvent) => void)
+```
+
+#### useWorkbookBookmarkOnChange
+
+Listen for a workbook bookmark change event, and execute the given callback when it occurs.
+
+```typescript
+useWorkbookBookmarkOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkChange: (event: WorkbookBookmarkOnChangeEvent) => void)
+```
+
+#### useUrlOnChange
+
+Listen for a url change event, and execute the given callback when it occurs.
+
+```typescript
+useUrlOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onUrlChange: (event: UrlOnChangeEvent) => void)
+```
+
+#### useWorkbookIdOnChange
+
+Listen for a workbook id change event, and execute the given callback when it occurs.
+
+```typescript
+useWorkbookIdOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onWorkbookIdChange: (event: WorkbookIdOnChangeEvent) => void)
+```
+
+### Mutations
+
+These are functions that can be used to send messages to the embed. They may cause an event to be emitted from the embed.
+
+#### getWorkbookVariables
+
+Send a message to the embed to list the current variables. This will cause a `workbook:variables:current` event to be emitted from the embed, and can be used with the `useWorkbookCurrentVariables` function.
+
+```typescript
+getWorkbookVariables(iframeRef: React.RefObject<HTMLIFrameElement>)
+```
+
+#### updateWorkbookVariables
+
+Send a message to the embed to update the variables.
+
+```typescript
+updateWorkbookVariables(iframeRef: React.RefObject<HTMLIFrameElement>, variables: Record<string, string>)
+```
+
+#### createWorkbookBookmark
+
+Send a message to the embed to create a bookmark.
+
+```typescript
+createWorkbookBookmark(iframeRef: React.RefObject<HTMLIFrameElement>, bookmark: WorkbookBookmarkCreateEvent)
+```
+
+#### updateWorkbookBookmark
+
+Send a message to the embed to update the current bookmark.
+
+```typescript
+updateWorkbookBookmark(iframeRef: React.RefObject<HTMLIFrameElement>)
+```
+
+#### updateWorkbookFullscreen
+
+Send a message to the embed to toggle the fullscreen state of the given element.
+
+```typescript
+updateWorkbookFullscreen(iframeRef: React.RefObject<HTMLIFrameElement>, nodeId: string | null)
+```
+
+#### updateWorkbookSelectedNodeId
+
+Send a message to the embed to update the selected element. Can be a pageId or elementId.
+
+```typescript
+updateWorkbookSelectedNodeId(iframeRef: React.RefObject<HTMLIFrameElement>, nodeId: string, nodeType: "element" | "page")
+```
+
+#### updateWorkbookSharingLink
+
+Send a message to the embed to update the sharing link.
+
+```typescript
+updateWorkbookSharingLink(iframeRef: React.RefObject<HTMLIFrameElement>, sharingLink: string | null, sharingExplorationLink?: string | null)
+```

package/dist/index.d.mts

@@ -1,6 +1,5 @@
-import { WorkbookErrorEvent, WorkbookLoadedEvent, WorkbookDataLoadedEvent, WorkbookVariableOnChangeEvent, WorkbookTableCellSelectEvent, WorkbookPublishedEvent, WorkbookFullScreenEvent, WorkbookPageHeightEvent, WorkbookPageSelectedNodeEvent, 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';
-import * as react from 'react';
 
 /**
  * A hook that returns a ref to be used with an iframe element, and the loading and error state of the embed.
@@ -24,10 +23,10 @@ import * as react from 'react';
  * ```
  */
 declare function useSigmaIframe(): {
-    iframeRef: react.RefObject<HTMLIFrameElement>;
+    iframeRef: React.RefObject<HTMLIFrameElement>;
     loading: boolean;
     error: WorkbookErrorEvent | null;
-    variables: Record<string, string> | null | undefined;
+    variables: Record<string, string> | undefined;
 };
 
 /**
@@ -147,7 +146,7 @@ declare function useTableCellSelect(iframeRef: React.RefObject<HTMLIFrameElement
 declare function useWorkbookPublished(iframeRef: React.RefObject<HTMLIFrameElement>, onWorkbookPublished: (event: WorkbookPublishedEvent) => void): void;
 declare function useWorkbookFullScreen(iframeRef: React.RefObject<HTMLIFrameElement>, onFullScreen: (event: WorkbookFullScreenEvent) => void): void;
 declare function useWorkbookPageHeight(iframeRef: React.RefObject<HTMLIFrameElement>, onPageHeight: (event: WorkbookPageHeightEvent) => void): void;
-declare function useWorkbookPageSelectedNode(iframeRef: React.RefObject<HTMLIFrameElement>, onPageSelectedNode: (event: WorkbookPageSelectedNodeEvent) => void): void;
+declare function useWorkbookSelectedNode(iframeRef: React.RefObject<HTMLIFrameElement>, onPageSelectedNode: (event: WorkbookSelectedNodeEvent) => void): void;
 declare function useWorkbookPivotTableCellSelect(iframeRef: React.RefObject<HTMLIFrameElement>, onPivotTableCellSelect: (event: WorkbookPivotTableCellSelectEvent) => void): void;
 declare function useWorkbookChartValueSelect(iframeRef: React.RefObject<HTMLIFrameElement>, onChartValueSelect: (event: WorkbookChartValueSelectEvent) => void): void;
 declare function useWorkbookCurrentVariables(iframeRef: React.RefObject<HTMLIFrameElement>, onCurrentVariables: (event: WorkbookCurrentVariablesEvent) => void): void;
@@ -157,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;
@@ -166,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, useWorkbookPageSelectedNode, useWorkbookPivotTableCellSelect, useWorkbookPublished, 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,6 +1,5 @@
-import { WorkbookErrorEvent, WorkbookLoadedEvent, WorkbookDataLoadedEvent, WorkbookVariableOnChangeEvent, WorkbookTableCellSelectEvent, WorkbookPublishedEvent, WorkbookFullScreenEvent, WorkbookPageHeightEvent, WorkbookPageSelectedNodeEvent, 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';
-import * as react from 'react';
 
 /**
  * A hook that returns a ref to be used with an iframe element, and the loading and error state of the embed.
@@ -24,10 +23,10 @@ import * as react from 'react';
  * ```
  */
 declare function useSigmaIframe(): {
-    iframeRef: react.RefObject<HTMLIFrameElement>;
+    iframeRef: React.RefObject<HTMLIFrameElement>;
     loading: boolean;
     error: WorkbookErrorEvent | null;
-    variables: Record<string, string> | null | undefined;
+    variables: Record<string, string> | undefined;
 };
 
 /**
@@ -147,7 +146,7 @@ declare function useTableCellSelect(iframeRef: React.RefObject<HTMLIFrameElement
 declare function useWorkbookPublished(iframeRef: React.RefObject<HTMLIFrameElement>, onWorkbookPublished: (event: WorkbookPublishedEvent) => void): void;
 declare function useWorkbookFullScreen(iframeRef: React.RefObject<HTMLIFrameElement>, onFullScreen: (event: WorkbookFullScreenEvent) => void): void;
 declare function useWorkbookPageHeight(iframeRef: React.RefObject<HTMLIFrameElement>, onPageHeight: (event: WorkbookPageHeightEvent) => void): void;
-declare function useWorkbookPageSelectedNode(iframeRef: React.RefObject<HTMLIFrameElement>, onPageSelectedNode: (event: WorkbookPageSelectedNodeEvent) => void): void;
+declare function useWorkbookSelectedNode(iframeRef: React.RefObject<HTMLIFrameElement>, onPageSelectedNode: (event: WorkbookSelectedNodeEvent) => void): void;
 declare function useWorkbookPivotTableCellSelect(iframeRef: React.RefObject<HTMLIFrameElement>, onPivotTableCellSelect: (event: WorkbookPivotTableCellSelectEvent) => void): void;
 declare function useWorkbookChartValueSelect(iframeRef: React.RefObject<HTMLIFrameElement>, onChartValueSelect: (event: WorkbookChartValueSelectEvent) => void): void;
 declare function useWorkbookCurrentVariables(iframeRef: React.RefObject<HTMLIFrameElement>, onCurrentVariables: (event: WorkbookCurrentVariablesEvent) => void): void;
@@ -157,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;
@@ -166,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, useWorkbookPageSelectedNode, useWorkbookPivotTableCellSelect, useWorkbookPublished, 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,
@@ -44,9 +45,9 @@ __export(src_exports, {
   useWorkbookIdOnChange: () => useWorkbookIdOnChange,
   useWorkbookLoaded: () => useWorkbookLoaded,
   useWorkbookPageHeight: () => useWorkbookPageHeight,
-  useWorkbookPageSelectedNode: () => useWorkbookPageSelectedNode,
   useWorkbookPivotTableCellSelect: () => useWorkbookPivotTableCellSelect,
   useWorkbookPublished: () => useWorkbookPublished,
+  useWorkbookSelectedNode: () => useWorkbookSelectedNode,
   useWorkbookVariables: () => useWorkbookVariables
 });
 module.exports = __toCommonJS(src_exports);
@@ -161,13 +162,13 @@ function useWorkbookPageHeight(iframeRef, onPageHeight) {
     return () => window.removeEventListener("message", listener);
   }, [iframeRef, onPageHeight]);
 }
-function useWorkbookPageSelectedNode(iframeRef, onPageSelectedNode) {
+function useWorkbookSelectedNode(iframeRef, onPageSelectedNode) {
   (0, import_react.useEffect)(() => {
     const listener = (event) => {
       if (!iframeRef.current) {
         return;
       }
-      (0, import_embed_sdk.workbookPageSelectedNodeListener)(
+      (0, import_embed_sdk.workbookSelectedNodeListener)(
         event,
         iframeRef.current,
         onPageSelectedNode
@@ -309,12 +310,24 @@ 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() {
   const iframeRef = (0, import_react2.useRef)(null);
   const [loading, setLoading] = (0, import_react2.useState)(true);
-  const [variables, setVariables] = (0, import_react2.useState)();
+  const [variables, setVariables] = (0, import_react2.useState)(void 0);
   const [error, setError] = (0, import_react2.useState)(null);
   const loadingCallback = (0, import_react2.useCallback)((event) => {
     setLoading(false);
@@ -445,6 +458,7 @@ function updateWorkbookSharingLink(iframeRef, sharingLink, sharingExplorationLin
   updateWorkbookSelectedNodeId,
   updateWorkbookSharingLink,
   updateWorkbookVariables,
+  useActionOutbound,
   usePageHeight,
   useSigmaIframe,
   useTableCellSelect,
@@ -462,8 +476,8 @@ function updateWorkbookSharingLink(iframeRef, sharingLink, sharingExplorationLin
   useWorkbookIdOnChange,
   useWorkbookLoaded,
   useWorkbookPageHeight,
-  useWorkbookPageSelectedNode,
   useWorkbookPivotTableCellSelect,
   useWorkbookPublished,
+  useWorkbookSelectedNode,
   useWorkbookVariables
 });

package/dist/index.mjs

@@ -12,7 +12,7 @@ import {
   workbookFullScreenListener,
   workbookPageHeightListener,
   workbookChartValueSelectListener,
-  workbookPageSelectedNodeListener,
+  workbookSelectedNodeListener,
   workbookPivotTableCellSelectListener,
   workbookBookmarkCreateListener,
   workbookCurrentVariablesListener,
@@ -20,7 +20,8 @@ import {
   workbookExploreKeyOnChangeListener,
   workbookBookmarkOnChangeListener,
   urlOnChangeListener,
-  workbookIdOnChangeListener
+  workbookIdOnChangeListener,
+  actionOutboundListener
 } from "@sigmacomputing/embed-sdk";
 import { useEffect } from "react";
 function useWorkbookLoaded(iframeRef, onLoaded) {
@@ -127,13 +128,13 @@ function useWorkbookPageHeight(iframeRef, onPageHeight) {
     return () => window.removeEventListener("message", listener);
   }, [iframeRef, onPageHeight]);
 }
-function useWorkbookPageSelectedNode(iframeRef, onPageSelectedNode) {
+function useWorkbookSelectedNode(iframeRef, onPageSelectedNode) {
   useEffect(() => {
     const listener = (event) => {
       if (!iframeRef.current) {
         return;
       }
-      workbookPageSelectedNodeListener(
+      workbookSelectedNodeListener(
         event,
         iframeRef.current,
         onPageSelectedNode
@@ -275,12 +276,24 @@ 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() {
   const iframeRef = useRef(null);
   const [loading, setLoading] = useState(true);
-  const [variables, setVariables] = useState();
+  const [variables, setVariables] = useState(void 0);
   const [error, setError] = useState(null);
   const loadingCallback = useCallback((event) => {
     setLoading(false);
@@ -422,6 +435,7 @@ export {
   updateWorkbookSelectedNodeId,
   updateWorkbookSharingLink,
   updateWorkbookVariables,
+  useActionOutbound,
   usePageHeight,
   useSigmaIframe,
   useTableCellSelect,
@@ -439,8 +453,8 @@ export {
   useWorkbookIdOnChange,
   useWorkbookLoaded,
   useWorkbookPageHeight,
-  useWorkbookPageSelectedNode,
   useWorkbookPivotTableCellSelect,
   useWorkbookPublished,
+  useWorkbookSelectedNode,
   useWorkbookVariables
 };

package/package.json

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