Skip to content

Commit

Permalink
v2.0.0 - version set to 2.0.0-alpha.01
Browse files Browse the repository at this point in the history
  • Loading branch information
idugalic committed Mar 10, 2024
1 parent 5d69d36 commit f1b21b3
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

[![CI with Node/NPM - Test and Build](https://github.com/fraktalio/fmodel-ts/actions/workflows/node-test-build.yml/badge.svg)](https://github.com/fraktalio/fmodel-ts/actions/workflows/node-test-build.yml)

> v2.0.0 of the library is introducing breaking changes. [Check the PR](https://github.com/fraktalio/fmodel-ts/pull/692)!
> Besides keeping the focus on separating data from behavior, we want to split the responsibilities between the domain and application/adapter layers better.
> For example, `metadata types` exist only on the application layer, not leaking into the domain, as these don't benefit core logic. Example: `traceId`, `correlationId`, ...
>
> The library will use `alpha` channel until it reach production ready quality. It will happen soon! We need more tests, better documentation and clear upgrade roadmap (`1.0.0` -> `2.0.0`).
> To keep it simple, `v2.*.*` will use the main branch going forward. [v1.*.*](https://github.com/fraktalio/fmodel-ts/tree/v1) will continue to be supported (bugs only, no new features)
When you’re developing an information system to automate the activities of the business, you are modeling the business.
The abstractions that you design, the behaviors that you implement, and the UI interactions that you build all reflect
the business — together, they constitute the model of the domain.
Expand Down Expand Up @@ -184,7 +191,7 @@ In TypeScript, we can use ADTs to model our application's domain entities and re
TypeScript has two main types of ADTs: union types (`"|"` operator), intersection types (`"&"` operator), tuples and records

- `union types` is used to define a type that can take on one of several possible variants - modeling a `sum/OR` type.
- `intersection types`, `tuples` and `records` are used to combines several types into one - modeling a `product/AND` type.
- `intersection types`, `tuples` and `records` are used to combine several types into one - modeling a `product/AND` type.

ADTs will help with

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@fraktalio/fmodel-ts",
"version": "2.0.0",
"version": "2.0.0-alpha.01",
"description": "Functional domain modeling with TypeScript. Optimized for event sourcing and CQRS",
"main": "build/main/index.js",
"typings": "build/main/index.d.ts",
Expand Down

0 comments on commit f1b21b3

Please sign in to comment.