@maxzima/wa-communicator 1.0.26 → 1.0.28

package/dist/engine/Communicator/Enums/CommunicatorEnum.d.ts

@@ -9,6 +9,7 @@ declare const enum CommunicatorAuthAPIEndpointEnum {
     SIGN_IN = "sign-in",
     CHALLENGE = "sign-in/challenge",
     EMAIL = "sign-in/email",
+    SSE_AUTH = "sse/app-auth",
     SIGN_UP = "sign-up",
     SESSION = "sign-in/session"
 }

package/dist/engine/Communicator/Public/Communicator.d.ts

@@ -1,10 +1,14 @@
-import type { TCreateSessionRequestData, TEmailUpdateRequestData, TGetCurrentUserProfileRequestData, TRegistrationRequestData, TResponse, TSetupChallengeRequestData, TSignInByMobileRequestData, TSignUpByMobileRequestData, TVerifyChallengeRequestData, TStorageRequestData, TGetRestrictedCountriesData } from "@root/types";
+import { TCreateSessionRequestData, TEmailUpdateRequestData, TGetCurrentUserProfileRequestData, TRegistrationRequestData, TResponse, TSetupChallengeRequestData, TSignInByMobileRequestData, TSignUpByMobileRequestData, TVerifyChallengeRequestData, TStorageRequestData, TGetRestrictedCountriesData, TSetupSSERequestData, TSignInByAppRequestData } from "@root/types";
 export declare class Communicator {
     private props;
+    private sseAuth;
     constructor(props: TCommunicatorProps);
     signIn(data: TSignInByMobileRequestData): Promise<TResponse>;
+    signInByApp(data: TSignInByAppRequestData): Promise<TResponse>;
     signUp(data: TSignUpByMobileRequestData): Promise<TResponse>;
     setupChallenge(data: TSetupChallengeRequestData): Promise<TResponse>;
+    listenSSEAuth(data: TSetupSSERequestData): void;
+    closeSSEAuth(): void;
     verifyChallenge(data: TVerifyChallengeRequestData): Promise<TResponse>;
     emailUpdate(data: TEmailUpdateRequestData): Promise<TResponse>;
     createSession(data: TCreateSessionRequestData): Promise<TResponse>;

package/dist/engine/Communicator/Public/Communicator.js

@@ -1,5 +1,6 @@
 import { __awaiter } from "tslib";
 import { CommunicatorDefaultRequestData } from "./../Constants/Communicator";
+import { jsonParse } from "./../Utils/jsonParseSafe";
 export class Communicator {
     constructor(props) {
         this.getHeaders = (token) => {
@@ -54,6 +55,22 @@ export class Communicator {
             });
         });
     }
+    signInByApp(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const headers = this.getHeaders(data.authToken);
+            const body = JSON.stringify({
+                type: data.type,
+                value: data.value,
+                request_id: data.requestId,
+            });
+            return yield this.send({
+                method: 'POST',
+                url: `${this.props.clientAuthApiBaseUrl}${"sign-in/challenge"}`,
+                headers,
+                body,
+            });
+        });
+    }
     signUp(data) {
         return __awaiter(this, void 0, void 0, function* () {
             const headers = this.getHeaders();
@@ -83,6 +100,54 @@ export class Communicator {
             });
         });
     }
+    listenSSEAuth(data) {
+        if (this.sseAuth) {
+            this.closeSSEAuth();
+        }
+        const params = {
+            request_id: data.requestId,
+            mobile: data.phoneNumber,
+        };
+        const url = `${this.props.clientAuthSSEBaseUrl}${"sse/app-auth"}`;
+        this.sseAuth = new EventSource(`${url}?${this.processingQueryParams(params)}`, {
+            withCredentials: true,
+        });
+        if (this.sseAuth) {
+            this.sseAuth.addEventListener('open', (event) => {
+                if (this.props.env !== 'prod') {
+                    console.log('sse open', event);
+                }
+                if (typeof data.onOpen === "function") {
+                    data.onOpen();
+                }
+            });
+            this.sseAuth.addEventListener('message', (event) => {
+                const responseData = jsonParse(event.data || '');
+                if (this.props.env !== 'prod') {
+                    console.log('sse message', event, responseData);
+                }
+                if (typeof data.onMessage === "function") {
+                    data.onMessage(responseData);
+                }
+            });
+            this.sseAuth.addEventListener('error', (event) => {
+                const responseData = jsonParse(event.data || '');
+                if (this.props.env !== 'prod') {
+                    console.log('sse error', event, responseData);
+                }
+                if (typeof data.onError === "function") {
+                    data.onError();
+                }
+            });
+        }
+    }
+    closeSSEAuth() {
+        if (this.sseAuth) {
+            console.log(this.sseAuth.readyState);
+            this.sseAuth.close();
+            this.sseAuth = null;
+        }
+    }
     verifyChallenge(data) {
         return __awaiter(this, void 0, void 0, function* () {
             const headers = this.getHeaders(data.authToken);

package/dist/engine/Communicator/Types/TCommunicator.d.ts

@@ -5,6 +5,8 @@ declare type TDefaultRequestData = {
     AUDIT_SOURCE_TYPE: import('@root/types').TAuditSource;
 };
 declare type TCommunicatorProps = {
+    env?: 'local' | 'dev' | 'prod';
     clientAuthApiBaseUrl: string;
+    clientAuthSSEBaseUrl: string;
     clientFAPIBaseUrl: string;
 };

package/dist/engine/Communicator/Utils/jsonParseSafe.d.ts

@@ -0,0 +1 @@
+export declare function jsonParse<ResultType = unknown>(data: string): ResultType;

package/dist/engine/Communicator/Utils/jsonParseSafe.js

@@ -0,0 +1,10 @@
+export function jsonParse(data) {
+    let ret = null;
+    try {
+        ret = JSON.parse(data);
+    }
+    catch (e) {
+        ret = null;
+    }
+    return ret;
+}

package/dist/types/TCommunicator.d.ts

@@ -1,4 +1,4 @@
-declare type TChallenge = 'email_otp' | 'mobile_otp' | 'pin';
+declare type TChallenge = 'email_otp' | 'mobile_otp' | 'pin' | 'out_of_band';
 declare type TAuditSource = 'Backend' | 'SelfService';
 declare type TRegistrationRequestBodySourceDeviceType = 'mobile' | 'regular';
 declare type TRequestProps = {
@@ -22,6 +22,11 @@ declare type TSignInStartRequestBody = {
     meta: TAccountMeta;
     mobile?: string;
 };
+declare type TSignInAppRequestBody = {
+    type: 'out_of_band';
+    value: string;
+    request_id: string;
+};
 declare type TAccountMeta = {
     audit_source_type: TAuditSource;
     browser_page_resolution: string;
@@ -42,10 +47,20 @@ declare type TSignInByMobileRequestData = {
     deviceId: string;
     browserData: TAccountBrowserData;
 };
+declare type TSignInByAppRequestData = {
+    authToken: string;
+    type: 'out_of_band';
+    value: string;
+    requestId: string;
+};
 declare type TSignInByMobileResponse = {
     auth_token: string;
     challenges: TChallenge[];
 };
+declare type TSignInBySSEResponse = {
+    request_id: string;
+    mobile: string;
+};
 declare type TSignUpStartRequestBody = {
     locale: string;
     mobile: string;
@@ -60,6 +75,23 @@ declare type TSetupChallengeRequestData = {
     type: TChallenge;
     authToken: string;
 };
+declare type TSetupSSERequestData = {
+    requestId: string;
+    phoneNumber: string;
+    onOpen: () => void;
+    onError: () => void;
+    onMessage: (responseData: TSSEResponseData) => void;
+};
+declare type TSSEResponseData = {
+    otp?: string;
+    decline_reason?: string;
+    message?: string;
+    error_code?: number;
+    error_text?: string;
+    error_context?: {
+        next_attempts_after?: string;
+    };
+};
 declare type TSetupChallengeResponse = {
     attempts_left: number;
     masked_email: string;
@@ -137,4 +169,4 @@ declare type TStorageRequestData = {
 declare type TGetRestrictedCountriesData = {
     entityType?: import('@root/enums').CountryTypeEnum;
 };
-export { TRegistrationRequestBodySourceDeviceType, TChallenge, TAuditSource, TRequestProps, TRequestQueryParams, TResponse, TSignInStartRequestBody, TAccountMeta, TAccountBrowserData, TSignInByMobileRequestData, TSignInByMobileResponse, TSignUpStartRequestBody, TSignUpByMobileRequestData, TSetupChallengeRequestData, TSetupChallengeResponse, TVerifyChallengeRequestBody, TVerifyChallengeRequestData, TVerifyChallengeResponse, TEmailUpdateRequestData, TCreateSessionRequestData, TCreateSessionResponse, TGetCurrentUserProfileResponseUser, TGetCurrentUserProfileRequestData, TRegistrationRequestData, TStorageRequestData, TGetRestrictedCountriesData, };
+export { TRegistrationRequestBodySourceDeviceType, TChallenge, TAuditSource, TRequestProps, TRequestQueryParams, TResponse, TSignInStartRequestBody, TSignInAppRequestBody, TAccountMeta, TAccountBrowserData, TSignInByMobileRequestData, TSignInByAppRequestData, TSignInByMobileResponse, TSignInBySSEResponse, TSignUpStartRequestBody, TSignUpByMobileRequestData, TSetupChallengeRequestData, TSetupSSERequestData, TSSEResponseData, TSetupChallengeResponse, TVerifyChallengeRequestBody, TVerifyChallengeRequestData, TVerifyChallengeResponse, TEmailUpdateRequestData, TCreateSessionRequestData, TCreateSessionResponse, TGetCurrentUserProfileResponseUser, TGetCurrentUserProfileRequestData, TRegistrationRequestData, TStorageRequestData, TGetRestrictedCountriesData, };

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.26",
+  "version": "1.0.28",
   "name": "@maxzima/wa-communicator",
   "description": "",
   "author": "Noname",

package/src/engine/Communicator/Enums/CommunicatorEnum.ts

@@ -10,6 +10,7 @@ const enum CommunicatorAuthAPIEndpointEnum {
   SIGN_IN = 'sign-in',
   CHALLENGE = 'sign-in/challenge',
   EMAIL = 'sign-in/email',
+  SSE_AUTH = 'sse/app-auth',
   SIGN_UP = 'sign-up',
   SESSION = 'sign-in/session',
 }

package/src/engine/Communicator/Public/Communicator.ts

@@ -1,4 +1,4 @@
-import type {
+import {
   TAccountBrowserData,
   TAccountMeta,
   TCreateSessionRequestData,
@@ -16,12 +16,19 @@ import type {
   TVerifyChallengeRequestBody,
   TVerifyChallengeRequestData,
   TStorageRequestData,
-  TGetRestrictedCountriesData
+  TGetRestrictedCountriesData,
+  TSetupSSERequestData,
+  TSignInAppRequestBody,
+  TSignInByAppRequestData,
+  TSignInBySSEResponse,
+  TSSEResponseData,
 } from "@root/types";
 import {CommunicatorDefaultRequestData} from "./../Constants/Communicator";
+import {jsonParse} from "./../Utils/jsonParseSafe";
 
 export class Communicator {
   private props: TCommunicatorProps;
+  private sseAuth: EventSource;
 
   constructor(props: TCommunicatorProps) {
     this.props = props;
@@ -48,6 +55,22 @@ export class Communicator {
     });
   }
 
+  public async signInByApp(data: TSignInByAppRequestData) {
+    const headers = this.getHeaders(data.authToken);
+    const body = JSON.stringify({
+      type: data.type,
+      value: data.value,
+      request_id: data.requestId,
+    } as TSignInAppRequestBody);
+
+    return await this.send({
+      method: 'POST',
+      url: `${this.props.clientAuthApiBaseUrl}${CommunicatorAuthAPIEndpointEnum.CHALLENGE}`,
+      headers,
+      body,
+    });
+  }
+
   public async signUp(data: TSignUpByMobileRequestData) {
     const headers = this.getHeaders();
     const body = JSON.stringify({
@@ -77,6 +100,60 @@ export class Communicator {
     });
   }
 
+  public listenSSEAuth(data: TSetupSSERequestData) {
+    if (this.sseAuth) {
+      this.closeSSEAuth();
+    }
+
+    const params: TSignInBySSEResponse = {
+      request_id: data.requestId,
+      mobile: data.phoneNumber,
+    }
+    const url = `${this.props.clientAuthSSEBaseUrl}${CommunicatorAuthAPIEndpointEnum.SSE_AUTH}`;
+    this.sseAuth = new EventSource(`${url}?${this.processingQueryParams(params)}`, {
+      withCredentials: true,
+    });
+
+    if (this.sseAuth) {
+      this.sseAuth.addEventListener('open', (event: MessageEvent) => {
+        if (this.props.env !== 'prod') {
+          console.log('sse open', event);
+        }
+        if (typeof data.onOpen === "function") {
+          data.onOpen();
+        }
+      });
+
+      this.sseAuth.addEventListener('message', (event: MessageEvent) => {
+        const responseData: TSSEResponseData = jsonParse(event.data || '');
+        if (this.props.env !== 'prod') {
+          console.log('sse message', event, responseData);
+        }
+        if (typeof data.onMessage === "function") {
+          data.onMessage(responseData);
+        }
+      });
+
+      this.sseAuth.addEventListener('error', (event: MessageEvent) => {
+        const responseData: TSSEResponseData = jsonParse(event.data || '');
+        if (this.props.env !== 'prod') {
+          console.log('sse error', event, responseData);
+        }
+        if (typeof data.onError === "function") {
+          data.onError();
+        }
+      });
+    }
+  }
+
+  public closeSSEAuth() {
+    if (this.sseAuth) {
+      console.log(this.sseAuth.readyState);
+      this.sseAuth.close();
+      this.sseAuth = null;
+    }
+  }
+
   public async verifyChallenge(data: TVerifyChallengeRequestData) {
     const headers = this.getHeaders(data.authToken);
     const body = JSON.stringify({

package/src/engine/Communicator/Types/TCommunicator.ts

@@ -6,6 +6,8 @@ type TDefaultRequestData = {
 }
 
 type TCommunicatorProps = {
+  env?: 'local' | 'dev' | 'prod';
   clientAuthApiBaseUrl: string;
+  clientAuthSSEBaseUrl: string;
   clientFAPIBaseUrl: string;
 }

package/src/engine/Communicator/Utils/jsonParseSafe.ts

@@ -0,0 +1,14 @@
+/**
+ * JSON Parse
+ * @param {string} data
+ * @returns {Object}
+ */
+export function jsonParse<ResultType = unknown>(data: string): ResultType {
+  let ret = null;
+  try {
+    ret = JSON.parse(data);
+  } catch (e) {
+    ret = null;
+  }
+  return ret;
+}

package/src/types/TCommunicator.ts

@@ -1,4 +1,4 @@
-type TChallenge = 'email_otp' | 'mobile_otp' | 'pin';
+type TChallenge = 'email_otp' | 'mobile_otp' | 'pin' | 'out_of_band';
 type TAuditSource = 'Backend' | 'SelfService';
 type TRegistrationRequestBodySourceDeviceType = 'mobile' | 'regular';
 
@@ -28,6 +28,12 @@ type TSignInStartRequestBody =  {
   mobile?: string,
 }
 
+type TSignInAppRequestBody =  {
+  type: 'out_of_band',
+  value: string,
+  request_id: string,
+}
+
 type TAccountMeta = {
   audit_source_type: TAuditSource,
   browser_page_resolution: string,
@@ -51,10 +57,22 @@ type TSignInByMobileRequestData = {
   browserData: TAccountBrowserData,
 }
 
+type TSignInByAppRequestData = {
+  authToken: string,
+  type: 'out_of_band',
+  value: string,
+  requestId: string,
+}
+
 type TSignInByMobileResponse = {
   auth_token: string,
   challenges: TChallenge[],
 }
+
+type TSignInBySSEResponse = {
+  request_id: string,
+  mobile: string,
+}
 /* endregion signIn */
 
 /* region signUp */
@@ -77,6 +95,25 @@ type TSetupChallengeRequestData = {
   authToken: string,
 }
 
+type TSetupSSERequestData = {
+  requestId: string,
+  phoneNumber: string,
+  onOpen: () => void,
+  onError: () => void,
+  onMessage: (responseData: TSSEResponseData) => void,
+}
+
+type TSSEResponseData = {
+  otp?: string,
+  decline_reason?: string,
+  message?: string,
+  error_code?: number,
+  error_text?: string,
+  error_context?: {
+    next_attempts_after?: string,
+  }
+}
+
 type TSetupChallengeResponse = {
   attempts_left: number,
   masked_email: string,
@@ -200,13 +237,18 @@ export {
   TRequestQueryParams,
   TResponse,
   TSignInStartRequestBody,
+  TSignInAppRequestBody,
   TAccountMeta,
   TAccountBrowserData,
   TSignInByMobileRequestData,
+  TSignInByAppRequestData,
   TSignInByMobileResponse,
+  TSignInBySSEResponse,
   TSignUpStartRequestBody,
   TSignUpByMobileRequestData,
   TSetupChallengeRequestData,
+  TSetupSSERequestData,
+  TSSEResponseData,
   TSetupChallengeResponse,
   TVerifyChallengeRequestBody,
   TVerifyChallengeRequestData,

package/test/__snapshots__/communicator.spec.ts.snap

@@ -135,6 +135,19 @@ Object {
 }
 `;
 
+exports[`Communicator requests signInByApp 1`] = `
+Object {
+  "body": "{\\"type\\":\\"out_of_band\\",\\"value\\":\\"123456\\",\\"request_id\\":\\"7ae2cefb-2f3b-4ecf-b478-67486aca2eaf\\"}",
+  "headers": Object {
+    "Accept": "application/json, text/plain, */*",
+    "Authorization": "Bearer _authToken_",
+    "Content-Type": "application/json",
+  },
+  "method": "POST",
+  "url": "https://google.com/sign-in/challenge",
+}
+`;
+
 exports[`Communicator requests signUp 1`] = `
 Object {
   "body": "{\\"locale\\":\\"en\\",\\"mobile\\":\\"+16234401486\\",\\"timezone_name\\":\\"Europe/Tallin\\"}",

package/test/communicator.spec.ts

@@ -11,6 +11,7 @@ import {
   registrationData,
   setupChallengeData,
   signInData,
+  signInByAppData,
   signUpData,
   verifyChallengeData,
   setStorageValuesData,
@@ -64,6 +65,11 @@ describe('Communicator requests', () => {
     expect(signInRequestData).toMatchSnapshot();
   });
 
+  test('signInByApp', async () => {
+    const signInRequestData = await communicator.signInByApp(signInByAppData);
+    expect(signInRequestData).toMatchSnapshot();
+  });
+
   test('signUp', async () => {
     const signUpRequestData = await communicator.signUp(signUpData);
     expect(signUpRequestData).toMatchSnapshot();

package/test/testunits/communicator/general.ts

@@ -3,6 +3,7 @@ import {TAccountBrowserData, TChallenge, TRegistrationRequestBodySourceDeviceTyp
 const communicatorTestData = {
   initProps: {
     clientAuthApiBaseUrl: 'https://google.com/',
+    clientAuthSSEBaseUrl: 'https://google.com/',
     clientFAPIBaseUrl: 'https://google.com/',
   },
   browserData: {
@@ -19,6 +20,7 @@ const communicatorTestData = {
   companyName: '_companyName_',
   deviceType: 'mobile' as TRegistrationRequestBodySourceDeviceType,
   deviceId: 'ov4lNmyk7armoC5DMiOpL5hl846kVQgS',
+  requestId: '7ae2cefb-2f3b-4ecf-b478-67486aca2eaf',
   otpCode: '123456',
   countryCode: 'CAN',
   authToken: '_authToken_',

package/test/testunits/communicator/requests.ts

@@ -6,6 +6,7 @@ import type {
   TRegistrationRequestData,
   TSetupChallengeRequestData,
   TSignInByMobileRequestData,
+  TSignInByAppRequestData,
   TSignUpByMobileRequestData,
   TStorageRequestData,
   TVerifyChallengeRequestData,
@@ -19,6 +20,13 @@ const signInData: TSignInByMobileRequestData = {
   browserData: communicatorTestData.browserData,
 };
 
+const signInByAppData: TSignInByAppRequestData = {
+  authToken: communicatorTestData.authToken,
+  type: 'out_of_band',
+  value: communicatorTestData.otpCode,
+  requestId: communicatorTestData.requestId,
+};
+
 const signUpData: TSignUpByMobileRequestData = {
   locale: communicatorTestData.locale,
   phoneNumber: communicatorTestData.phoneNumber,
@@ -75,6 +83,7 @@ const getRestrictedCountriesData: TGetRestrictedCountriesData = {
 
 export {
   signInData,
+  signInByAppData,
   signUpData,
   setupChallengeData,
   verifyChallengeData,