@workleap/logrocket 1.2.0 → 1.2.2

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @workleap/logrocket
 
+## 1.2.2
+
+### Patch Changes
+
+- [#58](https://github.com/workleap/wl-telemetry/pull/58) [`10d0c3f`](https://github.com/workleap/wl-telemetry/commit/10d0c3fe6e7565a2a95aeed9f3bc83274d90f1ad) Thanks [@patricklafrance](https://github.com/patricklafrance)! - LogRocketLogger object segment type is now unknown.
+
+- Updated dependencies [[`10d0c3f`](https://github.com/workleap/wl-telemetry/commit/10d0c3fe6e7565a2a95aeed9f3bc83274d90f1ad)]:
+  - @workleap/telemetry@1.1.3
+
+## 1.2.1
+
+### Patch Changes
+
+- [#56](https://github.com/workleap/wl-telemetry/pull/56) [`7be6e06`](https://github.com/workleap/wl-telemetry/commit/7be6e06b0f1f42e549ff043dc9b68db91ceb8d15) Thanks [@patricklafrance](https://github.com/patricklafrance)! - LogRocket logger now supports optional segments.
+
+- Updated dependencies [[`7be6e06`](https://github.com/workleap/wl-telemetry/commit/7be6e06b0f1f42e549ff043dc9b68db91ceb8d15)]:
+  - @workleap/telemetry@1.1.2
+
 ## 1.2.0
 
 ### Minor Changes

package/dist/LogRocketLogger.d.ts

@@ -12,15 +12,15 @@ export declare class LogRocketLoggerScope implements LoggerScope {
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */
-    withText(text: string, options?: LogOptions): this;
+    withText(text?: string, options?: LogOptions): this;
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */
-    withError(error: Error): this;
+    withError(error?: Error): this;
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */
-    withObject(obj: object): this;
+    withObject(obj?: unknown): this;
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */
@@ -72,15 +72,15 @@ export declare class LogRocketLogger implements Logger {
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */
-    withText(text: string, options?: LogOptions): this;
+    withText(text?: string, options?: LogOptions): this;
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */
-    withError(error: Error): this;
+    withError(error?: Error): this;
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */
-    withObject(obj: object): this;
+    withObject(obj?: unknown): this;
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */

package/dist/LogRocketLogger.js

@@ -57,26 +57,32 @@ function parseSegments(segments) {
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */ withText(text, options = {}) {
-        this.#segments.push({
-            text,
-            options
-        });
+        if (text) {
+            this.#segments.push({
+                text,
+                options
+            });
+        }
         return this;
     }
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */ withError(error) {
-        this.#segments.push({
-            error
-        });
+        if (error) {
+            this.#segments.push({
+                error
+            });
+        }
         return this;
     }
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */ withObject(obj) {
-        this.#segments.push({
-            obj
-        });
+        if (obj) {
+            this.#segments.push({
+                obj
+            });
+        }
         return this;
     }
     /**
@@ -196,26 +202,32 @@ function parseSegments(segments) {
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */ withText(text, options = {}) {
-        this.#segments.push({
-            text,
-            options
-        });
+        if (text) {
+            this.#segments.push({
+                text,
+                options
+            });
+        }
         return this;
     }
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */ withError(error) {
-        this.#segments.push({
-            error
-        });
+        if (error) {
+            this.#segments.push({
+                error
+            });
+        }
         return this;
     }
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */ withObject(obj) {
-        this.#segments.push({
-            obj
-        });
+        if (obj) {
+            this.#segments.push({
+                obj
+            });
+        }
         return this;
     }
     /**

package/dist/LogRocketLogger.js.map

@@ -1 +1 @@
-{"version":3,"file":"LogRocketLogger.js","sources":["webpack://@workleap/logrocket/./src/LogRocketLogger.ts"],"sourcesContent":["import { type Logger, type LoggerOptions, type LoggerScope, type LoggerScopeEndOptions, LogLevel, type LogOptions, type Segment } from \"@workleap/logging\";\nimport LogRocket from \"logrocket\";\n\ntype LogFunction = (...rest: unknown[]) => void;\ntype PendingLog = () => void;\n\nfunction parseSegments(segments: Segment[]) {\n    return segments.reduce<unknown[]>((acc, x) => {\n        if (x.text) {\n            acc.push(x.text);\n        } else if (x.obj) {\n            acc.push(x.obj);\n        } else if (x.error) {\n            acc.push(x.error);\n        } else if (x.lineChange) {\n            acc.push(\"\\r\\n\");\n        }\n\n        return acc;\n    }, []);\n}\n\n/**\n * An scope implementation for the LogRocket logger.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport class LogRocketLoggerScope implements LoggerScope {\n    readonly #logLevel: LogLevel;\n    readonly #label: string;\n\n    #segments: Segment[] = [];\n    #pendingLogs: PendingLog[] = [];\n    #hasEnded: boolean = false;\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    constructor(label: string, logLevel: LogLevel) {\n        this.#logLevel = logLevel;\n        this.#label = label;\n    }\n\n    #resetSegments() {\n        this.#segments = [];\n    }\n\n    #log(fct: LogFunction, threshold: LogLevel) {\n        if (this.#segments.length > 0) {\n            if (this.#logLevel <= threshold) {\n                // Required closure to preserved the current log items for when they will be formatted when the scope is ended.\n                const segments = this.#segments;\n\n                this.#pendingLogs.push(() => {\n                    const parsedSegments = parseSegments(segments);\n                    parsedSegments.unshift(`(${this.#label})`);\n\n                    fct(...parsedSegments);\n                });\n            }\n\n            this.#resetSegments();\n        }\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    withText(text: string, options: LogOptions = {}) {\n        this.#segments.push({\n            text,\n            options\n        });\n\n        return this;\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    withError(error: Error) {\n        this.#segments.push({\n            error\n        });\n\n        return this;\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    withObject(obj: object) {\n        this.#segments.push({\n            obj\n        });\n\n        return this;\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    withLineChange() {\n        this.#segments.push({\n            lineChange: true\n        });\n\n        return this;\n    }\n\n    /**\n     * Write a debug log. The log will be processed only if the logger LogLevel is >= debug.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    debug(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.log, LogLevel.debug);\n    }\n\n    /**\n     * Write an information log. The log will be processed only if the logger LogLevel is >= information.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    information(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.log, LogLevel.information);\n    }\n\n    /**\n     * Write a warning log. The log will be processed only if the logger LogLevel is >= warning.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    warning(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.warn, LogLevel.warning);\n    }\n\n    /**\n     * Write an error log. The log will be processed only if the logger LogLevel is >= error.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    error(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.error, LogLevel.error);\n    }\n\n    /**\n     * Write a critical log. The log will be processed only if the logger LogLevel is >= critical.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    critical(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.error, LogLevel.critical);\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    end(options: LoggerScopeEndOptions = {}) {\n        const {\n            dismiss = false\n        } = options;\n\n        if (!this.#hasEnded) {\n            this.#hasEnded = true;\n\n            if (!dismiss) {\n                if (this.#pendingLogs.length > 0) {\n                    this.#pendingLogs.forEach(x => {\n                        x();\n                    });\n\n                    this.#pendingLogs = [];\n                }\n            }\n        }\n    }\n}\n\n/**\n * A logger implementation for LogRocket.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport class LogRocketLogger implements Logger {\n    readonly #logLevel: LogLevel;\n    #segments: Segment[] = [];\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    constructor(options: LoggerOptions = {}) {\n        const {\n            logLevel = LogLevel.debug\n        } = options;\n\n        this.#logLevel = logLevel;\n    }\n\n    #resetSegments() {\n        this.#segments = [];\n    }\n\n    #log(fct: LogFunction, threshold: LogLevel) {\n        if (this.#segments.length > 0) {\n            if (this.#logLevel <= threshold) {\n                const parsedSegments = parseSegments(this.#segments);\n\n                fct(...parsedSegments);\n            }\n\n            this.#resetSegments();\n        }\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    getName() {\n        return LogRocketLogger.name;\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    withText(text: string, options: LogOptions = {}) {\n        this.#segments.push({\n            text,\n            options\n        });\n\n        return this;\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    withError(error: Error) {\n        this.#segments.push({\n            error\n        });\n\n        return this;\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    withObject(obj: object) {\n        this.#segments.push({\n            obj\n        });\n\n        return this;\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    withLineChange() {\n        this.#segments.push({\n            lineChange: true\n        });\n\n        return this;\n    }\n\n    /**\n     * Write a debug log. The log will be processed only if the logger LogLevel is >= debug.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    debug(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.log, LogLevel.debug);\n    }\n\n    /**\n     * Write an information log. The log will be processed only if the logger LogLevel is >= information.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    information(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.log, LogLevel.information);\n    }\n\n    /**\n     * Write a warning log. The log will be processed only if the logger LogLevel is >= warning.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    warning(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.warn, LogLevel.warning);\n    }\n\n    /**\n     * Write an error log. The log will be processed only if the logger LogLevel is >= error.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    error(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.error, LogLevel.error);\n    }\n\n    /**\n     * Write a critical log. The log will be processed only if the logger LogLevel is >= critical.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    critical(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.error, LogLevel.critical);\n    }\n\n    /**\n     * Start a new logging scope. The scope will inherit the LogLevel of the root logger.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    startScope(label: string) {\n        return new LogRocketLoggerScope(label, this.#logLevel);\n    }\n}\n"],"names":["LogLevel","LogRocket","parseSegments","segments","acc","x","LogRocketLoggerScope","label","logLevel","fct","threshold","parsedSegments","text","options","error","obj","log","dismiss","LogRocketLogger"],"mappings":";;;;;;;;AAA2J;AACzH;AAKlC,SAASE,cAAcC,QAAmB;IACtC,OAAOA,SAAS,MAAM,CAAY,CAACC,KAAKC;QACpC,IAAIA,EAAE,IAAI,EAAE;YACRD,IAAI,IAAI,CAACC,EAAE,IAAI;QACnB,OAAO,IAAIA,EAAE,GAAG,EAAE;YACdD,IAAI,IAAI,CAACC,EAAE,GAAG;QAClB,OAAO,IAAIA,EAAE,KAAK,EAAE;YAChBD,IAAI,IAAI,CAACC,EAAE,KAAK;QACpB,OAAO,IAAIA,EAAE,UAAU,EAAE;YACrBD,IAAI,IAAI,CAAC;QACb;QAEA,OAAOA;IACX,GAAG,EAAE;AACT;AAEA;;;CAGC,GACM,MAAME;IACA,SAAS,CAAW;IACpB,MAAM,CAAS;IAExB,SAAS,GAAc,EAAE,CAAC;IAC1B,YAAY,GAAiB,EAAE,CAAC;IAChC,SAAS,GAAY,MAAM;IAE3B;;KAEC,GACD,YAAYC,KAAa,EAAEC,QAAkB,CAAE;QAC3C,IAAI,CAAC,SAAS,GAAGA;QACjB,IAAI,CAAC,MAAM,GAAGD;IAClB;IAEA,cAAc;QACV,IAAI,CAAC,SAAS,GAAG,EAAE;IACvB;IAEA,IAAI,CAACE,GAAgB,EAAEC,SAAmB;QACtC,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,GAAG;YAC3B,IAAI,IAAI,CAAC,SAAS,IAAIA,WAAW;gBAC7B,+GAA+G;gBAC/G,MAAMP,WAAW,IAAI,CAAC,SAAS;gBAE/B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;oBACnB,MAAMQ,iBAAiBT,cAAcC;oBACrCQ,eAAe,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;oBAEzCF,OAAOE;gBACX;YACJ;YAEA,IAAI,CAAC,cAAc;QACvB;IACJ;IAEA;;KAEC,GACD,SAASC,IAAY,EAAEC,UAAsB,CAAC,CAAC,EAAE;QAC7C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAChBD;YACAC;QACJ;QAEA,OAAO,IAAI;IACf;IAEA;;KAEC,GACD,UAAUC,KAAY,EAAE;QACpB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAChBA;QACJ;QAEA,OAAO,IAAI;IACf;IAEA;;KAEC,GACD,WAAWC,GAAW,EAAE;QACpB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAChBA;QACJ;QAEA,OAAO,IAAI;IACf;IAEA;;KAEC,GACD,iBAAiB;QACb,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAChB,YAAY;QAChB;QAEA,OAAO,IAAI;IACf;IAEA;;;KAGC,GACD,MAAMC,GAAY,EAAEH,OAAoB,EAAE;QACtC,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,aAAa,EAAED,cAAc;IAC3C;IAEA;;;KAGC,GACD,YAAYgB,GAAY,EAAEH,OAAoB,EAAE;QAC5C,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,aAAa,EAAED,oBAAoB;IACjD;IAEA;;;KAGC,GACD,QAAQgB,GAAY,EAAEH,OAAoB,EAAE;QACxC,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,cAAc,EAAED,gBAAgB;IAC9C;IAEA;;;KAGC,GACD,MAAMgB,GAAY,EAAEH,OAAoB,EAAE;QACtC,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,eAAe,EAAED,cAAc;IAC7C;IAEA;;;KAGC,GACD,SAASgB,GAAY,EAAEH,OAAoB,EAAE;QACzC,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,eAAe,EAAED,iBAAiB;IAChD;IAEA;;KAEC,GACD,IAAIa,UAAiC,CAAC,CAAC,EAAE;QACrC,MAAM,EACFI,UAAU,KAAK,EAClB,GAAGJ;QAEJ,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACjB,IAAI,CAAC,SAAS,GAAG;YAEjB,IAAI,CAACI,SAAS;gBACV,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,GAAG;oBAC9B,IAAI,CAAC,YAAY,CAAC,OAAO,CAACZ,CAAAA;wBACtBA;oBACJ;oBAEA,IAAI,CAAC,YAAY,GAAG,EAAE;gBAC1B;YACJ;QACJ;IACJ;AACJ;AAEA;;;CAGC,GACM,MAAMa;IACA,SAAS,CAAW;IAC7B,SAAS,GAAc,EAAE,CAAC;IAE1B;;KAEC,GACD,YAAYL,UAAyB,CAAC,CAAC,CAAE;QACrC,MAAM,EACFL,WAAWR,cAAc,EAC5B,GAAGa;QAEJ,IAAI,CAAC,SAAS,GAAGL;IACrB;IAEA,cAAc;QACV,IAAI,CAAC,SAAS,GAAG,EAAE;IACvB;IAEA,IAAI,CAACC,GAAgB,EAAEC,SAAmB;QACtC,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,GAAG;YAC3B,IAAI,IAAI,CAAC,SAAS,IAAIA,WAAW;gBAC7B,MAAMC,iBAAiBT,cAAc,IAAI,CAAC,SAAS;gBAEnDO,OAAOE;YACX;YAEA,IAAI,CAAC,cAAc;QACvB;IACJ;IAEA;;KAEC,GACD,UAAU;QACN,OAAOO,gBAAgB,IAAI;IAC/B;IAEA;;KAEC,GACD,SAASN,IAAY,EAAEC,UAAsB,CAAC,CAAC,EAAE;QAC7C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAChBD;YACAC;QACJ;QAEA,OAAO,IAAI;IACf;IAEA;;KAEC,GACD,UAAUC,KAAY,EAAE;QACpB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAChBA;QACJ;QAEA,OAAO,IAAI;IACf;IAEA;;KAEC,GACD,WAAWC,GAAW,EAAE;QACpB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAChBA;QACJ;QAEA,OAAO,IAAI;IACf;IAEA;;KAEC,GACD,iBAAiB;QACb,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAChB,YAAY;QAChB;QAEA,OAAO,IAAI;IACf;IAEA;;;KAGC,GACD,MAAMC,GAAY,EAAEH,OAAoB,EAAE;QACtC,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,aAAa,EAAED,cAAc;IAC3C;IAEA;;;KAGC,GACD,YAAYgB,GAAY,EAAEH,OAAoB,EAAE;QAC5C,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,aAAa,EAAED,oBAAoB;IACjD;IAEA;;;KAGC,GACD,QAAQgB,GAAY,EAAEH,OAAoB,EAAE;QACxC,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,cAAc,EAAED,gBAAgB;IAC9C;IAEA;;;KAGC,GACD,MAAMgB,GAAY,EAAEH,OAAoB,EAAE;QACtC,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,eAAe,EAAED,cAAc;IAC7C;IAEA;;;KAGC,GACD,SAASgB,GAAY,EAAEH,OAAoB,EAAE;QACzC,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,eAAe,EAAED,iBAAiB;IAChD;IAEA;;;KAGC,GACD,WAAWO,KAAa,EAAE;QACtB,OAAO,IAAID,qBAAqBC,OAAO,IAAI,CAAC,SAAS;IACzD;AACJ"}
+{"version":3,"file":"LogRocketLogger.js","sources":["webpack://@workleap/logrocket/./src/LogRocketLogger.ts"],"sourcesContent":["import { type Logger, type LoggerOptions, type LoggerScope, type LoggerScopeEndOptions, LogLevel, type LogOptions, type Segment } from \"@workleap/logging\";\nimport LogRocket from \"logrocket\";\n\ntype LogFunction = (...rest: unknown[]) => void;\ntype PendingLog = () => void;\n\nfunction parseSegments(segments: Segment[]) {\n    return segments.reduce<unknown[]>((acc, x) => {\n        if (x.text) {\n            acc.push(x.text);\n        } else if (x.obj) {\n            acc.push(x.obj);\n        } else if (x.error) {\n            acc.push(x.error);\n        } else if (x.lineChange) {\n            acc.push(\"\\r\\n\");\n        }\n\n        return acc;\n    }, []);\n}\n\n/**\n * An scope implementation for the LogRocket logger.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport class LogRocketLoggerScope implements LoggerScope {\n    readonly #logLevel: LogLevel;\n    readonly #label: string;\n\n    #segments: Segment[] = [];\n    #pendingLogs: PendingLog[] = [];\n    #hasEnded: boolean = false;\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    constructor(label: string, logLevel: LogLevel) {\n        this.#logLevel = logLevel;\n        this.#label = label;\n    }\n\n    #resetSegments() {\n        this.#segments = [];\n    }\n\n    #log(fct: LogFunction, threshold: LogLevel) {\n        if (this.#segments.length > 0) {\n            if (this.#logLevel <= threshold) {\n                // Required closure to preserved the current log items for when they will be formatted when the scope is ended.\n                const segments = this.#segments;\n\n                this.#pendingLogs.push(() => {\n                    const parsedSegments = parseSegments(segments);\n                    parsedSegments.unshift(`(${this.#label})`);\n\n                    fct(...parsedSegments);\n                });\n            }\n\n            this.#resetSegments();\n        }\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    withText(text?: string, options: LogOptions = {}) {\n        if (text) {\n            this.#segments.push({\n                text,\n                options\n            });\n        }\n\n        return this;\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    withError(error?: Error) {\n        if (error) {\n            this.#segments.push({\n                error\n            });\n        }\n\n        return this;\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    withObject(obj?: unknown) {\n        if (obj) {\n            this.#segments.push({\n                obj\n            });\n        }\n\n        return this;\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    withLineChange() {\n        this.#segments.push({\n            lineChange: true\n        });\n\n        return this;\n    }\n\n    /**\n     * Write a debug log. The log will be processed only if the logger LogLevel is >= debug.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    debug(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.log, LogLevel.debug);\n    }\n\n    /**\n     * Write an information log. The log will be processed only if the logger LogLevel is >= information.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    information(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.log, LogLevel.information);\n    }\n\n    /**\n     * Write a warning log. The log will be processed only if the logger LogLevel is >= warning.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    warning(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.warn, LogLevel.warning);\n    }\n\n    /**\n     * Write an error log. The log will be processed only if the logger LogLevel is >= error.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    error(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.error, LogLevel.error);\n    }\n\n    /**\n     * Write a critical log. The log will be processed only if the logger LogLevel is >= critical.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    critical(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.error, LogLevel.critical);\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    end(options: LoggerScopeEndOptions = {}) {\n        const {\n            dismiss = false\n        } = options;\n\n        if (!this.#hasEnded) {\n            this.#hasEnded = true;\n\n            if (!dismiss) {\n                if (this.#pendingLogs.length > 0) {\n                    this.#pendingLogs.forEach(x => {\n                        x();\n                    });\n\n                    this.#pendingLogs = [];\n                }\n            }\n        }\n    }\n}\n\n/**\n * A logger implementation for LogRocket.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport class LogRocketLogger implements Logger {\n    readonly #logLevel: LogLevel;\n    #segments: Segment[] = [];\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    constructor(options: LoggerOptions = {}) {\n        const {\n            logLevel = LogLevel.debug\n        } = options;\n\n        this.#logLevel = logLevel;\n    }\n\n    #resetSegments() {\n        this.#segments = [];\n    }\n\n    #log(fct: LogFunction, threshold: LogLevel) {\n        if (this.#segments.length > 0) {\n            if (this.#logLevel <= threshold) {\n                const parsedSegments = parseSegments(this.#segments);\n\n                fct(...parsedSegments);\n            }\n\n            this.#resetSegments();\n        }\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    getName() {\n        return LogRocketLogger.name;\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    withText(text?: string, options: LogOptions = {}) {\n        if (text) {\n            this.#segments.push({\n                text,\n                options\n            });\n        }\n\n        return this;\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    withError(error?: Error) {\n        if (error) {\n            this.#segments.push({\n                error\n            });\n        }\n\n        return this;\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    withObject(obj?: unknown) {\n        if (obj) {\n            this.#segments.push({\n                obj\n            });\n        }\n\n        return this;\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    withLineChange() {\n        this.#segments.push({\n            lineChange: true\n        });\n\n        return this;\n    }\n\n    /**\n     * Write a debug log. The log will be processed only if the logger LogLevel is >= debug.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    debug(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.log, LogLevel.debug);\n    }\n\n    /**\n     * Write an information log. The log will be processed only if the logger LogLevel is >= information.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    information(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.log, LogLevel.information);\n    }\n\n    /**\n     * Write a warning log. The log will be processed only if the logger LogLevel is >= warning.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    warning(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.warn, LogLevel.warning);\n    }\n\n    /**\n     * Write an error log. The log will be processed only if the logger LogLevel is >= error.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    error(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.error, LogLevel.error);\n    }\n\n    /**\n     * Write a critical log. The log will be processed only if the logger LogLevel is >= critical.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    critical(log?: string, options?: LogOptions) {\n        if (log) {\n            this.#segments.push({\n                text: log,\n                options\n            });\n        }\n\n        this.#log(LogRocket.error, LogLevel.critical);\n    }\n\n    /**\n     * Start a new logging scope. The scope will inherit the LogLevel of the root logger.\n     * @see {@link https://workleap.github.io/wl-logging}\n     */\n    startScope(label: string) {\n        return new LogRocketLoggerScope(label, this.#logLevel);\n    }\n}\n"],"names":["LogLevel","LogRocket","parseSegments","segments","acc","x","LogRocketLoggerScope","label","logLevel","fct","threshold","parsedSegments","text","options","error","obj","log","dismiss","LogRocketLogger"],"mappings":";;;;;;;;AAA2J;AACzH;AAKlC,SAASE,cAAcC,QAAmB;IACtC,OAAOA,SAAS,MAAM,CAAY,CAACC,KAAKC;QACpC,IAAIA,EAAE,IAAI,EAAE;YACRD,IAAI,IAAI,CAACC,EAAE,IAAI;QACnB,OAAO,IAAIA,EAAE,GAAG,EAAE;YACdD,IAAI,IAAI,CAACC,EAAE,GAAG;QAClB,OAAO,IAAIA,EAAE,KAAK,EAAE;YAChBD,IAAI,IAAI,CAACC,EAAE,KAAK;QACpB,OAAO,IAAIA,EAAE,UAAU,EAAE;YACrBD,IAAI,IAAI,CAAC;QACb;QAEA,OAAOA;IACX,GAAG,EAAE;AACT;AAEA;;;CAGC,GACM,MAAME;IACA,SAAS,CAAW;IACpB,MAAM,CAAS;IAExB,SAAS,GAAc,EAAE,CAAC;IAC1B,YAAY,GAAiB,EAAE,CAAC;IAChC,SAAS,GAAY,MAAM;IAE3B;;KAEC,GACD,YAAYC,KAAa,EAAEC,QAAkB,CAAE;QAC3C,IAAI,CAAC,SAAS,GAAGA;QACjB,IAAI,CAAC,MAAM,GAAGD;IAClB;IAEA,cAAc;QACV,IAAI,CAAC,SAAS,GAAG,EAAE;IACvB;IAEA,IAAI,CAACE,GAAgB,EAAEC,SAAmB;QACtC,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,GAAG;YAC3B,IAAI,IAAI,CAAC,SAAS,IAAIA,WAAW;gBAC7B,+GAA+G;gBAC/G,MAAMP,WAAW,IAAI,CAAC,SAAS;gBAE/B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;oBACnB,MAAMQ,iBAAiBT,cAAcC;oBACrCQ,eAAe,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;oBAEzCF,OAAOE;gBACX;YACJ;YAEA,IAAI,CAAC,cAAc;QACvB;IACJ;IAEA;;KAEC,GACD,SAASC,IAAa,EAAEC,UAAsB,CAAC,CAAC,EAAE;QAC9C,IAAID,MAAM;YACN,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChBA;gBACAC;YACJ;QACJ;QAEA,OAAO,IAAI;IACf;IAEA;;KAEC,GACD,UAAUC,KAAa,EAAE;QACrB,IAAIA,OAAO;YACP,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChBA;YACJ;QACJ;QAEA,OAAO,IAAI;IACf;IAEA;;KAEC,GACD,WAAWC,GAAa,EAAE;QACtB,IAAIA,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChBA;YACJ;QACJ;QAEA,OAAO,IAAI;IACf;IAEA;;KAEC,GACD,iBAAiB;QACb,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAChB,YAAY;QAChB;QAEA,OAAO,IAAI;IACf;IAEA;;;KAGC,GACD,MAAMC,GAAY,EAAEH,OAAoB,EAAE;QACtC,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,aAAa,EAAED,cAAc;IAC3C;IAEA;;;KAGC,GACD,YAAYgB,GAAY,EAAEH,OAAoB,EAAE;QAC5C,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,aAAa,EAAED,oBAAoB;IACjD;IAEA;;;KAGC,GACD,QAAQgB,GAAY,EAAEH,OAAoB,EAAE;QACxC,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,cAAc,EAAED,gBAAgB;IAC9C;IAEA;;;KAGC,GACD,MAAMgB,GAAY,EAAEH,OAAoB,EAAE;QACtC,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,eAAe,EAAED,cAAc;IAC7C;IAEA;;;KAGC,GACD,SAASgB,GAAY,EAAEH,OAAoB,EAAE;QACzC,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,eAAe,EAAED,iBAAiB;IAChD;IAEA;;KAEC,GACD,IAAIa,UAAiC,CAAC,CAAC,EAAE;QACrC,MAAM,EACFI,UAAU,KAAK,EAClB,GAAGJ;QAEJ,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACjB,IAAI,CAAC,SAAS,GAAG;YAEjB,IAAI,CAACI,SAAS;gBACV,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,GAAG;oBAC9B,IAAI,CAAC,YAAY,CAAC,OAAO,CAACZ,CAAAA;wBACtBA;oBACJ;oBAEA,IAAI,CAAC,YAAY,GAAG,EAAE;gBAC1B;YACJ;QACJ;IACJ;AACJ;AAEA;;;CAGC,GACM,MAAMa;IACA,SAAS,CAAW;IAC7B,SAAS,GAAc,EAAE,CAAC;IAE1B;;KAEC,GACD,YAAYL,UAAyB,CAAC,CAAC,CAAE;QACrC,MAAM,EACFL,WAAWR,cAAc,EAC5B,GAAGa;QAEJ,IAAI,CAAC,SAAS,GAAGL;IACrB;IAEA,cAAc;QACV,IAAI,CAAC,SAAS,GAAG,EAAE;IACvB;IAEA,IAAI,CAACC,GAAgB,EAAEC,SAAmB;QACtC,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,GAAG;YAC3B,IAAI,IAAI,CAAC,SAAS,IAAIA,WAAW;gBAC7B,MAAMC,iBAAiBT,cAAc,IAAI,CAAC,SAAS;gBAEnDO,OAAOE;YACX;YAEA,IAAI,CAAC,cAAc;QACvB;IACJ;IAEA;;KAEC,GACD,UAAU;QACN,OAAOO,gBAAgB,IAAI;IAC/B;IAEA;;KAEC,GACD,SAASN,IAAa,EAAEC,UAAsB,CAAC,CAAC,EAAE;QAC9C,IAAID,MAAM;YACN,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChBA;gBACAC;YACJ;QACJ;QAEA,OAAO,IAAI;IACf;IAEA;;KAEC,GACD,UAAUC,KAAa,EAAE;QACrB,IAAIA,OAAO;YACP,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChBA;YACJ;QACJ;QAEA,OAAO,IAAI;IACf;IAEA;;KAEC,GACD,WAAWC,GAAa,EAAE;QACtB,IAAIA,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChBA;YACJ;QACJ;QAEA,OAAO,IAAI;IACf;IAEA;;KAEC,GACD,iBAAiB;QACb,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAChB,YAAY;QAChB;QAEA,OAAO,IAAI;IACf;IAEA;;;KAGC,GACD,MAAMC,GAAY,EAAEH,OAAoB,EAAE;QACtC,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,aAAa,EAAED,cAAc;IAC3C;IAEA;;;KAGC,GACD,YAAYgB,GAAY,EAAEH,OAAoB,EAAE;QAC5C,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,aAAa,EAAED,oBAAoB;IACjD;IAEA;;;KAGC,GACD,QAAQgB,GAAY,EAAEH,OAAoB,EAAE;QACxC,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,cAAc,EAAED,gBAAgB;IAC9C;IAEA;;;KAGC,GACD,MAAMgB,GAAY,EAAEH,OAAoB,EAAE;QACtC,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,eAAe,EAAED,cAAc;IAC7C;IAEA;;;KAGC,GACD,SAASgB,GAAY,EAAEH,OAAoB,EAAE;QACzC,IAAIG,KAAK;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,MAAMA;gBACNH;YACJ;QACJ;QAEA,IAAI,CAAC,IAAI,CAACZ,eAAe,EAAED,iBAAiB;IAChD;IAEA;;;KAGC,GACD,WAAWO,KAAa,EAAE;QACtB,OAAO,IAAID,qBAAqBC,OAAO,IAAI,CAAC,SAAS;IACzD;AACJ"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@workleap/logrocket",
   "author": "Workleap",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "A package containing utilities for LogRocket.",
   "license": "Apache-2.0",
   "repository": {
@@ -31,9 +31,9 @@
     "logrocket": "^10.1.0"
   },
   "dependencies": {
-    "@workleap/logging": "^1.2.0",
+    "@workleap/logging": "^1.2.2",
     "logrocket-fuzzy-search-sanitizer": "0.0.2",
-    "@workleap/telemetry": "1.1.1"
+    "@workleap/telemetry": "1.1.3"
   },
   "devDependencies": {
     "@rsbuild/core": "1.4.6",

package/src/LogRocketLogger.ts

@@ -65,11 +65,13 @@ export class LogRocketLoggerScope implements LoggerScope {
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */
-    withText(text: string, options: LogOptions = {}) {
-        this.#segments.push({
-            text,
-            options
-        });
+    withText(text?: string, options: LogOptions = {}) {
+        if (text) {
+            this.#segments.push({
+                text,
+                options
+            });
+        }
 
         return this;
     }
@@ -77,10 +79,12 @@ export class LogRocketLoggerScope implements LoggerScope {
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */
-    withError(error: Error) {
-        this.#segments.push({
-            error
-        });
+    withError(error?: Error) {
+        if (error) {
+            this.#segments.push({
+                error
+            });
+        }
 
         return this;
     }
@@ -88,10 +92,12 @@ export class LogRocketLoggerScope implements LoggerScope {
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */
-    withObject(obj: object) {
-        this.#segments.push({
-            obj
-        });
+    withObject(obj?: unknown) {
+        if (obj) {
+            this.#segments.push({
+                obj
+            });
+        }
 
         return this;
     }
@@ -251,11 +257,13 @@ export class LogRocketLogger implements Logger {
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */
-    withText(text: string, options: LogOptions = {}) {
-        this.#segments.push({
-            text,
-            options
-        });
+    withText(text?: string, options: LogOptions = {}) {
+        if (text) {
+            this.#segments.push({
+                text,
+                options
+            });
+        }
 
         return this;
     }
@@ -263,10 +271,12 @@ export class LogRocketLogger implements Logger {
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */
-    withError(error: Error) {
-        this.#segments.push({
-            error
-        });
+    withError(error?: Error) {
+        if (error) {
+            this.#segments.push({
+                error
+            });
+        }
 
         return this;
     }
@@ -274,10 +284,12 @@ export class LogRocketLogger implements Logger {
     /**
      * @see {@link https://workleap.github.io/wl-logging}
      */
-    withObject(obj: object) {
-        this.#segments.push({
-            obj
-        });
+    withObject(obj?: unknown) {
+        if (obj) {
+            this.#segments.push({
+                obj
+            });
+        }
 
         return this;
     }