@firebase/firestore 3.4.6-canary.69aa7b02d → 3.4.7-2022222232915

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @firebase/firestore
 
+## 3.4.7-2022222232915
+
+### Patch Changes
+
+- [`69aa7b02d`](https://github.com/firebase/firebase-js-sdk/commit/69aa7b02df3b4d1f9832b7713951936b6bf32ca9) [#5988](https://github.com/firebase/firebase-js-sdk/pull/5988) - The format of some of the IndexedDB data changed. This increases the performance of document lookups after an initial migration. If you do not want to migrate data, you can call `clearIndexedDbPersistence()` before invoking `enableIndexedDbPersistence()`.
+
+- Updated dependencies [[`3198d58dc`](https://github.com/firebase/firebase-js-sdk/commit/3198d58dcedbf7583914dbcc76984f6f7df8d2ef)]:
+  - @firebase/util@1.5.1-2022222232915
+  - @firebase/app@0.7.20-2022222232915
+  - @firebase/component@0.5.12-2022222232915
+
 ## 3.4.6
 
 ### Patch Changes

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

@@ -34,10 +34,10 @@ export interface BundledDocument {
  * An array of `BundledDocument`.
  */
 export declare type BundledDocuments = BundledDocument[];
-export declare class BundleLoadResult {
+export interface BundleLoadResult {
     readonly progress: LoadBundleTaskProgress;
+    readonly changedCollectionGroups: Set<string>;
     readonly changedDocs: DocumentMap;
-    constructor(progress: LoadBundleTaskProgress, changedDocs: DocumentMap);
 }
 /**
  * Represents a Firestore bundle saved by the SDK in its local storage.

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

@@ -51,6 +51,8 @@ export declare class BundleLoader {
     private queries;
     /** Batched documents to be saved into storage */
     private documents;
+    /** The collection groups affected by this bundle. */
+    private collectionGroups;
     constructor(bundleMetadata: ProtoBundleMetadata, localStore: LocalStore, serializer: JsonProtoSerializer);
     /**
      * Adds an element from the bundle to the loader.

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

@@ -121,6 +121,13 @@ export declare function canonifyQuery(query: Query): string;
 export declare function stringifyQuery(query: Query): string;
 /** Returns whether `doc` matches the constraints of `query`. */
 export declare function queryMatches(query: Query, doc: Document): boolean;
+/**
+ * Returns the collection group that this query targets.
+ *
+ * PORTING NOTE: This is only used in the Web SDK to facilitate multi-tab
+ * synchronization for query results.
+ */
+export declare function queryCollectionGroup(query: Query): string;
 /**
  * Returns a new comparator function that can be used to compare two documents
  * based on the Query's ordering constraint.

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

@@ -227,7 +227,7 @@ export declare function syncEngineGetRemoteKeysForTarget(syncEngine: SyncEngine,
  * Retrieves newly changed documents from remote document cache and raises
  * snapshots if needed.
  */
-export declare function syncEngineSynchronizeWithChangedDocuments(syncEngine: SyncEngine): Promise<void>;
+export declare function syncEngineSynchronizeWithChangedDocuments(syncEngine: SyncEngine, collectionGroup: string): Promise<void>;
 /** Applies a mutation state to an existing batch.  */
 export declare function syncEngineApplyBatchState(syncEngine: SyncEngine, batchId: BatchId, batchState: MutationBatchState, error?: FirestoreError): Promise<void>;
 /** Applies a query target change from a different tab. */

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

@@ -14,12 +14,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { SnapshotVersion } from '../core/snapshot_version';
-import { MutableDocumentMap } from '../model/collections';
 import { MutableDocument } from '../model/document';
 import { LocalSerializer } from './local_serializer';
-import { PersistencePromise } from './persistence_promise';
-import { PersistenceTransaction } from './persistence_transaction';
 import { RemoteDocumentCache } from './remote_document_cache';
 export interface DocumentSizeEntry {
     document: MutableDocument;
@@ -29,16 +25,3 @@ export interface IndexedDbRemoteDocumentCache extends RemoteDocumentCache {
 }
 /** Creates a new IndexedDbRemoteDocumentCache. */
 export declare function newIndexedDbRemoteDocumentCache(serializer: LocalSerializer): IndexedDbRemoteDocumentCache;
-/**
- * Returns the set of documents that have changed since the specified read
- * time.
- */
-export declare function remoteDocumentCacheGetNewDocumentChanges(remoteDocumentCache: IndexedDbRemoteDocumentCache, transaction: PersistenceTransaction, sinceReadTime: SnapshotVersion): PersistencePromise<{
-    changedDocs: MutableDocumentMap;
-    readTime: SnapshotVersion;
-}>;
-/**
- * Returns the read time of the most recently read document in the cache, or
- * SnapshotVersion.min() if not available.
- */
-export declare function remoteDocumentCacheGetLastReadTime(transaction: PersistenceTransaction): PersistencePromise<SnapshotVersion>;

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

@@ -95,14 +95,6 @@ export declare type DbRemoteDocumentKey = [
  * access by collection path and read time.
  */
 export declare const DbRemoteDocumentKeyPath: string[];
-/**
- * An index that provides access to all entries sorted by read time (which
- * corresponds to the last modification time of each row).
- *
- * This index is used to provide a changelog for Multi-Tab.
- */
-export declare const DbRemoteDocumentReadTimeIndex = "readTimeIndex";
-export declare const DbRemoteDocumentReadTimeIndexPath = "readTime";
 /** An index that provides access to documents by key. */
 export declare const DbRemoteDocumentDocumentKeyIndex = "documentKeyIndex";
 export declare const DbRemoteDocumentDocumentKeyIndexPath: string[];

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

@@ -165,13 +165,7 @@ export declare function localStoreGetCachedTarget(localStore: LocalStore, target
  * initialization. Further invocations will return document that have changed
  * since the prior call.
  */
-export declare function localStoreGetNewDocumentChanges(localStore: LocalStore): Promise<DocumentMap>;
-/**
- * Reads the newest document change from persistence and moves the internal
- * synchronization marker forward so that calls to `getNewDocumentChanges()`
- * only return changes that happened after client initialization.
- */
-export declare function localStoreSynchronizeLastDocumentChangeReadTime(localStore: LocalStore): Promise<void>;
+export declare function localStoreGetNewDocumentChanges(localStore: LocalStore, collectionGroup: string): Promise<DocumentMap>;
 /**
  * Applies the documents from a bundle to the "ground-state" (remote)
  * documents.

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

@@ -113,8 +113,10 @@ export interface SharedClientState {
     /**
      * Notifies other clients when remote documents have changed due to loading
      * a bundle.
+     *
+     * @param collectionGroups The collection groups affected by this bundle.
      */
-    notifyBundleLoaded(): void;
+    notifyBundleLoaded(collectionGroups: Set<string>): void;
 }
 /**
  * Holds the state of a mutation batch, including its user ID, batch ID and
@@ -237,7 +239,7 @@ export declare class WebStorageSharedClientState implements SharedClientState {
     updateQueryState(targetId: TargetId, state: QueryTargetState, error?: FirestoreError): void;
     handleUserChange(user: User, removedBatchIds: BatchId[], addedBatchIds: BatchId[]): void;
     setOnlineState(onlineState: OnlineState): void;
-    notifyBundleLoaded(): void;
+    notifyBundleLoaded(collectionGroups: Set<string>): void;
     shutdown(): void;
     private getItem;
     private setItem;
@@ -275,6 +277,7 @@ export declare class WebStorageSharedClientState implements SharedClientState {
      * could not be parsed.
      */
     private fromWebStorageOnlineState;
+    private fromWebStoreBundleLoadedState;
     private handleMutationBatchEvent;
     private handleQueryTargetEvent;
     private handleClientStateEvent;
@@ -305,5 +308,5 @@ export declare class MemorySharedClientState implements SharedClientState {
     setOnlineState(onlineState: OnlineState): void;
     shutdown(): void;
     writeSequenceNumber(sequenceNumber: ListenSequenceNumber): void;
-    notifyBundleLoaded(): void;
+    notifyBundleLoaded(collectionGroups: Set<string>): void;
 }

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

@@ -64,7 +64,7 @@ export interface QueryTargetStateSchema {
 export declare const ONLINE_STATE_KEY_PREFIX = "firestore_online_state";
 /** Assembles the key for the online state of the primary tab. */
 export declare function createWebStorageOnlineStateKey(persistenceKey: string): string;
-export declare const BUNDLE_LOADED_KEY_PREFIX = "firestore_bundle_loaded";
+export declare const BUNDLE_LOADED_KEY_PREFIX = "firestore_bundle_loaded_v2";
 export declare function createBundleLoadedKey(persistenceKey: string): string;
 /**
  * The JSON representation of the system's online state, as written by the

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

@@ -36,5 +36,5 @@ export interface SharedClientStateSyncer {
      * Retrieves newly changed documents from remote document cache and raises
      * snapshots if needed.
      */
-    synchronizeWithChangedDocuments(): Promise<void>;
+    synchronizeWithChangedDocuments(collectionGroup: string): Promise<void>;
 }