koota-kit 0.1.1 → 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 +61 -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,66 @@
|
|
|
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
|
+
|
|
11
|
+
## [0.2.0](https://github.com/jbcom/koota-kit/compare/v0.1.1...v0.2.0) (2026-08-24)
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Features
|
|
15
|
+
|
|
16
|
+
* codify main branch protection as a repository ruleset script ([30cda81](https://github.com/jbcom/koota-kit/commit/30cda819de657fade54157d492b77acab4192975))
|
|
17
|
+
* **docs:** author Starlight content from README, API, and architecture docs ([9809dc2](https://github.com/jbcom/koota-kit/commit/9809dc20904b26b0735a5e79caa9b256377c4810))
|
|
18
|
+
* **docs:** derive Starlight theme colors from the project hero image ([4953770](https://github.com/jbcom/koota-kit/commit/4953770e6bd6d199bdc7e74d427304d9e85a4875))
|
|
19
|
+
* **ecs-koota:** extract koota ECS conventions to @arcade-cabinet/ecs-koota ([#1](https://github.com/jbcom/koota-kit/issues/1)) ([3194046](https://github.com/jbcom/koota-kit/commit/319404639256c90bedb6cf69871dfe25fac0b5e8))
|
|
20
|
+
* **ecs-koota:** extract scratch-backed event logs with a peek seam ([#4](https://github.com/jbcom/koota-kit/issues/4)) ([746a8b9](https://github.com/jbcom/koota-kit/commit/746a8b9f0fe189fc60fddc23c35059d365fbe19c))
|
|
21
|
+
* enforce Conventional Commits via commitlint, git hooks, and a required PR-title check ([9afb14a](https://github.com/jbcom/koota-kit/commit/9afb14a4b6d0836a80ed38fa4f898ef266aca3df))
|
|
22
|
+
* harden koota-kit for public release ([2fa3568](https://github.com/jbcom/koota-kit/commit/2fa3568e708b816218706596a3593318ba31a28c))
|
|
23
|
+
* harden koota-kit for public release ([13363c1](https://github.com/jbcom/koota-kit/commit/13363c1d7ff1e8eabd7ba830f91ea75ab2134637))
|
|
24
|
+
* migrate docs to Sourcey and harden delivery ([9e876f1](https://github.com/jbcom/koota-kit/commit/9e876f1f7082bf142baf9b38bc4133dd565e145b))
|
|
25
|
+
* scaffold Astro + Starlight docs site as a pnpm workspace member ([bb12bc0](https://github.com/jbcom/koota-kit/commit/bb12bc08bf3493a4b4832d520b249b984a340f1d))
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
### Bug Fixes
|
|
29
|
+
|
|
30
|
+
* address CodeRabbit review findings ([98e8431](https://github.com/jbcom/koota-kit/commit/98e84312c9c90ff11f1b61988e134d23c253fcea))
|
|
31
|
+
* **ci:** accept release-please changelog layout ([8b08654](https://github.com/jbcom/koota-kit/commit/8b086549c40a1e41ba84b41642a1590ba19377f9))
|
|
32
|
+
* **ci:** accept release-please changelog layout ([4e7a329](https://github.com/jbcom/koota-kit/commit/4e7a3291edf07d717096ed69d712c9d9b3e331ea))
|
|
33
|
+
* **ci:** allow release validation dispatch ([e51eff0](https://github.com/jbcom/koota-kit/commit/e51eff03a57e62d26b69c487c6de2b791c727a25))
|
|
34
|
+
* **ci:** allow release validation dispatch ([3601162](https://github.com/jbcom/koota-kit/commit/36011625cff3685fa268bdbb8c856643f6ccdf8f))
|
|
35
|
+
* **ci:** dispatch release policy gates ([eac0ad7](https://github.com/jbcom/koota-kit/commit/eac0ad7fb459fd56a8a1bfc8a4f6a587edc4ec70))
|
|
36
|
+
* **ci:** dispatch release policy gates ([dd4f9f3](https://github.com/jbcom/koota-kit/commit/dd4f9f3603d9449a838d19c7c01e1e3a62384781))
|
|
37
|
+
* **ci:** handle dispatched release gates ([c6d2937](https://github.com/jbcom/koota-kit/commit/c6d2937c5c12bc234e85010ad2d3d46e5475f583))
|
|
38
|
+
* **ci:** keep the title gate unique ([528dd9e](https://github.com/jbcom/koota-kit/commit/528dd9e4692235bb0be58782d0b87ea865b38933))
|
|
39
|
+
* **ci:** run pre-commit without a mutable action dependency ([e5b61b7](https://github.com/jbcom/koota-kit/commit/e5b61b7b6be206bb91a5cf6184f6a54cb861fe9b))
|
|
40
|
+
* correctly locate the JSON array in npm pack output, not the first '[' ([b791621](https://github.com/jbcom/koota-kit/commit/b79162102ea2ec23c8df353bbcc5337101821ee4))
|
|
41
|
+
* disable unattested-change review gate ([6306ca4](https://github.com/jbcom/koota-kit/commit/6306ca4660ea5f14dc3137995c67632df7ed1ecc))
|
|
42
|
+
* document atomic Context7 restore guidance ([97b01c6](https://github.com/jbcom/koota-kit/commit/97b01c62da8c51d5d895e48d2eba1d7e91448747))
|
|
43
|
+
* **ecs-koota:** align facade with current Koota ([#2](https://github.com/jbcom/koota-kit/issues/2)) ([57afef0](https://github.com/jbcom/koota-kit/commit/57afef08046ccc3bb2e46ddbbc0f5092fc2e217a))
|
|
44
|
+
* enable release changelog lint override ([3ba3434](https://github.com/jbcom/koota-kit/commit/3ba3434eed69ffbcd76e8f61948b747e6af162da))
|
|
45
|
+
* enable release changelog lint override ([1c2ed71](https://github.com/jbcom/koota-kit/commit/1c2ed71c742f86677f1fddf7d08971f9c0140f58))
|
|
46
|
+
* harden generated pull request automation ([9764c5f](https://github.com/jbcom/koota-kit/commit/9764c5ffc501037685e63ad7a133322c526c74d3))
|
|
47
|
+
* keep npm-published README links resolvable within the package file set ([c3d38ea](https://github.com/jbcom/koota-kit/commit/c3d38ea1f4af397125acea5b06b4fa9abc3b68ee))
|
|
48
|
+
* make release gates portable on Windows ([53f23aa](https://github.com/jbcom/koota-kit/commit/53f23aa6ad25ac0de782fc1150e895f60595cc14))
|
|
49
|
+
* make verify-package.mjs resilient to npm pack lifecycle-script output ([0dd677b](https://github.com/jbcom/koota-kit/commit/0dd677bf0fd87e27bd7c9173e8c800b8c54d7bf0))
|
|
50
|
+
* match generated changelog lint override ([fceaa2a](https://github.com/jbcom/koota-kit/commit/fceaa2a381ba837b295c5217d49c76fa4f04196e))
|
|
51
|
+
* match generated changelog lint override ([529971a](https://github.com/jbcom/koota-kit/commit/529971ae9780c5e64eba1bac993e4ff42c86e8e9))
|
|
52
|
+
* normalize cross-platform line endings ([425f956](https://github.com/jbcom/koota-kit/commit/425f9569d03674e6ef708bbd74bc5815d322dfa7))
|
|
53
|
+
* publish koota-kit as an unscoped package ([e26dbbc](https://github.com/jbcom/koota-kit/commit/e26dbbcc394e0da5405a2b48b8e87781206df6d0))
|
|
54
|
+
* publish koota-kit as an unscoped package ([1a922ce](https://github.com/jbcom/koota-kit/commit/1a922ce3190bbf99a02990492bd799da69406bc5))
|
|
55
|
+
* require the observed PR-title check ([7f16ffa](https://github.com/jbcom/koota-kit/commit/7f16ffa9cfead5e13578aaaf6ccd1a4b6bcadc7e))
|
|
56
|
+
* restrict SonarCloud pull request scans ([efd4178](https://github.com/jbcom/koota-kit/commit/efd4178cd2d2c4f7a27d6c5dc88a1f007fade550))
|
|
57
|
+
* skip SonarCloud scans for Dependabot ([dd1e048](https://github.com/jbcom/koota-kit/commit/dd1e048322ea601c719aec077a897fb8ceea9dea))
|
|
58
|
+
* trigger trusted release automation ([01acd0f](https://github.com/jbcom/koota-kit/commit/01acd0f5d2c255ee98a36b4a643a3dc1cb0805d4))
|
|
59
|
+
* wait for generated pull request requirements ([9719102](https://github.com/jbcom/koota-kit/commit/97191025d8fdd243b857cabf37fb8384cb776c97))
|
|
60
|
+
* wait for generated pull request requirements ([440a1fe](https://github.com/jbcom/koota-kit/commit/440a1fe0a7f3aa2f320ad1cc0372cbca795e679e))
|
|
61
|
+
|
|
62
|
+
## Changelog
|
|
63
|
+
|
|
3
64
|
All notable changes to this project are documented here. This project follows
|
|
4
65
|
[Semantic Versioning](https://semver.org/) and uses
|
|
5
66
|
[Conventional Commits](https://www.conventionalcommits.org/) to drive releases.
|
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.
|