@loglayer/mixin-wide-events 1.0.0 → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Theo Gravity / [Disaresta](https://disaresta.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -1,5 +1,4 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 //#region ../../core/plugin/dist/index.js
 /**
 * List of plugin callbacks that can be called by the plugin manager.
@@ -20,17 +19,7 @@ let PluginCallbackType = /* @__PURE__ */ function(PluginCallbackType) {
 	PluginCallbackType["onContextCalled"] = "onContextCalled";
 	return PluginCallbackType;
 }({});
-
-//#endregion
-//#region ../../core/loglayer/dist/index.js
-const CALLBACK_LIST = [
-	PluginCallbackType.onBeforeDataOut,
-	PluginCallbackType.onMetadataCalled,
-	PluginCallbackType.onBeforeMessageOut,
-	PluginCallbackType.transformLogLevel,
-	PluginCallbackType.shouldSendToLogger,
-	PluginCallbackType.onContextCalled
-];
+PluginCallbackType.onBeforeDataOut, PluginCallbackType.onMetadataCalled, PluginCallbackType.onBeforeMessageOut, PluginCallbackType.transformLogLevel, PluginCallbackType.shouldSendToLogger, PluginCallbackType.onContextCalled;
 /**
 * The class that the mixin extends
 */
@@ -45,7 +34,6 @@ let LogLayerMixinAugmentType = /* @__PURE__ */ function(LogLayerMixinAugmentType
 	LogLayerMixinAugmentType["LogLayer"] = "LogLayer";
 	return LogLayerMixinAugmentType;
 }({});
-
 //#endregion
 //#region src/mixin.ts
 /**
@@ -95,6 +83,21 @@ function createWideEventMixin(options) {
 	const asyncContext = options.asyncContext;
 	const includeContext = options.includeContext ?? true;
 	const wideEventField = options.wideEventField;
+	const errorsAsArray = options.errorsAsArray ?? false;
+	const errorField = options.errorField ?? (errorsAsArray ? "errors" : "error");
+	function defaultErrorSerializer(err) {
+		if (err instanceof Error) return {
+			name: err.name,
+			message: err.message,
+			stack: err.stack
+		};
+		return { message: String(err) };
+	}
+	function getErrorSerializer(self) {
+		const config = self.getConfig?.();
+		if (config?.errorSerializer) return config.errorSerializer;
+		return defaultErrorSerializer;
+	}
 	/**
 	* Context tracker plugin - stores context in async storage
 	* for inclusion in wide events (only if includeContext is true)
@@ -160,6 +163,21 @@ function createWideEventMixin(options) {
 		return self;
 	}
 	/**
+	* Implementation for withWideEventError
+	*/
+	function withWideEventErrorImpl(error, self) {
+		const store = asyncContext.getStore();
+		if (store) {
+			const serializedError = getErrorSerializer(self)(error);
+			if (errorsAsArray) {
+				if (!store._llWideEvents) store._llWideEvents = {};
+				if (!store._llWideEvents[errorField]) store._llWideEvents[errorField] = [];
+				store._llWideEvents[errorField].push(serializedError);
+			} else withWideEventsImpl({ [errorField]: serializedError }, self);
+		}
+		return self;
+	}
+	/**
 	* Implementation for emitWideEvent
 	*/
 	function emitWideEventImpl(config, self) {
@@ -167,11 +185,9 @@ function createWideEventMixin(options) {
 		const wideEventData = {};
 		if (includeContext && store?._llContext) Object.assign(wideEventData, store._llContext);
 		if (store?._llWideEvents) Object.assign(wideEventData, store._llWideEvents);
-		if (config.metadata) Object.assign(wideEventData, config.metadata);
 		const level = config.level ?? "info";
 		const metadataToEmit = wideEventField ? { [wideEventField]: wideEventData } : wideEventData;
 		self.withMetadata(metadataToEmit)[level](config.message);
-		return self;
 	}
 	return {
 		mixinsToAdd: [{
@@ -189,6 +205,9 @@ function createWideEventMixin(options) {
 				prototype.emitWideEvent = function(config) {
 					return emitWideEventImpl(config, this);
 				};
+				prototype.withWideEventError = function(error) {
+					return withWideEventErrorImpl(error, this);
+				};
 			},
 			augmentMock: (prototype) => {
 				prototype.withWideEvents = function(data) {
@@ -203,11 +222,13 @@ function createWideEventMixin(options) {
 				prototype.emitWideEvent = function(config) {
 					return emitWideEventImpl(config, this);
 				};
+				prototype.withWideEventError = function(error) {
+					return withWideEventErrorImpl(error, this);
+				};
 			}
 		}],
 		pluginsToAdd: [contextTrackerPlugin]
 	};
 }
-
 //#endregion
-exports.createWideEventMixin = createWideEventMixin;
+exports.createWideEventMixin = createWideEventMixin;

package/dist/index.d.cts

@@ -2089,6 +2089,18 @@ interface WideEventMixinOptions {
    * { "userId": "123", "orderId": "456", "msg": "done" }
    */
   wideEventField?: string;
+  /**
+   * Optional: Field name to use for error data in wide events.
+   * @default "error" (single mode) or "errors" (array mode)
+   */
+  errorField?: string;
+  /**
+   * Optional: When true, errors are collected as an array.
+   * Each call to withWideEventError() appends to the array.
+   * When false, each call replaces the previous error.
+   * @default false
+   */
+  errorsAsArray?: boolean;
 }
 /**
  * Configuration for emitting a wide event.
@@ -2102,11 +2114,6 @@ interface EmitWideEventConfig {
    * Optional: Log level (defaults to "info").
    */
   level?: LogLevelType;
-  /**
-   * Optional: Additional metadata to include in this specific emission.
-   * This is merged with the accumulated wide event data.
-   */
-  metadata?: Record<string, any>;
 }
 /**
  * Interface for wide event mixin functionality.
@@ -2183,22 +2190,41 @@ interface IWideEventMixin {
    * and logs at the specified level.
    *
    * @param config - Configuration for the wide event emission
-   * @returns This logger instance for chaining
    *
    * @example
    * ```typescript
    * // Emit as info log
    * logger.emitWideEvent({ message: "Order processed" });
    *
-   * // Emit as error with additional metadata
+   * // Emit as error
    * logger.emitWideEvent({
    *   message: "Order failed",
    *   level: "error",
-   *   metadata: { reason: "payment_declined" }
    * });
    * ```
    */
-  emitWideEvent(config: EmitWideEventConfig): this;
+  emitWideEvent(config: EmitWideEventConfig): void;
+  /**
+   * Captures an error for inclusion in the wide event.
+   * Serializes the error using the configured errorSerializer (or default).
+   *
+   * @param error - The error to capture
+   * @returns This logger instance for chaining
+   *
+   * @example
+   * ```typescript
+   * try {
+   *   await doSomething();
+   * } catch (err) {
+   *   // For single error (replaces previous)
+   *   logger.withWideEventError(err);
+   *
+   *   // With errorsAsArray: true - errors accumulate
+   *   logger.withWideEventError(err).withWideEventError(otherErr);
+   * }
+   * ```
+   */
+  withWideEventError(error: any): this;
 }
 declare module "loglayer" {
   interface LogLayer extends IWideEventMixin {}

package/dist/index.d.mts

@@ -2089,6 +2089,18 @@ interface WideEventMixinOptions {
    * { "userId": "123", "orderId": "456", "msg": "done" }
    */
   wideEventField?: string;
+  /**
+   * Optional: Field name to use for error data in wide events.
+   * @default "error" (single mode) or "errors" (array mode)
+   */
+  errorField?: string;
+  /**
+   * Optional: When true, errors are collected as an array.
+   * Each call to withWideEventError() appends to the array.
+   * When false, each call replaces the previous error.
+   * @default false
+   */
+  errorsAsArray?: boolean;
 }
 /**
  * Configuration for emitting a wide event.
@@ -2102,11 +2114,6 @@ interface EmitWideEventConfig {
    * Optional: Log level (defaults to "info").
    */
   level?: LogLevelType;
-  /**
-   * Optional: Additional metadata to include in this specific emission.
-   * This is merged with the accumulated wide event data.
-   */
-  metadata?: Record<string, any>;
 }
 /**
  * Interface for wide event mixin functionality.
@@ -2183,22 +2190,41 @@ interface IWideEventMixin {
    * and logs at the specified level.
    *
    * @param config - Configuration for the wide event emission
-   * @returns This logger instance for chaining
    *
    * @example
    * ```typescript
    * // Emit as info log
    * logger.emitWideEvent({ message: "Order processed" });
    *
-   * // Emit as error with additional metadata
+   * // Emit as error
    * logger.emitWideEvent({
    *   message: "Order failed",
    *   level: "error",
-   *   metadata: { reason: "payment_declined" }
    * });
    * ```
    */
-  emitWideEvent(config: EmitWideEventConfig): this;
+  emitWideEvent(config: EmitWideEventConfig): void;
+  /**
+   * Captures an error for inclusion in the wide event.
+   * Serializes the error using the configured errorSerializer (or default).
+   *
+   * @param error - The error to capture
+   * @returns This logger instance for chaining
+   *
+   * @example
+   * ```typescript
+   * try {
+   *   await doSomething();
+   * } catch (err) {
+   *   // For single error (replaces previous)
+   *   logger.withWideEventError(err);
+   *
+   *   // With errorsAsArray: true - errors accumulate
+   *   logger.withWideEventError(err).withWideEventError(otherErr);
+   * }
+   * ```
+   */
+  withWideEventError(error: any): this;
 }
 declare module "loglayer" {
   interface LogLayer extends IWideEventMixin {}

package/dist/index.mjs

@@ -18,17 +18,7 @@ let PluginCallbackType = /* @__PURE__ */ function(PluginCallbackType) {
 	PluginCallbackType["onContextCalled"] = "onContextCalled";
 	return PluginCallbackType;
 }({});
-
-//#endregion
-//#region ../../core/loglayer/dist/index.js
-const CALLBACK_LIST = [
-	PluginCallbackType.onBeforeDataOut,
-	PluginCallbackType.onMetadataCalled,
-	PluginCallbackType.onBeforeMessageOut,
-	PluginCallbackType.transformLogLevel,
-	PluginCallbackType.shouldSendToLogger,
-	PluginCallbackType.onContextCalled
-];
+PluginCallbackType.onBeforeDataOut, PluginCallbackType.onMetadataCalled, PluginCallbackType.onBeforeMessageOut, PluginCallbackType.transformLogLevel, PluginCallbackType.shouldSendToLogger, PluginCallbackType.onContextCalled;
 /**
 * The class that the mixin extends
 */
@@ -43,7 +33,6 @@ let LogLayerMixinAugmentType = /* @__PURE__ */ function(LogLayerMixinAugmentType
 	LogLayerMixinAugmentType["LogLayer"] = "LogLayer";
 	return LogLayerMixinAugmentType;
 }({});
-
 //#endregion
 //#region src/mixin.ts
 /**
@@ -93,6 +82,21 @@ function createWideEventMixin(options) {
 	const asyncContext = options.asyncContext;
 	const includeContext = options.includeContext ?? true;
 	const wideEventField = options.wideEventField;
+	const errorsAsArray = options.errorsAsArray ?? false;
+	const errorField = options.errorField ?? (errorsAsArray ? "errors" : "error");
+	function defaultErrorSerializer(err) {
+		if (err instanceof Error) return {
+			name: err.name,
+			message: err.message,
+			stack: err.stack
+		};
+		return { message: String(err) };
+	}
+	function getErrorSerializer(self) {
+		const config = self.getConfig?.();
+		if (config?.errorSerializer) return config.errorSerializer;
+		return defaultErrorSerializer;
+	}
 	/**
 	* Context tracker plugin - stores context in async storage
 	* for inclusion in wide events (only if includeContext is true)
@@ -158,6 +162,21 @@ function createWideEventMixin(options) {
 		return self;
 	}
 	/**
+	* Implementation for withWideEventError
+	*/
+	function withWideEventErrorImpl(error, self) {
+		const store = asyncContext.getStore();
+		if (store) {
+			const serializedError = getErrorSerializer(self)(error);
+			if (errorsAsArray) {
+				if (!store._llWideEvents) store._llWideEvents = {};
+				if (!store._llWideEvents[errorField]) store._llWideEvents[errorField] = [];
+				store._llWideEvents[errorField].push(serializedError);
+			} else withWideEventsImpl({ [errorField]: serializedError }, self);
+		}
+		return self;
+	}
+	/**
 	* Implementation for emitWideEvent
 	*/
 	function emitWideEventImpl(config, self) {
@@ -165,11 +184,9 @@ function createWideEventMixin(options) {
 		const wideEventData = {};
 		if (includeContext && store?._llContext) Object.assign(wideEventData, store._llContext);
 		if (store?._llWideEvents) Object.assign(wideEventData, store._llWideEvents);
-		if (config.metadata) Object.assign(wideEventData, config.metadata);
 		const level = config.level ?? "info";
 		const metadataToEmit = wideEventField ? { [wideEventField]: wideEventData } : wideEventData;
 		self.withMetadata(metadataToEmit)[level](config.message);
-		return self;
 	}
 	return {
 		mixinsToAdd: [{
@@ -187,6 +204,9 @@ function createWideEventMixin(options) {
 				prototype.emitWideEvent = function(config) {
 					return emitWideEventImpl(config, this);
 				};
+				prototype.withWideEventError = function(error) {
+					return withWideEventErrorImpl(error, this);
+				};
 			},
 			augmentMock: (prototype) => {
 				prototype.withWideEvents = function(data) {
@@ -201,11 +221,13 @@ function createWideEventMixin(options) {
 				prototype.emitWideEvent = function(config) {
 					return emitWideEventImpl(config, this);
 				};
+				prototype.withWideEventError = function(error) {
+					return withWideEventErrorImpl(error, this);
+				};
 			}
 		}],
 		pluginsToAdd: [contextTrackerPlugin]
 	};
 }
-
 //#endregion
-export { createWideEventMixin };
+export { createWideEventMixin };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@loglayer/mixin-wide-events",
   "description": "Adds wide event logging functionality to LogLayer for comprehensive, self-contained log entries.",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -32,22 +32,14 @@
     "wide-events",
     "canonical-log-lines"
   ],
-  "scripts": {
-    "build": "tsdown src/index.ts",
-    "test": "vitest --run",
-    "clean": "rm -rf .turbo node_modules dist",
-    "lint": "biome check --no-errors-on-unmatched --write --unsafe src",
-    "lint:staged": "biome check --no-errors-on-unmatched --write --unsafe --staged src",
-    "verify-types": "tsc --noEmit"
-  },
   "devDependencies": {
-    "@internal/tsconfig": "workspace:*",
-    "@loglayer/shared": "workspace:*",
-    "@types/node": "25.2.3",
-    "loglayer": "workspace:*",
-    "tsdown": "0.20.3",
-    "typescript": "5.9.3",
-    "vitest": "4.0.18"
+    "@types/node": "25.9.1",
+    "tsdown": "0.22.0",
+    "typescript": "6.0.3",
+    "vitest": "4.1.7",
+    "@loglayer/shared": "4.2.0",
+    "@internal/tsconfig": "2.1.0",
+    "loglayer": "9.2.0"
   },
   "peerDependencies": {},
   "bugs": "https://github.com/loglayer/loglayer/issues",
@@ -55,5 +47,12 @@
     "dist"
   ],
   "homepage": "https://loglayer.dev",
-  "packageManager": "pnpm@10.20.0"
-}
+  "scripts": {
+    "build": "tsdown src/index.ts",
+    "test": "vitest --run",
+    "clean": "rm -rf .turbo node_modules dist",
+    "lint": "biome check --no-errors-on-unmatched --write --unsafe src",
+    "lint:staged": "biome check --no-errors-on-unmatched --write --unsafe --staged src",
+    "verify-types": "tsc --noEmit"
+  }
+}