mock-config-server 5.0.0-beta.1 → 5.0.0-beta.2

package/README.md

@@ -223,6 +223,7 @@ fetch("http://localhost:31299/graphql", {
   .then((data) => console.log(data)); // {  emoji: '🦁', name: 'Nursultan' }
 ```
 
+// TODO: rewrite to handlers
 #### Entity descriptors
 
 If you need more complex logic for matching entities, you can use entity descriptors.
@@ -241,7 +242,7 @@ Allowed `checkModes`
 - endsWith - checks actual value for ending with descriptor value.
 - notEndsWith - checks actual value for non-ending with descriptor value.
 - regExp - checks actual value with descriptor regExp.
-- function - checks actual value with descriptor function.
+- fn - checks actual value with descriptor function.
 
 ```javascript
 /** @type {import('mock-config-server').FlatMockServerConfig} */
@@ -290,58 +291,10 @@ const flatMockServerConfig = [
 export default flatMockServerConfig;
 ```
 
-#### Descriptor _oneOf_ property
-
-For `checkMode` with the `value` property (all `checkMode` options except `exists` and `notExists`) you can use an array as value.
-Mock server will find matches by iterating through the array until **some** match is found.
-To be able to use this functionality you need to explicitly set `oneOf: true` property in descriptor object.
-
-```javascript
-/** @type {import('mock-config-server').FlatMockServerConfig} */
-const flatMockServerConfig = [
-  {
-    baseUrl: "/api",
-  },
-  {
-    configs: [
-      {
-        path: "/user",
-        method: "post",
-        routes: [
-          {
-            entities: {
-              // if body equals to { key1: 'value1' } OR { key2: 'value2' } then mock-config-server return 'Some user data 1'
-              body: {
-                checkMode: "equals",
-                value: [{ key1: "value1" }, { key2: "value2" }],
-                oneOf: true,
-              },
-            },
-            data: "Some user data 1",
-          },
-          {
-            entities: {
-              // if body equals to [{ key1: 'value1' }, { key2: 'value2' }] then mock-config-server return 'Some user data 2'
-              // NO `oneOf` => array processed entirely
-              body: {
-                checkMode: "equals",
-                value: [{ key1: "value1" }, { key2: "value2" }],
-              },
-            },
-            data: "Some user data 2",
-          },
-        ],
-      },
-    ],
-  },
-];
-
-export default flatMockServerConfig;
-```
-
+// TODO: rewrite
 #### Function check mode
 
-`function checkMode` is the most powerful way to describe your `entities` logic, but in most cases you will be fine using other `checkModes`.
+`fn checkMode` is the most powerful way to describe your `entities` logic, but in most cases you will be fine using other `checkModes`.
 
 `Function value` has the following signature `(actualValue, checkFunction) => boolean`.
 Return `true` if `actualValue` matches your logic or `false` otherwise.
@@ -365,14 +318,14 @@ const flatMockServerConfig = [
             entities: {
               params: {
                 postId: {
-                  checkMode: "function",
+                  checkMode: "fn",
                   value: (actualValue) =>
                     +actualValue >= 0 && +actualValue <= 50,
                 },
               },
               cookies: {
                 authToken: {
-                  checkMode: "function",
+                  checkMode: "fn",
                   value: (actualValue, checkFunction) =>
                     checkFunction("equals", actualValue, 123) ||
                     checkFunction("startsWith", actualValue, 2),

package/dist/bin/init.js

@@ -19,6 +19,7 @@ function _interop_require_default(obj) {
 }
 const init = async (argv)=>{
     try {
+        var _process_env_npm_config_user_agent;
         const response = await (0, _prompts.default)([
             {
                 name: 'withTypescript',
@@ -102,7 +103,6 @@ const init = async (argv)=>{
             ...argv,
             ...response
         });
-        var _process_env_npm_config_user_agent;
         const userAgent = (_process_env_npm_config_user_agent = process.env.npm_config_user_agent) !== null && _process_env_npm_config_user_agent !== void 0 ? _process_env_npm_config_user_agent : '';
         const packageManager = /pnpm/.test(userAgent) ? 'pnpm' : /yarn/.test(userAgent) ? 'yarn' : 'npx';
         console.log('\n');

package/dist/src/core/database/createDatabaseRoutes/storages/File/FileWriter.js

@@ -24,8 +24,8 @@ class FileWriter {
         this.filePath = filePath;
     }
     lockedWrite(data) {
-        this.nextData = data;
         var _this_nextDataPromise;
+        this.nextData = data;
         this.nextDataPromise = (_this_nextDataPromise = this.nextDataPromise) !== null && _this_nextDataPromise !== void 0 ? _this_nextDataPromise : new Promise((resolve)=>{
             this.nextDataResolve = resolve;
         });

package/dist/src/core/entities/handlers/endsWith.d.ts

@@ -0,0 +1 @@
+export declare const endsWith: (expected: unknown) => import("../../..").Comparator;

package/dist/src/core/entities/handlers/endsWith.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "endsWith", {
+    enumerable: true,
+    get: function() {
+        return endsWith;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const endsWith = (expected)=>(0, _helpers.createComparator)((actual, { endsWith })=>endsWith(actual, expected));

package/dist/src/core/entities/handlers/equals.d.ts

@@ -0,0 +1 @@
+export declare const equals: (expected: unknown) => import("../../..").Comparator;

package/dist/src/core/entities/handlers/equals.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "equals", {
+    enumerable: true,
+    get: function() {
+        return equals;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const equals = (expected)=>(0, _helpers.createComparator)((actual, { equals })=>equals(actual, expected));

package/dist/src/core/entities/handlers/every.d.ts

@@ -0,0 +1,2 @@
+import type { Comparator } from '../../../utils/types';
+export declare const every: (...comparators: Comparator[]) => Comparator;

package/dist/src/core/entities/handlers/every.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "every", {
+    enumerable: true,
+    get: function() {
+        return every;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const every = (...comparators)=>(0, _helpers.createComparator)((actual, { fn })=>comparators.every((comparator)=>fn(actual, comparator)));

package/dist/src/core/entities/handlers/exists.d.ts

@@ -0,0 +1 @@
+export declare const exists: () => import("../../..").Comparator;

package/dist/src/core/entities/handlers/exists.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "exists", {
+    enumerable: true,
+    get: function() {
+        return exists;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const exists = ()=>(0, _helpers.createComparator)((actual, { exists })=>exists(actual));

package/dist/src/core/entities/handlers/fn.d.ts

@@ -0,0 +1,2 @@
+import type { Comparator } from '../../../utils/types';
+export declare const fn: (expected: Comparator) => Comparator;

package/dist/src/core/entities/handlers/fn.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "fn", {
+    enumerable: true,
+    get: function() {
+        return fn;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const fn = (expected)=>(0, _helpers.createComparator)((actual, { fn })=>fn(actual, expected));

package/dist/src/core/entities/handlers/greater.d.ts

@@ -0,0 +1 @@
+export declare const greater: (expected: number) => import("../../..").Comparator;

package/dist/src/core/entities/handlers/greater.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "greater", {
+    enumerable: true,
+    get: function() {
+        return greater;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const greater = (expected)=>(0, _helpers.createComparator)((actual, { greater })=>greater(actual, expected));

package/dist/src/core/entities/handlers/greaterOrEquals.d.ts

@@ -0,0 +1 @@
+export declare const greaterOrEquals: (expected: number) => import("../../..").Comparator;

package/dist/src/core/entities/handlers/greaterOrEquals.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "greaterOrEquals", {
+    enumerable: true,
+    get: function() {
+        return greaterOrEquals;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const greaterOrEquals = (expected)=>(0, _helpers.createComparator)((actual, { greaterOrEquals })=>greaterOrEquals(actual, expected));

package/dist/src/core/entities/handlers/haveEntries.d.ts

@@ -0,0 +1,2 @@
+import type { PlainObject } from '../../../utils/types';
+export declare const haveEntries: (expected: any[] | PlainObject) => import("../../../utils/types").Comparator;

package/dist/src/core/entities/handlers/haveEntries.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "haveEntries", {
+    enumerable: true,
+    get: function() {
+        return haveEntries;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const haveEntries = (expected)=>(0, _helpers.createComparator)((actual, { haveEntries })=>haveEntries(actual, expected));

package/dist/src/core/entities/handlers/haveType.d.ts

@@ -0,0 +1,2 @@
+import type { HaveTypeTypes } from '../../../utils/helpers';
+export declare const haveType: (expected: HaveTypeTypes) => import("../../..").Comparator;

package/dist/src/core/entities/handlers/haveType.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "haveType", {
+    enumerable: true,
+    get: function() {
+        return haveType;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const haveType = (expected)=>(0, _helpers.createComparator)((actual, { haveType })=>haveType(actual, expected));

package/dist/src/core/entities/handlers/inRange.d.ts

@@ -0,0 +1 @@
+export declare const inRange: (expected: [number, number]) => import("../../..").Comparator;

package/dist/src/core/entities/handlers/inRange.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "inRange", {
+    enumerable: true,
+    get: function() {
+        return inRange;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const inRange = (expected)=>(0, _helpers.createComparator)((actual, { inRange })=>inRange(actual, expected));

package/dist/src/core/entities/handlers/includes.d.ts

@@ -0,0 +1 @@
+export declare const includes: (expected: unknown) => import("../../..").Comparator;

package/dist/src/core/entities/handlers/includes.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "includes", {
+    enumerable: true,
+    get: function() {
+        return includes;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const includes = (expected)=>(0, _helpers.createComparator)((actual, { includes })=>includes(actual, expected));

package/dist/src/core/entities/handlers/index.d.ts

@@ -0,0 +1,21 @@
+export * from './endsWith';
+export * from './equals';
+export * from './every';
+export * from './exists';
+export * from './fn';
+export * from './greater';
+export * from './greaterOrEquals';
+export * from './haveEntries';
+export * from './haveType';
+export * from './includes';
+export * from './inRange';
+export * from './length';
+export * from './less';
+export * from './lessOrEquals';
+export * from './maxLength';
+export * from './minLength';
+export * from './not';
+export * from './oneOf';
+export * from './regExp';
+export * from './some';
+export * from './startsWith';

package/dist/src/core/entities/handlers/index.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./endsWith"), exports);
+_export_star(require("./equals"), exports);
+_export_star(require("./every"), exports);
+_export_star(require("./exists"), exports);
+_export_star(require("./fn"), exports);
+_export_star(require("./greater"), exports);
+_export_star(require("./greaterOrEquals"), exports);
+_export_star(require("./haveEntries"), exports);
+_export_star(require("./haveType"), exports);
+_export_star(require("./includes"), exports);
+_export_star(require("./inRange"), exports);
+_export_star(require("./length"), exports);
+_export_star(require("./less"), exports);
+_export_star(require("./lessOrEquals"), exports);
+_export_star(require("./maxLength"), exports);
+_export_star(require("./minLength"), exports);
+_export_star(require("./not"), exports);
+_export_star(require("./oneOf"), exports);
+_export_star(require("./regExp"), exports);
+_export_star(require("./some"), exports);
+_export_star(require("./startsWith"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}

package/dist/src/core/entities/handlers/length.d.ts

@@ -0,0 +1 @@
+export declare const length: (expected: number) => import("../../..").Comparator;

package/dist/src/core/entities/handlers/length.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "length", {
+    enumerable: true,
+    get: function() {
+        return length;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const length = (expected)=>(0, _helpers.createComparator)((actual, { length })=>length(actual, expected));

package/dist/src/core/entities/handlers/less.d.ts

@@ -0,0 +1 @@
+export declare const less: (expected: number) => import("../../..").Comparator;

package/dist/src/core/entities/handlers/less.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "less", {
+    enumerable: true,
+    get: function() {
+        return less;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const less = (expected)=>(0, _helpers.createComparator)((actual, { less })=>less(actual, expected));

package/dist/src/core/entities/handlers/lessOrEquals.d.ts

@@ -0,0 +1 @@
+export declare const lessOrEquals: (expected: number) => import("../../..").Comparator;

package/dist/src/core/entities/handlers/lessOrEquals.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "lessOrEquals", {
+    enumerable: true,
+    get: function() {
+        return lessOrEquals;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const lessOrEquals = (expected)=>(0, _helpers.createComparator)((actual, { lessOrEquals })=>lessOrEquals(actual, expected));

package/dist/src/core/entities/handlers/maxLength.d.ts

@@ -0,0 +1 @@
+export declare const maxLength: (expected: number) => import("../../..").Comparator;

package/dist/src/core/entities/handlers/maxLength.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "maxLength", {
+    enumerable: true,
+    get: function() {
+        return maxLength;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const maxLength = (expected)=>(0, _helpers.createComparator)((actual, { maxLength })=>maxLength(actual, expected));

package/dist/src/core/entities/handlers/minLength.d.ts

@@ -0,0 +1 @@
+export declare const minLength: (expected: number) => import("../../..").Comparator;

package/dist/src/core/entities/handlers/minLength.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "minLength", {
+    enumerable: true,
+    get: function() {
+        return minLength;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const minLength = (expected)=>(0, _helpers.createComparator)((actual, { minLength })=>minLength(actual, expected));

package/dist/src/core/entities/handlers/not.d.ts

@@ -0,0 +1,2 @@
+import type { Comparator } from '../../../utils/types';
+export declare const not: (comparator: Comparator) => Comparator;

package/dist/src/core/entities/handlers/not.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "not", {
+    enumerable: true,
+    get: function() {
+        return not;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const not = (comparator)=>(0, _helpers.createComparator)((actual, { fn })=>!fn(actual, comparator));

package/dist/src/core/entities/handlers/oneOf.d.ts

@@ -0,0 +1,2 @@
+import type { Comparator } from '../../../utils/types';
+export declare const oneOf: (...comparators: Comparator[]) => Comparator;

package/dist/src/core/entities/handlers/oneOf.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "oneOf", {
+    enumerable: true,
+    get: function() {
+        return oneOf;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const oneOf = (...comparators)=>(0, _helpers.createComparator)((actual, { fn })=>comparators.filter((comparator)=>fn(actual, comparator)).length === 1);

package/dist/src/core/entities/handlers/regExp.d.ts

@@ -0,0 +1 @@
+export declare const regExp: (expected: RegExp) => import("../../..").Comparator;

package/dist/src/core/entities/handlers/regExp.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "regExp", {
+    enumerable: true,
+    get: function() {
+        return regExp;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const regExp = (expected)=>(0, _helpers.createComparator)((actual, { regExp })=>regExp(actual, expected));

package/dist/src/core/entities/handlers/some.d.ts

@@ -0,0 +1,2 @@
+import type { Comparator } from '../../../utils/types';
+export declare const some: (...comparators: Comparator[]) => Comparator;

package/dist/src/core/entities/handlers/some.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "some", {
+    enumerable: true,
+    get: function() {
+        return some;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const some = (...comparators)=>(0, _helpers.createComparator)((actual, { fn })=>comparators.some((comparator)=>fn(actual, comparator)));

package/dist/src/core/entities/handlers/startsWith.d.ts

@@ -0,0 +1 @@
+export declare const startsWith: (expected: unknown) => import("../../..").Comparator;

package/dist/src/core/entities/handlers/startsWith.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "startsWith", {
+    enumerable: true,
+    get: function() {
+        return startsWith;
+    }
+});
+const _helpers = require("../../../utils/helpers");
+const startsWith = (expected)=>(0, _helpers.createComparator)((actual, { startsWith })=>startsWith(actual, expected));

package/dist/src/core/entities/index.d.ts

@@ -0,0 +1 @@
+export * from './handlers';

package/dist/src/{utils/helpers/config → core/entities}/index.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-_export_star(require("./resolveEntityValues/resolveEntityValues"), exports);
+_export_star(require("./handlers"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
         if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {

package/dist/src/core/functions/graphql/graphql.js

@@ -27,7 +27,7 @@ const resolveConfigType = (config)=>{
         config
     };
     if ('handler' in config) return {
-        type: 'handlerObj',
+        type: 'handler',
         config
     };
     return {
@@ -55,6 +55,7 @@ const createConfigResolver = (config, settings = {})=>{
             }
         case 'queue':
             {
+                var _resolvedConfig_config_match1;
                 const normalizedQueue = resolvedConfig.config.queue.map((item)=>{
                     if ('handler' in item) {
                         return {
@@ -70,7 +71,6 @@ const createConfigResolver = (config, settings = {})=>{
                     }
                     throw new Error(`Unexpected queue item kind: ${JSON.stringify(item, null, 2)}`);
                 });
-                var _resolvedConfig_config_match1;
                 return {
                     data: (0, _helpers.createQueueHandler)(normalizedQueue),
                     entities: (_resolvedConfig_config_match1 = resolvedConfig.config.match) !== null && _resolvedConfig_config_match1 !== void 0 ? _resolvedConfig_config_match1 : {},
@@ -83,7 +83,7 @@ const createConfigResolver = (config, settings = {})=>{
                 entities: {},
                 settings
             };
-        case 'handlerObj':
+        case 'handler':
             {
                 var _resolvedConfig_config_match2;
                 return {

package/dist/src/core/functions/index.d.ts

@@ -1,3 +1,4 @@
 export * from './graphql/graphql';
 export * from './mock';
 export * from './rest/rest';
+export * from './ws/ws';

package/dist/src/core/functions/index.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 _export_star(require("./graphql/graphql"), exports);
 _export_star(require("./mock"), exports);
 _export_star(require("./rest/rest"), exports);
+_export_star(require("./ws/ws"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
         if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {

package/dist/src/core/functions/ws/ws.d.ts

@@ -0,0 +1,15 @@
+import type { Data, WsConnectionEntitiesByEntityName, WsConnectionParams, WsParams, WsRequestConfig } from '../../../utils/types';
+type WsMessageHandler = (params: WsParams) => Data | Promise<Data>;
+type WsConnectionHandler = (params: WsConnectionParams) => Data | Promise<Data>;
+interface WsConnectionHandlerObject {
+    handler: WsConnectionHandler;
+    match?: WsConnectionEntitiesByEntityName;
+}
+export declare const createWsMessageRequestConfig: (handler: WsMessageHandler) => WsRequestConfig;
+export declare function createWsConnectionRequestConfig(handler: WsConnectionHandler): WsRequestConfig;
+export declare function createWsConnectionRequestConfig(config: WsConnectionHandlerObject): WsRequestConfig;
+export declare const ws: {
+    connection: typeof createWsConnectionRequestConfig;
+    message: (handler: WsMessageHandler) => WsRequestConfig;
+};
+export {};