@incodetech/core 2.4.0 → 2.4.1-agentic.1

package/dist/session.d.ts

@@ -1,10 +1,14 @@
-import { t as DeviceFingerprintResult } from "./types-CK8Jbjkp.js";
+import "./warmup-BO57syF6.js";
+import { t as DeviceFingerprintResult } from "./types-Csh8vzPo.js";
 import { n as FinishStatus, r as GetFinishStatusFn, s as getFinishStatus } from "./flowCompletionService-BlAHsKyv.js";
 //#region src/internal/session/sessionService.d.ts
 type CreateSessionOptions = {
   /** The configuration/flow ID from the Incode dashboard */
   configurationId: string;
-  /** External ID to associate with this session */
+  /**
+   * External ID to associate with this session.
+   * @deprecated
+   */
   externalId?: string;
   /** External customer ID */
   externalCustomerId?: string;
@@ -12,15 +16,28 @@ type CreateSessionOptions = {
   language?: string;
   /** Custom fields to attach to the session */
   customFields?: Record<string, unknown>;
-  /** UUID for continuing an existing session */
+  /**
+   * Onboarding-link UUID (the `uuid` of a desktop→mobile handoff link). When
+   * set, the session is continued through `POST /omni/session/continue`
+   * instead of started, and only `uuid` and `urlUuid` are sent.
+   */
   uuid?: string;
   /** QR anti-phishing token for continuing a phishing-resistant session from a mobile link */
   urlUuid?: string;
-  /** Interview ID for continuing an existing interview */
+  /**
+   * Interview ID for continuing an existing interview.
+   * @deprecated
+   */
   interviewId?: string;
   /** Hint forwarded to POST /omni/start as `loginHint` (e.g. from `auth_hint` URL param for identity search). */
   loginHint?: string;
 };
+type ContinueSessionOptions = {
+  /** Onboarding-link UUID: the `uuid` of a desktop→mobile handoff link. */
+  uuid: string;
+  /** QR anti-phishing token from the link, already rotated by {@link refreshQrUrlUuid}. */
+  urlUuid?: string;
+};
 type Session = {
   token: string;
   interviewId: string;
@@ -49,6 +66,18 @@ declare const QR_VALIDATION_ERROR_CODES: {
   readonly onboardingUrlAlreadyUsed: 4083;
 };
 type QrValidationErrorCode = (typeof QR_VALIDATION_ERROR_CODES)[keyof typeof QR_VALIDATION_ERROR_CODES];
+/**
+ * Incode status codes `POST /omni/session/continue` rejects a handoff link
+ * with (as `IncodeApiError.status`). Trying again does not help: the same link
+ * fails the same way.
+ */
+declare const SESSION_CONTINUE_ERROR_CODES: {
+  readonly invalidUuid: 4026;
+  readonly invalidQrValidation: 4081;
+  readonly continuationPeriodExpired: 4086;
+  readonly continuationLimitReached: 4087;
+  readonly sessionNotActive: 4088;
+};
 type RefreshQrUrlUuidOptions = {
   /** QR anti-phishing token from the incoming URL. When empty/undefined, the call is a no-op. */
   urlUuid?: string;
@@ -68,7 +97,14 @@ declare class QrValidationError extends Error {
   constructor(status: number, statusText: string);
 }
 /**
- * Creates a new onboarding session.
+ * Creates a new onboarding session, or continues an existing one when
+ * `options.uuid` is set (see {@link CreateSessionOptions.uuid}).
+ *
+ * The server allows a limited number of continues (a server setting, two by
+ * default), within 48 hours of the session start. Each successful call with a
+ * `uuid` spends one, a reload of the handoff link included. A refused continue
+ * throws an `IncodeApiError` whose `status` is one of
+ * {@link SESSION_CONTINUE_ERROR_CODES}.
  *
  * @param apiKey - The API key from the Incode dashboard
  * @param options - Session creation options
@@ -85,6 +121,21 @@ declare class QrValidationError extends Error {
  * ```
  */
 declare function createSession(apiKey: string, options: CreateSessionOptions, signal?: AbortSignal): Promise<Session>;
+/**
+ * Continues the session behind a desktop→mobile handoff link through
+ * `POST /omni/session/continue`. Only `uuid` and `urlUuid` are sent, and the
+ * response `sessionId` is returned as `interviewId`. `createSession` and
+ * `bootstrapSession` call it when `uuid` is set.
+ *
+ * Each successful call spends one continue. A refused continue throws an
+ * `IncodeApiError` whose `status` is one of {@link SESSION_CONTINUE_ERROR_CODES}.
+ *
+ * @param apiKey - The API key from the Incode dashboard
+ * @param options - The handoff link's `uuid` and `urlUuid`
+ * @param signal - Optional AbortSignal for request cancellation
+ * @returns The continued session with token
+ */
+declare function continueSession(apiKey: string, options: ContinueSessionOptions, signal?: AbortSignal): Promise<Session>;
 /**
  * Validates and rotates a QR anti-phishing URL UUID before creating a session.
  *
@@ -115,8 +166,8 @@ declare function validateQrUuid(options: ValidateQrUuidOptions, signal?: AbortSi
 declare function refreshQrUrlUuid(options: RefreshQrUrlUuidOptions, signal?: AbortSignal): Promise<string | undefined>;
 /**
  * Validates and rotates a QR anti-phishing `urlUuid` (when present), then
- * creates a session bound to the refreshed value. When `urlUuid` is absent,
- * behaves identically to {@link createSession}.
+ * creates (or, with `uuid`, continues) a session bound to the refreshed value.
+ * When `urlUuid` is absent, behaves identically to {@link createSession}.
  *
  * Use this when the host owns session creation and wants the SDK to handle
  * phishing-resistance rotation in a single call. For raw control, compose
@@ -178,7 +229,17 @@ type FeatureName = 'VIDEO_SELFIE_V2' | 'USE_CLIENT_GLARE' | 'USE_OPEN_VIDU' | 'D
  * unresolvable config all proceed (fail-open; the proxy's
  * `truesight.api.enabled` is the environment authority).
  */
-'TRUESIGHT_DIAGNOSTICS';
+'TRUESIGHT_DIAGNOSTICS' |
+/**
+ * Deepsight 2.0 capture metadata (ENG-61789). `enabled: true` makes the WASM
+ * emit the v2 capture-metadata document (ml-wasm-kit `smv(true)`); absent,
+ * `false` or an unresolvable config keep the v1 document (fail-closed). Read
+ * once per session in `sessionInitializer.ts` and latched on the WASM runtime,
+ * which replays it after every re-initialization. Delivered by provisioning;
+ * the key name is the SDK's assumption pending confirmation from the
+ * provisioning owners.
+ */
+'DEEPSIGHT_V2';
 type FeatureConfig = {
   enabled: boolean;
   feature: FeatureName;
@@ -219,12 +280,19 @@ type SessionInitOptions = {
   preloadFlow?: boolean;
   /**
    * `false` resolves as soon as the feature config is in, leaving the device
-   * fingerprint (thumbmark + IP lookup + submit) to finish in the background;
+   * fingerprint (IP lookup + submit) to finish in the background;
    * `fingerprintSuccess`/`fingerprintResult` on the result are then not yet
    * known — read them via `whenSessionFingerprintSettled()`. Default `true`
    * keeps the historical contract: the promise settles after the fingerprint.
    */
   awaitFingerprint?: boolean;
+  /**
+   * `false` loads no WASM runtime during activation, so the device
+   * fingerprint post goes out without waiting for a device hash and carries
+   * none. Without it, activation loads the runtime when a WASM config is
+   * known and `setup({ wasm: false })` wasn't called.
+   */
+  wasm?: false;
 };
 type SessionInitResult = {
   features: Features;
@@ -273,4 +341,22 @@ declare class SessionExpiredError extends Error {
 /** One notification per subscription. Unsubscribe when its owner unmounts. */
 declare function onSessionExpired(listener: (error: SessionExpiredError) => void): () => void;
 //#endregion
-export { type BootstrapSessionOptions, type CreateSessionOptions, type DeviceFingerprintResult, type FinishStatus, type GetFinishStatusFn, IncodeApiError, QR_VALIDATION_ERROR_CODES, QrValidationError, type QrValidationErrorCode, type QrValidationResult, type RefreshQrUrlUuidOptions, type Session, SessionExpiredError, type SessionInitOptions, type SessionInitResult, type ValidateQrUuidOptions, bootstrapSession, createSession, getFinishStatus, initializeSession, onSessionExpired, refreshQrUrlUuid, validateQrUuid, whenSessionFingerprintSettled };
+//#region src/internal/session/connectivity.d.ts
+/**
+ * Subscribes to connectivity loss and recovery. The listener receives `true`
+ * when the browser goes offline (or a request fails while it reports offline,
+ * before the `offline` event arrives), and
+ * `false` 1.5 s after the browser reports `online` (or on
+ * {@link resumeConnectivity}). Fires `true` at once if connectivity is already
+ * lost. Returns an unsubscribe function.
+ */
+declare function onConnectivityChange(listener: (lost: boolean) => void): () => void;
+/** True while connectivity is lost. Starts the store, like a subscribe. */
+declare function isConnectivityLost(): boolean;
+/**
+ * Ends the lost state at once, without the settle wait. Returns `false` and
+ * does nothing while the browser still reports offline.
+ */
+declare function resumeConnectivity(): boolean;
+//#endregion
+export { type BootstrapSessionOptions, type ContinueSessionOptions, type CreateSessionOptions, type DeviceFingerprintResult, type FinishStatus, type GetFinishStatusFn, IncodeApiError, QR_VALIDATION_ERROR_CODES, QrValidationError, type QrValidationErrorCode, type QrValidationResult, type RefreshQrUrlUuidOptions, SESSION_CONTINUE_ERROR_CODES, type Session, SessionExpiredError, type SessionInitOptions, type SessionInitResult, type ValidateQrUuidOptions, bootstrapSession, continueSession, createSession, getFinishStatus, initializeSession, isConnectivityLost, onConnectivityChange, onSessionExpired, refreshQrUrlUuid, resumeConnectivity, validateQrUuid, whenSessionFingerprintSettled };

package/dist/session.esm.js

@@ -1,9 +1,10 @@
-import { r as getToken } from "./api-Cz90EHyu.esm.js";
+import { r as getToken } from "./api-CpP4PS4S.esm.js";
 import { r as subscribeHttpErrors } from "./HttpRequestError-Bh0pNGSC.esm.js";
-import { i as initializeSession, l as whenSessionFingerprintSettled } from "./sessionInitializer-BTjYgE-V.esm.js";
-import { t as IncodeApiError } from "./apiError-DPwFas2f.esm.js";
-import { a as refreshQrUrlUuid, i as createSession, n as QrValidationError, o as validateQrUuid, r as bootstrapSession, t as QR_VALIDATION_ERROR_CODES } from "./session-CpwfoVdH.esm.js";
-import { n as getFinishStatus } from "./flowCompletionService-BDI5QpfR.esm.js";
+import { a as initializeSession, f as whenSessionFingerprintSettled } from "./sessionInitializer-DsL7X2j9.esm.js";
+import { n as onConnectivityChange, r as resumeConnectivity, t as isConnectivityLost } from "./connectivity-BCuEoQ-n.esm.js";
+import { t as IncodeApiError } from "./apiError-DH-CH4Nz.esm.js";
+import { a as continueSession, c as validateQrUuid, i as bootstrapSession, n as QrValidationError, o as createSession, r as SESSION_CONTINUE_ERROR_CODES, s as refreshQrUrlUuid, t as QR_VALIDATION_ERROR_CODES } from "./session-CdSX4wsZ.esm.js";
+import { n as getFinishStatus } from "./flowCompletionService-CcCnPs_T.esm.js";
 //#region src/internal/session/sessionExpired.ts
 var SessionExpiredError = class extends Error {
 	constructor() {
@@ -27,4 +28,4 @@ function onSessionExpired(listener) {
 	return unsubscribe;
 }
 //#endregion
-export { IncodeApiError, QR_VALIDATION_ERROR_CODES, QrValidationError, SessionExpiredError, bootstrapSession, createSession, getFinishStatus, initializeSession, onSessionExpired, refreshQrUrlUuid, validateQrUuid, whenSessionFingerprintSettled };
+export { IncodeApiError, QR_VALIDATION_ERROR_CODES, QrValidationError, SESSION_CONTINUE_ERROR_CODES, SessionExpiredError, bootstrapSession, continueSession, createSession, getFinishStatus, initializeSession, isConnectivityLost, onConnectivityChange, onSessionExpired, refreshQrUrlUuid, resumeConnectivity, validateQrUuid, whenSessionFingerprintSettled };