API Reference

API Reference

Complete type definitions for the MindFry TypeScript SDK.

Core Types

interface MindFryConfig {
  host: string
  port: number
  timeout?: number // Default: 5000ms
}

interface LineageInfo {
  key: string
  energy: number
  created: number
  accessed: number
}

interface BondInfo {
  from: string
  to: string
  strength: number
  polarity: number // +1, 0, -1
}

interface SystemStats {
  lineage_count: number
  bond_count: number
  mood: number
  uptime: number
}

Lineage API

interface LineageAPI {
  create(options: { key: string; energy: number }): Promise<void>

  get(key: string, flags?: number): Promise<LineageInfo>

  stimulate(options: { key: string; delta: number; flags?: number }): Promise<void>

  forget(key: string): Promise<void>

  touch(key: string): Promise<void>
}

Bond API

interface BondAPI {
  connect(options: { from: string; to: string; strength: number; polarity: number }): Promise<void>

  reinforce(options: { from: string; to: string; delta: number }): Promise<void>

  sever(from: string, to: string): Promise<void>
}

Query API

interface QueryAPI {
  neighbors(key: string): Promise<BondInfo[]>
  conscious(minEnergy: number): Promise<string[]>
  topK(k: number): Promise<LineageInfo[]>
  pattern(pattern: string): Promise<string[]>
}

System API

interface SystemAPI {
  ping(): Promise<number> // Returns uptime
  stats(): Promise<SystemStats>
  setMood(mood: number): Promise<void>
  snapshot(name: string): Promise<void>
  restore(name: string): Promise<void>
  freeze(frozen: boolean): Promise<void>
}

Enums

enum LineageStatus {
  Found = 0,
  NotFound = 1,
  Repressed = 2,
  Dormant = 3,
}

enum QueryFlags {
  BYPASS_FILTERS = 0x01,
  INCLUDE_REPRESSED = 0x02,
  NO_SIDE_EFFECTS = 0x04,
  FORENSIC = 0x07,
}

enum StimulateFlags {
  NO_PROPAGATE = 0x01,
}