-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
index.d.ts
589 lines (556 loc) · 16.2 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
/*
* Copyright (c) 2016-present Invertase Limited & Contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this library except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
import { ReactNativeFirebase } from '@react-native-firebase/app';
/**
* Firebase Remote RemoteConfig package for React Native.
*
* #### Example 1
*
* Access the firebase export from the `config` package:
*
* ```js
* import { firebase } from '@react-native-firebase/remote-config';
*
* // firebase.remoteConfig().X
* ```
*
* #### Example 2
*
* Using the default export from the `config` package:
*
* ```js
* import remoteConfig from '@react-native-firebase/remote-config';
*
* // remoteConfig().X
* ```
*
* #### Example 3
*
* Using the default export from the `app` package:
*
* ```js
* import firebase from '@react-native-firebase/app';
* import '@react-native-firebase/remote-config';
*
* // firebase.remoteConfig().X
* ```
*
* @firebase remote-config
*/
export namespace FirebaseRemoteConfigTypes {
import FirebaseModule = ReactNativeFirebase.FirebaseModule;
/**
* Defines levels of Remote Config logging. Web only.
*/
export declare type RemoteConfigLogLevel = 'debug' | 'error' | 'silent';
/**
* A pseudo-enum for usage with ConfigSettingsRead.lastFetchStatus to determine the last fetch status.
*
* #### Example
*
* ```js
* firebase.remoteConfig.LastFetchStatus;
* ```
*/
export interface LastFetchStatus {
/**
* A value indicating that the last fetch was successful.
*
* ```js
* firebase.remoteConfig.LastFetchStatus.SUCCESS;
* ```
*/
SUCCESS: 'success';
/**
* A value indicating that the last fetch failed.
*
* ```js
* firebase.remoteConfig.LastFetchStatus.FAILURE;
* ```
*/
FAILURE: 'failure';
/**
* A value indicating that the last fetch was throttled.
*
* This usually occurs when calling fetch often with a low expiration duration.
*
* ```js
* firebase.remoteConfig.LastFetchStatus.THROTTLED;
* ```
*/
THROTTLED: 'throttled';
/**
* A value indicating that no fetches have occurred yet.
*
* This usually means you've not called fetch yet.
*
* ```js
* firebase.remoteConfig.LastFetchStatus.NO_FETCH_YET;
* ```
*/
NO_FETCH_YET: 'no_fetch_yet';
}
/**
* A pseudo-enum for usage with ConfigValue.source to determine the value source.
*
* #### Example
*
* ```js
* firebase.remoteConfig.ValueSource;
* ```
*/
export interface ValueSource {
/**
* If the value was retrieved from the server.
*
* ```js
* firebase.remoteConfig.ValueSource.REMOTE;
* ```
*/
REMOTE: 'remote';
/**
* If the value was set as a default value.
*
* ```js
* firebase.remoteConfig.ValueSource.DEFAULT;
* ```
*/
DEFAULT: 'default';
/**
* If no value was found and a static default value was returned instead.
*
* ```js
* firebase.remoteConfig.ValueSource.STATIC;
* ```
*/
STATIC: 'static';
}
/**
* Firebase Remote RemoteConfig statics.
*
* ```js
* firebase.config;
* ```
*/
export interface Statics {
/**
* A pseudo-enum for usage with ConfigValue.source to determine the value source.
*
* #### Example
*
* ```js
* firebase.remoteConfig.ValueSource;
* ```
*/
ValueSource: ValueSource;
/**
* A pseudo-enum for usage with `firebase.remoteConfig().lastFetchStatus` to determine the last fetch status.
*
* #### Example
*
* ```js
* firebase.remoteConfig.LastFetchStatus;
* ```
*/
LastFetchStatus: LastFetchStatus;
}
/**
* An Interface representing a RemoteConfig value.
*/
export interface ConfigValue {
/**
* Where the value was retrieved from.
*
* - `remote`: If the value was retrieved from the server.
* - `default`: If the value was set as a default value.
* - `static`: If no value was found and a static default value was returned instead.
*
* See the `ValueSource` statics definition.
*
* #### Example
*
* ```js
* const configValue = firebase.remoteConfig().getValue('beta_enabled');
* console.log('Value source: ', configValue.getSource());
* ```
*/
getSource(): 'remote' | 'default' | 'static';
/**
* The returned value.
*
* #### Example
*
* ```js
* const configValue = firebase.remoteConfig().getValue('dev_mode');
* console.log('Boolean: ', configValue.asBoolean());
* ```
*/
asBoolean(): true | false;
/**
* The returned value.
*
* #### Example
*
* ```js
* const configValue = firebase.remoteConfig().getValue('user_count');
* console.log('Count: ', configValue.asNumber());
* ```
*/
asNumber(): number;
/**
* The returned value.
*
* #### Example
*
* ```js
* const configValue = firebase.remoteConfig().getValue('username');
* console.log('Name: ', configValue.asString());
* ```
*/
asString(): string;
}
/**
* An Interface representing multiple RemoteConfig Values.
*
* #### Example
*
* ```js
* const values = firebase.remoteConfig().getAll();
* ```
*/
export interface ConfigValues {
[key: string]: ConfigValue;
}
/**
* An Interface representing settable config settings.
*
* #### Example
*
* The example below shows how to set a time limit to the length of time the request for remote config values
*
* ```js
* await firebase.remoteConfig().setConfigSettings({
* fetchTimeMillis: 6000,
* });
* ```
*/
export interface ConfigSettings {
/**
* Indicates the default value in milliseconds to set for the minimum interval that needs to elapse
* before a fetch request can again be made to the Remote Config server. Defaults to 43200000 (Twelve hours).
*/
minimumFetchIntervalMillis?: number;
/**
* Indicates the default value in milliseconds to abandon a pending fetch request made to the Remote Config server. Defaults to 60000 (One minute).
*/
fetchTimeMillis?: number;
}
/**
* Set default config values by updating `defaultConfig` with an object & the properties you require as default.
*
* #### Example
*
* ```js
* await firebase.remoteConfig().setDefaults({
* experiment_enabled: false,
* });
* ```
*/
export interface ConfigDefaults {
[key: string]: number | string | boolean;
}
/**
* The status of the latest Remote RemoteConfig fetch action.
*/
type LastFetchStatusType = 'success' | 'failure' | 'no_fetch_yet' | 'throttled';
/**
* The Firebase Remote RemoteConfig service interface.
*
* > This module is available for the default app only.
*
* #### Example
*
* Get the Remote RemoteConfig service for the default app:
*
* ```js
* const defaultAppRemoteConfig = firebase.remoteConfig();
* ```
*/
export class Module extends FirebaseModule {
/**
* The number of milliseconds since the last Remote RemoteConfig fetch was performed.
*/
fetchTimeMillis: number;
/**
* The status of the latest Remote RemoteConfig fetch action.
*
* See the `LastFetchStatus` statics definition.
*/
lastFetchStatus: LastFetchStatusType;
/**
* Provides an object which provides the properties `minimumFetchIntervalMillis` & `fetchTimeMillis` if they have been set
* using setConfigSettings({ fetchTimeMillis: number, minimumFetchIntervalMillis: number }). A description of the properties
* can be found above
*
*/
settings: ConfigSettings;
/**
* Provides an object with the type ConfigDefaults for default configuration values
*/
defaultConfig: ConfigDefaults;
/**
* Set the Remote RemoteConfig settings, currently able to set `fetchTimeMillis` & `minimumFetchIntervalMillis`
*
* #### Example
*
* ```js
* await firebase.remoteConfig().setConfigSettings({
* minimumFetchIntervalMillis: 30000,
* });
* ```
*
* @param configSettings A ConfigSettingsWrite instance used to set Remote RemoteConfig settings.
*/
setConfigSettings(configSettings: ConfigSettings): Promise<void>;
/**
* Sets default values for the app to use when accessing values.
* Any data fetched and activated will override any default values. Any values in the defaults but not on Firebase will be untouched.
*
* #### Example
*
* ```js
* await firebase.remoteConfig().setDefaults({
* experiment_enabled: false,
* });
* ```
*
* @param defaults A ConfigDefaults instance used to set default values.
*/
setDefaults(defaults: ConfigDefaults): Promise<null>;
/**
* Sets the default values from a resource file.
* On iOS this is a plist file and on Android this is an XML defaultsMap file.
*
* ```js
* // put in either your iOS or Android directory without the file extension included (.plist or .xml)
* await firebase.remoteConfig().setDefaultsFromResource('config_resource');
*
* // resource values will now be loaded in with your other config values
* const config = firebase.remoteConfig().getAll();
* ```
*
* @param resourceName The plist/xml file name with no extension.
*/
setDefaultsFromResource(resourceName: string): Promise<null>;
/**
* Start listening for real-time config updates from the Remote Config backend and
* automatically fetch updates when they’re available. Note that the list of updated keys
* passed to the callback will include all keys not currently active, and the config update
* process fetches the new config but does not automatically activate for you. Typically
* you will want to activate the config in your callback so the new values are in force.
*
* @param listener called with either array of updated keys or error arg when config changes
*/
onConfigUpdated(listener: CallbackOrObserver<OnConfigUpdatedListenerCallback>): () => void;
/**
* Moves fetched data to the apps active config.
* Resolves with a boolean value true if new local values were activated
*
* #### Example
*
* ```js
* // Fetch values
* await firebase.remoteConfig().fetch();
* const activated = await firebase.remoteConfig().activate();
*
* if (activated) {
* console.log('Fetched values successfully activated.');
* } else {
* console.log('Fetched values were already activated.');
* }
* ```
*/
activate(): Promise<boolean>;
/**
* Ensures the last activated config are available to the getters.
*
* #### Example
*
* ```js
* await firebase.remoteConfig().ensureInitialized();
* // get remote config values
* ```
*/
ensureInitialized(): Promise<void>;
/**
* Fetches the remote config data from Firebase, as defined in the dashboard. If duration is defined (seconds), data will be locally cached for this duration.
*
* #### Example
*
* ```js
* // Fetch and cache for 5 minutes
* await firebase.remoteConfig().fetch(300);
* ```
*
* @param expirationDurationSeconds Duration in seconds to cache the data for. To skip cache, use a duration of 0.
*/
fetch(expirationDurationSeconds?: number): Promise<void>;
/**
* Fetches the remote config data from Firebase, as defined in the dashboard.
* Once fetching is complete this method immediately calls activate and returns a boolean value true if new values were activated
*
* #### Example
*
* ```js
* // Fetch, cache for 5 minutes and activate
* const fetchedRemotely = await firebase.remoteConfig().fetchAndActivate();
*
* if (fetchedRemotely) {
* console.log('New configs were retrieved from the backend and activated.');
* } else {
* console.log('No new configs were fetched from the backend, and the local configs were already activated');
* }
* ```
*
*/
fetchAndActivate(): Promise<boolean>;
/**
* Returns all available config values.
*
* #### Example
*
* ```js
* const values = firebase.remoteConfig().getAll();
*
* Object.entries(values).forEach(($) => {
* const [key, entry] = $;
* console.log('Key: ', key);
* console.log('Source: ', entry.getSource());
* console.log('Value: ', entry.asString());
* });
* ```
*
*/
getAll(): ConfigValues;
/**
* Gets a ConfigValue by key.
*
* #### Example
*
* ```js
* const configValue = firebase.remoteConfig().getValue('experiment');
* console.log('Source: ', configValue.getSource());
* console.log('Value: ', configValue.asString());
* ```
*
* @param key A key used to retrieve a specific value.
*/
getValue(key: string): ConfigValue;
/**
* Gets a config property using the key and converts to a boolean value
*
* #### Example
*
* ```js
* // true or false depending on truthy or falsy nature of value
* const configValue = firebase.remoteConfig().getBoolean('experiment');
* ```
*
* @param key A key used to retrieve a specific value.
*/
getBoolean(key: string): boolean;
/**
* Gets a config property using the key and converts to a string value
*
* #### Example
*
* ```js
* // string value of 'experiment' property
* const configValue = firebase.remoteConfig().getString('experiment');
* ```
*
* @param key A key used to retrieve a specific value.
*/
getString(key: string): string;
/**
* Gets a config property using the key and converts to a number value. It
* will be 0 if the value is not a number.
*
* #### Example
*
* ```js
* // number value of 'experiment' property
* const configValue = firebase.remoteConfig().getNumber('experiment');
* ```
*
* @param key A key used to retrieve a specific value.
*/
getNumber(key: string): number;
/**
* Deletes all activated, fetched and defaults configs and resets all Firebase Remote Config settings.
* @android Android only - iOS returns Promise<null> but does not reset anything
*
* #### Example
*
* ```js
* await firebase.remoteConfig().reset();
* // get remote config values
* ```
*
*/
reset(): Promise<void>;
}
}
declare const defaultExport: ReactNativeFirebase.FirebaseModuleWithStatics<
FirebaseRemoteConfigTypes.Module,
FirebaseRemoteConfigTypes.Statics
>;
export const firebase: ReactNativeFirebase.Module & {
remoteConfig: typeof defaultExport;
app(
name?: string,
): ReactNativeFirebase.FirebaseApp & { remoteConfig(): FirebaseRemoteConfigTypes.Module };
};
type CallbackOrObserver<T extends (...args: any[]) => any> = T | { next: T };
type OnConfigUpdatedListenerCallback = (
event?: { updatedKeys: string[] },
error?: {
code: string;
message: string;
nativeErrorMessage: string;
},
) => void;
export default defaultExport;
export * from './modular';
/**
* Attach namespace to `firebase.` and `FirebaseApp.`.
*/
declare module '@react-native-firebase/app' {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
namespace ReactNativeFirebase {
import FirebaseModuleWithStatics = ReactNativeFirebase.FirebaseModuleWithStatics;
interface Module {
remoteConfig: FirebaseModuleWithStatics<
FirebaseRemoteConfigTypes.Module,
FirebaseRemoteConfigTypes.Statics
>;
}
interface FirebaseApp {
remoteConfig(): FirebaseRemoteConfigTypes.Module;
}
}
}