Merge pull request #22 from securenative/dev

Add phone field to user traits

Author: inbaltako

README.md

@@ -87,7 +87,8 @@ secureNative.track({
   userId: '1234',
   userTraits: {
     name: 'Your Name',
-    email: '[email protected]'
+    email: '[email protected]',
+    phone: '+1234567890'
   },
   context: contextFromRequest(req)
 });
@@ -101,7 +102,8 @@ secureNative.track({
   userId: '1234',
   userTraits: {
     name: 'Your Name',
-    email: '[email protected]'
+    email: '[email protected]',
+    phone: '+1234567890'
   },
   context: {
     ip: '10.0.0.0',
@@ -121,7 +123,8 @@ secureNative.track({
     userId: '1234',
     userTraits: {
       name: 'Your Name',
-      email: '[email protected]'
+      email: '[email protected]',
+      phone: '+1234567890'
     },
     context: contextFromRequest(req)
   })

src/api-manager.spec.ts

@@ -20,6 +20,7 @@ const sdkEvent: EventOptions = {
   userTraits: {
     name: 'USER_NAME',
     email: 'USER_EMAIL',
+    phone: '+123456789',
   },
   context: {
     ip: '127.0.0.1',
@@ -69,6 +70,7 @@ describe('ApiManager', () => {
       expect(eventPayload).to.have.property('userTraits');
       expect(eventPayload.userTraits).to.have.property('name', sdkEvent.userTraits.name);
       expect(eventPayload.userTraits).to.have.property('email', sdkEvent.userTraits.email);
+      expect(eventPayload.userTraits).to.have.property('phone', sdkEvent.userTraits.phone);
       //properties
 
       expect(eventPayload).to.have.property('properties');
@@ -213,6 +215,7 @@ describe('ApiManager', () => {
       expect(eventPayload).to.have.property('userId', sdkEvent.userId);
       expect(eventPayload.userTraits).to.have.property('name', sdkEvent.userTraits.name);
       expect(eventPayload.userTraits).to.have.property('email', sdkEvent.userTraits.email);
+      expect(eventPayload.userTraits).to.have.property('phone', sdkEvent.userTraits.phone);
       //properties
       expect(eventPayload).to.have.property('properties');
       expect(Object.keys(eventPayload.properties)).to.have.lengthOf(Object.keys(sdkEvent.properties).length, 'Incorrect number of custom properties');

src/events/sdk-event.ts

@@ -14,6 +14,7 @@ export default class SDKEvent implements IEvent {
   public userTraits: {
     name: string;
     email: string;
+    phone: string;
     createdAt: string;
   };
   public request: {
@@ -45,6 +46,7 @@ export default class SDKEvent implements IEvent {
     this.userTraits = {
       name: user.name || '',
       email: user.email || '',
+      phone: user.phone || '',
       createdAt: user.createdAt?.toISOString() || new Date(0).toISOString(),
     };
     this.request = {

src/types/event-options.ts

@@ -8,6 +8,7 @@ export type EventOptions = {
   userTraits?: {
     name?: string;
     email?: string;
+    phone?: string;
     createdAt?: Date;
   };
   context?: RequestContext;