@firebase/firestore 3.4.8-2022312211851 → 3.4.8-canary.38da5d9be

package/CHANGELOG.md

@@ -1,15 +1,14 @@
 # @firebase/firestore
 
-## 3.4.8-2022312211851
+## 3.4.8
 
 ### Patch Changes
 
 - [`05dc9d6a0`](https://github.com/firebase/firebase-js-sdk/commit/05dc9d6a0db3058611dd7a2dc34daa726f9ba20d) [#6128](https://github.com/firebase/firebase-js-sdk/pull/6128) (fixes [#6110](https://github.com/firebase/firebase-js-sdk/issues/6110)) - Fixes an issue during multi-document lookup that resulted in the IndexedDB error "The parameter is less than or equal to this cursor's".
 
 - Updated dependencies [[`e9e5f6b3c`](https://github.com/firebase/firebase-js-sdk/commit/e9e5f6b3ca9d61323b22f87986d9959f5297ec59)]:
-  - @firebase/util@1.5.2-2022312211851
-  - @firebase/app@0.7.21-2022312211851
-  - @firebase/component@0.5.13-2022312211851
+  - @firebase/util@1.5.2
+  - @firebase/component@0.5.13
 
 ## 3.4.7
 

package/dist/firestore/src/core/target.d.ts

@@ -82,6 +82,8 @@ export declare function targetGetLowerBound(target: Target, fieldIndex: FieldInd
  * upper bound exists.
  */
 export declare function targetGetUpperBound(target: Target, fieldIndex: FieldIndex): Bound | null;
+/** Returns the number of segments of a perfect index for this target. */
+export declare function targetGetSegmentCount(target: Target): number;
 export declare abstract class Filter {
     abstract matches(doc: Document): boolean;
 }

package/dist/firestore/src/local/index_manager.d.ts

@@ -21,6 +21,22 @@ import { FieldIndex, IndexOffset } from '../model/field_index';
 import { ResourcePath } from '../model/path';
 import { PersistencePromise } from './persistence_promise';
 import { PersistenceTransaction } from './persistence_transaction';
+/** Represents the index state as it relates to a particular target. */
+export declare const enum IndexType {
+    /** Indicates that no index could be found for serving the target. */
+    NONE = 0,
+    /**
+     * Indicates that only a "partial index" could be found for serving the
+     * target. A partial index is one which does not have a segment for every
+     * filter/orderBy in the target.
+     */
+    PARTIAL = 1,
+    /**
+     * Indicates that a "full index" could be found for serving the target. A full
+     * index is one which has a segment for every filter/orderBy in the target.
+     */
+    FULL = 2
+}
 /**
  * Represents a set of indexes that are used to execute queries efficiently.
  *
@@ -68,10 +84,10 @@ export interface IndexManager {
     /** Returns all configured field indexes. */
     getFieldIndexes(transaction: PersistenceTransaction): PersistencePromise<FieldIndex[]>;
     /**
-     * Returns an index that can be used to serve the provided target. Returns
-     * `null` if no index is configured.
+     * Returns the type of index (if any) that can be used to serve the given
+     * target.
      */
-    getFieldIndex(transaction: PersistenceTransaction, target: Target): PersistencePromise<FieldIndex | null>;
+    getIndexType(transaction: PersistenceTransaction, target: Target): PersistencePromise<IndexType>;
     /**
      * Returns the documents that match the given target based on the provided
      * index or `null` if the target does not have a matching index.

package/dist/firestore/src/local/indexeddb_index_manager.d.ts

@@ -21,7 +21,7 @@ import { DocumentMap } from '../model/collections';
 import { DocumentKey } from '../model/document_key';
 import { FieldIndex, IndexOffset } from '../model/field_index';
 import { ResourcePath } from '../model/path';
-import { IndexManager } from './index_manager';
+import { IndexManager, IndexType } from './index_manager';
 import { PersistencePromise } from './persistence_promise';
 import { PersistenceTransaction } from './persistence_transaction';
 /**
@@ -75,7 +75,8 @@ export declare class IndexedDbIndexManager implements IndexManager {
      * and user.
      */
     private generateEmptyBound;
-    getFieldIndex(transaction: PersistenceTransaction, target: Target): PersistencePromise<FieldIndex | null>;
+    private getFieldIndex;
+    getIndexType(transaction: PersistenceTransaction, target: Target): PersistencePromise<IndexType>;
     /**
      * Returns the byte encoded form of the directional values in the field index.
      * Returns `null` if the document does not have all fields specified in the

package/dist/firestore/src/local/memory_index_manager.d.ts

@@ -19,7 +19,7 @@ import { DocumentMap } from '../model/collections';
 import { DocumentKey } from '../model/document_key';
 import { FieldIndex, IndexOffset } from '../model/field_index';
 import { ResourcePath } from '../model/path';
-import { IndexManager } from './index_manager';
+import { IndexManager, IndexType } from './index_manager';
 import { PersistencePromise } from './persistence_promise';
 import { PersistenceTransaction } from './persistence_transaction';
 /**
@@ -32,7 +32,7 @@ export declare class MemoryIndexManager implements IndexManager {
     addFieldIndex(transaction: PersistenceTransaction, index: FieldIndex): PersistencePromise<void>;
     deleteFieldIndex(transaction: PersistenceTransaction, index: FieldIndex): PersistencePromise<void>;
     getDocumentsMatchingTarget(transaction: PersistenceTransaction, target: Target): PersistencePromise<DocumentKey[] | null>;
-    getFieldIndex(transaction: PersistenceTransaction, target: Target): PersistencePromise<FieldIndex | null>;
+    getIndexType(transaction: PersistenceTransaction, target: Target): PersistencePromise<IndexType>;
     getFieldIndexes(transaction: PersistenceTransaction, collectionGroup?: string): PersistencePromise<FieldIndex[]>;
     getNextCollectionGroupToUpdate(transaction: PersistenceTransaction): PersistencePromise<string | null>;
     updateCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, offset: IndexOffset): PersistencePromise<void>;

package/dist/firestore/test/unit/local/test_index_manager.d.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 import { Target } from '../../../src/core/target';
-import { IndexManager } from '../../../src/local/index_manager';
+import { IndexManager, IndexType } from '../../../src/local/index_manager';
 import { Persistence } from '../../../src/local/persistence';
 import { DocumentMap } from '../../../src/model/collections';
 import { DocumentKey } from '../../../src/model/document_key';
@@ -34,7 +34,7 @@ export declare class TestIndexManager {
     addFieldIndex(index: FieldIndex): Promise<void>;
     deleteFieldIndex(index: FieldIndex): Promise<void>;
     getFieldIndexes(collectionGroup?: string): Promise<FieldIndex[]>;
-    getFieldIndex(target: Target): Promise<FieldIndex | null>;
+    getIndexType(target: Target): Promise<IndexType>;
     getDocumentsMatchingTarget(target: Target): Promise<DocumentKey[] | null>;
     getNextCollectionGroupToUpdate(): Promise<string | null>;
     updateCollectionGroup(collectionGroup: string, offset: IndexOffset): Promise<void>;