Files
suaveplan/packages/persistence/README.md
2026-05-27 23:47:53 +01:00

5.5 KiB

persistence

Caching, database adapters, search engines, and storage abstractions.

Subcategories

4 subcategories, 23 packages.

cache

Caching abstractions, memory caches, and Redis backends.

Package Description
@suaveplan/cache Type-safe caching abstraction for Suaveplan. Provides MemoryCache with LRU/LFU/FIFO/TTL eviction, NamespacedCache for shared-storage isolation, a `CacheFac…
@suaveplan/cache-redis AbstractCache<T> backend over a minimal RedisLike interface — native SET ... EX, GET, DEL, EXISTS, TTL, SCAN. Reuses @suaveplan/cache-storage…
@suaveplan/cache-storage AbstractCache<T> backend that bridges any @suaveplan/storage AbstractStorage into a typed cache via a 32-byte fixed-width TTL header and pluggable `Codec…

database

Database adapters, migrations, seeding, and SQLite support.

Package Description
@suaveplan/db Universal relational database adapter interface for Suaveplan. Provides the DatabaseAdapter contract (extending DatabaseLike from @suaveplan/types), inje…
@suaveplan/db-sqlite Universal SQLite adapter for Suaveplan. Runs on bun:sqlite on the Bun server and @sqlite.org/sqlite-wasm (Web Worker) in the browser, unified behind a sing…
@suaveplan/migration Database-agnostic schema migration runner with ledger tracking, checksum validation, dry-run reporting, distributed locking, event bus integration, and OTel in…
@suaveplan/seed Universal declarative database seeding and fixture framework. Define seed data once, let the runner handle dependency ordering, environment filtering, ide…
@suaveplan/surrealdb Universal SurrealDB client wrapper for Suaveplan. Implements @suaveplan/db's DatabaseAdapter interface with connection lifecycle management, typed CRUD, sc…

Full-text search, BM25, fuzzy matching, and faceted search.

Package Description
@suaveplan/search Full-text and fuzzy search primitives with in-memory BM25 engine, trigram fuzzy matching, faceted search, and pagination support.

storage

Storage abstractions, browser backends, S3, CDN, and URI routing.

Package Description
@suaveplan/storage Enterprise key-value storage abstractions for Suaveplan. Provides AbstractStorage (implementing StorageLike), MemoryStorage with TTL and zero-copy stream…
@suaveplan/storage-browser-indexeddb Browser-tier AbstractStorage adapter backed by the W3C IndexedDB API (globalThis.indexedDB). Provides persistent, origin-scoped key-value storage for brows…
@suaveplan/storage-browser-localstorage Browser-tier AbstractStorage adapter backed by the synchronous Storage API (globalThis.localStorage). Provides namespaced, origin-scoped key-value storag…
@suaveplan/storage-browser-opfs Browser-tier AbstractStorage adapter backed by the Origin Private File System (OPFS). Provides persistent, origin-scoped key-value storage for browser consum…
@suaveplan/storage-cdn Types-only foundation for CDN-flavoured @suaveplan/storage adapters. Declares CdnAdapter (an abstract base class extending AbstractStorage with purge,…
@suaveplan/storage-cdn-bunnycdn BunnyCDN Storage Zone + Pull Zone provider for @suaveplan/storage-cdn. Full AbstractStorage and CdnAdapter surface — get/set/delete/exists/`getMe…
@suaveplan/storage-cdn-rackspace Rackspace Cloud Files (OpenStack Swift) origin + Rackspace CDN provider for @suaveplan/storage-cdn. Full AbstractStorage and CdnAdapter surface — get/`…
@suaveplan/storage-file Node.js filesystem AbstractStorage adapter for @suaveplan/storage. Implements atomic writes via temp-file-then-rename, AbortSignal threaded through every a…
@suaveplan/storage-http Universal HTTP/CDN-backed AbstractStorage adapter for @suaveplan/storage. Reads via GET/HEAD/Range against any <baseUrl><key> origin, with optional…
@suaveplan/storage-plugin-cache Read-through cache decorator for AbstractStorage. Wraps any @suaveplan/storage instance with an injectable AbstractCache<Uint8Array>; hit/miss/populate o…
@suaveplan/storage-s3 S3-compatible object storage adapter for @suaveplan/storage. Extends AbstractStorage backed by @aws-sdk/client-s3 with presigned URL generation, multipar…
@suaveplan/storage-uri Universal URI-routed dispatch over @suaveplan StorageLike adapters.
@suaveplan/storage-uri-plugin-bundle Per-package bundle:// URI scheme for @suaveplan/storage-uri.
@suaveplan/storage-uri-plugin-fallback Universal fallback:// URI plugin for @suaveplan/storage-uri. Ships ordered multi-source resolution with cycle detection, depth cap, mirror writes, list uni…