decoders 2.0.0-beta8 → 2.0.1

package/format.mjs

@@ -1,140 +1,130 @@
-import { summarize as _summarize, asDate, INDENT, indent, isMultiline } from './_utils.mjs';
+import { summarize as _summarize, asDate, INDENT, indent, isMultiline } from './_utils.mjs'
 
 function serializeString(s, width) {
   if (width === void 0) {
-    width = 80;
+    width = 80
   }
-
-  // Full string
-  // Abbreviated to $maxlen i.e. "Vincent Driess..." [truncated]
-  var ser = JSON.stringify(s);
+  var ser = JSON.stringify(s)
 
   if (ser.length <= width) {
-    return ser;
-  } // Cut off a bit
-
+    return ser
+  }
 
-  var truncated = s.substring(0, width - 15) + '...';
-  ser = JSON.stringify(truncated) + ' [truncated]';
-  return ser;
+  var truncated = s.substring(0, width - 15) + '...'
+  ser = JSON.stringify(truncated) + ' [truncated]'
+  return ser
 }
 
 function serializeArray(annotation, prefix) {
-  var items = annotation.items;
+  var items = annotation.items
 
   if (items.length === 0) {
-    return '[]';
+    return '[]'
   }
 
-  var result = [];
+  var result = []
   items.forEach(function (item) {
-    var _serializeAnnotation = serializeAnnotation(item, prefix + INDENT),
-        ser = _serializeAnnotation[0],
-        ann = _serializeAnnotation[1];
+    var _serializeAnnotation = serializeAnnotation(item, '' + prefix + INDENT),
+      ser = _serializeAnnotation[0],
+      ann = _serializeAnnotation[1]
 
-    result.push(prefix + INDENT + ser + ',');
+    result.push('' + prefix + INDENT + ser + ',')
 
     if (ann !== undefined) {
-      result.push(indent(ann, prefix + INDENT));
+      result.push(indent(ann, '' + prefix + INDENT))
     }
-  });
-  return ['['].concat(result, [prefix + ']']).join('\n');
+  })
+  return ['['].concat(result, [prefix + ']']).join('\n')
 }
 
 function serializeObject(annotation, prefix) {
-  var fields = annotation.fields;
-  var fieldNames = Object.keys(fields);
+  var fields = annotation.fields
+  var fieldNames = Object.keys(fields)
 
   if (fieldNames.length === 0) {
-    return '{}';
+    return '{}'
   }
 
-  var result = [];
+  var result = []
   fieldNames.forEach(function (key) {
-    var valueAnnotation = fields[key];
-    var kser = serializeValue(key);
-    var valPrefix = prefix + INDENT + ' '.repeat(kser.length + 2);
+    var valueAnnotation = fields[key]
+    var kser = serializeValue(key)
+    var valPrefix = '' + prefix + INDENT + ' '.repeat(kser.length + 2)
 
-    var _serializeAnnotation2 = serializeAnnotation(valueAnnotation, prefix + INDENT),
-        vser = _serializeAnnotation2[0],
-        vann = _serializeAnnotation2[1];
+    var _serializeAnnotation2 = serializeAnnotation(valueAnnotation, '' + prefix + INDENT),
+      vser = _serializeAnnotation2[0],
+      vann = _serializeAnnotation2[1]
 
-    result.push(prefix + INDENT + kser + ': ' + vser + ',');
+    result.push('' + prefix + INDENT + kser + ': ' + vser + ',')
 
     if (vann !== undefined) {
-      result.push(indent(vann, valPrefix));
+      result.push(indent(vann, valPrefix))
     }
-  });
-  return ['{'].concat(result, [prefix + '}']).join('\n');
+  })
+  return ['{'].concat(result, [prefix + '}']).join('\n')
 }
 
 export function serializeValue(value) {
-  // istanbul ignore else
   if (typeof value === 'string') {
-    return serializeString(value);
+    return serializeString(value)
   } else if (typeof value === 'number' || typeof value === 'boolean') {
-    return value.toString();
+    return value.toString()
   } else if (value === null) {
-    return 'null';
+    return 'null'
   } else if (value === undefined) {
-    return 'undefined';
+    return 'undefined'
   } else {
-    var valueAsDate = asDate(value);
+    var valueAsDate = asDate(value)
 
     if (valueAsDate !== null) {
-      return "new Date(" + JSON.stringify(valueAsDate.toISOString()) + ")";
+      return 'new Date(' + JSON.stringify(valueAsDate.toISOString()) + ')'
     } else if (value instanceof Date) {
-      // NOTE: Using `instanceof Date` is unreliable way of checking dates.
-      // If this case occurs (and it didn't pass the prior isDate())
-      // check, then this must be the case where it's an invalid date.
-      return '(Invalid Date)';
+      return '(Invalid Date)'
     } else {
-      return '(unserializable)';
+      return '(unserializable)'
     }
   }
 }
 export function serializeAnnotation(ann, prefix) {
   if (prefix === void 0) {
-    prefix = '';
+    prefix = ''
   }
-
-  // The serialized data (the input object echoed back)
-  var serialized;
+  var serialized
 
   if (ann.type === 'array') {
-    serialized = serializeArray(ann, prefix);
+    serialized = serializeArray(ann, prefix)
   } else if (ann.type === 'object') {
-    serialized = serializeObject(ann, prefix);
+    serialized = serializeObject(ann, prefix)
   } else if (ann.type === 'function') {
-    serialized = '<function>';
+    serialized = '<function>'
   } else if (ann.type === 'circular-ref') {
-    serialized = '<circular ref>';
+    serialized = '<circular ref>'
   } else if (ann.type === 'unknown') {
-    serialized = '???';
+    serialized = '???'
   } else {
-    serialized = serializeValue(ann.value);
+    serialized = serializeValue(ann.value)
   }
 
-  var text = ann.text;
+  var text = ann.text
 
   if (text !== undefined) {
-    var sep = '^'.repeat(isMultiline(serialized) ? 1 : serialized.length);
-    return [serialized, [sep, text].join(isMultiline(text) ? '\n' : ' ')];
+    var sep = '^'.repeat(isMultiline(serialized) ? 1 : serialized.length)
+    return [serialized, [sep, text].join(isMultiline(text) ? '\n' : ' ')]
   } else {
-    return [serialized, undefined];
+    return [serialized, undefined]
   }
 }
 export function formatInline(ann) {
   var _serializeAnnotation3 = serializeAnnotation(ann),
-      serialized = _serializeAnnotation3[0],
-      annotation = _serializeAnnotation3[1];
+    serialized = _serializeAnnotation3[0],
+    annotation = _serializeAnnotation3[1]
 
   if (annotation !== undefined) {
-    return serialized + '\n' + annotation;
+    return serialized + '\n' + annotation
   } else {
-    return serialized;
+    return serialized
   }
 }
 export function formatShort(ann) {
-  return _summarize(ann, []).join('\n');
-}
+  return _summarize(ann, []).join('\n')
+}

package/index.d.ts

@@ -1,43 +1,40 @@
-export {
-    Decoder,
-    DecodeResult,
-    DecoderType,
-    Guard,
-    GuardType,
-    Predicate,
-    Scalar,
-} from './_types';
-export { Result } from './result';
-export { JSONValue, JSONObject, JSONArray } from './core/json';
-
-export { guard } from './_guard';
-
-export { compose, map, predicate } from './core/composition';
+export { DecodeResult, Decoder, DecoderType, Scalar, define } from './Decoder';
+export { JSONValue, JSONObject, JSONArray } from './lib/json';
 
-export { array, nonEmptyArray, poja } from './core/array';
-export { boolean, numericBoolean, truthy } from './core/boolean';
-export { constant, hardcoded, mixed, null_, undefined_, unknown } from './core/constants';
-export { date, iso8601 } from './core/date';
-export { describe } from './core/describe';
-export { disjointUnion } from './core/dispatch';
 export {
-    either,
-    either3,
-    either4,
-    either5,
-    either6,
-    either7,
-    either8,
-    either9,
-    oneOf,
-} from './core/either';
-export { fail } from './core/fail';
-export { instanceOf } from './core/instanceOf';
-export { json, jsonObject, jsonArray } from './core/json';
-export { lazy } from './core/lazy';
-export { mapping, dict } from './core/mapping';
-export { integer, number, positiveInteger, positiveNumber } from './core/number';
-export { exact, inexact, object, pojo } from './core/object';
-export { maybe, nullable, optional } from './core/optional';
-export { email, httpsUrl, nonEmptyString, regex, string, url } from './core/string';
-export { tuple1, tuple2, tuple3, tuple4, tuple5, tuple6 } from './core/tuple';
+    always,
+    constant,
+    hardcoded,
+    maybe,
+    mixed,
+    nullable,
+    null_,
+    optional,
+    undefined_,
+    unknown,
+} from './lib/basics';
+export { array, nonEmptyArray, poja, set, tuple } from './lib/arrays';
+export { boolean, numericBoolean, truthy } from './lib/booleans';
+export { date, iso8601 } from './lib/dates';
+export { dict, exact, inexact, mapping, object, pojo } from './lib/objects';
+export { either, oneOf, taggedUnion } from './lib/unions';
+export {
+    email,
+    httpsUrl,
+    nonEmptyString,
+    regex,
+    string,
+    url,
+    uuid,
+    uuidv1,
+    uuidv4,
+} from './lib/strings';
+export { fail, instanceOf, lazy, never, prep } from './lib/utilities';
+export {
+    anyNumber,
+    integer,
+    number,
+    positiveInteger,
+    positiveNumber,
+} from './lib/numbers';
+export { json, jsonObject, jsonArray } from './lib/json';

package/index.js

@@ -1,121 +1,89 @@
-"use strict";
+'use strict'
 
-exports.__esModule = true;
-exports.url = exports.unknown = exports.undefined_ = exports.tuple6 = exports.tuple5 = exports.tuple4 = exports.tuple3 = exports.tuple2 = exports.tuple1 = exports.truthy = exports.string = exports.regex = exports.predicate = 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.mixed = exports.maybe = exports.mapping = exports.map = exports.lazy = exports.jsonObject = exports.jsonArray = exports.json = exports.iso8601 = exports.integer = exports.instanceOf = exports.inexact = exports.httpsUrl = exports.hardcoded = exports.guard = exports.fail = exports.exact = exports.email = exports.either9 = exports.either8 = exports.either7 = exports.either6 = exports.either5 = exports.either4 = exports.either3 = exports.either = exports.disjointUnion = exports.dict = exports.describe = exports.date = exports.constant = exports.compose = exports["boolean"] = exports.array = 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 _guard = require("./_guard");
+var _Decoder = require('./Decoder')
 
-exports.guard = _guard.guard;
+exports.define = _Decoder.define
 
-var _composition = require("./core/composition");
+var _basics = require('./lib/basics')
 
-exports.compose = _composition.compose;
-exports.map = _composition.map;
-exports.predicate = _composition.predicate;
+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 _array = require("./core/array");
+var _arrays = require('./lib/arrays')
 
-exports.array = _array.array;
-exports.nonEmptyArray = _array.nonEmptyArray;
-exports.poja = _array.poja;
+exports.array = _arrays.array
+exports.nonEmptyArray = _arrays.nonEmptyArray
+exports.poja = _arrays.poja
+exports.set = _arrays.set
+exports.tuple = _arrays.tuple
 
-var _boolean = require("./core/boolean");
+var _booleans = require('./lib/booleans')
 
-exports["boolean"] = _boolean["boolean"];
-exports.numericBoolean = _boolean.numericBoolean;
-exports.truthy = _boolean.truthy;
+exports['boolean'] = _booleans['boolean']
+exports.numericBoolean = _booleans.numericBoolean
+exports.truthy = _booleans.truthy
 
-var _constants = require("./core/constants");
+var _dates = require('./lib/dates')
 
-exports.constant = _constants.constant;
-exports.hardcoded = _constants.hardcoded;
-exports.mixed = _constants.mixed;
-exports.null_ = _constants.null_;
-exports.undefined_ = _constants.undefined_;
-exports.unknown = _constants.unknown;
+exports.date = _dates.date
+exports.iso8601 = _dates.iso8601
 
-var _date = require("./core/date");
+var _objects = require('./lib/objects')
 
-exports.date = _date.date;
-exports.iso8601 = _date.iso8601;
+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 _describe = require("./core/describe");
+var _unions = require('./lib/unions')
 
-exports.describe = _describe.describe;
+exports.either = _unions.either
+exports.oneOf = _unions.oneOf
+exports.taggedUnion = _unions.taggedUnion
 
-var _dispatch = require("./core/dispatch");
+var _strings = require('./lib/strings')
 
-exports.disjointUnion = _dispatch.disjointUnion;
+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 _either = require("./core/either");
+var _utilities = require('./lib/utilities')
 
-exports.either = _either.either;
-exports.either3 = _either.either3;
-exports.either4 = _either.either4;
-exports.either5 = _either.either5;
-exports.either6 = _either.either6;
-exports.either7 = _either.either7;
-exports.either8 = _either.either8;
-exports.either9 = _either.either9;
-exports.oneOf = _either.oneOf;
+exports.fail = _utilities.fail
+exports.instanceOf = _utilities.instanceOf
+exports.lazy = _utilities.lazy
+exports.never = _utilities.never
+exports.prep = _utilities.prep
 
-var _fail = require("./core/fail");
+var _numbers = require('./lib/numbers')
 
-exports.fail = _fail.fail;
+exports.anyNumber = _numbers.anyNumber
+exports.integer = _numbers.integer
+exports.number = _numbers.number
+exports.positiveInteger = _numbers.positiveInteger
+exports.positiveNumber = _numbers.positiveNumber
 
-var _instanceOf = require("./core/instanceOf");
+var _json = require('./lib/json')
 
-exports.instanceOf = _instanceOf.instanceOf;
-
-var _json = require("./core/json");
-
-exports.json = _json.json;
-exports.jsonObject = _json.jsonObject;
-exports.jsonArray = _json.jsonArray;
-
-var _lazy = require("./core/lazy");
-
-exports.lazy = _lazy.lazy;
-
-var _mapping = require("./core/mapping");
-
-exports.mapping = _mapping.mapping;
-exports.dict = _mapping.dict;
-
-var _number = require("./core/number");
-
-exports.integer = _number.integer;
-exports.number = _number.number;
-exports.positiveInteger = _number.positiveInteger;
-exports.positiveNumber = _number.positiveNumber;
-
-var _object = require("./core/object");
-
-exports.exact = _object.exact;
-exports.inexact = _object.inexact;
-exports.object = _object.object;
-exports.pojo = _object.pojo;
-
-var _optional = require("./core/optional");
-
-exports.maybe = _optional.maybe;
-exports.nullable = _optional.nullable;
-exports.optional = _optional.optional;
-
-var _string = require("./core/string");
-
-exports.email = _string.email;
-exports.httpsUrl = _string.httpsUrl;
-exports.nonEmptyString = _string.nonEmptyString;
-exports.regex = _string.regex;
-exports.string = _string.string;
-exports.url = _string.url;
-
-var _tuple = require("./core/tuple");
-
-exports.tuple1 = _tuple.tuple1;
-exports.tuple2 = _tuple.tuple2;
-exports.tuple3 = _tuple.tuple3;
-exports.tuple4 = _tuple.tuple4;
-exports.tuple5 = _tuple.tuple5;
-exports.tuple6 = _tuple.tuple6;
+exports.json = _json.json
+exports.jsonObject = _json.jsonObject
+exports.jsonArray = _json.jsonArray

package/index.js.flow

@@ -1,63 +1,44 @@
 // @flow strict
 
-/**
- * Elm-like JSON decoders, for use with Flow.
- * See http://elmplayground.com/decoding-json-in-elm-1 for an introduction.
- *
- * Why? All JSON responses coming from our API endpoints are just that: free-form
- * JSON data.  To Flow, the only type classification possilbe is "any" -- effectively
- * turning off all type checks for anything related to JSON.  To the receiving end
- * (our frontend), the structure of that data is completely opaque to any type
- * checkers since JSON values can be anything: an object, an array, null, a string,
- * a bool, etc.  Our type system is not a runtime type system, so we need a way of
- * "converting" an any-type JSON value into a type that we want to work with in our
- * frontend code base.
- *
- * Elm's solution to this problem is to define composable decoders: functions that
- * take anything and either fail with an error, or guarantee to return the expected
- * type.  In our case, it's fine to fail with a runtime error.
- *
- */
-export type {
-    Decoder,
-    DecodeResult,
-    DecoderType,
-    Guard,
-    GuardType,
-    Predicate,
-    Scalar,
-} from './_types';
-export type { Result } from './result';
-export type { JSONValue, JSONObject, JSONArray } from './core/json';
+export type { Decoder, DecodeResult, DecoderType, Scalar } from './Decoder';
+export type { JSONValue, JSONObject, JSONArray } from './lib/json';
 
-export { guard } from './_guard';
+export { define } from './Decoder';
 
-export { compose, map, predicate } from './core/composition';
-
-export { array, nonEmptyArray, poja } from './core/array';
-export { boolean, numericBoolean, truthy } from './core/boolean';
-export { constant, hardcoded, mixed, null_, undefined_, unknown } from './core/constants';
-export { date, iso8601 } from './core/date';
-export { describe } from './core/describe';
-export { disjointUnion } from './core/dispatch';
 export {
-    either,
-    either3,
-    either4,
-    either5,
-    either6,
-    either7,
-    either8,
-    either9,
-    oneOf,
-} from './core/either';
-export { fail } from './core/fail';
-export { instanceOf } from './core/instanceOf';
-export { json, jsonObject, jsonArray } from './core/json';
-export { lazy } from './core/lazy';
-export { mapping, dict } from './core/mapping';
-export { integer, number, positiveInteger, positiveNumber } from './core/number';
-export { exact, inexact, object, pojo } from './core/object';
-export { maybe, nullable, optional } from './core/optional';
-export { email, httpsUrl, nonEmptyString, regex, string, url } from './core/string';
-export { tuple1, tuple2, tuple3, tuple4, tuple5, tuple6 } from './core/tuple';
+    always,
+    constant,
+    hardcoded,
+    maybe,
+    mixed,
+    nullable,
+    null_,
+    optional,
+    undefined_,
+    unknown,
+} from './lib/basics';
+export { array, nonEmptyArray, poja, set, tuple } from './lib/arrays';
+export { boolean, numericBoolean, truthy } from './lib/booleans';
+export { date, iso8601 } from './lib/dates';
+export { dict, exact, inexact, mapping, object, pojo } from './lib/objects';
+export { either, oneOf, taggedUnion } from './lib/unions';
+export {
+    email,
+    httpsUrl,
+    nonEmptyString,
+    regex,
+    string,
+    url,
+    uuid,
+    uuidv1,
+    uuidv4,
+} from './lib/strings';
+export { fail, instanceOf, lazy, never, prep } from './lib/utilities';
+export {
+    anyNumber,
+    integer,
+    number,
+    positiveInteger,
+    positiveNumber,
+} from './lib/numbers';
+export { json, jsonObject, jsonArray } from './lib/json';

package/index.mjs

@@ -1,37 +1,11 @@
-/**
- * Elm-like JSON decoders, for use with Flow.
- * See http://elmplayground.com/decoding-json-in-elm-1 for an introduction.
- *
- * Why? All JSON responses coming from our API endpoints are just that: free-form
- * JSON data.  To Flow, the only type classification possilbe is "any" -- effectively
- * turning off all type checks for anything related to JSON.  To the receiving end
- * (our frontend), the structure of that data is completely opaque to any type
- * checkers since JSON values can be anything: an object, an array, null, a string,
- * a bool, etc.  Our type system is not a runtime type system, so we need a way of
- * "converting" an any-type JSON value into a type that we want to work with in our
- * frontend code base.
- *
- * Elm's solution to this problem is to define composable decoders: functions that
- * take anything and either fail with an error, or guarantee to return the expected
- * type.  In our case, it's fine to fail with a runtime error.
- *
- */
-export { guard } from './_guard.mjs';
-export { compose, map, predicate } from './core/composition.mjs';
-export { array, nonEmptyArray, poja } from './core/array.mjs';
-export { boolean, numericBoolean, truthy } from './core/boolean.mjs';
-export { constant, hardcoded, mixed, null_, undefined_, unknown } from './core/constants.mjs';
-export { date, iso8601 } from './core/date.mjs';
-export { describe } from './core/describe.mjs';
-export { disjointUnion } from './core/dispatch.mjs';
-export { either, either3, either4, either5, either6, either7, either8, either9, oneOf } from './core/either.mjs';
-export { fail } from './core/fail.mjs';
-export { instanceOf } from './core/instanceOf.mjs';
-export { json, jsonObject, jsonArray } from './core/json.mjs';
-export { lazy } from './core/lazy.mjs';
-export { mapping, dict } from './core/mapping.mjs';
-export { integer, number, positiveInteger, positiveNumber } from './core/number.mjs';
-export { exact, inexact, object, pojo } from './core/object.mjs';
-export { maybe, nullable, optional } from './core/optional.mjs';
-export { email, httpsUrl, nonEmptyString, regex, string, url } from './core/string.mjs';
-export { tuple1, tuple2, tuple3, tuple4, tuple5, tuple6 } from './core/tuple.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'