firebase-admin 9.12.0 → 10.0.1

package/lib/security-rules/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.12.0 */
+/*! firebase-admin v10.0.1 */
 /*!
  * Copyright 2020 Google Inc.
  *
@@ -14,203 +14,37 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/// <reference types="node" />
-import { app } from '../firebase-namespace-api';
 /**
- * Gets the {@link securityRules.SecurityRules
- * `SecurityRules`} service for the default app or a given app.
+ * Security Rules for Cloud Firestore and Cloud Storage.
+ *
+ * @packageDocumentation
+ */
+import { App } from '../app';
+import { SecurityRules } from './security-rules';
+export { RulesFile, Ruleset, RulesetMetadata, RulesetMetadataList, SecurityRules, } from './security-rules';
+/**
+ * Gets the {@link SecurityRules} service for the default app or a given app.
  *
  * `admin.securityRules()` can be called with no arguments to access the
- * default app's {@link securityRules.SecurityRules
- * `SecurityRules`} service, or as `admin.securityRules(app)` to access
- * the {@link securityRules.SecurityRules `SecurityRules`}
- * service associated with a specific app.
+ * default app's `SecurityRules` service, or as `admin.securityRules(app)` to access
+ * the `SecurityRules` service associated with a specific app.
  *
  * @example
  * ```javascript
  * // Get the SecurityRules service for the default app
- * var defaultSecurityRules = admin.securityRules();
+ * const defaultSecurityRules = getSecurityRules();
  * ```
  *
  * @example
- *  ```javascript
+ * ```javascript
  * // Get the SecurityRules service for a given app
- * var otherSecurityRules = admin.securityRules(otherApp);
+ * const otherSecurityRules = getSecurityRules(otherApp);
  * ```
  *
- * @param app Optional app to return the `SecurityRules` service
+ * @param app - Optional app to return the `SecurityRules` service
  *     for. If not provided, the default `SecurityRules` service
  *     is returned.
- * @return The default `SecurityRules` service if no app is provided, or the
+ * @returns The default `SecurityRules` service if no app is provided, or the
  *   `SecurityRules` service associated with the provided app.
  */
-export declare function securityRules(app?: app.App): securityRules.SecurityRules;
-export declare namespace 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()`](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 {@link securityRules.SecurityRules.getRuleset `securityRules.getRuleset()`}
-         * and {@link securityRules.SecurityRules.deleteRuleset `securityRules.deleteRuleset()`}.
-         */
-        readonly name: string;
-        /**
-         * Creation time of the `Ruleset` as a UTC timestamp string.
-         */
-        readonly createTime: string;
-    }
-    /**
-     * A page of ruleset metadata.
-     */
-    interface RulesetMetadataList {
-        /**
-         * A batch of ruleset metadata.
-         */
-        readonly rulesets: RulesetMetadata[];
-        /**
-         * The next page token if available. This is needed to retrieve the next batch.
-         */
-        readonly nextPageToken?: string;
-    }
-    /**
-     * A set of Firebase security rules.
-     */
-    interface Ruleset extends RulesetMetadata {
-        readonly source: RulesFile[];
-    }
-    /**
-     * The Firebase `SecurityRules` service interface.
-     */
-    interface SecurityRules {
-        app: app.App;
-        /**
-         * Creates a {@link 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): RulesFile;
-        /**
-         * Creates a new {@link securityRules.Ruleset `Ruleset`} from the given
-         * {@link 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: RulesFile): Promise<Ruleset>;
-        /**
-         * Gets the {@link 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<Ruleset>;
-        /**
-         * Deletes the {@link 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<RulesetMetadataList>;
-        /**
-         * Gets the {@link 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<Ruleset>;
-        /**
-         * Creates a new {@link 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<Ruleset>;
-        /**
-         * Applies the specified {@link 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 | RulesetMetadata): Promise<void>;
-        /**
-         * Gets the {@link 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<Ruleset>;
-        /**
-         * Creates a new {@link 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 AppOptions `AppOptions`}.
-         * @return A promise that fulfills when the ruleset is created and released.
-         */
-        releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;
-        /**
-         * Applies the specified {@link 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 AppOptions `AppOptions`}.
-         * @return A promise that fulfills when the ruleset is released.
-         */
-        releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;
-    }
-}
+export declare function getSecurityRules(app?: App): SecurityRules;

package/lib/security-rules/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.12.0 */
+/*! firebase-admin v10.0.1 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.
@@ -16,3 +16,48 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSecurityRules = void 0;
+/**
+ * Security Rules for Cloud Firestore and Cloud Storage.
+ *
+ * @packageDocumentation
+ */
+var app_1 = require("../app");
+var security_rules_1 = require("./security-rules");
+var security_rules_2 = require("./security-rules");
+Object.defineProperty(exports, "Ruleset", { enumerable: true, get: function () { return security_rules_2.Ruleset; } });
+Object.defineProperty(exports, "RulesetMetadataList", { enumerable: true, get: function () { return security_rules_2.RulesetMetadataList; } });
+Object.defineProperty(exports, "SecurityRules", { enumerable: true, get: function () { return security_rules_2.SecurityRules; } });
+/**
+ * Gets the {@link SecurityRules} service for the default app or a given app.
+ *
+ * `admin.securityRules()` can be called with no arguments to access the
+ * default app's `SecurityRules` service, or as `admin.securityRules(app)` to access
+ * the `SecurityRules` service associated with a specific app.
+ *
+ * @example
+ * ```javascript
+ * // Get the SecurityRules service for the default app
+ * const defaultSecurityRules = getSecurityRules();
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Get the SecurityRules service for a given app
+ * const otherSecurityRules = getSecurityRules(otherApp);
+ * ```
+ *
+ * @param app - Optional app to return the `SecurityRules` service
+ *     for. If not provided, the default `SecurityRules` service
+ *     is returned.
+ * @returns The default `SecurityRules` service if no app is provided, or the
+ *   `SecurityRules` service associated with the provided app.
+ */
+function getSecurityRules(app) {
+    if (typeof app === 'undefined') {
+        app = app_1.getApp();
+    }
+    var firebaseApp = app;
+    return firebaseApp.getOrInitService('securityRules', function (app) { return new security_rules_1.SecurityRules(app); });
+}
+exports.getSecurityRules = getSecurityRules;

package/lib/security-rules/security-rules-api-client-internal.d.ts

@@ -0,0 +1,73 @@
+/*! firebase-admin v10.0.1 */
+/*!
+ * Copyright 2019 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';
+export interface Release {
+    readonly name: string;
+    readonly rulesetName: string;
+    readonly createTime?: string;
+    readonly updateTime?: string;
+}
+export interface RulesetContent {
+    readonly source: {
+        readonly files: Array<{
+            name: string;
+            content: string;
+        }>;
+    };
+}
+export interface RulesetResponse extends RulesetContent {
+    readonly name: string;
+    readonly createTime: string;
+}
+export interface ListRulesetsResponse {
+    readonly rulesets: Array<{
+        name: string;
+        createTime: string;
+    }>;
+    readonly nextPageToken?: string;
+}
+/**
+ * Class that facilitates sending requests to the Firebase security rules backend API.
+ *
+ * @private
+ */
+export declare class SecurityRulesApiClient {
+    private readonly app;
+    private readonly httpClient;
+    private projectIdPrefix?;
+    constructor(app: App);
+    getRuleset(name: string): Promise<RulesetResponse>;
+    createRuleset(ruleset: RulesetContent): Promise<RulesetResponse>;
+    deleteRuleset(name: string): Promise<void>;
+    listRulesets(pageSize?: number, pageToken?: string): Promise<ListRulesetsResponse>;
+    getRelease(name: string): Promise<Release>;
+    updateRelease(name: string, rulesetName: string): Promise<Release>;
+    private getUrl;
+    private getProjectIdPrefix;
+    /**
+     * Gets the specified resource from the rules API. Resource names must be the short names without project
+     * ID prefix (e.g. `rulesets/ruleset-name`).
+     *
+     * @param {string} name Full qualified name of the resource to get.
+     * @returns {Promise<T>} A promise that fulfills with the resource.
+     */
+    private getResource;
+    private getReleaseDescription;
+    private getRulesetName;
+    private sendRequest;
+    private toFirebaseError;
+}

package/lib/security-rules/security-rules-api-client-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.12.0 */
+/*! firebase-admin v10.0.1 */
 "use strict";
 /*!
  * Copyright 2019 Google Inc.

package/lib/security-rules/security-rules-internal.d.ts

@@ -0,0 +1,21 @@
+/*! firebase-admin v10.0.1 */
+/*!
+ * Copyright 2019 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 { PrefixedFirebaseError } from '../utils/error';
+export declare type SecurityRulesErrorCode = 'already-exists' | 'authentication-error' | 'internal-error' | 'invalid-argument' | 'invalid-server-response' | 'not-found' | 'resource-exhausted' | 'service-unavailable' | 'unknown-error';
+export declare class FirebaseSecurityRulesError extends PrefixedFirebaseError {
+    constructor(code: SecurityRulesErrorCode, message: string);
+}

package/lib/security-rules/security-rules-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.12.0 */
+/*! firebase-admin v10.0.1 */
 "use strict";
 /*!
  * Copyright 2019 Google Inc.

package/lib/security-rules/security-rules-namespace.d.ts

@@ -0,0 +1,69 @@
+/*! firebase-admin v10.0.1 */
+/*!
+ * 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.
+ */
+import { App } from '../app';
+import { RulesFile as TRulesFile, Ruleset as TRuleset, RulesetMetadata as TRulesetMetadata, RulesetMetadataList as TRulesetMetadataList, SecurityRules as TSecurityRules } from './security-rules';
+/**
+ * Gets the {@link firebase-admin.security-rules#SecurityRules} service for the default
+ * app or a given app.
+ *
+ * `admin.securityRules()` can be called with no arguments to access the
+ * default app's {@link firebase-admin.security-rules#SecurityRules}
+ * service, or as `admin.securityRules(app)` to access
+ * the {@link firebase-admin.security-rules#SecurityRules}
+ * service associated with a specific app.
+ *
+ * @example
+ * ```javascript
+ * // Get the SecurityRules service for the default app
+ * var defaultSecurityRules = admin.securityRules();
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Get the SecurityRules service for a given app
+ * var otherSecurityRules = admin.securityRules(otherApp);
+ * ```
+ *
+ * @param app - Optional app to return the `SecurityRules` service
+ *     for. If not provided, the default `SecurityRules` service
+ *     is returned.
+ * @returns The default `SecurityRules` service if no app is provided, or the
+ *   `SecurityRules` service associated with the provided app.
+ */
+export declare function securityRules(app?: App): securityRules.SecurityRules;
+export declare namespace securityRules {
+    /**
+     * Type alias to {@link firebase-admin.security-rules#RulesFile}.
+     */
+    type RulesFile = TRulesFile;
+    /**
+     * Type alias to {@link firebase-admin.security-rules#Ruleset}.
+     */
+    type Ruleset = TRuleset;
+    /**
+     * Type alias to {@link firebase-admin.security-rules#RulesetMetadata}.
+     */
+    type RulesetMetadata = TRulesetMetadata;
+    /**
+     * Type alias to {@link firebase-admin.security-rules#RulesetMetadataList}.
+     */
+    type RulesetMetadataList = TRulesetMetadataList;
+    /**
+     * Type alias to {@link firebase-admin.security-rules#SecurityRules}.
+     */
+    type SecurityRules = TSecurityRules;
+}

package/lib/security-rules/security-rules-namespace.js

@@ -0,0 +1,18 @@
+/*! firebase-admin v10.0.1 */
+"use strict";
+/*!
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/security-rules/security-rules.d.ts

@@ -0,0 +1,196 @@
+/*! firebase-admin v10.0.1 */
+/*!
+ * Copyright 2019 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.
+ */
+/// <reference types="node" />
+import { App } from '../app';
+/**
+ * A source file containing some Firebase security rules. The content includes raw
+ * source code including text formatting, indentation and comments. Use the
+ * {@link SecurityRules.createRulesFileFromSource} method to create new instances of this type.
+ */
+export interface RulesFile {
+    readonly name: string;
+    readonly content: string;
+}
+/**
+ * Required metadata associated with a ruleset.
+ */
+export interface RulesetMetadata {
+    /**
+     * Name of the `Ruleset` as a short string. This can be directly passed into APIs
+     * like {@link SecurityRules.getRuleset} and {@link SecurityRules.deleteRuleset}.
+     */
+    readonly name: string;
+    /**
+     * Creation time of the `Ruleset` as a UTC timestamp string.
+     */
+    readonly createTime: string;
+}
+/**
+ * A page of ruleset metadata.
+ */
+export declare class RulesetMetadataList {
+    /**
+     * A batch of ruleset metadata.
+     */
+    readonly rulesets: RulesetMetadata[];
+    /**
+     * The next page token if available. This is needed to retrieve the next batch.
+     */
+    readonly nextPageToken?: string;
+}
+/**
+ * A set of Firebase security rules.
+ */
+export declare class Ruleset implements RulesetMetadata {
+    /**
+     * {@inheritdoc RulesetMetadata.name}
+     */
+    readonly name: string;
+    /**
+     * {@inheritdoc RulesetMetadata.createTime}
+     */
+    readonly createTime: string;
+    readonly source: RulesFile[];
+}
+/**
+ * The Firebase `SecurityRules` service interface.
+ */
+export declare class SecurityRules {
+    readonly app: App;
+    private static readonly CLOUD_FIRESTORE;
+    private static readonly FIREBASE_STORAGE;
+    private readonly client;
+    /**
+     * Gets the {@link 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.
+     * @returns A promise that fulfills with the specified `Ruleset`.
+     */
+    getRuleset(name: string): Promise<Ruleset>;
+    /**
+     * Gets the {@link Ruleset} currently applied to
+     * Cloud Firestore. Rejects with a `not-found` error if no ruleset is applied
+     * on Firestore.
+     *
+     * @returns A promise that fulfills with the Firestore ruleset.
+     */
+    getFirestoreRuleset(): Promise<Ruleset>;
+    /**
+     * Creates a new {@link Ruleset} from the given
+     * source, and applies it to Cloud Firestore.
+     *
+     * @param source - Rules source to apply.
+     * @returns A promise that fulfills when the ruleset is created and released.
+     */
+    releaseFirestoreRulesetFromSource(source: string | Buffer): Promise<Ruleset>;
+    /**
+     * Applies the specified {@link Ruleset} ruleset
+     * to Cloud Firestore.
+     *
+     * @param ruleset - Name of the ruleset to apply or a `RulesetMetadata` object
+     *   containing the name.
+     * @returns A promise that fulfills when the ruleset is released.
+     */
+    releaseFirestoreRuleset(ruleset: string | RulesetMetadata): Promise<void>;
+    /**
+     * Gets the {@link 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`.
+     * @returns A promise that fulfills with the Cloud Storage ruleset.
+     */
+    getStorageRuleset(bucket?: string): Promise<Ruleset>;
+    /**
+     * Creates a new {@link 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 firebase-admin.app#AppOptions}.
+     * @returns A promise that fulfills when the ruleset is created and released.
+     */
+    releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;
+    /**
+     * Applies the specified {@link 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 firebase-admin.app#AppOptions}.
+     * @returns A promise that fulfills when the ruleset is released.
+     */
+    releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;
+    /**
+     * Creates a {@link RulesFile} 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.
+     * @returns A new rules file instance.
+     */
+    createRulesFileFromSource(name: string, source: string | Buffer): RulesFile;
+    /**
+     * Creates a new {@link Ruleset} from the given {@link RulesFile}.
+     *
+     * @param file - Rules file to include in the new `Ruleset`.
+     * @returns A promise that fulfills with the newly created `Ruleset`.
+     */
+    createRuleset(file: RulesFile): Promise<Ruleset>;
+    /**
+     * Deletes the {@link 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.
+     * @returns 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.
+     * @returns A promise that fulfills with a page of rulesets.
+     */
+    listRulesetMetadata(pageSize?: number, nextPageToken?: string): Promise<RulesetMetadataList>;
+    private getRulesetForRelease;
+    private releaseRuleset;
+    private getBucketName;
+}