decoders 2.0.0-beta8 → 2.0.1

package/core/constants.mjs

@@ -1,46 +0,0 @@
-import { annotate } from '../annotate.mjs';
-import { err, ok } from '../result.mjs';
-
-/**
- * Decoder that only returns Ok for `null` inputs.  Err otherwise.
- */
-export var null_ = function null_(blob) {
-  return blob === null ? ok(blob) : err(annotate(blob, 'Must be null'));
-};
-/**
- * Decoder that only returns Ok for `undefined` inputs.  Err otherwise.
- */
-
-export var undefined_ = function undefined_(blob) {
-  return blob === undefined ? ok(blob) : err(annotate(blob, 'Must be undefined'));
-};
-/**
- * Decoder that only returns Ok for the given value constant.  Err otherwise.
- */
-
-export function constant(value) {
-  return function (blob) {
-    return blob === value ? ok(value) : err(annotate(blob, "Must be constant " + String(value)));
-  };
-}
-/**
- * Decoder that always returns Ok for the given hardcoded value, no matter what the input.
- */
-
-export function hardcoded(value) {
-  return function () {
-    return ok(value);
-  };
-}
-/**
- * Decoder that always returns Ok for the given hardcoded value, no matter what the input.
- */
-
-export var unknown = function unknown(blob) {
-  return ok(blob);
-};
-/**
- * Alias of unknown.
- */
-
-export var mixed = unknown;

package/core/date.d.ts

@@ -1,4 +0,0 @@
-import { Decoder } from '../_types';
-
-export const date: Decoder<Date>;
-export const iso8601: Decoder<Date>;

package/core/date.js

@@ -1,42 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.iso8601 = exports.date = void 0;
-
-var _annotate = require("../annotate");
-
-var _result = require("../result");
-
-var _utils = require("../_utils");
-
-var _composition = require("./composition");
-
-var _string = require("./string");
-
-// Only matches the shape.  This "over-matches" some values that still aren't
-// valid dates (like 9999-99-99), but those will be caught by JS Date's
-// internal validations
-var iso8601_re = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:[.]\d+)?(?:Z|[+-]\d{2}:?\d{2})$/;
-
-var date = function date(value) {
-  return (0, _utils.isDate)(value) ? (0, _result.ok)(value) : (0, _result.err)((0, _annotate.annotate)(value, 'Must be a Date'));
-};
-/**
- * Decoder that only returns Ok for strings that are valid ISO8601 date
- * strings.  Err otherwise.
- */
-
-
-exports.date = date;
-var iso8601 = (0, _composition.map)( // Input itself needs to match the ISO8601 regex...
-(0, _string.regex)(iso8601_re, 'Must be ISO8601 format'), // Make sure it is a _valid_ date
-function (value) {
-  var date = new Date(value);
-
-  if (isNaN(date.getTime())) {
-    throw new Error('Must be valid date/time value');
-  }
-
-  return date;
-});
-exports.iso8601 = iso8601;

package/core/date.js.flow

@@ -1,38 +0,0 @@
-// @flow strict
-
-import { annotate } from '../annotate';
-import { err, ok } from '../result';
-import { isDate } from '../_utils';
-import { map } from './composition';
-import { regex } from './string';
-import type { Decoder } from '../_types';
-
-// $FlowFixMe[unclear-type] (not really an issue) - deliberate casting
-type cast = any;
-
-// Only matches the shape.  This "over-matches" some values that still aren't
-// valid dates (like 9999-99-99), but those will be caught by JS Date's
-// internal validations
-const iso8601_re =
-    /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:[.]\d+)?(?:Z|[+-]\d{2}:?\d{2})$/;
-
-export const date: Decoder<Date> = (value: mixed) =>
-    isDate(value) ? ok(((value: cast): Date)) : err(annotate(value, 'Must be a Date'));
-
-/**
- * Decoder that only returns Ok for strings that are valid ISO8601 date
- * strings.  Err otherwise.
- */
-export const iso8601: Decoder<Date> = map(
-    // Input itself needs to match the ISO8601 regex...
-    regex(iso8601_re, 'Must be ISO8601 format'),
-
-    // Make sure it is a _valid_ date
-    (value: string) => {
-        const date = new Date(value);
-        if (isNaN(date.getTime())) {
-            throw new Error('Must be valid date/time value');
-        }
-        return date;
-    },
-);

package/core/date.mjs

@@ -1,28 +0,0 @@
-import { annotate } from '../annotate.mjs';
-import { err, ok } from '../result.mjs';
-import { isDate } from '../_utils.mjs';
-import { map } from './composition.mjs';
-import { regex } from './string.mjs';
-// Only matches the shape.  This "over-matches" some values that still aren't
-// valid dates (like 9999-99-99), but those will be caught by JS Date's
-// internal validations
-var iso8601_re = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:[.]\d+)?(?:Z|[+-]\d{2}:?\d{2})$/;
-export var date = function date(value) {
-  return isDate(value) ? ok(value) : err(annotate(value, 'Must be a Date'));
-};
-/**
- * Decoder that only returns Ok for strings that are valid ISO8601 date
- * strings.  Err otherwise.
- */
-
-export var iso8601 = map( // Input itself needs to match the ISO8601 regex...
-regex(iso8601_re, 'Must be ISO8601 format'), // Make sure it is a _valid_ date
-function (value) {
-  var date = new Date(value);
-
-  if (isNaN(date.getTime())) {
-    throw new Error('Must be valid date/time value');
-  }
-
-  return date;
-});

package/core/describe.d.ts

@@ -1,3 +0,0 @@
-import { Decoder } from '../_types';
-
-export function describe<T>(decoder: Decoder<T>, msg: string): Decoder<T>;

package/core/describe.js

@@ -1,22 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.describe = describe;
-
-var _annotate = require("../annotate");
-
-var _result = require("../result");
-
-/**
- * Wrap another decoder, and override the error message in case it fails. This
- * is useful to "simplify" otherwise potentially complex error messages, or to
- * use language in those error messages that can be relayed to end users (for
- * example to show in form errors).
- */
-function describe(decoder, message) {
-  return function (blob) {
-    return (0, _result.mapError)(decoder(blob), function (err) {
-      return (0, _annotate.annotate)(err, message);
-    });
-  };
-}

package/core/describe.js.flow

@@ -1,17 +0,0 @@
-// @flow strict
-
-import { annotate } from '../annotate';
-import { mapError } from '../result';
-import type { Decoder } from '../_types';
-
-/**
- * Wrap another decoder, and override the error message in case it fails. This
- * is useful to "simplify" otherwise potentially complex error messages, or to
- * use language in those error messages that can be relayed to end users (for
- * example to show in form errors).
- */
-export function describe<T>(decoder: Decoder<T>, message: string): Decoder<T> {
-    return (blob: mixed) => {
-        return mapError(decoder(blob), (err) => annotate(err, message));
-    };
-}

package/core/describe.mjs

@@ -1,16 +0,0 @@
-import { annotate } from '../annotate.mjs';
-import { mapError } from '../result.mjs';
-
-/**
- * Wrap another decoder, and override the error message in case it fails. This
- * is useful to "simplify" otherwise potentially complex error messages, or to
- * use language in those error messages that can be relayed to end users (for
- * example to show in form errors).
- */
-export function describe(decoder, message) {
-  return function (blob) {
-    return mapError(decoder(blob), function (err) {
-      return annotate(err, message);
-    });
-  };
-}

package/core/dispatch.d.ts

@@ -1,8 +0,0 @@
-import { Decoder, DecoderType } from '../_types';
-
-export type Values<T extends object> = T[keyof T];
-
-export function disjointUnion<O extends { [key: string]: Decoder<any> }>(
-    field: string,
-    mapping: O,
-): Decoder<Values<{ [key in keyof O]: DecoderType<O[key]> }>>;

package/core/dispatch.js

@@ -1,58 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.disjointUnion = disjointUnion;
-
-var _result = require("../result");
-
-var _object2 = require("./object");
-
-var _either = require("./either");
-
-/**
- * Dispatches to one of several given decoders, based on the value found at
- * runtime in the given field.  For example, suppose you have these decoders:
- *
- *     const rectangle = object({
- *         type: constant('rect'),
- *         x: number,
- *         y: number,
- *         width: number,
- *         height: number,
- *     });
- *
- *     const circle = object({
- *         type: constant('circle'),
- *         cx: number,
- *         cy: number,
- *         r: number,
- *      });
- *
- * Then these two decoders are equivalent:
- *
- *     const shape = either(rectangle, circle)
- *     const shape = disjointUnion('type', { rectangle, circle })
- *
- * Will be of type Decoder<Rectangle | Circle>.
- *
- * But `disjointUnion` will typically be more runtime-efficient.  The reason is
- * that it will first do minimal work to "look ahead" into the `type` field
- * here, and based on that value, pick the decoder to invoke.
- *
- * The `either` version will simply try to invoke each decoder, until it finds
- * one that matches.
- *
- * Also, the error messages will be less ambiguous using `disjointUnion()`.
- */
-function disjointUnion(field, mapping) {
-  var _object;
-
-  var base = (0, _object2.object)((_object = {}, _object[field] = (0, _either.oneOf)(Object.keys(mapping)), _object));
-  return function (blob) {
-    return (0, _result.andThen)(base(blob), function (baseObj) {
-      var decoderName = baseObj[field];
-      var decoder = mapping[decoderName];
-      return decoder(blob);
-    });
-  };
-}

package/core/dispatch.js.flow

@@ -1,58 +0,0 @@
-// @flow strict
-
-import { andThen } from '../result';
-import { object } from './object';
-import { oneOf } from './either';
-import type { Decoder, DecoderType } from '../_types';
-
-// $FlowFixMe[unclear-type] (not really an issue) - deliberate use of `any` - not sure how we should get rid of this
-type anything = any;
-
-/**
- * Dispatches to one of several given decoders, based on the value found at
- * runtime in the given field.  For example, suppose you have these decoders:
- *
- *     const rectangle = object({
- *         type: constant('rect'),
- *         x: number,
- *         y: number,
- *         width: number,
- *         height: number,
- *     });
- *
- *     const circle = object({
- *         type: constant('circle'),
- *         cx: number,
- *         cy: number,
- *         r: number,
- *      });
- *
- * Then these two decoders are equivalent:
- *
- *     const shape = either(rectangle, circle)
- *     const shape = disjointUnion('type', { rectangle, circle })
- *
- * Will be of type Decoder<Rectangle | Circle>.
- *
- * But `disjointUnion` will typically be more runtime-efficient.  The reason is
- * that it will first do minimal work to "look ahead" into the `type` field
- * here, and based on that value, pick the decoder to invoke.
- *
- * The `either` version will simply try to invoke each decoder, until it finds
- * one that matches.
- *
- * Also, the error messages will be less ambiguous using `disjointUnion()`.
- */
-export function disjointUnion<O: { +[field: string]: Decoder<anything>, ... }>(
-    field: string,
-    mapping: O,
-): Decoder<$Values<$ObjMap<O, DecoderType>>> {
-    const base = object({ [field]: oneOf(Object.keys(mapping)) });
-    return (blob: mixed) => {
-        return andThen(base(blob), (baseObj) => {
-            const decoderName = baseObj[field];
-            const decoder = mapping[decoderName];
-            return decoder(blob);
-        });
-    };
-}

package/core/dispatch.mjs

@@ -1,51 +0,0 @@
-import { andThen } from '../result.mjs';
-import { object } from './object.mjs';
-import { oneOf } from './either.mjs';
-
-/**
- * Dispatches to one of several given decoders, based on the value found at
- * runtime in the given field.  For example, suppose you have these decoders:
- *
- *     const rectangle = object({
- *         type: constant('rect'),
- *         x: number,
- *         y: number,
- *         width: number,
- *         height: number,
- *     });
- *
- *     const circle = object({
- *         type: constant('circle'),
- *         cx: number,
- *         cy: number,
- *         r: number,
- *      });
- *
- * Then these two decoders are equivalent:
- *
- *     const shape = either(rectangle, circle)
- *     const shape = disjointUnion('type', { rectangle, circle })
- *
- * Will be of type Decoder<Rectangle | Circle>.
- *
- * But `disjointUnion` will typically be more runtime-efficient.  The reason is
- * that it will first do minimal work to "look ahead" into the `type` field
- * here, and based on that value, pick the decoder to invoke.
- *
- * The `either` version will simply try to invoke each decoder, until it finds
- * one that matches.
- *
- * Also, the error messages will be less ambiguous using `disjointUnion()`.
- */
-export function disjointUnion(field, mapping) {
-  var _object;
-
-  var base = object((_object = {}, _object[field] = oneOf(Object.keys(mapping)), _object));
-  return function (blob) {
-    return andThen(base(blob), function (baseObj) {
-      var decoderName = baseObj[field];
-      var decoder = mapping[decoderName];
-      return decoder(blob);
-    });
-  };
-}

package/core/either.d.ts

@@ -1,61 +0,0 @@
-import { Decoder, Scalar } from '../_types';
-
-export function either<T1, T2>(d1: Decoder<T1>, d2: Decoder<T2>): Decoder<T1 | T2>;
-export function either2<T1, T2>(d1: Decoder<T1>, d2: Decoder<T2>): Decoder<T1 | T2>;
-export function either3<T1, T2, T3>(
-    d1: Decoder<T1>,
-    d2: Decoder<T2>,
-    d3: Decoder<T3>,
-): Decoder<T1 | T2 | T3>;
-export function either4<T1, T2, T3, T4>(
-    d1: Decoder<T1>,
-    d2: Decoder<T2>,
-    d3: Decoder<T3>,
-    d4: Decoder<T4>,
-): Decoder<T1 | T2 | T3 | T4>;
-export function either5<T1, T2, T3, T4, T5>(
-    d1: Decoder<T1>,
-    d2: Decoder<T2>,
-    d3: Decoder<T3>,
-    d4: Decoder<T4>,
-    d5: Decoder<T5>,
-): Decoder<T1 | T2 | T3 | T4 | T5>;
-export function either6<T1, T2, T3, T4, T5, T6>(
-    d1: Decoder<T1>,
-    d2: Decoder<T2>,
-    d3: Decoder<T3>,
-    d4: Decoder<T4>,
-    d5: Decoder<T5>,
-    d6: Decoder<T6>,
-): Decoder<T1 | T2 | T3 | T4 | T5 | T6>;
-export function either7<T1, T2, T3, T4, T5, T6, T7>(
-    d1: Decoder<T1>,
-    d2: Decoder<T2>,
-    d3: Decoder<T3>,
-    d4: Decoder<T4>,
-    d5: Decoder<T5>,
-    d6: Decoder<T6>,
-    d7: Decoder<T7>,
-): Decoder<T1 | T2 | T3 | T4 | T5 | T6 | T7>;
-export function either8<T1, T2, T3, T4, T5, T6, T7, T8>(
-    d1: Decoder<T1>,
-    d2: Decoder<T2>,
-    d3: Decoder<T3>,
-    d4: Decoder<T4>,
-    d5: Decoder<T5>,
-    d6: Decoder<T6>,
-    d7: Decoder<T7>,
-    d8: Decoder<T8>,
-): Decoder<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8>;
-export function either9<T1, T2, T3, T4, T5, T6, T7, T8, T9>(
-    d1: Decoder<T1>,
-    d2: Decoder<T2>,
-    d3: Decoder<T3>,
-    d4: Decoder<T4>,
-    d5: Decoder<T5>,
-    d6: Decoder<T6>,
-    d7: Decoder<T7>,
-    d8: Decoder<T8>,
-    d9: Decoder<T9>,
-): Decoder<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8 | T9>;
-export function oneOf<T extends Scalar>(constants: readonly T[]): Decoder<T>;

package/core/either.js

@@ -1,113 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.either = either;
-exports.either3 = either3;
-exports.either4 = either4;
-exports.either5 = either5;
-exports.either6 = either6;
-exports.either7 = either7;
-exports.either8 = either8;
-exports.either9 = either9;
-exports.oneOf = oneOf;
-
-var _annotate = require("../annotate");
-
-var _result = require("../result");
-
-var _utils = require("../_utils");
-
-/**
- * Indents and adds a dash in front of this (potentially multiline) string.
- */
-function itemize(s) {
-  return '-' + (0, _utils.indent)(s).substring(1);
-}
-/**
- * Nests another error as an item under a new-to-be-created "Either error". If
- * the given subitem already is an "Either error" of itself, don't indent, but
- * just "inject" its items at the same error level, for nicely flattened either
- * expressions.
- *
- * Avoids:
- *
- *     Either:
- *     - Either:
- *       - Must be P
- *       - Either:
- *         - Must be Q
- *         - Must be R
- *     - Must be S
- *
- * And "flattens" these to:
- *
- *     Either:
- *     - Must be P
- *     - Must be Q
- *     - Must be R
- *     - Must be S
- *
- */
-
-
-function nest(errText) {
-  var EITHER_PREFIX = 'Either:\n';
-  return errText.startsWith(EITHER_PREFIX) ? errText.substr(EITHER_PREFIX.length) : itemize(errText);
-}
-
-function either(d1, d2) {
-  return function (blob) {
-    return (0, _result.orElse)(d1(blob), function (err1) {
-      return (0, _result.orElse)(d2(blob), function (err2) {
-        var serr1 = (0, _utils.summarize)(err1).join('\n');
-        var serr2 = (0, _utils.summarize)(err2).join('\n');
-        var text = ['Either:', nest(serr1), nest(serr2)].join('\n');
-        return (0, _result.err)((0, _annotate.annotate)(blob, text));
-      });
-    });
-  };
-}
-
-function either3(d1, d2, d3) {
-  return either(d1, either(d2, d3));
-}
-
-function either4(d1, d2, d3, d4) {
-  return either(d1, either3(d2, d3, d4));
-}
-
-function either5(d1, d2, d3, d4, d5) {
-  return either(d1, either4(d2, d3, d4, d5));
-}
-
-function either6(d1, d2, d3, d4, d5, d6) {
-  return either(d1, either5(d2, d3, d4, d5, d6));
-}
-
-function either7(d1, d2, d3, d4, d5, d6, d7) {
-  return either(d1, either6(d2, d3, d4, d5, d6, d7));
-}
-
-function either8(d1, d2, d3, d4, d5, d6, d7, d8) {
-  return either(d1, either7(d2, d3, d4, d5, d6, d7, d8));
-}
-
-function either9(d1, d2, d3, d4, d5, d6, d7, d8, d9) {
-  return either(d1, either8(d2, d3, d4, d5, d6, d7, d8, d9));
-}
-
-function oneOf(constants) {
-  return function (blob) {
-    var winner = constants.find(function (c) {
-      return c === blob;
-    });
-
-    if (winner !== undefined) {
-      return (0, _result.ok)(winner);
-    }
-
-    return (0, _result.err)((0, _annotate.annotate)(blob, "Must be one of " + constants.map(function (value) {
-      return JSON.stringify(value);
-    }).join(', ')));
-  };
-}