@scalar/types 0.11.0 → 0.12.0

package/dist/extensions/schema/index.d.ts

@@ -0,0 +1,75 @@
+/**
+ * This file is autogenerated. Do not edit it.
+ *
+ * Generated at: 2026-05-20T20:41:54.922Z
+ */
+/**
+ * Display name for additional properties on a schema object.
+ *
+ * @example
+ * ```yaml
+ * x-additionalPropertiesName: metadata
+ * ```
+ */
+export type XAdditionalPropertiesName = {
+    /** Human-readable label for additional properties on this schema */
+    'x-additionalPropertiesName'?: string;
+};
+/**
+ * Descriptions for enum values. Keys must match enum values.
+ *
+ * @example
+ * ```yaml
+ * x-enumDescriptions:
+ * other: Other reason
+ * ```
+ */
+export type XEnumDescriptions = {
+    /** Map or list of descriptions keyed by enum value (camelCase spelling) */
+    'x-enumDescriptions'?: Record<string, string> | string[];
+    /** Map or list of descriptions keyed by enum value (kebab-case spelling) */
+    'x-enum-descriptions'?: Record<string, string> | string[];
+};
+/**
+ * Display names for enum values. Must match the order of the `enum` array.
+ *
+ * @example
+ * ```yaml
+ * enum: [moon, asteroid]
+ * x-enum-varnames: [Moon, Asteroid]
+ * ```
+ */
+export type XEnumVarNames = {
+    /** Display names for enum values (same order as `enum`) */
+    'x-enum-varnames'?: string[];
+    /** Alias for x-enum-varnames — display names for enum values */
+    'x-enumNames'?: string[];
+};
+/**
+ * Named examples attached to a schema. Keys are example names; values are the example payloads.
+ *
+ * @example
+ * ```yaml
+ * x-examples:
+ * user:
+ * id: 1
+ * name: Ada
+ * ```
+ */
+export type XExamples = {
+    /** Map of example name to example value */
+    'x-examples'?: Record<string, any>;
+};
+/**
+ * References a variable for schema property substitution in the API client.
+ *
+ * @example
+ * ```yaml
+ * x-variable: userId
+ * ```
+ */
+export type XVariable = {
+    /** Variable name used for substitution in the API client */
+    'x-variable'?: string;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/extensions/schema/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/extensions/schema/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;GAOG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,oEAAoE;IACpE,4BAA4B,CAAC,EAAE,MAAM,CAAA;CACtC,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,2EAA2E;IAC3E,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,EAAE,CAAA;IACxD,4EAA4E;IAC5E,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,EAAE,CAAA;CAC1D,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,2DAA2D;IAC3D,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC5B,gEAAgE;IAChE,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;CACzB,CAAA;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,2CAA2C;IAC3C,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACnC,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,4DAA4D;IAC5D,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA"}

package/dist/extensions/schema/index.js

@@ -0,0 +1,6 @@
+/**
+ * This file is autogenerated. Do not edit it.
+ *
+ * Generated at: 2026-05-20T20:41:54.922Z
+ */
+export {};

package/dist/extensions/security/index.d.ts

@@ -0,0 +1,139 @@
+/**
+ * This file is autogenerated. Do not edit it.
+ *
+ * Generated at: 2026-05-20T20:41:54.922Z
+ */
+/**
+ * Default selected OAuth scopes.
+ *
+ * @example
+ * ```json
+ * { "x-default-scopes": ["profile", "email"] }
+ * ```
+ */
+export type XDefaultScopes = {
+    /** Scopes pre-selected in the OAuth consent UI */
+    'x-default-scopes'?: string[];
+};
+/** Persisted OAuth authorization URL override. Do not export when exporting the document. */
+export type XScalarAuthUrl = {
+    /** Override for the OAuth authorization endpoint URL */
+    'x-scalar-secret-auth-url'?: string;
+};
+/**
+ * Where OAuth2 credentials are sent for this security scheme.
+ *
+ * @example
+ * ```yaml
+ * x-scalar-credentials-location: header
+ * ```
+ */
+export type XScalarCredentialsLocation = {
+    /** Where OAuth2 credentials are sent (`header` or `body`) */
+    'x-scalar-credentials-location'?: 'header' | 'body';
+};
+/** Persisted OAuth client ID. Do not export when exporting the document. */
+export type XScalarSecretClientId = {
+    /** OAuth client ID */
+    'x-scalar-secret-client-id': string;
+};
+/** Persisted OAuth client secret (sensitive). Do not export when exporting the document. */
+export type XScalarSecretClientSecret = {
+    /** OAuth client secret */
+    'x-scalar-secret-client-secret': string;
+};
+/**
+ * Persisted HTTP basic credentials (sensitive). Do not export when exporting the document.
+ *
+ * @example
+ * ```yaml
+ * x-scalar-secret-username: api-user
+ * x-scalar-secret-password: secret
+ * ```
+ */
+export type XScalarSecretHTTP = {
+    /** HTTP basic auth username */
+    'x-scalar-secret-username': string;
+    /** HTTP basic auth password */
+    'x-scalar-secret-password': string;
+};
+/** Persisted OAuth redirect URI. Do not export when exporting the document. */
+export type XScalarSecretRedirectUri = {
+    /** OAuth redirect URI registered for this client */
+    'x-scalar-secret-redirect-uri': string;
+};
+/** Persisted OAuth refresh token (sensitive). Do not export when exporting the document. */
+export type XScalarSecretRefreshToken = {
+    /** Persisted OAuth refresh token */
+    'x-scalar-secret-refresh-token'?: string;
+};
+/**
+ * Persisted OAuth access token (sensitive). Do not export when exporting the document.
+ *
+ * @example
+ * ```yaml
+ * x-scalar-secret-token: eyJhbG...
+ * ```
+ */
+export type XScalarSecretToken = {
+    /** Persisted OAuth access token */
+    'x-scalar-secret-token': string;
+};
+/**
+ * Additional OAuth token request body parameters.
+ *
+ * @example
+ * ```yaml
+ * x-scalar-security-body:
+ * audience: https://api.example.com
+ * resource: user-profile
+ * ```
+ */
+export type XScalarSecurityBody = {
+    /** Additional body parameters for the OAuth token request */
+    'x-scalar-security-body'?: Record<string, string>;
+};
+/**
+ * Additional OAuth authorize query parameters.
+ *
+ * @example
+ * ```yaml
+ * x-scalar-security-query:
+ * prompt: consent
+ * audience: scalar
+ * ```
+ */
+export type XScalarSecurityQuery = {
+    /** Additional query parameters for the OAuth authorize request */
+    'x-scalar-security-query'?: Record<string, string>;
+};
+/** Persisted OAuth token URL override. Do not export when exporting the document. */
+export type XScalarTokenUrl = {
+    /** Override for the OAuth token endpoint URL */
+    'x-scalar-secret-token-url'?: string;
+};
+/**
+ * Custom OAuth2 access token field name.
+ *
+ * @example
+ * ```yaml
+ * x-tokenName: custom_access_token
+ * ```
+ */
+export type XTokenName = {
+    /** Custom field name for the OAuth2 access token in responses */
+    'x-tokenName'?: string;
+};
+/**
+ * Enables Proof Key for Code Exchange (PKCE) for the OAuth2 authorization code flow.
+ *
+ * @example
+ * ```yaml
+ * x-usePkce: SHA-256
+ * ```
+ */
+export type XusePkce = {
+    /** PKCE mode: `SHA-256`, `plain`, or `no` (disabled) */
+    'x-usePkce': 'no' | 'SHA-256' | 'plain';
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/extensions/security/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/extensions/security/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,kDAAkD;IAClD,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAA;CAC9B,CAAA;AAED,6FAA6F;AAC7F,MAAM,MAAM,cAAc,GAAG;IAC3B,wDAAwD;IACxD,0BAA0B,CAAC,EAAE,MAAM,CAAA;CACpC,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,6DAA6D;IAC7D,+BAA+B,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAA;CACpD,CAAA;AAED,4EAA4E;AAC5E,MAAM,MAAM,qBAAqB,GAAG;IAClC,sBAAsB;IACtB,2BAA2B,EAAE,MAAM,CAAA;CACpC,CAAA;AAED,4FAA4F;AAC5F,MAAM,MAAM,yBAAyB,GAAG;IACtC,0BAA0B;IAC1B,+BAA+B,EAAE,MAAM,CAAA;CACxC,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,+BAA+B;IAC/B,0BAA0B,EAAE,MAAM,CAAA;IAClC,+BAA+B;IAC/B,0BAA0B,EAAE,MAAM,CAAA;CACnC,CAAA;AAED,+EAA+E;AAC/E,MAAM,MAAM,wBAAwB,GAAG;IACrC,oDAAoD;IACpD,8BAA8B,EAAE,MAAM,CAAA;CACvC,CAAA;AAED,4FAA4F;AAC5F,MAAM,MAAM,yBAAyB,GAAG;IACtC,oCAAoC;IACpC,+BAA+B,CAAC,EAAE,MAAM,CAAA;CACzC,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,mCAAmC;IACnC,uBAAuB,EAAE,MAAM,CAAA;CAChC,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,6DAA6D;IAC7D,wBAAwB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAClD,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,kEAAkE;IAClE,yBAAyB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACnD,CAAA;AAED,qFAAqF;AACrF,MAAM,MAAM,eAAe,GAAG;IAC5B,gDAAgD;IAChD,2BAA2B,CAAC,EAAE,MAAM,CAAA;CACrC,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,iEAAiE;IACjE,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,wDAAwD;IACxD,WAAW,EAAE,IAAI,GAAG,SAAS,GAAG,OAAO,CAAA;CACxC,CAAA"}

package/dist/extensions/security/index.js

@@ -0,0 +1,6 @@
+/**
+ * This file is autogenerated. Do not edit it.
+ *
+ * Generated at: 2026-05-20T20:41:54.922Z
+ */
+export {};

package/dist/extensions/server/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file is autogenerated. Do not edit it.
+ *
+ * Generated at: 2026-05-20T20:41:54.922Z
+ */
+/**
+ * The URL of the currently selected server for this API description.
+ *
+ * @example
+ * ```yaml
+ * x-scalar-selected-server: https://api.example.com
+ * ```
+ */
+export type XScalarSelectedServer = {
+    /** The URL of the currently selected server */
+    'x-scalar-selected-server'?: string;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/extensions/server/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/extensions/server/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,+CAA+C;IAC/C,0BAA0B,CAAC,EAAE,MAAM,CAAA;CACpC,CAAA"}

package/dist/extensions/server/index.js

@@ -0,0 +1,6 @@
+/**
+ * This file is autogenerated. Do not edit it.
+ *
+ * Generated at: 2026-05-20T20:41:54.922Z
+ */
+export {};

package/dist/extensions/tag/index.d.ts

@@ -0,0 +1,55 @@
+/**
+ * This file is autogenerated. Do not edit it.
+ *
+ * Generated at: 2026-05-20T20:41:54.922Z
+ */
+/**
+ * Display-friendly name for a tag.
+ *
+ * @example
+ * ```yaml
+ * x-displayName: planets
+ * ```
+ */
+export type XDisplayName = {
+    /** Display-friendly name shown in the UI instead of the tag name */
+    'x-displayName'?: string;
+};
+export type XTagGroupBase = {
+    /** The group name. */
+    name: string;
+    /** List of tags to include in this group. */
+    tags: string[];
+};
+/**
+ * Custom display order for elements in the Scalar UI (tags, operations, tag groups).
+ *
+ * @example
+ * ```yaml
+ * x-scalar-order:
+ * - users
+ * - pets
+ * - admin
+ * ```
+ */
+export type XScalarOrder = {
+    /** Ordered list of element identifiers (tags, operations, etc.) */
+    'x-scalar-order'?: string[];
+};
+/** A tag group with optional custom ordering */
+export type XTagGroup = XTagGroupBase & XScalarOrder;
+/**
+ * Groups of tags for organizing the sidebar in the Scalar UI.
+ *
+ * @example
+ * ```yaml
+ * x-tagGroups:
+ * - name: Core API
+ * tags: [users, auth]
+ * ```
+ */
+export type XTagGroups = {
+    /** Tag groups for organizing tags in the UI */
+    'x-tagGroups'?: XTagGroup[];
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/extensions/tag/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/extensions/tag/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,oEAAoE;IACpE,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,6CAA6C;IAC7C,IAAI,EAAE,MAAM,EAAE,CAAA;CACf,CAAA;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,mEAAmE;IACnE,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;CAC5B,CAAA;AAED,gDAAgD;AAChD,MAAM,MAAM,SAAS,GAAG,aAAa,GAAG,YAAY,CAAA;AAEpD;;;;;;;;;GASG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,+CAA+C;IAC/C,aAAa,CAAC,EAAE,SAAS,EAAE,CAAA;CAC5B,CAAA"}

package/dist/extensions/tag/index.js

@@ -0,0 +1,6 @@
+/**
+ * This file is autogenerated. Do not edit it.
+ *
+ * Generated at: 2026-05-20T20:41:54.922Z
+ */
+export {};

package/dist/extensions/workspace/index.d.ts

@@ -0,0 +1,44 @@
+/**
+ * This file is autogenerated. Do not edit it.
+ *
+ * Generated at: 2026-05-20T20:41:54.922Z
+ */
+/** An open tab in the workspace */
+export type Tab = {
+    /** Tab path or document identifier */
+    path: string;
+    /** Tab title shown in the UI */
+    title: string;
+    /** Tab icon (`request` or `document`) */
+    icon?: string;
+};
+/**
+ * The currently selected proxy identifier for the workspace.
+ *
+ * @example
+ * ```json
+ * { "x-scalar-active-proxy": "my-proxy-id" }
+ * ```
+ */
+export type XScalarActiveProxy = {
+    /** The currently selected proxy identifier, or null when none is selected */
+    'x-scalar-active-proxy'?: string | null;
+};
+/**
+ * Workspace tab configuration. Persists open tabs and the active tab across sessions.
+ *
+ * @example
+ * ```yaml
+ * x-scalar-tabs:
+ * - path: /users
+ * title: Users
+ * x-scalar-active-tab: 0
+ * ```
+ */
+export type XScalarTabs = {
+    /** Tabs that are open in the workspace */
+    'x-scalar-tabs'?: Tab[];
+    /** Index of the currently active or focused tab */
+    'x-scalar-active-tab'?: number;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/extensions/workspace/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/extensions/workspace/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,mCAAmC;AACnC,MAAM,MAAM,GAAG,GAAG;IAChB,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAA;IACb,yCAAyC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,6EAA6E;IAC7E,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACxC,CAAA;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,0CAA0C;IAC1C,eAAe,CAAC,EAAE,GAAG,EAAE,CAAA;IACvB,mDAAmD;IACnD,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B,CAAA"}

package/dist/extensions/workspace/index.js

@@ -0,0 +1,6 @@
+/**
+ * This file is autogenerated. Do not edit it.
+ *
+ * Generated at: 2026-05-20T20:41:54.922Z
+ */
+export {};

package/dist/openapi/3.1/index.d.ts

@@ -0,0 +1,4 @@
+import type { OAuthFlowsObject } from './index.generated.js';
+export type { ApiKeySecuritySchemeObject, CallbackObject, ComponentsObject, ContactObject, DiscriminatorObject, EncodingObject, ExampleObject, ExternalDocumentationObject, HeaderObject, HttpSecuritySchemeObject, InfoObject, LicenseObject, LinkObject, MediaTypeObject, OAuth2SecuritySchemeObject, OAuthFlowsObject, OpenApiDocument, OpenIdConnectSecuritySchemeObject, OperationObject, ParameterObject, PathItemObject, PathsObject, RequestBodyObject, ResponseObject, ResponsesObject, SchemaObject, SecurityRequirementObject, SecuritySchemeObject, ServerObject, ServerVariableObject, TagObject, XMLObject, } from './index.generated.js';
+export type OAuthFlow = Exclude<OAuthFlowsObject['implicit' | 'password' | 'clientCredentials' | 'authorizationCode'], undefined>;
+//# sourceMappingURL=index.d.ts.map

package/dist/openapi/3.1/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/openapi/3.1/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AAEzD,YAAY,EACV,0BAA0B,EAC1B,cAAc,EACd,gBAAgB,EAChB,aAAa,EACb,mBAAmB,EACnB,cAAc,EACd,aAAa,EACb,2BAA2B,EAC3B,YAAY,EACZ,wBAAwB,EACxB,UAAU,EACV,aAAa,EACb,UAAU,EACV,eAAe,EACf,0BAA0B,EAC1B,gBAAgB,EAChB,eAAe,EACf,iCAAiC,EACjC,eAAe,EACf,eAAe,EACf,cAAc,EACd,WAAW,EACX,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,YAAY,EACZ,yBAAyB,EACzB,oBAAoB,EACpB,YAAY,EACZ,oBAAoB,EACpB,SAAS,EACT,SAAS,GACV,MAAM,mBAAmB,CAAA;AAE1B,MAAM,MAAM,SAAS,GAAG,OAAO,CAC7B,gBAAgB,CAAC,UAAU,GAAG,UAAU,GAAG,mBAAmB,GAAG,mBAAmB,CAAC,EACrF,SAAS,CACV,CAAA"}