@scalar/types 0.9.6 → 0.12.0

package/dist/api-reference/types.d.ts

@@ -0,0 +1,444 @@
+import type { PartialDeep } from 'type-fest';
+/** Some common properties used in all security schemes */
+type SecuirtySchemeCommon = {
+    description: string | undefined;
+};
+type ExtendedSecurityScheme = {
+    uid: any;
+    /** The name key that links a security requirement to a security object */
+    nameKey: string;
+};
+type SecuritySchemeApiKeyIn = 'query' | 'header' | 'cookie';
+type OasSecurityApiKey = {
+    type: 'apiKey';
+    /** REQUIRED. The name of the header, query or cookie parameter to be used. */
+    name: string;
+    /** REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie". */
+    in: SecuritySchemeApiKeyIn;
+    /** REQUIRED. The API key to be sent in the Authorization header or as a cookie. */
+    value: string;
+};
+export type SecuritySchemeApiKey = SecuirtySchemeCommon & ExtendedSecurityScheme & OasSecurityApiKey;
+type OasSecurityHttp = {
+    type: 'http';
+    /** REQUIRED. The name of the HTTP Authorization scheme to be used in the Authorization header as defined in
+     * [RFC7235]. The values used SHOULD be registered in the IANA Authentication Scheme registry. */
+    scheme: 'basic' | 'bearer';
+    /** A hint to the client to identify how the bearer token is formatted.
+     * Bearer tokens are usually generated by an authorization server, so
+     * this information is primarily for documentation purposes. */
+    bearerFormat: 'JWT' | string;
+    /** The username to be sent in the Authorization header. */
+    username: string;
+    /** The password to be sent in the Authorization header. */
+    password: string;
+    /** The token to be sent in the Authorization header. */
+    token: string;
+};
+export type SecuritySchemeHttp = SecuirtySchemeCommon & ExtendedSecurityScheme & OasSecurityHttp;
+type OasSecurityOpenIdConnect = {
+    type: 'openIdConnect';
+    /** REQUIRED. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the
+     * form of a URL. The OpenID Connect standard requires the use of TLS. */
+    openIdConnectUrl: string;
+};
+export type SecuritySchemeOpenIdConnect = SecuirtySchemeCommon & ExtendedSecurityScheme & OasSecurityOpenIdConnect;
+type FlowsCommon = {
+    /**
+     * The URL to be used for obtaining refresh tokens. This MUST be in the form of a
+     * URL. The OAuth2 standard requires the use of TLS.
+     */
+    'refreshUrl'?: string;
+    /**
+     * REQUIRED. The available scopes for the OAuth2 security scheme. A map
+     * between the scope name and a short description for it. The map MAY be empty.
+     */
+    'scopes'?: Record<string, string>;
+    'selectedScopes'?: string[];
+    /** Extension to save the client Id associated with an oauth flow */
+    'x-scalar-client-id'?: string;
+    /** The auth token */
+    'token'?: string;
+    /** Additional query parameters for the OAuth authorization request. Example: { prompt: 'consent', audience: 'scalar' }. */
+    'x-scalar-security-query'?: Record<string, string>;
+    /** Additional body parameters for the OAuth token request. Example: { audience: 'foo' }. */
+    'x-scalar-security-body'?: Record<string, string>;
+    /** Extension to specify custom token name in the response (defaults to 'access_token') */
+    'x-tokenName'?: string;
+};
+type PkceOptions = 'SHA-256' | 'plain' | 'no';
+type CredentialsLocationExtension = 'header' | 'body';
+type OasSecurityOauth2FlowImplicit = {
+    type: 'oauth2';
+    'x-default-scopes'?: string[];
+    flows: {
+        implicit: FlowsCommon & {
+            type: 'implicit';
+            authorizationUrl: string;
+            'x-scalar-redirect-uri'?: string;
+        };
+        password: FlowsCommon & {
+            type: 'password';
+            tokenUrl: string;
+            clientSecret: string;
+            username: string;
+            password: string;
+            'x-scalar-credentials-location'?: CredentialsLocationExtension;
+        };
+        clientCredentials: FlowsCommon & {
+            type: 'clientCredentials';
+            tokenUrl: string;
+            clientSecret: string;
+            'x-scalar-credentials-location'?: CredentialsLocationExtension;
+        };
+        authorizationCode: FlowsCommon & {
+            type: 'authorizationCode';
+            authorizationUrl: string;
+            tokenUrl: string;
+            clientSecret: string;
+            'x-scalar-credentials-location'?: CredentialsLocationExtension;
+            'x-usePkce'?: PkceOptions;
+            'x-scalar-redirect-uri'?: string;
+        };
+    };
+};
+export type SecuritySchemeOauth2 = SecuirtySchemeCommon & ExtendedSecurityScheme & OasSecurityOauth2FlowImplicit;
+export type SecurityScheme = SecuritySchemeApiKey | SecuritySchemeHttp | SecuritySchemeOpenIdConnect | SecuritySchemeOauth2;
+/**
+ * Authentication configuration for the API reference.
+ * This config is not validated so does not need a zod schema
+ */
+export type AuthenticationConfiguration = {
+    /**
+     * Specifies the preferred security scheme(s) to use for authentication.
+     * Can be one of:
+     * - A single security scheme name (string)
+     * - An array of security scheme names (OR relationship)
+     * - An array containing strings or arrays of strings (AND/OR relationship)
+     */
+    preferredSecurityScheme?: string | (string | string[])[] | null;
+    /**
+     * Setting security schemes this way will allow you to override any value in your openapi document
+     * You will also be able to set additional values such as api tokens etc.
+     *
+     * Set them via the nameKey in your components.securitySchemes.[nameKey]
+     *
+     * @example
+     * ```ts
+     * {
+     *   authentication: {
+     *     preferredSecurityScheme: 'apiKeyHeader',
+     *     securitySchemes: {
+     *       apiKeyHeader: {
+     *         value: 'tokenValue'
+     *       },
+     *       httpBearer: {
+     *         token: 'xyz token value'
+     *       },
+     *       httpBasic: {
+     *         username: 'username',
+     *         password: 'password'
+     *       },
+     *       oauth2: {
+     *         flows: {
+     *           authorizationCode: {
+     *             token: 'auth code token'
+     *           }
+     *         }
+     *       },
+     *     },
+     *   }
+     * }
+     * ```
+     *
+     */
+    securitySchemes?: Record<string, PartialDeep<SecurityScheme>>;
+    /**
+     * Allows adding authentication which is not in the document.
+     * When true, generic options (API Key, HTTP Basic, OAuth2, etc.) are shown in the auth dropdown.
+     * @default false
+     */
+    createAnySecurityScheme?: boolean;
+};
+export type SpecificationExtension = {
+    name: string;
+    component: unknown;
+    renderer?: unknown;
+};
+export type ViewComponent = {
+    component: unknown;
+    renderer?: unknown;
+    props?: Record<string, any>;
+};
+export type LifecycleHooks = {
+    onInit?: ({ config }: {
+        config: Partial<BaseConfiguration>;
+    }) => void;
+    onConfigChange?: ({ config }: {
+        config: Partial<BaseConfiguration>;
+    }) => void;
+    onDestroy?: () => void;
+};
+export type ApiReferencePlugin = () => {
+    name: string;
+    extensions: SpecificationExtension[];
+    views?: {
+        'content.end'?: ViewComponent[];
+    };
+    hooks?: LifecycleHooks;
+    apiClientPlugins?: any[];
+};
+export type ExternalUrls = {
+    dashboardUrl: string;
+    registryUrl: string;
+    proxyUrl: string;
+    apiBaseUrl: string;
+};
+export type BaseConfiguration = {
+    /** The title of the OpenAPI document. */
+    title?: string;
+    /** The slug of the OpenAPI document used in the URL. If none is passed, the title will be used. If no title is used, it will just use the index. */
+    slug?: string;
+    /** Prefill authentication */
+    authentication?: any;
+    /** Base URL for the API server */
+    baseServerURL?: string;
+    /** Whether to hide the client button */
+    hideClientButton: boolean;
+    /** URL to a request proxy for the API client */
+    proxyUrl?: string;
+    /** Default OAuth 2.0 redirect URI used to prefill auth flows in the API client. */
+    oauth2RedirectUri?: string;
+    /** Key used with CTRL/CMD to open the search modal (defaults to 'k' e.g. CMD+k) */
+    searchHotKey?: 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z';
+    /** List of OpenAPI server objects */
+    servers?: any[];
+    /** Whether to show the sidebar */
+    showSidebar: boolean;
+    /** Whether and when to show the developer tools. */
+    showDeveloperTools: 'localhost' | 'always' | 'never';
+    /** @deprecated Use showDeveloperTools instead */
+    showToolbar: 'localhost' | 'always' | 'never';
+    /** Whether to use the operation summary or the operation path for the sidebar and search */
+    operationTitleSource: 'summary' | 'path';
+    /** A string to use one of the color presets */
+    theme: 'default' | 'alternate' | 'moon' | 'purple' | 'solarized' | 'bluePlanet' | 'deepSpace' | 'saturn' | 'kepler' | 'elysiajs' | 'fastify' | 'mars' | 'laserwave' | 'none';
+    /** Integration type identifier */
+    _integration?: 'adonisjs' | 'astro' | 'docusaurus' | 'dotnet' | 'elysiajs' | 'express' | 'fastapi' | 'fastify' | 'go' | 'hono' | 'html' | 'laravel' | 'litestar' | 'nestjs' | 'nextjs' | 'nitro' | 'nuxt' | 'platformatic' | 'react' | 'rust' | 'svelte' | 'vue' | null;
+    /** onRequestSent is fired when a request is sent */
+    onRequestSent?: (input: string) => void;
+    /** Whether to persist auth to local storage */
+    persistAuth: boolean;
+    /** Enables / disables telemetry */
+    telemetry: boolean;
+    /** External service URLs used by Scalar packages */
+    externalUrls: ExternalUrls;
+};
+type ExtendedConfiguration = {
+    /** The layout to use for the references */
+    layout: 'modern' | 'classic';
+    /** @deprecated Use proxyUrl instead */
+    proxy?: string;
+    /**
+     * Custom fetch function for custom logic. Can be used to add custom headers, handle auth, etc.
+     *
+     * @deprecated Use `customFetch` instead.
+     */
+    fetch?: typeof fetch;
+    /**
+     * Custom fetch function used both when loading the OpenAPI document and when sending requests from the API client.
+     *
+     * Can be used to add custom headers, attach credentials (for example `credentials: 'include'`), handle auth, etc.
+     */
+    customFetch?: typeof fetch;
+    /** Plugins for the API reference */
+    plugins?: ApiReferencePlugin[];
+    /** Allows the user to inject an editor for the spec */
+    isEditable: boolean;
+    /** Controls whether the references show a loading state in the intro */
+    isLoading: boolean;
+    /** Whether to show models in the sidebar, search, and content. */
+    hideModels: boolean;
+    /** Sets the file type of the document to download, set to `none` to hide the download button */
+    documentDownloadType: 'both' | 'yaml' | 'json' | 'direct' | 'none';
+    /** @deprecated Use `documentDownloadType: 'none'` instead */
+    hideDownloadButton?: boolean;
+    /** Whether to show the "Test Request" button */
+    hideTestRequestButton: boolean;
+    /** Whether to show the sidebar search bar */
+    hideSearch: boolean;
+    /** Whether to show the operationId */
+    showOperationId: boolean;
+    /** Whether dark mode is on or off initially (light mode) */
+    darkMode?: boolean;
+    /** forceDarkModeState makes it always this state no matter what */
+    forceDarkModeState?: 'dark' | 'light';
+    /** Whether to show the dark mode toggle */
+    hideDarkModeToggle: boolean;
+    /** If used, passed data will be added to the HTML header. @see https://unhead.unjs.io/usage/composables/use-seo-meta */
+    metaData?: any;
+    /** Path to a favicon image */
+    favicon?: string;
+    /** List of httpsnippet clients to hide from the clients menu. By default hides Unirest, pass `[]` to show all clients */
+    hiddenClients?: Record<string, boolean | string[]> | string[] | true;
+    /** Determine the HTTP client that is selected by default */
+    defaultHttpClient?: {
+        targetKey: string;
+        clientKey: string;
+    };
+    /** Custom CSS to be added to the page */
+    customCss?: string;
+    /** onSpecUpdate is fired on spec/swagger content change */
+    onSpecUpdate?: (input: string) => void;
+    /** onServerChange is fired on selected server change */
+    onServerChange?: (input: string) => void;
+    /** onDocumentSelect is fired when the config is selected */
+    onDocumentSelect?: () => void | Promise<void>;
+    /** Callback fired when the reference is fully loaded */
+    onLoaded?: (slug: string) => void | Promise<void>;
+    /** Fired before the outbound request is built; callback receives a mutable request builder. Experimental API. */
+    onBeforeRequest?: ((input: {
+        request: Request;
+        requestBuilder: any;
+        envVariables: Record<string, string>;
+    }) => void | Promise<void>) | undefined;
+    /** onShowMore is fired when the user clicks the "Show more" button on the references */
+    onShowMore?: (tagId: string) => void | Promise<void>;
+    /** onSidebarClick is fired when the user clicks on a sidebar item */
+    onSidebarClick?: (href: string) => void | Promise<void>;
+    /** Route using paths instead of hashes, your server MUST support this. @experimental */
+    pathRouting?: {
+        basePath: string;
+    };
+    /** MCP (Model Context Protocol) configuration. When provided, enables MCP integration with the given name and url. */
+    mcp?: {
+        /** Display name for the MCP server */
+        name?: string;
+        /** URL of the MCP server */
+        url?: string;
+        /** When true, disables the MCP integration */
+        disabled?: boolean;
+    };
+    /** Customize the heading portion of the hash */
+    generateHeadingSlug?: (input: {
+        slug?: string;
+    }) => string;
+    /** Customize the model portion of the hash */
+    generateModelSlug?: (input: {
+        name?: string;
+    }) => string;
+    /** Customize the tag portion of the hash */
+    generateTagSlug?: (input: {
+        name?: string;
+    }) => string;
+    /** Customize the operation portion of the hash */
+    generateOperationSlug?: (input: {
+        path: string;
+        operationId?: string;
+        method: string;
+        summary?: string;
+    }) => string;
+    /** Customize the webhook portion of the hash */
+    generateWebhookSlug?: (input: {
+        name: string;
+        method?: string;
+    }) => string;
+    /** To handle redirects, pass a function that receives the current path/hash and passes that to history.replaceState */
+    redirect?: (input: string) => string | null | undefined;
+    /** Whether to include default fonts */
+    withDefaultFonts: boolean;
+    /** Whether to expand the first tag in the sidebar when no specific URL target is present */
+    defaultOpenFirstTag: boolean;
+    /** Whether to expand all tags by default. Warning: this can cause performance issues on big documents */
+    defaultOpenAllTags: boolean;
+    /** Whether to expand all models by default. Warning: this can cause performance issues on big documents */
+    expandAllModelSections: boolean;
+    /** Whether to expand all responses by default. Warning: this can cause performance issues on big documents */
+    expandAllResponses: boolean;
+    /** Function to sort tags */
+    tagsSorter?: 'alpha' | ((a: any, b: any) => number);
+    /** Function to sort operations */
+    operationsSorter?: 'alpha' | 'method' | ((a: any, b: any) => number);
+    /** Order the schema properties by */
+    orderSchemaPropertiesBy: 'alpha' | 'preserve';
+    /** Sort the schema properties by required ones first */
+    orderRequiredPropertiesFirst: boolean;
+};
+export type SourceConfiguration = {
+    default?: boolean;
+    /** URL to an OpenAPI/Swagger document */
+    url?: string;
+    /** Directly embed the OpenAPI document. Can be a string, object, function returning an object, or null. It is recommended to pass a URL instead of content. */
+    content?: string | null | Record<string, any> | (() => string | any);
+    /** The title of the OpenAPI document. @deprecated Please move `title` to the top level and remove the `spec` prefix. */
+    title?: string;
+    /** The slug of the OpenAPI document used in the URL. @deprecated Please move `slug` to the top level and remove the `spec` prefix. */
+    slug?: string;
+    /** @deprecated Use `url` and `content` on the top level instead. */
+    spec?: {
+        url?: string;
+        content?: string | null | Record<string, any> | (() => string | any);
+    };
+    /** Agent Scalar configuration */
+    agent?: {
+        key?: string;
+        disabled?: boolean;
+        /** When true, hide the control to add more APIs in the agent chat. Only preloaded/registry documents are shown; the public API list is not offered. */
+        hideAddApi?: boolean;
+    };
+};
+export type ApiReferenceConfigurationRaw = Omit<BaseConfiguration & ExtendedConfiguration, 'proxy' | 'spec' | 'authentication' | 'showToolbar'> & {
+    authentication?: AuthenticationConfiguration;
+};
+export type ApiReferenceConfiguration = ApiReferenceConfigurationRaw & {
+    /** @deprecated
+     * This type now refers to the base configuration that does not include the sources.
+     * Use the type `ApiReferenceConfigurationWithSource` instead.
+     */
+    url?: SourceConfiguration['url'];
+    /** @deprecated
+     * This type now refers to the base configuration that does not include the sources.
+     * Use the type `ApiReferenceConfigurationWithSource` instead.
+     */
+    content?: SourceConfiguration['content'];
+    /**
+     * Fired before the outbound request is built and sent. Mutate the **request builder** so the eventual fetch call
+     * reflects your changes (method, path, headers, body, and related fields).
+     *
+     * **Experimental:** The builder matches {@link https://github.com/scalar/scalar/blob/main/packages/workspace-store/src/request-example/builder/request-factory.ts RequestFactory}
+     * (`import type { RequestFactory } from '@scalar/workspace-store/request-example'`). That shape is still experimental and may change in minor releases.
+     *
+     * @param input - Hook argument from the integration layer.
+     * @param input.request - **Deprecated** when treated as a fetch API `Request`. Prefer thinking of this value as the
+     * mutable builder ({@link https://github.com/scalar/scalar/blob/main/packages/workspace-store/src/request-example/builder/request-factory.ts RequestFactory}).
+     * Some call sites only pass this property.
+     * @param input.requestBuilder - The same builder when exposed under this name; **prefer** mutating this when your integration provides it.
+     * @returns void or a promise that resolves when the hook finishes
+     * @example
+     * ```ts
+     * onBeforeRequest: ({ request: builder }) => {
+     *   builder.headers.set('Authorization', 'Bearer <token>')
+     * }
+     * ```
+     */
+    onBeforeRequest?: (input: {
+        request: Request;
+        requestBuilder: any;
+        envVariables: Record<string, string>;
+    }) => void | Promise<void> | undefined;
+};
+export type ApiReferenceConfigurationWithSource = Omit<ApiReferenceConfiguration, 'url' | 'content'> & SourceConfiguration;
+/**
+ * Configuration for a single config with multiple sources
+ * The configuration will be shared between the documents
+ */
+export type ApiReferenceConfigurationWithMultipleSources = ApiReferenceConfigurationWithSource & {
+    sources: SourceConfiguration[];
+};
+/** Configuration for multiple Api References */
+export type AnyApiReferenceConfiguration = Partial<ApiReferenceConfigurationWithSource> | Partial<ApiReferenceConfigurationWithMultipleSources> | Partial<ApiReferenceConfigurationWithSource>[] | Partial<ApiReferenceConfigurationWithMultipleSources>[];
+/** Typeguard to check to narrow the configs to the one with sources */
+export declare const isConfigurationWithSources: (config: AnyApiReferenceConfiguration) => config is Partial<ApiReferenceConfigurationWithMultipleSources>;
+export type ApiClientConfiguration = BaseConfiguration & SourceConfiguration;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/api-reference/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/api-reference/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAE5C,0DAA0D;AAC1D,KAAK,oBAAoB,GAAG;IAE1B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;CAChC,CAAA;AAGD,KAAK,sBAAsB,GAAG;IAC5B,GAAG,EAAE,GAAG,CAAA;IACR,0EAA0E;IAC1E,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,KAAK,sBAAsB,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAE3D,KAAK,iBAAiB,GAAG;IACvB,IAAI,EAAE,QAAQ,CAAA;IACd,8EAA8E;IAC9E,IAAI,EAAE,MAAM,CAAA;IACZ,6FAA6F;IAC7F,EAAE,EAAE,sBAAsB,CAAA;IAC1B,mFAAmF;IACnF,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG,sBAAsB,GAAG,iBAAiB,CAAA;AAGpG,KAAK,eAAe,GAAG;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ;qGACiG;IACjG,MAAM,EAAE,OAAO,GAAG,QAAQ,CAAA;IAC1B;;mEAE+D;IAC/D,YAAY,EAAE,KAAK,GAAG,MAAM,CAAA;IAC5B,2DAA2D;IAC3D,QAAQ,EAAE,MAAM,CAAA;IAChB,2DAA2D;IAC3D,QAAQ,EAAE,MAAM,CAAA;IAChB,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG,sBAAsB,GAAG,eAAe,CAAA;AAIhG,KAAK,wBAAwB,GAAG;IAC9B,IAAI,EAAE,eAAe,CAAA;IACrB;6EACyE;IACzE,gBAAgB,EAAE,MAAM,CAAA;CACzB,CAAA;AACD,MAAM,MAAM,2BAA2B,GAAG,oBAAoB,GAAG,sBAAsB,GAAG,wBAAwB,CAAA;AAIlH,KAAK,WAAW,GAAG;IACjB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACjC,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC3B,oEAAoE;IACpE,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B,qBAAqB;IACrB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,2HAA2H;IAC3H,yBAAyB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAClD,4FAA4F;IAC5F,wBAAwB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACjD,0FAA0F;IAC1F,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED,KAAK,WAAW,GAAG,SAAS,GAAG,OAAO,GAAG,IAAI,CAAA;AAE7C,KAAK,4BAA4B,GAAG,QAAQ,GAAG,MAAM,CAAA;AAErD,KAAK,6BAA6B,GAAG;IACnC,IAAI,EAAE,QAAQ,CAAA;IACd,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC7B,KAAK,EAAE;QACL,QAAQ,EAAE,WAAW,GAAG;YACtB,IAAI,EAAE,UAAU,CAAA;YAChB,gBAAgB,EAAE,MAAM,CAAA;YACxB,uBAAuB,CAAC,EAAE,MAAM,CAAA;SACjC,CAAA;QACD,QAAQ,EAAE,WAAW,GAAG;YACtB,IAAI,EAAE,UAAU,CAAA;YAChB,QAAQ,EAAE,MAAM,CAAA;YAChB,YAAY,EAAE,MAAM,CAAA;YACpB,QAAQ,EAAE,MAAM,CAAA;YAChB,QAAQ,EAAE,MAAM,CAAA;YAChB,+BAA+B,CAAC,EAAE,4BAA4B,CAAA;SAC/D,CAAA;QACD,iBAAiB,EAAE,WAAW,GAAG;YAC/B,IAAI,EAAE,mBAAmB,CAAA;YACzB,QAAQ,EAAE,MAAM,CAAA;YAChB,YAAY,EAAE,MAAM,CAAA;YACpB,+BAA+B,CAAC,EAAE,4BAA4B,CAAA;SAC/D,CAAA;QACD,iBAAiB,EAAE,WAAW,GAAG;YAC/B,IAAI,EAAE,mBAAmB,CAAA;YACzB,gBAAgB,EAAE,MAAM,CAAA;YACxB,QAAQ,EAAE,MAAM,CAAA;YAChB,YAAY,EAAE,MAAM,CAAA;YACpB,+BAA+B,CAAC,EAAE,4BAA4B,CAAA;YAC9D,WAAW,CAAC,EAAE,WAAW,CAAA;YACzB,uBAAuB,CAAC,EAAE,MAAM,CAAA;SACjC,CAAA;KACF,CAAA;CACF,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG,sBAAsB,GAAG,6BAA6B,CAAA;AAGhH,MAAM,MAAM,cAAc,GACtB,oBAAoB,GACpB,kBAAkB,GAClB,2BAA2B,GAC3B,oBAAoB,CAAA;AAExB;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;;;;;OAMG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE,GAAG,IAAI,CAAA;IAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC,CAAA;IAC7D;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAA;KAAE,KAAK,IAAI,CAAA;IACrE,cAAc,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAA;KAAE,KAAK,IAAI,CAAA;IAC7E,SAAS,CAAC,EAAE,MAAM,IAAI,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,MAAM;IACrC,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,sBAAsB,EAAE,CAAA;IACpC,KAAK,CAAC,EAAE;QACN,aAAa,CAAC,EAAE,aAAa,EAAE,CAAA;KAChC,CAAA;IACD,KAAK,CAAC,EAAE,cAAc,CAAA;IACtB,gBAAgB,CAAC,EAAE,GAAG,EAAE,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,oJAAoJ;IACpJ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,6BAA6B;IAC7B,cAAc,CAAC,EAAE,GAAG,CAAA;IACpB,kCAAkC;IAClC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,wCAAwC;IACxC,gBAAgB,EAAE,OAAO,CAAA;IACzB,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,mFAAmF;IACnF,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,mFAAmF;IACnF,YAAY,CAAC,EACT,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,CAAA;IACP,qCAAqC;IACrC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAA;IACf,kCAAkC;IAClC,WAAW,EAAE,OAAO,CAAA;IACpB,oDAAoD;IACpD,kBAAkB,EAAE,WAAW,GAAG,QAAQ,GAAG,OAAO,CAAA;IACpD,iDAAiD;IACjD,WAAW,EAAE,WAAW,GAAG,QAAQ,GAAG,OAAO,CAAA;IAC7C,4FAA4F;IAC5F,oBAAoB,EAAE,SAAS,GAAG,MAAM,CAAA;IACxC,+CAA+C;IAC/C,KAAK,EACD,SAAS,GACT,WAAW,GACX,MAAM,GACN,QAAQ,GACR,WAAW,GACX,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,QAAQ,GACR,UAAU,GACV,SAAS,GACT,MAAM,GACN,WAAW,GACX,MAAM,CAAA;IACV,kCAAkC;IAClC,YAAY,CAAC,EACT,UAAU,GACV,OAAO,GACP,YAAY,GACZ,QAAQ,GACR,UAAU,GACV,SAAS,GACT,SAAS,GACT,SAAS,GACT,IAAI,GACJ,MAAM,GACN,MAAM,GACN,SAAS,GACT,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,MAAM,GACN,cAAc,GACd,OAAO,GACP,MAAM,GACN,QAAQ,GACR,KAAK,GACL,IAAI,CAAA;IACR,oDAAoD;IACpD,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IACvC,+CAA+C;IAC/C,WAAW,EAAE,OAAO,CAAA;IACpB,mCAAmC;IACnC,SAAS,EAAE,OAAO,CAAA;IAClB,oDAAoD;IACpD,YAAY,EAAE,YAAY,CAAA;CAC3B,CAAA;AAED,KAAK,qBAAqB,GAAG;IAC3B,2CAA2C;IAC3C,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC5B,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;IACpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,KAAK,CAAA;IAC1B,oCAAoC;IACpC,OAAO,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAC9B,uDAAuD;IACvD,UAAU,EAAE,OAAO,CAAA;IACnB,wEAAwE;IACxE,SAAS,EAAE,OAAO,CAAA;IAClB,kEAAkE;IAClE,UAAU,EAAE,OAAO,CAAA;IACnB,gGAAgG;IAChG,oBAAoB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAA;IAClE,6DAA6D;IAC7D,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,gDAAgD;IAChD,qBAAqB,EAAE,OAAO,CAAA;IAC9B,6CAA6C;IAC7C,UAAU,EAAE,OAAO,CAAA;IACnB,sCAAsC;IACtC,eAAe,EAAE,OAAO,CAAA;IACxB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,mEAAmE;IACnE,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACrC,2CAA2C;IAC3C,kBAAkB,EAAE,OAAO,CAAA;IAC3B,wHAAwH;IACxH,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,8BAA8B;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,yHAAyH;IACzH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;IACpE,4DAA4D;IAC5D,iBAAiB,CAAC,EAAE;QAClB,SAAS,EAAE,MAAM,CAAA;QACjB,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;IACD,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,2DAA2D;IAC3D,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IACtC,wDAAwD;IACxD,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IACxC,4DAA4D;IAC5D,gBAAgB,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC7C,wDAAwD;IACxD,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACjD,iHAAiH;IACjH,eAAe,CAAC,EACZ,CAAC,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,cAAc,EAAE,GAAG,CAAC;QAAC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,GAClH,SAAS,CAAA;IACb,wFAAwF;IACxF,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACpD,qEAAqE;IACrE,cAAc,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACvD,wFAAwF;IACxF,WAAW,CAAC,EAAE;QACZ,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,sHAAsH;IACtH,GAAG,CAAC,EAAE;QACJ,sCAAsC;QACtC,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,4BAA4B;QAC5B,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,8CAA8C;QAC9C,QAAQ,CAAC,EAAE,OAAO,CAAA;KACnB,CAAA;IACD,gDAAgD;IAChD,mBAAmB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAA;IAC1D,8CAA8C;IAC9C,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAA;IACxD,4CAA4C;IAC5C,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAA;IACtD,kDAAkD;IAClD,qBAAqB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAA;IACnH,gDAAgD;IAChD,mBAAmB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAA;IAC1E,uHAAuH;IACvH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IACvD,uCAAuC;IACvC,gBAAgB,EAAE,OAAO,CAAA;IACzB,4FAA4F;IAC5F,mBAAmB,EAAE,OAAO,CAAA;IAC5B,yGAAyG;IACzG,kBAAkB,EAAE,OAAO,CAAA;IAC3B,2GAA2G;IAC3G,sBAAsB,EAAE,OAAO,CAAA;IAC/B,8GAA8G;IAC9G,kBAAkB,EAAE,OAAO,CAAA;IAC3B,4BAA4B;IAC5B,UAAU,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,KAAK,MAAM,CAAC,CAAA;IACnD,kCAAkC;IAClC,gBAAgB,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,KAAK,MAAM,CAAC,CAAA;IACpE,qCAAqC;IACrC,uBAAuB,EAAE,OAAO,GAAG,UAAU,CAAA;IAC7C,wDAAwD;IACxD,4BAA4B,EAAE,OAAO,CAAA;CACtC,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,yCAAyC;IACzC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,+JAA+J;IAC/J,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,MAAM,GAAG,GAAG,CAAC,CAAA;IACpE,wHAAwH;IACxH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,sIAAsI;IACtI,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,oEAAoE;IACpE,IAAI,CAAC,EAAE;QACL,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,MAAM,GAAG,GAAG,CAAC,CAAA;KACrE,CAAA;IACD,iCAAiC;IACjC,KAAK,CAAC,EAAE;QACN,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,uJAAuJ;QACvJ,UAAU,CAAC,EAAE,OAAO,CAAA;KACrB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAC7C,iBAAiB,GAAG,qBAAqB,EACzC,OAAO,GAAG,MAAM,GAAG,gBAAgB,GAAG,aAAa,CACpD,GAAG;IACF,cAAc,CAAC,EAAE,2BAA2B,CAAA;CAC7C,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG,4BAA4B,GAAG;IACrE;;;OAGG;IACH,GAAG,CAAC,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAA;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAA;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE;QACxB,OAAO,EAAE,OAAO,CAAA;QAChB,cAAc,EAAE,GAAG,CAAA;QACnB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACrC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,mCAAmC,GAAG,IAAI,CAAC,yBAAyB,EAAE,KAAK,GAAG,SAAS,CAAC,GAClG,mBAAmB,CAAA;AAErB;;;GAGG;AACH,MAAM,MAAM,4CAA4C,GAAG,mCAAmC,GAAG;IAC/F,OAAO,EAAE,mBAAmB,EAAE,CAAA;CAC/B,CAAA;AAED,gDAAgD;AAChD,MAAM,MAAM,4BAA4B,GACpC,OAAO,CAAC,mCAAmC,CAAC,GAC5C,OAAO,CAAC,4CAA4C,CAAC,GACrD,OAAO,CAAC,mCAAmC,CAAC,EAAE,GAC9C,OAAO,CAAC,4CAA4C,CAAC,EAAE,CAAA;AAE3D,uEAAuE;AACvE,eAAO,MAAM,0BAA0B,GACrC,QAAQ,4BAA4B,KACnC,MAAM,IAAI,OAAO,CAAC,4CAA4C,CACkC,CAAA;AAEnG,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,GAAG,mBAAmB,CAAA"}

package/dist/api-reference/types.js

@@ -0,0 +1,2 @@
+/** Typeguard to check to narrow the configs to the one with sources */
+export const isConfigurationWithSources = (config) => Boolean(!Array.isArray(config) && config && 'sources' in config && Array.isArray(config.sources));

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

@@ -0,0 +1,2 @@
+export type { AsyncApiDocument, AsyncApiInfoObject, AsyncApiLicenseObject } from './index.generated.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/asyncapi/3.1/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA"}