mock-config-server 2.1.0 → 2.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 siberiacancode
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -57,19 +57,21 @@ export default mockServerConfig;
 Start **🎉 Mock Config Server**
 
 ```bash
-$ npx mcs
-
-# 🎉 Mock Config Server is running at http://localhost:31299
+$ npx mock-config-server
 ```
 
+> If the package is already installed you can use short command `mcs`
+
 ## 🎭 Parameters for mock-server.config.(js|ts)
 
 - `rest?` Rest configs for mock requests
   - `baseUrl?` {string} part of the url that will be substituted at the beginning of rest request url (default: `'/'`)
   - `configs` {Array<RestRequestConfig>} configs for mock requests, [read](#configs)
+  - `interceptors?` {Interceptors} functions to change request or response parameters, [read](#interceptors)
 - `graphql?` GraphQL configs for mock requests
   - `baseUrl?` {string} part of the url that will be substituted at the beginning of graphql request url (default: `'/'`)
   - `configs` {Array<GraphQLRequestConfig>} configs for mock requests, [read](#configs)
+  - `interceptors?` {Interceptors} functions to change request or response parameters, [read](#interceptors)
 - `staticPath?` {StaticPath} entity for working with static files, [read](#static-path)
 - `interceptors?` {Interceptors} functions to change request or response parameters, [read](#interceptors)
 - `cors?` {Cors} CORS settings object (default: `CORS is turn off`), [read](#cors)
@@ -230,6 +232,13 @@ Functions to change request or response parameters
 
 - `params`
   - `request` request object
+  - `setDelay` (delay) => Promise<void>
+    - `delay` {number} milliseconds of delay time
+  - `getHeader` (field) => string | number | string[] | undefined
+    - `field` {string} name of response header
+  - `getHeaders` () => Record<string | number | string[] | undefined>
+  - `setCookie` (name) => string | undefined
+    - `name` {string} name of cookie
 
 ##### Response
 
@@ -238,14 +247,14 @@ Functions to change request or response parameters
   - `request` request object
   - `response` response object
   - `setDelay` (delay) => Promise<void>
-    - `delay` {number} seconds of delay time
+    - `delay` {number} milliseconds of delay time
   - `setStatusCode` (statusCode) => void
     - `statusCode` {number} status code for response
-  - `setHeader` (name, value) => void
-    - `name` {string} name of response header
+  - `setHeader` (field, value) => void
+    - `field` {string} name of response header
     - `value` {string | string[] | undefined} value of response header
-  - `appendHeader` (name, value) => void
-    - `name` {string} name of response header
+  - `appendHeader` (field, value) => void
+    - `field` {string} name of response header
     - `value` {string | string[] | undefined} value of response header
   - `setCookie` (name, value, options) => void
     - `name` {string} name of cookie
@@ -258,19 +267,22 @@ Functions to change request or response parameters
     - `filename` {string} name of file in 'Content-Disposition' header
 
 ## CLI usage
+
 ```
 mcs [options]
 
 Options:
-  --baseUrl, -b         Set base url
-  --port, -p            Set port
+  --baseUrl, -b         Set base url (default: '/')
+  --port, -p            Set port (default: 31299)
   --staticPath, -s      Set static path
+  --config, -c          Set path to config file (default: './mock-server.config.(?:ts|mts|cts|js|mjs|cjs)')
+  --watch, -w           Enables server restart after config file changes (default: false)
 
   --version, -v         Show version number
   --help, -h            Show help
-  
+
 Examples:
-  mcs --baseurl /base/url --port 3000
+  mcs --baseurl /base/url --port 3000 --config ./path/to/config.ts -w
   mcs --help
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mock-config-server",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Tool that easily and quickly imitates server operation, create full fake api in few steps",
   "author": {
     "name": "SIBERIA CAN CODE 🧊",
@@ -20,7 +20,7 @@
       "url": "https://github.com/RiceWithMeat"
     }
   ],
-  "license": "ISC",
+  "license": "MIT",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "bin": {
@@ -36,6 +36,8 @@
   "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",