diff --git a/.changeset/polite-lies-vanish.md b/.changeset/polite-lies-vanish.md
index f8173c4e474..211f069bbb2 100644
--- a/.changeset/polite-lies-vanish.md
+++ b/.changeset/polite-lies-vanish.md
@@ -3,6 +3,4 @@
'@firebase/auth': minor
---
-[feature] Added `ActionCodeSettings.linkDomain` to customize the Firebase Hosting link domain that
-is used in mobile out-of-band email action flows. Also, deprecated
-`ActionCodeSettings.dynamicLinkDomain`.
\ No newline at end of file
+Added `ActionCodeSettings.linkDomain` to customize the Firebase Hosting link domain that is used in mobile out-of-band email action flows. Also, deprecated `ActionCodeSettings.dynamicLinkDomain`.
diff --git a/docs-devsite/auth.actioncodesettings.md b/docs-devsite/auth.actioncodesettings.md
index ffebef8c805..8163d493d50 100644
--- a/docs-devsite/auth.actioncodesettings.md
+++ b/docs-devsite/auth.actioncodesettings.md
@@ -26,7 +26,7 @@ export interface ActionCodeSettings
| [dynamicLinkDomain](./auth.actioncodesettings.md#actioncodesettingsdynamiclinkdomain) | string | When multiple custom dynamic link domains are defined for a project, specify which one to use when the link is to be opened via a specified mobile app (for example, example.page.link
). |
| [handleCodeInApp](./auth.actioncodesettings.md#actioncodesettingshandlecodeinapp) | boolean | When set to true, the action code link will be be sent as a Universal Link or Android App Link and will be opened by the app if installed. |
| [iOS](./auth.actioncodesettings.md#actioncodesettingsios) | { bundleId: string; } | Sets the iOS bundle ID. |
-| [linkDomain](./auth.actioncodesettings.md#actioncodesettingslinkdomain) | string | The optional custom Firebase Hosting domain to use when the link is to be opened via a specified mobile app. The domain must be configured in Firebase Hosting and owned by the project. This cannot be a default hosting domain (web.app or firebaseapp.com). |
+| [linkDomain](./auth.actioncodesettings.md#actioncodesettingslinkdomain) | string | The optional custom Firebase Hosting domain to use when the link is to be opened via a specified mobile app. The domain must be configured in Firebase Hosting and owned by the project. This cannot be a default Hosting domain (web.app
or firebaseapp.com
). |
| [url](./auth.actioncodesettings.md#actioncodesettingsurl) | string | Sets the link continue/state URL. |
## ActionCodeSettings.android
@@ -90,7 +90,7 @@ iOS?: {
## ActionCodeSettings.linkDomain
-The optional custom Firebase Hosting domain to use when the link is to be opened via a specified mobile app. The domain must be configured in Firebase Hosting and owned by the project. This cannot be a default hosting domain (web.app or firebaseapp.com).
+The optional custom Firebase Hosting domain to use when the link is to be opened via a specified mobile app. The domain must be configured in Firebase Hosting and owned by the project. This cannot be a default Hosting domain (`web.app` or `firebaseapp.com`).
Signature:
@@ -102,7 +102,7 @@ linkDomain?: string;
Sets the link continue/state URL.
-This has different meanings in different contexts: - When the link is handled in the web action widgets, this is the deep link in the `continueUrl` query parameter. - When the link is handled in the app directly, this is the `continueUrl` query parameter in the deep link of the Dynamic Link or Hosting Link.
+This has different meanings in different contexts: - When the link is handled in the web action widgets, this is the deep link in the `continueUrl` query parameter. - When the link is handled in the app directly, this is the `continueUrl` query parameter in the deep link of the Dynamic Link or Hosting link.
Signature:
diff --git a/packages/auth/src/core/errors.ts b/packages/auth/src/core/errors.ts
index ff012c9ee37..0e7fb53059c 100644
--- a/packages/auth/src/core/errors.ts
+++ b/packages/auth/src/core/errors.ts
@@ -390,8 +390,8 @@ function _debugErrorMap(): ErrorMap {
[AuthErrorCode.PASSWORD_DOES_NOT_MEET_REQUIREMENTS]:
'The password does not meet the requirements.',
[AuthErrorCode.INVALID_HOSTING_LINK_DOMAIN]:
- 'The provided hosting link domain is not configured in Firebase Hosting or is not owned by ' +
- 'the current project. This cannot be a default hosting domain (web.app or firebaseapp.com).'
+ 'The provided Hosting link domain is not configured in Firebase Hosting or is not owned by ' +
+ 'the current project. This cannot be a default Hosting domain (`web.app` or `firebaseapp.com`).'
};
}
diff --git a/packages/auth/src/core/strategies/action_code_settings.test.ts b/packages/auth/src/core/strategies/action_code_settings.test.ts
index 1a14f719e30..09bc672ee06 100644
--- a/packages/auth/src/core/strategies/action_code_settings.test.ts
+++ b/packages/auth/src/core/strategies/action_code_settings.test.ts
@@ -72,7 +72,7 @@ describe('core/strategies/action_code_settings', () => {
).to.throw(FirebaseError, '(auth/invalid-dynamic-link-domain)');
});
- it('should require a non empty hosting link URL', () => {
+ it('should require a non empty Hosting link URL', () => {
expect(() =>
_setActionCodeSettingsOnRequest(auth, request, {
handleCodeInApp: true,
diff --git a/packages/auth/src/model/public_types.ts b/packages/auth/src/model/public_types.ts
index e2af70fa3b5..797f286ecdf 100644
--- a/packages/auth/src/model/public_types.ts
+++ b/packages/auth/src/model/public_types.ts
@@ -504,7 +504,7 @@ export interface ActionCodeSettings {
* - When the link is handled in the web action widgets, this is the deep link in the
* `continueUrl` query parameter.
* - When the link is handled in the app directly, this is the `continueUrl` query parameter in
- * the deep link of the Dynamic Link or Hosting Link.
+ * the deep link of the Dynamic Link or Hosting link.
*/
url: string;
/**
@@ -521,8 +521,8 @@ export interface ActionCodeSettings {
/**
* The optional custom Firebase Hosting domain to use when the link is to be opened via
* a specified mobile app. The domain must be configured in Firebase Hosting and owned
- * by the project. This cannot be a default hosting domain (web.app or firebaseapp.com).
- * @defaultValue The default hosting domain will be used (for example, `example.firebaseapp.com`)
+ * by the project. This cannot be a default Hosting domain (`web.app` or `firebaseapp.com`).
+ * @defaultValue The default Hosting domain will be used (for example, `example.firebaseapp.com`)
*/
linkDomain?: string;
}