react-onesignal 2.0.2 → 2.0.3

package/dist/index.js

@@ -2,16 +2,39 @@
 
 const ONESIGNAL_SDK_ID = 'onesignal-sdk';
 const ONE_SIGNAL_SCRIPT_SRC = 'https://cdn.onesignal.com/sdks/OneSignalSDK.js';
-const ONESIGNAL_NOT_SETUP_ERROR = 'OneSignal is not setup correctly.';
 const reactOneSignalFunctionQueue = [];
-const MAX_TIMEOUT = 30;
+// true if the script is successfully loaded from CDN.
 let isOneSignalInitialized = false;
-const injectScript = () => {
-    const script = document.createElement('script');
-    script.id = ONESIGNAL_SDK_ID;
-    script.src = ONE_SIGNAL_SCRIPT_SRC;
-    script.async = true;
-    document.head.appendChild(script);
+// true if the script fails to load from CDN. A separate flag is necessary
+// to disambiguate between a CDN load failure and a delayed call to
+// OneSignal#init.
+let isOneSignalScriptFailed = false;
+const doesOneSignalExist = () => {
+    if (window["OneSignal"]) {
+        return true;
+    }
+    return false;
+};
+const handleOnLoad = (resolve, options) => {
+    isOneSignalInitialized = true;
+    // OneSignal is assumed to be loaded correctly because this method
+    // is called after the script is successfully loaded by CDN, but
+    // just in case.
+    window["OneSignal"] = window["OneSignal"] || [];
+    window["OneSignal"].push(() => {
+        window["OneSignal"].init(options);
+    });
+    window["OneSignal"].push(() => {
+        processQueuedOneSignalFunctions();
+        resolve();
+    });
+};
+const handleOnError = (resolve) => {
+    isOneSignalScriptFailed = true;
+    // Ensure that any unresolved functions are cleared from the queue,
+    // even in the event of a CDN load failure.
+    processQueuedOneSignalFunctions();
+    resolve();
 };
 const processQueuedOneSignalFunctions = () => {
     reactOneSignalFunctionQueue.forEach(element => {
@@ -26,46 +49,36 @@ const processQueuedOneSignalFunctions = () => {
         }
     });
 };
-const doesOneSignalExist = () => {
-    if (window["OneSignal"]) {
-        return true;
-    }
-    return false;
-};
-const setupOneSignalIfMissing = () => {
-    if (!doesOneSignalExist()) {
-        window["OneSignal"] = window["OneSignal"] || [];
-    }
-};
 const init = (options) => new Promise(resolve => {
     if (isOneSignalInitialized) {
+        resolve();
         return;
     }
     if (!options || !options.appId) {
         throw new Error('You need to provide your OneSignal appId.');
     }
     if (!document) {
+        resolve();
         return;
     }
-    injectScript();
-    setupOneSignalIfMissing();
-    window["OneSignal"].push(() => {
-        window["OneSignal"].init(options);
-    });
-    const timeout = setTimeout(() => {
-        console.error(ONESIGNAL_NOT_SETUP_ERROR);
-    }, MAX_TIMEOUT * 1000);
-    window["OneSignal"].push(() => {
-        clearTimeout(timeout);
-        processQueuedOneSignalFunctions();
-        resolve();
-    });
-    isOneSignalInitialized = true;
+    const script = document.createElement('script');
+    script.id = ONESIGNAL_SDK_ID;
+    script.src = ONE_SIGNAL_SCRIPT_SRC;
+    script.async = true;
+    script.onload = () => {
+        handleOnLoad(resolve, options);
+    };
+    // Always resolve whether or not the script is successfully initialized.
+    // This is important for users who may block cdn.onesignal.com w/ adblock.
+    script.onerror = () => {
+        handleOnError(resolve);
+    };
+    document.head.appendChild(script);
 });
 function on(event, listener) {
     if (!doesOneSignalExist()) {
         reactOneSignalFunctionQueue.push({
-            name: "on",
+            name: 'on',
             args: arguments,
         });
         return;
@@ -77,7 +90,7 @@ function on(event, listener) {
 function off(event, listener) {
     if (!doesOneSignalExist()) {
         reactOneSignalFunctionQueue.push({
-            name: "off",
+            name: 'off',
             args: arguments,
         });
         return;
@@ -89,7 +102,7 @@ function off(event, listener) {
 function once(event, listener) {
     if (!doesOneSignalExist()) {
         reactOneSignalFunctionQueue.push({
-            name: "once",
+            name: 'once',
             args: arguments,
         });
         return;
@@ -100,9 +113,13 @@ function once(event, listener) {
 }
 function isPushNotificationsEnabled(callback) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "isPushNotificationsEnabled",
+                name: 'isPushNotificationsEnabled',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -122,9 +139,13 @@ function isPushNotificationsEnabled(callback) {
 }
 function showHttpPrompt(options) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "showHttpPrompt",
+                name: 'showHttpPrompt',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -144,9 +165,13 @@ function showHttpPrompt(options) {
 }
 function registerForPushNotifications(options) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "registerForPushNotifications",
+                name: 'registerForPushNotifications',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -166,9 +191,13 @@ function registerForPushNotifications(options) {
 }
 function setDefaultNotificationUrl(url) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "setDefaultNotificationUrl",
+                name: 'setDefaultNotificationUrl',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -188,9 +217,13 @@ function setDefaultNotificationUrl(url) {
 }
 function setDefaultTitle(title) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "setDefaultTitle",
+                name: 'setDefaultTitle',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -210,9 +243,13 @@ function setDefaultTitle(title) {
 }
 function getTags(callback) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "getTags",
+                name: 'getTags',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -232,9 +269,13 @@ function getTags(callback) {
 }
 function sendTag(key, value, callback) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "sendTag",
+                name: 'sendTag',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -254,9 +295,13 @@ function sendTag(key, value, callback) {
 }
 function sendTags(tags, callback) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "sendTags",
+                name: 'sendTags',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -276,9 +321,13 @@ function sendTags(tags, callback) {
 }
 function deleteTag(tag) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "deleteTag",
+                name: 'deleteTag',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -298,9 +347,13 @@ function deleteTag(tag) {
 }
 function deleteTags(tags, callback) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "deleteTags",
+                name: 'deleteTags',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -320,9 +373,13 @@ function deleteTags(tags, callback) {
 }
 function addListenerForNotificationOpened(callback) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "addListenerForNotificationOpened",
+                name: 'addListenerForNotificationOpened',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -342,9 +399,13 @@ function addListenerForNotificationOpened(callback) {
 }
 function setSubscription(newSubscription) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "setSubscription",
+                name: 'setSubscription',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -364,9 +425,13 @@ function setSubscription(newSubscription) {
 }
 function showHttpPermissionRequest(options) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "showHttpPermissionRequest",
+                name: 'showHttpPermissionRequest',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -386,9 +451,13 @@ function showHttpPermissionRequest(options) {
 }
 function showNativePrompt() {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "showNativePrompt",
+                name: 'showNativePrompt',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -408,9 +477,13 @@ function showNativePrompt() {
 }
 function showSlidedownPrompt(options) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "showSlidedownPrompt",
+                name: 'showSlidedownPrompt',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -430,9 +503,13 @@ function showSlidedownPrompt(options) {
 }
 function showCategorySlidedown(options) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "showCategorySlidedown",
+                name: 'showCategorySlidedown',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -452,9 +529,13 @@ function showCategorySlidedown(options) {
 }
 function showSmsSlidedown(options) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "showSmsSlidedown",
+                name: 'showSmsSlidedown',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -474,9 +555,13 @@ function showSmsSlidedown(options) {
 }
 function showEmailSlidedown(options) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "showEmailSlidedown",
+                name: 'showEmailSlidedown',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -496,9 +581,13 @@ function showEmailSlidedown(options) {
 }
 function showSmsAndEmailSlidedown(options) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "showSmsAndEmailSlidedown",
+                name: 'showSmsAndEmailSlidedown',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -518,9 +607,13 @@ function showSmsAndEmailSlidedown(options) {
 }
 function getNotificationPermission(onComplete) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "getNotificationPermission",
+                name: 'getNotificationPermission',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -540,9 +633,13 @@ function getNotificationPermission(onComplete) {
 }
 function getUserId(callback) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "getUserId",
+                name: 'getUserId',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -562,9 +659,13 @@ function getUserId(callback) {
 }
 function getSubscription(callback) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "getSubscription",
+                name: 'getSubscription',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -584,9 +685,13 @@ function getSubscription(callback) {
 }
 function setEmail(email, options) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "setEmail",
+                name: 'setEmail',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -606,9 +711,13 @@ function setEmail(email, options) {
 }
 function setSMSNumber(smsNumber, options) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "setSMSNumber",
+                name: 'setSMSNumber',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -628,9 +737,13 @@ function setSMSNumber(smsNumber, options) {
 }
 function logoutEmail() {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "logoutEmail",
+                name: 'logoutEmail',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -650,9 +763,13 @@ function logoutEmail() {
 }
 function logoutSMS() {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "logoutSMS",
+                name: 'logoutSMS',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -672,9 +789,13 @@ function logoutSMS() {
 }
 function setExternalUserId(externalUserId, authHash) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "setExternalUserId",
+                name: 'setExternalUserId',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -694,9 +815,13 @@ function setExternalUserId(externalUserId, authHash) {
 }
 function removeExternalUserId() {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "removeExternalUserId",
+                name: 'removeExternalUserId',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -716,9 +841,13 @@ function removeExternalUserId() {
 }
 function getExternalUserId() {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "getExternalUserId",
+                name: 'getExternalUserId',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -738,9 +867,13 @@ function getExternalUserId() {
 }
 function provideUserConsent(consent) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "provideUserConsent",
+                name: 'provideUserConsent',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -760,9 +893,13 @@ function provideUserConsent(consent) {
 }
 function getEmailId(callback) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "getEmailId",
+                name: 'getEmailId',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -782,9 +919,13 @@ function getEmailId(callback) {
 }
 function getSMSId(callback) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "getSMSId",
+                name: 'getSMSId',
                 args: arguments,
                 promiseResolver: resolve,
             });
@@ -804,9 +945,13 @@ function getSMSId(callback) {
 }
 function sendOutcome(outcomeName, outcomeWeight) {
     return new Promise((resolve, reject) => {
+        if (isOneSignalScriptFailed) {
+            resolve();
+            return;
+        }
         if (!doesOneSignalExist()) {
             reactOneSignalFunctionQueue.push({
-                name: "sendOutcome",
+                name: 'sendOutcome',
                 args: arguments,
                 promiseResolver: resolve,
             });