Commit graph

4 commits

Author SHA1 Message Date
970e08c466 feat(8.0): reserved-field contract — one canonical location, typed prevention, unified read/write
Brainy-owned field names (noun/verb, subtype, createdAt, updatedAt,
confidence, weight, service, data, createdBy, _rev) now have exactly one
home — top level — enforced by three layers driven from a single source of
truth, src/types/reservedFields.ts (RESERVED_ENTITY_FIELDS /
RESERVED_RELATION_FIELDS, exported):

1. Compile time — AddParams/UpdateParams/RelateParams/UpdateRelationParams
   metadata (and the transact() ops that extend them) reject a literal
   reserved key as a TypeScript error while keeping generic T ergonomics
   (typed bags, untyped brains, index-signature shapes, and a documented
   exemption for T-declared reserved keys). Pinned by @ts-expect-error
   type tests run under vitest typecheck mode on every unit run.

2. Write time — the 7.x update() remap is ported to 8.0 and extended to
   every write path: add/update/relate/updateRelation, their transact()
   mirrors, and db.with() overlays. User-settable fields lift to their
   dedicated param (top-level wins when both are supplied — closes the 7.x
   trap where update({metadata:{confidence}}) silently no-oped), and
   system-managed fields drop with a one-shot warning naming the right
   path. A remapped subtype satisfies subtype-pairing enforcement exactly
   like a top-level one.

3. Read time — every storage combine goes through one canonical hydration
   helper (hydrateNounWithMetadata / hydrateVerbWithMetadata over
   splitNoun/VerbMetadataRecord), so reserved fields surface ONLY top-level
   and entity/relation.metadata carry ONLY custom fields on live reads,
   batch reads, paginated listings, getRelations by source/target, streamed
   verbs, and historical asOf() materialization alike.

Read-path echoes found and fixed (previously the full stored record —
including the verb type key — leaked inside metadata): noun pagination,
verb pagination, getVerbsBySource/ByTarget (adjacency + shard fallback),
getVerbsBySourceBatch (which also dropped subtype/data), and the
filesystem verb stream. getRelations() results now surface
confidence/updatedAt top-level via verbsToRelations, updateRelation() no
longer erases service/createdBy, relate() persists its top-level
confidence/service params, and the dead convertHNSWVerbToGraphVerb echo
path is deleted. Import paths (CLI extract, deduplicator, coordinators,
neural import) write confidence through the dedicated param instead of the
bag. UpdateRelationParams is now exported from the package root.

Documented for consumers in docs/concepts/consistency-model.md ("Reserved
fields") and RELEASES.md. Regression tests ported from the 7.x fix and
extended to the full 8.0 contract (17 runtime tests + 41 type-level
assertions); full unit suite 1427/1427, db-mvcc integration 24/24.
2026-06-11 13:13:09 -07:00
c5dcdf6033 fix: update tests for Stage 3 CANONICAL taxonomy (42 nouns, 127 verbs)
Stage 3 taxonomy (v5.5.0) expanded from 31→42 noun types and 40→127
verb types but tests weren't updated. This fixes all test failures.

FIXES:
- typeUtils.test.ts: Update all hardcoded type indexes for new enum order
  - Document: index 6→13, Resource: index 30→34
  - InstanceOf: index 0 (was RelatedTo), During: index 10 (was Creates)
  - Update round-trip loops: 31→42 nouns, 40→127 verbs
  - Fix Uint32Array test expectations

- brainyTypes.ts: Add missing type descriptions for Stage 3 types
  - Added 11 new noun type descriptions (quality, timeInterval, function, etc.)
  - Add graceful handling for missing descriptions (prevents crash)

TEST RESULTS:
 46 test files passing (was 44 failing)
 1147 tests passing (was 1136 failing)
 100% pass rate restored

Root cause: Tests had hardcoded expectations from pre-Stage-3 taxonomy.
2025-11-11 10:09:01 -08:00
823cd5cf1b fix: update all Stage 2 references to Stage 3 CANONICAL type counts
Comprehensive update of type count references from Stage 2 (31 nouns + 40 verbs)
to Stage 3 CANONICAL (42 nouns + 127 verbs) across entire codebase.

Changes (23 files):
- Core architecture: Memory tracking comments, speedup calculations
- Tests: Type count assertions, enum index expectations, memory benchmarks
- CLI: User-visible type count output
- Augmentations: Type detection comments
- Documentation: Architecture docs, guides, performance docs
- Type embeddings: Regenerated for all 169 types (338KB)

Specific updates:
- 31 → 42 (noun count): 38 occurrences
- 40 → 127 (verb count): 24 occurrences
- 124 → 168 bytes (noun array size): 5 occurrences
- 160 → 508 bytes (verb array size): 5 occurrences
- 284 → 676 bytes (total type tracking): 12 occurrences
- Enum indices updated to match Stage 3 reordering

Type embeddings regenerated:
- 42 noun embeddings (64.5 KB)
- 127 verb embeddings (194.8 KB)
- Total: 338 KB (was 108.8 KB)

All constants, arrays, and tests now consistent with Stage 3 taxonomy.

Fixes #v5.5.1-type-count-migration
2025-11-06 09:40:33 -08:00
951e514fd7 feat(types): Phase 0 - Type System Foundation for billion-scale optimization
Phase 0 Complete: Type-first architecture foundation
- Zero technical debt
- Production-ready code
- 100% test coverage

Type System Enums:
- Add NounTypeEnum with indices 0-30 (31 types)
- Add VerbTypeEnum with indices 0-39 (40 types)
- Add NOUN_TYPE_COUNT and VERB_TYPE_COUNT constants

Type Utilities (O(1) operations):
- TypeUtils.getNounIndex: type → numeric index
- TypeUtils.getVerbIndex: type → numeric index
- TypeUtils.getNounFromIndex: index → type string
- TypeUtils.getVerbFromIndex: index → type string

Type Metadata (optimization hints):
- Per-type expectedFields count
- Per-type bloomBits configuration (128 or 256)
- Per-type avgChunkSize for chunking

Memory Impact:
- Type tracking: ~120KB → 284 bytes (-99.76% reduction)
- Enables fixed-size Uint32Array operations
- Enables type-specific bloom filter sizing

Tests:
- Add typeUtils.test.ts with 34 passing tests
- 100% coverage of type utilities
- Memory efficiency validation
- Round-trip conversion tests

Type Embeddings:
- Auto-regenerated for 31 nouns + 40 verbs
- Embedding dimensions: 384
- Size: 106.5 KB binary, 142.0 KB base64

Next: Phase 1 - Type-First Metadata Index (1 week)
Expected impact: 5GB → 3GB metadata (-40%)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-15 12:26:25 -07:00