@sigmacomputing/plugin 0.7.47 → 0.7.50

package/package.json

@@ -1,14 +1,12 @@
 {
   "name": "@sigmacomputing/plugin",
-  "version": "0.7.47",
+  "version": "0.7.50",
   "description": "Plugin client api",
   "module": "./src/index.ts",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
-    "/dist",
-    "/src",
-    "!/src/**/__tests__/**"
+    "/dist"
   ],
   "scripts": {
     "clean": "rimraf dist tsconfig*.tsbuildinfo",
@@ -24,10 +22,10 @@
     "tsc": "tsc --build tsconfig.build.json"
   },
   "dependencies": {
-    "@sigmacomputing/plugin-types": "^0.7.47"
+    "@sigmacomputing/plugin-types": "^0.7.50"
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0 | ^18.0.0"
   },
-  "gitHead": "146efa6343e32c1abb44287804c424db219a7d28"
+  "gitHead": "8bb6bcf1bf89d51b97c3132a1a21d69fb911be44"
 }

package/src/client.ts

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

package/src/deepEqual.ts

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

package/src/index.ts

@@ -1,8 +0,0 @@
-export { initialize } from './initialize';
-export { client } from './client';
-/* Ideally we want this to be tree-shakeable.
- * Node 12 added support for `exports` in package.json,
- * however typescript does not yet support this.
- * Tracked: https://github.com/microsoft/TypeScript/issues/33079
- */
-export * from './react';

package/src/initialize.test.ts

@@ -1,28 +0,0 @@
-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();
-  });
-  test('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/initialize.ts

@@ -1,190 +0,0 @@
-import * as plugin from '@sigmacomputing/plugin-types';
-
-export function initialize<T = {}>(): plugin.PluginInstance<T> {
-  const pluginConfig: Partial<plugin.PluginConfig<T>> = {
-    config: {} as T,
-  };
-  let subscribedInteractions: Record<string, plugin.WorkbookSelection[]> = {};
-  let subscribedWorkbookVars: Record<string, plugin.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: plugin.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: plugin.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, plugin.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): plugin.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: plugin.WorkbookVariable) => void,
-      ): plugin.Unsubscriber {
-        const setValues = (values: Record<string, plugin.WorkbookVariable>) => {
-          callback(values[id]);
-        };
-        on('wb:plugin:variable:update', setValues);
-        return () => {
-          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) {
-        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: function () {
-      Object.keys(listeners).forEach(event => delete listeners[event]);
-      window.removeEventListener('message', listener, false);
-    },
-  };
-}

package/src/react/index.tsx

@@ -1,183 +0,0 @@
-import React, {
-  Context,
-  createContext,
-  useContext,
-  useEffect,
-  useRef,
-  useState,
-} from 'react';
-import * as plugin from '@sigmacomputing/plugin-types';
-
-import { deepEqual } from '../deepEqual';
-import { client } from '../client';
-
-const Context = createContext<plugin.PluginInstance<any>>(client);
-
-/**
- * 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 function SigmaClientProvider(props: {
-  client: plugin.PluginInstance<any>;
-  children?: React.ReactChildren;
-}) {
-  return (
-    <Context.Provider value={props.client}>{props.children}</Context.Provider>
-  );
-}
-
-/**
- * A constantly updating getter for the entire Plugin Instance
- * @returns {plugin.PluginInstance} Context for the current plugin instance
- */
-export function usePlugin(): plugin.PluginInstance<any> {
-  return useContext(Context);
-}
-
-/**
- * Provides a setter for the Plugin's Config Options
- * @param {plugin.CustomPluginConfigOptions[]} nextOptions Updated possible Config Options
- */
-export function useEditorPanelConfig(
-  nextOptions: plugin.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 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 function useElementColumns(id: string): plugin.WbElementColumns {
-  const client = usePlugin();
-  const [columns, setColumns] = useState<plugin.WbElementColumns>({});
-  useEffect(() => {
-    if (id) {
-      return client.elements.subscribeToElementColumns(id, setColumns);
-    }
-  }, [client, id]);
-  return columns;
-}
-
-/**
- * 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 function useElementData(id: string): plugin.WbElementData {
-  const client = usePlugin();
-  const [data, setData] = useState<plugin.WbElementData>({});
-  useEffect(() => {
-    if (id) return client.elements.subscribeToElementData(id, setData);
-  }, [client, id]);
-  return data;
-}
-
-/**
- * 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 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 {[(plugin.WorkbookVariable | undefined), Function]} Constantly updating value of the variable and setter for the variable
- */
-export function useVariable(
-  id: string,
-): [plugin.WorkbookVariable | undefined, Function] {
-  const client = usePlugin();
-  const [workbookVariable, setWorkbookVariable] =
-    useState<plugin.WorkbookVariable>();
-  useEffect(() => {
-    return client.config.subscribeToWorkbookVariable(id, setWorkbookVariable);
-  }, [client, id]);
-  return [
-    workbookVariable,
-    React.useCallback(
-      (...values: unknown[]) => client.config.setVariable(id, ...values),
-      [id],
-    ),
-  ];
-}
-
-/**
- * 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],
-    ),
-  ];
-}