Adding the RTDB typings back (#140)

* Adding the RTDB typings back * Updated RTDB typings
firebase · Nov 20, 2017 · b6edf5a · b6edf5a
1 parent 3757aa9
commit b6edf5a
Show file tree

Hide file tree

Showing 2 changed files with 115 additions and 15 deletions.
diff --git a/src/index.d.ts b/src/index.d.ts
@@ -15,7 +15,6 @@
  */
 
 import {Bucket} from '@google-cloud/storage';
-import * as _rtdb from '@firebase/database';
 import * as _firestore from '@google-cloud/firestore';
 
 declare namespace admin {
@@ -175,6 +174,119 @@ declare namespace admin.credential {
   function refreshToken(refreshTokenPathOrObject: string|Object): admin.credential.Credential;
 }
 
+declare namespace admin.database {
+  interface Database {
+    app: admin.app.App;
+
+    goOffline(): void;
+    goOnline(): void;
+    ref(path?: string): admin.database.Reference;
+    refFromURL(url: string): admin.database.Reference;
+  }
+
+  interface DataSnapshot {
+    key: string|null;
+    ref: admin.database.Reference;
+
+    child(path: string): admin.database.DataSnapshot;
+    exists(): boolean;
+    exportVal(): any;
+    forEach(action: (a: admin.database.DataSnapshot) => boolean): boolean;
+    getPriority(): string|number|null;
+    hasChild(path: string): boolean;
+    hasChildren(): boolean;
+    numChildren(): number;
+    toJSON(): Object | null;
+    val(): any;
+  }
+
+  interface OnDisconnect {
+    cancel(onComplete?: (a: Error|null) => any): Promise<void>;
+    remove(onComplete?: (a: Error|null) => any): Promise<void>;
+    set(value: any, onComplete?: (a: Error|null) => any): Promise<void>;
+    setWithPriority(
+      value: any,
+      priority: number|string|null,
+      onComplete?: (a: Error|null) => any
+    ): Promise<void>;
+    update(values: Object, onComplete?: (a: Error|null) => any): Promise<void>;
+  }
+
+  type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';
+
+  interface Query {
+    ref: admin.database.Reference;
+
+    endAt(value: number|string|boolean|null, key?: string): admin.database.Query;
+    equalTo(value: number|string|boolean|null, key?: string): admin.database.Query;
+    isEqual(other: admin.database.Query|null): boolean;
+    limitToFirst(limit: number): admin.database.Query;
+    limitToLast(limit: number): admin.database.Query;
+    off(
+      eventType?: admin.database.EventType,
+      callback?: (a: admin.database.DataSnapshot, b?: string|null) => any,
+      context?: Object|null
+    ): void;
+    on(
+      eventType: admin.database.EventType,
+      callback: (a: admin.database.DataSnapshot|null, b?: string) => any,
+      cancelCallbackOrContext?: Object|null,
+      context?: Object|null
+    ): (a: admin.database.DataSnapshot|null, b?: string) => any;
+    once(
+      eventType: admin.database.EventType,
+      successCallback?: (a: admin.database.DataSnapshot, b?: string) => any,
+      failureCallbackOrContext?: Object|null,
+      context?: Object|null
+    ): Promise<any>;
+    orderByChild(path: string): admin.database.Query;
+    orderByKey(): admin.database.Query;
+    orderByPriority(): admin.database.Query;
+    orderByValue(): admin.database.Query;
+    startAt(value: number|string|boolean|null, key?: string): admin.database.Query;
+    toJSON(): Object;
+    toString(): string;
+  }
+
+  interface Reference extends admin.database.Query {
+    key: string|null;
+    parent: admin.database.Reference|null;
+    root: admin.database.Reference;
+    path: string;
+
+    child(path: string): admin.database.Reference;
+    onDisconnect(): admin.database.OnDisconnect;
+    push(value?: any, onComplete?: (a: Error|null) => any): admin.database.ThenableReference;
+    remove(onComplete?: (a: Error|null) => any): Promise<void>;
+    set(value: any, onComplete?: (a: Error|null) => any): Promise<void>;
+    setPriority(
+      priority: string|number|null,
+      onComplete: (a: Error|null) => any
+    ): Promise<void>;
+    setWithPriority(
+      newVal: any, newPriority: string|number|null,
+      onComplete?: (a: Error|null) => any
+    ): Promise<void>;
+    transaction(
+      transactionUpdate: (a: any) => any,
+      onComplete?: (a: Error|null, b: boolean, c: admin.database.DataSnapshot|null) => any,
+      applyLocally?: boolean
+    ): Promise<{
+      committed: boolean,
+      snapshot: admin.database.DataSnapshot|null
+    }>;
+    update(values: Object, onComplete?: (a: Error|null) => any): Promise<void>;
+  }
+
+  interface ThenableReference extends admin.database.Reference, PromiseLike<any> {}
+
+  function enableLogging(logger?: boolean|((message: string) => any), persistent?: boolean): any;
+}
+
+declare namespace admin.database.ServerValue {
+  var TIMESTAMP: number;
+}
+
 declare namespace admin.messaging {
   type DataMessagePayload = {
     [key: string]: string;
@@ -295,18 +407,6 @@ declare namespace admin.storage {
   }
 }
 
-declare namespace admin.database {
-  export import Database = _rtdb.Database;
-  export import Reference = _rtdb.Reference;
-  export import Query = _rtdb.Query;
-  export import ServerValue = _rtdb.ServerValue;
-  export import enableLogging = _rtdb.enableLogging;
-  export import OnDisconnect = _rtdb.OnDisconnect;
-  export import DataSnapshot = _rtdb.DataSnapshot;
-
-  type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';
-}
-
 declare namespace admin.firestore {
   export import FieldPath = _firestore.FieldPath;
   export import FieldValue = _firestore.FieldValue;

diff --git a/test/integration/typescript/src/example.test.ts b/test/integration/typescript/src/example.test.ts
@@ -32,12 +32,12 @@ describe('Init App', () => {
 
     it('Should return a Database client', () => {
         const db = admin.database(app);
-        expect(db).to.be.instanceOf(admin.database.Database);
+        expect(db).to.be.instanceOf((admin.database as any).Database);
     });
 
     it('Should return a Database client for URL', () => {
         const db = app.database('https://other-mock.firebaseio.com');
-        expect(db).to.be.instanceOf(admin.database.Database);
+        expect(db).to.be.instanceOf((admin.database as any).Database);
     });
 
     it('Should return a Database ServerValue', () => {