react-onesignal - npm Package Compare versions

Comparing version 1.1.16 to 1.1.17

dist/index.es.js

@@ -187,3 +187,2 @@ /* eslint-disable no-unused-vars */
  * Gets the email ID configured on OneSignal instance.
- * @param email email
  */
@@ -224,2 +223,39 @@ var getEmailId = function () { return new Promise(function (resolve, reject) {
 /**
+ * Sets the external user ID on OneSignal instance.
+ * @param externalUserId The external user ID
+ */
+var setExternalUserId = function (externalUserId) { return new Promise(function (resolve, reject) {
+    var oneSignal = getOneSignalInstance();
+    if (!oneSignal) {
+        reject();
+        return;
+    }
+    try {
+        oneSignal.setExternalUserId(externalUserId)
+            .then(function () { return resolve(); })
+            .catch(function (error) { return reject(error); });
+    }
+    catch (error) {
+        reject(error);
+    }
+}); };
+/**
+ * Gets the external user ID configured on OneSignal instance.
+ */
+var getExternalUserId = function () { return new Promise(function (resolve, reject) {
+    var oneSignal = getOneSignalInstance();
+    if (!oneSignal) {
+        reject();
+        return;
+    }
+    try {
+        oneSignal.getExternalUserId()
+            .then(function (value) { return resolve(value); })
+            .catch(function (error) { return reject(error); });
+    }
+    catch (error) {
+        reject(error);
+    }
+}); };
+/**
  * Object for manipulating OneSignal.
@@ -235,2 +271,4 @@ */
     getPlayerId: getPlayerId,
+    setExternalUserId: setExternalUserId,
+    getExternalUserId: getExternalUserId,
 };
@@ -237,0 +275,0 @@

dist/index.js

@@ -191,3 +191,2 @@ 'use strict';
  * Gets the email ID configured on OneSignal instance.
- * @param email email
  */
@@ -228,2 +227,39 @@ var getEmailId = function () { return new Promise(function (resolve, reject) {
 /**
+ * Sets the external user ID on OneSignal instance.
+ * @param externalUserId The external user ID
+ */
+var setExternalUserId = function (externalUserId) { return new Promise(function (resolve, reject) {
+    var oneSignal = getOneSignalInstance();
+    if (!oneSignal) {
+        reject();
+        return;
+    }
+    try {
+        oneSignal.setExternalUserId(externalUserId)
+            .then(function () { return resolve(); })
+            .catch(function (error) { return reject(error); });
+    }
+    catch (error) {
+        reject(error);
+    }
+}); };
+/**
+ * Gets the external user ID configured on OneSignal instance.
+ */
+var getExternalUserId = function () { return new Promise(function (resolve, reject) {
+    var oneSignal = getOneSignalInstance();
+    if (!oneSignal) {
+        reject();
+        return;
+    }
+    try {
+        oneSignal.getExternalUserId()
+            .then(function (value) { return resolve(value); })
+            .catch(function (error) { return reject(error); });
+    }
+    catch (error) {
+        reject(error);
+    }
+}); };
+/**
  * Object for manipulating OneSignal.
@@ -239,2 +275,4 @@ */
     getPlayerId: getPlayerId,
+    setExternalUserId: setExternalUserId,
+    getExternalUserId: getExternalUserId,
 };
@@ -241,0 +279,0 @@

dist/oneSignal.d.ts

@@ -13,3 +13,5 @@ import { OneSignalOptions } from './oneSignal.types';
     getPlayerId: () => Promise<string>;
+    setExternalUserId: (externalUserId: string | number) => Promise<void>;
+    getExternalUserId: () => Promise<string>;
 };
 export default ReactOneSignal;

dist/oneSignal.types.d.ts

@@ -8,2 +8,4 @@ export interface IOneSignal {
     getUserId: () => Promise<string>;
+    setExternalUserId: (externalUserId: string | number) => Promise<void>;
+    getExternalUserId: () => Promise<any>;
     initialized: boolean;
@@ -10,0 +12,0 @@ }

package.json

 {
   "name": "react-onesignal",
-  "version": "1.1.16",
+  "version": "1.1.17",
   "description": "React OneSignal Module: Make it easy to integrate OneSignal with your React App!",
@@ -5,0 +5,0 @@ "author": "pedro-lb",

README.md

@@ -101,2 +101,10 @@ # React OneSignal
 
+You can use `setExternalUserId` and `getExternalUserId` to track user email.
+
+```js
+OneSignal.setExternalUserId('your_id');
+
+const externalUserId = await OneSignal.getExternalUserId();
+```
+
 ## Contributing
@@ -103,0 +111,0 @@

src/oneSignal.ts

@@ -235,3 +235,2 @@ // eslint-disable-next-line no-unused-vars
  * Gets the email ID configured on OneSignal instance.
- * @param email email
  */
@@ -276,2 +275,45 @@ const getEmailId = () => new Promise<string>((resolve, reject) => {
 /**
+ * Sets the external user ID on OneSignal instance.
+ * @param externalUserId The external user ID
+ */
+const setExternalUserId = (
+  externalUserId: string | number,
+) => new Promise<void>((resolve, reject) => {
+  const oneSignal = getOneSignalInstance();
+
+  if (!oneSignal) {
+    reject();
+    return;
+  }
+
+  try {
+    oneSignal.setExternalUserId(externalUserId)
+      .then(() => resolve())
+      .catch((error) => reject(error));
+  } catch (error) {
+    reject(error);
+  }
+});
+
+/**
+ * Gets the external user ID configured on OneSignal instance.
+ */
+const getExternalUserId = () => new Promise<string>((resolve, reject) => {
+  const oneSignal = getOneSignalInstance();
+
+  if (!oneSignal) {
+    reject();
+    return;
+  }
+
+  try {
+    oneSignal.getExternalUserId()
+      .then((value) => resolve(value))
+      .catch((error) => reject(error));
+  } catch (error) {
+    reject(error);
+  }
+});
+
+/**
  * Object for manipulating OneSignal.
@@ -287,4 +329,6 @@ */
   getPlayerId,
+  setExternalUserId,
+  getExternalUserId,
 };
 
 export default ReactOneSignal;

src/oneSignal.types.ts

@@ -8,2 +8,4 @@ export interface IOneSignal {
   getUserId: () => Promise<string>,
+  setExternalUserId: (externalUserId: string | number) => Promise<void>,
+  getExternalUserId: () => Promise<any>,
   initialized: boolean,
@@ -10,0 +12,0 @@ }

No alert changes

Improved metrics

Total package byte prevSize

61524

increased by13.88%

Lines of code

995

increased by13.71%

Number of lines in readme file

116

increased by7.41%

No dependency changes