@scalar/api-client
Version:
the open source API testing client
221 lines • 9.21 kB
TypeScript
import type { Environment } from '@scalar/oas-utils/entities/environment';
import type { SelectedSecuritySchemeUids } from '@scalar/oas-utils/entities/shared';
import type { Collection, Operation, Server } from '@scalar/oas-utils/entities/spec';
import type { Workspace } from '@scalar/oas-utils/entities/workspace';
import type { EnvVariable } from '../../../../store/active-entities.js';
type __VLS_Props = {
collection: Collection;
/** Controls whether user can add new auth schemes */
isReadOnly?: boolean;
environment: Environment;
envVariables: EnvVariable[];
layout: 'client' | 'reference';
operation?: Operation | undefined;
persistAuth?: boolean;
selectedSecuritySchemeUids: SelectedSecuritySchemeUids;
server: Server | undefined;
title: string;
workspace: Workspace;
};
type __VLS_Slots = {
'oauth-actions'?: () => unknown;
};
declare const __VLS_component: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
authorized: () => any;
activeSchemes: (schemes: ({
type: "apiKey";
name: string;
in: "cookie" | "query" | "header";
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
value: string;
description?: string | undefined;
} | {
type: "http";
scheme: "basic" | "bearer";
bearerFormat: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
username: string;
password: string;
token: string;
description?: string | undefined;
} | {
type: "openIdConnect";
openIdConnectUrl: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
} | {
type: "oauth2";
flows: {
implicit?: {
refreshUrl: string;
scopes: Record<string, string>;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "implicit";
authorizationUrl: string;
"x-scalar-redirect-uri": string;
"x-scalar-security-query"?: Record<string, string> | undefined;
"x-scalar-security-body"?: Record<string, string> | undefined;
"x-tokenName"?: string | undefined;
} | undefined;
password?: {
refreshUrl: string;
scopes: Record<string, string>;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "password";
tokenUrl: string;
clientSecret: string;
username: string;
password: string;
"x-scalar-security-query"?: Record<string, string> | undefined;
"x-scalar-security-body"?: Record<string, string> | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
clientCredentials?: {
refreshUrl: string;
scopes: Record<string, string>;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "clientCredentials";
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record<string, string> | undefined;
"x-scalar-security-body"?: Record<string, string> | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
authorizationCode?: {
refreshUrl: string;
scopes: Record<string, string>;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "authorizationCode";
authorizationUrl: string;
"x-usePkce": "SHA-256" | "plain" | "no";
"x-scalar-redirect-uri": string;
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record<string, string> | undefined;
"x-scalar-security-body"?: Record<string, string> | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
};
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
'x-default-scopes'?: string[] | undefined;
})[]) => any;
}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
onAuthorized?: (() => any) | undefined;
onActiveSchemes?: ((schemes: ({
type: "apiKey";
name: string;
in: "cookie" | "query" | "header";
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
value: string;
description?: string | undefined;
} | {
type: "http";
scheme: "basic" | "bearer";
bearerFormat: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
username: string;
password: string;
token: string;
description?: string | undefined;
} | {
type: "openIdConnect";
openIdConnectUrl: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
} | {
type: "oauth2";
flows: {
implicit?: {
refreshUrl: string;
scopes: Record<string, string>;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "implicit";
authorizationUrl: string;
"x-scalar-redirect-uri": string;
"x-scalar-security-query"?: Record<string, string> | undefined;
"x-scalar-security-body"?: Record<string, string> | undefined;
"x-tokenName"?: string | undefined;
} | undefined;
password?: {
refreshUrl: string;
scopes: Record<string, string>;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "password";
tokenUrl: string;
clientSecret: string;
username: string;
password: string;
"x-scalar-security-query"?: Record<string, string> | undefined;
"x-scalar-security-body"?: Record<string, string> | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
clientCredentials?: {
refreshUrl: string;
scopes: Record<string, string>;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "clientCredentials";
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record<string, string> | undefined;
"x-scalar-security-body"?: Record<string, string> | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
authorizationCode?: {
refreshUrl: string;
scopes: Record<string, string>;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "authorizationCode";
authorizationUrl: string;
"x-usePkce": "SHA-256" | "plain" | "no";
"x-scalar-redirect-uri": string;
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record<string, string> | undefined;
"x-scalar-security-body"?: Record<string, string> | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
};
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
'x-default-scopes'?: string[] | undefined;
})[]) => any) | undefined;
}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
export default _default;
type __VLS_WithSlots<T, S> = T & {
new (): {
$slots: S;
};
};
//# sourceMappingURL=RequestAuth.vue.d.ts.map