@sigmacomputing/embed-sdk 0.2.11 → 0.3.1

package/dist/index.d.mts

@@ -63,6 +63,7 @@ declare const WorkbookSelectedNodeIdUpdateEventName: "workbook:selectednodeid:up
 declare const WorkbookVariablesListEventName: "workbook:variables:list";
 declare const WorkbookVariablesUpdateEventName: "workbook:variables:update";
 declare const WorkbookVariablesCurrentEventName: "workbook:variables:current";
+declare const WorkbookSharingLinkUpdateEventName: "workbook:sharinglink:update";
 interface WorkbookLoadedEvent {
     type: typeof WorkbookLoadedEventName;
     workbook: {
@@ -82,6 +83,10 @@ interface WorkbookVariableCurrentEvent {
     type: typeof WorkbookVariablesCurrentEventName;
     variables: Record<string, string>;
 }
+interface WorkbookSharingLinkUpdateEvent {
+    type: typeof WorkbookSharingLinkUpdateEventName;
+    variables: Record<string, string>;
+}
 interface WorkbookTableCellSelectEvent {
     type: typeof WorkbookTableCellSelectEventName;
     nodeId: string;
@@ -165,6 +170,7 @@ declare const workbookLoadedListener: (event: MessageEvent, iframe: HTMLIFrameEl
 declare const workbookErrorListener: (event: MessageEvent, iframe: HTMLIFrameElement, onError: (event: WorkbookErrorEvent) => void) => void;
 declare const workbookVariableChangeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onVariable: (event: WorkbookVariableOnChangeEvent) => void) => void;
 declare const workbookVariableCurrentListener: (event: MessageEvent, iframe: HTMLIFrameElement, onVariable: (event: WorkbookVariableCurrentEvent) => void) => void;
+declare const workbookLinkSharingUpdateListener: (event: MessageEvent, iframe: HTMLIFrameElement, onVariable: (event: WorkbookSharingLinkUpdateEvent) => void) => void;
 declare const workbookTableCellSelectListener: (event: MessageEvent, iframe: HTMLIFrameElement, onTableCellSelect: (event: WorkbookTableCellSelectEvent) => void) => void;
 declare const workbookPublishedListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPublished: (event: WorkbookPublishedEvent) => void) => void;
 declare const workbookFullScreenListener: (event: MessageEvent, iframe: HTMLIFrameElement, onFullScreen: (event: WorkbookFullScreenEvent) => void) => void;
@@ -187,5 +193,6 @@ declare const workbookFullscreenUpdate: (iframe: HTMLIFrameElement, nodeId: stri
 declare const workbookSelectedNodeIdUpdate: (iframe: HTMLIFrameElement, nodeId: string, 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 { 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 WorkbookTableCellSelectEvent, WorkbookTableCellSelectEventName, type WorkbookVariableCurrentEvent, WorkbookVariableEventOnChangeName, type WorkbookVariableOnChangeEvent, WorkbookVariablesCurrentEventName, WorkbookVariablesListEventName, WorkbookVariablesUpdateEventName, urlOnChangeListener, workbookBookmarkCreate, workbookBookmarkCreateListener, workbookBookmarkOnChangeListener, workbookBookmarkUpdate, workbookChartErrorListener, workbookChartValueSelectListener, workbookCurrentVariablesListener, workbookDataLoadedListener, workbookErrorListener, workbookExploreKeyOnChangeListener, workbookFullScreenListener, workbookFullscreenUpdate, workbookIdOnChangeListener, workbookLoadedListener, workbookPageHeightListener, workbookPageSelectedNodeListener, workbookPivotTableCellSelectListener, workbookPublishedListener, workbookSelectedNodeIdUpdate, workbookTableCellSelectListener, workbookVariableChangeListener, workbookVariableCurrentListener, workbookVariablesList, workbookVariablesUpdate };
+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 };

package/dist/index.d.ts

@@ -63,6 +63,7 @@ declare const WorkbookSelectedNodeIdUpdateEventName: "workbook:selectednodeid:up
 declare const WorkbookVariablesListEventName: "workbook:variables:list";
 declare const WorkbookVariablesUpdateEventName: "workbook:variables:update";
 declare const WorkbookVariablesCurrentEventName: "workbook:variables:current";
+declare const WorkbookSharingLinkUpdateEventName: "workbook:sharinglink:update";
 interface WorkbookLoadedEvent {
     type: typeof WorkbookLoadedEventName;
     workbook: {
@@ -82,6 +83,10 @@ interface WorkbookVariableCurrentEvent {
     type: typeof WorkbookVariablesCurrentEventName;
     variables: Record<string, string>;
 }
+interface WorkbookSharingLinkUpdateEvent {
+    type: typeof WorkbookSharingLinkUpdateEventName;
+    variables: Record<string, string>;
+}
 interface WorkbookTableCellSelectEvent {
     type: typeof WorkbookTableCellSelectEventName;
     nodeId: string;
@@ -165,6 +170,7 @@ declare const workbookLoadedListener: (event: MessageEvent, iframe: HTMLIFrameEl
 declare const workbookErrorListener: (event: MessageEvent, iframe: HTMLIFrameElement, onError: (event: WorkbookErrorEvent) => void) => void;
 declare const workbookVariableChangeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onVariable: (event: WorkbookVariableOnChangeEvent) => void) => void;
 declare const workbookVariableCurrentListener: (event: MessageEvent, iframe: HTMLIFrameElement, onVariable: (event: WorkbookVariableCurrentEvent) => void) => void;
+declare const workbookLinkSharingUpdateListener: (event: MessageEvent, iframe: HTMLIFrameElement, onVariable: (event: WorkbookSharingLinkUpdateEvent) => void) => void;
 declare const workbookTableCellSelectListener: (event: MessageEvent, iframe: HTMLIFrameElement, onTableCellSelect: (event: WorkbookTableCellSelectEvent) => void) => void;
 declare const workbookPublishedListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPublished: (event: WorkbookPublishedEvent) => void) => void;
 declare const workbookFullScreenListener: (event: MessageEvent, iframe: HTMLIFrameElement, onFullScreen: (event: WorkbookFullScreenEvent) => void) => void;
@@ -187,5 +193,6 @@ declare const workbookFullscreenUpdate: (iframe: HTMLIFrameElement, nodeId: stri
 declare const workbookSelectedNodeIdUpdate: (iframe: HTMLIFrameElement, nodeId: string, 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 { 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 WorkbookTableCellSelectEvent, WorkbookTableCellSelectEventName, type WorkbookVariableCurrentEvent, WorkbookVariableEventOnChangeName, type WorkbookVariableOnChangeEvent, WorkbookVariablesCurrentEventName, WorkbookVariablesListEventName, WorkbookVariablesUpdateEventName, urlOnChangeListener, workbookBookmarkCreate, workbookBookmarkCreateListener, workbookBookmarkOnChangeListener, workbookBookmarkUpdate, workbookChartErrorListener, workbookChartValueSelectListener, workbookCurrentVariablesListener, workbookDataLoadedListener, workbookErrorListener, workbookExploreKeyOnChangeListener, workbookFullScreenListener, workbookFullscreenUpdate, workbookIdOnChangeListener, workbookLoadedListener, workbookPageHeightListener, workbookPageSelectedNodeListener, workbookPivotTableCellSelectListener, workbookPublishedListener, workbookSelectedNodeIdUpdate, workbookTableCellSelectListener, workbookVariableChangeListener, workbookVariableCurrentListener, workbookVariablesList, workbookVariablesUpdate };
+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 };

package/dist/index.js

@@ -34,12 +34,14 @@ __export(src_exports, {
   workbookFullScreenListener: () => workbookFullScreenListener,
   workbookFullscreenUpdate: () => workbookFullscreenUpdate,
   workbookIdOnChangeListener: () => workbookIdOnChangeListener,
+  workbookLinkSharingUpdateListener: () => workbookLinkSharingUpdateListener,
   workbookLoadedListener: () => workbookLoadedListener,
   workbookPageHeightListener: () => workbookPageHeightListener,
   workbookPageSelectedNodeListener: () => workbookPageSelectedNodeListener,
   workbookPivotTableCellSelectListener: () => workbookPivotTableCellSelectListener,
   workbookPublishedListener: () => workbookPublishedListener,
   workbookSelectedNodeIdUpdate: () => workbookSelectedNodeIdUpdate,
+  workbookSharingLinkUpdate: () => workbookSharingLinkUpdate,
   workbookTableCellSelectListener: () => workbookTableCellSelectListener,
   workbookVariableChangeListener: () => workbookVariableChangeListener,
   workbookVariableCurrentListener: () => workbookVariableCurrentListener,
@@ -74,6 +76,7 @@ var WorkbookSelectedNodeIdUpdateEventName = "workbook:selectednodeid:update";
 var WorkbookVariablesListEventName = "workbook:variables:list";
 var WorkbookVariablesUpdateEventName = "workbook:variables:update";
 var WorkbookVariablesCurrentEventName = "workbook:variables:current";
+var WorkbookSharingLinkUpdateEventName = "workbook:sharinglink:update";
 
 // src/wrapper.ts
 var checkEventOrigin = (url) => {
@@ -110,6 +113,13 @@ var workbookVariableCurrentListener = (event, iframe, onVariable) => {
     }
   }
 };
+var workbookLinkSharingUpdateListener = (event, iframe, onVariable) => {
+  if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
+    if (event.data.type === WorkbookSharingLinkUpdateEventName) {
+      onVariable(event.data);
+    }
+  }
+};
 var workbookTableCellSelectListener = (event, iframe, onTableCellSelect) => {
   if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
     if (event.data.type === WorkbookTableCellSelectEventName) {
@@ -261,6 +271,13 @@ var workbookVariablesUpdate = (iframe, variables) => {
     variables
   });
 };
+var workbookSharingLinkUpdate = (iframe, sharingLink, sharingExplorationLink) => {
+  sendIframeMessage(iframe, {
+    type: WorkbookSharingLinkUpdateEventName,
+    sharingLink,
+    sharingExplorationLink
+  });
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   urlOnChangeListener,
@@ -277,12 +294,14 @@ var workbookVariablesUpdate = (iframe, variables) => {
   workbookFullScreenListener,
   workbookFullscreenUpdate,
   workbookIdOnChangeListener,
+  workbookLinkSharingUpdateListener,
   workbookLoadedListener,
   workbookPageHeightListener,
   workbookPageSelectedNodeListener,
   workbookPivotTableCellSelectListener,
   workbookPublishedListener,
   workbookSelectedNodeIdUpdate,
+  workbookSharingLinkUpdate,
   workbookTableCellSelectListener,
   workbookVariableChangeListener,
   workbookVariableCurrentListener,

package/dist/index.mjs

@@ -24,6 +24,7 @@ var WorkbookSelectedNodeIdUpdateEventName = "workbook:selectednodeid:update";
 var WorkbookVariablesListEventName = "workbook:variables:list";
 var WorkbookVariablesUpdateEventName = "workbook:variables:update";
 var WorkbookVariablesCurrentEventName = "workbook:variables:current";
+var WorkbookSharingLinkUpdateEventName = "workbook:sharinglink:update";
 
 // src/wrapper.ts
 var checkEventOrigin = (url) => {
@@ -60,6 +61,13 @@ var workbookVariableCurrentListener = (event, iframe, onVariable) => {
     }
   }
 };
+var workbookLinkSharingUpdateListener = (event, iframe, onVariable) => {
+  if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
+    if (event.data.type === WorkbookSharingLinkUpdateEventName) {
+      onVariable(event.data);
+    }
+  }
+};
 var workbookTableCellSelectListener = (event, iframe, onTableCellSelect) => {
   if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
     if (event.data.type === WorkbookTableCellSelectEventName) {
@@ -211,6 +219,13 @@ var workbookVariablesUpdate = (iframe, variables) => {
     variables
   });
 };
+var workbookSharingLinkUpdate = (iframe, sharingLink, sharingExplorationLink) => {
+  sendIframeMessage(iframe, {
+    type: WorkbookSharingLinkUpdateEventName,
+    sharingLink,
+    sharingExplorationLink
+  });
+};
 export {
   urlOnChangeListener,
   workbookBookmarkCreate,
@@ -226,12 +241,14 @@ export {
   workbookFullScreenListener,
   workbookFullscreenUpdate,
   workbookIdOnChangeListener,
+  workbookLinkSharingUpdateListener,
   workbookLoadedListener,
   workbookPageHeightListener,
   workbookPageSelectedNodeListener,
   workbookPivotTableCellSelectListener,
   workbookPublishedListener,
   workbookSelectedNodeIdUpdate,
+  workbookSharingLinkUpdate,
   workbookTableCellSelectListener,
   workbookVariableChangeListener,
   workbookVariableCurrentListener,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sigmacomputing/embed-sdk",
-  "version": "0.2.11",
+  "version": "0.3.1",
   "description": "JavaScript SDK to interact with Sigma Computing's Embed API",
   "author": "sigmacomputing",
   "license": "ISC",