@scalar/workspace-store 0.59.0 → 0.61.0

package/dist/request-example/builder/header/serialize-parameter.js

@@ -1,3 +1,4 @@
+import { isObjectLike } from '@scalar/helpers/object/is-object';
 /**
  * Shared parameter serialization utilities for OpenAPI style values.
  * Used by both build-request-parameters and process-parameters.
@@ -19,7 +20,7 @@ export const serializeContentValue = (value, contentType) => {
         return value;
     }
     // Handle JSON content types
-    if (contentType.includes('json') || (typeof value === 'object' && value !== null && !Array.isArray(value))) {
+    if (contentType.includes('json') || (isObjectLike(value) && !Array.isArray(value))) {
         return JSON.stringify(value);
     }
     // Default: convert to string
@@ -45,7 +46,7 @@ export const serializeSimpleStyle = (value, explode) => {
         return value.join(',');
     }
     // Handle objects
-    if (typeof value === 'object' && value !== null) {
+    if (isObjectLike(value)) {
         const entries = Object.entries(value);
         if (explode) {
             // Simple explode object: R=100,G=200,B=150
@@ -81,14 +82,14 @@ export const serializeFormStyle = (value, explode) => {
         return value.join(',');
     }
     // Handle objects with explode
-    if (typeof value === 'object' && value !== null && explode) {
+    if (isObjectLike(value) && explode) {
         return Object.entries(value).map(([k, v]) => ({
             key: k,
             value: v,
         }));
     }
     // Handle objects without explode
-    if (typeof value === 'object' && value !== null) {
+    if (isObjectLike(value)) {
         return Object.entries(value)
             .map(([k, v]) => `${k},${v}`)
             .join(',');
@@ -121,19 +122,19 @@ export const serializeFormStyleForCookies = (value, explode) => {
         return value.map((v) => (v === null ? 'null' : String(v))).join(',');
     }
     // Handle objects with explode
-    if (typeof value === 'object' && value !== null && explode) {
+    if (isObjectLike(value) && explode) {
         return Object.entries(value).map(([k, v]) => ({
             key: k,
             value: v,
         }));
     }
     // Handle objects without explode - recursively flatten nested objects
-    if (typeof value === 'object' && value !== null) {
+    if (isObjectLike(value)) {
         const flattenObject = (obj) => {
             const result = [];
             for (const [key, val] of Object.entries(obj)) {
                 // Recursively flatten nested objects
-                if (typeof val === 'object' && val !== null && !Array.isArray(val)) {
+                if (isObjectLike(val) && !Array.isArray(val)) {
                     result.push(key, ...flattenObject(val));
                 }
                 // Handle primitive values
@@ -161,7 +162,7 @@ export const serializeSpaceDelimitedStyle = (value) => {
         return value.join(' ');
     }
     // Handle objects
-    if (typeof value === 'object' && value !== null) {
+    if (isObjectLike(value)) {
         return Object.entries(value)
             .map(([k, v]) => `${k} ${v}`)
             .join(' ');
@@ -182,10 +183,8 @@ export const serializePipeDelimitedStyle = (value) => {
         return value.join('|');
     }
     // Handle objects
-    if (typeof value === 'object' && value !== null) {
-        return Object.entries(value)
-            .flat()
-            .join('|');
+    if (isObjectLike(value)) {
+        return Object.entries(value).flat().join('|');
     }
     // Handle primitives (shouldn't happen for pipeDelimited)
     return String(value);
@@ -213,7 +212,7 @@ export const serializeDeepObjectStyle = (paramName, value) => {
                 append(`${fullKey}[]`, item);
             }
         }
-        else if (typeof val === 'object' && val !== null) {
+        else if (isObjectLike(val)) {
             flatten(val, fullKey);
         }
         else {
@@ -228,7 +227,7 @@ export const serializeDeepObjectStyle = (paramName, value) => {
             append(`${prefix}[${key}]`, val);
         }
     };
-    if (typeof value === 'object' && value !== null && !Array.isArray(value)) {
+    if (isObjectLike(value) && !Array.isArray(value)) {
         flatten(value, paramName);
     }
     return result;

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

@@ -1,5 +1,5 @@
 import { type DynamicScope } from '../../../helpers/dynamic-ref.js';
-import type { SchemaObject } from '../../../schemas/v3.1/strict/openapi-document.js';
+import type { SchemaObject } from '../../../schemas/v3.2/strict/openapi-document.js';
 type GetExampleFromSchemaOptions = {
     /** Fallback string for empty string values. */
     emptyString?: string;
@@ -11,6 +11,14 @@ type GetExampleFromSchemaOptions = {
     variables?: Record<string, unknown>;
     /** Whether to omit empty and optional properties. */
     omitEmptyAndOptionalProperties?: boolean;
+    /**
+     * Whether to keep schemas annotated `deprecated: true`.
+     *
+     * `deprecated` says a field is discouraged, not that it is absent from the wire, so a caller
+     * that must produce a value satisfying the schema — a mock server response, for instance —
+     * sets this. Defaults to omitting, which is what a request-body form-filler wants.
+     */
+    includeDeprecated?: boolean;
     /** Selected oneOf/anyOf variants keyed by schema path. */
     compositionSelection?: Record<string, number>;
 };

package/dist/request-example/builder/helpers/get-example-from-schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-example-from-schema.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/helpers/get-example-from-schema.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,YAAY,EAAqD,MAAM,uBAAuB,CAAA;AAG5G,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AAitB1E,KAAK,2BAA2B,GAAG;IACjC,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,4CAA4C;IAC5C,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB,iEAAiE;IACjE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACnC,qDAAqD;IACrD,8BAA8B,CAAC,EAAE,OAAO,CAAA;IACxC,0DAA0D;IAC1D,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC9C,CAAA;AAeD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,oBAAoB,GAC/B,QAAQ,YAAY,EACpB,UAAU,2BAA2B,EACrC,iEAOG,OAAO,CAAC;IACT,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,EAAE,YAAY,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;IACrB,6EAA6E;IAC7E,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,qGAAqG;IACrG,YAAY,EAAE,YAAY,CAAA;CAC3B,CAAM,KACN,OAwMF,CAAA"}
+{"version":3,"file":"get-example-from-schema.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/helpers/get-example-from-schema.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,YAAY,EAAqD,MAAM,uBAAuB,CAAA;AAG5G,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AA+wB1E,KAAK,2BAA2B,GAAG;IACjC,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,4CAA4C;IAC5C,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB,iEAAiE;IACjE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACnC,qDAAqD;IACrD,8BAA8B,CAAC,EAAE,OAAO,CAAA;IACxC;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,0DAA0D;IAC1D,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC9C,CAAA;AA+ND;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,oBAAoB,GAC/B,QAAQ,YAAY,EACpB,UAAU,2BAA2B,EACrC,iEAOG,OAAO,CAAC;IACT,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,EAAE,YAAY,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;IACrB,6EAA6E;IAC7E,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,qGAAqG;IACrG,YAAY,EAAE,YAAY,CAAA;CAC3B,CAAM,KACN,OAmNF,CAAA"}

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

@@ -1,4 +1,5 @@
 import { isDefined } from '@scalar/helpers/array/is-defined';
+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';
@@ -70,7 +71,10 @@ const guessFromFormat = (schema, makeUpRandomData = false, fallback = '') => {
     }
     // Return format-specific example if we have one and are making up data
     if (makeUpRandomData && 'format' in schema && schema.format) {
-        return genericExampleValues[schema.format] ?? fallback;
+        // Some generators emit version-specific UUID formats (for example FastAPI/Pydantic
+        // uses uuid1, uuid3, uuid4 and uuid5). Treat them all like a regular uuid.
+        const format = /^uuid[1-8]$/.test(schema.format) ? 'uuid' : schema.format;
+        return genericExampleValues[format] ?? fallback;
     }
     return fallback;
 };
@@ -79,6 +83,18 @@ const guessFromFormat = (schema, makeUpRandomData = false, fallback = '') => {
  * Uses the resolved schema object as the key for efficient lookups.
  */
 const resultCache = new WeakMap();
+/**
+ * Set once the depth cap has truncated something in the current top-level call.
+ *
+ * A truncated value only holds at the level it was produced at, but `resultCache` keys carry no level,
+ * so a value assembled around one must not be stored. Composition reaches that case: an `allOf` member
+ * climbs a level without growing `schemaPath`, so a schema rendered just above the cap in one chain
+ * shares its key with the same schema used at the top of a document, and the shallow use is served the
+ * truncated result. Widening the key would cost the cache its hits everywhere, so storing simply stops
+ * for the rest of the call instead. The walk is synchronous, so resetting at level 0 scopes this to one
+ * top-level call.
+ */
+let truncated = false;
 /** Cache required property names per parent schema for O(1) membership checks */
 const requiredNamesCache = new WeakMap();
 /** Normalize schema identity for cache and cycle tracking */
@@ -115,7 +131,7 @@ const getRequiredNames = (parentSchema) => {
  * identity would leak one scope's result into another.
  */
 const cache = (schema, result, cacheKey, skip = false) => {
-    if (skip || typeof result !== 'object' || result === null) {
+    if (skip || truncated || typeof result !== 'object' || result === null) {
         return result;
     }
     const rawSchema = getSchemaCacheTarget(schema);
@@ -136,8 +152,8 @@ const isComposed = (schema) => !!(schema.allOf || schema.oneOf || schema.anyOf);
  * Properties are omitted if they are not required and the option is enabled.
  */
 const shouldOmitProperty = (schema, parentSchema, propertyName, options) => {
-    // Early exits for schemas that should not be included (deprecated, readOnly, writeOnly)
-    if (schema.deprecated ||
+    // Early exits for schemas that should not be included (deprecated unless opted in, readOnly, writeOnly)
+    if ((schema.deprecated && options?.includeDeprecated !== true) ||
         (options?.mode === 'write' && schema.readOnly) ||
         (options?.mode === 'read' && schema.writeOnly)) {
         return true;
@@ -292,6 +308,44 @@ const getCompositionSelectionIndex = (schemaPath, composition, options, length)
     }
     return Math.max(0, Math.min(rawIndex, length - 1));
 };
+/**
+ * Use the discriminator as a generation hint. Only referenced variants have
+ * implicit names; inline titles are display labels, not discriminator mappings.
+ */
+const getDiscriminatorSelectionIndex = (schema, variants, options, value) => {
+    const discriminator = schema.discriminator;
+    if (discriminator?.defaultMapping === undefined) {
+        return undefined;
+    }
+    const property = 'properties' in schema ? schema.properties?.[discriminator.propertyName] : undefined;
+    const resolvedProperty = property ? resolve.schema(property) : undefined;
+    const propertyName = options?.xml && resolvedProperty && 'xml' in resolvedProperty
+        ? (resolvedProperty.xml?.name ?? discriminator.propertyName)
+        : discriminator.propertyName;
+    const variableValue = resolvedProperty?.['x-variable']
+        ? options?.variables?.[resolvedProperty['x-variable']]
+        : undefined;
+    const declaredValue = resolvedProperty ? getDeclaredValue(resolvedProperty) : undefined;
+    const schemaValue = variableValue !== undefined ? variableValue : declaredValue;
+    const tag = value ? value[propertyName] : schemaValue;
+    const findReference = (reference) => variants.findIndex((variant) => '$ref' in variant && variant.$ref === reference);
+    const findComponent = (name) => findReference(`#/components/schemas/${escapeJsonPointer(name)}`);
+    const findTarget = (target) => {
+        // Prefer a component name when the same string could also be a relative URI.
+        const componentIndex = findComponent(target);
+        return componentIndex >= 0 ? componentIndex : findReference(target);
+    };
+    if (typeof tag === 'string') {
+        const explicit = discriminator.mapping && Object.hasOwn(discriminator.mapping, tag) ? discriminator.mapping[tag] : undefined;
+        const mappedIndex = explicit === undefined ? findComponent(tag) : findTarget(explicit);
+        // A broken explicit mapping must not silently select the fallback.
+        if (explicit !== undefined || mappedIndex >= 0) {
+            return mappedIndex >= 0 ? mappedIndex : undefined;
+        }
+    }
+    const fallbackIndex = findTarget(discriminator.defaultMapping);
+    return fallbackIndex >= 0 ? fallbackIndex : undefined;
+};
 /**
  * Read the numeric `x-order` extension value from a raw property entry, if present.
  * The entry may be a schema or a `$ref` object, so we check membership before reading.
@@ -378,15 +432,13 @@ const handleObjectSchema = (schema, options, level, seen, cacheKey, schemaPath,
         const isAnyType = schema.additionalProperties === true ||
             (typeof schema.additionalProperties === 'object' && Object.keys(schema.additionalProperties).length === 0);
         // Check for explicit x-additionalPropertiesName first
-        const hasCustomName = typeof additional === 'object' &&
-            'x-additionalPropertiesName' in additional &&
-            typeof additional['x-additionalPropertiesName'] === 'string' &&
-            additional['x-additionalPropertiesName'].trim().length > 0;
+        const customName = typeof additional === 'object' && 'x-additionalPropertiesName' in additional
+            ? additional['x-additionalPropertiesName']
+            : undefined;
+        const hasCustomName = typeof customName === 'string' && customName.trim().length > 0;
         // Use propertyNames enum values as example keys when no custom name is set
         const propertyNamesEnum = hasCustomName ? undefined : getPropertyNamesEnumValues(schema);
-        const additionalName = hasCustomName
-            ? additional['x-additionalPropertiesName'].trim()
-            : DEFAULT_ADDITIONAL_PROPERTIES_NAME;
+        const additionalName = hasCustomName ? customName.trim() : DEFAULT_ADDITIONAL_PROPERTIES_NAME;
         const additionalValue = isAnyType
             ? 'anything'
             : typeof additional === 'object'
@@ -408,7 +460,9 @@ 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) ?? 0;
+        const index = getCompositionSelectionIndex(schemaPath, compositionKeyword, options, oneOfAnyOf.length) ??
+            getDiscriminatorSelectionIndex(schema, oneOfAnyOf, options, response) ??
+            0;
         const chosen = resolve.schema(oneOfAnyOf[index]);
         if (chosen) {
             Object.assign(response, getExampleFromSchema(chosen, options, {
@@ -503,7 +557,9 @@ const handleArraySchema = (schema, options, level, seen, cacheKey, schemaPath, d
         const compositionKeyword = items.oneOf ? 'oneOf' : items.anyOf ? 'anyOf' : undefined;
         const union = compositionKeyword ? items[compositionKeyword] : undefined;
         if (compositionKeyword && union && union.length > 0) {
-            const selectedIndex = getCompositionSelectionIndex(itemsSchemaPath, compositionKeyword, options, union.length) ?? 0;
+            const selectedIndex = getCompositionSelectionIndex(itemsSchemaPath, compositionKeyword, options, union.length) ??
+                getDiscriminatorSelectionIndex(items, union, options) ??
+                0;
             const selected = union[selectedIndex];
             const ex = getExampleFromSchema(resolve.schema(selected), options, {
                 level: level + 1,
@@ -581,10 +637,181 @@ const createOptionsCacheKey = (options) => JSON.stringify({
     mode: options?.mode,
     variables: options?.variables,
     omitEmptyAndOptionalProperties: options?.omitEmptyAndOptionalProperties,
+    // Load-bearing: `resultCache` is a module global keyed by schema identity plus this string, and
+    // the lookup happens before `shouldOmitProperty` runs. Without this entry an include-caller's
+    // populated object could be handed back to a default caller, and vice versa. `JSON.stringify`
+    // drops `undefined`, so existing callers' keys stay byte-identical.
+    includeDeprecated: options?.includeDeprecated,
     compositionSelection: options?.compositionSelection
         ? Object.entries(options.compositionSelection).sort(([a], [b]) => a.localeCompare(b))
         : undefined,
 });
+/** Stand-in for a truncated schema whose shape cannot be read off the document. */
+const MAX_DEPTH_EXCEEDED = '[Max Depth Exceeded]';
+/** How long a chain of composition wrappers may be unwrapped before the stack becomes the concern. */
+const MAX_COMPOSITION_DEPTH = MAX_LEVELS_DEEP * 5;
+/** Read a schema's declared types as a list, so `type: 'object'` and `type: ['object']` behave alike. */
+const getDeclaredTypes = (schema) => {
+    if (!('type' in schema) || !schema.type) {
+        return [];
+    }
+    return Array.isArray(schema.type) ? schema.type : [schema.type];
+};
+/** Return the empty container a schema declares, or `undefined` when it declares neither. */
+const getEmptyContainer = (schema) => {
+    const types = getDeclaredTypes(schema);
+    if ('properties' in schema || types.includes('object')) {
+        return {};
+    }
+    if ('items' in schema || types.includes('array')) {
+        return [];
+    }
+    return undefined;
+};
+/** Pick the `oneOf`/`anyOf` variant the walk itself would have rendered, honoring an explicit selection. */
+const getSelectedVariant = (schema, options, schemaPath) => {
+    const compositionKeyword = schema.oneOf ? 'oneOf' : schema.anyOf ? 'anyOf' : undefined;
+    const variants = compositionKeyword ? schema[compositionKeyword] : undefined;
+    if (!compositionKeyword || !Array.isArray(variants) || variants.length === 0) {
+        return undefined;
+    }
+    const index = getCompositionSelectionIndex(schemaPath, compositionKeyword, options, variants.length) ??
+        getDiscriminatorSelectionIndex(schema, variants, options);
+    const candidate = index !== undefined
+        ? variants[index]
+        : variants.find((variant) => {
+            const resolved = resolve.schema(variant);
+            return resolved && (!('type' in resolved) || resolved.type !== 'null');
+        });
+    return candidate ? resolve.schema(candidate) : undefined;
+};
+/**
+ * Return the value a schema states outright, in the order the walk prefers them.
+ *
+ * The walk applies this before the cap, so a truncated schema has already had its turn — but a
+ * composition member reached from below the cap has not, and answering an `allOf`-wrapped enum with an
+ * empty string hands back a value that very schema forbids.
+ */
+const getDeclaredValue = (schema) => {
+    if (Array.isArray(schema.examples) && schema.examples.length > 0) {
+        return schema.examples[0];
+    }
+    if (schema.example !== undefined) {
+        return schema.example;
+    }
+    if (schema.default !== undefined) {
+        const normalizedDefault = normalizeSchemaDefault(schema);
+        if (normalizedDefault !== INVALID_DEFAULT) {
+            return normalizedDefault;
+        }
+    }
+    if (schema.const !== undefined) {
+        return schema.const;
+    }
+    if (Array.isArray(schema.enum) && schema.enum.length > 0) {
+        return schema.enum[0];
+    }
+    return undefined;
+};
+/**
+ * Describe a composed schema by the member the walk itself would have rendered.
+ * Returns `undefined` when no member describes a shape.
+ */
+const describeComposition = (schema, options, schemaPath, seen) => {
+    const variant = getSelectedVariant(schema, options, schemaPath);
+    if (variant) {
+        return getMaxDepthValue(variant, options, schemaPath, seen);
+    }
+    if (!Array.isArray(schema.allOf) || schema.allOf.length === 0) {
+        return undefined;
+    }
+    // `allOf` merges every member, so merge their truncated values the same way. Members that describe
+    // nothing contribute nothing rather than clobbering the ones that do.
+    let merged = undefined;
+    let choiceIndex = 0;
+    for (const member of schema.allOf) {
+        const resolved = resolve.schema(member);
+        // Each direct choice member gets its own ordinal in the path, the same way the walk keys them, so
+        // an explicit selection on an `allOf`-wrapped `oneOf` still resolves here.
+        const isChoiceMember = !!resolved && (Array.isArray(resolved.oneOf) || Array.isArray(resolved.anyOf));
+        const memberSchemaPath = isChoiceMember ? [...schemaPath, String(choiceIndex++)] : schemaPath;
+        const value = resolved ? getMaxDepthValue(resolved, options, memberSchemaPath, seen) : undefined;
+        if (value !== undefined && value !== MAX_DEPTH_EXCEEDED) {
+            merged = mergeExamples(merged, value);
+        }
+    }
+    return merged;
+};
+/**
+ * Build the value that stands in for a schema the recursion depth cap cut off.
+ *
+ * The stand-in is still read as an example of the schema it replaced, so a plain string makes the
+ * example contradict its own type: a mock server answering a `type: object` field with
+ * `[Max Depth Exceeded]` hands a strict SDK decoder a body it cannot parse. Describe the declared
+ * type instead, dispatching in the order the walk does, so a truncated value differs from a full render
+ * in having no children. A schema that describes no shape at all keeps the sentinel, which is then the
+ * only signal that truncation happened.
+ *
+ * Two deliberate departures from the walk, both answering with the declared container where the walk
+ * answers `null`: a container spelled as a list (`type: ['object']`, or `['object', 'null']`) is read
+ * here as the container it names, where the walk's strict comparison misses it.
+ *
+ * The value is empty rather than complete: satisfying `required` or `minItems` means descending
+ * again, which is exactly what the cap exists to prevent.
+ */
+const getMaxDepthValue = (schema, options, schemaPath, seen = new Set()) => {
+    // A stated value beats any stand-in, and matches what a full render would have produced.
+    const declared = getDeclaredValue(schema);
+    if (declared !== undefined) {
+        return declared;
+    }
+    const container = getEmptyContainer(schema);
+    if (container !== undefined) {
+        // Children were dropped here, so anything assembled around this value is level-bound too.
+        truncated = true;
+        return container;
+    }
+    // A schema with no children renders the same at every level, so nothing is lost and the cache stays
+    // usable for the rest of the call.
+    const makeUpRandomData = !!options?.emptyString;
+    const primitive = getPrimitiveValue(schema, makeUpRandomData, options?.emptyString);
+    if (primitive !== undefined) {
+        return primitive;
+    }
+    // A wrapper such as `allOf: [$ref]` declares no type of its own, so describe its members instead.
+    // Unwrapping runs outside the walk's own cycle guard, so it carries one: refusing to re-enter a
+    // wrapper already on the path terminates a self-reference without capping how long a legitimate
+    // inheritance chain may be. `seen` holds exactly the path, so its size bounds the stack against a
+    // pathological chain, the way `schemaAllowsValue` bounds its own recursion.
+    const target = getSchemaCacheTarget(schema);
+    if (!seen.has(target) && seen.size < MAX_COMPOSITION_DEPTH) {
+        seen.add(target);
+        const composed = describeComposition(schema, options, schemaPath, seen);
+        seen.delete(target);
+        if (composed !== undefined) {
+            return composed;
+        }
+    }
+    else {
+        // A description declined is never the value a full render would have produced.
+        truncated = true;
+    }
+    const unionPrimitive = getUnionPrimitiveValue(schema, makeUpRandomData, options?.emptyString);
+    if (unionPrimitive !== undefined) {
+        return unionPrimitive;
+    }
+    // A schema that declares `null` has exactly one valid value, which is what the walk falls back to.
+    if (getDeclaredTypes(schema).includes('null')) {
+        return null;
+    }
+    // A composition or a negative constraint none of the above could describe still says something about
+    // the value, and the walk answers both with `null` rather than a value of no particular type.
+    if (isComposed(schema) || 'not' in schema) {
+        return null;
+    }
+    truncated = true;
+    return MAX_DEPTH_EXCEEDED;
+};
 /**
  * Generate an example value from a given OpenAPI SchemaObject.
  *
@@ -601,6 +828,10 @@ const createOptionsCacheKey = (options) => JSON.stringify({
  * @returns An example value for the given schema.
  */
 export const getExampleFromSchema = (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;
+    }
     // Resolve any $ref references to get the actual schema
     const _schema = resolve.schema(schema);
     if (!isDefined(_schema)) {
@@ -645,14 +876,9 @@ export const getExampleFromSchema = (schema, options, { level = 0, parentSchema,
             return cached;
         }
     }
-    // Prevent infinite recursion in circular references
-    if (level > MAX_LEVELS_DEEP) {
-        seen.delete(targetValue);
-        return '[Max Depth Exceeded]';
-    }
     // Determine if we should generate realistic example data
     const makeUpRandomData = !!options?.emptyString;
-    // Early exits for schemas that should not be included (deprecated, readOnly, writeOnly, omitEmptyAndOptionalProperties)
+    // Early exits for schemas that should not be included (deprecated unless opted in, readOnly, writeOnly, omitEmptyAndOptionalProperties)
     if (shouldOmitProperty(_schema, parentSchema, name, options)) {
         seen.delete(targetValue);
         return undefined;
@@ -694,6 +920,14 @@ export const getExampleFromSchema = (schema, options, { level = 0, parentSchema,
         seen.delete(targetValue);
         return cache(_schema, _schema.enum[0], cacheKey, skipCache);
     }
+    // Stop descending once the walk is too deep to keep going, which also breaks circular references.
+    // Everything above still applied, so an explicit example, `const` or `enum` wins here as it would at
+    // any other level; only the children are given up on.
+    if (level > MAX_LEVELS_DEEP) {
+        seen.delete(targetValue);
+        // Deliberately not cached: the value holds only at this level, and the cache key carries none.
+        return getMaxDepthValue(_schema, options, schemaPath);
+    }
     // Handle object types - check for properties to identify objects
     if ('properties' in _schema || ('type' in _schema && _schema.type === 'object')) {
         const result = handleObjectSchema(_schema, options, level, seen, cacheKey, schemaPath, dynamicScope);
@@ -716,7 +950,8 @@ 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);
+        const index = getCompositionSelectionIndex(schemaPath, compositionKeyword, options, discriminate.length) ??
+            getDiscriminatorSelectionIndex(_schema, discriminate, options);
         const candidate = index !== undefined
             ? discriminate[index]
             : discriminate.find((item) => {

package/dist/request-example/builder/helpers/get-example.d.ts

@@ -1,4 +1,4 @@
-import type { ExampleObject, MediaTypeObject, ParameterObject, RequestBodyObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+import type { ExampleObject, MediaTypeObject, ParameterObject, RequestBodyObject } from '@scalar/workspace-store/schemas/v3.2/strict/openapi-document';
 /**
  * Resolve an example value for a parameter or requestBody from either `examples` or `content.*.examples`.
  * Or the [deprecated] `example` field.

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

@@ -1,7 +1,7 @@
 import { getResolvedRef } from '../../../helpers/get-resolved-ref.js';
 /** Helper to get example from examples object with fallback to example field */
 const getExampleFromExamples = (examples, exampleField, exampleName) => {
-    if (!examples && !exampleField) {
+    if (!examples && exampleField === undefined) {
         return undefined;
     }
     const hasExamples = !!examples && Object.keys(examples).length > 0;
@@ -43,7 +43,7 @@ export const getExample = (param, exampleName, contentType) => {
     }
     // Derive value from the schema
     const resolvedParam = getResolvedRef(param);
-    if ('schema' in resolvedParam && resolvedParam.schema) {
+    if (resolvedParam && 'schema' in resolvedParam && resolvedParam.schema) {
         const schema = resolvedParam.schema;
         // Default value
         if ('default' in schema && schema.default !== undefined) {

package/dist/request-example/builder/helpers/get-resolved-url.d.ts

@@ -1,4 +1,4 @@
-import type { ServerObject } from '../../../schemas/v3.1/strict/server.js';
+import type { ServerObject } from '../../../schemas/v3.2/strict/server.js';
 /**
  * Resolves the full request URL by:
  * 1. Applying OpenAPI server variables to the server URL template.

package/dist/request-example/builder/helpers/get-server-variables.d.ts

@@ -1,4 +1,4 @@
-import type { ServerObject } from '../../../schemas/v3.1/strict/server.js';
+import type { ServerObject } from '../../../schemas/v3.2/strict/server.js';
 /**
  * Extracts the default values of variables defined in a ServerObject into a simple key-value map.
  * Ignores variables with no default value.

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

@@ -2,6 +2,7 @@ export { getExampleFromBody, getSchemaExampleFromBody } from './body/get-request
 export { getSelectedBodyContentType } from './body/get-selected-body-content-type.js';
 export { buildDottedNestedRowPredicate, coerceLeafValueToSchemaType, coerceUntypedValue, resolveLeafSchema, } from './body/schema-value-coercion.js';
 export { type SerializedFormProperty, serializeFormPropertyWithEncoding } from './body/serialize-form-property.js';
+export { serializeMultipartArray } from './body/serialize-multipart-array.js';
 export { BUILD_REQUEST_FAILED, type BuildRequestData, type BuildRequestFailureCode, type BuildRequestResult, type RequestPayload, buildRequest, resolveExecutableRequestUrl, } from './build-request.js';
 export { deSerializeParameter, deSerializeSchemaValue } from './header/de-serialize-parameter.js';
 export { filterGlobalCookie } from './header/filter-global-cookies.js';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/request-example/builder/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAA;AAC9F,OAAO,EAAE,0BAA0B,EAAE,MAAM,uCAAuC,CAAA;AAClF,OAAO,EACL,6BAA6B,EAC7B,2BAA2B,EAC3B,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,KAAK,sBAAsB,EAAE,iCAAiC,EAAE,MAAM,gCAAgC,CAAA;AAC/G,OAAO,EACL,oBAAoB,EACpB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,YAAY,EACZ,2BAA2B,GAC5B,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAA;AAC9F,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAC5D,OAAO,EACL,qBAAqB,EACrB,wBAAwB,EACxB,kBAAkB,EAClB,4BAA4B,EAC5B,2BAA2B,EAC3B,oBAAoB,EACpB,4BAA4B,GAC7B,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAA;AAC7E,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAClD,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAA;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AACnE,YAAY,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EACL,2BAA2B,EAC3B,2BAA2B,EAC3B,KAAK,6BAA6B,EAClC,KAAK,8BAA8B,EACnC,wBAAwB,GACzB,MAAM,+BAA+B,CAAA;AACtC,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAA;AACzF,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAA;AACxE,YAAY,EACV,kBAAkB,EAClB,sBAAsB,EACtB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,gCAAgC,EAChC,gCAAgC,EAChC,uBAAuB,EACvB,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EACzB,gBAAgB,EAChB,0BAA0B,EAC1B,gBAAgB,GACjB,MAAM,yBAAyB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/request-example/builder/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAA;AAC9F,OAAO,EAAE,0BAA0B,EAAE,MAAM,uCAAuC,CAAA;AAClF,OAAO,EACL,6BAA6B,EAC7B,2BAA2B,EAC3B,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,KAAK,sBAAsB,EAAE,iCAAiC,EAAE,MAAM,gCAAgC,CAAA;AAC/G,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAA;AAC1E,OAAO,EACL,oBAAoB,EACpB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,YAAY,EACZ,2BAA2B,GAC5B,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAA;AAC9F,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAC5D,OAAO,EACL,qBAAqB,EACrB,wBAAwB,EACxB,kBAAkB,EAClB,4BAA4B,EAC5B,2BAA2B,EAC3B,oBAAoB,EACpB,4BAA4B,GAC7B,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAA;AAC7E,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAClD,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAA;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AACnE,YAAY,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EACL,2BAA2B,EAC3B,2BAA2B,EAC3B,KAAK,6BAA6B,EAClC,KAAK,8BAA8B,EACnC,wBAAwB,GACzB,MAAM,+BAA+B,CAAA;AACtC,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAA;AACzF,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAA;AACxE,YAAY,EACV,kBAAkB,EAClB,sBAAsB,EACtB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,gCAAgC,EAChC,gCAAgC,EAChC,uBAAuB,EACvB,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EACzB,gBAAgB,EAChB,0BAA0B,EAC1B,gBAAgB,GACjB,MAAM,yBAAyB,CAAA"}

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

@@ -2,6 +2,7 @@ export { getExampleFromBody, getSchemaExampleFromBody } from './body/get-request
 export { getSelectedBodyContentType } from './body/get-selected-body-content-type.js';
 export { buildDottedNestedRowPredicate, coerceLeafValueToSchemaType, coerceUntypedValue, resolveLeafSchema, } from './body/schema-value-coercion.js';
 export { serializeFormPropertyWithEncoding } from './body/serialize-form-property.js';
+export { serializeMultipartArray } from './body/serialize-multipart-array.js';
 export { BUILD_REQUEST_FAILED, buildRequest, resolveExecutableRequestUrl, } from './build-request.js';
 export { deSerializeParameter, deSerializeSchemaValue } from './header/de-serialize-parameter.js';
 export { filterGlobalCookie } from './header/filter-global-cookies.js';

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

@@ -1,7 +1,7 @@
 import type { XScalarEnvironment } from '@scalar/workspace-store/schemas/extensions/document/x-scalar-environments';
 import type { XScalarCookie } from '@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies';
-import type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
-import type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/operation';
+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 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';

package/dist/request-example/builder/security/broker-scheme-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"broker-scheme-types.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/security/broker-scheme-types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,2FAA2F;AAC3F,QAAA,MAAM,iBAAiB,kEAAmE,CAAA;AAE1F,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAA;AAE/D,eAAO,MAAM,gBAAgB,GAAI,MAAM,MAAM,GAAG,SAAS,KAAG,IAAI,IAAI,cACO,CAAA;AAE3E,qDAAqD;AACrD,QAAA,MAAM,uBAAuB,0DAA2D,CAAA;AAExF,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAA;AAE3E,eAAO,MAAM,sBAAsB,GAAI,MAAM,MAAM,GAAG,SAAS,KAAG,IAAI,IAAI,oBACO,CAAA"}
+{"version":3,"file":"broker-scheme-types.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/security/broker-scheme-types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,2FAA2F;AAC3F,QAAA,MAAM,iBAAiB,kEAAmE,CAAA;AAE1F,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAA;AAE/D,eAAO,MAAM,gBAAgB,GAAI,MAAM,MAAM,GAAG,SAAS,KAAG,IAAI,IAAI,cACP,CAAA;AAE7D,qDAAqD;AACrD,QAAA,MAAM,uBAAuB,0DAA2D,CAAA;AAExF,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAA;AAE3E,eAAO,MAAM,sBAAsB,GAAI,MAAM,MAAM,GAAG,SAAS,KAAG,IAAI,IAAI,oBACP,CAAA"}

package/dist/request-example/builder/security/broker-scheme-types.js

@@ -6,7 +6,7 @@
  */
 /** SASL-style broker schemes: all of them authenticate with a username + password pair. */
 const SASL_SCHEME_TYPES = ['userPassword', 'plain', 'scramSha256', 'scramSha512'];
-export const isSaslSchemeType = (type) => Boolean(type) && SASL_SCHEME_TYPES.includes(type);
+export const isSaslSchemeType = (type) => SASL_SCHEME_TYPES.some((schemeType) => schemeType === type);
 /** Encryption broker schemes: a single key value. */
 const ENCRYPTION_SCHEME_TYPES = ['symmetricEncryption', 'asymmetricEncryption'];
-export const isEncryptionSchemeType = (type) => Boolean(type) && ENCRYPTION_SCHEME_TYPES.includes(type);
+export const isEncryptionSchemeType = (type) => ENCRYPTION_SCHEME_TYPES.some((schemeType) => schemeType === type);

package/dist/request-example/builder/security/build-request-security.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"build-request-security.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/security/build-request-security.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,iDAAiD,CAAA;AAEjG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,8DAA8D;IAC9D,EAAE,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;IACjC,2EAA2E;IAC3E,IAAI,EAAE,MAAM,CAAA;IACZ,2EAA2E;IAC3E,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAA;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,oBAAoB;AAC/B,4DAA4D;AAC5D,yBAAyB,0BAA0B,EAAE;AACrD,qEAAqE;AACrE,8BAA0B,KACzB,0BAA0B,EA6F5B,CAAA"}
+{"version":3,"file":"build-request-security.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/security/build-request-security.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,iDAAiD,CAAA;AAEjG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,8DAA8D;IAC9D,EAAE,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;IACjC,2EAA2E;IAC3E,IAAI,EAAE,MAAM,CAAA;IACZ,2EAA2E;IAC3E,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAA;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,oBAAoB;AAC/B,4DAA4D;AAC5D,yBAAyB,0BAA0B,EAAE;AACrD,qEAAqE;AACrE,8BAA0B,KACzB,0BAA0B,EA4F5B,CAAA"}

package/dist/request-example/builder/security/build-request-security.js

@@ -12,26 +12,25 @@ emptyTokenPlaceholder = '') => {
     selectedSecuritySchemes.forEach((scheme) => {
         // Api key
         if (scheme.type === 'apiKey') {
-            const name = scheme.name;
             const value = scheme['x-scalar-secret-token'] || emptyTokenPlaceholder;
             if (scheme.in === 'header') {
                 return result.push({
                     in: scheme.in,
-                    name,
+                    name: scheme.name,
                     value,
                 });
             }
             if (scheme.in === 'query') {
                 return result.push({
                     in: 'query',
-                    name,
+                    name: scheme.name,
                     value,
                 });
             }
             if (scheme.in === 'cookie') {
                 return result.push({
                     in: 'cookie',
-                    name,
+                    name: scheme.name,
                     value,
                 });
             }