@forgerock/recognize 0.0.0-beta-20260811162949

package/dist/src/lib/recognize.d.ts

@@ -0,0 +1,8 @@
+import type { RecognizeWebComponentClient, RecognizeWebComponentConfiguration } from './recognize.types.js';
+/**
+ * @function recognize - Returns a client to interact with the PingOne Recognize SDK web components
+ * @param {RecognizeWebComponentConfiguration} configuration - Configuration for the PingOne Recognize SDK
+ * @returns {RecognizeWebComponentClient}
+ */
+export declare function recognize(configuration: RecognizeWebComponentConfiguration): RecognizeWebComponentClient;
+//# sourceMappingURL=recognize.d.ts.map

package/dist/src/lib/recognize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recognize.d.ts","sourceRoot":"","sources":["../../../src/lib/recognize.ts"],"names":[],"mappings":"AAqBA,OAAO,KAAK,EAIV,2BAA2B,EAC3B,kCAAkC,EAKnC,MAAM,sBAAsB,CAAC;AAE9B;;;;GAIG;AACH,wBAAgB,SAAS,CACvB,aAAa,EAAE,kCAAkC,GAChD,2BAA2B,CAwI7B"}

package/dist/src/lib/recognize.js

@@ -0,0 +1,122 @@
+/*
+ *
+ * Copyright © 2026 Ping Identity Corporation. All right reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ *
+ */
+import { CAMERA_ONLY_DISABLE_STEPS } from './defs/constants.js';
+import { RECOGNIZE_ERROR_CODE } from './defs/recognize-error-code.js';
+import { RECOGNIZE_SDK_TO_RECOGNIZE_PROXY_ERROR_MAP } from './defs/recognize-sdk-to-recognize-proxy-error-map.js';
+import { createRecognizeError } from './functions/create-recognize-error.js';
+import { setAttributes } from './functions/set-attributes.js';
+import { KeylessRecoverableErrorEvent } from './recognize-sdk/index.js';
+/**
+ * @function recognize - Returns a client to interact with the PingOne Recognize SDK web components
+ * @param {RecognizeWebComponentConfiguration} configuration - Configuration for the PingOne Recognize SDK
+ * @returns {RecognizeWebComponentClient}
+ */
+export function recognize(configuration) {
+    const config = {
+        disableSteps: CAMERA_ONLY_DISABLE_STEPS,
+        ...configuration,
+    };
+    const observers = new Set();
+    let element = null;
+    const aborter = new AbortController();
+    const dispatch = (event) => {
+        for (const observer of observers) {
+            observer.next(event);
+        }
+    };
+    const addEventListeners = (element) => {
+        const onError = (event) => {
+            if (event instanceof KeylessRecoverableErrorEvent) {
+                element?.dispose();
+            }
+            const code = RECOGNIZE_SDK_TO_RECOGNIZE_PROXY_ERROR_MAP[event.error?.message] ??
+                RECOGNIZE_ERROR_CODE.SDK_ERROR;
+            const error = createRecognizeError(code, { cause: event.error });
+            for (const observer of observers) {
+                observer.error?.(error);
+            }
+            observers.clear();
+        };
+        const onRecognitionFailure = (event) => {
+            return onError(new KeylessRecoverableErrorEvent({
+                error: new Error('SERVER_RECOGNITION_FAILED', { cause: event.detail }),
+            }));
+        };
+        const onRecoverableError = (event) => onError(event);
+        const onSuccess = (event) => {
+            for (const observer of observers) {
+                observer.complete?.(event.detail);
+            }
+            observers.clear();
+        };
+        const onNonCancelable = () => dispatch({ type: 'non-cancelable' });
+        const onRecognitionStart = () => dispatch({ type: 'recognition-start' });
+        const onStepChange = (event) => dispatch({ type: 'step-change', detail: event.detail });
+        const onVideoFrameQuality = (event) => dispatch({ type: 'video-frame-quality', detail: event.detail });
+        const options = { signal: aborter.signal };
+        element.addEventListener('error', onError, options);
+        element.addEventListener('non-cancelable', onNonCancelable, options);
+        element.addEventListener('recognition-failure', onRecognitionFailure, options);
+        element.addEventListener('recognition-start', onRecognitionStart, options);
+        element.addEventListener('recoverable-error', onRecoverableError, options);
+        element.addEventListener('step-change', onStepChange, options);
+        element.addEventListener('success', onSuccess, options);
+        element.addEventListener('video-frame-quality', onVideoFrameQuality, options);
+    };
+    const client = {
+        subscribe: (observer) => {
+            observers.add(observer);
+            return () => observers.delete(observer);
+        },
+        async init(options) {
+            if (element !== null) {
+                return createRecognizeError(RECOGNIZE_ERROR_CODE.SDK_ERROR, {
+                    cause: 'init() called more than once — call dispose() before re-initializing',
+                });
+            }
+            try {
+                await import('./recognize-sdk/index.js');
+            }
+            catch (error) {
+                return createRecognizeError(RECOGNIZE_ERROR_CODE.SDK_WEB_ASSEMBLY_IMPORT_FAILED, {
+                    cause: error,
+                });
+            }
+            if (options.mode === 'attach') {
+                const tag = options.element.tagName;
+                if (tag !== 'KL-AUTH' && tag !== 'KL-ENROLL') {
+                    return createRecognizeError(RECOGNIZE_ERROR_CODE.SDK_ERROR, {
+                        cause: `invalid element <${tag.toLowerCase()}> — options.element must be a <kl-auth> or <kl-enroll> custom element`,
+                    });
+                }
+                element = options.element;
+                element.username = options.username;
+                setAttributes(element, config);
+                addEventListeners(element);
+            }
+            else {
+                const tag = options.type === 'auth' ? 'kl-auth' : 'kl-enroll';
+                element = document.createElement(tag);
+                element.username = options.username;
+                setAttributes(element, config);
+                addEventListeners(element);
+                options.container.appendChild(element);
+            }
+        },
+        dispose: () => {
+            if (element === null)
+                return;
+            aborter.abort();
+            element.remove();
+            element = null;
+            observers.clear();
+        },
+    };
+    return client;
+}

package/dist/src/lib/recognize.types.d.ts

@@ -0,0 +1,113 @@
+import type { LocalizationPack, LocalizationVariables, LoggerLevel, Theme } from '@aracna/core';
+import type { RECOGNIZE_ERROR_CODE } from './defs/recognize-error-code.js';
+import type { KeylessAuthElement, KeylessCameraInstruction, KeylessComponentsStep, KeylessEnrollElement, KeylessStepChangeEventDetail, KeylessSuccessEventDetail, KeylessThemeOptions, KeylessVideoFrameQualityEventDetail } from './recognize-sdk/index.js';
+declare global {
+    interface HTMLElementTagNameMap {
+        'kl-auth': KeylessAuthElement;
+        'kl-enroll': KeylessEnrollElement;
+    }
+}
+/** @public */
+export interface CreateRecognizeErrorOptions {
+    cause?: unknown;
+}
+/** @public */
+export interface RecognizeError {
+    error: {
+        cause?: unknown;
+        code: RecognizeErrorCodeValue;
+        message: RecognizeErrorCodeKey;
+    };
+}
+/** @public */
+export type RecognizeErrorCodeKey = keyof typeof RECOGNIZE_ERROR_CODE;
+/** @public */
+export type RecognizeErrorCodeValue = (typeof RECOGNIZE_ERROR_CODE)[RecognizeErrorCodeKey];
+/** @public */
+export type RecognizeSessionType = 'auth' | 'enroll';
+/**
+ * Events
+ */
+/** */
+/** @public */
+export type RecognizeWebComponentStepChangeEventDetail = KeylessStepChangeEventDetail;
+/** @public */
+export type RecognizeWebComponentVideoFrameQualityEventDetail = KeylessVideoFrameQualityEventDetail;
+/**
+ * Web Components Client
+ */
+/** */
+/** @public */
+export interface RecognizeWebComponentClient {
+    subscribe: (observer: RecognizeWebComponentObserver) => RecognizeWebComponentUnsubscribe;
+    init(options: RecognizeWebComponentInitOptions): Promise<RecognizeError | void>;
+    dispose: () => void;
+}
+/** @public */
+export type RecognizeWebComponentCompleteData = KeylessSuccessEventDetail;
+/** @public */
+export interface RecognizeWebComponentConfiguration {
+    aspectRatio?: number | string;
+    authorizationToken?: string;
+    cameraAspectRatio?: number | string;
+    cameraInstructions?: KeylessCameraInstruction[];
+    customer: string;
+    datadogEnv?: string;
+    datadogToken?: string;
+    disableDatadog?: boolean;
+    disableLogger?: boolean;
+    disablePoweredBy?: boolean;
+    disableSteps?: KeylessComponentsStep[];
+    enableCameraFlash?: boolean;
+    enableCameraInstructions?: boolean;
+    enableCameraInstructionsIcons?: boolean;
+    enableDatadogPII?: boolean;
+    enableWasmPthreads?: boolean;
+    lang?: string;
+    localizationPacks?: LocalizationPack[];
+    localizationVariables?: LocalizationVariables;
+    loggerLevel?: LoggerLevel;
+    operationID?: string;
+    seedEntropy?: boolean;
+    serviceURL: string;
+    theme?: Theme;
+    themeOptions?: KeylessThemeOptions;
+    transactionData?: string;
+    wasmBinaryURL?: string;
+    wasmDataURL?: string;
+    wasmScriptURL?: string;
+}
+/** @public */
+export type RecognizeWebComponent = KeylessAuthElement | KeylessEnrollElement;
+/** @public */
+export type RecognizeWebComponentEvent = {
+    type: 'non-cancelable';
+} | {
+    type: 'recognition-start';
+} | {
+    type: 'step-change';
+    detail: RecognizeWebComponentStepChangeEventDetail;
+} | {
+    type: 'video-frame-quality';
+    detail: RecognizeWebComponentVideoFrameQualityEventDetail;
+};
+/** @public */
+export type RecognizeWebComponentInitOptions = {
+    mode: 'mount';
+    container: HTMLElement;
+    type: RecognizeSessionType;
+    username: string;
+} | {
+    mode: 'attach';
+    element: HTMLElement;
+    username: string;
+};
+/** @public */
+export interface RecognizeWebComponentObserver {
+    next: (event: RecognizeWebComponentEvent) => void;
+    error?: (error: RecognizeError) => void;
+    complete?: (data: RecognizeWebComponentCompleteData) => void;
+}
+/** @public */
+export type RecognizeWebComponentUnsubscribe = () => void;
+//# sourceMappingURL=recognize.types.d.ts.map

package/dist/src/lib/recognize.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recognize.types.d.ts","sourceRoot":"","sources":["../../../src/lib/recognize.types.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAEhG,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,KAAK,EACV,kBAAkB,EAClB,wBAAwB,EACxB,qBAAqB,EACrB,oBAAoB,EACpB,4BAA4B,EAC5B,yBAAyB,EACzB,mBAAmB,EACnB,mCAAmC,EACpC,MAAM,0BAA0B,CAAC;AAElC,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,SAAS,EAAE,kBAAkB,CAAC;QAC9B,WAAW,EAAE,oBAAoB,CAAC;KACnC;CACF;AAED,cAAc;AACd,MAAM,WAAW,2BAA2B;IAC1C,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,cAAc;AACd,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE;QACL,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,IAAI,EAAE,uBAAuB,CAAC;QAC9B,OAAO,EAAE,qBAAqB,CAAC;KAChC,CAAC;CACH;AAED,cAAc;AACd,MAAM,MAAM,qBAAqB,GAAG,MAAM,OAAO,oBAAoB,CAAC;AAEtE,cAAc;AACd,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,qBAAqB,CAAC,CAAC;AAE3F,cAAc;AACd,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,QAAQ,CAAC;AAErD;;GAEG;AACH,MAAM;AACN,cAAc;AACd,MAAM,MAAM,0CAA0C,GAAG,4BAA4B,CAAC;AAEtF,cAAc;AACd,MAAM,MAAM,iDAAiD,GAAG,mCAAmC,CAAC;AAEpG;;GAEG;AACH,MAAM;AAEN,cAAc;AACd,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,CAAC,QAAQ,EAAE,6BAA6B,KAAK,gCAAgC,CAAC;IACzF,IAAI,CAAC,OAAO,EAAE,gCAAgC,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IAChF,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAED,cAAc;AACd,MAAM,MAAM,iCAAiC,GAAG,yBAAyB,CAAC;AAE1E,cAAc;AACd,MAAM,WAAW,kCAAkC;IACjD,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACpC,kBAAkB,CAAC,EAAE,wBAAwB,EAAE,CAAC;IAChD,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,qBAAqB,EAAE,CAAC;IACvC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACvC,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAC9C,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,YAAY,CAAC,EAAE,mBAAmB,CAAC;IACnC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,cAAc;AACd,MAAM,MAAM,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;AAE9E,cAAc;AACd,MAAM,MAAM,0BAA0B,GAClC;IAAE,IAAI,EAAE,gBAAgB,CAAA;CAAE,GAC1B;IAAE,IAAI,EAAE,mBAAmB,CAAA;CAAE,GAC7B;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,MAAM,EAAE,0CAA0C,CAAA;CAAE,GAC3E;IAAE,IAAI,EAAE,qBAAqB,CAAC;IAAC,MAAM,EAAE,iDAAiD,CAAA;CAAE,CAAC;AAE/F,cAAc;AACd,MAAM,MAAM,gCAAgC,GACxC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,SAAS,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,oBAAoB,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GACvF;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,WAAW,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAE/D,cAAc;AACd,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,CAAC,KAAK,EAAE,0BAA0B,KAAK,IAAI,CAAC;IAClD,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;IACxC,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,iCAAiC,KAAK,IAAI,CAAC;CAC9D;AAED,cAAc;AACd,MAAM,MAAM,gCAAgC,GAAG,MAAM,IAAI,CAAC"}

package/dist/src/lib/recognize.types.js

@@ -0,0 +1,9 @@
+/*
+ *
+ * Copyright © 2026 Ping Identity Corporation. All right reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ *
+ */
+export {};

package/dist/src/types.d.ts

@@ -0,0 +1,2 @@
+export type { CreateRecognizeErrorOptions, RecognizeError, RecognizeErrorCodeKey, RecognizeErrorCodeValue, RecognizeSessionType, RecognizeWebComponentClient, RecognizeWebComponentCompleteData, RecognizeWebComponentConfiguration, RecognizeWebComponentEvent, RecognizeWebComponentInitOptions, RecognizeWebComponentObserver, RecognizeWebComponentStepChangeEventDetail, RecognizeWebComponentUnsubscribe, RecognizeWebComponentVideoFrameQualityEventDetail, } from './lib/recognize.types.js';
+//# sourceMappingURL=types.d.ts.map

package/dist/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,2BAA2B,EAC3B,cAAc,EACd,qBAAqB,EACrB,uBAAuB,EACvB,oBAAoB,EACpB,2BAA2B,EAC3B,iCAAiC,EACjC,kCAAkC,EAClC,0BAA0B,EAC1B,gCAAgC,EAChC,6BAA6B,EAC7B,0CAA0C,EAC1C,gCAAgC,EAChC,iDAAiD,GAClD,MAAM,0BAA0B,CAAC"}

package/dist/src/types.js

@@ -0,0 +1 @@
+export {};

package/dist/tsconfig.lib.tsbuildinfo

@@ -0,0 +1 @@
+{"version":"5.8.3"}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@forgerock/recognize",
+  "version": "0.0.0-beta-20260811162949",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ForgeRock/ping-javascript-sdk.git",
+    "directory": "packages/recognize"
+  },
+  "description": "Facial recognition client for the Ping JavaScript SDK",
+  "license": "MIT",
+  "author": "ForgeRock",
+  "sideEffects": [
+    "dist/src/lib/recognize-sdk/index.js"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js",
+      "default": "./dist/src/index.js"
+    },
+    "./package.json": "./package.json",
+    "./types": "./dist/src/types.js"
+  },
+  "main": "./dist/src/index.js",
+  "module": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@aracna/core": "^1.5.0"
+  },
+  "devDependencies": {
+    "@aracna/web-components": "^1.1.18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "nx": {
+    "tags": [
+      "scope:package"
+    ],
+    "targets": {
+      "build": {
+        "executor": "@nx/js:tsc",
+        "outputs": [
+          "{options.outputPath}"
+        ],
+        "options": {
+          "outputPath": "packages/recognize/dist",
+          "main": "packages/recognize/src/index.ts",
+          "tsConfig": "packages/recognize/tsconfig.lib.json",
+          "generatePackageJson": false,
+          "assets": [
+            {
+              "input": "packages/recognize/src/lib/recognize-sdk",
+              "glob": "**/*",
+              "output": "./src/lib/recognize-sdk"
+            }
+          ]
+        }
+      }
+    }
+  },
+  "scripts": {
+    "lint": "pnpm nx nxLint",
+    "test": "pnpm nx nxTest",
+    "test:watch": "pnpm nx nxTest --watch"
+  }
+}