{"id":20295999,"url":"https://github.com/fdorantesm/ts-ddd","last_synced_at":"2026-01-23T10:17:31.149Z","repository":{"id":251456905,"uuid":"837477658","full_name":"fdorantesm/ts-ddd","owner":"fdorantesm","description":"A Typescript Domain Driven Design library","archived":false,"fork":false,"pushed_at":"2024-08-06T05:41:23.000Z","size":98,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-07T04:43:31.324Z","etag":null,"topics":["clean-architecture","clean-code","ddd","domain","domain-driven-design","entity","software-architecture","software-design","software-engineering","ts-ddd","typescript","uncle-bob","value-object"],"latest_commit_sha":null,"homepage":"https://fdorantesm.github.io/ts-ddd","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fdorantesm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-08-03T05:15:31.000Z","updated_at":"2024-08-07T03:43:36.000Z","dependencies_parsed_at":"2024-08-06T07:42:42.431Z","dependency_job_id":null,"html_url":"https://github.com/fdorantesm/ts-ddd","commit_stats":null,"previous_names":["fdorantesm/ts-ddd"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fdorantesm/ts-ddd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fdorantesm%2Fts-ddd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fdorantesm%2Fts-ddd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fdorantesm%2Fts-ddd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fdorantesm%2Fts-ddd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fdorantesm","download_url":"https://codeload.github.com/fdorantesm/ts-ddd/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fdorantesm%2Fts-ddd/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28687439,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T05:48:07.525Z","status":"ssl_error","status_checked_at":"2026-01-23T05:48:07.129Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clean-architecture","clean-code","ddd","domain","domain-driven-design","entity","software-architecture","software-design","software-engineering","ts-ddd","typescript","uncle-bob","value-object"],"created_at":"2024-11-14T15:36:55.182Z","updated_at":"2026-01-23T10:17:31.132Z","avatar_url":"https://github.com/fdorantesm.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eTypescript Domain-Driven Design\u003c/h1\u003e\n\u003cdiv align=\"center\"\u003e\n\u003cbr\u003e\n\u003cp\u003e\u003ci\u003eA set of utilities for Domain-Driven Design\u003c/i\u003e\u003c/p\u003e\n\u003c/div\u003e\n\n## Packages\n\n| Packages              | Link                                                              |\n| --------------------- | ----------------------------------------------------------------- |\n| @ts-ddd/common        | [Go to package](https://npmjs.com/package/@ts-ddd/common)         |\n| @ts-ddd/entity        | [Go to package](https://npmjs.com/package/@ts-ddd/entity)         |\n| @ts-ddd/state-machine | [Go to package](https://npmjs.com/package/@ts-ddd/state-machine)  |\n| @ts-ddd/value-object  | [Go to package](https://npmjs.com/package/@ts-ddd/value-object)   |\n\n### Common\n\n#### UUID generator\n\n```ts\nimport { uuidGenerator } from '@ts-ddd/common';\n\nconst uuid = uuidGenerator() // -\u003e b9ebc3ea-bfbd-4a86-8b7b-39995b47c631\n```\n\n#### Interfaces\n\n| Interface       | Properties                                 |\n| -------------- | ------------------------------------------ |\n| WithActive     | isActive                                   |\n| WithAudit      | createdBy, updatedBy and deletedBy as date |\n| WithDomain     | domain                                     |\n| WithLocale     | locale                                     |\n| WithNullable   | isNullable                                 |\n| WithOwner      | ownerId                                    |\n| WithScope      | scope                                      |\n| WithStatus     | status                                     |\n| WithTimestamps | createdAt and deletedAt                    |\n| WithUser       | userId                                     |\n| WithUuid       | uuid                                       |\n| WithVersion    | version                                    |\n\n#### Example\n\n```ts\ninterface Post extends WithActive, WithUuid {\n    title: string;\n    body: string;\n}\n\n/*\n  {\n    uuid: string;\n    title: string;\n    body: string;\n    isActive: boolean;\n  }\n*/\n```\n\n### Entity\n\nUse to create domain entities using an interface as contract.\n\n```ts\nexport interface IBook {\n  id: Identifier;\n  name: string;\n  year: number;\n  publisher: string;\n}\n\n```\n\n```ts\nimport { uuidGenerator } from '@ts-ddd/common';\nimport { Identifier, Entity } from '@ts-ddd/entity';\nimport { IBook } from '../interfaces/book.interface';\n\nexport class Book extends Entity\u003cIBook\u003e {\n  public static createToPrimitives(payload: Omit\u003cIBook, 'id'\u003e) {\n    return new Book({\n      id: uuidGenerator(),\n      ...payload\n    })\n  }\n  \n  public static createFromPrimitives(payload: IBook): Book {\n    return new Book(payload)\n  }\n}\n```\n\n#### Getting an object from the data source\n\n```ts\nclass BooksService {\n  constructor(private readonly booksRepository: BooksRepository) {}\n\n  public async findBookById(id: string): Promise\u003cBook | undefined\u003e {\n    const book = await this.booksRepository.findOne({ id });\n\n    if (book) {\n        return Book.createFromPrimitives(book)\n    }\n\n    return undefined;\n  } \n}\n```\n\n#### Creating a book to store it in the data source\n\n```ts\nclass CreateBookUseCase {\n  constructor(private readonly booksService: BooksService) {}\n\n  public async execute(payload: Omit\u003cIBook, 'id'\u003e): Promise\u003cBook | undefined\u003e {\n    const book = await this.booksRepository.create(\n        Book.createToPrimitives(payload)\n    );\n\n    return book;\n  } \n}\n```\n\n### State Machine\n\n```ts\nimport { StateMachine } from '@ts-ddd/state-machine';\n\nenum LightTransitions {\n  RED = \"red\",\n  GREEN = \"green\",\n  PULSING_GREEN = \"pulsing_green\",\n  AMBER = \"amber\",\n}\n\nconst transitions = {\n  [LightTransitions.RED]: [LightTransitions.GREEN],\n  [LightTransitions.GREEN]: [LightTransitions.PULSING_GREEN],\n  [LightTransitions.PULSING_GREEN]: [LightTransitions.AMBER],\n  [LightTransitions.AMBER]: [LightTransitions.RED],\n}\n\nconst light = StateMachine.instance({\n  transitions,\n  currentState: LightTransitions.RED,\n});\n\ntry {\n  light.setState(LightTransitions.GREEN);\n} catch (error) {\n  // InvalidStateTransitionException\n}\n```\n\n### Value Object\n\n```ts\nimport { StringValue } from '@ts-ddd/value-object'\nimport { validate, v4 as uuid } from 'uuid';\n\nexport class Uuid extends StringValue {\n  constructor(value: string) {\n    super(value);\n    this.ensureIsValidUuid(value);\n  }\n\n  static generate(): Uuid {\n    return new Uuid(uuid());\n  }\n\n  private ensureIsValidUuid(value: string): void {\n    if (!validate(value)) {\n      throw new Error(`${value} is not a valid UUID`)\n    }\n  }\n}\n```\n\n```ts\nimport { StringValue } from '@ts-ddd/value-object'\n\nexport class Title extends StringValue {}\n```\n\n```ts\nimport { PositiveNumberValue } from '@ts-ddd/value-object'\n\nexport class Year extends PositiveNumberValue {}\n```\n\n```ts\nclass BooksRepository {\n  public async getBook(id: string): Promise\u003cBook | undefined\u003e {\n    const book = await this.booksRepository.findOne({ id });\n\n    if (!book) {\n      return undefined;\n    }\n\n    return Book.createFromPrimitives({\n      id: new Uuid(book.id),\n      title: new Title(book.title),\n      year: new Year(book.year)\n    })\n  }\n}\n```\n\n\u003cbr\u003e\n\u003cbr\u003e\n\n---\n\n\u003cbr\u003e\n\u003cbr\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://github.com/fdorantesm\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/github-%2324292e.svg?\u0026style=for-the-badge\u0026logo=github\u0026logoColor=white\" alt=\"github\" style=\"margin-bottom: 5px;\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://twitter.com/fdorantesm\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/twitter-%2300acee.svg?\u0026style=for-the-badge\u0026logo=twitter\u0026logoColor=white\" alt=\"twitter\" style=\"margin-bottom: 5px;\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://linkedin.com/in/fdorantesm\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/linkedin-%231E77B5.svg?\u0026style=for-the-badge\u0026logo=linkedin\u0026logoColor=white\" alt=\"linkedin\" style=\"margin-bottom: 5px;\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://www.youtube.com/user/FernandoDorantes\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/youtube-%23EE4831.svg?\u0026style=for-the-badge\u0026logo=youtube\u0026logoColor=white\" alt=\"youtube\" style=\"margin-bottom: 5px;\" /\u003e\n    \u003c/a\u003e\n\u003c/div\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffdorantesm%2Fts-ddd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffdorantesm%2Fts-ddd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffdorantesm%2Fts-ddd/lists"}