@x12i/memorix-writer 1.9.0 → 1.9.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/README.md +5 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@ Shared MongoDB naming rules: [docs/MEMORIX-DATABASE-CONVENTIONS.md](./docs/MEMOR
|
|
|
6
6
|
|
|
7
7
|
## Architecture
|
|
8
8
|
|
|
9
|
-
- **Catalox** — `memorix-write-descriptors`, `memorix-object-type-descriptors`
|
|
9
|
+
- **Catalox** — `memorix-write-descriptors`, `memorix-object-type-descriptors`. Catalog metadata (descriptors, catalog items) lives in **MongoDB** — the `memorix-catalox` database, via `@x12i/catalox`'s Mongo store (`@x12i/catalox/mongo`). This replaced the legacy Firestore-backed Catalox; Firestore is kept around only as a one-time backfill source for tenants that haven't migrated yet (see [Catalox seeds](#catalox-seeds)), never as a live read/write path.
|
|
10
10
|
- **MongoDB** — built-in `MemorixDataTier` + collection-name CRUD (no separate `@x12i/memorix` package)
|
|
11
11
|
- **@x12i/memorix-descriptors** — shared catalog ids and descriptor validation (aligned with retrieval)
|
|
12
12
|
- **@x12i/helpers** — GCS/S3 content uploads (`contentWriters.gcs` / `contentWriters.s3`)
|
|
@@ -146,19 +146,21 @@ Narrative keys use the same top-level `narratives.{key}` shape consumed by `@x12
|
|
|
146
146
|
|
|
147
147
|
## Catalox seeds
|
|
148
148
|
|
|
149
|
+
Catalog metadata for this package (write descriptors, entity descriptors) is managed in **MongoDB** — the `memorix-catalox` database — not Firestore. The manifest below is the source of truth for what gets applied there.
|
|
150
|
+
|
|
149
151
|
Validate the write descriptor seed:
|
|
150
152
|
|
|
151
153
|
```bash
|
|
152
154
|
npm run catalox:seed:write-descriptors:validate
|
|
153
155
|
```
|
|
154
156
|
|
|
155
|
-
Apply to Mongo `memorix-catalox` (uses `MONGO_URI` + `MEMORIX_CATALOX_DB`):
|
|
157
|
+
Apply the manifest to Mongo `memorix-catalox` (uses `MONGO_URI` + `MEMORIX_CATALOX_DB`) — this is the normal way to publish or update descriptors:
|
|
156
158
|
|
|
157
159
|
```bash
|
|
158
160
|
npm run catalox:seed:write-descriptors:apply
|
|
159
161
|
```
|
|
160
162
|
|
|
161
|
-
|
|
163
|
+
One-time migration helper only: pull any catalog items still living in the legacy Firestore Catalox (app `memorix`) into the manifest, then apply to Mongo. Use this only while backfilling a tenant that hasn't fully migrated off Firestore yet — new descriptors should be added straight to the manifest, not to Firestore.
|
|
162
164
|
|
|
163
165
|
```bash
|
|
164
166
|
npm run catalox:seed:write-descriptors:sync-firestore
|