reduced tools in validation utils.

Author: DellaBitta

packages/firestore/src/util/bundle_builder_validation_utils.ts

@@ -18,148 +18,6 @@
 import { FieldPath } from '../lite-api/field_path';
 import { Timestamp } from '../lite-api/timestamp';
 
-/**
- * Options to allow argument omission.
- *
- * @private
- * @internal
- */
-export interface RequiredArgumentOptions {
-  optional?: boolean;
-}
-
-/**
- * Options to limit the range of numbers.
- *
- * @private
- * @internal
- */
-export interface NumericRangeOptions {
-  minValue?: number;
-  maxValue?: number;
-}
-
-/**
- * Determines whether `value` is a JavaScript function.
- *
- * @private
- * @internal
- */
-export function isFunction(value: unknown): boolean {
-  return typeof value === 'function';
-}
-
-/**
- * Determines whether `value` is a JavaScript object.
- *
- * @private
- * @internal
- */
-export function isObject(value: unknown): value is {[k: string]: unknown} {
-  return Object.prototype.toString.call(value) === '[object Object]';
-}
-
-/**
- * Generates an error message to use with custom objects that cannot be
- * serialized.
- *
- * @private
- * @internal
- * @param arg The argument name or argument index (for varargs methods).
- * @param value The value that failed serialization.
- * @param path The field path that the object is assigned to.
- */
-export function customObjectMessage(
-  arg: string | number,
-  value: unknown,
-  path?: FieldPath
-): string {
-  const fieldPathMessage = path ? ` (found in field "${path}")` : '';
-
-  if (isObject(value)) {
-    // We use the base class name as the type name as the sentinel classes
-    // returned by the public FieldValue API are subclasses of FieldValue. By
-    // using the base name, we reduce the number of special cases below.
-    const typeName = value.constructor.name;
-    switch (typeName) {
-      case 'DocumentReference':
-      case 'FieldPath':
-      case 'FieldValue':
-      case 'GeoPoint':
-      case 'Timestamp':
-        return (
-          `${invalidArgumentMessage(
-            arg,
-            'Firestore document'
-          )} Detected an object of type "${typeName}" that doesn't match the ` +
-          `expected instance${fieldPathMessage}. Please ensure that the ` +
-          'Firestore types you are using are from the same NPM package.)'
-        );
-      case 'Object':
-        return `${invalidArgumentMessage(
-          arg,
-          'Firestore document'
-        )} Invalid use of type "${typeof value}" as a Firestore argument${fieldPathMessage}.`;
-      default:
-        return (
-          `${invalidArgumentMessage(
-            arg,
-            'Firestore document'
-          )} Couldn't serialize object of type "${typeName}"${fieldPathMessage}. Firestore doesn't support JavaScript ` +
-          'objects with custom prototypes (i.e. objects that were created ' +
-          'via the "new" operator).'
-        );
-    }
-  } else {
-    return `${invalidArgumentMessage(
-      arg,
-      'Firestore document'
-    )} Input is not a plain JavaScript object${fieldPathMessage}.`;
-  }
-}
-
-/**
- * Validates that 'value' is a function.
- *
- * @private
- * @internal
- * @param arg The argument name or argument index (for varargs methods).
- * @param value The input to validate.
- * @param options Options that specify whether the function can be omitted.
- */
-export function validateFunction(
-  arg: string | number,
-  value: unknown,
-  options?: RequiredArgumentOptions
-): void {
-  if (!validateOptional(value, options)) {
-    if (!isFunction(value)) {
-      throw new Error(invalidArgumentMessage(arg, 'function'));
-    }
-  }
-}
-
-/**
- * Validates that 'value' is an object.
- *
- * @private
- * @internal
- * @param arg The argument name or argument index (for varargs methods).
- * @param value The input to validate.
- * @param options Options that specify whether the object can be omitted.
- */
-export function validateObject(
-  arg: string | number,
-  value: unknown,
-  options?: RequiredArgumentOptions
-): void {
-  if (!validateOptional(value, options)) {
-    if (!isObject(value)) {
-      throw new Error(invalidArgumentMessage(arg, 'object'));
-    }
-  }
-}
-
 /**
  * Validates that 'value' is a string.
  *
@@ -171,161 +29,10 @@ export function validateObject(
  */
 export function validateString(
   arg: string | number,
-  value: unknown,
-  options?: RequiredArgumentOptions
-): void {
-  if (!validateOptional(value, options)) {
-    if (typeof value !== 'string') {
-      throw new Error(invalidArgumentMessage(arg, 'string'));
-    }
-  }
-}
-
-/**
- * Validates that 'value' is a host.
- *
- * @private
- * @internal
- * @param arg The argument name or argument index (for varargs methods).
- * @param value The input to validate.
- * @param options Options that specify whether the host can be omitted.
- */
-export function validateHost(
-  arg: string | number,
-  value: unknown,
-  options?: RequiredArgumentOptions
-): void {
-  if (!validateOptional(value, options)) {
-    validateString(arg, value);
-    const urlString = `http://${value}/`;
-    let parsed;
-    try {
-      parsed = new URL(urlString);
-    } catch (e) {
-      throw new Error(invalidArgumentMessage(arg, 'host'));
-    }
-
-    if (
-      parsed.search !== '' ||
-      parsed.pathname !== '/' ||
-      parsed.username !== ''
-    ) {
-      throw new Error(invalidArgumentMessage(arg, 'host'));
-    }
-  }
-}
-
-/**
- * Validates that 'value' is a boolean.
- *
- * @private
- * @internal
- * @param arg The argument name or argument index (for varargs methods).
- * @param value The input to validate.
- * @param options Options that specify whether the boolean can be omitted.
- */
-export function validateBoolean(
-  arg: string | number,
-  value: unknown,
-  options?: RequiredArgumentOptions
-): void {
-  if (!validateOptional(value, options)) {
-    if (typeof value !== 'boolean') {
-      throw new Error(invalidArgumentMessage(arg, 'boolean'));
-    }
-  }
-}
-
-/**
- * Validates that 'value' is a number.
- *
- * @private
- * @internal
- * @param arg The argument name or argument index (for varargs methods).
- * @param value The input to validate.
- * @param options Options that specify whether the number can be omitted.
- */
-export function validateNumber(
-  arg: string | number,
-  value: unknown,
-  options?: RequiredArgumentOptions & NumericRangeOptions
+  value: unknown
 ): void {
-  const min =
-    options !== undefined && options.minValue !== undefined
-      ? options.minValue
-      : -Infinity;
-  const max =
-    options !== undefined && options.maxValue !== undefined
-      ? options.maxValue
-      : Infinity;
-
-  if (!validateOptional(value, options)) {
-    if (typeof value !== 'number' || isNaN(value)) {
-      throw new Error(invalidArgumentMessage(arg, 'number'));
-    } else if (value < min || value > max) {
-      throw new Error(
-        `${formatArgumentName(
-          arg
-        )} must be within [${min}, ${max}] inclusive, but was: ${value}`
-      );
-    }
-  }
-}
-
-/**
- * Validates that 'value' is a integer.
- *
- * @private
- * @internal
- * @param arg The argument name or argument index (for varargs methods).
- * @param value The input to validate.
- * @param options Options that specify whether the integer can be omitted.
- */
-export function validateInteger(
-  arg: string | number,
-  value: unknown,
-  options?: RequiredArgumentOptions & NumericRangeOptions
-): void {
-  const min =
-    options !== undefined && options.minValue !== undefined
-      ? options.minValue
-      : -Infinity;
-  const max =
-    options !== undefined && options.maxValue !== undefined
-      ? options.maxValue
-      : Infinity;
-
-  if (!validateOptional(value, options)) {
-    if (typeof value !== 'number' || isNaN(value) || value % 1 !== 0) {
-      throw new Error(invalidArgumentMessage(arg, 'integer'));
-    } else if (value < min || value > max) {
-      throw new Error(
-        `${formatArgumentName(
-          arg
-        )} must be within [${min}, ${max}] inclusive, but was: ${value}`
-      );
-    }
-  }
-}
-
-/**
- * Validates that 'value' is a Timestamp.
- *
- * @private
- * @internal
- * @param arg The argument name or argument index (for varargs methods).
- * @param value The input to validate.
- * @param options Options that specify whether the Timestamp can be omitted.
- */
-export function validateTimestamp(
-  arg: string | number,
-  value: unknown,
-  options?: RequiredArgumentOptions
-): void {
-  if (!validateOptional(value, options)) {
-    if (!(value instanceof Timestamp)) {
-      throw new Error(invalidArgumentMessage(arg, 'Timestamp'));
-    }
+  if (typeof value !== 'string') {
+    throw new Error(invalidArgumentMessage(arg, 'string'));
   }
 }
 
@@ -344,24 +51,6 @@ export function invalidArgumentMessage(
   return `${formatArgumentName(arg)} is not a valid ${expectedType}.`;
 }
 
-/**
- * Enforces the 'options.optional' constraint for 'value'.
- *
- * @private
- * @internal
- * @param value The input to validate.
- * @param options Whether the function can be omitted.
- * @return Whether the object is omitted and is allowed to be omitted.
- */
-export function validateOptional(
-  value: unknown,
-  options?: RequiredArgumentOptions
-): boolean {
-  return (
-    value === undefined && options !== undefined && options.optional === true
-  );
-}
-
 /**
  * Formats the given word as plural conditionally given the preceding number.
  *
@@ -432,38 +121,4 @@ export function validateMaxNumberOfArguments(
         `${formatPlural(maxSize, 'argument')}.`
     );
   }
-}
-
-/**
- * Validates that the provided named option equals one of the expected values.
- *
- * @param arg The argument name or argument index (for varargs methods).).
- * @param value The input to validate.
- * @param allowedValues A list of expected values.
- * @param options Whether the input can be omitted.
- * @private
- * @internal
- */
-export function validateEnumValue(
-  arg: string | number,
-  value: unknown,
-  allowedValues: string[],
-  options?: RequiredArgumentOptions
-): void {
-  if (!validateOptional(value, options)) {
-    const expectedDescription: string[] = [];
-
-    for (const allowed of allowedValues) {
-      if (allowed === value) {
-        return;
-      }
-      expectedDescription.push(allowed);
-    }
-
-    throw new Error(
-      `${formatArgumentName(
-        arg
-      )} is invalid. Acceptable values are: ${expectedDescription.join(', ')}`
-    );
-  }
 }