@firebase/firestore 3.3.1 → 3.4.0-2021111174650

package/dist/lite/internal.d.ts

@@ -414,13 +414,13 @@ export declare function connectFirestoreEmulator(firestore: Firestore, host: str
  * token and may need to invalidate other state if the current user has also
  * changed.
  */
-declare type CredentialChangeListener = (user: User) => Promise<void>;
+declare type CredentialChangeListener<T> = (credential: T) => Promise<void>;
 
 /**
  * Provides methods for getting the uid and token for the current user and
  * listening for changes.
  */
-declare interface CredentialsProvider {
+declare interface CredentialsProvider<T> {
     /**
      * Starts the credentials provider and specifies a listener to be notified of
      * credential changes (sign-in / sign-out, token changes). It is immediately
@@ -428,7 +428,7 @@ declare interface CredentialsProvider {
      *
      * The change listener is invoked on the provided AsyncQueue.
      */
-    start(asyncQueue: AsyncQueue, changeListener: CredentialChangeListener): void;
+    start(asyncQueue: AsyncQueue, changeListener: CredentialChangeListener<T>): void;
     /** Requests a token for the current user. */
     getToken(): Promise<Token | null>;
     /**
@@ -952,7 +952,8 @@ declare abstract class Filter {
  * Do not call this constructor directly. Instead, use {@link getFirestore}.
  */
 export declare class Firestore implements FirestoreService {
-    _credentials: CredentialsProvider;
+    _authCredentials: CredentialsProvider<User>;
+    _appCheckCredentials: CredentialsProvider<string>;
     /**
      * Whether it's a Firestore or Firestore Lite instance.
      */
@@ -964,7 +965,7 @@ export declare class Firestore implements FirestoreService {
     private _terminateTask?;
     _app?: FirebaseApp;
     /** @hideconstructor */
-    constructor(databaseIdOrApp: DatabaseId | FirebaseApp, _credentials: CredentialsProvider);
+    constructor(databaseIdOrApp: DatabaseId | FirebaseApp, _authCredentials: CredentialsProvider<User>, _appCheckCredentials: CredentialsProvider<string>);
     /**
      * The {@link @firebase/app#FirebaseApp} associated with this `Firestore` service
      * instance.
@@ -1150,7 +1151,8 @@ export declare type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argu
  * This interface mainly exists to remove a cyclic dependency.
  */
 declare interface FirestoreService extends _FirebaseService {
-    _credentials: CredentialsProvider;
+    _authCredentials: CredentialsProvider<User>;
+    _appCheckCredentials: CredentialsProvider<string>;
     _persistenceKey: string;
     _databaseId: DatabaseId;
     _terminated: boolean;
@@ -1838,7 +1840,7 @@ declare interface PrivateSettings extends Settings {
 
 declare interface ProviderCredentialsSettings {
     ['type']: 'provider';
-    ['client']: CredentialsProvider;
+    ['client']: CredentialsProvider<User>;
 }
 
 /**
@@ -2411,15 +2413,14 @@ declare interface Token {
     /**
      * The user with which the token is associated (used for persisting user
      * state on disk, etc.).
+     * This will be null for Tokens of the type 'AppCheck'.
      */
-    user: User;
-    /** Extra header values to be passed along with a request */
-    authHeaders: {
-        [header: string]: string;
-    };
+    user?: User;
+    /** Header values to set for this token */
+    headers: Map<string, string>;
 }
 
-declare type TokenType = 'OAuth' | 'FirstParty';
+declare type TokenType = 'OAuth' | 'FirstParty' | 'AppCheck';
 
 /**
  * A reference to a transaction.