decoders 2.0.0-beta5 → 2.0.0-beta9

package/index.js

@@ -1,7 +1,7 @@
 "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;
+exports.uuidv4 = exports.uuidv1 = exports.uuid = exports.url = exports.unknown = exports.undefined_ = exports.tuple = exports.truthy = exports.transform = exports.taggedUnion = exports.string = exports.set = exports.regex = exports.prep = 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.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.either = exports.dict = exports.describe = exports.date = exports.constant = exports.compose = exports["boolean"] = exports.array = void 0;
 
 var _guard = require("./_guard");
 
@@ -10,14 +10,16 @@ exports.guard = _guard.guard;
 var _composition = require("./core/composition");
 
 exports.compose = _composition.compose;
-exports.map = _composition.map;
 exports.predicate = _composition.predicate;
+exports.prep = _composition.prep;
+exports.transform = _composition.transform;
 
 var _array = require("./core/array");
 
 exports.array = _array.array;
 exports.nonEmptyArray = _array.nonEmptyArray;
 exports.poja = _array.poja;
+exports.set = _array.set;
 
 var _boolean = require("./core/boolean");
 
@@ -43,22 +45,32 @@ var _describe = require("./core/describe");
 
 exports.describe = _describe.describe;
 
-var _dispatch = require("./core/dispatch");
+var _object = require("./core/object");
 
-exports.dispatch = _dispatch.dispatch;
+exports.dict = _object.dict;
+exports.exact = _object.exact;
+exports.inexact = _object.inexact;
+exports.mapping = _object.mapping;
+exports.object = _object.object;
+exports.pojo = _object.pojo;
 
 var _either = require("./core/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 _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;
+exports.uuid = _string.uuid;
+exports.uuidv1 = _string.uuidv1;
+exports.uuidv4 = _string.uuidv4;
+
 var _fail = require("./core/fail");
 
 exports.fail = _fail.fail;
@@ -67,6 +79,13 @@ var _instanceOf = require("./core/instanceOf");
 
 exports.instanceOf = _instanceOf.instanceOf;
 
+var _number = require("./core/number");
+
+exports.integer = _number.integer;
+exports.number = _number.number;
+exports.positiveInteger = _number.positiveInteger;
+exports.positiveNumber = _number.positiveNumber;
+
 var _json = require("./core/json");
 
 exports.json = _json.json;
@@ -77,44 +96,16 @@ 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");
+var _dispatch = require("./core/dispatch");
 
-exports.email = _string.email;
-exports.nonEmptyString = _string.nonEmptyString;
-exports.regex = _string.regex;
-exports.string = _string.string;
-exports.url = _string.url;
+exports.taggedUnion = _dispatch.taggedUnion;
 
 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.tuple = _tuple.tuple;

package/index.js.flow

@@ -32,32 +32,31 @@ export type { JSONValue, JSONObject, JSONArray } from './core/json';
 
 export { guard } from './_guard';
 
-export { compose, map, predicate } from './core/composition';
+export { compose, predicate, prep, transform } from './core/composition';
 
-export { array, nonEmptyArray, poja } from './core/array';
+export { array, nonEmptyArray, poja, set } 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 { dispatch } from './core/dispatch';
+export { dict, exact, inexact, mapping, object, pojo } from './core/object';
+export { either, oneOf } from './core/either';
 export {
-    either,
-    either3,
-    either4,
-    either5,
-    either6,
-    either7,
-    either8,
-    either9,
-    oneOf,
-} from './core/either';
+    email,
+    httpsUrl,
+    nonEmptyString,
+    regex,
+    string,
+    url,
+    uuid,
+    uuidv1,
+    uuidv4,
+} from './core/string';
 export { fail } from './core/fail';
 export { instanceOf } from './core/instanceOf';
+export { integer, number, positiveInteger, positiveNumber } from './core/number';
 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, nonEmptyString, regex, string, url } from './core/string';
-export { tuple1, tuple2, tuple3, tuple4, tuple5, tuple6 } from './core/tuple';
+export { taggedUnion } from './core/dispatch';
+export { tuple } from './core/tuple';

package/{_esm/index.js → index.mjs}

@@ -16,22 +16,21 @@
  * type.  In our case, it's fine to fail with a runtime error.
  *
  */
-export { guard } from './_guard';
-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 { dispatch } 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, nonEmptyString, regex, string, url } from './core/string';
-export { tuple1, tuple2, tuple3, tuple4, tuple5, tuple6 } from './core/tuple';
+export { guard } from './_guard.mjs';
+export { compose, predicate, prep, transform } from './core/composition.mjs';
+export { array, nonEmptyArray, poja, set } 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 { dict, exact, inexact, mapping, object, pojo } from './core/object.mjs';
+export { either, oneOf } from './core/either.mjs';
+export { email, httpsUrl, nonEmptyString, regex, string, url, uuid, uuidv1, uuidv4 } from './core/string.mjs';
+export { fail } from './core/fail.mjs';
+export { instanceOf } from './core/instanceOf.mjs';
+export { integer, number, positiveInteger, positiveNumber } from './core/number.mjs';
+export { json, jsonObject, jsonArray } from './core/json.mjs';
+export { lazy } from './core/lazy.mjs';
+export { maybe, nullable, optional } from './core/optional.mjs';
+export { taggedUnion } from './core/dispatch.mjs';
+export { tuple } from './core/tuple.mjs';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "decoders",
-    "version": "2.0.0-beta5",
+    "version": "2.0.0-beta9",
     "description": "Elegant and battle-tested validation library for type-safe input data (for TypeScript and Flow)",
     "license": "MIT",
     "repository": {
@@ -13,7 +13,7 @@
         "url": "https://github.com/nvie/decoders/issues"
     },
     "main": "./index.js",
-    "module": "./_esm/index.js",
+    "module": "./index.mjs",
     "keywords": [
         "decoder",
         "decoders",
@@ -41,5 +41,17 @@
         "predicate"
     ],
     "githubUrl": "https://github.com/nvie/decoders",
-    "sideEffects": false
+    "sideEffects": false,
+    "typesVersions": {
+        ">=4.1.0": {
+            "*": [
+                "*"
+            ]
+        },
+        "*": {
+            "*": [
+                "NotSupportedTSVersion.d.ts"
+            ]
+        }
+    }
 }

package/result.d.ts

@@ -0,0 +1,39 @@
+export interface Ok<T> {
+    ok: true;
+    value: T;
+    error: undefined;
+}
+
+export interface Err<E> {
+    ok: false;
+    value: undefined;
+    error: E;
+}
+
+export type Result<T, E> = Ok<T> | Err<E>;
+
+export function ok<T>(value: T): Ok<T>;
+export function err<E>(error: E): Err<E>;
+export function unwrap<T>(result: Result<T, unknown>): T;
+export function expect<T>(result: Result<T, unknown>, message: string | Error): T;
+export function dispatch<T, E, O>(
+    result: Result<T, E>,
+    okCallback: (value: T) => O,
+    errCallback: (error: E) => O,
+): O;
+export function andThen<T, E, T2>(
+    result1: Result<T, E>,
+    lazyResult2: (value: T) => Result<T2, E>,
+): Result<T2, E>;
+export function orElse<T, E, E2>(
+    result1: Result<T, E>,
+    lazyResult2: (errValue: E) => Result<T, E2>,
+): Result<T, E2>;
+export function mapOk<T, E, T2>(
+    result: Result<T, E>,
+    mapper: (value: T) => T2,
+): Result<T2, E>;
+export function mapError<T, E, E2>(
+    result: Result<T, E>,
+    mapper: (error: E) => E2,
+): Result<T, E2>;

package/result.js

@@ -4,19 +4,12 @@ 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.mapError = mapError;
 exports.mapOk = mapOk;
 exports.ok = ok;
-exports.okOrErrValue = okOrErrValue;
-exports.okValue = okValue;
 exports.orElse = orElse;
-exports.toString = toString;
 exports.unwrap = unwrap;
-exports.withDefault = withDefault;
 
 /**
  * Result <value> <error>
@@ -29,7 +22,7 @@ exports.withDefault = withDefault;
  */
 function ok(value) {
   return {
-    type: 'ok',
+    ok: true,
     value: value,
     error: undefined
   };
@@ -41,43 +34,11 @@ function ok(value) {
 
 function err(error) {
   return {
-    type: 'err',
+    ok: false,
     value: undefined,
     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;
-} // TODO: Remove this from the public API? The same can be achieved now with
-// TODO: const { value } = result;
-
-
-function okValue(result) {
-  return result.type === 'ok' ? result.value : undefined;
-} // TODO: Remove this from the public API? The same can be achieved now with
-// TODO: const { error } = result;
-
-
-function errValue(result) {
-  return result.type === 'err' ? result.error : undefined;
-}
-
-function okOrErrValue(result) {
-  return result.type === 'ok' ? result.value : result.error;
-}
 /**
  * Unwrap the value from this Result instance if this is an "Ok" result.
  * Otherwise, will throw the "Err" error via a runtime exception.
@@ -85,7 +46,7 @@ function okOrErrValue(result) {
 
 
 function unwrap(result) {
-  if (result.type === 'ok') {
+  if (result.ok) {
     return result.value;
   } else {
     throw result.error;
@@ -93,7 +54,7 @@ function unwrap(result) {
 }
 
 function expect(result, message) {
-  if (result.type === 'ok') {
+  if (result.ok) {
     return result.value;
   } else {
     throw message instanceof Error ? message : new Error(message);
@@ -101,50 +62,8 @@ function expect(result, message) {
 }
 
 function dispatch(result, okCallback, errCallback) {
-  return result.type === 'ok' ? okCallback(result.value) : errCallback(result.error);
+  return result.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
@@ -153,7 +72,7 @@ function dispatch(result, okCallback, errCallback) {
 
 
 function andThen(result1, lazyResult2) {
-  return result1.type === 'ok' ? lazyResult2(result1.value) : result1;
+  return result1.ok ? lazyResult2(result1.value) : result1;
 }
 /**
  * Like .or(), aka ||, but the second argument gets evaluated lazily only if
@@ -163,7 +82,7 @@ function andThen(result1, lazyResult2) {
 
 
 function orElse(result1, lazyResult2) {
-  return result1.type === 'ok' ? result1 : lazyResult2(result1.error);
+  return result1.ok ? result1 : lazyResult2(result1.error);
 }
 /**
  * Transform an Ok result. Will not touch Err results.
@@ -171,7 +90,7 @@ function orElse(result1, lazyResult2) {
 
 
 function mapOk(result, mapper) {
-  return result.type === 'ok' ? ok(mapper(result.value)) : result;
+  return result.ok ? ok(mapper(result.value)) : result;
 }
 /**
  * Transform an Err value. Will not touch Ok results.
@@ -179,5 +98,5 @@ function mapOk(result, mapper) {
 
 
 function mapError(result, mapper) {
-  return result.type === 'ok' ? result : err(mapper(result.error));
+  return result.ok ? result : err(mapper(result.error));
 }

package/result.js.flow

@@ -6,8 +6,8 @@
  *     | Err <error>
  */
 
-type Ok<+T> = {| +type: 'ok', +value: T, +error: void |};
-type Err<+E> = {| +type: 'err', +value: void, +error: E |};
+type Ok<+T> = {| +ok: true, +value: T, +error: void |};
+type Err<+E> = {| +ok: false, +value: void, +error: E |};
 
 export type Result<+T, +E> = Ok<T> | Err<E>;
 
@@ -15,48 +15,14 @@ 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, error: undefined };
+    return { ok: true, value, error: undefined };
 }
 
 /**
  * Create a new Result instance representing a failed computation.
  */
 export function err<E>(error: E): Err<E> {
-    return { type: 'err', value: undefined, 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;
-}
-
-// TODO: Remove this from the public API? The same can be achieved now with
-// TODO: const { value } = result;
-export function okValue<T>(result: Result<T, mixed>): void | T {
-    return result.type === 'ok' ? result.value : undefined;
-}
-
-// TODO: Remove this from the public API? The same can be achieved now with
-// TODO: const { error } = result;
-export function errValue<E>(result: Result<mixed, E>): void | E {
-    return result.type === 'err' ? result.error : undefined;
-}
-
-export function okOrErrValue<T, E>(result: Result<T, E>): T | E {
-    return result.type === 'ok' ? result.value : result.error;
+    return { ok: false, value: undefined, error };
 }
 
 /**
@@ -64,7 +30,7 @@ export function okOrErrValue<T, E>(result: Result<T, E>): T | E {
  * Otherwise, will throw the "Err" error via a runtime exception.
  */
 export function unwrap<T>(result: Result<T, mixed>): T {
-    if (result.type === 'ok') {
+    if (result.ok) {
         return result.value;
     } else {
         throw result.error;
@@ -72,7 +38,7 @@ export function unwrap<T>(result: Result<T, mixed>): T {
 }
 
 export function expect<T>(result: Result<T, mixed>, message: string | Error): T {
-    if (result.type === 'ok') {
+    if (result.ok) {
         return result.value;
     } else {
         throw message instanceof Error ? message : new Error(message);
@@ -84,51 +50,9 @@ export function dispatch<T, E, O>(
     okCallback: (value: T) => O,
     errCallback: (error: E) => O,
 ): O {
-    return result.type === 'ok' ? okCallback(result.value) : errCallback(result.error);
+    return result.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
@@ -138,7 +62,7 @@ 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;
+    return result1.ok ? lazyResult2(result1.value) : result1;
 }
 
 /**
@@ -150,7 +74,7 @@ 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);
+    return result1.ok ? result1 : lazyResult2(result1.error);
 }
 
 /**
@@ -160,7 +84,7 @@ export function mapOk<T, E, T2>(
     result: Result<T, E>,
     mapper: (value: T) => T2,
 ): Result<T2, E> {
-    return result.type === 'ok' ? ok(mapper(result.value)) : result;
+    return result.ok ? ok(mapper(result.value)) : result;
 }
 
 /**
@@ -170,5 +94,5 @@ 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));
+    return result.ok ? result : err(mapper(result.error));
 }