@shirudo/ddd-kit 0.8.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +22 -0
- package/README.md +43 -0
- package/package.json +53 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 D. S. (Shirudo)
|
|
4
|
+
Copyright (c) 2025 H. T. (Juppa)
|
|
5
|
+
|
|
6
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
7
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
8
|
+
in the Software without restriction, including without limitation the rights
|
|
9
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
10
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
11
|
+
furnished to do so, subject to the following conditions:
|
|
12
|
+
|
|
13
|
+
The above copyright notice and this permission notice shall be included in all
|
|
14
|
+
copies or substantial portions of the Software.
|
|
15
|
+
|
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
17
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
18
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
19
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
20
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
21
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
22
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# @shirudo/ddd-kit
|
|
2
|
+
|
|
3
|
+
> Composable TypeScript toolkit for tactical DDD
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
### ⚠️ Beta Notice
|
|
8
|
+
|
|
9
|
+
This project is in its early stages and should be considered a **beta release**. The API is subject to change, and it is not recommended for use in production environments at this time.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## About
|
|
14
|
+
|
|
15
|
+
`@shirudo/ddd-kit` is a lightweight, composable toolkit designed to help developers implement tactical Domain-Driven Design patterns in TypeScript. It provides a set of simple, unopinionated building blocks that you can use to create robust and maintainable domain models.
|
|
16
|
+
|
|
17
|
+
## Getting Started
|
|
18
|
+
|
|
19
|
+
To get a feel for how the toolkit works, you can explore the "Rugby Match" example included in the `examples/rugby` directory.
|
|
20
|
+
|
|
21
|
+
### Running the Example
|
|
22
|
+
|
|
23
|
+
To run the example, execute the following command in your terminal:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npx tsx examples/rugby/main.ts
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
This will simulate a rugby match, demonstrating how aggregates, events, and state changes work together.
|
|
30
|
+
|
|
31
|
+
### Running Tests
|
|
32
|
+
|
|
33
|
+
To run the test suite for the project, use the following command:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
pnpm test
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
This will execute all tests and provide a report of the results.
|
|
40
|
+
|
|
41
|
+
## License
|
|
42
|
+
|
|
43
|
+
This project is licensed under the MIT License.
|
package/package.json
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@shirudo/ddd-kit",
|
|
3
|
+
"version": "0.8.8",
|
|
4
|
+
"description": "Composable TypeScript toolkit for tactical DDD",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "https://github.com/shi-rudo/ddd-kit-ts.git"
|
|
9
|
+
},
|
|
10
|
+
"main": "./dist/index.js",
|
|
11
|
+
"types": "./dist/index.d.ts",
|
|
12
|
+
"exports": {
|
|
13
|
+
".": {
|
|
14
|
+
"import": "./dist/index.js",
|
|
15
|
+
"types": "./dist/index.d.ts"
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"files": [
|
|
19
|
+
"dist"
|
|
20
|
+
],
|
|
21
|
+
"scripts": {
|
|
22
|
+
"build": "tsc",
|
|
23
|
+
"test": "vitest",
|
|
24
|
+
"clean": "rm -rf dist",
|
|
25
|
+
"lint": "biome lint .",
|
|
26
|
+
"format": "pnpm exec biome format --write . && pnpm exec biome lint --write . && pnpm exec biome check --write .",
|
|
27
|
+
"typecheck": "tsc --noEmit"
|
|
28
|
+
},
|
|
29
|
+
"keywords": [
|
|
30
|
+
"ddd",
|
|
31
|
+
"domain",
|
|
32
|
+
"typescript",
|
|
33
|
+
"toolkit"
|
|
34
|
+
],
|
|
35
|
+
"license": "MIT",
|
|
36
|
+
"publishConfig": {
|
|
37
|
+
"access": "public"
|
|
38
|
+
},
|
|
39
|
+
"devDependencies": {
|
|
40
|
+
"@biomejs/biome": "2.1.4",
|
|
41
|
+
"typescript": "^5.9.2",
|
|
42
|
+
"vitest": "^3.2.4"
|
|
43
|
+
},
|
|
44
|
+
"private": false,
|
|
45
|
+
"author": "Shirudo",
|
|
46
|
+
"contributors": [
|
|
47
|
+
"Shirudo"
|
|
48
|
+
],
|
|
49
|
+
"homepage": "https://github.com/shi-rudo/ddd-kit-ts",
|
|
50
|
+
"bugs": {
|
|
51
|
+
"url": "https://github.com/shi-rudo/ddd-kit-ts/issues"
|
|
52
|
+
}
|
|
53
|
+
}
|