Merge pull request #165 from OneSignal/cd_update

sync with web-shim-codegen v3.0.4

Author: fadi-george

.eslintignore

@@ -0,0 +1,2 @@
+dist/
+example/

.eslintrc.cjs

@@ -1,4 +1,5 @@
 module.exports = {
+  root: true,
   env: {
     browser: true,
     es6: true,
@@ -12,7 +13,10 @@ module.exports = {
       },
     },
   },
-  extends: ['plugin:react/recommended'],
+  extends: [
+    'plugin:react/recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
   parser: '@typescript-eslint/parser',
   parserOptions: {
     ecmaFeatures: {
@@ -25,13 +29,14 @@ module.exports = {
   rules: {
     'react/jsx-filename-extension': [1, { extensions: ['.tsx', '.jsx'] }],
     'react/jsx-props-no-spreading': 0,
+    '@typescript-eslint/no-unused-vars': ['error'],
+    '@typescript-eslint/no-explicit-any': 'warn',
     'prefer-destructuring': 0,
     'no-param-reassign': 0,
     'import/extensions': 0,
     'dot-notation': 0,
     'no-continue': 0,
     'no-unused-vars': 'off',
-    '@typescript-eslint/no-unused-vars': ['error'],
     'no-unused-expressions': [
       'error',
       { allowShortCircuit: true, allowTernary: true },

index.test.ts

@@ -0,0 +1,50 @@
+import OneSignal from './index';
+
+const originalDocument = global.document;
+const documentSpy = vi.spyOn(global, 'document', 'get');
+
+const APP_ID = '123456';
+
+const init = vi.fn();
+// @ts-expect-error - mocking OneSignal class that comes from the cdn
+window.OneSignal = {
+  init,
+};
+window.OneSignalDeferred = [];
+Object.defineProperty(window.OneSignalDeferred, 'push', {
+  value: (cb: (OneSignal: typeof window.OneSignal) => void) => {
+    cb(window.OneSignal);
+  },
+});
+
+describe('React OneSignal', () => {
+  test('init method', async () => {
+    // no document error
+    documentSpy.mockReturnValue(undefined);
+    await expect(OneSignal.init({ appId: APP_ID })).rejects.toThrow(
+      'Document is not defined.',
+    );
+    documentSpy.mockImplementation(() => originalDocument);
+
+    // no appId error
+    // @ts-expect-error - appId is required but purposely not provided for this test
+    await expect(OneSignal.init({})).rejects.toThrow(
+      'You need to provide your OneSignal appId.',
+    );
+
+    // init error
+    init.mockRejectedValue(new Error('init error'));
+    await expect(OneSignal.init({ appId: APP_ID })).rejects.toThrow(
+      'init error',
+    );
+
+    // init success
+    init.mockResolvedValue(undefined);
+    await expect(OneSignal.init({ appId: APP_ID })).resolves.not.toThrow();
+
+    // already initialized error
+    await expect(OneSignal.init({ appId: APP_ID })).rejects.toThrow(
+      'OneSignal is already initialized.',
+    );
+  });
+});

index.ts

@@ -1,5 +1,6 @@
 const ONESIGNAL_SDK_ID = 'onesignal-sdk';
-const ONE_SIGNAL_SCRIPT_SRC = "https://cdn.onesignal.com/sdks/web/v16/OneSignalSDK.page.js";
+const ONE_SIGNAL_SCRIPT_SRC =
+  'https://cdn.onesignal.com/sdks/web/v16/OneSignalSDK.page.js';
 
 // true if the script is successfully loaded from CDN.
 let isOneSignalInitialized = false;
@@ -39,7 +40,7 @@ function addSDKScript() {
   // This is important for users who may block cdn.onesignal.com w/ adblock.
   script.onerror = () => {
     handleOnError();
-  }
+  };
 
   document.head.appendChild(script);
 }
@@ -57,20 +58,26 @@ function isPushNotificationsSupported() {
 
 function isMacOSSafariInIframe(): boolean {
   // Fallback detection for Safari on macOS in an iframe context
-  return window.top !== window && // isContextIframe
-  navigator.vendor === "Apple Computer, Inc." && // isSafari
-  navigator.platform === "MacIntel"; // isMacOS
+  return (
+    window.top !== window && // isContextIframe
+    navigator.vendor === 'Apple Computer, Inc.' && // isSafari
+    navigator.platform === 'MacIntel'
+  ); // isMacOS
 }
 
 function supportsSafariPush(): boolean {
-  return (window.safari && typeof window.safari.pushNotification !== "undefined") ||
-          isMacOSSafariInIframe();
+  return (
+    (window.safari && typeof window.safari.pushNotification !== 'undefined') ||
+    isMacOSSafariInIframe()
+  );
 }
 
 // Does the browser support the standard Push API
 function supportsVapidPush(): boolean {
-  return typeof PushSubscriptionOptions !== "undefined" &&
-         PushSubscriptionOptions.prototype.hasOwnProperty("applicationServerKey");
+  return (
+    typeof PushSubscriptionOptions !== 'undefined' &&
+    PushSubscriptionOptions.prototype.hasOwnProperty('applicationServerKey')
+  );
 }
 /* E N D */
 
@@ -82,7 +89,7 @@ function supportsVapidPush(): boolean {
  */
 const isPushSupported = (): boolean => {
   return isPushNotificationsSupported();
-}
+};
 
 /**
  * @PublicApi
@@ -93,19 +100,21 @@ const init = (options: IInitObject): Promise<void> => {
   }
 
   if (!options || !options.appId) {
-    throw new Error('You need to provide your OneSignal appId.');
+    return Promise.reject('You need to provide your OneSignal appId.');
   }
 
   if (!document) {
     return Promise.reject(`Document is not defined.`);
   }
 
-  return new Promise<void>((resolve) => {
+  return new Promise<void>((resolve, reject) => {
     window.OneSignalDeferred?.push((OneSignal) => {
-      OneSignal.init(options).then(() => {
-        isOneSignalInitialized = true;
-        resolve();
-      });
+      OneSignal.init(options)
+        .then(() => {
+          isOneSignalInitialized = true;
+          resolve();
+        })
+        .catch(reject);
     });
   });
 };
@@ -117,7 +126,7 @@ export interface IOneSignalTagCategory { tag: string; label: string; checked?: b
 export type PushSubscriptionNamespaceProperties = { id: string | null | undefined; token: string | null | undefined; optedIn: boolean; };
 export type SubscriptionChangeEvent = { previous: PushSubscriptionNamespaceProperties; current: PushSubscriptionNamespaceProperties; };
 export type NotificationEventName = 'click' | 'foregroundWillDisplay' | 'dismiss' | 'permissionChange' | 'permissionPromptDisplay';
-export type SlidedownEventName = 'slidedownShown';
+export type SlidedownEventName = 'slidedownAllowClick' | 'slidedownCancelClick' | 'slidedownClosed' | 'slidedownQueued' | 'slidedownShown';
 export type OneSignalDeferredLoadedCallback = (onesignal: IOneSignalOneSignal) => void;
 export interface IOSNotification {
   /**