From 8b3c85bcf148ac3321c7f2d554db00a9f570cdde Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20Rebou=C3=A7as?= Date: Mon, 5 Aug 2024 10:03:05 -0300 Subject: [PATCH 1/3] feat(RequestToken): add request_token support to all methods --- src/incogniaApi.ts | 51 +++++--- src/types.ts | 15 ++- test/incogniaApi.test.ts | 243 +++++++++++++++++++++++++++++++++++++-- 3 files changed, 275 insertions(+), 34 deletions(-) diff --git a/src/incogniaApi.ts b/src/incogniaApi.ts index 086758c..4402f55 100644 --- a/src/incogniaApi.ts +++ b/src/incogniaApi.ts @@ -75,9 +75,9 @@ export class IncogniaApi { ** Resources */ async registerSignup(props: RegisterSignupProps): Promise { - const { installationId } = props || {} - if (!installationId) { - throw new IncogniaError('No installationId provided') + const { installationId, requestToken } = props || {} + if (!installationId && !requestToken) { + throw new IncogniaError('No installationId or requestToken provided') } return this.#registerBaseSignup(props) @@ -86,18 +86,21 @@ export class IncogniaApi { async registerWebSignup( props: RegisterWebSignupProps ): Promise { - const { sessionToken } = props || {} - if (!sessionToken) { - throw new IncogniaError('No sessionToken provided') + const { sessionToken, requestToken } = props || {} + if (!sessionToken && !requestToken) { + throw new IncogniaError('No sessionToken or requestToken provided') } return this.#registerBaseSignup(props) } async registerLogin(props: RegisterLoginProps): Promise { - const { installationId, accountId } = props || {} - if (!installationId || !accountId) { - throw new IncogniaError('No installationId or accountId provided') + const { installationId, requestToken, accountId } = props || {} + if (!installationId && !requestToken) { + throw new IncogniaError('No installationId or requestToken provided') + } + if (!accountId) { + throw new IncogniaError('No accountId provided') } return this.#registerTransaction({ ...props, type: TransactionType.Login }) @@ -106,19 +109,26 @@ export class IncogniaApi { async registerWebLogin( props: RegisterWebLoginProps ): Promise { - const { sessionToken, accountId } = props || {} - if (!sessionToken || !accountId) { - throw new IncogniaError('No sessionToken or accountId provided') + const { sessionToken, requestToken, accountId } = props || {} + if (!sessionToken && !requestToken) { + throw new IncogniaError('No sessionToken or requestToken provided') + } + if (!accountId) { + throw new IncogniaError('No accountId provided') } + return this.#registerTransaction({ ...props, type: TransactionType.Login }) } async registerPayment( props: RegisterPaymentProps ): Promise { - const { installationId, accountId } = props || {} - if (!installationId || !accountId) { - throw new IncogniaError('No installationId or accountId provided') + const { installationId, requestToken, accountId } = props || {} + if (!installationId && !requestToken) { + throw new IncogniaError('No installationId or requestToken provided') + } + if (!accountId) { + throw new IncogniaError('No accountId provided') } return this.#registerTransaction({ @@ -130,17 +140,20 @@ export class IncogniaApi { async registerWebPayment( props: RegisterWebPaymentProps ): Promise { - const { sessionToken, accountId } = props || {} - if (!sessionToken || !accountId) { - throw new IncogniaError('No sessionToken or accountId provided') + const { sessionToken, requestToken, accountId } = props || {} + if (!sessionToken && !requestToken) { + throw new IncogniaError('No sessionToken or requestToken provided') } + if (!accountId) { + throw new IncogniaError('No accountId provided') + } + return this.#registerTransaction({ ...props, type: TransactionType.Payment }) } - async registerFeedback( bodyParams: RegisterFeedbackBodyProps, queryParams?: RegisterFeedbackParamsProps diff --git a/src/types.ts b/src/types.ts index 03e7ff9..62735a6 100644 --- a/src/types.ts +++ b/src/types.ts @@ -10,13 +10,14 @@ export enum TransactionAddressType { } export type RegisterSignupBaseProps = { + requestToken?: string accountId?: string policyId?: string [x: string]: any } export type RegisterSignupProps = RegisterSignupBaseProps & { - installationId: string + installationId?: string addressCoordinates?: AddressCoordinates addressLine?: string structuredAddress?: StructuredAddress @@ -24,7 +25,7 @@ export type RegisterSignupProps = RegisterSignupBaseProps & { } export type RegisterWebSignupProps = RegisterSignupBaseProps & { - sessionToken: string + sessionToken?: string } export type SignupBaseResponse = { @@ -48,12 +49,13 @@ export type WebSignupEvidenceSummary = WebEvidenceSummary type RegisterLoginBaseProps = { accountId: string + requestToken?: string policyId?: string [x: string]: any } export type RegisterLoginProps = RegisterLoginBaseProps & { - installationId: string + installationId?: string relatedAccountId?: string location?: TransactionLocation paymentMethodIdentifier?: string @@ -62,11 +64,12 @@ export type RegisterLoginProps = RegisterLoginBaseProps & { } export type RegisterWebLoginProps = RegisterLoginBaseProps & { - sessionToken: string + sessionToken?: string } export type RegisterPaymentBaseProps = { accountId: string + requestToken?: string policyId?: string externalId?: string addresses?: Array @@ -77,12 +80,12 @@ export type RegisterPaymentBaseProps = { } export type RegisterPaymentProps = RegisterPaymentBaseProps & { - installationId: string + installationId?: string relatedAccountId?: string } export type RegisterWebPaymentProps = RegisterPaymentBaseProps & { - sessionToken: string + sessionToken?: string } export type TransactionBaseResponse = { diff --git a/test/incogniaApi.test.ts b/test/incogniaApi.test.ts index 14a5d08..aba37c0 100644 --- a/test/incogniaApi.test.ts +++ b/test/incogniaApi.test.ts @@ -75,7 +75,13 @@ describe('API', () => { }) }) - it('registers signup', async () => { + it('validates a signup', async () => { + expect(() => incogniaApi.registerSignup({})).rejects.toThrowError( + 'No installationId or requestToken provided' + ) + }) + + it('registers signup with installation_id', async () => { const apiResponse = { id: '5e76a7ca-577c-4f47-a752-9e1e0cee9e49', request_id: '8afc84a7-f1d4-488d-bd69-36d9a37168b7', @@ -114,7 +120,52 @@ describe('API', () => { expect(signup).toEqual(expectedResponse) }) - it('registers a web signup', async () => { + it('registers signup with request_token', async () => { + const apiResponse = { + id: '5e76a7ca-577c-4f47-a752-9e1e0cee9e49', + request_id: '8afc84a7-f1d4-488d-bd69-36d9a37168b7', + risk_assessment: 'low_risk', + signup_attempts_by_device_total_10d: 5 + } + + const expectedResponse = { + id: '5e76a7ca-577c-4f47-a752-9e1e0cee9e49', + requestId: '8afc84a7-f1d4-488d-bd69-36d9a37168b7', + riskAssessment: 'low_risk', + signupAttemptsByDeviceTotal10d: 5 + } + + nock(BASE_ENDPOINT_URL) + .post(`/v2/onboarding/signups`) + .reply(200, apiResponse) + + const signup = await incogniaApi.registerSignup({ + requestToken: 'token', + policyId: 'policy_id', + structuredAddress: { + locale: 'en-US', + countryName: 'United States of America', + countryCode: 'US', + state: 'NY', + city: 'New York City', + borough: 'Manhattan', + neighborhood: 'Midtown', + street: 'W 34th St.', + number: '20', + complements: 'Floor 2', + postalCode: '10001' + } + }) + expect(signup).toEqual(expectedResponse) + }) + + it('validates a web signup', async () => { + expect(() => incogniaApi.registerWebSignup({})).rejects.toThrowError( + 'No sessionToken or requestToken provided' + ) + }) + + it('registers a web signup with session token', async () => { const apiResponse = { id: '5e76a7ca-577c-4f47-a752-9e1e0cee9e49', risk_assessment: 'low_risk' @@ -139,7 +190,44 @@ describe('API', () => { expect(webSignup).toEqual(expectedResponse) }) - it('registers login', async () => { + it('registers a web signup with request token', async () => { + const apiResponse = { + id: '5e76a7ca-577c-4f47-a752-9e1e0cee9e49', + risk_assessment: 'low_risk' + } + + const expectedResponse = { + id: '5e76a7ca-577c-4f47-a752-9e1e0cee9e49', + riskAssessment: 'low_risk' + } + + const requestToken = 'request_token' + + nock(BASE_ENDPOINT_URL) + .post(`/v2/onboarding/signups`, { + request_token: requestToken + }) + .reply(200, apiResponse) + + const webSignup = await incogniaApi.registerWebSignup({ + requestToken + }) + expect(webSignup).toEqual(expectedResponse) + }) + + it('validates a login', async () => { + expect(() => + incogniaApi.registerLogin({ accountId: 'id' }) + ).rejects.toThrowError('No installationId or requestToken provided') + expect(() => + incogniaApi.registerLogin({ installationId: 'id' } as any) + ).rejects.toThrowError('No accountId provided') + expect(() => + incogniaApi.registerLogin({ requestToken: 'token' } as any) + ).rejects.toThrowError('No accountId provided') + }) + + it('registers login with installation_id', async () => { const apiResponse = { id: '5e76a7ca-577c-4f47-a752-9e1e0cee9e49', risk_assessment: 'low_risk', @@ -171,7 +259,51 @@ describe('API', () => { expect(login).toEqual(expectedResponse) }) - it('registers a web login', async () => { + it('registers login with request_token', async () => { + const apiResponse = { + id: '5e76a7ca-577c-4f47-a752-9e1e0cee9e49', + risk_assessment: 'low_risk', + app_tampering: { + result: 'not_detected', + app_debugging: 'not_detected', + code_injection: 'not_detected' + } + } + + const expectedResponse = { + id: '5e76a7ca-577c-4f47-a752-9e1e0cee9e49', + riskAssessment: 'low_risk', + appTampering: { + result: 'not_detected', + appDebugging: 'not_detected', + codeInjection: 'not_detected' + } + } + + nock(BASE_ENDPOINT_URL) + .post(`/v2/authentication/transactions`) + .reply(200, apiResponse) + + const login = await incogniaApi.registerLogin({ + requestToken: 'request_token', + accountId: 'account_id' + }) + expect(login).toEqual(expectedResponse) + }) + + it('validates a web login', async () => { + expect(() => + incogniaApi.registerWebLogin({ accountId: 'id' }) + ).rejects.toThrowError('No sessionToken or requestToken provided') + expect(() => + incogniaApi.registerWebLogin({ sessionToken: 'token' } as any) + ).rejects.toThrowError('No accountId provided') + expect(() => + incogniaApi.registerWebLogin({ requestToken: 'token' } as any) + ).rejects.toThrowError('No accountId provided') + }) + + it('registers a web login with session token', async () => { const apiResponse = { id: '5e76a7ca-577c-4f47-a752-9e1e0cee9e49', risk_assessment: 'low_risk' @@ -193,7 +325,41 @@ describe('API', () => { expect(webLogin).toEqual(expectedResponse) }) - it('registers payment', async () => { + it('registers a web login with request token', async () => { + const apiResponse = { + id: '5e76a7ca-577c-4f47-a752-9e1e0cee9e49', + risk_assessment: 'low_risk' + } + + const expectedResponse = { + id: '5e76a7ca-577c-4f47-a752-9e1e0cee9e49', + riskAssessment: 'low_risk' + } + + nock(BASE_ENDPOINT_URL) + .post(`/v2/authentication/transactions`) + .reply(200, apiResponse) + + const webLogin = await incogniaApi.registerWebLogin({ + requestToken: 'request_token', + accountId: 'account_id' + }) + expect(webLogin).toEqual(expectedResponse) + }) + + it('validates a payment', async () => { + expect(() => + incogniaApi.registerPayment({ accountId: 'id' }) + ).rejects.toThrowError('No installationId or requestToken provided') + expect(() => + incogniaApi.registerPayment({ installationId: 'id' } as any) + ).rejects.toThrowError('No accountId provided') + expect(() => + incogniaApi.registerPayment({ requestToken: 'token' } as any) + ).rejects.toThrowError('No accountId provided') + }) + + it('registers payment with installation_id', async () => { const apiResponse = { id: '5e76a7ca-577c-4f47-a752-9e1e0cee9e49', risk_assessment: 'low_risk' @@ -218,7 +384,44 @@ describe('API', () => { expect(payment).toEqual(expectedResponse) }) - it('registers a web payment', async () => { + it('registers payment with request_token', async () => { + const apiResponse = { + id: '5e76a7ca-577c-4f47-a752-9e1e0cee9e49', + risk_assessment: 'low_risk' + } + + const expectedResponse = { + id: '5e76a7ca-577c-4f47-a752-9e1e0cee9e49', + riskAssessment: 'low_risk' + } + + nock(BASE_ENDPOINT_URL) + .post(`/v2/authentication/transactions`) + .reply(200, apiResponse) + + const payment = await incogniaApi.registerPayment({ + requestToken: 'request_token', + accountId: 'account_id', + appId: 'app_id', + externalId: 'external_id', + coupon: { type: CouponType.FixedValue, value: 10 } + }) + expect(payment).toEqual(expectedResponse) + }) + + it('validates a web payment', async () => { + expect(() => + incogniaApi.registerWebPayment({ accountId: 'id' }) + ).rejects.toThrowError('No sessionToken or requestToken provided') + expect(() => + incogniaApi.registerWebPayment({ sessionToken: 'token' } as any) + ).rejects.toThrowError('No accountId provided') + expect(() => + incogniaApi.registerWebPayment({ requestToken: 'token' } as any) + ).rejects.toThrowError('No accountId provided') + }) + + it('registers a web payment with session_token', async () => { const apiResponse = { id: '5e76a7ca-577c-4f47-a752-9e1e0cee9e49', risk_assessment: 'low_risk' @@ -240,6 +443,28 @@ describe('API', () => { expect(webPayment).toEqual(expectedResponse) }) + it('registers a web payment with request_token', async () => { + const apiResponse = { + id: '5e76a7ca-577c-4f47-a752-9e1e0cee9e49', + risk_assessment: 'low_risk' + } + + const expectedResponse = { + id: '5e76a7ca-577c-4f47-a752-9e1e0cee9e49', + riskAssessment: 'low_risk' + } + + nock(BASE_ENDPOINT_URL) + .post(`/v2/authentication/transactions`) + .reply(200, apiResponse) + + const webPayment = await incogniaApi.registerWebPayment({ + requestToken: 'request_token', + accountId: 'account_id' + }) + expect(webPayment).toEqual(expectedResponse) + }) + describe('Registers feedback', () => { beforeAll(() => { nock(BASE_ENDPOINT_URL).post(`/v2/feedbacks`).reply(200, {}) @@ -258,7 +483,7 @@ describe('API', () => { ) const expectedData = { - event: FeedbackEvent.AccountTakeover, + event: FeedbackEvent.AccountTakeover } const expectedParams = { @@ -287,8 +512,8 @@ describe('API', () => { paymentId: 'payment_id', signupId: 'signup_id', timestamp: 123, - occurredAt: new Date("Jul 19 2024 01:02:03 UTC"), - expiresAt: new Date("Jul 30 2024 01:02:03 UTC"), + occurredAt: new Date('Jul 19 2024 01:02:03 UTC'), + expiresAt: new Date('Jul 30 2024 01:02:03 UTC') }, { dryRun: true From 209be1e086424865b10a4dc154916c25d9e2313c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20Rebou=C3=A7as?= Date: Mon, 5 Aug 2024 10:05:43 -0300 Subject: [PATCH 2/3] Update README.md --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 8ef749a..032f107 100644 --- a/README.md +++ b/README.md @@ -23,13 +23,15 @@ yarn add @incognia/api Require the package: CommonJS modules: + ```js const { IncogniaApi } = require('@incognia/api') ``` Or ES modules: + ```js -import { IncogniaApi } from "@incognia/api"; +import { IncogniaApi } from '@incognia/api' ``` Instantiate with your clientId and clientSecret: @@ -45,7 +47,7 @@ const incogniaApi = new IncogniaApi({ ### Registering a Mobile Signup -This method registers a new mobile signup for the given installation and address, returning a signup assessment, containing the risk assessment and supporting evidence: +This method registers a new mobile signup for the given installation (or request token) and address, returning a signup assessment, containing the risk assessment and supporting evidence: ```js try { @@ -72,12 +74,12 @@ try { ### Registering a Web Signup -This method registers a new web signup for the given session token, returning a signup assessment, containing the risk assessment and supporting evidence: +This method registers a new web signup for the given session token (or request token), returning a signup assessment, containing the risk assessment and supporting evidence: ```js try { const signup = await incogniaApi.registerWebSignup({ - sessionToken: 'session_token', + sessionToken: 'session_token' }) } catch (error) { console.log(error.message) @@ -86,7 +88,7 @@ try { ### Registering a Mobile Login -This method registers a new mobile login for the given installation and account, returning a transaction assessment, containing the risk assessment and supporting evidence. +This method registers a new mobile login for the given installation (or request token) and account, returning a transaction assessment, containing the risk assessment and supporting evidence. ```js try { @@ -102,23 +104,22 @@ try { ### Registering a Web Login -This method registers a new web login for the given session token and account, returning a transaction assessment, containing the risk assessment and supporting evidence. +This method registers a new web login for the given session token (or request token) and account, returning a transaction assessment, containing the risk assessment and supporting evidence. ```js try { const login = await incogniaApi.registerWebLogin({ sessionToken: 'session_token', - accountId: 'account_id', + accountId: 'account_id' }) } catch (error) { console.log(error.message) } ``` - ### Registering a Payment -This method registers a new payment for the given installation and account, returning a transaction assessment, containing the risk assessment and supporting evidence. +This method registers a new payment for the given installation (or request token) and account, returning a transaction assessment, containing the risk assessment and supporting evidence. ```js try { @@ -155,7 +156,7 @@ try { ### Registering a Web Payment -This method registers a new web payment for the given session token and account, returning a transaction assessment, containing the risk assessment and supporting evidence. +This method registers a new web payment for the given session token (or request token) and account, returning a transaction assessment, containing the risk assessment and supporting evidence. ```js try { From cdf93dccffdc0846d2fd372a1a9841fad7c22392 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20Rebou=C3=A7as?= Date: Mon, 5 Aug 2024 18:02:28 -0300 Subject: [PATCH 3/3] chore(version): bump version to 5.2.0 --- package.json | 2 +- src/version.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 0109348..0aad72c 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "@incognia/api", "author": "Incognia (https://incognia.com)", "repository": "https://github.com/inloco/incognia-node", - "version": "5.1.0", + "version": "5.2.0", "license": "MIT", "type": "module", "main": "dist/index.cjs", diff --git a/src/version.ts b/src/version.ts index adac1e9..047383e 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1,2 +1,2 @@ // Generated by genversion. -export const version = '5.1.0' +export const version = '5.2.0'