flowxo-utils/CHANGELOG.md

Common utilities for Flow XO.

# Change Log
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [3.2.0] - 2017-02-28

### Changes
#### Added `limit` to `getFlattenedFields() options`
This limits length of the array returned

Usage:
``` js
Utils.getFlattenedFields(Object|Array, {limit: 100});
```

## [3.1.0] - 2017-02-22

### Changes
#### Added `Utils.hasTZOffset()`
Usage:
``` js
Utils.hasTZOffset('2017-02-22 13:26 -06:00') // true
```

#### Added `Utils.applyTzOffset()`
This doesn't make JS dates timezone aware. It 'pretends' to by shifting the date.
Usage:
``` js
Utils.applyTzOffset(new Date('2017-02-22'), 'America/Chicago'); // Returns a date shifted to the timezone specified
```

### Fixes
- Worked around a bug in SugarDate when sometimes `today at 3pm` would get parsed as the next day at 3pm.

## [3.0.2] - 2017-02-13

### Fixes
- Fixed an odd issue where regex was not working correctly causing dates to not be parsed correctly.

## [3.0.1] - 2017-02-13

### Fixes
- Fixed issues with parsing relative dates and times.
- The returned `.parsed` property from `parseDateTimeField` is completely backward compatible.
- Improved tests. They now check the parsed date and not just if it parsed.

## [3.0.0] - 2017-02-08
### Added
- Timezone support for `Utils.parseDateTimeField()`
- Locale support for `Utils.parseDateTimeField()`

`Utils.parseDateTimeField(date [, Object])` takes a second optional parameter of object.
- `timezone` defaults to `UTC`
- `locale` defaults to `en`

Usage:
``` js
Utils.parseDateTimeField('today at 3pm', {
  timezone: 'Europe/London',
  locale: 'en-GB'
});
```

### Breaking change
Upgraded Sugar Date module from 1.x to 2.x. See [Sugar breaking changes](https://github.com/andrewplummer/Sugar/blob/master/CAUTION.md#v200)

`Date` object no longer gets extended with SugarDate by default. If you want to extend the `Date` object you must call `Utils.activateDateParser()`.

## [2.1.0] - 2016-09-15
### Added
- `nonRetryableErrors` option to backoff module. This allows you to use your own 'non-retryable' error classes to halt the backoff if necessary.

## [2.0.0] - 2016-09-09
### Added
- `maxDuration` option to backoff module, to support abortion of backoff if the total operation time has or will exceed the `maxDuration` parameter on the next retry.

### Breaking change

Backoff module is now invoked differently. Instead of creating a `new Backoff` object, and passing in the `minDelay` and `maxDelay`, you now pass everything into the `attempt` or `attemptAsync` methods.

Assuming the following operation:

``` js
var operation = function() {
return new Promise(function (resolve, reject) {
  request(options, function(err, res, body) {
    if(err) {
      return reject(err);
    }
    resolve(body);
  }
});
```

Old (1.x) syntax:

``` js
var backoff = new Backoff(100, 1000);
backoff.attemptAsync(5, operation).then(res => {
  // Do something with result
}, err => {
  // Do something with error
})
```

New (2.0) syntax:

``` js
var options = {
  minDelay: 100,
  maxDelay: 1000,
  maxAttempts: 5
};
backoff.attemptAsync(operation, options).then(res => {
  // Do something with result
}, err => {
  // Do something with error
})
```

## [1.6.1] - 2016-08-23
### Added
- `NonRetryableError` to backoff module, to support early aborting of backoff.

## [1.6.0] - 2016-08-09
### Added
- Promise-style `attemptAsync` method to backoff module.

## [1.5.2] - 2016-07-01
### Fixed
- Reverted to ES5 syntax for node 0.10 and 0.12 compatibility.

## [1.5.1] - 2016-07-01
### Added
- hashToKeyValPairs utility function.
- Code coverage with istanbul.

## [1.5.0] - 2016-03-24
### Added
- Dumb console logger, with partial API compatibility with Winston.

## [1.4.0] - 2016-03-24
### Added
- Backoff utility.

## [1.3.1] - 2016-03-11
### Added
- Support for objects inside collections.

## [1.3.0] - 2016-03-10
### Added
- Support for 'flattened collections'.

## [1.2.0] - 2016-02-25
### Added
- Allow offset modifiers for datetime parsing to be in the form `date + 90d` and `date+90d` as well as `date +90d`.

## [1.1.4] - 2016-02-10
### Fixed
- Issues with `null` values for `datetime` or `boolean` inputs.

### Updated
- lodash and jasmine dependencies.

## [1.1.3] - 2016-02-09
### Fixed
- Correctly stringify `datetime` input annotated values.

## [1.1.2] - 2016-01-13
### Updated
- Allow `y` or `n` as valid boolean values.

## [1.1.1] - 2016-01-13
### Fixed
- Fixed issue when getting flattened fields for an object with a `length` property.

## [1.1.0] - 2015-09-22
### Added
- Added functions to label I/O data.

## [1.0.1] - 2015-05-02
### Fixed
- Fixed bug when getting a nested property when a higher-level property is `null`.

## 1.0.0 - 2015-04-13
### Added
- Initial release.

[3.2.0]: https://github.com/flowxo/flowxo-utils/compare/v3.1.0...v3.2.0
[3.1.0]: https://github.com/flowxo/flowxo-utils/compare/v3.0.2...v3.1.0
[3.0.2]: https://github.com/flowxo/flowxo-utils/compare/v3.0.1...v3.0.2
[3.0.1]: https://github.com/flowxo/flowxo-utils/compare/v3.0.0...v3.0.1
[3.0.0]: https://github.com/flowxo/flowxo-utils/compare/v2.1.0...v3.0.0
[2.1.0]: https://github.com/flowxo/flowxo-utils/compare/v2.0.0...v2.1.0
[2.0.0]: https://github.com/flowxo/flowxo-utils/compare/v1.6.1...v2.0.0
[1.6.1]: https://github.com/flowxo/flowxo-utils/compare/v1.6.0...v1.6.1
[1.6.0]: https://github.com/flowxo/flowxo-utils/compare/v1.5.2...v1.6.0
[1.5.2]: https://github.com/flowxo/flowxo-utils/compare/v1.5.1...v1.5.2
[1.5.1]: https://github.com/flowxo/flowxo-utils/compare/v1.5.0...v1.5.1
[1.5.0]: https://github.com/flowxo/flowxo-utils/compare/v1.4.0...v1.5.0
[1.4.0]: https://github.com/flowxo/flowxo-utils/compare/v1.3.1...v1.4.0
[1.3.1]: https://github.com/flowxo/flowxo-utils/compare/v1.3.0...v1.3.1
[1.3.0]: https://github.com/flowxo/flowxo-utils/compare/v1.2.0...v1.3.0
[1.2.0]: https://github.com/flowxo/flowxo-utils/compare/v1.1.4...v1.2.0
[1.1.4]: https://github.com/flowxo/flowxo-utils/compare/v1.1.3...v1.1.4
[1.1.3]: https://github.com/flowxo/flowxo-utils/compare/v1.1.2...v1.1.3
[1.1.2]: https://github.com/flowxo/flowxo-utils/compare/v1.1.1...v1.1.2
[1.1.1]: https://github.com/flowxo/flowxo-utils/compare/v1.1.0...v1.1.1
[1.1.0]: https://github.com/flowxo/flowxo-utils/compare/v1.0.1...v1.1.0
[1.0.1]: https://github.com/flowxo/flowxo-utils/compare/v1.0.0...v1.0.1