decoders 2.0.0 → 2.0.1

package/index.js

@@ -1,89 +1,89 @@
-"use strict";
+'use strict'
 
-exports.__esModule = true;
-exports.uuidv4 = exports.uuidv1 = exports.uuid = exports.url = exports.unknown = exports.undefined_ = exports.tuple = exports.truthy = exports.taggedUnion = exports.string = exports.set = exports.regex = exports.prep = exports.positiveNumber = exports.positiveInteger = exports.pojo = exports.poja = exports.optional = exports.oneOf = exports.object = exports.numericBoolean = exports.number = exports.nullable = exports.null_ = exports.nonEmptyString = exports.nonEmptyArray = exports.never = exports.mixed = exports.maybe = exports.mapping = exports.lazy = exports.jsonObject = exports.jsonArray = exports.json = exports.iso8601 = exports.integer = exports.instanceOf = exports.inexact = exports.httpsUrl = exports.hardcoded = exports.fail = exports.exact = exports.email = exports.either = exports.dict = exports.define = exports.date = exports.constant = exports["boolean"] = exports.array = exports.anyNumber = exports.always = void 0;
+exports.__esModule = true
+exports.uuidv4 = exports.uuidv1 = exports.uuid = exports.url = exports.unknown = exports.undefined_ = exports.tuple = exports.truthy = exports.taggedUnion = exports.string = exports.set = exports.regex = exports.prep = exports.positiveNumber = exports.positiveInteger = exports.pojo = exports.poja = exports.optional = exports.oneOf = exports.object = exports.numericBoolean = exports.number = exports.nullable = exports.null_ = exports.nonEmptyString = exports.nonEmptyArray = exports.never = exports.mixed = exports.maybe = exports.mapping = exports.lazy = exports.jsonObject = exports.jsonArray = exports.json = exports.iso8601 = exports.integer = exports.instanceOf = exports.inexact = exports.httpsUrl = exports.hardcoded = exports.fail = exports.exact = exports.email = exports.either = exports.dict = exports.define = exports.date = exports.constant = exports['boolean'] = exports.array = exports.anyNumber = exports.always = void 0
 
-var _Decoder = require("./Decoder");
+var _Decoder = require('./Decoder')
 
-exports.define = _Decoder.define;
+exports.define = _Decoder.define
 
-var _basics = require("./lib/basics");
+var _basics = require('./lib/basics')
 
-exports.always = _basics.always;
-exports.constant = _basics.constant;
-exports.hardcoded = _basics.hardcoded;
-exports.maybe = _basics.maybe;
-exports.mixed = _basics.mixed;
-exports.nullable = _basics.nullable;
-exports.null_ = _basics.null_;
-exports.optional = _basics.optional;
-exports.undefined_ = _basics.undefined_;
-exports.unknown = _basics.unknown;
+exports.always = _basics.always
+exports.constant = _basics.constant
+exports.hardcoded = _basics.hardcoded
+exports.maybe = _basics.maybe
+exports.mixed = _basics.mixed
+exports.nullable = _basics.nullable
+exports.null_ = _basics.null_
+exports.optional = _basics.optional
+exports.undefined_ = _basics.undefined_
+exports.unknown = _basics.unknown
 
-var _arrays = require("./lib/arrays");
+var _arrays = require('./lib/arrays')
 
-exports.array = _arrays.array;
-exports.nonEmptyArray = _arrays.nonEmptyArray;
-exports.poja = _arrays.poja;
-exports.set = _arrays.set;
-exports.tuple = _arrays.tuple;
+exports.array = _arrays.array
+exports.nonEmptyArray = _arrays.nonEmptyArray
+exports.poja = _arrays.poja
+exports.set = _arrays.set
+exports.tuple = _arrays.tuple
 
-var _booleans = require("./lib/booleans");
+var _booleans = require('./lib/booleans')
 
-exports["boolean"] = _booleans["boolean"];
-exports.numericBoolean = _booleans.numericBoolean;
-exports.truthy = _booleans.truthy;
+exports['boolean'] = _booleans['boolean']
+exports.numericBoolean = _booleans.numericBoolean
+exports.truthy = _booleans.truthy
 
-var _dates = require("./lib/dates");
+var _dates = require('./lib/dates')
 
-exports.date = _dates.date;
-exports.iso8601 = _dates.iso8601;
+exports.date = _dates.date
+exports.iso8601 = _dates.iso8601
 
-var _objects = require("./lib/objects");
+var _objects = require('./lib/objects')
 
-exports.dict = _objects.dict;
-exports.exact = _objects.exact;
-exports.inexact = _objects.inexact;
-exports.mapping = _objects.mapping;
-exports.object = _objects.object;
-exports.pojo = _objects.pojo;
+exports.dict = _objects.dict
+exports.exact = _objects.exact
+exports.inexact = _objects.inexact
+exports.mapping = _objects.mapping
+exports.object = _objects.object
+exports.pojo = _objects.pojo
 
-var _unions = require("./lib/unions");
+var _unions = require('./lib/unions')
 
-exports.either = _unions.either;
-exports.oneOf = _unions.oneOf;
-exports.taggedUnion = _unions.taggedUnion;
+exports.either = _unions.either
+exports.oneOf = _unions.oneOf
+exports.taggedUnion = _unions.taggedUnion
 
-var _strings = require("./lib/strings");
+var _strings = require('./lib/strings')
 
-exports.email = _strings.email;
-exports.httpsUrl = _strings.httpsUrl;
-exports.nonEmptyString = _strings.nonEmptyString;
-exports.regex = _strings.regex;
-exports.string = _strings.string;
-exports.url = _strings.url;
-exports.uuid = _strings.uuid;
-exports.uuidv1 = _strings.uuidv1;
-exports.uuidv4 = _strings.uuidv4;
+exports.email = _strings.email
+exports.httpsUrl = _strings.httpsUrl
+exports.nonEmptyString = _strings.nonEmptyString
+exports.regex = _strings.regex
+exports.string = _strings.string
+exports.url = _strings.url
+exports.uuid = _strings.uuid
+exports.uuidv1 = _strings.uuidv1
+exports.uuidv4 = _strings.uuidv4
 
-var _utilities = require("./lib/utilities");
+var _utilities = require('./lib/utilities')
 
-exports.fail = _utilities.fail;
-exports.instanceOf = _utilities.instanceOf;
-exports.lazy = _utilities.lazy;
-exports.never = _utilities.never;
-exports.prep = _utilities.prep;
+exports.fail = _utilities.fail
+exports.instanceOf = _utilities.instanceOf
+exports.lazy = _utilities.lazy
+exports.never = _utilities.never
+exports.prep = _utilities.prep
 
-var _numbers = require("./lib/numbers");
+var _numbers = require('./lib/numbers')
 
-exports.anyNumber = _numbers.anyNumber;
-exports.integer = _numbers.integer;
-exports.number = _numbers.number;
-exports.positiveInteger = _numbers.positiveInteger;
-exports.positiveNumber = _numbers.positiveNumber;
+exports.anyNumber = _numbers.anyNumber
+exports.integer = _numbers.integer
+exports.number = _numbers.number
+exports.positiveInteger = _numbers.positiveInteger
+exports.positiveNumber = _numbers.positiveNumber
 
-var _json = require("./lib/json");
+var _json = require('./lib/json')
 
-exports.json = _json.json;
-exports.jsonObject = _json.jsonObject;
-exports.jsonArray = _json.jsonArray;
+exports.json = _json.json
+exports.jsonObject = _json.jsonObject
+exports.jsonArray = _json.jsonArray

package/index.mjs

@@ -1,11 +1,11 @@
-export { define } from './Decoder.mjs';
-export { always, constant, hardcoded, maybe, mixed, nullable, null_, optional, undefined_, unknown } from './lib/basics.mjs';
-export { array, nonEmptyArray, poja, set, tuple } from './lib/arrays.mjs';
-export { boolean, numericBoolean, truthy } from './lib/booleans.mjs';
-export { date, iso8601 } from './lib/dates.mjs';
-export { dict, exact, inexact, mapping, object, pojo } from './lib/objects.mjs';
-export { either, oneOf, taggedUnion } from './lib/unions.mjs';
-export { email, httpsUrl, nonEmptyString, regex, string, url, uuid, uuidv1, uuidv4 } from './lib/strings.mjs';
-export { fail, instanceOf, lazy, never, prep } from './lib/utilities.mjs';
-export { anyNumber, integer, number, positiveInteger, positiveNumber } from './lib/numbers.mjs';
-export { json, jsonObject, jsonArray } from './lib/json.mjs';
+export { define } from './Decoder.mjs'
+export { always, constant, hardcoded, maybe, mixed, nullable, null_, optional, undefined_, unknown } from './lib/basics.mjs'
+export { array, nonEmptyArray, poja, set, tuple } from './lib/arrays.mjs'
+export { boolean, numericBoolean, truthy } from './lib/booleans.mjs'
+export { date, iso8601 } from './lib/dates.mjs'
+export { dict, exact, inexact, mapping, object, pojo } from './lib/objects.mjs'
+export { either, oneOf, taggedUnion } from './lib/unions.mjs'
+export { email, httpsUrl, nonEmptyString, regex, string, url, uuid, uuidv1, uuidv4 } from './lib/strings.mjs'
+export { fail, instanceOf, lazy, never, prep } from './lib/utilities.mjs'
+export { anyNumber, integer, number, positiveInteger, positiveNumber } from './lib/numbers.mjs'
+export { json, jsonObject, jsonArray } from './lib/json.mjs'

package/lib/arrays.js

@@ -1,139 +1,97 @@
-"use strict";
+'use strict'
 
-exports.__esModule = true;
-exports.array = array;
-exports.nonEmptyArray = nonEmptyArray;
-exports.poja = void 0;
-exports.set = set;
-exports.tuple = void 0;
+exports.__esModule = true
+exports.array = array
+exports.nonEmptyArray = nonEmptyArray
+exports.poja = void 0
+exports.set = set
+exports.tuple = void 0
 
-var _annotate = require("../annotate");
+var _annotate = require('../annotate')
 
-var _Decoder = require("../Decoder");
+var _Decoder = require('../Decoder')
 
-/**
- * Accepts any array, but doesn't validate its items further.
- *
- * "poja" means "plain old JavaScript array", a play on `pojo()`.
- */
 var poja = (0, _Decoder.define)(function (blob, ok, err) {
   if (!Array.isArray(blob)) {
-    return err('Must be an array');
+    return err('Must be an array')
   }
 
-  return ok( // NOTE: Since Flow 0.98, Array.isArray() returns $ReadOnlyArray<mixed>
-  // instead of Array<mixed>.  For rationale, see
-  // https://github.com/facebook/flow/issues/7684.  In this case, we
-  // don't want to output read-only types because it's up to the user of
-  // decoders to determine what they want to do with the decoded output.
-  // If they want to write items into the array, that's fine!
-  // The fastest way to turn a read-only array into a normal array in
-  // Javascript is to use .slice() on it, see this benchmark:
-  // http://jsben.ch/lO6C5
-  blob.slice());
-});
-/**
- * Given an array of Result instances, loop over them all and return:
- * - An [index, err] tuple, indicating the (index of the) first Err instance
- *   encountered; or
- * - a new Ok with an array of all unwrapped Ok'ed values
- */
-
-exports.poja = poja;
-
-function all(items, blobs, // TODO: Make this less ugly
-ok, err) {
-  var results = [];
+  return ok(blob.slice())
+})
+
+exports.poja = poja
+
+function all(items, blobs, ok, err) {
+  var results = []
 
   for (var index = 0; index < items.length; ++index) {
-    var result = items[index];
+    var result = items[index]
 
     if (result.ok) {
-      results.push(result.value);
+      results.push(result.value)
     } else {
-      var ann = result.error; // Rewrite the annotation to include the index information, and inject it into the original blob
+      var ann = result.error
 
-      var clone = [].concat(blobs);
-      clone.splice(index, 1, (0, _annotate.annotate)(ann, ann.text ? ann.text + " (at index " + index + ")" : "index " + index));
-      return err((0, _annotate.annotate)(clone));
+      var clone = [].concat(blobs)
+      clone.splice(index, 1, (0, _annotate.annotate)(ann, ann.text ? ann.text + ' (at index ' + index + ')' : 'index ' + index))
+      return err((0, _annotate.annotate)(clone))
     }
   }
 
-  return ok(results);
+  return ok(results)
 }
-/**
- * Accepts arrays of whatever the given decoder accepts.
- */
-
 
 function array(decoder) {
   return poja.then(function (blobs, ok, err) {
-    var results = blobs.map(decoder.decode);
-    return all(results, blobs, ok, err);
-  });
+    var results = blobs.map(decoder.decode)
+    return all(results, blobs, ok, err)
+  })
 }
-/**
- * Like `array()`, but will reject arrays with 0 elements.
- */
-
 
 function nonEmptyArray(decoder) {
   return array(decoder).refine(function (arr) {
-    return arr.length > 0;
-  }, 'Must be non-empty array');
+    return arr.length > 0
+  }, 'Must be non-empty array')
 }
-/**
- * Similar to `array()`, but returns the result as an [ES6
- * Set](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set).
- */
-
 
 function set(decoder) {
   return array(decoder).transform(function (items) {
-    return new Set(items);
-  });
+    return new Set(items)
+  })
 }
 
 var ntuple = function ntuple(n) {
   return poja.refine(function (arr) {
-    return arr.length === n;
-  }, "Must be a " + n + "-tuple");
-}; // prettier-ignore
-
+    return arr.length === n
+  }, 'Must be a ' + n + '-tuple')
+}
 
 function _tuple() {
   for (var _len = arguments.length, decoders = new Array(_len), _key = 0; _key < _len; _key++) {
-    decoders[_key] = arguments[_key];
+    decoders[_key] = arguments[_key]
   }
 
   return ntuple(decoders.length).then(function (blobs, ok, err) {
-    var allOk = true;
+    var allOk = true
     var rvs = decoders.map(function (decoder, i) {
-      var blob = blobs[i];
-      var result = decoder.decode(blob);
+      var blob = blobs[i]
+      var result = decoder.decode(blob)
 
       if (result.ok) {
-        return result.value;
+        return result.value
       } else {
-        allOk = false;
-        return result.error;
+        allOk = false
+        return result.error
       }
-    });
+    })
 
     if (allOk) {
-      return ok(rvs);
+      return ok(rvs)
     } else {
-      // If a decoder error has happened while unwrapping all the
-      // results, try to construct a good error message
-      return err((0, _annotate.annotate)(rvs));
+      return err((0, _annotate.annotate)(rvs))
     }
-  });
+  })
 }
-/**
- * Accepts a tuple (an array with exactly _n_ items) of values accepted by the
- * _n_ given decoders.
- */
-
 
-var tuple = _tuple;
-exports.tuple = tuple;
+var tuple = _tuple
+exports.tuple = tuple

package/lib/arrays.mjs

@@ -1,124 +1,84 @@
-import { annotate } from '../annotate.mjs';
-import { define } from '../Decoder.mjs';
-
-/**
- * Accepts any array, but doesn't validate its items further.
- *
- * "poja" means "plain old JavaScript array", a play on `pojo()`.
- */
+import { annotate } from '../annotate.mjs'
+import { define } from '../Decoder.mjs'
+
 export var poja = define(function (blob, ok, err) {
   if (!Array.isArray(blob)) {
-    return err('Must be an array');
+    return err('Must be an array')
   }
 
-  return ok( // NOTE: Since Flow 0.98, Array.isArray() returns $ReadOnlyArray<mixed>
-  // instead of Array<mixed>.  For rationale, see
-  // https://github.com/facebook/flow/issues/7684.  In this case, we
-  // don't want to output read-only types because it's up to the user of
-  // decoders to determine what they want to do with the decoded output.
-  // If they want to write items into the array, that's fine!
-  // The fastest way to turn a read-only array into a normal array in
-  // Javascript is to use .slice() on it, see this benchmark:
-  // http://jsben.ch/lO6C5
-  blob.slice());
-});
-/**
- * Given an array of Result instances, loop over them all and return:
- * - An [index, err] tuple, indicating the (index of the) first Err instance
- *   encountered; or
- * - a new Ok with an array of all unwrapped Ok'ed values
- */
-
-function all(items, blobs, // TODO: Make this less ugly
-ok, err) {
-  var results = [];
+  return ok(blob.slice())
+})
+
+function all(items, blobs, ok, err) {
+  var results = []
 
   for (var index = 0; index < items.length; ++index) {
-    var result = items[index];
+    var result = items[index]
 
     if (result.ok) {
-      results.push(result.value);
+      results.push(result.value)
     } else {
-      var ann = result.error; // Rewrite the annotation to include the index information, and inject it into the original blob
+      var ann = result.error
 
-      var clone = [].concat(blobs);
-      clone.splice(index, 1, annotate(ann, ann.text ? ann.text + " (at index " + index + ")" : "index " + index));
-      return err(annotate(clone));
+      var clone = [].concat(blobs)
+      clone.splice(index, 1, annotate(ann, ann.text ? ann.text + ' (at index ' + index + ')' : 'index ' + index))
+      return err(annotate(clone))
     }
   }
 
-  return ok(results);
+  return ok(results)
 }
-/**
- * Accepts arrays of whatever the given decoder accepts.
- */
-
 
 export function array(decoder) {
   return poja.then(function (blobs, ok, err) {
-    var results = blobs.map(decoder.decode);
-    return all(results, blobs, ok, err);
-  });
+    var results = blobs.map(decoder.decode)
+    return all(results, blobs, ok, err)
+  })
 }
-/**
- * Like `array()`, but will reject arrays with 0 elements.
- */
 
 export function nonEmptyArray(decoder) {
   return array(decoder).refine(function (arr) {
-    return arr.length > 0;
-  }, 'Must be non-empty array');
+    return arr.length > 0
+  }, 'Must be non-empty array')
 }
-/**
- * Similar to `array()`, but returns the result as an [ES6
- * Set](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set).
- */
 
 export function set(decoder) {
   return array(decoder).transform(function (items) {
-    return new Set(items);
-  });
+    return new Set(items)
+  })
 }
 
 var ntuple = function ntuple(n) {
   return poja.refine(function (arr) {
-    return arr.length === n;
-  }, "Must be a " + n + "-tuple");
-}; // prettier-ignore
-
+    return arr.length === n
+  }, 'Must be a ' + n + '-tuple')
+}
 
 function _tuple() {
   for (var _len = arguments.length, decoders = new Array(_len), _key = 0; _key < _len; _key++) {
-    decoders[_key] = arguments[_key];
+    decoders[_key] = arguments[_key]
   }
 
   return ntuple(decoders.length).then(function (blobs, ok, err) {
-    var allOk = true;
+    var allOk = true
     var rvs = decoders.map(function (decoder, i) {
-      var blob = blobs[i];
-      var result = decoder.decode(blob);
+      var blob = blobs[i]
+      var result = decoder.decode(blob)
 
       if (result.ok) {
-        return result.value;
+        return result.value
       } else {
-        allOk = false;
-        return result.error;
+        allOk = false
+        return result.error
       }
-    });
+    })
 
     if (allOk) {
-      return ok(rvs);
+      return ok(rvs)
     } else {
-      // If a decoder error has happened while unwrapping all the
-      // results, try to construct a good error message
-      return err(annotate(rvs));
+      return err(annotate(rvs))
     }
-  });
+  })
 }
-/**
- * Accepts a tuple (an array with exactly _n_ items) of values accepted by the
- * _n_ given decoders.
- */
-
 
-export var tuple = _tuple;
+export var tuple = _tuple