Importing RTDB code via @firebase/database

package.json

@@ -47,6 +47,8 @@
  ],
  "types": "./lib/index.d.ts",
  "dependencies": {
+ "@firebase/database": "^0.1.3",
+ "@firebase/app": "^0.1.1",
  "google-auth-library": "^0.10.0",
  "@google-cloud/storage": "^1.2.1",
  "@google-cloud/firestore": "~0.8.2",

src/database/database.ts

@@ -0,0 +1,86 @@
+import {FirebaseApp} from '../firebase-app';
+import {FirebaseDatabaseError} from '../utils/error';
+import {FirebaseServiceInterface, FirebaseServiceInternalsInterface} from '../firebase-service';
+import {Database} from '@firebase/database';
+
+import * as validator from '../utils/validator';
+
+
+/**
+ * Internals of a Database instance.
+ */
+class DatabaseInternals implements FirebaseServiceInternalsInterface {
+
+ public databases: {
+ [dbUrl: string]: Database
+ } = {};
+
+ /**
+ * Deletes the service and its associated resources.
+ *
+ * @return {Promise<()>} An empty Promise that will be fulfilled when the service is deleted.
+ */
+ public delete(): Promise<void> {
+ for (const dbUrl of Object.keys(this.databases)) {
+ let db: Database = this.databases[dbUrl];
+ db.INTERNAL.delete();
+ }
+ return Promise.resolve(undefined);
+ }
+}
+
+export class DatabaseService implements FirebaseServiceInterface {
+
+ public INTERNAL: DatabaseInternals = new DatabaseInternals();
+
+ private appInternal: FirebaseApp;
+
+ constructor(app: FirebaseApp) {
+ if (!validator.isNonNullObject(app) || !('options' in app)) {
+ throw new FirebaseDatabaseError({
+ code: 'invalid-argument',
+ message: 'First argument passed to admin.database() must be a valid Firebase app instance.',
+ });
+ }
+ this.appInternal = app;
+ }
+
+ /**
+ * Returns the app associated with this DatabaseService instance.
+ *
+ * @return {FirebaseApp} The app associated with this DatabaseService instance.
+ */
+ get app(): FirebaseApp {
+ return this.appInternal;
+ }
+
+ public getDatabase(url?: string): Database {
+ let dbUrl: string = this.ensureUrl(url);
+ if (!validator.isNonEmptyString(dbUrl)) {
+ throw new FirebaseDatabaseError({
+ code: 'invalid-argument',
+ message: 'Database URL must be a valid, non-empty URL string.',
+ });
+ }
+
+ let db: Database = this.INTERNAL.databases[dbUrl];
+ if (typeof db === 'undefined') {
+ let rtdb = require('@firebase/database');
+ db = rtdb.initStandalone(this.appInternal, dbUrl).instance;
+ this.INTERNAL.databases[dbUrl] = db;
+ }
+ return db;
+ }
+
+ private ensureUrl(url?: string): string {
+ if (typeof url !== 'undefined') {
+ return url;
+ } else if (typeof this.appInternal.options.databaseURL !== 'undefined') {
+ return this.appInternal.options.databaseURL;
+ }
+ throw new FirebaseDatabaseError({
+ code: 'invalid-argument',
+ message: 'Can\'t determine Firebase Database URL.',
+ });
+ }
+}

src/firebase-app.ts

@@ -21,12 +21,14 @@ import {GoogleOAuthAccessToken} from './auth/credential';
 import {FirebaseServiceInterface} from './firebase-service';
 import {FirebaseNamespaceInternals} from './firebase-namespace';
 import {AppErrorCodes, FirebaseAppError} from './utils/error';
-import {Firestore} from '@google-cloud/firestore';
-import {FirestoreService} from './firestore/firestore';
 
 import {Auth} from './auth/auth';
 import {Messaging} from './messaging/messaging';
 import {Storage} from './storage/storage';
+import {Database} from '@firebase/database';
+import {DatabaseService} from './database/database';
+import {Firestore} from '@google-cloud/firestore';
+import {FirestoreService} from './firestore/firestore';
 
 /**
  * Type representing a callback which is called every time an app lifecycle event occurs.
@@ -290,12 +292,16 @@ export class FirebaseApp {
  });
  }
 
- /* istanbul ignore next */
- public database(): FirebaseServiceInterface {
- throw new FirebaseAppError(
- AppErrorCodes.INTERNAL_ERROR,
- 'INTERNAL ASSERT FAILED: Firebase database() service has not been registered.',
- );
+ /**
+ * Returns the Database service for the specified URL, and the current app.
+ *
+ * @return {Database} The Database service instance of this app.
+ */
+ public database(url?: string): Database {
+ let service: DatabaseService = this.ensureService_('database', () => {
+ return new DatabaseService(this);
+ });
+ return service.getDatabase(url);
  }
 
  /**

src/firebase-namespace.ts

@@ -24,11 +24,12 @@ import {
  RefreshTokenCredential,
  ApplicationDefaultCredential,
 } from './auth/credential';
-import {Firestore} from '@google-cloud/firestore';
 
 import {Auth} from './auth/auth';
 import {Messaging} from './messaging/messaging';
 import {Storage} from './storage/storage';
+import {Database} from '@firebase/database';
+import {Firestore} from '@google-cloud/firestore';
 
 const DEFAULT_APP_NAME = '[DEFAULT]';
 
@@ -289,12 +290,16 @@ export class FirebaseNamespace {
  return Object.assign(fn, {Auth});
  }
 
- /* istanbul ignore next */
- public database(): FirebaseServiceInterface {
- throw new FirebaseAppError(
- AppErrorCodes.INTERNAL_ERROR,
- 'INTERNAL ASSERT FAILED: Firebase database() service has not been registered.',
- );
+ /**
+ * Gets the `Database` service namespace. The returned namespace can be used to get the
+ * `Database` service for the default app or an explicitly specified app.
+ */
+ get database(): FirebaseServiceNamespace<Database> {
+ const ns: FirebaseNamespace = this;
+ let fn: FirebaseServiceNamespace<Database> = (app?: FirebaseApp) => {
+ return ns.ensureApp(app).database();
+ };
+ return Object.assign(fn, require('@firebase/database'));
  }
 
  /**

src/index.d.ts

@@ -15,6 +15,7 @@
  */
 
 import {Bucket} from '@google-cloud/storage';
+import * as _rtdb from '@firebase/database';
 import * as _firestore from '@google-cloud/firestore';
 
 declare namespace admin {
@@ -67,7 +68,7 @@ declare namespace admin.app {
  options: admin.AppOptions;
 
  auth(): admin.auth.Auth;
- database(): admin.database.Database;
+ database(url?: string): admin.database.Database;
  firestore(): admin.firestore.Firestore;
  messaging(): admin.messaging.Messaging;
  storage(): admin.storage.Storage;
@@ -174,117 +175,6 @@ 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;
- 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;
-
- 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, Promise<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;
@@ -405,6 +295,16 @@ 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;
+}
+
 declare namespace admin.firestore {
  export import FieldPath = _firestore.FieldPath;
  export import FieldValue = _firestore.FieldValue;

src/index.ts

@@ -20,7 +20,7 @@ import * as firebase from './default-namespace';
 // For historical reasons, the database code is included as minified code and registers itself
 // as a side effect of requiring the file.
 /* tslint:disable:no-var-requires */
-require('./database/database');
+// require('./database/database');
 /* tslint:enable:no-var-requires */
 
 export = firebase;

src/utils/error.ts

@@ -176,6 +176,21 @@ export class FirebaseAuthError extends PrefixedFirebaseError {
  }
 }
 
+/**
+ * Firebase Database error code structure. This extends FirebaseError.
+ *
+ * @param {ErrorInfo} info The error code info.
+ * @param {string} [message] The error message. This will override the default
+ * message if provided.
+ * @constructor
+ */
+export class FirebaseDatabaseError extends FirebaseError {
+ constructor(info: ErrorInfo, message?: string) {
+ // Override default message if custom message provided.
+ super({code: 'database/' + info.code, message: message || info.message});
+ }
+}
+
 /**
  * Firebase Firestore error code structure. This extends FirebaseError.
  *