decoders 2.0.0-beta7 → 2.0.0-beta8

package/core/string.js.flow

@@ -1,8 +1,10 @@
 // @flow strict
 
 import { annotate } from '../annotate';
-import { compose, predicate } from './composition';
+import { either } from './either';
 import { err, ok } from '../result';
+import { instanceOf } from './instanceOf';
+import { map, predicate } from './composition';
 import type { Decoder } from '../_types';
 
 /** Match groups in this regex:
@@ -15,9 +17,6 @@ import type { Decoder } from '../_types';
 const url_re =
     /^([A-Za-z]{3,9}(?:[+][A-Za-z]{3,9})?):\/\/(?:([-;:&=+$,\w]+)@)?(?:([A-Za-z0-9.-]+)(?::([0-9]{2,5}))?)(\/(?:[-+~%/.,\w]*)?(?:\?[-+=&;%@.,\w]*)?(?:#[.,!/\w]*)?)?$/;
 
-// The URL schemes the url() decoder accepts by default
-const DEFAULT_SCHEMES = ['https'];
-
 /**
  * Decoder that only returns Ok for string inputs.  Err otherwise.
  */
@@ -36,10 +35,7 @@ export const nonEmptyString: Decoder<string> = regex(/\S/, 'Must be non-empty st
  * before testing the regex.
  */
 export function regex(regex: RegExp, msg: string): Decoder<string> {
-    return compose(
-        string,
-        predicate((s) => regex.test(s), msg),
-    );
+    return predicate(string, (s) => regex.test(s), msg);
 }
 
 /**
@@ -51,30 +47,13 @@ export const email: Decoder<string> = regex(
     'Must be email',
 );
 
-/**
- * Decoder that only returns Ok for string inputs that match URLs of the
- * expected scheme.  Defaults to only accept HTTPS URLs.  Err otherwise.
- *
- * Variants that can be used:
- *
- * - url()                      accepts only https:// URLs
- * - url([])                    accepts any URL scheme
- * - url(['http'])              accepts only HTTP
- * - url(['https', 'git+ssh'])  accepts both https:// and git+ssh:// URLs
- */
-export const url = (schemes: $ReadOnlyArray<string> = DEFAULT_SCHEMES): Decoder<string> =>
-    compose(string, (value: string) => {
-        const matches = value.match(url_re);
-        if (!matches) {
-            return err(annotate(value, 'Must be URL'));
-        } else {
-            const scheme = matches[1];
-            if (schemes.length === 0 || schemes.includes(scheme.toLowerCase())) {
-                return ok(value);
-            } else {
-                return err(
-                    annotate(value, `URL scheme must be any of: ${schemes.join(', ')}`),
-                );
-            }
-        }
-    });
+export const url: Decoder<URL> = either(
+    map(regex(url_re, 'Must be URL'), (value) => new URL(value)),
+    instanceOf(URL),
+);
+
+export const httpsUrl: Decoder<URL> = predicate(
+    url,
+    (value) => value.protocol === 'https:',
+    'Must be an HTTPS URL',
+);

package/core/string.mjs

@@ -1,6 +1,8 @@
 import { annotate } from '../annotate.mjs';
-import { compose, predicate } from './composition.mjs';
+import { either } from './either.mjs';
 import { err, ok } from '../result.mjs';
+import { instanceOf } from './instanceOf.mjs';
+import { map, predicate } from './composition.mjs';
 
 /** Match groups in this regex:
  * \1 - the scheme
@@ -9,9 +11,7 @@ import { err, ok } from '../result.mjs';
  * \4 - the port (optional)
  * \5 - the path (optional)
  */
-var url_re = /^([A-Za-z]{3,9}(?:[+][A-Za-z]{3,9})?):\/\/(?:([-;:&=+$,\w]+)@)?(?:([A-Za-z0-9.-]+)(?::([0-9]{2,5}))?)(\/(?:[-+~%/.,\w]*)?(?:\?[-+=&;%@.,\w]*)?(?:#[.,!/\w]*)?)?$/; // The URL schemes the url() decoder accepts by default
-
-var DEFAULT_SCHEMES = ['https'];
+var url_re = /^([A-Za-z]{3,9}(?:[+][A-Za-z]{3,9})?):\/\/(?:([-;:&=+$,\w]+)@)?(?:([A-Za-z0-9.-]+)(?::([0-9]{2,5}))?)(\/(?:[-+~%/.,\w]*)?(?:\?[-+=&;%@.,\w]*)?(?:#[.,!/\w]*)?)?$/;
 /**
  * Decoder that only returns Ok for string inputs.  Err otherwise.
  */
@@ -31,9 +31,9 @@ export var nonEmptyString = regex(/\S/, 'Must be non-empty string');
  */
 
 export function regex(regex, msg) {
-  return compose(string, predicate(function (s) {
+  return predicate(string, function (s) {
     return regex.test(s);
-  }, msg));
+  }, msg);
 }
 /**
  * Decoder that only returns Ok for string inputs that match the almost perfect
@@ -41,36 +41,9 @@ export function regex(regex, msg) {
  */
 
 export var email = regex(/^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/, 'Must be email');
-/**
- * Decoder that only returns Ok for string inputs that match URLs of the
- * expected scheme.  Defaults to only accept HTTPS URLs.  Err otherwise.
- *
- * Variants that can be used:
- *
- * - url()                      accepts only https:// URLs
- * - url([])                    accepts any URL scheme
- * - url(['http'])              accepts only HTTP
- * - url(['https', 'git+ssh'])  accepts both https:// and git+ssh:// URLs
- */
-
-export var url = function url(schemes) {
-  if (schemes === void 0) {
-    schemes = DEFAULT_SCHEMES;
-  }
-
-  return compose(string, function (value) {
-    var matches = value.match(url_re);
-
-    if (!matches) {
-      return err(annotate(value, 'Must be URL'));
-    } else {
-      var scheme = matches[1];
-
-      if (schemes.length === 0 || schemes.includes(scheme.toLowerCase())) {
-        return ok(value);
-      } else {
-        return err(annotate(value, "URL scheme must be any of: " + schemes.join(', ')));
-      }
-    }
-  });
-};
+export var url = either(map(regex(url_re, 'Must be URL'), function (value) {
+  return new URL(value);
+}), instanceOf(URL));
+export var httpsUrl = predicate(url, function (value) {
+  return value.protocol === 'https:';
+}, 'Must be an HTTPS URL');

package/core/tuple.js

@@ -21,9 +21,9 @@ function okOrErr(result) {
 }
 
 var ntuple = function ntuple(n) {
-  return (0, _composition.compose)(_array.poja, (0, _composition.predicate)(function (arr) {
+  return (0, _composition.predicate)(_array.poja, function (arr) {
     return arr.length === n;
-  }, "Must be a " + n + "-tuple"));
+  }, "Must be a " + n + "-tuple");
 };
 /**
  * Builds a Decoder that returns Ok for 1-tuple of [T], given a Decoder for T.

package/core/tuple.js.flow

@@ -12,10 +12,7 @@ function okOrErr<T, E>(result: Result<T, E>): T | E {
 }
 
 const ntuple = (n: number) =>
-    compose(
-        poja,
-        predicate((arr) => arr.length === n, `Must be a ${n}-tuple`),
-    );
+    predicate(poja, (arr) => arr.length === n, `Must be a ${n}-tuple`);
 
 /**
  * Builds a Decoder that returns Ok for 1-tuple of [T], given a Decoder for T.

package/core/tuple.mjs

@@ -8,9 +8,9 @@ function okOrErr(result) {
 }
 
 var ntuple = function ntuple(n) {
-  return compose(poja, predicate(function (arr) {
+  return predicate(poja, function (arr) {
     return arr.length === n;
-  }, "Must be a " + n + "-tuple"));
+  }, "Must be a " + n + "-tuple");
 };
 /**
  * Builds a Decoder that returns Ok for 1-tuple of [T], given a Decoder for T.

package/index.d.ts

@@ -19,7 +19,7 @@ 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 { disjointUnion } from './core/dispatch';
 export {
     either,
     either3,
@@ -39,5 +39,5 @@ 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 { email, httpsUrl, nonEmptyString, regex, string, url } from './core/string';
 export { tuple1, tuple2, tuple3, tuple4, tuple5, tuple6 } from './core/tuple';

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.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.httpsUrl = 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.disjointUnion = exports.dict = exports.describe = exports.date = exports.constant = exports.compose = exports["boolean"] = exports.array = void 0;
 
 var _guard = require("./_guard");
 
@@ -45,7 +45,7 @@ exports.describe = _describe.describe;
 
 var _dispatch = require("./core/dispatch");
 
-exports.dispatch = _dispatch.dispatch;
+exports.disjointUnion = _dispatch.disjointUnion;
 
 var _either = require("./core/either");
 
@@ -105,6 +105,7 @@ exports.optional = _optional.optional;
 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;

package/index.js.flow

@@ -39,7 +39,7 @@ 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 { disjointUnion } from './core/dispatch';
 export {
     either,
     either3,
@@ -59,5 +59,5 @@ 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 { email, httpsUrl, nonEmptyString, regex, string, url } from './core/string';
 export { tuple1, tuple2, tuple3, tuple4, tuple5, tuple6 } from './core/tuple';

package/index.mjs

@@ -23,7 +23,7 @@ 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 { disjointUnion } 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';
@@ -33,5 +33,5 @@ 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 { email, httpsUrl, 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-beta7",
+    "version": "2.0.0-beta8",
     "description": "Elegant and battle-tested validation library for type-safe input data (for TypeScript and Flow)",
     "license": "MIT",
     "repository": {
@@ -40,11 +40,6 @@
         "map",
         "predicate"
     ],
-    "*": {
-        "*": [
-            "NotSupportedTSVersion.d.ts"
-        ]
-    },
     "githubUrl": "https://github.com/nvie/decoders",
     "sideEffects": false,
     "typesVersions": {
@@ -52,6 +47,11 @@
             "*": [
                 "*"
             ]
+        },
+        "*": {
+            "*": [
+                "NotSupportedTSVersion.d.ts"
+            ]
         }
     }
 }