simply_valid/changelog.md

A simple data driven validation utility library

# Change Log

## v5.0.0

### BREAKING CHANGES

- `story` is no longer a value included with the return, it is just an object.
  - `simply_valid` will return on the first failure with the information about that failure
- Importing/requiring the module is a bit different please see the README for info
  - Schema will **No longer** take string values, you must import and pass the functions you want to use.
    - Why? This offers a cleaner and more direct experience, less the library has to worry about so less overhead!
    - This also opens the door for _you_ to be able to pass in your own functionality!
- Auto recursion dropped for nested complex data
  - Simply recall validate within an object to support nested objects
  - example:
  ```js
  const data = {
    a: 1,
    b: {
      c: 3
    }
  }
  const schema = {
    a: isNumber,
    b: validate({ c: isNumber })
  }

  validate({ schema }, data)
  ```
- Changed how `isBetween` params work instead of an object it expects 2 numbers now
  - Example: `isBetween(min, max, value)`

#### Removed

- `isVisaCard`: Should lean more towards relying on proper CC libs
- `isVisPanCard`: Should lean more towards relying on proper CC libs
- `isAmexCard`: Should lean more towards relying on proper CC libs
- `isMasterCard`: Should lean more towards relying on proper CC libs
- `isDiscoverCard`: Should lean more towards relying on proper CC libs
- `creditCard`: Since the above were also removed
- `meetsCVN`: Lean more towards proper CC validation
- `meetsCVNAmex`: Lean more towards proper CC validation
- `cvn`: Since the two cvn methods were removed
- `isNotToShort`: Use `isAboveMin` with the length of a value
- `isNotToLong`: Use `isBelowMax` with the length of a value
- `isCorrectLength`: Use `isBetween` with the length of a value
- `meetsMinMax`: Use `isBetween`

### Improved

- Converted more functionality to use Kyanite
- Re wrote how the app handles all validation for better performance

## v4.0.2

### New

- Added Kyanite library to help with utility functionality

### Improved

- Cleaned up code a bit using the library

## v4.0.1

### New

- Re vamped how the documentation scripts work to make keeping docs up-to-date much simpler
  - Now if I need to push an update I don't need to worry about the documentation falling behind!

## v4.0.0

### BREAKING CHANGES

- `isVin`, `isEmail`, and `meetsPassReq` no longer accept a regex overwrite the built in ones are optimized and specialized for each of these fields
- Regex options removed from available options lists to send in for the same as above reasons
- `hasValue` (As stated in the fixed section) will no longer consider the number or sting 0 as a falsey value
- Removal of long deprecated `isAmericanExpressCard` in favor of `isAmexCard`
- Marked `v1.0.0 - v2.2.0` as deprecated
- You now need to be more specific about nested objects in the schema if they're nested via your data

### New

- Extreme Architecture cleanup, flattened all of the file systems
- Improved Flow/Optimizations
- Converted from `eslint` to `standardjs`
- Added `maxLen` and `minLen` to options in the object
- Added `isNotTooShort` which verifies if the value is longer or equal to `minLen`
- Added `isNotTooLong` which verifies if the value is shorter or equal to `maxLen`
- Added `isCorrectLength` which verifies if the value is between or equal to `maxLen` or `minLen`
- There is now a non compressed version of the built module if you want to use it in a dev environment located with the compressed version in `dist/simply-valid.js`
- Converted back to `tape` from `ava`

### Updated

- Updated documentation scripts to be faster and have a little more info
- Slight documentation cleanup
- The reponse of the main validation functionality will be much more consistent `{ isValid: Boolean, story: Array }`

### Fixed

- `hasValue` Rule will no longer treat the number 0 as a falsy value
- Some documentation pieces had copy/paste errors that needed addressed
- Nested objects not being validated as expected
- Methods that could break on an undefined will no longer bomb out
- Methods `isAboveMin` and `isBelowMax` edge case fixed if you passed 0 for the min or max property when sending an object