Skip to content

Commit b3ee3cc

Browse files
committed
adding docgen
1 parent fb2d38f commit b3ee3cc

File tree

2 files changed

+21
-12
lines changed

2 files changed

+21
-12
lines changed

common/api-review/auth.api.md

+20-11
Original file line numberDiff line numberDiff line change
@@ -103,14 +103,14 @@ export class AuthCredential {
103103
protected constructor(
104104
providerId: string,
105105
signInMethod: string);
106-
// Warning: (ae-forgotten-export) The symbol "AuthInternal" needs to be exported by the entry point index.d.ts
107-
// Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.d.ts
106+
// Warning: (ae-forgotten-export) The symbol "AuthInternal" needs to be exported by the entry point index.doc.d.ts
107+
// Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.doc.d.ts
108108
//
109109
// @internal (undocumented)
110110
_getIdTokenResponse(_auth: AuthInternal): Promise<PhoneOrOauthTokenResponse>;
111111
// @internal (undocumented)
112112
_getReauthenticationResolver(_auth: AuthInternal): Promise<IdTokenResponse>;
113-
// Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.d.ts
113+
// Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.doc.d.ts
114114
//
115115
// @internal (undocumented)
116116
_linkToIdToken(_auth: AuthInternal, _idToken: string): Promise<IdTokenResponse>;
@@ -291,6 +291,9 @@ export function connectAuthEmulator(auth: Auth, url: string, options?: {
291291
disableWarnings: boolean;
292292
}): void;
293293

294+
// @public
295+
export const cordovaPopupRedirectResolver: PopupRedirectResolver;
296+
294297
// @public
295298
export function createUserWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;
296299

@@ -354,7 +357,7 @@ export interface EmulatorConfig {
354357

355358
export { ErrorFn }
356359

357-
// Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.d.ts
360+
// Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.doc.d.ts
358361
//
359362
// @public
360363
export class FacebookAuthProvider extends BaseOAuthProvider {
@@ -390,6 +393,9 @@ export function getIdTokenResult(user: User, forceRefresh?: boolean): Promise<Id
390393
// @public
391394
export function getMultiFactorResolver(auth: Auth, error: MultiFactorError): MultiFactorResolver;
392395

396+
// @public
397+
export function getReactNativePersistence(storage: ReactNativeAsyncStorage): Persistence;
398+
393399
// @public
394400
export function getRedirectResult(auth: Auth, resolver?: PopupRedirectResolver): Promise<UserCredential | null>;
395401

@@ -502,7 +508,7 @@ export type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;
502508
export class OAuthCredential extends AuthCredential {
503509
accessToken?: string;
504510
static fromJSON(json: string | object): OAuthCredential | null;
505-
// Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.d.ts
511+
// Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.doc.d.ts
506512
//
507513
// @internal (undocumented)
508514
static _fromParams(params: OAuthCredentialParams): OAuthCredential;
@@ -580,7 +586,7 @@ export class PhoneAuthCredential extends AuthCredential {
580586
_getReauthenticationResolver(auth: AuthInternal): Promise<IdTokenResponse>;
581587
// @internal (undocumented)
582588
_linkToIdToken(auth: AuthInternal, idToken: string): Promise<IdTokenResponse>;
583-
// Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.d.ts
589+
// Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.doc.d.ts
584590
//
585591
// @internal (undocumented)
586592
_makeVerificationRequest(): SignInWithPhoneNumberRequest;
@@ -659,6 +665,9 @@ export interface ReactNativeAsyncStorage {
659665
setItem(key: string, value: string): Promise<void>;
660666
}
661667

668+
// @public
669+
export const reactNativeLocalPersistence: Persistence;
670+
662671
// @public
663672
export function reauthenticateWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;
664673

@@ -677,13 +686,13 @@ export interface RecaptchaParameters {
677686
[key: string]: any;
678687
}
679688

680-
// Warning: (ae-forgotten-export) The symbol "ApplicationVerifierInternal" needs to be exported by the entry point index.d.ts
689+
// Warning: (ae-forgotten-export) The symbol "ApplicationVerifierInternal" needs to be exported by the entry point index.doc.d.ts
681690
//
682691
// @public
683692
export class RecaptchaVerifier implements ApplicationVerifierInternal {
684693
constructor(containerOrId: HTMLElement | string, parameters: RecaptchaParameters, authExtern: Auth);
685694
clear(): void;
686-
// Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.d.ts
695+
// Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.doc.d.ts
687696
//
688697
// @internal (undocumented)
689698
readonly _recaptchaLoader: ReCaptchaLoader;
@@ -697,7 +706,7 @@ export class RecaptchaVerifier implements ApplicationVerifierInternal {
697706
// @public
698707
export function reload(user: User): Promise<void>;
699708

700-
// Warning: (ae-forgotten-export) The symbol "FederatedAuthProvider" needs to be exported by the entry point index.d.ts
709+
// Warning: (ae-forgotten-export) The symbol "FederatedAuthProvider" needs to be exported by the entry point index.doc.d.ts
701710
//
702711
// @public
703712
export class SAMLAuthProvider extends FederatedAuthProvider {
@@ -778,13 +787,13 @@ export class TotpSecret {
778787
readonly codeIntervalSeconds: number;
779788
readonly codeLength: number;
780789
readonly enrollmentCompletionDeadline: string;
781-
// Warning: (ae-forgotten-export) The symbol "StartTotpMfaEnrollmentResponse" needs to be exported by the entry point index.d.ts
790+
// Warning: (ae-forgotten-export) The symbol "StartTotpMfaEnrollmentResponse" needs to be exported by the entry point index.doc.d.ts
782791
//
783792
// @internal (undocumented)
784793
static _fromStartTotpMfaEnrollmentResponse(response: StartTotpMfaEnrollmentResponse, auth: AuthInternal): TotpSecret;
785794
generateQrCodeUrl(accountName?: string, issuer?: string): string;
786795
readonly hashingAlgorithm: string;
787-
// Warning: (ae-forgotten-export) The symbol "TotpVerificationInfo" needs to be exported by the entry point index.d.ts
796+
// Warning: (ae-forgotten-export) The symbol "TotpVerificationInfo" needs to be exported by the entry point index.doc.d.ts
788797
//
789798
// @internal (undocumented)
790799
_makeTotpVerificationInfo(otp: string): TotpVerificationInfo;

packages/auth/api-extractor.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"extends": "../../config/api-extractor.json",
3-
"mainEntryPointFilePath": "<projectFolder>/dist/esm5/index.d.ts",
3+
"mainEntryPointFilePath": "<projectFolder>/dist/esm5/index.doc.d.ts",
44
"dtsRollup": {
55
"enabled": true,
66
"untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",

0 commit comments

Comments
 (0)