@kairos-es/codec 0.0.0 → 1.0.0-alpha.0
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/README.md +9 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -2,6 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
Schema-first codec with an encryption seam for kairos-es (ADR-0004).
|
|
4
4
|
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
`@kairos-es/core` and `effect` are peer dependencies, so the application owns the
|
|
8
|
+
single shared Effect instance (per [ADR-0003](../../docs/adr)):
|
|
9
|
+
|
|
10
|
+
```sh
|
|
11
|
+
pnpm add @kairos-es/codec@alpha @kairos-es/core@alpha effect
|
|
12
|
+
```
|
|
13
|
+
|
|
5
14
|
The typed-payload to opaque-bytes seam: `event(type, fields, tagsFor)` defines a
|
|
6
15
|
tagged `Schema` together with the mapper that derives an event's tags from its own
|
|
7
16
|
payload (ADR-0006); `projection(init).on(def, fold)…build()` builds the slices a
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kairos-es/codec",
|
|
3
|
-
"version": "0.0.0",
|
|
3
|
+
"version": "1.0.0-alpha.0",
|
|
4
4
|
"description": "Schema-first codec with encryption seam for kairos-es",
|
|
5
5
|
"license": "BSD-3-Clause",
|
|
6
6
|
"repository": {
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
"homepage": "https://github.com/neverbland/kairos-es",
|
|
13
13
|
"peerDependencies": {
|
|
14
14
|
"effect": "^3.22.0",
|
|
15
|
-
"@kairos-es/core": "^0.0.0"
|
|
15
|
+
"@kairos-es/core": "^1.0.0-alpha.0"
|
|
16
16
|
},
|
|
17
17
|
"main": "./dist/cjs/index.js",
|
|
18
18
|
"module": "./dist/esm/index.js",
|