Add external id property to operations

Will be used to retry operations for users with a valid Jwt token. Accessed through Operation.model.externalId

src/core/CoreModuleDirector.ts

@@ -41,6 +41,13 @@ export class CoreModuleDirector {
     if (user.hasOneSignalId) {
       pushModel.setOneSignalId(user.onesignalId);
     }
+
+    const identity = this.getIdentityModel();
+    const externalId = identity?.data.external_id;
+    if (externalId) {
+      pushModel.setExternalId(externalId);
+    }
+
     // don't propagate since we will be including the subscription in the user create call
     OneSignal.coreDirector.add(
       ModelName.PushSubscriptions,
@@ -59,7 +66,8 @@ export class CoreModuleDirector {
       const identity = this.getIdentityModel();
       const properties = this.getPropertiesModel();
 
-      const { onesignal_id: onesignalId } = user.identity;
+      const { onesignal_id: onesignalId, external_id: externalId } =
+        user.identity;
 
       if (!onesignalId) {
         throw new OneSignalError('OneSignal ID is missing from user data');
@@ -69,6 +77,11 @@ export class CoreModuleDirector {
       identity?.setOneSignalId(onesignalId);
       properties?.setOneSignalId(onesignalId);
 
+      if (externalId) {
+        identity?.setExternalId(externalId);
+        properties?.setExternalId(externalId);
+      }
+
       // identity and properties models are always single, so we hydrate immediately (i.e. replace existing data)
       identity?.hydrate(user.identity);
       properties?.hydrate(user.properties);
@@ -78,6 +91,7 @@ export class CoreModuleDirector {
       this._hydrateSubscriptions(
         user.subscriptions as SubscriptionModel[],
         onesignalId,
+        externalId,
       );
       EventHelper.checkAndTriggerUserChanged();
     } catch (e) {
@@ -88,6 +102,7 @@ export class CoreModuleDirector {
   private _hydrateSubscriptions(
     subscriptions: SubscriptionModel[],
     onesignalId: string,
+    externalId?: string,
   ): void {
     logMethodCall('CoreModuleDirector._hydrateSubscriptions', {
       subscriptions,
@@ -122,10 +137,16 @@ export class CoreModuleDirector {
       if (existingSubscription) {
         // set onesignalId on existing subscription *before* hydrating so that the onesignalId is updated in model cache
         existingSubscription.setOneSignalId(onesignalId);
+        if (externalId) {
+          existingSubscription?.setExternalId(externalId);
+        }
         existingSubscription.hydrate(subscription);
       } else {
         const model = new OSModel<SupportedModel>(modelName, subscription);
         model.setOneSignalId(onesignalId);
+        if (externalId) {
+          model?.setExternalId(externalId);
+        }
         modelStores[modelName].add(model, false); // don't propagate to server
       }
     });

src/core/caching/EncodedModel.ts

@@ -8,5 +8,6 @@ export default interface EncodedModel {
   modelId: string;
   modelName: ModelName;
   onesignalId?: string;
+  externalId?: string;
   [key: string]: unknown;
 }

src/core/modelRepo/OSModel.ts

@@ -17,6 +17,7 @@ export class OSModel<Model> extends Subscribable<ModelStoreChange<Model>> {
   onesignalId?: string;
   awaitOneSignalIdAvailable: Promise<string>;
   onesignalIdAvailableCallback?: (onesignalId: string) => void;
+  externalId?: string;
 
   constructor(
     readonly modelName: ModelName,
@@ -28,6 +29,7 @@ export class OSModel<Model> extends Subscribable<ModelStoreChange<Model>> {
     this.modelName = modelName;
     this.data = data;
     this.onesignalId = undefined;
+    this.externalId = undefined;
 
     this.awaitOneSignalIdAvailable = new Promise<string>((resolve) => {
       this.onesignalIdAvailableCallback = resolve;
@@ -48,6 +50,11 @@ export class OSModel<Model> extends Subscribable<ModelStoreChange<Model>> {
     }
   }
 
+  public setExternalId(externalId?: string): void {
+    logMethodCall('setExternalId', { externalId });
+    this.externalId = externalId;
+  }
+
   /**
    * We use this method to update the model data.
    * Results in a broadcasted update event.
@@ -92,7 +99,8 @@ export class OSModel<Model> extends Subscribable<ModelStoreChange<Model>> {
     const modelId = this.modelId as string;
     const modelName = this.modelName;
     const onesignalId = this.onesignalId;
-    return { modelId, modelName, onesignalId, ...this.data };
+    const externalId = this.externalId;
+    return { modelId, modelName, onesignalId, externalId, ...this.data };
   }
 
   /**
@@ -102,7 +110,8 @@ export class OSModel<Model> extends Subscribable<ModelStoreChange<Model>> {
    */
   static decode(encodedModel: EncodedModel): OSModel<SupportedModel> {
     logMethodCall('decode', { encodedModel });
-    const { modelId, modelName, onesignalId, ...data } = encodedModel;
+    const { modelId, modelName, onesignalId, externalId, ...data } =
+      encodedModel;
 
     const decodedModel = new OSModel<SupportedModel>(
       modelName as ModelName,
@@ -111,6 +120,7 @@ export class OSModel<Model> extends Subscribable<ModelStoreChange<Model>> {
     );
 
     decodedModel.setOneSignalId(onesignalId);
+    decodedModel.setExternalId(externalId);
     return decodedModel;
   }
 }

src/onesignal/User.ts

@@ -145,6 +145,10 @@ export default class User {
     ) {
       // existing user
       newSubscription.setOneSignalId(User.singletonInstance?.onesignalId);
+      const identityModel = OneSignal.coreDirector.getIdentityModel();
+      if (identityModel.data.external_id) {
+        newSubscription.setExternalId(identityModel.data.external_id);
+      }
       OneSignal.coreDirector.add(
         ModelName.EmailSubscriptions,
         newSubscription,
@@ -165,6 +169,10 @@ export default class User {
         throw e;
       },
     );
+    const identityModel = OneSignal.coreDirector.getIdentityModel();
+    if (identityModel.data.external_id) {
+      newSubscription.setExternalId(identityModel.data.external_id);
+    }
   }
 
   public async addSms(sms: string): Promise<void> {
@@ -194,6 +202,10 @@ export default class User {
     ) {
       // existing user
       newSubscription.setOneSignalId(User.singletonInstance?.onesignalId);
+      const identityModel = OneSignal.coreDirector.getIdentityModel();
+      if (identityModel.data.external_id) {
+        newSubscription.setExternalId(identityModel.data.external_id);
+      }
       OneSignal.coreDirector.add(
         ModelName.SmsSubscriptions,
         newSubscription,
@@ -214,6 +226,10 @@ export default class User {
         throw e;
       },
     );
+    const identityModel = OneSignal.coreDirector.getIdentityModel();
+    if (identityModel.data.external_id) {
+      newSubscription.setExternalId(identityModel.data.external_id);
+    }
   }
 
   public removeEmail(email: string): void {