Define internal password policy typings

Author: ch5zzy

packages/auth/src/model/password_policy.ts

@@ -0,0 +1,108 @@
+/**
+ * @license
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { PasswordPolicy, PasswordValidationStatus } from "./public_types";
+
+/**
+ * Custom strength options supported in the password policy.
+ */
+export interface PasswordPolicyCustomStrengthOptions {
+  /**
+   * Minimum password length.
+   */
+  readonly minPasswordLength?: number;
+  /**
+   * Maximum password length.
+   */
+  readonly maxPasswordLength?: number;
+  /**
+   * Whether the password should contain a lowercase letter.
+   */
+  readonly containsLowercaseLetter?: boolean;
+  /**
+   * Whether the password should contain an uppercase letter.
+   */
+  readonly containsUppercaseLetter?: boolean;
+  /**
+   * Whether the password should contain a numeric character.
+   */
+  readonly containsNumericCharacter?: boolean;
+  /**
+   * Whether the password should contain a non-alphanumeric character.
+   */
+  readonly containsNonAlphanumericCharacter?: boolean;
+}
+
+/**
+ * Internal typing of password policy that includes the schema version and methods for
+ * validating that a password meets the policy. The developer does not need access to
+ * these properties and methods, so they are excluded from the public typing.
+ *
+ * @internal
+ */
+export interface PasswordPolicyInternal extends PasswordPolicy {
+  /**
+   * Schema version of the password policy.
+   */
+  readonly schemaVersion: number;
+  /**
+   * Validates the password against the policy.
+   * @param password Password to validate.
+   */
+  validatePassword(password: string): PasswordValidationStatus;
+}
+
+/**
+ * Internal typing of password validation status that is modifiable. This allows us to
+ * construct the validation status before returning it
+ * 
+ * @internal
+ */
+export interface PasswordValidationStatusInternal extends PasswordValidationStatus {
+  /**
+   * Whether the password meets all requirements.
+   */
+  isValid: boolean;
+  /**
+   * Whether the password meets the minimum password length.
+   */
+  meetsMinPasswordLength?: boolean;
+  /**
+   * Whether the password meets the maximum password length.
+   */
+  meetsMaxPasswordLength?: boolean;
+  /**
+   * Whether the password contains a lowercase letter, if required.
+   */
+  containsLowercaseLetter?: boolean;
+  /**
+   * Whether the password contains an uppercase letter, if required.
+   */
+  containsUppercaseLetter?: boolean;
+  /**
+   * Whether the password contains a numeric character, if required.
+   */
+  containsNumericCharacter?: boolean;
+  /**
+   * Whether the password contains a non-alphanumeric character, if required.
+   */
+  containsNonAlphanumericCharacter?: boolean;
+  /**
+   * The policy used to validate the password.
+   */
+  passwordPolicy: PasswordPolicy;
+}

packages/auth/src/model/public_types.ts

@@ -32,6 +32,7 @@ import {
   OperationType as OperationTypeMap,
   ActionCodeOperation as ActionCodeOperationMap
 } from './enum_maps';
+import { PasswordPolicyCustomStrengthOptions } from './password_policy';
 
 export { CompleteFn, ErrorFn, NextFn, Unsubscribe };
 
@@ -1262,36 +1263,11 @@ export interface PasswordPolicy {
   /**
    * Requirements enforced by this password policy.
    */
-  readonly customStrengthOptions: {
-    /**
-     * Minimum password length.
-     */
-    readonly minPasswordLength?: number;
-    /**
-     * Maximum password length.
-     */
-    readonly maxPasswordLength?: number;
-    /**
-     * Whether the password should contain a lowercase letter.
-     */
-    readonly containsLowercaseLetter?: boolean;
-    /**
-     * Whether the password should contain an uppercase letter.
-     */
-    readonly containsUppercaseLetter?: boolean;
-    /**
-     * Whether the password should contain a numeric character.
-     */
-    readonly containsNumericCharacter?: boolean;
-    /**
-     * Whether the password should contain a non-alphanumeric character.
-     */
-    readonly containsNonAlphanumericCharacter?: boolean;
-  };
+  readonly customStrengthOptions: PasswordPolicyCustomStrengthOptions;
   /**
    * List of characters that are considered non-alphanumeric during validation.
    */
-  readonly allowedNonAlphanumericCharacters: string[];
+  readonly allowedNonAlphanumericCharacters?: string[];
 }
 
 /**