import type { TokenClientConfig, TokenResponse, OverridableTokenClientConfig } from '../interfaces/oauth2'; import { type Ref } from "vue"; import type { MaybeRef } from '../utils/types'; /** * Success response */ export type AuthCodeFlowSuccessResponse = Omit; /** * Error response */ export type AuthCodeFlowErrorResponse = Pick; /** * Auth Code Flow Options * * @export * @interface AuthCodeFlowOptions * @extends {(Omit)} */ export interface AuthCodeFlowOptions extends Omit { /** * On success callback * * @memberof AuthCodeFlowOptions */ onSuccess?: (response: AuthCodeFlowSuccessResponse) => void; /** * On error callback * * @memberof AuthCodeFlowOptions */ onError?: (errorResponse: AuthCodeFlowErrorResponse) => void; /** * Authorization scopes * * @type {(MaybeRef | MaybeRef)} * @see https://developers.google.com/identity/protocols/oauth2/scopes * @memberof ImplicitFlowOptions */ scope?: MaybeRef | MaybeRef; } /** * Token Client Result * * @export * @interface UseTokenClientReturn */ export interface UseTokenClientReturn { /** * Is script ready to be used? * * @type {Readonly>} * @memberof UseTokenClientReturn */ isReady: Readonly>; /** * Invoke login flow. You can provide a `OverridableTokenClientConfig` to override the login flow options. * * @memberof UseTokenClientReturn */ login: (overrideConfig?: OverridableTokenClientConfig) => void | undefined; } /** * Initiate login with authcode flow using token client. Return values of the composable can be used * to trigger the login flow and determine the readiness of the client. * It also provides callbacks such as `onSuccess` and `onError` that can be used to obtain the results from the login client. * * @export * @param {AuthCodeFlowOptions} [options={}] * @see https://developers.google.com/identity/oauth2/web/guides/use-token-model * @return {*} {UseTokenClientReturn} */ export default function useTokenClient(options?: AuthCodeFlowOptions): UseTokenClientReturn;