decoders 2.0.0-beta5 → 2.0.0-beta9

package/core/json.d.ts

@@ -0,0 +1,11 @@
+import { Decoder } from '../_types';
+
+export type JSONValue = null | string | number | boolean | JSONObject | JSONArray;
+export interface JSONObject {
+    [key: string]: JSONValue;
+}
+export type JSONArray = JSONValue[];
+
+export const json: Decoder<JSONValue>;
+export const jsonArray: Decoder<JSONArray>;
+export const jsonObject: Decoder<JSONObject>;

package/core/json.js

@@ -7,7 +7,7 @@ var _array = require("./array");
 
 var _boolean2 = require("./boolean");
 
-var _mapping = require("./mapping");
+var _object = require("./object");
 
 var _either = require("./either");
 
@@ -20,12 +20,12 @@ var _number = require("./number");
 var _string = require("./string");
 
 var jsonObject = (0, _lazy.lazy)(function () {
-  return (0, _mapping.dict)(json);
+  return (0, _object.dict)(json);
 });
 exports.jsonObject = jsonObject;
 var jsonArray = (0, _lazy.lazy)(function () {
   return (0, _array.array)(json);
 });
 exports.jsonArray = jsonArray;
-var json = (0, _either.either6)(_constants.null_, _string.string, _number.number, _boolean2["boolean"], jsonObject, jsonArray);
+var json = (0, _either.either)(_constants.null_, _string.string, _number.number, _boolean2["boolean"], jsonObject, jsonArray);
 exports.json = json;

package/core/json.js.flow

@@ -2,8 +2,8 @@
 
 import { array } from './array';
 import { boolean } from './boolean';
-import { dict } from './mapping';
-import { either6 } from './either';
+import { dict } from './object';
+import { either } from './either';
 import { lazy } from './lazy';
 import { null_ } from './constants';
 import { number } from './number';
@@ -18,7 +18,7 @@ export const jsonObject: Decoder<JSONObject> = lazy(() => dict(json));
 
 export const jsonArray: Decoder<JSONArray> = lazy(() => array(json));
 
-export const json: Decoder<JSONValue> = either6(
+export const json: Decoder<JSONValue> = either(
     null_,
     string,
     number,

package/core/json.mjs

@@ -0,0 +1,15 @@
+import { array } from './array.mjs';
+import { boolean as _boolean } from './boolean.mjs';
+import { dict } from './object.mjs';
+import { either } from './either.mjs';
+import { lazy } from './lazy.mjs';
+import { null_ } from './constants.mjs';
+import { number } from './number.mjs';
+import { string } from './string.mjs';
+export var jsonObject = lazy(function () {
+  return dict(json);
+});
+export var jsonArray = lazy(function () {
+  return array(json);
+});
+export var json = either(null_, string, number, _boolean, jsonObject, jsonArray);

package/core/lazy.d.ts

@@ -0,0 +1,3 @@
+import { Decoder } from '../_types';
+
+export function lazy<T>(decoderFn: () => Decoder<T>): Decoder<T>;

package/core/number.d.ts

@@ -0,0 +1,6 @@
+import { Decoder } from '../_types';
+
+export const integer: Decoder<number>;
+export const number: Decoder<number>;
+export const positiveInteger: Decoder<number>;
+export const positiveNumber: Decoder<number>;

package/core/number.js

@@ -3,18 +3,14 @@
 exports.__esModule = true;
 exports.positiveNumber = exports.positiveInteger = exports.number = exports.integer = void 0;
 
-var Result = _interopRequireWildcard(require("../result"));
-
 var _annotate = require("../annotate");
 
-var _composition = require("./composition");
-
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+var _result = require("../result");
 
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+var _composition = require("./composition");
 
 var anyNumber = function anyNumber(blob) {
-  return typeof blob === 'number' && !Number.isNaN(blob) ? Result.ok(blob) : Result.err((0, _annotate.annotate)(blob, 'Must be number'));
+  return typeof blob === 'number' && !Number.isNaN(blob) ? (0, _result.ok)(blob) : (0, _result.err)((0, _annotate.annotate)(blob, 'Must be number'));
 };
 
 var isInteger = function isInteger(n) {
@@ -25,16 +21,16 @@ var isFinite = function isFinite(n) {
   return Number.isFinite(n);
 };
 
-var number = (0, _composition.compose)(anyNumber, (0, _composition.predicate)(isFinite, 'Number must be finite'));
+var number = (0, _composition.predicate)(anyNumber, isFinite, 'Number must be finite');
 exports.number = number;
-var positiveNumber = (0, _composition.compose)(number, (0, _composition.predicate)(function (n) {
+var positiveNumber = (0, _composition.predicate)(number, function (n) {
   return n >= 0;
-}, 'Number must be positive')); // Integers
+}, 'Number must be positive'); // Integers
 
 exports.positiveNumber = positiveNumber;
-var integer = (0, _composition.compose)(number, (0, _composition.predicate)(isInteger, 'Number must be an integer'));
+var integer = (0, _composition.predicate)(number, isInteger, 'Number must be an integer');
 exports.integer = integer;
-var positiveInteger = (0, _composition.compose)(integer, (0, _composition.predicate)(function (n) {
+var positiveInteger = (0, _composition.predicate)(integer, function (n) {
   return n >= 0;
-}, 'Number must be positive'));
+}, 'Number must be positive');
 exports.positiveInteger = positiveInteger;

package/core/number.js.flow

@@ -1,34 +1,40 @@
 // @flow strict
 
-import * as Result from '../result';
 import { annotate } from '../annotate';
-import { compose, predicate } from './composition';
+import { err, ok } from '../result';
+import { predicate } from './composition';
 import type { Decoder } from '../_types';
 
 const anyNumber: Decoder<number> = (blob: mixed) => {
     return typeof blob === 'number' && !Number.isNaN(blob)
-        ? Result.ok(blob)
-        : Result.err(annotate(blob, 'Must be number'));
+        ? ok(blob)
+        : err(annotate(blob, 'Must be number'));
 };
 
 const isInteger = (n: number) => Number.isInteger(n);
 const isFinite = (n: number) => Number.isFinite(n);
 
-export const number: Decoder<number> = compose(
+export const number: Decoder<number> = predicate(
     anyNumber,
-    predicate(isFinite, 'Number must be finite'),
+    isFinite,
+    'Number must be finite',
 );
-export const positiveNumber: Decoder<number> = compose(
+
+export const positiveNumber: Decoder<number> = predicate(
     number,
-    predicate((n) => n >= 0, 'Number must be positive'),
+    (n) => n >= 0,
+    'Number must be positive',
 );
 
 // Integers
-export const integer: Decoder<number> = compose(
+export const integer: Decoder<number> = predicate(
     number,
-    predicate(isInteger, 'Number must be an integer'),
+    isInteger,
+    'Number must be an integer',
 );
-export const positiveInteger: Decoder<number> = compose(
+
+export const positiveInteger: Decoder<number> = predicate(
     integer,
-    predicate((n) => n >= 0, 'Number must be positive'),
+    (n) => n >= 0,
+    'Number must be positive',
 );

package/core/number.mjs

@@ -0,0 +1,25 @@
+import { annotate } from '../annotate.mjs';
+import { err, ok } from '../result.mjs';
+import { predicate } from './composition.mjs';
+
+var anyNumber = function anyNumber(blob) {
+  return typeof blob === 'number' && !Number.isNaN(blob) ? ok(blob) : err(annotate(blob, 'Must be number'));
+};
+
+var isInteger = function isInteger(n) {
+  return Number.isInteger(n);
+};
+
+var isFinite = function isFinite(n) {
+  return Number.isFinite(n);
+};
+
+export var number = predicate(anyNumber, isFinite, 'Number must be finite');
+export var positiveNumber = predicate(number, function (n) {
+  return n >= 0;
+}, 'Number must be positive'); // Integers
+
+export var integer = predicate(number, isInteger, 'Number must be an integer');
+export var positiveInteger = predicate(integer, function (n) {
+  return n >= 0;
+}, 'Number must be positive');

package/core/object.d.ts

@@ -0,0 +1,38 @@
+/// <reference lib="es6" />
+
+import { Decoder, DecoderType } from '../_types';
+import { AllowImplicit } from './_helpers';
+
+export type ObjectDecoderType<T> = AllowImplicit<{
+    [key in keyof T]: DecoderType<T[key]>;
+}>;
+
+export const pojo: Decoder<{ [key: string]: unknown }>;
+
+export function object<O extends { [key: string]: Decoder<any> }>(
+    mapping: O,
+): Decoder<{ [K in keyof ObjectDecoderType<O>]: ObjectDecoderType<O>[K] }>;
+//         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+//         This is basically just equivalent to:
+//             ObjectDecoderType<O>
+//
+//         But by "resolving" this with a mapped type, we remove the helper
+//         type names from the inferred type here, making this much easier to
+//         work with while developing.
+
+export function exact<O extends { [key: string]: Decoder<any> }>(
+    mapping: O,
+): Decoder<{ [K in keyof ObjectDecoderType<O>]: ObjectDecoderType<O>[K] }>;
+//         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+//         Ditto (see above)
+
+export function inexact<O extends { [key: string]: Decoder<any> }>(
+    mapping: O,
+): Decoder<
+    { [K in keyof ObjectDecoderType<O>]: ObjectDecoderType<O>[K] } & {
+        [extra: string]: unknown;
+    }
+>;
+
+export function mapping<T>(decoder: Decoder<T>): Decoder<Map<string, T>>;
+export function dict<T>(decoder: Decoder<T>): Decoder<{ [key: string]: T }>;

package/core/object.js

@@ -1,20 +1,18 @@
 "use strict";
 
 exports.__esModule = true;
+exports.dict = dict;
 exports.exact = exact;
 exports.inexact = inexact;
+exports.mapping = mapping;
 exports.object = object;
 exports.pojo = void 0;
 
-var Result = _interopRequireWildcard(require("../result"));
-
 var _annotate = require("../annotate");
 
 var _composition = require("./composition");
 
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+var _result = require("../result");
 
 function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 
@@ -36,7 +34,7 @@ function subtract(xs, ys) {
 }
 
 var pojo = function pojo(blob) {
-  return isPojo(blob) ? Result.ok( // NOTE:
+  return isPojo(blob) ? (0, _result.ok)( // NOTE:
   // Since Flow 0.98, typeof o === 'object' refines to
   //     {| +[string]: mixed |}
   // instead of
@@ -50,7 +48,7 @@ var pojo = function pojo(blob) {
   // way to turn a read-only Object to a writeable one in ES6 seems
   // to be to use object-spread. (Going off this benchmark:
   // https://thecodebarbarian.com/object-assign-vs-object-spread.html)
-  _extends({}, blob)) : Result.err((0, _annotate.annotate)(blob, 'Must be an object'));
+  _extends({}, blob)) : (0, _result.err)((0, _annotate.annotate)(blob, 'Must be an object'));
 };
 /**
  * Given a mapping of fields-to-decoders, builds a decoder for an object type.
@@ -91,7 +89,7 @@ function object(mapping) {
       var rawValue = blob[key];
       var result = decoder(rawValue);
 
-      if (result.type === 'ok') {
+      if (result.ok) {
         var value = result.value;
 
         if (value !== undefined) {
@@ -139,10 +137,10 @@ function object(mapping) {
         objAnn = (0, _annotate.updateText)(objAnn, "Missing " + pluralized + ": " + errMsg);
       }
 
-      return Result.err(objAnn);
+      return (0, _result.err)(objAnn);
     }
 
-    return Result.ok(record);
+    return (0, _result.ok)(record);
   });
 }
 
@@ -154,10 +152,10 @@ function exact(mapping) {
     var superfluous = subtract(actual, allowed);
 
     if (superfluous.size > 0) {
-      return Result.err((0, _annotate.annotate)(blob, "Superfluous keys: " + Array.from(superfluous).join(', ')));
+      return (0, _result.err)((0, _annotate.annotate)(blob, "Superfluous keys: " + Array.from(superfluous).join(', ')));
     }
 
-    return Result.ok(blob);
+    return (0, _result.ok)(blob);
   }); // Defer to the "object" decoder for doing the real decoding work.  Since
   // we made sure there are no superfluous keys in this structure, it's now
   // safe to force-cast it to an $Exact<> type.
@@ -169,7 +167,7 @@ function exact(mapping) {
 function inexact(mapping) {
   return (0, _composition.compose)(pojo, function (blob) {
     var allkeys = new Set(Object.keys(blob));
-    var decoder = (0, _composition.map)(object(mapping), function (safepart) {
+    var decoder = (0, _composition.transform)(object(mapping), function (safepart) {
       var safekeys = new Set(Object.keys(mapping)); // To account for hard-coded keys that aren't part of the input
 
       safekeys.forEach(function (k) {
@@ -191,4 +189,59 @@ function inexact(mapping) {
     });
     return decoder(blob);
   });
+}
+/**
+ * Like mapping(), but returns an object rather than a Map instance.
+ */
+
+
+function dict(decoder) {
+  return (0, _composition.compose)(pojo, function (blob) {
+    var rv = {};
+    var errors = null;
+    Object.keys(blob).forEach(function (key) {
+      var value = blob[key];
+      var result = decoder(value);
+
+      if (result.ok) {
+        if (errors === null) {
+          rv[key] = result.value;
+        }
+      } else {
+        rv = {}; // Clear the success value so it can get garbage collected early
+
+        if (errors === null) {
+          errors = {};
+        }
+
+        errors[key] = result.error;
+      }
+    });
+
+    if (errors !== null) {
+      return (0, _result.err)((0, _annotate.merge)((0, _annotate.annotateObject)(blob), errors));
+    } else {
+      return (0, _result.ok)(rv);
+    }
+  });
+}
+/**
+ * Given an object, will decode a Map of string keys to whatever values.
+ *
+ * For example, given a decoder for a Person, we can verify a Person lookup
+ * table structure (of type Map<string, Person>) like so:
+ *
+ *   mapping(person)
+ *
+ */
+
+
+function mapping(decoder) {
+  return (0, _composition.transform)(dict(decoder), function (obj) {
+    return new Map( // This is effectively Object.entries(obj), but in a way that Flow
+    // will know the types are okay
+    Object.keys(obj).map(function (key) {
+      return [key, obj[key]];
+    }));
+  });
 }

package/core/object.js.flow

@@ -1,10 +1,10 @@
 // @flow strict
 
-import * as Result from '../result';
 import { annotate, annotateObject, merge, updateText } from '../annotate';
-import { compose, map } from './composition';
+import { compose, transform } from './composition';
+import { err, ok } from '../result';
 import type { Annotation } from '../annotate';
-import type { Decoder, DecoderType } from '../_types';
+import type { Decoder, DecodeResult, DecoderType } from '../_types';
 
 // $FlowFixMe[unclear-type] (not really an issue) - deliberate use of `any` - not sure how we should get rid of this
 type AnyDecoder = any;
@@ -36,7 +36,7 @@ function subtract(xs: Set<string>, ys: Set<string>): Set<string> {
 
 export const pojo: Decoder<{| [string]: mixed |}> = (blob: mixed) => {
     return isPojo(blob)
-        ? Result.ok(
+        ? ok(
               // NOTE:
               // Since Flow 0.98, typeof o === 'object' refines to
               //     {| +[string]: mixed |}
@@ -53,7 +53,7 @@ export const pojo: Decoder<{| [string]: mixed |}> = (blob: mixed) => {
               // https://thecodebarbarian.com/object-assign-vs-object-spread.html)
               { ...blob },
           )
-        : Result.err(annotate(blob, 'Must be an object'));
+        : err(annotate(blob, 'Must be an object'));
 };
 
 /**
@@ -94,9 +94,9 @@ export function object<O: { +[field: string]: AnyDecoder, ... }>(
         Object.keys(mapping).forEach((key) => {
             const decoder = mapping[key];
             const rawValue = blob[key];
-            const result = decoder(rawValue);
+            const result: DecodeResult<mixed> = decoder(rawValue);
 
-            if (result.type === 'ok') {
+            if (result.ok) {
                 const value = result.value;
                 if (value !== undefined) {
                     record[key] = value;
@@ -144,10 +144,10 @@ export function object<O: { +[field: string]: AnyDecoder, ... }>(
                 objAnn = updateText(objAnn, `Missing ${pluralized}: ${errMsg}`);
             }
 
-            return Result.err(objAnn);
+            return err(objAnn);
         }
 
-        return Result.ok(record);
+        return ok(record);
     });
 }
 
@@ -160,11 +160,11 @@ export function exact<O: { +[field: string]: AnyDecoder, ... }>(
         const actual = new Set(Object.keys(blob));
         const superfluous = subtract(actual, allowed);
         if (superfluous.size > 0) {
-            return Result.err(
+            return err(
                 annotate(blob, `Superfluous keys: ${Array.from(superfluous).join(', ')}`),
             );
         }
-        return Result.ok(blob);
+        return ok(blob);
     });
 
     // Defer to the "object" decoder for doing the real decoding work.  Since
@@ -179,25 +179,81 @@ export function inexact<O: { +[field: string]: AnyDecoder }>(
 ): Decoder<$ObjMap<O, DecoderType> & { +[string]: mixed }> {
     return compose(pojo, (blob: {| [string]: mixed |}) => {
         const allkeys = new Set(Object.keys(blob));
-        const decoder = map(object(mapping), (safepart: $ObjMap<O, DecoderType>) => {
-            const safekeys = new Set(Object.keys(mapping));
-
-            // To account for hard-coded keys that aren't part of the input
-            safekeys.forEach((k) => allkeys.add(k));
-
-            const rv = {};
-            allkeys.forEach((k) => {
-                if (safekeys.has(k)) {
-                    const value = safepart[k];
-                    if (value !== undefined) {
-                        rv[k] = value;
+        const decoder = transform(
+            object(mapping),
+            (safepart: $ObjMap<O, DecoderType>) => {
+                const safekeys = new Set(Object.keys(mapping));
+
+                // To account for hard-coded keys that aren't part of the input
+                safekeys.forEach((k) => allkeys.add(k));
+
+                const rv = {};
+                allkeys.forEach((k) => {
+                    if (safekeys.has(k)) {
+                        const value = safepart[k];
+                        if (value !== undefined) {
+                            rv[k] = value;
+                        }
+                    } else {
+                        rv[k] = blob[k];
                     }
-                } else {
-                    rv[k] = blob[k];
+                });
+                return rv;
+            },
+        );
+        return decoder(blob);
+    });
+}
+
+/**
+ * Like mapping(), but returns an object rather than a Map instance.
+ */
+export function dict<T>(decoder: Decoder<T>): Decoder<{ [string]: T }> {
+    return compose(pojo, (blob: { +[key: string]: mixed }) => {
+        let rv: { [key: string]: T } = {};
+        let errors: { [key: string]: Annotation } | null = null;
+
+        Object.keys(blob).forEach((key: string) => {
+            const value = blob[key];
+            const result = decoder(value);
+            if (result.ok) {
+                if (errors === null) {
+                    rv[key] = result.value;
+                }
+            } else {
+                rv = {}; // Clear the success value so it can get garbage collected early
+                if (errors === null) {
+                    errors = {};
                 }
-            });
-            return rv;
+                errors[key] = result.error;
+            }
         });
-        return decoder(blob);
+
+        if (errors !== null) {
+            return err(merge(annotateObject(blob), errors));
+        } else {
+            return ok(rv);
+        }
     });
 }
+
+/**
+ * Given an object, will decode a Map of string keys to whatever values.
+ *
+ * For example, given a decoder for a Person, we can verify a Person lookup
+ * table structure (of type Map<string, Person>) like so:
+ *
+ *   mapping(person)
+ *
+ */
+export function mapping<T>(decoder: Decoder<T>): Decoder<Map<string, T>> {
+    return transform(
+        dict(decoder),
+        (obj) =>
+            new Map(
+                // This is effectively Object.entries(obj), but in a way that Flow
+                // will know the types are okay
+                Object.keys(obj).map((key) => [key, obj[key]]),
+            ),
+    );
+}