@airdraft/plugin-audit-log 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+All notable changes to `@airdraft/plugin-audit-log` will be documented here.
+
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { withAuditLog } from './withAuditLog.js';
+export { consolePersister, filePersister, compositePersister } from './persisters.js';
+export type { AuditLogOptions, AuditPersister } from './withAuditLog.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACrF,YAAY,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { withAuditLog } from './withAuditLog.js';
+export { consolePersister, filePersister, compositePersister } from './persisters.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA"}

package/dist/persisters.d.ts

@@ -0,0 +1,36 @@
+import type { AuditPersister } from './withAuditLog.js';
+/**
+ * Logs each audit event as a compact JSON line to stdout.
+ * This is the default persister when no `persist` option is provided.
+ */
+export declare const consolePersister: AuditPersister;
+/**
+ * Appends audit events as newline-delimited JSON (NDJSON) to a file.
+ * The file is created if it does not exist. Each line is one JSON event.
+ *
+ * Compatible with tools like `jq`, `grep`, and log shippers (Loki, Datadog, etc.).
+ *
+ * @param filePath Absolute or cwd-relative path to the log file.
+ *
+ * @example
+ * ```ts
+ * withAuditLog({ persist: filePersister(process.cwd() + '/logs/audit.log') })
+ * ```
+ */
+export declare function filePersister(filePath: string): AuditPersister;
+/**
+ * Calls multiple persisters in sequence. Use when you want both console
+ * output and file persistence simultaneously.
+ *
+ * @example
+ * ```ts
+ * withAuditLog({
+ *   persist: compositePersister(
+ *     consolePersister,
+ *     filePersister('./logs/audit.log'),
+ *   ),
+ * })
+ * ```
+ */
+export declare function compositePersister(...persisters: AuditPersister[]): AuditPersister;
+//# sourceMappingURL=persisters.d.ts.map

package/dist/persisters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"persisters.d.ts","sourceRoot":"","sources":["../src/persisters.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAEvD;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE,cAE9B,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc,CAK9D;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,UAAU,EAAE,cAAc,EAAE,GAAG,cAAc,CAMlF"}

package/dist/persisters.js

@@ -0,0 +1,50 @@
+import { appendFile, mkdir } from 'node:fs/promises';
+import { dirname } from 'node:path';
+/**
+ * Logs each audit event as a compact JSON line to stdout.
+ * This is the default persister when no `persist` option is provided.
+ */
+export const consolePersister = (event) => {
+    console.log(JSON.stringify(event));
+};
+/**
+ * Appends audit events as newline-delimited JSON (NDJSON) to a file.
+ * The file is created if it does not exist. Each line is one JSON event.
+ *
+ * Compatible with tools like `jq`, `grep`, and log shippers (Loki, Datadog, etc.).
+ *
+ * @param filePath Absolute or cwd-relative path to the log file.
+ *
+ * @example
+ * ```ts
+ * withAuditLog({ persist: filePersister(process.cwd() + '/logs/audit.log') })
+ * ```
+ */
+export function filePersister(filePath) {
+    return async (event) => {
+        await mkdir(dirname(filePath), { recursive: true });
+        await appendFile(filePath, JSON.stringify(event) + '\n', 'utf8');
+    };
+}
+/**
+ * Calls multiple persisters in sequence. Use when you want both console
+ * output and file persistence simultaneously.
+ *
+ * @example
+ * ```ts
+ * withAuditLog({
+ *   persist: compositePersister(
+ *     consolePersister,
+ *     filePersister('./logs/audit.log'),
+ *   ),
+ * })
+ * ```
+ */
+export function compositePersister(...persisters) {
+    return async (event) => {
+        for (const persist of persisters) {
+            await persist(event);
+        }
+    };
+}
+//# sourceMappingURL=persisters.js.map

package/dist/persisters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"persisters.js","sourceRoot":"","sources":["../src/persisters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAInC;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAmB,CAAC,KAAiB,EAAQ,EAAE;IAC1E,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;AACpC,CAAC,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,aAAa,CAAC,QAAgB;IAC5C,OAAO,KAAK,EAAE,KAAiB,EAAiB,EAAE;QAChD,MAAM,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QACnD,MAAM,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,CAAA;IAClE,CAAC,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAAG,UAA4B;IAChE,OAAO,KAAK,EAAE,KAAiB,EAAiB,EAAE;QAChD,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE,CAAC;YACjC,MAAM,OAAO,CAAC,KAAK,CAAC,CAAA;QACtB,CAAC;IACH,CAAC,CAAA;AACH,CAAC"}

package/dist/withAuditLog.d.ts

@@ -0,0 +1,23 @@
+import type { Plugin, AuditEvent } from '@airdraft/core';
+export type AuditPersister = (event: AuditEvent) => void | Promise<void>;
+export interface AuditLogOptions {
+    /**
+     * Called for every completed CMS request with the full audit event.
+     * Defaults to `consolePersister` (compact JSON to stdout).
+     */
+    persist?: AuditPersister;
+}
+/**
+ * Audit logging plugin. Registers an `onAuditEvent` hook that receives a wide
+ * event for every CMS operation. The event contains method, path, action,
+ * collection, slug, status code, duration, actor identity, and error details.
+ *
+ * @example
+ * ```ts
+ * import { withAuditLog, filePersister } from '@airdraft/plugin-audit-log'
+ *
+ * withAuditLog({ persist: filePersister('./logs/audit.log') })
+ * ```
+ */
+export declare function withAuditLog(options?: AuditLogOptions): Plugin;
+//# sourceMappingURL=withAuditLog.d.ts.map

package/dist/withAuditLog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withAuditLog.d.ts","sourceRoot":"","sources":["../src/withAuditLog.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAExD,MAAM,MAAM,cAAc,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;AAExE,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,OAAO,CAAC,EAAE,cAAc,CAAA;CACzB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,MAAM,CAS9D"}

package/dist/withAuditLog.js

@@ -0,0 +1,25 @@
+/**
+ * Audit logging plugin. Registers an `onAuditEvent` hook that receives a wide
+ * event for every CMS operation. The event contains method, path, action,
+ * collection, slug, status code, duration, actor identity, and error details.
+ *
+ * @example
+ * ```ts
+ * import { withAuditLog, filePersister } from '@airdraft/plugin-audit-log'
+ *
+ * withAuditLog({ persist: filePersister('./logs/audit.log') })
+ * ```
+ */
+export function withAuditLog(options) {
+    const persist = options?.persist ?? defaultConsolePersister;
+    return {
+        name: 'audit-log',
+        hooks: {
+            onAuditEvent: persist,
+        },
+    };
+}
+const defaultConsolePersister = (event) => {
+    console.log(JSON.stringify(event));
+};
+//# sourceMappingURL=withAuditLog.js.map

package/dist/withAuditLog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withAuditLog.js","sourceRoot":"","sources":["../src/withAuditLog.ts"],"names":[],"mappings":"AAYA;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAAC,OAAyB;IACpD,MAAM,OAAO,GAAmB,OAAO,EAAE,OAAO,IAAI,uBAAuB,CAAA;IAE3E,OAAO;QACL,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE;YACL,YAAY,EAAE,OAAO;SACtB;KACF,CAAA;AACH,CAAC;AAED,MAAM,uBAAuB,GAAmB,CAAC,KAAiB,EAAQ,EAAE;IAC1E,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;AACpC,CAAC,CAAA"}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@airdraft/plugin-audit-log",
+  "version": "0.1.0",
+  "description": "Audit logging plugin for Airdraft — emits a wide event per CMS request",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": ["dist", "README.md", "CHANGELOG.md"],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "clean": "rm -rf dist",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build",
+    "release": "standard-version",
+    "release:patch": "standard-version --release-as patch",
+    "release:minor": "standard-version --release-as minor",
+    "release:major": "standard-version --release-as major"
+  },
+  "publishConfig": { "access": "public" },
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "standard-version": "^9.5.0",
+    "typescript": "^5.4.0",
+    "vitest": "^1.5.0"
+  },
+  "dependencies": {
+    "@airdraft/core": "*"
+  },
+  "engines": { "node": ">=18.0.0" }
+}