# All files / api field_path.ts

89.66% Statements 26/29
66.67% Branches 4/6
80% Functions 4/5
88.89% Lines 24/27

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118

    2x
    2x
    2x

    2x

    893x
    753x

    753x
    869x
    869x
    48x

    705x

    2x

    2x
    26x

    2x

    2x

    2x

    2x
    791x
    791x
    72x

    719x
    719x

    48x

     /**
     * Copyright 2017 Google Inc.
     *
     * 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 '@firebase/firestore-types';

    import { FieldPath as InternalFieldPath } from '../model/path';
    import { Code, FirestoreError } from '../util/error';
    import {
      invalidClassError,
      validateArgType,
      validateNamedArrayAtLeastNumberOfElements
    } from '../util/input_validation';

    // 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.
    // tslint:disable:strip-private-property-underscore

    /**
     * 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 firestore.FieldPath {
      /** Internal representation of a Firestore field path. */
      _internalPath: InternalFieldPath;

      /**
       * 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[]) {
        validateNamedArrayAtLeastNumberOfElements(
          'FieldPath',
          fieldNames,
          'fieldNames',
          1
        );

        for (let i = 0; i < fieldNames.length; ++i) {
          validateArgType('FieldPath', 'string', i, fieldNames[i]);
          if (fieldNames[i].length === 0) {
            throw new FirestoreError(
              Code.INVALID_ARGUMENT,
              `Invalid field name at argument $(i + 1). ` +
                'Field names must not be empty.'
            );
          }
        }

        this._internalPath = new InternalFieldPath(fieldNames);
      }

      /**
       * 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.
       */
      private static readonly _DOCUMENT_ID = new FieldPath(
        InternalFieldPath.keyField().canonicalString()
      );

      static documentId(): FieldPath {
        return FieldPath._DOCUMENT_ID;
      }

      isEqual(other: firestore.FieldPath): boolean {
        if (!(other instanceof FieldPath)) {
          throw invalidClassError('isEqual', 'FieldPath', 1, other);
        }
        return this._internalPath.isEqual(other._internalPath);
      }
    }

    /**
     * Matches any characters in a field path string that are reserved.
     */
    const RESERVED = new RegExp('[~\\*/\\[\\]]');

    /**
     * Parses a field path string into a FieldPath, treating dots as separators.
     */
    export function fromDotSeparatedString(path: string): FieldPath {
      const found = path.search(RESERVED);
      if (found >= 0) {
        throw new FirestoreError(
          Code.INVALID_ARGUMENT,
          `Invalid field path (${path}). Paths must not contain ` +
            `'~', '*', '/', '[', or ']'`
        );
      }
      try {
        return new FieldPath(...path.split('.'));
      } catch (e) {
        throw new FirestoreError(
          Code.INVALID_ARGUMENT,
          `Invalid field path (${path}). Paths must not be empty, ` +
            `begin with '.', end with '.', or contain '..'`
        );
      }
    }