Skip to content

Commit b574873

Browse files
authored
Export public types from auth-exp (#4362)
1 parent 7ca7f4e commit b574873

File tree

3 files changed

+195
-3
lines changed

3 files changed

+195
-3
lines changed

common/api-review/auth-exp.api.md

+109-1
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,57 @@
44
55
```ts
66

7+
import { ActionCodeInfo } from '@firebase/auth-types-exp';
8+
import { ActionCodeOperation } from '@firebase/auth-types-exp';
9+
import { ActionCodeSettings } from '@firebase/auth-types-exp';
10+
import { AdditionalUserInfo } from '@firebase/auth-types-exp';
11+
import { ApplicationVerifier } from '@firebase/auth-types-exp';
712
import { Auth } from '@firebase/auth-types-exp';
13+
import { AuthError } from '@firebase/auth-types-exp';
14+
import { AuthErrorMap } from '@firebase/auth-types-exp';
15+
import { AuthProvider } from '@firebase/auth-types-exp';
16+
import { AuthSettings } from '@firebase/auth-types-exp';
817
import { CompleteFn } from '@firebase/util';
18+
import { Config } from '@firebase/auth-types-exp';
19+
import { ConfirmationResult } from '@firebase/auth-types-exp';
920
import { ErrorFactory } from '@firebase/util';
1021
import { ErrorFn } from '@firebase/util';
1122
import * as externs from '@firebase/auth-types-exp';
23+
import { FactorId } from '@firebase/auth-types-exp';
1224
import { FirebaseApp } from '@firebase/app-types-exp';
1325
import { FirebaseError } from '@firebase/util';
26+
import { IdTokenResult } from '@firebase/auth-types-exp';
27+
import { MultiFactorAssertion } from '@firebase/auth-types-exp';
28+
import { MultiFactorError } from '@firebase/auth-types-exp';
29+
import { MultiFactorInfo } from '@firebase/auth-types-exp';
30+
import { MultiFactorResolver } from '@firebase/auth-types-exp';
31+
import { MultiFactorSession } from '@firebase/auth-types-exp';
32+
import { MultiFactorUser } from '@firebase/auth-types-exp';
1433
import { NextFn } from '@firebase/util';
34+
import { OperationType } from '@firebase/auth-types-exp';
35+
import { ParsedToken } from '@firebase/auth-types-exp';
36+
import { Persistence } from '@firebase/auth-types-exp';
37+
import { PhoneInfoOptions } from '@firebase/auth-types-exp';
38+
import { PhoneMultiFactorAssertion } from '@firebase/auth-types-exp';
39+
import { PhoneMultiFactorEnrollInfoOptions } from '@firebase/auth-types-exp';
40+
import { PhoneMultiFactorSignInInfoOptions } from '@firebase/auth-types-exp';
41+
import { PhoneSingleFactorInfoOptions } from '@firebase/auth-types-exp';
42+
import { PopupRedirectResolver } from '@firebase/auth-types-exp';
1543
import { ProviderId } from '@firebase/auth-types-exp';
44+
import { ReactNativeAsyncStorage } from '@firebase/auth-types-exp';
45+
import { SignInMethod } from '@firebase/auth-types-exp';
1646
import { Unsubscribe } from '@firebase/util';
47+
import { User } from '@firebase/auth-types-exp';
1748
import { UserCredential } from '@firebase/auth-types-exp';
49+
import { UserInfo } from '@firebase/auth-types-exp';
50+
import { UserMetadata } from '@firebase/auth-types-exp';
51+
import { UserProfile } from '@firebase/auth-types-exp';
52+
53+
export { ActionCodeInfo }
54+
55+
export { ActionCodeOperation }
56+
57+
export { ActionCodeSettings }
1858

1959
// @public (undocumented)
2060
export class ActionCodeURL implements externs.ActionCodeURL {
@@ -36,9 +76,15 @@ export class ActionCodeURL implements externs.ActionCodeURL {
3676
readonly tenantId: string | null;
3777
}
3878

79+
export { AdditionalUserInfo }
80+
81+
export { ApplicationVerifier }
82+
3983
// @public
4084
export function applyActionCode(auth: externs.Auth, oobCode: string): Promise<void>;
4185

86+
export { Auth }
87+
4288
// @public (undocumented)
4389
export class AuthCredential {
4490
// @internal
@@ -62,6 +108,14 @@ export class AuthCredential {
62108
toJSON(): object;
63109
}
64110

111+
export { AuthError }
112+
113+
export { AuthErrorMap }
114+
115+
export { AuthProvider }
116+
117+
export { AuthSettings }
118+
65119
// @public
66120
export const browserLocalPersistence: externs.Persistence;
67121

@@ -74,6 +128,10 @@ export const browserSessionPersistence: externs.Persistence;
74128
// @public
75129
export function checkActionCode(auth: externs.Auth, oobCode: string): Promise<externs.ActionCodeInfo>;
76130

131+
export { Config }
132+
133+
export { ConfirmationResult }
134+
77135
// @public
78136
export function confirmPasswordReset(auth: externs.Auth, oobCode: string, newPassword: string): Promise<void>;
79137

@@ -139,6 +197,8 @@ export class FacebookAuthProvider extends OAuthProvider {
139197
static readonly PROVIDER_ID = externs.ProviderId.FACEBOOK;
140198
}
141199

200+
export { FactorId }
201+
142202
// @public
143203
export function fetchSignInMethodsForEmail(auth: externs.Auth, email: string): Promise<string[]>;
144204

@@ -180,6 +240,8 @@ export class GoogleAuthProvider extends OAuthProvider {
180240
static readonly PROVIDER_ID = externs.ProviderId.GOOGLE;
181241
}
182242

243+
export { IdTokenResult }
244+
183245
// @public
184246
export const indexedDBLocalPersistence: externs.Persistence;
185247

@@ -209,6 +271,18 @@ export function linkWithRedirect(user: externs.User, provider: externs.AuthProvi
209271
// @public
210272
export function multiFactor(user: externs.User): externs.MultiFactorUser;
211273

274+
export { MultiFactorAssertion }
275+
276+
export { MultiFactorError }
277+
278+
export { MultiFactorInfo }
279+
280+
export { MultiFactorResolver }
281+
282+
export { MultiFactorSession }
283+
284+
export { MultiFactorUser }
285+
212286
// @public (undocumented)
213287
export class OAuthCredential extends AuthCredential implements externs.OAuthCredential {
214288
// (undocumented)
@@ -267,9 +341,15 @@ export function onAuthStateChanged(auth: externs.Auth, nextOrObserver: externs.N
267341
// @public
268342
export function onIdTokenChanged(auth: externs.Auth, nextOrObserver: externs.NextOrObserver<externs.User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
269343

344+
export { OperationType }
345+
270346
// @public (undocumented)
271347
export function parseActionCodeURL(link: string): externs.ActionCodeURL | null;
272348

349+
export { ParsedToken }
350+
351+
export { Persistence }
352+
273353
// @public (undocumented)
274354
export class PhoneAuthCredential extends AuthCredential implements externs.PhoneAuthCredential {
275355
// (undocumented)
@@ -309,15 +389,31 @@ export class PhoneAuthProvider implements externs.PhoneAuthProvider {
309389
verifyPhoneNumber(phoneOptions: externs.PhoneInfoOptions | string, applicationVerifier: externs.ApplicationVerifier): Promise<string>;
310390
}
311391

392+
export { PhoneInfoOptions }
393+
394+
export { PhoneMultiFactorAssertion }
395+
396+
export { PhoneMultiFactorEnrollInfoOptions }
397+
312398
// @public (undocumented)
313399
export class PhoneMultiFactorGenerator implements externs.PhoneMultiFactorGenerator {
314400
// (undocumented)
315401
static assertion(credential: externs.PhoneAuthCredential): externs.PhoneMultiFactorAssertion;
316402
}
317403

404+
export { PhoneMultiFactorSignInInfoOptions }
405+
406+
export { PhoneSingleFactorInfoOptions }
407+
408+
export { PopupRedirectResolver }
409+
318410
// @public
319411
export const prodErrorMap: externs.AuthErrorMap;
320412

413+
export { ProviderId }
414+
415+
export { ReactNativeAsyncStorage }
416+
321417
// @public
322418
export function reauthenticateWithCredential(user: externs.User, credential: externs.AuthCredential): Promise<externs.UserCredential>;
323419

@@ -333,7 +429,7 @@ export function reauthenticateWithRedirect(user: externs.User, provider: externs
333429
// Warning: (ae-forgotten-export) The symbol "ApplicationVerifier" needs to be exported by the entry point index.d.ts
334430
//
335431
// @public (undocumented)
336-
export class RecaptchaVerifier implements externs.RecaptchaVerifier, ApplicationVerifier {
432+
export class RecaptchaVerifier implements externs.RecaptchaVerifier, ApplicationVerifier_2 {
337433
// Warning: (ae-forgotten-export) The symbol "Parameters" needs to be exported by the entry point index.d.ts
338434
constructor(containerOrId: HTMLElement | string, parameters: Parameters_2, authExtern: externs.Auth);
339435
// (undocumented)
@@ -370,6 +466,8 @@ export function setPersistence(auth: externs.Auth, persistence: externs.Persiste
370466
// @public
371467
export function signInAnonymously(auth: externs.Auth): Promise<externs.UserCredential>;
372468

469+
export { SignInMethod }
470+
373471
// @public
374472
export function signInWithCredential(auth: externs.Auth, credential: externs.AuthCredential): Promise<externs.UserCredential>;
375473

@@ -429,6 +527,16 @@ export function updateProfile(user: externs.User, { displayName, photoURL: photo
429527
// @public
430528
export function useDeviceLanguage(auth: externs.Auth): void;
431529

530+
export { User }
531+
532+
export { UserCredential }
533+
534+
export { UserInfo }
535+
536+
export { UserMetadata }
537+
538+
export { UserProfile }
539+
432540
// @public
433541
export function verifyBeforeUpdateEmail(user: externs.User, newEmail: string, actionCodeSettings?: externs.ActionCodeSettings | null): Promise<void>;
434542

packages-exp/auth-exp/index.ts

+85-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
*/
1717

1818
import { FirebaseApp } from '@firebase/app-types-exp';
19-
import { Auth } from '@firebase/auth-types-exp';
2019

2120
import { initializeAuth } from './src';
2221
import { registerAuth } from './src/core/auth/register';
@@ -25,6 +24,91 @@ import { browserLocalPersistence } from './src/platform_browser/persistence/loca
2524
import { indexedDBLocalPersistence } from './src/platform_browser/persistence/indexed_db';
2625
import { browserPopupRedirectResolver } from './src/platform_browser/popup_redirect';
2726

27+
import {
28+
// Enums
29+
ActionCodeOperation,
30+
FactorId,
31+
OperationType,
32+
ProviderId,
33+
SignInMethod,
34+
// Interfaces
35+
ActionCodeInfo,
36+
ActionCodeSettings,
37+
AdditionalUserInfo,
38+
ApplicationVerifier,
39+
Auth,
40+
AuthError,
41+
AuthErrorMap,
42+
AuthProvider,
43+
AuthSettings,
44+
Config,
45+
ConfirmationResult,
46+
IdTokenResult,
47+
MultiFactorAssertion,
48+
MultiFactorError,
49+
MultiFactorInfo,
50+
MultiFactorResolver,
51+
MultiFactorSession,
52+
MultiFactorUser,
53+
ParsedToken,
54+
Persistence,
55+
PhoneMultiFactorAssertion,
56+
PhoneMultiFactorEnrollInfoOptions,
57+
PhoneMultiFactorSignInInfoOptions,
58+
PhoneSingleFactorInfoOptions,
59+
PopupRedirectResolver,
60+
ReactNativeAsyncStorage,
61+
User,
62+
UserCredential,
63+
UserInfo,
64+
UserMetadata,
65+
UserProfile,
66+
PhoneInfoOptions
67+
} from '@firebase/auth-types-exp';
68+
69+
// Public types
70+
export {
71+
// Enums
72+
ActionCodeOperation,
73+
FactorId,
74+
OperationType,
75+
ProviderId,
76+
SignInMethod,
77+
// Interfaces
78+
ActionCodeInfo,
79+
ActionCodeSettings,
80+
AdditionalUserInfo,
81+
ApplicationVerifier,
82+
Auth,
83+
AuthError,
84+
AuthErrorMap,
85+
AuthProvider,
86+
AuthSettings,
87+
Config,
88+
ConfirmationResult,
89+
IdTokenResult,
90+
MultiFactorAssertion,
91+
MultiFactorError,
92+
MultiFactorInfo,
93+
MultiFactorResolver,
94+
MultiFactorSession,
95+
MultiFactorUser,
96+
ParsedToken,
97+
Persistence,
98+
PhoneMultiFactorAssertion,
99+
PhoneMultiFactorEnrollInfoOptions,
100+
PhoneMultiFactorSignInInfoOptions,
101+
PhoneSingleFactorInfoOptions,
102+
PopupRedirectResolver,
103+
ReactNativeAsyncStorage,
104+
User,
105+
UserCredential,
106+
UserInfo,
107+
UserMetadata,
108+
UserProfile,
109+
PhoneInfoOptions
110+
};
111+
28112
// Core functionality shared by all clients
29113
export * from './src';
30114

packages-exp/auth-types-exp/index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1067,7 +1067,7 @@ export interface MultiFactorInfo {
10671067
*
10681068
* @public
10691069
*/
1070-
export abstract class MultiFactorResolver {
1070+
export interface MultiFactorResolver {
10711071
/**
10721072
* The list of hints for the second factors needed to complete the sign-in for the current
10731073
* session.

0 commit comments

Comments
 (0)