@powerlines/core 0.14.5 → 0.15.1

package/dist/plugin-utils/logging.d.cts

@@ -1,4 +1,7 @@
+import { CustomLogger, LogCategory, LogFn, LogFnOptions, LogLevel, LogLevelResolvedConfig, LogLevelUserConfig, LogMeta, Logger, LoggerOptions } from "../types/logging.cjs";
 import { UnresolvedContext } from "../types/context.cjs";
+import { Mode } from "../types/config.cjs";
+
 //#region src/plugin-utils/logging.d.ts
 /**
  * Determines if the provided log level is considered verbose (debug or trace).
@@ -14,6 +17,95 @@ declare function isVerbose(logLevel: string): boolean;
  * @returns True if the log level is "debug" or "trace", false otherwise.
  */
 declare function isVerbose(context: UnresolvedContext): boolean;
+/**
+ * Resolves the log level configuration based on the provided log level and mode, returning a complete LogLevelResolvedConfig object that specifies the log level for each log category.
+ *
+ * @param logLevel - The user-provided log level configuration, which can be a string or an object specifying log levels for each category.
+ * @param mode - The current mode of the application (e.g., "development", "test", "production"), which determines the default log levels.
+ * @returns A LogLevelResolvedConfig object specifying the log level for each log category.
+ */
+declare function resolveLogLevel(logLevel?: LogLevelUserConfig, mode?: Mode): LogLevelResolvedConfig;
+/**
+ * Generate a consistent color based on the input text.
+ *
+ * @param text - The input text to generate the color from.
+ * @return A hexadecimal color string.
+ */
+declare const getTextColor: (text: string) => string;
+/**
+ * Generate a consistent color based on the input text.
+ *
+ * @param text - The input text to generate the color from.
+ * @return A hexadecimal color string.
+ */
+declare const colorText: (text: string) => string;
+/**
+ * Generate a consistent color based on the input text.
+ *
+ * @param text - The input text to generate the color from.
+ * @return A hexadecimal color string.
+ */
+declare const colorBackground: (text: string) => string;
+declare const consoleLog: (meta: LogMeta, ...args: string[]) => void;
+declare function isValidLogLevel(logLevel: LogLevel, type: LogLevel): boolean;
+declare function isValidLogLevelConfig(type: LogLevel, logLevel: LogLevelResolvedConfig, category?: LogCategory): boolean;
+/**
+ * Create a logging function with a specific name and options.
+ *
+ * @param name - The name of the logging function.
+ * @param options - The options to configure the logging function, including the source, command, environment, plugin, log level, custom logger, and colors. These options can be used to customize the appearance and behavior of the log messages generated by the logging function.
+ * @returns A logging function.
+ */
+declare const createLogFn: (name: string, options: LogFnOptions) => LogFn;
+/**
+ * Create a logging function with a specific name and options.
+ *
+ * @param logger - The original logger to wrap with the custom logger.
+ * @param secondaryLogger - The custom logger to use for logging messages, which can be used to override the default logging behavior of the original logger.
+ * @returns A new logger that combines the original logger's options with the custom logger's methods, allowing for customized logging behavior while still maintaining the original logger's configuration.
+ */
+declare const withLogger: (logger: Logger, secondaryLogger: Logger) => Logger;
+/**
+ * Create a logging function with a specific name and options.
+ *
+ * @param logger - The original logger to wrap with the custom logger.
+ * @param logFn - The custom logging function to use for logging messages, which can be used to override the default logging behavior of the original logger.
+ * @returns A new logger that combines the original logger's options with the custom logging function, allowing for customized logging behavior while still maintaining the original logger's configuration.
+ */
+declare const withLogFn: (logger: Logger, logFn: LogFn) => Logger;
+/**
+ * Create a logging function with a specific name and options.
+ *
+ * @param logger - The original logger to wrap with the custom logger.
+ * @param customLogger - The custom logger to use for logging messages, which can be used to override the default logging behavior of the original logger.
+ * @returns A new logger that combines the original logger's options with the custom logger's methods, allowing for customized logging behavior while still maintaining the original logger's configuration.
+ */
+declare const withCustomLogger: (logger: Logger, customLogger: CustomLogger) => Logger;
+declare const consoleLogger: LogFn;
+/**
+ * Create a logging function with a specific name and options.
+ *
+ * @param name - The name of the logging function.
+ * @param options - The options to configure the logging function, including the source, command, environment, plugin, log level, custom logger, and colors. These options can be used to customize the appearance and behavior of the log messages generated by the logging function.
+ * @returns A logging function.
+ */
+declare const createLogger: (name: string | undefined, options: LoggerOptions, callback?: LogFn) => Logger;
+/**
+ * Extend a logging function with a specific name, adding a colored badge to the log output.
+ *
+ * @param logFn - The original logging function to extend.
+ * @param options - The overlay metadata to use for the badge in the log output.
+ * @returns A new logging function that includes the badge in its output.
+ */
+declare const extendLogFn: (logFn: LogFn, options: LogFnOptions) => LogFn;
+/**
+ * Extend a logger with a specific name and options, adding a colored badge to the log output for each log message generated by the logger.
+ *
+ * @param logger - The original logger to extend.
+ * @param options - The options to configure the logging function, including the source, command, environment, plugin, log level, custom logger, and colors. These options can be used to customize the appearance and behavior of the log messages generated by the extended logger.
+ * @returns A new logger that includes the badge in its output for each log message.
+ */
+declare const extendLogger: (logger: Logger, options: LoggerOptions) => Logger;
 //#endregion
-export { isVerbose };
+export { colorBackground, colorText, consoleLog, consoleLogger, createLogFn, createLogger, extendLogFn, extendLogger, getTextColor, isValidLogLevel, isValidLogLevelConfig, isVerbose, resolveLogLevel, withCustomLogger, withLogFn, withLogger };
 //# sourceMappingURL=logging.d.cts.map

package/dist/plugin-utils/logging.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"logging.d.cts","names":[],"sources":["../../src/plugin-utils/logging.ts"],"mappings":";;;;;AA2BA;;;iBAAgB,SAAA,CAAU,QAAA;;AAQ1B;;;;;iBAAgB,SAAA,CAAU,OAAA,EAAS,iBAAA"}
+{"version":3,"file":"logging.d.cts","names":[],"sources":["../../src/plugin-utils/logging.ts"],"mappings":";;;;;;;AA+DA;;;;iBAAgB,SAAA,CAAU,QAAA;AAQ1B;;;;;AAyBA;AAzBA,iBAAgB,SAAA,CAAU,OAAA,EAAS,iBAAA;;;;;;;;iBAyBnB,eAAA,CACd,QAAA,GAAW,kBAAA,EACX,IAAA,GAAO,IAAA,GACN,sBAAA;;;;;;AAkGH;cAAa,YAAA,GAAgB,IAAA;;;;AAiB7B;;;cAAa,SAAA,GAAa,IAAA;;AAY1B;;;;;cAAa,eAAA,GAAmB,IAAA;AAAA,cAMnB,UAAA,GAAc,IAAA,EAAM,OAAA,KAAY,IAAA;AAAA,iBAwC7B,eAAA,CAAgB,QAAA,EAAU,QAAA,EAAU,IAAA,EAAM,QAAA;AAAA,iBAQ1C,qBAAA,CACd,IAAA,EAAM,QAAA,EACN,QAAA,EAAU,sBAAA,EACV,QAAA,GAAU,WAAA;;;;;;AAXZ;;cAuBa,WAAA,GAAe,IAAA,UAAc,OAAA,EAAS,YAAA,KAAe,KAAA;;;;;;;;cAqKrD,UAAA,GAAc,MAAA,EAAQ,MAAA,EAAQ,eAAA,EAAiB,MAAA,KAAS,MAAA;;;;;;;;cAuFxD,SAAA,GAAa,MAAA,EAAQ,MAAA,EAAQ,KAAA,EAAO,KAAA,KAAQ,MAAA;;;;;;;;cAuI5C,gBAAA,GACX,MAAA,EAAQ,MAAA,EACR,YAAA,EAAc,YAAA,KACb,MAAA;AAAA,cAoEU,aAAA,EAAe,KAAA;;;;;;;;cAmBf,YAAA,GACX,IAAA,sBACA,OAAA,EAAS,aAAA,EACT,QAAA,GAAU,KAAA,KACT,MAAA;AA5TH;;;;;;;AAAA,cAmXa,WAAA,GAAe,KAAA,EAAO,KAAA,EAAO,OAAA,EAAS,YAAA,KAAe,KAAA;;;;;;;;cAsBrD,YAAA,GACX,MAAA,EAAQ,MAAA,EACR,OAAA,EAAS,aAAA,KACR,MAAA"}

package/dist/plugin-utils/logging.d.mts

@@ -1,4 +1,7 @@
+import { CustomLogger, LogCategory, LogFn, LogFnOptions, LogLevel, LogLevelResolvedConfig, LogLevelUserConfig, LogMeta, Logger, LoggerOptions } from "../types/logging.mjs";
 import { UnresolvedContext } from "../types/context.mjs";
+import { Mode } from "../types/config.mjs";
+
 //#region src/plugin-utils/logging.d.ts
 /**
  * Determines if the provided log level is considered verbose (debug or trace).
@@ -14,6 +17,95 @@ declare function isVerbose(logLevel: string): boolean;
  * @returns True if the log level is "debug" or "trace", false otherwise.
  */
 declare function isVerbose(context: UnresolvedContext): boolean;
+/**
+ * Resolves the log level configuration based on the provided log level and mode, returning a complete LogLevelResolvedConfig object that specifies the log level for each log category.
+ *
+ * @param logLevel - The user-provided log level configuration, which can be a string or an object specifying log levels for each category.
+ * @param mode - The current mode of the application (e.g., "development", "test", "production"), which determines the default log levels.
+ * @returns A LogLevelResolvedConfig object specifying the log level for each log category.
+ */
+declare function resolveLogLevel(logLevel?: LogLevelUserConfig, mode?: Mode): LogLevelResolvedConfig;
+/**
+ * Generate a consistent color based on the input text.
+ *
+ * @param text - The input text to generate the color from.
+ * @return A hexadecimal color string.
+ */
+declare const getTextColor: (text: string) => string;
+/**
+ * Generate a consistent color based on the input text.
+ *
+ * @param text - The input text to generate the color from.
+ * @return A hexadecimal color string.
+ */
+declare const colorText: (text: string) => string;
+/**
+ * Generate a consistent color based on the input text.
+ *
+ * @param text - The input text to generate the color from.
+ * @return A hexadecimal color string.
+ */
+declare const colorBackground: (text: string) => string;
+declare const consoleLog: (meta: LogMeta, ...args: string[]) => void;
+declare function isValidLogLevel(logLevel: LogLevel, type: LogLevel): boolean;
+declare function isValidLogLevelConfig(type: LogLevel, logLevel: LogLevelResolvedConfig, category?: LogCategory): boolean;
+/**
+ * Create a logging function with a specific name and options.
+ *
+ * @param name - The name of the logging function.
+ * @param options - The options to configure the logging function, including the source, command, environment, plugin, log level, custom logger, and colors. These options can be used to customize the appearance and behavior of the log messages generated by the logging function.
+ * @returns A logging function.
+ */
+declare const createLogFn: (name: string, options: LogFnOptions) => LogFn;
+/**
+ * Create a logging function with a specific name and options.
+ *
+ * @param logger - The original logger to wrap with the custom logger.
+ * @param secondaryLogger - The custom logger to use for logging messages, which can be used to override the default logging behavior of the original logger.
+ * @returns A new logger that combines the original logger's options with the custom logger's methods, allowing for customized logging behavior while still maintaining the original logger's configuration.
+ */
+declare const withLogger: (logger: Logger, secondaryLogger: Logger) => Logger;
+/**
+ * Create a logging function with a specific name and options.
+ *
+ * @param logger - The original logger to wrap with the custom logger.
+ * @param logFn - The custom logging function to use for logging messages, which can be used to override the default logging behavior of the original logger.
+ * @returns A new logger that combines the original logger's options with the custom logging function, allowing for customized logging behavior while still maintaining the original logger's configuration.
+ */
+declare const withLogFn: (logger: Logger, logFn: LogFn) => Logger;
+/**
+ * Create a logging function with a specific name and options.
+ *
+ * @param logger - The original logger to wrap with the custom logger.
+ * @param customLogger - The custom logger to use for logging messages, which can be used to override the default logging behavior of the original logger.
+ * @returns A new logger that combines the original logger's options with the custom logger's methods, allowing for customized logging behavior while still maintaining the original logger's configuration.
+ */
+declare const withCustomLogger: (logger: Logger, customLogger: CustomLogger) => Logger;
+declare const consoleLogger: LogFn;
+/**
+ * Create a logging function with a specific name and options.
+ *
+ * @param name - The name of the logging function.
+ * @param options - The options to configure the logging function, including the source, command, environment, plugin, log level, custom logger, and colors. These options can be used to customize the appearance and behavior of the log messages generated by the logging function.
+ * @returns A logging function.
+ */
+declare const createLogger: (name: string | undefined, options: LoggerOptions, callback?: LogFn) => Logger;
+/**
+ * Extend a logging function with a specific name, adding a colored badge to the log output.
+ *
+ * @param logFn - The original logging function to extend.
+ * @param options - The overlay metadata to use for the badge in the log output.
+ * @returns A new logging function that includes the badge in its output.
+ */
+declare const extendLogFn: (logFn: LogFn, options: LogFnOptions) => LogFn;
+/**
+ * Extend a logger with a specific name and options, adding a colored badge to the log output for each log message generated by the logger.
+ *
+ * @param logger - The original logger to extend.
+ * @param options - The options to configure the logging function, including the source, command, environment, plugin, log level, custom logger, and colors. These options can be used to customize the appearance and behavior of the log messages generated by the extended logger.
+ * @returns A new logger that includes the badge in its output for each log message.
+ */
+declare const extendLogger: (logger: Logger, options: LoggerOptions) => Logger;
 //#endregion
-export { isVerbose };
+export { colorBackground, colorText, consoleLog, consoleLogger, createLogFn, createLogger, extendLogFn, extendLogger, getTextColor, isValidLogLevel, isValidLogLevelConfig, isVerbose, resolveLogLevel, withCustomLogger, withLogFn, withLogger };
 //# sourceMappingURL=logging.d.mts.map

package/dist/plugin-utils/logging.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"logging.d.mts","names":[],"sources":["../../src/plugin-utils/logging.ts"],"mappings":";;;;;AA2BA;;;iBAAgB,SAAA,CAAU,QAAA;;AAQ1B;;;;;iBAAgB,SAAA,CAAU,OAAA,EAAS,iBAAA"}
+{"version":3,"file":"logging.d.mts","names":[],"sources":["../../src/plugin-utils/logging.ts"],"mappings":";;;;;;;AA+DA;;;;iBAAgB,SAAA,CAAU,QAAA;AAQ1B;;;;;AAyBA;AAzBA,iBAAgB,SAAA,CAAU,OAAA,EAAS,iBAAA;;;;;;;;iBAyBnB,eAAA,CACd,QAAA,GAAW,kBAAA,EACX,IAAA,GAAO,IAAA,GACN,sBAAA;;;;;;AAkGH;cAAa,YAAA,GAAgB,IAAA;;;;AAiB7B;;;cAAa,SAAA,GAAa,IAAA;;AAY1B;;;;;cAAa,eAAA,GAAmB,IAAA;AAAA,cAMnB,UAAA,GAAc,IAAA,EAAM,OAAA,KAAY,IAAA;AAAA,iBAwC7B,eAAA,CAAgB,QAAA,EAAU,QAAA,EAAU,IAAA,EAAM,QAAA;AAAA,iBAQ1C,qBAAA,CACd,IAAA,EAAM,QAAA,EACN,QAAA,EAAU,sBAAA,EACV,QAAA,GAAU,WAAA;;;;;;AAXZ;;cAuBa,WAAA,GAAe,IAAA,UAAc,OAAA,EAAS,YAAA,KAAe,KAAA;;;;;;;;cAqKrD,UAAA,GAAc,MAAA,EAAQ,MAAA,EAAQ,eAAA,EAAiB,MAAA,KAAS,MAAA;;;;;;;;cAuFxD,SAAA,GAAa,MAAA,EAAQ,MAAA,EAAQ,KAAA,EAAO,KAAA,KAAQ,MAAA;;;;;;;;cAuI5C,gBAAA,GACX,MAAA,EAAQ,MAAA,EACR,YAAA,EAAc,YAAA,KACb,MAAA;AAAA,cAoEU,aAAA,EAAe,KAAA;;;;;;;;cAmBf,YAAA,GACX,IAAA,sBACA,OAAA,EAAS,aAAA,EACT,QAAA,GAAU,KAAA,KACT,MAAA;AA5TH;;;;;;;AAAA,cAmXa,WAAA,GAAe,KAAA,EAAO,KAAA,EAAO,OAAA,EAAS,YAAA,KAAe,KAAA;;;;;;;;cAsBrD,YAAA,GACX,MAAA,EAAQ,MAAA,EACR,OAAA,EAAS,aAAA,KACR,MAAA"}