ionic-logging-service 18.0.0 → 22.0.0

package/README.md

@@ -1,9 +1,11 @@
 # ionic-logging-service
 
-**The dependencies used by the latest version are the same as needed for [Ionic 7.0.0](https://github.com/ionic-team/ionic/blob/master/CHANGELOG.md). For older versions use:**
+**The dependencies used by the latest version are the same as needed for [Ionic 8.0.0](https://github.com/ionic-team/ionic/blob/master/CHANGELOG.md). For older versions use:**
 
 | ionic-logging-service | Ionic | Angular
 | ------ | -------- | ------
+| 22.0.0 | >= 8.0.0 | >=22.0.0
+| 21.0.0 | >= 8.0.0 | >=21.0.0
 | 18.0.0 | >= 7.0.0 | >=17.0.0
 | 17.0.0 | >= 6.1.9 | ^16.0.0
 | 16.0.0 | >= 6.1.9 | ^15.0.0
@@ -121,29 +123,18 @@ export const environment = {
 };
 ```
 
-Call `configure()` in your `app.module.ts`:
+Call `configure()` in your `app.config.ts`:
 
 ```TypeScript
-export function configureLogging(loggingService: LoggingService): () => void {
-  return () => loggingService.configure(environment.logging);
-}
-
-@NgModule({
-  ...
-  imports: [
-    ...
-    LoggingServiceModule
-  ],
+export const appConfig: ApplicationConfig = {
   providers: [
-    {
-      deps: [LoggingService],
-      multi: true,
-      provide: APP_INITIALIZER,
-      useFactory: configureLogging
-    }
+    ...
+    provideAppInitializer(() => {
+      const loggingService = inject(LoggingService);
+      loggingService.configure(environment.logging);
+    }),
   ]
-})
-export class AppModule { }
+};
 ```
 
 ### logLevels
@@ -185,4 +176,4 @@ With `memoryAppender`, it is possible to configure the `MemoryAppender`, which k
 
 ## API
 
-see [API documentation](https://ritzlgrmft.github.io/ionic-logging-service//service/index.html).
+see [API documentation](https://ritzlgrmft.github.io/ionic-logging-service/service/index.html).

package/fesm2022/ionic-logging-service.mjs

@@ -1,5 +1,5 @@
 import * as i0 from '@angular/core';
-import { EventEmitter, Injectable, NgModule } from '@angular/core';
+import { signal, Injectable } from '@angular/core';
 import * as log4javascript from 'log4javascript';
 
 /**
@@ -40,42 +40,34 @@ var LogLevel;
     /**
      * All events should be logged.
      */
-    // eslint-disable-next-line @typescript-eslint/naming-convention
     LogLevel[LogLevel["ALL"] = 0] = "ALL";
     /**
      * A fine-grained debug message, typically capturing the flow through the application.
      */
-    // eslint-disable-next-line @typescript-eslint/naming-convention
     LogLevel[LogLevel["TRACE"] = 1] = "TRACE";
     /**
      * A general debugging event.
      */
-    // eslint-disable-next-line @typescript-eslint/naming-convention
     LogLevel[LogLevel["DEBUG"] = 2] = "DEBUG";
     /**
      * An event for informational purposes.
      */
-    // eslint-disable-next-line @typescript-eslint/naming-convention
     LogLevel[LogLevel["INFO"] = 3] = "INFO";
     /**
      * An event that might possible lead to an error.
      */
-    // eslint-disable-next-line @typescript-eslint/naming-convention
     LogLevel[LogLevel["WARN"] = 4] = "WARN";
     /**
      * An error in the application, possibly recoverable.
      */
-    // eslint-disable-next-line @typescript-eslint/naming-convention
     LogLevel[LogLevel["ERROR"] = 5] = "ERROR";
     /**
      * A severe error that will prevent the application from continuing.
      */
-    // eslint-disable-next-line @typescript-eslint/naming-convention
     LogLevel[LogLevel["FATAL"] = 6] = "FATAL";
     /**
      * No events will be logged.
      */
-    // eslint-disable-next-line @typescript-eslint/naming-convention
     LogLevel[LogLevel["OFF"] = 7] = "OFF";
 })(LogLevel || (LogLevel = {}));
 
@@ -194,6 +186,8 @@ class AjaxAppender extends log4javascript.Appender {
      */
     constructor(configuration) {
         super();
+        this.lastFailure = signal(undefined, /* @ts-ignore */
+        ...(ngDevMode ? [{ debugName: "lastFailure" }] : /* istanbul ignore next */ []));
         if (!configuration) {
             throw new Error("configuration must be not empty");
         }
@@ -202,13 +196,12 @@ class AjaxAppender extends log4javascript.Appender {
         }
         this.ajaxAppender = new log4javascript.AjaxAppender(configuration.url, configuration.withCredentials);
         this.url = configuration.url;
-        this.withCredentials = configuration.withCredentials;
+        this.withCredentials = configuration.withCredentials ?? false;
         this.ajaxAppender.setLayout(new JsonLayout(false, false));
         this.ajaxAppender.addHeader("Content-Type", "application/json; charset=utf-8");
         this.ajaxAppender.setSendAllOnUnload(true);
-        this.appenderFailed = new EventEmitter();
         this.ajaxAppender.setFailCallback((message) => {
-            this.appenderFailed.emit(message);
+            this.lastFailure.set(message);
         });
         // process remaining configuration
         this.configure({
@@ -312,6 +305,13 @@ class AjaxAppender extends log4javascript.Appender {
         this.ajaxAppender.setTimed(timerInterval > 0);
         this.ajaxAppender.setTimerInterval(timerInterval);
     }
+    /**
+     * Last error message when the appender could not send log messages to the server.
+     * @returns error message
+     */
+    getLastFailure() {
+        return this.lastFailure.asReadonly();
+    }
 }
 
 /**
@@ -340,6 +340,7 @@ class LocalStorageAppender extends log4javascript.Appender {
      */
     constructor(configuration) {
         super();
+        this.maxMessages = LocalStorageAppender.maxMessagesDefault;
         if (!configuration) {
             throw new Error("configuration must be not empty");
         }
@@ -368,7 +369,7 @@ class LocalStorageAppender extends log4javascript.Appender {
             logMessages = [];
         }
         else {
-            logMessages = JSON.parse(localStorage.getItem(localStorageKey));
+            logMessages = JSON.parse(localStorage.getItem(localStorageKey) ?? "");
             for (const logMessage of logMessages) {
                 // timestamps are serialized as strings
                 logMessage.timeStamp = new Date(logMessage.timeStamp);
@@ -532,7 +533,7 @@ class Logger {
             for (const param of params) {
                 args.push(this.formatArgument(param));
             }
-            this.logger.trace.apply(this.logger, args);
+            this.logger.trace(...args);
         }
     }
     /**
@@ -547,7 +548,7 @@ class Logger {
             for (const param of params) {
                 args.push(this.formatArgument(param));
             }
-            this.logger.debug.apply(this.logger, args);
+            this.logger.debug(...args);
         }
     }
     /**
@@ -562,7 +563,7 @@ class Logger {
             for (const param of params) {
                 args.push(this.formatArgument(param));
             }
-            this.logger.info.apply(this.logger, args);
+            this.logger.info(...args);
         }
     }
     /**
@@ -577,7 +578,7 @@ class Logger {
             for (const param of params) {
                 args.push(this.formatArgument(param));
             }
-            this.logger.warn.apply(this.logger, args);
+            this.logger.warn(...args);
         }
     }
     /**
@@ -592,7 +593,7 @@ class Logger {
             for (const param of params) {
                 args.push(this.formatArgument(param));
             }
-            this.logger.error.apply(this.logger, args);
+            this.logger.error(...args);
         }
     }
     /**
@@ -607,7 +608,7 @@ class Logger {
             for (const param of params) {
                 args.push(this.formatArgument(param));
             }
-            this.logger.fatal.apply(this.logger, args);
+            this.logger.fatal(...args);
         }
     }
     /**
@@ -625,7 +626,7 @@ class Logger {
                     args.push(this.formatArgument(param));
                 }
             }
-            this.logger.info.apply(this.logger, args);
+            this.logger.info(...args);
         }
     }
     /**
@@ -643,7 +644,7 @@ class Logger {
                     args.push(this.formatArgument(param));
                 }
             }
-            this.logger.info.apply(this.logger, args);
+            this.logger.info(...args);
         }
     }
     /**
@@ -703,7 +704,8 @@ class MemoryAppender extends log4javascript.Appender {
      */
     constructor(configuration) {
         super();
-        this.logMessages = [];
+        this.logMessages = signal([], /* @ts-ignore */
+        ...(ngDevMode ? [{ debugName: "logMessages" }] : /* istanbul ignore next */ []));
         // process configuration
         configuration = configuration || {};
         this.configure({
@@ -736,8 +738,8 @@ class MemoryAppender extends log4javascript.Appender {
      */
     append(loggingEvent) {
         // if logMessages is already full, remove oldest element
-        while (this.logMessages.length >= this.maxMessages) {
-            this.logMessages.shift();
+        while (this.logMessages().length >= this.maxMessages) {
+            this.logMessages.update(messages => messages.slice(1));
         }
         // add event to logMessages
         const message = {
@@ -747,11 +749,7 @@ class MemoryAppender extends log4javascript.Appender {
             methodName: loggingEvent.messages[0],
             timeStamp: loggingEvent.timeStamp,
         };
-        this.logMessages.push(message);
-        // inform about new message
-        if (typeof this.onLogMessagesChangedCallback === "function") {
-            this.onLogMessagesChangedCallback(message);
-        }
+        this.logMessages.update(messages => [...messages, message]);
     }
     /**
      * Gets the appender's name.
@@ -778,8 +776,8 @@ class MemoryAppender extends log4javascript.Appender {
     setMaxMessages(value) {
         this.maxMessages = value;
         // if there are too much logMessages for the new value, remove oldest messages
-        if (this.logMessages.length > this.maxMessages) {
-            this.logMessages.splice(0, this.logMessages.length - this.maxMessages);
+        if (this.logMessages().length > this.maxMessages) {
+            this.logMessages.update(messages => messages.slice(this.logMessages().length - this.maxMessages));
         }
     }
     /**
@@ -788,22 +786,13 @@ class MemoryAppender extends log4javascript.Appender {
      * @return stored messages
      */
     getLogMessages() {
-        return this.logMessages;
+        return this.logMessages.asReadonly();
     }
     /**
      * Remove all messages stored in memory.
      */
     removeLogMessages() {
-        this.logMessages.splice(0);
-    }
-    /**
-     * 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) {
-        this.onLogMessagesChangedCallback = callback;
+        this.logMessages.set([]);
     }
 }
 
@@ -823,9 +812,6 @@ class LoggingService {
     constructor() {
         // prevent log4javascript to show alerts on case of errors
         log4javascript.logLog.setQuietMode(true);
-        // create event emitter
-        this.logMessagesChanged = new EventEmitter();
-        this.ajaxAppenderFailed = new EventEmitter();
         // configure appender
         const logger = log4javascript.getRootLogger();
         logger.setLevel(log4javascript.Level.WARN);
@@ -837,9 +823,6 @@ class LoggingService {
         // in-memory appender for display on log messages page
         this.memoryAppender = new MemoryAppender();
         this.memoryAppender.setLayout(new log4javascript.PatternLayout("%d{HH:mm:ss,SSS} %c %m"));
-        this.memoryAppender.setOnLogMessagesChangedCallback((message) => {
-            this.logMessagesChanged.emit();
-        });
         logger.addAppender(this.memoryAppender);
         this.configure();
     }
@@ -865,18 +848,15 @@ class LoggingService {
                 try {
                     logger.setLevel(LogLevelConverter.levelToLog4Javascript(LogLevelConverter.levelFromString(level.logLevel)));
                 }
-                catch (e) {
+                catch {
                     throw new Error(`invalid log level ${level.logLevel}`);
                 }
             }
         }
         // configure AjaxAppender
         if (typeof configuration.ajaxAppender !== "undefined") {
-            const ajaxAppender = new AjaxAppender(configuration.ajaxAppender);
-            ajaxAppender.appenderFailed.subscribe((message) => {
-                this.ajaxAppenderFailed.emit(message);
-            });
-            log4javascript.getRootLogger().addAppender(ajaxAppender);
+            this.ajaxAppender = new AjaxAppender(configuration.ajaxAppender);
+            log4javascript.getRootLogger().addAppender(this.ajaxAppender);
         }
         // configure LocalStorageAppender
         if (typeof configuration.localStorageAppender !== "undefined") {
@@ -945,7 +925,6 @@ class LoggingService {
      */
     removeLogMessages() {
         this.memoryAppender.removeLogMessages();
-        this.logMessagesChanged.emit();
     }
     /**
      * Removes the log messages written by the LocalStorageAppender with the given key.
@@ -954,32 +933,26 @@ class LoggingService {
      */
     removeLogMessagesFromLocalStorage(localStorageKey) {
         LocalStorageAppender.removeLogMessages(localStorageKey);
-        this.logMessagesChanged.emit();
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.2.2", ngImport: i0, type: LoggingService, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
-    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "17.2.2", ngImport: i0, type: LoggingService, providedIn: "root" }); }
+    /**
+     * Error messages when the ajax appender could not send log messages to the server.
+     * @returns error messages
+     */
+    getLastAjaxAppenderFailure() {
+        return this.ajaxAppender
+            ? this.ajaxAppender.getLastFailure()
+            : signal(undefined).asReadonly();
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.0.0", ngImport: i0, type: LoggingService, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
+    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "22.0.0", ngImport: i0, type: LoggingService, providedIn: "root" }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.2.2", ngImport: i0, type: LoggingService, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.0.0", ngImport: i0, type: LoggingService, decorators: [{
             type: Injectable,
             args: [{
                     providedIn: "root"
                 }]
         }], ctorParameters: () => [] });
 
-class LoggingServiceModule {
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.2.2", ngImport: i0, type: LoggingServiceModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
-    static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "17.2.2", ngImport: i0, type: LoggingServiceModule }); }
-    static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "17.2.2", ngImport: i0, type: LoggingServiceModule }); }
-}
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.2.2", ngImport: i0, type: LoggingServiceModule, decorators: [{
-            type: NgModule,
-            args: [{
-                    imports: [],
-                    declarations: [],
-                    exports: []
-                }]
-        }] });
-
 /*
  * Public API Surface of ionic-logging-service.
  */
@@ -988,5 +961,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.2.2", ngImpor
  * Generated bundle index. Do not edit.
  */
 
-export { AjaxAppender, LocalStorageAppender, LogLevel, LogLevelConverter, Logger, LoggingService, LoggingServiceModule, MemoryAppender };
+export { AjaxAppender, LocalStorageAppender, LogLevel, LogLevelConverter, Logger, LoggingService, MemoryAppender };
 //# sourceMappingURL=ionic-logging-service.mjs.map