@thirstie/thirstievalidators 0.0.6

package/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [0.0.6](https://github.com/ThirstieAdmin/thirstiejs-monorepo/compare/@thirstie/thirstievalidators@0.0.4...@thirstie/thirstievalidators@0.0.6) (2024-06-24)
+
+**Note:** Version bump only for package @thirstie/thirstievalidators
+
+
+
+
+
+## [0.0.5](https://github.com/ThirstieAdmin/thirstiejs-monorepo/compare/@thirstie/thirstievalidators@0.0.4...@thirstie/thirstievalidators@0.0.5) (2024-06-24)
+
+**Note:** Version bump only for package @thirstie/thirstievalidators
+
+
+
+
+
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+- n/a

package/README.md

@@ -0,0 +1,24 @@
+# validators
+
+TODO:
+- review https://github.com/validatorjs/validator.js
+    - see https://github.com/jameslk/awesome-falsehoods on why it's better to use a standard library
+- probably will use our own email validator
+- others are probably okay?
+
+
+# `passwordcheck`
+
+> TODO: description
+
+## Usage
+
+```
+const passwordcheck = require('passwordcheck');
+
+const pwStrength = passwordcheck('password');
+console.log(pwStrength);
+> 0  # Too Weak
+
+```
+

package/dist/bundle.cjs

@@ -0,0 +1,66 @@
+'use strict';
+
+const BREAKPOINTS = [ 78.0, 52, 0 ];
+const PWSTRENGTH_LABELS = [ 'weak', 'acceptable', 'strong' ];
+
+function passwordcheck (pw) {
+  const pwEntropy = blindEntropy(pw);
+  const strength = entropyMeter(pwEntropy);
+  return {
+    strength,
+    label: PWSTRENGTH_LABELS[strength]
+  };
+}
+
+const blindEntropy = (pw) => {
+  const numberPermutations = /.*[0-9].*/.test(pw) ? 10 : 0;
+  const lowercasePermutations = /.*[a-z].*/.test(pw) ? 26 : 0;
+  const uppercasePermutations = /.*[A-Z].*/.test(pw) ? 26 : 0;
+  const punctuationPermutations = /.*[^a-zA-Z0-9].*/.test(pw) ? 33 : 0;
+
+  const permutations = numberPermutations + lowercasePermutations + uppercasePermutations + punctuationPermutations;
+  const pwLength = pw.length;
+
+  return Math.log2(permutations ** pwLength);
+};
+
+const entropyMeter = (pwEntropy) => {
+  const ndx = BREAKPOINTS.findIndex(e => pwEntropy >= e);
+  // 0 = Too Weak; 1 == Acceptable; 2 = Strong
+  const strength = BREAKPOINTS.length - 1 - ndx;
+  return strength;
+};
+
+// see: https://github.com/ThirstieAdmin/archived-repos/tree/master/thirstie-templates/react-cookbook/src/utils
+// TODO: research using https://www.npmjs.com/package/validator
+const thirstieValidators = {
+  email: (value, options = null) => {
+    const emailRegex = /^(?![.!#$%&'*+/=?^_`{|}~-])(?!.*\.{2})[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]{1,64}@[a-zA-Z0-9]{1,255}\.[a-zA-Z]{2,}$/;
+    // TODO: add domain checks
+    return emailRegex.test(value);
+  },
+  phoneNumber: (value, options = null) => {
+    const phoneRegex = /^((\+1|1)?( |-)?)?(\([2-9][0-9]{2}\)|[2-9][0-9]{2})( |-)?([2-9][0-9]{2}( |-)?[0-9]{4})$/;
+    if (value) {
+      const testValue = String(value).replace(/[^0-9]/g, '');
+      return phoneRegex.test(testValue);
+    }
+    return false;
+  },
+  postalCode: (value, options = null) => {
+    const country = options.countryCode ? options.countryCode.toLowerCase() : 'en-us';
+    const regex = {
+      'en-us': /^\d{5}$/,
+      'en-ca': /^[a-zA-Z]\d[a-zA-Z]\s?\d[a-zA-Z]\d$/
+    }[country];
+    if (regex) {
+      return regex.test(value);
+    }
+    return false;
+  },
+  stateProvinceCode: (value, options = null) => { throw new Error('Not implemented'); },
+  currencyValue: (value, options = null) => { throw new Error('Not implemented'); },
+  passwordStrength: (value, options = null) => { return passwordcheck(value); }
+};
+
+module.exports = thirstieValidators;

package/dist/bundle.iife.js

@@ -0,0 +1 @@
+var thirstievalidators=function(){"use strict";const t=[78,52,0],e=["weak","acceptable","strong"];const n=t=>{const e=(/.*[0-9].*/.test(t)?10:0)+(/.*[a-z].*/.test(t)?26:0)+(/.*[A-Z].*/.test(t)?26:0)+(/.*[^a-zA-Z0-9].*/.test(t)?33:0),n=t.length;return Math.log2(e**n)},r=e=>{const n=t.findIndex((t=>e>=t));return t.length-1-n};return{email:(t,e=null)=>/^(?![.!#$%&'*+/=?^_`{|}~-])(?!.*\.{2})[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]{1,64}@[a-zA-Z0-9]{1,255}\.[a-zA-Z]{2,}$/.test(t),phoneNumber:(t,e=null)=>{const n=/^((\+1|1)?( |-)?)?(\([2-9][0-9]{2}\)|[2-9][0-9]{2})( |-)?([2-9][0-9]{2}( |-)?[0-9]{4})$/;if(t){const e=String(t).replace(/[^0-9]/g,"");return n.test(e)}return!1},postalCode:(t,e=null)=>{const n={"en-us":/^\d{5}$/,"en-ca":/^[a-zA-Z]\d[a-zA-Z]\s?\d[a-zA-Z]\d$/}[e.countryCode?e.countryCode.toLowerCase():"en-us"];return!!n&&n.test(t)},stateProvinceCode:(t,e=null)=>{throw new Error("Not implemented")},currencyValue:(t,e=null)=>{throw new Error("Not implemented")},passwordStrength:(t,o=null)=>function(t){const o=n(t),s=r(o);return{strength:s,label:e[s]}}(t)}}();

package/dist/bundle.mjs

@@ -0,0 +1,64 @@
+const BREAKPOINTS = [ 78.0, 52, 0 ];
+const PWSTRENGTH_LABELS = [ 'weak', 'acceptable', 'strong' ];
+
+function passwordcheck (pw) {
+  const pwEntropy = blindEntropy(pw);
+  const strength = entropyMeter(pwEntropy);
+  return {
+    strength,
+    label: PWSTRENGTH_LABELS[strength]
+  };
+}
+
+const blindEntropy = (pw) => {
+  const numberPermutations = /.*[0-9].*/.test(pw) ? 10 : 0;
+  const lowercasePermutations = /.*[a-z].*/.test(pw) ? 26 : 0;
+  const uppercasePermutations = /.*[A-Z].*/.test(pw) ? 26 : 0;
+  const punctuationPermutations = /.*[^a-zA-Z0-9].*/.test(pw) ? 33 : 0;
+
+  const permutations = numberPermutations + lowercasePermutations + uppercasePermutations + punctuationPermutations;
+  const pwLength = pw.length;
+
+  return Math.log2(permutations ** pwLength);
+};
+
+const entropyMeter = (pwEntropy) => {
+  const ndx = BREAKPOINTS.findIndex(e => pwEntropy >= e);
+  // 0 = Too Weak; 1 == Acceptable; 2 = Strong
+  const strength = BREAKPOINTS.length - 1 - ndx;
+  return strength;
+};
+
+// see: https://github.com/ThirstieAdmin/archived-repos/tree/master/thirstie-templates/react-cookbook/src/utils
+// TODO: research using https://www.npmjs.com/package/validator
+const thirstieValidators = {
+  email: (value, options = null) => {
+    const emailRegex = /^(?![.!#$%&'*+/=?^_`{|}~-])(?!.*\.{2})[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]{1,64}@[a-zA-Z0-9]{1,255}\.[a-zA-Z]{2,}$/;
+    // TODO: add domain checks
+    return emailRegex.test(value);
+  },
+  phoneNumber: (value, options = null) => {
+    const phoneRegex = /^((\+1|1)?( |-)?)?(\([2-9][0-9]{2}\)|[2-9][0-9]{2})( |-)?([2-9][0-9]{2}( |-)?[0-9]{4})$/;
+    if (value) {
+      const testValue = String(value).replace(/[^0-9]/g, '');
+      return phoneRegex.test(testValue);
+    }
+    return false;
+  },
+  postalCode: (value, options = null) => {
+    const country = options.countryCode ? options.countryCode.toLowerCase() : 'en-us';
+    const regex = {
+      'en-us': /^\d{5}$/,
+      'en-ca': /^[a-zA-Z]\d[a-zA-Z]\s?\d[a-zA-Z]\d$/
+    }[country];
+    if (regex) {
+      return regex.test(value);
+    }
+    return false;
+  },
+  stateProvinceCode: (value, options = null) => { throw new Error('Not implemented'); },
+  currencyValue: (value, options = null) => { throw new Error('Not implemented'); },
+  passwordStrength: (value, options = null) => { return passwordcheck(value); }
+};
+
+export { thirstieValidators as default };

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@thirstie/thirstievalidators",
+  "version": "0.0.6",
+  "description": "A collection of data validators used by Thirstiejs modules",
+  "author": "Thirstie, Inc. <technology@thirstie.com>",
+  "license": "MIT",
+  "type": "module",
+  "source": "src/index.js",
+  "main": "dist/bundle.cjs",
+  "module": "dist/bundle.mjs",
+  "exports": {
+    "require": "./dist/bundle.cjs",
+    "import": "./dist/bundle.mjs"
+  },
+  "scripts": {
+    "dev": "rollup -c -w",
+    "build": "rollup -c",
+    "lint": "eslint src/",
+    "test:int": "node --experimental-vm-modules ../../node_modules/.bin/jest int --no-cache",
+    "test:func": "node --experimental-vm-modules ../../node_modules/.bin/jest func --no-cache",
+    "test:coverage": "node --experimental-vm-modules ../../node_modules/.bin/jest unit --coverage",
+    "test": "concurrently \"npm run lint\" \"npm run test:coverage\"",
+    "test:watch": "node --experimental-vm-modules ../../node_modules/.bin/jest unit --watch"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json"
+    ],
+    "testEnvironment": "jsdom",
+    "transform": {}
+  },
+  "gitHead": "b7400621954f917a80a9a530ea89cc2d41aa6373"
+}

package/rollup.config.mjs

@@ -0,0 +1,23 @@
+import resolve from '@rollup/plugin-node-resolve';
+import terser from '@rollup/plugin-terser';
+
+export default {
+  input: 'src/index.js',
+  output: [
+    {
+      file: 'dist/bundle.mjs',
+      format: 'esm'
+    },
+    {
+      file: 'dist/bundle.cjs',
+      format: 'cjs'
+    },
+    {
+      file: 'dist/bundle.iife.js',
+      format: 'iife',
+      name: 'thirstievalidators',
+      plugins: [ terser() ]
+    }
+  ],
+  plugins: [ resolve() ]
+};

package/src/index.js

@@ -0,0 +1,35 @@
+import passwordcheck from './passwordcheck';
+
+// see: https://github.com/ThirstieAdmin/archived-repos/tree/master/thirstie-templates/react-cookbook/src/utils
+// TODO: research using https://www.npmjs.com/package/validator
+const thirstieValidators = {
+  email: (value, options = null) => {
+    const emailRegex = /^(?![.!#$%&'*+/=?^_`{|}~-])(?!.*\.{2})[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]{1,64}@[a-zA-Z0-9]{1,255}\.[a-zA-Z]{2,}$/;
+    // TODO: add domain checks
+    return emailRegex.test(value);
+  },
+  phoneNumber: (value, options = null) => {
+    const phoneRegex = /^((\+1|1)?( |-)?)?(\([2-9][0-9]{2}\)|[2-9][0-9]{2})( |-)?([2-9][0-9]{2}( |-)?[0-9]{4})$/;
+    if (value) {
+      const testValue = String(value).replace(/[^0-9]/g, '');
+      return phoneRegex.test(testValue);
+    }
+    return false;
+  },
+  postalCode: (value, options = null) => {
+    const country = options.countryCode ? options.countryCode.toLowerCase() : 'en-us';
+    const regex = {
+      'en-us': /^\d{5}$/,
+      'en-ca': /^[a-zA-Z]\d[a-zA-Z]\s?\d[a-zA-Z]\d$/
+    }[country];
+    if (regex) {
+      return regex.test(value);
+    }
+    return false;
+  },
+  stateProvinceCode: (value, options = null) => { throw new Error('Not implemented'); },
+  currencyValue: (value, options = null) => { throw new Error('Not implemented'); },
+  passwordStrength: (value, options = null) => { return passwordcheck(value); }
+};
+
+export default thirstieValidators;

package/src/passwordcheck.js

@@ -0,0 +1,32 @@
+const BREAKPOINTS = [ 78.0, 52, 0 ];
+const PWSTRENGTH_LABELS = [ 'weak', 'acceptable', 'strong' ];
+
+function passwordcheck (pw) {
+  const pwEntropy = blindEntropy(pw);
+  const strength = entropyMeter(pwEntropy);
+  return {
+    strength,
+    label: PWSTRENGTH_LABELS[strength]
+  };
+}
+
+const blindEntropy = (pw) => {
+  const numberPermutations = /.*[0-9].*/.test(pw) ? 10 : 0;
+  const lowercasePermutations = /.*[a-z].*/.test(pw) ? 26 : 0;
+  const uppercasePermutations = /.*[A-Z].*/.test(pw) ? 26 : 0;
+  const punctuationPermutations = /.*[^a-zA-Z0-9].*/.test(pw) ? 33 : 0;
+
+  const permutations = numberPermutations + lowercasePermutations + uppercasePermutations + punctuationPermutations;
+  const pwLength = pw.length;
+
+  return Math.log2(permutations ** pwLength);
+};
+
+const entropyMeter = (pwEntropy) => {
+  const ndx = BREAKPOINTS.findIndex(e => pwEntropy >= e);
+  // 0 = Too Weak; 1 == Acceptable; 2 = Strong
+  const strength = BREAKPOINTS.length - 1 - ndx;
+  return strength;
+};
+
+export default passwordcheck;

package/tests/func/validators.func.test.js

@@ -0,0 +1,3 @@
+describe('Not Implemented', () => {
+  test.todo('please pass');
+});

package/tests/int/validators.int.test.js

@@ -0,0 +1,3 @@
+describe('Not Implemented', () => {
+  test.todo('please pass');
+});

package/tests/unit/passwordcheck.unit.test.js

@@ -0,0 +1,23 @@
+import thirstieValidators from '../../src/index.js';
+
+describe('passwordcheck', () => {
+  it('should return password strength', () => {
+    const fixtures = [
+      {
+        testValue: '1235',
+        strength: 0,
+        label: 'weak'
+      },
+      {
+        testValue: 'Super-Str0ng-Long-Secret',
+        strength: 2,
+        label: 'strong'
+      }
+    ];
+    fixtures.forEach((fixture) => {
+      const pwStrength = thirstieValidators.passwordStrength(fixture.testValue);
+      expect(pwStrength.strength).toBe(fixture.strength);
+      expect(pwStrength.label).toBe(fixture.label);
+    });
+  });
+});

package/tests/unit/validators.email.unit.test.js

@@ -0,0 +1,31 @@
+import thirstieValidators from '../../src/index.js';
+
+describe('email validation', () => {
+  /* see:
+  * https://github.com/jameslk/awesome-falsehoods
+  * https://stackoverflow.com/questions/3844431/are-email-addresses-allowed-to-contain-non-alphanumeric-characters
+  * https://haacked.com/archive/2007/08/21/i-knew-how-to-validate-an-email-address-until-i.aspx/
+  */
+  it('should return true for valid emails', () => {
+    const fixtures = [
+      'localpart@domainname.tld',
+      'localpart+other@domainname.faketld',
+      'first.last@example.com'
+    ];
+    fixtures.forEach((fixture) => {
+      const validationCheck = thirstieValidators.email(fixture);
+      expect(validationCheck).toBe(true);
+    });
+  });
+  it('should return false for invalid emails', () => {
+    const fixtures = [
+      'localpart@domainname',
+      'first.läst.unicode@domainname.faketld',
+      'first.last@example.c'
+    ];
+    fixtures.forEach((fixture) => {
+      const validationCheck = thirstieValidators.email(fixture);
+      expect(validationCheck).toBe(false);
+    });
+  });
+});