@firebase/firestore 4.7.14 → 4.7.15

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

@@ -14,19 +14,36 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { DbIndexEntry } from '../local/indexeddb_schema';
+import { DbIndexEntryKey, KeySafeBytes } from '../local/indexeddb_sentinels';
 import { DocumentKey } from '../model/document_key';
 /** Represents an index entry saved by the SDK in persisted storage. */
 export declare class IndexEntry {
-    readonly indexId: number;
-    readonly documentKey: DocumentKey;
-    readonly arrayValue: Uint8Array;
-    readonly directionalValue: Uint8Array;
-    constructor(indexId: number, documentKey: DocumentKey, arrayValue: Uint8Array, directionalValue: Uint8Array);
+    readonly _indexId: number;
+    readonly _documentKey: DocumentKey;
+    readonly _arrayValue: Uint8Array;
+    readonly _directionalValue: Uint8Array;
+    constructor(_indexId: number, _documentKey: DocumentKey, _arrayValue: Uint8Array, _directionalValue: Uint8Array);
     /**
      * Returns an IndexEntry entry that sorts immediately after the current
      * directional value.
      */
     successor(): IndexEntry;
+    dbIndexEntry(uid: string, orderedDocumentKey: Uint8Array, documentKey: DocumentKey): DbIndexEntry;
+    dbIndexEntryKey(uid: string, orderedDocumentKey: Uint8Array, documentKey: DocumentKey): DbIndexEntryKey;
 }
 export declare function indexEntryComparator(left: IndexEntry, right: IndexEntry): number;
 export declare function compareByteArrays(left: Uint8Array, right: Uint8Array): number;
+/**
+ * Workaround for WebKit bug: https://bugs.webkit.org/show_bug.cgi?id=292721
+ * Create a key safe representation of Uint8Array values.
+ * If the browser is detected as Safari or WebKit, then
+ * the input array will be converted to "sortable byte string".
+ * Otherwise, the input array will be returned in its original type.
+ */
+export declare function encodeKeySafeBytes(array: Uint8Array): KeySafeBytes;
+/**
+ * Reverts the key safe representation of Uint8Array (created by
+ * encodeKeySafeBytes) to a normal Uint8Array.
+ */
+export declare function decodeKeySafeBytes(input: KeySafeBytes): Uint8Array;

package/dist/firestore/src/local/indexeddb_schema.d.ts

@@ -19,7 +19,7 @@ import { IndexKind } from '../model/field_index';
 import { BundledQuery } from '../protos/firestore_bundle_proto';
 import { Document as ProtoDocument, DocumentsTarget as ProtoDocumentsTarget, QueryTarget as ProtoQueryTarget, Write as ProtoWrite } from '../protos/firestore_proto_api';
 import { EncodedResourcePath } from './encoded_resource_path';
-import { DbTimestampKey } from './indexeddb_sentinels';
+import { DbTimestampKey, KeySafeBytes } from './indexeddb_sentinels';
 /**
  * Schema Version for the Web client:
  * 1.  Initial version including Mutation Queue, Query Cache, and Remote
@@ -44,8 +44,10 @@ import { DbTimestampKey } from './indexeddb_sentinels';
  * 14. Add overlays.
  * 15. Add indexing support.
  * 16. Parse timestamp strings before creating index entries.
+ * 17. TODO(tomandersen)
+ * 18. Encode key safe representations of IndexEntry in DbIndexEntryStore.
  */
-export declare const SCHEMA_VERSION = 17;
+export declare const SCHEMA_VERSION = 18;
 /**
  * Wrapper class to store timestamps (seconds and nanos) in IndexedDb objects.
  */
@@ -468,14 +470,14 @@ export interface DbIndexEntry {
     /** The user id for this entry. */
     uid: string;
     /** The encoded array index value for this entry. */
-    arrayValue: Uint8Array;
+    arrayValue: KeySafeBytes;
     /** The encoded directional value for equality and inequality filters. */
-    directionalValue: Uint8Array;
+    directionalValue: KeySafeBytes;
     /**
      * The document key this entry points to. This entry is encoded by an ordered
      * encoder to match the key order of the index.
      */
-    orderedDocumentKey: Uint8Array;
+    orderedDocumentKey: KeySafeBytes;
     /** The segments of the document key this entry points to. */
     documentKey: string[];
 }

package/dist/firestore/src/local/indexeddb_sentinels.d.ts

@@ -201,6 +201,14 @@ export declare const DbIndexStateKeyPath: string[];
  */
 export declare const DbIndexStateSequenceNumberIndex = "sequenceNumberIndex";
 export declare const DbIndexStateSequenceNumberIndexPath: string[];
+/**
+ * Representation of a byte array that is safe for
+ * use in an IndexedDb key. The value is either
+ * a "sortable byte string", which is key safe in
+ * Safari/WebKit, or the value is a Uint8Array,
+ * which is key safe in other browsers.
+ */
+export type KeySafeBytes = Uint8Array | string;
 /**
  * The key for each index entry consists of the index id and its user id,
  * the encoded array and directional value for the indexed fields as well as
@@ -209,9 +217,9 @@ export declare const DbIndexStateSequenceNumberIndexPath: string[];
 export type DbIndexEntryKey = [
     number,
     string,
-    Uint8Array,
-    Uint8Array,
-    Uint8Array,
+    KeySafeBytes,
+    KeySafeBytes,
+    KeySafeBytes,
     string[]
 ];
 /** Name of the IndexedDb object store. */
@@ -248,6 +256,7 @@ export declare const V14_STORES: string[];
 export declare const V15_STORES: string[];
 export declare const V16_STORES: string[];
 export declare const V17_STORES: string[];
+export declare const V18_STORES: string[];
 /**
  * The list of all default IndexedDB stores used throughout the SDK. This is
  * used when creating transactions so that access across all stores is done