@scalar/mock-server 0.4.1 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @scalar/mock-server
 
+## 0.5.0
+
+### Minor Changes
+
+- edf694b: refactor!: use openapi-parser utils, remove the deprecated pipeline syntax
+
+### Patch Changes
+
+- Updated dependencies [151ef09]
+- Updated dependencies [442c0a3]
+- Updated dependencies [edf694b]
+  - @scalar/oas-utils@0.3.2
+  - @scalar/openapi-parser@0.12.0
+
+## 0.4.2
+
+### Patch Changes
+
+- Updated dependencies [ea20eb4]
+  - @scalar/openapi-parser@0.11.1
+  - @scalar/oas-utils@0.3.1
+
 ## 0.4.1
 
 ### Patch Changes

package/README.md

@@ -20,11 +20,11 @@ A powerful Node.js mock server that automatically generates realistic API respon
 
 ## Quickstart
 
-The easiest way to get started is through [our Scalar CLI](https://github.com/scalar/scalar/tree/main/packages/cli).
+The easiest way to get started is through [our Scalar CLI](https://www.npmjs.com/package/@scalar/cli).
 You can have a mock server up and running in seconds:
 
 ```bash
-npx @scalar/cli mock openapi.json --watch
+npx @scalar/cli document mock openapi.json --watch
 ```
 
 ## Installation

package/dist/createMockServer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createMockServer.d.ts","sourceRoot":"","sources":["../src/createMockServer.ts"],"names":[],"mappings":"AAEA,OAAO,EAAgB,IAAI,EAAE,MAAM,MAAM,CAAA;AAGzC,OAAO,KAAK,EAAc,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAW5D;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,iBAAiB,uFA+ChE"}
+{"version":3,"file":"createMockServer.d.ts","sourceRoot":"","sources":["../src/createMockServer.ts"],"names":[],"mappings":"AAEA,OAAO,EAAgB,IAAI,EAAE,MAAM,MAAM,CAAA;AAGzC,OAAO,KAAK,EAAc,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAW5D;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,iBAAiB,uFA4ChE"}

package/dist/createMockServer.js

@@ -1,4 +1,4 @@
-import { openapi } from "@scalar/openapi-parser";
+import { dereference } from "@scalar/openapi-parser";
 import { Hono } from "hono";
 import { cors } from "hono/cors";
 import { getOperations } from "./utils/getOperations.js";
@@ -11,7 +11,7 @@ import { mockAnyResponse } from "./routes/mockAnyResponse.js";
 import { respondWithOpenApiDocument } from "./routes/respondWithOpenApiDocument.js";
 async function createMockServer(options) {
   const app = new Hono();
-  const { schema } = await openapi().load(options?.specification ?? {}).dereference().get();
+  const { schema } = await dereference(options?.specification ?? {});
   app.use(cors());
   setupAuthenticationRoutes(app, schema);
   logAuthenticationInstructions(

package/dist/createMockServer.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/createMockServer.ts"],
-  "sourcesContent": ["import { openapi } from '@scalar/openapi-parser'\nimport type { OpenAPI, OpenAPIV3_1 } from '@scalar/openapi-types'\nimport { type Context, Hono } from 'hono'\nimport { cors } from 'hono/cors'\n\nimport type { HttpMethod, MockServerOptions } from '@/types'\nimport { getOperations } from '@/utils/getOperations'\nimport { handleAuthentication } from '@/utils/handleAuthentication'\nimport { honoRouteFromPath } from '@/utils/honoRouteFromPath'\nimport { isAuthenticationRequired } from '@/utils/isAuthenticationRequired'\nimport { logAuthenticationInstructions } from '@/utils/logAuthenticationInstructions'\nimport { setupAuthenticationRoutes } from '@/utils/setupAuthenticationRoutes'\n\nimport { mockAnyResponse } from './routes/mockAnyResponse'\nimport { respondWithOpenApiDocument } from './routes/respondWithOpenApiDocument'\n\n/**\n * Create a mock server instance\n */\nexport async function createMockServer(options: MockServerOptions) {\n  const app = new Hono()\n\n  /** Dereferenced OpenAPI document */\n  const { schema } = await openapi()\n    .load(options?.specification ?? {})\n    .dereference()\n    .get()\n\n  // CORS headers\n  app.use(cors())\n\n  /** Authentication methods defined in the OpenAPI document */\n  setupAuthenticationRoutes(app, schema)\n\n  logAuthenticationInstructions(\n    schema?.components?.securitySchemes || ({} as Record<string, OpenAPIV3_1.SecuritySchemeObject>),\n  )\n\n  /** Paths specified in the OpenAPI document */\n  const paths = schema?.paths ?? {}\n\n  Object.keys(paths).forEach((path) => {\n    const methods = Object.keys(getOperations(paths[path])) as HttpMethod[]\n\n    /** Keys for all operations of a specified path */\n    methods.forEach((method) => {\n      const route = honoRouteFromPath(path)\n      const operation = schema?.paths?.[path]?.[method] as OpenAPI.Operation\n\n      // Check if authentication is required for this operation\n      if (isAuthenticationRequired(operation.security)) {\n        app[method](route, handleAuthentication(schema, operation))\n      }\n\n      // Actual route\n      app[method](route, (c: Context) => mockAnyResponse(c, operation, options))\n    })\n  })\n\n  // OpenAPI JSON file\n  app.get('/openapi.json', (c) => respondWithOpenApiDocument(c, options?.specification, 'json'))\n\n  // OpenAPI YAML file\n  app.get('/openapi.yaml', (c) => respondWithOpenApiDocument(c, options?.specification, 'yaml'))\n\n  return app\n}\n"],
-  "mappings": "AAAA,SAAS,eAAe;AAExB,SAAuB,YAAY;AACnC,SAAS,YAAY;AAGrB,SAAS,qBAAqB;AAC9B,SAAS,4BAA4B;AACrC,SAAS,yBAAyB;AAClC,SAAS,gCAAgC;AACzC,SAAS,qCAAqC;AAC9C,SAAS,iCAAiC;AAE1C,SAAS,uBAAuB;AAChC,SAAS,kCAAkC;AAK3C,eAAsB,iBAAiB,SAA4B;AACjE,QAAM,MAAM,IAAI,KAAK;AAGrB,QAAM,EAAE,OAAO,IAAI,MAAM,QAAQ,EAC9B,KAAK,SAAS,iBAAiB,CAAC,CAAC,EACjC,YAAY,EACZ,IAAI;AAGP,MAAI,IAAI,KAAK,CAAC;AAGd,4BAA0B,KAAK,MAAM;AAErC;AAAA,IACE,QAAQ,YAAY,mBAAoB,CAAC;AAAA,EAC3C;AAGA,QAAM,QAAQ,QAAQ,SAAS,CAAC;AAEhC,SAAO,KAAK,KAAK,EAAE,QAAQ,CAAC,SAAS;AACnC,UAAM,UAAU,OAAO,KAAK,cAAc,MAAM,IAAI,CAAC,CAAC;AAGtD,YAAQ,QAAQ,CAAC,WAAW;AAC1B,YAAM,QAAQ,kBAAkB,IAAI;AACpC,YAAM,YAAY,QAAQ,QAAQ,IAAI,IAAI,MAAM;AAGhD,UAAI,yBAAyB,UAAU,QAAQ,GAAG;AAChD,YAAI,MAAM,EAAE,OAAO,qBAAqB,QAAQ,SAAS,CAAC;AAAA,MAC5D;AAGA,UAAI,MAAM,EAAE,OAAO,CAAC,MAAe,gBAAgB,GAAG,WAAW,OAAO,CAAC;AAAA,IAC3E,CAAC;AAAA,EACH,CAAC;AAGD,MAAI,IAAI,iBAAiB,CAAC,MAAM,2BAA2B,GAAG,SAAS,eAAe,MAAM,CAAC;AAG7F,MAAI,IAAI,iBAAiB,CAAC,MAAM,2BAA2B,GAAG,SAAS,eAAe,MAAM,CAAC;AAE7F,SAAO;AACT;",
+  "sourcesContent": ["import { dereference } from '@scalar/openapi-parser'\nimport type { OpenAPI, OpenAPIV3_1 } from '@scalar/openapi-types'\nimport { type Context, Hono } from 'hono'\nimport { cors } from 'hono/cors'\n\nimport type { HttpMethod, MockServerOptions } from '@/types'\nimport { getOperations } from '@/utils/getOperations'\nimport { handleAuthentication } from '@/utils/handleAuthentication'\nimport { honoRouteFromPath } from '@/utils/honoRouteFromPath'\nimport { isAuthenticationRequired } from '@/utils/isAuthenticationRequired'\nimport { logAuthenticationInstructions } from '@/utils/logAuthenticationInstructions'\nimport { setupAuthenticationRoutes } from '@/utils/setupAuthenticationRoutes'\n\nimport { mockAnyResponse } from './routes/mockAnyResponse'\nimport { respondWithOpenApiDocument } from './routes/respondWithOpenApiDocument'\n\n/**\n * Create a mock server instance\n */\nexport async function createMockServer(options: MockServerOptions) {\n  const app = new Hono()\n\n  /** Dereferenced OpenAPI document */\n  const { schema } = await dereference(options?.specification ?? {})\n\n  // CORS headers\n  app.use(cors())\n\n  /** Authentication methods defined in the OpenAPI document */\n  setupAuthenticationRoutes(app, schema)\n\n  logAuthenticationInstructions(\n    schema?.components?.securitySchemes || ({} as Record<string, OpenAPIV3_1.SecuritySchemeObject>),\n  )\n\n  /** Paths specified in the OpenAPI document */\n  const paths = schema?.paths ?? {}\n\n  Object.keys(paths).forEach((path) => {\n    const methods = Object.keys(getOperations(paths[path])) as HttpMethod[]\n\n    /** Keys for all operations of a specified path */\n    methods.forEach((method) => {\n      const route = honoRouteFromPath(path)\n      const operation = schema?.paths?.[path]?.[method] as OpenAPI.Operation\n\n      // Check if authentication is required for this operation\n      if (isAuthenticationRequired(operation.security)) {\n        app[method](route, handleAuthentication(schema, operation))\n      }\n\n      // Actual route\n      app[method](route, (c: Context) => mockAnyResponse(c, operation, options))\n    })\n  })\n\n  // OpenAPI JSON file\n  app.get('/openapi.json', (c) => respondWithOpenApiDocument(c, options?.specification, 'json'))\n\n  // OpenAPI YAML file\n  app.get('/openapi.yaml', (c) => respondWithOpenApiDocument(c, options?.specification, 'yaml'))\n\n  return app\n}\n"],
+  "mappings": "AAAA,SAAS,mBAAmB;AAE5B,SAAuB,YAAY;AACnC,SAAS,YAAY;AAGrB,SAAS,qBAAqB;AAC9B,SAAS,4BAA4B;AACrC,SAAS,yBAAyB;AAClC,SAAS,gCAAgC;AACzC,SAAS,qCAAqC;AAC9C,SAAS,iCAAiC;AAE1C,SAAS,uBAAuB;AAChC,SAAS,kCAAkC;AAK3C,eAAsB,iBAAiB,SAA4B;AACjE,QAAM,MAAM,IAAI,KAAK;AAGrB,QAAM,EAAE,OAAO,IAAI,MAAM,YAAY,SAAS,iBAAiB,CAAC,CAAC;AAGjE,MAAI,IAAI,KAAK,CAAC;AAGd,4BAA0B,KAAK,MAAM;AAErC;AAAA,IACE,QAAQ,YAAY,mBAAoB,CAAC;AAAA,EAC3C;AAGA,QAAM,QAAQ,QAAQ,SAAS,CAAC;AAEhC,SAAO,KAAK,KAAK,EAAE,QAAQ,CAAC,SAAS;AACnC,UAAM,UAAU,OAAO,KAAK,cAAc,MAAM,IAAI,CAAC,CAAC;AAGtD,YAAQ,QAAQ,CAAC,WAAW;AAC1B,YAAM,QAAQ,kBAAkB,IAAI;AACpC,YAAM,YAAY,QAAQ,QAAQ,IAAI,IAAI,MAAM;AAGhD,UAAI,yBAAyB,UAAU,QAAQ,GAAG;AAChD,YAAI,MAAM,EAAE,OAAO,qBAAqB,QAAQ,SAAS,CAAC;AAAA,MAC5D;AAGA,UAAI,MAAM,EAAE,OAAO,CAAC,MAAe,gBAAgB,GAAG,WAAW,OAAO,CAAC;AAAA,IAC3E,CAAC;AAAA,EACH,CAAC;AAGD,MAAI,IAAI,iBAAiB,CAAC,MAAM,2BAA2B,GAAG,SAAS,eAAe,MAAM,CAAC;AAG7F,MAAI,IAAI,iBAAiB,CAAC,MAAM,2BAA2B,GAAG,SAAS,eAAe,MAAM,CAAC;AAE7F,SAAO;AACT;",
   "names": []
 }

package/dist/routes/respondWithOpenApiDocument.d.ts

@@ -2,9 +2,7 @@ import type { Context } from 'hono';
 /**
  * OpenAPI endpoints
  */
-export declare function respondWithOpenApiDocument(c: Context, input?: string | Record<string, any>, format?: 'json' | 'yaml'): Promise<(Response & import("hono").TypedResponse<"Not found", 404, "text">) | (Response & import("hono").TypedResponse<{
-    [x: string]: any;
-}, import("hono/utils/http-status").StatusCode, "json">) | (Response & import("hono").TypedResponse<string, 200, "text">) | (Response & import("hono").TypedResponse<{
+export declare function respondWithOpenApiDocument(c: Context, input?: string | Record<string, any>, format?: 'json' | 'yaml'): Promise<(Response & import("hono").TypedResponse<"Not found", 404, "text">) | (Response & import("hono").TypedResponse<never, import("hono/utils/http-status").StatusCode, "json">) | (Response & import("hono").TypedResponse<string, 200, "text">) | (Response & import("hono").TypedResponse<{
     error: string;
     message: string;
 }, 500, "json">) | (Response & import("hono").TypedResponse<{

package/dist/routes/respondWithOpenApiDocument.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"respondWithOpenApiDocument.d.ts","sourceRoot":"","sources":["../../src/routes/respondWithOpenApiDocument.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEnC;;GAEG;AACH,wBAAsB,0BAA0B,CAC9C,CAAC,EAAE,OAAO,EACV,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACpC,MAAM,GAAE,MAAM,GAAG,MAAe;;;;;;;;kBAuCjC"}
+{"version":3,"file":"respondWithOpenApiDocument.d.ts","sourceRoot":"","sources":["../../src/routes/respondWithOpenApiDocument.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEnC;;GAEG;AACH,wBAAsB,0BAA0B,CAC9C,CAAC,EAAE,OAAO,EACV,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACpC,MAAM,GAAE,MAAM,GAAG,MAAe;;;;;;kBAwCjC"}

package/dist/routes/respondWithOpenApiDocument.js

@@ -1,23 +1,23 @@
-import { openapi } from "@scalar/openapi-parser";
+import { normalize, toYaml } from "@scalar/openapi-parser";
 async function respondWithOpenApiDocument(c, input, format = "json") {
   if (!input) {
     return c.text("Not found", 404);
   }
   try {
-    const { specification } = await openapi().load(input).get();
+    const document = normalize(input);
     if (format === "json") {
-      return c.json(specification);
+      return c.json(document);
     }
     try {
-      const yamlSpecification = await openapi().load(input).toYaml();
+      const yamlDocument = toYaml(normalize(document));
       c.header("Content-Type", "text/yaml");
-      return c.text(yamlSpecification, 200, {
+      return c.text(yamlDocument, 200, {
         "Content-Type": "application/yaml; charset=UTF-8"
       });
     } catch (error) {
       return c.json(
         {
-          error: "Failed to convert specification to YAML",
+          error: "Failed to convert document to YAML",
           message: error instanceof Error ? error.message : "Unknown error occurred"
         },
         500
@@ -26,7 +26,7 @@ async function respondWithOpenApiDocument(c, input, format = "json") {
   } catch (error) {
     return c.json(
       {
-        error: "Failed to parse OpenAPI specification",
+        error: "Failed to parse OpenAPI document",
         message: error instanceof Error ? error.message : "Unknown error occurred"
       },
       400

package/dist/routes/respondWithOpenApiDocument.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/routes/respondWithOpenApiDocument.ts"],
-  "sourcesContent": ["import { openapi } from '@scalar/openapi-parser'\nimport type { Context } from 'hono'\n\n/**\n * OpenAPI endpoints\n */\nexport async function respondWithOpenApiDocument(\n  c: Context,\n  input?: string | Record<string, any>,\n  format: 'json' | 'yaml' = 'json',\n) {\n  if (!input) {\n    return c.text('Not found', 404)\n  }\n\n  try {\n    const { specification } = await openapi().load(input).get()\n\n    // JSON\n    if (format === 'json') {\n      return c.json(specification)\n    }\n\n    // YAML\n    try {\n      const yamlSpecification = await openapi().load(input).toYaml()\n      c.header('Content-Type', 'text/yaml')\n      return c.text(yamlSpecification, 200, {\n        'Content-Type': 'application/yaml; charset=UTF-8',\n      })\n    } catch (error) {\n      return c.json(\n        {\n          error: 'Failed to convert specification to YAML',\n          message: error instanceof Error ? error.message : 'Unknown error occurred',\n        },\n        500,\n      )\n    }\n  } catch (error) {\n    return c.json(\n      {\n        error: 'Failed to parse OpenAPI specification',\n        message: error instanceof Error ? error.message : 'Unknown error occurred',\n      },\n      400,\n    )\n  }\n}\n"],
-  "mappings": "AAAA,SAAS,eAAe;AAMxB,eAAsB,2BACpB,GACA,OACA,SAA0B,QAC1B;AACA,MAAI,CAAC,OAAO;AACV,WAAO,EAAE,KAAK,aAAa,GAAG;AAAA,EAChC;AAEA,MAAI;AACF,UAAM,EAAE,cAAc,IAAI,MAAM,QAAQ,EAAE,KAAK,KAAK,EAAE,IAAI;AAG1D,QAAI,WAAW,QAAQ;AACrB,aAAO,EAAE,KAAK,aAAa;AAAA,IAC7B;AAGA,QAAI;AACF,YAAM,oBAAoB,MAAM,QAAQ,EAAE,KAAK,KAAK,EAAE,OAAO;AAC7D,QAAE,OAAO,gBAAgB,WAAW;AACpC,aAAO,EAAE,KAAK,mBAAmB,KAAK;AAAA,QACpC,gBAAgB;AAAA,MAClB,CAAC;AAAA,IACH,SAAS,OAAO;AACd,aAAO,EAAE;AAAA,QACP;AAAA,UACE,OAAO;AAAA,UACP,SAAS,iBAAiB,QAAQ,MAAM,UAAU;AAAA,QACpD;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAAA,EACF,SAAS,OAAO;AACd,WAAO,EAAE;AAAA,MACP;AAAA,QACE,OAAO;AAAA,QACP,SAAS,iBAAiB,QAAQ,MAAM,UAAU;AAAA,MACpD;AAAA,MACA;AAAA,IACF;AAAA,EACF;AACF;",
+  "sourcesContent": ["import { normalize, toYaml } from '@scalar/openapi-parser'\nimport type { Context } from 'hono'\n\n/**\n * OpenAPI endpoints\n */\nexport async function respondWithOpenApiDocument(\n  c: Context,\n  input?: string | Record<string, any>,\n  format: 'json' | 'yaml' = 'json',\n) {\n  if (!input) {\n    return c.text('Not found', 404)\n  }\n\n  try {\n    const document = normalize(input)\n\n    // JSON\n    if (format === 'json') {\n      return c.json(document)\n    }\n\n    // YAML\n    try {\n      const yamlDocument = toYaml(normalize(document))\n\n      c.header('Content-Type', 'text/yaml')\n      return c.text(yamlDocument, 200, {\n        'Content-Type': 'application/yaml; charset=UTF-8',\n      })\n    } catch (error) {\n      return c.json(\n        {\n          error: 'Failed to convert document to YAML',\n          message: error instanceof Error ? error.message : 'Unknown error occurred',\n        },\n        500,\n      )\n    }\n  } catch (error) {\n    return c.json(\n      {\n        error: 'Failed to parse OpenAPI document',\n        message: error instanceof Error ? error.message : 'Unknown error occurred',\n      },\n      400,\n    )\n  }\n}\n"],
+  "mappings": "AAAA,SAAS,WAAW,cAAc;AAMlC,eAAsB,2BACpB,GACA,OACA,SAA0B,QAC1B;AACA,MAAI,CAAC,OAAO;AACV,WAAO,EAAE,KAAK,aAAa,GAAG;AAAA,EAChC;AAEA,MAAI;AACF,UAAM,WAAW,UAAU,KAAK;AAGhC,QAAI,WAAW,QAAQ;AACrB,aAAO,EAAE,KAAK,QAAQ;AAAA,IACxB;AAGA,QAAI;AACF,YAAM,eAAe,OAAO,UAAU,QAAQ,CAAC;AAE/C,QAAE,OAAO,gBAAgB,WAAW;AACpC,aAAO,EAAE,KAAK,cAAc,KAAK;AAAA,QAC/B,gBAAgB;AAAA,MAClB,CAAC;AAAA,IACH,SAAS,OAAO;AACd,aAAO,EAAE;AAAA,QACP;AAAA,UACE,OAAO;AAAA,UACP,SAAS,iBAAiB,QAAQ,MAAM,UAAU;AAAA,QACpD;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAAA,EACF,SAAS,OAAO;AACd,WAAO,EAAE;AAAA,MACP;AAAA,QACE,OAAO;AAAA,QACP,SAAS,iBAAiB,QAAQ,MAAM,UAAU;AAAA,MACpD;AAAA,MACA;AAAA,IACF;AAAA,EACF;AACF;",
   "names": []
 }

package/package.json

@@ -16,7 +16,7 @@
     "swagger",
     "cli"
   ],
-  "version": "0.4.1",
+  "version": "0.5.0",
   "engines": {
     "node": ">=20"
   },
@@ -38,20 +38,20 @@
   "dependencies": {
     "hono": "^4.6.5",
     "object-to-xml": "^2.0.0",
-    "@scalar/oas-utils": "0.3.1",
-    "@scalar/openapi-parser": "0.11.0",
+    "@scalar/oas-utils": "0.3.2",
+    "@scalar/openapi-parser": "0.12.0",
     "@scalar/openapi-types": "0.3.1"
   },
   "devDependencies": {
     "@hono/node-server": "^1.11.0",
     "@types/node": "^20.17.10",
     "vite": "5.4.19",
-    "@scalar/hono-api-reference": "0.9.1",
-    "@scalar/build-tooling": "0.2.0"
+    "@scalar/build-tooling": "0.2.0",
+    "@scalar/hono-api-reference": "0.9.1"
   },
   "scripts": {
     "build": "scalar-build-esbuild",
-    "dev": "nodemon --exec \"vite-node playground/index.ts\" --ext ts --quiet",
+    "dev": "nodemon --exec \"vite-node playground/src/index.ts\" --ext ts --quiet",
     "lint:check": "scalar-lint-check",
     "lint:fix": "scalar-lint-fix",
     "test": "vitest",