bitwarden/browser
1
0
Fork 0
mirror of https://github.com/bitwarden/browser synced 2025-12-12 22:33:35 +00:00
Code Issues Releases Wiki Activity

[PM-8236] Allow for additional data properties (#9278)

Browse Source 
* allow for additional properties

* create interface for DataProperties and extend AnonLayouWrapperData

* move data properties to RouterService

* add docs

* add comment

* rewrite comment
This commit is contained in:
rr-bw
2024-06-04 08:38:54 -07:00
committed by GitHub
parent 3acdd9d8fd
commit 13c2c2ecaa
2 changed files with 46 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
apps/web/src/app/core/router.service.ts
View File

@@ -12,6 +12,14 @@ import {
GlobalState, GlobalState,
} from "@bitwarden/common/platform/state"; } from "@bitwarden/common/platform/state";
/**
* Data properties acceptable for use in route objects (see usage in oss-routing.module.ts for example)
*/
export interface DataProperties {
titleId?: string; // sets the title of the current HTML document (shows in browser tab)
doNotSaveUrl?: boolean; // choose to not keep track of the previous URL in memory
}
const DEEP_LINK_REDIRECT_URL = new KeyDefinition(ROUTER_DISK, "deepLinkRedirectUrl", { const DEEP_LINK_REDIRECT_URL = new KeyDefinition(ROUTER_DISK, "deepLinkRedirectUrl", {
deserializer: (value: string) => value, deserializer: (value: string) => value,
}); });

67
apps/web/src/app/oss-routing.module.ts
View File

@@ -40,6 +40,7 @@ import { UpdatePasswordComponent } from "./auth/update-password.component";
import { UpdateTempPasswordComponent } from "./auth/update-temp-password.component"; import { UpdateTempPasswordComponent } from "./auth/update-temp-password.component";
import { VerifyEmailTokenComponent } from "./auth/verify-email-token.component"; import { VerifyEmailTokenComponent } from "./auth/verify-email-token.component";
import { VerifyRecoverDeleteComponent } from "./auth/verify-recover-delete.component"; import { VerifyRecoverDeleteComponent } from "./auth/verify-recover-delete.component";
import { DataProperties } from "./core";
import { FrontendLayoutComponent } from "./layouts/frontend-layout.component"; import { FrontendLayoutComponent } from "./layouts/frontend-layout.component";
import { UserLayoutComponent } from "./layouts/user-layout.component"; import { UserLayoutComponent } from "./layouts/user-layout.component";
import { DomainRulesComponent } from "./settings/domain-rules.component"; import { DomainRulesComponent } from "./settings/domain-rules.component";
@@ -54,7 +55,7 @@ const routes: Routes = [
{ {
path: "", path: "",
component: FrontendLayoutComponent, component: FrontendLayoutComponent,
data: { doNotSaveUrl: true }, data: { doNotSaveUrl: true } satisfies DataProperties,
children: [ children: [
{ {
path: "", path: "",
@@ -66,17 +67,17 @@ const routes: Routes = [
{ {
path: "login-with-device", path: "login-with-device",
component: LoginViaAuthRequestComponent, component: LoginViaAuthRequestComponent,
data: { titleId: "loginWithDevice" }, data: { titleId: "loginWithDevice" } satisfies DataProperties,
}, },
{ {
path: "login-with-passkey", path: "login-with-passkey",
component: LoginViaWebAuthnComponent, component: LoginViaWebAuthnComponent,
data: { titleId: "loginWithPasskey" }, data: { titleId: "loginWithPasskey" } satisfies DataProperties,
}, },
{ {
path: "admin-approval-requested", path: "admin-approval-requested",
component: LoginViaAuthRequestComponent, component: LoginViaAuthRequestComponent,
data: { titleId: "adminApprovalRequested" }, data: { titleId: "adminApprovalRequested" } satisfies DataProperties,
}, },
{ path: "2fa", component: TwoFactorComponent, canActivate: [UnauthGuard] }, { path: "2fa", component: TwoFactorComponent, canActivate: [UnauthGuard] },
{ {
@@ -88,7 +89,7 @@ const routes: Routes = [
path: "register", path: "register",
component: TrialInitiationComponent, component: TrialInitiationComponent,
canActivate: [UnauthGuard], canActivate: [UnauthGuard],
data: { titleId: "createAccount" }, data: { titleId: "createAccount" } satisfies DataProperties,
}, },
{ {
path: "trial", path: "trial",
@@ -99,18 +100,18 @@ const routes: Routes = [
path: "sso", path: "sso",
component: SsoComponent, component: SsoComponent,
canActivate: [UnauthGuard], canActivate: [UnauthGuard],
data: { titleId: "enterpriseSingleSignOn" }, data: { titleId: "enterpriseSingleSignOn" } satisfies DataProperties,
}, },
{ {
path: "set-password", path: "set-password",
component: SetPasswordComponent, component: SetPasswordComponent,
data: { titleId: "setMasterPassword" }, data: { titleId: "setMasterPassword" } satisfies DataProperties,
}, },
{ {
path: "hint", path: "hint",
component: HintComponent, component: HintComponent,
canActivate: [UnauthGuard], canActivate: [UnauthGuard],
data: { titleId: "passwordHint" }, data: { titleId: "passwordHint" } satisfies DataProperties,
}, },
{ {
path: "lock", path: "lock",
@@ -122,12 +123,12 @@ const routes: Routes = [
path: "accept-organization", path: "accept-organization",
canActivate: [deepLinkGuard()], canActivate: [deepLinkGuard()],
component: AcceptOrganizationComponent, component: AcceptOrganizationComponent,
data: { titleId: "joinOrganization", doNotSaveUrl: false }, data: { titleId: "joinOrganization", doNotSaveUrl: false } satisfies DataProperties,
}, },
{ {
path: "accept-emergency", path: "accept-emergency",
canActivate: [deepLinkGuard()], canActivate: [deepLinkGuard()],
data: { titleId: "acceptEmergency", doNotSaveUrl: false }, data: { titleId: "acceptEmergency", doNotSaveUrl: false } satisfies DataProperties,
loadComponent: () => loadComponent: () =>
import("./auth/emergency-access/accept/accept-emergency.component").then( import("./auth/emergency-access/accept/accept-emergency.component").then(
(mod) => mod.AcceptEmergencyComponent, (mod) => mod.AcceptEmergencyComponent,
@@ -137,26 +138,26 @@ const routes: Routes = [
path: "accept-families-for-enterprise", path: "accept-families-for-enterprise",
component: AcceptFamilySponsorshipComponent, component: AcceptFamilySponsorshipComponent,
canActivate: [deepLinkGuard()], canActivate: [deepLinkGuard()],
data: { titleId: "acceptFamilySponsorship", doNotSaveUrl: false }, data: { titleId: "acceptFamilySponsorship", doNotSaveUrl: false } satisfies DataProperties,
}, },
{ path: "recover", pathMatch: "full", redirectTo: "recover-2fa" }, { path: "recover", pathMatch: "full", redirectTo: "recover-2fa" },
{ {
path: "recover-2fa", path: "recover-2fa",
component: RecoverTwoFactorComponent, component: RecoverTwoFactorComponent,
canActivate: [UnauthGuard], canActivate: [UnauthGuard],
data: { titleId: "recoverAccountTwoStep" }, data: { titleId: "recoverAccountTwoStep" } satisfies DataProperties,
}, },
{ {
path: "recover-delete", path: "recover-delete",
component: RecoverDeleteComponent, component: RecoverDeleteComponent,
canActivate: [UnauthGuard], canActivate: [UnauthGuard],
data: { titleId: "deleteAccount" }, data: { titleId: "deleteAccount" } satisfies DataProperties,
}, },
{ {
path: "verify-recover-delete", path: "verify-recover-delete",
component: VerifyRecoverDeleteComponent, component: VerifyRecoverDeleteComponent,
canActivate: [UnauthGuard], canActivate: [UnauthGuard],
data: { titleId: "deleteAccount" }, data: { titleId: "deleteAccount" } satisfies DataProperties,
}, },
{ {
path: "verify-recover-delete-org", path: "verify-recover-delete-org",
@@ -168,30 +169,30 @@ const routes: Routes = [
path: "verify-recover-delete-provider", path: "verify-recover-delete-provider",
component: VerifyRecoverDeleteProviderComponent, component: VerifyRecoverDeleteProviderComponent,
canActivate: [UnauthGuard], canActivate: [UnauthGuard],
data: { titleId: "deleteAccount" }, data: { titleId: "deleteAccount" } satisfies DataProperties,
}, },
{ {
path: "send/:sendId/:key", path: "send/:sendId/:key",
component: AccessComponent, component: AccessComponent,
data: { title: "Bitwarden Send" }, data: { titleId: "Bitwarden Send" } satisfies DataProperties,
}, },
{ {
path: "update-temp-password", path: "update-temp-password",
component: UpdateTempPasswordComponent, component: UpdateTempPasswordComponent,
canActivate: [AuthGuard], canActivate: [AuthGuard],
data: { titleId: "updateTempPassword" }, data: { titleId: "updateTempPassword" } satisfies DataProperties,
}, },
{ {
path: "update-password", path: "update-password",
component: UpdatePasswordComponent, component: UpdatePasswordComponent,
canActivate: [AuthGuard], canActivate: [AuthGuard],
data: { titleId: "updatePassword" }, data: { titleId: "updatePassword" } satisfies DataProperties,
}, },
{ {
path: "remove-password", path: "remove-password",
component: RemovePasswordComponent, component: RemovePasswordComponent,
canActivate: [AuthGuard], canActivate: [AuthGuard],
data: { titleId: "removeMasterPassword" }, data: { titleId: "removeMasterPassword" } satisfies DataProperties,
}, },
{ {
path: "migrate-legacy-encryption", path: "migrate-legacy-encryption",
@@ -211,21 +212,29 @@ const routes: Routes = [
path: "vault", path: "vault",
loadChildren: () => VaultModule, loadChildren: () => VaultModule,
}, },
{ path: "sends", component: SendComponent, data: { titleId: "send" } }, {
path: "sends",
component: SendComponent,
data: { titleId: "send" } satisfies DataProperties,
},
{ {
path: "create-organization", path: "create-organization",
component: CreateOrganizationComponent, component: CreateOrganizationComponent,
data: { titleId: "newOrganization" }, data: { titleId: "newOrganization" } satisfies DataProperties,
}, },
{ {
path: "settings", path: "settings",
children: [ children: [
{ path: "", pathMatch: "full", redirectTo: "account" }, { path: "", pathMatch: "full", redirectTo: "account" },
{ path: "account", component: AccountComponent, data: { titleId: "myAccount" } }, {
path: "account",
component: AccountComponent,
data: { titleId: "myAccount" } satisfies DataProperties,
},
{ {
path: "preferences", path: "preferences",
component: PreferencesComponent, component: PreferencesComponent,
data: { titleId: "preferences" }, data: { titleId: "preferences" } satisfies DataProperties,
}, },
{ {
path: "security", path: "security",
@@ -234,7 +243,7 @@ const routes: Routes = [
{ {
path: "domain-rules", path: "domain-rules",
component: DomainRulesComponent, component: DomainRulesComponent,
data: { titleId: "domainRules" }, data: { titleId: "domainRules" } satisfies DataProperties,
}, },
{ {
path: "subscription", path: "subscription",
@@ -249,19 +258,19 @@ const routes: Routes = [
{ {
path: "", path: "",
component: EmergencyAccessComponent, component: EmergencyAccessComponent,
data: { titleId: "emergencyAccess" }, data: { titleId: "emergencyAccess" } satisfies DataProperties,
}, },
{ {
path: ":id", path: ":id",
component: EmergencyAccessViewComponent, component: EmergencyAccessViewComponent,
data: { titleId: "emergencyAccess" }, data: { titleId: "emergencyAccess" } satisfies DataProperties,
}, },
], ],
}, },
{ {
path: "sponsored-families", path: "sponsored-families",
component: SponsoredFamiliesComponent, component: SponsoredFamiliesComponent,
data: { titleId: "sponsoredFamilies" }, data: { titleId: "sponsoredFamilies" } satisfies DataProperties,
}, },
], ],
}, },
@@ -276,7 +285,7 @@ const routes: Routes = [
import("./tools/import/import-web.component").then((mod) => mod.ImportWebComponent), import("./tools/import/import-web.component").then((mod) => mod.ImportWebComponent),
data: { data: {
titleId: "importData", titleId: "importData",
}, } satisfies DataProperties,
}, },
{ {
path: "export", path: "export",
@@ -286,7 +295,7 @@ const routes: Routes = [
{ {
path: "generator", path: "generator",
component: GeneratorComponent, component: GeneratorComponent,
data: { titleId: "generator" }, data: { titleId: "generator" } satisfies DataProperties,
}, },
], ],
}, },