๐Ÿš€ Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more โ†’
Socket
DemoInstallSign in
Socket

dc-ts

Package Overview
Dependencies
Maintainers
1
Versions
27
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

dc-ts

Utilities for domain-centric typescript

0.1.9-unstable
latest
npm
Version published
Weekly downloads
22
633.33%
Maintainers
1
Weekly downloads
ย 
Created
Source

โœ… dc-ts

Domain-Centric TypeScript โ€” a functional, event-driven approach to core domain logic in TypeScript.

What is dc-ts?

dc-ts is a lightweight library and architecture style for implementing core domain logic using:

  • ๐Ÿง  Typed workflows via CoreWf
  • ๐Ÿงช Type-safe validation using TypeBox
  • โ™ป๏ธ Pure business logic, built around constrain โ†’ decide โ†’ evolve
  • ๐Ÿ” Designed for event sourcing and collaborative modeling

Architecture

๐Ÿ“ฆ Core/
 โ”œโ”€ domain.ts          # your types and workflows
 โ””โ”€ _implementation/
     โ”œโ”€ _schema.ts       # generated TypeBox schemas
     โ”œโ”€ constructors.ts  # smart type-safe constructors
     โ”œโ”€ constrain.ts     # constraint logic
     โ”œโ”€ decide.ts        # decision logic (commands โ†’ events)
     โ”œโ”€ evolve.ts        # state transitions (events โ†’ state)
     โ””โ”€ tests/           # BDD-style tests

๐Ÿงฑ CoreWf

At the heart of dc-ts is the CoreWf type:

export type CoreWf<C, iA, E, oA, F> = {
  cmd: C                 // domain command
  inputAg: iA            // aggregate before
  outputAg: oA           // aggregate after
  aggregate: iA | oA
  evt: E                 // emitted event
  fails: F               // failure messages
  validateAggregate: SafeParse<iA | oA>
}

๐Ÿงช Example: ToDo Domain

export type CreateToDoWf = CoreWf<
  CMD<'create-todo', { title: string }>,
  AGG<'initial', { title?: string }>,
  EVT<'todo-created', { id: string; title: string }>,
  AGG<'created', { id: string; title: string; status: 'pending' }>,
  'title_required'
>

โœ… Constrain

Used to enforce business rules before deciding.

export const constrainToDo: Constrain<CreateToDoWf['cmd'], CreateToDoWf['inputAg'], 'title_required'> =
  (cmd) => (state) => {
    if (!cmd.data.title?.trim()) {
      return fail('title_required')
    }
    return succeed(state)
  }

๐Ÿง  Decide

Takes a command and a validated state and returns event(s).

export const decideToDo = (cmd: CreateToDoWf['cmd']) => (state: CreateToDoWf['inputAg']) => {
  const evtRes = newToDoEVT<CreateToDoWf['evt']>()('todo-created')(dtFromMsg(cmd))({
    id: crypto.randomUUID(),
    title: cmd.data.title
  })
  return isFailure(evtRes) ? evtRes : succeed([evtRes.data])
}

๐Ÿ” Evolve

Transitions the aggregate to its next state.

export const evolveToDo = (evt: CreateToDoWf['evt']) => (state: CreateToDoWf['inputAg']): CreateToDoWf['outputAg'] => {
  return {
    _tag: 'created',
    data: {
      id: evt.data.id,
      title: evt.data.title,
      status: 'pending'
    }
  }
}

๐Ÿงช Validation

All inputs and state transitions are validated using TypeBox:

export const newToDoCMD = <C extends CreateToDoWf['cmd']>() =>
  newCmd<C['type'], C['data']>(safeParseTBox(ToDoCmdSchema))

๐Ÿงช BDD Testing

Tests can be generated and follow a Given/When/Then format:

Deno.test("Given a valid command, When constraints run, Then succeed", () => {
  const cmd = { ... }
  const state = { ... }
  const result = constrainToDo(cmd)(state)
  assertEquals(result.outcome, "success")
})

๐ŸŽฏ Design Principles

  • ๐Ÿ”„ One source of truth: models power code, tests, and docs
  • ๐Ÿงฉ Composable and side-effect free: logic stays pure and testable
  • ๐Ÿ›  Schema-driven development: everything is validated at runtime
  • ๐Ÿง  Business-first modeling: workflows match EventStorming patterns

๐Ÿงฉ Works Best With

  • TypeBox
  • dcts CLI: scaffolding, schema generation, test generation, business docs

๐Ÿ“˜ Need business documentation?

Use the dcts CLI to generate:

  • โœ… Business summaries
  • ๐Ÿ” Decision tables
  • ๐Ÿงช BDD-style test templates
  • ๐Ÿ“ฌ AsyncAPI specs

๐Ÿ“ License

MIT โ€” Giovanni & Contributors

Keywords

DDD

FAQs

Package last updated on 07 Apr 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts