@types/gapi.auth2
Advanced tools
Comparing version 0.0.57 to 0.0.58
@@ -10,384 +10,391 @@ // Type definitions for non-npm package Google Sign-In API 0.0 | ||
| declare namespace gapi.auth2 { | ||
| /** | ||
| * GoogleAuth is a singleton class that provides methods to allow the user to sign in with a Google account, | ||
| * get the user's current sign-in status, get specific data from the user's Google profile, | ||
| * request additional scopes, and sign out from the current account. | ||
| */ | ||
| class GoogleAuth extends GoogleAuthBase { | ||
| /** | ||
| * Calls the onInit function when the GoogleAuth object is fully initialized, or calls the onFailure function if | ||
| * initialization fails. | ||
| * GoogleAuth is a singleton class that provides methods to allow the user to sign in with a Google account, | ||
| * get the user's current sign-in status, get specific data from the user's Google profile, | ||
| * request additional scopes, and sign out from the current account. | ||
| */ | ||
| then(onInit: (googleAuth: GoogleAuthBase) => any, onFailure?: (reason: {error: string, details: string}) => any): any; | ||
| } | ||
| class GoogleAuth extends GoogleAuthBase { | ||
| /** | ||
| * Calls the onInit function when the GoogleAuth object is fully initialized, or calls the onFailure function if | ||
| * initialization fails. | ||
| */ | ||
| then( | ||
| onInit: (googleAuth: GoogleAuthBase) => any, | ||
| onFailure?: (reason: { error: string; details: string }) => any, | ||
| ): any; | ||
| } | ||
| class GoogleAuthBase { | ||
| isSignedIn: IsSignedIn; | ||
| class GoogleAuthBase { | ||
| isSignedIn: IsSignedIn; | ||
| currentUser: CurrentUser; | ||
| currentUser: CurrentUser; | ||
| /** | ||
| * Signs in the user using the specified options. | ||
| * If no option specified here, fallback to the options specified to gapi.auth2.init(). | ||
| */ | ||
| signIn(options?: SigninOptions | SigninOptionsBuilder): Promise<GoogleUser>; | ||
| /** | ||
| * Signs in the user using the specified options. | ||
| * If no option specified here, fallback to the options specified to gapi.auth2.init(). | ||
| */ | ||
| signIn(options?: SigninOptions | SigninOptionsBuilder): Promise<GoogleUser>; | ||
| /** | ||
| * Signs out all accounts from the application. | ||
| */ | ||
| signOut(): any; | ||
| /** | ||
| * Signs out all accounts from the application. | ||
| */ | ||
| signOut(): any; | ||
| /** | ||
| * Revokes all of the scopes that the user granted. | ||
| */ | ||
| disconnect(): any; | ||
| /** | ||
| * Revokes all of the scopes that the user granted. | ||
| */ | ||
| disconnect(): any; | ||
| /** | ||
| * Get permission from the user to access the specified scopes offline. | ||
| */ | ||
| grantOfflineAccess(options?: OfflineAccessOptions): Promise<{code: string}>; | ||
| /** | ||
| * Get permission from the user to access the specified scopes offline. | ||
| */ | ||
| grantOfflineAccess(options?: OfflineAccessOptions): Promise<{ code: string }>; | ||
| /** | ||
| * Attaches the sign-in flow to the specified container's click handler. | ||
| */ | ||
| attachClickHandler(container: any, options: SigninOptions, | ||
| onsuccess: (googleUser: GoogleUser) => any, onfailure: (reason: string) => any): any; | ||
| } | ||
| /** | ||
| * Attaches the sign-in flow to the specified container's click handler. | ||
| */ | ||
| attachClickHandler( | ||
| container: any, | ||
| options: SigninOptions, | ||
| onsuccess: (googleUser: GoogleUser) => any, | ||
| onfailure: (reason: string) => any, | ||
| ): any; | ||
| } | ||
| interface Listener { | ||
| /** | ||
| * Returns true if the listener is currently listening for changes. | ||
| * Returns false after remove() is called. | ||
| */ | ||
| isActive: boolean; | ||
| interface Listener { | ||
| /** | ||
| * Returns true if the listener is currently listening for changes. | ||
| * Returns false after remove() is called. | ||
| */ | ||
| isActive: boolean; | ||
| /** | ||
| * Stops listening for changes. | ||
| */ | ||
| remove(): void; | ||
| /** | ||
| * Stops listening for changes. | ||
| */ | ||
| remove(): void; | ||
| /** | ||
| * Triggers the callback function. | ||
| */ | ||
| trigger(): void; | ||
| } | ||
| /** | ||
| * Triggers the callback function. | ||
| */ | ||
| trigger(): void; | ||
| } | ||
| interface IsSignedIn { | ||
| /** | ||
| * Returns whether the current user is currently signed in. | ||
| */ | ||
| get(): boolean; | ||
| interface IsSignedIn { | ||
| /** | ||
| * Returns whether the current user is currently signed in. | ||
| */ | ||
| get(): boolean; | ||
| /** | ||
| * Listen for changes in the current user's sign-in state. | ||
| */ | ||
| listen(listener: (signedIn: boolean) => any): Listener; | ||
| } | ||
| /** | ||
| * Listen for changes in the current user's sign-in state. | ||
| */ | ||
| listen(listener: (signedIn: boolean) => any): Listener; | ||
| } | ||
| interface CurrentUser { | ||
| /** | ||
| * Returns a GoogleUser object that represents the current user. Note that in a newly-initialized | ||
| * GoogleAuth instance, the current user has not been set. Use the currentUser.listen() method or the | ||
| * GoogleAuth.then() to get an initialized GoogleAuth instance. | ||
| */ | ||
| get(): GoogleUser; | ||
| interface CurrentUser { | ||
| /** | ||
| * Returns a GoogleUser object that represents the current user. Note that in a newly-initialized | ||
| * GoogleAuth instance, the current user has not been set. Use the currentUser.listen() method or the | ||
| * GoogleAuth.then() to get an initialized GoogleAuth instance. | ||
| */ | ||
| get(): GoogleUser; | ||
| /** | ||
| * Listen for changes in currentUser. | ||
| */ | ||
| listen(listener: (user: GoogleUser) => any): Listener; | ||
| } | ||
| /** | ||
| * Listen for changes in currentUser. | ||
| */ | ||
| listen(listener: (user: GoogleUser) => any): Listener; | ||
| } | ||
| interface SigninOptions { | ||
| /** | ||
| * The package name of the Android app to install over the air. | ||
| * See Android app installs from your web site: | ||
| * https://developers.google.com/identity/sign-in/web/android-app-installs | ||
| */ | ||
| app_package_name?: string | undefined; | ||
| /** | ||
| * Fetch users' basic profile information when they sign in. | ||
| * Adds 'profile', 'email' and 'openid' to the requested scopes. | ||
| * True if unspecified. | ||
| */ | ||
| fetch_basic_profile?: boolean | undefined; | ||
| /** | ||
| * Specifies whether to prompt the user for re-authentication. | ||
| * See OpenID Connect Request Parameters: | ||
| * https://openid.net/specs/openid-connect-basic-1_0.html#RequestParameters | ||
| */ | ||
| prompt?: string | undefined; | ||
| /** | ||
| * The scopes to request, as a space-delimited string. | ||
| * Optional if fetch_basic_profile is not set to false. | ||
| */ | ||
| scope?: string | undefined; | ||
| /** | ||
| * The UX mode to use for the sign-in flow. | ||
| * By default, it will open the consent flow in a popup. | ||
| */ | ||
| ux_mode?: "popup" | "redirect" | undefined; | ||
| /** | ||
| * If using ux_mode='redirect', this parameter allows you to override the default redirect_uri that will be used at the end of the consent flow. | ||
| * The default redirect_uri is the current URL stripped of query parameters and hash fragment. | ||
| */ | ||
| redirect_uri?: string | undefined; | ||
| /** | ||
| * When your app knows which user it is trying to authenticate, it can provide this parameter as a hint to the authentication server. | ||
| * Passing this hint suppresses the account chooser and either pre-fill the email box on the sign-in form, or select the proper session (if the user is using multiple sign-in), | ||
| * which can help you avoid problems that occur if your app logs in the wrong user account. The value can be either an email address or the sub string, | ||
| * which is equivalent to the user's Google ID. | ||
| * https://developers.google.com/identity/protocols/OpenIDConnect?hl=en#authenticationuriparameters | ||
| */ | ||
| login_hint?: string | undefined; | ||
| } | ||
| interface SigninOptions { | ||
| /** | ||
| * The package name of the Android app to install over the air. | ||
| * See Android app installs from your web site: | ||
| * https://developers.google.com/identity/sign-in/web/android-app-installs | ||
| */ | ||
| app_package_name?: string | undefined; | ||
| /** | ||
| * Fetch users' basic profile information when they sign in. | ||
| * Adds 'profile', 'email' and 'openid' to the requested scopes. | ||
| * True if unspecified. | ||
| */ | ||
| fetch_basic_profile?: boolean | undefined; | ||
| /** | ||
| * Specifies whether to prompt the user for re-authentication. | ||
| * See OpenID Connect Request Parameters: | ||
| * https://openid.net/specs/openid-connect-basic-1_0.html#RequestParameters | ||
| */ | ||
| prompt?: string | undefined; | ||
| /** | ||
| * The scopes to request, as a space-delimited string. | ||
| * Optional if fetch_basic_profile is not set to false. | ||
| */ | ||
| scope?: string | undefined; | ||
| /** | ||
| * The UX mode to use for the sign-in flow. | ||
| * By default, it will open the consent flow in a popup. | ||
| */ | ||
| ux_mode?: "popup" | "redirect" | undefined; | ||
| /** | ||
| * If using ux_mode='redirect', this parameter allows you to override the default redirect_uri that will be used at the end of the consent flow. | ||
| * The default redirect_uri is the current URL stripped of query parameters and hash fragment. | ||
| */ | ||
| redirect_uri?: string | undefined; | ||
| /** | ||
| * When your app knows which user it is trying to authenticate, it can provide this parameter as a hint to the authentication server. | ||
| * Passing this hint suppresses the account chooser and either pre-fill the email box on the sign-in form, or select the proper session (if the user is using multiple sign-in), | ||
| * which can help you avoid problems that occur if your app logs in the wrong user account. The value can be either an email address or the sub string, | ||
| * which is equivalent to the user's Google ID. | ||
| * https://developers.google.com/identity/protocols/OpenIDConnect?hl=en#authenticationuriparameters | ||
| */ | ||
| login_hint?: string | undefined; | ||
| } | ||
| /** | ||
| * Definitions by: John <https://github.com/jhcao23> | ||
| * Interface that represents the different configuration parameters for the GoogleAuth.grantOfflineAccess(options) method. | ||
| * Reference: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2offlineaccessoptions | ||
| */ | ||
| interface OfflineAccessOptions { | ||
| scope?: string | undefined; | ||
| prompt?: "select_account" | "consent" | undefined; | ||
| app_package_name?: string | undefined; | ||
| } | ||
| /** | ||
| * Interface that represents the different configuration parameters for the gapi.auth2.init method. | ||
| * Reference: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2clientconfig | ||
| */ | ||
| interface ClientConfig { | ||
| /** | ||
| * The app's client ID, found and created in the Google Developers Console. | ||
| * Definitions by: John <https://github.com/jhcao23> | ||
| * Interface that represents the different configuration parameters for the GoogleAuth.grantOfflineAccess(options) method. | ||
| * Reference: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2offlineaccessoptions | ||
| */ | ||
| client_id?: string | undefined; | ||
| interface OfflineAccessOptions { | ||
| scope?: string | undefined; | ||
| prompt?: "select_account" | "consent" | undefined; | ||
| app_package_name?: string | undefined; | ||
| } | ||
| /** | ||
| * The domains for which to create sign-in cookies. Either a URI, single_host_origin, or none. | ||
| * Defaults to single_host_origin if unspecified. | ||
| * Interface that represents the different configuration parameters for the gapi.auth2.init method. | ||
| * Reference: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2clientconfig | ||
| */ | ||
| cookie_policy?: string | undefined; | ||
| interface ClientConfig { | ||
| /** | ||
| * The app's client ID, found and created in the Google Developers Console. | ||
| */ | ||
| client_id?: string | undefined; | ||
| /** | ||
| * The scopes to request, as a space-delimited string. Optional if fetch_basic_profile is not set to false. | ||
| */ | ||
| scope?: string | undefined; | ||
| /** | ||
| * The domains for which to create sign-in cookies. Either a URI, single_host_origin, or none. | ||
| * Defaults to single_host_origin if unspecified. | ||
| */ | ||
| cookie_policy?: string | undefined; | ||
| /** | ||
| * Fetch users' basic profile information when they sign in. Adds 'profile' and 'email' to the requested scopes. True if unspecified. | ||
| */ | ||
| fetch_basic_profile?: boolean | undefined; | ||
| /** | ||
| * The scopes to request, as a space-delimited string. Optional if fetch_basic_profile is not set to false. | ||
| */ | ||
| scope?: string | undefined; | ||
| /** | ||
| * The Google Apps domain to which users must belong to sign in. This is susceptible to modification by clients, | ||
| * so be sure to verify the hosted domain property of the returned user. Use GoogleUser.getHostedDomain() on the client, | ||
| * and the hd claim in the ID Token on the server to verify the domain is what you expected. | ||
| */ | ||
| hosted_domain?: string | undefined; | ||
| /** | ||
| * Fetch users' basic profile information when they sign in. Adds 'profile' and 'email' to the requested scopes. True if unspecified. | ||
| */ | ||
| fetch_basic_profile?: boolean | undefined; | ||
| /** | ||
| * Used only for OpenID 2.0 client migration. Set to the value of the realm that you are currently using for OpenID 2.0, | ||
| * as described in <a href="https://developers.google.com/accounts/docs/OpenID#openid-connect">OpenID 2.0 (Migration)</a>. | ||
| */ | ||
| openid_realm?: string | undefined; | ||
| /** | ||
| * The Google Apps domain to which users must belong to sign in. This is susceptible to modification by clients, | ||
| * so be sure to verify the hosted domain property of the returned user. Use GoogleUser.getHostedDomain() on the client, | ||
| * and the hd claim in the ID Token on the server to verify the domain is what you expected. | ||
| */ | ||
| hosted_domain?: string | undefined; | ||
| /** | ||
| * The UX mode to use for the sign-in flow. | ||
| * By default, it will open the consent flow in a popup. | ||
| */ | ||
| ux_mode?: "popup" | "redirect" | undefined; | ||
| /** | ||
| * Used only for OpenID 2.0 client migration. Set to the value of the realm that you are currently using for OpenID 2.0, | ||
| * as described in <a href="https://developers.google.com/accounts/docs/OpenID#openid-connect">OpenID 2.0 (Migration)</a>. | ||
| */ | ||
| openid_realm?: string | undefined; | ||
| /** | ||
| * If using ux_mode='redirect', this parameter allows you to override the default redirect_uri that will be used at the end of the consent flow. | ||
| * The default redirect_uri is the current URL stripped of query parameters and hash fragment. | ||
| */ | ||
| redirect_uri?: string | undefined; | ||
| } | ||
| /** | ||
| * The UX mode to use for the sign-in flow. | ||
| * By default, it will open the consent flow in a popup. | ||
| */ | ||
| ux_mode?: "popup" | "redirect" | undefined; | ||
| class SigninOptionsBuilder { | ||
| setAppPackageName(name: string): any; | ||
| setFetchBasicProfile(fetch: boolean): any; | ||
| setPrompt(prompt: string): any; | ||
| setScope(scope: string): any; | ||
| setLoginHint(hint: string): any; | ||
| } | ||
| /** | ||
| * If using ux_mode='redirect', this parameter allows you to override the default redirect_uri that will be used at the end of the consent flow. | ||
| * The default redirect_uri is the current URL stripped of query parameters and hash fragment. | ||
| */ | ||
| redirect_uri?: string | undefined; | ||
| } | ||
| interface BasicProfile { | ||
| getId(): string; | ||
| getName(): string; | ||
| getGivenName(): string; | ||
| getFamilyName(): string; | ||
| getImageUrl(): string; | ||
| getEmail(): string; | ||
| } | ||
| class SigninOptionsBuilder { | ||
| setAppPackageName(name: string): any; | ||
| setFetchBasicProfile(fetch: boolean): any; | ||
| setPrompt(prompt: string): any; | ||
| setScope(scope: string): any; | ||
| setLoginHint(hint: string): any; | ||
| } | ||
| /** | ||
| * Reference: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2authresponse | ||
| */ | ||
| interface AuthResponse { | ||
| access_token: string; | ||
| id_token: string; | ||
| login_hint: string; | ||
| scope: string; | ||
| expires_in: number; | ||
| first_issued_at: number; | ||
| expires_at: number; | ||
| } | ||
| interface BasicProfile { | ||
| getId(): string; | ||
| getName(): string; | ||
| getGivenName(): string; | ||
| getFamilyName(): string; | ||
| getImageUrl(): string; | ||
| getEmail(): string; | ||
| } | ||
| /** | ||
| * Reference: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2authorizeconfig | ||
| */ | ||
| interface AuthorizeConfig { | ||
| client_id: string; | ||
| scope: string; | ||
| response_type?: string | undefined; | ||
| prompt?: string | undefined; | ||
| cookie_policy?: string | undefined; | ||
| hosted_domain?: string | undefined; | ||
| login_hint?: string | undefined; | ||
| app_package_name?: string | undefined; | ||
| openid_realm?: string | undefined; | ||
| include_granted_scopes?: boolean | undefined; | ||
| } | ||
| /** | ||
| * Reference: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2authorizeresponse | ||
| */ | ||
| interface AuthorizeResponse { | ||
| access_token: string; | ||
| id_token: string; | ||
| code: string; | ||
| scope: string; | ||
| expires_in: number; | ||
| first_issued_at: number; | ||
| expires_at: number; | ||
| error: string; | ||
| error_subtype: string; | ||
| } | ||
| /** | ||
| * A GoogleUser object represents one user account. | ||
| */ | ||
| interface GoogleUser { | ||
| /** | ||
| * Get the user's unique ID string. | ||
| * Reference: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2authresponse | ||
| */ | ||
| getId(): string; | ||
| interface AuthResponse { | ||
| access_token: string; | ||
| id_token: string; | ||
| login_hint: string; | ||
| scope: string; | ||
| expires_in: number; | ||
| first_issued_at: number; | ||
| expires_at: number; | ||
| } | ||
| /** | ||
| * Returns true if the user is signed in. | ||
| * Reference: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2authorizeconfig | ||
| */ | ||
| isSignedIn(): boolean; | ||
| interface AuthorizeConfig { | ||
| client_id: string; | ||
| scope: string; | ||
| response_type?: string | undefined; | ||
| prompt?: string | undefined; | ||
| cookie_policy?: string | undefined; | ||
| hosted_domain?: string | undefined; | ||
| login_hint?: string | undefined; | ||
| app_package_name?: string | undefined; | ||
| openid_realm?: string | undefined; | ||
| include_granted_scopes?: boolean | undefined; | ||
| } | ||
| /** | ||
| * Get the user's Google Apps domain if the user signed in with a Google Apps account. | ||
| * Reference: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2authorizeresponse | ||
| */ | ||
| getHostedDomain(): string; | ||
| interface AuthorizeResponse { | ||
| access_token: string; | ||
| id_token: string; | ||
| code: string; | ||
| scope: string; | ||
| expires_in: number; | ||
| first_issued_at: number; | ||
| expires_at: number; | ||
| error: string; | ||
| error_subtype: string; | ||
| } | ||
| /** | ||
| * Get the scopes that the user granted as a space-delimited string. | ||
| * A GoogleUser object represents one user account. | ||
| */ | ||
| getGrantedScopes(): string; | ||
| interface GoogleUser { | ||
| /** | ||
| * Get the user's unique ID string. | ||
| */ | ||
| getId(): string; | ||
| /** | ||
| * Get the user's basic profile information. | ||
| */ | ||
| getBasicProfile(): BasicProfile; | ||
| /** | ||
| * Returns true if the user is signed in. | ||
| */ | ||
| isSignedIn(): boolean; | ||
| /** | ||
| * Get the response object from the user's auth session. | ||
| */ | ||
| getAuthResponse(includeAuthorizationData?: boolean): AuthResponse; | ||
| /** | ||
| * Get the user's Google Apps domain if the user signed in with a Google Apps account. | ||
| */ | ||
| getHostedDomain(): string; | ||
| /** | ||
| * Forces a refresh of the access token, and then returns a Promise for the new AuthResponse. | ||
| */ | ||
| reloadAuthResponse(): Promise<AuthResponse>; | ||
| /** | ||
| * Get the scopes that the user granted as a space-delimited string. | ||
| */ | ||
| getGrantedScopes(): string; | ||
| /** | ||
| * Returns true if the user granted the specified scopes. | ||
| */ | ||
| hasGrantedScopes(scopes: string): boolean; | ||
| /** | ||
| * Get the user's basic profile information. | ||
| */ | ||
| getBasicProfile(): BasicProfile; | ||
| /** | ||
| * See GoogleUser.signIn() | ||
| */ | ||
| grant(options?: SigninOptions | SigninOptionsBuilder): Promise<any>; | ||
| /** | ||
| * Get the response object from the user's auth session. | ||
| */ | ||
| getAuthResponse(includeAuthorizationData?: boolean): AuthResponse; | ||
| /** | ||
| * Get permission from the user to access the specified scopes offline. | ||
| * When you use GoogleUser.grantOfflineAccess(), the sign-in flow skips the account chooser step. | ||
| * See GoogleUser.grantOfflineAccess(). | ||
| */ | ||
| grantOfflineAccess(options?: OfflineAccessOptions): Promise<{code: string}>; | ||
| /** | ||
| * Forces a refresh of the access token, and then returns a Promise for the new AuthResponse. | ||
| */ | ||
| reloadAuthResponse(): Promise<AuthResponse>; | ||
| /** | ||
| * Revokes all of the scopes that the user granted. | ||
| */ | ||
| disconnect(): void; | ||
| } | ||
| /** | ||
| * Returns true if the user granted the specified scopes. | ||
| */ | ||
| hasGrantedScopes(scopes: string): boolean; | ||
| /** | ||
| * Initializes the GoogleAuth object. | ||
| * Reference: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2initparams | ||
| */ | ||
| function init(params: ClientConfig): GoogleAuth; | ||
| /** | ||
| * See GoogleUser.signIn() | ||
| */ | ||
| grant(options?: SigninOptions | SigninOptionsBuilder): Promise<any>; | ||
| /** | ||
| * Returns the GoogleAuth object. You must initialize the GoogleAuth object with gapi.auth2.init() before calling this method. | ||
| */ | ||
| function getAuthInstance(): GoogleAuth; | ||
| /** | ||
| * Get permission from the user to access the specified scopes offline. | ||
| * When you use GoogleUser.grantOfflineAccess(), the sign-in flow skips the account chooser step. | ||
| * See GoogleUser.grantOfflineAccess(). | ||
| */ | ||
| grantOfflineAccess(options?: OfflineAccessOptions): Promise<{ code: string }>; | ||
| /** | ||
| * Performs a one time OAuth 2.0 authorization. | ||
| * Reference: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2authorizeparams-callback | ||
| */ | ||
| function authorize(params: AuthorizeConfig, callback: (response: AuthorizeResponse) => void): void; | ||
| } | ||
| /** | ||
| * Revokes all of the scopes that the user granted. | ||
| */ | ||
| disconnect(): void; | ||
| } | ||
| declare namespace gapi.signin2 { | ||
| function render(id: any, options: { | ||
| /** | ||
| * The auth scope or scopes to authorize. Auth scopes for individual APIs can be found in their documentation. | ||
| * Initializes the GoogleAuth object. | ||
| * Reference: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2initparams | ||
| */ | ||
| scope?: string | undefined; | ||
| function init(params: ClientConfig): GoogleAuth; | ||
| /** | ||
| * The width of the button in pixels (default: 120). | ||
| * Returns the GoogleAuth object. You must initialize the GoogleAuth object with gapi.auth2.init() before calling this method. | ||
| */ | ||
| width?: number | undefined; | ||
| function getAuthInstance(): GoogleAuth; | ||
| /** | ||
| * The height of the button in pixels (default: 36). | ||
| * Performs a one time OAuth 2.0 authorization. | ||
| * Reference: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2authorizeparams-callback | ||
| */ | ||
| height?: number | undefined; | ||
| function authorize(params: AuthorizeConfig, callback: (response: AuthorizeResponse) => void): void; | ||
| } | ||
| /** | ||
| * Display long labels such as "Sign in with Google" rather than "Sign in" (default: false). | ||
| */ | ||
| longtitle?: boolean | undefined; | ||
| declare namespace gapi.signin2 { | ||
| function render(id: any, options: { | ||
| /** | ||
| * The auth scope or scopes to authorize. Auth scopes for individual APIs can be found in their documentation. | ||
| */ | ||
| scope?: string | undefined; | ||
| /** | ||
| * The color theme of the button: either light or dark (default: light). | ||
| */ | ||
| theme?: string | undefined; | ||
| /** | ||
| * The width of the button in pixels (default: 120). | ||
| */ | ||
| width?: number | undefined; | ||
| /** | ||
| * The callback function to call when a user successfully signs in (default: none). | ||
| */ | ||
| onsuccess?(user: auth2.GoogleUser): void; | ||
| /** | ||
| * The height of the button in pixels (default: 36). | ||
| */ | ||
| height?: number | undefined; | ||
| /** | ||
| * The callback function to call when sign-in fails (default: none). | ||
| */ | ||
| onfailure?(reason: { error: string }): void; | ||
| /** | ||
| * Display long labels such as "Sign in with Google" rather than "Sign in" (default: false). | ||
| */ | ||
| longtitle?: boolean | undefined; | ||
| /** | ||
| * The package name of the Android app to install over the air. See | ||
| * <a href="https://developers.google.com/identity/sign-in/web/android-app-installs">Android app installs from your web site</a>. | ||
| * Optional. (default: none) | ||
| */ | ||
| app_package_name?: string | undefined; | ||
| }): void; | ||
| /** | ||
| * The color theme of the button: either light or dark (default: light). | ||
| */ | ||
| theme?: string | undefined; | ||
| /** | ||
| * The callback function to call when a user successfully signs in (default: none). | ||
| */ | ||
| onsuccess?(user: auth2.GoogleUser): void; | ||
| /** | ||
| * The callback function to call when sign-in fails (default: none). | ||
| */ | ||
| onfailure?(reason: { error: string }): void; | ||
| /** | ||
| * The package name of the Android app to install over the air. See | ||
| * <a href="https://developers.google.com/identity/sign-in/web/android-app-installs">Android app installs from your web site</a>. | ||
| * Optional. (default: none) | ||
| */ | ||
| app_package_name?: string | undefined; | ||
| }): void; | ||
| } |
| { | ||
| "name": "@types/gapi.auth2", | ||
| "version": "0.0.57", | ||
| "version": "0.0.58", | ||
| "description": "TypeScript definitions for Google Sign-In API", | ||
@@ -25,4 +25,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gapi.auth2", | ||
| }, | ||
| "typesPublisherContentHash": "246a00209793d6145391713b088118fd4880b128102c2d01d7a5077d5ea71cc8", | ||
| "typeScriptVersion": "4.2" | ||
| "typesPublisherContentHash": "b3396b95b4844a6eb0fe2f12db5796c0f46a8086a3c6554e36022971589bd31b", | ||
| "typeScriptVersion": "4.5" | ||
| } |
@@ -11,3 +11,3 @@ # Installation | ||
| ### Additional Details | ||
| * Last updated: Fri, 27 Jan 2023 22:32:41 GMT | ||
| * Last updated: Wed, 20 Sep 2023 17:08:03 GMT | ||
| * Dependencies: [@types/gapi](https://npmjs.com/package/@types/gapi) | ||
@@ -14,0 +14,0 @@ * Global values: `gapi` |
No alert changes
Improved metrics
- Total package byte prevSize
- increased by7.99%
16872
- Lines of code
- increased by2.06%
346
No dependency changes