@sigmacomputing/plugin 1.0.6-beta → 1.0.6

package/README.md

@@ -159,8 +159,8 @@ Before you start:
 #### CustomPluginConfigOptions
 
 A plugin can be configured with any number of configuration fields. Each field
-type has its own configuration options. Each field type is also garunteed to
-have a the following options:
+type has its own configuration options. Each field type is also guaranteed to
+have the following options:
 
 - `name : string` - the name of the field
 - `type : string` - the field type
@@ -252,6 +252,11 @@ type CustomPluginConfigOptions =
       type: 'action-trigger';
       name: string;
       label?: string;
+    }
+  | {
+      type: 'action-effect';
+      name: string;
+      label?: string;
     };
 ```
 
@@ -385,6 +390,10 @@ A configurable workbook interaction to interact with other charts within your wo
 
 A configurable action trigger to trigger actions in other elements within your workbook
 
+**Action Effect**
+
+A configurable action effect that can be triggered by other elements within your workbook
+
 #### PluginInstance
 
 ```ts
@@ -425,31 +434,36 @@ interface PluginInstance<T> {
     /**
      * Gets a static image of a workbook variable
      */
-    getVariable(id: string): WorkbookVariable;
+    getVariable(configId: string): WorkbookVariable;
 
     /**
      * Setter for workbook variable passed in
      */
-    setVariable(id: string, ...values: unknown[]): void;
+    setVariable(configId: string, ...values: unknown[]): void;
 
     /**
      * Getter for interaction selection state
      */
-    getInteraction(id: string): WorkbookSelection[];
+    getInteraction(configId: string): WorkbookSelection[];
 
     /**
      * Setter for interaction selection state
      */
     setInteraction(
-      id: string,
+      configId: string,
       elementId: string,
       selection: WorkbookSelection[],
     ): void;
 
     /**
-     * Triggers an action based on the provided action trigger Id
+     * Triggers an action based on the provided action trigger ID
+     */
+    triggerAction(configId: string): void;
+
+    /**
+     * Registers an effect with the provided action effect ID
      */
-    triggerAction(id: string): void;
+    registerEffect(configId: string, effect: Function): void;
 
     /**
      * Overrider function for Config Ready state
@@ -460,15 +474,16 @@ interface PluginInstance<T> {
      * Allows users to subscribe to changes in the passed in variable
      */
     subscribeToWorkbookVariable(
-      id: string,
+      configId: string,
       callback: (input: WorkbookVariable) => void,
     ): Unsubscriber;
 
     /**
+     * @deprecated Use Action API instead
      * Allows users to subscribe to changes in the passed in interaction ID
      */
     subscribeToWorkbookInteraction(
-      id: string,
+      configId: string,
       callback: (input: WorkbookSelection[]) => void,
     ): Unsubscriber;
   };
@@ -477,13 +492,13 @@ interface PluginInstance<T> {
     /**
      * Getter for Column Data by parent sheet ID
      */
-    getElementColumns(id: string): Promise<WbElementColumns>;
+    getElementColumns(configId: string): Promise<WbElementColumns>;
 
     /**
      * Subscriber to changes in column data by ID
      */
     subscribeToElementColumns(
-      id: string,
+      configId: string,
       callback: (cols: WbElementColumns) => void,
     ): Unsubscriber;
 
@@ -491,7 +506,7 @@ interface PluginInstance<T> {
      * Subscriber for the data within a given sheet
      */
     subscribeToElementData(
-      id: string,
+      configId: string,
       callback: (data: WbElementData) => void,
     ): Unsubscriber;
   };
@@ -629,15 +644,15 @@ interface WorkbookElementColumns {
 
 #### useElementData()
 
-Provides the latest data values from corresponding sheet
+Provides the latest data values from corresponding sheet, up to 25000 values.
 
 ```ts
-function useElementData(elementId: string): WorkbookElementData;
+function useElementData(configId: string): WorkbookElementData;
 ```
 
 Arguments
 
-- `elementId : string` - A workbook element’s unique identifier.
+- `configId : string` - A workbook element’s unique identifier from the plugin config.
 
 Returns the row data from the specified element.
 
@@ -647,19 +662,41 @@ interface WorkbookElementData {
 }
 ```
 
+#### usePaginatedElementData()
+
+Provides the latest data values from the corresponding sheet (initially 25000), and provides a
+callback for fetching more data in chunks of 25000 values.
+
+```ts
+function useElementData(configId: string): [WorkbookElementData, () => void];
+```
+
+Arguments
+
+- `configId : string` - A workbook element’s unique identifier from the plugin config.
+
+Returns the row data from the specified element, and a callback for fetching
+more data.
+
+```ts
+interface WorkbookElementData {
+  [colId: string]: any[];
+}
+```
+
 #### useVariable()
 
 Returns a given variable's value and a setter to update that variable
 
 ```ts
 function useVariable(
-  variableId: string,
+  configId: string,
 ): [WorkbookVariable | undefined, (...values: unknown[]) => void];
 ```
 
 Arguments
 
-- `variableId : string` - The ID of the variable
+- `configId : string` - The config ID corresponding to the workbook control variable
 
 The returned setter function accepts 1 or more variable values expressed as an
 array or multiple parameters
@@ -670,18 +707,18 @@ function setVariableCallback(...values: unknown[]): void;
 
 #### useInteraction()
 
-Returns a given interaction's selection state and a setter to update that interation
+Returns a given interaction's selection state and a setter to update that interaction
 
 ```ts
 function useInteraction(
-  interactionId: string,
+  configId: string,
   elementId: string,
 ): [WorkbookSelection | undefined, (value: WorkbookSelection[]) => void];
 ```
 
 Arguments
 
-- `interactionId : string` - The ID of the interaction
+- `configId : string` - The config ID corresponding to the workbook interaction
 - `elementId : string` - The ID of the element that this interaction is
   associated with
 
@@ -693,22 +730,39 @@ function setVariableCallback(value: WorkbookSelection[]): void;
 
 #### useActionTrigger()
 
+- `configId : string` - The config ID corresponding to the action trigger
+
 Returns a callback function to trigger one or more action effects for a given action trigger
 
 ```ts
-function useActionTrigger(triggerId: string);
+function useActionTrigger(configId: string): () => void;
 ```
 
+#### triggerActionCallback();
+
 Arguments
 
-- `triggerId : string` - The ID of the action trigger
+- `configId : string` - The config ID corresponding to the action trigger
 
-The function that can be called to trigger the action
+The function that can be called to asynchronously trigger the action
 
 ```ts
-function triggerActionCallback(): void;
+function triggerActionCallback(configId: string): void;
 ```
 
+#### useActionEffect()
+
+Registers and unregisters an action effect within the plugin
+
+```ts
+function useActionEffect(configId: string, effect: () => void);
+```
+
+Arguments
+
+- `configId : string` - The config ID corresponding to the action effect
+- `effect : Function` - The function to be called when the effect is triggered
+
 #### useConfig()
 
 Returns the workbook element’s current configuration. If a key is provided, only

package/dist/client/initialize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"initialize.d.ts","sourceRoot":"","sources":["../../src/client/initialize.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,cAAc,EAKf,MAAM,UAAU,CAAC;AAElB,wBAAgB,UAAU,CAAC,CAAC,GAAG,EAAE,KAAK,cAAc,CAAC,CAAC,CAAC,CAgMtD"}
+{"version":3,"file":"initialize.d.ts","sourceRoot":"","sources":["../../src/client/initialize.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,cAAc,EAIf,MAAM,UAAU,CAAC;AAElB,wBAAgB,UAAU,CAAC,CAAC,GAAG,EAAE,KAAK,cAAc,CAAC,CAAC,CAAC,CA6NtD"}

package/dist/client/initialize.js

@@ -1,12 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.initialize = void 0;
+const error_1 = require("../error");
 function initialize() {
     const pluginConfig = {
         config: {},
     };
     let subscribedInteractions = {};
     let subscribedWorkbookVars = {};
+    const registeredEffects = {};
     const listeners = {};
     for (const [key, value] of new URL(document.location.toString()).searchParams.entries())
         pluginConfig[key] = JSON.parse(value);
@@ -34,6 +36,13 @@ function initialize() {
         subscribedInteractions = {};
         Object.assign(subscribedInteractions, updatedInteractions);
     });
+    on('wb:plugin:action-effect:invoke', (configId) => {
+        const effect = registeredEffects[configId];
+        if (!effect) {
+            throw new Error(`Unknown action effect with name: ${configId}`);
+        }
+        effect();
+    });
     function on(event, listener) {
         listeners[event] = listeners[event] || [];
         listeners[event].push(listener);
@@ -88,20 +97,32 @@ function initialize() {
                 on('config', listener);
                 return () => off('config', listener);
             },
-            getVariable(id) {
-                return subscribedWorkbookVars[id];
+            getVariable(configId) {
+                (0, error_1.validateConfigId)(configId, 'variable');
+                return subscribedWorkbookVars[configId];
             },
-            setVariable(id, ...values) {
-                void execPromise('wb:plugin:variable:set', id, ...values);
+            setVariable(configId, ...values) {
+                (0, error_1.validateConfigId)(configId, 'variable');
+                void execPromise('wb:plugin:variable:set', configId, ...values);
             },
-            getInteraction(id) {
-                return subscribedInteractions[id];
+            getInteraction(configId) {
+                (0, error_1.validateConfigId)(configId, 'interaction');
+                return subscribedInteractions[configId];
             },
-            setInteraction(id, elementId, selection) {
-                void execPromise('wb:plugin:selection:set', id, elementId, selection);
+            setInteraction(configId, elementId, selection) {
+                (0, error_1.validateConfigId)(configId, 'interaction');
+                void execPromise('wb:plugin:selection:set', configId, elementId, selection);
             },
-            triggerAction(id) {
-                void execPromise('wb:plugin:action-trigger:invoke', id);
+            triggerAction(configId) {
+                (0, error_1.validateConfigId)(configId, 'action-trigger');
+                void execPromise('wb:plugin:action-trigger:invoke', configId);
+            },
+            registerEffect(configId, effect) {
+                (0, error_1.validateConfigId)(configId, 'action-effect');
+                registeredEffects[configId] = effect;
+                return () => {
+                    delete registeredEffects[configId];
+                };
             },
             configureEditorPanel(options) {
                 void execPromise('wb:plugin:config:inspector', options);
@@ -109,18 +130,20 @@ function initialize() {
             setLoadingState(loadingState) {
                 void execPromise('wb:plugin:config:loading-state', loadingState);
             },
-            subscribeToWorkbookVariable(id, callback) {
+            subscribeToWorkbookVariable(configId, callback) {
+                (0, error_1.validateConfigId)(configId, 'variable');
                 const setValues = (values) => {
-                    callback(values[id]);
+                    callback(values[configId]);
                 };
                 on('wb:plugin:variable:update', setValues);
                 return () => {
                     off('wb:plugin:variable:update', setValues);
                 };
             },
-            subscribeToWorkbookInteraction(id, callback) {
+            subscribeToWorkbookInteraction(configId, callback) {
+                (0, error_1.validateConfigId)(configId, 'interaction');
                 const setValues = (values) => {
-                    callback(values[id]);
+                    callback(values[configId]);
                 };
                 on('wb:plugin:selection:update', setValues);
                 return () => {
@@ -129,27 +152,34 @@ function initialize() {
             },
         },
         elements: {
-            getElementColumns(id) {
-                return execPromise('wb:plugin:element:columns:get', id);
+            getElementColumns(configId) {
+                (0, error_1.validateConfigId)(configId, 'element');
+                return execPromise('wb:plugin:element:columns:get', configId);
             },
-            subscribeToElementColumns(id, callback) {
-                const eventName = `wb:plugin:element:${id}:columns`;
+            subscribeToElementColumns(configId, callback) {
+                (0, error_1.validateConfigId)(configId, 'element');
+                const eventName = `wb:plugin:element:${configId}:columns`;
                 on(eventName, callback);
-                void execPromise('wb:plugin:element:subscribe:columns', id);
+                void execPromise('wb:plugin:element:subscribe:columns', configId);
                 return () => {
                     off(eventName, callback);
-                    void execPromise('wb:plugin:element:unsubscribe:columns', id);
+                    void execPromise('wb:plugin:element:unsubscribe:columns', configId);
                 };
             },
-            subscribeToElementData(id, callback) {
-                const eventName = `wb:plugin:element:${id}:data`;
+            subscribeToElementData(configId, callback) {
+                (0, error_1.validateConfigId)(configId, 'element');
+                const eventName = `wb:plugin:element:${configId}:data`;
                 on(eventName, callback);
-                void execPromise('wb:plugin:element:subscribe:data', id);
+                void execPromise('wb:plugin:element:subscribe:data', configId);
                 return () => {
                     off(eventName, callback);
-                    void execPromise('wb:plugin:element:unsubscribe:data', id);
+                    void execPromise('wb:plugin:element:unsubscribe:data', configId);
                 };
             },
+            fetchMoreElementData(configId) {
+                (0, error_1.validateConfigId)(configId, 'element');
+                void execPromise('wb:plugin:element:fetch-more', configId);
+            },
         },
         destroy() {
             Object.keys(listeners).forEach(event => delete listeners[event]);

package/dist/error.d.ts

@@ -0,0 +1,3 @@
+import { CustomPluginConfigOptions } from './types';
+export declare function validateConfigId(configId: string, expectedConfigType: CustomPluginConfigOptions['type']): void;
+//# sourceMappingURL=error.d.ts.map

package/dist/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAC;AAEpD,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,MAAM,EAChB,kBAAkB,EAAE,yBAAyB,CAAC,MAAM,CAAC,QAKtD"}

package/dist/error.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateConfigId = void 0;
+function validateConfigId(configId, expectedConfigType) {
+    if (configId === undefined) {
+        console.warn(`Invalid config ${expectedConfigType}: ${configId}`);
+    }
+}
+exports.validateConfigId = validateConfigId;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AAEzB,OAAO,EAAC,6BAA6B,EAAC,MAAM,uCAAuC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AAEzB,OAAO,EAAE,6BAA6B,EAAE,MAAM,uCAAuC,CAAC"}

package/dist/react/hooks.d.ts

@@ -16,17 +16,26 @@ export declare function useEditorPanelConfig(nextOptions: CustomPluginConfigOpti
  */
 export declare function useLoadingState(initialState: boolean): [boolean, (nextState: boolean) => void];
 /**
- * Provides the latest column values from corresponding sheet
- * @param {string} id Sheet ID to retrieve from workbook
- * @returns {WorkbookElementColumns} Values of corresponding columns contained within the sheet
+ * Provides the latest column values from corresponding config element
+ * @param {string} configId ID from the config for fetching element columns, with type: 'element'
+ * @returns {WorkbookElementColumns} Values of corresponding columns contained
+ * within the config element
  */
-export declare function useElementColumns(id: string): WorkbookElementColumns;
+export declare function useElementColumns(configId: string): WorkbookElementColumns;
 /**
- * Provides the latest data values from corresponding sheet
- * @param {string} id Sheet ID to get element data from
- * @returns {WorkbookElementData} Element Data for corresponding sheet, if any
+ * Provides the latest data values from config element (max 25_000)
+ * @param {string} configId ID from the config for fetching element data, with type: 'element'
+ * @returns {WorkbookElementData} Element Data for config element, if any
  */
-export declare function useElementData(id: string): WorkbookElementData;
+export declare function useElementData(configId: string): WorkbookElementData;
+/**
+ * Provides the latest data values from corresponding config element with a callback to
+ * fetch more in chunks of 25_000 data points
+ * @param {string} configId ID from the config for fetching paginated
+ * element data, with type: 'element'
+ * @returns {WorkbookElementData} Element Data for configured config element, if any
+ */
+export declare function usePaginatedElementData(configId: string): [WorkbookElementData, () => void];
 /**
  * Provides the latest value for entire config or certain key within the config
  * @param {string} key Key within Plugin Config, optional
@@ -34,22 +43,30 @@ export declare function useElementData(id: string): WorkbookElementData;
  */
 export declare function useConfig(key?: string): any;
 /**
- * React hook for accessing a workbook variable
- * @param {string} id ID of variable within Plugin Config to use
- * @returns {[(WorkbookVariable | undefined), Function]} Constantly updating value of the variable and setter for the variable
+ * React hook for accessing a workbook control variable
+ * @param {string} id ID from the config of type: 'variable'
+ * @returns {[(WorkbookVariable | undefined), Function]} Constantly updating
+ * value of the control variable and setter for the variable
  */
 export declare function useVariable(id: string): [WorkbookVariable | undefined, Function];
 /**
+ * @deprecated Use Action API instead
  * React hook for accessing a workbook interaction selections state
- * @param {string} id ID of variable within Plugin Config to use
+ * @param {string} id ID from the config of type: 'interaction'
  * @returns {[(WorkbookSelection | undefined), Function]} Constantly updating selection state and setter thereof
  */
 export declare function useInteraction(id: string, elementId: string): [unknown, Function];
 /**
  * React hook for returning a triggering callback function for the registered
  * action trigger
- * @param {string} id ID of action trigger
+ * @param {string} configId ID from the config of type: 'action-trigger'
  * @returns {Function} A callback function to trigger the action
  */
-export declare function useActionTrigger(id: string): () => void;
+export declare function useActionTrigger(configId: string): () => void;
+/**
+ * React hook for registering and unregistering an action effect
+ * @param {string} configId ID from the config of type: 'action-effect'
+ * @param {Function} effect The function to be called when the action is triggered
+ */
+export declare function useActionEffect(configId: string, effect: () => void): void;
 //# sourceMappingURL=hooks.d.ts.map

package/dist/react/hooks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../src/react/hooks.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,cAAc,EACd,yBAAyB,EACzB,sBAAsB,EACtB,mBAAmB,EAEnB,gBAAgB,EACjB,MAAM,UAAU,CAAC;AAGlB;;;GAGG;AACH,wBAAgB,SAAS,IAAI,cAAc,CAAC,GAAG,CAAC,CAE/C;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,yBAAyB,EAAE,GACvC,IAAI,CAWN;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAC7B,YAAY,EAAE,OAAO,GACpB,CAAC,OAAO,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC,CAezC;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,sBAAsB,CAWpE;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,mBAAmB,CAW9D;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,GAAG,CAmB3C;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,EAAE,EAAE,MAAM,GACT,CAAC,gBAAgB,GAAG,SAAS,EAAE,QAAQ,CAAC,CAc1C;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,EAAE,EAAE,MAAM,EACV,SAAS,EAAE,MAAM,GAChB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAoBrB;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,MAAM,cAM1C"}
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../src/react/hooks.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,cAAc,EACd,yBAAyB,EACzB,sBAAsB,EACtB,mBAAmB,EAEnB,gBAAgB,EACjB,MAAM,UAAU,CAAC;AAGlB;;;GAGG;AACH,wBAAgB,SAAS,IAAI,cAAc,CAAC,GAAG,CAAC,CAE/C;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,yBAAyB,EAAE,GACvC,IAAI,CAWN;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAC7B,YAAY,EAAE,OAAO,GACpB,CAAC,OAAO,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC,CAezC;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,sBAAsB,CAW1E;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,mBAAmB,CAWpE;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,MAAM,GACf,CAAC,mBAAmB,EAAE,MAAM,IAAI,CAAC,CAiBnC;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,GAAG,CAmB3C;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,EAAE,EAAE,MAAM,GACT,CAAC,gBAAgB,GAAG,SAAS,EAAE,QAAQ,CAAC,CAc1C;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,EAAE,EAAE,MAAM,EACV,SAAS,EAAE,MAAM,GAChB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAoBrB;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,IAAI,CAM7D;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,IAAI,QAYnE"}

package/dist/react/hooks.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useActionTrigger = exports.useInteraction = exports.useVariable = exports.useConfig = exports.useElementData = exports.useElementColumns = exports.useLoadingState = exports.useEditorPanelConfig = exports.usePlugin = void 0;
+exports.useActionEffect = exports.useActionTrigger = exports.useInteraction = exports.useVariable = exports.useConfig = exports.usePaginatedElementData = exports.useElementData = exports.useElementColumns = exports.useLoadingState = exports.useEditorPanelConfig = exports.usePlugin = void 0;
 const react_1 = require("react");
 const Context_1 = require("./Context");
 const deepEqual_1 = require("../utils/deepEqual");
@@ -52,37 +52,61 @@ function useLoadingState(initialState) {
 }
 exports.useLoadingState = useLoadingState;
 /**
- * Provides the latest column values from corresponding sheet
- * @param {string} id Sheet ID to retrieve from workbook
- * @returns {WorkbookElementColumns} Values of corresponding columns contained within the sheet
+ * Provides the latest column values from corresponding config element
+ * @param {string} configId ID from the config for fetching element columns, with type: 'element'
+ * @returns {WorkbookElementColumns} Values of corresponding columns contained
+ * within the config element
  */
-function useElementColumns(id) {
+function useElementColumns(configId) {
     const client = usePlugin();
     const [columns, setColumns] = (0, react_1.useState)({});
     (0, react_1.useEffect)(() => {
-        if (id) {
-            return client.elements.subscribeToElementColumns(id, setColumns);
+        if (configId) {
+            return client.elements.subscribeToElementColumns(configId, setColumns);
         }
-    }, [client, id]);
+    }, [client, configId]);
     return columns;
 }
 exports.useElementColumns = useElementColumns;
 /**
- * Provides the latest data values from corresponding sheet
- * @param {string} id Sheet ID to get element data from
- * @returns {WorkbookElementData} Element Data for corresponding sheet, if any
+ * Provides the latest data values from config element (max 25_000)
+ * @param {string} configId ID from the config for fetching element data, with type: 'element'
+ * @returns {WorkbookElementData} Element Data for config element, if any
  */
-function useElementData(id) {
+function useElementData(configId) {
     const client = usePlugin();
     const [data, setData] = (0, react_1.useState)({});
     (0, react_1.useEffect)(() => {
-        if (id) {
-            return client.elements.subscribeToElementData(id, setData);
+        if (configId) {
+            return client.elements.subscribeToElementData(configId, setData);
         }
-    }, [client, id]);
+    }, [client, configId]);
     return data;
 }
 exports.useElementData = useElementData;
+/**
+ * Provides the latest data values from corresponding config element with a callback to
+ * fetch more in chunks of 25_000 data points
+ * @param {string} configId ID from the config for fetching paginated
+ * element data, with type: 'element'
+ * @returns {WorkbookElementData} Element Data for configured config element, if any
+ */
+function usePaginatedElementData(configId) {
+    const client = usePlugin();
+    const [data, setData] = (0, react_1.useState)({});
+    const loadMore = (0, react_1.useCallback)(() => {
+        if (configId) {
+            client.elements.fetchMoreElementData(configId);
+        }
+    }, [configId]);
+    (0, react_1.useEffect)(() => {
+        if (configId) {
+            return client.elements.subscribeToElementData(configId, setData);
+        }
+    }, [client, configId]);
+    return [data, loadMore];
+}
+exports.usePaginatedElementData = usePaginatedElementData;
 /**
  * Provides the latest value for entire config or certain key within the config
  * @param {string} key Key within Plugin Config, optional
@@ -103,9 +127,10 @@ function useConfig(key) {
 }
 exports.useConfig = useConfig;
 /**
- * React hook for accessing a workbook variable
- * @param {string} id ID of variable within Plugin Config to use
- * @returns {[(WorkbookVariable | undefined), Function]} Constantly updating value of the variable and setter for the variable
+ * React hook for accessing a workbook control variable
+ * @param {string} id ID from the config of type: 'variable'
+ * @returns {[(WorkbookVariable | undefined), Function]} Constantly updating
+ * value of the control variable and setter for the variable
  */
 function useVariable(id) {
     const client = usePlugin();
@@ -118,8 +143,9 @@ function useVariable(id) {
 }
 exports.useVariable = useVariable;
 /**
+ * @deprecated Use Action API instead
  * React hook for accessing a workbook interaction selections state
- * @param {string} id ID of variable within Plugin Config to use
+ * @param {string} id ID from the config of type: 'interaction'
  * @returns {[(WorkbookSelection | undefined), Function]} Constantly updating selection state and setter thereof
  */
 function useInteraction(id, elementId) {
@@ -137,13 +163,29 @@ exports.useInteraction = useInteraction;
 /**
  * React hook for returning a triggering callback function for the registered
  * action trigger
- * @param {string} id ID of action trigger
+ * @param {string} configId ID from the config of type: 'action-trigger'
  * @returns {Function} A callback function to trigger the action
  */
-function useActionTrigger(id) {
+function useActionTrigger(configId) {
     const client = usePlugin();
     return (0, react_1.useCallback)(() => {
-        client.config.triggerAction(id);
-    }, [client, id]);
+        client.config.triggerAction(configId);
+    }, [client, configId]);
 }
 exports.useActionTrigger = useActionTrigger;
+/**
+ * React hook for registering and unregistering an action effect
+ * @param {string} configId ID from the config of type: 'action-effect'
+ * @param {Function} effect The function to be called when the action is triggered
+ */
+function useActionEffect(configId, effect) {
+    const client = usePlugin();
+    const effectRef = (0, react_1.useRef)(effect);
+    (0, react_1.useEffect)(() => {
+        effectRef.current = effect;
+    });
+    (0, react_1.useEffect)(() => {
+        return client.config.registerEffect(configId, effectRef.current);
+    }, [client, configId, effect]);
+}
+exports.useActionEffect = useActionEffect;

package/dist/types.d.ts

@@ -13,8 +13,8 @@ export interface PluginConfig<T> {
 }
 /**
  * @typedef {object} WorkbookVariable
- * @property {string} name Name of Control Variable within Workbook
- * @property {{string}} defaultValue Current Value containing at least type as string
+ * @property {string} name Name of control variable within workbook
+ * @property {{string}} defaultValue Current value containing at least type as string
  */
 export interface WorkbookVariable {
     name: string;
@@ -143,6 +143,10 @@ export declare type CustomPluginConfigOptions = {
     type: 'action-trigger';
     name: string;
     label?: string;
+} | {
+    type: 'action-effect';
+    name: string;
+    label?: string;
 };
 /**
  * @typedef {object} PluginInstance
@@ -194,33 +198,42 @@ export interface PluginInstance<T = any> {
         configureEditorPanel(options: CustomPluginConfigOptions[]): void;
         /**
          * Gets a static image of a workbook variable
-         * @param {string} id ID of the workbook variable in config
+         * @param {string} configId ID from config of type: 'variable'
          * @returns {WorkbookVariable} Current value of the workbook variable
          */
-        getVariable(id: string): WorkbookVariable;
+        getVariable(configId: string): WorkbookVariable;
         /**
          * Setter for workbook variable passed in
-         * @param {string} id ID of the workbook variable in config
+         * @param {string} configId ID from config of type: 'variable'
          * @param {unknown[]} values Values to assign to the workbook variable
          */
-        setVariable(id: string, ...values: unknown[]): void;
+        setVariable(configId: string, ...values: unknown[]): void;
         /**
+         * @deprecated Use Action API instead
          * Getter for interaction selection state
-         * @param {string} id ID from interaction type in Plugin Config
+         * @param {string} configId ID from config of type: 'interaction'
          */
-        getInteraction(id: string): WorkbookSelection[];
+        getInteraction(configId: string): WorkbookSelection[];
         /**
+         * @deprecated Use Action API instead
          * Setter for interaction selection state
-         * @param {string} id ID from interaction type in Plugin Config
+         * @param {string} configId ID from config of type: 'interaction'
          * @param {string} elementId Source element ID from element type in Plugin Config
          * @param {Object} selection List of column IDs or Columns and values and key-value pairs to select
          */
-        setInteraction(id: string, elementId: string, selection: WorkbookSelection[]): void;
+        setInteraction(configId: string, elementId: string, selection: WorkbookSelection[]): void;
+        /**
+         * Triggers an action based on the provided action trigger ID
+         * @param {string} configId ID from config of type: 'action-trigger'
+         */
+        triggerAction(configId: string): void;
         /**
-         * Triggers an action based on the provided action trigger Id
-         * @param {string} id ID from action-trigger type in Plugin Config
+         * Registers an effect with the provided action effect ID
+         * @param {string} configId ID from config of type: 'action-effect'
+         * @param {Function} effect The effect function to register
+         * @returns {Unsubscriber} A callable unsubscriber
          */
-        triggerAction(id: string): void;
+        registerEffect(configId: string, effect: () => void): () => void;
         /**
          * Overrider function for Config Ready state
          * @param {boolean} loadingState Boolean representing if Plugin Config is still loading
@@ -228,40 +241,46 @@ export interface PluginInstance<T = any> {
         setLoadingState(ready: boolean): void;
         /**
          * Allows users to subscribe to changes in the passed in variable
-         * @param {string} id ID of the workbook variable in config
+         * @param {string} configId ID from config of type: 'variable'
          * @callback callback Function to be called upon receiving an updated workbook variable
          * @returns {Unsubscriber} A callable unsubscriber
          */
-        subscribeToWorkbookVariable(id: string, callback: (input: WorkbookVariable) => void): Unsubscriber;
+        subscribeToWorkbookVariable(configId: string, callback: (input: WorkbookVariable) => void): Unsubscriber;
         /**
+         * @deprecated Use Action API instead
          * Allows users to subscribe to changes in the passed in interaction ID
-         * @param {string} id ID of the interaction variable within Plugin Config
+         * @param {string} configId ID from the config of type: 'interaction'
          * @callback callback Function to be called upon receiving an updated interaction selection state
          * @returns {Unsubscriber} A callable unsubscriber
          */
-        subscribeToWorkbookInteraction(id: string, callback: (input: WorkbookSelection[]) => void): Unsubscriber;
+        subscribeToWorkbookInteraction(configId: string, callback: (input: WorkbookSelection[]) => void): Unsubscriber;
     };
     elements: {
         /**
          * Getter for Column Data by parent sheet ID
-         * @param {string} id Sheet ID to retrieve columns from
+         * @param {string} configId ID from config of type: 'element'
          * @returns {WorkbookElementColumns} Column values contained within corresponding sheet
          */
-        getElementColumns(id: string): Promise<WorkbookElementColumns>;
+        getElementColumns(configId: string): Promise<WorkbookElementColumns>;
         /**
          * Subscriber to changes in column data by ID
-         * @param {string} id Column ID to subscribe to
+         * @param {string} configId ID from config of type: 'element'
          * @callback callback Callback function to be called upon changes to column data
          * @returns {Unsubscriber} Callable unsubscriber to column data changes
          */
-        subscribeToElementColumns(id: string, callback: (cols: WorkbookElementColumns) => void): Unsubscriber;
+        subscribeToElementColumns(configId: string, callback: (cols: WorkbookElementColumns) => void): Unsubscriber;
         /**
          * Subscriber for the data within a given sheet
-         * @param {string} id Sheet ID to get element data from
+         * @param {string} configId ID from config of type: 'element'
          * @callback callback Function to call on data passed in
          * @returns {Unsubscriber} A callable unsubscriber to changes in the data
          */
-        subscribeToElementData(id: string, callback: (data: WorkbookElementData) => void): Unsubscriber;
+        subscribeToElementData(configId: string, callback: (data: WorkbookElementData) => void): Unsubscriber;
+        /**
+         * Ask sigma to load more data
+         * @param {string} configId ID from config of type: 'element'
+         */
+        fetchMoreElementData(configId: string): void;
     };
     /**
      * Destroys plugin instance and removes all subscribers

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,oBAAY,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;AAChF,oBAAY,aAAa,GAAG,UAAU,GAAG,SAAS,GAAG,MAAM,CAAC;AAC5D,oBAAY,SAAS,GAAG,aAAa,GAAG,OAAO,CAAC;AAEhD;;GAEG;AACH,oBAAY,WAAW,GACnB,SAAS,GACT,MAAM,GACN,QAAQ,GACR,MAAM,GACN,WAAW,GACX,aAAa,GACb,WAAW,GACX,cAAc,GACd,YAAY,CAAC;AAEjB,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,CAAC,CAAC;IACV,UAAU,EAAE,OAAO,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAChC;AAED,oBAAY,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAEhF,oBAAY,qBAAqB,GAAG,YAAY,CAAC;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,GAAG,EAAE,CAAC;IACd,KAAK,EAAE,GAAG,CAAC;CACZ,CAAC,CAAC;AAEH,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,EAAE,CAAC;CACxB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,SAAS,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,CAAC,KAAK,EAAE,MAAM,GAAG,qBAAqB,CAAC;CACxC;AAED;;;GAGG;AACH,oBAAY,YAAY,GAAG,MAAM,IAAI,CAAC;AAEtC;;;;;;GAMG;AACH,oBAAY,yBAAyB,GACjC;IACE,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,SAAS,EAAE,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,OAAO,CAAC;CACxB,GACD;IACE,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GACD;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GACD;IACE,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GACD;IACE,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GACD;IACE,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GACD;IACE,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,GACD;IACE,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;CAC9B,GACD;IACE,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IACE,IAAI,EAAE,gBAAgB,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEN;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,GAAG;IACrC,QAAQ,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC;IAE3C,MAAM,EAAE;QACN;;;;WAIG;QACH,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;QAE9B;;;;WAIG;QACH,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;QAE9B;;;;;WAKG;QACH,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAE9C;;;;;;WAMG;QACH,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;QAE3D;;;WAGG;QACH,SAAS,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,GAAG,YAAY,CAAC;QAErD;;;WAGG;QACH,oBAAoB,CAAC,OAAO,EAAE,yBAAyB,EAAE,GAAG,IAAI,CAAC;QAEjE;;;;WAIG;QACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,gBAAgB,CAAC;QAE1C;;;;WAIG;QACH,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAEpD;;;WAGG;QACH,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,iBAAiB,EAAE,CAAC;QAEhD;;;;;WAKG;QACH,cAAc,CACZ,EAAE,EAAE,MAAM,EACV,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,iBAAiB,EAAE,GAC7B,IAAI,CAAC;QAER;;;WAGG;QACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;;WAGG;QACH,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;QAEtC;;;;;WAKG;QACH,2BAA2B,CACzB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,GAC1C,YAAY,CAAC;QAEhB;;;;;WAKG;QACH,8BAA8B,CAC5B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,CAAC,KAAK,EAAE,iBAAiB,EAAE,KAAK,IAAI,GAC7C,YAAY,CAAC;KACjB,CAAC;IAEF,QAAQ,EAAE;QACR;;;;WAIG;QACH,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAE/D;;;;;WAKG;QACH,yBAAyB,CACvB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,CAAC,IAAI,EAAE,sBAAsB,KAAK,IAAI,GAC/C,YAAY,CAAC;QAEhB;;;;;WAKG;QACH,sBAAsB,CACpB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,CAAC,IAAI,EAAE,mBAAmB,KAAK,IAAI,GAC5C,YAAY,CAAC;KACjB,CAAC;IAEF;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;CACjB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,oBAAY,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;AAChF,oBAAY,aAAa,GAAG,UAAU,GAAG,SAAS,GAAG,MAAM,CAAC;AAC5D,oBAAY,SAAS,GAAG,aAAa,GAAG,OAAO,CAAC;AAEhD;;GAEG;AACH,oBAAY,WAAW,GACnB,SAAS,GACT,MAAM,GACN,QAAQ,GACR,MAAM,GACN,WAAW,GACX,aAAa,GACb,WAAW,GACX,cAAc,GACd,YAAY,CAAC;AAEjB,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,CAAC,CAAC;IACV,UAAU,EAAE,OAAO,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAChC;AAED,oBAAY,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAEhF,oBAAY,qBAAqB,GAAG,YAAY,CAAC;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,GAAG,EAAE,CAAC;IACd,KAAK,EAAE,GAAG,CAAC;CACZ,CAAC,CAAC;AAEH,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,EAAE,CAAC;CACxB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,SAAS,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,CAAC,KAAK,EAAE,MAAM,GAAG,qBAAqB,CAAC;CACxC;AAED;;;GAGG;AACH,oBAAY,YAAY,GAAG,MAAM,IAAI,CAAC;AAEtC;;;;;;GAMG;AACH,oBAAY,yBAAyB,GACjC;IACE,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,SAAS,EAAE,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,OAAO,CAAC;CACxB,GACD;IACE,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GACD;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GACD;IACE,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GACD;IACE,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GACD;IACE,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GACD;IACE,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,GACD;IACE,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;CAC9B,GACD;IACE,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IACE,IAAI,EAAE,gBAAgB,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IACE,IAAI,EAAE,eAAe,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEN;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,GAAG;IACrC,QAAQ,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC;IAE3C,MAAM,EAAE;QACN;;;;WAIG;QACH,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;QAE9B;;;;WAIG;QACH,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;QAE9B;;;;;WAKG;QACH,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAE9C;;;;;;WAMG;QACH,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;QAE3D;;;WAGG;QACH,SAAS,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,GAAG,YAAY,CAAC;QAErD;;;WAGG;QACH,oBAAoB,CAAC,OAAO,EAAE,yBAAyB,EAAE,GAAG,IAAI,CAAC;QAEjE;;;;WAIG;QACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAAC;QAEhD;;;;WAIG;QACH,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAE1D;;;;WAIG;QACH,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,iBAAiB,EAAE,CAAC;QAEtD;;;;;;WAMG;QACH,cAAc,CACZ,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,iBAAiB,EAAE,GAC7B,IAAI,CAAC;QAER;;;WAGG;QACH,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtC;;;;;WAKG;QACH,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;QAEjE;;;WAGG;QACH,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;QAEtC;;;;;WAKG;QACH,2BAA2B,CACzB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,GAC1C,YAAY,CAAC;QAEhB;;;;;;WAMG;QACH,8BAA8B,CAC5B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,CAAC,KAAK,EAAE,iBAAiB,EAAE,KAAK,IAAI,GAC7C,YAAY,CAAC;KACjB,CAAC;IAEF,QAAQ,EAAE;QACR;;;;WAIG;QACH,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAErE;;;;;WAKG;QACH,yBAAyB,CACvB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,CAAC,IAAI,EAAE,sBAAsB,KAAK,IAAI,GAC/C,YAAY,CAAC;QAEhB;;;;;WAKG;QACH,sBAAsB,CACpB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,CAAC,IAAI,EAAE,mBAAmB,KAAK,IAAI,GAC5C,YAAY,CAAC;QAEhB;;;WAGG;QACH,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9C,CAAC;IAEF;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;CACjB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sigmacomputing/plugin",
-  "version": "1.0.6-beta",
+  "version": "1.0.6",
   "description": "Sigma Computing Plugin Client API",
   "license": "MIT",
   "homepage": "https://github.com/sigmacomputing/plugin",
@@ -13,6 +13,7 @@
     "email": "support@sigmacomputing.com",
     "url": "https://github.com/sigmacomputing/plugin/issues"
   },
+  "packageManager": "yarn@4.4.1",
   "files": [
     "dist/*"
   ],
@@ -24,15 +25,13 @@
     }
   },
   "scripts": {
-    "clean": "rimraf dist tsconfig*.tsbuildinfo",
-    "build": "yarn clean && yarn tsc",
+    "build": "yarn tsc --build tsconfig.build.json",
     "build:watch": "yarn build --watch",
     "format": "prettier --write 'src/**/*.{ts,tsx}' 'jest.config.ts'",
     "precommit": "lint-staged",
     "prepublish": "yarn build",
     "test": "jest --ci",
-    "test:watch": "yarn test --watch",
-    "tsc": "tsc --build tsconfig.build.json"
+    "test:watch": "yarn test --watch"
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
@@ -49,10 +48,6 @@
     "lint-staged": "^13.0.3",
     "prettier": "^2.7.1",
     "ts-jest": "^27.1.4",
-    "ts-node": "^10.9.1",
-    "ttypescript": "^1.5.13",
-    "typescript": "^4.8.2",
-    "typescript-transform-paths": "^3.3.1"
-  },
-  "packageManager": "yarn@4.3.1+sha512.af78262d7d125afbfeed740602ace8c5e4405cd7f4735c08feb327286b2fdb2390fbca01589bfd1f50b1240548b74806767f5a063c94b67e431aabd0d86f7774"
+    "typescript": "^4.8.2"
+  }
 }