@flowscripter/dynamic-cli-framework 1.7.2 → 1.7.4

package/dist/src/runtime/values/argumentValueValidation.js

@@ -0,0 +1,505 @@
+import { ArgumentValueTypeName, ComplexValueTypeName, } from "../../api/argument/ArgumentValueTypes.js";
+import { isComplexOption } from "../argument/ArgumentTypeGuards.js";
+import { InvalidArgumentReason } from "../../api/RunResult.js";
+/**
+ * Validates the provided primitive value against the provided {@link Argument}.
+ *
+ * @param argument the {@link Argument} to validate against.
+ * @param value the value (if any) for the {@link Argument}.
+ */
+function validatePrimitiveValue(argument, value) {
+    let convertedValue;
+    if (value === undefined) {
+        return {
+            invalidArgument: {
+                argument,
+                reason: InvalidArgumentReason.MISSING_VALUE,
+            },
+        };
+    }
+    // type check and conversion
+    let castValue;
+    switch (argument.type) {
+        case ArgumentValueTypeName.BOOLEAN:
+            if (value === true || value === false) {
+                convertedValue = value;
+                break;
+            }
+            if (typeof value === "string") {
+                castValue = value;
+                castValue = castValue.toLowerCase();
+            }
+            if (castValue !== "true" && castValue !== "false") {
+                return {
+                    invalidArgument: {
+                        argument,
+                        value,
+                        reason: InvalidArgumentReason.INCORRECT_VALUE_TYPE,
+                    },
+                };
+            }
+            convertedValue = castValue === "true";
+            break;
+        case ArgumentValueTypeName.INTEGER:
+            if (!Number.isInteger(Number(value))) {
+                return {
+                    invalidArgument: {
+                        argument,
+                        value,
+                        reason: InvalidArgumentReason.INCORRECT_VALUE_TYPE,
+                    },
+                };
+            }
+            convertedValue = Number(value);
+            break;
+        case ArgumentValueTypeName.NUMBER:
+            if (!Number.isFinite(Number(value))) {
+                return {
+                    invalidArgument: {
+                        argument,
+                        value,
+                        reason: InvalidArgumentReason.INCORRECT_VALUE_TYPE,
+                    },
+                };
+            }
+            convertedValue = Number(value);
+            break;
+        case ArgumentValueTypeName.STRING:
+        default:
+            convertedValue = String(value);
+            break;
+    }
+    // check if the value is valid
+    if (argument.allowableValues) {
+        let searchValue = convertedValue;
+        let allowableValues = argument.allowableValues;
+        if (argument.type === ArgumentValueTypeName.STRING && argument.isCaseInsensitive) {
+            searchValue = convertedValue.toLowerCase();
+            allowableValues = argument.allowableValues.map((v) => v.toLowerCase());
+        }
+        if (!allowableValues.includes(searchValue)) {
+            return {
+                invalidArgument: {
+                    argument,
+                    value,
+                    reason: InvalidArgumentReason.ILLEGAL_VALUE,
+                },
+            };
+        }
+    }
+    if (argument.minValueInclusive !== undefined) {
+        if (convertedValue < argument.minValueInclusive) {
+            return {
+                invalidArgument: {
+                    argument,
+                    value,
+                    reason: InvalidArgumentReason.ILLEGAL_VALUE,
+                },
+            };
+        }
+    }
+    if (argument.maxValueInclusive !== undefined) {
+        if (convertedValue > argument.maxValueInclusive) {
+            return {
+                invalidArgument: {
+                    argument,
+                    value,
+                    reason: InvalidArgumentReason.ILLEGAL_VALUE,
+                },
+            };
+        }
+    }
+    return { validValue: convertedValue };
+}
+function validateArrayValue(subCommandArgument, arrayValue) {
+    const convertedArrayValue = [];
+    for (let i = 0; i < arrayValue.length; i += 1) {
+        const singleValue = arrayValue[i];
+        if (singleValue === undefined) {
+            return {
+                validValue: convertedArrayValue,
+                invalidArgument: {
+                    argument: subCommandArgument,
+                    name: `[${i}]`,
+                    reason: InvalidArgumentReason.ILLEGAL_SPARSE_ARRAY,
+                },
+            };
+        }
+        let validationResult;
+        if (Array.isArray(singleValue)) {
+            throw new Error(`Unexpected array value as array member, arrays of arrays are not supported. Argument: ${subCommandArgument.name}[${i}]`);
+        }
+        else if (typeof singleValue === "object") {
+            if (subCommandArgument.type !== ComplexValueTypeName.COMPLEX) {
+                return {
+                    validValue: convertedArrayValue,
+                    invalidArgument: {
+                        argument: subCommandArgument,
+                        name: `[${i}]`,
+                        value: arrayValue,
+                        reason: InvalidArgumentReason.INCORRECT_VALUE_TYPE,
+                    },
+                };
+            }
+            validationResult = validateObjectValue(subCommandArgument, singleValue);
+        } // if not array and not object, then must be primitive
+        else {
+            if (isComplexOption(subCommandArgument)) {
+                return {
+                    validValue: convertedArrayValue,
+                    invalidArgument: {
+                        argument: subCommandArgument,
+                        name: `[${i}]`,
+                        value: arrayValue,
+                        reason: InvalidArgumentReason.INCORRECT_VALUE_TYPE,
+                    },
+                };
+            }
+            validationResult = validatePrimitiveValue(subCommandArgument, singleValue);
+        }
+        if (validationResult.validValue !== undefined) {
+            convertedArrayValue.push(validationResult.validValue);
+        }
+        if (validationResult.invalidArgument) {
+            // fast fail
+            if (validationResult.invalidArgument.value !== undefined) {
+                return {
+                    validValue: convertedArrayValue,
+                    invalidArgument: {
+                        argument: validationResult.invalidArgument.argument,
+                        name: `[${i}]${validationResult.invalidArgument.name ? validationResult.invalidArgument.name : ""}`,
+                        value: validationResult.invalidArgument.value,
+                        reason: validationResult.invalidArgument.reason,
+                    },
+                };
+            }
+            else {
+                return {
+                    validValue: convertedArrayValue,
+                    invalidArgument: {
+                        argument: validationResult.invalidArgument.argument,
+                        name: `[${i}]${validationResult.invalidArgument.name ? validationResult.invalidArgument.name : ""}`,
+                        reason: validationResult.invalidArgument.reason,
+                    },
+                };
+            }
+        }
+    }
+    return {
+        validValue: convertedArrayValue,
+    };
+}
+function validateObjectValue(argument, objectValue) {
+    const convertedObjectValue = {};
+    for (let i = 0; i < argument.properties.length; i++) {
+        const propertyArg = argument.properties[i];
+        const propertyValue = objectValue[propertyArg.name];
+        if (propertyValue === undefined) {
+            return {
+                validValue: convertedObjectValue,
+                invalidArgument: {
+                    argument: propertyArg,
+                    name: `.${propertyArg.name}`,
+                    reason: InvalidArgumentReason.MISSING_VALUE,
+                },
+            };
+        }
+        let validationResult;
+        if (Array.isArray(propertyValue)) {
+            if (!propertyArg.isArray) {
+                return {
+                    validValue: convertedObjectValue,
+                    invalidArgument: {
+                        argument: propertyArg,
+                        name: `.${propertyArg.name}`,
+                        value: propertyValue,
+                        reason: InvalidArgumentReason.ILLEGAL_MULTIPLE_VALUES,
+                    },
+                };
+            }
+            validationResult = validateArrayValue(propertyArg, propertyValue);
+        }
+        else if (typeof propertyValue === "object") {
+            if (propertyArg.type !== ComplexValueTypeName.COMPLEX) {
+                return {
+                    validValue: convertedObjectValue,
+                    invalidArgument: {
+                        argument: propertyArg,
+                        name: `.${propertyArg.name}`,
+                        value: propertyValue,
+                        reason: InvalidArgumentReason.INCORRECT_VALUE_TYPE,
+                    },
+                };
+            }
+            validationResult = validateObjectValue(propertyArg, propertyValue);
+        } // if not array and not object, then must be primitive
+        else {
+            if (isComplexOption(propertyArg)) {
+                return {
+                    validValue: convertedObjectValue,
+                    invalidArgument: {
+                        argument: propertyArg,
+                        name: `.${propertyArg.name}`,
+                        value: propertyValue,
+                        reason: InvalidArgumentReason.INCORRECT_VALUE_TYPE,
+                    },
+                };
+            }
+            validationResult = validatePrimitiveValue(propertyArg, propertyValue);
+        }
+        if (validationResult.validValue !== undefined) {
+            convertedObjectValue[propertyArg.name] = validationResult.validValue;
+        }
+        // fast fail
+        if (validationResult.invalidArgument !== undefined) {
+            if (validationResult.invalidArgument.value !== undefined) {
+                return {
+                    validValue: convertedObjectValue,
+                    invalidArgument: {
+                        argument: validationResult.invalidArgument.argument,
+                        name: `.${propertyArg.name}${validationResult.invalidArgument.name ? validationResult.invalidArgument.name : ""}`,
+                        value: validationResult.invalidArgument.value,
+                        reason: validationResult.invalidArgument.reason,
+                    },
+                };
+            }
+            else {
+                return {
+                    validValue: convertedObjectValue,
+                    invalidArgument: {
+                        argument: validationResult.invalidArgument.argument,
+                        name: `.${propertyArg.name}${validationResult.invalidArgument.name ? validationResult.invalidArgument.name : ""}`,
+                        reason: validationResult.invalidArgument.reason,
+                    },
+                };
+            }
+        }
+    }
+    return {
+        validValue: convertedObjectValue,
+    };
+}
+function doSubCommandArgumentValidation(argument, value, isArray, isOptional, invalidArguments) {
+    // if there is a value, check if it is valid
+    if (value !== undefined) {
+        let validationResult;
+        if (Array.isArray(value)) {
+            if (!isArray) {
+                invalidArguments.push({
+                    argument,
+                    name: argument.name,
+                    value,
+                    reason: InvalidArgumentReason.ILLEGAL_MULTIPLE_VALUES,
+                });
+                return undefined;
+            }
+            validationResult = validateArrayValue(argument, value);
+        }
+        else if (typeof value === "object") {
+            if (!isComplexOption(argument)) {
+                invalidArguments.push({
+                    argument,
+                    name: argument.name,
+                    value,
+                    reason: InvalidArgumentReason.INCORRECT_VALUE_TYPE,
+                });
+                return undefined;
+            }
+            validationResult = validateObjectValue(argument, value);
+        }
+        else {
+            if (isComplexOption(argument)) {
+                invalidArguments.push({
+                    argument,
+                    name: argument.name,
+                    value,
+                    reason: InvalidArgumentReason.INCORRECT_VALUE_TYPE,
+                });
+                return undefined;
+            }
+            validationResult = validatePrimitiveValue(argument, value);
+        }
+        if (validationResult.invalidArgument !== undefined) {
+            if (validationResult.invalidArgument.value !== undefined) {
+                validationResult.invalidArgument = {
+                    argument: validationResult.invalidArgument.argument,
+                    name: `${argument.name}${validationResult.invalidArgument.name ? validationResult.invalidArgument.name : ""}`,
+                    value: validationResult.invalidArgument.value,
+                    reason: validationResult.invalidArgument.reason,
+                };
+            }
+            else {
+                validationResult.invalidArgument = {
+                    argument: validationResult.invalidArgument.argument,
+                    name: `${argument.name}${validationResult.invalidArgument.name ? validationResult.invalidArgument.name : ""}`,
+                    reason: validationResult.invalidArgument.reason,
+                };
+            }
+        }
+        if (validationResult.invalidArgument) {
+            invalidArguments.push(validationResult.invalidArgument);
+            return undefined;
+        }
+        if (argument.validate && validationResult.validValue !== undefined) {
+            const customError = argument.validate(validationResult.validValue);
+            if (customError !== undefined) {
+                invalidArguments.push({
+                    argument,
+                    name: argument.name,
+                    value: validationResult.validValue,
+                    reason: InvalidArgumentReason.CUSTOM_VALIDATION,
+                    message: customError,
+                });
+                return undefined;
+            }
+        }
+        return validationResult.validValue;
+    }
+    // if there is no value, check if it was optional
+    if (!isOptional) {
+        invalidArguments.push({
+            argument: argument,
+            name: argument.name,
+            reason: InvalidArgumentReason.MISSING_VALUE,
+        });
+    }
+    return undefined;
+}
+/**
+ * Validates the provided value against the provided {@link Option}.
+ *
+ * @param option the {@link Option} to validate against.
+ * @param value the value (if any) for the {@link Option}.
+ * @param invalidArguments an array of {@link InvalidArgument} which may be added to if the provided value is invalid.
+ */
+export function validateOptionValue(option, value, invalidArguments) {
+    return doSubCommandArgumentValidation(option, value, option.isArray || false, option.isOptional || false, invalidArguments);
+}
+/**
+ * Validates the provided value against the provided {@link Positional}.
+ *
+ * @param positional the {@link Positional} to validate against.
+ * @param value the value (if any) for the {@link Positional}.
+ * @param invalidArguments an array of {@link InvalidArgument} which may be added to if the provided value is invalid.
+ */
+export function validatePositionalValue(positional, value, invalidArguments) {
+    return doSubCommandArgumentValidation(positional, value, positional.isVarargMultiple || false, positional.isVarargOptional || false, invalidArguments);
+}
+/**
+ * Validates the provided value against the {@link GlobalCommandArgument} provided by the {@link GlobalCommand} and returns the validated
+ * value or undefined if the value was invalid.
+ *
+ * @param globalCommand the {@link GlobalCommand} providing the {@link GlobalCommandArgument}.
+ * @param value the value (if any) for the {@link GlobalCommandArgument}.
+ * @param invalidArguments an array of {@link InvalidArgument} which may be added to if the provided value is invalid.
+ */
+export function validateGlobalCommandArgumentValue(globalCommand, value, invalidArguments) {
+    // if this function is called it is because the argument is defined
+    const globalCommandArgument = globalCommand.argument;
+    // if there is a value, check if it is valid
+    if (value !== undefined) {
+        const validationResult = validatePrimitiveValue(globalCommandArgument, value);
+        if (validationResult.invalidArgument) {
+            if (validationResult.invalidArgument.value !== undefined) {
+                invalidArguments.push({
+                    argument: globalCommandArgument,
+                    name: globalCommand.name,
+                    value: validationResult.invalidArgument.value,
+                    reason: validationResult.invalidArgument.reason,
+                });
+            }
+            else {
+                invalidArguments.push({
+                    argument: globalCommandArgument,
+                    name: globalCommand.name,
+                    reason: validationResult.invalidArgument.reason,
+                });
+            }
+            return undefined;
+        }
+        if (globalCommandArgument.validate && validationResult.validValue !== undefined) {
+            const customError = globalCommandArgument.validate(validationResult.validValue);
+            if (customError !== undefined) {
+                invalidArguments.push({
+                    argument: globalCommandArgument,
+                    name: globalCommand.name,
+                    value: validationResult.validValue,
+                    reason: InvalidArgumentReason.CUSTOM_VALIDATION,
+                    message: customError,
+                });
+                return undefined;
+            }
+        }
+        return validationResult.validValue;
+    }
+    // if there is no value, check if it was optional
+    if (!globalCommandArgument.isOptional) {
+        invalidArguments.push({
+            argument: globalCommandArgument,
+            name: globalCommand.name,
+            reason: InvalidArgumentReason.MISSING_VALUE,
+        });
+    }
+    return undefined;
+}
+export function getInvalidArgumentString(invalidArgument, skipArgName) {
+    let nameString = "";
+    if (!skipArgName && invalidArgument.name !== undefined) {
+        nameString = invalidArgument.name;
+    }
+    let valueString = "";
+    if (invalidArgument.value !== undefined) {
+        valueString = `'${invalidArgument.value}'`;
+    }
+    let argString = "";
+    if (nameString !== "") {
+        if (valueString !== "") {
+            argString = `${nameString}=${valueString} `;
+        }
+        else {
+            argString = `${nameString} `;
+        }
+    }
+    else if (valueString !== "") {
+        argString = `${valueString} `;
+    }
+    let invalidString;
+    switch (invalidArgument.reason) {
+        case InvalidArgumentReason.MISSING_VALUE:
+            invalidString = "(missing value)";
+            break;
+        case InvalidArgumentReason.INCORRECT_VALUE_TYPE:
+            invalidString = "(incorrect type)";
+            break;
+        case InvalidArgumentReason.ILLEGAL_MULTIPLE_VALUES:
+            invalidString = "(illegal multiple values)";
+            break;
+        case InvalidArgumentReason.ILLEGAL_VALUE:
+            invalidString = "(illegal value)";
+            break;
+        case InvalidArgumentReason.ILLEGAL_SPARSE_ARRAY:
+            invalidString = "(sparse array values)";
+            break;
+        case InvalidArgumentReason.UNKNOWN_PROPERTY:
+            invalidString = "(unknown property)";
+            break;
+        case InvalidArgumentReason.NESTING_DEPTH_EXCEEDED:
+            invalidString = "(nesting depth exceeded)";
+            break;
+        case InvalidArgumentReason.ARRAY_SIZE_EXCEEDED:
+            invalidString = "(array size exceeded)";
+            break;
+        case InvalidArgumentReason.OPTION_IS_COMPLEX:
+            invalidString = "(specified option is complex)";
+            break;
+        case InvalidArgumentReason.CUSTOM_VALIDATION:
+            invalidString = invalidArgument.message
+                ? `(custom validation: ${invalidArgument.message})`
+                : "(custom validation failed)";
+            break;
+        default:
+            invalidString = "";
+            break;
+    }
+    return `${argString}${invalidString}`;
+}

package/dist/src/runtime/values/globalCommandValuePopulation.js

@@ -0,0 +1,67 @@
+import { ArgumentValueTypeName } from "../../api/argument/ArgumentValueTypes.js";
+import getLogger from "../../util/logger.js";
+import { InvalidArgumentReason } from "../../api/RunResult.js";
+const logger = getLogger("globalCommandValuePopulation");
+/**
+ * Attempt to populate a {@link ArgumentValueType} for the provided {@link GlobalCommand} using the provided potential args.
+ *
+ * @param globalCommand the {@link GlobalCommand} for which {@link ArgumentValues} values should be populated.
+ * @param potentialArgs the potential args to use for population.
+ * @param defaultValue optional default value to use for population before parsing the provided arguments.
+ */
+export default function populateGlobalCommandValue(globalCommand, potentialArgs, defaultValue) {
+    logger.debug(() => {
+        const message = `Populating value for global command: '${globalCommand.name}' using potential args: ${potentialArgs.join(" ")}`;
+        if (defaultValue !== undefined) {
+            return `${message} and configured value: '${defaultValue}'`;
+        }
+        return message;
+    });
+    const argument = globalCommand.argument;
+    // default to defined argument default value
+    let populatedArgumentValue = argument.defaultValue;
+    // override with provided configured value
+    if (defaultValue !== undefined) {
+        populatedArgumentValue = defaultValue;
+    }
+    let unusedArgs = [];
+    if (potentialArgs.length > 0) {
+        const firstPotentialArg = potentialArgs[0];
+        // don't use potentialArg if it cannot be a boolean value...
+        if (argument.type === ArgumentValueTypeName.BOOLEAN) {
+            const firstPotentialArgLower = firstPotentialArg.toLowerCase();
+            if (firstPotentialArgLower !== "true" && firstPotentialArgLower !== "false") {
+                // ...instead, use the fact that the argument is present as the value true
+                return {
+                    populatedArgumentValue: "true",
+                    unusedArgs: potentialArgs,
+                };
+            }
+        }
+        // otherwise override with parsed argument value
+        populatedArgumentValue = firstPotentialArg;
+        unusedArgs = potentialArgs.slice(1);
+    } // check if argument type is boolean and therefore command being specified is an implicit value of true
+    else if (argument.type === ArgumentValueTypeName.BOOLEAN &&
+        (populatedArgumentValue === undefined || argument.defaultValue === false)) {
+        return {
+            populatedArgumentValue: "true",
+            unusedArgs,
+        };
+    }
+    // check if there is no value and the global command argument is not optional
+    if (populatedArgumentValue === undefined && !argument.isOptional) {
+        return {
+            populatedArgumentValue,
+            unusedArgs,
+            invalidArgument: {
+                name: globalCommand.name,
+                reason: InvalidArgumentReason.MISSING_VALUE,
+            },
+        };
+    }
+    return {
+        populatedArgumentValue,
+        unusedArgs,
+    };
+}