change subscription to interface

Author: fadi-george

package.json

@@ -84,12 +84,12 @@
     },
     {
       "path": "./build/releases/OneSignalSDK.page.es6.js",
-      "limit": "46.124 kB",
+      "limit": "46.035 kB",
       "gzip": true
     },
     {
       "path": "./build/releases/OneSignalSDK.sw.js",
-      "limit": "13.4 kB",
+      "limit": "13.302 kB",
       "gzip": true
     },
     {

src/onesignal/PushSubscriptionNamespace.ts

@@ -16,7 +16,6 @@ import { IDManager } from 'src/shared/managers/IDManager';
 import type { EventsMap } from 'src/shared/services/types';
 import { EventListenerBase } from '../page/userModel/EventListenerBase';
 import { isCompleteSubscriptionObject } from '../shared/managers/utils';
-import { Subscription } from '../shared/models/Subscription';
 import {
   awaitOneSignalInitAndSupported,
   logMethodCall,
@@ -30,7 +29,7 @@ export default class PushSubscriptionNamespace extends EventListenerBase {
 
   constructor(
     initialize: boolean,
-    subscription?: Subscription,
+    subscription?: UserSubscription,
     permission?: NotificationPermission,
   ) {
     super();

src/onesignal/UserNamespace.test.ts

@@ -5,8 +5,8 @@ import { IdentityConstants } from 'src/core/constants';
 import { ModelChangeTags } from 'src/core/types/models';
 import * as Log from 'src/shared/libraries/log';
 import { IDManager } from 'src/shared/managers/IDManager';
+import type { UserSubscription } from 'src/shared/subscriptions/types';
 import type { UserChangeEvent } from '../page/models/UserChangeEvent';
-import { Subscription } from '../shared/models/Subscription';
 import User from './User';
 import UserNamespace from './UserNamespace';
 
@@ -438,11 +438,11 @@ describe('Initialization', () => {
   });
 
   test('should use provided subscription and permission when initializing', () => {
-    const subscription = new Subscription();
-    subscription.deviceId = 'device-123';
-    subscription.subscriptionToken = PUSH_TOKEN;
-    subscription.optedOut = false;
-    subscription.createdAt = Date.now();
+    const subscription: UserSubscription = {
+      deviceId: 'device-123',
+      subscriptionToken: PUSH_TOKEN,
+      optedOut: false,
+    };
 
     const permission: NotificationPermission = 'granted';
 

src/onesignal/UserNamespace.ts

@@ -2,7 +2,6 @@ import type { UserEventsMap } from 'src/shared/services/types';
 import type { UserChangeEvent } from '../page/models/UserChangeEvent';
 import { EventListenerBase } from '../page/userModel/EventListenerBase';
 import Emitter from '../shared/libraries/Emitter';
-import { Subscription } from '../shared/models/Subscription';
 import PushSubscriptionNamespace from './PushSubscriptionNamespace';
 import User from './User';
 
@@ -15,7 +14,7 @@ export default class UserNamespace extends EventListenerBase {
 
   constructor(
     initialize: boolean,
-    subscription?: Subscription,
+    subscription?: UserSubscription,
     permission?: NotificationPermission,
   ) {
     super();

src/shared/database/subscription.ts

@@ -1,4 +1,4 @@
-import { Subscription } from '../models/Subscription';
+import type { UserSubscription } from '../subscriptions/types';
 import { db, getOptionsValue } from './client';
 
 export const getPushId = async () => {
@@ -16,7 +16,7 @@ export const setPushToken = async (pushToken: string | undefined) => {
 };
 
 export const getSubscription = async () => {
-  const subscription = new Subscription();
+  const subscription: UserSubscription = {};
   subscription.deviceId = (await db.get('Ids', 'userId'))?.id;
   subscription.subscriptionToken = (await db.get('Ids', 'registrationId'))?.id;
 
@@ -44,7 +44,7 @@ export const getSubscription = async () => {
   return subscription;
 };
 
-export const setSubscription = async (subscription: Subscription) => {
+export const setSubscription = async (subscription: UserSubscription) => {
   if (subscription.deviceId) {
     await db.put('Ids', {
       type: 'userId',

src/shared/helpers/subscription.ts

@@ -1,16 +1,18 @@
 import { SubscriptionType } from 'src/shared/subscriptions/constants';
-import type { SubscriptionTypeValue } from 'src/shared/subscriptions/types';
+import type {
+  SubscriptionTypeValue,
+  UserSubscription,
+} from 'src/shared/subscriptions/types';
 import { error } from '../libraries/log';
 import { checkAndTriggerSubscriptionChanged } from '../listeners';
-import { Subscription } from '../models/Subscription';
 import { SubscriptionStrategyKind } from '../models/SubscriptionStrategyKind';
 import { IS_SERVICE_WORKER } from '../utils/env';
 import { incrementPageViewCount } from './pageview';
 import { triggerNotificationPermissionChanged } from './permissions';
 
-export async function registerForPush(): Promise<Subscription | null> {
+export async function registerForPush(): Promise<UserSubscription | null> {
   const context = OneSignal._context;
-  let subscription: Subscription | null = null;
+  let subscription: UserSubscription | null = null;
 
   if (IS_SERVICE_WORKER) throw new Error('Unsupported environment');
   try {

src/shared/managers/subscription/base.ts

@@ -2,11 +2,14 @@ import {
   getSubscription,
   setSubscription,
 } from 'src/shared/database/subscription';
-import type { NotificationTypeValue } from 'src/shared/subscriptions/types';
+import { debug, warn } from 'src/shared/libraries/log';
+import type {
+  NotificationTypeValue,
+  UserSubscription,
+} from 'src/shared/subscriptions/types';
 import type { ContextInterface, ContextSWInterface } from '../../context/types';
 import { useSafariLegacyPush } from '../../environment/detect';
 import { RawPushSubscription } from '../../models/RawPushSubscription';
-import type { Subscription } from '../../models/Subscription';
 import {
   SubscriptionStrategyKind,
   type SubscriptionStrategyKindValue,
@@ -18,7 +21,6 @@ import { getBrowserName } from '../../useragent/detect';
 import { base64ToUint8Array } from '../../utils/encode';
 import { IS_SERVICE_WORKER } from '../../utils/env';
 import { DEFAULT_DEVICE_ID } from './constants';
-import { debug, warn } from 'src/shared/libraries/log';
 
 export interface SubscriptionManagerConfig {
   safariWebId?: string;
@@ -65,7 +67,7 @@ export class SubscriptionManagerBase<
     pushSubscription: RawPushSubscription | undefined,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     _subscriptionState?: NotificationTypeValue | null,
-  ): Promise<Subscription> {
+  ): Promise<UserSubscription> {
     /*
       This may be called after the RawPushSubscription has been serialized across a postMessage
       frame. This means it will only have object properties and none of the functions. We have to
@@ -300,9 +302,7 @@ export class SubscriptionManagerBase<
   private static async _doPushUnsubscribe(
     pushSubscription: PushSubscription,
   ): Promise<boolean> {
-    debug(
-      '[Subscription Manager] Unsubscribing existing push subscription.',
-    );
+    debug('[Subscription Manager] Unsubscribing existing push subscription.');
     const result = await pushSubscription.unsubscribe();
     debug(
       `[Subscription Manager] Unsubscribing existing push subscription result: ${result}`,

src/shared/models/Subscription.ts

@@ -12,3 +12,27 @@ export type SubscriptionTypeValue =
 
 export type NotificationTypeValue =
   (typeof NotificationType)[keyof typeof NotificationType];
+
+export interface UserSubscription {
+  /**
+   * The OneSignal subscription id.
+   */
+  deviceId?: string | null;
+  /**
+   * The GCM/FCM registration token, as a stringified URL, or the Safari device token.
+   */
+  subscriptionToken?: string | null;
+  /**
+   * Whether the user is opted out of notifications, set by setSubscription().
+   */
+  optedOut?: boolean;
+  /**
+   * A UTC timestamp of when this subscription was created. This value is not modified when a
+   * subscription is merely refreshed, only when a subscription is created anew.
+   */
+  createdAt?: number | null;
+  /**
+   * This property is stored on the native PushSubscription object.
+   */
+  expirationTime?: number | null;
+}

src/shared/subscriptions/types.ts

@@ -181,7 +181,7 @@ function setupMessageListeners() {
         );
       workerMessenger._broadcast(
         WorkerMessengerCommand._Subscribe,
-        subscription._serialize(),
+        subscription,
       );
     },
   );
@@ -201,7 +201,7 @@ function setupMessageListeners() {
 
       workerMessenger._broadcast(
         WorkerMessengerCommand._SubscribeNew,
-        subscription._serialize(),
+        subscription,
       );
     },
   );