decoders 2.1.0 → 2.2.0-test

package/CHANGELOG.md

@@ -1,670 +0,0 @@
-## v2.1.0
-
--   Officially drop Node 12 and 14 support (they may still work)
--   Fix unintentional inclusion of `lib.dom.d.ts` in TypeScript
-
-## v2.0.5
-
--   The returned value for `positiveInteger(-0)` is now `0`, not `-0`
--   The returned value for `positiveNumber(-0)` is now `0`, not `-0`
-
-## v2.0.4
-
--   Fix a bug in the `url` decoder, which could incorrectly reject URLs with a `/` in the
-    query path. Thanks, @gcampax!
-
-## v2.0.3
-
--   Fix bundling issue where TypeScript types would not get picked up correctly in old
-    TypeScript versions. Thanks, @robinchow!
-
--   ![](./docs/assets/tiny-ts-logo.png) Fix TypeScript types for `Result` type to allow
-    implicit-undefineds.
-
-## v2.0.2
-
--   ![](./docs/assets/tiny-ts-logo.png) Fix TypeScript types for `formatShort` and
-    `formatInline` helper functions
-
-## v2.0.1
-
--   ![](./docs/assets/tiny-ts-logo.png) **TypeScript-only:** Fix definition of JSONObject
-    to reflect that its values might always be `undefined` as well.
-
--   ![](./docs/assets/tiny-ts-logo.png) **TypeScript-only:** Changed return types of
-    `{ [key: string]: T }` to `Record<string, T>`.
-
--   ![](./docs/assets/tiny-ts-logo.png) **TypeScript-only:** Fine-tune the type of
-    [`instanceOf()`](https://decoders.cc/api.html#instanceOf).
-
-## v2.0.0
-
-This is a breaking change, which brings numerous benefits:
-
--   A **simpler API** 😇
--   Smaller **bundle size** (67% reduction 😱)
--   **Tree-shaking** support 🍃
--   Runtime **speed** 🏎️
--   Better documentation 📚
--   Better support for writing your own decoders 🛠️
-
-<img alt="Bundle size comparison between v1 and v2" src="./docs/assets/size-comparison@2x.png" style="width: 100%; max-width: 829px" width="829" />
-
-Please see the [migration guide](./MIGRATING-v2.md) for precise instructions on how to
-adjust your v1 code.
-
-The main change is the brand new `Decoder<T>` API! The **tl;dr** is:
-
-| Replace this v1 pattern...           |     | ...with this v2 API                        | Notes                                                                        |
-| :----------------------------------- | --- | :----------------------------------------- | :--------------------------------------------------------------------------- |
-| `mydecoder(input)`                   | →   | `mydecoder.decode(input)`                  | [migration instructions](./MIGRATING-v2.md#stop-calling-decoders)            |
-| `guard(mydecoder)(input)`            | →   | `mydecoder.verify(input)`                  | [migration instructions](./MIGRATING-v2.md#guards-are-no-longer-a-thing)     |
-| `map(mydecoder, ...)`                | →   | `mydecoder.transform(...)`                 | [migration instructions](./MIGRATING-v2.md#map-is-now-transform)             |
-| `compose(mydecoder, predicate(...))` | →   | `mydecoder.refine(...)`                    | [migration instructions](./MIGRATING-v2.md#compose--predicate-is-now-refine) |
-| `describe(mydecoder, ...)`           | →   | `mydecoder.describe(...)`                  |                                                                              |
-| `mydecoder(input).value()`           | →   | `mydecoder.value(input)`                   |                                                                              |
-| `either`, `either3`, ..., `either9`  | →   | `either`                                   | [migration instructions](./MIGRATING-v2.md#eitherN-is-now-simply-either)     |
-| `tuple1`, `tuple2`, ... `tuple6`     | →   | `tuple`                                    | [migration instructions](./MIGRATING-v2.md#tupleN-is-now-simply-tuple)       |
-| `dispatch`                           | →   | `taggedUnion`                              | [migration instructions](./MIGRATING-v2.md#dispatch-is-now-taggedUnion)      |
-| `url(...)`                           | →   | `httpsUrl` / `url` (signature has changed) | [migration instructions](./MIGRATING-v2.md#signature-of-url-has-changed)     |
-
-The full documentation is available on [**decoders.cc**](https://decoders.cc).
-
-Other features:
-
--   Include ES modules in published NPM builds (yay tree-shaking! 🍃)
--   Much smaller total bundle size (**67% smaller** compared to v1 😱)
-
-Other potentially breaking changes:
-
--   Drop support for all Node versions below 12.x
--   Drop support for TypeScript versions below 4.1.0
--   Drop support for Flow versions below 0.142.0
--   Drop all package dependencies
--   Direct reliance on `lemons` has been removed
-
-New decoders:
-
--   [`always`](https://decoders.cc/api.html#always)
--   [`anyNumber`](https://decoders.cc/api.html#anyNumber)
--   [`never`](https://decoders.cc/api.html#never)
--   [`prep()`](https://decoders.cc/api.html#prep)
--   [`set()`](https://decoders.cc/api.html#set)
--   [`uuid`](https://decoders.cc/api.html#uuid)
--   [`uuidv1`](https://decoders.cc/api.html#uuidv1)
--   [`uuidv4`](https://decoders.cc/api.html#uuidv4)
-
-Other improvements:
-
--   [`optional()`](https://decoders.cc/api.html#optional),
-    [`nullable()`](https://decoders.cc/api.html#nullable), and
-    [`maybe()`](https://decoders.cc/api.html#maybe) now each take an optional 2nd param to
-    specify a default value
--   Better error messages for nested `either`s
-
-Implementation changes:
-
--   Major reorganization of internal module structure
--   Various simplification of internals
-
-## v1.25.5
-
--   Fix compatibility issue with TypeScript projects configured with
-    `strictNullChecks: false` (or `strict: false`) (Thanks, @stevekrouse and @djlauk!)
-
--   Officially support Node 16.x
-
-## v1.25.4
-
--   Expose `nonEmptyArray` function in TypeScript (Thanks, @mszczepanczyk!)
-
-## v1.25.3
-
--   Argument to `constant(...)` now has to be scalar value in both Flow and TypeScript,
-    which matches its intended purpose.
-
-## v1.25.2
-
--   Avoid the need for having to manually specify "as const" in TypeScript when using
-    `constant()`. (Thanks, @schmod!)
-
-## v1.25.1
-
--   Add support for Flow 0.154.0
-
-## v1.25.0
-
--   Fix signature of `oneOf()` to reflect it can only be used with scalar/constant values
-
--   In TypeScript, the inferred type for `oneOf(['foo', 'bar'])` will now be
-    `Decoder<'foo' | 'bar'>` instead of `Decoder<string>` 🎉
-
--   Drop support for Flow versions < 0.115.0
-
-## v1.24.1
-
--   Tighten up signature types to indicate that incoming arrays won't get mutated
-
-## v1.24.0
-
--   **New decoders:**
-
-    -   [`describe`](https://github.com/nvie/decoders#describe): change the error message
-        for an existing decoder
-
--   Add support for Flow 0.153.x
-
--   Drop support for Node 13.x (unstable)
-
-## v1.23.5
-
-TypeScript types:
-
--   Add missing export for `tuple1`
-
-## v1.23.4
-
-TypeScript types:
-
--   Add missing export for `nonEmptyString`
-
-## v1.23.3
-
--   Returned objects that are the result from `object()`, `inexact()`, and `exact()`
-    decoders will no longer contain explicit `undefined` values for optional keys, but
-    instead those keys will be missing in the returned object entirely. (#574, thanks
-    @w01fgang!)
-
-## v1.23.2
-
--   Add missing exports for `nonEmptyArray` and `nonEmptyString` (for TypeScript)
-
-## v1.23.1
-
--   Include an error code with every FlowFixMe suppression (Flow 0.132.x compatibility)
-
-## v1.23.0
-
--   **New decoders:**
-
-    -   [`json`](https://github.com/nvie/decoders#json): decodes any valid JSON value
-
-    -   [`jsonObject`](https://github.com/nvie/decoders#jsonObject): decodes any valid
-        JSON object
-
-    -   [`jsonArray`](https://github.com/nvie/decoders#jsonArray): decodes any valid JSON
-        array
-
-## v1.22.2
-
--   **New decoders:**
-
-    -   [`inexact()`](https://github.com/nvie/decoders#inexact): like object, but retain
-        any extra fields on the input value as `unknown`
-
-    -   [`iso8601`](https://github.com/nvie/decoders#iso8601): for decoding
-        ISO8601-formatted date strings
-
--   **Improved type inference** for `object()` and `exact()` decoders (see #515, thanks
-    @dimfeld)
-
--   `DecoderType` is now an alias for `$DecoderType` (to support both TypeScript and Flow
-    conventional naming)
-
--   `GuardType` (and `$GuardType`) is a new type function to extract the type of a guard
-    instance
-
-## v1.21.0
-
--   **New decoder** [`lazy()`](https://github.com/nvie/decoders#lazy): lazily-evaluated
-    decoder, suitable to define self-referential types.
-
--   Fix compatibility with Flow 0.127.0
-
-## v1.20.2
-
--   Fix compatibility with Flow 0.126.0+
-
-## v1.20.1
-
--   Upgrade debrief to correct (final) version
-
-## v1.20.0
-
--   Fix issue where infinite recursion occurs when input object (the object being
-    validated) contains a circular reference
-
-## v1.19.1
-
--   Republish due to an NPM outage
-
-## v1.19.0
-
-**New decoders:**
-
--   To complement the tuple family of decoders, there's now also `tuple1` (thanks
-    @sfarthin!)
-
-## v1.18.1
-
--   Also fix Flow type bugs when Flow option `exact_by_default=true` in `debrief`
-    dependency
-
-## v1.18.0
-
-**New decoders:**
-
--   `nonEmptyString`: like `string`, but will fail on inputs with only whitespace (or the
-    empty string)
-
--   `nonEmptyArray`: like `array`, but will fail on inputs with 0 elements
-
-**Fixes:**
-
--   Fix Flow type bugs when Flow option `exact_by_default=true` is enabled
-
-## v1.17.0
-
-May cause breakage for Flow users:
-
--   Fix subtle bug in `object()` and `exact()` Flow type definitions that could cause Flow
-    to leak `any` under rare circumstances.
-
-## v1.16.1
-
--   Internal change to make the code Flow 0.105.x compatible. Basically stops using array
-    spreads (`[...things]`) in favor of `Array.from()`.
-
-## v1.16.0
-
-**New feature:**
-
--   Allow `map()` calls to throw an exception in the mapper function to reject the
-    decoder. Previously, these mapper functions were not expected to ever throw.
-
-## v1.15.0
-
-**New features:**
-
--   Support constructors that have required arguments in `instanceOf` decoders in
-    TypeScript (see #308, thanks @Jessidhia!)
--   Add support for type predicates in `predicate()` in TypeScript (see #310, thanks
-    @Jessidhia!)
-
-**Fixes:**
-
--   Add support for Flow >= 0.101.0
-
-## v1.14.0
-
-**Potential breaking changes:**
-
--   Stricten `pojo` criteria. Now, custom classes like `new String()` or `new Error()`
-    will not be accepted as a plain old Javascript object (= pojo) anymore.
-
-**Fixes:**
-
--   Add support for Flow 0.98+
-
-## v1.13.1
-
-**Fixes:**
-
--   Don't reject URLs that contains commas (`,`)
-
-## v1.13.0
-
-**Breaking changes:**
-
--   Changed the API interface of `dispatch()`. The previous version was too complicated
-    and was hardly used. The new version is easier to use in practice, and has better type
-    inference support in TypeScript and Flow.
-
-    **Previous usage:**
-
-    ```
-    const shape = dispatch(
-        field('type', string),
-        type => {
-            switch (type) {
-                case 'rect': return rectangle;
-                case 'circle': return circle;
-            }
-            return fail('Must be a valid shape');
-        }
-    );
-    ```
-
-    **New usage:**
-
-    ```
-    const shape = dispatch('type', { rectangle, circle });
-    ```
-
-    Where `rectangle` and `circle` are decoders of which exactly one will be invoked.
-
-*   Removed the `field()` decoder. It was not generic enough to stay part of the standard
-    decoder library. (It was typically used in combination with `dispatch()`, which now
-    isn't needed anymore, see above.)
-
-*   `pojo` decoder now returns `Decoder<{[string]: mixed}>` instead of the unsafe
-    `Decoder<Object>`.
-
-**Fixes and cleanup:**
-
--   Internal reorganization of modules
--   Improve TypeScript support
-    -   Reorganization of TypeScript declarations
-    -   More robust test suite for TypeScript
-    -   100% TypeScript test coverage
-
-## v1.12.0
-
-**New decoders:**
-
--   `oneOf(['foo', 'bar'])` will return only values matching the given values
--   `instanceOf(...)` will return only values that are instances of the given class. For
-    example: `instanceOf(TypeError)`.
-
-## v1.11.1
-
--   Reduce bundle size for web builds
--   New build system
--   Cleaner package output
-
-## v1.11.0
-
-**Potentially breaking changes:**
-
--   Decoders now all take `mixed` (TypeScript: `unknown`) arguments, instead of `any` 🎉 !
-    This ensures that the proper type refinements in the implementation of your decoder
-    are made. (See migration notes below.)
--   Invalid dates (e.g. `new Date('not a date')`) won’t be considered valid by the `date`
-    decoder anymore.
-
-**New features:**
-
--   `guard()` now takes a config option to control how to format error messages. This is
-    done via the `guard(..., { style: 'inline' })` parameter.
-
-    -   `'inline'`: echoes back the input value and inlines errors (default);
-    -   `'simple'`: just returns the decoder errors. Useful for use in sensitive contexts.
-
--   Export `$DecoderType` utility type so it can be used outside of the decoders library.
-
-**Fixes:**
-
--   Fixes for some TypeScript type definitions.
--   Add missing documentation.
-
-**Migration notes:**
-
-If your decoder code breaks after upgrading to 1.11.0, please take the following measures
-to upgrade:
-
-1. If you wrote any custom decoders of this form yourself:
-
-    ```javascript
-    const mydecoder = (blob: any) => ...
-    //                       ^^^ Decoder function taking `any`
-    ```
-
-    You should now convert those to:
-
-    ```javascript
-    const mydecoder = (blob: mixed) => ...
-    //                       ^^^^^ Decoders should take `mixed` from now on
-    ```
-
-    Or, for TypeScript:
-
-    ```javascript
-    const mydecoder = (blob: unknown) => ...
-    //                       ^^^^^^^ `unknown` for TypeScript
-    ```
-
-    Then follow and fix type errors that pop up because you were making assumptions that
-    are now caught by the type checker.
-
-2. If you wrote any decoders based on `predicate()`, you may have code like this:
-
-    ```javascript
-    const mydecoder: Decoder<string> = predicate(
-        (s) => s.startsWith('x'),
-        'Must start with "x"',
-    );
-    ```
-
-    You'll have to change the explicit Decoder type of those to take two type arguments:
-
-    ```javascript
-    const mydecoder: Decoder<string, string> = predicate(
-        //                               ^^^^^^ Provide the input type to predicate() decoders
-        (s) => s.startsWith('x'),
-        'Must start with "x"',
-    );
-    ```
-
-    This now explicitly records that `predicate()` makes assumptions about its input
-    type—previously this wasn’t get caught correctly.
-
-## v1.10.6
-
--   Make Flow 0.85 compatible
-
-## v1.10.5
-
--   Update to latest debrief (which fixes a TypeScript bug)
-
-## v1.10.4
-
--   Drop dependency on babel-runtime to reduce bundle size
-
-## v1.10.3
-
--   Fix minor declaration issue in TypeScript definitions
-
-## v1.10.2
-
--   Tuple decoder error messages now show decoder errors in all positions, not just the
-    first occurrence.
-
-**New decoders:**
-
--   New tuple decoders: `tuple3`, `tuple4`, `tuple5`, and `tuple6`
--   `unknown` decoder is an alias of `mixed`, which may be more recognizable for
-    TypeScript users.
-
-## v1.10.1
-
--   TypeScript support
-
-## v1.10.0
-
-**Breaking:**
-
--   Private helper function `undefined_or_null` was accidentally exported in the package.
-    This is a private API.
-
-## v1.9.0
-
-**New decoder:**
-
--   `dict()` is like `mapping()`, but will return an object rather than a Map instance,
-    which may be more convenient to handle in most cases.
-
-**Breaking:**
-
--   `optional(..., /* allowNull */ true)` has been removed (was deprecated since 1.8.3)
-
-## v1.8.3
-
-**New decoder:**
-
--   `maybe()` is like `optional(nullable(...))`, i.e. returns a "maybe type".
-
-**Deprecation warning:**
-
--   `optional(..., /* allowNull */ true)` is now deprecated in favor of `maybe(...)`
-
-## v1.8.2
-
-**Improved error reporting:**
-
--   Fix bug where empty error branches could be shown in complex either expressions (fixes
-    #83)
-
-## v1.8.1
-
--   Fix: revert accidentally emitting \$ReadOnlyArray types in array decoders
-
-## v1.8.0
-
--   Drop support for Node 7
--   Declare inputted arrays will not be modified (treated as read-only)
-
-## v1.7.0
-
--   Make decoders fully [Flow Strict](https://flow.org/en/docs/strict/) compatible
-
-## v1.6.1
-
--   Upgraded debrief dependency
--   Behave better in projects that have Flow's `experimental.const_params` setting turned
-    on
-
-## v1.6.0
-
--   **New decoders!**
-    -   `exact()` is like `object()`, but will fail if the inputted object contains
-        superfluous keys (keys that aren't in the object definition).
-
-## v1.5.0
-
--   Collect and report all nested errors in an object() at once (rather than error on the
-    first error).
-
-**Breaking:**
-
--   Remove deprecated `message` argument to `object()`
-
-## v1.4.6
-
--   Add missing documentation
-
-## v1.4.5
-
--   Upgrade second-level dependencies
-
-## v1.4.4
-
--   Declare library to be side effect free (to help optimize webpack v4 builds)
--   Upgrade dependencies
-
-## v1.4.1
-
--   Improve internals of the error message serializer (debrief)
-
-## v1.4.0
-
--   **New decoders!**
-    -   `email` validator based on the
-        [almost perfect email regex](http://emailregex.com/)
-    -   `url` validator for validating HTTPS URLs (most common use case)
-    -   `anyUrl` validator for validating any URL scheme
-
-## v1.3.1
-
--   Fix bug where dates, or arrays (or any other Object subclass) could pass for a record
-    with merely optional fields.
-
-## v1.3.0
-
--   Much improved error messages! They were redesigned to look great in terminals and to
-    summarize only the relevant bits of the error message, striking a balance between all
-    the details and the high level summary.
-
-## v1.2.4
-
--   **New features**:
-    -   `truthy` takes any input and returns whether the value is truthy
-    -   `numericBoolean` takes only numbers as input, and returns their boolean
-        interpretation (0 = false, non-0 = true)
-
-## v1.2.2, v1.2.3
-
--   **New feature** `mixed` decoder, for unverified pass-thru of any values
-
-## v1.2.1
-
--   **Fix** Expose the following decoders publicly:
-    -   `integer`
-    -   `positiveInteger`
-    -   `positiveNumber`
-
-## v1.2.0
-
--   **New feature** `regex()`, for building custom string decoders
--   Tiny tweaks to improve error messages (more structural improvements are on the
-    roadmap)
-
-## v1.1.0
-
--   Expose pojo() decoder, for plain old objects (with mixed contents)
--   Expose poja() decoder, for plain old arrays (with mixed contents)
--   Perf: make `tuple2()` decoder lazier
-
-## v1.0.1
-
--   Expose new "either" decoders at the too level
-
-## v1.0.0
-
--   **BREAKING** Removes the old public ("compat") API
--   Finalize/settle on public API
-
-## v0.1.3
-
--   Add whole series for either, either3, either4, ..., either9
--   Updated dev dependencies
-
-## v0.1.2
-
--   Add `date` decoder, which decodes `Date` instances
--   Improve error output detail when throwing errors
-
-## v0.1.1
-
--   Export `g2d()` helper function that can help adoption to new-style APIs by converting
-    old-style decoders (now called guards) to new-style decoders.
-
-## v0.1.0
-
--   **Breaking change** New API: simplified names, split up decoders from guards. What
-    used to be called "decoders" in 0.0.x ("things that either return a value or throw a
-    runtime error") are now called "guards" in 0.1.0. The meaning of the term "decoders"
-    is now changed to a thing that either is an "Ok" value or an "Err" value.
-
-    To convert to the new API, do this:
-
-    ```javascript
-    // Old way
-    import { decodeNumber, decodeObject, decodeString } from 'decoders';
-
-    const decoder = decodeObject({
-        name: decodeString(),
-        age: decodeNumber(),
-    });
-
-    // -------------------------------------------------------------------
-
-    // New way
-    import { guard, number, object, string } from 'decoders';
-
-    const guard = guard(
-        object({
-            name: string,
-            age: number,
-        }),
-    );
-    ```