@firebase/firestore 3.7.3 → 3.8.0
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.
- package/CHANGELOG.md +18 -0
- package/dist/firestore/lite/index.d.ts +1 -1
- package/dist/firestore/src/api/filter.d.ts +1 -1
- package/dist/firestore/src/api.d.ts +1 -1
- package/dist/firestore/src/core/bound.d.ts +49 -0
- package/dist/firestore/src/core/filter.d.ts +134 -0
- package/dist/firestore/src/core/order_by.d.ts +35 -0
- package/dist/firestore/src/core/query.d.ts +5 -6
- package/dist/firestore/src/core/target.d.ts +4 -120
- package/dist/firestore/src/lite-api/query.d.ts +273 -66
- package/dist/firestore/src/local/indexeddb_index_manager.d.ts +2 -0
- package/dist/firestore/src/local/local_documents_view.d.ts +0 -2
- package/dist/firestore/src/model/document.d.ts +8 -1
- package/dist/firestore/src/protos/firestore_proto_api.d.ts +1 -1
- package/dist/firestore/src/remote/serializer.d.ts +10 -3
- package/dist/firestore/src/util/logic_utils.d.ts +52 -0
- package/dist/firestore/src/util/types.d.ts +1 -1
- package/dist/firestore/test/lite/helpers.d.ts +1 -1
- package/dist/firestore/test/unit/core/filter.test.d.ts +17 -0
- package/dist/firestore/test/unit/specs/spec_test_runner.d.ts +2 -1
- package/dist/firestore/test/unit/util/logic_utils.test.d.ts +17 -0
- package/dist/firestore/test/util/helpers.d.ts +6 -2
- package/dist/firestore/test/util/test_platform.d.ts +2 -2
- package/dist/index.d.ts +138 -62
- package/dist/index.esm2017.js +4295 -3742
- package/dist/index.esm2017.js.map +1 -1
- package/dist/index.esm5.js +4981 -4410
- package/dist/index.esm5.js.map +1 -1
- package/dist/index.node.cjs.js +1657 -889
- package/dist/index.node.cjs.js.map +1 -1
- package/dist/index.node.mjs +1650 -890
- package/dist/index.node.mjs.map +1 -1
- package/dist/index.rn.js +4520 -3967
- package/dist/index.rn.js.map +1 -1
- package/dist/internal.d.ts +328 -68
- package/dist/lite/firestore/lite/index.d.ts +1 -1
- package/dist/lite/firestore/src/api/filter.d.ts +1 -1
- package/dist/lite/firestore/src/api.d.ts +1 -1
- package/dist/lite/firestore/src/core/bound.d.ts +49 -0
- package/dist/lite/firestore/src/core/filter.d.ts +134 -0
- package/dist/lite/firestore/src/core/order_by.d.ts +35 -0
- package/dist/lite/firestore/src/core/query.d.ts +5 -6
- package/dist/lite/firestore/src/core/target.d.ts +4 -120
- package/dist/lite/firestore/src/lite-api/query.d.ts +273 -66
- package/dist/lite/firestore/src/local/indexeddb_index_manager.d.ts +2 -0
- package/dist/lite/firestore/src/local/local_documents_view.d.ts +0 -2
- package/dist/lite/firestore/src/model/document.d.ts +8 -1
- package/dist/lite/firestore/src/protos/firestore_proto_api.d.ts +1 -1
- package/dist/lite/firestore/src/remote/serializer.d.ts +10 -3
- package/dist/lite/firestore/src/util/logic_utils.d.ts +52 -0
- package/dist/lite/firestore/src/util/types.d.ts +1 -1
- package/dist/lite/firestore/test/lite/helpers.d.ts +1 -1
- package/dist/lite/firestore/test/unit/core/filter.test.d.ts +17 -0
- package/dist/lite/firestore/test/unit/specs/spec_test_runner.d.ts +2 -1
- package/dist/lite/firestore/test/unit/util/logic_utils.test.d.ts +17 -0
- package/dist/lite/firestore/test/util/helpers.d.ts +6 -2
- package/dist/lite/firestore/test/util/test_platform.d.ts +2 -2
- package/dist/lite/index.browser.esm2017.js +2091 -1793
- package/dist/lite/index.browser.esm2017.js.map +1 -1
- package/dist/lite/index.browser.esm5.js +2239 -2000
- package/dist/lite/index.browser.esm5.js.map +1 -1
- package/dist/lite/index.d.ts +138 -62
- package/dist/lite/index.node.cjs.js +2212 -1802
- package/dist/lite/index.node.cjs.js.map +1 -1
- package/dist/lite/index.node.mjs +2205 -1803
- package/dist/lite/index.node.mjs.map +1 -1
- package/dist/lite/index.rn.esm2017.js +2077 -1778
- package/dist/lite/index.rn.esm2017.js.map +1 -1
- package/dist/lite/internal.d.ts +328 -66
- package/dist/lite/packages/firestore/dist/lite/index.browser.esm2017.d.ts +322 -174
- package/dist/lite/packages/firestore/lite/index.d.ts +1 -1
- package/dist/lite/packages/firestore/rollup.config.debug.d.ts +1 -1
- package/dist/lite/packages/firestore/src/api/filter.d.ts +1 -1
- package/dist/lite/packages/firestore/src/api.d.ts +1 -1
- package/dist/lite/packages/firestore/src/core/bound.d.ts +49 -0
- package/dist/lite/packages/firestore/src/core/filter.d.ts +134 -0
- package/dist/lite/packages/firestore/src/core/order_by.d.ts +35 -0
- package/dist/lite/packages/firestore/src/core/query.d.ts +5 -6
- package/dist/lite/packages/firestore/src/core/target.d.ts +4 -120
- package/dist/lite/packages/firestore/src/lite-api/query.d.ts +273 -66
- package/dist/lite/packages/firestore/src/local/indexeddb_index_manager.d.ts +2 -0
- package/dist/lite/packages/firestore/src/local/local_documents_view.d.ts +0 -2
- package/dist/lite/packages/firestore/src/model/document.d.ts +8 -1
- package/dist/lite/packages/firestore/src/protos/firestore_proto_api.d.ts +1 -1
- package/dist/lite/packages/firestore/src/remote/serializer.d.ts +10 -3
- package/dist/lite/packages/firestore/src/util/logic_utils.d.ts +52 -0
- package/dist/lite/packages/firestore/src/util/types.d.ts +1 -1
- package/dist/lite/packages/firestore/test/lite/helpers.d.ts +1 -1
- package/dist/lite/packages/firestore/test/unit/core/filter.test.d.ts +17 -0
- package/dist/lite/packages/firestore/test/unit/specs/spec_test_runner.d.ts +2 -1
- package/dist/lite/packages/firestore/test/unit/util/logic_utils.test.d.ts +17 -0
- package/dist/lite/packages/firestore/test/util/helpers.d.ts +6 -2
- package/dist/lite/packages/firestore/test/util/test_platform.d.ts +2 -2
- package/dist/lite/private.d.ts +240 -66
- package/dist/packages/firestore/dist/index.esm2017.d.ts +368 -208
- package/dist/packages/firestore/lite/index.d.ts +1 -1
- package/dist/packages/firestore/rollup.config.debug.d.ts +1 -1
- package/dist/packages/firestore/src/api/filter.d.ts +1 -1
- package/dist/packages/firestore/src/api.d.ts +1 -1
- package/dist/packages/firestore/src/core/bound.d.ts +49 -0
- package/dist/packages/firestore/src/core/filter.d.ts +134 -0
- package/dist/packages/firestore/src/core/order_by.d.ts +35 -0
- package/dist/packages/firestore/src/core/query.d.ts +5 -6
- package/dist/packages/firestore/src/core/target.d.ts +4 -120
- package/dist/packages/firestore/src/lite-api/query.d.ts +273 -66
- package/dist/packages/firestore/src/local/indexeddb_index_manager.d.ts +2 -0
- package/dist/packages/firestore/src/local/local_documents_view.d.ts +0 -2
- package/dist/packages/firestore/src/model/document.d.ts +8 -1
- package/dist/packages/firestore/src/protos/firestore_proto_api.d.ts +1 -1
- package/dist/packages/firestore/src/remote/serializer.d.ts +10 -3
- package/dist/packages/firestore/src/util/logic_utils.d.ts +52 -0
- package/dist/packages/firestore/src/util/types.d.ts +1 -1
- package/dist/packages/firestore/test/lite/helpers.d.ts +1 -1
- package/dist/packages/firestore/test/unit/core/filter.test.d.ts +17 -0
- package/dist/packages/firestore/test/unit/specs/spec_test_runner.d.ts +2 -1
- package/dist/packages/firestore/test/unit/util/logic_utils.test.d.ts +17 -0
- package/dist/packages/firestore/test/util/helpers.d.ts +6 -2
- package/dist/packages/firestore/test/util/test_platform.d.ts +2 -2
- package/dist/private.d.ts +240 -68
- package/package.json +13 -11
|
@@ -33,13 +33,13 @@
|
|
|
33
33
|
/**
|
|
34
34
|
* Represents an aggregation that can be performed by Firestore.
|
|
35
35
|
*/
|
|
36
|
-
declare class
|
|
36
|
+
declare class Tn {
|
|
37
37
|
/** A type string to uniquely identify instances of this class. */
|
|
38
38
|
type: string;
|
|
39
39
|
}
|
|
40
40
|
/**
|
|
41
41
|
* The results of executing an aggregation query.
|
|
42
|
-
*/ declare class
|
|
42
|
+
*/ declare class An {
|
|
43
43
|
/** @hideconstructor */
|
|
44
44
|
constructor(t: any, e: any);
|
|
45
45
|
_data: any;
|
|
@@ -76,18 +76,18 @@ declare class yn {
|
|
|
76
76
|
*/
|
|
77
77
|
/**
|
|
78
78
|
* An immutable object representing an array of bytes.
|
|
79
|
-
*/ declare class
|
|
79
|
+
*/ declare class qn {
|
|
80
80
|
/**
|
|
81
81
|
* Creates a new `Bytes` object from the given Base64 string, converting it to
|
|
82
82
|
* bytes.
|
|
83
83
|
*
|
|
84
84
|
* @param base64 - The Base64 string used to create the `Bytes` object.
|
|
85
|
-
*/ static fromBase64String(t: any):
|
|
85
|
+
*/ static fromBase64String(t: any): qn;
|
|
86
86
|
/**
|
|
87
87
|
* Creates a new `Bytes` object from the given Uint8Array.
|
|
88
88
|
*
|
|
89
89
|
* @param array - The Uint8Array used to create the `Bytes` object.
|
|
90
|
-
*/ static fromUint8Array(t: any):
|
|
90
|
+
*/ static fromUint8Array(t: any): qn;
|
|
91
91
|
/** @hideconstructor */
|
|
92
92
|
constructor(t: any);
|
|
93
93
|
_byteString: any;
|
|
@@ -116,7 +116,7 @@ declare class yn {
|
|
|
116
116
|
/**
|
|
117
117
|
* A `CollectionReference` object can be used for adding documents, getting
|
|
118
118
|
* document references, and querying for documents (using {@link query}).
|
|
119
|
-
*/ declare class
|
|
119
|
+
*/ declare class $n extends Vn {
|
|
120
120
|
_path: any;
|
|
121
121
|
/** The collection's identifier. */ get id(): any;
|
|
122
122
|
/**
|
|
@@ -126,7 +126,8 @@ declare class yn {
|
|
|
126
126
|
/**
|
|
127
127
|
* A reference to the containing `DocumentReference` if this is a
|
|
128
128
|
* subcollection. If this isn't a subcollection, the reference is null.
|
|
129
|
-
*/ get parent():
|
|
129
|
+
*/ get parent(): Pn | null;
|
|
130
|
+
withConverter(t: any): $n;
|
|
130
131
|
}
|
|
131
132
|
/**
|
|
132
133
|
* @license
|
|
@@ -148,7 +149,7 @@ declare class yn {
|
|
|
148
149
|
* A `DocumentReference` refers to a document location in a Firestore database
|
|
149
150
|
* and can be used to write, read, or listen to the location. The document at
|
|
150
151
|
* the referenced location may or may not exist.
|
|
151
|
-
*/ declare class
|
|
152
|
+
*/ declare class Pn {
|
|
152
153
|
/** @hideconstructor */
|
|
153
154
|
constructor(t: any, e: any, n: any);
|
|
154
155
|
converter: any;
|
|
@@ -166,8 +167,8 @@ declare class yn {
|
|
|
166
167
|
*/ get path(): any;
|
|
167
168
|
/**
|
|
168
169
|
* The collection this `DocumentReference` belongs to.
|
|
169
|
-
*/ get parent():
|
|
170
|
-
withConverter(t: any):
|
|
170
|
+
*/ get parent(): $n;
|
|
171
|
+
withConverter(t: any): Pn;
|
|
171
172
|
}
|
|
172
173
|
/**
|
|
173
174
|
* @license
|
|
@@ -193,7 +194,7 @@ declare class yn {
|
|
|
193
194
|
* For a `DocumentSnapshot` that points to a non-existing document, any data
|
|
194
195
|
* access will return 'undefined'. You can use the `exists()` method to
|
|
195
196
|
* explicitly verify a document's existence.
|
|
196
|
-
*/ declare class
|
|
197
|
+
*/ declare class fr {
|
|
197
198
|
/** @hideconstructor protected */
|
|
198
199
|
constructor(t: any, e: any, n: any, r: any, s: any);
|
|
199
200
|
_firestore: any;
|
|
@@ -204,7 +205,7 @@ declare class yn {
|
|
|
204
205
|
/** Property of the `DocumentSnapshot` that provides the document's ID. */ get id(): any;
|
|
205
206
|
/**
|
|
206
207
|
* The `DocumentReference` for the document included in the `DocumentSnapshot`.
|
|
207
|
-
*/ get ref():
|
|
208
|
+
*/ get ref(): Pn;
|
|
208
209
|
/**
|
|
209
210
|
* Signals whether or not the document at the snapshot's location exists.
|
|
210
211
|
*
|
|
@@ -251,7 +252,7 @@ declare class yn {
|
|
|
251
252
|
*
|
|
252
253
|
* Create a `FieldPath` by providing field names. If more than one field
|
|
253
254
|
* name is provided, the path will point to a nested field in a document.
|
|
254
|
-
*/ declare class
|
|
255
|
+
*/ declare class On {
|
|
255
256
|
/**
|
|
256
257
|
* Creates a `FieldPath` from the provided field names. If more than one field
|
|
257
258
|
* name is provided, the path will point to a nested field in a document.
|
|
@@ -286,7 +287,7 @@ declare class yn {
|
|
|
286
287
|
/**
|
|
287
288
|
* Sentinel values that can be used when writing document fields with `set()`
|
|
288
289
|
* or `update()`.
|
|
289
|
-
*/ declare class
|
|
290
|
+
*/ declare class Cn {
|
|
290
291
|
/**
|
|
291
292
|
* @param _methodName - The public API endpoint that returns this class.
|
|
292
293
|
* @hideconstructor
|
|
@@ -314,7 +315,7 @@ declare class yn {
|
|
|
314
315
|
* The Cloud Firestore service interface.
|
|
315
316
|
*
|
|
316
317
|
* Do not call this constructor directly. Instead, use {@link (getFirestore:1)}.
|
|
317
|
-
*/ declare class
|
|
318
|
+
*/ declare class _n {
|
|
318
319
|
/** @hideconstructor */
|
|
319
320
|
constructor(t: any, e: any, n: any, r: any);
|
|
320
321
|
_authCredentials: any;
|
|
@@ -326,7 +327,7 @@ declare class yn {
|
|
|
326
327
|
*/
|
|
327
328
|
type: string;
|
|
328
329
|
_persistenceKey: string;
|
|
329
|
-
_settings:
|
|
330
|
+
_settings: gn;
|
|
330
331
|
_settingsFrozen: boolean;
|
|
331
332
|
/**
|
|
332
333
|
* The {@link @firebase/app#FirebaseApp} associated with this `Firestore` service
|
|
@@ -335,14 +336,14 @@ declare class yn {
|
|
|
335
336
|
get _initialized(): boolean;
|
|
336
337
|
get _terminated(): boolean;
|
|
337
338
|
_setSettings(t: any): void;
|
|
338
|
-
_getSettings():
|
|
339
|
-
_freezeSettings():
|
|
339
|
+
_getSettings(): gn;
|
|
340
|
+
_freezeSettings(): gn;
|
|
340
341
|
_delete(): Promise<void>;
|
|
341
342
|
_terminateTask: Promise<void> | undefined;
|
|
342
343
|
/** Returns a JSON-serializable representation of this `Firestore` instance. */ toJSON(): {
|
|
343
344
|
app: any;
|
|
344
345
|
databaseId: any;
|
|
345
|
-
settings:
|
|
346
|
+
settings: gn;
|
|
346
347
|
};
|
|
347
348
|
/**
|
|
348
349
|
* Terminates all components used by this client. Subclasses can override
|
|
@@ -355,6 +356,8 @@ declare class yn {
|
|
|
355
356
|
/** An error returned by a Firestore operation. */ declare class U extends c {
|
|
356
357
|
/** @hideconstructor */
|
|
357
358
|
constructor(t: any, e: any);
|
|
359
|
+
code: any;
|
|
360
|
+
message: any;
|
|
358
361
|
}
|
|
359
362
|
/**
|
|
360
363
|
* @license
|
|
@@ -378,7 +381,7 @@ declare class yn {
|
|
|
378
381
|
*
|
|
379
382
|
* Latitude values are in the range of [-90, 90].
|
|
380
383
|
* Longitude values are in the range of [-180, 180].
|
|
381
|
-
*/ declare class
|
|
384
|
+
*/ declare class Ln {
|
|
382
385
|
/**
|
|
383
386
|
* Creates a new immutable `GeoPoint` object with the provided latitude and
|
|
384
387
|
* longitude values.
|
|
@@ -412,7 +415,7 @@ declare class yn {
|
|
|
412
415
|
/**
|
|
413
416
|
* A `Query` refers to a query which you can read or listen to. You can also
|
|
414
417
|
* construct refined `Query` objects by adding filters and ordering.
|
|
415
|
-
*/ declare class
|
|
418
|
+
*/ declare class Vn {
|
|
416
419
|
/** @hideconstructor protected */
|
|
417
420
|
constructor(t: any, e: any, n: any);
|
|
418
421
|
converter: any;
|
|
@@ -420,33 +423,37 @@ declare class yn {
|
|
|
420
423
|
/** The type of this Firestore reference. */
|
|
421
424
|
type: string;
|
|
422
425
|
firestore: any;
|
|
423
|
-
withConverter(t: any):
|
|
426
|
+
withConverter(t: any): Vn;
|
|
424
427
|
}
|
|
425
428
|
/**
|
|
426
|
-
*
|
|
427
|
-
*
|
|
428
|
-
*
|
|
429
|
-
*
|
|
430
|
-
*
|
|
431
|
-
*
|
|
432
|
-
*
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
429
|
+
* A `QueryCompositeFilterConstraint` is used to narrow the set of documents
|
|
430
|
+
* returned by a Firestore query by performing the logical OR or AND of multiple
|
|
431
|
+
* {@link QueryFieldFilterConstraint}s or {@link QueryCompositeFilterConstraint}s.
|
|
432
|
+
* `QueryCompositeFilterConstraint`s are created by invoking {@link or} or
|
|
433
|
+
* {@link and} and can then be passed to {@link query} to create a new query
|
|
434
|
+
* instance that also contains the `QueryCompositeFilterConstraint`.
|
|
435
|
+
* @internal TODO remove this internal tag with OR Query support in the server
|
|
436
|
+
*/ declare class Er extends yr {
|
|
437
|
+
static _create(t: any, e: any): Er;
|
|
438
|
+
/**
|
|
439
|
+
* @internal
|
|
440
|
+
*/
|
|
441
|
+
constructor(t: any, e: any);
|
|
442
|
+
type: any;
|
|
443
|
+
_queryConstraints: any;
|
|
444
|
+
_parse(t: any): any;
|
|
445
|
+
_apply(t: any): any;
|
|
446
|
+
_getQueryConstraints(): any;
|
|
447
|
+
_getOperator(): "and" | "or";
|
|
448
|
+
}
|
|
441
449
|
/**
|
|
442
450
|
* A `QueryConstraint` is used to narrow the set of documents returned by a
|
|
443
451
|
* Firestore query. `QueryConstraint`s are created by invoking {@link where},
|
|
444
|
-
* {@link orderBy}, {@link
|
|
445
|
-
* endBefore
|
|
452
|
+
* {@link orderBy}, {@link startAt}, {@link startAfter}, {@link
|
|
453
|
+
* endBefore}, {@link endAt}, {@link limit}, {@link limitToLast} and
|
|
446
454
|
* can then be passed to {@link query} to create a new query instance that
|
|
447
455
|
* also contains this `QueryConstraint`.
|
|
448
|
-
*/
|
|
449
|
-
declare class hr {
|
|
456
|
+
*/ declare class gr extends yr {
|
|
450
457
|
}
|
|
451
458
|
/**
|
|
452
459
|
* A `QueryDocumentSnapshot` contains data read from a document in your
|
|
@@ -458,7 +465,81 @@ declare class hr {
|
|
|
458
465
|
* `DocumentSnapshot`. Since query results contain only existing documents, the
|
|
459
466
|
* `exists` property will always be true and `data()` will never return
|
|
460
467
|
* 'undefined'.
|
|
461
|
-
*/ declare class
|
|
468
|
+
*/ declare class dr extends fr {
|
|
469
|
+
}
|
|
470
|
+
/**
|
|
471
|
+
* A `QueryEndAtConstraint` is used to exclude documents from the end of a
|
|
472
|
+
* result set returned by a Firestore query.
|
|
473
|
+
* `QueryEndAtConstraint`s are created by invoking {@link (endAt:1)} or
|
|
474
|
+
* {@link (endBefore:1)} and can then be passed to {@link query} to create a new
|
|
475
|
+
* query instance that also contains this `QueryEndAtConstraint`.
|
|
476
|
+
*/ declare class xr extends gr {
|
|
477
|
+
static _create(t: any, e: any, n: any): xr;
|
|
478
|
+
/**
|
|
479
|
+
* @internal
|
|
480
|
+
*/
|
|
481
|
+
constructor(t: any, e: any, n: any);
|
|
482
|
+
type: any;
|
|
483
|
+
_docOrFields: any;
|
|
484
|
+
_inclusive: any;
|
|
485
|
+
_apply(t: any): Vn;
|
|
486
|
+
}
|
|
487
|
+
/**
|
|
488
|
+
* A `QueryFieldFilterConstraint` is used to narrow the set of documents returned by
|
|
489
|
+
* a Firestore query by filtering on one or more document fields.
|
|
490
|
+
* `QueryFieldFilterConstraint`s are created by invoking {@link where} and can then
|
|
491
|
+
* be passed to {@link query} to create a new query instance that also contains
|
|
492
|
+
* this `QueryFieldFilterConstraint`.
|
|
493
|
+
*/ declare class vr extends gr {
|
|
494
|
+
static _create(t: any, e: any, n: any): vr;
|
|
495
|
+
/**
|
|
496
|
+
* @internal
|
|
497
|
+
*/
|
|
498
|
+
constructor(t: any, e: any, n: any);
|
|
499
|
+
_field: any;
|
|
500
|
+
_op: any;
|
|
501
|
+
_value: any;
|
|
502
|
+
/** The type of this query constraint */
|
|
503
|
+
type: string;
|
|
504
|
+
_apply(t: any): Vn;
|
|
505
|
+
_parse(t: any): Gt | Jt | re;
|
|
506
|
+
}
|
|
507
|
+
/**
|
|
508
|
+
* A `QueryLimitConstraint` is used to limit the number of documents returned by
|
|
509
|
+
* a Firestore query.
|
|
510
|
+
* `QueryLimitConstraint`s are created by invoking {@link limit} or
|
|
511
|
+
* {@link limitToLast} and can then be passed to {@link query} to create a new
|
|
512
|
+
* query instance that also contains this `QueryLimitConstraint`.
|
|
513
|
+
*/ declare class Pr extends gr {
|
|
514
|
+
static _create(t: any, e: any, n: any): Pr;
|
|
515
|
+
/**
|
|
516
|
+
* @internal
|
|
517
|
+
*/
|
|
518
|
+
constructor(t: any, e: any, n: any);
|
|
519
|
+
type: any;
|
|
520
|
+
_limit: any;
|
|
521
|
+
_limitType: any;
|
|
522
|
+
_apply(t: any): Vn;
|
|
523
|
+
}
|
|
524
|
+
/**
|
|
525
|
+
* A `QueryOrderByConstraint` is used to sort the set of documents returned by a
|
|
526
|
+
* Firestore query. `QueryOrderByConstraint`s are created by invoking
|
|
527
|
+
* {@link orderBy} and can then be passed to {@link query} to create a new query
|
|
528
|
+
* instance that also contains this `QueryOrderByConstraint`.
|
|
529
|
+
*
|
|
530
|
+
* Note: Documents that do not contain the orderBy field will not be present in
|
|
531
|
+
* the query result.
|
|
532
|
+
*/ declare class Ar extends gr {
|
|
533
|
+
static _create(t: any, e: any): Ar;
|
|
534
|
+
/**
|
|
535
|
+
* @internal
|
|
536
|
+
*/
|
|
537
|
+
constructor(t: any, e: any);
|
|
538
|
+
_field: any;
|
|
539
|
+
_direction: any;
|
|
540
|
+
/** The type of this query constraint */
|
|
541
|
+
type: string;
|
|
542
|
+
_apply(t: any): Vn;
|
|
462
543
|
}
|
|
463
544
|
/**
|
|
464
545
|
* A `QuerySnapshot` contains zero or more `DocumentSnapshot` objects
|
|
@@ -466,7 +547,7 @@ declare class hr {
|
|
|
466
547
|
* array via the `docs` property or enumerated using the `forEach` method. The
|
|
467
548
|
* number of documents can be determined via the `empty` and `size`
|
|
468
549
|
* properties.
|
|
469
|
-
*/ declare class
|
|
550
|
+
*/ declare class wr {
|
|
470
551
|
/** @hideconstructor */
|
|
471
552
|
constructor(t: any, e: any);
|
|
472
553
|
_docs: any;
|
|
@@ -482,6 +563,23 @@ declare class hr {
|
|
|
482
563
|
* @param thisArg - The `this` binding for the callback.
|
|
483
564
|
*/ forEach(t: any, e: any): void;
|
|
484
565
|
}
|
|
566
|
+
/**
|
|
567
|
+
* A `QueryStartAtConstraint` is used to exclude documents from the start of a
|
|
568
|
+
* result set returned by a Firestore query.
|
|
569
|
+
* `QueryStartAtConstraint`s are created by invoking {@link (startAt:1)} or
|
|
570
|
+
* {@link (startAfter:1)} and can then be passed to {@link query} to create a
|
|
571
|
+
* new query instance that also contains this `QueryStartAtConstraint`.
|
|
572
|
+
*/ declare class Nr extends gr {
|
|
573
|
+
static _create(t: any, e: any, n: any): Nr;
|
|
574
|
+
/**
|
|
575
|
+
* @internal
|
|
576
|
+
*/
|
|
577
|
+
constructor(t: any, e: any, n: any);
|
|
578
|
+
type: any;
|
|
579
|
+
_docOrFields: any;
|
|
580
|
+
_inclusive: any;
|
|
581
|
+
_apply(t: any): Vn;
|
|
582
|
+
}
|
|
485
583
|
/**
|
|
486
584
|
* @license
|
|
487
585
|
* Copyright 2017 Google LLC
|
|
@@ -512,19 +610,19 @@ declare class hr {
|
|
|
512
610
|
* For examples and further specifications, refer to the
|
|
513
611
|
* {@link https://github.com/google/protobuf/blob/master/src/google/protobuf/timestamp.proto | Timestamp definition}.
|
|
514
612
|
*/
|
|
515
|
-
declare class
|
|
613
|
+
declare class Vt {
|
|
516
614
|
/**
|
|
517
615
|
* Creates a new timestamp with the current date, with millisecond precision.
|
|
518
616
|
*
|
|
519
617
|
* @returns a new timestamp representing the current date.
|
|
520
|
-
*/ static now():
|
|
618
|
+
*/ static now(): Vt;
|
|
521
619
|
/**
|
|
522
620
|
* Creates a new timestamp from the given date.
|
|
523
621
|
*
|
|
524
622
|
* @param date - The date to initialize the `Timestamp` from.
|
|
525
623
|
* @returns A new `Timestamp` representing the same point in time as the given
|
|
526
624
|
* date.
|
|
527
|
-
*/ static fromDate(t: any):
|
|
625
|
+
*/ static fromDate(t: any): Vt;
|
|
528
626
|
/**
|
|
529
627
|
* Creates a new timestamp from the given number of milliseconds.
|
|
530
628
|
*
|
|
@@ -532,7 +630,7 @@ declare class bt {
|
|
|
532
630
|
* 1970-01-01T00:00:00Z.
|
|
533
631
|
* @returns A new `Timestamp` representing the same point in time as the given
|
|
534
632
|
* number of milliseconds.
|
|
535
|
-
*/ static fromMillis(t: any):
|
|
633
|
+
*/ static fromMillis(t: any): Vt;
|
|
536
634
|
/**
|
|
537
635
|
* Creates a new timestamp.
|
|
538
636
|
*
|
|
@@ -579,26 +677,26 @@ declare class bt {
|
|
|
579
677
|
* to be compared using the `>`, `<=`, `>=` and `>` operators.
|
|
580
678
|
*/ valueOf(): string;
|
|
581
679
|
}
|
|
582
|
-
declare class
|
|
680
|
+
declare class fs {
|
|
583
681
|
/** @hideconstructor */
|
|
584
682
|
constructor(t: any, e: any);
|
|
585
683
|
_firestore: any;
|
|
586
684
|
_transaction: any;
|
|
587
|
-
_dataReader:
|
|
685
|
+
_dataReader: zn;
|
|
588
686
|
/**
|
|
589
687
|
* Reads the document referenced by the provided {@link DocumentReference}.
|
|
590
688
|
*
|
|
591
689
|
* @param documentRef - A reference to the document to be read.
|
|
592
690
|
* @returns A `DocumentSnapshot` with the read data.
|
|
593
691
|
*/ get(t: any): any;
|
|
594
|
-
set(t: any, e: any, n: any):
|
|
595
|
-
update(t: any, e: any, n: any, ...r: any[]):
|
|
692
|
+
set(t: any, e: any, n: any): fs;
|
|
693
|
+
update(t: any, e: any, n: any, ...r: any[]): fs;
|
|
596
694
|
/**
|
|
597
695
|
* Deletes the document referred to by the provided {@link DocumentReference}.
|
|
598
696
|
*
|
|
599
697
|
* @param documentRef - A reference to the document to be deleted.
|
|
600
698
|
* @returns This `Transaction` instance. Used for chaining method calls.
|
|
601
|
-
*/ delete(t: any):
|
|
699
|
+
*/ delete(t: any): fs;
|
|
602
700
|
}
|
|
603
701
|
/**
|
|
604
702
|
* @license
|
|
@@ -623,22 +721,22 @@ declare class Zr {
|
|
|
623
721
|
* provides methods for adding writes to the write batch. None of the writes
|
|
624
722
|
* will be committed (or visible locally) until {@link WriteBatch.commit} is
|
|
625
723
|
* called.
|
|
626
|
-
*/ declare class
|
|
724
|
+
*/ declare class rs {
|
|
627
725
|
/** @hideconstructor */
|
|
628
726
|
constructor(t: any, e: any);
|
|
629
727
|
_firestore: any;
|
|
630
728
|
_commitHandler: any;
|
|
631
729
|
_mutations: any[];
|
|
632
730
|
_committed: boolean;
|
|
633
|
-
_dataReader:
|
|
634
|
-
set(t: any, e: any, n: any):
|
|
635
|
-
update(t: any, e: any, n: any, ...r: any[]):
|
|
731
|
+
_dataReader: zn;
|
|
732
|
+
set(t: any, e: any, n: any): rs;
|
|
733
|
+
update(t: any, e: any, n: any, ...r: any[]): rs;
|
|
636
734
|
/**
|
|
637
735
|
* Deletes the document referred to by the provided {@link DocumentReference}.
|
|
638
736
|
*
|
|
639
737
|
* @param documentRef - A reference to the document to be deleted.
|
|
640
738
|
* @returns This `WriteBatch` instance. Used for chaining method calls.
|
|
641
|
-
*/ delete(t: any):
|
|
739
|
+
*/ delete(t: any): rs;
|
|
642
740
|
/**
|
|
643
741
|
* Commits all of the writes in this write batch as a single atomic unit.
|
|
644
742
|
*
|
|
@@ -667,7 +765,7 @@ declare class Zr {
|
|
|
667
765
|
* @throws Error - If the provided input is not a valid Firestore document.
|
|
668
766
|
* @returns A `Promise` resolved with a `DocumentReference` pointing to the
|
|
669
767
|
* newly created document after it has been written to the backend.
|
|
670
|
-
*/ declare function
|
|
768
|
+
*/ declare function Yr(t: any, e: any): Promise<Pn>;
|
|
671
769
|
/**
|
|
672
770
|
* Compares two `AggregateQuerySnapshot` instances for equality.
|
|
673
771
|
*
|
|
@@ -679,7 +777,17 @@ declare class Zr {
|
|
|
679
777
|
*
|
|
680
778
|
* @returns `true` if the objects are "equal", as defined above, or `false`
|
|
681
779
|
* otherwise.
|
|
682
|
-
*/ declare function
|
|
780
|
+
*/ declare function Jr(t: any, e: any): boolean;
|
|
781
|
+
/**
|
|
782
|
+
* Creates a {@link QueryCompositeFilterConstraint} that performs a logical AND
|
|
783
|
+
* of all the provided {@link QueryFilterConstraint}s.
|
|
784
|
+
*
|
|
785
|
+
* @param queryConstraints - Optional. The {@link QueryFilterConstraint}s
|
|
786
|
+
* for AND operation. These must be created with calls to {@link where},
|
|
787
|
+
* {@link or}, or {@link and}.
|
|
788
|
+
* @returns The created {@link QueryCompositeFilterConstraint}.
|
|
789
|
+
* @internal TODO remove this internal tag with OR Query support in the server
|
|
790
|
+
*/ declare function Tr(...t: any[]): Er;
|
|
683
791
|
/**
|
|
684
792
|
* Returns a special value that can be used with {@link (setDoc:1)} or {@link
|
|
685
793
|
* updateDoc:1} that tells the server to remove the given elements from any
|
|
@@ -690,7 +798,7 @@ declare class Zr {
|
|
|
690
798
|
* @param elements - The elements to remove from the array.
|
|
691
799
|
* @returns The `FieldValue` sentinel for use in a call to `setDoc()` or
|
|
692
800
|
* `updateDoc()`
|
|
693
|
-
*/ declare function
|
|
801
|
+
*/ declare function es(...t: any[]): Xn;
|
|
694
802
|
/**
|
|
695
803
|
* Returns a special value that can be used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link
|
|
696
804
|
* @firebase/firestore/lite#(updateDoc:1)} that tells the server to union the given elements with any array
|
|
@@ -702,8 +810,8 @@ declare class Zr {
|
|
|
702
810
|
* @param elements - The elements to union into the array.
|
|
703
811
|
* @returns The `FieldValue` sentinel for use in a call to `setDoc()` or
|
|
704
812
|
* `updateDoc()`.
|
|
705
|
-
*/ declare function
|
|
706
|
-
declare function
|
|
813
|
+
*/ declare function ts(...t: any[]): Jn;
|
|
814
|
+
declare function Nn(t: any, e: any, ...n: any[]): $n;
|
|
707
815
|
/**
|
|
708
816
|
* Creates and returns a new `Query` instance that includes all documents in the
|
|
709
817
|
* database that are contained in a collection or subcollection with the
|
|
@@ -714,7 +822,7 @@ declare function In(t: any, e: any, ...n: any[]): En;
|
|
|
714
822
|
* collection or subcollection with this ID as the last segment of its path
|
|
715
823
|
* will be included. Cannot contain a slash.
|
|
716
824
|
* @returns The created `Query`.
|
|
717
|
-
*/ declare function
|
|
825
|
+
*/ declare function Dn(t: any, e: any): Vn;
|
|
718
826
|
/**
|
|
719
827
|
* Modify this instance to communicate with the Cloud Firestore emulator.
|
|
720
828
|
*
|
|
@@ -727,7 +835,7 @@ declare function In(t: any, e: any, ...n: any[]): En;
|
|
|
727
835
|
* @param port - the emulator port (ex: 9000).
|
|
728
836
|
* @param options.mockUserToken - the mock auth token to use for unit testing
|
|
729
837
|
* Security Rules.
|
|
730
|
-
*/ declare function
|
|
838
|
+
*/ declare function En(t: any, e: any, n: any, r?: {}): void;
|
|
731
839
|
/**
|
|
732
840
|
* Deletes the document referred to by the specified `DocumentReference`.
|
|
733
841
|
*
|
|
@@ -739,7 +847,7 @@ declare function In(t: any, e: any, ...n: any[]): En;
|
|
|
739
847
|
* @param reference - A reference to the document to delete.
|
|
740
848
|
* @returns A `Promise` resolved once the document has been successfully
|
|
741
849
|
* deleted from the backend.
|
|
742
|
-
*/ declare function
|
|
850
|
+
*/ declare function Kr(t: any): Promise<void>;
|
|
743
851
|
/**
|
|
744
852
|
* @license
|
|
745
853
|
* Copyright 2020 Google LLC
|
|
@@ -759,14 +867,14 @@ declare function In(t: any, e: any, ...n: any[]): En;
|
|
|
759
867
|
/**
|
|
760
868
|
* Returns a sentinel for use with {@link @firebase/firestore/lite#(updateDoc:1)} or
|
|
761
869
|
* {@link @firebase/firestore/lite#(setDoc:1)} with `{merge: true}` to mark a field for deletion.
|
|
762
|
-
*/ declare function
|
|
763
|
-
declare function
|
|
870
|
+
*/ declare function Xr(): Kn;
|
|
871
|
+
declare function Fn(t: any, e: any, ...n: any[]): Pn;
|
|
764
872
|
/**
|
|
765
873
|
* Returns a special sentinel `FieldPath` to refer to the ID of a document.
|
|
766
874
|
* It can be used in queries to sort or filter by the document ID.
|
|
767
|
-
*/ declare function
|
|
768
|
-
declare function
|
|
769
|
-
declare function
|
|
875
|
+
*/ declare function kn(): On;
|
|
876
|
+
declare function qr(...t: any[]): xr;
|
|
877
|
+
declare function Sr(...t: any[]): xr;
|
|
770
878
|
/**
|
|
771
879
|
* @license
|
|
772
880
|
* Copyright 2022 Google LLC
|
|
@@ -796,7 +904,7 @@ declare function Ir(...t: any[]): Er;
|
|
|
796
904
|
* @returns A Promise that will be resolved with the count; the count can be
|
|
797
905
|
* retrieved from `snapshot.data().count`, where `snapshot` is the
|
|
798
906
|
* `AggregateQuerySnapshot` to which the returned Promise resolves.
|
|
799
|
-
*/ declare function
|
|
907
|
+
*/ declare function Hr(t: any): Promise<An>;
|
|
800
908
|
/**
|
|
801
909
|
* Reads the document referred to by the specified document reference.
|
|
802
910
|
*
|
|
@@ -809,7 +917,7 @@ declare function Ir(...t: any[]): Er;
|
|
|
809
917
|
* @param reference - The reference of the document to fetch.
|
|
810
918
|
* @returns A Promise resolved with a `DocumentSnapshot` containing the current
|
|
811
919
|
* document contents.
|
|
812
|
-
*/ declare function
|
|
920
|
+
*/ declare function Qr(t: any): Promise<fr>;
|
|
813
921
|
/**
|
|
814
922
|
* Executes the query and returns the results as a {@link QuerySnapshot}.
|
|
815
923
|
*
|
|
@@ -821,8 +929,8 @@ declare function Ir(...t: any[]): Er;
|
|
|
821
929
|
*
|
|
822
930
|
* @param query - The `Query` to execute.
|
|
823
931
|
* @returns A Promise that will be resolved with the results of the query.
|
|
824
|
-
*/ declare function
|
|
825
|
-
declare function
|
|
932
|
+
*/ declare function zr(t: any): Promise<wr>;
|
|
933
|
+
declare function bn(e: any, n: any): import("../../lite").Firestore;
|
|
826
934
|
/**
|
|
827
935
|
* Returns a special value that can be used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link
|
|
828
936
|
* @firebase/firestore/lite#(updateDoc:1)} that tells the server to increment the field's current value by
|
|
@@ -841,41 +949,48 @@ declare function wn(e: any, n: any): import("../../lite").Firestore;
|
|
|
841
949
|
* @param n - The value to increment by.
|
|
842
950
|
* @returns The `FieldValue` sentinel for use in a call to `setDoc()` or
|
|
843
951
|
* `updateDoc()`
|
|
844
|
-
*/ declare function
|
|
845
|
-
declare function
|
|
952
|
+
*/ declare function ns(t: any): Zn;
|
|
953
|
+
declare function vn(t: any, e: any, n: any): import("../../lite").Firestore;
|
|
846
954
|
/**
|
|
847
|
-
* Creates a {@link
|
|
955
|
+
* Creates a {@link QueryLimitConstraint} that only returns the first matching
|
|
956
|
+
* documents.
|
|
848
957
|
*
|
|
849
958
|
* @param limit - The maximum number of items to return.
|
|
850
|
-
* @returns The created {@link
|
|
851
|
-
*/ declare function
|
|
959
|
+
* @returns The created {@link QueryLimitConstraint}.
|
|
960
|
+
*/ declare function Vr(t: any): Pr;
|
|
852
961
|
/**
|
|
853
|
-
* Creates a {@link
|
|
962
|
+
* Creates a {@link QueryLimitConstraint} that only returns the last matching
|
|
963
|
+
* documents.
|
|
854
964
|
*
|
|
855
965
|
* You must specify at least one `orderBy` clause for `limitToLast` queries,
|
|
856
966
|
* otherwise an exception will be thrown during execution.
|
|
857
967
|
*
|
|
858
968
|
* @param limit - The maximum number of items to return.
|
|
859
|
-
* @returns The created {@link
|
|
860
|
-
*/ declare function
|
|
969
|
+
* @returns The created {@link QueryLimitConstraint}.
|
|
970
|
+
*/ declare function $r(t: any): Pr;
|
|
971
|
+
/**
|
|
972
|
+
* Creates a {@link QueryCompositeFilterConstraint} that performs a logical OR
|
|
973
|
+
* of all the provided {@link QueryFilterConstraint}s.
|
|
974
|
+
*
|
|
975
|
+
* @param queryConstraints - Optional. The {@link QueryFilterConstraint}s
|
|
976
|
+
* for OR operation. These must be created with calls to {@link where},
|
|
977
|
+
* {@link or}, or {@link and}.
|
|
978
|
+
* @returns The created {@link QueryCompositeFilterConstraint}.
|
|
979
|
+
* @internal TODO remove this internal tag with OR Query support in the server
|
|
980
|
+
*/ declare function Ir(...t: any[]): Er;
|
|
861
981
|
/**
|
|
862
|
-
* Creates a {@link
|
|
982
|
+
* Creates a {@link QueryOrderByConstraint} that sorts the query result by the
|
|
863
983
|
* specified field, optionally in descending order instead of ascending.
|
|
864
984
|
*
|
|
985
|
+
* Note: Documents that do not contain the specified field will not be present
|
|
986
|
+
* in the query result.
|
|
987
|
+
*
|
|
865
988
|
* @param fieldPath - The field to sort by.
|
|
866
989
|
* @param directionStr - Optional direction to sort by ('asc' or 'desc'). If
|
|
867
990
|
* not specified, order will be ascending.
|
|
868
|
-
* @returns The created {@link
|
|
869
|
-
*/ declare function
|
|
870
|
-
|
|
871
|
-
* Creates a new immutable instance of {@link Query} that is extended to also include
|
|
872
|
-
* additional query constraints.
|
|
873
|
-
*
|
|
874
|
-
* @param query - The {@link Query} instance to use as a base for the new constraints.
|
|
875
|
-
* @param queryConstraints - The list of {@link QueryConstraint}s to apply.
|
|
876
|
-
* @throws if any of the provided query constraints cannot be combined with the
|
|
877
|
-
* existing or new constraints.
|
|
878
|
-
*/ declare function lr(t: any, ...e: any[]): any;
|
|
991
|
+
* @returns The created {@link QueryOrderByConstraint}.
|
|
992
|
+
*/ declare function Rr(t: any, e?: string): Ar;
|
|
993
|
+
declare function _r(t: any, e: any, ...n: any[]): any;
|
|
879
994
|
/**
|
|
880
995
|
* Returns true if the provided queries point to the same collection and apply
|
|
881
996
|
* the same constraints.
|
|
@@ -884,7 +999,7 @@ declare function dn(t: any, e: any, n: any): import("../../lite").Firestore;
|
|
|
884
999
|
* @param right - A `Query` to compare.
|
|
885
1000
|
* @returns true if the references point to the same location in the same
|
|
886
1001
|
* Firestore database.
|
|
887
|
-
*/ declare function
|
|
1002
|
+
*/ declare function Sn(t: any, e: any): boolean;
|
|
888
1003
|
/**
|
|
889
1004
|
* Returns true if the provided references are equal.
|
|
890
1005
|
*
|
|
@@ -892,7 +1007,7 @@ declare function dn(t: any, e: any, n: any): import("../../lite").Firestore;
|
|
|
892
1007
|
* @param right - A reference to compare.
|
|
893
1008
|
* @returns true if the references point to the same location in the same
|
|
894
1009
|
* Firestore database.
|
|
895
|
-
*/ declare function
|
|
1010
|
+
*/ declare function xn(t: any, e: any): boolean;
|
|
896
1011
|
/**
|
|
897
1012
|
* Executes the given `updateFunction` and then attempts to commit the changes
|
|
898
1013
|
* applied within the transaction. If any document read within the transaction
|
|
@@ -911,12 +1026,12 @@ declare function dn(t: any, e: any, n: any): import("../../lite").Firestore;
|
|
|
911
1026
|
* (the `updateFunction` returned a failed promise), the promise returned by the
|
|
912
1027
|
* `updateFunction `is returned here. Otherwise, if the transaction failed, a
|
|
913
1028
|
* rejected promise with the corresponding failure error is returned.
|
|
914
|
-
*/ declare function
|
|
1029
|
+
*/ declare function ds(t: any, e: any, n: any): Promise<any>;
|
|
915
1030
|
/**
|
|
916
1031
|
* Returns a sentinel used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link @firebase/firestore/lite#(updateDoc:1)} to
|
|
917
1032
|
* include a server-generated timestamp in the written data.
|
|
918
|
-
*/ declare function
|
|
919
|
-
declare function
|
|
1033
|
+
*/ declare function Zr(): Hn;
|
|
1034
|
+
declare function Wr(t: any, e: any, n: any): Promise<void>;
|
|
920
1035
|
/**
|
|
921
1036
|
* Sets the verbosity of Cloud Firestore logs (debug, error, or silent).
|
|
922
1037
|
*
|
|
@@ -936,9 +1051,9 @@ declare function Fr(t: any, e: any, n: any): Promise<void>;
|
|
|
936
1051
|
* @param left - A snapshot to compare.
|
|
937
1052
|
* @param right - A snapshot to compare.
|
|
938
1053
|
* @returns true if the snapshots are equal.
|
|
939
|
-
*/ declare function
|
|
940
|
-
declare function
|
|
941
|
-
declare function
|
|
1054
|
+
*/ declare function mr(t: any, e: any): any;
|
|
1055
|
+
declare function Fr(...t: any[]): Nr;
|
|
1056
|
+
declare function Dr(...t: any[]): Nr;
|
|
942
1057
|
/**
|
|
943
1058
|
* Terminates the provided `Firestore` instance.
|
|
944
1059
|
*
|
|
@@ -958,19 +1073,19 @@ declare function vr(...t: any[]): gr;
|
|
|
958
1073
|
* @param firestore - The `Firestore` instance to terminate.
|
|
959
1074
|
* @returns A `Promise` that is resolved when the instance has been successfully
|
|
960
1075
|
* terminated.
|
|
961
|
-
*/ declare function
|
|
962
|
-
declare function
|
|
1076
|
+
*/ declare function In(t: any): any;
|
|
1077
|
+
declare function Gr(t: any, e: any, n: any, ...r: any[]): Promise<void>;
|
|
963
1078
|
/**
|
|
964
|
-
* Creates a {@link
|
|
965
|
-
* specified field and that the value should satisfy the
|
|
966
|
-
* provided.
|
|
1079
|
+
* Creates a {@link QueryFieldFilterConstraint} that enforces that documents
|
|
1080
|
+
* must contain the specified field and that the value should satisfy the
|
|
1081
|
+
* relation constraint provided.
|
|
967
1082
|
*
|
|
968
1083
|
* @param fieldPath - The path to compare
|
|
969
1084
|
* @param opStr - The operation string (e.g "<", "<=", "==", "<",
|
|
970
1085
|
* "<=", "!=").
|
|
971
1086
|
* @param value - The value for comparison
|
|
972
|
-
* @returns The created {@link
|
|
973
|
-
*/ declare function
|
|
1087
|
+
* @returns The created {@link QueryFieldFilterConstraint}.
|
|
1088
|
+
*/ declare function br(t: any, e: any, n: any): vr;
|
|
974
1089
|
/**
|
|
975
1090
|
* Creates a write batch, used for performing multiple writes as a single
|
|
976
1091
|
* atomic operation. The maximum number of writes allowed in a single WriteBatch
|
|
@@ -983,7 +1098,7 @@ declare function Sr(t: any, e: any, n: any, ...r: any[]): Promise<void>;
|
|
|
983
1098
|
*
|
|
984
1099
|
* @returns A `WriteBatch` that can be used to atomically execute multiple
|
|
985
1100
|
* writes.
|
|
986
|
-
*/ declare function
|
|
1101
|
+
*/ declare function is(t: any): rs;
|
|
987
1102
|
/**
|
|
988
1103
|
* A dot-separated path for navigating sub-objects within a document.
|
|
989
1104
|
* @internal
|
|
@@ -1022,7 +1137,7 @@ declare function Sr(t: any, e: any, n: any, ...r: any[]): Promise<void>;
|
|
|
1022
1137
|
* user-supplied `FirestoreSettings` object. This is a separate type so that
|
|
1023
1138
|
* defaults can be supplied and the value can be checked for equality.
|
|
1024
1139
|
*/
|
|
1025
|
-
declare class
|
|
1140
|
+
declare class gn {
|
|
1026
1141
|
constructor(t: any);
|
|
1027
1142
|
host: any;
|
|
1028
1143
|
ssl: any;
|
|
@@ -1035,78 +1150,89 @@ declare class ln {
|
|
|
1035
1150
|
isEqual(t: any): boolean;
|
|
1036
1151
|
}
|
|
1037
1152
|
import { FirebaseError as c } from "@firebase/util/dist/src/errors";
|
|
1153
|
+
/**
|
|
1154
|
+
* @license
|
|
1155
|
+
* Copyright 2020 Google LLC
|
|
1156
|
+
*
|
|
1157
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
1158
|
+
* you may not use this file except in compliance with the License.
|
|
1159
|
+
* You may obtain a copy of the License at
|
|
1160
|
+
*
|
|
1161
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
1162
|
+
*
|
|
1163
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
1164
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
1165
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
1166
|
+
* See the License for the specific language governing permissions and
|
|
1167
|
+
* limitations under the License.
|
|
1168
|
+
*/
|
|
1169
|
+
/**
|
|
1170
|
+
* An `AppliableConstraint` is an abstraction of a constraint that can be applied
|
|
1171
|
+
* to a Firestore query.
|
|
1172
|
+
*/
|
|
1173
|
+
declare class yr {
|
|
1174
|
+
}
|
|
1175
|
+
declare class Gt extends Wt {
|
|
1176
|
+
/**
|
|
1177
|
+
* Creates a filter based on the provided arguments.
|
|
1178
|
+
*/ static create(t: any, e: any, n: any): Gt | Jt | re;
|
|
1179
|
+
static createKeyFieldInFilter(t: any, e: any, n: any): Jt | Xt;
|
|
1180
|
+
constructor(t: any, e: any, n: any);
|
|
1181
|
+
field: any;
|
|
1182
|
+
op: any;
|
|
1183
|
+
value: any;
|
|
1184
|
+
matches(t: any): boolean | void;
|
|
1185
|
+
matchesComparison(t: any): boolean | void;
|
|
1186
|
+
isInequality(): boolean;
|
|
1187
|
+
getFlattenedFilters(): Gt[];
|
|
1188
|
+
getFilters(): Gt[];
|
|
1189
|
+
getFirstInequalityField(): any;
|
|
1190
|
+
}
|
|
1191
|
+
/** Filter that matches on key fields within an array. */ declare class Jt extends Gt {
|
|
1192
|
+
constructor(t: any, e: any);
|
|
1193
|
+
keys: any;
|
|
1194
|
+
matches(t: any): any;
|
|
1195
|
+
}
|
|
1196
|
+
/** A Filter that implements the array-contains-any operator. */ declare class re extends Gt {
|
|
1197
|
+
constructor(t: any, e: any);
|
|
1198
|
+
matches(t: any): any;
|
|
1199
|
+
}
|
|
1038
1200
|
/**
|
|
1039
1201
|
* Helper for parsing raw user input (provided via the API) into internal model
|
|
1040
1202
|
* classes.
|
|
1041
|
-
*/ declare class
|
|
1203
|
+
*/ declare class zn {
|
|
1042
1204
|
constructor(t: any, e: any, n: any);
|
|
1043
1205
|
databaseId: any;
|
|
1044
1206
|
ignoreUndefinedProperties: any;
|
|
1045
|
-
|
|
1046
|
-
/** Creates a new top-level parse context. */
|
|
1207
|
+
C: any;
|
|
1208
|
+
/** Creates a new top-level parse context. */ ft(t: any, e: any, n: any, r?: boolean): Qn;
|
|
1047
1209
|
}
|
|
1048
|
-
declare class
|
|
1210
|
+
declare class Xn extends Cn {
|
|
1049
1211
|
constructor(t: any, e: any);
|
|
1050
|
-
|
|
1051
|
-
_toFieldTransform(t: any):
|
|
1212
|
+
dt: any;
|
|
1213
|
+
_toFieldTransform(t: any): De;
|
|
1052
1214
|
isEqual(t: any): boolean;
|
|
1053
1215
|
}
|
|
1054
|
-
declare class
|
|
1216
|
+
declare class Jn extends Cn {
|
|
1055
1217
|
constructor(t: any, e: any);
|
|
1056
|
-
|
|
1057
|
-
_toFieldTransform(t: any):
|
|
1218
|
+
dt: any;
|
|
1219
|
+
_toFieldTransform(t: any): De;
|
|
1058
1220
|
isEqual(t: any): boolean;
|
|
1059
1221
|
}
|
|
1060
|
-
declare class
|
|
1222
|
+
declare class Kn extends Cn {
|
|
1061
1223
|
_toFieldTransform(t: any): null;
|
|
1062
1224
|
isEqual(t: any): boolean;
|
|
1063
1225
|
}
|
|
1064
|
-
declare class
|
|
1065
|
-
constructor(t: any, e: any, n: any);
|
|
1066
|
-
type: any;
|
|
1067
|
-
Tt: any;
|
|
1068
|
-
At: any;
|
|
1069
|
-
_apply(t: any): bn;
|
|
1070
|
-
}
|
|
1071
|
-
declare class Gn extends Dn {
|
|
1226
|
+
declare class Zn extends Cn {
|
|
1072
1227
|
constructor(t: any, e: any);
|
|
1073
|
-
|
|
1074
|
-
_toFieldTransform(t: any):
|
|
1228
|
+
wt: any;
|
|
1229
|
+
_toFieldTransform(t: any): De;
|
|
1075
1230
|
isEqual(t: any): boolean;
|
|
1076
1231
|
}
|
|
1077
|
-
declare class
|
|
1078
|
-
|
|
1079
|
-
type: any;
|
|
1080
|
-
Et: any;
|
|
1081
|
-
It: any;
|
|
1082
|
-
_apply(t: any): bn;
|
|
1083
|
-
}
|
|
1084
|
-
declare class wr extends hr {
|
|
1085
|
-
constructor(t: any, e: any);
|
|
1086
|
-
_t: any;
|
|
1087
|
-
bt: any;
|
|
1088
|
-
type: string;
|
|
1089
|
-
_apply(t: any): bn;
|
|
1090
|
-
}
|
|
1091
|
-
declare class Bn extends Dn {
|
|
1092
|
-
_toFieldTransform(t: any): Pe;
|
|
1232
|
+
declare class Hn extends Cn {
|
|
1233
|
+
_toFieldTransform(t: any): De;
|
|
1093
1234
|
isEqual(t: any): boolean;
|
|
1094
1235
|
}
|
|
1095
|
-
declare class gr extends hr {
|
|
1096
|
-
constructor(t: any, e: any, n: any);
|
|
1097
|
-
type: any;
|
|
1098
|
-
Tt: any;
|
|
1099
|
-
At: any;
|
|
1100
|
-
_apply(t: any): bn;
|
|
1101
|
-
}
|
|
1102
|
-
declare class fr extends hr {
|
|
1103
|
-
constructor(t: any, e: any, n: any);
|
|
1104
|
-
_t: any;
|
|
1105
|
-
gt: any;
|
|
1106
|
-
vt: any;
|
|
1107
|
-
type: string;
|
|
1108
|
-
_apply(t: any): bn;
|
|
1109
|
-
}
|
|
1110
1236
|
/**
|
|
1111
1237
|
* Path represents an ordered sequence of string segments.
|
|
1112
1238
|
*/
|
|
@@ -1131,7 +1257,29 @@ declare class Z {
|
|
|
1131
1257
|
forEach(t: any): void;
|
|
1132
1258
|
toArray(): any;
|
|
1133
1259
|
}
|
|
1134
|
-
/**
|
|
1260
|
+
/**
|
|
1261
|
+
* @license
|
|
1262
|
+
* Copyright 2022 Google LLC
|
|
1263
|
+
*
|
|
1264
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
1265
|
+
* you may not use this file except in compliance with the License.
|
|
1266
|
+
* You may obtain a copy of the License at
|
|
1267
|
+
*
|
|
1268
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
1269
|
+
*
|
|
1270
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
1271
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
1272
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
1273
|
+
* See the License for the specific language governing permissions and
|
|
1274
|
+
* limitations under the License.
|
|
1275
|
+
*/ declare class Wt {
|
|
1276
|
+
}
|
|
1277
|
+
/** Filter that matches on key fields not present within an array. */ declare class Xt extends Gt {
|
|
1278
|
+
constructor(t: any, e: any);
|
|
1279
|
+
keys: any;
|
|
1280
|
+
matches(t: any): boolean;
|
|
1281
|
+
}
|
|
1282
|
+
/** A "context" object passed around while parsing user data. */ declare class Qn {
|
|
1135
1283
|
/**
|
|
1136
1284
|
* Initializes a ParseContext with the given source and path.
|
|
1137
1285
|
*
|
|
@@ -1153,20 +1301,20 @@ declare class Z {
|
|
|
1153
1301
|
constructor(t: any, e: any, n: any, r: any, s: any, i: any);
|
|
1154
1302
|
settings: any;
|
|
1155
1303
|
databaseId: any;
|
|
1156
|
-
|
|
1304
|
+
C: any;
|
|
1157
1305
|
ignoreUndefinedProperties: any;
|
|
1158
1306
|
fieldTransforms: any;
|
|
1159
1307
|
fieldMask: any;
|
|
1160
1308
|
get path(): any;
|
|
1161
|
-
get
|
|
1162
|
-
/** Returns a new context with the specified settings overwritten. */
|
|
1163
|
-
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
|
|
1309
|
+
get nt(): any;
|
|
1310
|
+
/** Returns a new context with the specified settings overwritten. */ rt(t: any): Qn;
|
|
1311
|
+
st(t: any): Qn;
|
|
1312
|
+
ut(t: any): Qn;
|
|
1313
|
+
ct(t: any): Qn;
|
|
1314
|
+
at(t: any): U;
|
|
1167
1315
|
/** Returns 'true' if 'fieldPath' was traversed when creating this context. */ contains(t: any): boolean;
|
|
1168
|
-
|
|
1169
|
-
|
|
1316
|
+
et(): void;
|
|
1317
|
+
ot(t: any): void;
|
|
1170
1318
|
}
|
|
1171
1319
|
/**
|
|
1172
1320
|
* @license
|
|
@@ -1184,9 +1332,9 @@ declare class Z {
|
|
|
1184
1332
|
* See the License for the specific language governing permissions and
|
|
1185
1333
|
* limitations under the License.
|
|
1186
1334
|
*/
|
|
1187
|
-
/** A field path and the TransformOperation to perform upon it. */ declare class
|
|
1335
|
+
/** A field path and the TransformOperation to perform upon it. */ declare class De {
|
|
1188
1336
|
constructor(t: any, e: any);
|
|
1189
1337
|
field: any;
|
|
1190
1338
|
transform: any;
|
|
1191
1339
|
}
|
|
1192
|
-
export {
|
|
1340
|
+
export { Tn as AggregateField, An as AggregateQuerySnapshot, qn as Bytes, $n as CollectionReference, Pn as DocumentReference, fr as DocumentSnapshot, On as FieldPath, Cn as FieldValue, _n as Firestore, U as FirestoreError, Ln as GeoPoint, Vn as Query, Er as QueryCompositeFilterConstraint, gr as QueryConstraint, dr as QueryDocumentSnapshot, xr as QueryEndAtConstraint, vr as QueryFieldFilterConstraint, Pr as QueryLimitConstraint, Ar as QueryOrderByConstraint, wr as QuerySnapshot, Nr as QueryStartAtConstraint, Vt as Timestamp, fs as Transaction, rs as WriteBatch, Yr as addDoc, Jr as aggregateQuerySnapshotEqual, Tr as and, es as arrayRemove, ts as arrayUnion, Nn as collection, Dn as collectionGroup, En as connectFirestoreEmulator, Kr as deleteDoc, Xr as deleteField, Fn as doc, kn as documentId, qr as endAt, Sr as endBefore, Hr as getCount, Qr as getDoc, zr as getDocs, bn as getFirestore, ns as increment, vn as initializeFirestore, Vr as limit, $r as limitToLast, Ir as or, Rr as orderBy, _r as query, Sn as queryEqual, xn as refEqual, ds as runTransaction, Zr as serverTimestamp, Wr as setDoc, p as setLogLevel, mr as snapshotEqual, Fr as startAfter, Dr as startAt, In as terminate, Gr as updateDoc, br as where, is as writeBatch };
|