Merge pull request #45 from deanilvincent/releases/v2.0.3

Releases/v2.0.3

README.md

@@ -16,7 +16,9 @@ A simple way to check that password strength of a certain passphrase. A password
 
 ## Setup & Basic Usage
 ```
-const passwordStrength = require('check-password-strength')
+const { passwordStrength } = require('check-password-strength')
+// OR
+import { passwordStrength } from 'check-password-strength'
 
 console.log(passwordStrength('asdfasdf').value)
 // Too weak (It will return Too weak if the value doesn't match the RegEx conditions)
@@ -125,7 +127,6 @@ The minDiversity and minLength parameters of the first element cannot be overrid
 ```
 passwordStrength('myPassword', yourCustomOptions)
 ```
-
 ### RegEx 
 
 **Strong**
@@ -151,6 +152,9 @@ passwordStrength('myPassword', yourCustomOptions)
 | (?=.{8,}) | The string must be eight characters or longer for Medium strength |
 | (?=.{6,}) | Mininum of 6 characters for Weak strength |
 
+## TypeScript type declarations ☑ 
+Available starting version `v2.0.3` and above. (Thanks to [@Mesoptier!](https://github.com/Mesoptier))
+
 ## Other resources
 
 ##### For .NET Project

azure-pipelines.yml

@@ -0,0 +1,22 @@
+# Node.js
+# Build a general Node.js project with npm.
+# Add steps that analyze code, save build artifacts, deploy, and more:
+# https://docs.microsoft.com/azure/devops/pipelines/languages/javascript
+
+trigger:
+- master
+- releases/*
+
+pool:
+  vmImage: 'ubuntu-latest'
+
+steps:
+- task: NodeTool@0
+  inputs:
+    versionSpec: '10.x'
+  displayName: 'Install Node.js'
+
+- script: |
+    npm install
+    npm test
+  displayName: 'npm install and test'

index.d.ts

@@ -0,0 +1,30 @@
+export interface Option<V> {
+  id: number;
+  value: V;
+  minDiversity: number;
+  minLength: number;
+}
+
+export interface FirstOption<V> extends Option<V> {
+  minDiversity: 0;
+  minLength: 0;
+}
+
+export type Options<V> = [FirstOption<V>, ...Option<V>[]];
+
+export const defaultOptions: Options<string>;
+
+export type DiversityType = "lowercase" | "uppercase" | "symbol" | "number";
+
+export interface Result<V> {
+  id: number;
+  value: V;
+  contains: DiversityType[];
+  length: number;
+}
+
+export function passwordStrength<V = string>(
+  password: string,
+  options?: Options<V>,
+  allowedSymbols?: string,
+): Result<V>;

index.js

@@ -25,6 +25,8 @@ const defaultOptions = [
   }
 ]
 
+const escapeRegExp = (string) => string.replace(/[-.*+?^${}()|[\]\\]/g, '\\$&')
+
 const passwordStrength = (password, options = defaultOptions, allowedSymbols="!@#$%^&*") => {
 
   let passwordCopy = password || ''
@@ -49,7 +51,7 @@ const passwordStrength = (password, options = defaultOptions, allowedSymbols="!@
 
   if (allowedSymbols) {
     rules.push({
-      regex: `[${allowedSymbols}]`,
+      regex: `[${escapeRegExp(allowedSymbols)}]`,
       message: 'symbol'
     })
   }

index.test-d.ts

@@ -0,0 +1,68 @@
+import { expectType } from "tsd";
+import { DiversityType, passwordStrength } from "./index";
+
+// Test result types
+expectType<string>(passwordStrength("asdfasdf").value);
+expectType<number>(passwordStrength("asdfasdf").id);
+expectType<number>(passwordStrength("asdfasdf").length);
+expectType<DiversityType[]>(passwordStrength("asdfasdf").contains);
+
+// Test options with custom value (string)
+expectType<string>(
+  passwordStrength("asdfasdf", [
+    {
+      id: 0,
+      value: "Too weak",
+      minDiversity: 0,
+      minLength: 0,
+    },
+    {
+      id: 1,
+      value: "Weak",
+      minDiversity: 2,
+      minLength: 6,
+    },
+    {
+      id: 2,
+      value: "Medium",
+      minDiversity: 4,
+      minLength: 8,
+    },
+    {
+      id: 3,
+      value: "Strong",
+      minDiversity: 4,
+      minLength: 10,
+    },
+  ]).value
+);
+
+// Test options with custom value (object)
+expectType<{ message: string, color: string }>(
+  passwordStrength("asdfasdf", [
+    {
+      id: 0,
+      value: {message: "Too weak", color: "red"},
+      minDiversity: 0,
+      minLength: 0,
+    },
+    {
+      id: 1,
+      value: {message: "Weak", color: "orange"},
+      minDiversity: 2,
+      minLength: 6,
+    },
+    {
+      id: 2,
+      value: {message: "Medium", color: "yellow"},
+      minDiversity: 4,
+      minLength: 8,
+    },
+    {
+      id: 3,
+      value: {message: "Strong", color: "green"},
+      minDiversity: 4,
+      minLength: 10,
+    },
+  ]).value
+);

index.test.js

@@ -246,3 +246,23 @@ it("[overridden allowedSymbols] Should contains symbols if the password have one
   expect(contains).toEqual(expect.not.arrayContaining(['number']));
   expect(contains).toEqual(expect.arrayContaining(['symbol']));
 });
+
+it("[overridden allowedSymbols] Should contains symbols if allowedSymbol is a special regex char", () => {
+  expect(app("[", undefined, '[]').contains).toEqual(expect.arrayContaining(['symbol']));
+  expect(app("]", undefined, '[]').contains).toEqual(expect.arrayContaining(['symbol']));
+  expect(app("(", undefined, '()').contains).toEqual(expect.arrayContaining(['symbol']));
+  expect(app(")", undefined, '()').contains).toEqual(expect.arrayContaining(['symbol']));
+  expect(app("{", undefined, '{}').contains).toEqual(expect.arrayContaining(['symbol']));
+  expect(app("}", undefined, '{}').contains).toEqual(expect.arrayContaining(['symbol']));
+  expect(app("*", undefined, '*').contains).toEqual(expect.arrayContaining(['symbol']));
+  expect(app("^", undefined, '^').contains).toEqual(expect.arrayContaining(['symbol']));
+  expect(app("/", undefined, '/').contains).toEqual(expect.arrayContaining(['symbol']));
+  expect(app("\\", undefined, '\\').contains).toEqual(expect.arrayContaining(['symbol']));
+  expect(app("-", undefined, '-').contains).toEqual(expect.arrayContaining(['symbol']));
+  expect(app("=", undefined, '=').contains).toEqual(expect.arrayContaining(['symbol']));
+  expect(app("?", undefined, '?').contains).toEqual(expect.arrayContaining(['symbol']));
+  expect(app("+", undefined, '+').contains).toEqual(expect.arrayContaining(['symbol']));
+  expect(app(".", undefined, '.').contains).toEqual(expect.arrayContaining(['symbol']));
+  expect(app("$", undefined, '$').contains).toEqual(expect.arrayContaining(['symbol']));
+  expect(app("[](){}*^/\\-=?+.$", undefined, '[](){}*^/\\-=?+.$').contains).toEqual(expect.arrayContaining(['symbol']));
+});