perimeterx-js-core 0.34.0 → 0.35.0

package/lib/cjs/config/ConfigurationBase.js

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

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

@@ -135,6 +135,7 @@ var defaultConfigurationParams = function () { return ({
     px_data_enrichment_header_name: '',
     px_snippet_injection_enabled: false,
     px_create_custom_snippet: null,
+    px_proxy_url: '',
     px_custom_is_sensitive_request: null,
     px_custom_is_monitored_request: null,
     px_custom_is_enforced_request: null,

package/lib/cjs/impl/http/phin/PhinHttpClient.js

@@ -44,11 +44,13 @@ var http_1 = require("http");
 var https_1 = require("https");
 var phin_1 = __importDefault(require("phin"));
 var utils_1 = require("../../../utils/index.js");
-var interfaces_1 = require("../../../http/interfaces/index.js");
+var http_2 = require("../../../http/index.js");
 var PhinIncomingResponse_1 = require("./PhinIncomingResponse.js");
 var PhinHttpClient = /** @class */ (function () {
-    function PhinHttpClient() {
-        this.httpsKeepAliveAgent = new https_1.Agent({ keepAlive: true });
+    function PhinHttpClient(options) {
+        var _a, _b;
+        this.httpAgent = (_a = options === null || options === void 0 ? void 0 : options.httpAgent) !== null && _a !== void 0 ? _a : null;
+        this.httpsAgent = (_b = options === null || options === void 0 ? void 0 : options.httpsAgent) !== null && _b !== void 0 ? _b : new https_1.Agent({ keepAlive: true });
     }
     PhinHttpClient.prototype.send = function (request, options) {
         return __awaiter(this, void 0, void 0, function () {
@@ -60,11 +62,11 @@ var PhinHttpClient = /** @class */ (function () {
                         return [4 /*yield*/, phin_1.default.promisified({
                                 url: request.url,
                                 method: request.method,
-                                headers: (0, interfaces_1.joinHeaderValues)(request.headers),
+                                headers: (0, http_2.joinHeaderValues)(request.headers),
                                 data: request.body,
                                 timeout: options === null || options === void 0 ? void 0 : options.timeoutMs,
                                 core: {
-                                    agent: request.url.startsWith('https://') ? this.httpsKeepAliveAgent : new http_1.Agent(),
+                                    agent: this.getAgent(request),
                                 },
                             })];
                     case 1:
@@ -79,6 +81,15 @@ var PhinHttpClient = /** @class */ (function () {
             });
         });
     };
+    PhinHttpClient.prototype.getAgent = function (request) {
+        if (request.url.startsWith('https://')) {
+            return this.httpsAgent;
+        }
+        if (this.httpAgent) {
+            return this.httpAgent;
+        }
+        return new http_1.Agent();
+    };
     return PhinHttpClient;
 }());
 exports.PhinHttpClient = PhinHttpClient;

package/lib/cjs/impl/http/phin/PhinHttpProxyClient.js

@@ -0,0 +1,31 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PhinHttpProxyClient = void 0;
+var PhinHttpClient_1 = require("./PhinHttpClient.js");
+var http_proxy_agent_1 = require("http-proxy-agent");
+var https_proxy_agent_1 = require("https-proxy-agent");
+var PhinHttpProxyClient = /** @class */ (function (_super) {
+    __extends(PhinHttpProxyClient, _super);
+    function PhinHttpProxyClient(proxyUrl) {
+        var httpAgent = new http_proxy_agent_1.HttpProxyAgent(proxyUrl, { keepAlive: true });
+        var httpsAgent = new https_proxy_agent_1.HttpsProxyAgent(proxyUrl, { keepAlive: true });
+        return _super.call(this, { httpsAgent: httpsAgent, httpAgent: httpAgent }) || this;
+    }
+    return PhinHttpProxyClient;
+}(PhinHttpClient_1.PhinHttpClient));
+exports.PhinHttpProxyClient = PhinHttpProxyClient;

package/lib/cjs/impl/http/phin/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./PhinIncomingResponse.js"), exports);
 __exportStar(require("./PhinHttpClient.js"), exports);
+__exportStar(require("./PhinHttpProxyClient.js"), exports);

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.34.0';
+exports.CORE_MODULE_VERSION = 'JS Core 0.35.0';

package/lib/esm/config/ConfigurationBase.js

@@ -409,6 +409,9 @@ export class ConfigurationBase {
     get dataEnrichmentHeaderName() {
         return this.configParams.px_data_enrichment_header_name;
     }
+    get proxyUrl() {
+        return this.configParams.px_proxy_url;
+    }
     get enableBlockedUrlOnCaptchaBlockPage() {
         return true;
     }

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

@@ -132,6 +132,7 @@ export const defaultConfigurationParams = () => ({
     px_data_enrichment_header_name: '',
     px_snippet_injection_enabled: false,
     px_create_custom_snippet: null,
+    px_proxy_url: '',
     px_custom_is_sensitive_request: null,
     px_custom_is_monitored_request: null,
     px_custom_is_enforced_request: null,

package/lib/esm/impl/http/phin/PhinHttpClient.js

@@ -2,12 +2,14 @@ import { Agent as HttpAgent } from 'http';
 import { Agent as HttpsAgent } from 'https';
 import phin from 'phin';
 import { EnforcerTimeoutError } from '../../../utils/index.js';
-import { joinHeaderValues, } from '../../../http/interfaces/index.js';
+import { joinHeaderValues } from '../../../http/index.js';
 import { PhinIncomingResponse } from './PhinIncomingResponse.js';
 export class PhinHttpClient {
-    httpsKeepAliveAgent;
-    constructor() {
-        this.httpsKeepAliveAgent = new HttpsAgent({ keepAlive: true });
+    httpAgent;
+    httpsAgent;
+    constructor(options) {
+        this.httpAgent = options?.httpAgent ?? null;
+        this.httpsAgent = options?.httpsAgent ?? new HttpsAgent({ keepAlive: true });
     }
     async send(request, options) {
         try {
@@ -18,7 +20,7 @@ export class PhinHttpClient {
                 data: request.body,
                 timeout: options?.timeoutMs,
                 core: {
-                    agent: request.url.startsWith('https://') ? this.httpsKeepAliveAgent : new HttpAgent(),
+                    agent: this.getAgent(request),
                 },
             });
             return new PhinIncomingResponse(res);
@@ -28,4 +30,13 @@ export class PhinHttpClient {
             throw isTimeout ? new EnforcerTimeoutError(options?.timeoutMs) : e;
         }
     }
+    getAgent(request) {
+        if (request.url.startsWith('https://')) {
+            return this.httpsAgent;
+        }
+        if (this.httpAgent) {
+            return this.httpAgent;
+        }
+        return new HttpAgent();
+    }
 }

package/lib/esm/impl/http/phin/PhinHttpProxyClient.js

@@ -0,0 +1,10 @@
+import { PhinHttpClient } from './PhinHttpClient.js';
+import { HttpProxyAgent } from 'http-proxy-agent';
+import { HttpsProxyAgent } from 'https-proxy-agent';
+export class PhinHttpProxyClient extends PhinHttpClient {
+    constructor(proxyUrl) {
+        const httpAgent = new HttpProxyAgent(proxyUrl, { keepAlive: true });
+        const httpsAgent = new HttpsProxyAgent(proxyUrl, { keepAlive: true });
+        super({ httpsAgent, httpAgent });
+    }
+}

package/lib/esm/impl/http/phin/index.js

@@ -1,2 +1,3 @@
 export * from './PhinIncomingResponse.js';
 export * from './PhinHttpClient.js';
+export * from './PhinHttpProxyClient.js';

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.34.0';
+export const CORE_MODULE_VERSION = 'JS Core 0.35.0';

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

@@ -1,5 +1,5 @@
 import { IConfiguration } from './IConfiguration';
-import { RemoteConfigurationParams, StaticConfigurationParams, AllConfigurationParams, RequiredAllConfigurationParams, ActiveConfigurationParams, CoreConfigurationParams } from './params';
+import { RemoteConfigurationParams, StaticConfigurationParams, AllConfigurationParams, RequiredAllConfigurationParams, ActiveConfigurationParams, CoreConfigurationParams, CoreConfigurationParamsKeys } from './params';
 import { CustomParametersFunction, ResponseCustomParametersFunction } from '../custom_parameters';
 import { AdditionalActivityHandler } from '../additional_activity_handler';
 import { ILogger, LoggerSeverity } from '../logger';
@@ -11,6 +11,11 @@ import { ExtractGraphQLKeywordsFunction } from '../graphql';
 import { RemoteConfigData } from './remote_config';
 import { TokenVersion } from '../risk_token';
 import { CustomSnippetFunction } from '../snippet_injection';
+type EmptyObjectStrict = Record<PropertyKey, never>;
+type Unsupported<Supported extends string> = Exclude<CoreConfigurationParamsKeys, Supported>;
+type RemovedParams<Supported extends string> = Unsupported<Supported> extends never ? EmptyObjectStrict : {
+    [K in Unsupported<Supported>]: undefined;
+};
 /**
  * Base class for the enforcer configuration.
  */
@@ -19,7 +24,7 @@ export declare abstract class ConfigurationBase<Req, Res, Supported extends stri
     protected readonly staticConfigParams: StaticConfigurationParams<Req, Res, Supported, Added>;
     protected remoteConfigData?: RemoteConfigData<Req, Res, Supported, Added>;
     protected readonly defaultConfigParams: RequiredAllConfigurationParams<Req, Res, Supported, Added>;
-    protected readonly removedParams: Record<Exclude<keyof CoreConfigurationParams<Req, Res, Supported, Added>, Supported>, undefined>;
+    protected readonly removedParams: RemovedParams<Supported>;
     private internalLogger;
     /**
      * Returns the module version of the enforcer.
@@ -40,7 +45,7 @@ export declare abstract class ConfigurationBase<Req, Res, Supported extends stri
      * @param removedParams - A map of all removed (unsupported) configuration parameters set to undefined. This parameter can be generated automatically by your IDE.
      * @protected
      */
-    protected constructor(params: StaticConfigurationParams<Req, Res, Supported, Added>, defaultParams: Required<Added> & Partial<CoreConfigurationParams<Req, Res, Supported, Added>>, removedParams: Record<Exclude<keyof CoreConfigurationParams<Req, Res, Supported, Added>, Supported>, undefined>);
+    protected constructor(params: StaticConfigurationParams<Req, Res, Supported, Added>, defaultParams: Required<Added> & Partial<CoreConfigurationParams<Req, Res, Supported, Added>>, removedParams: RemovedParams<Supported>);
     protected createActiveConfiguration(params: AllConfigurationParams<Req, Res, Supported, Added>, defaultParams: RequiredAllConfigurationParams<Req, Res, Supported, Added>): RequiredAllConfigurationParams<Req, Res, Supported, Added>;
     protected throwIfMissingRequiredField(params: AllConfigurationParams<Req, Res, Supported, Added>): void;
     protected getValidConfigValue<K extends keyof RequiredAllConfigurationParams<Req, Res, Supported, Added>, V extends RequiredAllConfigurationParams<Req, Res, Supported, Added>[K]>(params: AllConfigurationParams<Req, Res, Supported, Added>, defaultParams: RequiredAllConfigurationParams<Req, Res, Supported, Added>, key: K): V;
@@ -144,7 +149,9 @@ export declare abstract class ConfigurationBase<Req, Res, Supported extends stri
     get snippetInjectionEnabled(): boolean;
     get createCustomSnippet(): CustomSnippetFunction<Req, Res, Supported, Added> | null;
     get dataEnrichmentHeaderName(): string;
+    get proxyUrl(): string;
     get enableBlockedUrlOnCaptchaBlockPage(): boolean;
     get awaitAsyncHttpRequests(): boolean;
     get isPostEnforceEnabled(): boolean;
 }
+export {};

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

@@ -408,6 +408,10 @@ export interface IConfiguration<Req, Res, Supported extends string, Added> {
      * The header name to use when adding the data enrichment value as an incoming request header.
      */
     readonly dataEnrichmentHeaderName: string;
+    /**
+     * The URL to which all HUMAN requests will be proxied as a domain or IP:port (e.g., "http://example.proxy.net", "https://1.1.1.1:8888").
+     */
+    readonly proxyUrl: string;
     /**
      * Returns an object representation of the current configuration.
      */

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

@@ -121,6 +121,7 @@ export type CommonConfigurationParams<Req, Res, Supported extends string, Added>
     px_url_decode_reserved_characters?: boolean;
     px_secured_pxhd_enabled?: boolean;
     px_data_enrichment_header_name?: string;
+    px_proxy_url?: string;
     px_additional_activity_handler?: AdditionalActivityHandler<Req, Res, Supported, Added> | null;
     px_enrich_custom_parameters?: CustomParametersFunction<Req, Res, Supported, Added> | null;
     px_enrich_response_custom_parameters?: ResponseCustomParametersFunction<Req, Res, Supported, Added> | null;

package/lib/types/impl/http/phin/PhinHttpClient.d.ts

@@ -1,6 +1,14 @@
-import { HttpSendOptions, IHttpClient, IIncomingResponse, IOutgoingRequest } from '../../../http/interfaces';
+import { Agent as HttpAgent } from 'http';
+import { Agent as HttpsAgent } from 'https';
+import { HttpSendOptions, IHttpClient, IIncomingResponse, IOutgoingRequest } from '../../../http';
+export type PhinHttpClientOptions = {
+    httpAgent?: HttpAgent;
+    httpsAgent?: HttpsAgent;
+};
 export declare class PhinHttpClient implements IHttpClient {
-    private readonly httpsKeepAliveAgent;
-    constructor();
+    private readonly httpAgent;
+    private readonly httpsAgent;
+    constructor(options?: PhinHttpClientOptions);
     send(request: IOutgoingRequest, options?: HttpSendOptions): Promise<IIncomingResponse>;
+    protected getAgent(request: IOutgoingRequest): HttpAgent;
 }

package/lib/types/impl/http/phin/PhinHttpProxyClient.d.ts

@@ -0,0 +1,4 @@
+import { PhinHttpClient } from './PhinHttpClient';
+export declare class PhinHttpProxyClient extends PhinHttpClient {
+    constructor(proxyUrl: string);
+}

package/lib/types/impl/http/phin/index.d.ts

@@ -1,2 +1,3 @@
 export * from './PhinIncomingResponse';
 export * from './PhinHttpClient';
+export * from './PhinHttpProxyClient';

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.34.0";
+export declare const CORE_MODULE_VERSION = "JS Core 0.35.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "perimeterx-js-core",
-  "version": "0.34.0",
+  "version": "0.35.0",
   "description": "",
   "type": "module",
   "typesVersions": {
@@ -44,6 +44,8 @@
   },
   "dependencies": {
     "crypto-js": "^4.1.1",
+    "http-proxy-agent": "^7.0.2",
+    "https-proxy-agent": "^7.0.6",
     "ip-range-check": "^0.2.0",
     "js-base64": "^3.7.2",
     "phin": "^3.7.0",
@@ -61,7 +63,7 @@
     "@typescript-eslint/eslint-plugin": "^8.38.0",
     "@typescript-eslint/parser": "^8.26.0",
     "c8": "^10.1.3",
-    "chai": "^5.2.0",
+    "chai": "^6.2.0",
     "chai-as-promised": "^8.0.0",
     "core-js": "^3.19.1",
     "eslint": "^9.21.0",