@onfido/api 2.8.0 → 3.0.0

package/package.json

@@ -1,39 +1,41 @@
 {
   "name": "@onfido/api",
-  "version": "2.8.0",
+  "version": "3.0.0",
   "description": "Node.js library for the Onfido API",
+  "author": "OpenAPI-Generator Contributors",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/onfido/onfido-node.git"
+  },
   "keywords": [
+    "axios",
+    "typescript",
+    "openapi-client",
+    "openapi-generator",
+    "@onfido/api",
     "onfido",
     "identity",
     "verification",
     "api"
   ],
-  "homepage": "https://github.com/onfido/onfido-node#readme",
   "license": "MIT",
-  "author": "Onfido <api@onfido.com> (https://documentation.onfido.com)",
-  "repository": "github:onfido/onfido-node",
-  "main": "dist/index.js",
-  "module": "dist/index.es.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
   "sideEffects": false,
-  "files": [
-    "dist"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
   "scripts": {
-    "build": "rollup -c rollup.config.ts",
     "test": "jest",
-    "test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand",
-    "inspect": "tslint 'src/**/*.ts' 'test/**/*.ts' && prettier --check README.md",
-    "format": "tslint 'src/**/*.ts' 'test/**/*.ts' --fix && prettier --write README.md"
+    "build": "tsc && tsc -p tsconfig.esm.json",
+    "prepare": "npm run build"
   },
+  "files": [
+    "/dist"
+  ],
   "jest": {
     "preset": "ts-jest",
     "testEnvironment": "node",
     "moduleNameMapper": {
-      "onfido-node": "<rootDir>/src/index",
+      "onfido-node": "<rootDir>/index",
       "axios": "axios/dist/node/axios.cjs"
     },
     "globals": {
@@ -42,23 +44,20 @@
       }
     }
   },
+  "dependencies": {
+    "axios": "^1.6.1"
+  },
   "devDependencies": {
-    "@rollup/plugin-json": "^4.1.0",
+    "@faker-js/faker": "^8.4.1",
     "@types/jest": "^26.0.15",
     "jest": "^26.6.3",
-    "nock": "^11.7.0",
     "prettier": "^1.18.2",
-    "rollup": "^1.24.0",
-    "rollup-plugin-typescript2": "^0.25.3",
-    "snakecase-keys": "^5.4.4",
     "ts-jest": "^26.4.4",
-    "tslint": "^5.20.0",
-    "tslint-config-prettier": "^1.18.0",
-    "tslint-plugin-prettier": "^2.0.1",
-    "typescript": "^4.0.5"
+    "dotenv": "^16.4.5",
+    "@types/node": "^12.11.5",
+    "typescript": "^4.0"
   },
-  "dependencies": {
-    "axios": "^1.6.1",
-    "form-data": "^3.0.0"
+  "publishConfig": {
+    "access": "public"
   }
-}
+}

package/CHANGELOG.md

@@ -1,117 +0,0 @@
-# Changelog
-
-## v2.8.0 24 November 2023
-
-- Added `signed_evidence_file` method for WorkflowRuns
-
-## v2.7.2, 14 June 2023
-
-- Added `sandbox` field to Check.
-
-## v2.7.1, 30 May 2023
-
-- Fix bug when uploading documents with `validateImageQuality`.
-
-## v2.7.0, 24 January 2023
-
-- Updated to use API v3.6. For more details please see our [release notes](https://developers.onfido.com/release-notes#api-v36)
-
-## v2.6.0, 7 December 2022
-
-- Added WorkflowRuns support
-
-## v2.5.0, 22 November 2022
-
-- Added Motion capture support
-
-## v2.4.0, 06 October 2022
-
-- Updated to use API v3.5. For more details please see our [release notes](https://developers.onfido.com/release-notes#api-v35)
-
-## v2.3.1, 24 May 2022
-
-- Reinstated `privacyNoticesReadConsentGiven` parameter 
-
-## v2.3.0, 10 May 2022
-
-- Updated to use API v3.4. For more details please see our [release notes](https://developers.onfido.com/release-notes#api-v34)
-- Added `location` to applicant request, applicant response and documents request. `location` is a mandatory parameter for all applicants in order to create a check using API v3.4
-- Added `consents` to applicant request. `consents` is a mandatory parameter for any applicant located in the United States in order to create a check using API v3.4
-- Added `phoneNumber` to applicant request and response
-
-## v2.2.0, 02 March 2022
-
-- Updated to use API v3.3
-
-## v2.1.2, 17 Feb 2022
-
-- Fixed `advancedValidation` flag when uploading live photo
-
-## v2.1.1, 6 Jan 2022
-
-- Added `validate_image_quality` to document upload request
-
-## v2.1.0, 24 June 2021
-
-- Updated to use API v3.2
-
-## v2.0.2, 25 May 2021
-
-- Added `environments` to Webhook object 
-
-## v2.0.1, 17 May 2021
-
-- Added `sub_result` to trigger sandbox pre-determined responses for Document report sub-results
-- Added `consider` array functionality for sandbox pre-determined responses 
-
-## v2.0.0, 9 April 2021
-
-- Updated to use API v3.1
-- Region is now a required argument when constructing an `Onfido` instance. The region previously defaulted to `Region.EU`
-- Add support for downloading a check
-
-## v1.6.0, 8 March 2021
-
-- Add `privacy_notices_read_consent_given` to the type for creating a chec
-
-## v1.5.4, 12 January 2021
-
-- Updated dependencies.
-
-## v1.5.3, 3 December 2020
-
-- Library should work now with `esModuleInterop: false`
-
-## v1.5.2, 3 September 2020
-
-- Fix type declaration location for TypeScript users
-
-## v1.5.1, 20 August 2020
-
-- Ensure consistent version in User-Agent
-
-## v1.5.0, 14 August 2020
-
-- Add User Agent header
-
-## v1.4.0, 15 July 2020
-
-- Add support for [Autofill endpoint](https://documentation.onfido.com/#autofill-beta)
-
-## v1.3.0, 30 June 2020
-
-- Add support for `cross_device_url` when generating an SDK token
-
-## v1.2.0, 23 June 2020
-
-- Allow specifying the filepath and content type explicitly for file upload
-- Add support for the Canada region (api.ca.onfido.com)
-- Add missing `document_ids` field to `CheckRequest` type
-
-## v1.1.0, 2 April 2020
-
-- Improved typing of check and report objects.
-
-## v1.0.0, 23 January 2020
-
-- The initial release of this library, which uses v3 of the Onfido API

package/dist/Onfido.d.ts

@@ -1,40 +0,0 @@
-import { AxiosInstance } from "axios";
-import { Addresses } from "./resources/Addresses";
-import { Applicants } from "./resources/Applicants";
-import { Autofill } from "./resources/Autofill";
-import { Checks } from "./resources/Checks";
-import { Documents } from "./resources/Documents";
-import { LivePhotos } from "./resources/LivePhotos";
-import { LiveVideos } from "./resources/LiveVideos";
-import { MotionCaptures } from "./resources/MotionCaptures";
-import { Reports } from "./resources/Reports";
-import { SdkTokens } from "./resources/SdkTokens";
-import { Webhooks } from "./resources/Webhooks";
-import { WorkflowRuns } from "./resources/WorkflowRuns";
-export declare enum Region {
-    EU = "EU",
-    US = "US",
-    CA = "CA"
-}
-export declare type OnfidoOptions = {
-    apiToken: string;
-    region: Region;
-    timeout?: number;
-    unknownApiUrl?: string;
-};
-export declare class Onfido {
-    readonly axiosInstance: AxiosInstance;
-    readonly applicant: Applicants;
-    readonly document: Documents;
-    readonly livePhoto: LivePhotos;
-    readonly liveVideo: LiveVideos;
-    readonly motionCapture: MotionCaptures;
-    readonly check: Checks;
-    readonly report: Reports;
-    readonly workflowRun: WorkflowRuns;
-    readonly address: Addresses;
-    readonly webhook: Webhooks;
-    readonly sdkToken: SdkTokens;
-    readonly autofill: Autofill;
-    constructor({ apiToken, region, timeout, unknownApiUrl }: OnfidoOptions);
-}

package/dist/OnfidoDownload.d.ts

@@ -1,9 +0,0 @@
-/// <reference types="node" />
-import { IncomingMessage } from "http";
-import { Readable } from "stream";
-export declare class OnfidoDownload {
-    private readonly incomingMessage;
-    constructor(incomingMessage: IncomingMessage);
-    asStream(): Readable;
-    get contentType(): string;
-}

package/dist/Resource.d.ts

@@ -1,22 +0,0 @@
-import { AxiosInstance } from "axios";
-import { SimpleObject } from "./formatting";
-import { OnfidoDownload } from "./OnfidoDownload";
-export declare enum Method {
-    GET = "get",
-    POST = "post",
-    PUT = "put",
-    DELETE = "delete"
-}
-export declare class Resource<T extends SimpleObject> {
-    private readonly name;
-    private readonly axiosInstance;
-    protected constructor(name: string, axiosInstance: AxiosInstance);
-    protected request({ method, path, body, query }: {
-        method: Method;
-        path?: string;
-        body?: T;
-        query?: SimpleObject;
-    }): Promise<any>;
-    protected upload(body: T): Promise<any>;
-    protected download(path: string): Promise<OnfidoDownload>;
-}

package/dist/errors/OnfidoApiError.d.ts

@@ -1,10 +0,0 @@
-import { OnfidoError } from "./OnfidoError";
-export declare class OnfidoApiError extends OnfidoError {
-    readonly responseBody: unknown;
-    readonly statusCode: number;
-    readonly type: string;
-    readonly fields: unknown;
-    private constructor();
-    static fromResponse(responseBody: unknown, statusCode: number): OnfidoApiError;
-    isClientError(): boolean;
-}

package/dist/errors/OnfidoError.d.ts

@@ -1,3 +0,0 @@
-export declare class OnfidoError extends Error {
-    constructor(message?: string);
-}

package/dist/formatting.d.ts

@@ -1,16 +0,0 @@
-/// <reference types="node" />
-import { Readable } from "stream";
-import { IFormData } from "./types/formData";
-export declare type SimpleObject = {
-    [key: string]: unknown;
-};
-declare type ContentsAndOptions = {
-    contents: Readable;
-    filepath: string;
-    contentType?: string;
-};
-export declare type FileLike = Readable | ContentsAndOptions;
-export declare const convertObjectToSnakeCase: (requestBody: unknown) => unknown;
-export declare const convertObjectToCamelCase: (responseBody: SimpleObject) => SimpleObject;
-export declare const toFormData: (object: SimpleObject) => IFormData;
-export {};