Default supportedEventTypes to empty array (#67)

Co-authored-by: BLACKBAUD\Michael.Tims <[email protected]>

CHANGELOG.md

@@ -1,3 +1,6 @@
+# 1.4.1 (2024-09-10)
+- Addressed issue to prevent `supportedEventTypes` to be `undefined`. Should default to empty array.
+
 # 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`.

package.json

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

src/addin/addin-client.spec.ts

@@ -1490,6 +1490,22 @@ describe('AddinClient ', () => {
       expect((client as any).supportedEventTypes).toEqual(['update-settings']);
     });
 
+    it('should initialize add-in with empty event types.',
+      () => {
+        const msg: AddinHostMessageEventData = {
+          message: {
+            context: 'my_context',
+            envId: 'my_envid'
+          },
+          messageType: 'host-ready',
+          source: 'bb-addin-host'
+        };
+
+        postMessageFromHost(msg);
+
+        expect((client as any).supportedEventTypes).toEqual([]);
+      });
+
     it('should raise "client-event" event with proper message.',
     (done) => {
       let postedMessage: any;

src/addin/addin-client.ts

@@ -571,8 +571,8 @@ export class AddinClient {
 
         this.trackHeightChangesOfAddinContent();
 
-        // set the supported event types
-        this.supportedEventTypes = data.message.supportedEventTypes;
+        // set the supported event types (default to empty array)
+        this.supportedEventTypes = data.message.supportedEventTypes || [];
 
         // Pass key data to the add-in for it to initiailze.
         this.args.callbacks.init({
@@ -587,7 +587,7 @@ export class AddinClient {
               messageType: 'addin-ready'
             });
           },
-          supportedEventTypes : data.message.supportedEventTypes,
+          supportedEventTypes : this.supportedEventTypes,
           themeSettings: data.message.themeSettings
         });