@athenna/logger 1.1.8 → 1.2.1

package/src/Contracts/DriverContract.js

@@ -1,10 +0,0 @@
-"use strict";
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/src/Contracts/FormatterContract.d.ts

@@ -1,11 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-export interface FormatterContract {
-    format(message: any, options?: any): any;
-}

package/src/Contracts/FormatterContract.js

@@ -1,10 +0,0 @@
-"use strict";
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/src/Contracts/LevelTypes.d.ts

@@ -1 +0,0 @@
-export declare type LevelTypes = 'info' | 'INFO' | 'debug' | 'DEBUG' | 'warn' | 'WARN' | 'error' | 'ERROR' | 'success' | 'SUCCESS';

package/src/Contracts/LevelTypes.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/src/Drivers/ConsoleDriver.d.ts

@@ -1,19 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { DriverContract } from '../Contracts/DriverContract';
-export interface ConsoleDriverOpts {
-    streamType?: 'stdout' | 'stderr';
-    formatter?: any;
-    formatterConfig?: any;
-}
-export declare class ConsoleDriver implements DriverContract {
-    configs: Required<ConsoleDriverOpts>;
-    constructor(channel: string, configs?: any);
-    transport(message: string, options?: ConsoleDriverOpts): void;
-}

package/src/Drivers/DebugDriver.d.ts

@@ -1,19 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { DriverContract } from '../Contracts/DriverContract';
-export interface DebugDriverOpts {
-    namespace?: string;
-    formatter?: any;
-    formatterConfig?: any;
-}
-export declare class DebugDriver implements DriverContract {
-    configs: Required<DebugDriverOpts>;
-    constructor(channel: string, configs?: any);
-    transport(message: string, options?: DebugDriverOpts): void;
-}

package/src/Drivers/DiscordDriver.d.ts

@@ -1,20 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { DriverContract } from '../Contracts/DriverContract';
-export interface DiscordDriverOpts {
-    url?: string;
-    username?: string;
-    formatter?: any;
-    formatterConfig?: any;
-}
-export declare class DiscordDriver implements DriverContract {
-    configs: Required<DiscordDriverOpts>;
-    constructor(channel: string, configs?: any);
-    transport(message: string, options?: DiscordDriverOpts): Promise<void>;
-}

package/src/Drivers/FileDriver.d.ts

@@ -1,19 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { DriverContract } from '../Contracts/DriverContract';
-export interface FileDriverOpts {
-    filePath?: string;
-    formatter?: any;
-    formatterConfig?: any;
-}
-export declare class FileDriver implements DriverContract {
-    configs: Required<FileDriverOpts>;
-    constructor(channel: string, configs?: any);
-    transport(message: string, options?: FileDriverOpts): Promise<void>;
-}

package/src/Drivers/NullDriver.d.ts

@@ -1,13 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { DriverContract } from '../Contracts/DriverContract';
-export declare class NullDriver implements DriverContract {
-    constructor(_channel: string, _configs?: any);
-    transport(_message: string, _options?: any): void;
-}

package/src/Drivers/PinoDriver.d.ts

@@ -1,20 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import pino from 'pino';
-import pinoPretty from 'pino-pretty';
-import { DriverContract } from '../Contracts/DriverContract';
-export interface PinoDriverOpts extends pino.LoggerOptions {
-    formatter: 'pino-pretty';
-    formatterConfig: pinoPretty.PrettyOptions;
-}
-export declare class PinoDriver implements DriverContract {
-    configs: PinoDriverOpts;
-    constructor(channel: string, configs?: any);
-    transport(message: any, options?: Partial<PinoDriverOpts>): void;
-}

package/src/Drivers/SlackDriver.d.ts

@@ -1,19 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { DriverContract } from '../Contracts/DriverContract';
-export interface SlackDriverOpts {
-    url?: string;
-    formatter?: any;
-    formatterConfig?: any;
-}
-export declare class SlackDriver implements DriverContract {
-    configs: Required<SlackDriverOpts>;
-    constructor(channel: string, configs?: any);
-    transport(message: string, options?: SlackDriverOpts): Promise<void>;
-}

package/src/Drivers/TelegramDriver.d.ts

@@ -1,21 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { DriverContract } from '../Contracts/DriverContract';
-export interface TelegramDriverOpts {
-    token?: string;
-    chatId?: string | number;
-    parseMode?: 'HTML' | 'Markdown' | 'MarkdownV2';
-    formatter?: any;
-    formatterConfig?: any;
-}
-export declare class TelegramDriver implements DriverContract {
-    configs: Required<TelegramDriverOpts>;
-    constructor(channel: string, configs?: any);
-    transport(message: string, options?: TelegramDriverOpts): Promise<void>;
-}

package/src/Exceptions/ChannelNotConfiguredException.d.ts

@@ -1,12 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Exception } from '@secjs/utils';
-export declare class ChannelNotConfiguredException extends Exception {
-    constructor(channelName: string);
-}

package/src/Exceptions/ChannelNotConfiguredException.js

@@ -1,19 +0,0 @@
-"use strict";
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChannelNotConfiguredException = void 0;
-const utils_1 = require("@secjs/utils");
-class ChannelNotConfiguredException extends utils_1.Exception {
-    constructor(channelName) {
-        const content = `Channel ${channelName} is not configured inside logging.channels object from config/logging file`;
-        super(content, 500, 'NOT_CONFIGURED_ERROR', `Implement the channel in the logging.channels`);
-    }
-}
-exports.ChannelNotConfiguredException = ChannelNotConfiguredException;

package/src/Exceptions/DriverAlreadyExistException.d.ts

@@ -1,12 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Exception } from '@secjs/utils';
-export declare class DriverAlreadyExistException extends Exception {
-    constructor(driverName: string);
-}

package/src/Exceptions/DriverAlreadyExistException.js

@@ -1,19 +0,0 @@
-"use strict";
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DriverAlreadyExistException = void 0;
-const utils_1 = require("@secjs/utils");
-class DriverAlreadyExistException extends utils_1.Exception {
-    constructor(driverName) {
-        const content = `The driver ${driverName} already exists`;
-        super(content, 500, 'ALREADY_EXIST_ERROR', `The name ${driverName} is already in use. Try using a different name for your driver`);
-    }
-}
-exports.DriverAlreadyExistException = DriverAlreadyExistException;

package/src/Exceptions/FormatterAlreadyExistException.d.ts

@@ -1,12 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Exception } from '@secjs/utils';
-export declare class FormatterAlreadyExistException extends Exception {
-    constructor(formatterName: string);
-}

package/src/Exceptions/FormatterAlreadyExistException.js

@@ -1,19 +0,0 @@
-"use strict";
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FormatterAlreadyExistException = void 0;
-const utils_1 = require("@secjs/utils");
-class FormatterAlreadyExistException extends utils_1.Exception {
-    constructor(formatterName) {
-        const content = `The formatter ${formatterName} already exists`;
-        super(content, 500, 'ALREADY_EXIST_ERROR', `The name ${formatterName} is already in use. Try using a different name for your formatter`);
-    }
-}
-exports.FormatterAlreadyExistException = FormatterAlreadyExistException;

package/src/Exceptions/NotFoundDriverException.d.ts

@@ -1,12 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Exception } from '@secjs/utils';
-export declare class NotFoundDriverException extends Exception {
-    constructor(driverName: string);
-}

package/src/Exceptions/NotFoundFormatterException.d.ts

@@ -1,12 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Exception } from '@secjs/utils';
-export declare class NotFoundFormatterException extends Exception {
-    constructor(formatterName: string);
-}

package/src/Exceptions/OnlyPinoPrettyException.d.ts

@@ -1,12 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Exception } from '@secjs/utils';
-export declare class OnlyPinoPrettyException extends Exception {
-    constructor();
-}

package/src/Facades/Log.d.ts

@@ -1,10 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Logger } from '../Logger';
-export declare const Log: Logger;

package/src/Factories/DriverFactory.d.ts

@@ -1,19 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { DriverContract } from '../Contracts/DriverContract';
-export interface DriverObject {
-    Driver: any;
-}
-export declare class DriverFactory {
-    private static drivers;
-    static availableDrivers(): string[];
-    static fabricate(channelName: string, runtimeConfig?: any): DriverContract;
-    static createDriver(name: string, driver: new (channel: string, configs?: any) => DriverContract): void;
-    private static getChannelConfig;
-}

package/src/Factories/FormatterFactory.d.ts

@@ -1,18 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { FormatterContract } from '../Contracts/FormatterContract';
-export interface FormatterObject {
-    Formatter: any;
-}
-export declare class FormatterFactory {
-    private static formatters;
-    static availableFormatters(): string[];
-    static fabricate(formatterName: string): FormatterContract;
-    static createFormatter(name: string, driver: new () => FormatterContract): void;
-}

package/src/Formatters/CliFormatter.d.ts

@@ -1,19 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Chalk } from 'chalk';
-import { LevelTypes } from '../Contracts/LevelTypes';
-import { FormatterContract } from '../Contracts/FormatterContract';
-export interface CliFormatterOptions {
-    chalk: Chalk;
-    level: LevelTypes;
-}
-export declare class CliFormatter implements FormatterContract {
-    private static paintByLevel;
-    format(message: string, options: CliFormatterOptions): string;
-}

package/src/Formatters/JsonFormatter.d.ts

@@ -1,16 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Chalk } from 'chalk';
-import { FormatterContract } from '../Contracts/FormatterContract';
-export interface JsonFormatterOptions {
-    chalk: Chalk;
-}
-export declare class JsonFormatter implements FormatterContract {
-    format(message: Record<any, unknown>, options: JsonFormatterOptions): string;
-}

package/src/Formatters/MessageFormatter.d.ts

@@ -1,20 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { LevelTypes } from '../Contracts/LevelTypes';
-import { FormatterContract } from '../Contracts/FormatterContract';
-export interface MessageFormatterOpts {
-    level: LevelTypes;
-    customEmoji: string;
-}
-export declare class MessageFormatter implements FormatterContract {
-    private static lastTimestamp?;
-    private static getTimestampDiff;
-    private static getEmojiByLevel;
-    format(message: string, options: MessageFormatterOpts): string;
-}

package/src/Formatters/NestFormatter.d.ts

@@ -1,19 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Chalk } from 'chalk';
-import { FormatterContract } from '../Contracts/FormatterContract';
-export interface ContextFormatterOptions {
-    chalk: Chalk;
-    context: string;
-}
-export declare class NestFormatter implements FormatterContract {
-    private static lastTimestamp?;
-    private static getTimestampDiff;
-    format(message: string, options: ContextFormatterOptions): string;
-}

package/src/Formatters/RequestFormatter.d.ts

@@ -1,17 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Chalk } from 'chalk';
-import { FormatterContract } from '../Contracts/FormatterContract';
-export interface RequestFormatterOptions {
-    chalk: Chalk;
-    asJson: boolean;
-}
-export declare class RequestFormatter implements FormatterContract {
-    format(ctx: any, options: RequestFormatterOptions): string;
-}

package/src/Formatters/SimpleFormatter.d.ts

@@ -1,21 +0,0 @@
-/**
- * @athenna/logger
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Chalk } from 'chalk';
-import { LevelTypes } from '../Contracts/LevelTypes';
-import { FormatterContract } from '../Contracts/FormatterContract';
-export interface SimpleFormatterOpts {
-    chalk: Chalk;
-    level: LevelTypes;
-}
-export declare class SimpleFormatter implements FormatterContract {
-    private static lastTimestamp?;
-    private static getTimestampDiff;
-    private static paintByLevel;
-    format(message: string, options: SimpleFormatterOpts): string;
-}

package/src/Logger.d.ts

@@ -1,110 +0,0 @@
-import { DriverContract } from './Contracts/DriverContract';
-import { FormatterContract } from './Contracts/FormatterContract';
-export declare class Logger {
-    /**
-     * Runtime configurations to be used inside the Drivers and Formatters.
-     * @private
-     */
-    private runtimeConfig;
-    /**
-     * The driver responsible for transporting the logs.
-     * @private
-     */
-    private driver;
-    /**
-     * The log channel selected with driver and formatter configurations.
-     * @private
-     */
-    private channelName;
-    /**
-     * Creates a new instance of Logger.
-     *
-     * @return {Logger}
-     */
-    constructor();
-    /**
-     * Return all drivers available.
-     */
-    static get drivers(): string[];
-    /**
-     * Return all formatters available.
-     */
-    static get formatters(): string[];
-    /**
-     * Builds a new driver to use within Logger class.
-     *
-     * @param name
-     * @param driver
-     */
-    static buildDriver(name: string, driver: new (channel: string, configs?: any) => DriverContract): void;
-    /**
-     * Builds a new formatter to use within Logger class.
-     *
-     * @param name
-     * @param formatter
-     */
-    static buildFormatter(name: string, formatter: new () => FormatterContract): void;
-    /**
-     * Applies the log engine to execute chalk methods of string.
-     *
-     * @param content
-     * @private
-     */
-    private static applyLogEngine;
-    /**
-     * Change the log channel.
-     *
-     * @param channel
-     * @param runtimeConfig
-     */
-    channel(channel: string, runtimeConfig?: any): Logger;
-    /**
-     * Creates a log of type log in channel.
-     * @param message
-     * @param options
-     */
-    log(message: any, options?: {}): void | Promise<void>;
-    /**
-     * Creates a log of type info in channel.
-     *
-     * @param message
-     * @param options
-     */
-    info(message: any, options?: {}): void | Promise<void>;
-    /**
-     * Creates a log of type warn in channel.
-     *
-     * @param message
-     * @param options
-     */
-    warn(message: any, options?: {}): void | Promise<void>;
-    /**
-     * Creates a log of type error in channel.
-     *
-     * @param message
-     * @param options
-     */
-    error(message: any, options?: {}): void | Promise<void>;
-    /**
-     * Creates a log of type debug in channel.
-     *
-     * @param message
-     * @param options
-     */
-    debug(message: any, options?: {}): void | Promise<void>;
-    /**
-     * Creates a log of type success in channel.
-     *
-     * @param message
-     * @param options
-     */
-    success(message: any, options?: {}): void | Promise<void>;
-    /**
-     * Create options concatenating client options with default options.
-     *
-     * @param options
-     * @param defaultValues
-     * @private
-     */
-    private createOptions;
-}