@stuntman/client 0.1.0 → 0.1.2

package/{src/clientTestExample.ts → README.md}

@@ -1,4 +1,10 @@
-import type * as Stuntman from '@stuntman/shared';
+# Stuntman API client
+
+Client for [Stuntman](https://github.com/andrzej-woof/stuntman) proxy/mock server API
+
+## Example usage
+
+```ts
 import { Client } from './apiClient';
 import { ruleBuilder } from './ruleBuilder';
 
@@ -7,10 +13,10 @@ const client = new Client();
 const uniqueQaUserEmail = 'unique_qa_email@example.com';
 const rule = ruleBuilder()
     .limitedUse(2)
-    .onAnyRequest()
-    .withBodyJson('test', 'value')
+    .onRequestToHostname('example.com')
+    .withSearchParam('user', uniqueQaUserEmail)
     .mockResponse({
-        localFn: (req: Stuntman.Request) => {
+        localFn: (req) => {
             if (JSON.parse(req.body).email !== uniqueQaUserEmail) {
                 return {
                     status: 500,
@@ -22,3 +28,6 @@ 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,12 +1,13 @@
 {
   "name": "@stuntman/client",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Stuntman - HTTP proxy / mock API client",
   "main": "dist/index.js",
   "repository": {
     "type": "git",
     "url": "https://github.com/andrzej-woof/stuntman.git"
   },
+  "homepage": "https://github.com/andrzej-woof/stuntman#readme",
   "bugs": {
     "url": "https://github.com/andrzej-woof/stuntman/issues"
   },
@@ -31,7 +32,7 @@
   "author": "Andrzej Pasterczyk",
   "license": "MIT",
   "dependencies": {
-    "@stuntman/shared": "^0.1.0",
+    "@stuntman/shared": "^0.1.2",
     "serialize-javascript": "6.0.1",
     "uuid": "9.0.0"
   },
@@ -39,6 +40,12 @@
     "@types/serialize-javascript": "5.0.2",
     "@types/uuid": "9.0.0"
   },
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "clean": "rm -fr dist",

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));

package/src/apiClient.ts

@@ -1,181 +0,0 @@
-import serializeJavascript from 'serialize-javascript';
-import { ClientError } from './clientError';
-import { DEFAULT_API_PORT } from '@stuntman/shared';
-import type * as Stuntman from '@stuntman/shared';
-
-type ClientOptions = {
-    protocol?: 'http' | 'https';
-    host?: string;
-    port?: number;
-    timeout?: number;
-};
-
-const SERIALIZE_JAVASCRIPT_OPTIONS: serializeJavascript.SerializeJSOptions = {
-    unsafe: true,
-    ignoreFunction: true,
-};
-
-const getFunctionParams = (func: () => any) => {
-    const funstr = func.toString();
-    const params = funstr.slice(funstr.indexOf('(') + 1, funstr.indexOf(')')).match(/([^\s,]+)/g) || new Array<string>();
-    if (params.includes('=')) {
-        throw new Error('default argument values are not supported');
-    }
-    return params;
-};
-
-const serializeApiFunction = (fn: (...args: any[]) => any, variables?: Stuntman.LocalVariables): string => {
-    const variableInitializer: string[] = [];
-    const functionParams = getFunctionParams(fn);
-    if (variables) {
-        for (const varName of Object.keys(variables)) {
-            let varValue = variables[varName];
-            if (varValue === undefined || varValue === null || typeof varValue === 'number' || typeof varValue === 'boolean') {
-                varValue = `${varValue}`;
-            } else if (typeof varValue === 'string') {
-                varValue = `${serializeJavascript(variables[varName], SERIALIZE_JAVASCRIPT_OPTIONS)}`;
-            } else {
-                varValue = `eval('(${serializeJavascript(variables[varName], SERIALIZE_JAVASCRIPT_OPTIONS).replace(
-                    /'/g,
-                    "\\'"
-                )})')`;
-            }
-            variableInitializer.push(`const ${varName} = ${varValue};`);
-        }
-    }
-    const functionString = fn.toString();
-    const serializedHeader = `return ((${functionParams.map((_param, index) => `____arg${index}`).join(',')}) => {`;
-    const serializedParams = `${functionParams
-        .map((_param, index) => `const ${functionParams[index]} = ____arg${index};`)
-        .join('\n')}`;
-    const serializedVariables = `${variableInitializer.join('\n')}`;
-    // prettier-ignore
-    const serializedFunction = `return (${functionString.substring(0, functionString.indexOf('('))}()${functionString.substring(functionString.indexOf(')')+1)})(); })(${functionParams.map((_param, index) => `____arg${index}`).join(',')})`;
-    if (!serializedParams && !serializedVariables) {
-        return `${serializedHeader}${serializedFunction}`;
-    }
-    return [serializedHeader, serializedParams, serializedVariables, serializedFunction].filter((x) => !!x).join('\n');
-};
-
-const keysOf = <T extends object>(obj: T): Array<keyof T> => {
-    return Array.from(Object.keys(obj)) as any;
-};
-const serializeRemotableFunctions = <T>(obj: any): Stuntman.WithSerializedFunctions<T> => {
-    const objectKeys = keysOf(obj);
-    if (!objectKeys || objectKeys.length === 0) {
-        return obj;
-    }
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    const output: WithSerializedFunctions<T> = {};
-    for (const key of objectKeys) {
-        if (typeof obj[key] === 'object') {
-            if ('localFn' in obj[key]) {
-                const remotableFunction = obj[key] as Stuntman.RemotableFunction<(...args: any[]) => any>;
-                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                // @ts-ignore
-                output[key] = {
-                    remoteFn: serializeApiFunction(remotableFunction.localFn, remotableFunction.localVariables),
-                    localFn: remotableFunction.localFn.toString(),
-                    localVariables: serializeJavascript(remotableFunction.localVariables, SERIALIZE_JAVASCRIPT_OPTIONS),
-                };
-            } else {
-                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                // @ts-ignore
-                output[key] = serializeRemotableFunctions<any>(obj[key]);
-            }
-        } else {
-            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-            // @ts-ignore
-            output[key] = obj[key];
-        }
-    }
-    return output;
-};
-
-export class Client {
-    // TODO websockets connection to API and hooks `onIntereceptedRequest`, `onInterceptedResponse`
-
-    private options: ClientOptions;
-
-    private get baseUrl() {
-        return `${this.options.protocol}://${this.options.host}${this.options.port ? `:${this.options.port}` : ''}`;
-    }
-
-    constructor(options?: ClientOptions) {
-        this.options = {
-            ...options,
-            timeout: options?.timeout || 60000,
-            host: options?.host || 'localhost',
-            protocol: options?.protocol || 'http',
-            port: options?.port || options?.protocol ? (options.protocol === 'https' ? 443 : 80) : DEFAULT_API_PORT,
-        };
-    }
-
-    private async fetch(url: RequestInfo, init?: RequestInit): Promise<Response> {
-        const controller = new AbortController();
-        const timeout = setTimeout(() => {
-            controller.abort();
-        }, this.options.timeout);
-        try {
-            const response = await fetch(url, { ...init, signal: init?.signal ?? controller.signal });
-            if (!response.ok) {
-                const text = await response.text();
-                let json: any;
-                try {
-                    json = JSON.parse(text);
-                } catch (kiss) {
-                    // and swallow
-                }
-                if ('error' in json) {
-                    throw new ClientError(json.error);
-                }
-                throw new Error(`Unexpected errror: ${text}`);
-            }
-            return response;
-        } finally {
-            clearTimeout(timeout);
-        }
-    }
-
-    async getRules(): Promise<Stuntman.LiveRule[]> {
-        const response = await this.fetch(`${this.baseUrl}/rules`);
-        return response.json() as unknown as Promise<Stuntman.LiveRule[]>;
-    }
-
-    async getRule(id: string): Promise<Stuntman.LiveRule> {
-        const response = await this.fetch(`${this.baseUrl}/rule/${encodeURIComponent(id)}`);
-        return response.json() as unknown as Stuntman.LiveRule;
-    }
-
-    async disableRule(id: string): Promise<void> {
-        await this.fetch(`${this.baseUrl}/rule/${encodeURIComponent(id)}/disable`);
-    }
-
-    async enableRule(id: string): Promise<void> {
-        await this.fetch(`${this.baseUrl}/rule/${encodeURIComponent(id)}/enable`);
-    }
-
-    async removeRule(id: string): Promise<void> {
-        await this.fetch(`${this.baseUrl}/rule/${encodeURIComponent(id)}/remove`);
-    }
-
-    async addRule(rule: Stuntman.SerializableRule): Promise<Stuntman.Rule> {
-        const serializedRule = serializeRemotableFunctions<Stuntman.SerializableRule>(rule);
-        const response = await this.fetch(`${this.baseUrl}/rule`, {
-            method: 'POST',
-            body: JSON.stringify(serializedRule),
-            headers: { 'content-type': 'application/json' },
-        });
-        return response.json() as unknown as Stuntman.Rule;
-    }
-
-    // TODO improve filtering by timestamp from - to, multiple labels, etc.
-    async getTraffic(rule: Stuntman.Rule): Promise<Record<string, Stuntman.LogEntry>>;
-    async getTraffic(ruleIdOrLabel: string): Promise<Record<string, Stuntman.LogEntry>>;
-    async getTraffic(ruleOrIdOrLabel: string | Stuntman.Rule): Promise<Record<string, Stuntman.LogEntry>> {
-        const ruleId = typeof ruleOrIdOrLabel === 'object' ? ruleOrIdOrLabel.id : ruleOrIdOrLabel;
-        const response = await this.fetch(`${this.baseUrl}/traffic${ruleId ? `/${encodeURIComponent(ruleId)}` : ''}`);
-        return response.json() as unknown as Record<string, Stuntman.LogEntry>;
-    }
-}

package/src/clientError.ts

@@ -1,22 +0,0 @@
-import { AppError } from '@stuntman/shared';
-import type * as Stuntman from '@stuntman/shared';
-
-export enum HttpCode {
-    OK = 200,
-    NO_CONTENT = 204,
-    BAD_REQUEST = 400,
-    UNAUTHORIZED = 401,
-    NOT_FOUND = 404,
-    CONFLICT = 409,
-    UNPROCESSABLE_ENTITY = 422,
-    INTERNAL_SERVER_ERROR = 500,
-}
-
-export class ClientError extends AppError {
-    public readonly originalStack?: string;
-
-    constructor(args: Stuntman.AppError & { stack?: string }) {
-        super(args);
-        this.originalStack = args.stack;
-    }
-}

package/src/index.ts

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

package/src/ruleBuilder.ts

@@ -1,458 +0,0 @@
-import { v4 as uuidv4 } from 'uuid';
-import type * as Stuntman from '@stuntman/shared';
-import { DEFAULT_RULE_PRIORITY, DEFAULT_RULE_TTL_SECONDS, MAX_RULE_TTL_SECONDS, MIN_RULE_TTL_SECONDS } from '@stuntman/shared';
-
-type KeyValueMatcher = string | RegExp | { key: string; value?: string | RegExp };
-type ObjectValueMatcher = string | RegExp | number | boolean | null;
-type ObjectKeyValueMatcher = { key: string; value?: ObjectValueMatcher };
-type GQLRequestMatcher = {
-    operationName?: string | RegExp;
-    variables?: ObjectKeyValueMatcher[];
-    query?: string | RegExp;
-    type?: 'query' | 'mutation';
-    methodName?: string | RegExp;
-};
-
-type MatchBuilderVariables = {
-    filter?: string | RegExp;
-    hostname?: string | RegExp;
-    pathname?: string | RegExp;
-    port?: number | string | RegExp;
-    searchParams?: KeyValueMatcher[];
-    headers?: KeyValueMatcher[];
-    bodyText?: string | RegExp | null;
-    bodyJson?: ObjectKeyValueMatcher[];
-    bodyGql?: GQLRequestMatcher;
-};
-
-// eslint-disable-next-line no-var
-declare var matchBuilderVariables: MatchBuilderVariables;
-
-// TODO add fluent match on multipart from data
-
-class RuleBuilderBaseBase {
-    protected rule: Stuntman.SerializableRule;
-    protected _matchBuilderVariables: MatchBuilderVariables;
-
-    constructor(rule?: Stuntman.SerializableRule, _matchBuilderVariables?: MatchBuilderVariables) {
-        this._matchBuilderVariables = _matchBuilderVariables || {};
-        this.rule = rule || {
-            id: uuidv4(),
-            ttlSeconds: DEFAULT_RULE_TTL_SECONDS,
-            priority: DEFAULT_RULE_PRIORITY,
-            matches: {
-                localFn: (req: Stuntman.Request): boolean => {
-                    const ___url = new URL(req.url);
-                    const ___headers = req.rawHeaders;
-
-                    const arrayIndexerRegex = /\[(?<arrayIndex>[0-9]*)\]/i;
-                    const matchObject = (obj: any, path: string, value?: string | RegExp | number | boolean | null): boolean => {
-                        if (!obj) {
-                            return false;
-                        }
-                        const [rawKey, ...rest] = path.split('.');
-                        const key = rawKey.replace(arrayIndexerRegex, '');
-                        const shouldBeArray = arrayIndexerRegex.test(rawKey);
-                        const arrayIndex = Number(arrayIndexerRegex.exec(rawKey)?.groups?.arrayIndex);
-                        const actualValue = key ? obj[key] : obj;
-                        if (value === undefined && actualValue === undefined) {
-                            return false;
-                        }
-                        if (rest.length === 0) {
-                            if (
-                                shouldBeArray &&
-                                (!Array.isArray(actualValue) ||
-                                    !(!Number.isInteger(arrayIndex) && actualValue.length > Number(arrayIndex)))
-                            ) {
-                                return false;
-                            }
-                            if (value === undefined) {
-                                return shouldBeArray
-                                    ? !Number.isInteger(arrayIndex) || actualValue.length >= Number(arrayIndex)
-                                    : actualValue !== undefined;
-                            }
-                            if (!shouldBeArray) {
-                                return value instanceof RegExp ? value.test(actualValue) : value === actualValue;
-                            }
-                        }
-                        if (shouldBeArray) {
-                            return Number.isInteger(arrayIndex)
-                                ? matchObject(actualValue[Number(arrayIndex)], rest.join('.'), value)
-                                : (actualValue as Array<any>).some((arrayValue) =>
-                                      matchObject(arrayValue, rest.join('.'), value)
-                                  );
-                        }
-                        return typeof actualValue !== 'object' ? false : matchObject(actualValue, rest.join('.'), value);
-                    };
-
-                    const ___matchesValue = (matcher: number | string | RegExp | undefined, value?: string | number): boolean => {
-                        if (matcher === undefined) {
-                            return true;
-                        }
-                        if (typeof matcher !== 'string' && !(matcher instanceof RegExp) && typeof matcher !== 'number') {
-                            throw new Error('invalid matcher');
-                        }
-                        if (typeof matcher === 'string' && matcher !== value) {
-                            return false;
-                        }
-                        if (matcher instanceof RegExp && (typeof value !== 'string' || !matcher.test(value))) {
-                            return false;
-                        }
-                        if (typeof matcher === 'number' && (typeof value !== 'number' || matcher !== value)) {
-                            return false;
-                        }
-                        return true;
-                    };
-                    if (!___matchesValue(matchBuilderVariables.filter, req.url)) {
-                        return false;
-                    }
-                    if (!___matchesValue(matchBuilderVariables.hostname, ___url.hostname)) {
-                        return false;
-                    }
-                    if (!___matchesValue(matchBuilderVariables.pathname, ___url.pathname)) {
-                        return false;
-                    }
-                    if (matchBuilderVariables.searchParams) {
-                        for (const searchParamMatcher of matchBuilderVariables.searchParams) {
-                            if (typeof searchParamMatcher === 'string') {
-                                return ___url.searchParams.has(searchParamMatcher);
-                            }
-                            if (searchParamMatcher instanceof RegExp) {
-                                return Array.from(___url.searchParams.keys()).some((key) => searchParamMatcher.test(key));
-                            }
-                            if (!___url.searchParams.has(searchParamMatcher.key)) {
-                                return false;
-                            }
-                            if (searchParamMatcher.value) {
-                                const value = ___url.searchParams.get(searchParamMatcher.key);
-                                if (value === null) {
-                                    return false;
-                                }
-                                if (!___matchesValue(searchParamMatcher.value, value)) {
-                                    return false;
-                                }
-                            }
-                        }
-                    }
-                    if (matchBuilderVariables.headers) {
-                        for (const headerMatcher of matchBuilderVariables.headers) {
-                            if (typeof headerMatcher === 'string') {
-                                return ___headers.has(headerMatcher);
-                            }
-                            if (headerMatcher instanceof RegExp) {
-                                return ___headers.toHeaderPairs().some(([key]) => headerMatcher.test(key));
-                            }
-                            if (!___headers.has(headerMatcher.key)) {
-                                return false;
-                            }
-                            if (headerMatcher.value) {
-                                const value = ___headers.get(headerMatcher.key);
-                                if (value === null) {
-                                    return false;
-                                }
-                                if (!___matchesValue(headerMatcher.value, value as string)) {
-                                    return false;
-                                }
-                            }
-                        }
-                    }
-                    if (matchBuilderVariables.bodyText === null && !!req.body) {
-                        return false;
-                    }
-                    if (matchBuilderVariables.bodyText) {
-                        if (!___matchesValue(matchBuilderVariables.bodyText, req.body)) {
-                            return false;
-                        }
-                    }
-                    if (matchBuilderVariables.bodyJson) {
-                        let json: any;
-                        try {
-                            json = JSON.parse(req.body);
-                        } catch (kiss) {
-                            return false;
-                        }
-                        if (!json) {
-                            return false;
-                        }
-                        for (const jsonMatcher of Array.isArray(matchBuilderVariables.bodyJson)
-                            ? matchBuilderVariables.bodyJson
-                            : [matchBuilderVariables.bodyJson]) {
-                            if (!matchObject(json, jsonMatcher.key, jsonMatcher.value)) {
-                                return false;
-                            }
-                        }
-                    }
-                    if (matchBuilderVariables.bodyGql) {
-                        if (!req.gqlBody) {
-                            return false;
-                        }
-                        if (!___matchesValue(matchBuilderVariables.bodyGql.methodName, req.gqlBody.methodName)) {
-                            return false;
-                        }
-                        if (!___matchesValue(matchBuilderVariables.bodyGql.operationName, req.gqlBody.operationName)) {
-                            return false;
-                        }
-                        if (!___matchesValue(matchBuilderVariables.bodyGql.query, req.gqlBody.query)) {
-                            return false;
-                        }
-                        if (!___matchesValue(matchBuilderVariables.bodyGql.type, req.gqlBody.type)) {
-                            return false;
-                        }
-                        if (!matchBuilderVariables.bodyGql.variables) {
-                            return true;
-                        }
-                        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;
-                            }
-                        }
-                    }
-                    return true;
-                },
-                localVariables: { matchBuilderVariables: this._matchBuilderVariables },
-            },
-        };
-    }
-}
-
-class RuleBuilderBase extends RuleBuilderBaseBase {
-    limitedUse(hitCount: number) {
-        if (Number.isNaN(hitCount) || !Number.isFinite(hitCount) || !Number.isInteger(hitCount) || hitCount <= 0) {
-            throw new Error('Invalid hitCount');
-        }
-        this.rule.removeAfterUse = hitCount;
-        return this;
-    }
-
-    singleUse() {
-        return this.limitedUse(1);
-    }
-
-    storeTraffic() {
-        this.rule.storeTraffic = true;
-        return this;
-    }
-
-    disabled() {
-        this.rule.isEnabled = false;
-    }
-}
-
-class RuleBuilder extends RuleBuilderBase {
-    raisePriority(by?: number) {
-        const subtract = by ?? 1;
-        if (subtract >= DEFAULT_RULE_PRIORITY) {
-            throw new Error(`Unable to raise priority over the default ${DEFAULT_RULE_PRIORITY}`);
-        }
-        this.rule.priority = DEFAULT_RULE_PRIORITY - subtract;
-        return this;
-    }
-
-    decreasePriority(by?: number) {
-        const add = by ?? 1;
-        this.rule.priority = DEFAULT_RULE_PRIORITY + add;
-        return this;
-    }
-
-    customTtl(ttlSeconds: number) {
-        if (Number.isNaN(ttlSeconds) || !Number.isInteger(ttlSeconds) || !Number.isFinite(ttlSeconds) || ttlSeconds < 0) {
-            throw new Error('Invalid ttl');
-        }
-        if (ttlSeconds < MIN_RULE_TTL_SECONDS || ttlSeconds > MAX_RULE_TTL_SECONDS) {
-            throw new Error(
-                `ttl of ${ttlSeconds} seconds is outside range min: ${MIN_RULE_TTL_SECONDS}, max:${MAX_RULE_TTL_SECONDS}`
-            );
-        }
-        this.rule.ttlSeconds = ttlSeconds;
-        return this;
-    }
-
-    customId(id: string) {
-        this.rule.id = id;
-        return this;
-    }
-
-    onRequestTo(filter: string | RegExp): RuleBuilderInitialized {
-        this._matchBuilderVariables.filter = filter;
-        return new RuleBuilderInitialized(this.rule, this._matchBuilderVariables);
-    }
-
-    onRequestToHostname(hostname: string | RegExp): RuleBuilderInitialized {
-        this._matchBuilderVariables.hostname = hostname;
-        return new RuleBuilderInitialized(this.rule, this._matchBuilderVariables);
-    }
-
-    onRequestToPathname(pathname: string | RegExp): RuleBuilderInitialized {
-        this._matchBuilderVariables.pathname = pathname;
-        return new RuleBuilderInitialized(this.rule, this._matchBuilderVariables);
-    }
-
-    onAnyRequest(): RuleBuilderInitialized {
-        this.rule.matches = { localFn: () => true };
-        return new RuleBuilderInitialized(this.rule, this._matchBuilderVariables);
-    }
-}
-
-class RuleBuilderInitialized extends RuleBuilderBase {
-    withHostname(hostname: string | RegExp) {
-        this._matchBuilderVariables.hostname = hostname;
-        return this;
-    }
-
-    withPathname(pathname: string | RegExp) {
-        this._matchBuilderVariables.pathname = pathname;
-        return this;
-    }
-
-    withPort(port: number | string | RegExp) {
-        this._matchBuilderVariables.port = port;
-        return this;
-    }
-
-    withSearchParam(key: string | RegExp): RuleBuilderInitialized;
-    withSearchParam(key: string, value?: string | RegExp): RuleBuilderInitialized;
-    withSearchParam(key: string | RegExp, value?: string | RegExp): RuleBuilderInitialized {
-        if (!this._matchBuilderVariables.searchParams) {
-            this._matchBuilderVariables.searchParams = [];
-        }
-        if (!key) {
-            throw new Error('key cannot be empty');
-        }
-        if (!value) {
-            this._matchBuilderVariables.searchParams.push(key);
-            return this;
-        }
-        if (key instanceof RegExp) {
-            throw new Error('Unsupported regex param key with value');
-        }
-        this._matchBuilderVariables.searchParams.push({ key, value });
-        return this;
-    }
-
-    withSearchParams(params: KeyValueMatcher[]): RuleBuilderInitialized {
-        if (!this._matchBuilderVariables.searchParams) {
-            this._matchBuilderVariables.searchParams = [];
-        }
-        for (const param of params) {
-            if (typeof param === 'string' || param instanceof RegExp) {
-                this.withSearchParam(param);
-            } else {
-                this.withSearchParam(param.key, param.value);
-            }
-        }
-        return this;
-    }
-
-    withHeader(key: string | RegExp): RuleBuilderInitialized;
-    withHeader(key: string, value?: string | RegExp): RuleBuilderInitialized;
-    withHeader(key: string | RegExp, value?: string | RegExp): RuleBuilderInitialized {
-        if (!this._matchBuilderVariables.headers) {
-            this._matchBuilderVariables.headers = [];
-        }
-        if (!key) {
-            throw new Error('key cannot be empty');
-        }
-        if (!value) {
-            this._matchBuilderVariables.headers.push(key);
-            return this;
-        }
-        if (key instanceof RegExp) {
-            throw new Error('Unsupported regex param key with value');
-        }
-        this._matchBuilderVariables.headers.push({ key, value });
-        return this;
-    }
-
-    withHeaders(headers: KeyValueMatcher[]): RuleBuilderInitialized {
-        if (!this._matchBuilderVariables.headers) {
-            this._matchBuilderVariables.headers = [];
-        }
-        for (const header of headers) {
-            if (typeof header === 'string' || header instanceof RegExp) {
-                this.withHeader(header);
-            } else {
-                this.withHeader(header.key, header.value);
-            }
-        }
-        return this;
-    }
-
-    withBodyText(includes: string): RuleBuilderInitialized;
-    withBodyText(matches: RegExp): RuleBuilderInitialized;
-    withBodyText(includesOrMatches: string | RegExp): RuleBuilderInitialized {
-        this._matchBuilderVariables.bodyText = includesOrMatches;
-        return this;
-    }
-
-    withoutBody(): RuleBuilderInitialized {
-        this._matchBuilderVariables.bodyText = null;
-        return this;
-    }
-
-    withBodyJson(hasKey: string): RuleBuilderInitialized;
-    withBodyJson(hasKey: string, withValue: ObjectValueMatcher): RuleBuilderInitialized;
-    withBodyJson(matches: ObjectKeyValueMatcher): RuleBuilderInitialized;
-    withBodyJson(keyOrMatcher: string | ObjectKeyValueMatcher, withValue?: ObjectValueMatcher): RuleBuilderInitialized {
-        const keyRegex = /^(?:(?:[a-z0-9_-]+)|(?:\[[0-9]*\]))(?:\.(?:(?:[a-z0-9_-]+)|(?:\[[0-9]*\])))*$/i;
-        if (!this._matchBuilderVariables.bodyJson) {
-            this._matchBuilderVariables.bodyJson = [];
-        }
-        if (typeof keyOrMatcher === 'string') {
-            if (!keyRegex.test(keyOrMatcher)) {
-                throw new Error('invalid key');
-            }
-            this._matchBuilderVariables.bodyJson.push({ key: keyOrMatcher, value: withValue });
-            return this;
-        }
-        if (withValue !== undefined) {
-            throw new Error('invalid usage');
-        }
-        if (!keyRegex.test(keyOrMatcher.key)) {
-            throw new Error('invalid key');
-        }
-        this._matchBuilderVariables.bodyJson.push(keyOrMatcher);
-        return this;
-    }
-
-    withBodyGql(gqlMatcher: GQLRequestMatcher): RuleBuilderInitialized {
-        this._matchBuilderVariables.bodyGql = gqlMatcher;
-        return this;
-    }
-
-    proxyPass(): Stuntman.SerializableRule {
-        return this.rule;
-    }
-
-    mockResponse(staticResponse: Stuntman.Response): Stuntman.SerializableRule;
-    mockResponse(generationFunction: Stuntman.RemotableFunction<Stuntman.ResponseGenerationFn>): Stuntman.SerializableRule;
-    mockResponse(
-        response: Stuntman.Response | Stuntman.RemotableFunction<Stuntman.ResponseGenerationFn>
-    ): Stuntman.SerializableRule {
-        this.rule.actions = { mockResponse: response };
-        return this.rule;
-    }
-
-    modifyRequest(modifyFunction: Stuntman.RemotableFunction<Stuntman.RequestManipulationFn>): RuleBuilderRequestInitialized {
-        this.rule.actions = { modifyRequest: modifyFunction };
-        return new RuleBuilderRequestInitialized(this.rule, this._matchBuilderVariables);
-    }
-
-    modifyResponse(modifyFunction: Stuntman.RemotableFunction<Stuntman.ResponseManipulationFn>): Stuntman.SerializableRule {
-        this.rule.actions = { modifyResponse: modifyFunction };
-        return this.rule;
-    }
-}
-
-class RuleBuilderRequestInitialized extends RuleBuilderBase {
-    modifyResponse(modifyFunction: Stuntman.RemotableFunction<Stuntman.ResponseManipulationFn>): Stuntman.SerializableRule {
-        if (!this.rule.actions) {
-            throw new Error('rule.actions not defined - builder implementation error');
-        }
-        this.rule.actions.modifyResponse = modifyFunction;
-        return this.rule;
-    }
-}
-
-export const ruleBuilder = () => new RuleBuilder();

package/tsconfig.json

@@ -1,16 +0,0 @@
-{
-    "compilerOptions": {
-        "target": "ES2018",
-        "module": "commonjs",
-        "rootDir": "src",
-        "declaration": true,
-        "outDir": "dist",
-        "esModuleInterop": true,
-        "forceConsistentCasingInFileNames": true,
-        "strict": true,
-        "skipLibCheck": true,
-        "typeRoots": ["node_modules/@types"],
-        "allowJs": true,
-        "moduleResolution": "node16"
-    }
-}