@firebase/firestore-compat 0.1.3-2021822203916 → 0.1.3

package/src/api/field_path.ts

@@ -1,64 +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 {
-  FieldPath as ExpFieldPath,
-  _FieldPath as InternalFieldPath
-} from '@firebase/firestore';
-import { FieldPath as PublicFieldPath } from '@firebase/firestore-types';
-import { Compat, getModularInstance } from '@firebase/util';
-
-// The objects that are a part of this API are exposed to third-parties as
-// compiled javascript so we want to flag our private members with a leading
-// underscore to discourage their use.
-
-/**
- * A `FieldPath` refers to a field in a document. The path may consist of a
- * single field name (referring to a top-level field in the document), or a list
- * of field names (referring to a nested field in the document).
- */
-export class FieldPath implements PublicFieldPath, Compat<ExpFieldPath> {
-  readonly _delegate: ExpFieldPath;
-  /**
-   * Creates a FieldPath from the provided field names. If more than one field
-   * name is provided, the path will point to a nested field in a document.
-   *
-   * @param fieldNames - A list of field names.
-   */
-  constructor(...fieldNames: string[]) {
-    this._delegate = new ExpFieldPath(...fieldNames);
-  }
-
-  static documentId(): FieldPath {
-    /**
-     * Internal Note: The backend doesn't technically support querying by
-     * document ID. Instead it queries by the entire document name (full path
-     * included), but in the cases we currently support documentId(), the net
-     * effect is the same.
-     */
-    return new FieldPath(InternalFieldPath.keyField().canonicalString());
-  }
-
-  isEqual(other: PublicFieldPath): boolean {
-    other = getModularInstance(other);
-
-    if (!(other instanceof ExpFieldPath)) {
-      return false;
-    }
-    return this._delegate._internalPath.isEqual(other._internalPath);
-  }
-}

package/src/api/field_value.ts

@@ -1,65 +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 {
-  arrayRemove,
-  arrayUnion,
-  deleteField,
-  FieldValue as FieldValue1,
-  increment,
-  serverTimestamp
-} from '@firebase/firestore';
-import { FieldValue as PublicFieldValue } from '@firebase/firestore-types';
-import { Compat } from '@firebase/util';
-
-export class FieldValue implements PublicFieldValue, Compat<FieldValue1> {
-  static serverTimestamp(): FieldValue {
-    const delegate = serverTimestamp();
-    delegate._methodName = 'FieldValue.serverTimestamp';
-    return new FieldValue(delegate);
-  }
-
-  static delete(): FieldValue {
-    const delegate = deleteField();
-    delegate._methodName = 'FieldValue.delete';
-    return new FieldValue(delegate);
-  }
-
-  static arrayUnion(...elements: unknown[]): FieldValue {
-    const delegate = arrayUnion(...elements);
-    delegate._methodName = 'FieldValue.arrayUnion';
-    return new FieldValue(delegate);
-  }
-
-  static arrayRemove(...elements: unknown[]): FieldValue {
-    const delegate = arrayRemove(...elements);
-    delegate._methodName = 'FieldValue.arrayRemove';
-    return new FieldValue(delegate);
-  }
-
-  static increment(n: number): FieldValue {
-    const delegate = increment(n);
-    delegate._methodName = 'FieldValue.increment';
-    return new FieldValue(delegate);
-  }
-
-  constructor(readonly _delegate: FieldValue1) {}
-
-  isEqual(other: FieldValue): boolean {
-    return this._delegate.isEqual(other._delegate);
-  }
-}

package/src/api/geo_point.ts

@@ -1,18 +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.
- */
-
-export { GeoPoint } from '@firebase/firestore';

package/src/api/observer.ts

@@ -1,54 +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 { FirestoreError } from '@firebase/firestore';
-
-/**
- * Observer/Subscribe interfaces.
- */
-export type NextFn<T> = (value: T) => void;
-export type ErrorFn = (error: FirestoreError) => void;
-export type CompleteFn = () => void;
-
-// Allow for any of the Observer methods to be undefined.
-export interface PartialObserver<T> {
-  next?: NextFn<T>;
-  error?: ErrorFn;
-  complete?: CompleteFn;
-}
-
-export function isPartialObserver<T>(obj: unknown): obj is PartialObserver<T> {
-  return implementsAnyMethods(obj, ['next', 'error', 'complete']);
-}
-
-/**
- * Returns true if obj is an object and contains at least one of the specified
- * methods.
- */
-function implementsAnyMethods(obj: unknown, methods: string[]): boolean {
-  if (typeof obj !== 'object' || obj === null) {
-    return false;
-  }
-
-  const object = obj as Record<string, unknown>;
-  for (const method of methods) {
-    if (method in object && typeof object[method] === 'function') {
-      return true;
-    }
-  }
-  return false;
-}

package/src/api/timestamp.ts

@@ -1,18 +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.
- */
-
-export { Timestamp } from '@firebase/firestore';

package/src/config.ts

@@ -1,90 +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 { FirebaseApp } from '@firebase/app-compat';
-import { FirebaseNamespace } from '@firebase/app-types';
-import { _FirebaseNamespace } from '@firebase/app-types/private';
-import { Component, ComponentType } from '@firebase/component';
-import {
-  Firestore as ModularFirestore,
-  CACHE_SIZE_UNLIMITED,
-  GeoPoint,
-  Timestamp
-} from '@firebase/firestore';
-
-import { Blob } from './api/blob';
-import {
-  Firestore,
-  Transaction,
-  CollectionReference,
-  DocumentReference,
-  DocumentSnapshot,
-  Query,
-  QueryDocumentSnapshot,
-  QuerySnapshot,
-  WriteBatch,
-  setLogLevel
-} from './api/database';
-import { FieldPath } from './api/field_path';
-import { FieldValue } from './api/field_value';
-
-const firestoreNamespace = {
-  Firestore,
-  GeoPoint,
-  Timestamp,
-  Blob,
-  Transaction,
-  WriteBatch,
-  DocumentReference,
-  DocumentSnapshot,
-  Query,
-  QueryDocumentSnapshot,
-  QuerySnapshot,
-  CollectionReference,
-  FieldPath,
-  FieldValue,
-  setLogLevel,
-  CACHE_SIZE_UNLIMITED
-};
-
-/**
- * Configures Firestore as part of the Firebase SDK by calling registerComponent.
- *
- * @param firebase - The FirebaseNamespace to register Firestore with
- * @param firestoreFactory - A factory function that returns a new Firestore
- *    instance.
- */
-export function configureForFirebase(
-  firebase: FirebaseNamespace,
-  firestoreFactory: (
-    app: FirebaseApp,
-    firestoreExp: ModularFirestore
-  ) => Firestore
-): void {
-  (firebase as _FirebaseNamespace).INTERNAL.registerComponent(
-    new Component(
-      'firestore-compat',
-      container => {
-        const app = container.getProvider('app-compat').getImmediate()!;
-        const firestoreExp = container.getProvider('firestore').getImmediate()!;
-        return firestoreFactory(app, firestoreExp);
-      },
-      ComponentType.PUBLIC
-    ).setServiceProps({ ...firestoreNamespace })
-  );
-}

package/src/index.console.ts

@@ -1,111 +0,0 @@
-/**
- * @license
- * Copyright 2019 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 { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
-import { Provider } from '@firebase/component';
-import {
-  _DatabaseId,
-  Firestore as FirestoreExp,
-  FirestoreError,
-  _EmptyCredentialsProvider
-} from '@firebase/firestore';
-
-import {
-  Firestore as FirestoreCompat,
-  PersistenceProvider
-} from './api/database';
-
-export {
-  CollectionReference,
-  DocumentReference,
-  DocumentSnapshot,
-  QuerySnapshot
-} from './api/database';
-export { Blob } from './api/blob';
-export { GeoPoint } from './api/geo_point';
-export { FieldPath } from './api/field_path';
-export { FieldValue } from './api/field_value';
-export { Timestamp } from './api/timestamp';
-
-export interface FirestoreDatabase {
-  projectId: string;
-  database?: string;
-}
-
-const MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE =
-  'You are using the memory-only build of Firestore. Persistence support is ' +
-  'only available via the @firebase/firestore bundle or the ' +
-  'firebase-firestore.js build.';
-
-/**
- * The persistence provider included with the memory-only SDK. This provider
- * errors for all attempts to access persistence.
- */
-export class MemoryPersistenceProvider implements PersistenceProvider {
-  enableIndexedDbPersistence(
-    firestore: FirestoreCompat,
-    forceOwnership: boolean
-  ): Promise<void> {
-    throw new FirestoreError(
-      'failed-precondition',
-      MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE
-    );
-  }
-
-  enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void> {
-    throw new FirestoreError(
-      'failed-precondition',
-      MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE
-    );
-  }
-
-  clearIndexedDbPersistence(firestore: Firestore): Promise<void> {
-    throw new FirestoreError(
-      'failed-precondition',
-      MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE
-    );
-  }
-}
-
-/** Firestore class that exposes the constructor expected by the Console. */
-export class Firestore extends FirestoreCompat {
-  constructor(
-    firestoreDatabase: FirestoreDatabase,
-    authProvider: Provider<FirebaseAuthInternalName>
-  ) {
-    super(
-      databaseIdFromFirestoreDatabase(firestoreDatabase),
-      new FirestoreExp(
-        databaseIdFromFirestoreDatabase(firestoreDatabase),
-        new _EmptyCredentialsProvider()
-      ),
-      new MemoryPersistenceProvider()
-    );
-  }
-}
-
-function databaseIdFromFirestoreDatabase(
-  firestoreDatabase: FirestoreDatabase
-): _DatabaseId {
-  if (!firestoreDatabase.projectId) {
-    throw new FirestoreError('invalid-argument', 'Must provide projectId');
-  }
-  return new _DatabaseId(
-    firestoreDatabase.projectId,
-    firestoreDatabase.database
-  );
-}

package/src/index.node.ts

@@ -1,40 +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.
- */
-
-// eslint-disable-next-line import/no-extraneous-dependencies
-import firebase from '@firebase/app-compat';
-import { FirebaseNamespace } from '@firebase/app-types';
-
-import { name, version } from '../package.json';
-
-import { Firestore, IndexedDbPersistenceProvider } from './api/database';
-import { configureForFirebase } from './config';
-
-/**
- * Registers the main Firestore Node build with the components framework.
- * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
- */
-export function registerFirestore(instance: FirebaseNamespace): void {
-  configureForFirebase(
-    instance,
-    (app, firestoreExp) =>
-      new Firestore(app, firestoreExp, new IndexedDbPersistenceProvider())
-  );
-  instance.registerVersion(name, version, 'node');
-}
-
-registerFirestore(firebase as unknown as FirebaseNamespace);

package/src/index.rn.ts

@@ -1,39 +0,0 @@
-/**
- * @license
- * Copyright 2020 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 from '@firebase/app-compat';
-import { FirebaseNamespace } from '@firebase/app-types';
-
-import { name, version } from '../package.json';
-
-import { Firestore, IndexedDbPersistenceProvider } from './api/database';
-import { configureForFirebase } from './config';
-/**
- * Registers the main Firestore ReactNative build with the components framework.
- * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
- */
-export function registerFirestore(instance: FirebaseNamespace): void {
-  configureForFirebase(
-    instance,
-    (app, firestoreExp) =>
-      new Firestore(app, firestoreExp, new IndexedDbPersistenceProvider())
-  );
-  instance.registerVersion(name, version, 'rn');
-}
-
-registerFirestore(firebase as unknown as FirebaseNamespace);

package/src/index.ts

@@ -1,69 +0,0 @@
-/**
- * @license
- * Copyright 2020 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 from '@firebase/app-compat';
-import { FirebaseNamespace } from '@firebase/app-types';
-import * as types from '@firebase/firestore-types';
-
-import { name, version } from '../package.json';
-
-import { Firestore, IndexedDbPersistenceProvider } from './api/database';
-import { configureForFirebase } from './config';
-
-import './register-module';
-
-/**
- * Registers the main Firestore build with the components framework.
- * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
- */
-export function registerFirestore(instance: FirebaseNamespace): void {
-  configureForFirebase(
-    instance,
-    (app, firestoreExp) =>
-      new Firestore(app, firestoreExp, new IndexedDbPersistenceProvider())
-  );
-  instance.registerVersion(name, version);
-}
-
-registerFirestore(firebase as unknown as FirebaseNamespace);
-
-declare module '@firebase/app-compat' {
-  interface FirebaseNamespace {
-    firestore: {
-      (app?: FirebaseApp): types.FirebaseFirestore;
-      Blob: typeof types.Blob;
-      CollectionReference: typeof types.CollectionReference;
-      DocumentReference: typeof types.DocumentReference;
-      DocumentSnapshot: typeof types.DocumentSnapshot;
-      FieldPath: typeof types.FieldPath;
-      FieldValue: typeof types.FieldValue;
-      Firestore: typeof types.FirebaseFirestore;
-      GeoPoint: typeof types.GeoPoint;
-      Query: typeof types.Query;
-      QueryDocumentSnapshot: typeof types.QueryDocumentSnapshot;
-      QuerySnapshot: typeof types.QuerySnapshot;
-      Timestamp: typeof types.Timestamp;
-      Transaction: typeof types.Transaction;
-      WriteBatch: typeof types.WriteBatch;
-      setLogLevel: typeof types.setLogLevel;
-    };
-  }
-  interface FirebaseApp {
-    firestore?(): types.FirebaseFirestore;
-  }
-}

package/src/register-module.ts

@@ -1,44 +0,0 @@
-/**
- * @license
- * Copyright 2020 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 * as types from '@firebase/firestore-types';
-
-declare module '@firebase/app-compat' {
-  interface FirebaseNamespace {
-    firestore: {
-      (app?: FirebaseApp): types.FirebaseFirestore;
-      Blob: typeof types.Blob;
-      CollectionReference: typeof types.CollectionReference;
-      DocumentReference: typeof types.DocumentReference;
-      DocumentSnapshot: typeof types.DocumentSnapshot;
-      FieldPath: typeof types.FieldPath;
-      FieldValue: typeof types.FieldValue;
-      Firestore: typeof types.FirebaseFirestore;
-      GeoPoint: typeof types.GeoPoint;
-      Query: typeof types.Query;
-      QueryDocumentSnapshot: typeof types.QueryDocumentSnapshot;
-      QuerySnapshot: typeof types.QuerySnapshot;
-      Timestamp: typeof types.Timestamp;
-      Transaction: typeof types.Transaction;
-      WriteBatch: typeof types.WriteBatch;
-      setLogLevel: typeof types.setLogLevel;
-    };
-  }
-  interface FirebaseApp {
-    firestore?(): types.FirebaseFirestore;
-  }
-}

package/src/util/input_validation.ts

@@ -1,40 +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 { FirestoreError } from '@firebase/firestore';
-import { SetOptions } from '@firebase/firestore-types';
-
-export function validateSetOptions(
-  methodName: string,
-  options: SetOptions | undefined
-): SetOptions {
-  if (options === undefined) {
-    return {
-      merge: false
-    };
-  }
-
-  if (options.mergeFields !== undefined && options.merge !== undefined) {
-    throw new FirestoreError(
-      'invalid-argument',
-      `Invalid options passed to function ${methodName}(): You cannot ` +
-        'specify both "merge" and "mergeFields".'
-    );
-  }
-
-  return options;
-}