@usebetterdev/audit-core 0.5.0-beta.1 → 0.6.0

package/dist/index.cjs

@@ -25,6 +25,7 @@ __export(index_exports, {
   betterAudit: () => betterAudit,
   createAuditApi: () => createAuditApi,
   createAuditConsoleEndpoints: () => createAuditConsoleEndpoints,
+  createExportResponse: () => createExportResponse,
   fromBearerToken: () => fromBearerToken,
   fromCookie: () => fromCookie,
   fromHeader: () => fromHeader,
@@ -1159,6 +1160,65 @@ function createAuditConsoleEndpoints(api) {
   ];
 }
 
+// src/export-response.ts
+function contentTypeForFormat(format, jsonStyle) {
+  if (format === "csv") {
+    return "text/csv; charset=utf-8";
+  }
+  if (jsonStyle === "ndjson") {
+    return "application/x-ndjson; charset=utf-8";
+  }
+  return "application/json; charset=utf-8";
+}
+function fileExtensionForFormat(format, jsonStyle) {
+  if (format === "csv") {
+    return ".csv";
+  }
+  if (jsonStyle === "ndjson") {
+    return ".ndjson";
+  }
+  return ".json";
+}
+function formatDate(date) {
+  const year = date.getFullYear();
+  const month = String(date.getMonth() + 1).padStart(2, "0");
+  const day = String(date.getDate()).padStart(2, "0");
+  return `${year}-${month}-${day}`;
+}
+function sanitiseFilename(name) {
+  return name.replace(/["\\\r\n\x00-\x1f]/g, "");
+}
+function createExportResponse(executor, options = {}) {
+  const format = options.format ?? "csv";
+  const jsonStyle = options.jsonStyle ?? "ndjson";
+  const stem = options.filename ?? `audit-export-${formatDate(/* @__PURE__ */ new Date())}`;
+  const extension = fileExtensionForFormat(format, jsonStyle);
+  const fullFilename = sanitiseFilename(`${stem}${extension}`);
+  const contentType = contentTypeForFormat(format, jsonStyle);
+  const transform = new TransformStream();
+  const encoder = new TextEncoderStream();
+  const readable = transform.readable.pipeThrough(encoder);
+  runExport(executor, {
+    format,
+    jsonStyle,
+    output: transform.writable,
+    ...options.batchSize !== void 0 && { batchSize: options.batchSize },
+    ...options.csvDelimiter !== void 0 && {
+      csvDelimiter: options.csvDelimiter
+    },
+    ...options.query !== void 0 && { query: options.query }
+  }).catch(() => {
+  });
+  return new Response(readable, {
+    status: 200,
+    headers: {
+      "Content-Type": contentType,
+      "Content-Disposition": `attachment; filename="${fullFilename}"`,
+      "Cache-Control": "no-cache"
+    }
+  });
+}
+
 // src/retention.ts
 function validateRetentionPolicy(policy) {
   if (!Number.isInteger(policy.days) || !Number.isFinite(policy.days) || policy.days <= 0) {
@@ -1183,6 +1243,11 @@ function betterAudit(config) {
   if (config.retention !== void 0) {
     validateRetentionPolicy(config.retention);
   }
+  if (config.asyncWrite === true && config.onError === void 0) {
+    console.warn(
+      "audit: asyncWrite is enabled without onError \u2014 write failures will only log to console.error. Set onError to route failures to your error tracking system."
+    );
+  }
   const { database } = config;
   const auditTables = new Set(config.auditTables);
   if (config.retention?.tables !== void 0) {
@@ -1323,6 +1388,15 @@ function betterAudit(config) {
     const queryLogs = database.queryLogs;
     return runExport((spec) => queryLogs(spec), options);
   }
+  function exportResponse(options) {
+    if (database.queryLogs === void 0) {
+      throw new Error(
+        "audit.exportResponse() requires a database adapter that implements queryLogs(). Check that your ORM adapter supports querying."
+      );
+    }
+    const queryLogs = database.queryLogs;
+    return createExportResponse((spec) => queryLogs(spec), options);
+  }
   if (config.console) {
     const api = createAuditApi(database, registry, config.maxQueryLimit);
     const endpoints = createAuditConsoleEndpoints(api);
@@ -1332,7 +1406,7 @@ function betterAudit(config) {
       endpoints
     });
   }
-  return { captureLog, query, export: exportLogs, withContext, enrich, onBeforeLog, onAfterLog, retentionPolicy };
+  return { captureLog, query, export: exportLogs, exportResponse, withContext, enrich, onBeforeLog, onAfterLog, retentionPolicy };
 }
 
 // src/audit-log-schema.ts
@@ -1541,6 +1615,7 @@ async function handleMiddleware(extractor, request, next, options = {}) {
   betterAudit,
   createAuditApi,
   createAuditConsoleEndpoints,
+  createExportResponse,
   fromBearerToken,
   fromCookie,
   fromHeader,