@sigmacomputing/plugin 0.7.57 → 1.0.0-rc.2

package/dist/types.d.ts

@@ -0,0 +1,262 @@
+export declare type ScalarType = 'boolean' | 'datetime' | 'number' | 'integer' | 'text';
+export declare type PrimitiveType = ScalarType | 'variant' | 'link';
+export declare type ValueType = PrimitiveType | 'error';
+/**
+ * All mutable workbook control variable types
+ */
+export declare 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 declare type WorkbookSelection = Record<string, {
+    type: string;
+    val?: unknown;
+}>;
+export declare 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 declare 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 declare 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;
+    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;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +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,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,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"}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/deepEqual.d.ts.map

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

package/dist/utils/deepEqual.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deepEqual = void 0;
+function isObject(obj) {
+    if (typeof obj === 'object' && obj != null) {
+        return true;
+    }
+    else {
+        return false;
+    }
+}
+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;
+    }
+}
+exports.deepEqual = deepEqual;

package/jest.config.ts

@@ -0,0 +1,22 @@
+import path from 'path';
+import { Config } from '@jest/types';
+
+const config: Config.InitialOptions = {
+  globals: {
+    'ts-jest': {
+      tsconfig: path.resolve(__dirname, 'tsconfig.json'),
+      isolatedModules: true,
+    },
+  },
+
+  preset: 'ts-jest',
+  testEnvironment: 'jsdom',
+  testMatch: ['<rootDir>/src/**/*.{spec,test}.{js,jsx,ts,tsx}'],
+
+  watchPlugins: [
+    'jest-watch-typeahead/filename',
+    'jest-watch-typeahead/testname',
+  ],
+};
+
+export default config;

package/package.json

@@ -1,34 +1,67 @@
 {
   "name": "@sigmacomputing/plugin",
-  "version": "0.7.57",
-  "description": "Plugin client api",
+  "version": "1.0.0-rc.2",
+  "description": "Sigma Computing Plugin Client API",
+  "license": "MIT",
+  "homepage": "https://github.com/sigmacomputing/plugin",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sigmacomputing/plugin.git"
+  },
+  "bugs": {
+    "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"
+    "/dist",
+    "/src",
+    "!/src/**/__tests__/**"
   ],
+  "exports": {
+    ".": "./dist/index.js",
+    "./react": "./dist/client/react/index.js",
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "react": [
+        "dist/client/react/index.d.ts"
+      ]
+    }
+  },
   "scripts": {
     "clean": "rimraf dist tsconfig*.tsbuildinfo",
     "build": "yarn clean && yarn tsc",
     "build:watch": "yarn build --watch",
-    "format": "prettier --write 'src/**/*.ts' 'jest.config.ts' '.eslintrc.js'",
-    "lint": "eslint --cache src jest.config.ts .eslintrc.js",
-    "lint:clean": "rimraf .eslintcache",
-    "lint:fix": "yarn lint --fix",
-    "prepublish": "yarn clean && tsc --build tsconfig.publish.json",
-    "test": "cd ../.. && jest --ci --selectProjects @sigmacomputing/plugin",
+    "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"
-  },
-  "dependencies": {
-    "@sigmacomputing/plugin-types": "^0.7.57"
-  },
-  "devDependencies": {
-    "@jest/types": "^27.5.1"
+    "tsc": "ttsc --build tsconfig.build.json"
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0"
   },
-  "gitHead": "d160042372302f61d74e9f321cd71aacfb2712e5"
+  "devDependencies": {
+    "@jest/types": "^27.5.1",
+    "@types/jest": "^27.5.1",
+    "@types/node": "^18.7.14",
+    "@types/react": "^18.0.18",
+    "@types/react-dom": "^18.0.6",
+    "jest": "^27.5.1",
+    "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",
+    "typescript": "^4.8.2",
+    "typescript-transform-paths": "^3.3.1"
+  }
 }

package/src/client/__tests__/initialize.test.ts

@@ -0,0 +1,30 @@
+import { initialize } from '../initialize';
+
+describe('initialize', () => {
+  let originalAddEventListener: any;
+  let originalRemoveEventListener: any;
+
+  beforeAll(() => {
+    originalAddEventListener = window.addEventListener;
+    originalRemoveEventListener = window.removeEventListener;
+    window.addEventListener = jest.fn();
+    window.removeEventListener = jest.fn();
+  });
+
+  beforeEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it('should initialize and be destroyable', () => {
+    const client = initialize();
+    expect(window.addEventListener).toHaveBeenCalled();
+
+    client.destroy();
+    expect(window.removeEventListener).toHaveBeenCalled();
+  });
+
+  afterAll(() => {
+    window.addEventListener = originalAddEventListener;
+    window.removeEventListener = originalRemoveEventListener;
+  });
+});

package/src/client/index.ts

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

package/src/client/initialize.ts

@@ -0,0 +1,199 @@
+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

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

package/src/client/react/Provider.tsx

@@ -0,0 +1,19 @@
+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>
+  );
+}