hazo_audit 1.0.0

package/migrations/001_init.sql

@@ -0,0 +1,149 @@
+-- hazo_audit database schema
+-- Supports both PostgreSQL and SQLite
+--
+-- Three tables:
+--   hazo_audit_outbox  : queue produced by wrapWithAudit, drained by the worker
+--   hazo_audit_field   : per-leaf field events the UI reads from
+--   hazo_audit_intent  : Layer-1 named events (e.g., 'audit_reveal')
+--
+-- ============================================================================
+-- SQLite version (commented; uncomment when running against SQLite)
+-- ============================================================================
+--
+-- CREATE TABLE IF NOT EXISTS hazo_audit_outbox (
+--   id              TEXT PRIMARY KEY,
+--   scope_id        TEXT,
+--   correlation_id  TEXT NOT NULL,
+--   table_name      TEXT NOT NULL,
+--   subject_kind    TEXT NOT NULL,
+--   subject_id      TEXT NOT NULL,
+--   op              TEXT NOT NULL CHECK (op IN ('insert','update','delete')),
+--   before_row      TEXT,
+--   after_row       TEXT,
+--   actor_kind      TEXT NOT NULL,
+--   actor_user_id   TEXT,
+--   actor_label     TEXT,
+--   intent_event    TEXT,
+--   intent_payload  TEXT,
+--   created_at      TEXT NOT NULL DEFAULT (datetime('now')),
+--   drained_at      TEXT,
+--   attempt_count   INTEGER NOT NULL DEFAULT 0,
+--   last_attempt_at TEXT,
+--   failed_at       TEXT,
+--   failure_reason  TEXT
+-- );
+--
+-- CREATE INDEX IF NOT EXISTS ix_hazo_audit_outbox_drain
+--   ON hazo_audit_outbox (drained_at, failed_at, attempt_count, last_attempt_at);
+--
+-- CREATE INDEX IF NOT EXISTS ix_hazo_audit_outbox_chain
+--   ON hazo_audit_outbox (subject_kind, subject_id, created_at);
+--
+-- CREATE TABLE IF NOT EXISTS hazo_audit_field (
+--   id              TEXT PRIMARY KEY,
+--   scope_id        TEXT,
+--   correlation_id  TEXT NOT NULL,
+--   subject_kind    TEXT NOT NULL,
+--   subject_id      TEXT NOT NULL,
+--   field_path      TEXT NOT NULL,
+--   op              TEXT NOT NULL CHECK (op IN ('insert','update','delete')),
+--   before_value    TEXT,
+--   after_value     TEXT,
+--   is_sensitive    INTEGER NOT NULL DEFAULT 0,
+--   actor_kind      TEXT NOT NULL,
+--   actor_user_id   TEXT,
+--   actor_label     TEXT,
+--   occurred_at     TEXT NOT NULL DEFAULT (datetime('now'))
+-- );
+--
+-- CREATE INDEX IF NOT EXISTS ix_hazo_audit_field_subject
+--   ON hazo_audit_field (subject_kind, subject_id, field_path, occurred_at);
+--
+-- CREATE TABLE IF NOT EXISTS hazo_audit_intent (
+--   id              TEXT PRIMARY KEY,
+--   scope_id        TEXT,
+--   correlation_id  TEXT NOT NULL,
+--   event_name      TEXT NOT NULL,
+--   payload         TEXT,
+--   subject_kind    TEXT,
+--   subject_id      TEXT,
+--   actor_kind      TEXT NOT NULL,
+--   actor_user_id   TEXT,
+--   actor_label     TEXT,
+--   occurred_at     TEXT NOT NULL DEFAULT (datetime('now'))
+-- );
+--
+-- CREATE INDEX IF NOT EXISTS ix_hazo_audit_intent_event
+--   ON hazo_audit_intent (event_name, occurred_at);
+--
+-- ============================================================================
+-- PostgreSQL version (active)
+-- ============================================================================
+
+CREATE TABLE IF NOT EXISTS hazo_audit_outbox (
+  id              UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+  scope_id        UUID,
+  correlation_id  UUID NOT NULL,
+  table_name      TEXT NOT NULL,
+  subject_kind    TEXT NOT NULL,
+  subject_id      TEXT NOT NULL,
+  op              TEXT NOT NULL CHECK (op IN ('insert','update','delete')),
+  before_row      JSONB,
+  after_row       JSONB,
+  actor_kind      TEXT NOT NULL,
+  actor_user_id   UUID,
+  actor_label     TEXT,
+  intent_event    TEXT,
+  intent_payload  JSONB,
+  created_at      TIMESTAMPTZ NOT NULL DEFAULT NOW(),
+  drained_at      TIMESTAMPTZ,
+  attempt_count   INTEGER NOT NULL DEFAULT 0,
+  last_attempt_at TIMESTAMPTZ,
+  failed_at       TIMESTAMPTZ,
+  failure_reason  TEXT
+);
+
+CREATE INDEX IF NOT EXISTS ix_hazo_audit_outbox_drain
+  ON hazo_audit_outbox (drained_at, failed_at, attempt_count, last_attempt_at)
+  WHERE drained_at IS NULL AND failed_at IS NULL;
+
+CREATE INDEX IF NOT EXISTS ix_hazo_audit_outbox_chain
+  ON hazo_audit_outbox (subject_kind, subject_id, created_at DESC)
+  WHERE drained_at IS NOT NULL;
+
+CREATE TABLE IF NOT EXISTS hazo_audit_field (
+  id              UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+  scope_id        UUID,
+  correlation_id  UUID NOT NULL,
+  subject_kind    TEXT NOT NULL,
+  subject_id      TEXT NOT NULL,
+  field_path      TEXT NOT NULL,
+  op              TEXT NOT NULL CHECK (op IN ('insert','update','delete')),
+  before_value    JSONB,
+  after_value     JSONB,
+  is_sensitive    BOOLEAN NOT NULL DEFAULT FALSE,
+  actor_kind      TEXT NOT NULL,
+  actor_user_id   UUID,
+  actor_label     TEXT,
+  occurred_at     TIMESTAMPTZ NOT NULL DEFAULT NOW()
+);
+
+CREATE INDEX IF NOT EXISTS ix_hazo_audit_field_subject
+  ON hazo_audit_field (subject_kind, subject_id, field_path, occurred_at DESC);
+
+CREATE TABLE IF NOT EXISTS hazo_audit_intent (
+  id              UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+  scope_id        UUID,
+  correlation_id  UUID NOT NULL,
+  event_name      TEXT NOT NULL,
+  payload         JSONB,
+  subject_kind    TEXT,
+  subject_id      TEXT,
+  actor_kind      TEXT NOT NULL,
+  actor_user_id   UUID,
+  actor_label     TEXT,
+  occurred_at     TIMESTAMPTZ NOT NULL DEFAULT NOW()
+);
+
+CREATE INDEX IF NOT EXISTS ix_hazo_audit_intent_event
+  ON hazo_audit_intent (event_name, occurred_at DESC);

package/package.json

@@ -0,0 +1,101 @@
+{
+  "name": "hazo_audit",
+  "version": "1.0.0",
+  "description": "Field-level audit trail for hazo_connect-backed apps. Attach to any adapter via wrapWithAudit() to auto-capture writes; ships worker, Next.js routes, and React UI primitives.",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./server": {
+      "types": "./dist/server/index.d.ts",
+      "default": "./dist/server/index.js"
+    },
+    "./nextjs": {
+      "types": "./dist/nextjs/index.d.ts",
+      "default": "./dist/nextjs/index.js"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "default": "./dist/client/index.js"
+    }
+  },
+  "bin": {
+    "hazo-audit-migrate": "./bin/hazo-audit-migrate.js"
+  },
+  "files": [
+    "dist",
+    "bin",
+    "config",
+    "migrations",
+    "README.md",
+    "SETUP_CHECKLIST.md",
+    "CHANGE_LOG.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "dev:package": "tsc -p tsconfig.build.json --watch",
+    "dev:test-app": "npm run build && cd test-app && npm run dev",
+    "build:test-app": "npm run build && cd test-app && npm run build",
+    "clean": "rm -rf dist",
+    "prebuild": "npm run clean",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "audit",
+    "hazo",
+    "history",
+    "outbox",
+    "field-level",
+    "react",
+    "typescript",
+    "nextjs"
+  ],
+  "author": "Pubs Abayasiri",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "clsx": "^2.1.1",
+    "ini": "^4.1.0",
+    "microdiff": "^1.5.0",
+    "server-only": "^0.0.1",
+    "tailwind-merge": "^3.5.0"
+  },
+  "peerDependencies": {
+    "hazo_auth": "^6.0.0",
+    "hazo_config": "^2.1.0",
+    "hazo_connect": "^2.6.0",
+    "hazo_logs": "^1.0.13",
+    "hazo_ui": "^2.8.0",
+    "next": "^14.0.0 || ^16.0.0",
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0"
+  },
+  "peerDependenciesMeta": {
+    "hazo_auth": { "optional": true },
+    "hazo_logs": { "optional": true },
+    "hazo_ui": { "optional": true },
+    "next": { "optional": true },
+    "react": { "optional": true },
+    "react-dom": { "optional": true }
+  },
+  "devDependencies": {
+    "@types/ini": "^4.1.1",
+    "@types/node": "^20.14.10",
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
+    "hazo_auth": "^6.0.0",
+    "hazo_config": "^2.1.0",
+    "hazo_connect": "^2.7.0",
+    "hazo_logs": "^1.0.13",
+    "next": "^14.2.33",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "typescript": "^5.7.2"
+  }
+}