Skip to content

Commit e0bf867

Browse files
committed
Address review comments
1 parent 0db649e commit e0bf867

File tree

5 files changed

+10
-12
lines changed

5 files changed

+10
-12
lines changed

.changeset/polite-lies-vanish.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,4 @@
33
'@firebase/auth': minor
44
---
55

6-
[feature] Added `ActionCodeSettings.linkDomain` to customize the Firebase Hosting link domain that
7-
is used in mobile out-of-band email action flows. Also, deprecated
8-
`ActionCodeSettings.dynamicLinkDomain`.
6+
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`.

docs-devsite/auth.actioncodesettings.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export interface ActionCodeSettings
2626
| [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, <code>example.page.link</code>). |
2727
| [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. |
2828
| [iOS](./auth.actioncodesettings.md#actioncodesettingsios) | { bundleId: string; } | Sets the iOS bundle ID. |
29-
| [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). |
29+
| [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 (<code>web.app</code> or <code>firebaseapp.com</code>). |
3030
| [url](./auth.actioncodesettings.md#actioncodesettingsurl) | string | Sets the link continue/state URL. |
3131

3232
## ActionCodeSettings.android
@@ -90,7 +90,7 @@ iOS?: {
9090

9191
## ActionCodeSettings.linkDomain
9292

93-
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).
93+
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`<!-- -->).
9494

9595
<b>Signature:</b>
9696

@@ -102,7 +102,7 @@ linkDomain?: string;
102102

103103
Sets the link continue/state URL.
104104

105-
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.
105+
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.
106106

107107
<b>Signature:</b>
108108

packages/auth/src/core/errors.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -390,8 +390,8 @@ function _debugErrorMap(): ErrorMap<AuthErrorCode> {
390390
[AuthErrorCode.PASSWORD_DOES_NOT_MEET_REQUIREMENTS]:
391391
'The password does not meet the requirements.',
392392
[AuthErrorCode.INVALID_HOSTING_LINK_DOMAIN]:
393-
'The provided hosting link domain is not configured in Firebase Hosting or is not owned by ' +
394-
'the current project. This cannot be a default hosting domain (web.app or firebaseapp.com).'
393+
'The provided Hosting link domain is not configured in Firebase Hosting or is not owned by ' +
394+
'the current project. This cannot be a default Hosting domain (`web.app` or `firebaseapp.com`).'
395395
};
396396
}
397397

packages/auth/src/core/strategies/action_code_settings.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ describe('core/strategies/action_code_settings', () => {
7272
).to.throw(FirebaseError, '(auth/invalid-dynamic-link-domain)');
7373
});
7474

75-
it('should require a non empty hosting link URL', () => {
75+
it('should require a non empty Hosting link URL', () => {
7676
expect(() =>
7777
_setActionCodeSettingsOnRequest(auth, request, {
7878
handleCodeInApp: true,

packages/auth/src/model/public_types.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,7 @@ export interface ActionCodeSettings {
504504
* - When the link is handled in the web action widgets, this is the deep link in the
505505
* `continueUrl` query parameter.
506506
* - When the link is handled in the app directly, this is the `continueUrl` query parameter in
507-
* the deep link of the Dynamic Link or Hosting Link.
507+
* the deep link of the Dynamic Link or Hosting link.
508508
*/
509509
url: string;
510510
/**
@@ -521,8 +521,8 @@ export interface ActionCodeSettings {
521521
/**
522522
* The optional custom Firebase Hosting domain to use when the link is to be opened via
523523
* a specified mobile app. The domain must be configured in Firebase Hosting and owned
524-
* by the project. This cannot be a default hosting domain (web.app or firebaseapp.com).
525-
* @defaultValue The default hosting domain will be used (for example, `example.firebaseapp.com`)
524+
* by the project. This cannot be a default Hosting domain (`web.app` or `firebaseapp.com`).
525+
* @defaultValue The default Hosting domain will be used (for example, `example.firebaseapp.com`)
526526
*/
527527
linkDomain?: string;
528528
}

0 commit comments

Comments
 (0)