perimeterx-js-core 0.33.0 → 0.34.1

package/lib/cjs/context/DefaultContext.js

@@ -54,7 +54,7 @@ var DefaultContext = /** @class */ (function () {
         if (!this.isMobile) {
             this.setCookiesOnContext();
         }
-        this.shouldSendTelemetry = false;
+        this.telemetryUpdateReason = undefined;
     }
     Object.defineProperty(DefaultContext.prototype, "shouldSendLogs", {
         get: function () {
@@ -189,7 +189,7 @@ var DefaultContext = /** @class */ (function () {
             enforcerStartTime: this.enforcerStartTime,
             blockAction: this.blockAction,
             pxdeVerified: this.pxdeVerified,
-            shouldSendTelemetry: this.shouldSendTelemetry,
+            telemetryUpdateReason: this.telemetryUpdateReason,
             logger: this.shouldSendLogs
                 ? {
                     logs: this.logger.getLogs(),

package/lib/cjs/context/SerializedContext.js

@@ -48,7 +48,7 @@ var SerializedContext = /** @class */ (function () {
         this.graphqlData = contextJson.graphqlData;
         this.enforcerStartTime = contextJson.enforcerStartTime;
         this.blockAction = contextJson.blockAction;
-        this.shouldSendTelemetry = contextJson.shouldSendTelemetry;
+        this.telemetryUpdateReason = contextJson.telemetryUpdateReason;
     }
     SerializedContext.prototype.createRequestData = function (_a, request, urlUtils) {
         var requestData = _a.requestData;

package/lib/cjs/phase/impl/IdentifyTelemetryRequestPhase.js

@@ -53,7 +53,7 @@ var IdentifyTelemetryRequestPhase = /** @class */ (function () {
                     case 0: return [4 /*yield*/, this.telemetry.isValidTelemetryRequest(context)];
                     case 1:
                         if (_a.sent()) {
-                            context.shouldSendTelemetry = true;
+                            context.telemetryUpdateReason = 'command';
                             return [2 /*return*/, { done: true }];
                         }
                         return [2 /*return*/, { done: false }];

package/lib/cjs/phase/impl/RiskApiPhase.js

@@ -139,7 +139,7 @@ var RiskApiPhase = /** @class */ (function (_super) {
             context.uuid = riskResponse.uuid;
         }
         if (riskResponse.telemetryRequested) {
-            context.shouldSendTelemetry = true;
+            context.telemetryUpdateReason = 'risk';
         }
         if (riskResponse.dataEnrichment) {
             context.pxde = riskResponse.dataEnrichment;

package/lib/cjs/phase/impl/SendTelemetryActivityPhase.js

@@ -51,7 +51,7 @@ var SendTelemetryActivityPhase = /** @class */ (function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        if (!context.shouldSendTelemetry) return [3 /*break*/, 2];
+                        if (!context.telemetryUpdateReason) return [3 /*break*/, 2];
                         promise = this.telemetry.sendTelemetry(context);
                         if (!this.config.awaitAsyncHttpRequests) return [3 /*break*/, 2];
                         return [4 /*yield*/, promise];

package/lib/cjs/telemetry/DefaultTelemetry.js

@@ -156,6 +156,9 @@ var DefaultTelemetry = /** @class */ (function () {
                 enforcer_configs: telemetryConfig,
             },
         };
+        if (context.requestId) {
+            activity.details.request_id = context.requestId;
+        }
         if (context.serverData.osName) {
             activity.details.os_name = context.serverData.osName;
         }

package/lib/cjs/telemetry/index.js

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefaultTelemetry = void 0;
 var DefaultTelemetry_1 = require("./DefaultTelemetry.js");
 Object.defineProperty(exports, "DefaultTelemetry", { enumerable: true, get: function () { return DefaultTelemetry_1.DefaultTelemetry; } });
+__exportStar(require("./model/TelemetryActivity.js"), exports);
 __exportStar(require("./constants.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.33.0';
+exports.CORE_MODULE_VERSION = 'JS Core 0.34.1';

package/lib/esm/context/DefaultContext.js

@@ -36,7 +36,7 @@ export class DefaultContext {
     enforcerStartTime;
     logger;
     usedCookieSecret;
-    shouldSendTelemetry;
+    telemetryUpdateReason;
     _shouldSendLogs = false;
     config;
     urlUtils;
@@ -68,7 +68,7 @@ export class DefaultContext {
         if (!this.isMobile) {
             this.setCookiesOnContext();
         }
-        this.shouldSendTelemetry = false;
+        this.telemetryUpdateReason = undefined;
     }
     get shouldSendLogs() {
         return this._shouldSendLogs;
@@ -195,7 +195,7 @@ export class DefaultContext {
             enforcerStartTime: this.enforcerStartTime,
             blockAction: this.blockAction,
             pxdeVerified: this.pxdeVerified,
-            shouldSendTelemetry: this.shouldSendTelemetry,
+            telemetryUpdateReason: this.telemetryUpdateReason,
             logger: this.shouldSendLogs
                 ? {
                     logs: this.logger.getLogs(),

package/lib/esm/context/SerializedContext.js

@@ -32,7 +32,7 @@ export class SerializedContext {
     vidSource;
     tokenOrigin;
     uuid;
-    shouldSendTelemetry;
+    telemetryUpdateReason;
     constructor(config, contextJson, request, urlUtils) {
         this.action = contextJson.action;
         this.reasons = contextJson.reasons;
@@ -59,7 +59,7 @@ export class SerializedContext {
         this.graphqlData = contextJson.graphqlData;
         this.enforcerStartTime = contextJson.enforcerStartTime;
         this.blockAction = contextJson.blockAction;
-        this.shouldSendTelemetry = contextJson.shouldSendTelemetry;
+        this.telemetryUpdateReason = contextJson.telemetryUpdateReason;
     }
     createRequestData({ requestData }, request, urlUtils) {
         return {

package/lib/esm/phase/impl/IdentifyTelemetryRequestPhase.js

@@ -10,7 +10,7 @@ export class IdentifyTelemetryRequestPhase {
     }
     async execute(context) {
         if (await this.telemetry.isValidTelemetryRequest(context)) {
-            context.shouldSendTelemetry = true;
+            context.telemetryUpdateReason = 'command';
             return { done: true };
         }
         return { done: false };

package/lib/esm/phase/impl/RiskApiPhase.js

@@ -51,7 +51,7 @@ export class RiskApiPhase extends DecideActionPhase {
             context.uuid = riskResponse.uuid;
         }
         if (riskResponse.telemetryRequested) {
-            context.shouldSendTelemetry = true;
+            context.telemetryUpdateReason = 'risk';
         }
         if (riskResponse.dataEnrichment) {
             context.pxde = riskResponse.dataEnrichment;

package/lib/esm/phase/impl/SendTelemetryActivityPhase.js

@@ -9,7 +9,7 @@ export class SendTelemetryActivityPhase {
         this.telemetry = telemetry;
     }
     async execute(context) {
-        if (context.shouldSendTelemetry) {
+        if (context.telemetryUpdateReason) {
             // ensure error handling is done in the sendTelemetry method
             const promise = this.telemetry.sendTelemetry(context);
             if (this.config.awaitAsyncHttpRequests) {

package/lib/esm/telemetry/DefaultTelemetry.js

@@ -78,6 +78,9 @@ export class DefaultTelemetry {
                 enforcer_configs: telemetryConfig,
             },
         };
+        if (context.requestId) {
+            activity.details.request_id = context.requestId;
+        }
         if (context.serverData.osName) {
             activity.details.os_name = context.serverData.osName;
         }

package/lib/esm/telemetry/index.js

@@ -1,2 +1,3 @@
 export { DefaultTelemetry } from './DefaultTelemetry.js';
+export * from './model/TelemetryActivity.js';
 export * from './constants.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.33.0';
+export const CORE_MODULE_VERSION = 'JS Core 0.34.1';

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;
@@ -148,3 +153,4 @@ export declare abstract class ConfigurationBase<Req, Res, Supported extends stri
     get awaitAsyncHttpRequests(): boolean;
     get isPostEnforceEnabled(): boolean;
 }
+export {};

package/lib/types/context/ContextJson.d.ts

@@ -9,6 +9,7 @@ import { CustomParameters } from '../custom_parameters';
 import { GraphQLData } from '../graphql';
 import { RemoteConfigUpdateData, RequestData, RiskApiData, ServerData, TlsData, TokenData } from './interfaces';
 import { LogRecord } from '../logger';
+import { TelemetryUpdateReason } from '../telemetry';
 type RequestDataJson<Req> = Omit<RequestData<Req>, 'url' | 'request'> & {
     url: string;
     request: undefined;
@@ -45,6 +46,6 @@ export type ContextJson<Req = unknown, Res = unknown> = {
     logger?: {
         logs: LogRecord[];
     };
-    shouldSendTelemetry: boolean;
+    telemetryUpdateReason?: TelemetryUpdateReason;
 };
 export {};

package/lib/types/context/DefaultContext.d.ts

@@ -12,6 +12,7 @@ import { ILogger } from '../logger';
 import { IContext, RemoteConfigUpdateData, RequestData, RiskApiData, ServerData, TlsData, TokenData } from './interfaces';
 import { ContextJson } from './ContextJson';
 import { GraphQLData } from '../graphql';
+import { TelemetryUpdateReason } from '../telemetry';
 export type DefaultContextOptions = {
     cookieParser?: ICookieParser;
     requestIdGenerator: IRequestIdGenerator;
@@ -47,7 +48,7 @@ export declare class DefaultContext<Req, Res, Supported extends string, Added> i
     enforcerStartTime?: number;
     logger: ILogger;
     usedCookieSecret?: string;
-    shouldSendTelemetry: boolean;
+    telemetryUpdateReason?: TelemetryUpdateReason;
     protected _shouldSendLogs: boolean;
     protected readonly config: IConfiguration<Req, Res, Supported, Added>;
     protected readonly urlUtils: IUrlUtils;

package/lib/types/context/SerializedContext.d.ts

@@ -12,6 +12,7 @@ import { CustomParameters } from '../custom_parameters';
 import { GraphQLData } from '../graphql';
 import { IContext, RemoteConfigUpdateData, RequestData, RiskApiData, ServerData, TlsData, TokenData } from './interfaces';
 import { ContextJson } from './ContextJson';
+import { TelemetryUpdateReason } from '../telemetry';
 /**
  * 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()`
@@ -43,7 +44,7 @@ export declare class SerializedContext<Req, Res, Supported extends string, Added
     vidSource?: VidSource;
     tokenOrigin: TokenOrigin;
     uuid?: string;
-    shouldSendTelemetry: boolean;
+    telemetryUpdateReason?: TelemetryUpdateReason;
     constructor(config: IConfiguration<Req, Res, Supported, Added>, contextJson: ContextJson<Req, Res>, request: IIncomingRequest<Req>, urlUtils: IUrlUtils);
     protected createRequestData({ requestData }: ContextJson<Req, Res>, request: IIncomingRequest<Req>, urlUtils: IUrlUtils): RequestData<Req>;
     protected createTokenData({ tokenData }: ContextJson<Req, Res>, config: IConfiguration<Req, Res, Supported, Added>): TokenData<Req, Res>;

package/lib/types/context/interfaces/IContext.d.ts

@@ -15,6 +15,7 @@ import { GraphQLData } from '../../graphql';
 import { PXHD } from '../../pxhd';
 import { ILogger } from '../../logger';
 import { RemoteConfigUpdateData } from './RemoteConfigUpdateData';
+import { TelemetryUpdateReason } from '../../telemetry';
 export interface IContext<Req, Res> {
     /**
      * Logger for recording messages related to the request flow.
@@ -138,7 +139,7 @@ export interface IContext<Req, Res> {
      */
     readonly enforcerStartTime?: number;
     /**
-     * Whether to send telemetry activity for the current request.
+     * The reason why a telemetry activity should be sent (undefined if no telemetry activity is triggered)
      */
-    shouldSendTelemetry: boolean;
+    telemetryUpdateReason?: TelemetryUpdateReason;
 }

package/lib/types/telemetry/index.d.ts

@@ -1,4 +1,4 @@
 export { ITelemetry } from './ITelemetry';
 export { DefaultTelemetry } from './DefaultTelemetry';
-export { TelemetryActivity } from './model/TelemetryActivity';
+export * from './model/TelemetryActivity';
 export * from './constants';

package/lib/types/telemetry/model/TelemetryActivity.d.ts

@@ -1,13 +1,15 @@
 import { ActivityType } from '../../activities';
 import { RemoteConfigurationParams, StaticConfigurationParams, ActiveConfigurationParams, CoreConfigurationParamsKeys } from '../../config';
+export type TelemetryUpdateReason = 'command' | 'risk';
 export type TelemetryActivityDetails<Req, Res, Supported extends CoreConfigurationParamsKeys, Added> = {
     enforcer_configs: TelemetryEnforcerConfiguration<Req, Res, Supported, Added>;
     module_version: string;
-    update_reason: 'command';
+    update_reason: TelemetryUpdateReason;
     node_name?: string;
     os_name?: string;
     remote_config_id?: string;
     remote_config_version?: number;
+    request_id?: string;
 };
 export type TelemetryActivity<Req, Res, Supported extends CoreConfigurationParamsKeys, Added> = {
     type: ActivityType.ENFORCER_TELEMETRY;

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "perimeterx-js-core",
-  "version": "0.33.0",
+  "version": "0.34.1",
   "description": "",
   "type": "module",
   "typesVersions": {
@@ -61,7 +61,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",