@sigmacomputing/plugin 0.7.57 → 1.0.0-rc.1

package/dist/client.d.ts

@@ -1,2 +0,0 @@
-export declare const client: import("@sigmacomputing/plugin-types").PluginInstance<{}>;
-//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,MAAM,2DAAe,CAAC"}

package/dist/deepEqual.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"deepEqual.d.ts","sourceRoot":"","sources":["../src/deepEqual.ts"],"names":[],"mappings":"AAkBA,wBAAgB,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,uBAuB7C"}

package/dist/deepEqual.js

@@ -1,46 +0,0 @@
-"use strict";
-// Deep Equality comparison example
-//
-// This is an example of how to implement an object-comparison function in
-// JavaScript (ES5+). A few points of interest here:
-//
-// * You can get an array of all an object's properties in ES5+ by calling
-//   the class method Object.keys(obj).
-// * The function recursively calls itself in the for / in loop when it
-//   compares the contents of each property
-// * You can hide a "private" function inside a function of this kind by
-//   placing one function declaration inside of another. The inner function
-//   is not hoisted out into the global scope, so it is only visible inside
-//   of the parent function.
-// * The reason this nested helper function is necessary is that
-//   `typeof null` is still "object" in JS, a major "gotcha" to watch out for.
-//
-// https://gist.github.com/egardner/efd34f270cc33db67c0246e837689cb9
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deepEqual = void 0;
-function deepEqual(obj1, obj2) {
-    if (obj1 === obj2) {
-        return true;
-    }
-    else if (isObject(obj1) && isObject(obj2)) {
-        if (Object.keys(obj1).length !== Object.keys(obj2).length) {
-            return false;
-        }
-        for (const prop in obj1) {
-            if (!deepEqual(obj1[prop], obj2[prop])) {
-                return false;
-            }
-        }
-        return true;
-    }
-    // Private
-    function isObject(obj) {
-        if (typeof obj === 'object' && obj != null) {
-            return true;
-        }
-        else {
-            return false;
-        }
-    }
-}
-exports.deepEqual = deepEqual;

package/dist/initialize.d.ts

@@ -1,3 +0,0 @@
-import * as plugin from '@sigmacomputing/plugin-types';
-export declare function initialize<T = {}>(): plugin.PluginInstance<T>;
-//# sourceMappingURL=initialize.d.ts.map

package/dist/initialize.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"initialize.d.ts","sourceRoot":"","sources":["../src/initialize.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,8BAA8B,CAAC;AAEvD,wBAAgB,UAAU,CAAC,CAAC,GAAG,EAAE,KAAK,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CA2L7D"}

package/dist/initialize.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=initialize.test.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"initialize.test.d.ts","sourceRoot":"","sources":["../src/initialize.test.ts"],"names":[],"mappings":""}

package/dist/initialize.test.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const initialize_1 = require("./initialize");
-describe('initialize', () => {
-    let originalAddEventListener;
-    let originalRemoveEventListener;
-    beforeAll(() => {
-        originalAddEventListener = window.addEventListener;
-        originalRemoveEventListener = window.removeEventListener;
-        window.addEventListener = jest.fn();
-        window.removeEventListener = jest.fn();
-    });
-    beforeEach(() => {
-        jest.resetAllMocks();
-    });
-    test('should initialize and be destroyable', () => {
-        const client = (0, initialize_1.initialize)();
-        expect(window.addEventListener).toHaveBeenCalled();
-        client.destroy();
-        expect(window.removeEventListener).toHaveBeenCalled();
-    });
-    afterAll(() => {
-        window.addEventListener = originalAddEventListener;
-        window.removeEventListener = originalRemoveEventListener;
-    });
-});

package/dist/react/index.d.ts

@@ -1,58 +0,0 @@
-import React from 'react';
-import * as plugin from '@sigmacomputing/plugin-types';
-/**
- * Wrapper for plugin client using a Provider
- * @param {{client: plugin.PluginInstance, children: React.ReachChildren}} props Plugin instance and any children elements
- * @returns {JSXElement} Context Provider for passed in props
- */
-export declare function SigmaClientProvider(props: {
-    client: plugin.PluginInstance<any>;
-    children?: React.ReactChildren;
-}): JSX.Element;
-/**
- * A constantly updating getter for the entire Plugin Instance
- * @returns {plugin.PluginInstance} Context for the current plugin instance
- */
-export declare function usePlugin(): plugin.PluginInstance<any>;
-/**
- * Provides a setter for the Plugin's Config Options
- * @param {plugin.CustomPluginConfigOptions[]} nextOptions Updated possible Config Options
- */
-export declare function useEditorPanelConfig(nextOptions: plugin.CustomPluginConfigOptions[]): void;
-/**
- * React hook for Plugin Config loading state
- * @param {boolean} initialState Initial value to set loading state to
- * @returns {[boolean, Function]} Boolean value corresponding to loading state for plugin config and setter for loading state
- */
-export declare function useLoadingState(initialState: boolean): [boolean, (nextState: boolean) => void];
-/**
- * Provides constantly updating column values from corresponding sheet
- * @param {string} id Sheet ID to retrieve from workbook
- * @returns {plugin.WbElementColumns} Values of corresponding columns contained within the sheet
- */
-export declare function useElementColumns(id: string): plugin.WbElementColumns;
-/**
- * Provides constantly updating data values from corresponding sheet
- * @param {string} id Sheet ID to get element data from
- * @returns {plugin.WbElementData} Element Data for corresponding sheet, if any
- */
-export declare function useElementData(id: string): plugin.WbElementData;
-/**
- * Provides a constantly updating value for entire config or certain key within config
- * @param {string} key Key within Plugin Config, optional
- * @returns Entire config if no key passed in or value for key within plugin config
- */
-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 {[(plugin.WorkbookVariable | undefined), Function]} Constantly updating value of the variable and setter for the variable
- */
-export declare function useVariable(id: string): [plugin.WorkbookVariable | undefined, Function];
-/**
- * React hook for accessing a workbook interaction selections state
- * @param {string} id ID of variable within Plugin Config to use
- * @returns {[(plugin.WorkbookSelection | undefined), Function]} Constantly updating selection state and setter thereof
- */
-export declare function useInteraction(id: string, elementId: string): [unknown, Function];
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/react/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAON,MAAM,OAAO,CAAC;AACf,OAAO,KAAK,MAAM,MAAM,8BAA8B,CAAC;AAOvD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE;IACzC,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IACnC,QAAQ,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;CAChC,eAIA;AAED;;;GAGG;AACH,wBAAgB,SAAS,IAAI,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAEtD;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,MAAM,CAAC,yBAAyB,EAAE,GAC9C,IAAI,CAUN;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAC7B,YAAY,EAAE,OAAO,GACpB,CAAC,OAAO,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC,CAczC;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC,gBAAgB,CASrE;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC,aAAa,CAO/D;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,GAAG,CAiB3C;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,EAAE,EAAE,MAAM,GACT,CAAC,MAAM,CAAC,gBAAgB,GAAG,SAAS,EAAE,QAAQ,CAAC,CAcjD;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,EAAE,EAAE,MAAM,EACV,SAAS,EAAE,MAAM,GAChB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAmBrB"}