Merge pull request #4 from notificationapi-com/YWEKB1Ew/2447-detect-f…

…ront-end-integration

Add identify function

lib/client.ts

@@ -3,7 +3,8 @@ import {
   BaseDeliveryOptions,
   Channels,
   DeliveryOptionsForEmail,
-  DeliveryOptionsForInappWeb
+  DeliveryOptionsForInappWeb,
+  PostUserRequest
 } from './interfaces';
 import {
   GetPreferencesResponse,
@@ -69,6 +70,7 @@ type NotificationAPIClientSDK = {
           | BaseDeliveryOptions;
       }>
     ): Promise<any>;
+    postUser(params: PostUserRequest): Promise<any>;
   };
   websocket: {
     object: WebSocket | undefined;
@@ -101,6 +103,7 @@ type NotificationAPIClientSDK = {
       | BaseDeliveryOptions;
   }): Promise<void>;
   getPreferences(): Promise<GetPreferencesResponse>;
+  identify(params: PostUserRequest): Promise<void>;
 };
 
 export const NotificationAPIClientSDK: NotificationAPIClientSDK = {
@@ -123,6 +126,11 @@ export const NotificationAPIClientSDK: NotificationAPIClientSDK = {
         data
       );
     },
+
+    // The functions below are nice wrappers over the generic
+    // rest  api function above. They must follow REST API naming:
+    // Method + Resource, representing the end-point.
+
     getNotifications: function (before, count) {
       return NotificationAPIClientSDK.rest.generic(
         'GET',
@@ -145,6 +153,9 @@ export const NotificationAPIClientSDK: NotificationAPIClientSDK = {
         'preferences',
         params
       );
+    },
+    postUser: function (params: PostUserRequest) {
+      return NotificationAPIClientSDK.rest.generic('POST', '', params);
     }
   },
   websocket: {
@@ -194,6 +205,11 @@ export const NotificationAPIClientSDK: NotificationAPIClientSDK = {
     });
     return websocket;
   },
+
+  // These functions are developer friendly wrappers over the rest APIs
+  // They may or may not do additional tasks.
+  // e.g. identify simply maps to postUsers
+
   getInAppNotifications: async (params) => {
     const maxCountNeeded =
       params.maxCountNeeded ||
@@ -269,5 +285,13 @@ export const NotificationAPIClientSDK: NotificationAPIClientSDK = {
   },
   updateDeliveryOption: async (params) => {
     return NotificationAPIClientSDK.rest.postPreferences([params]);
+  },
+  identify: async (params: PostUserRequest) => {
+    if (params.id && params.id !== NotificationAPIClientSDK.config.userId) {
+      throw new Error(
+        'The id in the parameters does not match the initialized userId.'
+      );
+    }
+    return NotificationAPIClientSDK.rest.postUser(params);
   }
 };

lib/interfaces.ts

@@ -154,3 +154,51 @@ export interface InAppWebDeliveryOptions {
     batchingWindow?: number;
   };
 }
+
+export interface User {
+  id: string;
+  email?: string;
+  number?: string;
+  pushTokens?: PushToken[];
+  webPushTokens?: WebPushToken[];
+  lastSeenTime?: string;
+  createdAt?: string;
+  updatedAt?: string;
+}
+
+export type PostUserRequest = Omit<
+  Partial<User>,
+  'lastSeenTime' | 'createdAt' | 'updatedAt'
+>;
+
+export interface PushToken {
+  type: PushProviders;
+  token: string;
+  device: Device;
+}
+
+export enum PushProviders {
+  FCM = 'FCM',
+  APN = 'APN'
+}
+
+export interface Device {
+  app_id?: string;
+  ad_id?: string;
+  device_id: string;
+  platform?: string;
+  manufacturer?: string;
+  model?: string;
+}
+
+export interface PushSubscription {
+  endpoint: string;
+  keys: {
+    p256dh: string;
+    auth: string;
+  };
+}
+
+export interface WebPushToken {
+  sub: PushSubscription;
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@notificationapi/core",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "type": "module",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",