Skip to content

feat: add-recognize-proxy #580

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ryanbas21 wants to merge 8 commits into
base: main
Choose a base branch
from
Open

feat: add-recognize-proxy #580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
39ee8bf
feat: add-recognize-proxy
ryanbas21 Apr 23, 2026
b60f46c
feat: implement recognize client and error handling in SDK
eugeniobet-ping Jun 5, 2026
e9817c8
feat: refactor recognize SDK error handling and improve type definitions
eugeniobet-ping Jun 11, 2026
0d673aa
feat: update error handling in recognize SDK to throw descriptive err…
eugeniobet-ping Jun 12, 2026
b66ab2b
feat: update RecognizeWcCompleteDetail to use interface instead of ty…
eugeniobet-ping Jun 12, 2026
7bd16ba
feat: enhance recognize tests and update vitest configuration for jsd…
eugeniobet-ping Jun 12, 2026
43da855
feat: update createRecognizeError to use Error type for cause and imp…
eugeniobet-ping Jun 12, 2026
01690ab
feat: optimize error and event handling
dariosechi-ping Jun 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions e2e/recognize-app/eslint.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import baseConfig from '../../eslint.config.mjs';

export default [
{
ignores: [
'node_modules',
'*.md',
'LICENSE',
'.swcrc',
'.babelrc',
'.env*',
'.bin',
'dist',
'.eslintignore',
'*.html',
'*.svg',
'*.css',
'public',
'*.json',
'*.d.ts',
Comment on lines +15 to +20

@coderabbitai coderabbitai Bot Apr 23, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: List nested asset/config files under the recognize E2E app that root-only ignore globs do not cover.
python - <<'PY'
from pathlib import Path

root = Path("e2e/recognize-app")
suffixes = (".html", ".svg", ".css", ".json", ".d.ts")

for path in root.rglob("*"):
    if path.is_file() and path.name.endswith(suffixes):
        rel = path.relative_to(root).as_posix()
        if "/" in rel:
            print(rel)
PY

Repository: ForgeRock/ping-javascript-sdk

Length of output: 102

🏁 Script executed:

cd e2e/recognize-app && head -25 eslint.config.mjs

Repository: ForgeRock/ping-javascript-sdk

Length of output: 438

🏁 Script executed:

# Check if there are other nested files beyond what was already found
find e2e/recognize-app -type f \( -name "*.html" -o -name "*.svg" -o -name "*.css" -o -name "*.json" -o -name "*.d.ts" \) | head -20

Repository: ForgeRock/ping-javascript-sdk

Length of output: 237

🌐 Web query:

ESLint flat config ignore patterns glob semantics documentation

💡 Result:

In ESLint flat config (eslint.config.js, default since v9), ignore patterns use minimatch glob syntax. They are specified in the ignores array within config objects. Global ignores (applied project-wide, skipping file traversal): Use a standalone object with only ignores or the globalIgnores helper from eslint/config. Example: import { globalIgnores } from "eslint/config"; export default [ globalIgnores(["/node_modules/", "dist/", ".git/"]), // other configs ]; Local ignores (apply only to that config object): Use ignores alongside files, rules, etc. Example: { files: ["/.js"], ignores: ["/.config.js"], rules: { /* ... / } } Glob semantics (minimatch): - recurses directories (e.g., /node_modules/ ignores all node_modules). - * matches non-/ chars. - ? single non-/ char. - dir/ matches only that dir (relative to config file location). - dir/ ignores dir + contents (no unignore inside). - dir// ignores contents but allows unignoring specific files. - !pattern negates (unignores). - Patterns ending / match dirs; others match files/dirs. - Defaults: ["/node_modules/", ".git/"]. - Resolution: Relative to eslint.config.js for globalIgnores; cwd for CLI --ignore-pattern. Unlike .eslintignore (gitignore-style), flat config uses strict minimatch (e.g., dist ignores only top-level dist, use /dist/ for recursive). Primary source: Official ESLint docs (https://eslint.org/docs/latest/use/configure/ignore).

Citations:

Make asset ignore globs recursive.

Patterns like *.html and *.css match only root-level files in ESLint's flat config (using strict minimatch). Nested files such as src/index.html and src/styles.css will not be ignored, allowing the linter to process them despite being asset files.

🛠️ Proposed fix 
-      '*.html',
-      '*.svg',
-      '*.css',
+      '**/*.html',
+      '**/*.svg',
+      '**/*.css',
       'public',
-      '*.json',
-      '*.d.ts',
+      '**/*.json',
+      '**/*.d.ts',
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
'*.html',
'*.svg',
'*.css',
'public',
'*.json',
'*.d.ts',
'**/*.html',
'**/*.svg',
'**/*.css',
'public',
'**/*.json',
'**/*.d.ts',
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@e2e/recognize-app/eslint.config.mjs` around lines 15 - 20, The glob ignore
patterns in eslint.config.mjs (entries like '*.html', '*.svg', '*.css',
'*.json', '*.d.ts') are non-recursive and only match root-level files; update
each asset pattern to be recursive (e.g., change '*.html' -> '**/*.html',
'*.css' -> '**/*.css', '*.svg' -> '**/*.svg', '*.json' -> '**/*.json', '*.d.ts'
-> '**/*.d.ts') so nested assets (like src/index.html or src/styles/site.css)
are ignored by ESLint; modify the array of ignore globs in the file accordingly
to use the double-star recursive form for all asset patterns.

],
},
...baseConfig,
];
18 changes: 18 additions & 0 deletions e2e/recognize-app/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"name": "@forgerock/recognize-app",
"version": "0.0.1",
"private": true,
"scripts": {
"build": "pnpm nx nxBuild",
"lint": "pnpm nx nxLint",
"preview": "pnpm nx nxPreview",
"serve": "pnpm nx nxServe"
},
"dependencies": {
"@forgerock/journey-client": "workspace:*",
"@forgerock/recognize": "workspace:*"
},
"nx": {
"tags": ["scope:e2e"]
}
}
14 changes: 14 additions & 0 deletions e2e/recognize-app/src/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Recognize E2E Test Index | Ping Identity JavaScript SDK</title>
</head>
<body>
<div id="app">
<h2>Recognize E2E Test Index | Ping Identity JavaScript SDK</h2>
</div>
<script type="module" src="index.ts"></script>
</body>
</html>
36 changes: 36 additions & 0 deletions e2e/recognize-app/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
import './styles.css';
import { recognize } from '@forgerock/recognize';

const client = recognize({
customer: 'CUSTOMER_NAME',
key: 'IMAGE_ENCRYPTION_PUBLIC_KEY',
keyID: 'IMAGE_ENCRYPTION_KEY_ID',
wsURL: 'KEYLESS_AUTHENTICATION_SERVICE_URL',
transactionData: 'DATA_FROM_CUSTOMER_SERVER_TO_BE_SIGNED',
});

client.subscribe({
next: (event) => {
console.log('[recognize]', event.type, event.detail);
},
error: (err) => {
console.error('[recognize] error', {
code: err.code,
message: err.message,
name: err.name,
cause: err.cause,
});
},
complete: (detail) => {
console.log('[recognize] complete', detail);
},
});

const appEl = document.getElementById('app');
if (appEl) {
client
.init({ mode: 'mount', container: appEl, type: 'auth', username: 'USERNAME' })
.then((err) => {
if (err) console.error('[recognize] init error', err);
});
}
11 changes: 11 additions & 0 deletions e2e/recognize-app/src/styles.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
body {
font-family:
-apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, sans-serif;
margin: 0;
padding: 2rem;
}

#app {
max-width: 960px;
margin: 0 auto;
}
29 changes: 29 additions & 0 deletions e2e/recognize-app/tsconfig.app.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"outDir": "dist",
"types": ["node"],
"rootDir": "src",
"module": "esnext",
"moduleResolution": "bundler",
"tsBuildInfoFile": "dist/tsconfig.app.tsbuildinfo"
},
"exclude": [
"out-tsc",
"dist",
"src/**/*.spec.ts",
"src/**/*.test.ts",
"eslint.config.js",
"eslint.config.cjs",
"eslint.config.mjs"
],
"include": ["src/**/*.ts"],
"references": [
{
"path": "../../packages/recognize/tsconfig.lib.json"
},
{
"path": "../../packages/journey-client/tsconfig.lib.json"
}
]
}
10 changes: 10 additions & 0 deletions e2e/recognize-app/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"extends": "../../tsconfig.base.json",
"files": [],
"include": [],
"references": [
{
"path": "./tsconfig.app.json"
}
]
}
33 changes: 33 additions & 0 deletions e2e/recognize-app/vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import { defineConfig } from 'vite';
import { dirname, resolve } from 'path';
import { fileURLToPath } from 'url';

const __dirname = dirname(fileURLToPath(import.meta.url));

export default defineConfig(() => ({
root: __dirname + '/src',
cacheDir: '../../node_modules/.vite/e2e/recognize-app',
publicDir: __dirname + '/public',
Comment on lines +8 to +10

@coderabbitai coderabbitai Bot Apr 23, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Point publicDir at the Vite root’s public folder.

With root set to src, Line 10 currently serves e2e/recognize-app/public, not e2e/recognize-app/src/public. If the app’s static assets are under src/public, they won’t be copied or served.

🛠️ Proposed fix 
-  publicDir: __dirname + '/public',
+  publicDir: resolve(__dirname, 'src/public'),
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@e2e/recognize-app/vite.config.ts` around lines 8 - 10, The Vite config sets
root to src but publicDir points to __dirname + '/public', so static assets
under the Vite root (src/public) won't be served; update publicDir to reference
the Vite root's public folder (e.g., derive it from the configured root or point
it to src/public) so that with root = __dirname + '/src' the publicDir resolves
to the corresponding public directory; adjust the publicDir setting in
vite.config.ts accordingly (referencing the root/public relationship rather than
the project root).

server: {
port: 8443,
host: 'localhost',
},
preview: {
port: 8443,
host: 'localhost',
},
plugins: [],
build: {
outDir: __dirname + '/dist',
emptyOutDir: true,
reportCompressedSize: true,
rollupOptions: {
input: {
main: resolve(__dirname + '/src', 'index.html'),
},
output: {
entryFileNames: '[name]/main.js',
},
},
},
}));
11 changes: 11 additions & 0 deletions packages/recognize/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# recognize

This library was generated with [Nx](https://nx.dev).

## Building

Run `nx build recognize` to build the library.

## Running unit tests

Run `nx test recognize` to execute the unit tests via [Vitest](https://vitest.dev/).
25 changes: 25 additions & 0 deletions packages/recognize/eslint.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import baseConfig from '../../eslint.config.mjs';

export default [
...baseConfig,
{
files: ['**/*.json'],
rules: {
'@nx/dependency-checks': [
'error',
{
ignoredFiles: [
'{projectRoot}/eslint.config.{js,cjs,mjs,ts,cts,mts}',
'{projectRoot}/vite.config.{js,ts,mjs,mts}',
],
},
],
},
languageOptions: {
parser: await import('jsonc-eslint-parser'),
},
},
{
ignores: ['**/out-tsc'],
},
];
45 changes: 45 additions & 0 deletions packages/recognize/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
{
"name": "@forgerock/recognize",
"version": "0.0.1",
"private": true,
"type": "module",
"exports": {
".": {
"types": "./dist/src/index.d.ts",
"import": "./dist/src/index.js",
"default": "./dist/src/index.js"
},
"./package.json": "./package.json"
},
"main": "./dist/src/index.js",
"module": "./dist/src/index.js",
"types": "./dist/src/index.d.ts",
"dependencies": {
"tslib": "^2.3.0"
},
"devDependencies": {
"@aracna/web-components": "^1.1.18"
},
"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"
}
]
}
}
}
}
}
18 changes: 18 additions & 0 deletions packages/recognize/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
export { recognize } from './lib/recognize.js';
export { RecognizeErrorCode } from './lib/defs/recognize-error-code.js';
export type { RecognizeError } from './lib/recognize.types.js';
export type {
RecognizeSessionType,
RecognizeWcClient,
RecognizeWcCompleteDetail,
RecognizeWcConfig,
RecognizeWcEvent,
RecognizeWcFrameResultsEventDetail,
RecognizeWcInitOptions,
RecognizeWcObserver,
RecognizeWcStepChangeEventDetail,
RecognizeWcUnsubscribe,
RecognizeWcVideoFrameQualityEventDetail,
RecognizeWcWebSocketCloseEventDetail,
RecognizeWcWebSocketOpenEventDetail,
} from './lib/recognize.types.js';
14 changes: 14 additions & 0 deletions packages/recognize/src/lib/classes/recognize-error.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import type { RecognizeErrorCode } from '../defs/recognize-error-code.js';

/** @public */
export class RecognizeError extends Error {
code: RecognizeErrorCode;

constructor(code: RecognizeErrorCode, cause?: Error) {
super(code);

this.code = code;
this.cause = cause;
this.name = 'RecognizeError';
}
}
11 changes: 11 additions & 0 deletions packages/recognize/src/lib/defs/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/** @internal */
export const CAMERA_ONLY_DISABLE_STEPS: string[] = [
'bootstrap',
'camera-instructions',
'done',
'error',
'microphone-permission',
'server-computation',
'stm-choice',
'stm-qrcode',
];
55 changes: 55 additions & 0 deletions packages/recognize/src/lib/defs/recognize-error-code.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
/*
*
* 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.
*
*/

/** @public */
export enum RecognizeErrorCode {
SDK_ERROR = 'SDK_ERROR',
SDK_NOT_CONFIGURED = 'SDK_NOT_CONFIGURED',
SDK_CONFIGURATION_FAILED = 'SDK_CONFIGURATION_FAILED',
SDK_LOGGING_NOT_CONFIGURED = 'SDK_LOGGING_NOT_CONFIGURED',
SDK_LOGGING_CONFIGURATION_FAILED = 'SDK_LOGGING_CONFIGURATION_FAILED',
SDK_STORAGE_ERROR = 'SDK_STORAGE_ERROR',
SDK_USER_CANCELLED = 'SDK_USER_CANCELLED',
SDK_NO_NETWORK_CONNECTION = 'SDK_NO_NETWORK_CONNECTION',
SDK_DYNAMIC_LINKING_MALFORMED_PAYLOAD = 'SDK_DYNAMIC_LINKING_MALFORMED_PAYLOAD',
SDK_ARTIFACT_RETRIEVE_FAILED = 'SDK_ARTIFACT_RETRIEVE_FAILED',
SDK_ARTIFACT_RETRIEVE_FROM_CLIENT_STATE_FAILED = 'SDK_ARTIFACT_RETRIEVE_FROM_CLIENT_STATE_FAILED',
SDK_WEB_SOCKET_ERROR = 'SDK_WEB_SOCKET_ERROR',
SDK_TIMEOUT = 'SDK_TIMEOUT',
SDK_WEB_ASSEMBLY_IMPORT_FAILED = 'SDK_WEB_ASSEMBLY_IMPORT_FAILED',
SDK_WEB_ASSEMBLY_IMPORT_NOT_FULFILLED = 'SDK_WEB_ASSEMBLY_IMPORT_NOT_FULFILLED',
SDK_WEB_ASSEMBLY_ERROR = 'SDK_WEB_ASSEMBLY_ERROR',
CAMERA_ERROR = 'CAMERA_ERROR',
CAMERA_MISSING = 'CAMERA_MISSING',
CAMERA_PERMISSION_DENIED = 'CAMERA_PERMISSION_DENIED',
CAMERA_NOT_SUPPORTED = 'CAMERA_NOT_SUPPORTED',
CORE_ERROR = 'CORE_ERROR',
CORE_CUSTOMER_NOT_FOUND = 'CORE_CUSTOMER_NOT_FOUND',
CORE_INVALID_API_KEY = 'CORE_INVALID_API_KEY',
CORE_NOT_ENOUGH_API_KEY_SEATS = 'CORE_NOT_ENOUGH_API_KEY_SEATS',
CORE_USER_NOT_ENROLLED = 'CORE_USER_NOT_ENROLLED',
CORE_USER_ALREADY_ENROLLED = 'CORE_USER_ALREADY_ENROLLED',
CORE_NOT_ENOUGH_CIRCUITS = 'CORE_NOT_ENOUGH_CIRCUITS',
CORE_USER_LOCKED_OUT = 'CORE_USER_LOCKED_OUT',
CORE_FACE_NOT_MATCHING = 'CORE_FACE_NOT_MATCHING',
CORE_SECRET_NOT_FOUND = 'CORE_SECRET_NOT_FOUND',
BIOM_ERROR = 'BIOM_ERROR',
BIOM_REJECTED = 'BIOM_REJECTED',
BIOM_SPOOFING = 'BIOM_SPOOFING',
BIOM_DEVICE_ENVIRONMENT_AWARE_NOT_SUPPORTED = 'BIOM_DEVICE_ENVIRONMENT_AWARE_NOT_SUPPORTED',
BIOM_LIVENESS_ENVIRONMENT_AWARE_NOT_SUPPORTED = 'BIOM_LIVENESS_ENVIRONMENT_AWARE_NOT_SUPPORTED',
SERVER_ERROR = 'SERVER_ERROR',
SERVER_AUTHORIZATION_FAILED = 'SERVER_AUTHORIZATION_FAILED',
SERVER_ENCRYPTION_FAILED = 'SERVER_ENCRYPTION_FAILED',
SERVER_RECOGNITION_FAILED = 'SERVER_RECOGNITION_FAILED',
SERVER_TIMEOUT = 'SERVER_TIMEOUT',
SECURITY_ERROR = 'SECURITY_ERROR',
SECURITY_APPLICATION_EXPIRED = 'SECURITY_APPLICATION_EXPIRED',
SECURITY_DEVICE_NOT_GENUINE = 'SECURITY_DEVICE_NOT_GENUINE',
}
Loading
Loading