@miadi/episodic-memory-schema 0.11.0 → 0.11.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.
Files changed (2) hide show
  1. package/README.md +29 -12
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,6 +2,16 @@
2
2
 
3
3
  Types + JSON Schema for **episodic memory** — the durable session-to-session memory layer in the Miadi orchestration kit.
4
4
 
5
+ In the Miadi stack, this is the shared record format. An episode is the unit everything is
6
+ filed under, and this package defines its shapes: the authored `EpisodicMemory` a session
7
+ leaves behind, and the read-only observations, manifests and catalogs other packages build
8
+ from existing episode folders. It has no dependencies and touches no filesystem: callers read
9
+ the files and hand it what they read.
10
+
11
+ Most of the stack depends on it: `@miadi/inquiry-weave`, `passages`, `@miadi/capture`,
12
+ `@miadi/episode-capture`, `@miadi/transcription`, `@miadi/plan-insight` and
13
+ `@miadi/musical-composition-to-episode`.
14
+
5
15
  When a Storyweaver session closes, the Export Steward extracts an episodic-memory object and feeds it back to Miadi world memory. The next commission inherits what this one built.
6
16
 
7
17
  ---
@@ -35,7 +45,7 @@ EpisodicMemory
35
45
 
36
46
  ### Narrative layer is NCP-aligned
37
47
 
38
- The `narrative` layer mirrors the [Narrative Context Protocol](https://github.com/) two-layer model:
48
+ The `narrative` layer mirrors the Narrative Context Protocol (NCP) two-layer model:
39
49
 
40
50
  - **Subtext** — authorial intent: perspectives, players, storypoints, storybeats, dynamics
41
51
  - **Storytelling** — surface presentation: overviews, moments
@@ -52,7 +62,7 @@ An NCP-consuming agent can read the narrative layer directly. Episodic-memory ad
52
62
  ## Install
53
63
 
54
64
  ```bash
55
- pnpm add @miadi/episodic-memory-schema
65
+ npm i @miadi/episodic-memory-schema
56
66
  ```
57
67
 
58
68
  ## Usage
@@ -158,18 +168,25 @@ modifies source material.
158
168
 
159
169
  ---
160
170
 
161
- ## Reviews held by an episode
162
-
163
- `parseReviewRef`, `readEpisodeReviews`, `reviewNodeId` and `EpisodeReviewEntry` type a Miadi
164
- review inside `episode.yaml` (`reviews:`), in the shape Episode 345 set on the wheel
165
- (`review:<uuid>`). Pure: no fs, no fetch. jgwill/Miadi#682.
171
+ ## Also in this package
172
+
173
+ - **Chronicle and story-library manifests.** `observeChronicleManifest`,
174
+ `EpisodeManifestEntry`, `chronicleEpisodeNodeId`, `linkEpisodeCaptures`;
175
+ `observeStoryLibrary`, `StoryManifestEntry`, `indexStoriesByEpisode`, `linkStoryForms`. They
176
+ shape a snapshot of the chronicle, or of a library of stories made from episodes, that the
177
+ caller hands in.
178
+ - **Episode captures.** `EpisodeCaptureRecord` and its parts: the descriptor of a recording
179
+ filed into an episode. `CaptureProvenance` is the provenance a capture carries.
180
+ - **Attention items.** The `attention.json` store an episode keeps for questions waiting on a
181
+ person (`ATTENTION_FILE`, schema `chronicle.attention.v1`).
182
+ - **Reviews held by an episode.** `parseReviewRef`, `readEpisodeReviews`, `reviewNodeId` and
183
+ `EpisodeReviewEntry` type a Miadi review inside `episode.yaml` (`reviews:`), with its
184
+ `review:<uuid>` node id. Pure: no fs, no fetch.
166
185
 
167
186
  ## Versioning
168
187
 
169
- - v0.2.0 (current) — compatibility-first observation adapters for composition manifests, parsed episode YAML, and descriptor-light directory snapshots
170
- - v0.1.1 — strict authored episodic-memory types and JSON Schema
171
- - The package release is `0.2.0`; the authored memory schema remains `episodic-memory.v1.0`
172
- - Schema version is encoded in the `schemaVersion` field, independently of the package version
188
+ The package version and the authored memory schema version move independently. The schema is
189
+ `episodic-memory.v1.0`, carried in the `schemaVersion` field.
173
190
 
174
191
  ---
175
192
 
@@ -182,7 +199,7 @@ review inside `episode.yaml` (`reviews:`), in the shape Episode 345 set on the w
182
199
  | W3C PROV-DM | Source / agent / activity attribution |
183
200
  | OAIS reference model + FAIR (Wilkinson 2016) | Archival packaging frame |
184
201
  | HAWK (Cheng et al. 2025, arXiv:2507.04067) | 10-predicate evaluation rubric; versioned chapter-state audit trail |
185
- | Storyweaver foundations (`foundations/narrative-studies-and-digital-storytelling/`) | Domain integration |
202
+ | Storyweaver foundations (narrative studies and digital storytelling) | Domain integration |
186
203
 
187
204
  ## License
188
205
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@miadi/episodic-memory-schema",
3
- "version": "0.11.0",
3
+ "version": "0.11.1",
4
4
  "description": "TypeScript types and JSON Schema for episodic memory — the durable session-to-session memory layer in the Miadi orchestration kit. Narrative layer is NCP-aligned; provenance layer is W3C PROV-DM and OAIS-informed.",
5
5
  "keywords": [
6
6
  "miadi",