auth0-password-policies 1.1.1 → 2.0.0

package/README.md

@@ -36,8 +36,8 @@ const { createRulesFromOptions } = require('auth0-password-policies');
 
 const passwordOptions = {
   character_types: ["uppercase","lowercase","number","special"],
-  "require_3of4_character_types": true,
-  identical_characters: "disallow"
+  character_type_rule: "three_of_four",
+  identical_characters: "block"
 };
 
 const rules = createRulesFromOptions(passwordOptions);

package/index.js

@@ -46,8 +46,8 @@ const CHARACTER_TYPES = {
  * @typedef {Object} PasswordOptions
  * @property {number} [min_length=15] - Minimum password length (1-72)
  * @property {Array<'uppercase'|'lowercase'|'number'|'special'>} [character_types=[]] - Required character types
- * @property {boolean} [require_3of4_character_types=false] - Whether to require 3 out of 4 character types (requires all 4 types to be specified)
- * @property {'allow'|'disallow'} [identical_characters='disallow'] - Whether to allow >2 identical consecutive characters
+ * @property {'all'|'three_of_four'} [character_type_rule='all'] - How many character types are required
+ * @property {'allow'|'block'} [identical_characters='allow'] - Whether to allow >2 identical consecutive characters
  */
 
 /**
@@ -58,8 +58,8 @@ const CHARACTER_TYPES = {
 const DEFAULT_PASSWORD_OPTIONS = {
   min_length: 15,
   character_types: [],
-  require_3of4_character_types: false,
-  identical_characters: "disallow",
+  character_type_rule: "all",
+  identical_characters: "allow",
 };
 
 /**
@@ -76,7 +76,7 @@ function createRulesFromOptions(options = {}) {
   const {
     min_length: minLength,
     character_types: requiredTypes,
-    require_3of4_character_types: require3of4,
+    character_type_rule: characterTypeRule,
     identical_characters: identicalChars,
   } = { ...DEFAULT_PASSWORD_OPTIONS, ...options };
 
@@ -88,7 +88,8 @@ function createRulesFromOptions(options = {}) {
   // Handle min_length
   rules.length = { minLength: minLength };
 
-  // Validate require_3of4_character_types prerequisite
+  // Validate '3 of 4' prerequisite
+  const require3of4 = characterTypeRule === "three_of_four";
   if (require3of4) {
     const hasAllFourTypes = Object.values(CHARACTER_TYPES).every(function (
       type
@@ -98,7 +99,7 @@ function createRulesFromOptions(options = {}) {
 
     if (!hasAllFourTypes) {
       throw new Error(
-        `require_3of4_character_types can only be used when all four character types (${Object.values(
+        `'three_of_four' character_type_rule can only be used when all four character types (${Object.values(
           CHARACTER_TYPES
         ).join(", ")}) are selected`
       );
@@ -135,7 +136,7 @@ function createRulesFromOptions(options = {}) {
     }
   }
 
-  if (identicalChars === "disallow") {
+  if (identicalChars === "block") {
     rules.identicalChars = { max: 2 };
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auth0-password-policies",
-  "version": "1.1.1",
+  "version": "2.0.0",
   "main": "index.js",
   "repository": "git@github.com:auth0/auth0-password-policies.git",
   "author": "Shaun Starsprung <shaun.starsprung@auth0.com>",

package/test/test.js

@@ -76,11 +76,11 @@ describe("password policies", function () {
       });
     });
 
-    describe("require_3of4_character_types", function () {
-      it("should enforce 3 out of 4 character types when all 4 types are specified", function () {
+    describe("character_type_rule", function () {
+      it("when set to 'three_of_four', should enforce 3 out of 4 character types when all 4 types are specified", function () {
         const auth0Config = {
           character_types: ["lowercase", "uppercase", "number", "special"],
-          require_3of4_character_types: true,
+          character_type_rule: "three_of_four",
           identical_characters: "allow",
           min_length: 3,
         };
@@ -100,15 +100,15 @@ describe("password policies", function () {
         });
       });
 
-      it("should throw an error when require_3of4_character_types is used without all 4 character types", function () {
+      it("when set to 'three_of_four', should throw an error when all 4 character types are NOT specified", function () {
         expect(function () {
           const auth0Config = {
             character_types: ["lowercase", "uppercase"],
-            require_3of4_character_types: true,
+            character_type_rule: "three_of_four",
           };
           createRulesFromOptions(auth0Config);
         }).toThrow(
-          "require_3of4_character_types can only be used when all four character types (lowercase, uppercase, number, special) are selected"
+          "'three_of_four' character_type_rule can only be used when all four character types (lowercase, uppercase, number, special) are selected"
         );
       });
     });
@@ -116,7 +116,7 @@ describe("password policies", function () {
     describe("identical_characters", function () {
       it("should disallow more than 2 identical characters when specified", function () {
         const auth0Config = {
-          identical_characters: "disallow",
+          identical_characters: "block",
         };
         const rules = createRulesFromOptions(auth0Config);
         expect(rules).toEqual({
@@ -150,9 +150,6 @@ describe("password policies", function () {
           length: {
             minLength: 15,
           },
-          identicalChars: {
-            max: 2,
-          },
         });
       });