skills/plugins/document-navigator/docs/foundation

foundation

Foundational primitives — types, errors, configuration, data structures, and cross-cutting utilities.

Subcategories

9 subcategories, 62 packages.

barcode

1-D barcode generation and parsing.

Package	Description
@suaveplan/barcode	Runtime-agnostic 1D barcode generation for seven symbologies — Code 128B, Code 39, EAN-13, EAN-8, UPC-A, UPC-E, and ITF. Outputs inline SVG strings and binary…
@suaveplan/qrcode	QR code generation producing SVG, pixel matrix, terminal (Unicode blocks), and data URL representations. Implements QR code versions 1-10, error correction lev…

bitpacker

Bit-level binary packing, schemas, compression, and streaming codecs.

Package	Description
@suaveplan/bitpacker	Core bit-level binary packing library. Provides BitWriter, BitReader, BitPacker, and a pluggable strategy system for schema-driven serialization.
@suaveplan/bitpacker-compressed	Compression pipeline integration for bitpacker.
@suaveplan/bitpacker-crypto	Bit-packer-aware crypto primitives. The shared interfaces (Authority, DomainTag, AuthorityVerifier, AeadOps) live in @suaveplan/types; the canonical…
@suaveplan/bitpacker-delta	Delta encoding utilities for efficient repeated state transmission. Detects changes between successive values and encodes differences rather than full values.
@suaveplan/bitpacker-game	Game state utilities: quantization, prediction, interpolation, and client-server reconciliation.
@suaveplan/bitpacker-network	Network simulation utilities for testing bitpacker under realistic network conditions.
@suaveplan/bitpacker-schema	Schema registry and validation for bitpacker.
@suaveplan/bitpacker-strategies	Built-in packing strategies for @suaveplan/bitpacker. Provides strategies for numbers, strings, booleans, objects, arrays, enums, optional fields, oneOf unio…
@suaveplan/bitpacker-streaming	Streaming APIs for bitpacker including chunked packing/unpacking and true TransformStream support with framing.
@suaveplan/bitpacker-validation	Safety limits and validation reports for bitpacker schemas.

core

Core foundation — types, errors, configuration, schema registry, and utilities.

Package	Description
@suaveplan/config	Layered configuration management for Suaveplan. Resolves an ordered set of typed layers (defaults, file, object, env, CLI) in priority order, deep-merges the r…
@suaveplan/env	Type-safe, schema-first environment variable loading for Node.js and edge runtimes. Define a schema of typed field builders, point it at your sources, and rece…
@suaveplan/error	Foundation error substrate for Suaveplan. Every non-testing @suaveplan/* package extends this library's SuaveplanError base class and uses its stable code…
@suaveplan/schema-registry	Versioned schema registry with forward/backward/full compatibility checking for evolving data contracts. Register schemas by subject name, enforce evolution ru…
@suaveplan/types	Types-only foundation package. Zero runtime code, zero dependencies, zero bundle bytes. Provides the canonical shared interfaces that allow every `@suaveplan/*…
@suaveplan/typescript-config	Shared TypeScript configuration presets for Suaveplan. This package ships composable JSON presets consumed via "extends" across every workspace package — no…
@suaveplan/utils	Zero-external-dependency utility library for Suaveplan. Covers debug helpers, deep object manipulation, platform detection, IEEE 754 float packing, pseudo-rand…

data

Data manipulation, masking, deduplication, diffing, and byte utilities.

Package	Description
@suaveplan/bytes	Low-level byte utilities for Suaveplan: lossless hex/base64/UTF-8 encoding, Uint8Array manipulation, and UUID conversion. No native addons; depends only on p…
@suaveplan/clipboard	Enterprise Clipboard API abstraction for browser-tier consumers. Wraps the async Clipboard API with a textarea + execCommand fallback, a paste-event read fal…
@suaveplan/data-masking	PII/sensitive data masking for objects and strings with field-level rules, nested traversal, eight masking strategies, and OpenTelemetry instrumentation.
@suaveplan/dedup	Entity deduplication engine for detecting and merging duplicate records in any data set. Given a list of objects with varying representations of the same real-…
@suaveplan/diff	Zero-dependency RFC 6902 JSON Patch engine for computing, applying, and inverting structural differences between JSON documents. The diff(a, b) function prod…
@suaveplan/json	Safe, enterprise-grade JSON utilities with prototype-pollution protection, circular-reference detection, and OpenTelemetry instrumentation.
@suaveplan/media	Universal media detection, metadata extraction, and constraint validation. Combines a pluggable magic-byte SignatureRegistry with the MIME database from `@su…
@suaveplan/mime	Structured MIME-type detection, parsing, and registry for the Suaveplan platform. Provides RFC 7231 Content-Type parsing, magic-byte file signature detection,…
@suaveplan/packer	Binary packing/unpacking utilities. Two modes:
@suaveplan/packer-browser	Browser-tier runtime for @suaveplan/packer archives. Ships a Service Worker interceptor, a PackedResourceManager (LRU + Blob-URL bookkeeping + ref-count +…
@suaveplan/pagination	Universal pagination primitives for cursor-based, offset-based, and keyset-based (seek) pagination strategies. The package covers the full pagination surface:…
@suaveplan/pwa	Enterprise browser-tier PWA primitives for Suaveplan applications.
@suaveplan/react-packer	React 19 companion for @suaveplan/packer-browser. Ships usePackedResource, usePackedImage, usePackedAudio, usePackedVideo, and usePackedFont hooks…
@suaveplan/serialize	Round-trip-preserving structured serialization for JavaScript's rich type system. The standard JSON.stringify/JSON.parse pair silently drops Date objects…
@suaveplan/templates	A plugin-based string template engine for TypeScript. Resolves {variable} and {variable:transform} tokens in strings using a priority-sorted, regex-scan pi…
@suaveplan/validation	Runtime schema validation with a Zod-compatible API. This package is a self-contained parse engine — it does not import Zod or any other validation library — s…
@suaveplan/web-workers	Enterprise browser-tier runtime for managing Web Workers, SharedWorkers, and fixed-size worker pools with typed RPC, AbortSignal-aware cancellation, transfer-l…

etl

Extract-Transform-Load pipeline engine with typed stages.

Package	Description
@suaveplan/etl	Extract-Transform-Load pipeline engine with typed stages, error handling, observable progress, and OTel instrumentation.

feature-flags

Feature-flag evaluation engine with percentage and attribute targeting.

Package	Description
@suaveplan/feature-flags	Provider-agnostic feature flag evaluation engine for controlling feature rollout without code deploys. The package ships a FlagManager high-level façade, a `…

flow

Finite state machines, CRDTs, idempotency, and CBOR serialization.

Package	Description
@suaveplan/cbor	RFC 8949 (CBOR) encoder + decoder, RFC 8742 (CBOR Sequences), pull-style streaming decoder (AsyncIterable<Uint8Array> / ReadableStream<Uint8Array>), RFC 90…
@suaveplan/crdt	Conflict-free Replicated Data Types (CRDTs) for distributed systems. Provides eight composable CRDT primitives plus a vector-clock and a sync manager that coor…
@suaveplan/fsm	Typed, generic finite state machine (FSM) for TypeScript. Ships a synchronous-by-default interpreter with guard predicates, ordered transition actions, context…
@suaveplan/idempotency	Idempotency key guard and deduplication for async operations. The package provides a complete pending → completed | failed state machine, three store backend…
@suaveplan/job-scheduler	Universal in-process job scheduler with cron + queued runs, retries, timeouts, concurrency control, and OpenTelemetry observability. Built on @suaveplan/cron…
@suaveplan/queue	Enterprise-grade queue management: memory/priority/delayed queues, concurrent workers with retry and dead-letter forwarding, job state machines, and OTel instr…
@suaveplan/queue-distribution	Worker-pool distribution layer: load-balancing strategies, worker pool management, manager with retry and health checks, in-process LocalWorker. Transport-ag…
@suaveplan/queue-distribution-http	HTTP transport plugin for @suaveplan/queue-distribution. Ships HttpWorkerCommunicator (a fetch-backed WorkerCommunicator with a Zod-validated wire envelo…
@suaveplan/queue-distribution-worker-thread	Web-Worker / Node worker_threads transport plugin for @suaveplan/queue-distribution. Ships WorkerThreadCommunicator (a ThreadWorkerLike-based message b…
@suaveplan/rate-limiter	Enterprise rate limiter with three algorithms, rule-based routing, tenant multipliers, pluggable storage, and OTel instrumentation.
@suaveplan/retry	Retry strategies and circuit-breaker for async operations. The package provides constant, linear, and exponential backoff with four jitter modes (full, equal,…
@suaveplan/rules	Universal rule engine + validation system. Comprehensive RuleEngine with async evaluation, depth limit, AbortSignal, plugin registration; fluent `RuleBuilder…
@suaveplan/rules-hono	Hono middleware wrapping @suaveplan/rules. Six middleware factories — ruleMiddleware, validationMiddleware, accessControl, responseValidation, `rateL…
@suaveplan/streams	WHATWG-Streams-based primitives: backpressure-first transforms, zero-copy Uint8Array operations, AbortSignal integration end-to-end, structured errors, OTe…
@suaveplan/streams-chunk-queue	Universal out-of-order chunk reconstitution. Accepts chunks for a file in any order and exposes a sequential ReadableStream<Uint8Array> consumer surface, com…
@suaveplan/streams-metadata	Universal stream transforms that detect MIME type and extract EXIF/IPTC/XMP image metadata from buffered Uint8Array payloads. Three composable transforms (`M…
@suaveplan/undo	Enterprise-grade undo/redo engine with branching history, async commands, history compression, selective undo, and command merging. Built for collaborative edi…
@suaveplan/workflow	Workflow and pipeline orchestration: sequential and parallel step execution, conditional branching with guard functions, retry strategies, timeouts, saga-patte…

random

Pseudo-random generators, noise functions, and deterministic sequences.

Package	Description
@suaveplan/noise	Seeded spatial noise fields for procedural content generation. Provides six field types — Perlin, Simplex (2D/3D/4D), Value, Worley/cellular (F1/F2/F2-F1 modes…
@suaveplan/pseudo-random	Deterministic, seeded pseudo-random number generators (PRNGs) conforming to the Rng interface from @suaveplan/types. Ships four algorithms — Mulberry32, SF…
@suaveplan/random	High-level cryptographically secure randomness for application use. This is the everyday random package — it wraps the CSPRNG with ergonomic helpers for every…

timing

Cron, stopwatches, throttling, debouncing, and scheduling.

Package	Description
@suaveplan/cron	Universal cron expression parser, next-fire calculator with timezone + DST awareness, and an opt-in lightweight in-process scheduler. Zero external cron depend…
@suaveplan/datetime	Timezone-aware date/time utilities covering the most common application-layer date operations that the native Date API leaves unaddressed. The package provid…
@suaveplan/timing	Timing and scheduling utilities for application-layer time management. The package covers measurement (stopwatch with lap recording), rate control (throttle an…