@sigmacomputing/plugin 0.7.46 → 0.7.47

package/dist/initialize.d.ts.map

@@ -1 +1 @@
-{"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,CAiK7D"}
+{"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.js

@@ -30,7 +30,7 @@ function initialize() {
         subscribedWorkbookVars = {};
         Object.assign(subscribedWorkbookVars, updatedVariables);
     });
-    on('wb:plugin:interaction:update', (updatedInteractions) => {
+    on('wb:plugin:selection:update', (updatedInteractions) => {
         subscribedInteractions = {};
         Object.assign(subscribedInteractions, updatedInteractions);
     });
@@ -94,6 +94,12 @@ function initialize() {
             setVariable(id, ...values) {
                 void execPromise('wb:plugin:variable:set', id, ...values);
             },
+            getInteraction(id) {
+                return subscribedInteractions[id];
+            },
+            setInteraction(id, elementId, selection) {
+                void execPromise('wb:plugin:selection:set', id, elementId, selection);
+            },
             configureEditorPanel(options) {
                 void execPromise('wb:plugin:config:inspector', options);
             },
@@ -109,6 +115,15 @@ function initialize() {
                     off('wb:plugin:variable:update', setValues);
                 };
             },
+            subscribeToWorkbookInteraction(id, callback) {
+                const setValues = (values) => {
+                    callback(values[id]);
+                };
+                on('wb:plugin:selection:update', setValues);
+                return () => {
+                    off('wb:plugin:selection:update', setValues);
+                };
+            },
         },
         elements: {
             getElementColumns(id) {

package/dist/react/index.d.ts

@@ -49,4 +49,10 @@ export declare function useConfig(key?: string): any;
  * @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 +1 @@
-{"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"}
+{"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"}

package/dist/react/index.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useVariable = exports.useConfig = exports.useElementData = exports.useElementColumns = exports.useLoadingState = exports.useEditorPanelConfig = exports.usePlugin = exports.SigmaClientProvider = void 0;
+exports.useInteraction = exports.useVariable = exports.useConfig = exports.useElementData = exports.useElementColumns = exports.useLoadingState = exports.useEditorPanelConfig = exports.usePlugin = exports.SigmaClientProvider = void 0;
 const jsx_runtime_1 = require("react/jsx-runtime");
 const react_1 = __importStar(require("react"));
 const deepEqual_1 = require("../deepEqual");
@@ -152,3 +152,22 @@ function useVariable(id) {
     ];
 }
 exports.useVariable = useVariable;
+/**
+ * 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
+ */
+function useInteraction(id, elementId) {
+    const client = usePlugin();
+    const [workbookInteraction, setWorkbookInteraction] = (0, react_1.useState)();
+    (0, react_1.useEffect)(() => {
+        return client.config.subscribeToWorkbookInteraction(id, setWorkbookInteraction);
+    }, [client, id]);
+    return [
+        workbookInteraction,
+        react_1.default.useCallback((value) => {
+            client.config.setInteraction(id, elementId, value);
+        }, [id]),
+    ];
+}
+exports.useInteraction = useInteraction;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sigmacomputing/plugin",
-  "version": "0.7.46",
+  "version": "0.7.47",
   "description": "Plugin client api",
   "module": "./src/index.ts",
   "main": "./dist/index.js",
@@ -18,16 +18,16 @@
     "lint": "eslint --cache src jest.config.js .eslintrc.js",
     "lint:clean": "rimraf .eslintcache",
     "lint:fix": "yarn lint --fix",
-    "prepublish": "yarn build",
+    "prepublish": "yarn clean && tsc --build tsconfig.publish.json",
     "test": "cd ../.. && jest --ci --selectProjects @sigmacomputing/plugin",
     "test:watch": "yarn test --watch",
     "tsc": "tsc --build tsconfig.build.json"
   },
   "dependencies": {
-    "@sigmacomputing/plugin-types": "^0.7.46"
+    "@sigmacomputing/plugin-types": "^0.7.47"
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0 | ^18.0.0"
   },
-  "gitHead": "c8725f7c064315802d07b792b25f71da525c2516"
+  "gitHead": "146efa6343e32c1abb44287804c424db219a7d28"
 }

package/src/initialize.ts

@@ -4,7 +4,7 @@ export function initialize<T = {}>(): plugin.PluginInstance<T> {
   const pluginConfig: Partial<plugin.PluginConfig<T>> = {
     config: {} as T,
   };
-  let subscribedInteractions: Record<string, unknown> = {};
+  let subscribedInteractions: Record<string, plugin.WorkbookSelection[]> = {};
   let subscribedWorkbookVars: Record<string, plugin.WorkbookVariable> = {};
 
   const listeners: {
@@ -45,7 +45,7 @@ export function initialize<T = {}>(): plugin.PluginInstance<T> {
     },
   );
 
-  on('wb:plugin:interaction:update', (updatedInteractions: unknown) => {
+  on('wb:plugin:selection:update', (updatedInteractions: unknown) => {
     subscribedInteractions = {};
     Object.assign(subscribedInteractions, updatedInteractions);
   });
@@ -112,6 +112,18 @@ export function initialize<T = {}>(): plugin.PluginInstance<T> {
       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);
       },
@@ -130,6 +142,20 @@ export function initialize<T = {}>(): plugin.PluginInstance<T> {
           off('wb:plugin:variable:update', setValues);
         };
       },
+      subscribeToWorkbookInteraction(
+        id: string,
+        callback: (input: plugin.WorkbookSelection[]) => void,
+      ): plugin.Unsubscriber {
+        const setValues = (
+          values: Record<string, plugin.WorkbookSelection[]>,
+        ) => {
+          callback(values[id]);
+        };
+        on('wb:plugin:selection:update', setValues);
+        return () => {
+          off('wb:plugin:selection:update', setValues);
+        };
+      },
     },
     elements: {
       getElementColumns(id) {

package/src/react/index.tsx

@@ -152,3 +152,32 @@ export function useVariable(
     ),
   ];
 }
+
+/**
+ * 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 function useInteraction(
+  id: string,
+  elementId: string,
+): [unknown, Function] {
+  const client = usePlugin();
+  const [workbookInteraction, setWorkbookInteraction] =
+    useState<plugin.WorkbookSelection[]>();
+  useEffect(() => {
+    return client.config.subscribeToWorkbookInteraction(
+      id,
+      setWorkbookInteraction,
+    );
+  }, [client, id]);
+  return [
+    workbookInteraction,
+    React.useCallback(
+      (value: plugin.WorkbookSelection[]) => {
+        client.config.setInteraction(id, elementId, value);
+      },
+      [id],
+    ),
+  ];
+}