Merge

Author: schmidt-sebastian

.changeset/config.json

@@ -23,7 +23,9 @@
     "@firebase/installations-exp",
     "@firebase/installations-compat",
     "@firebase/messaging-exp",
+    "@firebase/messaging-compat",
     "@firebase/performance-exp",
+    "@firebase/performance-compat",
     "@firebase/remote-config-exp",
     "@firebase/remote-config-compat",
     "firebase-exp",

.changeset/cyan-wasps-worry.md

@@ -0,0 +1,5 @@
+---
+"@firebase/util": patch
+---
+
+Added a utility function and type for compat interop API

.changeset/giant-eggs-nail.md

@@ -0,0 +1,5 @@
+---
+"@firebase/firestore": patch
+---
+
+Added new internal HTTP header to all network requests.

.changeset/honest-hounds-sin.md

@@ -216,8 +216,10 @@ export class EmailAuthProvider implements AuthProvider {
     readonly providerId = ProviderId.PASSWORD;
 }
 
+// Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.d.ts
+//
 // @public
-export class FacebookAuthProvider extends OAuthProvider {
+export class FacebookAuthProvider extends BaseOAuthProvider {
     constructor();
     static credential(accessToken: string): OAuthCredential;
     static credentialFromError(error: FirebaseError): OAuthCredential | null;
@@ -255,7 +257,7 @@ export function getMultiFactorResolver(auth: Auth, error: MultiFactorError_2): M
 export function getRedirectResult(auth: Auth, resolver?: PopupRedirectResolver): Promise<UserCredential | null>;
 
 // @public
-export class GithubAuthProvider extends OAuthProvider {
+export class GithubAuthProvider extends BaseOAuthProvider {
     constructor();
     static credential(accessToken: string): OAuthCredential;
     static credentialFromError(error: FirebaseError): OAuthCredential | null;
@@ -265,7 +267,7 @@ export class GithubAuthProvider extends OAuthProvider {
 }
 
 // @public
-export class GoogleAuthProvider extends OAuthProvider {
+export class GoogleAuthProvider extends BaseOAuthProvider {
     constructor();
     static credential(idToken?: string | null, accessToken?: string | null): OAuthCredential;
     static credentialFromError(error: FirebaseError): OAuthCredential | null;
@@ -380,23 +382,13 @@ export interface OAuthCredentialOptions {
 }
 
 // @public
-export class OAuthProvider implements AuthProvider {
-    constructor(providerId: string);
-    addScope(scope: string): AuthProvider;
+export class OAuthProvider extends BaseOAuthProvider {
     credential(params: OAuthCredentialOptions): OAuthCredential;
     static credentialFromError(error: FirebaseError): OAuthCredential | null;
     // (undocumented)
     static credentialFromJSON(json: object | string): OAuthCredential;
     static credentialFromResult(userCredential: UserCredential): OAuthCredential | null;
-    // @internal (undocumented)
-    defaultLanguageCode: string | null;
-    getCustomParameters(): CustomParameters;
-    getScopes(): string[];
-    // (undocumented)
-    readonly providerId: string;
-    setCustomParameters(customOAuthParameters: CustomParameters): AuthProvider;
-    setDefaultLanguage(languageCode: string | null): void;
-}
+    }
 
 // @public
 export function onAuthStateChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
@@ -566,6 +558,19 @@ export class RecaptchaVerifier implements ApplicationVerifierInternal {
 // @public
 export function reload(user: User): Promise<void>;
 
+// Warning: (ae-forgotten-export) The symbol "FederatedAuthProvider" needs to be exported by the entry point index.d.ts
+//
+// @public
+export class SAMLAuthProvider extends FederatedAuthProvider {
+    constructor(providerId: string);
+    // (undocumented)
+    static credentialFromError(error: FirebaseError): AuthCredential | null;
+    // (undocumented)
+    static credentialFromJSON(json: string | object): AuthCredential;
+    // (undocumented)
+    static credentialFromResult(userCredential: UserCredential): AuthCredential | null;
+    }
+
 // @public
 export function sendEmailVerification(user: User, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;
 
@@ -626,7 +631,7 @@ export function signInWithRedirect(auth: Auth, provider: AuthProvider, resolver?
 export function signOut(auth: Auth): Promise<void>;
 
 // @public
-export class TwitterAuthProvider extends OAuthProvider {
+export class TwitterAuthProvider extends BaseOAuthProvider {
     constructor();
     static credential(token: string, secret: string): OAuthCredential;
     static credentialFromError(error: FirebaseError): OAuthCredential | null;

.changeset/lemon-laws-brush.md

@@ -53,6 +53,8 @@ export class CollectionReference<T = DocumentData> extends Query<T> {
     get path(): string;
     // (undocumented)
     readonly type = "collection";
+    withConverter(converter: null): CollectionReference<DocumentData>;
+    // (undocumented)
     withConverter<U>(converter: FirestoreDataConverter<U>): CollectionReference<U>;
 }
 
@@ -101,6 +103,8 @@ export class DocumentReference<T = DocumentData> {
     get parent(): CollectionReference<T>;
     get path(): string;
     readonly type = "document";
+    withConverter(converter: null): DocumentReference<DocumentData>;
+    // (undocumented)
     withConverter<U>(converter: FirestoreDataConverter<U>): DocumentReference<U>;
 }
 
@@ -318,6 +322,8 @@ export class Query<T = DocumentData> {
     protected constructor();
     readonly firestore: FirebaseFirestore;
     readonly type: 'query' | 'collection';
+    withConverter(converter: null): Query<DocumentData>;
+    // (undocumented)
     withConverter<U>(converter: FirestoreDataConverter<U>): Query<U>;
 }
 

common/api-review/auth-exp.api.md

@@ -47,6 +47,8 @@ export class CollectionReference<T = DocumentData> extends Query<T> {
     get path(): string;
     // (undocumented)
     readonly type = "collection";
+    withConverter(converter: null): CollectionReference<DocumentData>;
+    // (undocumented)
     withConverter<U>(converter: FirestoreDataConverter<U>): CollectionReference<U>;
 }
 
@@ -81,6 +83,8 @@ export class DocumentReference<T = DocumentData> {
     get parent(): CollectionReference<T>;
     get path(): string;
     readonly type = "document";
+    withConverter(converter: null): DocumentReference<DocumentData>;
+    // (undocumented)
     withConverter<U>(converter: FirestoreDataConverter<U>): DocumentReference<U>;
 }
 
@@ -195,6 +199,8 @@ export class Query<T = DocumentData> {
     protected constructor();
     readonly firestore: FirebaseFirestore;
     readonly type: 'query' | 'collection';
+    withConverter(converter: null): Query<DocumentData>;
+    // (undocumented)
     withConverter<U>(converter: FirestoreDataConverter<U>): Query<U>;
 }
 

common/api-review/firestore-exp.api.md

@@ -62,6 +62,11 @@ export interface NotificationPayload {
     title?: string;
 }
 
+// Warning: (ae-internal-missing-underscore) The name "onBackgroundMessage" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal
+export function onBackgroundMessage(messaging: FirebaseMessaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
+
 // @public
 export function onMessage(messaging: FirebaseMessaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
 

common/api-review/firestore-lite.api.md

@@ -6,14 +6,32 @@
 
 import { CompleteFn } from '@firebase/util';
 import { FirebaseApp } from '@firebase/app';
+import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import { FirebaseError } from '@firebase/util';
+import { _FirebaseService } from '@firebase/app';
 import { NextFn } from '@firebase/util';
+import { Provider } from '@firebase/component';
 import { Subscribe } from '@firebase/util';
 import { Unsubscribe } from '@firebase/util';
 
 // @public
 export function deleteObject(ref: StorageReference): Promise<void>;
 
+// @internal (undocumented)
+export class _FbsBlob {
+    constructor(data: Blob | Uint8Array | ArrayBuffer, elideCopy?: boolean);
+    // (undocumented)
+    static getBlob(...args: Array<string | _FbsBlob>): _FbsBlob | null;
+    // (undocumented)
+    size(): number;
+    // (undocumented)
+    slice(startByte: number, endByte: number): _FbsBlob | null;
+    // (undocumented)
+    type(): string;
+    // (undocumented)
+    uploadData(): Blob | Uint8Array;
+}
+
 // @public
 export interface FirebaseStorageError extends FirebaseError {
     serverResponse: string | null;
@@ -33,6 +51,9 @@ export interface FullMetadata extends UploadMetadata {
     updated: string;
 }
 
+// @internal (undocumented)
+export function _getChild(ref: StorageReference, childPath: string): _Reference;
+
 // @public
 export function getDownloadURL(ref: StorageReference): Promise<string>;
 
@@ -61,12 +82,50 @@ export interface ListResult {
     prefixes: StorageReference[];
 }
 
+// @internal
+export class _Location {
+    constructor(bucket: string, path: string);
+    // (undocumented)
+    readonly bucket: string;
+    // (undocumented)
+    bucketOnlyServerUrl(): string;
+    // (undocumented)
+    fullServerUrl(): string;
+    // (undocumented)
+    get isRoot(): boolean;
+    // (undocumented)
+    static makeFromBucketSpec(bucketString: string): _Location;
+    // (undocumented)
+    static makeFromUrl(url: string): _Location;
+    // (undocumented)
+    get path(): string;
+    }
+
 // @public
 export function ref(storage: StorageService, url?: string): StorageReference;
 
 // @public
 export function ref(storageOrRef: StorageService | StorageReference, path?: string): StorageReference;
 
+// @internal
+export class _Reference {
+    // Warning: (ae-forgotten-export) The symbol "StorageService" needs to be exported by the entry point index.d.ts
+    constructor(_service: StorageService_2, location: string | _Location);
+    get bucket(): string;
+    get fullPath(): string;
+    // (undocumented)
+    _location: _Location;
+    get name(): string;
+    // (undocumented)
+    protected _newRef(service: StorageService_2, location: _Location): _Reference;
+    get parent(): _Reference | null;
+    get root(): _Reference;
+    get storage(): StorageService_2;
+    _throwIfRoot(name: string): void;
+    // @override
+    toString(): string;
+}
+
 // @public
 export interface SettableMetadata {
     cacheControl?: string | undefined;
@@ -101,7 +160,7 @@ export interface StorageReference {
 }
 
 // @public
-export interface StorageService {
+export interface StorageService extends _FirebaseService {
     readonly app: FirebaseApp;
     maxOperationRetryTime: number;
     maxUploadRetryTime: number;
@@ -158,6 +217,32 @@ export interface UploadTask {
     then(onFulfilled?: ((snapshot: UploadTaskSnapshot) => unknown) | null, onRejected?: ((error: FirebaseStorageError) => unknown) | null): Promise<unknown>;
 }
 
+// @internal
+export class _UploadTask {
+    constructor(ref: _Reference, blob: _FbsBlob, metadata?: Metadata | null);
+    _blob: _FbsBlob;
+    cancel(): boolean;
+    catch<T>(onRejected: (p1: FirebaseStorageError_2) => T | Promise<T>): Promise<T>;
+    // Warning: (ae-forgotten-export) The symbol "Metadata" needs to be exported by the entry point index.d.ts
+    _metadata: Metadata | null;
+    // Warning: (ae-forgotten-export) The symbol "TaskEvent" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "StorageObserver" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "ErrorFn" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "CompleteFn" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Unsubscribe" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Subscribe" needs to be exported by the entry point index.d.ts
+    on(type: TaskEvent_2, nextOrObserver?: StorageObserver_2<UploadTaskSnapshot_2> | ((a: UploadTaskSnapshot_2) => unknown), error?: ErrorFn, completed?: CompleteFn_2): Unsubscribe_2 | Subscribe_2<UploadTaskSnapshot_2>;
+    pause(): boolean;
+    resume(): boolean;
+    // Warning: (ae-forgotten-export) The symbol "UploadTaskSnapshot" needs to be exported by the entry point index.d.ts
+    get snapshot(): UploadTaskSnapshot_2;
+    // Warning: (ae-forgotten-export) The symbol "InternalTaskState" needs to be exported by the entry point index.d.ts
+    _state: InternalTaskState;
+    // Warning: (ae-forgotten-export) The symbol "FirebaseStorageError" needs to be exported by the entry point index.d.ts
+    then<U>(onFulfilled?: ((value: UploadTaskSnapshot_2) => U | Promise<U>) | null, onRejected?: ((error: FirebaseStorageError_2) => U | Promise<U>) | null): Promise<U>;
+    _transferred: number;
+    }
+
 // @public
 export interface UploadTaskSnapshot {
     bytesTransferred: number;

common/api-review/messaging-exp.api.md

@@ -7,7 +7,7 @@
     "test:ci": "node ../../scripts/run_tests_in_ci.js -s test"
   },
   "devDependencies": {
-    "firebase": "8.2.10",
+    "firebase": "8.3.1",
     "@types/chai": "4.2.14",
     "@types/mocha": "7.0.2",
     "chai": "4.2.0",

common/api-review/storage.api.md

@@ -14,8 +14,8 @@
     "test:memory:debug": "yarn build:memory; karma start --auto-watch --browsers Chrome"
   },
   "devDependencies": {
-    "@firebase/app": "0.6.15",
-    "@firebase/firestore": "2.1.7",
+    "@firebase/app": "0.6.17",
+    "@firebase/firestore": "2.2.1",
     "@types/mocha": "7.0.2",
     "gulp": "4.0.2",
     "gulp-filter": "6.0.0",

integration/firebase/package.json

@@ -9,9 +9,9 @@
     "test:manual": "mocha --exit"
   },
   "devDependencies": {
-    "firebase": "8.2.10",
+    "firebase": "8.3.1",
     "chai": "4.2.0",
-    "chromedriver": "88.0.0",
+    "chromedriver": "89.0.0",
     "express": "4.17.1",
     "geckodriver": "1.21.1",
     "mocha": "7.2.0",

integration/firestore/package.json

@@ -53,7 +53,8 @@
     "api-report": "lerna run --scope @firebase/*-exp --scope @firebase/firestore --scope @firebase/storage --scope @firebase/storage-types --scope @firebase/database api-report",
     "docgen:exp": "ts-node-script scripts/exp/docgen.ts",
     "postinstall": "yarn --cwd repo-scripts/changelog-generator build",
-    "sa": "ts-node-script repo-scripts/size-analysis/cli.ts"
+    "sa": "ts-node-script repo-scripts/size-analysis/cli.ts",
+    "api-documenter-devsite": "ts-node-script repo-scripts/api-documenter/src/start.ts"
   },
   "repository": {
     "type": "git",
@@ -89,8 +90,8 @@
     "@typescript-eslint/eslint-plugin": "4.11.1",
     "@typescript-eslint/eslint-plugin-tslint": "4.11.1",
     "@typescript-eslint/parser": "4.11.1",
-    "api-documenter-me": "0.1.0",
-    "api-extractor-me": "0.1.1",
+    "api-documenter-me": "0.1.1",
+    "api-extractor-me": "0.1.2",
     "babel-loader": "8.2.2",
     "chai": "4.2.0",
     "chai-as-promised": "7.1.1",