@scalar/workspace-store 0.52.0 → 0.54.0

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

@@ -6,6 +6,7 @@ import { unpackProxyObject } from '@scalar/workspace-store/helpers/unpack-proxy'
 import { isObjectSchema } from '@scalar/workspace-store/schemas/v3.1/strict/type-guards';
 import { getExampleFromBody } from './get-request-body-example.js';
 import { getSelectedBodyContentType } from './get-selected-body-content-type.js';
+import { serializeFormPropertyWithEncoding } from './serialize-form-property.js';
 const getMultipartEncodingContentType = (requestBody, bodyContentType, fieldName) => requestBody.content[bodyContentType]?.encoding?.[fieldName]?.contentType;
 /**
  * Build a predicate that recognizes multipart rows whose dotted name encodes a path
@@ -108,7 +109,18 @@ requestBodyCompositionSelection) => {
             if (!name) {
                 return;
             }
-            const partContentType = result.mode === 'formdata' ? getMultipartEncodingContentType(requestBody, bodyContentType, name) : undefined;
+            const partEncoding = requestBody.content[bodyContentType]?.encoding?.[name];
+            // When the encoding sets style/explode, serialize objects/arrays RFC6570-style
+            // (bracket or exploded notation) instead of JSON, so the wire request matches the
+            // generated code snippet.
+            const styleParts = serializeFormPropertyWithEncoding(name, value, partEncoding);
+            if (styleParts) {
+                for (const part of styleParts) {
+                    result.value.push({ type: 'text', key: part.key, value: part.value });
+                }
+                return;
+            }
+            const partContentType = result.mode === 'formdata' ? partEncoding?.contentType : undefined;
             // Handle file uploads
             if (value instanceof File && result.mode === 'formdata') {
                 /**
@@ -161,6 +173,15 @@ requestBodyCompositionSelection) => {
         // Convert object properties to form fields
         for (const [key, value] of Object.entries(example.value)) {
             if (key && value !== undefined && value !== null) {
+                const partEncoding = requestBody.content[bodyContentType]?.encoding?.[key];
+                // Encoding style/explode turns objects into bracket or exploded notation.
+                const styleParts = serializeFormPropertyWithEncoding(key, value, partEncoding);
+                if (styleParts) {
+                    for (const part of styleParts) {
+                        result.value.push({ key: part.key, value: part.value });
+                    }
+                    continue;
+                }
                 const stringValue = typeof value === 'object' && value !== null ? JSON.stringify(unpackProxyObject(value)) : String(value);
                 result.value.push({
                     key,
@@ -180,6 +201,16 @@ requestBodyCompositionSelection) => {
             if (!key || value === undefined || value === null) {
                 continue;
             }
+            const partEncoding = requestBody.content[bodyContentType]?.encoding?.[key];
+            // Encoding style/explode turns objects into bracket or exploded notation instead of
+            // the default single JSON part.
+            const styleParts = serializeFormPropertyWithEncoding(key, value, partEncoding);
+            if (styleParts) {
+                for (const part of styleParts) {
+                    result.value.push({ type: 'text', key: part.key, value: part.value });
+                }
+                continue;
+            }
             const partContentType = getMultipartEncodingContentType(requestBody, bodyContentType, key);
             if (value instanceof File) {
                 const unwrappedValue = unpackProxyObject(value);

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

@@ -0,0 +1,23 @@
+import type { EncodingObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+/** A single serialized form field, ready to become a multipart part or a urlencoded pair. */
+export type SerializedFormProperty = {
+    key: string;
+    value: string;
+};
+/**
+ * Serialize a `multipart/form-data` or `application/x-www-form-urlencoded` property
+ * according to its OpenAPI Encoding Object when `style` / `explode` / `allowReserved`
+ * is set. The value is serialized RFC6570-style (like a query parameter) into one or
+ * more key/value parts — for example `style: deepObject` turns `{ address: { city } }`
+ * into `address[city]=...` bracket notation, and `style: form, explode: true` breaks an
+ * object into one part per property.
+ *
+ * Returns `null` when the encoding does not opt into style-based serialization, so callers
+ * keep their default handling (JSON for objects, `contentType` parts, file uploads). This
+ * is shared by the request builder (`build-request-body`) and the code-snippet generator
+ * (`process-body`) so the request sent over the wire matches the generated snippet.
+ *
+ * @see https://spec.openapis.org/oas/v3.1.1.html#encoding-object
+ */
+export declare const serializeFormPropertyWithEncoding: (key: string, value: unknown, encoding: EncodingObject | undefined) => SerializedFormProperty[] | null;
+//# sourceMappingURL=serialize-form-property.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,101 @@
+import { unpackProxyObject } from '@scalar/workspace-store/helpers/unpack-proxy';
+import { serializeDeepObjectStyle, serializeFormStyle, serializePipeDelimitedStyle, serializeSpaceDelimitedStyle, } from '../header/serialize-parameter.js';
+/**
+ * Stringify a value emitted by `serializeFormStyle` into a form field value.
+ *
+ * Form-style serialization only addresses one level of nesting per RFC6570; deeper
+ * structures (an object or array still sitting in `entry.value`) are spec-undefined.
+ * JSON-stringify them so the output stays readable instead of `String(value)` returning
+ * `"[object Object]"`. Primitives pass through `String()` to preserve the existing wire
+ * shape (e.g. `true` -> `"true"`).
+ */
+const stringifyEntryValue = (value) => value !== null && typeof value === 'object' ? JSON.stringify(value) : String(value);
+/**
+ * Serialize a `multipart/form-data` or `application/x-www-form-urlencoded` property
+ * according to its OpenAPI Encoding Object when `style` / `explode` / `allowReserved`
+ * is set. The value is serialized RFC6570-style (like a query parameter) into one or
+ * more key/value parts — for example `style: deepObject` turns `{ address: { city } }`
+ * into `address[city]=...` bracket notation, and `style: form, explode: true` breaks an
+ * object into one part per property.
+ *
+ * Returns `null` when the encoding does not opt into style-based serialization, so callers
+ * keep their default handling (JSON for objects, `contentType` parts, file uploads). This
+ * is shared by the request builder (`build-request-body`) and the code-snippet generator
+ * (`process-body`) so the request sent over the wire matches the generated snippet.
+ *
+ * @see https://spec.openapis.org/oas/v3.1.1.html#encoding-object
+ */
+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);
+    if (!hasFormStyle) {
+        return null;
+    }
+    /**
+     * Style is a no-op for primitives, and RFC6570 expansion of binary data is undefined
+     * (spec §Appendix C). Files and arrays containing Files keep their dedicated handling in
+     * the caller, so we bail out and let the default path emit those parts.
+     */
+    if (typeof value !== 'object' ||
+        value === null ||
+        value instanceof File ||
+        (Array.isArray(value) && value.some((item) => item instanceof File))) {
+        return null;
+    }
+    const unpacked = unpackProxyObject(value);
+    /**
+     * OAS Encoding follows query-parameter defaults: when no `style` is set the default is
+     * "form"; when no `explode` is set the default is `true` for "form" and `false` otherwise.
+     */
+    const style = encoding?.style ?? 'form';
+    const explode = encoding?.explode ?? style === 'form';
+    const params = [];
+    if (style === 'deepObject') {
+        if (Array.isArray(unpacked)) {
+            /**
+             * deepObject-on-array is marked n/a by the spec; fall back to the form/explode:true
+             * shape so the array still reaches the wire instead of being silently dropped.
+             */
+            const serialized = serializeFormStyle(unpacked, true);
+            if (Array.isArray(serialized)) {
+                for (const entry of serialized) {
+                    params.push({ key: entry.key || key, value: stringifyEntryValue(entry.value) });
+                }
+            }
+            else {
+                params.push({ key, value: String(serialized) });
+            }
+        }
+        else {
+            for (const entry of serializeDeepObjectStyle(key, unpacked)) {
+                params.push({ key: entry.key, value: String(entry.value) });
+            }
+        }
+    }
+    else if (style === 'spaceDelimited') {
+        params.push({ key, value: String(serializeSpaceDelimitedStyle(unpacked)) });
+    }
+    else if (style === 'pipeDelimited') {
+        params.push({ key, value: String(serializePipeDelimitedStyle(unpacked)) });
+    }
+    else {
+        const serialized = serializeFormStyle(unpacked, explode);
+        if (Array.isArray(serialized)) {
+            for (const entry of serialized) {
+                /**
+                 * Arrays: `entry.key === ''` -> fall back to the outer name.
+                 * Objects: `entry.key` is the inner property name (the spec strips the outer name).
+                 */
+                params.push({ key: entry.key || key, value: stringifyEntryValue(entry.value) });
+            }
+        }
+        else {
+            params.push({ key, value: String(serialized) });
+        }
+    }
+    return params;
+};

package/dist/request-example/builder/header/de-serialize-parameter.d.ts

@@ -1,4 +1,7 @@
 import type { ParameterObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
-/** Helper that de-serializes the example value based on the parameter type */
+/**
+ * Coerces a parameter example from the UI (always a string from CodeInput) into a value
+ * request building can serialize. Only structured types are parsed; primitives stay as strings.
+ */
 export declare const deSerializeParameter: (example: unknown, param: ParameterObject) => any;
 //# sourceMappingURL=de-serialize-parameter.d.ts.map

package/dist/request-example/builder/header/de-serialize-parameter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"de-serialize-parameter.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/header/de-serialize-parameter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,eAAe,EAEhB,MAAM,8DAA8D,CAAA;AAErE,8EAA8E;AAC9E,eAAO,MAAM,oBAAoB,GAAI,SAAS,OAAO,EAAE,OAAO,eAAe,QAS5E,CAAA"}
+{"version":3,"file":"de-serialize-parameter.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/header/de-serialize-parameter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,eAAe,EAEhB,MAAM,8DAA8D,CAAA;AAErE;;;GAGG;AACH,eAAO,MAAM,oBAAoB,GAAI,SAAS,OAAO,EAAE,OAAO,eAAe,QAS5E,CAAA"}

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

@@ -1,5 +1,8 @@
 import { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref';
-/** Helper that de-serializes the example value based on the parameter type */
+/**
+ * Coerces a parameter example from the UI (always a string from CodeInput) into a value
+ * request building can serialize. Only structured types are parsed; primitives stay as strings.
+ */
 export const deSerializeParameter = (example, param) => {
     if ('content' in param) {
         return deSerializeContentExample(example, Object.keys(param.content ?? {})[0] ?? '');
@@ -9,39 +12,42 @@ export const deSerializeParameter = (example, param) => {
     }
     return example;
 };
-/** De-serialize the example value based on the content type */
+/**
+ * Content-based parameters (e.g. `application/json`) may hold full JSON payloads;
+ * parse those so nested structure is available to serializers.
+ */
 const deSerializeContentExample = (example, contentType) => {
     if (typeof example === 'string' && contentType.includes('json')) {
         try {
             return JSON.parse(example);
         }
         catch {
-            // Ignore the error and return the original example
+            return example;
         }
     }
     return example;
 };
-/** Create a set of all the types we wish to parse as JSON */
-const parseableTypesSet = new Set(['array', 'object', 'boolean', 'number', 'integer', 'null']);
-/** De-serialize the example value based on the schema type */
+/** Schema types that must become arrays/objects — serializers branch on `Array.isArray` / objects. */
+const structuredSchemaTypes = new Set(['array', 'object']);
+/**
+ * Schema-based parameters from the request editor.
+ *
+ * Primitives (`string`, `integer`, `number`, `boolean`, `null`) are left as the typed string
+ * Only `array` and `object` values are parsed so OpenAPI style serialization can expand them.
+ */
 const deSerializeSchemaExample = (example, schema) => {
     const resolvedSchema = getResolvedRef(schema);
     if (typeof example === 'string' && resolvedSchema && 'type' in resolvedSchema) {
         const type = Array.isArray(resolvedSchema.type) ? resolvedSchema.type[0] : resolvedSchema.type;
-        if (type && parseableTypesSet.has(type)) {
+        if (type && structuredSchemaTypes.has(type)) {
             try {
                 return JSON.parse(example);
             }
             catch {
-                // For array types, fall back to splitting comma-separated values.
-                // Users commonly enter array values as "foo,bar" or "foo, bar" in the UI
-                // text field, which is not valid JSON. Per the OpenAPI spec, the default
-                // serialization for query array parameters is style=form + explode=true,
-                // meaning each value should be sent as a separate query parameter.
+                // Arrays: users often type `foo,bar` instead of JSON — split to match default form+explode query style.
                 if (type === 'array') {
                     return example.split(/,\s?/).filter((v) => v !== '');
                 }
-                // Ignore the error and return the original example for other types
             }
         }
     }

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

@@ -1,5 +1,6 @@
 export { getExampleFromBody } from './body/get-request-body-example.js';
 export { getSelectedBodyContentType } from './body/get-selected-body-content-type.js';
+export { type SerializedFormProperty, serializeFormPropertyWithEncoding } from './body/serialize-form-property.js';
 export { BUILD_REQUEST_FAILED, type BuildRequestData, type BuildRequestFailureCode, type BuildRequestResult, type RequestPayload, buildRequest, resolveExecutableRequestUrl, } from './build-request.js';
 export { deSerializeParameter } from './header/de-serialize-parameter.js';
 export { filterGlobalCookie } from './header/filter-global-cookies.js';

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

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

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

@@ -1,5 +1,6 @@
 export { getExampleFromBody } from './body/get-request-body-example.js';
 export { getSelectedBodyContentType } from './body/get-selected-body-content-type.js';
+export { serializeFormPropertyWithEncoding } from './body/serialize-form-property.js';
 export { BUILD_REQUEST_FAILED, buildRequest, resolveExecutableRequestUrl, } from './build-request.js';
 export { deSerializeParameter } from './header/de-serialize-parameter.js';
 export { filterGlobalCookie } from './header/filter-global-cookies.js';

package/dist/request-example/context/security/extract-security-scheme-secrets.d.ts

@@ -6,5 +6,5 @@ import type { SecuritySchemeObjectSecret } from '../../../request-example/builde
 /** A combined scheme that includes both the auth store secrets and a deep partial of the config auth */
 export type ConfigAuthScheme = SecuritySchemeObject & DeepPartial<SecurityScheme>;
 /** Extract the secrets from the config and the auth store */
-export declare const extractSecuritySchemeSecrets: (scheme: SecuritySchemeObject & DeepPartial<SecurityScheme>, authStore: AuthStore, name: string, documentSlug: string) => SecuritySchemeObjectSecret;
+export declare const extractSecuritySchemeSecrets: (scheme: SecuritySchemeObject & DeepPartial<SecurityScheme>, authStore: AuthStore, name: string, documentSlug: string, oauth2RedirectUri?: string) => SecuritySchemeObjectSecret;
 //# sourceMappingURL=extract-security-scheme-secrets.d.ts.map

package/dist/request-example/context/security/extract-security-scheme-secrets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"extract-security-scheme-secrets.d.ts","sourceRoot":"","sources":["../../../../src/request-example/context/security/extract-security-scheme-secrets.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAC5D,OAAO,KAAK,EAAE,SAAS,EAA2C,MAAM,uCAAuC,CAAA;AAC/G,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iDAAiD,CAAA;AAQlF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8DAA8D,CAAA;AAExG,OAAO,KAAK,EAUV,0BAA0B,EAC3B,MAAM,iDAAiD,CAAA;AAExD,wGAAwG;AACxG,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,GAAG,WAAW,CAAC,cAAc,CAAC,CAAA;AAiLjF,6DAA6D;AAC7D,eAAO,MAAM,4BAA4B,GAEvC,QAAQ,oBAAoB,GAAG,WAAW,CAAC,cAAc,CAAC,EAC1D,WAAW,SAAS,EACpB,MAAM,MAAM,EACZ,cAAc,MAAM,KACnB,0BA2DF,CAAA"}
+{"version":3,"file":"extract-security-scheme-secrets.d.ts","sourceRoot":"","sources":["../../../../src/request-example/context/security/extract-security-scheme-secrets.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAC5D,OAAO,KAAK,EAAE,SAAS,EAA2C,MAAM,uCAAuC,CAAA;AAC/G,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iDAAiD,CAAA;AAQlF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8DAA8D,CAAA;AAExG,OAAO,KAAK,EAUV,0BAA0B,EAC3B,MAAM,iDAAiD,CAAA;AAExD,wGAAwG;AACxG,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,GAAG,WAAW,CAAC,cAAc,CAAC,CAAA;AAyLjF,6DAA6D;AAC7D,eAAO,MAAM,4BAA4B,GAEvC,QAAQ,oBAAoB,GAAG,WAAW,CAAC,cAAc,CAAC,EAC1D,WAAW,SAAS,EACpB,MAAM,MAAM,EACZ,cAAc,MAAM,EACpB,oBAAoB,MAAM,KACzB,0BA4DF,CAAA"}

package/dist/request-example/context/security/extract-security-scheme-secrets.js

@@ -14,7 +14,7 @@ const SECRET_TO_INPUT_FIELD_MAP = {
     'x-scalar-secret-auth-url': 'authorizationUrl',
     'x-scalar-secret-token-url': 'tokenUrl',
 };
-const mergeFlowSecrets = (properties, configSecrets, authStoreSecrets = {}) => Object.fromEntries(properties.map((property) => {
+const mergeFlowSecrets = (properties, configSecrets, authStoreSecrets = {}, oauth2RedirectUri) => Object.fromEntries(properties.map((property) => {
     // Redirect URI is the only OAuth secret where an explicit empty value from
     // store must be preserved. Other secrets use falsy fallback behavior for backwards-compatibility
     // with config defaults when the casted auth store value is an empty string.
@@ -23,8 +23,12 @@ const mergeFlowSecrets = (properties, configSecrets, authStoreSecrets = {}) => O
     const configInputValue = typeof configSecrets[SECRET_TO_INPUT_FIELD_MAP[property]] === 'string'
         ? configSecrets[SECRET_TO_INPUT_FIELD_MAP[property]]
         : undefined;
+    // oauth2RedirectUri (top-level config option) is used as a global fallback for the redirect URI,
+    // applied only when neither the auth store nor per-scheme config have a value. This ensures
+    // the configured redirect URI persists when switching between documents with the same OAuth config,
+    // because each document starts with no stored redirect URI (authStoreValue === undefined).
     const value = property === 'x-scalar-secret-redirect-uri'
-        ? (authStoreValue ?? configValue ?? configInputValue ?? '')
+        ? (authStoreValue ?? configValue ?? configInputValue ?? oauth2RedirectUri ?? '')
         : authStoreValue || configValue || configInputValue || '';
     return [property, value];
 }));
@@ -44,7 +48,7 @@ const extractCredentialsLocation = (configSecrets, authStoreSecrets = {}) => {
  * Extract flow secrets and selected scopes for OAuth-like flows.
  * Reused by both oauth2 and openIdConnect security schemes.
  */
-const extractOAuthFlowSecrets = (flows, storeSecrets) => {
+const extractOAuthFlowSecrets = (flows, storeSecrets, oauth2RedirectUri) => {
     const selectedScopes = new Set();
     const extractedFlows = objectEntries(flows ?? {}).reduce((acc, [key, flow]) => {
         if (!isObject(flow)) {
@@ -64,7 +68,7 @@ const extractOAuthFlowSecrets = (flows, storeSecrets) => {
                     'x-scalar-secret-redirect-uri',
                     'x-scalar-secret-token',
                     'x-scalar-secret-auth-url',
-                ], flow, storeSecrets?.implicit),
+                ], flow, storeSecrets?.implicit, oauth2RedirectUri),
                 ...extractRefreshTokenSecret(storeSecrets?.implicit),
             };
         }
@@ -109,7 +113,7 @@ const extractOAuthFlowSecrets = (flows, storeSecrets) => {
                     'x-scalar-secret-token',
                     'x-scalar-secret-auth-url',
                     'x-scalar-secret-token-url',
-                ], flow, storeSecrets?.authorizationCode),
+                ], flow, storeSecrets?.authorizationCode, oauth2RedirectUri),
                 ...extractCredentialsLocation(flow, storeSecrets?.authorizationCode),
                 ...extractRefreshTokenSecret(storeSecrets?.authorizationCode),
             };
@@ -121,7 +125,7 @@ const extractOAuthFlowSecrets = (flows, storeSecrets) => {
 /** Extract the secrets from the config and the auth store */
 export const extractSecuritySchemeSecrets = (
 // Include the config fields
-scheme, authStore, name, documentSlug) => {
+scheme, authStore, name, documentSlug, oauth2RedirectUri) => {
     const secrets = authStore.getAuthSecrets(documentSlug, name);
     // Handle API Key security schemes
     if (scheme.type === 'apiKey') {
@@ -144,7 +148,7 @@ scheme, authStore, name, documentSlug) => {
     // Handle OAuth2 security schemes and all supported flows
     if (scheme.type === 'oauth2') {
         const storeSecrets = secrets?.type === 'oauth2' ? secrets : undefined;
-        const extracted = extractOAuthFlowSecrets(scheme.flows, storeSecrets);
+        const extracted = extractOAuthFlowSecrets(scheme.flows, storeSecrets, oauth2RedirectUri);
         const configuredDefaultScopes = Array.isArray(scheme['x-default-scopes'])
             ? scheme['x-default-scopes'].filter((scope) => typeof scope === 'string')
             : [];
@@ -163,7 +167,7 @@ scheme, authStore, name, documentSlug) => {
             password: storeSecrets?.password,
             clientCredentials: storeSecrets?.clientCredentials,
             authorizationCode: storeSecrets?.authorizationCode,
-        }, storeSecrets);
+        }, storeSecrets, oauth2RedirectUri);
         return {
             ...scheme,
             ...(objectEntries(extracted.flows).length ? { flows: extracted.flows } : {}),

package/dist/request-example/context/security/merge-security.d.ts

@@ -5,5 +5,5 @@ import type { SecuritySchemeObjectSecret } from '../../../request-example/builde
 /** Document security merged with the config security schemes */
 export type MergedSecuritySchemes = Record<string, SecuritySchemeObjectSecret>;
 /** Merge the authentication config with the document security schemes + the auth store secrets */
-export declare const mergeSecurity: (documentSecuritySchemes: ComponentsObject["securitySchemes"], configSecuritySchemes: AuthenticationConfiguration["securitySchemes"], authStore: AuthStore, documentName: string) => MergedSecuritySchemes;
+export declare const mergeSecurity: (documentSecuritySchemes: ComponentsObject["securitySchemes"], configSecuritySchemes: AuthenticationConfiguration["securitySchemes"], authStore: AuthStore, documentName: string, oauth2RedirectUri?: string) => MergedSecuritySchemes;
 //# sourceMappingURL=merge-security.d.ts.map

package/dist/request-example/context/security/merge-security.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"merge-security.d.ts","sourceRoot":"","sources":["../../../../src/request-example/context/security/merge-security.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAA;AAC9E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAA;AAKtE,OAAO,EACL,KAAK,gBAAgB,EAGtB,MAAM,8DAA8D,CAAA;AAErE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,iDAAiD,CAAA;AAIjG,gEAAgE;AAChE,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAA;AAE9E,kGAAkG;AAClG,eAAO,MAAM,aAAa,GACxB,yBAAyB,gBAAgB,CAAC,iBAAiB,CAAM,EACjE,uBAAuB,2BAA2B,CAAC,iBAAiB,CAAM,EAC1E,WAAW,SAAS,EACpB,cAAc,MAAM,KACnB,qBA2BF,CAAA"}
+{"version":3,"file":"merge-security.d.ts","sourceRoot":"","sources":["../../../../src/request-example/context/security/merge-security.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAA;AAC9E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAA;AAKtE,OAAO,EACL,KAAK,gBAAgB,EAGtB,MAAM,8DAA8D,CAAA;AAErE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,iDAAiD,CAAA;AAIjG,gEAAgE;AAChE,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAA;AAE9E,kGAAkG;AAClG,eAAO,MAAM,aAAa,GACxB,yBAAyB,gBAAgB,CAAC,iBAAiB,CAAM,EACjE,uBAAuB,2BAA2B,CAAC,iBAAiB,CAAM,EAC1E,WAAW,SAAS,EACpB,cAAc,MAAM,EACpB,oBAAoB,MAAM,KACzB,qBA2BF,CAAA"}

package/dist/request-example/context/security/merge-security.js

@@ -6,7 +6,7 @@ import { coerceValue } from '@scalar/workspace-store/schemas/typebox-coerce';
 import { SecuritySchemeObjectSchema, } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
 import { extractSecuritySchemeSecrets } from './extract-security-scheme-secrets.js';
 /** Merge the authentication config with the document security schemes + the auth store secrets */
-export const mergeSecurity = (documentSecuritySchemes = {}, configSecuritySchemes = {}, authStore, documentName) => {
+export const mergeSecurity = (documentSecuritySchemes = {}, configSecuritySchemes = {}, authStore, documentName, oauth2RedirectUri) => {
     /** Resolve any refs in the document security schemes */
     const resolvedDocumentSecuritySchemes = objectEntries(documentSecuritySchemes).reduce((acc, [key, value]) => {
         const resolved = deepClone(getResolvedRef(value));
@@ -23,7 +23,7 @@ export const mergeSecurity = (documentSecuritySchemes = {}, configSecurityScheme
         const coerced = coerceValue(SecuritySchemeObjectSchema, value);
         // We then overwrite it back with the original value to keep any other fields like description, etc.
         const merged = { ...coerced, ...value };
-        acc[name] = extractSecuritySchemeSecrets(merged, authStore, name, documentName);
+        acc[name] = extractSecuritySchemeSecrets(merged, authStore, name, documentName, oauth2RedirectUri);
         return acc;
     }, {});
 };

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

@@ -1,5 +1,5 @@
 export type { ApiKeyObjectSecret, BuildRequestData, BuildRequestFailureCode, BuildRequestResult, HttpObjectSecret, OAuth2ObjectSecret, OAuthFlowAuthorizationCodeSecret, OAuthFlowClientCredentialsSecret, OAuthFlowImplicitSecret, OAuthFlowPasswordSecret, OAuthFlowsObjectSecret, OpenIdConnectObjectSecret, RequestPayload, ResolveRequestFactoryUrlError, ResolveRequestFactoryUrlResult, SecuritySchemeObjectSecret, } from './builder/index.js';
-export { BUILD_REQUEST_FAILED, INVALID_REQUEST_FACTORY_URL, MISSING_REQUEST_SERVER_BASE, type RequestFactory, buildRequest, buildRequestSecurity, deSerializeParameter, filterGlobalCookie, getEnvironmentVariables, getExample, getExampleFromBody, getExampleFromSchema, getResolvedUrl, getSelectedBodyContentType, getServerVariables, requestFactory, resolveExecutableRequestUrl, resolveRequestFactoryUrl, serializeContentValue, serializeDeepObjectStyle, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle, } from './builder/index.js';
+export { BUILD_REQUEST_FAILED, INVALID_REQUEST_FACTORY_URL, MISSING_REQUEST_SERVER_BASE, type RequestFactory, type SerializedFormProperty, buildRequest, buildRequestSecurity, deSerializeParameter, filterGlobalCookie, getEnvironmentVariables, getExample, getExampleFromBody, getExampleFromSchema, getResolvedUrl, getSelectedBodyContentType, getServerVariables, requestFactory, resolveExecutableRequestUrl, resolveRequestFactoryUrl, serializeContentValue, serializeDeepObjectStyle, serializeFormPropertyWithEncoding, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle, } from './builder/index.js';
 export type { MergedSecuritySchemes } from './context/index.js';
 export { type BuildRequestExampleContext, combineParams, filterDisabledDefaultHeaders, getActiveEnvironment, getActiveProxyUrl, getDefaultHeaders, getRequestExampleContext, getSecurityRequirements, getSecuritySchemes, getSelectedSecurity, getSelectedServer, getServers, isAuthOptional, mergeSecurity, restoreConventionalDefaultHeaderNames, restoreConventionalHeaderName, } from './context/index.js';
 export { CONTEXT_FUNCTION_NAMES, type ContextFunctionEntry, type ContextFunctionName, POPULAR_CONTEXT_FUNCTION_KEYS, contextFunctions, getContextFunctionComment, isContextFunctionName, } from './functions.js';

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

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

package/dist/request-example/index.js

@@ -1,4 +1,4 @@
-export { BUILD_REQUEST_FAILED, INVALID_REQUEST_FACTORY_URL, MISSING_REQUEST_SERVER_BASE, buildRequest, buildRequestSecurity, deSerializeParameter, filterGlobalCookie, getEnvironmentVariables, getExample, getExampleFromBody, getExampleFromSchema, getResolvedUrl, getSelectedBodyContentType, getServerVariables, requestFactory, resolveExecutableRequestUrl, resolveRequestFactoryUrl, serializeContentValue, serializeDeepObjectStyle, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle, } from './builder/index.js';
+export { BUILD_REQUEST_FAILED, INVALID_REQUEST_FACTORY_URL, MISSING_REQUEST_SERVER_BASE, buildRequest, buildRequestSecurity, deSerializeParameter, filterGlobalCookie, getEnvironmentVariables, getExample, getExampleFromBody, getExampleFromSchema, getResolvedUrl, getSelectedBodyContentType, getServerVariables, requestFactory, resolveExecutableRequestUrl, resolveRequestFactoryUrl, serializeContentValue, serializeDeepObjectStyle, serializeFormPropertyWithEncoding, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle, } from './builder/index.js';
 export { combineParams, filterDisabledDefaultHeaders, getActiveEnvironment, getActiveProxyUrl, getDefaultHeaders, getRequestExampleContext, getSecurityRequirements, getSecuritySchemes, getSelectedSecurity, getSelectedServer, getServers, isAuthOptional, mergeSecurity, restoreConventionalDefaultHeaderNames, restoreConventionalHeaderName, } from './context/index.js';
 export { CONTEXT_FUNCTION_NAMES, POPULAR_CONTEXT_FUNCTION_KEYS, contextFunctions, getContextFunctionComment, isContextFunctionName, } from './functions.js';
 export { createVariablesStoreForRequest } from './variable-store/index.js';

package/dist/schemas/extensions/document/x-scalar-sdk-installation.d.ts

@@ -1,7 +1,6 @@
 export declare const XScalarSdkInstallationSchema: import("@scalar/typebox").TObject<{
     'x-scalar-sdk-installation': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TObject<{
         lang: import("@scalar/typebox").TString;
-        source: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
         description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
     }>>>;
 }>;
@@ -9,14 +8,13 @@ export type XScalarSdkInstallation = {
     /** Scalar SDK installation information. */
     'x-scalar-sdk-installation'?: {
         lang: string;
-        source?: string;
+        /** Installation instructions in Markdown (supports fenced code blocks). */
         description?: string;
     }[];
 };
 export declare const XScalarSdkInstallation: import("@scalar/validation").ObjectSchema<{
     'x-scalar-sdk-installation': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
         lang: import("@scalar/validation").StringSchema;
-        source: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
         description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
     }>>>;
 }>;

package/dist/schemas/extensions/document/x-scalar-sdk-installation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"x-scalar-sdk-installation.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-sdk-installation.ts"],"names":[],"mappings":"AASA,eAAO,MAAM,4BAA4B;;;;;;EAEvC,CAAA;AAcF,MAAM,MAAM,sBAAsB,GAAG;IACnC,2CAA2C;IAC3C,2BAA2B,CAAC,EAAE;QAC5B,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,EAAE,CAAA;CACJ,CAAA;AAED,eAAO,MAAM,sBAAsB;;;;;;EAYlC,CAAA"}
+{"version":3,"file":"x-scalar-sdk-installation.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-sdk-installation.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,4BAA4B;;;;;EAEvC,CAAA;AAaF,MAAM,MAAM,sBAAsB,GAAG;IACnC,2CAA2C;IAC3C,2BAA2B,CAAC,EAAE;QAC5B,IAAI,EAAE,MAAM,CAAA;QACZ,2EAA2E;QAC3E,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,EAAE,CAAA;CACJ,CAAA;AAED,eAAO,MAAM,sBAAsB;;;;;EAYlC,CAAA"}

package/dist/schemas/extensions/document/x-scalar-sdk-installation.js

@@ -2,7 +2,6 @@ import { Type } from '@scalar/typebox';
 import { array, object, optional, string } from '@scalar/validation';
 const XScalarSdkInstallationItemSchema = Type.Object({
     lang: Type.String(),
-    source: Type.Optional(Type.String()),
     description: Type.Optional(Type.String()),
 });
 export const XScalarSdkInstallationSchema = Type.Object({
@@ -10,7 +9,6 @@ export const XScalarSdkInstallationSchema = Type.Object({
 });
 const XScalarSdkInstallationItem = object({
     lang: string(),
-    source: optional(string()),
     description: optional(string()),
 }, {
     typeName: 'XScalarSdkInstallationItem',

package/dist/schemas/extensions/operation/index.d.ts

@@ -1,5 +1,5 @@
 export { type XBadge, XBadgeSchema, type XBadges, XBadgesSchema, } from './x-badge.js';
-export { type XCodeSample, type XCodeSamples, XCodeSamplesSchema, } from './x-code-samples.js';
+export { type XCodeSample, type XCodeSamples, XCodeSamplesSchema, type XLanguageExample, type XReadmeCodeSample, } from './x-code-samples.js';
 export { type XScalarSelectedContentType, XScalarSelectedContentTypeSchema, } from './x-scalar-selected-content-type.js';
 export { XScalarStabilitySchema, XScalarStabilityValues, } from './x-scalar-stability.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/schemas/extensions/operation/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/operation/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,YAAY,EACZ,KAAK,OAAO,EACZ,aAAa,GACd,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,kBAAkB,GACnB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EACL,KAAK,0BAA0B,EAC/B,gCAAgC,GACjC,MAAM,kCAAkC,CAAA;AACzC,OAAO,EACL,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,sBAAsB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/operation/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,YAAY,EACZ,KAAK,OAAO,EACZ,aAAa,GACd,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,kBAAkB,EAClB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,GACvB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EACL,KAAK,0BAA0B,EAC/B,gCAAgC,GACjC,MAAM,kCAAkC,CAAA;AACzC,OAAO,EACL,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,sBAAsB,CAAA"}

package/dist/schemas/extensions/operation/x-code-samples.d.ts

@@ -14,12 +14,51 @@ export declare const XCodeSamplesSchema: import("@scalar/typebox").TObject<{
         label: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
         source: import("@scalar/typebox").TString;
     }>>>;
+    'x-readme': import("@scalar/typebox").TOptional<import("@scalar/typebox").TObject<{
+        'code-samples': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TObject<{
+            language: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
+            code: import("@scalar/typebox").TString;
+            name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
+            install: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
+            correspondingExample: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
+        }>>>;
+        'samples-languages': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
+    }>>;
+    'x-stainless-snippets': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
+    'x-stainless-examples': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TObject<{
+        title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
+        request: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
+        response: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
+    }>, import("@scalar/typebox").TArray<import("@scalar/typebox").TObject<{
+        title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
+        request: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
+        response: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
+    }>>]>>;
+    'x-scalar-examples': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TObject<{
+        lang: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
+        label: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
+        source: import("@scalar/typebox").TString;
+    }>>>;
 }>;
 export type XCodeSample = {
     lang?: string;
     label?: string;
     source: string;
 };
+/** A single ReadMe custom code sample. */
+export type XReadmeCodeSample = {
+    language?: string;
+    code: string;
+    name?: string;
+    install?: string;
+    correspondingExample?: string;
+};
+/** Per-language request snippets with an optional title and response. */
+export type XLanguageExample = {
+    title?: string;
+    request?: Record<string, string>;
+    response?: unknown;
+};
 export declare const XCodeSample: import("@scalar/validation").ObjectSchema<{
     lang: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
     label: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
@@ -29,6 +68,13 @@ export type XCodeSamples = {
     'x-codeSamples'?: XCodeSample[];
     'x-code-samples'?: XCodeSample[];
     'x-custom-examples'?: XCodeSample[];
+    'x-readme'?: {
+        'code-samples'?: XReadmeCodeSample[];
+        'samples-languages'?: string[];
+    };
+    'x-stainless-snippets'?: Record<string, string>;
+    'x-stainless-examples'?: XLanguageExample | XLanguageExample[];
+    'x-scalar-examples'?: XCodeSample[];
 };
 export declare const XCodeSamples: import("@scalar/validation").ObjectSchema<{
     'x-codeSamples': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
@@ -46,5 +92,30 @@ export declare const XCodeSamples: import("@scalar/validation").ObjectSchema<{
         label: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
         source: import("@scalar/validation").StringSchema;
     }>>>;
+    'x-readme': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
+        'code-samples': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
+            language: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
+            code: import("@scalar/validation").StringSchema;
+            name: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
+            install: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
+            correspondingExample: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
+        }>>>;
+        'samples-languages': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>>;
+    }>>;
+    'x-stainless-snippets': import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>>;
+    'x-stainless-examples': import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").ObjectSchema<{
+        title: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
+        request: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>>;
+        response: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnknownSchema>;
+    }>, import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
+        title: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
+        request: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>>;
+        response: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnknownSchema>;
+    }>>]>>;
+    'x-scalar-examples': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
+        lang: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
+        label: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
+        source: import("@scalar/validation").StringSchema;
+    }>>>;
 }>;
 //# sourceMappingURL=x-code-samples.d.ts.map