mock-config-server 2.0.1 → 2.1.0

package/README.md

@@ -57,7 +57,7 @@ export default mockServerConfig;
 Start **🎉 Mock Config Server**
 
 ```bash
-$ npx mock-config-server
+$ npx mcs
 
 # 🎉 Mock Config Server is running at http://localhost:31299
 ```
@@ -241,6 +241,38 @@ Functions to change request or response parameters
     - `delay` {number} seconds of delay time
   - `setStatusCode` (statusCode) => void
     - `statusCode` {number} status code for response
+  - `setHeader` (name, value) => void
+    - `name` {string} name of response header
+    - `value` {string | string[] | undefined} value of response header
+  - `appendHeader` (name, value) => void
+    - `name` {string} name of response header
+    - `value` {string | string[] | undefined} value of response header
+  - `setCookie` (name, value, options) => void
+    - `name` {string} name of cookie
+    - `value` {string} value of cookie
+    - `options` {[CookieOptions](https://expressjs.com/en/resources/middleware/cookie-session.html) | undefined} cookie options (like path, expires, etc.)
+  - `clearCookie` (name, options) => void
+    - `name` {string} name of cookie
+    - `options` {[CookieOptions](https://expressjs.com/en/resources/middleware/cookie-session.html) | undefined} cookie options (like path, expires, etc.)
+  - `attachment` (filename) => void
+    - `filename` {string} name of file in 'Content-Disposition' header
+
+## CLI usage
+```
+mcs [options]
+
+Options:
+  --baseUrl, -b         Set base url
+  --port, -p            Set port
+  --staticPath, -s      Set static path
+
+  --version, -v         Show version number
+  --help, -h            Show help
+  
+Examples:
+  mcs --baseurl /base/url --port 3000
+  mcs --help
+```
 
 ## ✨ Contributors
 

package/dist/bin/{mock-config-server.d.ts → bin.d.ts}

@@ -1,2 +1,2 @@
-#!/usr/bin/env node
-export {};
+#!/usr/bin/env node
+export {};

package/dist/bin/bin.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const pleaseUpgradeNode = require('please-upgrade-node');
+const packageJson = require('../../package.json');
+pleaseUpgradeNode(packageJson);
+const { cli } = require('./cli');
+cli();

package/dist/bin/cli.d.ts

@@ -0,0 +1 @@
+export declare const cli: () => void;

package/dist/bin/cli.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cli = void 0;
+const yargs_1 = __importDefault(require("yargs"));
+const helpers_1 = require("yargs/helpers");
+const start_1 = require("./start");
+const cli = () => {
+    const argv = (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
+        .options({
+        baseUrl: {
+            alias: 'b',
+            description: 'Set base url for mock server',
+            type: 'string'
+        },
+        port: {
+            alias: 'p',
+            description: 'Set port for server',
+            type: 'number'
+        },
+        staticPath: {
+            alias: 's',
+            description: 'Set static path for mock server',
+            type: 'string'
+        }
+    })
+        .version()
+        .alias('version', 'v')
+        .help()
+        .alias('help', 'h')
+        .parse();
+    (0, start_1.start)(argv);
+};
+exports.cli = cli;

package/dist/bin/{resolveExportsFromSourceCode.d.ts → resolveExportsFromSourceCode/resolveExportsFromSourceCode.d.ts}

@@ -1 +1 @@
-export declare const resolveExportsFromSourceCode: (sourceCode: string) => any;
+export declare const resolveExportsFromSourceCode: (sourceCode: string) => any;

package/dist/bin/{resolveExportsFromSourceCode.js → resolveExportsFromSourceCode/resolveExportsFromSourceCode.js}

@@ -1,11 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveExportsFromSourceCode = void 0;
-const resolveExportsFromSourceCode = (sourceCode) => {
-    // @ts-ignore
-    const moduleInstance = new module.constructor();
-    // eslint-disable-next-line no-underscore-dangle
-    moduleInstance._compile(sourceCode, '');
-    return moduleInstance.exports;
-};
-exports.resolveExportsFromSourceCode = resolveExportsFromSourceCode;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveExportsFromSourceCode = void 0;
+const resolveExportsFromSourceCode = (sourceCode) => {
+    // @ts-ignore
+    const moduleInstance = new module.constructor();
+    // eslint-disable-next-line no-underscore-dangle
+    moduleInstance._compile(sourceCode, '');
+    return moduleInstance.exports;
+};
+exports.resolveExportsFromSourceCode = resolveExportsFromSourceCode;

package/dist/bin/start.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import type { MockServerConfigArgv } from '../src';
+export declare const start: (argv: MockServerConfigArgv) => Promise<void>;

package/dist/bin/{mock-config-server.js → start.js}

@@ -1,67 +1,73 @@
-#!/usr/bin/env node
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const esbuild_1 = require("esbuild");
-const fs = __importStar(require("fs"));
-const src_1 = require("../src");
-const validateMockServerConfig_1 = require("./validateMockServerConfig/validateMockServerConfig");
-const resolveExportsFromSourceCode_1 = require("./resolveExportsFromSourceCode");
-const start = async () => {
-    try {
-        const appPath = process.cwd();
-        const mockServerConfigFileRegex = /mock-server.config.(?:ts|js)/;
-        const mockServerConfigFile = fs
-            .readdirSync(appPath)
-            .find((file) => mockServerConfigFileRegex.test(file));
-        if (!mockServerConfigFile) {
-            throw new Error('Cannot find config file mock-server.config.(ts|js)');
-        }
-        const { outputFiles } = await (0, esbuild_1.build)({
-            entryPoints: [mockServerConfigFile],
-            bundle: true,
-            platform: 'node',
-            target: 'esnext',
-            minifySyntax: true,
-            minify: true,
-            write: false,
-            metafile: false
-        });
-        const mockServerConfigSourceCode = outputFiles[0]?.text;
-        if (!mockServerConfigSourceCode) {
-            throw new Error('Cannot handle source code of mock-server.config.(ts|js)');
-        }
-        const mockServerConfigExports = (0, resolveExportsFromSourceCode_1.resolveExportsFromSourceCode)(mockServerConfigSourceCode);
-        if (!mockServerConfigExports?.default) {
-            throw new Error('Cannot handle exports of mock-server.config.(ts|js)');
-        }
-        (0, validateMockServerConfig_1.validateMockServerConfig)(mockServerConfigExports.default);
-        (0, src_1.startMockServer)(mockServerConfigExports.default);
-    }
-    catch (error) {
-        console.error(error.message);
-    }
-};
-start();
+#!/usr/bin/env node
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.start = void 0;
+const fs = __importStar(require("fs"));
+const esbuild_1 = require("esbuild");
+const server_1 = require("../src/server");
+const helpers_1 = require("../src/utils/helpers");
+const resolveExportsFromSourceCode_1 = require("./resolveExportsFromSourceCode/resolveExportsFromSourceCode");
+const validateMockServerConfig_1 = require("./validateMockServerConfig/validateMockServerConfig");
+const start = async (argv) => {
+    try {
+        const appPath = process.cwd();
+        const mockServerConfigFileRegex = /mock-server.config.(?:ts|js)/;
+        const mockServerConfigFile = fs
+            .readdirSync(appPath)
+            .find((file) => mockServerConfigFileRegex.test(file));
+        if (!mockServerConfigFile) {
+            throw new Error('Cannot find config file mock-server.config.(ts|js)');
+        }
+        const { outputFiles } = await (0, esbuild_1.build)({
+            entryPoints: [mockServerConfigFile],
+            bundle: true,
+            platform: 'node',
+            target: 'esnext',
+            minifySyntax: true,
+            minify: true,
+            write: false,
+            metafile: false
+        });
+        const mockServerConfigSourceCode = outputFiles[0]?.text;
+        if (!mockServerConfigSourceCode) {
+            throw new Error('Cannot handle source code of mock-server.config.(ts|js)');
+        }
+        const mockServerConfigExports = (0, resolveExportsFromSourceCode_1.resolveExportsFromSourceCode)(mockServerConfigSourceCode);
+        if (!mockServerConfigExports?.default) {
+            throw new Error('Cannot handle exports of mock-server.config.(ts|js)');
+        }
+        if (!(0, helpers_1.isPlainObject)(mockServerConfigExports.default)) {
+            throw new Error('configuration should be plain object; see our doc (https://www.npmjs.com/package/mock-config-server) for more information');
+        }
+        const mergedMockServerConfig = { ...mockServerConfigExports.default, ...argv };
+        (0, validateMockServerConfig_1.validateMockServerConfig)(mergedMockServerConfig);
+        (0, server_1.startMockServer)(mergedMockServerConfig);
+    }
+    catch (error) {
+        console.error(error.message);
+    }
+};
+exports.start = start;

package/dist/bin/validateMockServerConfig/validateBaseUrl/validateBaseUrl.d.ts

@@ -1 +1 @@
-export declare const validateBaseUrl: (baseUrl: unknown) => void;
+export declare const validateBaseUrl: (baseUrl: unknown) => void;

package/dist/bin/validateMockServerConfig/validateBaseUrl/validateBaseUrl.js

@@ -1,12 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateBaseUrl = void 0;
-const validateBaseUrl = (baseUrl) => {
-    if (typeof baseUrl !== 'string' && typeof baseUrl !== 'undefined') {
-        throw new Error('baseUrl');
-    }
-    if (typeof baseUrl === 'string' && !baseUrl.startsWith('/')) {
-        throw new Error('baseUrl');
-    }
-};
-exports.validateBaseUrl = validateBaseUrl;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateBaseUrl = void 0;
+const validateBaseUrl = (baseUrl) => {
+    if (typeof baseUrl !== 'string' && typeof baseUrl !== 'undefined') {
+        throw new Error('baseUrl');
+    }
+    if (typeof baseUrl === 'string' && !baseUrl.startsWith('/')) {
+        throw new Error('baseUrl');
+    }
+};
+exports.validateBaseUrl = validateBaseUrl;

package/dist/bin/validateMockServerConfig/validateCors/validateCors.d.ts

@@ -1 +1 @@
-export declare const validateCors: (cors: unknown) => void;
+export declare const validateCors: (cors: unknown) => void;

package/dist/bin/validateMockServerConfig/validateCors/validateCors.js

@@ -1,82 +1,82 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateCors = void 0;
-const helpers_1 = require("../../../src/utils/helpers");
-const validateOrigin = (origin) => {
-    const isOriginArray = Array.isArray(origin);
-    if (isOriginArray) {
-        origin.forEach((originElement, index) => {
-            const isOriginElementStringOrRegExp = typeof originElement === 'string' || originElement instanceof RegExp;
-            if (!isOriginElementStringOrRegExp) {
-                throw new Error(`origin[${index}]`);
-            }
-        });
-        return;
-    }
-    const isOriginStringOrRegexp = typeof origin === 'string' || origin instanceof RegExp;
-    const isOriginFunction = typeof origin === 'function';
-    if (!isOriginStringOrRegexp && !isOriginFunction) {
-        throw new Error('origin');
-    }
-};
-const validateMethods = (methods) => {
-    const isMethodsArray = Array.isArray(methods);
-    if (isMethodsArray) {
-        const allowedMethods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH'];
-        methods.forEach((method, index) => {
-            // ✅ important:
-            // compare without 'toUpperCase' because 'Access-Control-Allow-Methods' value is case-sensitive
-            if (!allowedMethods.includes(method)) {
-                throw new Error(`methods[${index}]`);
-            }
-        });
-        return;
-    }
-    if (typeof methods !== 'undefined') {
-        throw new Error('methods');
-    }
-};
-const validateHeaders = (headers) => {
-    const isHeadersArray = Array.isArray(headers);
-    if (isHeadersArray) {
-        headers.forEach((header, index) => {
-            if (typeof header !== 'string') {
-                throw new Error(`headers[${index}]`);
-            }
-        });
-        return;
-    }
-    if (typeof headers !== 'undefined') {
-        throw new Error('headers');
-    }
-};
-const validateCredentials = (credentials) => {
-    if (typeof credentials !== 'boolean' && typeof credentials !== 'undefined') {
-        throw new Error('credentials');
-    }
-};
-const validateMaxAge = (maxAge) => {
-    if (typeof maxAge !== 'number' && typeof maxAge !== 'undefined') {
-        throw new Error('maxAge');
-    }
-};
-const validateCors = (cors) => {
-    const isCorsObject = (0, helpers_1.isPlainObject)(cors);
-    if (isCorsObject) {
-        try {
-            validateOrigin(cors.origin);
-            validateMethods(cors.methods);
-            validateHeaders(cors.headers);
-            validateCredentials(cors.credentials);
-            validateMaxAge(cors.maxAge);
-        }
-        catch (error) {
-            throw new Error(`cors.${error.message}`);
-        }
-        return;
-    }
-    if (typeof cors !== 'undefined') {
-        throw new Error('cors');
-    }
-};
-exports.validateCors = validateCors;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateCors = void 0;
+const helpers_1 = require("../../../src/utils/helpers");
+const validateOrigin = (origin) => {
+    const isOriginArray = Array.isArray(origin);
+    if (isOriginArray) {
+        origin.forEach((originElement, index) => {
+            const isOriginElementStringOrRegExp = typeof originElement === 'string' || originElement instanceof RegExp;
+            if (!isOriginElementStringOrRegExp) {
+                throw new Error(`origin[${index}]`);
+            }
+        });
+        return;
+    }
+    const isOriginStringOrRegexp = typeof origin === 'string' || origin instanceof RegExp;
+    const isOriginFunction = typeof origin === 'function';
+    if (!isOriginStringOrRegexp && !isOriginFunction) {
+        throw new Error('origin');
+    }
+};
+const validateMethods = (methods) => {
+    const isMethodsArray = Array.isArray(methods);
+    if (isMethodsArray) {
+        const allowedMethods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS'];
+        methods.forEach((method, index) => {
+            // ✅ important:
+            // compare without 'toUpperCase' because 'Access-Control-Allow-Methods' value is case-sensitive
+            if (!allowedMethods.includes(method)) {
+                throw new Error(`methods[${index}]`);
+            }
+        });
+        return;
+    }
+    if (typeof methods !== 'undefined') {
+        throw new Error('methods');
+    }
+};
+const validateHeaders = (headers) => {
+    const isHeadersArray = Array.isArray(headers);
+    if (isHeadersArray) {
+        headers.forEach((header, index) => {
+            if (typeof header !== 'string') {
+                throw new Error(`headers[${index}]`);
+            }
+        });
+        return;
+    }
+    if (typeof headers !== 'undefined') {
+        throw new Error('headers');
+    }
+};
+const validateCredentials = (credentials) => {
+    if (typeof credentials !== 'boolean' && typeof credentials !== 'undefined') {
+        throw new Error('credentials');
+    }
+};
+const validateMaxAge = (maxAge) => {
+    if (typeof maxAge !== 'number' && typeof maxAge !== 'undefined') {
+        throw new Error('maxAge');
+    }
+};
+const validateCors = (cors) => {
+    const isCorsObject = (0, helpers_1.isPlainObject)(cors);
+    if (isCorsObject) {
+        try {
+            validateOrigin(cors.origin);
+            validateMethods(cors.methods);
+            validateHeaders(cors.headers);
+            validateCredentials(cors.credentials);
+            validateMaxAge(cors.maxAge);
+        }
+        catch (error) {
+            throw new Error(`cors.${error.message}`);
+        }
+        return;
+    }
+    if (typeof cors !== 'undefined') {
+        throw new Error('cors');
+    }
+};
+exports.validateCors = validateCors;

package/dist/bin/validateMockServerConfig/validateGraphqlConfig/validateGraphqlConfig.d.ts

@@ -1 +1 @@
-export declare const validateGraphqlConfig: (graphqlConfig: unknown) => void;
+export declare const validateGraphqlConfig: (graphqlConfig: unknown) => void;

package/dist/bin/validateMockServerConfig/validateGraphqlConfig/validateGraphqlConfig.js

@@ -1,48 +1,48 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateGraphqlConfig = void 0;
-const helpers_1 = require("../../../src/utils/helpers");
-const validateBaseUrl_1 = require("../validateBaseUrl/validateBaseUrl");
-const validateInterceptors_1 = require("../validateInterceptors/validateInterceptors");
-const validateRoutes_1 = require("./validateRoutes/validateRoutes");
-const validateConfigs = (configs) => {
-    const isConfigsArray = Array.isArray(configs);
-    if (isConfigsArray) {
-        configs.forEach((config, index) => {
-            const { operationType, operationName } = config;
-            if (operationType !== 'query' && operationType !== 'mutation') {
-                throw new Error(`configs[${index}].operationType`);
-            }
-            const isOperationNameStringOrRegExp = typeof operationName === 'string' || operationName instanceof RegExp;
-            if (!isOperationNameStringOrRegExp) {
-                throw new Error(`configs[${index}].operationName`);
-            }
-            try {
-                (0, validateRoutes_1.validateRoutes)(config.routes, operationType);
-                (0, validateInterceptors_1.validateInterceptors)(config.interceptors);
-            }
-            catch (error) {
-                throw new Error(`configs[${index}].${error.message}`);
-            }
-        });
-        return;
-    }
-    throw new Error('configs');
-};
-const validateGraphqlConfig = (graphqlConfig) => {
-    const isGraphqlConfigObject = (0, helpers_1.isPlainObject)(graphqlConfig);
-    if (isGraphqlConfigObject) {
-        try {
-            (0, validateBaseUrl_1.validateBaseUrl)(graphqlConfig.baseUrl);
-            validateConfigs(graphqlConfig.configs);
-        }
-        catch (error) {
-            throw new Error(`graphql.${error.message}`);
-        }
-        return;
-    }
-    if (typeof graphqlConfig !== 'undefined') {
-        throw new Error('graphql');
-    }
-};
-exports.validateGraphqlConfig = validateGraphqlConfig;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateGraphqlConfig = void 0;
+const helpers_1 = require("../../../src/utils/helpers");
+const validateBaseUrl_1 = require("../validateBaseUrl/validateBaseUrl");
+const validateInterceptors_1 = require("../validateInterceptors/validateInterceptors");
+const validateRoutes_1 = require("./validateRoutes/validateRoutes");
+const validateConfigs = (configs) => {
+    const isConfigsArray = Array.isArray(configs);
+    if (isConfigsArray) {
+        configs.forEach((config, index) => {
+            const { operationType, operationName } = config;
+            if (operationType !== 'query' && operationType !== 'mutation') {
+                throw new Error(`configs[${index}].operationType`);
+            }
+            const isOperationNameStringOrRegExp = typeof operationName === 'string' || operationName instanceof RegExp;
+            if (!isOperationNameStringOrRegExp) {
+                throw new Error(`configs[${index}].operationName`);
+            }
+            try {
+                (0, validateRoutes_1.validateRoutes)(config.routes, operationType);
+                (0, validateInterceptors_1.validateInterceptors)(config.interceptors);
+            }
+            catch (error) {
+                throw new Error(`configs[${index}].${error.message}`);
+            }
+        });
+        return;
+    }
+    throw new Error('configs');
+};
+const validateGraphqlConfig = (graphqlConfig) => {
+    const isGraphqlConfigObject = (0, helpers_1.isPlainObject)(graphqlConfig);
+    if (isGraphqlConfigObject) {
+        try {
+            (0, validateBaseUrl_1.validateBaseUrl)(graphqlConfig.baseUrl);
+            validateConfigs(graphqlConfig.configs);
+        }
+        catch (error) {
+            throw new Error(`graphql.${error.message}`);
+        }
+        return;
+    }
+    if (typeof graphqlConfig !== 'undefined') {
+        throw new Error('graphql');
+    }
+};
+exports.validateGraphqlConfig = validateGraphqlConfig;

package/dist/bin/validateMockServerConfig/validateGraphqlConfig/validateRoutes/validateRoutes.d.ts

@@ -1,2 +1,2 @@
-import type { GraphQLOperationType } from '../../../../src';
-export declare const validateRoutes: (routes: unknown, operationType: GraphQLOperationType) => void;
+import type { GraphQLOperationType } from '../../../../src/utils/types';
+export declare const validateRoutes: (routes: unknown, operationType: GraphQLOperationType) => void;