Skip to content

Repository files navigation

Kamod Tracking

First-party product analytics SDK (library only — not a hosted collector or dashboard).

Consumer install (reproducible)

git clone <repo>
cd kamod-tracking
pnpm install          # pnpm 11.25.0 (see packageManager)
pnpm verify           # typecheck, lint, format, unit tests, examples (memory), build, exports, bundle, e2e smoke

With PostgreSQL (required for SQL integration release gate):

docker compose -f docker-compose.tracking-test.yml up -d
export TRACKING_TEST_DATABASE_URL='postgres://tracking:tracking@127.0.0.1:54329/tracking_test'
pnpm verify:all       # verify + pnpm test:postgres + collector-postgres example

CI runs the same split: job quality → pnpm verify; job postgres → pnpm test:postgres (see docs/verify-matrix.md).

Package surface

Import Role
@kamod-ch/tracking Event contract, registry, consent stores
@kamod-ch/tracking/browser Browser client (no Node / no pg)
@kamod-ch/tracking/preact Optional Preact adapter
@kamod-ch/tracking/server Collectors (Request → Response)
@kamod-ch/tracking/postgres Optional PostgreSQL adapter (peer pg)

Examples

Tier Path
Memory demos examples/vanilla-browser, examples/server-outbox-postgres
PostgreSQL integration examples/collector-postgres — browser collector + PG batch adapter + ops counters
Product consumer Your app repo — mount handlers, run workers, own outbox tables

Index: examples/README.md.

Documentation

Local commands

pnpm typecheck
pnpm test              # unit (PostgreSQL tests excluded without env)
pnpm test:postgres     # requires TRACKING_TEST_DATABASE_URL
pnpm build
pnpm check:exports     # packed tarball + browser bundle guard
pnpm measure:bundle

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages