Add DocumentReference

Author: schmidt-sebastian

packages/firestore/lite/index.node.ts

@@ -26,6 +26,8 @@ export {
   getFirestore
 } from './src/api/database';
 
+export { DocumentReference } from './src/api/reference';
+
 export function registerFirestore(): void {
   _registerComponent(
     new Component(

packages/firestore/lite/src/api/reference.ts

@@ -0,0 +1,51 @@
+/**
+ * @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 firestore from '../../index';
+
+import { DocumentKey } from '../../../src/model/document_key';
+import { Firestore } from './database';
+import { DocumentKeyReference } from '../../../src/api/user_data_reader';
+
+/**
+ * A reference to a particular document in a collection in the database.
+ */
+export class DocumentReference<T = firestore.DocumentData>
+  extends DocumentKeyReference<T>
+  implements firestore.DocumentReference<T> {
+  constructor(
+    key: DocumentKey,
+    readonly firestore: Firestore,
+    readonly _converter?: firestore.FirestoreDataConverter<T>
+  ) {
+    super(firestore._databaseId, key, _converter);
+  }
+
+  get id(): string {
+    return this._key.path.lastSegment();
+  }
+
+  get path(): string {
+    return this._key.path.canonicalString();
+  }
+
+  withConverter<U>(
+    converter: firestore.FirestoreDataConverter<U>
+  ): DocumentReference<U> {
+    return new DocumentReference<U>(this._key, this.firestore, converter);
+  }
+}

packages/firestore/src/api/user_data_reader.ts

@@ -50,6 +50,29 @@ import { DocumentReference } from './database';
 
 const RESERVED_FIELD_REGEX = /^__.*__$/;
 
+/**
+ * An untyped Firestore Data Converter interface that is shared between the
+ * lite, full and legacy SDK.
+ */
+export interface UntypedFirestoreDataConverter<T> {
+  toFirestore(modelObject: T): firestore.DocumentData;
+  fromFirestore(snapshot: unknown, options?: unknown): T;
+}
+
+/**
+ * A reference to a document in a Firebase project.
+ *
+ * This class serves as a common base class for the public DocumentReferences
+ * exposed in the lite, full and legacy SDK.
+ */
+export class DocumentKeyReference<T> {
+  constructor(
+    public readonly _databaseId: DatabaseId,
+    public readonly _key: DocumentKey,
+    public readonly _converter?: UntypedFirestoreDataConverter<T>
+  ) {}
+}
+
 /** The result of parsing document data (e.g. for a setData call). */
 export class ParsedSetData {
   constructor(