guidewhale 1.0.4 → 1.0.6

package/README.md

@@ -10,7 +10,27 @@ The script is automatically loaded when the module is imported. Any methods that
 npm install guidewhale
 ```
 
-## Usage
+## User Identity Verification
+In order to verify user identity and prevent impersonations, you need to sign your `user_id` with a secret key and provide the signature during JavaScript SDK initialization. 
+
+Your secret key can be copied from the GuideWhale dashboard environment settings or on the installation settings page. Please note that each environment has its own unique secret key.
+
+> ⚠️ **Warning:** Never share your secret key. This operation should be performed on the server side only.
+```typescript
+import crypto from 'crypto'
+
+// Generate user signature using environment secret key and user_id
+// IMPORTANT: Secret key should not be shared with anyone, so perform this on your server
+let userSignature = crypto
+  .createHmac('sha256', '<secret_key>')
+  .update(<user_id>)
+  .digest('hex')
+
+// Pass user signature to your client
+...
+```
+
+## User Identification
 Start by importing our package by calling `import gwhale from 'guidewhale'`, then initialize the environment and currently active user/company. 
 Make sure to replace placeholder values with your actual environment token and user/company properties, while removing any non-required properties which you don't have/need.
 
@@ -21,7 +41,8 @@ gwhale.init("<guidewhale_environment_code>", {  // REQUIRED - string - make sure
     gdpr: true,                                 // OPTIONAL - true | false - enable GDPR mode to require user consent before tracking data under their user_id
     gdprConsent: true,                          // OPTIONAL - true | false - Whether user has given consent to track their data
     user: {
-        user_id: <user_id>,                     // REQUIRED - string - unique user identifier (e.g. '100000356', '6099047b-660b-4f2e-a878-fb66a12c1840', 'john.smith@example.com')
+        user_id: <user_id>,                     // REQUIRED - string | null - unique user identifier (e.g. null for anonymous users, '100000356', '6099047b-660b-4f2e-a878-fb66a12c1840', 'john.smith@example.com')
+        signature: <user_signature>,            // REQUIRED IF USER_ID IS SET - string - user signature hash (not the secret!) to prevent unathorized initialization
         email: <user_email>,                    // RECOMMENDED - string - email is used as the key to map user data for most integrations (e.g. 'john.smith@example.com')
         image_url: <profile_image_url>,         // RECOMMENDED - string - used to display user's profile image inside GuideWhale dashboard (e.g. 'https://cdn.guidewhale.com/users/1234abcd/profile.png')
         first_name: <user_first_name>,          // RECOMMENDED - string - can be used to personalize GuideWhale content (e.g. 'John')

package/dist/guidewhale.d.ts

@@ -5,8 +5,10 @@ type DisallowKeys<T, K extends string> = {
     [P in keyof T as P extends K ? never : P]: T[P];
 };
 type UserProperties = DisallowKeys<Record<string, any> & {
-    user_id: string;
+    user_id: string | null;
+    signature?: string | null;
     email?: string;
+    image_url?: string;
     first_name?: string;
     last_name?: string;
     date_signed_up?: Date;
@@ -14,6 +16,7 @@ type UserProperties = DisallowKeys<Record<string, any> & {
 type CompanyProperties = DisallowKeys<Record<string, any> & {
     company_id: string;
     name?: string;
+    image_url?: string;
     plan?: string;
     date_signed_up?: Date;
     date_renewal?: Date;

package/dist/guidewhale.js

@@ -10,7 +10,7 @@ var r = [
 if (!e) {
   e = t.gwhale = {
     location: t.location.href.toString(),
-    contentUrl: "https://fast.guidewhale.com/",
+    contentUrl: "https://cdn.guidewhale.com/",
     t: /* @__PURE__ */ new Date()
   };
   for (var a = 0; a < r.length; a++) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "guidewhale",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "GuideWhale SDK client script loader",
   "type": "module",
   "main": "dist/guidewhale.js",