Skip to content

Commit 6535efa

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

File tree

8 files changed

+153
-38
lines changed

8 files changed

+153
-38
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: 69 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,27 @@ import {
2323
OnlineComponentProvider
2424
} from '../core/component_provider';
2525

26-
export interface MemoryLocalCache {
26+
export type MemoryLocalCache = {
2727
kind: 'memory';
28+
/**
29+
* @internal
30+
*/
2831
_onlineComponentProvider: OnlineComponentProvider;
32+
/**
33+
* @internal
34+
*/
2935
_offlineComponentProvider: MemoryOfflineComponentProvider;
30-
}
36+
};
3137

3238
class MemoryLocalCacheImpl implements MemoryLocalCache {
3339
kind: 'memory' = 'memory';
40+
/**
41+
* @internal
42+
*/
3443
_onlineComponentProvider: OnlineComponentProvider;
44+
/**
45+
* @internal
46+
*/
3547
_offlineComponentProvider: MemoryOfflineComponentProvider;
3648

3749
constructor() {
@@ -44,15 +56,27 @@ class MemoryLocalCacheImpl implements MemoryLocalCache {
4456
}
4557
}
4658

47-
export interface IndexedDbLocalCache {
59+
export type IndexedDbLocalCache = {
4860
kind: 'indexeddb';
61+
/**
62+
* @internal
63+
*/
4964
_onlineComponentProvider: OnlineComponentProvider;
65+
/**
66+
* @internal
67+
*/
5068
_offlineComponentProvider: OfflineComponentProvider;
51-
}
69+
};
5270

5371
class IndexedDbLocalCacheImpl implements IndexedDbLocalCache {
5472
kind: 'indexeddb' = 'indexeddb';
73+
/**
74+
* @internal
75+
*/
5576
_onlineComponentProvider: OnlineComponentProvider;
77+
/**
78+
* @internal
79+
*/
5680
_offlineComponentProvider: OfflineComponentProvider;
5781

5882
constructor(settings: IndexedDbSettings | undefined) {
@@ -93,19 +117,34 @@ export function indexedDbLocalCache(
93117
return new IndexedDbLocalCacheImpl(settings);
94118
}
95119

96-
export interface IndexedDbSingleTabManager {
120+
export type IndexedDbSingleTabManager = {
97121
kind: 'indexedDbSingleTab';
122+
/**
123+
* @internal
124+
*/
98125
_initialize: (
99126
settings: Omit<IndexedDbSettings, 'tabManager'> | undefined
100127
) => void;
128+
/**
129+
* @internal
130+
*/
101131
_onlineComponentProvider?: OnlineComponentProvider;
132+
/**
133+
* @internal
134+
*/
102135
_offlineComponentProvider?: OfflineComponentProvider;
103-
}
136+
};
104137

105138
class SingleTabManagerImpl implements IndexedDbSingleTabManager {
106139
kind: 'indexedDbSingleTab' = 'indexedDbSingleTab';
107140

141+
/**
142+
* @internal
143+
*/
108144
_onlineComponentProvider?: OnlineComponentProvider;
145+
/**
146+
* @internal
147+
*/
109148
_offlineComponentProvider?: OfflineComponentProvider;
110149

111150
constructor(private forceOwnership?: boolean) {}
@@ -114,6 +153,9 @@ class SingleTabManagerImpl implements IndexedDbSingleTabManager {
114153
return { kind: this.kind };
115154
}
116155

156+
/**
157+
* @internal
158+
*/
117159
_initialize(
118160
settings: Omit<IndexedDbSettings, 'tabManager'> | undefined
119161
): void {
@@ -126,23 +168,42 @@ class SingleTabManagerImpl implements IndexedDbSingleTabManager {
126168
}
127169
}
128170

129-
export interface IndexedDbMultipleTabManager {
171+
export type IndexedDbMultipleTabManager = {
130172
kind: 'IndexedDbMultipleTab';
173+
/**
174+
* @internal
175+
*/
131176
_initialize: (settings: Omit<IndexedDbSettings, 'tabManager'>) => void;
177+
/**
178+
* @internal
179+
*/
132180
_onlineComponentProvider?: OnlineComponentProvider;
181+
/**
182+
* @internal
183+
*/
184+
133185
_offlineComponentProvider?: OfflineComponentProvider;
134-
}
186+
};
135187

136188
class MultiTabManagerImpl implements IndexedDbMultipleTabManager {
137189
kind: 'IndexedDbMultipleTab' = 'IndexedDbMultipleTab';
138190

191+
/**
192+
* @internal
193+
*/
139194
_onlineComponentProvider?: OnlineComponentProvider;
195+
/**
196+
* @internal
197+
*/
140198
_offlineComponentProvider?: OfflineComponentProvider;
141199

142200
toJSON(): {} {
143201
return { kind: this.kind };
144202
}
145203

204+
/**
205+
* @internal
206+
*/
146207
_initialize(
147208
settings: Omit<IndexedDbSettings, 'tabManager'> | undefined
148209
): 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.

‎packages/firestore/src/core/firestore_client.ts‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -114,14 +114,14 @@ export class FirestoreClient {
114114
appCheckToken: string,
115115
user: User
116116
) => Promise<void> = () => Promise.resolve();
117-
uninitializedComponentsProvider?: {
118-
offline: OfflineComponentProvider;
119-
offlineKind: 'memory' | 'indexeddb';
120-
online: OnlineComponentProvider;
117+
_uninitializedComponentsProvider?: {
118+
_offline: OfflineComponentProvider;
119+
_offlineKind: 'memory' | 'indexeddb';
120+
_online: OnlineComponentProvider;
121121
};
122122

123-
offlineComponents?: OfflineComponentProvider;
124-
onlineComponents?: OnlineComponentProvider;
123+
_offlineComponents?: OfflineComponentProvider;
124+
_onlineComponents?: OnlineComponentProvider;
125125

126126
constructor(
127127
private authCredentials: CredentialsProvider<User>,
@@ -188,11 +188,11 @@ export class FirestoreClient {
188188
const deferred = new Deferred();
189189
this.asyncQueue.enqueueAndForgetEvenWhileRestricted(async () => {
190190
try {
191-
if (this.onlineComponents) {
192-
await this.onlineComponents.terminate();
191+
if (this._onlineComponents) {
192+
await this._onlineComponents.terminate();
193193
}
194-
if (this.offlineComponents) {
195-
await this.offlineComponents.terminate();
194+
if (this._offlineComponents) {
195+
await this._offlineComponents.terminate();
196196
}
197197

198198
// The credentials provider must be terminated after shutting down the
@@ -240,7 +240,7 @@ export async function setOfflineComponentProvider(
240240
client.terminate()
241241
);
242242

243-
client.offlineComponents = offlineComponentProvider;
243+
client._offlineComponents = offlineComponentProvider;
244244
}
245245

246246
export async function setOnlineComponentProvider(
@@ -265,18 +265,18 @@ export async function setOnlineComponentProvider(
265265
client.setAppCheckTokenChangeListener((_, user) =>
266266
remoteStoreHandleCredentialChange(onlineComponentProvider.remoteStore, user)
267267
);
268-
client.onlineComponents = onlineComponentProvider;
268+
client._onlineComponents = onlineComponentProvider;
269269
}
270270

271271
async function ensureOfflineComponents(
272272
client: FirestoreClient
273273
): Promise<OfflineComponentProvider> {
274-
if (!client.offlineComponents) {
275-
if (client.uninitializedComponentsProvider) {
274+
if (!client._offlineComponents) {
275+
if (client._uninitializedComponentsProvider) {
276276
logDebug(LOG_TAG, 'Using user provided OfflineComponentProvider');
277277
await setOfflineComponentProvider(
278278
client,
279-
client.uninitializedComponentsProvider.offline
279+
client._uninitializedComponentsProvider._offline
280280
);
281281
} else {
282282
logDebug(LOG_TAG, 'Using default OfflineComponentProvider');
@@ -287,26 +287,26 @@ async function ensureOfflineComponents(
287287
}
288288
}
289289

290-
return client.offlineComponents!;
290+
return client._offlineComponents!;
291291
}
292292

293293
async function ensureOnlineComponents(
294294
client: FirestoreClient
295295
): Promise<OnlineComponentProvider> {
296-
if (!client.onlineComponents) {
297-
if (client.uninitializedComponentsProvider) {
296+
if (!client._onlineComponents) {
297+
if (client._uninitializedComponentsProvider) {
298298
logDebug(LOG_TAG, 'Using user provided OnlineComponentProvider');
299299
await setOnlineComponentProvider(
300300
client,
301-
client.uninitializedComponentsProvider.online
301+
client._uninitializedComponentsProvider._online
302302
);
303303
} else {
304304
logDebug(LOG_TAG, 'Using default OnlineComponentProvider');
305305
await setOnlineComponentProvider(client, new OnlineComponentProvider());
306306
}
307307
}
308308

309-
return client.onlineComponents!;
309+
return client._onlineComponents!;
310310
}
311311

312312
function getPersistence(client: FirestoreClient): Promise<Persistence> {

‎packages/firestore/test/integration/util/helpers.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,6 @@ export async function withTestDbsSettings(
185185
const dbs: Firestore[] = [];
186186

187187
for (let i = 0; i < numDbs; i++) {
188-
// logWarn(`set persistence from helper: ${persistence}`);
189188
const newSettings = { ...settings };
190189
if (persistence) {
191190
newSettings.cache = indexedDbLocalCache();

0 commit comments

Comments
 (0)