Merge pull request #9 from Crowdhandler/improvement/validateRequest-custom-parameters

Improvement/validate request custom parameters

Author: luke-owen-crowdhandler

README.md

@@ -130,18 +130,32 @@ await gatekeeper.recordPerformance();
 
 ## Core Methods
 
-### gatekeeper.validateRequest()
+### gatekeeper.validateRequest(params?)
 
 The primary method for validating requests against CrowdHandler's queue system. This method determines whether a user should be granted access to your protected resource or sent to a waiting room.
 
 ```javascript
+// Basic usage
 const result = await gatekeeper.validateRequest();
+
+// With custom parameters
+const result = await gatekeeper.validateRequest({
+  custom: {
+    code: 'ABC123',
+    captcha: 'xK9mN2pQ5vL8wR3tY6uZ1aS4dF7gH0j'
+  }
+});
 ```
 
+**Parameters:**
+
+- `params` (optional) - Object containing custom parameters
+  - `custom` - Object with any key-value pairs to send to the CrowdHandler API
+
 **How it works:**
 
 1. **Token Check**: First checks for an existing CrowdHandler session token in cookies
-2. **API Validation**: Sends the token (or generates a new one) to CrowdHandler's API
+2. **API Validation**: Sends the token (or generates a new one) to CrowdHandler's API, including any custom parameters
 3. **Queue Position**: Determines if the user is promoted based on current capacity
 4. **Response**: Returns instructions on how to handle the request
 

dist/client/resource.js

@@ -14,6 +14,28 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Resource = void 0;
 var base_client_1 = require("./base_client");
@@ -44,11 +66,19 @@ var Resource = /** @class */ (function (_super) {
             id = "";
         }
         this.path = this.formatPath(this.path, id);
-        return _super.prototype.httpGET.call(this, this.path, params);
+        // Extract custom parameters and spread them with other params
+        var _a = params || {}, custom = _a.custom, standardParams = __rest(_a, ["custom"]);
+        var requestParams = __assign(__assign({}, standardParams), custom // Spread custom parameters at the root level
+        );
+        return _super.prototype.httpGET.call(this, this.path, requestParams);
     };
     Resource.prototype.post = function (body) {
         this.path = this.formatPath(this.path, "");
-        return _super.prototype.httpPOST.call(this, this.path, body);
+        // Extract custom parameters and spread them with other body params
+        var _a = body || {}, custom = _a.custom, standardBody = __rest(_a, ["custom"]);
+        var requestBody = __assign(__assign({}, standardBody), custom // Spread custom parameters at the root level
+        );
+        return _super.prototype.httpPOST.call(this, this.path, requestBody);
     };
     Resource.prototype.put = function (id, body) {
         this.path = this.formatPath(this.path, id);

dist/common/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Modes = exports.RecordPerformanceOptions = exports.SessionStatusWrapper = exports.HttpErrorWrapper = exports.ValidateRequestObject = exports.TokenObjectConstructor = exports.TokenObject = exports.ExtractTokenOptions = exports.SignatureSourceObject = exports.SignatureResponseObject = exports.SignatureObject = exports.RoomMetaObject = exports.LocalStorageOptions = exports.LocalStorageObject = exports.CookieObject = exports.RequestObject = exports.ProcessURLResultObject = exports.SessionRequestConfig = exports.SpecialParametersObject = exports.QueryObject = exports.GatekeeperKeyPair = exports.GatekeeperOptions = exports.RoomsConfig = exports.RoomConfig = void 0;
+exports.Modes = exports.RecordPerformanceOptions = exports.SessionStatusWrapper = exports.HttpErrorWrapper = exports.ValidateRequestObject = exports.ValidateRequestParams = exports.TokenObjectConstructor = exports.TokenObject = exports.ExtractTokenOptions = exports.SignatureSourceObject = exports.SignatureResponseObject = exports.SignatureObject = exports.RoomMetaObject = exports.LocalStorageOptions = exports.LocalStorageObject = exports.CookieObject = exports.RequestObject = exports.ProcessURLResultObject = exports.SessionRequestConfig = exports.SpecialParametersObject = exports.QueryObject = exports.GatekeeperKeyPair = exports.GatekeeperOptions = exports.RoomsConfig = exports.RoomConfig = void 0;
 var zod_1 = require("zod");
 // Lite Validator types
 exports.RoomConfig = zod_1.z.object({
@@ -52,6 +52,8 @@ exports.SessionRequestConfig = zod_1.z.object({
     lang: zod_1.z.string().optional(),
     url: zod_1.z.string().optional(),
     slug: zod_1.z.string().optional(),
+    // Allow custom parameters to be passed through
+    custom: zod_1.z.record(zod_1.z.any()).optional(),
 });
 exports.ProcessURLResultObject = zod_1.z.object({
     targetURL: zod_1.z.string(),
@@ -123,6 +125,10 @@ exports.TokenObjectConstructor = zod_1.z.object({
     tokenSignatures: zod_1.z.array(zod_1.z.any()),
     tokenValue: zod_1.z.string(),
 });
+// Custom parameters that can be passed to validateRequest
+exports.ValidateRequestParams = zod_1.z.object({
+    custom: zod_1.z.record(zod_1.z.any()).optional(),
+});
 exports.ValidateRequestObject = zod_1.z.object({
     promoted: zod_1.z.boolean(),
     stripParams: zod_1.z.boolean(),