@scalar/workspace-store 0.63.0 → 0.65.0

package/dist/request-example/builder/body/build-multipart.js

@@ -0,0 +1,191 @@
+import { parseMimeType } from '@scalar/helpers/http/mime-type';
+import { isObject } from '@scalar/helpers/object/is-object';
+import { getResolvedRef, mergeSiblingReferences } from '@scalar/workspace-store/helpers/get-resolved-ref';
+import { unpackProxyObject } from '@scalar/workspace-store/helpers/unpack-proxy';
+import { isArraySchema } from '@scalar/workspace-store/schemas/v3.2/strict/type-guards';
+import { serializeXmlPart } from '../../xml/serialize-xml-part.js';
+import { MAX_MULTIPART_NESTING } from './multipart-limits.js';
+import { resolveLeafSchema } from './schema-value-coercion.js';
+import { hasEncodingStyle, serializeFormPropertyWithEncoding } from './serialize-form-property.js';
+/** Identify ordered multipart independently of the editor's row representation. */
+export const isPositionalMultipart = (contentType, media) => {
+    const schema = getResolvedRef(media.schema);
+    return (parseMimeType(contentType).essence !== 'multipart/form-data' ||
+        media.prefixEncoding !== undefined ||
+        media.itemEncoding !== undefined ||
+        (schema !== undefined && isArraySchema(schema)) ||
+        media.itemSchema !== undefined);
+};
+/** Whether a media type needs ordered or nested multipart serialization. */
+export const needsMultipartEncoding = (contentType, media) => {
+    const mime = parseMimeType(contentType);
+    return (mime.type === 'multipart' &&
+        (isPositionalMultipart(contentType, media) ||
+            Object.values(media.encoding ?? {}).some((encoding) => parseMimeType(encoding.contentType).type === 'multipart' || encoding.encoding !== undefined)));
+};
+const defaultContentType = (schema, value) => {
+    if (value instanceof Blob) {
+        return value.type || 'application/octet-stream';
+    }
+    // OpenAPI 3.2.1 Encoding Object defaults explicitly treat absent type as binary.
+    // With no schema at all, infer from the example so existing editor values remain usable.
+    if (schema && (!('type' in schema) || !schema.type || (schema.type === 'string' && schema.contentEncoding))) {
+        return 'application/octet-stream';
+    }
+    return typeof value === 'object' && value !== null ? 'application/json' : 'text/plain';
+};
+/** Encoding accepts ranges, but each wire header needs a single concrete media type. */
+const selectContentType = (encoding, schema, value) => {
+    const fallback = defaultContentType(schema, value);
+    if (!encoding) {
+        return fallback;
+    }
+    if (/[\r\n\0]/.test(encoding)) {
+        throw new Error('Invalid multipart content type');
+    }
+    const choices = encoding.split(',').map((choice) => choice.trim());
+    const preferred = parseMimeType(fallback);
+    const match = choices.find((choice) => {
+        const mime = parseMimeType(choice);
+        return ((mime.type === '*' || mime.type === preferred.type) &&
+            (mime.subtype === '*' || mime.subtype === preferred.subtype));
+    });
+    if (match) {
+        const mime = parseMimeType(match);
+        if (!mime.essence.includes('*')) {
+            return match;
+        }
+        // Keep parameters from the range while replacing only its wildcard essence.
+        return match.replace(/^[^;]+/, preferred.essence);
+    }
+    // A nonmatching range cannot supply a concrete wire type; keep the inferred fallback.
+    return choices.find((choice) => !parseMimeType(choice).essence.includes('*')) ?? fallback;
+};
+/** Resolve a positional item's schema independently of the encoding prefix length. */
+export const getMultipartItemSchema = (schema, index, itemSchema) => getResolvedRef((schema && 'prefixItems' in schema ? schema.prefixItems?.[index] : undefined) ??
+    (schema && 'items' in schema ? schema.items : undefined) ??
+    itemSchema, mergeSiblingReferences);
+/** Serialize structured values to the selected part format; strings already containing XML stay intact. */
+const serializePartValue = (value, contentType, schema) => {
+    const subtype = contentType ? parseMimeType(contentType).subtype : undefined;
+    if ((subtype === 'xml' || subtype?.endsWith('+xml')) && isObject(value)) {
+        return serializeXmlPart(value, schema);
+    }
+    const json = subtype === 'json' || subtype?.endsWith('+json');
+    return json || (value !== null && typeof value === 'object')
+        ? JSON.stringify(unpackProxyObject(value))
+        : String(value ?? '');
+};
+/** Build ordered parts, applying prefix encodings independently of schema prefix lengths. */
+export const buildMultipart = (value, contentType, encoding = {}, schema, nesting = 0) => {
+    if (nesting >= MAX_MULTIPART_NESTING) {
+        throw new Error('Maximum multipart nesting exceeded');
+    }
+    const named = parseMimeType(contentType).essence === 'multipart/form-data';
+    const positional = Array.isArray(value);
+    const entries = positional
+        ? value.map((item, index) => {
+            const itemEncoding = index < (encoding.prefixEncoding?.length ?? 0) ? encoding.prefixEncoding?.[index] : encoding.itemEncoding;
+            const itemSchema = getMultipartItemSchema(schema, index, encoding.itemSchema);
+            if (named && item !== null && typeof item === 'object' && !Array.isArray(item)) {
+                // Each position describes one named part; accepting more keys would silently discard data.
+                const entries = Object.entries(item);
+                const entry = entries[0];
+                if (entries.length !== 1 || !entry) {
+                    throw new Error('Named positional multipart items must contain exactly one property');
+                }
+                return [entry[0], entry[1], itemEncoding, resolveLeafSchema(itemSchema, [entry[0]])];
+            }
+            return [undefined, item, itemEncoding, itemSchema];
+        })
+        : value !== null && typeof value === 'object'
+            ? Object.entries(value).flatMap(([key, item]) => {
+                const propertySchema = resolveLeafSchema(schema, [key]);
+                return (Array.isArray(item) ? item : [item]).map((part) => [
+                    key,
+                    part,
+                    encoding.encoding?.[key],
+                    Array.isArray(item)
+                        ? getResolvedRef(propertySchema && isArraySchema(propertySchema) ? propertySchema.items : undefined, mergeSiblingReferences)
+                        : propertySchema,
+                ]);
+            })
+            : [];
+    return entries.flatMap(([key, item, partEncoding, partSchema]) => {
+        const style = named && hasEncodingStyle(partEncoding);
+        const styleParts = style ? serializeFormPropertyWithEncoding(key ?? '', item, partEncoding) : null;
+        const partContentType = style ? undefined : selectContentType(partEncoding?.contentType, partSchema, item);
+        const headers = Object.fromEntries(Object.entries(partEncoding?.headers ?? {}).flatMap(([name, ref]) => {
+            if (name.toLowerCase() === 'content-type') {
+                return [];
+            }
+            const header = getResolvedRef(ref);
+            if (!header || !('schema' in header)) {
+                return [];
+            }
+            const headerSchema = getResolvedRef(header.schema);
+            const example = header?.example ??
+                getResolvedRef(Object.values(header?.examples ?? {})[0])?.value ??
+                headerSchema?.const ??
+                headerSchema?.default;
+            return example === undefined ? [] : [[name, String(example)]];
+        }));
+        if (partSchema?.contentEncoding &&
+            !Object.keys(headers).some((name) => name.toLowerCase() === 'content-transfer-encoding')) {
+            headers['Content-Transfer-Encoding'] = partSchema.contentEncoding;
+        }
+        const metadata = {
+            ...(key === undefined ? {} : { key }),
+            ...(partContentType ? { contentType: partContentType } : {}),
+            ...(Object.keys(headers).length ? { headers } : {}),
+        };
+        if (styleParts) {
+            return styleParts.map((part) => ({ ...metadata, type: 'text', ...part }));
+        }
+        if (partContentType &&
+            parseMimeType(partContentType).type === 'multipart' &&
+            typeof item !== 'string' &&
+            !(item instanceof Blob)) {
+            return [
+                {
+                    ...metadata,
+                    type: 'multipart',
+                    contentType: partContentType,
+                    value: buildMultipart(item, partContentType, partEncoding, partSchema, nesting + 1),
+                },
+            ];
+        }
+        if (partContentType &&
+            parseMimeType(partContentType).essence === 'application/x-www-form-urlencoded' &&
+            item !== null &&
+            typeof item === 'object') {
+            const params = Object.entries(item).flatMap(([name, fieldValue]) => (Array.isArray(fieldValue) ? fieldValue : [fieldValue]).flatMap((field) => {
+                const fieldEncoding = partEncoding?.encoding?.[name];
+                const styled = serializeFormPropertyWithEncoding(name, field, fieldEncoding);
+                if (styled) {
+                    return styled;
+                }
+                return [
+                    {
+                        key: name,
+                        value: serializePartValue(field, hasEncodingStyle(fieldEncoding) ? undefined : fieldEncoding?.contentType),
+                    },
+                ];
+            }));
+            return [
+                {
+                    ...metadata,
+                    type: 'text',
+                    value: new URLSearchParams(params.map((part) => [part.key, part.value])).toString(),
+                },
+            ];
+        }
+        if (item instanceof File) {
+            return [{ ...metadata, type: 'file', value: unpackProxyObject(item) }];
+        }
+        if (item instanceof Blob) {
+            return [{ ...metadata, type: 'blob', value: unpackProxyObject(item) }];
+        }
+        return [{ ...metadata, type: 'text', value: serializePartValue(item, partContentType, partSchema) }];
+    });
+};

package/dist/request-example/builder/body/build-request-body.d.ts

@@ -1,4 +1,5 @@
 import type { RequestBodyObject } from '@scalar/workspace-store/schemas/v3.2/strict/request-body';
+import { type MultipartPart } from './build-multipart.js';
 type FormData = {
     mode: 'formdata';
     value: ({
@@ -30,7 +31,11 @@ type Raw = {
     value: string | File | Blob;
     contentType?: string;
 };
-export type RequestBody = FormData | UrlEncoded | Raw;
+export type RequestBody = FormData | UrlEncoded | Raw | {
+    mode: 'multipart';
+    contentType: string;
+    value: MultipartPart[];
+};
 /**
  * Create the fetch request body
  */

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

@@ -1 +1 @@
-{"version":3,"file":"build-request-body.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/body/build-request-body.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0DAA0D,CAAA;AASjG,KAAK,QAAQ,GAAG;IACd,IAAI,EAAE,UAAU,CAAA;IAChB,KAAK,EAAE,CACH;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,MAAM,CAAA;QACb,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,GACD;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,IAAI,CAAA;QACX,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,GACD;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,IAAI,CAAA;QACX,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,CACJ,EAAE,CAAA;CACJ,CAAA;AAwBD,KAAK,UAAU,GAAG;IAChB,IAAI,EAAE,YAAY,CAAA;IAClB,KAAK,EAAE;QACL,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,MAAM,CAAA;KACd,EAAE,CAAA;CACJ,CAAA;AAED,KAAK,GAAG,GAAG;IACT,IAAI,EAAE,KAAK,CAAA;IACX,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,UAAU,GAAG,GAAG,CAAA;AAKrD;;GAEG;AACH,eAAO,MAAM,gBAAgB,GAC3B,aAAa,iBAAiB,GAAG,SAAS;AAC1C,qCAAqC;AACrC,oBAAuB;AACvB,sEAAsE;AACtE,kCAAkC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KACvD,WAAW,GAAG,IAuUhB,CAAA"}
+{"version":3,"file":"build-request-body.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/body/build-request-body.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0DAA0D,CAAA;AAKjG,OAAO,EACL,KAAK,aAAa,EAKnB,MAAM,mBAAmB,CAAA;AAO1B,KAAK,QAAQ,GAAG;IACd,IAAI,EAAE,UAAU,CAAA;IAChB,KAAK,EAAE,CACH;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,MAAM,CAAA;QACb,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,GACD;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,IAAI,CAAA;QACX,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,GACD;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,IAAI,CAAA;QACX,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,CACJ,EAAE,CAAA;CACJ,CAAA;AAwBD,KAAK,UAAU,GAAG;IAChB,IAAI,EAAE,YAAY,CAAA;IAClB,KAAK,EAAE;QACL,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,MAAM,CAAA;KACd,EAAE,CAAA;CACJ,CAAA;AAED,KAAK,GAAG,GAAG;IACT,IAAI,EAAE,KAAK,CAAA;IACX,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,WAAW,GACnB,QAAQ,GACR,UAAU,GACV,GAAG,GACH;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,WAAW,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,aAAa,EAAE,CAAA;CAAE,CAAA;AA2CtE;;GAEG;AACH,eAAO,MAAM,gBAAgB,GAC3B,aAAa,iBAAiB,GAAG,SAAS;AAC1C,qCAAqC;AACrC,oBAAuB;AACvB,sEAAsE;AACtE,kCAAkC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KACvD,WAAW,GAAG,IA8WhB,CAAA"}

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

@@ -1,9 +1,12 @@
 // import { replaceEnvVariables } from '@scalar/helpers/regex/replace-variables'
+import { parseMimeType } from '@scalar/helpers/http/mime-type';
 import { isObject } from '@scalar/helpers/object/is-object';
 import { setValueAtPath } from '@scalar/helpers/object/set-value-at-path';
 import { getResolvedRef, mergeSiblingReferences } from '@scalar/workspace-store/helpers/get-resolved-ref';
 import { unpackProxyObject } from '@scalar/workspace-store/helpers/unpack-proxy';
 import { isObjectSchema } from '@scalar/workspace-store/schemas/v3.2/strict/type-guards';
+import { getExampleValue, getExplicitExampleText } from '../../../helpers/get-example-value.js';
+import { buildMultipart, getMultipartItemSchema, isPositionalMultipart, needsMultipartEncoding, } from './build-multipart.js';
 import { getExampleFromBody } from './get-request-body-example.js';
 import { getSelectedBodyContentType } from './get-selected-body-content-type.js';
 import { buildDottedNestedRowPredicate, coerceLeafValueToSchemaType, resolveLeafSchema } from './schema-value-coercion.js';
@@ -30,6 +33,33 @@ const toMultipartPart = (part) => {
     };
 };
 const getMultipartEncodingContentType = (requestBody, bodyContentType, fieldName) => requestBody.content[bodyContentType]?.encoding?.[fieldName]?.contentType;
+/** Preserve schema-backed nested objects and repeated flat fields from form editor rows. */
+const regroupMultipartRows = (rows, multipartSchema) => {
+    const isDottedNestedRow = buildDottedNestedRowPredicate(multipartSchema);
+    const entries = [];
+    const regroupedByTopKey = new Map();
+    for (const row of rows) {
+        if (!isDottedNestedRow(row.name, row.value)) {
+            entries.push(row);
+            continue;
+        }
+        const segments = row.name.split('.');
+        const topKey = segments[0];
+        if (!topKey) {
+            continue;
+        }
+        let target = regroupedByTopKey.get(topKey);
+        if (!target) {
+            target = {};
+            regroupedByTopKey.set(topKey, target);
+            entries.push({ name: topKey, value: target });
+        }
+        // The form table stringifies leaf values; restore the schema-declared type so the
+        // regrouped JSON part keeps booleans/numbers/arrays instead of string-typing them.
+        setValueAtPath(target, segments.slice(1), coerceLeafValueToSchemaType(row.value, resolveLeafSchema(multipartSchema, segments)));
+    }
+    return entries;
+};
 /**
  * Create the fetch request body
  */
@@ -51,6 +81,10 @@ requestBodyCompositionSelection) => {
     if (!example) {
         return null;
     }
+    const explicitText = getExplicitExampleText(getExampleValue(example), bodyContentType);
+    if (explicitText !== undefined) {
+        return { mode: 'raw', value: explicitText, contentType: bodyContentType };
+    }
     // Optional body properties default to "not sent", matching how optional parameters are
     // dropped by `isParamDisabled`. We only know a property is optional when the body has an
     // object schema that declares it outside `required`, so undeclared and required keys are
@@ -67,6 +101,51 @@ requestBodyCompositionSelection) => {
     // `Object.hasOwn` (not `in`) so an undeclared key named like an `Object.prototype` member
     // (`toString`, `constructor`, …) is not misread as declared-and-optional and dropped.
     const isOptionalBodyProperty = (key) => Boolean(bodyProperties && Object.hasOwn(bodyProperties, key) && !requiredBodyProperties.has(key));
+    const media = requestBody.content[bodyContentType];
+    if (media && needsMultipartEncoding(bodyContentType, media)) {
+        // Raw editors store JSON text, while form editors store named rows.
+        const value = (() => {
+            if (typeof example.value !== 'string') {
+                return example.value;
+            }
+            try {
+                return JSON.parse(example.value);
+            }
+            catch {
+                return example.value;
+            }
+        })();
+        // Already serialized payloads and uploaded bodies retain their bytes.
+        if (typeof value === 'string' || value instanceof Blob) {
+            return { mode: 'raw', value, contentType: bodyContentType };
+        }
+        const positional = isPositionalMultipart(bodyContentType, media);
+        const orderedValue = positional && parseMimeType(bodyContentType).essence === 'multipart/form-data' && Array.isArray(value)
+            ? value
+                .filter((item) => !(isObject(item) && typeof item.name === 'string' && 'value' in item && item.isDisabled))
+                .map((item, index) => {
+                if (!isObject(item) || typeof item.name !== 'string' || !('value' in item)) {
+                    return item;
+                }
+                const itemSchema = getMultipartItemSchema(resolvedBodySchema, index, media.itemSchema);
+                return {
+                    [item.name]: coerceLeafValueToSchemaType(item.value, resolveLeafSchema(itemSchema, [item.name])),
+                };
+            })
+            : value;
+        const multipartParts = !positional && Array.isArray(value)
+            ? regroupMultipartRows(value.filter((row) => !row.isDisabled), resolvedBodySchema).flatMap((row) => buildMultipart({
+                [row.name]: coerceLeafValueToSchemaType(row.value, resolveLeafSchema(resolvedBodySchema, [row.name])),
+            }, bodyContentType, media, resolvedBodySchema))
+            : buildMultipart(!positional && isObject(value)
+                ? Object.fromEntries(Object.entries(value).filter(([key]) => !isOptionalBodyProperty(key)))
+                : orderedValue, bodyContentType, media, resolvedBodySchema);
+        return {
+            mode: 'multipart',
+            contentType: bodyContentType,
+            value: multipartParts,
+        };
+    }
     // Form data - array format (from UI editor)
     if ((bodyContentType === 'multipart/form-data' || bodyContentType === 'application/x-www-form-urlencoded') &&
         Array.isArray(example.value)) {
@@ -95,29 +174,7 @@ requestBodyCompositionSelection) => {
         const multipartSchema = result.mode === 'formdata'
             ? getResolvedRef(requestBody.content[bodyContentType]?.schema, mergeSiblingReferences)
             : undefined;
-        const isDottedNestedRow = result.mode === 'formdata' ? buildDottedNestedRowPredicate(multipartSchema) : () => false;
-        const entries = [];
-        const regroupedByTopKey = new Map();
-        for (const row of exampleValue) {
-            if (!isDottedNestedRow(row.name, row.value)) {
-                entries.push(row);
-                continue;
-            }
-            const segments = row.name.split('.');
-            const topKey = segments[0];
-            if (!topKey) {
-                continue;
-            }
-            let target = regroupedByTopKey.get(topKey);
-            if (!target) {
-                target = {};
-                regroupedByTopKey.set(topKey, target);
-                entries.push({ name: topKey, value: target });
-            }
-            // The form table stringifies leaf values; restore the schema-declared type so the
-            // regrouped JSON part keeps booleans/numbers/arrays instead of string-typing them.
-            setValueAtPath(target, segments.slice(1), coerceLeafValueToSchemaType(row.value, resolveLeafSchema(multipartSchema, segments)));
-        }
+        const entries = result.mode === 'formdata' ? regroupMultipartRows(exampleValue, multipartSchema) : exampleValue;
         // Loop over all entries and add them to the form
         entries.forEach(({ name, value }) => {
             if (!name) {

package/dist/request-example/builder/body/encode-multipart-body.d.ts

@@ -1,9 +1,9 @@
-import type { RequestBody } from './build-request-body.js';
-/**
- * Encode typed text fields without turning them into file uploads.
- * Blob parts retain binary bytes and keep request construction synchronous.
- */
-export declare const encodeMultipartBody: (parts: Extract<RequestBody, {
-    mode: "formdata";
-}>["value"]) => Blob;
+import type { MultipartPart } from './build-multipart.js';
+/** Serialize nested multipart bodies for both fetch and synchronous code snippets. */
+export declare const serializeMultipartBody: (parts: MultipartPart[], contentType?: string, replace?: (value: string) => string, nesting?: number) => {
+    chunks: BlobPart[];
+    contentType: string;
+};
+/** Encode multipart parts without losing binary bytes or assigning filenames to typed text. */
+export declare const encodeMultipartBody: (parts: MultipartPart[], contentType?: string, replace?: (value: string) => string) => Blob;
 //# sourceMappingURL=encode-multipart-body.d.ts.map

package/dist/request-example/builder/body/encode-multipart-body.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"encode-multipart-body.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/body/encode-multipart-body.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAUvD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,GAAI,OAAO,OAAO,CAAC,WAAW,EAAE;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC,CAAC,OAAO,CAAC,KAAG,IAqBhG,CAAA"}
+{"version":3,"file":"encode-multipart-body.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/body/encode-multipart-body.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AA0BtD,sFAAsF;AACtF,eAAO,MAAM,sBAAsB,GACjC,OAAO,aAAa,EAAE,EACtB,oBAAmC,EACnC,UAAS,CAAC,KAAK,EAAE,MAAM,KAAK,MAAyB,EACrD,gBAAW,KACV;IAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CA6C3C,CAAA;AAED,+FAA+F;AAC/F,eAAO,MAAM,mBAAmB,GAC9B,OAAO,aAAa,EAAE,EACtB,oBAAmC,EACnC,UAAU,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,KAClC,IAGF,CAAA"}

package/dist/request-example/builder/body/encode-multipart-body.js

@@ -1,29 +1,67 @@
+import { parseMimeType } from '@scalar/helpers/http/mime-type';
+import { MAX_MULTIPART_NESTING } from './multipart-limits.js';
 /** Escape disposition parameters using the same percent escapes as browser form submissions. */
 const escapeParameter = (value) => value
     .replace(/\r\n|\r|\n/g, '\r\n')
     .replace(/\r/g, '%0D')
     .replace(/\n/g, '%0A')
     .replace(/"/g, '%22');
-/**
- * Encode typed text fields without turning them into file uploads.
- * Blob parts retain binary bytes and keep request construction synchronous.
- */
-export const encodeMultipartBody = (parts) => {
-    // getRandomValues also works on HTTP playgrounds, where randomUUID is unavailable.
-    const random = crypto.getRandomValues(new Uint8Array(24));
-    const boundary = `----scalar-${Array.from(random, (byte) => byte.toString(16).padStart(2, '0')).join('')}`;
-    const chunks = parts.flatMap((part) => {
+/** Keep equal-length boundaries distinct from nested delimiters and resolved text. */
+const createBoundary = (chunks) => {
+    const text = chunks.filter((chunk) => typeof chunk === 'string').join('');
+    for (const _attempt of Array.from({ length: 10 })) {
+        // getRandomValues also works on HTTP playgrounds, where randomUUID is unavailable.
+        // Binary blobs stay untouched; 192 random bits make accidental byte collisions negligible.
+        const random = crypto.getRandomValues(new Uint8Array(24));
+        const boundary = `----scalar-${Array.from(random, (byte) => byte.toString(16).padStart(2, '0')).join('')}`;
+        if (!text.includes(boundary)) {
+            return boundary;
+        }
+    }
+    throw new Error('Unable to generate a distinct multipart boundary');
+};
+/** Serialize nested multipart bodies for both fetch and synchronous code snippets. */
+export const serializeMultipartBody = (parts, contentType = 'multipart/form-data', replace = (value) => value, nesting = 0) => {
+    if (nesting >= MAX_MULTIPART_NESTING) {
+        throw new Error('Maximum multipart nesting exceeded');
+    }
+    if (/[\r\n\0]/.test(contentType)) {
+        throw new Error('Invalid multipart content type');
+    }
+    const mime = parseMimeType(contentType);
+    const partsChunks = parts.map((part) => {
+        const encoded = part.type === 'multipart'
+            ? serializeMultipartBody(part.value, part.contentType, replace, nesting + 1)
+            : { chunks: [part.type === 'text' ? replace(part.value) : part.value], contentType: part.contentType };
         const filename = part.type === 'file' ? part.value.name : part.type === 'blob' ? 'blob' : undefined;
-        const contentType = part.contentType ?? (part.type === 'text' ? undefined : part.value.type || 'application/octet-stream');
-        // A media type comes from the API description and must never inject part headers.
-        if (contentType && /[\r\n\0]/.test(contentType)) {
+        const partContentType = encoded.contentType ??
+            (part.type === 'file' || part.type === 'blob' ? part.value.type || 'application/octet-stream' : undefined);
+        if (partContentType && /[\r\n\0]/.test(partContentType)) {
             throw new Error('Invalid multipart content type');
         }
-        const disposition = `Content-Disposition: form-data; name="${escapeParameter(part.key)}"${filename === undefined ? '' : `; filename="${escapeParameter(filename)}"`}`;
-        const headers = `--${boundary}\r\n${disposition}\r\n${contentType ? `Content-Type: ${contentType}\r\n` : ''}\r\n`;
-        // Match native FormData line endings for ordinary text; explicitly typed data keeps its bytes.
-        const value = part.type === 'text' && !part.contentType ? part.value.replace(/\r\n|\r|\n/g, '\r\n') : part.value;
-        return [headers, value, '\r\n'];
+        const disposition = part.key === undefined
+            ? ''
+            : `Content-Disposition: form-data; name="${escapeParameter(replace(part.key))}"${filename === undefined ? '' : `; filename="${escapeParameter(filename)}"`}\r\n`;
+        const extraHeaders = Object.entries(part.headers ?? {})
+            .map(([name, value]) => {
+            const resolved = replace(value);
+            if (!/^[!#$%&'*+.^_`|~0-9A-Za-z-]+$/.test(name) || /[\r\n\0]/.test(resolved)) {
+                throw new Error('Invalid multipart header');
+            }
+            return name.toLowerCase() === 'content-type' ? '' : `${name}: ${resolved}\r\n`;
+        })
+            .join('');
+        const headers = `${disposition}${partContentType ? `Content-Type: ${partContentType}\r\n` : ''}${extraHeaders}\r\n`;
+        const chunks = encoded.chunks.map((value) => typeof value === 'string' && !part.contentType ? value.replace(/\r\n|\r|\n/g, '\r\n') : value);
+        return [headers, ...chunks, '\r\n'];
     });
-    return new Blob([...chunks, `--${boundary}--\r\n`], { type: `multipart/form-data; boundary=${boundary}` });
+    const boundary = createBoundary(partsChunks.flat());
+    mime.parameters.set('boundary', boundary);
+    const chunks = partsChunks.flatMap((part) => [`--${boundary}\r\n`, ...part]);
+    return { chunks: [...chunks, `--${boundary}--\r\n`], contentType: mime.toString() };
+};
+/** Encode multipart parts without losing binary bytes or assigning filenames to typed text. */
+export const encodeMultipartBody = (parts, contentType = 'multipart/form-data', replace) => {
+    const encoded = serializeMultipartBody(parts, contentType, replace);
+    return new Blob(encoded.chunks, { type: encoded.contentType });
 };

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

@@ -1 +1 @@
-{"version":3,"file":"get-request-body-example.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/body/get-request-body-example.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,aAAa,EACb,iBAAiB,EAElB,MAAM,8DAA8D,CAAA;AAMrE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,wBAAwB,GACnC,aAAa,iBAAiB,EAC9B,aAAa,MAAM,EACnB,kCAAkC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KACvD,OAkBF,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,GAC7B,aAAa,iBAAiB,EAC9B,aAAa,MAAM,EACnB,aAAa,MAAM,EACnB,kCAAkC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KACvD,aAAa,GAAG,IAgBlB,CAAA"}
+{"version":3,"file":"get-request-body-example.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/body/get-request-body-example.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,aAAa,EACb,iBAAiB,EAElB,MAAM,8DAA8D,CAAA;AAQrE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,wBAAwB,GACnC,aAAa,iBAAiB,EAC9B,aAAa,MAAM,EACnB,kCAAkC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KACvD,OAwBF,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,GAC7B,aAAa,iBAAiB,EAC9B,aAAa,MAAM,EACnB,aAAa,MAAM,EACnB,kCAAkC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KACvD,aAAa,GAAG,IAwBlB,CAAA"}

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

@@ -1,5 +1,7 @@
-import { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref';
+import { parseMimeType } from '@scalar/helpers/http/mime-type';
+import { getExampleValue } from '../../../helpers/get-example-value.js';
 import { getResolvedRefDeep } from '../../../helpers/get-resolved-ref-deep.js';
+import { serializeStreamExample } from '../../../helpers/serialize-stream-example.js';
 import { getExample } from '../../../request-example/builder/helpers/get-example.js';
 import { getExampleFromSchema } from '../../../request-example/builder/helpers/get-example-from-schema.js';
 /**
@@ -14,17 +16,22 @@ import { getExampleFromSchema } from '../../../request-example/builder/helpers/g
  * Returns `undefined` when there is no schema for the content type.
  */
 export const getSchemaExampleFromBody = (requestBody, contentType, requestBodyCompositionSelection) => {
-    const schema = getResolvedRef(requestBody.content?.[contentType]?.schema);
+    const mediaType = requestBody.content?.[contentType];
+    const schema = mediaType?.schema ??
+        (mediaType?.itemSchema && parseMimeType(contentType).type === 'multipart'
+            ? { type: 'array', items: mediaType.itemSchema }
+            : mediaType?.itemSchema);
     if (!schema) {
         return undefined;
     }
     const resolvedSchema = getResolvedRefDeep(schema);
-    return getExampleFromSchema(resolvedSchema, {
+    const value = getExampleFromSchema(resolvedSchema, {
         mode: 'write',
         compositionSelection: requestBodyCompositionSelection,
     }, {
         schemaPath: ['requestBody'],
     });
+    return serializeStreamExample(value, contentType, mediaType?.schema === undefined) ?? value;
 };
 /**
  * Basically getExample + we generate an example from the schema if no example is found
@@ -34,12 +41,19 @@ export const getExampleFromBody = (requestBody, contentType, exampleName, reques
     // `externalValue` (not yet resolved to a `value`) is treated as missing, so we fall back to a
     // schema-generated example instead of building an empty request body.
     const example = getExample(requestBody, exampleName, contentType);
-    if (example && example.value !== undefined) {
-        return example;
+    const selected = getExampleValue(example);
+    if (example && selected) {
+        const stream = typeof selected.value === 'string' ? undefined : serializeStreamExample(selected.value, contentType, false);
+        if (stream !== undefined) {
+            return selected.source === 'data'
+                ? { ...example, value: stream, serializedValue: stream }
+                : { ...example, value: stream };
+        }
+        return selected.source === 'value' ? example : { ...example, value: selected.value };
     }
     // Generate an example from the schema
     const schemaExample = getSchemaExampleFromBody(requestBody, contentType, requestBodyCompositionSelection);
-    if (!schemaExample) {
+    if (schemaExample === undefined || schemaExample === null) {
         return null;
     }
     return { value: schemaExample };

package/dist/request-example/builder/body/multipart-limits.d.ts

@@ -0,0 +1,3 @@
+/** Match the response parser: the outer body counts toward the eight multipart levels. */
+export declare const MAX_MULTIPART_NESTING = 8;
+//# sourceMappingURL=multipart-limits.d.ts.map

package/dist/request-example/builder/body/multipart-limits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"multipart-limits.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/body/multipart-limits.ts"],"names":[],"mappings":"AAAA,0FAA0F;AAC1F,eAAO,MAAM,qBAAqB,IAAI,CAAA"}

package/dist/request-example/builder/body/multipart-limits.js

@@ -0,0 +1,2 @@
+/** Match the response parser: the outer body counts toward the eight multipart levels. */
+export const MAX_MULTIPART_NESTING = 8;

package/dist/request-example/builder/body/serialize-form-property.d.ts

@@ -1,4 +1,6 @@
 import type { EncodingObject } from '@scalar/workspace-store/schemas/v3.2/strict/openapi-document';
+/** Explicit RFC6570 fields select style serialization instead of media-type encoding. */
+export declare const hasEncodingStyle: (encoding: EncodingObject | undefined) => boolean;
 /** A single serialized form field, ready to become a multipart part or a urlencoded pair. */
 export type SerializedFormProperty = {
     key: string;

package/dist/request-example/builder/body/serialize-form-property.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"serialize-form-property.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/body/serialize-form-property.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8DAA8D,CAAA;AASlG,6FAA6F;AAC7F,MAAM,MAAM,sBAAsB,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAA;AAcnE;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iCAAiC,GAC5C,KAAK,MAAM,EACX,OAAO,OAAO,EACd,UAAU,cAAc,GAAG,SAAS,KACnC,sBAAsB,EAAE,GAAG,IA4E7B,CAAA"}
+{"version":3,"file":"serialize-form-property.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/body/serialize-form-property.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8DAA8D,CAAA;AASlG,yFAAyF;AACzF,eAAO,MAAM,gBAAgB,GAAI,UAAU,cAAc,GAAG,SAAS,KAAG,OACgD,CAAA;AAExH,6FAA6F;AAC7F,MAAM,MAAM,sBAAsB,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAA;AAcnE;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iCAAiC,GAC5C,KAAK,MAAM,EACX,OAAO,OAAO,EACd,UAAU,cAAc,GAAG,SAAS,KACnC,sBAAsB,EAAE,GAAG,IA0E7B,CAAA"}

package/dist/request-example/builder/body/serialize-form-property.js

@@ -1,5 +1,7 @@
 import { unpackProxyObject } from '@scalar/workspace-store/helpers/unpack-proxy';
 import { serializeDeepObjectStyle, serializeFormStyle, serializePipeDelimitedStyle, serializeSpaceDelimitedStyle, } from '../header/serialize-parameter.js';
+/** Explicit RFC6570 fields select style serialization instead of media-type encoding. */
+export const hasEncodingStyle = (encoding) => !!encoding && (encoding.style !== undefined || encoding.explode !== undefined || encoding.allowReserved !== undefined);
 /**
  * Stringify a value emitted by `serializeFormStyle` into a form field value.
  *
@@ -30,8 +32,7 @@ export const serializeFormPropertyWithEncoding = (key, value, encoding) => {
      * Per OpenAPI 3.1.x: when style, explode, or allowReserved is explicitly set, the value
      * is serialized as if it were a query-style parameter and contentType is ignored.
      */
-    const hasFormStyle = !!encoding &&
-        (encoding.style !== undefined || encoding.explode !== undefined || encoding.allowReserved !== undefined);
+    const hasFormStyle = hasEncodingStyle(encoding);
     if (!hasFormStyle) {
         return null;
     }

package/dist/request-example/builder/body/serialize-multipart-array.d.ts

@@ -1,4 +1,4 @@
-import type { EncodingObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+import type { EncodingObject } from '@scalar/workspace-store/schemas/v3.2/strict/openapi-document';
 /** A multipart array item shared by the request builder and code snippets. */
 export type MultipartArrayPart = {
     key: string;

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

@@ -88,6 +88,11 @@ const buildRequestInner = (request, options) => {
     })();
     /** Create a new body object with the replaced values */
     const body = (() => {
+        if (request.body?.mode === 'multipart') {
+            const encoded = encodeMultipartBody(request.body.value, request.body.contentType, (value) => replaceEnvVariables(value, replace));
+            headers.set('content-type', encoded.type);
+            return encoded;
+        }
         if (request.body?.mode === 'raw') {
             if (typeof request.body.value === 'string') {
                 return replaceEnvVariables(request.body.value, replace);

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

@@ -1 +1 @@
-{"version":3,"file":"build-request-parameters.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/header/build-request-parameters.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,KAAK,aAAa,EAEnB,MAAM,qEAAqE,CAAA;AAE5E,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,8DAA8D,CAAA;AAoBlH;;;;;;;;;GASG;AACH,eAAO,MAAM,sBAAsB;AACjC,qBAAqB;AACrB,aAAY,aAAa,CAAC,eAAe,CAAC,EAAO;AACjD,qCAAqC;AACrC,cAAa,MAAkB,KAC9B;IACD,OAAO,EAAE,aAAa,EAAE,CAAA;IACxB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC,4BAA4B,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACzC,SAAS,EAAE,eAAe,CAAA;CA6F3B,CAAA"}
+{"version":3,"file":"build-request-parameters.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/header/build-request-parameters.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,KAAK,aAAa,EAEnB,MAAM,qEAAqE,CAAA;AAE5E,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,8DAA8D,CAAA;AAqBlH;;;;;;;;;GASG;AACH,eAAO,MAAM,sBAAsB;AACjC,qBAAqB;AACrB,aAAY,aAAa,CAAC,eAAe,CAAC,EAAO;AACjD,qCAAqC;AACrC,cAAa,MAAkB,KAC9B;IACD,OAAO,EAAE,aAAa,EAAE,CAAA;IACxB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC,4BAA4B,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACzC,SAAS,EAAE,eAAe,CAAA;CAqG3B,CAAA"}

package/dist/request-example/builder/header/build-request-parameters.js

@@ -6,7 +6,7 @@ import { coerceValue } from '@scalar/workspace-store/schemas/typebox-coerce';
 import { deSerializeParameter } from '../../../request-example/builder/header/de-serialize-parameter.js';
 import { getExample } from '../helpers/get-example.js';
 import { isParamDisabled } from './is-param-disabled.js';
-import { serializeContentValue, serializeDeepObjectStyle, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle, } from './serialize-parameter.js';
+import { serializeContentValue, serializeCookieStyle, serializeDeepObjectStyle, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle, } from './serialize-parameter.js';
 /** Helper to get explode value with default */
 const getExplode = (param, defaultValue) => 'explode' in param && param.explode !== undefined ? param.explode : defaultValue;
 /**
@@ -91,6 +91,10 @@ exampleName = 'default') => {
                 break;
             }
             case 'cookie': {
+                if ('style' in param && param.style === 'cookie') {
+                    result.cookies.push(...serializeCookieStyle(paramName, deSerializedValue, getExplode(param, true)).map((cookie) => coerceValue(xScalarCookieSchema, { ...cookie, path: '/' })));
+                    break;
+                }
                 processCookieParameter(paramName, deSerializedValue, getExplode(param, true), result.cookies);
                 break;
             }