@prove-identity/prove-auth 2.15.2 → 3.1.0

package/build/lib/index.js

@@ -15,24 +15,35 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InstantLinkResultType = exports.BuildConfig = exports.PhoneValidationError = exports.OtpError = exports.OtpFinishResultType = exports.MobileAuthImplementation = exports.LogLevel = exports.LoggerFactory = exports.DeviceRole = exports.CancelablePromise = exports.AuthResponseStatus = exports.AuthenticatorBuilder = exports.VERSION = void 0;
+exports.InstantLinkResultType = exports.BuildConfig = exports.PhoneValidationError = exports.OtpError = exports.OtpFinishResultType = exports.MobileAuthImplementation = exports.LogLevel = exports.LoggerFactory = exports.DeviceRole = exports.CancelablePromise = exports.AuthResponseStatus = exports.DeviceContextIntegration = exports.PpbIntegration = exports.AuthenticatorBuilder = exports.VERSION = void 0;
 const version_1 = require("./proveauth/version");
 Object.defineProperty(exports, "VERSION", { enumerable: true, get: function () { return version_1.VERSION; } });
 const authenticator_builder_1 = __importStar(require("./proveauth/authenticator-builder"));
 exports.AuthenticatorBuilder = authenticator_builder_1.default;
-Object.defineProperty(exports, "DeviceRole", { enumerable: true, get: function () { return authenticator_builder_1.DeviceRole; } });
 Object.defineProperty(exports, "MobileAuthImplementation", { enumerable: true, get: function () { return authenticator_builder_1.MobileAuthImplementation; } });
+const device_role_1 = require("./proveauth/device-role");
+Object.defineProperty(exports, "DeviceRole", { enumerable: true, get: function () { return device_role_1.DeviceRole; } });
 const device_context_options_1 = require("./proveauth/device-context-options");
 Object.defineProperty(exports, "BuildConfig", { enumerable: true, get: function () { return device_context_options_1.BuildConfig; } });
 const auth_response_status_1 = require("./proveauth/internal/auth-response-status");
@@ -49,3 +60,6 @@ Object.defineProperty(exports, "OtpError", { enumerable: true, get: function ()
 Object.defineProperty(exports, "OtpFinishResultType", { enumerable: true, get: function () { return otp_1.OtpFinishResultType; } });
 const instantlink_1 = require("./proveauth/instantlink");
 Object.defineProperty(exports, "InstantLinkResultType", { enumerable: true, get: function () { return instantlink_1.InstantLinkResultType; } });
+const external_integrations_1 = require("./proveauth/internal/external-integrations");
+Object.defineProperty(exports, "PpbIntegration", { enumerable: true, get: function () { return external_integrations_1.PpbIntegration; } });
+Object.defineProperty(exports, "DeviceContextIntegration", { enumerable: true, get: function () { return external_integrations_1.DeviceContextIntegration; } });

package/build/lib/proveauth/authenticator-builder.d.ts

@@ -5,16 +5,13 @@ import { AuthResponseStatus } from './internal/auth-response-status';
 import Platform from './internal/platform';
 import { OtpFinishStep, OtpFinishStepFn, OtpStartStep, OtpStartStepFn } from './otp';
 import { InstantLinkRetryStep, InstantLinkRetryStepFn, InstantLinkStartStep, InstantLinkStartStepFn } from './instantlink';
-import type { Region } from '@fingerprintjs/fingerprintjs-pro';
-import DeviceContextOptions, { BuildConfig } from './device-context-options';
+import DeviceContextOptions from './device-context-options';
 import UserConsentStep, { UserConsentStepFn } from './user-consent-step';
 import { PpbFinishStep, PpbFinishStepFn, PpbStartStep, PpbStartStepFn } from './ppb';
+import { DocVFinishStep, DocVFinishStepFn, DocVStartStep, DocVStartStepFn } from './docv';
+import { DeviceRole } from './device-role';
 export type AuthMessageHandler = (message: AuthMessage) => Promise<AuthResponseStatus>;
 export type PasskeyAlreadyExistCallback = () => Promise<AuthResponseStatus>;
-export declare enum DeviceRole {
-    Primary = 0,
-    Secondary = 1
-}
 export declare enum MobileAuthImplementation {
     Pixel = "pixel",
     Fetch = "fetch"
@@ -38,8 +35,11 @@ export default class AuthenticatorBuilder {
     private ppbEnabled;
     private ppbStartStep?;
     private ppbFinishStep?;
-    private readonly log;
+    private docvEnabled;
+    private docvStartStep?;
+    private docvFinishStep?;
     private deviceContextOptions?;
+    private readonly log;
     constructor();
     withDeviceContext(options: DeviceContextOptions): AuthenticatorBuilder;
     withAuthFinishStep(step: AuthFinishStep | AuthFinishStepFn): AuthenticatorBuilder;
@@ -52,12 +52,10 @@ export default class AuthenticatorBuilder {
     withDeviceIpAddress(deviceIp: string | (() => string | null) | null): AuthenticatorBuilder;
     withOtpFallback(startStep: OtpStartStep | OtpStartStepFn, finishStep: OtpFinishStep | OtpFinishStepFn): AuthenticatorBuilder;
     withInstantLinkFallback(startStep: InstantLinkStartStep | InstantLinkStartStepFn, retryStep?: InstantLinkRetryStep | InstantLinkRetryStepFn): AuthenticatorBuilder;
-    withUPKEnabled(): this;
     withUniversalProveKey(step?: UserConsentStep | UserConsentStepFn): this;
     withPrivacyPreservingBiometrics(startStep?: PpbStartStep | PpbStartStepFn, finishStep?: PpbFinishStep | PpbFinishStepFn): this;
-    getUrlsByBuildConfig(buildConfig?: BuildConfig): [string | undefined, string | undefined];
-    getRegionByBuildConfig(buildConfig?: BuildConfig): Region;
-    private getFpPromiseInstanceFromOptions;
+    withDocumentVerification(startStep: DocVStartStep | DocVStartStepFn, finishStep?: DocVFinishStep | DocVFinishStepFn): this;
     withPasskeyAlreadyExistCallback(handler: PasskeyAlreadyExistCallback): AuthenticatorBuilder;
     build(): Authenticator;
+    private getAuthSteps;
 }

package/build/lib/proveauth/authenticator-builder.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MobileAuthImplementation = exports.DeviceRole = void 0;
+exports.MobileAuthImplementation = void 0;
 const web_platform_1 = require("./internal/web-platform");
 const device_passive_register_step_1 = __importDefault(require("./internal/device-passive-register-step"));
 const device_passive_step_1 = __importDefault(require("./internal/device-passive-step"));
@@ -20,24 +20,21 @@ const device_universal_redirect_steps_1 = require("./internal/device-universal-r
 const main_authenticator_1 = __importDefault(require("./internal/main-authenticator"));
 const logger_1 = require("./common/logger");
 const settings_1 = __importDefault(require("./internal/settings"));
-const device_context_options_1 = require("./device-context-options");
 const user_ppb_steps_1 = require("./internal/user-ppb-steps");
-var DeviceRole;
-(function (DeviceRole) {
-    DeviceRole[DeviceRole["Primary"] = 0] = "Primary";
-    DeviceRole[DeviceRole["Secondary"] = 1] = "Secondary";
-})(DeviceRole = exports.DeviceRole || (exports.DeviceRole = {}));
+const user_docv_steps_1 = require("./internal/user-docv-steps");
+const device_role_1 = require("./device-role");
 var MobileAuthImplementation;
 (function (MobileAuthImplementation) {
     MobileAuthImplementation["Pixel"] = "pixel";
     MobileAuthImplementation["Fetch"] = "fetch";
-})(MobileAuthImplementation = exports.MobileAuthImplementation || (exports.MobileAuthImplementation = {}));
+})(MobileAuthImplementation || (exports.MobileAuthImplementation = MobileAuthImplementation = {}));
 class AuthenticatorBuilder {
     constructor() {
-        this.role = DeviceRole.Primary;
+        this.role = device_role_1.DeviceRole.Primary;
         this.mobileAuthImplementation = MobileAuthImplementation.Fetch;
         this.upkEnabled = false;
         this.ppbEnabled = false;
+        this.docvEnabled = false;
         this.log = logger_1.LoggerFactory.getLogger('authenticator-builder');
         if (typeof window !== 'undefined') {
             this.storage = window.localStorage;
@@ -117,9 +114,6 @@ class AuthenticatorBuilder {
         }
         return this;
     }
-    withUPKEnabled() {
-        return this.withUniversalProveKey();
-    }
     withUniversalProveKey(step) {
         if (!step) {
             this.userConsentStep = { execute: () => Promise.resolve({ consentGranted: true }) };
@@ -149,127 +143,73 @@ class AuthenticatorBuilder {
         }
         return this;
     }
-    getUrlsByBuildConfig(buildConfig) {
-        switch (buildConfig) {
-            case device_context_options_1.BuildConfig.US_PROD:
-                return [
-                    device_context_options_1.ProveAuthProxyScriptUrl.DEFAULT_US_PROD_SCRIPT_URL.toString(),
-                    device_context_options_1.ProveAuthProxyEndpoint.DEFAULT_US_PROD_ENDPOINT.toString(),
-                ];
-            case device_context_options_1.BuildConfig.US_UAT:
-                return [
-                    device_context_options_1.ProveAuthProxyScriptUrl.DEFAULT_US_UAT_SCRIPT_URL.toString(),
-                    device_context_options_1.ProveAuthProxyEndpoint.DEFAULT_US_UAT_ENDPOINT.toString(),
-                ];
-            case device_context_options_1.BuildConfig.DEV:
-                this.log.debug("Recommended for Prove's internal testing only, BuildConfig.DEV " +
-                    'might need custom endpoint URL and custom script URL values to bypass ad blockers');
-                return [undefined, undefined];
-            default:
-                this.log.warn('Unknown BuildConfig value: ' + buildConfig);
-                return [undefined, undefined];
+    withDocumentVerification(startStep, finishStep) {
+        this.docvEnabled = true;
+        if (typeof startStep === 'function') {
+            this.docvStartStep = { execute: startStep };
         }
-    }
-    getRegionByBuildConfig(buildConfig) {
-        var region;
-        switch (buildConfig) {
-            case device_context_options_1.BuildConfig.DEV:
-            case device_context_options_1.BuildConfig.US_PROD:
-            case device_context_options_1.BuildConfig.US_UAT:
-                region = 'us';
-                break;
-            default:
-                this.log.warn('Unknown BuildConfig value, set Region to default value: us');
-                region = 'us';
-                break;
+        else {
+            this.docvStartStep = startStep;
         }
-        return region;
-    }
-    getFpPromiseInstanceFromOptions(options) {
-        try {
-            const FingerprintJS = require('@fingerprintjs/fingerprintjs-pro');
-            if (!FingerprintJS) {
-                this.log.debug('fingerprintjs package is not installed or failed to load');
-            }
-            else if (!options) {
-                this.log.warn('Prove Key Persistence feature is not enabled');
-            }
-            else {
-                let region = this.getRegionByBuildConfig(options.buildConfig);
-                let [scriptUrl, endpointUrl] = this.getUrlsByBuildConfig(options.buildConfig);
-                if (options.customScriptUrl && options.customEndpointUrl) {
-                    scriptUrl = options.customScriptUrl;
-                    endpointUrl = options.customEndpointUrl;
-                }
-                const scriptUrlPattern = scriptUrl
-                    ? [
-                        `${scriptUrl}?apiKey=<apiKey>&version=<version>&loaderVersion=<loaderVersion>`,
-                        FingerprintJS.defaultScriptUrlPattern,
-                    ]
-                    : [FingerprintJS.defaultScriptUrlPattern];
-                const endpoint = endpointUrl
-                    ? [`${endpointUrl}?region=${region}`, FingerprintJS.defaultEndpoint]
-                    : [FingerprintJS.defaultEndpoint];
-                const fpPromise = FingerprintJS.load({
-                    apiKey: options.publicApiKey,
-                    endpoint: endpoint,
-                    scriptUrlPattern: scriptUrlPattern,
-                    region: region,
-                });
-                const status = fpPromise ? 'successfully' : 'unsuccessfully with null instance';
-                this.log.trace(`Instantiating FingerprintJS ${status}`);
-                return fpPromise;
-            }
+        if (typeof finishStep === 'function') {
+            this.docvFinishStep = { execute: finishStep };
         }
-        catch (error) {
-            this.log.trace('FingerprintJS is not installed or failed to load', error);
+        else {
+            this.docvFinishStep = finishStep;
         }
+        return this;
     }
     withPasskeyAlreadyExistCallback(handler) {
         this.passkeyCreationHandler = handler;
         return this;
     }
     build() {
-        var _a;
         if (!this.platform) {
             throw new Error('Implementation of Platform is required');
         }
         if (!this.storage) {
             throw new Error('Implementation of Storage is required');
         }
-        const fpPromise = this.getFpPromiseInstanceFromOptions(this.deviceContextOptions);
-        if (fpPromise) {
-            (_a = this.platform) === null || _a === void 0 ? void 0 : _a.setFpPromise(fpPromise);
-        }
         const settings = new settings_1.default(this.storage);
         settings.upkEnabled = this.upkEnabled;
-        if (this.role === DeviceRole.Primary) {
-            return new main_authenticator_1.default(this.platform, settings, this.authFinishStep, [
-                new device_universal_step_1.default(this.upkEnabled),
-                new device_universal_redirect_steps_1.DeviceUniversalRedirectExchangeStep(),
-                new device_universal_redirect_steps_1.DeviceUniversalRedirectFinishStep(),
-                new device_passive_step_1.default(this.getDisplayName, this.passkeyCreationHandler, this.role),
-                new device_passive_stepup_step_1.default(this.getDisplayName, this.passkeyCreationHandler),
-                new device_passive_silent_step_1.default(this.upkEnabled, this.userConsentStep),
-                new device_passive_register_step_1.default(),
-                new device_passive_verify_step_1.default(),
-                new mobile_instant_step_1.default(this.mobileAuthImplementation, this.getDeviceIp),
-                new mobile_instantlink_step_1.default(this.instantLinkStartStep, this.instantLinkRetryStep, this.getDeviceIp),
-                new mobile_otp_step_1.default(this.otpStartStep, this.otpFinishStep),
-                new scan_message_step_1.default(this.authMessageHandler),
-                new user_mobileactive_step_1.default(),
-                new user_ppb_steps_1.UserPpbEnrollStep(this.ppbEnabled, this.ppbStartStep, this.ppbFinishStep),
-                new user_ppb_steps_1.UserPpbVerifyStep(this.ppbEnabled, this.ppbStartStep, this.ppbFinishStep),
-            ]);
+        if (this.deviceContextOptions) {
+            this.platform.initDeviceContext(this.deviceContextOptions);
         }
-        else {
-            return new main_authenticator_1.default(this.platform, settings, this.authFinishStep, [
-                new device_passive_step_1.default(this.getDisplayName, undefined, this.role),
-                new mobile_instant_step_1.default(this.mobileAuthImplementation, this.getDeviceIp),
-                new mobile_instantlink_step_1.default(this.instantLinkStartStep, this.instantLinkRetryStep, this.getDeviceIp),
-                new user_ppb_steps_1.UserPpbEnrollStep(this.ppbEnabled, this.ppbStartStep, this.ppbFinishStep),
-                new user_ppb_steps_1.UserPpbVerifyStep(this.ppbEnabled, this.ppbStartStep, this.ppbFinishStep),
-            ]);
+        const steps = this.getAuthSteps(this.role);
+        return new main_authenticator_1.default(this.platform, settings, this.authFinishStep, steps);
+    }
+    getAuthSteps(role) {
+        switch (this.role) {
+            case device_role_1.DeviceRole.Primary:
+                return [
+                    new device_universal_step_1.default(this.upkEnabled),
+                    new device_universal_redirect_steps_1.DeviceUniversalRedirectExchangeStep(),
+                    new device_universal_redirect_steps_1.DeviceUniversalRedirectFinishStep(),
+                    new device_passive_step_1.default(this.getDisplayName, this.passkeyCreationHandler, this.role),
+                    new device_passive_stepup_step_1.default(this.getDisplayName, this.passkeyCreationHandler),
+                    new device_passive_silent_step_1.default(this.upkEnabled, this.userConsentStep),
+                    new device_passive_register_step_1.default(),
+                    new device_passive_verify_step_1.default(),
+                    new mobile_instant_step_1.default(this.mobileAuthImplementation, this.getDeviceIp),
+                    new mobile_instantlink_step_1.default(this.instantLinkStartStep, this.instantLinkRetryStep, this.getDeviceIp),
+                    new mobile_otp_step_1.default(this.otpStartStep, this.otpFinishStep),
+                    new scan_message_step_1.default(this.authMessageHandler),
+                    new user_mobileactive_step_1.default(),
+                    new user_ppb_steps_1.UserPpbEnrollStep(this.ppbEnabled, this.ppbStartStep, this.ppbFinishStep),
+                    new user_ppb_steps_1.UserPpbVerifyStep(this.ppbEnabled, this.ppbStartStep, this.ppbFinishStep),
+                    new user_docv_steps_1.UserDocVerifyStep(this.docvEnabled, this.docvStartStep, this.docvFinishStep),
+                ];
+            case device_role_1.DeviceRole.Secondary:
+                return [
+                    new device_passive_step_1.default(this.getDisplayName, undefined, this.role),
+                    new mobile_instant_step_1.default(this.mobileAuthImplementation, this.getDeviceIp),
+                    new mobile_instantlink_step_1.default(this.instantLinkStartStep, this.instantLinkRetryStep, this.getDeviceIp),
+                    new user_ppb_steps_1.UserPpbEnrollStep(this.ppbEnabled, this.ppbStartStep, this.ppbFinishStep),
+                    new user_ppb_steps_1.UserPpbVerifyStep(this.ppbEnabled, this.ppbStartStep, this.ppbFinishStep),
+                    new user_docv_steps_1.UserDocVerifyStep(this.docvEnabled, this.docvStartStep, this.docvFinishStep),
+                ];
+            default:
+                throw new Error(`Unknown role: ${this.role}`);
         }
     }
 }

package/build/lib/proveauth/common/base64.js

@@ -6,7 +6,8 @@ class Base64 {
             '='.repeat(value.length % 4 ? 4 - (value.length % 4) : 0));
     }
     static bufferDecode(value) {
-        return Uint8Array.from(atob(Base64.stringToBase64(value)), (c) => c.charCodeAt(0));
+        const uint8Array = Uint8Array.from(atob(Base64.stringToBase64(value)), (c) => c.charCodeAt(0));
+        return uint8Array.buffer.slice(uint8Array.byteOffset, uint8Array.byteOffset + uint8Array.byteLength);
     }
     static bufferEncode(value) {
         const arrayValue = ArrayBuffer.isView(value) ? value.buffer : value;

package/build/lib/proveauth/common/logger.js

@@ -9,7 +9,7 @@ var LogLevel;
     LogLevel[LogLevel["info"] = 3] = "info";
     LogLevel[LogLevel["debug"] = 4] = "debug";
     LogLevel[LogLevel["trace"] = 5] = "trace";
-})(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
+})(LogLevel || (exports.LogLevel = LogLevel = {}));
 class ConsoleLogger {
     trace(...args) {
         console.info(...args);
@@ -80,6 +80,6 @@ class LoggerFactory {
         };
     }
 }
+exports.LoggerFactory = LoggerFactory;
 LoggerFactory.logWriter = new ConsoleLogWriter();
 LoggerFactory.logLevel = LogLevel.info;
-exports.LoggerFactory = LoggerFactory;

package/build/lib/proveauth/device-context-options.d.ts

@@ -1,11 +1,3 @@
-export declare enum ProveAuthProxyScriptUrl {
-    DEFAULT_US_UAT_SCRIPT_URL = "https://upk.uat.prove-auth.proveapis.com/vFqZceQyx8/uqLttozA7q",
-    DEFAULT_US_PROD_SCRIPT_URL = "https://upk.prove-auth.proveapis.com/vf82rhgDRK/r4VnwuwPUd"
-}
-export declare enum ProveAuthProxyEndpoint {
-    DEFAULT_US_UAT_ENDPOINT = "https://upk.uat.prove-auth.proveapis.com/vFqZceQyx8/bt9xhGAgQw",
-    DEFAULT_US_PROD_ENDPOINT = "https://upk.prove-auth.proveapis.com/vf82rhgDRK/ePaZsNne4X"
-}
 export declare enum BuildConfig {
     DEV = "DEV",
     US_UAT = "US_UAT",

package/build/lib/proveauth/device-context-options.js

@@ -1,19 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BuildConfig = exports.ProveAuthProxyEndpoint = exports.ProveAuthProxyScriptUrl = void 0;
-var ProveAuthProxyScriptUrl;
-(function (ProveAuthProxyScriptUrl) {
-    ProveAuthProxyScriptUrl["DEFAULT_US_UAT_SCRIPT_URL"] = "https://upk.uat.prove-auth.proveapis.com/vFqZceQyx8/uqLttozA7q";
-    ProveAuthProxyScriptUrl["DEFAULT_US_PROD_SCRIPT_URL"] = "https://upk.prove-auth.proveapis.com/vf82rhgDRK/r4VnwuwPUd";
-})(ProveAuthProxyScriptUrl = exports.ProveAuthProxyScriptUrl || (exports.ProveAuthProxyScriptUrl = {}));
-var ProveAuthProxyEndpoint;
-(function (ProveAuthProxyEndpoint) {
-    ProveAuthProxyEndpoint["DEFAULT_US_UAT_ENDPOINT"] = "https://upk.uat.prove-auth.proveapis.com/vFqZceQyx8/bt9xhGAgQw";
-    ProveAuthProxyEndpoint["DEFAULT_US_PROD_ENDPOINT"] = "https://upk.prove-auth.proveapis.com/vf82rhgDRK/ePaZsNne4X";
-})(ProveAuthProxyEndpoint = exports.ProveAuthProxyEndpoint || (exports.ProveAuthProxyEndpoint = {}));
+exports.BuildConfig = void 0;
 var BuildConfig;
 (function (BuildConfig) {
     BuildConfig["DEV"] = "DEV";
     BuildConfig["US_UAT"] = "US_UAT";
     BuildConfig["US_PROD"] = "US_PROD";
-})(BuildConfig = exports.BuildConfig || (exports.BuildConfig = {}));
+})(BuildConfig || (exports.BuildConfig = BuildConfig = {}));

package/build/lib/proveauth/device-role.d.ts

@@ -0,0 +1,4 @@
+export declare enum DeviceRole {
+    Primary = 0,
+    Secondary = 1
+}

package/build/lib/proveauth/device-role.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviceRole = void 0;
+var DeviceRole;
+(function (DeviceRole) {
+    DeviceRole[DeviceRole["Primary"] = 0] = "Primary";
+    DeviceRole[DeviceRole["Secondary"] = 1] = "Secondary";
+})(DeviceRole || (exports.DeviceRole = DeviceRole = {}));

package/build/lib/proveauth/docv.d.ts

@@ -0,0 +1,11 @@
+export default interface DocumentTypeInput {
+    documentType: string;
+}
+export interface DocVStartStep {
+    execute: () => Promise<DocumentTypeInput>;
+}
+export interface DocVFinishStep {
+    execute: (error?: Error) => Promise<void>;
+}
+export type DocVStartStepFn = () => Promise<DocumentTypeInput>;
+export type DocVFinishStepFn = (error?: Error) => Promise<void>;

package/build/lib/proveauth/docv.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/proveauth/instantlink.js

@@ -5,4 +5,4 @@ var InstantLinkResultType;
 (function (InstantLinkResultType) {
     InstantLinkResultType[InstantLinkResultType["OnResend"] = 0] = "OnResend";
     InstantLinkResultType[InstantLinkResultType["OnMobileNumberChange"] = 1] = "OnMobileNumberChange";
-})(InstantLinkResultType = exports.InstantLinkResultType || (exports.InstantLinkResultType = {}));
+})(InstantLinkResultType || (exports.InstantLinkResultType = InstantLinkResultType = {}));

package/build/lib/proveauth/internal/auth-request.d.ts

@@ -1,6 +1,6 @@
 import { MobileAuthImplementation } from '../authenticator-builder';
 import { AuthResponseStatus } from './auth-response-status';
-export type AuthRequest = V1ClientDeviceFido2RegisterStart | V1ClientDeviceFido2RegisterFinish | V1ClientDeviceFido2VerifyStart | V1ClientDeviceFido2VerifyFinish | V1ClientDevicePassiveRegister | V1ClientDevicePassiveVerify | V1ClientUserResponse | V1ClientAnyError | V1ClientChallenge | V1ClientMobileInstantLinkStart | V1ClientMobileInstantStart | V1ClientMobileInstantFinish | V1ClientOtpStart | V1ClientOtpFinish | V1ClientPpbFinish;
+export type AuthRequest = V1ClientDeviceFido2RegisterStart | V1ClientDeviceFido2RegisterFinish | V1ClientDeviceFido2VerifyStart | V1ClientDeviceFido2VerifyFinish | V1ClientDevicePassiveRegister | V1ClientDevicePassiveVerify | V1ClientUserResponse | V1ClientAnyError | V1ClientChallenge | V1ClientMobileInstantLinkStart | V1ClientMobileInstantStart | V1ClientMobileInstantFinish | V1ClientOtpStart | V1ClientOtpFinish | V1ClientPpbFinish | V1ClientDocVStart | V1ClientDocVFinish;
 export type AuthRegistration = PassiveRegistration | Fido2Registration;
 export interface PublicKey {
     id: string;
@@ -102,3 +102,8 @@ export interface V1ClientPpbFinish {
     requestId: string;
     operationId: string;
 }
+export interface V1ClientDocVStart {
+    requestId: string;
+    documentType: string;
+}
+export type V1ClientDocVFinish = V1ClientPpbFinish;

package/build/lib/proveauth/internal/auth-response-status.js

@@ -9,4 +9,4 @@ var AuthResponseStatus;
     AuthResponseStatus["Unexpected"] = "unexpected";
     AuthResponseStatus["Timeout"] = "timeout";
     AuthResponseStatus["Unknown"] = "unknown";
-})(AuthResponseStatus = exports.AuthResponseStatus || (exports.AuthResponseStatus = {}));
+})(AuthResponseStatus || (exports.AuthResponseStatus = AuthResponseStatus = {}));

package/build/lib/proveauth/internal/auth-response.d.ts

@@ -22,6 +22,8 @@ export type OtpFinishResponse = AuthResponse;
 export type InstantLinkStartResponse = AuthResponse;
 export type PpbStartResponse = AuthResponse;
 export type PpbFinishResponse = AuthResponse;
+export type DocVStartResponse = AuthResponse;
+export type DocVFinishResponse = AuthResponse;
 export interface RegisterStartAuthResponseData {
     credCreateOptions?: PublicKeyCredentialCreationOptions;
     credRequestOptions?: PublicKeyCredentialRequestOptions;
@@ -60,3 +62,7 @@ export interface PpbOperation {
 export interface PpbResponseData extends ResponseData {
     ppb?: PpbOperation;
 }
+export type DocVOperation = PpbOperation;
+export interface DocVResponseData extends ResponseData {
+    docv?: DocVOperation;
+}

package/build/lib/proveauth/internal/auth-session.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="webappsec-credential-management" />
 import AuthMessage from './auth-message';
 import { AuthRequest, Signal } from './auth-request';
 import AuthResponse, { ResponseData } from './auth-response';
@@ -36,7 +35,7 @@ export default class AuthSession implements AuthSessionIntegration {
     private getCurrentTimestampInSeconds;
     markNewFptts(ts?: number): void;
     resetFptts(): void;
-    getFingerprintData(): Promise<Signal | undefined>;
+    getDeviceContextData(): Promise<Signal | undefined>;
     shouldCollectFP(): boolean;
     shouldRefreshFpSignal(currentTimestamp: number): boolean;
     private parseJwt;

package/build/lib/proveauth/internal/auth-session.js

@@ -1,4 +1,13 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -77,7 +86,23 @@ class AuthSession {
                     headers: headers,
                     body: bodyStr,
                 })
-                    .then((response) => response.json())
+                    .then((response) => __awaiter(this, void 0, void 0, function* () {
+                    if (!response.ok) {
+                        const statusSuffix = response.statusText ? ` - ${response.statusText}` : '';
+                        const errorMessage = `Got ${response.status} HTTP error${statusSuffix}`;
+                        throw new auth_error_1.default(errorMessage, undefined, undefined, false);
+                    }
+                    const responseText = yield response.text();
+                    if (!responseText) {
+                        throw new auth_error_1.default('Empty response from server');
+                    }
+                    try {
+                        return JSON.parse(responseText);
+                    }
+                    catch (parseError) {
+                        throw new auth_error_1.default(`Failed to parse JSON response: ${parseError.message}`);
+                    }
+                }))
                     .then((response) => {
                     if (response.error) {
                         if (response.error.code === error_code_1.default.ERROR_NO_DEVICE_FOUND) {
@@ -220,7 +245,7 @@ class AuthSession {
     }
     embedFpResultToDeviceRegistration(registration) {
         return new Promise((resolve) => {
-            this.getFingerprintData()
+            this.getDeviceContextData()
                 .then((result) => {
                 if (result) {
                     registration.setFpSignal(result);
@@ -228,7 +253,7 @@ class AuthSession {
                 resolve(registration);
             })
                 .catch((error) => {
-                const errorMsg = `Unexpected error happened during Fingerprint data collection: ${auth_error_1.default.extractMessage(error)}`;
+                const errorMsg = `Unexpected error happened during Device Context data collection: ${auth_error_1.default.extractMessage(error)}`;
                 this.log.warn(error);
                 registration.setFpSignal({ error: errorMsg });
             });
@@ -245,51 +270,50 @@ class AuthSession {
     resetFptts() {
         this.settings.fingerPrintTimestamp = null;
     }
-    getFingerprintData() {
+    getDeviceContextData() {
         return new Promise((resolve) => {
-            var fpPromise = this.platform.getFpPromise();
             if (!this.shouldCollectFP()) {
-                this.log.trace('Fingerprint is not enabled from AuthToken');
+                this.log.trace('DeviceContext is not enabled in the AuthToken');
                 resolve(undefined);
+                return;
             }
-            else if (!fpPromise) {
-                const msg = 'Found null instance of Fingerprint, check if your input API key is valid';
-                this.log.warn(msg);
-                resolve({ error: msg });
-            }
-            else if (!this.shouldRefreshFpSignal(this.getCurrentTimestampInSeconds())) {
-                this.log.trace('Existing FP signal is not yet expired, skip new collection');
-                resolve(undefined);
-            }
-            else {
-                this.log.trace('Collect new FP signal');
-                fpPromise
-                    .then((fp) => fp.get())
-                    .then((result) => {
-                    if (result.sealedResult) {
-                        this.log.debug(`FP result: ${result.sealedResult}`);
-                        resolve({ results: result.sealedResult });
-                    }
-                    else {
-                        const msg = 'Cannot found sealed result in Fingerprint returned payload';
+            this.platform.getDataCollector().then((collector) => {
+                if (!collector) {
+                    const msg = 'Found null instance of data collector, check if your input API key is valid ' +
+                        'and prove-auth-device-context integration module is properly initialized';
+                    this.log.warn(msg);
+                    resolve({ error: msg });
+                    return;
+                }
+                if (!this.shouldRefreshFpSignal(this.getCurrentTimestampInSeconds())) {
+                    this.log.trace('Existing Device Context signal has not yet expired, skipping new collection');
+                    resolve(undefined);
+                    return;
+                }
+                this.log.trace('Collect new Device Context data');
+                collector
+                    .getCollectedData()
+                    .then((data) => {
+                    if (!data) {
+                        const msg = 'Data collector returned no result data';
                         this.log.warn(msg);
                         resolve({ error: msg });
+                        return;
                     }
+                    resolve({ results: data });
+                    return;
                 })
                     .catch((error) => {
-                    const msg = `Error in collecting Fingerprint data: ${auth_error_1.default.extractMessage(error)}`;
+                    const msg = `Error in collecting Device Context data: ${auth_error_1.default.extractMessage(error)}`;
                     this.log.warn(error);
                     resolve({ error: msg });
                 });
-            }
+            });
         });
     }
     shouldCollectFP() {
         var _a, _b, _c;
-        if ((_c = (_b = (_a = this.claims) === null || _a === void 0 ? void 0 : _a.auth.subs.dev) === null || _b === void 0 ? void 0 : _b.sgnls) === null || _c === void 0 ? void 0 : _c.fpt) {
-            return true;
-        }
-        return false;
+        return (_c = (_b = (_a = this.claims) === null || _a === void 0 ? void 0 : _a.auth.subs.dev) === null || _b === void 0 ? void 0 : _b.sgnls) === null || _c === void 0 ? void 0 : _c.fpt;
     }
     shouldRefreshFpSignal(currentTimestamp) {
         var _a, _b, _c, _d;
@@ -298,6 +322,7 @@ class AuthSession {
             return true;
         }
         const refreshRate = (_d = (_c = (_b = (_a = this.claims) === null || _a === void 0 ? void 0 : _a.auth.subs.dev) === null || _b === void 0 ? void 0 : _b.sgnls) === null || _c === void 0 ? void 0 : _c.fptrr) !== null && _d !== void 0 ? _d : 0;
+        this.log.debug(`Device Context refresh rate: ${refreshRate}`);
         const interval = currentTimestamp - this.settings.fingerPrintTimestamp;
         return interval >= refreshRate;
     }