@richardmcquiston01/error-log-adapter 0.9.0 → 0.10.0

package/dist/index.d.cts

@@ -802,9 +802,16 @@ interface FirebaseErrorRecord {
  */
 interface FirestoreCollectionLike {
     doc(documentId: string): {
-        set(data: FirebaseErrorRecord): Promise<unknown>;
+        set(data: FirestoreErrorRecord): Promise<unknown>;
     };
 }
+/**
+ * What the Firestore adapter writes: the usual fields, plus the expiry field
+ * (a `Date`, which Firestore stores as a timestamp) when `expireAfterMs` is set.
+ */
+type FirestoreErrorRecord = FirebaseErrorRecord & {
+    [field: string]: unknown;
+};
 /**
  * The only thing the Realtime Database adapter needs from a reference:
  * `push(value)`, which resolves once the write is saved. A `firebase-admin`
@@ -843,6 +850,25 @@ interface FirebaseErrorOptions {
     /** Text printed before failure messages. Defaults to `[error-log-adapter]`. */
     prefix?: string;
 }
+interface FirestoreErrorOptions extends FirebaseErrorOptions {
+    /**
+     * Add an expiry time to every document: the entry's `timestamp` plus this
+     * many milliseconds, stored as a Firestore timestamp in `expireField`. This
+     * only writes the field. Firestore deletes nothing until you turn on a TTL
+     * policy for that field, for example:
+     *
+     * ```sh
+     * gcloud firestore fields ttls update expire_at \
+     *   --collection-group=error_log --enable-ttl
+     * ```
+     *
+     * Firestore then removes documents some time after they expire (typically
+     * within a day), and the deletes are billed like any other. Off by default.
+     */
+    expireAfterMs?: number;
+    /** Name of the expiry field. Defaults to `expire_at`. Only used with `expireAfterMs`. */
+    expireField?: string;
+}
 /**
  * Writes each entry as a document in a Firestore collection. The document id is
  * the entry's UUID, so the SDK finishing one queued write twice cannot create two
@@ -855,8 +881,10 @@ declare class FirestoreErrorAdapter<TCode extends string = string> implements Er
     private readonly collection;
     private readonly prefix;
     private readonly timeoutMs;
-    /** @throws {RangeError} if `options.timeoutMs` is not a positive number or `Infinity`. */
-    constructor(collection: FirestoreCollectionLike, options?: FirebaseErrorOptions);
+    private readonly expireAfterMs;
+    private readonly expireField;
+    /** @throws {RangeError} if `options.timeoutMs` is not a positive number or `Infinity`, or the expiry options are invalid. */
+    constructor(collection: FirestoreCollectionLike, options?: FirestoreErrorOptions);
     log(entry: ErrorLogEntry<TCode>): Promise<ErrorLogResult>;
 }
 /**
@@ -1303,4 +1331,4 @@ declare class BatchingErrorAdapter<TCode extends string = string> implements Err
     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 };
+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, type FirestoreErrorOptions, type FirestoreErrorRecord, 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

@@ -802,9 +802,16 @@ interface FirebaseErrorRecord {
  */
 interface FirestoreCollectionLike {
     doc(documentId: string): {
-        set(data: FirebaseErrorRecord): Promise<unknown>;
+        set(data: FirestoreErrorRecord): Promise<unknown>;
     };
 }
+/**
+ * What the Firestore adapter writes: the usual fields, plus the expiry field
+ * (a `Date`, which Firestore stores as a timestamp) when `expireAfterMs` is set.
+ */
+type FirestoreErrorRecord = FirebaseErrorRecord & {
+    [field: string]: unknown;
+};
 /**
  * The only thing the Realtime Database adapter needs from a reference:
  * `push(value)`, which resolves once the write is saved. A `firebase-admin`
@@ -843,6 +850,25 @@ interface FirebaseErrorOptions {
     /** Text printed before failure messages. Defaults to `[error-log-adapter]`. */
     prefix?: string;
 }
+interface FirestoreErrorOptions extends FirebaseErrorOptions {
+    /**
+     * Add an expiry time to every document: the entry's `timestamp` plus this
+     * many milliseconds, stored as a Firestore timestamp in `expireField`. This
+     * only writes the field. Firestore deletes nothing until you turn on a TTL
+     * policy for that field, for example:
+     *
+     * ```sh
+     * gcloud firestore fields ttls update expire_at \
+     *   --collection-group=error_log --enable-ttl
+     * ```
+     *
+     * Firestore then removes documents some time after they expire (typically
+     * within a day), and the deletes are billed like any other. Off by default.
+     */
+    expireAfterMs?: number;
+    /** Name of the expiry field. Defaults to `expire_at`. Only used with `expireAfterMs`. */
+    expireField?: string;
+}
 /**
  * Writes each entry as a document in a Firestore collection. The document id is
  * the entry's UUID, so the SDK finishing one queued write twice cannot create two
@@ -855,8 +881,10 @@ declare class FirestoreErrorAdapter<TCode extends string = string> implements Er
     private readonly collection;
     private readonly prefix;
     private readonly timeoutMs;
-    /** @throws {RangeError} if `options.timeoutMs` is not a positive number or `Infinity`. */
-    constructor(collection: FirestoreCollectionLike, options?: FirebaseErrorOptions);
+    private readonly expireAfterMs;
+    private readonly expireField;
+    /** @throws {RangeError} if `options.timeoutMs` is not a positive number or `Infinity`, or the expiry options are invalid. */
+    constructor(collection: FirestoreCollectionLike, options?: FirestoreErrorOptions);
     log(entry: ErrorLogEntry<TCode>): Promise<ErrorLogResult>;
 }
 /**
@@ -1303,4 +1331,4 @@ declare class BatchingErrorAdapter<TCode extends string = string> implements Err
     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 };
+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, type FirestoreErrorOptions, type FirestoreErrorRecord, 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.mjs

@@ -1574,6 +1574,15 @@ var S3ErrorAdapter = class {
 };
 
 // src/adapters/firebase-error-adapter.ts
+var DEFAULT_EXPIRE_FIELD = "expire_at";
+var RESERVED_FIELDS = /* @__PURE__ */ new Set([
+  "id",
+  "code",
+  "message",
+  "timestamp",
+  "source",
+  "cause"
+]);
 function waitForWrite(start, timeoutMs) {
   return withTimeout(
     start,
@@ -1598,7 +1607,7 @@ function buildRecord(entry) {
   return record;
 }
 var FirestoreErrorAdapter = class {
-  /** @throws {RangeError} if `options.timeoutMs` is not a positive number or `Infinity`. */
+  /** @throws {RangeError} if `options.timeoutMs` is not a positive number or `Infinity`, or the expiry options are invalid. */
   constructor(collection, options = {}) {
     this.collection = collection;
     this.prefix = options.prefix ?? DEFAULT_PREFIX;
@@ -1606,10 +1615,31 @@ var FirestoreErrorAdapter = class {
       options.timeoutMs,
       "FirestoreErrorAdapter"
     );
+    this.expireAfterMs = options.expireAfterMs;
+    this.expireField = options.expireField ?? DEFAULT_EXPIRE_FIELD;
+    if (this.expireAfterMs !== void 0 && (!Number.isFinite(this.expireAfterMs) || this.expireAfterMs <= 0)) {
+      throw new RangeError(
+        `FirestoreErrorAdapter: expireAfterMs must be a positive number of milliseconds, received ${String(options.expireAfterMs)}.`
+      );
+    }
+    if (this.expireField === "" || /[./]/.test(this.expireField) || RESERVED_FIELDS.has(this.expireField)) {
+      throw new RangeError(
+        `FirestoreErrorAdapter: expireField must be a name other than ${[...RESERVED_FIELDS].join(", ")}, without "." or "/", received ${JSON.stringify(this.expireField)}.`
+      );
+    }
   }
   async log(entry) {
     try {
-      const record = buildRecord(entry);
+      const record = { ...buildRecord(entry) };
+      if (this.expireAfterMs !== void 0) {
+        const occurredAt = Date.parse(record.timestamp);
+        if (Number.isNaN(occurredAt)) {
+          throw new RangeError(
+            `timestamp "${record.timestamp}" is not a valid ISO 8601 date, so the expiry time cannot be worked out`
+          );
+        }
+        record[this.expireField] = new Date(occurredAt + this.expireAfterMs);
+      }
       await waitForWrite(
         () => this.collection.doc(record.id).set(record),
         this.timeoutMs