Guides
  1. BEEM Javascript SDK
  2. Guides

Project Structure

Overview of the SDK's directory layout and domain patterns.

src/
  logger.ts               # Level-gated logger
  hub/                    # Warehousing (Redshift)
  catalog/                # Datalake storage (S3)
  flow/                   # Outbound integrations
    email/                # Email (SES)
    documents/            # Document rendering (docx)
  connectors/             # Inbound integrations (placeholder)
  metrics/                # Observability (CloudWatch)
  config/                 # Parameters & secrets (SSM)
  index.ts                # Barrel export
dist/                     # Compiled JS + .d.ts (generated, git-ignored)

Each domain follows the pattern:

  • index.ts — Public API, provider interface, setProvider() / getProvider()
  • aws-*.provider.ts — Default AWS implementation