mock-config-server 2.4.0 → 3.0.1

package/dist/src/utils/types/interceptors.d.ts

@@ -1,6 +1,6 @@
 import type { CookieOptions, Request, Response } from 'express';
-export type RequestInterceptorCookieValue = string | undefined;
-export type RequestInterceptorHeaderValue = string | number | string[] | undefined;
+type RequestInterceptorCookieValue = string | undefined;
+type RequestInterceptorHeaderValue = string | number | string[] | undefined;
 export interface RequestInterceptorParams {
     request: Request;
     setDelay: (delay: number) => Promise<void>;
@@ -23,8 +23,9 @@ export interface ResponseInterceptorParams {
     clearCookie: (name: string, options?: CookieOptions) => void;
     attachment: (filename: string) => void;
 }
-export type ResponseInterceptor<Data extends any = any> = (data: Data, params: ResponseInterceptorParams) => any;
+export type ResponseInterceptor<Data = any> = (data: Data, params: ResponseInterceptorParams) => any;
 export interface Interceptors {
     request?: RequestInterceptor;
     response?: ResponseInterceptor;
 }
+export {};

package/dist/src/utils/types/rest.d.ts

@@ -1,39 +1,77 @@
 import type { Request } from 'express';
+import type { CalculateByDescriptorValueCheckMode, CheckActualValueCheckMode, CheckFunction, CheckMode, CompareWithDescriptorAnyValueCheckMode, CompareWithDescriptorValueCheckMode } from './checkModes';
 import type { Interceptors } from './interceptors';
-import type { BodyValue, CookiesValue, Data, HeadersValue, ParamsValue, QueryValue } from './values';
-export type RestEntities = 'headers' | 'cookies' | 'query' | 'params' | 'body';
-export type RestEntitiesValue = BodyValue | QueryValue | HeadersValue | CookiesValue | ParamsValue;
-export type RestEntitiesValues = {
-    [Key in RestEntities]: Key extends 'body' ? BodyValue : Key extends 'query' ? QueryValue : Key extends 'headers' ? HeadersValue : Key extends 'cookies' ? CookiesValue : Key extends 'params' ? ParamsValue : never;
+import type { Data, Primitive } from './values';
+export type RestMethod = 'get' | 'post' | 'delete' | 'put' | 'patch' | 'options';
+export type RestEntityName = 'headers' | 'cookies' | 'query' | 'params' | 'body';
+export type RestMappedEntityKey = string;
+type RestMappedEntityValue = string | number | boolean;
+type RestPlainEntityInnerValue = {
+    checkMode?: undefined;
+    call?: undefined;
+    dotAll?: undefined;
+    [key: string]: Primitive | RestPlainEntityInnerValue;
 };
-export interface RestMethodsEntities {
-    get: Exclude<RestEntities, 'body'>;
-    delete: Exclude<RestEntities, 'body'>;
-    post: RestEntities;
-    put: RestEntities;
-    patch: RestEntities;
-    options: Exclude<RestEntities, 'body'>;
+type RestPlainEntityValue = {
+    checkMode?: undefined;
+    call?: undefined;
+    dotAll?: undefined;
+    [key: string]: RestPlainEntityInnerValue | Primitive | RestEntityDescriptor;
+} | (RestPlainEntityInnerValue | Primitive | RestEntityDescriptor)[];
+type RestEntityValue<EntityName = RestEntityName> = EntityName extends 'body' ? RestPlainEntityValue : RestMappedEntityValue;
+type RestEntityValueOrValues<EntityName = RestEntityName> = RestEntityValue<EntityName> | RestEntityValue<EntityName>[];
+type RestEntityDescriptor<EntityName extends RestEntityName = RestEntityName, Check extends CheckMode = CheckMode> = EntityName extends 'body' ? Check extends Extract<CalculateByDescriptorValueCheckMode, 'function'> ? {
+    checkMode: Check;
+    value: (actualValue: any, checkFunction: CheckFunction) => boolean;
+} : Check extends CompareWithDescriptorAnyValueCheckMode ? {
+    checkMode: Check;
+    value: RestEntityValueOrValues<EntityName>;
+} : Check extends CheckActualValueCheckMode ? {
+    checkMode: Check;
+    value?: undefined;
+} : never : Check extends Extract<CalculateByDescriptorValueCheckMode, 'function'> ? {
+    checkMode: Check;
+    value: (actualValue: any, checkFunction: CheckFunction) => boolean;
+} : Check extends Extract<CalculateByDescriptorValueCheckMode, 'regExp'> ? {
+    checkMode: Check;
+    value: RegExp | RegExp[];
+} : Check extends CompareWithDescriptorValueCheckMode ? {
+    checkMode: Check;
+    value: RestEntityValueOrValues<EntityName>;
+} : Check extends CheckActualValueCheckMode ? {
+    checkMode: Check;
+    value?: undefined;
+} : never;
+export type RestEntityDescriptorOrValue<EntityName extends RestEntityName = RestEntityName> = EntityName extends 'body' ? RestEntityDescriptor<EntityName> | RestEntityValue<EntityName> : Record<RestMappedEntityKey, RestEntityDescriptor<EntityName> | RestEntityValueOrValues<EntityName>>;
+export type RestEntityDescriptorOnly<EntityName extends RestEntityName = RestEntityName> = EntityName extends 'body' ? RestEntityDescriptor<EntityName> : Record<RestMappedEntityKey, RestEntityDescriptor<EntityName>>;
+export interface RestEntityNamesByMethod {
+    get: Exclude<RestEntityName, 'body'>;
+    delete: Exclude<RestEntityName, 'body'>;
+    post: RestEntityName;
+    put: RestEntityName;
+    patch: RestEntityName;
+    options: Exclude<RestEntityName, 'body'>;
 }
-export type RestRouteConfigEntities<Method extends RestMethod> = {
-    [Key in RestMethodsEntities[Method]]?: RestEntitiesValues[Key];
+export type RestEntityByEntityName<Method extends RestMethod> = {
+    [EntityName in RestEntityNamesByMethod[Method]]?: RestEntityDescriptorOrValue<EntityName>;
 };
-export interface RestRouteConfig<Method extends RestMethod, Entities extends RestRouteConfigEntities<Method> = RestRouteConfigEntities<Method>> {
+export interface RestRouteConfig<Method extends RestMethod, Entities extends RestEntityByEntityName<Method> = RestEntityByEntityName<Method>> {
     entities?: Entities;
     data: ((request: Request, entities: Entities) => Data | Promise<Data>) | Data;
     interceptors?: Pick<Interceptors, 'response'>;
 }
-export type RestMethod = 'get' | 'post' | 'delete' | 'put' | 'patch' | 'options';
 export type RestPathString = `/${string}`;
-export interface BaseRestRequestConfig<Method extends RestMethod> {
+interface BaseRestRequestConfig<Method extends RestMethod> {
     path: RestPathString | RegExp;
     method: Method;
     routes: RestRouteConfig<Method>[];
     interceptors?: Interceptors;
 }
-export type RestGetRequestConfig = BaseRestRequestConfig<'get'>;
-export type RestPostRequestConfig = BaseRestRequestConfig<'post'>;
-export type RestPutRequestConfig = BaseRestRequestConfig<'put'>;
-export type RestDeleteRequestConfig = BaseRestRequestConfig<'delete'>;
-export type RestPatchRequestConfig = BaseRestRequestConfig<'patch'>;
-export type RestOptionsRequestConfig = BaseRestRequestConfig<'options'>;
+type RestGetRequestConfig = BaseRestRequestConfig<'get'>;
+type RestPostRequestConfig = BaseRestRequestConfig<'post'>;
+type RestPutRequestConfig = BaseRestRequestConfig<'put'>;
+type RestDeleteRequestConfig = BaseRestRequestConfig<'delete'>;
+type RestPatchRequestConfig = BaseRestRequestConfig<'patch'>;
+type RestOptionsRequestConfig = BaseRestRequestConfig<'options'>;
 export type RestRequestConfig = RestGetRequestConfig | RestPostRequestConfig | RestPutRequestConfig | RestDeleteRequestConfig | RestPatchRequestConfig | RestOptionsRequestConfig;
+export {};

package/dist/src/utils/types/server.d.ts

@@ -2,12 +2,12 @@ import type { Request } from 'express';
 import type { GraphQLRequestConfig } from './graphql';
 import type { Interceptors } from './interceptors';
 import type { RestMethod, RestRequestConfig } from './rest';
-export type StaticPathObject = {
+type StaticPathObject = {
     prefix: `/${string}`;
     path: `/${string}`;
 };
 export type StaticPath = `/${string}` | StaticPathObject | (StaticPathObject | `/${string}`)[];
-export type CorsHeader = string;
+type CorsHeader = string;
 export type CorsOrigin = string | RegExp | (RegExp | string)[];
 export type Cors = {
     origin: CorsOrigin | ((request: Request) => Promise<CorsOrigin> | CorsOrigin);
@@ -17,7 +17,7 @@ export type Cors = {
     credentials?: boolean;
     maxAge?: number;
 };
-export type Port = number;
+type Port = number;
 export type BaseUrl = `/${string}`;
 export interface RestConfig {
     baseUrl?: BaseUrl;
@@ -45,3 +45,4 @@ export interface MockServerConfigArgv {
     config?: string;
     watch?: boolean;
 }
+export {};

package/dist/src/utils/types/values.d.ts

@@ -1,10 +1,4 @@
-import type { ParsedQs } from 'qs';
 export type PlainObject = Record<string, any>;
 export type PlainFunction = (...args: any[]) => any;
-export type BodyValue = any;
-export type VariablesValue = any;
-export type QueryValue = ParsedQs;
-export type HeadersValue = Record<string, string>;
-export type CookiesValue = Record<string, string>;
-export type ParamsValue = Record<string, string>;
+export type Primitive = boolean | number | bigint | string | null | undefined | symbol;
 export type Data = boolean | number | string | any[] | Record<any, any> | null | undefined;

package/package.json

@@ -1,113 +1,113 @@
-{
-  "name": "mock-config-server",
-  "version": "2.4.0",
-  "description": "Tool that easily and quickly imitates server operation, create full fake api in few steps",
-  "author": {
-    "name": "SIBERIA CAN CODE 🧊",
-    "url": "https://github.com/siberiacancode"
-  },
-  "contributors": [
-    {
-      "name": "Dmitry Babin",
-      "url": "https://github.com/debabin"
-    },
-    {
-      "name": "Nursultan Zianurov",
-      "url": "https://github.com/MiaInturi"
-    },
-    {
-      "name": "Sergey Kryavkin",
-      "url": "https://github.com/RiceWithMeat"
-    }
-  ],
-  "license": "MIT",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "bin": {
-    "mock-config-server": "dist/bin/bin.js",
-    "mcs": "dist/bin/bin.js"
-  },
-  "files": [
-    "dist"
-  ],
-  "engines": {
-    "node": ">=14"
-  },
-  "scripts": {
-    "prepare": "husky install",
-    "build": "shx rm -rf dist && tsc -p tsconfig.production.json && tsc-alias -p tsconfig.production.json && shx cp -R src/static dist/src/static",
-    "start": "yarn build && node ./dist/bin/bin.js",
-    "dev": "nodemon --watch src --watch bin --watch mock-server.config.* -e js,ts,ejs --exec \"yarn start\"",
-    "test": "jest",
-    "type": "tsc --noEmit",
-    "lint": "eslint . --ext ts --no-error-on-unmatched-pattern",
-    "stylelint": "stylelint \"src/static/**/*.css\"",
-    "format": "prettier --write {src,bin}/**/*.ts",
-    "pretty": "yarn type && yarn format && yarn lint --fix"
-  },
-  "lint-staged": {
-    "*.css": "yarn stylelint",
-    "*.js": "yarn format",
-    "*.ts": "yarn pretty"
-  },
-  "dependencies": {
-    "@types/body-parser": "^1.19.2",
-    "@types/express": "^4.17.17",
-    "@types/flat": "^5.0.2",
-    "@types/yargs": "^17.0.24",
-    "ansi-colors": "^4.1.3",
-    "body-parser": "^1.20.0",
-    "ejs": "^3.1.9",
-    "esbuild": "^0.17.8",
-    "express": "^4.18.1",
-    "flat": "^5.0.2",
-    "graphql": "^16.6.0",
-    "please-upgrade-node": "^3.2.0",
-    "shx": "^0.3.4",
-    "yargs": "^17.7.1"
-  },
-  "devDependencies": {
-    "@types/jest": "^29.4.0",
-    "@types/supertest": "^2.0.12",
-    "@typescript-eslint/eslint-plugin": "^5.54.1",
-    "@typescript-eslint/parser": "^5.55.0",
-    "eslint": "^8.35.0",
-    "eslint-config-airbnb": "^19.0.4",
-    "eslint-config-airbnb-typescript": "^17.0.0",
-    "eslint-config-prettier": "^8.7.0",
-    "eslint-import-resolver-typescript": "^3.4.1",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-prettier": "^4.2.1",
-    "style-loader": "^3.3.2",
-    "stylelint": "^15.6.1",
-    "stylelint-config-prettier": "^9.0.5",
-    "stylelint-config-standard": "^32.0.0",
-    "stylelint-order": "^6.0.3",
-    "husky": "^8.0.1",
-    "jest": "^29.4.2",
-    "lint-staged": "^13.1.1",
-    "nodemon": "^2.0.19",
-    "prettier": "^2.8.3",
-    "supertest": "^6.3.3",
-    "ts-jest": "^29.0.3",
-    "tsc-alias": "^1.8.5",
-    "typescript": "^4.9.5"
-  },
-  "homepage": "https://github.com/siberiacancode/mock-config-server",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/siberiacancode/mock-config-server.git"
-  },
-  "keywords": [
-    "server",
-    "fake",
-    "REST",
-    "rest",
-    "API",
-    "api",
-    "mock",
-    "mocking",
-    "config",
-    "data"
-  ]
-}
+{
+  "name": "mock-config-server",
+  "version": "3.0.1",
+  "description": "Tool that easily and quickly imitates server operation, create full fake api in few steps",
+  "author": {
+    "name": "SIBERIA CAN CODE 🧊",
+    "url": "https://github.com/siberiacancode"
+  },
+  "contributors": [
+    {
+      "name": "Dmitry Babin",
+      "url": "https://github.com/debabin"
+    },
+    {
+      "name": "Nursultan Zianurov",
+      "url": "https://github.com/MiaInturi"
+    },
+    {
+      "name": "Sergey Kryavkin",
+      "url": "https://github.com/RiceWithMeat"
+    }
+  ],
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "mock-config-server": "dist/bin/bin.js",
+    "mcs": "dist/bin/bin.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=14"
+  },
+  "scripts": {
+    "prepare": "husky install && yarn build",
+    "build": "shx rm -rf dist && tsc -p tsconfig.production.json && tsc-alias -p tsconfig.production.json && shx cp -R src/static dist/src/static",
+    "start": "yarn build && node ./dist/bin/bin.js",
+    "dev": "nodemon --watch src --watch bin --watch mock-server.config.* -e js,ts,ejs --exec \"yarn start\"",
+    "test": "jest",
+    "type": "tsc --noEmit",
+    "lint": "eslint . --ext ts --no-error-on-unmatched-pattern",
+    "stylelint": "stylelint \"src/static/**/*.css\"",
+    "format": "prettier --write \"{src,bin}/**/*.ts\"",
+    "pretty": "yarn format && yarn lint --fix && yarn type"
+  },
+  "lint-staged": {
+    "*.css": "yarn stylelint",
+    "*.js": "yarn format",
+    "*.ts": "yarn pretty"
+  },
+  "dependencies": {
+    "@types/body-parser": "^1.19.2",
+    "@types/express": "^4.17.17",
+    "@types/flat": "^5.0.2",
+    "@types/yargs": "^17.0.24",
+    "ansi-colors": "^4.1.3",
+    "body-parser": "^1.20.0",
+    "ejs": "^3.1.9",
+    "esbuild": "^0.18.17",
+    "express": "^4.18.1",
+    "flat": "^5.0.2",
+    "graphql": "^16.6.0",
+    "please-upgrade-node": "^3.2.0",
+    "shx": "^0.3.4",
+    "yargs": "^17.7.1"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.4.0",
+    "@types/supertest": "^2.0.12",
+    "@typescript-eslint/eslint-plugin": "^6.2.0",
+    "@typescript-eslint/parser": "^6.2.0",
+    "eslint": "^8.35.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-airbnb-typescript": "^17.0.0",
+    "eslint-config-prettier": "^8.7.0",
+    "eslint-import-resolver-typescript": "^3.4.1",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-prettier": "^5.0.0",
+    "husky": "^8.0.1",
+    "jest": "^29.4.2",
+    "lint-staged": "^13.1.1",
+    "nodemon": "^3.0.1",
+    "prettier": "^3.0.0",
+    "style-loader": "^3.3.2",
+    "stylelint": "^15.6.1",
+    "stylelint-config-prettier": "^9.0.5",
+    "stylelint-config-standard": "^34.0.0",
+    "stylelint-order": "^6.0.3",
+    "supertest": "^6.3.3",
+    "ts-jest": "^29.0.3",
+    "tsc-alias": "^1.8.5",
+    "typescript": "^5.1.6"
+  },
+  "homepage": "https://github.com/siberiacancode/mock-config-server",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/siberiacancode/mock-config-server.git"
+  },
+  "keywords": [
+    "server",
+    "fake",
+    "REST",
+    "rest",
+    "API",
+    "api",
+    "mock",
+    "mocking",
+    "config",
+    "data"
+  ]
+}

package/dist/src/utils/helpers/config/isEntitiesEqual/isEntityValuesEqual.d.ts

@@ -1 +0,0 @@
-export declare const isEntityValuesEqual: (firstEntityValue: any, secondEntityValue: any) => boolean;

package/dist/src/utils/helpers/config/isEntitiesEqual/isEntityValuesEqual.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isEntityValuesEqual = void 0;
-const flat_1 = require("flat");
-const isPlainObject_1 = require("../../isPlainObject/isPlainObject");
-const isEntityValuesEqual = (firstEntityValue, secondEntityValue) => {
-    const isValuesArePlainObjects = (0, isPlainObject_1.isPlainObject)(firstEntityValue) && (0, isPlainObject_1.isPlainObject)(secondEntityValue);
-    if (isValuesArePlainObjects) {
-        const flattenFirstEntityValue = (0, flat_1.flatten)(firstEntityValue);
-        const flattenSecondEntityValue = (0, flat_1.flatten)(secondEntityValue);
-        return Object.keys(flattenFirstEntityValue).every((key) => 
-        // ✅ important:
-        // call 'toString' for ignore types of values
-        flattenFirstEntityValue[key].toString() === flattenSecondEntityValue[key]?.toString());
-    }
-    const isValuesAreArrays = Array.isArray(firstEntityValue) && Array.isArray(secondEntityValue);
-    if (isValuesAreArrays) {
-        const flattenFirstEntityValue = (0, flat_1.flatten)(firstEntityValue);
-        const flattenSecondEntityValue = (0, flat_1.flatten)(secondEntityValue);
-        return (Object.keys(flattenFirstEntityValue).length ===
-            Object.keys(flattenSecondEntityValue).length &&
-            Object.keys(flattenFirstEntityValue).every((key) => 
-            // ✅ important:
-            // call 'toString' for ignore types of values
-            flattenFirstEntityValue[key].toString() === flattenSecondEntityValue[key].toString()));
-    }
-    return `${firstEntityValue}` === `${secondEntityValue}`;
-};
-exports.isEntityValuesEqual = isEntityValuesEqual;