@onfido/api 2.9.0 → 3.0.0

package/dist/esm/base.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Onfido API v3.6
+ * The Onfido API (v3.6)
+ *
+ * The version of the OpenAPI document: v3.6
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from './configuration';
+import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
+export declare const BASE_PATH: string;
+/**
+ *
+ * @export
+ */
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: RawAxiosRequestConfig;
+}
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export declare class BaseAPI {
+    protected basePath: string;
+    protected axios: AxiosInstance;
+    protected configuration: Configuration | undefined;
+    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+}
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export declare class RequiredError extends Error {
+    field: string;
+    constructor(field: string, msg?: string);
+}
+interface ServerMap {
+    [key: string]: {
+        url: string;
+        description: string;
+    }[];
+}
+/**
+ *
+ * @export
+ */
+export declare const operationServerMap: ServerMap;
+export {};

package/dist/esm/base.js

@@ -0,0 +1,60 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Onfido API v3.6
+ * The Onfido API (v3.6)
+ *
+ * The version of the OpenAPI document: v3.6
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import globalAxios from 'axios';
+export const BASE_PATH = "https://api.eu.onfido.com/v3.6".replace(/\/+$/, "");
+/**
+ *
+ * @export
+ */
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export class BaseAPI {
+    constructor(configuration, basePath = BASE_PATH, axios = globalAxios) {
+        var _a;
+        this.basePath = basePath;
+        this.axios = axios;
+        if (configuration) {
+            this.configuration = configuration;
+            this.basePath = (_a = configuration.basePath) !== null && _a !== void 0 ? _a : basePath;
+        }
+    }
+}
+;
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export class RequiredError extends Error {
+    constructor(field, msg) {
+        super(msg);
+        this.field = field;
+        this.name = "RequiredError";
+    }
+}
+/**
+ *
+ * @export
+ */
+export const operationServerMap = {};

package/dist/esm/common.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Onfido API v3.6
+ * The Onfido API (v3.6)
+ *
+ * The version of the OpenAPI document: v3.6
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from "./configuration";
+import type { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+import { URL } from 'url';
+/**
+ *
+ * @export
+ */
+export declare const DUMMY_BASE_URL = "https://example.com";
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
+/**
+ *
+ * @export
+ */
+export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
+/**
+ *
+ * @export
+ */
+export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ *
+ * @export
+ */
+export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
+/**
+ *
+ * @export
+ */
+export declare const toPathString: (url: URL) => string;
+/**
+ *
+ * @export
+ */
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/esm/common.js

@@ -0,0 +1,189 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Onfido API v3.6
+ * The Onfido API (v3.6)
+ *
+ * The version of the OpenAPI document: v3.6
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { RequiredError } from "./base";
+import { URLSearchParams } from 'url';
+/**
+ *
+ * @export
+ */
+export const DUMMY_BASE_URL = 'https://example.com';
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export const assertParamExists = function (functionName, paramName, paramValue) {
+    if (paramValue === null || paramValue === undefined) {
+        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+    }
+};
+/**
+ *
+ * @export
+ */
+export const setApiKeyToObject = function (object, keyParamName, configuration) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (configuration && configuration.apiKey) {
+            const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+                ? yield configuration.apiKey(keyParamName)
+                : yield configuration.apiKey;
+            object[keyParamName] = localVarApiKeyValue;
+        }
+    });
+};
+/**
+ *
+ * @export
+ */
+export const setBasicAuthToObject = function (object, configuration) {
+    if (configuration && (configuration.username || configuration.password)) {
+        object["auth"] = { username: configuration.username, password: configuration.password };
+    }
+};
+/**
+ *
+ * @export
+ */
+export const setBearerAuthToObject = function (object, configuration) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (configuration && configuration.accessToken) {
+            const accessToken = typeof configuration.accessToken === 'function'
+                ? yield configuration.accessToken()
+                : yield configuration.accessToken;
+            object["Authorization"] = "Bearer " + accessToken;
+        }
+    });
+};
+/**
+ *
+ * @export
+ */
+export const setOAuthToObject = function (object, name, scopes, configuration) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (configuration && configuration.accessToken) {
+            const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+                ? yield configuration.accessToken(name, scopes)
+                : yield configuration.accessToken;
+            object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+        }
+    });
+};
+function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
+    if (parameter == null)
+        return;
+    if (typeof parameter === "object") {
+        if (Array.isArray(parameter)) {
+            parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
+        }
+        else {
+            Object.keys(parameter).forEach(currentKey => setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`));
+        }
+    }
+    else {
+        if (urlSearchParams.has(key)) {
+            urlSearchParams.append(key, parameter);
+        }
+        else {
+            urlSearchParams.set(key, parameter);
+        }
+    }
+}
+/**
+ *
+ * @export
+ */
+export const setSearchParams = function (url, ...objects) {
+    const searchParams = new URLSearchParams(url.search);
+    setFlattenedQueryParams(searchParams, objects);
+    url.search = searchParams.toString();
+};
+/**
+ *
+ * @export
+ */
+export const serializeDataIfNeeded = function (value, requestOptions, configuration) {
+    const nonString = typeof value !== 'string';
+    const needsSerialization = nonString && configuration && configuration.isJsonMime
+        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
+        : nonString;
+    return needsSerialization
+        ? JSON.stringify(value !== undefined ? convertMapsAndSetsToPlain(value) : {})
+        : (value || "");
+};
+function convertMapsAndSetsToPlain(value) {
+    if (typeof Set === "undefined")
+        return value;
+    if (typeof Map === "undefined")
+        return value;
+    if (typeof value !== "object" || !value) {
+        return value;
+    }
+    if (value instanceof Set) {
+        return Array.from(value).map(item => convertMapsAndSetsToPlain(item));
+    }
+    if (value instanceof Map) {
+        const entries = [];
+        value.forEach((value, key) => {
+            entries.push([key, convertMapsAndSetsToPlain(value)]);
+        });
+        return objectFromEntries(entries);
+    }
+    if (Array.isArray(value)) {
+        return value.map(it => convertMapsAndSetsToPlain(it));
+    }
+    return objectFromEntries(objectEntries(value)
+        .map(([k, v]) => [k, convertMapsAndSetsToPlain(v)]));
+}
+/**
+ * Ponyfill for Object.entries
+ */
+function objectEntries(object) {
+    return Object.keys(object).map(key => [key, object[key]]);
+}
+/**
+ * Ponyfill for Object.fromEntries
+ */
+function objectFromEntries(entries) {
+    return [...entries].reduce((object, [key, val]) => {
+        object[key] = val;
+        return object;
+    }, {});
+}
+/**
+ *
+ * @export
+ */
+export const toPathString = function (url) {
+    return url.pathname + url.search + url.hash;
+};
+/**
+ *
+ * @export
+ */
+export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
+    return (axios = globalAxios, basePath = BASE_PATH) => {
+        var _a;
+        const axiosRequestArgs = Object.assign(Object.assign({}, axiosArgs.options), { url: (axios.defaults.baseURL ? '' : (_a = configuration === null || configuration === void 0 ? void 0 : configuration.basePath) !== null && _a !== void 0 ? _a : basePath) + axiosArgs.url });
+        return axios.request(axiosRequestArgs);
+    };
+};

package/dist/esm/configuration.d.ts

@@ -0,0 +1,93 @@
+/**
+ * Onfido API v3.6
+ * The Onfido API (v3.6)
+ *
+ * The version of the OpenAPI document: v3.6
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare enum Region {
+    EU = 0,
+    US = 1,
+    CA = 2
+}
+export interface ConfigurationParameters {
+    apiToken?: string;
+    region?: Region;
+    basePath?: string;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+export declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * override server index
+     *
+     * @type {number}
+     * @memberof Configuration
+     */
+    serverIndex?: number;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}

package/dist/esm/configuration.js

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Onfido API v3.6
+ * The Onfido API (v3.6)
+ *
+ * The version of the OpenAPI document: v3.6
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { BASE_PATH } from "./base";
+export var Region;
+(function (Region) {
+    Region[Region["EU"] = 0] = "EU";
+    Region[Region["US"] = 1] = "US";
+    Region[Region["CA"] = 2] = "CA";
+})(Region || (Region = {}));
+export class Configuration {
+    constructor(param = {}) {
+        var _a;
+        if (!param.apiToken) {
+            throw new Error("No apiToken provided");
+        }
+        if (param.region && !Object.values(Region).includes(param.region)) {
+            throw new Error(`Unknown or missing region '${param.region}'`);
+        }
+        this.apiKey = 'Token token=' + param.apiToken;
+        this.basePath = param.basePath || BASE_PATH.replace('.eu.', `.${Region[param.region || Region.EU].toLowerCase()}.`);
+        this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/3.0.0' }) });
+        this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed)
+    }
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime) {
+        const jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
+        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
+    }
+}

package/dist/esm/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Onfido API v3.6
+ * The Onfido API (v3.6)
+ *
+ * The version of the OpenAPI document: v3.6
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from "./api";
+export * from "./configuration";
+export * from "./webhook-event-verifier";

package/dist/esm/index.js

@@ -0,0 +1,16 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Onfido API v3.6
+ * The Onfido API (v3.6)
+ *
+ * The version of the OpenAPI document: v3.6
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from "./api";
+export * from "./configuration";
+export * from "./webhook-event-verifier";

package/dist/esm/webhook-event-verifier.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="node" />
+import { WebhookEvent } from "./api";
+export declare class OnfidoInvalidSignatureError extends Error {
+}
+export declare class WebhookEventVerifier {
+    private readonly webhookToken;
+    constructor(webhookToken: string);
+    readPayload(rawEventBody: string | Buffer, hexSignature: string): WebhookEvent;
+}

package/dist/esm/webhook-event-verifier.js

@@ -0,0 +1,31 @@
+// Require crypto instead of importing, because Node can be built without crypto support.
+let crypto;
+try {
+    // tslint:disable-next-line: no-var-requires
+    crypto = require("crypto");
+}
+catch (_a) {
+    // We throw an error when verifying webhooks instead.
+}
+export class OnfidoInvalidSignatureError extends Error {
+}
+export class WebhookEventVerifier {
+    constructor(webhookToken) {
+        this.webhookToken = webhookToken;
+    }
+    readPayload(rawEventBody, hexSignature) {
+        if (!crypto) {
+            throw new Error("Verifying webhook events requires crypto support");
+        }
+        const givenSignature = Buffer.from(hexSignature, "hex");
+        // Compute the the actual HMAC signature from the raw request body.
+        const hmac = crypto.createHmac("sha256", this.webhookToken);
+        hmac.update(rawEventBody);
+        const eventSignature = hmac.digest();
+        // Use timingSafeEqual to prevent against timing attacks.
+        if (!crypto.timingSafeEqual(givenSignature, eventSignature)) {
+            throw new OnfidoInvalidSignatureError("Invalid signature for webhook event");
+        }
+        return JSON.parse(rawEventBody.toString());
+    }
+}

package/dist/index.d.ts

@@ -1,19 +1,14 @@
-export { Onfido, OnfidoOptions, Region } from "./Onfido";
-export { OnfidoDownload } from "./OnfidoDownload";
-export { OnfidoError } from "./errors/OnfidoError";
-export { OnfidoApiError } from "./errors/OnfidoApiError";
-export { FileLike } from "./formatting";
-export { WebhookEvent, WebhookEventVerifier } from "./WebhookEventVerifier";
-export { Applicant, ApplicantRequest } from "./resources/Applicants";
-export { Address, AddressRequest } from "./resources/Addresses";
-export { IdNumber, IdNumberRequest } from "./resources/IdNumbers";
-export { Document, DocumentRequest } from "./resources/Documents";
-export { LivePhoto, LivePhotoRequest } from "./resources/LivePhotos";
-export { LiveVideo } from "./resources/LiveVideos";
-export { MotionCapture } from "./resources/MotionCaptures";
-export { Check, CheckRequest } from "./resources/Checks";
-export { Report } from "./resources/Reports";
-export { Webhook, WebhookRequest } from "./resources/Webhooks";
-export { SdkTokenRequest } from "./resources/SdkTokens";
-export { Autofill, ExtractionResult } from "./resources/Autofill";
-export { WorkflowRun, WorkflowRunRequest } from "./resources/WorkflowRuns";
+/**
+ * Onfido API v3.6
+ * The Onfido API (v3.6)
+ *
+ * The version of the OpenAPI document: v3.6
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from "./api";
+export * from "./configuration";
+export * from "./webhook-event-verifier";