@firebase/firestore 4.7.14 → 4.7.15-canary.2fe754727

package/dist/lite/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/lite/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/lite/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

package/dist/lite/index.browser.esm2017.js

@@ -4,7 +4,7 @@ import { Logger, LogLevel } from '@firebase/logger';
 import { FirebaseError, updateEmulatorBanner, getDefaultEmulatorHostnameAndPort, isCloudWorkstation, deepEqual, pingServer, createMockUserToken, getModularInstance } from '@firebase/util';
 import { Integer } from '@firebase/webchannel-wrapper/bloom-blob';
 
-const A = "4.7.14";
+const A = "4.7.15-canary.2fe754727";
 
 /**
  * @license
@@ -65,7 +65,7 @@ User.MOCK_USER = new User("mock-user");
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-let P = "11.7.3";
+let P = "11.8.0-canary.2fe754727";
 
 /**
  * @license
@@ -5196,8 +5196,8 @@ function __PRIVATE_isWrite(t) {
             _t: !0
         });
     }
-    dt(t) {
-        return __PRIVATE_createError(t, this.settings.methodName, this.settings.ft || !1, this.path, this.settings.Et);
+    ft(t) {
+        return __PRIVATE_createError(t, this.settings.methodName, this.settings.dt || !1, this.path, this.settings.Et);
     }
     /** Returns 'true' if 'fieldPath' was traversed when creating this context. */    contains(t) {
         return void 0 !== this.fieldMask.find((e => t.isPrefixOf(e))) || void 0 !== this.fieldTransforms.find((e => t.isPrefixOf(e.field)));
@@ -5208,8 +5208,8 @@ function __PRIVATE_isWrite(t) {
         if (this.path) for (let t = 0; t < this.path.length; t++) this.ct(this.path.get(t));
     }
     ct(t) {
-        if (0 === t.length) throw this.dt("Document fields must not be empty");
-        if (__PRIVATE_isWrite(this.it) && ut.test(t)) throw this.dt('Document fields cannot begin and end with "__"');
+        if (0 === t.length) throw this.ft("Document fields must not be empty");
+        if (__PRIVATE_isWrite(this.it) && ut.test(t)) throw this.ft('Document fields cannot begin and end with "__"');
     }
 }
 
@@ -5227,7 +5227,7 @@ function __PRIVATE_isWrite(t) {
             Et: r,
             path: FieldPath$1.emptyPath(),
             _t: !1,
-            ft: n
+            dt: n
         }, this.databaseId, this.serializer, this.ignoreUndefinedProperties);
     }
 }
@@ -5256,7 +5256,7 @@ function __PRIVATE_newUserDataReader(t) {
 
 class __PRIVATE_DeleteFieldValueImpl extends FieldValue {
     _toFieldTransform(t) {
-        if (2 /* UserDataSource.MergeSet */ !== t.it) throw 1 /* UserDataSource.Update */ === t.it ? t.dt(`${this._methodName}() can only appear at the top level of your update data`) : t.dt(`${this._methodName}() cannot be used with set() unless you pass {merge:true}`);
+        if (2 /* UserDataSource.MergeSet */ !== t.it) throw 1 /* UserDataSource.Update */ === t.it ? t.ft(`${this._methodName}() can only appear at the top level of your update data`) : t.ft(`${this._methodName}() cannot be used with set() unless you pass {merge:true}`);
         // No transform to add for a delete, but we need to add it to our
         // fieldMask so it gets deleted.
         return t.fieldMask.push(t.path), null;
@@ -5423,8 +5423,8 @@ class __PRIVATE_NumericIncrementFieldValueImpl extends FieldValue {
  */
     return function __PRIVATE_parseSentinelFieldValue(t, e) {
         // Sentinels are only supported with writes, and not within arrays.
-        if (!__PRIVATE_isWrite(e.it)) throw e.dt(`${t._methodName}() can only be used with update() and set()`);
-        if (!e.path) throw e.dt(`${t._methodName}() is not currently supported inside arrays`);
+        if (!__PRIVATE_isWrite(e.it)) throw e.ft(`${t._methodName}() can only be used with update() and set()`);
+        if (!e.path) throw e.ft(`${t._methodName}() is not currently supported inside arrays`);
         const r = t._toFieldTransform(e);
         r && e.fieldTransforms.push(r);
     }
@@ -5448,7 +5448,7 @@ class __PRIVATE_NumericIncrementFieldValueImpl extends FieldValue {
         // the set of values to be included for the IN query) that may directly
         // contain additional arrays (each representing an individual field
         // value), so we disable this validation.
-        if (e.settings._t && 4 /* UserDataSource.ArrayArgument */ !== e.it) throw e.dt("Nested arrays are not supported");
+        if (e.settings._t && 4 /* UserDataSource.ArrayArgument */ !== e.it) throw e.ft("Nested arrays are not supported");
         return function __PRIVATE_parseArray(t, e) {
             const r = [];
             let n = 0;
@@ -5505,7 +5505,7 @@ class __PRIVATE_NumericIncrementFieldValueImpl extends FieldValue {
         };
         if (t instanceof DocumentReference) {
             const r = e.databaseId, n = t.firestore._databaseId;
-            if (!n.isEqual(r)) throw e.dt(`Document reference is for database ${n.projectId}/${n.database} but should be for database ${r.projectId}/${r.database}`);
+            if (!n.isEqual(r)) throw e.ft(`Document reference is for database ${n.projectId}/${n.database} but should be for database ${r.projectId}/${r.database}`);
             return {
                 referenceValue: __PRIVATE_toResourceName(t.firestore._databaseId || e.databaseId, t._key.path)
             };
@@ -5523,7 +5523,7 @@ class __PRIVATE_NumericIncrementFieldValueImpl extends FieldValue {
                     [X]: {
                         arrayValue: {
                             values: t.toArray().map((t => {
-                                if ("number" != typeof t) throw e.dt("VectorValues must only contain numeric values.");
+                                if ("number" != typeof t) throw e.ft("VectorValues must only contain numeric values.");
                                 return __PRIVATE_toDouble(e.serializer, t);
                             }))
                         }
@@ -5541,7 +5541,7 @@ class __PRIVATE_NumericIncrementFieldValueImpl extends FieldValue {
  * GeoPoints, etc. are not considered to look like JSON objects since they map
  * to specific FieldValue types other than ObjectValue.
  */ (t, e);
-        throw e.dt(`Unsupported field value: ${__PRIVATE_valueDescription(t)}`);
+        throw e.ft(`Unsupported field value: ${__PRIVATE_valueDescription(t)}`);
     }(t, e);
 }
 
@@ -5572,7 +5572,7 @@ function __PRIVATE_validatePlainObject(t, e, r) {
         return "object" == typeof t && null !== t && (Object.getPrototypeOf(t) === Object.prototype || null === Object.getPrototypeOf(t));
     }(r)) {
         const n = __PRIVATE_valueDescription(r);
-        throw "an object" === n ? e.dt(t + " a custom object") : e.dt(t + " " + n);
+        throw "an object" === n ? e.ft(t + " a custom object") : e.ft(t + " " + n);
     }
 }