@regulaforensics/vp-frontend-face-components 8.4.2356-nightly → 8.4.2357-rc

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -49,37 +49,6 @@ export declare interface DetailEvent<A, R> {
49
49
  data: CustomEventDataType<R> | null;
50
50
  }
51
51
 
52
- declare type EnrollConfig = {
53
- person: EnrollPersonConfig;
54
- search?: EnrollSearchConfig;
55
- };
56
-
57
- declare type EnrollPersonConfig = {
58
- name?: string;
59
- externalId?: string;
60
- metadata?: Record<string, any>;
61
- groups?: string[];
62
- ttl?: number;
63
- expireAt?: number;
64
- };
65
-
66
- declare type EnrollResult = {
67
- enrolled: boolean;
68
- person: PersonResult | null;
69
- search: SearchResult | null;
70
- };
71
-
72
- declare type EnrollSearchConfig = {
73
- groupIds?: string[];
74
- filter?: {
75
- op: string;
76
- field: string;
77
- value: string[];
78
- };
79
- threshold: number;
80
- limit: number;
81
- };
82
-
83
52
  export declare const ErrorTypes: {
84
53
  readonly WASM_ERROR: "WASM_ERROR";
85
54
  readonly UNKNOWN_ERROR: "UNKNOWN_ERROR";
@@ -150,35 +119,6 @@ export declare class FaceDetectionWebComponent extends HTMLElement {
150
119
 
151
120
  export declare type FaceDictionaries = Partial<Record<Locales, FaceTranslations>>;
152
121
 
153
- export declare type FaceEnrollDetailType = DetailEvent<FaceEventActions, FaceEnrollResponseType>;
154
-
155
- /** web component enroll response */
156
- export declare type FaceEnrollResponseType = FaceLivenessResponseType & {
157
- enrollResult: EnrollResult;
158
- };
159
-
160
- export declare interface FaceEnrollSettings extends FaceLivenessSettings {
161
- enroll?: EnrollConfig;
162
- }
163
-
164
- export declare class FaceEnrollWebComponent extends HTMLElement {
165
- private _root;
166
- private _mounted;
167
- private _translations;
168
- constructor();
169
- static get observedAttributes(): Array<string>;
170
- private onEvent;
171
- attributeChangedCallback(name: string): void;
172
- connectedCallback(): void;
173
- get version(): string;
174
- set translations(dictionary: FaceDictionaries | null);
175
- get translations(): FaceDictionaries | null;
176
- set settings(params: FaceEnrollSettings);
177
- get settings(): FaceEnrollSettings;
178
- private render;
179
- disconnectedCallback(): void;
180
- }
181
-
182
122
  export declare const FaceEventActions: {
183
123
  readonly ELEMENT_VISIBLE: "ELEMENT_VISIBLE";
184
124
  readonly PRESS_START_BUTTON: "PRESS_START_BUTTON";
@@ -194,7 +134,7 @@ export declare type FaceEventActions = (typeof FaceEventActions)[keyof typeof Fa
194
134
 
195
135
  export declare type FaceLivenessDetailType = DetailEvent<FaceEventActions, FaceLivenessResponseType>;
196
136
 
197
- /** web component liveness response */
137
+ /** web component response */
198
138
  export declare type FaceLivenessResponseType = {
199
139
  images: Array<string>;
200
140
  code: number;
@@ -256,35 +196,6 @@ export declare class FaceLivenessWebComponent extends HTMLElement {
256
196
 
257
197
  export declare type FaceTranslations = Partial<Record<Labels, string>>;
258
198
 
259
- export declare type FaceVerifyDetailType = DetailEvent<FaceEventActions, FaceVerifyResponseType>;
260
-
261
- /** web component verify response */
262
- export declare type FaceVerifyResponseType = FaceLivenessResponseType & {
263
- verifyResult: VerifyResult;
264
- };
265
-
266
- export declare interface FaceVerifySettings extends FaceLivenessSettings {
267
- verify?: VerifyConfig;
268
- }
269
-
270
- export declare class FaceVerifyWebComponent extends HTMLElement {
271
- private _root;
272
- private _mounted;
273
- private _translations;
274
- constructor();
275
- static get observedAttributes(): Array<string>;
276
- private onEvent;
277
- attributeChangedCallback(name: string): void;
278
- connectedCallback(): void;
279
- get version(): string;
280
- set translations(dictionary: FaceDictionaries | null);
281
- get translations(): FaceDictionaries | null;
282
- set settings(params: FaceVerifySettings);
283
- get settings(): FaceVerifySettings;
284
- private render;
285
- disconnectedCallback(): void;
286
- }
287
-
288
199
  export declare class FullScreenContainer extends HTMLElement {
289
200
  private _root;
290
201
  constructor();
@@ -300,19 +211,11 @@ export declare interface IFaceDetection {
300
211
  'finish-screen'?: boolean;
301
212
  }
302
213
 
303
- export declare interface IFaceEnroll extends IFaceLiveness {
304
- enroll?: EnrollConfig;
305
- }
306
-
307
214
  export declare interface IFaceLiveness extends IFaceDetection {
308
215
  url?: string;
309
216
  'device-orientation'?: boolean;
310
217
  }
311
218
 
312
- export declare interface IFaceVerify extends IFaceLiveness {
313
- verify?: VerifyConfig;
314
- }
315
-
316
219
  declare type Labels = 'showOnlyOneFace' | 'preparingCamera' | 'allowAccessCamera' | 'somethingWentWrong' | 'incorrectCameraId' | 'checkCameraId' | 'preparingService' | 'allowAccessToCamera' | 'error' | 'versionNotSupported' | 'updateBrowser' | 'licenseError' | 'licenseExpired' | 'onlyPortraitOrientation' | 'turnDeviceIntoPortrait' | 'tryAgain' | 'noCameraAvailable' | 'checkCameraConnection' | 'noMaskSunglassesHeaddress' | 'ambientLighting' | 'lookStraight' | 'fitYourFace' | 'moveCloser' | 'moveAway' | 'holdSteady' | 'takeAPhoto' | 'turnHead' | 'removeOcclusion' | 'turnHeadUp' | 'turnHeadDown' | 'turnHeadLeft' | 'turnHeadRight' | 'blinkYourEyes' | 'processing' | 'retryButtonText' | 'followGuidelinesText' | 'letsTryAgainTitle' | 'noCameraPermission' | 'goButton' | 'centerFaceTurnHead' | 'centerFace' | 'selfieTime' | 'errorCode' | 'illumination' | 'cameraLevel' | 'noAccessories' | 'getReady' | 'httpNotSupported' | 'webServerNotCompatible' | 'processCompleted' | 'notSufficientQuality' | 'cleanCameraLens' | 'addMoreLight' | 'wipeOutOcclusions' | 'changeBackground' | 'tooMuchTurn' | 'makeFaceFullyVisible' | 'done' | 'close';
317
220
 
318
221
  declare type LanguageCodes = 'ru' | 'en' | 'de' | 'pl' | 'it' | 'hu' | 'zh' | 'sk' | 'uk' | 'fr' | 'es' | 'pt' | 'ar' | 'nl' | 'id' | 'vi' | 'ko' | 'ms' | 'ro' | 'el' | 'tr' | 'ja' | 'cs' | 'th' | 'hi' | 'bn' | 'he' | 'fi' | 'sv' | 'da' | 'hr' | 'no' | 'uz' | 'ku' | 'tg' | 'ky' | 'hy';
@@ -323,17 +226,6 @@ declare type LocalCodes = 'ru-RU' | 'en-US' | 'de-DE' | 'pl-PL' | 'it-IT' | 'hu-
323
226
 
324
227
  export declare type Locales = Languages | string;
325
228
 
326
- declare type PersonResult = {
327
- id: string;
328
- createdAt: string;
329
- updatedAt: string;
330
- name: string | null;
331
- externalId: string | null;
332
- metadata: Record<string, any>;
333
- groups: string[];
334
- expireAt: string | null;
335
- };
336
-
337
229
  export declare const RecordingProcess: {
338
230
  readonly ASYNCHRONOUS_UPLOAD: 0;
339
231
  readonly SYNCHRONOUS_UPLOAD: 1;
@@ -350,63 +242,6 @@ export declare const ResponseCode: {
350
242
 
351
243
  export declare type ResponseCode = (typeof ResponseCode)[keyof typeof ResponseCode];
352
244
 
353
- declare type SearchPerson = {
354
- name: string;
355
- externalId: string;
356
- metadata: Record<string, any>;
357
- groups: string[];
358
- expireAt: string;
359
- id: string;
360
- createdAt: string;
361
- updatedAt: string;
362
- detection: {
363
- code: number;
364
- crop: string;
365
- detectorType: number;
366
- hash: string;
367
- idx: number;
368
- image: string;
369
- landmarks: number[];
370
- landmarksType: number;
371
- msg: string;
372
- roi: number[];
373
- versionSDK: string;
374
- };
375
- images: Array<{
376
- id: string;
377
- content: string;
378
- contentType: string;
379
- createdAt: string;
380
- updatedAt: string;
381
- path: string;
382
- url: string;
383
- metadata: Record<string, any>;
384
- similarity: number;
385
- distance: number;
386
- }>;
387
- };
388
-
389
- declare type SearchResult = {
390
- persons: SearchPerson[];
391
- };
392
-
393
- declare type VerifyConfig = {
394
- personId: string;
395
- threshold?: number;
396
- } | {
397
- externalId: string;
398
- threshold?: number;
399
- };
400
-
401
- declare type VerifyResult = {
402
- verified: boolean;
403
- person: PersonResult | null;
404
- match: {
405
- verified: boolean;
406
- similarity: number;
407
- } | null;
408
- };
409
-
410
245
  export { }
411
246
 
412
247
 
@@ -415,7 +250,5 @@ declare global {
415
250
  interface HTMLElementEventMap {
416
251
  'face-liveness': CustomEvent<FaceLivenessDetailType>;
417
252
  'face-capture': CustomEvent<FaceCaptureDetailType>;
418
- 'face-enroll': CustomEvent<FaceEnrollDetailType>;
419
- 'face-verify': CustomEvent<FaceVerifyDetailType>;
420
253
  }
421
254
  }