update Reference to DatabaseReference

Feiyang1 · Feiyang1 · commit bac86bff552d · 2021-07-09T16:43:02.000-07:00
diff --git a/common/api-review/database.api.md b/common/api-review/database.api.md
@@ -8,14 +8,21 @@ import { EmulatorMockTokenOptions } from '@firebase/util';
 import { FirebaseApp } from '@firebase/app';
 
 // @public
-export function child(parent: Reference, path: string): Reference;
+export function child(parent: DatabaseReference, path: string): DatabaseReference;
 
 // @public
 export class Database {
     readonly app: FirebaseApp;
     readonly 'type' = "database";
 }
 
+// @public
+export interface DatabaseReference extends Query {
+    readonly key: string | null;
+    readonly parent: DatabaseReference | null;
+    readonly root: DatabaseReference;
+}
+
 // @public
 export class DataSnapshot {
     child(path: string): DataSnapshot;
@@ -26,7 +33,7 @@ export class DataSnapshot {
     hasChildren(): boolean;
     get key(): string | null;
     get priority(): string | number | null;
-    readonly ref: Reference;
+    readonly ref: DatabaseReference;
     get size(): number;
     toJSON(): object | null;
     val(): any;
@@ -125,7 +132,7 @@ export class OnDisconnect {
 }
 
 // @public
-export function onDisconnect(ref: Reference): OnDisconnect;
+export function onDisconnect(ref: DatabaseReference): OnDisconnect;
 
 // @public
 export function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
@@ -149,12 +156,12 @@ export function orderByPriority(): QueryConstraint;
 export function orderByValue(): QueryConstraint;
 
 // @public
-export function push(parent: Reference, value?: unknown): ThenableReference;
+export function push(parent: DatabaseReference, value?: unknown): ThenableReference;
 
 // @public
 export interface Query {
     isEqual(other: Query | null): boolean;
-    readonly ref: Reference;
+    readonly ref: DatabaseReference;
     toJSON(): string;
     toString(): string;
 }
@@ -171,35 +178,28 @@ export abstract class QueryConstraint {
 export type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';
 
 // @public
-export function ref(db: Database, path?: string): Reference;
-
-// @public
-export interface Reference extends Query {
-    readonly key: string | null;
-    readonly parent: Reference | null;
-    readonly root: Reference;
-}
+export function ref(db: Database, path?: string): DatabaseReference;
 
 // @public
-export function refFromURL(db: Database, url: string): Reference;
+export function refFromURL(db: Database, url: string): DatabaseReference;
 
 // @public
-export function remove(ref: Reference): Promise<void>;
+export function remove(ref: DatabaseReference): Promise<void>;
 
 // @public
-export function runTransaction(ref: Reference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;
+export function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;
 
 // @public
 export function serverTimestamp(): object;
 
 // @public
-export function set(ref: Reference, value: unknown): Promise<void>;
+export function set(ref: DatabaseReference, value: unknown): Promise<void>;
 
 // @public
-export function setPriority(ref: Reference, priority: string | number | null): Promise<void>;
+export function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;
 
 // @public
-export function setWithPriority(ref: Reference, value: unknown, priority: string | number | null): Promise<void>;
+export function setWithPriority(ref: DatabaseReference, value: unknown, priority: string | number | null): Promise<void>;
 
 // @public
 export function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;
@@ -208,7 +208,7 @@ export function startAfter(value: number | string | boolean | null, key?: string
 export function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;
 
 // @public
-export interface ThenableReference extends Reference, Pick<Promise<Reference>, 'then' | 'catch'> {
+export interface ThenableReference extends DatabaseReference, Pick<Promise<DatabaseReference>, 'then' | 'catch'> {
 }
 
 // @public
@@ -227,7 +227,7 @@ export class TransactionResult {
 export type Unsubscribe = () => void;
 
 // @public
-export function update(ref: Reference, values: object): Promise<void>;
+export function update(ref: DatabaseReference, values: object): Promise<void>;
 
 // @public
 export function useDatabaseEmulator(db: Database, host: string, port: number, options?: {
diff --git a/packages/database/exp/api.ts b/packages/database/exp/api.ts
@@ -26,7 +26,7 @@ export {
 } from '../src/exp/Database';
 export {
   Query,
-  Reference,
+  DatabaseReference,
   ListenOptions,
   Unsubscribe,
   ThenableReference
diff --git a/packages/database/src/exp/Reference.ts b/packages/database/src/exp/Reference.ts
@@ -27,23 +27,23 @@ import { QueryContext } from '../core/view/EventRegistration';
  * suitable for synchronizing to the client. Queries are created by chaining
  * together one or more of the filter methods defined here.
  *
- * Just as with a `Reference`, you can receive data from a `Query` by using the
+ * Just as with a `DatabaseReference`, you can receive data from a `Query` by using the
  * `on*()` methods. You will only receive events and `DataSnapshot`s for the
  * subset of the data that matches your query.
  *
  * See {@link https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data}
  * for more information.
  */
 export interface Query extends QueryContext {
-  /** The `Reference` for the `Query`'s location. */
-  readonly ref: Reference;
+  /** The `DatabaseReference` for the `Query`'s location. */
+  readonly ref: DatabaseReference;
 
   /**
    * Returns whether or not the current and provided queries represent the same
    * location, have the same query parameters, and are from the same instance of
    * `FirebaseApp`.
    *
-   * Two `Reference` objects are equivalent if they represent the same location
+   * Two `DatabaseReference` objects are equivalent if they represent the same location
    * and are from the same instance of `FirebaseApp`.
    *
    * Two `Query` objects are equivalent if they represent the same location,
@@ -80,7 +80,7 @@ export interface Query extends QueryContext {
 }
 
 /**
- * A `Reference` represents a specific location in your Database and can be used
+ * A `DatabaseReference` represents a specific location in your Database and can be used
  * for reading or writing data to that Database location.
  *
  * You can reference the root or child location in your Database by calling
@@ -90,36 +90,36 @@ export interface Query extends QueryContext {
  * `on*()` method. See {@link
  * https://firebase.google.com/docs/database/web/read-and-write}
  */
-export interface Reference extends Query {
+export interface DatabaseReference extends Query {
   /**
-   * The last part of the `Reference`'s path.
+   * The last part of the `DatabaseReference`'s path.
    *
    * For example, `"ada"` is the key for
    * `https://<DATABASE_NAME>.firebaseio.com/users/ada`.
    *
-   * The key of a root `Reference` is `null`.
+   * The key of a root `DatabaseReference` is `null`.
    */
   readonly key: string | null;
 
   /**
-   * The parent location of a `Reference`.
+   * The parent location of a `DatabaseReference`.
    *
-   * The parent of a root `Reference` is `null`.
+   * The parent of a root `DatabaseReference` is `null`.
    */
-  readonly parent: Reference | null;
+  readonly parent: DatabaseReference | null;
 
-  /** The root `Reference` of the Database. */
-  readonly root: Reference;
+  /** The root `DatabaseReference` of the Database. */
+  readonly root: DatabaseReference;
 }
 
 /**
- * A `Promise` that can also act as a `Reference` when returned by
+ * A `Promise` that can also act as a `DatabaseReference` when returned by
  * {@link push}. The reference is available immediately and the Promise resolves
  * as the write to the backend completes.
  */
 export interface ThenableReference
-  extends Reference,
-    Pick<Promise<Reference>, 'then' | 'catch'> {}
+  extends DatabaseReference,
+    Pick<Promise<DatabaseReference>, 'then' | 'catch'> {}
 
 /** A callback that can invoked to remove a listener. */
 export type Unsubscribe = () => void;
@@ -131,5 +131,5 @@ export interface ListenOptions {
 }
 
 export interface ReferenceConstructor {
-  new (repo: Repo, path: Path): Reference;
+  new (repo: Repo, path: Path): DatabaseReference;
 }
diff --git a/packages/database/src/exp/Reference_impl.ts b/packages/database/src/exp/Reference_impl.ts
@@ -89,7 +89,7 @@ import { OnDisconnect } from './OnDisconnect';
 import {
   ListenOptions,
   Query as Query,
-  Reference as Reference,
+  DatabaseReference,
   Unsubscribe,
   ThenableReference
 } from './Reference';
@@ -116,7 +116,7 @@ export class QueryImpl implements Query, QueryContext {
     }
   }
 
-  get ref(): Reference {
+  get ref(): DatabaseReference {
     return new ReferenceImpl(this._repo, this._path);
   }
 
@@ -250,7 +250,7 @@ function validateLimit(params: QueryParams) {
 /**
  * @internal
  */
-export class ReferenceImpl extends QueryImpl implements Reference {
+export class ReferenceImpl extends QueryImpl implements DatabaseReference {
   /** @hideconstructor */
   constructor(repo: Repo, path: Path) {
     super(repo, path, new QueryParams(), false);
@@ -298,7 +298,7 @@ export class DataSnapshot {
     /**
      * The location of this DataSnapshot.
      */
-    readonly ref: Reference,
+    readonly ref: DatabaseReference,
     readonly _index: Index
   ) {}
 
@@ -477,7 +477,7 @@ export class DataSnapshot {
  *   pointing to the provided path. Otherwise, a `Reference` pointing to the
  *   root of the Database.
  */
-export function ref(db: Database, path?: string): Reference {
+export function ref(db: Database, path?: string): DatabaseReference {
   db = getModularInstance(db);
   db._checkNotDeleted('ref');
   return path !== undefined ? child(db._root, path) : db._root;
@@ -499,7 +499,7 @@ export function ref(db: Database, path?: string): Reference {
  * @returns A `Reference` pointing to the provided
  *   Firebase URL.
  */
-export function refFromURL(db: Database, url: string): Reference {
+export function refFromURL(db: Database, url: string): DatabaseReference {
   db = getModularInstance(db);
   db._checkNotDeleted('refFromURL');
   const parsedURL = parseRepoInfo(url, db._repo.repoInfo_.nodeAdmin);
@@ -535,7 +535,10 @@ export function refFromURL(db: Database, url: string): Reference {
  *   location.
  * @returns The specified child location.
  */
-export function child(parent: Reference, path: string): Reference {
+export function child(
+  parent: DatabaseReference,
+  path: string
+): DatabaseReference {
   parent = getModularInstance(parent);
   if (pathGetFront(parent._path) === null) {
     validateRootPathString('child', 'path', path, false);
@@ -552,7 +555,7 @@ export function child(parent: Reference, path: string): Reference {
  *
  * @param ref - The reference to add OnDisconnect triggers for.
  */
-export function onDisconnect(ref: Reference): OnDisconnect {
+export function onDisconnect(ref: DatabaseReference): OnDisconnect {
   ref = getModularInstance(ref) as ReferenceImpl;
   return new OnDisconnect(ref._repo, ref._path);
 }
@@ -584,7 +587,10 @@ export interface ThenableReferenceImpl
  * @returns Combined `Promise` and `Reference`; resolves when write is complete,
  * but can be used immediately as the `Reference` to the child location.
  */
-export function push(parent: Reference, value?: unknown): ThenableReference {
+export function push(
+  parent: DatabaseReference,
+  value?: unknown
+): ThenableReference {
   parent = getModularInstance(parent);
   validateWritablePath('push', parent._path);
   validateFirebaseDataArg('push', value, parent._path, true);
@@ -629,7 +635,7 @@ export function push(parent: Reference, value?: unknown): ThenableReference {
  * @param ref - The location to remove.
  * @returns Resolves when remove on server is complete.
  */
-export function remove(ref: Reference): Promise<void> {
+export function remove(ref: DatabaseReference): Promise<void> {
   validateWritablePath('remove', ref._path);
   return set(ref, null);
 }
@@ -663,7 +669,7 @@ export function remove(ref: Reference): Promise<void> {
  *   array, or null).
  * @returns Resolves when write to server is complete.
  */
-export function set(ref: Reference, value: unknown): Promise<void> {
+export function set(ref: DatabaseReference, value: unknown): Promise<void> {
   ref = getModularInstance(ref);
   validateWritablePath('set', ref._path);
   validateFirebaseDataArg('set', value, ref._path, false);
@@ -691,7 +697,7 @@ export function set(ref: Reference, value: unknown): Promise<void> {
  * @returns Resolves when write to server is complete.
  */
 export function setPriority(
-  ref: Reference,
+  ref: DatabaseReference,
   priority: string | number | null
 ): Promise<void> {
   ref = getModularInstance(ref);
@@ -724,7 +730,7 @@ export function setPriority(
  * @returns Resolves when write to server is complete.
  */
 export function setWithPriority(
-  ref: Reference,
+  ref: DatabaseReference,
   value: unknown,
   priority: string | number | null
 ): Promise<void> {
@@ -781,7 +787,7 @@ export function setWithPriority(
  * @param values - Object containing multiple values.
  * @returns Resolves when update on server is complete.
  */
-export function update(ref: Reference, values: object): Promise<void> {
+export function update(ref: DatabaseReference, values: object): Promise<void> {
   validateFirebaseMergeDataArg('update', values, ref._path, false);
   const deferred = new Deferred<void>();
   repoUpdate(
diff --git a/packages/database/src/exp/Transaction.ts b/packages/database/src/exp/Transaction.ts
@@ -22,7 +22,7 @@ import { PRIORITY_INDEX } from '../core/snap/indexes/PriorityIndex';
 import { Node } from '../core/snap/Node';
 import { validateWritablePath } from '../core/util/validation';
 
-import { Reference } from './Reference';
+import { DatabaseReference } from './Reference';
 import { DataSnapshot, onValue, ReferenceImpl } from './Reference_impl';
 
 /** An options object to configure transactions. */
@@ -92,7 +92,7 @@ export class TransactionResult {
  * callback to handle success and failure.
  */
 export function runTransaction(
-  ref: Reference,
+  ref: DatabaseReference,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   transactionUpdate: (currentData: any) => unknown,
   options?: TransactionOptions
