@firebase/firestore 3.4.2 → 3.4.3-202202014332
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 +8 -0
- package/dist/firestore/src/api/snapshot.d.ts +6 -6
- package/dist/firestore/src/lite-api/snapshot.d.ts +2 -2
- package/dist/firestore/test/integration/bootstrap.d.ts +0 -1
- package/dist/firestore/test/integration/util/events_accumulator.d.ts +2 -2
- package/dist/firestore/test/integration/util/firebase_export.d.ts +6 -14
- package/dist/firestore/test/integration/util/helpers.d.ts +18 -18
- package/dist/firestore/test/integration/util/internal_helpers.d.ts +3 -3
- package/dist/firestore/test/integration/util/settings.d.ts +2 -2
- package/dist/firestore/test/unit/api/{blob.test.d.ts → bytes.test.d.ts} +0 -0
- package/dist/firestore/test/util/api_helpers.d.ts +1 -1
- package/dist/firestore/test/util/helpers.d.ts +4 -6
- package/dist/index.d.ts +6 -6
- package/dist/index.esm2017.js +869 -869
- package/dist/index.esm2017.js.map +1 -1
- package/dist/index.esm5.js +1257 -1257
- package/dist/index.esm5.js.map +1 -1
- package/dist/index.node.cjs.js +2674 -24
- package/dist/index.node.cjs.js.map +1 -1
- package/dist/index.node.mjs +2675 -25
- package/dist/index.node.mjs.map +1 -1
- package/dist/index.rn.js +1068 -1068
- package/dist/index.rn.js.map +1 -1
- package/dist/internal.d.ts +8 -8
- package/dist/lite/firestore/src/api/snapshot.d.ts +6 -6
- package/dist/lite/firestore/src/lite-api/snapshot.d.ts +2 -2
- package/dist/lite/firestore/test/integration/bootstrap.d.ts +0 -1
- package/dist/lite/firestore/test/integration/util/events_accumulator.d.ts +2 -2
- package/dist/lite/firestore/test/integration/util/firebase_export.d.ts +6 -14
- package/dist/lite/firestore/test/integration/util/helpers.d.ts +18 -18
- package/dist/lite/firestore/test/integration/util/internal_helpers.d.ts +3 -3
- package/dist/lite/firestore/test/integration/util/settings.d.ts +2 -2
- package/dist/lite/firestore/test/unit/api/{blob.test.d.ts → bytes.test.d.ts} +0 -0
- package/dist/lite/firestore/test/util/api_helpers.d.ts +1 -1
- package/dist/lite/firestore/test/util/helpers.d.ts +4 -6
- package/dist/lite/index.browser.esm2017.js +1136 -1136
- package/dist/lite/index.browser.esm2017.js.map +1 -1
- package/dist/lite/index.browser.esm5.js +105 -105
- package/dist/lite/index.browser.esm5.js.map +1 -1
- package/dist/lite/index.d.ts +2 -2
- package/dist/lite/index.node.cjs.js +11 -12
- package/dist/lite/index.node.cjs.js.map +1 -1
- package/dist/lite/index.node.mjs +11 -12
- package/dist/lite/index.node.mjs.map +1 -1
- package/dist/lite/index.rn.esm2017.js +148 -148
- package/dist/lite/index.rn.esm2017.js.map +1 -1
- package/dist/lite/internal.d.ts +2 -2
- package/dist/lite/packages/firestore/dist/lite/index.browser.esm2017.d.ts +107 -107
- package/dist/lite/packages/firestore/src/api/snapshot.d.ts +6 -6
- package/dist/lite/packages/firestore/src/lite-api/snapshot.d.ts +2 -2
- package/dist/lite/packages/firestore/test/integration/bootstrap.d.ts +0 -1
- package/dist/lite/packages/firestore/test/integration/util/events_accumulator.d.ts +2 -2
- package/dist/lite/packages/firestore/test/integration/util/firebase_export.d.ts +6 -14
- package/dist/lite/packages/firestore/test/integration/util/helpers.d.ts +18 -18
- package/dist/lite/packages/firestore/test/integration/util/internal_helpers.d.ts +3 -3
- package/dist/lite/packages/firestore/test/integration/util/settings.d.ts +2 -2
- package/dist/lite/packages/firestore/test/unit/api/{blob.test.d.ts → bytes.test.d.ts} +0 -0
- package/dist/lite/packages/firestore/test/util/api_helpers.d.ts +1 -1
- package/dist/lite/packages/firestore/test/util/helpers.d.ts +4 -6
- package/dist/lite/private.d.ts +2 -2
- package/dist/packages/firestore/dist/index.esm2017.d.ts +105 -105
- package/dist/packages/firestore/src/api/snapshot.d.ts +6 -6
- package/dist/packages/firestore/src/lite-api/snapshot.d.ts +2 -2
- package/dist/packages/firestore/test/integration/bootstrap.d.ts +0 -1
- package/dist/packages/firestore/test/integration/util/events_accumulator.d.ts +2 -2
- package/dist/packages/firestore/test/integration/util/firebase_export.d.ts +6 -14
- package/dist/packages/firestore/test/integration/util/helpers.d.ts +18 -18
- package/dist/packages/firestore/test/integration/util/internal_helpers.d.ts +3 -3
- package/dist/packages/firestore/test/integration/util/settings.d.ts +2 -2
- package/dist/packages/firestore/test/unit/api/{blob.test.d.ts → bytes.test.d.ts} +0 -0
- package/dist/packages/firestore/test/util/api_helpers.d.ts +1 -1
- package/dist/packages/firestore/test/util/helpers.d.ts +4 -6
- package/dist/private.d.ts +8 -8
- package/package.json +5 -8
- package/dist/firestore/compat/api/blob.d.ts +0 -29
- package/dist/firestore/compat/api/database.d.ts +0 -228
- package/dist/firestore/compat/api/field_path.d.ts +0 -36
- package/dist/firestore/compat/api/field_value.d.ts +0 -29
- package/dist/firestore/compat/api/geo_point.d.ts +0 -17
- package/dist/firestore/compat/api/observer.d.ts +0 -29
- package/dist/firestore/compat/api/timestamp.d.ts +0 -17
- package/dist/firestore/compat/config.d.ts +0 -28
- package/dist/firestore/compat/index.console.d.ts +0 -42
- package/dist/firestore/compat/index.d.ts +0 -49
- package/dist/firestore/compat/index.node.d.ts +0 -22
- package/dist/firestore/compat/index.rn.d.ts +0 -22
- package/dist/firestore/compat/register-module.d.ts +0 -42
- package/dist/firestore/compat/util/input_validation.d.ts +0 -18
- package/dist/lite/firestore/compat/api/blob.d.ts +0 -29
- package/dist/lite/firestore/compat/api/database.d.ts +0 -228
- package/dist/lite/firestore/compat/api/field_path.d.ts +0 -36
- package/dist/lite/firestore/compat/api/field_value.d.ts +0 -29
- package/dist/lite/firestore/compat/api/geo_point.d.ts +0 -17
- package/dist/lite/firestore/compat/api/observer.d.ts +0 -29
- package/dist/lite/firestore/compat/api/timestamp.d.ts +0 -17
- package/dist/lite/firestore/compat/config.d.ts +0 -28
- package/dist/lite/firestore/compat/index.console.d.ts +0 -42
- package/dist/lite/firestore/compat/index.d.ts +0 -49
- package/dist/lite/firestore/compat/index.node.d.ts +0 -22
- package/dist/lite/firestore/compat/index.rn.d.ts +0 -22
- package/dist/lite/firestore/compat/register-module.d.ts +0 -42
- package/dist/lite/firestore/compat/util/input_validation.d.ts +0 -18
- package/dist/lite/packages/firestore/compat/api/blob.d.ts +0 -29
- package/dist/lite/packages/firestore/compat/api/database.d.ts +0 -228
- package/dist/lite/packages/firestore/compat/api/field_path.d.ts +0 -36
- package/dist/lite/packages/firestore/compat/api/field_value.d.ts +0 -29
- package/dist/lite/packages/firestore/compat/api/geo_point.d.ts +0 -17
- package/dist/lite/packages/firestore/compat/api/observer.d.ts +0 -29
- package/dist/lite/packages/firestore/compat/api/timestamp.d.ts +0 -17
- package/dist/lite/packages/firestore/compat/config.d.ts +0 -28
- package/dist/lite/packages/firestore/compat/index.console.d.ts +0 -42
- package/dist/lite/packages/firestore/compat/index.d.ts +0 -49
- package/dist/lite/packages/firestore/compat/index.node.d.ts +0 -22
- package/dist/lite/packages/firestore/compat/index.rn.d.ts +0 -22
- package/dist/lite/packages/firestore/compat/register-module.d.ts +0 -42
- package/dist/lite/packages/firestore/compat/util/input_validation.d.ts +0 -18
- package/dist/lite/src/protos/README.md +0 -2
- package/dist/lite/src/protos/firestore/bundle.proto +0 -121
- package/dist/lite/src/protos/firestore_bundle_proto.ts +0 -93
- package/dist/lite/src/protos/firestore_proto_api.ts +0 -1259
- package/dist/lite/src/protos/google/api/annotations.proto +0 -31
- package/dist/lite/src/protos/google/api/http.proto +0 -370
- package/dist/lite/src/protos/google/firestore/v1/common.proto +0 -84
- package/dist/lite/src/protos/google/firestore/v1/document.proto +0 -151
- package/dist/lite/src/protos/google/firestore/v1/firestore.proto +0 -761
- package/dist/lite/src/protos/google/firestore/v1/query.proto +0 -302
- package/dist/lite/src/protos/google/firestore/v1/write.proto +0 -264
- package/dist/lite/src/protos/google/protobuf/any.proto +0 -155
- package/dist/lite/src/protos/google/protobuf/descriptor.proto +0 -882
- package/dist/lite/src/protos/google/protobuf/empty.proto +0 -52
- package/dist/lite/src/protos/google/protobuf/struct.proto +0 -96
- package/dist/lite/src/protos/google/protobuf/timestamp.proto +0 -137
- package/dist/lite/src/protos/google/protobuf/wrappers.proto +0 -123
- package/dist/lite/src/protos/google/rpc/status.proto +0 -92
- package/dist/lite/src/protos/google/type/latlng.proto +0 -71
- package/dist/lite/src/protos/update.sh +0 -61
- package/dist/packages/firestore/compat/api/blob.d.ts +0 -29
- package/dist/packages/firestore/compat/api/database.d.ts +0 -228
- package/dist/packages/firestore/compat/api/field_path.d.ts +0 -36
- package/dist/packages/firestore/compat/api/field_value.d.ts +0 -29
- package/dist/packages/firestore/compat/api/geo_point.d.ts +0 -17
- package/dist/packages/firestore/compat/api/observer.d.ts +0 -29
- package/dist/packages/firestore/compat/api/timestamp.d.ts +0 -17
- package/dist/packages/firestore/compat/config.d.ts +0 -28
- package/dist/packages/firestore/compat/index.console.d.ts +0 -42
- package/dist/packages/firestore/compat/index.d.ts +0 -49
- package/dist/packages/firestore/compat/index.node.d.ts +0 -22
- package/dist/packages/firestore/compat/index.rn.d.ts +0 -22
- package/dist/packages/firestore/compat/register-module.d.ts +0 -42
- package/dist/packages/firestore/compat/util/input_validation.d.ts +0 -18
- package/dist/src/protos/README.md +0 -2
- package/dist/src/protos/firestore/bundle.proto +0 -121
- package/dist/src/protos/firestore_bundle_proto.ts +0 -93
- package/dist/src/protos/firestore_proto_api.ts +0 -1259
- package/dist/src/protos/google/api/annotations.proto +0 -31
- package/dist/src/protos/google/api/http.proto +0 -370
- package/dist/src/protos/google/firestore/v1/common.proto +0 -84
- package/dist/src/protos/google/firestore/v1/document.proto +0 -151
- package/dist/src/protos/google/firestore/v1/firestore.proto +0 -761
- package/dist/src/protos/google/firestore/v1/query.proto +0 -302
- package/dist/src/protos/google/firestore/v1/write.proto +0 -264
- package/dist/src/protos/google/protobuf/any.proto +0 -155
- package/dist/src/protos/google/protobuf/descriptor.proto +0 -882
- package/dist/src/protos/google/protobuf/empty.proto +0 -52
- package/dist/src/protos/google/protobuf/struct.proto +0 -96
- package/dist/src/protos/google/protobuf/timestamp.proto +0 -137
- package/dist/src/protos/google/protobuf/wrappers.proto +0 -123
- package/dist/src/protos/google/rpc/status.proto +0 -92
- package/dist/src/protos/google/type/latlng.proto +0 -71
- package/dist/src/protos/update.sh +0 -61
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# @firebase/firestore
|
|
2
2
|
|
|
3
|
+
## 3.4.3
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`044a8d7f9`](https://github.com/firebase/firebase-js-sdk/commit/044a8d7f95a0ba0d34123ff5fd7a4bcb1bd3d328) [#5830](https://github.com/firebase/firebase-js-sdk/pull/5830) (fixes [#5823](https://github.com/firebase/firebase-js-sdk/issues/5823)) - Fix Proto loading for Vercel/Next.js.
|
|
8
|
+
|
|
9
|
+
* [`ff2f7d4c8`](https://github.com/firebase/firebase-js-sdk/commit/ff2f7d4c85c0bda94b14d66237faa0e5da93bfa4) [#5883](https://github.com/firebase/firebase-js-sdk/pull/5883) - The Node SDK now uses JSON to load its internal Protobuf definition, which allows the Node SDK to work with bundlers such as Rollup and Webpack.
|
|
10
|
+
|
|
3
11
|
## 3.4.2
|
|
4
12
|
|
|
5
13
|
### Patch Changes
|
|
@@ -42,12 +42,12 @@ import { SnapshotListenOptions } from './reference_impl';
|
|
|
42
42
|
* }
|
|
43
43
|
*
|
|
44
44
|
* const postConverter = {
|
|
45
|
-
* toFirestore(post: WithFieldValue<Post>):
|
|
45
|
+
* toFirestore(post: WithFieldValue<Post>): DocumentData {
|
|
46
46
|
* return {title: post.title, author: post.author};
|
|
47
47
|
* },
|
|
48
48
|
* fromFirestore(
|
|
49
|
-
* snapshot:
|
|
50
|
-
* options:
|
|
49
|
+
* snapshot: QueryDocumentSnapshot,
|
|
50
|
+
* options: SnapshotOptions
|
|
51
51
|
* ): Post {
|
|
52
52
|
* const data = snapshot.data(options)!;
|
|
53
53
|
* return new Post(data.title, data.author);
|
|
@@ -206,7 +206,7 @@ export declare class DocumentSnapshot<T = DocumentData> extends LiteDocumentSnap
|
|
|
206
206
|
* Retrieves all fields in the document as an `Object`. Returns `undefined` if
|
|
207
207
|
* the document doesn't exist.
|
|
208
208
|
*
|
|
209
|
-
* By default, `
|
|
209
|
+
* By default, `serverTimestamp()` values that have not yet been
|
|
210
210
|
* set to their final value will be returned as `null`. You can override
|
|
211
211
|
* this by passing an options object.
|
|
212
212
|
*
|
|
@@ -221,7 +221,7 @@ export declare class DocumentSnapshot<T = DocumentData> extends LiteDocumentSnap
|
|
|
221
221
|
* Retrieves the field specified by `fieldPath`. Returns `undefined` if the
|
|
222
222
|
* document or field doesn't exist.
|
|
223
223
|
*
|
|
224
|
-
* By default, a `
|
|
224
|
+
* By default, a `serverTimestamp()` that has not yet been set to
|
|
225
225
|
* its final value will be returned as `null`. You can override this by
|
|
226
226
|
* passing an options object.
|
|
227
227
|
*
|
|
@@ -250,7 +250,7 @@ export declare class QueryDocumentSnapshot<T = DocumentData> extends DocumentSna
|
|
|
250
250
|
/**
|
|
251
251
|
* Retrieves all fields in the document as an `Object`.
|
|
252
252
|
*
|
|
253
|
-
* By default, `
|
|
253
|
+
* By default, `serverTimestamp()` values that have not yet been
|
|
254
254
|
* set to their final value will be returned as `null`. You can override
|
|
255
255
|
* this by passing an options object.
|
|
256
256
|
*
|
|
@@ -41,10 +41,10 @@ import { AbstractUserDataWriter } from './user_data_writer';
|
|
|
41
41
|
* }
|
|
42
42
|
*
|
|
43
43
|
* const postConverter = {
|
|
44
|
-
* toFirestore(post: WithFieldValue<Post>):
|
|
44
|
+
* toFirestore(post: WithFieldValue<Post>): DocumentData {
|
|
45
45
|
* return {title: post.title, author: post.author};
|
|
46
46
|
* },
|
|
47
|
-
* fromFirestore(snapshot:
|
|
47
|
+
* fromFirestore(snapshot: QueryDocumentSnapshot): Post {
|
|
48
48
|
* const data = snapshot.data(options)!;
|
|
49
49
|
* return new Post(data.title, data.author);
|
|
50
50
|
* }
|
|
@@ -14,12 +14,12 @@
|
|
|
14
14
|
* See the License for the specific language governing permissions and
|
|
15
15
|
* limitations under the License.
|
|
16
16
|
*/
|
|
17
|
-
import
|
|
17
|
+
import { DocumentSnapshot, QuerySnapshot } from './firebase_export';
|
|
18
18
|
/**
|
|
19
19
|
* A helper object that can accumulate an arbitrary amount of events and resolve
|
|
20
20
|
* a promise when expected number has been emitted.
|
|
21
21
|
*/
|
|
22
|
-
export declare class EventsAccumulator<T extends
|
|
22
|
+
export declare class EventsAccumulator<T extends DocumentSnapshot | QuerySnapshot> {
|
|
23
23
|
private events;
|
|
24
24
|
private waitingFor;
|
|
25
25
|
private deferred;
|
|
@@ -14,17 +14,9 @@
|
|
|
14
14
|
* See the License for the specific language governing permissions and
|
|
15
15
|
* limitations under the License.
|
|
16
16
|
*/
|
|
17
|
-
import { FirebaseApp } from '@firebase/app
|
|
18
|
-
import
|
|
19
|
-
import {
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
import { GeoPoint } from '../../../compat/api/geo_point';
|
|
24
|
-
import { Timestamp } from '../../../compat/api/timestamp';
|
|
25
|
-
/**
|
|
26
|
-
* Creates a new test instance of Firestore using either firebase.firestore()
|
|
27
|
-
* or `initializeFirestore` from the modular API.
|
|
28
|
-
*/
|
|
29
|
-
export declare function newTestFirestore(projectId: string, nameOrApp?: string | FirebaseApp, settings?: firestore.Settings): firestore.FirebaseFirestore;
|
|
30
|
-
export { Firestore, FieldValue, FieldPath, Timestamp, Blob, GeoPoint, DocumentReference, QueryDocumentSnapshot };
|
|
17
|
+
import { FirebaseApp } from '@firebase/app';
|
|
18
|
+
import { Firestore } from '../../../src';
|
|
19
|
+
import { PrivateSettings } from '../../../src/lite-api/settings';
|
|
20
|
+
export declare function newTestFirestore(projectId: string, nameOrApp?: string | FirebaseApp, settings?: PrivateSettings): Firestore;
|
|
21
|
+
export * from '../../../src';
|
|
22
|
+
export { PrivateSettings };
|
|
@@ -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
|
|
17
|
+
import { DocumentReference, Firestore, CollectionReference, DocumentData, QuerySnapshot, PrivateSettings, SnapshotListenOptions } from './firebase_export';
|
|
18
18
|
export declare function isPersistenceAvailable(): boolean;
|
|
19
19
|
declare type ApiSuiteFunction = (message: string, testSuite: (persistence: boolean) => void) => void;
|
|
20
20
|
interface ApiDescribe {
|
|
@@ -24,26 +24,26 @@ interface ApiDescribe {
|
|
|
24
24
|
}
|
|
25
25
|
export declare const apiDescribe: ApiDescribe;
|
|
26
26
|
/** Converts the documents in a QuerySnapshot to an array with the data of each document. */
|
|
27
|
-
export declare function toDataArray(docSet:
|
|
27
|
+
export declare function toDataArray(docSet: QuerySnapshot): DocumentData[];
|
|
28
28
|
/** Converts the changes in a QuerySnapshot to an array with the data of each document. */
|
|
29
|
-
export declare function toChangesArray(docSet:
|
|
30
|
-
export declare function toDataMap(docSet:
|
|
31
|
-
[field: string]:
|
|
29
|
+
export declare function toChangesArray(docSet: QuerySnapshot, options?: SnapshotListenOptions): DocumentData[];
|
|
30
|
+
export declare function toDataMap(docSet: QuerySnapshot): {
|
|
31
|
+
[field: string]: DocumentData;
|
|
32
32
|
};
|
|
33
33
|
/** Converts a DocumentSet to an array with the id of each document */
|
|
34
|
-
export declare function toIds(docSet:
|
|
35
|
-
export declare function withTestDb(persistence: boolean, fn: (db:
|
|
34
|
+
export declare function toIds(docSet: QuerySnapshot): string[];
|
|
35
|
+
export declare function withTestDb(persistence: boolean, fn: (db: Firestore) => Promise<void>): Promise<void>;
|
|
36
36
|
/** Runs provided fn with a db for an alternate project id. */
|
|
37
|
-
export declare function withAlternateTestDb(persistence: boolean, fn: (db:
|
|
38
|
-
export declare function withTestDbs(persistence: boolean, numDbs: number, fn: (db:
|
|
39
|
-
export declare function withTestDbsSettings(persistence: boolean, projectId: string, settings:
|
|
40
|
-
export declare function withTestDoc(persistence: boolean, fn: (doc:
|
|
41
|
-
export declare function withTestDocAndSettings(persistence: boolean, settings:
|
|
42
|
-
export declare function withTestDocAndInitialData(persistence: boolean, initialData:
|
|
37
|
+
export declare function withAlternateTestDb(persistence: boolean, fn: (db: Firestore) => Promise<void>): Promise<void>;
|
|
38
|
+
export declare function withTestDbs(persistence: boolean, numDbs: number, fn: (db: Firestore[]) => Promise<void>): Promise<void>;
|
|
39
|
+
export declare function withTestDbsSettings(persistence: boolean, projectId: string, settings: PrivateSettings, numDbs: number, fn: (db: Firestore[]) => Promise<void>): Promise<void>;
|
|
40
|
+
export declare function withTestDoc(persistence: boolean, fn: (doc: DocumentReference, db: Firestore) => Promise<void>): Promise<void>;
|
|
41
|
+
export declare function withTestDocAndSettings(persistence: boolean, settings: PrivateSettings, fn: (doc: DocumentReference) => Promise<void>): Promise<void>;
|
|
42
|
+
export declare function withTestDocAndInitialData(persistence: boolean, initialData: DocumentData | null, fn: (doc: DocumentReference, db: Firestore) => Promise<void>): Promise<void>;
|
|
43
43
|
export declare function withTestCollection(persistence: boolean, docs: {
|
|
44
|
-
[key: string]:
|
|
45
|
-
}, fn: (collection:
|
|
46
|
-
export declare function withTestCollectionSettings(persistence: boolean, settings:
|
|
47
|
-
[key: string]:
|
|
48
|
-
}, fn: (collection:
|
|
44
|
+
[key: string]: DocumentData;
|
|
45
|
+
}, fn: (collection: CollectionReference, db: Firestore) => Promise<void>): Promise<void>;
|
|
46
|
+
export declare function withTestCollectionSettings(persistence: boolean, settings: PrivateSettings, docs: {
|
|
47
|
+
[key: string]: DocumentData;
|
|
48
|
+
}, fn: (collection: CollectionReference, db: Firestore) => Promise<void>): Promise<void>;
|
|
49
49
|
export {};
|
|
@@ -14,14 +14,14 @@
|
|
|
14
14
|
* See the License for the specific language governing permissions and
|
|
15
15
|
* limitations under the License.
|
|
16
16
|
*/
|
|
17
|
-
import * as firestore from '@firebase/firestore-types';
|
|
18
17
|
import { CredentialChangeListener, CredentialsProvider, EmptyAuthCredentialsProvider } from '../../../src/api/credentials';
|
|
19
18
|
import { User } from '../../../src/auth/user';
|
|
20
19
|
import { DatabaseInfo } from '../../../src/core/database_info';
|
|
21
20
|
import { Datastore } from '../../../src/remote/datastore';
|
|
22
21
|
import { AsyncQueue } from '../../../src/util/async_queue';
|
|
23
22
|
import { AsyncQueueImpl } from '../../../src/util/async_queue_impl';
|
|
24
|
-
|
|
23
|
+
import { Firestore } from './firebase_export';
|
|
24
|
+
export declare function asyncQueue(db: Firestore): AsyncQueueImpl;
|
|
25
25
|
export declare function getDefaultDatabaseInfo(): DatabaseInfo;
|
|
26
26
|
export declare function withTestDatastore(fn: (datastore: Datastore) => Promise<void>, authCredentialsProvider?: CredentialsProvider<User>, appCheckTokenProvider?: CredentialsProvider<string>): Promise<void>;
|
|
27
27
|
export declare class MockAuthCredentialsProvider extends EmptyAuthCredentialsProvider {
|
|
@@ -30,4 +30,4 @@ export declare class MockAuthCredentialsProvider extends EmptyAuthCredentialsPro
|
|
|
30
30
|
triggerUserChange(newUser: User): void;
|
|
31
31
|
start(asyncQueue: AsyncQueue, listener: CredentialChangeListener<User>): void;
|
|
32
32
|
}
|
|
33
|
-
export declare function withMockCredentialProviderTestDb(persistence: boolean, fn: (db:
|
|
33
|
+
export declare function withMockCredentialProviderTestDb(persistence: boolean, fn: (db: Firestore, mockCredential: MockAuthCredentialsProvider) => Promise<void>): Promise<void>;
|
|
@@ -14,8 +14,8 @@
|
|
|
14
14
|
* See the License for the specific language governing permissions and
|
|
15
15
|
* limitations under the License.
|
|
16
16
|
*/
|
|
17
|
-
import
|
|
17
|
+
import { PrivateSettings } from './firebase_export';
|
|
18
18
|
export declare const USE_EMULATOR: boolean;
|
|
19
|
-
export declare const DEFAULT_SETTINGS:
|
|
19
|
+
export declare const DEFAULT_SETTINGS: PrivateSettings;
|
|
20
20
|
export declare const DEFAULT_PROJECT_ID: any;
|
|
21
21
|
export declare const ALT_PROJECT_ID = "test-db2";
|
|
File without changes
|
|
@@ -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 {
|
|
17
|
+
import { DocumentReference, Firestore, Query, CollectionReference, QuerySnapshot, DocumentSnapshot } from '../../src';
|
|
18
18
|
import { DocumentKeySet } from '../../src/model/collections';
|
|
19
19
|
import { JsonObject } from '../../src/model/object_value';
|
|
20
20
|
/**
|
|
@@ -14,9 +14,7 @@
|
|
|
14
14
|
* See the License for the specific language governing permissions and
|
|
15
15
|
* limitations under the License.
|
|
16
16
|
*/
|
|
17
|
-
import
|
|
18
|
-
import { Blob } from '../../compat/api/blob';
|
|
19
|
-
import { DocumentReference } from '../../compat/api/database';
|
|
17
|
+
import { Bytes, DocumentReference, OrderByDirection } from '../../src';
|
|
20
18
|
import { BundledDocuments } from '../../src/core/bundle';
|
|
21
19
|
import { DatabaseId } from '../../src/core/database_info';
|
|
22
20
|
import { Query } from '../../src/core/query';
|
|
@@ -61,17 +59,17 @@ export declare function keys(...documents: Array<Document | string>): DocumentKe
|
|
|
61
59
|
export declare function path(path: string, offset?: number): ResourcePath;
|
|
62
60
|
export declare function field(path: string): FieldPath;
|
|
63
61
|
export declare function mask(...paths: string[]): FieldMask;
|
|
64
|
-
export declare function blob(...bytes: number[]):
|
|
62
|
+
export declare function blob(...bytes: number[]): Bytes;
|
|
65
63
|
export declare function filter(path: string, op: string, value: unknown): FieldFilter;
|
|
66
64
|
export declare function setMutation(keyStr: string, json: JsonObject<unknown>): SetMutation;
|
|
67
65
|
export declare function patchMutation(keyStr: string, json: JsonObject<unknown>, precondition?: Precondition): PatchMutation;
|
|
68
66
|
export declare function deleteMutation(keyStr: string): DeleteMutation;
|
|
69
67
|
export declare function mutationResult(testVersion: TestSnapshotVersion): MutationResult;
|
|
70
|
-
export declare function bound(values: Array<[string, {},
|
|
68
|
+
export declare function bound(values: Array<[string, {}, OrderByDirection]>, before: boolean): Bound;
|
|
71
69
|
export declare function query(resourcePath: string, ...constraints: Array<OrderBy | Filter>): Query;
|
|
72
70
|
export declare function targetData(targetId: TargetId, queryPurpose: TargetPurpose, path: string): TargetData;
|
|
73
71
|
export declare function noChangeEvent(targetId: number, snapshotVersion: number, resumeToken?: ByteString): RemoteEvent;
|
|
74
|
-
export declare function existenceFilterEvent(targetId: number,
|
|
72
|
+
export declare function existenceFilterEvent(targetId: number, syncedKeys: DocumentKeySet, remoteCount: number, snapshotVersion: number): RemoteEvent;
|
|
75
73
|
export declare function docAddedRemoteEvent(docOrDocs: MutableDocument | MutableDocument[], updatedInTargets?: TargetId[], removedFromTargets?: TargetId[], activeTargets?: TargetId[]): RemoteEvent;
|
|
76
74
|
export declare function docUpdateRemoteEvent(doc: MutableDocument, updatedInTargets?: TargetId[], removedFromTargets?: TargetId[], limboTargets?: TargetId[]): RemoteEvent;
|
|
77
75
|
export declare class TestBundledDocuments {
|
package/dist/index.d.ts
CHANGED
|
@@ -421,7 +421,7 @@ export declare class DocumentSnapshot<T = DocumentData> {
|
|
|
421
421
|
* Retrieves all fields in the document as an `Object`. Returns `undefined` if
|
|
422
422
|
* the document doesn't exist.
|
|
423
423
|
*
|
|
424
|
-
* By default, `
|
|
424
|
+
* By default, `serverTimestamp()` values that have not yet been
|
|
425
425
|
* set to their final value will be returned as `null`. You can override
|
|
426
426
|
* this by passing an options object.
|
|
427
427
|
*
|
|
@@ -436,7 +436,7 @@ export declare class DocumentSnapshot<T = DocumentData> {
|
|
|
436
436
|
* Retrieves the field specified by `fieldPath`. Returns `undefined` if the
|
|
437
437
|
* document or field doesn't exist.
|
|
438
438
|
*
|
|
439
|
-
* By default, a `
|
|
439
|
+
* By default, a `serverTimestamp()` that has not yet been set to
|
|
440
440
|
* its final value will be returned as `null`. You can override this by
|
|
441
441
|
* passing an options object.
|
|
442
442
|
*
|
|
@@ -628,12 +628,12 @@ export declare class Firestore {
|
|
|
628
628
|
* }
|
|
629
629
|
*
|
|
630
630
|
* const postConverter = {
|
|
631
|
-
* toFirestore(post: WithFieldValue<Post>):
|
|
631
|
+
* toFirestore(post: WithFieldValue<Post>): DocumentData {
|
|
632
632
|
* return {title: post.title, author: post.author};
|
|
633
633
|
* },
|
|
634
634
|
* fromFirestore(
|
|
635
|
-
* snapshot:
|
|
636
|
-
* options:
|
|
635
|
+
* snapshot: QueryDocumentSnapshot,
|
|
636
|
+
* options: SnapshotOptions
|
|
637
637
|
* ): Post {
|
|
638
638
|
* const data = snapshot.data(options)!;
|
|
639
639
|
* return new Post(data.title, data.author);
|
|
@@ -1344,7 +1344,7 @@ export declare class QueryDocumentSnapshot<T = DocumentData> extends DocumentSna
|
|
|
1344
1344
|
/**
|
|
1345
1345
|
* Retrieves all fields in the document as an `Object`.
|
|
1346
1346
|
*
|
|
1347
|
-
* By default, `
|
|
1347
|
+
* By default, `serverTimestamp()` values that have not yet been
|
|
1348
1348
|
* set to their final value will be returned as `null`. You can override
|
|
1349
1349
|
* this by passing an options object.
|
|
1350
1350
|
*
|