firebase-admin 9.12.0 → 10.0.0

package/lib/app-check/token-generator.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.12.0 */
+/*! firebase-admin v10.0.0 */
 "use strict";
 /*!
  * @license
@@ -47,7 +47,7 @@ var AppCheckTokenGenerator = /** @class */ (function () {
     /**
      * The AppCheckTokenGenerator class constructor.
      *
-     * @param signer The CryptoSigner instance for this token generator.
+     * @param signer - The CryptoSigner instance for this token generator.
      * @constructor
      */
     function AppCheckTokenGenerator(signer) {
@@ -59,9 +59,9 @@ var AppCheckTokenGenerator = /** @class */ (function () {
     /**
      * Creates a new custom token that can be exchanged to an App Check token.
      *
-     * @param appId The Application ID to use for the generated token.
+     * @param appId - The Application ID to use for the generated token.
      *
-     * @return A Promise fulfilled with a custom token signed with a service account key
+     * @returns A Promise fulfilled with a custom token signed with a service account key
      * that can be exchanged to an App Check token.
      */
     AppCheckTokenGenerator.prototype.createCustomToken = function (appId, options) {
@@ -99,7 +99,7 @@ var AppCheckTokenGenerator = /** @class */ (function () {
      * Checks if a given `AppCheckTokenOptions` object is valid. If successful, returns an object with
      * custom properties.
      *
-     * @param options An options object to be validated.
+     * @param options - An options object to be validated.
      * @returns A custom object with ttl converted to protobuf Duration string format.
      */
     AppCheckTokenGenerator.prototype.validateTokenOptions = function (options) {
@@ -122,11 +122,11 @@ var AppCheckTokenGenerator = /** @class */ (function () {
 }());
 exports.AppCheckTokenGenerator = AppCheckTokenGenerator;
 /**
- * Creates a new FirebaseAppCheckError by extracting the error code, message and other relevant
- * details from a CryptoSignerError.
+ * Creates a new `FirebaseAppCheckError` by extracting the error code, message and other relevant
+ * details from a `CryptoSignerError`.
  *
- * @param err The Error to convert into a FirebaseAppCheckError error
- * @return A Firebase App Check error that can be returned to the user.
+ * @param err - The Error to convert into a `FirebaseAppCheckError` error
+ * @returns A Firebase App Check error that can be returned to the user.
  */
 function appCheckErrorFromCryptoSignerError(err) {
     if (!(err instanceof crypto_signer_1.CryptoSignerError)) {

package/lib/app-check/token-verifier.d.ts

@@ -0,0 +1,17 @@
+/*! firebase-admin v10.0.0 */
+/*!
+ * Copyright 2021 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/lib/app-check/token-verifier.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.12.0 */
+/*! firebase-admin v10.0.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.
@@ -36,8 +36,8 @@ var AppCheckTokenVerifier = /** @class */ (function () {
     /**
      * Verifies the format and signature of a Firebase App Check token.
      *
-     * @param token The Firebase Auth JWT token to verify.
-     * @return A promise fulfilled with the decoded claims of the Firebase App Check token.
+     * @param token - The Firebase Auth JWT token to verify.
+     * @returns A promise fulfilled with the decoded claims of the Firebase App Check token.
      */
     AppCheckTokenVerifier.prototype.verifyToken = function (token) {
         var _this = this;
@@ -85,8 +85,8 @@ var AppCheckTokenVerifier = /** @class */ (function () {
     /**
      * Verifies the content of a Firebase App Check JWT.
      *
-     * @param fullDecodedToken The decoded JWT.
-     * @param projectId The Firebase Project Id.
+     * @param fullDecodedToken - The decoded JWT.
+     * @param projectId - The Firebase Project Id.
      */
     AppCheckTokenVerifier.prototype.verifyContent = function (fullDecodedToken, projectId) {
         var header = fullDecodedToken.header;
@@ -126,7 +126,7 @@ var AppCheckTokenVerifier = /** @class */ (function () {
     /**
      * Maps JwtError to FirebaseAppCheckError
      *
-     * @param error JwtError to be mapped.
+     * @param error - JwtError to be mapped.
      * @returns FirebaseAppCheckError instance.
      */
     AppCheckTokenVerifier.prototype.mapJwtErrorToAppCheckError = function (error) {

package/lib/auth/action-code-settings-builder.d.ts

@@ -0,0 +1,87 @@
+/*! firebase-admin v10.0.0 */
+/*!
+ * Copyright 2018 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * This is the interface that defines the required continue/state URL with
+ * optional Android and iOS bundle identifiers.
+ */
+export interface ActionCodeSettings {
+    /**
+     * Defines the link continue/state URL, which has different meanings in
+     * different contexts:
+     * <ul>
+     * <li>When the link is handled in the web action widgets, this is the deep
+     *     link in the `continueUrl` query parameter.</li>
+     * <li>When the link is handled in the app directly, this is the `continueUrl`
+     *     query parameter in the deep link of the Dynamic Link.</li>
+     * </ul>
+     */
+    url: string;
+    /**
+     * Whether to open the link via a mobile app or a browser.
+     * The default is false. When set to true, the action code link is sent
+     * as a Universal Link or Android App Link and is opened by the app if
+     * installed. In the false case, the code is sent to the web widget first
+     * and then redirects to the app if installed.
+     */
+    handleCodeInApp?: boolean;
+    /**
+     * Defines the iOS bundle ID. This will try to open the link in an iOS app if it
+     * is installed.
+     */
+    iOS?: {
+        /**
+         * Defines the required iOS bundle ID of the app where the link should be
+         * handled if the application is already installed on the device.
+         */
+        bundleId: string;
+    };
+    /**
+     * Defines the Android package name. This will try to open the link in an
+     * android app if it is installed. If `installApp` is passed, it specifies
+     * whether to install the Android app if the device supports it and the app is
+     * not already installed. If this field is provided without a `packageName`, an
+     * error is thrown explaining that the `packageName` must be provided in
+     * conjunction with this field. If `minimumVersion` is specified, and an older
+     * version of the app is installed, the user is taken to the Play Store to
+     * upgrade the app.
+     */
+    android?: {
+        /**
+         * Defines the required Android package name of the app where the link should be
+         * handled if the Android app is installed.
+         */
+        packageName: string;
+        /**
+         * Whether to install the Android app if the device supports it and the app is
+         * not already installed.
+         */
+        installApp?: boolean;
+        /**
+         * The Android minimum version if available. If the installed app is an older
+         * version, the user is taken to the GOogle Play Store to upgrade the app.
+         */
+        minimumVersion?: string;
+    };
+    /**
+     * Defines the dynamic link domain to use for the current link if it is to be
+     * opened using Firebase Dynamic Links, as multiple dynamic link domains can be
+     * configured per project. This field provides the ability to explicitly choose
+     * configured per project. This fields provides the ability explicitly choose
+     * one. If none is provided, the oldest domain is used by default.
+     */
+    dynamicLinkDomain?: string;
+}

package/lib/auth/action-code-settings-builder.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.12.0 */
+/*! firebase-admin v10.0.0 */
 "use strict";
 /*!
  * Copyright 2018 Google Inc.
@@ -22,6 +22,8 @@ var error_1 = require("../utils/error");
 /**
  * Defines the ActionCodeSettings builder class used to convert the
  * ActionCodeSettings object to its corresponding server request.
+ *
+ * @internal
  */
 var ActionCodeSettingsBuilder = /** @class */ (function () {
     /**
@@ -91,7 +93,7 @@ var ActionCodeSettingsBuilder = /** @class */ (function () {
      * Returns the corresponding constructed server request corresponding to the
      * current ActionCodeSettings.
      *
-     * @return {EmailActionCodeRequest} The constructed EmailActionCodeRequest request.
+     * @returns The constructed EmailActionCodeRequest request.
      */
     ActionCodeSettingsBuilder.prototype.buildRequest = function () {
         var request = {

package/lib/auth/auth-api-request.d.ts

@@ -0,0 +1,174 @@
+/*! firebase-admin v10.0.0 */
+/*!
+ * @license
+ * Copyright 2017 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { App } from '../app/index';
+import { UserImportOptions, UserImportRecord, UserImportResult } from './user-import-builder';
+import { TenantServerResponse, CreateTenantRequest, UpdateTenantRequest } from './tenant';
+/** List of reserved claims which cannot be provided when creating a custom token. */
+export declare const RESERVED_CLAIMS: string[];
+/** List of supported email action request types. */
+export declare const EMAIL_ACTION_REQUEST_TYPES: string[];
+/** Defines a base utility to help with resource URL construction. */
+declare class AuthResourceUrlBuilder {
+    protected app: App;
+    protected version: string;
+    protected urlFormat: string;
+    private projectId;
+    /**
+     * The resource URL builder constructor.
+     *
+     * @param projectId - The resource project ID.
+     * @param version - The endpoint API version.
+     * @constructor
+     */
+    constructor(app: App, version?: string);
+    /**
+     * Returns the resource URL corresponding to the provided parameters.
+     *
+     * @param api - The backend API name.
+     * @param params - The optional additional parameters to substitute in the
+     *     URL path.
+     * @returns The corresponding resource URL.
+     */
+    getUrl(api?: string, params?: object): Promise<string>;
+    private getProjectId;
+}
+interface BatchDeleteErrorInfo {
+    index?: number;
+    localId?: string;
+    message?: string;
+}
+export interface BatchDeleteAccountsResponse {
+    errors?: BatchDeleteErrorInfo[];
+}
+/**
+ * Utility for sending requests to Auth server that are Auth instance related. This includes user and
+ * tenant management related APIs. This extends the BaseFirebaseAuthRequestHandler class and defines
+ * additional tenant management related APIs.
+ */
+export declare class AuthRequestHandler extends AbstractAuthRequestHandler {
+    protected readonly tenantMgmtResourceBuilder: AuthResourceUrlBuilder;
+    /**
+     * The FirebaseAuthRequestHandler constructor used to initialize an instance using a FirebaseApp.
+     *
+     * @param app - The app used to fetch access tokens to sign API requests.
+     * @constructor.
+     */
+    constructor(app: App);
+    /**
+     * @returns A new Auth user management resource URL builder instance.
+     */
+    protected newAuthUrlBuilder(): AuthResourceUrlBuilder;
+    /**
+     * @returns A new project config resource URL builder instance.
+     */
+    protected newProjectConfigUrlBuilder(): AuthResourceUrlBuilder;
+    /**
+     * Looks up a tenant by tenant ID.
+     *
+     * @param tenantId - The tenant identifier of the tenant to lookup.
+     * @returns A promise that resolves with the tenant information.
+     */
+    getTenant(tenantId: string): Promise<TenantServerResponse>;
+    /**
+     * Exports the tenants (single batch only) with a size of maxResults and starting from
+     * the offset as specified by pageToken.
+     *
+     * @param maxResults - The page size, 1000 if undefined. This is also the maximum
+     *     allowed limit.
+     * @param pageToken - The next page token. If not specified, returns tenants starting
+     *     without any offset. Tenants are returned in the order they were created from oldest to
+     *     newest, relative to the page token offset.
+     * @returns A promise that resolves with the current batch of downloaded
+     *     tenants and the next page token if available. For the last page, an empty list of tenants
+     *     and no page token are returned.
+     */
+    listTenants(maxResults?: number, pageToken?: string): Promise<{
+        tenants: TenantServerResponse[];
+        nextPageToken?: string;
+    }>;
+    /**
+     * Deletes a tenant identified by a tenantId.
+     *
+     * @param tenantId - The identifier of the tenant to delete.
+     * @returns A promise that resolves when the tenant is deleted.
+     */
+    deleteTenant(tenantId: string): Promise<void>;
+    /**
+     * Creates a new tenant with the properties provided.
+     *
+     * @param tenantOptions - The properties to set on the new tenant to be created.
+     * @returns A promise that resolves with the newly created tenant object.
+     */
+    createTenant(tenantOptions: CreateTenantRequest): Promise<TenantServerResponse>;
+    /**
+     * Updates an existing tenant with the properties provided.
+     *
+     * @param tenantId - The tenant identifier of the tenant to update.
+     * @param tenantOptions - The properties to update on the existing tenant.
+     * @returns A promise that resolves with the modified tenant object.
+     */
+    updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<TenantServerResponse>;
+}
+/**
+ * Utility for sending requests to Auth server that are tenant Auth instance related. This includes user
+ * management related APIs for specified tenants.
+ * This extends the BaseFirebaseAuthRequestHandler class.
+ */
+export declare class TenantAwareAuthRequestHandler extends AbstractAuthRequestHandler {
+    private readonly tenantId;
+    /**
+     * The FirebaseTenantRequestHandler constructor used to initialize an instance using a
+     * FirebaseApp and a tenant ID.
+     *
+     * @param app - The app used to fetch access tokens to sign API requests.
+     * @param tenantId - The request handler's tenant ID.
+     * @constructor
+     */
+    constructor(app: App, tenantId: string);
+    /**
+     * @returns A new Auth user management resource URL builder instance.
+     */
+    protected newAuthUrlBuilder(): AuthResourceUrlBuilder;
+    /**
+     * @returns A new project config resource URL builder instance.
+     */
+    protected newProjectConfigUrlBuilder(): AuthResourceUrlBuilder;
+    /**
+     * Imports the list of users provided to Firebase Auth. This is useful when
+     * migrating from an external authentication system without having to use the Firebase CLI SDK.
+     * At most, 1000 users are allowed to be imported one at a time.
+     * When importing a list of password users, UserImportOptions are required to be specified.
+     *
+     * Overrides the superclass methods by adding an additional check to match tenant IDs of
+     * imported user records if present.
+     *
+     * @param users - The list of user records to import to Firebase Auth.
+     * @param options - The user import options, required when the users provided
+     *     include password credentials.
+     * @returns A promise that resolves when the operation completes
+     *     with the result of the import. This includes the number of successful imports, the number
+     *     of failed uploads and their corresponding errors.
+     */
+    uploadAccount(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;
+}
+/**
+ * When true the SDK should communicate with the Auth Emulator for all API
+ * calls and also produce unsigned tokens.
+ */
+export declare function useEmulator(): boolean;
+export {};