@scalar/mock-server 0.2.18 → 0.2.20

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @scalar/mock-server
 
+## 0.2.20
+
+### Patch Changes
+
+- ad002b9: feat: add headers to mocked responses
+- f4e0edc: fix: imports cause a circular reference
+- ad002b9: feat: support redirects
+- ad002b9: feat: support all content types
+
+## 0.2.19
+
+### Patch Changes
+
+- @scalar/oas-utils@0.2.17
+
 ## 0.2.18
 
 ### 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;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"}
+{"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;AAkBzC;;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,uFAqLA"}

package/dist/createMockServer.js

@@ -1,16 +1,18 @@
 import { getExampleFromSchema } from '@scalar/oas-utils/spec-getters';
 import { openapi } from '@scalar/openapi-parser';
 import { Hono } from 'hono';
+import { accepts } from 'hono/accepts';
 import { cors } from 'hono/cors';
+import objectToXML from 'object-to-xml';
+import { anyBasicAuthentication } from './utils/anyBasicAuthentication.js';
+import { anyOpenAuthPasswordGrantAuthentication } from './utils/anyOpenAuthPasswordGrantAuthentication.js';
+import { findPreferredResponseKey } from './utils/findPreferredResponseKey.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 { anyOpenAuthPasswordGrantAuthentication } from './utils/anyOpenAuthPasswordGrantAuthentication.js';
-import { findPreferredResponseKey } from './utils/findPreferredResponseKey.js';
 
 /**
  * Create a mock server instance
@@ -94,15 +96,32 @@ async function createMockServer(options) {
                 // Response
                 // default, 200, 201 …
                 const preferredResponseKey = findPreferredResponseKey(Object.keys(operation.responses ?? {}));
-                // Focus on JSON for now
-                const jsonResponse = preferredResponseKey
-                    ? operation.responses?.[preferredResponseKey]?.content?.['application/json']
+                const preferredResponse = preferredResponseKey
+                    ? operation.responses?.[preferredResponseKey]
                     : null;
-                // Get or generate JSON
-                const response = jsonResponse?.example
-                    ? jsonResponse.example
-                    : jsonResponse?.schema
-                        ? getExampleFromSchema(jsonResponse.schema, {
+                const supportedContentTypes = Object.keys(preferredResponse?.content ?? {});
+                // Headers
+                const headers = preferredResponse?.headers ?? {};
+                Object.keys(headers).forEach((header) => {
+                    c.header(header, headers[header].schema
+                        ? getExampleFromSchema(headers[header].schema)
+                        : null);
+                });
+                // Content-Type
+                const acceptedContentType = accepts(c, {
+                    header: 'Accept',
+                    supports: supportedContentTypes,
+                    default: supportedContentTypes.includes('application/json')
+                        ? 'application/json'
+                        : supportedContentTypes[0],
+                });
+                c.header('Content-Type', acceptedContentType);
+                const acceptedResponse = preferredResponse?.content?.[acceptedContentType];
+                // Body
+                const body = acceptedResponse?.example
+                    ? acceptedResponse.example
+                    : acceptedResponse?.schema
+                        ? getExampleFromSchema(acceptedResponse.schema, {
                             emptyString: '…',
                             variables: c.req.param(),
                         })
@@ -111,7 +130,15 @@ async function createMockServer(options) {
                 const statusCode = parseInt(preferredResponseKey === 'default'
                     ? '200'
                     : preferredResponseKey ?? '200', 10);
-                return c.json(response, statusCode);
+                c.status(statusCode);
+                return c.body(typeof body === 'object'
+                    ? // XML
+                        acceptedContentType?.includes('xml')
+                            ? `<?xml version="1.0" encoding="UTF-8"?>${objectToXML(body)}`
+                            : // JSON
+                                JSON.stringify(body, null, 2)
+                    : // String
+                        body);
             });
         });
     });

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

@@ -1 +1 @@
-{"version":3,"file":"findPreferredResponseKey.d.ts","sourceRoot":"","sources":["../../src/utils/findPreferredResponseKey.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,sBAI5D"}
+{"version":3,"file":"findPreferredResponseKey.d.ts","sourceRoot":"","sources":["../../src/utils/findPreferredResponseKey.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,sBAU5D"}

package/dist/utils/findPreferredResponseKey.js

@@ -2,7 +2,12 @@
  * Find the preferred response key: default, 200, 201 …
  */
 function findPreferredResponseKey(responses) {
-    return ['default', '200', '201', '204', '404', '500'].find((key) => responses?.includes(key) ?? false);
+    return (
+    // Regular status codes
+    ['default', '200', '201', '204', '404', '500'].find((key) => responses?.includes(key) ?? false) ??
+        // Lowest status code
+        responses?.sort()[0] ??
+        undefined);
 }
 
 export { findPreferredResponseKey };

package/package.json

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