@firebase/firestore 3.4.3-202202014332 → 3.4.3-canary.2d04af91d

package/dist/index.node.cjs.js

@@ -12,7 +12,7 @@ var grpcJs = require('@grpc/grpc-js');
 var protoLoader = require('@grpc/proto-loader');
 
 const name = "@firebase/firestore";
-const version$1 = "3.4.3-202202014332";
+const version$1 = "3.4.3-canary.2d04af91d";
 
 /**
  * @license
@@ -65,7 +65,7 @@ User.GOOGLE_CREDENTIALS = new User('google-credentials-uid');
 User.FIRST_PARTY = new User('first-party-uid');
 User.MOCK_USER = new User('mock-user');
 
-const version = "9.6.4-202202014332";
+const version = "9.6.4-canary.2d04af91d";
 
 /**
  * @license
@@ -23517,13 +23517,13 @@ function terminate(firestore) {
 /**
  * Loads a Firestore bundle into the local cache.
  *
- * @param firestore - The {@link Firestore} instance to load bundles for for.
- * @param bundleData - An object representing the bundle to be loaded. Valid objects are
- *   `ArrayBuffer`, `ReadableStream<Uint8Array>` or `string`.
+ * @param firestore - The {@link Firestore} instance to load bundles for.
+ * @param bundleData - An object representing the bundle to be loaded. Valid
+ * objects are `ArrayBuffer`, `ReadableStream<Uint8Array>` or `string`.
  *
- * @returns
- *   A `LoadBundleTask` object, which notifies callers with progress updates, and completion
- *   or error events. It can be used as a `Promise<LoadBundleTaskProgress>`.
+ * @returns A `LoadBundleTask` object, which notifies callers with progress
+ * updates, and completion or error events. It can be used as a
+ * `Promise<LoadBundleTaskProgress>`.
  */
 function loadBundle(firestore, bundleData) {
     firestore = cast(firestore, Firestore);
@@ -23533,11 +23533,16 @@ function loadBundle(firestore, bundleData) {
     return resultTask;
 }
 /**
- * Reads a Firestore {@link Query} from local cache, identified by the given name.
+ * Reads a Firestore {@link Query} from local cache, identified by the given
+ * name.
  *
  * The named queries are packaged  into bundles on the server side (along
- * with resulting documents), and loaded to local cache using `loadBundle`. Once in local
- * cache, use this method to extract a {@link Query} by name.
+ * with resulting documents), and loaded to local cache using `loadBundle`. Once
+ * in local cache, use this method to extract a {@link Query} by name.
+ *
+ * @param firestore - The {@link Firestore} instance to read the query from.
+ * @param name - The name of the query.
+ * @returns A `Promise` that is resolved with the Query or `null`.
  */
 function namedQuery(firestore, name) {
     firestore = cast(firestore, Firestore);
@@ -26226,6 +26231,80 @@ function writeBatch(firestore) {
     ensureFirestoreConfigured(firestore);
     return new WriteBatch(firestore, mutations => executeWrite(firestore, mutations));
 }
+/** An index component consisting of field path and index type.  */
+class Segment {
+    constructor(
+    /** The field path of the component. */
+    fieldPath, 
+    /** The fields sorting order. */
+    kind) {
+        this.fieldPath = fieldPath;
+        this.kind = kind;
+    }
+}
+
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * 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.
+ */
+function setIndexConfiguration(firestore, jsonOrConfiguration) {
+    firestore = cast(firestore, Firestore);
+    ensureFirestoreConfigured(firestore);
+    const indexConfiguration = typeof jsonOrConfiguration === 'string'
+        ? tryParseJson(jsonOrConfiguration)
+        : jsonOrConfiguration;
+    // PORTING NOTE: We don't return an error if the user has not enabled
+    // persistence since `enableIndexeddbPersistence()` can fail on the Web.
+    if (Array.isArray(indexConfiguration.indexes)) {
+        for (const index of indexConfiguration.indexes) {
+            tryGetString(index, 'collectionGroup');
+            const segments = [];
+            if (Array.isArray(index.fields)) {
+                for (const field of index.fields) {
+                    const fieldPathString = tryGetString(field, 'fieldPath');
+                    const fieldPath = fieldPathFromDotSeparatedString('setIndexConfiguration', fieldPathString);
+                    if (field.arrayConfig === 'CONTAINS') {
+                        segments.push(new Segment(fieldPath, 2 /* CONTAINS */));
+                    }
+                    else if (field.order === 'ASCENDING') {
+                        segments.push(new Segment(fieldPath, 0 /* ASCENDING */));
+                    }
+                    else if (field.order === 'DESCENDING') {
+                        segments.push(new Segment(fieldPath, 1 /* DESCENDING */));
+                    }
+                }
+            }
+        }
+    }
+    // TODO(indexing): Configure indexes
+    return Promise.resolve();
+}
+function tryParseJson(json) {
+    try {
+        return JSON.parse(json);
+    }
+    catch (e) {
+        throw new FirestoreError(Code.INVALID_ARGUMENT, 'Failed to parse JSON:' + e.message);
+    }
+}
+function tryGetString(data, property) {
+    if (typeof data[property] !== 'string') {
+        throw new FirestoreError(Code.INVALID_ARGUMENT, 'Missing string value for: ' + property);
+    }
+    return data[property];
+}
 
 /**
  * @license
@@ -26274,6 +26353,7 @@ exports._cast = cast;
 exports._debugAssert = debugAssert;
 exports._isBase64Available = isBase64Available;
 exports._logWarn = logWarn;
+exports._setIndexConfiguration = setIndexConfiguration;
 exports._validateIsNotUsedTogether = validateIsNotUsedTogether;
 exports.addDoc = addDoc;
 exports.arrayRemove = arrayRemove;