perimeterx-js-core 0.4.0 → 0.4.2

package/README.md

@@ -77,23 +77,20 @@ While you will need to create a custom implementation for the request context, y
 ### HTTP
 
 Every framework has a different API for creating and sending HTTP requests and responses. This library reduces this functionality
-into three interfaces:
+into several interfaces:
 
-`IHttpRequest` - Represents an HTTP request.
+`IIncomingRequest` - Represents an HTTP request from the user.
 
-`IHttpResponse` - Represents an HTTP response.
+`IOutgoingResponse` - Represents an HTTP response which is returned to the user.
 
-`IHttpClient` - Represents a client that can send an `IHttpRequest` and return an `IHttpResponse`.
+`IOutgoingRequest` - Represents an HTTP request that can be executed (sent to other origin)
 
-When developing your JavaScript/TypeScript enforcer with this library, you will need to wrap the native HTTP request/response
-objects such that they conform to these interfaces. Of course, you are free to extend these interfaces as needed.
+`IIncomingResponse` - Represents an HTTP response that received from sending `IOutgoingRequest`
 
-The `HttpRequestBase` and `HttpResponseBase` classes are also provided for minimizing code repetition, simplifying
-encapsulating request and response body handling to a single `IBodyReader` interface.
+`IHttpClient` - Represents a client that can send an `IIncomingRequest` and return an `IOutgoingResponse`.
 
-The library also provides the `DefaultHttpRequest` and `DefaultHttpResponse` classes, simple implementations of the
-`IHttpRequest` and `IHttpResponse` interfaces, which are used internally. These implementations use the `StringBodyReader`
-class to parse request and response bodies provided as strings.
+When developing your JavaScript/TypeScript enforcer with this library, you will need to wrap the native HTTP request/response
+objects such that they conform to these interfaces. Of course, you are free to extend these interfaces as needed.
 
 You will also need to implement an HTTP client. You can do this however you see fit: use the platform's built-in API
 or use an external library (e.g., `phin`, `axios`) if needed.

package/lib/activities/model/Activity.d.ts

@@ -6,7 +6,7 @@ export declare type Activity = {
     socket_ip: string;
     url: string;
     px_app_id: string;
-    headers?: Record<string, string | string[]>;
+    headers?: Record<string, string>;
     vid?: string;
     pxhd?: string;
     details: ActivityDetails;

package/lib/activities/utils.js

@@ -3,12 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createBlockActivityDetails = exports.createPageRequestedActivityDetails = exports.createGenericActivityDetails = exports.createActivityDetails = exports.createActivity = void 0;
 var utils_1 = require("../utils");
 var ActivityType_1 = require("./ActivityType");
+var http_1 = require("../http");
 var createActivity = function (activityType, config, context) {
     return {
         type: activityType,
         px_app_id: config.appId,
         url: context.requestData.url.href,
-        headers: (0, utils_1.removeSensitiveHeaders)(context.requestData.headers, config.sensitiveHeaders),
+        headers: (0, http_1.joinHeaderValues)((0, utils_1.removeSensitiveHeaders)(context.requestData.headers, config.sensitiveHeaders)),
         pxhd: context.pxhd,
         socket_ip: context.requestData.ip,
         timestamp: Date.now(),

package/lib/http/interfaces/ReadOnlyHeaders.d.ts

@@ -1,3 +1,4 @@
 export declare type ReadOnlyHeaders = Readonly<Record<string, string[]>>;
 export declare const toReadOnlyHeaders: (headers: Headers) => ReadOnlyHeaders;
 export declare const fromReadOnlyHeaders: (headers?: ReadOnlyHeaders) => Headers;
+export declare const joinHeaderValues: (headers: ReadOnlyHeaders) => Record<string, string>;

package/lib/http/interfaces/ReadOnlyHeaders.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fromReadOnlyHeaders = exports.toReadOnlyHeaders = void 0;
+exports.joinHeaderValues = exports.fromReadOnlyHeaders = exports.toReadOnlyHeaders = void 0;
 var toReadOnlyHeaders = function (headers) {
     var readonlyHeaders = {};
     headers.forEach(function (headerValue, headerName) {
@@ -23,3 +23,10 @@ var fromReadOnlyHeaders = function (headers) {
     return new Headers(init);
 };
 exports.fromReadOnlyHeaders = fromReadOnlyHeaders;
+var joinHeaderValues = function (headers) {
+    return Object.fromEntries(Object.entries(headers).map(function (_a) {
+        var name = _a[0], values = _a[1];
+        return [name, values.join(', ')];
+    }));
+};
+exports.joinHeaderValues = joinHeaderValues;

package/lib/http/interfaces/index.d.ts

@@ -1,6 +1,7 @@
 export * from './ReadOnlyHeaders';
 export * from './IHttpClient';
 export * from './IIncomingResponse';
+export * from './IIncomingRequest';
 export * from './IMinimalResponse';
 export * from './IOutgoingRequest';
 export * from './IOutgoingResponse';

package/lib/http/interfaces/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ReadOnlyHeaders"), exports);
 __exportStar(require("./IHttpClient"), exports);
 __exportStar(require("./IIncomingResponse"), exports);
+__exportStar(require("./IIncomingRequest"), exports);
 __exportStar(require("./IMinimalResponse"), exports);
 __exportStar(require("./IOutgoingRequest"), exports);
 __exportStar(require("./IOutgoingResponse"), exports);

package/lib/utils/constants.d.ts

@@ -7,4 +7,4 @@ export declare const BYPASS_MONITOR_HEADER_VALUE = "1";
 export declare const X_PX_AUTHORIZATION_HEADER_NAME = "x-px-authorization";
 export declare const X_PX_ORIGINAL_TOKEN_HEADER_NAME = "x-px-original-token";
 export declare const X_PX_BYPASS_REASON_HEADER_NAME = "x-px-bypass-reason";
-export declare const CORE_MODULE_VERSION = "JS Core 0.4.0";
+export declare const CORE_MODULE_VERSION = "JS Core 0.4.2";

package/lib/utils/constants.js

@@ -10,4 +10,4 @@ exports.BYPASS_MONITOR_HEADER_VALUE = '1';
 exports.X_PX_AUTHORIZATION_HEADER_NAME = 'x-px-authorization';
 exports.X_PX_ORIGINAL_TOKEN_HEADER_NAME = 'x-px-original-token';
 exports.X_PX_BYPASS_REASON_HEADER_NAME = 'x-px-bypass-reason';
-exports.CORE_MODULE_VERSION = 'JS Core 0.4.0';
+exports.CORE_MODULE_VERSION = 'JS Core 0.4.2';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "perimeterx-js-core",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",