@periodic/vanadium 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+
+All notable changes to `@periodic/vanadium` will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+
+## [1.0.0] — 2024-12-01
+
+### Added
+
+- **Idempotency Engine** (`createIdempotency`) — deterministic exactly-once execution
+- **Distributed Lock Engine** (`createLock`) — exclusive key-level locking with TTL
+- **Memory Adapter** (`createMemoryAdapter`) — built-in, zero-dependency storage with LRU eviction
+- **Redis Adapter** (`createRedisAdapter`) — atomic Lua-script-based adapter for Redis >= 4.x
+- **PostgreSQL Adapter** (`createPostgresAdapter`) — transactionally correct adapter for pg >= 8.x
+- **MongoDB Adapter** (`createMongoAdapter`) — atomic findOneAndUpdate adapter for mongodb >= 5.x
+- **Mongoose Adapter** (`createMongooseAdapter`) — Mongoose ORM wrapper preserving identical semantics
+- **Prisma Adapter** (`createPrismaAdapter`) — Prisma Client wrapper for @prisma/client >= 5.x
+- **Circuit Breaker** (`createCircuitBreaker`) — CLOSED/OPEN/HALF_OPEN protection for storage layer
+- **Cleanup Engine** (`createCleanupEngine`) — optional background stale record cleanup
+- **Express Middleware** (`vanadiumMiddleware`) — HTTP idempotency via `Idempotency-Key` header
+- **Fastify Plugin** (`vanadiumFastifyPlugin`) — Fastify integration
+- **OpenTelemetry Metrics** (`createVanadiumMetrics`) — graceful no-op unless OTel configured
+- **Structured Error System** (`VanadiumError`) — typed errors with `type`, `key`, `adapterName`, `timestamp`
+- **State Machine** (`assertValidTransition`) — compile-time + runtime transition enforcement
+- **Payload Hash Protection** — SHA-256 payload fingerprinting with PAYLOAD_MISMATCH detection
+- **Lifecycle Hooks** — `onBeforeExecute`, `onAfterExecute`, `onDuplicateHit`, `onTakeover`, `onStorageError`
+- **Metrics** — `getMetrics()` returns deterministic execution statistics
+- **Crash Recovery** — expired IN_PROGRESS records safely taken over by new nodes
+- **Concurrency Guard** — local in-process deduplication layer (optimization over adapter)
+- Full TypeScript strict mode — zero `any`, full generics, exact optional properties
+- ESM + CJS dual builds with tree-shakable exports
+- 90%+ test coverage target with Jest
+- GitHub Actions CI across Node 18 / 20 / 22

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Uday Thakur
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.