@stuntman/client 0.1.2 → 0.1.3

package/README.md

@@ -30,4 +30,4 @@ const rule = ruleBuilder()
 client.addRule(rule).then((x) => console.log(x));
 ```
 
-Check [example app](https://github.com/andrzej-woof/stuntman/tree/master/packages/example#readme) for more samples
+Check [example app](https://github.com/andrzej-woof/stuntman/tree/master/apps/example#readme) for more samples

package/dist/apiClient.d.ts

@@ -4,6 +4,7 @@ type ClientOptions = {
     host?: string;
     port?: number;
     timeout?: number;
+    apiKey?: string;
 };
 export declare class Client {
     private options;

package/dist/apiClient.js

@@ -107,7 +107,14 @@ class Client {
             controller.abort();
         }, this.options.timeout);
         try {
-            const response = await fetch(url, { ...init, signal: (_a = init === null || init === void 0 ? void 0 : init.signal) !== null && _a !== void 0 ? _a : controller.signal });
+            const response = await fetch(url, {
+                ...init,
+                headers: {
+                    ...(this.options.apiKey && { 'x-api-key': this.options.apiKey }),
+                    ...init === null || init === void 0 ? void 0 : init.headers,
+                },
+                signal: (_a = init === null || init === void 0 ? void 0 : init.signal) !== null && _a !== void 0 ? _a : controller.signal,
+            });
             if (!response.ok) {
                 const text = await response.text();
                 let json;

package/dist/ruleBuilder.d.ts

@@ -45,6 +45,7 @@ declare class RuleBuilder extends RuleBuilderBase {
     onRequestTo(filter: string | RegExp): RuleBuilderInitialized;
     onRequestToHostname(hostname: string | RegExp): RuleBuilderInitialized;
     onRequestToPathname(pathname: string | RegExp): RuleBuilderInitialized;
+    onRequestToPort(port: string | number | RegExp): RuleBuilderInitialized;
     onAnyRequest(): RuleBuilderInitialized;
 }
 declare class RuleBuilderInitialized extends RuleBuilderBase {
@@ -56,7 +57,7 @@ declare class RuleBuilderInitialized extends RuleBuilderBase {
     withSearchParams(params: KeyValueMatcher[]): RuleBuilderInitialized;
     withHeader(key: string | RegExp): RuleBuilderInitialized;
     withHeader(key: string, value?: string | RegExp): RuleBuilderInitialized;
-    withHeaders(headers: KeyValueMatcher[]): RuleBuilderInitialized;
+    withHeaders(...headers: KeyValueMatcher[]): RuleBuilderInitialized;
     withBodyText(includes: string): RuleBuilderInitialized;
     withBodyText(matches: RegExp): RuleBuilderInitialized;
     withoutBody(): RuleBuilderInitialized;
@@ -67,11 +68,12 @@ declare class RuleBuilderInitialized extends RuleBuilderBase {
     proxyPass(): Stuntman.SerializableRule;
     mockResponse(staticResponse: Stuntman.Response): Stuntman.SerializableRule;
     mockResponse(generationFunction: Stuntman.RemotableFunction<Stuntman.ResponseGenerationFn>): Stuntman.SerializableRule;
-    modifyRequest(modifyFunction: Stuntman.RemotableFunction<Stuntman.RequestManipulationFn>): RuleBuilderRequestInitialized;
-    modifyResponse(modifyFunction: Stuntman.RemotableFunction<Stuntman.ResponseManipulationFn>): Stuntman.SerializableRule;
+    mockResponse(localFn: Stuntman.ResponseGenerationFn, localVariables?: Stuntman.LocalVariables): Stuntman.SerializableRule;
+    modifyRequest(modifyFunction: Stuntman.RequestManipulationFn | Stuntman.RemotableFunction<Stuntman.RequestManipulationFn>, localVariables?: Stuntman.LocalVariables): RuleBuilderRequestInitialized;
+    modifyResponse(modifyFunction: Stuntman.ResponseManipulationFn | Stuntman.RemotableFunction<Stuntman.ResponseManipulationFn>, localVariables?: Stuntman.LocalVariables): Stuntman.SerializableRule;
 }
 declare class RuleBuilderRequestInitialized extends RuleBuilderBase {
-    modifyResponse(modifyFunction: Stuntman.RemotableFunction<Stuntman.ResponseManipulationFn>): Stuntman.SerializableRule;
+    modifyResponse(modifyFunction: Stuntman.ResponseManipulationFn | Stuntman.RemotableFunction<Stuntman.ResponseManipulationFn>, localVariables?: Stuntman.LocalVariables): Stuntman.SerializableRule;
 }
 export declare const ruleBuilder: () => RuleBuilder;
 export {};

package/dist/ruleBuilder.js

@@ -13,19 +13,21 @@ class RuleBuilderBaseBase {
             priority: shared_1.DEFAULT_RULE_PRIORITY,
             matches: {
                 localFn: (req) => {
-                    var _a, _b, _c;
+                    var _a, _b, _c, _d;
                     const ___url = new URL(req.url);
                     const ___headers = req.rawHeaders;
                     const arrayIndexerRegex = /\[(?<arrayIndex>[0-9]*)\]/i;
                     const matchObject = (obj, path, value, parentPath) => {
-                        var _a, _b;
+                        var _a, _b, _c, _d;
                         if (!obj) {
                             return { result: false, description: `${parentPath} is falsey` };
                         }
                         const [rawKey, ...rest] = path.split('.');
                         const key = rawKey.replace(arrayIndexerRegex, '');
                         const shouldBeArray = arrayIndexerRegex.test(rawKey);
-                        const arrayIndex = Number((_b = (_a = arrayIndexerRegex.exec(rawKey)) === null || _a === void 0 ? void 0 : _a.groups) === null || _b === void 0 ? void 0 : _b.arrayIndex);
+                        const arrayIndex = (((_b = (_a = arrayIndexerRegex.exec(rawKey)) === null || _a === void 0 ? void 0 : _a.groups) === null || _b === void 0 ? void 0 : _b.arrayIndex) || '').length > 0
+                            ? Number((_d = (_c = arrayIndexerRegex.exec(rawKey)) === null || _c === void 0 ? void 0 : _c.groups) === null || _d === void 0 ? void 0 : _d.arrayIndex)
+                            : Number.NaN;
                         const actualValue = key ? obj[key] : obj;
                         const currentPath = `${parentPath ? `${parentPath}.` : ''}${rawKey}`;
                         if (value === undefined && actualValue === undefined) {
@@ -34,7 +36,7 @@ class RuleBuilderBaseBase {
                         if (rest.length === 0) {
                             if (shouldBeArray &&
                                 (!Array.isArray(actualValue) ||
-                                    !(!Number.isInteger(arrayIndex) && actualValue.length > Number(arrayIndex)))) {
+                                    (Number.isInteger(arrayIndex) && actualValue.length <= Number(arrayIndex)))) {
                                 return { result: false, description: `${currentPath} empty array` };
                             }
                             if (value === undefined) {
@@ -52,7 +54,7 @@ class RuleBuilderBaseBase {
                             if (Number.isInteger(arrayIndex)) {
                                 return matchObject(actualValue[Number(arrayIndex)], rest.join('.'), value, currentPath);
                             }
-                            const hasArrayMatch = actualValue.some((arrayValue) => matchObject(arrayValue, rest.join('.'), value, currentPath));
+                            const hasArrayMatch = actualValue.some((arrayValue) => matchObject(arrayValue, rest.join('.'), value, currentPath).result);
                             return { result: hasArrayMatch, description: `array match ${currentPath}` };
                         }
                         if (typeof actualValue !== 'object') {
@@ -96,6 +98,17 @@ class RuleBuilderBaseBase {
                             description: `pathname ${___url.pathname} doesn't match ${(_c = matchBuilderVariables.pathname) === null || _c === void 0 ? void 0 : _c.toString()}`,
                         };
                     }
+                    if (matchBuilderVariables.port) {
+                        const port = ___url.port && ___url.port !== '' ? ___url.port : ___url.protocol === 'https:' ? '443' : '80';
+                        if (!___matchesValue(matchBuilderVariables.port instanceof RegExp
+                            ? matchBuilderVariables.port
+                            : `${matchBuilderVariables.port}`, port)) {
+                            return {
+                                result: false,
+                                description: `port ${port} doesn't match ${(_d = matchBuilderVariables.port) === null || _d === void 0 ? void 0 : _d.toString()}`,
+                            };
+                        }
+                    }
                     if (matchBuilderVariables.searchParams) {
                         for (const searchParamMatcher of matchBuilderVariables.searchParams) {
                             if (typeof searchParamMatcher === 'string') {
@@ -130,11 +143,17 @@ class RuleBuilderBaseBase {
                         for (const headerMatcher of matchBuilderVariables.headers) {
                             if (typeof headerMatcher === 'string') {
                                 const result = ___headers.has(headerMatcher);
-                                return { result, description: `headers.has("${headerMatcher}")` };
+                                if (result) {
+                                    continue;
+                                }
+                                return { result: false, description: `headers.has("${headerMatcher}")` };
                             }
                             if (headerMatcher instanceof RegExp) {
                                 const result = ___headers.toHeaderPairs().some(([key]) => headerMatcher.test(key));
-                                return { result, description: `headers.keys matches ${headerMatcher.toString()}` };
+                                if (result) {
+                                    continue;
+                                }
+                                return { result: false, description: `headers.keys matches ${headerMatcher.toString()}` };
                             }
                             if (!___headers.has(headerMatcher.key)) {
                                 return { result: false, description: `headers.has("${headerMatcher.key}")` };
@@ -189,7 +208,8 @@ class RuleBuilderBaseBase {
                         for (const jsonMatcher of Array.isArray(matchBuilderVariables.bodyJson)
                             ? matchBuilderVariables.bodyJson
                             : [matchBuilderVariables.bodyJson]) {
-                            if (!matchObject(json, jsonMatcher.key, jsonMatcher.value)) {
+                            const matchObjectResult = matchObject(json, jsonMatcher.key, jsonMatcher.value);
+                            if (!matchObjectResult.result) {
                                 return { result: false, description: `$.${jsonMatcher.key} != "${jsonMatcher.value}"` };
                             }
                         }
@@ -246,6 +266,9 @@ class RuleBuilderBaseBase {
 }
 class RuleBuilderBase extends RuleBuilderBaseBase {
     limitedUse(hitCount) {
+        if (this.rule.removeAfterUse) {
+            throw new Error(`limit already set at ${this.rule.removeAfterUse}`);
+        }
         if (Number.isNaN(hitCount) || !Number.isFinite(hitCount) || !Number.isInteger(hitCount) || hitCount <= 0) {
             throw new Error('Invalid hitCount');
         }
@@ -265,6 +288,9 @@ class RuleBuilderBase extends RuleBuilderBaseBase {
 }
 class RuleBuilder extends RuleBuilderBase {
     raisePriority(by) {
+        if (this.rule.priority !== shared_1.DEFAULT_RULE_PRIORITY) {
+            throw new Error('you should not alter rule priority more than once');
+        }
         const subtract = by !== null && by !== void 0 ? by : 1;
         if (subtract >= shared_1.DEFAULT_RULE_PRIORITY) {
             throw new Error(`Unable to raise priority over the default ${shared_1.DEFAULT_RULE_PRIORITY}`);
@@ -273,6 +299,9 @@ class RuleBuilder extends RuleBuilderBase {
         return this;
     }
     decreasePriority(by) {
+        if (this.rule.priority !== shared_1.DEFAULT_RULE_PRIORITY) {
+            throw new Error('you should not alter rule priority more than once');
+        }
         const add = by !== null && by !== void 0 ? by : 1;
         this.rule.priority = shared_1.DEFAULT_RULE_PRIORITY + add;
         return this;
@@ -303,20 +332,33 @@ class RuleBuilder extends RuleBuilderBase {
         this._matchBuilderVariables.pathname = pathname;
         return new RuleBuilderInitialized(this.rule, this._matchBuilderVariables);
     }
+    onRequestToPort(port) {
+        this._matchBuilderVariables.port = port;
+        return new RuleBuilderInitialized(this.rule, this._matchBuilderVariables);
+    }
     onAnyRequest() {
-        return this.onRequestTo(/.*/);
+        return new RuleBuilderInitialized(this.rule, this._matchBuilderVariables);
     }
 }
 class RuleBuilderInitialized extends RuleBuilderBase {
     withHostname(hostname) {
+        if (this._matchBuilderVariables.hostname) {
+            throw new Error('hostname already set');
+        }
         this._matchBuilderVariables.hostname = hostname;
         return this;
     }
     withPathname(pathname) {
+        if (this._matchBuilderVariables.pathname) {
+            throw new Error('pathname already set');
+        }
         this._matchBuilderVariables.pathname = pathname;
         return this;
     }
     withPort(port) {
+        if (this._matchBuilderVariables.port) {
+            throw new Error('port already set');
+        }
         this._matchBuilderVariables.port = port;
         return this;
     }
@@ -368,7 +410,7 @@ class RuleBuilderInitialized extends RuleBuilderBase {
         this._matchBuilderVariables.headers.push({ key, value });
         return this;
     }
-    withHeaders(headers) {
+    withHeaders(...headers) {
         if (!this._matchBuilderVariables.headers) {
             this._matchBuilderVariables.headers = [];
         }
@@ -383,10 +425,19 @@ class RuleBuilderInitialized extends RuleBuilderBase {
         return this;
     }
     withBodyText(includesOrMatches) {
+        if (this._matchBuilderVariables.bodyText) {
+            throw new Error('bodyText already set');
+        }
+        if (this._matchBuilderVariables.bodyText === null) {
+            throw new Error('cannot use both withBodyText and withoutBody');
+        }
         this._matchBuilderVariables.bodyText = includesOrMatches;
         return this;
     }
     withoutBody() {
+        if (this._matchBuilderVariables.bodyText) {
+            throw new Error('cannot use both withBodyText and withoutBody');
+        }
         this._matchBuilderVariables.bodyText = null;
         return this;
     }
@@ -397,7 +448,7 @@ class RuleBuilderInitialized extends RuleBuilderBase {
         }
         if (typeof keyOrMatcher === 'string') {
             if (!keyRegex.test(keyOrMatcher)) {
-                throw new Error('invalid key');
+                throw new Error(`invalid key "${keyOrMatcher}"`);
             }
             this._matchBuilderVariables.bodyJson.push({ key: keyOrMatcher, value: withValue });
             return this;
@@ -406,7 +457,7 @@ class RuleBuilderInitialized extends RuleBuilderBase {
             throw new Error('invalid usage');
         }
         if (!keyRegex.test(keyOrMatcher.key)) {
-            throw new Error('invalid key');
+            throw new Error(`invalid key "${keyOrMatcher}"`);
         }
         this._matchBuilderVariables.bodyJson.push(keyOrMatcher);
         return this;
@@ -418,24 +469,52 @@ class RuleBuilderInitialized extends RuleBuilderBase {
     proxyPass() {
         return this.rule;
     }
-    mockResponse(response) {
+    mockResponse(response, localVariables) {
+        if (typeof response === 'function') {
+            this.rule.actions = { mockResponse: { localFn: response, localVariables: localVariables !== null && localVariables !== void 0 ? localVariables : {} } };
+            return this.rule;
+        }
+        if (localVariables) {
+            throw new Error('invalid call - localVariables cannot be used together with Response or RemotableFunction');
+        }
         this.rule.actions = { mockResponse: response };
         return this.rule;
     }
-    modifyRequest(modifyFunction) {
+    modifyRequest(modifyFunction, localVariables) {
+        if (typeof modifyFunction === 'function') {
+            this.rule.actions = { modifyRequest: { localFn: modifyFunction, localVariables: localVariables !== null && localVariables !== void 0 ? localVariables : {} } };
+            return new RuleBuilderRequestInitialized(this.rule, this._matchBuilderVariables);
+        }
+        if (localVariables) {
+            throw new Error('invalid call - localVariables cannot be used together with Response or RemotableFunction');
+        }
         this.rule.actions = { modifyRequest: modifyFunction };
         return new RuleBuilderRequestInitialized(this.rule, this._matchBuilderVariables);
     }
-    modifyResponse(modifyFunction) {
+    modifyResponse(modifyFunction, localVariables) {
+        if (typeof modifyFunction === 'function') {
+            this.rule.actions = { modifyResponse: { localFn: modifyFunction, localVariables: localVariables !== null && localVariables !== void 0 ? localVariables : {} } };
+            return this.rule;
+        }
+        if (localVariables) {
+            throw new Error('invalid call - localVariables cannot be used together with Response or RemotableFunction');
+        }
         this.rule.actions = { modifyResponse: modifyFunction };
         return this.rule;
     }
 }
 class RuleBuilderRequestInitialized extends RuleBuilderBase {
-    modifyResponse(modifyFunction) {
+    modifyResponse(modifyFunction, localVariables) {
         if (!this.rule.actions) {
             throw new Error('rule.actions not defined - builder implementation error');
         }
+        if (typeof modifyFunction === 'function') {
+            this.rule.actions = { modifyResponse: { localFn: modifyFunction, localVariables: localVariables !== null && localVariables !== void 0 ? localVariables : {} } };
+            return this.rule;
+        }
+        if (localVariables) {
+            throw new Error('invalid call - localVariables cannot be used together with Response or RemotableFunction');
+        }
         this.rule.actions.modifyResponse = modifyFunction;
         return this.rule;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stuntman/client",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Stuntman - HTTP proxy / mock API client",
   "main": "dist/index.js",
   "repository": {
@@ -37,8 +37,12 @@
     "uuid": "9.0.0"
   },
   "devDependencies": {
+    "@jest/globals": "29.4.3",
     "@types/serialize-javascript": "5.0.2",
-    "@types/uuid": "9.0.0"
+    "@types/uuid": "9.0.0",
+    "jest": "29.4.3",
+    "ts-jest": "29.0.5",
+    "typescript": "4.9.5"
   },
   "files": [
     "dist/",
@@ -47,10 +51,10 @@
     "CHANGELOG.md"
   ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "SUPPRESS_NO_CONFIG_WARNING=1 jest",
     "clean": "rm -fr dist",
     "build": "tsc",
     "lint": "prettier --check . && eslint . --ext ts",
-    "lint:fix": "prettier --write ./src && eslint ./src --ext ts --fix"
+    "lint:fix": "prettier --write ./{src,test} && eslint ./{src,test} --ext ts --fix"
   }
 }