@sigmacomputing/plugin 1.0.2 → 1.0.3

package/dist/client/initialize.d.ts

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

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,iBAAc;AAEf,wBAAgB,UAAU,CAAC,CAAC,GAAG,EAAE,KAAK,cAAc,CAAC,CAAC,CAAC,CA6LtD"}
+{"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,CA6LtD"}

package/dist/client/initialize.js

@@ -21,7 +21,7 @@ function initialize() {
         emit('config', (_a = pluginConfig.config) !== null && _a !== void 0 ? _a : {});
     });
     // send initialize event
-    void execPromise('wb:plugin:init', require("../../package.json").version).then(config => {
+    void execPromise('wb:plugin:init', require('../../package.json').version).then(config => {
         Object.assign(pluginConfig, config);
         emit('init', pluginConfig);
         emit('config', pluginConfig.config);

package/dist/client.d.ts

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

package/dist/client.d.ts.map

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

package/dist/client.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.client = void 0;
+const initialize_1 = require("./client/initialize");
+exports.client = (0, initialize_1.initialize)();

package/dist/index.d.ts

@@ -1,3 +1,4 @@
-export * from "./client";
-export * from "./types";
+export * from './types';
+export * from './react';
+export * from './client';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,yBAAuB;AACvB,wBAAsB"}
+{"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"}

package/dist/index.js

@@ -14,5 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./client"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./react"), exports);
+__exportStar(require("./client"), exports);

package/dist/{client/react → react}/Context.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="react" />
-import { PluginInstance } from "../../types";
+import { PluginInstance } from '../types';
 export declare const PluginContext: import("react").Context<PluginInstance<any>>;
 //# sourceMappingURL=Context.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Context.d.ts","sourceRoot":"","sources":["../../src/react/Context.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAE1C,eAAO,MAAM,aAAa,8CAAwC,CAAC"}

package/dist/{client/react → react}/Context.js

@@ -2,5 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PluginContext = void 0;
 const react_1 = require("react");
-const client_1 = require("..");
+const client_1 = require("../client");
 exports.PluginContext = (0, react_1.createContext)(client_1.client);

package/dist/{client/react → react}/Provider.d.ts

@@ -1,5 +1,5 @@
 import type { ReactNode } from 'react';
-import { PluginInstance } from "../../types";
+import { PluginInstance } from '../types';
 export interface SigmaClientProviderProps<T = any> {
     client: PluginInstance<T>;
     children?: ReactNode;

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

@@ -0,0 +1 @@
+{"version":3,"file":"Provider.d.ts","sourceRoot":"","sources":["../../src/react/Provider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAGvC,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAE1C,MAAM,WAAW,wBAAwB,CAAC,CAAC,GAAG,GAAG;IAC/C,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;IAC1B,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED,wBAAgB,mBAAmB,CAAC,CAAC,GAAG,GAAG,EACzC,KAAK,EAAE,wBAAwB,CAAC,CAAC,CAAC,eAOnC"}

package/dist/{client/react → react}/hooks.d.ts

@@ -1,4 +1,4 @@
-import { PluginInstance, CustomPluginConfigOptions, WorkbookElementColumns, WorkbookElementData, WorkbookVariable } from "../../types";
+import { PluginInstance, CustomPluginConfigOptions, WorkbookElementColumns, WorkbookElementData, WorkbookVariable } from '../types';
 /**
  * Gets the entire plugin instance
  * @returns {PluginInstance} Context for the current plugin instance

package/dist/{client/react → react}/hooks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../../src/client/react/hooks.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,cAAc,EACd,yBAAyB,EACzB,sBAAsB,EACtB,mBAAmB,EAEnB,gBAAgB,EACjB,oBAAc;AAGf;;;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"}
+{"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"}

package/dist/{client/react → react}/hooks.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.useInteraction = exports.useVariable = exports.useConfig = 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");
+const deepEqual_1 = require("../utils/deepEqual");
 /**
  * Gets the entire plugin instance
  * @returns {PluginInstance} Context for the current plugin instance

package/dist/react.d.ts

@@ -0,0 +1,3 @@
+export * from './react/hooks';
+export { SigmaClientProviderProps, SigmaClientProvider, } from './react/Provider';
+//# sourceMappingURL=react.d.ts.map

package/dist/react.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../src/react.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,OAAO,EACL,wBAAwB,EACxB,mBAAmB,GACpB,MAAM,kBAAkB,CAAC"}

package/dist/{client/react/index.js → react.js}

@@ -15,8 +15,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SigmaClientProvider = void 0;
-__exportStar(require(".."), exports);
-__exportStar(require("./hooks"), exports);
-var Provider_1 = require("./Provider");
+__exportStar(require("./react/hooks"), exports);
+var Provider_1 = require("./react/Provider");
 Object.defineProperty(exports, "SigmaClientProvider", { enumerable: true, get: function () { return Provider_1.SigmaClientProvider; } });
-__exportStar(require("../../types"), exports);

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@sigmacomputing/plugin",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Sigma Computing Plugin Client API",
   "license": "MIT",
   "homepage": "https://github.com/sigmacomputing/plugin",
+  "main": "./dist/index.js",
   "repository": {
     "type": "git",
     "url": "https://github.com/sigmacomputing/plugin.git"
@@ -12,23 +13,13 @@
     "email": "support@sigmacomputing.com",
     "url": "https://github.com/sigmacomputing/plugin/issues"
   },
-  "module": "./src/index.ts",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
   "files": [
-    "/dist",
-    "/src",
-    "!/src/**/__tests__/**"
+    "dist/*"
   ],
-  "exports": {
-    ".": "./dist/index.js",
-    "./react": "./dist/client/react/index.js",
-    "./package.json": "./package.json"
-  },
   "typesVersions": {
     "*": {
       "react": [
-        "dist/client/react/index.d.ts"
+        "dist/react/index.d.ts"
       ]
     }
   },
@@ -44,7 +35,8 @@
     "tsc": "ttsc --build tsconfig.build.json"
   },
   "peerDependencies": {
-    "react": "^16.8.0 || ^17.0.0 || ^18.0.0"
+    "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
+    "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0"
   },
   "devDependencies": {
     "@jest/types": "^27.5.1",
@@ -56,8 +48,6 @@
     "jest-watch-typeahead": "^2.1.1",
     "lint-staged": "^13.0.3",
     "prettier": "^2.7.1",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
     "ts-jest": "^27.1.4",
     "ts-node": "^10.9.1",
     "ttypescript": "^1.5.13",

package/dist/client/index.d.ts

@@ -1,4 +0,0 @@
-import { initialize } from "./initialize";
-export declare const client: import("..").PluginInstance<{}>;
-export { initialize };
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,qBAA0B;AAE/C,eAAO,MAAM,MAAM,iCAAe,CAAC;AAEnC,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/client/index.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.initialize = exports.client = void 0;
-const initialize_1 = require("./initialize");
-Object.defineProperty(exports, "initialize", { enumerable: true, get: function () { return initialize_1.initialize; } });
-exports.client = (0, initialize_1.initialize)();

package/dist/client/react/Context.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Context.d.ts","sourceRoot":"","sources":["../../../src/client/react/Context.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,cAAc,EAAE,oBAAc;AAEvC,eAAO,MAAM,aAAa,8CAAwC,CAAC"}

package/dist/client/react/Provider.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Provider.d.ts","sourceRoot":"","sources":["../../../src/client/react/Provider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAGvC,OAAO,EAAE,cAAc,EAAE,oBAAc;AAEvC,MAAM,WAAW,wBAAwB,CAAC,CAAC,GAAG,GAAG;IAC/C,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;IAC1B,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED,wBAAgB,mBAAmB,CAAC,CAAC,GAAG,GAAG,EACzC,KAAK,EAAE,wBAAwB,CAAC,CAAC,CAAC,eAOnC"}

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

@@ -1,5 +0,0 @@
-export * from "..";
-export * from "./hooks";
-export { SigmaClientProviderProps, SigmaClientProvider, } from "./Provider";
-export * from "../../types";
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/react/index.tsx"],"names":[],"mappings":"AAAA,mBAAuB;AAEvB,wBAAmC;AACnC,OAAO,EACL,wBAAwB,EACxB,mBAAmB,GACpB,mBAA8B;AAE/B,4BAAsB"}

package/src/client/index.ts

@@ -1,5 +0,0 @@
-import { initialize } from 'client/initialize';
-
-export const client = initialize();
-
-export { initialize };

package/src/client/initialize.ts

@@ -1,199 +0,0 @@
-import {
-  PluginConfig,
-  PluginInstance,
-  PluginMessageResponse,
-  WorkbookSelection,
-  WorkbookVariable,
-  Unsubscriber,
-} from 'types';
-
-export function initialize<T = {}>(): PluginInstance<T> {
-  const pluginConfig: Partial<PluginConfig<T>> = {
-    config: {} as T,
-  };
-
-  let subscribedInteractions: Record<string, WorkbookSelection[]> = {};
-  let subscribedWorkbookVars: Record<string, WorkbookVariable> = {};
-
-  const listeners: {
-    [event: string]: Function[];
-  } = {};
-
-  for (const [key, value] of new URL(
-    document.location.toString(),
-  ).searchParams.entries())
-    pluginConfig[key] = JSON.parse(value);
-
-  const listener = (e: PluginMessageResponse) => {
-    emit(e.data.type, e.data.result, e.data.error);
-  };
-
-  window.addEventListener('message', listener, false);
-  window.addEventListener('click', () => execPromise('wb:plugin:focus'));
-
-  on('wb:plugin:config:update', (config: PluginConfig<T>) => {
-    Object.assign(pluginConfig, config);
-    emit('config', pluginConfig.config ?? {});
-  });
-
-  // send initialize event
-  void execPromise(
-    'wb:plugin:init',
-    require('../../package.json').version,
-  ).then(config => {
-    Object.assign(pluginConfig, config);
-    emit('init', pluginConfig);
-    emit('config', pluginConfig.config);
-  });
-
-  on(
-    'wb:plugin:variable:update',
-    (updatedVariables: Record<string, WorkbookVariable>) => {
-      subscribedWorkbookVars = {};
-      Object.assign(subscribedWorkbookVars, updatedVariables);
-    },
-  );
-
-  on('wb:plugin:selection:update', (updatedInteractions: unknown) => {
-    subscribedInteractions = {};
-    Object.assign(subscribedInteractions, updatedInteractions);
-  });
-
-  function on(event: string, listener: Function) {
-    listeners[event] = listeners[event] || [];
-    listeners[event].push(listener);
-  }
-
-  function off(event: string, listener: Function) {
-    if (listeners[event] == null) return;
-    listeners[event] = listeners[event].filter(a => a !== listener);
-  }
-
-  function emit(event: string, ...args: any) {
-    Object.values(listeners[event] || []).forEach(fn => fn(...args));
-  }
-
-  function execPromise<R>(event: string, ...args: any): Promise<R> {
-    return new Promise((resolve, reject) => {
-      const callback = (data: R, error: any) => {
-        if (error) reject(error);
-        else resolve(data);
-        off(event, callback);
-      };
-      on(event, callback);
-      window.parent.postMessage(
-        { type: event, args, elementId: pluginConfig.id },
-        pluginConfig?.wbOrigin ?? '*',
-      );
-    });
-  }
-
-  return {
-    get sigmaEnv() {
-      return pluginConfig.sigmaEnv;
-    },
-
-    get isScreenshot() {
-      return pluginConfig.screenshot;
-    },
-
-    config: {
-      // @ts-ignore
-      getKey(key) {
-        return pluginConfig?.config?.[key]!;
-      },
-      get() {
-        return pluginConfig.config;
-      },
-      set(partialConfig) {
-        void execPromise('wb:plugin:config:update', partialConfig);
-      },
-      setKey(key, value) {
-        void execPromise('wb:plugin:config:update', {
-          [key]: value,
-        });
-      },
-      subscribe(listener) {
-        on('config', listener);
-        return () => off('config', listener);
-      },
-      getVariable(id: string): WorkbookVariable {
-        return subscribedWorkbookVars[id];
-      },
-      setVariable(id: string, ...values: unknown[]) {
-        void execPromise('wb:plugin:variable:set', id, ...values);
-      },
-      getInteraction(id: string) {
-        return subscribedInteractions[id];
-      },
-      setInteraction(
-        id: string,
-        elementId: string,
-        selection:
-          | string[]
-          | Array<Record<string, { type: string; val?: unknown }>>,
-      ) {
-        void execPromise('wb:plugin:selection:set', id, elementId, selection);
-      },
-      configureEditorPanel(options) {
-        void execPromise('wb:plugin:config:inspector', options);
-      },
-      setLoadingState(loadingState) {
-        void execPromise('wb:plugin:config:loading-state', loadingState);
-      },
-      subscribeToWorkbookVariable(
-        id: string,
-        callback: (input: WorkbookVariable) => void,
-      ): Unsubscriber {
-        const setValues = (values: Record<string, WorkbookVariable>) => {
-          callback(values[id]);
-        };
-        on('wb:plugin:variable:update', setValues);
-        return () => {
-          off('wb:plugin:variable:update', setValues);
-        };
-      },
-      subscribeToWorkbookInteraction(
-        id: string,
-        callback: (input: WorkbookSelection[]) => void,
-      ): Unsubscriber {
-        const setValues = (values: Record<string, WorkbookSelection[]>) => {
-          callback(values[id]);
-        };
-        on('wb:plugin:selection:update', setValues);
-        return () => {
-          off('wb:plugin:selection:update', setValues);
-        };
-      },
-    },
-    elements: {
-      getElementColumns(id) {
-        return execPromise('wb:plugin:element:columns:get', id);
-      },
-      subscribeToElementColumns(id, callback) {
-        const eventName = `wb:plugin:element:${id}:columns`;
-        on(eventName, callback);
-        void execPromise('wb:plugin:element:subscribe:columns', id);
-
-        return () => {
-          off(eventName, callback);
-          void execPromise('wb:plugin:element:unsubscribe:columns', id);
-        };
-      },
-      subscribeToElementData(id, callback) {
-        const eventName = `wb:plugin:element:${id}:data`;
-        on(eventName, callback);
-        void execPromise('wb:plugin:element:subscribe:data', id);
-
-        return () => {
-          off(eventName, callback);
-          void execPromise('wb:plugin:element:unsubscribe:data', id);
-        };
-      },
-    },
-    destroy() {
-      Object.keys(listeners).forEach(event => delete listeners[event]);
-      window.removeEventListener('message', listener, false);
-    },
-  };
-}

package/src/client/react/Context.ts

@@ -1,6 +0,0 @@
-import { createContext } from 'react';
-
-import { client } from 'client';
-import { PluginInstance } from 'types';
-
-export const PluginContext = createContext<PluginInstance>(client);

package/src/client/react/Provider.tsx

@@ -1,19 +0,0 @@
-import type { ReactNode } from 'react';
-
-import { PluginContext } from 'client/react/Context';
-import { PluginInstance } from 'types';
-
-export interface SigmaClientProviderProps<T = any> {
-  client: PluginInstance<T>;
-  children?: ReactNode;
-}
-
-export function SigmaClientProvider<T = any>(
-  props: SigmaClientProviderProps<T>,
-) {
-  return (
-    <PluginContext.Provider value={props.client}>
-      {props.children}
-    </PluginContext.Provider>
-  );
-}

package/src/client/react/hooks.ts

@@ -1,178 +0,0 @@
-import { useContext, useEffect, useCallback, useRef, useState } from 'react';
-
-import { PluginContext } from 'client/react/Context';
-import {
-  PluginInstance,
-  CustomPluginConfigOptions,
-  WorkbookElementColumns,
-  WorkbookElementData,
-  WorkbookSelection,
-  WorkbookVariable,
-} from 'types';
-import { deepEqual } from 'utils/deepEqual';
-
-/**
- * Gets the entire plugin instance
- * @returns {PluginInstance} Context for the current plugin instance
- */
-export function usePlugin(): PluginInstance<any> {
-  return useContext(PluginContext);
-}
-
-/**
- * Provides a setter for the Plugin's Config Options
- * @param {CustomPluginConfigOptions[]} nextOptions Updated possible Config Options
- */
-export function useEditorPanelConfig(
-  nextOptions: CustomPluginConfigOptions[],
-): void {
-  const client = usePlugin();
-  const optionsRef = useRef({});
-
-  useEffect(() => {
-    if (nextOptions == null) return;
-    if (!deepEqual(nextOptions, optionsRef.current)) {
-      client.config.configureEditorPanel(nextOptions);
-      optionsRef.current = nextOptions;
-    }
-  }, [client, nextOptions]);
-}
-
-/**
- * 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 function useLoadingState(
-  initialState: boolean,
-): [boolean, (nextState: boolean) => void] {
-  const client = usePlugin();
-  const [loading, setLoading] = useState(() => {
-    client.config.setLoadingState(initialState);
-    return initialState;
-  });
-
-  return [
-    loading,
-    nextState => {
-      if (nextState === loading) return;
-      setLoading(nextState);
-      client.config.setLoadingState(nextState);
-    },
-  ];
-}
-
-/**
- * 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
- */
-export function useElementColumns(id: string): WorkbookElementColumns {
-  const client = usePlugin();
-  const [columns, setColumns] = useState<WorkbookElementColumns>({});
-
-  useEffect(() => {
-    if (id) {
-      return client.elements.subscribeToElementColumns(id, setColumns);
-    }
-  }, [client, id]);
-
-  return columns;
-}
-
-/**
- * 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
- */
-export function useElementData(id: string): WorkbookElementData {
-  const client = usePlugin();
-  const [data, setData] = useState<WorkbookElementData>({});
-
-  useEffect(() => {
-    if (id) {
-      return client.elements.subscribeToElementData(id, setData);
-    }
-  }, [client, id]);
-
-  return data;
-}
-
-/**
- * Provides the latest value for entire config or certain key within the 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 function useConfig(key?: string): any {
-  const client = usePlugin();
-  const [config, setConfig] = useState<any>(
-    key != null ? client.config.getKey(key) : client.config.get(),
-  );
-
-  useEffect(
-    () =>
-      client.config.subscribe(newConfig => {
-        if (key != null && newConfig[key] !== config[key]) {
-          setConfig(newConfig[key]);
-        } else {
-          setConfig(newConfig);
-        }
-      }),
-    [client],
-  );
-
-  return config;
-}
-
-/**
- * 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
- */
-export function useVariable(
-  id: string,
-): [WorkbookVariable | undefined, Function] {
-  const client = usePlugin();
-  const [workbookVariable, setWorkbookVariable] = useState<WorkbookVariable>();
-
-  useEffect(() => {
-    return client.config.subscribeToWorkbookVariable(id, setWorkbookVariable);
-  }, [client, id]);
-
-  const setVariable = useCallback(
-    (...values: unknown[]) => client.config.setVariable(id, ...values),
-    [id],
-  );
-
-  return [workbookVariable, setVariable];
-}
-
-/**
- * React hook for accessing a workbook interaction selections state
- * @param {string} id ID of variable within Plugin Config to use
- * @returns {[(WorkbookSelection | undefined), Function]} Constantly updating selection state and setter thereof
- */
-export function useInteraction(
-  id: string,
-  elementId: string,
-): [unknown, Function] {
-  const client = usePlugin();
-  const [workbookInteraction, setWorkbookInteraction] =
-    useState<WorkbookSelection[]>();
-
-  useEffect(() => {
-    return client.config.subscribeToWorkbookInteraction(
-      id,
-      setWorkbookInteraction,
-    );
-  }, [client, id]);
-
-  const setInteraction = useCallback(
-    (value: WorkbookSelection[]) => {
-      client.config.setInteraction(id, elementId, value);
-    },
-    [id],
-  );
-
-  return [workbookInteraction, setInteraction];
-}

package/src/client/react/index.tsx

@@ -1,9 +0,0 @@
-export * from 'client';
-
-export * from 'client/react/hooks';
-export {
-  SigmaClientProviderProps,
-  SigmaClientProvider,
-} from 'client/react/Provider';
-
-export * from 'types';

package/src/index.ts

@@ -1,2 +0,0 @@
-export * from 'client';
-export * from 'types';

package/src/types.ts

@@ -1,322 +0,0 @@
-export type ScalarType = 'boolean' | 'datetime' | 'number' | 'integer' | 'text';
-export type PrimitiveType = ScalarType | 'variant' | 'link';
-export type ValueType = PrimitiveType | 'error';
-
-/**
- * All mutable workbook control variable types
- */
-export type ControlType =
-  | 'boolean'
-  | 'date'
-  | 'number'
-  | 'text'
-  | 'text-list'
-  | 'number-list'
-  | 'date-list'
-  | 'number-range'
-  | 'date-range';
-
-export interface PluginConfig<T> {
-  id: string;
-  config: T;
-  screenshot: boolean;
-  [key: string]: any;
-}
-
-/**
- * @typedef {object} WorkbookVariable
- * @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;
-  defaultValue: { type: string };
-}
-
-export type WorkbookSelection = Record<string, { type: string; val?: unknown }>;
-
-export type PluginMessageResponse = MessageEvent<{
-  type: string;
-  result: any[];
-  error: any;
-}>;
-
-export interface WbElement {
-  id: string;
-}
-
-/**
- * @typedef {object} WorkbookElementData
- * @property {Object<string, any>} data Workbook data sorted by column ID
- */
-export interface WorkbookElementData {
-  [colId: string]: any[];
-}
-
-/**
- * Column data
- * @typedef {object} WorkbookElementColumn
- * @property {string} id Column ID
- * @property {string} name Column Name
- * @property {string} columnType Type of data contained within column
- */
-export interface WorkbookElementColumn {
-  id: string;
-  name: string;
-  columnType: ValueType;
-}
-
-/**
- * Record of Column data with corresponding IDs
- * @typedef {object} WorkbookElementColumns
- * @property {Object<string, WorkbookElementColumn>} column Column ID and corresponding column data
- */
-export interface WorkbookElementColumns {
-  [colId: string]: WorkbookElementColumn;
-}
-
-/**
- * Function to Unsubscribe from the corresponding elements
- * @typedef {() => void} Unsubscriber
- */
-export type Unsubscriber = () => void;
-
-/**
- * Different types Plugin Config Options
- * @typedef {object} CustomPluginConfigOptions
- * @property {string} type Type of config option
- * @property {string} name Name ID of config option
- * @property {(string | undefined)} label Displayed label for config option
- */
-export type CustomPluginConfigOptions =
-  | {
-      type: 'group';
-      name: string;
-      label?: string;
-    }
-  | {
-      type: 'element';
-      name: string;
-      label?: string;
-    }
-  | {
-      type: 'column';
-      name: string;
-      label?: string;
-      allowedTypes?: ValueType[];
-      source: string;
-      allowMultiple: boolean;
-    }
-  | {
-      type: 'text';
-      name: string;
-      label?: string;
-      source?: string; // can point to a group or element config
-      // if true will omit from prehydrated configs passed through querystring
-      secure?: boolean;
-      multiline?: boolean;
-      placeholder?: string;
-      defaultValue?: string;
-    }
-  | {
-      type: 'toggle';
-      name: string;
-      label?: string;
-      source?: string;
-      defaultValue?: boolean;
-    }
-  | {
-      type: 'checkbox';
-      name: string;
-      label?: string;
-      source?: string;
-      defaultValue?: boolean;
-    }
-  | {
-      type: 'radio';
-      name: string;
-      label?: string;
-      source?: string;
-      values: string[];
-      singleLine?: boolean;
-      defaultValue?: string;
-    }
-  | {
-      type: 'dropdown';
-      name: string;
-      label?: string;
-      source?: string;
-      width?: string;
-      values: string[];
-      defaultValue?: string;
-    }
-  | {
-      type: 'color';
-      name: string;
-      label?: string;
-      source?: string;
-    }
-  | {
-      type: 'variable';
-      name: string;
-      label?: string;
-      allowedTypes?: ControlType[];
-    }
-  | {
-      type: 'interaction';
-      name: string;
-      label?: string;
-    };
-
-/**
- * @typedef {object} PluginInstance
- * @template T Type of Config passed in
- * @property {string} sigmaEnv Permissions within Sigma Environment
- * @property {object} config Set of helper functions for interacting with Plugin Config
- * @property {object} elements Set of helper functions for interacting with Workbook Element Data
- * @property {Function} destroy Destroys Plugin Instance and removes all subscriptions
- */
-export interface PluginInstance<T = any> {
-  sigmaEnv: 'author' | 'viewer' | 'explorer';
-
-  config: {
-    /**
-     * Getter for entire Plugin Config
-     * @template T Config type to be passed in
-     * @returns {Partial<T>} Current Plugin Config
-     */
-    get(): Partial<T> | undefined;
-
-    /**
-     * Performs a shallow merge between current config and passed in config
-     * @template T Config type to be passed in
-     * @param {Partial<T>} config Config to directly assign
-     */
-    set(config: Partial<T>): void;
-
-    /**
-     * Getter for key within plugin config
-     * @template K Possible key within CustomPluginConfigOptions
-     * @param {K} key Key within config to retrieve
-     * @returns Value within config for passed in key
-     */
-    getKey<K extends keyof T>(key: K): Pick<T, K>;
-
-    /**
-     * Assigns key value pair within plugin
-     * @template K Possible key within CustomPluginConfigOptions
-     * @template V Value corresponding to K
-     * @param {K} key Key within config to set
-     * @param {V} value New value to set key to
-     */
-    setKey<K extends keyof T>(key: K, value: Pick<T, K>): void;
-
-    /**
-     * Subscriber for Plugin Config
-     * @param {Function} listener Function to be called upon changes to Plugin Config
-     */
-    subscribe(listener: (arg0: T) => void): Unsubscriber;
-
-    /**
-     * Set possible options for plugin config
-     * @param {CustomPluginConfigOptions[]} options Possible config options
-     */
-    configureEditorPanel(options: CustomPluginConfigOptions[]): void;
-
-    /**
-     * Gets a static image of a workbook variable
-     * @param {string} id ID of the workbook variable in config
-     * @returns {WorkbookVariable} Current value of the workbook variable
-     */
-    getVariable(id: string): WorkbookVariable;
-
-    /**
-     * Setter for workbook variable passed in
-     * @param {string} id ID of the workbook variable in config
-     * @param {unknown[]} values Values to assign to the workbook variable
-     */
-    setVariable(id: string, ...values: unknown[]): void;
-
-    /**
-     * Getter for interaction selection state
-     * @param {string} id ID from interaction type in Plugin Config
-     */
-    getInteraction(id: string): WorkbookSelection[];
-
-    /**
-     * Setter for interaction selection state
-     * @param {string} id ID from interaction type in Plugin Config
-     * @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;
-
-    /**
-     * Overrider function for Config Ready state
-     * @param {boolean} loadingState Boolean representing if Plugin Config is still loading
-     */
-    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
-     * @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;
-
-    /**
-     * Allows users to subscribe to changes in the passed in interaction ID
-     * @param {string} id ID of the interaction variable within Plugin Config
-     * @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;
-  };
-
-  elements: {
-    /**
-     * Getter for Column Data by parent sheet ID
-     * @param {string} id Sheet ID to retrieve columns from
-     * @returns {WorkbookElementColumns} Column values contained within corresponding sheet
-     */
-    getElementColumns(id: string): Promise<WorkbookElementColumns>;
-
-    /**
-     * Subscriber to changes in column data by ID
-     * @param {string} id Column ID to subscribe to
-     * @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;
-
-    /**
-     * Subscriber for the data within a given sheet
-     * @param {string} id Sheet ID to get element data from
-     * @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;
-  };
-
-  /**
-   * Destroys plugin instance and removes all subscribers
-   */
-  destroy(): void;
-}

package/src/utils/deepEqual.ts

@@ -1,23 +0,0 @@
-function isObject(obj: any) {
-  if (typeof obj === 'object' && obj != null) {
-    return true;
-  } else {
-    return false;
-  }
-}
-
-export function deepEqual(obj1: any, obj2: any) {
-  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;
-  }
-}