@contractspec/module.audit-trail 3.7.6 → 3.7.10

package/README.md

@@ -1,113 +1,68 @@
 # @contractspec/module.audit-trail
 
-Website: https://contractspec.io/
+Website: https://contractspec.io
 
+**Audit trail module for tracking and querying system events.**
 
-Audit trail module for tracking and querying system events in ContractSpec applications.
+## What It Provides
 
-## Purpose
+- **Layer**: module.
+- **Consumers**: bundles (library, contractspec-studio), apps (web-landing).
+- `src/contracts/` contains contract specs, operations, entities, and registry exports.
+- Related ContractSpec packages include `@contractspec/lib.bus`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.schema`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
+- `src/contracts/` contains contract specs, operations, entities, and registry exports.
 
-Provides a complete audit logging solution that captures, stores, and queries audit events. Integrates with the event bus to automatically capture domain events and exposes a query API for compliance and debugging.
-
-## Features
+## Installation
 
-- **Event Capture**: Automatic capture of events from the event bus
-- **Persistent Storage**: Multiple storage adapters (Prisma, append-only log)
-- **Rich Querying**: Filter by actor, target, organization, time range
-- **Retention Policies**: Configurable retention and archival
-- **Export**: Export audit logs for compliance reporting
+`npm install @contractspec/module.audit-trail`
 
-## Installation
+or
 
-```bash
-bun add @contractspec/module.audit-trail
-```
+`bun add @contractspec/module.audit-trail`
 
 ## Usage
 
-### Entity Specs (for schema generation)
-
-```typescript
-import { auditTrailSchemaContribution } from '@contractspec/module.audit-trail/entities';
-
-// Use in schema composition
-const config = {
-  modules: [auditTrailSchemaContribution],
-};
-```
-
-### Set Up Audit Capture
-
-```typescript
-import { createAuditCapture, PrismaAuditStorage } from '@contractspec/module.audit-trail';
-import { prisma } from './db';
-
-// Create storage adapter
-const storage = new PrismaAuditStorage(prisma);
-
-// Create audit capture (connects to event bus)
-const auditCapture = createAuditCapture({
-  bus: eventBus,
-  storage,
-  filters: {
-    // Only audit events with audit:true tag or from specific domains
-    domains: ['identity', 'billing', 'security'],
-  },
-});
-
-// Start capturing
-auditCapture.start();
-```
-
-### Query Audit Logs
-
-```typescript
-import { AuditLogService } from '@contractspec/module.audit-trail';
-
-const service = new AuditLogService(storage);
-
-// Query by actor
-const userActions = await service.query({
-  actorId: 'user-123',
-  from: new Date('2024-01-01'),
-  to: new Date(),
-  limit: 100,
-});
-
-// Query by target
-const resourceChanges = await service.query({
-  targetId: 'project-456',
-  eventName: 'project.*',
-});
-
-// Export for compliance
-const report = await service.export({
-  orgId: 'org-789',
-  from: new Date('2024-01-01'),
-  to: new Date('2024-12-31'),
-  format: 'csv',
-});
-```
-
-## Entity Overview
-
-| Entity | Description |
-|--------|-------------|
-| AuditLog | Main audit log entry |
-| AuditLogArchive | Archived logs for retention |
-
-## Retention
-
-Configure retention policies:
-
-```typescript
-const retention = new RetentionPolicy({
-  // Keep detailed logs for 90 days
-  hotRetentionDays: 90,
-  // Archive for 7 years (compliance)
-  archiveRetentionDays: 2555,
-  // Run cleanup daily at 3 AM
-  cleanupSchedule: '0 3 * * *',
-});
-```
+Import the root entrypoint from `@contractspec/module.audit-trail`, or choose a documented subpath when you only need one part of the package surface.
+
+## Architecture
+
+- `src/audit-trail.capability.ts` defines a capability surface.
+- `src/audit-trail.feature.ts` defines a feature entrypoint.
+- `src/contracts/` contains contract specs, operations, entities, and registry exports.
+- `src/entities/` contains domain entities and value objects.
+- `src/index.ts` is the root public barrel and package entrypoint.
+- `src/storage/` contains persistence adapters and storage implementations.
+
+## Public Entry Points
+
+- Export `.` resolves through `./src/index.ts`.
+- Export `./audit-trail.capability` resolves through `./src/audit-trail.capability.ts`.
+- Export `./audit-trail.feature` resolves through `./src/audit-trail.feature.ts`.
+- Export `./contracts` resolves through `./src/contracts/index.ts`.
+- Export `./entities` resolves through `./src/entities/index.ts`.
+- Export `./storage` resolves through `./src/storage/index.ts`.
+
+## Local Commands
+
+- `bun run dev` — contractspec-bun-build dev
+- `bun run build` — bun run prebuild && bun run build:bundle && bun run build:types
+- `bun run lint` — bun lint:fix
+- `bun run lint:check` — biome check .
+- `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
+- `bun run typecheck` — tsc --noEmit
+- `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose
+- `bun run publish:pkg:canary` — bun publish:pkg --tag canary
+- `bun run clean` — rimraf dist .turbo
+- `bun run build:bundle` — contractspec-bun-build transpile
+- `bun run build:types` — contractspec-bun-build types
+- `bun run prebuild` — contractspec-bun-build prebuild
+
+## Recent Updates
+
+- Replace eslint+prettier by biomejs to optimize speed.
+
+## Notes
 
+- Depends on `lib.bus` for event dispatch -- never emit events outside the bus.
+- Audit records are append-only; mutations or deletions break compliance invariants.
+- Storage adapters must implement the store interface; do not bypass it.

package/dist/browser/contracts/index.js

@@ -1,9 +1,9 @@
 // src/contracts/index.ts
 import { defineCommand, defineQuery } from "@contractspec/lib.contracts-spec";
 import {
-  ScalarTypeEnum,
   defineEnum,
-  defineSchemaModel
+  defineSchemaModel,
+  ScalarTypeEnum
 } from "@contractspec/lib.schema";
 var OWNERS = ["platform.audit-trail"];
 var AuditLogModel = defineSchemaModel({

package/dist/browser/index.js

@@ -31,9 +31,9 @@ var AuditTrailFeature = defineFeature({
 // src/contracts/index.ts
 import { defineCommand, defineQuery } from "@contractspec/lib.contracts-spec";
 import {
-  ScalarTypeEnum,
   defineEnum,
-  defineSchemaModel
+  defineSchemaModel,
+  ScalarTypeEnum
 } from "@contractspec/lib.schema";
 var OWNERS = ["platform.audit-trail"];
 var AuditLogModel = defineSchemaModel({

package/dist/contracts/index.js

@@ -2,9 +2,9 @@
 // src/contracts/index.ts
 import { defineCommand, defineQuery } from "@contractspec/lib.contracts-spec";
 import {
-  ScalarTypeEnum,
   defineEnum,
-  defineSchemaModel
+  defineSchemaModel,
+  ScalarTypeEnum
 } from "@contractspec/lib.schema";
 var OWNERS = ["platform.audit-trail"];
 var AuditLogModel = defineSchemaModel({

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-export * from './entities';
+export type { AuditQueryOptions, AuditRecord, AuditStorage, } from '@contractspec/lib.bus';
+export * from './audit-trail.feature';
 export * from './contracts';
+export * from './entities';
 export * from './storage';
-export * from './audit-trail.feature';
-export type { AuditRecord, AuditStorage, AuditQueryOptions, } from '@contractspec/lib.bus';

package/dist/index.js

@@ -32,9 +32,9 @@ var AuditTrailFeature = defineFeature({
 // src/contracts/index.ts
 import { defineCommand, defineQuery } from "@contractspec/lib.contracts-spec";
 import {
-  ScalarTypeEnum,
   defineEnum,
-  defineSchemaModel
+  defineSchemaModel,
+  ScalarTypeEnum
 } from "@contractspec/lib.schema";
 var OWNERS = ["platform.audit-trail"];
 var AuditLogModel = defineSchemaModel({

package/dist/node/contracts/index.js

@@ -1,9 +1,9 @@
 // src/contracts/index.ts
 import { defineCommand, defineQuery } from "@contractspec/lib.contracts-spec";
 import {
-  ScalarTypeEnum,
   defineEnum,
-  defineSchemaModel
+  defineSchemaModel,
+  ScalarTypeEnum
 } from "@contractspec/lib.schema";
 var OWNERS = ["platform.audit-trail"];
 var AuditLogModel = defineSchemaModel({

package/dist/node/index.js

@@ -31,9 +31,9 @@ var AuditTrailFeature = defineFeature({
 // src/contracts/index.ts
 import { defineCommand, defineQuery } from "@contractspec/lib.contracts-spec";
 import {
-  ScalarTypeEnum,
   defineEnum,
-  defineSchemaModel
+  defineSchemaModel,
+  ScalarTypeEnum
 } from "@contractspec/lib.schema";
 var OWNERS = ["platform.audit-trail"];
 var AuditLogModel = defineSchemaModel({

package/dist/storage/index.d.ts

@@ -1,4 +1,4 @@
-import type { AuditRecord, AuditQueryOptions, AuditStorage } from '@contractspec/lib.bus';
+import type { AuditQueryOptions, AuditRecord, AuditStorage } from '@contractspec/lib.bus';
 /**
  * Extended query options for audit storage.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contractspec/module.audit-trail",
-  "version": "3.7.6",
+  "version": "3.7.10",
   "description": "Audit trail module for tracking and querying system events",
   "keywords": [
     "contractspec",
@@ -21,21 +21,21 @@
     "dev": "contractspec-bun-build dev",
     "clean": "rimraf dist .turbo",
     "lint": "bun lint:fix",
-    "lint:fix": "eslint src --fix",
-    "lint:check": "eslint src",
+    "lint:fix": "biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .",
+    "lint:check": "biome check .",
     "prebuild": "contractspec-bun-build prebuild",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@contractspec/lib.schema": "3.7.6",
-    "@contractspec/lib.contracts-spec": "3.7.6",
-    "@contractspec/lib.bus": "3.7.6",
+    "@contractspec/lib.schema": "3.7.8",
+    "@contractspec/lib.contracts-spec": "4.1.2",
+    "@contractspec/lib.bus": "3.7.10",
     "zod": "^4.3.5"
   },
   "devDependencies": {
-    "@contractspec/tool.typescript": "3.7.6",
+    "@contractspec/tool.typescript": "3.7.8",
     "typescript": "^5.9.3",
-    "@contractspec/tool.bun": "3.7.6"
+    "@contractspec/tool.bun": "3.7.8"
   },
   "exports": {
     ".": {