onesignal-cordova-plugin - npm Package Compare versions

Comparing version 2.11.3 to 3.0.0-beta1

package.json

 {
-  "version": "2.11.3",
+  "version": "3.0.0-beta1",
 
@@ -26,3 +26,2 @@ "name": "onesignal-cordova-plugin",
     "ios",
-    "windows",
     "amazon-fireos"
@@ -57,3 +56,2 @@ ],
       "ios",
-      "windows",
       "amazon-fireos"
@@ -60,0 +58,0 @@ ]

www/OneSignal.js

@@ -28,17 +28,17 @@ /**
 
+var OSNotificationReceivedEvent = require('./NotificationReceived').OSNotificationReceivedEvent;
+var OSNotificationOpenedResult = require('./NotificationOpened');
+var OSInAppMessageAction = require('./InAppMessage');
+var OSDeviceState = require('./Subscription').OSDeviceState;
+var OSPermissionStateChanges = require('./Subscription').OSPermissionStateChanges;
+var OSSubscriptionStateChanges = require('./Subscription').OSSubscriptionStateChanges;
+var OSEmailSubscriptionStateChanges = require('./Subscription').OSEmailSubscriptionStateChanges;
+
 var OneSignal = function() {
     var _appID = "";
-    var _googleProjectNumber = "";
-    var _iOSSettings = {};
-    var _notificationReceivedDelegate = function() {};
-    var _notificationOpenedDelegate = function() {};
-    var _inAppMessageClickDelegate = function () {};
+    var _notificationWillShowInForegroundDelegate = function(notificationReceived) {};
+    var _notificationOpenedDelegate = function(notificationOpened) {};
+    var _inAppMessageClickDelegate = function (action) {};
 };
 
-OneSignal.prototype.OSInFocusDisplayOption = {
-    None: 0,
-    InAppAlert : 1,
-    Notification : 2
-};
-
 OneSignal.prototype.OSNotificationPermission = {
@@ -50,4 +50,2 @@ NotDetermined: 0,
 
-OneSignal._displayOption = OneSignal.prototype.OSInFocusDisplayOption.InAppAlert;
-
 OneSignal._permissionObserverList = [];
@@ -59,12 +57,17 @@ OneSignal._subscriptionObserverList = [];
 // You must call init before any other OneSignal function.
-//  Android - googleProjectNumber: Deprecated; pulled from dashboard, local value is ignored
-OneSignal.prototype.startInit = function(appId, googleProjectNumber) {
+OneSignal.prototype.setAppId = function(appId) {
     OneSignal._appID = appId;
-    OneSignal._googleProjectNumber = googleProjectNumber;
-    return this;
+
+    cordova.exec(function() {}, function(){}, "OneSignalPush", "init", [OneSignal._appID]);
 };
 
-OneSignal.prototype.handleNotificationReceived = function(handleNotificationReceivedCallback) {
-    OneSignal._notificationReceivedDelegate = handleNotificationReceivedCallback;
-    return this;
+OneSignal.prototype.handleNotificationWillShowInForeground = function(handleNotificationWillShowInForegroundCallback) {
+    OneSignal._notificationWillShowInForegroundDelegate = handleNotificationWillShowInForegroundCallback;
+    
+    var foregroundParsingHandler = function(notificationReceived) {
+        console.log("foregroundParsingHandler " + JSON.stringify(notificationReceived));
+        OneSignal._notificationWillShowInForegroundDelegate(OSNotificationReceivedEvent.create(notificationReceived));
+    };
+
+    cordova.exec(foregroundParsingHandler, function(){}, "OneSignalPush", "setNotificationWillShowInForegroundHandler", []);
 };
@@ -74,3 +77,8 @@
     OneSignal._notificationOpenedDelegate = handleNotificationOpenedCallback;
-    return this;
+
+    var notificationOpenedHandler = function(json) {
+        OneSignal._notificationOpenedDelegate(new OSNotificationOpenedResult(json));
+    };
+
+    cordova.exec(notificationOpenedHandler, function(){}, "OneSignalPush", "setNotificationOpenedHandler", []);
 };
@@ -80,28 +88,10 @@
     OneSignal._inAppMessageClickDelegate = handler;
-    return this;
-};
 
-OneSignal.prototype.inFocusDisplaying = function(display) {
-    OneSignal._displayOption = display;
-    return this;
-};
+    var inAppMessageClickHandler = function(json) {
+        OneSignal._inAppMessageClickDelegate(new OSInAppMessageAction(json));
+    };
 
-//Possible settings keys:
-// kOSSettingsKeyInAppLaunchURL: Bool. Enable in-app webviews for urls. Default: Enabled
-// kOSSettingsKeyAutoPrompt: Bool. Enable automatic prompting for notifications. Default: Enabled
-OneSignal.prototype.iOSSettings = function(settings) {
-    OneSignal._iOSSettings = settings;
-    return this;
+    cordova.exec(inAppMessageClickHandler, function() {}, "OneSignalPush", "setInAppMessageClickHandler", []);
 };
 
-OneSignal.prototype.endInit = function() {
-
-    //Pass notification received handler
-    cordova.exec(OneSignal._notificationReceivedDelegate, function(){}, "OneSignalPush", "setNotificationReceivedHandler", []);
-    cordova.exec(OneSignal._notificationOpenedDelegate, function(){}, "OneSignalPush", "setNotificationOpenedHandler", []);
-    cordova.exec(OneSignal._inAppMessageClickDelegate, function() {}, "OneSignalPush", "setInAppMessageClickHandler", []);
-    //Call Init
-    cordova.exec(function() {}, function(){}, "OneSignalPush", "init", [OneSignal._appID, OneSignal._googleProjectNumber, OneSignal._iOSSettings, OneSignal._displayOption]);
-};
-
 OneSignal._processFunctionList = function(array, param) {
@@ -112,19 +102,11 @@ for (var i = 0; i < array.length; i++)
 
-OneSignal._formatPermissionObj = function(state) {
-    // If Android format, match it to the iOS format
-    if ("undefined" !== typeof state.enabled) {
-        state.hasPrompted = true;
-        state.state = state.enabled ? OneSignal.prototype.OSNotificationPermission.Authorized : OneSignal.prototype.OSNotificationPermission.Denied;
-        delete state.enabled
-    }
+OneSignal.prototype.completeNotification = function(notification, shouldDisplay) {
+    cordova.exec(function(){}, function(){}, "OneSignalPush", "completeNotification", [notification.notificationId, shouldDisplay]);
 };
 
-OneSignal.prototype.addPermissionObserver = function(callback) {
-    OneSignal._permissionObserverList.push(callback);
-    var permissionCallBackProcessor = function(state) {
-        OneSignal._formatPermissionObj(state.to);
-        OneSignal._formatPermissionObj(state.from);
-        OneSignal._processFunctionList(OneSignal._permissionObserverList, state);
+OneSignal.prototype.getDeviceState = function(deviceStateReceivedCallBack) {
+    var deviceStateCallback = function(json) {
+        deviceStateReceivedCallBack(new OSDeviceState(json));
     };
-    cordova.exec(permissionCallBackProcessor, function(){}, "OneSignalPush", "addPermissionObserver", []);
+    cordova.exec(deviceStateCallback, function(){}, "OneSignalPush", "getDeviceState", []);
 };
@@ -135,3 +117,3 @@
     var subscriptionCallBackProcessor = function(state) {
-        OneSignal._processFunctionList(OneSignal._subscriptionObserverList, state);
+        OneSignal._processFunctionList(OneSignal._subscriptionObserverList, new OSSubscriptionStateChanges(state));
     };
@@ -144,3 +126,3 @@ cordova.exec(subscriptionCallBackProcessor, function(){}, "OneSignalPush", "addSubscriptionObserver", []);
     var emailSubscriptionCallbackProcessor = function(state) {
-        OneSignal._processFunctionList(OneSignal._emailSubscriptionObserverList, state);
+        OneSignal._processFunctionList(OneSignal._emailSubscriptionObserverList, new OSEmailSubscriptionStateChanges(state));
     };
@@ -150,19 +132,10 @@ cordova.exec(emailSubscriptionCallbackProcessor, function(){}, "OneSignalPush", "addEmailSubscriptionObserver", []);
 
-OneSignal.prototype.setInFocusDisplaying = function(displayType) {
-    OneSignal._displayOption = displayType;
-    cordova.exec(function(){}, function(){}, "OneSignalPush", "setInFocusDisplaying", [displayType]);
-};
-
-OneSignal.prototype.getPermissionSubscriptionState = function(callback) {
-    var internalCallBackProcessor = function(state) {
-        OneSignal._formatPermissionObj(state.permissionStatus);
-        callback(state);
+OneSignal.prototype.addPermissionObserver = function(callback) {
+    OneSignal._permissionObserverList.push(callback);
+    var permissionCallBackProcessor = function(state) {
+        OneSignal._processFunctionList(OneSignal._permissionObserverList, new OSPermissionStateChanges(state));
     };
-    cordova.exec(internalCallBackProcessor, function(){}, "OneSignalPush", "getPermissionSubscriptionState", []);
+    cordova.exec(permissionCallBackProcessor, function(){}, "OneSignalPush", "addPermissionObserver", []);
 };
 
-OneSignal.prototype.getIds = function(IdsReceivedCallBack) {
-    cordova.exec(IdsReceivedCallBack, function(){}, "OneSignalPush", "getIds", []);
-};
-
 OneSignal.prototype.getTags = function(tagsReceivedCallBack) {
@@ -173,3 +146,3 @@ cordova.exec(tagsReceivedCallBack, function(){}, "OneSignalPush", "getTags", []);
 OneSignal.prototype.sendTag = function(key, value) {
-    jsonKeyValue = {};
+    const jsonKeyValue = {};
     jsonKeyValue[key] = value;
@@ -191,8 +164,9 @@ cordova.exec(function(){}, function(){}, "OneSignalPush", "sendTags", [jsonKeyValue]);
 
-// Only applies to iOS(does nothing on Android as it always silently registers)
+// Only applies to iOS (does nothing on Android as it always silently registers)
 // Call only if you passed false to autoRegister
-OneSignal.prototype.registerForPushNotifications = function() {
-    cordova.exec(function(){}, function(){}, "OneSignalPush", "registerForPushNotifications", []);
+OneSignal.prototype.registerForProvisionalAuthorization = function(provisionalAuthCallback) {
+    cordova.exec(provisionalAuthCallback, function(){}, "OneSignalPush", "registerForProvisionalAuthorization", []);
 };
 
+// Only applies to iOS (does nothing on Android as it always silently registers without user permission)
 OneSignal.prototype.promptForPushNotificationsWithUserResponse = function(callback) {
@@ -205,2 +179,3 @@ var internalCallback = function(data) {
 
+// Only applies to Android.
 OneSignal.prototype.clearOneSignalNotifications = function() {
@@ -210,18 +185,20 @@ cordova.exec(function(){}, function(){}, "OneSignalPush", "clearOneSignalNotifications", []);
 
-// Only applies to Android, vibrate is on by default but can be disabled by passing in false.
-OneSignal.prototype.enableVibrate = function(enable) {
-    cordova.exec(function(){}, function(){}, "OneSignalPush", "enableVibrate", [enable]);
+// Only applies to Android.
+// If notifications are disabled for your app, unsubscribe the user from OneSignal.
+OneSignal.prototype.unsubscribeWhenNotificationsAreDisabled = function(unsubscribe) {
+    cordova.exec(function(){}, function(){}, "OneSignalPush", "unsubscribeWhenNotificationsAreDisabled", [unsubscribe]);
 };
 
-// Only applies to Android, sound is on by default but can be disabled by passing in false.
-OneSignal.prototype.enableSound = function(enable) {
-    cordova.exec(function(){}, function(){}, "OneSignalPush", "enableSound", [enable]);
+// Only applies to Android. Cancels a single OneSignal notification based on its Android notification integer ID
+OneSignal.prototype.removeNotification = function(id) {
+    cordova.exec(function(){}, function(){}, "OneSignalPush", "removeNotification", [id]);
 };
 
-OneSignal.prototype.enableNotificationsWhenActive = function(enable) {
-    cordova.exec(function(){}, function(){}, "OneSignalPush", "enableNotificationsWhenActive", [enable]);
+// Only applies to Android. Cancels a single OneSignal notification based on its Android notification group ID
+OneSignal.prototype.removeGroupedNotifications = function(groupId) {
+    cordova.exec(function(){}, function(){}, "OneSignalPush", "removeGroupedNotifications", [groupId]);
 };
 
-OneSignal.prototype.setSubscription = function(enable) {
-    cordova.exec(function(){}, function(){}, "OneSignalPush", "setSubscription", [enable]);
+OneSignal.prototype.disablePush = function(disable) {
+    cordova.exec(function(){}, function(){}, "OneSignalPush", "disablePush", [disable]);
 };
@@ -239,20 +216,25 @@
 
-OneSignal.prototype.promptLocation = function() {
-    cordova.exec(function(){}, function(){}, "OneSignalPush", "promptLocation", []);
+OneSignal.prototype.setLogLevel = function(logLevel) {
+    cordova.exec(function(){}, function(){}, "OneSignalPush", "setLogLevel", [logLevel]);
 };
 
-OneSignal.prototype.syncHashedEmail = function(email) {
-    cordova.exec(function(){}, function(){}, "OneSignalPush", "syncHashedEmail", [email]);
+OneSignal.prototype.userProvidedPrivacyConsent = function(callback) {
+    cordova.exec(callback, function(){}, "OneSignalPush", "userProvidedPrivacyConsent", []);
 };
 
-OneSignal.prototype.setLogLevel = function(logLevel) {
-    cordova.exec(function(){}, function(){}, "OneSignalPush", "setLogLevel", [logLevel]);
+OneSignal.prototype.requiresUserPrivacyConsent = function(callback) {
+    cordova.exec(callback, function(){}, "OneSignalPush", "requiresUserPrivacyConsent", []);
 };
 
-OneSignal.prototype.setLocationShared = function(shared) {
-    cordova.exec(function() {}, function() {}, "OneSignalPush", "setLocationShared", [shared]);
+OneSignal.prototype.setRequiresUserPrivacyConsent = function(required) {
+    cordova.exec(function() {}, function() {}, "OneSignalPush", "setRequiresUserPrivacyConsent", [required]);
 };
 
-//email
+OneSignal.prototype.provideUserConsent = function(granted) {
+    cordova.exec(function() {}, function() {}, "OneSignalPush", "provideUserConsent", [granted]);
+};
 
+/**
+ * Email
+ */
 OneSignal.prototype.setEmail = function(email, emailAuthToken, onSuccess, onFailure) {
@@ -288,14 +270,2 @@ if (onSuccess == null)
 
-OneSignal.prototype.userProvidedPrivacyConsent = function(callback) {
-    cordova.exec(callback, function(){}, "OneSignalPush", "userProvidedPrivacyConsent", []);
-};
-
-OneSignal.prototype.setRequiresUserPrivacyConsent = function(required) {
-    cordova.exec(function() {}, function() {}, "OneSignalPush", "setRequiresUserPrivacyConsent", [required]);
-};
-
-OneSignal.prototype.provideUserConsent = function(granted) {
-    cordova.exec(function() {}, function() {}, "OneSignalPush", "provideUserConsent", [granted]);
-};
-
 /** Possible function usages
@@ -346,5 +316,4 @@ setExternalUserId(externalId: string?): void
 /**
- * in app messaging
+ * In app messaging
  */
-
 OneSignal.prototype.addTriggers = function(triggers) {
@@ -389,5 +358,4 @@ Object.keys(triggers).forEach(function(key){
 /**
- * outcomes
+ * Outcomes
  */
-
 OneSignal.prototype.sendOutcome = function(name, callback) {
@@ -441,2 +409,18 @@ if (typeof callback === "undefined")
 
+/**
+ * Location
+ */
+
+OneSignal.prototype.promptLocation = function() {
+    cordova.exec(function(){}, function(){}, "OneSignalPush", "promptLocation", []);
+};
+
+OneSignal.prototype.setLocationShared = function(shared) {
+    cordova.exec(function() {}, function() {}, "OneSignalPush", "setLocationShared", [shared]);
+};
+
+OneSignal.prototype.isLocationShared = function(callback) {
+    cordova.exec(callback, function() {}, "OneSignalPush", "isLocationShared", []);
+};
+
 //-------------------------------------------------------------------
@@ -450,3 +434,4 @@
 
-if (typeof module != 'undefined' && module.exports)
+if (typeof module != 'undefined' && module.exports) {
     module.exports = OneSignal;
+}

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

603841

increased by3.52%

Number of package files

35

increased by34.62%

Lines of code

1643

increased by28.06%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes