@x12i/memorix-format 2.3.3 → 3.0.1

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.0.1
+
+- Patch release: README/port-map alignment, live-view wiring where applicable.
+
 # Changelog
 
 ## 2.3.3

package/README.md

@@ -1,27 +1,28 @@
-# @x12i/memorix-format
+# `@x12i/memorix-format`
 
-Memorix record format package.
+Canonical **memorix-record/2** validation, migration, and CLI for Memorix.
 
-| Era | API | Status |
-|---|---|---|
-| **memorix-record/2** | `validateMemorixRecordV2`, `migratePresentToV2`, CLI `validate-v2` / `migrate-to-v2` | **Gate G2 SoT** for new platform work |
-| Present | `validateMemorixRecord`, CLI `validate` / `migrate` | Migration source; writer default until `MEMORIX_RECORD_FORMAT=v2` |
+Object / content **types** belong in agent metadata — this package is the **envelope** SoT (shape of every stored subject content document), not product vocabulary.
 
-Present envelope helpers still come from [`@x12i/memorix-base-format`](https://www.npmjs.com/package/@x12i/memorix-base-format) (temporary; folding into this package per Phase 0 deletion ledger).
+## Install
 
-**Object types belong in agent metadata / Catalox, not here.**
+```bash
+npm install @x12i/memorix-format@3.0.0
+```
 
-Docs:
+| Audience | Use this package? |
+|----------|-------------------|
+| Remote app | Optional — validate offline / in CI |
+| Platform / writers / pipelines | **Yes** |
 
-- [docs/memorix-record-v2.md](./docs/memorix-record-v2.md) — V2 contract
-- [docs/memorix-format.md](./docs/memorix-format.md) — present + pointers
-- Golden V2 examples: [examples/v2/](./examples/v2/)
+## API status
 
-## Install
+| API | Status |
+|-----|--------|
+| `validateMemorixRecordV2`, CLI `validate-v2` / `migrate-to-v2` | **Current** SoT for platform work |
+| Present-envelope helpers | Migration / compat only |
 
-```bash
-npm install @x12i/memorix-format
-```
+**Exports:** `.` · `./validate` · `./profiles` · `./types` · `./v2`
 
 ## Quick V2 example
 
@@ -54,12 +55,24 @@ npx memorix-format migrate-to-v2 ./present.json \
   --object-type=work-items --content-type=snapshots --data-category=entity
 ```
 
-## Present envelope (migration)
+```ts
+import { validateMemorixRecordV2 } from "@x12i/memorix-format/v2";
+
+const result = validateMemorixRecordV2(doc);
+if (!result.ok) throw new Error(result.errors.join("; "));
+```
+
+## Hard rules (format)
+
+- V2 rejects **copied** related-record payloads in the document.
+- Authoritative navigation between subjects is **four-field relationship links** (`@x12i/memorix-relationships`), not embedded `associated*`.
 
-Still documented for existing data. Open buckets: `analytics`, `enrichment`, `insights`, `associated*` (copied payloads — **rejected on V2**).
+## Docs
 
-## Writer flag
+- [`docs/memorix-record-v2.md`](./docs/memorix-record-v2.md) · [`meta/`](./meta/)
+- Ebook: [Format for Dummies](../new-ebooks/01-format-for-dummies/)
+- Hub: [https://ebooks.memorix.x12i.com](https://ebooks.memorix.x12i.com)
 
 ```bash
-MEMORIX_RECORD_FORMAT=v2
+npm test
 ```

package/docs/association-format.md

@@ -39,7 +39,7 @@ Object-type segments come from Catalox descriptors — not from this format pack
 
 - Associated properties are **arrays of plain objects** (linked payloads), never full envelopes.
 - On **memorix-record/2**, root `associated*` may hold **lightweight refs only** (Option A — format-valid): `relationshipDefinitionId` + `recordId`, optional `relationshipId`. Copied related business payload is rejected.
-- **Authoritative relationship storage (Gate G4)** is centralized per-category collections (Candidate C), not Option A roots or sibling `relationships` content. See `docs/re-factoring-and-ops-agent/RELATIONSHIP-STORAGE-DECISION.md`.
+- **Authoritative relationship storage (Gate G4)** is centralized per-category collections (Candidate C), not Option A roots or sibling `relationships` content. See `@x12i/memorix-relationship-store` (archived decision: `.tmp/housekeeping-2026-07-23/docs/re-factoring-and-ops-agent/RELATIONSHIP-STORAGE-DECISION.md`).
 
 - **Omit** the property when empty — never write `[]`.
 - Prefer traceability in optional item-level `_system.association` (v2) rather than wrapping envelopes.

package/docs/memorix-format.md

@@ -56,7 +56,7 @@ Every piece of business data lives in **exactly one** of these buckets (plus the
 | **`insights`** | AI / judgment outputs |
 | **`associated*`** | Copied related payloads (present only; removed in V2) |
 
-On **memorix-record/2**, snapshot buckets are optional and **omitted when empty**. Root `associated*` may hold **lightweight refs** only (Option A — still format-valid). **Authoritative relationship storage (Gate G4)** is centralized per-category collections (Candidate C); see `docs/re-factoring-and-ops-agent/RELATIONSHIP-STORAGE-DECISION.md`.
+On **memorix-record/2**, snapshot buckets are optional and **omitted when empty**. Root `associated*` may hold **lightweight refs** only (Option A — still format-valid). **Authoritative relationship storage (Gate G4)** is centralized per-category collections (Candidate C); see `@x12i/memorix-relationship-store` (archived: `.tmp/housekeeping-2026-07-23/docs/re-factoring-and-ops-agent/RELATIONSHIP-STORAGE-DECISION.md`).
 
 ---
 

package/docs/memorix-record-v2.md

@@ -52,7 +52,7 @@ type MemorixRecordV2 = {
 3. **Composition** = same `recordId` across content types; not a relationship.
 4. **`_graphRuns` / `_jobTypeRuns` stay off the subject** — operational run ledger owns run history.
 5. **V2 rejects copied related-record payloads.** Root `associated*` may hold **lightweight relationship refs** only: required `relationshipDefinitionId` + `recordId`; optional `relationshipId` (derivable). Without `relationshipDefinitionId` the item is not a relationship. **Option A** (direct-record lightweight `associated*` roots) remains **format-valid** for validation and migration compatibility.
-6. **Authoritative physical relationship storage is Gate G4 Candidate C** — org-prefixed per-category `relationships` collections (`entity` / `event` / `knowledge`). Option A lightweight roots and sibling `relationships` content are **not** the selected authoritative storage model; see `docs/re-factoring-and-ops-agent/RELATIONSHIP-STORAGE-DECISION.md`.
+6. **Authoritative physical relationship storage is Gate G4 Candidate C** — org-prefixed per-category `relationships` collections (`entity` / `event` / `knowledge`). Option A lightweight roots and sibling `relationships` content are **not** the selected authoritative storage model; see `@x12i/memorix-relationship-store` / `@x12i/memorix-relationships` (decision note archived under `.tmp/housekeeping-2026-07-23/docs/re-factoring-and-ops-agent/RELATIONSHIP-STORAGE-DECISION.md`).
 7. **Present format remains the writer/pipeline default** until cutover (`MEMORIX_RECORD_FORMAT=v2`). All **new** refactor packages and the `ops` harness use V2 exclusively. The env switch is transitional (`DEL-FORMAT-PRESENT-SOT`).
 
 ## Revision vs lifecycle

package/docs/migrate-present-to-v2.md

@@ -44,6 +44,6 @@ Optional `associatedPropertyMap: { associatedPeople: "people-assigned-to-work-it
 
 ## Gate G4 boundary
 
-**Authoritative physical relationship storage (Gate G4):** centralized org-prefixed per-category `relationships` collections (Candidate C). See `docs/re-factoring-and-ops-agent/RELATIONSHIP-STORAGE-DECISION.md`.
+**Authoritative physical relationship storage (Gate G4):** centralized org-prefixed per-category `relationships` collections (Candidate C). See `@x12i/memorix-relationship-store` (archived decision: `.tmp/housekeeping-2026-07-23/docs/re-factoring-and-ops-agent/RELATIONSHIP-STORAGE-DECISION.md`).
 
 `migratePresentToV2` still extracts relationship candidates **out-of-band** and does not persist them onto the V2 record. Option A root `associated*` lightweight refs remain **format-valid** but are **not** the selected authoritative storage model.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@x12i/memorix-format",
-  "version": "2.3.3",
+  "version": "3.0.1",
   "description": "Memorix format: present envelope + memorix-record/2 (Gate G2 SoT), validators, migrate CLIs.",
   "type": "module",
   "main": "./dist/index.js",