diff --git a/common/api-review/auth-exp.api.md b/common/api-review/auth-exp.api.md
index 3574f685b71..c96d59265f1 100644
--- a/common/api-review/auth-exp.api.md
+++ b/common/api-review/auth-exp.api.md
@@ -17,6 +17,7 @@ import { UserCredential } from '@firebase/auth-types-exp';
// @public (undocumented)
export class ActionCodeURL implements externs.ActionCodeURL {
+ // @internal
constructor(actionLink: string);
// (undocumented)
readonly apiKey: string;
diff --git a/common/api-review/auth-types-exp.api.md b/common/api-review/auth-types-exp.api.md
index 6a0e032900f..8b8efb4585a 100644
--- a/common/api-review/auth-types-exp.api.md
+++ b/common/api-review/auth-types-exp.api.md
@@ -45,19 +45,12 @@ export interface ActionCodeSettings {
// @public
export abstract class ActionCodeURL {
- // (undocumented)
readonly apiKey: string;
- // (undocumented)
readonly code: string;
- // (undocumented)
readonly continueUrl: string | null;
- // (undocumented)
readonly languageCode: string | null;
- // (undocumented)
readonly operation: Operation;
- // (undocumented)
static parseLink(link: string): ActionCodeURL | null;
- // (undocumented)
readonly tenantId: string | null;
}
@@ -116,7 +109,7 @@ export interface Auth {
// (undocumented)
useDeviceLanguage(): void;
// (undocumented)
- useEmulator(hostname: string, port: number): void;
+ useEmulator(url: string): void;
}
// @public
diff --git a/docs-exp/auth-types.actioncodeurl.apikey.md b/docs-exp/auth-types.actioncodeurl.apikey.md
index d1c16d4307b..6984aa7faef 100644
--- a/docs-exp/auth-types.actioncodeurl.apikey.md
+++ b/docs-exp/auth-types.actioncodeurl.apikey.md
@@ -4,6 +4,8 @@
## ActionCodeURL.apiKey property
+The API key of the email action link.
+
Signature:
```typescript
diff --git a/docs-exp/auth-types.actioncodeurl.code.md b/docs-exp/auth-types.actioncodeurl.code.md
index ed51c711c1c..df7dcf0d7e7 100644
--- a/docs-exp/auth-types.actioncodeurl.code.md
+++ b/docs-exp/auth-types.actioncodeurl.code.md
@@ -4,6 +4,8 @@
## ActionCodeURL.code property
+The action code of the email action link.
+
Signature:
```typescript
diff --git a/docs-exp/auth-types.actioncodeurl.continueurl.md b/docs-exp/auth-types.actioncodeurl.continueurl.md
index 6d2a2643a56..d25785dbad3 100644
--- a/docs-exp/auth-types.actioncodeurl.continueurl.md
+++ b/docs-exp/auth-types.actioncodeurl.continueurl.md
@@ -4,6 +4,8 @@
## ActionCodeURL.continueUrl property
+The continue URL of the email action link. Null if not provided.
+
Signature:
```typescript
diff --git a/docs-exp/auth-types.actioncodeurl.languagecode.md b/docs-exp/auth-types.actioncodeurl.languagecode.md
index 9f24dc7e9aa..6ad17299693 100644
--- a/docs-exp/auth-types.actioncodeurl.languagecode.md
+++ b/docs-exp/auth-types.actioncodeurl.languagecode.md
@@ -4,6 +4,8 @@
## ActionCodeURL.languageCode property
+The language code of the email action link. Null if not provided.
+
Signature:
```typescript
diff --git a/docs-exp/auth-types.actioncodeurl.md b/docs-exp/auth-types.actioncodeurl.md
index 5c998008f70..f3de723cf1c 100644
--- a/docs-exp/auth-types.actioncodeurl.md
+++ b/docs-exp/auth-types.actioncodeurl.md
@@ -4,7 +4,7 @@
## ActionCodeURL class
-https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeURL
+A utility class to parse email action URLs such as password reset, email verification, email link sign in, etc.
Signature:
@@ -16,16 +16,16 @@ export abstract class ActionCodeURL
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
-| [apiKey](./auth-types.actioncodeurl.apikey.md) | | string | |
-| [code](./auth-types.actioncodeurl.code.md) | | string | |
-| [continueUrl](./auth-types.actioncodeurl.continueurl.md) | | string \| null | |
-| [languageCode](./auth-types.actioncodeurl.languagecode.md) | | string \| null | |
-| [operation](./auth-types.actioncodeurl.operation.md) | | [Operation](./auth-types.operation.md) | |
-| [tenantId](./auth-types.actioncodeurl.tenantid.md) | | string \| null | |
+| [apiKey](./auth-types.actioncodeurl.apikey.md) | | string | The API key of the email action link. |
+| [code](./auth-types.actioncodeurl.code.md) | | string | The action code of the email action link. |
+| [continueUrl](./auth-types.actioncodeurl.continueurl.md) | | string \| null | The continue URL of the email action link. Null if not provided. |
+| [languageCode](./auth-types.actioncodeurl.languagecode.md) | | string \| null | The language code of the email action link. Null if not provided. |
+| [operation](./auth-types.actioncodeurl.operation.md) | | [Operation](./auth-types.operation.md) | The action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth-types.actioncodeinfo.md) |
+| [tenantId](./auth-types.actioncodeurl.tenantid.md) | | string \| null | The tenant ID of the email action link. Null if the email action is from the parent project. |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
-| [parseLink(link)](./auth-types.actioncodeurl.parselink.md) | static
| |
+| [parseLink(link)](./auth-types.actioncodeurl.parselink.md) | static
| Parses the email action link string and returns an ActionCodeURL object if the link is valid, otherwise returns null. |
diff --git a/docs-exp/auth-types.actioncodeurl.operation.md b/docs-exp/auth-types.actioncodeurl.operation.md
index 9e75986f290..234fca8c658 100644
--- a/docs-exp/auth-types.actioncodeurl.operation.md
+++ b/docs-exp/auth-types.actioncodeurl.operation.md
@@ -4,6 +4,8 @@
## ActionCodeURL.operation property
+The action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth-types.actioncodeinfo.md)
+
Signature:
```typescript
diff --git a/docs-exp/auth-types.actioncodeurl.parselink.md b/docs-exp/auth-types.actioncodeurl.parselink.md
index 375a6a3635d..05d933b4ef5 100644
--- a/docs-exp/auth-types.actioncodeurl.parselink.md
+++ b/docs-exp/auth-types.actioncodeurl.parselink.md
@@ -4,6 +4,8 @@
## ActionCodeURL.parseLink() method
+Parses the email action link string and returns an ActionCodeURL object if the link is valid, otherwise returns null.
+
Signature:
```typescript
@@ -14,9 +16,11 @@ static parseLink(link: string): ActionCodeURL | null;
| Parameter | Type | Description |
| --- | --- | --- |
-| link | string | |
+| link | string | The email action link string. |
Returns:
[ActionCodeURL](./auth-types.actioncodeurl.md) \| null
+The ActionCodeURL object, or null if the link is invalid.
+
diff --git a/docs-exp/auth-types.actioncodeurl.tenantid.md b/docs-exp/auth-types.actioncodeurl.tenantid.md
index c181bfe728c..06002ff16a4 100644
--- a/docs-exp/auth-types.actioncodeurl.tenantid.md
+++ b/docs-exp/auth-types.actioncodeurl.tenantid.md
@@ -4,6 +4,8 @@
## ActionCodeURL.tenantId property
+The tenant ID of the email action link. Null if the email action is from the parent project.
+
Signature:
```typescript
diff --git a/docs-exp/auth-types.auth.md b/docs-exp/auth-types.auth.md
index aa7615514cd..40732f59ae2 100644
--- a/docs-exp/auth-types.auth.md
+++ b/docs-exp/auth-types.auth.md
@@ -33,5 +33,5 @@ export interface Auth
| [signOut()](./auth-types.auth.signout.md) | |
| [updateCurrentUser(user)](./auth-types.auth.updatecurrentuser.md) | |
| [useDeviceLanguage()](./auth-types.auth.usedevicelanguage.md) | |
-| [useEmulator(hostname, port)](./auth-types.auth.useemulator.md) | |
+| [useEmulator(url)](./auth-types.auth.useemulator.md) | |
diff --git a/docs-exp/auth-types.auth.useemulator.md b/docs-exp/auth-types.auth.useemulator.md
index 9f63781ebd0..675456aa60b 100644
--- a/docs-exp/auth-types.auth.useemulator.md
+++ b/docs-exp/auth-types.auth.useemulator.md
@@ -7,15 +7,14 @@
Signature:
```typescript
-useEmulator(hostname: string, port: number): void;
+useEmulator(url: string): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
-| hostname | string | |
-| port | number | |
+| url | string | |
Returns:
diff --git a/docs-exp/auth-types.md b/docs-exp/auth-types.md
index c4669bf39dc..8fed5c4494f 100644
--- a/docs-exp/auth-types.md
+++ b/docs-exp/auth-types.md
@@ -8,7 +8,7 @@
| Class | Description |
| --- | --- |
-| [ActionCodeURL](./auth-types.actioncodeurl.md) | https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeURL |
+| [ActionCodeURL](./auth-types.actioncodeurl.md) | A utility class to parse email action URLs such as password reset, email verification, email link sign in, etc. |
| [AuthCredential](./auth-types.authcredential.md) | https://firebase.google.com/docs/reference/js/firebase.auth.AuthCredential |
| [EmailAuthProvider](./auth-types.emailauthprovider.md) | A provider for generating email & password and email link credentialshttps://firebase.google.com/docs/reference/js/firebase.auth.EmailAuthProvider |
| [MultiFactorResolver](./auth-types.multifactorresolver.md) | https://firebase.google.com/docs/reference/js/firebase.auth.multifactorresolver |
diff --git a/docs-exp/auth.actioncodeurl._constructor_.md b/docs-exp/auth.actioncodeurl._constructor_.md
deleted file mode 100644
index f9610df25c6..00000000000
--- a/docs-exp/auth.actioncodeurl._constructor_.md
+++ /dev/null
@@ -1,20 +0,0 @@
-
-
-[Home](./index.md) > [@firebase/auth](./auth.md) > [ActionCodeURL](./auth.actioncodeurl.md) > [(constructor)](./auth.actioncodeurl._constructor_.md)
-
-## ActionCodeURL.(constructor)
-
-Constructs a new instance of the `ActionCodeURL` class
-
-Signature:
-
-```typescript
-constructor(actionLink: string);
-```
-
-## Parameters
-
-| Parameter | Type | Description |
-| --- | --- | --- |
-| actionLink | string | |
-
diff --git a/docs-exp/auth.actioncodeurl.apikey.md b/docs-exp/auth.actioncodeurl.apikey.md
index 0c096dfb508..adb1e936942 100644
--- a/docs-exp/auth.actioncodeurl.apikey.md
+++ b/docs-exp/auth.actioncodeurl.apikey.md
@@ -4,6 +4,8 @@
## ActionCodeURL.apiKey property
+The API key of the email action link.
+
Signature:
```typescript
diff --git a/docs-exp/auth.actioncodeurl.code.md b/docs-exp/auth.actioncodeurl.code.md
index f0850003f40..8cc8b393b82 100644
--- a/docs-exp/auth.actioncodeurl.code.md
+++ b/docs-exp/auth.actioncodeurl.code.md
@@ -4,6 +4,8 @@
## ActionCodeURL.code property
+The action code of the email action link.
+
Signature:
```typescript
diff --git a/docs-exp/auth.actioncodeurl.continueurl.md b/docs-exp/auth.actioncodeurl.continueurl.md
index 691deb0219c..b619a32feae 100644
--- a/docs-exp/auth.actioncodeurl.continueurl.md
+++ b/docs-exp/auth.actioncodeurl.continueurl.md
@@ -4,6 +4,8 @@
## ActionCodeURL.continueUrl property
+The continue URL of the email action link. Null if not provided.
+
Signature:
```typescript
diff --git a/docs-exp/auth.actioncodeurl.languagecode.md b/docs-exp/auth.actioncodeurl.languagecode.md
index 266a902bd42..083c3a17906 100644
--- a/docs-exp/auth.actioncodeurl.languagecode.md
+++ b/docs-exp/auth.actioncodeurl.languagecode.md
@@ -4,6 +4,8 @@
## ActionCodeURL.languageCode property
+The language code of the email action link. Null if not provided.
+
Signature:
```typescript
diff --git a/docs-exp/auth.actioncodeurl.md b/docs-exp/auth.actioncodeurl.md
index ddfa4e3a680..30d65d287c6 100644
--- a/docs-exp/auth.actioncodeurl.md
+++ b/docs-exp/auth.actioncodeurl.md
@@ -4,6 +4,8 @@
## ActionCodeURL class
+A utility class to parse email action URLs such as password reset, email verification, email link sign in, etc.
+
Signature:
```typescript
@@ -11,26 +13,20 @@ export declare class ActionCodeURL implements externs.ActionCodeURL
```
Implements: externs.[ActionCodeURL](./auth-types.actioncodeurl.md)
-## Constructors
-
-| Constructor | Modifiers | Description |
-| --- | --- | --- |
-| [(constructor)(actionLink)](./auth.actioncodeurl._constructor_.md) | | Constructs a new instance of the ActionCodeURL
class |
-
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
-| [apiKey](./auth.actioncodeurl.apikey.md) | | string | |
-| [code](./auth.actioncodeurl.code.md) | | string | |
-| [continueUrl](./auth.actioncodeurl.continueurl.md) | | string \| null | |
-| [languageCode](./auth.actioncodeurl.languagecode.md) | | string \| null | |
-| [operation](./auth.actioncodeurl.operation.md) | | externs.[Operation](./auth-types.operation.md) | |
-| [tenantId](./auth.actioncodeurl.tenantid.md) | | string \| null | |
+| [apiKey](./auth.actioncodeurl.apikey.md) | | string | The API key of the email action link. |
+| [code](./auth.actioncodeurl.code.md) | | string | The action code of the email action link. |
+| [continueUrl](./auth.actioncodeurl.continueurl.md) | | string \| null | The continue URL of the email action link. Null if not provided. |
+| [languageCode](./auth.actioncodeurl.languagecode.md) | | string \| null | The language code of the email action link. Null if not provided. |
+| [operation](./auth.actioncodeurl.operation.md) | | externs.[Operation](./auth-types.operation.md) | The action performed by the email action link. It returns from one of the types from |
+| [tenantId](./auth.actioncodeurl.tenantid.md) | | string \| null | The tenant ID of the email action link. Null if the email action is from the parent project. |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
-| [parseLink(link)](./auth.actioncodeurl.parselink.md) | static
| |
+| [parseLink(link)](./auth.actioncodeurl.parselink.md) | static
| Parses the email action link string and returns an ActionCodeURL object if the link is valid, otherwise returns null. |
diff --git a/docs-exp/auth.actioncodeurl.operation.md b/docs-exp/auth.actioncodeurl.operation.md
index e6644c5cae9..0c39873bc6b 100644
--- a/docs-exp/auth.actioncodeurl.operation.md
+++ b/docs-exp/auth.actioncodeurl.operation.md
@@ -4,6 +4,8 @@
## ActionCodeURL.operation property
+The action performed by the email action link. It returns from one of the types from
+
Signature:
```typescript
diff --git a/docs-exp/auth.actioncodeurl.parselink.md b/docs-exp/auth.actioncodeurl.parselink.md
index ebef8f3c468..4e2861b1efa 100644
--- a/docs-exp/auth.actioncodeurl.parselink.md
+++ b/docs-exp/auth.actioncodeurl.parselink.md
@@ -4,6 +4,8 @@
## ActionCodeURL.parseLink() method
+Parses the email action link string and returns an ActionCodeURL object if the link is valid, otherwise returns null.
+
Signature:
```typescript
@@ -14,9 +16,11 @@ static parseLink(link: string): externs.ActionCodeURL | null;
| Parameter | Type | Description |
| --- | --- | --- |
-| link | string | |
+| link | string | The email action link string. |
Returns:
externs.[ActionCodeURL](./auth-types.actioncodeurl.md) \| null
+The ActionCodeURL object, or null if the link is invalid.
+
diff --git a/docs-exp/auth.actioncodeurl.tenantid.md b/docs-exp/auth.actioncodeurl.tenantid.md
index bbd86e49deb..7b43806b4c6 100644
--- a/docs-exp/auth.actioncodeurl.tenantid.md
+++ b/docs-exp/auth.actioncodeurl.tenantid.md
@@ -4,6 +4,8 @@
## ActionCodeURL.tenantId property
+The tenant ID of the email action link. Null if the email action is from the parent project.
+
Signature:
```typescript
diff --git a/docs-exp/auth.authcredential._getidtokenresponse.md b/docs-exp/auth.authcredential._getidtokenresponse.md
index c3326a29fc5..03c42c19047 100644
--- a/docs-exp/auth.authcredential._getidtokenresponse.md
+++ b/docs-exp/auth.authcredential._getidtokenresponse.md
@@ -7,14 +7,14 @@
Signature:
```typescript
-_getIdTokenResponse(_auth: AuthCore): Promise;
+_getIdTokenResponse(_auth: Auth): Promise;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
-| \_auth | AuthCore | |
+| \_auth | Auth | |
Returns:
diff --git a/docs-exp/auth.authcredential._getreauthenticationresolver.md b/docs-exp/auth.authcredential._getreauthenticationresolver.md
index 919efadbd23..db7f3688f37 100644
--- a/docs-exp/auth.authcredential._getreauthenticationresolver.md
+++ b/docs-exp/auth.authcredential._getreauthenticationresolver.md
@@ -7,14 +7,14 @@
Signature:
```typescript
-_getReauthenticationResolver(_auth: AuthCore): Promise;
+_getReauthenticationResolver(_auth: Auth): Promise;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
-| \_auth | AuthCore | |
+| \_auth | Auth | |
Returns:
diff --git a/docs-exp/auth.authcredential._linktoidtoken.md b/docs-exp/auth.authcredential._linktoidtoken.md
index 5422c8c5759..67bcf7c2ddc 100644
--- a/docs-exp/auth.authcredential._linktoidtoken.md
+++ b/docs-exp/auth.authcredential._linktoidtoken.md
@@ -7,14 +7,14 @@
Signature:
```typescript
-_linkToIdToken(_auth: AuthCore, _idToken: string): Promise;
+_linkToIdToken(_auth: Auth, _idToken: string): Promise;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
-| \_auth | AuthCore | |
+| \_auth | Auth | |
| \_idToken | string | |
Returns:
diff --git a/docs-exp/auth.emailauthcredential._getidtokenresponse.md b/docs-exp/auth.emailauthcredential._getidtokenresponse.md
index 4537fe7b4cf..15535401477 100644
--- a/docs-exp/auth.emailauthcredential._getidtokenresponse.md
+++ b/docs-exp/auth.emailauthcredential._getidtokenresponse.md
@@ -7,14 +7,14 @@
Signature:
```typescript
-_getIdTokenResponse(auth: AuthCore): Promise;
+_getIdTokenResponse(auth: Auth): Promise;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
-| auth | AuthCore | |
+| auth | Auth | |
Returns:
diff --git a/docs-exp/auth.emailauthcredential._getreauthenticationresolver.md b/docs-exp/auth.emailauthcredential._getreauthenticationresolver.md
index fe77fa06984..7b8eadfbff1 100644
--- a/docs-exp/auth.emailauthcredential._getreauthenticationresolver.md
+++ b/docs-exp/auth.emailauthcredential._getreauthenticationresolver.md
@@ -7,14 +7,14 @@
Signature:
```typescript
-_getReauthenticationResolver(auth: AuthCore): Promise;
+_getReauthenticationResolver(auth: Auth): Promise;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
-| auth | AuthCore | |
+| auth | Auth | |
Returns:
diff --git a/docs-exp/auth.emailauthcredential._linktoidtoken.md b/docs-exp/auth.emailauthcredential._linktoidtoken.md
index a9d83e5bcf6..ea4f92b5264 100644
--- a/docs-exp/auth.emailauthcredential._linktoidtoken.md
+++ b/docs-exp/auth.emailauthcredential._linktoidtoken.md
@@ -7,14 +7,14 @@
Signature:
```typescript
-_linkToIdToken(auth: AuthCore, idToken: string): Promise;
+_linkToIdToken(auth: Auth, idToken: string): Promise;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
-| auth | AuthCore | |
+| auth | Auth | |
| idToken | string | |
Returns:
diff --git a/docs-exp/auth.getredirectresult.md b/docs-exp/auth.getredirectresult.md
index 823dce7f808..1a793eb5f1e 100644
--- a/docs-exp/auth.getredirectresult.md
+++ b/docs-exp/auth.getredirectresult.md
@@ -7,7 +7,7 @@
Signature:
```typescript
-export declare function getRedirectResult(authExtern: externs.Auth, resolverExtern: externs.PopupRedirectResolver): Promise;
+export declare function getRedirectResult(authExtern: externs.Auth, resolverExtern?: externs.PopupRedirectResolver): Promise;
```
## Parameters
diff --git a/docs-exp/auth.linkwithpopup.md b/docs-exp/auth.linkwithpopup.md
index 1e516baeda6..76c36378633 100644
--- a/docs-exp/auth.linkwithpopup.md
+++ b/docs-exp/auth.linkwithpopup.md
@@ -7,7 +7,7 @@
Signature:
```typescript
-export declare function linkWithPopup(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern: externs.PopupRedirectResolver): Promise;
+export declare function linkWithPopup(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern?: externs.PopupRedirectResolver): Promise;
```
## Parameters
diff --git a/docs-exp/auth.linkwithredirect.md b/docs-exp/auth.linkwithredirect.md
index d456b2a92cf..dc31203de75 100644
--- a/docs-exp/auth.linkwithredirect.md
+++ b/docs-exp/auth.linkwithredirect.md
@@ -7,7 +7,7 @@
Signature:
```typescript
-export declare function linkWithRedirect(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern: externs.PopupRedirectResolver): Promise;
+export declare function linkWithRedirect(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern?: externs.PopupRedirectResolver): Promise;
```
## Parameters
diff --git a/docs-exp/auth.md b/docs-exp/auth.md
index 23b8d8451b5..e36e91f8cf3 100644
--- a/docs-exp/auth.md
+++ b/docs-exp/auth.md
@@ -8,7 +8,7 @@
| Class | Description |
| --- | --- |
-| [ActionCodeURL](./auth.actioncodeurl.md) | |
+| [ActionCodeURL](./auth.actioncodeurl.md) | A utility class to parse email action URLs such as password reset, email verification, email link sign in, etc. |
| [AuthCredential](./auth.authcredential.md) | |
| [EmailAuthCredential](./auth.emailauthcredential.md) | |
| [EmailAuthProvider](./auth.emailauthprovider.md) | |
@@ -48,7 +48,7 @@
| [multiFactor(user)](./auth.multifactor.md) | |
| [onAuthStateChanged(auth, nextOrObserver, error, completed)](./auth.onauthstatechanged.md) | |
| [onIdTokenChanged(auth, nextOrObserver, error, completed)](./auth.onidtokenchanged.md) | |
-| [parseActionCodeURL(link)](./auth.parseactioncodeurl.md) | |
+| [parseActionCodeURL(link)](./auth.parseactioncodeurl.md) | Parses the email action link string and returns an ActionCodeURL object if the link is valid, otherwise returns null. |
| [reauthenticateWithCredential(userExtern, credentialExtern)](./auth.reauthenticatewithcredential.md) | |
| [reauthenticateWithPhoneNumber(userExtern, phoneNumber, appVerifier)](./auth.reauthenticatewithphonenumber.md) | |
| [reauthenticateWithPopup(userExtern, provider, resolverExtern)](./auth.reauthenticatewithpopup.md) | |
@@ -64,8 +64,8 @@
| [signInWithEmailAndPassword(auth, email, password)](./auth.signinwithemailandpassword.md) | |
| [signInWithEmailLink(auth, email, emailLink)](./auth.signinwithemaillink.md) | |
| [signInWithPhoneNumber(auth, phoneNumber, appVerifier)](./auth.signinwithphonenumber.md) | |
-| [signInWithPopup(auth, provider, resolverExtern)](./auth.signinwithpopup.md) | |
-| [signInWithRedirect(auth, provider, resolverExtern)](./auth.signinwithredirect.md) | |
+| [signInWithPopup(authExtern, provider, resolverExtern)](./auth.signinwithpopup.md) | |
+| [signInWithRedirect(authExtern, provider, resolverExtern)](./auth.signinwithredirect.md) | |
| [signOut(auth)](./auth.signout.md) | |
| [unlink(userExtern, providerId)](./auth.unlink.md) | This is the externally visible unlink function |
| [updateCurrentUser(auth, user)](./auth.updatecurrentuser.md) | |
diff --git a/docs-exp/auth.oauthcredential._getidtokenresponse.md b/docs-exp/auth.oauthcredential._getidtokenresponse.md
index 97fc7971692..a1b21269649 100644
--- a/docs-exp/auth.oauthcredential._getidtokenresponse.md
+++ b/docs-exp/auth.oauthcredential._getidtokenresponse.md
@@ -7,14 +7,14 @@
Signature:
```typescript
-_getIdTokenResponse(auth: AuthCore): Promise;
+_getIdTokenResponse(auth: Auth): Promise;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
-| auth | AuthCore | |
+| auth | Auth | |
Returns:
diff --git a/docs-exp/auth.oauthcredential._getreauthenticationresolver.md b/docs-exp/auth.oauthcredential._getreauthenticationresolver.md
index d998f3049f5..35a047fda48 100644
--- a/docs-exp/auth.oauthcredential._getreauthenticationresolver.md
+++ b/docs-exp/auth.oauthcredential._getreauthenticationresolver.md
@@ -7,14 +7,14 @@
Signature:
```typescript
-_getReauthenticationResolver(auth: AuthCore): Promise;
+_getReauthenticationResolver(auth: Auth): Promise;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
-| auth | AuthCore | |
+| auth | Auth | |
Returns:
diff --git a/docs-exp/auth.oauthcredential._linktoidtoken.md b/docs-exp/auth.oauthcredential._linktoidtoken.md
index fb8e94ccf8f..eb0a27249d3 100644
--- a/docs-exp/auth.oauthcredential._linktoidtoken.md
+++ b/docs-exp/auth.oauthcredential._linktoidtoken.md
@@ -7,14 +7,14 @@
Signature:
```typescript
-_linkToIdToken(auth: AuthCore, idToken: string): Promise;
+_linkToIdToken(auth: Auth, idToken: string): Promise;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
-| auth | AuthCore | |
+| auth | Auth | |
| idToken | string | |
Returns:
diff --git a/docs-exp/auth.parseactioncodeurl.md b/docs-exp/auth.parseactioncodeurl.md
index bb640fec8a7..9b50bf16f0e 100644
--- a/docs-exp/auth.parseactioncodeurl.md
+++ b/docs-exp/auth.parseactioncodeurl.md
@@ -4,6 +4,8 @@
## parseActionCodeURL() function
+Parses the email action link string and returns an ActionCodeURL object if the link is valid, otherwise returns null.
+
Signature:
```typescript
@@ -14,9 +16,11 @@ export declare function parseActionCodeURL(link: string): externs.ActionCodeURL
| Parameter | Type | Description |
| --- | --- | --- |
-| link | string | |
+| link | string | The email action link string. |
Returns:
externs.[ActionCodeURL](./auth-types.actioncodeurl.md) \| null
+The ActionCodeURL object, or null if the link is invalid.
+
diff --git a/docs-exp/auth.phoneauthcredential._getidtokenresponse.md b/docs-exp/auth.phoneauthcredential._getidtokenresponse.md
index 5bfaba228b6..48f709938d9 100644
--- a/docs-exp/auth.phoneauthcredential._getidtokenresponse.md
+++ b/docs-exp/auth.phoneauthcredential._getidtokenresponse.md
@@ -7,14 +7,14 @@
Signature:
```typescript
-_getIdTokenResponse(auth: AuthCore): Promise;
+_getIdTokenResponse(auth: Auth): Promise;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
-| auth | AuthCore | |
+| auth | Auth | |
Returns:
diff --git a/docs-exp/auth.phoneauthcredential._getreauthenticationresolver.md b/docs-exp/auth.phoneauthcredential._getreauthenticationresolver.md
index 9461f379518..468f2e72bf5 100644
--- a/docs-exp/auth.phoneauthcredential._getreauthenticationresolver.md
+++ b/docs-exp/auth.phoneauthcredential._getreauthenticationresolver.md
@@ -7,14 +7,14 @@
Signature:
```typescript
-_getReauthenticationResolver(auth: AuthCore): Promise;
+_getReauthenticationResolver(auth: Auth): Promise;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
-| auth | AuthCore | |
+| auth | Auth | |
Returns:
diff --git a/docs-exp/auth.phoneauthcredential._linktoidtoken.md b/docs-exp/auth.phoneauthcredential._linktoidtoken.md
index e79f0c71282..9152759d2f0 100644
--- a/docs-exp/auth.phoneauthcredential._linktoidtoken.md
+++ b/docs-exp/auth.phoneauthcredential._linktoidtoken.md
@@ -7,14 +7,14 @@
Signature:
```typescript
-_linkToIdToken(auth: AuthCore, idToken: string): Promise;
+_linkToIdToken(auth: Auth, idToken: string): Promise;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
-| auth | AuthCore | |
+| auth | Auth | |
| idToken | string | |
Returns:
diff --git a/docs-exp/auth.phoneauthprovider._constructor_.md b/docs-exp/auth.phoneauthprovider._constructor_.md
index 116b2f1a9e9..849cad76568 100644
--- a/docs-exp/auth.phoneauthprovider._constructor_.md
+++ b/docs-exp/auth.phoneauthprovider._constructor_.md
@@ -9,12 +9,12 @@ Constructs a new instance of the `PhoneAuthProvider` class
Signature:
```typescript
-constructor(auth: AuthCore);
+constructor(auth: externs.Auth);
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
-| auth | AuthCore | |
+| auth | externs.[Auth](./auth-types.auth.md) | |
diff --git a/docs-exp/auth.reauthenticatewithpopup.md b/docs-exp/auth.reauthenticatewithpopup.md
index 636e78292e0..f759246a63a 100644
--- a/docs-exp/auth.reauthenticatewithpopup.md
+++ b/docs-exp/auth.reauthenticatewithpopup.md
@@ -7,7 +7,7 @@
Signature:
```typescript
-export declare function reauthenticateWithPopup(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern: externs.PopupRedirectResolver): Promise;
+export declare function reauthenticateWithPopup(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern?: externs.PopupRedirectResolver): Promise;
```
## Parameters
diff --git a/docs-exp/auth.reauthenticatewithredirect.md b/docs-exp/auth.reauthenticatewithredirect.md
index 96aa8ca0d48..537f4810542 100644
--- a/docs-exp/auth.reauthenticatewithredirect.md
+++ b/docs-exp/auth.reauthenticatewithredirect.md
@@ -7,7 +7,7 @@
Signature:
```typescript
-export declare function reauthenticateWithRedirect(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern: externs.PopupRedirectResolver): Promise;
+export declare function reauthenticateWithRedirect(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern?: externs.PopupRedirectResolver): Promise;
```
## Parameters
diff --git a/docs-exp/auth.recaptchaverifier._constructor_.md b/docs-exp/auth.recaptchaverifier._constructor_.md
index 9808828362a..b30e021e866 100644
--- a/docs-exp/auth.recaptchaverifier._constructor_.md
+++ b/docs-exp/auth.recaptchaverifier._constructor_.md
@@ -9,7 +9,7 @@ Constructs a new instance of the `RecaptchaVerifier` class
Signature:
```typescript
-constructor(containerOrId: HTMLElement | string, parameters: Parameters, auth: AuthCore);
+constructor(containerOrId: HTMLElement | string, parameters: Parameters, authExtern: externs.Auth);
```
## Parameters
@@ -18,5 +18,5 @@ constructor(containerOrId: HTMLElement | string, parameters: Parameters, auth: A
| --- | --- | --- |
| containerOrId | HTMLElement \| string | |
| parameters | Parameters | |
-| auth | AuthCore | |
+| authExtern | externs.[Auth](./auth-types.auth.md) | |
diff --git a/docs-exp/auth.recaptchaverifier.md b/docs-exp/auth.recaptchaverifier.md
index 568087706b6..ecbf1958428 100644
--- a/docs-exp/auth.recaptchaverifier.md
+++ b/docs-exp/auth.recaptchaverifier.md
@@ -15,7 +15,7 @@ export declare class RecaptchaVerifier implements externs.RecaptchaVerifier, App
| Constructor | Modifiers | Description |
| --- | --- | --- |
-| [(constructor)(containerOrId, parameters, auth)](./auth.recaptchaverifier._constructor_.md) | | Constructs a new instance of the RecaptchaVerifier
class |
+| [(constructor)(containerOrId, parameters, authExtern)](./auth.recaptchaverifier._constructor_.md) | | Constructs a new instance of the RecaptchaVerifier
class |
## Properties
diff --git a/docs-exp/auth.signinwithpopup.md b/docs-exp/auth.signinwithpopup.md
index 3154fdf17d0..4be7d318680 100644
--- a/docs-exp/auth.signinwithpopup.md
+++ b/docs-exp/auth.signinwithpopup.md
@@ -7,14 +7,14 @@
Signature:
```typescript
-export declare function signInWithPopup(auth: externs.Auth, provider: externs.AuthProvider, resolverExtern: externs.PopupRedirectResolver): Promise;
+export declare function signInWithPopup(authExtern: externs.Auth, provider: externs.AuthProvider, resolverExtern?: externs.PopupRedirectResolver): Promise;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
-| auth | externs.[Auth](./auth-types.auth.md) | |
+| authExtern | externs.[Auth](./auth-types.auth.md) | |
| provider | externs.[AuthProvider](./auth-types.authprovider.md) | |
| resolverExtern | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | |
diff --git a/docs-exp/auth.signinwithredirect.md b/docs-exp/auth.signinwithredirect.md
index 0decff074f2..86336c4a436 100644
--- a/docs-exp/auth.signinwithredirect.md
+++ b/docs-exp/auth.signinwithredirect.md
@@ -7,14 +7,14 @@
Signature:
```typescript
-export declare function signInWithRedirect(auth: externs.Auth, provider: externs.AuthProvider, resolverExtern: externs.PopupRedirectResolver): Promise;
+export declare function signInWithRedirect(authExtern: externs.Auth, provider: externs.AuthProvider, resolverExtern?: externs.PopupRedirectResolver): Promise;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
-| auth | externs.[Auth](./auth-types.auth.md) | |
+| authExtern | externs.[Auth](./auth-types.auth.md) | |
| provider | externs.[AuthProvider](./auth-types.authprovider.md) | |
| resolverExtern | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | |
diff --git a/packages-exp/auth-exp/package.json b/packages-exp/auth-exp/package.json
index fc5c25a69a5..cfedac20f79 100644
--- a/packages-exp/auth-exp/package.json
+++ b/packages-exp/auth-exp/package.json
@@ -32,7 +32,7 @@
"prepare": "rollup -c rollup.config.release.js",
"api-report": "api-extractor run --local --verbose",
"predoc": "node ../../scripts/exp/remove-exp.js temp",
- "doc": "api-documenter markdown --input temp --output docs",
+ "doc": "api-documenter markdown --input temp --input ../auth-types-exp/temp --output docs",
"build:doc": "yarn build && yarn doc"
},
"peerDependencies": {
diff --git a/packages-exp/auth-exp/src/core/action_code_url.ts b/packages-exp/auth-exp/src/core/action_code_url.ts
index 122dff0f993..38fb4c977eb 100644
--- a/packages-exp/auth-exp/src/core/action_code_url.ts
+++ b/packages-exp/auth-exp/src/core/action_code_url.ts
@@ -20,7 +20,9 @@ import { AuthErrorCode, AUTH_ERROR_FACTORY } from './errors';
/**
* Enums for fields in URL query string.
+ *
* @enum {string}
+ * @internal
*/
enum QueryField {
API_KEY = 'apiKey',
@@ -33,6 +35,8 @@ enum QueryField {
/**
* Map from mode string in action code URL to Action Code Info operation.
+ *
+ * @internal
*/
const MODE_TO_OPERATION_MAP: { [key: string]: externs.Operation } = {
'recoverEmail': externs.Operation.RECOVER_EMAIL,
@@ -45,11 +49,20 @@ const MODE_TO_OPERATION_MAP: { [key: string]: externs.Operation } = {
/**
* Maps the mode string in action code URL to Action Code Info operation.
+ *
+ * @param mode
+ * @internal
*/
function parseMode(mode: string | null): externs.Operation | null {
return mode ? MODE_TO_OPERATION_MAP[mode] || null : null;
}
+/**
+ * Helper to parse FDL links
+ *
+ * @param url
+ * @internal
+ */
function parseDeepLink(url: string): string {
const uri = new URL(url);
const link = uri.searchParams.get('link');
@@ -63,14 +76,31 @@ function parseDeepLink(url: string): string {
return iOSDoubleDeepLink || iOSDeepLink || doubleDeepLink || link || url;
}
+/**
+ * {@inheritDoc @firebase/auth-types-exp#ActionCodeURL}
+ *
+ * @public
+ */
export class ActionCodeURL implements externs.ActionCodeURL {
+ /** {@inheritDoc @firebase/auth-types-exp#ActionCodeURL.apiKey} */
readonly apiKey: string;
+ /** {@inheritDoc @firebase/auth-types-exp#ActionCodeURL.code} */
readonly code: string;
+ /** {@inheritDoc @firebase/auth-types-exp#ActionCodeURL.continueUrl} */
readonly continueUrl: string | null;
+ /** {@inheritDoc @firebase/auth-types-exp#ActionCodeURL.languageCode} */
readonly languageCode: string | null;
+ /** {@inheritDoc @firebase/auth-types-exp#ActionCodeURL.operation} */
readonly operation: externs.Operation;
+ /** {@inheritDoc @firebase/auth-types-exp#ActionCodeURL.tenantId} */
readonly tenantId: string | null;
+ /**
+ * @param actionLink - The link from which to extract the URL.
+ * @returns The ActionCodeURL object, or null if the link is invalid.
+ *
+ * @internal
+ */
constructor(actionLink: string) {
const uri = new URL(actionLink);
const apiKey = uri.searchParams.get(QueryField.API_KEY);
@@ -88,6 +118,7 @@ export class ActionCodeURL implements externs.ActionCodeURL {
this.tenantId = uri.searchParams.get(QueryField.TENANT_ID);
}
+ /** {@inheritDoc @firebase/auth-types-exp#ActionCodeURL.parseLink} */
static parseLink(link: string): externs.ActionCodeURL | null {
const actionLink = parseDeepLink(link);
try {
@@ -98,6 +129,11 @@ export class ActionCodeURL implements externs.ActionCodeURL {
}
}
+/**
+ * {@inheritDoc @firebase/auth-types-exp#ActionCodeURL.parseLink}
+ *
+ * @public
+ */
export function parseActionCodeURL(link: string): externs.ActionCodeURL | null {
return ActionCodeURL.parseLink(link);
}
diff --git a/packages-exp/auth-types-exp/index.d.ts b/packages-exp/auth-types-exp/index.d.ts
index 85ac75e4f53..c24d133b7c8 100644
--- a/packages-exp/auth-types-exp/index.d.ts
+++ b/packages-exp/auth-types-exp/index.d.ts
@@ -205,16 +205,45 @@ export interface ActionCodeSettings {
}
/**
- * https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeURL
+ * A utility class to parse email action URLs such as password reset, email verification,
+ * email link sign in, etc.
+ *
+ * @public
*/
export abstract class ActionCodeURL {
+ /**
+ * The API key of the email action link.
+ */
readonly apiKey: string;
+ /**
+ * The action code of the email action link.
+ */
readonly code: string;
+ /**
+ * The continue URL of the email action link. Null if not provided.
+ */
readonly continueUrl: string | null;
+ /**
+ * The language code of the email action link. Null if not provided.
+ */
readonly languageCode: string | null;
+ /**
+ * The action performed by the email action link. It returns from one of the types from {@link ActionCodeInfo}
+ */
readonly operation: Operation;
+ /**
+ * The tenant ID of the email action link. Null if the email action is from the parent project.
+ */
readonly tenantId: string | null;
+ /**
+ * Parses the email action link string and returns an ActionCodeURL object if the link is valid, otherwise returns null.
+ *
+ * @param link - The email action link string.
+ * @returns The ActionCodeURL object, or null if the link is invalid.
+ *
+ * @public
+ */
static parseLink(link: string): ActionCodeURL | null;
}