PrimebrickPrimebrick
  • Primebrick.dev
  • GitHub
  • Documentation
  • Services
  • Libraries
  • API Catalog
Resources
  • Landing Page
  • API Catalog
  • GitHub
PrimebrickPrimebrick

© 2026 Primebrick. MIT License.

github
DAL Library
SDK Library
    Architecture: Ports & AdaptersBuild, Tooling & CI/CDCI/CD & NPM PublishingConfiguration ManagementCore ModulesDatabase MigrationsEnvironment ValidationGetting StartedGlossaryHTTP Server & Health ChecksLifecycle & Graceful ShutdownModule Test PatternsNATS Messaging ClientOverviewService Registration & HeartbeatTest Infrastructure & ConfigurationTestingTypeScript Build ConfigurationREADME
powered by Zudoku
SDK Library

README

@primebrick/sdk

Shared microservice infrastructure for Primebrick v3 — config loading, migration runner, service registration, graceful shutdown, NATS client, health checks, env validation. DB-agnostic via port interfaces.

What the SDK provides

  • Port interfaces — ConfigRepositoryPort, DatabasePort, ServiceRegistryPort, HealthCheckPort. Abstract contracts the consumer implements using their DAL.
  • ConfigLoader — load config from a DB config table at startup, cache in memory, get(key) on hot path, invalidate() for refresh.
  • IConfigEntity — self-contained interface for dictionary-style config rows.
  • Migration runner — SHA256-based patch tracking, idempotent re-runs.
  • ServiceRegistrar — register microservice in service_registry, maintain heartbeat.
  • IServiceRegistry — self-contained interface for service_registry rows.
  • GracefulShutdown — re-entrancy guard, Promise.allSettled for parallel resource cleanup, signal handlers.
  • NatsClient — singleton NATS connection management.
  • HttpServer — minimal HTTP server with health endpoint.
  • HealthCheck — DB health check utility.
  • EnvValidator — centralized env var validation.

License

MIT — Copyright (c) 2026 Michael Sogos

Last modified on July 13, 2026
TypeScript Build Configuration
On this page
  • What the SDK provides
  • License