perimeterx-js-core 0.5.0 → 0.6.0

package/lib/config/IConfiguration.d.ts

@@ -3,7 +3,9 @@ import { ILogger, LoggerSeverity } from '../logger';
 import { CustomParametersFunction } from '../custom_parameters';
 import { AdditionalActivityHandler } from '../additional_activity_handler';
 import { ConfigurationParams } from './ConfigurationParams';
-export interface IConfiguration<ParamsType extends ConfigurationParams = ConfigurationParams> {
+import { CustomPreflightHandler, CustomBlockResponseHeadersHandler } from '../cors';
+import { CredentialEndpointConfiguration, CredentialIntelligenceVersion, CustomLoginSuccessfulCallback, LoginSuccessfulReportingMethod } from '../products';
+export interface IConfiguration<Req, Res, ParamsType extends ConfigurationParams<Req, Res> = ConfigurationParams<Req, Res>> {
     /**
      * The application ID.
      */
@@ -88,9 +90,24 @@ export interface IConfiguration<ParamsType extends ConfigurationParams = Configu
      */
     readonly firstPartyEnabled: boolean;
     /**
-     * The prefix to use for first party requests.
+     * The customized prefix to use for first party requests.
      */
-    readonly firstPartyPrefix: string;
+    readonly customFirstPartyPrefix: string;
+    /**
+     * The customized endpoint to use for the sensor script. This will
+     * take precedence over if a custom first party prefix is configured.
+     */
+    readonly customFirstPartySensorEndpoint: string;
+    /**
+     * The customized endpoint to use for the XHR requests. This will
+     * take precedence over if a custom first party prefix is configured.
+     */
+    readonly customFirstPartyXhrEndpoint: string;
+    /**
+     * The customized endpoint to use for the captcha script. This will
+     * take precedence over if a custom first party prefix is configured.
+     */
+    readonly customFirstPartyCaptchaEndpoint: string;
     /**
      * Whether the enforcer should return a JSON block response in cases where the
      * Accept header on the request includes application/json.
@@ -186,11 +203,104 @@ export interface IConfiguration<ParamsType extends ConfigurationParams = Configu
     /**
      * A function returning CustomParameters that will be added to the enforcer activities.
      */
-    readonly enrichCustomParameters: CustomParametersFunction;
+    readonly enrichCustomParameters: CustomParametersFunction<Req, Res>;
     /**
      * A function that will be called after the asynchronous activities are sent to the backend.
      */
     readonly additionalActivityHandler: AdditionalActivityHandler;
+    /**
+     * Whether cors support feature should be enabled.
+     */
+    readonly corsSupportEnabled: boolean;
+    /**
+     * Function that will be called for preflight requests and returns response that will be returned to the client.
+     */
+    readonly corsCustomPreflightHandler: CustomPreflightHandler<Req>;
+    /**
+     * Function that returns an object with custom headers to be added to the block response.
+     */
+    readonly corsCreateCustomBlockResponseHeaders: CustomBlockResponseHeadersHandler<Req>;
+    /**
+     * Whether preflight requests will be filtered out from the enforcer.
+     */
+    readonly corsPreflightRequestFilterEnabled: boolean;
+    /**
+     * The name of cookie that contains the JWT token.
+     */
+    readonly jwtCookieName: string;
+    /**
+     * The name of the field/field path that contains the user ID.
+     */
+    readonly jwtCookieUserIdFieldName: string;
+    /**
+     * List of additional fields/fields' paths to be extracted from the JWT.
+     */
+    readonly jwtCookieAdditionalFieldNames: string[];
+    /**
+     * The name of the header that contains the JWT token.
+     */
+    readonly jwtHeaderName: string;
+    /**
+     * The name of the field/field path that contains the user ID.
+     */
+    readonly jwtHeaderUserIdFieldName: string;
+    /**
+     * List of additional fields/fields' paths to be extracted from the JWT.
+     */
+    readonly jwtHeaderAdditionalFieldNames: string[];
+    /**
+     * Whether to enable Credential Intelligence.
+     */
+    readonly ciEnabled: boolean;
+    /**
+     * An array of configuration objects for each credential endpoint.
+     */
+    readonly ciEndpoints: CredentialEndpointConfiguration<Req, Res>[];
+    /**
+     * The header name to be set on the incoming request if the credentials are compromised.
+     */
+    readonly ciCompromisedCredentialsHeaderName: string;
+    /**
+     * Whether to send the raw username on the additional_s2s activity.
+     */
+    readonly ciSendRawUsernameOnAdditionalS2SActivity: boolean;
+    /**
+     * Whether to send the additional_s2s activity automatically in the postEnforce function.
+     */
+    readonly ciAutomaticAdditionalS2SEnabled: boolean;
+    /**
+     * Whether to attach the additional_s2s payload and URL as headers to the original request.
+     * This should only be enabled if the additional_s2s activity is not sent automatically.
+     */
+    readonly ciAdditionalS2SHeaderEnabled: boolean;
+    /**
+     * The default Credential Intelligence version to use if none is defined for an endpoint.
+     */
+    readonly ciDefaultVersion: CredentialIntelligenceVersion;
+    /**
+     * The default login successful reporting method to use if none is defined for an endpoint.
+     */
+    readonly ciDefaultLoginSuccessfulReportingMethod: LoginSuccessfulReportingMethod;
+    /**
+     * The default login successful statuses to use if none is defined for an endpoint.
+     */
+    readonly ciDefaultLoginSuccessfulStatus: number[];
+    /**
+     * The default login successful body regex to use if none is defined for an endpoint.
+     */
+    readonly ciDefaultLoginSuccessfulBodyRegex: string;
+    /**
+     * The default login successful header name to use if none is defined for an endpoint.
+     */
+    readonly ciDefaultLoginSuccessfulHeaderName: string;
+    /**
+     * The default login successful header value to use if none is defined for an endpoint.
+     */
+    readonly ciDefaultLoginSuccessfulHeaderValue: string;
+    /**
+     * The default login successful custom callback to use if none is defined for an endpoint.
+     */
+    readonly ciDefaultLoginSuccessfulCustomCallback: CustomLoginSuccessfulCallback<Res>;
     /**
      * Returns an object representation of the current configuration.
      */

package/lib/config/IConfiguration.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/lib/config/StaticConfigurationBase.d.ts

@@ -3,8 +3,10 @@ import { ConfigurationParams } from './ConfigurationParams';
 import { CustomParametersFunction } from '../custom_parameters';
 import { AdditionalActivityHandler } from '../additional_activity_handler';
 import { ILogger, LoggerSeverity } from '../logger';
+import { CustomBlockResponseHeadersHandler, CustomPreflightHandler } from '../cors';
 import { ModuleMode } from '../utils';
-export declare abstract class StaticConfigurationBase<ParamsType extends ConfigurationParams = ConfigurationParams> implements IConfiguration<ParamsType> {
+import { CredentialEndpointConfiguration, CredentialIntelligenceVersion, CustomLoginSuccessfulCallback, LoginSuccessfulReportingMethod } from '../products';
+export declare abstract class StaticConfigurationBase<Req, Res, ParamsType extends ConfigurationParams<Req, Res> = ConfigurationParams<Req, Res>> implements IConfiguration<Req, Res, ParamsType> {
     protected readonly configParams: ParamsType;
     protected internalLogger: ILogger;
     protected abstract getModuleVersion(): string;
@@ -31,7 +33,10 @@ export declare abstract class StaticConfigurationBase<ParamsType extends Configu
     get filteredRoutes(): string[];
     get filteredUserAgents(): string[];
     get firstPartyEnabled(): boolean;
-    get firstPartyPrefix(): string;
+    get customFirstPartyPrefix(): string;
+    get customFirstPartySensorEndpoint(): string;
+    get customFirstPartyXhrEndpoint(): string;
+    get customFirstPartyCaptchaEndpoint(): string;
     get loggerSeverity(): LoggerSeverity;
     get moduleEnabled(): boolean;
     get moduleMode(): ModuleMode;
@@ -57,7 +62,30 @@ export declare abstract class StaticConfigurationBase<ParamsType extends Configu
     get graphqlRoutes(): string[];
     get sensitiveGraphqlOperationNames(): string[];
     get sensitiveGraphqlOperationTypes(): string[];
-    get enrichCustomParameters(): CustomParametersFunction;
+    get enrichCustomParameters(): CustomParametersFunction<Req, Res>;
     get additionalActivityHandler(): AdditionalActivityHandler;
     get altBackendCaptchaUrl(): string;
+    get corsSupportEnabled(): boolean;
+    get corsCustomPreflightHandler(): CustomPreflightHandler<Req>;
+    get corsPreflightRequestFilterEnabled(): boolean;
+    get corsCreateCustomBlockResponseHeaders(): CustomBlockResponseHeadersHandler<Req>;
+    get jwtCookieAdditionalFieldNames(): string[];
+    get jwtCookieName(): string;
+    get jwtCookieUserIdFieldName(): string;
+    get jwtHeaderAdditionalFieldNames(): string[];
+    get jwtHeaderName(): string;
+    get jwtHeaderUserIdFieldName(): string;
+    get ciEnabled(): boolean;
+    get ciEndpoints(): CredentialEndpointConfiguration<Req, Res>[];
+    get ciCompromisedCredentialsHeaderName(): string;
+    get ciSendRawUsernameOnAdditionalS2SActivity(): boolean;
+    get ciAutomaticAdditionalS2SEnabled(): boolean;
+    get ciAdditionalS2SHeaderEnabled(): boolean;
+    get ciDefaultVersion(): CredentialIntelligenceVersion;
+    get ciDefaultLoginSuccessfulReportingMethod(): LoginSuccessfulReportingMethod;
+    get ciDefaultLoginSuccessfulStatus(): number[];
+    get ciDefaultLoginSuccessfulBodyRegex(): string;
+    get ciDefaultLoginSuccessfulHeaderName(): string;
+    get ciDefaultLoginSuccessfulHeaderValue(): string;
+    get ciDefaultLoginSuccessfulCustomCallback(): CustomLoginSuccessfulCallback<Res>;
 }