@scalar/workspace-store 0.68.1 → 0.68.3

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":"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"}
+{"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;CA8C3C,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

@@ -33,7 +33,8 @@ export const serializeMultipartBody = (parts, contentType = 'multipart/form-data
         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 blobFilename = part.type === 'blob' ? 'blob' : undefined;
+        const filename = part.type === 'file' ? part.value.name : blobFilename;
         const partContentType = encoded.contentType ??
             (part.type === 'file' || part.type === 'blob' ? part.value.type || 'application/octet-stream' : undefined);
         if (partContentType && /[\r\n\0]/.test(partContentType)) {

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":"AAEA,OAAO,KAAK,EACV,aAAa,EACb,iBAAiB,EAElB,MAAM,8DAA8D,CAAA;AASrE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,wBAAwB,GACnC,aAAa,iBAAiB,EAC9B,aAAa,MAAM,EACnB,kCAAkC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACxD,iBAAiB,MAAM,KACtB,OAgCF,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,GAC7B,aAAa,iBAAiB,EAC9B,aAAa,MAAM,EACnB,aAAa,MAAM,EACnB,kCAAkC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACxD,iBAAiB,MAAM,KACtB,aAAa,GAAG,IA0ClB,CAAA"}
+{"version":3,"file":"get-request-body-example.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/body/get-request-body-example.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,aAAa,EACb,iBAAiB,EAElB,MAAM,8DAA8D,CAAA;AASrE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,wBAAwB,GACnC,aAAa,iBAAiB,EAC9B,aAAa,MAAM,EACnB,kCAAkC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACxD,iBAAiB,MAAM,KACtB,OAgCF,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,GAC7B,aAAa,iBAAiB,EAC9B,aAAa,MAAM,EACnB,aAAa,MAAM,EACnB,kCAAkC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACxD,iBAAiB,MAAM,KACtB,aAAa,GAAG,IA4ClB,CAAA"}

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

@@ -58,8 +58,9 @@ export const getExampleFromBody = (requestBody, contentType, exampleName, reques
             compositionSelection: requestBodyCompositionSelection,
             schemaPath: ['requestBody'],
         });
-        if (result.xml === undefined)
+        if (result.xml === undefined) {
             return null;
+        }
         // Consumers select dataValue before value, so retain the serialized result for editor and wire output.
         return example?.dataValue !== undefined
             ? { ...example, value: result.xml, serializedValue: result.xml }

package/dist/request-example/builder/body/schema-value-coercion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema-value-coercion.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/body/schema-value-coercion.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8DAA8D,CAAA;AAShG;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,YAAY,GAAG,SAAS,EAAE,UAAU,MAAM,EAAE,KAAG,YAAY,GAAG,SASvG,CAAA;AA2BD;;;;;;;;GAQG;AACH,eAAO,MAAM,2BAA2B,GAAI,OAAO,OAAO,EAAE,QAAQ,YAAY,GAAG,SAAS,KAAG,OAe9F,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,GAAI,OAAO,OAAO,KAAG,OAUnD,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B,GAAI,QAAQ,OAAO,aAG1C,MAAM,UAAU,OAAO,YAkBzC,CAAA"}
+{"version":3,"file":"schema-value-coercion.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/body/schema-value-coercion.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8DAA8D,CAAA;AAYhG;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,YAAY,GAAG,SAAS,EAAE,UAAU,MAAM,EAAE,KAAG,YAAY,GAAG,SASvG,CAAA;AA2BD;;;;;;;;GAQG;AACH,eAAO,MAAM,2BAA2B,GAAI,OAAO,OAAO,EAAE,QAAQ,YAAY,GAAG,SAAS,KAAG,OAe9F,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,GAAI,OAAO,OAAO,KAAG,OAUnD,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B,GAAI,QAAQ,OAAO,aAG1C,MAAM,UAAU,OAAO,YAgBzC,CAAA"}

package/dist/request-example/builder/body/schema-value-coercion.js

@@ -1,21 +1,24 @@
-import { getResolvedRef, mergeSiblingReferences } from '@scalar/workspace-store/helpers/get-resolved-ref';
+import { resolveSchemaWithAnnotations } from '@scalar/workspace-store/helpers/resolve-schema-with-annotations';
 import { isObjectSchema } from '@scalar/workspace-store/schemas/v3.2/strict/type-guards';
 /** Normalize a schema's `type` (string | string[] | absent) into a plain string array. */
 const normalizeSchemaTypes = (schema) => {
     const type = 'type' in schema ? schema.type : undefined;
-    return Array.isArray(type) ? [...type] : type == null ? [] : [type];
+    if (Array.isArray(type)) {
+        return [...type];
+    }
+    return type == null ? [] : [type];
 };
 /**
  * Walk an object schema along a dotted-row path and return the resolved leaf schema,
  * or undefined when any segment is not a declared object property.
  */
 export const resolveLeafSchema = (schema, segments) => {
-    let current = schema;
+    let current = resolveSchemaWithAnnotations(schema);
     for (const segment of segments) {
         if (!current || !isObjectSchema(current) || !current.properties) {
             return undefined;
         }
-        current = getResolvedRef(current.properties[segment], mergeSiblingReferences);
+        current = resolveSchemaWithAnnotations(current.properties[segment]);
     }
     return current;
 };
@@ -97,15 +100,13 @@ export const coerceUntypedValue = (value) => {
  * back into nested objects.
  */
 export const buildDottedNestedRowPredicate = (schema) => {
-    const resolved = schema ? getResolvedRef(schema, mergeSiblingReferences) : undefined;
+    const resolved = schema ? resolveSchemaWithAnnotations(schema) : undefined;
     if (!resolved || !isObjectSchema(resolved) || !resolved.properties) {
         return (_name, _value) => false;
     }
     const nestedTopKeys = new Set();
     for (const [key, child] of Object.entries(resolved.properties)) {
-        const childResolved = child
-            ? getResolvedRef(child, mergeSiblingReferences)
-            : undefined;
+        const childResolved = child ? resolveSchemaWithAnnotations(child) : undefined;
         if (childResolved && isObjectSchema(childResolved) && childResolved.properties) {
             nestedTopKeys.add(key);
         }

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

@@ -1 +1 @@
-{"version":3,"file":"build-request.d.ts","sourceRoot":"","sources":["../../../src/request-example/builder/build-request.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,MAAM,EAAW,MAAM,8BAA8B,CAAA;AAQnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2CAA2C,CAAA;AAC/E,OAAO,EACL,KAAK,6BAA6B,EAEnC,MAAM,uDAAuD,CAAA;AAK9D;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;AAwClD;;;;;;;GAOG;AACH,eAAO,MAAM,2BAA2B,GACtC,SAAS,cAAc,EACvB,cAAc,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACpC,iBAAiB;IAAE,6BAA6B,CAAC,EAAE,OAAO,CAAA;CAAE,KAC3D,MAyBF,CAAA;AAED;;;;;KAKK;AACL,MAAM,MAAM,gBAAgB,GAAG;IAC7B,kGAAkG;IAClG,cAAc,EAAE,cAAc,CAAA;IAC9B,2BAA2B;IAC3B,UAAU,EAAE,eAAe,CAAA;IAC3B,0DAA0D;IAC1D,YAAY,EAAE,OAAO,CAAA;CACtB,CAAA;AAED,wGAAwG;AACxG,eAAO,MAAM,oBAAoB,EAAG,sBAA+B,CAAA;AAEnE,MAAM,MAAM,uBAAuB,GAAG,6BAA6B,GAAG,OAAO,oBAAoB,CAAA;AAEjG,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,gBAAgB,EAAE,uBAAuB,CAAC,CAAA;AAElF,eAAO,MAAM,YAAY,GACvB,SAAS,cAAc,EACvB,SAAS;IACP,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACpC;;;OAGG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAA;CACxC,KACA,kBAMF,CAAA"}
+{"version":3,"file":"build-request.d.ts","sourceRoot":"","sources":["../../../src/request-example/builder/build-request.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,MAAM,EAAW,MAAM,8BAA8B,CAAA;AAQnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2CAA2C,CAAA;AAC/E,OAAO,EACL,KAAK,6BAA6B,EAEnC,MAAM,uDAAuD,CAAA;AAK9D;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;AAwClD;;;;;;;GAOG;AACH,eAAO,MAAM,2BAA2B,GACtC,SAAS,cAAc,EACvB,cAAc,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACpC,iBAAiB;IAAE,6BAA6B,CAAC,EAAE,OAAO,CAAA;CAAE,KAC3D,MAyBF,CAAA;AAED;;;;;KAKK;AACL,MAAM,MAAM,gBAAgB,GAAG;IAC7B,kGAAkG;IAClG,cAAc,EAAE,cAAc,CAAA;IAC9B,2BAA2B;IAC3B,UAAU,EAAE,eAAe,CAAA;IAC3B,0DAA0D;IAC1D,YAAY,EAAE,OAAO,CAAA;CACtB,CAAA;AAED,wGAAwG;AACxG,eAAO,MAAM,oBAAoB,EAAG,sBAA+B,CAAA;AAEnE,MAAM,MAAM,uBAAuB,GAAG,6BAA6B,GAAG,OAAO,oBAAoB,CAAA;AAEjG,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,gBAAgB,EAAE,uBAAuB,CAAC,CAAA;AAElF,eAAO,MAAM,YAAY,GACvB,SAAS,cAAc,EACvB,SAAS;IACP,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACpC;;;OAGG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAA;CACxC,KACA,kBASF,CAAA"}

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

@@ -68,6 +68,9 @@ export const resolveExecutableRequestUrl = (request, envVariables, resolveOption
 /** Catch-all code when an unexpected synchronous error escapes a helper during request construction. */
 export const BUILD_REQUEST_FAILED = 'BUILD_REQUEST_FAILED';
 export const buildRequest = (request, options) => {
+    if (request.cookieErrors?.length) {
+        return err(BUILD_REQUEST_FAILED, request.cookieErrors[0]);
+    }
     const guarded = safeRun(() => buildRequestInner(request, options));
     if (!guarded.ok) {
         return err(BUILD_REQUEST_FAILED, guarded.error);

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

@@ -1,5 +1,6 @@
 import { type XScalarCookie } from '@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies';
 import type { ParameterObject, ReferenceType } from '@scalar/workspace-store/schemas/v3.2/strict/openapi-document';
+import type { ReservedPathParameter } from '../../../helpers/encode-path-parameter.js';
 /**
  * Converts the parameters into a set of headers, cookies and url params while
  * replacing environment variables and extracting example values. Also builds up a record of the path
@@ -14,10 +15,15 @@ export declare const buildRequestParameters: (
 /** All parameters */
 parameters?: ReferenceType<ParameterObject>[], 
 /** The key of the current example */
-exampleName?: string) => {
+exampleName?: string, 
+/** Reserved path expansion was introduced in OpenAPI 3.2. */
+openapiVersion?: string) => {
     cookies: XScalarCookie[];
+    /** Invalid active cookie parameters that prevent sending this request. */
+    cookieErrors?: string[];
     headers: Record<string, string>;
     pathVariables: Record<string, string>;
+    reservedPathParameters?: Record<string, ReservedPathParameter>;
     allowReservedQueryParameters: Set<string>;
     urlParams: URLSearchParams;
     serializedQuery?: string[];

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;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;IAC1B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;IAC1B,wBAAwB,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;CA8IvC,CAAA"}
+{"version":3,"file":"build-request-parameters.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/header/build-request-parameters.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,KAAK,aAAa,EAEnB,MAAM,qEAAqE,CAAA;AAE5E,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,8DAA8D,CAAA;AAElH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAA;AAqB5E;;;;;;;;;GASG;AACH,eAAO,MAAM,sBAAsB;AACjC,qBAAqB;AACrB,aAAY,aAAa,CAAC,eAAe,CAAC,EAAO;AACjD,qCAAqC;AACrC,cAAa,MAAkB;AAC/B,6DAA6D;AAC7D,iBAAiB,MAAM,KACtB;IACD,OAAO,EAAE,aAAa,EAAE,CAAA;IACxB,0EAA0E;IAC1E,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;IAC9D,4BAA4B,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACzC,SAAS,EAAE,eAAe,CAAA;IAC1B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;IAC1B,wBAAwB,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;CAyKvC,CAAA"}

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

@@ -1,10 +1,12 @@
 import { isDefined } from '@scalar/helpers/array/is-defined';
+import { getCookieSerializationError } from '@scalar/helpers/http/get-cookie-serialization-error';
 import { isObject } from '@scalar/helpers/object/is-object';
 import { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref';
 import { xScalarCookieSchema, } from '@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies';
 import { coerceValue } from '@scalar/workspace-store/schemas/typebox-coerce';
 import { getParameterExample } from '../../../helpers/get-parameter-example.js';
 import { deSerializeParameter } from '../../../request-example/builder/header/de-serialize-parameter.js';
+import { filterDisabledProperties } from './filter-disabled-properties.js';
 import { isParamDisabled } from './is-param-disabled.js';
 import { serializeContentValue, serializeCookieStyle, serializeDeepObjectStyle, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle, } from './serialize-parameter.js';
 /** Helper to get explode value with default */
@@ -23,7 +25,9 @@ export const buildRequestParameters = (
 /** All parameters */
 parameters = [], 
 /** The key of the current example */
-exampleName = 'default') => {
+exampleName = 'default', 
+/** Reserved path expansion was introduced in OpenAPI 3.2. */
+openapiVersion) => {
     const result = {
         cookies: [],
         headers: {},
@@ -44,7 +48,10 @@ exampleName = 'default') => {
         const selected = getParameterExample(param, exampleName);
         const { example, value } = selected;
         // Skip disabled examples
-        if (!example || isParamDisabled(param, example)) {
+        const propertyStates = param.in === 'query' && !selected.serialized && !selected.mediaSerialized
+            ? example?.['x-scalar-disabled-properties']
+            : undefined;
+        if (!example || (!propertyStates && isParamDisabled(param, example))) {
             continue;
         }
         /** Parameter-level wire text already contains its name, delimiters, and encoding. */
@@ -91,7 +98,13 @@ exampleName = 'default') => {
             continue;
         }
         /** De-serialize the example value if it is a string and matches the schema type */
-        const deSerializedValue = deSerializeParameter(value, param);
+        const fullValue = deSerializeParameter(value, param);
+        const deSerializedValue = propertyStates
+            ? filterDisabledProperties(fullValue, propertyStates, isParamDisabled(param, example))
+            : fullValue;
+        if (propertyStates && deSerializedValue === undefined) {
+            continue;
+        }
         const paramName = param.name;
         // Handle by parameter location
         switch (param.in) {
@@ -123,6 +136,15 @@ exampleName = 'default') => {
                 // Path parameters use simple style by default
                 const serialized = serializeSimpleStyle(deSerializedValue, getExplode(param, false));
                 result.pathVariables[paramName] = String(serialized);
+                if (openapiVersion?.startsWith('3.2.') && 'schema' in param && param.allowReserved === true) {
+                    ;
+                    (result.reservedPathParameters ??= {})[paramName] = {
+                        value: deSerializedValue,
+                        originalValue: String(serialized),
+                        style: param.style ?? 'simple',
+                        explode: getExplode(param, false),
+                    };
+                }
                 break;
             }
             case 'query': {
@@ -130,6 +152,15 @@ exampleName = 'default') => {
                 break;
             }
             case 'cookie': {
+                const [major, minor] = (openapiVersion ?? '').split('.');
+                const error = major === '3' && minor === '2' && !('content' in param)
+                    ? getCookieSerializationError(param, deSerializedValue)
+                    : undefined;
+                if (error) {
+                    ;
+                    (result.cookieErrors ??= []).push(error);
+                    break;
+                }
                 if ('style' in param && param.style === 'cookie') {
                     result.cookies.push(...serializeCookieStyle(paramName, deSerializedValue, getExplode(param, true)).map((cookie) => coerceValue(xScalarCookieSchema, { ...cookie, path: '/' })));
                     break;

package/dist/request-example/builder/header/filter-disabled-properties.d.ts

@@ -0,0 +1,3 @@
+/** Build the enabled portion of a query object without discarding stored disabled values. */
+export declare const filterDisabledProperties: (value: unknown, states: Record<string, boolean>, inheritedDisabled: boolean, path?: string[]) => unknown;
+//# sourceMappingURL=filter-disabled-properties.d.ts.map

package/dist/request-example/builder/header/filter-disabled-properties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter-disabled-properties.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/header/filter-disabled-properties.ts"],"names":[],"mappings":"AAEA,6FAA6F;AAC7F,eAAO,MAAM,wBAAwB,GACnC,OAAO,OAAO,EACd,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,mBAAmB,OAAO,EAC1B,OAAM,MAAM,EAAO,KAClB,OAgBF,CAAA"}

package/dist/request-example/builder/header/filter-disabled-properties.js

@@ -0,0 +1,18 @@
+import { isObject } from '@scalar/helpers/object/is-object';
+/** Build the enabled portion of a query object without discarding stored disabled values. */
+export const filterDisabledProperties = (value, states, inheritedDisabled, path = []) => {
+    const disabled = states[JSON.stringify(path)] ?? inheritedDisabled;
+    if (!isObject(value) || Array.isArray(value)) {
+        return disabled ? undefined : value;
+    }
+    const entries = Object.entries(value);
+    const enabled = entries.flatMap(([key, child]) => {
+        const filtered = filterDisabledProperties(child, states, disabled, [...path, key]);
+        return filtered === undefined ? [] : [[key, filtered]];
+    });
+    // Do not serialize parents whose children were all excluded.
+    if (enabled.length === 0 && (disabled || entries.length > 0)) {
+        return undefined;
+    }
+    return Object.fromEntries(enabled);
+};

package/dist/request-example/builder/header/filter-global-cookies.d.ts

@@ -3,7 +3,7 @@ import type { XScalarCookie } from '@scalar/workspace-store/schemas/extensions/g
  * Filter a global cookie to determine if it should be included with a request to the given URL.
  * - Returns false if the cookie is disabled, in the disabledGlobalCookies map, or missing a name.
  * - Returns false if the domain does not match.
- * - Returns false if the path is specified and does not match the URL pathname.
+ * - Returns false if the path is specified and the request pathname does not path-match it.
  * - Returns true otherwise.
  */
 export declare const filterGlobalCookie: ({ cookie, url, disabledGlobalCookies, }: {

package/dist/request-example/builder/header/filter-global-cookies.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"filter-global-cookies.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/header/filter-global-cookies.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qEAAqE,CAAA;AAIxG;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,GAAI,yCAIhC;IACD,MAAM,EAAE,aAAa,CAAA;IACrB,GAAG,EAAE,MAAM,CAAA;IACX,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/C,KAAG,OAqBH,CAAA"}
+{"version":3,"file":"filter-global-cookies.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/header/filter-global-cookies.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qEAAqE,CAAA;AAiBxG;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,GAAI,yCAIhC;IACD,MAAM,EAAE,aAAa,CAAA;IACrB,GAAG,EAAE,MAAM,CAAA;IACX,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/C,KAAG,OAsBH,CAAA"}

package/dist/request-example/builder/header/filter-global-cookies.js

@@ -1,9 +1,20 @@
 import { matchesDomain } from './matches-domain.js';
+/**
+ * RFC 6265 path-match: cookie-path C matches request-path R when they are the same,
+ * or C is a prefix of R and the next character is a slash. A trailing slash on C
+ * already supplies that boundary, so `/api` matches `/api/users` but not `/apiv2`.
+ */
+const pathMatches = (requestPath, cookiePath) => {
+    if (requestPath === cookiePath || cookiePath.endsWith('/')) {
+        return requestPath.startsWith(cookiePath);
+    }
+    return requestPath.startsWith(`${cookiePath}/`);
+};
 /**
  * Filter a global cookie to determine if it should be included with a request to the given URL.
  * - Returns false if the cookie is disabled, in the disabledGlobalCookies map, or missing a name.
  * - Returns false if the domain does not match.
- * - Returns false if the path is specified and does not match the URL pathname.
+ * - Returns false if the path is specified and the request pathname does not path-match it.
  * - Returns true otherwise.
  */
 export const filterGlobalCookie = ({ cookie, url, disabledGlobalCookies, }) => {
@@ -17,8 +28,9 @@ export const filterGlobalCookie = ({ cookie, url, disabledGlobalCookies, }) => {
     if (cookie.domain && !matchesDomain(url, cookie.domain)) {
         return false;
     }
-    // If a path restriction exists, ensure the cookie is only sent for URLs with a matching prefix.
-    if (cookie.path && !urlObject.pathname.startsWith(cookie.path)) {
+    // An empty path means no path restriction. Otherwise require an RFC 6265 path-match,
+    // so a cookie for `/api` is not sent to `/apiv2`.
+    if (cookie.path && !pathMatches(urlObject.pathname, cookie.path)) {
         return false;
     }
     // Cookie passed all checks; include it in the request.

package/dist/request-example/builder/header/is-param-disabled.d.ts

@@ -3,7 +3,7 @@ import type { ExampleObject, ParameterObject } from '@scalar/workspace-store/sch
  * Determines if a parameter is disabled
  *
  * First we explicitly check if its been disabled via the `x-disabled` extension.
- * Populated examples are enabled unless explicitly disabled. Empty optional parameters stay disabled.
+ * Authored populated examples are enabled unless explicitly disabled. Empty optional parameters stay disabled.
  *
  * @param param - The parameter to check.
  * @param example - The example to check.

package/dist/request-example/builder/header/is-param-disabled.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"is-param-disabled.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/header/is-param-disabled.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAA;AAIlH;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,GAC1B,OAAO,eAAe,EACtB,SAAS,aAAa,GAAG,SAAS,EAClC,kBAAiB,OAAc,KAC9B,OAiBF,CAAA"}
+{"version":3,"file":"is-param-disabled.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/header/is-param-disabled.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAA;AAKlH;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,GAC1B,OAAO,eAAe,EACtB,SAAS,aAAa,GAAG,SAAS,EAClC,kBAAiB,OAAc,KAC9B,OAiBF,CAAA"}

package/dist/request-example/builder/header/is-param-disabled.js

@@ -1,9 +1,10 @@
 import { getExampleValue } from '../../../helpers/get-example-value.js';
+import { isGeneratedExample } from '../../../request-example/builder/helpers/get-example.js';
 /**
  * Determines if a parameter is disabled
  *
  * First we explicitly check if its been disabled via the `x-disabled` extension.
- * Populated examples are enabled unless explicitly disabled. Empty optional parameters stay disabled.
+ * Authored populated examples are enabled unless explicitly disabled. Empty optional parameters stay disabled.
  *
  * @param param - The parameter to check.
  * @param example - The example to check.
@@ -18,7 +19,7 @@ export const isParamDisabled = (param, example, defaultDisabled = true) => {
     }
     // Keep the editor, generated snippets, and outgoing requests aligned for pre-populated values.
     const value = getExampleValue(example)?.value;
-    const hasValue = value !== undefined && value !== '' && value !== null;
+    const hasValue = value !== undefined && value !== '' && value !== null && !isGeneratedExample(example);
     if (!defaultDisabled || hasValue) {
         return false;
     }

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":"AAGA,OAAO,EAAE,KAAK,YAAY,EAAqD,MAAM,uBAAuB,CAAA;AAG5G,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AAE1E,OAAO,EAAE,kBAAkB,EAA0B,KAAK,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAwZ9G,gGAAgG;AAChG,eAAO,MAAM,wBAAwB,GACnC,QAAQ,YAAY,EACpB,YAAY,MAAM,EAAE,EACpB,UAAU,2BAA2B,EACrC,mBAAiB,EACjB,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC9B,YAAY,GAAG,SAmBjB,CAAA;AAuZD,sEAAsE;AACtE,MAAM,MAAM,2BAA2B,GAAG;IACxC,2EAA2E;IAC3E,CAAC,kBAAkB,CAAC,CAAC,EAAE,sBAAsB,CAAA;IAC7C,mFAAmF;IACnF,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kFAAkF;IAClF,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;AAwPD;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,yBAAyB,GAC7B,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,OA8OF,CAAA;AAoBD,gGAAgG;AAChG,eAAO,MAAM,oBAAoB,GAC/B,QAAQ,YAAY,EACpB,UAAU,2BAA2B,EACrC,UAAS,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAC,CAAC,CAAM,KAC5D,OA2BF,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;AAE1E,OAAO,EAAE,kBAAkB,EAA0B,KAAK,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAwZ9G,gGAAgG;AAChG,eAAO,MAAM,wBAAwB,GACnC,QAAQ,YAAY,EACpB,YAAY,MAAM,EAAE,EACpB,UAAU,2BAA2B,EACrC,mBAAiB,EACjB,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC9B,YAAY,GAAG,SAoBjB,CAAA;AA0ZD,sEAAsE;AACtE,MAAM,MAAM,2BAA2B,GAAG;IACxC,2EAA2E;IAC3E,CAAC,kBAAkB,CAAC,CAAC,EAAE,sBAAsB,CAAA;IAC7C,mFAAmF;IACnF,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kFAAkF;IAClF,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;AAyPD;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,yBAAyB,GAC7B,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,OAgPF,CAAA;AAoBD,gGAAgG;AAChG,eAAO,MAAM,oBAAoB,GAC/B,QAAQ,YAAY,EACpB,UAAU,2BAA2B,EACrC,UAAS,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAC,CAAC,CAAM,KAC5D,OA2BF,CAAA"}

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

@@ -324,7 +324,8 @@ const consumeCompositionSelection = (options, schemaPath, composition) => {
 };
 /** Select a composition branch once for both generated values and supplied example metadata. */
 export const selectExampleComposition = (schema, schemaPath, options, arrayItem = false, value) => {
-    const keyword = schema.oneOf ? 'oneOf' : schema.anyOf ? 'anyOf' : undefined;
+    const anyOfKeyword = schema.anyOf ? 'anyOf' : undefined;
+    const keyword = schema.oneOf ? 'oneOf' : anyOfKeyword;
     const members = keyword ? schema[keyword] : undefined;
     if (!keyword || !members?.length) {
         return undefined;
@@ -472,16 +473,14 @@ const handleObjectSchema = (schema, options, level, seen, cacheKey, schemaPath,
         // Use propertyNames enum values as example keys when no custom name is set
         const propertyNamesEnum = hasCustomName ? undefined : getPropertyNamesEnumValues(schema);
         const additionalName = hasCustomName ? customName.trim() : DEFAULT_ADDITIONAL_PROPERTIES_NAME;
-        const additionalValue = isAnyType
-            ? 'anything'
-            : typeof additional === 'object'
-                ? getExampleFromSchema(additional, options, {
-                    level: level + 1,
-                    schemaPath: [...schemaPath, additionalName],
-                    seen,
-                    dynamicScope: childScope,
-                })
-                : 'anything';
+        const additionalValue = !isAnyType && typeof additional === 'object'
+            ? getExampleFromSchema(additional, options, {
+                level: level + 1,
+                schemaPath: [...schemaPath, additionalName],
+                seen,
+                dynamicScope: childScope,
+            })
+            : 'anything';
         if (propertyNamesEnum && propertyNamesEnum.length > 0) {
             // Use the first enum value as a realistic example key
             response[String(propertyNamesEnum[0])] = additionalValue;
@@ -490,7 +489,8 @@ const handleObjectSchema = (schema, options, level, seen, cacheKey, schemaPath,
             response[additionalName] = additionalValue;
         }
     }
-    const compositionKeyword = schema.oneOf ? 'oneOf' : schema.anyOf ? 'anyOf' : undefined;
+    const anyOfKeyword = schema.anyOf ? 'anyOf' : undefined;
+    const compositionKeyword = schema.oneOf ? 'oneOf' : anyOfKeyword;
     const oneOfAnyOf = compositionKeyword ? schema[compositionKeyword] : undefined;
     if (compositionKeyword && oneOfAnyOf?.length) {
         const chosen = selectExampleComposition(schema, schemaPath, options, false, response);
@@ -593,7 +593,8 @@ const handleArraySchema = (schema, options, level, seen, cacheKey, schemaPath, d
                 .filter(isDefined);
             return cache(schema, wrapItems ? examples.map((e) => ({ [itemsXmlTagName]: e })) : examples, cacheKey, skipCache);
         }
-        const compositionKeyword = items.oneOf ? 'oneOf' : items.anyOf ? 'anyOf' : undefined;
+        const anyOfKeyword = items.anyOf ? 'anyOf' : undefined;
+        const compositionKeyword = items.oneOf ? 'oneOf' : anyOfKeyword;
         const union = compositionKeyword ? items[compositionKeyword] : undefined;
         if (compositionKeyword && union && union.length > 0) {
             const selectedIndex = getCompositionSelectionIndex(itemsSchemaPath, compositionKeyword, options, union.length) ??
@@ -730,7 +731,8 @@ const getEmptyContainer = (schema) => {
 };
 /** 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 anyOfKeyword = schema.anyOf ? 'anyOf' : undefined;
+    const compositionKeyword = schema.oneOf ? 'oneOf' : anyOfKeyword;
     const variants = compositionKeyword ? schema[compositionKeyword] : undefined;
     if (!compositionKeyword || !Array.isArray(variants) || variants.length === 0) {
         return undefined;
@@ -990,7 +992,8 @@ const generateExampleFromSchema = (schema, options, { level = 0, parentSchema, n
     }
     // Resolve non-object unions before type dispatch so shared root keywords do not
     // hide the selected member. Use the same selection and discriminator rules as other unions.
-    const selectedComposition = _schema.oneOf ? 'oneOf' : _schema.anyOf ? 'anyOf' : undefined;
+    const selectedAnyOf = _schema.anyOf ? 'anyOf' : undefined;
+    const selectedComposition = _schema.oneOf ? 'oneOf' : selectedAnyOf;
     const selectedVariant = getSelectedVariant(_schema, options, schemaPath);
     if (selectedComposition && selectedVariant) {
         const rootType = 'type' in _schema ? _schema.type : undefined;
@@ -1037,7 +1040,8 @@ const generateExampleFromSchema = (schema, options, { level = 0, parentSchema, n
         return cache(_schema, primitive, cacheKey, skipCache);
     }
     // Handle composition schemas (oneOf, anyOf)
-    const compositionKeyword = _schema.oneOf ? 'oneOf' : _schema.anyOf ? 'anyOf' : undefined;
+    const anyOfKeyword = _schema.anyOf ? 'anyOf' : undefined;
+    const compositionKeyword = _schema.oneOf ? 'oneOf' : anyOfKeyword;
     const discriminate = compositionKeyword ? _schema[compositionKeyword] : undefined;
     if (compositionKeyword && Array.isArray(discriminate) && discriminate.length > 0) {
         const candidate = selectExampleComposition(_schema, schemaPath, options);

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

@@ -1,4 +1,6 @@
 import type { ExampleObject, MediaTypeObject, ParameterObject, RequestBodyObject } from '@scalar/workspace-store/schemas/v3.2/strict/openapi-document';
+/** Whether an example contains only enum suggestions rather than authored values. */
+export declare const isGeneratedExample: (example: ExampleObject | undefined) => boolean;
 /**
  * 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.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-example.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/helpers/get-example.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EACf,eAAe,EACf,iBAAiB,EAGlB,MAAM,8DAA8D,CAAA;AAoHrE;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,GACrB,OAAO,eAAe,GAAG,iBAAiB,GAAG,eAAe,EAC5D,aAAa,MAAM,GAAG,SAAS,EAC/B,aAAa,MAAM,GAAG,SAAS,KAC9B,aAAa,GAAG,SAyBlB,CAAA"}
+{"version":3,"file":"get-example.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/helpers/get-example.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EACf,eAAe,EACf,iBAAiB,EAGlB,MAAM,8DAA8D,CAAA;AAQrE,qFAAqF;AACrF,eAAO,MAAM,kBAAkB,GAAI,SAAS,aAAa,GAAG,SAAS,KAAG,OACf,CAAA;AAuHzD;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,GACrB,OAAO,eAAe,GAAG,iBAAiB,GAAG,eAAe,EAC5D,aAAa,MAAM,GAAG,SAAS,EAC/B,aAAa,MAAM,GAAG,SAAS,KAC9B,aAAa,GAAG,SAyBlB,CAAA"}

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

@@ -1,5 +1,9 @@
 import { getResolvedRef } from '../../../helpers/get-resolved-ref.js';
 import { resolve } from '../../../resolve.js';
+// Keep suggestion provenance out of API descriptions and persisted user examples.
+const generatedExamples = new WeakSet();
+/** Whether an example contains only enum suggestions rather than authored values. */
+export const isGeneratedExample = (example) => example !== undefined && generatedExamples.has(example);
 /** Helper to get example from examples object with fallback to example field */
 const getExampleFromExamples = (examples, exampleField, exampleName) => {
     if (!examples && exampleField === undefined) {
@@ -34,15 +38,17 @@ const getSchemaExample = (input, walk = { ancestors: new Set(), withoutValues: n
     if ('default' in schema && schema.default !== undefined) {
         return { value: schema.default };
     }
-    if ('enum' in schema && schema.enum?.[0] !== undefined) {
-        return { value: schema.enum[0] };
-    }
     if ('examples' in schema && schema.examples?.[0] !== undefined) {
         return { value: schema.examples[0] };
     }
     if ('example' in schema && schema.example !== undefined) {
         return { value: schema.example };
     }
+    if ('enum' in schema && schema.enum?.[0] !== undefined) {
+        const example = { value: schema.enum[0] };
+        generatedExamples.add(example);
+        return example;
+    }
     // Reference siblings create a fresh merged object, so track the underlying schema for cycles.
     const target = getResolvedRef(input) ?? input;
     if (!('properties' in schema) || !schema.properties) {
@@ -62,7 +68,7 @@ const getSchemaExample = (input, walk = { ancestors: new Set(), withoutValues: n
     walk.ancestors.add(target);
     const properties = Object.entries(schema.properties).flatMap(([name, property]) => {
         const example = getSchemaExample(property, walk);
-        return example === undefined ? [] : [[name, example.value]];
+        return example === undefined ? [] : [{ name, example }];
     });
     walk.ancestors.delete(target);
     // Stops at schemas inside this walk have left the path, so the rest point above it.
@@ -70,7 +76,11 @@ const getSchemaExample = (input, walk = { ancestors: new Set(), withoutValues: n
     walk.stops = outerStops;
     stops.forEach((stop) => outerStops.add(stop));
     if (properties.length > 0) {
-        return { value: Object.fromEntries(properties) };
+        const example = { value: Object.fromEntries(properties.map(({ name, example }) => [name, example.value])) };
+        if (properties.every(({ example }) => isGeneratedExample(example))) {
+            generatedExamples.add(example);
+        }
+        return example;
     }
     walk.withoutValues.set(target, { properties: schema.properties, stops });
     return undefined;

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

@@ -5,6 +5,7 @@ export { type SerializedFormProperty, serializeFormPropertyWithEncoding } from '
 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 { filterDisabledProperties } from './header/filter-disabled-properties.js';
 export { filterGlobalCookie } from './header/filter-global-cookies.js';
 export { isParamDisabled } from './header/is-param-disabled.js';
 export { serializeContentValue, serializeCookieStyle, serializeDeepObjectStyle, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle, } from './header/serialize-parameter.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,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,oBAAoB,EACpB,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,kCAAkC,EAClC,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,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAC9E,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAC5D,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,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,kCAAkC,EAClC,uBAAuB,EACvB,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EACzB,gBAAgB,EAChB,0BAA0B,EAC1B,gBAAgB,GACjB,MAAM,yBAAyB,CAAA"}

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

@@ -5,6 +5,7 @@ export { serializeFormPropertyWithEncoding } from './body/serialize-form-propert
 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 { filterDisabledProperties } from './header/filter-disabled-properties.js';
 export { filterGlobalCookie } from './header/filter-global-cookies.js';
 export { isParamDisabled } from './header/is-param-disabled.js';
 export { serializeContentValue, serializeCookieStyle, serializeDeepObjectStyle, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle, } from './header/serialize-parameter.js';

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

@@ -2,6 +2,7 @@ import type { XScalarEnvironment } from '@scalar/workspace-store/schemas/extensi
 import type { XScalarCookie } from '@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies';
 import type { ServerObject } from '@scalar/workspace-store/schemas/v3.2/strict/openapi-document';
 import type { OperationObject } from '@scalar/workspace-store/schemas/v3.2/strict/operation';
+import type { ReservedPathParameter } from '../../helpers/encode-path-parameter.js';
 import { type QuerystringParameter } from '../../helpers/querystring-parameter.js';
 import { type BuildRequestSecurityResult } from '../../request-example/builder/security/build-request-security.js';
 import type { SecuritySchemeObjectSecret } from '../../request-example/builder/security/secret-types.js';
@@ -74,6 +75,8 @@ import { type RequestBody } from './body/build-request-body.js';
  * ```
  */
 export type RequestFactory = {
+    /** Invalid active cookie declarations, retained for previews and reported before sending. */
+    cookieErrors?: string[];
     /**
      * The base API server URL prior to environment or server variable substitution.
      * May still contain placeholders such as `{version}` or `{region}`.
@@ -94,6 +97,8 @@ export type RequestFactory = {
         variables: Record<string, string>;
         /** Names whose example is already URI-encoded. */
         serializedParameters?: Set<string>;
+        /** Schema-based values using OpenAPI 3.2 reserved expansion. */
+        reservedParameters?: Record<string, ReservedPathParameter>;
         /**
          * The raw request path string, as entered by the user or read from the OpenAPI schema.
          * Placeholders are not yet substituted.
@@ -198,7 +203,7 @@ export declare const requestFactory: ({ exampleName, globalCookies, method, oper
     /** The selected security schemes for the current operation */
     selectedSecuritySchemes: SecuritySchemeObjectSecret[];
     /** Selected anyOf/oneOf request-body variants keyed by schema path */
-    /** Originating OpenAPI version, used for XML mapping rules. */
+    /** Originating OpenAPI version, used for version-specific serialization. */
     openapiVersion?: string;
     requestBodyCompositionSelection?: Record<string, number>;
 }) => {

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

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

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

@@ -15,7 +15,7 @@ import { buildRequestParameters } from './header/build-request-parameters.js';
 export const requestFactory = ({ exampleName, globalCookies, method, operation, path, proxyUrl, server, defaultHeaders, isElectron, selectedSecuritySchemes, openapiVersion, requestBodyCompositionSelection, }) => {
     const requestBody = getResolvedRef(operation.requestBody);
     /** Build out the request parameters */
-    const params = buildRequestParameters(operation.parameters ?? [], exampleName);
+    const params = buildRequestParameters(operation.parameters ?? [], exampleName, openapiVersion);
     const querystringParameter = operation.parameters
         ?.map((parameter) => getResolvedRef(parameter))
         .find((parameter) => parameter?.in === 'querystring');
@@ -52,11 +52,13 @@ export const requestFactory = ({ exampleName, globalCookies, method, operation,
         headers.set('Pragma', 'no-cache');
     }
     const request = {
+        ...(params.cookieErrors ? { cookieErrors: params.cookieErrors } : {}),
         baseUrl,
         proxyUrl,
         path: {
             variables: params.pathVariables,
             ...(params.serializedPathParameters ? { serializedParameters: params.serializedPathParameters } : {}),
+            ...(params.reservedPathParameters ? { reservedParameters: params.reservedPathParameters } : {}),
             raw: path,
         },
         query: params.urlParams,