-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
Copy pathRNFBAuthModule.js
1077 lines (953 loc) · 32.3 KB
/
RNFBAuthModule.js
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
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import {
getApp,
initializeAuth,
getReactNativePersistence,
onAuthStateChanged,
onIdTokenChanged,
signInAnonymously,
sendSignInLinkToEmail,
getAdditionalUserInfo,
multiFactor,
createUserWithEmailAndPassword,
signInWithEmailAndPassword,
isSignInWithEmailLink,
signInWithEmailLink,
signInWithCustomToken,
sendPasswordResetEmail,
useDeviceLanguage,
verifyPasswordResetCode,
connectAuthEmulator,
fetchSignInMethodsForEmail,
sendEmailVerification,
verifyBeforeUpdateEmail,
confirmPasswordReset,
updateEmail,
updatePassword,
updateProfile,
updatePhoneNumber,
signInWithCredential,
unlink,
linkWithCredential,
reauthenticateWithCredential,
getIdToken,
getIdTokenResult,
applyActionCode,
checkActionCode,
EmailAuthProvider,
FacebookAuthProvider,
GoogleAuthProvider,
TwitterAuthProvider,
GithubAuthProvider,
PhoneAuthProvider,
OAuthProvider,
} from '@react-native-firebase/app/lib/internal/web/firebaseAuth';
import { guard, getWebError, emitEvent } from '@react-native-firebase/app/lib/internal/web/utils';
import {
getReactNativeAsyncStorageInternal,
isMemoryStorage,
} from '@react-native-firebase/app/lib/internal/asyncStorage';
/**
* Resolves or rejects an auth method promise without a user (user was missing).
* @param {boolean} isError whether to reject the promise.
* @returns {Promise<void>} - Void promise.
*/
function promiseNoUser(isError = false) {
if (isError) {
return rejectPromiseWithCodeAndMessage('no-current-user', 'No user currently signed in.');
}
// TODO(ehesp): Should this be null, or undefined?
return Promise.resolve(null);
}
/**
* Returns a structured error object.
* @param {string} code - The error code.
* @param {string} message - The error message.
*/
function rejectPromiseWithCodeAndMessage(code, message) {
return rejectPromise(getWebError({ code: `auth/${code}`, message }));
}
/**
* Returns a structured error object.
* @param {error} error The error object.
* @returns {never}
*/
function rejectPromise(error) {
const { code, message, details } = error;
const nativeError = {
code,
message,
userInfo: {
code: code ? code.replace('auth/', '') : 'unknown',
message,
details,
},
};
return Promise.reject(nativeError);
}
/**
* Converts a user object to a plain object.
* @param {User} user - The User object to convert.
* @returns {object}
*/
function userToObject(user) {
return {
...userInfoToObject(user),
emailVerified: user.emailVerified,
isAnonymous: user.isAnonymous,
tenantId: user.tenantId !== null && user.tenantId !== '' ? user.tenantId : null,
providerData: user.providerData.map(userInfoToObject),
metadata: userMetadataToObject(user.metadata),
multiFactor: multiFactor(user).enrolledFactors.map(multiFactorInfoToObject),
};
}
/**
* Returns an AuthCredential object for the given provider.
* @param {Auth} auth - The Auth instance to use.
* @param {string} provider - The provider to get the credential for.
* @param {string} token - The token to use for the credential.
* @param {string|null} secret - The secret to use for the credential.
* @returns {AuthCredential|null} - The AuthCredential object.
*/
function getAuthCredential(_auth, provider, token, secret) {
if (provider.startsWith('oidc.')) {
return new OAuthProvider(provider).credential({
idToken: token,
});
}
switch (provider) {
case 'facebook.com':
return FacebookAuthProvider().credential(token);
case 'google.com':
return GoogleAuthProvider().credential(token, secret);
case 'twitter.com':
return TwitterAuthProvider().credential(token, secret);
case 'github.com':
return GithubAuthProvider().credential(token);
case 'apple.com':
return new OAuthProvider(provider).credential({
idToken: token,
rawNonce: secret,
});
case 'oauth':
return OAuthProvider(provider).credential({
idToken: token,
accessToken: secret,
});
case 'phone':
return PhoneAuthProvider.credential(token, secret);
case 'password':
return EmailAuthProvider.credential(token, secret);
case 'emailLink':
return EmailAuthProvider.credentialWithLink(token, secret);
default:
return null;
}
}
/**
* Converts a user info object to a plain object.
* @param {UserInfo} userInfo - The UserInfo object to convert.
*/
function userInfoToObject(userInfo) {
return {
providerId: userInfo.providerId,
uid: userInfo.uid,
displayName:
userInfo.displayName !== null && userInfo.displayName !== '' ? userInfo.displayName : null,
email: userInfo.email !== null && userInfo.email !== '' ? userInfo.email : null,
photoURL: userInfo.photoURL !== null && userInfo.photoURL !== '' ? userInfo.photoURL : null,
phoneNumber:
userInfo.phoneNumber !== null && userInfo.phoneNumber !== '' ? userInfo.phoneNumber : null,
};
}
/**
* Converts a user metadata object to a plain object.
* @param {UserMetadata} metadata - The UserMetadata object to convert.
*/
function userMetadataToObject(metadata) {
return {
creationTime: metadata.creationTime ? new Date(metadata.creationTime).toISOString() : null,
lastSignInTime: metadata.lastSignInTime
? new Date(metadata.lastSignInTime).toISOString()
: null,
};
}
/**
* Converts a MultiFactorInfo object to a plain object.
* @param {MultiFactorInfo} multiFactorInfo - The MultiFactorInfo object to convert.
*/
function multiFactorInfoToObject(multiFactorInfo) {
const obj = {
displayName: multiFactorInfo.displayName,
enrollmentTime: multiFactorInfo.enrollmentTime,
factorId: multiFactorInfo.factorId,
uid: multiFactorInfo.uid,
};
// If https://firebase.google.com/docs/reference/js/auth.phonemultifactorinfo
if ('phoneNumber' in multiFactorInfo) {
obj.phoneNumber = multiFactorInfo.phoneNumber;
}
return obj;
}
/**
* Converts a user credential object to a plain object.
* @param {UserCredential} userCredential - The user credential object to convert.
*/
function authResultToObject(userCredential) {
const additional = getAdditionalUserInfo(userCredential);
return {
user: userToObject(userCredential.user),
additionalUserInfo: {
isNewUser: additional.isNewUser,
profile: additional.profile,
providerId: additional.providerId,
username: additional.username,
},
};
}
const instances = {};
const authStateListeners = {};
const idTokenListeners = {};
const sessionMap = new Map();
let sessionId = 0;
// Returns a cached Firestore instance.
function getCachedAuthInstance(appName) {
if (!instances[appName]) {
if (!isMemoryStorage()) {
// Warn auth persistence is is disabled unless Async Storage implementation is provided.
// eslint-disable-next-line no-console
console.warn(
```
Firebase Auth persistence is disabled. To enable persistence, provide an Async Storage implementation.
For example, to use React Native Async Storage:
import AsyncStorage from '@react-native-async-storage/async-storage';
// Before initializing Firebase set the Async Storage implementation
// that will be used to persist user sessions.
firebase.setReactNativeAsyncStorage(AsyncStorage);
// Then initialize Firebase as normal.
await firebase.initializeApp({ ... });
```,
);
}
instances[appName] = initializeAuth(getApp(appName), {
persistence: getReactNativePersistence(getReactNativeAsyncStorageInternal()),
});
}
return instances[appName];
}
// getConstants
const CONSTANTS = {
APP_LANGUAGE: {},
APP_USER: {},
};
// Not required for web, since it's dynamic initialization
// and we are not making instances of auth based on apps that already exist
// since there are none that exist before we initialize them in our code below.
// for (const appName of getApps()) {
// const instance = getAuth(getApp(appName));
// CONSTANTS.APP_LANGUAGE[appName] = instance.languageCode;
// if (instance.currentUser) {
// CONSTANTS.APP_USER[appName] = userToObject(instance.currentUser);
// }
// }
/**
* This is a 'NativeModule' for the web platform.
* Methods here are identical to the ones found in
* the native android/ios modules e.g. `@ReactMethod` annotated
* java methods on Android.
*/
export default {
// Expose all the constants.
...CONSTANTS,
async useUserAccessGroup() {
// noop
},
configureAuthDomain() {
return rejectPromiseWithCodeAndMessage(
'unsupported',
'This operation is not supported in this environment.',
);
},
async getCustomAuthDomain() {
return rejectPromiseWithCodeAndMessage(
'unsupported',
'This operation is not supported in this environment.',
);
},
/**
* Create a new auth state listener instance for a given app.
* @param {string} appName - The name of the app to get the auth instance for.
* @returns {Promise<void>} - Void promise.
*/
addAuthStateListener(appName) {
if (authStateListeners[appName]) {
return;
}
return guard(async () => {
const auth = getCachedAuthInstance(appName);
authStateListeners[appName] = onAuthStateChanged(auth, user => {
emitEvent('auth_state_changed', {
appName,
user: user ? userToObject(user) : null,
});
});
});
},
/**
* Remove an auth state listener instance for a given app.
* @param {string} appName - The name of the app to get the auth instance for.
* @returns {Promise<void>} - Void promise.
*/
removeAuthStateListener(appName) {
if (authStateListeners[appName]) {
authStateListeners[appName]();
delete authStateListeners[appName];
}
},
/**
* Create a new ID token listener instance for a given app.
* @param {string} appName - The name of the app to get the auth instance for.
* @returns {Promise<void>} - Void promise.
*/
addIdTokenListener(appName) {
if (idTokenListeners[appName]) {
return;
}
return guard(async () => {
const auth = getCachedAuthInstance(appName);
idTokenListeners[appName] = onIdTokenChanged(auth, user => {
emitEvent('auth_id_token_changed', {
authenticated: !!user,
appName,
user: user ? userToObject(user) : null,
});
});
});
},
/**
* Remove an ID token listener instance for a given app.
* @param {string} appName - The name of the app to get the auth instance for.
* @returns {Promise<void>} - Void promise.
*/
removeIdTokenListener(appName) {
if (idTokenListeners[appName]) {
idTokenListeners[appName]();
delete idTokenListeners[appName];
}
},
async forceRecaptchaFlowForTesting() {
return rejectPromiseWithCodeAndMessage(
'unsupported',
'This operation is not supported in this environment.',
);
},
async setAutoRetrievedSmsCodeForPhoneNumber() {
return rejectPromiseWithCodeAndMessage(
'unsupported',
'This operation is not supported in this environment.',
);
},
async setAppVerificationDisabledForTesting() {
return rejectPromiseWithCodeAndMessage(
'unsupported',
'This operation is not supported in this environment.',
);
},
/**
* Sign out the current user.
* @param {string} appName - The name of the app to get the auth instance for.
* @returns {Promise<void>} - Void promise.
*/
signOut(appName) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
if (auth.currentUser === null) {
return promiseNoUser(true);
}
await auth.signOut();
return promiseNoUser();
});
},
/**
* Sign in anonymously.
* @param {*} appName - The name of the app to get the auth instance for.
* @returns
*/
signInAnonymously(appName) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
const credential = await signInAnonymously(auth);
return authResultToObject(credential);
});
},
/**
* Sign in with email and password.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {string} email - The email to sign in with.
* @param {string} password - The password to sign in with.
* @returns {Promise<object>} - The result of the sign in.
*/
async createUserWithEmailAndPassword(appName, email, password) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
const credential = await createUserWithEmailAndPassword(auth, email, password);
return authResultToObject(credential);
});
},
/**
* Sign in with email and password.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {string} email - The email to sign in with.
* @param {string} password - The password to sign in with.
* @returns {Promise<object>} - The result of the sign in.
*/
async signInWithEmailAndPassword(appName, email, password) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
const credential = await signInWithEmailAndPassword(auth, email, password);
return authResultToObject(credential);
});
},
/**
* Check if a sign in with email link is valid
* @param {string} appName - The name of the app to get the auth instance for.
* @param {string} emailLink - The email link to sign in with.
* @returns {Promise<boolean>} - Whether the link is a valid sign in with email link.
*/
async isSignInWithEmailLink(appName, emailLink) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
return await isSignInWithEmailLink(auth, emailLink);
});
},
/**
* Sign in with email link.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {string} email - The email to sign in with.
* @param {string} emailLink - The email link to sign in with.
* @returns {Promise<object>} - The result of the sign in.
*/
async signInWithEmailLink(appName, email, emailLink) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
const credential = await signInWithEmailLink(auth, email, emailLink);
return authResultToObject(credential);
});
},
/**
* Sign in with a custom token.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {string} token - The token to sign in with.
* @returns {Promise<object>} - The result of the sign in.
*/
async signInWithCustomToken(appName, token) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
const credential = await signInWithCustomToken(auth, token);
return authResultToObject(credential);
});
},
/**
* Not implemented on web.
*/
async revokeToken() {
return promiseNoUser();
},
/**
* Send a password reset email.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {string} email - The email to send the password reset email to.
* @param {ActionCodeSettings} settings - The settings to use for the password reset email.
* @returns {Promise<null>}
*/
async sendPasswordResetEmail(appName, email, settings) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
await sendPasswordResetEmail(auth, email, settings);
return promiseNoUser();
});
},
/**
* Send a sign in link to an email.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {string} email - The email to send the password reset email to.
* @param {ActionCodeSettings} settings - The settings to use for the password reset email.
* @returns {Promise<null>}
*/
async sendSignInLinkToEmail(appName, email, settings) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
await sendSignInLinkToEmail(auth, email, settings);
return promiseNoUser();
});
},
/* ----------------------
* .currentUser methods
* ---------------------- */
/**
* Delete the current user.
* @param {string} appName - The name of the app to get the auth instance for.
* @returns {Promise<null>}
*/
async delete(appName) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
if (auth.currentUser === null) {
return promiseNoUser(true);
}
await auth.currentUser.delete();
return promiseNoUser();
});
},
/**
* Reload the current user.
* @param {string} appName - The name of the app to get the auth instance for.
* @returns {Promise<object>} - The current user object.
*/
async reload(appName) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
if (auth.currentUser === null) {
return promiseNoUser(true);
}
await auth.currentUser.reload();
return userToObject(auth.currentUser);
});
},
/**
* Send a verification email to the current user.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {ActionCodeSettings} actionCodeSettings - The settings to use for the email verification.
* @returns {Promise<object>} - The current user object.
*/
async sendEmailVerification(appName, actionCodeSettings) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
if (auth.currentUser === null) {
return promiseNoUser(true);
}
await sendEmailVerification(auth.currentUser, actionCodeSettings);
return userToObject(auth.currentUser);
});
},
/**
* Verify the email before updating it.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {string} email - The email to verify.
* @param {ActionCodeSettings} actionCodeSettings - The settings to use for the email verification.
* @returns {Promise<object>} - The current user object.
*/
async verifyBeforeUpdateEmail(appName, email, actionCodeSettings) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
if (auth.currentUser === null) {
return promiseNoUser(true);
}
await verifyBeforeUpdateEmail(auth.currentUser, email, actionCodeSettings);
return userToObject(auth.currentUser);
});
},
/**
* Update the current user's email.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {string} email - The email to update.
* @returns {Promise<object>} - The current user object.
*/
async updateEmail(appName, email) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
if (auth.currentUser === null) {
return promiseNoUser(true);
}
await updateEmail(auth.currentUser, email);
return userToObject(auth.currentUser);
});
},
/**
* Update the current user's password.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {string} password - The password to update.
* @returns {Promise<object>} - The current user object.
*/
async updatePassword(appName, password) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
if (auth.currentUser === null) {
return promiseNoUser(true);
}
await updatePassword(auth.currentUser, password);
return userToObject(auth.currentUser);
});
},
/**
* Update the current user's phone number.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {string} provider - The provider to update the phone number with.
* @param {string} authToken - The auth token to update the phone number with.
* @param {string} authSecret - The auth secret to update the phone number with.
* @returns {Promise<object>} - The current user object.
*/
async updatePhoneNumber(appName, provider, authToken, authSecret) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
if (auth.currentUser === null) {
return promiseNoUser(true);
}
if (provider !== 'phone') {
return rejectPromiseWithCodeAndMessage(
'invalid-credential',
'The supplied auth credential does not have a phone provider.',
);
}
const credential = getAuthCredential(auth, provider, authToken, authSecret);
if (!credential) {
return rejectPromiseWithCodeAndMessage(
'invalid-credential',
'The supplied auth credential is malformed, has expired or is not currently supported.',
);
}
await updatePhoneNumber(auth.currentUser, credential);
return userToObject(auth.currentUser);
});
},
/**
* Update the current user's profile.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {object} props - The properties to update.
* @returns {Promise<object>} - The current user object.
*/
async updateProfile(appName, props) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
if (auth.currentUser === null) {
return promiseNoUser(true);
}
await updateProfile(auth.currentUser, {
displayName: props.displayName,
photoURL: props.photoURL,
});
return userToObject(auth.currentUser);
});
},
/**
* Sign in with a credential.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {string} provider - The provider to sign in with.
* @param {string} authToken - The auth token to sign in with.
* @param {string} authSecret - The auth secret to sign in with.
* @returns {Promise<object>} - The result of the sign in.
*/
async signInWithCredential(appName, provider, authToken, authSecret) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
const credential = getAuthCredential(auth, provider, authToken, authSecret);
if (credential === null) {
return rejectPromiseWithCodeAndMessage(
'invalid-credential',
'The supplied auth credential is malformed, has expired or is not currently supported.',
);
}
const credentialResult = await signInWithCredential(auth, credential);
return authResultToObject(credentialResult);
});
},
async signInWithProvider() {
return rejectPromiseWithCodeAndMessage(
'unsupported',
'This operation is not supported in this environment.',
);
},
async signInWithPhoneNumber() {
return rejectPromiseWithCodeAndMessage(
'unsupported',
'This operation is not supported in this environment.',
);
},
/**
* Get a multi-factor session.
* @param {string} appName - The name of the app to get the auth instance for.
* @returns {Promise<string>} - The session ID.
*/
async getSession(appName) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
if (auth.currentUser === null) {
return promiseNoUser(true);
}
const session = await multiFactor(auth.currentUser).getSession();
// Increment the session ID.
sessionId++;
const key = `${sessionId}`;
sessionMap.set(key, session);
return key;
});
},
verifyPhoneNumberForMultiFactor() {
return rejectPromiseWithCodeAndMessage(
'unsupported',
'This operation is not supported in this environment.',
);
},
finalizeMultiFactorEnrollment() {
return rejectPromiseWithCodeAndMessage(
'unsupported',
'This operation is not supported in this environment.',
);
},
resolveMultiFactorSignIn() {
return rejectPromiseWithCodeAndMessage(
'unsupported',
'This operation is not supported in this environment.',
);
},
confirmationResultConfirm() {
return rejectPromiseWithCodeAndMessage(
'unsupported',
'This operation is not supported in this environment.',
);
},
verifyPhoneNumber() {
return rejectPromiseWithCodeAndMessage(
'unsupported',
'This operation is not supported in this environment.',
);
},
/**
* Confirm the password reset code.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {string} code - The code to confirm.
* @param {string} newPassword - The new password to set.
* @returns {Promise<null>}
*/
async confirmPasswordReset(appName, code, newPassword) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
await confirmPasswordReset(auth, code, newPassword);
return promiseNoUser();
});
},
/**
* Apply an action code.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {string} code - The code to apply.
* @returns {Promise<void>} - Void promise.
*/
async applyActionCode(appName, code) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
await applyActionCode(auth, code);
});
},
/**
* Check an action code.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {string} code - The code to check.
* @returns {Promise<object>} - The result of the check.
*/
async checkActionCode(appName, code) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
const result = await checkActionCode(auth, code);
return {
operation: result.operation,
data: {
email: result.data.email,
fromEmail: result.data.previousEmail,
// multiFactorInfo - not implemented
},
};
});
},
/**
* Link a credential to the current user.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {string} provider - The provider to link.
* @param {string} authToken - The auth token to link.
* @param {string} authSecret - The auth secret to link.
* @returns {Promise<object>} - The current user object.
*/
async linkWithCredential(appName, provider, authToken, authSecret) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
const credential = getAuthCredential(auth, provider, authToken, authSecret);
if (credential === null) {
return rejectPromiseWithCodeAndMessage(
'invalid-credential',
'The supplied auth credential is malformed, has expired or is not currently supported.',
);
}
if (auth.currentUser === null) {
return promiseNoUser(true);
}
return authResultToObject(await linkWithCredential(auth.currentUser, credential));
});
},
async linkWithProvider() {
// TODO: We could check if window is available here, but for now it's not supported.
return rejectPromiseWithCodeAndMessage(
'unsupported',
'This operation is not supported in this environment.',
);
},
/**
* Unlink a provider from the current user.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {string} providerId - The provider ID to unlink.
* @returns {Promise<object>} - The current user object.
*/
async unlink(appName, providerId) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
if (auth.currentUser === null) {
return promiseNoUser(true);
}
const user = await unlink(auth.currentUser, providerId);
return userToObject(user);
});
},
/**
* Reauthenticate with a credential.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {string} provider - The provider to reauthenticate with.
* @param {string} authToken - The auth token to reauthenticate with.
* @param {string} authSecret - The auth secret to reauthenticate with.
* @returns {Promise<object>} - The current user object.
*/
async reauthenticateWithCredential(appName, provider, authToken, authSecret) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
const credential = getAuthCredential(auth, provider, authToken, authSecret);
if (credential === null) {
return rejectPromiseWithCodeAndMessage(
'invalid-credential',
'The supplied auth credential is malformed, has expired or is not currently supported.',
);
}
if (auth.currentUser === null) {
return promiseNoUser(true);
}
return authResultToObject(await reauthenticateWithCredential(auth.currentUser, credential));
});
},
async reauthenticateWithProvider() {
// TODO: We could check if window is available here, but for now it's not supported.
return rejectPromiseWithCodeAndMessage(
'unsupported',
'This operation is not supported in this environment.',
);
},
/**
* Get the ID token for the current user.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {boolean} forceRefresh - Whether to force a token refresh.
* @returns {Promise<string>} - The ID token.
*/
async getIdToken(appName, forceRefresh) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
if (auth.currentUser === null) {
return promiseNoUser(true);
}
const token = await getIdToken(auth.currentUser, forceRefresh);
return token;
});
},
/**
* Get the ID token result for the current user.
* @param {string} appName - The name of the app to get the auth instance for.
* @param {boolean} forceRefresh - Whether to force a token refresh.
* @returns {Promise<object>} - The ID token result.
*/
async getIdTokenResult(appName, forceRefresh) {
return guard(async () => {
const auth = getCachedAuthInstance(appName);
if (auth.currentUser === null) {
return promiseNoUser(true);
}
const result = await getIdTokenResult(auth.currentUser, forceRefresh);
// TODO(ehesp): Result looks expected, might be safer to keep fixed object?
return {
authTime: result.authTime,
expirationTime: result.expirationTime,
issuedAtTime: result.issuedAtTime,
claims: result.claims,
signInProvider: result.signInProvider,
token: result.token,
};
});
},
/* ----------------------
* other methods
* ---------------------- */
/**