Files
breakpilot-compliance/breakpilot-compliance-sdk/README.md
2026-04-19 16:07:23 +02:00

1.2 KiB

breakpilot-compliance-sdk

TypeScript SDK monorepo providing React, Angular, Vue, vanilla JS, and core bindings for the BreakPilot Compliance backend. Published as npm packages.

Stack: TypeScript, workspaces (packages/core, packages/react, packages/angular, packages/vanilla, packages/types).

Layout

packages/
├── core/       # Framework-agnostic client + state
├── types/      # Shared type definitions
├── react/      # React Provider + hooks
├── angular/    # Angular service
└── vanilla/    # Vanilla-JS embed script

Architecture

Follow ../AGENTS.typescript.md. No framework-specific code in core/.

Build + test

npm install
npm run build     # per-workspace build
npm test          # Vitest (currently 0 tests)

Known debt

  • Several files across packages/vanilla/src/, packages/react/src/, and packages/core/src/ exceed the LOC budget and are candidates for splitting as refactoring continues.
  • Zero test coverage. Adding Vitest coverage is a priority backlog item.

Don't touch

Public API surface of core without bumping package major version and updating consumers.