@forgrit/debugger

NestJS module for design-quality debugging — visual regression debugger surface for the ForGrit Foundry OS design-composition pipeline. Controllers, services, DTOs, Prisma-backed run-history store.

Status: early-access (v0.x). Pre-1.0 releases may include breaking changes in minor bumps until v1.0.0.

NestJS-coupled by design — this is a @Module()-shaped package, not a framework-agnostic library. Node 20+.

What's in the box

• Controllers: internal debugger HTTP surface for runtime introspection
• Services: run sharding, indexing, design-quality scoring helpers
• DTOs: class-validator + class-transformer shapes for request/response payloads
• Prisma integration: run-history store via IPrismaService from @forgrit/shared-contracts-platform/db
• Cross-domain integration: design-DNA + variant-constraint types from @forgrit/shared-contracts-design-composition

What it's NOT

• Not framework-agnostic. Requires NestJS at consumer side.
• Not standalone. Requires @forgrit/shared-contracts-platform (auth + db + logger) and @forgrit/shared-contracts-design-composition (design types).
• Not a screenshot/preview-render service. Reads diffs that another service produces.

Install

npm install @forgrit/debugger
# or
pnpm add @forgrit/debugger

Required peer deps (typical NestJS app already has these):

npm install @nestjs/common @nestjs/core @prisma/client reflect-metadata

Optional peer dep (for Express request types):

npm install express

Usage

import { Module } from '@nestjs/common';
import { DebuggerModule } from '@forgrit/debugger';
import { MyPlatformProvidersModule } from './platform';

@Module({
  imports: [
    MyPlatformProvidersModule, // provides PRISMA_SERVICE + LOGGER_SERVICE + auth
    DebuggerModule,
  ],
})
export class AppModule {}

The DebuggerModule consumes PRISMA_SERVICE + LOGGER_SERVICE + auth guards through DI — wire those via @forgrit/shared-contracts-platform's Symbol tokens.

License

MIT — see LICENSE.

Sibling packages

• @forgrit/shared-contracts-platform — auth/logger/db contracts (required)
• @forgrit/shared-contracts-design-composition — design-DNA + variant types (required)
• @forgrit/design-engine — the design engine being debugged
• @forgrit/design-intelligence — ML/RAG layer on top of design-engine
• @forgrit/contracts — cross-domain Zod schemas + types