@sigmacomputing/react-embed-sdk 0.5.2 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -226,6 +226,30 @@ Listen for a workbook bookmark create event, and execute the given callback when
226
226
  useWorkbookBookmarkOnCreate(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkCreate: (event: WorkbookBookmarkOnCreateEvent) => void)
227
227
  ```
228
228
 
229
+ #### useWorkbookBookmarkOnChange
230
+
231
+ Listen for a workbook bookmark change event, and execute the given callback when it occurs.
232
+
233
+ ```typescript
234
+ useWorkbookBookmarkOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkChange: (event: WorkbookBookmarkOnChangeEvent) => void)
235
+ ```
236
+
237
+ #### useWorkbookBookmarkOnUpdate
238
+
239
+ Listen for a workbook bookmark update event, and execute the given callback when it occurs.
240
+
241
+ ```typescript
242
+ useWorkbookBookmarkOnUpdate(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkUpdate: (event: WorkbookBookmarkOnUpdateEvent) => void)
243
+ ```
244
+
245
+ #### useWorkbookBookmarkOnDelete
246
+
247
+ Listen for a workbook bookmark delete event, and execute the given callback when it occurs.
248
+
249
+ ```typescript
250
+ useWorkbookBookmarkOnDelete(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkDelete: (event: WorkbookBookmarkOnDeleteEvent) => void)
251
+ ```
252
+
229
253
  #### useWorkbookChartError
230
254
 
231
255
  Listen for a workbook chart error event, and execute the given callback when it occurs.
@@ -242,14 +266,6 @@ Listen for a workbook explore key change event, and execute the given callback w
242
266
  useWorkbookExploreKeyOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onExploreKeyOnChange: (event: WorkbookExploreKeyOnChangeEvent) => void)
243
267
  ```
244
268
 
245
- #### useWorkbookBookmarkOnChange
246
-
247
- Listen for a workbook bookmark change event, and execute the given callback when it occurs.
248
-
249
- ```typescript
250
- useWorkbookBookmarkOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkChange: (event: WorkbookBookmarkOnChangeEvent) => void)
251
- ```
252
-
253
269
  #### useUrlOnChange
254
270
 
255
271
  Listen for a url change event, and execute the given callback when it occurs.
@@ -302,6 +318,22 @@ Send a message to the embed to update the current bookmark.
302
318
  updateWorkbookBookmark(iframeRef: React.RefObject<HTMLIFrameElement>)
303
319
  ```
304
320
 
321
+ #### deleteWorkbookBookmark
322
+
323
+ Send a message to the embed to delete the given bookmark.
324
+
325
+ ```typescript
326
+ deleteWorkbookBookmark(iframeRef: React.RefObject<HTMLIFrameElement>, bookmarkId: string)
327
+ ```
328
+
329
+ #### selectWorkbookBookmark
330
+
331
+ Send a message to the embed to select the given bookmark. If no bookmarkId is provided, the current bookmark will be deselected.
332
+
333
+ ```typescript
334
+ selectWorkbookBookmark(iframeRef: React.RefObject<HTMLIFrameElement>, bookmarkId?: string)
335
+ ```
336
+
305
337
  #### updateWorkbookFullscreen
306
338
 
307
339
  Send a message to the embed to toggle the fullscreen state of the given element.
package/dist/index.d.mts CHANGED
@@ -1,5 +1,6 @@
1
- import { WorkbookErrorEvent, WorkbookLoadedEvent, WorkbookDataLoadedEvent, WorkbookVariableOnChangeEvent, WorkbookTableCellSelectEvent, WorkbookPublishedEvent, WorkbookFullScreenEvent, WorkbookPageHeightEvent, WorkbookSelectedNodeEvent, WorkbookPivotTableCellSelectEvent, WorkbookChartValueSelectEvent, WorkbookCurrentVariablesEvent, WorkbookBookmarkOnCreateEvent, WorkbookChartErrorEvent, WorkbookExploreKeyOnChangeEvent, WorkbookBookmarkOnChangeEvent, UrlOnChangeEvent, WorkbookIdOnChangeEvent, ActionOutboundEvent, WorkbookBookmarkCreateEvent } from '@sigmacomputing/embed-sdk';
1
+ import { WorkbookErrorEvent, WorkbookLoadedEvent, WorkbookDataLoadedEvent, WorkbookVariableOnChangeEvent, WorkbookTableCellSelectEvent, WorkbookPublishedEvent, WorkbookFullScreenEvent, WorkbookPageHeightEvent, WorkbookSelectedNodeEvent, WorkbookPivotTableCellSelectEvent, WorkbookChartValueSelectEvent, WorkbookCurrentVariablesEvent, WorkbookBookmarkOnCreateEvent, WorkbookBookmarkOnChangeEvent, WorkbookBookmarkOnUpdateEvent, WorkbookBookmarkOnDeleteEvent, WorkbookChartErrorEvent, WorkbookExploreKeyOnChangeEvent, UrlOnChangeEvent, WorkbookIdOnChangeEvent, ActionOutboundEvent, WorkbookBookmarkCreateEvent } from '@sigmacomputing/embed-sdk';
2
2
  export * from '@sigmacomputing/embed-sdk';
3
+ export { DO_NOT_USE_IN_PRODUCTION_overrideMutationUrl } from '@sigmacomputing/embed-sdk';
3
4
 
4
5
  /**
5
6
  * A hook that returns a ref to be used with an iframe element, and the loading and error state of the embed.
@@ -151,9 +152,11 @@ declare function useWorkbookPivotTableCellSelect(iframeRef: React.RefObject<HTML
151
152
  declare function useWorkbookChartValueSelect(iframeRef: React.RefObject<HTMLIFrameElement>, onChartValueSelect: (event: WorkbookChartValueSelectEvent) => void): void;
152
153
  declare function useWorkbookCurrentVariables(iframeRef: React.RefObject<HTMLIFrameElement>, onCurrentVariables: (event: WorkbookCurrentVariablesEvent) => void): void;
153
154
  declare function useWorkbookBookmarkOnCreate(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkCreate: (event: WorkbookBookmarkOnCreateEvent) => void): void;
155
+ declare function useWorkbookBookmarkOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkChange: (event: WorkbookBookmarkOnChangeEvent) => void): void;
156
+ declare function useWorkbookBookmarkOnUpdate(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkUpdate: (event: WorkbookBookmarkOnUpdateEvent) => void): void;
157
+ declare function useWorkbookBookmarkOnDelete(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkDelete: (event: WorkbookBookmarkOnDeleteEvent) => void): void;
154
158
  declare function useWorkbookChartError(iframeRef: React.RefObject<HTMLIFrameElement>, onChartError: (event: WorkbookChartErrorEvent) => void): void;
155
159
  declare function useWorkbookExploreKeyOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onExploreKeyChange: (event: WorkbookExploreKeyOnChangeEvent) => void): void;
156
- declare function useWorkbookBookmarkOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkChange: (event: WorkbookBookmarkOnChangeEvent) => void): void;
157
160
  declare function useUrlOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onUrlChange: (event: UrlOnChangeEvent) => void): void;
158
161
  declare function useWorkbookIdOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onIdChange: (event: WorkbookIdOnChangeEvent) => void): void;
159
162
  /**
@@ -171,8 +174,10 @@ declare function getWorkbookVariables(iframeRef: React.RefObject<HTMLIFrameEleme
171
174
  declare function updateWorkbookVariables(iframeRef: React.RefObject<HTMLIFrameElement>, variables: Record<string, string>): void;
172
175
  declare function createWorkbookBookmark(iframeRef: React.RefObject<HTMLIFrameElement>, bookmark: WorkbookBookmarkCreateEvent): void;
173
176
  declare function updateWorkbookBookmark(iframeRef: React.RefObject<HTMLIFrameElement>): void;
177
+ declare function deleteWorkbookBookmark(iframeRef: React.RefObject<HTMLIFrameElement>, bookmarkId: string): void;
178
+ declare function selectWorkbookBookmark(iframeRef: React.RefObject<HTMLIFrameElement>, bookmarkId?: string): void;
174
179
  declare function updateWorkbookFullscreen(iframeRef: React.RefObject<HTMLIFrameElement>, nodeId: string | null): void;
175
180
  declare function updateWorkbookSelectedNodeId(iframeRef: React.RefObject<HTMLIFrameElement>, nodeId: string, nodeType: "element" | "page"): void;
176
181
  declare function updateWorkbookSharingLink(iframeRef: React.RefObject<HTMLIFrameElement>, sharingLink: string | null, sharingExplorationLink?: string | null): void;
177
182
 
178
- export { createWorkbookBookmark, getWorkbookVariables, updateWorkbookBookmark, updateWorkbookFullscreen, updateWorkbookSelectedNodeId, updateWorkbookSharingLink, updateWorkbookVariables, useActionOutbound, usePageHeight, useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPivotTableCellSelect, useWorkbookPublished, useWorkbookSelectedNode, useWorkbookVariables };
183
+ export { createWorkbookBookmark, deleteWorkbookBookmark, getWorkbookVariables, selectWorkbookBookmark, updateWorkbookBookmark, updateWorkbookFullscreen, updateWorkbookSelectedNodeId, updateWorkbookSharingLink, updateWorkbookVariables, useActionOutbound, usePageHeight, useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookBookmarkOnDelete, useWorkbookBookmarkOnUpdate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPivotTableCellSelect, useWorkbookPublished, useWorkbookSelectedNode, useWorkbookVariables };
package/dist/index.d.ts CHANGED
@@ -1,5 +1,6 @@
1
- import { WorkbookErrorEvent, WorkbookLoadedEvent, WorkbookDataLoadedEvent, WorkbookVariableOnChangeEvent, WorkbookTableCellSelectEvent, WorkbookPublishedEvent, WorkbookFullScreenEvent, WorkbookPageHeightEvent, WorkbookSelectedNodeEvent, WorkbookPivotTableCellSelectEvent, WorkbookChartValueSelectEvent, WorkbookCurrentVariablesEvent, WorkbookBookmarkOnCreateEvent, WorkbookChartErrorEvent, WorkbookExploreKeyOnChangeEvent, WorkbookBookmarkOnChangeEvent, UrlOnChangeEvent, WorkbookIdOnChangeEvent, ActionOutboundEvent, WorkbookBookmarkCreateEvent } from '@sigmacomputing/embed-sdk';
1
+ import { WorkbookErrorEvent, WorkbookLoadedEvent, WorkbookDataLoadedEvent, WorkbookVariableOnChangeEvent, WorkbookTableCellSelectEvent, WorkbookPublishedEvent, WorkbookFullScreenEvent, WorkbookPageHeightEvent, WorkbookSelectedNodeEvent, WorkbookPivotTableCellSelectEvent, WorkbookChartValueSelectEvent, WorkbookCurrentVariablesEvent, WorkbookBookmarkOnCreateEvent, WorkbookBookmarkOnChangeEvent, WorkbookBookmarkOnUpdateEvent, WorkbookBookmarkOnDeleteEvent, WorkbookChartErrorEvent, WorkbookExploreKeyOnChangeEvent, UrlOnChangeEvent, WorkbookIdOnChangeEvent, ActionOutboundEvent, WorkbookBookmarkCreateEvent } from '@sigmacomputing/embed-sdk';
2
2
  export * from '@sigmacomputing/embed-sdk';
3
+ export { DO_NOT_USE_IN_PRODUCTION_overrideMutationUrl } from '@sigmacomputing/embed-sdk';
3
4
 
4
5
  /**
5
6
  * A hook that returns a ref to be used with an iframe element, and the loading and error state of the embed.
@@ -151,9 +152,11 @@ declare function useWorkbookPivotTableCellSelect(iframeRef: React.RefObject<HTML
151
152
  declare function useWorkbookChartValueSelect(iframeRef: React.RefObject<HTMLIFrameElement>, onChartValueSelect: (event: WorkbookChartValueSelectEvent) => void): void;
152
153
  declare function useWorkbookCurrentVariables(iframeRef: React.RefObject<HTMLIFrameElement>, onCurrentVariables: (event: WorkbookCurrentVariablesEvent) => void): void;
153
154
  declare function useWorkbookBookmarkOnCreate(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkCreate: (event: WorkbookBookmarkOnCreateEvent) => void): void;
155
+ declare function useWorkbookBookmarkOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkChange: (event: WorkbookBookmarkOnChangeEvent) => void): void;
156
+ declare function useWorkbookBookmarkOnUpdate(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkUpdate: (event: WorkbookBookmarkOnUpdateEvent) => void): void;
157
+ declare function useWorkbookBookmarkOnDelete(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkDelete: (event: WorkbookBookmarkOnDeleteEvent) => void): void;
154
158
  declare function useWorkbookChartError(iframeRef: React.RefObject<HTMLIFrameElement>, onChartError: (event: WorkbookChartErrorEvent) => void): void;
155
159
  declare function useWorkbookExploreKeyOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onExploreKeyChange: (event: WorkbookExploreKeyOnChangeEvent) => void): void;
156
- declare function useWorkbookBookmarkOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onBookmarkChange: (event: WorkbookBookmarkOnChangeEvent) => void): void;
157
160
  declare function useUrlOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onUrlChange: (event: UrlOnChangeEvent) => void): void;
158
161
  declare function useWorkbookIdOnChange(iframeRef: React.RefObject<HTMLIFrameElement>, onIdChange: (event: WorkbookIdOnChangeEvent) => void): void;
159
162
  /**
@@ -171,8 +174,10 @@ declare function getWorkbookVariables(iframeRef: React.RefObject<HTMLIFrameEleme
171
174
  declare function updateWorkbookVariables(iframeRef: React.RefObject<HTMLIFrameElement>, variables: Record<string, string>): void;
172
175
  declare function createWorkbookBookmark(iframeRef: React.RefObject<HTMLIFrameElement>, bookmark: WorkbookBookmarkCreateEvent): void;
173
176
  declare function updateWorkbookBookmark(iframeRef: React.RefObject<HTMLIFrameElement>): void;
177
+ declare function deleteWorkbookBookmark(iframeRef: React.RefObject<HTMLIFrameElement>, bookmarkId: string): void;
178
+ declare function selectWorkbookBookmark(iframeRef: React.RefObject<HTMLIFrameElement>, bookmarkId?: string): void;
174
179
  declare function updateWorkbookFullscreen(iframeRef: React.RefObject<HTMLIFrameElement>, nodeId: string | null): void;
175
180
  declare function updateWorkbookSelectedNodeId(iframeRef: React.RefObject<HTMLIFrameElement>, nodeId: string, nodeType: "element" | "page"): void;
176
181
  declare function updateWorkbookSharingLink(iframeRef: React.RefObject<HTMLIFrameElement>, sharingLink: string | null, sharingExplorationLink?: string | null): void;
177
182
 
178
- export { createWorkbookBookmark, getWorkbookVariables, updateWorkbookBookmark, updateWorkbookFullscreen, updateWorkbookSelectedNodeId, updateWorkbookSharingLink, updateWorkbookVariables, useActionOutbound, usePageHeight, useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPivotTableCellSelect, useWorkbookPublished, useWorkbookSelectedNode, useWorkbookVariables };
183
+ export { createWorkbookBookmark, deleteWorkbookBookmark, getWorkbookVariables, selectWorkbookBookmark, updateWorkbookBookmark, updateWorkbookFullscreen, updateWorkbookSelectedNodeId, updateWorkbookSharingLink, updateWorkbookVariables, useActionOutbound, usePageHeight, useSigmaIframe, useTableCellSelect, useUrlOnChange, useVariableChange, useWorkbookBookmarkOnChange, useWorkbookBookmarkOnCreate, useWorkbookBookmarkOnDelete, useWorkbookBookmarkOnUpdate, useWorkbookChartError, useWorkbookChartValueSelect, useWorkbookCurrentVariables, useWorkbookDataLoaded, useWorkbookError, useWorkbookExploreKeyOnChange, useWorkbookFullScreen, useWorkbookIdOnChange, useWorkbookLoaded, useWorkbookPageHeight, useWorkbookPivotTableCellSelect, useWorkbookPublished, useWorkbookSelectedNode, useWorkbookVariables };
package/dist/index.js CHANGED
@@ -20,8 +20,11 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
20
20
  // src/index.ts
21
21
  var src_exports = {};
22
22
  __export(src_exports, {
23
+ DO_NOT_USE_IN_PRODUCTION_overrideMutationUrl: () => import_embed_sdk4.DO_NOT_USE_IN_PRODUCTION_overrideMutationUrl,
23
24
  createWorkbookBookmark: () => createWorkbookBookmark,
25
+ deleteWorkbookBookmark: () => deleteWorkbookBookmark,
24
26
  getWorkbookVariables: () => getWorkbookVariables,
27
+ selectWorkbookBookmark: () => selectWorkbookBookmark,
25
28
  updateWorkbookBookmark: () => updateWorkbookBookmark,
26
29
  updateWorkbookFullscreen: () => updateWorkbookFullscreen,
27
30
  updateWorkbookSelectedNodeId: () => updateWorkbookSelectedNodeId,
@@ -35,6 +38,8 @@ __export(src_exports, {
35
38
  useVariableChange: () => useVariableChange,
36
39
  useWorkbookBookmarkOnChange: () => useWorkbookBookmarkOnChange,
37
40
  useWorkbookBookmarkOnCreate: () => useWorkbookBookmarkOnCreate,
41
+ useWorkbookBookmarkOnDelete: () => useWorkbookBookmarkOnDelete,
42
+ useWorkbookBookmarkOnUpdate: () => useWorkbookBookmarkOnUpdate,
38
43
  useWorkbookChartError: () => useWorkbookChartError,
39
44
  useWorkbookChartValueSelect: () => useWorkbookChartValueSelect,
40
45
  useWorkbookCurrentVariables: () => useWorkbookCurrentVariables,
@@ -242,49 +247,81 @@ function useWorkbookBookmarkOnCreate(iframeRef, onBookmarkCreate) {
242
247
  return () => window.removeEventListener("message", listener);
243
248
  }, [iframeRef, onBookmarkCreate]);
244
249
  }
245
- function useWorkbookChartError(iframeRef, onChartError) {
250
+ function useWorkbookBookmarkOnChange(iframeRef, onBookmarkChange) {
246
251
  (0, import_react.useEffect)(() => {
247
252
  const listener = (event) => {
248
253
  if (!iframeRef.current) {
249
254
  return;
250
255
  }
251
- (0, import_embed_sdk.workbookChartErrorListener)(event, iframeRef.current, onChartError);
256
+ (0, import_embed_sdk.workbookBookmarkOnChangeListener)(
257
+ event,
258
+ iframeRef.current,
259
+ onBookmarkChange
260
+ );
252
261
  };
253
262
  window.addEventListener("message", listener);
254
263
  return () => window.removeEventListener("message", listener);
255
- }, [iframeRef, onChartError]);
264
+ }, [iframeRef, onBookmarkChange]);
256
265
  }
257
- function useWorkbookExploreKeyOnChange(iframeRef, onExploreKeyChange) {
266
+ function useWorkbookBookmarkOnUpdate(iframeRef, onBookmarkUpdate) {
258
267
  (0, import_react.useEffect)(() => {
259
268
  const listener = (event) => {
260
269
  if (!iframeRef.current) {
261
270
  return;
262
271
  }
263
- (0, import_embed_sdk.workbookExploreKeyOnChangeListener)(
272
+ (0, import_embed_sdk.workbookBookmarkOnUpdateListener)(
264
273
  event,
265
274
  iframeRef.current,
266
- onExploreKeyChange
275
+ onBookmarkUpdate
267
276
  );
268
277
  };
269
278
  window.addEventListener("message", listener);
270
279
  return () => window.removeEventListener("message", listener);
271
- }, [iframeRef, onExploreKeyChange]);
280
+ }, [iframeRef, onBookmarkUpdate]);
272
281
  }
273
- function useWorkbookBookmarkOnChange(iframeRef, onBookmarkChange) {
282
+ function useWorkbookBookmarkOnDelete(iframeRef, onBookmarkDelete) {
274
283
  (0, import_react.useEffect)(() => {
275
284
  const listener = (event) => {
276
285
  if (!iframeRef.current) {
277
286
  return;
278
287
  }
279
- (0, import_embed_sdk.workbookBookmarkOnChangeListener)(
288
+ (0, import_embed_sdk.workbookBookmarkOnDeleteListener)(
280
289
  event,
281
290
  iframeRef.current,
282
- onBookmarkChange
291
+ onBookmarkDelete
283
292
  );
284
293
  };
285
294
  window.addEventListener("message", listener);
286
295
  return () => window.removeEventListener("message", listener);
287
- }, [iframeRef, onBookmarkChange]);
296
+ }, [iframeRef, onBookmarkDelete]);
297
+ }
298
+ function useWorkbookChartError(iframeRef, onChartError) {
299
+ (0, import_react.useEffect)(() => {
300
+ const listener = (event) => {
301
+ if (!iframeRef.current) {
302
+ return;
303
+ }
304
+ (0, import_embed_sdk.workbookChartErrorListener)(event, iframeRef.current, onChartError);
305
+ };
306
+ window.addEventListener("message", listener);
307
+ return () => window.removeEventListener("message", listener);
308
+ }, [iframeRef, onChartError]);
309
+ }
310
+ function useWorkbookExploreKeyOnChange(iframeRef, onExploreKeyChange) {
311
+ (0, import_react.useEffect)(() => {
312
+ const listener = (event) => {
313
+ if (!iframeRef.current) {
314
+ return;
315
+ }
316
+ (0, import_embed_sdk.workbookExploreKeyOnChangeListener)(
317
+ event,
318
+ iframeRef.current,
319
+ onExploreKeyChange
320
+ );
321
+ };
322
+ window.addEventListener("message", listener);
323
+ return () => window.removeEventListener("message", listener);
324
+ }, [iframeRef, onExploreKeyChange]);
288
325
  }
289
326
  function useUrlOnChange(iframeRef, onUrlChange) {
290
327
  (0, import_react.useEffect)(() => {
@@ -403,6 +440,7 @@ var useWorkbookVariables = (iframeRef) => {
403
440
 
404
441
  // src/mutations.ts
405
442
  var import_embed_sdk3 = require("@sigmacomputing/embed-sdk");
443
+ var import_embed_sdk4 = require("@sigmacomputing/embed-sdk");
406
444
  function getWorkbookVariables(iframeRef) {
407
445
  if (!iframeRef.current) {
408
446
  throw new Error("iframe is not available");
@@ -427,6 +465,18 @@ function updateWorkbookBookmark(iframeRef) {
427
465
  }
428
466
  (0, import_embed_sdk3.workbookBookmarkUpdate)(iframeRef.current);
429
467
  }
468
+ function deleteWorkbookBookmark(iframeRef, bookmarkId) {
469
+ if (!iframeRef.current) {
470
+ throw new Error("iframe is not available");
471
+ }
472
+ (0, import_embed_sdk3.workbookBookmarkDelete)(iframeRef.current, bookmarkId);
473
+ }
474
+ function selectWorkbookBookmark(iframeRef, bookmarkId) {
475
+ if (!iframeRef.current) {
476
+ throw new Error("iframe is not available");
477
+ }
478
+ (0, import_embed_sdk3.workbookBookmarkSelect)(iframeRef.current, bookmarkId);
479
+ }
430
480
  function updateWorkbookFullscreen(iframeRef, nodeId) {
431
481
  if (!iframeRef.current) {
432
482
  throw new Error("iframe is not available");
@@ -451,8 +501,11 @@ function updateWorkbookSharingLink(iframeRef, sharingLink, sharingExplorationLin
451
501
  }
452
502
  // Annotate the CommonJS export names for ESM import in node:
453
503
  0 && (module.exports = {
504
+ DO_NOT_USE_IN_PRODUCTION_overrideMutationUrl,
454
505
  createWorkbookBookmark,
506
+ deleteWorkbookBookmark,
455
507
  getWorkbookVariables,
508
+ selectWorkbookBookmark,
456
509
  updateWorkbookBookmark,
457
510
  updateWorkbookFullscreen,
458
511
  updateWorkbookSelectedNodeId,
@@ -466,6 +519,8 @@ function updateWorkbookSharingLink(iframeRef, sharingLink, sharingExplorationLin
466
519
  useVariableChange,
467
520
  useWorkbookBookmarkOnChange,
468
521
  useWorkbookBookmarkOnCreate,
522
+ useWorkbookBookmarkOnDelete,
523
+ useWorkbookBookmarkOnUpdate,
469
524
  useWorkbookChartError,
470
525
  useWorkbookChartValueSelect,
471
526
  useWorkbookCurrentVariables,
package/dist/index.mjs CHANGED
@@ -21,7 +21,9 @@ import {
21
21
  workbookBookmarkOnChangeListener,
22
22
  urlOnChangeListener,
23
23
  workbookIdOnChangeListener,
24
- actionOutboundListener
24
+ actionOutboundListener,
25
+ workbookBookmarkOnUpdateListener,
26
+ workbookBookmarkOnDeleteListener
25
27
  } from "@sigmacomputing/embed-sdk";
26
28
  import { useEffect } from "react";
27
29
  function useWorkbookLoaded(iframeRef, onLoaded) {
@@ -208,49 +210,81 @@ function useWorkbookBookmarkOnCreate(iframeRef, onBookmarkCreate) {
208
210
  return () => window.removeEventListener("message", listener);
209
211
  }, [iframeRef, onBookmarkCreate]);
210
212
  }
211
- function useWorkbookChartError(iframeRef, onChartError) {
213
+ function useWorkbookBookmarkOnChange(iframeRef, onBookmarkChange) {
212
214
  useEffect(() => {
213
215
  const listener = (event) => {
214
216
  if (!iframeRef.current) {
215
217
  return;
216
218
  }
217
- workbookChartErrorListener(event, iframeRef.current, onChartError);
219
+ workbookBookmarkOnChangeListener(
220
+ event,
221
+ iframeRef.current,
222
+ onBookmarkChange
223
+ );
218
224
  };
219
225
  window.addEventListener("message", listener);
220
226
  return () => window.removeEventListener("message", listener);
221
- }, [iframeRef, onChartError]);
227
+ }, [iframeRef, onBookmarkChange]);
222
228
  }
223
- function useWorkbookExploreKeyOnChange(iframeRef, onExploreKeyChange) {
229
+ function useWorkbookBookmarkOnUpdate(iframeRef, onBookmarkUpdate) {
224
230
  useEffect(() => {
225
231
  const listener = (event) => {
226
232
  if (!iframeRef.current) {
227
233
  return;
228
234
  }
229
- workbookExploreKeyOnChangeListener(
235
+ workbookBookmarkOnUpdateListener(
230
236
  event,
231
237
  iframeRef.current,
232
- onExploreKeyChange
238
+ onBookmarkUpdate
233
239
  );
234
240
  };
235
241
  window.addEventListener("message", listener);
236
242
  return () => window.removeEventListener("message", listener);
237
- }, [iframeRef, onExploreKeyChange]);
243
+ }, [iframeRef, onBookmarkUpdate]);
238
244
  }
239
- function useWorkbookBookmarkOnChange(iframeRef, onBookmarkChange) {
245
+ function useWorkbookBookmarkOnDelete(iframeRef, onBookmarkDelete) {
240
246
  useEffect(() => {
241
247
  const listener = (event) => {
242
248
  if (!iframeRef.current) {
243
249
  return;
244
250
  }
245
- workbookBookmarkOnChangeListener(
251
+ workbookBookmarkOnDeleteListener(
246
252
  event,
247
253
  iframeRef.current,
248
- onBookmarkChange
254
+ onBookmarkDelete
249
255
  );
250
256
  };
251
257
  window.addEventListener("message", listener);
252
258
  return () => window.removeEventListener("message", listener);
253
- }, [iframeRef, onBookmarkChange]);
259
+ }, [iframeRef, onBookmarkDelete]);
260
+ }
261
+ function useWorkbookChartError(iframeRef, onChartError) {
262
+ useEffect(() => {
263
+ const listener = (event) => {
264
+ if (!iframeRef.current) {
265
+ return;
266
+ }
267
+ workbookChartErrorListener(event, iframeRef.current, onChartError);
268
+ };
269
+ window.addEventListener("message", listener);
270
+ return () => window.removeEventListener("message", listener);
271
+ }, [iframeRef, onChartError]);
272
+ }
273
+ function useWorkbookExploreKeyOnChange(iframeRef, onExploreKeyChange) {
274
+ useEffect(() => {
275
+ const listener = (event) => {
276
+ if (!iframeRef.current) {
277
+ return;
278
+ }
279
+ workbookExploreKeyOnChangeListener(
280
+ event,
281
+ iframeRef.current,
282
+ onExploreKeyChange
283
+ );
284
+ };
285
+ window.addEventListener("message", listener);
286
+ return () => window.removeEventListener("message", listener);
287
+ }, [iframeRef, onExploreKeyChange]);
254
288
  }
255
289
  function useUrlOnChange(iframeRef, onUrlChange) {
256
290
  useEffect(() => {
@@ -379,8 +413,11 @@ import {
379
413
  workbookBookmarkUpdate,
380
414
  workbookFullscreenUpdate,
381
415
  workbookSelectedNodeIdUpdate,
382
- workbookSharingLinkUpdate
416
+ workbookSharingLinkUpdate,
417
+ workbookBookmarkDelete,
418
+ workbookBookmarkSelect
383
419
  } from "@sigmacomputing/embed-sdk";
420
+ import { DO_NOT_USE_IN_PRODUCTION_overrideMutationUrl } from "@sigmacomputing/embed-sdk";
384
421
  function getWorkbookVariables(iframeRef) {
385
422
  if (!iframeRef.current) {
386
423
  throw new Error("iframe is not available");
@@ -405,6 +442,18 @@ function updateWorkbookBookmark(iframeRef) {
405
442
  }
406
443
  workbookBookmarkUpdate(iframeRef.current);
407
444
  }
445
+ function deleteWorkbookBookmark(iframeRef, bookmarkId) {
446
+ if (!iframeRef.current) {
447
+ throw new Error("iframe is not available");
448
+ }
449
+ workbookBookmarkDelete(iframeRef.current, bookmarkId);
450
+ }
451
+ function selectWorkbookBookmark(iframeRef, bookmarkId) {
452
+ if (!iframeRef.current) {
453
+ throw new Error("iframe is not available");
454
+ }
455
+ workbookBookmarkSelect(iframeRef.current, bookmarkId);
456
+ }
408
457
  function updateWorkbookFullscreen(iframeRef, nodeId) {
409
458
  if (!iframeRef.current) {
410
459
  throw new Error("iframe is not available");
@@ -428,8 +477,11 @@ function updateWorkbookSharingLink(iframeRef, sharingLink, sharingExplorationLin
428
477
  );
429
478
  }
430
479
  export {
480
+ DO_NOT_USE_IN_PRODUCTION_overrideMutationUrl,
431
481
  createWorkbookBookmark,
482
+ deleteWorkbookBookmark,
432
483
  getWorkbookVariables,
484
+ selectWorkbookBookmark,
433
485
  updateWorkbookBookmark,
434
486
  updateWorkbookFullscreen,
435
487
  updateWorkbookSelectedNodeId,
@@ -443,6 +495,8 @@ export {
443
495
  useVariableChange,
444
496
  useWorkbookBookmarkOnChange,
445
497
  useWorkbookBookmarkOnCreate,
498
+ useWorkbookBookmarkOnDelete,
499
+ useWorkbookBookmarkOnUpdate,
446
500
  useWorkbookChartError,
447
501
  useWorkbookChartValueSelect,
448
502
  useWorkbookCurrentVariables,
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@sigmacomputing/react-embed-sdk",
3
3
  "author": "sigmacomputing",
4
- "version": "0.5.2",
4
+ "version": "0.7.0",
5
5
  "description": "React JavaScript SDK to interact with Sigma Computing's Embed API",
6
6
  "license": "MIT",
7
7
  "repository": {
@@ -19,27 +19,35 @@
19
19
  "sigma",
20
20
  "react"
21
21
  ],
22
+ "main": "./dist/index.js",
23
+ "module": "./dist/index.mjs",
24
+ "types": "./dist/index.d.ts",
22
25
  "exports": {
23
- "import": "./dist/index.mjs",
24
- "require": "./dist/index.js",
25
- "types": "./dist/index.d.ts"
26
+ "import": {
27
+ "import": "./dist/index.mjs",
28
+ "types": "./dist/index.d.mts"
29
+ },
30
+ "require": {
31
+ "require": "./dist/index.js",
32
+ "types": "./dist/index.d.ts"
33
+ }
26
34
  },
27
35
  "files": [
28
36
  "dist"
29
37
  ],
30
38
  "peerDependencies": {
31
- "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0",
32
- "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0"
39
+ "react": "^16.8.0 || ^17.0 || ^18.0 || ^19.0 || 19.0.0-rc",
40
+ "react-dom": "^16.8.0 || ^17.0 || ^18.0 || ^19.0 || 19.0.0-rc"
33
41
  },
34
42
  "devDependencies": {
35
- "@types/react": "^18.3.3",
43
+ "@types/react": "^18.3.18",
36
44
  "react": "^18.3.1",
37
45
  "react-dom": "^18.3.1",
38
46
  "@sigmacomputing/eslint-config": "0.0.0",
39
47
  "@sigmacomputing/typescript-config": "0.0.0"
40
48
  },
41
49
  "dependencies": {
42
- "@sigmacomputing/embed-sdk": "0.5.0"
50
+ "@sigmacomputing/embed-sdk": "0.7.0"
43
51
  },
44
52
  "scripts": {
45
53
  "prepublish": "turbo run build",