refactor(plugin): remove deprecated subscription properties

Author: fadi-george

src/OneSignalPlugin.ts

@@ -44,9 +44,7 @@ export class OneSignalPlugin implements OneSignalAPI {
   initialize(appId: string): Promise<void> {
     this._appID = appId;
 
-    return this._plugin.initialize({ appId: this._appID }).then(() => {
-      this.User.pushSubscription._setPropertiesAndObserver();
-    });
+    return this._plugin.initialize({ appId: this._appID });
   }
 
   /**

src/PushSubscriptionNamespace.test.ts

@@ -22,73 +22,6 @@ describe('PushSubscription', () => {
     expect(pushSubscription).toBeInstanceOf(PushSubscription);
   });
 
-  describe('id (deprecated)', () => {
-    test('should set id via getPushSubscriptionId', async () => {
-      mockPlugin.getPushSubscriptionId.mockResolvedValue({ id: SUB_ID });
-      pushSubscription._setPropertiesAndObserver();
-
-      await vi.waitFor(() => {
-        expect(pushSubscription.id).toBe(SUB_ID);
-      });
-    });
-
-    test('should set id via addEventListener', () => {
-      pushSubscription._setPropertiesAndObserver();
-
-      const listener = mockPlugin.addListener.mock.calls.find(
-        (call) => call[0] === 'pushSubscriptionChange',
-      )?.[1];
-      listener?.({ current: { id: SUB_ID, token: SUB_TOKEN, optedIn: true } });
-      expect(pushSubscription.id).toBe(SUB_ID);
-    });
-  });
-
-  describe('token (deprecated)', () => {
-    test('should set token via getPushSubscriptionToken', async () => {
-      mockPlugin.getPushSubscriptionToken.mockResolvedValue({
-        token: SUB_TOKEN,
-      });
-      pushSubscription._setPropertiesAndObserver();
-
-      await vi.waitFor(() => {
-        expect(pushSubscription.token).toBe(SUB_TOKEN);
-      });
-    });
-
-    test('should set token via addEventListener', () => {
-      pushSubscription._setPropertiesAndObserver();
-
-      const listener = mockPlugin.addListener.mock.calls.find(
-        (call) => call[0] === 'pushSubscriptionChange',
-      )?.[1];
-      listener?.({ current: { id: SUB_ID, token: SUB_TOKEN, optedIn: true } });
-      expect(pushSubscription.token).toBe(SUB_TOKEN);
-    });
-  });
-
-  describe('optedIn (deprecated)', () => {
-    test('should set optedIn via getPushSubscriptionOptedIn', async () => {
-      mockPlugin.getPushSubscriptionOptedIn.mockResolvedValue({
-        optedIn: true,
-      });
-      pushSubscription._setPropertiesAndObserver();
-
-      await vi.waitFor(() => {
-        expect(pushSubscription.optedIn).toBe(true);
-      });
-    });
-
-    test('should set optedIn via addEventListener', () => {
-      pushSubscription._setPropertiesAndObserver();
-
-      const listener = mockPlugin.addListener.mock.calls.find(
-        (call) => call[0] === 'pushSubscriptionChange',
-      )?.[1];
-      listener?.({ current: { id: SUB_ID, token: SUB_TOKEN, optedIn: true } });
-      expect(pushSubscription.optedIn).toBe(true);
-    });
-  });
-
   describe('getIdAsync', () => {
     test('should return a Promise', () => {
       const promise = pushSubscription.getIdAsync();

src/PushSubscriptionNamespace.ts

@@ -15,9 +15,6 @@ export interface PushSubscriptionChangedState {
 
 export default class PushSubscription implements OneSignalPushSubscriptionAPI {
   private _plugin: OneSignalCapacitorPlugin;
-  private _id?: string | null;
-  private _token?: string | null;
-  private _optedIn?: boolean;
 
   private _subscriptionObserverList: ((event: PushSubscriptionChangedState) => void)[] = [];
 
@@ -34,60 +31,6 @@ export default class PushSubscription implements OneSignalPushSubscriptionAPI {
     }
   }
 
-  /**
-   * Sets initial Push Subscription properties and adds observer for changes.
-   * This internal method is kept to support the deprecated methods {@link id}, {@link token}, {@link optedIn}.
-   */
-  _setPropertiesAndObserver(): void {
-    void this._plugin.getPushSubscriptionId().then((result) => {
-      this._id = result.id;
-    });
-
-    void this._plugin.getPushSubscriptionToken().then((result) => {
-      this._token = result.token;
-    });
-
-    void this._plugin.getPushSubscriptionOptedIn().then((result) => {
-      this._optedIn = result.optedIn;
-    });
-
-    this.addEventListener('change', (subscriptionChange) => {
-      this._id = subscriptionChange.current.id;
-      this._token = subscriptionChange.current.token;
-      this._optedIn = subscriptionChange.current.optedIn;
-    });
-  }
-
-  /**
-   * @deprecated This method is deprecated. It has been replaced by {@link getIdAsync}.
-   */
-  get id(): string | null | undefined {
-    console.warn(
-      'OneSignal: This method has been deprecated. Use getIdAsync instead for getting push subscription id.',
-    );
-    return this._id;
-  }
-
-  /**
-   * @deprecated This method is deprecated. It has been replaced by {@link getTokenAsync}.
-   */
-  get token(): string | null | undefined {
-    console.warn(
-      'OneSignal: This method has been deprecated. Use getTokenAsync instead for getting push subscription token.',
-    );
-    return this._token;
-  }
-
-  /**
-   * @deprecated This method is deprecated. It has been replaced by {@link getOptedInAsync}.
-   */
-  get optedIn(): boolean {
-    console.warn(
-      'OneSignal: This method has been deprecated. Use getOptedInAsync instead for getting push subscription opted in status.',
-    );
-    return this._optedIn || false;
-  }
-
   /**
    * The readonly push subscription ID.
    * @returns {Promise<string | null>}

src/api.ts

@@ -21,15 +21,6 @@ export interface OneSignalDebugAPI {
  * Push subscription state and controls exposed via `OneSignal.User.pushSubscription`.
  */
 export interface OneSignalPushSubscriptionAPI {
-  /** @deprecated Use {@link getIdAsync} instead. */
-  readonly id: string | null | undefined;
-
-  /** @deprecated Use {@link getTokenAsync} instead. */
-  readonly token: string | null | undefined;
-
-  /** @deprecated Use {@link getOptedInAsync} instead. */
-  readonly optedIn: boolean;
-
   /** Get the current device's push subscription ID, or null if not yet assigned. */
   getIdAsync(): Promise<string | null>;
 

src/index.test.ts

@@ -1,4 +1,4 @@
-import { describe, test, expect, vi, beforeEach } from 'vitest';
+import { describe, test, expect, beforeEach } from 'vitest';
 
 import { createMockPlugin } from '../mocks/capacitor';
 import { APP_ID } from '../mocks/constants';
@@ -31,10 +31,6 @@ describe('OneSignalPlugin', () => {
     await plugin.initialize(APP_ID);
 
     expect(mockPlugin.initialize).toHaveBeenCalledWith({ appId: APP_ID });
-
-    await vi.waitFor(() => {
-      expect(mockPlugin.getPushSubscriptionId).toHaveBeenCalled();
-    });
   });
 
   test('should call plugin for login', async () => {