@firebase/firestore 3.4.3-canary.e28b0e413 → 3.4.4-202211222730

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/dist/firestore/src/api/{query.d.ts → filter.d.ts} +0 -0
  3. package/dist/firestore/src/api.d.ts +1 -1
  4. package/dist/firestore/src/core/database_info.d.ts +1 -0
  5. package/dist/firestore/src/core/target.d.ts +26 -1
  6. package/dist/firestore/src/local/indexeddb_schema.d.ts +121 -7
  7. package/dist/firestore/src/local/local_serializer.d.ts +1 -1
  8. package/dist/firestore/src/local/remote_document_change_buffer.d.ts +3 -12
  9. package/dist/firestore/src/model/document.d.ts +7 -0
  10. package/dist/firestore/src/model/document_key.d.ts +1 -0
  11. package/dist/firestore/src/model/field_index.d.ts +87 -7
  12. package/dist/firestore/src/model/values.d.ts +7 -0
  13. package/dist/firestore/test/unit/local/test_remote_document_cache.d.ts +1 -1
  14. package/dist/firestore/test/unit/model/field_index.test.d.ts +17 -0
  15. package/dist/firestore/test/unit/model/target.test.d.ts +17 -0
  16. package/dist/firestore/test/util/helpers.d.ts +8 -2
  17. package/dist/index.esm2017.js +3407 -3232
  18. package/dist/index.esm2017.js.map +1 -1
  19. package/dist/index.esm5.js +3736 -3630
  20. package/dist/index.esm5.js.map +1 -1
  21. package/dist/index.node.cjs.js +412 -177
  22. package/dist/index.node.cjs.js.map +1 -1
  23. package/dist/index.node.mjs +412 -177
  24. package/dist/index.node.mjs.map +1 -1
  25. package/dist/index.rn.js +3408 -3271
  26. package/dist/index.rn.js.map +1 -1
  27. package/dist/internal.d.ts +12 -12
  28. package/dist/lite/firestore/src/api/{query.d.ts → filter.d.ts} +0 -0
  29. package/dist/lite/firestore/src/api.d.ts +1 -1
  30. package/dist/lite/firestore/src/core/database_info.d.ts +1 -0
  31. package/dist/lite/firestore/src/core/target.d.ts +26 -1
  32. package/dist/lite/firestore/src/local/indexeddb_schema.d.ts +121 -7
  33. package/dist/lite/firestore/src/local/local_serializer.d.ts +1 -1
  34. package/dist/lite/firestore/src/local/remote_document_change_buffer.d.ts +3 -12
  35. package/dist/lite/firestore/src/model/document.d.ts +7 -0
  36. package/dist/lite/firestore/src/model/document_key.d.ts +1 -0
  37. package/dist/lite/firestore/src/model/field_index.d.ts +87 -7
  38. package/dist/lite/firestore/src/model/values.d.ts +7 -0
  39. package/dist/lite/firestore/test/unit/local/test_remote_document_cache.d.ts +1 -1
  40. package/dist/lite/firestore/test/unit/model/field_index.test.d.ts +17 -0
  41. package/dist/lite/firestore/test/unit/model/target.test.d.ts +17 -0
  42. package/dist/lite/firestore/test/util/helpers.d.ts +8 -2
  43. package/dist/lite/index.browser.esm2017.js +80 -69
  44. package/dist/lite/index.browser.esm2017.js.map +1 -1
  45. package/dist/lite/index.browser.esm5.js +94 -87
  46. package/dist/lite/index.browser.esm5.js.map +1 -1
  47. package/dist/lite/index.node.cjs.js +20 -8
  48. package/dist/lite/index.node.cjs.js.map +1 -1
  49. package/dist/lite/index.node.mjs +20 -8
  50. package/dist/lite/index.node.mjs.map +1 -1
  51. package/dist/lite/index.rn.esm2017.js +99 -88
  52. package/dist/lite/index.rn.esm2017.js.map +1 -1
  53. package/dist/lite/internal.d.ts +9 -0
  54. package/dist/lite/packages/firestore/dist/lite/index.browser.esm2017.d.ts +20 -19
  55. package/dist/lite/packages/firestore/src/api/{query.d.ts → filter.d.ts} +0 -0
  56. package/dist/lite/packages/firestore/src/api.d.ts +1 -1
  57. package/dist/lite/packages/firestore/src/core/database_info.d.ts +1 -0
  58. package/dist/lite/packages/firestore/src/core/target.d.ts +26 -1
  59. package/dist/lite/packages/firestore/src/local/indexeddb_schema.d.ts +121 -7
  60. package/dist/lite/packages/firestore/src/local/local_serializer.d.ts +1 -1
  61. package/dist/lite/packages/firestore/src/local/remote_document_change_buffer.d.ts +3 -12
  62. package/dist/lite/packages/firestore/src/model/document.d.ts +7 -0
  63. package/dist/lite/packages/firestore/src/model/document_key.d.ts +1 -0
  64. package/dist/lite/packages/firestore/src/model/field_index.d.ts +87 -7
  65. package/dist/lite/packages/firestore/src/model/values.d.ts +7 -0
  66. package/dist/lite/packages/firestore/test/unit/local/test_remote_document_cache.d.ts +1 -1
  67. package/dist/lite/packages/firestore/test/unit/model/field_index.test.d.ts +17 -0
  68. package/dist/lite/packages/firestore/test/unit/model/target.test.d.ts +17 -0
  69. package/dist/lite/packages/firestore/test/util/helpers.d.ts +8 -2
  70. package/dist/lite/private.d.ts +7 -0
  71. package/dist/packages/firestore/dist/index.esm2017.d.ts +181 -179
  72. package/dist/packages/firestore/src/api/{query.d.ts → filter.d.ts} +0 -0
  73. package/dist/packages/firestore/src/api.d.ts +1 -1
  74. package/dist/packages/firestore/src/core/database_info.d.ts +1 -0
  75. package/dist/packages/firestore/src/core/target.d.ts +26 -1
  76. package/dist/packages/firestore/src/local/indexeddb_schema.d.ts +121 -7
  77. package/dist/packages/firestore/src/local/local_serializer.d.ts +1 -1
  78. package/dist/packages/firestore/src/local/remote_document_change_buffer.d.ts +3 -12
  79. package/dist/packages/firestore/src/model/document.d.ts +7 -0
  80. package/dist/packages/firestore/src/model/document_key.d.ts +1 -0
  81. package/dist/packages/firestore/src/model/field_index.d.ts +87 -7
  82. package/dist/packages/firestore/src/model/values.d.ts +7 -0
  83. package/dist/packages/firestore/test/unit/local/test_remote_document_cache.d.ts +1 -1
  84. package/dist/packages/firestore/test/unit/model/field_index.test.d.ts +17 -0
  85. package/dist/packages/firestore/test/unit/model/target.test.d.ts +17 -0
  86. package/dist/packages/firestore/test/util/helpers.d.ts +8 -2
  87. package/dist/private.d.ts +10 -12
  88. package/package.json +10 -10
package/CHANGELOG.md CHANGED
@@ -1,5 +1,15 @@
1
1
  # @firebase/firestore
2
2
 
3
+ ## 3.4.4
4
+
5
+ ### Patch Changes
6
+
7
+ - [`e28b0e413`](https://github.com/firebase/firebase-js-sdk/commit/e28b0e413decb115c846a7b5ed1e63dbf55c56ab) [#5902](https://github.com/firebase/firebase-js-sdk/pull/5902) (fixes [#5842](https://github.com/firebase/firebase-js-sdk/issues/5842)) - Fixed an AppCheck issue that caused Firestore listeners to stop working and
8
+ receive a "Permission Denied" error. This issue only occurred for AppCheck users
9
+ that set their expiration time to under an hour.
10
+
11
+ * [`d612d6f6e`](https://github.com/firebase/firebase-js-sdk/commit/d612d6f6e4d3113d45427b7df68459c0a3e31a1f) [#5928](https://github.com/firebase/firebase-js-sdk/pull/5928) - Upgrade `node-fetch` dependency due to a security issue.
12
+
3
13
  ## 3.4.3
4
14
 
5
15
  ### Patch Changes
@@ -20,7 +20,7 @@ export { LoadBundleTask, LoadBundleTaskProgress, TaskState } from './api/bundle'
20
20
  export { FirestoreSettings, PersistenceSettings } from './api/settings';
21
21
  export { DocumentChange, DocumentSnapshot, QueryDocumentSnapshot, QuerySnapshot, snapshotEqual, SnapshotOptions, FirestoreDataConverter, DocumentChangeType, SnapshotMetadata } from './api/snapshot';
22
22
  export { DocumentReference, CollectionReference, Query, doc, collection, collectionGroup, SetOptions, DocumentData, UpdateData, WithFieldValue, PartialWithFieldValue, refEqual, queryEqual } from './api/reference';
23
- export { endAt, endBefore, startAt, startAfter, limit, limitToLast, where, orderBy, query, QueryConstraint, QueryConstraintType, OrderByDirection, WhereFilterOp } from './api/query';
23
+ export { endAt, endBefore, startAt, startAfter, limit, limitToLast, where, orderBy, query, QueryConstraint, QueryConstraintType, OrderByDirection, WhereFilterOp } from './api/filter';
24
24
  export { Unsubscribe, SnapshotListenOptions } from './api/reference_impl';
25
25
  export { runTransaction, Transaction } from './api/transaction';
26
26
  export { getDoc, getDocFromCache, getDocFromServer, getDocs, getDocsFromCache, getDocsFromServer, onSnapshot, onSnapshotsInSync, setDoc, updateDoc, deleteDoc, addDoc, executeWrite } from './api/reference_impl';
@@ -50,6 +50,7 @@ export declare class DatabaseId {
50
50
  readonly projectId: string;
51
51
  readonly database: string;
52
52
  constructor(projectId: string, database?: string);
53
+ static empty(): DatabaseId;
53
54
  get isDefaultDatabase(): boolean;
54
55
  isEqual(other: {}): boolean;
55
56
  }
@@ -15,6 +15,7 @@
15
15
  * limitations under the License.
16
16
  */
17
17
  import { Document } from '../model/document';
18
+ import { FieldIndex } from '../model/field_index';
18
19
  import { FieldPath, ResourcePath } from '../model/path';
19
20
  import { Value as ProtoValue } from '../protos/firestore_proto_api';
20
21
  /**
@@ -56,7 +57,31 @@ export declare function newTarget(path: ResourcePath, collectionGroup?: string |
56
57
  export declare function canonifyTarget(target: Target): string;
57
58
  export declare function stringifyTarget(target: Target): string;
58
59
  export declare function targetEquals(left: Target, right: Target): boolean;
59
- export declare function isDocumentTarget(target: Target): boolean;
60
+ export declare function targetIsDocumentTarget(target: Target): boolean;
61
+ /** Returns the field filters that target the given field path. */
62
+ export declare function targetGetFieldFiltersForPath(target: Target, path: FieldPath): FieldFilter[];
63
+ /**
64
+ * Returns the values that are used in ARRAY_CONTAINS or ARRAY_CONTAINS_ANY
65
+ * filters. Returns `null` if there are no such filters.
66
+ */
67
+ export declare function targetGetArrayValues(target: Target, fieldIndex: FieldIndex): ProtoValue[] | null;
68
+ /**
69
+ * Returns the list of values that are used in != or NOT_IN filters. Returns
70
+ * `null` if there are no such filters.
71
+ */
72
+ export declare function targetGetNotInValues(target: Target, fieldIndex: FieldIndex): ProtoValue[] | null;
73
+ /**
74
+ * Returns a lower bound of field values that can be used as a starting point to
75
+ * scan the index defined by `fieldIndex`. Returns `null` if no lower bound
76
+ * exists.
77
+ */
78
+ export declare function targetGetLowerBound(target: Target, fieldIndex: FieldIndex): Bound | null;
79
+ /**
80
+ * Returns an upper bound of field values that can be used as an ending point
81
+ * when scanning the index defined by `fieldIndex`. Returns `null` if no
82
+ * upper bound exists.
83
+ */
84
+ export declare function targetGetUpperBound(target: Target, fieldIndex: FieldIndex): Bound | null;
60
85
  export declare abstract class Filter {
61
86
  abstract matches(doc: Document): boolean;
62
87
  }
@@ -15,10 +15,12 @@
15
15
  * limitations under the License.
16
16
  */
17
17
  import { BatchId, TargetId } from '../core/types';
18
+ import { IndexKind } from '../model/field_index';
18
19
  import { ResourcePath } from '../model/path';
19
20
  import { BundledQuery } from '../protos/firestore_bundle_proto';
20
21
  import { Document as ProtoDocument, DocumentsTarget as ProtoDocumentsTarget, QueryTarget as ProtoQueryTarget, Write as ProtoWrite } from '../protos/firestore_proto_api';
21
22
  import { EncodedResourcePath } from './encoded_resource_path';
23
+ export declare const INDEXING_SCHEMA_VERSION = 12;
22
24
  /**
23
25
  * Schema Version for the Web client:
24
26
  * 1. Initial version including Mutation Queue, Query Cache, and Remote
@@ -37,8 +39,9 @@ import { EncodedResourcePath } from './encoded_resource_path';
37
39
  * an auto-incrementing ID. This is required for Index-Free queries.
38
40
  * 10. Rewrite the canonical IDs to the explicit Protobuf-based format.
39
41
  * 11. Add bundles and named_queries for bundle support.
42
+ * 12. Add indexing support.
40
43
  */
41
- export declare const SCHEMA_VERSION = 11;
44
+ export declare const SCHEMA_VERSION: number;
42
45
  /**
43
46
  * Wrapper class to store timestamps (seconds and nanos) in IndexedDb objects.
44
47
  */
@@ -763,9 +766,7 @@ export declare class DbClientMetadata {
763
766
  /** Object keys in the 'clientMetadata' store are clientId strings. */
764
767
  export declare type DbClientMetadataKey = string;
765
768
  export declare type DbBundlesKey = string;
766
- /**
767
- * A object representing a bundle loaded by the SDK.
768
- */
769
+ /** An object representing a bundle loaded by the SDK. */
769
770
  export declare class DbBundle {
770
771
  /** The ID of the loaded bundle. */
771
772
  bundleId: string;
@@ -785,9 +786,7 @@ export declare class DbBundle {
785
786
  version: number);
786
787
  }
787
788
  export declare type DbNamedQueriesKey = string;
788
- /**
789
- * A object representing a named query loaded by the SDK via a bundle.
790
- */
789
+ /** An object representing a named query loaded by the SDK via a bundle. */
791
790
  export declare class DbNamedQuery {
792
791
  /** The name of the query. */
793
792
  name: string;
@@ -806,12 +805,127 @@ export declare class DbNamedQuery {
806
805
  /** The query saved in the bundle. */
807
806
  bundledQuery: BundledQuery);
808
807
  }
808
+ /** The key for each index consisting of just the index id. */
809
+ export declare type DbIndexConfigurationKey = number;
810
+ /** An object representing the global configuration for a field index. */
811
+ export declare class DbIndexConfiguration {
812
+ /** The index id for this entry. */
813
+ indexId: number;
814
+ /** The collection group this index belongs to. */
815
+ collectionGroup: string;
816
+ /** The fields to index for this index. */
817
+ fields: [[name: string, kind: IndexKind]];
818
+ /** Name of the IndexedDb object store. */
819
+ static store: string;
820
+ static keyPath: string;
821
+ constructor(
822
+ /** The index id for this entry. */
823
+ indexId: number,
824
+ /** The collection group this index belongs to. */
825
+ collectionGroup: string,
826
+ /** The fields to index for this index. */
827
+ fields: [[name: string, kind: IndexKind]]);
828
+ }
829
+ /** The key for each index state consisting of the index id and its user id. */
830
+ export declare type DbIndexStateKey = [number, string];
831
+ /**
832
+ * An object describing how up-to-date the index backfill is for each user and
833
+ * index.
834
+ */
835
+ export declare class DbIndexState {
836
+ /** The index id for this entry. */
837
+ indexId: number;
838
+ /** The user id for this entry. */
839
+ uid: string;
840
+ /**
841
+ * A number that indicates when the index was last updated (relative to
842
+ * other indexes).
843
+ */
844
+ sequenceNumber: number;
845
+ /**
846
+ * The latest read time that has been indexed by Firestore for this field
847
+ * index. Set to `{seconds: 0, nanos: 0}` if no documents have been indexed.
848
+ */
849
+ readTime: DbTimestamp;
850
+ /**
851
+ * The last document that has been indexed for this field index. Empty if
852
+ * no documents have been indexed.
853
+ */
854
+ documentKey: EncodedResourcePath;
855
+ /**
856
+ * The largest mutation batch id that has been processed for this index. -1
857
+ * if no mutations have been indexed.
858
+ */
859
+ largestBatchId: number;
860
+ /** Name of the IndexedDb object store. */
861
+ static store: string;
862
+ static keyPath: string[];
863
+ constructor(
864
+ /** The index id for this entry. */
865
+ indexId: number,
866
+ /** The user id for this entry. */
867
+ uid: string,
868
+ /**
869
+ * A number that indicates when the index was last updated (relative to
870
+ * other indexes).
871
+ */
872
+ sequenceNumber: number,
873
+ /**
874
+ * The latest read time that has been indexed by Firestore for this field
875
+ * index. Set to `{seconds: 0, nanos: 0}` if no documents have been indexed.
876
+ */
877
+ readTime: DbTimestamp,
878
+ /**
879
+ * The last document that has been indexed for this field index. Empty if
880
+ * no documents have been indexed.
881
+ */
882
+ documentKey: EncodedResourcePath,
883
+ /**
884
+ * The largest mutation batch id that has been processed for this index. -1
885
+ * if no mutations have been indexed.
886
+ */
887
+ largestBatchId: number);
888
+ }
889
+ /**
890
+ * The key for each index entry consists of the index id and its user id,
891
+ * the encoded array and directional value for the indexed fields as well as
892
+ * the encoded document path for the indexed document.
893
+ */
894
+ export declare type DbIndexEntryKey = [number, string, Uint8Array, Uint8Array, string];
895
+ /** An object that stores the encoded entries for all documents and fields. */
896
+ export declare class DbIndexEntries {
897
+ /** The index id for this entry. */
898
+ indexId: number;
899
+ /** The user id for this entry. */
900
+ uid: string;
901
+ /** The encoded array index value for this entry. */
902
+ arrayValue: Uint8Array;
903
+ /** The encoded directional value for equality and inequality filters. */
904
+ directionalValue: Uint8Array;
905
+ /** The document key this entry points to. */
906
+ documentKey: EncodedResourcePath;
907
+ /** Name of the IndexedDb object store. */
908
+ static store: string;
909
+ static keyPath: string[];
910
+ constructor(
911
+ /** The index id for this entry. */
912
+ indexId: number,
913
+ /** The user id for this entry. */
914
+ uid: string,
915
+ /** The encoded array index value for this entry. */
916
+ arrayValue: Uint8Array,
917
+ /** The encoded directional value for equality and inequality filters. */
918
+ directionalValue: Uint8Array,
919
+ /** The document key this entry points to. */
920
+ documentKey: EncodedResourcePath);
921
+ }
809
922
  export declare const V1_STORES: string[];
810
923
  export declare const V3_STORES: string[];
811
924
  export declare const V4_STORES: string[];
812
925
  export declare const V6_STORES: string[];
813
926
  export declare const V8_STORES: string[];
814
927
  export declare const V11_STORES: string[];
928
+ export declare const V12_STORES: string[];
815
929
  /**
816
930
  * The list of all default IndexedDB stores used throughout the SDK. This is
817
931
  * used when creating transactions so that access across all stores is done
@@ -31,7 +31,7 @@ export declare class LocalSerializer {
31
31
  /** Decodes a remote document from storage locally to a Document. */
32
32
  export declare function fromDbRemoteDocument(localSerializer: LocalSerializer, remoteDoc: DbRemoteDocument): MutableDocument;
33
33
  /** Encodes a document for storage locally. */
34
- export declare function toDbRemoteDocument(localSerializer: LocalSerializer, document: MutableDocument, readTime: SnapshotVersion): DbRemoteDocument;
34
+ export declare function toDbRemoteDocument(localSerializer: LocalSerializer, document: MutableDocument): DbRemoteDocument;
35
35
  export declare function toDbTimestampKey(snapshotVersion: SnapshotVersion): DbTimestampKey;
36
36
  export declare function fromDbTimestampKey(dbTimestampKey: DbTimestampKey): SnapshotVersion;
37
37
  /** Encodes a batch of mutations into a DbMutationBatch for local storage. */
@@ -21,13 +21,6 @@ import { DocumentKey } from '../model/document_key';
21
21
  import { ObjectMap } from '../util/obj_map';
22
22
  import { PersistencePromise } from './persistence_promise';
23
23
  import { PersistenceTransaction } from './persistence_transaction';
24
- /**
25
- * Represents a document change to be applied to remote document cache.
26
- */
27
- interface RemoteDocumentChange {
28
- readonly document: MutableDocument;
29
- readonly readTime: SnapshotVersion | null;
30
- }
31
24
  /**
32
25
  * An in-memory buffer of entries to be written to a RemoteDocumentCache.
33
26
  * It can be used to batch up a set of changes to be written to the cache, but
@@ -43,26 +36,25 @@ interface RemoteDocumentChange {
43
36
  * porting this class as part of that implementation work.
44
37
  */
45
38
  export declare abstract class RemoteDocumentChangeBuffer {
46
- protected changes: ObjectMap<DocumentKey, RemoteDocumentChange>;
39
+ protected changes: ObjectMap<DocumentKey, MutableDocument>;
47
40
  private changesApplied;
48
41
  protected abstract getFromCache(transaction: PersistenceTransaction, documentKey: DocumentKey): PersistencePromise<MutableDocument>;
49
42
  protected abstract getAllFromCache(transaction: PersistenceTransaction, documentKeys: DocumentKeySet): PersistencePromise<MutableDocumentMap>;
50
43
  protected abstract applyChanges(transaction: PersistenceTransaction): PersistencePromise<void>;
51
- protected getReadTime(key: DocumentKey): SnapshotVersion;
52
44
  /**
53
45
  * Buffers a `RemoteDocumentCache.addEntry()` call.
54
46
  *
55
47
  * You can only modify documents that have already been retrieved via
56
48
  * `getEntry()/getEntries()` (enforced via IndexedDbs `apply()`).
57
49
  */
58
- addEntry(document: MutableDocument, readTime: SnapshotVersion): void;
50
+ addEntry(document: MutableDocument): void;
59
51
  /**
60
52
  * Buffers a `RemoteDocumentCache.removeEntry()` call.
61
53
  *
62
54
  * You can only remove documents that have already been retrieved via
63
55
  * `getEntry()/getEntries()` (enforced via IndexedDbs `apply()`).
64
56
  */
65
- removeEntry(key: DocumentKey, readTime?: SnapshotVersion | null): void;
57
+ removeEntry(key: DocumentKey, readTime: SnapshotVersion): void;
66
58
  /**
67
59
  * Looks up an entry in the cache. The buffered changes will first be checked,
68
60
  * and if no buffered change applies, this will forward to
@@ -94,4 +86,3 @@ export declare abstract class RemoteDocumentChangeBuffer {
94
86
  /** Helper to assert this.changes is not null */
95
87
  protected assertNotApplied(): void;
96
88
  }
97
- export {};
@@ -30,6 +30,11 @@ export interface Document {
30
30
  * document was guaranteed to not exist.
31
31
  */
32
32
  readonly version: SnapshotVersion;
33
+ /**
34
+ * The timestamp at which this document was read from the remote server. Uses
35
+ * `SnapshotVersion.min()` for documents created by the user.
36
+ */
37
+ readonly readTime: SnapshotVersion;
33
38
  /** The underlying data of this document or an empty value if no data exists. */
34
39
  readonly data: ObjectValue;
35
40
  /** Returns whether local mutations were applied via the mutation queue. */
@@ -79,6 +84,7 @@ export declare class MutableDocument implements Document {
79
84
  readonly key: DocumentKey;
80
85
  private documentType;
81
86
  version: SnapshotVersion;
87
+ readTime: SnapshotVersion;
82
88
  data: ObjectValue;
83
89
  private documentState;
84
90
  private constructor();
@@ -118,6 +124,7 @@ export declare class MutableDocument implements Document {
118
124
  convertToUnknownDocument(version: SnapshotVersion): MutableDocument;
119
125
  setHasCommittedMutations(): MutableDocument;
120
126
  setHasLocalMutations(): MutableDocument;
127
+ setReadTime(readTime: SnapshotVersion): MutableDocument;
121
128
  get hasLocalMutations(): boolean;
122
129
  get hasCommittedMutations(): boolean;
123
130
  get hasPendingWrites(): boolean;
@@ -23,6 +23,7 @@ export declare class DocumentKey {
23
23
  constructor(path: ResourcePath);
24
24
  static fromPath(path: string): DocumentKey;
25
25
  static fromName(name: string): DocumentKey;
26
+ static empty(): DocumentKey;
26
27
  /** Returns true if the document is in the specified collectionId. */
27
28
  hasCollectionId(collectionId: string): boolean;
28
29
  isEqual(other: DocumentKey | null): boolean;
@@ -14,7 +14,15 @@
14
14
  * See the License for the specific language governing permissions and
15
15
  * limitations under the License.
16
16
  */
17
+ import { SnapshotVersion } from '../core/snapshot_version';
18
+ import { Document } from './document';
19
+ import { DocumentKey } from './document_key';
17
20
  import { FieldPath } from './path';
21
+ /**
22
+ * The initial sequence number for each index. Gets updated during index
23
+ * backfill.
24
+ */
25
+ export declare const INITIAL_SEQUENCE_NUMBER = 0;
18
26
  /**
19
27
  * An index definition for field indexes in Firestore.
20
28
  *
@@ -35,9 +43,11 @@ export declare class FieldIndex {
35
43
  /** The collection ID this index applies to. */
36
44
  readonly collectionGroup: string;
37
45
  /** The field segments for this index. */
38
- readonly segments: Segment[];
46
+ readonly segments: IndexSegment[];
47
+ /** Shows how up-to-date the index is for the current user. */
48
+ readonly indexState: IndexState;
39
49
  /** An ID for an index that has not yet been added to persistence. */
40
- static UNKNOWN_ID: -1;
50
+ static UNKNOWN_ID: number;
41
51
  constructor(
42
52
  /**
43
53
  * The index ID. Returns -1 if the index ID is not available (e.g. the index
@@ -47,10 +57,21 @@ export declare class FieldIndex {
47
57
  /** The collection ID this index applies to. */
48
58
  collectionGroup: string,
49
59
  /** The field segments for this index. */
50
- segments: Segment[]);
60
+ segments: IndexSegment[],
61
+ /** Shows how up-to-date the index is for the current user. */
62
+ indexState: IndexState);
51
63
  }
64
+ /** Returns the ArrayContains/ArrayContainsAny segment for this index. */
65
+ export declare function fieldIndexGetArraySegment(fieldIndex: FieldIndex): IndexSegment | undefined;
66
+ /** Returns all directional (ascending/descending) segments for this index. */
67
+ export declare function fieldIndexGetDirectionalSegments(fieldIndex: FieldIndex): IndexSegment[];
68
+ /**
69
+ * Compares indexes by collection group and segments. Ignores update time and
70
+ * index ID.
71
+ */
72
+ export declare function fieldIndexSemanticComparator(left: FieldIndex, right: FieldIndex): number;
52
73
  /** The type of the index, e.g. for which type of query it can be used. */
53
- export declare const enum Kind {
74
+ export declare const enum IndexKind {
54
75
  /**
55
76
  * Ordered index. Can be used for <, <=, ==, >=, >, !=, IN and NOT IN queries.
56
77
  */
@@ -63,14 +84,73 @@ export declare const enum Kind {
63
84
  CONTAINS = 2
64
85
  }
65
86
  /** An index component consisting of field path and index type. */
66
- export declare class Segment {
87
+ export declare class IndexSegment {
67
88
  /** The field path of the component. */
68
89
  readonly fieldPath: FieldPath;
69
90
  /** The fields sorting order. */
70
- readonly kind: Kind;
91
+ readonly kind: IndexKind;
71
92
  constructor(
72
93
  /** The field path of the component. */
73
94
  fieldPath: FieldPath,
74
95
  /** The fields sorting order. */
75
- kind: Kind);
96
+ kind: IndexKind);
97
+ }
98
+ /**
99
+ * Stores the "high water mark" that indicates how updated the Index is for the
100
+ * current user.
101
+ */
102
+ export declare class IndexState {
103
+ /**
104
+ * Indicates when the index was last updated (relative to other indexes).
105
+ */
106
+ readonly sequenceNumber: number;
107
+ /** The the latest indexed read time, document and batch id. */
108
+ readonly offset: IndexOffset;
109
+ constructor(
110
+ /**
111
+ * Indicates when the index was last updated (relative to other indexes).
112
+ */
113
+ sequenceNumber: number,
114
+ /** The the latest indexed read time, document and batch id. */
115
+ offset: IndexOffset);
116
+ /** The state of an index that has not yet been backfilled. */
117
+ static empty(): IndexState;
118
+ }
119
+ /**
120
+ * Creates an offset that matches all documents with a read time higher than
121
+ * `readTime`.
122
+ */
123
+ export declare function newIndexOffsetSuccessorFromReadTime(readTime: SnapshotVersion, largestBatchId: number): IndexOffset;
124
+ /** Creates a new offset based on the provided document. */
125
+ export declare function newIndexOffsetFromDocument(document: Document): IndexOffset;
126
+ /**
127
+ * Stores the latest read time, document and batch ID that were processed for an
128
+ * index.
129
+ */
130
+ export declare class IndexOffset {
131
+ /**
132
+ * The latest read time version that has been indexed by Firestore for this
133
+ * field index.
134
+ */
135
+ readonly readTime: SnapshotVersion;
136
+ /**
137
+ * The key of the last document that was indexed for this query. Use
138
+ * `DocumentKey.empty()` if no document has been indexed.
139
+ */
140
+ readonly documentKey: DocumentKey;
141
+ readonly largestBatchId: number;
142
+ constructor(
143
+ /**
144
+ * The latest read time version that has been indexed by Firestore for this
145
+ * field index.
146
+ */
147
+ readTime: SnapshotVersion,
148
+ /**
149
+ * The key of the last document that was indexed for this query. Use
150
+ * `DocumentKey.empty()` if no document has been indexed.
151
+ */
152
+ documentKey: DocumentKey, largestBatchId: number);
153
+ /** The state of an index that has not yet been backfilled. */
154
+ static min(): IndexOffset;
76
155
  }
156
+ export declare function indexOffsetComparator(left: IndexOffset, right: IndexOffset): number;
@@ -19,6 +19,7 @@ import { ArrayValue, MapValue, Value } from '../protos/firestore_proto_api';
19
19
  import { DocumentKey } from './document_key';
20
20
  import { TypeOrder } from './type_order';
21
21
  export declare const MAX_VALUE: Value;
22
+ export declare const MIN_VALUE: Value;
22
23
  /** Extracts the backend's type order for the provided value. */
23
24
  export declare function typeOrder(value: Value): TypeOrder;
24
25
  /** Tests `left` and `right` for equality based on the backend semantics. */
@@ -76,3 +77,9 @@ export declare function isMapValue(value?: Value | null): value is {
76
77
  export declare function deepClone(source: Value): Value;
77
78
  /** Returns true if the Value represents the canonical {@link #MAX_VALUE} . */
78
79
  export declare function isMaxValue(value: Value): boolean;
80
+ /** Returns the lowest value for the given value type (inclusive). */
81
+ export declare function valuesGetLowerBound(value: Value): Value;
82
+ /** Returns the largest value for the given value type (exclusive). */
83
+ export declare function valuesGetUpperBound(value: Value): Value;
84
+ export declare function valuesMax(left: Value | undefined, right: Value | undefined): Value | undefined;
85
+ export declare function valuesMin(left: Value | undefined, right: Value | undefined): Value | undefined;
@@ -33,7 +33,7 @@ export declare class TestRemoteDocumentCache {
33
33
  * Reads all of the documents first so we can safely add them and keep the size calculation in
34
34
  * sync.
35
35
  */
36
- addEntries(documents: MutableDocument[], readTime: SnapshotVersion): Promise<void>;
36
+ addEntries(documents: MutableDocument[]): Promise<void>;
37
37
  /**
38
38
  * Adds a single document using the document's version as its read time.
39
39
  * Reads the document first to track the document size internally.
@@ -0,0 +1,17 @@
1
+ /**
2
+ * @license
3
+ * Copyright 2022 Google LLC
4
+ *
5
+ * Licensed under the Apache License, Version 2.0 (the "License");
6
+ * you may not use this file except in compliance with the License.
7
+ * You may obtain a copy of the License at
8
+ *
9
+ * http://www.apache.org/licenses/LICENSE-2.0
10
+ *
11
+ * Unless required by applicable law or agreed to in writing, software
12
+ * distributed under the License is distributed on an "AS IS" BASIS,
13
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ * See the License for the specific language governing permissions and
15
+ * limitations under the License.
16
+ */
17
+ export {};
@@ -0,0 +1,17 @@
1
+ /**
2
+ * @license
3
+ * Copyright 2022 Google LLC
4
+ *
5
+ * Licensed under the Apache License, Version 2.0 (the "License");
6
+ * you may not use this file except in compliance with the License.
7
+ * You may obtain a copy of the License at
8
+ *
9
+ * http://www.apache.org/licenses/LICENSE-2.0
10
+ *
11
+ * Unless required by applicable law or agreed to in writing, software
12
+ * distributed under the License is distributed on an "AS IS" BASIS,
13
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ * See the License for the specific language governing permissions and
15
+ * limitations under the License.
16
+ */
17
+ export {};
@@ -14,7 +14,7 @@
14
14
  * See the License for the specific language governing permissions and
15
15
  * limitations under the License.
16
16
  */
17
- import { Bytes, DocumentReference, OrderByDirection } from '../../src';
17
+ import { Bytes, DocumentReference } from '../../src';
18
18
  import { BundledDocuments } from '../../src/core/bundle';
19
19
  import { DatabaseId } from '../../src/core/database_info';
20
20
  import { Query } from '../../src/core/query';
@@ -30,6 +30,7 @@ import { Document, MutableDocument } from '../../src/model/document';
30
30
  import { DocumentComparator } from '../../src/model/document_comparator';
31
31
  import { DocumentKey } from '../../src/model/document_key';
32
32
  import { DocumentSet } from '../../src/model/document_set';
33
+ import { FieldIndex, IndexKind, IndexOffset } from '../../src/model/field_index';
33
34
  import { FieldMask } from '../../src/model/field_mask';
34
35
  import { DeleteMutation, MutationResult, PatchMutation, Precondition, SetMutation } from '../../src/model/mutation';
35
36
  import { JsonObject, ObjectValue } from '../../src/model/object_value';
@@ -58,6 +59,11 @@ export declare function key(path: string): DocumentKey;
58
59
  export declare function keys(...documents: Array<Document | string>): DocumentKeySet;
59
60
  export declare function path(path: string, offset?: number): ResourcePath;
60
61
  export declare function field(path: string): FieldPath;
62
+ export declare function fieldIndex(collectionGroup: string, options?: {
63
+ id?: number;
64
+ fields?: Array<[field: string, kind: IndexKind]>;
65
+ offset?: IndexOffset;
66
+ }): FieldIndex;
61
67
  export declare function mask(...paths: string[]): FieldMask;
62
68
  export declare function blob(...bytes: number[]): Bytes;
63
69
  export declare function filter(path: string, op: string, value: unknown): FieldFilter;
@@ -65,7 +71,7 @@ export declare function setMutation(keyStr: string, json: JsonObject<unknown>):
65
71
  export declare function patchMutation(keyStr: string, json: JsonObject<unknown>, precondition?: Precondition): PatchMutation;
66
72
  export declare function deleteMutation(keyStr: string): DeleteMutation;
67
73
  export declare function mutationResult(testVersion: TestSnapshotVersion): MutationResult;
68
- export declare function bound(values: Array<[string, {}, OrderByDirection]>, before: boolean): Bound;
74
+ export declare function bound(values: unknown[], before: boolean): Bound;
69
75
  export declare function query(resourcePath: string, ...constraints: Array<OrderBy | Filter>): Query;
70
76
  export declare function targetData(targetId: TargetId, queryPurpose: TargetPurpose, path: string): TargetData;
71
77
  export declare function noChangeEvent(targetId: number, snapshotVersion: number, resumeToken?: ByteString): RemoteEvent;