@cenk1cenk2/oclif-common 3.1.0-beta.1 → 3.1.0-beta.4

package/dist/index.d.ts

@@ -98,13 +98,20 @@ interface PipeProcessToLoggerOptions {
  */
 declare function pipeProcessToLogger(logger: Logger, instance: ExecaChildProcess, options?: PipeProcessToLoggerOptions): ExecaChildProcess;
 
-interface GlobalConfig {
+interface GlobalConfigInit {
     logLevel: LogLevels;
     ci: boolean;
+    json: boolean;
+}
+interface GlobalConfig extends GlobalConfigInit {
     isVerbose: boolean;
     isDebug: boolean;
     isSilent: boolean;
-    json: boolean;
+}
+interface ConfigIterator {
+    key: (string | number)[];
+    env: string;
+    parser?: string;
 }
 
 declare const color: colorette.Colorette;
@@ -203,9 +210,9 @@ declare class ConfigService implements GlobalConfig {
     private readonly logger;
     constructor(oclif: Command['config'], command: Command['ctor'], config: Omit<GlobalConfig, 'isVerbose' | 'isDebug' | 'isSilent'>);
     read<T extends LockableData = LockableData>(path: string): Promise<T>;
-    extend<T extends LockableData = LockableData>(paths: string[], strategy?: MergeStrategy): Promise<T>;
+    extend<T extends LockableData = LockableData>(paths: (string | Partial<T>)[], strategy?: MergeStrategy): Promise<T>;
     merge<T extends LockableData = LockableData>(configs: Partial<T>[], strategy?: MergeStrategy): T;
-    env<T extends LockableData = LockableData>(definition: string, config: T): Promise<T>;
+    env<T extends LockableData = LockableData>(definition: string | T, config: T): Promise<T>;
     write<T extends LockableData = LockableData>(path: string, data: T): Promise<void>;
     private recalculate;
 }
@@ -275,6 +282,13 @@ interface ConfigCommandSetup<T extends string = string, LockFile = any> {
 declare type InferFlags<T extends typeof Command$1> = InferredFlags<T['globalFlags'] & T['flags']>;
 declare type InferArgs<T extends typeof Command$1> = Record<T['args'][number]['name'], string>;
 
+/**
+ * Makes the object deep partial.
+ */
+declare type DeepPartial<T> = {
+    [P in keyof T]?: DeepPartial<T[P]>;
+};
+
 declare abstract class Command<Ctx extends ListrContext = ListrContext, Flags extends Record<PropertyKey, any> = InferFlags<typeof Command>, Args extends Record<PropertyKey, any> = InferArgs<typeof Command>, Store extends Record<PropertyKey, any> = Record<PropertyKey, any>> extends Command$1 {
     static globalFlags: {
         "log-level": _oclif_core_lib_interfaces.OptionFlag<string>;
@@ -364,4 +378,4 @@ declare const _default: {
     };
 };
 
-export { ClassType, Command, CommonLockerData, ConfigCommand, ConfigCommandChoices, ConfigCommandSetup, ConfigService, FileConstants, FileSystemService, GenericParser, GlobalConfig, HelpGroups, InferArgs, InferFlags, JsonParser, LockData, LockableData, LockerService, LogFieldStatus, LogLevels, Logger, LoggerFormat, LoggerOptions, MergeStrategy, ParserService, PipeProcessToLoggerOptions, SetCtxAssignOptions, SetCtxDefaultsOptions, UnlockData, ValidatorService, ValidatorServiceOptions, Winston, YamlParser, color, _default as default, isDebug, isSilent, isVerbose, merge, pipeProcessThroughListr, pipeProcessToLogger, setCtxAssign, setCtxDefaults, setup };
+export { ClassType, Command, CommonLockerData, ConfigCommand, ConfigCommandChoices, ConfigCommandSetup, ConfigIterator, ConfigService, DeepPartial, FileConstants, FileSystemService, GenericParser, GlobalConfig, GlobalConfigInit, HelpGroups, InferArgs, InferFlags, JsonParser, LockData, LockableData, LockerService, LogFieldStatus, LogLevels, Logger, LoggerFormat, LoggerOptions, MergeStrategy, ParserService, PipeProcessToLoggerOptions, SetCtxAssignOptions, SetCtxDefaultsOptions, UnlockData, ValidatorService, ValidatorServiceOptions, Winston, YamlParser, color, _default as default, isDebug, isSilent, isVerbose, merge, pipeProcessThroughListr, pipeProcessToLogger, setCtxAssign, setCtxDefaults, setup };

package/dist/index.js

@@ -617,11 +617,11 @@ var ConfigService = class {
     return config;
   }
   async extend(paths, strategy = "OVERWRITE" /* OVERWRITE */) {
-    this.logger.trace("Will generate config from: %s with %s", paths.join(", "), strategy);
+    this.logger.trace("Will generate config from: %o with %s", paths, strategy);
     const configs = (await Promise.all(
       paths.map(async (path) => {
         try {
-          const config = await this.parser.read(path);
+          const config = typeof path === "string" ? await this.parser.read(path) : path;
           this.logger.trace("Extending config from: %s", path);
           return config;
         } catch (e) {
@@ -638,8 +638,8 @@ var ConfigService = class {
     return merge(strategy, configs.some((config) => Array.isArray(config)) ? [] : {}, ...configs);
   }
   async env(definition, config) {
-    const env = await this.parser.read(definition);
-    this.logger.trace("Environment variable extensions read: %s", definition);
+    const env = typeof definition === "string" ? await this.parser.read(definition) : definition;
+    this.logger.trace("Environment variable extensions read: %o", definition);
     const iter = /* @__PURE__ */ __name(async (obj, parent) => {
       const data = await Promise.all(
         Object.entries(obj).map(async ([key, value]) => {
@@ -649,10 +649,11 @@ var ConfigService = class {
           } else if (typeof value === "object") {
             const extras = [];
             if ("__element" /* ELEMENT */ in value) {
-              extras.push(await iter(value, [...location, "__element" /* ELEMENT */]));
+              this.logger.trace("Expanding location to elements: %s", location);
+              extras.push(await iter(value["__element" /* ELEMENT */], [...location, "__element" /* ELEMENT */]));
             }
             if ("__name" /* NAME */ in value && "__format" /* PARSER */ in value) {
-              return [
+              const variable = [
                 {
                   key: location,
                   env: value["__name" /* NAME */],
@@ -660,6 +661,7 @@ var ConfigService = class {
                 },
                 ...extras
               ];
+              return variable;
             } else {
               return iter(value, location);
             }
@@ -669,20 +671,23 @@ var ConfigService = class {
       return data.flatMap((d) => d);
     }, "iter");
     const parsed = await iter(env);
+    const cb = /* @__PURE__ */ __name(async (variable, data) => {
+      if (variable.parser) {
+        try {
+          variable = await this.parser.parse(variable.parser, data);
+        } catch (e) {
+          this.logger.trace("Can not parse environment environment variable for config: %s -> %s with %s", variable.key.join("."), variable.env, variable.parser);
+          throw e;
+        }
+      }
+      return import_object_path_immutable.default.update(config, variable.key, () => {
+        this.logger.trace("Overwriting config with environment variable: %s -> %s", variable.key.join("."), variable.env);
+        return variable;
+      });
+    }, "cb");
     await Promise.all(
       parsed.map(async (variable) => {
-        let data = process.env[variable.env];
-        if (!data) {
-          return;
-        }
-        if (variable.parser) {
-          try {
-            data = await this.parser.parse(variable.parser, data);
-          } catch (e) {
-            this.logger.trace("Can not parse environment variable for config: %s -> %s with %s", variable.key.join("."), variable.env, variable.parser);
-            throw e;
-          }
-        }
+        let data;
         if (variable.key.includes("__element" /* ELEMENT */)) {
           const timeout = 6e4;
           const startedAt = Date.now();
@@ -690,24 +695,24 @@ var ConfigService = class {
             if (Date.now() - startedAt > timeout) {
               throw new Error(`Timed-out in ${timeout}ms while looking for element environment variables.`);
             }
-            data = process.env[variable.env.replace("${i}", i.toString())];
+            const clone = JSON.parse(JSON.stringify(variable));
+            clone.env = clone.env.replace("${i}" /* ELEMENT_REPLACER */, i.toString());
+            this.logger.trace("Looking for environment variable element: %o", clone);
+            data = process.env[clone.env];
             if (!data) {
               this.logger.trace("No more variable available: %s -> %d", variable.env, i);
               break;
             }
-            const clone = JSON.parse(JSON.stringify(variable.key));
-            clone[clone.findIndex("__element" /* ELEMENT */)] = i;
-            config = import_object_path_immutable.default.update(config, clone, () => {
-              this.logger.trace("Overwriting config with element environment variable: %s -> %s", clone.join("."), variable.env);
-              return data;
-            });
+            clone.key[clone.key.findIndex((value) => value === "__element" /* ELEMENT */)] = i;
+            config = await cb(clone, data);
           }
-        } else {
-          config = import_object_path_immutable.default.update(config, variable.key, () => {
-            this.logger.trace("Overwriting config with environment variable: %s -> %s", variable.key.join("."), variable.env);
-            return data;
-          });
+          return;
+        }
+        data = process.env[variable.env];
+        if (!data) {
+          return;
         }
+        config = await cb(variable, data);
       })
     );
     return config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cenk1cenk2/oclif-common",
-  "version": "3.1.0-beta.1",
+  "version": "3.1.0-beta.4",
   "description": "Oclif common package for oclif2 projects.",
   "repository": "https://gitlab.kilic.dev/libraries/oclif-tools",
   "author": {