[PM-3609] [Tech-Debt] Add types to password and username generator (#6090)

* Create and use GeneratorOptions

Selection between `password`and `username`

* Use PasswordGeneratorOptions

* Declare and use UsernameGeneratorOptions

libs/angular/src/tools/generator/components/generator.component.ts

@@ -8,8 +8,15 @@ import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.servic
 import { LogService } from "@bitwarden/common/platform/abstractions/log.service";
 import { PlatformUtilsService } from "@bitwarden/common/platform/abstractions/platform-utils.service";
 import { StateService } from "@bitwarden/common/platform/abstractions/state.service";
-import { PasswordGenerationServiceAbstraction } from "@bitwarden/common/tools/generator/password";
-import { UsernameGenerationServiceAbstraction } from "@bitwarden/common/tools/generator/username";
+import { GeneratorOptions } from "@bitwarden/common/tools/generator/generator-options";
+import {
+  PasswordGenerationServiceAbstraction,
+  PasswordGeneratorOptions,
+} from "@bitwarden/common/tools/generator/password";
+import {
+  UsernameGenerationServiceAbstraction,
+  UsernameGeneratorOptions,
+} from "@bitwarden/common/tools/generator/username";
 
 @Directive()
 export class GeneratorComponent implements OnInit {
@@ -24,8 +31,8 @@ export class GeneratorComponent implements OnInit {
   subaddressOptions: any[];
   catchallOptions: any[];
   forwardOptions: EmailForwarderOptions[];
-  usernameOptions: any = {};
-  passwordOptions: any = {};
+  usernameOptions: UsernameGeneratorOptions = {};
+  passwordOptions: PasswordGeneratorOptions = {};
   username = "-";
   password = "-";
   showOptions = false;
@@ -118,7 +125,7 @@ export class GeneratorComponent implements OnInit {
   }
 
   async typeChanged() {
-    await this.stateService.setGeneratorOptions({ type: this.type });
+    await this.stateService.setGeneratorOptions({ type: this.type } as GeneratorOptions);
     if (this.regenerateWithoutButtonPress()) {
       await this.regenerate();
     }

libs/common/src/platform/abstractions/state.service.ts

@@ -13,7 +13,9 @@ import { BiometricKey } from "../../auth/types/biometric-key";
 import { KdfType, ThemeType, UriMatchType } from "../../enums";
 import { EventData } from "../../models/data/event.data";
 import { WindowState } from "../../models/domain/window-state";
-import { GeneratedPasswordHistory } from "../../tools/generator/password";
+import { GeneratorOptions } from "../../tools/generator/generator-options";
+import { GeneratedPasswordHistory, PasswordGeneratorOptions } from "../../tools/generator/password";
+import { UsernameGeneratorOptions } from "../../tools/generator/username";
 import { SendData } from "../../tools/send/models/data/send.data";
 import { SendView } from "../../tools/send/models/view/send.view";
 import { CipherData } from "../../vault/models/data/cipher.data";
@@ -439,12 +441,18 @@ export abstract class StateService<T extends Account = Account> {
     value: { [id: string]: OrganizationData },
     options?: StorageOptions
   ) => Promise<void>;
-  getPasswordGenerationOptions: (options?: StorageOptions) => Promise<any>;
-  setPasswordGenerationOptions: (value: any, options?: StorageOptions) => Promise<void>;
-  getUsernameGenerationOptions: (options?: StorageOptions) => Promise<any>;
-  setUsernameGenerationOptions: (value: any, options?: StorageOptions) => Promise<void>;
-  getGeneratorOptions: (options?: StorageOptions) => Promise<any>;
-  setGeneratorOptions: (value: any, options?: StorageOptions) => Promise<void>;
+  getPasswordGenerationOptions: (options?: StorageOptions) => Promise<PasswordGeneratorOptions>;
+  setPasswordGenerationOptions: (
+    value: PasswordGeneratorOptions,
+    options?: StorageOptions
+  ) => Promise<void>;
+  getUsernameGenerationOptions: (options?: StorageOptions) => Promise<UsernameGeneratorOptions>;
+  setUsernameGenerationOptions: (
+    value: UsernameGeneratorOptions,
+    options?: StorageOptions
+  ) => Promise<void>;
+  getGeneratorOptions: (options?: StorageOptions) => Promise<GeneratorOptions>;
+  setGeneratorOptions: (value: GeneratorOptions, options?: StorageOptions) => Promise<void>;
   /**
    * Gets the user's Pin, encrypted by the user key
    */

libs/common/src/platform/models/domain/account.ts

@@ -14,7 +14,12 @@ import { TrustedDeviceUserDecryptionOption } from "../../../auth/models/domain/u
 import { IdentityTokenResponse } from "../../../auth/models/response/identity-token.response";
 import { KdfType, UriMatchType } from "../../../enums";
 import { EventData } from "../../../models/data/event.data";
-import { GeneratedPasswordHistory } from "../../../tools/generator/password";
+import { GeneratorOptions } from "../../../tools/generator/generator-options";
+import {
+  GeneratedPasswordHistory,
+  PasswordGeneratorOptions,
+} from "../../../tools/generator/password";
+import { UsernameGeneratorOptions } from "../../../tools/generator/username/username-generation-options";
 import { SendData } from "../../../tools/send/models/data/send.data";
 import { SendView } from "../../../tools/send/models/view/send.view";
 import { DeepJsonify } from "../../../types/deep-jsonify";
@@ -235,9 +240,9 @@ export class AccountSettings {
   equivalentDomains?: any;
   minimizeOnCopyToClipboard?: boolean;
   neverDomains?: { [id: string]: any };
-  passwordGenerationOptions?: any;
-  usernameGenerationOptions?: any;
-  generatorOptions?: any;
+  passwordGenerationOptions?: PasswordGeneratorOptions;
+  usernameGenerationOptions?: UsernameGeneratorOptions;
+  generatorOptions?: GeneratorOptions;
   pinKeyEncryptedUserKey?: EncryptedString;
   pinKeyEncryptedUserKeyEphemeral?: EncryptedString;
   protectedPin?: string;

libs/common/src/platform/services/state.service.ts

@@ -22,7 +22,9 @@ import { VaultTimeoutAction } from "../../enums/vault-timeout-action.enum";
 import { EventData } from "../../models/data/event.data";
 import { WindowState } from "../../models/domain/window-state";
 import { migrate } from "../../state-migrations";
-import { GeneratedPasswordHistory } from "../../tools/generator/password";
+import { GeneratorOptions } from "../../tools/generator/generator-options";
+import { GeneratedPasswordHistory, PasswordGeneratorOptions } from "../../tools/generator/password";
+import { UsernameGeneratorOptions } from "../../tools/generator/username";
 import { SendData } from "../../tools/send/models/data/send.data";
 import { SendView } from "../../tools/send/models/view/send.view";
 import { CipherData } from "../../vault/models/data/cipher.data";
@@ -2367,13 +2369,16 @@ export class StateService<
     );
   }
 
-  async getPasswordGenerationOptions(options?: StorageOptions): Promise<any> {
+  async getPasswordGenerationOptions(options?: StorageOptions): Promise<PasswordGeneratorOptions> {
     return (
       await this.getAccount(this.reconcileOptions(options, await this.defaultOnDiskLocalOptions()))
     )?.settings?.passwordGenerationOptions;
   }
 
-  async setPasswordGenerationOptions(value: any, options?: StorageOptions): Promise<void> {
+  async setPasswordGenerationOptions(
+    value: PasswordGeneratorOptions,
+    options?: StorageOptions
+  ): Promise<void> {
     const account = await this.getAccount(
       this.reconcileOptions(options, await this.defaultOnDiskLocalOptions())
     );
@@ -2384,13 +2389,16 @@ export class StateService<
     );
   }
 
-  async getUsernameGenerationOptions(options?: StorageOptions): Promise<any> {
+  async getUsernameGenerationOptions(options?: StorageOptions): Promise<UsernameGeneratorOptions> {
     return (
       await this.getAccount(this.reconcileOptions(options, await this.defaultOnDiskLocalOptions()))
     )?.settings?.usernameGenerationOptions;
   }
 
-  async setUsernameGenerationOptions(value: any, options?: StorageOptions): Promise<void> {
+  async setUsernameGenerationOptions(
+    value: UsernameGeneratorOptions,
+    options?: StorageOptions
+  ): Promise<void> {
     const account = await this.getAccount(
       this.reconcileOptions(options, await this.defaultOnDiskLocalOptions())
     );
@@ -2401,13 +2409,13 @@ export class StateService<
     );
   }
 
-  async getGeneratorOptions(options?: StorageOptions): Promise<any> {
+  async getGeneratorOptions(options?: StorageOptions): Promise<GeneratorOptions> {
     return (
       await this.getAccount(this.reconcileOptions(options, await this.defaultOnDiskLocalOptions()))
     )?.settings?.generatorOptions;
   }
 
-  async setGeneratorOptions(value: any, options?: StorageOptions): Promise<void> {
+  async setGeneratorOptions(value: GeneratorOptions, options?: StorageOptions): Promise<void> {
     const account = await this.getAccount(
       this.reconcileOptions(options, await this.defaultOnDiskLocalOptions())
     );

libs/common/src/tools/generator/generator-options.ts

@@ -0,0 +1,3 @@
+export type GeneratorOptions = {
+  type?: "password" | "username";
+};

libs/common/src/tools/generator/password/index.ts

@@ -1,3 +1,4 @@
+export { PasswordGeneratorOptions } from "./password-generator-options";
 export { PasswordGenerationServiceAbstraction } from "./password-generation.service.abstraction";
 export { PasswordGenerationService } from "./password-generation.service";
 export { GeneratedPasswordHistory } from "./generated-password-history";

libs/common/src/tools/generator/username/index.ts

@@ -1,2 +1,3 @@
+export { UsernameGeneratorOptions } from "./username-generation-options";
 export { UsernameGenerationServiceAbstraction } from "./username-generation.service.abstraction";
 export { UsernameGenerationService } from "./username-generation.service";

libs/common/src/tools/generator/username/username-generation-options.ts

@@ -0,0 +1,19 @@
+export type UsernameGeneratorOptions = {
+  type?: "word" | "subaddress" | "catchall" | "forwarded";
+  wordCapitalize?: boolean;
+  wordIncludeNumber?: boolean;
+  subaddressType?: "random" | "website-name";
+  subaddressEmail?: string;
+  catchallType?: "random" | "website-name";
+  catchallDomain?: string;
+  website?: string;
+  forwardedService?: string;
+  forwardedAnonAddyApiToken?: string;
+  forwardedAnonAddyDomain?: string;
+  forwardedDuckDuckGoToken?: string;
+  forwardedFirefoxApiToken?: string;
+  forwardedFastmailApiToken?: string;
+  forwardedForwardEmailApiToken?: string;
+  forwardedForwardEmailDomain?: string;
+  forwardedSimpleLoginApiKey?: string;
+};

libs/common/src/tools/generator/username/username-generation.service.abstraction.ts

@@ -1,9 +1,11 @@
+import { UsernameGeneratorOptions } from "./username-generation-options";
+
 export abstract class UsernameGenerationServiceAbstraction {
-  generateUsername: (options: any) => Promise<string>;
-  generateWord: (options: any) => Promise<string>;
-  generateSubaddress: (options: any) => Promise<string>;
-  generateCatchall: (options: any) => Promise<string>;
-  generateForwarded: (options: any) => Promise<string>;
-  getOptions: () => Promise<any>;
-  saveOptions: (options: any) => Promise<void>;
+  generateUsername: (options: UsernameGeneratorOptions) => Promise<string>;
+  generateWord: (options: UsernameGeneratorOptions) => Promise<string>;
+  generateSubaddress: (options: UsernameGeneratorOptions) => Promise<string>;
+  generateCatchall: (options: UsernameGeneratorOptions) => Promise<string>;
+  generateForwarded: (options: UsernameGeneratorOptions) => Promise<string>;
+  getOptions: () => Promise<UsernameGeneratorOptions>;
+  saveOptions: (options: UsernameGeneratorOptions) => Promise<void>;
 }

libs/common/src/tools/generator/username/username-generation.service.ts

@@ -13,9 +13,10 @@ import {
   ForwarderOptions,
   SimpleLoginForwarder,
 } from "./email-forwarders";
+import { UsernameGeneratorOptions } from "./username-generation-options";
 import { UsernameGenerationServiceAbstraction } from "./username-generation.service.abstraction";
 
-const DefaultOptions = {
+const DefaultOptions: UsernameGeneratorOptions = {
   type: "word",
   wordCapitalize: true,
   wordIncludeNumber: true,
@@ -33,7 +34,7 @@ export class UsernameGenerationService implements UsernameGenerationServiceAbstr
     private apiService: ApiService
   ) {}
 
-  generateUsername(options: any): Promise<string> {
+  generateUsername(options: UsernameGeneratorOptions): Promise<string> {
     if (options.type === "catchall") {
       return this.generateCatchall(options);
     } else if (options.type === "subaddress") {
@@ -45,7 +46,7 @@ export class UsernameGenerationService implements UsernameGenerationServiceAbstr
     }
   }
 
-  async generateWord(options: any): Promise<string> {
+  async generateWord(options: UsernameGeneratorOptions): Promise<string> {
     const o = Object.assign({}, DefaultOptions, options);
 
     if (o.wordCapitalize == null) {
@@ -67,7 +68,7 @@ export class UsernameGenerationService implements UsernameGenerationServiceAbstr
     return word;
   }
 
-  async generateSubaddress(options: any): Promise<string> {
+  async generateSubaddress(options: UsernameGeneratorOptions): Promise<string> {
     const o = Object.assign({}, DefaultOptions, options);
 
     const subaddressEmail = o.subaddressEmail;
@@ -94,7 +95,7 @@ export class UsernameGenerationService implements UsernameGenerationServiceAbstr
     return emailBeginning + "+" + subaddressString + "@" + emailEnding;
   }
 
-  async generateCatchall(options: any): Promise<string> {
+  async generateCatchall(options: UsernameGeneratorOptions): Promise<string> {
     const o = Object.assign({}, DefaultOptions, options);
 
     if (o.catchallDomain == null || o.catchallDomain === "") {
@@ -113,7 +114,7 @@ export class UsernameGenerationService implements UsernameGenerationServiceAbstr
     return startString + "@" + o.catchallDomain;
   }
 
-  async generateForwarded(options: any): Promise<string> {
+  async generateForwarded(options: UsernameGeneratorOptions): Promise<string> {
     const o = Object.assign({}, DefaultOptions, options);
 
     if (o.forwardedService == null) {
@@ -152,7 +153,7 @@ export class UsernameGenerationService implements UsernameGenerationServiceAbstr
     return forwarder.generate(this.apiService, forwarderOptions);
   }
 
-  async getOptions(): Promise<any> {
+  async getOptions(): Promise<UsernameGeneratorOptions> {
     let options = await this.stateService.getUsernameGenerationOptions();
     if (options == null) {
       options = Object.assign({}, DefaultOptions);
@@ -163,7 +164,7 @@ export class UsernameGenerationService implements UsernameGenerationServiceAbstr
     return options;
   }
 
-  async saveOptions(options: any) {
+  async saveOptions(options: UsernameGeneratorOptions) {
     await this.stateService.setUsernameGenerationOptions(options);
   }