@sigmacomputing/embed-sdk 0.3.3 → 0.5.0

package/README.md

@@ -0,0 +1,247 @@
+## Getting Started
+
+To use the embed-sdk in your project, you can install it using your node package manager.
+
+**Using npm:**
+
+```code
+npm install @sigmacomputing/embed-sdk
+```
+
+**yarn:**
+
+```code
+yarn add @sigmacomputing/embed-sdk
+```
+
+**pnpm:**
+
+```code
+pnpm add @sigmacomputing/embed-sdk
+```
+
+## Documentation
+
+### Listeners
+
+These are functions that can be used to listen for events from the embed, and react to them.
+
+#### workbookLoadedListener
+
+Listen for a workbook loaded event, and execute the given callback when it occurs.
+
+```typescript
+workbookLoadedListener(event: MessageEvent, iframe: HTMLIFrameElement, onLoaded: (event: WorkbookLoadedEvent) => void)
+```
+
+#### workbookErrorListener
+
+Listen for a workbook error event, and execute the given callback when it occurs.
+
+```typescript
+workbookErrorListener(event: MessageEvent, iframe: HTMLIFrameElement, onError: (event: WorkbookErrorEvent) => void)
+```
+
+#### workbookVariableChangeListener
+
+Listen for a workbook variable change event, and execute the given callback when it occurs.
+
+```typescript
+workbookVariableChangeListener(event: MessageEvent, iframe: HTMLIFrameElement, onVariable: (event: WorkbookVariableOnChangeEvent) => void)
+```
+
+#### workbookVariableCurrentListener
+
+Listen for a workbook variable current event, and execute the given callback when it occurs.
+
+```typescript
+workbookVariableCurrentListener(event: MessageEvent, iframe: HTMLIFrameElement, onVariable: (event: WorkbookVariableCurrentEvent) => void)
+```
+
+#### workbookLinkSharingUpdateListener
+
+Listen for a workbook sharing link update event, and execute the given callback when it occurs.
+
+```typescript
+workbookLinkSharingUpdateListener(event: MessageEvent, iframe: HTMLIFrameElement, onVariable: (event: WorkbookSharingLinkUpdateEvent) => void)
+```
+
+#### workbookTableCellSelectListener
+
+Listen for a table cell select event, and execute the given callback when it occurs.
+
+```typescript
+workbookTableCellSelectListener(event: MessageEvent, iframe: HTMLIFrameElement, onTableCellSelect: (event: WorkbookTableCellSelectEvent) => void)
+```
+
+#### workbookPublishedListener
+
+Listen for a workbook published event, and execute the given callback when it occurs.
+
+```typescript
+workbookPublishedListener(event: MessageEvent, iframe: HTMLIFrameElement, onPublished: (event: WorkbookPublishedEvent) => void)
+```
+
+#### workbookFullScreenListener
+
+Listen for a workbook full screen event, and execute the given callback when it occurs.
+
+```typescript
+workbookFullScreenListener(event: MessageEvent, iframe: HTMLIFrameElement, onFullScreen: (event: WorkbookFullScreenEvent) => void)
+```
+
+#### workbookPageHeightListener
+
+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
+workbookPageHeightListener(event: MessageEvent, iframe: HTMLIFrameElement, onPageHeight: (event: WorkbookPageHeightEvent) => void)
+```
+
+#### workbookSelectedNodeListener
+
+Listen for a workbook selected node event, and execute the given callback when it occurs.
+
+```typescript
+workbookSelectedNodeListener(event: MessageEvent, iframe: HTMLIFrameElement, onPageSelectedNode: (event: WorkbookSelectedNodeEvent) => void)
+```
+
+#### workbookPivotTableCellSelectListener
+
+Listen for a pivot table cell select event, and execute the given callback when it occurs.
+
+```typescript
+workbookPivotTableCellSelectListener(event: MessageEvent, iframe: HTMLIFrameElement, onPivotTableCellSelect: (event: WorkbookPivotTableCellSelectEvent) => void)
+```
+
+#### workbookChartValueSelectListener
+
+Listen for a chart value select event, and execute the given callback when it occurs.
+
+```typescript
+workbookChartValueSelectListener(event: MessageEvent, iframe: HTMLIFrameElement, onChartValueSelect: (event: WorkbookChartValueSelectEvent) => void)
+```
+
+#### workbookCurrentVariablesListener
+
+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
+workbookCurrentVariablesListener(event: MessageEvent, iframe: HTMLIFrameElement, onCurrentVariables: (event: WorkbookCurrentVariablesEvent) => void)
+```
+
+#### workbookBookmarkCreateListener
+
+Listen for a workbook bookmark create event, and execute the given callback when it occurs.
+
+```typescript
+workbookBookmarkCreateListener(event: MessageEvent, iframe: HTMLIFrameElement, onBookmarkCreate: (event: WorkbookBookmarkOnCreateEvent) => void)
+```
+
+#### workbookDataLoadedListener
+
+Listen for a workbook data loaded event, and execute the given callback when it occurs.
+
+```typescript
+workbookDataLoadedListener(event: MessageEvent, iframe: HTMLIFrameElement, onWorkbookDataLoaded: (event: WorkbookDataLoadedEvent) => void)
+```
+
+#### workbookChartErrorListener
+
+Listen for a workbook chart error event, and execute the given callback when it occurs.
+
+```typescript
+workbookChartErrorListener(event: MessageEvent, iframe: HTMLIFrameElement, onChartError: (event: WorkbookChartErrorEvent) => void)
+```
+
+#### workbookExploreKeyOnChangeListener
+
+Listen for a workbook explore key change event, and execute the given callback when it occurs.
+
+```typescript
+workbookExploreKeyOnChangeListener(event: MessageEvent, iframe: HTMLIFrameElement, onExploreKeyOnChange: (event: WorkbookExploreKeyOnChangeEvent) => void)
+```
+
+#### workbookBookmarkOnChangeListener
+
+Listen for a workbook bookmark change event, and execute the given callback when it occurs.
+
+```typescript
+workbookBookmarkOnChangeListener(event: MessageEvent, iframe: HTMLIFrameElement, onBookmarkChange: (event: WorkbookBookmarkOnChangeEvent) => void)
+```
+
+#### urlOnChangeListener
+
+Listen for a url change event, and execute the given callback when it occurs.
+
+```typescript
+urlOnChangeListener(event: MessageEvent, iframe: HTMLIFrameElement, onUrlChange: (event: UrlOnChangeEvent) => void)
+```
+
+#### workbookIdOnChangeListener
+
+Listen for a workbook id change event, and execute the given callback when it occurs.
+
+```typescript
+workbookIdOnChangeListener(event: MessageEvent, iframe: 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.
+
+#### workbookVariablesList
+
+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 `workbookCurrentVariablesListener` function.
+
+```typescript
+workbookVariablesList(iframe: HTMLIFrameElement)
+```
+
+#### workbookVariablesUpdate
+
+Send a message to the embed to update the variables.
+
+```typescript
+workbookVariablesUpdate(iframe: HTMLIFrameElement, variables: Record<string, string>)
+```
+
+#### workbookSharingLinkUpdate
+
+Send a message to the embed to update the sharing link.
+
+```typescript
+workbookSharingLinkUpdate(iframe: HTMLIFrameElement, sharingLink: string | null, sharingExplorationLink?: string | null)
+```
+
+#### workbookBookmarkCreate
+
+Send a message to the embed to create a bookmark.
+
+```typescript
+workbookBookmarkCreate(iframe: HTMLIFrameElement, bookmark: WorkbookBookmarkCreateEvent)
+```
+
+#### workbookBookmarkUpdate
+
+Send a message to the embed to update the current bookmark.
+
+```typescript
+workbookBookmarkUpdate(iframe: HTMLIFrameElement)
+```
+
+#### workbookFullscreenUpdate
+
+Send a message to the embed to toggle the fullscreen state of the given element.
+
+```typescript
+workbookFullscreenUpdate(iframe: HTMLIFrameElement, nodeId: string | null)
+```
+
+#### workbookSelectedNodeIdUpdate
+
+Send a message to the embed to update the selected element. Can be a pageId or elementId.
+
+```typescript
+workbookSelectedNodeIdUpdate(iframe: HTMLIFrameElement, nodeId: string, nodeType: "element" | "page")
+```

package/dist/index.d.mts

@@ -45,7 +45,7 @@ declare const WorkbookTableCellSelectEventName: "workbook:table:oncellselect";
 declare const WorkbookPublishedEventName: "workbook:published";
 declare const WorkbookFullScreenEventName: "workbook:fullscreen:onchange";
 declare const WorkbookPageHeightEventName: "workbook:pageheight:onchange";
-declare const WorkbookPageSelectedNodeEventName: "workbook:selectednodeid:onchange";
+declare const WorkbookSelectedNodeEventName: "workbook:selectednodeid:onchange";
 declare const WorkbookPivotTableCellSelectEventName: "workbook:pivottable:oncellselect";
 declare const WorkbookChartValueSelectEventName: "workbook:chart:onvalueselect";
 declare const WorkbookCurrentVariablesEventName: "workbook:variables:current";
@@ -64,6 +64,7 @@ declare const WorkbookVariablesListEventName: "workbook:variables:list";
 declare const WorkbookVariablesUpdateEventName: "workbook:variables:update";
 declare const WorkbookVariablesCurrentEventName: "workbook:variables:current";
 declare const WorkbookSharingLinkUpdateEventName: "workbook:sharinglink:update";
+declare const ActionOutboundEventName: "action:outbound";
 interface WorkbookLoadedEvent {
     type: typeof WorkbookLoadedEventName;
     workbook: {
@@ -105,8 +106,8 @@ type WorkbookPageHeightEvent = {
     type: typeof WorkbookPageHeightEventName;
     pageHeight: number;
 };
-type WorkbookPageSelectedNodeEvent = {
-    type: typeof WorkbookPageSelectedNodeEventName;
+type WorkbookSelectedNodeEvent = {
+    type: typeof WorkbookSelectedNodeEventName;
     selectedNodeId: string | null;
 };
 type WorkbookPivotTableCellSelectEvent = {
@@ -165,6 +166,11 @@ type WorkbookBookmarkCreateEvent = {
     isDefault: boolean;
     isShared: boolean;
 };
+type ActionOutboundEvent = {
+    type: typeof ActionOutboundEventName;
+    name: string;
+    values: Record<string, unknown>;
+};
 
 declare const workbookLoadedListener: (event: MessageEvent, iframe: HTMLIFrameElement, onLoaded: (event: WorkbookLoadedEvent) => void) => void;
 declare const workbookErrorListener: (event: MessageEvent, iframe: HTMLIFrameElement, onError: (event: WorkbookErrorEvent) => void) => void;
@@ -175,7 +181,7 @@ declare const workbookTableCellSelectListener: (event: MessageEvent, iframe: HTM
 declare const workbookPublishedListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPublished: (event: WorkbookPublishedEvent) => void) => void;
 declare const workbookFullScreenListener: (event: MessageEvent, iframe: HTMLIFrameElement, onFullScreen: (event: WorkbookFullScreenEvent) => void) => void;
 declare const workbookPageHeightListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPageHeight: (event: WorkbookPageHeightEvent) => void) => void;
-declare const workbookPageSelectedNodeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPageSelectedNode: (event: WorkbookPageSelectedNodeEvent) => void) => void;
+declare const workbookSelectedNodeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPageSelectedNode: (event: WorkbookSelectedNodeEvent) => void) => void;
 declare const workbookPivotTableCellSelectListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPivotTableCellSelect: (event: WorkbookPivotTableCellSelectEvent) => void) => void;
 declare const workbookChartValueSelectListener: (event: MessageEvent, iframe: HTMLIFrameElement, onChartValueSelect: (event: WorkbookChartValueSelectEvent) => void) => void;
 declare const workbookCurrentVariablesListener: (event: MessageEvent, iframe: HTMLIFrameElement, onCurrentVariables: (event: WorkbookCurrentVariablesEvent) => void) => void;
@@ -186,6 +192,7 @@ declare const workbookExploreKeyOnChangeListener: (event: MessageEvent, iframe:
 declare const workbookBookmarkOnChangeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onBookmarkChange: (event: WorkbookBookmarkOnChangeEvent) => void) => void;
 declare const urlOnChangeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onUrlChange: (event: UrlOnChangeEvent) => void) => void;
 declare const workbookIdOnChangeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onWorkbookIdChange: (event: WorkbookIdOnChangeEvent) => void) => void;
+declare const actionOutboundListener: (event: MessageEvent, iframe: HTMLIFrameElement, onActionOutbound: (event: ActionOutboundEvent) => void) => void;
 
 declare const workbookBookmarkCreate: (iframe: HTMLIFrameElement, bookmark: WorkbookBookmarkCreateEvent) => void;
 declare const workbookBookmarkUpdate: (iframe: HTMLIFrameElement) => void;
@@ -195,4 +202,4 @@ declare const workbookVariablesList: (iframe: HTMLIFrameElement) => void;
 declare const workbookVariablesUpdate: (iframe: HTMLIFrameElement, variables: Record<string, string>) => void;
 declare const workbookSharingLinkUpdate: (iframe: HTMLIFrameElement, sharingLink: string | null, sharingExplorationLink?: string | null) => void;
 
-export { CellType_t, type Cell_t, type ChartValue_t, type ChartValues_t, type DataRow_t, type DataRows_t, type Data_t, type LevelTableCell_t, type LevelTableCells, type LevelTableColumnCell_t, type LevelTableValueCell_t, type PathChunk_t, type PivotPath_t, type PivotTableCell_t, type PivotTableCells_t, type UrlOnChangeEvent, UrlOnChangeEventName, type Value_t, type WorkbookBookmarkCreateEvent, WorkbookBookmarkCreateEventName, type WorkbookBookmarkOnChangeEvent, WorkbookBookmarkOnChangeEventName, type WorkbookBookmarkOnCreateEvent, WorkbookBookmarkOnCreateEventName, WorkbookBookmarkUpdateEventName, type WorkbookChartErrorEvent, WorkbookChartErrorEventName, type WorkbookChartValueSelectEvent, WorkbookChartValueSelectEventName, type WorkbookCurrentVariablesEvent, WorkbookCurrentVariablesEventName, type WorkbookDataLoadedEvent, WorkbookDataLoadedEventName, type WorkbookErrorEvent, WorkbookErrorEventName, type WorkbookExploreKeyOnChangeEvent, WorkbookExploreKeyOnChangeEventName, type WorkbookFullScreenEvent, WorkbookFullScreenEventName, WorkbookFullscreenUpdateEventName, type WorkbookIdOnChangeEvent, WorkbookIdOnChangeEventName, type WorkbookLoadedEvent, WorkbookLoadedEventName, type WorkbookPageHeightEvent, WorkbookPageHeightEventName, type WorkbookPageSelectedNodeEvent, WorkbookPageSelectedNodeEventName, type WorkbookPivotTableCellSelectEvent, WorkbookPivotTableCellSelectEventName, type WorkbookPublishedEvent, WorkbookPublishedEventName, WorkbookSelectedNodeIdUpdateEventName, type WorkbookSharingLinkUpdateEvent, WorkbookSharingLinkUpdateEventName, type WorkbookTableCellSelectEvent, WorkbookTableCellSelectEventName, type WorkbookVariableCurrentEvent, WorkbookVariableEventOnChangeName, type WorkbookVariableOnChangeEvent, WorkbookVariablesCurrentEventName, WorkbookVariablesListEventName, WorkbookVariablesUpdateEventName, urlOnChangeListener, workbookBookmarkCreate, workbookBookmarkCreateListener, workbookBookmarkOnChangeListener, workbookBookmarkUpdate, workbookChartErrorListener, workbookChartValueSelectListener, workbookCurrentVariablesListener, workbookDataLoadedListener, workbookErrorListener, workbookExploreKeyOnChangeListener, workbookFullScreenListener, workbookFullscreenUpdate, workbookIdOnChangeListener, workbookLinkSharingUpdateListener, workbookLoadedListener, workbookPageHeightListener, workbookPageSelectedNodeListener, workbookPivotTableCellSelectListener, workbookPublishedListener, workbookSelectedNodeIdUpdate, workbookSharingLinkUpdate, workbookTableCellSelectListener, workbookVariableChangeListener, workbookVariableCurrentListener, workbookVariablesList, workbookVariablesUpdate };
+export { type ActionOutboundEvent, ActionOutboundEventName, CellType_t, type Cell_t, type ChartValue_t, type ChartValues_t, type DataRow_t, type DataRows_t, type Data_t, type LevelTableCell_t, type LevelTableCells, type LevelTableColumnCell_t, type LevelTableValueCell_t, type PathChunk_t, type PivotPath_t, type PivotTableCell_t, type PivotTableCells_t, type UrlOnChangeEvent, UrlOnChangeEventName, type Value_t, type WorkbookBookmarkCreateEvent, WorkbookBookmarkCreateEventName, type WorkbookBookmarkOnChangeEvent, WorkbookBookmarkOnChangeEventName, type WorkbookBookmarkOnCreateEvent, WorkbookBookmarkOnCreateEventName, WorkbookBookmarkUpdateEventName, type WorkbookChartErrorEvent, WorkbookChartErrorEventName, type WorkbookChartValueSelectEvent, WorkbookChartValueSelectEventName, type WorkbookCurrentVariablesEvent, WorkbookCurrentVariablesEventName, type WorkbookDataLoadedEvent, WorkbookDataLoadedEventName, type WorkbookErrorEvent, WorkbookErrorEventName, type WorkbookExploreKeyOnChangeEvent, WorkbookExploreKeyOnChangeEventName, type WorkbookFullScreenEvent, WorkbookFullScreenEventName, WorkbookFullscreenUpdateEventName, type WorkbookIdOnChangeEvent, WorkbookIdOnChangeEventName, type WorkbookLoadedEvent, WorkbookLoadedEventName, type WorkbookPageHeightEvent, WorkbookPageHeightEventName, type WorkbookPivotTableCellSelectEvent, WorkbookPivotTableCellSelectEventName, type WorkbookPublishedEvent, WorkbookPublishedEventName, type WorkbookSelectedNodeEvent, WorkbookSelectedNodeEventName, WorkbookSelectedNodeIdUpdateEventName, type WorkbookSharingLinkUpdateEvent, WorkbookSharingLinkUpdateEventName, type WorkbookTableCellSelectEvent, WorkbookTableCellSelectEventName, type WorkbookVariableCurrentEvent, WorkbookVariableEventOnChangeName, type WorkbookVariableOnChangeEvent, WorkbookVariablesCurrentEventName, WorkbookVariablesListEventName, WorkbookVariablesUpdateEventName, actionOutboundListener, urlOnChangeListener, workbookBookmarkCreate, workbookBookmarkCreateListener, workbookBookmarkOnChangeListener, workbookBookmarkUpdate, workbookChartErrorListener, workbookChartValueSelectListener, workbookCurrentVariablesListener, workbookDataLoadedListener, workbookErrorListener, workbookExploreKeyOnChangeListener, workbookFullScreenListener, workbookFullscreenUpdate, workbookIdOnChangeListener, workbookLinkSharingUpdateListener, workbookLoadedListener, workbookPageHeightListener, workbookPivotTableCellSelectListener, workbookPublishedListener, workbookSelectedNodeIdUpdate, workbookSelectedNodeListener, workbookSharingLinkUpdate, workbookTableCellSelectListener, workbookVariableChangeListener, workbookVariableCurrentListener, workbookVariablesList, workbookVariablesUpdate };

package/dist/index.d.ts

@@ -45,7 +45,7 @@ declare const WorkbookTableCellSelectEventName: "workbook:table:oncellselect";
 declare const WorkbookPublishedEventName: "workbook:published";
 declare const WorkbookFullScreenEventName: "workbook:fullscreen:onchange";
 declare const WorkbookPageHeightEventName: "workbook:pageheight:onchange";
-declare const WorkbookPageSelectedNodeEventName: "workbook:selectednodeid:onchange";
+declare const WorkbookSelectedNodeEventName: "workbook:selectednodeid:onchange";
 declare const WorkbookPivotTableCellSelectEventName: "workbook:pivottable:oncellselect";
 declare const WorkbookChartValueSelectEventName: "workbook:chart:onvalueselect";
 declare const WorkbookCurrentVariablesEventName: "workbook:variables:current";
@@ -64,6 +64,7 @@ declare const WorkbookVariablesListEventName: "workbook:variables:list";
 declare const WorkbookVariablesUpdateEventName: "workbook:variables:update";
 declare const WorkbookVariablesCurrentEventName: "workbook:variables:current";
 declare const WorkbookSharingLinkUpdateEventName: "workbook:sharinglink:update";
+declare const ActionOutboundEventName: "action:outbound";
 interface WorkbookLoadedEvent {
     type: typeof WorkbookLoadedEventName;
     workbook: {
@@ -105,8 +106,8 @@ type WorkbookPageHeightEvent = {
     type: typeof WorkbookPageHeightEventName;
     pageHeight: number;
 };
-type WorkbookPageSelectedNodeEvent = {
-    type: typeof WorkbookPageSelectedNodeEventName;
+type WorkbookSelectedNodeEvent = {
+    type: typeof WorkbookSelectedNodeEventName;
     selectedNodeId: string | null;
 };
 type WorkbookPivotTableCellSelectEvent = {
@@ -165,6 +166,11 @@ type WorkbookBookmarkCreateEvent = {
     isDefault: boolean;
     isShared: boolean;
 };
+type ActionOutboundEvent = {
+    type: typeof ActionOutboundEventName;
+    name: string;
+    values: Record<string, unknown>;
+};
 
 declare const workbookLoadedListener: (event: MessageEvent, iframe: HTMLIFrameElement, onLoaded: (event: WorkbookLoadedEvent) => void) => void;
 declare const workbookErrorListener: (event: MessageEvent, iframe: HTMLIFrameElement, onError: (event: WorkbookErrorEvent) => void) => void;
@@ -175,7 +181,7 @@ declare const workbookTableCellSelectListener: (event: MessageEvent, iframe: HTM
 declare const workbookPublishedListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPublished: (event: WorkbookPublishedEvent) => void) => void;
 declare const workbookFullScreenListener: (event: MessageEvent, iframe: HTMLIFrameElement, onFullScreen: (event: WorkbookFullScreenEvent) => void) => void;
 declare const workbookPageHeightListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPageHeight: (event: WorkbookPageHeightEvent) => void) => void;
-declare const workbookPageSelectedNodeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPageSelectedNode: (event: WorkbookPageSelectedNodeEvent) => void) => void;
+declare const workbookSelectedNodeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPageSelectedNode: (event: WorkbookSelectedNodeEvent) => void) => void;
 declare const workbookPivotTableCellSelectListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPivotTableCellSelect: (event: WorkbookPivotTableCellSelectEvent) => void) => void;
 declare const workbookChartValueSelectListener: (event: MessageEvent, iframe: HTMLIFrameElement, onChartValueSelect: (event: WorkbookChartValueSelectEvent) => void) => void;
 declare const workbookCurrentVariablesListener: (event: MessageEvent, iframe: HTMLIFrameElement, onCurrentVariables: (event: WorkbookCurrentVariablesEvent) => void) => void;
@@ -186,6 +192,7 @@ declare const workbookExploreKeyOnChangeListener: (event: MessageEvent, iframe:
 declare const workbookBookmarkOnChangeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onBookmarkChange: (event: WorkbookBookmarkOnChangeEvent) => void) => void;
 declare const urlOnChangeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onUrlChange: (event: UrlOnChangeEvent) => void) => void;
 declare const workbookIdOnChangeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onWorkbookIdChange: (event: WorkbookIdOnChangeEvent) => void) => void;
+declare const actionOutboundListener: (event: MessageEvent, iframe: HTMLIFrameElement, onActionOutbound: (event: ActionOutboundEvent) => void) => void;
 
 declare const workbookBookmarkCreate: (iframe: HTMLIFrameElement, bookmark: WorkbookBookmarkCreateEvent) => void;
 declare const workbookBookmarkUpdate: (iframe: HTMLIFrameElement) => void;
@@ -195,4 +202,4 @@ declare const workbookVariablesList: (iframe: HTMLIFrameElement) => void;
 declare const workbookVariablesUpdate: (iframe: HTMLIFrameElement, variables: Record<string, string>) => void;
 declare const workbookSharingLinkUpdate: (iframe: HTMLIFrameElement, sharingLink: string | null, sharingExplorationLink?: string | null) => void;
 
-export { CellType_t, type Cell_t, type ChartValue_t, type ChartValues_t, type DataRow_t, type DataRows_t, type Data_t, type LevelTableCell_t, type LevelTableCells, type LevelTableColumnCell_t, type LevelTableValueCell_t, type PathChunk_t, type PivotPath_t, type PivotTableCell_t, type PivotTableCells_t, type UrlOnChangeEvent, UrlOnChangeEventName, type Value_t, type WorkbookBookmarkCreateEvent, WorkbookBookmarkCreateEventName, type WorkbookBookmarkOnChangeEvent, WorkbookBookmarkOnChangeEventName, type WorkbookBookmarkOnCreateEvent, WorkbookBookmarkOnCreateEventName, WorkbookBookmarkUpdateEventName, type WorkbookChartErrorEvent, WorkbookChartErrorEventName, type WorkbookChartValueSelectEvent, WorkbookChartValueSelectEventName, type WorkbookCurrentVariablesEvent, WorkbookCurrentVariablesEventName, type WorkbookDataLoadedEvent, WorkbookDataLoadedEventName, type WorkbookErrorEvent, WorkbookErrorEventName, type WorkbookExploreKeyOnChangeEvent, WorkbookExploreKeyOnChangeEventName, type WorkbookFullScreenEvent, WorkbookFullScreenEventName, WorkbookFullscreenUpdateEventName, type WorkbookIdOnChangeEvent, WorkbookIdOnChangeEventName, type WorkbookLoadedEvent, WorkbookLoadedEventName, type WorkbookPageHeightEvent, WorkbookPageHeightEventName, type WorkbookPageSelectedNodeEvent, WorkbookPageSelectedNodeEventName, type WorkbookPivotTableCellSelectEvent, WorkbookPivotTableCellSelectEventName, type WorkbookPublishedEvent, WorkbookPublishedEventName, WorkbookSelectedNodeIdUpdateEventName, type WorkbookSharingLinkUpdateEvent, WorkbookSharingLinkUpdateEventName, type WorkbookTableCellSelectEvent, WorkbookTableCellSelectEventName, type WorkbookVariableCurrentEvent, WorkbookVariableEventOnChangeName, type WorkbookVariableOnChangeEvent, WorkbookVariablesCurrentEventName, WorkbookVariablesListEventName, WorkbookVariablesUpdateEventName, urlOnChangeListener, workbookBookmarkCreate, workbookBookmarkCreateListener, workbookBookmarkOnChangeListener, workbookBookmarkUpdate, workbookChartErrorListener, workbookChartValueSelectListener, workbookCurrentVariablesListener, workbookDataLoadedListener, workbookErrorListener, workbookExploreKeyOnChangeListener, workbookFullScreenListener, workbookFullscreenUpdate, workbookIdOnChangeListener, workbookLinkSharingUpdateListener, workbookLoadedListener, workbookPageHeightListener, workbookPageSelectedNodeListener, workbookPivotTableCellSelectListener, workbookPublishedListener, workbookSelectedNodeIdUpdate, workbookSharingLinkUpdate, workbookTableCellSelectListener, workbookVariableChangeListener, workbookVariableCurrentListener, workbookVariablesList, workbookVariablesUpdate };
+export { type ActionOutboundEvent, ActionOutboundEventName, CellType_t, type Cell_t, type ChartValue_t, type ChartValues_t, type DataRow_t, type DataRows_t, type Data_t, type LevelTableCell_t, type LevelTableCells, type LevelTableColumnCell_t, type LevelTableValueCell_t, type PathChunk_t, type PivotPath_t, type PivotTableCell_t, type PivotTableCells_t, type UrlOnChangeEvent, UrlOnChangeEventName, type Value_t, type WorkbookBookmarkCreateEvent, WorkbookBookmarkCreateEventName, type WorkbookBookmarkOnChangeEvent, WorkbookBookmarkOnChangeEventName, type WorkbookBookmarkOnCreateEvent, WorkbookBookmarkOnCreateEventName, WorkbookBookmarkUpdateEventName, type WorkbookChartErrorEvent, WorkbookChartErrorEventName, type WorkbookChartValueSelectEvent, WorkbookChartValueSelectEventName, type WorkbookCurrentVariablesEvent, WorkbookCurrentVariablesEventName, type WorkbookDataLoadedEvent, WorkbookDataLoadedEventName, type WorkbookErrorEvent, WorkbookErrorEventName, type WorkbookExploreKeyOnChangeEvent, WorkbookExploreKeyOnChangeEventName, type WorkbookFullScreenEvent, WorkbookFullScreenEventName, WorkbookFullscreenUpdateEventName, type WorkbookIdOnChangeEvent, WorkbookIdOnChangeEventName, type WorkbookLoadedEvent, WorkbookLoadedEventName, type WorkbookPageHeightEvent, WorkbookPageHeightEventName, type WorkbookPivotTableCellSelectEvent, WorkbookPivotTableCellSelectEventName, type WorkbookPublishedEvent, WorkbookPublishedEventName, type WorkbookSelectedNodeEvent, WorkbookSelectedNodeEventName, WorkbookSelectedNodeIdUpdateEventName, type WorkbookSharingLinkUpdateEvent, WorkbookSharingLinkUpdateEventName, type WorkbookTableCellSelectEvent, WorkbookTableCellSelectEventName, type WorkbookVariableCurrentEvent, WorkbookVariableEventOnChangeName, type WorkbookVariableOnChangeEvent, WorkbookVariablesCurrentEventName, WorkbookVariablesListEventName, WorkbookVariablesUpdateEventName, actionOutboundListener, urlOnChangeListener, workbookBookmarkCreate, workbookBookmarkCreateListener, workbookBookmarkOnChangeListener, workbookBookmarkUpdate, workbookChartErrorListener, workbookChartValueSelectListener, workbookCurrentVariablesListener, workbookDataLoadedListener, workbookErrorListener, workbookExploreKeyOnChangeListener, workbookFullScreenListener, workbookFullscreenUpdate, workbookIdOnChangeListener, workbookLinkSharingUpdateListener, workbookLoadedListener, workbookPageHeightListener, workbookPivotTableCellSelectListener, workbookPublishedListener, workbookSelectedNodeIdUpdate, workbookSelectedNodeListener, workbookSharingLinkUpdate, workbookTableCellSelectListener, workbookVariableChangeListener, workbookVariableCurrentListener, workbookVariablesList, workbookVariablesUpdate };

package/dist/index.js

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  actionOutboundListener: () => actionOutboundListener,
   urlOnChangeListener: () => urlOnChangeListener,
   workbookBookmarkCreate: () => workbookBookmarkCreate,
   workbookBookmarkCreateListener: () => workbookBookmarkCreateListener,
@@ -37,10 +38,10 @@ __export(src_exports, {
   workbookLinkSharingUpdateListener: () => workbookLinkSharingUpdateListener,
   workbookLoadedListener: () => workbookLoadedListener,
   workbookPageHeightListener: () => workbookPageHeightListener,
-  workbookPageSelectedNodeListener: () => workbookPageSelectedNodeListener,
   workbookPivotTableCellSelectListener: () => workbookPivotTableCellSelectListener,
   workbookPublishedListener: () => workbookPublishedListener,
   workbookSelectedNodeIdUpdate: () => workbookSelectedNodeIdUpdate,
+  workbookSelectedNodeListener: () => workbookSelectedNodeListener,
   workbookSharingLinkUpdate: () => workbookSharingLinkUpdate,
   workbookTableCellSelectListener: () => workbookTableCellSelectListener,
   workbookVariableChangeListener: () => workbookVariableChangeListener,
@@ -58,7 +59,7 @@ var WorkbookTableCellSelectEventName = "workbook:table:oncellselect";
 var WorkbookPublishedEventName = "workbook:published";
 var WorkbookFullScreenEventName = "workbook:fullscreen:onchange";
 var WorkbookPageHeightEventName = "workbook:pageheight:onchange";
-var WorkbookPageSelectedNodeEventName = "workbook:selectednodeid:onchange";
+var WorkbookSelectedNodeEventName = "workbook:selectednodeid:onchange";
 var WorkbookPivotTableCellSelectEventName = "workbook:pivottable:oncellselect";
 var WorkbookChartValueSelectEventName = "workbook:chart:onvalueselect";
 var WorkbookCurrentVariablesEventName = "workbook:variables:current";
@@ -77,6 +78,7 @@ var WorkbookVariablesListEventName = "workbook:variables:list";
 var WorkbookVariablesUpdateEventName = "workbook:variables:update";
 var WorkbookVariablesCurrentEventName = "workbook:variables:current";
 var WorkbookSharingLinkUpdateEventName = "workbook:sharinglink:update";
+var ActionOutboundEventName = "action:outbound";
 
 // src/wrapper.ts
 var checkEventOrigin = (url) => {
@@ -148,9 +150,9 @@ var workbookPageHeightListener = (event, iframe, onPageHeight) => {
     }
   }
 };
-var workbookPageSelectedNodeListener = (event, iframe, onPageSelectedNode) => {
+var workbookSelectedNodeListener = (event, iframe, onPageSelectedNode) => {
   if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
-    if (event.data.type === WorkbookPageSelectedNodeEventName) {
+    if (event.data.type === WorkbookSelectedNodeEventName) {
       onPageSelectedNode(event.data);
     }
   }
@@ -225,6 +227,13 @@ var workbookIdOnChangeListener = (event, iframe, onWorkbookIdChange) => {
     }
   }
 };
+var actionOutboundListener = (event, iframe, onActionOutbound) => {
+  if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
+    if (event.data.type === ActionOutboundEventName) {
+      onActionOutbound(event.data);
+    }
+  }
+};
 
 // src/mutations.ts
 var sendIframeMessage = (iframe, message) => {
@@ -280,6 +289,7 @@ var workbookSharingLinkUpdate = (iframe, sharingLink, sharingExplorationLink) =>
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  actionOutboundListener,
   urlOnChangeListener,
   workbookBookmarkCreate,
   workbookBookmarkCreateListener,
@@ -297,10 +307,10 @@ var workbookSharingLinkUpdate = (iframe, sharingLink, sharingExplorationLink) =>
   workbookLinkSharingUpdateListener,
   workbookLoadedListener,
   workbookPageHeightListener,
-  workbookPageSelectedNodeListener,
   workbookPivotTableCellSelectListener,
   workbookPublishedListener,
   workbookSelectedNodeIdUpdate,
+  workbookSelectedNodeListener,
   workbookSharingLinkUpdate,
   workbookTableCellSelectListener,
   workbookVariableChangeListener,

package/dist/index.mjs

@@ -6,7 +6,7 @@ var WorkbookTableCellSelectEventName = "workbook:table:oncellselect";
 var WorkbookPublishedEventName = "workbook:published";
 var WorkbookFullScreenEventName = "workbook:fullscreen:onchange";
 var WorkbookPageHeightEventName = "workbook:pageheight:onchange";
-var WorkbookPageSelectedNodeEventName = "workbook:selectednodeid:onchange";
+var WorkbookSelectedNodeEventName = "workbook:selectednodeid:onchange";
 var WorkbookPivotTableCellSelectEventName = "workbook:pivottable:oncellselect";
 var WorkbookChartValueSelectEventName = "workbook:chart:onvalueselect";
 var WorkbookCurrentVariablesEventName = "workbook:variables:current";
@@ -25,6 +25,7 @@ var WorkbookVariablesListEventName = "workbook:variables:list";
 var WorkbookVariablesUpdateEventName = "workbook:variables:update";
 var WorkbookVariablesCurrentEventName = "workbook:variables:current";
 var WorkbookSharingLinkUpdateEventName = "workbook:sharinglink:update";
+var ActionOutboundEventName = "action:outbound";
 
 // src/wrapper.ts
 var checkEventOrigin = (url) => {
@@ -96,9 +97,9 @@ var workbookPageHeightListener = (event, iframe, onPageHeight) => {
     }
   }
 };
-var workbookPageSelectedNodeListener = (event, iframe, onPageSelectedNode) => {
+var workbookSelectedNodeListener = (event, iframe, onPageSelectedNode) => {
   if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
-    if (event.data.type === WorkbookPageSelectedNodeEventName) {
+    if (event.data.type === WorkbookSelectedNodeEventName) {
       onPageSelectedNode(event.data);
     }
   }
@@ -173,6 +174,13 @@ var workbookIdOnChangeListener = (event, iframe, onWorkbookIdChange) => {
     }
   }
 };
+var actionOutboundListener = (event, iframe, onActionOutbound) => {
+  if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
+    if (event.data.type === ActionOutboundEventName) {
+      onActionOutbound(event.data);
+    }
+  }
+};
 
 // src/mutations.ts
 var sendIframeMessage = (iframe, message) => {
@@ -227,6 +235,7 @@ var workbookSharingLinkUpdate = (iframe, sharingLink, sharingExplorationLink) =>
   });
 };
 export {
+  actionOutboundListener,
   urlOnChangeListener,
   workbookBookmarkCreate,
   workbookBookmarkCreateListener,
@@ -244,10 +253,10 @@ export {
   workbookLinkSharingUpdateListener,
   workbookLoadedListener,
   workbookPageHeightListener,
-  workbookPageSelectedNodeListener,
   workbookPivotTableCellSelectListener,
   workbookPublishedListener,
   workbookSelectedNodeIdUpdate,
+  workbookSelectedNodeListener,
   workbookSharingLinkUpdate,
   workbookTableCellSelectListener,
   workbookVariableChangeListener,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sigmacomputing/embed-sdk",
   "author": "sigmacomputing",
-  "version": "0.3.3",
+  "version": "0.5.0",
   "description": "JavaScript SDK to interact with Sigma Computing's Embed API",
   "license": "MIT",
   "repository": {