decoders 2.0.0-beta6 → 2.0.0-beta7

package/{_esm/core/string.js → core/string.mjs}

@@ -1,6 +1,6 @@
-import * as Result from '../result';
-import { annotate } from '../annotate';
-import { compose, predicate } from './composition';
+import { annotate } from '../annotate.mjs';
+import { compose, predicate } from './composition.mjs';
+import { err, ok } from '../result.mjs';
 
 /** Match groups in this regex:
  * \1 - the scheme
@@ -17,7 +17,7 @@ var DEFAULT_SCHEMES = ['https'];
  */
 
 export var string = function string(blob) {
-  return typeof blob === 'string' ? Result.ok(blob) : Result.err(annotate(blob, 'Must be string'));
+  return typeof blob === 'string' ? ok(blob) : err(annotate(blob, 'Must be string'));
 };
 /**
  * Decoder that only returns Ok for non-empty string inputs.  Err otherwise.
@@ -62,14 +62,14 @@ export var url = function url(schemes) {
     var matches = value.match(url_re);
 
     if (!matches) {
-      return Result.err(annotate(value, 'Must be URL'));
+      return err(annotate(value, 'Must be URL'));
     } else {
       var scheme = matches[1];
 
       if (schemes.length === 0 || schemes.includes(scheme.toLowerCase())) {
-        return Result.ok(value);
+        return ok(value);
       } else {
-        return Result.err(annotate(value, "URL scheme must be any of: " + schemes.join(', ')));
+        return err(annotate(value, "URL scheme must be any of: " + schemes.join(', ')));
       }
     }
   });

package/core/tuple.d.ts

@@ -0,0 +1,30 @@
+import { Decoder } from '../_types';
+
+export function tuple1<T1>(d1: Decoder<T1>): Decoder<[T1]>;
+export function tuple2<T1, T2>(d1: Decoder<T1>, d2: Decoder<T2>): Decoder<[T1, T2]>;
+export function tuple3<T1, T2, T3>(
+    d1: Decoder<T1>,
+    d2: Decoder<T2>,
+    d3: Decoder<T3>,
+): Decoder<[T1, T2, T3]>;
+export function tuple4<T1, T2, T3, T4>(
+    d1: Decoder<T1>,
+    d2: Decoder<T2>,
+    d3: Decoder<T3>,
+    d4: Decoder<T4>,
+): Decoder<[T1, T2, T3, T4]>;
+export function tuple5<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 tuple6<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]>;

package/{_esm/core/tuple.js → core/tuple.mjs}

@@ -1,7 +1,7 @@
-import { annotate } from '../annotate';
-import { compose, predicate } from './composition';
-import { err, ok, unwrap } from '../result';
-import { poja } from './array';
+import { annotate } from '../annotate.mjs';
+import { compose, predicate } from './composition.mjs';
+import { err, ok, unwrap } from '../result.mjs';
+import { poja } from './array.mjs';
 
 function okOrErr(result) {
   return result.type === 'ok' ? result.value : result.error;

package/format.d.ts

@@ -0,0 +1,4 @@
+import { Annotation } from './annotate';
+
+export function formatInline(ann: Annotation): string;
+export function formatShort(ann: Annotation): string;

package/{format/inline.js → format.js}

@@ -2,10 +2,11 @@
 
 exports.__esModule = true;
 exports.formatInline = formatInline;
+exports.formatShort = formatShort;
 exports.serializeAnnotation = serializeAnnotation;
 exports.serializeValue = serializeValue;
 
-var _utils = require("../_utils");
+var _utils = require("./_utils");
 
 function serializeString(s, width) {
   if (width === void 0) {
@@ -143,4 +144,8 @@ function formatInline(ann) {
   } else {
     return serialized;
   }
+}
+
+function formatShort(ann) {
+  return (0, _utils.summarize)(ann, []).join('\n');
 }

package/{_esm/format/inline.js.flow → format.js.flow}

@@ -1,7 +1,7 @@
 // @flow strict
 
-import { asDate, indent, INDENT, isMultiline } from '../_utils';
-import type { Annotation, ArrayAnnotation, ObjectAnnotation } from '../annotate';
+import { summarize as _summarize, asDate, INDENT, indent, isMultiline } from './_utils';
+import type { Annotation, ArrayAnnotation, ObjectAnnotation } from './annotate';
 
 function serializeString(s: string, width: number = 80): string {
     // Full string
@@ -120,3 +120,7 @@ export function formatInline(ann: Annotation): string {
         return serialized;
     }
 }
+
+export function formatShort(ann: Annotation): string {
+    return _summarize(ann, []).join('\n');
+}

package/{_esm/format/inline.js → format.mjs}

@@ -1,4 +1,4 @@
-import { asDate, indent, INDENT, isMultiline } from '../_utils';
+import { summarize as _summarize, asDate, INDENT, indent, isMultiline } from './_utils.mjs';
 
 function serializeString(s, width) {
   if (width === void 0) {
@@ -134,4 +134,7 @@ export function formatInline(ann) {
   } else {
     return serialized;
   }
+}
+export function formatShort(ann) {
+  return _summarize(ann, []).join('\n');
 }

package/{_esm/index.js.flow → index.d.ts}

@@ -1,24 +1,4 @@
-// @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 {
+export {
     Decoder,
     DecodeResult,
     DecoderType,
@@ -27,8 +7,8 @@ export type {
     Predicate,
     Scalar,
 } from './_types';
-export type { Result } from './result';
-export type { JSONValue, JSONObject, JSONArray } from './core/json';
+export { Result } from './result';
+export { JSONValue, JSONObject, JSONArray } from './core/json';
 
 export { guard } from './_guard';
 

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

@@ -16,22 +16,22 @@
  * 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, map, predicate } from './core/composition.mjs';
+export { array, nonEmptyArray, poja } 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 { dispatch } from './core/dispatch.mjs';
+export { either, either3, either4, either5, either6, either7, either8, either9, oneOf } from './core/either.mjs';
+export { fail } from './core/fail.mjs';
+export { instanceOf } from './core/instanceOf.mjs';
+export { json, jsonObject, jsonArray } from './core/json.mjs';
+export { lazy } from './core/lazy.mjs';
+export { mapping, dict } from './core/mapping.mjs';
+export { integer, number, positiveInteger, positiveNumber } from './core/number.mjs';
+export { exact, inexact, object, pojo } from './core/object.mjs';
+export { maybe, nullable, optional } from './core/optional.mjs';
+export { email, nonEmptyString, regex, string, url } from './core/string.mjs';
+export { tuple1, tuple2, tuple3, tuple4, tuple5, tuple6 } from './core/tuple.mjs';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "decoders",
-    "version": "2.0.0-beta6",
+    "version": "2.0.0-beta7",
     "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",
@@ -40,6 +40,18 @@
         "map",
         "predicate"
     ],
+    "*": {
+        "*": [
+            "NotSupportedTSVersion.d.ts"
+        ]
+    },
     "githubUrl": "https://github.com/nvie/decoders",
-    "sideEffects": false
+    "sideEffects": false,
+    "typesVersions": {
+        ">=4.1.0": {
+            "*": [
+                "*"
+            ]
+        }
+    }
 }

package/result.d.ts

@@ -0,0 +1,39 @@
+export interface Ok<T> {
+    type: 'ok';
+    value: T;
+    error: undefined;
+}
+
+export interface Err<E> {
+    type: 'err';
+    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

@@ -5,15 +5,11 @@ exports.andThen = andThen;
 exports.dispatch = dispatch;
 exports.err = err;
 exports.expect = expect;
-exports.isErr = isErr;
-exports.isOk = isOk;
 exports.mapError = mapError;
 exports.mapOk = mapOk;
 exports.ok = ok;
 exports.orElse = orElse;
-exports.toString = toString;
 exports.unwrap = unwrap;
-exports.withDefault = withDefault;
 
 /**
  * Result <value> <error>
@@ -43,22 +39,6 @@ function err(error) {
     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;
-}
 /**
  * Unwrap the value from this Result instance if this is an "Ok" result.
  * Otherwise, will throw the "Err" error via a runtime exception.
@@ -84,48 +64,6 @@ function expect(result, 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

package/result.js.flow

@@ -25,24 +25,6 @@ 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;
-}
-
 /**
  * Unwrap the value from this Result instance if this is an "Ok" result.
  * Otherwise, will throw the "Err" error via a runtime exception.
@@ -71,48 +53,6 @@ export function dispatch<T, E, 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

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

@@ -25,18 +25,6 @@ export function err(error) {
     error: error
   };
 }
-export function toString(result) {
-  return result.type === 'ok' ? "Ok(" + String(result.value) + ")" : "Err(" + String(result.error) + ")";
-}
-export function isOk(result) {
-  return result.type === 'ok';
-}
-export function isErr(result) {
-  return result.type === 'err';
-}
-export function withDefault(result, defaultValue) {
-  return result.type === 'ok' ? result.value : defaultValue;
-}
 /**
  * Unwrap the value from this Result instance if this is an "Ok" result.
  * Otherwise, will throw the "Err" error via a runtime exception.
@@ -59,48 +47,6 @@ export function expect(result, message) {
 export 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

package/_esm/_guard.js.flow

@@ -1,20 +0,0 @@
-// @flow strict
-
-import * as Result from './result';
-import { formatInline } from './format';
-import type { Annotation } from './annotate';
-import type { Decoder, Guard } from './_types';
-
-export function guard<T>(
-    decoder: Decoder<T>,
-    formatter: (Annotation) => string = formatInline,
-): Guard<T> {
-    return (blob: mixed) =>
-        Result.unwrap(
-            Result.mapError(decoder(blob), (annotation) => {
-                const err = new Error('\n' + formatter(annotation));
-                err.name = 'Decoding error';
-                return err;
-            }),
-        );
-}

package/_esm/_types.js.flow

@@ -1,20 +0,0 @@
-// @flow strict
-
-import type { Annotation } from './annotate';
-import type { Result } from './result';
-
-export type Scalar = string | number | boolean | symbol | void | null;
-
-export type Predicate<T> = (T) => boolean;
-export type DecodeResult<T> = Result<T, Annotation>;
-
-export type Decoder<T, F = mixed> = (F) => DecodeResult<T>;
-export type Guard<T> = (mixed) => T;
-
-/**
- * A "type function" which informs Flow about how a type will be modified at runtime.
- * Read this as "given a Guard of type T, I can produce a value of type T".  This
- * definition helps construct $ObjMap types.
- */
-export type DecoderType = <T>(Decoder<T>) => T;
-export type GuardType = <T>(Guard<T>) => T;

package/_esm/_utils.js.flow

@@ -1,97 +0,0 @@
-// @flow strict
-
-import type { Annotation } from './annotate';
-
-// $FlowFixMe[unclear-type] - deliberate casting
-type cast = any;
-
-// Two spaces of indentation
-export const INDENT = '  ';
-
-/**
- * `x instanceof Date` checks are unreliable across stack frames (that information
- * might get lost by the JS runtime), so we'll have to reside to more runtime
- * inspection checks.
- *
- * Taken from https://stackoverflow.com/a/44198641
- */
-export function isDate(value: mixed): boolean {
-    return (
-        !!value &&
-        // $FlowFixMe[method-unbinding]
-        Object.prototype.toString.call(value) === '[object Date]' &&
-        !isNaN(value)
-    );
-}
-
-/**
- * Is value is a valid Date instance, then return that.  If not, then return
- * null.
- */
-export function asDate(value: mixed): Date | null {
-    return isDate(value) ? ((value: cast): Date) : null;
-}
-
-export function isMultiline(s: string): boolean {
-    return s.indexOf('\n') >= 0;
-}
-
-export function indent(s: string, prefix: string = INDENT): string {
-    if (isMultiline(s)) {
-        return s
-            .split('\n')
-            .map((line) => prefix + line)
-            .join('\n');
-    } else {
-        return prefix + s;
-    }
-}
-
-/**
- * Walks the annotation tree and emits the annotation's key path within the
- * object tree, and the message as a series of messages (array of strings).
- */
-export function summarize(
-    ann: Annotation,
-    keypath: $ReadOnlyArray<number | string> = [],
-): Array<string> {
-    const result: Array<string> = [];
-
-    if (ann.type === 'array') {
-        const items = ann.items;
-        let index = 0;
-        items.forEach((ann) => {
-            summarize(ann, [...keypath, index++]).forEach((item) =>
-                // Collect to results
-                result.push(item),
-            );
-        });
-    } else if (ann.type === 'object') {
-        const fields = ann.fields;
-        Object.keys(fields).forEach((key) => {
-            const value = fields[key];
-            summarize(value, [...keypath, key]).forEach((item) =>
-                // Collect to results
-                result.push(item),
-            );
-        });
-    }
-
-    const text = ann.text;
-    if (!text) {
-        return result;
-    }
-
-    let prefix: string;
-    if (keypath.length === 0) {
-        prefix = '';
-    } else if (keypath.length === 1) {
-        prefix =
-            typeof keypath[0] === 'number'
-                ? `Value at index ${keypath[0]}: `
-                : `Value at key ${JSON.stringify(keypath[0])}: `;
-    } else {
-        prefix = `Value at keypath ${keypath.map((x) => x.toString()).join('.')}: `;
-    }
-    return [...result, prefix + text];
-}