@flowscripter/dynamic-cli-framework 1.7.2 → 1.7.4

package/dist/src/util/envVarHelper.js

@@ -0,0 +1,216 @@
+import process from "node:process";
+import { ArgumentValueTypeName, ComplexValueTypeName, } from "../api/argument/ArgumentValueTypes.js";
+import { MAXIMUM_ARGUMENT_ARRAY_SIZE } from "../api/argument/SubCommandArgument.js";
+function getKeySegment(segment) {
+    let keySegment = segment.replace("-", "_").toUpperCase();
+    if (keySegment[0].match(/[0-9]/)) {
+        keySegment = `_${keySegment}`;
+    }
+    return keySegment;
+}
+function getSubCommandArgumentKeyPrefix(cliConfig, command, subCommandArgument) {
+    if (subCommandArgument.configurationKey) {
+        return subCommandArgument.configurationKey;
+    }
+    return `${getKeySegment(cliConfig.name)}_${getKeySegment(command.name)}_${getKeySegment(subCommandArgument.name)}`;
+}
+function getGlobalArgumentKeyPrefix(cliConfig, command, globalCommandArgument) {
+    if (globalCommandArgument.configurationKey) {
+        return globalCommandArgument.configurationKey;
+    }
+    return `${getKeySegment(cliConfig.name)}_${getKeySegment(command.name)}`;
+}
+/**
+ * Get configured argument value for the specified {@link GlobalCommandArgument} from environment variables.
+ *
+ * @param cliConfig the {@link CLIConfig} to use for determining the default configuration key.
+ * @param command the {@link GlobalCommand} to use for determining the default configuration key and containing a
+ * {@link GlobalCommandArgument} instance to populate a value for.
+ */
+export function getGlobalCommandValueFromEnvVars(cliConfig, command) {
+    const { argument } = command;
+    if (argument === undefined) {
+        return undefined;
+    }
+    // simple check for a specific env var name
+    let envVarValue = process.env[getGlobalArgumentKeyPrefix(cliConfig, command, argument)];
+    if (envVarValue != undefined && argument.type === ArgumentValueTypeName.BOOLEAN) {
+        envVarValue = envVarValue.length > 0 ? "true" : "false";
+    }
+    return envVarValue;
+}
+function getOptionValuesFromEnvVars(envVarValues, potentialEnvVarNames, env, option, envVarNamePrefix) {
+    if (potentialEnvVarNames.length === 0) {
+        return;
+    }
+    if (option.name === "__proto__" || option.name === "constructor" || option.name === "prototype") {
+        throw new Error(`Unsafe key name in use: ${option.name}, CodeQL Rule ID: js/prototype-polluting-assignment`);
+    }
+    if (option.isArray) {
+        envVarNamePrefix = `${envVarNamePrefix}_`;
+        const matches = potentialEnvVarNames.filter((envVarName) => envVarName.startsWith(envVarNamePrefix));
+        matches.forEach((match) => {
+            const path = match.substring(envVarNamePrefix.length);
+            // either '1' or '1_property...' or 'something_invalid'....
+            let indexString = path;
+            let suffix = "";
+            const indexOf = path.indexOf("_");
+            if (indexOf > -1) {
+                indexString = path.substring(0, indexOf);
+                if (indexOf + 1 < path.length) {
+                    suffix = path.substring(indexOf + 1);
+                }
+            }
+            let index;
+            try {
+                index = parseInt(indexString);
+            }
+            catch {
+                throw new Error(`Unable to parse array index from env var: ${match}`);
+            }
+            if (index !== undefined) {
+                if (index > MAXIMUM_ARGUMENT_ARRAY_SIZE) {
+                    throw new Error(`Maximum array size exceeded: ${index} in env var: ${match}`);
+                }
+                if (envVarValues[option.name] === undefined) {
+                    envVarValues[option.name] = [];
+                }
+                if (suffix.length > 0) {
+                    if (option.type === ComplexValueTypeName.COMPLEX) {
+                        if (envVarValues[option.name][index] ===
+                            undefined) {
+                            envVarValues[option.name][index] = Object.create(null);
+                        }
+                        option.properties.forEach((property) => {
+                            const propertySegment = property.configurationKey || getKeySegment(property.name);
+                            getOptionValuesFromEnvVars(envVarValues[option.name][index], matches, env, property, `${envVarNamePrefix}${index}_${propertySegment}`);
+                        });
+                        if (Object.keys(envVarValues[option.name][index]).length === 0) {
+                            delete envVarValues[option.name][index];
+                        }
+                    }
+                    else {
+                        throw new Error(`Unidentified suffix ${suffix} in env var: ${match}`);
+                    }
+                }
+                else if (option.type === ComplexValueTypeName.COMPLEX) {
+                    throw new Error(`Incomplete argument path in env var: ${match}`);
+                }
+                else {
+                    // set primitive value
+                    let envVarValue = env[match];
+                    if (envVarValue != undefined && option.type === ArgumentValueTypeName.BOOLEAN) {
+                        envVarValue = envVarValue.length > 1 ? "true" : "false";
+                    }
+                    envVarValues[option.name][index] =
+                        envVarValue;
+                }
+                const elements = envVarValues[option.name];
+                for (let i = elements.length - 1; i > -1; i--) {
+                    if (elements[i] === undefined) {
+                        elements.length = i;
+                    }
+                }
+                if (elements.length === 0) {
+                    delete envVarValues[option.name];
+                }
+            }
+        });
+    }
+    else if (option.type === ComplexValueTypeName.COMPLEX) {
+        option.properties.forEach((property) => {
+            if (envVarValues[option.name] === undefined) {
+                envVarValues[option.name] = Object.create(null);
+            }
+            const propertySegment = property.configurationKey || getKeySegment(property.name);
+            getOptionValuesFromEnvVars(envVarValues[option.name], potentialEnvVarNames, env, property, `${envVarNamePrefix}_${propertySegment}`);
+            if (Object.keys(envVarValues[option.name]).length === 0) {
+                delete envVarValues[option.name];
+            }
+        });
+    }
+    else {
+        // simple check for a specific env var name
+        let value = process.env[envVarNamePrefix];
+        if (value === undefined) {
+            return undefined;
+        }
+        if (option.type === ArgumentValueTypeName.BOOLEAN) {
+            value = value.length > 1 ? "true" : "false";
+        }
+        // set primitive value
+        envVarValues[option.name] = value;
+    }
+}
+/**
+ * Get configured argument values for the specified {@link Option} from environment variables.
+ *
+ * @param cliConfig the {@link CLIConfig} to use for determining the default configuration key.
+ * @param command the {@link SubCommand} to use for determining the default configuration key and containing
+ * {@link Positional} and {@link Option} instances to populate values for.
+ */
+export function getSubCommandValuesFromEnvVars(cliConfig, command) {
+    const envVarValues = Object.create(null);
+    if (command.options) {
+        for (const option of command.options) {
+            const potentialEnvVarNames = Object.keys(process.env);
+            const optionPrefix = getSubCommandArgumentKeyPrefix(cliConfig, command, option);
+            getOptionValuesFromEnvVars(envVarValues, potentialEnvVarNames, process.env ?? {}, option, optionPrefix);
+        }
+    }
+    if (command.positionals) {
+        for (const positional of command.positionals) {
+            if (positional.name === "__proto__" ||
+                positional.name === "constructor" ||
+                positional.name === "prototype") {
+                throw new Error(`Unsafe key name in use: ${positional.name}, CodeQL Rule ID: js/prototype-polluting-assignment`);
+            }
+            let envVarNamePrefix = getSubCommandArgumentKeyPrefix(cliConfig, command, positional);
+            if (positional.isVarargMultiple) {
+                envVarNamePrefix = `${envVarNamePrefix}_`;
+                const matches = Object.keys(process.env).filter((envVarName) => envVarName.startsWith(envVarNamePrefix));
+                matches.forEach((match) => {
+                    let index;
+                    try {
+                        index = parseInt(match.substring(envVarNamePrefix.length));
+                    }
+                    catch {
+                        throw new Error(`Unable to parse array index from env var: ${match}`);
+                    }
+                    if (index !== undefined) {
+                        if (index > MAXIMUM_ARGUMENT_ARRAY_SIZE) {
+                            throw new Error(`Maximum array size exceeded: ${index} in env var: ${match}`);
+                        }
+                        if (envVarValues[positional.name] === undefined) {
+                            envVarValues[positional.name] = [];
+                        }
+                        // set primitive value
+                        let envVarValue = process.env[match];
+                        if (envVarValue != undefined && positional.type === ArgumentValueTypeName.BOOLEAN) {
+                            envVarValue = envVarValue.length > 1 ? "true" : "false";
+                        }
+                        envVarValues[positional.name][index] =
+                            envVarValue;
+                    }
+                });
+            }
+            else {
+                // simple check for a specific env var name
+                let value = process.env[envVarNamePrefix];
+                if (value === undefined) {
+                    return undefined;
+                }
+                if (positional.type === ArgumentValueTypeName.BOOLEAN) {
+                    value = value.length > 1 ? "true" : "false";
+                }
+                // set primitive value
+                envVarValues[positional.name] = value;
+            }
+        }
+    }
+    // Check if anything was actually populated
+    if (Object.keys(envVarValues).length === 0) {
+        return undefined;
+    }
+    return envVarValues;
+}

package/dist/src/util/helpHelper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helpHelper.d.ts","sourceRoot":"","sources":["../../../src/util/helpHelper.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,aAAa,MAAM,iCAAiC,CAAC;AAGjE,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,OAAO,MAAM,mBAAmB,CAAC;AAI7C,OAAO,KAAK,qBAAqB,MAAM,yCAAyC,CAAC;AACjF,OAAO,KAAK,YAAY,MAAM,gCAAgC,CAAC;AAM/D,OAAO,KAAK,SAAS,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,cAAc,MAAM,uCAAuC,CAAC;AAGxE,OAAO,KAAK,qBAAqB,MAAM,8CAA8C,CAAC;AAOtF,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CACxC;AAsDD,wBAAsB,iBAAiB,CACrC,cAAc,EAAE,cAAc,EAC9B,qBAAqB,EAAE,qBAAqB,EAC5C,QAAQ,EAAE,KAAK,CAAC,WAAW,CAAC,GAC3B,OAAO,CAAC,IAAI,CAAC,CA2Cf;AA8BD,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,OAAO,EACvB,aAAa,EAAE,aAAa,GAC3B,SAAS,CA6DX;AAED,wBAAgB,4BAA4B,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CA+C3E;AAkLD,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,OAAO,EACvB,UAAU,EAAE,UAAU,EACtB,kBAAkB,EAAE,OAAO,GAC1B,KAAK,CAAC,WAAW,CAAC,CAoBpB;AACD,wBAAgB,8BAA8B,CAC5C,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,OAAO,EAChB,UAAU,EAAE,UAAU,GACrB,KAAK,CAAC,WAAW,CAAC,CAgCpB;AAED,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,OAAO,EAChB,sBAAsB,EAAE,aAAa,CAAC,qBAAqB,CAAC,EAC5D,cAAc,EAAE,aAAa,CAAC,aAAa,CAAC,EAC5C,aAAa,EAAE,aAAa,CAAC,YAAY,CAAC,EAC1C,WAAW,EAAE,aAAa,CAAC,UAAU,CAAC,GACrC,MAAM,CAgJR;AAED,wBAAgB,wBAAwB,CACtC,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,aAAa,CAAC,YAAY,CAAC,EAC1C,WAAW,EAAE,aAAa,CAAC,UAAU,CAAC,GACrC,MAAM,EAAE,CAgBV"}
+{"version":3,"file":"helpHelper.d.ts","sourceRoot":"","sources":["../../../src/util/helpHelper.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,aAAa,MAAM,iCAAiC,CAAC;AAGjE,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,OAAO,MAAM,mBAAmB,CAAC;AAI7C,OAAO,KAAK,qBAAqB,MAAM,yCAAyC,CAAC;AACjF,OAAO,KAAK,YAAY,MAAM,gCAAgC,CAAC;AAM/D,OAAO,KAAK,SAAS,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,cAAc,MAAM,uCAAuC,CAAC;AAGxE,OAAO,KAAK,qBAAqB,MAAM,8CAA8C,CAAC;AAMtF,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CACxC;AAsDD,wBAAsB,iBAAiB,CACrC,cAAc,EAAE,cAAc,EAC9B,qBAAqB,EAAE,qBAAqB,EAC5C,QAAQ,EAAE,KAAK,CAAC,WAAW,CAAC,GAC3B,OAAO,CAAC,IAAI,CAAC,CA2Cf;AA8BD,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,OAAO,EACvB,aAAa,EAAE,aAAa,GAC3B,SAAS,CA6DX;AAED,wBAAgB,4BAA4B,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CA+C3E;AAkLD,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,OAAO,EACvB,UAAU,EAAE,UAAU,EACtB,kBAAkB,EAAE,OAAO,GAC1B,KAAK,CAAC,WAAW,CAAC,CAoBpB;AACD,wBAAgB,8BAA8B,CAC5C,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,OAAO,EAChB,UAAU,EAAE,UAAU,GACrB,KAAK,CAAC,WAAW,CAAC,CAgCpB;AAED,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,OAAO,EAChB,sBAAsB,EAAE,aAAa,CAAC,qBAAqB,CAAC,EAC5D,cAAc,EAAE,aAAa,CAAC,aAAa,CAAC,EAC5C,aAAa,EAAE,aAAa,CAAC,YAAY,CAAC,EAC1C,WAAW,EAAE,aAAa,CAAC,UAAU,CAAC,GACrC,MAAM,CAgJR;AAED,wBAAgB,wBAAwB,CACtC,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,aAAa,CAAC,YAAY,CAAC,EAC1C,WAAW,EAAE,aAAa,CAAC,UAAU,CAAC,GACrC,MAAM,EAAE,CAkBV"}