firebase-admin 9.3.0 → 9.5.0

package/lib/remote-config.d.ts

@@ -1,350 +0,0 @@
-/*! firebase-admin v9.3.0 */
-import * as _admin from './index.d';
-
-export namespace admin.remoteConfig {
-
-  /**
-  * Colors that are associated with conditions for display purposes.
-  */
-  type TagColor = 'BLUE' | 'BROWN' | 'CYAN' | 'DEEP_ORANGE' | 'GREEN' |
-    'INDIGO' | 'LIME' | 'ORANGE' | 'PINK' | 'PURPLE' | 'TEAL';
-
-  /**
-  * Interface representing a Remote Config template.
-  */
-  interface RemoteConfigTemplate {
-    /**
-     * A list of conditions in descending order by priority.
-     */
-    conditions: RemoteConfigCondition[];
-
-    /**
-     * Map of parameter keys to their optional default values and optional conditional values.
-     */
-    parameters: { [key: string]: RemoteConfigParameter };
-
-    /**
-     * Map of parameter group names to their parameter group objects.
-     * A group's name is mutable but must be unique among groups in the Remote Config template.
-     * The name is limited to 256 characters and intended to be human-readable. Any Unicode
-     * characters are allowed.
-     */
-    parameterGroups: { [key: string]: RemoteConfigParameterGroup };
-
-    /**
-     * ETag of the current Remote Config template (readonly).
-     */
-    readonly etag: string;
-
-    /**
-     * Version information for the current Remote Config template.
-     */
-    version?: Version;
-  }
-
-  /**
-   * Interface representing a Remote Config parameter.
-   * At minimum, a `defaultValue` or a `conditionalValues` entry must be present for the
-   * parameter to have any effect.
-   */
-  interface RemoteConfigParameter {
-
-    /**
-     * The value to set the parameter to, when none of the named conditions evaluate to `true`.
-     */
-    defaultValue?: RemoteConfigParameterValue;
-
-    /**
-     * A `(condition name, value)` map. The condition name of the highest priority
-     * (the one listed first in the Remote Config template's conditions list) determines the value of
-     * this parameter.
-     */
-    conditionalValues?: { [key: string]: RemoteConfigParameterValue };
-
-    /**
-     * A description for this parameter. Should not be over 100 characters and may contain any
-     * Unicode characters.
-     */
-    description?: string;
-  }
-
-  /**
-   * Interface representing a Remote Config parameter group.
-   * Grouping parameters is only for management purposes and does not affect client-side
-   * fetching of parameter values.
-   */
-  export interface RemoteConfigParameterGroup {
-    /**
-     * A description for the group. Its length must be less than or equal to 256 characters.
-     * A description may contain any Unicode characters.
-     */
-    description?: string;
-
-    /**
-     * Map of parameter keys to their optional default values and optional conditional values for
-     * parameters that belong to this group. A parameter only appears once per
-     * Remote Config template. An ungrouped parameter appears at the top level, whereas a
-     * parameter organized within a group appears within its group's map of parameters.
-     */
-    parameters: { [key: string]: RemoteConfigParameter };
-  }
-
-  /**
-   * Interface representing a Remote Config condition.
-   * A condition targets a specific group of users. A list of these conditions make up
-   * part of a Remote Config template.
-   */
-  interface RemoteConfigCondition {
-
-    /**
-     * A non-empty and unique name of this condition.
-     */
-    name: string;
-
-    /**
-     * The logic of this condition.
-     * See the documentation on
-     * {@link https://firebase.google.com/docs/remote-config/condition-reference condition expressions}
-     * for the expected syntax of this field.
-     */
-    expression: string;
-
-    /**
-     * The color associated with this condition for display purposes in the Firebase Console.
-     * Not specifying this value results in the console picking an arbitrary color to associate
-     * with the condition.
-     */
-    tagColor?: TagColor;
-  }
-
-  /**
-   * Interface representing an explicit parameter value.
-   */
-  interface ExplicitParameterValue {
-    /**
-     * The `string` value that the parameter is set to.
-     */
-    value: string;
-  }
-
-  /**
-   * Interface representing an in-app-default value.
-   */
-  interface InAppDefaultValue {
-    /**
-     * If `true`, the parameter is omitted from the parameter values returned to a client.
-     */
-    useInAppDefault: boolean;
-  }
-
-  /**
-   * Type representing a Remote Config parameter value.
-   * A `RemoteConfigParameterValue` could be either an `ExplicitParameterValue` or
-   * an `InAppDefaultValue`.
-   */
-  type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;
-
-  /**
-   * Interface representing a Remote Config template version.
-   * Output only, except for the version description. Contains metadata about a particular
-   * version of the Remote Config template. All fields are set at the time the specified Remote
-   * Config template is published. A version's description field may be specified in
-   * `publishTemplate` calls.
-   */
-  export interface Version {
-    /**
-     * The version number of a Remote Config template.
-     */
-    versionNumber?: string;
-
-    /**
-     * The timestamp of when this version of the Remote Config template was written to the
-     * Remote Config backend.
-     */
-    updateTime?: string;
-
-    /**
-     * The origin of the template update action.
-     */
-    updateOrigin?: ('REMOTE_CONFIG_UPDATE_ORIGIN_UNSPECIFIED' | 'CONSOLE' |
-      'REST_API' | 'ADMIN_SDK_NODE');
-
-    /**
-     * The type of the template update action.
-     */
-    updateType?: ('REMOTE_CONFIG_UPDATE_TYPE_UNSPECIFIED' |
-      'INCREMENTAL_UPDATE' | 'FORCED_UPDATE' | 'ROLLBACK');
-
-    /**
-     * Aggregation of all metadata fields about the account that performed the update.
-     */
-    updateUser?: RemoteConfigUser;
-
-    /**
-     * The user-provided description of the corresponding Remote Config template.
-     */
-    description?: string;
-
-    /**
-     * The version number of the Remote Config template that has become the current version
-     * due to a rollback. Only present if this version is the result of a rollback.
-     */
-    rollbackSource?: string;
-
-    /**
-     * Indicates whether this Remote Config template was published before version history was
-     * supported.
-     */
-    isLegacy?: boolean;
-  }
-
-  /** Interface representing a list of Remote Config template versions. */
-  export interface ListVersionsResult {
-    /**
-     * A list of version metadata objects, sorted in reverse chronological order.
-     */
-    versions: Version[];
-
-    /**
-     * Token to retrieve the next page of results, or empty if there are no more results
-     * in the list.
-     */
-    nextPageToken?: string;
-  }
-
-  /** Interface representing options for Remote Config list versions operation. */
-  export interface ListVersionsOptions {
-    /**
-     * The maximum number of items to return per page.
-     */
-    pageSize?: number;
-
-    /**
-     * The `nextPageToken` value returned from a previous list versions request, if any.
-     */
-    pageToken?: string;
-
-    /** 
-     * Specifies the newest version number to include in the results.
-     * If specified, must be greater than zero. Defaults to the newest version.
-     */
-    endVersionNumber?: string | number;
-
-    /**
-     * Specifies the earliest update time to include in the results. Any entries updated before this
-     * time are omitted.
-     */
-    startTime?: Date | string;
-
-    /**
-     * Specifies the latest update time to include in the results. Any entries updated on or after
-     * this time are omitted.
-     */
-    endTime?: Date | string;
-  }
-
-  /** Interface representing a Remote Config user.*/
-  export interface RemoteConfigUser {
-    /**
-     * Email address. Output only.
-     */
-    email: string;
-
-    /**
-     * Display name. Output only.
-     */
-    name?: string;
-
-    /**
-     * Image URL. Output only.
-     */
-    imageUrl?: string;
-  }
-
-  /**
-   * The Firebase `RemoteConfig` service interface.
-   *
-   * Do not call this constructor directly. Instead, use
-   * [`admin.remoteConfig()`](admin.remoteConfig#remoteConfig).
-   */
-  interface RemoteConfig {
-    app: _admin.app.App;
-
-    /**
-     * Gets the current active version of the {@link admin.remoteConfig.RemoteConfigTemplate
-     * `RemoteConfigTemplate`} of the project.
-     *
-     * @return A promise that fulfills with a `RemoteConfigTemplate`.
-     */
-    getTemplate(): Promise<RemoteConfigTemplate>;
-
-    /**
-     * Gets the requested version of the {@link admin.remoteConfig.RemoteConfigTemplate
-     * `RemoteConfigTemplate`} of the project.
-     * 
-     * @param versionNumber Version number of the Remote Config template to look up.
-     * 
-     * @return A promise that fulfills with a `RemoteConfigTemplate`.
-     */
-    getTemplateAtVersion(versionNumber: number | string): Promise<RemoteConfigTemplate>;
-
-    /**
-     * Validates a {@link admin.remoteConfig.RemoteConfigTemplate `RemoteConfigTemplate`}.
-     *
-     * @param template The Remote Config template to be validated.
-     * @returns A promise that fulfills with the validated `RemoteConfigTemplate`.
-     */
-    validateTemplate(template: RemoteConfigTemplate): Promise<RemoteConfigTemplate>;
-
-    /**
-     * Publishes a Remote Config template.
-     *
-     * @param template The Remote Config template to be published.
-     * @param options Optional options object when publishing a Remote Config template:
-     *    - {boolean} `force` Setting this to `true` forces the Remote Config template to
-     *      be updated and circumvent the ETag. This approach is not recommended
-     *      because it risks causing the loss of updates to your Remote Config
-     *      template if multiple clients are updating the Remote Config template.
-     *      See {@link https://firebase.google.com/docs/remote-config/use-config-rest#etag_usage_and_forced_updates
-     *      ETag usage and forced updates}.
-     *
-     * @return A Promise that fulfills with the published `RemoteConfigTemplate`.
-     */
-    publishTemplate(template: RemoteConfigTemplate, options?: { force: boolean }): Promise<RemoteConfigTemplate>;
-
-    /**
-    * Rolls back a project's published Remote Config template to the specified version.
-    * A rollback is equivalent to getting a previously published Remote Config
-    * template and re-publishing it using a force update.
-    * 
-    * @param versionNumber The version number of the Remote Config template to roll back to.
-    *    The specified version number must be lower than the current version number, and not have
-    *    been deleted due to staleness. Only the last 300 versions are stored.
-    *    All versions that correspond to non-active Remote Config templates (that is, all except the
-    *    template that is being fetched by clients) are also deleted if they are more than 90 days old.
-    * @return A promise that fulfills with the published `RemoteConfigTemplate`.
-    */
-    rollback(versionNumber: string | number): Promise<RemoteConfigTemplate>;
-
-    /**
-    * Gets a list of Remote Config template versions that have been published, sorted in reverse 
-    * chronological order. Only the last 300 versions are stored.
-    * All versions that correspond to non-active Remote Config templates (that is, all except the 
-    * template that is being fetched by clients) are also deleted if they are more than 90 days old.
-    * 
-    * @param options Optional {@link admin.remoteConfig.ListVersionsOptions `ListVersionsOptions`}
-    *    object for getting a list of template versions.
-    * @return A promise that fulfills with a `ListVersionsResult`.
-    */
-    listVersions(options?: ListVersionsOptions): Promise<ListVersionsResult>;
-
-    /**
-     * Creates and returns a new Remote Config template from a JSON string.
-     *
-     * @param json The JSON string to populate a Remote Config template.
-     *
-     * @return A new template instance.
-     */
-    createTemplateFromJSON(json: string): RemoteConfigTemplate;
-  }
-}

package/lib/security-rules.d.ts

@@ -1,192 +0,0 @@
-/*! firebase-admin v9.3.0 */
-import * as _admin from './index.d';
-
-export namespace admin.securityRules {
-  /**
-   * A source file containing some Firebase security rules. The content includes raw
-   * source code including text formatting, indentation and comments. Use the
-   * [`securityRules.createRulesFileFromSource()`](admin.securityRules.SecurityRules#createRulesFileFromSource)
-   * method to create new instances of this type.
-   */
-  interface RulesFile {
-    readonly name: string;
-    readonly content: string;
-  }
-
-  /**
-   * Required metadata associated with a ruleset.
-   */
-  interface RulesetMetadata {
-    /**
-     * Name of the `Ruleset` as a short string. This can be directly passed into APIs
-     * like [`securityRules.getRuleset()`](admin.securityRules.SecurityRules#getRuleset)
-     * and [`securityRules.deleteRuleset()`](admin.securityRules.SecurityRules#deleteRuleset).
-     */
-    readonly name: string;
-
-    /**
-     * Creation time of the `Ruleset` as a UTC timestamp string.
-     */
-    readonly createTime: string;
-  }
-
-  /**
-   * A set of Firebase security rules.
-   */
-  interface Ruleset extends RulesetMetadata {
-    readonly source: admin.securityRules.RulesFile[];
-  }
-
-  interface RulesetMetadataList {
-    /**
-     * A batch of ruleset metadata.
-     */
-    readonly rulesets: admin.securityRules.RulesetMetadata[];
-
-    /**
-     * The next page token if available. This is needed to retrieve the next batch.
-     */
-    readonly nextPageToken?: string;
-  }
-
-  /**
-   * The Firebase `SecurityRules` service interface.
-   *
-   * Do not call this constructor directly. Instead, use
-   * [`admin.securityRules()`](admin.securityRules#securityRules).
-   */
-  interface SecurityRules {
-    app: _admin.app.App;
-
-    /**
-     * Creates a {@link admin.securityRules.RulesFile `RuleFile`} with the given name
-     * and source. Throws an error if any of the arguments are invalid. This is a local
-     * operation, and does not involve any network API calls.
-     *
-     * @example
-     * ```javascript
-     * const source = '// Some rules source';
-     * const rulesFile = admin.securityRules().createRulesFileFromSource(
-     *   'firestore.rules', source);
-     * ```
-     *
-     * @param name Name to assign to the rules file. This is usually a short file name that
-     *   helps identify the file in a ruleset.
-     * @param source Contents of the rules file.
-     * @return A new rules file instance.
-     */
-    createRulesFileFromSource(name: string, source: string | Buffer): admin.securityRules.RulesFile;
-
-    /**
-     * Creates a new {@link admin.securityRules.Ruleset `Ruleset`} from the given
-     * {@link admin.securityRules.RulesFile `RuleFile`}.
-     *
-     * @param file Rules file to include in the new `Ruleset`.
-     * @returns A promise that fulfills with the newly created `Ruleset`.
-     */
-    createRuleset(file: admin.securityRules.RulesFile): Promise<admin.securityRules.Ruleset>;
-
-    /**
-     * Gets the {@link admin.securityRules.Ruleset `Ruleset`} identified by the given
-     * name. The input name should be the short name string without the project ID
-     * prefix. For example, to retrieve the `projects/project-id/rulesets/my-ruleset`,
-     * pass the short name "my-ruleset". Rejects with a `not-found` error if the
-     * specified `Ruleset` cannot be found.
-     *
-     * @param name Name of the `Ruleset` to retrieve.
-     * @return A promise that fulfills with the specified `Ruleset`.
-     */
-    getRuleset(name: string): Promise<admin.securityRules.Ruleset>;
-
-    /**
-     * Deletes the {@link admin.securityRules.Ruleset `Ruleset`} identified by the given
-     * name. The input name should be the short name string without the project ID
-     * prefix. For example, to delete the `projects/project-id/rulesets/my-ruleset`,
-     * pass the  short name "my-ruleset". Rejects with a `not-found` error if the
-     * specified `Ruleset` cannot be found.
-     *
-     * @param name Name of the `Ruleset` to delete.
-     * @return A promise that fulfills when the `Ruleset` is deleted.
-     */
-    deleteRuleset(name: string): Promise<void>;
-
-    /**
-     * Retrieves a page of ruleset metadata.
-     *
-     * @param pageSize The page size, 100 if undefined. This is also the maximum allowed
-     *   limit.
-     * @param nextPageToken The next page token. If not specified, returns rulesets
-     *   starting without any offset.
-     * @return A promise that fulfills with a page of rulesets.
-     */
-    listRulesetMetadata(
-      pageSize?: number, nextPageToken?: string): Promise<admin.securityRules.RulesetMetadataList>;
-
-    /**
-     * Gets the {@link admin.securityRules.Ruleset `Ruleset`} currently applied to
-     * Cloud Firestore. Rejects with a `not-found` error if no ruleset is applied
-     * on Firestore.
-     *
-     * @return A promise that fulfills with the Firestore ruleset.
-     */
-    getFirestoreRuleset(): Promise<admin.securityRules.Ruleset>;
-
-    /**
-     * Creates a new {@link admin.securityRules.Ruleset `Ruleset`} from the given
-     * source, and applies it to Cloud Firestore.
-     *
-     * @param source Rules source to apply.
-     * @return A promise that fulfills when the ruleset is created and released.
-     */
-    releaseFirestoreRulesetFromSource(source: string | Buffer): Promise<admin.securityRules.Ruleset>;
-
-    /**
-     * Applies the specified {@link admin.securityRules.Ruleset `Ruleset`} ruleset
-     * to Cloud Firestore.
-     *
-     * @param ruleset Name of the ruleset to apply or a `RulesetMetadata` object
-     *   containing the name.
-     * @return A promise that fulfills when the ruleset is released.
-     */
-    releaseFirestoreRuleset(ruleset: string | admin.securityRules.RulesetMetadata): Promise<void>;
-
-    /**
-     * Gets the {@link admin.securityRules.Ruleset `Ruleset`} currently applied to a
-     * Cloud Storage bucket. Rejects with a `not-found` error if no ruleset is applied
-     * on the bucket.
-     *
-     * @param bucket Optional name of the Cloud Storage bucket to be retrieved. If not
-     *   specified, retrieves the ruleset applied on the default bucket configured via
-     *   `AppOptions`.
-     * @return A promise that fulfills with the Cloud Storage ruleset.
-     */
-    getStorageRuleset(bucket?: string): Promise<admin.securityRules.Ruleset>;
-
-    /**
-     * Creates a new {@link admin.securityRules.Ruleset `Ruleset`} from the given
-     * source, and applies it to a Cloud Storage bucket.
-     *
-     * @param source Rules source to apply.
-     * @param bucket Optional name of the Cloud Storage bucket to apply the rules on. If
-     *   not specified, applies the ruleset on the default bucket configured via
-     *   {@link admin.AppOptions `AppOptions`}.
-     * @return A promise that fulfills when the ruleset is created and released.
-     */
-    releaseStorageRulesetFromSource(
-      source: string | Buffer, bucket?: string): Promise<admin.securityRules.Ruleset>;
-
-    /**
-     * Applies the specified {@link admin.securityRules.Ruleset `Ruleset`} ruleset
-     * to a Cloud Storage bucket.
-     *
-     * @param ruleset Name of the ruleset to apply or a `RulesetMetadata` object
-     *   containing the name.
-     * @param bucket Optional name of the Cloud Storage bucket to apply the rules on. If
-     *   not specified, applies the ruleset on the default bucket configured via
-     *   {@link admin.AppOptions `AppOptions`}.
-     * @return A promise that fulfills when the ruleset is released.
-     */
-    releaseStorageRuleset(
-      ruleset: string | admin.securityRules.RulesetMetadata, bucket?: string): Promise<void>;
-  }
-}

package/lib/storage.d.ts

@@ -1,40 +0,0 @@
-/*! firebase-admin v9.3.0 */
-/*!
- * Copyright 2020 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 { Bucket } from '@google-cloud/storage';
-import * as _admin from './index.d';
-
-export namespace admin.storage {
-
-  /**
-   * The default `Storage` service if no
-   * app is provided or the `Storage` service associated with the provided
-   * app.
-   */
-  export interface Storage {
-    /**
-     * Optional app whose `Storage` service to
-     * return. If not provided, the default `Storage` service will be returned.
-     */
-    app: _admin.app.App;
-    /**
-     * @returns A [Bucket](https://cloud.google.com/nodejs/docs/reference/storage/latest/Bucket)
-     * instance as defined in the `@google-cloud/storage` package.
-     */
-    bucket(name?: string): Bucket;
-  }
-}