@mks2508/better-logger 0.14.0-alpha.2 → 0.18.2-alpha.2

package/dist/styling/SmartPresets.d.ts

@@ -1,25 +1,119 @@
 /**
- * @fileoverview Smart presets for simplified logger configuration
+ * @fileoverview Smart presets para configurar el layout del logger.
  */
 import type { LogStyles } from '../types/index.js';
 /**
- * Smart presets that configure the entire log appearance
+ * Catálogo de smart presets que configuran el layout completo de un log.
+ *
+ * A diferencia de {@link THEME_PRESETS} — que solo controla los colores
+ * y emojis del badge del nivel — los smart presets controlan la
+ * composición entera del output: timestamp, badge de nivel, prefix,
+ * mensaje, location, fuentes, padding/spacing y efectos visuales
+ * (blur, transparency). Cada clave es un {@link LogStyles} completo.
+ *
+ * Presets disponibles:
+ *  - `default`       — adaptativo (claro/oscuro según DevTools), legible.
+ *  - `cyberpunk`     — neón, glow, fondo oscuro, location oculta.
+ *  - `glassmorphism` — blur + transparencia, layout spacious.
+ *  - `minimal`       — sin timestamp, sin location, badges flat.
+ *  - `debug`         — monospace, todo visible, compacto para dev.
+ *  - `production`    — solo lo esencial: timestamp + level + mensaje.
+ *
+ * Los presets son ortogonales a los themes: pueden combinarse (por
+ * ejemplo, `theme: 'dark'` + `preset: 'debug'` aplica el layout debug
+ * sobre la paleta oscura).
+ *
+ * @example
+ * ```ts
+ * import logger from '@mks2508/better-logger';
+ *
+ * logger.preset('glassmorphism');
+ * logger.info('Vidrio esmerilado en DevTools');
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Componer: theme custom + preset de layout
+ * logger.configure({ theme: 'dark' });
+ * logger.preset('debug');
+ * logger.warn('Layout debug sobre theme dark');
+ * ```
+ *
+ * @see {@link getSmartPreset} para resolver un preset por nombre.
+ * @see {@link LogStyles} para la shape completa de un preset.
  */
 export declare const SMART_PRESETS: Record<string, LogStyles>;
 /**
- * Get a smart preset by name
+ * Resuelve un smart preset por nombre desde {@link SMART_PRESETS}.
+ *
+ * @param {string} name - Nombre del preset (`'default'`, `'cyberpunk'`,
+ *   `'glassmorphism'`, `'minimal'`, `'debug'`, `'production'`).
+ * @returns {LogStyles | null} El preset encontrado, o `null` si el nombre
+ *   no existe en el catálogo.
+ *
+ * @example
+ * ```ts
+ * import { getSmartPreset } from '@mks2508/better-logger/styles';
+ *
+ * const preset = getSmartPreset('cyberpunk');
+ * if (preset) {
+ *   console.log(preset.level?.style); // 'glowing'
+ * }
+ * ```
+ *
+ * @see {@link hasPreset} para un check booleano sin traer el objeto.
  */
 export declare function getSmartPreset(name: string): LogStyles | null;
 /**
- * List all available smart presets
+ * Lista los nombres de todos los smart presets registrados.
+ *
+ * Útil para alimentar menús de configuración, CLIs o help text.
+ *
+ * @returns {string[]} Array con las claves de {@link SMART_PRESETS}.
+ *
+ * @example
+ * ```ts
+ * import { getAvailablePresets } from '@mks2508/better-logger/styles';
+ *
+ * console.log(getAvailablePresets());
+ * // ['default', 'cyberpunk', 'glassmorphism', 'minimal', 'debug', 'production']
+ * ```
  */
 export declare function getAvailablePresets(): string[];
 /**
- * Check if a preset exists
+ * Comprueba si un smart preset existe en el catálogo.
+ *
+ * @param {string} name - Nombre del preset a verificar.
+ * @returns {boolean} `true` si el preset está registrado, `false` en caso contrario.
+ *
+ * @example
+ * ```ts
+ * import { hasPreset, getSmartPreset } from '@mks2508/better-logger/styles';
+ *
+ * const name = 'glassmorphism';
+ * const preset = hasPreset(name) ? getSmartPreset(name) : null;
+ * ```
+ *
+ * @see {@link getSmartPreset} para resolver el preset (retorna `null` si no existe).
  */
 export declare function hasPreset(name: string): boolean;
 /**
- * Preset descriptions for help/documentation
+ * Descripciones cortas y legibles para humanos de cada smart preset.
+ *
+ * Pensadas para help text, CLI output o UI de selección. Las claves
+ * coinciden con {@link SMART_PRESETS}; los valores son strings de una
+ * línea describiendo el propósito del preset.
+ *
+ * @example
+ * ```ts
+ * import { PRESET_DESCRIPTIONS, getAvailablePresets } from '@mks2508/better-logger/styles';
+ *
+ * for (const name of getAvailablePresets()) {
+ *   console.log(`${name.padEnd(14)} — ${PRESET_DESCRIPTIONS[name]}`);
+ * }
+ * ```
+ *
+ * @see {@link SMART_PRESETS} para los objetos {@link LogStyles} completos.
  */
 export declare const PRESET_DESCRIPTIONS: Record<string, string>;
 //# sourceMappingURL=SmartPresets.d.ts.map

package/dist/styling/SmartPresets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SmartPresets.d.ts","sourceRoot":"","sources":["../../src/styling/SmartPresets.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAa,MAAM,mBAAmB,CAAC;AAE9D;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAqPnD,CAAC;AAEF;;GAEG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAE7D;AAED;;GAEG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,EAAE,CAE9C;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAE/C;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAOtD,CAAC"}
+{"version":3,"file":"SmartPresets.d.ts","sourceRoot":"","sources":["../../src/styling/SmartPresets.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAa,MAAM,mBAAmB,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAqPnD,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAE7D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,EAAE,CAE9C;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAE/C;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAOtD,CAAC"}