@scalar/workspace-store 0.41.2 → 0.43.0

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

@@ -0,0 +1,19 @@
+import { replaceVariables } from '@scalar/helpers/regex/replace-variables';
+import { mergeUrls } from '@scalar/helpers/url/merge-urls';
+import { getServerVariables } from '../../../request-example/builder/helpers/get-server-variables.js';
+/**
+ * Resolves the full request URL by:
+ * 1. Applying OpenAPI server variables to the server URL template.
+ * 2. Merging the resolved server URL with the OpenAPI path and optional URL parameters.
+ * 3. Applying "allowReserved" query parameter logic if needed (for RFC3986 reserved chars).
+ *
+ * @param server - The OpenAPI server object or null
+ * @param path - The OpenAPI operation path (may contain {variables})
+ * @param urlParams - Optional URLSearchParams to include as query parameters
+ * @param allowReservedQueryParameters - Optional set of parameter names for which reserved characters should not be percent-encoded
+ * @returns The resolved URL as a string
+ */
+export const getResolvedUrl = ({ server, path, urlParams, }) => {
+    const serverVariables = getServerVariables(server);
+    return mergeUrls(replaceVariables(server?.url ?? '', serverVariables), path, urlParams);
+};

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

@@ -0,0 +1,10 @@
+import type { ServerObject } from '../../../schemas/v3.1/strict/server.js';
+/**
+ * Extracts the default values of variables defined in a ServerObject into a simple key-value map.
+ * Ignores variables with no default value.
+ *
+ * @param server The OpenAPI ServerObject (may be null).
+ * @returns Record of variableName -> defaultValue.
+ */
+export declare const getServerVariables: (server: ServerObject | null) => Record<string, string>;
+//# sourceMappingURL=get-server-variables.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"get-server-variables.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/helpers/get-server-variables.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAEhE;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,GAAI,QAAQ,YAAY,GAAG,IAAI,2BAU7D,CAAA"}

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

@@ -0,0 +1,19 @@
+import { objectEntries } from '@scalar/helpers/object/object-entries';
+/**
+ * Extracts the default values of variables defined in a ServerObject into a simple key-value map.
+ * Ignores variables with no default value.
+ *
+ * @param server The OpenAPI ServerObject (may be null).
+ * @returns Record of variableName -> defaultValue.
+ */
+export const getServerVariables = (server) => {
+    if (!server) {
+        return {};
+    }
+    return objectEntries(server?.variables ?? {}).reduce((acc, [name, variable]) => {
+        if (variable.default) {
+            acc[name] = variable.default;
+        }
+        return acc;
+    }, {});
+};

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

@@ -0,0 +1,15 @@
+export { getExampleFromBody } from './body/get-request-body-example.js';
+export { getSelectedBodyContentType } from './body/get-selected-body-content-type.js';
+export { buildRequest } from './build-request.js';
+export { deSerializeParameter } from './header/de-serialize-parameter.js';
+export { filterGlobalCookie } from './header/filter-global-cookies.js';
+export { serializeContentValue, serializeDeepObjectStyle, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle, } from './header/serialize-parameter.js';
+export { getEnvironmentVariables } from './helpers/get-environment-variables.js';
+export { getExample } from './helpers/get-example.js';
+export { getExampleFromSchema } from './helpers/get-example-from-schema.js';
+export { getResolvedUrl } from './helpers/get-resolved-url.js';
+export { getServerVariables } from './helpers/get-server-variables.js';
+export { requestFactory } from './request-factory.js';
+export { buildRequestSecurity } from './security/build-request-security.js';
+export type { ApiKeyObjectSecret, HttpObjectSecret, OAuth2ObjectSecret, OAuthFlowAuthorizationCodeSecret, OAuthFlowClientCredentialsSecret, OAuthFlowImplicitSecret, OAuthFlowPasswordSecret, OAuthFlowsObjectSecret, OpenIdConnectObjectSecret, SecuritySchemeObjectSecret, } from './security/secret-types.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +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,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAC9C,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,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,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

@@ -0,0 +1,13 @@
+export { getExampleFromBody } from './body/get-request-body-example.js';
+export { getSelectedBodyContentType } from './body/get-selected-body-content-type.js';
+export { buildRequest } from './build-request.js';
+export { deSerializeParameter } from './header/de-serialize-parameter.js';
+export { filterGlobalCookie } from './header/filter-global-cookies.js';
+export { serializeContentValue, serializeDeepObjectStyle, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle, } from './header/serialize-parameter.js';
+export { getEnvironmentVariables } from './helpers/get-environment-variables.js';
+export { getExample } from './helpers/get-example.js';
+export { getExampleFromSchema } from './helpers/get-example-from-schema.js';
+export { getResolvedUrl } from './helpers/get-resolved-url.js';
+export { getServerVariables } from './helpers/get-server-variables.js';
+export { requestFactory } from './request-factory.js';
+export { buildRequestSecurity } from './security/build-request-security.js';

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

@@ -0,0 +1,60 @@
+import type { XScalarEnvironment } from '@scalar/workspace-store/schemas/extensions/document/x-scalar-environments';
+import type { XScalarCookie } from '@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies';
+import type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+import type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/operation';
+import { type BuildRequestSecurityResult } from '../../request-example/builder/security/build-request-security.js';
+import type { SecuritySchemeObjectSecret } from '../../request-example/builder/security/secret-types.js';
+import type { RequestExampleMeta } from '../../request-example/types.js';
+import { type RequestBody } from './body/build-request-body.js';
+export type RequestFactory = {
+    baseUrl: string;
+    path: {
+        variables: Record<string, string>;
+        raw: string;
+    };
+    method: string;
+    proxy: {
+        proxyUrl: string;
+    };
+    query: {
+        params: URLSearchParams;
+    };
+    headers: Headers;
+    body: RequestBody | null;
+    cookies: {
+        list: XScalarCookie[];
+    };
+    cache: RequestCache;
+    security: BuildRequestSecurityResult[];
+    allowedReservedQueryParameters?: Set<string>;
+    options?: {
+        isElectron?: boolean;
+    };
+};
+/**
+ * Builds a request object fastory which can be used to build a request object.
+ * @returns A request object factory
+ */
+export declare const requestFactory: ({ exampleName, globalCookies, method, operation, path, proxyUrl, server, defaultHeaders, isElectron, selectedSecuritySchemes, requestBodyCompositionSelection, }: RequestExampleMeta & {
+    /** The operation object */
+    operation: OperationObject;
+    /** For environment variables in the inputs */
+    environment: XScalarEnvironment;
+    /** Workspace + document cookies */
+    globalCookies: XScalarCookie[];
+    /** The proxy URL for cookie domain determination */
+    proxyUrl: string;
+    /** The server object */
+    server: ServerObject | null;
+    /** Default headers */
+    defaultHeaders: Record<string, string>;
+    /** Whether the request is being made from an Electron environment */
+    isElectron: boolean;
+    /** The selected security schemes for the current operation */
+    selectedSecuritySchemes: SecuritySchemeObjectSecret[];
+    /** Selected anyOf/oneOf request-body variants keyed by schema path */
+    requestBodyCompositionSelection?: Record<string, number>;
+}) => {
+    request: RequestFactory;
+};
+//# sourceMappingURL=request-factory.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"request-factory.d.ts","sourceRoot":"","sources":["../../../src/request-example/builder/request-factory.ts"],"names":[],"mappings":"AAGA,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;AAG5F,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;AAEjE,OAAO,EAAE,KAAK,WAAW,EAAoB,MAAM,2BAA2B,CAAA;AAG9E,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE;QACJ,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACjC,GAAG,EAAE,MAAM,CAAA;KACZ,CAAA;IACD,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE;QACL,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,KAAK,EAAE;QACL,MAAM,EAAE,eAAe,CAAA;KACxB,CAAA;IACD,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,WAAW,GAAG,IAAI,CAAA;IACxB,OAAO,EAAE;QACP,IAAI,EAAE,aAAa,EAAE,CAAA;KACtB,CAAA;IACD,KAAK,EAAE,YAAY,CAAA;IACnB,QAAQ,EAAE,0BAA0B,EAAE,CAAA;IACtC,8BAA8B,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC5C,OAAO,CAAC,EAAE;QACR,UAAU,CAAC,EAAE,OAAO,CAAA;KACrB,CAAA;CACF,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,kKAY5B,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,+BAA+B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACzD,KAAG;IACF,OAAO,EAAE,cAAc,CAAA;CA+ExB,CAAA"}

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

@@ -0,0 +1,78 @@
+import { canMethodHaveBody } from '@scalar/helpers/http/can-method-have-body';
+import { replacePathVariables } from '@scalar/helpers/regex/replace-variables';
+import { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref';
+import { getServerVariables } from '../../request-example/builder/helpers/get-server-variables.js';
+import { buildRequestSecurity, } from '../../request-example/builder/security/build-request-security.js';
+import { buildRequestBody } from './body/build-request-body.js';
+import { buildRequestParameters } from './header/build-request-parameters.js';
+/**
+ * Builds a request object fastory which can be used to build a request object.
+ * @returns A request object factory
+ */
+export const requestFactory = ({ exampleName, globalCookies, method, operation, path, proxyUrl, server, defaultHeaders, isElectron, selectedSecuritySchemes, requestBodyCompositionSelection, }) => {
+    const requestBody = getResolvedRef(operation.requestBody);
+    /** Build out the request parameters */
+    const params = buildRequestParameters(operation.parameters ?? [], exampleName);
+    const security = buildRequestSecurity(selectedSecuritySchemes);
+    const headers = new Headers({ ...defaultHeaders, ...params.headers });
+    // If the method can have a body, build the request body, otherwise set it to null
+    const body = canMethodHaveBody(method)
+        ? buildRequestBody(requestBody, exampleName, requestBodyCompositionSelection)
+        : null;
+    // Delete the Content-Type header so the browser will set it automatically based on the request body
+    if (body?.mode === 'formdata' || body?.mode === 'urlencoded') {
+        headers.delete('Content-Type');
+    }
+    /** Combine the server url, path and url params into a single url */
+    const serverVariables = getServerVariables(server);
+    const baseUrl = replacePathVariables(server?.url ?? '', serverVariables);
+    // If we are running in Electron, we need to add a custom header
+    // that's then forwarded as a `User-Agent` header.
+    const userAgentHeader = headers.get('User-Agent');
+    if (isElectron && userAgentHeader) {
+        headers.set('X-Scalar-User-Agent', userAgentHeader);
+    }
+    const globalCookieFilter = operation['x-scalar-disable-parameters']?.['global-cookies']?.[exampleName] ?? {};
+    const cookiesList = [
+        ...globalCookies.map((c) => ({
+            ...c,
+            isDisabled: (c.isDisabled || globalCookieFilter[c.name.toLowerCase()]) ?? false,
+        })),
+        ...params.cookies,
+    ];
+    const acceptHeader = headers.get('Accept');
+    const isSseAcceptHeader = acceptHeader?.toLowerCase().includes('text/event-stream') ?? false;
+    const requestCacheMode = isSseAcceptHeader ? 'no-store' : 'default';
+    if (isSseAcceptHeader) {
+        headers.set('Cache-Control', 'no-cache');
+        headers.set('Pragma', 'no-cache');
+    }
+    const request = {
+        baseUrl,
+        proxy: {
+            proxyUrl,
+        },
+        path: {
+            variables: params.pathVariables,
+            raw: path,
+        },
+        query: {
+            params: params.urlParams,
+        },
+        method: method.toUpperCase(),
+        headers,
+        body,
+        cookies: {
+            list: cookiesList,
+        },
+        cache: requestCacheMode,
+        security,
+        options: {
+            isElectron,
+        },
+        allowedReservedQueryParameters: params.allowReservedQueryParameters,
+    };
+    return {
+        request,
+    };
+};

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

@@ -0,0 +1,24 @@
+import type { SecuritySchemeObjectSecret } from '../../../request-example/builder/security/secret-types.js';
+export type BuildRequestSecurityResult = {
+    /** The location of the security scheme */
+    in: 'header' | 'query' | 'cookie';
+    /** The name of the security scheme */
+    name: string;
+    /** The type of security scheme */
+    type: 'simple' | 'basic' | 'bearer';
+    /**
+     * The value of the security scheme
+     * For basic auth we need to base64 encode the value when we build the request
+     */
+    value: string;
+};
+/**
+ * Generates the headers, cookies and query params for selected security schemes
+ * In the future we can add customization for where the security is applied
+ */
+export declare const buildRequestSecurity: (
+/** Currently selected security for the current operation */
+selectedSecuritySchemes: SecuritySchemeObjectSecret[], 
+/** Include this parameter to set the placeholder for empty tokens */
+emptyTokenPlaceholder?: string) => BuildRequestSecurityResult[];
+//# sourceMappingURL=build-request-security.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"build-request-security.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/security/build-request-security.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,iDAAiD,CAAA;AAEjG,MAAM,MAAM,0BAA0B,GAAG;IACvC,0CAA0C;IAC1C,EAAE,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;IACjC,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,kCAAkC;IAClC,IAAI,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;IACnC;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,oBAAoB;AAC/B,4DAA4D;AAC5D,yBAAyB,0BAA0B,EAAE;AACrD,qEAAqE;AACrE,8BAA0B,KACzB,0BAA0B,EA6E5B,CAAA"}

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

@@ -0,0 +1,79 @@
+import { isDefined } from '@scalar/helpers/array/is-defined';
+/**
+ * Generates the headers, cookies and query params for selected security schemes
+ * In the future we can add customization for where the security is applied
+ */
+export const buildRequestSecurity = (
+/** Currently selected security for the current operation */
+selectedSecuritySchemes, 
+/** Include this parameter to set the placeholder for empty tokens */
+emptyTokenPlaceholder = '') => {
+    const result = [];
+    selectedSecuritySchemes.forEach((scheme) => {
+        // Api key
+        if (scheme.type === 'apiKey') {
+            const name = scheme.name;
+            const value = scheme['x-scalar-secret-token'] || emptyTokenPlaceholder;
+            if (scheme.in === 'header') {
+                return result.push({
+                    in: scheme.in,
+                    name,
+                    value,
+                    type: 'simple',
+                });
+            }
+            if (scheme.in === 'query') {
+                return result.push({
+                    in: 'query',
+                    name,
+                    value,
+                    type: 'simple',
+                });
+            }
+            if (scheme.in === 'cookie') {
+                return result.push({
+                    in: 'cookie',
+                    name,
+                    value,
+                    type: 'simple',
+                });
+            }
+        }
+        // HTTP
+        if (scheme.type === 'http') {
+            if (scheme.scheme === 'basic') {
+                const username = scheme['x-scalar-secret-username'];
+                const password = scheme['x-scalar-secret-password'];
+                const value = `${username}:${password}`;
+                return result.push({
+                    in: 'header',
+                    name: 'Authorization',
+                    // We encode the value when we build the request since we want to be able to replace the variables in the value
+                    value: value === ':' ? 'username:password' : value,
+                    type: 'basic',
+                });
+            }
+            // Bearer auth
+            const value = scheme['x-scalar-secret-token'];
+            return result.push({
+                in: 'header',
+                name: 'Authorization',
+                value: value || emptyTokenPlaceholder,
+                type: 'bearer',
+            });
+        }
+        // OAuth2
+        if (scheme.type === 'oauth2') {
+            const flows = Object.values(scheme?.flows ?? {});
+            const token = flows.filter(isDefined).find((f) => f['x-scalar-secret-token'])?.['x-scalar-secret-token'] ?? '';
+            return result.push({
+                in: 'header',
+                name: 'Authorization',
+                value: token || emptyTokenPlaceholder,
+                type: 'bearer',
+            });
+        }
+        return null;
+    });
+    return result;
+};

package/dist/request-example/builder/security/secret-types.d.ts

@@ -0,0 +1,25 @@
+import type { XScalarAuthUrl, XScalarCredentialsLocation, XScalarSecretClientId, XScalarSecretClientSecret, XScalarSecretHTTP, XScalarSecretRedirectUri, XScalarSecretRefreshToken, XScalarSecretToken, XScalarTokenUrl } from '../../../schemas/extensions/security/index.js';
+import type { OAuthFlowAuthorizationCode, OAuthFlowClientCredentials, OAuthFlowImplicit, OAuthFlowPassword } from '../../../schemas/v3.1/strict/oauth-flow.js';
+import type { ApiKeyObject, HttpObject, OAuth2Object, OpenIdConnectObject } from '../../../schemas/v3.1/strict/security-scheme.js';
+type OAuthFlowCommonSecret = XScalarSecretClientId & XScalarSecretToken & XScalarSecretRefreshToken & XScalarAuthUrl & XScalarTokenUrl;
+export type OAuthFlowImplicitSecret = OAuthFlowImplicit & OAuthFlowCommonSecret & XScalarSecretRedirectUri;
+export type OAuthFlowPasswordSecret = OAuthFlowPassword & OAuthFlowCommonSecret & XScalarSecretHTTP & XScalarSecretClientSecret & XScalarCredentialsLocation;
+export type OAuthFlowClientCredentialsSecret = OAuthFlowClientCredentials & OAuthFlowCommonSecret & XScalarSecretClientSecret & XScalarCredentialsLocation;
+export type OAuthFlowAuthorizationCodeSecret = OAuthFlowAuthorizationCode & OAuthFlowCommonSecret & XScalarSecretClientSecret & XScalarSecretRedirectUri & XScalarCredentialsLocation;
+export type OAuthFlowsObjectSecret = {
+    implicit?: OAuthFlowImplicitSecret;
+    password?: OAuthFlowPasswordSecret;
+    clientCredentials?: OAuthFlowClientCredentialsSecret;
+    authorizationCode?: OAuthFlowAuthorizationCodeSecret;
+};
+export type ApiKeyObjectSecret = ApiKeyObject & XScalarSecretToken;
+export type HttpObjectSecret = HttpObject & XScalarSecretHTTP & XScalarSecretToken;
+export type OAuth2ObjectSecret = Omit<OAuth2Object, 'flows'> & {
+    flows: OAuthFlowsObjectSecret;
+};
+export type OpenIdConnectObjectSecret = OpenIdConnectObject & {
+    flows?: OAuthFlowsObjectSecret;
+};
+export type SecuritySchemeObjectSecret = ApiKeyObjectSecret | HttpObjectSecret | OpenIdConnectObjectSecret | OAuth2ObjectSecret;
+export {};
+//# sourceMappingURL=secret-types.d.ts.map

package/dist/request-example/builder/security/secret-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"secret-types.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/security/secret-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,0BAA0B,EAC1B,qBAAqB,EACrB,yBAAyB,EACzB,iBAAiB,EACjB,wBAAwB,EACxB,yBAAyB,EACzB,kBAAkB,EAClB,eAAe,EAChB,MAAM,+BAA+B,CAAA;AACtC,OAAO,KAAK,EACV,0BAA0B,EAC1B,0BAA0B,EAC1B,iBAAiB,EACjB,iBAAiB,EAClB,MAAM,kCAAkC,CAAA;AACzC,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAA;AAExH,KAAK,qBAAqB,GAAG,qBAAqB,GAChD,kBAAkB,GAClB,yBAAyB,GACzB,cAAc,GACd,eAAe,CAAA;AAEjB,MAAM,MAAM,uBAAuB,GAAG,iBAAiB,GAAG,qBAAqB,GAAG,wBAAwB,CAAA;AAE1G,MAAM,MAAM,uBAAuB,GAAG,iBAAiB,GACrD,qBAAqB,GACrB,iBAAiB,GACjB,yBAAyB,GACzB,0BAA0B,CAAA;AAE5B,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,GACvE,qBAAqB,GACrB,yBAAyB,GACzB,0BAA0B,CAAA;AAE5B,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,GACvE,qBAAqB,GACrB,yBAAyB,GACzB,wBAAwB,GACxB,0BAA0B,CAAA;AAE5B,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,CAAC,EAAE,uBAAuB,CAAA;IAClC,QAAQ,CAAC,EAAE,uBAAuB,CAAA;IAClC,iBAAiB,CAAC,EAAE,gCAAgC,CAAA;IACpD,iBAAiB,CAAC,EAAE,gCAAgC,CAAA;CACrD,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG,kBAAkB,CAAA;AAClE,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,iBAAiB,GAAG,kBAAkB,CAAA;AAClF,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,GAAG;IAAE,KAAK,EAAE,sBAAsB,CAAA;CAAE,CAAA;AAChG,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,GAAG;IAAE,KAAK,CAAC,EAAE,sBAAsB,CAAA;CAAE,CAAA;AAEhG,MAAM,MAAM,0BAA0B,GAClC,kBAAkB,GAClB,gBAAgB,GAChB,yBAAyB,GACzB,kBAAkB,CAAA"}

package/dist/request-example/builder/security/secret-types.js

@@ -0,0 +1 @@
+export {};

package/dist/request-example/context/environment.d.ts

@@ -0,0 +1,21 @@
+import type { WorkspaceStore } from '../../client.js';
+import { type XScalarEnvironment } from '../../schemas/extensions/document/x-scalar-environments.js';
+import type { WorkspaceDocument } from '../../schemas/workspace.js';
+/**
+ * Returns the active environment context for a given workspace and document.
+ *
+ * - If there is no workspace, returns a default (empty) environment.
+ * - If no environment is selected (no active environment), returns a default environment.
+ * - Otherwise, combines variables from both the workspace and document environments,
+ *   merging document environment values over workspace ones. The variables arrays from both
+ *   sources are concatenated and passed through the environment schema.
+ *
+ * @param workspace Workspace store instance or null if unavailable
+ * @param document Document data or null if unavailable
+ * @returns An object with the environment name (or null) and a validated XScalarEnvironment
+ */
+export declare const getActiveEnvironment: (workspace: WorkspaceStore | null, document: WorkspaceDocument | null) => {
+    name: string | null;
+    environment: XScalarEnvironment;
+};
+//# sourceMappingURL=environment.d.ts.map

package/dist/request-example/context/environment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../../src/request-example/context/environment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAC9C,OAAO,EAAE,KAAK,kBAAkB,EAA4B,MAAM,qDAAqD,CAAA;AAEvH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAE5D;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,oBAAoB,GAC/B,WAAW,cAAc,GAAG,IAAI,EAChC,UAAU,iBAAiB,GAAG,IAAI,KACjC;IACD,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,WAAW,EAAE,kBAAkB,CAAA;CAqChC,CAAA"}

package/dist/request-example/context/environment.js

@@ -0,0 +1,49 @@
+import { xScalarEnvironmentSchema } from '../../schemas/extensions/document/x-scalar-environments.js';
+import { coerceValue } from '../../schemas/typebox-coerce.js';
+/**
+ * Returns the active environment context for a given workspace and document.
+ *
+ * - If there is no workspace, returns a default (empty) environment.
+ * - If no environment is selected (no active environment), returns a default environment.
+ * - Otherwise, combines variables from both the workspace and document environments,
+ *   merging document environment values over workspace ones. The variables arrays from both
+ *   sources are concatenated and passed through the environment schema.
+ *
+ * @param workspace Workspace store instance or null if unavailable
+ * @param document Document data or null if unavailable
+ * @returns An object with the environment name (or null) and a validated XScalarEnvironment
+ */
+export const getActiveEnvironment = (workspace, document) => {
+    // If workspace is null, return default (empty) environment
+    if (workspace === null) {
+        return {
+            name: null,
+            environment: coerceValue(xScalarEnvironmentSchema, {}),
+        };
+    }
+    // Get the name of the currently active environment from workspace
+    const activeEnv = workspace.workspace['x-scalar-active-environment'];
+    // If no active environment is set, return default (empty) environment
+    if (!activeEnv) {
+        return {
+            name: null,
+            environment: coerceValue(xScalarEnvironmentSchema, {}),
+        };
+    }
+    // Get environment variables from workspace and document (if present)
+    const workspaceEnv = workspace.workspace['x-scalar-environments']?.[activeEnv] ?? {
+        variables: [],
+    };
+    const documentEnv = document?.['x-scalar-environments']?.[activeEnv] ?? {
+        variables: [],
+    };
+    // Merge workspace and document variables, with document variables appended
+    return {
+        name: activeEnv,
+        environment: coerceValue(xScalarEnvironmentSchema, {
+            ...workspaceEnv,
+            ...documentEnv,
+            variables: [...workspaceEnv.variables, ...documentEnv.variables],
+        }),
+    };
+};

package/dist/request-example/context/get-request-example-context.d.ts

@@ -0,0 +1,57 @@
+import type { WorkspaceStore } from '../../client.js';
+import type { SelectedSecurity } from '../../entities/auth/index.js';
+import type { AuthMeta, ServerMeta } from '../../events/index.js';
+import type { SecuritySchemeObjectSecret } from '../../request-example/builder/security/secret-types.js';
+import { type Layout } from '../../request-example/context/proxy.js';
+import { type MergedSecuritySchemes } from '../../request-example/context/security/merge-security.js';
+import type { RequestExampleMeta, Result } from '../../request-example/types.js';
+import type { XScalarEnvironment } from '../../schemas/extensions/document/x-scalar-environments.js';
+import type { XScalarCookie } from '../../schemas/extensions/general/x-scalar-cookies.js';
+import type { OperationObject } from '../../schemas/v3.1/strict/operation.js';
+import type { SecurityRequirementObject } from '../../schemas/v3.1/strict/security-requirement.js';
+import type { ServerObject } from '../../schemas/v3.1/strict/server.js';
+import type { WorkspaceDocument } from '../../schemas/workspace.js';
+type BuildRequestExampleContext = {
+    operation: OperationObject;
+    environment: {
+        name: string | null;
+        environment: XScalarEnvironment;
+    };
+    cookies: {
+        workspace: XScalarCookie[];
+        document: XScalarCookie[];
+    };
+    servers: {
+        list: ServerObject[];
+        selected: ServerObject | null;
+        meta: ServerMeta;
+    };
+    proxy: {
+        url: string | null;
+    };
+    headers: {
+        default: Record<string, string>;
+    };
+    security: {
+        schemes: MergedSecuritySchemes;
+        requirements: SecurityRequirementObject[];
+        selected: SelectedSecurity;
+        selectedSchemes: SecuritySchemeObjectSecret[];
+        meta: AuthMeta;
+    };
+};
+export declare const getRequestExampleContext: (workspaceStore: WorkspaceStore, documentName: string, requestExampleMeta: RequestExampleMeta, options?: Partial<{
+    servers: ServerObject[];
+    baseServerUrl: string;
+    layout: Layout;
+    appVersion: string;
+    isElectron: boolean;
+    /**
+     * When the document is not in `workspace.documents[documentName]` yet, use this copy (same shape as the
+     * workspace entry). Callers that already hold the resolved document should pass it so behavior matches
+     * reading from props.
+     */
+    fallbackDocument: WorkspaceDocument | null;
+}>) => Result<BuildRequestExampleContext>;
+export {};
+//# sourceMappingURL=get-request-example-context.d.ts.map

package/dist/request-example/context/get-request-example-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-request-example-context.d.ts","sourceRoot":"","sources":["../../../src/request-example/context/get-request-example-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AACvD,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAEpD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,iDAAiD,CAAA;AAIjG,OAAO,EAAE,KAAK,MAAM,EAAqB,MAAM,iCAAiC,CAAA;AAIhF,OAAO,EAAE,KAAK,qBAAqB,EAAiB,MAAM,mDAAmD,CAAA;AAE7G,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AACzE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qDAAqD,CAAA;AAC7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+CAA+C,CAAA;AAClF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AACtE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAA;AAC3F,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAChE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAE5D,KAAK,0BAA0B,GAAG;IAChC,SAAS,EAAE,eAAe,CAAA;IAC1B,WAAW,EAAE;QACX,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;QACnB,WAAW,EAAE,kBAAkB,CAAA;KAChC,CAAA;IACD,OAAO,EAAE;QACP,SAAS,EAAE,aAAa,EAAE,CAAA;QAC1B,QAAQ,EAAE,aAAa,EAAE,CAAA;KAC1B,CAAA;IACD,OAAO,EAAE;QACP,IAAI,EAAE,YAAY,EAAE,CAAA;QACpB,QAAQ,EAAE,YAAY,GAAG,IAAI,CAAA;QAC7B,IAAI,EAAE,UAAU,CAAA;KACjB,CAAA;IACD,KAAK,EAAE;QACL,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;KACnB,CAAA;IACD,OAAO,EAAE;QACP,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAChC,CAAA;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,qBAAqB,CAAA;QAC9B,YAAY,EAAE,yBAAyB,EAAE,CAAA;QACzC,QAAQ,EAAE,gBAAgB,CAAA;QAC1B,eAAe,EAAE,0BAA0B,EAAE,CAAA;QAC7C,IAAI,EAAE,QAAQ,CAAA;KACf,CAAA;CACF,CAAA;AAED,eAAO,MAAM,wBAAwB,GACnC,gBAAgB,cAAc,EAC9B,cAAc,MAAM,EACpB,oBAAoB,kBAAkB,EACtC,UAAS,OAAO,CAAC;IACf,OAAO,EAAE,YAAY,EAAE,CAAA;IACvB,aAAa,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,OAAO,CAAA;IACnB;;;;OAIG;IACH,gBAAgB,EAAE,iBAAiB,GAAG,IAAI,CAAA;CAC3C,CAAM,KACN,MAAM,CAAC,0BAA0B,CAmInC,CAAA"}

package/dist/request-example/context/get-request-example-context.js

@@ -0,0 +1,115 @@
+import { getResolvedRef } from '../../helpers/get-resolved-ref.js';
+import { getActiveEnvironment } from '../../request-example/context/environment.js';
+import { getDefaultHeaders } from '../../request-example/context/headers.js';
+import { combineParams } from '../../request-example/context/helpers/combine-params.js';
+import { getActiveProxyUrl } from '../../request-example/context/proxy.js';
+import { getSecurityRequirements } from '../../request-example/context/security/get-security-requirements.js';
+import { getSecuritySchemes } from '../../request-example/context/security/get-security-schemes.js';
+import { getSelectedSecurity } from '../../request-example/context/security/get-selected-security.js';
+import { mergeSecurity } from '../../request-example/context/security/merge-security.js';
+import { getSelectedServer, getServers } from '../../request-example/context/servers.js';
+export const getRequestExampleContext = (workspaceStore, documentName, requestExampleMeta, options = {}) => {
+    const { path, method, exampleName } = requestExampleMeta;
+    const document = workspaceStore.workspace.documents[documentName] ?? options.fallbackDocument ?? undefined;
+    if (!document) {
+        return {
+            ok: false,
+            error: `Document ${documentName} not found`,
+        };
+    }
+    const pathItem = getResolvedRef(document.paths?.[path]);
+    if (!pathItem) {
+        return {
+            ok: false,
+            error: `Path ${path} not found`,
+        };
+    }
+    const resolvedOperation = getResolvedRef(pathItem[method]);
+    if (!resolvedOperation) {
+        return {
+            ok: false,
+            error: `Method ${method} not found on path ${path}`,
+        };
+    }
+    // Combine the path item and operation parameters
+    const operation = {
+        ...resolvedOperation,
+        parameters: combineParams(pathItem.parameters, resolvedOperation.parameters ?? []),
+    };
+    //------------------------------------------------------------------------------------------------
+    //                                 ENVIRONMENT CONTEXT
+    //------------------------------------------------------------------------------------------------
+    // Get environment context for the request example
+    const environment = getActiveEnvironment(workspaceStore, document);
+    //------------------------------------------------------------------------------------------------
+    //                                 SERVER CONTEXT
+    //------------------------------------------------------------------------------------------------
+    // Get server context for the request example
+    const serverList = getServers(options.servers ?? operation.servers ?? document.servers, {
+        baseServerUrl: options.baseServerUrl,
+        documentUrl: document['x-scalar-original-source-url'],
+    });
+    const selectedServer = getSelectedServer(document, operation, options.servers ?? null, serverList);
+    //------------------------------------------------------------------------------------------------
+    //                                 SECURITY CONTEXT
+    //------------------------------------------------------------------------------------------------
+    const documentSelectedSecurity = workspaceStore.auth.getAuthSelectedSchemas({
+        type: 'document',
+        documentName,
+    });
+    const operationSelectedSecurity = workspaceStore.auth.getAuthSelectedSchemas({
+        type: 'operation',
+        documentName,
+        path: path ?? '',
+        method: method ?? 'get',
+    });
+    const securitySchemes = mergeSecurity(document.components?.securitySchemes ?? {}, {}, workspaceStore.auth, documentName);
+    const securityRequirements = getSecurityRequirements(document.security, operation.security);
+    const selectedSecurity = getSelectedSecurity(documentSelectedSecurity, operationSelectedSecurity, securityRequirements, securitySchemes);
+    /** The above selected requirements in scheme form */
+    const selectedSecuritySchemes = getSecuritySchemes(securitySchemes, selectedSecurity.selectedSchemes);
+    const serverMeta = operation.servers != null ? { type: 'operation', path: path ?? '', method: method ?? 'get' } : { type: 'document' };
+    const authMeta = operationSelectedSecurity !== undefined
+        ? { type: 'operation', path: path ?? '', method: method ?? 'get' }
+        : { type: 'document' };
+    //------------------------------------------------------------------------------------------------
+    //                                 PROXY URL
+    //------------------------------------------------------------------------------------------------
+    // Get proxy url for the request example
+    const proxyUrl = getActiveProxyUrl(workspaceStore.workspace['x-scalar-active-proxy'], options.layout ?? 'other');
+    const defaultHeaders = getDefaultHeaders({
+        method,
+        operation,
+        exampleName,
+        options: { appVersion: options.appVersion ?? '0.0.0', isElectron: options.isElectron ?? false },
+    });
+    return {
+        ok: true,
+        data: {
+            operation,
+            environment,
+            cookies: {
+                workspace: workspaceStore.workspace['x-scalar-cookies'] ?? [],
+                document: document['x-scalar-cookies'] ?? [],
+            },
+            headers: {
+                default: defaultHeaders,
+            },
+            servers: {
+                list: serverList,
+                selected: selectedServer,
+                meta: serverMeta,
+            },
+            proxy: {
+                url: proxyUrl,
+            },
+            security: {
+                schemes: securitySchemes,
+                requirements: securityRequirements,
+                selected: selectedSecurity,
+                selectedSchemes: selectedSecuritySchemes,
+                meta: authMeta,
+            },
+        },
+    };
+};