@scalar/mock-server 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Scalar
+
+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

@@ -0,0 +1,62 @@
+# Scalar Mock Server
+
+A server returning fake data based on an OpenAPI specification
+
+## Installation
+
+```bash
+npm install @scalar/mock-server
+```
+
+## Usage
+
+```ts
+import { serve } from '@hono/node-server'
+import { createMockServer } from '@scalar/mock-server'
+
+// Your OpenAPI specification
+const openapi = {
+  openapi: '3.1.0',
+  info: {
+    title: 'Hello World',
+    version: '1.0.0',
+  },
+  paths: {
+    '/foobar': {
+      get: {
+        responses: {
+          '200': {
+            description: 'OK',
+            content: {
+              'application/json': {
+                example: {
+                  foo: 'bar',
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+}
+
+// Create the mocked routes
+const app = await createMockServer({
+  openapi,
+  onRequest({ context, operation }) {
+    console.log(context.req.method, context.req.path)
+  },
+})
+
+// Start the server
+serve(
+  {
+    fetch: app.fetch,
+    port: 3000,
+  },
+  (info) => {
+    console.log(`Listening on http://localhost:${info.port}`)
+  },
+)
+```

package/dist/index.js

@@ -0,0 +1,143 @@
+import { getExampleFromSchema } from '@scalar/api-reference';
+import { parse } from '@scalar/openapi-parser';
+import { Hono } from 'hono';
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise, SuppressedError, Symbol */
+
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+function __generator(thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+/**
+ * Normalize OpenAPI JSON string, YAML string … to object
+ */
+function normalize(openapi) {
+    if (typeof openapi === 'string') {
+        openapi = JSON.parse(openapi);
+    }
+    return openapi;
+}
+
+/**
+ * Convert path to route
+ * Example: /posts/{id} -> /posts/:id
+ */
+function routeFromPath(path) {
+    return path.replace(/{/g, ':').replace(/}/g, '');
+}
+
+/**
+ * Create a mock server instance
+ */
+function createMockServer(options) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function () {
+        var app, specification;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    app = new Hono();
+                    // Normalize input
+                    options.openapi = normalize(options.openapi);
+                    return [4 /*yield*/, parse(options.openapi)
+                        // OpenAPI file
+                    ];
+                case 1:
+                    specification = _b.sent();
+                    // OpenAPI file
+                    app.get('/openapi.json', function (c) {
+                        if (!(options === null || options === void 0 ? void 0 : options.openapi)) {
+                            return c.text('Not found', 404);
+                        }
+                        return c.json(options.openapi);
+                    });
+                    // Paths
+                    Object.keys((_a = specification.document.paths) !== null && _a !== void 0 ? _a : {}).forEach(function (path) {
+                        // Request methods
+                        Object.keys(specification.document.paths[path]).forEach(function (method) {
+                            var route = routeFromPath(path);
+                            // Route
+                            app[method](route, function (c) {
+                                var _a, _b;
+                                // Call onRequest callback
+                                if (options === null || options === void 0 ? void 0 : options.onRequest) {
+                                    options.onRequest({
+                                        context: c,
+                                        operation: specification.document.paths[path][method],
+                                    });
+                                }
+                                // Response
+                                var operation = specification.document.paths[path][method];
+                                var jsonResponseConfiguration = (_b = (_a = operation.responses) === null || _a === void 0 ? void 0 : _a['200']) === null || _b === void 0 ? void 0 : _b.content['application/json'];
+                                var response = (jsonResponseConfiguration === null || jsonResponseConfiguration === void 0 ? void 0 : jsonResponseConfiguration.example)
+                                    ? jsonResponseConfiguration.example
+                                    : (jsonResponseConfiguration === null || jsonResponseConfiguration === void 0 ? void 0 : jsonResponseConfiguration.schema)
+                                        ? getExampleFromSchema(jsonResponseConfiguration.schema, {
+                                            emptyString: '…',
+                                        })
+                                        : null;
+                                return c.json(response);
+                            });
+                        });
+                    });
+                    return [2 /*return*/, app];
+            }
+        });
+    });
+}
+
+export { createMockServer, normalize, routeFromPath };

package/dist/package.json

@@ -0,0 +1,56 @@
+{
+    "name": "@scalar/mock-server",
+    "description": "OpenAPI mock server server",
+    "license": "MIT",
+    "author": "Scalar (https://github.com/scalar)",
+    "homepage": "https://github.com/scalar/cli",
+    "bugs": "https://github.com/scalar/cli/issues/new/choose",
+    "keywords": [
+        "scalar",
+        "openapi",
+        "swagger",
+        "cli"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/scalar/cli.git",
+        "directory": "packages/mock-server"
+    },
+    "engines": {
+        "node": ">=18"
+    },
+    "main": "./dist/index.js",
+    "types": "dist/src/index.d.ts",
+    "exports": {
+        "import": "./dist/index.js"
+    },
+    "scripts": {
+        "test": "vitest",
+        "cli:link": "pnpm run build && npm unlink -g && npm link",
+        "types:check": "tsc --noEmit --skipLibCheck",
+        "build": "rm -Rf dist/ && tsc && rollup -c"
+    },
+    "type": "module",
+    "version": "0.0.2",
+    "files": [
+        "./dist"
+    ],
+    "dependencies": {
+        "@hono/node-server": "^1.7.0",
+        "@scalar/api-reference": "^1.16.1",
+        "@scalar/openapi-parser": "^0.1.0",
+        "hono": "^4.0.2",
+        "vite-node": "^1.2.2"
+    },
+    "devDependencies": {
+        "@rollup/plugin-json": "^6.1.0",
+        "@rollup/plugin-typescript": "^11.1.6",
+        "@types/node": "^20.11.17",
+        "execa": "^8.0.1",
+        "rollup": "^4.10.0",
+        "rollup-plugin-delete": "^2.0.0",
+        "strip-ansi": "^7.1.0",
+        "tslib": "^2.6.2",
+        "typescript": "^5.3.3"
+    }
+}

package/dist/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lib';
+export * from './utils';

package/dist/src/index.js

@@ -0,0 +1,2 @@
+export * from './lib';
+export * from './utils';

package/dist/src/lib/createMockServer.d.ts

@@ -0,0 +1,12 @@
+import { OpenAPI } from '@scalar/openapi-parser';
+import { type Context, Hono } from 'hono';
+/**
+ * Create a mock server instance
+ */
+export declare function createMockServer(options?: {
+    openapi: string | Record<string, any>;
+    onRequest?: (data: {
+        context: Context;
+        operation: OpenAPI.Operation;
+    }) => void;
+}): Promise<Hono<import("hono").Env, import("hono/types").BlankSchema, "/">>;

package/dist/src/lib/createMockServer.js

@@ -0,0 +1,99 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import { getExampleFromSchema } from '@scalar/api-reference';
+import { parse } from '@scalar/openapi-parser';
+import { Hono } from 'hono';
+import { normalize, routeFromPath } from '../utils';
+/**
+ * Create a mock server instance
+ */
+export function createMockServer(options) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function () {
+        var app, specification;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    app = new Hono();
+                    // Normalize input
+                    options.openapi = normalize(options.openapi);
+                    return [4 /*yield*/, parse(options.openapi)
+                        // OpenAPI file
+                    ];
+                case 1:
+                    specification = _b.sent();
+                    // OpenAPI file
+                    app.get('/openapi.json', function (c) {
+                        if (!(options === null || options === void 0 ? void 0 : options.openapi)) {
+                            return c.text('Not found', 404);
+                        }
+                        return c.json(options.openapi);
+                    });
+                    // Paths
+                    Object.keys((_a = specification.document.paths) !== null && _a !== void 0 ? _a : {}).forEach(function (path) {
+                        // Request methods
+                        Object.keys(specification.document.paths[path]).forEach(function (method) {
+                            var route = routeFromPath(path);
+                            // Route
+                            app[method](route, function (c) {
+                                var _a, _b;
+                                // Call onRequest callback
+                                if (options === null || options === void 0 ? void 0 : options.onRequest) {
+                                    options.onRequest({
+                                        context: c,
+                                        operation: specification.document.paths[path][method],
+                                    });
+                                }
+                                // Response
+                                var operation = specification.document.paths[path][method];
+                                var jsonResponseConfiguration = (_b = (_a = operation.responses) === null || _a === void 0 ? void 0 : _a['200']) === null || _b === void 0 ? void 0 : _b.content['application/json'];
+                                var response = (jsonResponseConfiguration === null || jsonResponseConfiguration === void 0 ? void 0 : jsonResponseConfiguration.example)
+                                    ? jsonResponseConfiguration.example
+                                    : (jsonResponseConfiguration === null || jsonResponseConfiguration === void 0 ? void 0 : jsonResponseConfiguration.schema)
+                                        ? getExampleFromSchema(jsonResponseConfiguration.schema, {
+                                            emptyString: '…',
+                                        })
+                                        : null;
+                                return c.json(response);
+                            });
+                        });
+                    });
+                    return [2 /*return*/, app];
+            }
+        });
+    });
+}

package/dist/src/lib/createMockServer.onRequest.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/lib/createMockServer.onRequest.test.js

@@ -0,0 +1,82 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import { describe, expect, it } from 'vitest';
+import { createMockServer } from './createMockServer';
+describe('onRequest', function () {
+    it('call custom onRequest hook', function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            return [2 /*return*/, new Promise(function (resolve) { return __awaiter(void 0, void 0, void 0, function () {
+                    var openapi, server;
+                    return __generator(this, function (_a) {
+                        switch (_a.label) {
+                            case 0:
+                                openapi = {
+                                    openapi: '3.1.0',
+                                    info: {
+                                        title: 'Hello World',
+                                        version: '1.0.0',
+                                    },
+                                    paths: {
+                                        '/foobar': {
+                                            get: {
+                                                operationId: 'foobar',
+                                            },
+                                        },
+                                    },
+                                };
+                                return [4 /*yield*/, createMockServer({
+                                        openapi: openapi,
+                                        onRequest: function (_a) {
+                                            var context = _a.context, operation = _a.operation;
+                                            expect(context.req.method).toBe('GET');
+                                            expect(context.req.path).toBe('/foobar');
+                                            expect(operation.operationId).toBe('foobar');
+                                            resolve(null);
+                                        },
+                                    })];
+                            case 1:
+                                server = _a.sent();
+                                return [4 /*yield*/, server.request('/foobar')];
+                            case 2:
+                                _a.sent();
+                                return [2 /*return*/];
+                        }
+                    });
+                }); })];
+        });
+    }); });
+});

package/dist/src/lib/createMockServer.openapi.test.d.ts

@@ -0,0 +1 @@
+export {};