@scalar/workspace-store 0.42.0 → 0.43.0

package/dist/request-example/builder/header/matches-domain.js

@@ -0,0 +1,27 @@
+/**
+ * Matches, when:
+ * - Isn't scoped to a domain, or
+ * - matches the current host, or
+ * - or ends with the current host, or
+ * - matches the current host with a wildcard.
+ */
+export const matchesDomain = (givenUrl, configuredHostname) => {
+    if (!givenUrl || !configuredHostname) {
+        return true;
+    }
+    try {
+        // Add protocol if not present
+        const urlWithProtocol = givenUrl.startsWith('http') ? givenUrl : `http://${givenUrl}`;
+        // Get just the hostname
+        const givenHostname = new URL(urlWithProtocol).hostname;
+        // Let's see if the configured hostname matches the given hostname in some way
+        const noHostnameConfigured = !configuredHostname;
+        const hostnameMatches = configuredHostname === givenHostname;
+        const domainMatchesWildcard = configuredHostname.startsWith('.') && configuredHostname === `.${givenHostname}`;
+        const subdomainMatchesWildcard = configuredHostname.startsWith('.') && givenHostname?.endsWith(configuredHostname);
+        return noHostnameConfigured || hostnameMatches || subdomainMatchesWildcard || domainMatchesWildcard;
+    }
+    catch {
+        return false;
+    }
+};

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

@@ -0,0 +1,96 @@
+/**
+ * Shared parameter serialization utilities for OpenAPI style values.
+ * Used by both build-request-parameters and process-parameters.
+ *
+ * @see https://spec.openapis.org/oas/v3.1.1.html#style-values
+ */
+/**
+ * Serializes a value based on the content type for content-based query parameters.
+ * Content-based query parameters do not use style serialization and instead follow
+ * their content type specification (e.g., application/json should be JSON.stringified).
+ *
+ * @param value - The value to serialize
+ * @param contentType - The content type to use for serialization
+ * @returns The serialized value as a string
+ */
+export declare const serializeContentValue: (value: unknown, contentType: string) => string;
+/**
+ * Serializes a value according to OpenAPI simple style.
+ * Used for path and header parameters.
+ *
+ * Simple style with explode: false
+ * - Primitive: blue
+ * - Array: blue,black,brown
+ * - Object: R,100,G,200,B,150
+ *
+ * Simple style with explode: true
+ * - Primitive: blue
+ * - Array: blue,black,brown
+ * - Object: R=100,G=200,B=150
+ */
+export declare const serializeSimpleStyle: (value: unknown, explode: boolean) => unknown;
+/**
+ * Serializes a value according to OpenAPI form style.
+ * Used for query and cookie parameters.
+ *
+ * Form style with explode: true (default for query)
+ * - Primitive: color=blue
+ * - Array: color=blue&color=black&color=brown (multiple entries)
+ * - Object: R=100&G=200&B=150 (multiple entries)
+ *
+ * Form style with explode: false
+ * - Primitive: color=blue
+ * - Array: color=blue,black,brown
+ * - Object: color=R,100,G,200,B,150
+ */
+export declare const serializeFormStyle: (value: unknown, explode: boolean) => unknown | Array<{
+    key: string;
+    value: unknown;
+}>;
+/**
+ * Serializes a value according to OpenAPI form style for cookies.
+ * This is similar to serializeFormStyle but handles nested objects recursively
+ * and treats null values specially for cookie serialization.
+ *
+ * Form style with explode: true (default for cookies)
+ * - Primitive: color=blue
+ * - Array: color=blue&color=black&color=brown (multiple entries)
+ * - Object: R=100&G=200&B=150 (multiple entries)
+ *
+ * Form style with explode: false
+ * - Primitive: color=blue
+ * - Array: color=blue,black,brown (null becomes "null")
+ * - Object: color=R,100,G,200,B,150 (recursively flattened)
+ */
+export declare const serializeFormStyleForCookies: (value: unknown, explode: boolean) => unknown | Array<{
+    key: string;
+    value: unknown;
+}>;
+/**
+ * Serializes a value according to OpenAPI spaceDelimited style.
+ * Only valid for query parameters with array or object values.
+ *
+ * SpaceDelimited array: blue black brown
+ * SpaceDelimited object: R 100 G 200 B 150
+ */
+export declare const serializeSpaceDelimitedStyle: (value: unknown) => string;
+/**
+ * Serializes a value according to OpenAPI pipeDelimited style.
+ * Only valid for query parameters with array or object values.
+ *
+ * PipeDelimited array: blue|black|brown
+ * PipeDelimited object: R|100|G|200|B|150
+ */
+export declare const serializePipeDelimitedStyle: (value: unknown) => string;
+/**
+ * Serializes a value according to OpenAPI deepObject style.
+ * Only valid for query parameters with explode: true.
+ *
+ * DeepObject: color[R]=100&color[G]=200&color[B]=150
+ * Nested: user[name][first]=Alex&user[name][last]=Smith&user[role]=admin
+ */
+export declare const serializeDeepObjectStyle: (paramName: string, value: unknown) => Array<{
+    key: string;
+    value: string;
+}>;
+//# sourceMappingURL=serialize-parameter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"serialize-parameter.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/header/serialize-parameter.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,GAAI,OAAO,OAAO,EAAE,aAAa,MAAM,KAAG,MAa3E,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,oBAAoB,GAAI,OAAO,OAAO,EAAE,SAAS,OAAO,KAAG,OAqBvE,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,kBAAkB,GAC7B,OAAO,OAAO,EACd,SAAS,OAAO,KACf,OAAO,GAAG,KAAK,CAAC;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CA4BjD,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,4BAA4B,GACvC,OAAO,OAAO,EACd,SAAS,OAAO,KACf,OAAO,GAAG,KAAK,CAAC;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CA2CjD,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B,GAAI,OAAO,OAAO,KAAG,MAe7D,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,2BAA2B,GAAI,OAAO,OAAO,KAAG,MAe5D,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB,GAAI,WAAW,MAAM,EAAE,OAAO,OAAO,KAAG,KAAK,CAAC;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAyBhH,CAAA"}

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

@@ -0,0 +1,222 @@
+/**
+ * Shared parameter serialization utilities for OpenAPI style values.
+ * Used by both build-request-parameters and process-parameters.
+ *
+ * @see https://spec.openapis.org/oas/v3.1.1.html#style-values
+ */
+/**
+ * Serializes a value based on the content type for content-based query parameters.
+ * Content-based query parameters do not use style serialization and instead follow
+ * their content type specification (e.g., application/json should be JSON.stringified).
+ *
+ * @param value - The value to serialize
+ * @param contentType - The content type to use for serialization
+ * @returns The serialized value as a string
+ */
+export const serializeContentValue = (value, contentType) => {
+    // If already a string, return as is
+    if (typeof value === 'string') {
+        return value;
+    }
+    // Handle JSON content types
+    if (contentType.includes('json') || (typeof value === 'object' && value !== null && !Array.isArray(value))) {
+        return JSON.stringify(value);
+    }
+    // Default: convert to string
+    return String(value);
+};
+/**
+ * Serializes a value according to OpenAPI simple style.
+ * Used for path and header parameters.
+ *
+ * Simple style with explode: false
+ * - Primitive: blue
+ * - Array: blue,black,brown
+ * - Object: R,100,G,200,B,150
+ *
+ * Simple style with explode: true
+ * - Primitive: blue
+ * - Array: blue,black,brown
+ * - Object: R=100,G=200,B=150
+ */
+export const serializeSimpleStyle = (value, explode) => {
+    // Handle arrays
+    if (Array.isArray(value)) {
+        return value.join(',');
+    }
+    // Handle objects
+    if (typeof value === 'object' && value !== null) {
+        const entries = Object.entries(value);
+        if (explode) {
+            // Simple explode object: R=100,G=200,B=150
+            return entries.map(([k, v]) => `${k}=${v}`).join(',');
+        }
+        // Simple no explode object: R,100,G,200,B,150
+        return entries.map(([k, v]) => `${k},${v}`).join(',');
+    }
+    // Handle primitives - return as-is to preserve type
+    return value;
+};
+/**
+ * Serializes a value according to OpenAPI form style.
+ * Used for query and cookie parameters.
+ *
+ * Form style with explode: true (default for query)
+ * - Primitive: color=blue
+ * - Array: color=blue&color=black&color=brown (multiple entries)
+ * - Object: R=100&G=200&B=150 (multiple entries)
+ *
+ * Form style with explode: false
+ * - Primitive: color=blue
+ * - Array: color=blue,black,brown
+ * - Object: color=R,100,G,200,B,150
+ */
+export const serializeFormStyle = (value, explode) => {
+    // Handle arrays with explode
+    if (Array.isArray(value) && explode) {
+        return value.map((v) => ({ key: '', value: v }));
+    }
+    // Handle arrays without explode
+    if (Array.isArray(value)) {
+        return value.join(',');
+    }
+    // Handle objects with explode
+    if (typeof value === 'object' && value !== null && explode) {
+        return Object.entries(value).map(([k, v]) => ({
+            key: k,
+            value: v,
+        }));
+    }
+    // Handle objects without explode
+    if (typeof value === 'object' && value !== null) {
+        return Object.entries(value)
+            .map(([k, v]) => `${k},${v}`)
+            .join(',');
+    }
+    // Handle primitives - return as-is to preserve type
+    return value;
+};
+/**
+ * Serializes a value according to OpenAPI form style for cookies.
+ * This is similar to serializeFormStyle but handles nested objects recursively
+ * and treats null values specially for cookie serialization.
+ *
+ * Form style with explode: true (default for cookies)
+ * - Primitive: color=blue
+ * - Array: color=blue&color=black&color=brown (multiple entries)
+ * - Object: R=100&G=200&B=150 (multiple entries)
+ *
+ * Form style with explode: false
+ * - Primitive: color=blue
+ * - Array: color=blue,black,brown (null becomes "null")
+ * - Object: color=R,100,G,200,B,150 (recursively flattened)
+ */
+export const serializeFormStyleForCookies = (value, explode) => {
+    // Handle arrays with explode
+    if (Array.isArray(value) && explode) {
+        return value.map((v) => ({ key: '', value: v }));
+    }
+    // Handle arrays without explode - convert null to "null" string
+    if (Array.isArray(value)) {
+        return value.map((v) => (v === null ? 'null' : String(v))).join(',');
+    }
+    // Handle objects with explode
+    if (typeof value === 'object' && value !== null && explode) {
+        return Object.entries(value).map(([k, v]) => ({
+            key: k,
+            value: v,
+        }));
+    }
+    // Handle objects without explode - recursively flatten nested objects
+    if (typeof value === 'object' && value !== null) {
+        const flattenObject = (obj) => {
+            const result = [];
+            for (const [key, val] of Object.entries(obj)) {
+                // Recursively flatten nested objects
+                if (typeof val === 'object' && val !== null && !Array.isArray(val)) {
+                    result.push(key, ...flattenObject(val));
+                }
+                // Handle primitive values
+                else {
+                    result.push(key, val === null ? 'null' : String(val));
+                }
+            }
+            return result;
+        };
+        return flattenObject(value).join(',');
+    }
+    // Handle primitives - return as-is to preserve type
+    return value;
+};
+/**
+ * Serializes a value according to OpenAPI spaceDelimited style.
+ * Only valid for query parameters with array or object values.
+ *
+ * SpaceDelimited array: blue black brown
+ * SpaceDelimited object: R 100 G 200 B 150
+ */
+export const serializeSpaceDelimitedStyle = (value) => {
+    // Handle arrays
+    if (Array.isArray(value)) {
+        return value.join(' ');
+    }
+    // Handle objects
+    if (typeof value === 'object' && value !== null) {
+        return Object.entries(value)
+            .map(([k, v]) => `${k} ${v}`)
+            .join(' ');
+    }
+    // Handle primitives (shouldn't happen for spaceDelimited)
+    return String(value);
+};
+/**
+ * Serializes a value according to OpenAPI pipeDelimited style.
+ * Only valid for query parameters with array or object values.
+ *
+ * PipeDelimited array: blue|black|brown
+ * PipeDelimited object: R|100|G|200|B|150
+ */
+export const serializePipeDelimitedStyle = (value) => {
+    // Handle arrays
+    if (Array.isArray(value)) {
+        return value.join('|');
+    }
+    // Handle objects
+    if (typeof value === 'object' && value !== null) {
+        return Object.entries(value)
+            .flat()
+            .join('|');
+    }
+    // Handle primitives (shouldn't happen for pipeDelimited)
+    return String(value);
+};
+/**
+ * Serializes a value according to OpenAPI deepObject style.
+ * Only valid for query parameters with explode: true.
+ *
+ * DeepObject: color[R]=100&color[G]=200&color[B]=150
+ * Nested: user[name][first]=Alex&user[name][last]=Smith&user[role]=admin
+ */
+export const serializeDeepObjectStyle = (paramName, value) => {
+    const result = [];
+    /**
+     * Recursively flattens nested objects into deepObject notation.
+     */
+    const flatten = (obj, prefix) => {
+        for (const [key, val] of Object.entries(obj)) {
+            const fullKey = `${prefix}[${key}]`;
+            if (typeof val === 'object' && val !== null && !Array.isArray(val)) {
+                // Recursively flatten nested objects
+                flatten(val, fullKey);
+            }
+            else {
+                // Add primitive values
+                result.push({ key: fullKey, value: String(val) });
+            }
+        }
+    };
+    if (typeof value === 'object' && value !== null && !Array.isArray(value)) {
+        flatten(value, paramName);
+    }
+    return result;
+};

package/dist/request-example/builder/helpers/apply-allow-reserved-to-url.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Decodes reserved character percent-encodings only for query keys marked with
+ * OpenAPI's `allowReserved: true`.
+ */
+export declare const applyAllowReservedToUrl: (url: string, allowReservedQueryParameters: Set<string>) => string;
+//# sourceMappingURL=apply-allow-reserved-to-url.d.ts.map

package/dist/request-example/builder/helpers/apply-allow-reserved-to-url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apply-allow-reserved-to-url.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/helpers/apply-allow-reserved-to-url.ts"],"names":[],"mappings":"AAsCA;;;GAGG;AACH,eAAO,MAAM,uBAAuB,GAAI,KAAK,MAAM,EAAE,8BAA8B,GAAG,CAAC,MAAM,CAAC,KAAG,MAwChG,CAAA"}

package/dist/request-example/builder/helpers/apply-allow-reserved-to-url.js

@@ -0,0 +1,69 @@
+/**
+ * Reserved characters we can safely decode in query values when OpenAPI
+ * `allowReserved` is enabled.
+ *
+ * We intentionally keep percent-encodings for characters that can break query
+ * parsing (`#`, `&`, `=`, `?`, `[`, `]`) or change x-www-form-urlencoded
+ * semantics (`+`).
+ *
+ * @see https://spec.openapis.org/oas/v3.1.0.html#fixed-fields-10
+ */
+const DECODABLE_RESERVED_CHARACTERS_BY_PERCENT_ENCODING = {
+    '21': '!',
+    '24': '$',
+    '27': "'",
+    '28': '(',
+    '29': ')',
+    '2A': '*',
+    '2C': ',',
+    '2F': '/',
+    '3A': ':',
+    '3B': ';',
+    '40': '@',
+};
+const decodeReservedCharacters = (value) => value.replace(/%([0-9A-Fa-f]{2})/g, (match, code) => DECODABLE_RESERVED_CHARACTERS_BY_PERCENT_ENCODING[code.toUpperCase()] ?? match);
+const decodeQueryKey = (key) => {
+    try {
+        return decodeURIComponent(key.replaceAll('+', '%20'));
+    }
+    catch {
+        return key;
+    }
+};
+/**
+ * Decodes reserved character percent-encodings only for query keys marked with
+ * OpenAPI's `allowReserved: true`.
+ */
+export const applyAllowReservedToUrl = (url, allowReservedQueryParameters) => {
+    if (allowReservedQueryParameters.size === 0) {
+        return url;
+    }
+    const queryStart = url.indexOf('?');
+    if (queryStart === -1) {
+        return url;
+    }
+    const hashStart = url.indexOf('#', queryStart);
+    const urlPrefix = url.slice(0, queryStart + 1);
+    const query = hashStart === -1 ? url.slice(queryStart + 1) : url.slice(queryStart + 1, hashStart);
+    const hash = hashStart === -1 ? '' : url.slice(hashStart);
+    if (!query) {
+        return url;
+    }
+    const decodedQuery = query
+        .split('&')
+        .map((segment) => {
+        if (!segment) {
+            return segment;
+        }
+        const equalsIndex = segment.indexOf('=');
+        const rawKey = equalsIndex === -1 ? segment : segment.slice(0, equalsIndex);
+        const key = decodeQueryKey(rawKey);
+        if (!allowReservedQueryParameters.has(key) || equalsIndex === -1) {
+            return segment;
+        }
+        const rawValue = segment.slice(equalsIndex + 1);
+        return `${rawKey}=${decodeReservedCharacters(rawValue)}`;
+    })
+        .join('&');
+    return `${urlPrefix}${decodedQuery}${hash}`;
+};

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

@@ -0,0 +1,9 @@
+import type { XScalarEnvironment } from '@scalar/workspace-store/schemas/extensions/document/x-scalar-environments';
+/**
+ * Flattens the environment variables array into a key-value object.
+ * If a variable value is a string, use it directly; otherwise, use its default value.
+ *
+ * @returns An object mapping variable names to their resolved values.
+ */
+export declare const getEnvironmentVariables: (environment: XScalarEnvironment) => Record<string, string>;
+//# sourceMappingURL=get-environment-variables.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"get-environment-variables.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/helpers/get-environment-variables.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2EAA2E,CAAA;AAEnH;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,GAAI,aAAa,kBAAkB,2BAKtE,CAAA"}

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

@@ -0,0 +1,12 @@
+/**
+ * Flattens the environment variables array into a key-value object.
+ * If a variable value is a string, use it directly; otherwise, use its default value.
+ *
+ * @returns An object mapping variable names to their resolved values.
+ */
+export const getEnvironmentVariables = (environment) => {
+    return environment.variables.reduce((acc, curr) => {
+        acc[curr.name] = typeof curr.value === 'string' ? curr.value : curr.value.default;
+        return acc;
+    }, {});
+};

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

@@ -0,0 +1,40 @@
+import type { SchemaObject } from '../../../schemas/v3.1/strict/openapi-document.js';
+type GetExampleFromSchemaOptions = {
+    /** Fallback string for empty string values. */
+    emptyString?: string;
+    /** Whether to use XML tag names as keys. */
+    xml?: boolean;
+    /** Whether to show read-only/write-only properties. */
+    mode?: 'read' | 'write';
+    /** Dynamic variables which can replace values via x-variable. */
+    variables?: Record<string, unknown>;
+    /** Whether to omit empty and optional properties. */
+    omitEmptyAndOptionalProperties?: boolean;
+    /** Selected oneOf/anyOf variants keyed by schema path. */
+    compositionSelection?: Record<string, number>;
+};
+/**
+ * Generate an example value from a given OpenAPI SchemaObject.
+ *
+ * This function recursively processes OpenAPI schemas to create realistic example data.
+ * It handles all OpenAPI schema types including primitives, objects, arrays, and
+ * composition schemas (allOf, oneOf, anyOf).
+ * Uses a tonne of caching for maximum performance.
+ *
+ * @param schema - The OpenAPI SchemaObject to generate an example from.
+ * @param options - Options to customize example generation.
+ * @param level - The current recursion depth.
+ * @param parentSchema - The parent schema, if any.
+ * @param name - The name of the property being processed.
+ * @returns An example value for the given schema.
+ */
+export declare const getExampleFromSchema: (schema: SchemaObject, options?: GetExampleFromSchemaOptions, { level, parentSchema, name, seen, schemaPath, }?: Partial<{
+    level: number;
+    parentSchema: SchemaObject;
+    name: string;
+    seen: WeakSet<object>;
+    /** Internal traversal path used to resolve nested composition selections. */
+    schemaPath: string[];
+}>) => unknown;
+export {};
+//# sourceMappingURL=get-example-from-schema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"get-example-from-schema.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/helpers/get-example-from-schema.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AAwf1E,KAAK,2BAA2B,GAAG;IACjC,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,4CAA4C;IAC5C,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB,iEAAiE;IACjE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACnC,qDAAqD;IACrD,8BAA8B,CAAC,EAAE,OAAO,CAAA;IACxC,0DAA0D;IAC1D,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC9C,CAAA;AAeD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,oBAAoB,GAC/B,QAAQ,YAAY,EACpB,UAAU,2BAA2B,EACrC,mDAMG,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;CACrB,CAAM,KACN,OAiKF,CAAA"}