Initial commit

4 years ago · abfcc787b3
commit abfcc787b3
6 changed files with 352 additions and 0 deletions
--- a/.gitignore
+++ b/.gitignore
@ -0,0 +1 @@
+node_modules
--- a/README.md
+++ b/README.md
@ -0,0 +1,5 @@
+# @validatem/require-either
+
+Documentation for this module has not been written yet. By the time it reaches 1.0.0, it will have full documentation.
+
+In the meantime, check out the `example.js` file in the repository for a usage demonstration.
--- a/example.js
+++ b/example.js
@ -0,0 +1,29 @@
+"use strict";
+
+const { validateValue } = require("@validatem/core");
+const requireEither = require("./");
+
+let looseRule = requireEither([
+	"foo",
+	[ "bar", "baz" ]
+], { allowMultiple: true });
+
+let strictRule = requireEither([
+	"foo",
+	[ "bar", "baz" ]
+]);
+
+console.log(validateValue({ foo: 42 }, looseRule)); // { foo: 42 }
+
+console.log(validateValue({ bar: 42, baz: 14 }, looseRule)); // { bar: 42, baz: 14 }
+
+console.log(validateValue({ foo: true, bar: 42 }, looseRule)); // { foo: true, bar: 42 }
+
+console.log(validateValue({ foo: true, bar: 42 }, strictRule)); /*
+	AggregrateValidationError: One or more validation errors occurred at 'Object.<anonymous>' in require-either/example.js, at line 22 (<path>):
+	 - Must satisfy at least one of:
+		├─ bar: Value exists in a place that should be empty
+		└─ Must satisfy all of the following:
+			├─ baz: Required value is missing
+			└─ foo: Value exists in a place that should be empty
+*/
--- a/index.js
+++ b/index.js
@ -0,0 +1,37 @@
+"use strict";
+
+const flatten = require("flatten");
+const assureArray = require("assure-array");
+
+const required = require("@validatem/required");
+const forbidden = require("@validatem/forbidden");
+const allowExtraProperties = require("@validatem/allow-extra-properties");
+const either = require("@validatem/either");
+
+module.exports = function requireEither(alternatives, options = {}) {
+	let allKeys = flatten(alternatives);
+	let allUniqueKeys = Array.from(new Set(allKeys));
+	
+	let predicates = alternatives.map((alternative) => {
+		let requiredKeys = assureArray(alternative);
+		let requiredKeysSet = new Set(requiredKeys);
+
+		let object = {};
+
+		for (let key of requiredKeys) {
+			object[key] = required;
+		}
+
+		if (!options.allowMultiple) {
+			for (let key of allUniqueKeys) {
+				if (!requiredKeysSet.has(key)) {
+					object[key] = forbidden;
+				}
+			}
+		}
+
+		return allowExtraProperties(object);
+	});
+
+	return either(predicates);
+};
--- a/package.json
+++ b/package.json
@ -0,0 +1,25 @@
+{
+  "name": "@validatem/require-either",
+  "description": "Validatem combinator for writing 'any one of these must be specified' rules",
+  "keywords": [
+    "validatem",
+    "validator",
+    "combinator"
+  ],
+  "version": "0.1.0",
+  "main": "index.js",
+  "repository": "http://git.cryto.net/validatem/require-either.git",
+  "author": "Sven Slootweg <admin@cryto.net>",
+  "license": "WTFPL OR CC0-1.0",
+  "dependencies": {
+    "@validatem/allow-extra-properties": "^0.1.0",
+    "@validatem/either": "^0.1.9",
+    "@validatem/forbidden": "^0.1.0",
+    "@validatem/required": "^0.1.1",
+    "assure-array": "^1.0.0",
+    "flatten": "^1.0.3"
+  },
+  "devDependencies": {
+    "@validatem/core": "^0.3.12"
+  }
+}
--- a/yarn.lock
+++ b/yarn.lock
@ -0,0 +1,255 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+"@validatem/allow-extra-properties@^0.1.0":
+  version "0.1.0"
+  resolved "https://registry.yarnpkg.com/@validatem/allow-extra-properties/-/allow-extra-properties-0.1.0.tgz#e8c434818d6fd74b8cb237cfaa4d548295de13c1"
+  integrity sha512-9jihpYxw1vp4FdjnbN0bTVZMLYv//9OjFNTsVLG5OV4xHESwtgkgQEF5/N5rY1iBwoH/pcKuRl44MBZ8eMdrKw==
+  dependencies:
+    "@validatem/with-context" "^0.1.0"
+
+"@validatem/annotate-errors@^0.1.2":
+  version "0.1.2"
+  resolved "https://registry.yarnpkg.com/@validatem/annotate-errors/-/annotate-errors-0.1.2.tgz#fa9152bb30f4f42b69496b527e38f0c31ff605a9"
+  integrity sha512-EuX7pzdYI/YpTmZcgdPG481Oi3elAg8JWh/LYXuE1h6MaZk3A8eP5DD33/l7EoKzrysn6y8nCsqNa1ngei562w==
+  dependencies:
+    "@validatem/match-validation-error" "^0.1.0"
+
+"@validatem/any-property@^0.1.0":
+  version "0.1.3"
+  resolved "https://registry.yarnpkg.com/@validatem/any-property/-/any-property-0.1.3.tgz#fc7768c1922a8bacff9369ae48913672e5350f52"
+  integrity sha512-jYWxif5ff9pccu7566LIQ/4+snlApXEJUimBywzAriBgS3r4eDBbz3oZFHuiPmhxNK/NNof5YUS+L6Sk3zaMfg==
+  dependencies:
+    "@validatem/annotate-errors" "^0.1.2"
+    "@validatem/combinator" "^0.1.0"
+    "@validatem/error" "^1.0.0"
+    "@validatem/validation-result" "^0.1.1"
+    "@validatem/virtual-property" "^0.1.0"
+    default-value "^1.0.0"
+
+"@validatem/combinator@^0.1.0", "@validatem/combinator@^0.1.1":
+  version "0.1.2"
+  resolved "https://registry.yarnpkg.com/@validatem/combinator/-/combinator-0.1.2.tgz#eab893d55f1643b9c6857eaf6ff7ed2a728e89ff"
+  integrity sha512-vE8t1tNXknmN62FlN6LxQmA2c6TwVKZ+fl/Wit3H2unFdOhu7SZj2kRPGjAXdK/ARh/3svYfUBeD75pea0j1Sw==
+
+"@validatem/core@^0.3.12":
+  version "0.3.12"
+  resolved "https://registry.yarnpkg.com/@validatem/core/-/core-0.3.12.tgz#e4e8a566850571bf55412862e88a3b06e75c8072"
+  integrity sha512-ngrFk6PT/pPZntpleG6q55SByongNxRk7wJhUiCihyv4yqIqqG+bNGH4wb6yW33IHefreWxkkJ53yM1Yj9srNA==
+  dependencies:
+    "@validatem/annotate-errors" "^0.1.2"
+    "@validatem/any-property" "^0.1.0"
+    "@validatem/error" "^1.0.0"
+    "@validatem/match-validation-error" "^0.1.0"
+    "@validatem/match-versioned-special" "^0.1.0"
+    "@validatem/match-virtual-property" "^0.1.0"
+    "@validatem/normalize-rules" "^0.1.0"
+    "@validatem/required" "^0.1.0"
+    "@validatem/validation-result" "^0.1.1"
+    "@validatem/virtual-property" "^0.1.0"
+    as-expression "^1.0.0"
+    assure-array "^1.0.0"
+    create-error "^0.3.1"
+    default-value "^1.0.0"
+    execall "^2.0.0"
+    flatten "^1.0.3"
+    indent-string "^4.0.0"
+    is-arguments "^1.0.4"
+    supports-color "^7.1.0"
+    syncpipe "^1.0.0"
+
+"@validatem/either@^0.1.9":
+  version "0.1.9"
+  resolved "https://registry.yarnpkg.com/@validatem/either/-/either-0.1.9.tgz#0d753ef8fe04486d2b7122de3dd3ac51b3acaacf"
+  integrity sha512-cUqlRjy02qDcZ166/D6duk8lrtqrHynHuSakU0TvMGMBiLzjWpMJ+3beAWHe+kILB5/dlXVyc68ZIjSNhBi8Kw==
+  dependencies:
+    "@validatem/combinator" "^0.1.1"
+    "@validatem/error" "^1.0.0"
+    "@validatem/match-validation-error" "^0.1.0"
+    "@validatem/validation-result" "^0.1.2"
+    flatten "^1.0.3"
+
+"@validatem/error@^1.0.0":
+  version "1.1.0"
+  resolved "https://registry.yarnpkg.com/@validatem/error/-/error-1.1.0.tgz#bef46e7066c39761b494ebe3eec2ecdc7348f4ed"
+  integrity sha512-gZJEoZq1COi/8/5v0fVKQ9uX54x5lb5HbV7mzIOhY6dqjmLNfxdQmpECZPQrCAOpcRkRMJ7zaFhq4UTslpY9yA==
+
+"@validatem/forbidden@^0.1.0":
+  version "0.1.0"
+  resolved "https://registry.yarnpkg.com/@validatem/forbidden/-/forbidden-0.1.0.tgz#f96a5ac38e322a411eb74c9be1458f80e30348a0"
+  integrity sha512-5GpgXt33z15oXZJwd+BKzEcX56YrU1Ysqe3NM20L9OzuSCJYbWU6xR6mMHkYVfF3TDLfkC8csOiKG2UnduCLhw==
+  dependencies:
+    "@validatem/error" "^1.0.0"
+
+"@validatem/has-shape@^0.1.0":
+  version "0.1.8"
+  resolved "https://registry.yarnpkg.com/@validatem/has-shape/-/has-shape-0.1.8.tgz#dff0f0449c12b96d150091b7a980154d810ae63d"
+  integrity sha512-x2i8toW1uraFF2Vl6WBl4CScbBeg5alrtoCKMyXbJkHf2B5QxL/ftUh2RQRcBzx6U0i7KUb8vdShcWAa+fehRQ==
+  dependencies:
+    "@validatem/annotate-errors" "^0.1.2"
+    "@validatem/combinator" "^0.1.0"
+    "@validatem/error" "^1.0.0"
+    "@validatem/validation-result" "^0.1.1"
+    array-union "^2.1.0"
+    as-expression "^1.0.0"
+    assure-array "^1.0.0"
+    default-value "^1.0.0"
+    flatten "^1.0.3"
+
+"@validatem/is-plain-object@^0.1.0":
+  version "0.1.1"
+  resolved "https://registry.yarnpkg.com/@validatem/is-plain-object/-/is-plain-object-0.1.1.tgz#b7a3ef8ef960882c7c41e84ed709fa0bfb932e93"
+  integrity sha512-aNGbNIbKRpYI0lRBczlTBbiA+nqN52ADAASdySKg2/QeSCVtYS4uOIeCNIJRAgXe/5sUnLTuL4pgq628uAl7Kw==
+  dependencies:
+    "@validatem/error" "^1.0.0"
+    is-plain-obj "^2.1.0"
+
+"@validatem/match-special@^0.1.0":
+  version "0.1.0"
+  resolved "https://registry.yarnpkg.com/@validatem/match-special/-/match-special-0.1.0.tgz#4e0c28f1aee5bf53c1ef30bbf8c755d4946ae0ff"
+  integrity sha512-TFiq9Wk/1Hoja4PK85WwNYnwBXk3+Lgoj59ZIMxm2an1qmNYp8j+BnSvkKBflba451yIn6V1laU9NJf+/NYZgw==
+
+"@validatem/match-validation-error@^0.1.0":
+  version "0.1.0"
+  resolved "https://registry.yarnpkg.com/@validatem/match-validation-error/-/match-validation-error-0.1.0.tgz#fa87f5f1836e7c1d9bf6b75b2addf0a5b21e4c1e"
+  integrity sha512-6akGTk7DdulOreyqDiGdikwRSixQz/AlvARSX18dcWaTFc79KxCLouL2hyoFcor9IIUhu5RTY4/i756y4T1yxA==
+  dependencies:
+    "@validatem/match-versioned-special" "^0.1.0"
+
+"@validatem/match-versioned-special@^0.1.0":
+  version "0.1.0"
+  resolved "https://registry.yarnpkg.com/@validatem/match-versioned-special/-/match-versioned-special-0.1.0.tgz#2eacc48debecdbbe7e3d02f0c0a665afaea9bedf"
+  integrity sha512-xoOTY0bdA2ELj+ntcDVJ8YyMEFIJpjZ4HNPL9lGcbnRFwJBhQcHUAhUpZwkMxu02zH9wkNM1FvYGHxPz40745Q==
+
+"@validatem/match-virtual-property@^0.1.0":
+  version "0.1.0"
+  resolved "https://registry.yarnpkg.com/@validatem/match-virtual-property/-/match-virtual-property-0.1.0.tgz#4de2de1075987b5f3b356d3f2bcf6c0be5b5fb83"
+  integrity sha512-ssd3coFgwbLuqvZftLZTy3eHN0TFST8oTS2XTViQdXJPXVoJmwEKBpFhXgwnb5Ly1CE037R/KWpjhd1TP/56kQ==
+
+"@validatem/normalize-rules@^0.1.0":
+  version "0.1.3"
+  resolved "https://registry.yarnpkg.com/@validatem/normalize-rules/-/normalize-rules-0.1.3.tgz#59fd6193b1091ff97b5c723b32c9bb1fe2a9dc9c"
+  integrity sha512-HHPceAP2ce9NWymIZrgLCTzpdwXNRBCCB5H6ZPc5ggOrbmh4STpT83fLazleHtvYNlqgXZ4GjQOvCwrjaM+qEA==
+  dependencies:
+    "@validatem/has-shape" "^0.1.0"
+    "@validatem/is-plain-object" "^0.1.0"
+    "@validatem/match-special" "^0.1.0"
+    assure-array "^1.0.0"
+    default-value "^1.0.0"
+    flatten "^1.0.3"
+    is-plain-obj "^2.1.0"
+
+"@validatem/required@^0.1.0", "@validatem/required@^0.1.1":
+  version "0.1.1"
+  resolved "https://registry.yarnpkg.com/@validatem/required/-/required-0.1.1.tgz#64f4a87333fc5955511634036b7f8948ed269170"
+  integrity sha512-vI4NzLfay4RFAzp7xyU34PHb8sAo6w/3frrNh1EY9Xjnw2zxjY5oaxwmbFP1jVevBE6QQEnKogtzUHz/Zuvh6g==
+
+"@validatem/validation-result@^0.1.1", "@validatem/validation-result@^0.1.2":
+  version "0.1.2"
+  resolved "https://registry.yarnpkg.com/@validatem/validation-result/-/validation-result-0.1.2.tgz#4e75cfd87305fc78f8d05ac84921a2c99a0348e0"
+  integrity sha512-okmP8JarIwIgfpaVcvZGuQ1yOsLKT3Egt49Ynz6h1MAeGsP/bGHXkkXtbiWOVsk5Tzku5vDVFSrFnF+5IEHKxw==
+  dependencies:
+    default-value "^1.0.0"
+
+"@validatem/virtual-property@^0.1.0":
+  version "0.1.0"
+  resolved "https://registry.yarnpkg.com/@validatem/virtual-property/-/virtual-property-0.1.0.tgz#880540dfd149f98ecf1095d93912e34443381fe4"
+  integrity sha512-JUUvWtdqoSkOwlsl20oB3qFHYIL05a/TAfdY4AJcs55QeVTiX5iI1b8IoQW644sIWWooBuLv+XwoxjRsQFczlQ==
+
+"@validatem/with-context@^0.1.0":
+  version "0.1.2"
+  resolved "https://registry.yarnpkg.com/@validatem/with-context/-/with-context-0.1.2.tgz#3645c04897664f70995104961277e07b61b4f615"
+  integrity sha512-noAWf4CsmU+BCz+KOg3GPq9+R9BQLWOQnOgWVfkYHFdLnnbLhl8w/ONdzvFzUYGHIZGKZwsWVCp+Kwz/tAfMnA==
+  dependencies:
+    "@validatem/combinator" "^0.1.1"
+
+array-union@^2.1.0:
+  version "2.1.0"
+  resolved "https://registry.yarnpkg.com/array-union/-/array-union-2.1.0.tgz#b798420adbeb1de828d84acd8a2e23d3efe85e8d"
+  integrity sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==
+
+as-expression@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/as-expression/-/as-expression-1.0.0.tgz#7bc620ca4cb2fe0ee90d86729bd6add33b8fd831"
+  integrity sha512-Iqh4GxNUfxbJdGn6b7/XMzc8m1Dz2ZHouBQ9DDTzyMRO3VPPIAXeoY/sucRxxxXKbUtzwzWZSN6jPR3zfpYHHA==
+
+assure-array@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/assure-array/-/assure-array-1.0.0.tgz#4f4ad16a87659d6200a4fb7103462033d216ec1f"
+  integrity sha1-T0rRaodlnWIApPtxA0YgM9IW7B8=
+
+clone-regexp@^2.1.0:
+  version "2.2.0"
+  resolved "https://registry.yarnpkg.com/clone-regexp/-/clone-regexp-2.2.0.tgz#7d65e00885cd8796405c35a737e7a86b7429e36f"
+  integrity sha512-beMpP7BOtTipFuW8hrJvREQ2DrRu3BE7by0ZpibtfBA+qfHYvMGTc2Yb1JMYPKg/JUw0CHYvpg796aNTSW9z7Q==
+  dependencies:
+    is-regexp "^2.0.0"
+
+create-error@^0.3.1:
+  version "0.3.1"
+  resolved "https://registry.yarnpkg.com/create-error/-/create-error-0.3.1.tgz#69810245a629e654432bf04377360003a5351a23"
+  integrity sha1-aYECRaYp5lRDK/BDdzYAA6U1GiM=
+
+default-value@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/default-value/-/default-value-1.0.0.tgz#8c6f52a5a1193fe78fdc9f86eb71d16c9757c83a"
+  integrity sha1-jG9SpaEZP+eP3J+G63HRbJdXyDo=
+  dependencies:
+    es6-promise-try "0.0.1"
+
+es6-promise-try@0.0.1:
+  version "0.0.1"
+  resolved "https://registry.yarnpkg.com/es6-promise-try/-/es6-promise-try-0.0.1.tgz#10f140dad27459cef949973e5d21a087f7274b20"
+  integrity sha1-EPFA2tJ0Wc75SZc+XSGgh/cnSyA=
+
+execall@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/execall/-/execall-2.0.0.tgz#16a06b5fe5099df7d00be5d9c06eecded1663b45"
+  integrity sha512-0FU2hZ5Hh6iQnarpRtQurM/aAvp3RIbfvgLHrcqJYzhXyV2KFruhuChf9NC6waAhiUR7FFtlugkI4p7f2Fqlow==
+  dependencies:
+    clone-regexp "^2.1.0"
+
+flatten@^1.0.3:
+  version "1.0.3"
+  resolved "https://registry.yarnpkg.com/flatten/-/flatten-1.0.3.tgz#c1283ac9f27b368abc1e36d1ff7b04501a30356b"
+  integrity sha512-dVsPA/UwQ8+2uoFe5GHtiBMu48dWLTdsuEd7CKGlZlD78r1TTWBvDuFaFGKCo/ZfEr95Uk56vZoX86OsHkUeIg==
+
+has-flag@^4.0.0:
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-4.0.0.tgz#944771fd9c81c81265c4d6941860da06bb59479b"
+  integrity sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==
+
+indent-string@^4.0.0:
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/indent-string/-/indent-string-4.0.0.tgz#624f8f4497d619b2d9768531d58f4122854d7251"
+  integrity sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==
+
+is-arguments@^1.0.4:
+  version "1.0.4"
+  resolved "https://registry.yarnpkg.com/is-arguments/-/is-arguments-1.0.4.tgz#3faf966c7cba0ff437fb31f6250082fcf0448cf3"
+  integrity sha512-xPh0Rmt8NE65sNzvyUmWgI1tz3mKq74lGA0mL8LYZcoIzKOzDh6HmrYm3d18k60nHerC8A9Km8kYu87zfSFnLA==
+
+is-plain-obj@^2.1.0:
+  version "2.1.0"
+  resolved "https://registry.yarnpkg.com/is-plain-obj/-/is-plain-obj-2.1.0.tgz#45e42e37fccf1f40da8e5f76ee21515840c09287"
+  integrity sha512-YWnfyRwxL/+SsrWYfOpUtz5b3YD+nyfkHvjbcanzk8zgyO4ASD67uVMRt8k5bM4lLMDnXfriRhOpemw+NfT1eA==
+
+is-regexp@^2.0.0:
+  version "2.1.0"
+  resolved "https://registry.yarnpkg.com/is-regexp/-/is-regexp-2.1.0.tgz#cd734a56864e23b956bf4e7c66c396a4c0b22c2d"
+  integrity sha512-OZ4IlER3zmRIoB9AqNhEggVxqIH4ofDns5nRrPS6yQxXE1TPCUpFznBfRQmQa8uC+pXqjMnukiJBxCisIxiLGA==
+
+supports-color@^7.1.0:
+  version "7.1.0"
+  resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-7.1.0.tgz#68e32591df73e25ad1c4b49108a2ec507962bfd1"
+  integrity sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==
+  dependencies:
+    has-flag "^4.0.0"
+
+syncpipe@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/syncpipe/-/syncpipe-1.0.0.tgz#170340f813150bc8fcb8878b1b9c71ea0ccd3727"
+  integrity sha512-cdiAFTnFJRvUaNPDc2n9CqoFvtIL3+JUMJZrC3kA3FzpugHOqu0TvkgNwmnxPZ5/WjAzMcfMS3xm+AO7rg/j/w==
+  dependencies:
+    assure-array "^1.0.0"