@firebase/firestore 3.0.2-canary.3846fb049 → 3.0.2-canary.4e7aba48a
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/dist/firestore/compat/api/database.d.ts +0 -9
- package/dist/firestore/compat/index.console.d.ts +10 -1
- package/dist/firestore/lite/index.d.ts +1 -1
- package/dist/firestore/src/api.d.ts +1 -1
- package/dist/firestore/src/lite-api/reference.d.ts +1 -1
- package/dist/firestore/src/lite-api/types.d.ts +12 -1
- package/dist/index.d.ts +13 -2
- package/dist/index.esm2017.js +2583 -2583
- package/dist/index.esm2017.js.map +1 -1
- package/dist/index.esm5.js +2516 -2516
- package/dist/index.esm5.js.map +1 -1
- package/dist/index.node.cjs.esm2017.js +4 -4
- package/dist/index.node.cjs.esm2017.js.map +1 -1
- package/dist/index.node.cjs.js +3 -3
- package/dist/index.node.cjs.js.map +1 -1
- package/dist/index.rn.js +2799 -2799
- package/dist/index.rn.js.map +1 -1
- package/dist/internal.d.ts +14 -2
- package/dist/lite/firestore/compat/api/database.d.ts +0 -9
- package/dist/lite/firestore/compat/index.console.d.ts +10 -1
- package/dist/lite/firestore/lite/index.d.ts +1 -1
- package/dist/lite/firestore/src/api.d.ts +1 -1
- package/dist/lite/firestore/src/lite-api/reference.d.ts +1 -1
- package/dist/lite/firestore/src/lite-api/types.d.ts +12 -1
- package/dist/lite/index.browser.esm2017.js +2 -2
- package/dist/lite/index.browser.esm2017.js.map +1 -1
- package/dist/lite/index.browser.esm5.js +2 -2
- package/dist/lite/index.browser.esm5.js.map +1 -1
- package/dist/lite/index.d.ts +13 -2
- package/dist/lite/index.node.cjs.js +2 -2
- package/dist/lite/index.node.cjs.js.map +1 -1
- package/dist/lite/index.node.esm2017.js +2 -2
- package/dist/lite/index.node.esm2017.js.map +1 -1
- package/dist/lite/index.rn.esm2017.js +2 -2
- package/dist/lite/index.rn.esm2017.js.map +1 -1
- package/dist/lite/internal.d.ts +14 -2
- package/dist/lite/packages/firestore/compat/api/database.d.ts +0 -9
- package/dist/lite/packages/firestore/compat/index.console.d.ts +10 -1
- package/dist/lite/packages/firestore/lite/index.d.ts +1 -1
- package/dist/lite/packages/firestore/src/api.d.ts +1 -1
- package/dist/lite/packages/firestore/src/lite-api/reference.d.ts +1 -1
- package/dist/lite/packages/firestore/src/lite-api/types.d.ts +12 -1
- package/dist/lite/private.d.ts +14 -2
- package/dist/packages/firestore/compat/api/database.d.ts +0 -9
- package/dist/packages/firestore/compat/index.console.d.ts +10 -1
- package/dist/packages/firestore/dist/index.esm2017.d.ts +156 -156
- package/dist/packages/firestore/lite/index.d.ts +1 -1
- package/dist/packages/firestore/src/api.d.ts +1 -1
- package/dist/packages/firestore/src/lite-api/reference.d.ts +1 -1
- package/dist/packages/firestore/src/lite-api/types.d.ts +12 -1
- package/dist/private.d.ts +14 -2
- package/package.json +9 -9
package/dist/lite/internal.d.ts
CHANGED
|
@@ -281,6 +281,18 @@ declare class ByteString {
|
|
|
281
281
|
isEqual(other: ByteString): boolean;
|
|
282
282
|
}
|
|
283
283
|
|
|
284
|
+
/**
|
|
285
|
+
* Helper for calculating the nested fields for a given type T1. This is needed
|
|
286
|
+
* to distribute union types such as `undefined | {...}` (happens for optional
|
|
287
|
+
* props) or `{a: A} | {b: B}`.
|
|
288
|
+
*
|
|
289
|
+
* In this use case, `V` is used to distribute the union types of `T[K]` on
|
|
290
|
+
* `Record`, since `T[K]` is evaluated as an expression and not distributed.
|
|
291
|
+
*
|
|
292
|
+
* See https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types
|
|
293
|
+
*/
|
|
294
|
+
export declare type ChildUpdateFields<K extends string, V> = V extends Record<string, unknown> ? AddPrefixToKeys<K, UpdateData<V>> : never;
|
|
295
|
+
|
|
284
296
|
/**
|
|
285
297
|
* Gets a `CollectionReference` instance that refers to the collection at
|
|
286
298
|
* the specified absolute path.
|
|
@@ -1672,7 +1684,7 @@ declare const enum MutationType {
|
|
|
1672
1684
|
* all possible keys that are all marked as optional
|
|
1673
1685
|
*/
|
|
1674
1686
|
export declare type NestedUpdateFields<T extends Record<string, unknown>> = UnionToIntersection<{
|
|
1675
|
-
[K in keyof T & string]:
|
|
1687
|
+
[K in keyof T & string]: ChildUpdateFields<K, T[K]>;
|
|
1676
1688
|
}[keyof T & string]>;
|
|
1677
1689
|
|
|
1678
1690
|
/**
|
|
@@ -2560,7 +2572,7 @@ declare interface UntypedFirestoreDataConverter<T> {
|
|
|
2560
2572
|
* reference nested fields within the document. FieldValues can be passed in
|
|
2561
2573
|
* as property values.
|
|
2562
2574
|
*/
|
|
2563
|
-
export declare type UpdateData<T> = T extends Primitive ? T : T extends
|
|
2575
|
+
export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
|
|
2564
2576
|
[K in keyof T]?: UpdateData<T[K]> | FieldValue;
|
|
2565
2577
|
} & NestedUpdateFields<T> : Partial<T>;
|
|
2566
2578
|
|
|
@@ -30,15 +30,6 @@ export interface PersistenceProvider {
|
|
|
30
30
|
enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;
|
|
31
31
|
clearIndexedDbPersistence(firestore: Firestore): Promise<void>;
|
|
32
32
|
}
|
|
33
|
-
/**
|
|
34
|
-
* The persistence provider included with the memory-only SDK. This provider
|
|
35
|
-
* errors for all attempts to access persistence.
|
|
36
|
-
*/
|
|
37
|
-
export declare class MemoryPersistenceProvider implements PersistenceProvider {
|
|
38
|
-
enableIndexedDbPersistence(firestore: Firestore, forceOwnership: boolean): Promise<void>;
|
|
39
|
-
enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;
|
|
40
|
-
clearIndexedDbPersistence(firestore: Firestore): Promise<void>;
|
|
41
|
-
}
|
|
42
33
|
/**
|
|
43
34
|
* The persistence provider included with the full Firestore SDK.
|
|
44
35
|
*/
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*/
|
|
17
17
|
import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
|
|
18
18
|
import { Provider } from '@firebase/component';
|
|
19
|
-
import { Firestore as FirestoreCompat } from './api/database';
|
|
19
|
+
import { Firestore as FirestoreCompat, PersistenceProvider } from './api/database';
|
|
20
20
|
export { CollectionReference, DocumentReference, DocumentSnapshot, QuerySnapshot } from './api/database';
|
|
21
21
|
export { Blob } from './api/blob';
|
|
22
22
|
export { GeoPoint } from './api/geo_point';
|
|
@@ -27,6 +27,15 @@ export interface FirestoreDatabase {
|
|
|
27
27
|
projectId: string;
|
|
28
28
|
database?: string;
|
|
29
29
|
}
|
|
30
|
+
/**
|
|
31
|
+
* The persistence provider included with the memory-only SDK. This provider
|
|
32
|
+
* errors for all attempts to access persistence.
|
|
33
|
+
*/
|
|
34
|
+
export declare class MemoryPersistenceProvider implements PersistenceProvider {
|
|
35
|
+
enableIndexedDbPersistence(firestore: FirestoreCompat, forceOwnership: boolean): Promise<void>;
|
|
36
|
+
enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;
|
|
37
|
+
clearIndexedDbPersistence(firestore: Firestore): Promise<void>;
|
|
38
|
+
}
|
|
30
39
|
/** Firestore class that exposes the constructor expected by the Console. */
|
|
31
40
|
export declare class Firestore extends FirestoreCompat {
|
|
32
41
|
constructor(firestoreDatabase: FirestoreDatabase, authProvider: Provider<FirebaseAuthInternalName>);
|
|
@@ -11,7 +11,7 @@ export { Firestore as Firestore, EmulatorMockTokenOptions, initializeFirestore,
|
|
|
11
11
|
export { DocumentData, UpdateData, WithFieldValue, PartialWithFieldValue, SetOptions, DocumentReference, Query, CollectionReference, collection, collectionGroup, doc, refEqual, queryEqual } from '../src/lite-api/reference';
|
|
12
12
|
export { endAt, endBefore, startAt, startAfter, limit, limitToLast, orderBy, OrderByDirection, where, WhereFilterOp, query, QueryConstraint, QueryConstraintType } from '../src/lite-api/query';
|
|
13
13
|
export { addDoc, deleteDoc, updateDoc, setDoc, getDoc, getDocs } from '../src/lite-api/reference_impl';
|
|
14
|
-
export { Primitive, NestedUpdateFields, AddPrefixToKeys, UnionToIntersection } from '../src/lite-api/types';
|
|
14
|
+
export { Primitive, NestedUpdateFields, ChildUpdateFields, AddPrefixToKeys, UnionToIntersection } from '../src/lite-api/types';
|
|
15
15
|
export { FieldPath, documentId } from '../src/lite-api/field_path';
|
|
16
16
|
export { FieldValue } from '../src/lite-api/field_value';
|
|
17
17
|
export { increment, arrayRemove, arrayUnion, serverTimestamp, deleteField } from '../src/lite-api/field_value_impl';
|
|
@@ -34,7 +34,7 @@ export { Timestamp } from './api/timestamp';
|
|
|
34
34
|
export { CACHE_SIZE_UNLIMITED } from './api/database';
|
|
35
35
|
export { FirestoreErrorCode, FirestoreError } from './util/error';
|
|
36
36
|
export { AbstractUserDataWriter } from './lite-api/user_data_writer';
|
|
37
|
-
export { Primitive, NestedUpdateFields, AddPrefixToKeys, UnionToIntersection } from '../src/lite-api/types';
|
|
37
|
+
export { Primitive, NestedUpdateFields, ChildUpdateFields, AddPrefixToKeys, UnionToIntersection } from '../src/lite-api/types';
|
|
38
38
|
/**
|
|
39
39
|
* Internal exports
|
|
40
40
|
*/
|
|
@@ -50,7 +50,7 @@ export declare type WithFieldValue<T> = T extends Primitive ? T : T extends {} ?
|
|
|
50
50
|
* reference nested fields within the document. FieldValues can be passed in
|
|
51
51
|
* as property values.
|
|
52
52
|
*/
|
|
53
|
-
export declare type UpdateData<T> = T extends Primitive ? T : T extends
|
|
53
|
+
export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
|
|
54
54
|
[K in keyof T]?: UpdateData<T[K]> | FieldValue;
|
|
55
55
|
} & NestedUpdateFields<T> : Partial<T>;
|
|
56
56
|
/**
|
|
@@ -28,8 +28,19 @@ export declare type Primitive = string | number | boolean | undefined | null;
|
|
|
28
28
|
* all possible keys that are all marked as optional
|
|
29
29
|
*/
|
|
30
30
|
export declare type NestedUpdateFields<T extends Record<string, unknown>> = UnionToIntersection<{
|
|
31
|
-
[K in keyof T & string]:
|
|
31
|
+
[K in keyof T & string]: ChildUpdateFields<K, T[K]>;
|
|
32
32
|
}[keyof T & string]>;
|
|
33
|
+
/**
|
|
34
|
+
* Helper for calculating the nested fields for a given type T1. This is needed
|
|
35
|
+
* to distribute union types such as `undefined | {...}` (happens for optional
|
|
36
|
+
* props) or `{a: A} | {b: B}`.
|
|
37
|
+
*
|
|
38
|
+
* In this use case, `V` is used to distribute the union types of `T[K]` on
|
|
39
|
+
* `Record`, since `T[K]` is evaluated as an expression and not distributed.
|
|
40
|
+
*
|
|
41
|
+
* See https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types
|
|
42
|
+
*/
|
|
43
|
+
export declare type ChildUpdateFields<K extends string, V> = V extends Record<string, unknown> ? AddPrefixToKeys<K, UpdateData<V>> : never;
|
|
33
44
|
/**
|
|
34
45
|
* Returns a new map where every key is prefixed with the outer key appended
|
|
35
46
|
* to a dot.
|
package/dist/lite/private.d.ts
CHANGED
|
@@ -228,6 +228,18 @@ export declare class Bytes {
|
|
|
228
228
|
|
|
229
229
|
/* Excluded from this release type: ByteString */
|
|
230
230
|
|
|
231
|
+
/**
|
|
232
|
+
* Helper for calculating the nested fields for a given type T1. This is needed
|
|
233
|
+
* to distribute union types such as `undefined | {...}` (happens for optional
|
|
234
|
+
* props) or `{a: A} | {b: B}`.
|
|
235
|
+
*
|
|
236
|
+
* In this use case, `V` is used to distribute the union types of `T[K]` on
|
|
237
|
+
* `Record`, since `T[K]` is evaluated as an expression and not distributed.
|
|
238
|
+
*
|
|
239
|
+
* See https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types
|
|
240
|
+
*/
|
|
241
|
+
export declare type ChildUpdateFields<K extends string, V> = V extends Record<string, unknown> ? AddPrefixToKeys<K, UpdateData<V>> : never;
|
|
242
|
+
|
|
231
243
|
/**
|
|
232
244
|
* Gets a `CollectionReference` instance that refers to the collection at
|
|
233
245
|
* the specified absolute path.
|
|
@@ -1557,7 +1569,7 @@ declare const enum MutationType {
|
|
|
1557
1569
|
* all possible keys that are all marked as optional
|
|
1558
1570
|
*/
|
|
1559
1571
|
export declare type NestedUpdateFields<T extends Record<string, unknown>> = UnionToIntersection<{
|
|
1560
|
-
[K in keyof T & string]:
|
|
1572
|
+
[K in keyof T & string]: ChildUpdateFields<K, T[K]>;
|
|
1561
1573
|
}[keyof T & string]>;
|
|
1562
1574
|
|
|
1563
1575
|
/**
|
|
@@ -2428,7 +2440,7 @@ declare interface UntypedFirestoreDataConverter<T> {
|
|
|
2428
2440
|
* reference nested fields within the document. FieldValues can be passed in
|
|
2429
2441
|
* as property values.
|
|
2430
2442
|
*/
|
|
2431
|
-
export declare type UpdateData<T> = T extends Primitive ? T : T extends
|
|
2443
|
+
export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
|
|
2432
2444
|
[K in keyof T]?: UpdateData<T[K]> | FieldValue;
|
|
2433
2445
|
} & NestedUpdateFields<T> : Partial<T>;
|
|
2434
2446
|
|
|
@@ -30,15 +30,6 @@ export interface PersistenceProvider {
|
|
|
30
30
|
enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;
|
|
31
31
|
clearIndexedDbPersistence(firestore: Firestore): Promise<void>;
|
|
32
32
|
}
|
|
33
|
-
/**
|
|
34
|
-
* The persistence provider included with the memory-only SDK. This provider
|
|
35
|
-
* errors for all attempts to access persistence.
|
|
36
|
-
*/
|
|
37
|
-
export declare class MemoryPersistenceProvider implements PersistenceProvider {
|
|
38
|
-
enableIndexedDbPersistence(firestore: Firestore, forceOwnership: boolean): Promise<void>;
|
|
39
|
-
enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;
|
|
40
|
-
clearIndexedDbPersistence(firestore: Firestore): Promise<void>;
|
|
41
|
-
}
|
|
42
33
|
/**
|
|
43
34
|
* The persistence provider included with the full Firestore SDK.
|
|
44
35
|
*/
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*/
|
|
17
17
|
import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
|
|
18
18
|
import { Provider } from '@firebase/component';
|
|
19
|
-
import { Firestore as FirestoreCompat } from './api/database';
|
|
19
|
+
import { Firestore as FirestoreCompat, PersistenceProvider } from './api/database';
|
|
20
20
|
export { CollectionReference, DocumentReference, DocumentSnapshot, QuerySnapshot } from './api/database';
|
|
21
21
|
export { Blob } from './api/blob';
|
|
22
22
|
export { GeoPoint } from './api/geo_point';
|
|
@@ -27,6 +27,15 @@ export interface FirestoreDatabase {
|
|
|
27
27
|
projectId: string;
|
|
28
28
|
database?: string;
|
|
29
29
|
}
|
|
30
|
+
/**
|
|
31
|
+
* The persistence provider included with the memory-only SDK. This provider
|
|
32
|
+
* errors for all attempts to access persistence.
|
|
33
|
+
*/
|
|
34
|
+
export declare class MemoryPersistenceProvider implements PersistenceProvider {
|
|
35
|
+
enableIndexedDbPersistence(firestore: FirestoreCompat, forceOwnership: boolean): Promise<void>;
|
|
36
|
+
enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;
|
|
37
|
+
clearIndexedDbPersistence(firestore: Firestore): Promise<void>;
|
|
38
|
+
}
|
|
30
39
|
/** Firestore class that exposes the constructor expected by the Console. */
|
|
31
40
|
export declare class Firestore extends FirestoreCompat {
|
|
32
41
|
constructor(firestoreDatabase: FirestoreDatabase, authProvider: Provider<FirebaseAuthInternalName>);
|