Sky-box-addin action-click (#66)

* sky-box-addin action-click

* package and change log

* review comment version bump

---------

Co-authored-by: Akash Mehra <[email protected]>

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.4.0 (2024-08-21)
+- Added a `actionClick` callback for Box Add-ins to allow developers to take action when actions are clicked.
+- Added `AddinBoxConfig` interface for defining configuration options for `Box add-ins`.
+
 # 1.3.0 (2024-06-18)
 - Added `AddinClientConfig` interface to allow additional host origins to be supplied by an `AddinClient`.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blackbaud/sky-addin-client",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "SKY add-in client",
   "main": "dist/bundles/sky-addin-client.umd.js",
   "module": "index.ts",

src/addin/addin-client.spec.ts

@@ -343,6 +343,57 @@ describe('AddinClient ', () => {
 
     });
 
+    describe('action-click', () => {
+
+      it('should call the "actionClick" callback.',
+        () => {
+          let actionClickCalled = false;
+
+          const client = new AddinClient({
+            callbacks: {
+              init: () => { return; },
+              actionClick: () => { actionClickCalled = true; }
+            }
+          });
+
+          initializeHost();
+
+          const msg: AddinHostMessageEventData = {
+            message: {},
+            messageType: 'action-click',
+            source: 'bb-addin-host'
+          };
+
+          postMessageFromHost(msg);
+          client.destroy();
+
+          expect(actionClickCalled).toBe(true);
+        });
+
+      it('should tolerate the "actionClick" callback being undefined.',
+        () => {
+          const client = new AddinClient({
+            callbacks: {
+              init: () => { return; }
+            }
+          });
+
+          initializeHost();
+
+          const msg: AddinHostMessageEventData = {
+            message: {},
+            messageType: 'action-click',
+            source: 'bb-addin-host'
+          };
+
+          postMessageFromHost(msg);
+          client.destroy();
+
+        // No assertion.  Just don't fail.
+      });
+
+    });
+
     describe('help-click', () => {
 
       it('should call the "helpClick" callback.',

src/addin/addin-client.ts

@@ -594,6 +594,11 @@ export class AddinClient {
       } else if (this.isFromValidOrigin(event)) {
         /* tslint:disable-next-line switch-default */
         switch (data.messageType) {
+          case 'action-click':
+            if (this.args.callbacks.actionClick) {
+              this.args.callbacks.actionClick(data.message.reason);
+            }
+            break;
           case 'auth-token':
           case 'auth-token-fail':
             this.handleAuthTokenMessage(data);

src/addin/client-interfaces/addin-box-config.ts

@@ -0,0 +1,16 @@
+import { AddinBoxControl } from './addin-box-control';
+
+/**
+ * Interface for defining configuration options for Box add-ins
+ */
+export interface AddinBoxConfig {
+  /**
+   * The controls to use for the box context menu
+   */
+  controls: AddinBoxControl[] | undefined;
+
+  /**
+   * The help key to open when the Help icon is clicked
+   */
+  helpKey?: string | undefined;
+}

src/addin/client-interfaces/addin-box-control.ts

@@ -0,0 +1,14 @@
+/**
+ * Interface for defining a control for Box add-ins
+ */
+export interface AddinBoxControl {
+  /**
+   * The display name of the control
+   */
+  name: string;
+
+  /**
+   * The action of the control
+   */
+  action: string;
+}

src/addin/client-interfaces/addin-client-callbacks.ts

@@ -11,6 +11,11 @@ export interface AddinClientCallbacks {
    */
   init: (args: AddinClientInitArgs) => void;
 
+  /**
+   * Callback raised for box add-ins indicating that a control action was clicked.
+   */
+  actionClick?: (action: string) => void;
+
   /**
    * Callback raised for button add-ins indicating that the button was clicked.
    */

src/addin/client-interfaces/addin-client-ready-args.ts

@@ -1,4 +1,5 @@
 import { AddinActionButtonConfig } from './addin-action-button-config';
+import { AddinBoxConfig } from './addin-box-config';
 import { AddinButtonConfig } from './addin-button-config';
 import { AddinModalConfig } from './addin-modal-config';
 import { AddinTabConfig } from './addin-tab-config';
@@ -44,4 +45,9 @@ export interface AddinClientReadyArgs {
    * Provides additional configuration for Tab add-ins
    */
   tabConfig?: AddinTabConfig;
+
+  /**
+   * Provides additional configuration for Box add-ins
+   */
+  boxConfig?: AddinBoxConfig;
 }

src/addin/client-interfaces/index.ts

@@ -1,3 +1,5 @@
+export * from './addin-box-config';
+export * from './addin-box-control';
 export * from './addin-button-config';
 export * from './addin-button-style';
 export * from './addin-client-args';