feat(number-insight-v2): added support for number insight v2

jest.config.ts

@@ -42,6 +42,13 @@ const config: Config.InitialOptions = {
       testMatch: ['<rootDir>/packages/meetings/__tests__/**/*.test.ts'],
       coveragePathIgnorePatterns: ['node_modules', '__tests__'],
     },
+    {
+      displayName: 'NUMBER INSIGHT V2',
+      testMatch: [
+        '<rootDir>/packages/number-insight-v2/__tests__/**/*.test.ts',
+      ],
+      coveragePathIgnorePatterns: ['node_modules', '__tests__'],
+    },
     {
       displayName: 'NUMBER INSIGHTS',
       testMatch: ['<rootDir>/packages/number-insights/__tests__/**/*.test.ts'],

packages/number-insight-v2/README.md

@@ -0,0 +1,11 @@
+# `number-insight-v2`
+
+> TODO: description
+
+## Usage
+
+```
+const numberInsightV2 = require('number-insight-v2');
+
+// TODO: DEMONSTRATE API
+```

packages/number-insight-v2/__tests__/__dataSets__/index.ts

@@ -0,0 +1,8 @@
+import postTests from './post';
+
+export default [
+  {
+    label: 'Check For Fraud',
+    tests: postTests,
+  },
+];

packages/number-insight-v2/__tests__/__dataSets__/post.ts

@@ -0,0 +1,69 @@
+import {
+  Status,
+  FraudCheckResponse,
+  FraudCheckParameters,
+  Insight,
+  FraudCheck,
+  Label,
+  RiskRecommendation,
+  FraudScoreResponse,
+} from '../../lib';
+
+const params = {
+  type: 'phone',
+  phone: '16127779311',
+  insights: [Insight.SIM_SWAP, Insight.FRAUD_SCORE],
+} as FraudCheckParameters;
+
+const fraudCheck = {
+  requestId: '00000000-0000-0000-0000-000000000000',
+  type: 'phone',
+  phone: {
+    phone: '16127779311',
+    carrier: 'Google (Grand Central) - SVR',
+    type: 'VOIP',
+  },
+  fraudScore: {
+    riskScore: '20',
+    riskRecommendation: RiskRecommendation.ALLOW,
+    label: Label.LOW,
+    status: Status.COMPLETED,
+  },
+  simSwap: {
+    status: Status.COMPLETED,
+    swapped: false,
+  },
+} as FraudCheck;
+
+const response = {
+  request_id: '00000000-0000-0000-0000-000000000000',
+  type: 'phone',
+  phone: {
+    phone: '16127779311',
+    carrier: 'Google (Grand Central) - SVR',
+    type: 'VOIP',
+  },
+  fraud_score: {
+    risk_score: '20',
+    risk_recommendation: 'allow',
+    label: 'low',
+    status: 'completed',
+  } as FraudScoreResponse,
+  sim_swap: {
+    status: 'completed',
+    swapped: false,
+  },
+} as FraudCheckResponse;
+
+export default [
+  {
+    label: 'check for fraud',
+    requests: [[`/v2/ni`, 'POST', params]],
+    responses: [[200, response]],
+    clientMethod: 'checkForFraud',
+    parameters: [params],
+    generator: false,
+    error: false,
+    expected: fraudCheck,
+  },
+];

packages/number-insight-v2/__tests__/common.ts

@@ -0,0 +1 @@
+export const BASE_URL = 'https://api.nexmo.com/';

packages/number-insight-v2/__tests__/numberInsightV2.test.ts

@@ -0,0 +1,48 @@
+import { NumberInsightV2 } from '../lib/index';
+import nock from 'nock';
+import { Auth } from '@vonage/auth';
+import { BASE_URL } from './common';
+import testDataSets from './__dataSets__/index';
+import { readFileSync } from 'fs';
+
+const key = readFileSync(`${__dirname}/private.test.key`).toString();
+
+describe.each(testDataSets)('$label', ({ tests }) => {
+  let client;
+  let scope;
+
+  beforeEach(function () {
+    client = new NumberInsightV2(
+      new Auth({
+        privateKey: key,
+        applicationId: 'my-application',
+      }),
+    );
+
+    scope = nock(BASE_URL, {
+      reqheaders: {
+        authorization: (value) => value.startsWith('Bearer '),
+      },
+    }).persist();
+  });
+
+  afterEach(function () {
+    client = null;
+    scope = null;
+    nock.cleanAll();
+  });
+
+  test.each(tests)(
+    'Can $label using: $clientMethod',
+    async ({ requests, responses, clientMethod, parameters, expected }) => {
+      requests.forEach((request, index) => {
+        scope.intercept(...request).reply(...responses[index]);
+      });
+
+      const result = await client[clientMethod](...parameters);
+
+      expect(result).toEqual(expected);
+      expect(nock.isDone()).toBeTruthy();
+    },
+  );
+});

packages/number-insight-v2/__tests__/private.test.key

@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDTH8cEhJKsu2hB
+ucgs0Blf3tvgdXuIa5sMRI3zIZGok8jqaj6DC0WdM1eiJlQCWnVL0vR25MkopMZN
+MTphoaVpdK9wywMVx7PsgMCDXJjW77QFJFbbcbV9KG2xvMsjJGttmVrn+9aPpCnX
+yT27bWkTR0k/wCAvra/st5MDKg2kB3SMc+97zlO3GqIkJJKfKYQFAO8oRBcsZ1Bx
+ydPWTQvyLYW15Cjv30aIGLfceFwDeUOBgBsesGFtcXvVF6sVxd5D/USunX/9es95
+Rdr4+9Qq4tIKZRkBz2KWD0eo256wmmq2lQoGaR9x6XgLHhUlsi6OXILcyChi2Qcc
+a01Hn7YvAgMBAAECggEAJsS+lIdNsddmIS+e4Q/DoRW49aJNMXNlEN8j2+Itr7GX
+ougom4K94UyUyotUQOxgfrB5wL1pbQO5AGLKUDRRPii1sLYu1liKIyNPdq/RxyJU
+Qd927awXQiji39EF0mm1KnaPOWtG7rCcGGp1Yg4Izgf4nPLIVkkENalOHzYhNB3u
+4W4OIT49iw/auBF4wnl1RmXWXjkxDuk2cYT28a8hWqyQjJqXTsO+u4BaXYxSf4nP
+Be2yoUEFRbcxvJrhEpfODhPP83I1EBipJkhUTc5WMb/vtH2b49+TYd2tPR0LOxom
+mcNUWF6++ae+vL6K8Dlfcvx+CA7g7KBHHcgFCzn7GQKBgQDzc2ow5LlQQ/VfXZTz
+n07V/QgVQ15sA5Cf/gsvmwnGPy06Qx/WRHsz6NG8nvW2mHZwfDIHuLjBW1gcssEx
+mLpqav5XLZfSyjjRO/AxLIfJDx/aARp3+7Ny5aY2e3wtNx8wz4J80i7P+eX3fETM
+70cWhc2PvYMDjG+O7cDW2FWAFwKBgQDeAcc/FBHLl9/HqiBvYf/Y/k0t1TUoHujO
+PSbP6SaN06JnvJmBANyED7sWeIPuoRFXXEr4Auu7y0C55Wlsno/ImTbJsopZ1rgU
+k5q4t9vcu7cGiOr7L7UkySNYZqRjwvKEJ610COexTThSwl0v3GNLP8r4AMdBaqdK
+uO6fVfxxqQKBgFc5ne2Atai9gJe3ltum0382FoRPy+/VYyb/xZA780eVcSXz0N9b
+T+0sWKFFLvJKM/1fcil0FLYqfSpjHXcgqoHgbdpcWo5KqArHd+qWctwl0Bqy1IHy
+q7vZ7jCNE9O7cTBy2OTSBbW8apm+a4Qlowm9zQXYN624zmueYb5YamHnAoGAZvJA
+KHnv/o7AkF/NhpjVARR7SYOSkLY0kl48/zBIVoAK0TvdmrqBhyOcR8E+vIsn9XCw
+uuzvzzdjHlDJYDruxcB2bXVDPoGY/sGrf3iSlXreVkNrY2st/o7euwFtvW0K9ElJ
+34K5nbgHJClI+QajbKN6RSJnQ2hnhvjWfkBrPXECgYEA4MCEm9EyrguEO51am8va
+OjIAiQMkj/iyjsMDL8eH0VM+OMdieHwbkKyajyrB9dFikvWfxiuo3dU1N5vJTzty
+LmzkB8M/rKlAYKD8iKA8cRun4tKzRepHT3JPMu0GYTfcP9ovs5F3aEjX+UuWOO7n
+doWDENAr/VU1RNCDwFdxYFg=
+-----END PRIVATE KEY-----

packages/number-insight-v2/lib/enums/index.ts

@@ -0,0 +1,4 @@
+export * from './insight';
+export * from './label';
+export * from './riskRecommendation';
+export * from './status';

packages/number-insight-v2/lib/enums/insight.ts

@@ -0,0 +1,4 @@
+export enum Insight {
+  FRAUD_SCORE = 'fraud_score',
+  SIM_SWAP = 'sim_swap',
+}

packages/number-insight-v2/lib/enums/label.ts

@@ -0,0 +1,5 @@
+export enum Label {
+  LOW = 'low',
+  MEDIUM = 'medium',
+  HIGH = 'high',
+}

packages/number-insight-v2/lib/enums/riskRecommendation.ts

@@ -0,0 +1,5 @@
+export enum RiskRecommendation {
+  ALLOW = 'allow',
+  FLAG = 'flag',
+  BLOCK = 'block',
+}

packages/number-insight-v2/lib/enums/status.ts

@@ -0,0 +1,4 @@
+export enum Status {
+  COMPLETED = 'completed',
+  FAILED = 'failed',
+}

packages/number-insight-v2/lib/index.ts

@@ -0,0 +1,3 @@
+export * from './enums';
+export * from './numberInsightV2';
+export * from './types';

packages/number-insight-v2/lib/numberInsightV2.ts

@@ -0,0 +1,15 @@
+import { Client, AuthenticationType } from '@vonage/server-client';
+import { FraudCheckParameters, FraudScore, FraudScoreResponse } from './types';
+
+export class NumberInsightV2 extends Client {
+  protected authType = AuthenticationType.JWT;
+
+  async checkForFraud(params: FraudCheckParameters): Promise<FraudScore> {
+    const resp = await this.sendPostRequest<FraudScoreResponse>(
+      `${this.config.apiHost}/v2/ni`,
+      params,
+    );
+
+    return Client.transformers.camelCaseObjectKeys(resp?.data, true);
+  }
+}

packages/number-insight-v2/lib/types/fraudCheck.ts

@@ -0,0 +1,11 @@
+import { PhoneInfo } from './phoneInfo';
+import { FraudScore } from './fraudScore';
+import { SimSwap } from './simSwap';
+
+export type FraudCheck = {
+  requestId: string;
+  type: 'phone';
+  phone: PhoneInfo;
+  fraudScore?: FraudScore;
+  simSwap?: SimSwap;
+};

packages/number-insight-v2/lib/types/fraudScore.ts

@@ -0,0 +1,8 @@
+import { RiskRecommendation, Label, Status } from '../enums';
+
+export type FraudScore = {
+  riskScore: string;
+  riskRecommendation: RiskRecommendation;
+  label: Label;
+  status: Status;
+};

packages/number-insight-v2/lib/types/index.ts

@@ -0,0 +1,7 @@
+export * from './fraudCheck';
+export * from './fraudScore';
+export * from './parameters';
+export * from './phoneInfo';
+export * from './requests';
+export * from './responses';
+export * from './simSwap';

packages/number-insight-v2/lib/types/parameters/fraudParameters.ts

@@ -0,0 +1,7 @@
+import { Insight } from '../../enums/';
+
+export type FraudCheckParameters = {
+  type: 'phone';
+  phone: string;
+  insights: Insight[];
+};

packages/number-insight-v2/lib/types/parameters/index.ts

@@ -0,0 +1 @@
+export * from './fraudParameters';

packages/number-insight-v2/lib/types/phoneInfo.ts

@@ -0,0 +1,5 @@
+export type PhoneInfo = {
+  phone: string;
+  carrier?: string;
+  type?: string;
+};

packages/number-insight-v2/lib/types/requests/fraudCheckRequest.ts

@@ -0,0 +1,7 @@
+import { Insight } from '../../enums';
+
+export type FraudCheckRequest = {
+  type: 'phone';
+  phone: string;
+  insights: Insight[];
+};

packages/number-insight-v2/lib/types/requests/index.ts

@@ -0,0 +1 @@
+export * from './fraudCheckRequest';

packages/number-insight-v2/lib/types/responses/fraudCheckResponse.ts

@@ -0,0 +1,9 @@
+import { FraudCheck } from '../fraudCheck';
+import { FraudScoreResponse } from './fraudScoreResponse';
+import { SimSwap } from '../simSwap';
+
+export type FraudCheckResponse = {
+  request_id: string;
+  fraud_score: FraudScoreResponse;
+  sim_swap: SimSwap;
+} & Omit<FraudCheck, 'requestId' | 'fraudScore' | 'simSwap'>;

packages/number-insight-v2/lib/types/responses/fraudScoreResponse.ts

@@ -0,0 +1,7 @@
+import { RiskRecommendation } from '../../enums';
+import { FraudScore } from '../fraudScore';
+
+export type FraudScoreResponse = {
+  risk_score: string;
+  risk_recommendation: RiskRecommendation;
+} & Omit<FraudScore, 'riskRecommendation' | 'riskScore'>;

packages/number-insight-v2/lib/types/responses/index.ts

@@ -0,0 +1,2 @@
+export * from './fraudCheckResponse';
+export * from './fraudScoreResponse';

packages/number-insight-v2/lib/types/simSwap.ts

@@ -0,0 +1,7 @@
+import { Status } from '../enums/';
+
+export type SimSwap = {
+  status: Status;
+  swapped?: boolean;
+  reason?: string;
+};

packages/number-insight-v2/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@vonage/number-insight-v2",
+  "version": "1.0.0",
+  "description": "Number Insight v2 is designed to give fraud scores for Application Integrations.",
+  "homepage": "https://github.com/vonage/vonage-node-sdk/tree/main/packages/number-insight-v2#readme",
+  "bugs": {
+    "url": "https://github.com/Vonage/vonage-node-sdk/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Vonage/vonage-node-sdk.git"
+  },
+  "license": "Apache-2.0",
+  "author": "Chuck MANCHUCK Reeves <[email protected]>",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "directories": {
+    "lib": "lib",
+    "test": "__tests__"
+  },
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "build": "npm run clean && npm run compile",
+    "clean": "npx shx rm -rf dist tsconfig.tsbuildinfo",
+    "compile": "npx tsc --build --verbose"
+  },
+  "dependencies": {
+    "@vonage/server-client": "1.8.2"
+  },
+  "devDependencies": {
+    "@vonage/auth": "1.6.0",
+    "nock": "13.3.3"
+  }
+}