perimeterx-js-core 0.18.2 → 0.20.0

package/lib/types/config/IConfiguration.d.ts

@@ -2,10 +2,11 @@ import { ModuleMode } from '../utils';
 import { ILogger, LoggerSeverity } from '../logger';
 import { CustomParametersFunction } from '../custom_parameters';
 import { AdditionalActivityHandler } from '../additional_activity_handler';
-import { ConfigurationParams } from './params';
+import { ConfigurationParams, RemoteConfigurationParams } from './params';
 import { CustomPreflightHandler, CustomBlockResponseHeadersHandler } from '../cors';
 import { CredentialEndpointConfiguration, CredentialIntelligenceVersion, CustomLoginSuccessfulCallback, LoginSuccessfulReportingMethod } from '../products';
 import { CustomRequestFunction } from './CustomRequestFunction';
+import { ExtractGraphQLKeywordsFunction } from '../graphql/ExtractGraphQLKeywordsFunction';
 export interface IConfiguration<Req, Res, ParamsType extends ConfigurationParams<Req, Res> = ConfigurationParams<Req, Res>> {
     /**
      * The application ID.
@@ -215,15 +216,26 @@ export interface IConfiguration<Req, Res, ParamsType extends ConfigurationParams
      */
     readonly graphqlRoutes: Array<string | RegExp>;
     /**
-     * An array of GraphQL operation names that should trigger a risk API call
+     * An array of GraphQL operation names and keywords that should trigger a risk API call
      * even if a valid, unexpired, low-score risk cookie is present.
      */
-    readonly sensitiveGraphqlOperationNames: string[];
+    readonly sensitiveGraphqlOperationNames: Array<string | RegExp>;
     /**
      * An array of GraphQL operation types (e.g., mutation) that should trigger a risk API call
      * even if a valid, unexpired, low-score risk cookie is present.
      */
     readonly sensitiveGraphqlOperationTypes: string[];
+    /**
+     * An array of strings or regular expressions representing important keywords in the GraphQL
+     * query that should be extracted by the enforcer.
+     */
+    readonly graphqlKeywords: Array<string | RegExp>;
+    /**
+     * A custom function that receives the GraphQL query as a string and returns the extracted
+     * keywords from the query. This function may be called multiple times if the HTTP request
+     * contains multiple GraphQL queries.
+     */
+    readonly extractGraphQLKeywords: ExtractGraphQLKeywordsFunction<Req>;
     /**
      * A function returning CustomParameters that will be added to the enforcer activities.
      */
@@ -333,10 +345,6 @@ export interface IConfiguration<Req, Res, ParamsType extends ConfigurationParams
      * The authentication token for the remote configuration service.
      */
     readonly remoteConfigAuthToken: string;
-    /**
-     * The secret used for validating remote config update requests.
-     */
-    readonly remoteConfigSecret: string;
     /**
      * The ID of the remote configuration.
      */
@@ -364,5 +372,17 @@ export interface IConfiguration<Req, Res, ParamsType extends ConfigurationParams
     /**
      * Returns an object representation of the current configuration.
      */
-    toParams(): ParamsType;
+    getActiveConfig(): ParamsType;
+    /**
+     * Returns an object representation of the static configuration.
+     */
+    getStaticConfig(): ParamsType;
+    /**
+     * Returns an object representation of the remote configuration.
+     */
+    getRemoteConfig(): ParamsType;
+    /**
+     * Adds a remote configuration to the current configuration.
+     */
+    addRemoteConfig(remoteConfigurationParams: RemoteConfigurationParams): void;
 }

package/lib/types/config/params/CommonConfigurationParams.d.ts

@@ -6,6 +6,7 @@ import { AdditionalActivityHandler } from '../../additional_activity_handler';
 import { CustomParametersFunction } from '../../custom_parameters';
 import { CustomBlockResponseHeadersHandler, CustomPreflightHandler } from '../../cors';
 import { CustomRequestFunction } from '../CustomRequestFunction';
+import { ExtractGraphQLKeywordsFunction } from '../../graphql/ExtractGraphQLKeywordsFunction';
 export type CommonConfigurationParams<Req, Res> = {
     px_s2s_timeout?: number;
     px_backend_url?: string;
@@ -64,7 +65,8 @@ export type CommonConfigurationParams<Req, Res> = {
     px_jwt_header_additional_field_names?: string[];
     px_graphql_enabled?: boolean;
     px_graphql_routes?: Array<string | RegExp>;
-    px_sensitive_graphql_operation_names?: string[];
+    px_graphql_keywords?: Array<string | RegExp>;
+    px_sensitive_graphql_operation_names?: Array<string | RegExp>;
     px_sensitive_graphql_operation_types?: Array<'query' | 'mutation' | 'subscription' | GraphQLOperationType>;
     px_cors_support_enabled?: boolean;
     px_cors_preflight_request_filter_enabled?: boolean;
@@ -81,4 +83,5 @@ export type CommonConfigurationParams<Req, Res> = {
     px_custom_is_monitored_request?: CustomRequestFunction<Req>;
     px_custom_is_enforced_request?: CustomRequestFunction<Req>;
     px_custom_is_filtered_request?: CustomRequestFunction<Req>;
+    px_extract_graphql_keywords?: ExtractGraphQLKeywordsFunction<Req>;
 };

package/lib/types/config/params/StaticConfigurationParams.d.ts

@@ -3,6 +3,5 @@ export type StaticConfigurationParams = {
     px_cookie_secret: string;
     px_auth_token: string;
     px_logger_auth_token?: string;
-    px_remote_config_secret?: string;
     px_remote_config_auth_token?: string;
 };

package/lib/types/graphql/DefaultGraphQLParser.d.ts

@@ -1,19 +1,28 @@
 import { ReadonlyContext } from '../context';
 import { IConfiguration } from '../config';
+import { IIncomingRequest } from '../http';
 import { IGraphQLParser } from './IGraphQLParser';
-import { GraphQLData } from './model';
+import { GraphQLData, GraphQLOperation, GraphQLOperationType } from './model';
 export declare class DefaultGraphQLParser<Req, Res> implements IGraphQLParser<Req, Res> {
-    private readonly graphqlRoutes;
-    private readonly sensitiveOperationTypes;
-    private readonly sensitiveOperationNames;
+    protected readonly config: IConfiguration<Req, Res>;
+    protected readonly maxCharactersInGraphqlKeyword: number;
+    protected readonly maxGraphqlKeywordCount: number;
     constructor(config: IConfiguration<Req, Res>);
     isGraphQLRequest({ requestData }: ReadonlyContext<Req, Res>): boolean;
     parseGraphQLRequest(context: ReadonlyContext<Req, Res>): Promise<GraphQLData[]>;
-    private getGraphQLOperationsFromBody;
-    private parseGraphQLOperations;
-    private parseGraphQlOperation;
-    private getOperationNameToTypeMap;
-    private getGraphQLData;
-    private isSensitiveOperation;
-    private extractGraphQLVariableNames;
+    protected getGraphQLOperationsFromBody(request: IIncomingRequest<Req>, context: ReadonlyContext<Req, Res>): Promise<Array<GraphQLOperation>>;
+    protected parseGraphQLOperations(operations: GraphQLOperation[], context: ReadonlyContext<Req, Res>): Promise<GraphQLData[]>;
+    protected parseGraphQLOperation(operation: GraphQLOperation, context: ReadonlyContext<Req, Res>): Promise<GraphQLData | null>;
+    protected getOperationNameToTypeMap(query: string): Record<string, GraphQLOperationType> | null;
+    protected getGraphQLData(operationNameToTypeMap: Record<string, GraphQLOperationType>, operation: GraphQLOperation, context: ReadonlyContext<Req, Res>): Promise<GraphQLData>;
+    protected getOperationType(operation: GraphQLOperation, operationName: string, operationNameToTypeMap: Record<string, GraphQLOperationType>): GraphQLOperationType;
+    protected isGraphqlQueryShorthand(query: string): boolean;
+    protected getOperationName(operationNameToTypeMap: Record<string, GraphQLOperationType>, operation: GraphQLOperation): string;
+    protected getQueryKeywords(query: string, context: ReadonlyContext<Req, Res>): Promise<string[]>;
+    protected cleanKeywords(keywords: string[]): string[];
+    protected getQueryKeywordsFromCustomFunction(query: string, context: ReadonlyContext<Req, Res>): Promise<string[]>;
+    protected getQueryKeywordsFromArray(query: string, context: ReadonlyContext<Req, Res>): string[];
+    protected isSensitiveOperation(operationName: string, operationType: GraphQLOperationType, keywords: string[]): boolean;
+    protected extractGraphQLVariableNames(variables: Record<string, unknown>): string[];
+    protected toGlobalRegExp(pattern: string | RegExp): RegExp;
 }

package/lib/types/graphql/ExtractGraphQLKeywordsFunction.d.ts

@@ -0,0 +1 @@
+export type ExtractGraphQLKeywordsFunction<Req> = (graphqlQuery: string) => string[] | Promise<string[]>;

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

@@ -1,3 +1,4 @@
 export * from './model';
 export * from './IGraphQLParser';
 export * from './DefaultGraphQLParser';
+export * from './ExtractGraphQLKeywordsFunction';

package/lib/types/graphql/model/GraphQLData.d.ts

@@ -1,6 +1,7 @@
 import { GraphQLOperationType } from './GraphQLOperationType';
 export type GraphQLData = {
-    type: GraphQLOperationType;
+    type?: GraphQLOperationType;
+    keywords?: string[];
     name?: string;
     sensitive?: boolean;
     variables?: string[];

package/lib/types/monitored_request/MonitoredRequestUtils.d.ts

@@ -264,7 +264,8 @@ export declare namespace MonitoredRequestUtils {
                         readonly is_hype_sale?: boolean;
                     };
                     readonly graphqlData?: readonly {
-                        readonly type: import("..").GraphQLOperationType;
+                        readonly type?: import("..").GraphQLOperationType;
+                        readonly keywords?: readonly string[];
                         readonly name?: string;
                         readonly sensitive?: boolean;
                         readonly variables?: readonly string[];
@@ -490,7 +491,8 @@ export declare namespace MonitoredRequestUtils {
                             readonly is_hype_sale?: boolean;
                         };
                         readonly graphqlData?: readonly {
-                            readonly type: import("..").GraphQLOperationType;
+                            readonly type?: import("..").GraphQLOperationType;
+                            readonly keywords?: readonly string[];
                             readonly name?: string;
                             readonly sensitive?: boolean;
                             readonly variables?: readonly string[];
@@ -647,7 +649,8 @@ export declare namespace MonitoredRequestUtils {
             readonly is_hype_sale?: boolean;
         };
         readonly graphqlData?: readonly {
-            readonly type: import("..").GraphQLOperationType;
+            readonly type?: import("..").GraphQLOperationType;
+            readonly keywords?: readonly string[];
             readonly name?: string;
             readonly sensitive?: boolean;
             readonly variables?: readonly string[];
@@ -932,7 +935,8 @@ export declare namespace MonitoredRequestUtils {
                         readonly is_hype_sale?: boolean;
                     };
                     readonly graphqlData?: readonly {
-                        readonly type: import("..").GraphQLOperationType;
+                        readonly type?: import("..").GraphQLOperationType;
+                        readonly keywords?: readonly string[];
                         readonly name?: string;
                         readonly sensitive?: boolean;
                         readonly variables?: readonly string[];
@@ -1158,7 +1162,8 @@ export declare namespace MonitoredRequestUtils {
                             readonly is_hype_sale?: boolean;
                         };
                         readonly graphqlData?: readonly {
-                            readonly type: import("..").GraphQLOperationType;
+                            readonly type?: import("..").GraphQLOperationType;
+                            readonly keywords?: readonly string[];
                             readonly name?: string;
                             readonly sensitive?: boolean;
                             readonly variables?: readonly string[];
@@ -1315,7 +1320,8 @@ export declare namespace MonitoredRequestUtils {
             readonly is_hype_sale?: boolean;
         };
         readonly graphqlData?: readonly {
-            readonly type: import("..").GraphQLOperationType;
+            readonly type?: import("..").GraphQLOperationType;
+            readonly keywords?: readonly string[];
             readonly name?: string;
             readonly sensitive?: boolean;
             readonly variables?: readonly string[];
@@ -1598,7 +1604,8 @@ export declare namespace MonitoredRequestUtils {
                         readonly is_hype_sale?: boolean;
                     };
                     readonly graphqlData?: readonly {
-                        readonly type: import("..").GraphQLOperationType;
+                        readonly type?: import("..").GraphQLOperationType;
+                        readonly keywords?: readonly string[];
                         readonly name?: string;
                         readonly sensitive?: boolean;
                         readonly variables?: readonly string[];
@@ -1824,7 +1831,8 @@ export declare namespace MonitoredRequestUtils {
                             readonly is_hype_sale?: boolean;
                         };
                         readonly graphqlData?: readonly {
-                            readonly type: import("..").GraphQLOperationType;
+                            readonly type?: import("..").GraphQLOperationType;
+                            readonly keywords?: readonly string[];
                             readonly name?: string;
                             readonly sensitive?: boolean;
                             readonly variables?: readonly string[];
@@ -1981,7 +1989,8 @@ export declare namespace MonitoredRequestUtils {
             readonly is_hype_sale?: boolean;
         };
         readonly graphqlData?: readonly {
-            readonly type: import("..").GraphQLOperationType;
+            readonly type?: import("..").GraphQLOperationType;
+            readonly keywords?: readonly string[];
             readonly name?: string;
             readonly sensitive?: boolean;
             readonly variables?: readonly string[];

package/lib/types/pxhd/PXHDUtils.d.ts

@@ -266,7 +266,8 @@ export declare namespace PXHDUtils {
                         readonly is_hype_sale?: boolean;
                     };
                     readonly graphqlData?: readonly {
-                        readonly type: import("..").GraphQLOperationType;
+                        readonly type?: import("..").GraphQLOperationType;
+                        readonly keywords?: readonly string[];
                         readonly name?: string;
                         readonly sensitive?: boolean;
                         readonly variables?: readonly string[];
@@ -492,7 +493,8 @@ export declare namespace PXHDUtils {
                             readonly is_hype_sale?: boolean;
                         };
                         readonly graphqlData?: readonly {
-                            readonly type: import("..").GraphQLOperationType;
+                            readonly type?: import("..").GraphQLOperationType;
+                            readonly keywords?: readonly string[];
                             readonly name?: string;
                             readonly sensitive?: boolean;
                             readonly variables?: readonly string[];
@@ -649,7 +651,8 @@ export declare namespace PXHDUtils {
             readonly is_hype_sale?: boolean;
         };
         readonly graphqlData?: readonly {
-            readonly type: import("..").GraphQLOperationType;
+            readonly type?: import("..").GraphQLOperationType;
+            readonly keywords?: readonly string[];
             readonly name?: string;
             readonly sensitive?: boolean;
             readonly variables?: readonly string[];
@@ -932,7 +935,8 @@ export declare namespace PXHDUtils {
                         readonly is_hype_sale?: boolean;
                     };
                     readonly graphqlData?: readonly {
-                        readonly type: import("..").GraphQLOperationType;
+                        readonly type?: import("..").GraphQLOperationType;
+                        readonly keywords?: readonly string[];
                         readonly name?: string;
                         readonly sensitive?: boolean;
                         readonly variables?: readonly string[];
@@ -1158,7 +1162,8 @@ export declare namespace PXHDUtils {
                             readonly is_hype_sale?: boolean;
                         };
                         readonly graphqlData?: readonly {
-                            readonly type: import("..").GraphQLOperationType;
+                            readonly type?: import("..").GraphQLOperationType;
+                            readonly keywords?: readonly string[];
                             readonly name?: string;
                             readonly sensitive?: boolean;
                             readonly variables?: readonly string[];
@@ -1315,7 +1320,8 @@ export declare namespace PXHDUtils {
             readonly is_hype_sale?: boolean;
         };
         readonly graphqlData?: readonly {
-            readonly type: import("..").GraphQLOperationType;
+            readonly type?: import("..").GraphQLOperationType;
+            readonly keywords?: readonly string[];
             readonly name?: string;
             readonly sensitive?: boolean;
             readonly variables?: readonly string[];

package/lib/types/sensitive_request/SensitiveRequestUtils.d.ts

@@ -265,7 +265,8 @@ export declare namespace SensitiveRequestUtils {
                         readonly is_hype_sale?: boolean;
                     };
                     readonly graphqlData?: readonly {
-                        readonly type: import("../graphql").GraphQLOperationType;
+                        readonly type?: import("../graphql").GraphQLOperationType;
+                        readonly keywords?: readonly string[];
                         readonly name?: string;
                         readonly sensitive?: boolean;
                         readonly variables?: readonly string[];
@@ -491,7 +492,8 @@ export declare namespace SensitiveRequestUtils {
                             readonly is_hype_sale?: boolean;
                         };
                         readonly graphqlData?: readonly {
-                            readonly type: import("../graphql").GraphQLOperationType;
+                            readonly type?: import("../graphql").GraphQLOperationType;
+                            readonly keywords?: readonly string[];
                             readonly name?: string;
                             readonly sensitive?: boolean;
                             readonly variables?: readonly string[];
@@ -648,7 +650,8 @@ export declare namespace SensitiveRequestUtils {
             readonly is_hype_sale?: boolean;
         };
         readonly graphqlData?: readonly {
-            readonly type: import("../graphql").GraphQLOperationType;
+            readonly type?: import("../graphql").GraphQLOperationType;
+            readonly keywords?: readonly string[];
             readonly name?: string;
             readonly sensitive?: boolean;
             readonly variables?: readonly string[];
@@ -933,7 +936,8 @@ export declare namespace SensitiveRequestUtils {
                         readonly is_hype_sale?: boolean;
                     };
                     readonly graphqlData?: readonly {
-                        readonly type: import("../graphql").GraphQLOperationType;
+                        readonly type?: import("../graphql").GraphQLOperationType;
+                        readonly keywords?: readonly string[];
                         readonly name?: string;
                         readonly sensitive?: boolean;
                         readonly variables?: readonly string[];
@@ -1159,7 +1163,8 @@ export declare namespace SensitiveRequestUtils {
                             readonly is_hype_sale?: boolean;
                         };
                         readonly graphqlData?: readonly {
-                            readonly type: import("../graphql").GraphQLOperationType;
+                            readonly type?: import("../graphql").GraphQLOperationType;
+                            readonly keywords?: readonly string[];
                             readonly name?: string;
                             readonly sensitive?: boolean;
                             readonly variables?: readonly string[];
@@ -1316,7 +1321,8 @@ export declare namespace SensitiveRequestUtils {
             readonly is_hype_sale?: boolean;
         };
         readonly graphqlData?: readonly {
-            readonly type: import("../graphql").GraphQLOperationType;
+            readonly type?: import("../graphql").GraphQLOperationType;
+            readonly keywords?: readonly string[];
             readonly name?: string;
             readonly sensitive?: boolean;
             readonly variables?: readonly string[];

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

@@ -1,7 +1,7 @@
 import { ActivityType } from '../../activities';
-import { ConfigurationParams } from '../../config';
+import { CommonConfigurationParams, ConfigurationParams, RemoteConfigurationParams, StaticConfigurationParams } from '../../config';
 export type TelemetryActivityDetails = {
-    enforcer_configs: ConfigurationParams<unknown, unknown>;
+    enforcer_configs: TelemetryEnforcerConfiguration;
     module_version: string;
     update_reason: 'command';
     node_name?: string;
@@ -13,3 +13,8 @@ export type TelemetryActivity = {
     px_app_id: string;
     details: TelemetryActivityDetails;
 };
+export type TelemetryEnforcerConfiguration = {
+    active_config: ConfigurationParams<unknown, unknown>;
+    static_config: StaticConfigurationParams & CommonConfigurationParams<unknown, unknown>;
+    remote_config: RemoteConfigurationParams & CommonConfigurationParams<unknown, unknown>;
+};

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

@@ -10,4 +10,4 @@ export declare const PUSH_DATA_HMAC_HEADER_NAME = "x-px-pushdata";
 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 CORE_MODULE_VERSION = "JS Core 0.18.2";
+export declare const CORE_MODULE_VERSION = "JS Core 0.20.0";

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

@@ -20,3 +20,4 @@ export declare const getPropertyFromObject: <T>(object: any, ...keys: Array<stri
 export declare const sleep: (ms: number) => Promise<void>;
 export declare const algoToSubtleCryptoString: (algo: Algorithm) => string;
 export declare const algoToCryptoString: (algo: Algorithm) => string;
+export declare const telemetryConfigReplacer: (key: string, value: any) => string;

package/package.json

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