Deprecate Interaction API, to be replaced by Actions API (#18)

Author: peternandersson

README.md

@@ -479,6 +479,7 @@ interface PluginInstance<T> {
     ): Unsubscriber;
 
     /**
+     * @deprecated Use Action API instead
      * Allows users to subscribe to changes in the passed in interaction ID
      */
     subscribeToWorkbookInteraction(

src/client/initialize.ts

@@ -210,7 +210,7 @@ export function initialize<T = {}>(): PluginInstance<T> {
       },
       fetchMoreElementData(id) {
         void execPromise('wb:plugin:element:fetch-more', id);
-      }
+      },
     },
     destroy() {
       Object.keys(listeners).forEach(event => delete listeners[event]);

src/react/hooks.ts

@@ -182,6 +182,7 @@ export function useVariable(
 }
 
 /**
+ * @deprecated Use Action API instead
  * React hook for accessing a workbook interaction selections state
  * @param {string} id ID of variable within Plugin Config to use
  * @returns {[(WorkbookSelection | undefined), Function]} Constantly updating selection state and setter thereof

src/types.ts

@@ -248,12 +248,14 @@ export interface PluginInstance<T = any> {
     setVariable(id: string, ...values: unknown[]): void;
 
     /**
+     * @deprecated Use Action API instead
      * Getter for interaction selection state
      * @param {string} id ID from interaction type in Plugin Config
      */
     getInteraction(id: string): WorkbookSelection[];
 
     /**
+     * @deprecated Use Action API instead
      * 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
@@ -297,6 +299,7 @@ export interface PluginInstance<T = any> {
     ): Unsubscriber;
 
     /**
+     * @deprecated Use Action API instead
      * 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