@regulaforensics/facesdk-webclient 3.1.0 → 4.1.0

package/src/api/search-api.ts

@@ -0,0 +1,133 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API
+ *
+ * The version of the OpenAPI document: 3.2.0
+ * 
+ *
+ * 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, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+// @ts-ignore
+import { OperationLog } from '../models';
+// @ts-ignore
+import { SearchRequest } from '../models';
+// @ts-ignore
+import { SearchResult } from '../models';
+/**
+ * SearchApi - axios parameter creator
+ * @export
+ */
+export const SearchApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 
+         * @summary Find person by image in groups.
+         * @param {SearchRequest} searchRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        search: async (searchRequest: SearchRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'searchRequest' is not null or undefined
+            assertParamExists('search', 'searchRequest', searchRequest)
+            const localVarPath = `/api/search`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(searchRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * SearchApi - functional programming interface
+ * @export
+ */
+export const SearchApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = SearchApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 
+         * @summary Find person by image in groups.
+         * @param {SearchRequest} searchRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async search(searchRequest: SearchRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchResult>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.search(searchRequest, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * SearchApi - factory interface
+ * @export
+ */
+export const SearchApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = SearchApiFp(configuration)
+    return {
+        /**
+         * 
+         * @summary Find person by image in groups.
+         * @param {SearchRequest} searchRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        search(searchRequest: SearchRequest, options?: any): AxiosPromise<SearchResult> {
+            return localVarFp.search(searchRequest, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * SearchApi - object-oriented interface
+ * @export
+ * @class SearchApi
+ * @extends {BaseAPI}
+ */
+export class SearchApi extends BaseAPI {
+    /**
+     * 
+     * @summary Find person by image in groups.
+     * @param {SearchRequest} searchRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SearchApi
+     */
+    public search(searchRequest: SearchRequest, options?: AxiosRequestConfig) {
+        return SearchApiFp(this.configuration).search(searchRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/src/api.ts

@@ -4,7 +4,7 @@
  * Regula FaceSDK Web API
  * Regula FaceSDK Web API
  *
- * The version of the OpenAPI document: 0.1.0
+ * The version of the OpenAPI document: 3.2.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -14,5 +14,8 @@
 
 
 
+export * from './api/group-api';
 export * from './api/matching-api';
+export * from './api/person-api';
+export * from './api/search-api';
 

package/src/base.ts

@@ -4,7 +4,7 @@
  * Regula FaceSDK Web API
  * Regula FaceSDK Web API
  *
- * The version of the OpenAPI document: 0.1.0
+ * The version of the OpenAPI document: 3.2.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,7 +16,7 @@
 import { Configuration } from "./configuration";
 // Some imports not used depending on template conditions
 // @ts-ignore
-import globalAxios, { AxiosPromise, AxiosInstance } from 'axios';
+import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 
 export const BASE_PATH = "http://localhost:41101".replace(/\/+$/, "");
 
@@ -38,7 +38,7 @@ export const COLLECTION_FORMATS = {
  */
 export interface RequestArgs {
     url: string;
-    options: any;
+    options: AxiosRequestConfig;
 }
 
 /**

package/src/common.ts

@@ -0,0 +1,138 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API
+ *
+ * The version of the OpenAPI document: 3.2.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { Configuration } from "./configuration";
+import { RequiredError, RequestArgs } from "./base";
+import { AxiosInstance, AxiosResponse } from 'axios';
+
+/**
+ *
+ * @export
+ */
+export const DUMMY_BASE_URL = 'https://example.com'
+
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
+    if (paramValue === null || paramValue === undefined) {
+        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
+    if (configuration && configuration.apiKey) {
+        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+            ? await configuration.apiKey(keyParamName)
+            : await configuration.apiKey;
+        object[keyParamName] = localVarApiKeyValue;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
+    if (configuration && (configuration.username || configuration.password)) {
+        object["auth"] = { username: configuration.username, password: configuration.password };
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const accessToken = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken()
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + accessToken;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken(name, scopes)
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setSearchParams = function (url: URL, ...objects: any[]) {
+    const searchParams = new URLSearchParams(url.search);
+    for (const object of objects) {
+        for (const key in object) {
+            if (Array.isArray(object[key])) {
+                searchParams.delete(key);
+                for (const item of object[key]) {
+                    searchParams.append(key, item);
+                }
+            } else {
+                searchParams.set(key, object[key]);
+            }
+        }
+    }
+    url.search = searchParams.toString();
+}
+
+/**
+ *
+ * @export
+ */
+export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: 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 ? value : {})
+        : (value || "");
+}
+
+/**
+ *
+ * @export
+ */
+export const toPathString = function (url: URL) {
+    return url.pathname + url.search + url.hash
+}
+
+/**
+ *
+ * @export
+ */
+export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
+    return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
+        const axiosRequestArgs = {...axiosArgs.options, url: (configuration?.basePath || basePath) + axiosArgs.url};
+        return axios.request<T, R>(axiosRequestArgs);
+    };
+}

package/src/configuration.ts

@@ -4,7 +4,7 @@
  * Regula FaceSDK Web API
  * Regula FaceSDK Web API
  *
- * The version of the OpenAPI document: 0.1.0
+ * The version of the OpenAPI document: 3.2.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -20,6 +20,7 @@ export interface ConfigurationParameters {
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     basePath?: string;
     baseOptions?: any;
+    formDataCtor?: new () => any;
 }
 
 export class Configuration {
@@ -64,6 +65,14 @@ export class Configuration {
      * @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 = {}) {
         this.apiKey = param.apiKey;
@@ -72,5 +81,21 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.baseOptions = param.baseOptions;
+        this.formDataCtor = param.formDataCtor;
+    }
+
+    /**
+     * 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.
+     */
+    public isJsonMime(mime: string): boolean {
+        const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
+        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
     }
 }

package/src/ext/face-sdk.ts

@@ -2,11 +2,21 @@ import {BASE_PATH} from "../base.js";
 import {Configuration} from "../configuration.js";
 import globalAxios, {AxiosInstance} from "axios";
 import {MatchingApi} from "./matching-api.js";
+import {GroupApi} from "./group-api";
+import {PersonApi} from "./person-api";
+import {SearchApi} from "./search-api";
 
 export class FaceSdk {
     matchingApi: MatchingApi;
+    groupApi: GroupApi;
+    personApi: PersonApi;
+    searchApi: SearchApi;
+
 
     constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
         this.matchingApi = new MatchingApi(configuration, basePath, axios)
+        this.groupApi = new GroupApi(configuration, basePath, axios)
+        this.personApi = new PersonApi(configuration, basePath, axios)
+        this.searchApi = new SearchApi(configuration, basePath, axios)
     }
 }

package/src/ext/group-api.ts

@@ -0,0 +1,34 @@
+import {GroupApi as GenGroupApi} from "../api/group-api";
+import {GroupToCreate, UpdateGroup} from "../models";
+import {AxiosRequestConfig} from "axios";
+
+export class GroupApi extends GenGroupApi {
+    createGroup(groupToCreate: GroupToCreate, options?: AxiosRequestConfig): any {
+        return super.createGroup(groupToCreate, options).then(r => r.data);
+    }
+
+    deleteGroup(groupId: number, options?: AxiosRequestConfig): any {
+        return super.deleteGroup(groupId, options).then(r => r.data);
+    }
+
+    getAllGroups(page: number, size: number, options?: AxiosRequestConfig): any {
+        return super.getAllGroups(page, size, options).then(r => r.data);
+    }
+
+    getAllPersonsByGroupId(page: number, size: number, groupId: number, options?: AxiosRequestConfig): any {
+        return super.getAllPersonsByGroupId(page, size, groupId, options).then(r => r.data);
+    }
+
+    getGroup(groupId: number, options?: AxiosRequestConfig): any {
+        return super.getGroup(groupId, options).then(r => r.data);
+    }
+
+    updateGroup(groupId: number, groupToCreate: GroupToCreate, options?: AxiosRequestConfig): any {
+        return super.updateGroup(groupId, groupToCreate, options).then(r => r.data);
+    }
+
+    updatePersonsInGroup(groupId: number, updateGroup: UpdateGroup, options?: AxiosRequestConfig): any {
+        return super.updatePersonsInGroup(groupId, updateGroup, options).then(r => r.data);
+    }
+
+}

package/src/ext/index.ts

@@ -1,2 +1 @@
-export * from './matching-api.js';
 export * from './face-sdk.js';

package/src/ext/matching-api.ts

@@ -1,12 +1,12 @@
 import {MatchingApi as GenMatchingApi} from "../api/matching-api.js";
-import {MatchRequest, MatchResponse, DetectRequest, DetectResponse, ImageSource} from "../models/index.js";
+import {MatchRequest, DetectRequest, ImageSource} from "../models/index.js";
 
 // @ts-ignore
-import converter from "base64-arraybuffer";
+import * as converter from "base64-arraybuffer";
 
 export class MatchingApi extends GenMatchingApi {
 
-  match(compareRequest: MatchRequest, options?: any): Promise<MatchResponse> {
+  match(compareRequest: MatchRequest, options?: any): any {
     for (const image of compareRequest.images) {
       if (!image.type) {
         image.type = ImageSource.LIVE
@@ -15,18 +15,14 @@ export class MatchingApi extends GenMatchingApi {
         image.data = converter.encode(image.data)
       }
     }
-    return super.matchGen(compareRequest, options).then(r => r.data);
-  }
 
-  // deprecated, use match()
-  compare(compareRequest: MatchRequest, options?: any): Promise<MatchResponse> {
-    return this.match(compareRequest, options)
+    return super.match(compareRequest, options).then(r => r.data);
   }
 
-  detect(detectRequest: DetectRequest, options?: any): Promise<DetectResponse> {
-    if (typeof detectRequest.image !== "string") {
+  detect(detectRequest: DetectRequest, options?: any): any {
+    if (detectRequest.image && typeof detectRequest.image !== "string") {
       detectRequest.image = converter.encode(detectRequest.image)
     }
-    return super.detectGen(detectRequest, options).then(r => r.data)
+    return super.detect(detectRequest, options).then(r => r.data)
   }
 }

package/src/ext/person-api.ts

@@ -0,0 +1,51 @@
+import {PersonApi as GenPersonApi} from "../api/person-api";
+
+// @ts-ignore
+import * as converter from "base64-arraybuffer";
+import {ImageFields, PersonFields} from "../models";
+import {AxiosRequestConfig} from "axios";
+
+export class PersonApi extends GenPersonApi {
+    createPerson(personFields: PersonFields, options?: AxiosRequestConfig): any {
+        return super.createPerson(personFields, options).then(r => r.data);
+    }
+
+    addImageToPerson(personId: number, imageFields: ImageFields, options?: AxiosRequestConfig): any {
+        if (imageFields.image.content && typeof imageFields.image.content !== "string") {
+            imageFields.image.content = converter.encode(imageFields.image.content)
+        }
+        return super.addImageToPerson(personId, imageFields, options).then(r => r.data);
+    }
+
+    deleteImageOfPerson(imageId: number, personId: number, options?: AxiosRequestConfig): any {
+        return super.deleteImageOfPerson(imageId, personId, options).then(r => r.data);
+    }
+
+    deletePerson(personId: number, options?: AxiosRequestConfig): any {
+        return super.deletePerson(personId, options).then(r => r.data);
+    }
+
+    getAllGroupsByPersonId(page: number, size: number, personId: number, options?: AxiosRequestConfig): any {
+        return super.getAllGroupsByPersonId(page, size, personId, options).then(r => r.data);
+    }
+
+    getAllImagesByPersonId(page: number, size: number, personId: number, options?: AxiosRequestConfig): any {
+        return super.getAllImagesByPersonId(page, size, personId, options).then(r => r.data);
+    }
+
+    getAllPersons(page: number, size: number, options?: AxiosRequestConfig): any {
+        return super.getAllPersons(page, size, options).then(r => r.data);
+    }
+
+    getImageOfPerson(imageId: number, personId: number, options?: AxiosRequestConfig): any {
+        return super.getImageOfPerson(imageId, personId, options).then(r => r.data);
+    }
+
+    getPerson(personId: number, options?: AxiosRequestConfig): any {
+        return super.getPerson(personId, options).then(r => r.data);
+    }
+
+    updatePerson(personId: number, personFields: PersonFields, options?: AxiosRequestConfig): any {
+        return super.updatePerson(personId, personFields, options).then(r => r.data);
+    }
+}

package/src/ext/search-api.ts

@@ -0,0 +1,14 @@
+import {SearchApi as GenSearchApi} from "../api/search-api";
+import * as converter from "base64-arraybuffer";
+import {SearchRequest} from "../models";
+import {AxiosRequestConfig} from "axios";
+
+
+export class SearchApi extends GenSearchApi {
+    search(searchRequest: SearchRequest, options?: AxiosRequestConfig): any {
+        if (searchRequest.image.content && typeof searchRequest.image.content !== "string") {
+            searchRequest.image.content = converter.encode(searchRequest.image.content)
+        }
+        return super.search(searchRequest, options).then(r => r.data);
+    }
+}

package/src/index.ts

@@ -16,4 +16,3 @@
 export * from './ext/index.js';
 export * from "./configuration.js";
 export * from "./models/index.js";
-export * from "./models/face-recognition-result-code.js"

package/src/models/crop.ts

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula FaceSDK Web API
+ * Regula FaceSDK Web API
+ *
+ * The version of the OpenAPI document: 3.2.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { FaceAlignTypeQuality } from './face-align-type-quality';
+
+/**
+ * 
+ * @export
+ * @interface Crop
+ */
+export interface Crop {
+    /**
+     * 
+     * @type {FaceAlignTypeQuality}
+     * @memberof Crop
+     */
+    'type'?: FaceAlignTypeQuality;
+    /**
+     * 
+     * @type {Array<number>}
+     * @memberof Crop
+     */
+    'padColor'?: Array<number>;
+    /**
+     * The resize value in case type matches this value. It it doesn\'t, no resize is done.
+     * @type {Array<number>}
+     * @memberof Crop
+     */
+    'size'?: Array<number>;
+    /**
+     * Whether to return the coordinates of the rectangle with the face in the original image prepared for the face crop.
+     * @type {boolean}
+     * @memberof Crop
+     */
+    'returnOriginalRect'?: boolean;
+}
+

package/src/models/detect-request.ts

@@ -4,7 +4,7 @@
  * Regula FaceSDK Web API
  * Regula FaceSDK Web API
  *
- * The version of the OpenAPI document: 0.1.0
+ * The version of the OpenAPI document: 3.2.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,6 +13,7 @@
  */
 
 
+import { ProcessParam } from './process-param';
 import { ImageData } from './image-data';
 
 /**
@@ -21,30 +22,41 @@ import { ImageData } from './image-data';
  * @interface DetectRequest
  */
 export interface DetectRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof DetectRequest
+     */
+    'tag'?: string;
+    /**
+     * 
+     * @type {ProcessParam}
+     * @memberof DetectRequest
+     */
+    'processParam'?: ProcessParam;
     /**
      * 
      * @type {ImageData}
      * @memberof DetectRequest
      */
-    image?: ImageData;
+    'image'?: ImageData;
     /**
-     * Enable formatted detections\' thumbnails in the response
+     * Whether to return the cropped portrains with the detected faces.
      * @type {boolean}
      * @memberof DetectRequest
      */
-    thumbnails?: boolean;
+    'thumbnails'?: boolean;
     /**
-     * Enable face attributions detection, such as age or emotion and etc.
+     * Whether to evaluate attributes, such as age and emotions.
      * @type {boolean}
      * @memberof DetectRequest
      */
-    attributes?: boolean;
+    'attributes'?: boolean;
     /**
-     * True - main face; false - all faces.
+     * Whether to detect the only central face (true) or all the faces (false).
      * @type {boolean}
      * @memberof DetectRequest
      */
-    onlyCentralFace?: boolean;
+    'onlyCentralFace'?: boolean;
 }
 
-

package/src/models/detect-response-all-of.ts

@@ -4,7 +4,7 @@
  * Regula FaceSDK Web API
  * Regula FaceSDK Web API
  *
- * The version of the OpenAPI document: 0.1.0
+ * The version of the OpenAPI document: 3.2.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -26,7 +26,6 @@ export interface DetectResponseAllOf {
      * @type {DetectResult}
      * @memberof DetectResponseAllOf
      */
-    results?: DetectResult;
+    'results'?: DetectResult;
 }
 
-