@push.rocks/qenv 5.0.2

package/dist_ts/00_commitinfo_data.d.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export declare const commitinfo: {
+    name: string;
+    version: string;
+    description: string;
+};

package/dist_ts/00_commitinfo_data.js

@@ -0,0 +1,9 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+    name: '@pushrocks/qenv',
+    version: '5.0.2',
+    description: 'easy promised environments'
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSxpQkFBaUI7SUFDdkIsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLDRCQUE0QjtDQUMxQyxDQUFBIn0=

package/dist_ts/index.d.ts

@@ -0,0 +1 @@
+export * from './qenv.classes.qenv.js';

package/dist_ts/index.js

@@ -0,0 +1,2 @@
+export * from './qenv.classes.qenv.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxjQUFjLHdCQUF3QixDQUFDIn0=

package/dist_ts/qenv.classes.qenv.d.ts

@@ -0,0 +1,39 @@
+import * as plugins from './qenv.plugins.js';
+/**
+ * class Qenv
+ * allows to make assertions about the environments while being more flexibel in how to meet them
+ */
+export declare class Qenv {
+    requiredEnvVars: string[];
+    availableEnvVars: string[];
+    missingEnvVars: string[];
+    keyValueObject: {
+        [key: string]: any;
+    };
+    logger: plugins.smartlog.ConsoleLog;
+    qenvFilePathAbsolute: string;
+    envFilePathAbsolute: string;
+    constructor(qenvFileBasePathArg: string, envFileBasePathArg: any, failOnMissing?: boolean);
+    /**
+     * only gets an environment variable if it is required within a read qenv.yml file
+     * @param envVarName
+     */
+    getEnvVarRequired(envVarName: any): string;
+    /**
+     * tries to get any env var even if it is not required
+     * @param wantedEnvVar
+     */
+    getEnvVarOnDemand(wantedEnvVar: string): string;
+    /**
+     * gets the required env values
+     */
+    private getRequiredEnvVars;
+    /**
+     * gets the available env vars
+     */
+    private getAvailableEnvVars;
+    /**
+     * gets missing env vars
+     */
+    private getMissingEnvVars;
+}

package/dist_ts/qenv.classes.qenv.js

@@ -0,0 +1,160 @@
+import * as plugins from './qenv.plugins.js';
+/**
+ * class Qenv
+ * allows to make assertions about the environments while being more flexibel in how to meet them
+ */
+export class Qenv {
+    constructor(qenvFileBasePathArg = process.cwd(), envFileBasePathArg, failOnMissing = true) {
+        this.requiredEnvVars = [];
+        this.availableEnvVars = [];
+        this.missingEnvVars = [];
+        this.keyValueObject = {};
+        this.logger = new plugins.smartlog.ConsoleLog();
+        /**
+         * gets the required env values
+         */
+        this.getRequiredEnvVars = () => {
+            let qenvFile = {};
+            if (plugins.smartfile.fs.fileExistsSync(this.qenvFilePathAbsolute)) {
+                qenvFile = plugins.smartfile.fs.toObjectSync(this.qenvFilePathAbsolute);
+            }
+            if (!qenvFile || !qenvFile.required || !Array.isArray(qenvFile.required)) {
+                this.logger.log('warn', `qenv (promised environment): ./qenv.yml File does not contain a 'required' Array! This might be ok though.`);
+            }
+            else {
+                for (const keyArg of Object.keys(qenvFile.required)) {
+                    this.requiredEnvVars.push(qenvFile.required[keyArg]);
+                }
+            }
+        };
+        /**
+         * gets the available env vars
+         */
+        this.getAvailableEnvVars = () => {
+            for (const requiredEnvVar of this.requiredEnvVars) {
+                const chosenVar = this.getEnvVarOnDemand(requiredEnvVar);
+                if (chosenVar) {
+                    this.availableEnvVars.push(requiredEnvVar);
+                    this.keyValueObject[requiredEnvVar] = chosenVar;
+                }
+            }
+        };
+        /**
+         * gets missing env vars
+         */
+        this.getMissingEnvVars = () => {
+            const missingEnvVars = [];
+            for (const envVar of this.requiredEnvVars) {
+                if (!this.availableEnvVars.includes(envVar)) {
+                    missingEnvVars.push(envVar);
+                }
+            }
+            return missingEnvVars;
+        };
+        // lets make sure paths are absolute
+        this.qenvFilePathAbsolute = plugins.path.join(plugins.path.resolve(qenvFileBasePathArg), 'qenv.yml');
+        this.envFilePathAbsolute = plugins.path.join(plugins.path.resolve(envFileBasePathArg), 'env.json');
+        this.getRequiredEnvVars();
+        this.getAvailableEnvVars();
+        this.missingEnvVars = this.getMissingEnvVars();
+        // handle missing variables
+        if (this.missingEnvVars.length > 0) {
+            console.info('Required Env Vars are:');
+            console.log(this.requiredEnvVars);
+            console.error('However some Env variables could not be resolved:');
+            console.log(this.missingEnvVars);
+            if (failOnMissing) {
+                this.logger.log('error', 'Exiting!');
+                process.exit(1);
+            }
+            else {
+                this.logger.log('warn', 'qenv is not set to fail on missing environment variables');
+            }
+        }
+    }
+    /**
+     * only gets an environment variable if it is required within a read qenv.yml file
+     * @param envVarName
+     */
+    getEnvVarRequired(envVarName) {
+        return this.keyValueObject[envVarName];
+    }
+    /**
+     * tries to get any env var even if it is not required
+     * @param wantedEnvVar
+     */
+    getEnvVarOnDemand(wantedEnvVar) {
+        let envVarFromEnvironmentVariable;
+        let envVarFromEnvJsonFile;
+        let envVarFromDockerSecret;
+        let dockerSecretJson;
+        // env var check
+        if (process.env[wantedEnvVar]) {
+            this.availableEnvVars.push(wantedEnvVar);
+            envVarFromEnvironmentVariable = process.env[wantedEnvVar];
+        }
+        // env file check
+        // lets determine the actual env yml
+        let envJsonFileAsObject;
+        try {
+            envJsonFileAsObject = plugins.smartfile.fs.toObjectSync(this.envFilePathAbsolute);
+        }
+        catch (err) {
+            envJsonFileAsObject = {};
+        }
+        if (envJsonFileAsObject.hasOwnProperty(wantedEnvVar)) {
+            envVarFromEnvJsonFile = envJsonFileAsObject[wantedEnvVar];
+        }
+        // docker secret check
+        if (plugins.smartfile.fs.isDirectory('/run') &&
+            plugins.smartfile.fs.isDirectory('/run/secrets') &&
+            plugins.smartfile.fs.fileExistsSync(`/run/secrets/${wantedEnvVar}`)) {
+            envVarFromDockerSecret = plugins.smartfile.fs.toStringSync(`/run/secrets/${wantedEnvVar}`);
+        }
+        // docker secret.json
+        if (plugins.smartfile.fs.isDirectory('/run') &&
+            plugins.smartfile.fs.isDirectory('/run/secrets')) {
+            const availableSecrets = plugins.smartfile.fs.listAllItemsSync('/run/secrets');
+            for (const secret of availableSecrets) {
+                if (secret.includes('secret.json') && !envVarFromDockerSecret) {
+                    const secretObject = plugins.smartfile.fs.toObjectSync(`/run/secrets/${secret}`);
+                    envVarFromDockerSecret = secretObject[wantedEnvVar];
+                }
+            }
+        }
+        // warn if there is more than one candidate
+        const availableCcandidates = [];
+        [
+            envVarFromEnvironmentVariable,
+            envVarFromEnvJsonFile,
+            envVarFromDockerSecret,
+            dockerSecretJson,
+        ].forEach((candidate) => {
+            if (candidate) {
+                availableCcandidates.push(candidate);
+            }
+        });
+        if (availableCcandidates.length > 1) {
+            this.logger.log('warn', `found multiple candidates for ${wantedEnvVar} Choosing in the order of envVar, envFileVar, dockerSecret, dockerSecretJson`);
+            console.log(availableCcandidates);
+        }
+        switch (true) {
+            case !!envVarFromEnvironmentVariable:
+                this.logger.log('ok', `found ${wantedEnvVar} as environment variable`);
+                return envVarFromEnvironmentVariable;
+            case !!envVarFromEnvJsonFile:
+                this.logger.log('ok', `found ${wantedEnvVar} as env.json variable`);
+                return envVarFromEnvJsonFile;
+            case !!envVarFromDockerSecret:
+                this.logger.log('ok', `found ${wantedEnvVar} as docker secret`);
+                return envVarFromDockerSecret;
+            case !!dockerSecretJson:
+                this.logger.log('ok', `found ${wantedEnvVar} as docker secret.json`);
+                return dockerSecretJson;
+            default:
+                this.logger.log('warn', `could not find the wanted environment variable ${wantedEnvVar} anywhere`);
+                return;
+        }
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicWVudi5jbGFzc2VzLnFlbnYuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9xZW52LmNsYXNzZXMucWVudi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssT0FBTyxNQUFNLG1CQUFtQixDQUFDO0FBRTdDOzs7R0FHRztBQUNILE1BQU0sT0FBTyxJQUFJO0lBV2YsWUFBWSxtQkFBbUIsR0FBRyxPQUFPLENBQUMsR0FBRyxFQUFFLEVBQUUsa0JBQWtCLEVBQUUsYUFBYSxHQUFHLElBQUk7UUFWbEYsb0JBQWUsR0FBYSxFQUFFLENBQUM7UUFDL0IscUJBQWdCLEdBQWEsRUFBRSxDQUFDO1FBQ2hDLG1CQUFjLEdBQWEsRUFBRSxDQUFDO1FBQzlCLG1CQUFjLEdBQTJCLEVBQUUsQ0FBQztRQUM1QyxXQUFNLEdBQUcsSUFBSSxPQUFPLENBQUMsUUFBUSxDQUFDLFVBQVUsRUFBRSxDQUFDO1FBMElsRDs7V0FFRztRQUNLLHVCQUFrQixHQUFHLEdBQUcsRUFBRTtZQUNoQyxJQUFJLFFBQVEsR0FBUSxFQUFFLENBQUM7WUFDdkIsSUFBSSxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxjQUFjLENBQUMsSUFBSSxDQUFDLG9CQUFvQixDQUFDLEVBQUU7Z0JBQ2xFLFFBQVEsR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxZQUFZLENBQUMsSUFBSSxDQUFDLG9CQUFvQixDQUFDLENBQUM7YUFDekU7WUFDRCxJQUFJLENBQUMsUUFBUSxJQUFJLENBQUMsUUFBUSxDQUFDLFFBQVEsSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsUUFBUSxDQUFDLFFBQVEsQ0FBQyxFQUFFO2dCQUN4RSxJQUFJLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FDYixNQUFNLEVBQ04sNEdBQTRHLENBQzdHLENBQUM7YUFDSDtpQkFBTTtnQkFDTCxLQUFLLE1BQU0sTUFBTSxJQUFJLE1BQU0sQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLFFBQVEsQ0FBQyxFQUFFO29CQUNuRCxJQUFJLENBQUMsZUFBZSxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUM7aUJBQ3REO2FBQ0Y7UUFDSCxDQUFDLENBQUM7UUFFRjs7V0FFRztRQUNLLHdCQUFtQixHQUFHLEdBQUcsRUFBRTtZQUNqQyxLQUFLLE1BQU0sY0FBYyxJQUFJLElBQUksQ0FBQyxlQUFlLEVBQUU7Z0JBQ2pELE1BQU0sU0FBUyxHQUFHLElBQUksQ0FBQyxpQkFBaUIsQ0FBQyxjQUFjLENBQUMsQ0FBQztnQkFDekQsSUFBSSxTQUFTLEVBQUU7b0JBQ2IsSUFBSSxDQUFDLGdCQUFnQixDQUFDLElBQUksQ0FBQyxjQUFjLENBQUMsQ0FBQztvQkFDM0MsSUFBSSxDQUFDLGNBQWMsQ0FBQyxjQUFjLENBQUMsR0FBRyxTQUFTLENBQUM7aUJBQ2pEO2FBQ0Y7UUFDSCxDQUFDLENBQUM7UUFFRjs7V0FFRztRQUNLLHNCQUFpQixHQUFHLEdBQWEsRUFBRTtZQUN6QyxNQUFNLGNBQWMsR0FBYSxFQUFFLENBQUM7WUFDcEMsS0FBSyxNQUFNLE1BQU0sSUFBSSxJQUFJLENBQUMsZUFBZSxFQUFFO2dCQUN6QyxJQUFJLENBQUMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsRUFBRTtvQkFDM0MsY0FBYyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQztpQkFDN0I7YUFDRjtZQUNELE9BQU8sY0FBYyxDQUFDO1FBQ3hCLENBQUMsQ0FBQztRQS9LQSxvQ0FBb0M7UUFDcEMsSUFBSSxDQUFDLG9CQUFvQixHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUMzQyxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxtQkFBbUIsQ0FBQyxFQUN6QyxVQUFVLENBQ1gsQ0FBQztRQUNGLElBQUksQ0FBQyxtQkFBbUIsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FDMUMsT0FBTyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsa0JBQWtCLENBQUMsRUFDeEMsVUFBVSxDQUNYLENBQUM7UUFFRixJQUFJLENBQUMsa0JBQWtCLEVBQUUsQ0FBQztRQUMxQixJQUFJLENBQUMsbUJBQW1CLEVBQUUsQ0FBQztRQUUzQixJQUFJLENBQUMsY0FBYyxHQUFHLElBQUksQ0FBQyxpQkFBaUIsRUFBRSxDQUFDO1FBRS9DLDJCQUEyQjtRQUMzQixJQUFJLElBQUksQ0FBQyxjQUFjLENBQUMsTUFBTSxHQUFHLENBQUMsRUFBRTtZQUNsQyxPQUFPLENBQUMsSUFBSSxDQUFDLHdCQUF3QixDQUFDLENBQUM7WUFDdkMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLENBQUM7WUFDbEMsT0FBTyxDQUFDLEtBQUssQ0FBQyxtREFBbUQsQ0FBQyxDQUFDO1lBQ25FLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxDQUFDO1lBQ2pDLElBQUksYUFBYSxFQUFFO2dCQUNqQixJQUFJLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxPQUFPLEVBQUUsVUFBVSxDQUFDLENBQUM7Z0JBQ3JDLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUM7YUFDakI7aUJBQU07Z0JBQ0wsSUFBSSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsTUFBTSxFQUFFLDBEQUEwRCxDQUFDLENBQUM7YUFDckY7U0FDRjtJQUNILENBQUM7SUFFRDs7O09BR0c7SUFDSSxpQkFBaUIsQ0FBQyxVQUFVO1FBQ2pDLE9BQU8sSUFBSSxDQUFDLGNBQWMsQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUN6QyxDQUFDO0lBRUQ7OztPQUdHO0lBQ0ksaUJBQWlCLENBQUMsWUFBb0I7UUFDM0MsSUFBSSw2QkFBcUMsQ0FBQztRQUMxQyxJQUFJLHFCQUE2QixDQUFDO1FBQ2xDLElBQUksc0JBQThCLENBQUM7UUFDbkMsSUFBSSxnQkFBd0IsQ0FBQztRQUU3QixnQkFBZ0I7UUFDaEIsSUFBSSxPQUFPLENBQUMsR0FBRyxDQUFDLFlBQVksQ0FBQyxFQUFFO1lBQzdCLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDLENBQUM7WUFDekMsNkJBQTZCLEdBQUcsT0FBTyxDQUFDLEdBQUcsQ0FBQyxZQUFZLENBQUMsQ0FBQztTQUMzRDtRQUVELGlCQUFpQjtRQUNqQixvQ0FBb0M7UUFDcEMsSUFBSSxtQkFBbUIsQ0FBQztRQUN4QixJQUFJO1lBQ0YsbUJBQW1CLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsWUFBWSxDQUFDLElBQUksQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDO1NBQ25GO1FBQUMsT0FBTyxHQUFHLEVBQUU7WUFDWixtQkFBbUIsR0FBRyxFQUFFLENBQUM7U0FDMUI7UUFDRCxJQUFJLG1CQUFtQixDQUFDLGNBQWMsQ0FBQyxZQUFZLENBQUMsRUFBRTtZQUNwRCxxQkFBcUIsR0FBRyxtQkFBbUIsQ0FBQyxZQUFZLENBQUMsQ0FBQztTQUMzRDtRQUVELHNCQUFzQjtRQUN0QixJQUNFLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUM7WUFDeEMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsV0FBVyxDQUFDLGNBQWMsQ0FBQztZQUNoRCxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxjQUFjLENBQUMsZ0JBQWdCLFlBQVksRUFBRSxDQUFDLEVBQ25FO1lBQ0Esc0JBQXNCLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsWUFBWSxDQUFDLGdCQUFnQixZQUFZLEVBQUUsQ0FBQyxDQUFDO1NBQzVGO1FBRUQscUJBQXFCO1FBQ3JCLElBQ0UsT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQztZQUN4QyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxXQUFXLENBQUMsY0FBYyxDQUFDLEVBQ2hEO1lBQ0EsTUFBTSxnQkFBZ0IsR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxnQkFBZ0IsQ0FBQyxjQUFjLENBQUMsQ0FBQztZQUMvRSxLQUFLLE1BQU0sTUFBTSxJQUFJLGdCQUFnQixFQUFFO2dCQUNyQyxJQUFJLE1BQU0sQ0FBQyxRQUFRLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxzQkFBc0IsRUFBRTtvQkFDN0QsTUFBTSxZQUFZLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsWUFBWSxDQUFDLGdCQUFnQixNQUFNLEVBQUUsQ0FBQyxDQUFDO29CQUNqRixzQkFBc0IsR0FBRyxZQUFZLENBQUMsWUFBWSxDQUFDLENBQUM7aUJBQ3JEO2FBQ0Y7U0FDRjtRQUVELDJDQUEyQztRQUMzQyxNQUFNLG9CQUFvQixHQUFVLEVBQUUsQ0FBQztRQUN2QztZQUNFLDZCQUE2QjtZQUM3QixxQkFBcUI7WUFDckIsc0JBQXNCO1lBQ3RCLGdCQUFnQjtTQUNqQixDQUFDLE9BQU8sQ0FBQyxDQUFDLFNBQVMsRUFBRSxFQUFFO1lBQ3RCLElBQUksU0FBUyxFQUFFO2dCQUNiLG9CQUFvQixDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsQ0FBQzthQUN0QztRQUNILENBQUMsQ0FBQyxDQUFDO1FBQ0gsSUFBSSxvQkFBb0IsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFO1lBQ25DLElBQUksQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUNiLE1BQU0sRUFDTixpQ0FBaUMsWUFBWSw4RUFBOEUsQ0FDNUgsQ0FBQztZQUNGLE9BQU8sQ0FBQyxHQUFHLENBQUMsb0JBQW9CLENBQUMsQ0FBQztTQUNuQztRQUVELFFBQVEsSUFBSSxFQUFFO1lBQ1osS0FBSyxDQUFDLENBQUMsNkJBQTZCO2dCQUNsQyxJQUFJLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsU0FBUyxZQUFZLDBCQUEwQixDQUFDLENBQUM7Z0JBQ3ZFLE9BQU8sNkJBQTZCLENBQUM7WUFDdkMsS0FBSyxDQUFDLENBQUMscUJBQXFCO2dCQUMxQixJQUFJLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsU0FBUyxZQUFZLHVCQUF1QixDQUFDLENBQUM7Z0JBQ3BFLE9BQU8scUJBQXFCLENBQUM7WUFDL0IsS0FBSyxDQUFDLENBQUMsc0JBQXNCO2dCQUMzQixJQUFJLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsU0FBUyxZQUFZLG1CQUFtQixDQUFDLENBQUM7Z0JBQ2hFLE9BQU8sc0JBQXNCLENBQUM7WUFDaEMsS0FBSyxDQUFDLENBQUMsZ0JBQWdCO2dCQUNyQixJQUFJLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsU0FBUyxZQUFZLHdCQUF3QixDQUFDLENBQUM7Z0JBQ3JFLE9BQU8sZ0JBQWdCLENBQUM7WUFDMUI7Z0JBQ0UsSUFBSSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQ2IsTUFBTSxFQUNOLGtEQUFrRCxZQUFZLFdBQVcsQ0FDMUUsQ0FBQztnQkFDRixPQUFPO1NBQ1Y7SUFDSCxDQUFDO0NBK0NGIn0=

package/dist_ts/qenv.plugins.d.ts

@@ -0,0 +1,5 @@
+import * as path from 'path';
+export { path };
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartlog from '@pushrocks/smartlog';
+export { smartfile, smartlog };

package/dist_ts/qenv.plugins.js

@@ -0,0 +1,8 @@
+// native
+import * as path from 'path';
+export { path };
+// @pushrocks scope
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartlog from '@pushrocks/smartlog';
+export { smartfile, smartlog };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicWVudi5wbHVnaW5zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvcWVudi5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLFNBQVM7QUFDVCxPQUFPLEtBQUssSUFBSSxNQUFNLE1BQU0sQ0FBQztBQUU3QixPQUFPLEVBQUUsSUFBSSxFQUFFLENBQUM7QUFFaEIsbUJBQW1CO0FBQ25CLE9BQU8sS0FBSyxTQUFTLE1BQU0sc0JBQXNCLENBQUM7QUFDbEQsT0FBTyxLQUFLLFFBQVEsTUFBTSxxQkFBcUIsQ0FBQztBQUVoRCxPQUFPLEVBQUUsU0FBUyxFQUFFLFFBQVEsRUFBRSxDQUFDIn0=

package/npmextra.json

@@ -0,0 +1,17 @@
+{
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "qenv",
+      "description": "easy promised environments",
+      "npmPackagename": "@pushrocks/qenv",
+      "license": "MIT"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@push.rocks/qenv",
+  "version": "5.0.2",
+  "private": false,
+  "description": "easy promised environments",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "test": "(tstest test/)",
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "tsdoc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@gitlab.com/pushrocks/qenv.git"
+  },
+  "keywords": [
+    "environment",
+    "git",
+    "ci"
+  ],
+  "author": "Lossless GmbH",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://gitlab.com/pushrocks/qenv/issues"
+  },
+  "homepage": "https://gitlab.com/pushrocks/qenv#README",
+  "devDependencies": {
+    "@gitzone/tsbuild": "^2.1.63",
+    "@gitzone/tsrun": "^1.2.37",
+    "@gitzone/tstest": "^1.0.72",
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^18.6.3"
+  },
+  "dependencies": {
+    "@pushrocks/smartfile": "^10.0.4",
+    "@pushrocks/smartlog": "^3.0.1",
+    "@pushrocks/smartpath": "^5.0.5"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
+}

package/readme.md

@@ -0,0 +1,54 @@
+# @pushrocks/qenv
+easy promised environments
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/qenv)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/qenv)
+* [github.com (source mirror)](https://github.com/pushrocks/qenv)
+* [docs (typedoc)](https://pushrocks.gitlab.io/qenv/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/qenv/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/qenv/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/qenv)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/qenv)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/qenv)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/qenv)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/qenv)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
+
+## Usage
+
+Use TypeScript for best in class instellisense.
+
+qenv works with two files:
+
+- **qenv.yml** - specifies which ENV vars are required.
+- **env.yml** - specifies all env vars that are not already set in the current environment.
+
+Now obviously you can set build specific env vars in many CI environments.
+So there we do not need an **env.yml** since all ENV vars are in place
+However when on another machine you can have a env.yml that will be added to the environment by qenv.
+
+```javascript
+import { Qenv } from 'qenv';
+
+const myQenv = new Qenv('path/to/dir/where/qenv.yml/is/', 'path/to/dir/where/env.yml/is(');
+```
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

package/ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/qenv',
+  version: '5.0.2',
+  description: 'easy promised environments'
+}

package/ts/index.ts

@@ -0,0 +1 @@
+export * from './qenv.classes.qenv.js';

package/ts/qenv.classes.qenv.ts

@@ -0,0 +1,195 @@
+import * as plugins from './qenv.plugins.js';
+
+/**
+ * class Qenv
+ * allows to make assertions about the environments while being more flexibel in how to meet them
+ */
+export class Qenv {
+  public requiredEnvVars: string[] = [];
+  public availableEnvVars: string[] = [];
+  public missingEnvVars: string[] = [];
+  public keyValueObject: { [key: string]: any } = {};
+  public logger = new plugins.smartlog.ConsoleLog();
+
+  // filePaths
+  public qenvFilePathAbsolute: string;
+  public envFilePathAbsolute: string;
+
+  constructor(qenvFileBasePathArg = process.cwd(), envFileBasePathArg, failOnMissing = true) {
+    // lets make sure paths are absolute
+    this.qenvFilePathAbsolute = plugins.path.join(
+      plugins.path.resolve(qenvFileBasePathArg),
+      'qenv.yml'
+    );
+    this.envFilePathAbsolute = plugins.path.join(
+      plugins.path.resolve(envFileBasePathArg),
+      'env.json'
+    );
+
+    this.getRequiredEnvVars();
+    this.getAvailableEnvVars();
+
+    this.missingEnvVars = this.getMissingEnvVars();
+
+    // handle missing variables
+    if (this.missingEnvVars.length > 0) {
+      console.info('Required Env Vars are:');
+      console.log(this.requiredEnvVars);
+      console.error('However some Env variables could not be resolved:');
+      console.log(this.missingEnvVars);
+      if (failOnMissing) {
+        this.logger.log('error', 'Exiting!');
+        process.exit(1);
+      } else {
+        this.logger.log('warn', 'qenv is not set to fail on missing environment variables');
+      }
+    }
+  }
+
+  /**
+   * only gets an environment variable if it is required within a read qenv.yml file
+   * @param envVarName
+   */
+  public getEnvVarRequired(envVarName): string {
+    return this.keyValueObject[envVarName];
+  }
+
+  /**
+   * tries to get any env var even if it is not required
+   * @param wantedEnvVar
+   */
+  public getEnvVarOnDemand(wantedEnvVar: string): string {
+    let envVarFromEnvironmentVariable: string;
+    let envVarFromEnvJsonFile: string;
+    let envVarFromDockerSecret: string;
+    let dockerSecretJson: string;
+
+    // env var check
+    if (process.env[wantedEnvVar]) {
+      this.availableEnvVars.push(wantedEnvVar);
+      envVarFromEnvironmentVariable = process.env[wantedEnvVar];
+    }
+
+    // env file check
+    // lets determine the actual env yml
+    let envJsonFileAsObject;
+    try {
+      envJsonFileAsObject = plugins.smartfile.fs.toObjectSync(this.envFilePathAbsolute);
+    } catch (err) {
+      envJsonFileAsObject = {};
+    }
+    if (envJsonFileAsObject.hasOwnProperty(wantedEnvVar)) {
+      envVarFromEnvJsonFile = envJsonFileAsObject[wantedEnvVar];
+    }
+
+    // docker secret check
+    if (
+      plugins.smartfile.fs.isDirectory('/run') &&
+      plugins.smartfile.fs.isDirectory('/run/secrets') &&
+      plugins.smartfile.fs.fileExistsSync(`/run/secrets/${wantedEnvVar}`)
+    ) {
+      envVarFromDockerSecret = plugins.smartfile.fs.toStringSync(`/run/secrets/${wantedEnvVar}`);
+    }
+
+    // docker secret.json
+    if (
+      plugins.smartfile.fs.isDirectory('/run') &&
+      plugins.smartfile.fs.isDirectory('/run/secrets')
+    ) {
+      const availableSecrets = plugins.smartfile.fs.listAllItemsSync('/run/secrets');
+      for (const secret of availableSecrets) {
+        if (secret.includes('secret.json') && !envVarFromDockerSecret) {
+          const secretObject = plugins.smartfile.fs.toObjectSync(`/run/secrets/${secret}`);
+          envVarFromDockerSecret = secretObject[wantedEnvVar];
+        }
+      }
+    }
+
+    // warn if there is more than one candidate
+    const availableCcandidates: any[] = [];
+    [
+      envVarFromEnvironmentVariable,
+      envVarFromEnvJsonFile,
+      envVarFromDockerSecret,
+      dockerSecretJson,
+    ].forEach((candidate) => {
+      if (candidate) {
+        availableCcandidates.push(candidate);
+      }
+    });
+    if (availableCcandidates.length > 1) {
+      this.logger.log(
+        'warn',
+        `found multiple candidates for ${wantedEnvVar} Choosing in the order of envVar, envFileVar, dockerSecret, dockerSecretJson`
+      );
+      console.log(availableCcandidates);
+    }
+
+    switch (true) {
+      case !!envVarFromEnvironmentVariable:
+        this.logger.log('ok', `found ${wantedEnvVar} as environment variable`);
+        return envVarFromEnvironmentVariable;
+      case !!envVarFromEnvJsonFile:
+        this.logger.log('ok', `found ${wantedEnvVar} as env.json variable`);
+        return envVarFromEnvJsonFile;
+      case !!envVarFromDockerSecret:
+        this.logger.log('ok', `found ${wantedEnvVar} as docker secret`);
+        return envVarFromDockerSecret;
+      case !!dockerSecretJson:
+        this.logger.log('ok', `found ${wantedEnvVar} as docker secret.json`);
+        return dockerSecretJson;
+      default:
+        this.logger.log(
+          'warn',
+          `could not find the wanted environment variable ${wantedEnvVar} anywhere`
+        );
+        return;
+    }
+  }
+
+  /**
+   * gets the required env values
+   */
+  private getRequiredEnvVars = () => {
+    let qenvFile: any = {};
+    if (plugins.smartfile.fs.fileExistsSync(this.qenvFilePathAbsolute)) {
+      qenvFile = plugins.smartfile.fs.toObjectSync(this.qenvFilePathAbsolute);
+    }
+    if (!qenvFile || !qenvFile.required || !Array.isArray(qenvFile.required)) {
+      this.logger.log(
+        'warn',
+        `qenv (promised environment): ./qenv.yml File does not contain a 'required' Array! This might be ok though.`
+      );
+    } else {
+      for (const keyArg of Object.keys(qenvFile.required)) {
+        this.requiredEnvVars.push(qenvFile.required[keyArg]);
+      }
+    }
+  };
+
+  /**
+   * gets the available env vars
+   */
+  private getAvailableEnvVars = () => {
+    for (const requiredEnvVar of this.requiredEnvVars) {
+      const chosenVar = this.getEnvVarOnDemand(requiredEnvVar);
+      if (chosenVar) {
+        this.availableEnvVars.push(requiredEnvVar);
+        this.keyValueObject[requiredEnvVar] = chosenVar;
+      }
+    }
+  };
+
+  /**
+   * gets missing env vars
+   */
+  private getMissingEnvVars = (): string[] => {
+    const missingEnvVars: string[] = [];
+    for (const envVar of this.requiredEnvVars) {
+      if (!this.availableEnvVars.includes(envVar)) {
+        missingEnvVars.push(envVar);
+      }
+    }
+    return missingEnvVars;
+  };
+}

package/ts/qenv.plugins.ts

@@ -0,0 +1,10 @@
+// native
+import * as path from 'path';
+
+export { path };
+
+// @pushrocks scope
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartlog from '@pushrocks/smartlog';
+
+export { smartfile, smartlog };