@scalar/workspace-store 0.64.0 → 0.66.0

package/dist/helpers/get-parameter-example.js

@@ -0,0 +1,19 @@
+import { getFirstMediaType } from '@scalar/helpers/http/get-first-media-type';
+import { getExampleValue, getExplicitExampleText } from '../helpers/get-example-value.js';
+import { getExample } from '../request-example/builder/helpers/get-example.js';
+/** Resolve new and legacy example fields without serializing parameter-level wire text again. */
+export const getParameterExample = (parameter, exampleName) => {
+    const authored = getExample({ ...parameter, content: undefined, schema: undefined }, exampleName, undefined);
+    const example = authored ?? getExample(parameter, exampleName, undefined);
+    const selected = getExampleValue(example);
+    const contentType = 'content' in parameter ? getFirstMediaType(parameter.content)?.[0] : undefined;
+    const mediaText = contentType ? getExplicitExampleText(selected, contentType) : undefined;
+    return {
+        example,
+        value: contentType && selected && !(authored && selected.source === 'serialized')
+            ? (mediaText ?? selected.value)
+            : selected?.value,
+        mediaSerialized: contentType !== undefined && mediaText !== undefined && !(authored && selected?.source === 'serialized'),
+        serialized: authored !== undefined && selected?.source === 'serialized',
+    };
+};

package/dist/helpers/get-resolved-ref.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-resolved-ref.d.ts","sourceRoot":"","sources":["../../src/helpers/get-resolved-ref.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,IAAI,CAAA;CAAE,CAAA;AACjF,MAAM,MAAM,SAAS,CAAC,IAAI,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;AA0ElD;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GAAI,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,KAAG,IAclE,CAAA;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EACzC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,EACrB,SAAS,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,MAAM,GACzC,IAAI,GAAG,MAAM,CAAA;AAChB,wBAAgB,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,IAAI,CAAA;CAAE,GAAG,IAAI,CAAA;AACtF,wBAAgB,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,SAAS,CAAA;AAW7E;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAA"}
+{"version":3,"file":"get-resolved-ref.d.ts","sourceRoot":"","sources":["../../src/helpers/get-resolved-ref.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,IAAI,CAAA;CAAE,CAAA;AACjF,MAAM,MAAM,SAAS,CAAC,IAAI,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;AA0ElD;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GAAI,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,KAAG,IA2BlE,CAAA;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EACzC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,EACrB,SAAS,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,MAAM,GACzC,IAAI,GAAG,MAAM,CAAA;AAChB,wBAAgB,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,IAAI,CAAA;CAAE,GAAG,IAAI,CAAA;AACtF,wBAAgB,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,SAAS,CAAA;AAW7E;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAA"}

package/dist/helpers/get-resolved-ref.js

@@ -76,7 +76,18 @@ export const mergeSiblingReferences = (node) => {
     if (!isObject(target)) {
         return rest;
     }
-    return { ...target, ...rest };
+    const merged = { ...target, ...rest };
+    // Plain document loaders hide reference links from serialization. Preserve the
+    // next hop explicitly so chain resolution does not depend on object spread.
+    if (Object.hasOwn(target, '$ref-value') && !Object.hasOwn(merged, '$ref-value')) {
+        Object.defineProperty(merged, '$ref-value', {
+            value: target['$ref-value'],
+            enumerable: false,
+            configurable: true,
+            writable: true,
+        });
+    }
+    return merged;
 };
 export function getResolvedRef(node, transform = defaultTransform) {
     if (typeof node === 'object' && node !== null && '$ref' in node) {

package/dist/helpers/normalize-boolean-schemas.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Normalize boolean schemas without mutating caller-owned data.
+ * Only changed schema containers and their ancestors are copied. Unchanged bundled
+ * documents and opaque example/extension payloads retain their identity. Iterative
+ * discovery and copy propagation preserve cycles without recursive cloning.
+ * The marker represents an untyped schema; false is its negation. additionalProperties
+ * already accepts booleans and therefore retains its authored representation.
+ */
+export declare const normalizeBooleanSchemas: <T extends Record<string, unknown>>(document: T) => T;
+//# sourceMappingURL=normalize-boolean-schemas.d.ts.map

package/dist/helpers/normalize-boolean-schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalize-boolean-schemas.d.ts","sourceRoot":"","sources":["../../src/helpers/normalize-boolean-schemas.ts"],"names":[],"mappings":"AAgDA;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,CAAC,KAAG,CAkJxF,CAAA"}

package/dist/helpers/normalize-boolean-schemas.js

@@ -0,0 +1,193 @@
+import { parseJsonPointerSegments } from '@scalar/helpers/json/parse-json-pointer-segments';
+import { isObject } from '@scalar/helpers/object/is-object';
+import { isSchemaPath } from '@scalar/helpers/openapi/is-schema-path';
+const schemaMaps = new Set(['properties', 'patternProperties', '$defs', 'definitions', 'dependentSchemas']);
+const schemaArrays = new Set(['allOf', 'anyOf', 'oneOf', 'prefixItems']);
+const childSchemas = new Set([
+    'items',
+    'not',
+    'if',
+    'then',
+    'else',
+    'contains',
+    'propertyNames',
+    'contentSchema',
+    '$ref-value',
+]);
+const openApiMaps = new Set([
+    'paths',
+    'webhooks',
+    'responses',
+    'content',
+    'headers',
+    'examples',
+    'links',
+    'encoding',
+    'variables',
+    'parameters',
+    'requestBodies',
+    'securitySchemes',
+    'pathItems',
+    'mediaTypes',
+    'additionalOperations',
+    'callbacks',
+    'x-ext',
+]);
+const opaqueValues = new Set(['example', 'examples', 'default', 'enum', 'const', 'value', 'dataValue']);
+/**
+ * Normalize boolean schemas without mutating caller-owned data.
+ * Only changed schema containers and their ancestors are copied. Unchanged bundled
+ * documents and opaque example/extension payloads retain their identity. Iterative
+ * discovery and copy propagation preserve cycles without recursive cloning.
+ * The marker represents an untyped schema; false is its negation. additionalProperties
+ * already accepts booleans and therefore retains its authored representation.
+ */
+export const normalizeBooleanSchemas = (document) => {
+    const nodes = new WeakMap();
+    const changed = new Set();
+    const schemas = new WeakSet();
+    const documents = new WeakSet();
+    const tasks = [];
+    const getNode = (source) => {
+        const existing = nodes.get(source);
+        if (existing) {
+            return existing;
+        }
+        const node = { source };
+        nodes.set(source, node);
+        return node;
+    };
+    const root = getNode(document);
+    const link = (parent, key, child) => {
+        const node = getNode(child);
+        if (!node.parent) {
+            node.parent = { node: parent, key };
+        }
+        else if (node.parent.node !== parent || node.parent.key !== key) {
+            const parents = (node.otherParents ??= []);
+            if (!parents.some((edge) => edge.node === parent && edge.key === key)) {
+                parents.push({ node: parent, key });
+            }
+        }
+        return node;
+    };
+    const schema = (parent, key, value) => {
+        if (typeof value === 'boolean') {
+            ;
+            (parent.replacements ??= new Map()).set(key, value ? { __scalar_: '' } : { __scalar_: '', not: { __scalar_: '' } });
+            changed.add(parent);
+        }
+        else if (isObject(value)) {
+            tasks.push({ node: link(parent, key, value), kind: 'schema' });
+        }
+    };
+    const reference = (pointer) => {
+        const segments = parseJsonPointerSegments(pointer);
+        let parent = root;
+        for (const [index, key] of segments.entries()) {
+            // A local reference cannot reach inherited properties or prototype setters.
+            if (!Object.hasOwn(parent.source, key)) {
+                return;
+            }
+            const value = Reflect.get(parent.source, key);
+            if (index === segments.length - 1) {
+                schema(parent, key, value);
+            }
+            else if (value !== null && typeof value === 'object') {
+                parent = link(parent, key, value);
+            }
+            else {
+                return;
+            }
+        }
+    };
+    tasks.push({ node: root, kind: 'document', path: [], mapDepth: 0 });
+    while (tasks.length > 0) {
+        const task = tasks.pop();
+        if (!task) {
+            break;
+        }
+        const { node } = task;
+        const visited = task.kind === 'schema' ? schemas : documents;
+        if (visited.has(node.source)) {
+            continue;
+        }
+        visited.add(node.source);
+        if (task.kind === 'schema') {
+            const value = node.source;
+            if (typeof value.$ref === 'string' && value.$ref.startsWith('#/')) {
+                reference(value.$ref.slice(1));
+            }
+            for (const [key, child] of Object.entries(value)) {
+                if ((schemaMaps.has(key) && isObject(child)) || (schemaArrays.has(key) && Array.isArray(child))) {
+                    const container = link(node, key, child);
+                    for (const [name, nested] of Object.entries(child)) {
+                        schema(container, name, nested);
+                    }
+                }
+                else if (childSchemas.has(key)) {
+                    schema(node, key, child);
+                }
+                else if (['additionalProperties', 'unevaluatedProperties', 'unevaluatedItems'].includes(key) &&
+                    isObject(child)) {
+                    schema(node, key, child);
+                }
+            }
+            continue;
+        }
+        const { path } = task;
+        for (const [key, child] of Object.entries(node.source)) {
+            const childPath = [...path, key];
+            const isMapEntry = task.mapDepth > 0;
+            if (key === 'schemas' && path.at(-1) === 'components' && isObject(child)) {
+                const container = link(node, key, child);
+                for (const [name, nested] of Object.entries(child)) {
+                    schema(container, name, nested);
+                }
+            }
+            else if ((key === 'schema' || key === 'itemSchema') && !isMapEntry && isSchemaPath(childPath)) {
+                schema(node, key, child);
+            }
+            else if (isMapEntry || (!opaqueValues.has(key) && (!key.startsWith('x-') || key === 'x-ext'))) {
+                // Vendor extensions are opaque. x-ext additionally contains bundled documents
+                // and schema targets whose context can be supplied by a local reference.
+                if (child !== null && typeof child === 'object') {
+                    tasks.push({
+                        node: link(node, key, child),
+                        kind: 'document',
+                        path: childPath,
+                        mapDepth: isMapEntry ? task.mapDepth - 1 : key === 'callbacks' ? 2 : openApiMaps.has(key) ? 1 : 0,
+                    });
+                }
+            }
+        }
+    }
+    const forEachParent = (node, callback) => {
+        if (node.parent) {
+            callback(node.parent);
+        }
+        node.otherParents?.forEach(callback);
+    };
+    // Set iteration also visits newly added ancestors, including shared/cyclic parents.
+    for (const node of changed) {
+        forEachParent(node, (parent) => changed.add(parent.node));
+    }
+    for (const node of changed) {
+        node.copy = Array.isArray(node.source) ? [] : {};
+    }
+    for (const node of changed) {
+        forEachParent(node, (parent) => (parent.node.replacements ??= new Map()).set(parent.key, node.copy));
+    }
+    for (const node of changed) {
+        for (const [key, value] of Object.entries(node.source)) {
+            // Define an own data property so authored keys such as __proto__ remain data.
+            Object.defineProperty(node.copy, key, {
+                value: node.replacements?.has(key) ? node.replacements.get(key) : value,
+                enumerable: true,
+                writable: true,
+                configurable: true,
+            });
+        }
+    }
+    return (root.copy ?? document);
+};

package/dist/helpers/operation-examples.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"operation-examples.d.ts","sourceRoot":"","sources":["../../src/helpers/operation-examples.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAmB,eAAe,EAAE,MAAM,wCAAwC,CAAA;AAE7G,+FAA+F;AAC/F,eAAO,MAAM,oBAAoB,GAC/B,WAAW,eAAe,EAC1B,KAAK,MAAM,EACX,cAAc,MAAM,KACnB,CAAC,aAAa,GAAG,SAAS,CAAC,EAS7B,CAAA;AAED,8FAA8F;AAC9F,eAAO,MAAM,wBAAwB,GACnC,WAAW,eAAe,EAC1B,KAAK,MAAM,EACX,aAAa,MAAM,GAAG,SAAS,EAC/B,SAAS,CAAC,OAAO,EAAE,aAAa,GAAG,SAAS,KAAK,aAAa,GAAG,SAAS,KACzE,eA6BF,CAAA"}
+{"version":3,"file":"operation-examples.d.ts","sourceRoot":"","sources":["../../src/helpers/operation-examples.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAmB,eAAe,EAAE,MAAM,wCAAwC,CAAA;AAE7G,+FAA+F;AAC/F,eAAO,MAAM,oBAAoB,GAC/B,WAAW,eAAe,EAC1B,KAAK,MAAM,EACX,cAAc,MAAM,KACnB,CAAC,aAAa,GAAG,SAAS,CAAC,EAS7B,CAAA;AAED,8FAA8F;AAC9F,eAAO,MAAM,wBAAwB,GACnC,WAAW,eAAe,EAC1B,KAAK,MAAM,EACX,aAAa,MAAM,GAAG,SAAS,EAC/B,SAAS,CAAC,OAAO,EAAE,aAAa,GAAG,SAAS,KAAK,aAAa,GAAG,SAAS,KACzE,eAgCF,CAAA"}

package/dist/helpers/operation-examples.js

@@ -37,9 +37,12 @@ export const resolveOperationExamples = (operation, key, contentType, resolve) =
             const content = 'content' in resolved ? resolved.content : undefined;
             const mediaType = Object.keys(content ?? {})[0];
             if (mediaType && content?.[mediaType]) {
-                return { ...resolved, content: { ...content, [mediaType]: mapMedia(content[mediaType]) } };
+                const media = mapMedia(content[mediaType]);
+                return media === content[mediaType] ? parameter : { ...resolved, content: { ...content, [mediaType]: media } };
             }
-            return { ...resolved, ...mapMedia(resolved) };
+            // Keep editable source objects when there is no downloaded example to overlay.
+            const media = mapMedia(resolved);
+            return media === resolved ? parameter : { ...resolved, ...media };
         }),
     };
 };

package/dist/helpers/querystring-parameter.d.ts

@@ -0,0 +1,21 @@
+import type { EncodingObject, ParameterObject } from '../schemas/v3.2/strict/openapi-document.js';
+/** A whole query string, kept separate from named parameters until URL serialization. */
+export type QuerystringParameter = {
+    value: unknown;
+    contentType: string;
+    encoding?: Record<string, EncodingObject>;
+    /** URI-ready parameter examples, serialized media examples, or data requiring media serialization. */
+    kind: 'uri-ready' | 'serialized' | 'data';
+};
+/**
+ * Resolve the selected whole-query example, including content-schema defaults.
+ * This module serializes outgoing queries; mock-server/src/utils/querystring-parameter.ts decodes incoming ones.
+ */
+export declare const getQuerystringParameter: (parameter: ParameterObject, exampleName?: string, { defaultDisabled, includeDisabled, }?: {
+    defaultDisabled?: boolean;
+    /** Editors must retain the value when its checkbox is off. */
+    includeDisabled?: boolean;
+}) => QuerystringParameter | undefined;
+/** Serialize without introducing a parameter name or re-encoding URI-ready examples. */
+export declare const serializeQuerystringParameter: (parameter: QuerystringParameter, variables?: Record<string, string> | ((value: string) => string | null)) => string;
+//# sourceMappingURL=querystring-parameter.d.ts.map

package/dist/helpers/querystring-parameter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"querystring-parameter.d.ts","sourceRoot":"","sources":["../../src/helpers/querystring-parameter.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,cAAc,EAAiB,eAAe,EAAE,MAAM,wCAAwC,CAAA;AAE5G,yFAAyF;AACzF,MAAM,MAAM,oBAAoB,GAAG;IACjC,KAAK,EAAE,OAAO,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IACzC,sGAAsG;IACtG,IAAI,EAAE,WAAW,GAAG,YAAY,GAAG,MAAM,CAAA;CAC1C,CAAA;AAmBD;;;GAGG;AACH,eAAO,MAAM,uBAAuB,GAClC,WAAW,eAAe,EAC1B,cAAc,MAAM,EACpB,wCAGG;IACD,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,8DAA8D;IAC9D,eAAe,CAAC,EAAE,OAAO,CAAA;CACrB,KACL,oBAAoB,GAAG,SAwBzB,CAAA;AAED,wFAAwF;AACxF,eAAO,MAAM,6BAA6B,GACxC,WAAW,oBAAoB,EAC/B,YAAW,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAM,KAC1E,MA6DF,CAAA"}

package/dist/helpers/querystring-parameter.js

@@ -0,0 +1,108 @@
+import { getFirstMediaType } from '@scalar/helpers/http/get-first-media-type';
+import { isJsonMediaType } from '@scalar/helpers/http/is-json-media-type';
+import { parseMimeType } from '@scalar/helpers/http/mime-type';
+import { isObject } from '@scalar/helpers/object/is-object';
+import { replaceEnvVariables } from '@scalar/helpers/regex/replace-variables';
+import { getResolvedRef } from '../helpers/get-resolved-ref.js';
+import { serializeFormPropertyWithEncoding } from '../request-example/builder/body/serialize-form-property.js';
+import { isParamDisabled } from '../request-example/builder/header/is-param-disabled.js';
+import { applyAllowReservedToUrl } from '../request-example/builder/helpers/apply-allow-reserved-to-url.js';
+import { getExample } from '../request-example/builder/helpers/get-example.js';
+import { getExampleFromSchema } from '../request-example/builder/helpers/get-example-from-schema.js';
+/** Classify provenance before serialization so generated strings remain data, not pre-serialized media. */
+const getQuerystringValueKind = (example, source) => {
+    if (example?.serializedValue !== undefined) {
+        return source === 'parameter' ? 'uri-ready' : 'serialized';
+    }
+    if (example?.dataValue !== undefined) {
+        return 'data';
+    }
+    if (typeof example?.value === 'string') {
+        return 'serialized';
+    }
+    return 'data';
+};
+/**
+ * Resolve the selected whole-query example, including content-schema defaults.
+ * This module serializes outgoing queries; mock-server/src/utils/querystring-parameter.ts decodes incoming ones.
+ */
+export const getQuerystringParameter = (parameter, exampleName, { defaultDisabled = true, includeDisabled = false, } = {}) => {
+    if (parameter.in !== 'querystring' || !('content' in parameter) || !parameter.content) {
+        return undefined;
+    }
+    const [contentType, media] = getFirstMediaType(parameter.content) ?? [];
+    if (!contentType) {
+        return undefined;
+    }
+    const mediaType = getResolvedRef(media);
+    // Resolve parameter examples first rather than probing their identity after media selection.
+    const parameterExample = getExample({ ...parameter, content: undefined }, exampleName, undefined);
+    // Schema-generated strings are data, so only authored media examples participate here.
+    const example = parameterExample ?? getExample({ ...mediaType, schema: undefined }, exampleName, contentType);
+    if (!includeDisabled && isParamDisabled(parameter, example, defaultDisabled)) {
+        return undefined;
+    }
+    const value = example?.serializedValue ?? (example?.dataValue !== undefined ? example.dataValue : example?.value);
+    const schema = getResolvedRef(mediaType?.schema);
+    return {
+        value: value !== undefined ? value : schema ? getExampleFromSchema(schema) : '',
+        contentType,
+        encoding: mediaType?.encoding,
+        kind: getQuerystringValueKind(example, parameterExample === undefined ? 'media' : 'parameter'),
+    };
+};
+/** Serialize without introducing a parameter name or re-encoding URI-ready examples. */
+export const serializeQuerystringParameter = (parameter, variables = {}) => {
+    const replace = (value) => {
+        if (typeof value === 'string') {
+            return replaceEnvVariables(value, variables);
+        }
+        if (Array.isArray(value)) {
+            return value.map(replace);
+        }
+        if (isObject(value)) {
+            return Object.fromEntries(Object.entries(value).map(([key, item]) => [replaceEnvVariables(key, variables), replace(item)]));
+        }
+        return value;
+    };
+    const value = replace(parameter.value);
+    if (parameter.kind === 'uri-ready') {
+        return String(value);
+    }
+    const contentType = parseMimeType(parameter.contentType).essence;
+    if (contentType === 'application/x-www-form-urlencoded') {
+        if (typeof value === 'string') {
+            return value;
+        }
+        const params = new URLSearchParams();
+        const reservedKeys = new Set();
+        for (const [key, item] of Object.entries(isObject(value) ? value : {})) {
+            const encoding = parameter.encoding?.[key];
+            const entries = serializeFormPropertyWithEncoding(key, item, encoding);
+            if (entries) {
+                for (const entry of entries) {
+                    params.append(entry.key, entry.value);
+                    if (encoding?.allowReserved) {
+                        reservedKeys.add(entry.key);
+                    }
+                }
+                continue;
+            }
+            const styleBased = encoding?.style !== undefined || encoding?.explode !== undefined || encoding?.allowReserved !== undefined;
+            for (const part of Array.isArray(item) ? item : [item]) {
+                const json = !styleBased && (isJsonMediaType(encoding?.contentType) || (part !== null && typeof part === 'object'));
+                params.append(key, json ? JSON.stringify(part) : String(part ?? ''));
+            }
+            if (encoding?.allowReserved) {
+                reservedKeys.add(key);
+            }
+        }
+        return applyAllowReservedToUrl(`?${params}`, reservedKeys).slice(1);
+    }
+    const serialized = parameter.kind === 'serialized'
+        ? String(value)
+        : isJsonMediaType(contentType)
+            ? JSON.stringify(value)
+            : String(value);
+    return encodeURIComponent(serialized).replace(/[!'()*]/g, (char) => `%${char.charCodeAt(0).toString(16).toUpperCase()}`);
+};

package/dist/helpers/serialize-stream-example.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Frame generated values and authored structured examples as sequential content.
+ * Callers bypass this helper for authored strings that already contain wire framing.
+ * SSE objects with no valid fields are omitted with one warning per call; an empty
+ * input sequence is valid and does not produce a warning.
+ */
+export declare const serializeStreamExample: (value: unknown, contentType: string, singleItem: boolean) => string | undefined;
+//# sourceMappingURL=serialize-stream-example.d.ts.map

package/dist/helpers/serialize-stream-example.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serialize-stream-example.d.ts","sourceRoot":"","sources":["../../src/helpers/serialize-stream-example.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,GACjC,OAAO,OAAO,EACd,aAAa,MAAM,EACnB,YAAY,OAAO,KAClB,MAAM,GAAG,SA2CX,CAAA"}

package/dist/helpers/serialize-stream-example.js

@@ -0,0 +1,52 @@
+import { getStreamFormat } from '@scalar/helpers/http/is-streaming-content-type';
+import { isObject } from '@scalar/helpers/object/is-object';
+/**
+ * Frame generated values and authored structured examples as sequential content.
+ * Callers bypass this helper for authored strings that already contain wire framing.
+ * SSE objects with no valid fields are omitted with one warning per call; an empty
+ * input sequence is valid and does not produce a warning.
+ */
+export const serializeStreamExample = (value, contentType, singleItem) => {
+    if (value === undefined) {
+        return undefined;
+    }
+    const format = getStreamFormat(contentType);
+    const items = singleItem ? [value] : Array.isArray(value) ? value : [value];
+    if (format === 'json-lines') {
+        return items.map((item) => `${JSON.stringify(item)}\n`).join('');
+    }
+    if (format === 'json-seq') {
+        return items.map((item) => `\u001e${JSON.stringify(item)}\n`).join('');
+    }
+    if (format === 'sse') {
+        const frames = items.map((item) => {
+            if (!isObject(item)) {
+                return `data: ${JSON.stringify(item)}\n\n`;
+            }
+            const fields = ['event', 'id', 'retry', 'data'].flatMap((field) => {
+                const fieldValue = item[field];
+                if (field === 'retry') {
+                    return typeof fieldValue === 'number' && Number.isInteger(fieldValue) && fieldValue >= 0
+                        ? [`retry: ${fieldValue}`]
+                        : [];
+                }
+                if (field === 'data' && fieldValue !== undefined) {
+                    const data = typeof fieldValue === 'string' ? fieldValue : JSON.stringify(fieldValue);
+                    return data.split(/\r\n|\r|\n/).map((line) => `data: ${line}`);
+                }
+                if (typeof fieldValue !== 'string' || (field === 'id' && fieldValue.includes('\0'))) {
+                    return [];
+                }
+                const lines = fieldValue.split(/\r\n|\r|\n/);
+                return lines.length === 1 ? [`${field}: ${fieldValue}`] : [];
+            });
+            return fields.length ? `${fields.join('\n')}\n\n` : '';
+        });
+        const omitted = frames.filter((frame) => frame === '').length;
+        if (omitted > 0) {
+            console.warn(`Skipped ${omitted} SSE example item(s) with no valid event, id, retry, or data fields.`);
+        }
+        return frames.join('');
+    }
+    return undefined;
+};

package/dist/helpers/use-external-examples.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-external-examples.d.ts","sourceRoot":"","sources":["../../src/helpers/use-external-examples.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,GAAG,EAOT,MAAM,KAAK,CAAA;AAEZ,OAAO,EAAE,KAAK,uBAAuB,EAAiC,MAAM,6BAA6B,CAAA;AACzG,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAA;AAE3E,4FAA4F;AAC5F,eAAO,MAAM,iBAAiB,EAAE,YAAY,CAAC,MAAM,uBAAuB,CAA+B,CAAA;AAEzG,0GAA0G;AAC1G,eAAO,MAAM,oBAAoB,GAAI,QAAQ,GAAG,CAAC,OAAO,GAAG,uBAAuB,GAAG,IAAI,CAAC,KAAG,GAAG,CAAC,OAAO,CAuBvG,CAAA;AAED,gGAAgG;AAChG,eAAO,MAAM,mBAAmB,GAC9B,UAAU,MAAM,CAAC,aAAa,GAAG,SAAS,CAAC,EAAE,EAC7C,UAAS,MAAM,OAAoB,EACnC,WAAW,MAAM,uBAAuB,KACvC;IACD,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC7B,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC5B,OAAO,EAAE,CAAC,OAAO,EAAE,aAAa,GAAG,SAAS,KAAK,aAAa,GAAG,SAAS,CAAA;IAC1E,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAgC3B,CAAA"}
+{"version":3,"file":"use-external-examples.d.ts","sourceRoot":"","sources":["../../src/helpers/use-external-examples.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,GAAG,EAOT,MAAM,KAAK,CAAA;AAEZ,OAAO,EAAE,KAAK,uBAAuB,EAAiC,MAAM,6BAA6B,CAAA;AACzG,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAA;AAE3E,4FAA4F;AAC5F,eAAO,MAAM,iBAAiB,EAAE,YAAY,CAAC,MAAM,uBAAuB,CAA+B,CAAA;AAEzG,0GAA0G;AAC1G,eAAO,MAAM,oBAAoB,GAAI,QAAQ,GAAG,CAAC,OAAO,GAAG,uBAAuB,GAAG,IAAI,CAAC,KAAG,GAAG,CAAC,OAAO,CAuBvG,CAAA;AAED,gGAAgG;AAChG,eAAO,MAAM,mBAAmB,GAC9B,UAAU,MAAM,CAAC,aAAa,GAAG,SAAS,CAAC,EAAE,EAC7C,UAAS,MAAM,OAAoB,EACnC,WAAW,MAAM,uBAAuB,KACvC;IACD,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC7B,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC5B,OAAO,EAAE,CAAC,OAAO,EAAE,aAAa,GAAG,SAAS,KAAK,aAAa,GAAG,SAAS,CAAA;IAC1E,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAsC3B,CAAA"}

package/dist/helpers/use-external-examples.js

@@ -46,7 +46,14 @@ export const useExternalExamples = (examples, enabled = () => true, resolver) =>
             if (!example || example.value !== undefined || !example.externalValue)
                 return example;
             const state = getResolver()(example);
-            return state.status === 'loaded' ? { ...example, value: state.value } : example;
+            if (state.status !== 'loaded')
+                return example;
+            // A 3.2 example can pair structured data with external wire text. Keep both in the
+            // resolved view so raw consumers display the download and form editors retain the data.
+            if (example.dataValue !== undefined && state.serializedValue !== undefined) {
+                return { ...example, serializedValue: state.serializedValue };
+            }
+            return { ...example, value: state.value };
         },
         retry: async () => {
             await Promise.all(states.value.map((state) => state.load()));

package/dist/mutators/index.d.ts

@@ -12,8 +12,8 @@ export declare function generateClientMutators(store: WorkspaceStore | null): {
     workspace: () => {
         cookie: {
             upsertCookie: (payload: {
-                payload: Partial<import("../schemas/extensions/general/x-scalar-cookies.js").XScalarCookie>;
                 index?: number | undefined;
+                payload: Partial<import("../schemas/extensions/general/x-scalar-cookies.js").XScalarCookie>;
             }) => import("../schemas/extensions/general/x-scalar-cookies.js").XScalarCookie | undefined;
             deleteCookie: (payload: {
                 index: number;
@@ -77,8 +77,8 @@ export declare function generateClientMutators(store: WorkspaceStore | null): {
         };
         cookie: {
             upsertCookie: (payload: {
-                payload: Partial<import("../schemas/extensions/general/x-scalar-cookies.js").XScalarCookie>;
                 index?: number | undefined;
+                payload: Partial<import("../schemas/extensions/general/x-scalar-cookies.js").XScalarCookie>;
             }) => import("../schemas/extensions/general/x-scalar-cookies.js").XScalarCookie | undefined;
             deleteCookie: (payload: {
                 index: number;
@@ -168,8 +168,8 @@ export declare function generateClientMutators(store: WorkspaceStore | null): {
         };
         cookie: {
             upsertCookie: (payload: {
-                payload: Partial<import("../schemas/extensions/general/x-scalar-cookies.js").XScalarCookie>;
                 index?: number | undefined;
+                payload: Partial<import("../schemas/extensions/general/x-scalar-cookies.js").XScalarCookie>;
             }) => import("../schemas/extensions/general/x-scalar-cookies.js").XScalarCookie | undefined;
             deleteCookie: (payload: {
                 index: number;

package/dist/mutators/operation/body.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"body.d.ts","sourceRoot":"","sources":["../../../src/mutators/operation/body.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAA;AAIrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAoClD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,qCAAqC,GAChD,UAAU,iBAAiB,GAAG,IAAI,EAClC,mBAAmB,eAAe,CAAC,0CAA0C,CAAC,SAwB/E,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iCAAiC,GAC5C,UAAU,iBAAiB,GAAG,IAAI,EAClC,gCAAgC,eAAe,CAAC,oCAAoC,CAAC,SAStF,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,mCAAmC,GAC9C,UAAU,iBAAiB,GAAG,IAAI,EAClC,gCAAgC,eAAe,CAAC,wCAAwC,CAAC,SAS1F,CAAA"}
+{"version":3,"file":"body.d.ts","sourceRoot":"","sources":["../../../src/mutators/operation/body.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAA;AAIrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AA4ClD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,qCAAqC,GAChD,UAAU,iBAAiB,GAAG,IAAI,EAClC,mBAAmB,eAAe,CAAC,0CAA0C,CAAC,SAwB/E,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iCAAiC,GAC5C,UAAU,iBAAiB,GAAG,IAAI,EAClC,gCAAgC,eAAe,CAAC,oCAAoC,CAAC,SAStF,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,mCAAmC,GAC9C,UAAU,iBAAiB,GAAG,IAAI,EAClC,gCAAgC,eAAe,CAAC,wCAAwC,CAAC,SAS1F,CAAA"}

package/dist/mutators/operation/body.js

@@ -2,6 +2,13 @@ import { getPathItemOperation } from '../../helpers/for-each-path-item-operation
 import { getResolvedRef } from '../../helpers/get-resolved-ref.js';
 import { unpackProxyObject } from '../../helpers/unpack-proxy.js';
 import { isOpenApiDocument } from '../../schemas/type-guards.js';
+/** An edit replaces the authored source so the old serialized/data value cannot win. */
+const replaceExampleValue = (example, value) => {
+    delete example.serializedValue;
+    delete example.dataValue;
+    delete example.externalValue;
+    example.value = value;
+};
 /** Ensure the json that we need exists up to the example object in the request body */
 const findOrCreateRequestBodyExample = (document, contentType, meta) => {
     if (!isOpenApiDocument(document)) {
@@ -81,7 +88,7 @@ export const updateOperationRequestBodyExample = (document, { meta, payload, con
         console.error('Example not found', meta.exampleKey);
         return;
     }
-    example.value = payload;
+    replaceExampleValue(example, payload);
 };
 /**
  * Stores the form data for the request body example
@@ -94,5 +101,5 @@ export const updateOperationRequestBodyFormValue = (document, { meta, payload, c
         console.error('Example not found', meta.exampleKey);
         return;
     }
-    example.value = unpackProxyObject(payload, { depth: 3 });
+    replaceExampleValue(example, unpackProxyObject(payload, { depth: 3 }));
 };

package/dist/mutators/operation/operation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../../src/mutators/operation/operation.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAA;AAarE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAGlD;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,eAAe,GAC1B,gBAAgB,cAAc,GAAG,IAAI,EACrC,SAAS,eAAe,CAAC,4BAA4B,CAAC,KACrD,MAAM,GAAG,SA0DX,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,mBAAmB,GAC9B,OAAO,cAAc,GAAG,IAAI,EAC5B,UAAU,iBAAiB,GAAG,IAAI,EAClC,mBAAmB,eAAe,CAAC,uBAAuB,CAAC,SAsB5D,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,yBAAyB,GACpC,UAAU,iBAAiB,GAAG,IAAI,EAClC,OAAO,cAAc,GAAG,IAAI,EAC5B,mEAAmE,eAAe,CAAC,6BAA6B,CAAC,KAChH,IAoGF,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,GAC1B,WAAW,cAAc,GAAG,IAAI,EAChC,wBAAwB,eAAe,CAAC,4BAA4B,CAAC,SAgBtE,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,2BAA2B,GACtC,WAAW,cAAc,GAAG,IAAI,EAChC,uDAAuD,eAAe,CAAC,gCAAgC,CAAC,SAuBzG,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,GACjC,WAAW,cAAc,GAAG,IAAI,EAChC,sDAAsD,eAAe,CAAC,0BAA0B,CAAC,SAkDlG,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,GACjC,WAAW,cAAc,GAAG,IAAI,EAChC,+DAA+D,eAAe,CAAC,0BAA0B,CAAC,SAwE3G,CAAA"}
+{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../../src/mutators/operation/operation.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAA;AAarE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAGlD;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,eAAe,GAC1B,gBAAgB,cAAc,GAAG,IAAI,EACrC,SAAS,eAAe,CAAC,4BAA4B,CAAC,KACrD,MAAM,GAAG,SA0DX,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,mBAAmB,GAC9B,OAAO,cAAc,GAAG,IAAI,EAC5B,UAAU,iBAAiB,GAAG,IAAI,EAClC,mBAAmB,eAAe,CAAC,uBAAuB,CAAC,SAsB5D,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,yBAAyB,GACpC,UAAU,iBAAiB,GAAG,IAAI,EAClC,OAAO,cAAc,GAAG,IAAI,EAC5B,mEAAmE,eAAe,CAAC,6BAA6B,CAAC,KAChH,IAkGF,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,GAC1B,WAAW,cAAc,GAAG,IAAI,EAChC,wBAAwB,eAAe,CAAC,4BAA4B,CAAC,SAgBtE,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,2BAA2B,GACtC,WAAW,cAAc,GAAG,IAAI,EAChC,uDAAuD,eAAe,CAAC,gCAAgC,CAAC,SAuBzG,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,GACjC,WAAW,cAAc,GAAG,IAAI,EAChC,sDAAsD,eAAe,CAAC,0BAA0B,CAAC,SAkDlG,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,GACjC,WAAW,cAAc,GAAG,IAAI,EAChC,+DAA+D,eAAe,CAAC,0BAA0B,CAAC,SAwE3G,CAAA"}

package/dist/mutators/operation/operation.js

@@ -1,4 +1,3 @@
-import { isHttpMethod } from '@scalar/helpers/http/is-http-method';
 import { preventPollution } from '@scalar/helpers/object/prevent-pollution';
 import { findVariables } from '@scalar/helpers/regex/find-variables';
 import { deletePathItemOperation, getPathItemOperation, pathItemIsEmpty, setPathItemOperation, } from '../../helpers/for-each-path-item-operation.js';
@@ -188,12 +187,10 @@ export const updateOperationPathMethod = (document, store, { meta, payload: { me
     // Move the operation to the new location
     setPathItemOperation(document.paths[finalPath], finalMethod, unpackProxyObject(operation));
     // Remove the operation from the old location
-    if (isHttpMethod(meta.method)) {
-        deletePathItemOperation(document.paths[meta.path], meta.method);
-        // If the old path is now empty, remove the path entry (path-level metadata is kept otherwise)
-        if (pathItemIsEmpty(document.paths[meta.path])) {
-            delete document.paths[meta.path];
-        }
+    deletePathItemOperation(document.paths[meta.path], meta.method);
+    // If the old path is now empty, remove the path entry (path-level metadata is kept otherwise)
+    if (pathItemIsEmpty(document.paths[meta.path])) {
+        delete document.paths[meta.path];
     }
     // We need to reset the history for the operation when the path or method changes
     store.history.clearOperationHistory(document['x-scalar-navigation']?.name ?? '', meta.path, meta.method);

package/dist/mutators/operation/parameters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../../src/mutators/operation/parameters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAA;AAIrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAmClD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,wBAAwB,GACnC,UAAU,iBAAiB,GAAG,IAAI,EAClC,4CAA4C,eAAe,CAAC,4BAA4B,CAAC,SAuE1F,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,8BAA8B,GACzC,UAAU,iBAAiB,GAAG,IAAI,EAClC,uCAAuC,eAAe,CAAC,mCAAmC,CAAC,SA8C5F,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,wBAAwB,GACnC,UAAU,iBAAiB,GAAG,IAAI,EAClC,6BAA6B,eAAe,CAAC,4BAA4B,CAAC,SAkC3E,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,4BAA4B,GACvC,UAAU,iBAAiB,GAAG,IAAI,EAClC,gBAAgB,eAAe,CAAC,iCAAiC,CAAC,SAanE,CAAA"}
+{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../../src/mutators/operation/parameters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAA;AAMrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAmClD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,wBAAwB,GACnC,UAAU,iBAAiB,GAAG,IAAI,EAClC,4CAA4C,eAAe,CAAC,4BAA4B,CAAC,SAyG1F,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,8BAA8B,GACzC,UAAU,iBAAiB,GAAG,IAAI,EAClC,uCAAuC,eAAe,CAAC,mCAAmC,CAAC,SA8C5F,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,wBAAwB,GACnC,UAAU,iBAAiB,GAAG,IAAI,EAClC,6BAA6B,eAAe,CAAC,4BAA4B,CAAC,SAkC3E,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,4BAA4B,GACvC,UAAU,iBAAiB,GAAG,IAAI,EAClC,gBAAgB,eAAe,CAAC,iCAAiC,CAAC,SAgBnE,CAAA"}