soulcraft/brainy
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions

feat: implement comprehensive type safety system with BrainyTypes API

Browse source 
Major enhancements for type safety and developer experience:

- Add BrainyTypes static API for type management and AI-powered suggestions
- Implement strict type validation for all 31 NounType categories
- Remove dangerous generic add() method that bypassed type safety
- Add intelligent type inference with confidence scoring
- Provide helpful error messages with typo suggestions using Levenshtein distance
- Update all internal code, examples, and documentation to use typed methods
- Enhance CLI with new type management commands (types, suggest, validate)

Breaking changes:
- Remove deprecated add() method - use addNoun() with explicit type parameter
- All addNoun() calls now require explicit type as second parameter

This release significantly improves type safety across the entire system while
maintaining backward compatibility for properly typed method calls.

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

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
David Snelling 2025-09-01 09:37:36 -07:00
parent d7d2d749b6
commit 6c62bc4e9d
40 changed files with 1704 additions and 497 deletions
Download patch file Download diff file Expand all files Collapse all files

40
src/storage/baseStorage.ts
View file

@ -5,6 +5,8 @@
import { GraphVerb, HNSWNoun, HNSWVerb, StatisticsData } from '../coreTypes.js'
import { BaseStorageAdapter } from './adapters/baseStorageAdapter.js'
import { validateNounType, validateVerbType } from '../utils/typeValidation.js'
import { NounType, VerbType } from '../types/graphTypes.js'
// Common directory/prefix names
// Option A: Entity-Based Directory Structure
@ -81,6 +83,11 @@ export abstract class BaseStorage extends BaseStorageAdapter {
*/
public async saveNoun(noun: HNSWNoun): Promise<void> {
await this.ensureInitialized()
// Validate noun type before saving - storage boundary protection
const metadata = await this.getNounMetadata(noun.id)
if (metadata?.noun) {
validateNounType(metadata.noun)
}
return this.saveNoun_internal(noun)
}
@ -116,6 +123,11 @@ export abstract class BaseStorage extends BaseStorageAdapter {
public async saveVerb(verb: GraphVerb): Promise<void> {
await this.ensureInitialized()
// Validate verb type before saving - storage boundary protection
if (verb.verb) {
validateVerbType(verb.verb)
}
// Extract the lightweight HNSWVerb data
const hnswVerb: HNSWVerb = {
id: verb.id,
@ -635,7 +647,19 @@ export abstract class BaseStorage extends BaseStorageAdapter {
* Save noun metadata to storage
* This method should be implemented by each specific adapter
*/
public abstract saveNounMetadata(id: string, metadata: any): Promise<void>
public async saveNounMetadata(id: string, metadata: any): Promise<void> {
// Validate noun type in metadata - storage boundary protection
if (metadata?.noun) {
validateNounType(metadata.noun)
}
return this.saveNounMetadata_internal(id, metadata)
}
/**
* Internal method for saving noun metadata
* This method should be implemented by each specific adapter
*/
protected abstract saveNounMetadata_internal(id: string, metadata: any): Promise<void>
/**
* Get noun metadata from storage
@ -647,7 +671,19 @@ export abstract class BaseStorage extends BaseStorageAdapter {
* Save verb metadata to storage
* This method should be implemented by each specific adapter
*/
public abstract saveVerbMetadata(id: string, metadata: any): Promise<void>
public async saveVerbMetadata(id: string, metadata: any): Promise<void> {
// Validate verb type in metadata - storage boundary protection
if (metadata?.verb) {
validateVerbType(metadata.verb)
}
return this.saveVerbMetadata_internal(id, metadata)
}
/**
* Internal method for saving verb metadata
* This method should be implemented by each specific adapter
*/
protected abstract saveVerbMetadata_internal(id: string, metadata: any): Promise<void>
/**
* Get verb metadata from storage