@firebase/firestore 3.4.1-canary.4c042b2f9 → 3.4.1-canary.4f3662b70

package/dist/firestore/src/index/directional_index_byte_encoder.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @license
+ * Copyright 2021 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 { ByteString } from '../util/byte_string';
+/** An index value encoder.  */
+export interface DirectionalIndexByteEncoder {
+    writeBytes(value: ByteString): void;
+    writeString(value: string): void;
+    writeNumber(value: number): void;
+    writeInfinity(): void;
+}

package/dist/firestore/src/index/firestore_index_value_writer.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @license
+ * Copyright 2021 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 { Value } from '../protos/firestore_proto_api';
+import { DirectionalIndexByteEncoder } from './directional_index_byte_encoder';
+/** Firestore index value writer.  */
+export declare class FirestoreIndexValueWriter {
+    static INSTANCE: FirestoreIndexValueWriter;
+    private constructor();
+    /** Writes an index value.  */
+    writeIndexValue(value: Value, encoder: DirectionalIndexByteEncoder): void;
+    private writeIndexValueAux;
+    private writeIndexString;
+    private writeUnlabeledIndexString;
+    private writeIndexMap;
+    private writeIndexArray;
+    private writeIndexEntityRef;
+    private writeValueTypeLabel;
+    private writeTruncationMarker;
+}

package/dist/firestore/src/index/index_byte_encoder.d.ts

@@ -0,0 +1,14 @@
+import { DirectionalIndexByteEncoder } from './directional_index_byte_encoder';
+/**
+ * Implements `DirectionalIndexByteEncoder` using `OrderedCodeWriter` for the
+ * actual encoding.
+ */
+export declare class IndexByteEncoder {
+    private orderedCode;
+    private ascending;
+    private descending;
+    seed(encodedBytes: Uint8Array): void;
+    forKind(kind: 'asc' | 'desc'): DirectionalIndexByteEncoder;
+    encodedBytes(): Uint8Array;
+    reset(): void;
+}

package/dist/firestore/src/index/ordered_code_writer.d.ts

@@ -0,0 +1,49 @@
+import { ByteString } from '../util/byte_string';
+/**
+ * Counts the number of zeros in a byte.
+ *
+ * Visible for testing.
+ */
+export declare function numberOfLeadingZerosInByte(x: number): number;
+/**
+ * OrderedCodeWriter is a minimal-allocation implementation of the writing
+ * behavior defined by the backend.
+ *
+ * The code is ported from its Java counterpart.
+ */
+export declare class OrderedCodeWriter {
+    buffer: Uint8Array;
+    position: number;
+    /** Writes utf8 bytes into this byte sequence, ascending. */
+    writeUtf8Ascending(sequence: string): void;
+    /** Writes utf8 bytes into this byte sequence, descending */
+    writeUtf8Descending(sequence: string): void;
+    writeNumberAscending(val: number): void;
+    writeNumberDescending(val: number): void;
+    /**
+     * Encodes `val` into an encoding so that the order matches the IEEE 754
+     * floating-point comparison results with the following exceptions:
+     *   -0.0 < 0.0
+     *   all non-NaN < NaN
+     *   NaN = NaN
+     */
+    private toOrderedBits;
+    /** Resets the buffer such that it is the same as when it was newly constructed.  */
+    reset(): void;
+    /** Makes a copy of the encoded bytes in this buffer.  */
+    encodedBytes(): Uint8Array;
+    /** Writes a single byte ascending to the buffer. */
+    private writeByteAscending;
+    /** Writes a single byte descending to the buffer.  */
+    private writeByteDescending;
+    private writeSeparatorAscending;
+    private writeSeparatorDescending;
+    private writeEscapedByteAscending;
+    private writeEscapedByteDescending;
+    writeBytesAscending(value: ByteString): void;
+    writeBytesDescending(value: ByteString): void;
+    writeInfinityAscending(): void;
+    writeInfinityDescending(): void;
+    seed(encodedBytes: Uint8Array): void;
+    private ensureAvailable;
+}

package/dist/firestore/src/model/values.d.ts

@@ -18,6 +18,7 @@ import { DatabaseId } from '../core/database_info';
 import { ArrayValue, MapValue, Value } from '../protos/firestore_proto_api';
 import { DocumentKey } from './document_key';
 import { TypeOrder } from './type_order';
+export declare const MAX_VALUE: Value;
 /** Extracts the backend's type order for the provided value. */
 export declare function typeOrder(value: Value): TypeOrder;
 /** Tests `left` and `right` for equality based on the backend semantics. */
@@ -73,3 +74,5 @@ export declare function isMapValue(value?: Value | null): value is {
 };
 /** Creates a deep copy of `source`. */
 export declare function deepClone(source: Value): Value;
+/** Returns true if the Value represents the canonical {@link #MAX_VALUE} . */
+export declare function isMaxValue(value: Value): boolean;

package/dist/firestore/src/util/error.d.ts

@@ -14,6 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { FirebaseError } from '@firebase/util';
 /**
  * The set of Firestore status codes. The codes are the same at the ones
  * exposed by gRPC here:
@@ -170,7 +171,7 @@ export declare const Code: {
     DATA_LOSS: FirestoreErrorCode;
 };
 /** An error returned by a Firestore operation. */
-export declare class FirestoreError extends Error {
+export declare class FirestoreError extends FirebaseError {
     /**
      * The backend error code associated with this error.
      */
@@ -179,8 +180,6 @@ export declare class FirestoreError extends Error {
      * A custom error description.
      */
     readonly message: string;
-    /** The custom name for all FirestoreErrors. */
-    readonly name: string;
     /** The stack of the error. */
     readonly stack?: string;
     /** @hideconstructor */

package/dist/firestore/test/unit/index/ordered_code_writer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -6,6 +6,7 @@
 import { FirebaseApp } from '@firebase/app';
 import { LogLevelString as LogLevel } from '@firebase/logger';
 import { EmulatorMockTokenOptions } from '@firebase/util';
+import { FirebaseError } from '@firebase/util';
 
 /**
  * Add a new document to specified `CollectionReference` with the given data,
@@ -684,7 +685,7 @@ export declare interface FirestoreDataConverter<T> {
     fromFirestore(snapshot: QueryDocumentSnapshot<DocumentData>, options?: SnapshotOptions): T;
 }
 /** An error returned by a Firestore operation. */
-export declare class FirestoreError extends Error {
+export declare class FirestoreError extends FirebaseError {
     /**
      * The backend error code associated with this error.
      */
@@ -693,28 +694,10 @@ export declare class FirestoreError extends Error {
      * A custom error description.
      */
     readonly message: string;
-    /** The custom name for all FirestoreErrors. */
-    readonly name: string;
     /** The stack of the error. */
     readonly stack?: string;
     private constructor();
 }
-/**
- * @license
- * Copyright 2017 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.
- */
 /**
  * The set of Firestore status codes. The codes are the same at the ones
  * exposed by gRPC here: