convex-audit-log 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +408 -0
  3. package/dist/client/_generated/_ignore.d.ts +1 -0
  4. package/dist/client/_generated/_ignore.d.ts.map +1 -0
  5. package/dist/client/_generated/_ignore.js +3 -0
  6. package/dist/client/_generated/_ignore.js.map +1 -0
  7. package/dist/client/index.d.ts +336 -0
  8. package/dist/client/index.d.ts.map +1 -0
  9. package/dist/client/index.js +297 -0
  10. package/dist/client/index.js.map +1 -0
  11. package/dist/component/_generated/api.d.ts +36 -0
  12. package/dist/component/_generated/api.d.ts.map +1 -0
  13. package/dist/component/_generated/api.js +31 -0
  14. package/dist/component/_generated/api.js.map +1 -0
  15. package/dist/component/_generated/component.d.ts +317 -0
  16. package/dist/component/_generated/component.d.ts.map +1 -0
  17. package/dist/component/_generated/component.js +11 -0
  18. package/dist/component/_generated/component.js.map +1 -0
  19. package/dist/component/_generated/dataModel.d.ts +46 -0
  20. package/dist/component/_generated/dataModel.d.ts.map +1 -0
  21. package/dist/component/_generated/dataModel.js +11 -0
  22. package/dist/component/_generated/dataModel.js.map +1 -0
  23. package/dist/component/_generated/server.d.ts +121 -0
  24. package/dist/component/_generated/server.d.ts.map +1 -0
  25. package/dist/component/_generated/server.js +78 -0
  26. package/dist/component/_generated/server.js.map +1 -0
  27. package/dist/component/convex.config.d.ts +3 -0
  28. package/dist/component/convex.config.d.ts.map +1 -0
  29. package/dist/component/convex.config.js +3 -0
  30. package/dist/component/convex.config.js.map +1 -0
  31. package/dist/component/lib.d.ts +341 -0
  32. package/dist/component/lib.d.ts.map +1 -0
  33. package/dist/component/lib.js +598 -0
  34. package/dist/component/lib.js.map +1 -0
  35. package/dist/component/schema.d.ts +87 -0
  36. package/dist/component/schema.d.ts.map +1 -0
  37. package/dist/component/schema.js +71 -0
  38. package/dist/component/schema.js.map +1 -0
  39. package/dist/component/shared.d.ts +203 -0
  40. package/dist/component/shared.d.ts.map +1 -0
  41. package/dist/component/shared.js +94 -0
  42. package/dist/component/shared.js.map +1 -0
  43. package/dist/react/index.d.ts +247 -0
  44. package/dist/react/index.d.ts.map +1 -0
  45. package/dist/react/index.js +196 -0
  46. package/dist/react/index.js.map +1 -0
  47. package/package.json +115 -0
  48. package/src/client/_generated/_ignore.ts +1 -0
  49. package/src/client/index.test.ts +61 -0
  50. package/src/client/index.ts +525 -0
  51. package/src/client/setup.test.ts +26 -0
  52. package/src/component/_generated/api.ts +52 -0
  53. package/src/component/_generated/component.ts +392 -0
  54. package/src/component/_generated/dataModel.ts +60 -0
  55. package/src/component/_generated/server.ts +161 -0
  56. package/src/component/convex.config.ts +3 -0
  57. package/src/component/lib.test.ts +171 -0
  58. package/src/component/lib.ts +722 -0
  59. package/src/component/schema.ts +93 -0
  60. package/src/component/setup.test.ts +11 -0
  61. package/src/component/shared.ts +167 -0
  62. package/src/react/index.ts +305 -0
  63. package/src/test.ts +18 -0
@@ -0,0 +1,171 @@
1
+ /// <reference types="vite/client" />
2
+
3
+ import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
4
+ import { api } from "./_generated/api.js";
5
+ import { initConvexTest } from "./setup.test.js";
6
+
7
+ describe("audit log component", () => {
8
+ beforeEach(async () => {
9
+ vi.useFakeTimers();
10
+ });
11
+ afterEach(() => {
12
+ vi.useRealTimers();
13
+ });
14
+
15
+ test("can log a basic audit event", async () => {
16
+ const t = initConvexTest();
17
+
18
+ const logId = await t.mutation(api.lib.log, {
19
+ action: "user.login",
20
+ actorId: "user123",
21
+ severity: "info",
22
+ metadata: { method: "password" },
23
+ });
24
+
25
+ expect(logId).toBeDefined();
26
+
27
+ const result = await t.query(api.lib.get, { id: logId });
28
+ expect(result).not.toBeNull();
29
+ expect(result?.action).toBe("user.login");
30
+ expect(result?.actorId).toBe("user123");
31
+ expect(result?.severity).toBe("info");
32
+ });
33
+
34
+ test("can log a change event with diff", async () => {
35
+ const t = initConvexTest();
36
+
37
+ const logId = await t.mutation(api.lib.logChange, {
38
+ action: "document.updated",
39
+ actorId: "user123",
40
+ resourceType: "documents",
41
+ resourceId: "doc456",
42
+ before: { title: "Old Title" },
43
+ after: { title: "New Title" },
44
+ generateDiff: true,
45
+ });
46
+
47
+ expect(logId).toBeDefined();
48
+
49
+ const result = await t.query(api.lib.get, { id: logId });
50
+ expect(result).not.toBeNull();
51
+ expect(result?.before).toEqual({ title: "Old Title" });
52
+ expect(result?.after).toEqual({ title: "New Title" });
53
+ expect(result?.diff).toContain("title");
54
+ });
55
+
56
+ test("can query by resource", async () => {
57
+ const t = initConvexTest();
58
+
59
+ // Log some events for a resource
60
+ await t.mutation(api.lib.log, {
61
+ action: "document.created",
62
+ resourceType: "documents",
63
+ resourceId: "doc123",
64
+ severity: "info",
65
+ });
66
+
67
+ await t.mutation(api.lib.log, {
68
+ action: "document.updated",
69
+ resourceType: "documents",
70
+ resourceId: "doc123",
71
+ severity: "info",
72
+ });
73
+
74
+ const results = await t.query(api.lib.queryByResource, {
75
+ resourceType: "documents",
76
+ resourceId: "doc123",
77
+ });
78
+
79
+ expect(results).toHaveLength(2);
80
+ });
81
+
82
+ test("can query by actor", async () => {
83
+ const t = initConvexTest();
84
+
85
+ await t.mutation(api.lib.log, {
86
+ action: "user.login",
87
+ actorId: "user123",
88
+ severity: "info",
89
+ });
90
+
91
+ await t.mutation(api.lib.log, {
92
+ action: "user.logout",
93
+ actorId: "user123",
94
+ severity: "info",
95
+ });
96
+
97
+ const results = await t.query(api.lib.queryByActor, {
98
+ actorId: "user123",
99
+ });
100
+
101
+ expect(results).toHaveLength(2);
102
+ });
103
+
104
+ test("can query by severity", async () => {
105
+ const t = initConvexTest();
106
+
107
+ await t.mutation(api.lib.log, {
108
+ action: "user.login",
109
+ severity: "info",
110
+ });
111
+
112
+ await t.mutation(api.lib.log, {
113
+ action: "user.login.failed",
114
+ severity: "warning",
115
+ });
116
+
117
+ await t.mutation(api.lib.log, {
118
+ action: "security.breach",
119
+ severity: "critical",
120
+ });
121
+
122
+ const criticalEvents = await t.query(api.lib.queryBySeverity, {
123
+ severity: ["critical"],
124
+ });
125
+
126
+ expect(criticalEvents).toHaveLength(1);
127
+ expect(criticalEvents[0].action).toBe("security.breach");
128
+ });
129
+
130
+ test("can get stats", async () => {
131
+ const t = initConvexTest();
132
+
133
+ await t.mutation(api.lib.log, {
134
+ action: "user.login",
135
+ actorId: "user1",
136
+ severity: "info",
137
+ });
138
+
139
+ await t.mutation(api.lib.log, {
140
+ action: "user.login",
141
+ actorId: "user2",
142
+ severity: "info",
143
+ });
144
+
145
+ await t.mutation(api.lib.log, {
146
+ action: "user.login.failed",
147
+ severity: "warning",
148
+ });
149
+
150
+ const stats = await t.query(api.lib.getStats, {});
151
+
152
+ expect(stats.totalCount).toBe(3);
153
+ expect(stats.bySeverity.info).toBe(2);
154
+ expect(stats.bySeverity.warning).toBe(1);
155
+ expect(stats.topActions).toContainEqual({ action: "user.login", count: 2 });
156
+ });
157
+
158
+ test("can bulk log events", async () => {
159
+ const t = initConvexTest();
160
+
161
+ const ids = await t.mutation(api.lib.logBulk, {
162
+ events: [
163
+ { action: "event1", severity: "info" },
164
+ { action: "event2", severity: "info" },
165
+ { action: "event3", severity: "warning" },
166
+ ],
167
+ });
168
+
169
+ expect(ids).toHaveLength(3);
170
+ });
171
+ });