@dawn-ai/memory

pnpm add @dawn-ai/memory

import { sqliteMemoryStore } from "@dawn-ai/memory"
import { validateBrowseQuery } from "@dawn-ai/memory/browse"
import { serializeNamespace } from "@dawn-ai/memory/namespace"
import { approveWithReconcile } from "@dawn-ai/memory/reconcile"

export interface MemoryScopeTuple {
  readonly workspace?: string
  readonly route?: string
  readonly tenant?: string
  readonly user?: string
  readonly agent?: string
}

export interface MemoryRecord {
  readonly id: string
  readonly kind: MemoryKind
  readonly namespace: string
  readonly content: string
  readonly data: Record<string, unknown>
  readonly source: MemorySource
  readonly confidence: number
  readonly tags: readonly string[]
  readonly status: MemoryStatus
  readonly supersedes?: readonly string[]
  readonly createdAt: string
  readonly updatedAt: string
  readonly effectiveAt?: string
  readonly expiresAt?: string
}

export interface MemoryQuery {
  readonly namespace: string
  readonly query?: string
  readonly kind?: MemoryKind
  readonly tags?: readonly string[]
  readonly status?: MemoryStatus
  readonly limit?: number
  readonly now?: string
  readonly since?: string
  readonly until?: string
  readonly queryEmbedding?: Float32Array
  readonly embedderId?: string
  readonly vector?: VectorRankingOptions
}

export interface BrowsePage {
  readonly records: readonly MemoryRecord[]
  readonly total: number
  readonly continuation: string | null
}

export interface BrowseQuery {
  readonly namespacePrefix?: string
  readonly namespace?: string
  readonly status?: MemoryStatus | readonly MemoryStatus[]
  readonly kind?: MemoryKind | readonly MemoryKind[]
  readonly sourceType?: MemorySource["type"]
  readonly limit?: number
  readonly offset?: number
  readonly since?: string
  readonly until?: string
  readonly now?: string
  readonly filters?: readonly BrowseFilter[]
  readonly orderBy?: readonly BrowseSortEntry[]
  readonly cursor?: string
}

export interface MemoryStore {
  put(
    rec: MemoryRecord,
    opts?: { readonly embedding?: Float32Array; readonly embeddingModel?: string },
  ): Promise<void>
  get(id: string): Promise<MemoryRecord | null>
  search(q: MemoryQuery): Promise<readonly MemoryRecord[]>
  update(id: string, patch: Partial<MemoryRecord>): Promise<void>
  supersede(id: string, bySupersedingId: string): Promise<void>
  delete(id: string): Promise<void>
  listCandidates(namespacePrefix: string): Promise<readonly MemoryRecord[]>
  browse(q?: BrowseQuery): Promise<BrowsePage>
  stats(opts?: { readonly namespacePrefix?: string }): Promise<MemoryStats>
  prune(opts: {
    readonly now: string
    readonly namespacePrefix?: string
    readonly cap?: number
  }): Promise<{ readonly deletedExpired: number; readonly deletedOverCap: number }>
}

export declare function serializeNamespace(tuple: MemoryScopeTuple): string

export declare function approveWithReconcile(
  store: MemoryStore,
  id: string,
  opts: { readonly identityKeys: readonly string[]; readonly now: string },
): Promise<ApproveResult>

import { sqliteMemoryStore } from "@dawn-ai/memory"
 
const store = sqliteMemoryStore({ path: ".dawn/memory.sqlite" })
const records = await store.search({ namespace: "workspace=acme", query: "shipping" })