perimeterx-js-core 0.25.0 → 0.26.1

package/lib/cjs/action/Action.js

@@ -1,10 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Action = void 0;
+/**
+ * The action that should be taken by the enforcer.
+ */
 var Action;
 (function (Action) {
+    /**
+     * Indicates that the request should be allowed to pass.
+     */
     Action["PASS_REQUEST"] = "pass_request";
+    /**
+     * Indicates that there is not enough information to make a decision and a Risk API request should be made.
+     */
     Action["TRIGGER_RISK_API"] = "trigger_risk_api";
+    /**
+     * Indicates that the request should be blocked, but no block response will be returned.
+     */
     Action["SIMULATED_BLOCK"] = "simulated_block";
+    /**
+     * Indicates that the request should be blocked and a block response should be returned.
+     */
     Action["BLOCK"] = "block";
 })(Action || (exports.Action = Action = {}));

package/lib/cjs/action/ActionPriorityOrder.js

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ACTION_PRIORITY_ORDER = void 0;
 var Action_1 = require("./Action.js");
+/**
+ * The priority order of actions that the enforcer should take. The array will be traversed in order,
+ * and the first action that matches a product recommendation will be taken.
+ */
 exports.ACTION_PRIORITY_ORDER = [
     Action_1.Action.BLOCK,
     Action_1.Action.SIMULATED_BLOCK,

package/lib/cjs/action/utils.js

@@ -4,10 +4,20 @@ exports.getReasonForHighestPriorityProduct = exports.getDecisionFromActions = ex
 var Action_1 = require("./Action.js");
 var products_1 = require("../products/index.js");
 var ActionPriorityOrder_1 = require("./ActionPriorityOrder.js");
+/**
+ * Determines the final decision from the context.
+ * @param context - The request context.
+ * @returns Decision - The final action that should be taken and the associated products and reasons responsible for the decision.
+ */
 var getDecisionFromContext = function (context) {
     return (0, exports.getDecisionFromActions)((0, exports.getProductActions)(context));
 };
 exports.getDecisionFromContext = getDecisionFromContext;
+/**
+ * Determines all product recommended actions from the context.
+ * @param context - The request context.
+ * @returns ProductAction[] - An array of objects, representing the recommended action and reason of all relevant products.
+ */
 var getProductActions = function (context) {
     return Object.entries(context.productData)
         .filter(function (_a) {
@@ -24,6 +34,11 @@ var getProductActions = function (context) {
     });
 };
 exports.getProductActions = getProductActions;
+/**
+ * Reduces a list of ProductActions to a single Decision, taking into consideration the ACTION_PRIORITY_ORDER.
+ * @param productActions - All possible actions from all products.
+ * @returns Decision - The final action that should be taken and the associated products and reasons responsible for the decision.
+ */
 var getDecisionFromActions = function (productActions) {
     return createDecision(reduce(productActions));
 };
@@ -47,6 +62,11 @@ var createDecision = function (tally) {
     }
     return { action: Action_1.Action.PASS_REQUEST, reasons: {} };
 };
+/**
+ * Provided a mapping of product names to reasons, returns the reason associated with the highest priority product in the mapping.
+ * @param reasons - An object mapping any product names to their associated reasons.
+ * @returns string - The reason for the highest priority product, or 'unknown_reason' if none is found.
+ */
 var getReasonForHighestPriorityProduct = function (reasons) {
     for (var _i = 0, PRODUCT_PRIORITY_ORDER_1 = products_1.PRODUCT_PRIORITY_ORDER; _i < PRODUCT_PRIORITY_ORDER_1.length; _i++) {
         var productName = PRODUCT_PRIORITY_ORDER_1[_i];

package/lib/cjs/activities/HttpActivityClient.js

@@ -43,11 +43,24 @@ var utils_1 = require("../utils/index.js");
 var ActivityType_1 = require("./ActivityType.js");
 var utils_2 = require("./utils.js");
 var constants_1 = require("./constants.js");
+/**
+ * The HttpActivityClient is responsible for sending async activities to the backend via HTTP.
+ */
 var HttpActivityClient = /** @class */ (function () {
+    /**
+     * Creates an instance of HttpActivityClient.
+     * @param config
+     * @param httpClient
+     */
     function HttpActivityClient(config, httpClient) {
         this.config = config;
         this.httpClient = httpClient;
     }
+    /**
+     * Creates and sends all necessary async activities to the backend.
+     * @param context - The context containing the request (and possibly response).
+     * @returns {Promise<boolean>} - A boolean indicating if the activities were sent successfully.
+     */
     HttpActivityClient.prototype.sendActivities = function (context) {
         return __awaiter(this, void 0, void 0, function () {
             var activities, e_1;
@@ -56,6 +69,10 @@ var HttpActivityClient = /** @class */ (function () {
                     case 0:
                         _a.trys.push([0, 2, , 3]);
                         activities = this.createActivities(context);
+                        if (!activities || activities.length === 0) {
+                            context.logger.debug('no activities to send');
+                            return [2 /*return*/, true];
+                        }
                         return [4 /*yield*/, this.postActivities(activities, context.logger)];
                     case 1: return [2 /*return*/, _a.sent()];
                     case 2:
@@ -67,6 +84,12 @@ var HttpActivityClient = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Creates all async activities (block, page_requested, additional_s2s) that should be sent based on the context.
+     * @param context - The context containing the request (and possibly response).
+     * @returns {AsyncActivity[]} - An array of async activities to be sent.
+     * @protected
+     */
     HttpActivityClient.prototype.createActivities = function (context) {
         var activities = [];
         if (this.shouldCreateBlockActivity(context)) {
@@ -80,28 +103,58 @@ var HttpActivityClient = /** @class */ (function () {
         }
         return activities.map(this.finalizeActivity);
     };
+    /**
+     * Whether to create a block activity based on the context.
+     * @param context
+     * @protected
+     */
     HttpActivityClient.prototype.shouldCreateBlockActivity = function (context) {
         return context.action === action_1.Action.BLOCK || context.action === action_1.Action.SIMULATED_BLOCK;
     };
+    /**
+     * Whether to create a page_requested activity based on the context.
+     * @param context
+     * @protected
+     */
     HttpActivityClient.prototype.shouldCreatePageRequestedActivity = function (context) {
         return context.action === action_1.Action.PASS_REQUEST;
     };
+    /**
+     * Whether to create an additional_s2s activity based on the context.
+     * @param context
+     * @protected
+     */
     HttpActivityClient.prototype.shouldCreateAdditionalS2SActivity = function (context) {
         return (this.shouldCreatePageRequestedActivity(context) &&
             !!context.productData.ci &&
             this.config.ciAutomaticAdditionalS2SEnabled);
     };
+    /**
+     * Creates a block activity based on the context.
+     * @param context
+     * @protected
+     */
     HttpActivityClient.prototype.createBlockActivity = function (context) {
         return (0, utils_2.createAsyncActivity)(ActivityType_1.ActivityType.BLOCK, this.config, context);
     };
+    /**
+     * Creates a page_requested activity based on the context.
+     * @param context
+     * @protected
+     */
     HttpActivityClient.prototype.createPageRequestedActivity = function (context) {
         return (0, utils_2.createAsyncActivity)(ActivityType_1.ActivityType.PAGE_REQUESTED, this.config, context);
     };
+    /**
+     * Creates an additional_s2s activity based on the context.
+     * @param context
+     * @protected
+     */
     HttpActivityClient.prototype.createAdditionalS2SActivity = function (context) {
         return (0, utils_2.createAsyncActivity)(ActivityType_1.ActivityType.ADDITIONAL_S2S, this.config, context);
     };
     /**
-     * Allows for expansions or alterations to the async activity if needed.
+     * Allows for expansions or alterations to an async activity if needed. This applies to all created async activities.
      * @param activity
      * @returns AsyncActivity
      * @protected
@@ -109,6 +162,13 @@ var HttpActivityClient = /** @class */ (function () {
     HttpActivityClient.prototype.finalizeActivity = function (activity) {
         return activity;
     };
+    /**
+     * Sends the async activities to the backend.
+     * @param activities - The activities to be sent.
+     * @param logger - The logger instance for logging.
+     * @returns {Promise<boolean>} - A boolean indicating if the activities were sent successfully.
+     * @protected
+     */
     HttpActivityClient.prototype.postActivities = function (activities, logger) {
         return __awaiter(this, void 0, void 0, function () {
             var url, method, headers, body, req, res;

package/lib/cjs/activities/HttpBatchedActivityClient.js

@@ -53,6 +53,13 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HttpBatchedActivityClient = void 0;
 var HttpActivityClient_1 = require("./HttpActivityClient.js");
+/**
+ * The HttpBatchedActivityClient is responsible for sending async activities to the backend via HTTP in batches.
+ * It extends the HttpActivityClient class and adds functionality for batching activities.
+ *
+ * This class uses setTimeout and clearTimeout for managing the timeout for sending activities. It also exposes the stop()
+ * method to stop the timer and prevent further activity sending, which should be called on shutdown.
+ */
 var HttpBatchedActivityClient = /** @class */ (function (_super) {
     __extends(HttpBatchedActivityClient, _super);
     function HttpBatchedActivityClient(config, httpClient) {

package/lib/cjs/activities/utils.js

@@ -7,6 +7,13 @@ var products_1 = require("../products/index.js");
 var action_1 = require("../action/index.js");
 var ActivityType_1 = require("./ActivityType.js");
 var risk_token_1 = require("../risk_token/index.js");
+/**
+ * Creates an async activity object based on the provided parameters.
+ * @param activityType - The activity type to create.
+ * @param config - The enforcer configuration.
+ * @param context - The request context.
+ * @returns {AsyncActivity} - The complete async activity payload.
+ */
 var createAsyncActivity = function (activityType, config, context) {
     var _a;
     return {
@@ -24,6 +31,13 @@ var createAsyncActivity = function (activityType, config, context) {
     };
 };
 exports.createAsyncActivity = createAsyncActivity;
+/**
+ * Creates activity details based on the provided parameters.
+ * @param activityType - The activity type to create.
+ * @param config - The enforcer configuration.
+ * @param context - The request context.
+ * @returns {AsyncActivityDetails} - The activity details.
+ */
 var createActivityDetails = function (activityType, config, context) {
     var commonActivityDetails = (0, exports.createCommonActivityDetails)(config, context);
     var commonAsyncActivityDetails = (0, exports.createAsyncActivityCommonDetails)(context);
@@ -70,13 +84,21 @@ var createCommonActivityDetails = function (config, context) {
 };
 exports.createCommonActivityDetails = createCommonActivityDetails;
 var addRootContextDataToDetails = function (details, context) {
-    (0, utils_1.transferExistingProperties)(context, details, {
-        requestId: 'request_id',
-        tokenOrigin: 'cookie_origin',
-        vidSource: 'enforcer_vid_source',
-        graphqlData: 'graphql_operations',
-        enforcerStartTime: 'enforcer_start_time',
-    });
+    if (context.requestId) {
+        details.request_id = context.requestId;
+    }
+    if (context.tokenOrigin) {
+        details.cookie_origin = context.tokenOrigin;
+    }
+    if (context.vidSource) {
+        details.enforcer_vid_source = context.vidSource;
+    }
+    if (context.graphqlData) {
+        details.graphql_operations = context.graphqlData;
+    }
+    if (context.enforcerStartTime) {
+        details.enforcer_start_time = context.enforcerStartTime;
+    }
     if (context.usedCookieSecret) {
         details.used_cookie_secret = redactCookieSecret(context.usedCookieSecret);
     }
@@ -86,10 +108,12 @@ function redactCookieSecret(secret) {
     return '***'.concat(secret.substring(secret.length - 3, secret.length));
 }
 var addConfigDataToDetails = function (details, config) {
-    (0, utils_1.transferExistingProperties)(config, details, {
-        remoteConfigId: 'remote_config_id',
-        remoteConfigVersion: 'remote_config_version',
-    });
+    if (config.remoteConfigId) {
+        details.remote_config_id = config.remoteConfigId;
+    }
+    if (config.remoteConfigVersion) {
+        details.remote_config_version = config.remoteConfigVersion;
+    }
 };
 exports.addConfigDataToDetails = addConfigDataToDetails;
 var addCustomParametersToDetails = function (details, customParameters) {
@@ -99,47 +123,81 @@ var addCustomParametersToDetails = function (details, customParameters) {
 };
 exports.addCustomParametersToDetails = addCustomParametersToDetails;
 var addProductDataToDetails = function (details, productData) {
-    (0, utils_1.transferExistingProperties)(productData.ad, details, {
-        appUserId: 'app_user_id',
-        additionalFields: 'jwt_additional_fields',
-        crossTabSession: 'cross_tab_session',
-    });
-    (0, utils_1.transferExistingProperties)(productData.ci, details, {
-        hashedUsername: 'user',
-        hashedPassword: 'pass',
-        ciVersion: 'ci_version',
-        ssoStep: 'sso_step',
-    });
-    (0, utils_1.transferExistingProperties)(productData.hsc, details, {
-        isTokenHscApproved: 'cpa',
-    });
+    if (productData.ad) {
+        if (productData.ad.appUserId) {
+            details.app_user_id = productData.ad.appUserId;
+        }
+        if (productData.ad.additionalFields) {
+            details.jwt_additional_fields = productData.ad.additionalFields;
+        }
+        if (productData.ad.crossTabSession) {
+            details.cross_tab_session = productData.ad.crossTabSession;
+        }
+    }
+    if (productData.ci) {
+        if (productData.ci.hashedUsername) {
+            details.user = productData.ci.hashedUsername;
+        }
+        if (productData.ci.hashedPassword) {
+            details.pass = productData.ci.hashedPassword;
+        }
+        if (productData.ci.ciVersion) {
+            details.ci_version = productData.ci.ciVersion;
+        }
+        if (productData.ci.ssoStep) {
+            details.sso_step = productData.ci.ssoStep;
+        }
+    }
+    if (productData.hsc) {
+        if (typeof productData.hsc.isTokenHscApproved === 'boolean') {
+            details.cpa = productData.hsc.isTokenHscApproved;
+        }
+    }
 };
 exports.addProductDataToDetails = addProductDataToDetails;
 var addTlsDataToDetails = function (details, tlsData) {
-    (0, utils_1.transferExistingProperties)(tlsData, details, {
-        tlsProtocol: 'tls_protocol',
-        tlsServer: 'tls_server',
-        tlsCipher: 'tls_cipher',
-        tlsCiphersSha: 'tls_ciphers_sha',
-        tlsExtensionSha: 'tls_extension_sha',
-        tlsPreferredCiphers: 'tls_preferred_ciphers',
-        tlsJa3Fingerprint: 'tls_ja3_fingerprint',
-    });
+    if (tlsData.tlsCipher) {
+        details.tls_cipher = tlsData.tlsCipher;
+    }
+    if (tlsData.tlsCiphersSha) {
+        details.tls_ciphers_sha = tlsData.tlsCiphersSha;
+    }
+    if (tlsData.tlsExtensionSha) {
+        details.tls_extension_sha = tlsData.tlsExtensionSha;
+    }
+    if (tlsData.tlsPreferredCiphers) {
+        details.tls_preferred_ciphers = tlsData.tlsPreferredCiphers;
+    }
+    if (tlsData.tlsJa3Fingerprint) {
+        details.tls_ja3_fingerprint = tlsData.tlsJa3Fingerprint;
+    }
+    if (tlsData.tlsProtocol) {
+        details.tls_protocol = tlsData.tlsProtocol;
+    }
+    if (tlsData.tlsServer) {
+        details.tls_server = tlsData.tlsServer;
+    }
 };
 exports.addTlsDataToDetails = addTlsDataToDetails;
 var addServerDataToDetails = function (details, serverData) {
-    (0, utils_1.transferExistingProperties)(serverData, details, {
-        region: 'server_info_region',
-        datacenter: 'server_info_datacenter',
-    });
+    if (serverData.datacenter) {
+        details.server_info_datacenter = serverData.datacenter;
+    }
+    if (serverData.region) {
+        details.server_info_region = serverData.region;
+    }
 };
 exports.addServerDataToDetails = addServerDataToDetails;
 var addRequestDataToDetails = function (details, requestData) {
-    (0, utils_1.transferExistingProperties)(requestData, details, {
-        httpVersion: 'http_version',
-        method: 'http_method',
-        requestCookieNames: 'request_cookie_names',
-    });
+    if (requestData.httpVersion) {
+        details.http_version = requestData.httpVersion;
+    }
+    if (requestData.method) {
+        details.http_method = requestData.method;
+    }
+    if (requestData.requestCookieNames) {
+        details.request_cookie_names = requestData.requestCookieNames.concat();
+    }
     if (requestData.isUrlDifferentFromRawUrl) {
         details.raw_url = requestData.rawUrl;
     }
@@ -157,10 +215,12 @@ var addTokenDataToDetails = function (details, _a) {
         }
     }
     if (mobileData) {
-        (0, utils_1.transferExistingProperties)(mobileData, details, {
-            originalToken: 'original_token',
-            decodedOriginalToken: 'px_decoded_original_token',
-        });
+        if (mobileData.originalToken) {
+            details.original_token = mobileData.originalToken.tokenString;
+        }
+        if (mobileData.decodedOriginalToken) {
+            details.px_decoded_original_token = mobileData.decodedOriginalToken;
+        }
         if (mobileData.originalTokenParseResult === risk_token_1.TokenParseResult.DECRYPTION_FAILED) {
             details.original_token_error = 'cookie_decryption_failed';
         }
@@ -172,11 +232,15 @@ var addTokenDataToDetails = function (details, _a) {
 exports.addTokenDataToDetails = addTokenDataToDetails;
 var addRiskApiDataToAsyncActivityCommonDetails = function (details, context) {
     var _a;
-    (0, utils_1.transferExistingProperties)(context.riskApiData, details, {
-        riskRtt: 'risk_rtt',
-        s2sCallReason: 's2s_call_reason',
-        riskStartTime: 'risk_start_time',
-    });
+    if (context.riskApiData.riskRtt) {
+        details.risk_rtt = context.riskApiData.riskRtt;
+    }
+    if (context.riskApiData.s2sCallReason) {
+        details.s2s_call_reason = context.riskApiData.s2sCallReason;
+    }
+    if (context.riskApiData.riskStartTime) {
+        details.risk_start_time = context.riskApiData.riskStartTime;
+    }
     if ((_a = context.riskApiData.riskResponse) === null || _a === void 0 ? void 0 : _a.additionalRiskInfo) {
         details.additional_risk_info = context.riskApiData.riskResponse.additionalRiskInfo;
     }
@@ -186,10 +250,9 @@ var addRiskApiDataToAsyncActivityCommonDetails = function (details, context) {
 };
 exports.addRiskApiDataToAsyncActivityCommonDetails = addRiskApiDataToAsyncActivityCommonDetails;
 var addResponseDataToAsyncActivityCommonDetails = function (details, context) {
-    if (context.action !== action_1.Action.BLOCK) {
-        (0, utils_1.transferExistingProperties)(context.response, details, {
-            status: 'http_status_code',
-        });
+    var _a;
+    if (context.action !== action_1.Action.BLOCK && ((_a = context.response) === null || _a === void 0 ? void 0 : _a.status)) {
+        details.http_status_code = context.response.status;
     }
 };
 exports.addResponseDataToAsyncActivityCommonDetails = addResponseDataToAsyncActivityCommonDetails;
@@ -197,11 +260,15 @@ var createPageRequestedActivityDetails = function (context) {
     var 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',
-        errorMessage: 'error_message',
-    });
+    if (context.riskApiData.errorReason) {
+        details.s2s_error_reason = context.riskApiData.errorReason;
+    }
+    if (context.riskApiData.errorHttpStatus) {
+        details.s2s_error_http_status = context.riskApiData.errorHttpStatus;
+    }
+    if (context.riskApiData.errorMessage) {
+        details.error_message = context.riskApiData.errorMessage;
+    }
     return details;
 };
 exports.createPageRequestedActivityDetails = createPageRequestedActivityDetails;
@@ -210,7 +277,6 @@ var createBlockActivityDetails = function (context) {
         block_reason: (0, action_1.getReasonForHighestPriorityProduct)(context.reasons),
         simulated_block: context.action === action_1.Action.SIMULATED_BLOCK,
         block_action: context.blockAction,
-        // @ts-ignore
         block_score: context.score,
     };
 };

package/lib/cjs/additional_activity_handler/AdditionalActivityHandlerUtils.js

@@ -40,6 +40,12 @@ exports.AdditionalActivityHandlerUtils = void 0;
 var AdditionalActivityHandlerUtils;
 (function (AdditionalActivityHandlerUtils) {
     var _this = this;
+    /**
+     * Invokes the additional activity handler if it is defined in the configuration.
+     * @param config - The enforcer configuration.
+     * @param context - The request context.
+     * @returns {Promise<void>} - A promise that resolves when the additional activity handler is complete.
+     */
     AdditionalActivityHandlerUtils.invokeAdditionalActivityHandler = function (config, context) { return __awaiter(_this, void 0, void 0, function () {
         var e_1;
         return __generator(this, function (_a) {

package/lib/cjs/blocker/BlockerBase.js

@@ -2,12 +2,26 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BlockerBase = void 0;
 var http_1 = require("../http/index.js");
+/**
+ * Base class for creating a block response.
+ */
 var BlockerBase = /** @class */ (function () {
+    /**
+     * Creates a new instance of BlockerBase.
+     * @param contentType - The Content-Type header to be included in the HTTP block response.
+     * @param statusCode - The status code of the HTTP block response.
+     * @protected
+     */
     function BlockerBase(contentType, statusCode) {
         if (statusCode === void 0) { statusCode = 403; }
         this.contentType = contentType;
         this.statusCode = statusCode;
     }
+    /**
+     * Creates the complete HTTP block response based on the given context.
+     * @param context - The request context.
+     * @returns {IMinimalResponse} - The HTTP block response.
+     */
     BlockerBase.prototype.createBlockResponse = function (context) {
         var status = this.statusCode;
         var headers = this.createHeaders();

package/lib/cjs/blocker/JsonBlockerBase.js

@@ -18,6 +18,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.JsonBlockerBase = void 0;
 var BlockerBase_1 = require("./BlockerBase.js");
 var http_1 = require("../http/index.js");
+/**
+ * Base class for creating a block response with JSON payload.
+ *
+ * The generic argument JsonPayloadT is the specific structure of the JSON payload to be returned.
+ */
 var JsonBlockerBase = /** @class */ (function (_super) {
     __extends(JsonBlockerBase, _super);
     function JsonBlockerBase() {

package/lib/cjs/blocker/utils.js

@@ -2,6 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createBlockData = exports.renderHtml = void 0;
 var products_1 = require("../products/index.js");
+/**
+ * Renders the HTML template with the provided block data.
+ * @param htmlTemplate - The HTML template to be rendered. Placeholders are indicated with {{key_name}} where the key_name should be keyof BlockData.
+ * @param blockData - The block data to be used for rendering. The keys in the object should match the placeholders in the template.
+ * @returns {string} - The final HTML string. If no block data is provided, the original template is returned unchanged.
+ */
 var renderHtml = function (htmlTemplate, blockData) {
     if (!blockData) {
         return htmlTemplate;
@@ -15,6 +21,13 @@ var renderHtml = function (htmlTemplate, blockData) {
     return htmlTemplate;
 };
 exports.renderHtml = renderHtml;
+/**
+ * Creates the block data object to be used when creating a block response.
+ * @param config - The enforcer configuration.
+ * @param context - The request context.
+ * @param base64Utils - The base64 utility functions.
+ * @returns {BlockData} - The block data object.
+ */
 var createBlockData = function (config, context, base64Utils) {
     var captchaScriptSuffix = '/captcha.js';
     var b64EncodedUrl = config.enableBlockedUrlOnCaptchaBlockPage

package/lib/cjs/config/ConfigurationBase.js

@@ -17,7 +17,17 @@ var logger_1 = require("../logger/index.js");
 var utils_1 = require("../utils/index.js");
 var remote_config_1 = require("./remote_config/index.js");
 var risk_token_1 = require("../risk_token/index.js");
+/**
+ * Base class for the enforcer configuration.
+ */
 var ConfigurationBase = /** @class */ (function () {
+    /**
+     * Creates an instance of the configuration base class.
+     * @param params - The configuration parameters as provided by the customer.
+     * @param defaultParams - Default parameters for added configurations or any default core configurations that should be overridden.
+     * @param removedParams - A map of all removed (unsupported) configuration parameters set to undefined. This parameter can be generated automatically by your IDE.
+     * @protected
+     */
     function ConfigurationBase(params, defaultParams, removedParams) {
         this.defaultConfigParams = __assign(__assign({}, (0, defaults_1.defaultConfigurationParams)()), defaultParams);
         this.configParams = this.createActiveConfiguration(params, this.defaultConfigParams);
@@ -741,6 +751,13 @@ var ConfigurationBase = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(ConfigurationBase.prototype, "isPostEnforceEnabled", {
+        get: function () {
+            return true;
+        },
+        enumerable: false,
+        configurable: true
+    });
     return ConfigurationBase;
 }());
 exports.ConfigurationBase = ConfigurationBase;

package/lib/cjs/context/DefaultContext.js

@@ -20,6 +20,10 @@ var http_1 = require("../http/index.js");
 var utils_1 = require("../utils/index.js");
 var action_1 = require("../action/index.js");
 var logger_1 = require("../logger/index.js");
+/**
+ * The default implementation of the request context which uses the incoming HTTP request and enforcer configuration
+ * to populate the context with relevant data.
+ */
 var DefaultContext = /** @class */ (function () {
     function DefaultContext(config, request, options) {
         this._shouldSendLogs = false;

package/lib/cjs/context/SerializedContext.js

@@ -15,6 +15,11 @@ exports.SerializedContext = void 0;
 var logger_1 = require("../logger/index.js");
 var risk_token_1 = require("../risk_token/index.js");
 var risk_api_1 = require("../risk_api/index.js");
+/**
+ * Implements the `IContext` interface based an already serialized `ContextJson`. This class does not extract data from the
+ * incoming request, but rather uses already-extracted data from the `ContextJson` (likely returned from the `DefaultContext.toJSON()`
+ * function) and fills in the gaps using the other parameters.
+ */
 var SerializedContext = /** @class */ (function () {
     function SerializedContext(config, contextJson, request, urlUtils) {
         var _a;