@sigmacomputing/react-embed-sdk 0.2.8 → 0.2.11

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { WorkbookErrorEvent, WorkbookLoadedEvent, WorkbookDataLoadedEvent, WorkbookVariableOnChangeEvent, WorkbookTableCellSelectEvent, WorkbookPublishedEvent, WorkbookFullScreenEvent, WorkbookPageHeightEvent, WorkbookPageSelectedNodeEvent, WorkbookPivotTableCellSelectEvent, WorkbookChartValueSelectEvent, WorkbookCurrentVariablesEvent, WorkbookBookmarkOnCreateEvent, WorkbookChartErrorEvent, WorkbookExploreKeyOnChangeEvent, WorkbookBookmarkOnChangeEvent, UrlOnChangeEvent, WorkbookIdOnChangeEvent } from '@sigmacomputing/embed-sdk';
+import { WorkbookErrorEvent, WorkbookLoadedEvent, WorkbookDataLoadedEvent, WorkbookVariableOnChangeEvent, WorkbookTableCellSelectEvent, WorkbookPublishedEvent, WorkbookFullScreenEvent, WorkbookPageHeightEvent, WorkbookPageSelectedNodeEvent, WorkbookPivotTableCellSelectEvent, WorkbookChartValueSelectEvent, WorkbookCurrentVariablesEvent, WorkbookBookmarkOnCreateEvent, WorkbookChartErrorEvent, WorkbookExploreKeyOnChangeEvent, WorkbookBookmarkOnChangeEvent, UrlOnChangeEvent, WorkbookIdOnChangeEvent, WorkbookBookmarkCreateEvent } from '@sigmacomputing/embed-sdk';
 export * from '@sigmacomputing/embed-sdk';
 import * as react from 'react';
 
@@ -158,4 +158,11 @@ declare function useWorkbookBookmarkOnChange(iframeRef: React.RefObject<HTMLIFra
 declare function useUrlOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onUrlChange: (event: UrlOnChangeEvent) => void): void;
 declare function useWorkbookIdOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onIdChange: (event: WorkbookIdOnChangeEvent) => void): void;
 
-export { usePageHeight, useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPageSelectedNode, useWorkbookPivotTableCellSelect, useWorkbookPublished, useWorkbookVariables };
+declare function getWorkbookVariables(iframeRef: React.RefObject<HTMLIFrameElement>): void;
+declare function updateWorkbookVariables(iframeRef: React.RefObject<HTMLIFrameElement>, variables: Record<string, string>): void;
+declare function createWorkbookBookmark(iframeRef: React.RefObject<HTMLIFrameElement>, bookmark: WorkbookBookmarkCreateEvent): void;
+declare function updateWorkbookBookmark(iframeRef: React.RefObject<HTMLIFrameElement>): void;
+declare function updateWorkbookFullscreen(iframeRef: React.RefObject<HTMLIFrameElement>, nodeId: string | null): void;
+declare function updateWorkbookSelectedNodeId(iframeRef: React.RefObject<HTMLIFrameElement>, nodeId: string, nodeType: "element" | "page"): void;
+
+export { createWorkbookBookmark, getWorkbookVariables, updateWorkbookBookmark, updateWorkbookFullscreen, updateWorkbookSelectedNodeId, updateWorkbookVariables, usePageHeight, useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPageSelectedNode, useWorkbookPivotTableCellSelect, useWorkbookPublished, useWorkbookVariables };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { WorkbookErrorEvent, WorkbookLoadedEvent, WorkbookDataLoadedEvent, WorkbookVariableOnChangeEvent, WorkbookTableCellSelectEvent, WorkbookPublishedEvent, WorkbookFullScreenEvent, WorkbookPageHeightEvent, WorkbookPageSelectedNodeEvent, WorkbookPivotTableCellSelectEvent, WorkbookChartValueSelectEvent, WorkbookCurrentVariablesEvent, WorkbookBookmarkOnCreateEvent, WorkbookChartErrorEvent, WorkbookExploreKeyOnChangeEvent, WorkbookBookmarkOnChangeEvent, UrlOnChangeEvent, WorkbookIdOnChangeEvent } from '@sigmacomputing/embed-sdk';
+import { WorkbookErrorEvent, WorkbookLoadedEvent, WorkbookDataLoadedEvent, WorkbookVariableOnChangeEvent, WorkbookTableCellSelectEvent, WorkbookPublishedEvent, WorkbookFullScreenEvent, WorkbookPageHeightEvent, WorkbookPageSelectedNodeEvent, WorkbookPivotTableCellSelectEvent, WorkbookChartValueSelectEvent, WorkbookCurrentVariablesEvent, WorkbookBookmarkOnCreateEvent, WorkbookChartErrorEvent, WorkbookExploreKeyOnChangeEvent, WorkbookBookmarkOnChangeEvent, UrlOnChangeEvent, WorkbookIdOnChangeEvent, WorkbookBookmarkCreateEvent } from '@sigmacomputing/embed-sdk';
 export * from '@sigmacomputing/embed-sdk';
 import * as react from 'react';
 
@@ -158,4 +158,11 @@ declare function useWorkbookBookmarkOnChange(iframeRef: React.RefObject<HTMLIFra
 declare function useUrlOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onUrlChange: (event: UrlOnChangeEvent) => void): void;
 declare function useWorkbookIdOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onIdChange: (event: WorkbookIdOnChangeEvent) => void): void;
 
-export { usePageHeight, useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPageSelectedNode, useWorkbookPivotTableCellSelect, useWorkbookPublished, useWorkbookVariables };
+declare function getWorkbookVariables(iframeRef: React.RefObject<HTMLIFrameElement>): void;
+declare function updateWorkbookVariables(iframeRef: React.RefObject<HTMLIFrameElement>, variables: Record<string, string>): void;
+declare function createWorkbookBookmark(iframeRef: React.RefObject<HTMLIFrameElement>, bookmark: WorkbookBookmarkCreateEvent): void;
+declare function updateWorkbookBookmark(iframeRef: React.RefObject<HTMLIFrameElement>): void;
+declare function updateWorkbookFullscreen(iframeRef: React.RefObject<HTMLIFrameElement>, nodeId: string | null): void;
+declare function updateWorkbookSelectedNodeId(iframeRef: React.RefObject<HTMLIFrameElement>, nodeId: string, nodeType: "element" | "page"): void;
+
+export { createWorkbookBookmark, getWorkbookVariables, updateWorkbookBookmark, updateWorkbookFullscreen, updateWorkbookSelectedNodeId, updateWorkbookVariables, usePageHeight, useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPageSelectedNode, useWorkbookPivotTableCellSelect, useWorkbookPublished, useWorkbookVariables };

package/dist/index.js

@@ -20,6 +20,12 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  createWorkbookBookmark: () => createWorkbookBookmark,
+  getWorkbookVariables: () => getWorkbookVariables,
+  updateWorkbookBookmark: () => updateWorkbookBookmark,
+  updateWorkbookFullscreen: () => updateWorkbookFullscreen,
+  updateWorkbookSelectedNodeId: () => updateWorkbookSelectedNodeId,
+  updateWorkbookVariables: () => updateWorkbookVariables,
   usePageHeight: () => usePageHeight,
   useSigmaIframe: () => useSigmaIframe,
   useTableCellSelect: () => useTableCellSelect,
@@ -327,14 +333,13 @@ var import_react3 = require("react");
 function usePageHeight(iframeRef) {
   const [height, setHeight] = (0, import_react3.useState)(void 0);
   useWorkbookPageHeight(iframeRef, (event) => {
-    if (!iframeRef.current)
-      return;
+    if (!iframeRef.current) return;
     setHeight(event.pageHeight);
   });
   return height;
 }
 
-// src/mutations.ts
+// src/use-workbook-variables.ts
 var import_react4 = require("react");
 var import_embed_sdk2 = require("@sigmacomputing/embed-sdk");
 var useWorkbookVariables = (iframeRef) => {
@@ -359,14 +364,13 @@ var useWorkbookVariables = (iframeRef) => {
     [iframeRef]
   );
   (0, import_react4.useEffect)(() => {
-    if (!iframeRef.current)
-      return;
+    if (!iframeRef.current) return;
     const listener = (event) => {
       if (!iframeRef.current) {
         return;
       }
       (0, import_embed_sdk2.workbookCurrentVariablesListener)(event, iframeRef.current, (event2) => {
-        if ((state == null ? void 0 : state.state) === "pending") {
+        if (state?.state === "pending") {
           setState({ state: "success", variables: event2.variables });
           state.callback(event2.variables);
         }
@@ -382,8 +386,53 @@ var useWorkbookVariables = (iframeRef) => {
     setVariables
   };
 };
+
+// src/mutations.ts
+var import_embed_sdk3 = require("@sigmacomputing/embed-sdk");
+function getWorkbookVariables(iframeRef) {
+  if (!iframeRef.current) {
+    throw new Error("iframe is not available");
+  }
+  (0, import_embed_sdk3.workbookVariablesList)(iframeRef.current);
+}
+function updateWorkbookVariables(iframeRef, variables) {
+  if (!iframeRef.current) {
+    throw new Error("iframe is not available");
+  }
+  (0, import_embed_sdk3.workbookVariablesUpdate)(iframeRef.current, variables);
+}
+function createWorkbookBookmark(iframeRef, bookmark) {
+  if (!iframeRef.current) {
+    throw new Error("iframe is not available");
+  }
+  (0, import_embed_sdk3.workbookBookmarkCreate)(iframeRef.current, bookmark);
+}
+function updateWorkbookBookmark(iframeRef) {
+  if (!iframeRef.current) {
+    throw new Error("iframe is not available");
+  }
+  (0, import_embed_sdk3.workbookBookmarkUpdate)(iframeRef.current);
+}
+function updateWorkbookFullscreen(iframeRef, nodeId) {
+  if (!iframeRef.current) {
+    throw new Error("iframe is not available");
+  }
+  (0, import_embed_sdk3.workbookFullscreenUpdate)(iframeRef.current, nodeId);
+}
+function updateWorkbookSelectedNodeId(iframeRef, nodeId, nodeType) {
+  if (!iframeRef.current) {
+    throw new Error("iframe is not available");
+  }
+  (0, import_embed_sdk3.workbookSelectedNodeIdUpdate)(iframeRef.current, nodeId, nodeType);
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  createWorkbookBookmark,
+  getWorkbookVariables,
+  updateWorkbookBookmark,
+  updateWorkbookFullscreen,
+  updateWorkbookSelectedNodeId,
+  updateWorkbookVariables,
   usePageHeight,
   useSigmaIframe,
   useTableCellSelect,

package/dist/index.mjs

@@ -300,14 +300,13 @@ import { useState as useState2 } from "react";
 function usePageHeight(iframeRef) {
   const [height, setHeight] = useState2(void 0);
   useWorkbookPageHeight(iframeRef, (event) => {
-    if (!iframeRef.current)
-      return;
+    if (!iframeRef.current) return;
     setHeight(event.pageHeight);
   });
   return height;
 }
 
-// src/mutations.ts
+// src/use-workbook-variables.ts
 import { useCallback as useCallback2, useEffect as useEffect2, useState as useState3 } from "react";
 import {
   workbookVariablesList,
@@ -336,14 +335,13 @@ var useWorkbookVariables = (iframeRef) => {
     [iframeRef]
   );
   useEffect2(() => {
-    if (!iframeRef.current)
-      return;
+    if (!iframeRef.current) return;
     const listener = (event) => {
       if (!iframeRef.current) {
         return;
       }
       workbookCurrentVariablesListener2(event, iframeRef.current, (event2) => {
-        if ((state == null ? void 0 : state.state) === "pending") {
+        if (state?.state === "pending") {
           setState({ state: "success", variables: event2.variables });
           state.callback(event2.variables);
         }
@@ -359,7 +357,59 @@ var useWorkbookVariables = (iframeRef) => {
     setVariables
   };
 };
+
+// src/mutations.ts
+import {
+  workbookVariablesList as workbookVariablesList2,
+  workbookVariablesUpdate as workbookVariablesUpdate2,
+  workbookBookmarkCreate,
+  workbookBookmarkUpdate,
+  workbookFullscreenUpdate,
+  workbookSelectedNodeIdUpdate
+} from "@sigmacomputing/embed-sdk";
+function getWorkbookVariables(iframeRef) {
+  if (!iframeRef.current) {
+    throw new Error("iframe is not available");
+  }
+  workbookVariablesList2(iframeRef.current);
+}
+function updateWorkbookVariables(iframeRef, variables) {
+  if (!iframeRef.current) {
+    throw new Error("iframe is not available");
+  }
+  workbookVariablesUpdate2(iframeRef.current, variables);
+}
+function createWorkbookBookmark(iframeRef, bookmark) {
+  if (!iframeRef.current) {
+    throw new Error("iframe is not available");
+  }
+  workbookBookmarkCreate(iframeRef.current, bookmark);
+}
+function updateWorkbookBookmark(iframeRef) {
+  if (!iframeRef.current) {
+    throw new Error("iframe is not available");
+  }
+  workbookBookmarkUpdate(iframeRef.current);
+}
+function updateWorkbookFullscreen(iframeRef, nodeId) {
+  if (!iframeRef.current) {
+    throw new Error("iframe is not available");
+  }
+  workbookFullscreenUpdate(iframeRef.current, nodeId);
+}
+function updateWorkbookSelectedNodeId(iframeRef, nodeId, nodeType) {
+  if (!iframeRef.current) {
+    throw new Error("iframe is not available");
+  }
+  workbookSelectedNodeIdUpdate(iframeRef.current, nodeId, nodeType);
+}
 export {
+  createWorkbookBookmark,
+  getWorkbookVariables,
+  updateWorkbookBookmark,
+  updateWorkbookFullscreen,
+  updateWorkbookSelectedNodeId,
+  updateWorkbookVariables,
   usePageHeight,
   useSigmaIframe,
   useTableCellSelect,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sigmacomputing/react-embed-sdk",
-  "version": "0.2.8",
+  "version": "0.2.11",
   "description": "React JavaScript SDK to interact with Sigma Computing's Embed API",
   "author": "sigmacomputing",
   "license": "ISC",
@@ -17,18 +17,20 @@
     "react-dom": "^16.8 || ^17 || ^18"
   },
   "devDependencies": {
-    "@types/react": "^18.2.66",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
+    "@types/react": "^18.3.3",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "@sigmacomputing/eslint-config": "0.0.0",
     "@sigmacomputing/typescript-config": "0.0.0"
   },
   "dependencies": {
-    "@sigmacomputing/embed-sdk": "0.2.8"
+    "@sigmacomputing/embed-sdk": "0.2.11"
   },
   "scripts": {
     "prepublish": "pnpm build",
     "build": "tsup",
     "dev": "tsup --watch",
+    "lint": "eslint . --ext .ts,.tsx",
     "test": "echo \"Error: no test specified\" && exit 1"
   }
 }