SEMVER notes on the DI tokens

Author: jamesdaniels

src/core/angularfire2.ts

@@ -3,6 +3,7 @@ import { isPlatformServer } from '@angular/common';
 import { Observable, Subscription, queueScheduler as queue } from 'rxjs';
 
 // Put in database.ts when we drop database-depreciated
+// SEMVER drop RealtimeDatabaseURL in favor of DATABASE_URL in next major
 export const RealtimeDatabaseURL = new InjectionToken<string>('angularfire2.realtimeDatabaseURL');
 export const DATABASE_URL = RealtimeDatabaseURL;
 

src/core/firebase.app.module.ts

@@ -7,6 +7,7 @@ import firebase from 'firebase/app'; // once fixed can pull in as "default as fi
 export type FirebaseOptions = {[key:string]: any};
 export type FirebaseAppConfig = {[key:string]: any};
 
+// SEMVER drop FirebaseOptionsToken and FirebaseNameOrConfigToken in favor of FIREBASE_OPTIONS and FIREBASE_APP_NAME in next major
 export const FirebaseOptionsToken = new InjectionToken<FirebaseOptions>('angularfire2.app.options');
 export const FirebaseNameOrConfigToken = new InjectionToken<string|FirebaseAppConfig|undefined>('angularfire2.app.nameOrConfig');
 

src/firestore/firestore.ts

@@ -17,6 +17,7 @@ import firebase from 'firebase/app';
 // SEMVER: have to import here while we target ng 6, as the version of typescript doesn't allow dynamic import of types
 import { firestore } from 'firebase/app';
 
+// SEMVER drop EnablePersistenceToken, PersistenceSettingsToken, and FirestoreSettingsToken in favor of new export names
 /**
  * The value of this token determines whether or not the firestore will have persistance enabled
  */
@@ -28,6 +29,7 @@ export const ENABLE_PERSISTENCE = EnablePersistenceToken;
 export const PERSISTENCE_SETTINGS = PersistenceSettingsToken
 export const FIRESTORE_SETTINGS = FirestoreSettingsToken;
 
+// SEMVER kill this in the next major
 // timestampsInSnapshots was depreciated in 5.8.0
 const major = parseInt(firebase.SDK_VERSION.split('.')[0]);
 const minor = parseInt(firebase.SDK_VERSION.split('.')[1]);

src/storage/storage.ts

@@ -6,8 +6,8 @@ import { FirebaseStorage, FirebaseOptions, FirebaseAppConfig, FirebaseZoneSchedu
 
 import { UploadMetadata } from './interfaces';
 
+// SEMVER drop StorageBucket in favor of STORAGE_BUCKET
 export const StorageBucket = new InjectionToken<string>('angularfire2.storageBucket');
-
 export const STORAGE_BUCKET = StorageBucket;
 
 /**