Placeholders for sub-package, reexport rxfire/*

jamesdaniels · jamesdaniels · commit b72a87b2bef7 · 2021-05-03T15:47:58.000-04:00
diff --git a/README.md b/README.md
@@ -18,8 +18,9 @@ AngularFire smooths over the rough edges an Angular developer might encounter wh
 
 ```ts
 import { Component } from '@angular/core';
-import { AngularFirestore } from '@angular/fire/firestore';
-import { Observable } from 'rxjs';
+import { Firestore } from '@angular/fire';
+import { Observable, valueChanges } from 'rxjs';
+import { collection } from 'firebase/firestore';
 
 @Component({
   selector: 'app-root',
@@ -33,8 +34,8 @@ import { Observable } from 'rxjs';
 })
 export class MyApp {
   item$: Observable<any[]>;
-  constructor(firestore: AngularFirestore) {
-    this.item$ = firestore.collection('items').valueChanges();
+  constructor(firestore: Firestore) {
+    this.item$ = valueChanges(collection(firestore, 'items'));
   }
 }
 ```
@@ -47,6 +48,7 @@ AngularFire doesn't follow Angular's versioning as Firebase also has breaking ch
 
 | Angular | Firebase | AngularFire  |
 | --------|----------|--------------|
+| 12      | 9        | ^7.0         |
 | 11      | 7,8      | ^6.1         |
 | 10      | 8        | ^6.0.4       |
 | 10      | 7        | ^6.0.3       |
@@ -77,7 +79,7 @@ Neither AngularFire or Firebase ship with polyfills. To have compatability acros
 
 [Stackblitz Template](https://stackblitz.com/edit/angular-fire-start) - Remember to set your Firebase configuration in `app/app.module.ts`.
 
-[Upgrading to v6.0? Check out our guide.](docs/version-6-upgrade.md)
+[Upgrading to v7.0? Check out our guide.](docs/version-7-upgrade.md)
 
 **Having troubles?** Get help on our [Q&A board](https://github.com/angular/angularfire/discussions?discussions_q=category%3AQ%26A), the official [Firebase Mailing List](https://groups.google.com/forum/#!forum/firebase-talk), the [Firebase Community Slack](https://firebase.community/) (`#angularfire2`), the [Angular Community Discord](http://discord.gg/angular) (`#firebase`), [Gitter](https://gitter.im/angular/angularfire2), the [Firebase subreddit](https://www.reddit.com/r/firebase), or [Stack Overflow](https://stackoverflow.com/questions/tagged/angularfire2).
 
diff --git a/docs/version-7-upgrade.md b/docs/version-7-upgrade.md
@@ -0,0 +1,5 @@
+# Upgrading to AngularFire 7.0
+
+Intended to be run with Angular 12, AngularFire 7.0 allows you to take full advtange of the new tree-shakable Firebase JS SDK (v9) while also providing a compatible expirience with the prior API.
+
+**TBD**
diff --git a/src/analytics/analytics.module.ts b/src/analytics/analytics.module.ts
@@ -28,7 +28,7 @@ export function ɵanalyticsInstancesFactory(instances: Analytics[]) {
 // Hack: useFactory doesn't allow us to pass a lambda, so let's bind the arugments
 // Going this direction to cut down on DI token noise; also making it easier to support
 // multiple Firebase Apps
-export function ɵboundAuthInstanceFactory(zone: NgZone) {
+export function ɵboundAnalyticsInstanceFactory(zone: NgZone) {
   const analytics = ɵsmartCacheInstance<FirebaseAnalytics>(CACHE_PREFIX, this);
   return new Analytics(analytics);
 }
@@ -47,15 +47,15 @@ const DEFAULT_ANALYTICS_INSTANCE_PROVIDER = {
     DEFAULT_ANALYTICS_INSTANCE_PROVIDER,
   ]
 })
-export class AngularFireAuthModule {
+export class AngularFireAnalyticsModule {
 }
 
 export function provideAnalytics(fn: () => FirebaseAnalytics) {
   return {
-    ngModule: AngularFireAuthModule,
+    ngModule: AngularFireAnalyticsModule,
     providers: [{
       provide: ANALYTICS_INSTANCES,
-      useFactory: ɵboundAuthInstanceFactory.bind(fn),
+      useFactory: ɵboundAnalyticsInstanceFactory.bind(fn),
       multi: true,
       deps: [
         NgZone,
diff --git a/src/analytics/package.json b/src/analytics/package.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "../../node_modules/ng-packagr/package.schema.json",
+  "ngPackage": {
+    "lib": {
+      "umdModuleIds": {
+        "rxfire/analytics": "rxfire"
+      },
+      "entryFile": "public_api.ts"
+    }
+  }
+}
diff --git a/src/analytics/public_api.ts b/src/analytics/public_api.ts
@@ -0,0 +1 @@
+export { Analytics, provideAnalytics, ANALYTICS_INSTANCES } from '@angular/fire';
diff --git a/src/app/package.json b/src/app/package.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "../../node_modules/ng-packagr/package.schema.json",
+  "ngPackage": {
+    "lib": {
+      "umdModuleIds": {
+        "rxfire/app": "rxfire"
+      },
+      "entryFile": "public_api.ts"
+    }
+  }
+}
diff --git a/src/app/public_api.ts b/src/app/public_api.ts
@@ -0,0 +1 @@
+export { FirebaseApp, provideFirebaseApp, FIREBASE_APPS } from '@angular/fire';
diff --git a/src/auth/package.json b/src/auth/package.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "../../node_modules/ng-packagr/package.schema.json",
+  "ngPackage": {
+    "lib": {
+      "umdModuleIds": {
+        "rxfire/auth": "rxfire"
+      },
+      "entryFile": "public_api.ts"
+    }
+  }
+}
diff --git a/src/auth/public_api.ts b/src/auth/public_api.ts
@@ -0,0 +1,2 @@
+export { Auth, provideAuth, AUTH_INSTANCES } from '@angular/fire';
+export * from 'rxfire/auth';
diff --git a/src/database/package.json b/src/database/package.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "../../node_modules/ng-packagr/package.schema.json",
+  "ngPackage": {
+    "lib": {
+      "umdModuleIds": {
+        "rxfire/database": "rxfire"
+      },
+      "entryFile": "public_api.ts"
+    }
+  }
+}
diff --git a/src/database/public_api.ts b/src/database/public_api.ts
@@ -0,0 +1,2 @@
+export { Database, provideDatabase, DATABASE_INSTANCES } from '@angular/fire';
+export * from 'rxfire/database';
diff --git a/src/firestore/package.json b/src/firestore/package.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "../../node_modules/ng-packagr/package.schema.json",
+  "ngPackage": {
+    "lib": {
+      "umdModuleIds": {
+        "rxfire/firestore": "rxfire"
+      },
+      "entryFile": "public_api.ts"
+    }
+  }
+}
diff --git a/src/firestore/public_api.ts b/src/firestore/public_api.ts
@@ -0,0 +1,2 @@
+export { Firestore, provideFirestore, FIRESTORE_INSTANCES } from '@angular/fire';
+export * from 'rxfire/firestore';
diff --git a/src/functions/package.json b/src/functions/package.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "../../node_modules/ng-packagr/package.schema.json",
+  "ngPackage": {
+    "lib": {
+      "umdModuleIds": {
+        "rxfire/functions": "rxfire"
+      },
+      "entryFile": "public_api.ts"
+    }
+  }
+}
diff --git a/src/functions/public_api.ts b/src/functions/public_api.ts
@@ -0,0 +1,2 @@
+export { Functions, provideFunctions, FUNCTIONS_INSTANCES } from '@angular/fire';
+export * from 'rxfire/functions';
diff --git a/src/messaging/package.json b/src/messaging/package.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "../../node_modules/ng-packagr/package.schema.json",
+  "ngPackage": {
+    "lib": {
+      "umdModuleIds": {
+        "rxfire/messaging": "rxfire"
+      },
+      "entryFile": "public_api.ts"
+    }
+  }
+}
diff --git a/src/messaging/public_api.ts b/src/messaging/public_api.ts
@@ -0,0 +1 @@
+export { Messaging, provideMessaging, MESSAGING_INSTANCES } from '@angular/fire';
diff --git a/src/performance/package.json b/src/performance/package.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "../../node_modules/ng-packagr/package.schema.json",
+  "ngPackage": {
+    "lib": {
+      "umdModuleIds": {
+        "rxfire/performance": "rxfire"
+      },
+      "entryFile": "public_api.ts"
+    }
+  }
+}
diff --git a/src/performance/performance.module.ts b/src/performance/performance.module.ts
@@ -0,0 +1,66 @@
+import { NgModule, Optional, NgZone, InjectionToken } from '@angular/core';
+import { FirebasePerformance } from 'firebase/performance';
+
+import { ɵsmartCacheInstance, ɵfetchCachedInstance } from '../core';
+import { Performance } from './performance';
+import { DEFAULT_APP_NAME, FIREBASE_APPS } from '../app/app.module';
+
+export const PERFORMANCE_INSTANCES = new InjectionToken<Performance[]>('angularfire2.performance-instances');
+
+const CACHE_PREFIX = 'Performance';
+
+export function ɵdefaultPerformanceInstanceFactory(_: Performance[]) {
+  const performance = ɵfetchCachedInstance([CACHE_PREFIX, DEFAULT_APP_NAME].join('.'));
+  if (performance) {
+    return new Performance(performance);
+  }
+  throw new Error(`No Performance Instance provided for the '${DEFAULT_APP_NAME}' Firebase App - call providePerformance(...) in your providers list.`);
+}
+
+export function ɵwrapPerformanceInstanceInInjectable(performance: FirebasePerformance) {
+  return new Performance(performance);
+}
+
+export function ɵperformanceInstancesFactory(instances: Performance[]) {
+  return instances;
+}
+
+// Hack: useFactory doesn't allow us to pass a lambda, so let's bind the arugments
+// Going this direction to cut down on DI token noise; also making it easier to support
+// multiple Firebase Apps
+export function ɵboundPerformanceInstanceFactory(zone: NgZone) {
+  const performance = ɵsmartCacheInstance<FirebasePerformance>(CACHE_PREFIX, this);
+  return new Performance(performance);
+}
+
+const DEFAULT_PERFORMANCE_INSTANCE_PROVIDER = {
+  provide: Performance,
+  useFactory: ɵdefaultPerformanceInstanceFactory,
+  deps: [
+    NgZone,
+    [new Optional(), PERFORMANCE_INSTANCES ],
+  ]
+};
+
+@NgModule({
+  providers: [
+    DEFAULT_PERFORMANCE_INSTANCE_PROVIDER,
+  ]
+})
+export class AngularFirePerformanceModule {
+}
+
+export function providePerformance(fn: () => FirebasePerformance) {
+  return {
+    ngModule: AngularFirePerformanceModule,
+    providers: [{
+      provide: PERFORMANCE_INSTANCES,
+      useFactory: ɵboundPerformanceInstanceFactory.bind(fn),
+      multi: true,
+      deps: [
+        NgZone,
+        [new Optional(), FIREBASE_APPS ]
+      ]
+    }]
+  };
+}
diff --git a/src/performance/performance.ts b/src/performance/performance.ts
@@ -0,0 +1,11 @@
+import { FirebasePerformance } from 'firebase/performance';
+
+// see notes in core/firebase.app.module.ts for why we're building the class like this
+// tslint:disable-next-line:no-empty-interface
+export interface Performance extends FirebasePerformance {}
+
+export class Performance {
+  constructor(performance: FirebasePerformance) {
+    return performance;
+  }
+}
diff --git a/src/performance/public_api.ts b/src/performance/public_api.ts
@@ -0,0 +1,2 @@
+export { Performance, providePerformance, PERFORMANCE_INSTANCES } from '@angular/fire';
+export * from 'rxfire/performance';
diff --git a/src/public_api.ts b/src/public_api.ts
@@ -1,6 +1,9 @@
 export * from './core';
 export * from './zones';
 
+export * from './analytics/analytics';
+export * from './analytics/analytics.module';
+
 export * from './app/app';
 export * from './app/app.module';
 
@@ -19,6 +22,9 @@ export * from './functions/functions.module';
 export * from './messaging/messaging';
 export * from './messaging/messaging.module';
 
+export * from './performance/performance';
+export * from './performance/performance.module';
+
 export * from './remote-config/remote-config';
 export * from './remote-config/remote-config.module';
 
diff --git a/src/remote-config/package.json b/src/remote-config/package.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "../../node_modules/ng-packagr/package.schema.json",
+  "ngPackage": {
+    "lib": {
+      "umdModuleIds": {
+        "rxfire/remote-config": "rxfire"
+      },
+      "entryFile": "public_api.ts"
+    }
+  }
+}
diff --git a/src/remote-config/public_api.ts b/src/remote-config/public_api.ts
@@ -0,0 +1,2 @@
+export { RemoteConfig, provideRemoteConfig, REMOTE_CONFIG_INSTANCES } from '@angular/fire';
+export * from 'rxfire/remote-config';
diff --git a/src/storage/package.json b/src/storage/package.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "../../node_modules/ng-packagr/package.schema.json",
+  "ngPackage": {
+    "lib": {
+      "umdModuleIds": {
+        "rxfire/storage": "rxfire"
+      },
+      "entryFile": "public_api.ts"
+    }
+  }
+}
diff --git a/src/storage/public_api.ts b/src/storage/public_api.ts
@@ -0,0 +1,2 @@
+export { Storage, provideStorage, STORAGE_INSTANCES } from '@angular/fire';
+export * from 'rxfire/storage';
diff --git a/tools/build.ts b/tools/build.ts
@@ -8,9 +8,11 @@ import firebase from 'firebase/compat/app';
 
 // TODO infer these from the package.json
 const MODULES = [
-  'core', 'compat', 'compat/analytics', 'compat/auth-guard', 'compat/auth',
-  'compat/database', 'compat/firestore', 'compat/functions', 'compat/remote-config',
-  'compat/storage', 'compat/messaging', 'compat/performance'
+  'core', 'compat', 'analytics', 'auth', 'database', 'firestore', 'functions',
+  'remote-config', 'storage', 'messaging', 'performance', 'compat/analytics',
+  'compat/auth-guard', 'compat/auth', 'compat/database', 'compat/firestore',
+  'compat/functions', 'compat/remote-config', 'compat/storage', 'compat/messaging',
+  'compat/performance'
 ];
 const LAZY_MODULES = ['compat/analytics', 'compat/auth', 'compat/functions', 'compat/messaging', 'compat/remote-config'];
 const UMD_NAMES = MODULES.map(m => m === 'core' ? 'angular-fire' : `angular-fire-${m.replace('/', '-')}`);
@@ -142,15 +144,15 @@ async function buildDocs() {
     const buffer = await readFile(`./dist/typedocs/${module}.json`);
     const typedoc = JSON.parse(buffer.toString());
     if (!typedoc.children) {
-      console.log('typedoc fail', module);
+      console.error('typedoc fail', module);
     }
     // TODO infer the entryPoint from the package.json
     const entryPoint = typedoc.children.find((c: any) => c.name === '"public_api"');
     const allChildren = [].concat(...typedoc.children.map(child =>
       // TODO chop out the working directory and filename
       child.children ? child.children.map(c => ({ ...c, path: dirname(child.originalName.split(process.cwd())[1]) })) : []
     ));
-    return entryPoint.children
+    return (entryPoint.children || [])
       .filter(c => c.name[0] !== 'ɵ' && c.name[0] !== '_' /* private */)
       .map(child => ({ ...allChildren.find(c => child.target === c.id) }))
       .reduce((acc, child) => ({ ...acc, [encodeURIComponent(child.name)]: child }), {});

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +# Upgrading to AngularFire 7.0
++
 +Intended to be run with Angular 12, AngularFire 7.0 allows you to take full advtange of the new tree-shakable Firebase JS SDK (v9) while also providing a compatible expirience with the prior API.
++
 +**TBD**
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export { Analytics, provideAnalytics, ANALYTICS_INSTANCES } from '@angular/fire';`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export { FirebaseApp, provideFirebaseApp, FIREBASE_APPS } from '@angular/fire';`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export { Auth, provideAuth, AUTH_INSTANCES } from '@angular/fire';`
	`2`	`+export * from 'rxfire/auth';`