@sigmacomputing/plugin 1.1.1 → 1.2.0

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":["React","React"],"sources":["../../src/utils/deepEqual.ts","../../src/utils/error.ts","../../src/client/initialize.ts","../../src/client.ts","../../src/react/Context.ts","../../src/react/hooks.ts","../../src/react/Provider.tsx","../../src/utils/polyfillRequestAnimationFrame.ts"],"sourcesContent":["function isObject(obj: any) {\n  if (typeof obj === 'object' && obj != null) {\n    return true;\n  } else {\n    return false;\n  }\n}\n\nexport function deepEqual(obj1: any, obj2: any) {\n  if (obj1 === obj2) {\n    return true;\n  } else if (isObject(obj1) && isObject(obj2)) {\n    if (Object.keys(obj1).length !== Object.keys(obj2).length) {\n      return false;\n    }\n    for (const prop in obj1) {\n      if (!deepEqual(obj1[prop], obj2[prop])) {\n        return false;\n      }\n    }\n    return true;\n  }\n}\n","import { CustomPluginConfigOptions } from '../types';\n\nexport function validateConfigId(\n  configId: string,\n  expectedConfigType: CustomPluginConfigOptions['type'],\n) {\n  if (configId === undefined) {\n    console.warn(`Invalid config ${expectedConfigType}: ${configId}`);\n  }\n}\n","import {\n  PluginConfig,\n  PluginInstance,\n  PluginMessageResponse,\n  PluginStyle,\n  UrlParameter,\n  WorkbookSelection,\n  WorkbookVariable,\n} from '../types';\nimport { validateConfigId } from '../utils/error';\n\nexport function initialize<T = {}>(): PluginInstance<T> {\n  const pluginConfig: Partial<PluginConfig<T>> = {\n    config: {} as T,\n  };\n\n  let subscribedInteractions: Record<string, WorkbookSelection[]> = {};\n  let subscribedWorkbookVars: Record<string, WorkbookVariable> = {};\n  let subscribedUrlParameters: Record<string, UrlParameter> = {};\n  const registeredEffects: Record<string, () => void> = {};\n\n  const listeners: {\n    [event: string]: Function[];\n  } = {};\n\n  const location = new URL(document.location.href);\n  for (const [key, value] of location.searchParams.entries()) {\n    try {\n      pluginConfig[key] = JSON.parse(value);\n    } catch (_err: unknown) {\n      if (__VITEST_BROWSER__ && (key === 'iframeId' || key === 'sessionId')) {\n        // noop: vitest browser injects these into the test iframe URL\n      } else {\n        console.error(\n          `Failed to parse URL param ${key} with value ${value} as JSON.`,\n        );\n      }\n    }\n  }\n\n  const listener = (e: PluginMessageResponse) => {\n    emit(e.data.type, e.data.result, e.data.error);\n  };\n\n  window.addEventListener('message', listener, false);\n  window.addEventListener('click', () => execPromise('wb:plugin:focus'));\n\n  on('wb:plugin:config:update', (config: PluginConfig<T>) => {\n    Object.assign(pluginConfig, config);\n    emit('config', pluginConfig.config ?? {});\n  });\n\n  // send initialize event\n  void execPromise('wb:plugin:init', __VERSION__).then(config => {\n    Object.assign(pluginConfig, config);\n    emit('init', pluginConfig);\n    emit('config', pluginConfig.config);\n  });\n\n  on(\n    'wb:plugin:variable:update',\n    (updatedVariables: Record<string, WorkbookVariable>) => {\n      subscribedWorkbookVars = {};\n      Object.assign(subscribedWorkbookVars, updatedVariables);\n    },\n  );\n\n  on('wb:plugin:selection:update', (updatedInteractions: unknown) => {\n    subscribedInteractions = {};\n    Object.assign(subscribedInteractions, updatedInteractions);\n  });\n\n  on(\n    'wb:plugin:url-parameter:update',\n    (updatedUrlParameters: Record<string, UrlParameter>) => {\n      subscribedUrlParameters = {};\n      Object.assign(subscribedUrlParameters, updatedUrlParameters);\n    },\n  );\n\n  on('wb:plugin:action-effect:invoke', (configId: string) => {\n    const effect = registeredEffects[configId];\n    if (!effect) {\n      throw new Error(`Unknown action effect with name: ${configId}`);\n    }\n    effect();\n  });\n\n  function on(event: string, listener: Function) {\n    listeners[event] = listeners[event] || [];\n    listeners[event].push(listener);\n  }\n\n  function off(event: string, listener: Function) {\n    if (listeners[event] == null) return;\n    listeners[event] = listeners[event].filter(a => a !== listener);\n  }\n\n  function emit(event: string, ...args: any) {\n    Object.values(listeners[event] || []).forEach(fn => fn(...args));\n  }\n\n  function execPromise<R>(event: string, ...args: any): Promise<R> {\n    return new Promise((resolve, reject) => {\n      const callback = (data: R, error: any) => {\n        if (error) reject(error);\n        else resolve(data);\n        off(event, callback);\n      };\n      on(event, callback);\n      window.parent.postMessage(\n        { type: event, args, elementId: pluginConfig.id },\n        pluginConfig?.wbOrigin ?? '*',\n      );\n    });\n  }\n\n  return {\n    get sigmaEnv() {\n      return pluginConfig.sigmaEnv;\n    },\n\n    get isScreenshot() {\n      return pluginConfig.screenshot;\n    },\n\n    config: {\n      // @ts-ignore TODO: Fix\n      getKey(key) {\n        return pluginConfig?.config?.[key];\n      },\n      get() {\n        return pluginConfig.config;\n      },\n      set(partialConfig) {\n        void execPromise('wb:plugin:config:update', partialConfig);\n      },\n      setKey(key, value) {\n        void execPromise('wb:plugin:config:update', {\n          [key]: value,\n        });\n      },\n      subscribe(listener) {\n        on('config', listener);\n        return () => off('config', listener);\n      },\n      getVariable(configId: string) {\n        validateConfigId(configId, 'variable');\n        return subscribedWorkbookVars[configId];\n      },\n      setVariable(configId: string, ...values: unknown[]) {\n        validateConfigId(configId, 'variable');\n        void execPromise('wb:plugin:variable:set', configId, ...values);\n      },\n      getInteraction(configId: string) {\n        validateConfigId(configId, 'interaction');\n        return subscribedInteractions[configId];\n      },\n      setInteraction(\n        configId: string,\n        elementId: string,\n        selection:\n          | string[]\n          | Array<Record<string, { type: string; val?: unknown }>>,\n      ) {\n        validateConfigId(configId, 'interaction');\n        void execPromise(\n          'wb:plugin:selection:set',\n          configId,\n          elementId,\n          selection,\n        );\n      },\n      triggerAction(configId: string) {\n        validateConfigId(configId, 'action-trigger');\n        void execPromise('wb:plugin:action-trigger:invoke', configId);\n      },\n      registerEffect(configId: string, effect: () => void) {\n        validateConfigId(configId, 'action-effect');\n        registeredEffects[configId] = effect;\n        return () => {\n          delete registeredEffects[configId];\n        };\n      },\n      configureEditorPanel(options) {\n        void execPromise('wb:plugin:config:inspector', options);\n      },\n      setLoadingState(loadingState) {\n        void execPromise('wb:plugin:config:loading-state', loadingState);\n      },\n      subscribeToWorkbookVariable(configId, callback) {\n        validateConfigId(configId, 'variable');\n        const setValues = (values: Record<string, WorkbookVariable>) => {\n          callback(values[configId]);\n        };\n        on('wb:plugin:variable:update', setValues);\n        return () => {\n          off('wb:plugin:variable:update', setValues);\n        };\n      },\n      subscribeToWorkbookInteraction(configId, callback) {\n        validateConfigId(configId, 'interaction');\n        const setValues = (values: Record<string, WorkbookSelection[]>) => {\n          callback(values[configId]);\n        };\n        on('wb:plugin:selection:update', setValues);\n        return () => {\n          off('wb:plugin:selection:update', setValues);\n        };\n      },\n      subscribeToUrlParameter(configId, callback) {\n        validateConfigId(configId, 'url-parameter');\n        const setValues = (values: Record<string, UrlParameter>) => {\n          callback(values[configId]);\n        };\n        setValues(subscribedUrlParameters);\n        on('wb:plugin:url-parameter:update', setValues);\n        return () => {\n          off('wb:plugin:url-parameter:update', setValues);\n        };\n      },\n      getUrlParameter(configId: string) {\n        validateConfigId(configId, 'url-parameter');\n        return subscribedUrlParameters[configId];\n      },\n      setUrlParameter(configId: string, value: string) {\n        validateConfigId(configId, 'url-parameter');\n        void execPromise('wb:plugin:url-parameter:set', configId, value);\n      },\n    },\n    elements: {\n      getElementColumns(configId) {\n        validateConfigId(configId, 'element');\n        return execPromise('wb:plugin:element:columns:get', configId);\n      },\n      subscribeToElementColumns(configId, callback) {\n        validateConfigId(configId, 'element');\n        const eventName = `wb:plugin:element:${configId}:columns`;\n        on(eventName, callback);\n        void execPromise('wb:plugin:element:subscribe:columns', configId);\n\n        return () => {\n          off(eventName, callback);\n          void execPromise('wb:plugin:element:unsubscribe:columns', configId);\n        };\n      },\n      subscribeToElementData(configId, callback) {\n        validateConfigId(configId, 'element');\n        const eventName = `wb:plugin:element:${configId}:data`;\n        on(eventName, callback);\n        void execPromise('wb:plugin:element:subscribe:data', configId);\n\n        return () => {\n          off(eventName, callback);\n          void execPromise('wb:plugin:element:unsubscribe:data', configId);\n        };\n      },\n      fetchMoreElementData(configId) {\n        validateConfigId(configId, 'element');\n        void execPromise('wb:plugin:element:fetch-more', configId);\n      },\n    },\n\n    style: {\n      subscribe(callback: (style: PluginStyle) => void) {\n        on('wb:plugin:style:update', callback);\n        return () => off('wb:plugin:style:update', callback);\n      },\n\n      get() {\n        return execPromise('wb:plugin:style:get');\n      },\n    },\n\n    destroy() {\n      Object.keys(listeners).forEach(event => delete listeners[event]);\n      window.removeEventListener('message', listener, false);\n    },\n  };\n}\n","import { initialize } from './client/initialize';\n\nexport const client = initialize();\n","import * as React from 'react';\n\nimport { client } from '../client';\nimport { PluginInstance } from '../types';\n\nexport const PluginContext = React.createContext<PluginInstance>(client);\n","import * as React from 'react';\n\nimport {\n  PluginInstance,\n  CustomPluginConfigOptions,\n  WorkbookElementColumns,\n  WorkbookElementData,\n  WorkbookSelection,\n  WorkbookVariable,\n  PluginStyle,\n  UrlParameter,\n} from '../types';\nimport { deepEqual } from '../utils/deepEqual';\n\nimport { PluginContext } from './Context';\n\n/**\n * Gets the entire plugin instance\n * @returns {PluginInstance} Context for the current plugin instance\n */\nexport function usePlugin(): PluginInstance<any> {\n  return React.useContext(PluginContext);\n}\n\n/**\n * Provides a setter for the Plugin's Config Options\n * @param {CustomPluginConfigOptions[]} nextOptions Updated possible Config Options\n */\nexport function useEditorPanelConfig(\n  nextOptions: CustomPluginConfigOptions[],\n): void {\n  const client = usePlugin();\n  const optionsRef = React.useRef({});\n\n  React.useEffect(() => {\n    if (nextOptions == null) return;\n    if (!deepEqual(nextOptions, optionsRef.current)) {\n      client.config.configureEditorPanel(nextOptions);\n      optionsRef.current = nextOptions;\n    }\n  }, [client, nextOptions]);\n}\n\n/**\n * React hook for Plugin Config loading state\n * @param {boolean} initialState Initial value to set loading state to\n * @returns {[boolean, Function]} Boolean value corresponding to loading state for plugin config and setter for loading state\n */\nexport function useLoadingState(\n  initialState: boolean,\n): [boolean, (nextState: boolean) => void] {\n  const client = usePlugin();\n  const [loading, setLoading] = React.useState(() => {\n    client.config.setLoadingState(initialState);\n    return initialState;\n  });\n\n  return [\n    loading,\n    nextState => {\n      if (nextState === loading) return;\n      setLoading(nextState);\n      client.config.setLoadingState(nextState);\n    },\n  ];\n}\n\n/**\n * Provides the latest column values from corresponding config element\n * @param {string} configId ID from the config for fetching element columns, with type: 'element'\n * @returns {WorkbookElementColumns} Values of corresponding columns contained\n * within the config element\n */\nexport function useElementColumns(configId: string): WorkbookElementColumns {\n  const client = usePlugin();\n  const [columns, setColumns] = React.useState<WorkbookElementColumns>({});\n\n  React.useEffect(() => {\n    if (configId) {\n      return client.elements.subscribeToElementColumns(configId, setColumns);\n    }\n  }, [client, configId]);\n\n  return columns;\n}\n\n/**\n * Provides the latest data values from config element (max 25_000)\n * @param {string} configId ID from the config for fetching element data, with type: 'element'\n * @returns {WorkbookElementData} Element Data for config element, if any\n */\nexport function useElementData(configId: string): WorkbookElementData {\n  const client = usePlugin();\n  const [data, setData] = React.useState<WorkbookElementData>({});\n\n  React.useEffect(() => {\n    if (configId) {\n      return client.elements.subscribeToElementData(configId, setData);\n    }\n  }, [client, configId]);\n\n  return data;\n}\n\n/**\n * Provides the latest data values from corresponding config element with a callback to\n * fetch more in chunks of 25_000 data points\n * @param {string} configId ID from the config for fetching paginated\n * element data, with type: 'element'\n * @returns {WorkbookElementData} Element Data for configured config element, if any\n */\nexport function usePaginatedElementData(\n  configId: string,\n): [WorkbookElementData, () => void] {\n  const client = usePlugin();\n  const [data, setData] = React.useState<WorkbookElementData>({});\n\n  const loadMore = React.useCallback(() => {\n    if (configId) {\n      client.elements.fetchMoreElementData(configId);\n    }\n  }, [configId, client.elements]);\n\n  React.useEffect(() => {\n    if (configId) {\n      return client.elements.subscribeToElementData(configId, setData);\n    }\n  }, [client, configId]);\n\n  return [data, loadMore];\n}\n\n/**\n * Provides the latest value for entire config or certain key within the config\n * @param {string} key Key within Plugin Config, optional\n * @returns Entire config if no key passed in or value for key within plugin config\n */\nexport function useConfig(key?: string): any {\n  const client = usePlugin();\n  const [config, setConfig] = React.useState<any>(\n    key != null ? client.config.getKey(key) : client.config.get(),\n  );\n\n  React.useEffect(\n    () =>\n      client.config.subscribe(newConfig => {\n        if (key != null && newConfig[key] !== config[key]) {\n          setConfig(newConfig[key]);\n        } else {\n          setConfig(newConfig);\n        }\n      }),\n    [client, key, config],\n  );\n\n  return config;\n}\n\n/**\n * React hook for accessing a workbook control variable\n * @param {string} id ID from the config of type: 'variable'\n * @returns {[(WorkbookVariable | undefined), Function]} Constantly updating\n * value of the control variable and setter for the variable\n */\nexport function useVariable(\n  id: string,\n): [WorkbookVariable | undefined, Function] {\n  const client = usePlugin();\n  const [workbookVariable, setWorkbookVariable] =\n    React.useState<WorkbookVariable>();\n\n  const isFirstRender = React.useRef<boolean>(true);\n\n  React.useEffect(() => {\n    if (isFirstRender.current) {\n      setWorkbookVariable(client.config.getVariable(id));\n      isFirstRender.current = false;\n    }\n    return client.config.subscribeToWorkbookVariable(id, setWorkbookVariable);\n  }, [client, id]);\n\n  const setVariable = React.useCallback(\n    (...values: unknown[]) => client.config.setVariable(id, ...values),\n    [id, client.config],\n  );\n\n  return [workbookVariable, setVariable];\n}\n\n/**\n * React hook for accessing a url parameter\n * @param {string} id ID from the config of type: 'url-parameter'\n * @returns {[(UrlParameter | undefined), Function]} Constantly updating value of the url parameter and setter for the url parameter\n */\nexport function useUrlParameter(\n  id: string,\n): [UrlParameter | undefined, (value: string) => void] {\n  const client = usePlugin();\n  const [urlParameter, setUrlParameter] = React.useState<UrlParameter>();\n\n  const isFirstRender = React.useRef<boolean>(true);\n\n  React.useEffect(() => {\n    if (isFirstRender.current) {\n      setUrlParameter(client.config.getUrlParameter(id));\n      isFirstRender.current = false;\n    }\n    return client.config.subscribeToUrlParameter(id, setUrlParameter);\n  }, [client, id]);\n\n  const setter = React.useCallback(\n    (value: string) => client.config.setUrlParameter(id, value),\n    [client, id],\n  );\n\n  return [urlParameter, setter];\n}\n\n/**\n * @deprecated Use Action API instead\n * React hook for accessing a workbook interaction selections state\n * @param {string} id ID from the config of type: 'interaction'\n * @returns {[(WorkbookSelection | undefined), Function]} Constantly updating selection state and setter thereof\n */\nexport function useInteraction(\n  id: string,\n  elementId: string,\n): [unknown, Function] {\n  const client = usePlugin();\n  const [workbookInteraction, setWorkbookInteraction] =\n    React.useState<WorkbookSelection[]>();\n\n  React.useEffect(() => {\n    return client.config.subscribeToWorkbookInteraction(\n      id,\n      setWorkbookInteraction,\n    );\n  }, [client, id]);\n\n  const setInteraction = React.useCallback(\n    (value: WorkbookSelection[]) => {\n      client.config.setInteraction(id, elementId, value);\n    },\n    [id, elementId, client.config],\n  );\n\n  return [workbookInteraction, setInteraction];\n}\n\n/**\n * React hook for returning a triggering callback function for the registered\n * action trigger\n * @param {string} configId ID from the config of type: 'action-trigger'\n * @returns {Function} A callback function to trigger the action\n */\nexport function useActionTrigger(configId: string): () => void {\n  const client = usePlugin();\n\n  return React.useCallback(() => {\n    client.config.triggerAction(configId);\n  }, [client, configId]);\n}\n\n/**\n * React hook for registering and unregistering an action effect\n * @param {string} configId ID from the config of type: 'action-effect'\n * @param {Function} effect The function to be called when the action is triggered\n */\nexport function useActionEffect(configId: string, effect: () => void) {\n  const client = usePlugin();\n\n  const effectRef = React.useRef(effect);\n\n  React.useEffect(() => {\n    effectRef.current = effect;\n  });\n\n  React.useEffect(() => {\n    return client.config.registerEffect(configId, effectRef.current);\n  }, [client, configId, effect]);\n}\n\n/**\n * React hook for accessing plugin style with live updates\n * @returns {PluginStyle | undefined} Style properties from the workbook if available\n */\nexport function usePluginStyle(): PluginStyle | undefined {\n  const client = usePlugin();\n  const [style, setStyle] = React.useState<PluginStyle | undefined>();\n\n  React.useEffect(() => {\n    // Request initial style data on mount and subscribe to updates\n    void client.style.get().then(response => setStyle(response));\n    return client.style.subscribe(setStyle);\n  }, [client]);\n\n  return style;\n}\n","import * as React from 'react';\n\nimport { PluginInstance } from '../types';\n\nimport { PluginContext } from './Context';\n\nexport interface SigmaClientProviderProps<T = any> {\n  client: PluginInstance<T>;\n  children?: React.ReactNode;\n}\n\nexport function SigmaClientProvider<T = any>(\n  props: SigmaClientProviderProps<T>,\n) {\n  return (\n    <PluginContext.Provider value={props.client}>\n      {props.children}\n    </PluginContext.Provider>\n  );\n}\n","const FPS = 1000 / 60;\n\n/**\n * requestAnimationFrame() calls are paused in most browsers when running in background tabs or hidden <iframe>s in order to improve performance and battery life\n * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame\n */\nexport function polyfillRequestAnimationFrame(window: Window) {\n  if ('requestAnimationFrame' in window) {\n    window.requestAnimationFrame = callback => window.setTimeout(callback, FPS);\n\n    window.cancelAnimationFrame = id => window.clearTimeout(id);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,SAAS,SAAS,KAAU;AAC1B,KAAI,OAAO,QAAQ,YAAY,OAAO,KACpC,QAAO;KAEP,QAAO;;AAIX,SAAgB,UAAU,MAAW,MAAW;AAC9C,KAAI,SAAS,KACX,QAAO;UACE,SAAS,KAAK,IAAI,SAAS,KAAK,EAAE;AAC3C,MAAI,OAAO,KAAK,KAAK,CAAC,WAAW,OAAO,KAAK,KAAK,CAAC,OACjD,QAAO;AAET,OAAK,MAAM,QAAQ,KACjB,KAAI,CAAC,UAAU,KAAK,OAAO,KAAK,MAAM,CACpC,QAAO;AAGX,SAAO;;;;;AClBX,SAAgB,iBACd,UACA,oBACA;AACA,KAAI,aAAa,KAAA,EACf,SAAQ,KAAK,kBAAkB,mBAAmB,IAAI,WAAW;;;;ACIrE,SAAgB,aAAwC;CACtD,MAAM,eAAyC,EAC7C,QAAQ,EAAE,EACX;CAED,IAAI,yBAA8D,EAAE;CACpE,IAAI,yBAA2D,EAAE;CACjE,IAAI,0BAAwD,EAAE;CAC9D,MAAM,oBAAgD,EAAE;CAExD,MAAM,YAEF,EAAE;CAEN,MAAM,WAAW,IAAI,IAAI,SAAS,SAAS,KAAK;AAChD,MAAK,MAAM,CAAC,KAAK,UAAU,SAAS,aAAa,SAAS,CACxD,KAAI;AACF,eAAa,OAAO,KAAK,MAAM,MAAM;UAC9B,MAAe;AAIpB,UAAQ,MACN,6BAA6B,IAAI,cAAc,MAAM,WACtD;;CAKP,MAAM,YAAY,MAA6B;AAC7C,OAAK,EAAE,KAAK,MAAM,EAAE,KAAK,QAAQ,EAAE,KAAK,MAAM;;AAGhD,QAAO,iBAAiB,WAAW,UAAU,MAAM;AACnD,QAAO,iBAAiB,eAAe,YAAY,kBAAkB,CAAC;AAEtE,IAAG,4BAA4B,WAA4B;AACzD,SAAO,OAAO,cAAc,OAAO;AACnC,OAAK,UAAU,aAAa,UAAU,EAAE,CAAC;GACzC;AAGG,aAAY,kBAAA,QAA8B,CAAC,MAAK,WAAU;AAC7D,SAAO,OAAO,cAAc,OAAO;AACnC,OAAK,QAAQ,aAAa;AAC1B,OAAK,UAAU,aAAa,OAAO;GACnC;AAEF,IACE,8BACC,qBAAuD;AACtD,2BAAyB,EAAE;AAC3B,SAAO,OAAO,wBAAwB,iBAAiB;GAE1D;AAED,IAAG,+BAA+B,wBAAiC;AACjE,2BAAyB,EAAE;AAC3B,SAAO,OAAO,wBAAwB,oBAAoB;GAC1D;AAEF,IACE,mCACC,yBAAuD;AACtD,4BAA0B,EAAE;AAC5B,SAAO,OAAO,yBAAyB,qBAAqB;GAE/D;AAED,IAAG,mCAAmC,aAAqB;EACzD,MAAM,SAAS,kBAAkB;AACjC,MAAI,CAAC,OACH,OAAM,IAAI,MAAM,oCAAoC,WAAW;AAEjE,UAAQ;GACR;CAEF,SAAS,GAAG,OAAe,UAAoB;AAC7C,YAAU,SAAS,UAAU,UAAU,EAAE;AACzC,YAAU,OAAO,KAAK,SAAS;;CAGjC,SAAS,IAAI,OAAe,UAAoB;AAC9C,MAAI,UAAU,UAAU,KAAM;AAC9B,YAAU,SAAS,UAAU,OAAO,QAAO,MAAK,MAAM,SAAS;;CAGjE,SAAS,KAAK,OAAe,GAAG,MAAW;AACzC,SAAO,OAAO,UAAU,UAAU,EAAE,CAAC,CAAC,SAAQ,OAAM,GAAG,GAAG,KAAK,CAAC;;CAGlE,SAAS,YAAe,OAAe,GAAG,MAAuB;AAC/D,SAAO,IAAI,SAAS,SAAS,WAAW;GACtC,MAAM,YAAY,MAAS,UAAe;AACxC,QAAI,MAAO,QAAO,MAAM;QACnB,SAAQ,KAAK;AAClB,QAAI,OAAO,SAAS;;AAEtB,MAAG,OAAO,SAAS;AACnB,UAAO,OAAO,YACZ;IAAE,MAAM;IAAO;IAAM,WAAW,aAAa;IAAI,EACjD,cAAc,YAAY,IAC3B;IACD;;AAGJ,QAAO;EACL,IAAI,WAAW;AACb,UAAO,aAAa;;EAGtB,IAAI,eAAe;AACjB,UAAO,aAAa;;EAGtB,QAAQ;GAEN,OAAO,KAAK;AACV,WAAO,cAAc,SAAS;;GAEhC,MAAM;AACJ,WAAO,aAAa;;GAEtB,IAAI,eAAe;AACZ,gBAAY,2BAA2B,cAAc;;GAE5D,OAAO,KAAK,OAAO;AACZ,gBAAY,2BAA2B,GACzC,MAAM,OACR,CAAC;;GAEJ,UAAU,UAAU;AAClB,OAAG,UAAU,SAAS;AACtB,iBAAa,IAAI,UAAU,SAAS;;GAEtC,YAAY,UAAkB;AAC5B,qBAAiB,UAAU,WAAW;AACtC,WAAO,uBAAuB;;GAEhC,YAAY,UAAkB,GAAG,QAAmB;AAClD,qBAAiB,UAAU,WAAW;AACjC,gBAAY,0BAA0B,UAAU,GAAG,OAAO;;GAEjE,eAAe,UAAkB;AAC/B,qBAAiB,UAAU,cAAc;AACzC,WAAO,uBAAuB;;GAEhC,eACE,UACA,WACA,WAGA;AACA,qBAAiB,UAAU,cAAc;AACpC,gBACH,2BACA,UACA,WACA,UACD;;GAEH,cAAc,UAAkB;AAC9B,qBAAiB,UAAU,iBAAiB;AACvC,gBAAY,mCAAmC,SAAS;;GAE/D,eAAe,UAAkB,QAAoB;AACnD,qBAAiB,UAAU,gBAAgB;AAC3C,sBAAkB,YAAY;AAC9B,iBAAa;AACX,YAAO,kBAAkB;;;GAG7B,qBAAqB,SAAS;AACvB,gBAAY,8BAA8B,QAAQ;;GAEzD,gBAAgB,cAAc;AACvB,gBAAY,kCAAkC,aAAa;;GAElE,4BAA4B,UAAU,UAAU;AAC9C,qBAAiB,UAAU,WAAW;IACtC,MAAM,aAAa,WAA6C;AAC9D,cAAS,OAAO,UAAU;;AAE5B,OAAG,6BAA6B,UAAU;AAC1C,iBAAa;AACX,SAAI,6BAA6B,UAAU;;;GAG/C,+BAA+B,UAAU,UAAU;AACjD,qBAAiB,UAAU,cAAc;IACzC,MAAM,aAAa,WAAgD;AACjE,cAAS,OAAO,UAAU;;AAE5B,OAAG,8BAA8B,UAAU;AAC3C,iBAAa;AACX,SAAI,8BAA8B,UAAU;;;GAGhD,wBAAwB,UAAU,UAAU;AAC1C,qBAAiB,UAAU,gBAAgB;IAC3C,MAAM,aAAa,WAAyC;AAC1D,cAAS,OAAO,UAAU;;AAE5B,cAAU,wBAAwB;AAClC,OAAG,kCAAkC,UAAU;AAC/C,iBAAa;AACX,SAAI,kCAAkC,UAAU;;;GAGpD,gBAAgB,UAAkB;AAChC,qBAAiB,UAAU,gBAAgB;AAC3C,WAAO,wBAAwB;;GAEjC,gBAAgB,UAAkB,OAAe;AAC/C,qBAAiB,UAAU,gBAAgB;AACtC,gBAAY,+BAA+B,UAAU,MAAM;;GAEnE;EACD,UAAU;GACR,kBAAkB,UAAU;AAC1B,qBAAiB,UAAU,UAAU;AACrC,WAAO,YAAY,iCAAiC,SAAS;;GAE/D,0BAA0B,UAAU,UAAU;AAC5C,qBAAiB,UAAU,UAAU;IACrC,MAAM,YAAY,qBAAqB,SAAS;AAChD,OAAG,WAAW,SAAS;AAClB,gBAAY,uCAAuC,SAAS;AAEjE,iBAAa;AACX,SAAI,WAAW,SAAS;AACnB,iBAAY,yCAAyC,SAAS;;;GAGvE,uBAAuB,UAAU,UAAU;AACzC,qBAAiB,UAAU,UAAU;IACrC,MAAM,YAAY,qBAAqB,SAAS;AAChD,OAAG,WAAW,SAAS;AAClB,gBAAY,oCAAoC,SAAS;AAE9D,iBAAa;AACX,SAAI,WAAW,SAAS;AACnB,iBAAY,sCAAsC,SAAS;;;GAGpE,qBAAqB,UAAU;AAC7B,qBAAiB,UAAU,UAAU;AAChC,gBAAY,gCAAgC,SAAS;;GAE7D;EAED,OAAO;GACL,UAAU,UAAwC;AAChD,OAAG,0BAA0B,SAAS;AACtC,iBAAa,IAAI,0BAA0B,SAAS;;GAGtD,MAAM;AACJ,WAAO,YAAY,sBAAsB;;GAE5C;EAED,UAAU;AACR,UAAO,KAAK,UAAU,CAAC,SAAQ,UAAS,OAAO,UAAU,OAAO;AAChE,UAAO,oBAAoB,WAAW,UAAU,MAAM;;EAEzD;;;;ACpRH,MAAa,SAAS,YAAY;;;ACGlC,MAAa,gBAAgBA,QAAM,cAA8B,OAAO;;;;;;;ACexE,SAAgB,YAAiC;AAC/C,QAAOC,QAAM,WAAW,cAAc;;;;;;AAOxC,SAAgB,qBACd,aACM;CACN,MAAM,SAAS,WAAW;CAC1B,MAAM,aAAaA,QAAM,OAAO,EAAE,CAAC;AAEnC,SAAM,gBAAgB;AACpB,MAAI,eAAe,KAAM;AACzB,MAAI,CAAC,UAAU,aAAa,WAAW,QAAQ,EAAE;AAC/C,UAAO,OAAO,qBAAqB,YAAY;AAC/C,cAAW,UAAU;;IAEtB,CAAC,QAAQ,YAAY,CAAC;;;;;;;AAQ3B,SAAgB,gBACd,cACyC;CACzC,MAAM,SAAS,WAAW;CAC1B,MAAM,CAAC,SAAS,cAAcA,QAAM,eAAe;AACjD,SAAO,OAAO,gBAAgB,aAAa;AAC3C,SAAO;GACP;AAEF,QAAO,CACL,UACA,cAAa;AACX,MAAI,cAAc,QAAS;AAC3B,aAAW,UAAU;AACrB,SAAO,OAAO,gBAAgB,UAAU;GAE3C;;;;;;;;AASH,SAAgB,kBAAkB,UAA0C;CAC1E,MAAM,SAAS,WAAW;CAC1B,MAAM,CAAC,SAAS,cAAcA,QAAM,SAAiC,EAAE,CAAC;AAExE,SAAM,gBAAgB;AACpB,MAAI,SACF,QAAO,OAAO,SAAS,0BAA0B,UAAU,WAAW;IAEvE,CAAC,QAAQ,SAAS,CAAC;AAEtB,QAAO;;;;;;;AAQT,SAAgB,eAAe,UAAuC;CACpE,MAAM,SAAS,WAAW;CAC1B,MAAM,CAAC,MAAM,WAAWA,QAAM,SAA8B,EAAE,CAAC;AAE/D,SAAM,gBAAgB;AACpB,MAAI,SACF,QAAO,OAAO,SAAS,uBAAuB,UAAU,QAAQ;IAEjE,CAAC,QAAQ,SAAS,CAAC;AAEtB,QAAO;;;;;;;;;AAUT,SAAgB,wBACd,UACmC;CACnC,MAAM,SAAS,WAAW;CAC1B,MAAM,CAAC,MAAM,WAAWA,QAAM,SAA8B,EAAE,CAAC;CAE/D,MAAM,WAAWA,QAAM,kBAAkB;AACvC,MAAI,SACF,QAAO,SAAS,qBAAqB,SAAS;IAE/C,CAAC,UAAU,OAAO,SAAS,CAAC;AAE/B,SAAM,gBAAgB;AACpB,MAAI,SACF,QAAO,OAAO,SAAS,uBAAuB,UAAU,QAAQ;IAEjE,CAAC,QAAQ,SAAS,CAAC;AAEtB,QAAO,CAAC,MAAM,SAAS;;;;;;;AAQzB,SAAgB,UAAU,KAAmB;CAC3C,MAAM,SAAS,WAAW;CAC1B,MAAM,CAAC,QAAQ,aAAaA,QAAM,SAChC,OAAO,OAAO,OAAO,OAAO,OAAO,IAAI,GAAG,OAAO,OAAO,KAAK,CAC9D;AAED,SAAM,gBAEF,OAAO,OAAO,WAAU,cAAa;AACnC,MAAI,OAAO,QAAQ,UAAU,SAAS,OAAO,KAC3C,WAAU,UAAU,KAAK;MAEzB,WAAU,UAAU;GAEtB,EACJ;EAAC;EAAQ;EAAK;EAAO,CACtB;AAED,QAAO;;;;;;;;AAST,SAAgB,YACd,IAC0C;CAC1C,MAAM,SAAS,WAAW;CAC1B,MAAM,CAAC,kBAAkB,uBACvBA,QAAM,UAA4B;CAEpC,MAAM,gBAAgBA,QAAM,OAAgB,KAAK;AAEjD,SAAM,gBAAgB;AACpB,MAAI,cAAc,SAAS;AACzB,uBAAoB,OAAO,OAAO,YAAY,GAAG,CAAC;AAClD,iBAAc,UAAU;;AAE1B,SAAO,OAAO,OAAO,4BAA4B,IAAI,oBAAoB;IACxE,CAAC,QAAQ,GAAG,CAAC;AAOhB,QAAO,CAAC,kBALYA,QAAM,aACvB,GAAG,WAAsB,OAAO,OAAO,YAAY,IAAI,GAAG,OAAO,EAClE,CAAC,IAAI,OAAO,OAAO,CAGgB,CAAC;;;;;;;AAQxC,SAAgB,gBACd,IACqD;CACrD,MAAM,SAAS,WAAW;CAC1B,MAAM,CAAC,cAAc,mBAAmBA,QAAM,UAAwB;CAEtE,MAAM,gBAAgBA,QAAM,OAAgB,KAAK;AAEjD,SAAM,gBAAgB;AACpB,MAAI,cAAc,SAAS;AACzB,mBAAgB,OAAO,OAAO,gBAAgB,GAAG,CAAC;AAClD,iBAAc,UAAU;;AAE1B,SAAO,OAAO,OAAO,wBAAwB,IAAI,gBAAgB;IAChE,CAAC,QAAQ,GAAG,CAAC;AAOhB,QAAO,CAAC,cALOA,QAAM,aAClB,UAAkB,OAAO,OAAO,gBAAgB,IAAI,MAAM,EAC3D,CAAC,QAAQ,GAAG,CAGc,CAAC;;;;;;;;AAS/B,SAAgB,eACd,IACA,WACqB;CACrB,MAAM,SAAS,WAAW;CAC1B,MAAM,CAAC,qBAAqB,0BAC1BA,QAAM,UAA+B;AAEvC,SAAM,gBAAgB;AACpB,SAAO,OAAO,OAAO,+BACnB,IACA,uBACD;IACA,CAAC,QAAQ,GAAG,CAAC;AAShB,QAAO,CAAC,qBAPeA,QAAM,aAC1B,UAA+B;AAC9B,SAAO,OAAO,eAAe,IAAI,WAAW,MAAM;IAEpD;EAAC;EAAI;EAAW,OAAO;EAAO,CAGW,CAAC;;;;;;;;AAS9C,SAAgB,iBAAiB,UAA8B;CAC7D,MAAM,SAAS,WAAW;AAE1B,QAAOA,QAAM,kBAAkB;AAC7B,SAAO,OAAO,cAAc,SAAS;IACpC,CAAC,QAAQ,SAAS,CAAC;;;;;;;AAQxB,SAAgB,gBAAgB,UAAkB,QAAoB;CACpE,MAAM,SAAS,WAAW;CAE1B,MAAM,YAAYA,QAAM,OAAO,OAAO;AAEtC,SAAM,gBAAgB;AACpB,YAAU,UAAU;GACpB;AAEF,SAAM,gBAAgB;AACpB,SAAO,OAAO,OAAO,eAAe,UAAU,UAAU,QAAQ;IAC/D;EAAC;EAAQ;EAAU;EAAO,CAAC;;;;;;AAOhC,SAAgB,iBAA0C;CACxD,MAAM,SAAS,WAAW;CAC1B,MAAM,CAAC,OAAO,YAAYA,QAAM,UAAmC;AAEnE,SAAM,gBAAgB;AAEf,SAAO,MAAM,KAAK,CAAC,MAAK,aAAY,SAAS,SAAS,CAAC;AAC5D,SAAO,OAAO,MAAM,UAAU,SAAS;IACtC,CAAC,OAAO,CAAC;AAEZ,QAAO;;;;AC7RT,SAAgB,oBACd,OACA;AACA,QACE,sBAAA,cAAC,cAAc,UAAf,EAAwB,OAAO,MAAM,QAEZ,EADtB,MAAM,SACgB;;;;ACjB7B,MAAM,MAAM,MAAO;;;;;AAMnB,SAAgB,8BAA8B,QAAgB;AAC5D,KAAI,2BAA2B,QAAQ;AACrC,SAAO,yBAAwB,aAAY,OAAO,WAAW,UAAU,IAAI;AAE3E,SAAO,wBAAuB,OAAM,OAAO,aAAa,GAAG"}

package/dist/cjs/index.d.cts

@@ -0,0 +1,438 @@
+import * as React from "react";
+
+//#region src/types.d.ts
+type ScalarType = 'boolean' | 'datetime' | 'number' | 'integer' | 'text';
+type PrimitiveType = ScalarType | 'variant' | 'link';
+type ValueType = PrimitiveType | 'error';
+/**
+ * All mutable workbook control variable types
+ */
+type ControlType = 'boolean' | 'date' | 'number' | 'text' | 'text-list' | 'number-list' | 'date-list' | 'number-range' | 'date-range';
+interface PluginConfig<T> {
+  id: string;
+  config: T;
+  screenshot: boolean;
+  [key: string]: any;
+}
+/**
+ * Style colors available to plugins
+ * @typedef {object} PluginStyle
+ * @property {string} backgroundColor Background color set from workbook if any
+ */
+interface PluginStyle {
+  backgroundColor: string;
+}
+/**
+ * @typedef {object} WorkbookVariable
+ * @property {string} name Name of control variable within workbook
+ * @property {{string}} defaultValue Current value containing at least type as string
+ */
+interface WorkbookVariable {
+  name: string;
+  defaultValue: {
+    type: string;
+    value: any;
+  };
+}
+/**
+ * @typedef {object} UrlParameter
+ * @property {string} value Current url value
+ */
+interface UrlParameter {
+  value: string;
+}
+type WorkbookSelection = Record<string, {
+  type: string;
+  val?: unknown;
+}>;
+type PluginMessageResponse = MessageEvent<{
+  type: string;
+  result: any[];
+  error: any;
+}>;
+interface WbElement {
+  id: string;
+}
+/**
+ * @typedef {object} WorkbookElementData
+ * @property {Object<string, any>} data Workbook data sorted by column ID
+ */
+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
+ */
+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
+ */
+interface WorkbookElementColumns {
+  [colId: string]: WorkbookElementColumn;
+}
+/**
+ * Function to Unsubscribe from the corresponding elements
+ * @typedef {() => void} Unsubscriber
+ */
+type Unsubscriber = () => void;
+interface CustomPluginConfigOptionBase {
+  name: string;
+  label?: string;
+}
+interface CustomPluginConfigGroup extends CustomPluginConfigOptionBase {
+  type: 'group';
+}
+interface CustomPluginConfigElement extends CustomPluginConfigOptionBase {
+  type: 'element';
+}
+interface CustomPluginConfigColumn extends CustomPluginConfigOptionBase {
+  type: 'column';
+  allowedTypes?: ValueType[];
+  source: string;
+  allowMultiple: boolean;
+}
+interface CustomPluginConfigText extends CustomPluginConfigOptionBase {
+  type: 'text';
+  source?: string;
+  secure?: boolean;
+  multiline?: boolean;
+  placeholder?: string;
+  defaultValue?: string;
+}
+interface CustomPluginConfigToggle extends CustomPluginConfigOptionBase {
+  type: 'toggle';
+  source?: string;
+  defaultValue?: boolean;
+}
+interface CustomPluginConfigCheckbox extends CustomPluginConfigOptionBase {
+  type: 'checkbox';
+  source?: string;
+  defaultValue?: boolean;
+}
+interface CustomPluginConfigRadio extends CustomPluginConfigOptionBase {
+  type: 'radio';
+  source?: string;
+  singleLine?: boolean;
+  values: string[];
+  defaultValue?: string;
+}
+interface CustomPluginConfigDropdown extends CustomPluginConfigOptionBase {
+  type: 'dropdown';
+  source?: string;
+  width?: string;
+  values: string[];
+  defaultValue?: string;
+}
+interface CustomPluginConfigColor extends CustomPluginConfigOptionBase {
+  type: 'color';
+  source?: string;
+}
+interface CustomPluginConfigVariable extends CustomPluginConfigOptionBase {
+  type: 'variable';
+  allowedTypes?: ControlType[];
+}
+interface CustomPluginConfigInteraction extends CustomPluginConfigOptionBase {
+  type: 'interaction';
+}
+interface CustomPluginConfigActionTrigger extends CustomPluginConfigOptionBase {
+  type: 'action-trigger';
+}
+interface CustomPluginConfigActionEffect extends CustomPluginConfigOptionBase {
+  type: 'action-effect';
+}
+interface CustomPluginConfigUrlParameter extends Omit<CustomPluginConfigOptionBase, 'label'> {
+  type: 'url-parameter';
+}
+/**
+ * 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
+ */
+type CustomPluginConfigOptions = CustomPluginConfigGroup | CustomPluginConfigElement | CustomPluginConfigColumn | CustomPluginConfigText | CustomPluginConfigToggle | CustomPluginConfigCheckbox | CustomPluginConfigRadio | CustomPluginConfigDropdown | CustomPluginConfigColor | CustomPluginConfigVariable | CustomPluginConfigInteraction | CustomPluginConfigActionTrigger | CustomPluginConfigActionEffect | CustomPluginConfigUrlParameter;
+/**
+ * @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
+ */
+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} configId ID from config of type: 'variable'
+     * @returns {WorkbookVariable} Current value of the workbook variable
+     */
+    getVariable(configId: string): WorkbookVariable;
+    /**
+     * Setter for workbook variable passed in
+     * @param {string} configId ID from config of type: 'variable'
+     * @param {unknown[]} values Values to assign to the workbook variable
+     */
+    setVariable(configId: string, ...values: unknown[]): void;
+    /**
+     * @deprecated Use Action API instead
+     * Getter for interaction selection state
+     * @param {string} configId ID from config of type: 'interaction'
+     */
+    getInteraction(configId: string): WorkbookSelection[];
+    /**
+     * @deprecated Use Action API instead
+     * Setter for interaction selection state
+     * @param {string} configId ID from config of type: 'interaction'
+     * @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(configId: string, elementId: string, selection: WorkbookSelection[]): void;
+    /**
+     * Triggers an action based on the provided action trigger ID
+     * @param {string} configId ID from config of type: 'action-trigger'
+     */
+    triggerAction(configId: string): void;
+    /**
+     * Registers an effect with the provided action effect ID
+     * @param {string} configId ID from config of type: 'action-effect'
+     * @param {Function} effect The effect function to register
+     * @returns {Unsubscriber} A callable unsubscriber
+     */
+    registerEffect(configId: string, effect: () => void): () => void;
+    /**
+     * Tell the workbook whether the plugin is still loading. Pass false when the plugin
+     * has finished loading and is ready to be used.
+     * @param {boolean} isLoading Boolean representing if Plugin Config is still loading
+     */
+    setLoadingState(isLoading: boolean): void;
+    /**
+     * Allows users to subscribe to changes in the passed in variable
+     * @param {string} configId ID from config of type: 'variable'
+     * @callback callback Function to be called upon receiving an updated workbook variable
+     * @returns {Unsubscriber} A callable unsubscriber
+     */
+    subscribeToWorkbookVariable(configId: string, callback: (input: WorkbookVariable) => void): Unsubscriber;
+    /**
+     * Allows users to subscribe to changes in the url parameter
+     * @param {string} configId ID from config of type: 'url-parameter'
+     * @callback callback Function to be called upon receiving an updated url parameter
+     * @returns {Unsubscriber} A callable unsubscriber
+     */
+    subscribeToUrlParameter(configId: string, callback: (input: UrlParameter) => void): Unsubscriber;
+    /**
+     * Gets the current value of a url parameter
+     * @param {string} configId ID from config of type: 'url-parameter'
+     * @returns {UrlParameter} Current value of the url parameter
+     */
+    getUrlParameter(configId: string): UrlParameter;
+    /**
+     * Setter for url parameter
+     * @param {string} configId ID from config of type: 'url-parameter'
+     * @param {string} value Value to assign to the url parameter
+     */
+    setUrlParameter(configId: string, value: string): void;
+    /**
+     * @deprecated Use Action API instead
+     * Allows users to subscribe to changes in the passed in interaction ID
+     * @param {string} configId ID from the config of type: 'interaction'
+     * @callback callback Function to be called upon receiving an updated interaction selection state
+     * @returns {Unsubscriber} A callable unsubscriber
+     */
+    subscribeToWorkbookInteraction(configId: string, callback: (input: WorkbookSelection[]) => void): Unsubscriber;
+  };
+  elements: {
+    /**
+     * Getter for Column Data by parent sheet ID
+     * @param {string} configId ID from config of type: 'element'
+     * @returns {WorkbookElementColumns} Column values contained within corresponding sheet
+     */
+    getElementColumns(configId: string): Promise<WorkbookElementColumns>;
+    /**
+     * Subscriber to changes in column data by ID
+     * @param {string} configId ID from config of type: 'element'
+     * @callback callback Callback function to be called upon changes to column data
+     * @returns {Unsubscriber} Callable unsubscriber to column data changes
+     */
+    subscribeToElementColumns(configId: string, callback: (cols: WorkbookElementColumns) => void): Unsubscriber;
+    /**
+     * Subscriber for the data within a given sheet
+     * @param {string} configId ID from config of type: 'element'
+     * @callback callback Function to call on data passed in
+     * @returns {Unsubscriber} A callable unsubscriber to changes in the data
+     */
+    subscribeToElementData(configId: string, callback: (data: WorkbookElementData) => void): Unsubscriber;
+    /**
+     * Ask sigma to load more data
+     * @param {string} configId ID from config of type: 'element'
+     */
+    fetchMoreElementData(configId: string): void;
+  };
+  style: {
+    /**
+     * Subscribe to style updates
+     * @param callback Function to call when style updates
+     * @returns Unsubscriber function
+     */
+    subscribe(callback: (style: PluginStyle) => void): () => void;
+    /**
+     * Request current style from workbook
+     * @returns Promise with current style
+     */
+    get(): Promise<PluginStyle>;
+  };
+  /**
+   * Destroys plugin instance and removes all subscribers
+   */
+  destroy(): void;
+}
+//#endregion
+//#region src/react/hooks.d.ts
+/**
+ * Gets the entire plugin instance
+ * @returns {PluginInstance} Context for the current plugin instance
+ */
+declare function usePlugin(): PluginInstance<any>;
+/**
+ * Provides a setter for the Plugin's Config Options
+ * @param {CustomPluginConfigOptions[]} nextOptions Updated possible Config Options
+ */
+declare function useEditorPanelConfig(nextOptions: 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
+ */
+declare function useLoadingState(initialState: boolean): [boolean, (nextState: boolean) => void];
+/**
+ * Provides the latest column values from corresponding config element
+ * @param {string} configId ID from the config for fetching element columns, with type: 'element'
+ * @returns {WorkbookElementColumns} Values of corresponding columns contained
+ * within the config element
+ */
+declare function useElementColumns(configId: string): WorkbookElementColumns;
+/**
+ * Provides the latest data values from config element (max 25_000)
+ * @param {string} configId ID from the config for fetching element data, with type: 'element'
+ * @returns {WorkbookElementData} Element Data for config element, if any
+ */
+declare function useElementData(configId: string): WorkbookElementData;
+/**
+ * Provides the latest data values from corresponding config element with a callback to
+ * fetch more in chunks of 25_000 data points
+ * @param {string} configId ID from the config for fetching paginated
+ * element data, with type: 'element'
+ * @returns {WorkbookElementData} Element Data for configured config element, if any
+ */
+declare function usePaginatedElementData(configId: string): [WorkbookElementData, () => void];
+/**
+ * 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
+ */
+declare function useConfig(key?: string): any;
+/**
+ * React hook for accessing a workbook control variable
+ * @param {string} id ID from the config of type: 'variable'
+ * @returns {[(WorkbookVariable | undefined), Function]} Constantly updating
+ * value of the control variable and setter for the variable
+ */
+declare function useVariable(id: string): [WorkbookVariable | undefined, Function];
+/**
+ * React hook for accessing a url parameter
+ * @param {string} id ID from the config of type: 'url-parameter'
+ * @returns {[(UrlParameter | undefined), Function]} Constantly updating value of the url parameter and setter for the url parameter
+ */
+declare function useUrlParameter(id: string): [UrlParameter | undefined, (value: string) => void];
+/**
+ * @deprecated Use Action API instead
+ * React hook for accessing a workbook interaction selections state
+ * @param {string} id ID from the config of type: 'interaction'
+ * @returns {[(WorkbookSelection | undefined), Function]} Constantly updating selection state and setter thereof
+ */
+declare function useInteraction(id: string, elementId: string): [unknown, Function];
+/**
+ * React hook for returning a triggering callback function for the registered
+ * action trigger
+ * @param {string} configId ID from the config of type: 'action-trigger'
+ * @returns {Function} A callback function to trigger the action
+ */
+declare function useActionTrigger(configId: string): () => void;
+/**
+ * React hook for registering and unregistering an action effect
+ * @param {string} configId ID from the config of type: 'action-effect'
+ * @param {Function} effect The function to be called when the action is triggered
+ */
+declare function useActionEffect(configId: string, effect: () => void): void;
+/**
+ * React hook for accessing plugin style with live updates
+ * @returns {PluginStyle | undefined} Style properties from the workbook if available
+ */
+declare function usePluginStyle(): PluginStyle | undefined;
+//#endregion
+//#region src/react/Provider.d.ts
+interface SigmaClientProviderProps<T = any> {
+  client: PluginInstance<T>;
+  children?: React.ReactNode;
+}
+declare function SigmaClientProvider<T = any>(props: SigmaClientProviderProps<T>): React.JSX.Element;
+//#endregion
+//#region src/client.d.ts
+declare const client: PluginInstance<{}>;
+//#endregion
+//#region src/utils/polyfillRequestAnimationFrame.d.ts
+/**
+ * requestAnimationFrame() calls are paused in most browsers when running in background tabs or hidden <iframe>s in order to improve performance and battery life
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
+ */
+declare function polyfillRequestAnimationFrame(window: Window): void;
+//#endregion
+export { ControlType, CustomPluginConfigActionEffect, CustomPluginConfigActionTrigger, CustomPluginConfigCheckbox, CustomPluginConfigColor, CustomPluginConfigColumn, CustomPluginConfigDropdown, CustomPluginConfigElement, CustomPluginConfigGroup, CustomPluginConfigInteraction, CustomPluginConfigOptionBase, CustomPluginConfigOptions, CustomPluginConfigRadio, CustomPluginConfigText, CustomPluginConfigToggle, CustomPluginConfigUrlParameter, CustomPluginConfigVariable, PluginConfig, PluginInstance, PluginMessageResponse, PluginStyle, PrimitiveType, ScalarType, SigmaClientProvider, type SigmaClientProviderProps, Unsubscriber, UrlParameter, ValueType, WbElement, WorkbookElementColumn, WorkbookElementColumns, WorkbookElementData, WorkbookSelection, WorkbookVariable, client, polyfillRequestAnimationFrame, useActionEffect, useActionTrigger, useConfig, useEditorPanelConfig, useElementColumns, useElementData, useInteraction, useLoadingState, usePaginatedElementData, usePlugin, usePluginStyle, useUrlParameter, useVariable };
+//# sourceMappingURL=index.d.cts.map