Remove FieldValue factory methods (#342)

Author: milaGGL

common/api-review/firestore-lite.api.md

@@ -68,14 +68,13 @@ export function average(field: string | FieldPath): AggregateField<number | null
 // @public
 export class BsonBinaryData {
     constructor(subtype: number, data: Uint8Array);
+    // (undocumented)
     readonly data: Uint8Array;
     isEqual(other: BsonBinaryData): boolean;
+    // (undocumented)
     readonly subtype: number;
 }
 
-// @public
-export function bsonBinaryData(subtype: number, data: Uint8Array): BsonBinaryData;
-
 // @public
 export class BsonObjectId {
     constructor(value: string);
@@ -84,9 +83,6 @@ export class BsonObjectId {
     readonly value: string;
 }
 
-// @public
-export function bsonObjectId(value: string): BsonObjectId;
-
 // @public
 export class BsonTimestamp {
     constructor(seconds: number, increment: number);
@@ -97,9 +93,6 @@ export class BsonTimestamp {
     readonly seconds: number;
 }
 
-// @public
-export function bsonTimestamp(seconds: number, increment: number): BsonTimestamp;
-
 // @public
 export class Bytes {
     static fromBase64String(base64: string): Bytes;
@@ -284,9 +277,6 @@ export function initializeFirestore(app: FirebaseApp, settings: Settings): Fires
 // @beta
 export function initializeFirestore(app: FirebaseApp, settings: Settings, databaseId?: string): Firestore;
 
-// @public
-export function int32(value: number): Int32Value;
-
 // @public
 export class Int32Value {
     constructor(value: number);
@@ -310,19 +300,13 @@ export class MaxKey {
     readonly type = "MaxKey";
 }
 
-// @public
-export function maxKey(): MaxKey;
-
 // @public
 export class MinKey {
     // (undocumented)
     static instance(): MinKey;
     readonly type = "MinKey";
 }
 
-// @public
-export function minKey(): MinKey;
-
 // @public
 export type NestedUpdateFields<T extends Record<string, unknown>> = UnionToIntersection<{
     [K in keyof T & string]: ChildUpdateFields<K, T[K]>;
@@ -426,9 +410,6 @@ export class QueryStartAtConstraint extends QueryConstraint {
 // @public
 export function refEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>, right: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>): boolean;
 
-// @public
-export function regex(pattern: string, options: string): RegexValue;
-
 // @public
 export class RegexValue {
     constructor(pattern: string, options: string);

common/api-review/firestore.api.md

@@ -68,14 +68,13 @@ export function average(field: string | FieldPath): AggregateField<number | null
 // @public
 export class BsonBinaryData {
     constructor(subtype: number, data: Uint8Array);
+    // (undocumented)
     readonly data: Uint8Array;
     isEqual(other: BsonBinaryData): boolean;
+    // (undocumented)
     readonly subtype: number;
 }
 
-// @public
-export function bsonBinaryData(subtype: number, data: Uint8Array): BsonBinaryData;
-
 // @public
 export class BsonObjectId {
     constructor(value: string);
@@ -84,9 +83,6 @@ export class BsonObjectId {
     readonly value: string;
 }
 
-// @public
-export function bsonObjectId(value: string): BsonObjectId;
-
 // @public
 export class BsonTimestamp {
     constructor(seconds: number, increment: number);
@@ -97,9 +93,6 @@ export class BsonTimestamp {
     readonly seconds: number;
 }
 
-// @public
-export function bsonTimestamp(seconds: number, increment: number): BsonTimestamp;
-
 // @public
 export class Bytes {
     static fromBase64String(base64: string): Bytes;
@@ -379,9 +372,6 @@ export interface IndexField {
 // @public
 export function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;
 
-// @public
-export function int32(value: number): Int32Value;
-
 // @public
 export class Int32Value {
     constructor(value: number);
@@ -427,9 +417,6 @@ export class MaxKey {
     readonly type = "MaxKey";
 }
 
-// @public
-export function maxKey(): MaxKey;
-
 // @public
 export interface MemoryCacheSettings {
     garbageCollector?: MemoryGarbageCollector;
@@ -474,9 +461,6 @@ export class MinKey {
     readonly type = "MinKey";
 }
 
-// @public
-export function minKey(): MinKey;
-
 // @public
 export function namedQuery(firestore: Firestore, name: string): Promise<Query | null>;
 
@@ -686,9 +670,6 @@ export class QueryStartAtConstraint extends QueryConstraint {
 // @public
 export function refEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>, right: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>): boolean;
 
-// @public
-export function regex(pattern: string, options: string): RegexValue;
-
 // @public
 export class RegexValue {
     constructor(pattern: string, options: string);

packages/firestore/lite/index.ts

@@ -128,14 +128,7 @@ export {
   arrayUnion,
   serverTimestamp,
   deleteField,
-  vector,
-  int32,
-  regex,
-  bsonBinaryData,
-  bsonObjectId,
-  bsonTimestamp,
-  minKey,
-  maxKey
+  vector
 } from '../src/lite-api/field_value_impl';
 
 export {
@@ -156,7 +149,7 @@ export { BsonBinaryData } from '../src/lite-api/bson_binary_data';
 
 export { BsonObjectId } from '../src/lite-api/bson_object_Id';
 
-export { BsonTimestamp } from '../src/lite-api/bson_timestamp_value';
+export { BsonTimestamp } from '../src/lite-api/bson_timestamp';
 
 export { MinKey } from '../src/lite-api/min_key';
 

packages/firestore/src/api.ts

@@ -173,14 +173,7 @@ export {
   deleteField,
   increment,
   serverTimestamp,
-  vector,
-  int32,
-  regex,
-  bsonBinaryData,
-  bsonObjectId,
-  bsonTimestamp,
-  minKey,
-  maxKey
+  vector
 } from './api/field_value_impl';
 
 export { VectorValue } from './lite-api/vector_value';
@@ -193,7 +186,7 @@ export { BsonBinaryData } from './lite-api/bson_binary_data';
 
 export { BsonObjectId } from './lite-api/bson_object_Id';
 
-export { BsonTimestamp } from './lite-api/bson_timestamp_value';
+export { BsonTimestamp } from './lite-api/bson_timestamp';
 
 export { MinKey } from './lite-api/min_key';
 

packages/firestore/src/api/field_value_impl.ts

@@ -21,12 +21,5 @@ export {
   arrayUnion,
   serverTimestamp,
   deleteField,
-  vector,
-  int32,
-  regex,
-  bsonBinaryData,
-  bsonObjectId,
-  bsonTimestamp,
-  minKey,
-  maxKey
+  vector
 } from '../lite-api/field_value_impl';

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

@@ -24,13 +24,9 @@ import { Code, FirestoreError } from '../util/error';
  * @class BsonBinaryData
  */
 export class BsonBinaryData {
-  /** The subtype for the data */
-  readonly subtype: number;
-
-  /** The binary data as a byte array */
   readonly data: Uint8Array;
 
-  constructor(subtype: number, data: Uint8Array) {
+  constructor(readonly subtype: number, data: Uint8Array) {
     if (subtype < 0 || subtype > 255) {
       throw new FirestoreError(
         Code.INVALID_ARGUMENT,

packages/firestore/src/lite-api/bson_timestamp_value.ts renamed to packages/firestore/src/lite-api/bson_timestamp.ts

@@ -21,7 +21,19 @@
  * @class BsonTimestamp
  */
 export class BsonTimestamp {
-  constructor(readonly seconds: number, readonly increment: number) {}
+  constructor(readonly seconds: number, readonly increment: number) {
+    // Make sure 'seconds' and 'increment' are in the range of a 32-bit unsigned integer.
+    if (seconds < 0 || seconds > 4294967295) {
+      throw new Error(
+        "BsonTimestamp 'seconds' must be in the range of a 32-bit unsigned integer."
+      );
+    }
+    if (increment < 0 || increment > 4294967295) {
+      throw new Error(
+        "BsonTimestamp 'increment' must be in the range of a 32-bit unsigned integer."
+      );
+    }
+  }
 
   /**
    * Returns true if this `BsonTimestamp` is equal to the provided one.

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

@@ -14,15 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-import { BsonBinaryData } from './bson_binary_data';
-import { BsonObjectId } from './bson_object_Id';
-import { BsonTimestamp } from './bson_timestamp_value';
 import { FieldValue } from './field_value';
-import { Int32Value } from './int32_value';
-import { MaxKey } from './max_key';
-import { MinKey } from './min_key';
-import { RegexValue } from './regex_value';
 import {
   ArrayRemoveFieldValueImpl,
   ArrayUnionFieldValueImpl,
@@ -116,85 +108,3 @@ export function increment(n: number): FieldValue {
 export function vector(values?: number[]): VectorValue {
   return new VectorValue(values);
 }
-
-/**
- * Creates a new `Int32Value` constructed with the given number.
- *
- * @param value - The 32-bit number to be used for constructing the Int32Value
- *
- * @returns A new `Int32Value` constructed with the given number.
- */
-export function int32(value: number): Int32Value {
-  return new Int32Value(value);
-}
-
-/**
- * Creates a new `RegexValue` constructed with the given pattern and options.
- *
- * @param subtype - The subtype of the BSON binary data.
- * @param data - The data to use for the BSON binary data.
- *
- * @returns A new `RegexValue` constructed with the given pattern and options.
- */
-export function regex(pattern: string, options: string): RegexValue {
-  return new RegexValue(pattern, options);
-}
-
-/**
- * Creates a new `BsonBinaryData` constructed with the given subtype and data.
- *
- * @param subtype - Create a `BsonBinaryData` instance with the given subtype.
- * @param data - Create a `BsonBinaryData` instance with a copy of this array of numbers.
- *
- * @returns A new `BsonBinaryData` constructed with the given subtype and data.
- */
-export function bsonBinaryData(
-  subtype: number,
-  data: Uint8Array
-): BsonBinaryData {
-  return new BsonBinaryData(subtype, data);
-}
-
-/**
- * Creates a new `BsonObjectId` constructed with the given string.
- *
- * @param value - The 24-character hex string representing the ObjectId.
- *
- * @returns A new `BsonObjectId` constructed with the given string.
- */
-export function bsonObjectId(value: string): BsonObjectId {
-  return new BsonObjectId(value);
-}
-
-/**
- * Creates a new `BsonTimestamp` constructed with the given seconds and increment.
- *
- * @param seconds - The underlying unsigned 32-bit integer for seconds.
- * @param seconds - The underlying unsigned 32-bit integer for increment.
- *
- * @returns A new `BsonTimestamp` constructed with the given seconds and increment.
- */
-export function bsonTimestamp(
-  seconds: number,
-  increment: number
-): BsonTimestamp {
-  return new BsonTimestamp(seconds, increment);
-}
-
-/**
- * Creates or returns a `MinKey` instance.
- *
- * @returns A `MinKey` instance.
- */
-export function minKey(): MinKey {
-  return MinKey.instance();
-}
-
-/**
- * Creates or returns a `MaxKey` instance.
- *
- * @returns A `MaxKey` instance.
- */
-export function maxKey(): MaxKey {
-  return MaxKey.instance();
-}

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

@@ -77,7 +77,7 @@ import { Dict, forEach, isEmpty } from '../util/obj';
 
 import { BsonBinaryData } from './bson_binary_data';
 import { BsonObjectId } from './bson_object_Id';
-import { BsonTimestamp } from './bson_timestamp_value';
+import { BsonTimestamp } from './bson_timestamp';
 import { Bytes } from './bytes';
 import { Firestore } from './database';
 import { FieldPath } from './field_path';

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

@@ -60,10 +60,11 @@ import { forEach } from '../util/obj';
 
 import { BsonBinaryData } from './bson_binary_data';
 import { BsonObjectId } from './bson_object_Id';
-import { BsonTimestamp } from './bson_timestamp_value';
-import { maxKey, minKey } from './field_value_impl';
+import { BsonTimestamp } from './bson_timestamp';
 import { GeoPoint } from './geo_point';
 import { Int32Value } from './int32_value';
+import { MaxKey } from './max_key';
+import { MinKey } from './min_key';
 import { RegexValue } from './regex_value';
 import { Timestamp } from './timestamp';
 import { VectorValue } from './vector_value';
@@ -118,9 +119,9 @@ export abstract class AbstractUserDataWriter {
       case TypeOrder.BsonTimestampValue:
         return this.convertToBsonTimestamp(value.mapValue!);
       case TypeOrder.MaxKeyValue:
-        return maxKey();
+        return MaxKey.instance();
       case TypeOrder.MinKeyValue:
-        return minKey();
+        return MinKey.instance();
       default:
         throw fail('Invalid value type: ' + JSON.stringify(value));
     }