node-ts / ddd Goto Github PK

Examples are a great way to help people learn a framework. A start of a DDD based example has been created in packages/ddd-example that models a security system. This was selected because it uses real-world concepts that are easy to grasp, and easy to communicate the code layout aspects of DDD.

This is a rather big "epic", so rather than doing everything in a single PR, this task would just be to implement the AlarmSystem agg root and some of its interactions.

Great package! I especially like the way how events are handled. However, one thing caught my eye.
Within an aggregate events are published. This makes perfect sense as per DDD your not allowed to update different aggregates in the same transaction. To achieve eventual consistencies, events published in one aggregate can be used by services to update other aggregates. However, in this library the aggregate which publishes events also handles its own events (through when() on the abstract aggregate root). I was wondering why this is? Why not simple call a method on the aggregate?

the file @node-ts/ddd/tsconfig.json is looking for a tsconfig file in the base node_modules folder, which doesn't exist. This 'file not found' error shows up in my VS Code IDE.

{
  "extends": "../../tsconfig.json",
  "compilerOptions": {
    "baseUrl": "."
  },
  "exclude": ["dist"]
}

🚨 You need to enable Continuous Integration on Greenkeeper branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please click the 'fix repo' button on account.greenkeeper.io.

Create a new base class (ie; ValueObject<PropertyType>) that can be inherited to create a value object concrete definition.

Value objects are a core concept of DDD and represent things that are identified by their value rather than their hash/id/reference etc. See: https://martinfowler.com/bliki/ValueObject.html

There're already some examples on the web on this practice in typescript (eg https://khalilstemmler.com/articles/typescript-value-object/) that can be used. This task can be used to create a similar base and exposed in ddd.

Side note: operator overloading provides a cleaner way to do this in other languages, but that doesn't appear to be coming to java/typescript: microsoft/TypeScript#6936

I have created a new project, and I tried to install ddd with their dependencies, but I have the following error:

npm i @node-ts/ddd @node-ts/logger-core @node-ts/bus-core @node-ts/bus-messages inversify --save
npm ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree
npm ERR!
npm ERR! While resolving: [email protected]
npm ERR! Found: @node-ts/[email protected]
npm ERR! node_modules/@node-ts/logger-core
npm ERR! @node-ts/logger-core@"" from the root project
npm ERR! peer @node-ts/logger-core@"^0.0.17" from @node-ts/[email protected]
npm ERR! node_modules/@node-ts/bus-core
npm ERR! @node-ts/bus-core@"" from the root project
npm ERR! peer @node-ts/bus-core@"^0.6.3" from @node-ts/[email protected]
npm ERR! node_modules/@node-ts/ddd
npm ERR! @node-ts/ddd@"" from the root project
npm ERR!
npm ERR! Could not resolve dependency:
npm ERR! peer @node-ts/logger-core@"^0.1.0" from @node-ts/[email protected]
npm ERR! node_modules/@node-ts/ddd
npm ERR! @node-ts/ddd@"" from the root project
npm ERR!
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force, or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
npm ERR!
npm ERR! See /.npm/eresolve-report.txt for a full report.
npm ERR! A complete log of this run can be found in:
npm ERR! /.npm/_logs/2021-06-30T09_06_28_182Z-debug.log

I have 2 versions of node.js in my local.

❯ nvm ls
       v10.21.0
->     v14.15.0
         system

But in both versions, yarn test failed in ddd/packages/ddd with same error below:

yarn run v1.22.4
$ jest "(src\/.+\.|/)spec\.ts$"
 FAIL  src/infrastructure/read-repository.spec.ts
  ● Test suite failed to run

    SyntaxError: /Users/poqw/github/ddd/packages/ddd/src/infrastructure/read-repository.spec.ts: Unexpected token, expected "{" (12:47)

      10 | }
      11 |
    > 12 | class UserReadRepository extends ReadRepository<UserModel> {
         |                                                ^
      13 |   constructor (connection: Connection) {
      14 |     super(
      15 |       connection,

      at Parser._raise (../../node_modules/jest/node_modules/@babel/parser/src/parser/error.js:60:45)

 FAIL  src/infrastructure/write-repository.spec.ts
  ● Test suite failed to run

    SyntaxError: /Users/poqw/github/ddd/packages/ddd/src/infrastructure/write-repository.spec.ts: Unexpected reserved word 'interface' (13:0)

      11 | import { Bus } from '@node-ts/bus-core'
      12 |
    > 13 | interface UserProperties extends AggregateRootProperties {
         | ^
      14 |   name: string
      15 |   email: string
      16 | }

      at Parser._raise (../../node_modules/jest/node_modules/@babel/parser/src/parser/error.js:60:45)

 FAIL  src/domain/aggregate-root.spec.ts
  ● Test suite failed to run

    SyntaxError: /Users/poqw/github/ddd/packages/ddd/src/domain/aggregate-root.spec.ts: Support for the experimental syntax 'classProperties' isn't currently enabled (7:9):

       5 |
       6 | class SomethingHappens extends Event {
    >  7 |   $name = 'node-ts/ddd/something-happens'
         |         ^
       8 |   $version = 0
       9 |
      10 |   example = 2

    Add @babel/plugin-proposal-class-properties (https://git.io/vb4SL) to the 'plugins' section of your Babel config to enable transformation.
    If you want to leave it as-is, add @babel/plugin-syntax-class-properties (https://git.io/vb4yQ) to the 'plugins' section to enable parsing.

      at Parser._raise (../../node_modules/jest/node_modules/@babel/parser/src/parser/error.js:60:45)

Test Suites: 3 failed, 3 total
Tests:       0 total
Snapshots:   0 total
Time:        6.884s
Ran all test suites matching /(src\/.+\.|\/)spec\.ts$/i.
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

I think it is related to the version of node(Or not, let me know it first).
What version should I use? and Is there any plan to support node v14 LTE?