Skip to content

Commit d651d88

Browse files
wu-huiwu-hui
committed
Fixing dts file
1 parent 7d0b186 commit d651d88

File tree

8 files changed

+156
-40
lines changed

8 files changed

+156
-40
lines changed

‎common/api-review/firestore.api.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,8 +216,13 @@ export class FirestoreError extends FirebaseError {
216216
// @public
217217
export type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';
218218

219+
// @public (undocumented)
220+
export type FirestoreLocalCache = MemoryLocalCache | IndexedDbLocalCache;
221+
219222
// @public
220223
export interface FirestoreSettings {
224+
// (undocumented)
225+
cache?: FirestoreLocalCache;
221226
cacheSizeBytes?: number;
222227
experimentalAutoDetectLongPolling?: boolean;
223228
experimentalForceLongPolling?: boolean;
@@ -285,6 +290,46 @@ export interface IndexConfiguration {
285290
readonly indexes?: Index[];
286291
}
287292

293+
// @public (undocumented)
294+
export interface IndexedDbLocalCache {
295+
// (undocumented)
296+
kind: 'indexeddb';
297+
}
298+
299+
// @public (undocumented)
300+
export function indexedDbLocalCache(settings?: IndexedDbSettings): IndexedDbLocalCache;
301+
302+
// @public (undocumented)
303+
export interface IndexedDbMultipleTabManager {
304+
// (undocumented)
305+
kind: 'IndexedDbMultipleTab';
306+
}
307+
308+
// @public (undocumented)
309+
export function indexedDbMultipleTabManager(): IndexedDbMultipleTabManager;
310+
311+
// @public (undocumented)
312+
export interface IndexedDbSettings {
313+
// (undocumented)
314+
cacheSizeBytes?: number;
315+
// (undocumented)
316+
tabManager?: IndexedDbTabManager;
317+
}
318+
319+
// @public (undocumented)
320+
export interface IndexedDbSingleTabManager {
321+
// (undocumented)
322+
kind: 'indexedDbSingleTab';
323+
}
324+
325+
// @public (undocumented)
326+
export function indexedDbSingleTabManager(settings: {
327+
forceOwnership?: boolean;
328+
} | undefined): IndexedDbSingleTabManager;
329+
330+
// @public (undocumented)
331+
export type IndexedDbTabManager = IndexedDbSingleTabManager | IndexedDbMultipleTabManager;
332+
288333
// @beta
289334
export interface IndexField {
290335
// (undocumented)
@@ -324,6 +369,15 @@ export interface LoadBundleTaskProgress {
324369

325370
export { LogLevel }
326371

372+
// @public (undocumented)
373+
export interface MemoryLocalCache {
374+
// (undocumented)
375+
kind: 'memory';
376+
}
377+
378+
// @public (undocumented)
379+
export function memoryLocalCache(): MemoryLocalCache;
380+
327381
// @public
328382
export function namedQuery(firestore: Firestore, name: string): Promise<Query | null>;
329383

‎packages/firestore/src/api.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@ export {
3030

3131
export {
3232
FirestoreLocalCache,
33-
MemoryLocalCache,
3433
IndexedDbLocalCache,
3534
IndexedDbMultipleTabManager,
3635
indexedDbLocalCache,
3736
indexedDbMultipleTabManager,
3837
IndexedDbSettings,
3938
indexedDbSingleTabManager,
4039
IndexedDbSingleTabManager,
40+
MemoryLocalCache,
4141
memoryLocalCache,
4242
IndexedDbTabManager
4343
} from './api/cache_config';

‎packages/firestore/src/api/cache_config.ts

Lines changed: 72 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,28 @@ import {
2323
OnlineComponentProvider
2424
} from '../core/component_provider';
2525

26-
export interface MemoryLocalCache {
26+
/* eslint @typescript-eslint/consistent-type-definitions: ["error", "type"] */
27+
export type MemoryLocalCache = {
2728
kind: 'memory';
29+
/**
30+
* @internal
31+
*/
2832
_onlineComponentProvider: OnlineComponentProvider;
33+
/**
34+
* @internal
35+
*/
2936
_offlineComponentProvider: MemoryOfflineComponentProvider;
30-
}
37+
};
3138

3239
class MemoryLocalCacheImpl implements MemoryLocalCache {
3340
kind: 'memory' = 'memory';
41+
/**
42+
* @internal
43+
*/
3444
_onlineComponentProvider: OnlineComponentProvider;
45+
/**
46+
* @internal
47+
*/
3548
_offlineComponentProvider: MemoryOfflineComponentProvider;
3649

3750
constructor() {
@@ -44,15 +57,27 @@ class MemoryLocalCacheImpl implements MemoryLocalCache {
4457
}
4558
}
4659

47-
export interface IndexedDbLocalCache {
60+
export type IndexedDbLocalCache = {
4861
kind: 'indexeddb';
62+
/**
63+
* @internal
64+
*/
4965
_onlineComponentProvider: OnlineComponentProvider;
66+
/**
67+
* @internal
68+
*/
5069
_offlineComponentProvider: OfflineComponentProvider;
51-
}
70+
};
5271

5372
class IndexedDbLocalCacheImpl implements IndexedDbLocalCache {
5473
kind: 'indexeddb' = 'indexeddb';
74+
/**
75+
* @internal
76+
*/
5577
_onlineComponentProvider: OnlineComponentProvider;
78+
/**
79+
* @internal
80+
*/
5681
_offlineComponentProvider: OfflineComponentProvider;
5782

5883
constructor(settings: IndexedDbSettings | undefined) {
@@ -80,11 +105,11 @@ export function memoryLocalCache(): MemoryLocalCache {
80105
return new MemoryLocalCacheImpl();
81106
}
82107

83-
export interface IndexedDbSettings {
108+
export type IndexedDbSettings = {
84109
cacheSizeBytes?: number;
85110
// default to singleTabManager({forceOwnership: false})
86111
tabManager?: IndexedDbTabManager;
87-
}
112+
};
88113

89114
// Factory function
90115
export function indexedDbLocalCache(
@@ -93,19 +118,34 @@ export function indexedDbLocalCache(
93118
return new IndexedDbLocalCacheImpl(settings);
94119
}
95120

96-
export interface IndexedDbSingleTabManager {
121+
export type IndexedDbSingleTabManager = {
97122
kind: 'indexedDbSingleTab';
123+
/**
124+
* @internal
125+
*/
98126
_initialize: (
99127
settings: Omit<IndexedDbSettings, 'tabManager'> | undefined
100128
) => void;
129+
/**
130+
* @internal
131+
*/
101132
_onlineComponentProvider?: OnlineComponentProvider;
133+
/**
134+
* @internal
135+
*/
102136
_offlineComponentProvider?: OfflineComponentProvider;
103-
}
137+
};
104138

105139
class SingleTabManagerImpl implements IndexedDbSingleTabManager {
106140
kind: 'indexedDbSingleTab' = 'indexedDbSingleTab';
107141

142+
/**
143+
* @internal
144+
*/
108145
_onlineComponentProvider?: OnlineComponentProvider;
146+
/**
147+
* @internal
148+
*/
109149
_offlineComponentProvider?: OfflineComponentProvider;
110150

111151
constructor(private forceOwnership?: boolean) {}
@@ -114,6 +154,9 @@ class SingleTabManagerImpl implements IndexedDbSingleTabManager {
114154
return { kind: this.kind };
115155
}
116156

157+
/**
158+
* @internal
159+
*/
117160
_initialize(
118161
settings: Omit<IndexedDbSettings, 'tabManager'> | undefined
119162
): void {
@@ -126,23 +169,42 @@ class SingleTabManagerImpl implements IndexedDbSingleTabManager {
126169
}
127170
}
128171

129-
export interface IndexedDbMultipleTabManager {
172+
export type IndexedDbMultipleTabManager = {
130173
kind: 'IndexedDbMultipleTab';
174+
/**
175+
* @internal
176+
*/
131177
_initialize: (settings: Omit<IndexedDbSettings, 'tabManager'>) => void;
178+
/**
179+
* @internal
180+
*/
132181
_onlineComponentProvider?: OnlineComponentProvider;
182+
/**
183+
* @internal
184+
*/
185+
133186
_offlineComponentProvider?: OfflineComponentProvider;
134-
}
187+
};
135188

136189
class MultiTabManagerImpl implements IndexedDbMultipleTabManager {
137190
kind: 'IndexedDbMultipleTab' = 'IndexedDbMultipleTab';
138191

192+
/**
193+
* @internal
194+
*/
139195
_onlineComponentProvider?: OnlineComponentProvider;
196+
/**
197+
* @internal
198+
*/
140199
_offlineComponentProvider?: OfflineComponentProvider;
141200

142201
toJSON(): {} {
143202
return { kind: this.kind };
144203
}
145204

205+
/**
206+
* @internal
207+
*/
146208
_initialize(
147209
settings: Omit<IndexedDbSettings, 'tabManager'> | undefined
148210
): void {

‎packages/firestore/src/api/database.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -287,10 +287,10 @@ export function configureFirestore(firestore: Firestore): void {
287287
settings.cache?._offlineComponentProvider &&
288288
settings.cache?._onlineComponentProvider
289289
) {
290-
firestore._firestoreClient.uninitializedComponentsProvider = {
291-
offlineKind: settings.cache.kind,
292-
offline: settings.cache._offlineComponentProvider,
293-
online: settings.cache._onlineComponentProvider
290+
firestore._firestoreClient._uninitializedComponentsProvider = {
291+
_offlineKind: settings.cache.kind,
292+
_offline: settings.cache._offlineComponentProvider,
293+
_online: settings.cache._onlineComponentProvider
294294
};
295295
}
296296
}
@@ -327,7 +327,7 @@ export function enableIndexedDbPersistence(
327327
verifyNotInitialized(firestore);
328328

329329
const client = ensureFirestoreConfigured(firestore);
330-
if (client.uninitializedComponentsProvider) {
330+
if (client._uninitializedComponentsProvider) {
331331
throw new FirestoreError(
332332
Code.FAILED_PRECONDITION,
333333
'SDK cache is already specified.'
@@ -379,7 +379,7 @@ export function enableMultiTabIndexedDbPersistence(
379379
verifyNotInitialized(firestore);
380380

381381
const client = ensureFirestoreConfigured(firestore);
382-
if (client.uninitializedComponentsProvider) {
382+
if (client._uninitializedComponentsProvider) {
383383
throw new FirestoreError(
384384
Code.FAILED_PRECONDITION,
385385
'SDK cache is already specified.'

‎packages/firestore/src/api/index_configuration.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,8 +151,8 @@ export function setIndexConfiguration(
151151
firestore = cast(firestore, Firestore);
152152
const client = ensureFirestoreConfigured(firestore);
153153
if (
154-
!client.uninitializedComponentsProvider ||
155-
client.uninitializedComponentsProvider?.offlineKind === 'memory'
154+
!client._uninitializedComponentsProvider ||
155+
client._uninitializedComponentsProvider?._offlineKind === 'memory'
156156
) {
157157
// PORTING NOTE: We don't return an error if the user has not enabled
158158
// persistence since `enableIndexeddbPersistence()` can fail on the Web.

0 commit comments

Comments
 (0)