@scalar/workspace-store 0.65.0 → 0.67.0

package/dist/request-example/builder/helpers/get-example-from-schema.js

@@ -3,6 +3,7 @@ import { escapeJsonPointer } from '@scalar/helpers/json/escape-json-pointer';
 import { isDynamicRef, pushDynamicScope, resolveDynamicRef } from '../../../helpers/dynamic-ref.js';
 import { unpackProxyObject } from '../../../helpers/unpack-proxy.js';
 import { resolve } from '../../../resolve.js';
+import { EXAMPLE_EVALUATION } from './example-evaluation.js';
 /** Maximum recursion depth to prevent infinite loops in circular references */
 const MAX_LEVELS_DEEP = 10;
 /** Default name used for additional properties when no custom name is provided */
@@ -317,6 +318,25 @@ const consumeCompositionSelection = (options, schemaPath, composition) => {
     const { [key]: _selection, ...compositionSelection } = options.compositionSelection;
     return { ...options, compositionSelection };
 };
+/** Select a composition branch once for both generated values and supplied example metadata. */
+export const selectExampleComposition = (schema, schemaPath, options, arrayItem = false, value) => {
+    const keyword = schema.oneOf ? 'oneOf' : schema.anyOf ? 'anyOf' : undefined;
+    const members = keyword ? schema[keyword] : undefined;
+    if (!keyword || !members?.length) {
+        return undefined;
+    }
+    const index = getCompositionSelectionIndex(schemaPath, keyword, options, members.length) ??
+        getDiscriminatorSelectionIndex(schema, members, options, value);
+    const isObject = 'properties' in schema || ('type' in schema && schema.type === 'object');
+    const candidate = index !== undefined || isObject || arrayItem
+        ? members[index ?? 0]
+        : members.find((item) => {
+            const resolved = resolve.schema(item);
+            return resolved && (!('type' in resolved) || resolved.type !== 'null');
+        });
+    // The generator resolves the value at its entry point; serializers also need the reference site.
+    return candidate;
+};
 /**
  * Use the discriminator as a generation hint. Only referenced variants have
  * implicit names; inline titles are display labels, not discriminator mappings.
@@ -393,7 +413,7 @@ const handleObjectSchema = (schema, options, level, seen, cacheKey, schemaPath,
     const response = {};
     // Children are evaluated with this schema added to the dynamic scope so nested `$dynamicRef`s bind here.
     const childScope = pushDynamicScope(dynamicScope, schema);
-    const skipCache = dynamicScope.length > 0;
+    const skipCache = dynamicScope.length > 0 || !!options?.[EXAMPLE_EVALUATION];
     if ('properties' in schema && schema.properties) {
         const properties = schema.properties;
         const propertyNames = sortPropertyNamesByXOrder(properties);
@@ -469,10 +489,7 @@ const handleObjectSchema = (schema, options, level, seen, cacheKey, schemaPath,
     const compositionKeyword = schema.oneOf ? 'oneOf' : schema.anyOf ? 'anyOf' : undefined;
     const oneOfAnyOf = compositionKeyword ? schema[compositionKeyword] : undefined;
     if (compositionKeyword && oneOfAnyOf?.length) {
-        const index = getCompositionSelectionIndex(schemaPath, compositionKeyword, options, oneOfAnyOf.length) ??
-            getDiscriminatorSelectionIndex(schema, oneOfAnyOf, options, response) ??
-            0;
-        const chosen = resolve.schema(oneOfAnyOf[index]);
+        const chosen = selectExampleComposition(schema, schemaPath, options, false, response);
         if (chosen) {
             Object.assign(response, getExampleFromSchema(chosen, consumeCompositionSelection(options, schemaPath, compositionKeyword), {
                 level: level + 1,
@@ -516,7 +533,16 @@ const handleObjectSchema = (schema, options, level, seen, cacheKey, schemaPath,
 /** Build an example for an array schema, including items, allOf, oneOf/anyOf, and XML wrapping */
 const handleArraySchema = (schema, options, level, seen, cacheKey, schemaPath, dynamicScope) => {
     const childScope = pushDynamicScope(dynamicScope, schema);
-    const skipCache = dynamicScope.length > 0;
+    const skipCache = dynamicScope.length > 0 || !!options?.[EXAMPLE_EVALUATION];
+    if ('prefixItems' in schema && Array.isArray(schema.prefixItems)) {
+        const values = schema.prefixItems.map((item, index) => getExampleFromSchema(item, options, {
+            level: level + 1,
+            schemaPath: [...schemaPath, 'prefixItems', String(index)],
+            seen,
+            dynamicScope: childScope,
+        }));
+        return cache(schema, values, cacheKey, skipCache);
+    }
     let items = 'items' in schema ? resolve.schema(schema.items) : undefined;
     // Bind a dynamic item type (e.g. the generic `PaginatedResponse<T>` pattern) before inspecting it.
     // Crossing a `$dynamicRef` leaves the static schema graph, so the cycle guard built up by the outer
@@ -856,7 +882,7 @@ const getMaxDepthValue = (schema, options, schemaPath, seen = new Set()) => {
  * @param name - The name of the property being processed.
  * @returns An example value for the given schema.
  */
-export const getExampleFromSchema = (schema, options, { level = 0, parentSchema, name, seen = new WeakSet(), schemaPath = [], dynamicScope = [], } = {}) => {
+const generateExampleFromSchema = (schema, options, { level = 0, parentSchema, name, seen = new WeakSet(), schemaPath = [], dynamicScope = [], } = {}) => {
     // A truncation only taints the call it happened in, so every top-level call starts clean.
     if (level === 0) {
         truncated = false;
@@ -888,7 +914,7 @@ export const getExampleFromSchema = (schema, options, { level = 0, parentSchema,
     // Grow the scope with this schema so nested references can bind to its `$dynamicAnchor`s.
     const childScope = pushDynamicScope(dynamicScope, _schema);
     // The same shared node can resolve differently per scope, so skip the result cache under a scope.
-    const skipCache = dynamicScope.length > 0;
+    const skipCache = dynamicScope.length > 0 || !!options?.[EXAMPLE_EVALUATION];
     // Unpack from all proxies to get the raw schema object for cycle detection
     const targetValue = getSchemaCacheTarget(_schema);
     if (seen.has(targetValue)) {
@@ -994,7 +1020,7 @@ export const getExampleFromSchema = (schema, options, { level = 0, parentSchema,
         return result;
     }
     // Handle array types
-    if (('type' in _schema && _schema.type === 'array') || 'items' in _schema) {
+    if (('type' in _schema && _schema.type === 'array') || 'items' in _schema || 'prefixItems' in _schema) {
         const result = handleArraySchema(_schema, options, level, seen, cacheKey, schemaPath, dynamicScope);
         seen.delete(targetValue);
         return result;
@@ -1009,14 +1035,7 @@ export const getExampleFromSchema = (schema, options, { level = 0, parentSchema,
     const compositionKeyword = _schema.oneOf ? 'oneOf' : _schema.anyOf ? 'anyOf' : undefined;
     const discriminate = compositionKeyword ? _schema[compositionKeyword] : undefined;
     if (compositionKeyword && Array.isArray(discriminate) && discriminate.length > 0) {
-        const index = getCompositionSelectionIndex(schemaPath, compositionKeyword, options, discriminate.length) ??
-            getDiscriminatorSelectionIndex(_schema, discriminate, options);
-        const candidate = index !== undefined
-            ? discriminate[index]
-            : discriminate.find((item) => {
-                const resolved = resolve.schema(item);
-                return resolved && (!('type' in resolved) || resolved.type !== 'null');
-            });
+        const candidate = selectExampleComposition(_schema, schemaPath, options);
         if (candidate) {
             const resolved = resolve.schema(candidate);
             if (resolved) {
@@ -1073,3 +1092,33 @@ export const getExampleFromSchema = (schema, options, { level = 0, parentSchema,
     seen.delete(targetValue);
     return cache(_schema, null, cacheKey, skipCache);
 };
+/** Generate data, optionally retaining the exact schema decisions for another output format. */
+export const getExampleFromSchema = (schema, options, context = {}) => {
+    const capture = options?.[EXAMPLE_EVALUATION];
+    if (!capture) {
+        return generateExampleFromSchema(schema, options, context);
+    }
+    const node = {
+        schema,
+        value: undefined,
+        path: context.schemaPath ?? [],
+        name: context.name,
+        dynamicScope: context.dynamicScope ?? [],
+        children: [],
+    };
+    const parent = capture.stack.at(-1);
+    if (parent) {
+        parent.children.push(node);
+    }
+    else {
+        capture.root = node;
+    }
+    capture.stack.push(node);
+    try {
+        node.value = generateExampleFromSchema(schema, options, context);
+        return node.value;
+    }
+    finally {
+        capture.stack.pop();
+    }
+};

package/dist/request-example/builder/request-factory.d.ts

@@ -2,6 +2,7 @@ import type { XScalarEnvironment } from '@scalar/workspace-store/schemas/extensi
 import type { XScalarCookie } from '@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies';
 import type { ServerObject } from '@scalar/workspace-store/schemas/v3.2/strict/openapi-document';
 import type { OperationObject } from '@scalar/workspace-store/schemas/v3.2/strict/operation';
+import { type QuerystringParameter } from '../../helpers/querystring-parameter.js';
 import { type BuildRequestSecurityResult } from '../../request-example/builder/security/build-request-security.js';
 import type { SecuritySchemeObjectSecret } from '../../request-example/builder/security/secret-types.js';
 import type { RequestExampleMeta } from '../../request-example/types.js';
@@ -91,6 +92,8 @@ export type RequestFactory = {
          * @example { "userId": "{env.USER_ID}" }
          */
         variables: Record<string, string>;
+        /** Names whose example is already URI-encoded. */
+        serializedParameters?: Set<string>;
         /**
          * The raw request path string, as entered by the user or read from the OpenAPI schema.
          * Placeholders are not yet substituted.
@@ -119,6 +122,10 @@ export type RequestFactory = {
      * The actual query string is assembled later, after variable and environment expansion.
      */
     query: URLSearchParams;
+    /** URI-ready named-parameter examples, appended without re-encoding. */
+    serializedQuery?: string[];
+    /** OpenAPI 3.2 whole-query parameter, serialized after environment substitution. */
+    querystring?: QuerystringParameter;
     /**
      * Headers to be sent with this request, combining spec-provided defaults, user overrides,
      * and (potentially) security-related fields. All header values are unsubstituted at this stage.
@@ -173,7 +180,7 @@ export type RequestFactory = {
  * Builds a request object fastory which can be used to build a request object.
  * @returns A request object factory
  */
-export declare const requestFactory: ({ exampleName, globalCookies, method, operation, path, proxyUrl, server, defaultHeaders, isElectron, selectedSecuritySchemes, requestBodyCompositionSelection, }: RequestExampleMeta & {
+export declare const requestFactory: ({ exampleName, globalCookies, method, operation, path, proxyUrl, server, defaultHeaders, isElectron, selectedSecuritySchemes, openapiVersion, requestBodyCompositionSelection, }: RequestExampleMeta & {
     /** The operation object */
     operation: OperationObject;
     /** For environment variables in the inputs */
@@ -191,6 +198,8 @@ export declare const requestFactory: ({ exampleName, globalCookies, method, oper
     /** The selected security schemes for the current operation */
     selectedSecuritySchemes: SecuritySchemeObjectSecret[];
     /** Selected anyOf/oneOf request-body variants keyed by schema path */
+    /** Originating OpenAPI version, used for XML mapping rules. */
+    openapiVersion?: string;
     requestBodyCompositionSelection?: Record<string, number>;
 }) => {
     request: RequestFactory;

package/dist/request-example/builder/request-factory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"request-factory.d.ts","sourceRoot":"","sources":["../../../src/request-example/builder/request-factory.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2EAA2E,CAAA;AACnH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qEAAqE,CAAA;AACxG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8DAA8D,CAAA;AAChG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAA;AAG5F,OAAO,EACL,KAAK,0BAA0B,EAEhC,MAAM,2DAA2D,CAAA;AAClE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,iDAAiD,CAAA;AACjG,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAGjE,OAAO,EAAE,KAAK,WAAW,EAAoB,MAAM,2BAA2B,CAAA;AAG9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;;OAKG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,IAAI,EAAE;QACJ;;;;;WAKG;QACH,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACjC;;;;;WAKG;QACH,GAAG,EAAE,MAAM,CAAA;KACZ,CAAA;IAED;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;OAGG;IACH,KAAK,EAAE,eAAe,CAAA;IAEtB;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAA;IAEhB;;;;OAIG;IACH,IAAI,EAAE,WAAW,GAAG,IAAI,CAAA;IAExB;;;;OAIG;IACH,OAAO,EAAE,aAAa,EAAE,CAAA;IAExB;;;OAGG;IACH,KAAK,EAAE,YAAY,CAAA;IAEnB;;;;OAIG;IACH,QAAQ,EAAE,0BAA0B,EAAE,CAAA;IAEtC;;;OAGG;IACH,8BAA8B,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAE5C;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;QACf;;;WAGG;QACH,UAAU,EAAE,OAAO,CAAA;QACnB;;;WAGG;QACH,eAAe,EAAE,OAAO,CAAA;KACzB,CAAC,CAAA;CACH,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,kKAY5B,kBAAkB,GAAG;IACtB,2BAA2B;IAC3B,SAAS,EAAE,eAAe,CAAA;IAC1B,8CAA8C;IAC9C,WAAW,EAAE,kBAAkB,CAAA;IAC/B,mCAAmC;IACnC,aAAa,EAAE,aAAa,EAAE,CAAA;IAC9B,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAA;IAChB,wBAAwB;IACxB,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;IAC3B,sBAAsB;IACtB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACtC,qEAAqE;IACrE,UAAU,EAAE,OAAO,CAAA;IACnB,8DAA8D;IAC9D,uBAAuB,EAAE,0BAA0B,EAAE,CAAA;IACrD,sEAAsE;IACtE,+BAA+B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACzD,KAAG;IACF,OAAO,EAAE,cAAc,CAAA;CAqExB,CAAA"}
+{"version":3,"file":"request-factory.d.ts","sourceRoot":"","sources":["../../../src/request-example/builder/request-factory.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2EAA2E,CAAA;AACnH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qEAAqE,CAAA;AACxG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8DAA8D,CAAA;AAChG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAA;AAE5F,OAAO,EAAE,KAAK,oBAAoB,EAA2B,MAAM,iCAAiC,CAAA;AAEpG,OAAO,EACL,KAAK,0BAA0B,EAEhC,MAAM,2DAA2D,CAAA;AAClE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,iDAAiD,CAAA;AACjG,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAGjE,OAAO,EAAE,KAAK,WAAW,EAAoB,MAAM,2BAA2B,CAAA;AAG9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;;OAKG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,IAAI,EAAE;QACJ;;;;;WAKG;QACH,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACjC,kDAAkD;QAClD,oBAAoB,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QAClC;;;;;WAKG;QACH,GAAG,EAAE,MAAM,CAAA;KACZ,CAAA;IAED;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;OAGG;IACH,KAAK,EAAE,eAAe,CAAA;IAEtB,wEAAwE;IACxE,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;IAE1B,oFAAoF;IACpF,WAAW,CAAC,EAAE,oBAAoB,CAAA;IAElC;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAA;IAEhB;;;;OAIG;IACH,IAAI,EAAE,WAAW,GAAG,IAAI,CAAA;IAExB;;;;OAIG;IACH,OAAO,EAAE,aAAa,EAAE,CAAA;IAExB;;;OAGG;IACH,KAAK,EAAE,YAAY,CAAA;IAEnB;;;;OAIG;IACH,QAAQ,EAAE,0BAA0B,EAAE,CAAA;IAEtC;;;OAGG;IACH,8BAA8B,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAE5C;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;QACf;;;WAGG;QACH,UAAU,EAAE,OAAO,CAAA;QACnB;;;WAGG;QACH,eAAe,EAAE,OAAO,CAAA;KACzB,CAAC,CAAA;CACH,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,kLAa5B,kBAAkB,GAAG;IACtB,2BAA2B;IAC3B,SAAS,EAAE,eAAe,CAAA;IAC1B,8CAA8C;IAC9C,WAAW,EAAE,kBAAkB,CAAA;IAC/B,mCAAmC;IACnC,aAAa,EAAE,aAAa,EAAE,CAAA;IAC9B,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAA;IAChB,wBAAwB;IACxB,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;IAC3B,sBAAsB;IACtB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACtC,qEAAqE;IACrE,UAAU,EAAE,OAAO,CAAA;IACnB,8DAA8D;IAC9D,uBAAuB,EAAE,0BAA0B,EAAE,CAAA;IACrD,sEAAsE;IACtE,+DAA+D;IAC/D,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,+BAA+B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACzD,KAAG;IACF,OAAO,EAAE,cAAc,CAAA;CA4ExB,CAAA"}

package/dist/request-example/builder/request-factory.js

@@ -1,6 +1,8 @@
 import { canMethodHaveBody } from '@scalar/helpers/http/can-method-have-body';
+import { isHttpMethod } from '@scalar/helpers/http/is-http-method';
 import { replacePathVariables } from '@scalar/helpers/regex/replace-variables';
 import { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref';
+import { getQuerystringParameter } from '../../helpers/querystring-parameter.js';
 import { getServerVariables } from '../../request-example/builder/helpers/get-server-variables.js';
 import { buildRequestSecurity, } from '../../request-example/builder/security/build-request-security.js';
 import { filterDisabledDefaultHeaders } from '../context/headers.js';
@@ -10,10 +12,14 @@ import { buildRequestParameters } from './header/build-request-parameters.js';
  * Builds a request object fastory which can be used to build a request object.
  * @returns A request object factory
  */
-export const requestFactory = ({ exampleName, globalCookies, method, operation, path, proxyUrl, server, defaultHeaders, isElectron, selectedSecuritySchemes, requestBodyCompositionSelection, }) => {
+export const requestFactory = ({ exampleName, globalCookies, method, operation, path, proxyUrl, server, defaultHeaders, isElectron, selectedSecuritySchemes, openapiVersion, requestBodyCompositionSelection, }) => {
     const requestBody = getResolvedRef(operation.requestBody);
     /** Build out the request parameters */
     const params = buildRequestParameters(operation.parameters ?? [], exampleName);
+    const querystringParameter = operation.parameters
+        ?.map((parameter) => getResolvedRef(parameter))
+        .find((parameter) => parameter?.in === 'querystring');
+    const querystring = querystringParameter ? getQuerystringParameter(querystringParameter, exampleName) : undefined;
     const security = buildRequestSecurity(selectedSecuritySchemes);
     const headers = new Headers({
         ...filterDisabledDefaultHeaders(operation, exampleName, defaultHeaders),
@@ -21,7 +27,7 @@ export const requestFactory = ({ exampleName, globalCookies, method, operation,
     });
     // If the method can have a body, build the request body, otherwise set it to null
     const body = canMethodHaveBody(method)
-        ? buildRequestBody(requestBody, exampleName, requestBodyCompositionSelection)
+        ? buildRequestBody(requestBody, exampleName, requestBodyCompositionSelection, openapiVersion)
         : null;
     // Delete the Content-Type header so the browser will set it automatically based on the request body
     if (body?.mode === 'formdata' || body?.mode === 'urlencoded') {
@@ -50,10 +56,13 @@ export const requestFactory = ({ exampleName, globalCookies, method, operation,
         proxyUrl,
         path: {
             variables: params.pathVariables,
+            ...(params.serializedPathParameters ? { serializedParameters: params.serializedPathParameters } : {}),
             raw: path,
         },
         query: params.urlParams,
-        method: method.toUpperCase(),
+        ...(params.serializedQuery ? { serializedQuery: params.serializedQuery } : {}),
+        ...(querystring ? { querystring } : {}),
+        method: isHttpMethod(method) && method === method.toLowerCase() ? method.toUpperCase() : method,
         headers,
         body,
         cookies: cookiesList,

package/dist/request-example/builder/resolve-request-factory-url.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolve-request-factory-url.d.ts","sourceRoot":"","sources":["../../../src/request-example/builder/resolve-request-factory-url.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,MAAM,EAAW,MAAM,8BAA8B,CAAA;AAKnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2CAA2C,CAAA;AAE/E;;;GAGG;AACH,eAAO,MAAM,2BAA2B,EAAG,6BAAsC,CAAA;AAEjF;;GAEG;AACH,eAAO,MAAM,2BAA2B,EAAG,6BAAsC,CAAA;AAEjF,MAAM,MAAM,6BAA6B,GAAG,OAAO,2BAA2B,GAAG,OAAO,2BAA2B,CAAA;AAEnH,MAAM,MAAM,8BAA8B,GAAG,MAAM,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAA;AAK1F;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,GACnC,SAAS,cAAc,EACvB,SAAS;IACP,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAC,CAAA;IACzE,mBAAmB,EAAE,eAAe,CAAA;IACpC;;;OAGG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAA;CACxC,KACA,8BAqDF,CAAA"}
+{"version":3,"file":"resolve-request-factory-url.d.ts","sourceRoot":"","sources":["../../../src/request-example/builder/resolve-request-factory-url.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,MAAM,EAAW,MAAM,8BAA8B,CAAA;AAMnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2CAA2C,CAAA;AAE/E;;;GAGG;AACH,eAAO,MAAM,2BAA2B,EAAG,6BAAsC,CAAA;AAEjF;;GAEG;AACH,eAAO,MAAM,2BAA2B,EAAG,6BAAsC,CAAA;AAEjF,MAAM,MAAM,6BAA6B,GAAG,OAAO,2BAA2B,GAAG,OAAO,2BAA2B,CAAA;AAEnH,MAAM,MAAM,8BAA8B,GAAG,MAAM,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAA;AAK1F;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,GACnC,SAAS,cAAc,EACvB,SAAS;IACP,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAC,CAAA;IACzE,mBAAmB,EAAE,eAAe,CAAA;IACpC;;;OAGG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAA;CACxC,KACA,8BAoEF,CAAA"}

package/dist/request-example/builder/resolve-request-factory-url.js

@@ -3,6 +3,7 @@ import { err, ok } from '@scalar/helpers/types/result';
 import { safeRun } from '@scalar/helpers/types/safe-run';
 import { isRelativePath } from '@scalar/helpers/url/is-relative-path';
 import { mergeSearchParams, mergeUrls } from '@scalar/helpers/url/merge-urls';
+import { serializeQuerystringParameter } from '../../helpers/querystring-parameter.js';
 /**
  * Discriminated error code when the merged request URL is not a complete absolute target
  * (for example no OpenAPI server, or unresolved `{{environment}}` segments left in the merged URL).
@@ -22,7 +23,9 @@ export const resolveRequestFactoryUrl = (request, options) => {
     const variables = options.envVariables;
     const pathVariablesEncoded = safeRun(() => Object.fromEntries(Object.entries(request.path.variables).map(([key, value]) => [
         key,
-        encodeURIComponent(replaceEnvVariables(value, variables)),
+        request.path.serializedParameters?.has(key)
+            ? replaceEnvVariables(value, variables)
+            : encodeURIComponent(replaceEnvVariables(value, variables)),
     ])));
     if (!pathVariablesEncoded.ok) {
         return err(INVALID_REQUEST_FACTORY_URL, 'The request URL contains invalid characters in path parameters.');
@@ -54,6 +57,19 @@ export const resolveRequestFactoryUrl = (request, options) => {
     for (const [key, value] of options.securityQueryParams.entries()) {
         securityQueryParams.append(key, value);
     }
-    url.search = mergeSearchParams(url.searchParams, operationQueryParams, securityQueryParams).toString();
+    if (request.querystring) {
+        // A whole-query value replaces the server/path query and must never pass through
+        // URLSearchParams, which would add '=' and change existing percent encodings.
+        const query = serializeQuerystringParameter(request.querystring, variables);
+        const extra = mergeSearchParams(operationQueryParams, securityQueryParams).toString();
+        url.search = [query, extra].filter(Boolean).join('&');
+    }
+    else {
+        url.search = mergeSearchParams(url.searchParams, operationQueryParams, securityQueryParams).toString();
+    }
+    if (request.serializedQuery?.length) {
+        const query = request.serializedQuery.map((value) => replaceEnvVariables(value, variables)).join('&');
+        url.search = [url.search.slice(1), query].filter(Boolean).join('&');
+    }
     return ok(url.toString());
 };

package/dist/request-example/context/headers.d.ts

@@ -1,4 +1,3 @@
-import type { HttpMethod } from '@scalar/helpers/http/http-methods';
 import type { OperationObject } from '@scalar/workspace-store/schemas/v3.2/strict/openapi-document';
 /**
  * Restores conventional casing for well-known default headers.
@@ -35,7 +34,7 @@ export declare const filterDisabledDefaultHeaders: (operation: OperationObject,
  *   operation parameter with `in: header` (disabled optional header parameters do not shadow defaults).
  */
 export declare const getDefaultHeaders: ({ method, operation, exampleName, hideDisabledHeaders, hideOverriddenHeaders, options, }: {
-    method: HttpMethod;
+    method: string;
     operation: OperationObject;
     exampleName: string;
     hideDisabledHeaders?: boolean;

package/dist/request-example/context/headers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"headers.d.ts","sourceRoot":"","sources":["../../../src/request-example/context/headers.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAA;AAcnG;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B,GAAI,YAAY,MAAM,KAAG,MACQ,CAAA;AAE3E;;GAEG;AACH,eAAO,MAAM,qCAAqC,GAAI,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CACK,CAAA;AAgDlH;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B,GACvC,WAAW,eAAe,EAC1B,aAAa,MAAM,EACnB,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAC9B,MAAM,CAAC,MAAM,EAAE,MAAM,CAIpB,CAAA;AAEJ;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iBAAiB,GAAI,0FAU/B;IACD,MAAM,EAAE,UAAU,CAAA;IAClB,SAAS,EAAE,eAAe,CAAA;IAC1B,WAAW,EAAE,MAAM,CAAA;IACnB,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,OAAO,CAAC,EAAE;QACR,UAAU,EAAE,MAAM,CAAA;QAClB,UAAU,EAAE,OAAO,CAAA;KACpB,CAAA;CACF,KAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAuCxB,CAAA"}
+{"version":3,"file":"headers.d.ts","sourceRoot":"","sources":["../../../src/request-example/context/headers.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAA;AAcnG;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B,GAAI,YAAY,MAAM,KAAG,MACQ,CAAA;AAE3E;;GAEG;AACH,eAAO,MAAM,qCAAqC,GAAI,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CACK,CAAA;AAgDlH;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B,GACvC,WAAW,eAAe,EAC1B,aAAa,MAAM,EACnB,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAC9B,MAAM,CAAC,MAAM,EAAE,MAAM,CAIpB,CAAA;AAEJ;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iBAAiB,GAAI,0FAU/B;IACD,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,eAAe,CAAA;IAC1B,WAAW,EAAE,MAAM,CAAA;IACnB,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,OAAO,CAAC,EAAE;QACR,UAAU,EAAE,MAAM,CAAA;QAClB,UAAU,EAAE,OAAO,CAAA;KACpB,CAAA;CACF,KAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAuCxB,CAAA"}

package/dist/request-example/index.d.ts

@@ -8,4 +8,8 @@ export { type BuildRequestExampleContext, combineParams, filterDisabledDefaultHe
 export { CONTEXT_FUNCTION_NAMES, type ContextFunctionEntry, type ContextFunctionName, POPULAR_CONTEXT_FUNCTION_KEYS, contextFunctions, getContextFunctionComment, isContextFunctionName, } from './functions.js';
 export { createVariablesStoreForRequest } from './variable-store/index.js';
 export type { VariableEntry, VariablesStore } from './variable-store/types.js';
+export { getXmlBodyExample } from './xml/get-xml-body-example.js';
+export { type XmlExampleOptions, getXmlExampleFromSchema, serializeXmlExample } from './xml/get-xml-example.js';
+export { serializeXmlPart } from './xml/serialize-xml-part.js';
+export type { XmlDiagnostic, XmlExampleResult } from './xml/xml-node.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/request-example/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/request-example/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,kBAAkB,EAClB,gBAAgB,EAChB,uBAAuB,EACvB,kBAAkB,EAClB,sBAAsB,EACtB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,gCAAgC,EAChC,gCAAgC,EAChC,kCAAkC,EAClC,uBAAuB,EACvB,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EACzB,cAAc,EACd,6BAA6B,EAC7B,8BAA8B,EAC9B,gBAAgB,EAChB,0BAA0B,EAC1B,gBAAgB,GACjB,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,oBAAoB,EACpB,2BAA2B,EAC3B,2BAA2B,EAC3B,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,6BAA6B,EAC7B,YAAY,EACZ,oBAAoB,EACpB,2BAA2B,EAC3B,kBAAkB,EAClB,oBAAoB,EACpB,sBAAsB,EACtB,kBAAkB,EAClB,uBAAuB,EACvB,UAAU,EACV,kBAAkB,EAClB,oBAAoB,EACpB,cAAc,EACd,wBAAwB,EACxB,0BAA0B,EAC1B,kBAAkB,EAClB,sBAAsB,EACtB,eAAe,EACf,gBAAgB,EAChB,cAAc,EACd,2BAA2B,EAC3B,iBAAiB,EACjB,wBAAwB,EACxB,qBAAqB,EACrB,oBAAoB,EACpB,wBAAwB,EACxB,iCAAiC,EACjC,kBAAkB,EAClB,4BAA4B,EAC5B,uBAAuB,EACvB,2BAA2B,EAC3B,oBAAoB,EACpB,4BAA4B,GAC7B,MAAM,WAAW,CAAA;AAClB,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAA;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAA;AACpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAA;AAC7E,YAAY,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AACtD,OAAO,EACL,KAAK,0BAA0B,EAC/B,aAAa,EACb,4BAA4B,EAC5B,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,wBAAwB,EACxB,uBAAuB,EACvB,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,UAAU,EACV,cAAc,EACd,aAAa,EACb,qCAAqC,EACrC,6BAA6B,GAC9B,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,sBAAsB,EACtB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,6BAA6B,EAC7B,gBAAgB,EAChB,yBAAyB,EACzB,qBAAqB,GACtB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,8BAA8B,EAAE,MAAM,kBAAkB,CAAA;AACjE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/request-example/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,kBAAkB,EAClB,gBAAgB,EAChB,uBAAuB,EACvB,kBAAkB,EAClB,sBAAsB,EACtB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,gCAAgC,EAChC,gCAAgC,EAChC,kCAAkC,EAClC,uBAAuB,EACvB,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EACzB,cAAc,EACd,6BAA6B,EAC7B,8BAA8B,EAC9B,gBAAgB,EAChB,0BAA0B,EAC1B,gBAAgB,GACjB,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,oBAAoB,EACpB,2BAA2B,EAC3B,2BAA2B,EAC3B,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,6BAA6B,EAC7B,YAAY,EACZ,oBAAoB,EACpB,2BAA2B,EAC3B,kBAAkB,EAClB,oBAAoB,EACpB,sBAAsB,EACtB,kBAAkB,EAClB,uBAAuB,EACvB,UAAU,EACV,kBAAkB,EAClB,oBAAoB,EACpB,cAAc,EACd,wBAAwB,EACxB,0BAA0B,EAC1B,kBAAkB,EAClB,sBAAsB,EACtB,eAAe,EACf,gBAAgB,EAChB,cAAc,EACd,2BAA2B,EAC3B,iBAAiB,EACjB,wBAAwB,EACxB,qBAAqB,EACrB,oBAAoB,EACpB,wBAAwB,EACxB,iCAAiC,EACjC,kBAAkB,EAClB,4BAA4B,EAC5B,uBAAuB,EACvB,2BAA2B,EAC3B,oBAAoB,EACpB,4BAA4B,GAC7B,MAAM,WAAW,CAAA;AAClB,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAA;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAA;AACpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAA;AAC7E,YAAY,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AACtD,OAAO,EACL,KAAK,0BAA0B,EAC/B,aAAa,EACb,4BAA4B,EAC5B,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,wBAAwB,EACxB,uBAAuB,EACvB,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,UAAU,EACV,cAAc,EACd,aAAa,EACb,qCAAqC,EACrC,6BAA6B,GAC9B,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,sBAAsB,EACtB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,6BAA6B,EAC7B,gBAAgB,EAChB,yBAAyB,EACzB,qBAAqB,GACtB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,8BAA8B,EAAE,MAAM,kBAAkB,CAAA;AACjE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAA;AAC9D,OAAO,EAAE,KAAK,iBAAiB,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC5G,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,YAAY,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA"}

package/dist/request-example/index.js

@@ -5,3 +5,6 @@ export { serializeMultipartBody } from './builder/body/encode-multipart-body.js'
 export { combineParams, filterDisabledDefaultHeaders, getActiveEnvironment, getActiveProxyUrl, getDefaultHeaders, getRequestExampleContext, getSecurityRequirements, getSecuritySchemes, getSelectedSecurity, getSelectedServer, getServers, isAuthOptional, mergeSecurity, restoreConventionalDefaultHeaderNames, restoreConventionalHeaderName, } from './context/index.js';
 export { CONTEXT_FUNCTION_NAMES, POPULAR_CONTEXT_FUNCTION_KEYS, contextFunctions, getContextFunctionComment, isContextFunctionName, } from './functions.js';
 export { createVariablesStoreForRequest } from './variable-store/index.js';
+export { getXmlBodyExample } from './xml/get-xml-body-example.js';
+export { getXmlExampleFromSchema, serializeXmlExample } from './xml/get-xml-example.js';
+export { serializeXmlPart } from './xml/serialize-xml-part.js';

package/dist/request-example/types.d.ts

@@ -1,4 +1,3 @@
-import type { HttpMethod } from '@scalar/helpers/http/http-methods';
 /**
  * Re-exported from `@scalar/helpers/types/result` so the rest of the
  * workspace-store codebase keeps importing `Result` from a colocated
@@ -8,7 +7,7 @@ export type { Result } from '@scalar/helpers/types/result';
 export type RequestExampleMeta = {
     /** API path, or webhook name when `isWebhook` is true. */
     path: string;
-    method: HttpMethod;
+    method: string;
     exampleName: string;
     /** Resolve the operation from `document.webhooks` instead of `document.paths`. */
     isWebhook?: boolean;

package/dist/request-example/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/request-example/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE;;;;GAIG;AACH,YAAY,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAA;AAE1D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,UAAU,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;IACnB,kFAAkF;IAClF,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/request-example/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,YAAY,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAA;AAE1D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,kFAAkF;IAClF,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,CAAA"}

package/dist/request-example/xml/get-xml-body-example.d.ts

@@ -0,0 +1,8 @@
+import { type RefNode } from '../../helpers/get-resolved-ref.js';
+import type { ExampleObject } from '../../schemas/v3.2/strict/example.js';
+import { type SchemaObject } from '../../schemas/v3.2/strict/openapi-document.js';
+import { type XmlExampleOptions } from './get-xml-example.js';
+import type { XmlExampleResult } from './xml-node.js';
+/** Resolve media-level XML examples without treating schema string values as serialized payloads. */
+export declare const getXmlBodyExample: (schema: SchemaObject | undefined, inputExample: ExampleObject | RefNode<ExampleObject> | undefined, options?: XmlExampleOptions) => XmlExampleResult;
+//# sourceMappingURL=get-xml-body-example.d.ts.map

package/dist/request-example/xml/get-xml-body-example.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-xml-body-example.d.ts","sourceRoot":"","sources":["../../../src/request-example/xml/get-xml-body-example.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAkB,MAAM,4BAA4B,CAAA;AAEzE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAA;AAClE,OAAO,EAAE,KAAK,YAAY,EAAsB,MAAM,wCAAwC,CAAA;AAE9F,OAAO,EAAE,KAAK,iBAAiB,EAAgD,MAAM,mBAAmB,CAAA;AACxG,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAElD,qGAAqG;AACrG,eAAO,MAAM,iBAAiB,GAC5B,QAAQ,YAAY,GAAG,SAAS,EAChC,cAAc,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,SAAS,EAChE,UAAS,iBAAsB,KAC9B,gBAeF,CAAA"}

package/dist/request-example/xml/get-xml-body-example.js

@@ -0,0 +1,21 @@
+import { getResolvedRef } from '../../helpers/get-resolved-ref.js';
+import { coerceValue } from '../../schemas/typebox-coerce.js';
+import { SchemaObjectSchema } from '../../schemas/v3.2/strict/openapi-document.js';
+import { getXmlExampleFromSchema, serializeXmlExample } from './get-xml-example.js';
+/** Resolve media-level XML examples without treating schema string values as serialized payloads. */
+export const getXmlBodyExample = (schema, inputExample, options = {}) => {
+    const example = getResolvedRef(inputExample);
+    if (example?.serializedValue !== undefined) {
+        return { xml: example.serializedValue, diagnostics: [] };
+    }
+    if (example?.dataValue !== undefined) {
+        return serializeXmlExample(example.dataValue, schema ?? coerceValue(SchemaObjectSchema, {}), options);
+    }
+    if (typeof example?.value === 'string') {
+        return { xml: example.value, diagnostics: [] };
+    }
+    if (example?.value !== undefined) {
+        return serializeXmlExample(example.value, schema ?? coerceValue(SchemaObjectSchema, {}), options);
+    }
+    return schema ? getXmlExampleFromSchema(schema, options) : { xml: undefined, diagnostics: [] };
+};

package/dist/request-example/xml/get-xml-example.d.ts

@@ -0,0 +1,21 @@
+import type { SchemaObject } from '../../schemas/v3.2/strict/openapi-document.js';
+import { EXAMPLE_EVALUATION } from '../builder/helpers/example-evaluation.js';
+import { type GetExampleFromSchemaOptions } from '../builder/helpers/get-example-from-schema.js';
+import { type WriteXmlOptions } from './write-xml.js';
+import type { XmlDiagnostic, XmlExampleResult } from './xml-node.js';
+/** XML options share the data generator's value and branch-selection policies. */
+export type XmlExampleOptions = Omit<GetExampleFromSchemaOptions, 'xml' | typeof EXAMPLE_EVALUATION> & WriteXmlOptions & {
+    /** Version-specific XML defaults. Existing descriptions default to OpenAPI 3.1 behavior. */
+    openapiVersion?: string;
+    /** Context retained by callers before resolving a component reference. */
+    rootName?: string;
+    /** Keep composition-selection keys aligned with the request editor. */
+    schemaPath?: string[];
+    /** Receives diagnostics; errors otherwise appear in the developer console instead of failing silently. */
+    onDiagnostic?: (diagnostic: XmlDiagnostic) => void;
+};
+/** Generate XML using the same value evaluator and selected branches as JSON examples. */
+export declare const getXmlExampleFromSchema: (schema: SchemaObject, options?: XmlExampleOptions) => XmlExampleResult;
+/** Serialize schema-ready example data. Serialized XML strings bypass this function at the media boundary. */
+export declare const serializeXmlExample: (value: unknown, schema: SchemaObject, options?: XmlExampleOptions) => XmlExampleResult;
+//# sourceMappingURL=get-xml-example.d.ts.map

package/dist/request-example/xml/get-xml-example.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-xml-example.d.ts","sourceRoot":"","sources":["../../../src/request-example/xml/get-xml-example.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AAG1E,OAAO,EACL,kBAAkB,EAGnB,MAAM,uCAAuC,CAAA;AAC9C,OAAO,EACL,KAAK,2BAA2B,EAGjC,MAAM,4CAA4C,CAAA;AAEnD,OAAO,EAAE,KAAK,eAAe,EAAY,MAAM,aAAa,CAAA;AAC5D,OAAO,KAAK,EAAgB,aAAa,EAAE,gBAAgB,EAAoB,MAAM,YAAY,CAAA;AAEjG,kFAAkF;AAClF,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,2BAA2B,EAAE,KAAK,GAAG,OAAO,kBAAkB,CAAC,GAClG,eAAe,GAAG;IAChB,4FAA4F;IAC5F,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,uEAAuE;IACvE,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IACrB,0GAA0G;IAC1G,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,aAAa,KAAK,IAAI,CAAA;CACnD,CAAA;AAmBH,0FAA0F;AAC1F,eAAO,MAAM,uBAAuB,GAAI,QAAQ,YAAY,EAAE,UAAS,iBAAsB,KAAG,gBAQ/F,CAAA;AAED,8GAA8G;AAC9G,eAAO,MAAM,mBAAmB,GAC9B,OAAO,OAAO,EACd,QAAQ,YAAY,EACpB,UAAS,iBAAsB,KAC9B,gBAAqF,CAAA"}