ionic-logging-service 17.0.0 → 21.0.0

package/lib/ajax-appender.model.d.ts

@@ -1,92 +0,0 @@
-import { EventEmitter } from "@angular/core";
-import * as log4javascript from "log4javascript";
-import { AjaxAppenderConfiguration } from "./ajax-appender.configuration";
-/**
- * An appender which sends the log messages to a server via HTTP.
- *
- * A typical configuration could be:
- *
- * ```json
- * {
- *   "url": "https://my.backend.xy/LoggingBackend",
- *   "batchSize": 10,
- *   "timerInterval": 60000,
- *   "threshold": "INFO"
- * }
- * ```
- */
-export declare class AjaxAppender extends log4javascript.Appender {
-    private static batchSizeDefault;
-    private static timerIntervalDefault;
-    private static thresholdDefault;
-    /**
-     * Event triggered when the appender could not send log messages to the server.
-     *
-     * @param message error message
-     */
-    appenderFailed: EventEmitter<string>;
-    private ajaxAppender;
-    private url;
-    private withCredentials;
-    /**
-     * Creates a new instance of the appender.
-     *
-     * @param configuration configuration for the appender.
-     */
-    constructor(configuration: AjaxAppenderConfiguration);
-    /**
-     * Configures the logging depending on the given configuration.
-     *
-     * Only the defined properties get overwritten.
-     * Neither url nor withCredentials can be modified.
-     *
-     * @param configuration configuration data.
-     */
-    configure(configuration: AjaxAppenderConfiguration): void;
-    /**
-     * Appender-specific method to append a log message.
-     *
-     * @param loggingEvent event to be appended.
-     */
-    append(loggingEvent: log4javascript.LoggingEvent): void;
-    /**
-     * Gets the appender's name.
-     * Mainly for unit testing purposes.
-     *
-     * @return appender's name
-     */
-    toString(): string;
-    /**
-     * Get the internally used appender.
-     * Mainly for unit testing purposes.
-     */
-    getInternalAppender(): log4javascript.AjaxAppender;
-    /**
-     * Returns the number of log messages sent in each request.
-     */
-    getBatchSize(): number;
-    /**
-     * Sets the number of log messages to send in each request.
-     *
-     * @param batchSize new batch size
-     */
-    setBatchSize(batchSize: number): void;
-    /**
-     * Returns the appender's layout.
-     */
-    getLayout(): log4javascript.Layout;
-    /**
-     * Sets the appender's layout.
-     */
-    setLayout(layout: log4javascript.Layout): void;
-    /**
-     * Returns the length of time in milliseconds between each sending of queued log messages.
-     */
-    getTimerInterval(): number;
-    /**
-     * Sets the length of time in milliseconds between each sending of queued log messages.
-     *
-     * @param timerInterval new timer interval
-     */
-    setTimerInterval(timerInterval: number): void;
-}

package/lib/browser-console-appender.configuration.d.ts

@@ -1,13 +0,0 @@
-/**
- * Configuration for BrowserConsoleAppender.
- */
-export interface BrowserConsoleAppenderConfiguration {
-    /**
-     * Threshold.
-     *
-     * Valid values are: ALL, DEBUG, ERROR, FATAL, INFO, OFF, TRACE, WARN
-     *
-     * Default: DEBUG.
-     */
-    threshold?: string;
-}

package/lib/json-layout.model.d.ts

@@ -1,20 +0,0 @@
-import * as log4javascript from "log4javascript";
-import { LoggingEvent } from "log4javascript";
-/**
- * Formats a logging event into JavaScript Object Notation (JSON).
- * The implemenatation is mainly the same as with log4javascript.JsonLayout,
- * with an improvement of serializing messages containing '\"'."
- */
-export declare class JsonLayout extends log4javascript.JsonLayout {
-    /**
-     * Formats the log message.
-     */
-    format(loggingEvent: LoggingEvent): string;
-    /**
-     * Gets the layout's name.
-     * Mainly for unit testing purposes.
-     *
-     * @return layout's name
-     */
-    toString(): string;
-}

package/lib/local-storage-appender.configuration.d.ts

@@ -1,23 +0,0 @@
-/**
- * Configuration for LocalStorageAppender.
- */
-export interface LocalStorageAppenderConfiguration {
-    /**
-     * Key which is used to store the messages in the local storage.
-     */
-    localStorageKey: string;
-    /**
-     * Maximum number of log messages stored by the appender.
-     *
-     * Default: 250.
-     */
-    maxMessages?: number;
-    /**
-     * Threshold.
-     *
-     * Valid values are: ALL, DEBUG, ERROR, FATAL, INFO, OFF, TRACE, WARN
-     *
-     * Default: WARN.
-     */
-    threshold?: string;
-}

package/lib/local-storage-appender.model.d.ts

@@ -1,95 +0,0 @@
-import * as log4javascript from "log4javascript";
-import { LocalStorageAppenderConfiguration } from "./local-storage-appender.configuration";
-import { LogMessage } from "./log-message.model";
-/**
- * An appender which stores the log messages in the browser's local storage.
- *
- * The messages are saved JSON-serialized.
- * You have to configure which key is used for storing the messages.
- *
- * A typical configuration could be:
- *
- * ```json
- * {
- *   "localStorageKey": "myLogs",
- *   "maxMessages": 500,
- *   "threshold": "INFO"
- * }
- * ```
- */
-export declare class LocalStorageAppender extends log4javascript.Appender {
-    private static maxMessagesDefault;
-    private static thresholdDefault;
-    private maxMessages;
-    private localStorageKey;
-    private logMessages;
-    /**
-     * Creates a new instance of the appender.
-     *
-     * @param configuration configuration for the appender.
-     */
-    constructor(configuration: LocalStorageAppenderConfiguration);
-    /**
-     * Load log messages from local storage which are stored there under the given key.
-     *
-     * @param localStorageKey local storage key
-     * @return stored messages
-     */
-    static loadLogMessages(localStorageKey: string): LogMessage[];
-    /**
-     * Remove log messages from local storage which are stored there under the given key.
-     *
-     * @param localStorageKey local storage key
-     */
-    static removeLogMessages(localStorageKey: string): void;
-    /**
-     * Configures the logging depending on the given configuration.
-     *
-     * Only the defined properties get overwritten.
-     * The localStorageKey cannot be modified.
-     *
-     * @param configuration configuration data.
-     */
-    configure(configuration: LocalStorageAppenderConfiguration): void;
-    /**
-     * Appender-specific method to append a log message.
-     *
-     * @param loggingEvent event to be appended.
-     */
-    append(loggingEvent: log4javascript.LoggingEvent): void;
-    /**
-     * Gets the appender's name.
-     * Mainly for unit testing purposes.
-     *
-     * @return appender's name
-     */
-    toString(): string;
-    /**
-     * Get the key which is used to store the messages in the local storage.
-     */
-    getLocalStorageKey(): string;
-    /**
-     * Get the maximum number of messages which will be stored in local storage.
-     */
-    getMaxMessages(): number;
-    /**
-     * Set the maximum number of messages which will be stored in local storage.
-     *
-     * If the appender stores currently more messages than the new value allows, the oldest messages get removed.
-     *
-     * @param value new maximum number
-     */
-    setMaxMessages(value: number): void;
-    /**
-     * Gets all messages stored in local storage.
-     * Mainly for unit testing purposes.
-     *
-     * @return stored messages
-     */
-    getLogMessages(): LogMessage[];
-    /**
-     * Removes all messages from local storage.
-     * Mainly for unit testing purposes.
-     */
-    clearLog(): void;
-}

package/lib/log-level.converter.d.ts

@@ -1,28 +0,0 @@
-import * as log4javascript from "log4javascript";
-import { LogLevel } from "./log-level.model";
-/**
- * Helper class for converting log levels from and to different data type.
- */
-export declare class LogLevelConverter {
-    /**
-     * Converts log4javascript.Level to internal LogLevel.
-     *
-     * @param level log4javascript's data type
-     * @return internal data type.
-     */
-    static levelFromLog4Javascript(level: log4javascript.Level): LogLevel;
-    /**
-     * Converts string representation to internal LogLevel.
-     *
-     * @param level string representation
-     * @return internal data type.
-     */
-    static levelFromString(level: string): LogLevel;
-    /**
-     * Converts internal LogLevel to log4javascript.Level.
-     *
-     * @param internal data type.
-     * @return level log4javascript's data type
-     */
-    static levelToLog4Javascript(level: LogLevel): log4javascript.Level;
-}

package/lib/log-level.model.d.ts

@@ -1,37 +0,0 @@
-/**
- * Logging levels.
- */
-export declare enum LogLevel {
-    /**
-     * All events should be logged.
-     */
-    ALL = 0,
-    /**
-     * A fine-grained debug message, typically capturing the flow through the application.
-     */
-    TRACE = 1,
-    /**
-     * A general debugging event.
-     */
-    DEBUG = 2,
-    /**
-     * An event for informational purposes.
-     */
-    INFO = 3,
-    /**
-     * An event that might possible lead to an error.
-     */
-    WARN = 4,
-    /**
-     * An error in the application, possibly recoverable.
-     */
-    ERROR = 5,
-    /**
-     * A severe error that will prevent the application from continuing.
-     */
-    FATAL = 6,
-    /**
-     * No events will be logged.
-     */
-    OFF = 7
-}

package/lib/log-message.model.d.ts

@@ -1,25 +0,0 @@
-/**
- * Log message.
- */
-export interface LogMessage {
-    /**
-     * Time when the log was written.
-     */
-    timeStamp: Date;
-    /**
-     * Log level.
-     */
-    level: string;
-    /**
-     * Name of the logger.
-     */
-    logger: string;
-    /**
-     * Method, in which the message was written.
-     */
-    methodName: string;
-    /**
-     * Message.
-     */
-    message: string[];
-}

package/lib/logger.model.d.ts

@@ -1,88 +0,0 @@
-import * as log4javascript from "log4javascript";
-import { LogLevel } from "./log-level.model";
-/**
- * Logger for writing log messages.
- */
-export declare class Logger {
-    private logger;
-    /**
-     * Creates a new instance of a logger.
-     */
-    constructor(logger?: string | any);
-    /**
-     * Get the log level.
-     */
-    getLogLevel(): LogLevel;
-    /**
-     * Set the log level.
-     *
-     * @param level the new log level
-     */
-    setLogLevel(level: LogLevel): void;
-    /**
-     * Logs a message at level TRACE.
-     *
-     * @param methodName name of the method
-     * @param params optional parameters to be logged; objects will be formatted as JSON
-     */
-    trace(methodName: string, ...params: any[]): void;
-    /**
-     * Logs a message at level DEBUG.
-     *
-     * @param methodName name of the method
-     * @param params optional parameters to be logged; objects will be formatted as JSON
-     */
-    debug(methodName: string, ...params: any[]): void;
-    /**
-     * Logs a message at level INFO.
-     *
-     * @param methodName name of the method
-     * @param params optional parameters to be logged; objects will be formatted as JSON
-     */
-    info(methodName: string, ...params: any[]): void;
-    /**
-     * Logs a message at level WARN.
-     *
-     * @param methodName name of the method
-     * @param params optional parameters to be logged; objects will be formatted as JSON
-     */
-    warn(methodName: string, ...params: any[]): void;
-    /**
-     * Logs a message at level ERROR.
-     *
-     * @param methodName name of the method
-     * @param params optional parameters to be logged; objects will be formatted as JSON
-     */
-    error(methodName: string, ...params: any[]): void;
-    /**
-     * Logs a message at level FATAL.
-     *
-     * @param methodName name of the method
-     * @param params optional parameters to be logged; objects will be formatted as JSON
-     */
-    fatal(methodName: string, ...params: any[]): void;
-    /**
-     * Logs the entry into a method.
-     * The method name will be logged at level INFO, the parameters at level DEBUG.
-     *
-     * @param methodName name of the method
-     * @param params optional parameters to be logged; objects will be formatted as JSON
-     */
-    entry(methodName: string, ...params: any[]): void;
-    /**
-     * Logs the exit of a method.
-     * The method name will be logged at level INFO, the parameters at level DEBUG.
-     *
-     * @param methodName name of the method
-     * @param params optional parameters to be logged; objects will be formatted as JSON
-     */
-    exit(methodName: string, ...params: any[]): void;
-    /**
-     * Formats the given argument.
-     */
-    formatArgument(arg: any): string;
-    /**
-     * Returns the internal Logger (for unit tests only).
-     */
-    getInternalLogger(): log4javascript.Logger;
-}

package/lib/logging-service.configuration.d.ts

@@ -1,40 +0,0 @@
-import { AjaxAppenderConfiguration } from "./ajax-appender.configuration";
-import { BrowserConsoleAppenderConfiguration } from "./browser-console-appender.configuration";
-import { LocalStorageAppenderConfiguration } from "./local-storage-appender.configuration";
-import { MemoryAppenderConfiguration } from "./memory-appender.configuration";
-/**
- * Partial configuration definition for LoggingService.
- */
-export interface LoggingServiceConfiguration {
-    /**
-     * Log levels for different loggers.
-     * Default: root: WARN
-     */
-    logLevels?: Array<{
-        /**
-         * Logger name or "root" for root logger.
-         */
-        loggerName: string;
-        /**
-         * Log level.
-         * Valid values are: ALL, DEBUG, ERROR, FATAL, INFO, OFF, TRACE, WARN
-         */
-        logLevel: string;
-    }>;
-    /**
-     * Settings for AjaxAppender.
-     */
-    ajaxAppender?: AjaxAppenderConfiguration;
-    /**
-     * Settings for LocalStorageAppender.
-     */
-    localStorageAppender?: LocalStorageAppenderConfiguration;
-    /**
-     * Settings for MemoryAppender.
-     */
-    memoryAppender?: MemoryAppenderConfiguration;
-    /**
-     * Settings for BrowserConsoleAppender.
-     */
-    browserConsoleAppender?: BrowserConsoleAppenderConfiguration;
-}

package/lib/logging-service.module.d.ts

@@ -1,6 +0,0 @@
-import * as i0 from "@angular/core";
-export declare class LoggingServiceModule {
-    static ɵfac: i0.ɵɵFactoryDeclaration<LoggingServiceModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<LoggingServiceModule, never, never, never>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<LoggingServiceModule>;
-}

package/lib/logging.service.d.ts

@@ -1,84 +0,0 @@
-import { EventEmitter } from "@angular/core";
-import { LogMessage } from "./log-message.model";
-import { Logger } from "./logger.model";
-import { LoggingServiceConfiguration } from "./logging-service.configuration";
-import * as i0 from "@angular/core";
-/**
- * Service for logging functionality.
- *
- * By default, the following settings are used:
- *  - logger: root with level WARN
- *  - appender: BrowserConsoleAppender with threshold DEBUG and MemoryAppender with threshold ALL
- *
- * Via [configure](#configure), it is possible to amend these settings.
- */
-export declare class LoggingService {
-    /**
-     * Event triggered when the log messages got (potentially) change.
-     * This can happen when:
-     * - new message was added
-     * - all message where removed from memory
-     * - all massages where removed for one spcific LocalStorageAppender
-     */
-    logMessagesChanged: EventEmitter<void>;
-    /**
-     * Event triggered when ajax appender could not send log messages to the server.
-     *
-     * @param message error message
-     */
-    ajaxAppenderFailed: EventEmitter<string>;
-    private memoryAppender;
-    private browserConsoleAppender;
-    /**
-     * Creates a new instance of the service.
-     */
-    constructor();
-    /**
-     * Configures the logging depending on the given configuration.
-     *
-     * @param configuration configuration data.
-     */
-    configure(configuration?: LoggingServiceConfiguration): void;
-    /**
-     * Gets the root logger from which all other loggers derive.
-     *
-     * @return root logger
-     */
-    getRootLogger(): Logger;
-    /**
-     * Gets a logger with the specified name, creating it if a logger with that name does not already exist.
-     *
-     * @param loggerName name of the logger
-     * @return logger
-     */
-    getLogger(loggerName: string): Logger;
-    /**
-     * Gets the last log messages.
-     *
-     * The log messages are retrieved from the internal [MemoryAppender](../memoryappender.html).
-     * That means you will get only the most current messages. The number of the messages is limited
-     * by its maxMessages value.
-     *
-     * @return log messages
-     */
-    getLogMessages(): LogMessage[];
-    /**
-     * Loads the log messages written by the LocalStorageAppender with the given key.
-     *
-     * @param localStorageKey key for the local storage
-     * @returns log messages
-     */
-    getLogMessagesFromLocalStorage(localStorageKey: string): LogMessage[];
-    /**
-     * Remove all log messages.
-     */
-    removeLogMessages(): void;
-    /**
-     * Removes the log messages written by the LocalStorageAppender with the given key.
-     *
-     * @param localStorageKey key for the local storage
-     */
-    removeLogMessagesFromLocalStorage(localStorageKey: string): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<LoggingService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<LoggingService>;
-}

package/lib/memory-appender.configuration.d.ts

@@ -1,19 +0,0 @@
-/**
- * Configuration for MemoryAppender.
- */
-export interface MemoryAppenderConfiguration {
-    /**
-     * Maximum number of log messages stored by the appender.
-     *
-     * Default: 250.
-     */
-    maxMessages?: number;
-    /**
-     * Threshold.
-     *
-     * Valid values are: ALL, DEBUG, ERROR, FATAL, INFO, OFF, TRACE, WARN.
-     *
-     * Default: ALL.
-     */
-    threshold?: string;
-}

package/lib/memory-appender.model.d.ts

@@ -1,81 +0,0 @@
-import * as log4javascript from "log4javascript";
-import { LogMessage } from "./log-message.model";
-import { MemoryAppenderConfiguration } from "./memory-appender.configuration";
-/**
- * An appender which stores the log messages in the browser's memory.
- *
- * The MemoryAppender is enabled by default.
- * If you do not specify anything else, it is using this configuration:
- *
- * ```JSON
- * {
- *   "memoryAppender": [
- *     {
- *       "maxMessages": 250,
- *       "threshold": "ALL"
- *     }
- * }
- * ```
- */
-export declare class MemoryAppender extends log4javascript.Appender {
-    private static maxMessagesDefault;
-    private static thresholdDefault;
-    private maxMessages;
-    private logMessages;
-    private onLogMessagesChangedCallback;
-    /**
-     * Creates a new instance of the appender.
-     *
-     * @param configuration configuration for the appender.
-     */
-    constructor(configuration?: MemoryAppenderConfiguration);
-    /**
-     * Configures the logging depending on the given configuration.
-     * Only the defined properties get overwritten.
-     *
-     * @param configuration configuration data.
-     */
-    configure(configuration: MemoryAppenderConfiguration): void;
-    /**
-     * Appender-specific method to append a log message.
-     *
-     * @param loggingEvent event to be appended.
-     */
-    append(loggingEvent: log4javascript.LoggingEvent): void;
-    /**
-     * Gets the appender's name.
-     * Mainly for unit testing purposes.
-     *
-     * @return appender's name
-     */
-    toString(): string;
-    /**
-     * Get the maximum number of messages which will be stored in memory.
-     */
-    getMaxMessages(): number;
-    /**
-     * Set the maximum number of messages which will be stored in memory.
-     *
-     * If the appender stores currently more messages than the new value allows, the oldest messages get removed.
-     *
-     * @param value new maximum number
-     */
-    setMaxMessages(value: number): void;
-    /**
-     * Gets all messages stored in memory.
-     *
-     * @return stored messages
-     */
-    getLogMessages(): LogMessage[];
-    /**
-     * Remove all messages stored in memory.
-     */
-    removeLogMessages(): void;
-    /**
-     * Registers a callback which will be called every time a new message is appended.
-     * This could be useful if you want to show new messages in realtime.
-     *
-     * @param callback callback to be called
-     */
-    setOnLogMessagesChangedCallback(callback: (message: LogMessage) => void): void;
-}

package/public_api.d.ts

@@ -1,14 +0,0 @@
-export * from "./lib/ajax-appender.configuration";
-export * from "./lib/ajax-appender.model";
-export * from "./lib/browser-console-appender.configuration";
-export * from "./lib/local-storage-appender.configuration";
-export * from "./lib/local-storage-appender.model";
-export * from "./lib/log-level.converter";
-export * from "./lib/log-level.model";
-export * from "./lib/log-message.model";
-export * from "./lib/logger.model";
-export * from "./lib/logging.service";
-export * from "./lib/logging-service.configuration";
-export * from "./lib/logging-service.module";
-export * from "./lib/memory-appender.configuration";
-export * from "./lib/memory-appender.model";