Skip to content

armgit / crm

Public Imported from GitHub
0

Comp AI CRM is an open source, CRM designed for AI agents. Agentic-first CRM.

TypeScript
3.9 KB
Raw Blame

api

NestJS API for the CRM. Runs on Bun, backed by @crm/db and @crm/auth.

Running it

cp .env.example .env        # at the repo root — one file for the whole monorepo
openssl rand -base64 32     # -> BETTER_AUTH_SECRET

bun run dev                 # watch mode on http://localhost:3001
bun run test
bun run build && bun run start:prod

Three values are required and the process refuses to boot without them, naming the one it is missing: DATABASE_URL, BETTER_AUTH_SECRET and ALLOWED_SIGN_IN. GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET are the fourth value almost every install wants — they are both the sign-in button and the Gmail and Calendar sync — but they are optional and set as a pair, because an install that signs in through its own identity provider on Settings → SSO needs neither. With them, register http://localhost:3001/api/auth/callback/google as an authorised redirect URI. src/config/env.validation.ts is the full list of what this process reads; docs/environment.md explains where the file is found.

Bun is the runtime, not just the package manager: @crm/db and @crm/auth ship TypeScript sources, so tsc/node cannot run this app directly. tsc is used for type checking only (bun run check-types).

Routes

Route Auth Notes
/api/auth/* anonymous Mounted by @thallesp/nestjs-better-auth
/auth/me required Cached profile of the signed-in user
/auth/session optional Whether the caller is signed in
/health anonymous 200 with a database round-trip, 503 otherwise
/internal/sync/google CRON_SECRET bearer Vercel Cron entrypoint for Gmail/Calendar sync. Fails closed when the secret is unset.

How auth is wired

This process owns authentication. It mounts /api/auth/* and is the only one that writes session cookies; the Next.js app in apps/app reads those sessions straight from Postgres via @crm/auth and calls the routes above with credentials: "include".

AuthModule.forRoot({ auth }) mounts the Better Auth handler and registers a global AuthGuard, so every route is protected unless it opts out:

@Get('public')
@AllowAnonymous()          // no session required
@OptionalAuth()            // session optional; @Session() may be undefined

It also calls enableCors({ origin: trustedOrigins, credentials: true }) for the whole app, which is what lets the browser at localhost:3000 talk to it — APP_URL is the single knob for that, comma-separated if the app is served from more than one origin.

main.ts creates the app with bodyParser: false — Better Auth needs the raw request body, and the library installs its own parsers around the auth routes.

AuthHooksService uses @AfterUpdate("user") to drop a cached profile the moment its row changes. Database hooks require databaseHooks: {} in the Better Auth options and endpoint hooks require hooks: {} (both set in @crm/auth); the library throws at startup without them.

Caching

AppCacheModule registers @nestjs/cache-manager globally. It uses REDIS_URL when set and otherwise falls back to a per-instance in-memory store — fine for local development, not for more than one API instance.

AuthService.getProfile is the reference pattern: read through the cache, write with an explicit TTL, invalidate on change.

Notes

  • Better Auth stores rate limits in the database (rateLimit.storage), so every request to /api/auth/* needs a reachable Postgres. Moving this to secondaryStorage backed by Redis would remove that dependency.
  • Environment variables are validated at boot by src/config/env.validation.ts. The process refuses to start on a bad config.