@wlloyalty/wll-react-sdk 1.0.102 → 1.0.103

package/dist/types/context/WllSdkContext.d.ts

@@ -4,6 +4,7 @@ import { NavigationConfig } from '../types/navigation';
 import { TSection } from '../types/section';
 import { BaseThemeObject, ThemeContextType } from '../types/theme';
 import { CTALinkTarget, Tile } from '../types/tile';
+import { EventTypes } from '../utils/eventEmitter';
 type Fetcher = <T>(endpoint: string, options?: RequestInit) => Promise<APIResponse<T>>;
 export type SDKConfig = {
     apiKey: string;
@@ -22,6 +23,8 @@ type WllSdkContextType = ThemeContextType & {
     getTileByID: (id: string) => Promise<APIResponse<Tile>>;
     handleNavigation: (link: string, target: CTALinkTarget) => Promise<void>;
     refreshGroup: (id: string) => Promise<APIResponse<TGroup>>;
+    notifyDataChange: (eventType: EventTypes, data?: any) => void;
+    subscribeToDataChange: (eventType: EventTypes, callback: (data?: any) => void) => () => void;
 } & Readonly<{
     readonly config: SDKConfig;
 }>;

package/dist/types/unit-tests/eventEmitter.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/utils/eventEmitter.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Type definition for event callback functions
+ * @typedef {function} EventCallback
+ * @param {any} [data] - Optional data passed with the event
+ */
+export type EventCallback = (data?: any) => void;
+/**
+ * Supported event types for the SDK event system
+ * @typedef {string} EventTypes
+ */
+export type EventTypes = 'GROUP_DATA_CHANGED' | 'SECTION_DATA_CHANGED' | 'TILE_DATA_CHANGED' | string;
+/**
+ * A simple event emitter for handling SDK events
+ * Provides a pub-sub mechanism for components to communicate
+ */
+export declare class EventEmitter {
+    /**
+     * Map of event types to arrays of callback functions
+     * @private
+     */
+    private events;
+    /**
+     * Subscribe to an event
+     * @param {EventTypes} event - The event type to subscribe to
+     * @param {EventCallback} callback - The callback function to execute when the event is emitted
+     * @returns {Function} An unsubscribe function that removes this callback when called
+     */
+    on(event: EventTypes, callback: EventCallback): () => void;
+    /**
+     * Emit an event with optional data
+     * @param {EventTypes} event - The event type to emit
+     * @param {any} [data] - Optional data to pass to the event callbacks
+     */
+    emit(event: EventTypes, data?: any): void;
+    /**
+     * Remove all event listeners
+     * Use this method to clean up when the event emitter is no longer needed
+     */
+    clear(): void;
+}
+/**
+ * Singleton instance of the EventEmitter for use throughout the SDK
+ */
+export declare const sdkEventEmitter: EventEmitter;

package/dist/web.js

@@ -7924,6 +7924,68 @@ var useGetGroupByID = createResourceGetter('groups', true);
 var useGetSectionByID = createResourceGetter('sections');
 var useGetTileByID = createResourceGetter('tiles');
 
+/**
+ * A simple event emitter for handling SDK events
+ * Provides a pub-sub mechanism for components to communicate
+ */
+var EventEmitter$1 = /** @class */function () {
+  function EventEmitter() {
+    /**
+     * Map of event types to arrays of callback functions
+     * @private
+     */
+    this.events = new Map();
+  }
+  /**
+   * Subscribe to an event
+   * @param {EventTypes} event - The event type to subscribe to
+   * @param {EventCallback} callback - The callback function to execute when the event is emitted
+   * @returns {Function} An unsubscribe function that removes this callback when called
+   */
+  EventEmitter.prototype.on = function (event, callback) {
+    var _this = this;
+    var _a;
+    if (!this.events.has(event)) {
+      this.events.set(event, []);
+    }
+    (_a = this.events.get(event)) === null || _a === void 0 ? void 0 : _a.push(callback);
+    return function () {
+      var callbacks = _this.events.get(event);
+      if (callbacks) {
+        var index = callbacks.indexOf(callback);
+        if (index !== -1) {
+          callbacks.splice(index, 1);
+        }
+      }
+    };
+  };
+  /**
+   * Emit an event with optional data
+   * @param {EventTypes} event - The event type to emit
+   * @param {any} [data] - Optional data to pass to the event callbacks
+   */
+  EventEmitter.prototype.emit = function (event, data) {
+    var callbacks = this.events.get(event);
+    if (callbacks) {
+      callbacks.forEach(function (callback) {
+        return callback(data);
+      });
+    }
+  };
+  /**
+   * Remove all event listeners
+   * Use this method to clean up when the event emitter is no longer needed
+   */
+  EventEmitter.prototype.clear = function () {
+    this.events.clear();
+  };
+  return EventEmitter;
+}();
+/**
+ * Singleton instance of the EventEmitter for use throughout the SDK
+ */
+var sdkEventEmitter = new EventEmitter$1();
+
 var sizes = {
   borderRadiusSm: 15,
   borderRadiusLg: 20,
@@ -8525,6 +8587,12 @@ var WllSdkProvider = function (_a) {
       });
     });
   }, [getGroupByID]);
+  var notifyDataChange = React.useCallback(function (eventType, data) {
+    sdkEventEmitter.emit(eventType, data);
+  }, []);
+  var subscribeToDataChange = React.useCallback(function (eventType, callback) {
+    return sdkEventEmitter.on(eventType, callback);
+  }, []);
   var contextValue = React.useMemo(function () {
     return {
       theme: theme,
@@ -8534,9 +8602,11 @@ var WllSdkProvider = function (_a) {
       getTileByID: getTileByID,
       handleNavigation: handleNavigation,
       refreshGroup: refreshGroup,
+      notifyDataChange: notifyDataChange,
+      subscribeToDataChange: subscribeToDataChange,
       config: config
     };
-  }, [theme, setTheme, getGroupByID, getSectionByID, getTileByID, handleNavigation, refreshGroup, config]);
+  }, [theme, setTheme, getGroupByID, getSectionByID, getTileByID, handleNavigation, refreshGroup, notifyDataChange, subscribeToDataChange, config]);
   return /*#__PURE__*/React.createElement(WllSdkContext.Provider, {
     value: contextValue
   }, /*#__PURE__*/React.createElement(ResponsiveProvider, null, children));
@@ -21107,6 +21177,14 @@ var useGroupContext = function () {
 /**
  * Custom hook to fetch and manage group data
  *
+ * This hook handles two distinct data fetching scenarios:
+ * 1. Initial fetch: Shows loading state while first loading data
+ * 2. Background refresh: Updates data silently without loading states
+ *
+ * The hook subscribes to GROUP_DATA_CHANGED events to refresh data
+ * when notified by the host application, ensuring UI remains responsive
+ * without showing loading indicators during refreshes.
+ *
  * @param {string} id - The ID of the group to fetch
  * @returns {Object} Object containing group data, loading state, and any error
  */
@@ -21121,27 +21199,22 @@ var useGroupData = function (id) {
   var _c = React.useState(true),
     isLoading = _c[0],
     setIsLoading = _c[1];
-  var fetchGroup = React.useCallback(function () {
-    var args_1 = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-      args_1[_i] = arguments[_i];
-    }
-    return __awaiter(void 0, __spreadArray([], args_1, true), void 0, function (showLoading) {
+  var _d = React.useState(false),
+    isInitialFetchDone = _d[0],
+    setIsInitialFetchDone = _d[1];
+  var initialFetch = React.useCallback(function () {
+    return __awaiter(void 0, void 0, void 0, function () {
       var response, err_1;
-      if (showLoading === void 0) {
-        showLoading = true;
-      }
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
             if (!id || !sdk || !sdk.getGroupByID) {
               setError('Unable to fetch group data: invalid configuration');
               setIsLoading(false);
+              setIsInitialFetchDone(true);
               return [2 /*return*/];
             }
-            if (showLoading) {
-              setIsLoading(true);
-            }
+            setIsLoading(true);
             setError(null);
             _a.label = 1;
           case 1:
@@ -21161,9 +21234,8 @@ var useGroupData = function (id) {
             console.error('Error fetching group:', err_1);
             return [3 /*break*/, 5];
           case 4:
-            if (showLoading) {
-              setIsLoading(false);
-            }
+            setIsLoading(false);
+            setIsInitialFetchDone(true);
             return [7 /*endfinally*/];
           case 5:
             return [2 /*return*/];
@@ -21171,12 +21243,49 @@ var useGroupData = function (id) {
       });
     });
   }, [id, sdk]);
+  var silentRefresh = React.useCallback(function () {
+    return __awaiter(void 0, void 0, void 0, function () {
+      var response, err_2;
+      return __generator(this, function (_a) {
+        switch (_a.label) {
+          case 0:
+            if (!id || !sdk || !sdk.getGroupByID || !isInitialFetchDone) {
+              return [2 /*return*/];
+            }
+            _a.label = 1;
+          case 1:
+            _a.trys.push([1, 3,, 4]);
+            return [4 /*yield*/, sdk.refreshGroup(id)];
+          case 2:
+            response = _a.sent();
+            if (response && response.status === 'success' && response.data) {
+              setGroupData(response.data);
+            }
+            return [3 /*break*/, 4];
+          case 3:
+            err_2 = _a.sent();
+            console.error('Error during silent refresh:', err_2);
+            return [3 /*break*/, 4];
+          case 4:
+            return [2 /*return*/];
+        }
+      });
+    });
+  }, [id, sdk, isInitialFetchDone]);
   var refreshGroup = React.useCallback(function () {
-    return fetchGroup(false);
-  }, [fetchGroup]);
+    return silentRefresh();
+  }, [silentRefresh]);
   React.useEffect(function () {
-    fetchGroup(true);
-  }, [fetchGroup]);
+    if (sdk) {
+      initialFetch();
+      var unsubscribeGroup_1 = sdk.subscribeToDataChange('GROUP_DATA_CHANGED', function () {
+        silentRefresh();
+      });
+      return function () {
+        unsubscribeGroup_1();
+      };
+    }
+  }, [initialFetch, id, sdk, silentRefresh]);
   return {
     groupData: groupData,
     isLoading: isLoading,
@@ -21273,7 +21382,7 @@ var Group = function (_a) {
       groupData: groupData
     }
   }, /*#__PURE__*/React.createElement(View$2, {
-    "data-testid": "group-container"
+    testID: "group-container"
   }, /*#__PURE__*/React.createElement(GroupSections, null)));
 };