@sigmacomputing/embed-sdk 0.3.3 → 0.4.0

Sign up to get free protection for your applications and to get access to all the features.
package/README.md ADDED
@@ -0,0 +1,247 @@
1
+ ## Getting Started
2
+
3
+ To use the embed-sdk in your project, you can install it using your node package manager.
4
+
5
+ **Using npm:**
6
+
7
+ ```code
8
+ npm install @sigmacomputing/embed-sdk
9
+ ```
10
+
11
+ **yarn:**
12
+
13
+ ```code
14
+ yarn add @sigmacomputing/embed-sdk
15
+ ```
16
+
17
+ **pnpm:**
18
+
19
+ ```code
20
+ pnpm add @sigmacomputing/embed-sdk
21
+ ```
22
+
23
+ ## Documentation
24
+
25
+ ### Listeners
26
+
27
+ These are functions that can be used to listen for events from the embed, and react to them.
28
+
29
+ #### workbookLoadedListener
30
+
31
+ Listen for a workbook loaded event, and execute the given callback when it occurs.
32
+
33
+ ```typescript
34
+ workbookLoadedListener(event: MessageEvent, iframe: HTMLIFrameElement, onLoaded: (event: WorkbookLoadedEvent) => void)
35
+ ```
36
+
37
+ #### workbookErrorListener
38
+
39
+ Listen for a workbook error event, and execute the given callback when it occurs.
40
+
41
+ ```typescript
42
+ workbookErrorListener(event: MessageEvent, iframe: HTMLIFrameElement, onError: (event: WorkbookErrorEvent) => void)
43
+ ```
44
+
45
+ #### workbookVariableChangeListener
46
+
47
+ Listen for a workbook variable change event, and execute the given callback when it occurs.
48
+
49
+ ```typescript
50
+ workbookVariableChangeListener(event: MessageEvent, iframe: HTMLIFrameElement, onVariable: (event: WorkbookVariableOnChangeEvent) => void)
51
+ ```
52
+
53
+ #### workbookVariableCurrentListener
54
+
55
+ Listen for a workbook variable current event, and execute the given callback when it occurs.
56
+
57
+ ```typescript
58
+ workbookVariableCurrentListener(event: MessageEvent, iframe: HTMLIFrameElement, onVariable: (event: WorkbookVariableCurrentEvent) => void)
59
+ ```
60
+
61
+ #### workbookLinkSharingUpdateListener
62
+
63
+ Listen for a workbook sharing link update event, and execute the given callback when it occurs.
64
+
65
+ ```typescript
66
+ workbookLinkSharingUpdateListener(event: MessageEvent, iframe: HTMLIFrameElement, onVariable: (event: WorkbookSharingLinkUpdateEvent) => void)
67
+ ```
68
+
69
+ #### workbookTableCellSelectListener
70
+
71
+ Listen for a table cell select event, and execute the given callback when it occurs.
72
+
73
+ ```typescript
74
+ workbookTableCellSelectListener(event: MessageEvent, iframe: HTMLIFrameElement, onTableCellSelect: (event: WorkbookTableCellSelectEvent) => void)
75
+ ```
76
+
77
+ #### workbookPublishedListener
78
+
79
+ Listen for a workbook published event, and execute the given callback when it occurs.
80
+
81
+ ```typescript
82
+ workbookPublishedListener(event: MessageEvent, iframe: HTMLIFrameElement, onPublished: (event: WorkbookPublishedEvent) => void)
83
+ ```
84
+
85
+ #### workbookFullScreenListener
86
+
87
+ Listen for a workbook full screen event, and execute the given callback when it occurs.
88
+
89
+ ```typescript
90
+ workbookFullScreenListener(event: MessageEvent, iframe: HTMLIFrameElement, onFullScreen: (event: WorkbookFullScreenEvent) => void)
91
+ ```
92
+
93
+ #### workbookPageHeightListener
94
+
95
+ Listen for a workbook page height event, and execute the given callback when it occurs. Needs to be used with the responsive_height [URL Parameter](https://help.sigmacomputing.com/docs/embed-url-parameters).
96
+
97
+ ```typescript
98
+ workbookPageHeightListener(event: MessageEvent, iframe: HTMLIFrameElement, onPageHeight: (event: WorkbookPageHeightEvent) => void)
99
+ ```
100
+
101
+ #### workbookSelectedNodeListener
102
+
103
+ Listen for a workbook selected node event, and execute the given callback when it occurs.
104
+
105
+ ```typescript
106
+ workbookSelectedNodeListener(event: MessageEvent, iframe: HTMLIFrameElement, onPageSelectedNode: (event: WorkbookSelectedNodeEvent) => void)
107
+ ```
108
+
109
+ #### workbookPivotTableCellSelectListener
110
+
111
+ Listen for a pivot table cell select event, and execute the given callback when it occurs.
112
+
113
+ ```typescript
114
+ workbookPivotTableCellSelectListener(event: MessageEvent, iframe: HTMLIFrameElement, onPivotTableCellSelect: (event: WorkbookPivotTableCellSelectEvent) => void)
115
+ ```
116
+
117
+ #### workbookChartValueSelectListener
118
+
119
+ Listen for a chart value select event, and execute the given callback when it occurs.
120
+
121
+ ```typescript
122
+ workbookChartValueSelectListener(event: MessageEvent, iframe: HTMLIFrameElement, onChartValueSelect: (event: WorkbookChartValueSelectEvent) => void)
123
+ ```
124
+
125
+ #### workbookCurrentVariablesListener
126
+
127
+ Listen for a workbook current variables event, and execute the given callback when it occurs. This is to be used when `workbookVariablesList` is called.
128
+
129
+ ```typescript
130
+ workbookCurrentVariablesListener(event: MessageEvent, iframe: HTMLIFrameElement, onCurrentVariables: (event: WorkbookCurrentVariablesEvent) => void)
131
+ ```
132
+
133
+ #### workbookBookmarkCreateListener
134
+
135
+ Listen for a workbook bookmark create event, and execute the given callback when it occurs.
136
+
137
+ ```typescript
138
+ workbookBookmarkCreateListener(event: MessageEvent, iframe: HTMLIFrameElement, onBookmarkCreate: (event: WorkbookBookmarkOnCreateEvent) => void)
139
+ ```
140
+
141
+ #### workbookDataLoadedListener
142
+
143
+ Listen for a workbook data loaded event, and execute the given callback when it occurs.
144
+
145
+ ```typescript
146
+ workbookDataLoadedListener(event: MessageEvent, iframe: HTMLIFrameElement, onWorkbookDataLoaded: (event: WorkbookDataLoadedEvent) => void)
147
+ ```
148
+
149
+ #### workbookChartErrorListener
150
+
151
+ Listen for a workbook chart error event, and execute the given callback when it occurs.
152
+
153
+ ```typescript
154
+ workbookChartErrorListener(event: MessageEvent, iframe: HTMLIFrameElement, onChartError: (event: WorkbookChartErrorEvent) => void)
155
+ ```
156
+
157
+ #### workbookExploreKeyOnChangeListener
158
+
159
+ Listen for a workbook explore key change event, and execute the given callback when it occurs.
160
+
161
+ ```typescript
162
+ workbookExploreKeyOnChangeListener(event: MessageEvent, iframe: HTMLIFrameElement, onExploreKeyOnChange: (event: WorkbookExploreKeyOnChangeEvent) => void)
163
+ ```
164
+
165
+ #### workbookBookmarkOnChangeListener
166
+
167
+ Listen for a workbook bookmark change event, and execute the given callback when it occurs.
168
+
169
+ ```typescript
170
+ workbookBookmarkOnChangeListener(event: MessageEvent, iframe: HTMLIFrameElement, onBookmarkChange: (event: WorkbookBookmarkOnChangeEvent) => void)
171
+ ```
172
+
173
+ #### urlOnChangeListener
174
+
175
+ Listen for a url change event, and execute the given callback when it occurs.
176
+
177
+ ```typescript
178
+ urlOnChangeListener(event: MessageEvent, iframe: HTMLIFrameElement, onUrlChange: (event: UrlOnChangeEvent) => void)
179
+ ```
180
+
181
+ #### workbookIdOnChangeListener
182
+
183
+ Listen for a workbook id change event, and execute the given callback when it occurs.
184
+
185
+ ```typescript
186
+ workbookIdOnChangeListener(event: MessageEvent, iframe: HTMLIFrameElement, onWorkbookIdChange: (event: WorkbookIdOnChangeEvent) => void)
187
+ ```
188
+
189
+ ### Mutations
190
+
191
+ These are functions that can be used to send messages to the embed. They may cause an event to be emitted from the embed.
192
+
193
+ #### workbookVariablesList
194
+
195
+ Send a message to the embed to list the current variables. This will cause a `workbook:variables:current` event to be emitted from the embed, and can be used with the `workbookCurrentVariablesListener` function.
196
+
197
+ ```typescript
198
+ workbookVariablesList(iframe: HTMLIFrameElement)
199
+ ```
200
+
201
+ #### workbookVariablesUpdate
202
+
203
+ Send a message to the embed to update the variables.
204
+
205
+ ```typescript
206
+ workbookVariablesUpdate(iframe: HTMLIFrameElement, variables: Record<string, string>)
207
+ ```
208
+
209
+ #### workbookSharingLinkUpdate
210
+
211
+ Send a message to the embed to update the sharing link.
212
+
213
+ ```typescript
214
+ workbookSharingLinkUpdate(iframe: HTMLIFrameElement, sharingLink: string | null, sharingExplorationLink?: string | null)
215
+ ```
216
+
217
+ #### workbookBookmarkCreate
218
+
219
+ Send a message to the embed to create a bookmark.
220
+
221
+ ```typescript
222
+ workbookBookmarkCreate(iframe: HTMLIFrameElement, bookmark: WorkbookBookmarkCreateEvent)
223
+ ```
224
+
225
+ #### workbookBookmarkUpdate
226
+
227
+ Send a message to the embed to update the current bookmark.
228
+
229
+ ```typescript
230
+ workbookBookmarkUpdate(iframe: HTMLIFrameElement)
231
+ ```
232
+
233
+ #### workbookFullscreenUpdate
234
+
235
+ Send a message to the embed to toggle the fullscreen state of the given element.
236
+
237
+ ```typescript
238
+ workbookFullscreenUpdate(iframe: HTMLIFrameElement, nodeId: string | null)
239
+ ```
240
+
241
+ #### workbookSelectedNodeIdUpdate
242
+
243
+ Send a message to the embed to update the selected element. Can be a pageId or elementId.
244
+
245
+ ```typescript
246
+ workbookSelectedNodeIdUpdate(iframe: HTMLIFrameElement, nodeId: string, nodeType: "element" | "page")
247
+ ```
package/dist/index.d.mts CHANGED
@@ -45,7 +45,7 @@ declare const WorkbookTableCellSelectEventName: "workbook:table:oncellselect";
45
45
  declare const WorkbookPublishedEventName: "workbook:published";
46
46
  declare const WorkbookFullScreenEventName: "workbook:fullscreen:onchange";
47
47
  declare const WorkbookPageHeightEventName: "workbook:pageheight:onchange";
48
- declare const WorkbookPageSelectedNodeEventName: "workbook:selectednodeid:onchange";
48
+ declare const WorkbookSelectedNodeEventName: "workbook:selectednodeid:onchange";
49
49
  declare const WorkbookPivotTableCellSelectEventName: "workbook:pivottable:oncellselect";
50
50
  declare const WorkbookChartValueSelectEventName: "workbook:chart:onvalueselect";
51
51
  declare const WorkbookCurrentVariablesEventName: "workbook:variables:current";
@@ -105,8 +105,8 @@ type WorkbookPageHeightEvent = {
105
105
  type: typeof WorkbookPageHeightEventName;
106
106
  pageHeight: number;
107
107
  };
108
- type WorkbookPageSelectedNodeEvent = {
109
- type: typeof WorkbookPageSelectedNodeEventName;
108
+ type WorkbookSelectedNodeEvent = {
109
+ type: typeof WorkbookSelectedNodeEventName;
110
110
  selectedNodeId: string | null;
111
111
  };
112
112
  type WorkbookPivotTableCellSelectEvent = {
@@ -175,7 +175,7 @@ declare const workbookTableCellSelectListener: (event: MessageEvent, iframe: HTM
175
175
  declare const workbookPublishedListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPublished: (event: WorkbookPublishedEvent) => void) => void;
176
176
  declare const workbookFullScreenListener: (event: MessageEvent, iframe: HTMLIFrameElement, onFullScreen: (event: WorkbookFullScreenEvent) => void) => void;
177
177
  declare const workbookPageHeightListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPageHeight: (event: WorkbookPageHeightEvent) => void) => void;
178
- declare const workbookPageSelectedNodeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPageSelectedNode: (event: WorkbookPageSelectedNodeEvent) => void) => void;
178
+ declare const workbookSelectedNodeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPageSelectedNode: (event: WorkbookSelectedNodeEvent) => void) => void;
179
179
  declare const workbookPivotTableCellSelectListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPivotTableCellSelect: (event: WorkbookPivotTableCellSelectEvent) => void) => void;
180
180
  declare const workbookChartValueSelectListener: (event: MessageEvent, iframe: HTMLIFrameElement, onChartValueSelect: (event: WorkbookChartValueSelectEvent) => void) => void;
181
181
  declare const workbookCurrentVariablesListener: (event: MessageEvent, iframe: HTMLIFrameElement, onCurrentVariables: (event: WorkbookCurrentVariablesEvent) => void) => void;
@@ -195,4 +195,4 @@ declare const workbookVariablesList: (iframe: HTMLIFrameElement) => void;
195
195
  declare const workbookVariablesUpdate: (iframe: HTMLIFrameElement, variables: Record<string, string>) => void;
196
196
  declare const workbookSharingLinkUpdate: (iframe: HTMLIFrameElement, sharingLink: string | null, sharingExplorationLink?: string | null) => void;
197
197
 
198
- 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 };
198
+ 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 WorkbookPivotTableCellSelectEvent, WorkbookPivotTableCellSelectEventName, type WorkbookPublishedEvent, WorkbookPublishedEventName, type WorkbookSelectedNodeEvent, WorkbookSelectedNodeEventName, 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, workbookPivotTableCellSelectListener, workbookPublishedListener, workbookSelectedNodeIdUpdate, workbookSelectedNodeListener, workbookSharingLinkUpdate, workbookTableCellSelectListener, workbookVariableChangeListener, workbookVariableCurrentListener, workbookVariablesList, workbookVariablesUpdate };
package/dist/index.d.ts CHANGED
@@ -45,7 +45,7 @@ declare const WorkbookTableCellSelectEventName: "workbook:table:oncellselect";
45
45
  declare const WorkbookPublishedEventName: "workbook:published";
46
46
  declare const WorkbookFullScreenEventName: "workbook:fullscreen:onchange";
47
47
  declare const WorkbookPageHeightEventName: "workbook:pageheight:onchange";
48
- declare const WorkbookPageSelectedNodeEventName: "workbook:selectednodeid:onchange";
48
+ declare const WorkbookSelectedNodeEventName: "workbook:selectednodeid:onchange";
49
49
  declare const WorkbookPivotTableCellSelectEventName: "workbook:pivottable:oncellselect";
50
50
  declare const WorkbookChartValueSelectEventName: "workbook:chart:onvalueselect";
51
51
  declare const WorkbookCurrentVariablesEventName: "workbook:variables:current";
@@ -105,8 +105,8 @@ type WorkbookPageHeightEvent = {
105
105
  type: typeof WorkbookPageHeightEventName;
106
106
  pageHeight: number;
107
107
  };
108
- type WorkbookPageSelectedNodeEvent = {
109
- type: typeof WorkbookPageSelectedNodeEventName;
108
+ type WorkbookSelectedNodeEvent = {
109
+ type: typeof WorkbookSelectedNodeEventName;
110
110
  selectedNodeId: string | null;
111
111
  };
112
112
  type WorkbookPivotTableCellSelectEvent = {
@@ -175,7 +175,7 @@ declare const workbookTableCellSelectListener: (event: MessageEvent, iframe: HTM
175
175
  declare const workbookPublishedListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPublished: (event: WorkbookPublishedEvent) => void) => void;
176
176
  declare const workbookFullScreenListener: (event: MessageEvent, iframe: HTMLIFrameElement, onFullScreen: (event: WorkbookFullScreenEvent) => void) => void;
177
177
  declare const workbookPageHeightListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPageHeight: (event: WorkbookPageHeightEvent) => void) => void;
178
- declare const workbookPageSelectedNodeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPageSelectedNode: (event: WorkbookPageSelectedNodeEvent) => void) => void;
178
+ declare const workbookSelectedNodeListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPageSelectedNode: (event: WorkbookSelectedNodeEvent) => void) => void;
179
179
  declare const workbookPivotTableCellSelectListener: (event: MessageEvent, iframe: HTMLIFrameElement, onPivotTableCellSelect: (event: WorkbookPivotTableCellSelectEvent) => void) => void;
180
180
  declare const workbookChartValueSelectListener: (event: MessageEvent, iframe: HTMLIFrameElement, onChartValueSelect: (event: WorkbookChartValueSelectEvent) => void) => void;
181
181
  declare const workbookCurrentVariablesListener: (event: MessageEvent, iframe: HTMLIFrameElement, onCurrentVariables: (event: WorkbookCurrentVariablesEvent) => void) => void;
@@ -195,4 +195,4 @@ declare const workbookVariablesList: (iframe: HTMLIFrameElement) => void;
195
195
  declare const workbookVariablesUpdate: (iframe: HTMLIFrameElement, variables: Record<string, string>) => void;
196
196
  declare const workbookSharingLinkUpdate: (iframe: HTMLIFrameElement, sharingLink: string | null, sharingExplorationLink?: string | null) => void;
197
197
 
198
- 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 };
198
+ 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 WorkbookPivotTableCellSelectEvent, WorkbookPivotTableCellSelectEventName, type WorkbookPublishedEvent, WorkbookPublishedEventName, type WorkbookSelectedNodeEvent, WorkbookSelectedNodeEventName, 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, workbookPivotTableCellSelectListener, workbookPublishedListener, workbookSelectedNodeIdUpdate, workbookSelectedNodeListener, workbookSharingLinkUpdate, workbookTableCellSelectListener, workbookVariableChangeListener, workbookVariableCurrentListener, workbookVariablesList, workbookVariablesUpdate };
package/dist/index.js CHANGED
@@ -37,10 +37,10 @@ __export(src_exports, {
37
37
  workbookLinkSharingUpdateListener: () => workbookLinkSharingUpdateListener,
38
38
  workbookLoadedListener: () => workbookLoadedListener,
39
39
  workbookPageHeightListener: () => workbookPageHeightListener,
40
- workbookPageSelectedNodeListener: () => workbookPageSelectedNodeListener,
41
40
  workbookPivotTableCellSelectListener: () => workbookPivotTableCellSelectListener,
42
41
  workbookPublishedListener: () => workbookPublishedListener,
43
42
  workbookSelectedNodeIdUpdate: () => workbookSelectedNodeIdUpdate,
43
+ workbookSelectedNodeListener: () => workbookSelectedNodeListener,
44
44
  workbookSharingLinkUpdate: () => workbookSharingLinkUpdate,
45
45
  workbookTableCellSelectListener: () => workbookTableCellSelectListener,
46
46
  workbookVariableChangeListener: () => workbookVariableChangeListener,
@@ -58,7 +58,7 @@ var WorkbookTableCellSelectEventName = "workbook:table:oncellselect";
58
58
  var WorkbookPublishedEventName = "workbook:published";
59
59
  var WorkbookFullScreenEventName = "workbook:fullscreen:onchange";
60
60
  var WorkbookPageHeightEventName = "workbook:pageheight:onchange";
61
- var WorkbookPageSelectedNodeEventName = "workbook:selectednodeid:onchange";
61
+ var WorkbookSelectedNodeEventName = "workbook:selectednodeid:onchange";
62
62
  var WorkbookPivotTableCellSelectEventName = "workbook:pivottable:oncellselect";
63
63
  var WorkbookChartValueSelectEventName = "workbook:chart:onvalueselect";
64
64
  var WorkbookCurrentVariablesEventName = "workbook:variables:current";
@@ -148,9 +148,9 @@ var workbookPageHeightListener = (event, iframe, onPageHeight) => {
148
148
  }
149
149
  }
150
150
  };
151
- var workbookPageSelectedNodeListener = (event, iframe, onPageSelectedNode) => {
151
+ var workbookSelectedNodeListener = (event, iframe, onPageSelectedNode) => {
152
152
  if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
153
- if (event.data.type === WorkbookPageSelectedNodeEventName) {
153
+ if (event.data.type === WorkbookSelectedNodeEventName) {
154
154
  onPageSelectedNode(event.data);
155
155
  }
156
156
  }
@@ -297,10 +297,10 @@ var workbookSharingLinkUpdate = (iframe, sharingLink, sharingExplorationLink) =>
297
297
  workbookLinkSharingUpdateListener,
298
298
  workbookLoadedListener,
299
299
  workbookPageHeightListener,
300
- workbookPageSelectedNodeListener,
301
300
  workbookPivotTableCellSelectListener,
302
301
  workbookPublishedListener,
303
302
  workbookSelectedNodeIdUpdate,
303
+ workbookSelectedNodeListener,
304
304
  workbookSharingLinkUpdate,
305
305
  workbookTableCellSelectListener,
306
306
  workbookVariableChangeListener,
package/dist/index.mjs CHANGED
@@ -6,7 +6,7 @@ var WorkbookTableCellSelectEventName = "workbook:table:oncellselect";
6
6
  var WorkbookPublishedEventName = "workbook:published";
7
7
  var WorkbookFullScreenEventName = "workbook:fullscreen:onchange";
8
8
  var WorkbookPageHeightEventName = "workbook:pageheight:onchange";
9
- var WorkbookPageSelectedNodeEventName = "workbook:selectednodeid:onchange";
9
+ var WorkbookSelectedNodeEventName = "workbook:selectednodeid:onchange";
10
10
  var WorkbookPivotTableCellSelectEventName = "workbook:pivottable:oncellselect";
11
11
  var WorkbookChartValueSelectEventName = "workbook:chart:onvalueselect";
12
12
  var WorkbookCurrentVariablesEventName = "workbook:variables:current";
@@ -96,9 +96,9 @@ var workbookPageHeightListener = (event, iframe, onPageHeight) => {
96
96
  }
97
97
  }
98
98
  };
99
- var workbookPageSelectedNodeListener = (event, iframe, onPageSelectedNode) => {
99
+ var workbookSelectedNodeListener = (event, iframe, onPageSelectedNode) => {
100
100
  if (event.source === iframe.contentWindow && checkEventOrigin(event.origin)) {
101
- if (event.data.type === WorkbookPageSelectedNodeEventName) {
101
+ if (event.data.type === WorkbookSelectedNodeEventName) {
102
102
  onPageSelectedNode(event.data);
103
103
  }
104
104
  }
@@ -244,10 +244,10 @@ export {
244
244
  workbookLinkSharingUpdateListener,
245
245
  workbookLoadedListener,
246
246
  workbookPageHeightListener,
247
- workbookPageSelectedNodeListener,
248
247
  workbookPivotTableCellSelectListener,
249
248
  workbookPublishedListener,
250
249
  workbookSelectedNodeIdUpdate,
250
+ workbookSelectedNodeListener,
251
251
  workbookSharingLinkUpdate,
252
252
  workbookTableCellSelectListener,
253
253
  workbookVariableChangeListener,
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@sigmacomputing/embed-sdk",
3
3
  "author": "sigmacomputing",
4
- "version": "0.3.3",
4
+ "version": "0.4.0",
5
5
  "description": "JavaScript SDK to interact with Sigma Computing's Embed API",
6
6
  "license": "MIT",
7
7
  "repository": {