@sigmacomputing/embed-sdk 0.2.0 → 0.2.1

package/dist/index.d.mts

@@ -1,15 +1,84 @@
+type Value_t = Object | Date | boolean | number | string | null;
+declare enum CellType_t {
+    Value = "valueCell",
+    RowHeader = "rowHeader",
+    ColumnHeader = "columnHeader",
+    Total = "total"
+}
+type DataRow_t = Record<string, Value_t>;
+type DataRows_t = DataRow_t[];
+interface Data_t {
+    rows: DataRows_t;
+    isTruncated: boolean;
+    length: number;
+}
+interface Cell_t {
+    value: Value_t;
+    cellType: CellType_t;
+    columnName: string;
+}
+interface LevelTableValueCell_t extends Cell_t {
+    cellType: CellType_t.Value;
+    underlyingData: Data_t;
+}
+interface LevelTableColumnCell_t extends Cell_t {
+    cellType: CellType_t.ColumnHeader;
+}
+type LevelTableCell_t = LevelTableValueCell_t | LevelTableColumnCell_t;
+type LevelTableCells = LevelTableCell_t[];
+declare const WorkbookLoadedEventName: "workbook:loaded";
+declare const WorkbookErrorEventName: "workbook:error";
+declare const WorkbookVariableEventName: "workbook:variables:onchange";
+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";
 interface WorkbookLoadedEvent {
-    type: "workbook:loaded";
+    type: typeof WorkbookLoadedEventName;
     workbook: {
         variables: Record<string, string>;
     };
 }
 interface WorkbookErrorEvent {
-    type: "workbook:error";
+    type: typeof WorkbookErrorEventName;
     code: string;
     message: string;
 }
+interface WorkbookVariableEvent {
+    type: typeof WorkbookVariableEventName;
+    variables: Record<string, string>;
+}
+interface WorkbookTableCellSelectEvent {
+    type: typeof WorkbookTableCellSelectEventName;
+    nodeId: string;
+    title: string;
+    cells: LevelTableCells;
+}
+type WorkbookPublishedEvent = {
+    type: typeof WorkbookPublishedEventName;
+    workbookId: string;
+};
+type WorkbookFullScreenEvent = {
+    type: typeof WorkbookFullScreenEventName;
+    fullScreen: boolean;
+};
+type WorkbookPageHeightEvent = {
+    type: typeof WorkbookPageHeightEventName;
+    pageHeight: number;
+};
+type WorkbookPageSelectedNodeEvent = {
+    type: typeof WorkbookPageSelectedNodeEventName;
+    selectedNodeId: string | null;
+};
+
 declare const workbookLoadedListener: (event: MessageEvent, iframe: HTMLIFrameElement, onLoaded: (event: WorkbookLoadedEvent) => void) => void;
 declare const workbookErrorListener: (event: MessageEvent, iframe: HTMLIFrameElement, onError: (event: WorkbookErrorEvent) => void) => void;
+declare const workbookVariableListener: (event: MessageEvent, iframe: HTMLIFrameElement, onVariable: (event: WorkbookVariableEvent) => 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;
+declare const workbookPageHeightListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPageHeight: (event: WorkbookPageHeightEvent) => void) => void;
+declare const workbookPageSelectedNodeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPageSelectedNode: (event: WorkbookPageSelectedNodeEvent) => void) => void;
 
-export { type WorkbookErrorEvent, type WorkbookLoadedEvent, workbookErrorListener, workbookLoadedListener };
+export { workbookErrorListener, workbookFullScreenListener, workbookLoadedListener, workbookPageHeightListener, workbookPageSelectedNodeListener, workbookPublishedListener, workbookTableCellSelectListener, workbookVariableListener };

package/dist/index.d.ts

@@ -1,15 +1,84 @@
+type Value_t = Object | Date | boolean | number | string | null;
+declare enum CellType_t {
+    Value = "valueCell",
+    RowHeader = "rowHeader",
+    ColumnHeader = "columnHeader",
+    Total = "total"
+}
+type DataRow_t = Record<string, Value_t>;
+type DataRows_t = DataRow_t[];
+interface Data_t {
+    rows: DataRows_t;
+    isTruncated: boolean;
+    length: number;
+}
+interface Cell_t {
+    value: Value_t;
+    cellType: CellType_t;
+    columnName: string;
+}
+interface LevelTableValueCell_t extends Cell_t {
+    cellType: CellType_t.Value;
+    underlyingData: Data_t;
+}
+interface LevelTableColumnCell_t extends Cell_t {
+    cellType: CellType_t.ColumnHeader;
+}
+type LevelTableCell_t = LevelTableValueCell_t | LevelTableColumnCell_t;
+type LevelTableCells = LevelTableCell_t[];
+declare const WorkbookLoadedEventName: "workbook:loaded";
+declare const WorkbookErrorEventName: "workbook:error";
+declare const WorkbookVariableEventName: "workbook:variables:onchange";
+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";
 interface WorkbookLoadedEvent {
-    type: "workbook:loaded";
+    type: typeof WorkbookLoadedEventName;
     workbook: {
         variables: Record<string, string>;
     };
 }
 interface WorkbookErrorEvent {
-    type: "workbook:error";
+    type: typeof WorkbookErrorEventName;
     code: string;
     message: string;
 }
+interface WorkbookVariableEvent {
+    type: typeof WorkbookVariableEventName;
+    variables: Record<string, string>;
+}
+interface WorkbookTableCellSelectEvent {
+    type: typeof WorkbookTableCellSelectEventName;
+    nodeId: string;
+    title: string;
+    cells: LevelTableCells;
+}
+type WorkbookPublishedEvent = {
+    type: typeof WorkbookPublishedEventName;
+    workbookId: string;
+};
+type WorkbookFullScreenEvent = {
+    type: typeof WorkbookFullScreenEventName;
+    fullScreen: boolean;
+};
+type WorkbookPageHeightEvent = {
+    type: typeof WorkbookPageHeightEventName;
+    pageHeight: number;
+};
+type WorkbookPageSelectedNodeEvent = {
+    type: typeof WorkbookPageSelectedNodeEventName;
+    selectedNodeId: string | null;
+};
+
 declare const workbookLoadedListener: (event: MessageEvent, iframe: HTMLIFrameElement, onLoaded: (event: WorkbookLoadedEvent) => void) => void;
 declare const workbookErrorListener: (event: MessageEvent, iframe: HTMLIFrameElement, onError: (event: WorkbookErrorEvent) => void) => void;
+declare const workbookVariableListener: (event: MessageEvent, iframe: HTMLIFrameElement, onVariable: (event: WorkbookVariableEvent) => 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;
+declare const workbookPageHeightListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPageHeight: (event: WorkbookPageHeightEvent) => void) => void;
+declare const workbookPageSelectedNodeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPageSelectedNode: (event: WorkbookPageSelectedNodeEvent) => void) => void;
 
-export { type WorkbookErrorEvent, type WorkbookLoadedEvent, workbookErrorListener, workbookLoadedListener };
+export { workbookErrorListener, workbookFullScreenListener, workbookLoadedListener, workbookPageHeightListener, workbookPageSelectedNodeListener, workbookPublishedListener, workbookTableCellSelectListener, workbookVariableListener };

package/dist/index.js

@@ -21,25 +21,91 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   workbookErrorListener: () => workbookErrorListener,
-  workbookLoadedListener: () => workbookLoadedListener
+  workbookFullScreenListener: () => workbookFullScreenListener,
+  workbookLoadedListener: () => workbookLoadedListener,
+  workbookPageHeightListener: () => workbookPageHeightListener,
+  workbookPageSelectedNodeListener: () => workbookPageSelectedNodeListener,
+  workbookPublishedListener: () => workbookPublishedListener,
+  workbookTableCellSelectListener: () => workbookTableCellSelectListener,
+  workbookVariableListener: () => workbookVariableListener
 });
 module.exports = __toCommonJS(src_exports);
+
+// src/types.ts
+var WorkbookLoadedEventName = "workbook:loaded";
+var WorkbookErrorEventName = "workbook:error";
+var WorkbookVariableEventName = "workbook:variables:onchange";
+var WorkbookTableCellSelectEventName = "workbook:table:oncellselect";
+var WorkbookPublishedEventName = "workbook:published";
+var WorkbookFullScreenEventName = "workbook:fullscreen:onchange";
+var WorkbookPageHeightEventName = "workbook:pageheight:onchange";
+var WorkbookPageSelectedNodeEventName = "workbook:selectednodeid:onchange";
+
+// src/index.ts
 var workbookLoadedListener = (event, iframe, onLoaded) => {
   if (event.source === iframe.contentWindow && event.origin === "https://staging.sigmacomputing.io") {
-    if (event.data.type === "workbook:loaded") {
+    if (event.data.type === WorkbookLoadedEventName) {
       onLoaded(event.data);
     }
   }
 };
 var workbookErrorListener = (event, iframe, onError) => {
   if (event.source === iframe.contentWindow && event.origin === "https://staging.sigmacomputing.io") {
-    if (event.data.type === "workbook:error") {
+    if (event.data.type === WorkbookErrorEventName) {
       onError(event.data);
     }
   }
 };
+var workbookVariableListener = (event, iframe, onVariable) => {
+  if (event.source === iframe.contentWindow && event.origin === "https://staging.sigmacomputing.io") {
+    if (event.data.type === WorkbookVariableEventName) {
+      onVariable(event.data);
+    }
+  }
+};
+var workbookTableCellSelectListener = (event, iframe, onTableCellSelect) => {
+  if (event.source === iframe.contentWindow && event.origin === "https://staging.sigmacomputing.io") {
+    if (event.data.type === WorkbookTableCellSelectEventName) {
+      onTableCellSelect(event.data);
+    }
+  }
+};
+var workbookPublishedListener = (event, iframe, onPublished) => {
+  if (event.source === iframe.contentWindow && event.origin === "https://staging.sigmacomputing.io") {
+    if (event.data.type === WorkbookPublishedEventName) {
+      onPublished(event.data);
+    }
+  }
+};
+var workbookFullScreenListener = (event, iframe, onFullScreen) => {
+  if (event.source === iframe.contentWindow && event.origin === "https://staging.sigmacomputing.io") {
+    if (event.data.type === WorkbookFullScreenEventName) {
+      onFullScreen(event.data);
+    }
+  }
+};
+var workbookPageHeightListener = (event, iframe, onPageHeight) => {
+  if (event.source === iframe.contentWindow && event.origin === "https://staging.sigmacomputing.io") {
+    if (event.data.type === WorkbookPageHeightEventName) {
+      onPageHeight(event.data);
+    }
+  }
+};
+var workbookPageSelectedNodeListener = (event, iframe, onPageSelectedNode) => {
+  if (event.source === iframe.contentWindow && event.origin === "https://staging.sigmacomputing.io") {
+    if (event.data.type === WorkbookPageSelectedNodeEventName) {
+      onPageSelectedNode(event.data);
+    }
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   workbookErrorListener,
-  workbookLoadedListener
+  workbookFullScreenListener,
+  workbookLoadedListener,
+  workbookPageHeightListener,
+  workbookPageSelectedNodeListener,
+  workbookPublishedListener,
+  workbookTableCellSelectListener,
+  workbookVariableListener
 });

package/dist/index.mjs

@@ -1,19 +1,77 @@
+// src/types.ts
+var WorkbookLoadedEventName = "workbook:loaded";
+var WorkbookErrorEventName = "workbook:error";
+var WorkbookVariableEventName = "workbook:variables:onchange";
+var WorkbookTableCellSelectEventName = "workbook:table:oncellselect";
+var WorkbookPublishedEventName = "workbook:published";
+var WorkbookFullScreenEventName = "workbook:fullscreen:onchange";
+var WorkbookPageHeightEventName = "workbook:pageheight:onchange";
+var WorkbookPageSelectedNodeEventName = "workbook:selectednodeid:onchange";
+
 // src/index.ts
 var workbookLoadedListener = (event, iframe, onLoaded) => {
   if (event.source === iframe.contentWindow && event.origin === "https://staging.sigmacomputing.io") {
-    if (event.data.type === "workbook:loaded") {
+    if (event.data.type === WorkbookLoadedEventName) {
       onLoaded(event.data);
     }
   }
 };
 var workbookErrorListener = (event, iframe, onError) => {
   if (event.source === iframe.contentWindow && event.origin === "https://staging.sigmacomputing.io") {
-    if (event.data.type === "workbook:error") {
+    if (event.data.type === WorkbookErrorEventName) {
       onError(event.data);
     }
   }
 };
+var workbookVariableListener = (event, iframe, onVariable) => {
+  if (event.source === iframe.contentWindow && event.origin === "https://staging.sigmacomputing.io") {
+    if (event.data.type === WorkbookVariableEventName) {
+      onVariable(event.data);
+    }
+  }
+};
+var workbookTableCellSelectListener = (event, iframe, onTableCellSelect) => {
+  if (event.source === iframe.contentWindow && event.origin === "https://staging.sigmacomputing.io") {
+    if (event.data.type === WorkbookTableCellSelectEventName) {
+      onTableCellSelect(event.data);
+    }
+  }
+};
+var workbookPublishedListener = (event, iframe, onPublished) => {
+  if (event.source === iframe.contentWindow && event.origin === "https://staging.sigmacomputing.io") {
+    if (event.data.type === WorkbookPublishedEventName) {
+      onPublished(event.data);
+    }
+  }
+};
+var workbookFullScreenListener = (event, iframe, onFullScreen) => {
+  if (event.source === iframe.contentWindow && event.origin === "https://staging.sigmacomputing.io") {
+    if (event.data.type === WorkbookFullScreenEventName) {
+      onFullScreen(event.data);
+    }
+  }
+};
+var workbookPageHeightListener = (event, iframe, onPageHeight) => {
+  if (event.source === iframe.contentWindow && event.origin === "https://staging.sigmacomputing.io") {
+    if (event.data.type === WorkbookPageHeightEventName) {
+      onPageHeight(event.data);
+    }
+  }
+};
+var workbookPageSelectedNodeListener = (event, iframe, onPageSelectedNode) => {
+  if (event.source === iframe.contentWindow && event.origin === "https://staging.sigmacomputing.io") {
+    if (event.data.type === WorkbookPageSelectedNodeEventName) {
+      onPageSelectedNode(event.data);
+    }
+  }
+};
 export {
   workbookErrorListener,
-  workbookLoadedListener
+  workbookFullScreenListener,
+  workbookLoadedListener,
+  workbookPageHeightListener,
+  workbookPageSelectedNodeListener,
+  workbookPublishedListener,
+  workbookTableCellSelectListener,
+  workbookVariableListener
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sigmacomputing/embed-sdk",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "JavaScript SDK to interact with Sigma Computing's Embed API",
   "scripts": {
     "prepublish": "npm run build",
@@ -18,5 +18,8 @@
   },
   "files": [
     "dist"
-  ]
+  ],
+  "devDependencies": {
+    "@sigmacomputing/typescript-config": "*"
+  }
 }