@centeredgesoft/runtime-mock-routes 2.1.0 → 2.5.0

package/.devcontainer/Dockerfile

@@ -0,0 +1,16 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.209.6/containers/typescript-node/.devcontainer/base.Dockerfile
+
+# [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 16, 14, 12, 16-bullseye, 14-bullseye, 12-bullseye, 16-buster, 14-buster, 12-buster
+ARG VARIANT="16-bullseye"
+FROM mcr.microsoft.com/vscode/devcontainers/typescript-node:0-${VARIANT}
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment if you want to install an additional version of node using nvm
+# ARG EXTRA_NODE_VERSION=10
+# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"
+
+# [Optional] Uncomment if you want to install more global node packages
+# RUN su node -c "npm install -g <your-package-list -here>"

package/.devcontainer/devcontainer.json

@@ -0,0 +1,32 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.209.6/containers/typescript-node
+{
+	"name": "Node.js & TypeScript",
+	"build": {
+		"dockerfile": "Dockerfile",
+		// Update 'VARIANT' to pick a Node version: 16, 14, 12.
+		// Append -bullseye or -buster to pin to an OS version.
+		// Use -bullseye variants on local on arm64/Apple Silicon.
+		"args": { 
+			"VARIANT": "16-bullseye"
+		}
+	},
+
+	// Set *default* container specific settings.json values on container create.
+	"settings": {},
+
+
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"dbaeumer.vscode-eslint"
+	],
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "yarn install",
+
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "node"
+}

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 CenterEdge Software
-
-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
+MIT License
+
+Copyright (c) 2020 CenterEdge Software
+
+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

@@ -1,94 +1,101 @@
-# Runtime-Mock-Routes
-
-Runtime-Mock-Routes is a nodejs application for defining parameterized route and response bodies. This is ideal for mocking 3rd party services.
-
-## Installation
-
-Use the package manager [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/) to install Runtime-Mock-Routes.
-
-```bash
-npm install -g @centeredgesoft/runtime-mock-routes
-```
-
-## Usage
-
-```bash
-runtime-mock-routes -p 8080 -s ./seed.json
-```
-
-All command line options are optional. If a seed file is supplied, it must be one of the following
-* a json file that matches a `RuntimeRequestCollection`
-* a js file with a default export of type `RuntimeRequestCollection`
-* a js file with a default export of a function that returns a `RuntimeRequestCollection`
-
-```typescript
-type SupportedMethodsType = ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'];
-const SupportedMethodsColection: SupportedMethodsType = ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'];
-type SupportedMethod = SupportedMethodsType[number];
-
-export interface RuntimeRequestMethodBody {
-    body: any;
-    status?: number;
-}
-
-export type RuntimeRequestMethodBodyCollection = Partial<Record<SupportedMethod, RuntimeRequestMethodBody>>;
-
-export interface RuntimeRequestBody {
-    path: string;
-    methods: RuntimeRequestMethodBodyCollection;
-}
-
-export interface RuntimeRequestCollection {
-    [path: string]: RuntimeRequestBody;
-}
-```
-
-For example:
-```JSON
-{
-    "/test":{
-        "path":"/test",
-        "methods":{
-            "GET": {
-                "body": {},
-                "status": 200
-            }
-        }
-    }
-}
-```
-
-The following environment variables can also be used in place of command line options
-
-```
-RUNTIME_MOCK_ROUTES_PORT=8080
-RUNTIME_MOCK_ROUTES_FILE_PATH=/seed.json
-```
-
-Route parameters are specified in path via a colon followed by the parameter name.
-`'/users/:id'`
-
-Template strings that are compatible with [handlebars](https://handlebarsjs.com/) can be used for the `body` property of a `RuntimeRequestMethodBody`. The application will use path and query params as data for the tempalte. This application makes use of [faker](https://www.npmjs.com/package/faker) and [chance](https://www.npmjs.com/package/chance) as Handlebars Helpers.
-
-```
-{{params.<path-param-name>}} {{query.<query-param-name>}} 
-{{body.<post-body-property>}}
-{{ faker "lorem.words" 5}} {{ chance "guid"}}
-```
-
-If the rendered template is valid JSON, the response will be of type `application/json`.
-
-### Routes
-* `GET /` returns all of the currently defined routes 
-* `POST /` Takes a `RuntimeRequestBody` and adds it to the collection or updates the existing entry if it exists.
-* `PUT /` Takes a `RuntimeRequestCollection` and replaces the current collection.
-* `[GET,POST,PUT,PATCH,DELETE] /*` The result of retrieving an entry in the collection, 404 otherwise
-* `DELETE /?path=<path>` Deletes items from the collection
-
-## Contributing
-Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
-
-Please make sure to add/update tests as appropriate.
-
-## License
+# Runtime-Mock-Routes
+
+Runtime-Mock-Routes is a nodejs application for defining parameterized route and response bodies. This is ideal for mocking 3rd party services.
+
+## Installation
+
+Use the package manager [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/) to install Runtime-Mock-Routes.
+
+```bash
+npm install -g @centeredgesoft/runtime-mock-routes
+```
+
+## Usage
+
+```bash
+runtime-mock-routes -p 8080 -s ./seed.json
+```
+
+All command line options are optional. If a seed file is supplied, it must be one of the following
+* a json file that matches a `RuntimeRequestCollection`
+* a js file with a default export of type `RuntimeRequestCollection`
+* a js file with a default export of a function that returns a `RuntimeRequestCollection`
+
+```typescript
+type SupportedMethodsType = ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'];
+const SupportedMethodsColection: SupportedMethodsType = ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'];
+type SupportedMethod = SupportedMethodsType[number];
+
+export interface RuntimeRequestMethodBody {
+    body: any;
+    status?: number | ((...args : any[])=>number);
+    headers?: Record<string, string>;
+}
+
+export type RuntimeRequestMethodBodyCollection = Partial<Record<SupportedMethod, RuntimeRequestMethodBody>>;
+
+export interface RuntimeRequestBody {
+    path: string;
+    methods: RuntimeRequestMethodBodyCollection;
+}
+
+export interface RuntimeRequestCollection {
+    [path: string]: RuntimeRequestBody;
+}
+```
+
+For example:
+```JSON
+{
+    "/test":{
+        "path":"/test",
+        "methods":{
+            "GET": {
+                "body": {},
+                "status": 200,
+                "headers": {
+                    "X-Custom-Header": "yes"
+                }
+            }
+        }
+    }
+}
+```
+
+The following environment variables can also be used in place of command line options
+
+```
+RUNTIME_MOCK_ROUTES_PORT=8080
+RUNTIME_MOCK_ROUTES_FILE_PATH=/seed.json
+```
+
+Route parameters are specified in path via a colon followed by the parameter name.
+`'/users/:id'`
+
+Template strings that are compatible with [handlebars](https://handlebarsjs.com/) can be used for the `body` property of a `RuntimeRequestMethodBody`. The application will use path and query params as data for the tempalte. This application makes use of [faker](https://www.npmjs.com/package/faker) and [chance](https://www.npmjs.com/package/chance) as Handlebars Helpers.
+
+```
+{{params.<path-param-name>}} {{query.<query-param-name>}} 
+{{body.<post-body-property>}}
+{{headers.<header-property-name>}}
+{{ faker "lorem.words" 5}} {{ chance "guid"}}
+```
+
+If the rendered template is valid JSON, the response will be of type `application/json`.
+
+Also, be aware that instead of a direct JSON response, the body can also be a function that takes in a `RequestParameters` and returns a body response. The response will still be processed through handlebars.
+
+### Routes
+* `GET /` returns all of the currently defined routes 
+* `POST /` Takes a `RuntimeRequestBody` and adds it to the collection or updates the existing entry if it exists.
+* `PUT /` Takes a `RuntimeRequestCollection` and replaces the current collection.
+* `[GET,POST,PUT,PATCH,DELETE] /*` The result of retrieving an entry in the collection, 404 otherwise
+* `DELETE /?path=<path>` Deletes items from the collection
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to add/update tests as appropriate.
+
+## License
 [MIT](https://choosealicense.com/licenses/mit/)

package/build/index.d.ts

@@ -1,2 +1,2 @@
-export * as appV1 from './src/app';
-export * as appV2 from './src/appV2';
+export * as appV1 from './src/app';
+export * as appV2 from './src/appV2';

package/build/index.js

@@ -1,24 +1,24 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (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.appV2 = exports.appV1 = void 0;
-exports.appV1 = __importStar(require("./src/app"));
-exports.appV2 = __importStar(require("./src/appV2"));
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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.appV2 = exports.appV1 = void 0;
+exports.appV1 = __importStar(require("./src/app"));
+exports.appV2 = __importStar(require("./src/appV2"));

package/build/run.d.ts

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

package/build/run.js

@@ -1,32 +1,32 @@
-#!/usr/bin/env node
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const path_1 = require("path");
-const app_1 = require("./src/app");
-const appV2_1 = require("./src/appV2");
-var AppVersion;
-(function (AppVersion) {
-    AppVersion["v1"] = "v1";
-    AppVersion["v2"] = "v2";
-})(AppVersion || (AppVersion = {}));
-commander_1.program.version("2.1.0")
-    .option("-p, --port <port>", "Port to run the server one", process.env.RUNTIME_MOCK_ROUTES_PORT || "8080")
-    .option("-s, --seed <filePath>", "File path to seed the application", process.env.RUNTIME_MOCK_ROUTES_FILE_PATH)
-    .option("-a, --appVersion <appVersion>", "App Version to use", AppVersion.v2);
-commander_1.program.parse(process.argv);
-let initialRequests = {};
-if (commander_1.program.seed) {
-    const filePath = path_1.resolve(commander_1.program.seed);
-    const funcOrJson = require(filePath);
-    initialRequests = typeof funcOrJson === 'function' ? funcOrJson() : funcOrJson;
-}
-const appVersions = {
-    v1: app_1.appFactory,
-    v2: appV2_1.appFactory
-};
-const appFactory = appVersions[commander_1.program.appVersion] || appV2_1.appFactory;
-const app = appFactory(initialRequests);
-app.listen(commander_1.program.port, () => {
-    console.log(`⚡️[server]: Server is running at http://localhost:${commander_1.program.port}`);
-});
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const path_1 = require("path");
+const app_1 = require("./src/app");
+const appV2_1 = require("./src/appV2");
+var AppVersion;
+(function (AppVersion) {
+    AppVersion["v1"] = "v1";
+    AppVersion["v2"] = "v2";
+})(AppVersion || (AppVersion = {}));
+commander_1.program.version("2.1.0")
+    .option("-p, --port <port>", "Port to run the server one", process.env.RUNTIME_MOCK_ROUTES_PORT || "8080")
+    .option("-s, --seed <filePath>", "File path to seed the application", process.env.RUNTIME_MOCK_ROUTES_FILE_PATH)
+    .option("-a, --appVersion <appVersion>", "App Version to use", AppVersion.v2);
+commander_1.program.parse(process.argv);
+let initialRequests = {};
+if (commander_1.program.seed) {
+    const filePath = path_1.resolve(commander_1.program.seed);
+    const funcOrJson = require(filePath);
+    initialRequests = typeof funcOrJson === 'function' ? funcOrJson() : funcOrJson;
+}
+const appVersions = {
+    v1: app_1.appFactory,
+    v2: appV2_1.appFactory
+};
+const appFactory = appVersions[commander_1.program.appVersion] || appV2_1.appFactory;
+const app = appFactory(initialRequests);
+app.listen(commander_1.program.port, () => {
+    console.log(`⚡️[server]: Server is running at http://localhost:${commander_1.program.port}`);
+});

package/build/src/app.d.ts

@@ -1,27 +1,27 @@
-declare type SupportedMethodsType = ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'];
-export declare const SupportedMethodsColection: SupportedMethodsType;
-export declare type SupportedMethod = SupportedMethodsType[number];
-export declare const isSupportedMethod: (obj: any) => obj is "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
-export interface RuntimeRequestBody {
-    path: string;
-    body: any;
-    method: SupportedMethod;
-    status?: number;
-}
-export declare const isRuntimeRequestBody: (obj: any) => obj is RuntimeRequestBody;
-export interface RuntimeRequestCollection {
-    [path: string]: RuntimeRequestBody;
-}
-export declare const isRuntimeRequestCollection: (obj: any) => obj is RuntimeRequestCollection;
-export declare type MethodBasedRuntimeRequestCollection = Partial<Record<SupportedMethod, RuntimeRequestCollection>>;
-export declare const isMethodBasedRuntimeRequestCollection: (obj: any) => obj is Partial<Record<"GET" | "POST" | "PUT" | "PATCH" | "DELETE", RuntimeRequestCollection>>;
-interface CleanRuntimeRequestCollectionParams {
-    collection: RuntimeRequestCollection;
-    method: SupportedMethod;
-}
-export declare const cleanRuntimeRequestCollection: (params: CleanRuntimeRequestCollectionParams) => RuntimeRequestCollection;
-export declare const cleanMethodBasedRuntimeRequestCollection: (obj: MethodBasedRuntimeRequestCollection) => MethodBasedRuntimeRequestCollection;
-export declare const singleQueryParam: (obj: any) => string;
-export declare const appFactory: (runtimeCollection?: MethodBasedRuntimeRequestCollection) => import("express-serve-static-core").Express;
-declare const app: import("express-serve-static-core").Express;
-export default app;
+declare type SupportedMethodsType = ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'];
+export declare const SupportedMethodsColection: SupportedMethodsType;
+export declare type SupportedMethod = SupportedMethodsType[number];
+export declare const isSupportedMethod: (obj: any) => obj is "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+export interface RuntimeRequestBody {
+    path: string;
+    body: any;
+    method: SupportedMethod;
+    status?: number;
+}
+export declare const isRuntimeRequestBody: (obj: any) => obj is RuntimeRequestBody;
+export interface RuntimeRequestCollection {
+    [path: string]: RuntimeRequestBody;
+}
+export declare const isRuntimeRequestCollection: (obj: any) => obj is RuntimeRequestCollection;
+export declare type MethodBasedRuntimeRequestCollection = Partial<Record<SupportedMethod, RuntimeRequestCollection>>;
+export declare const isMethodBasedRuntimeRequestCollection: (obj: any) => obj is Partial<Record<"GET" | "POST" | "PUT" | "PATCH" | "DELETE", RuntimeRequestCollection>>;
+interface CleanRuntimeRequestCollectionParams {
+    collection: RuntimeRequestCollection;
+    method: SupportedMethod;
+}
+export declare const cleanRuntimeRequestCollection: (params: CleanRuntimeRequestCollectionParams) => RuntimeRequestCollection;
+export declare const cleanMethodBasedRuntimeRequestCollection: (obj: MethodBasedRuntimeRequestCollection) => MethodBasedRuntimeRequestCollection;
+export declare const singleQueryParam: (obj: any) => string;
+export declare const appFactory: (runtimeCollection?: MethodBasedRuntimeRequestCollection) => import("express-serve-static-core").Express;
+declare const app: import("express-serve-static-core").Express;
+export default app;