@scalar/mock-server 0.1.60 → 0.1.62

package/CHANGELOG.md

@@ -0,0 +1,488 @@
+# @scalar/mock-server
+
+## 0.1.62
+
+### Patch Changes
+
+- 09b38c4: fix: openapi.json returns yaml string
+- ea0eed3: fix: types not available
+
+## 0.1.61
+
+### Patch Changes
+
+- 5a2f0c9: fix: release workflow fails
+
+## 0.1.60
+
+### Patch Changes
+
+- 17841a8: fix: wrong repository URL in the package.json
+
+## 0.1.59
+
+### Patch Changes
+
+- 45dc04b: fix: can’t release packages
+- Updated dependencies [9ba838b]
+- Updated dependencies [45dc04b]
+  - @scalar/api-reference@1.22.24
+  - @scalar/oas-utils@0.1.10
+  - @scalar/galaxy@0.1.2
+
+## 0.1.58
+
+### Patch Changes
+
+- 05e2e27: chore: add provenance statement
+- Updated dependencies [05e2e27]
+  - @scalar/api-reference@1.22.23
+  - @scalar/galaxy@0.1.1
+  - @scalar/oas-utils@0.1.9
+
+## 0.1.57
+
+### Patch Changes
+
+- Updated dependencies [f1bf5bc]
+- Updated dependencies [085a0c2]
+- Updated dependencies [fa10d45]
+  - @scalar/api-reference@1.22.22
+  - @scalar/oas-utils@0.1.8
+
+## 0.1.56
+
+### Patch Changes
+
+- Updated dependencies [07211ad]
+- Updated dependencies [801ad65]
+- Updated dependencies [d4fa19b]
+- Updated dependencies [b234d1d]
+  - @scalar/api-reference@1.22.21
+  - @scalar/oas-utils@0.1.7
+
+## 0.1.55
+
+### Patch Changes
+
+- Updated dependencies [a8c3045]
+- Updated dependencies [1324378]
+- Updated dependencies [9201802]
+  - @scalar/api-reference@1.22.20
+
+## 0.1.54
+
+### Patch Changes
+
+- @scalar/api-reference@1.22.19
+
+## 0.1.53
+
+### Patch Changes
+
+- Updated dependencies [45dccb0]
+- Updated dependencies [abff1f4]
+  - @scalar/api-reference@1.22.18
+
+## 0.1.52
+
+### Patch Changes
+
+- Updated dependencies [53ba90d]
+- Updated dependencies [b42479c]
+- Updated dependencies [4c38ac1]
+  - @scalar/galaxy@0.1.0
+  - @scalar/api-reference@1.22.17
+
+## 0.1.51
+
+### Patch Changes
+
+- Updated dependencies [7e1d318]
+  - @scalar/api-reference@1.22.16
+
+## 0.1.50
+
+### Patch Changes
+
+- Updated dependencies [fc2c90f]
+  - @scalar/api-reference@1.22.15
+
+## 0.1.49
+
+### Patch Changes
+
+- Updated dependencies [b8e3f09]
+  - @scalar/api-reference@1.22.14
+
+## 0.1.48
+
+### Patch Changes
+
+- Updated dependencies [c05c90e]
+- Updated dependencies [2700c5c]
+  - @scalar/api-reference@1.22.13
+
+## 0.1.47
+
+### Patch Changes
+
+- Updated dependencies [55398db]
+  - @scalar/api-reference@1.22.12
+
+## 0.1.46
+
+### Patch Changes
+
+- Updated dependencies [b24b455]
+- Updated dependencies [43e1217]
+  - @scalar/api-reference@1.22.11
+
+## 0.1.45
+
+### Patch Changes
+
+- @scalar/api-reference@1.22.10
+
+## 0.1.44
+
+### Patch Changes
+
+- Updated dependencies [6f68b40]
+- Updated dependencies [4d31b19]
+  - @scalar/api-reference@1.22.9
+
+## 0.1.43
+
+### Patch Changes
+
+- Updated dependencies [24662c3]
+  - @scalar/api-reference@1.22.8
+
+## 0.1.42
+
+### Patch Changes
+
+- Updated dependencies [c408cf5]
+  - @scalar/api-reference@1.22.7
+
+## 0.1.41
+
+### Patch Changes
+
+- Updated dependencies [cf12a95]
+- Updated dependencies [7b37c63]
+  - @scalar/api-reference@1.22.6
+
+## 0.1.40
+
+### Patch Changes
+
+- Updated dependencies [d03ab0f]
+  - @scalar/api-reference@1.22.5
+
+## 0.1.39
+
+### Patch Changes
+
+- Updated dependencies [adc0693]
+  - @scalar/api-reference@1.22.4
+
+## 0.1.38
+
+### Patch Changes
+
+- @scalar/api-reference@1.22.3
+
+## 0.1.37
+
+### Patch Changes
+
+- @scalar/api-reference@1.22.2
+
+## 0.1.36
+
+### Patch Changes
+
+- Updated dependencies [8dc1640]
+  - @scalar/api-reference@1.22.1
+
+## 0.1.35
+
+### Patch Changes
+
+- 22f2858: chore: ran syncpack to update packages
+- Updated dependencies [22f2858]
+- Updated dependencies [ced76e5]
+- Updated dependencies [0e64a36]
+- Updated dependencies [3afec45]
+  - @scalar/api-reference@1.22.0
+  - @scalar/oas-utils@0.1.6
+
+## 0.1.34
+
+### Patch Changes
+
+- Updated dependencies [851017a]
+  - @scalar/api-reference@1.21.2
+
+## 0.1.33
+
+### Patch Changes
+
+- Updated dependencies [b4abb34]
+  - @scalar/api-reference@1.21.1
+
+## 0.1.32
+
+### Patch Changes
+
+- Updated dependencies [51d4997]
+  - @scalar/api-reference@1.20.32
+
+## 0.1.31
+
+### Patch Changes
+
+- Updated dependencies [b903a2f]
+  - @scalar/api-reference@1.20.31
+
+## 0.1.30
+
+### Patch Changes
+
+- Updated dependencies [deabe4c]
+- Updated dependencies [3ba9774]
+- Updated dependencies [a14fc32]
+- Updated dependencies [3d4d83e]
+  - @scalar/api-reference@1.20.30
+  - @scalar/oas-utils@0.1.5
+
+## 0.1.29
+
+### Patch Changes
+
+- Updated dependencies [24b3c2a]
+  - @scalar/oas-utils@0.1.4
+  - @scalar/api-reference@1.20.29
+
+## 0.1.28
+
+### Patch Changes
+
+- Updated dependencies [622f31b]
+- Updated dependencies [f2c2ce8]
+  - @scalar/api-reference@1.20.28
+
+## 0.1.27
+
+### Patch Changes
+
+- Updated dependencies [605f522]
+  - @scalar/api-reference@1.20.27
+
+## 0.1.26
+
+### Patch Changes
+
+- Updated dependencies [050410a]
+  - @scalar/api-reference@1.20.26
+
+## 0.1.25
+
+### Patch Changes
+
+- Updated dependencies [1504d3b]
+  - @scalar/api-reference@1.20.25
+
+## 0.1.24
+
+### Patch Changes
+
+- Updated dependencies [ab58747]
+  - @scalar/api-reference@1.20.24
+
+## 0.1.23
+
+### Patch Changes
+
+- @scalar/api-reference@1.20.23
+
+## 0.1.22
+
+### Patch Changes
+
+- Updated dependencies [4089634]
+  - @scalar/api-reference@1.20.22
+
+## 0.1.21
+
+### Patch Changes
+
+- @scalar/api-reference@1.20.21
+
+## 0.1.20
+
+### Patch Changes
+
+- Updated dependencies [c14568f]
+  - @scalar/oas-utils@0.1.3
+  - @scalar/api-reference@1.20.20
+
+## 0.1.19
+
+### Patch Changes
+
+- Updated dependencies [c99f6ff]
+  - @scalar/api-reference@1.20.18
+
+## 0.1.18
+
+### Patch Changes
+
+- Updated dependencies [5b4c8a5]
+  - @scalar/api-reference@1.20.17
+
+## 0.1.17
+
+### Patch Changes
+
+- Updated dependencies [5232eab]
+  - @scalar/api-reference@1.20.16
+
+## 0.1.16
+
+### Patch Changes
+
+- Updated dependencies [8f03345]
+  - @scalar/api-reference@1.20.15
+
+## 0.1.15
+
+### Patch Changes
+
+- Updated dependencies [78f2ab3]
+  - @scalar/api-reference@1.20.14
+
+## 0.1.14
+
+### Patch Changes
+
+- Updated dependencies [8b0691b]
+  - @scalar/api-reference@1.20.13
+  - @scalar/oas-utils@0.1.2
+
+## 0.1.13
+
+### Patch Changes
+
+- Updated dependencies [999dfc9]
+  - @scalar/api-reference@1.20.12
+
+## 0.1.12
+
+### Patch Changes
+
+- Updated dependencies [d70bda7]
+  - @scalar/api-reference@1.20.11
+
+## 0.1.11
+
+### Patch Changes
+
+- Updated dependencies [ae193a8]
+- Updated dependencies [bec8e52]
+  - @scalar/api-reference@1.20.10
+
+## 0.1.10
+
+### Patch Changes
+
+- Updated dependencies [5260d07]
+- Updated dependencies [f861efa]
+  - @scalar/api-reference@1.20.9
+
+## 0.1.9
+
+### Patch Changes
+
+- @scalar/api-reference@1.20.8
+
+## 0.1.8
+
+### Patch Changes
+
+- Updated dependencies [1e658b0]
+- Updated dependencies [06c57ca]
+  - @scalar/api-reference@1.20.7
+
+## 0.1.7
+
+### Patch Changes
+
+- @scalar/api-reference@1.20.6
+
+## 0.1.6
+
+### Patch Changes
+
+- Updated dependencies [0c5e22c]
+  - @scalar/api-reference@1.20.5
+
+## 0.1.5
+
+### Patch Changes
+
+- @scalar/api-reference@1.20.4
+
+## 0.1.4
+
+### Patch Changes
+
+- Updated dependencies [61a97e2]
+  - @scalar/api-reference@1.20.3
+
+## 0.1.3
+
+### Patch Changes
+
+- Updated dependencies [9fe930c]
+  - @scalar/api-reference@1.20.2
+
+## 0.1.2
+
+### Patch Changes
+
+- Updated dependencies [4b5a136]
+- Updated dependencies [1fb2eac]
+- Updated dependencies [01476a9]
+- Updated dependencies [083e0a1]
+  - @scalar/api-reference@1.20.1
+
+## 0.1.1
+
+### Patch Changes
+
+- 31aae5e: chore: moved shared types and methods into oas-utils
+- Updated dependencies [6dc67c1]
+- Updated dependencies [c4500f6]
+- Updated dependencies [41f0d86]
+- Updated dependencies [31aae5e]
+  - @scalar/api-reference@1.20.0
+  - @scalar/oas-utils@0.1.1
+
+## 0.1.0
+
+### Minor Changes
+
+- a866e91: refactor: switch to @scalar/openapi-parser
+
+### Patch Changes
+
+- 0399390: chore: update dependencies
+
+## 0.0.2
+
+### Patch Changes
+
+- 96b85ef: feat: new @scalar/mock-server package

package/dist/index.cjs

@@ -0,0 +1,59 @@
+'use strict';
+
+var oasUtils = require('@scalar/oas-utils');
+var openapiParser = require('@scalar/openapi-parser');
+var hono = require('hono');
+
+function normalize(openapi) {
+  if (typeof openapi === "string") {
+    openapi = JSON.parse(openapi);
+  }
+  return openapi;
+}
+
+function routeFromPath(path) {
+  return path.replace(/{/g, ":").replace(/}/g, "");
+}
+
+async function createMockServer(options) {
+  const app = new hono.Hono();
+  const result = await openapiParser.openapi().load(options?.specification ?? {}).resolve();
+  app.get("/openapi.json", (c) => {
+    if (!options?.specification) {
+      return c.text("Not found", 404);
+    }
+    return c.json(openapiParser.openapi().load(options.specification).get());
+  });
+  app.get("/openapi.yaml", (c) => {
+    if (!options?.specification) {
+      return c.text("Not found", 404);
+    }
+    return c.text(openapiParser.openapi().load(options.specification).toYaml());
+  });
+  Object.keys(result.schema?.paths ?? {}).forEach((path) => {
+    Object.keys(result.schema?.paths?.[path] ?? {}).forEach((method) => {
+      const route = routeFromPath(path);
+      app[method](route, (c) => {
+        if (options?.onRequest) {
+          options.onRequest({
+            context: c,
+            // @ts-expect-error Needs a proper type
+            operation: result.schema.paths[path][method]
+          });
+        }
+        const operation = result.schema?.paths?.[path]?.[method];
+        const jsonResponseConfiguration = operation.responses?.["200"]?.content["application/json"];
+        const response = jsonResponseConfiguration?.example ? jsonResponseConfiguration.example : jsonResponseConfiguration?.schema ? oasUtils.getExampleFromSchema(jsonResponseConfiguration.schema, {
+          emptyString: "\u2026"
+        }) : null;
+        return c.json(response);
+      });
+    });
+  });
+  return app;
+}
+
+exports.createMockServer = createMockServer;
+exports.normalize = normalize;
+exports.routeFromPath = routeFromPath;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/utils/normalize.ts","../src/utils/routeFromPath.ts","../src/createMockServer.ts"],"sourcesContent":["/**\n * Normalize OpenAPI JSON string, YAML string … to object\n */\nexport function normalize(openapi: string | Record<string, any>) {\n  if (typeof openapi === 'string') {\n    openapi = JSON.parse(openapi)\n  }\n\n  return openapi\n}\n","/**\n * Convert path to route\n * Example: /posts/{id} -> /posts/:id\n */\nexport function routeFromPath(path: string) {\n  return path.replace(/{/g, ':').replace(/}/g, '')\n}\n","import { type Operation, getExampleFromSchema } from '@scalar/oas-utils'\nimport { openapi } from '@scalar/openapi-parser'\nimport { type Context, Hono } from 'hono'\n\nimport { routeFromPath } from './utils'\n\n/**\n * Create a mock server instance\n */\nexport async function createMockServer(options?: {\n  specification: string | Record<string, any>\n  onRequest?: (data: { context: Context; operation: Operation }) => void\n}) {\n  const app = new Hono()\n\n  // Resolve references\n  const result = await openapi()\n    .load(options?.specification ?? {})\n    .resolve()\n\n  // OpenAPI JSON file\n  app.get('/openapi.json', (c) => {\n    if (!options?.specification) {\n      return c.text('Not found', 404)\n    }\n\n    return c.json(openapi().load(options.specification).get())\n  })\n\n  // OpenAPI YAML file\n  app.get('/openapi.yaml', (c) => {\n    if (!options?.specification) {\n      return c.text('Not found', 404)\n    }\n\n    return c.text(openapi().load(options.specification).toYaml())\n  })\n\n  // Paths\n  Object.keys(result.schema?.paths ?? {}).forEach((path) => {\n    // Request methods\n    Object.keys(result.schema?.paths?.[path] ?? {}).forEach((method) => {\n      const route = routeFromPath(path)\n\n      // Route\n      // @ts-expect-error Needs a proper type\n      app[method](route, (c: Context) => {\n        // Call onRequest callback\n        if (options?.onRequest) {\n          options.onRequest({\n            context: c,\n            // @ts-expect-error Needs a proper type\n            operation: result.schema.paths[path][method],\n          })\n        }\n\n        // Response\n        // @ts-expect-error Needs a proper type\n        const operation = result.schema?.paths?.[path]?.[method]\n\n        const jsonResponseConfiguration =\n          operation.responses?.['200']?.content['application/json']\n\n        const response = jsonResponseConfiguration?.example\n          ? jsonResponseConfiguration.example\n          : jsonResponseConfiguration?.schema\n            ? getExampleFromSchema(jsonResponseConfiguration.schema, {\n                emptyString: '…',\n              })\n            : null\n\n        return c.json(response)\n      })\n    })\n  })\n\n  return app\n}\n"],"names":["Hono","openapi","getExampleFromSchema"],"mappings":";;;;;;AAGO,SAAS,UAAU,OAAuC,EAAA;AAC/D,EAAI,IAAA,OAAO,YAAY,QAAU,EAAA;AAC/B,IAAU,OAAA,GAAA,IAAA,CAAK,MAAM,OAAO,CAAA,CAAA;AAAA,GAC9B;AAEA,EAAO,OAAA,OAAA,CAAA;AACT;;ACLO,SAAS,cAAc,IAAc,EAAA;AAC1C,EAAA,OAAO,KAAK,OAAQ,CAAA,IAAA,EAAM,GAAG,CAAE,CAAA,OAAA,CAAQ,MAAM,EAAE,CAAA,CAAA;AACjD;;ACGA,eAAsB,iBAAiB,OAGpC,EAAA;AACD,EAAM,MAAA,GAAA,GAAM,IAAIA,SAAK,EAAA,CAAA;AAGrB,EAAM,MAAA,MAAA,GAAS,MAAMC,qBAAA,EAClB,CAAA,IAAA,CAAK,SAAS,aAAiB,IAAA,EAAE,CAAA,CACjC,OAAQ,EAAA,CAAA;AAGX,EAAI,GAAA,CAAA,GAAA,CAAI,eAAiB,EAAA,CAAC,CAAM,KAAA;AAC9B,IAAI,IAAA,CAAC,SAAS,aAAe,EAAA;AAC3B,MAAO,OAAA,CAAA,CAAE,IAAK,CAAA,WAAA,EAAa,GAAG,CAAA,CAAA;AAAA,KAChC;AAEA,IAAO,OAAA,CAAA,CAAE,KAAKA,qBAAQ,EAAA,CAAE,KAAK,OAAQ,CAAA,aAAa,CAAE,CAAA,GAAA,EAAK,CAAA,CAAA;AAAA,GAC1D,CAAA,CAAA;AAGD,EAAI,GAAA,CAAA,GAAA,CAAI,eAAiB,EAAA,CAAC,CAAM,KAAA;AAC9B,IAAI,IAAA,CAAC,SAAS,aAAe,EAAA;AAC3B,MAAO,OAAA,CAAA,CAAE,IAAK,CAAA,WAAA,EAAa,GAAG,CAAA,CAAA;AAAA,KAChC;AAEA,IAAO,OAAA,CAAA,CAAE,KAAKA,qBAAQ,EAAA,CAAE,KAAK,OAAQ,CAAA,aAAa,CAAE,CAAA,MAAA,EAAQ,CAAA,CAAA;AAAA,GAC7D,CAAA,CAAA;AAGD,EAAO,MAAA,CAAA,IAAA,CAAK,OAAO,MAAQ,EAAA,KAAA,IAAS,EAAE,CAAA,CAAE,OAAQ,CAAA,CAAC,IAAS,KAAA;AAExD,IAAO,MAAA,CAAA,IAAA,CAAK,MAAO,CAAA,MAAA,EAAQ,KAAQ,GAAA,IAAI,CAAK,IAAA,EAAE,CAAA,CAAE,OAAQ,CAAA,CAAC,MAAW,KAAA;AAClE,MAAM,MAAA,KAAA,GAAQ,cAAc,IAAI,CAAA,CAAA;AAIhC,MAAA,GAAA,CAAI,MAAM,CAAA,CAAE,KAAO,EAAA,CAAC,CAAe,KAAA;AAEjC,QAAA,IAAI,SAAS,SAAW,EAAA;AACtB,UAAA,OAAA,CAAQ,SAAU,CAAA;AAAA,YAChB,OAAS,EAAA,CAAA;AAAA;AAAA,YAET,WAAW,MAAO,CAAA,MAAA,CAAO,KAAM,CAAA,IAAI,EAAE,MAAM,CAAA;AAAA,WAC5C,CAAA,CAAA;AAAA,SACH;AAIA,QAAA,MAAM,YAAY,MAAO,CAAA,MAAA,EAAQ,KAAQ,GAAA,IAAI,IAAI,MAAM,CAAA,CAAA;AAEvD,QAAA,MAAM,4BACJ,SAAU,CAAA,SAAA,GAAY,KAAK,CAAA,EAAG,QAAQ,kBAAkB,CAAA,CAAA;AAE1D,QAAM,MAAA,QAAA,GAAW,2BAA2B,OACxC,GAAA,yBAAA,CAA0B,UAC1B,yBAA2B,EAAA,MAAA,GACzBC,6BAAqB,CAAA,yBAAA,CAA0B,MAAQ,EAAA;AAAA,UACrD,WAAa,EAAA,QAAA;AAAA,SACd,CACD,GAAA,IAAA,CAAA;AAEN,QAAO,OAAA,CAAA,CAAE,KAAK,QAAQ,CAAA,CAAA;AAAA,OACvB,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACF,CAAA,CAAA;AAED,EAAO,OAAA,GAAA,CAAA;AACT;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+import * as hono_types from 'hono/types';
+import * as hono from 'hono';
+import { Context, Hono } from 'hono';
+import { Operation } from '@scalar/oas-utils';
+
+/**
+ * Create a mock server instance
+ */
+declare function createMockServer(options?: {
+    specification: string | Record<string, any>;
+    onRequest?: (data: {
+        context: Context;
+        operation: Operation;
+    }) => void;
+}): Promise<Hono<hono.Env, hono_types.BlankSchema, "/">>;
+
+/**
+ * Normalize OpenAPI JSON string, YAML string … to object
+ */
+declare function normalize(openapi: string | Record<string, any>): string | Record<string, any>;
+
+/**
+ * Convert path to route
+ * Example: /posts/{id} -> /posts/:id
+ */
+declare function routeFromPath(path: string): string;
+
+export { createMockServer, normalize, routeFromPath };