types/gapi/index.d.ts

/**
 * The OAuth 2.0 token object represents the OAuth 2.0 token and any associated data.
 */
interface GoogleApiOAuth2TokenObject {
    /**
     * The OAuth 2.0 token. Only present in successful responses
     */
    access_token: string;
    /**
     * Details about the error. Only present in error responses
     */
    error: string;
    /**
     * The duration, in seconds, the token is valid for. Only present in successful responses
     */
    expires_in: string;
    session_state?: GoogleApiOAuth2TokenSessionState | undefined;
    /**
     * The Google API scopes related to this token
     */
    state: string;
}

interface GoogleApiOAuth2TokenSessionState {
    extraQueryParams: {
        authuser: string;
    };
}

/**
 * Fix for #8215
 * https://github.com/DefinitelyTyped/DefinitelyTyped/issues/8215
 *
 * Usage example:
 * https://developers.google.com/identity/sign-in/web/session-state
 */
declare namespace gapi {
    type LoadCallback = (...args: any[]) => void;
    type LoadConfig = {
        callback: LoadCallback;
        onerror?: Function | undefined;
        timeout?: number | undefined;
        ontimeout?: Function | undefined;
    };
    type CallbackOrConfig = LoadConfig | LoadCallback;

    /**
     * Pragmatically initialize gapi class member.
     * Reference: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiloadlibraries-callbackorconfig
     */
    export function load(apiName: string, callback: CallbackOrConfig): void;
}

declare namespace gapi.auth {
    /**
     * Initiates the OAuth 2.0 authorization process. The browser displays a popup window prompting the user authenticate and authorize. After the user authorizes, the popup closes and the callback function fires.
     * @param params A key/value map of parameters for the request. If the key is not one of the expected OAuth 2.0 parameters, it is added to the URI as a query parameter.
     * @param callback The function to call once the login process is complete. The function takes an OAuth 2.0 token object as its only parameter.
     */
    export function authorize(params: {
        /**
         * The application's client ID.
         */
        client_id?: string | undefined;
        /**
         * If true, then login uses "immediate mode", which means that the token is refreshed behind the scenes, and no UI is shown to the user.
         */
        immediate?: boolean | undefined;
        /**
         * The OAuth 2.0 response type property. Default: token
         */
        response_type?: string | undefined;
        /**
         * The auth scope or scopes to authorize. Auth scopes for individual APIs can be found in their documentation.
         */
        scope?: any;
        /**
         * The user to sign in as. -1 to toggle a multi-account chooser, 0 to default to the user's current account, and 1 to automatically sign in if the user is signed into Google Plus.
         */
        authuser?: number | undefined;
    }, callback: (token: GoogleApiOAuth2TokenObject) => any): void;
    /**
     * Initializes the authorization feature. Call this when the client loads to prevent popup blockers from blocking the auth window on gapi.auth.authorize calls.
     * @param callback A callback to execute when the auth feature is ready to make authorization calls.
     */
    export function init(callback: () => any): void;
    /**
     * Retrieves the OAuth 2.0 token for the application.
     * @return The OAuth 2.0 token.
     */
    export function getToken(): GoogleApiOAuth2TokenObject;
    /**
     * Sets the OAuth 2.0 token for the application.
     * @param token The token to set.
     */
    export function setToken(token: GoogleApiOAuth2TokenObject): void;
    /**
     * Initiates the client-side Google+ Sign-In OAuth 2.0 flow.
     * When the method is called, the OAuth 2.0 authorization dialog is displayed to the user and when they accept, the callback function is called.
     * @param params
     */
    export function signIn(params: {
        /**
         * Your OAuth 2.0 client ID that you obtained from the Google Developers Console.
         */
        clientid?: string | undefined;
        /**
         * Directs the sign-in button to store user and session information in a session cookie and HTML5 session storage on the user's client for the purpose of minimizing HTTP traffic and distinguishing between multiple Google accounts a user might be signed into.
         */
        cookiepolicy?: string | undefined;
        /**
         * A function in the global namespace, which is called when the sign-in button is rendered and also called after a sign-in flow completes.
         */
        callback?: (() => void) | undefined;
        /**
         * If true, all previously granted scopes remain granted in each incremental request, for incremental authorization. The default value true is correct for most use cases; use false only if employing delegated auth, where you pass the bearer token to a less-trusted component with lower programmatic authority.
         */
        includegrantedscopes?: boolean | undefined;
        /**
         * If your app will write moments, list the full URI of the types of moments that you intend to write.
         */
        requestvisibleactions?: any;
        /**
         * The OAuth 2.0 scopes for the APIs that you would like to use as a space-delimited list.
         */
        scope?: any;
        /**
         * If you have an Android app, you can drive automatic Android downloads from your web sign-in flow.
         */
        apppackagename?: string | undefined;
    }): void;
    /**
     * Signs a user out of your app without logging the user out of Google. This method will only work when the user is signed in with Google+ Sign-In.
     */
    export function signOut(): void;
}

declare namespace gapi.client {
    /**
     * Initializes the JavaScript client with API key, OAuth client ID, scope, and API discovery document(s).
     * If OAuth client ID and scope are provided, this function will load the gapi.auth2 module to perform OAuth.
     * The gapi.client.init function can be run multiple times, such as to set up more APIs, to change API key, or initialize OAuth lazily.
     */
    export function init(args: {
        /**
         * The API Key to use.
         */
        apiKey?: string | undefined;
        /**
         * An array of discovery doc URLs or discovery doc JSON objects.
         */
        discoveryDocs?: string[] | undefined;
        /**
         * The app's client ID, found and created in the Google Developers Console.
         */
        clientId?: string | undefined;
        /**
         * The scopes to request, as a space-delimited string.
         */
        scope?: string | undefined;
        /**
         * Arbitrary value. If present, allows keys generated after July 29th, 2022 to work with the old (deprecated) api.
         */
        plugin_name?: string;

        hosted_domain?: string | undefined;
    }): Promise<void>;

    interface RequestOptions {
        /**
         * The URL to handle the request
         */
        path: string;
        /**
         * The HTTP request method to use. Default is GET
         */
        method?: string | undefined;
        /**
         * URL params in key-value pair form
         */
        params?: any;
        /**
         * Additional HTTP request headers
         */
        headers?: any;
        /**
         * The HTTP request body (applies to PUT or POST).
         */
        body?: any;
        /**
         * If supplied, the request is executed immediately and no gapi.client.HttpRequest object is returned
         */
        callback?: (() => any) | undefined;
    }

    interface TokenObject {
        /**
         * The access token to use in requests.
         */
        access_token: string;
    }

    /**
     * Loads the client library interface to a particular API with discovery document URL or JSON object.
     * @param urlOrObject The Discovery Document URL or parsed Discovery Document JSON object
     * @return promise The promise that get's resolved after the request is finished.
     */
    export function load(urlOrObject: string | object): Promise<void>;

    /**
     * Loads the client library interface to a particular API. If a callback is not provided, a promise is returned.
     * @param name The name of the API to load.
     * @param version The version of the API to load.
     * @return promise The promise that get's resolved after the request is finished.
     */
    export function load(name: string, version: string): Promise<void>;

    /**
     * Loads the client library interface to a particular API. The new API interface will be in the form gapi.client.api.collection.method.
     * @param name The name of the API to load.
     * @param version The version of the API to load
     * @param callback the function that is called once the API interface is loaded
     * @param url optional, the url of your app - if using Google's APIs, don't set it
     */
    export function load(name: string, version: string, callback: () => any, url?: string): void;
    /**
     * Creates a HTTP request for making RESTful requests.
     * An object encapsulating the various arguments for this method.
     */
    export function request(args: RequestOptions): HttpRequest<any>;
    /**
     * Creates an RPC Request directly. The method name and version identify the method to be executed and the RPC params are provided upon RPC creation.
     * @param method The method to be executed.
     * @param version The version of the API which defines the method to be executed. Defaults to v1
     * @param rpcParams A key-value pair of the params to supply to this RPC
     */
    export function rpcRequest(method: string, version?: string, rpcParams?: any): RpcRequest;
    /**
     * Sets the API key for the application.
     * @param apiKey The API key to set
     */
    export function setApiKey(apiKey: string): void;
    /**
     * Retrieves the OAuth 2.0 token for the application.
     * @return The OAuth 2.0 token.
     */
    export function getToken(): GoogleApiOAuth2TokenObject;
    /**
     * Sets the authentication token to use in requests.
     * @param token The token to set.
     *
     * Reference: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiclientsettokentokenobject
     */
    export function setToken(token: TokenObject | null): void;

    interface HttpRequestFulfilled<T> {
        result: T;
        body: string;
        headers?: any[] | undefined;
        status?: number | undefined;
        statusText?: string | undefined;
    }

    interface HttpRequestRejected {
        result: any | boolean;
        body: string;
        headers?: any[] | undefined;
        status?: number | undefined;
        statusText?: string | undefined;
    }

    /**
     * HttpRequest supports promises.
     * See Google API Client JavaScript Using Promises https://developers.google.com/api-client-library/javascript/features/promises
     */
    class HttpRequestPromise<T> {
        // Taken and adapted from https://github.com/Microsoft/TypeScript/blob/v2.3.1/lib/lib.es5.d.ts#L1343
        then<TResult1 = T, TResult2 = never>(
            onfulfilled?: ((response: HttpRequestFulfilled<T>) => TResult1 | PromiseLike<TResult1>) | null,
            onrejected?: ((reason: HttpRequestRejected) => TResult2 | PromiseLike<TResult2>) | null,
            opt_context?: any,
        ): Promise<TResult1 | TResult2>;
    }

    /**
     * An object encapsulating an HTTP request. This object is not instantiated directly, rather it is returned by gapi.client.request.
     */
    export class HttpRequest<T> extends HttpRequestPromise<T> {
        /**
         * Executes the request and runs the supplied callback on response.
         * @param callback The callback function which executes when the request succeeds or fails.
         */
        execute(
            callback: (
                /**
                 * contains the response parsed as JSON. If the response is not JSON, this field will be false.
                 */
                jsonResp: T,
                /**
                 * is the HTTP response. It is JSON, and can be parsed to an object
                 */
                rawResp: {
                    body: string;
                    headers: any[];
                    status: number;
                    statusText: string;
                },
            ) => any,
        ): void;
    }

    /**
     * Represents an HTTP Batch operation. Individual HTTP requests are added with the add method and the batch is executed using execute.
     */
    export class HttpBatch {
        /**
         * Adds a gapi.client.HttpRequest to the batch.
         * @param httpRequest The HTTP request to add to this batch.
         * @param opt_params extra parameters for this batch entry.
         */
        add(httpRequest: HttpRequest<any>, opt_params?: {
            /**
             * Identifies the response for this request in the map of batch responses. If one is not provided, the system generates a random ID.
             */
            id: string;
            callback: (
                /**
                 * is the response for this request only. Its format is defined by the API method being called.
                 */
                individualResponse: any,
                /**
                 * is the raw batch ID-response map as a string. It contains all responses to all requests in the batch.
                 */
                rawBatchResponse: any,
            ) => any;
        }): void;
        /**
         * Executes all requests in the batch. The supplied callback is executed on success or failure.
         * @param callback The callback to execute when the batch returns.
         */
        execute(
            callback: (
                /**
                 * is an ID-response map of each requests response.
                 */
                responseMap: any,
                /**
                 * is the same response, but as an unparsed JSON-string.
                 */
                rawBatchResponse: string,
            ) => any,
        ): void;
    }

    /**
     * Similar to gapi.client.HttpRequest except this object encapsulates requests generated by registered methods.
     */
    export class RpcRequest {
        /**
         * Executes the request and runs the supplied callback with the response.
         * @param callback The callback function which executes when the request succeeds or fails.
         */
        callback(
            callback: (
                /**
                 * contains the response parsed as JSON. If the response is not JSON, this field will be false.
                 */
                jsonResp: any,
                /**
                 * is the same as jsonResp, except it is a raw string that has not been parsed. It is typically used when the response is not JSON.
                 */
                rawResp: string,
            ) => void,
        ): void;
    }
}