@adobe/alloy 2.20.0-alpha.1 → 2.20.0-beta.2

package/libEs6/utils/validation/domainValidator.js

@@ -1,17 +0,0 @@
-/*
-Copyright 2019 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 { assertValid } from "./utils";
-const DOMAIN_REGEX = /^[a-z0-9.-]{1,}$/i;
-export default ((value, path) => {
-  assertValid(DOMAIN_REGEX.test(value), value, path, "a valid domain");
-  return value;
-});

package/libEs6/utils/validation/index.js

@@ -1,232 +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.
-*/
-
-/**
- * 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`.
- * Here 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.
- *
- * 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,
- * nullSafeChain allows you to chain a validator in a null-safe way.
- */
-
-import { chain, nullSafeChain, reverseNullSafeChainJoinErrors } from "./utils";
-import booleanValidator from "./booleanValidator";
-import callbackValidator from "./callbackValidator";
-import createArrayOfValidator from "./createArrayOfValidator";
-import createDefaultValidator from "./createDefaultValidator";
-import createDeprecatedValidator from "./createDeprecatedValidator";
-import createLiteralValidator from "./createLiteralValidator";
-import createMapOfValuesValidator from "./createMapOfValuesValidator";
-import createMinimumValidator from "./createMinimumValidator";
-import createMaximumValidator from "./createMaximumValidator";
-import createNoUnknownFieldsValidator from "./createNoUnknownFieldsValidator";
-import createNonEmptyValidator from "./createNonEmptyValidator";
-import createObjectOfValidator from "./createObjectOfValidator";
-import createAnyOfValidator from "./createAnyOfValidator";
-import createUniqueValidator from "./createUniqueValidator";
-import createUniqueItemsValidator from "./createUniqueItemsValidator";
-import domainValidator from "./domainValidator";
-import integerValidator from "./integerValidator";
-import numberValidator from "./numberValidator";
-import regexpValidator from "./regexpValidator";
-import requiredValidator from "./requiredValidator";
-import stringValidator from "./stringValidator";
-import matchesRegexpValidator from "./matchesRegexpValidator";
-
-// The base validator does no validation and just returns the value unchanged
-const base = value => value;
-
-// The 'default', 'required', and 'deprecated' methods are available after any
-// data-type method. Don't use the nullSafeChain on 'default' or 'required'
-// because they need to handle the null or undefined case
-base.default = function _default(defaultValue) {
-  return chain(this, createDefaultValidator(defaultValue));
-};
-base.required = function required() {
-  return chain(this, requiredValidator);
-};
-
-// helper validators
-const domain = function domain() {
-  return nullSafeChain(this, domainValidator);
-};
-const minimumInteger = function minimumInteger(minValue) {
-  return nullSafeChain(this, createMinimumValidator("an integer", minValue));
-};
-const minimumNumber = function minimumNumber(minValue) {
-  return nullSafeChain(this, createMinimumValidator("a number", minValue));
-};
-const maximumNumber = function maximumNumber(maxValue) {
-  return nullSafeChain(this, createMaximumValidator("a number", maxValue));
-};
-const integer = function integer() {
-  return nullSafeChain(this, integerValidator, {
-    minimum: minimumInteger
-  });
-};
-const nonEmptyString = function nonEmptyString() {
-  return nullSafeChain(this, createNonEmptyValidator("a non-empty string"));
-};
-const nonEmptyArray = function nonEmptyArray() {
-  return nullSafeChain(this, createNonEmptyValidator("a non-empty array"));
-};
-const nonEmptyObject = function nonEmptyObject() {
-  return nullSafeChain(this, createNonEmptyValidator("a non-empty object"));
-};
-const regexp = function regexp() {
-  return nullSafeChain(this, regexpValidator);
-};
-const matches = function matches(regexpPattern) {
-  return nullSafeChain(this, matchesRegexpValidator(regexpPattern));
-};
-const unique = function createUnique() {
-  return nullSafeChain(this, createUniqueValidator());
-};
-const uniqueItems = function createUniqueItems() {
-  return nullSafeChain(this, createUniqueItemsValidator());
-};
-
-// top-level validators.  These are the first functions that are called to create a validator.
-const anyOf = function anyOf(validators, message) {
-  // use chain here because we don't want to accept null or undefined unless at least
-  // one of the validators accept null or undefined.
-  return chain(this, createAnyOfValidator(validators, message));
-};
-const anything = function anything() {
-  return this;
-};
-const arrayOf = function arrayOf(elementValidator) {
-  return nullSafeChain(this, createArrayOfValidator(elementValidator), {
-    nonEmpty: nonEmptyArray,
-    uniqueItems
-  });
-};
-const boolean = function boolean() {
-  return nullSafeChain(this, booleanValidator);
-};
-const callback = function callback() {
-  return nullSafeChain(this, callbackValidator);
-};
-const literal = function literal(literalValue) {
-  return nullSafeChain(this, createLiteralValidator(literalValue));
-};
-const number = function number() {
-  return nullSafeChain(this, numberValidator, {
-    minimum: minimumNumber,
-    maximum: maximumNumber,
-    integer,
-    unique
-  });
-};
-const mapOfValues = function mapOfValues(valuesValidator) {
-  return nullSafeChain(this, createMapOfValuesValidator(valuesValidator), {
-    nonEmpty: nonEmptyObject
-  });
-};
-const createObjectOfAdditionalProperties = schema => ({
-  noUnknownFields: function noUnknownFields() {
-    return nullSafeChain(this, createNoUnknownFieldsValidator(schema));
-  },
-  nonEmpty: nonEmptyObject,
-  concat: function concat(otherObjectOfValidator) {
-    // combine the schema so that noUnknownFields, and concat have the combined schema
-    const newSchema = {
-      ...schema,
-      ...otherObjectOfValidator.schema
-    };
-    return nullSafeChain(this, otherObjectOfValidator, createObjectOfAdditionalProperties(newSchema));
-  },
-  deprecated: function deprecated(oldField, oldSchema, newField) {
-    // Run the deprecated validator first so that the deprecated field is removed
-    // before the objectOf validator runs.
-    return reverseNullSafeChainJoinErrors(this, createDeprecatedValidator(oldField, oldSchema, newField));
-  },
-  schema
-});
-const objectOf = function objectOf(schema) {
-  return nullSafeChain(this, createObjectOfValidator(schema), createObjectOfAdditionalProperties(schema));
-};
-const string = function string() {
-  return nullSafeChain(this, stringValidator, {
-    regexp,
-    domain,
-    nonEmpty: nonEmptyString,
-    unique,
-    matches
-  });
-};
-const boundAnyOf = anyOf.bind(base);
-const boundAnything = anything.bind(base);
-const boundArrayOf = arrayOf.bind(base);
-const boundBoolean = boolean.bind(base);
-const boundCallback = callback.bind(base);
-const boundLiteral = literal.bind(base);
-const boundNumber = number.bind(base);
-const boundMapOfValues = mapOfValues.bind(base);
-const boundObjectOf = objectOf.bind(base);
-const boundString = string.bind(base);
-
-// compound validators
-const boundEnumOf = function boundEnumOf(...values) {
-  return boundAnyOf(values.map(boundLiteral), `one of these values: [${JSON.stringify(values)}]`);
-};
-export { boundAnyOf as anyOf, boundAnything as anything, boundArrayOf as arrayOf, boundBoolean as boolean, boundCallback as callback, boundLiteral as literal, boundNumber as number, boundMapOfValues as mapOfValues, boundObjectOf as objectOf, boundString as string, boundEnumOf as enumOf };

package/libEs6/utils/validation/integerValidator.js

@@ -1,18 +0,0 @@
-/*
-Copyright 2019 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 isInteger from "../isInteger";
-import { assertValid } from "./utils";
-export default ((value, path) => {
-  assertValid(isInteger(value), value, path, "an integer");
-  return value;
-});

package/libEs6/utils/validation/matchesRegexpValidator.js

@@ -1,17 +0,0 @@
-/*
-Copyright 2023 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 { assertValid } from "./utils";
-export default (regexp => (value, path) => {
-  assertValid(regexp.test(value), value, path, `does not match the ${regexp.toString()}`);
-  return value;
-});

package/libEs6/utils/validation/numberValidator.js

@@ -1,18 +0,0 @@
-/*
-Copyright 2019 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 isNumber from "../isNumber";
-import { assertValid } from "./utils";
-export default ((value, path) => {
-  assertValid(isNumber(value), value, path, "a number");
-  return value;
-});

package/libEs6/utils/validation/regexpValidator.js

@@ -1,18 +0,0 @@
-/*
-Copyright 2019 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 { assertValid } from "./utils";
-import isValidRegExp from "../isValidRegExp";
-export default ((value, path) => {
-  assertValid(isValidRegExp(value), value, path, "a regular expression");
-  return value;
-});

package/libEs6/utils/validation/requiredValidator.js

@@ -1,18 +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 ((value, path) => {
-  if (value == null) {
-    throw new Error(`'${path}' is a required option`);
-  }
-  return value;
-});

package/libEs6/utils/validation/stringValidator.js

@@ -1,17 +0,0 @@
-/*
-Copyright 2019 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 isString from "../isString";
-import { assertValid } from "./utils";
-export default ((value, path) => {
-  assertValid(isString(value), value, path, "a string");
-  return value;
-});

package/libEs6/utils/validation/utils.js

@@ -1,127 +0,0 @@
-/*
-Copyright 2023 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 is used to add methods onto a function.
-import assign from "../assign";
-
-/**
- * Wraps a validator returning the value if it is null or undefined, otherwise
- * it will call the original validator and return the result.
- *
- * @param {function} validator - the validator to call if the value is not null
- */
-const skipIfNull = validator => function skipIfNullValidator(value, path) {
-  return value == null ? value : validator.call(this, value, path);
-};
-
-/**
- * Returns a new validator that calls the first validator and then calls the second
- * validator with the result of the first validator. The result of the second validator
- * is returned.
- *
- * @param {function} firstValidator - validator to call first
- * @param {function} secondValidator - validator to call second
- * @returns {function} - a new validator that calls the first and second validators
- */
-const callSequentially = (firstValidator, secondValidator) => function callSequentiallyValidator(value, path) {
-  return secondValidator.call(this, firstValidator.call(this, value, path), path);
-};
-
-/**
- * Just like callSequentially, but if either validator throws an error, the errors
- * are collected and thrown at the end.
- *
- * @param {function} firstValidator
- * @param {function} secondValidator
- * @returns {function}
- */
-const callSequentiallyJoinErrors = (firstValidator, secondValidator) => function callSequentiallyJoinErrorsValidator(value, path) {
-  const errors = [];
-  const newValue = [firstValidator, secondValidator].reduce((memo, validator) => {
-    try {
-      return validator.call(this, memo, path);
-    } catch (e) {
-      errors.push(e);
-      return memo;
-    }
-  }, value);
-  if (errors.length) {
-    throw new Error(errors.join("\n"));
-  }
-  return newValue;
-};
-
-/**
- * Chains two validators together. In addition to calling the validators in
- * sequence, this will also copy over methods from the base validator to the
- * resulting validator and include any additional methods.
- *
- * @param {function} baseValidator - This validator will be called first, and its
- * methods will be copied over to the returned validator.
- * @param {function} newValidator - This validator will be called second.
- * @param {object} additionalMethods - Additional methods to include on the returned
- * validator.
- * @returns {function}
- */
-export const chain = (baseValidator, newValidator, additionalMethods) => {
-  return assign(callSequentially(baseValidator, newValidator), baseValidator, additionalMethods);
-};
-
-/**
- * Chains two validators together, but skips the second validator if the value
- * is null. In addition to calling the validators in sequence, this will also
- * copy over methods from the base validator to the resulting validator and
- * include any additional methods.
- *
- * @param {function} baseValidator - This validator will be called first, and its
- * methods will be copied over to the returned validator.
- * @param {function} newValidator - This validator will be called second. If the value
- * is null after the first validator is called, this validator will not be
- * called.
- * @param {object} additionalMethods - Additional methods to include on the returned
- * validator.
- * @returns {function}
- */
-export const nullSafeChain = (baseValidator, newValidator, additionalMethods) => {
-  return assign(callSequentially(baseValidator, skipIfNull(newValidator)), baseValidator, additionalMethods);
-};
-
-/**
- * Same as nullSafeChain, but calls the new validator first.
- *
- * @param {function} baseValidator - This validator will be called second, and its
- * methods will be copied over to the returned validator.
- * @param {function} newValidator - This validator will be called first. If the value
- * is null, this validator will not be called.
- * @param {function} additionalMethods - Additional methods to include on the returned
- * validator.
- * @returns {function}
- */
-export const reverseNullSafeChainJoinErrors = (baseValidator, newValidator, additionalMethods) => {
-  return assign(callSequentiallyJoinErrors(skipIfNull(newValidator), baseValidator), baseValidator, additionalMethods);
-};
-
-/**
- * Throws an error if the value is not valid.
- *
- * @param {boolean} isValid - Whether or not the value is valid.
- * @param {*} value - The value to validate.
- * @param {string} path - The path to the value.
- * @param {string} message - The expected part of the error message.
- * @throws {Error} - Throws an error if the value is not valid.
- * @returns {void}
- */
-export const assertValid = (isValid, value, path, message) => {
-  if (!isValid) {
-    throw new Error(`'${path}': Expected ${message}, but got ${JSON.stringify(value)}.`);
-  }
-};

package/libEs6/utils/values.js

@@ -1,21 +0,0 @@
-/*
-Copyright 2019 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.
-*/
-
-/**
- * Returns an array whose items are the provided object's own enumerable
- * property values.
- * @param {Object} obj
- * @returns {Array}
- */
-export default (obj => {
-  return Object.keys(obj).map(key => obj[key]);
-});