Cleanup pass

removed extraneous imports and private/protected changes.

Author: DellaBitta

packages/firestore/src/api/snapshot.ts

@@ -521,7 +521,11 @@ export class DocumentSnapshot<
       'previous'
     );
     builder.addBundleDocument(
-      documentToDocumentSnapshotBundleData(this.ref.path, documentData, document)
+      documentToDocumentSnapshotBundleData(
+        this.ref.path,
+        documentData,
+        document
+      )
     );
     return { bundle: builder.build() };
   }
@@ -700,7 +704,11 @@ export class QuerySnapshot<
         'previous'
       );
       docBundleDataArray.push(
-        documentToDocumentSnapshotBundleData(doc.ref.path, documentData, doc._document)
+        documentToDocumentSnapshotBundleData(
+          doc.ref.path,
+          documentData,
+          doc._document
+        )
       );
     });
     const bundleData: QuerySnapshotBundleData = {

packages/firestore/src/lite-api/snapshot.ts

@@ -17,7 +17,6 @@
 
 import { Compat, getModularInstance } from '@firebase/util';
 
-import { Timestamp } from '../lite-api/timestamp';
 import { Document } from '../model/document';
 import { DocumentKey } from '../model/document_key';
 import { FieldPath as InternalFieldPath } from '../model/path';

packages/firestore/src/model/path.ts

@@ -26,7 +26,7 @@ export const DOCUMENT_KEY_NAME = '__name__';
  * Path represents an ordered sequence of string segments.
  */
 abstract class BasePath<B extends BasePath<B>> {
-  protected segments: string[];
+  private segments: string[];
   private offset: number;
   private len: number;
 

packages/firestore/src/util/bundle_builder_impl.ts

@@ -61,8 +61,10 @@ export class BundleBuilder {
   // The latest read time among all bundled documents and queries.
   private latestReadTime = new Timestamp(0, 0);
 
+  // Database identifier which is part of the serialized bundle.
   private databaseId: DatabaseId;
 
+  // Tools to convert public data types into their serialized form.
   private readonly serializer: JsonProtoSerializer;
   private readonly userDataReader: UserDataReader;
 
@@ -83,31 +85,6 @@ export class BundleBuilder {
     );
   }
 
-  private toBundleDocument(
-    docBundleData: DocumentSnapshotBundleData
-  ): ProtoDocument {
-    // TODO handle documents that have mutations
-    debugAssert(
-      !docBundleData.documentData.hasLocalMutations,
-      "Can't serialize documents with mutations."
-    );
-
-    // a parse context is typically used for validating and parsing user data, but in this
-    // case we are using it internally to convert DocumentData to Proto3 JSON
-    const context = this.userDataReader.createContext(
-      UserDataSource.ArrayArgument,
-      'internal toBundledDocument'
-    );
-    const proto3Fields = parseObject(docBundleData.documentData, context);
-
-    return {
-      name: toName(this.serializer, docBundleData.documentKey),
-      fields: proto3Fields.mapValue.fields,
-      updateTime: toTimestamp(this.serializer, docBundleData.versionTime),
-      createTime: toTimestamp(this.serializer, docBundleData.createdTime)
-    };
-  }
-
   /**
    * Adds data from a DocumentSnapshot to the bundle.
    * @internal
@@ -188,6 +165,38 @@ export class BundleBuilder {
     });
   }
 
+  /**
+   * Convert data from a DocumentSnapshot into the serialized form within a bundle.
+   * @private
+   * @internal
+   * @param docBundleData a DocumentSnapshotBundleData containing the data required to
+   * serialize a document.
+   */
+  private toBundleDocument(
+    docBundleData: DocumentSnapshotBundleData
+  ): ProtoDocument {
+    // TODO handle documents that have mutations
+    debugAssert(
+      !docBundleData.documentData.hasLocalMutations,
+      "Can't serialize documents with mutations."
+    );
+
+    // a parse context is typically used for validating and parsing user data, but in this
+    // case we are using it internally to convert DocumentData to Proto3 JSON
+    const context = this.userDataReader.createContext(
+      UserDataSource.ArrayArgument,
+      'internal toBundledDocument'
+    );
+    const proto3Fields = parseObject(docBundleData.documentData, context);
+
+    return {
+      name: toName(this.serializer, docBundleData.documentKey),
+      fields: proto3Fields.mapValue.fields,
+      updateTime: toTimestamp(this.serializer, docBundleData.versionTime),
+      createTime: toTimestamp(this.serializer, docBundleData.createdTime)
+    };
+  }
+
   /**
    * Converts a IBundleElement to a Buffer whose content is the length prefixed JSON representation
    * of the element.
@@ -205,6 +214,11 @@ export class BundleBuilder {
     return `${l}${str}`;
   }
 
+  /**
+   * Construct a serialized string containing document and query information that has previously
+   * been added to the BundleBuilder through the addBundleDocument and addBundleQuery methods.
+   * @internal
+   */
   build(): string {
     let bundleString = '';