decoders 1.25.4 → 2.0.0-beta1

package/either.js

@@ -1,85 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: 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 _debrief = require("debrief");
-
-var _Result = require("lemons/Result");
-
-/**
- * Indents and adds a dash in front of this (potentially multiline) string.
- */
-// istanbul ignore next
-function itemize() {
-  var s = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
-  return '-' + (0, _debrief.indent)(s).substring(1);
-}
-
-function either(d1, d2) {
-  return function (blob) {
-    return d1(blob).dispatch(function (value1) {
-      return (0, _Result.Ok)(value1);
-    }, function (err1) {
-      return d2(blob).dispatch(function (value2) {
-        return (0, _Result.Ok)(value2);
-      }, function (err2) {
-        return (0, _Result.Err)((0, _debrief.annotate)(blob, ['Either:', itemize((0, _debrief.summarize)(err1).join('\n')), itemize((0, _debrief.summarize)(err2).join('\n'))].join('\n')));
-      });
-    });
-  };
-}
-
-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, _debrief.annotate)(blob, "Must be one of ".concat(constants.map(function (value) {
-      return JSON.stringify(value);
-    }).join(', '))));
-  };
-}

package/fail.js

@@ -1,19 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.fail = fail;
-
-var _debrief = require("debrief");
-
-var _Result = require("lemons/Result");
-
-/**
- * Decoder that always fails with the given error message, no matter what the input.
- */
-function fail(msg) {
-  return function (blob) {
-    return (0, _Result.Err)((0, _debrief.annotate)(blob, msg));
-  };
-}

package/fail.js.flow

@@ -1,13 +0,0 @@
-// @flow strict
-
-import { annotate } from 'debrief';
-import { Err } from 'lemons/Result';
-
-import type { Decoder } from './types';
-
-/**
- * Decoder that always fails with the given error message, no matter what the input.
- */
-export function fail(msg: string): Decoder<empty> {
-    return (blob: mixed) => Err(annotate(blob, msg));
-}

package/guard.d.ts

@@ -1,7 +0,0 @@
-import { Decoder, Guard } from './types';
-
-export interface Options {
-    style?: 'inline' | 'simple';
-}
-
-export function guard<T>(decoder: Decoder<T>, options?: Options): Guard<T>;

package/guard.js

@@ -1,30 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.guard = guard;
-
-var _debrief = require("debrief");
-
-/**
- * Alternative for serialize() that does not echo back the input value.
- */
-function serializeSimple(annotation) {
-  return (0, _debrief.summarize)(annotation).join('\n');
-}
-
-function guard(decoder, options) {
-  var o = options || {};
-  var style = o.style || 'inline';
-  var serializer = style === 'inline' ? _debrief.serialize // Normal serializer, which echoes back inputted value and inlines errors
-  : serializeSimple; // Only returns error messages, without echoing back input
-
-  return function (blob) {
-    return decoder(blob).mapError(function (annotation) {
-      var err = new Error('\n' + serializer(annotation));
-      err.name = 'Decoding error';
-      return err;
-    }).unwrap();
-  };
-}

package/guard.js.flow

@@ -1,36 +0,0 @@
-// @flow strict
-
-import { serialize as serializeInline, summarize } from 'debrief';
-import type { Annotation } from 'debrief';
-
-import type { Decoder, Guard } from './types';
-
-type Options = {|
-    style?: 'inline' | 'simple', // `inline` by default
-|};
-
-/**
- * Alternative for serialize() that does not echo back the input value.
- */
-function serializeSimple(annotation: Annotation) {
-    return summarize(annotation).join('\n');
-}
-
-export function guard<T>(decoder: Decoder<T>, options?: Options): Guard<T> {
-    const o = options || {};
-    const style = o.style || 'inline';
-
-    const serializer =
-        style === 'inline'
-            ? serializeInline // Normal serializer, which echoes back inputted value and inlines errors
-            : serializeSimple; // Only returns error messages, without echoing back input
-
-    return (blob: mixed) =>
-        decoder(blob)
-            .mapError((annotation) => {
-                const err = new Error('\n' + serializer(annotation));
-                err.name = 'Decoding error';
-                return err;
-            })
-            .unwrap();
-}

package/helpers.d.ts

@@ -1,62 +0,0 @@
-/**
- * Given a type like:
- *
- *   {
- *     a: string;
- *     b: number | undefined;
- *     c: null | undefined;
- *     d: null;
- *     e: undefined;
- *   }
- *
- * Will drop all the "undefined" types. In this case, only "e":
- *
- *   {
- *     a: string;
- *     b: number | undefined;
- *     c: null | undefined;
- *     d: null;
- *   }
- *
- */
-type Compact<T> = { [K in IsDefined<T, keyof T>]: T[K] };
-
-type IsDefined<T, K extends keyof T> = K extends any
-    ? T[K] extends undefined
-        ? never
-        : K
-    : never;
-
-export type RequiredKeys<T> = keyof Compact<
-    { [K in keyof T]: undefined extends T[K] ? undefined : 1 }
->;
-
-export type OptionalKeys<T> = keyof Compact<
-    { [K in keyof T]: undefined extends T[K] ? 1 : undefined }
->;
-
-/**
- * Transforms an object type, by marking all fields that contain "undefined"
- * with a question mark, i.e. allowing implicit-undefineds when
- * explicit-undefined are also allowed.
- *
- * For example, if:
- *
- *   type User = {
- *     name: string;
- *     age: number | null | undefined;
- *   }
- *
- * Then AllowImplicit<User> will become equivalent to:
- *
- *   {
- *     name: string;
- *     age?: number | null;
- *        ^
- *        Note the question mark
- *   }
- */
-type AllowImplicit<T> = { [K in RequiredKeys<T>]-?: T[K] } &
-    { [K in OptionalKeys<T>]+?: Exclude<T[K], undefined> };
-
-export { AllowImplicit };

package/index.d.ts

@@ -1,38 +0,0 @@
-import { Decoder, DecoderType, Guard, GuardType } from './types';
-
-export { guard } from './guard';
-export { compose, map, predicate } from './utils';
-
-export { array, nonEmptyArray, poja } from './array';
-export { boolean, numericBoolean, truthy } from './boolean';
-export { constant, hardcoded, mixed, null_, undefined_, unknown } from './constants';
-export { date, iso8601 } from './date';
-export { describe } from './describe';
-export { dispatch } from './dispatch';
-export {
-    either,
-    either3,
-    either4,
-    either5,
-    either6,
-    either7,
-    either8,
-    either9,
-    oneOf,
-} from './either';
-export { fail } from './fail';
-export { instanceOf } from './instanceOf';
-export { json, jsonArray, jsonObject } from './json';
-export { lazy } from './lazy';
-export { mapping, dict } from './mapping';
-export { integer, number, positiveInteger, positiveNumber } from './number';
-export { exact, inexact, object, pojo } from './object';
-export { maybe, nullable, optional } from './optional';
-export { email, nonEmptyString, regex, string, url } from './string';
-export { tuple1, tuple2, tuple3, tuple4, tuple5, tuple6 } from './tuple';
-
-export { Decoder, Guard };
-export { DecoderType, GuardType };
-export { JSONArray, JSONObject, JSONValue } from './json';
-
-export type $DecoderType<T> = DecoderType<T>; // Alias for backward compatibility

package/index.js

@@ -1,397 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "array", {
-  enumerable: true,
-  get: function get() {
-    return _array.array;
-  }
-});
-Object.defineProperty(exports, "boolean", {
-  enumerable: true,
-  get: function get() {
-    return _boolean["boolean"];
-  }
-});
-Object.defineProperty(exports, "compose", {
-  enumerable: true,
-  get: function get() {
-    return _utils.compose;
-  }
-});
-Object.defineProperty(exports, "constant", {
-  enumerable: true,
-  get: function get() {
-    return _constants.constant;
-  }
-});
-Object.defineProperty(exports, "date", {
-  enumerable: true,
-  get: function get() {
-    return _date.date;
-  }
-});
-Object.defineProperty(exports, "describe", {
-  enumerable: true,
-  get: function get() {
-    return _describe.describe;
-  }
-});
-Object.defineProperty(exports, "dict", {
-  enumerable: true,
-  get: function get() {
-    return _mapping.dict;
-  }
-});
-Object.defineProperty(exports, "dispatch", {
-  enumerable: true,
-  get: function get() {
-    return _dispatch.dispatch;
-  }
-});
-Object.defineProperty(exports, "either", {
-  enumerable: true,
-  get: function get() {
-    return _either.either;
-  }
-});
-Object.defineProperty(exports, "either3", {
-  enumerable: true,
-  get: function get() {
-    return _either.either3;
-  }
-});
-Object.defineProperty(exports, "either4", {
-  enumerable: true,
-  get: function get() {
-    return _either.either4;
-  }
-});
-Object.defineProperty(exports, "either5", {
-  enumerable: true,
-  get: function get() {
-    return _either.either5;
-  }
-});
-Object.defineProperty(exports, "either6", {
-  enumerable: true,
-  get: function get() {
-    return _either.either6;
-  }
-});
-Object.defineProperty(exports, "either7", {
-  enumerable: true,
-  get: function get() {
-    return _either.either7;
-  }
-});
-Object.defineProperty(exports, "either8", {
-  enumerable: true,
-  get: function get() {
-    return _either.either8;
-  }
-});
-Object.defineProperty(exports, "either9", {
-  enumerable: true,
-  get: function get() {
-    return _either.either9;
-  }
-});
-Object.defineProperty(exports, "email", {
-  enumerable: true,
-  get: function get() {
-    return _string.email;
-  }
-});
-Object.defineProperty(exports, "exact", {
-  enumerable: true,
-  get: function get() {
-    return _object.exact;
-  }
-});
-Object.defineProperty(exports, "fail", {
-  enumerable: true,
-  get: function get() {
-    return _fail.fail;
-  }
-});
-Object.defineProperty(exports, "guard", {
-  enumerable: true,
-  get: function get() {
-    return _guard.guard;
-  }
-});
-Object.defineProperty(exports, "hardcoded", {
-  enumerable: true,
-  get: function get() {
-    return _constants.hardcoded;
-  }
-});
-Object.defineProperty(exports, "inexact", {
-  enumerable: true,
-  get: function get() {
-    return _object.inexact;
-  }
-});
-Object.defineProperty(exports, "instanceOf", {
-  enumerable: true,
-  get: function get() {
-    return _instanceOf.instanceOf;
-  }
-});
-Object.defineProperty(exports, "integer", {
-  enumerable: true,
-  get: function get() {
-    return _number.integer;
-  }
-});
-Object.defineProperty(exports, "iso8601", {
-  enumerable: true,
-  get: function get() {
-    return _date.iso8601;
-  }
-});
-Object.defineProperty(exports, "json", {
-  enumerable: true,
-  get: function get() {
-    return _json.json;
-  }
-});
-Object.defineProperty(exports, "jsonArray", {
-  enumerable: true,
-  get: function get() {
-    return _json.jsonArray;
-  }
-});
-Object.defineProperty(exports, "jsonObject", {
-  enumerable: true,
-  get: function get() {
-    return _json.jsonObject;
-  }
-});
-Object.defineProperty(exports, "lazy", {
-  enumerable: true,
-  get: function get() {
-    return _lazy.lazy;
-  }
-});
-Object.defineProperty(exports, "map", {
-  enumerable: true,
-  get: function get() {
-    return _utils.map;
-  }
-});
-Object.defineProperty(exports, "mapping", {
-  enumerable: true,
-  get: function get() {
-    return _mapping.mapping;
-  }
-});
-Object.defineProperty(exports, "maybe", {
-  enumerable: true,
-  get: function get() {
-    return _optional.maybe;
-  }
-});
-Object.defineProperty(exports, "mixed", {
-  enumerable: true,
-  get: function get() {
-    return _constants.mixed;
-  }
-});
-Object.defineProperty(exports, "nonEmptyArray", {
-  enumerable: true,
-  get: function get() {
-    return _array.nonEmptyArray;
-  }
-});
-Object.defineProperty(exports, "nonEmptyString", {
-  enumerable: true,
-  get: function get() {
-    return _string.nonEmptyString;
-  }
-});
-Object.defineProperty(exports, "null_", {
-  enumerable: true,
-  get: function get() {
-    return _constants.null_;
-  }
-});
-Object.defineProperty(exports, "nullable", {
-  enumerable: true,
-  get: function get() {
-    return _optional.nullable;
-  }
-});
-Object.defineProperty(exports, "number", {
-  enumerable: true,
-  get: function get() {
-    return _number.number;
-  }
-});
-Object.defineProperty(exports, "numericBoolean", {
-  enumerable: true,
-  get: function get() {
-    return _boolean.numericBoolean;
-  }
-});
-Object.defineProperty(exports, "object", {
-  enumerable: true,
-  get: function get() {
-    return _object.object;
-  }
-});
-Object.defineProperty(exports, "oneOf", {
-  enumerable: true,
-  get: function get() {
-    return _either.oneOf;
-  }
-});
-Object.defineProperty(exports, "optional", {
-  enumerable: true,
-  get: function get() {
-    return _optional.optional;
-  }
-});
-Object.defineProperty(exports, "poja", {
-  enumerable: true,
-  get: function get() {
-    return _array.poja;
-  }
-});
-Object.defineProperty(exports, "pojo", {
-  enumerable: true,
-  get: function get() {
-    return _object.pojo;
-  }
-});
-Object.defineProperty(exports, "positiveInteger", {
-  enumerable: true,
-  get: function get() {
-    return _number.positiveInteger;
-  }
-});
-Object.defineProperty(exports, "positiveNumber", {
-  enumerable: true,
-  get: function get() {
-    return _number.positiveNumber;
-  }
-});
-Object.defineProperty(exports, "predicate", {
-  enumerable: true,
-  get: function get() {
-    return _utils.predicate;
-  }
-});
-Object.defineProperty(exports, "regex", {
-  enumerable: true,
-  get: function get() {
-    return _string.regex;
-  }
-});
-Object.defineProperty(exports, "string", {
-  enumerable: true,
-  get: function get() {
-    return _string.string;
-  }
-});
-Object.defineProperty(exports, "truthy", {
-  enumerable: true,
-  get: function get() {
-    return _boolean.truthy;
-  }
-});
-Object.defineProperty(exports, "tuple1", {
-  enumerable: true,
-  get: function get() {
-    return _tuple.tuple1;
-  }
-});
-Object.defineProperty(exports, "tuple2", {
-  enumerable: true,
-  get: function get() {
-    return _tuple.tuple2;
-  }
-});
-Object.defineProperty(exports, "tuple3", {
-  enumerable: true,
-  get: function get() {
-    return _tuple.tuple3;
-  }
-});
-Object.defineProperty(exports, "tuple4", {
-  enumerable: true,
-  get: function get() {
-    return _tuple.tuple4;
-  }
-});
-Object.defineProperty(exports, "tuple5", {
-  enumerable: true,
-  get: function get() {
-    return _tuple.tuple5;
-  }
-});
-Object.defineProperty(exports, "tuple6", {
-  enumerable: true,
-  get: function get() {
-    return _tuple.tuple6;
-  }
-});
-Object.defineProperty(exports, "undefined_", {
-  enumerable: true,
-  get: function get() {
-    return _constants.undefined_;
-  }
-});
-Object.defineProperty(exports, "unknown", {
-  enumerable: true,
-  get: function get() {
-    return _constants.unknown;
-  }
-});
-Object.defineProperty(exports, "url", {
-  enumerable: true,
-  get: function get() {
-    return _string.url;
-  }
-});
-
-var _guard = require("./guard");
-
-var _utils = require("./utils");
-
-var _array = require("./array");
-
-var _boolean = require("./boolean");
-
-var _constants = require("./constants");
-
-var _date = require("./date");
-
-var _describe = require("./describe");
-
-var _dispatch = require("./dispatch");
-
-var _either = require("./either");
-
-var _fail = require("./fail");
-
-var _instanceOf = require("./instanceOf");
-
-var _json = require("./json");
-
-var _lazy = require("./lazy");
-
-var _mapping = require("./mapping");
-
-var _number = require("./number");
-
-var _object = require("./object");
-
-var _optional = require("./optional");
-
-var _string = require("./string");
-
-var _tuple = require("./tuple");

package/instanceOf.js

@@ -1,17 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.instanceOf = instanceOf;
-
-var _debrief = require("debrief");
-
-var _Result = require("lemons/Result");
-
-function instanceOf(klass) {
-  return function (blob) {
-    return blob instanceof klass ? (0, _Result.Ok)(blob) : (0, _Result.Err)((0, _debrief.annotate)(blob, "Must be ".concat( // $FlowFixMe[incompatible-use] - klass.name is fine?
-    klass.name, " instance")));
-  };
-}