perimeterx-js-core 0.27.0 → 0.29.0

package/lib/cjs/utils/timestamp_hmac_header_validator/DefaultTimestampHmacHeaderValidator.js

@@ -9,8 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");

package/lib/cjs/utils/utils.js

@@ -9,8 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");

package/lib/esm/activities/HttpActivityClient.js

@@ -133,7 +133,7 @@ export class HttpActivityClient {
         const body = activities.length === 1 ? JSON.stringify(activities[0]) : JSON.stringify(activities);
         logger.debug(`sending ${activities.map(({ type }) => `${type} activity`).join(', ')} to ${url}`);
         const req = new OutgoingRequestImpl({ url, method, headers, body });
-        const res = await this.httpClient.send(req);
+        const res = await this.httpClient.send(req, { timeoutMs: this.config.asyncTimeout });
         return res?.status === 200;
     }
 }

package/lib/esm/config/ConfigurationBase.js

@@ -1,6 +1,6 @@
 import { defaultConfigurationParams } from './defaults/index.js';
 import { DefaultLogger, LoggerSeverity } from '../logger/index.js';
-import { CORE_MODULE_VERSION, EnforcerConfigurationError, getCollectorDomain, getScoreApiDomain, isNullOrUndefined, isValidEnumValue, ModuleMode, } from '../utils/index.js';
+import { convertRegexStringToRegex, CORE_MODULE_VERSION, EnforcerConfigurationError, getCollectorDomain, getScoreApiDomain, isNullOrUndefined, isValidEnumValue, ModuleMode, UNLIMITED_TIMEOUT, } from '../utils/index.js';
 import { RemoteConfigUtils } from './remote_config/index.js';
 import { TokenVersion } from '../risk_token/index.js';
 /**
@@ -46,9 +46,8 @@ export class ConfigurationBase {
         });
     }
     getValidConfigValue(params, defaultParams, key) {
-        const paramsValue = params[key];
-        if (!isNullOrUndefined(paramsValue) && this.isValidConfigValue(params, defaultParams, key)) {
-            return paramsValue;
+        if (!isNullOrUndefined(params[key]) && this.isValidConfigValue(params, defaultParams, key)) {
+            return this.normalizeConfigurationValue(params, key);
         }
         else {
             return this.getDefaultConfigurationValue(params, defaultParams, key);
@@ -84,6 +83,23 @@ export class ConfigurationBase {
                 return defaultParams[key];
         }
     }
+    normalizeConfigurationValue(params, key) {
+        switch (key) {
+            case 'px_filter_by_extension':
+                return params[key].map((ext) => (ext.startsWith('.') ? ext : `.${ext}`));
+            case 'px_sensitive_routes':
+            case 'px_monitored_routes':
+            case 'px_enforced_routes':
+            case 'px_graphql_routes':
+            case 'px_filter_by_route':
+            case 'px_filter_by_user_agent':
+            case 'px_graphql_keywords':
+            case 'px_sensitive_graphql_operation_names':
+                return params[key].map((pattern) => typeof pattern === 'string' ? (convertRegexStringToRegex(pattern) ?? pattern) : pattern);
+            default:
+                return params[key];
+        }
+    }
     createInternalLogger(params) {
         return new DefaultLogger(params.px_logger_severity, false, this.logger?.getLogs());
     }
@@ -148,7 +164,7 @@ export class ConfigurationBase {
         return this.configParams.px_custom_is_enforced_request;
     }
     get filteredExtensions() {
-        return this.configParams.px_filter_by_extension?.map((ext) => (ext.startsWith('.') ? ext : `.${ext}`));
+        return this.configParams.px_filter_by_extension;
     }
     get filteredHttpMethods() {
         return this.configParams.px_filter_by_http_method;
@@ -201,6 +217,11 @@ export class ConfigurationBase {
     get s2sTimeout() {
         return this.configParams.px_s2s_timeout;
     }
+    get asyncTimeout() {
+        return this.configParams.px_async_timeout === UNLIMITED_TIMEOUT
+            ? undefined
+            : this.configParams.px_async_timeout;
+    }
     get sensitiveHeaders() {
         return this.configParams.px_sensitive_headers;
     }

package/lib/esm/config/defaults/DefaultConfigurationParams.js

@@ -1,5 +1,5 @@
 import { LoggerSeverity } from '../../logger/index.js';
-import { ModuleMode } from '../../utils/index.js';
+import { ModuleMode, UNLIMITED_TIMEOUT } from '../../utils/index.js';
 import { CredentialIntelligenceVersion, DEFAULT_COMPROMISED_CREDENTIALS_HEADER_NAME, LoginSuccessfulReportingMethod, } from '../../products/index.js';
 import { TokenVersion } from '../../risk_token/index.js';
 export const defaultConfigurationParams = () => ({
@@ -18,6 +18,7 @@ export const defaultConfigurationParams = () => ({
     px_graphql_routes_regex: [],
     px_sensitive_routes_regex: [],
     px_s2s_timeout: 1000,
+    px_async_timeout: UNLIMITED_TIMEOUT,
     px_blocking_score: 100,
     px_user_agent_max_length: 8528,
     px_risk_cookie_max_length: 2048,

package/lib/esm/config/remote_config/service_client/HttpRemoteConfigServiceClient.js

@@ -9,7 +9,7 @@ export class HttpRemoteConfigServiceClient {
     }
     async fetch(_updateRequestData) {
         const request = this.createFetchRemoteConfigRequest();
-        const response = await this.httpClient.send(request);
+        const response = await this.httpClient.send(request, { timeoutMs: this.config.asyncTimeout });
         return this.extractConfigFromResponse(response);
     }
     createFetchRemoteConfigRequest() {

package/lib/esm/flow/Flow.js

@@ -7,45 +7,49 @@ export class Flow {
     insert(phase, options) {
         if (!options) {
             this.phases.push(phase);
-            return;
+            return this;
         }
         if (options.before) {
             const index = this.getIndexOfPhase(options.before);
             if (index === -1) {
-                return;
+                return this;
             }
             this.phases.splice(index, 0, phase);
         }
         if (options.after) {
             const index = this.getIndexOfPhase(options.after);
             if (index === -1) {
-                return;
+                return this;
             }
             this.phases.splice(index + 1, 0, phase);
         }
+        return this;
     }
     remove(name) {
         const index = this.getIndexOfPhase(name);
         if (index === -1) {
-            return;
+            return this;
         }
         this.phases.splice(index, 1);
+        return this;
     }
     replace(name, phase) {
         const index = this.getIndexOfPhase(name);
         if (index === -1) {
-            return;
+            return this;
         }
         this.phases.splice(index, 1, phase);
+        return this;
     }
     move(name, to) {
         const index = this.getIndexOfPhase(name);
         if (index === -1) {
-            return;
+            return this;
         }
         const phase = this.phases[index];
         this.phases.splice(index, 1);
         this.insert(phase, to);
+        return this;
     }
     getIndexOfPhase(name) {
         return this.phases.findIndex((existingPhase) => existingPhase.constructor.name === name);

package/lib/esm/graphql/DefaultGraphQLParser.js

@@ -147,11 +147,15 @@ export class DefaultGraphQLParser {
         }
     }
     getQueryKeywordsFromArray(query, context) {
+        if (!query) {
+            context.logger.debug(`empty query, unable to extract graphql keywords`);
+            return [];
+        }
         let keywords = [];
         try {
             this.config.graphqlKeywords.forEach((keyword) => {
                 const pattern = this.toGlobalRegExp(keyword);
-                let matchGroup = query?.match(pattern);
+                let matchGroup = query.match(pattern);
                 if (!matchGroup) {
                     return;
                 }

package/lib/esm/logger/HttpLogServiceClient.js

@@ -51,7 +51,7 @@ export class HttpLogServiceClient {
         };
         const body = JSON.stringify(logRecords);
         const req = new OutgoingRequestImpl({ url, method, headers, body });
-        const res = await this.httpClient.send(req);
+        const res = await this.httpClient.send(req, { timeoutMs: this.config.asyncTimeout });
         return res?.status === 200;
     }
 }

package/lib/esm/telemetry/DefaultTelemetry.js

@@ -39,7 +39,7 @@ export class DefaultTelemetry {
     async sendTelemetryActivity(context) {
         const telemetryRequest = this.createTelemetryRequest(context);
         context.logger.debug(`sending telemetry to ${telemetryRequest.url}`);
-        await this.httpClient.send(telemetryRequest);
+        await this.httpClient.send(telemetryRequest, { timeoutMs: this.config.asyncTimeout });
     }
     createTelemetryRequest(context) {
         const url = `${this.config.backendScoreApiUrl}${TELEMETRY_ENDPOINT}`;

package/lib/esm/utils/constants.js

@@ -3,6 +3,7 @@ export const PXHD_COOKIE_NAME = '_pxhd';
 export const PXDE_COOKIE_NAME = '_pxde';
 export const CD_PXVID_COOKIE_NAME = '__pxvid';
 export const BYPASS_MONITOR_HEADER_VALUE = '1';
+export const UNLIMITED_TIMEOUT = 0;
 export const X_PX_AUTHORIZATION_HEADER_NAME = 'x-px-authorization';
 export const X_PX_ORIGINAL_TOKEN_HEADER_NAME = 'x-px-original-token';
 export const X_PX_BYPASS_REASON_HEADER_NAME = 'x-px-bypass-reason';
@@ -11,4 +12,4 @@ export const PUSH_DATA_FEATURE_HEADER_NAME = 'x-px-feature';
 export const EMAIL_ADDRESS_REGEX = /^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$/;
 export const URL_REGEX = /^(https?:)\/\/(([^@\s:\/]+):?([^@\s\/]*)@)?(([^:\/?#]*)(?:\:([0-9]+))?)(\/?[^?#]*)(\?[^#]*|)(#.*|)$/;
 export const REGEX_STRUCTURE = /^\/(.+?)\/([gimsuyvd]*)$/;
-export const CORE_MODULE_VERSION = 'JS Core 0.27.0';
+export const CORE_MODULE_VERSION = 'JS Core 0.29.0';

package/lib/types/config/ConfigurationBase.d.ts

@@ -46,6 +46,7 @@ export declare abstract class ConfigurationBase<Req, Res, Added, Removed extends
     protected getValidConfigValue<K extends keyof RequiredAllConfigurationParams<Req, Res, Added, Removed>, V extends RequiredAllConfigurationParams<Req, Res, Added, Removed>[K]>(params: AllConfigurationParams<Req, Res, Added, Removed>, defaultParams: RequiredAllConfigurationParams<Req, Res, Added, Removed>, key: K): V;
     protected isValidConfigValue(params: AllConfigurationParams<Req, Res, Added, Removed>, defaultParams: RequiredAllConfigurationParams<Req, Res, Added, Removed>, key: keyof RequiredAllConfigurationParams<Req, Res, Added, Removed>): boolean;
     protected getDefaultConfigurationValue<K extends keyof RequiredAllConfigurationParams<Req, Res, Added, Removed>, V extends RequiredAllConfigurationParams<Req, Res, Added, Removed>[K]>(params: AllConfigurationParams<Req, Res, Added, Removed>, defaultParams: RequiredAllConfigurationParams<Req, Res, Added, Removed>, key: K): V;
+    protected normalizeConfigurationValue<K extends keyof RequiredAllConfigurationParams<Req, Res, Added, Removed>, V extends RequiredAllConfigurationParams<Req, Res, Added, Removed>[K]>(params: AllConfigurationParams<Req, Res, Added, Removed>, key: K): V;
     protected createInternalLogger(params: RequiredAllConfigurationParams<Req, Res, Added, Removed>): ILogger;
     setRemoteConfigData(remoteConfigData: RemoteConfigData<Req, Res, Added, Removed>): void;
     getActiveConfig(): ActiveConfigurationParams<Req, Res, Added, Removed>;
@@ -80,6 +81,7 @@ export declare abstract class ConfigurationBase<Req, Res, Added, Removed extends
     get monitoredRoutes(): Array<string | RegExp>;
     get customIsMonitoredRequest(): CustomRequestFunction<Req> | null;
     get s2sTimeout(): number;
+    get asyncTimeout(): number | undefined;
     get sensitiveHeaders(): string[];
     get sensitiveRoutes(): Array<string | RegExp>;
     get customIsSensitiveRequest(): CustomRequestFunction<Req> | null;

package/lib/types/config/IConfiguration.d.ts

@@ -31,6 +31,10 @@ export interface IConfiguration<Req, Res, Added, Removed> {
      * The timeout for risk API calls, in milliseconds.
      */
     readonly s2sTimeout: number;
+    /**
+     * The timeout for async HTTP requests, in milliseconds. A value of undefined means an unlimited timeout.
+     */
+    readonly asyncTimeout: number | undefined;
     /**
      * An interface used to log enforcer debug and error messages.
      */

package/lib/types/config/params/CoreConfigurationParams.d.ts

@@ -9,7 +9,7 @@ import { CustomRequestFunction } from '../CustomRequestFunction';
 import { TokenVersion } from '../../risk_token';
 import { CustomSnippetFunction } from '../../snippet_injection';
 /**
- * The configuration parameters that can be set only via the static configuration..
+ * The configuration parameters that can be set only via the static configuration.
  */
 export type StaticConfigurationParamsOnly = {
     px_app_id: string;
@@ -59,6 +59,7 @@ export type SnippetInjectionParamsOnly<Req, Res, Added, Removed> = {
  */
 export type CommonConfigurationParams<Req, Res, Added, Removed> = TokenV3ConfigurationParamsOnly & BatchedActivitiesConfigParamsOnly & SnippetInjectionParamsOnly<Req, Res, Added, Removed> & {
     px_s2s_timeout?: number;
+    px_async_timeout?: number;
     px_backend_url?: string;
     px_user_agent_max_length?: number;
     px_logger_severity?: `${LoggerSeverity}`;

package/lib/types/flow/Flow.d.ts

@@ -4,10 +4,10 @@ import { IFlow, InsertPhaseOptions } from './IFlow';
 export declare class Flow<Req, Res> implements IFlow<Req, Res> {
     readonly phases: IPhase<Req, Res>[];
     constructor(phases: IPhase<Req, Res>[]);
-    insert(phase: IPhase<Req, Res>, options?: InsertPhaseOptions): void;
-    remove(name: string): void;
-    replace(name: string, phase: IPhase<Req, Res>): void;
-    move(name: string, to: InsertPhaseOptions): void;
+    insert(phase: IPhase<Req, Res>, options?: InsertPhaseOptions): IFlow<Req, Res>;
+    remove(name: string): IFlow<Req, Res>;
+    replace(name: string, phase: IPhase<Req, Res>): IFlow<Req, Res>;
+    move(name: string, to: InsertPhaseOptions): IFlow<Req, Res>;
     protected getIndexOfPhase(name: string): number;
     execute(context: IContext<Req, Res>): Promise<PhaseResult>;
 }

package/lib/types/flow/IFlow.d.ts

@@ -34,24 +34,28 @@ export interface IFlow<Req, Res> extends IPhase<Req, Res> {
      * Replaces the named phase in the flow with the provided phase. If the named phase is not found, nothing happens.
      * @param name - The name of the phase to replace. A phase with this name should exist in the flow already.
      * @param phase - The phase that should replace the named phase.
+     * @returns The flow instance itself for chaining.
      */
-    replace(name: string, phase: IPhase<Req, Res>): void;
+    replace(name: string, phase: IPhase<Req, Res>): IFlow<Req, Res>;
     /**
      * Removes the named phase from the flow. If the named phase is not found, does nothing.
      * @param name - The name of the phase to remove. A phase with this name should exist in the flow already.
+     * @returns The flow instance itself for chaining.
      */
-    remove(name: string): void;
+    remove(name: string): IFlow<Req, Res>;
     /**
      * Inserts the provided phase into the flow at the specified position. If no position is specified,
      * the phase will be added to the very end of the flow.
      * @param phase - The phase to insert into the flow.
      * @param options - The options for inserting the phase. If no options are provided, the phase will be added to the end of the flow.
+     * @returns The flow instance itself for chaining.
      */
-    insert(phase: IPhase<Req, Res>, options?: InsertPhaseOptions): void;
+    insert(phase: IPhase<Req, Res>, options?: InsertPhaseOptions): IFlow<Req, Res>;
     /**
      * Moves the named phase to the specified position in the flow. If the named phase is not found, nothing happens.
      * @param name - The name of the phase to move. A phase with this name should exist in the flow already.
      * @param to - The options for moving the phase. The phase will be moved to the specified position in the flow.
+     * @returns The flow instance itself for chaining.
      */
-    move(name: string, to: InsertPhaseOptions): void;
+    move(name: string, to: InsertPhaseOptions): IFlow<Req, Res>;
 }

package/lib/types/utils/constants.d.ts

@@ -3,6 +3,7 @@ export declare const PXHD_COOKIE_NAME = "_pxhd";
 export declare const PXDE_COOKIE_NAME = "_pxde";
 export declare const CD_PXVID_COOKIE_NAME = "__pxvid";
 export declare const BYPASS_MONITOR_HEADER_VALUE = "1";
+export declare const UNLIMITED_TIMEOUT = 0;
 export declare const X_PX_AUTHORIZATION_HEADER_NAME = "x-px-authorization";
 export declare const X_PX_ORIGINAL_TOKEN_HEADER_NAME = "x-px-original-token";
 export declare const X_PX_BYPASS_REASON_HEADER_NAME = "x-px-bypass-reason";
@@ -11,4 +12,4 @@ export declare const PUSH_DATA_FEATURE_HEADER_NAME = "x-px-feature";
 export declare const EMAIL_ADDRESS_REGEX: RegExp;
 export declare const URL_REGEX: RegExp;
 export declare const REGEX_STRUCTURE: RegExp;
-export declare const CORE_MODULE_VERSION = "JS Core 0.27.0";
+export declare const CORE_MODULE_VERSION = "JS Core 0.29.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "perimeterx-js-core",
-  "version": "0.27.0",
+  "version": "0.29.0",
   "description": "",
   "type": "module",
   "typesVersions": {
@@ -55,6 +55,7 @@
     "@types/chai-as-promised": "^8.0.2",
     "@types/crypto-js": "^4.1.1",
     "@types/mocha": "^10.0.0",
+    "@types/node": "^18.19.50 || ^20.6.0 || ^22.0.0",
     "@types/sinon": "^17.0.1",
     "@types/uuid": "^10.0.0",
     "@typescript-eslint/eslint-plugin": "^8.26.0",
@@ -66,11 +67,11 @@
     "eslint-config-prettier": "^10.0.2",
     "eslint-plugin-prettier": "^5.2.3",
     "husky": "^9.1.7",
-    "lint-staged": "^15.4.3",
-    "mocha": "^10.0.0",
+    "lint-staged": "^16.0.0",
+    "mocha": "^11.4.0",
     "nyc": "^17.0.0",
     "prettier": "^3.5.3",
-    "sinon": "^18.0.0",
+    "sinon": "^20.0.0",
     "ts-loader": "^9.4.1",
     "ts-node": "^10.9.1",
     "tsc-alias": "^1.8.11",