@richardmcquiston01/error-log-adapter 0.7.0 → 0.9.0

package/dist/index.d.cts

@@ -127,6 +127,15 @@ declare class WebhookErrorAdapter<TCode extends string = string> implements Erro
     /** @throws {RangeError} if `url` is not a valid `https://` URL (see `allowInsecure`) or a timeout, retry or signing option is invalid. */
     constructor(url: string, options?: WebhookErrorOptions);
     log(entry: ErrorLogEntry<TCode>): Promise<ErrorLogResult>;
+    /**
+     * Sends several entries in one request, as a JSON array of the same records
+     * `log` sends one at a time (each with an `id`). `BatchingErrorAdapter` uses
+     * this when it wraps a webhook, so the receiver must accept an array. The
+     * whole request succeeds or fails together.
+     */
+    logBatch(entries: ErrorLogEntry<TCode>[]): Promise<ErrorLogResult>;
+    /** Sends one prepared body, trying again as `retries` allows. */
+    private deliver;
     /** Milliseconds to wait before retry number `retryNumber` (1 for the first). */
     private retryWaitMs;
     private send;
@@ -1059,4 +1068,239 @@ declare class WebSocketErrorAdapter<TCode extends string = string> implements Er
     log(entry: ErrorLogEntry<TCode>): Promise<ErrorLogResult>;
 }
 
-export { type CollectionLike, CompositeErrorAdapter, type CompositeErrorOptions, ConsoleErrorAdapter, type ConsoleErrorOptions, type EmitterLike, type ErrorLogAdapter, type ErrorLogEntry, type ErrorLogResult, EventEmitterErrorAdapter, type EventEmitterErrorOptions, type EventEmitterErrorRecord, type FileSystemLike, type FirebaseErrorOptions, type FirebaseErrorRecord, type FirestoreCollectionLike, FirestoreErrorAdapter, FlatFileErrorAdapter, type FlatFileErrorOptions, type IdbDatabaseLike, type IdbObjectStoreLike, type IdbRequestLike, type IdbTransactionLike, type IdbUpgradeDatabaseLike, IndexedDbErrorAdapter, type IndexedDbErrorOptions, type IndexedDbErrorRecord, JsonFileErrorAdapter, type JsonFileErrorOptions, type JsonFileErrorRecord, type LockManagerLike, MongoDbErrorAdapter, type MongoDbErrorOptions, MySqlErrorAdapter, PostgresErrorAdapter, type ReadWriteFileSystemLike, RealtimeDatabaseErrorAdapter, type RealtimeDatabaseRefLike, type RedisClientLike, RedisErrorAdapter, type RedisErrorOptions, type S3BatchOptions, type S3ClientLike, S3ErrorAdapter, type S3ErrorOptions, type S3PutObjectInput, type SerializedErrorLogEntry, type SqlClientLike, type SqlDialect, type SqlErrorOptions, type SqliteClientLike, SqliteErrorAdapter, type SqliteErrorOptions, type StorageLike, type SupabaseClientLike, SupabaseErrorAdapter, type SupabaseErrorLike, type SupabaseErrorOptions, type SupabaseErrorRow, type SupabaseInsertResult, type SupabaseSetupOptions, WebSocketErrorAdapter, type WebSocketErrorOptions, type WebSocketLike, WebStorageErrorAdapter, type WebStorageErrorOptions, type WebStorageErrorRecord, WebhookErrorAdapter, type WebhookErrorOptions, buildCreateErrorLogTableSql, buildErrorLogTableDdl, buildMySqlWidenColumnsSql, buildSupabaseSetupSql, createErrorLogStore, formatErrorLogLine, serializeCause, serializeEntry };
+/** One event as `PutLogEvents` takes it. */
+interface CloudWatchLogEvent {
+    /** Milliseconds since the epoch. */
+    timestamp: number;
+    message: string;
+}
+/** The parameters this adapter passes to `putLogEvents`. */
+interface CloudWatchPutLogEventsInput {
+    logGroupName: string;
+    logStreamName: string;
+    logEvents: CloudWatchLogEvent[];
+}
+/**
+ * What an AWS SDK client needs to offer. The AWS SDK v3 aggregated client
+ * (`new CloudWatchLogs({ ... })` from `@aws-sdk/client-cloudwatch-logs`) fits as
+ * it is. `createLogGroup` and `createLogStream` are only used when
+ * `createMissing` is on (the default); leave them out of a hand-written client
+ * that cannot create them.
+ */
+interface CloudWatchLogsClientLike {
+    putLogEvents(input: CloudWatchPutLogEventsInput): Promise<unknown>;
+    createLogGroup?(input: {
+        logGroupName: string;
+    }): Promise<unknown>;
+    createLogStream?(input: {
+        logGroupName: string;
+        logStreamName: string;
+    }): Promise<unknown>;
+}
+interface CloudWatchBatchOptions {
+    /** Send once this many events are buffered. */
+    batchSize: number;
+    /**
+     * Also send when the oldest buffered event has waited this long (ms). The
+     * timer does not keep the process alive, so call `flush()` before exiting.
+     */
+    maxWaitMs?: number;
+}
+interface CloudWatchLogsErrorOptions {
+    /**
+     * Create the log stream, and the log group if that is missing too, when
+     * `PutLogEvents` says they do not exist, then try again once. This needs the
+     * `logs:CreateLogStream` (and `logs:CreateLogGroup`) permissions and only runs
+     * after a "not found" answer, so a stream that exists costs nothing. A group
+     * created this way never expires its logs; set a retention policy on it.
+     * Defaults to `true`.
+     */
+    createMissing?: boolean;
+    /**
+     * Buffer events and send them together, up to the 10,000 events and 1 MiB
+     * that one request allows. Off by default: one request per entry.
+     */
+    batch?: CloudWatchBatchOptions;
+    /** Text printed before failure messages. Defaults to `[error-log-adapter]`. */
+    prefix?: string;
+    /**
+     * How long a request may take before `log` (or `flush`) gives up waiting, in
+     * milliseconds. Defaults to 10000. Pass `Infinity` to wait without limit. The
+     * request cannot be cancelled, so it may still finish afterwards; in batch
+     * mode the events stay buffered and are sent again by the next flush.
+     */
+    timeoutMs?: number;
+}
+/**
+ * Sends entries to one CloudWatch Logs stream through `PutLogEvents`, each as a
+ * JSON event (the serialized entry plus its UUID `id`) stamped with the entry's
+ * time, so Logs Insights can query its fields. AWS no longer asks for sequence
+ * tokens, so none are tracked.
+ *
+ * By default each entry is its own request and `log` resolves once CloudWatch
+ * accepts it. With `batch`, events are buffered and sent together; `log` then
+ * resolves ok as soon as the event is buffered (it is not stored yet), except
+ * for the call that fills the batch, which resolves with the send result. Call
+ * `flush()` before shutting down.
+ *
+ * CloudWatch can answer ok and still reject events it considers too old (over
+ * 14 days) or too new (over 2 hours ahead); that is reported as `ok: false`. An
+ * event over 256 KiB is refused before sending, since CloudWatch would reject
+ * the whole request.
+ *
+ * In AWS Lambda, ECS and similar runtimes, anything written to stdout already
+ * reaches CloudWatch; this adapter is for apps running elsewhere.
+ */
+declare class CloudWatchLogsErrorAdapter<TCode extends string = string> implements ErrorLogAdapter<TCode> {
+    private readonly client;
+    private readonly logGroupName;
+    private readonly logStreamName;
+    private readonly createMissing;
+    private readonly batch;
+    private readonly logPrefix;
+    private readonly timeoutMs;
+    private buffer;
+    private timer;
+    private readonly flushQueue;
+    /** @throws {RangeError} if a name is empty, the batch or timeout options are invalid, or `createMissing` is on but the client cannot create streams. */
+    constructor(client: CloudWatchLogsClientLike, logGroupName: string, logStreamName: string, options?: CloudWatchLogsErrorOptions);
+    log(entry: ErrorLogEntry<TCode>): Promise<ErrorLogResult>;
+    /**
+     * Sends any buffered events now. Resolves ok when nothing is buffered. Events
+     * from a failed send stay buffered and are retried by the next flush.
+     */
+    flush(): Promise<ErrorLogResult>;
+    private addToBatch;
+    private scheduleFlush;
+    private sendBuffered;
+    /**
+     * Sends one request, creating the stream first if CloudWatch says it is
+     * missing. Resolves to a description of any events CloudWatch refused, or
+     * undefined when it took them all.
+     */
+    private send;
+    private putLogEvents;
+    private createStream;
+    private fail;
+}
+
+/**
+ * An adapter that can send several entries in one go, such as
+ * `WebhookErrorAdapter` (one request carrying a JSON array).
+ * `BatchingErrorAdapter` uses it when it is there. The whole batch succeeds or
+ * fails together.
+ */
+interface BatchCapableAdapter<TCode extends string = string> extends ErrorLogAdapter<TCode> {
+    logBatch(entries: ErrorLogEntry<TCode>[]): Promise<ErrorLogResult>;
+}
+interface BatchingErrorOptions<TCode extends string = string> {
+    /** Deliver once this many entries are waiting. Defaults to 20. */
+    batchSize?: number;
+    /**
+     * Also deliver once the oldest waiting entry has waited this long (ms).
+     * Defaults to 5000. Pass `Infinity` to deliver only when `batchSize` is
+     * reached or `flush()` is called. The timer does not keep the process alive,
+     * so call `flush()` before exiting.
+     */
+    maxWaitMs?: number;
+    /**
+     * How many times to try an entry again after a failed delivery before giving
+     * up on it. Defaults to 3 (four attempts in all).
+     */
+    retries?: number;
+    /** Wait before the first retry, in milliseconds; it doubles after that. Defaults to 500. */
+    retryDelayMs?: number;
+    /** Longest wait between attempts, in milliseconds. Defaults to 30000. */
+    maxRetryDelayMs?: number;
+    /**
+     * Most entries kept while the sink is slow or down. Past this, the oldest
+     * are dropped. Defaults to 1000. Must be at least `batchSize`.
+     */
+    maxBuffered?: number;
+    /**
+     * Use the wrapped adapter's `logBatch` when it has one. Defaults to `true`.
+     * Pass `false` to deliver one entry at a time even then (a wrapped
+     * `WebhookErrorAdapter` then sends one request per entry, not an array).
+     */
+    useBatchMethod?: boolean;
+    /**
+     * Called when entries are given up on, either because they failed every
+     * attempt or because the buffer was full. Errors it throws are ignored.
+     */
+    onDrop?: (entries: ErrorLogEntry<TCode>[], reason: string) => void;
+    /** Text printed before failure messages. Defaults to `[error-log-adapter]`. */
+    prefix?: string;
+}
+/**
+ * Puts a queue in front of any other adapter. `log()` returns `ok: true` as
+ * soon as the entry is queued, so a slow or failing sink never holds up the
+ * application; entries are then delivered in order, in batches, and a failed
+ * delivery is tried again with exponential backoff before the entry is given up
+ * on (see `onDrop`).
+ *
+ * Delivery uses the wrapped adapter's `logBatch` when it has one (the webhook
+ * sends one request for the whole batch); otherwise the entries go one at a
+ * time through `log`, stopping at the first failure so a sink that is down is
+ * not hammered. Because of that, `ok: true` from `log()` means "queued", not
+ * "stored": call `flush()` before the process exits, and watch `onDrop` or the
+ * console for entries that could not be delivered. The queue is in memory, so
+ * entries still waiting when the process dies are lost; put a durable adapter
+ * beside it in a `CompositeErrorAdapter` when that matters.
+ *
+ * ```ts
+ * const errorLog = new BatchingErrorAdapter(
+ *   new WebhookErrorAdapter('https://example.com/errors'),
+ *   { batchSize: 50, maxWaitMs: 2000 }
+ * );
+ * process.on('beforeExit', () => void errorLog.flush());
+ * ```
+ *
+ * Do not also turn on the wrapped adapter's own retries (for example the
+ * webhook's `retries`): the two multiply.
+ */
+declare class BatchingErrorAdapter<TCode extends string = string> implements ErrorLogAdapter<TCode> {
+    private readonly inner;
+    private readonly batchSize;
+    private readonly maxWaitMs;
+    private readonly retries;
+    private readonly retryDelayMs;
+    private readonly maxRetryDelayMs;
+    private readonly maxBuffered;
+    private readonly useBatchMethod;
+    private readonly onDrop;
+    private readonly logPrefix;
+    private queue;
+    private waitTimer;
+    private backoffTimer;
+    private draining;
+    private flushers;
+    private droppedSinceFlush;
+    private lastDropReason;
+    /** @throws {RangeError} if an option is out of range. */
+    constructor(inner: ErrorLogAdapter<TCode>, options?: BatchingErrorOptions<TCode>);
+    /** Queues the entry. Resolves ok straight away; delivery happens in the background. */
+    log(entry: ErrorLogEntry<TCode>): Promise<ErrorLogResult>;
+    /**
+     * Delivers everything queued, retrying as configured, and resolves once the
+     * queue is empty. Resolves `ok: false` if any entries were given up on since
+     * the last flush. With retries on and the sink down this can take a while
+     * (the waits add up to well over a minute with the defaults).
+     */
+    flush(): Promise<ErrorLogResult>;
+    private scheduleDrain;
+    private startDraining;
+    /** Delivers batches until the queue is empty, waiting out a backoff after each failure. */
+    private drain;
+    /**
+     * Tries to deliver `batch` (the front of the queue). Delivered entries leave
+     * the queue; an entry that failed has its failure count raised and stays.
+     * Resolves to the failure message, or undefined when everything went through.
+     */
+    private deliver;
+    /** The wrapped adapter should not throw, but a bug in one must not stop the queue. */
+    private safely;
+    private backoff;
+    private drop;
+}
+
+export { type BatchCapableAdapter, BatchingErrorAdapter, type BatchingErrorOptions, type CloudWatchBatchOptions, type CloudWatchLogEvent, type CloudWatchLogsClientLike, CloudWatchLogsErrorAdapter, type CloudWatchLogsErrorOptions, type CloudWatchPutLogEventsInput, type CollectionLike, CompositeErrorAdapter, type CompositeErrorOptions, ConsoleErrorAdapter, type ConsoleErrorOptions, type EmitterLike, type ErrorLogAdapter, type ErrorLogEntry, type ErrorLogResult, EventEmitterErrorAdapter, type EventEmitterErrorOptions, type EventEmitterErrorRecord, type FileSystemLike, type FirebaseErrorOptions, type FirebaseErrorRecord, type FirestoreCollectionLike, FirestoreErrorAdapter, FlatFileErrorAdapter, type FlatFileErrorOptions, type IdbDatabaseLike, type IdbObjectStoreLike, type IdbRequestLike, type IdbTransactionLike, type IdbUpgradeDatabaseLike, IndexedDbErrorAdapter, type IndexedDbErrorOptions, type IndexedDbErrorRecord, JsonFileErrorAdapter, type JsonFileErrorOptions, type JsonFileErrorRecord, type LockManagerLike, MongoDbErrorAdapter, type MongoDbErrorOptions, MySqlErrorAdapter, PostgresErrorAdapter, type ReadWriteFileSystemLike, RealtimeDatabaseErrorAdapter, type RealtimeDatabaseRefLike, type RedisClientLike, RedisErrorAdapter, type RedisErrorOptions, type S3BatchOptions, type S3ClientLike, S3ErrorAdapter, type S3ErrorOptions, type S3PutObjectInput, type SerializedErrorLogEntry, type SqlClientLike, type SqlDialect, type SqlErrorOptions, type SqliteClientLike, SqliteErrorAdapter, type SqliteErrorOptions, type StorageLike, type SupabaseClientLike, SupabaseErrorAdapter, type SupabaseErrorLike, type SupabaseErrorOptions, type SupabaseErrorRow, type SupabaseInsertResult, type SupabaseSetupOptions, WebSocketErrorAdapter, type WebSocketErrorOptions, type WebSocketLike, WebStorageErrorAdapter, type WebStorageErrorOptions, type WebStorageErrorRecord, WebhookErrorAdapter, type WebhookErrorOptions, buildCreateErrorLogTableSql, buildErrorLogTableDdl, buildMySqlWidenColumnsSql, buildSupabaseSetupSql, createErrorLogStore, formatErrorLogLine, serializeCause, serializeEntry };

package/dist/index.d.ts

@@ -127,6 +127,15 @@ declare class WebhookErrorAdapter<TCode extends string = string> implements Erro
     /** @throws {RangeError} if `url` is not a valid `https://` URL (see `allowInsecure`) or a timeout, retry or signing option is invalid. */
     constructor(url: string, options?: WebhookErrorOptions);
     log(entry: ErrorLogEntry<TCode>): Promise<ErrorLogResult>;
+    /**
+     * Sends several entries in one request, as a JSON array of the same records
+     * `log` sends one at a time (each with an `id`). `BatchingErrorAdapter` uses
+     * this when it wraps a webhook, so the receiver must accept an array. The
+     * whole request succeeds or fails together.
+     */
+    logBatch(entries: ErrorLogEntry<TCode>[]): Promise<ErrorLogResult>;
+    /** Sends one prepared body, trying again as `retries` allows. */
+    private deliver;
     /** Milliseconds to wait before retry number `retryNumber` (1 for the first). */
     private retryWaitMs;
     private send;
@@ -1059,4 +1068,239 @@ declare class WebSocketErrorAdapter<TCode extends string = string> implements Er
     log(entry: ErrorLogEntry<TCode>): Promise<ErrorLogResult>;
 }
 
-export { type CollectionLike, CompositeErrorAdapter, type CompositeErrorOptions, ConsoleErrorAdapter, type ConsoleErrorOptions, type EmitterLike, type ErrorLogAdapter, type ErrorLogEntry, type ErrorLogResult, EventEmitterErrorAdapter, type EventEmitterErrorOptions, type EventEmitterErrorRecord, type FileSystemLike, type FirebaseErrorOptions, type FirebaseErrorRecord, type FirestoreCollectionLike, FirestoreErrorAdapter, FlatFileErrorAdapter, type FlatFileErrorOptions, type IdbDatabaseLike, type IdbObjectStoreLike, type IdbRequestLike, type IdbTransactionLike, type IdbUpgradeDatabaseLike, IndexedDbErrorAdapter, type IndexedDbErrorOptions, type IndexedDbErrorRecord, JsonFileErrorAdapter, type JsonFileErrorOptions, type JsonFileErrorRecord, type LockManagerLike, MongoDbErrorAdapter, type MongoDbErrorOptions, MySqlErrorAdapter, PostgresErrorAdapter, type ReadWriteFileSystemLike, RealtimeDatabaseErrorAdapter, type RealtimeDatabaseRefLike, type RedisClientLike, RedisErrorAdapter, type RedisErrorOptions, type S3BatchOptions, type S3ClientLike, S3ErrorAdapter, type S3ErrorOptions, type S3PutObjectInput, type SerializedErrorLogEntry, type SqlClientLike, type SqlDialect, type SqlErrorOptions, type SqliteClientLike, SqliteErrorAdapter, type SqliteErrorOptions, type StorageLike, type SupabaseClientLike, SupabaseErrorAdapter, type SupabaseErrorLike, type SupabaseErrorOptions, type SupabaseErrorRow, type SupabaseInsertResult, type SupabaseSetupOptions, WebSocketErrorAdapter, type WebSocketErrorOptions, type WebSocketLike, WebStorageErrorAdapter, type WebStorageErrorOptions, type WebStorageErrorRecord, WebhookErrorAdapter, type WebhookErrorOptions, buildCreateErrorLogTableSql, buildErrorLogTableDdl, buildMySqlWidenColumnsSql, buildSupabaseSetupSql, createErrorLogStore, formatErrorLogLine, serializeCause, serializeEntry };
+/** One event as `PutLogEvents` takes it. */
+interface CloudWatchLogEvent {
+    /** Milliseconds since the epoch. */
+    timestamp: number;
+    message: string;
+}
+/** The parameters this adapter passes to `putLogEvents`. */
+interface CloudWatchPutLogEventsInput {
+    logGroupName: string;
+    logStreamName: string;
+    logEvents: CloudWatchLogEvent[];
+}
+/**
+ * What an AWS SDK client needs to offer. The AWS SDK v3 aggregated client
+ * (`new CloudWatchLogs({ ... })` from `@aws-sdk/client-cloudwatch-logs`) fits as
+ * it is. `createLogGroup` and `createLogStream` are only used when
+ * `createMissing` is on (the default); leave them out of a hand-written client
+ * that cannot create them.
+ */
+interface CloudWatchLogsClientLike {
+    putLogEvents(input: CloudWatchPutLogEventsInput): Promise<unknown>;
+    createLogGroup?(input: {
+        logGroupName: string;
+    }): Promise<unknown>;
+    createLogStream?(input: {
+        logGroupName: string;
+        logStreamName: string;
+    }): Promise<unknown>;
+}
+interface CloudWatchBatchOptions {
+    /** Send once this many events are buffered. */
+    batchSize: number;
+    /**
+     * Also send when the oldest buffered event has waited this long (ms). The
+     * timer does not keep the process alive, so call `flush()` before exiting.
+     */
+    maxWaitMs?: number;
+}
+interface CloudWatchLogsErrorOptions {
+    /**
+     * Create the log stream, and the log group if that is missing too, when
+     * `PutLogEvents` says they do not exist, then try again once. This needs the
+     * `logs:CreateLogStream` (and `logs:CreateLogGroup`) permissions and only runs
+     * after a "not found" answer, so a stream that exists costs nothing. A group
+     * created this way never expires its logs; set a retention policy on it.
+     * Defaults to `true`.
+     */
+    createMissing?: boolean;
+    /**
+     * Buffer events and send them together, up to the 10,000 events and 1 MiB
+     * that one request allows. Off by default: one request per entry.
+     */
+    batch?: CloudWatchBatchOptions;
+    /** Text printed before failure messages. Defaults to `[error-log-adapter]`. */
+    prefix?: string;
+    /**
+     * How long a request may take before `log` (or `flush`) gives up waiting, in
+     * milliseconds. Defaults to 10000. Pass `Infinity` to wait without limit. The
+     * request cannot be cancelled, so it may still finish afterwards; in batch
+     * mode the events stay buffered and are sent again by the next flush.
+     */
+    timeoutMs?: number;
+}
+/**
+ * Sends entries to one CloudWatch Logs stream through `PutLogEvents`, each as a
+ * JSON event (the serialized entry plus its UUID `id`) stamped with the entry's
+ * time, so Logs Insights can query its fields. AWS no longer asks for sequence
+ * tokens, so none are tracked.
+ *
+ * By default each entry is its own request and `log` resolves once CloudWatch
+ * accepts it. With `batch`, events are buffered and sent together; `log` then
+ * resolves ok as soon as the event is buffered (it is not stored yet), except
+ * for the call that fills the batch, which resolves with the send result. Call
+ * `flush()` before shutting down.
+ *
+ * CloudWatch can answer ok and still reject events it considers too old (over
+ * 14 days) or too new (over 2 hours ahead); that is reported as `ok: false`. An
+ * event over 256 KiB is refused before sending, since CloudWatch would reject
+ * the whole request.
+ *
+ * In AWS Lambda, ECS and similar runtimes, anything written to stdout already
+ * reaches CloudWatch; this adapter is for apps running elsewhere.
+ */
+declare class CloudWatchLogsErrorAdapter<TCode extends string = string> implements ErrorLogAdapter<TCode> {
+    private readonly client;
+    private readonly logGroupName;
+    private readonly logStreamName;
+    private readonly createMissing;
+    private readonly batch;
+    private readonly logPrefix;
+    private readonly timeoutMs;
+    private buffer;
+    private timer;
+    private readonly flushQueue;
+    /** @throws {RangeError} if a name is empty, the batch or timeout options are invalid, or `createMissing` is on but the client cannot create streams. */
+    constructor(client: CloudWatchLogsClientLike, logGroupName: string, logStreamName: string, options?: CloudWatchLogsErrorOptions);
+    log(entry: ErrorLogEntry<TCode>): Promise<ErrorLogResult>;
+    /**
+     * Sends any buffered events now. Resolves ok when nothing is buffered. Events
+     * from a failed send stay buffered and are retried by the next flush.
+     */
+    flush(): Promise<ErrorLogResult>;
+    private addToBatch;
+    private scheduleFlush;
+    private sendBuffered;
+    /**
+     * Sends one request, creating the stream first if CloudWatch says it is
+     * missing. Resolves to a description of any events CloudWatch refused, or
+     * undefined when it took them all.
+     */
+    private send;
+    private putLogEvents;
+    private createStream;
+    private fail;
+}
+
+/**
+ * An adapter that can send several entries in one go, such as
+ * `WebhookErrorAdapter` (one request carrying a JSON array).
+ * `BatchingErrorAdapter` uses it when it is there. The whole batch succeeds or
+ * fails together.
+ */
+interface BatchCapableAdapter<TCode extends string = string> extends ErrorLogAdapter<TCode> {
+    logBatch(entries: ErrorLogEntry<TCode>[]): Promise<ErrorLogResult>;
+}
+interface BatchingErrorOptions<TCode extends string = string> {
+    /** Deliver once this many entries are waiting. Defaults to 20. */
+    batchSize?: number;
+    /**
+     * Also deliver once the oldest waiting entry has waited this long (ms).
+     * Defaults to 5000. Pass `Infinity` to deliver only when `batchSize` is
+     * reached or `flush()` is called. The timer does not keep the process alive,
+     * so call `flush()` before exiting.
+     */
+    maxWaitMs?: number;
+    /**
+     * How many times to try an entry again after a failed delivery before giving
+     * up on it. Defaults to 3 (four attempts in all).
+     */
+    retries?: number;
+    /** Wait before the first retry, in milliseconds; it doubles after that. Defaults to 500. */
+    retryDelayMs?: number;
+    /** Longest wait between attempts, in milliseconds. Defaults to 30000. */
+    maxRetryDelayMs?: number;
+    /**
+     * Most entries kept while the sink is slow or down. Past this, the oldest
+     * are dropped. Defaults to 1000. Must be at least `batchSize`.
+     */
+    maxBuffered?: number;
+    /**
+     * Use the wrapped adapter's `logBatch` when it has one. Defaults to `true`.
+     * Pass `false` to deliver one entry at a time even then (a wrapped
+     * `WebhookErrorAdapter` then sends one request per entry, not an array).
+     */
+    useBatchMethod?: boolean;
+    /**
+     * Called when entries are given up on, either because they failed every
+     * attempt or because the buffer was full. Errors it throws are ignored.
+     */
+    onDrop?: (entries: ErrorLogEntry<TCode>[], reason: string) => void;
+    /** Text printed before failure messages. Defaults to `[error-log-adapter]`. */
+    prefix?: string;
+}
+/**
+ * Puts a queue in front of any other adapter. `log()` returns `ok: true` as
+ * soon as the entry is queued, so a slow or failing sink never holds up the
+ * application; entries are then delivered in order, in batches, and a failed
+ * delivery is tried again with exponential backoff before the entry is given up
+ * on (see `onDrop`).
+ *
+ * Delivery uses the wrapped adapter's `logBatch` when it has one (the webhook
+ * sends one request for the whole batch); otherwise the entries go one at a
+ * time through `log`, stopping at the first failure so a sink that is down is
+ * not hammered. Because of that, `ok: true` from `log()` means "queued", not
+ * "stored": call `flush()` before the process exits, and watch `onDrop` or the
+ * console for entries that could not be delivered. The queue is in memory, so
+ * entries still waiting when the process dies are lost; put a durable adapter
+ * beside it in a `CompositeErrorAdapter` when that matters.
+ *
+ * ```ts
+ * const errorLog = new BatchingErrorAdapter(
+ *   new WebhookErrorAdapter('https://example.com/errors'),
+ *   { batchSize: 50, maxWaitMs: 2000 }
+ * );
+ * process.on('beforeExit', () => void errorLog.flush());
+ * ```
+ *
+ * Do not also turn on the wrapped adapter's own retries (for example the
+ * webhook's `retries`): the two multiply.
+ */
+declare class BatchingErrorAdapter<TCode extends string = string> implements ErrorLogAdapter<TCode> {
+    private readonly inner;
+    private readonly batchSize;
+    private readonly maxWaitMs;
+    private readonly retries;
+    private readonly retryDelayMs;
+    private readonly maxRetryDelayMs;
+    private readonly maxBuffered;
+    private readonly useBatchMethod;
+    private readonly onDrop;
+    private readonly logPrefix;
+    private queue;
+    private waitTimer;
+    private backoffTimer;
+    private draining;
+    private flushers;
+    private droppedSinceFlush;
+    private lastDropReason;
+    /** @throws {RangeError} if an option is out of range. */
+    constructor(inner: ErrorLogAdapter<TCode>, options?: BatchingErrorOptions<TCode>);
+    /** Queues the entry. Resolves ok straight away; delivery happens in the background. */
+    log(entry: ErrorLogEntry<TCode>): Promise<ErrorLogResult>;
+    /**
+     * Delivers everything queued, retrying as configured, and resolves once the
+     * queue is empty. Resolves `ok: false` if any entries were given up on since
+     * the last flush. With retries on and the sink down this can take a while
+     * (the waits add up to well over a minute with the defaults).
+     */
+    flush(): Promise<ErrorLogResult>;
+    private scheduleDrain;
+    private startDraining;
+    /** Delivers batches until the queue is empty, waiting out a backoff after each failure. */
+    private drain;
+    /**
+     * Tries to deliver `batch` (the front of the queue). Delivered entries leave
+     * the queue; an entry that failed has its failure count raised and stays.
+     * Resolves to the failure message, or undefined when everything went through.
+     */
+    private deliver;
+    /** The wrapped adapter should not throw, but a bug in one must not stop the queue. */
+    private safely;
+    private backoff;
+    private drop;
+}
+
+export { type BatchCapableAdapter, BatchingErrorAdapter, type BatchingErrorOptions, type CloudWatchBatchOptions, type CloudWatchLogEvent, type CloudWatchLogsClientLike, CloudWatchLogsErrorAdapter, type CloudWatchLogsErrorOptions, type CloudWatchPutLogEventsInput, type CollectionLike, CompositeErrorAdapter, type CompositeErrorOptions, ConsoleErrorAdapter, type ConsoleErrorOptions, type EmitterLike, type ErrorLogAdapter, type ErrorLogEntry, type ErrorLogResult, EventEmitterErrorAdapter, type EventEmitterErrorOptions, type EventEmitterErrorRecord, type FileSystemLike, type FirebaseErrorOptions, type FirebaseErrorRecord, type FirestoreCollectionLike, FirestoreErrorAdapter, FlatFileErrorAdapter, type FlatFileErrorOptions, type IdbDatabaseLike, type IdbObjectStoreLike, type IdbRequestLike, type IdbTransactionLike, type IdbUpgradeDatabaseLike, IndexedDbErrorAdapter, type IndexedDbErrorOptions, type IndexedDbErrorRecord, JsonFileErrorAdapter, type JsonFileErrorOptions, type JsonFileErrorRecord, type LockManagerLike, MongoDbErrorAdapter, type MongoDbErrorOptions, MySqlErrorAdapter, PostgresErrorAdapter, type ReadWriteFileSystemLike, RealtimeDatabaseErrorAdapter, type RealtimeDatabaseRefLike, type RedisClientLike, RedisErrorAdapter, type RedisErrorOptions, type S3BatchOptions, type S3ClientLike, S3ErrorAdapter, type S3ErrorOptions, type S3PutObjectInput, type SerializedErrorLogEntry, type SqlClientLike, type SqlDialect, type SqlErrorOptions, type SqliteClientLike, SqliteErrorAdapter, type SqliteErrorOptions, type StorageLike, type SupabaseClientLike, SupabaseErrorAdapter, type SupabaseErrorLike, type SupabaseErrorOptions, type SupabaseErrorRow, type SupabaseInsertResult, type SupabaseSetupOptions, WebSocketErrorAdapter, type WebSocketErrorOptions, type WebSocketLike, WebStorageErrorAdapter, type WebStorageErrorOptions, type WebStorageErrorRecord, WebhookErrorAdapter, type WebhookErrorOptions, buildCreateErrorLogTableSql, buildErrorLogTableDdl, buildMySqlWidenColumnsSql, buildSupabaseSetupSql, createErrorLogStore, formatErrorLogLine, serializeCause, serializeEntry };