@stuntman/client 0.1.1 → 0.1.2

package/README.md

@@ -29,3 +29,5 @@ 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

package/dist/index.d.ts

@@ -1 +1,2 @@
 export { Client as StuntmanClient } from './apiClient';
+export { ruleBuilder } from './ruleBuilder';

package/dist/index.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StuntmanClient = void 0;
+exports.ruleBuilder = exports.StuntmanClient = void 0;
 var apiClient_1 = require("./apiClient");
 Object.defineProperty(exports, "StuntmanClient", { enumerable: true, get: function () { return apiClient_1.Client; } });
+var ruleBuilder_1 = require("./ruleBuilder");
+Object.defineProperty(exports, "ruleBuilder", { enumerable: true, get: function () { return ruleBuilder_1.ruleBuilder; } });

package/dist/ruleBuilder.js

@@ -13,43 +13,52 @@ class RuleBuilderBaseBase {
             priority: shared_1.DEFAULT_RULE_PRIORITY,
             matches: {
                 localFn: (req) => {
+                    var _a, _b, _c;
                     const ___url = new URL(req.url);
                     const ___headers = req.rawHeaders;
                     const arrayIndexerRegex = /\[(?<arrayIndex>[0-9]*)\]/i;
-                    const matchObject = (obj, path, value) => {
+                    const matchObject = (obj, path, value, parentPath) => {
                         var _a, _b;
                         if (!obj) {
-                            return false;
+                            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 actualValue = key ? obj[key] : obj;
+                        const currentPath = `${parentPath ? `${parentPath}.` : ''}${rawKey}`;
                         if (value === undefined && actualValue === undefined) {
-                            return false;
+                            return { result: false, description: `${currentPath}=undefined` };
                         }
                         if (rest.length === 0) {
                             if (shouldBeArray &&
                                 (!Array.isArray(actualValue) ||
                                     !(!Number.isInteger(arrayIndex) && actualValue.length > Number(arrayIndex)))) {
-                                return false;
+                                return { result: false, description: `${currentPath} empty array` };
                             }
                             if (value === undefined) {
-                                return shouldBeArray
+                                const result = shouldBeArray
                                     ? !Number.isInteger(arrayIndex) || actualValue.length >= Number(arrayIndex)
                                     : actualValue !== undefined;
+                                return { result, description: `${currentPath}` };
                             }
                             if (!shouldBeArray) {
-                                return value instanceof RegExp ? value.test(actualValue) : value === actualValue;
+                                const result = value instanceof RegExp ? value.test(actualValue) : value === actualValue;
+                                return { result, description: `${currentPath}` };
                             }
                         }
                         if (shouldBeArray) {
-                            return Number.isInteger(arrayIndex)
-                                ? matchObject(actualValue[Number(arrayIndex)], rest.join('.'), value)
-                                : actualValue.some((arrayValue) => matchObject(arrayValue, rest.join('.'), value));
+                            if (Number.isInteger(arrayIndex)) {
+                                return matchObject(actualValue[Number(arrayIndex)], rest.join('.'), value, currentPath);
+                            }
+                            const hasArrayMatch = actualValue.some((arrayValue) => matchObject(arrayValue, rest.join('.'), value, currentPath));
+                            return { result: hasArrayMatch, description: `array match ${currentPath}` };
                         }
-                        return typeof actualValue !== 'object' ? false : matchObject(actualValue, rest.join('.'), value);
+                        if (typeof actualValue !== 'object') {
+                            return { result: false, description: `${currentPath} not an object` };
+                        }
+                        return matchObject(actualValue, rest.join('.'), value, currentPath);
                     };
                     const ___matchesValue = (matcher, value) => {
                         if (matcher === undefined) {
@@ -70,32 +79,49 @@ class RuleBuilderBaseBase {
                         return true;
                     };
                     if (!___matchesValue(matchBuilderVariables.filter, req.url)) {
-                        return false;
+                        return {
+                            result: false,
+                            description: `url ${req.url} doesn't match ${(_a = matchBuilderVariables.filter) === null || _a === void 0 ? void 0 : _a.toString()}`,
+                        };
                     }
                     if (!___matchesValue(matchBuilderVariables.hostname, ___url.hostname)) {
-                        return false;
+                        return {
+                            result: false,
+                            description: `hostname ${___url.hostname} doesn't match ${(_b = matchBuilderVariables.hostname) === null || _b === void 0 ? void 0 : _b.toString()}`,
+                        };
                     }
                     if (!___matchesValue(matchBuilderVariables.pathname, ___url.pathname)) {
-                        return false;
+                        return {
+                            result: false,
+                            description: `pathname ${___url.pathname} doesn't match ${(_c = matchBuilderVariables.pathname) === null || _c === void 0 ? void 0 : _c.toString()}`,
+                        };
                     }
                     if (matchBuilderVariables.searchParams) {
                         for (const searchParamMatcher of matchBuilderVariables.searchParams) {
                             if (typeof searchParamMatcher === 'string') {
-                                return ___url.searchParams.has(searchParamMatcher);
+                                const result = ___url.searchParams.has(searchParamMatcher);
+                                return { result, description: `searchParams.has("${searchParamMatcher}")` };
                             }
                             if (searchParamMatcher instanceof RegExp) {
-                                return Array.from(___url.searchParams.keys()).some((key) => searchParamMatcher.test(key));
+                                const result = Array.from(___url.searchParams.keys()).some((key) => searchParamMatcher.test(key));
+                                return { result, description: `searchParams.keys() matches ${searchParamMatcher.toString()}` };
                             }
                             if (!___url.searchParams.has(searchParamMatcher.key)) {
-                                return false;
+                                return { result: false, description: `searchParams.has("${searchParamMatcher.key}")` };
                             }
                             if (searchParamMatcher.value) {
                                 const value = ___url.searchParams.get(searchParamMatcher.key);
                                 if (value === null) {
-                                    return false;
+                                    return {
+                                        result: false,
+                                        description: `searchParams.get("${searchParamMatcher.key}") === null`,
+                                    };
                                 }
                                 if (!___matchesValue(searchParamMatcher.value, value)) {
-                                    return false;
+                                    return {
+                                        result: false,
+                                        description: `searchParams.get("${searchParamMatcher.key}") = "${searchParamMatcher.value}"`,
+                                    };
                                 }
                             }
                         }
@@ -103,31 +129,50 @@ class RuleBuilderBaseBase {
                     if (matchBuilderVariables.headers) {
                         for (const headerMatcher of matchBuilderVariables.headers) {
                             if (typeof headerMatcher === 'string') {
-                                return ___headers.has(headerMatcher);
+                                const result = ___headers.has(headerMatcher);
+                                return { result, description: `headers.has("${headerMatcher}")` };
                             }
                             if (headerMatcher instanceof RegExp) {
-                                return ___headers.toHeaderPairs().some(([key]) => headerMatcher.test(key));
+                                const result = ___headers.toHeaderPairs().some(([key]) => headerMatcher.test(key));
+                                return { result, description: `headers.keys matches ${headerMatcher.toString()}` };
                             }
                             if (!___headers.has(headerMatcher.key)) {
-                                return false;
+                                return { result: false, description: `headers.has("${headerMatcher.key}")` };
                             }
                             if (headerMatcher.value) {
                                 const value = ___headers.get(headerMatcher.key);
                                 if (value === null) {
-                                    return false;
+                                    return { result: false, description: `headers.get("${headerMatcher.key}") === null` };
                                 }
                                 if (!___matchesValue(headerMatcher.value, value)) {
-                                    return false;
+                                    return {
+                                        result: false,
+                                        description: `headerMatcher.get("${headerMatcher.key}") = "${headerMatcher.value}"`,
+                                    };
                                 }
                             }
                         }
                     }
                     if (matchBuilderVariables.bodyText === null && !!req.body) {
-                        return false;
+                        return { result: false, description: `empty body` };
                     }
                     if (matchBuilderVariables.bodyText) {
-                        if (!___matchesValue(matchBuilderVariables.bodyText, req.body)) {
-                            return false;
+                        if (!req.body) {
+                            return { result: false, description: `empty body` };
+                        }
+                        if (matchBuilderVariables.bodyText instanceof RegExp) {
+                            if (!___matchesValue(matchBuilderVariables.bodyText, req.body)) {
+                                return {
+                                    result: false,
+                                    description: `body text doesn't match ${matchBuilderVariables.bodyText.toString()}`,
+                                };
+                            }
+                        }
+                        else if (!req.body.includes(matchBuilderVariables.bodyText)) {
+                            return {
+                                result: false,
+                                description: `body text doesn't include "${matchBuilderVariables.bodyText}"`,
+                            };
                         }
                     }
                     if (matchBuilderVariables.bodyJson) {
@@ -136,47 +181,63 @@ class RuleBuilderBaseBase {
                             json = JSON.parse(req.body);
                         }
                         catch (kiss) {
-                            return false;
+                            return { result: false, description: `unparseable json` };
                         }
                         if (!json) {
-                            return false;
+                            return { result: false, description: `empty json object` };
                         }
                         for (const jsonMatcher of Array.isArray(matchBuilderVariables.bodyJson)
                             ? matchBuilderVariables.bodyJson
                             : [matchBuilderVariables.bodyJson]) {
                             if (!matchObject(json, jsonMatcher.key, jsonMatcher.value)) {
-                                return false;
+                                return { result: false, description: `$.${jsonMatcher.key} != "${jsonMatcher.value}"` };
                             }
                         }
                     }
                     if (matchBuilderVariables.bodyGql) {
                         if (!req.gqlBody) {
-                            return false;
+                            return { result: false, description: `not a gql body` };
                         }
                         if (!___matchesValue(matchBuilderVariables.bodyGql.methodName, req.gqlBody.methodName)) {
-                            return false;
+                            return {
+                                result: false,
+                                description: `methodName "${matchBuilderVariables.bodyGql.methodName}" !== "${req.gqlBody.methodName}"`,
+                            };
                         }
                         if (!___matchesValue(matchBuilderVariables.bodyGql.operationName, req.gqlBody.operationName)) {
-                            return false;
+                            return {
+                                result: false,
+                                description: `operationName "${matchBuilderVariables.bodyGql.operationName}" !== "${req.gqlBody.operationName}"`,
+                            };
                         }
                         if (!___matchesValue(matchBuilderVariables.bodyGql.query, req.gqlBody.query)) {
-                            return false;
+                            return {
+                                result: false,
+                                description: `query "${matchBuilderVariables.bodyGql.query}" !== "${req.gqlBody.query}"`,
+                            };
                         }
                         if (!___matchesValue(matchBuilderVariables.bodyGql.type, req.gqlBody.type)) {
-                            return false;
+                            return {
+                                result: false,
+                                description: `type "${matchBuilderVariables.bodyGql.type}" !== "${req.gqlBody.type}"`,
+                            };
                         }
                         if (!matchBuilderVariables.bodyGql.variables) {
-                            return true;
+                            return { result: true, description: `no variables to match` };
                         }
                         for (const jsonMatcher of Array.isArray(matchBuilderVariables.bodyGql.variables)
                             ? matchBuilderVariables.bodyGql.variables
                             : [matchBuilderVariables.bodyGql.variables]) {
-                            if (!matchObject(req.gqlBody.variables, jsonMatcher.key, jsonMatcher.value)) {
-                                return false;
+                            const matchObjectResult = matchObject(req.gqlBody.variables, jsonMatcher.key, jsonMatcher.value);
+                            if (!matchObjectResult.result) {
+                                return {
+                                    result: false,
+                                    description: `GQL variable ${jsonMatcher.key} != "${jsonMatcher.value}". Detail: ${matchObjectResult.description}`,
+                                };
                             }
                         }
                     }
-                    return true;
+                    return { result: true, description: 'match' };
                 },
                 localVariables: { matchBuilderVariables: this._matchBuilderVariables },
             },
@@ -243,8 +304,7 @@ class RuleBuilder extends RuleBuilderBase {
         return new RuleBuilderInitialized(this.rule, this._matchBuilderVariables);
     }
     onAnyRequest() {
-        this.rule.matches = { localFn: () => true };
-        return new RuleBuilderInitialized(this.rule, this._matchBuilderVariables);
+        return this.onRequestTo(/.*/);
     }
 }
 class RuleBuilderInitialized extends RuleBuilderBase {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stuntman/client",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Stuntman - HTTP proxy / mock API client",
   "main": "dist/index.js",
   "repository": {
@@ -32,7 +32,7 @@
   "author": "Andrzej Pasterczyk",
   "license": "MIT",
   "dependencies": {
-    "@stuntman/shared": "^0.1.1",
+    "@stuntman/shared": "^0.1.2",
     "serialize-javascript": "6.0.1",
     "uuid": "9.0.0"
   },

package/dist/clientTestExample.d.ts

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

package/dist/clientTestExample.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const apiClient_1 = require("./apiClient");
-const ruleBuilder_1 = require("./ruleBuilder");
-const client = new apiClient_1.Client();
-const uniqueQaUserEmail = 'unique_qa_email@example.com';
-const rule = (0, ruleBuilder_1.ruleBuilder)()
-    .limitedUse(2)
-    .onAnyRequest()
-    .withBodyJson('test', 'value')
-    .mockResponse({
-    localFn: (req) => {
-        if (JSON.parse(req.body).email !== uniqueQaUserEmail) {
-            return {
-                status: 500,
-            };
-        }
-        return { status: 201 };
-    },
-    localVariables: { uniqueQaUserEmail },
-});
-client.addRule(rule).then((x) => console.log(x));