firebase-project-manager/dist/src/index.d.ts

Create and manage your Firebase projects from the command line or with code

import * as auth from './auth';
import * as firebase from './firebase';
import { EventCB } from './firebase.types';
export { ERRORS, EVENTS, EventCB } from './firebase.types';
/** Static OAuth client managed by `authenticate` and `deauthenticate` */
export declare const oauth2Client: import("google-auth-library").OAuth2Client;
/**
 * Authenticates client with Firebase Project Manager and retains a refresh token in the
 * system's configuration store for later usage.
 * @param verbose If true, authentication status will be logged with `console.log`.
 * @return Void promise resolved upon completion
 */
export declare const authenticate: typeof auth.authenticate;
/**
 * Deauthenticates the currently logged in user, revokes and deletes the currently cached
 * refresh_token stored in the system's configuration store.
 * @param verbose If true, authentication status will be logged with `console.log`.
 * @return Void promise resolved upon completion
 */
export declare const deauthenticate: typeof auth.deauthenticate;
/**
 * Creates a new Firebase Project via a two step process of first creating a CGP Project
 * and then secondly adding Firebase resources to it.
 * @param name Desired display name for the underlying GCP project. If available, this name
 * will also be used as a `projectId` by replacing all non-whitespace characters with '-'
 * and making all alphabetic characters lower-case.
 * @param cb function called with progress of project creation.
 * @return Promise to the newly created project's `projectId`.
 */
export declare function createFirebaseProject(name: string, cb?: EventCB): Promise<string>;
/**
 * Creates a new GCP project using Google `cloudresourcemanager`.
 * @param name Desired display name for the underlying GCP project. If available, this name
 * will also be used as a `projectId` by replacing all non-whitespace characters with `-`
 * and making all alphabetic characters lower-case.
 * @param cb function called with progress of project creation.
 * @return Promise to the newly created project's `projectId`.
 */
export declare function createGCProject(name: string, cb?: EventCB): Promise<string>;
/**
 * Adds Firebase resources to a GCP Project
 * @param projectId projectId of the GCP Project to add Firebase features to.
 * @param cb function called with progress of project creation.
 * @return Void promise resolved upon completion
 */
export declare function addFirebaseFeatures(projectId: string, cb?: EventCB): Promise<void>;
/**
 * Lists all GCP Projects with Firebase resources.
 * @param pageSize The maximum number of Projects to return
 * @param pageToken Token returned from a previous call indicating where in the
 * set of Projects to resume listing.
 * @return Promise to an array of Firebase Projects
 */
export declare function listFirebaseProjects(pageSize?: number, pageToken?: string): Promise<import("googleapis").firebase_v1beta1.Schema$FirebaseProject[]>;
/**
 * Lists all GCP Projects lacking Firebase resources, but that are available to become Firebase
 * projects.
 * @param pageSize The maximum number of Projects to return
 * @param pageToken Token returned from a previous call indicating where in the
 * set of Projects to resume listing.
 * @return Promise to an array of GCP Projects
 */
export declare function listAvailableProjects(pageSize?: number, pageToken?: string): Promise<import("googleapis").firebase_v1beta1.Schema$ProjectInfo[] | undefined>;
/**
 * Retrieves information for a given Firebase project.
 * @param projectId projectId of the Firebase project to retrieve
 * @return Promise to a Firebase Project
 */
export declare function getFirebaseProject(projectId: string): Promise<import("googleapis").firebase_v1beta1.Schema$FirebaseProject>;
/**
 * Lists all applications associated with a Firebase Project.
 * @param projectId projectId of the Firebase project to retrieve apps of
 * @param pageSize The maximum number of Apps to return
 * @param pageToken Token returned from a previous call indicating where in the
 * set of Apps to resume listing.
 */
export declare function listFirebaseProjectApps(projectId: string, pageSize?: number, pageToken?: string): Promise<import("googleapis").firebase_v1beta1.Schema$FirebaseAppInfo[] | undefined>;
/**
 * Creates a new web application under a given Firebase Project.
 * @param projectId projectId of the parent Firebase project to create an application for
 * @param displayName User-assigned display name of the App.
 * @param appUrls Fully qualified URLs where the App is hosted.
 */
export declare function createFirebaseWebapp(projectId: string, displayName?: string, appUrls?: string[]): Promise<import("googleapis").firebase_v1beta1.Schema$WebApp>;
/**
 * Retrieves information for a given Firebase Project's app.
 * @param name Fully qualified identifier for the webapp (Eg: `/projects/.../webApp/...`)
 */
export declare function getFirebaseWebapp(name: string): ReturnType<typeof firebase.getFirebaseWebapp>;
/**
 * Retrieves information for a given Firebase Project's app.
 * @param projectId projectId of the parent Firebase project
 * @param appId The webapp's ID.
 */
export declare function getFirebaseWebapp(projectId: string, appId?: string): ReturnType<typeof firebase.getFirebaseWebapp>;
/**
 * Retrieves configuration information for a given Firebase Project's app.
 * @param name Fully qualified identifier for the webapp (Eg: `/projects/.../webApp/...`)
 */
export declare function getFirebaseWebappConfig(name: string): ReturnType<typeof firebase.getFirebaseWebappConfig>;
/**
 * Retrieves configuration information for a given Firebase Project's app.
 * @param projectId projectId of the parent Firebase project
 * @param appId The webapp's ID.
 */
export declare function getFirebaseWebappConfig(projectId: string, appId?: string): ReturnType<typeof firebase.getFirebaseWebappConfig>;