@purespectrum1/purescore-client 0.7.0 → 0.9.8

package/README.md

@@ -1,12 +1,12 @@
-# Purescore Identifier
+# Purescore Client
 
 `@purespectrum1/purescore-client` generates a stable, unique device ID from
 device- and browser-level signals (fingerprinting). It ships as both a Node/TypeScript
 library and a standalone UMD browser bundle, so the same identification logic can run
 in a service or be dropped into a page with a `<script>` tag.
 
-> **Status:** project scaffolding. Build, test, lint and release pipelines are in place;
-> the `src/` implementation is still being added, so the public API below is not final.
+For survey pages, the recommended integration is the self-initializing script tag
+described in [Auto-init](#auto-init-single-script-tag).
 
 ## Requirements
 
@@ -41,6 +41,138 @@ Each release also uploads a version-pinned file (`bundle.<version>.js`) alongsid
 floating `bundle.js`. Pin the versioned file in production so a new release cannot
 change behaviour under you.
 
+## Auto-init (single script tag)
+
+The browser bundle can set itself up from its own `<script>` tag, so the survey page
+needs no bootstrap code and no `trackDetails` calls. Add `data-auto-init="true"` and
+the attributes below, and the bundle will:
+
+1. create the transaction (`POST /v1/transaction`), retrying up to 3 times;
+2. send the device and behavioural signals (`PATCH /v1/respondent/:transactionId`) on
+   a schedule derived from the survey's expected length of interview (LOI);
+3. hand every response back to the page (see [Receiving the result](#receiving-the-result)).
+
+Without `data-auto-init="true"` the bundle does nothing on load, so existing
+integrations are unaffected.
+
+### Example
+
+```html
+<script>
+  // Must be a global function, declared before the bundle tag (see data-callback).
+  function handlePureScore(result) {
+    if (result.continue === 0) {
+      // terminate the respondent
+    }
+  }
+</script>
+<script src="https://<cdn-host>/dist/bundle.<version>.js"
+        data-auto-init="true"
+        data-token="<device-intelligence-token>"
+        data-env="production"
+        data-callback="handlePureScore"
+
+        data-project-id="${project_id}"
+        data-expected-survey-loi="10"
+        data-survey-country="US"
+        data-survey-language="en"
+
+        data-buyer-id="456"
+        data-metadata='{"sup_resp_id":"24d373e4"}'
+        data-supplier-id="607"
+        data-supplier-member-id="m-24d373e4"
+        data-email-hash="<sha256-of-the-email>"
+        data-demographics-age="30"
+        data-demographics-gender="male"
+        data-demographics-zip="02134"></script>
+```
+
+`${project_id}` stands for whatever placeholder syntax your survey platform uses. It
+has to be replaced with the real value before the page is served (see
+[Validation](#validation)).
+
+### Attributes
+
+**Required.** If any of these is missing or invalid, auto-init logs an error to the
+console and does not start.
+
+| Attribute | Description |
+| --- | --- |
+| `data-auto-init` | Must be `"true"` to enable auto-init. |
+| `data-token` | Purescore bearer token. |
+| `data-project-id` | Project identifier. |
+| `data-expected-survey-loi` | Expected length of interview, **in minutes**. A positive number (decimals allowed). |
+| `data-survey-country` | ISO 3166-1 alpha-2 country code, e.g. `US`, `GB`. Converted to upper case. |
+| `data-survey-language` | ISO 639-1 language code, e.g. `en`, `fr`. Converted to lower case. Use the language only: `en-US` is rejected. |
+
+**Optional.** If one of these is set but invalid, it is logged and ignored, and
+auto-init still runs.
+
+| Attribute | Description |
+| --- | --- |
+| `data-env` | `production` or `staging`. Any other value, or none, means `staging`. **Set `production` on live surveys.** |
+| `data-callback` | Name of a **global** function to call with each response. |
+| `data-metadata` | A JSON **object** sent as `metadata` with every checkpoint. Use single quotes around the attribute so the JSON can keep its double quotes. |
+| `data-buyer-id` | Added to the metadata as `buyer_id`. |
+| `data-supplier-id` | Supplier identifier, sent when the transaction is created. |
+| `data-supplier-member-id` | The supplier's respondent identifier, sent when the transaction is created. |
+| `data-email-hash` | Hash of the respondent's email, sent when the transaction is created. Never send the plain email address. The value is not validated yet. |
+| `data-demographics-age` | Respondent age. A positive number. |
+| `data-demographics-gender` | Respondent gender. |
+| `data-demographics-zip` | Respondent postal code. Keep it as a string so leading zeros are preserved. |
+
+### Validation
+
+- **Uninterpolated placeholders are rejected.** If a value still contains `${`, `{{`,
+  `{%` or `<%`, the survey platform didn't replace it. A literal like
+  `${transaction_id}` would otherwise be shared by every respondent. For a required
+  attribute this stops auto-init; for an optional one, that attribute is dropped.
+- **Errors go to the browser console** with the prefix `Purescore-Client auto-init:`.
+  Check the console first when nothing seems to happen.
+- **Only the first tag on a page runs.** If the bundle is loaded a second time, it
+  does nothing.
+
+### Checkpoint schedule
+
+The transaction makes at most 5 calls, timed from the respondent's first page load:
+
+| Checkpoint | Due at | Example: LOI = 6 min |
+| --- | --- | --- |
+| 1 | 10 seconds | 0:10 |
+| 2 | ⅓ × LOI | 2:00 |
+| 3 | ⅔ × LOI | 4:00 |
+| 4 | 1 × LOI | 6:00 |
+| 5 | 2 × LOI | 12:00 |
+
+### Receiving the result
+
+Each response is delivered through three channels at once. Use whichever suits your
+platform:
+
+```js
+// 1. The global function named in data-callback
+function handlePureScore(result) { /* ... */ }
+
+// 2. A DOM event on window (any number of listeners)
+window.addEventListener('ps:purescore:result', function (event) {
+  var result = event.detail;
+});
+
+// 3. A global you can read at any time
+window.psPureScore && window.psPureScore.lastResult;
+```
+
+- **`data-callback` must name a function on `window`.** Declare it with a plain
+  `function` statement in a classic `<script>`, before the bundle tag. A function
+  declared inside an IIFE, an ES module or `jQuery(document).ready(...)` can't be
+  found, and the console will report `"<name>" is not a global function`.
+- **Use the `continue` field to decide what to do.** `continue: 0` means the
+  respondent should be terminated.
+- **On a later page, the latest response is delivered again.**
+  `window.psPureScore.lastResult` is set immediately. The event and the callback fire
+  once the document has finished parsing, so listeners declared further down the page
+  still receive it.
+
 ## Usage
 
 ```ts

package/lib/application/auto-init.d.ts

@@ -16,11 +16,15 @@ export declare const TRANSACTION_RETRY_DELAY_MS = 1000;
 export declare function resolveScriptTag(): HTMLScriptElement | null;
 /**
  * Reads the bootstrap configuration off the tag's `data-*` attributes, or
- * returns null when a required one is missing or unusable.
+ * returns null when the token is missing.
+ *
+ * A missing or unusable survey attribute is reported but not fatal: the
+ * transaction is still created with what the tag holds, so the service's own
+ * validation error shows up in the network response next to the console one.
  */
 export declare function readAutoInitConfig(tag: HTMLScriptElement): AutoInitConfig | null;
 /**
- * Bootstraps the Device-Identifier straight from the script tag: no constructor
+ * Bootstraps the Purescore-Client straight from the script tag: no constructor
  * call and no `trackDetails` call on the buyer side.
  *
  * Strictly opt-in — it does nothing unless `data-auto-init="true"` is on the tag
@@ -38,7 +42,6 @@ export declare class AutoInitService {
     private resolveTransactionId;
     /**
      * Registers the transaction, trying up to `TRANSACTION_CREATION_ATTEMPTS` times.
-     * Resolves with undefined when every attempt failed.
      */
     private createTransaction;
 }

package/lib/application/auto-init.js

@@ -15,6 +15,7 @@ exports.readAutoInitConfig = readAutoInitConfig;
 const validation_1 = require("../validation");
 const single_script_injection_1 = require("../domain/services/single-script-injection");
 const cache_1 = require("../infra/cache");
+const errors_1 = require("../domain/errors");
 /**
  * Guard flag on `window`: a second tag on the same page is a no-op.
  */
@@ -39,15 +40,18 @@ function resolveScriptTag() {
 }
 /**
  * Reads the bootstrap configuration off the tag's `data-*` attributes, or
- * returns null when a required one is missing or unusable.
+ * returns null when the token is missing.
+ *
+ * A missing or unusable survey attribute is reported but not fatal: the
+ * transaction is still created with what the tag holds, so the service's own
+ * validation error shows up in the network response next to the console one.
  */
 function readAutoInitConfig(tag) {
     var _a, _b, _c, _d, _e, _f, _g;
     const data = tag.dataset;
+    const tokenError = validation_1.ValidationBuilder.of({ value: data.token, fieldName: 'data-token' }).required().validate();
     const errors = [
-        validation_1.ValidationBuilder.of({ value: data.token, fieldName: 'data-token' })
-            .required(),
-        validation_1.ValidationBuilder.of({ value: data.surveyId, fieldName: 'data-survey-id' })
+        validation_1.ValidationBuilder.of({ value: data.projectId, fieldName: 'data-project-id' })
             .required()
             .interpolated(),
         validation_1.ValidationBuilder.of({ value: data.expectedSurveyLoi, fieldName: 'data-expected-survey-loi' })
@@ -62,17 +66,19 @@ function readAutoInitConfig(tag) {
             .required()
             .interpolated()
             .languageCode(),
-    ].map(rules => rules.validate()).filter((error) => error !== undefined);
-    if (errors.length) {
-        console.error(`Device-Identifier auto-init: ${errors.map(e => e.message).join('; ')}`);
-        return null;
+    ].map(rules => rules.validate());
+    const reported = [tokenError, ...errors].filter((error) => error !== undefined);
+    if (reported.length) {
+        console.error(`Purescore-Client auto-init: ${reported.map(e => e.message).join('; ')}`);
     }
+    if (tokenError)
+        return null;
     const config = {
         token: ((_a = data.token) !== null && _a !== void 0 ? _a : '').trim(),
         env: ((_b = data.env) === null || _b === void 0 ? void 0 : _b.trim().toLowerCase()) === 'production' ? 'production' : 'staging',
         callbackName: ((_c = data.callback) === null || _c === void 0 ? void 0 : _c.trim()) || undefined,
         metadata: parseMetadataAttribute(data.metadata),
-        surveyId: ((_d = data.surveyId) !== null && _d !== void 0 ? _d : '').trim(),
+        projectId: ((_d = data.projectId) !== null && _d !== void 0 ? _d : '').trim(),
         expectedSurveyLOI: Number(data.expectedSurveyLoi),
         surveyCountry: ((_e = data.surveyCountry) !== null && _e !== void 0 ? _e : '').trim().toUpperCase(),
         surveyLanguage: ((_f = data.surveyLanguage) !== null && _f !== void 0 ? _f : '').trim().toLowerCase(),
@@ -103,7 +109,7 @@ function readAutoInitConfig(tag) {
 function optionalField(raw, fieldName, rules = builder => builder, convert = value => value) {
     const error = rules(validation_1.ValidationBuilder.of({ value: raw, fieldName }).optional().interpolated()).validate();
     if (error) {
-        console.error(`Device-Identifier auto-init: ${error.message}, ignoring it`);
+        console.error(`Purescore-Client auto-init: ${error.message}, ignoring it`);
         return undefined;
     }
     const value = raw === null || raw === void 0 ? void 0 : raw.trim();
@@ -117,7 +123,7 @@ function optionalField(raw, fieldName, rules = builder => builder, convert = val
 function parseMetadataAttribute(raw) {
     const error = validation_1.ValidationBuilder.of({ value: raw, fieldName: 'data-metadata' }).jsonObject().validate();
     if (error) {
-        console.error(`Device-Identifier auto-init: ${error.message}, ignoring it`);
+        console.error(`Purescore-Client auto-init: ${error.message}, ignoring it`);
         return {};
     }
     return (raw === null || raw === void 0 ? void 0 : raw.trim()) ? JSON.parse(raw) : {};
@@ -130,7 +136,7 @@ function assignDefined(target, values) {
     });
 }
 /**
- * Bootstraps the Device-Identifier straight from the script tag: no constructor
+ * Bootstraps the Purescore-Client straight from the script tag: no constructor
  * call and no `trackDetails` call on the buyer side.
  *
  * Strictly opt-in — it does nothing unless `data-auto-init="true"` is on the tag
@@ -166,7 +172,7 @@ class AutoInitService {
         var _a;
         const deviceIdentifier = this.createDeviceIdentifier(config);
         const delivery = new single_script_injection_1.ResponseDeliveryService(config.callbackName);
-        const store = new single_script_injection_1.ScheduleStore(config.surveyId, new cache_1.LocalStorageAdapter());
+        const store = new single_script_injection_1.ScheduleStore(config, new cache_1.LocalStorageAdapter());
         const credentials = { token: config.token, env: config.env };
         // Re-emit the verdict from an earlier page before the schedule resumes, so a
         // page that only now registers a listener still receives the current one.
@@ -176,13 +182,15 @@ class AutoInitService {
         // The LOI comes off the tag, so every checkpoint is known up front. On a
         // later page the record already carries it, and `applyLoi` leaves it alone.
         store.resumeOrCreate();
-        store.applyLoi(config.expectedSurveyLOI);
+        if (Number.isFinite(config.expectedSurveyLOI) && config.expectedSurveyLOI > 0) {
+            store.applyLoi(config.expectedSurveyLOI);
+        }
         const transactionReady = this.resolveTransactionId(store, deviceIdentifier, config, credentials);
         const scheduler = new single_script_injection_1.CheckpointScheduler(store, () => __awaiter(this, void 0, void 0, function* () {
             const transactionId = yield transactionReady;
             if (!transactionId)
                 throw new Error('no transaction id to send the checkpoint for');
-            const response = yield deviceIdentifier.trackDetails(transactionId, config.metadata, credentials, { surveyId: config.surveyId });
+            const response = yield deviceIdentifier.trackDetails(transactionId, config.metadata, credentials, { projectId: config.projectId });
             store.storeResponse(response);
             delivery.deliver(response);
         }));
@@ -206,7 +214,6 @@ class AutoInitService {
     }
     /**
      * Registers the transaction, trying up to `TRANSACTION_CREATION_ATTEMPTS` times.
-     * Resolves with undefined when every attempt failed.
      */
     createTransaction(deviceIdentifier, config, credentials) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -214,7 +221,7 @@ class AutoInitService {
                 return new Promise(resolve => setTimeout(resolve, ms));
             };
             const details = {
-                surveyId: config.surveyId,
+                projectId: config.projectId,
                 expectedSurveyLOI: config.expectedSurveyLOI,
                 surveyCountry: config.surveyCountry,
                 surveyLanguage: config.surveyLanguage,
@@ -227,17 +234,19 @@ class AutoInitService {
             });
             for (let attempt = 1; attempt <= exports.TRANSACTION_CREATION_ATTEMPTS; attempt++) {
                 try {
-                    const transactionId = yield deviceIdentifier.createTransaction(details, credentials);
+                    const transactionId = yield deviceIdentifier.createTransaction(details, credentials, config.metadata);
                     if (transactionId)
                         return transactionId;
                 }
                 catch (error) {
-                    console.error(`Error creating Device-Intelligence transaction (attempt ${attempt}):`, error);
+                    if (error instanceof errors_1.TransactionRejectedError)
+                        return undefined;
+                    console.error(`Error creating PureScore-Intelligence transaction (attempt ${attempt}):`, error);
                 }
                 if (attempt < exports.TRANSACTION_CREATION_ATTEMPTS)
                     yield delay(exports.TRANSACTION_RETRY_DELAY_MS);
             }
-            console.error(`Device-Identifier auto-init: could not create the transaction after ${exports.TRANSACTION_CREATION_ATTEMPTS} attempts`);
+            console.error(`Purescore-Client auto-init: could not create the transaction after ${exports.TRANSACTION_CREATION_ATTEMPTS} attempts`);
             return undefined;
         });
     }

package/lib/application/device-identifier.d.ts

@@ -26,6 +26,11 @@ export declare class DeviceIdentifier implements TrackDetails, CreateTransaction
      * Service responsible for performing API requests to the Purescore Intelligence service.
     */
     private deviceIntelligenceService;
+    /**
+     * Source of the Verisoul session id sent with each respondent PATCH. Only
+     * set under the auto-init bootstrap; not configurable from the outside.
+     */
+    private verisoul?;
     private singleScriptInjection?;
     private screen_resolution?;
     private screen_orientation?;
@@ -61,6 +66,9 @@ export declare class DeviceIdentifier implements TrackDetails, CreateTransaction
         };
         webdriverEnabled: boolean;
         estimatedRoundTripTime: number;
+        cpuCores: number | null;
+        deviceMemory: number | null;
+        gpu: string | null;
         ua: string;
         browser: {
             name?: string;
@@ -110,7 +118,16 @@ export declare class DeviceIdentifier implements TrackDetails, CreateTransaction
      * as inactive.
      */
     deactivateBehavioralBiometricsDetection(): void;
-    createTransaction(details: TransactionDetails, config?: DeviceIdentifierConfig): Promise<string | undefined>;
+    /**
+     * The device details of a session
+     */
+    private collectSessionDetails;
+    /**
+     * Registers the transaction together with session 0: the device details
+     * collected right now, so the transaction can be evaluated as soon as it
+     * exists.
+     */
+    createTransaction(details: TransactionDetails, config?: DeviceIdentifierConfig, metadata?: DeviceIdentifierMetadata): Promise<string | undefined>;
     trackDetails(transactionId: string, metadata?: DeviceIdentifierMetadata, config?: DeviceIdentifierConfig, context?: TrackDetailsContext): Promise<Record<string, any>>;
     sendBehaviorBiometrics(transactionId: string, params: BehaviorBiometricsParams, config?: DeviceIdentifierConfig): Promise<any>;
 }

package/lib/application/device-identifier.js

@@ -12,9 +12,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DeviceIdentifier = void 0;
 const device_fingerprint_1 = require("../domain/services/device-fingerprint");
 const behavioural_biometrics_1 = require("../domain/services/behavioural-biometrics");
+const interaction_activity_1 = require("../domain/services/interaction-activity");
+const errors_1 = require("../domain/errors");
 const device_intelligence_1 = require("../domain/services/device-intelligence");
 const crosscutting_1 = require("../domain/models/crosscutting");
+const verisoul_1 = require("../domain/services/verisoul");
 const spa_navigation_1 = require("../domain/services/spa-navigation");
+const dom_mutation_tracker_1 = require("../domain/services/dom-mutation-tracker");
 const axios_http_client_1 = require("../infra/http/axios-http-client");
 const cache_1 = require("../infra/cache");
 const hash = new device_fingerprint_1.Hash();
@@ -24,7 +28,10 @@ const navigatior = new device_fingerprint_1.Navigatior();
 const canvas = new device_fingerprint_1.Canvas();
 const utils = new device_fingerprint_1.Utils();
 const audioFingerprint = new device_fingerprint_1.AudioFingerprint();
+const webgl = new device_fingerprint_1.WebGL();
 const pointerCapability = new device_fingerprint_1.PointerCapabilityDetector();
+const domMutationTracker = new dom_mutation_tracker_1.DomMutationTracker(new cache_1.SessionStorageAdapter());
+const interactionActivity = new interaction_activity_1.InteractionActivityTracker(new cache_1.SessionStorageAdapter());
 // One collector shared for the lifetime of the page. It owns the trackers, which
 // is what makes behavioural data survive a DeviceIdentifier being re-instantiated.
 const behaviouralBiometrics = new behavioural_biometrics_1.BehaviouralBiometricsCollector(new behavioural_biometrics_1.TouchBehavior(), new behavioural_biometrics_1.CursorBehavior(), new behavioural_biometrics_1.KeyboardMetrics(), new cache_1.SessionStorageAdapter(), new spa_navigation_1.SpaNavigationDetector());
@@ -52,7 +59,14 @@ class DeviceIdentifier {
         this.token = token;
         this.baseUrl = (0, crosscutting_1.resolveDeviceIntelligenceBaseUrl)(env);
         this.deviceIntelligenceService = new device_intelligence_1.DeviceIntelligenceService(new axios_http_client_1.AxiosHttpClient(), this.baseUrl, this.token);
+        if (this.singleScriptInjection && typeof window !== 'undefined') {
+            // Load the SDK now so its session is ready by the first checkpoint.
+            this.verisoul = new verisoul_1.VerisoulService((0, crosscutting_1.resolveVerisoulConfig)(env));
+            this.verisoul.load();
+        }
         this.activateBehavioralBiometricsDetection();
+        domMutationTracker.start();
+        interactionActivity.startTracking();
     }
     /**
      * Generates the fingerprint data for the browser.
@@ -70,7 +84,7 @@ class DeviceIdentifier {
             const hash = this.getIdentity(canvasFingerprint);
             return Object.assign(Object.assign({}, parsedData), { hash, canvas: canvasFingerprint, cookieEnabled: navigatior.isCookieEnabled(), display: display.getDisplayDetails(), javaEnabled: navigatior.isJavaEnabled(), tzOffset: utils.getTimezoneOffset(), touchEnabled: utils.getTouchSupport() || pointerCapability.hasTouchOrPen(), userAgent: navigatior.getUserAgent(), platform: navigatior.getPlatform(), languages: navigatior.getLanguages(), displayChecks: display.displayChecks(), networkPerformance: utils.getNetworkTime(), isWebCrawler: navigatior.isCrawler(), audioFingerprint: audioFingerprintResponse, userAgentClientHints: {
                     model: highEntropyClientHints === null || highEntropyClientHints === void 0 ? void 0 : highEntropyClientHints.model
-                }, webdriverEnabled: navigatior.isWebDriverEnabled(), estimatedRoundTripTime: navigatior.getEstimatedRoundTripTime() });
+                }, webdriverEnabled: navigatior.isWebDriverEnabled(), estimatedRoundTripTime: navigatior.getEstimatedRoundTripTime(), cpuCores: navigatior.getCpuCores(), deviceMemory: navigatior.getDeviceMemory(), gpu: webgl.getGpuRenderer() });
         });
     }
     /**
@@ -127,10 +141,34 @@ class DeviceIdentifier {
     deactivateBehavioralBiometricsDetection() {
         behaviouralBiometrics.deactivate();
     }
+    /**
+     * The device details of a session
+     */
+    collectSessionDetails(metadata) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const [details, verisoulSessionId] = yield Promise.all([
+                this.getDetails(),
+                (_a = this.verisoul) === null || _a === void 0 ? void 0 : _a.getSessionId(),
+            ]);
+            return Object.assign(Object.assign(Object.assign({ metadata }, details), (verisoulSessionId ? { verisoulSessionId } : {})), { domElementsMutationCount: domMutationTracker.domElementsMutationCount, interactionActivity: interactionActivity.getInteractionActivity() });
+        });
+    }
+    /**
+     * Registers the transaction together with session 0: the device details
+     * collected right now, so the transaction can be evaluated as soon as it
+     * exists.
+     */
     createTransaction(details_1) {
-        return __awaiter(this, arguments, void 0, function* (details, config = {}) {
+        return __awaiter(this, arguments, void 0, function* (details, config = {}, metadata = {}) {
             var _a;
-            const response = yield this.deviceIntelligenceService.performRequest('/v1/transaction', 'post', config, details);
+            const session = yield this.collectSessionDetails(metadata).catch(error => {
+                console.error('Error collecting the PureScore-Intelligence Session 0 details:', error);
+                return undefined;
+            });
+            const response = yield this.deviceIntelligenceService.performRequest('/v1/transaction', 'post', config, session ? Object.assign(Object.assign({}, details), { session }) : details);
+            if ((response === null || response === void 0 ? void 0 : response.statusCode) === 422)
+                throw new errors_1.TransactionRejectedError(response.body);
             const transactionId = (_a = response === null || response === void 0 ? void 0 : response.body) === null || _a === void 0 ? void 0 : _a.transactionId;
             const succeeded = typeof (response === null || response === void 0 ? void 0 : response.statusCode) === 'number'
                 && response.statusCode < 400
@@ -143,7 +181,7 @@ class DeviceIdentifier {
         return __awaiter(this, arguments, void 0, function* (transactionId, metadata = {}, config = {}, context = {}) {
             var _a;
             behaviouralBiometrics.pauseWindow();
-            const bbParams = context.surveyId ? Object.assign(Object.assign({}, metadata), { survey_id: context.surveyId }) : metadata;
+            const bbParams = context.projectId ? Object.assign(Object.assign({}, metadata), { survey_id: context.projectId }) : metadata;
             const bbResponse = yield this.sendBehaviorBiometrics(transactionId, bbParams, config);
             if (bbResponse.statusCode >= 400) {
                 this.deactivateBehavioralBiometricsDetection();
@@ -151,7 +189,7 @@ class DeviceIdentifier {
             else {
                 behaviouralBiometrics.startCycle(this.behaviouralBiometricsOptions);
             }
-            const payload = Object.assign(Object.assign({ metadata }, yield this.getDetails()), { transactionId });
+            const payload = Object.assign(Object.assign({}, yield this.collectSessionDetails(metadata)), { transactionId });
             const response = yield this.deviceIntelligenceService.performRequest(`/v1/respondent/${transactionId}`, 'patch', config, payload);
             return (_a = response.body) !== null && _a !== void 0 ? _a : response;
         });

package/lib/domain/errors/index.d.ts

@@ -0,0 +1 @@
+export * from './transaction-rejected-error';

package/lib/domain/errors/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./transaction-rejected-error"), exports);

package/lib/domain/errors/transaction-rejected-error.d.ts

@@ -0,0 +1,7 @@
+export declare class TransactionRejectedError extends Error {
+    readonly body: unknown;
+    /**
+     * @param body - the service's response body, kept so the caller can surface its validation message.
+     */
+    constructor(body: unknown);
+}

package/lib/domain/errors/transaction-rejected-error.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionRejectedError = void 0;
+class TransactionRejectedError extends Error {
+    /**
+     * @param body - the service's response body, kept so the caller can surface its validation message.
+     */
+    constructor(body) {
+        super('PureScore-Intelligence rejected the transaction details (HTTP 422)');
+        this.body = body;
+        this.name = 'TransactionRejectedError';
+    }
+}
+exports.TransactionRejectedError = TransactionRejectedError;

package/lib/domain/models/crosscutting/device-intelligence.d.ts

@@ -1,10 +1,10 @@
 /**
  * NOTE: these endpoints are going to be changed to a new domain
 */
-/** Device-Intelligence API, per environment. */
+/** PureScore-Intelligence API, per environment. */
 export declare const PURESCORE_INTELLIGENCE_BASE_URL: {
-    readonly production: "https://purescore.spectrumsurveys.com";
-    readonly staging: "https://purescore-staging.spectrumsurveys.com";
+    readonly production: "https://purescore-intelligence.spectrumsurveys.com";
+    readonly staging: "https://purescore-intelligence-uat.spectrumsurveys.com";
 };
 export type DeviceIntelligenceEnv = keyof typeof PURESCORE_INTELLIGENCE_BASE_URL;
 /** Anything other than an explicit `production` resolves to staging. */

package/lib/domain/models/crosscutting/device-intelligence.js

@@ -5,10 +5,10 @@ exports.resolveDeviceIntelligenceBaseUrl = resolveDeviceIntelligenceBaseUrl;
 /**
  * NOTE: these endpoints are going to be changed to a new domain
 */
-/** Device-Intelligence API, per environment. */
+/** PureScore-Intelligence API, per environment. */
 exports.PURESCORE_INTELLIGENCE_BASE_URL = {
-    production: 'https://purescore.spectrumsurveys.com',
-    staging: 'https://purescore-staging.spectrumsurveys.com',
+    production: 'https://purescore-intelligence.spectrumsurveys.com',
+    staging: 'https://purescore-intelligence-uat.spectrumsurveys.com',
 };
 /** Anything other than an explicit `production` resolves to staging. */
 function resolveDeviceIntelligenceBaseUrl(env) {

package/lib/domain/models/crosscutting/index.d.ts

@@ -1 +1,2 @@
 export * from './device-intelligence';
+export * from './verisoul';

package/lib/domain/models/crosscutting/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./device-intelligence"), exports);
+__exportStar(require("./verisoul"), exports);

package/lib/domain/models/crosscutting/verisoul.d.ts

@@ -0,0 +1,19 @@
+import { DeviceIntelligenceEnv } from './device-intelligence';
+/**
+ * Verisoul SDK, per environment. The bundle is served through our own proxy
+ * (same hosts as ps-screener) so ad-blockers keyed on the vendor domain don't
+ * drop it; the project id is what ties the session to our Verisoul account.
+ */
+export declare const VERISOUL_CONFIG: {
+    readonly production: {
+        readonly sdkUrl: "https://vs.spectrumsurveys.com/bundle.js";
+        readonly projectId: "7a994dae-58a8-413f-a59a-655a7adbfb2d";
+    };
+    readonly staging: {
+        readonly sdkUrl: "https://sandbox.vs.spectrumsurveys.com/bundle.js";
+        readonly projectId: "6e7419d0-3be6-43d7-a4a4-9d44828d9f5e";
+    };
+};
+export type VerisoulEnvConfig = (typeof VERISOUL_CONFIG)[DeviceIntelligenceEnv];
+/** Anything other than an explicit `production` resolves to the sandbox project. */
+export declare function resolveVerisoulConfig(env?: string): VerisoulEnvConfig;

package/lib/domain/models/crosscutting/verisoul.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERISOUL_CONFIG = void 0;
+exports.resolveVerisoulConfig = resolveVerisoulConfig;
+/**
+ * Verisoul SDK, per environment. The bundle is served through our own proxy
+ * (same hosts as ps-screener) so ad-blockers keyed on the vendor domain don't
+ * drop it; the project id is what ties the session to our Verisoul account.
+ */
+exports.VERISOUL_CONFIG = {
+    production: {
+        sdkUrl: 'https://vs.spectrumsurveys.com/bundle.js',
+        projectId: '7a994dae-58a8-413f-a59a-655a7adbfb2d',
+    },
+    staging: {
+        sdkUrl: 'https://sandbox.vs.spectrumsurveys.com/bundle.js',
+        projectId: '6e7419d0-3be6-43d7-a4a4-9d44828d9f5e',
+    },
+};
+/** Anything other than an explicit `production` resolves to the sandbox project. */
+function resolveVerisoulConfig(env) {
+    return (env === null || env === void 0 ? void 0 : env.toLowerCase()) === 'production'
+        ? exports.VERISOUL_CONFIG.production
+        : exports.VERISOUL_CONFIG.staging;
+}

package/lib/domain/protocols/services/device-fingerprint/navigator.d.ts

@@ -32,6 +32,7 @@ declare global {
     interface Navigator {
         userAgentData?: NavigatorUAData;
         connection?: NetworkInformation;
+        deviceMemory?: number;
     }
 }
 export interface UAParserDeviceType {