@firebase/firestore 4.6.4-canary.a9f844066 → 4.6.4-canary.aef54687d

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

@@ -50,6 +50,7 @@ export interface EventManager {
     onUnlisten?: (query: Query, disableRemoteListen: boolean) => Promise<void>;
     onFirstRemoteStoreListen?: (query: Query) => Promise<void>;
     onLastRemoteStoreUnlisten?: (query: Query) => Promise<void>;
+    terminate(): void;
 }
 export declare function newEventManager(): EventManager;
 export declare class EventManagerImpl implements EventManager {
@@ -70,6 +71,7 @@ export declare class EventManagerImpl implements EventManager {
      * still listening to the cache.
      */
     onLastRemoteStoreUnlisten?: (query: Query) => Promise<void>;
+    terminate(): void;
 }
 export declare function eventManagerListen(eventManager: EventManager, listener: QueryListener): Promise<void>;
 export declare function eventManagerUnlisten(eventManager: EventManager, listener: QueryListener): Promise<void>;

package/dist/firestore/src/global_index.d.ts

@@ -4217,6 +4217,44 @@ interface BundleCache {
     saveNamedQuery(transaction: PersistenceTransaction, query: NamedQuery$1): PersistencePromise<void>;
 }
 
+/**
+ * @license
+ * Copyright 2024 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.
+ */
+
+/**
+ * General purpose cache for global values.
+ *
+ * Global state that cuts across components should be saved here. Following are contained herein:
+ *
+ * `sessionToken` tracks server interaction across Listen and Write streams. This facilitates cache
+ * synchronization and invalidation.
+ */
+interface GlobalsCache {
+    /**
+     * Gets session token.
+     */
+    getSessionToken(transaction: PersistenceTransaction): PersistencePromise<ByteString>;
+    /**
+     * Sets session token.
+     *
+     * @param sessionToken - The new session token.
+     */
+    setSessionToken(transaction: PersistenceTransaction, sessionToken: ByteString): PersistencePromise<void>;
+}
+
 /**
  * @license
  * Copyright 2017 Google LLC
@@ -4762,6 +4800,10 @@ interface Persistence {
      * PORTING NOTE: This is only used for Web multi-tab.
      */
     setNetworkEnabled(networkEnabled: boolean): void;
+    /**
+     * Returns GlobalCache representing a general purpose cache for global values.
+     */
+    getGlobalsCache(): GlobalsCache;
     /**
      * Returns a MutationQueue representing the persisted mutations for the
      * given user.
@@ -5384,6 +5426,7 @@ interface EventManager {
     onUnlisten?: (query: Query$1, disableRemoteListen: boolean) => Promise<void>;
     onFirstRemoteStoreListen?: (query: Query$1) => Promise<void>;
     onLastRemoteStoreUnlisten?: (query: Query$1) => Promise<void>;
+    terminate(): void;
 }
 
 /**

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

@@ -0,0 +1,39 @@
+/**
+ * @license
+ * Copyright 2024 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.
+ */
+import { ByteString } from '../util/byte_string';
+import { PersistencePromise } from './persistence_promise';
+import { PersistenceTransaction } from './persistence_transaction';
+/**
+ * General purpose cache for global values.
+ *
+ * Global state that cuts across components should be saved here. Following are contained herein:
+ *
+ * `sessionToken` tracks server interaction across Listen and Write streams. This facilitates cache
+ * synchronization and invalidation.
+ */
+export interface GlobalsCache {
+    /**
+     * Gets session token.
+     */
+    getSessionToken(transaction: PersistenceTransaction): PersistencePromise<ByteString>;
+    /**
+     * Sets session token.
+     *
+     * @param sessionToken - The new session token.
+     */
+    setSessionToken(transaction: PersistenceTransaction, sessionToken: ByteString): PersistencePromise<void>;
+}

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

@@ -0,0 +1,25 @@
+/**
+ * @license
+ * Copyright 2024 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.
+ */
+import { ByteString } from '../util/byte_string';
+import { GlobalsCache } from './globals_cache';
+import { PersistencePromise } from './persistence_promise';
+import { PersistenceTransaction } from './persistence_transaction';
+export declare class IndexedDbGlobalsCache implements GlobalsCache {
+    private globalsStore;
+    getSessionToken(txn: PersistenceTransaction): PersistencePromise<ByteString>;
+    setSessionToken(txn: PersistenceTransaction, sessionToken: ByteString): PersistencePromise<void>;
+}

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

@@ -22,6 +22,7 @@ import { AsyncQueue } from '../util/async_queue';
 import { DocumentLike, WindowLike } from '../util/types';
 import { BundleCache } from './bundle_cache';
 import { DocumentOverlayCache } from './document_overlay_cache';
+import { GlobalsCache } from './globals_cache';
 import { IndexManager } from './index_manager';
 import { IndexedDbLruDelegateImpl } from './indexeddb_lru_delegate_impl';
 import { IndexedDbMutationQueue } from './indexeddb_mutation_queue';
@@ -119,6 +120,7 @@ export declare class IndexedDbPersistence implements Persistence {
     private lastGarbageCollectionTime;
     /** A listener to notify on primary state changes. */
     private primaryStateListener;
+    private readonly globalsCache;
     private readonly targetCache;
     private readonly remoteDocumentCache;
     private readonly bundleCache;
@@ -208,6 +210,7 @@ export declare class IndexedDbPersistence implements Persistence {
      */
     getActiveClients(): Promise<ClientId[]>;
     get started(): boolean;
+    getGlobalsCache(): GlobalsCache;
     getMutationQueue(user: User, indexManager: IndexManager): IndexedDbMutationQueue;
     getTargetCache(): IndexedDbTargetCache;
     getRemoteDocumentCache(): IndexedDbRemoteDocumentCache;

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

@@ -45,7 +45,7 @@ import { DbTimestampKey } from './indexeddb_sentinels';
  * 15. Add indexing support.
  * 16. Parse timestamp strings before creating index entries.
  */
-export declare const SCHEMA_VERSION = 16;
+export declare const SCHEMA_VERSION = 17;
 /**
  * Wrapper class to store timestamps (seconds and nanos) in IndexedDb objects.
  */
@@ -496,3 +496,12 @@ export interface DbDocumentOverlay {
     /** The overlay mutation. */
     overlayMutation: ProtoWrite;
 }
+/**
+ * An object containing global name/value pair.
+ */
+export interface DbGlobals {
+    /** Name is a globally unique identifier for a value. */
+    name: string;
+    /** Value is a general purpose storage for global data. */
+    value: Uint8Array;
+}

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

@@ -231,6 +231,11 @@ export declare const DbDocumentOverlayCollectionPathOverlayIndex = "collectionPa
 export declare const DbDocumentOverlayCollectionPathOverlayIndexPath: string[];
 export declare const DbDocumentOverlayCollectionGroupOverlayIndex = "collectionGroupOverlayIndex";
 export declare const DbDocumentOverlayCollectionGroupOverlayIndexPath: string[];
+/** Name of the IndexedDb object store. */
+export declare const DbGlobalsStore = "globals";
+export declare const DbGlobalsKeyPath = "name";
+/** Names of global values */
+export declare type DbGlobalsKey = 'sessionToken';
 export declare const V1_STORES: string[];
 export declare const V3_STORES: string[];
 export declare const V4_STORES: string[];
@@ -242,6 +247,7 @@ export declare const V13_STORES: string[];
 export declare const V14_STORES: string[];
 export declare const V15_STORES: string[];
 export declare const V16_STORES: string[];
+export declare const V17_STORES: string[];
 /**
  * The list of all default IndexedDB stores used throughout the SDK. This is
  * used when creating transactions so that access across all stores is done

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

@@ -0,0 +1,25 @@
+/**
+ * @license
+ * Copyright 2024 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.
+ */
+import { ByteString } from '../util/byte_string';
+import { GlobalsCache } from './globals_cache';
+import { PersistencePromise } from './persistence_promise';
+import { PersistenceTransaction } from './persistence_transaction';
+export declare class MemoryGlobalsCache implements GlobalsCache {
+    private sessionToken;
+    getSessionToken(transaction: PersistenceTransaction): PersistencePromise<ByteString>;
+    setSessionToken(transaction: PersistenceTransaction, sessionToken: ByteString): PersistencePromise<void>;
+}

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

@@ -20,6 +20,7 @@ import { Document } from '../model/document';
 import { DocumentKey } from '../model/document_key';
 import { JsonProtoSerializer } from '../remote/serializer';
 import { DocumentOverlayCache } from './document_overlay_cache';
+import { GlobalsCache } from './globals_cache';
 import { IndexManager } from './index_manager';
 import { ActiveTargets, LruDelegate, LruGarbageCollector, LruParams } from './lru_garbage_collector';
 import { MemoryBundleCache } from './memory_bundle_cache';
@@ -44,6 +45,7 @@ export declare class MemoryPersistence implements Persistence {
      * persisting values.
      */
     private readonly indexManager;
+    private readonly globalsCache;
     private mutationQueues;
     private overlays;
     private readonly remoteDocumentCache;
@@ -68,6 +70,7 @@ export declare class MemoryPersistence implements Persistence {
     getIndexManager(user: User): MemoryIndexManager;
     getDocumentOverlayCache(user: User): DocumentOverlayCache;
     getMutationQueue(user: User, indexManager: IndexManager): MutationQueue;
+    getGlobalsCache(): GlobalsCache;
     getTargetCache(): MemoryTargetCache;
     getRemoteDocumentCache(): MemoryRemoteDocumentCache;
     getBundleCache(): MemoryBundleCache;

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

@@ -19,6 +19,7 @@ import { TargetId } from '../core/types';
 import { DocumentKey } from '../model/document_key';
 import { BundleCache } from './bundle_cache';
 import { DocumentOverlayCache } from './document_overlay_cache';
+import { GlobalsCache } from './globals_cache';
 import { IndexManager } from './index_manager';
 import { MutationQueue } from './mutation_queue';
 import { PersistencePromise } from './persistence_promise';
@@ -130,6 +131,10 @@ export interface Persistence {
      * PORTING NOTE: This is only used for Web multi-tab.
      */
     setNetworkEnabled(networkEnabled: boolean): void;
+    /**
+     * Returns GlobalCache representing a general purpose cache for global values.
+     */
+    getGlobalsCache(): GlobalsCache;
     /**
      * Returns a MutationQueue representing the persisted mutations for the
      * given user.

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

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2024 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.
+ */
+export {};

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

@@ -0,0 +1,29 @@
+/**
+ * @license
+ * Copyright 2024 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.
+ */
+import { Persistence } from '../../../src/local/persistence';
+import { ByteString } from '../../../src/util/byte_string';
+/**
+ * A wrapper around a GlobalsCache that automatically creates a
+ * transaction around every operation to reduce test boilerplate.
+ */
+export declare class TestGlobalsCache {
+    private readonly persistence;
+    private readonly cache;
+    constructor(persistence: Persistence);
+    getSessionToken(): Promise<ByteString>;
+    setSessionToken(sessionToken: ByteString): Promise<void>;
+}