firebase-tools 14.12.0 → 14.13.0

package/lib/deploy/functions/release/fabricator.js

@@ -136,6 +136,11 @@ class Fabricator {
         else if (endpoint.platform === "gcfv2") {
             await this.createV2Function(endpoint, scraperV2);
         }
+        else if (endpoint.platform === "run") {
+            throw new error_1.FirebaseError("Creating new Cloud Run functions is not supported yet.", {
+                exit: 1,
+            });
+        }
         else {
             (0, functional_1.assertExhaustive)(endpoint.platform);
         }
@@ -154,6 +159,9 @@ class Fabricator {
         else if (update.endpoint.platform === "gcfv2") {
             await this.updateV2Function(update.endpoint, scraperV2);
         }
+        else if (update.endpoint.platform === "run") {
+            throw new error_1.FirebaseError("Updating Cloud Run functions is not supported yet.", { exit: 1 });
+        }
         else {
             (0, functional_1.assertExhaustive)(update.endpoint.platform);
         }
@@ -162,11 +170,15 @@ class Fabricator {
     async deleteEndpoint(endpoint) {
         await this.deleteTrigger(endpoint);
         if (endpoint.platform === "gcfv1") {
-            await this.deleteV1Function(endpoint);
+            return this.deleteV1Function(endpoint);
         }
-        else {
-            await this.deleteV2Function(endpoint);
+        else if (endpoint.platform === "gcfv2") {
+            return this.deleteV2Function(endpoint);
         }
+        else if (endpoint.platform === "run") {
+            throw new error_1.FirebaseError("Deleting Cloud Run functions is not supported yet.", { exit: 1 });
+        }
+        (0, functional_1.assertExhaustive)(endpoint.platform);
     }
     async createV1Function(endpoint, scraper) {
         var _a, _b;
@@ -471,6 +483,11 @@ class Fabricator {
             .catch(rethrowAs(endpoint, "set concurrency"));
     }
     async setTrigger(endpoint) {
+        if (endpoint.platform === "run") {
+            throw new error_1.FirebaseError("Setting triggers for Cloud Run functions is not supported yet.", {
+                exit: 1,
+            });
+        }
         if (backend.isScheduleTriggered(endpoint)) {
             if (endpoint.platform === "gcfv1") {
                 await this.upsertScheduleV1(endpoint);
@@ -490,6 +507,11 @@ class Fabricator {
         }
     }
     async deleteTrigger(endpoint) {
+        if (endpoint.platform === "run") {
+            throw new error_1.FirebaseError("Deleting triggers for Cloud Run functions is not supported yet.", {
+                exit: 1,
+            });
+        }
         if (backend.isScheduleTriggered(endpoint)) {
             if (endpoint.platform === "gcfv1") {
                 await this.deleteScheduleV1(endpoint);

package/lib/emulator/controller.js

@@ -116,7 +116,7 @@ function shouldStart(options, name) {
             return true;
         }
         catch (err) {
-            emulatorLogger_1.EmulatorLogger.forEmulator(types_1.Emulators.FUNCTIONS).logLabeled("WARN", "functions", `The functions emulator is configured but there is no functions source directory. Have you run ${clc.bold("firebase init functions")}?`);
+            emulatorLogger_1.EmulatorLogger.forEmulator(types_1.Emulators.FUNCTIONS).logLabeled("ERROR", "functions", `Failed to start Functions emulator: ${err.message}`);
             return false;
         }
     }
@@ -348,6 +348,7 @@ async function startAll(options, showUI = true, runningTestScript = false) {
                 functionsDir,
                 runtime,
                 codebase: cfg.codebase,
+                prefix: cfg.prefix,
                 env: Object.assign({}, options.extDevEnv),
                 secretEnv: [],
                 predefinedTriggers: options.extDevTriggers,

package/lib/emulator/downloadableEmulatorInfo.json

@@ -54,28 +54,28 @@
     },
     "dataconnect": {
         "darwin": {
-            "version": "2.11.0",
-            "expectedSize": 29234016,
-            "expectedChecksum": "96da48708b8210f0d3d97099d777b322",
-            "expectedChecksumSHA256": "10fe334f2c4145e4c9d27bc442bdc92b1252164d3daac47bb7555da42b6d7050",
-            "remoteUrl": "https://storage.googleapis.com/firemat-preview-drop/emulator/dataconnect-emulator-macos-v2.11.0",
-            "downloadPathRelativeToCacheDir": "dataconnect-emulator-2.11.0"
+            "version": "2.11.2",
+            "expectedSize": 29447008,
+            "expectedChecksum": "13bc7d3bb0a0bbfe601991361e4413c2",
+            "expectedChecksumSHA256": "e3b029eb461f0fe6f0c825c7a71d42c7a09c2b8ee4fac10c3e187d78fe5083f6",
+            "remoteUrl": "https://storage.googleapis.com/firemat-preview-drop/emulator/dataconnect-emulator-macos-v2.11.2",
+            "downloadPathRelativeToCacheDir": "dataconnect-emulator-2.11.2"
         },
         "win32": {
-            "version": "2.11.0",
-            "expectedSize": 29719040,
-            "expectedChecksum": "df6b221af204a4a21163bcc73367f99e",
-            "expectedChecksumSHA256": "af17c0d873b2b8f1919652c1ad9fd4aed417cd82bc35bbc5cc4a302fc90f9a03",
-            "remoteUrl": "https://storage.googleapis.com/firemat-preview-drop/emulator/dataconnect-emulator-windows-v2.11.0",
-            "downloadPathRelativeToCacheDir": "dataconnect-emulator-2.11.0.exe"
+            "version": "2.11.2",
+            "expectedSize": 29934592,
+            "expectedChecksum": "032a0749781fc338b446d753dd543bf5",
+            "expectedChecksumSHA256": "2d0498b3ef94b4e777d6fc1d526279376caf3842549f39f13a8ca327393bf810",
+            "remoteUrl": "https://storage.googleapis.com/firemat-preview-drop/emulator/dataconnect-emulator-windows-v2.11.2",
+            "downloadPathRelativeToCacheDir": "dataconnect-emulator-2.11.2.exe"
         },
         "linux": {
-            "version": "2.11.0",
-            "expectedSize": 29159608,
-            "expectedChecksum": "38d6161f7e8f06ee89e5dc4094f1a9b6",
-            "expectedChecksumSHA256": "3391efac3570164141b5d7f3e3d48b6426ec9c8cf9eafeabee3fa31678120218",
-            "remoteUrl": "https://storage.googleapis.com/firemat-preview-drop/emulator/dataconnect-emulator-linux-v2.11.0",
-            "downloadPathRelativeToCacheDir": "dataconnect-emulator-2.11.0"
+            "version": "2.11.2",
+            "expectedSize": 29368504,
+            "expectedChecksum": "065a7523f881952040ac678a9a1e9323",
+            "expectedChecksumSHA256": "41ca6561cf77107b5d1d829233844d21c46a5e4bb823c150b1b32591dc2463e0",
+            "remoteUrl": "https://storage.googleapis.com/firemat-preview-drop/emulator/dataconnect-emulator-linux-v2.11.2",
+            "downloadPathRelativeToCacheDir": "dataconnect-emulator-2.11.2"
         }
     }
 }

package/lib/emulator/functionsEmulator.js

@@ -28,8 +28,9 @@ const utils_1 = require("../utils");
 const adminSdkConfig_1 = require("./adminSdkConfig");
 const validate_1 = require("../deploy/functions/validate");
 const secretManager_1 = require("../gcp/secretManager");
-const runtimes = require("../deploy/functions/runtimes");
 const backend = require("../deploy/functions/backend");
+const build = require("../deploy/functions/build");
+const runtimes = require("../deploy/functions/runtimes");
 const functionsEnv = require("../functions/env");
 const v1_1 = require("../functions/events/v1");
 const build_1 = require("../deploy/functions/build");
@@ -82,6 +83,7 @@ class FunctionsEmulator {
         this.blockingFunctionsConfig = {};
         this.staticBackends = [];
         this.dynamicBackends = [];
+        this.watchers = [];
         this.debugMode = false;
         this.staticBackends = args.emulatableBackends;
         emulatorLogger_1.EmulatorLogger.setVerbosity(this.args.verbosity ? emulatorLogger_1.Verbosity[this.args.verbosity] : emulatorLogger_1.Verbosity["DEBUG"]);
@@ -271,6 +273,7 @@ class FunctionsEmulator {
                 ],
                 persistent: true,
             });
+            this.watchers.push(watcher);
             const debouncedLoadTriggers = (0, utils_1.debounce)(() => this.loadTriggers(backend), 1000);
             watcher.on("change", (filePath) => {
                 this.logger.log("DEBUG", `File ${filePath} changed, reloading triggers`);
@@ -292,6 +295,10 @@ class FunctionsEmulator {
         for (const pool of Object.values(this.workerPools)) {
             pool.exit();
         }
+        for (const watcher of this.watchers) {
+            await watcher.close();
+        }
+        this.watchers = [];
         if (this.destroyServer) {
             await this.destroyServer();
         }
@@ -329,6 +336,7 @@ class FunctionsEmulator {
                 await this.args.extensionsEmulator.addDynamicExtensions(emulatableBackend.codebase, discoveredBuild);
                 await this.loadDynamicExtensionBackends();
             }
+            build.applyPrefix(discoveredBuild, emulatableBackend.prefix || "");
             const resolution = await (0, build_1.resolveBackend)({
                 build: discoveredBuild,
                 firebaseConfig: JSON.parse(firebaseConfig),

package/lib/experiments.js

@@ -48,6 +48,10 @@ exports.ALL_EXPERIMENTS = experiments({
         default: true,
         public: true,
     },
+    runfunctions: {
+        shortDescription: "Functions created using the V2 API target Cloud Run Functions (not production ready)",
+        public: false,
+    },
     emulatoruisnapshot: {
         shortDescription: "Load pre-release versions of the emulator UI",
     },

package/lib/extensions/extensionsHelper.js

@@ -7,7 +7,7 @@ var __asyncValues = (this && this.__asyncValues) || function (o) {
     function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.diagnoseAndFixProject = exports.getSourceOrigin = exports.isLocalOrURLPath = exports.isLocalPath = exports.isUrlPath = exports.instanceIdExists = exports.promptForRepeatInstance = exports.promptForOfficialExtension = exports.displayReleaseNotes = exports.getPublisherProjectFromName = exports.createSourceFromLocation = exports.getMissingPublisherError = exports.uploadExtensionVersionFromLocalSource = exports.uploadExtensionVersionFromGitHubSource = exports.unpackExtensionState = exports.getNextVersionByStage = exports.ensureExtensionsPublisherApiEnabled = exports.ensureExtensionsApiEnabled = exports.checkExtensionsApiEnabled = exports.promptForExtensionRoot = exports.promptForValidRepoURI = exports.promptForValidInstanceId = exports.validateSpec = exports.validateCommandLineParams = exports.populateDefaultParams = exports.substituteSecretParams = exports.substituteParams = exports.getFirebaseProjectParams = exports.getDBInstanceFromURL = exports.resourceTypeToNiceName = exports.AUTOPOPULATED_PARAM_PLACEHOLDERS = exports.EXTENSIONS_BUCKET_NAME = exports.URL_REGEX = exports.logPrefix = exports.SourceOrigin = exports.SpecParamType = void 0;
+exports.diagnoseAndFixProject = exports.getSourceOrigin = exports.isLocalOrURLPath = exports.isLocalPath = exports.isUrlPath = exports.instanceIdExists = exports.promptForRepeatInstance = exports.displayReleaseNotes = exports.getPublisherProjectFromName = exports.createSourceFromLocation = exports.getMissingPublisherError = exports.uploadExtensionVersionFromLocalSource = exports.uploadExtensionVersionFromGitHubSource = exports.unpackExtensionState = exports.getNextVersionByStage = exports.ensureExtensionsPublisherApiEnabled = exports.ensureExtensionsApiEnabled = exports.checkExtensionsApiEnabled = exports.promptForExtensionRoot = exports.promptForValidRepoURI = exports.promptForValidInstanceId = exports.validateSpec = exports.validateCommandLineParams = exports.populateDefaultParams = exports.substituteSecretParams = exports.substituteParams = exports.getFirebaseProjectParams = exports.getDBInstanceFromURL = exports.resourceTypeToNiceName = exports.AUTOPOPULATED_PARAM_PLACEHOLDERS = exports.EXTENSIONS_BUCKET_NAME = exports.URL_REGEX = exports.logPrefix = exports.SourceOrigin = exports.SpecParamType = void 0;
 const clc = require("colorette");
 const ora = require("ora");
 const semver = require("semver");
@@ -21,10 +21,8 @@ const unzip_1 = require("./../unzip");
 marked_1.marked.use((0, marked_terminal_1.markedTerminal)());
 const api_1 = require("../api");
 const archiveDirectory_1 = require("../archiveDirectory");
-const utils_1 = require("./utils");
 const functionsConfig_1 = require("../functionsConfig");
 const adminSdkConfig_1 = require("../emulator/adminSdkConfig");
-const resolveSource_1 = require("./resolveSource");
 const error_1 = require("../error");
 const diagnose_1 = require("./diagnose");
 const askUserForParam_1 = require("./askUserForParam");
@@ -37,7 +35,7 @@ const prompt_1 = require("../prompt");
 const refs = require("./refs");
 const localHelper_1 = require("./localHelper");
 const logger_1 = require("../logger");
-const utils_2 = require("../utils");
+const utils_1 = require("../utils");
 const change_log_1 = require("./change-log");
 const getProjectNumber_1 = require("../getProjectNumber");
 const constants_1 = require("../emulator/constants");
@@ -61,7 +59,7 @@ var SourceOrigin;
 exports.logPrefix = "extensions";
 const VALID_LICENSES = ["apache-2.0"];
 exports.URL_REGEX = /^https:/;
-exports.EXTENSIONS_BUCKET_NAME = (0, utils_2.envOverride)("FIREBASE_EXTENSIONS_UPLOAD_BUCKET", "firebase-ext-eap-uploads");
+exports.EXTENSIONS_BUCKET_NAME = (0, utils_1.envOverride)("FIREBASE_EXTENSIONS_UPLOAD_BUCKET", "firebase-ext-eap-uploads");
 const AUTOPOPULATED_PARAM_NAMES = [
     "PROJECT_ID",
     "STORAGE_BUCKET",
@@ -104,7 +102,7 @@ async function getFirebaseProjectParams(projectId, emulatorMode = false) {
             projectNumber = await (0, getProjectNumber_1.getProjectNumber)({ projectId });
         }
         catch (err) {
-            (0, utils_2.logLabeledError)("extensions", `Unable to look up project number for ${projectId}.\n` +
+            (0, utils_1.logLabeledError)("extensions", `Unable to look up project number for ${projectId}.\n` +
                 " If this is a real project, ensure that you are logged in and have access to it.\n" +
                 " If this is a fake project, please use a project ID starting with 'demo-' to skip production calls.\n" +
                 " Continuing with a fake project number - secrets and other features that require production access may behave unexpectedly.");
@@ -810,15 +808,6 @@ function displayReleaseNotes(args) {
     logger_1.logger.info(message);
 }
 exports.displayReleaseNotes = displayReleaseNotes;
-async function promptForOfficialExtension(message) {
-    const officialExts = await (0, resolveSource_1.getExtensionRegistry)(true);
-    return await (0, prompt_1.select)({
-        message,
-        choices: (0, utils_1.convertOfficialExtensionsToList)(officialExts),
-        pageSize: Object.keys(officialExts).length,
-    });
-}
-exports.promptForOfficialExtension = promptForOfficialExtension;
 async function promptForRepeatInstance(projectName, extensionName) {
     const message = `An extension with the ID '${clc.bold(extensionName)}' already exists in the project '${clc.bold(projectName)}'. What would you like to do?`;
     return await (0, prompt_1.select)({

package/lib/extensions/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getResourceRuntime = exports.formatTimestamp = exports.getRandomString = exports.convertOfficialExtensionsToList = exports.convertExtensionOptionToLabeledList = void 0;
+exports.getResourceRuntime = exports.formatTimestamp = exports.getRandomString = exports.convertExtensionOptionToLabeledList = void 0;
 const types_1 = require("./types");
 function convertExtensionOptionToLabeledList(options) {
     return options.map((option) => {
@@ -12,17 +12,6 @@ function convertExtensionOptionToLabeledList(options) {
     });
 }
 exports.convertExtensionOptionToLabeledList = convertExtensionOptionToLabeledList;
-function convertOfficialExtensionsToList(officialExts) {
-    const l = Object.entries(officialExts).map(([key, entry]) => {
-        return {
-            checked: false,
-            value: `${entry.publisher}/${key}`,
-        };
-    });
-    l.sort((a, b) => a.value.localeCompare(b.value));
-    return l;
-}
-exports.convertOfficialExtensionsToList = convertOfficialExtensionsToList;
 function getRandomString(length) {
     const SUFFIX_CHAR_SET = "abcdefghijklmnopqrstuvwxyz0123456789";
     let result = "";

package/lib/firestore/api-sort.js

@@ -8,6 +8,19 @@ const QUERY_SCOPE_SEQUENCE = [
     API.QueryScope.COLLECTION,
     undefined,
 ];
+const API_SCOPE_SEQUENCE = [
+    API.ApiScope.ANY_API,
+    API.ApiScope.DATASTORE_MODE_API,
+    API.ApiScope.MONGODB_COMPATIBLE_API,
+    undefined,
+];
+const DENSITY_SEQUENCE = [
+    API.Density.DENSITY_UNSPECIFIED,
+    API.Density.SPARSE_ALL,
+    API.Density.SPARSE_ANY,
+    API.Density.DENSE,
+    undefined,
+];
 const ORDER_SEQUENCE = [API.Order.ASCENDING, API.Order.DESCENDING, undefined];
 const ARRAY_CONFIG_SEQUENCE = [API.ArrayConfig.CONTAINS, undefined];
 function compareSpecIndex(a, b) {
@@ -17,7 +30,23 @@ function compareSpecIndex(a, b) {
     if (a.queryScope !== b.queryScope) {
         return compareQueryScope(a.queryScope, b.queryScope);
     }
-    return compareArrays(a.fields, b.fields, compareIndexField);
+    let cmp = compareArrays(a.fields, b.fields, compareIndexField);
+    if (cmp !== 0) {
+        return cmp;
+    }
+    cmp = compareApiScope(a.apiScope, b.apiScope);
+    if (cmp !== 0) {
+        return cmp;
+    }
+    cmp = compareDensity(a.density, b.density);
+    if (cmp !== 0) {
+        return cmp;
+    }
+    cmp = compareBoolean(a.multikey, b.multikey);
+    if (cmp !== 0) {
+        return cmp;
+    }
+    return compareBoolean(a.unique, b.unique);
 }
 exports.compareSpecIndex = compareSpecIndex;
 function compareApiIndex(a, b) {
@@ -31,7 +60,23 @@ function compareApiIndex(a, b) {
     if (a.queryScope !== b.queryScope) {
         return compareQueryScope(a.queryScope, b.queryScope);
     }
-    return compareArrays(a.fields, b.fields, compareIndexField);
+    let cmp = compareArrays(a.fields, b.fields, compareIndexField);
+    if (cmp !== 0) {
+        return cmp;
+    }
+    cmp = compareApiScope(a.apiScope, b.apiScope);
+    if (cmp !== 0) {
+        return cmp;
+    }
+    cmp = compareDensity(a.density, b.density);
+    if (cmp !== 0) {
+        return cmp;
+    }
+    cmp = compareBoolean(a.multikey, b.multikey);
+    if (cmp !== 0) {
+        return cmp;
+    }
+    return compareBoolean(a.unique, b.unique);
 }
 exports.compareApiIndex = compareApiIndex;
 function compareApiDatabase(a, b) {
@@ -115,14 +160,62 @@ function compareFieldIndex(a, b) {
     if (a.arrayConfig !== b.arrayConfig) {
         return compareArrayConfig(a.arrayConfig, b.arrayConfig);
     }
-    return 0;
+    let cmp = compareApiScope(a.apiScope, b.apiScope);
+    if (cmp !== 0) {
+        return cmp;
+    }
+    cmp = compareDensity(a.density, b.density);
+    if (cmp !== 0) {
+        return cmp;
+    }
+    cmp = compareBoolean(a.multikey, b.multikey);
+    if (cmp !== 0) {
+        return cmp;
+    }
+    return compareBoolean(a.unique, b.unique);
 }
 function compareQueryScope(a, b) {
     return QUERY_SCOPE_SEQUENCE.indexOf(a) - QUERY_SCOPE_SEQUENCE.indexOf(b);
 }
+function compareApiScope(a, b) {
+    if (a === b) {
+        return 0;
+    }
+    if (a === undefined) {
+        return -1;
+    }
+    if (b === undefined) {
+        return 1;
+    }
+    return API_SCOPE_SEQUENCE.indexOf(a) - API_SCOPE_SEQUENCE.indexOf(b);
+}
+function compareDensity(a, b) {
+    if (a === b) {
+        return 0;
+    }
+    if (a === undefined) {
+        return -1;
+    }
+    if (b === undefined) {
+        return 1;
+    }
+    return DENSITY_SEQUENCE.indexOf(a) - DENSITY_SEQUENCE.indexOf(b);
+}
 function compareOrder(a, b) {
     return ORDER_SEQUENCE.indexOf(a) - ORDER_SEQUENCE.indexOf(b);
 }
+function compareBoolean(a, b) {
+    if (a === b) {
+        return 0;
+    }
+    if (a === undefined) {
+        return -1;
+    }
+    if (b === undefined) {
+        return 1;
+    }
+    return Number(a) - Number(b);
+}
 function compareArrayConfig(a, b) {
     return ARRAY_CONFIG_SEQUENCE.indexOf(a) - ARRAY_CONFIG_SEQUENCE.indexOf(b);
 }

package/lib/firestore/api-types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RecurrenceType = exports.DatabaseEdition = exports.PointInTimeRecoveryEnablement = exports.PointInTimeRecoveryEnablementOption = exports.DatabaseDeleteProtectionState = exports.DatabaseDeleteProtectionStateOption = exports.DatabaseType = exports.StateTtl = exports.State = exports.ArrayConfig = exports.Order = exports.QueryScope = exports.Mode = void 0;
+exports.RecurrenceType = exports.DatabaseEdition = exports.PointInTimeRecoveryEnablement = exports.PointInTimeRecoveryEnablementOption = exports.DatabaseDeleteProtectionState = exports.DatabaseDeleteProtectionStateOption = exports.DatabaseType = exports.StateTtl = exports.State = exports.ArrayConfig = exports.Order = exports.Density = exports.ApiScope = exports.QueryScope = exports.Mode = void 0;
 var Mode;
 (function (Mode) {
     Mode["ASCENDING"] = "ASCENDING";
@@ -12,6 +12,19 @@ var QueryScope;
     QueryScope["COLLECTION"] = "COLLECTION";
     QueryScope["COLLECTION_GROUP"] = "COLLECTION_GROUP";
 })(QueryScope = exports.QueryScope || (exports.QueryScope = {}));
+var ApiScope;
+(function (ApiScope) {
+    ApiScope["ANY_API"] = "ANY_API";
+    ApiScope["DATASTORE_MODE_API"] = "DATASTORE_MODE_API";
+    ApiScope["MONGODB_COMPATIBLE_API"] = "MONGODB_COMPATIBLE_API";
+})(ApiScope = exports.ApiScope || (exports.ApiScope = {}));
+var Density;
+(function (Density) {
+    Density["DENSITY_UNSPECIFIED"] = "DENSITY_UNSPECIFIED";
+    Density["SPARSE_ALL"] = "SPARSE_ALL";
+    Density["SPARSE_ANY"] = "SPARSE_ANY";
+    Density["DENSE"] = "DENSE";
+})(Density = exports.Density || (exports.Density = {}));
 var Order;
 (function (Order) {
     Order["ASCENDING"] = "ASCENDING";

package/lib/firestore/api.js

@@ -6,6 +6,7 @@ const logger_1 = require("../logger");
 const utils = require("../utils");
 const validator = require("./validator");
 const types = require("./api-types");
+const api_types_1 = require("./api-types");
 const sort = require("./api-sort");
 const util = require("./util");
 const prompt_1 = require("../prompt");
@@ -13,6 +14,7 @@ const api_1 = require("../api");
 const error_1 = require("../error");
 const apiv2_1 = require("../apiv2");
 const pretty_print_1 = require("./pretty-print");
+const functional_1 = require("../functional");
 class FirestoreApi {
     constructor() {
         this.apiClient = new apiv2_1.Client({ urlPrefix: (0, api_1.firestoreOrigin)(), apiVersion: "v1" });
@@ -33,6 +35,7 @@ class FirestoreApi {
         });
     }
     async deploy(options, indexes, fieldOverrides, databaseId = "(default)") {
+        var _a;
         const spec = this.upgradeOldSpec({
             indexes,
             fieldOverrides,
@@ -42,8 +45,10 @@ class FirestoreApi {
         const fieldOverridesToDeploy = spec.fieldOverrides;
         const existingIndexes = await this.listIndexes(options.project, databaseId);
         const existingFieldOverrides = await this.listFieldOverrides(options.project, databaseId);
+        const database = await this.getDatabase(options.project, databaseId);
+        const edition = (_a = database.databaseEdition) !== null && _a !== void 0 ? _a : api_types_1.DatabaseEdition.STANDARD;
         const indexesToDelete = existingIndexes.filter((index) => {
-            return !indexesToDeploy.some((spec) => this.indexMatchesSpec(index, spec));
+            return !indexesToDeploy.some((spec) => this.indexMatchesSpec(index, spec, edition));
         });
         const fieldOverridesToDelete = existingFieldOverrides.filter((field) => {
             return !fieldOverridesToDeploy.some((spec) => {
@@ -79,7 +84,7 @@ class FirestoreApi {
             }
         }
         for (const index of indexesToDeploy) {
-            const exists = existingIndexes.some((x) => this.indexMatchesSpec(x, index));
+            const exists = existingIndexes.some((x) => this.indexMatchesSpec(x, index, edition));
             if (exists) {
                 logger_1.logger.debug(`Skipping existing index: ${JSON.stringify(index)}`);
             }
@@ -160,6 +165,10 @@ class FirestoreApi {
                 collectionGroup: util.parseIndexName(index.name).collectionGroupId,
                 queryScope: index.queryScope,
                 fields: index.fields,
+                apiScope: index.apiScope,
+                density: index.density,
+                multikey: index.multikey,
+                unique: index.unique,
             };
         });
         if (!fields) {
@@ -179,6 +188,10 @@ class FirestoreApi {
                         order: firstField.order,
                         arrayConfig: firstField.arrayConfig,
                         queryScope: index.queryScope,
+                        apiScope: index.apiScope,
+                        density: index.density,
+                        multikey: index.multikey,
+                        unique: index.unique,
                     };
                 }),
             };
@@ -205,6 +218,19 @@ class FirestoreApi {
         validator.assertHas(index, "collectionGroup");
         validator.assertHas(index, "queryScope");
         validator.assertEnum(index, "queryScope", Object.keys(types.QueryScope));
+        if (index.apiScope) {
+            validator.assertEnum(index, "apiScope", Object.keys(types.ApiScope));
+        }
+        if (index.density) {
+            validator.assertEnum(index, "density", Object.keys(types.Density));
+        }
+        if (index.multikey) {
+            validator.assertType("multikey", index.multikey, "boolean");
+        }
+        if (index.unique !== undefined) {
+            validator.assertType("unique", index.unique, "boolean");
+            throw new error_1.FirebaseError("The `unique` index configuration is not supported yet.");
+        }
         validator.assertHas(index, "fields");
         index.fields.forEach((field) => {
             validator.assertHas(field, "fieldPath");
@@ -239,6 +265,18 @@ class FirestoreApi {
             if (index.queryScope) {
                 validator.assertEnum(index, "queryScope", Object.keys(types.QueryScope));
             }
+            if (index.apiScope) {
+                validator.assertEnum(index, "apiScope", Object.keys(types.ApiScope));
+            }
+            if (index.density) {
+                validator.assertEnum(index, "density", Object.keys(types.Density));
+            }
+            if (index.multikey) {
+                validator.assertType("multikey", index.multikey, "boolean");
+            }
+            if (index.unique) {
+                validator.assertType("unique", index.unique, "boolean");
+            }
         });
     }
     async patchField(project, spec, databaseId = "(default)") {
@@ -246,6 +284,10 @@ class FirestoreApi {
         const indexes = spec.indexes.map((index) => {
             return {
                 queryScope: index.queryScope,
+                apiScope: index.apiScope,
+                density: index.density,
+                multikey: index.multikey,
+                unique: index.unique,
                 fields: [
                     {
                         fieldPath: spec.fieldPath,
@@ -282,13 +324,28 @@ class FirestoreApi {
         return this.apiClient.post(url, {
             fields: index.fields,
             queryScope: index.queryScope,
+            apiScope: index.apiScope,
+            density: index.density,
+            multikey: index.multikey,
+            unique: index.unique,
         });
     }
     deleteIndex(index) {
         const url = index.name;
         return this.apiClient.delete(`/${url}`);
     }
-    indexMatchesSpec(index, spec) {
+    optionalApiScopeMatches(lhs, rhs) {
+        return (0, functional_1.optionalValueMatches)(lhs, rhs, types.ApiScope.ANY_API);
+    }
+    optionalDensityMatches(lhs, rhs, edition) {
+        const defaultValue = edition === api_types_1.DatabaseEdition.STANDARD ? types.Density.SPARSE_ALL : types.Density.DENSE;
+        return (0, functional_1.optionalValueMatches)(lhs, rhs, defaultValue);
+    }
+    optionalMultikeyMatches(lhs, rhs) {
+        const defaultValue = false;
+        return (0, functional_1.optionalValueMatches)(lhs, rhs, defaultValue);
+    }
+    indexMatchesSpec(index, spec, edition) {
         const collection = util.parseIndexName(index.name).collectionGroupId;
         if (collection !== spec.collectionGroup) {
             return false;
@@ -296,6 +353,15 @@ class FirestoreApi {
         if (index.queryScope !== spec.queryScope) {
             return false;
         }
+        if (!this.optionalApiScopeMatches(index.apiScope, spec.apiScope)) {
+            return false;
+        }
+        if (!this.optionalDensityMatches(index.density, spec.density, edition)) {
+            return false;
+        }
+        if (!this.optionalMultikeyMatches(index.multikey, spec.multikey)) {
+            return false;
+        }
         if (index.fields.length !== spec.fields.length) {
             return false;
         }
@@ -312,6 +378,9 @@ class FirestoreApi {
             if (iField.arrayConfig !== sField.arrayConfig) {
                 return false;
             }
+            if (!utils.deepEqual(iField.vectorConfig, sField.vectorConfig)) {
+                return false;
+            }
             i++;
         }
         return true;
@@ -368,8 +437,19 @@ class FirestoreApi {
             const i = {
                 collectionGroup: index.collectionGroup || index.collectionId,
                 queryScope: index.queryScope || types.QueryScope.COLLECTION,
-                fields: [],
             };
+            if (index.apiScope) {
+                i.apiScope = index.apiScope;
+            }
+            if (index.density) {
+                i.density = index.density;
+            }
+            if (index.multikey !== undefined) {
+                i.multikey = index.multikey;
+            }
+            if (index.unique !== undefined) {
+                i.unique = index.unique;
+            }
             if (index.fields) {
                 i.fields = index.fields.map((field) => {
                     const f = {
@@ -429,6 +509,7 @@ class FirestoreApi {
         const payload = {
             locationId: req.locationId,
             type: req.type,
+            databaseEdition: req.databaseEdition,
             deleteProtectionState: req.deleteProtectionState,
             pointInTimeRecoveryEnablement: req.pointInTimeRecoveryEnablement,
             cmekConfig: req.cmekConfig,

package/lib/firestore/pretty-print.js

@@ -177,6 +177,13 @@ class PrettyPrint {
             }
             result += `(${field.fieldPath},${configString}) `;
         });
+        result += " -- ";
+        if (index.density !== undefined) {
+            result += clc.cyan(`Density:${index.density} `);
+        }
+        if (index.multikey !== undefined) {
+            result += clc.cyan(`Multikey:${index.multikey ? "YES" : "NO"}`);
+        }
         return result;
     }
     prettyBackupString(backup) {

package/lib/firestore/validator.js

@@ -26,7 +26,7 @@ exports.assertHasOneOf = assertHasOneOf;
 function assertEnum(obj, prop, valid) {
     const objString = clc.cyan(JSON.stringify(obj));
     if (valid.indexOf(obj[prop]) < 0) {
-        throw new error_1.FirebaseError(`Field "${prop}" must be one of  ${valid.join(", ")}: ${objString}`);
+        throw new error_1.FirebaseError(`Field "${prop}" must be one of ${valid.join(", ")}: ${objString}`);
     }
 }
 exports.assertEnum = assertEnum;