convex-audit-log 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,408 @@
+# Convex Audit Log Component
+
+[![npm version](https://badge.fury.io/js/convex-audit-log.svg)](https://badge.fury.io/js/convex-audit-log)
+
+A comprehensive audit logging component for Convex that helps you track user actions, API calls, and system events with built-in compliance features.
+
+## Features
+
+- **Automatic Event Capture** - Log who, what, when, and where for any action
+- **Change Tracking** - Record before/after states with automatic diff generation
+- **PII Redaction** - Built-in privacy controls for sensitive data
+- **Flexible Querying** - Query by actor, resource, severity, time range, and more
+- **Real-time Monitoring** - Subscribe to critical events as they happen
+- **Anomaly Detection** - Detect unusual patterns in event frequency
+- **Report Generation** - Export audit logs as JSON or CSV
+- **Configurable Retention** - Automatic cleanup with customizable policies
+- **React Hooks** - Pre-built hooks for common UI patterns
+
+## Installation
+
+```bash
+npm install convex-audit-log
+```
+
+Create a `convex.config.ts` file in your app's `convex/` folder and install the component:
+
+```ts
+// convex/convex.config.ts
+import { defineApp } from "convex/server";
+import auditLog from "convex-audit-log/convex.config.js";
+
+const app = defineApp();
+app.use(auditLog);
+
+export default app;
+```
+
+## Quick Start
+
+### 1. Create an AuditLog Client
+
+```ts
+// convex/auditLog.ts
+import { AuditLog } from "convex-audit-log";
+import { components } from "./_generated/api";
+
+export const auditLog = new AuditLog(components.auditLog, {
+  // Optional: Configure PII fields to automatically redact
+  piiFields: ["email", "phone", "ssn", "password"],
+});
+```
+
+### 2. Log Events in Your Mutations
+
+```ts
+import { mutation } from "./_generated/server";
+import { auditLog } from "./auditLog";
+
+export const updateUserProfile = mutation({
+  args: { userId: v.id("users"), name: v.string(), email: v.string() },
+  handler: async (ctx, args) => {
+    // Get current state
+    const before = await ctx.db.get(args.userId);
+
+    // Perform the update
+    await ctx.db.patch(args.userId, { name: args.name, email: args.email });
+
+    // Get new state
+    const after = await ctx.db.get(args.userId);
+
+    // Log the change with automatic diff
+    await auditLog.logChange(ctx, {
+      action: "user.profile.updated",
+      actorId: ctx.auth.getUserIdentity()?.subject,
+      resourceType: "users",
+      resourceId: args.userId,
+      before,
+      after,
+      generateDiff: true,
+      severity: "info",
+    });
+
+    return after;
+  },
+});
+```
+
+### 3. Query Audit Logs
+
+```ts
+import { query } from "./_generated/server";
+import { auditLog } from "./auditLog";
+
+// Get all changes to a specific document
+export const getDocumentHistory = query({
+  args: { documentId: v.string() },
+  handler: async (ctx, args) => {
+    return await auditLog.queryByResource(ctx, {
+      resourceType: "documents",
+      resourceId: args.documentId,
+      limit: 50,
+    });
+  },
+});
+
+// Get all actions by a specific user
+export const getUserActivity = query({
+  args: { userId: v.string() },
+  handler: async (ctx, args) => {
+    return await auditLog.queryByActor(ctx, {
+      actorId: args.userId,
+      limit: 50,
+    });
+  },
+});
+
+// Watch for critical security events
+export const watchSecurityEvents = query({
+  handler: async (ctx) => {
+    return await auditLog.watchCritical(ctx, {
+      severity: ["warning", "error", "critical"],
+      limit: 20,
+    });
+  },
+});
+```
+
+## API Reference
+
+### Severity Levels
+
+| Level | Description |
+|-------|-------------|
+| `info` | Regular operations (login, profile update) |
+| `warning` | Potentially concerning actions (password change, permission change) |
+| `error` | Failed operations or errors |
+| `critical` | Security-sensitive events (unauthorized access, data breaches) |
+
+### Core Methods
+
+#### `log(ctx, event)`
+
+Log a single audit event.
+
+```ts
+await auditLog.log(ctx, {
+  action: "user.login",
+  actorId: userId,
+  severity: "info",
+  metadata: { method: "password" },
+  tags: ["authentication"],
+});
+```
+
+#### `logChange(ctx, event)`
+
+Log a change event with before/after states.
+
+```ts
+await auditLog.logChange(ctx, {
+  action: "document.updated",
+  actorId: userId,
+  resourceType: "documents",
+  resourceId: docId,
+  before: { title: "Old Title" },
+  after: { title: "New Title" },
+  generateDiff: true, // Automatically generate diff
+  severity: "info",
+});
+```
+
+#### `logBulk(ctx, events)`
+
+Log multiple events in a single transaction.
+
+```ts
+await auditLog.logBulk(ctx, [
+  { action: "document.created", severity: "info", ... },
+  { action: "notification.sent", severity: "info", ... },
+]);
+```
+
+### Query Methods
+
+#### `queryByResource(ctx, args)`
+
+Query logs for a specific resource.
+
+```ts
+const history = await auditLog.queryByResource(ctx, {
+  resourceType: "documents",
+  resourceId: docId,
+  limit: 50,
+  fromTimestamp: Date.now() - 7 * 24 * 60 * 60 * 1000, // Last 7 days
+});
+```
+
+#### `queryByActor(ctx, args)`
+
+Query logs for a specific actor.
+
+```ts
+const activity = await auditLog.queryByActor(ctx, {
+  actorId: userId,
+  limit: 50,
+  actions: ["user.login", "user.logout"], // Optional filter
+});
+```
+
+#### `search(ctx, args)`
+
+Advanced search with multiple filters.
+
+```ts
+const results = await auditLog.search(ctx, {
+  filters: {
+    severity: ["warning", "error", "critical"],
+    actions: ["user.login.failed"],
+    fromTimestamp: Date.now() - 24 * 60 * 60 * 1000,
+    tags: ["security"],
+  },
+  pagination: { limit: 100 },
+});
+```
+
+#### `watchCritical(ctx, args)`
+
+Subscribe to critical events in real-time.
+
+```ts
+const criticalEvents = await auditLog.watchCritical(ctx, {
+  severity: ["error", "critical"],
+  limit: 20,
+});
+```
+
+### Analytics Methods
+
+#### `getStats(ctx, args)`
+
+Get statistics for audit logs.
+
+```ts
+const stats = await auditLog.getStats(ctx, {
+  fromTimestamp: Date.now() - 24 * 60 * 60 * 1000,
+});
+// Returns: { totalCount, bySeverity, topActions, topActors }
+```
+
+#### `detectAnomalies(ctx, patterns)`
+
+Detect anomalies based on event frequency.
+
+```ts
+const anomalies = await auditLog.detectAnomalies(ctx, [
+  { action: "user.login.failed", threshold: 5, windowMinutes: 5 },
+  { action: "record.deleted", threshold: 50, windowMinutes: 60 },
+]);
+```
+
+#### `generateReport(ctx, args)`
+
+Generate a compliance report.
+
+```ts
+const report = await auditLog.generateReport(ctx, {
+  startDate: startOfMonth,
+  endDate: endOfMonth,
+  format: "csv", // or "json"
+  includeFields: ["timestamp", "action", "actorId", "resourceType"],
+  groupBy: "action",
+});
+```
+
+### Maintenance Methods
+
+#### `cleanup(ctx, options)`
+
+Clean up old audit logs based on retention policies.
+
+```ts
+const deletedCount = await auditLog.cleanup(ctx, {
+  olderThanDays: 90,
+  preserveSeverity: ["critical"], // Keep critical events forever
+  batchSize: 100,
+});
+```
+
+## React Hooks
+
+```tsx
+import {
+  useAuditLogByResource,
+  useWatchCriticalEvents,
+  useAuditLogStats,
+  formatTimestamp,
+  getSeverityColor,
+} from "convex-audit-log/react";
+import { api } from "../convex/_generated/api";
+
+function DocumentHistory({ documentId }: { documentId: string }) {
+  const logs = useAuditLogByResource(api.auditLog.queryByResource, {
+    resourceType: "documents",
+    resourceId: documentId,
+    limit: 20,
+  });
+
+  if (!logs) return <div>Loading...</div>;
+
+  return (
+    <ul>
+      {logs.map((log) => (
+        <li key={log._id} style={{ borderLeftColor: getSeverityColor(log.severity) }}>
+          <strong>{log.action}</strong>
+          <span>{formatTimestamp(log.timestamp)}</span>
+        </li>
+      ))}
+    </ul>
+  );
+}
+```
+
+## Pre-defined Action Constants
+
+Use the provided action constants for consistency:
+
+```ts
+import { AuditActions } from "convex-audit-log";
+
+await auditLog.log(ctx, {
+  action: AuditActions.USER_LOGIN,
+  // ...
+});
+```
+
+Available actions:
+- `USER_LOGIN`, `USER_LOGIN_FAILED`, `USER_LOGOUT`, `USER_SIGNUP`
+- `PASSWORD_CHANGED`, `PASSWORD_RESET_REQUESTED`, `PASSWORD_RESET_COMPLETED`
+- `MFA_ENABLED`, `MFA_DISABLED`
+- `USER_CREATED`, `USER_UPDATED`, `USER_DELETED`
+- `USER_ROLE_CHANGED`, `USER_PERMISSIONS_CHANGED`
+- `RECORD_CREATED`, `RECORD_UPDATED`, `RECORD_DELETED`, `RECORD_VIEWED`, `RECORD_EXPORTED`
+- `SETTINGS_CHANGED`, `API_KEY_CREATED`, `API_KEY_REVOKED`
+- `UNAUTHORIZED_ACCESS`, `SUSPICIOUS_ACTIVITY`, `RATE_LIMIT_EXCEEDED`
+
+## Exposing API to React Clients
+
+```ts
+// convex/auditLog.ts
+import { exposeAuditLogApi } from "convex-audit-log";
+import { components } from "./_generated/api";
+
+export const {
+  queryByResource,
+  queryByActor,
+  getStats,
+  watchCritical,
+} = exposeAuditLogApi(components.auditLog, {
+  auth: async (ctx, operation) => {
+    const userId = await getAuthUserId(ctx);
+    if (!userId && operation.type !== "read") {
+      throw new Error("Unauthorized");
+    }
+    return userId;
+  },
+});
+```
+
+## Testing
+
+```ts
+import { test } from "vitest";
+import { convexTest } from "convex-test";
+import auditLogComponent from "convex-audit-log/test";
+import schema from "./schema";
+
+test("audit logging", async () => {
+  const t = convexTest(schema);
+  auditLogComponent.register(t);
+
+  await t.run(async (ctx) => {
+    // Test your audit log functionality
+  });
+});
+```
+
+## Example App
+
+Run the example app to see the component in action:
+
+```sh
+npm install
+npm run dev
+```
+
+The example app includes:
+- Event generation demo
+- Real-time log viewer
+- Analytics dashboard with statistics
+- Anomaly detection monitoring
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for development instructions.
+
+## License
+
+Apache-2.0

package/dist/client/_generated/_ignore.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=_ignore.d.ts.map

package/dist/client/_generated/_ignore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_ignore.d.ts","sourceRoot":"","sources":["../../../src/client/_generated/_ignore.ts"],"names":[],"mappings":""}

package/dist/client/_generated/_ignore.js

@@ -0,0 +1,3 @@
+"use strict";
+// This is only here so convex-test can detect a _generated folder
+//# sourceMappingURL=_ignore.js.map

package/dist/client/_generated/_ignore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_ignore.js","sourceRoot":"","sources":["../../../src/client/_generated/_ignore.ts"],"names":[],"mappings":";AAAA,kEAAkE"}