CRITICAL CHECKPOINT - DO NOT PUSH TO GITHUB Recovery Status: - Successfully recovered brainy.ts from compiled JavaScript - All core v3.0 API methods functional (add, get, update, delete, relate, find, etc.) - Neural subsystem intact (562KB embedded patterns, NLP working) - Augmentation pipeline operational (20+ augmentations) - HNSW clustering system complete - Triple Intelligence compiled (needs constructor fix) - Test suite validates functionality Changes preserved: - 898 files with changes from last 3 days - 144,475 insertions - All augmentation improvements - All test coverage enhancements - Complete v3.0 feature set This is a LOCAL checkpoint only - contains recovered work after corruption incident. Created backup in .backups/brainy-full-20250910-151314.tar.gz Branch: recovery-checkpoint-20250910-151433 Date: Wed Sep 10 03:18:04 PM PDT 2025
306 lines
No EOL
10 KiB
JavaScript
306 lines
No EOL
10 KiB
JavaScript
/**
|
|
* Augmentation Metadata Contract System
|
|
*
|
|
* Prevents accidental metadata corruption while allowing intentional enrichment
|
|
* Each augmentation declares its metadata intentions upfront
|
|
*/
|
|
/**
|
|
* Runtime metadata safety enforcer
|
|
*/
|
|
export class MetadataSafetyEnforcer {
|
|
constructor() {
|
|
this.contracts = new Map();
|
|
this.modifications = new Map(); // field -> augmentations that modify it
|
|
}
|
|
/**
|
|
* Register an augmentation's contract
|
|
*/
|
|
registerContract(contract) {
|
|
this.contracts.set(contract.name, contract);
|
|
// Track which augmentations modify which fields
|
|
if (contract.writes?.userFields) {
|
|
for (const fieldDef of contract.writes.userFields) {
|
|
if (!this.modifications.has(fieldDef.field)) {
|
|
this.modifications.set(fieldDef.field, new Set());
|
|
}
|
|
this.modifications.get(fieldDef.field).add(contract.name);
|
|
}
|
|
}
|
|
}
|
|
/**
|
|
* Check if an augmentation can modify a field
|
|
*/
|
|
canModifyField(augName, field, value) {
|
|
const contract = this.contracts.get(augName);
|
|
if (!contract) {
|
|
return {
|
|
allowed: false,
|
|
reason: `Augmentation '${augName}' has no registered contract`
|
|
};
|
|
}
|
|
// Check if field is in user namespace
|
|
if (!field.startsWith('_brainy.') && !field.startsWith('_augmentations.')) {
|
|
// It's a user field
|
|
const declaredField = contract.writes?.userFields?.find(f => f.field === field);
|
|
if (!declaredField) {
|
|
return {
|
|
allowed: false,
|
|
reason: `Augmentation '${augName}' did not declare intent to modify '${field}'`
|
|
};
|
|
}
|
|
// Check for conflicts
|
|
const modifiers = this.modifications.get(field);
|
|
if (modifiers && modifiers.size > 1) {
|
|
const others = Array.from(modifiers).filter(a => a !== augName);
|
|
return {
|
|
allowed: true, // Still allowed but with warning
|
|
warnings: [`Field '${field}' is also modified by: ${others.join(', ')}`]
|
|
};
|
|
}
|
|
return { allowed: true };
|
|
}
|
|
// Check internal fields
|
|
if (field.startsWith('_brainy.')) {
|
|
const internalField = contract.writes?.internalFields?.find(f => field === `_brainy.${f.field}`);
|
|
if (!internalField) {
|
|
return {
|
|
allowed: false,
|
|
reason: `Augmentation '${augName}' cannot modify internal field '${field}'`
|
|
};
|
|
}
|
|
if (internalField.permission !== 'granted') {
|
|
return {
|
|
allowed: false,
|
|
reason: `Permission not granted for internal field '${field}'`
|
|
};
|
|
}
|
|
return { allowed: true };
|
|
}
|
|
// Check augmentation namespace
|
|
if (field.startsWith('_augmentations.')) {
|
|
const parts = field.split('.');
|
|
const targetAug = parts[1];
|
|
// Can only modify own namespace
|
|
if (targetAug !== augName) {
|
|
return {
|
|
allowed: false,
|
|
reason: `Cannot modify another augmentation's namespace: ${targetAug}`
|
|
};
|
|
}
|
|
return { allowed: true };
|
|
}
|
|
return { allowed: true };
|
|
}
|
|
/**
|
|
* Create safe metadata proxy for an augmentation
|
|
*/
|
|
createSafeProxy(metadata, augName) {
|
|
const self = this;
|
|
return new Proxy(metadata, {
|
|
set(target, prop, value) {
|
|
const field = String(prop);
|
|
// Check permission
|
|
const permission = self.canModifyField(augName, field, value);
|
|
if (!permission.allowed) {
|
|
throw new Error(`[${augName}] ${permission.reason}`);
|
|
}
|
|
if (permission.warnings) {
|
|
console.warn(`[${augName}] Warning:`, ...permission.warnings);
|
|
}
|
|
// Track modification for audit
|
|
if (!target._audit) {
|
|
target._audit = [];
|
|
}
|
|
target._audit.push({
|
|
augmentation: augName,
|
|
field,
|
|
oldValue: target[prop],
|
|
newValue: value,
|
|
timestamp: Date.now()
|
|
});
|
|
target[prop] = value;
|
|
return true;
|
|
},
|
|
deleteProperty(target, prop) {
|
|
const field = String(prop);
|
|
const permission = self.canModifyField(augName, field, undefined);
|
|
if (!permission.allowed) {
|
|
throw new Error(`[${augName}] Cannot delete field: ${permission.reason}`);
|
|
}
|
|
delete target[prop];
|
|
return true;
|
|
}
|
|
});
|
|
}
|
|
}
|
|
/**
|
|
* Example augmentation contracts
|
|
*/
|
|
export const EXAMPLE_CONTRACTS = {
|
|
// Enrichment augmentation that adds categories
|
|
categoryEnricher: {
|
|
name: 'categoryEnricher',
|
|
version: '1.0.0',
|
|
reads: {
|
|
userFields: ['title', 'description', 'content']
|
|
},
|
|
writes: {
|
|
userFields: [
|
|
{
|
|
field: 'category',
|
|
type: 'create',
|
|
description: 'Auto-detected category',
|
|
example: 'technology'
|
|
},
|
|
{
|
|
field: 'subcategories',
|
|
type: 'create',
|
|
description: 'List of relevant subcategories',
|
|
example: ['web', 'framework']
|
|
}
|
|
],
|
|
augmentationFields: [
|
|
{
|
|
field: 'confidence',
|
|
description: 'Confidence score of categorization'
|
|
}
|
|
]
|
|
},
|
|
guarantees: {
|
|
preservesExisting: true,
|
|
idempotent: true
|
|
}
|
|
},
|
|
// Translation augmentation
|
|
translator: {
|
|
name: 'translator',
|
|
version: '1.0.0',
|
|
reads: {
|
|
userFields: ['title', 'description']
|
|
},
|
|
writes: {
|
|
userFields: [
|
|
{
|
|
field: 'translations',
|
|
type: 'merge',
|
|
description: 'Translations in multiple languages',
|
|
example: { es: 'Título', fr: 'Titre' }
|
|
},
|
|
{
|
|
field: 'detectedLanguage',
|
|
type: 'create',
|
|
description: 'Detected source language',
|
|
example: 'en'
|
|
}
|
|
]
|
|
},
|
|
conflictResolution: {
|
|
strategy: 'merge',
|
|
priority: 10
|
|
}
|
|
},
|
|
// Sentiment analyzer
|
|
sentimentAnalyzer: {
|
|
name: 'sentimentAnalyzer',
|
|
version: '1.0.0',
|
|
reads: {
|
|
userFields: ['content', 'description', 'reviews']
|
|
},
|
|
writes: {
|
|
userFields: [
|
|
{
|
|
field: 'sentiment',
|
|
type: 'update',
|
|
description: 'Overall sentiment score',
|
|
example: { score: 0.8, label: 'positive' }
|
|
}
|
|
],
|
|
augmentationFields: [
|
|
{
|
|
field: 'analysis',
|
|
description: 'Detailed sentiment breakdown'
|
|
}
|
|
]
|
|
},
|
|
guarantees: {
|
|
reversible: true,
|
|
validatesTypes: true
|
|
}
|
|
},
|
|
// System augmentation with internal access
|
|
garbageCollector: {
|
|
name: 'garbageCollector',
|
|
version: '1.0.0',
|
|
reads: {
|
|
internalFields: ['_brainy.createdAt', '_brainy.lastAccessed']
|
|
},
|
|
writes: {
|
|
internalFields: [
|
|
{
|
|
field: 'deleted',
|
|
permission: 'granted',
|
|
reason: 'Soft delete expired items'
|
|
},
|
|
{
|
|
field: 'archived',
|
|
permission: 'granted',
|
|
reason: 'Archive old items'
|
|
}
|
|
]
|
|
}
|
|
}
|
|
};
|
|
/**
|
|
* Augmentation base class with safety
|
|
*/
|
|
export class SafeAugmentation {
|
|
constructor(contract) {
|
|
this.contract = contract;
|
|
this.enforcer = new MetadataSafetyEnforcer();
|
|
this.enforcer.registerContract(contract);
|
|
}
|
|
/**
|
|
* Get safe metadata proxy
|
|
*/
|
|
getSafeMetadata(metadata) {
|
|
return this.enforcer.createSafeProxy(metadata, this.contract.name);
|
|
}
|
|
}
|
|
/**
|
|
* Example: Category enricher implementation
|
|
*/
|
|
export class CategoryEnricherAugmentation extends SafeAugmentation {
|
|
constructor() {
|
|
super(EXAMPLE_CONTRACTS.categoryEnricher);
|
|
}
|
|
async execute(metadata) {
|
|
const safe = this.getSafeMetadata(metadata);
|
|
// Read declared fields
|
|
const title = safe.title;
|
|
const description = safe.description;
|
|
// Analyze and categorize
|
|
const category = this.detectCategory(title, description);
|
|
const subcategories = this.detectSubcategories(title, description);
|
|
// Write to declared fields (will be checked by proxy)
|
|
safe.category = category; // ✅ Allowed - declared in contract
|
|
safe.subcategories = subcategories; // ✅ Allowed
|
|
// Try to write undeclared field
|
|
// safe.randomField = 'test' // ❌ Would throw error!
|
|
// Write to our augmentation namespace
|
|
if (!safe._augmentations)
|
|
safe._augmentations = {};
|
|
if (!safe._augmentations.categoryEnricher) {
|
|
safe._augmentations.categoryEnricher = {};
|
|
}
|
|
safe._augmentations.categoryEnricher.confidence = 0.95; // ✅ Allowed
|
|
return safe;
|
|
}
|
|
detectCategory(title, description) {
|
|
// Simplified logic
|
|
return 'technology';
|
|
}
|
|
detectSubcategories(title, description) {
|
|
return ['web', 'framework'];
|
|
}
|
|
}
|
|
//# sourceMappingURL=AugmentationMetadataContract.js.map
|