import * as vue from 'vue'; import { App } from 'vue'; interface CredentialPopupResponse { clientId: string; /** JWT credential string */ credential: string; /** This field shows how the credential is selected */ select_by: "auto" | "user" | "user_1tap" | "user_2tap" | "btn" | "btn_confirm" | "brn_add_session" | "btn_confirm_add_session"; } interface TokenPopupResponse { /** The access token of a successful token response. */ access_token: string; authuser: string; /** The lifetime in seconds of the access token. */ expires_in: string; /** Type of prompt presented to the user */ prompt: string; /** A space-delimited list of scopes that are approved by the user. */ scope: string; /** The type of the token issued. */ token_type: string; } interface CodePopupResponse { authuser: string; /** The authorization code of a successful token response */ code: string; /** Type of prompt presented to the user */ prompt: string; /** A space-delimited list of scopes that are approved by the user */ scope: string; } interface ErrorPopupResponse { message: string; /** The error stack trace. */ stack: string; /** The error type, giving the detailed reason for the error. */ type: string; } /** * Callback triggered with JWT credential response on google login prompts success. */ declare type CredentialCallback = (response: CredentialPopupResponse) => void; /** * Callback triggered with auth code response on google login popup success. */ declare type CodeResponseCallback = (response: CodePopupResponse) => void; /** * Callback triggered with access token response on google login popup success. */ declare type TokenResponseCallback = (response: TokenPopupResponse) => void; type callbackTypes_d_CredentialPopupResponse = CredentialPopupResponse; type callbackTypes_d_TokenPopupResponse = TokenPopupResponse; type callbackTypes_d_CodePopupResponse = CodePopupResponse; type callbackTypes_d_ErrorPopupResponse = ErrorPopupResponse; type callbackTypes_d_CredentialCallback = CredentialCallback; type callbackTypes_d_CodeResponseCallback = CodeResponseCallback; type callbackTypes_d_TokenResponseCallback = TokenResponseCallback; declare namespace callbackTypes_d { export { callbackTypes_d_CredentialPopupResponse as CredentialPopupResponse, callbackTypes_d_TokenPopupResponse as TokenPopupResponse, callbackTypes_d_CodePopupResponse as CodePopupResponse, callbackTypes_d_ErrorPopupResponse as ErrorPopupResponse, callbackTypes_d_CredentialCallback as CredentialCallback, callbackTypes_d_CodeResponseCallback as CodeResponseCallback, callbackTypes_d_TokenResponseCallback as TokenResponseCallback, }; } declare type PopupTypeCode = "CODE"; declare type PopupTypeToken = "TOKEN"; declare type PopupTypes = PopupTypeCode | PopupTypeToken; /** Actions to be performed after library is loaded */ declare type ActionOnLibraryLoad = (google: Google) => void; /** * A wrapper function which makes sure google Client Library is loaded and then give an access to the SDK api * @param action A function to execute some actions only after google Client Library is loaded */ declare type GoogleSdkLoaded = (action: ActionOnLibraryLoad) => void; interface ButtonConfig { /** The button [type](https://developers.google.com/identity/gsi/web/reference/js-reference#type): icon, or standard button */ type?: "standard" | "icon"; /** The button [theme](https://developers.google.com/identity/gsi/web/reference/js-reference#theme). For example, filled_blue or filled_black */ theme?: "outline" | "filled_blue" | "filled_black"; /** The button [size](https://developers.google.com/identity/gsi/web/reference/js-reference#size). For example, small or large */ size?: "large" | "medium" | "small"; /** The button [text](https://developers.google.com/identity/gsi/web/reference/js-reference#text). For example, "Sign in with Google" or "Sign up with Google" */ text?: "signin_with" | "signup_with" | "continue_with" | "signin"; /** The button [shape](https://developers.google.com/identity/gsi/web/reference/js-reference#shape). For example, rectangular or circular */ shape?: "rectangular" | "pill" | "circle" | "square"; /** The Google [logo alignment](https://developers.google.com/identity/gsi/web/reference/js-reference#logo_alignment): left or center */ logo_alignment?: "left" | "center"; /** The button [width](https://developers.google.com/identity/gsi/web/reference/js-reference#width), in pixels */ width?: string; /** If set, then the button [language](https://developers.google.com/identity/gsi/web/reference/js-reference#locale) is rendered */ locale?: string; } /** * Your Google API client ID */ declare type ClientId = string | null; declare type Context = "signin" | "signup" | "use"; interface IdConfiguration { /**Your Google API client ID */ client_id?: ClientId; /** Enables automatic selection on Google One Tap */ auto_select?: boolean; /** ID token callback handler */ callback?: Function; /** The Sign In With Google button UX flow */ ux_mode?: "popup" | "redirect"; /** The URL of your login endpoint */ login_uri?: string; /** The URL of your password credential handler endpoint */ native_login_uri?: string; /** The JavaScript password credential handler function name */ native_callback?: (response: { id: string; password: string; }) => void; /** Controls whether to cancel the prompt if the user clicks outside of the prompt */ cancel_on_tap_outside?: boolean; /** The DOM ID of the One Tap prompt container element */ prompt_parent_id?: string; /** A random string for ID tokens */ nonce?: string; /** The title and words in the One Tap prompt */ context?: Context; /** If you need to call One Tap in the parent domain and its subdomains, pass the parent domain to this attribute so that a single shared cookie is used. */ state_cookie_domain?: string; /** The origins that are allowed to embed the intermediate iframe. One Tap will run in the intermediate iframe mode if this attribute presents */ allowed_parent_origin?: string | string[]; /** Allow the browser to control user sign-in prompts and mediate the sign-in flow between your website and Google. Defaults to false. */ use_fedcm_for_prompt?: boolean; /** Overrides the default intermediate iframe behavior when users manually close One Tap */ intermediate_iframe_close_callback?: () => void; /** Enables upgraded One Tap UX on ITP browsers */ itp_support?: boolean; /** * If your application knows the Workspace domain the user belongs to, * use this to provide a hint to Google. For more information, * see the [hd](https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters) * field in the OpenID Connect docs. */ hosted_domain?: string; } interface InstallOptions { clientId?: ClientId; prompt?: boolean; autoLogin?: boolean; popupType?: PopupTypes; idConfiguration?: IdConfiguration | null; buttonConfig?: ButtonConfig; callback?: Function; error?: Function | null; } interface PopupOptions { /** * Your Google API client ID */ clientId?: ClientId; } /** * A helper function to trigger login popup using google.accounts.oauth2.initCodeClient function under the hoods * @param options Optionally you can add clientId in this option if not initialized on plugin install * @returns A promise which get resolved with an auth code once user login through the popup */ interface GoogleAuthCodeLogin { (options?: PopupOptions): Promise; } /** * A helper function to trigger login popup using google.accounts.oauth2.initTokenClient function under the hoods * @param options Optionally you can add clientId in this option if not initialized on plugin install * @returns A promise which get resolved with an access token once user login through the popup */ interface GoogleTokenLogin { (options?: PopupOptions): Promise; } interface OneTapOptions { /**Your Google API client ID */ clientId?: ClientId; /** The title and words in the One Tap prompt */ context?: Context; /** Set this to true if you want the one-tap promt to automatically login */ autoLogin?: boolean; /** Controls whether to cancel the prompt if the user clicks outside of the prompt */ cancelOnTapOutside?: boolean; /** Callback function to triggered on successfull login */ callback?: CredentialCallback; /** Callback function to triggered when prompt fails to show */ error?: Function | null; } /** * A function to open one-tap and automatic log-in prompt * @param options Options to customise the behavior of one-tap and automatic log-in prompt * @returns A promise which get resolved once user login through the prompt */ declare type GoogleOneTap = (options?: OneTapOptions) => Promise; /** * This will make user to login and select account again by disabling auto select */ declare type Logout = () => void; interface TokenClientConfig { /** * The client ID for your application. You can find this value in the * [API Console](https://console.cloud.google.com/apis/dashboard) */ client_id: ClientId; /** * A space-delimited list of scopes that identify the resources * that your application could access on the user's behalf. * These values inform the consent screen that Google displays to the user */ scope: string; /** * Required for popup UX. The JavaScript function name that handles returned code response * The property will be ignored by the redirect UX */ callback?: (response: TokenPopupResponse) => void; /** * Optional, defaults to 'select_account'. A space-delimited, case-sensitive list of prompts to present the user */ prompt?: "" | "none" | "consent" | "select_account"; /** * Optional, defaults to true. If set to false, * [more granular Google Account permissions](https://developers.googleblog.com/2018/10/more-granular-google-account.html) * will be disabled for clients created before 2019. No effect for newer clients, * since more granular permissions is always enabled for them. */ enable_serial_consent?: boolean; /** * Optional. If your application knows which user should authorize the request, * it can use this property to provide a hint to Google. * The email address for the target user. For more information, * see the [login_hint](https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters) field in the OpenID Connect docs. */ hint?: string; /** * Optional. If your application knows the Workspace domain the user belongs to, * use this to provide a hint to Google. For more information, * see the [hd](https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters) * field in the OpenID Connect docs. */ hosted_domain?: string; /** * Optional. Not recommended. Specifies any string value that * your application uses to maintain state between your authorization * request and the authorization server's response. */ state?: string; /** * Optional. The JavaScript function that handles some non-OAuth errors, such as the popup window is failed to open; or closed before an OAuth response is returned. * * The `type` field of the input parameter gives the detailed reason. * * * popup_failed_to_open The popup window is failed to open. * * popup_closed The popup window is closed before an OAuth response is returned. * * unknown Placeholder for other errors. */ error_callback?: (errorResponse: ErrorPopupResponse) => void; } interface OverridableTokenClientConfig { /** * Optional. A space-delimited, case-sensitive list of prompts to present the user. */ prompt?: string; /** * Optional. If set to false, * [more granular Google Account permissions](https://developers.googleblog.com/2018/10/more-granular-google-account.html) * will be disabled for clients created before 2019. * No effect for newer clients, since more granular permissions is always enabled for them. */ enable_serial_consent?: boolean; /** * Optional. If your application knows which user should authorize the request, * it can use this property to provide a hint to Google. * The email address for the target user. For more information, * see the [login_hint](https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters) field in the OpenID Connect docs. */ hint?: string; /** * Optional. Not recommended. Specifies any string value that your * application uses to maintain state between your authorization request * and the authorization server's response. */ state?: string; } interface CodeClientConfig { /** * Required. The client ID for your application. You can find this value in the * [API Console](https://console.developers.google.com/) */ client_id: ClientId; /** * Required. A space-delimited list of scopes that identify * the resources that your application could access on the user's behalf. * These values inform the consent screen that Google displays to the user */ scope: string; /** * Required for redirect UX. Determines where the API server redirects * the user after the user completes the authorization flow. * The value must exactly match one of the authorized redirect URIs for the OAuth 2.0 client, * which you configured in the API Console and must conform to our * [Redirect URI validation](https://developers.google.com/identity/protocols/oauth2/web-server#uri-validation) rules. The property will be ignored by the popup UX */ redirect_uri?: string; /** * Required for popup UX. The JavaScript function name that handles * returned code response. The property will be ignored by the redirect UX */ callback?: (codeResponse: CodePopupResponse) => void; /** * Optional. Recommended for redirect UX. Specifies any string value that * your application uses to maintain state between your authorization request and the authorization server's response */ state?: string; /** * Optional, defaults to true. If set to false, * [more granular Google Account permissions](https://developers.googleblog.com/2018/10/more-granular-google-account.html) * will be disabled for clients created before 2019. No effect for newer clients, since * more granular permissions is always enabled for them */ enable_serial_consent?: boolean; /** * Optional. If your application knows which user should authorize the request, * it can use this property to provide a hint to Google. * The email address for the target user. For more information, * see the [login_hint](https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters) field in the OpenID Connect docs */ hint?: string; /** * Optional. If your application knows the Workspace domain * the user belongs to, use this to provide a hint to Google. * For more information, see the [hd](https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters) field in the OpenID Connect docs */ hosted_domain?: string; /** * Optional. The UX mode to use for the authorization flow. * By default, it will open the consent flow in a popup. Valid values are popup and redirect */ ux_mode?: "popup" | "redirect"; /** * Optional, defaults to 'false'. Boolean value to prompt the user to select an account */ select_account?: boolean; /** * Optional. The JavaScript function that handles some non-OAuth errors, such as the popup window is failed to open; or closed before an OAuth response is returned. * * The `type` field of the input parameter gives the detailed reason. * * * popup_failed_to_open The popup window is failed to open. * * popup_closed The popup window is closed before an OAuth response is returned. * * unknown Placeholder for other errors. */ error_callback?: (errorResponse: ErrorPopupResponse) => void; } /** This variable holds an access to google client SDK */ interface Google { accounts: { id: { initialize: (input: IdConfiguration) => void; prompt: Function; renderButton: (parent: HTMLElement, options: ButtonConfig, clickHandler?: () => void) => void; disableAutoSelect: () => void; storeCredential: (credential: { id: string; password: string; }, callback?: () => void) => void; cancel: () => void; onGoogleLibraryLoad: Function; revoke: (accessToken: string, done: () => void) => void; }; oauth2: { initTokenClient: (config: TokenClientConfig) => { requestAccessToken: (overridableClientConfig?: OverridableTokenClientConfig) => void; }; initCodeClient: (config: CodeClientConfig) => { requestCode: () => void; }; hasGrantedAnyScope: (tokenRsponse: TokenPopupResponse, firstScope: string, ...restScopes: string[]) => boolean; hasGrantedAllScopes: (tokenRsponse: TokenPopupResponse, firstScope: string, ...restScopes: string[]) => boolean; revoke: (accessToken: string, done?: () => void) => void; }; }; } interface _Window { google: Google; } declare type DecodeCredential = (token: string) => object; declare global { interface Window extends _Window { } } /** * For retriving the JWT payload from the credential * @param token JWT credential string * @returns Decoded payload from the JWT credential string */ declare const decodeCredential: DecodeCredential; /** * A wrapper function which makes sure google Client Library is loaded and then give an access to the SDK api * @param action A function to execute some actions only after google Client Library is loaded */ declare const googleSdkLoaded: GoogleSdkLoaded; /** * A helper function to trigger login popup using google.accounts.oauth2.initCodeClient function under the hoods * @param options Optionally you can add clientId in this option if not initialized on plugin install * @returns A promise which get resolved with an auth code once user login through the popup */ declare const googleAuthCodeLogin: GoogleAuthCodeLogin; /** * A helper function to trigger login popup using google.accounts.oauth2.initTokenClient function under the hoods * @param options Optionally you can add clientId in this option if not initialized on plugin install * @returns A promise which get resolved with an access token once user login through the popup */ declare const googleTokenLogin: GoogleTokenLogin; /** * A function to open one-tap and automatic log-in prompt * @param options Options to customise the behavior of one-tap and automatic log-in prompt * @returns A promise which get resolved once user login through the prompt */ declare const googleOneTap: GoogleOneTap; /** * This will make user to login and select account again by disabling auto select */ declare const googleLogout: Logout; declare const _default$1: vue.DefineComponent<{ clientId: { type: StringConstructor; required: false; }; prompt: { type: BooleanConstructor; required: false; default: boolean; }; autoLogin: { type: BooleanConstructor; required: false; default: boolean; }; popupType: { type: StringConstructor; required: false; }; idConfiguration: { type: ObjectConstructor; required: false; }; buttonConfig: { type: ObjectConstructor; required: false; }; callback: { type: FunctionConstructor; required: false; }; error: { type: FunctionConstructor; required: false; }; }, (_ctx: any, _cache: any) => vue.VNode, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, Record, string, vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps, Readonly>, { prompt: boolean; autoLogin: boolean; }>; //# sourceMappingURL=GoogleLogin.vue?vue&type=script&setup=true&lang.d.ts.map declare const _default: { install: (app: App, options: InstallOptions) => void; }; //# sourceMappingURL=index.d.ts.map export { callbackTypes_d as CallbackTypes, _default$1 as GoogleLogin, decodeCredential, _default as default, googleAuthCodeLogin, googleLogout, googleOneTap, googleSdkLoaded, googleTokenLogin };