Initial Commit

openspec/changes/enterprise-api-plugin-analytics/proposal.md

@@ -0,0 +1,88 @@
+# OpenSpec Change: enterprise-api-plugin-analytics
+
+- **Change ID**: enterprise-api-plugin-analytics
+- **Package**: `@suaveplan/api-plugin-analytics`
+- **Category**: api/data
+- **Target path**: `api/data/api-plugin-analytics`
+- **Status**: PROPOSED
+- **Date**: 2026-04-24
+- **Reference spec**: `/mnt/s/web/suaveplan/enterprise/api-plugin-analytics.md`
+
+---
+
+## Summary
+
+Deliver `@suaveplan/api-plugin-analytics` on the genesis branch from scratch at enterprise quality. Product-analytics plugin for `@suaveplan/api`. Genesis rebuild fixes all identified gaps: replaces the in-memory ring buffer with a pluggable `StorageAdapter` (in-memory for dev, SurrealDB for production), adds HTTP routes (`POST /track`, `POST /track/batch`, `POST /query/aggregate`, `POST /query/funnel`, `POST /query/cohort`, `DELETE /analytics/purge`), proper `EventMap` declaration via `src/events.ts` module augmentation (dropping `as Parameters<...>` cast), per-event-type schema validation via `@suaveplan/schema-registry`, PII masking via `@suaveplan/data-masking`, and batch idempotency via `@suaveplan/idempotency`.
+
+---
+
+## Available workspace deps on genesis
+
+| Package | Role |
+|---|---|
+| `@suaveplan/api` (`workspace:^`) | `definePlugin` |
+| `@suaveplan/api-shared` (`workspace:^`) | Helpers |
+| `@suaveplan/api-plugin-auth` (`workspace:^`) | `requireAuth` |
+| `@suaveplan/api-plugin-database` (`workspace:^`) | SurrealDB adapter |
+| `@suaveplan/events` (`workspace:^`) | Typed event bus |
+| `@suaveplan/schema-registry` (`workspace:^`) | Event schema versioning |
+| `@suaveplan/data-masking` (`workspace:^`) | PII masking on ingestion |
+| `@suaveplan/idempotency` (`workspace:^`) | Batch ingestion dedup |
+| `@suaveplan/error` (`workspace:^`) | `AnalyticsError` hierarchy |
+| `@suaveplan/rate-limiter` (`workspace:^`) | Ingestion rate limits |
+| `hono` + `@hono/zod-openapi` + `zod` | Routes |
+| `@opentelemetry/api` | OTel |
+
+---
+
+## Public API surface (preserves + extends existing)
+
+```ts
+function createAnalyticsPlugin(config?: AnalyticsConfig): PluginDescriptor
+
+// Services (preserved)
+class AnalyticsService      // track, aggregate, clear — now backed by StorageAdapter
+class FunnelAnalyzer        // funnel conversion rates
+class CohortAnalyzer        // cohort retention
+
+// Types (preserved)
+AnalyticsEvent, TrackEventInput, TimeGranularity, TimeSeriesPoint
+AggregationQuery, AggregationResult
+FunnelQuery, FunnelStep, FunnelStepResult, FunnelResult
+CohortQuery, CohortRow, CohortResult, AnalyticsEventMap
+
+// New
+interface StorageAdapter { track, query, purge, getStats }
+dateToPeriodKey (preserved)
+```
+
+### Error codes (new)
+
+```ts
+type AnalyticsErrorCode =
+  | "ANALYTICS_INVALID_EVENT"
+  | "ANALYTICS_STORAGE_ERROR"
+  | "ANALYTICS_SCHEMA_MISMATCH"
+  | "ANALYTICS_QUERY_INVALID"
+```
+
+---
+
+## File layout
+
+```text
+api/data/api-plugin-analytics/
+  package.json  tsconfig.json  vitest.config.ts
+  src/
+    index.ts  events.ts  types.ts  errors/
+    adapters/storage.port.ts  adapters/memory-storage.ts  adapters/surreal-storage.ts
+    analytics/analytics.ts  cohort/cohort.ts  funnel/funnel.ts
+    routes/track/  routes/query/  routes/admin/
+  tests/integration.test.ts
+```
+
+---
+
+## Impact
+
+Prerequisites: `@suaveplan/api`, `@suaveplan/api-plugin-auth`, `@suaveplan/api-plugin-database`, `@suaveplan/events`, `@suaveplan/schema-registry`, `@suaveplan/data-masking`, `@suaveplan/idempotency`.

openspec/changes/enterprise-api-plugin-analytics/tasks.md

@@ -0,0 +1,61 @@
+# Tasks: enterprise-api-plugin-analytics
+
+**Change ID**: enterprise-api-plugin-analytics
+**Package**: `@suaveplan/api-plugin-analytics`
+**Target path**: `api/data/api-plugin-analytics`
+**Prerequisite packages on Verdaccio**: `@suaveplan/api`, `@suaveplan/api-shared`, `@suaveplan/api-plugin-auth`, `@suaveplan/api-plugin-database`, `@suaveplan/events`, `@suaveplan/schema-registry`, `@suaveplan/data-masking`, `@suaveplan/idempotency`, `@suaveplan/rate-limiter`, `@suaveplan/error`
+
+---
+
+## 0. Pre-flight (non-negotiable)
+
+- [ ] 0.1 Confirm clean working tree (`git status` reports nothing) and no in-flight worktrees with uncommitted work (`git worktree list` then `git status` in each)
+- [ ] 0.2 If any worktrees exist under `.claude/worktrees/`, account for each one: still-active agent, work-pending-merge, or stale-and-prune. Stale worktrees MUST be removed (`git worktree remove`) before opening a new one — code that has been lost twice on main is the failure mode this guards against.
+- [ ] 0.3 Confirm the package set in `MANIFEST.md` matches `find packages -maxdepth 3 -name package.json` count. Drift here means a prior change archived without regenerating the manifest.
+
+## 1. Scaffold + types + errors + events
+
+- [ ] Create `api/data/api-plugin-analytics/`; `package.json` v0.0.0; standard tooling.
+- [ ] `src/types.ts` — preserve all existing types; add `StorageAdapter` interface, `AnalyticsConfig` (Zod), `AnalyticsErrorCode`.
+- [ ] `src/errors/` — 4-code union + metadata + registration. Test + doc.
+- [ ] `src/events.ts` — `AnalyticsEventMap` module augmentation (analytics:initialized, analytics:event:tracked); NO `as Parameters<...>` casts.
+
+---
+
+## 2. Storage adapters
+
+- [ ] `src/adapters/storage.port.ts` — `StorageAdapter` interface: `track(event)`, `query(params)`, `purge(filter)`, `getStats()`.
+- [ ] `src/adapters/memory-storage.ts` — bounded ring buffer (preserved from main). `.test.ts` + `.md`.
+- [ ] `src/adapters/surreal-storage.ts` — SurrealDB-backed adapter. `.test.ts` + `.md`.
+
+---
+
+## 3. Core services (preserve existing, add adapter injection)
+
+- [ ] **AnalyticsService**: inject `StorageAdapter`; `track` applies PII masking + schema validation before storage. Preserve `aggregate`, `clear`, `dateToPeriodKey`.
+- [ ] **FunnelAnalyzer**: preserve existing implementation. `.test.ts` + `.md`.
+- [ ] **CohortAnalyzer**: preserve existing implementation. `.test.ts` + `.md`.
+
+---
+
+## 4. Routes
+
+- [ ] `POST /analytics/track` — `requireAuth`; single event; rate-limited.
+- [ ] `POST /analytics/track/batch` — `requireAuth`; idempotency key; rate-limited.
+- [ ] `POST /analytics/query/aggregate` — `requireAuth`.
+- [ ] `POST /analytics/query/funnel` — `requireAuth`.
+- [ ] `POST /analytics/query/cohort` — `requireAuth`.
+- [ ] `DELETE /analytics/purge` — `requireAuth` + `requireRole("ADMIN")`.
+- [ ] `GET /analytics/stats` — `requireAuth` + `requireRole("ADMIN")`.
+- [ ] Route `.test.ts` + `.md`.
+
+---
+
+## 5. Plugin factory + integration tests + publish
+
+- [ ] `createAnalyticsPlugin(config?)`: `enabledByDefault: true`, `dependencies: ["database"]`.
+- [ ] Default to `SurrealStorageAdapter`; fall back to `MemoryStorageAdapter` when no DB plugin available.
+- [ ] Integration: track events → aggregate → funnel → cohort → purge (real SurrealDB).
+- [ ] `bunx turbo lint typecheck test --filter=@suaveplan/api-plugin-analytics` — green; 100% coverage.
+- [ ] `bun scripts/publish.ts --package @suaveplan/api-plugin-analytics`.
+- [ ] Archive → `openspec/archive/2026-04-24-enterprise-api-plugin-analytics/`.