perimeterx-js-core 0.19.0 → 0.20.0

package/lib/cjs/config/ConfigurationBase.js

@@ -427,6 +427,20 @@ var ConfigurationBase = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(ConfigurationBase.prototype, "graphqlKeywords", {
+        get: function () {
+            return this.activeConfigParams.px_graphql_keywords;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ConfigurationBase.prototype, "extractGraphQLKeywords", {
+        get: function () {
+            return this.activeConfigParams.px_extract_graphql_keywords;
+        },
+        enumerable: false,
+        configurable: true
+    });
     Object.defineProperty(ConfigurationBase.prototype, "sensitiveGraphqlOperationNames", {
         get: function () {
             return this.activeConfigParams.px_sensitive_graphql_operation_names;

package/lib/cjs/config/defaults/DefaultCommonConfigurationParams.js

@@ -19,7 +19,7 @@ exports.DEFAULT_COMMON_CONFIGURATION_PARAMS = {
     px_advanced_blocking_response_enabled: true,
     px_max_activity_batch_size: 0,
     px_batch_activities_timeout_ms: 1000,
-    px_bypass_monitor_header: '',
+    px_bypass_monitor_header: 'x-px-block',
     px_enforced_routes: [],
     px_first_party_enabled: true,
     px_custom_first_party_prefix: '',
@@ -97,6 +97,7 @@ exports.DEFAULT_COMMON_CONFIGURATION_PARAMS = {
     px_custom_logo: '',
     px_graphql_enabled: true,
     px_graphql_routes: ['/graphql'],
+    px_graphql_keywords: [],
     px_sensitive_graphql_operation_names: [],
     px_sensitive_graphql_operation_types: [],
     px_enrich_custom_parameters: null,
@@ -118,4 +119,5 @@ exports.DEFAULT_COMMON_CONFIGURATION_PARAMS = {
     px_custom_is_monitored_request: null,
     px_custom_is_enforced_request: null,
     px_custom_is_filtered_request: null,
+    px_extract_graphql_keywords: null,
 };

package/lib/cjs/graphql/DefaultGraphQLParser.js

@@ -42,13 +42,14 @@ var http_1 = require("../http");
 var model_1 = require("./model");
 var DefaultGraphQLParser = /** @class */ (function () {
     function DefaultGraphQLParser(config) {
-        this.graphqlRoutes = config.graphqlRoutes;
-        this.sensitiveOperationNames = config.sensitiveGraphqlOperationNames;
-        this.sensitiveOperationTypes = config.sensitiveGraphqlOperationTypes;
+        this.config = config;
+        this.maxCharactersInGraphqlKeyword = 100;
+        this.maxGraphqlKeywordCount = 500;
     }
     DefaultGraphQLParser.prototype.isGraphQLRequest = function (_a) {
         var requestData = _a.requestData;
-        return (requestData.method === http_1.HttpMethod.POST && (0, utils_1.isRouteInPatterns)(requestData.url.pathname, this.graphqlRoutes));
+        return (requestData.method === http_1.HttpMethod.POST &&
+            (0, utils_1.isRouteInPatterns)(requestData.url.pathname, this.config.graphqlRoutes));
     };
     DefaultGraphQLParser.prototype.parseGraphQLRequest = function (context) {
         return __awaiter(this, void 0, void 0, function () {
@@ -56,7 +57,7 @@ var DefaultGraphQLParser = /** @class */ (function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        _a.trys.push([0, 2, , 3]);
+                        _a.trys.push([0, 3, , 4]);
                         requestData = context.requestData;
                         return [4 /*yield*/, this.getGraphQLOperationsFromBody(requestData.request, context)];
                     case 1:
@@ -65,18 +66,20 @@ var DefaultGraphQLParser = /** @class */ (function () {
                             context.logger.debug('unable to get graphql operations from request body');
                             return [2 /*return*/, null];
                         }
-                        data = this.parseGraphQLOperations(graphQLOperations);
+                        return [4 /*yield*/, this.parseGraphQLOperations(graphQLOperations, context)];
+                    case 2:
+                        data = _a.sent();
                         if (!data || data.length === 0) {
                             context.logger.debug('unable to parse graphql operations');
                             return [2 /*return*/, null];
                         }
                         context.logger.debug("".concat(data.length, " graphql operation").concat(data.length === 1 ? '' : 's', " parsed successfully"));
                         return [2 /*return*/, data];
-                    case 2:
+                    case 3:
                         e_1 = _a.sent();
                         context.logger.debug("unable to parse graphql request: ".concat(e_1));
                         return [2 /*return*/, null];
-                    case 3: return [2 /*return*/];
+                    case 4: return [2 /*return*/];
                 }
             });
         });
@@ -92,6 +95,7 @@ var DefaultGraphQLParser = /** @class */ (function () {
                     case 1:
                         body = _a.sent();
                         if (!body) {
+                            context.logger.debug("received empty graphql body when calling .json()");
                             return [2 /*return*/, null];
                         }
                         return [2 /*return*/, Array.isArray(body) ? body : [body]];
@@ -104,19 +108,31 @@ var DefaultGraphQLParser = /** @class */ (function () {
             });
         });
     };
-    DefaultGraphQLParser.prototype.parseGraphQLOperations = function (operations) {
-        var _this = this;
-        return operations.map(function (operation) { return _this.parseGraphQlOperation(operation); }).filter(function (x) { return x; });
+    DefaultGraphQLParser.prototype.parseGraphQLOperations = function (operations, context) {
+        return __awaiter(this, void 0, void 0, function () {
+            var data;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, Promise.all(operations.map(function (operation) { return _this.parseGraphQLOperation(operation, context); }))];
+                    case 1:
+                        data = _a.sent();
+                        return [2 /*return*/, data.filter(Boolean)];
+                }
+            });
+        });
     };
-    DefaultGraphQLParser.prototype.parseGraphQlOperation = function (operation) {
+    DefaultGraphQLParser.prototype.parseGraphQLOperation = function (operation, context) {
         if (!operation.query || typeof operation.query !== 'string') {
+            context.logger.debug('no query found');
             return null;
         }
         var operationNameToTypeMap = this.getOperationNameToTypeMap(operation.query);
         if (!operationNameToTypeMap) {
+            context.logger.debug('operationNameToTypeMap returned null');
             return null;
         }
-        return this.getGraphQLData(operationNameToTypeMap, operation);
+        return this.getGraphQLData(operationNameToTypeMap, operation, context);
     };
     DefaultGraphQLParser.prototype.getOperationNameToTypeMap = function (query) {
         var operationTypesString = Object.values(model_1.GraphQLOperationType).join('|');
@@ -136,28 +152,128 @@ var DefaultGraphQLParser = /** @class */ (function () {
         }
         return map;
     };
-    DefaultGraphQLParser.prototype.getGraphQLData = function (operationNameToTypeMap, operation) {
-        var name = operation.operationName ||
-            (Object.keys(operationNameToTypeMap).length === 1 ? Object.keys(operationNameToTypeMap)[0] : undefined);
-        var type = operationNameToTypeMap[name];
-        if (!type && /^\s*{/.test(operation.query)) {
-            type = model_1.GraphQLOperationType.QUERY;
+    DefaultGraphQLParser.prototype.getGraphQLData = function (operationNameToTypeMap, operation, context) {
+        return __awaiter(this, void 0, void 0, function () {
+            var name, type, data, keywords;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        name = this.getOperationName(operationNameToTypeMap, operation);
+                        type = this.getOperationType(operation, name, operationNameToTypeMap);
+                        if (!type) {
+                            return [2 /*return*/, null];
+                        }
+                        data = { type: type };
+                        if (name) {
+                            data.name = name;
+                        }
+                        return [4 /*yield*/, this.getQueryKeywords(operation.query, context)];
+                    case 1:
+                        keywords = _a.sent();
+                        if (keywords) {
+                            data.keywords = this.cleanKeywords(keywords);
+                        }
+                        if (this.isSensitiveOperation(name, type, keywords)) {
+                            data.sensitive = true;
+                        }
+                        if (operation.variables && typeof operation.variables === 'object') {
+                            data.variables = this.extractGraphQLVariableNames(operation.variables);
+                        }
+                        return [2 /*return*/, data];
+                }
+            });
+        });
+    };
+    DefaultGraphQLParser.prototype.getOperationType = function (operation, operationName, operationNameToTypeMap) {
+        if (operationName && operationNameToTypeMap[operationName]) {
+            return operationNameToTypeMap[operationName];
         }
-        if (!type) {
-            return null;
+        if (this.isGraphqlQueryShorthand(operation.query)) {
+            return model_1.GraphQLOperationType.QUERY;
         }
-        var data = { name: name, type: type };
-        if (this.isSensitiveOperation(name, type)) {
-            data.sensitive = true;
+        var match = operation.query.match(new RegExp("^\\s*(".concat(Object.values(model_1.GraphQLOperationType).join('|'), ")(?:\\s|{)")));
+        if ((match === null || match === void 0 ? void 0 : match[1]) && !operationName) {
+            return match[1];
         }
-        if (operation.variables && typeof operation.variables === 'object') {
-            data.variables = this.extractGraphQLVariableNames(operation.variables);
+        return null;
+    };
+    DefaultGraphQLParser.prototype.isGraphqlQueryShorthand = function (query) {
+        return /^\s*{/.test(query);
+    };
+    DefaultGraphQLParser.prototype.getOperationName = function (operationNameToTypeMap, operation) {
+        return (operation.operationName ||
+            (Object.keys(operationNameToTypeMap).length === 1 ? Object.keys(operationNameToTypeMap)[0] : undefined));
+    };
+    DefaultGraphQLParser.prototype.getQueryKeywords = function (query, context) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            var keywords;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        if (!(this.config.extractGraphQLKeywords && typeof this.config.extractGraphQLKeywords === 'function')) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.getQueryKeywordsFromCustomFunction(query, context)];
+                    case 1:
+                        keywords = _b.sent();
+                        if (Array.isArray(keywords)) {
+                            return [2 /*return*/, keywords];
+                        }
+                        _b.label = 2;
+                    case 2:
+                        if (((_a = this.config.graphqlKeywords) === null || _a === void 0 ? void 0 : _a.length) > 0) {
+                            return [2 /*return*/, this.getQueryKeywordsFromArray(query, context)];
+                        }
+                        return [2 /*return*/, null];
+                }
+            });
+        });
+    };
+    DefaultGraphQLParser.prototype.cleanKeywords = function (keywords) {
+        var _this = this;
+        return keywords
+            .slice(0, this.maxGraphqlKeywordCount)
+            .map(function (kw) { return kw.trim().substring(0, _this.maxCharactersInGraphqlKeyword); });
+    };
+    DefaultGraphQLParser.prototype.getQueryKeywordsFromCustomFunction = function (query, context) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                try {
+                    return [2 /*return*/, this.config.extractGraphQLKeywords(query)];
+                }
+                catch (e) {
+                    context.logger.debug("unable to extract graphql keywords via custom function: ".concat(e));
+                    return [2 /*return*/, null];
+                }
+                return [2 /*return*/];
+            });
+        });
+    };
+    DefaultGraphQLParser.prototype.getQueryKeywordsFromArray = function (query, context) {
+        var _this = this;
+        var keywords = [];
+        try {
+            this.config.graphqlKeywords.forEach(function (keyword) {
+                var pattern = _this.toGlobalRegExp(keyword);
+                var matchGroup = query.match(pattern);
+                if (!matchGroup) {
+                    return;
+                }
+                keywords = keywords.concat(matchGroup);
+            });
+        }
+        catch (e) {
+            context.logger.debug("unable to extract graphql keywords via array: ".concat(e));
+            return null;
         }
-        return data;
+        return keywords;
     };
-    DefaultGraphQLParser.prototype.isSensitiveOperation = function (operationName, operationType) {
-        return (this.sensitiveOperationTypes.some(function (type) { return type === operationType; }) ||
-            this.sensitiveOperationNames.some(function (name) { return name === operationName; }));
+    DefaultGraphQLParser.prototype.isSensitiveOperation = function (operationName, operationType, keywords) {
+        var _this = this;
+        return (this.config.sensitiveGraphqlOperationTypes.some(function (type) { return type === operationType; }) ||
+            this.config.sensitiveGraphqlOperationNames.some(function (name) {
+                var pattern = _this.toGlobalRegExp(name);
+                return pattern.test(operationName) || (keywords === null || keywords === void 0 ? void 0 : keywords.some(function (kw) { return pattern.test(kw); }));
+            }));
     };
     DefaultGraphQLParser.prototype.extractGraphQLVariableNames = function (variables) {
         var processVariables = function (variablesObj, prefix) {
@@ -174,6 +290,15 @@ var DefaultGraphQLParser = /** @class */ (function () {
         };
         return processVariables(variables, '');
     };
+    DefaultGraphQLParser.prototype.toGlobalRegExp = function (pattern) {
+        if (typeof pattern === 'string') {
+            return new RegExp(pattern, 'g');
+        }
+        if (pattern.global) {
+            return pattern;
+        }
+        return new RegExp(pattern, pattern.flags + 'g');
+    };
     return DefaultGraphQLParser;
 }());
 exports.DefaultGraphQLParser = DefaultGraphQLParser;

package/lib/cjs/graphql/ExtractGraphQLKeywordsFunction.js

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

package/lib/cjs/graphql/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./model"), exports);
 __exportStar(require("./IGraphQLParser"), exports);
 __exportStar(require("./DefaultGraphQLParser"), exports);
+__exportStar(require("./ExtractGraphQLKeywordsFunction"), exports);

package/lib/cjs/utils/constants.js

@@ -13,4 +13,4 @@ exports.PUSH_DATA_HMAC_HEADER_NAME = 'x-px-pushdata';
 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]+))?)([\/]{0,1}[^?#]*)(\?[^#]*|)(#.*|)$/;
-exports.CORE_MODULE_VERSION = 'JS Core 0.19.0';
+exports.CORE_MODULE_VERSION = 'JS Core 0.20.0';

package/lib/esm/config/ConfigurationBase.js

@@ -223,6 +223,12 @@ export class ConfigurationBase {
     get graphqlRoutes() {
         return this.activeConfigParams.px_graphql_routes;
     }
+    get graphqlKeywords() {
+        return this.activeConfigParams.px_graphql_keywords;
+    }
+    get extractGraphQLKeywords() {
+        return this.activeConfigParams.px_extract_graphql_keywords;
+    }
     get sensitiveGraphqlOperationNames() {
         return this.activeConfigParams.px_sensitive_graphql_operation_names;
     }

package/lib/esm/config/defaults/DefaultCommonConfigurationParams.js

@@ -16,7 +16,7 @@ export const DEFAULT_COMMON_CONFIGURATION_PARAMS = {
     px_advanced_blocking_response_enabled: true,
     px_max_activity_batch_size: 0,
     px_batch_activities_timeout_ms: 1000,
-    px_bypass_monitor_header: '',
+    px_bypass_monitor_header: 'x-px-block',
     px_enforced_routes: [],
     px_first_party_enabled: true,
     px_custom_first_party_prefix: '',
@@ -94,6 +94,7 @@ export const DEFAULT_COMMON_CONFIGURATION_PARAMS = {
     px_custom_logo: '',
     px_graphql_enabled: true,
     px_graphql_routes: ['/graphql'],
+    px_graphql_keywords: [],
     px_sensitive_graphql_operation_names: [],
     px_sensitive_graphql_operation_types: [],
     px_enrich_custom_parameters: null,
@@ -115,4 +116,5 @@ export const DEFAULT_COMMON_CONFIGURATION_PARAMS = {
     px_custom_is_monitored_request: null,
     px_custom_is_enforced_request: null,
     px_custom_is_filtered_request: null,
+    px_extract_graphql_keywords: null,
 };

package/lib/esm/graphql/DefaultGraphQLParser.js

@@ -2,16 +2,17 @@ import { isRouteInPatterns } from '../utils';
 import { HttpMethod } from '../http';
 import { GraphQLOperationType } from './model';
 export class DefaultGraphQLParser {
-    graphqlRoutes;
-    sensitiveOperationTypes;
-    sensitiveOperationNames;
+    config;
+    maxCharactersInGraphqlKeyword;
+    maxGraphqlKeywordCount;
     constructor(config) {
-        this.graphqlRoutes = config.graphqlRoutes;
-        this.sensitiveOperationNames = config.sensitiveGraphqlOperationNames;
-        this.sensitiveOperationTypes = config.sensitiveGraphqlOperationTypes;
+        this.config = config;
+        this.maxCharactersInGraphqlKeyword = 100;
+        this.maxGraphqlKeywordCount = 500;
     }
     isGraphQLRequest({ requestData }) {
-        return (requestData.method === HttpMethod.POST && isRouteInPatterns(requestData.url.pathname, this.graphqlRoutes));
+        return (requestData.method === HttpMethod.POST &&
+            isRouteInPatterns(requestData.url.pathname, this.config.graphqlRoutes));
     }
     async parseGraphQLRequest(context) {
         try {
@@ -21,7 +22,7 @@ export class DefaultGraphQLParser {
                 context.logger.debug('unable to get graphql operations from request body');
                 return null;
             }
-            const data = this.parseGraphQLOperations(graphQLOperations);
+            const data = await this.parseGraphQLOperations(graphQLOperations, context);
             if (!data || data.length === 0) {
                 context.logger.debug('unable to parse graphql operations');
                 return null;
@@ -36,8 +37,9 @@ export class DefaultGraphQLParser {
     }
     async getGraphQLOperationsFromBody(request, context) {
         try {
-            let body = await request.json();
+            const body = await request.json();
             if (!body) {
+                context.logger.debug(`received empty graphql body when calling .json()`);
                 return null;
             }
             return Array.isArray(body) ? body : [body];
@@ -47,18 +49,21 @@ export class DefaultGraphQLParser {
             return null;
         }
     }
-    parseGraphQLOperations(operations) {
-        return operations.map((operation) => this.parseGraphQlOperation(operation)).filter((x) => x);
+    async parseGraphQLOperations(operations, context) {
+        const data = await Promise.all(operations.map((operation) => this.parseGraphQLOperation(operation, context)));
+        return data.filter(Boolean);
     }
-    parseGraphQlOperation(operation) {
+    parseGraphQLOperation(operation, context) {
         if (!operation.query || typeof operation.query !== 'string') {
+            context.logger.debug('no query found');
             return null;
         }
         const operationNameToTypeMap = this.getOperationNameToTypeMap(operation.query);
         if (!operationNameToTypeMap) {
+            context.logger.debug('operationNameToTypeMap returned null');
             return null;
         }
-        return this.getGraphQLData(operationNameToTypeMap, operation);
+        return this.getGraphQLData(operationNameToTypeMap, operation, context);
     }
     getOperationNameToTypeMap(query) {
         const operationTypesString = Object.values(GraphQLOperationType).join('|');
@@ -78,18 +83,21 @@ export class DefaultGraphQLParser {
         }
         return map;
     }
-    getGraphQLData(operationNameToTypeMap, operation) {
-        let name = operation.operationName ||
-            (Object.keys(operationNameToTypeMap).length === 1 ? Object.keys(operationNameToTypeMap)[0] : undefined);
-        let type = operationNameToTypeMap[name];
-        if (!type && /^\s*{/.test(operation.query)) {
-            type = GraphQLOperationType.QUERY;
-        }
+    async getGraphQLData(operationNameToTypeMap, operation, context) {
+        const name = this.getOperationName(operationNameToTypeMap, operation);
+        const type = this.getOperationType(operation, name, operationNameToTypeMap);
         if (!type) {
             return null;
         }
-        const data = { name, type };
-        if (this.isSensitiveOperation(name, type)) {
+        const data = { type };
+        if (name) {
+            data.name = name;
+        }
+        const keywords = await this.getQueryKeywords(operation.query, context);
+        if (keywords) {
+            data.keywords = this.cleanKeywords(keywords);
+        }
+        if (this.isSensitiveOperation(name, type, keywords)) {
             data.sensitive = true;
         }
         if (operation.variables && typeof operation.variables === 'object') {
@@ -97,9 +105,76 @@ export class DefaultGraphQLParser {
         }
         return data;
     }
-    isSensitiveOperation(operationName, operationType) {
-        return (this.sensitiveOperationTypes.some((type) => type === operationType) ||
-            this.sensitiveOperationNames.some((name) => name === operationName));
+    getOperationType(operation, operationName, operationNameToTypeMap) {
+        if (operationName && operationNameToTypeMap[operationName]) {
+            return operationNameToTypeMap[operationName];
+        }
+        if (this.isGraphqlQueryShorthand(operation.query)) {
+            return GraphQLOperationType.QUERY;
+        }
+        const match = operation.query.match(new RegExp(`^\\s*(${Object.values(GraphQLOperationType).join('|')})(?:\\s|{)`));
+        if (match?.[1] && !operationName) {
+            return match[1];
+        }
+        return null;
+    }
+    isGraphqlQueryShorthand(query) {
+        return /^\s*{/.test(query);
+    }
+    getOperationName(operationNameToTypeMap, operation) {
+        return (operation.operationName ||
+            (Object.keys(operationNameToTypeMap).length === 1 ? Object.keys(operationNameToTypeMap)[0] : undefined));
+    }
+    async getQueryKeywords(query, context) {
+        if (this.config.extractGraphQLKeywords && typeof this.config.extractGraphQLKeywords === 'function') {
+            const keywords = await this.getQueryKeywordsFromCustomFunction(query, context);
+            if (Array.isArray(keywords)) {
+                return keywords;
+            }
+        }
+        if (this.config.graphqlKeywords?.length > 0) {
+            return this.getQueryKeywordsFromArray(query, context);
+        }
+        return null;
+    }
+    cleanKeywords(keywords) {
+        return keywords
+            .slice(0, this.maxGraphqlKeywordCount)
+            .map((kw) => kw.trim().substring(0, this.maxCharactersInGraphqlKeyword));
+    }
+    async getQueryKeywordsFromCustomFunction(query, context) {
+        try {
+            return this.config.extractGraphQLKeywords(query);
+        }
+        catch (e) {
+            context.logger.debug(`unable to extract graphql keywords via custom function: ${e}`);
+            return null;
+        }
+    }
+    getQueryKeywordsFromArray(query, context) {
+        let keywords = [];
+        try {
+            this.config.graphqlKeywords.forEach((keyword) => {
+                const pattern = this.toGlobalRegExp(keyword);
+                let matchGroup = query.match(pattern);
+                if (!matchGroup) {
+                    return;
+                }
+                keywords = keywords.concat(matchGroup);
+            });
+        }
+        catch (e) {
+            context.logger.debug(`unable to extract graphql keywords via array: ${e}`);
+            return null;
+        }
+        return keywords;
+    }
+    isSensitiveOperation(operationName, operationType, keywords) {
+        return (this.config.sensitiveGraphqlOperationTypes.some((type) => type === operationType) ||
+            this.config.sensitiveGraphqlOperationNames.some((name) => {
+                const pattern = this.toGlobalRegExp(name);
+                return pattern.test(operationName) || keywords?.some((kw) => pattern.test(kw));
+            }));
     }
     extractGraphQLVariableNames(variables) {
         const processVariables = (variablesObj, prefix) => Object.entries(variablesObj).reduce((total, [key, value]) => {
@@ -113,4 +188,13 @@ export class DefaultGraphQLParser {
         }, []);
         return processVariables(variables, '');
     }
+    toGlobalRegExp(pattern) {
+        if (typeof pattern === 'string') {
+            return new RegExp(pattern, 'g');
+        }
+        if (pattern.global) {
+            return pattern;
+        }
+        return new RegExp(pattern, pattern.flags + 'g');
+    }
 }

package/lib/esm/graphql/ExtractGraphQLKeywordsFunction.js

@@ -0,0 +1 @@
+export {};

package/lib/esm/graphql/index.js

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

package/lib/esm/utils/constants.js

@@ -10,4 +10,4 @@ export const PUSH_DATA_HMAC_HEADER_NAME = 'x-px-pushdata';
 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]+))?)([\/]{0,1}[^?#]*)(\?[^#]*|)(#.*|)$/;
-export const CORE_MODULE_VERSION = 'JS Core 0.19.0';
+export const CORE_MODULE_VERSION = 'JS Core 0.20.0';

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

@@ -268,7 +268,8 @@ export declare const createAsyncActivity: <Req, Res>(activityType: ActivityType,
                     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[];
@@ -494,7 +495,8 @@ export declare const createAsyncActivity: <Req, Res>(activityType: ActivityType,
                         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[];
@@ -651,7 +653,8 @@ export declare const createAsyncActivity: <Req, Res>(activityType: ActivityType,
         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[];
@@ -934,7 +937,8 @@ export declare const createActivityDetails: <Req, Res>(activityType: ActivityTyp
                     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[];
@@ -1160,7 +1164,8 @@ export declare const createActivityDetails: <Req, Res>(activityType: ActivityTyp
                         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[];
@@ -1317,7 +1322,8 @@ export declare const createActivityDetails: <Req, Res>(activityType: ActivityTyp
         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[];
@@ -1600,7 +1606,8 @@ export declare const createAsyncActivityCommonDetails: <Req, Res>(context: {
                     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[];
@@ -1826,7 +1833,8 @@ export declare const createAsyncActivityCommonDetails: <Req, Res>(context: {
                         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[];
@@ -1983,7 +1991,8 @@ export declare const createAsyncActivityCommonDetails: <Req, Res>(context: {
         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[];
@@ -2266,7 +2275,8 @@ export declare const createCommonActivityDetails: <Req, Res>(config: IConfigurat
                     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[];
@@ -2492,7 +2502,8 @@ export declare const createCommonActivityDetails: <Req, Res>(config: IConfigurat
                         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[];
@@ -2649,7 +2660,8 @@ export declare const createCommonActivityDetails: <Req, Res>(config: IConfigurat
         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[];
@@ -2932,7 +2944,8 @@ export declare const addRootContextDataToDetails: <Req, Res>(details: CommonActi
                     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[];
@@ -3158,7 +3171,8 @@ export declare const addRootContextDataToDetails: <Req, Res>(details: CommonActi
                         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[];
@@ -3315,7 +3329,8 @@ export declare const addRootContextDataToDetails: <Req, Res>(details: CommonActi
         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[];
@@ -3656,7 +3671,8 @@ export declare const addRiskApiDataToAsyncActivityCommonDetails: <Req, Res>(deta
                     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[];
@@ -3882,7 +3898,8 @@ export declare const addRiskApiDataToAsyncActivityCommonDetails: <Req, Res>(deta
                         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[];
@@ -4039,7 +4056,8 @@ export declare const addRiskApiDataToAsyncActivityCommonDetails: <Req, Res>(deta
         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[];
@@ -4322,7 +4340,8 @@ export declare const addResponseDataToAsyncActivityCommonDetails: <Req, Res>(det
                     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[];
@@ -4548,7 +4567,8 @@ export declare const addResponseDataToAsyncActivityCommonDetails: <Req, Res>(det
                         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[];
@@ -4705,7 +4725,8 @@ export declare const addResponseDataToAsyncActivityCommonDetails: <Req, Res>(det
         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[];
@@ -4988,7 +5009,8 @@ export declare const createPageRequestedActivityDetails: <Req, Res>(context: {
                     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[];
@@ -5214,7 +5236,8 @@ export declare const createPageRequestedActivityDetails: <Req, Res>(context: {
                         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[];
@@ -5371,7 +5394,8 @@ export declare const createPageRequestedActivityDetails: <Req, Res>(context: {
         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[];
@@ -5654,7 +5678,8 @@ export declare const createBlockActivityDetails: <Req, Res>(context: {
                     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[];
@@ -5880,7 +5905,8 @@ export declare const createBlockActivityDetails: <Req, Res>(context: {
                         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[];
@@ -6037,7 +6063,8 @@ export declare const createBlockActivityDetails: <Req, Res>(context: {
         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[];
@@ -6320,7 +6347,8 @@ export declare const createAdditionalS2SActivityDetails: <Req, Res>({ ciSendRawU
                     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[];
@@ -6546,7 +6574,8 @@ export declare const createAdditionalS2SActivityDetails: <Req, Res>({ ciSendRawU
                         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[];
@@ -6703,7 +6732,8 @@ export declare const createAdditionalS2SActivityDetails: <Req, Res>({ ciSendRawU
         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/blocker/utils.d.ts

@@ -264,7 +264,8 @@ export declare const createBlockData: <Req, Res>(config: IConfiguration<Req, Res
                     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 const createBlockData: <Req, Res>(config: IConfiguration<Req, Res
                         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 const createBlockData: <Req, Res>(config: IConfiguration<Req, Res
         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/config/ConfigurationBase.d.ts

@@ -7,6 +7,7 @@ import { CustomBlockResponseHeadersHandler, CustomPreflightHandler } from '../co
 import { ModuleMode } from '../utils';
 import { CredentialEndpointConfiguration, CredentialIntelligenceVersion, CustomLoginSuccessfulCallback, LoginSuccessfulReportingMethod } from '../products';
 import { CustomRequestFunction } from './CustomRequestFunction';
+import { ExtractGraphQLKeywordsFunction } from '../graphql/ExtractGraphQLKeywordsFunction';
 export declare abstract class ConfigurationBase<Req, Res, ParamsType extends ConfigurationParams<Req, Res> = ConfigurationParams<Req, Res>> implements IConfiguration<Req, Res, ParamsType> {
     protected activeConfigParams: ParamsType;
     protected readonly staticConfigParams: ParamsType;
@@ -73,7 +74,9 @@ export declare abstract class ConfigurationBase<Req, Res, ParamsType extends Con
     get activityBatchTimeoutMs(): number;
     get graphqlEnabled(): boolean;
     get graphqlRoutes(): Array<string | RegExp>;
-    get sensitiveGraphqlOperationNames(): string[];
+    get graphqlKeywords(): Array<string | RegExp>;
+    get extractGraphQLKeywords(): ExtractGraphQLKeywordsFunction<Req>;
+    get sensitiveGraphqlOperationNames(): Array<string | RegExp>;
     get sensitiveGraphqlOperationTypes(): string[];
     get enrichCustomParameters(): CustomParametersFunction<Req, Res>;
     get additionalActivityHandler(): AdditionalActivityHandler<Req, Res>;

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

@@ -6,6 +6,7 @@ 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.
      */

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/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/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.19.0";
+export declare const CORE_MODULE_VERSION = "JS Core 0.20.0";

package/package.json

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