@powerlines/core 0.15.0 → 0.15.1

package/dist/plugin-utils/logging.cjs

@@ -1,6 +1,18 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_runtime = require('../_virtual/_rolldown/runtime.cjs');
+const require_constants_environments = require('../constants/environments.cjs');
+const require_constants_log_level = require('../constants/log-level.cjs');
+let _stryke_string_format_kebab_case = require("@stryke/string-format/kebab-case");
+let _stryke_type_checks_is_set_object = require("@stryke/type-checks/is-set-object");
+let defu = require("defu");
+let _storm_software_config_tools_logger = require("@storm-software/config-tools/logger");
+let _storm_software_config_tools_utilities_colors = require("@storm-software/config-tools/utilities/colors");
+let _stryke_string_format_title_case = require("@stryke/string-format/title-case");
+let _stryke_type_checks_is_set_string = require("@stryke/type-checks/is-set-string");
 let _stryke_type_checks_is_string = require("@stryke/type-checks/is-string");
+let _stryke_unique_id_uuid = require("@stryke/unique-id/uuid");
+let chalk = require("chalk");
+chalk = require_runtime.__toESM(chalk, 1);
 
 //#region src/plugin-utils/logging.ts
 /**
@@ -13,6 +25,581 @@ function isVerbose(logLevelOrContext) {
 	const level = (0, _stryke_type_checks_is_string.isString)(logLevelOrContext) ? logLevelOrContext : logLevelOrContext.config.logLevel;
 	return level === "debug" || level === "trace";
 }
+/**
+* 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.
+*/
+function resolveLogLevel(logLevel, mode) {
+	if (logLevel === "trace") return {
+		general: "trace",
+		fs: "trace",
+		performance: "trace",
+		communication: "trace",
+		plugins: "trace",
+		hooks: "trace",
+		env: "trace",
+		rpc: "trace",
+		config: "trace",
+		babel: "trace"
+	};
+	else if (logLevel === "silent") return {
+		general: "silent",
+		fs: "silent",
+		performance: "silent",
+		communication: "silent",
+		plugins: "silent",
+		hooks: "silent",
+		env: "silent",
+		rpc: "silent",
+		config: "silent",
+		babel: "silent"
+	};
+	let defaultLogLevel;
+	if (mode === "development") defaultLogLevel = require_constants_log_level.DEFAULT_DEVELOPMENT_LOG_LEVEL;
+	else if (mode === "test") defaultLogLevel = require_constants_log_level.DEFAULT_TEST_LOG_LEVEL;
+	else defaultLogLevel = require_constants_log_level.DEFAULT_PRODUCTION_LOG_LEVEL;
+	if ((0, _stryke_type_checks_is_set_string.isSetString)(logLevel)) return {
+		general: logLevel,
+		fs: defaultLogLevel.fs,
+		performance: logLevel,
+		communication: defaultLogLevel.communication,
+		plugins: logLevel,
+		hooks: logLevel,
+		env: defaultLogLevel.env,
+		rpc: defaultLogLevel.rpc,
+		config: defaultLogLevel.config,
+		babel: logLevel
+	};
+	else if ((0, _stryke_type_checks_is_set_object.isSetObject)(logLevel)) {
+		if (Object.values(logLevel).filter((level) => (0, _stryke_type_checks_is_set_string.isSetString)(level)).length === require_constants_log_level.LOG_CATEGORIES_ARRAY.length) return logLevel;
+		return (0, defu.defu)(logLevel, defaultLogLevel);
+	}
+	return defaultLogLevel;
+}
+const BADGE_COLORS = [
+	"#00A0DD",
+	"#6FCE4E",
+	"#FBBF24",
+	"#F43F5E",
+	"#3B82F6",
+	"#A855F7",
+	"#469592",
+	"#288EDF",
+	"#D8B4FE",
+	"#10B981",
+	"#EF4444",
+	"#F0EC56",
+	"#F472B6",
+	"#22D3EE",
+	"#EAB308",
+	"#84CC16",
+	"#F87171",
+	"#0EA5E9",
+	"#D946EF",
+	"#FACC15",
+	"#34D399",
+	"#8B5CF6"
+];
+const BRAND_COLOR = (0, _storm_software_config_tools_utilities_colors.getColor)("brand");
+/**
+* Generate a consistent color based on the input text.
+*
+* @param text - The input text to generate the color from.
+* @return A hexadecimal color string.
+*/
+const getTextColor = (text) => {
+	return BADGE_COLORS[text.split("").map((char) => char.charCodeAt(0)).reduce((ret, charCode) => ret + charCode, 0) % BADGE_COLORS.length] || BADGE_COLORS[0];
+};
+/**
+* Generate a consistent color based on the input text.
+*
+* @param text - The input text to generate the color from.
+* @return A hexadecimal color string.
+*/
+const colorText = (text) => {
+	const title = (0, _stryke_string_format_title_case.titleCase)(text);
+	return chalk.default.hex(getTextColor(title))(title);
+};
+/**
+* Generate a consistent color based on the input text.
+*
+* @param text - The input text to generate the color from.
+* @return A hexadecimal color string.
+*/
+const colorBackground = (text) => {
+	const title = (0, _stryke_string_format_title_case.titleCase)(text);
+	return chalk.default.inverse.hex(getTextColor(title))(` ${title} `);
+};
+const consoleLog = (meta, ...args) => (0, _storm_software_config_tools_logger.getLogFn)((0, _storm_software_config_tools_logger.getLogLevel)(meta.category === require_constants_log_level.LogCategories.PERFORMANCE ? "performance" : meta.type), { logLevel: "all" })(`${meta.name ? chalk.default.bold.hex(BRAND_COLOR)((0, _stryke_string_format_kebab_case.kebabCase)(meta.name)) : ""}${meta.name ? chalk.default.grey(" > ") : ""}${meta.command ? `${chalk.default.bold.hex(BRAND_COLOR)((0, _stryke_string_format_kebab_case.kebabCase)(meta.command))}${chalk.default.grey(" > ")}` : ""}${meta.environment && (0, _stryke_string_format_kebab_case.kebabCase)(meta.environment) !== "default" ? `${chalk.default.bold.hex(BRAND_COLOR)((0, _stryke_string_format_kebab_case.kebabCase)(meta.environment))}${chalk.default.grey(" > ")}` : ""}${meta.plugin ? `${chalk.default.bold.hex(BRAND_COLOR)(meta.plugin)}${chalk.default.grey(" > ")}` : ""}${meta.source ? `${chalk.default.bold.hex(BRAND_COLOR)((0, _stryke_string_format_kebab_case.kebabCase)(meta.source))}${chalk.default.grey(" > ")}` : ""}${meta.category && meta.category !== require_constants_log_level.LogCategories.GENERAL && meta.category !== require_constants_log_level.LogCategories.PERFORMANCE ? `${colorBackground((0, _stryke_string_format_kebab_case.kebabCase)(meta.category))} ` : ""}${args.join(" ")} `.trim());
+function isValidLogLevel(logLevel, type) {
+	if (logLevel === require_constants_log_level.LogLevels.SILENT) return false;
+	return require_constants_log_level.LOG_LEVELS.indexOf(logLevel) >= require_constants_log_level.LOG_LEVELS.indexOf(type);
+}
+function isValidLogLevelConfig(type, logLevel, category = require_constants_log_level.LogCategories.GENERAL) {
+	return isValidLogLevel(logLevel[category], type);
+}
+/**
+* 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.
+*/
+const createLogFn = (name, options) => {
+	const logLevel = resolveLogLevel(options.logLevel, options.mode);
+	return (meta, ...args) => {
+		const logMeta = (0, _stryke_type_checks_is_set_object.isSetObject)(meta) ? {
+			logId: (0, _stryke_unique_id_uuid.uuid)(),
+			timestamp: Date.now(),
+			category: require_constants_log_level.LogCategories.GENERAL,
+			...options,
+			...meta,
+			name
+		} : {
+			logId: (0, _stryke_unique_id_uuid.uuid)(),
+			timestamp: Date.now(),
+			category: require_constants_log_level.LogCategories.GENERAL,
+			...options,
+			type: meta,
+			name
+		};
+		if (logMeta.$$ipc || isValidLogLevelConfig(logMeta.type, logLevel, logMeta.category ? logMeta.category : require_constants_log_level.LogCategories.GENERAL)) consoleLog(logMeta, ...args);
+	};
+};
+const validateLogger = (type, name, options, callback) => {
+	const logLevel = resolveLogLevel(options.logLevel, options.mode);
+	return (message) => {
+		const params = (0, _stryke_type_checks_is_set_string.isSetString)(message) ? {
+			name,
+			plugin: options.plugin,
+			meta: {
+				type,
+				name,
+				category: require_constants_log_level.LogCategories.GENERAL,
+				logId: (0, _stryke_unique_id_uuid.uuid)(),
+				timestamp: Date.now(),
+				...options
+			},
+			message
+		} : message instanceof Error || message.error ? {
+			name,
+			plugin: options.plugin,
+			message: `${(message instanceof Error ? message : message.error)?.message ? (message instanceof Error ? message : message.error)?.name ? `[${message.name}]: ${message.message}` : message.message : JSON.stringify(message)}${(message instanceof Error ? message : message.error)?.stack ? `
+Stack Trace: ${message.stack}` : ""}`,
+			meta: {
+				type,
+				name,
+				category: require_constants_log_level.LogCategories.GENERAL,
+				logId: (0, _stryke_unique_id_uuid.uuid)(),
+				timestamp: Date.now(),
+				...options
+			}
+		} : {
+			name,
+			plugin: options.plugin,
+			...message,
+			meta: {
+				type,
+				name,
+				category: require_constants_log_level.LogCategories.GENERAL,
+				logId: (0, _stryke_unique_id_uuid.uuid)(),
+				timestamp: Date.now(),
+				plugin: message.plugin,
+				...options,
+				...message.meta
+			}
+		};
+		if (params.meta.$$ipc || isValidLogLevelConfig(type, logLevel, params.meta.category)) callback(params);
+	};
+};
+const validateCustomLogger = (type, name, options, callback, customCallback) => {
+	const logLevel = resolveLogLevel(options.logLevel, options.mode);
+	return (message) => {
+		const params = (0, _stryke_type_checks_is_set_string.isSetString)(message) ? {
+			name,
+			plugin: options.plugin,
+			meta: {
+				category: require_constants_log_level.LogCategories.GENERAL,
+				...options,
+				type,
+				name,
+				logId: (0, _stryke_unique_id_uuid.uuid)(),
+				timestamp: Date.now()
+			},
+			message
+		} : {
+			name,
+			plugin: options.plugin,
+			...message,
+			meta: {
+				category: require_constants_log_level.LogCategories.GENERAL,
+				...options,
+				type,
+				name,
+				logId: (0, _stryke_unique_id_uuid.uuid)(),
+				timestamp: Date.now(),
+				plugin: message.plugin,
+				...message.meta
+			}
+		};
+		if (params.meta.$$ipc || isValidLogLevelConfig(type, logLevel, params.meta.category)) {
+			callback?.(params);
+			customCallback?.(params);
+		}
+	};
+};
+/**
+* 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.
+*/
+const withLogger = (logger, secondaryLogger) => {
+	const options = {
+		...secondaryLogger.options,
+		...logger.options
+	};
+	const result = {
+		options,
+		error: validateLogger("error", options.name, options, (message) => {
+			logger.error?.(message);
+			secondaryLogger.error?.(message);
+		}),
+		warn: validateLogger("warn", options.name, options, (message) => {
+			logger.warn?.(message);
+			secondaryLogger.warn?.(message);
+		}),
+		info: validateLogger("info", options.name, options, (message) => {
+			logger.info?.(message);
+			secondaryLogger.info?.(message);
+		}),
+		debug: validateLogger("debug", options.name, options, (message) => {
+			logger.debug?.(message);
+			secondaryLogger.debug?.(message);
+		}),
+		trace: validateLogger("trace", options.name, options, (message) => {
+			logger.trace?.(message);
+			secondaryLogger.trace?.(message);
+		})
+	};
+	result.log = (type, message) => {
+		switch (type) {
+			case "error":
+				result.error(message);
+				break;
+			case "warn":
+				result.warn(message);
+				break;
+			case "info":
+				result.info(message);
+				break;
+			case "debug":
+				result.debug(message);
+				break;
+			case "trace":
+				result.trace(message);
+				break;
+			case "silent": break;
+			default:
+				result.info(message);
+				break;
+		}
+	};
+	return result;
+};
+/**
+* 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.
+*/
+const withLogFn = (logger, logFn) => {
+	const result = {
+		options: logger.options,
+		error: validateLogger("error", logger.options.name, logger.options, (msg) => {
+			logger.error?.(msg);
+			logFn({
+				category: require_constants_log_level.LogCategories.GENERAL,
+				...logger.options,
+				type: "error",
+				logId: (0, _stryke_unique_id_uuid.uuid)(),
+				timestamp: Date.now(),
+				...msg.meta
+			}, msg.message);
+		}),
+		warn: validateLogger("warn", logger.options.name, logger.options, (msg) => {
+			logger.warn?.(msg);
+			logFn({
+				category: require_constants_log_level.LogCategories.GENERAL,
+				...logger.options,
+				type: "warn",
+				logId: (0, _stryke_unique_id_uuid.uuid)(),
+				timestamp: Date.now(),
+				...msg.meta
+			}, msg.message);
+		}),
+		info: validateLogger("info", logger.options.name, logger.options, (msg) => {
+			logger.info?.(msg);
+			logFn({
+				category: require_constants_log_level.LogCategories.GENERAL,
+				...logger.options,
+				type: "info",
+				logId: (0, _stryke_unique_id_uuid.uuid)(),
+				timestamp: Date.now(),
+				...msg.meta
+			}, msg.message);
+		}),
+		debug: validateLogger("debug", logger.options.name, logger.options, (msg) => {
+			logger.debug?.(msg);
+			logFn({
+				category: require_constants_log_level.LogCategories.GENERAL,
+				...logger.options,
+				type: "debug",
+				logId: (0, _stryke_unique_id_uuid.uuid)(),
+				timestamp: Date.now(),
+				...msg.meta
+			}, msg.message);
+		}),
+		trace: validateLogger("trace", logger.options.name, logger.options, (msg) => {
+			logger.trace?.(msg);
+			logFn({
+				category: require_constants_log_level.LogCategories.GENERAL,
+				...logger.options,
+				type: "trace",
+				logId: (0, _stryke_unique_id_uuid.uuid)(),
+				timestamp: Date.now(),
+				...msg.meta
+			}, msg.message);
+		})
+	};
+	result.log = (type, message) => {
+		switch (type) {
+			case "error":
+				result.error(message);
+				break;
+			case "warn":
+				result.warn(message);
+				break;
+			case "info":
+				result.info(message);
+				break;
+			case "debug":
+				result.debug(message);
+				break;
+			case "trace":
+				result.trace(message);
+				break;
+			case "silent": break;
+			default:
+				result.info(message);
+				break;
+		}
+	};
+	return result;
+};
+/**
+* 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.
+*/
+const withCustomLogger = (logger, customLogger) => {
+	const result = {
+		options: logger.options,
+		error: validateCustomLogger("error", logger.options.name, logger.options, logger.error.bind(logger), customLogger.error?.bind(customLogger)),
+		warn: validateCustomLogger("warn", logger.options.name, logger.options, logger.warn.bind(logger), customLogger.warn?.bind(customLogger)),
+		info: validateCustomLogger("info", logger.options.name, logger.options, logger.info.bind(logger), customLogger.info?.bind(customLogger)),
+		debug: validateCustomLogger("debug", logger.options.name, logger.options, logger.debug.bind(logger), customLogger.debug?.bind(customLogger)),
+		trace: validateCustomLogger("trace", logger.options.name, logger.options, logger.trace.bind(logger), customLogger.trace?.bind(customLogger))
+	};
+	result.log = (type, message) => {
+		switch (type) {
+			case "error":
+				result.error(message);
+				break;
+			case "warn":
+				result.warn(message);
+				break;
+			case "info":
+				result.info(message);
+				break;
+			case "debug":
+				result.debug(message);
+				break;
+			case "trace":
+				result.trace(message);
+				break;
+			case "silent": break;
+			default:
+				result.info(message);
+				break;
+		}
+	};
+	return result;
+};
+const consoleLogger = (meta, message) => consoleLog({
+	type: (0, _stryke_type_checks_is_set_string.isSetString)(meta) ? meta : meta.type,
+	category: require_constants_log_level.LogCategories.GENERAL,
+	logId: (0, _stryke_unique_id_uuid.uuid)(),
+	timestamp: Date.now(),
+	...(0, _stryke_type_checks_is_set_object.isSetObject)(meta) ? meta : {}
+}, message);
+/**
+* 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.
+*/
+const createLogger = (name, options, callback = consoleLogger) => {
+	const result = {
+		options: {
+			name,
+			...options
+		},
+		error: validateLogger("error", name, {
+			name,
+			...options
+		}, (data) => callback({
+			...data.meta,
+			type: "error"
+		}, data.message)),
+		warn: validateLogger("warn", name, {
+			name,
+			...options
+		}, (data) => callback({
+			...data.meta,
+			type: "warn"
+		}, data.message)),
+		info: validateLogger("info", name, {
+			name,
+			...options
+		}, (data) => callback({
+			...data.meta,
+			type: "info"
+		}, data.message)),
+		debug: validateLogger("debug", name, {
+			name,
+			...options
+		}, (data) => callback({
+			...data.meta,
+			type: "debug"
+		}, data.message)),
+		trace: validateLogger("trace", name, {
+			name,
+			...options
+		}, (data) => callback({
+			...data.meta,
+			type: "trace"
+		}, data.message))
+	};
+	result.log = (type, message) => {
+		switch (type) {
+			case "error":
+				result.error(message);
+				break;
+			case "warn":
+				result.warn(message);
+				break;
+			case "info":
+				result.info(message);
+				break;
+			case "debug":
+				result.debug(message);
+				break;
+			case "trace":
+				result.trace(message);
+				break;
+			case "silent": break;
+			default:
+				result.info(message);
+				break;
+		}
+	};
+	return result;
+};
+/**
+* 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.
+*/
+const extendLogFn = (logFn, options) => {
+	return (meta, ...args) => options.source || options.category ? logFn((0, _stryke_type_checks_is_set_object.isSetObject)(meta) ? {
+		...options,
+		...meta
+	} : {
+		...options,
+		type: meta
+	}, `${colorBackground(String(options.source || options.category))} ${args.filter(Boolean).map((arg) => String(arg).trim()).join(" ")} `) : logFn(meta, ...args);
+};
+/**
+* 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.
+*/
+const extendLogger = (logger, options) => {
+	const opts = {
+		...logger.options,
+		...options
+	};
+	const result = {
+		options: opts,
+		error: validateLogger("error", opts.name, opts, logger.error.bind(logger)),
+		warn: validateLogger("warn", opts.name, opts, logger.warn.bind(logger)),
+		info: validateLogger("info", opts.name, opts, logger.info.bind(logger)),
+		debug: validateLogger("debug", opts.name, opts, logger.debug.bind(logger)),
+		trace: validateLogger("trace", opts.name, opts, logger.trace.bind(logger))
+	};
+	result.log = (type, message) => {
+		switch (type) {
+			case "error":
+				result.error(message);
+				break;
+			case "warn":
+				result.warn(message);
+				break;
+			case "info":
+				result.info(message);
+				break;
+			case "debug":
+				result.debug(message);
+				break;
+			case "trace":
+				result.trace(message);
+				break;
+			case "silent": break;
+			default:
+				result.info(message);
+				break;
+		}
+	};
+	return result;
+};
 
 //#endregion
-exports.isVerbose = isVerbose;
+exports.colorBackground = colorBackground;
+exports.colorText = colorText;
+exports.consoleLog = consoleLog;
+exports.consoleLogger = consoleLogger;
+exports.createLogFn = createLogFn;
+exports.createLogger = createLogger;
+exports.extendLogFn = extendLogFn;
+exports.extendLogger = extendLogger;
+exports.getTextColor = getTextColor;
+exports.isValidLogLevel = isValidLogLevel;
+exports.isValidLogLevelConfig = isValidLogLevelConfig;
+exports.isVerbose = isVerbose;
+exports.resolveLogLevel = resolveLogLevel;
+exports.withCustomLogger = withCustomLogger;
+exports.withLogFn = withLogFn;
+exports.withLogger = withLogger;