react-native-smallcase-gateway 7.0.0 → 7.1.0

package/src/SCLoansEventEmitter.js

@@ -1,8 +1,4 @@
-import {
-    NativeEventEmitter,
-    NativeModules,
-    Platform
-} from 'react-native';
+import { NativeEventEmitter, NativeModules } from 'react-native';
 
 /**
  * @typedef {Object} LoansEvent
@@ -16,101 +12,116 @@ import {
 const nativeModule = NativeModules.SCLoansBridgeEmitter;
 
 export const SCLoansEventTypes = {
-    ANALYTICS_EVENT: 'scloans_analytics_event',
-    SUPER_PROPERTIES_UPDATED: 'scloans_super_properties_updated',
+  ANALYTICS_EVENT: 'scloans_analytics_event',
+  SUPER_PROPERTIES_UPDATED: 'scloans_super_properties_updated',
 };
 
 const SCLoansNotificationEvent = 'scloans_notification';
 class SCLoansEvents {
-    constructor() {
-        this.eventEmitter = null;
-        this.subscriptions = [];
-        this.initialize();
+  constructor() {
+    this.eventEmitter = null;
+    this.subscriptions = [];
+    this.initialize();
+  }
+
+  get isInitialized() {
+    return this.eventEmitter !== null;
+  }
+
+  initialize() {
+    if (nativeModule) {
+      this.eventEmitter = new NativeEventEmitter(nativeModule);
+    } else {
+      console.warn('[SCLoansEvents] Native module not available');
     }
-
-    get isInitialized() {
-        return this.eventEmitter !== null;
+  }
+
+  // ===== LOANS EVENT METHODS =====
+  /**
+   * Subscribe to Loans Events
+   * @param {(event: LoansEvent) => void} callback - Callback function to handle loans events
+   * @returns {LoansEventSubscription} subscription - Subscription object with remove() method
+   */
+  subscribeToLoansEvent(callback) {
+    if (!this.isInitialized) {
+      console.warn('[SCLoansEvents] Event emitter not initialized');
+      return null;
     }
 
-    initialize() {
-        if (nativeModule) {
-            this.eventEmitter = new NativeEventEmitter(nativeModule);
-        } else {
-            console.warn('[SCLoansEvents] Native module not available');
-        }
+    if (typeof callback !== 'function') {
+      console.warn(
+        '[SCLoansEvents] Invalid callback provided for subscription'
+      );
+      return null;
     }
 
-    // ===== LOANS EVENT METHODS =====
-    /**
-     * Subscribe to Loans Events
-     * @param {(event: LoansEvent) => void} callback - Callback function to handle loans events
-     * @returns {LoansEventSubscription} subscription - Subscription object with remove() method
-     */
-    subscribeToLoansEvent(callback) {
-        if (!this.isInitialized) {
-            console.warn('[SCLoansEvents] Event emitter not initialized');
-            return null;
+    const subscription = this.eventEmitter.addListener(
+      SCLoansNotificationEvent,
+      (jsonString) => {
+        if (!jsonString) {
+          console.warn('[SCLoansEvents] Received null/undefined event data');
+          return;
         }
 
-        if (typeof callback !== 'function') {
-            console.warn('[SCLoansEvents] Invalid callback provided for subscription');
-            return null;
+        let eventData;
+        try {
+          eventData = JSON.parse(jsonString);
+        } catch (error) {
+          console.warn(
+            '[SCLoansEvents] Failed to parse event JSON:',
+            error,
+            'Raw data:',
+            jsonString
+          );
+          return;
         }
 
-        const subscription = this.eventEmitter.addListener(SCLoansNotificationEvent, (jsonString) => {
-            if (!jsonString) {
-                console.warn('[SCLoansEvents] Received null/undefined event data');
-                return;
-            }
-
-            let eventData;
-            try {
-                eventData = JSON.parse(jsonString);
-            } catch (error) {
-                console.warn('[SCLoansEvents] Failed to parse event JSON:', error, 'Raw data:', jsonString);
-                return;
-            }
-
-            if (!eventData.type) {
-                console.warn('[SCLoansEvents] Dropping event - missing event type:', eventData);
-                return;
-            }
-
-            const normalizedEvent = {
-                type: eventData.type,
-                data: eventData.data,
-                timestamp: eventData.timestamp || Date.now()
-            };
-
-            callback(normalizedEvent);
-        });
-
-        this.subscriptions.push(subscription);
-
-        return subscription;
-    }
-
-    /**
-     * Unsubscribe from Loans Events
-     * @param {LoansEventSubscription} subscription - Subscription returned from subscribeToLoansEvents
-     */
-    unsubscribeFromLoansEvent(subscription) {
-        if (subscription && typeof subscription.remove === 'function') {
-            subscription.remove();
-            this.subscriptions = this.subscriptions.filter(sub => sub !== subscription);
+        if (!eventData.type) {
+          console.warn(
+            '[SCLoansEvents] Dropping event - missing event type:',
+            eventData
+          );
+          return;
         }
-    }
 
-    cleanup() {
-        this.subscriptions.forEach(subscription => {
-            if (subscription && typeof subscription.remove === 'function') {
-                subscription.remove();
-            }
-        });
-        this.subscriptions = [];
+        const normalizedEvent = {
+          type: eventData.type,
+          data: eventData.data,
+          timestamp: eventData.timestamp || Date.now(),
+        };
+
+        callback(normalizedEvent);
+      }
+    );
+
+    this.subscriptions.push(subscription);
+
+    return subscription;
+  }
+
+  /**
+   * Unsubscribe from Loans Events
+   * @param {LoansEventSubscription} subscription - Subscription returned from subscribeToLoansEvents
+   */
+  unsubscribeFromLoansEvent(subscription) {
+    if (subscription && typeof subscription.remove === 'function') {
+      subscription.remove();
+      this.subscriptions = this.subscriptions.filter(
+        (sub) => sub !== subscription
+      );
     }
+  }
+
+  cleanup() {
+    this.subscriptions.forEach((subscription) => {
+      if (subscription && typeof subscription.remove === 'function') {
+        subscription.remove();
+      }
+    });
+    this.subscriptions = [];
+  }
 }
 
 const scLoansEventManager = new SCLoansEvents();
 
-export default scLoansEventManager;
+export default scLoansEventManager;

package/src/ScLoan.js

@@ -31,11 +31,12 @@ const { SmallcaseGateway: SmallcaseGatewayNative } = NativeModules;
  * @throws {ScLoanError}
  */
 const setup = async (config) => {
-    const safeConfig = safeObject(config);
-    if(safeConfig.environment === undefined || safeConfig.environment === null) safeConfig.environment = ENV.PROD
+  const safeConfig = safeObject(config);
+  if (safeConfig.environment === undefined || safeConfig.environment === null)
+    safeConfig.environment = ENV.PROD;
 
-    return SmallcaseGatewayNative.setupLoans(safeConfig);
-  };
+  return SmallcaseGatewayNative.setupLoans(safeConfig);
+};
 
 /**
  * Triggers the LOS Journey
@@ -46,10 +47,10 @@ const setup = async (config) => {
  * @deprecated This method is deprecated use triggerInteraction() instead.
  */
 const apply = async (loanInfo) => {
-    const safeLoanInfo = safeObject(loanInfo);
+  const safeLoanInfo = safeObject(loanInfo);
 
-    return SmallcaseGatewayNative.apply(safeLoanInfo);
-  };
+  return SmallcaseGatewayNative.apply(safeLoanInfo);
+};
 
 /**
  * Triggers the Repayment Journey
@@ -60,10 +61,10 @@ const apply = async (loanInfo) => {
  * @deprecated This method is deprecated use triggerInteraction() instead.
  */
 const pay = async (loanInfo) => {
-    const safeLoanInfo = safeObject(loanInfo);
+  const safeLoanInfo = safeObject(loanInfo);
 
-    return SmallcaseGatewayNative.pay(safeLoanInfo);
-  };
+  return SmallcaseGatewayNative.pay(safeLoanInfo);
+};
 
 /**
  * Triggers the Withdraw Journey
@@ -74,10 +75,10 @@ const pay = async (loanInfo) => {
  * @deprecated This method is deprecated use triggerInteraction() instead.
  */
 const withdraw = async (loanInfo) => {
-    const safeLoanInfo = safeObject(loanInfo);
+  const safeLoanInfo = safeObject(loanInfo);
 
-    return SmallcaseGatewayNative.withdraw(safeLoanInfo);
-  };
+  return SmallcaseGatewayNative.withdraw(safeLoanInfo);
+};
 
 /**
  * Triggers the Servicing Journey
@@ -88,10 +89,10 @@ const withdraw = async (loanInfo) => {
  * @deprecated This method is deprecated use triggerInteraction() instead.
  */
 const service = async (loanInfo) => {
-    const safeLoanInfo = safeObject(loanInfo);
+  const safeLoanInfo = safeObject(loanInfo);
 
-    return SmallcaseGatewayNative.service(safeLoanInfo);
-  };
+  return SmallcaseGatewayNative.service(safeLoanInfo);
+};
 
 /**
  * Triggers the triggerInteraction function
@@ -115,4 +116,4 @@ const ScLoan = {
   triggerInteraction,
 };
 
-export default ScLoan;
+export default ScLoan;

package/src/SmallcaseGateway.js

@@ -1,6 +1,10 @@
-import { NativeModules, Platform } from 'react-native';
+import { NativeModules } from 'react-native';
 import { ENV } from './constants';
-import { safeObject, platformSpecificColorHex } from './util';
+import {
+  safeObject,
+  platformSpecificColorHex,
+  sanitizeBrokerList,
+} from './util';
 import { version } from '../package.json';
 const { SmallcaseGateway: SmallcaseGatewayNative } = NativeModules;
 
@@ -64,7 +68,7 @@ const setConfigEnvironment = async (envConfig) => {
 
   const safeIsLeprechaun = Boolean(isLeprechaun);
   const safeIsAmoEnabled = Boolean(isAmoEnabled);
-  const safeBrokerList = Array.isArray(brokerList) ? brokerList : [];
+  const safeBrokerList = sanitizeBrokerList(brokerList);
   const safeGatewayName = typeof gatewayName === 'string' ? gatewayName : '';
   const safeEnvName =
     typeof environmentName === 'string' ? environmentName : ENV.PROD;
@@ -85,10 +89,15 @@ const setConfigEnvironment = async (envConfig) => {
  *
  * note: this must be called after `setConfigEnvironment()`
  * @param {string} sdkToken
+ * @param {Object} [externalMeta] - external metadata (iOS only, optional)
+ * @param {Object} [externalMeta.externalIdentifier] - key-value pairs for external identifiers (e.g., { userId: '123' })
  */
-const init = async (sdkToken) => {
+const init = async (sdkToken, externalMeta) => {
   const safeToken = typeof sdkToken === 'string' ? sdkToken : '';
-  return SmallcaseGatewayNative.init(safeToken);
+  const safeExternalMeta =
+    externalMeta && typeof externalMeta === 'object' ? externalMeta : null;
+
+  return SmallcaseGatewayNative.init(safeToken, safeExternalMeta);
 };
 
 /**
@@ -103,10 +112,11 @@ const triggerTransaction = async (transactionId, utmParams, brokerList) => {
   const safeUtm = safeObject(utmParams);
   const safeId = typeof transactionId === 'string' ? transactionId : '';
 
-  const safeBrokerList =
-    Array.isArray(brokerList) && brokerList.length
-      ? brokerList
-      : defaultBrokerList;
+  let safeBrokerList = sanitizeBrokerList(brokerList);
+
+  if (safeBrokerList.length === 0) {
+    safeBrokerList = defaultBrokerList;
+  }
 
   return SmallcaseGatewayNative.triggerTransaction(
     safeId,
@@ -183,14 +193,14 @@ const launchSmallplugWithBranding = async (
   const safeBackIconOpacity =
     typeof backIconOpacity === 'number' ? backIconOpacity : 1;
 
-return SmallcaseGatewayNative.launchSmallplugWithBranding(
-        safeEndpoint,
-        safeParams,
-        safeHeaderColor,
-        safeHeaderOpacity,
-        safeBackIconColor,
-        safeBackIconOpacity
-      );
+  return SmallcaseGatewayNative.launchSmallplugWithBranding(
+    safeEndpoint,
+    safeParams,
+    safeHeaderColor,
+    safeHeaderOpacity,
+    safeBackIconColor,
+    safeBackIconOpacity
+  );
 };
 
 /**
@@ -298,4 +308,4 @@ const SmallcaseGateway = {
   showOrders,
 };
 
-export default SmallcaseGateway;
+export default SmallcaseGateway;

package/src/constants.js

@@ -1,35 +1,35 @@
 export const ENV = {
-  STAG: "staging",
-  DEV: "development",
-  PROD: "production",
+  STAG: 'staging',
+  DEV: 'development',
+  PROD: 'production',
 };
 
 export const TRANSACTION_TYPE = {
-  connect: "CONNECT",
-  sipSetup: "SIP_SETUP",
-  fetchFunds: "FETCH_FUNDS",
-  transaction: "TRANSACTION",
-  holdingsImport: "HOLDINGS_IMPORT",
-  authorizeHoldings: "AUTHORISE_HOLDINGS",
-  mfHoldingsImport: "MF_HOLDINGS_IMPORT"
+  connect: 'CONNECT',
+  sipSetup: 'SIP_SETUP',
+  fetchFunds: 'FETCH_FUNDS',
+  transaction: 'TRANSACTION',
+  holdingsImport: 'HOLDINGS_IMPORT',
+  authorizeHoldings: 'AUTHORISE_HOLDINGS',
+  mfHoldingsImport: 'MF_HOLDINGS_IMPORT',
 };
 
 export const ERROR_MSG = {
-  init_sdk: "init_sdk",
-  no_order: "no_order",
-  no_broker: "no_broker",
-  invalid_jwt: "invalid_jwt",
-  market_closed: "market_closed",
-  user_mismatch: "user_mismatch",
-  order_pending: "order_pending",
-  internal_error: "internal_error",
-  user_cancelled: "user_cancelled",
-  consent_denied: "consent_denied",
-  order_in_queue: "order_in_queue",
-  invalid_gateway: "invalid_gateway",
-  transaction_expired: "transaction_expired",
-  invalid_transactionId: "invalid_transactionId",
-  insufficient_holdings: "insufficient_holdings",
-  transaction_in_process: "transaction_in_process",
-  no_compatible_browser: "no_compatible_browser"
+  init_sdk: 'init_sdk',
+  no_order: 'no_order',
+  no_broker: 'no_broker',
+  invalid_jwt: 'invalid_jwt',
+  market_closed: 'market_closed',
+  user_mismatch: 'user_mismatch',
+  order_pending: 'order_pending',
+  internal_error: 'internal_error',
+  user_cancelled: 'user_cancelled',
+  consent_denied: 'consent_denied',
+  order_in_queue: 'order_in_queue',
+  invalid_gateway: 'invalid_gateway',
+  transaction_expired: 'transaction_expired',
+  invalid_transactionId: 'invalid_transactionId',
+  insufficient_holdings: 'insufficient_holdings',
+  transaction_in_process: 'transaction_in_process',
+  no_compatible_browser: 'no_compatible_browser',
 };

package/src/index.js

@@ -1,8 +1,16 @@
-import SmallcaseGateway from "./SmallcaseGateway";
-import ScLoan from "./ScLoan";
-import scGatewayEventManager, { SCGatewayEventTypes } from './SCGatewayEventEmitter';
+import SmallcaseGateway from './SmallcaseGateway';
+import ScLoan from './ScLoan';
+import scGatewayEventManager, {
+  SCGatewayEventTypes,
+} from './SCGatewayEventEmitter';
 import scLoansEventManager, { SCLoansEventTypes } from './SCLoansEventEmitter';
-import { ENV, TRANSACTION_TYPE, ERROR_MSG } from "./constants";
+import { ENV, TRANSACTION_TYPE, ERROR_MSG } from './constants';
 
-export { ScLoan, scGatewayEventManager as SCGatewayEventManager, scLoansEventManager as SCLoansEventManager, SCGatewayEventTypes, SCLoansEventTypes }
+export {
+  ScLoan,
+  scGatewayEventManager as SCGatewayEventManager,
+  scLoansEventManager as SCLoansEventManager,
+  SCGatewayEventTypes,
+  SCLoansEventTypes,
+};
 export default { ...SmallcaseGateway, ENV, ERROR_MSG, TRANSACTION_TYPE };

package/src/util.js

@@ -1,3 +1,5 @@
+import { Platform } from 'react-native';
+
 /**
  * check if value is a valid object.
  *
@@ -6,13 +8,24 @@
  * @param {*} obj
  * @returns {Object} same object if its valid, else returns `{}`
  */
- export const safeObject = (obj) => {
-  return obj && typeof obj === "object" ? obj : {};
+export const safeObject = (obj) => {
+  return obj && typeof obj === 'object' ? obj : {};
 };
 
 export function platformSpecificColorHex(hex) {
   if (Platform.OS === 'android') {
-    return `#${hex}`
+    return `#${hex}`;
   }
-  return hex
+  return hex;
+}
+
+/** sanitize the input broker array to make sure its an array and only has string values */
+export function sanitizeBrokerList(arr) {
+  if (!Array.isArray(arr) || arr.length === 0) {
+    return [];
+  }
+
+  return arr.filter((val) => {
+    return typeof val === 'string' && val.trim() !== '';
+  });
 }

package/types/SmallcaseGateway.d.ts

@@ -95,8 +95,10 @@ declare namespace SmallcaseGateway {
  *
  * note: this must be called after `setConfigEnvironment()`
  * @param {string} sdkToken
+ * @param {Object} [externalMeta] - external metadata (iOS only, optional)
+ * @param {Object} [externalMeta.externalIdentifier] - key-value pairs for external identifiers (e.g., { userId: '123' })
  */
-declare function init(sdkToken: string): unknown;
+declare function init(sdkToken: string, externalMeta?: { externalIdentifier?: { [key: string]: string } }): unknown;
 /**
  * Logs the user out and removes the web session.
  *

package/types/index.d.ts

@@ -67,7 +67,7 @@ declare const _default: {
         authorizeHoldings: string;
         mfHoldingsImport: string;
     };
-    init: (sdkToken: string) => unknown;
+    init: (sdkToken: string, externalMeta?: { externalIdentifier?: { [key: string]: string } }) => unknown;
     logoutUser: () => Promise;
     triggerLeadGen: (userDetails?: import("./SmallcaseGateway").userDetails, utmParams?: any) => any;
     triggerLeadGenWithStatus: (userDetails?: import("./SmallcaseGateway").userDetails) => Promise;