@firebase/database-compat 0.1.1-2021823172527 → 0.1.2-canary.0b3ca78eb

package/src/api/internal.ts

@@ -1,91 +0,0 @@
-/**
- * @license
- * Copyright 2017 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import { FirebaseApp } from '@firebase/app-types';
-import {
-  FirebaseAuthInternal,
-  FirebaseAuthInternalName
-} from '@firebase/auth-interop-types';
-import {
-  Component,
-  ComponentContainer,
-  ComponentType,
-  Provider
-} from '@firebase/component';
-import {
-  _repoManagerDatabaseFromApp,
-  _setSDKVersion
-} from '@firebase/database';
-import * as types from '@firebase/database-types';
-
-import { Database } from './Database';
-
-/**
- * Used by console to create a database based on the app,
- * passed database URL and a custom auth implementation.
- *
- * @param app - A valid FirebaseApp-like object
- * @param url - A valid Firebase databaseURL
- * @param version - custom version e.g. firebase-admin version
- * @param customAuthImpl - custom auth implementation
- */
-export function initStandalone<T>({
-  app,
-  url,
-  version,
-  customAuthImpl,
-  namespace,
-  nodeAdmin = false
-}: {
-  app: FirebaseApp;
-  url: string;
-  version: string;
-  customAuthImpl: FirebaseAuthInternal;
-  namespace: T;
-  nodeAdmin?: boolean;
-}): {
-  instance: types.Database;
-  namespace: T;
-} {
-  _setSDKVersion(version);
-
-  /**
-   * ComponentContainer('database-standalone') is just a placeholder that doesn't perform
-   * any actual function.
-   */
-  const authProvider = new Provider<FirebaseAuthInternalName>(
-    'auth-internal',
-    new ComponentContainer('database-standalone')
-  );
-  authProvider.setComponent(
-    new Component('auth-internal', () => customAuthImpl, ComponentType.PRIVATE)
-  );
-
-  return {
-    instance: new Database(
-      _repoManagerDatabaseFromApp(
-        app,
-        authProvider,
-        /* appCheckProvider= */ undefined,
-        url,
-        nodeAdmin
-      ),
-      app
-    ) as types.Database,
-    namespace
-  };
-}

package/src/api/onDisconnect.ts

@@ -1,112 +0,0 @@
-/**
- * @license
- * Copyright 2017 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import { OnDisconnect as ModularOnDisconnect } from '@firebase/database';
-import { validateArgCount, validateCallback, Compat } from '@firebase/util';
-
-import { warn } from '../util/util';
-export class OnDisconnect implements Compat<ModularOnDisconnect> {
-  constructor(readonly _delegate: ModularOnDisconnect) {}
-
-  cancel(onComplete?: (a: Error | null) => void): Promise<void> {
-    validateArgCount('OnDisconnect.cancel', 0, 1, arguments.length);
-    validateCallback('OnDisconnect.cancel', 'onComplete', onComplete, true);
-    const result = this._delegate.cancel();
-    if (onComplete) {
-      result.then(
-        () => onComplete(null),
-        error => onComplete(error)
-      );
-    }
-    return result;
-  }
-
-  remove(onComplete?: (a: Error | null) => void): Promise<void> {
-    validateArgCount('OnDisconnect.remove', 0, 1, arguments.length);
-    validateCallback('OnDisconnect.remove', 'onComplete', onComplete, true);
-    const result = this._delegate.remove();
-    if (onComplete) {
-      result.then(
-        () => onComplete(null),
-        error => onComplete(error)
-      );
-    }
-    return result;
-  }
-
-  set(value: unknown, onComplete?: (a: Error | null) => void): Promise<void> {
-    validateArgCount('OnDisconnect.set', 1, 2, arguments.length);
-    validateCallback('OnDisconnect.set', 'onComplete', onComplete, true);
-    const result = this._delegate.set(value);
-    if (onComplete) {
-      result.then(
-        () => onComplete(null),
-        error => onComplete(error)
-      );
-    }
-    return result;
-  }
-
-  setWithPriority(
-    value: unknown,
-    priority: number | string | null,
-    onComplete?: (a: Error | null) => void
-  ): Promise<void> {
-    validateArgCount('OnDisconnect.setWithPriority', 2, 3, arguments.length);
-    validateCallback(
-      'OnDisconnect.setWithPriority',
-      'onComplete',
-      onComplete,
-      true
-    );
-    const result = this._delegate.setWithPriority(value, priority);
-    if (onComplete) {
-      result.then(
-        () => onComplete(null),
-        error => onComplete(error)
-      );
-    }
-    return result;
-  }
-
-  update(
-    objectToMerge: Record<string, unknown>,
-    onComplete?: (a: Error | null) => void
-  ): Promise<void> {
-    validateArgCount('OnDisconnect.update', 1, 2, arguments.length);
-    if (Array.isArray(objectToMerge)) {
-      const newObjectToMerge: { [k: string]: unknown } = {};
-      for (let i = 0; i < objectToMerge.length; ++i) {
-        newObjectToMerge['' + i] = objectToMerge[i];
-      }
-      objectToMerge = newObjectToMerge;
-      warn(
-        'Passing an Array to firebase.database.onDisconnect().update() is deprecated. Use set() if you want to overwrite the ' +
-          'existing data, or an Object with integer keys if you really do want to only update some of the children.'
-      );
-    }
-    validateCallback('OnDisconnect.update', 'onComplete', onComplete, true);
-    const result = this._delegate.update(objectToMerge);
-    if (onComplete) {
-      result.then(
-        () => onComplete(null),
-        error => onComplete(error)
-      );
-    }
-    return result;
-  }
-}

package/src/index.node.ts

@@ -1,142 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import { FirebaseApp, FirebaseNamespace } from '@firebase/app-types';
-import { _FirebaseNamespace } from '@firebase/app-types/private';
-import { FirebaseAuthInternal } from '@firebase/auth-interop-types';
-import { Component, ComponentType } from '@firebase/component';
-import { enableLogging } from '@firebase/database';
-import * as types from '@firebase/database-types';
-import { CONSTANTS, isNodeSdk } from '@firebase/util';
-
-import { name, version } from '../package.json';
-import { Database } from '../src/api/Database';
-import * as INTERNAL from '../src/api/internal';
-import { DataSnapshot, Query, Reference } from '../src/api/Reference';
-
-const ServerValue = Database.ServerValue;
-
-/**
- * A one off register function which returns a database based on the app and
- * passed database URL. (Used by the Admin SDK)
- *
- * @param app - A valid FirebaseApp-like object
- * @param url - A valid Firebase databaseURL
- * @param version - custom version e.g. firebase-admin version
- * @param nodeAdmin - true if the SDK is being initialized from Firebase Admin.
- */
-export function initStandalone(
-  app: FirebaseApp,
-  url: string,
-  version: string,
-  nodeAdmin = true
-) {
-  CONSTANTS.NODE_ADMIN = nodeAdmin;
-  return INTERNAL.initStandalone({
-    app,
-    url,
-    version,
-    // firebase-admin-node's app.INTERNAL implements FirebaseAuthInternal interface
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    customAuthImpl: (app as any).INTERNAL as FirebaseAuthInternal,
-    namespace: {
-      Reference,
-      Query,
-      Database,
-      DataSnapshot,
-      enableLogging,
-      INTERNAL,
-      ServerValue
-    },
-    nodeAdmin
-  });
-}
-
-export function registerDatabase(instance: FirebaseNamespace) {
-  // Register the Database Service with the 'firebase' namespace.
-  const namespace = (instance as _FirebaseNamespace).INTERNAL.registerComponent(
-    new Component(
-      'database-compat',
-      (container, { instanceIdentifier: url }) => {
-        /* Dependencies */
-        // getImmediate for FirebaseApp will always succeed
-        const app = container.getProvider('app-compat').getImmediate();
-        const databaseExp = container
-          .getProvider('database')
-          .getImmediate({ identifier: url });
-        return new Database(databaseExp, app);
-      },
-      ComponentType.PUBLIC
-    )
-      .setServiceProps(
-        // firebase.database namespace properties
-        {
-          Reference,
-          Query,
-          Database,
-          DataSnapshot,
-          enableLogging,
-          INTERNAL,
-          ServerValue
-        }
-      )
-      .setMultipleInstances(true)
-  );
-
-  instance.registerVersion(name, version, 'node');
-
-  if (isNodeSdk()) {
-    module.exports = Object.assign({}, namespace, { initStandalone });
-  }
-}
-
-try {
-  // If @firebase/app is not present, skip registering database.
-  // It could happen when this package is used in firebase-admin which doesn't depend on @firebase/app.
-  // Previously firebase-admin depends on @firebase/app, which causes version conflict on
-  // @firebase/app when used together with the js sdk. More detail:
-  // https://github.com/firebase/firebase-js-sdk/issues/1696#issuecomment-501546596
-  // eslint-disable-next-line import/no-extraneous-dependencies, @typescript-eslint/no-require-imports
-  const firebase = require('@firebase/app-compat').default;
-  registerDatabase(firebase);
-} catch (err) {
-  // catch and ignore 'MODULE_NOT_FOUND' error in firebase-admin context
-  // we can safely ignore this error because RTDB in firebase-admin works without @firebase/app
-  if (err.code !== 'MODULE_NOT_FOUND') {
-    throw err;
-  }
-}
-
-// Types to export for the admin SDK
-export { Database, Query, Reference, enableLogging, ServerValue };
-
-export { OnDisconnect } from '@firebase/database';
-
-declare module '@firebase/app-compat' {
-  interface FirebaseNamespace {
-    database?: {
-      (app?: FirebaseApp): types.FirebaseDatabase;
-      enableLogging: typeof types.enableLogging;
-      ServerValue: types.ServerValue;
-      Database: typeof types.FirebaseDatabase;
-    };
-  }
-  interface FirebaseApp {
-    database?(): types.FirebaseDatabase;
-  }
-}
-export { DataSnapshot } from '../src/api/Reference';

package/src/index.ts

@@ -1,88 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-// eslint-disable-next-line import/no-extraneous-dependencies
-import firebase, { FirebaseNamespace } from '@firebase/app-compat';
-import { _FirebaseNamespace } from '@firebase/app-types/private';
-import { Component, ComponentType } from '@firebase/component';
-import { enableLogging } from '@firebase/database';
-import * as types from '@firebase/database-types';
-
-import { name, version } from '../package.json';
-import { Database as DatabaseCompat } from '../src/api/Database';
-import * as INTERNAL from '../src/api/internal';
-// rename the imports to avoid conflicts with imports that will be added by "yarn add-compat-overloads" during a release build
-import { DataSnapshot as DataSnapshotCompat, Query as QueryCompat, Reference } from '../src/api/Reference';
-
-const ServerValue = DatabaseCompat.ServerValue;
-
-export function registerDatabase(instance: FirebaseNamespace) {
-  // Register the Database Service with the 'firebase' namespace.
-  const namespace = (
-    instance as unknown as _FirebaseNamespace
-  ).INTERNAL.registerComponent(
-    new Component(
-      'database-compat',
-      (container, { instanceIdentifier: url }) => {
-        /* Dependencies */
-        // getImmediate for FirebaseApp will always succeed
-        const app = container.getProvider('app-compat').getImmediate();
-        const databaseExp = container
-          .getProvider('database')
-          .getImmediate({ identifier: url });
-        return new DatabaseCompat(databaseExp, app);
-      },
-      ComponentType.PUBLIC
-    )
-      .setServiceProps(
-        // firebase.database namespace properties
-        {
-          Reference,
-          Query: QueryCompat,
-          Database: DatabaseCompat,
-          DataSnapshot: DataSnapshotCompat,
-          enableLogging,
-          INTERNAL,
-          ServerValue
-        }
-      )
-      .setMultipleInstances(true)
-  );
-
-  instance.registerVersion(name, version);
-}
-
-registerDatabase(firebase);
-
-// Types to export for the admin SDK. They are exported here in the browser entry point only for types
-// The same symbol should be exported from the node entry point so their values can be accessed at runtime by admin SDK
-export { DatabaseCompat as Database, QueryCompat as Query, Reference, enableLogging, ServerValue, DataSnapshotCompat as DataSnapshot };
-export { OnDisconnect } from '@firebase/database';
-
-declare module '@firebase/app-compat' {
-  interface FirebaseNamespace {
-    database?: {
-      (app?: FirebaseApp): types.FirebaseDatabase;
-      enableLogging: typeof types.enableLogging;
-      ServerValue: types.ServerValue;
-      Database: typeof types.FirebaseDatabase;
-    };
-  }
-  interface FirebaseApp {
-    database?(databaseURL?: string): types.FirebaseDatabase;
-  }
-}

package/src/util/validation.ts

@@ -1,59 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import { errorPrefix as errorPrefixFxn } from '@firebase/util';
-
-export const validateBoolean = function (
-  fnName: string,
-  argumentName: string,
-  bool: unknown,
-  optional: boolean
-) {
-  if (optional && bool === undefined) {
-    return;
-  }
-  if (typeof bool !== 'boolean') {
-    throw new Error(
-      errorPrefixFxn(fnName, argumentName) + 'must be a boolean.'
-    );
-  }
-};
-
-export const validateEventType = function (
-  fnName: string,
-  eventType: string,
-  optional: boolean
-) {
-  if (optional && eventType === undefined) {
-    return;
-  }
-
-  switch (eventType) {
-    case 'value':
-    case 'child_added':
-    case 'child_removed':
-    case 'child_changed':
-    case 'child_moved':
-      break;
-    default:
-      throw new Error(
-        errorPrefixFxn(fnName, 'eventType') +
-          'must be a valid event type = "value", "child_added", "child_removed", ' +
-          '"child_changed", or "child_moved".'
-      );
-  }
-};

package/test/browser/crawler_support.test.ts

@@ -1,206 +0,0 @@
-/**
- * @license
- * Copyright 2017 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import { _TEST_ACCESS_forceRestClient as forceRestClient } from '@firebase/database';
-import { expect } from 'chai';
-
-import { getRandomNode, getFreshRepoFromReference } from '../helpers/util';
-
-// Some sanity checks for the ReadonlyRestClient crawler support.
-describe('Crawler Support', () => {
-  let initialData;
-  let normalRef;
-  let restRef;
-
-  beforeEach(done => {
-    normalRef = getRandomNode();
-
-    forceRestClient(true);
-    restRef = getFreshRepoFromReference(normalRef);
-    forceRestClient(false);
-
-    setInitialData(done);
-  });
-
-  function setInitialData(done) {
-    // Set some initial data.
-    initialData = {
-      leaf: 42,
-      securedLeaf: 'secret',
-      leafWithPriority: { '.value': 42, '.priority': 'pri' },
-      obj: { a: 1, b: 2 },
-      list: {
-        10: { name: 'amy', age: 75, '.priority': 22 },
-        20: { name: 'becky', age: 42, '.priority': 52 },
-        30: { name: 'fred', age: 35, '.priority': 23 },
-        40: { name: 'fred', age: 29, '.priority': 26 },
-        50: { name: 'sally', age: 21, '.priority': 96 },
-        60: { name: 'tom', age: 16, '.priority': 15 },
-        70: { name: 'victor', age: 4, '.priority': 47 }
-      },
-      valueList: {
-        10: 'c',
-        20: 'b',
-        30: 'e',
-        40: 'f',
-        50: 'a',
-        60: 'd',
-        70: 'e'
-      }
-    };
-
-    return normalRef.set(initialData, error => {
-      expect(error).to.not.be.ok;
-      done();
-    });
-  }
-
-  it('set() is a no-op', done => {
-    normalRef.child('leaf').on('value', s => {
-      expect(s.val()).to.equal(42);
-    });
-
-    restRef.child('leaf').set('hello');
-
-    // We need to wait long enough to be sure that our 'hello' didn't actually get set, but there's
-    // no good way to do that.  So we just do a couple round-trips via the REST client and assume
-    // that's good enough.
-    restRef.child('obj').once('value', s => {
-      expect(s.val()).to.deep.equal(initialData.obj);
-
-      restRef.child('obj').once('value', s => {
-        expect(s.val()).to.deep.equal(initialData.obj);
-
-        normalRef.child('leaf').off();
-        done();
-      });
-    });
-  });
-
-  it('set() is a no-op (Promise)', () => {
-    // This test mostly exists to make sure restRef really is using ReadonlyRestClient
-    // and we're not accidentally testing a normal Firebase connection.
-
-    normalRef.child('leaf').on('value', s => {
-      expect(s.val()).to.equal(42);
-    });
-
-    restRef.child('leaf').set('hello');
-
-    // We need to wait long enough to be sure that our 'hello' didn't actually get set, but there's
-    // no good way to do that.  So we just do a couple round-trips via the REST client and assume
-    // that's good enough.
-    return restRef
-      .child('obj')
-      .once('value')
-      .then(s => {
-        expect(s.val()).to.deep.equal(initialData.obj);
-
-        return restRef.child('obj').once('value');
-      })
-      .then(
-        s => {
-          expect(s.val()).to.deep.equal(initialData.obj);
-          normalRef.child('leaf').off();
-        },
-        reason => {
-          normalRef.child('leaf').off();
-          return Promise.reject(reason);
-        }
-      );
-  });
-
-  it('.info/connected fires with true', done => {
-    restRef.root.child('.info/connected').on('value', s => {
-      if (s.val() === true) {
-        done();
-      }
-    });
-  });
-
-  it('Leaf read works.', done => {
-    restRef.child('leaf').once('value', s => {
-      expect(s.val()).to.equal(initialData.leaf);
-      done();
-    });
-  });
-
-  it('Leaf read works. (Promise)', () => {
-    return restRef
-      .child('leaf')
-      .once('value')
-      .then(s => {
-        expect(s.val()).to.equal(initialData.leaf);
-      });
-  });
-
-  it('Object read works.', done => {
-    restRef.child('obj').once('value', s => {
-      expect(s.val()).to.deep.equal(initialData.obj);
-      done();
-    });
-  });
-
-  it('Object read works. (Promise)', () => {
-    return restRef
-      .child('obj')
-      .once('value')
-      .then(s => {
-        expect(s.val()).to.deep.equal(initialData.obj);
-      });
-  });
-
-  it('Leaf with priority read works.', done => {
-    restRef.child('leafWithPriority').once('value', s => {
-      expect(s.exportVal()).to.deep.equal(initialData.leafWithPriority);
-      done();
-    });
-  });
-
-  it('Leaf with priority read works. (Promise)', () => {
-    return restRef
-      .child('leafWithPriority')
-      .once('value')
-      .then(s => {
-        expect(s.exportVal()).to.deep.equal(initialData.leafWithPriority);
-      });
-  });
-
-  it('Null read works.', done => {
-    restRef.child('nonexistent').once('value', s => {
-      expect(s.val()).to.equal(null);
-      done();
-    });
-  });
-
-  it('Null read works. (Promise)', () => {
-    return restRef
-      .child('nonexistent')
-      .once('value')
-      .then(s => {
-        expect(s.val()).to.equal(null);
-      });
-  });
-
-  it('on works.', done => {
-    restRef.child('leaf').on('value', s => {
-      expect(s.val()).to.equal(initialData.leaf);
-      restRef.child('leaf').off();
-      done();
-    });
-  });
-});