forked from EddyVerbruggen/nativescript-plugin-firebase
-
Notifications
You must be signed in to change notification settings - Fork 0
/
firebase.d.ts
675 lines (581 loc) · 18.1 KB
/
firebase.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
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
/**
* The allowed values for LoginOptions.type.
*/
export enum LoginType {
/**
* No further data is required.
*/
ANONYMOUS,
/**
* This requires you to pass in email and password properties as well.
*/
PASSWORD,
/**
* This requires you to pass either an authentication token generated by your backend server
* or the tokenProviderFn function that returns a promise to provide the token.
* See: https://firebase.google.com/docs/auth/server
*/
CUSTOM,
/**
* This requires you to setup Facebook Auth in the Firebase console,
* as well as uncommenting the SDK includes in include.gradle (Android) and Podfile (iOS).
*/
FACEBOOK,
/**
* This requires you to setup Google Sign In in the Firebase console,
* as well as uncommenting the SDK includes in include.gradle (Android) and Podfile (iOS).
*/
GOOGLE
}
/**
* The allowed values for QueryOptions.orderBy.type.
*/
export enum QueryOrderByType {
KEY,
VALUE,
CHILD,
PRIORITY
}
/**
* The allowed values for QueryOptions.range.type.
*/
export enum QueryRangeType {
START_AT,
END_AT,
EQUAL_TO
}
/**
* The allowed values for QueryOptions.limit.type.
*/
export enum QueryLimitType {
FIRST,
LAST
}
export enum ServerValue {
/**
* When for instance using setValue you can set a timestamp property to this placeholder value.
* Example:
* updateTs: firebase.ServerValue.TIMESTAMP
*/
TIMESTAMP
}
/**
* The options object passed into the init function.
*/
export interface InitOptions {
/**
* Allow disk persistence. Default false.
*/
persist?: boolean;
/**
* Get notified when the user is logged in.
*/
onAuthStateChanged?: (data: AuthStateData) => void;
/**
* Attempt to sign out before initializing, useful in case previous
* project token is cached which leads to following type of error:
* "[FirebaseDatabase] Authentication failed: invalid_token ..."
* Default false.
*/
iOSEmulatorFlush?: boolean;
/**
* For Firebase Storage you can pass in something like 'gs://n-plugin-test.appspot.com'
* here so we can cache it. Otherwise pass in the 'bucket' param when using Storage features.
* Can be found in the firebase console.
*/
storageBucket?: string;
/**
* For FCM either pass in this callback function here, or use addOnMessageReceivedCallback
*/
onPushTokenReceivedCallback?: (data: string) => void;
/**
* For FCM either pass in this callback function here, or use addOnPushTokenReceivedCallback
*/
onMessageReceivedCallback?: (data: Message) => void;
}
export interface QueryRangeOption {
type: QueryRangeType;
value: any;
}
/**
* The options object passed into the query function.
*/
export interface QueryOptions {
/**
* How you'd like to sort the query result.
*/
orderBy: {
type: QueryOrderByType;
/**
* mandatory when type is QueryOrderByType.CHILD
*/
value?: string;
};
/**
* You can further restrict the returned results by specifying restrictions.
* Need more than one range restriction? Use 'ranges' instead.
*/
range?: QueryRangeOption;
/**
* Same as 'range', but for a 'chain of ranges'.
* You can further restrict the returned results by specifying restrictions.
*/
ranges?: QueryRangeOption[];
/**
* You can limit the number of returned rows if you want to.
*/
limit?: {
type: QueryLimitType;
value: number;
};
/**
* Set this to true if you don't want to listen for any future updates,
* but just want to retrieve the current value.
* You can also use this to check if certain data is in the database.
* Default false.
*/
singleEvent?: boolean;
}
export interface GetAuthTokenOptions {
/**
* Default false.
*/
forceRefresh?: boolean;
}
export interface Provider {
id: string;
}
/**
* The options object passed into the login function.
*/
export interface LoginOptions {
type: LoginType;
email?: string;
password?: string;
/**
* The JSON Web Token (JWT) to use for authentication.
* Use with LoginType.CUSTOM
* See: https://firebase.google.com/docs/auth/server
*/
token?: string;
/**
* A function that returns a promise with the JSON Web Token (JWT) to use for authentication.
* Use with LoginType.CUSTOM
* See: https://firebase.google.com/docs/auth/server
*/
tokenProviderFn?: () => Promise<String>;
/**
* For Facebook auth. Default: ["public_profile", "email"]
*/
scope?: string[];
}
export interface ReauthenticateOptions {
type: LoginType;
email?: string;
password?: string;
}
/**
* The returned object from the login function.
*/
export interface User {
uid: string;
email?: string;
emailVerified: boolean;
name?: string;
anonymous: boolean;
providers: Array<Provider>;
profileImageURL?: string;
/** iOS only */
refreshToken?: string;
}
/**
* The returned object from the push function.
*/
export interface PushResult {
key: string;
}
/**
* The returned object from the addEventListener functions.
*/
export interface AddEventListenerResult {
path: string;
listeners: Array<any>
}
/**
* The returned object from the createUser function.
*/
export interface CreateUserResult {
key: string;
}
/**
* The options object passed into the createUser function.
*/
export interface CreateUserOptions {
email: string;
password: string;
}
/**
* The options object passed into the updateProfile function.
*/
export interface UpdateProfileOptions {
displayName?: string;
photoURL?: string;
}
/**
* The options object passed into the resetPassword function.
*/
export interface ResetPasswordOptions {
email: string;
}
/**
* The returned object in the callback handlers
* of the addChildEventListener and addValueEventListener functions.
*/
export interface FBData {
type: string;
key: string;
value: any;
}
/**
* The options object passed into the changePassword function.
*/
export interface ChangePasswordOptions {
email: string;
oldPassword: string;
newPassword: string
}
export interface AuthStateData {
loggedIn?: boolean;
user?: User;
}
export interface AuthStateChangeListener {
onAuthStateChanged: (data: AuthStateData) => void;
thisArg?: any;
}
export interface RemoteConfigProperty {
key: string;
default: any;
}
export interface GetRemoteConfigOptions {
/**
* Fetch new results from the server more often.
* Default false.
*/
developerMode?: boolean;
/**
* The number of seconds before retrieving fresh state from the server.
* Default 12 hours.
*/
cacheExpirationSeconds?: number;
/**
* The configuration properties to retrieve for your app. Specify as:
* properties: [{
* key: "holiday_promo_enabled",
* default: false
* }, ..]
*/
properties: Array<RemoteConfigProperty>
}
/**
* The returned object from the getRemoteConfig function.
*/
export interface GetRemoteConfigResult {
/**
* The date the data was last refreshed from the server.
* Should honor the 'cacheExpirationSeconds' you passed in previously.
*/
lastFetch: Date;
/**
* The result may be throttled when retrieved from the server.
* Even when the cache has expired. And it's just FYI really.
*/
throttled: boolean;
/**
* A JS Object with properties and values.
* If you previously requested keys ["foo", "is_enabled"] then this will be like:
* properties: {
* foo: "bar",
* is_enabled: true
* }
*/
properties: Object;
}
/**
* The returned object in the callback handler of the addOnMessageReceivedCallback function.
*
* Note that any custom data you send from your server will be available as
* key/value properties on the Message object as well.
*/
export interface Message {
/**
* Indicated whether or not the notification was received while the app was in the foreground.
*/
foreground: boolean;
/**
* The main text shown in the notificiation.
* Not available on Android when the notification was received in the background.
*/
body?: string;
/**
* Optional title, shown above the body in the notification.
* Not available on Android when the notification was received in the background.
*/
title?: string;
/**
* Any other data you may have added to the notification.
*/
data: any;
}
export interface ProgressStatus {
fractionCompleted: Number;
percentageCompleted: Number;
}
/**
* Use either the 'localFile' or 'localFullPath' param to upload a file.
*/
export interface UploadFileOptions {
/**
* If you didn't pass 'storageBucket' during init() you will need to do it now.
* Takes the form of 'gs://n-plugin-test.appspot.com' and can be found in the Firebase console.
*/
bucket?: string;
/**
* The full path of the file in your Firebase storage (folders will be created)
* Example: 'uploads/images/telerik-logo-uploaded.png'
*/
remoteFullPath: string;
/**
* Option 1: a file-system module File object
* Example:
* var fs = require("file-system");
* fs.File.fromPath("path-to-the-file")
*/
localFile?: any;
/**
* Option 2: a full file path (ignored if 'localFile' is set)
*/
localFullPath?: string;
/**
* You can get updates during upload by passing a function, example:
*
* onProgress: function(status) {
* console.log("Uploaded fraction: " + status.fractionCompleted);
* console.log("Percentage complete: " + status.percentageCompleted);
* }
*/
onProgress: (data: ProgressStatus) => void;
}
export interface UploadFileResult {
}
export interface DownloadFileOptions {
/**
* If you didn't pass 'storageBucket' during init() you will need to do it now.
* Takes the form of 'gs://n-plugin-test.appspot.com' and can be found in the Firebase console.
*/
bucket?: string;
/**
* The full path of an existing file in your Firebase storage
* Example: 'uploads/images/telerik-logo-uploaded.png'
*/
remoteFullPath: string;
/**
* Option 1: a file-system module File object
* Example:
* var fs = require("file-system");
* fs.File.fromPath("path-to-the-file")
*/
localFile?: any;
/**
* Option 2: a full file path (ignored if 'localFile' is set)
*/
localFullPath?: string
}
export interface GetDownloadUrlOptions {
/**
* If you didn't pass 'storageBucket' during init() you will need to do it now.
* Takes the form of 'gs://n-plugin-test.appspot.com' and can be found in the Firebase console.
*/
bucket?: string;
/**
* The full path of an existing file in your Firebase storage
* Example: 'uploads/images/telerik-logo-uploaded.png'
*/
remoteFullPath: string;
}
export interface DeleteFileOptions {
/**
* If you didn't pass 'storageBucket' during init() you will need to do it now.
* Takes the form of 'gs://n-plugin-test.appspot.com' and can be found in the Firebase console.
*/
bucket?: string;
/**
* The full path of an existing file in your Firebase storage
* Example: 'uploads/images/telerik-logo-uploaded.png'
*/
remoteFullPath: string;
}
export interface SendCrashLogOptions {
/**
* Any custom logging you want to send to Firebase.
*/
message: string;
/**
* Also log to the device console. Default false.
*/
showInConsole: boolean;
}
export function init(options?: InitOptions): Promise<any>;
// Database
export function push(path: string, value: any): Promise<PushResult>;
export function setValue(path: string, value: any): Promise<any>;
export function update(path: string, value: any): Promise<any>;
export function remove(path: string): Promise<any>;
export function query(onValueEvent: (data: FBData) => void, path: string, options: QueryOptions): Promise<any>;
export function addChildEventListener(onChildEvent: (data: FBData) => void, path: string): Promise<AddEventListenerResult>;
export function addValueEventListener(onValueEvent: (data: FBData) => void, path: string): Promise<AddEventListenerResult>;
export function removeEventListeners(listeners: Array<any>, path: string): Promise<any>;
/**
* Tells the client to keep its local cache in sync with the server automatically.
*/
export function keepInSync(path: string, switchOn: boolean): Promise<any>;
// AdMob, nicely grouped in its own module
export module admob {
/**
* The allowed values for AD_SIZE.
*/
export enum AD_SIZE {
SMART_BANNER,
LARGE_BANNER,
BANNER,
MEDIUM_RECTANGLE,
FULL_BANNER,
LEADERBOARD
}
export interface ShowBannerOptions {
/**
* The layout of the banner.
* Default AD_SIZE.SMART_BANNER
*/
size?: AD_SIZE;
/**
* When false (default) you'll get real banners.
*/
testing?: boolean;
/**
* Something like "ca-app-pub-AAAAAAAA/BBBBBBB".
*/
androidBannerId?: string;
/**
* Something like "ca-app-pub-XXXXXX/YYYYYY".
*/
iosBannerId?: string;
/**
* If testing is true, the simulator is allowed to receive test banners.
* Android automatically add the connceted device as test device, but iOS does not.
* If you also want to test on real devices, add it here like this:
* ["ce97330130c9047ce0d4430d37d713b1", ".."]
*/
iosTestDeviceIds?: string[];
/**
* The number of pixels from the top/bottom of the view.
* The plugin corrects for display density, so don't worry about that.
*
* If both are set, top wins.
*/
margins?: {
/**
* Default: -1 (ignored).
*/
top?: number;
/**
* Default: -1 (ignored).
*/
bottom?: number;
}
}
export interface ShowInterstitialOptions {
/**
* When false (default) you'll get real banners.
*/
testing?: boolean;
/**
* Something like "ca-app-pub-AAAAAAAA/BBBBBBB".
*/
androidInterstitialId?: string;
/**
* Something like "ca-app-pub-XXXXXX/YYYYYY".
*/
iosInterstitialId?: string;
/**
* If testing is true, the simulator is allowed to receive test banners.
* Android automatically add the connceted device as test device, but iOS does not.
* If you also want to test on real devices, add it here like this:
* ["ce97330130c9047ce0d4430d37d713b1", ".."]
*/
iosTestDeviceIds?: string[];
}
function showBanner(options: ShowBannerOptions): Promise<any>;
function showInterstitial(options: ShowInterstitialOptions): Promise<any>;
function hideBanner(): Promise<any>;
}
// Analytics, nicely grouped in its own module
export module analytics {
export interface LogEventParameter {
key: string;
value: string;
}
export interface LogEventOptions {
/**
* The name of the event. You can use any name, but it's recommended to use one of
* the predefined constants. These values are the same for both iOS and Android, so
* for the complete list see https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Event.html
*/
key: string;
/**
* Each (predefined) event has its own set of optional parameters, see
* https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Param
* Example:
*
* parameters: [{
* key: "item_name",
* value: "abc"
* }, ..]
*/
parameters?: Array<LogEventParameter>
}
export interface SetUserPropertyOptions {
key: string;
value: string;
}
function logEvent(options: LogEventOptions): Promise<any>;
function setUserProperty(options: SetUserPropertyOptions): Promise<any>;
}
// Auth
export function login(options: LoginOptions): Promise<User>;
export function reauthenticate(options: ReauthenticateOptions): Promise<any>;
export function getAuthToken(option: GetAuthTokenOptions): Promise<string>;
export function logout(): Promise<any>;
export function sendEmailVerification(): Promise<any>;
export function createUser(options: CreateUserOptions): Promise<CreateUserResult>;
export function deleteUser(): Promise<any>;
export function updateProfile(options: UpdateProfileOptions): Promise<any>;
export function resetPassword(options: ResetPasswordOptions): Promise<any>;
export function changePassword(options: ChangePasswordOptions): Promise<any>;
export function addAuthStateListener(listener: AuthStateChangeListener): boolean;
export function removeAuthStateListener(listener: AuthStateChangeListener): boolean;
export function hasAuthStateListener(listener: AuthStateChangeListener): boolean;
export function getCurrentUser(): Promise<User>;
// FCM
export function addOnMessageReceivedCallback(onMessageReceived: (data: Message) => void): Promise<any>;
export function addOnPushTokenReceivedCallback(onPushTokenReceived: (data: string) => void): Promise<any>;
// remote config
export function getRemoteConfig(options: GetRemoteConfigOptions): Promise<GetRemoteConfigResult>;
// storage
export function uploadFile(options: UploadFileOptions): Promise<UploadFileResult>;
export function downloadFile(options: DownloadFileOptions): Promise<any>;
export function getDownloadUrl(options: GetDownloadUrlOptions): Promise<string>;
export function deleteFile(options: DeleteFileOptions): Promise<any>;
export function subscribeToTopic(topicName): Promise<any>;
export function unsubscribeFromTopic(topicName): Promise<any>;
// crash logging
export function sendCrashLog(options: SendCrashLogOptions): Promise<any>;