@scalar/mock-server 0.14.0 → 0.14.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scalar/mock-server
 
+## 0.14.1
+
+### Patch Changes
+
+- [#10190](https://github.com/scalar/scalar/pull/10190): Update Hono to allow HTTP QUERY requests in default CORS preflight responses.
+- [#10164](https://github.com/scalar/scalar/pull/10164): Serve deprecated response schemas from the mock instead of answering a declared JSON response with an empty body, and generate a deprecated AsyncAPI message payload instead of sending `null`. `getExampleFromSchema` takes a new `includeDeprecated` option for callers that must produce a value satisfying the schema. A declared response header that generates no value is now skipped rather than clearing a header of the same name the mock already set, such as the CORS headers.
+- [#10140](https://github.com/scalar/scalar/pull/10140): Replace redundant type assertions with compiler-checked annotations, typed accumulators, and existing guards across helpers, API conversion, request handling, and schema rendering.
+
+  Narrow DOM elements and caught errors before accessing their properties. Correct header lookup to include missing values and handle them during PowerShell snippet generation.
+
+  Validate release-note provider responses, represent unresolved references and absent groups in helper return types, and require narrowing merged object values. Preserve AsyncAPI broker credentials separately from HTTP authentication schemes.
+
 ## 0.14.0
 
 ### Minor Changes

package/dist/create-mock-server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-mock-server.d.ts","sourceRoot":"","sources":["../src/create-mock-server.ts"],"names":[],"mappings":"AAEA,OAAO,EAAgB,IAAI,EAA0B,MAAM,MAAM,CAAA;AAIjE,OAAO,KAAK,EAAc,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAwD5D;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,aAAa,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CA8NtF"}
+{"version":3,"file":"create-mock-server.d.ts","sourceRoot":"","sources":["../src/create-mock-server.ts"],"names":[],"mappings":"AAEA,OAAO,EAAgB,IAAI,EAA0B,MAAM,MAAM,CAAA;AAIjE,OAAO,KAAK,EAAc,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAwD5D;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,aAAa,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CA2NtF"}

package/dist/routes/mock-any-response.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mock-any-response.d.ts","sourceRoot":"","sources":["../../src/routes/mock-any-response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAIxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAanC;;GAEG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,CAAC,eAAe,YA6HjF"}
+{"version":3,"file":"mock-any-response.d.ts","sourceRoot":"","sources":["../../src/routes/mock-any-response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAIxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAcnC;;GAEG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,CAAC,eAAe,YA4HjF"}

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

@@ -5,6 +5,7 @@ import { accepts } from 'hono/accepts';
 import { streamSSE } from 'hono/streaming';
 import { collectSseEvents, isEventStreamContentType } from '../utils/collect-sse-events.js';
 import { findPreferredResponseKey } from '../utils/find-preferred-response-key.js';
+import { generateResponseExample } from '../utils/generate-response-example.js';
 import { normalizeResponseBody } from '../utils/normalize-response-body.js';
 import { parsePreferHeader } from '../utils/parse-prefer-header.js';
 import { pathParameters } from '../utils/path-parameters.js';
@@ -36,10 +37,15 @@ export function mockAnyResponse(c, operation) {
     const headers = selectedResponse?.headers ?? {};
     Object.keys(headers).forEach((header) => {
         const headerObject = getResolvedRef(headers[header]);
+        // Headers need `includeDeprecated` but none of `generateResponseExample`'s other options — see
+        // the note on that helper for why passing them would change what declared headers emit.
         const value = headerObject?.schema
-            ? getExampleFromSchema(getResolvedRefDeep(headerObject.schema))
+            ? getExampleFromSchema(getResolvedRefDeep(headerObject.schema), { includeDeprecated: true })
             : null;
-        if (value !== null) {
+        // Loose check on purpose: Hono *deletes* a header when handed `undefined`. This loop is the first
+        // thing to set the declared headers, so in practice a delete removes a header set earlier by
+        // middleware — `cors()` sets `Access-Control-Allow-Origin` before the handler runs.
+        if (value != null) {
             c.header(header, value);
         }
     });
@@ -66,13 +72,7 @@ export function mockAnyResponse(c, operation) {
     const acceptedResponse = selectedResponse?.content?.[acceptedContentType];
     const responseSchema = acceptedResponse?.schema ? getResolvedRefDeep(acceptedResponse.schema) : undefined;
     /** Generates the response body from the schema, or returns `undefined` when there is no schema. */
-    const generateFromSchema = () => responseSchema
-        ? getExampleFromSchema(responseSchema, {
-            emptyString: 'string',
-            variables: pathParameters(c),
-            mode: 'read',
-        })
-        : undefined;
+    const generateFromSchema = () => responseSchema ? generateResponseExample(responseSchema, pathParameters(c)) : undefined;
     // Server-Sent Events are a framed, multi-event wire format, so they cannot go out as one buffered
     // body: a client reading the stream expects `data:` lines terminated by a blank line. Everything
     // else (JSON, XML, text) keeps taking the single-body path below.

package/dist/routes/mock-handler-response.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mock-handler-response.d.ts","sourceRoot":"","sources":["../../src/routes/mock-handler-response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAGxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEnC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AAqIxD;;;GAGG;AACH,wBAAsB,mBAAmB,CAAC,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,CAAC,eAAe,gMA8D3F"}
+{"version":3,"file":"mock-handler-response.d.ts","sourceRoot":"","sources":["../../src/routes/mock-handler-response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEnC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AA+HxD;;;GAGG;AACH,wBAAsB,mBAAmB,CAAC,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,CAAC,eAAe,gMAyD3F"}

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

@@ -1,8 +1,8 @@
 import { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref';
-import { getExampleFromSchema } from '@scalar/workspace-store/request-example';
 import { accepts } from 'hono/accepts';
 import { buildHandlerContext } from '../utils/build-handler-context.js';
 import { executeHandler } from '../utils/execute-handler.js';
+import { generateResponseExample } from '../utils/generate-response-example.js';
 import { normalizeResponseBody } from '../utils/normalize-response-body.js';
 import { parsePreferHeader } from '../utils/parse-prefer-header.js';
 import { pathParameters } from '../utils/path-parameters.js';
@@ -47,11 +47,7 @@ function getExampleFromResponse(c, statusCode, responses, exampleName) {
     return selectedExample
         ? normalizeResponseBody(selectedExample.value, responseSchema)
         : responseSchema
-            ? normalizeResponseBody(getExampleFromSchema(responseSchema, {
-                emptyString: 'string',
-                variables: pathParameters(c),
-                mode: 'read',
-            }), responseSchema)
+            ? normalizeResponseBody(generateResponseExample(responseSchema, pathParameters(c)), responseSchema)
             : null;
 }
 /**

package/dist/utils/build-handler-context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"build-handler-context.d.ts","sourceRoot":"","sources":["../../src/utils/build-handler-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAIxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAMnC,OAAO,EAAE,KAAK,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAEjF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,cAAc,CAAC,CAAA;IAC5D,GAAG,EAAE;QACH,IAAI,EAAE,GAAG,CAAA;QACT,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC9B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC7B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAChC,CAAA;IACD,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACzB,CAAA;AAED;;GAEG;AACH,KAAK,oBAAoB,GAAG;IAC1B,OAAO,EAAE,cAAc,CAAA;IACvB,QAAQ,EAAE,sBAAsB,CAAA;CACjC,CAAA;AA4DD;;GAEG;AACH,wBAAsB,mBAAmB,CACvC,CAAC,EAAE,OAAO,EACV,SAAS,CAAC,EAAE,WAAW,CAAC,eAAe,GACtC,OAAO,CAAC,oBAAoB,CAAC,CAgD/B"}
+{"version":3,"file":"build-handler-context.d.ts","sourceRoot":"","sources":["../../src/utils/build-handler-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAGxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAOnC,OAAO,EAAE,KAAK,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAEjF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,cAAc,CAAC,CAAA;IAC5D,GAAG,EAAE;QACH,IAAI,EAAE,GAAG,CAAA;QACT,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC9B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC7B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAChC,CAAA;IACD,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACzB,CAAA;AAED;;GAEG;AACH,KAAK,oBAAoB,GAAG;IAC1B,OAAO,EAAE,cAAc,CAAA;IACvB,QAAQ,EAAE,sBAAsB,CAAA;CACjC,CAAA;AAqDD;;GAEG;AACH,wBAAsB,mBAAmB,CACvC,CAAC,EAAE,OAAO,EACV,SAAS,CAAC,EAAE,WAAW,CAAC,eAAe,GACtC,OAAO,CAAC,oBAAoB,CAAC,CA4C/B"}

package/dist/utils/build-handler-context.js

@@ -1,8 +1,8 @@
 import { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref';
 import { getResolvedRefDeep } from '@scalar/workspace-store/helpers/get-resolved-ref-deep';
-import { getExampleFromSchema } from '@scalar/workspace-store/request-example';
 import { accepts } from 'hono/accepts';
 import { store } from '../libs/store.js';
+import { generateResponseExample } from './generate-response-example.js';
 import { normalizeResponseBody } from './normalize-response-body.js';
 import { pathParameters } from './path-parameters.js';
 import { createStoreWrapper } from './store-wrapper.js';
@@ -40,11 +40,7 @@ function getExampleFromResponse(c, statusCode, responses) {
     return acceptedResponse.example !== undefined
         ? normalizeResponseBody(acceptedResponse.example, responseSchema)
         : responseSchema
-            ? normalizeResponseBody(getExampleFromSchema(responseSchema, {
-                emptyString: 'string',
-                variables: pathParameters(c),
-                mode: 'read',
-            }), responseSchema)
+            ? normalizeResponseBody(generateResponseExample(responseSchema, pathParameters(c)), responseSchema)
             : null;
 }
 /**

package/dist/utils/deserialize-parameter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deserialize-parameter.d.ts","sourceRoot":"","sources":["../../src/utils/deserialize-parameter.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,oFAAoF;AACpF,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAUtE;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAC/B,UAAU,iBAAiB,EAC3B,QAAQ,MAAM,EACd,UAAU,OAAO,KAChB;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAGnC,CAAA;AA2BD,8GAA8G;AAC9G,eAAO,MAAM,aAAa,GAAI,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,KAAG,OAU3E,CAAA;AAED,gHAAgH;AAChH,eAAO,MAAM,cAAc,GAAI,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,KAAG,OAU5E,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,GAAI,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,KAAG,MAAM,EA4B1F,CAAA;AAgGD;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,GAAI,oCAKvC;IACD,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,OAAO,CAAA;IAChB,iGAAiG;IACjG,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,uFAAuF;IACvF,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;CAC7B,KAAG,MAAM,EAAE,GAAG,SAoBd,CAAA;AAgCD;;;;;;;;GAQG;AACH,eAAO,MAAM,0BAA0B,GAAI,qEAQxC;IACD,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,OAAO,CAAA;IAChB,+FAA+F;IAC/F,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,SAAS,CAAA;IACnD,IAAI,EAAE,MAAM,CAAA;IACZ,mGAAmG;IACnG,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IACpC;;;;OAIG;IACH,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;CACvC,KAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,SAoEvC,CAAA"}
+{"version":3,"file":"deserialize-parameter.d.ts","sourceRoot":"","sources":["../../src/utils/deserialize-parameter.ts"],"names":[],"mappings":"AACA;;;;;GAKG;AAEH,oFAAoF;AACpF,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAUtE;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAC/B,UAAU,iBAAiB,EAC3B,QAAQ,MAAM,EACd,UAAU,OAAO,KAChB;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAGnC,CAAA;AA2BD,8GAA8G;AAC9G,eAAO,MAAM,aAAa,GAAI,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,KAAG,OAU3E,CAAA;AAED,gHAAgH;AAChH,eAAO,MAAM,cAAc,GAAI,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,KAAG,OAU5E,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,GAAI,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,KAAG,MAAM,EA4B1F,CAAA;AAgGD;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,GAAI,oCAKvC;IACD,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,OAAO,CAAA;IAChB,iGAAiG;IACjG,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,uFAAuF;IACvF,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;CAC7B,KAAG,MAAM,EAAE,GAAG,SAoBd,CAAA;AAgCD;;;;;;;;GAQG;AACH,eAAO,MAAM,0BAA0B,GAAI,qEAQxC;IACD,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,OAAO,CAAA;IAChB,+FAA+F;IAC/F,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,SAAS,CAAA;IACnD,IAAI,EAAE,MAAM,CAAA;IACZ,mGAAmG;IACnG,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IACpC;;;;OAIG;IACH,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;CACvC,KAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,SAoEvC,CAAA"}

package/dist/utils/deserialize-parameter.js

@@ -1,9 +1,4 @@
-/**
- * Helpers for turning string-encoded request parameters back into the structured values that JSON
- * Schema validation expects, following the OpenAPI `style`/`explode` serialization rules.
- *
- * @see https://spec.openapis.org/oas/v3.1.1.html#style-values
- */
+import { isObjectLike } from '@scalar/helpers/object/is-object';
 /** Default serialization style per parameter location. */
 const DEFAULT_STYLE = {
     query: 'form',
@@ -34,7 +29,7 @@ const matchesComposedSchema = (schema, predicate) => {
         const subSchemas = schema[keyword];
         if (Array.isArray(subSchemas)) {
             for (const subSchema of subSchemas) {
-                if (subSchema && typeof subSchema === 'object' && predicate(subSchema)) {
+                if (isObjectLike(subSchema) && predicate(subSchema)) {
                     return true;
                 }
             }
@@ -87,7 +82,7 @@ export const getObjectPropertyNames = (schema) => {
         const subSchemas = schema[keyword];
         if (Array.isArray(subSchemas)) {
             for (const subSchema of subSchemas) {
-                if (subSchema && typeof subSchema === 'object') {
+                if (isObjectLike(subSchema)) {
                     for (const name of getObjectPropertyNames(subSchema)) {
                         names.add(name);
                     }

package/dist/utils/generate-message.d.ts

@@ -2,7 +2,7 @@ import type { MockMessage, ResolvedChannel } from '../transports/types.js';
 /**
  * Generate an encoded mock frame for a channel message — the AsyncAPI analogue of the REST
  * mocker's response generation. Prefers a defined example, otherwise generates a value from the
- * message payload schema with the same `getExampleFromSchema` the HTTP mocker uses.
+ * message payload schema through the same `generateResponseExample` the HTTP mocker uses.
  *
  * @param channel - The resolved channel to mock a message for.
  * @param messageId - Which message to emit; defaults to the channel's first message.

package/dist/utils/generate-message.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generate-message.d.ts","sourceRoot":"","sources":["../../src/utils/generate-message.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAmB,MAAM,oBAAoB,CAAA;AAWvF;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,eAAe,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,CAwBhG"}
+{"version":3,"file":"generate-message.d.ts","sourceRoot":"","sources":["../../src/utils/generate-message.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAmB,MAAM,oBAAoB,CAAA;AAYvF;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,eAAe,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,CAuBhG"}

package/dist/utils/generate-message.js

@@ -1,5 +1,5 @@
 import { getResolvedRefDeep } from '@scalar/workspace-store/helpers/get-resolved-ref-deep';
-import { getExampleFromSchema } from '@scalar/workspace-store/request-example';
+import { generateResponseExample } from '../utils/generate-response-example.js';
 /** Encode a generated value to a wire string. Strings pass through; everything else is JSON. */
 function encode(value) {
     if (typeof value === 'string') {
@@ -10,7 +10,7 @@ function encode(value) {
 /**
  * Generate an encoded mock frame for a channel message — the AsyncAPI analogue of the REST
  * mocker's response generation. Prefers a defined example, otherwise generates a value from the
- * message payload schema with the same `getExampleFromSchema` the HTTP mocker uses.
+ * message payload schema through the same `generateResponseExample` the HTTP mocker uses.
  *
  * @param channel - The resolved channel to mock a message for.
  * @param messageId - Which message to emit; defaults to the channel's first message.
@@ -29,10 +29,9 @@ export function generateMessage(channel, messageId) {
         value = message.examples[0];
     }
     else if (message.payload) {
-        value = getExampleFromSchema(getResolvedRefDeep(message.payload), {
-            emptyString: 'string',
-            mode: 'read',
-        });
+        // No `variables`: `generateMessage` is never handed the Hono context, so a channel route's path
+        // parameters are not in scope for `x-variable` substitution. It does run per request.
+        value = generateResponseExample(getResolvedRefDeep(message.payload));
     }
     return {
         data: encode(value),

package/dist/utils/generate-response-example.d.ts

@@ -0,0 +1,25 @@
+import { getExampleFromSchema } from '@scalar/workspace-store/request-example';
+/** The schema shape `getExampleFromSchema` accepts, so callers do not have to name it themselves. */
+export type ExampleSchema = Parameters<typeof getExampleFromSchema>[0];
+/**
+ * Generate a mocked response value from a schema the mock has declared.
+ *
+ * Every value the mock puts on the wire — an HTTP body, an SSE frame, a channel message — has to
+ * satisfy the schema it was declared with, which is why this passes `includeDeprecated: true`:
+ * `deprecated` marks a field as discouraged, not absent, so omitting it answered a declared JSON
+ * response with zero bytes and dropped required properties. Owning the option set in one place keeps
+ * a newly added response path from quietly missing that.
+ *
+ * Not for response headers. Two of the options here would change what an already-declared header
+ * emits: `emptyString` yields the literal `string` for a bare `type: 'string'` and switches on
+ * format-based generation (a `format: 'date-time'` header would emit a fabricated timestamp), and
+ * `mode: 'read'` drops a `writeOnly` header entirely. Headers set `includeDeprecated` on their own
+ * call instead.
+ *
+ * @param schema - The resolved schema to generate a value for.
+ * @param variables - Values for `x-variable` substitution, usually a request's path parameters.
+ *   Omitted by callers that have no request in scope, such as channel messages.
+ * @returns The generated value, or `undefined` when the schema yields nothing.
+ */
+export declare const generateResponseExample: (schema: ExampleSchema, variables?: Record<string, unknown>) => unknown;
+//# sourceMappingURL=generate-response-example.d.ts.map

package/dist/utils/generate-response-example.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-response-example.d.ts","sourceRoot":"","sources":["../../src/utils/generate-response-example.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAA;AAE9E,qGAAqG;AACrG,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAA;AAEtE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,uBAAuB,GAAI,QAAQ,aAAa,EAAE,YAAY,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAG,OAMjG,CAAA"}

package/dist/utils/generate-response-example.js

@@ -0,0 +1,27 @@
+import { getExampleFromSchema } from '@scalar/workspace-store/request-example';
+/**
+ * Generate a mocked response value from a schema the mock has declared.
+ *
+ * Every value the mock puts on the wire — an HTTP body, an SSE frame, a channel message — has to
+ * satisfy the schema it was declared with, which is why this passes `includeDeprecated: true`:
+ * `deprecated` marks a field as discouraged, not absent, so omitting it answered a declared JSON
+ * response with zero bytes and dropped required properties. Owning the option set in one place keeps
+ * a newly added response path from quietly missing that.
+ *
+ * Not for response headers. Two of the options here would change what an already-declared header
+ * emits: `emptyString` yields the literal `string` for a bare `type: 'string'` and switches on
+ * format-based generation (a `format: 'date-time'` header would emit a fabricated timestamp), and
+ * `mode: 'read'` drops a `writeOnly` header entirely. Headers set `includeDeprecated` on their own
+ * call instead.
+ *
+ * @param schema - The resolved schema to generate a value for.
+ * @param variables - Values for `x-variable` substitution, usually a request's path parameters.
+ *   Omitted by callers that have no request in scope, such as channel messages.
+ * @returns The generated value, or `undefined` when the schema yields nothing.
+ */
+export const generateResponseExample = (schema, variables) => getExampleFromSchema(schema, {
+    emptyString: 'string',
+    variables,
+    mode: 'read',
+    includeDeprecated: true,
+});

package/package.json

@@ -16,7 +16,7 @@
     "swagger",
     "cli"
   ],
-  "version": "0.14.0",
+  "version": "0.14.1",
   "engines": {
     "node": ">=22"
   },
@@ -55,15 +55,15 @@
     "@hono/node-ws": "^1.2.0",
     "ajv": "^8.20.0",
     "ajv-formats": "^3.0.1",
-    "hono": "^4.12.7",
+    "hono": "^4.13.7",
     "quickjs-emscripten": "0.32.0",
     "yaml": "^2.9.0",
-    "@scalar/helpers": "0.11.3",
-    "@scalar/json-magic": "0.13.4",
-    "@scalar/openapi-types": "0.9.5",
-    "@scalar/openapi-upgrader": "0.2.15",
-    "@scalar/types": "0.19.0",
-    "@scalar/workspace-store": "0.60.0"
+    "@scalar/helpers": "0.12.0",
+    "@scalar/json-magic": "0.13.5",
+    "@scalar/openapi-types": "0.9.6",
+    "@scalar/openapi-upgrader": "0.2.16",
+    "@scalar/workspace-store": "0.61.0",
+    "@scalar/types": "0.20.0"
   },
   "devDependencies": {
     "@types/node": "^24.1.0",