@venturekit-pro/audit 0.0.0-dev.20260602192622

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.
package/LICENSE ADDED
@@ -0,0 +1,191 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to the Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by the Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding any notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ Copyright 2025 VentureKit Contributors
180
+
181
+ Licensed under the Apache License, Version 2.0 (the "License");
182
+ you may not use this file except in compliance with the License.
183
+ You may obtain a copy of the License at
184
+
185
+ http://www.apache.org/licenses/LICENSE-2.0
186
+
187
+ Unless required by applicable law or agreed to in writing, software
188
+ distributed under the License is distributed on an "AS IS" BASIS,
189
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
190
+ See the License for the specific language governing permissions and
191
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,124 @@
1
+ # @venturekit-pro/audit
2
+
3
+ Strictly-scoped, append-only audit log for VentureKit applications.
4
+
5
+ **The package records WHO did WHAT, TO WHAT, WHEN, and HOW IT WENT.
6
+ Nothing else.** Domain concerns (USD cost, payment totals, token usage,
7
+ LLM provider/model, latency) live in their own packages' tables (e.g.
8
+ `@venturekit-pro/ai`'s `llm_cost_events`) and reference this one via
9
+ `correlation_id` / `target_type` + `target_id`. The audit package never
10
+ sees money, tokens, or any other domain primitive.
11
+
12
+ Event kinds (`'blog.save'`, `'order.refunded'`, `'security.login'`, …) are
13
+ free-form strings the calling app chooses and namespaces however it likes.
14
+
15
+ ## What it gives you
16
+
17
+ - **One canonical `audit_events` table** keyed by
18
+ `(tenant_id, kind, target_type, target_id)`.
19
+ - **Append-only by construction** — DB-level `REVOKE UPDATE, DELETE` on
20
+ `audit_events` from `PUBLIC` so a SQL bug can't silently mutate
21
+ compliance history. Retention pruning runs as a privileged
22
+ maintenance role through `pruneAuditEvents()`.
23
+ - **Idempotent writes** via an optional `idempotency_key` — repeated
24
+ retries of the same operation never produce duplicate rows.
25
+ - **Pure-audit aggregation helpers** — `countEvents()` /
26
+ `monthlyEventCounts()` with an optional `byKindPrefix` split for
27
+ per-namespace tallies.
28
+
29
+ ## Wire-up
30
+
31
+ ```ts
32
+ // In your VentureKit project's vk.config.ts:
33
+ import { getAuditMigrationsDir } from '@venturekit-pro/audit';
34
+
35
+ export default defineVenture({
36
+ // ...
37
+ extraMigrationsDirs: [getAuditMigrationsDir()],
38
+ });
39
+ ```
40
+
41
+ `vk migrate` then runs the package's `vk_audit_*.sql` files alongside your
42
+ project's own migrations.
43
+
44
+ ## Recording
45
+
46
+ ```ts
47
+ import { record } from '@venturekit-pro/audit';
48
+ import { query } from '@venturekit/data';
49
+
50
+ await record(query, {
51
+ tenantId,
52
+ actor: { type: 'user', id: userSub },
53
+ kind: 'order.refunded', // free-form, app-namespaced
54
+ target: { type: 'order', id: order.id },
55
+ payload: { reason: 'duplicate' }, // free-form jsonb
56
+ });
57
+
58
+ // Threaded with a correlation id so several events link to the same op:
59
+ await record(query, {
60
+ tenantId,
61
+ actor: { type: 'service', id: 'workflow-runner' },
62
+ kind: 'workflow.step.completed',
63
+ target: { type: 'workflow_run', id: run.id },
64
+ correlationId: run.id,
65
+ payload: { stepName: 'critique' },
66
+ idempotencyKey: `${run.id}/step-3/attempt-1`,
67
+ });
68
+ ```
69
+
70
+ ## Listing
71
+
72
+ ```ts
73
+ import { listEvents } from '@venturekit-pro/audit';
74
+
75
+ await listEvents(query, { tenantId, limit: 50 });
76
+ await listEvents(query, { tenantId, kindPrefix: 'order.' });
77
+ await listEvents(query, { tenantId, targetType: 'order', targetId });
78
+ await listEvents(query, { tenantId, correlationId: runId });
79
+ await listEvents(query, { tenantId, status: 'failed' });
80
+ await listEvents(query, { tenantId, actorType: 'cron' });
81
+ ```
82
+
83
+ ## Counting / activity volume
84
+
85
+ ```ts
86
+ import { countEvents, monthlyEventCounts } from '@venturekit-pro/audit';
87
+
88
+ // Total events in a window:
89
+ await countEvents(query, {
90
+ tenantId,
91
+ since: new Date('2026-05-01'),
92
+ until: new Date('2026-06-01'),
93
+ });
94
+ // → { count: 1247, byKindPrefix: {} }
95
+
96
+ // Split by whatever kind-prefixes the app cares about:
97
+ await countEvents(query, {
98
+ tenantId,
99
+ byKindPrefix: ['order.', 'security.', 'workflow.'],
100
+ });
101
+ // → { count: 1247, byKindPrefix: { 'order.': 320, 'security.': 12, 'workflow.': 915 } }
102
+
103
+ // Monthly activity buckets:
104
+ await monthlyEventCounts(query, { tenantId, monthCount: 6, byKindPrefix: ['order.'] });
105
+ // → [{ month: '2025-12-01', count: 245, byKindPrefix: { 'order.': 80 } }, …]
106
+ ```
107
+
108
+ ## Retention
109
+
110
+ `pruneAuditEvents()` is the only mutating helper besides `record()`. It
111
+ runs as a **privileged maintenance role** (the application role has
112
+ `DELETE` revoked by the migration), is paginated to avoid long
113
+ transactions, and never auto-fires — the consumer wires it into its own
114
+ cron with a retention policy that fits its compliance regime.
115
+
116
+ ```ts
117
+ import { pruneAuditEvents, previewPrune } from '@venturekit-pro/audit';
118
+
119
+ // What WOULD be pruned (safe to call from app role):
120
+ await previewPrune(query, { olderThanDays: 365, batchSize: 1000 });
121
+
122
+ // Actually delete (requires DELETE privileges):
123
+ await pruneAuditEvents(adminQuery, { olderThanDays: 365, batchSize: 1000 });
124
+ ```
@@ -0,0 +1,31 @@
1
+ /**
2
+ * @venturekit-pro/audit
3
+ *
4
+ * Strictly-scoped, append-only audit log.
5
+ *
6
+ * Records WHO did WHAT, TO WHAT, WHEN, and HOW IT WENT. Nothing else.
7
+ * Domain rollups (cost, payment totals, token usage) live in their
8
+ * own packages' tables and reference this one via `correlationId` /
9
+ * `target`.
10
+ *
11
+ * - `record(querier, input)` — write one event.
12
+ * - `listEvents(querier, args)` — paginated newest-first list.
13
+ * - `countEvents(querier, args)` — count, with optional
14
+ * byKindPrefix split.
15
+ * - `monthlyEventCounts(querier, args)` — trailing-N-months
16
+ * activity volume.
17
+ * - `pruneAuditEvents` / `previewPrune` — retention sweep
18
+ * (privileged role).
19
+ * - `getAuditMigrationsDir()` — path to `vk_audit_*.sql`
20
+ * files for `vk migrate`.
21
+ *
22
+ * Documentation: https://venturekit.dev
23
+ */
24
+ export type { AuditEvent, AuditEventInput, AuditActor, AuditActorType, AuditTarget, AuditStatus, EventCount, Querier, } from './types.js';
25
+ export { record } from './record.js';
26
+ export { listEvents, countEvents, monthlyEventCounts, } from './query.js';
27
+ export type { ListEventsArgs, CountEventsArgs, MonthlyEventCountsArgs, MonthlyCountBucket, } from './query.js';
28
+ export { pruneAuditEvents, previewPrune } from './retention.js';
29
+ export type { PruneOptions } from './retention.js';
30
+ export { getAuditMigrationsDir } from './path.js';
31
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,YAAY,EACV,UAAU,EACV,eAAe,EACf,UAAU,EACV,cAAc,EACd,WAAW,EACX,WAAW,EACX,UAAU,EACV,OAAO,GACR,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EACL,UAAU,EACV,WAAW,EACX,kBAAkB,GACnB,MAAM,YAAY,CAAC;AACpB,YAAY,EACV,cAAc,EACd,eAAe,EACf,sBAAsB,EACtB,kBAAkB,GACnB,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAChE,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,28 @@
1
+ /**
2
+ * @venturekit-pro/audit
3
+ *
4
+ * Strictly-scoped, append-only audit log.
5
+ *
6
+ * Records WHO did WHAT, TO WHAT, WHEN, and HOW IT WENT. Nothing else.
7
+ * Domain rollups (cost, payment totals, token usage) live in their
8
+ * own packages' tables and reference this one via `correlationId` /
9
+ * `target`.
10
+ *
11
+ * - `record(querier, input)` — write one event.
12
+ * - `listEvents(querier, args)` — paginated newest-first list.
13
+ * - `countEvents(querier, args)` — count, with optional
14
+ * byKindPrefix split.
15
+ * - `monthlyEventCounts(querier, args)` — trailing-N-months
16
+ * activity volume.
17
+ * - `pruneAuditEvents` / `previewPrune` — retention sweep
18
+ * (privileged role).
19
+ * - `getAuditMigrationsDir()` — path to `vk_audit_*.sql`
20
+ * files for `vk migrate`.
21
+ *
22
+ * Documentation: https://venturekit.dev
23
+ */
24
+ export { record } from './record.js';
25
+ export { listEvents, countEvents, monthlyEventCounts, } from './query.js';
26
+ export { pruneAuditEvents, previewPrune } from './retention.js';
27
+ export { getAuditMigrationsDir } from './path.js';
28
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAaH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EACL,UAAU,EACV,WAAW,EACX,kBAAkB,GACnB,MAAM,YAAY,CAAC;AAQpB,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAGhE,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC"}
@@ -0,0 +1,152 @@
1
+ -- @venturekit-pro/audit — initial schema.
2
+ --
3
+ -- One canonical, append-only `audit_events` table. Stores WHO did
4
+ -- WHAT, TO WHAT, WHEN, and HOW IT WENT. Nothing else.
5
+ --
6
+ -- **Strict scope.** The audit package does not know about LLM costs,
7
+ -- token counts, image generation, payment amounts, or any other
8
+ -- domain concern. Those live in their own packages / tables
9
+ -- (e.g. `@venturekit-pro/ai`'s `llm_cost_events`); audit events
10
+ -- merely reference them by `target_type` / `target_id` /
11
+ -- `correlation_id`.
12
+ --
13
+ -- Append-only by construction:
14
+ -- - No UPDATE / DELETE statements are issued by the package code.
15
+ -- - DB-level REVOKE on `audit_events` from the application role
16
+ -- at the bottom of this migration enforces it physically.
17
+ -- Privileged maintenance (retention pruning) runs as a
18
+ -- separate role.
19
+ --
20
+ -- Idempotency:
21
+ -- - `idempotency_key` is OPTIONAL on insert. When set, the
22
+ -- partial unique index makes a re-insert a no-op (caller
23
+ -- catches the duplicate-key error in `record()` and returns
24
+ -- the original row).
25
+
26
+ CREATE EXTENSION IF NOT EXISTS pgcrypto;
27
+
28
+ -- ─── Status enum ────────────────────────────────────────────────────
29
+ --
30
+ -- Outcome of an audited action. Mirrors the standard `job_status`
31
+ -- shape so callers can map 1:1.
32
+
33
+ DO $$
34
+ BEGIN
35
+ IF NOT EXISTS (SELECT 1 FROM pg_type WHERE typname = 'vk_audit_status') THEN
36
+ CREATE TYPE vk_audit_status AS ENUM (
37
+ 'queued',
38
+ 'running',
39
+ 'succeeded',
40
+ 'failed',
41
+ 'skipped'
42
+ );
43
+ END IF;
44
+ END
45
+ $$;
46
+
47
+ DO $$
48
+ BEGIN
49
+ IF NOT EXISTS (SELECT 1 FROM pg_type WHERE typname = 'vk_audit_actor_type') THEN
50
+ CREATE TYPE vk_audit_actor_type AS ENUM (
51
+ 'user', -- end-user via session token
52
+ 'service', -- internal service identity
53
+ 'cron', -- scheduled-job Lambda
54
+ 'api_key', -- programmatic-access key
55
+ 'system' -- bootstrap / migration / cross-tenant maintenance
56
+ );
57
+ END IF;
58
+ END
59
+ $$;
60
+
61
+ -- ─── audit_events ───────────────────────────────────────────────────
62
+
63
+ CREATE TABLE IF NOT EXISTS audit_events (
64
+ id uuid PRIMARY KEY DEFAULT gen_random_uuid(),
65
+ -- tenant_id is nullable so we can record platform-wide events
66
+ -- (e.g. cron sweeps that fan out across every tenant). Per-tenant
67
+ -- views filter on `tenant_id = $1`; the rare cross-tenant rows
68
+ -- show up only when querying with `tenant_id IS NULL`.
69
+ tenant_id uuid,
70
+ -- WHO did the thing.
71
+ actor_type vk_audit_actor_type NOT NULL,
72
+ -- Free-form actor id. For users: their auth id (e.g. Cognito sub).
73
+ -- For services: service name. For api_key: key prefix. For cron:
74
+ -- schedule rule name. NULL only for bootstrap / system rows.
75
+ actor_id text,
76
+ -- WHAT happened. Free-form, app-namespaced (e.g. `'blog.save'`,
77
+ -- `'order.refunded'`, `'security.login'`). The package never
78
+ -- enumerates these; the calling app owns its kind taxonomy.
79
+ kind text NOT NULL,
80
+ -- WHAT it was done to (optional). target_type + target_id together
81
+ -- identify the row this event mutated or read.
82
+ target_type text,
83
+ target_id text,
84
+ -- Secondary identifier for human-readable references (slug, label).
85
+ target_slug text,
86
+ -- Outcome of the action. Finalized rows are NEVER UPDATE'd; long
87
+ -- operations write a `running` row, then a separate `succeeded` /
88
+ -- `failed` / `skipped` row with the same `correlation_id`.
89
+ status vk_audit_status NOT NULL DEFAULT 'succeeded',
90
+ -- Free-form payload. Caller's responsibility to keep this small
91
+ -- (~< 32KB) and PII-free. Heavy artifacts go in S3 + are
92
+ -- referenced by URL/key.
93
+ payload jsonb NOT NULL DEFAULT '{}'::jsonb,
94
+
95
+ -- ─── Cross-event correlation ─────────────────────────────────────
96
+
97
+ -- Threads multiple events into one logical operation (a workflow
98
+ -- run, an HTTP request, a saga).
99
+ correlation_id text,
100
+ -- Optional idempotency token; supports safe retry of e.g. cron
101
+ -- ticks. NULL is allowed and skips the dedup check.
102
+ idempotency_key text,
103
+ -- Human-readable failure summary when `status = 'failed'`.
104
+ error_message text,
105
+
106
+ created_at timestamptz NOT NULL DEFAULT now()
107
+ );
108
+
109
+ -- ─── Indexes ────────────────────────────────────────────────────────
110
+
111
+ -- Main page query: "show me the last N events for this tenant".
112
+ CREATE INDEX IF NOT EXISTS audit_events_tenant_created_idx
113
+ ON audit_events (tenant_id, created_at DESC);
114
+
115
+ -- Filtered list: "show me the last N 'order.refunded' events".
116
+ CREATE INDEX IF NOT EXISTS audit_events_tenant_kind_idx
117
+ ON audit_events (tenant_id, kind, created_at DESC);
118
+
119
+ -- Per-entity history: "every event touching blog_post X".
120
+ CREATE INDEX IF NOT EXISTS audit_events_target_idx
121
+ ON audit_events (tenant_id, target_type, target_id, created_at DESC);
122
+
123
+ -- Correlation join: "every event in this workflow run".
124
+ CREATE INDEX IF NOT EXISTS audit_events_correlation_idx
125
+ ON audit_events (correlation_id, created_at DESC)
126
+ WHERE correlation_id IS NOT NULL;
127
+
128
+ -- Idempotency dedup. Partial because the vast majority of rows
129
+ -- have idempotency_key = NULL.
130
+ CREATE UNIQUE INDEX IF NOT EXISTS audit_events_idempotency_unique
131
+ ON audit_events (idempotency_key)
132
+ WHERE idempotency_key IS NOT NULL;
133
+
134
+ -- ─── Append-only enforcement at the storage layer ───────────────────
135
+ --
136
+ -- The application role can INSERT and SELECT but never UPDATE /
137
+ -- DELETE. A privileged maintenance role (whatever the app uses to
138
+ -- run migrations) retains full privileges, and is what retention
139
+ -- sweeps run as.
140
+ --
141
+ -- We don't know the application role's name at migration time — apps
142
+ -- vary (`venturekit_cms_app`, `myapp_runtime`, …). The REVOKE here
143
+ -- targets `PUBLIC` which covers the default no-role-set case AND
144
+ -- means the application role inherits the lockdown unless explicitly
145
+ -- granted UPDATE/DELETE. Apps that grant their runtime role
146
+ -- `ALL PRIVILEGES` on the schema must re-revoke after this migration.
147
+
148
+ REVOKE UPDATE, DELETE ON audit_events FROM PUBLIC;
149
+
150
+ -- A convenience GRANT so the app role still works for inserts and
151
+ -- reads when only PUBLIC's privileges were revoked.
152
+ GRANT SELECT, INSERT ON audit_events TO PUBLIC;
package/dist/path.d.ts ADDED
@@ -0,0 +1,28 @@
1
+ /**
2
+ * Migrations-dir helper.
3
+ *
4
+ * The CMS wires this into `vk.config.ts:extraMigrationsDirs` so
5
+ * `vk migrate` picks up the package's `vk_audit_*.sql` files
6
+ * alongside the project's own migrations.
7
+ *
8
+ * The directory is bundled into the built package (via the
9
+ * `files: ["src/migrations/*.sql"]` declaration in `package.json`,
10
+ * mirrored into `dist/migrations/` by the build script). Apps
11
+ * consuming the source rather than the build (workspace symlinks)
12
+ * read straight from `src/migrations/`.
13
+ */
14
+ /**
15
+ * Absolute path to the `audit_events` migration files.
16
+ *
17
+ * @example
18
+ * ```ts
19
+ * // vk.config.ts
20
+ * import { getAuditMigrationsDir } from '@venturekit-pro/audit';
21
+ *
22
+ * export default defineVenture({
23
+ * extraMigrationsDirs: [getAuditMigrationsDir()],
24
+ * });
25
+ * ```
26
+ */
27
+ export declare function getAuditMigrationsDir(): string;
28
+ //# sourceMappingURL=path.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"path.d.ts","sourceRoot":"","sources":["../src/path.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAMH;;;;;;;;;;;;GAYG;AACH,wBAAgB,qBAAqB,IAAI,MAAM,CAQ9C"}
package/dist/path.js ADDED
@@ -0,0 +1,40 @@
1
+ /**
2
+ * Migrations-dir helper.
3
+ *
4
+ * The CMS wires this into `vk.config.ts:extraMigrationsDirs` so
5
+ * `vk migrate` picks up the package's `vk_audit_*.sql` files
6
+ * alongside the project's own migrations.
7
+ *
8
+ * The directory is bundled into the built package (via the
9
+ * `files: ["src/migrations/*.sql"]` declaration in `package.json`,
10
+ * mirrored into `dist/migrations/` by the build script). Apps
11
+ * consuming the source rather than the build (workspace symlinks)
12
+ * read straight from `src/migrations/`.
13
+ */
14
+ import * as path from 'node:path';
15
+ import { fileURLToPath } from 'node:url';
16
+ import * as fs from 'node:fs';
17
+ /**
18
+ * Absolute path to the `audit_events` migration files.
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * // vk.config.ts
23
+ * import { getAuditMigrationsDir } from '@venturekit-pro/audit';
24
+ *
25
+ * export default defineVenture({
26
+ * extraMigrationsDirs: [getAuditMigrationsDir()],
27
+ * });
28
+ * ```
29
+ */
30
+ export function getAuditMigrationsDir() {
31
+ const here = path.dirname(fileURLToPath(import.meta.url));
32
+ // After build: dist/path.js, migrations under dist/migrations/.
33
+ // From source (workspace symlink): src/path.ts, migrations under
34
+ // src/migrations/. Try the built layout first, fall back to source.
35
+ const builtDir = path.join(here, 'migrations');
36
+ if (fs.existsSync(builtDir))
37
+ return builtDir;
38
+ return path.join(here, 'migrations');
39
+ }
40
+ //# sourceMappingURL=path.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"path.js","sourceRoot":"","sources":["../src/path.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAE9B;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,qBAAqB;IACnC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1D,gEAAgE;IAChE,iEAAiE;IACjE,oEAAoE;IACpE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAC/C,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;QAAE,OAAO,QAAQ,CAAC;IAC7C,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;AACvC,CAAC"}