@checodo/better-auth-audit-log 0.0.0-stage → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @checodo/better-auth-audit-log
+
+## 0.1.0
+
+### Minor Changes
+
+- 5f427b0: First release: an audit log of sign-ins, failed sign-ins, account changes, and admin actions. Users see their own history, admins everyone's.

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Clas Heinemeyer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,50 @@
-# Temporary Holding Version
+# @checodo/better-auth-audit-log
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+An audit log for [better-auth](https://better-auth.com): sign-ins, failed sign-ins, account changes, admin and organization actions, with retention and an optional hash chain.
+
+A community plugin, not made by the better-auth team. It looks and works
+like better-auth's own plugins: a server plugin, a typed client plugin,
+error codes, and database tables.
+
+## Install
+
+```bash
+npm install @checodo/better-auth-audit-log
+```
+
+Requires `better-auth` and `@better-auth/core` 1.7.20 or a later 1.x
+release (peer dependencies). ESM only.
+
+## Usage
+
+```ts
+// auth.ts
+import { betterAuth } from "better-auth";
+import { auditLog } from "@checodo/better-auth-audit-log";
+
+export const auth = betterAuth({
+  plugins: [
+    // last, after the other plugins
+    auditLog({ retention: { days: 180 } }),
+  ],
+});
+```
+
+```ts
+// auth-client.ts
+import { createAuthClient } from "better-auth/client";
+import { auditLogClient } from "@checodo/better-auth-audit-log/client";
+
+export const authClient = createAuthClient({ plugins: [auditLogClient()] });
+```
+
+Create the plugin's tables with the better-auth CLI:
+
+```bash
+npx auth@latest migrate
+```
+
+## Documentation
+
+Every option, endpoint, error code, and table:
+[docs](https://github.com/checodo/better-auth-plugins/blob/main/apps/docs/content/docs/audit-log.mdx).

package/dist/client.d.ts

@@ -0,0 +1,33 @@
+import { i as AUDIT_LOG_ERROR_CODES, t as AuditLogPlugin } from "./index-e6JB3Yiu.js";
+/**
+ * Client companion to `auditLog()`. Adds `authClient.auditLog.listEvents`,
+ * typed from the server plugin: the signed-in user's own events, or any
+ * user's for admins.
+ *
+ * @example
+ * ```ts
+ * import { createAuthClient } from "better-auth/client";
+ * import { auditLogClient } from "@checodo/better-auth-audit-log/client";
+ *
+ * export const authClient = createAuthClient({
+ *   plugins: [auditLogClient()],
+ * });
+ *
+ * const { data } = await authClient.auditLog.listEvents({ query: { type: "sign-in" } });
+ * ```
+ */
+export declare const auditLogClient: () => {
+  id: "audit-log";
+  $InferServerPlugin: AuditLogPlugin;
+  pathMethods: {
+    "/audit-log/list-events": "GET";
+  };
+  $ERROR_CODES: {
+    YOU_ARE_NOT_ALLOWED_TO_LIST_OTHER_USERS_EVENTS: import("better-auth").RawError<"YOU_ARE_NOT_ALLOWED_TO_LIST_OTHER_USERS_EVENTS">;
+    METADATA_TOO_LARGE: import("better-auth").RawError<"METADATA_TOO_LARGE">;
+    RETENTION_NOT_CONFIGURED: import("better-auth").RawError<"RETENTION_NOT_CONFIGURED">;
+    HASH_CHAIN_NOT_ENABLED: import("better-auth").RawError<"HASH_CHAIN_NOT_ENABLED">;
+  };
+};
+export { AUDIT_LOG_ERROR_CODES };
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","names":[],"sources":["../src/client.ts"],"mappings":";;;;;;;;;;;;;;;;;;qBAqBa;;EAGiB,oBAAA"}

package/dist/client.js

@@ -0,0 +1,30 @@
+import { t as AUDIT_LOG_ERROR_CODES } from "./error-codes-B9Frh9bu.js";
+// src/client.ts
+/**
+* Client companion to `auditLog()`. Adds `authClient.auditLog.listEvents`,
+* typed from the server plugin: the signed-in user's own events, or any
+* user's for admins.
+*
+* @example
+* ```ts
+* import { createAuthClient } from "better-auth/client";
+* import { auditLogClient } from "@checodo/better-auth-audit-log/client";
+*
+* export const authClient = createAuthClient({
+*   plugins: [auditLogClient()],
+* });
+*
+* const { data } = await authClient.auditLog.listEvents({ query: { type: "sign-in" } });
+* ```
+*/
+const auditLogClient = () => {
+	return {
+		id: "audit-log",
+		$InferServerPlugin: {},
+		pathMethods: { "/audit-log/list-events": "GET" },
+		$ERROR_CODES: AUDIT_LOG_ERROR_CODES
+	};
+};
+export { AUDIT_LOG_ERROR_CODES, auditLogClient };
+
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","names":[],"sources":["../src/client.ts"],"sourcesContent":["import type { BetterAuthClientPlugin } from \"better-auth/client\";\nimport { AUDIT_LOG_ERROR_CODES } from \"./error-codes\";\nimport type { AuditLogPlugin } from \"./index\";\n\n/**\n * Client companion to `auditLog()`. Adds `authClient.auditLog.listEvents`,\n * typed from the server plugin: the signed-in user's own events, or any\n * user's for admins.\n *\n * @example\n * ```ts\n * import { createAuthClient } from \"better-auth/client\";\n * import { auditLogClient } from \"@checodo/better-auth-audit-log/client\";\n *\n * export const authClient = createAuthClient({\n *   plugins: [auditLogClient()],\n * });\n *\n * const { data } = await authClient.auditLog.listEvents({ query: { type: \"sign-in\" } });\n * ```\n */\nexport const auditLogClient = () => {\n  return {\n    id: \"audit-log\",\n    $InferServerPlugin: {} as AuditLogPlugin,\n    pathMethods: {\n      \"/audit-log/list-events\": \"GET\",\n    },\n    $ERROR_CODES: AUDIT_LOG_ERROR_CODES,\n  } satisfies BetterAuthClientPlugin;\n};\n\nexport { AUDIT_LOG_ERROR_CODES } from \"./error-codes\";\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAqBA,MAAa,uBAAuB;CAClC,OAAO;EACL,IAAI;EACJ,oBAAoB,CAAC;EACrB,aAAa,EACX,0BAA0B,MAC5B;EACA,cAAc;CAChB;AACF"}

package/dist/error-codes-B9Frh9bu.js

@@ -0,0 +1,11 @@
+import { defineErrorCodes } from "@better-auth/core/utils/error-codes";
+// src/error-codes.ts
+const AUDIT_LOG_ERROR_CODES = defineErrorCodes({
+	YOU_ARE_NOT_ALLOWED_TO_LIST_OTHER_USERS_EVENTS: "You are not allowed to list the audit events of other users",
+	METADATA_TOO_LARGE: "The metadata is too large",
+	RETENTION_NOT_CONFIGURED: "Pass `days`, or configure the plugin's `retention` option",
+	HASH_CHAIN_NOT_ENABLED: "The plugin's `hashChain` option is off"
+});
+export { AUDIT_LOG_ERROR_CODES as t };
+
+//# sourceMappingURL=error-codes-B9Frh9bu.js.map

package/dist/error-codes-B9Frh9bu.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-codes-B9Frh9bu.js","names":[],"sources":["../src/error-codes.ts"],"sourcesContent":["import { defineErrorCodes } from \"@better-auth/core/utils/error-codes\";\n\nexport const AUDIT_LOG_ERROR_CODES = defineErrorCodes({\n  YOU_ARE_NOT_ALLOWED_TO_LIST_OTHER_USERS_EVENTS:\n    \"You are not allowed to list the audit events of other users\",\n  METADATA_TOO_LARGE: \"The metadata is too large\",\n  RETENTION_NOT_CONFIGURED: \"Pass `days`, or configure the plugin's `retention` option\",\n  HASH_CHAIN_NOT_ENABLED: \"The plugin's `hashChain` option is off\",\n});\n\nexport type AuditLogErrorCode = keyof typeof AUDIT_LOG_ERROR_CODES;\n"],"mappings":";;AAEA,MAAa,wBAAwB,iBAAiB;CACpD,gDACE;CACF,oBAAoB;CACpB,0BAA0B;CAC1B,wBAAwB;AAC1B,CAAC"}