@tmlmobilidade/logger 20260616.2252.19 → 20260617.1703.12

package/dist/index.d.ts

@@ -1,82 +1,2 @@
-interface LoggerColumn {
-    /**
-     * Column alignment.
-     */
-    a?: 'left' | 'right';
-    /**
-     * Column width.
-     */
-    c?: number;
-    /**
-     * Column text.
-     */
-    t: number | string;
-}
-type LoggerMessage = (LoggerColumn | string)[] | string;
-declare class LoggersClass {
-    /**
-     * Loggers a divider line in the console.
-     * @param message Optional message to display.
-     * @param size Width of the divider line. Default is `75`.
-     */
-    divider(message?: string, size?: number): void;
-    /**
-     * Loggers an error message in the console.
-     * @param message Error message to display.
-     * @param error Optional error object to display.
-     * @param spacesAfter Optional number of blank lines to add after the message.
-     * @param spacesBefore Optional number of blank lines to add before the message.
-     */
-    error(message: LoggerMessage, error?: Error, spacesAfter?: number, spacesBefore?: number): void;
-    /**
-     * Loggers an informational message in the console.
-     * @param message Informational message to display.
-     * @param spacesAfter Optional number of blank lines to add after the message.
-     * @param spacesBefore Optional number of blank lines to add before the message.
-     */
-    info(message: LoggerMessage, spacesAfter?: number, spacesBefore?: number): void;
-    /**
-     * Initial message for program startup.
-     */
-    init(): void;
-    /**
-     * Loggers a progress message in the console.
-     * @param message Progress message to display.
-     * @param spacesAfter Optional number of blank lines to add after the message.
-     * @param spacesBefore Optional number of blank lines to add before the message.
-     */
-    progress(message: LoggerMessage, spacesAfter?: number, spacesBefore?: number): void;
-    /**
-     * Loggers a spacer line in the console.
-     * @param lines Number of blank lines to add. Default is `1`.
-     */
-    spacer(lines?: number): void;
-    /**
-     * Loggers a success message in the console.
-     * @param message Success message to display.
-     * @param spacesAfter Optional number of blank lines to add after the message.
-     * @param spacesBefore Optional number of blank lines to add before the message.
-     */
-    success(message: LoggerMessage, spacesAfter?: number, spacesBefore?: number): void;
-    /**
-     * Loggers a termination message in the console.
-     * @param message Termination message to display.
-     */
-    terminate(message: string): void;
-    /**
-     * Loggers a title message in the console.
-     * @param message Title message to display.
-     */
-    title(message: string): void;
-    /**
-     * Formats an array of log columns or strings into a single string.
-     * @param columns Array of log columns or strings to format.
-     * @returns Formatted string.
-     */
-    private formatColumns;
-}
-/**
- * Logger class for structured logging.
- */
-export declare const Logger: LoggersClass;
-export {};
+export * from './logger/index.js';
+export * from './sentry/index.js';

package/dist/index.js

@@ -1,145 +1,2 @@
-/* * */
-/* * */
-class LoggersClass {
-    //
-    /**
-     * Loggers a divider line in the console.
-     * @param message Optional message to display.
-     * @param size Width of the divider line. Default is `75`.
-     */
-    divider(message, size = 75) {
-        console.log();
-        if (message)
-            console.log(`- ${message} ${'-'.repeat(size - 2 - message.length < 1 ? 1 : size - 2 - message.length)}`);
-        else
-            console.log('-'.repeat(size));
-        console.log();
-    }
-    /**
-     * Loggers an error message in the console.
-     * @param message Error message to display.
-     * @param error Optional error object to display.
-     * @param spacesAfter Optional number of blank lines to add after the message.
-     * @param spacesBefore Optional number of blank lines to add before the message.
-     */
-    error(message, error, spacesAfter, spacesBefore) {
-        if (spacesBefore && spacesBefore > 0)
-            this.spacer(spacesBefore);
-        if (Array.isArray(message))
-            console.error(`✘ ${this.formatColumns(message)}`, error ?? '');
-        else
-            console.error(`✘ ${message}`, error ?? '');
-        if (spacesAfter && spacesAfter > 0)
-            this.spacer(spacesAfter);
-    }
-    /**
-     * Loggers an informational message in the console.
-     * @param message Informational message to display.
-     * @param spacesAfter Optional number of blank lines to add after the message.
-     * @param spacesBefore Optional number of blank lines to add before the message.
-     */
-    info(message, spacesAfter, spacesBefore) {
-        if (spacesBefore && spacesBefore > 0)
-            this.spacer(spacesBefore);
-        if (Array.isArray(message))
-            console.log(`→ ${this.formatColumns(message)}`);
-        else
-            console.log(`→ ${message}`);
-        if (spacesAfter && spacesAfter > 0)
-            this.spacer(spacesAfter);
-    }
-    /**
-     * Initial message for program startup.
-     */
-    init() {
-        const currentDate = new Date().toISOString();
-        console.log();
-        console.log('-'.repeat(currentDate.length));
-        console.log(currentDate);
-        console.log('-'.repeat(currentDate.length));
-        console.log();
-    }
-    /**
-     * Loggers a progress message in the console.
-     * @param message Progress message to display.
-     * @param spacesAfter Optional number of blank lines to add after the message.
-     * @param spacesBefore Optional number of blank lines to add before the message.
-     */
-    progress(message, spacesAfter, spacesBefore) {
-        if (spacesBefore && spacesBefore > 0)
-            this.spacer(spacesBefore);
-        if (Array.isArray(message))
-            console.log(`• ${this.formatColumns(message)}`);
-        else
-            console.log(`• ${message}`);
-        if (spacesAfter && spacesAfter > 0)
-            this.spacer(spacesAfter);
-    }
-    /**
-     * Loggers a spacer line in the console.
-     * @param lines Number of blank lines to add. Default is `1`.
-     */
-    spacer(lines = 1) {
-        for (let i = 0; i < lines; i++) {
-            console.log();
-        }
-    }
-    /**
-     * Loggers a success message in the console.
-     * @param message Success message to display.
-     * @param spacesAfter Optional number of blank lines to add after the message.
-     * @param spacesBefore Optional number of blank lines to add before the message.
-     */
-    success(message, spacesAfter, spacesBefore) {
-        if (spacesBefore && spacesBefore > 0)
-            this.spacer(spacesBefore);
-        if (Array.isArray(message))
-            console.log(`✓ ${this.formatColumns(message)}`);
-        else
-            console.log(`✓ ${message}`);
-        if (spacesAfter && spacesAfter > 0)
-            this.spacer(spacesAfter);
-    }
-    /**
-     * Loggers a termination message in the console.
-     * @param message Termination message to display.
-     */
-    terminate(message) {
-        console.log();
-        console.log('-'.repeat(message.length));
-        console.log(message);
-        console.log('-'.repeat(message.length));
-        console.log();
-    }
-    /**
-     * Loggers a title message in the console.
-     * @param message Title message to display.
-     */
-    title(message) {
-        console.log();
-        console.log(`▶︎ ${message}`);
-        console.log();
-    }
-    /**
-     * Formats an array of log columns or strings into a single string.
-     * @param columns Array of log columns or strings to format.
-     * @returns Formatted string.
-     */
-    formatColumns(columns) {
-        return columns
-            .map((item) => {
-            if (typeof item === 'string')
-                return item;
-            if (!item.c)
-                return String(item.t);
-            if (item.a === 'right')
-                return String(item.t).padStart(item.c);
-            return String(item.t).padEnd(item.c);
-        })
-            .join('');
-    }
-}
-/**
- * Logger class for structured logging.
- */
-export const Logger = new LoggersClass();
+export * from './logger/index.js';
+export * from './sentry/index.js';

package/dist/logger/index.d.ts

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

package/dist/logger/index.js

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

package/dist/logger/interface/globalIssue.d.ts

@@ -0,0 +1,25 @@
+export type GlobalIssueLevel = 'debug' | 'error' | 'fatal' | 'info' | 'warning';
+export interface GlobalIssueRequestContext {
+    me?: {
+        email?: string;
+    };
+    method?: string;
+    routeOptions?: {
+        url?: string;
+    };
+    url?: string;
+}
+export interface GlobalIssueContext {
+    [key: string]: unknown;
+    action?: string;
+    email?: string;
+    error?: Error;
+    feature?: string;
+    level?: GlobalIssueLevel;
+    message?: string;
+    request?: GlobalIssueRequestContext;
+    service?: string;
+    status?: number;
+    value?: unknown;
+}
+export declare function globalIssue(context: GlobalIssueContext): void;

package/dist/logger/interface/globalIssue.js

@@ -0,0 +1,59 @@
+import * as Sentry from '@sentry/core';
+export function globalIssue(context) {
+    //
+    //
+    // Normalize the request context
+    const requestContext = context.request;
+    const routeUrl = requestContext?.routeOptions?.url;
+    const requestUrl = requestContext?.url;
+    const requestMethod = context.request?.method;
+    const requestEmail = context.email ?? requestContext?.me?.email;
+    const normalizedLevel = context.level ?? 'info';
+    const normalizedMessage = context.message ?? context.error?.message ?? 'Unknown issue';
+    const normalizedValueTag = context.value === undefined || context.value === null
+        ? undefined
+        : typeof context.value === 'string'
+            ? context.value
+            : JSON.stringify(context.value);
+    const errorStatusCode = context.error?.statusCode;
+    const statusCode = context.status ?? (typeof errorStatusCode === 'number'
+        ? Number(errorStatusCode)
+        : undefined);
+    //
+    // Create the sentry context
+    const sentryContext = {
+        ...context,
+        extra: {
+            ...context,
+            email: requestEmail,
+            endpoint: routeUrl ?? context.request?.url,
+            message: normalizedMessage,
+            method: requestMethod,
+            path: routeUrl ?? requestUrl,
+            request: requestUrl,
+            value: context.value,
+        },
+        level: normalizedLevel,
+        tags: {
+            action: context.action,
+            email: context.email,
+            feature: context.feature,
+            level: normalizedLevel,
+            method: requestMethod,
+            path: routeUrl ?? requestUrl,
+            request: requestUrl,
+            status: statusCode,
+            value: normalizedValueTag,
+        },
+    };
+    //
+    // Capture the issue
+    if (normalizedLevel === 'error' || normalizedLevel === 'fatal' || context.error) {
+        Sentry.captureException(context.error ?? new Error(normalizedMessage), sentryContext);
+        return;
+    }
+    //
+    // Capture the message
+    Sentry.captureMessage(normalizedMessage, sentryContext);
+}
+;

package/dist/logger/interface/index.d.ts

@@ -0,0 +1,3 @@
+export * from './globalIssue.js';
+export * from './logs-nextjs.js';
+export * from './logs-node.js';

package/dist/logger/interface/index.js

@@ -0,0 +1,3 @@
+export * from './globalIssue.js';
+export * from './logs-nextjs.js';
+export * from './logs-node.js';

package/dist/logger/interface/logs-nextjs.d.ts

@@ -0,0 +1,9 @@
+export interface LogsNextjsContext {
+    [key: string]: unknown;
+    app: string;
+    message: string;
+    module: string;
+    severity?: string;
+    status?: string;
+}
+export declare function startLogsNextjs(context: LogsNextjsContext): void;

package/dist/logger/interface/logs-nextjs.js

@@ -0,0 +1,41 @@
+import * as Sentry from '@sentry/nextjs';
+/* * */
+export function startLogsNextjs(context) {
+    const locationData = normalizeLocationContext();
+    const payload = {
+        ...context,
+        ...locationData,
+        app: context.app,
+        message: context.message,
+        module: context.module,
+        severity: normalizeSeverity(context.severity),
+        status: context.status,
+    };
+    const level = normalizeSeverity(context.severity);
+    if (level === 'debug') {
+        Sentry.logger.debug(context.message, payload);
+        return;
+    }
+    if (level === 'warn') {
+        Sentry.logger.warn(context.message, payload);
+        return;
+    }
+    if (level === 'error') {
+        Sentry.logger.error(context.message, payload);
+        return;
+    }
+    Sentry.logger.info(context.message, payload);
+    Sentry.getGlobalScope().setAttributes({ app: context.app, module: context.module });
+}
+;
+function normalizeSeverity(severity) {
+    if (severity === 'debug' || severity === 'error' || severity === 'warn')
+        return severity;
+    return 'info';
+}
+function normalizeLocationContext() {
+    if (!('window' in globalThis))
+        return {};
+    const pathname = globalThis.window.location.pathname;
+    return { pathname };
+}

package/dist/logger/interface/logs-node.d.ts

@@ -0,0 +1,12 @@
+export interface LogsNodeContext {
+    [key: string]: unknown;
+    app: string;
+    message: string;
+    method?: string;
+    module: string;
+    path?: string;
+    reqId?: string;
+    severity?: string;
+    status?: string;
+}
+export declare function startNodeLogs(context: LogsNodeContext): void;

package/dist/logger/interface/logs-node.js

@@ -0,0 +1,44 @@
+import * as Sentry from '@sentry/node';
+/* * */
+export function startNodeLogs(context) {
+    const requestData = normalizeRequestContext(context.request);
+    const payload = {
+        ...context,
+        ...requestData,
+        severity: normalizeSeverity(context.severity),
+    };
+    const level = normalizeSeverity(context.severity);
+    if (level === 'debug') {
+        Sentry.logger.debug(context.message, payload);
+        return;
+    }
+    if (level === 'warn') {
+        Sentry.logger.warn(context.message, payload);
+        return;
+    }
+    if (level === 'error') {
+        Sentry.logger.error(context.message, payload);
+        return;
+    }
+    Sentry.logger.info(context.message, payload);
+    Sentry.getGlobalScope().setAttributes({ app: context.app, module: context.module });
+}
+;
+function normalizeSeverity(severity) {
+    if (severity === 'debug' || severity === 'error' || severity === 'warn')
+        return severity;
+    return 'info';
+}
+function normalizeRequestContext(request) {
+    if (!request || typeof request !== 'object')
+        return {};
+    const maybeRequest = request;
+    const method = typeof maybeRequest.method === 'string' ? maybeRequest.method : undefined;
+    const requestUrl = typeof maybeRequest.url === 'string' ? maybeRequest.url : undefined;
+    const routeUrl = typeof maybeRequest.routeOptions?.url === 'string' ? maybeRequest.routeOptions.url : undefined;
+    return {
+        ...(routeUrl || requestUrl ? { endpoint: routeUrl ?? requestUrl } : {}),
+        ...(method ? { method } : {}),
+        ...(requestUrl ? { request: requestUrl } : {}),
+    };
+}

package/dist/logger/logger.d.ts

@@ -0,0 +1,28 @@
+import { divider } from './logs/divider.js';
+import { error } from './logs/error.js';
+import { info } from './logs/info.js';
+import { init } from './logs/init.js';
+import { issue } from './logs/issue.js';
+import { progress } from './logs/progress.js';
+import { spacer } from './logs/spacer.js';
+import { startLogsNextjs } from './logs/start-logs-nextjs.js';
+import { startNodeLogs } from './logs/start-node-logs.js';
+import { success } from './logs/success.js';
+import { terminate } from './logs/terminate.js';
+import { title } from './logs/title.js';
+declare class LoggerClass {
+    divider: typeof divider;
+    error: typeof error;
+    info: typeof info;
+    init: typeof init;
+    issue: typeof issue;
+    progress: typeof progress;
+    spacer: typeof spacer;
+    startLogsNextjs: typeof startLogsNextjs;
+    startNodeLogs: typeof startNodeLogs;
+    success: typeof success;
+    terminate: typeof terminate;
+    title: typeof title;
+}
+export declare const Logger: LoggerClass;
+export {};

package/dist/logger/logger.js

@@ -0,0 +1,31 @@
+/* * */
+import { divider } from './logs/divider.js';
+import { error } from './logs/error.js';
+import { info } from './logs/info.js';
+import { init } from './logs/init.js';
+import { issue } from './logs/issue.js';
+import { progress } from './logs/progress.js';
+import { spacer } from './logs/spacer.js';
+import { startLogsNextjs } from './logs/start-logs-nextjs.js';
+import { startNodeLogs } from './logs/start-node-logs.js';
+import { success } from './logs/success.js';
+import { terminate } from './logs/terminate.js';
+import { title } from './logs/title.js';
+/* * */
+class LoggerClass {
+    //
+    divider = divider;
+    error = error;
+    info = info;
+    init = init;
+    issue = issue;
+    progress = progress;
+    spacer = spacer;
+    startLogsNextjs = startLogsNextjs;
+    startNodeLogs = startNodeLogs;
+    success = success;
+    terminate = terminate;
+    title = title;
+}
+/* * */
+export const Logger = new LoggerClass();

package/dist/logger/logs/divider.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Logs a divider line to visually separate sections in the console output.
+ *
+ * If a message is provided, it will be placed after an initial hyphen and padded with additional hyphens up to `size`.
+ * For example: divider("Section", 20) will print something like:
+ *
+ *
+ * - Section -----------
+ *
+ * @param message Optional message to display within the divider.
+ * @param size Total length of the divider line. Defaults to 75.
+ */
+export declare function divider(message?: string, size?: number): void;

package/dist/logger/logs/divider.js

@@ -0,0 +1,24 @@
+/**
+ * Logs a divider line to visually separate sections in the console output.
+ *
+ * If a message is provided, it will be placed after an initial hyphen and padded with additional hyphens up to `size`.
+ * For example: divider("Section", 20) will print something like:
+ *
+ *
+ * - Section -----------
+ *
+ * @param message Optional message to display within the divider.
+ * @param size Total length of the divider line. Defaults to 75.
+ */
+export function divider(message, size = 75) {
+    console.log();
+    if (message) {
+        // Calculate the available space for hyphens after the message and account for hyphens and spaces
+        const hyphenCount = size - 2 - message.length;
+        console.log(`- ${message} ${'-'.repeat(hyphenCount < 1 ? 1 : hyphenCount)}`);
+    }
+    else {
+        console.log('-'.repeat(size));
+    }
+    console.log();
+}

package/dist/logger/logs/error.d.ts

@@ -0,0 +1,22 @@
+import { type LoggerErrorInputContext, type LoggerMessage } from '../types/types.js';
+interface ErrorArgs {
+    contextOrErrorOrSpacesAfter?: LoggerErrorInputContext | number | string;
+    error?: Error;
+    message?: LoggerMessage;
+    spacesAfterOrBefore?: number;
+    spacesBefore?: number;
+}
+/**
+ * Logs an error message to the console, with flexible arguments and formatting.
+ *
+ * @param message The error or message to log. Can be an Error object or a LoggerMessage.
+ * @param contextOrErrorOrSpacesAfter Optional. Can be one of:
+ *   - Error: Use as the error instance.
+ *   - LoggerErrorInputContext: Pass additional context (optionally with silentConsole).
+ *   - number: Number of spaces after the log line.
+ *   - string: Additional message context.
+ * @param spacesAfterOrBefore Optional. Number of spaces after or before depending on previous arg.
+ * @param spacesBefore Optional. Number of blank lines before the log.
+ */
+export declare function error(args: ErrorArgs): void;
+export {};

package/dist/logger/logs/error.js

@@ -0,0 +1,57 @@
+/* * */
+import { formatMessage } from './format-message.js';
+import { spacer } from './spacer.js';
+/**
+ * Logs an error message to the console, with flexible arguments and formatting.
+ *
+ * @param message The error or message to log. Can be an Error object or a LoggerMessage.
+ * @param contextOrErrorOrSpacesAfter Optional. Can be one of:
+ *   - Error: Use as the error instance.
+ *   - LoggerErrorInputContext: Pass additional context (optionally with silentConsole).
+ *   - number: Number of spaces after the log line.
+ *   - string: Additional message context.
+ * @param spacesAfterOrBefore Optional. Number of spaces after or before depending on previous arg.
+ * @param spacesBefore Optional. Number of blank lines before the log.
+ */
+export function error(args) {
+    //
+    let context;
+    let parsedError;
+    let spacesAfter;
+    let normalizedSpacesBefore;
+    // Determine context and error instance based on argument types
+    if (typeof args.contextOrErrorOrSpacesAfter === 'object' && args.contextOrErrorOrSpacesAfter !== null && !(args.contextOrErrorOrSpacesAfter instanceof Error)) {
+        context = args.contextOrErrorOrSpacesAfter;
+    }
+    else {
+        context = undefined;
+    }
+    if (args.contextOrErrorOrSpacesAfter instanceof Error) {
+        parsedError = args.contextOrErrorOrSpacesAfter;
+    }
+    else if (args.message instanceof Error) {
+        parsedError = args.message;
+    }
+    else {
+        parsedError = undefined;
+    }
+    if (typeof args.contextOrErrorOrSpacesAfter === 'number') {
+        spacesAfter = args.contextOrErrorOrSpacesAfter;
+        normalizedSpacesBefore = args.spacesAfterOrBefore;
+    }
+    else {
+        spacesAfter = args.spacesAfterOrBefore;
+        normalizedSpacesBefore = args.spacesBefore;
+    }
+    if (normalizedSpacesBefore && normalizedSpacesBefore > 0) {
+        spacer(normalizedSpacesBefore);
+    }
+    const formattedMessage = formatMessage(args.message, context?.message ?? parsedError?.message ?? '');
+    // Only log if not silent
+    if (!context?.silentConsole) {
+        console.error(`✘ ${formattedMessage}`, parsedError ?? '');
+    }
+    if (spacesAfter && spacesAfter > 0) {
+        spacer(spacesAfter);
+    }
+}

package/dist/logger/logs/format-columns.d.ts

@@ -0,0 +1,14 @@
+import { type LoggerColumn } from '../types/types.js';
+/**
+ * Formats a set of columns (strings or LoggerColumn objects) into a single padded string.
+ *
+ * Each item in `columns` can be:
+ *  - A string: included as-is.
+ *  - A LoggerColumn: padded/truncated based on `c` (column width), content `t`, and alignment `a` ('left' or 'right').
+ *
+ * If `a` is 'right', pads the value on the left (right-aligned). Default is left-aligned.
+ *
+ * @param columns Array of LoggerColumn objects or strings to format.
+ * @returns The formatted string with each value padded to its column definition.
+ */
+export declare function formatColumns(columns: (LoggerColumn | string)[]): string;

package/dist/logger/logs/format-columns.js

@@ -0,0 +1,27 @@
+/* * */
+/* * */
+/**
+ * Formats a set of columns (strings or LoggerColumn objects) into a single padded string.
+ *
+ * Each item in `columns` can be:
+ *  - A string: included as-is.
+ *  - A LoggerColumn: padded/truncated based on `c` (column width), content `t`, and alignment `a` ('left' or 'right').
+ *
+ * If `a` is 'right', pads the value on the left (right-aligned). Default is left-aligned.
+ *
+ * @param columns Array of LoggerColumn objects or strings to format.
+ * @returns The formatted string with each value padded to its column definition.
+ */
+export function formatColumns(columns) {
+    return columns
+        .map((item) => {
+        if (typeof item === 'string')
+            return item;
+        if (!item.c)
+            return String(item.t);
+        if (item.a === 'right')
+            return String(item.t).padStart(item.c);
+        return String(item.t).padEnd(item.c);
+    })
+        .join('');
+}