@adobe/alloy 2.17.0-beta.0 → 2.18.0-beta.0

package/libEs5/utils/validation/chain.js

@@ -1,76 +0,0 @@
-"use strict";
-
-exports.default = void 0;
-
-var _assign = require("../assign");
-
-/*
-Copyright 2020 Adobe. All rights reserved.
-This file is licensed to you under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License. You may obtain a copy
-of the License at http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under
-the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-OF ANY KIND, either express or implied. See the License for the specific language
-governing permissions and limitations under the License.
-*/
-
-/**
- * Chains two validators together.
- *
- * Validators are functions of two parameters (value and path) that return the computed value if
- * the input is valid, or throw an exception if the input is invalid. In most cases the returned
- * value is the same as the input value; however, reference createDefaultValidator.js
- * to see an example where the computed value is different from the input. Additionally, if we ever
- * wanted to coerce types (i.e. parse string values into integers) as part of the validation process
- * we could use the computed value to accomplish that.
- *
- * The path parameter is used to generate informative error messages. It is created by the objectOf, and
- * arrayOf validators so that any error message can describe which key within the object or array is
- * invalid.
- *
- * The validators also have methods to chain additional validation logic. For example, when you call
- * `string()` to start a validator chain, it returns a validator function but it also has methods
- * like `required` and `nonEmpty`. In index.js you can see that these methods are actually calling `chain`.
- * Specifically in this function, the leftValidator is called first and then the return value of that is
- * sent to the rightValidator. For example, when calling `string().nonEmpty().required()` the following
- * chain is built up:
- * ```
- *              *
- *            /   \
- *          *     required
- *        /   \
- *      *     nonEmpty
- *    /   \
- * base   string
- * ```
- * Where every * is a call to chain where the two are combined. The individual validators are called from
- * left to right in the above tree. The base validator is simply the identity function `value => value`,
- * representing an optional value.
- *
- * After combining the validators, the new validator function is then augmented with the methods from the
- * leftValidator and from the additionalMethods parameter. For example, when the string() function is called
- * it chains to the base validator, but also adds additional methods like (`regexp`, `domain`, `nonEmpty`,
- * and `unique`). When `nonEmpty` is called, which calls chain again, the additional methods are carried
- * forward because they are already defined on the leftValidator.
- *
- * The base validator also contains the two methods `required` and `default`, so these can be used anywhere
- * after any of the exposed validator functions are called.
- */
-var _default = function _default(leftValidator, rightValidator) {
-  var additionalMethods = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-
-  // combine the two validators, calling left first and then right.
-  // pass the return value from left into right.
-  var combinedValidator = function combinedValidator(value, path) {
-    return rightValidator(leftValidator(value, path), path);
-  }; // add the methods already defined on the left validator, and the additionalMethods
-  // to the new combined validator function.
-
-
-  (0, _assign.default)(combinedValidator, leftValidator, additionalMethods);
-  return combinedValidator;
-};
-
-exports.default = _default;

package/libEs5/utils/validation/nullSafeChain.js

@@ -1,41 +0,0 @@
-"use strict";
-
-exports.default = void 0;
-
-var _chain = require("./chain");
-
-/*
-Copyright 2020 Adobe. All rights reserved.
-This file is licensed to you under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License. You may obtain a copy
-of the License at http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under
-the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-OF ANY KIND, either express or implied. See the License for the specific language
-governing permissions and limitations under the License.
-*/
-
-/**
- * This augments `chain` with a null check done before running the rightValidator.
- * See chain for more info.
- *
- * For most validators, we want the validation to be optional (i.e. allow null or
- * undefined values). To accomplish this, the validator needs to have a check
- * at the begining of the function, short circuiting the validation logic and
- * returning value if value is null or undefined. `default` and `required` do not
- * want this null check though. Indeed, `default` should return the default value
- * if value is null, and `required` should throw an error if value is null.
- *
- * So to keep from having to have a null check in front of most validators, this
- * function allows you to chain a rightValidator that needs to have a null check.
- */
-var _default = function _default(leftValidator, rightValidator, additionalMethods) {
-  var rightValidatorWithNullCheck = function rightValidatorWithNullCheck(value, path) {
-    return value == null ? value : rightValidator(value, path);
-  };
-
-  return (0, _chain.default)(leftValidator, rightValidatorWithNullCheck, additionalMethods);
-};
-
-exports.default = _default;

package/libEs6/utils/validation/assertValid.js

@@ -1,16 +0,0 @@
-/*
-Copyright 2020 Adobe. All rights reserved.
-This file is licensed to you under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License. You may obtain a copy
-of the License at http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under
-the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-OF ANY KIND, either express or implied. See the License for the specific language
-governing permissions and limitations under the License.
-*/
-export default ((isValid, value, path, message) => {
-  if (!isValid) {
-    throw new Error(`'${path}': Expected ${message}, but got ${JSON.stringify(value)}.`);
-  }
-});

package/libEs6/utils/validation/chain.js

@@ -1,67 +0,0 @@
-/*
-Copyright 2020 Adobe. All rights reserved.
-This file is licensed to you under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License. You may obtain a copy
-of the License at http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under
-the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-OF ANY KIND, either express or implied. See the License for the specific language
-governing permissions and limitations under the License.
-*/
-import assign from "../assign";
-/**
- * Chains two validators together.
- *
- * Validators are functions of two parameters (value and path) that return the computed value if
- * the input is valid, or throw an exception if the input is invalid. In most cases the returned
- * value is the same as the input value; however, reference createDefaultValidator.js
- * to see an example where the computed value is different from the input. Additionally, if we ever
- * wanted to coerce types (i.e. parse string values into integers) as part of the validation process
- * we could use the computed value to accomplish that.
- *
- * The path parameter is used to generate informative error messages. It is created by the objectOf, and
- * arrayOf validators so that any error message can describe which key within the object or array is
- * invalid.
- *
- * The validators also have methods to chain additional validation logic. For example, when you call
- * `string()` to start a validator chain, it returns a validator function but it also has methods
- * like `required` and `nonEmpty`. In index.js you can see that these methods are actually calling `chain`.
- * Specifically in this function, the leftValidator is called first and then the return value of that is
- * sent to the rightValidator. For example, when calling `string().nonEmpty().required()` the following
- * chain is built up:
- * ```
- *              *
- *            /   \
- *          *     required
- *        /   \
- *      *     nonEmpty
- *    /   \
- * base   string
- * ```
- * Where every * is a call to chain where the two are combined. The individual validators are called from
- * left to right in the above tree. The base validator is simply the identity function `value => value`,
- * representing an optional value.
- *
- * After combining the validators, the new validator function is then augmented with the methods from the
- * leftValidator and from the additionalMethods parameter. For example, when the string() function is called
- * it chains to the base validator, but also adds additional methods like (`regexp`, `domain`, `nonEmpty`,
- * and `unique`). When `nonEmpty` is called, which calls chain again, the additional methods are carried
- * forward because they are already defined on the leftValidator.
- *
- * The base validator also contains the two methods `required` and `default`, so these can be used anywhere
- * after any of the exposed validator functions are called.
- */
-
-export default ((leftValidator, rightValidator, additionalMethods = {}) => {
-  // combine the two validators, calling left first and then right.
-  // pass the return value from left into right.
-  const combinedValidator = (value, path) => {
-    return rightValidator(leftValidator(value, path), path);
-  }; // add the methods already defined on the left validator, and the additionalMethods
-  // to the new combined validator function.
-
-
-  assign(combinedValidator, leftValidator, additionalMethods);
-  return combinedValidator;
-});

package/libEs6/utils/validation/nullSafeChain.js

@@ -1,32 +0,0 @@
-/*
-Copyright 2020 Adobe. All rights reserved.
-This file is licensed to you under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License. You may obtain a copy
-of the License at http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under
-the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-OF ANY KIND, either express or implied. See the License for the specific language
-governing permissions and limitations under the License.
-*/
-import chain from "./chain";
-/**
- * This augments `chain` with a null check done before running the rightValidator.
- * See chain for more info.
- *
- * For most validators, we want the validation to be optional (i.e. allow null or
- * undefined values). To accomplish this, the validator needs to have a check
- * at the begining of the function, short circuiting the validation logic and
- * returning value if value is null or undefined. `default` and `required` do not
- * want this null check though. Indeed, `default` should return the default value
- * if value is null, and `required` should throw an error if value is null.
- *
- * So to keep from having to have a null check in front of most validators, this
- * function allows you to chain a rightValidator that needs to have a null check.
- */
-
-export default ((leftValidator, rightValidator, additionalMethods) => {
-  const rightValidatorWithNullCheck = (value, path) => value == null ? value : rightValidator(value, path);
-
-  return chain(leftValidator, rightValidatorWithNullCheck, additionalMethods);
-});