@sigmacomputing/embed-sdk 0.5.0 → 0.7.0

package/README.md

@@ -138,6 +138,30 @@ Listen for a workbook bookmark create event, and execute the given callback when
 workbookBookmarkCreateListener(event: MessageEvent, iframe: HTMLIFrameElement, onBookmarkCreate: (event: WorkbookBookmarkOnCreateEvent) => 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)
+```
+
+#### workbookBookmarkOnUpdateListener
+
+Listen for a workbook bookmark update event, and execute the given callback when it occurs.
+
+```typescript
+workbookBookmarkOnUpdateListener(event: MessageEvent, iframe: HTMLIFrameElement, onBookmarkUpdate: (event: WorkbookBookmarkOnUpdateEvent) => void)
+```
+
+#### workbookBookmarkOnDeleteListener
+
+Listen for a workbook bookmark delete event, and execute the given callback when it occurs.
+
+```typescript
+workbookBookmarkOnDeleteListener(event: MessageEvent, iframe: HTMLIFrameElement, onBookmarkDelete: (event: WorkbookBookmarkOnDeleteEvent) => void)
+```
+
 #### workbookDataLoadedListener
 
 Listen for a workbook data loaded event, and execute the given callback when it occurs.
@@ -162,14 +186,6 @@ Listen for a workbook explore key change event, and execute the given callback w
 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.
@@ -230,6 +246,22 @@ Send a message to the embed to update the current bookmark.
 workbookBookmarkUpdate(iframe: HTMLIFrameElement)
 ```
 
+#### workbookBookmarkDelete
+
+Send a message to the embed to delete the given bookmark.
+
+```typescript
+workbookBookmarkDelete(iframe: HTMLIFrameElement, bookmarkId: string)
+```
+
+#### workbookBookmarkSelect
+
+Send a message to the embed to select the given bookmark. If no bookmarkId is provided, the current bookmark will be deselected.
+
+```typescript
+workbookBookmarkSelect(iframe: HTMLIFrameElement, bookmarkId?: string)
+```
+
 #### workbookFullscreenUpdate
 
 Send a message to the embed to toggle the fullscreen state of the given element.

package/dist/index.d.mts

@@ -53,11 +53,15 @@ declare const WorkbookBookmarkOnCreateEventName: "workbook:bookmark:oncreate";
 declare const WorkbookDataLoadedEventName: "workbook:dataloaded";
 declare const WorkbookChartErrorEventName: "workbook:chart:error";
 declare const WorkbookExploreKeyOnChangeEventName: "workbook:exploreKey:onchange";
-declare const WorkbookBookmarkOnChangeEventName: "workbook:bookmark:onchange";
 declare const UrlOnChangeEventName: "url:onchange";
 declare const WorkbookIdOnChangeEventName: "workbook:id:onchange";
 declare const WorkbookBookmarkCreateEventName: "workbook:bookmark:create";
 declare const WorkbookBookmarkUpdateEventName: "workbook:bookmark:update";
+declare const WorkbookBookmarkDeleteEventName: "workbook:bookmark:delete";
+declare const WorkbookBookmarkSelectEventName: "workbook:bookmark:select";
+declare const WorkbookBookmarkOnChangeEventName: "workbook:bookmark:onchange";
+declare const WorkbookBookmarkOnDeleteEventName: "workbook:bookmark:ondelete";
+declare const WorkbookBookmarkOnUpdateEventName: "workbook:bookmark:onupdate";
 declare const WorkbookFullscreenUpdateEventName: "workbook:fullscreen:update";
 declare const WorkbookSelectedNodeIdUpdateEventName: "workbook:selectednodeid:update";
 declare const WorkbookVariablesListEventName: "workbook:variables:list";
@@ -78,7 +82,9 @@ interface WorkbookErrorEvent {
 }
 interface WorkbookVariableOnChangeEvent {
     type: typeof WorkbookVariableEventOnChangeName;
-    variables: Record<string, string>;
+    workbook: {
+        variables: Record<string, string>;
+    };
 }
 interface WorkbookVariableCurrentEvent {
     type: typeof WorkbookVariablesCurrentEventName;
@@ -109,6 +115,7 @@ type WorkbookPageHeightEvent = {
 type WorkbookSelectedNodeEvent = {
     type: typeof WorkbookSelectedNodeEventName;
     selectedNodeId: string | null;
+    nodeType: "element" | "page" | null;
 };
 type WorkbookPivotTableCellSelectEvent = {
     type: typeof WorkbookPivotTableCellSelectEventName;
@@ -126,13 +133,6 @@ type WorkbookCurrentVariablesEvent = {
     type: typeof WorkbookCurrentVariablesEventName;
     variables: Record<string, string>;
 };
-type WorkbookBookmarkOnCreateEvent = {
-    type: typeof WorkbookBookmarkOnCreateEventName;
-    bookmarkName: string;
-    workbookId: string;
-    versionTagName: string | null;
-    bookmarkId: string;
-};
 type WorkbookDataLoadedEvent = {
     type: typeof WorkbookDataLoadedEventName;
 };
@@ -146,6 +146,14 @@ type WorkbookExploreKeyOnChangeEvent = {
     type: typeof WorkbookExploreKeyOnChangeEventName;
     exploreKey: string | null;
 };
+declare const WorkbookBookmarkOnCreateEvent: "workbook:bookmark:oncreate";
+type WorkbookBookmarkOnCreateEvent = {
+    type: typeof WorkbookBookmarkOnCreateEventName;
+    bookmarkName: string;
+    workbookId: string;
+    versionTagName: string | null;
+    bookmarkId: string;
+};
 type WorkbookBookmarkOnChangeEvent = {
     type: typeof WorkbookBookmarkOnChangeEventName;
     bookmarkName: string | null;
@@ -153,6 +161,27 @@ type WorkbookBookmarkOnChangeEvent = {
     versionTagName: string | null;
     bookmarkId: string | null;
 };
+type WorkbookBookmarkOnUpdateEvent = {
+    type: typeof WorkbookBookmarkOnUpdateEventName;
+    bookmarkName?: string;
+    workbookId: string;
+    versionTagName: string | null;
+    bookmarkId: string;
+    isDefault?: boolean;
+    isShared?: boolean;
+};
+type WorkbookBookmarkOnDeleteEvent = {
+    type: typeof WorkbookBookmarkOnDeleteEventName;
+    bookmarkName: string;
+    workbookId: string;
+    versionTagName: string | null;
+    bookmarkId: string;
+};
+type WorkbookBookmarkCreateEvent = {
+    name: string;
+    isDefault: boolean;
+    isShared: boolean;
+};
 type UrlOnChangeEvent = {
     type: typeof UrlOnChangeEventName;
     url: string;
@@ -161,11 +190,6 @@ type WorkbookIdOnChangeEvent = {
     type: typeof WorkbookIdOnChangeEventName;
     id: string;
 };
-type WorkbookBookmarkCreateEvent = {
-    name: string;
-    isDefault: boolean;
-    isShared: boolean;
-};
 type ActionOutboundEvent = {
     type: typeof ActionOutboundEventName;
     name: string;
@@ -186,20 +210,32 @@ declare const workbookPivotTableCellSelectListener: (event: MessageEvent, iframe
 declare const workbookChartValueSelectListener: (event: MessageEvent, iframe: HTMLIFrameElement, onChartValueSelect: (event: WorkbookChartValueSelectEvent) => void) => void;
 declare const workbookCurrentVariablesListener: (event: MessageEvent, iframe: HTMLIFrameElement, onCurrentVariables: (event: WorkbookCurrentVariablesEvent) => void) => void;
 declare const workbookBookmarkCreateListener: (event: MessageEvent, iframe: HTMLIFrameElement, onBookmarkCreate: (event: WorkbookBookmarkOnCreateEvent) => void) => void;
+declare const workbookBookmarkOnChangeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onBookmarkChange: (event: WorkbookBookmarkOnChangeEvent) => void) => void;
+declare const workbookBookmarkOnUpdateListener: (event: MessageEvent, iframe: HTMLIFrameElement, onBookmarkUpdate: (event: WorkbookBookmarkOnUpdateEvent) => void) => void;
+declare const workbookBookmarkOnDeleteListener: (event: MessageEvent, iframe: HTMLIFrameElement, onBookmarkDelete: (event: WorkbookBookmarkOnDeleteEvent) => void) => void;
 declare const workbookDataLoadedListener: (event: MessageEvent, iframe: HTMLIFrameElement, onWorkbookDataLoaded: (event: WorkbookDataLoadedEvent) => void) => void;
 declare const workbookChartErrorListener: (event: MessageEvent, iframe: HTMLIFrameElement, onChartError: (event: WorkbookChartErrorEvent) => void) => void;
 declare const workbookExploreKeyOnChangeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onExploreKeyOnChange: (event: WorkbookExploreKeyOnChangeEvent) => void) => void;
-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;
 
+/**
+ * DO NOT USE IN PRODUCTION.
+ *
+ * This will override the Sigma Computing URL used for mutations.
+ *
+ * @param url the URL to use instead of the default
+ */
+declare const DO_NOT_USE_IN_PRODUCTION_overrideMutationUrl: (url: string) => void;
 declare const workbookBookmarkCreate: (iframe: HTMLIFrameElement, bookmark: WorkbookBookmarkCreateEvent) => void;
 declare const workbookBookmarkUpdate: (iframe: HTMLIFrameElement) => void;
+declare const workbookBookmarkSelect: (iframe: HTMLIFrameElement, bookmarkId?: string) => void;
+declare const workbookBookmarkDelete: (iframe: HTMLIFrameElement, bookmarkId: string) => void;
 declare const workbookFullscreenUpdate: (iframe: HTMLIFrameElement, nodeId: string | null) => void;
-declare const workbookSelectedNodeIdUpdate: (iframe: HTMLIFrameElement, nodeId: string, nodeType: "element" | "page") => void;
+declare const workbookSelectedNodeIdUpdate: (iframe: HTMLIFrameElement, nodeId: string | null, nodeType: "element" | "page") => void;
 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 { 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 };
+export { type ActionOutboundEvent, ActionOutboundEventName, CellType_t, type Cell_t, type ChartValue_t, type ChartValues_t, DO_NOT_USE_IN_PRODUCTION_overrideMutationUrl, 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, WorkbookBookmarkDeleteEventName, type WorkbookBookmarkOnChangeEvent, WorkbookBookmarkOnChangeEventName, WorkbookBookmarkOnCreateEvent, WorkbookBookmarkOnCreateEventName, type WorkbookBookmarkOnDeleteEvent, WorkbookBookmarkOnDeleteEventName, type WorkbookBookmarkOnUpdateEvent, WorkbookBookmarkOnUpdateEventName, WorkbookBookmarkSelectEventName, 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, workbookBookmarkDelete, workbookBookmarkOnChangeListener, workbookBookmarkOnDeleteListener, workbookBookmarkOnUpdateListener, workbookBookmarkSelect, 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

@@ -53,11 +53,15 @@ declare const WorkbookBookmarkOnCreateEventName: "workbook:bookmark:oncreate";
 declare const WorkbookDataLoadedEventName: "workbook:dataloaded";
 declare const WorkbookChartErrorEventName: "workbook:chart:error";
 declare const WorkbookExploreKeyOnChangeEventName: "workbook:exploreKey:onchange";
-declare const WorkbookBookmarkOnChangeEventName: "workbook:bookmark:onchange";
 declare const UrlOnChangeEventName: "url:onchange";
 declare const WorkbookIdOnChangeEventName: "workbook:id:onchange";
 declare const WorkbookBookmarkCreateEventName: "workbook:bookmark:create";
 declare const WorkbookBookmarkUpdateEventName: "workbook:bookmark:update";
+declare const WorkbookBookmarkDeleteEventName: "workbook:bookmark:delete";
+declare const WorkbookBookmarkSelectEventName: "workbook:bookmark:select";
+declare const WorkbookBookmarkOnChangeEventName: "workbook:bookmark:onchange";
+declare const WorkbookBookmarkOnDeleteEventName: "workbook:bookmark:ondelete";
+declare const WorkbookBookmarkOnUpdateEventName: "workbook:bookmark:onupdate";
 declare const WorkbookFullscreenUpdateEventName: "workbook:fullscreen:update";
 declare const WorkbookSelectedNodeIdUpdateEventName: "workbook:selectednodeid:update";
 declare const WorkbookVariablesListEventName: "workbook:variables:list";
@@ -78,7 +82,9 @@ interface WorkbookErrorEvent {
 }
 interface WorkbookVariableOnChangeEvent {
     type: typeof WorkbookVariableEventOnChangeName;
-    variables: Record<string, string>;
+    workbook: {
+        variables: Record<string, string>;
+    };
 }
 interface WorkbookVariableCurrentEvent {
     type: typeof WorkbookVariablesCurrentEventName;
@@ -109,6 +115,7 @@ type WorkbookPageHeightEvent = {
 type WorkbookSelectedNodeEvent = {
     type: typeof WorkbookSelectedNodeEventName;
     selectedNodeId: string | null;
+    nodeType: "element" | "page" | null;
 };
 type WorkbookPivotTableCellSelectEvent = {
     type: typeof WorkbookPivotTableCellSelectEventName;
@@ -126,13 +133,6 @@ type WorkbookCurrentVariablesEvent = {
     type: typeof WorkbookCurrentVariablesEventName;
     variables: Record<string, string>;
 };
-type WorkbookBookmarkOnCreateEvent = {
-    type: typeof WorkbookBookmarkOnCreateEventName;
-    bookmarkName: string;
-    workbookId: string;
-    versionTagName: string | null;
-    bookmarkId: string;
-};
 type WorkbookDataLoadedEvent = {
     type: typeof WorkbookDataLoadedEventName;
 };
@@ -146,6 +146,14 @@ type WorkbookExploreKeyOnChangeEvent = {
     type: typeof WorkbookExploreKeyOnChangeEventName;
     exploreKey: string | null;
 };
+declare const WorkbookBookmarkOnCreateEvent: "workbook:bookmark:oncreate";
+type WorkbookBookmarkOnCreateEvent = {
+    type: typeof WorkbookBookmarkOnCreateEventName;
+    bookmarkName: string;
+    workbookId: string;
+    versionTagName: string | null;
+    bookmarkId: string;
+};
 type WorkbookBookmarkOnChangeEvent = {
     type: typeof WorkbookBookmarkOnChangeEventName;
     bookmarkName: string | null;
@@ -153,6 +161,27 @@ type WorkbookBookmarkOnChangeEvent = {
     versionTagName: string | null;
     bookmarkId: string | null;
 };
+type WorkbookBookmarkOnUpdateEvent = {
+    type: typeof WorkbookBookmarkOnUpdateEventName;
+    bookmarkName?: string;
+    workbookId: string;
+    versionTagName: string | null;
+    bookmarkId: string;
+    isDefault?: boolean;
+    isShared?: boolean;
+};
+type WorkbookBookmarkOnDeleteEvent = {
+    type: typeof WorkbookBookmarkOnDeleteEventName;
+    bookmarkName: string;
+    workbookId: string;
+    versionTagName: string | null;
+    bookmarkId: string;
+};
+type WorkbookBookmarkCreateEvent = {
+    name: string;
+    isDefault: boolean;
+    isShared: boolean;
+};
 type UrlOnChangeEvent = {
     type: typeof UrlOnChangeEventName;
     url: string;
@@ -161,11 +190,6 @@ type WorkbookIdOnChangeEvent = {
     type: typeof WorkbookIdOnChangeEventName;
     id: string;
 };
-type WorkbookBookmarkCreateEvent = {
-    name: string;
-    isDefault: boolean;
-    isShared: boolean;
-};
 type ActionOutboundEvent = {
     type: typeof ActionOutboundEventName;
     name: string;
@@ -186,20 +210,32 @@ declare const workbookPivotTableCellSelectListener: (event: MessageEvent, iframe
 declare const workbookChartValueSelectListener: (event: MessageEvent, iframe: HTMLIFrameElement, onChartValueSelect: (event: WorkbookChartValueSelectEvent) => void) => void;
 declare const workbookCurrentVariablesListener: (event: MessageEvent, iframe: HTMLIFrameElement, onCurrentVariables: (event: WorkbookCurrentVariablesEvent) => void) => void;
 declare const workbookBookmarkCreateListener: (event: MessageEvent, iframe: HTMLIFrameElement, onBookmarkCreate: (event: WorkbookBookmarkOnCreateEvent) => void) => void;
+declare const workbookBookmarkOnChangeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onBookmarkChange: (event: WorkbookBookmarkOnChangeEvent) => void) => void;
+declare const workbookBookmarkOnUpdateListener: (event: MessageEvent, iframe: HTMLIFrameElement, onBookmarkUpdate: (event: WorkbookBookmarkOnUpdateEvent) => void) => void;
+declare const workbookBookmarkOnDeleteListener: (event: MessageEvent, iframe: HTMLIFrameElement, onBookmarkDelete: (event: WorkbookBookmarkOnDeleteEvent) => void) => void;
 declare const workbookDataLoadedListener: (event: MessageEvent, iframe: HTMLIFrameElement, onWorkbookDataLoaded: (event: WorkbookDataLoadedEvent) => void) => void;
 declare const workbookChartErrorListener: (event: MessageEvent, iframe: HTMLIFrameElement, onChartError: (event: WorkbookChartErrorEvent) => void) => void;
 declare const workbookExploreKeyOnChangeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onExploreKeyOnChange: (event: WorkbookExploreKeyOnChangeEvent) => void) => void;
-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;
 
+/**
+ * DO NOT USE IN PRODUCTION.
+ *
+ * This will override the Sigma Computing URL used for mutations.
+ *
+ * @param url the URL to use instead of the default
+ */
+declare const DO_NOT_USE_IN_PRODUCTION_overrideMutationUrl: (url: string) => void;
 declare const workbookBookmarkCreate: (iframe: HTMLIFrameElement, bookmark: WorkbookBookmarkCreateEvent) => void;
 declare const workbookBookmarkUpdate: (iframe: HTMLIFrameElement) => void;
+declare const workbookBookmarkSelect: (iframe: HTMLIFrameElement, bookmarkId?: string) => void;
+declare const workbookBookmarkDelete: (iframe: HTMLIFrameElement, bookmarkId: string) => void;
 declare const workbookFullscreenUpdate: (iframe: HTMLIFrameElement, nodeId: string | null) => void;
-declare const workbookSelectedNodeIdUpdate: (iframe: HTMLIFrameElement, nodeId: string, nodeType: "element" | "page") => void;
+declare const workbookSelectedNodeIdUpdate: (iframe: HTMLIFrameElement, nodeId: string | null, nodeType: "element" | "page") => void;
 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 { 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 };
+export { type ActionOutboundEvent, ActionOutboundEventName, CellType_t, type Cell_t, type ChartValue_t, type ChartValues_t, DO_NOT_USE_IN_PRODUCTION_overrideMutationUrl, 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, WorkbookBookmarkDeleteEventName, type WorkbookBookmarkOnChangeEvent, WorkbookBookmarkOnChangeEventName, WorkbookBookmarkOnCreateEvent, WorkbookBookmarkOnCreateEventName, type WorkbookBookmarkOnDeleteEvent, WorkbookBookmarkOnDeleteEventName, type WorkbookBookmarkOnUpdateEvent, WorkbookBookmarkOnUpdateEventName, WorkbookBookmarkSelectEventName, 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, workbookBookmarkDelete, workbookBookmarkOnChangeListener, workbookBookmarkOnDeleteListener, workbookBookmarkOnUpdateListener, workbookBookmarkSelect, 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,11 +20,16 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  DO_NOT_USE_IN_PRODUCTION_overrideMutationUrl: () => DO_NOT_USE_IN_PRODUCTION_overrideMutationUrl,
   actionOutboundListener: () => actionOutboundListener,
   urlOnChangeListener: () => urlOnChangeListener,
   workbookBookmarkCreate: () => workbookBookmarkCreate,
   workbookBookmarkCreateListener: () => workbookBookmarkCreateListener,
+  workbookBookmarkDelete: () => workbookBookmarkDelete,
   workbookBookmarkOnChangeListener: () => workbookBookmarkOnChangeListener,
+  workbookBookmarkOnDeleteListener: () => workbookBookmarkOnDeleteListener,
+  workbookBookmarkOnUpdateListener: () => workbookBookmarkOnUpdateListener,
+  workbookBookmarkSelect: () => workbookBookmarkSelect,
   workbookBookmarkUpdate: () => workbookBookmarkUpdate,
   workbookChartErrorListener: () => workbookChartErrorListener,
   workbookChartValueSelectListener: () => workbookChartValueSelectListener,
@@ -67,11 +72,13 @@ var WorkbookBookmarkOnCreateEventName = "workbook:bookmark:oncreate";
 var WorkbookDataLoadedEventName = "workbook:dataloaded";
 var WorkbookChartErrorEventName = "workbook:chart:error";
 var WorkbookExploreKeyOnChangeEventName = "workbook:exploreKey:onchange";
-var WorkbookBookmarkOnChangeEventName = "workbook:bookmark:onchange";
 var UrlOnChangeEventName = "url:onchange";
 var WorkbookIdOnChangeEventName = "workbook:id:onchange";
 var WorkbookBookmarkCreateEventName = "workbook:bookmark:create";
 var WorkbookBookmarkUpdateEventName = "workbook:bookmark:update";
+var WorkbookBookmarkOnChangeEventName = "workbook:bookmark:onchange";
+var WorkbookBookmarkOnDeleteEventName = "workbook:bookmark:ondelete";
+var WorkbookBookmarkOnUpdateEventName = "workbook:bookmark:onupdate";
 var WorkbookFullscreenUpdateEventName = "workbook:fullscreen:update";
 var WorkbookSelectedNodeIdUpdateEventName = "workbook:selectednodeid:update";
 var WorkbookVariablesListEventName = "workbook:variables:list";
@@ -185,6 +192,27 @@ var workbookBookmarkCreateListener = (event, iframe, onBookmarkCreate) => {
     }
   }
 };
+var workbookBookmarkOnChangeListener = (event, iframe, onBookmarkChange) => {
+  if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
+    if (event.data.type === WorkbookBookmarkOnChangeEventName) {
+      onBookmarkChange(event.data);
+    }
+  }
+};
+var workbookBookmarkOnUpdateListener = (event, iframe, onBookmarkUpdate) => {
+  if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
+    if (event.data.type === WorkbookBookmarkOnUpdateEventName) {
+      onBookmarkUpdate(event.data);
+    }
+  }
+};
+var workbookBookmarkOnDeleteListener = (event, iframe, onBookmarkDelete) => {
+  if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
+    if (event.data.type === WorkbookBookmarkOnDeleteEventName) {
+      onBookmarkDelete(event.data);
+    }
+  }
+};
 var workbookDataLoadedListener = (event, iframe, onWorkbookDataLoaded) => {
   if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
     if (event.data.type === WorkbookDataLoadedEventName) {
@@ -206,13 +234,6 @@ var workbookExploreKeyOnChangeListener = (event, iframe, onExploreKeyOnChange) =
     }
   }
 };
-var workbookBookmarkOnChangeListener = (event, iframe, onBookmarkChange) => {
-  if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
-    if (event.data.type === WorkbookBookmarkOnChangeEventName) {
-      onBookmarkChange(event.data);
-    }
-  }
-};
 var urlOnChangeListener = (event, iframe, onUrlChange) => {
   if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
     if (event.data.type === UrlOnChangeEventName) {
@@ -236,14 +257,15 @@ var actionOutboundListener = (event, iframe, onActionOutbound) => {
 };
 
 // src/mutations.ts
+var SIGMA_COMPUTING_URL = "https://app.sigmacomputing.com";
 var sendIframeMessage = (iframe, message) => {
   if (!iframe.contentWindow) {
     throw new Error("iframe contentWindow is not available");
   }
-  iframe.contentWindow.postMessage(
-    message,
-    "https://staging.sigmacomputing.io"
-  );
+  iframe.contentWindow.postMessage(message, SIGMA_COMPUTING_URL);
+};
+var DO_NOT_USE_IN_PRODUCTION_overrideMutationUrl = (url) => {
+  SIGMA_COMPUTING_URL = url;
 };
 var workbookBookmarkCreate = (iframe, bookmark) => {
   sendIframeMessage(iframe, {
@@ -256,6 +278,18 @@ var workbookBookmarkUpdate = (iframe) => {
     type: WorkbookBookmarkUpdateEventName
   });
 };
+var workbookBookmarkSelect = (iframe, bookmarkId) => {
+  sendIframeMessage(iframe, {
+    type: "workbook:bookmark:select",
+    bookmarkId
+  });
+};
+var workbookBookmarkDelete = (iframe, bookmarkId) => {
+  sendIframeMessage(iframe, {
+    type: "workbook:bookmark:delete",
+    bookmarkId
+  });
+};
 var workbookFullscreenUpdate = (iframe, nodeId) => {
   sendIframeMessage(iframe, {
     type: WorkbookFullscreenUpdateEventName,
@@ -265,7 +299,7 @@ var workbookFullscreenUpdate = (iframe, nodeId) => {
 var workbookSelectedNodeIdUpdate = (iframe, nodeId, nodeType) => {
   sendIframeMessage(iframe, {
     type: WorkbookSelectedNodeIdUpdateEventName,
-    nodeId,
+    selectedNodeId: nodeId,
     nodeType
   });
 };
@@ -289,11 +323,16 @@ var workbookSharingLinkUpdate = (iframe, sharingLink, sharingExplorationLink) =>
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  DO_NOT_USE_IN_PRODUCTION_overrideMutationUrl,
   actionOutboundListener,
   urlOnChangeListener,
   workbookBookmarkCreate,
   workbookBookmarkCreateListener,
+  workbookBookmarkDelete,
   workbookBookmarkOnChangeListener,
+  workbookBookmarkOnDeleteListener,
+  workbookBookmarkOnUpdateListener,
+  workbookBookmarkSelect,
   workbookBookmarkUpdate,
   workbookChartErrorListener,
   workbookChartValueSelectListener,

package/dist/index.mjs

@@ -14,11 +14,13 @@ var WorkbookBookmarkOnCreateEventName = "workbook:bookmark:oncreate";
 var WorkbookDataLoadedEventName = "workbook:dataloaded";
 var WorkbookChartErrorEventName = "workbook:chart:error";
 var WorkbookExploreKeyOnChangeEventName = "workbook:exploreKey:onchange";
-var WorkbookBookmarkOnChangeEventName = "workbook:bookmark:onchange";
 var UrlOnChangeEventName = "url:onchange";
 var WorkbookIdOnChangeEventName = "workbook:id:onchange";
 var WorkbookBookmarkCreateEventName = "workbook:bookmark:create";
 var WorkbookBookmarkUpdateEventName = "workbook:bookmark:update";
+var WorkbookBookmarkOnChangeEventName = "workbook:bookmark:onchange";
+var WorkbookBookmarkOnDeleteEventName = "workbook:bookmark:ondelete";
+var WorkbookBookmarkOnUpdateEventName = "workbook:bookmark:onupdate";
 var WorkbookFullscreenUpdateEventName = "workbook:fullscreen:update";
 var WorkbookSelectedNodeIdUpdateEventName = "workbook:selectednodeid:update";
 var WorkbookVariablesListEventName = "workbook:variables:list";
@@ -132,6 +134,27 @@ var workbookBookmarkCreateListener = (event, iframe, onBookmarkCreate) => {
     }
   }
 };
+var workbookBookmarkOnChangeListener = (event, iframe, onBookmarkChange) => {
+  if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
+    if (event.data.type === WorkbookBookmarkOnChangeEventName) {
+      onBookmarkChange(event.data);
+    }
+  }
+};
+var workbookBookmarkOnUpdateListener = (event, iframe, onBookmarkUpdate) => {
+  if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
+    if (event.data.type === WorkbookBookmarkOnUpdateEventName) {
+      onBookmarkUpdate(event.data);
+    }
+  }
+};
+var workbookBookmarkOnDeleteListener = (event, iframe, onBookmarkDelete) => {
+  if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
+    if (event.data.type === WorkbookBookmarkOnDeleteEventName) {
+      onBookmarkDelete(event.data);
+    }
+  }
+};
 var workbookDataLoadedListener = (event, iframe, onWorkbookDataLoaded) => {
   if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
     if (event.data.type === WorkbookDataLoadedEventName) {
@@ -153,13 +176,6 @@ var workbookExploreKeyOnChangeListener = (event, iframe, onExploreKeyOnChange) =
     }
   }
 };
-var workbookBookmarkOnChangeListener = (event, iframe, onBookmarkChange) => {
-  if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
-    if (event.data.type === WorkbookBookmarkOnChangeEventName) {
-      onBookmarkChange(event.data);
-    }
-  }
-};
 var urlOnChangeListener = (event, iframe, onUrlChange) => {
   if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
     if (event.data.type === UrlOnChangeEventName) {
@@ -183,14 +199,15 @@ var actionOutboundListener = (event, iframe, onActionOutbound) => {
 };
 
 // src/mutations.ts
+var SIGMA_COMPUTING_URL = "https://app.sigmacomputing.com";
 var sendIframeMessage = (iframe, message) => {
   if (!iframe.contentWindow) {
     throw new Error("iframe contentWindow is not available");
   }
-  iframe.contentWindow.postMessage(
-    message,
-    "https://staging.sigmacomputing.io"
-  );
+  iframe.contentWindow.postMessage(message, SIGMA_COMPUTING_URL);
+};
+var DO_NOT_USE_IN_PRODUCTION_overrideMutationUrl = (url) => {
+  SIGMA_COMPUTING_URL = url;
 };
 var workbookBookmarkCreate = (iframe, bookmark) => {
   sendIframeMessage(iframe, {
@@ -203,6 +220,18 @@ var workbookBookmarkUpdate = (iframe) => {
     type: WorkbookBookmarkUpdateEventName
   });
 };
+var workbookBookmarkSelect = (iframe, bookmarkId) => {
+  sendIframeMessage(iframe, {
+    type: "workbook:bookmark:select",
+    bookmarkId
+  });
+};
+var workbookBookmarkDelete = (iframe, bookmarkId) => {
+  sendIframeMessage(iframe, {
+    type: "workbook:bookmark:delete",
+    bookmarkId
+  });
+};
 var workbookFullscreenUpdate = (iframe, nodeId) => {
   sendIframeMessage(iframe, {
     type: WorkbookFullscreenUpdateEventName,
@@ -212,7 +241,7 @@ var workbookFullscreenUpdate = (iframe, nodeId) => {
 var workbookSelectedNodeIdUpdate = (iframe, nodeId, nodeType) => {
   sendIframeMessage(iframe, {
     type: WorkbookSelectedNodeIdUpdateEventName,
-    nodeId,
+    selectedNodeId: nodeId,
     nodeType
   });
 };
@@ -235,11 +264,16 @@ var workbookSharingLinkUpdate = (iframe, sharingLink, sharingExplorationLink) =>
   });
 };
 export {
+  DO_NOT_USE_IN_PRODUCTION_overrideMutationUrl,
   actionOutboundListener,
   urlOnChangeListener,
   workbookBookmarkCreate,
   workbookBookmarkCreateListener,
+  workbookBookmarkDelete,
   workbookBookmarkOnChangeListener,
+  workbookBookmarkOnDeleteListener,
+  workbookBookmarkOnUpdateListener,
+  workbookBookmarkSelect,
   workbookBookmarkUpdate,
   workbookChartErrorListener,
   workbookChartValueSelectListener,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sigmacomputing/embed-sdk",
   "author": "sigmacomputing",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "JavaScript SDK to interact with Sigma Computing's Embed API",
   "license": "MIT",
   "repository": {
@@ -18,10 +18,18 @@
     "sdk",
     "sigma"
   ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "exports": {
-    "import": "./dist/index.mjs",
-    "require": "./dist/index.js",
-    "types": "./dist/index.d.ts"
+    "import": {
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.mts"
+    },
+    "require": {
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
   },
   "files": [
     "dist"
@@ -31,7 +39,7 @@
     "@sigmacomputing/typescript-config": "0.0.0"
   },
   "scripts": {
-    "prepublish": "pnpm run build",
+    "prepublish": "turbo run build",
     "build": "tsup",
     "lint": "eslint . --ext .ts",
     "watch": "tsup --watch",