koota-kit 0.2.0 → 0.2.1
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/CHANGELOG.md +8 -0
- package/README.md +11 -3
- package/docs/API.md +5 -3
- package/package.json +1 -1
- package/docs/changelog.md +0 -13
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.2.1](https://github.com/jbcom/koota-kit/compare/v0.2.0...v0.2.1) (2026-10-06)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* sync the lockfile with the docs sourcey range ([eab4ae1](https://github.com/jbcom/koota-kit/commit/eab4ae1df3194cc1157b2a59ea0b04c3bc5345eb))
|
|
9
|
+
* sync the lockfile with the docs sourcey range ([be276e5](https://github.com/jbcom/koota-kit/commit/be276e52f7d58621fd3730a5762b8c4eccbc5cbb))
|
|
10
|
+
|
|
3
11
|
## [0.2.0](https://github.com/jbcom/koota-kit/compare/v0.1.1...v0.2.0) (2026-08-24)
|
|
4
12
|
|
|
5
13
|
|
package/README.md
CHANGED
|
@@ -137,9 +137,12 @@ the system responsible for acting on the event should drain.
|
|
|
137
137
|
## Persistence boundary
|
|
138
138
|
|
|
139
139
|
`snapshotWorld` stores the clock and both RNG states. It intentionally does not
|
|
140
|
-
serialize entities or traits:
|
|
141
|
-
|
|
142
|
-
|
|
140
|
+
serialize immutable seeds, entities, or traits: persist `sim.seeds` beside the
|
|
141
|
+
header so a fresh handle can retain stable derived randomness, and keep entity
|
|
142
|
+
data in application-specific schemas and migrations. Stage a fresh handle when
|
|
143
|
+
loading so old scratch caches and event logs cannot leak into the restored run.
|
|
144
|
+
`restoreWorldHeader` validates a parsed save before changing that staged handle
|
|
145
|
+
and restores atomically.
|
|
143
146
|
|
|
144
147
|
Persist a version beside the header and your ECS state so the application can
|
|
145
148
|
migrate its own schema.
|
|
@@ -159,6 +162,11 @@ See the [API reference](./docs/API.md) for signatures and validation behavior,
|
|
|
159
162
|
and [architecture notes](./docs/ARCHITECTURE.md) for module boundaries and
|
|
160
163
|
invariants.
|
|
161
164
|
|
|
165
|
+
For task-oriented usage, read the Sourcey guides on
|
|
166
|
+
[deterministic randomness](https://jonbogaty.com/koota-kit/determinism/),
|
|
167
|
+
[save headers](https://jonbogaty.com/koota-kit/persistence/), and
|
|
168
|
+
[event ownership](https://jonbogaty.com/koota-kit/event-logs/).
|
|
169
|
+
|
|
162
170
|
## Errors and edge cases
|
|
163
171
|
|
|
164
172
|
- Seeds must be strings or finite numbers.
|
package/docs/API.md
CHANGED
|
@@ -43,9 +43,11 @@ function restoreWorldHeader(handle: WorldHandle, snapshot: WorldSnapshot): void;
|
|
|
43
43
|
```
|
|
44
44
|
|
|
45
45
|
Snapshots and restores both RNG streams plus the simulation clock. The plain
|
|
46
|
-
object can be round-tripped through JSON.
|
|
47
|
-
|
|
48
|
-
|
|
46
|
+
object can be round-tripped through JSON. It does not include `WorldHandle.seeds`:
|
|
47
|
+
persist the immutable seeds separately and use them when creating a fresh
|
|
48
|
+
handle for loading. Entity and trait data are also outside this package's
|
|
49
|
+
persistence boundary. Restore validates the complete replacement before
|
|
50
|
+
mutating the handle.
|
|
49
51
|
|
|
50
52
|
### Koota exports
|
|
51
53
|
|
package/package.json
CHANGED
package/docs/changelog.md
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Changelog
|
|
3
|
-
description: Release history maintained by Release Please from Conventional Commits.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
Release Please maintains the canonical
|
|
7
|
-
[CHANGELOG.md](https://github.com/jbcom/koota-kit/blob/main/CHANGELOG.md),
|
|
8
|
-
version metadata, tags, and GitHub Releases. Published releases use npm
|
|
9
|
-
provenance and the project supports the latest `0.x` line.
|
|
10
|
-
|
|
11
|
-
For planned changes, use a Conventional Commit type such as `fix:`, `feat:`,
|
|
12
|
-
`docs:`, `refactor:`, `test:`, or `chore:`. Breaking public API changes need a
|
|
13
|
-
`!` or `BREAKING CHANGE:` footer.
|