Skip to content

Repository files navigation

polypack

Embedded graph and vector memory for adaptive, local-first apps.

npm version GitHub release CI

Polypack is an embedded graph and vector database for adaptive, local-first applications. It combines property relationships, semantic search, persistent activation, working-memory primitives, and real-time synchronisation across TypeScript, Python, and Rust. It runs in Node.js and the browser with pluggable persistence (in-memory, filesystem, or OPFS).

Install

npm install @0xx0lostcause0xx0/polypack

React is an optional peer dependency and is only required when importing from @0xx0lostcause0xx0/polypack/react.

Python and Rust bindings over the same core are published separately:

pip install polypack-db
cargo add polypack-core

Releases

  • npm package: @0xx0lostcause0xx0/polypack is the installable TypeScript/JavaScript distribution for Node.js and browser build tooling. @0xx0lostcause0xx0/polypack-native provides NAPI-RS bindings to the native VectorIndex/HNSWIndex.
  • PyPI package: polypack-db is the Python distribution, built with maturin/PyO3 over the same Rust core.
  • crates.io package: polypack-core is the portable Rust core (property graph, vector search, persistence) underlying the TypeScript native addon and the Python bindings.
  • GitHub releases: release notes, source archives, and tags are published from the repository. The current coordinated source version is 3.2.0.

Stable GitHub releases run the complete test, build, export, and package checks before the corresponding packages are submitted to npm, PyPI, and crates.io with provenance/trusted publishing. All three ecosystems are version-locked together. See the changelog for breaking changes and migration notes.

Features

  • Property graph — typed nodes and edges with arbitrary data payloads
  • LRU working set — 50K loaded-node limit by default, with explicit restoration from persistence
  • Vector similarity — cosine, euclidean, or pluggable distance functions
  • Pluggable text embeddings — supply any local or hosted model, with a dependency-free 384-dimensional feature-hash provider included by default
  • Fluent query builder — filter by type/attribute/edge/range, BFS traversal, vector similarity
  • Relational extensionspluck, aggregate, groupAggregate, join, groupByVector (clustering)
  • Edge ownershipowned (cascade delete), shared (orphan detection), reference (no-op)
  • Reactive — RxJS change events, batching, React hooks
  • Pluggable persistence — MemoryAdapter, BinaryStoreAdapter (MessagePack + WAL), build your own
  • Database core — atomic transactions, revisions, conditional writes, patches, schema hooks, and resource limits
  • Capability checks — inspect adapter guarantees and reject configurations that require unsupported durability, indexing, concurrency, or vector-search features
  • Operational durability — checkpoint/backup/verification APIs, durable logical mutation logs, cursors, and idempotent operation IDs
  • Schema migrations — contiguous, validated, retry-safe application migrations with dry runs, resume cursors, and progress reporting
  • Explainable queries — persisted and hot-query plans with index selection, estimated cost, and operational metrics
  • Configurable indexes — compound and unique node-data indexes with persisted Python index metadata
  • Cross-language contract — shared conformance fixtures and compatibility levels for TypeScript, Rust, and Python
  • Persisted queries — asynchronous filtering, ordering, pagination, and similarity across the full backing store without loading the result set into the hot cache
  • Adaptive memory — durable, decayed relevance (score/importance/inhibition) per node with per-context activation lenses, spreading activation over edges, semantic pulses, a budgeted/diversity-aware working-memory set, memory classes with differentiated decay, confidence/provenance fields, contradiction (supersede) and consolidation (consolidate) primitives, and feedback-driven learned scoring weights — synced additively
  • Real-time sync — acknowledgements, retry, deduplication, reconnect recovery, and echo suppression

For scale limits and reproducible 100K/1M/10M-node characterization, see the scale benchmark. Its default vector scope is capped at 100K for practical 10M-node storage and graph runs; full vector indexing is an explicit opt-in.

Quick start

import { PolyGraph, MemoryAdapter } from '@0xx0lostcause0xx0/polypack'

const graph = new PolyGraph()

// Add nodes with vectors
graph.addNode({
  id: 'doc_1',
  type: 'document',
  data: { title: 'Quantum Computing' },
  vector: new Float64Array([0.95, 0.20, 0.10]),
  insertedAt: Date.now(),
  updatedAt: Date.now(),
})

// Or generate vectors from text with the default model-free provider
await graph.addNodeWithEmbedding({
  id: 'doc-2',
  type: 'document',
  data: { title: 'Graph search' },
  insertedAt: Date.now(),
  updatedAt: Date.now(),
}, 'Property graphs with vector similarity search')

const textMatches = await graph.queryText('semantic graph search', 0.1, 10)
textMatches.toArray()

// Query the complete persisted store without warming the hot cache
const recentPosts = await graph.queryPersisted()
  .whereNodeType('document')
  .orderBy('updatedAt', 'desc')
  .limit(20)
  .toArray()

// Search by similarity
graph.query()
  .whereNodeType('document')
  .similarTo([0.90, 0.30, 0.10], 0.5, 5)
  .toArray()

// Traverse edges
graph.query()
  .where('title', 'Quantum Computing')
  .traverse('REFERENCES', 3, 'out')
  .toArray()

// Aggregate
graph.query()
  .whereNodeType('book')
  .aggregate('price', 'avg')

// Group by vector cluster
graph.query()
  .whereNodeType('product')
  .groupByVector(
    [{ key: 'electronics', centroid: [0.9, 0.1] }],
    'price', 'avg', 0.4,
  )

Packages

Subpath Contents
@0xx0lostcause0xx0/polypack Core: PolyGraph, VectorIndex, GraphQuery, PersistedGraphQuery, MemoryAdapter
@0xx0lostcause0xx0/polypack/persistence Platform-neutral persistence: adapters, FileIO types
@0xx0lostcause0xx0/polypack/persistence/node BinaryStoreAdapter + NodeFileIO for the filesystem
@0xx0lostcause0xx0/polypack/persistence/opfs BinaryStoreAdapter + OPFSFileIO for the browser
@0xx0lostcause0xx0/polypack/react React hooks: useGraphQuery, useLiveQuery, useWorkingMemory
@0xx0lostcause0xx0/polypack/activation Adaptive memory: ActivationEngine (inhibition, per-context activation, budgeted/diverse workingMemory, learned weights via recordFeedback), mergeActivation, activation config types
@0xx0lostcause0xx0/polypack/sync Sync layer: OpLog, SyncAdapter, SyncClient, SyncServer
@0xx0lostcause0xx0/polypack-native Separate package: NAPI-RS bindings for native VectorIndex/HNSWIndex over the Rust core
polypack-db (PyPI) Separate package: PyO3/maturin bindings exposing PolyGraph, GraphQuery, PersistedGraphQuery, and vector indexes to Python — see python/README.md
polypack-core (crates.io) Separate package: the portable Rust core (property graph, vector search, persistence) shared by the TypeScript native addon and the Python bindings

See the complete API reference, including persistence, React, sync, lifecycle, ownership, and error contracts.

The Python binding has a separate, idiomatic API with snake_case method names. See the Python API guide for PolyGraph, hot-cache GraphQuery, native storage-level query_persisted(), vector indexes, and binding-specific behavior.

Requirements

  • Node.js 18 or newer when used in Node.js.
  • A browser with the File System Access API (OPFS) when using @0xx0lostcause0xx0/polypack/persistence/opfs.
  • Equal vector dimensions for similarity operations; mismatches throw RangeError.

Polypack is distributed as native ES modules.

Contributing and security

See CONTRIBUTING.md for development instructions. Please report vulnerabilities according to SECURITY.md.

License

MIT

About

Generic property graph engine with vector similarity search — extracted from scrollstr's PolyGraph

Topics

Resources

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages