feat: adding network apis

jest.config.ts

@@ -42,14 +42,29 @@ const config: Config.InitialOptions = {
       testMatch: ['<rootDir>/packages/media/__tests__/**/*.test.ts'],
       coveragePathIgnorePatterns: ['node_modules', '__tests__'],
     },
+    {
+      displayName: 'MEETINGS',
+      testMatch: ['<rootDir>/packages/meetings/__tests__/**/*.test.ts'],
+      coveragePathIgnorePatterns: ['node_modules', '__tests__'],
+    },
     {
       displayName: 'MESSAGES',
       testMatch: ['<rootDir>/packages/messages/__tests__/**/*.test.ts'],
       coveragePathIgnorePatterns: ['node_modules', '__tests__'],
     },
     {
-      displayName: 'MEETINGS',
-      testMatch: ['<rootDir>/packages/meetings/__tests__/**/*.test.ts'],
+      displayName: 'NETWORK CLIENT',
+      testMatch: ['<rootDir>/packages/network-client/__tests__/**/*.test.ts'],
+      coveragePathIgnorePatterns: ['node_modules', '__tests__'],
+    },
+    {
+      displayName: 'NETWORK SIM SWAP',
+      testMatch: ['<rootDir>/packages/network-sim-swap/__tests__/**/*.test.ts'],
+      coveragePathIgnorePatterns: ['node_modules', '__tests__'],
+    },
+    {
+      displayName: 'NETWORK NUMBER VERIFICATION',
+      testMatch: ['<rootDir>/packages/network-sim-swap/__tests__/**/*.test.ts'],
       coveragePathIgnorePatterns: ['node_modules', '__tests__'],
     },
     {

packages/network-client/README.md

@@ -0,0 +1,11 @@
+# `network-auth`
+
+> TODO: description
+
+## Usage
+
+```
+const networkAuth = require('network-auth');
+
+// TODO: DEMONSTRATE API
+```

packages/network-client/__tests__/__dataSets__/get.ts

@@ -0,0 +1,30 @@
+import { NetworkClient } from '../../lib';
+import { SDKTestCase, testPrivateKey } from '../../../../testHelpers';
+import { SIMSwap } from '../../../network-sim-swap/lib';
+
+export default [
+  {
+    label: 'retrieve all conversations',
+    client: new SIMSwap(
+      {
+        privateKey: testPrivateKey,
+        applicationId: 'my-application',
+        msisdn: '447700900000',
+      },
+    ) as unknown as NetworkClient,
+    requests: [
+      [`/v1/conversations`, 'GET'],
+    ],
+    responses: [
+      [
+        200,
+        {},
+      ],
+    ],
+    clientMethod: 'foo',
+    parameters: [],
+    generator: false,
+    error: false,
+    expected: [],
+  } as SDKTestCase,
+] 

packages/network-client/__tests__/__dataSets__/index.ts

@@ -0,0 +1,9 @@
+import getTests from './get';
+
+export default [
+  {
+    name: 'GET tests',
+    tests: getTests,
+  },
+];
+

packages/network-client/__tests__/common.ts

@@ -0,0 +1,10 @@
+import { NetworkClient } from '../lib';
+import { VetchOptions, VetchResponse } from '@vonage/vetch';
+
+export const BASE_URL = 'https://api.nexmo.com/';
+
+export class TestNetworkClient extends NetworkClient {
+  async testRequest<T = void>(request: VetchOptions): Promise<VetchResponse<T>> {
+    return await this.sendRequest<T>(request);
+  }
+}

packages/network-client/__tests__/networkClient.test.ts

@@ -0,0 +1,55 @@
+import { NetworkAuthParameters, NetworkClient } from '../lib';
+import nock from 'nock';
+import { BASE_URL } from './common';
+import testDataSets from './__dataSets__';
+import { SDKTestCase, TestTuple, getResults } from '../../../testHelpers';
+
+describe.each<TestTuple>(testDataSets)('$label', ({tests}) => {
+  let client;
+  let scope;
+
+  beforeEach(function () {
+    scope = nock(BASE_URL, {
+      reqheaders: {
+        authorization: (value) => value.startsWith('Bearer '),
+      },
+    }).persist();
+  });
+
+  afterEach(function () {
+    client = null;
+    scope = null;
+    nock.cleanAll();
+  });
+
+  test.each<SDKTestCase>(tests)(
+    'Can $label using: $clientMethod',
+    async ({
+      generator,
+      requests,
+      responses,
+      client,
+      clientMethod,
+      parameters,
+      expected,
+    }) => {
+
+      requests.forEach((request, index) => {
+        scope.intercept(...request).reply(...responses[index]);
+      });
+
+      const results = await getResults(
+        generator,
+        client,
+        clientMethod,
+        parameters,
+      );
+
+      expect(results).toEqual(expected);
+      expect(nock.isDone()).toBeTruthy();
+
+      expect(results).toEqual(expected);
+      expect(nock.isDone()).toBeTruthy();
+    },
+  );
+});

packages/network-client/lib/enums/index.ts

@@ -0,0 +1,2 @@
+export * from './purpose';
+export * from './scope';

packages/network-client/lib/enums/purpose.ts

@@ -0,0 +1,9 @@
+/**
+ * Netowrk API purposes for generating the scope
+ */
+export enum Purpose {
+  /**
+   * Purpose for Fraud Prevention and Detection
+   */
+  FRAUD_PREVENTION_AND_DETECTION = 'FraudPreventionAndDetection',
+}

packages/network-client/lib/enums/scope.ts

@@ -0,0 +1,14 @@
+/**
+ * Scopes for the API
+ */
+export enum Scope {
+  /**
+   * Check for SIM Swap
+   */
+  CHECK_SIM_SWAP = 'check-sim-swap',
+
+  /**
+   * Number Verification
+   */
+  NUMBER_VERIFICATION_VERIFY_READ = 'number-verification-verify-read',
+}

packages/network-client/lib/errors/index.ts

@@ -0,0 +1,4 @@
+export * from './invalidScopeError';
+export * from './missingScopeError';
+export * from './missingPurposeError';
+export * from './invalidPurposeError';

packages/network-client/lib/errors/invalidPurposeError.ts

@@ -0,0 +1,8 @@
+/**
+ * Error thrown when purpose is invalid
+ */
+export class InvalidPurposeError extends Error {
+  constructor() {
+    super(`You did not set a purpose for this request. Please set a proper purpose for this request.`);
+  }
+}

packages/network-client/lib/errors/invalidScopeError.ts

@@ -0,0 +1,8 @@
+/**
+ * Error thrown when scope is invalid
+ */
+export class InvalidScopeError extends Error {
+  constructor() {
+    super(`You did not set a scope for this request. Please set a proper scope for this request.`);
+  }
+}

packages/network-client/lib/errors/missingPurposeError.ts

@@ -0,0 +1,8 @@
+/**
+ * Error thrown when purpose is invalid
+ */
+export class MissingPurposeError extends Error {
+  constructor() {
+    super(`You did not set a purpose for this request.`);
+  }
+}

packages/network-client/lib/errors/missingScopeError.ts

@@ -0,0 +1,8 @@
+/**
+ * Error thrown when no scope is set for a request.
+ */
+export class MissingScopeError extends Error {
+  constructor() {
+    super(`You did not set a scope for this request.`);
+  }
+}

packages/network-client/lib/index.ts

@@ -0,0 +1,4 @@
+export * from './errors';
+export * from './networkClient';
+export * from './types';
+export * from './enums';