@scalar/mock-server 0.2.17 → 0.2.19

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scalar/mock-server
 
+## 0.2.19
+
+### Patch Changes
+
+- @scalar/oas-utils@0.2.17
+
+## 0.2.18
+
+### Patch Changes
+
+- de9e775: fix: tries to register non-http methods as routes
+
 ## 0.2.17
 
 ### Patch Changes

package/dist/createMockServer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createMockServer.d.ts","sourceRoot":"","sources":["../src/createMockServer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,OAAO,EAAW,MAAM,wBAAwB,CAAA;AAC9D,OAAO,EAAE,KAAK,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAezC;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,CAAC,EAAE;IAC/C,aAAa,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC3C,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,SAAS,EAAE,OAAO,CAAC,SAAS,CAAA;KAAE,KAAK,IAAI,CAAA;CAC/E,uFAiJA"}
+{"version":3,"file":"createMockServer.d.ts","sourceRoot":"","sources":["../src/createMockServer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,OAAO,EAAW,MAAM,wBAAwB,CAAA;AAC9D,OAAO,EAAE,KAAK,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAiBzC;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,CAAC,EAAE;IAC/C,aAAa,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC3C,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,SAAS,EAAE,OAAO,CAAC,SAAS,CAAA;KAAE,KAAK,IAAI,CAAA;CAC/E,uFA8IA"}

package/dist/createMockServer.js

@@ -2,13 +2,14 @@ import { getExampleFromSchema } from '@scalar/oas-utils/spec-getters';
 import { openapi } from '@scalar/openapi-parser';
 import { Hono } from 'hono';
 import { cors } from 'hono/cors';
-import { anyBasicAuthentication } from './utils/anyBasicAuthentication.js';
-import { anyOpenAuthPasswordGrantAuthentication } from './utils/anyOpenAuthPasswordGrantAuthentication.js';
 import { getOpenAuthTokenUrl } from './utils/getOpenAuthTokenUrl.js';
+import { getOperations } from './utils/getOperations.js';
+import { honoRouteFromPath } from './utils/honoRouteFromPath.js';
+import { isAuthenticationRequired } from './utils/isAuthenticationRequired.js';
 import { isBasicAuthenticationRequired } from './utils/isBasicAuthenticationRequired.js';
+import { anyBasicAuthentication } from './utils/anyBasicAuthentication.js';
 import { isOpenAuthPasswordGrantRequired } from './utils/isOpenAuthPasswordGrantRequired.js';
-import { routeFromPath } from './utils/routeFromPath.js';
-import { isAuthenticationRequired } from './utils/isAuthenticationRequired.js';
+import { anyOpenAuthPasswordGrantAuthentication } from './utils/anyOpenAuthPasswordGrantAuthentication.js';
 import { findPreferredResponseKey } from './utils/findPreferredResponseKey.js';
 
 /**
@@ -16,8 +17,8 @@ import { findPreferredResponseKey } from './utils/findPreferredResponseKey.js';
  */
 async function createMockServer(options) {
     const app = new Hono();
-    // Resolve references
-    const result = await openapi()
+    /** Dereferenced OpenAPI document */
+    const { schema } = await openapi()
         .load(options?.specification ?? {})
         .dereference()
         .get();
@@ -40,7 +41,7 @@ async function createMockServer(options) {
         return c.text(specification);
     });
     // OpenAuth2 token endpoint
-    const tokenUrl = getOpenAuthTokenUrl(result?.schema);
+    const tokenUrl = getOpenAuthTokenUrl(schema);
     if (typeof tokenUrl === 'string') {
         app.post(tokenUrl, async (c) => {
             return c.json({
@@ -59,31 +60,29 @@ async function createMockServer(options) {
             });
         });
     }
-    // Paths
-    Object.keys(result.schema?.paths ?? {}).forEach((path) => {
-        // Operations
-        Object.keys(result.schema?.paths?.[path] ?? {}).forEach((method) => {
-            const route = routeFromPath(path);
-            // @ts-expect-error Needs a proper type
-            const operation = result.schema?.paths?.[path]?.[method];
+    /** Paths specified in the OpenAPI document */
+    const paths = schema?.paths ?? {};
+    Object.keys(paths).forEach((path) => {
+        const methods = Object.keys(getOperations(paths[path]));
+        /** Keys for all operations of a specified path */
+        methods.forEach((method) => {
+            const route = honoRouteFromPath(path);
+            const operation = schema?.paths?.[path]?.[method];
             // Check if authentication is required
             const requiresAuthentication = isAuthenticationRequired(operation.security);
             // Check whether we need basic authentication
-            const requiresBasicAuthentication = isBasicAuthenticationRequired(operation, result?.schema);
+            const requiresBasicAuthentication = isBasicAuthenticationRequired(operation, schema);
             // Add HTTP basic authentication
             if (requiresAuthentication && requiresBasicAuthentication) {
-                // @ts-expect-error Needs a proper type
                 app[method](route, anyBasicAuthentication());
             }
             // Check whether we need OpenAuth password grant authentication
-            const requiresOpenAuthPasswordGrant = isOpenAuthPasswordGrantRequired(operation, result?.schema);
+            const requiresOpenAuthPasswordGrant = isOpenAuthPasswordGrantRequired(operation, schema);
             // Add HTTP basic authentication
             if (requiresAuthentication && requiresOpenAuthPasswordGrant) {
-                // @ts-expect-error Needs a proper type
                 app[method](route, anyOpenAuthPasswordGrantAuthentication());
             }
             // Route
-            // @ts-expect-error Needs a proper type
             app[method](route, (c) => {
                 // Call onRequest callback
                 if (options?.onRequest) {

package/dist/index.d.ts

@@ -1,3 +1,2 @@
 export * from './createMockServer.js';
-export * from './utils';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA"}

package/dist/index.js

@@ -1,4 +1 @@
 export { createMockServer } from './createMockServer.js';
-export { findPreferredResponseKey } from './utils/findPreferredResponseKey.js';
-export { routeFromPath } from './utils/routeFromPath.js';
-export { isAuthenticationRequired } from './utils/isAuthenticationRequired.js';

package/dist/types.d.ts

@@ -0,0 +1,5 @@
+/** Available HTTP methods for Hono routes */
+export declare const httpMethods: readonly ["get", "put", "post", "delete", "options", "patch"];
+/** Valid HTTP method */
+export type HttpMethod = (typeof httpMethods)[number];
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,eAAO,MAAM,WAAW,+DAOd,CAAA;AAEV,wBAAwB;AACxB,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,CAAC,CAAA"}

package/dist/types.js

@@ -0,0 +1,11 @@
+/** Available HTTP methods for Hono routes */
+const httpMethods = [
+    'get',
+    'put',
+    'post',
+    'delete',
+    'options',
+    'patch',
+];
+
+export { httpMethods };

package/dist/utils/findPreferredResponseKey.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=findPreferredResponseKey.test.d.ts.map

package/dist/utils/findPreferredResponseKey.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findPreferredResponseKey.test.d.ts","sourceRoot":"","sources":["../../src/utils/findPreferredResponseKey.test.ts"],"names":[],"mappings":""}

package/dist/utils/getOperations.d.ts

@@ -0,0 +1,8 @@
+import type { OpenAPI, OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from '@scalar/openapi-parser';
+import { type HttpMethod } from '../types.js';
+/**
+ * Takes a dereferenced OpenAPI document and returns all operations.
+ * Ignores other attributes, like summary, parameters, etc.
+ */
+export declare function getOperations(path?: OpenAPIV2.PathItemObject | OpenAPIV3.PathItemObject | OpenAPIV3_1.PathItemObject): Record<HttpMethod, OpenAPI.Operation>;
+//# sourceMappingURL=getOperations.d.ts.map

package/dist/utils/getOperations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getOperations.d.ts","sourceRoot":"","sources":["../../src/utils/getOperations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,SAAS,EACT,SAAS,EACT,WAAW,EACZ,MAAM,wBAAwB,CAAA;AAE/B,OAAO,EAAE,KAAK,UAAU,EAAe,MAAM,UAAU,CAAA;AAEvD;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,IAAI,CAAC,EACD,SAAS,CAAC,cAAc,GACxB,SAAS,CAAC,cAAc,GACxB,WAAW,CAAC,cAAc,GAC7B,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC,CAUvC"}

package/dist/utils/getOperations.js

@@ -0,0 +1,17 @@
+import { httpMethods } from '../types.js';
+
+/**
+ * Takes a dereferenced OpenAPI document and returns all operations.
+ * Ignores other attributes, like summary, parameters, etc.
+ */
+function getOperations(path) {
+    const operations = {};
+    for (const method of httpMethods) {
+        if (path?.[method]) {
+            operations[method] = path?.[method];
+        }
+    }
+    return operations;
+}
+
+export { getOperations };

package/dist/utils/honoRouteFromPath.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Convert path to route
+ * Example: /posts/{id} -> /posts/:id
+ */
+export declare function honoRouteFromPath(path: string): string;
+//# sourceMappingURL=honoRouteFromPath.d.ts.map

package/dist/utils/honoRouteFromPath.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"honoRouteFromPath.d.ts","sourceRoot":"","sources":["../../src/utils/honoRouteFromPath.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,UAE7C"}

package/dist/utils/{routeFromPath.js → honoRouteFromPath.js}

@@ -2,8 +2,8 @@
  * Convert path to route
  * Example: /posts/{id} -> /posts/:id
  */
-function routeFromPath(path) {
+function honoRouteFromPath(path) {
     return path.replace(/{/g, ':').replace(/}/g, '');
 }
 
-export { routeFromPath };
+export { honoRouteFromPath };

package/dist/utils/honoRouteFromPath.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=honoRouteFromPath.test.d.ts.map

package/dist/utils/honoRouteFromPath.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"honoRouteFromPath.test.d.ts","sourceRoot":"","sources":["../../src/utils/honoRouteFromPath.test.ts"],"names":[],"mappings":""}

package/dist/utils/index.d.ts

@@ -1,4 +1,12 @@
+export * from './anyBasicAuthentication.js';
+export * from './anyOpenAuthPasswordGrantAuthentication.js';
+export * from './findPreferredResponseKey.test';
 export * from './findPreferredResponseKey.js';
-export * from './routeFromPath.js';
+export * from './getOpenAuthTokenUrl.js';
+export * from './getOperations.js';
+export * from './honoRouteFromPath.test';
+export * from './honoRouteFromPath.js';
 export * from './isAuthenticationRequired.js';
+export * from './isBasicAuthenticationRequired.js';
+export * from './isOpenAuthPasswordGrantRequired.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAA;AAC1C,cAAc,iBAAiB,CAAA;AAC/B,cAAc,4BAA4B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAA;AACxC,cAAc,0CAA0C,CAAA;AACxD,cAAc,iCAAiC,CAAA;AAC/C,cAAc,4BAA4B,CAAA;AAC1C,cAAc,uBAAuB,CAAA;AACrC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,0BAA0B,CAAA;AACxC,cAAc,qBAAqB,CAAA;AACnC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,iCAAiC,CAAA;AAC/C,cAAc,mCAAmC,CAAA"}

package/package.json

@@ -16,7 +16,7 @@
     "swagger",
     "cli"
   ],
-  "version": "0.2.17",
+  "version": "0.2.19",
   "engines": {
     "node": ">=18"
   },
@@ -37,14 +37,13 @@
   "dependencies": {
     "@scalar/openapi-parser": "^0.7.2",
     "hono": "^4.2.7",
-    "@scalar/oas-utils": "0.2.16"
+    "@scalar/oas-utils": "0.2.17"
   },
   "devDependencies": {
     "@hono/node-server": "^1.11.0",
     "@types/node": "^20.14.10",
-    "vite-node": "^1.3.1",
-    "@scalar/build-tooling": "0.1.10",
-    "@scalar/galaxy": "0.2.4"
+    "@scalar/galaxy": "0.2.5",
+    "@scalar/build-tooling": "0.1.10"
   },
   "scripts": {
     "build": "scalar-build-rollup",

package/dist/utils/routeFromPath.d.ts

@@ -1,6 +0,0 @@
-/**
- * Convert path to route
- * Example: /posts/{id} -> /posts/:id
- */
-export declare function routeFromPath(path: string): string;
-//# sourceMappingURL=routeFromPath.d.ts.map

package/dist/utils/routeFromPath.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"routeFromPath.d.ts","sourceRoot":"","sources":["../../src/utils/routeFromPath.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,UAEzC"}