perimeterx-js-core 0.21.1 → 0.21.2

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

@@ -67,7 +67,7 @@ var BotDefender = /** @class */ (function () {
         this.firstParty =
             (_a = options.firstParty) !== null && _a !== void 0 ? _a : new first_party_1.DefaultBotDefenderFirstParty(config, { urlUtils: options.urlUtils });
         this.filter = (_b = options.filter) !== null && _b !== void 0 ? _b : new filter_1.DefaultBotDefenderFilter(config, options.ipRangeChecker);
-        this.blocker = (_c = options.blocker) !== null && _c !== void 0 ? _c : new block_1.DefaultBotDefenderBlocker(config, options.base64Utils);
+        this.blocker = (_c = options.blocker) !== null && _c !== void 0 ? _c : new block_1.DefaultBotDefenderBlocker(config, { base64Utils: options.base64Utils });
     }
     BotDefender.prototype.handleFirstPartyRequest = function (context) {
         return __awaiter(this, void 0, void 0, function () {

package/lib/cjs/products/bot_defender/block/DefaultBotDefenderBlocker.js

@@ -8,9 +8,18 @@ var utils_1 = require("../../utils");
 var captcha_1 = require("./captcha");
 var templates_1 = require("./templates");
 var DefaultBotDefenderBlocker = /** @class */ (function () {
-    function DefaultBotDefenderBlocker(config, base64Utils) {
+    function DefaultBotDefenderBlocker(config, options) {
         this.config = config;
-        this.captchaBlocker = new captcha_1.CaptchaBlocker(config, base64Utils);
+        if ('captchaBlocker' in options) {
+            this.captchaBlocker = options.captchaBlocker;
+        }
+        else {
+            this.captchaBlocker = new captcha_1.CaptchaBlocker({
+                config: config,
+                base64Utils: options.base64Utils,
+                captchaTemplate: templates_1.CAPTCHA_TEMPLATE,
+            });
+        }
     }
     DefaultBotDefenderBlocker.prototype.shouldBlock = function (_a) {
         var action = _a.action, reasons = _a.reasons, productData = _a.productData;

package/lib/cjs/products/bot_defender/block/captcha/CaptchaBlocker.js

@@ -5,11 +5,14 @@ var JsonCaptchaBlocker_1 = require("./JsonCaptchaBlocker");
 var MobileCaptchaBlocker_1 = require("./MobileCaptchaBlocker");
 var HtmlCaptchaBlocker_1 = require("./HtmlCaptchaBlocker");
 var CaptchaBlocker = /** @class */ (function () {
-    function CaptchaBlocker(config, base64Utils) {
-        this.config = config;
-        this.jsonCaptchaBlocker = new JsonCaptchaBlocker_1.JsonCaptchaBlocker(config, base64Utils);
-        this.mobileCaptchaBlocker = new MobileCaptchaBlocker_1.MobileCaptchaBlocker(config, base64Utils);
-        this.htmlCaptchaBlocker = new HtmlCaptchaBlocker_1.HtmlCaptchaBlocker(config, base64Utils);
+    function CaptchaBlocker(options) {
+        this.config = options.config;
+        this.jsonCaptchaBlocker =
+            'jsonCaptchaBlocker' in options ? options.jsonCaptchaBlocker : new JsonCaptchaBlocker_1.JsonCaptchaBlocker(options);
+        this.mobileCaptchaBlocker =
+            'mobileCaptchaBlocker' in options ? options.mobileCaptchaBlocker : new MobileCaptchaBlocker_1.MobileCaptchaBlocker(options);
+        this.htmlCaptchaBlocker =
+            'htmlCaptchaBlocker' in options ? options.htmlCaptchaBlocker : new HtmlCaptchaBlocker_1.HtmlCaptchaBlocker(options);
     }
     CaptchaBlocker.prototype.createBlockResponse = function (context) {
         if (this.mobileCaptchaBlocker.shouldBlock(context)) {

package/lib/cjs/products/bot_defender/block/captcha/HtmlCaptchaBlocker.js

@@ -21,14 +21,15 @@ var blocker_1 = require("../../../../blocker");
 var templates_1 = require("../templates");
 var HtmlCaptchaBlocker = /** @class */ (function (_super) {
     __extends(HtmlCaptchaBlocker, _super);
-    function HtmlCaptchaBlocker(config, base64Utils) {
+    function HtmlCaptchaBlocker(options) {
         var _this = _super.call(this, http_1.ContentType.TEXT_HTML) || this;
-        _this.config = config;
-        _this.base64Utils = base64Utils;
+        _this.config = options.config;
+        _this.base64Utils = options.base64Utils;
+        _this.captchaTemplate = options.captchaTemplate || templates_1.CAPTCHA_TEMPLATE;
         return _this;
     }
     HtmlCaptchaBlocker.prototype.createBlockBody = function (context) {
-        return (0, blocker_1.renderHtml)(templates_1.CAPTCHA_TEMPLATE, (0, blocker_1.createBlockData)(this.config, context, this.base64Utils));
+        return (0, blocker_1.renderHtml)(this.captchaTemplate, (0, blocker_1.createBlockData)(this.config, context, this.base64Utils));
     };
     return HtmlCaptchaBlocker;
 }(blocker_1.BlockerBase));

package/lib/cjs/products/bot_defender/block/captcha/JsonCaptchaBlocker.js

@@ -19,10 +19,10 @@ exports.JsonCaptchaBlocker = void 0;
 var blocker_1 = require("../../../../blocker");
 var JsonCaptchaBlocker = /** @class */ (function (_super) {
     __extends(JsonCaptchaBlocker, _super);
-    function JsonCaptchaBlocker(config, base64Utils) {
+    function JsonCaptchaBlocker(options) {
         var _this = _super.call(this) || this;
-        _this.config = config;
-        _this.base64Utils = base64Utils;
+        _this.config = options.config;
+        _this.base64Utils = options.base64Utils;
         return _this;
     }
     JsonCaptchaBlocker.prototype.shouldBlock = function (context) {

package/lib/cjs/products/bot_defender/block/captcha/MobileCaptchaBlocker.js

@@ -20,8 +20,8 @@ var blocker_1 = require("../../../../blocker");
 var templates_1 = require("../templates");
 var MobileCaptchaBlocker = /** @class */ (function (_super) {
     __extends(MobileCaptchaBlocker, _super);
-    function MobileCaptchaBlocker(config, base64Utils) {
-        return _super.call(this, config, base64Utils, templates_1.CAPTCHA_TEMPLATE) || this;
+    function MobileCaptchaBlocker(options) {
+        return _super.call(this, options.config, options.base64Utils, options.captchaTemplate || templates_1.CAPTCHA_TEMPLATE) || this;
     }
     return MobileCaptchaBlocker;
 }(blocker_1.MobileBlocker));

package/lib/cjs/utils/constants.js

@@ -14,4 +14,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]+))?)([\/]{0,1}[^?#]*)(\?[^#]*|)(#.*|)$/;
 exports.REGEX_STRUCTURE = /^\/(.+?)\/([gimsuyvd]*)$/;
-exports.CORE_MODULE_VERSION = 'JS Core 0.21.1';
+exports.CORE_MODULE_VERSION = 'JS Core 0.21.2';

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

@@ -20,7 +20,7 @@ export class BotDefender {
         this.firstParty =
             options.firstParty ?? new DefaultBotDefenderFirstParty(config, { urlUtils: options.urlUtils });
         this.filter = options.filter ?? new DefaultBotDefenderFilter(config, options.ipRangeChecker);
-        this.blocker = options.blocker ?? new DefaultBotDefenderBlocker(config, options.base64Utils);
+        this.blocker = options.blocker ?? new DefaultBotDefenderBlocker(config, { base64Utils: options.base64Utils });
     }
     async handleFirstPartyRequest(context) {
         return this.firstParty.handleFirstPartyRequest(context);

package/lib/esm/products/bot_defender/block/DefaultBotDefenderBlocker.js

@@ -3,13 +3,22 @@ import { BlockAction } from '../../../blocker';
 import { ContentType, CONTENT_TYPE_HEADER_NAME, MinimalResponseImpl } from '../../../http';
 import { ProductName } from '../../utils';
 import { CaptchaBlocker } from './captcha';
-import { RATE_LIMIT_TEMPLATE } from './templates';
+import { CAPTCHA_TEMPLATE, RATE_LIMIT_TEMPLATE } from './templates';
 export class DefaultBotDefenderBlocker {
     config;
     captchaBlocker;
-    constructor(config, base64Utils) {
+    constructor(config, options) {
         this.config = config;
-        this.captchaBlocker = new CaptchaBlocker(config, base64Utils);
+        if ('captchaBlocker' in options) {
+            this.captchaBlocker = options.captchaBlocker;
+        }
+        else {
+            this.captchaBlocker = new CaptchaBlocker({
+                config,
+                base64Utils: options.base64Utils,
+                captchaTemplate: CAPTCHA_TEMPLATE,
+            });
+        }
     }
     shouldBlock({ action, reasons, productData }) {
         return action === Action.BLOCK && !!reasons?.[ProductName.BOT_DEFENDER];

package/lib/esm/products/bot_defender/block/captcha/CaptchaBlocker.js

@@ -6,11 +6,14 @@ export class CaptchaBlocker {
     jsonCaptchaBlocker;
     mobileCaptchaBlocker;
     htmlCaptchaBlocker;
-    constructor(config, base64Utils) {
-        this.config = config;
-        this.jsonCaptchaBlocker = new JsonCaptchaBlocker(config, base64Utils);
-        this.mobileCaptchaBlocker = new MobileCaptchaBlocker(config, base64Utils);
-        this.htmlCaptchaBlocker = new HtmlCaptchaBlocker(config, base64Utils);
+    constructor(options) {
+        this.config = options.config;
+        this.jsonCaptchaBlocker =
+            'jsonCaptchaBlocker' in options ? options.jsonCaptchaBlocker : new JsonCaptchaBlocker(options);
+        this.mobileCaptchaBlocker =
+            'mobileCaptchaBlocker' in options ? options.mobileCaptchaBlocker : new MobileCaptchaBlocker(options);
+        this.htmlCaptchaBlocker =
+            'htmlCaptchaBlocker' in options ? options.htmlCaptchaBlocker : new HtmlCaptchaBlocker(options);
     }
     createBlockResponse(context) {
         if (this.mobileCaptchaBlocker.shouldBlock(context)) {

package/lib/esm/products/bot_defender/block/captcha/HtmlCaptchaBlocker.js

@@ -4,12 +4,14 @@ import { CAPTCHA_TEMPLATE } from '../templates';
 export class HtmlCaptchaBlocker extends BlockerBase {
     config;
     base64Utils;
-    constructor(config, base64Utils) {
+    captchaTemplate;
+    constructor(options) {
         super(ContentType.TEXT_HTML);
-        this.config = config;
-        this.base64Utils = base64Utils;
+        this.config = options.config;
+        this.base64Utils = options.base64Utils;
+        this.captchaTemplate = options.captchaTemplate || CAPTCHA_TEMPLATE;
     }
     createBlockBody(context) {
-        return renderHtml(CAPTCHA_TEMPLATE, createBlockData(this.config, context, this.base64Utils));
+        return renderHtml(this.captchaTemplate, createBlockData(this.config, context, this.base64Utils));
     }
 }

package/lib/esm/products/bot_defender/block/captcha/JsonCaptchaBlocker.js

@@ -2,10 +2,10 @@ import { BlockAction, createBlockData, JsonBlockerBase } from '../../../../block
 export class JsonCaptchaBlocker extends JsonBlockerBase {
     config;
     base64Utils;
-    constructor(config, base64Utils) {
+    constructor(options) {
         super();
-        this.config = config;
-        this.base64Utils = base64Utils;
+        this.config = options.config;
+        this.base64Utils = options.base64Utils;
     }
     shouldBlock(context) {
         if (!this.config.advancedBlockingResponseEnabled) {

package/lib/esm/products/bot_defender/block/captcha/MobileCaptchaBlocker.js

@@ -1,7 +1,7 @@
 import { MobileBlocker } from '../../../../blocker';
 import { CAPTCHA_TEMPLATE } from '../templates';
 export class MobileCaptchaBlocker extends MobileBlocker {
-    constructor(config, base64Utils) {
-        super(config, base64Utils, CAPTCHA_TEMPLATE);
+    constructor(options) {
+        super(options.config, options.base64Utils, options.captchaTemplate || CAPTCHA_TEMPLATE);
     }
 }

package/lib/esm/utils/constants.js

@@ -11,4 +11,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]+))?)([\/]{0,1}[^?#]*)(\?[^#]*|)(#.*|)$/;
 export const REGEX_STRUCTURE = /^\/(.+?)\/([gimsuyvd]*)$/;
-export const CORE_MODULE_VERSION = 'JS Core 0.21.1';
+export const CORE_MODULE_VERSION = 'JS Core 0.21.2';

package/lib/types/products/bot_defender/block/DefaultBotDefenderBlocker.d.ts

@@ -3,10 +3,15 @@ import { IConfiguration } from '../../../config';
 import { IBase64Utils } from '../../../utils';
 import { IBlocker, IConditionalBlocker } from '../../../blocker';
 import { IMinimalResponse } from '../../../http';
+export type DefaultBotDefenderBlockerConstructorOptions<Req, Res> = {
+    base64Utils: IBase64Utils;
+} | {
+    captchaBlocker: IBlocker<Req, Res>;
+};
 export declare class DefaultBotDefenderBlocker<Req, Res> implements IConditionalBlocker<Req, Res> {
     protected readonly config: IConfiguration<Req, Res>;
     protected readonly captchaBlocker: IBlocker<Req, Res>;
-    constructor(config: IConfiguration<Req, Res>, base64Utils: IBase64Utils);
+    constructor(config: IConfiguration<Req, Res>, options: DefaultBotDefenderBlockerConstructorOptions<Req, Res>);
     shouldBlock({ action, reasons, productData }: ReadonlyContext<Req, Res>): boolean;
     createBlockResponse(context: ReadonlyContext<Req, Res>): IMinimalResponse;
     protected createRateLimitResponse(): IMinimalResponse;

package/lib/types/products/bot_defender/block/captcha/CaptchaBlocker.d.ts

@@ -1,16 +1,28 @@
 import { IConfiguration } from '../../../../config';
 import { ReadonlyContext } from '../../../../context';
-import { IBase64Utils } from '../../../../utils';
-import { IBlocker } from '../../../../blocker';
+import { IBlocker, IConditionalBlocker } from '../../../../blocker';
 import { IMinimalResponse } from '../../../../http';
-import { JsonCaptchaBlocker } from './JsonCaptchaBlocker';
-import { MobileCaptchaBlocker } from './MobileCaptchaBlocker';
-import { HtmlCaptchaBlocker } from './HtmlCaptchaBlocker';
+import { JsonCaptchaBlockerConstructorOptions } from './JsonCaptchaBlocker';
+import { MobileCaptchaBlockerConstructorOptions } from './MobileCaptchaBlocker';
+import { HtmlCaptchaBlockerConstructorOptions } from './HtmlCaptchaBlocker';
+type JsonBlockerOptions<Req, Res> = {
+    jsonCaptchaBlocker: IConditionalBlocker<Req, Res>;
+} | JsonCaptchaBlockerConstructorOptions<Req, Res>;
+type MobileCaptchaBlockerOptions<Req, Res> = {
+    mobileCaptchaBlocker: IConditionalBlocker<Req, Res>;
+} | MobileCaptchaBlockerConstructorOptions<Req, Res>;
+type HtmlCaptchaBlockerOptions<Req, Res> = {
+    htmlCaptchaBlocker: IBlocker<Req, Res>;
+} | HtmlCaptchaBlockerConstructorOptions<Req, Res>;
+export type CaptchaBlockerConstructorOptions<Req, Res> = {
+    config: IConfiguration<Req, Res>;
+} & JsonBlockerOptions<Req, Res> & MobileCaptchaBlockerOptions<Req, Res> & HtmlCaptchaBlockerOptions<Req, Res>;
 export declare class CaptchaBlocker<Req, Res> implements IBlocker<Req, Res> {
     protected readonly config: IConfiguration<Req, Res>;
-    protected readonly jsonCaptchaBlocker: JsonCaptchaBlocker<Req, Res>;
-    protected readonly mobileCaptchaBlocker: MobileCaptchaBlocker<Req, Res>;
-    protected readonly htmlCaptchaBlocker: HtmlCaptchaBlocker<Req, Res>;
-    constructor(config: IConfiguration<Req, Res>, base64Utils: IBase64Utils);
+    protected readonly jsonCaptchaBlocker: IConditionalBlocker<Req, Res>;
+    protected readonly mobileCaptchaBlocker: IConditionalBlocker<Req, Res>;
+    protected readonly htmlCaptchaBlocker: IBlocker<Req, Res>;
+    constructor(options: CaptchaBlockerConstructorOptions<Req, Res>);
     createBlockResponse(context: ReadonlyContext<Req, Res>): IMinimalResponse;
 }
+export {};

package/lib/types/products/bot_defender/block/captcha/HtmlCaptchaBlocker.d.ts

@@ -2,9 +2,15 @@ import { IConfiguration } from '../../../../config';
 import { ReadonlyContext } from '../../../../context';
 import { IBase64Utils } from '../../../../utils';
 import { BlockerBase } from '../../../../blocker';
+export type HtmlCaptchaBlockerConstructorOptions<Req, Res> = {
+    config: IConfiguration<Req, Res>;
+    base64Utils: IBase64Utils;
+    captchaTemplate?: string;
+};
 export declare class HtmlCaptchaBlocker<Req, Res> extends BlockerBase<Req, Res> {
     protected readonly config: IConfiguration<Req, Res>;
     protected readonly base64Utils: IBase64Utils;
-    constructor(config: IConfiguration<Req, Res>, base64Utils: IBase64Utils);
+    protected readonly captchaTemplate: string;
+    constructor(options: HtmlCaptchaBlockerConstructorOptions<Req, Res>);
     protected createBlockBody(context: ReadonlyContext<Req, Res>): string;
 }

package/lib/types/products/bot_defender/block/captcha/JsonCaptchaBlocker.d.ts

@@ -3,10 +3,14 @@ import { ReadonlyContext } from '../../../../context';
 import { IConditionalBlocker, JsonBlockerBase } from '../../../../blocker';
 import { JsonCaptchaBlockPayload } from '../model';
 import { IBase64Utils } from '../../../../utils';
+export type JsonCaptchaBlockerConstructorOptions<Req, Res> = {
+    config: IConfiguration<Req, Res>;
+    base64Utils: IBase64Utils;
+};
 export declare class JsonCaptchaBlocker<Req, Res> extends JsonBlockerBase<Req, Res, JsonCaptchaBlockPayload> implements IConditionalBlocker<Req, Res> {
     protected readonly config: IConfiguration<Req, Res>;
     protected readonly base64Utils: IBase64Utils;
-    constructor(config: IConfiguration<Req, Res>, base64Utils: IBase64Utils);
+    constructor(options: JsonCaptchaBlockerConstructorOptions<Req, Res>);
     shouldBlock(context: ReadonlyContext<Req, Res>): boolean;
     protected createJsonPayload(context: ReadonlyContext<Req, Res>): JsonCaptchaBlockPayload;
 }

package/lib/types/products/bot_defender/block/captcha/MobileCaptchaBlocker.d.ts

@@ -1,6 +1,11 @@
 import { IConfiguration } from '../../../../config';
 import { IBase64Utils } from '../../../../utils';
 import { MobileBlocker } from '../../../../blocker';
+export type MobileCaptchaBlockerConstructorOptions<Req, Res> = {
+    config: IConfiguration<Req, Res>;
+    base64Utils: IBase64Utils;
+    captchaTemplate?: string;
+};
 export declare class MobileCaptchaBlocker<Req, Res> extends MobileBlocker<Req, Res> {
-    constructor(config: IConfiguration<Req, Res>, base64Utils: IBase64Utils);
+    constructor(options: MobileCaptchaBlockerConstructorOptions<Req, Res>);
 }

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

@@ -11,4 +11,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.21.1";
+export declare const CORE_MODULE_VERSION = "JS Core 0.21.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "perimeterx-js-core",
-  "version": "0.21.1",
+  "version": "0.21.2",
   "description": "",
   "type": "module",
   "typesVersions": {
@@ -48,7 +48,7 @@
     "js-base64": "^3.7.2",
     "phin": "^3.7.0",
     "ts-essentials": "^10.0.0",
-    "uuid": "^9.0.0"
+    "uuid": "^10.0.0"
   },
   "devDependencies": {
     "@types/chai": "^4.3.3",
@@ -56,7 +56,7 @@
     "@types/crypto-js": "^4.1.1",
     "@types/mocha": "^10.0.0",
     "@types/sinon": "^17.0.1",
-    "@types/uuid": "^9.0.2",
+    "@types/uuid": "^10.0.0",
     "@typescript-eslint/eslint-plugin": "^5.40.0",
     "@typescript-eslint/parser": "^5.40.0",
     "chai": "^4.3.6",