perimeterx-js-core 0.30.1 → 0.31.0

package/lib/cjs/config/ConfigurationBase.js

@@ -775,6 +775,13 @@ var ConfigurationBase = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(ConfigurationBase.prototype, "dataEnrichmentHeaderName", {
+        get: function () {
+            return this.configParams.px_data_enrichment_header_name;
+        },
+        enumerable: false,
+        configurable: true
+    });
     Object.defineProperty(ConfigurationBase.prototype, "enableBlockedUrlOnCaptchaBlockPage", {
         get: function () {
             return true;

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

@@ -132,6 +132,7 @@ var defaultConfigurationParams = function () { return ({
     px_remote_config_retry_interval_ms: 1000,
     px_url_decode_reserved_characters: false,
     px_secured_pxhd_enabled: false,
+    px_data_enrichment_header_name: '',
     px_snippet_injection_enabled: false,
     px_create_custom_snippet: null,
     px_custom_is_sensitive_request: null,

package/lib/cjs/products/bot_defender/BotDefender.js

@@ -189,9 +189,17 @@ var BotDefender = /** @class */ (function () {
     BotDefender.prototype.createBlockResponse = function (context) {
         return this.blocker.createBlockResponse(context);
     };
-    BotDefender.prototype.modifyIncomingRequest = function (_context) {
+    BotDefender.prototype.modifyIncomingRequest = function (context) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
+                if (this.config.dataEnrichmentHeaderName && context.pxde && context.pxdeVerified) {
+                    try {
+                        context.requestData.request.headers.set(this.config.dataEnrichmentHeaderName, JSON.stringify(context.pxde));
+                    }
+                    catch (err) {
+                        context.logger.debug("unable to set data enrichment header: ".concat(err));
+                    }
+                }
                 return [2 /*return*/];
             });
         });

package/lib/cjs/utils/constants.js

@@ -15,4 +15,4 @@ exports.PUSH_DATA_FEATURE_HEADER_NAME = 'x-px-feature';
 exports.EMAIL_ADDRESS_REGEX = /^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$/;
 exports.URL_REGEX = /^(https?:)\/\/(([^@\s:\/]+):?([^@\s\/]*)@)?(([^:\/?#]*)(?:\:([0-9]+))?)(\/?[^?#]*)(\?[^#]*|)(#.*|)$/;
 exports.REGEX_STRUCTURE = /^\/(.+?)\/([gimsuyvd]*)$/;
-exports.CORE_MODULE_VERSION = 'JS Core 0.30.1';
+exports.CORE_MODULE_VERSION = 'JS Core 0.31.0';

package/lib/esm/config/ConfigurationBase.js

@@ -405,6 +405,9 @@ export class ConfigurationBase {
     get createCustomSnippet() {
         return this.configParams.px_create_custom_snippet;
     }
+    get dataEnrichmentHeaderName() {
+        return this.configParams.px_data_enrichment_header_name;
+    }
     get enableBlockedUrlOnCaptchaBlockPage() {
         return true;
     }

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

@@ -129,6 +129,7 @@ export const defaultConfigurationParams = () => ({
     px_remote_config_retry_interval_ms: 1000,
     px_url_decode_reserved_characters: false,
     px_secured_pxhd_enabled: false,
+    px_data_enrichment_header_name: '',
     px_snippet_injection_enabled: false,
     px_create_custom_snippet: null,
     px_custom_is_sensitive_request: null,

package/lib/esm/products/bot_defender/BotDefender.js

@@ -101,8 +101,15 @@ export class BotDefender {
     createBlockResponse(context) {
         return this.blocker.createBlockResponse(context);
     }
-    async modifyIncomingRequest(_context) {
-        // intentionally left blank
+    async modifyIncomingRequest(context) {
+        if (this.config.dataEnrichmentHeaderName && context.pxde && context.pxdeVerified) {
+            try {
+                context.requestData.request.headers.set(this.config.dataEnrichmentHeaderName, JSON.stringify(context.pxde));
+            }
+            catch (err) {
+                context.logger.debug(`unable to set data enrichment header: ${err}`);
+            }
+        }
     }
     async modifyOutgoingResponse(_context) {
         // intentionally left blank

package/lib/esm/utils/constants.js

@@ -12,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.30.1';
+export const CORE_MODULE_VERSION = 'JS Core 0.31.0';

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

@@ -143,6 +143,7 @@ export declare abstract class ConfigurationBase<Req, Res, Added, Removed extends
     get tokenVersion(): `${TokenVersion}`;
     get snippetInjectionEnabled(): boolean;
     get createCustomSnippet(): CustomSnippetFunction<Req, Res, Added, Removed> | null;
+    get dataEnrichmentHeaderName(): string;
     get enableBlockedUrlOnCaptchaBlockPage(): boolean;
     get awaitAsyncHttpRequests(): boolean;
     get isPostEnforceEnabled(): boolean;

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

@@ -404,6 +404,10 @@ export interface IConfiguration<Req, Res, Added, Removed> {
      * The version of the token the enforcer is able to parse.
      */
     readonly tokenVersion: `${TokenVersion}`;
+    /**
+     * The header name to use when adding the data enrichment value as an incoming request header.
+     */
+    readonly dataEnrichmentHeaderName: string;
     /**
      * Returns an object representation of the current configuration.
      */

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

@@ -120,6 +120,7 @@ export type CommonConfigurationParams<Req, Res, Added, Removed> = TokenV3Configu
     px_remote_config_retry_interval_ms?: number;
     px_url_decode_reserved_characters?: boolean;
     px_secured_pxhd_enabled?: boolean;
+    px_data_enrichment_header_name?: string;
     px_additional_activity_handler?: AdditionalActivityHandler<Req, Res, Added, Removed> | null;
     px_enrich_custom_parameters?: CustomParametersFunction<Req, Res, Added, Removed> | null;
     px_enrich_response_custom_parameters?: ResponseCustomParametersFunction<Req, Res, Added, Removed> | null;

package/lib/types/products/bot_defender/BotDefender.d.ts

@@ -46,6 +46,6 @@ export declare class BotDefender<Req, Res, Added, Removed> implements IBotDefend
     protected getSuccessfulRiskApiAction(riskResponse: DeepReadonly<IRiskResponse>, isMonitored: boolean): ActionData;
     shouldBlock(context: ReadonlyContext<Req, Res>): boolean;
     createBlockResponse(context: ReadonlyContext<Req, Res>): IMinimalResponse;
-    modifyIncomingRequest(_context: ReadonlyContext<Req, Res>): Promise<void>;
+    modifyIncomingRequest(context: ReadonlyContext<Req, Res>): Promise<void>;
     modifyOutgoingResponse(_context: ReadonlyContext<Req, Res>): Promise<void>;
 }

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

@@ -12,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.30.1";
+export declare const CORE_MODULE_VERSION = "JS Core 0.31.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "perimeterx-js-core",
-  "version": "0.30.1",
+  "version": "0.31.0",
   "description": "",
   "type": "module",
   "typesVersions": {
@@ -38,7 +38,7 @@
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --ext .ts --fix",
     "test": "mocha",
-    "coverage": "nyc npm run test",
+    "coverage": "c8 npm run test",
     "pre-commit": "./node_modules/.bin/lint-staged",
     "prepare": "husky"
   },
@@ -58,8 +58,9 @@
     "@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",
+    "@typescript-eslint/eslint-plugin": "^8.38.0",
     "@typescript-eslint/parser": "^8.26.0",
+    "c8": "^10.1.3",
     "chai": "^5.2.0",
     "chai-as-promised": "^8.0.0",
     "core-js": "^3.19.1",
@@ -69,9 +70,8 @@
     "husky": "^9.1.7",
     "lint-staged": "^16.0.0",
     "mocha": "^11.4.0",
-    "nyc": "^17.0.0",
     "prettier": "^3.5.3",
-    "sinon": "^20.0.0",
+    "sinon": "^21.0.0",
     "ts-loader": "^9.4.1",
     "ts-node": "^10.9.1",
     "tsc-alias": "^1.8.11",