@firebase/firestore 3.4.2 → 3.4.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/dist/firestore/src/api/snapshot.d.ts +6 -6
  3. package/dist/firestore/src/lite-api/snapshot.d.ts +2 -2
  4. package/dist/firestore/test/integration/bootstrap.d.ts +0 -1
  5. package/dist/firestore/test/integration/util/events_accumulator.d.ts +2 -2
  6. package/dist/firestore/test/integration/util/firebase_export.d.ts +6 -14
  7. package/dist/firestore/test/integration/util/helpers.d.ts +18 -18
  8. package/dist/firestore/test/integration/util/internal_helpers.d.ts +3 -3
  9. package/dist/firestore/test/integration/util/settings.d.ts +2 -2
  10. package/dist/firestore/test/unit/api/{blob.test.d.ts → bytes.test.d.ts} +0 -0
  11. package/dist/firestore/test/util/api_helpers.d.ts +1 -1
  12. package/dist/firestore/test/util/helpers.d.ts +4 -6
  13. package/dist/index.d.ts +6 -6
  14. package/dist/index.esm2017.js +869 -869
  15. package/dist/index.esm2017.js.map +1 -1
  16. package/dist/index.esm5.js +1257 -1257
  17. package/dist/index.esm5.js.map +1 -1
  18. package/dist/index.node.cjs.js +2674 -24
  19. package/dist/index.node.cjs.js.map +1 -1
  20. package/dist/index.node.mjs +2675 -25
  21. package/dist/index.node.mjs.map +1 -1
  22. package/dist/index.rn.js +1068 -1068
  23. package/dist/index.rn.js.map +1 -1
  24. package/dist/internal.d.ts +8 -8
  25. package/dist/lite/firestore/src/api/snapshot.d.ts +6 -6
  26. package/dist/lite/firestore/src/lite-api/snapshot.d.ts +2 -2
  27. package/dist/lite/firestore/test/integration/bootstrap.d.ts +0 -1
  28. package/dist/lite/firestore/test/integration/util/events_accumulator.d.ts +2 -2
  29. package/dist/lite/firestore/test/integration/util/firebase_export.d.ts +6 -14
  30. package/dist/lite/firestore/test/integration/util/helpers.d.ts +18 -18
  31. package/dist/lite/firestore/test/integration/util/internal_helpers.d.ts +3 -3
  32. package/dist/lite/firestore/test/integration/util/settings.d.ts +2 -2
  33. package/dist/lite/firestore/test/unit/api/{blob.test.d.ts → bytes.test.d.ts} +0 -0
  34. package/dist/lite/firestore/test/util/api_helpers.d.ts +1 -1
  35. package/dist/lite/firestore/test/util/helpers.d.ts +4 -6
  36. package/dist/lite/index.browser.esm2017.js +1136 -1136
  37. package/dist/lite/index.browser.esm2017.js.map +1 -1
  38. package/dist/lite/index.browser.esm5.js +105 -105
  39. package/dist/lite/index.browser.esm5.js.map +1 -1
  40. package/dist/lite/index.d.ts +2 -2
  41. package/dist/lite/index.node.cjs.js +11 -12
  42. package/dist/lite/index.node.cjs.js.map +1 -1
  43. package/dist/lite/index.node.mjs +11 -12
  44. package/dist/lite/index.node.mjs.map +1 -1
  45. package/dist/lite/index.rn.esm2017.js +148 -148
  46. package/dist/lite/index.rn.esm2017.js.map +1 -1
  47. package/dist/lite/internal.d.ts +2 -2
  48. package/dist/lite/packages/firestore/dist/lite/index.browser.esm2017.d.ts +107 -107
  49. package/dist/lite/packages/firestore/src/api/snapshot.d.ts +6 -6
  50. package/dist/lite/packages/firestore/src/lite-api/snapshot.d.ts +2 -2
  51. package/dist/lite/packages/firestore/test/integration/bootstrap.d.ts +0 -1
  52. package/dist/lite/packages/firestore/test/integration/util/events_accumulator.d.ts +2 -2
  53. package/dist/lite/packages/firestore/test/integration/util/firebase_export.d.ts +6 -14
  54. package/dist/lite/packages/firestore/test/integration/util/helpers.d.ts +18 -18
  55. package/dist/lite/packages/firestore/test/integration/util/internal_helpers.d.ts +3 -3
  56. package/dist/lite/packages/firestore/test/integration/util/settings.d.ts +2 -2
  57. package/dist/lite/packages/firestore/test/unit/api/{blob.test.d.ts → bytes.test.d.ts} +0 -0
  58. package/dist/lite/packages/firestore/test/util/api_helpers.d.ts +1 -1
  59. package/dist/lite/packages/firestore/test/util/helpers.d.ts +4 -6
  60. package/dist/lite/private.d.ts +2 -2
  61. package/dist/packages/firestore/dist/index.esm2017.d.ts +105 -105
  62. package/dist/packages/firestore/src/api/snapshot.d.ts +6 -6
  63. package/dist/packages/firestore/src/lite-api/snapshot.d.ts +2 -2
  64. package/dist/packages/firestore/test/integration/bootstrap.d.ts +0 -1
  65. package/dist/packages/firestore/test/integration/util/events_accumulator.d.ts +2 -2
  66. package/dist/packages/firestore/test/integration/util/firebase_export.d.ts +6 -14
  67. package/dist/packages/firestore/test/integration/util/helpers.d.ts +18 -18
  68. package/dist/packages/firestore/test/integration/util/internal_helpers.d.ts +3 -3
  69. package/dist/packages/firestore/test/integration/util/settings.d.ts +2 -2
  70. package/dist/packages/firestore/test/unit/api/{blob.test.d.ts → bytes.test.d.ts} +0 -0
  71. package/dist/packages/firestore/test/util/api_helpers.d.ts +1 -1
  72. package/dist/packages/firestore/test/util/helpers.d.ts +4 -6
  73. package/dist/private.d.ts +8 -8
  74. package/package.json +4 -7
  75. package/dist/firestore/compat/api/blob.d.ts +0 -29
  76. package/dist/firestore/compat/api/database.d.ts +0 -228
  77. package/dist/firestore/compat/api/field_path.d.ts +0 -36
  78. package/dist/firestore/compat/api/field_value.d.ts +0 -29
  79. package/dist/firestore/compat/api/geo_point.d.ts +0 -17
  80. package/dist/firestore/compat/api/observer.d.ts +0 -29
  81. package/dist/firestore/compat/api/timestamp.d.ts +0 -17
  82. package/dist/firestore/compat/config.d.ts +0 -28
  83. package/dist/firestore/compat/index.console.d.ts +0 -42
  84. package/dist/firestore/compat/index.d.ts +0 -49
  85. package/dist/firestore/compat/index.node.d.ts +0 -22
  86. package/dist/firestore/compat/index.rn.d.ts +0 -22
  87. package/dist/firestore/compat/register-module.d.ts +0 -42
  88. package/dist/firestore/compat/util/input_validation.d.ts +0 -18
  89. package/dist/lite/firestore/compat/api/blob.d.ts +0 -29
  90. package/dist/lite/firestore/compat/api/database.d.ts +0 -228
  91. package/dist/lite/firestore/compat/api/field_path.d.ts +0 -36
  92. package/dist/lite/firestore/compat/api/field_value.d.ts +0 -29
  93. package/dist/lite/firestore/compat/api/geo_point.d.ts +0 -17
  94. package/dist/lite/firestore/compat/api/observer.d.ts +0 -29
  95. package/dist/lite/firestore/compat/api/timestamp.d.ts +0 -17
  96. package/dist/lite/firestore/compat/config.d.ts +0 -28
  97. package/dist/lite/firestore/compat/index.console.d.ts +0 -42
  98. package/dist/lite/firestore/compat/index.d.ts +0 -49
  99. package/dist/lite/firestore/compat/index.node.d.ts +0 -22
  100. package/dist/lite/firestore/compat/index.rn.d.ts +0 -22
  101. package/dist/lite/firestore/compat/register-module.d.ts +0 -42
  102. package/dist/lite/firestore/compat/util/input_validation.d.ts +0 -18
  103. package/dist/lite/packages/firestore/compat/api/blob.d.ts +0 -29
  104. package/dist/lite/packages/firestore/compat/api/database.d.ts +0 -228
  105. package/dist/lite/packages/firestore/compat/api/field_path.d.ts +0 -36
  106. package/dist/lite/packages/firestore/compat/api/field_value.d.ts +0 -29
  107. package/dist/lite/packages/firestore/compat/api/geo_point.d.ts +0 -17
  108. package/dist/lite/packages/firestore/compat/api/observer.d.ts +0 -29
  109. package/dist/lite/packages/firestore/compat/api/timestamp.d.ts +0 -17
  110. package/dist/lite/packages/firestore/compat/config.d.ts +0 -28
  111. package/dist/lite/packages/firestore/compat/index.console.d.ts +0 -42
  112. package/dist/lite/packages/firestore/compat/index.d.ts +0 -49
  113. package/dist/lite/packages/firestore/compat/index.node.d.ts +0 -22
  114. package/dist/lite/packages/firestore/compat/index.rn.d.ts +0 -22
  115. package/dist/lite/packages/firestore/compat/register-module.d.ts +0 -42
  116. package/dist/lite/packages/firestore/compat/util/input_validation.d.ts +0 -18
  117. package/dist/lite/src/protos/README.md +0 -2
  118. package/dist/lite/src/protos/firestore/bundle.proto +0 -121
  119. package/dist/lite/src/protos/firestore_bundle_proto.ts +0 -93
  120. package/dist/lite/src/protos/firestore_proto_api.ts +0 -1259
  121. package/dist/lite/src/protos/google/api/annotations.proto +0 -31
  122. package/dist/lite/src/protos/google/api/http.proto +0 -370
  123. package/dist/lite/src/protos/google/firestore/v1/common.proto +0 -84
  124. package/dist/lite/src/protos/google/firestore/v1/document.proto +0 -151
  125. package/dist/lite/src/protos/google/firestore/v1/firestore.proto +0 -761
  126. package/dist/lite/src/protos/google/firestore/v1/query.proto +0 -302
  127. package/dist/lite/src/protos/google/firestore/v1/write.proto +0 -264
  128. package/dist/lite/src/protos/google/protobuf/any.proto +0 -155
  129. package/dist/lite/src/protos/google/protobuf/descriptor.proto +0 -882
  130. package/dist/lite/src/protos/google/protobuf/empty.proto +0 -52
  131. package/dist/lite/src/protos/google/protobuf/struct.proto +0 -96
  132. package/dist/lite/src/protos/google/protobuf/timestamp.proto +0 -137
  133. package/dist/lite/src/protos/google/protobuf/wrappers.proto +0 -123
  134. package/dist/lite/src/protos/google/rpc/status.proto +0 -92
  135. package/dist/lite/src/protos/google/type/latlng.proto +0 -71
  136. package/dist/lite/src/protos/update.sh +0 -61
  137. package/dist/packages/firestore/compat/api/blob.d.ts +0 -29
  138. package/dist/packages/firestore/compat/api/database.d.ts +0 -228
  139. package/dist/packages/firestore/compat/api/field_path.d.ts +0 -36
  140. package/dist/packages/firestore/compat/api/field_value.d.ts +0 -29
  141. package/dist/packages/firestore/compat/api/geo_point.d.ts +0 -17
  142. package/dist/packages/firestore/compat/api/observer.d.ts +0 -29
  143. package/dist/packages/firestore/compat/api/timestamp.d.ts +0 -17
  144. package/dist/packages/firestore/compat/config.d.ts +0 -28
  145. package/dist/packages/firestore/compat/index.console.d.ts +0 -42
  146. package/dist/packages/firestore/compat/index.d.ts +0 -49
  147. package/dist/packages/firestore/compat/index.node.d.ts +0 -22
  148. package/dist/packages/firestore/compat/index.rn.d.ts +0 -22
  149. package/dist/packages/firestore/compat/register-module.d.ts +0 -42
  150. package/dist/packages/firestore/compat/util/input_validation.d.ts +0 -18
  151. package/dist/src/protos/README.md +0 -2
  152. package/dist/src/protos/firestore/bundle.proto +0 -121
  153. package/dist/src/protos/firestore_bundle_proto.ts +0 -93
  154. package/dist/src/protos/firestore_proto_api.ts +0 -1259
  155. package/dist/src/protos/google/api/annotations.proto +0 -31
  156. package/dist/src/protos/google/api/http.proto +0 -370
  157. package/dist/src/protos/google/firestore/v1/common.proto +0 -84
  158. package/dist/src/protos/google/firestore/v1/document.proto +0 -151
  159. package/dist/src/protos/google/firestore/v1/firestore.proto +0 -761
  160. package/dist/src/protos/google/firestore/v1/query.proto +0 -302
  161. package/dist/src/protos/google/firestore/v1/write.proto +0 -264
  162. package/dist/src/protos/google/protobuf/any.proto +0 -155
  163. package/dist/src/protos/google/protobuf/descriptor.proto +0 -882
  164. package/dist/src/protos/google/protobuf/empty.proto +0 -52
  165. package/dist/src/protos/google/protobuf/struct.proto +0 -96
  166. package/dist/src/protos/google/protobuf/timestamp.proto +0 -137
  167. package/dist/src/protos/google/protobuf/wrappers.proto +0 -123
  168. package/dist/src/protos/google/rpc/status.proto +0 -92
  169. package/dist/src/protos/google/type/latlng.proto +0 -71
  170. package/dist/src/protos/update.sh +0 -61
@@ -1,28 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright 2021 Google LLC
4
- *
5
- * Licensed under the Apache License, Version 2.0 (the "License");
6
- * you may not use this file except in compliance with the License.
7
- * You may obtain a copy of the License at
8
- *
9
- * http://www.apache.org/licenses/LICENSE-2.0
10
- *
11
- * Unless required by applicable law or agreed to in writing, software
12
- * distributed under the License is distributed on an "AS IS" BASIS,
13
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- * See the License for the specific language governing permissions and
15
- * limitations under the License.
16
- */
17
- import { FirebaseApp } from '@firebase/app-compat';
18
- import { FirebaseNamespace } from '@firebase/app-types';
19
- import { Firestore as ModularFirestore } from '../src/api';
20
- import { Firestore } from './api/database';
21
- /**
22
- * Configures Firestore as part of the Firebase SDK by calling registerComponent.
23
- *
24
- * @param firebase - The FirebaseNamespace to register Firestore with
25
- * @param firestoreFactory - A factory function that returns a new Firestore
26
- * instance.
27
- */
28
- export declare function configureForFirebase(firebase: FirebaseNamespace, firestoreFactory: (app: FirebaseApp, firestoreExp: ModularFirestore) => Firestore): void;
@@ -1,42 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright 2019 Google LLC
4
- *
5
- * Licensed under the Apache License, Version 2.0 (the "License");
6
- * you may not use this file except in compliance with the License.
7
- * You may obtain a copy of the License at
8
- *
9
- * http://www.apache.org/licenses/LICENSE-2.0
10
- *
11
- * Unless required by applicable law or agreed to in writing, software
12
- * distributed under the License is distributed on an "AS IS" BASIS,
13
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- * See the License for the specific language governing permissions and
15
- * limitations under the License.
16
- */
17
- import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
18
- import { Provider } from '@firebase/component';
19
- import { Firestore as FirestoreCompat, PersistenceProvider } from './api/database';
20
- export { CollectionReference, DocumentReference, DocumentSnapshot, QuerySnapshot } from './api/database';
21
- export { Blob } from './api/blob';
22
- export { GeoPoint } from './api/geo_point';
23
- export { FieldPath } from './api/field_path';
24
- export { FieldValue } from './api/field_value';
25
- export { Timestamp } from './api/timestamp';
26
- export interface FirestoreDatabase {
27
- projectId: string;
28
- database?: string;
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
- }
39
- /** Firestore class that exposes the constructor expected by the Console. */
40
- export declare class Firestore extends FirestoreCompat {
41
- constructor(firestoreDatabase: FirestoreDatabase, authProvider: Provider<FirebaseAuthInternalName>);
42
- }
@@ -1,49 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright 2020 Google LLC
4
- *
5
- * Licensed under the Apache License, Version 2.0 (the "License");
6
- * you may not use this file except in compliance with the License.
7
- * You may obtain a copy of the License at
8
- *
9
- * http://www.apache.org/licenses/LICENSE-2.0
10
- *
11
- * Unless required by applicable law or agreed to in writing, software
12
- * distributed under the License is distributed on an "AS IS" BASIS,
13
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- * See the License for the specific language governing permissions and
15
- * limitations under the License.
16
- */
17
- import type { FirebaseNamespace } from '@firebase/app-types';
18
- import * as types from '@firebase/firestore-types';
19
- import './register-module';
20
- /**
21
- * Registers the main Firestore build with the components framework.
22
- * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
23
- */
24
- export declare function registerFirestore(instance: FirebaseNamespace): void;
25
- declare module '@firebase/app-compat' {
26
- interface FirebaseNamespace {
27
- firestore: {
28
- (app?: FirebaseApp): types.FirebaseFirestore;
29
- Blob: typeof types.Blob;
30
- CollectionReference: typeof types.CollectionReference;
31
- DocumentReference: typeof types.DocumentReference;
32
- DocumentSnapshot: typeof types.DocumentSnapshot;
33
- FieldPath: typeof types.FieldPath;
34
- FieldValue: typeof types.FieldValue;
35
- Firestore: typeof types.FirebaseFirestore;
36
- GeoPoint: typeof types.GeoPoint;
37
- Query: typeof types.Query;
38
- QueryDocumentSnapshot: typeof types.QueryDocumentSnapshot;
39
- QuerySnapshot: typeof types.QuerySnapshot;
40
- Timestamp: typeof types.Timestamp;
41
- Transaction: typeof types.Transaction;
42
- WriteBatch: typeof types.WriteBatch;
43
- setLogLevel: typeof types.setLogLevel;
44
- };
45
- }
46
- interface FirebaseApp {
47
- firestore?(): types.FirebaseFirestore;
48
- }
49
- }
@@ -1,22 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright 2017 Google LLC
4
- *
5
- * Licensed under the Apache License, Version 2.0 (the "License");
6
- * you may not use this file except in compliance with the License.
7
- * You may obtain a copy of the License at
8
- *
9
- * http://www.apache.org/licenses/LICENSE-2.0
10
- *
11
- * Unless required by applicable law or agreed to in writing, software
12
- * distributed under the License is distributed on an "AS IS" BASIS,
13
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- * See the License for the specific language governing permissions and
15
- * limitations under the License.
16
- */
17
- import { FirebaseNamespace } from '@firebase/app-types';
18
- /**
19
- * Registers the main Firestore Node build with the components framework.
20
- * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
21
- */
22
- export declare function registerFirestore(instance: FirebaseNamespace): void;
@@ -1,22 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright 2020 Google LLC
4
- *
5
- * Licensed under the Apache License, Version 2.0 (the "License");
6
- * you may not use this file except in compliance with the License.
7
- * You may obtain a copy of the License at
8
- *
9
- * http://www.apache.org/licenses/LICENSE-2.0
10
- *
11
- * Unless required by applicable law or agreed to in writing, software
12
- * distributed under the License is distributed on an "AS IS" BASIS,
13
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- * See the License for the specific language governing permissions and
15
- * limitations under the License.
16
- */
17
- import { FirebaseNamespace } from '@firebase/app-types';
18
- /**
19
- * Registers the main Firestore ReactNative build with the components framework.
20
- * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
21
- */
22
- export declare function registerFirestore(instance: FirebaseNamespace): void;
@@ -1,42 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright 2020 Google LLC
4
- *
5
- * Licensed under the Apache License, Version 2.0 (the "License");
6
- * you may not use this file except in compliance with the License.
7
- * You may obtain a copy of the License at
8
- *
9
- * http://www.apache.org/licenses/LICENSE-2.0
10
- *
11
- * Unless required by applicable law or agreed to in writing, software
12
- * distributed under the License is distributed on an "AS IS" BASIS,
13
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- * See the License for the specific language governing permissions and
15
- * limitations under the License.
16
- */
17
- import * as types from '@firebase/firestore-types';
18
- declare module '@firebase/app-compat' {
19
- interface FirebaseNamespace {
20
- firestore: {
21
- (app?: FirebaseApp): types.FirebaseFirestore;
22
- Blob: typeof types.Blob;
23
- CollectionReference: typeof types.CollectionReference;
24
- DocumentReference: typeof types.DocumentReference;
25
- DocumentSnapshot: typeof types.DocumentSnapshot;
26
- FieldPath: typeof types.FieldPath;
27
- FieldValue: typeof types.FieldValue;
28
- Firestore: typeof types.FirebaseFirestore;
29
- GeoPoint: typeof types.GeoPoint;
30
- Query: typeof types.Query;
31
- QueryDocumentSnapshot: typeof types.QueryDocumentSnapshot;
32
- QuerySnapshot: typeof types.QuerySnapshot;
33
- Timestamp: typeof types.Timestamp;
34
- Transaction: typeof types.Transaction;
35
- WriteBatch: typeof types.WriteBatch;
36
- setLogLevel: typeof types.setLogLevel;
37
- };
38
- }
39
- interface FirebaseApp {
40
- firestore?(): types.FirebaseFirestore;
41
- }
42
- }
@@ -1,18 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright 2021 Google LLC
4
- *
5
- * Licensed under the Apache License, Version 2.0 (the "License");
6
- * you may not use this file except in compliance with the License.
7
- * You may obtain a copy of the License at
8
- *
9
- * http://www.apache.org/licenses/LICENSE-2.0
10
- *
11
- * Unless required by applicable law or agreed to in writing, software
12
- * distributed under the License is distributed on an "AS IS" BASIS,
13
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- * See the License for the specific language governing permissions and
15
- * limitations under the License.
16
- */
17
- import { SetOptions } from '@firebase/firestore-types';
18
- export declare function validateSetOptions(methodName: string, options: SetOptions | undefined): SetOptions;
@@ -1,2 +0,0 @@
1
- These protos are copied from https://github.com/googleapis/googleapis and
2
- https://github.com/google/protobuf. Run update.sh to update them.
@@ -1,121 +0,0 @@
1
- // Copyright 2020 Google LLC.
2
- //
3
- // Licensed under the Apache License, Version 2.0 (the "License");
4
- // you may not use this file except in compliance with the License.
5
- // You may obtain a copy of the License at
6
- //
7
- // http://www.apache.org/licenses/LICENSE-2.0
8
- //
9
- // Unless required by applicable law or agreed to in writing, software
10
- // distributed under the License is distributed on an "AS IS" BASIS,
11
- // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- // See the License for the specific language governing permissions and
13
- // limitations under the License.
14
- //
15
-
16
- // This file defines the format of Firestore bundle file/stream. It is not a part of the
17
- // Firestore API, only a specification used by Server and Client SDK to write and read
18
- // bundles.
19
-
20
- syntax = "proto3";
21
-
22
- package firestore;
23
-
24
- import "google/firestore/v1/document.proto";
25
- import "google/firestore/v1/query.proto";
26
- import "google/protobuf/timestamp.proto";
27
-
28
- option csharp_namespace = "Firestore.Proto";
29
- option go_package = "google.golang.org/genproto/firestore/proto;firestore";
30
- option java_multiple_files = true;
31
- option java_outer_classname = "BundleProto";
32
- option java_package = "com.google.firestore.proto";
33
- option objc_class_prefix = "FSTPB";
34
- option php_namespace = "Firestore\\Proto";
35
-
36
- // Describes a query saved in the bundle.
37
- message BundledQuery {
38
- // The parent resource name.
39
- string parent = 1;
40
-
41
- // The query to run.
42
- oneof query_type {
43
- // A structured query.
44
- google.firestore.v1.StructuredQuery structured_query = 2;
45
- }
46
-
47
- // If the query is a limit query, should the limit be applied to the beginning or
48
- // the end of results.
49
- enum LimitType {
50
- FIRST = 0;
51
- LAST = 1;
52
- }
53
- LimitType limit_type = 3;
54
- }
55
-
56
- // A Query associated with a name, created as part of the bundle file, and can be read
57
- // by client SDKs once the bundle containing them is loaded.
58
- message NamedQuery {
59
- // Name of the query, such that client can use the name to load this query
60
- // from bundle, and resume from when the query results are materialized
61
- // into this bundle.
62
- string name = 1;
63
-
64
- // The query saved in the bundle.
65
- BundledQuery bundled_query = 2;
66
-
67
- // The read time of the query, when it is used to build the bundle. This is useful to
68
- // resume the query from the bundle, once it is loaded by client SDKs.
69
- google.protobuf.Timestamp read_time = 3;
70
- }
71
-
72
- // Metadata describing a Firestore document saved in the bundle.
73
- message BundledDocumentMetadata {
74
- // The document key of a bundled document.
75
- string name = 1;
76
-
77
- // The snapshot version of the document data bundled.
78
- google.protobuf.Timestamp read_time = 2;
79
-
80
- // Whether the document exists.
81
- bool exists = 3;
82
-
83
- // The names of the queries in this bundle that this document matches to.
84
- repeated string queries = 4;
85
- }
86
-
87
- // Metadata describing the bundle file/stream.
88
- message BundleMetadata {
89
- // The ID of the bundle.
90
- string id = 1;
91
-
92
- // Time at which the documents snapshot is taken for this bundle.
93
- google.protobuf.Timestamp create_time = 2;
94
-
95
- // The schema version of the bundle.
96
- uint32 version = 3;
97
-
98
- // The number of documents in the bundle.
99
- uint32 total_documents = 4;
100
-
101
- // The size of the bundle in bytes, excluding this `BundleMetadata`.
102
- uint64 total_bytes = 5;
103
- }
104
-
105
- // A Firestore bundle is a length-prefixed stream of JSON representations of
106
- // `BundleElement`.
107
- // Only one `BundleMetadata` is expected, and it should be the first element.
108
- // The named queries follow after `metadata`. If a document exists when the
109
- // bundle is built, `document_metadata` is immediately followed by the
110
- // `document`, otherwise `document_metadata` will present by itself.
111
- message BundleElement {
112
- oneof element_type {
113
- BundleMetadata metadata = 1;
114
-
115
- NamedQuery named_query = 2;
116
-
117
- BundledDocumentMetadata document_metadata = 3;
118
-
119
- google.firestore.v1.Document document = 4;
120
- }
121
- }
@@ -1,93 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright 2020 Google LLC
4
- *
5
- * Licensed under the Apache License, Version 2.0 (the "License");
6
- * you may not use this file except in compliance with the License.
7
- * You may obtain a copy of the License at
8
- *
9
- * http://www.apache.org/licenses/LICENSE-2.0
10
- *
11
- * Unless required by applicable law or agreed to in writing, software
12
- * distributed under the License is distributed on an "AS IS" BASIS,
13
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- * See the License for the specific language governing permissions and
15
- * limitations under the License.
16
- */
17
-
18
- import { StructuredQuery, Timestamp, Document } from './firestore_proto_api';
19
-
20
- /** Properties of a BundledQuery. */
21
- export interface BundledQuery {
22
- /** BundledQuery parent */
23
- parent?: string | null;
24
-
25
- /** BundledQuery structuredQuery */
26
- structuredQuery?: StructuredQuery | null;
27
-
28
- /** BundledQuery limitType */
29
- limitType?: LimitType | null;
30
- }
31
-
32
- /** LimitType enum. */
33
- export type LimitType = 'FIRST' | 'LAST';
34
-
35
- /** Properties of a NamedQuery. */
36
- export interface NamedQuery {
37
- /** NamedQuery name */
38
- name?: string | null;
39
-
40
- /** NamedQuery bundledQuery */
41
- bundledQuery?: BundledQuery | null;
42
-
43
- /** NamedQuery readTime */
44
- readTime?: Timestamp | null;
45
- }
46
-
47
- /** Properties of a BundledDocumentMetadata. */
48
- export interface BundledDocumentMetadata {
49
- /** BundledDocumentMetadata name */
50
- name?: string | null;
51
-
52
- /** BundledDocumentMetadata readTime */
53
- readTime?: Timestamp | null;
54
-
55
- /** BundledDocumentMetadata exists */
56
- exists?: boolean | null;
57
-
58
- /** The names of the queries in this bundle that this document matches to. */
59
- queries?: string[];
60
- }
61
-
62
- /** Properties of a BundleMetadata. */
63
- export interface BundleMetadata {
64
- /** BundleMetadata id */
65
- id?: string | null;
66
-
67
- /** BundleMetadata createTime */
68
- createTime?: Timestamp | null;
69
-
70
- /** BundleMetadata version */
71
- version?: number | null;
72
-
73
- /** BundleMetadata totalDocuments */
74
- totalDocuments?: number | null;
75
-
76
- /** BundleMetadata totalBytes */
77
- totalBytes?: number | null;
78
- }
79
-
80
- /** Properties of a BundleElement. */
81
- export interface BundleElement {
82
- /** BundleElement metadata */
83
- metadata?: BundleMetadata | null;
84
-
85
- /** BundleElement namedQuery */
86
- namedQuery?: NamedQuery | null;
87
-
88
- /** BundleElement documentMetadata */
89
- documentMetadata?: BundledDocumentMetadata | null;
90
-
91
- /** BundleElement document */
92
- document?: Document | null;
93
- }