@visulima/pail 4.0.2 → 4.1.0

package/dist/packem_shared/abstract-json-reporter.d-B6NoO-hG.d.ts

@@ -0,0 +1,61 @@
+import { s as stringify } from "./index.d-T71KjNAr.js";
+import { R as ReadonlyMeta, E as ExtendedRfc5424LogLevels, L as LiteralUnion, S as StringifyAwareReporter } from "./types.d-4ge_rME4.js";
+/**
+ * Options for configuring JSON reporters.
+ */
+type AbstractJsonReporterOptions = {
+  /** Error serialization options */
+  error: Partial<{
+    /** Properties to exclude from error serialization */
+    exclude?: string[];
+    /** Maximum depth for error object serialization */
+    maxDepth?: number;
+    /** Whether to use toJSON methods during serialization */
+    useToJSON?: boolean;
+  }>;
+};
+/**
+ * Abstract JSON Reporter.
+ *
+ * Base class for JSON-based reporters that provides common functionality
+ * for serializing log metadata to JSON format. Handles error serialization,
+ * context processing, and provides a template method for actual output.
+ * @template L - The log level type
+ * @example
+ * ```typescript
+ * class CustomJsonReporter extends AbstractJsonReporter {
+ *   protected _log(message: string): void {
+ *     console.log(message);
+ *   }
+ * }
+ * ```
+ */
+declare abstract class AbstractJsonReporter<L extends string = string> implements StringifyAwareReporter<L> {
+  /** Custom stringify function for object serialization */
+  protected stringify: typeof stringify | undefined;
+  /** Error serialization options */
+  protected errorOptions: AbstractJsonReporterOptions["error"];
+  /**
+   * Creates a new AbstractJsonReporter instance.
+   * @param options Configuration options for JSON formatting and error handling
+   */
+  constructor(options?: Partial<AbstractJsonReporterOptions>);
+  /**
+   * Sets a custom stringify function for object serialization.
+   * @param function_ The stringify function to use for serialization
+   */
+  setStringify(function_: typeof stringify): void;
+  log(meta: ReadonlyMeta<L>): void;
+  /**
+   * Template method for outputting the JSON log message.
+   *
+   * Subclasses must implement this method to define how the JSON message
+   * is actually written (to console, file, network, etc.).
+   * @param message The JSON-formatted log message
+   * @param logLevel The log level of the message
+   * @protected
+   * @abstract
+   */
+  protected abstract _log(message: string, logLevel: LiteralUnion<ExtendedRfc5424LogLevels, L>): void;
+}
+export { AbstractJsonReporterOptions as A, AbstractJsonReporter as a };