decoders 2.0.0-beta1 → 2.0.0-beta13

package/cjs/index.js

@@ -1,120 +0,0 @@
-"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.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.dispatch = exports.dict = exports.describe = exports.date = exports.constant = exports.compose = exports["boolean"] = exports.array = void 0;
-
-var _guard = require("./_guard");
-
-exports.guard = _guard.guard;
-
-var _composition = require("./stdlib/composition");
-
-exports.compose = _composition.compose;
-exports.map = _composition.map;
-exports.predicate = _composition.predicate;
-
-var _array = require("./stdlib/array");
-
-exports.array = _array.array;
-exports.nonEmptyArray = _array.nonEmptyArray;
-exports.poja = _array.poja;
-
-var _boolean = require("./stdlib/boolean");
-
-exports["boolean"] = _boolean["boolean"];
-exports.numericBoolean = _boolean.numericBoolean;
-exports.truthy = _boolean.truthy;
-
-var _constants = require("./stdlib/constants");
-
-exports.constant = _constants.constant;
-exports.hardcoded = _constants.hardcoded;
-exports.mixed = _constants.mixed;
-exports.null_ = _constants.null_;
-exports.undefined_ = _constants.undefined_;
-exports.unknown = _constants.unknown;
-
-var _date = require("./stdlib/date");
-
-exports.date = _date.date;
-exports.iso8601 = _date.iso8601;
-
-var _describe = require("./stdlib/describe");
-
-exports.describe = _describe.describe;
-
-var _dispatch = require("./stdlib/dispatch");
-
-exports.dispatch = _dispatch.dispatch;
-
-var _either = require("./stdlib/either");
-
-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;
-
-var _fail = require("./stdlib/fail");
-
-exports.fail = _fail.fail;
-
-var _instanceOf = require("./stdlib/instanceOf");
-
-exports.instanceOf = _instanceOf.instanceOf;
-
-var _json = require("./stdlib/json");
-
-exports.json = _json.json;
-exports.jsonObject = _json.jsonObject;
-exports.jsonArray = _json.jsonArray;
-
-var _lazy = require("./stdlib/lazy");
-
-exports.lazy = _lazy.lazy;
-
-var _mapping = require("./stdlib/mapping");
-
-exports.mapping = _mapping.mapping;
-exports.dict = _mapping.dict;
-
-var _number = require("./stdlib/number");
-
-exports.integer = _number.integer;
-exports.number = _number.number;
-exports.positiveInteger = _number.positiveInteger;
-exports.positiveNumber = _number.positiveNumber;
-
-var _object = require("./stdlib/object");
-
-exports.exact = _object.exact;
-exports.inexact = _object.inexact;
-exports.object = _object.object;
-exports.pojo = _object.pojo;
-
-var _optional = require("./stdlib/optional");
-
-exports.maybe = _optional.maybe;
-exports.nullable = _optional.nullable;
-exports.optional = _optional.optional;
-
-var _string = require("./stdlib/string");
-
-exports.email = _string.email;
-exports.nonEmptyString = _string.nonEmptyString;
-exports.regex = _string.regex;
-exports.string = _string.string;
-exports.url = _string.url;
-
-var _tuple = require("./stdlib/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;

package/cjs/index.js.flow

@@ -1,63 +0,0 @@
-// @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, Guard } from './_types';
-export type { DecoderType, GuardType } from './_types';
-
-export type { JSONValue, JSONObject, JSONArray } from './stdlib/json';
-
-export { guard } from './_guard';
-
-export { compose, map, predicate } from './stdlib/composition';
-
-export { array, nonEmptyArray, poja } from './stdlib/array';
-export { boolean, numericBoolean, truthy } from './stdlib/boolean';
-export {
-    constant,
-    hardcoded,
-    mixed,
-    null_,
-    undefined_,
-    unknown,
-} from './stdlib/constants';
-export { date, iso8601 } from './stdlib/date';
-export { describe } from './stdlib/describe';
-export { dispatch } from './stdlib/dispatch';
-export {
-    either,
-    either3,
-    either4,
-    either5,
-    either6,
-    either7,
-    either8,
-    either9,
-    oneOf,
-} from './stdlib/either';
-export { fail } from './stdlib/fail';
-export { instanceOf } from './stdlib/instanceOf';
-export { json, jsonObject, jsonArray } from './stdlib/json';
-export { lazy } from './stdlib/lazy';
-export { mapping, dict } from './stdlib/mapping';
-export { integer, number, positiveInteger, positiveNumber } from './stdlib/number';
-export { exact, inexact, object, pojo } from './stdlib/object';
-export { maybe, nullable, optional } from './stdlib/optional';
-export { email, nonEmptyString, regex, string, url } from './stdlib/string';
-export { tuple1, tuple2, tuple3, tuple4, tuple5, tuple6 } from './stdlib/tuple';

package/cjs/result.js

@@ -1,172 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.andThen = andThen;
-exports.dispatch = dispatch;
-exports.err = err;
-exports.errValue = errValue;
-exports.expect = expect;
-exports.isErr = isErr;
-exports.isOk = isOk;
-exports.map = map;
-exports.mapError = mapError;
-exports.ok = ok;
-exports.orElse = orElse;
-exports.toString = toString;
-exports.unwrap = unwrap;
-exports.value = value;
-exports.withDefault = withDefault;
-
-/**
- * Result <value> <error>
- *     = Ok <value>
- *     | Err <error>
- */
-
-/**
- * Create a new Result instance representing a successful computation.
- */
-function ok(value) {
-  return {
-    type: 'ok',
-    value: value
-  };
-}
-/**
- * Create a new Result instance representing a failed computation.
- */
-
-
-function err(error) {
-  return {
-    type: 'err',
-    error: error
-  };
-}
-
-function toString(result) {
-  return result.type === 'ok' ? "Ok(" + String(result.value) + ")" : "Err(" + String(result.error) + ")";
-}
-
-function isOk(result) {
-  return result.type === 'ok';
-}
-
-function isErr(result) {
-  return result.type === 'err';
-}
-
-function withDefault(result, defaultValue) {
-  return result.type === 'ok' ? result.value : defaultValue;
-}
-
-function value(result) {
-  return result.type === 'ok' ? result.value : undefined;
-}
-
-function errValue(result) {
-  return result.type === 'err' ? result.error : undefined;
-}
-/**
- * Unwrap the value from this Result instance if this is an "Ok" result.
- * Otherwise, will throw the "Err" error via a runtime exception.
- */
-
-
-function unwrap(result) {
-  if (result.type === 'ok') {
-    return result.value;
-  } else {
-    throw result.error;
-  }
-}
-
-function expect(result, message) {
-  if (result.type === 'ok') {
-    return result.value;
-  } else {
-    throw message instanceof Error ? message : new Error(message);
-  }
-}
-
-function dispatch(result, okCallback, errCallback) {
-  return result.type === 'ok' ? okCallback(result.value) : errCallback(result.error);
-}
-/**
- * If the given result is OK, defers to the other result. Otherwise returns the
- * error result.
- *
- * It's like saying A && B, but on Result.
- *
- * Examples:
- *
- *     Result.ok(42)     && Result.ok('hi')    // => Ok('hi')
- *     Result.err('boo') && Result.ok('hi')    // => Err('boo')
- *     Result.ok(42)     && Result.err('boo')  // => Err('boo')
- *     Result.err('boo') && Result.err('boo')  // => Err('boo')
- *
- */
-// export function and<T, E, T2>(
-//     result1: Result<T, E>,
-//     result2: Result<T2, E>,
-// ): Result<T2, E> {
-//     return result1.type === 'ok' ? result2 : result1;
-// }
-
-/**
- * If the given result is OK, return that result. Otherwise, defers to the
- * other result.
- *
- * It's like saying A || B, but on Result.
- *
- * Examples:
- *
- *     Result.ok(42)      || Result.ok('hi')    // => Ok(42)
- *     Result.err('boo')  || Result.ok('hi')    // => Ok('hi')
- *     Result.ok(42)      || Result.err('boo')  // => Ok(42)
- *     Result.err('bleh') || Result.err('boo')  // => Err('boo')
- *
- */
-// export function or<T, E, E2>(
-//     result1: Result<T, E>,
-//     result2: Result<T, E2>,
-// ): Result<T, E2> {
-//     return result1.type === 'ok' ? result1 : result2;
-// }
-
-/**
- * Like .and(), aka &&, but the second argument gets evaluated lazily only if
- * the first result is an Ok result. If so, it has access to the Ok value from
- * the first argument.
- */
-
-
-function andThen(result1, lazyResult2) {
-  return result1.type === 'ok' ? lazyResult2(result1.value) : result1;
-}
-/**
- * Like .or(), aka ||, but the second argument gets evaluated lazily only if
- * the first result is an Err result. If so, it has access to the Err value
- * from the first argument.
- */
-
-
-function orElse(result1, lazyResult2) {
-  return result1.type === 'ok' ? result1 : lazyResult2(result1.error);
-}
-/**
- * Transform an Ok result. Will not touch Err results.
- */
-
-
-function map(result, mapper) {
-  return result.type === 'ok' ? ok(mapper(result.value)) : result;
-}
-/**
- * Transform an Err value. Will not touch Ok results.
- */
-
-
-function mapError(result, mapper) {
-  return result.type === 'ok' ? result : err(mapper(result.error));
-}

package/cjs/result.js.flow

@@ -1,166 +0,0 @@
-// @flow strict
-
-/**
- * Result <value> <error>
- *     = Ok <value>
- *     | Err <error>
- */
-
-type Ok<+T> = {| +type: 'ok', +value: T |};
-type Err<+E> = {| +type: 'err', +error: E |};
-
-export type Result<+T, +E> = Ok<T> | Err<E>;
-
-/**
- * Create a new Result instance representing a successful computation.
- */
-export function ok<T>(value: T): Ok<T> {
-    return { type: 'ok', value };
-}
-
-/**
- * Create a new Result instance representing a failed computation.
- */
-export function err<E>(error: E): Err<E> {
-    return { type: 'err', error };
-}
-
-export function toString(result: Result<mixed, mixed>): string {
-    return result.type === 'ok'
-        ? `Ok(${String(result.value)})`
-        : `Err(${String(result.error)})`;
-}
-
-export function isOk(result: Result<mixed, mixed>): boolean {
-    return result.type === 'ok';
-}
-
-export function isErr(result: Result<mixed, mixed>): boolean {
-    return result.type === 'err';
-}
-
-export function withDefault<T>(result: Result<T, mixed>, defaultValue: T): T {
-    return result.type === 'ok' ? result.value : defaultValue;
-}
-
-export function value<T>(result: Result<T, mixed>): void | T {
-    return result.type === 'ok' ? result.value : undefined;
-}
-
-export function errValue<E>(result: Result<mixed, E>): void | E {
-    return result.type === 'err' ? result.error : undefined;
-}
-
-/**
- * Unwrap the value from this Result instance if this is an "Ok" result.
- * Otherwise, will throw the "Err" error via a runtime exception.
- */
-export function unwrap<T>(result: Result<T, mixed>): T {
-    if (result.type === 'ok') {
-        return result.value;
-    } else {
-        throw result.error;
-    }
-}
-
-export function expect<T>(result: Result<T, mixed>, message: string | Error): T {
-    if (result.type === 'ok') {
-        return result.value;
-    } else {
-        throw message instanceof Error ? message : new Error(message);
-    }
-}
-
-export function dispatch<T, E, O>(
-    result: Result<T, E>,
-    okCallback: (value: T) => O,
-    errCallback: (error: E) => O,
-): O {
-    return result.type === 'ok' ? okCallback(result.value) : errCallback(result.error);
-}
-
-/**
- * If the given result is OK, defers to the other result. Otherwise returns the
- * error result.
- *
- * It's like saying A && B, but on Result.
- *
- * Examples:
- *
- *     Result.ok(42)     && Result.ok('hi')    // => Ok('hi')
- *     Result.err('boo') && Result.ok('hi')    // => Err('boo')
- *     Result.ok(42)     && Result.err('boo')  // => Err('boo')
- *     Result.err('boo') && Result.err('boo')  // => Err('boo')
- *
- */
-// export function and<T, E, T2>(
-//     result1: Result<T, E>,
-//     result2: Result<T2, E>,
-// ): Result<T2, E> {
-//     return result1.type === 'ok' ? result2 : result1;
-// }
-
-/**
- * If the given result is OK, return that result. Otherwise, defers to the
- * other result.
- *
- * It's like saying A || B, but on Result.
- *
- * Examples:
- *
- *     Result.ok(42)      || Result.ok('hi')    // => Ok(42)
- *     Result.err('boo')  || Result.ok('hi')    // => Ok('hi')
- *     Result.ok(42)      || Result.err('boo')  // => Ok(42)
- *     Result.err('bleh') || Result.err('boo')  // => Err('boo')
- *
- */
-// export function or<T, E, E2>(
-//     result1: Result<T, E>,
-//     result2: Result<T, E2>,
-// ): Result<T, E2> {
-//     return result1.type === 'ok' ? result1 : result2;
-// }
-
-/**
- * Like .and(), aka &&, but the second argument gets evaluated lazily only if
- * the first result is an Ok result. If so, it has access to the Ok value from
- * the first argument.
- */
-export function andThen<T, E, T2>(
-    result1: Result<T, E>,
-    lazyResult2: (value: T) => Result<T2, E>,
-): Result<T2, E> {
-    return result1.type === 'ok' ? lazyResult2(result1.value) : result1;
-}
-
-/**
- * Like .or(), aka ||, but the second argument gets evaluated lazily only if
- * the first result is an Err result. If so, it has access to the Err value
- * from the first argument.
- */
-export function orElse<T, E, E2>(
-    result1: Result<T, E>,
-    lazyResult2: (errValue: E) => Result<T, E2>,
-): Result<T, E2> {
-    return result1.type === 'ok' ? result1 : lazyResult2(result1.error);
-}
-
-/**
- * Transform an Ok result. Will not touch Err results.
- */
-export function map<T, E, T2>(
-    result: Result<T, E>,
-    mapper: (value: T) => T2,
-): Result<T2, E> {
-    return result.type === 'ok' ? ok(mapper(result.value)) : result;
-}
-
-/**
- * Transform an Err value. Will not touch Ok results.
- */
-export function mapError<T, E, E2>(
-    result: Result<T, E>,
-    mapper: (error: E) => E2,
-): Result<T, E2> {
-    return result.type === 'ok' ? result : err(mapper(result.error));
-}

package/cjs/stdlib/array.js

@@ -1,108 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.array = array;
-exports.nonEmptyArray = nonEmptyArray;
-exports.poja = 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; }
-
-/**
- * Like a "Plain Old JavaScript Object", but for arrays: "Plain Old JavaScript
- * Array" ^_^
- */
-var poja = function poja(blob) {
-  if (!Array.isArray(blob)) {
-    return Result.err((0, _annotate.annotate)(blob, 'Must be an array'));
-  }
-
-  return Result.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) {
-  var results = [];
-
-  for (var index = 0; index < items.length; ++index) {
-    var result = items[index];
-
-    if (result.type === 'ok') {
-      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 clone = [].concat(blobs);
-      clone.splice(index, 1, (0, _annotate.annotate)(ann, ann.text ? ann.text + " (at index " + index + ")" : "index " + index)); // const errValue = [];
-      // if (index > 0) {
-      //     errValue.push('...'); // TODO: make special mark, not string!
-      // }
-      // errValue.push(
-      // );
-      // if (index < iterable.length - 1) {
-      //     errValue.push('...'); // TODO: make special mark, not string!
-      // }
-
-      return Result.err((0, _annotate.annotate)(clone));
-    }
-  }
-
-  return Result.ok(results);
-}
-/**
- * Given a T, builds a decoder that assumes an array input and returns an
- * Array<T>.
- */
-
-
-function members(decoder) {
-  return function (blobs) {
-    var results = blobs.map(decoder);
-    var result = all(results, blobs);
-    return result;
-  };
-}
-/**
- * Builds a Decoder that returns Ok for values of `Array<T>`, given a Decoder
- * for `T`.  Err otherwise.
- */
-
-
-function array(decoder) {
-  return (0, _composition.compose)(poja, members(decoder));
-}
-/**
- * Builds a Decoder that returns Ok for values of `Array<T>`, but will reject
- * empty arrays.
- */
-
-
-function nonEmptyArray(decoder) {
-  return (0, _composition.compose)(array(decoder), (0, _composition.predicate)(function (arr) {
-    return arr.length > 0;
-  }, 'Must be non-empty array'));
-}