@scalar/mock-server 0.9.9 → 0.9.11

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @scalar/mock-server
 
+## 0.9.11
+
+## 0.9.10
+
+### Patch Changes
+
+- [#8466](https://github.com/scalar/scalar/pull/8466): chore: new build pipeline
+
 ## 0.9.9
 
 ### Patch Changes

package/dist/create-mock-server.js

@@ -1,72 +1,83 @@
-import { Hono } from "hono";
-import { cors } from "hono/cors";
-import { buildSeedContext } from "./utils/build-seed-context.js";
-import { executeSeed } from "./utils/execute-seed.js";
-import { getOperations } from "./utils/get-operation.js";
-import { handleAuthentication } from "./utils/handle-authentication.js";
-import { honoRouteFromPath } from "./utils/hono-route-from-path.js";
-import { isAuthenticationRequired } from "./utils/is-authentication-required.js";
-import { logAuthenticationInstructions } from "./utils/log-authentication-instructions.js";
-import { processOpenApiDocument } from "./utils/process-openapi-document.js";
-import { setUpAuthenticationRoutes } from "./utils/set-up-authentication-routes.js";
-import { store } from "./libs/store.js";
-import { mockAnyResponse } from "./routes/mock-any-response.js";
-import { mockHandlerResponse } from "./routes/mock-handler-response.js";
-import { respondWithOpenApiDocument } from "./routes/respond-with-openapi-document.js";
-async function createMockServer(configuration) {
-  const app = new Hono();
-  const schema = await processOpenApiDocument(configuration?.document ?? configuration?.specification);
-  const schemas = schema?.components?.schemas;
-  if (schemas) {
-    for (const [schemaName, schemaObject] of Object.entries(schemas)) {
-      const seedCode = schemaObject?.["x-seed"];
-      if (seedCode && typeof seedCode === "string") {
-        try {
-          const existingItems = store.list(schemaName);
-          if (existingItems.length === 0) {
-            const seedContext = buildSeedContext(schemaName);
-            await executeSeed(seedCode, seedContext);
-          }
-        } catch (error) {
-          console.error(`Error seeding schema "${schemaName}":`, error);
+import { Hono } from 'hono';
+import { cors } from 'hono/cors';
+import { buildSeedContext } from './utils/build-seed-context.js';
+import { executeSeed } from './utils/execute-seed.js';
+import { getOperations } from './utils/get-operation.js';
+import { handleAuthentication } from './utils/handle-authentication.js';
+import { honoRouteFromPath } from './utils/hono-route-from-path.js';
+import { isAuthenticationRequired } from './utils/is-authentication-required.js';
+import { logAuthenticationInstructions } from './utils/log-authentication-instructions.js';
+import { processOpenApiDocument } from './utils/process-openapi-document.js';
+import { setUpAuthenticationRoutes } from './utils/set-up-authentication-routes.js';
+import { store } from './libs/store.js';
+import { mockAnyResponse } from './routes/mock-any-response.js';
+import { mockHandlerResponse } from './routes/mock-handler-response.js';
+import { respondWithOpenApiDocument } from './routes/respond-with-openapi-document.js';
+/**
+ * Create a mock server instance
+ */
+export async function createMockServer(configuration) {
+    const app = new Hono();
+    /** Dereferenced OpenAPI document */
+    const schema = await processOpenApiDocument(configuration?.document ?? configuration?.specification);
+    // Seed data from schemas with x-seed extension
+    // This happens before routes are set up so data is available immediately
+    const schemas = schema?.components?.schemas;
+    if (schemas) {
+        for (const [schemaName, schemaObject] of Object.entries(schemas)) {
+            const seedCode = schemaObject?.['x-seed'];
+            if (seedCode && typeof seedCode === 'string') {
+                try {
+                    // Check if collection is empty (idempotent seeding)
+                    // Use the schema key directly as the collection name
+                    const existingItems = store.list(schemaName);
+                    if (existingItems.length === 0) {
+                        // Build seed context with schema key (used as collection name)
+                        const seedContext = buildSeedContext(schemaName);
+                        // Execute seed code
+                        await executeSeed(seedCode, seedContext);
+                    }
+                }
+                catch (error) {
+                    // Log error but don't fail server startup
+                    console.error(`Error seeding schema "${schemaName}":`, error);
+                }
+            }
         }
-      }
     }
-  }
-  app.use(cors());
-  setUpAuthenticationRoutes(app, schema);
-  logAuthenticationInstructions(
-    schema?.components?.securitySchemes || {}
-  );
-  const paths = schema?.paths ?? {};
-  Object.keys(paths).forEach((path) => {
-    const methods = Object.keys(getOperations(paths[path]));
-    methods.forEach((method) => {
-      const route = honoRouteFromPath(path);
-      const operation = schema?.paths?.[path]?.[method];
-      if (isAuthenticationRequired(operation.security)) {
-        app[method](route, handleAuthentication(schema, operation));
-      }
-      const handlerCode = operation?.["x-handler"];
-      const hasHandler = handlerCode && typeof handlerCode === "string" && handlerCode.trim().length > 0;
-      if (hasHandler) {
-        app[method](route, (c) => mockHandlerResponse(c, operation, configuration));
-      } else {
-        app[method](route, (c) => mockAnyResponse(c, operation, configuration));
-      }
+    // CORS headers
+    app.use(cors());
+    /** Authentication methods defined in the OpenAPI document */
+    setUpAuthenticationRoutes(app, schema);
+    logAuthenticationInstructions(schema?.components?.securitySchemes || {});
+    /** 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 for this operation
+            if (isAuthenticationRequired(operation.security)) {
+                app[method](route, handleAuthentication(schema, operation));
+            }
+            // Check if operation has x-handler extension
+            // Validate that it's a non-empty string (consistent with x-seed validation)
+            const handlerCode = operation?.['x-handler'];
+            const hasHandler = handlerCode && typeof handlerCode === 'string' && handlerCode.trim().length > 0;
+            // Route to appropriate handler
+            if (hasHandler) {
+                app[method](route, (c) => mockHandlerResponse(c, operation, configuration));
+            }
+            else {
+                app[method](route, (c) => mockAnyResponse(c, operation, configuration));
+            }
+        });
     });
-  });
-  app.get(
-    "/openapi.json",
-    (c) => respondWithOpenApiDocument(c, configuration?.document ?? configuration?.specification, "json")
-  );
-  app.get(
-    "/openapi.yaml",
-    (c) => respondWithOpenApiDocument(c, configuration?.document ?? configuration?.specification, "yaml")
-  );
-  return app;
+    // OpenAPI JSON file
+    app.get('/openapi.json', (c) => respondWithOpenApiDocument(c, configuration?.document ?? configuration?.specification, 'json'));
+    // OpenAPI YAML file
+    app.get('/openapi.yaml', (c) => respondWithOpenApiDocument(c, configuration?.document ?? configuration?.specification, 'yaml'));
+    return app;
 }
-export {
-  createMockServer
-};
-//# sourceMappingURL=create-mock-server.js.map

package/dist/index.js

@@ -1,5 +1 @@
-import { createMockServer } from "./create-mock-server.js";
-export {
-  createMockServer
-};
-//# sourceMappingURL=index.js.map
+export { createMockServer } from './create-mock-server.js';

package/dist/libs/store.js

@@ -1,70 +1,71 @@
-class Store {
-  data = {};
-  /**
-   * Get all items in a collection.
-   */
-  list(collection) {
-    const items = this.data[collection];
-    return items ? Object.values(items) : [];
-  }
-  /**
-   * Get a single item by ID.
-   */
-  get(collection, id) {
-    return this.data[collection]?.[id];
-  }
-  /**
-   * Create a new item in a collection.
-   * Auto-generates an ID if not provided.
-   */
-  create(collection, data) {
-    if (!this.data[collection]) {
-      this.data[collection] = {};
+export class Store {
+    data = {};
+    /**
+     * Get all items in a collection.
+     */
+    list(collection) {
+        const items = this.data[collection];
+        return items ? Object.values(items) : [];
     }
-    const safeData = data ?? {};
-    const id = safeData.id ?? crypto.randomUUID();
-    const item = { ...safeData, id };
-    this.data[collection][id] = item;
-    return item;
-  }
-  /**
-   * Update an existing item in a collection.
-   * Returns null if the item is not found.
-   */
-  update(collection, id, data) {
-    if (!this.data[collection]?.[id]) {
-      return null;
+    /**
+     * Get a single item by ID.
+     */
+    get(collection, id) {
+        return this.data[collection]?.[id];
     }
-    const safeData = data ?? {};
-    const updated = { ...this.data[collection][id], ...safeData, id };
-    this.data[collection][id] = updated;
-    return updated;
-  }
-  /**
-   * Delete an item from a collection.
-   * Returns null if the item is not found.
-   */
-  delete(collection, id) {
-    if (!this.data[collection]?.[id]) {
-      return null;
+    /**
+     * Create a new item in a collection.
+     * Auto-generates an ID if not provided.
+     */
+    create(collection, data) {
+        if (!this.data[collection]) {
+            this.data[collection] = {};
+        }
+        // Handle null/undefined data by defaulting to empty object
+        const safeData = data ?? {};
+        const id = safeData.id ?? crypto.randomUUID();
+        const item = { ...safeData, id };
+        this.data[collection][id] = item;
+        return item;
     }
-    delete this.data[collection][id];
-    return true;
-  }
-  /**
-   * Clear a specific collection or all collections.
-   */
-  clear(collection) {
-    if (collection) {
-      delete this.data[collection];
-    } else {
-      this.data = {};
+    /**
+     * Update an existing item in a collection.
+     * Returns null if the item is not found.
+     */
+    update(collection, id, data) {
+        if (!this.data[collection]?.[id]) {
+            return null;
+        }
+        // Handle null/undefined data by defaulting to empty object
+        const safeData = data ?? {};
+        const updated = { ...this.data[collection][id], ...safeData, id };
+        this.data[collection][id] = updated;
+        return updated;
+    }
+    /**
+     * Delete an item from a collection.
+     * Returns null if the item is not found.
+     */
+    delete(collection, id) {
+        if (!this.data[collection]?.[id]) {
+            return null;
+        }
+        delete this.data[collection][id];
+        return true;
+    }
+    /**
+     * Clear a specific collection or all collections.
+     */
+    clear(collection) {
+        if (collection) {
+            delete this.data[collection];
+        }
+        else {
+            this.data = {};
+        }
     }
-  }
 }
-const store = new Store();
-export {
-  Store,
-  store
-};
-//# sourceMappingURL=store.js.map
+/**
+ * Singleton store instance shared across all requests.
+ */
+export const store = new Store();

package/dist/routes/mock-any-response.js

@@ -1,67 +1,74 @@
-import { json2xml } from "@scalar/helpers/file/json2xml";
-import { getExampleFromSchema } from "@scalar/oas-utils/spec-getters";
-import { accepts } from "hono/accepts";
-import { findPreferredResponseKey } from "../utils/find-preferred-response-key.js";
-function mockAnyResponse(c, operation, options) {
-  if (options?.onRequest) {
-    options.onRequest({
-      context: c,
-      operation
+import { json2xml } from '@scalar/helpers/file/json2xml';
+import { getExampleFromSchema } from '@scalar/oas-utils/spec-getters';
+import { accepts } from 'hono/accepts';
+import { findPreferredResponseKey } from '../utils/find-preferred-response-key.js';
+/**
+ * Mock any response
+ */
+export function mockAnyResponse(c, operation, options) {
+    // Call onRequest callback
+    if (options?.onRequest) {
+        options.onRequest({
+            context: c,
+            operation,
+        });
+    }
+    // Response
+    // default, 200, 201 …
+    const preferredResponseKey = findPreferredResponseKey(Object.keys(operation.responses ?? {}));
+    const preferredResponse = preferredResponseKey ? operation.responses?.[preferredResponseKey] : null;
+    if (!preferredResponse) {
+        c.status(500);
+        return c.json({ error: 'No response defined for this operation.' });
+    }
+    // Status code
+    const statusCode = Number.parseInt(preferredResponseKey === 'default' ? '200' : (preferredResponseKey ?? '200'), 10);
+    // Headers
+    const headers = preferredResponse?.headers ?? {};
+    Object.keys(headers).forEach((header) => {
+        const value = headers[header].schema ? getExampleFromSchema(headers[header].schema) : null;
+        if (value !== null) {
+            c.header(header, value);
+        }
     });
-  }
-  const preferredResponseKey = findPreferredResponseKey(Object.keys(operation.responses ?? {}));
-  const preferredResponse = preferredResponseKey ? operation.responses?.[preferredResponseKey] : null;
-  if (!preferredResponse) {
-    c.status(500);
-    return c.json({ error: "No response defined for this operation." });
-  }
-  const statusCode = Number.parseInt(
-    preferredResponseKey === "default" ? "200" : preferredResponseKey ?? "200",
-    10
-  );
-  const headers = preferredResponse?.headers ?? {};
-  Object.keys(headers).forEach((header) => {
-    const value = headers[header].schema ? getExampleFromSchema(headers[header].schema) : null;
-    if (value !== null) {
-      c.header(header, value);
+    // For 204 No Content responses, we should not set Content-Type and should return null body
+    if (statusCode === 204) {
+        c.status(statusCode);
+        return c.body(null);
     }
-  });
-  if (statusCode === 204) {
-    c.status(statusCode);
-    return c.body(null);
-  }
-  const supportedContentTypes = Object.keys(preferredResponse?.content ?? {});
-  if (supportedContentTypes.length === 0) {
+    const supportedContentTypes = Object.keys(preferredResponse?.content ?? {});
+    // If no content types are defined, return the status with no body
+    if (supportedContentTypes.length === 0) {
+        c.status(statusCode);
+        return c.body(null);
+    }
+    // Content-Type
+    const acceptedContentType = accepts(c, {
+        header: 'Accept',
+        supports: supportedContentTypes,
+        default: supportedContentTypes.includes('application/json')
+            ? 'application/json'
+            : (supportedContentTypes[0] ?? 'text/plain;charset=UTF-8'),
+    });
+    c.header('Content-Type', acceptedContentType);
+    const acceptedResponse = preferredResponse?.content?.[acceptedContentType];
+    // Body
+    const body = acceptedResponse?.example
+        ? acceptedResponse.example
+        : acceptedResponse?.schema
+            ? getExampleFromSchema(acceptedResponse.schema, {
+                emptyString: 'string',
+                variables: c.req.param(),
+                mode: 'read',
+            })
+            : null;
     c.status(statusCode);
-    return c.body(null);
-  }
-  const acceptedContentType = accepts(c, {
-    header: "Accept",
-    supports: supportedContentTypes,
-    default: supportedContentTypes.includes("application/json") ? "application/json" : supportedContentTypes[0] ?? "text/plain;charset=UTF-8"
-  });
-  c.header("Content-Type", acceptedContentType);
-  const acceptedResponse = preferredResponse?.content?.[acceptedContentType];
-  const body = acceptedResponse?.example ? acceptedResponse.example : acceptedResponse?.schema ? getExampleFromSchema(acceptedResponse.schema, {
-    emptyString: "string",
-    variables: c.req.param(),
-    mode: "read"
-  }) : null;
-  c.status(statusCode);
-  return c.body(
-    typeof body === "object" ? (
-      // XML
-      acceptedContentType?.includes("xml") ? json2xml(body) : (
-        // JSON
-        JSON.stringify(body, null, 2)
-      )
-    ) : (
-      // String
-      body
-    )
-  );
+    return c.body(typeof body === 'object'
+        ? // XML
+            acceptedContentType?.includes('xml')
+                ? json2xml(body)
+                : // JSON
+                    JSON.stringify(body, null, 2)
+        : // String
+            body);
 }
-export {
-  mockAnyResponse
-};
-//# sourceMappingURL=mock-any-response.js.map