perimeterx-js-core 0.25.0 → 0.26.0

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

@@ -2,3 +2,4 @@ export * from './model';
 export * from './risk_response';
 export * from './client';
 export * from './constants';
+export * from './utils';

package/lib/types/risk_api/model/GetRiskRequestHeaders.d.ts

@@ -0,0 +1,17 @@
+import { RiskActivity } from './RiskActivity';
+export type RiskRequestHeaderConversionObject<T> = T extends string ? {
+    header: string;
+    convertToString?: (value: T) => string;
+} : {
+    header: string;
+    convertToString: (value: T) => string;
+};
+export declare const RISK_ACTIVITY_FIELDS_TO_HEADER_NAMES: {
+    [K in keyof Omit<RiskActivity, 'additional' | 'request'>]: RiskRequestHeaderConversionObject<Omit<RiskActivity, 'additional' | 'request'>[K]>;
+};
+export declare const RISK_ACTIVITY_REQUEST_FIELDS_TO_HEADER_NAMES: {
+    [K in keyof Omit<RiskActivity['request'], 'headers'>]: RiskRequestHeaderConversionObject<Omit<RiskActivity['request'], 'headers'>[K]>;
+};
+export declare const RISK_ACTIVITY_ADDITIONAL_FIELDS_TO_HEADER_NAMES: {
+    [K in keyof Required<RiskActivity['additional']>]: RiskRequestHeaderConversionObject<Required<RiskActivity['additional']>[K]>;
+};

package/lib/types/risk_api/model/GetRiskResponseHeaders.d.ts

@@ -0,0 +1,3 @@
+import { RiskResponseV2Payload } from '../risk_response';
+import { SnakeToPascalCase } from '../utils';
+export declare const GetRiskResponseHeaders: Record<SnakeToPascalCase<keyof RiskResponseV2Payload>, string>;

package/lib/types/risk_api/model/index.d.ts

@@ -2,3 +2,5 @@ export * from './RiskActivity';
 export * from './RiskStatus';
 export * from './RiskApiCallResult';
 export * from './S2SErrorReason';
+export * from './GetRiskResponseHeaders';
+export * from './GetRiskRequestHeaders';

package/lib/types/risk_api/risk_response/IRiskResponse.d.ts

@@ -2,6 +2,7 @@ import { AsyncOrSync } from 'ts-essentials';
 import { BlockAction } from '../../blocker';
 import { PXDE } from '../../pxde';
 import { RiskStatus } from '../model';
+import { RiskResponseJson } from './serialize';
 export interface IRiskResponse {
     readonly status?: RiskStatus;
     readonly score?: number;
@@ -15,4 +16,5 @@ export interface IRiskResponse {
     readonly additionalRiskInfo?: string;
     readonly telemetryRequested?: boolean;
     validate(): AsyncOrSync<boolean>;
+    toJSON(): RiskResponseJson;
 }

package/lib/types/risk_api/risk_response/PostRiskResponseBase.d.ts

@@ -0,0 +1,7 @@
+import { RiskResponseBase } from './RiskResponseBase';
+import { TokenVersion } from '../../risk_token';
+import { IIncomingResponse } from '../../http';
+import { RiskResponsePayloadType } from './RiskResponsePayloadType';
+export declare abstract class PostRiskResponseBase<TokenV extends TokenVersion> extends RiskResponseBase<TokenV> {
+    protected parseRiskResponse(response: IIncomingResponse): Promise<RiskResponsePayloadType<TokenV>>;
+}

package/lib/types/risk_api/risk_response/RiskResponseBase.d.ts

@@ -6,10 +6,12 @@ import { RiskStatus } from '../model';
 import { IRiskResponse } from './IRiskResponse';
 import { RiskResponsePayloadType } from './RiskResponsePayloadType';
 import { RiskResponseJson } from './serialize';
+import { AsyncOrSync } from 'ts-essentials';
 export declare abstract class RiskResponseBase<TokenV extends TokenVersion> implements IRiskResponse {
-    private readonly response;
+    protected readonly response: IIncomingResponse;
     protected riskResponse?: RiskResponsePayloadType<TokenV>;
     abstract score: number | undefined;
+    protected abstract parseRiskResponse(response: IIncomingResponse): AsyncOrSync<RiskResponsePayloadType<TokenV> | null>;
     protected abstract validateRiskResponseScore(): boolean;
     protected constructor(response: IIncomingResponse);
     validate(): Promise<boolean>;

package/lib/types/risk_api/risk_response/index.d.ts

@@ -1,5 +1,6 @@
 export * from './IRiskResponse';
 export * from './RiskResponseBase';
+export * from './PostRiskResponseBase';
 export * from './CommonRiskResponsePayload';
 export * from './v2';
 export * from './v3';

package/lib/types/risk_api/risk_response/serialize/SerializedRiskResponse.d.ts

@@ -17,4 +17,5 @@ export declare class SerializedRiskResponse implements IRiskResponse {
     readonly uuid: string | undefined;
     constructor(riskResponseJson: RiskResponseJson);
     validate(): boolean;
+    toJSON(): RiskResponseJson;
 }

package/lib/types/risk_api/risk_response/v2/GetRiskResponseV2.d.ts

@@ -0,0 +1,11 @@
+import { IIncomingResponse } from '../../../http';
+import { RiskResponseBase } from '../RiskResponseBase';
+import { TokenVersion } from '../../../risk_token';
+import { RiskResponseV2Payload } from './RiskResponseV2Payload';
+export declare class GetRiskResponseV2 extends RiskResponseBase<TokenVersion.V2> {
+    constructor(response: IIncomingResponse);
+    protected parseRiskResponse(response: IIncomingResponse): RiskResponseV2Payload | null;
+    protected getHeader(response: IIncomingResponse, header: string): string | undefined;
+    get score(): number | undefined;
+    protected validateRiskResponseScore(): boolean;
+}

package/lib/types/risk_api/risk_response/{v3/DefaultRiskResponseV3.d.ts → v2/PostRiskResponseV2.d.ts}

@@ -1,7 +1,7 @@
 import { IIncomingResponse } from '../../../http';
 import { TokenVersion } from '../../../risk_token';
-import { RiskResponseBase } from '../RiskResponseBase';
-export declare class DefaultRiskResponseV3 extends RiskResponseBase<TokenVersion.V3> {
+import { PostRiskResponseBase } from '../PostRiskResponseBase';
+export declare class PostRiskResponseV2 extends PostRiskResponseBase<TokenVersion.V2> {
     constructor(response: IIncomingResponse);
     get score(): number | undefined;
     protected validateRiskResponseScore(): boolean;

package/lib/types/risk_api/risk_response/v2/index.d.ts

@@ -1,2 +1,3 @@
-export * from './DefaultRiskResponseV2';
+export * from './GetRiskResponseV2';
+export * from './PostRiskResponseV2';
 export * from './RiskResponseV2Payload';

package/lib/types/risk_api/risk_response/{v2/DefaultRiskResponseV2.d.ts → v3/PostRiskResponseV3.d.ts}

@@ -1,7 +1,7 @@
 import { IIncomingResponse } from '../../../http';
 import { TokenVersion } from '../../../risk_token';
-import { RiskResponseBase } from '../RiskResponseBase';
-export declare class DefaultRiskResponseV2 extends RiskResponseBase<TokenVersion.V2> {
+import { PostRiskResponseBase } from '../PostRiskResponseBase';
+export declare class PostRiskResponseV3 extends PostRiskResponseBase<TokenVersion.V3> {
     constructor(response: IIncomingResponse);
     get score(): number | undefined;
     protected validateRiskResponseScore(): boolean;

package/lib/types/risk_api/risk_response/v3/index.d.ts

@@ -1,2 +1,2 @@
-export * from './DefaultRiskResponseV3';
+export * from './PostRiskResponseV3';
 export * from './RiskResponseV3Payload';

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

@@ -0,0 +1,69 @@
+import { HeaderEntry } from '../activities';
+import { ReadonlyContext } from '../context';
+import { IConfiguration } from '../config';
+import { ReadonlyHeaders } from '../http';
+export type SnakeToPascalCase<S extends string> = S extends `${infer T}_${infer U}` ? `${Capitalize<T>}${SnakeToPascalCase<U>}` : Capitalize<S>;
+export declare const createRiskApiActivity: <Req, Res, Added, Removed>(config: IConfiguration<Req, Res, Added, Removed>, context: ReadonlyContext<Req, Res>) => {
+    vid: string | undefined;
+    client_uuid: string | undefined;
+    pxhd: string | undefined;
+    request: {
+        socket_ip: string;
+        headers: HeaderEntry[];
+        url: string;
+    };
+    additional: {
+        s2s_call_reason: string;
+        risk_start_time: number;
+        request_id: string;
+        module_version: string;
+        risk_mode: import("../utils").ModuleMode;
+        http_method: import("../http").HttpMethod;
+        http_version?: string;
+        px_orig_cookie?: string;
+        px_cookie?: string;
+        px_cookie_hmac?: string;
+        tls_protocol?: string;
+        tls_server?: string;
+        tls_cipher?: string;
+        tls_ciphers_sha?: string;
+        tls_extension_sha?: string;
+        tls_preferred_ciphers?: string;
+        tls_ja3_fingerprint?: string;
+        enforcer_vid_source?: import("../utils").VidSource;
+        original_uuid?: string;
+        original_token_error?: string;
+        original_token?: string;
+        px_decoded_original_token?: string;
+        cookie_origin?: import("..").TokenOrigin;
+        request_cookie_names?: string[];
+        server_info_region?: string;
+        server_info_datacenter?: string;
+        cpa?: boolean;
+        cross_tab_session?: string;
+        app_user_id?: string;
+        jwt_additional_fields?: Record<string, any>;
+        graphql_operations?: import("..").GraphQLData[];
+        user?: string;
+        pass?: string;
+        ci_version?: import("..").CredentialIntelligenceVersion;
+        sso_step?: import("..").SsoStep;
+        remote_config_version?: number;
+        remote_config_id?: string;
+        enforcer_start_time: number;
+        raw_url?: string;
+        used_cookie_secret?: string;
+        custom_param1?: any;
+        custom_param2?: any;
+        custom_param3?: any;
+        custom_param4?: any;
+        custom_param5?: any;
+        custom_param6?: any;
+        custom_param7?: any;
+        custom_param8?: any;
+        custom_param9?: any;
+        custom_param10?: any;
+        is_hype_sale?: boolean;
+    };
+};
+export declare const formatRiskHeadersField: <Req, Res, Added, Removed>(headers: ReadonlyHeaders, config: IConfiguration<Req, Res, Added, Removed>) => HeaderEntry[];

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

@@ -7,7 +7,7 @@ export type TelemetryActivityDetails<Req, Res, Added, Removed> = {
     node_name?: string;
     os_name?: string;
     remote_config_id?: string;
-    remote_config_version?: string;
+    remote_config_version?: number;
 };
 export type TelemetryActivity<Req, Res, Added, Removed> = {
     type: ActivityType.ENFORCER_TELEMETRY;

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

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

@@ -13,11 +13,6 @@ export declare const redactSensitiveFields: <T extends Record<string, any>>(obje
 export declare const removeSensitiveHeaders: (headers: ReadonlyHeaders, sensitiveHeaderNames: string[]) => Record<string, string[]>;
 export declare const isStringInPatterns: (str: string, patterns: Array<string | RegExp>) => boolean;
 export declare const isStringMatch: (str: string, pattern: string | RegExp) => boolean;
-/**
- * @deprecated this method is not typesafe. Copy the fields manually instead,
- *             unsafe - ignores compilerOptions.strictNullChecks
- */
-export declare const transferExistingProperties: <FromObj extends Record<string, any>, ToObj extends Record<string, any>>(fromObj: FromObj | undefined, toObj: ToObj | undefined, propertyMappings: Partial<Record<keyof FromObj, keyof ToObj>>) => void;
 export declare const rejectOnTimeout: <T>(promise: Promise<T>, ms: number) => Promise<T>;
 export declare const getPropertyFromObject: <T>(object: any, ...keys: Array<string | number>) => T;
 export declare const sleep: (ms: number) => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "perimeterx-js-core",
-  "version": "0.25.0",
+  "version": "0.26.0",
   "description": "",
   "type": "module",
   "typesVersions": {

package/lib/esm/phase/flow/EndEnforcerFlow.js

@@ -1,14 +0,0 @@
-import { ClearLogsPhase, CompositePhase, SendLogsPhase, SendTelemetryActivityPhase, UpdateRemoteConfigPhase, } from '../impl/index.js';
-export class EndEnforcerFlow extends CompositePhase {
-    constructor(config, { logServiceClient, telemetry, remoteConfigManager, }) {
-        const phases = [new SendTelemetryActivityPhase(telemetry)];
-        if (remoteConfigManager) {
-            phases.push(new UpdateRemoteConfigPhase(config, remoteConfigManager));
-        }
-        if (logServiceClient) {
-            phases.push(new SendLogsPhase(config, logServiceClient));
-        }
-        phases.push(new ClearLogsPhase());
-        super(phases);
-    }
-}

package/lib/esm/phase/flow/EnforceFlow.js

@@ -1,18 +0,0 @@
-import { ProductName } from '../../products/index.js';
-import { CompositePhase, AdditionalActivityHandlerPhase, CreateBlockResponsePhase, EnrichContextFromRequestPhase, ModifyIncomingRequestPhase, ParseTokenPhase, RiskApiPhase, SendAsyncActivitiesOnRequestPhase, } from '../impl/index.js';
-export class EnforceFlow extends CompositePhase {
-    constructor(config, { dataEnrichment, tokenParser, riskApiClient, activityClient, cors, products, graphQLParser, }) {
-        super([
-            new ParseTokenPhase(tokenParser),
-            new EnrichContextFromRequestPhase(config, products, dataEnrichment, graphQLParser),
-            new RiskApiPhase(products, riskApiClient),
-            new AdditionalActivityHandlerPhase(config),
-            new SendAsyncActivitiesOnRequestPhase(activityClient),
-            new CreateBlockResponsePhase(config, {
-                [ProductName.BOT_DEFENDER]: products[ProductName.BOT_DEFENDER],
-                [ProductName.HYPE_SALE_CHALLENGE]: products[ProductName.HYPE_SALE_CHALLENGE],
-            }, cors),
-            new ModifyIncomingRequestPhase(Object.values(products)),
-        ]);
-    }
-}

package/lib/esm/phase/flow/PostEnforceFlow.js

@@ -1,10 +0,0 @@
-import { CompositePhase, EnrichContextFromResponsePhase, ModifyOutgoingResponsePhase, SendAsyncActivitiesOnResponsePhase, } from '../impl/index.js';
-export class PostEnforceFlow extends CompositePhase {
-    constructor(config, { products, activityClient, snippetRetriever, snippetInjector, }) {
-        super([
-            new EnrichContextFromResponsePhase(config, products),
-            new ModifyOutgoingResponsePhase(config, Object.values(products), snippetRetriever, snippetInjector),
-            new SendAsyncActivitiesOnResponsePhase(activityClient),
-        ]);
-    }
-}

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

@@ -1,16 +0,0 @@
-import { Action } from '../../action/index.js';
-export class SendAsyncActivitiesOnRequestPhase {
-    activityClient;
-    constructor(activityClient) {
-        this.activityClient = activityClient;
-    }
-    async execute(context) {
-        if (context.action === Action.BLOCK) {
-            await this.sendAsyncActivity(context);
-        }
-        return { done: false };
-    }
-    async sendAsyncActivity(context) {
-        await this.activityClient.sendActivities(context);
-    }
-}

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

@@ -1,10 +0,0 @@
-export class SendAsyncActivitiesOnResponsePhase {
-    activityClient;
-    constructor(activityClient) {
-        this.activityClient = activityClient;
-    }
-    async execute(context) {
-        await this.activityClient.sendActivities(context);
-        return { done: false };
-    }
-}

package/lib/types/phase/flow/EndEnforcerFlow.d.ts

@@ -1,8 +0,0 @@
-import { IConfiguration } from '../../config';
-import { CompositePhase } from '../impl';
-import { EnforcerOptions } from '../../enforcer';
-type RequiredEndEnforcerFlowOptions = 'logServiceClient' | 'telemetry' | 'remoteConfigManager';
-export declare class EndEnforcerFlow<Req, Res, Added, Removed> extends CompositePhase<Req, Res> {
-    constructor(config: IConfiguration<Req, Res, Added, Removed>, { logServiceClient, telemetry, remoteConfigManager, }: Pick<Required<EnforcerOptions<Req, Res, Added, Removed>>, RequiredEndEnforcerFlowOptions>);
-}
-export {};

package/lib/types/phase/flow/EnforceFlow.d.ts

@@ -1,8 +0,0 @@
-import { IConfiguration } from '../../config';
-import { EnforcerOptions } from '../../enforcer';
-import { CompositePhase } from '../impl';
-type RequiredEnforceFlowOptions = 'dataEnrichment' | 'tokenParser' | 'riskApiClient' | 'activityClient' | 'cors' | 'products' | 'graphQLParser';
-export declare class EnforceFlow<Req, Res, Added, Removed> extends CompositePhase<Req, Res> {
-    constructor(config: IConfiguration<Req, Res, Added, Removed>, { dataEnrichment, tokenParser, riskApiClient, activityClient, cors, products, graphQLParser, }: Pick<Required<EnforcerOptions<Req, Res, Added, Removed>>, RequiredEnforceFlowOptions>);
-}
-export {};

package/lib/types/phase/flow/PostEnforceFlow.d.ts

@@ -1,6 +0,0 @@
-import { IConfiguration } from '../../config';
-import { EnforcerOptions } from '../../enforcer';
-import { CompositePhase } from '../impl';
-export declare class PostEnforceFlow<Req, Res, Added, Removed> extends CompositePhase<Req, Res> {
-    constructor(config: IConfiguration<Req, Res, Added, Removed>, { products, activityClient, snippetRetriever, snippetInjector, }: Pick<Required<EnforcerOptions<Req, Res, Added, Removed>>, 'products' | 'activityClient' | 'snippetRetriever' | 'snippetInjector'>);
-}

package/lib/types/phase/impl/SendAsyncActivitiesOnRequestPhase.d.ts

@@ -1,10 +0,0 @@
-import { IContext, ReadonlyContext } from '../../context';
-import { IActivityClient } from '../../activities';
-import { PhaseResult } from '../PhaseResult';
-import { IPhase } from '../IPhase';
-export declare class SendAsyncActivitiesOnRequestPhase<Req, Res> implements IPhase<Req, Res> {
-    protected readonly activityClient: IActivityClient<Req, Res>;
-    constructor(activityClient: IActivityClient<Req, Res>);
-    execute(context: IContext<Req, Res>): Promise<PhaseResult>;
-    protected sendAsyncActivity(context: ReadonlyContext<Req, Res>): Promise<void>;
-}

package/lib/types/risk_api/client/PostRiskApiClientBase.d.ts

@@ -1,40 +0,0 @@
-import { ReadonlyContext, RiskApiData } from '../../context';
-import { IConfiguration } from '../../config';
-import { IHttpClient, IIncomingResponse, ReadonlyHeaders } from '../../http';
-import { HeaderEntry } from '../../activities';
-import { RiskActivity } from '../model';
-import { IRiskResponse } from '../risk_response';
-import { IRiskApiClient } from './IRiskApiClient';
-export declare abstract class PostRiskApiClientBase<Req, Res, Added, Removed> implements IRiskApiClient<Req, Res> {
-    private readonly config;
-    private readonly httpClient;
-    protected constructor(config: IConfiguration<Req, Res, Added, Removed>, httpClient: IHttpClient);
-    protected abstract createRiskResponse(response: IIncomingResponse): IRiskResponse;
-    /**
-     * Builds the Risk API activity, sends the request, and returns RiskApiData with the response.
-     * @param context
-     * @returns Promise<RiskApiData>
-     */
-    executeRiskApi(context: ReadonlyContext<Req, Res>): Promise<RiskApiData>;
-    /**
-     * Creates the RiskActivity payload
-     * @param context
-     * @returns RiskActivity
-     * @protected
-     */
-    protected createRiskActivity(context: ReadonlyContext<Req, Res>): RiskActivity;
-    /**
-     * Protected function in case expansions or alterations to the risk activity are needed for certain platforms.
-     * @param riskActivity
-     * @returns RiskActivity
-     * @protected
-     */
-    protected finalizeRiskActivity(riskActivity: RiskActivity): RiskActivity;
-    protected formatRiskHeadersField(headers: ReadonlyHeaders): HeaderEntry[];
-    protected sendRiskActivity(riskActivity: RiskActivity, riskApiData: RiskApiData, context: ReadonlyContext<Req, Res>): Promise<IIncomingResponse>;
-    protected getRiskUrl(): string;
-    protected getRiskHeaders(): ReadonlyHeaders;
-    protected handleS2STimeout(riskApiData: RiskApiData): RiskApiData;
-    protected handleS2SError(riskApiData: RiskApiData, context: ReadonlyContext<Req, Res>, response?: IIncomingResponse, error?: unknown): Promise<RiskApiData>;
-}
-export declare const isEnforcerTimeoutError: (err: unknown) => boolean;