onesignal-node - npm Package Compare versions

Comparing version 3.2.1 to 3.3.0

lib/client.d.ts

@@ -165,3 +165,21 @@ import { ClientOptions, Options, ClientResponse, ViewNotificationsQuery, NotificationHistoryBody, CreateNotificationBody, LimitOffsetQuery, AddDeviceBody, EditDeviceBody, NewSessionBody, NewPurchaseBody, IncrementSessionLengthBody, ExportCSVBody, CreateSegmentBody, EditTagsBody } from './types';
     deleteDevice(deviceId: string): Promise<ClientResponse>;
+    /**
+     * Sign user external id using client REST key to use on the client-side code
+     * Reference: https://documentation.onesignal.com/docs/identity-verification
+     *
+     * @param {string} id User id to be signed
+     *
+     * @return {string} Signed user external id
+     */
+    signUserExternalId(id: string | number): string;
+    /**
+     * Sign user email using client REST key to use on the client-side code
+     * Reference: https://documentation.onesignal.com/docs/identity-verification
+     *
+     * @param {string} email Email to be signed
+     *
+     * @return {string} Signed email
+     */
+    signUserEmail(email: string): string;
 }
 //# sourceMappingURL=client.d.ts.map

lib/client.js

@@ -240,4 +240,26 @@ "use strict";
     }
+    /**
+     * Sign user external id using client REST key to use on the client-side code
+     * Reference: https://documentation.onesignal.com/docs/identity-verification
+     *
+     * @param {string} id User id to be signed
+     *
+     * @return {string} Signed user external id
+     */
+    signUserExternalId(id) {
+        return utils_1.signStringWithKey(id.toString(), this.apiKey);
+    }
+    /**
+     * Sign user email using client REST key to use on the client-side code
+     * Reference: https://documentation.onesignal.com/docs/identity-verification
+     *
+     * @param {string} email Email to be signed
+     *
+     * @return {string} Signed email
+     */
+    signUserEmail(email) {
+        return utils_1.signStringWithKey(email, this.apiKey);
+    }
 }
 exports.Client = Client;
 //# sourceMappingURL=client.js.map

lib/utils.d.ts

@@ -39,2 +39,11 @@ import * as request from 'request';
 export declare const basicAuthRequest: (uri: string, method: string, authKey: string, body?: {} | undefined) => Promise<request.ResponseAsJSON>;
+/**
+ * Sign any string payload using specified private key
+ * Reference: https://documentation.onesignal.com/docs/identity-verification#auth-hash-generation
+ *
+ * @param {string} payload String to be signed
+ * @param {string} key Private REST key
+ * @return {string} Signed payload
+ */
+export declare const signStringWithKey: (payload: string, key: string) => string;
 //# sourceMappingURL=utils.d.ts.map

lib/utils.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.basicAuthRequest = exports.jsonToQueryString = exports.stripTrailingSlash = void 0;
+exports.signStringWithKey = exports.basicAuthRequest = exports.jsonToQueryString = exports.stripTrailingSlash = void 0;
+const crypto_1 = require("crypto");
 const request = require("request");
@@ -101,2 +102,15 @@ const errors_1 = require("./errors");
 };
+/**
+ * Sign any string payload using specified private key
+ * Reference: https://documentation.onesignal.com/docs/identity-verification#auth-hash-generation
+ *
+ * @param {string} payload String to be signed
+ * @param {string} key Private REST key
+ * @return {string} Signed payload
+ */
+exports.signStringWithKey = function signStringWithKey(payload, key) {
+    const hmac = crypto_1.createHmac('sha256', key);
+    hmac.update(payload);
+    return hmac.digest('hex');
+};
 //# sourceMappingURL=utils.js.map

package.json

 {
   "name": "onesignal-node",
-  "version": "3.2.1",
+  "version": "3.3.0",
   "description": "A Node.js Library for OneSignal push notification service",
@@ -5,0 +5,0 @@ "engines": {

README.md

@@ -47,3 +47,4 @@ # onesignal-node
   * [Increment Session Length](#increment-session-length)  
-  * [CSV Export](#csv-export)      
+  * [CSV Export](#csv-export)        
+  * [Identity verification](#identity-verification)      
 * [Tests](#tests)
@@ -69,2 +70,6 @@ * [Contributing](#contributing)
 ```      
+OR
+``` js      
+import * as OneSignal from 'onesignal-node';  
+```
 
@@ -412,2 +417,15 @@ ### Client Types:
 ```   
+
+### Identity Verification
+
+https://documentation.onesignal.com/docs/identity-verification
+
+You can use these simple helpers to sign user id or email to be used in client-side code.
+
+```ts
+.signUserExternalId(id: string | number): string
+.signUserEmail(email: string): string
+```  
+ 
+Each of these will return SHA-256 hash, that was generated using apiKey.
       
@@ -414,0 +432,0 @@ ## Tests

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

73422

increased by4.97%

Lines of code

981

increased by6.86%

Number of lines in readme file

454

increased by4.13%

No dependency changes