perimeterx-js-core 0.9.0 → 0.11.0

package/README.md

@@ -60,7 +60,7 @@ your enforcer's configuration setup.
 `IConfiguration` - Represents the enforcer configuration and is required to construct most other components
 in this library.
 
-`StaticConfigurationBase` - An implementation of the above interface that validates provided configurations and merges
+`ConfigurationBase` - An implementation of the above interface that validates provided configurations and merges
 them with default ones.
 
 `DefaultConfigurations` - A static object complete with all default enforcer configurations.

package/lib/cjs/action/utils.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDecisionFromActions = exports.getProductActions = exports.getDecisionFromContext = void 0;
+exports.getReasonForHighestPriorityProduct = exports.getDecisionFromActions = exports.getProductActions = exports.getDecisionFromContext = void 0;
 var Action_1 = require("./Action");
+var products_1 = require("../products");
 var ActionPriorityOrder_1 = require("./ActionPriorityOrder");
 var getDecisionFromContext = function (context) {
     return (0, exports.getDecisionFromActions)((0, exports.getProductActions)(context));
@@ -46,3 +47,7 @@ var createDecision = function (tally) {
     }
     return { action: Action_1.Action.PASS_REQUEST };
 };
+var getReasonForHighestPriorityProduct = function (reasons) {
+    return reasons[products_1.PRODUCT_PRIORITY_ORDER.find(function (product) { return !!reasons[product]; })];
+};
+exports.getReasonForHighestPriorityProduct = getReasonForHighestPriorityProduct;

package/lib/cjs/activities/utils.js

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toHeaderEntryArray = exports.createAdditionalS2SActivityDetails = exports.createBlockActivityDetails = exports.createPageRequestedActivityDetails = exports.addResponseDataToAsyncActivityCommonDetails = exports.addRiskApiDataToAsyncActivityCommonDetails = exports.addTokenDataToDetails = exports.addRequestDataToDetails = exports.addServerDataToDetails = exports.addTlsDataToDetails = exports.addProductDataToDetails = exports.addCustomParametersToDetails = exports.addRootContextDataToDetails = exports.createCommonActivityDetails = exports.createAsyncActivityCommonDetails = exports.createActivityDetails = exports.createAsyncActivity = void 0;
+exports.toHeaderEntryArray = exports.createAdditionalS2SActivityDetails = exports.createBlockActivityDetails = exports.createPageRequestedActivityDetails = exports.addResponseDataToAsyncActivityCommonDetails = exports.addRiskApiDataToAsyncActivityCommonDetails = exports.addTokenDataToDetails = exports.addRequestDataToDetails = exports.addServerDataToDetails = exports.addTlsDataToDetails = exports.addProductDataToDetails = exports.addCustomParametersToDetails = exports.addConfigDataToDetails = exports.addRootContextDataToDetails = exports.createCommonActivityDetails = exports.createAsyncActivityCommonDetails = exports.createActivityDetails = exports.createAsyncActivity = void 0;
 var utils_1 = require("../utils");
 var products_1 = require("../products");
-var blocker_1 = require("../blocker");
 var action_1 = require("../action");
 var ActivityType_1 = require("./ActivityType");
 var risk_token_1 = require("../risk_token");
@@ -58,6 +57,7 @@ var createCommonActivityDetails = function (config, context) {
         // Note: risk_mode currently reflects only Bot Defender mode
         risk_mode: ((_a = context.productData.bd) === null || _a === void 0 ? void 0 : _a.isMonitoredRequest) ? utils_1.ModuleMode.MONITOR : utils_1.ModuleMode.ACTIVE_BLOCKING,
     };
+    (0, exports.addConfigDataToDetails)(details, config);
     (0, exports.addRootContextDataToDetails)(details, context);
     (0, exports.addRequestDataToDetails)(details, context.requestData);
     (0, exports.addTokenDataToDetails)(details, context.tokenData);
@@ -77,6 +77,12 @@ var addRootContextDataToDetails = function (details, context) {
     });
 };
 exports.addRootContextDataToDetails = addRootContextDataToDetails;
+var addConfigDataToDetails = function (details, config) {
+    if (config.remoteConfigVersion) {
+        details.remote_config_version = config.remoteConfigVersion;
+    }
+};
+exports.addConfigDataToDetails = addConfigDataToDetails;
 var addCustomParametersToDetails = function (details, customParameters) {
     if (customParameters) {
         Object.assign(details, customParameters);
@@ -95,6 +101,9 @@ var addProductDataToDetails = function (details, productData) {
         ciVersion: 'ci_version',
         ssoStep: 'sso_step',
     });
+    (0, utils_1.transferExistingProperties)(productData.hsc, details, {
+        isTokenHscApproved: 'cpa',
+    });
 };
 exports.addProductDataToDetails = addProductDataToDetails;
 var addTlsDataToDetails = function (details, tlsData) {
@@ -171,9 +180,7 @@ var addResponseDataToAsyncActivityCommonDetails = function (details, context) {
 exports.addResponseDataToAsyncActivityCommonDetails = addResponseDataToAsyncActivityCommonDetails;
 var createPageRequestedActivityDetails = function (context) {
     var details = {};
-    details.pass_reason = Object.values(context.reasons)
-        .filter(function (x) { return x; })
-        .join(', ');
+    details.pass_reason = (0, action_1.getReasonForHighestPriorityProduct)(context.reasons);
     (0, utils_1.transferExistingProperties)(context.riskApiData, details, {
         errorReason: 's2s_error_reason',
         errorHttpStatus: 's2s_error_http_status',
@@ -183,10 +190,8 @@ var createPageRequestedActivityDetails = function (context) {
 };
 exports.createPageRequestedActivityDetails = createPageRequestedActivityDetails;
 var createBlockActivityDetails = function (context) {
-    var _a;
     var details = {};
-    var blockingProduct = blocker_1.BLOCK_ACTION_TO_PRODUCT_MAP.get(context.blockAction);
-    details.block_reason = (_a = context.reasons) === null || _a === void 0 ? void 0 : _a[blockingProduct];
+    details.block_reason = (0, action_1.getReasonForHighestPriorityProduct)(context.reasons);
     details.simulated_block = context.action === action_1.Action.SIMULATED_BLOCK;
     (0, utils_1.transferExistingProperties)(context, details, {
         blockAction: 'block_action',

package/lib/cjs/blocker/BlockerBase.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlockerBase = void 0;
+var http_1 = require("../http");
+var BlockerBase = /** @class */ (function () {
+    function BlockerBase(contentType, statusCode) {
+        if (statusCode === void 0) { statusCode = 403; }
+        this.contentType = contentType;
+        this.statusCode = statusCode;
+    }
+    BlockerBase.prototype.createBlockResponse = function (context) {
+        var status = this.statusCode;
+        var headers = this.createHeaders(context);
+        var body = this.createBlockBody(context);
+        return new http_1.MinimalResponseImpl({
+            status: status,
+            headers: headers,
+            body: body,
+        });
+    };
+    BlockerBase.prototype.createHeaders = function (context) {
+        var _a;
+        return _a = {},
+            _a[http_1.CONTENT_TYPE_HEADER_NAME] = [this.contentType],
+            _a;
+    };
+    return BlockerBase;
+}());
+exports.BlockerBase = BlockerBase;

package/lib/cjs/blocker/JsonBlockerBase.js

@@ -0,0 +1,36 @@
+"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.JsonBlockerBase = void 0;
+var BlockerBase_1 = require("./BlockerBase");
+var http_1 = require("../http");
+var JsonBlockerBase = /** @class */ (function (_super) {
+    __extends(JsonBlockerBase, _super);
+    function JsonBlockerBase() {
+        return _super.call(this, http_1.ContentType.APPLICATION_JSON) || this;
+    }
+    JsonBlockerBase.prototype.shouldBlock = function (context) {
+        var acceptHeaderValue = context.requestData.request.headers.get(http_1.ACCEPT_HEADER_NAME) || '';
+        var acceptHeaderContainsJson = acceptHeaderValue === null || acceptHeaderValue === void 0 ? void 0 : acceptHeaderValue.split(',').some(function (value) { return value.toLowerCase() === http_1.ContentType.APPLICATION_JSON; });
+        return !context.isMobile && acceptHeaderContainsJson;
+    };
+    JsonBlockerBase.prototype.createBlockBody = function (context) {
+        return JSON.stringify(this.createJsonPayload(context));
+    };
+    return JsonBlockerBase;
+}(BlockerBase_1.BlockerBase));
+exports.JsonBlockerBase = JsonBlockerBase;

package/lib/cjs/blocker/MobileBlocker.js

@@ -0,0 +1,48 @@
+"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.MobileBlocker = void 0;
+var http_1 = require("../http");
+var blocker_1 = require("../blocker");
+var BlockerBase_1 = require("./BlockerBase");
+var MobileBlocker = /** @class */ (function (_super) {
+    __extends(MobileBlocker, _super);
+    function MobileBlocker(config, base64Utils, template) {
+        var _this = _super.call(this, http_1.ContentType.APPLICATION_JSON) || this;
+        _this.config = config;
+        _this.base64Utils = base64Utils;
+        _this.template = template;
+        return _this;
+    }
+    MobileBlocker.prototype.shouldBlock = function (context) {
+        return context.isMobile;
+    };
+    MobileBlocker.prototype.createBlockBody = function (context) {
+        var blockData = (0, blocker_1.createBlockData)(this.config, context);
+        var html = (0, blocker_1.renderHtml)(this.template, blockData);
+        return JSON.stringify({
+            action: blocker_1.BLOCK_ACTION_TO_WORD_MAP.get(blockData.blockAction),
+            uuid: blockData.uuid,
+            vid: blockData.vid,
+            appId: blockData.appId,
+            page: this.base64Utils.base64Encode(html),
+            collectorHost: this.config.backendCollectorUrl,
+        });
+    };
+    return MobileBlocker;
+}(BlockerBase_1.BlockerBase));
+exports.MobileBlocker = MobileBlocker;

package/lib/cjs/blocker/index.js

@@ -16,6 +16,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./IConditionalBlocker"), exports);
 __exportStar(require("./IBlocker"), exports);
-__exportStar(require("./BlockAction"), exports);
-__exportStar(require("./BlockActionToProductMap"), exports);
-__exportStar(require("./BlockActionToWordMap"), exports);
+__exportStar(require("./BlockerBase"), exports);
+__exportStar(require("./JsonBlockerBase"), exports);
+__exportStar(require("./MobileBlocker"), exports);
+__exportStar(require("./model"), exports);
+__exportStar(require("./utils"), exports);

package/lib/cjs/blocker/{BlockAction.js → model/BlockAction.js}

@@ -6,4 +6,6 @@ var BlockAction;
     BlockAction["CAPTCHA"] = "c";
     BlockAction["RATE_LIMIT"] = "r";
     BlockAction["CHALLENGE"] = "j";
+    BlockAction["HYPE_SALE_CHALLENGE"] = "hsc";
+    BlockAction["HYPE_SALE_CHALLENGE_LEGACY"] = "cp";
 })(BlockAction || (exports.BlockAction = BlockAction = {}));

package/lib/cjs/blocker/model/index.js

@@ -0,0 +1,19 @@
+"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("./BlockAction"), exports);
+__exportStar(require("./BlockActionToWordMap"), exports);
+__exportStar(require("./BlockData"), exports);

package/lib/cjs/{products/bot_defender/block → blocker}/utils.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createBlockData = exports.renderHtml = void 0;
-var utils_1 = require("../../../utils");
-var first_party_1 = require("../first_party");
+var utils_1 = require("../utils");
+var products_1 = require("../products");
 var renderHtml = function (htmlTemplate, blockData) {
     if (!blockData) {
         return htmlTemplate;
@@ -24,13 +24,14 @@ var createBlockData = function (config, context) {
     var blockScript = "".concat(config.backendCaptchaUrl, "/").concat(config.appId).concat(captchaScriptSuffix).concat(captchaParams);
     var hostUrl = config.backendCollectorUrl;
     if (config.firstPartyEnabled && !context.isMobile) {
-        jsClientSrc = (0, first_party_1.getMostCustomizedFirstPartyPath)(config, first_party_1.FirstPartySuffix.SENSOR);
-        blockScript = "".concat((0, first_party_1.getMostCustomizedFirstPartyPath)(config, first_party_1.FirstPartySuffix.CAPTCHA)).concat(config.customFirstPartyCaptchaEndpoint ? captchaParams : "".concat(captchaScriptSuffix).concat(captchaParams));
-        hostUrl = (0, first_party_1.getMostCustomizedFirstPartyPath)(config, first_party_1.FirstPartySuffix.XHR);
+        jsClientSrc = (0, products_1.getMostCustomizedFirstPartyPath)(config, products_1.FirstPartySuffix.SENSOR);
+        blockScript = "".concat((0, products_1.getMostCustomizedFirstPartyPath)(config, products_1.FirstPartySuffix.CAPTCHA)).concat(config.customFirstPartyCaptchaEndpoint ? captchaParams : "".concat(captchaScriptSuffix).concat(captchaParams));
+        hostUrl = (0, products_1.getMostCustomizedFirstPartyPath)(config, products_1.FirstPartySuffix.XHR);
     }
     var cssRef = config.cssRef ? "<link rel=\"stylesheet\" type=\"text/css\" href=\"".concat(config.cssRef, "\" />") : '';
     var jsRef = config.jsRef ? "<script src=\"".concat(config.jsRef, "\"></script>") : '';
     var altBlockScript = "".concat(config.altBackendCaptchaUrl, "/").concat(config.appId).concat(captchaScriptSuffix).concat(captchaParams);
+    var jsTemplateScriptSrc = "https://captcha.px-cdn.net/".concat(config.appId, "/checkpoint.js");
     return {
         appId: config.appId,
         vid: context.vid || ((_b = (_a = context.requestData) === null || _a === void 0 ? void 0 : _a.cookies) === null || _b === void 0 ? void 0 : _b[utils_1.PXVID_COOKIE_NAME]) || '',
@@ -45,6 +46,7 @@ var createBlockData = function (config, context) {
         firstPartyEnabled: config.firstPartyEnabled,
         blockScript: blockScript,
         altBlockScript: altBlockScript,
+        jsTemplateScriptSrc: jsTemplateScriptSrc,
     };
 };
 exports.createBlockData = createBlockData;