@dcsv-io/d2-caching-abstractions 0.1.1

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright (c) DCSV
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,263 @@
+<!--
+Copyright (c) DCSV. Licensed under the Apache License, Version 2.0.
+-->
+
+# @dcsv-io/d2-caching-abstractions
+
+> Parent: [`../README.md`](../README.md) · .NET mirror: `DcsvIo.D2.Caching.Abstractions`
+
+Node/BFF authors inject these cache **ports** without pulling Redis, logging, or DI
+wiring into domain-safe code. The package is the TypeScript twin of
+`DcsvIo.D2.Caching.Abstractions`: marker interfaces (`ILocalCache` /
+`IDistributedCache` / `ITieredCache`), fine-grained building blocks
+(`ICacheBasic` / `ICacheAtomic` / `ICacheBroadcast` / `ICacheSet`), plus
+`ICacheInvalidationBackplane`, `ICacheSerializer`, `InputFailures`, and
+`LocalCacheOptions` / `LOCAL_CACHE_DEFAULTS`. Every op returns
+`Promise<D2Result<…>>` / `D2Result<…>` via `@dcsv-io/d2-result`. **No implementations**
+ship here — only contracts and pure helpers.
+
+## Public surface — building blocks
+
+Fine-grained interfaces. Implementations declare which they support; marker
+interfaces compose them. Method names are camelCase (drop .NET `Async` suffix);
+cancellation is optional `signal?: AbortSignal`; durations are milliseconds
+(`expirationMs`, `defaultExpirationMs`, remaining TTL from `getTtl`).
+
+- **`ICacheBasic`** — `get` / `getMany` / `exists` / `getTtl` / `set` /
+  `setMany` / `remove` / `removeMany`
+- **`ICacheAtomic`** — `setNx` / `increment` / `acquireLock` / `releaseLock`
+- **`ICacheBroadcast`** — `setAndBroadcast` / `setManyAndBroadcast` /
+  `removeAndBroadcast` / `removeManyAndBroadcast`
+- **`ICacheSet`** — `setAdd` / `setCardinality` / `setRemove` / `setContains`
+  (cluster-only — Redis SADD/SCARD/SREM/SISMEMBER)
+
+All operations return `D2Result` / `D2Result<T>` (async ops wrap in
+`Promise`). Multi-entry maps use `ReadonlyMap<string, T>` (callers may
+`new Map(Object.entries(record))`).
+
+Falsey inputs (missing key, missing keys collection, missing entries map)
+return `validationFailed` with an `InputError` naming the offending parameter
+(built via `InputFailures.required(...)`). Implementations never throw for
+**per-call** caller mistakes — every per-call failure shape is observable on
+the result. Construction-time / DI-registration errors are a different
+lifecycle concern and **do** surface as throws — see the `*AndBroadcast*`
+carve-out below.
+
+## Cache key convention + PII
+
+Cache keys follow the `EntityName:{id}` shape (`Session:{userId}`,
+`Jwks:{kid}`, `WhoIs:{ip}`, etc.) (`EntityName:{id}`).
+`LocalCacheOptions.keyPrefix` is a **namespace** prefix layered on top of that
+convention (handy when multiple caches share a process), not a substitute for
+it. **Keep PII out of keys** — keys leak into logs, traces, and store
+inspection. Hash any user-supplied identifier first.
+
+## Marker interfaces
+
+What consumers inject. The marker name documents the cache scope at the
+dependency site so the reader sees the parameter and immediately knows the
+behavioral profile, without checking registration.
+
+**`ILocalCache`** — composes `ICacheBasic` + `ICacheAtomic`.
+Per-process scope. Atomic ops at process scope. No broadcast (nothing outside
+this process can see local cache state). Use for instance-scoped data: per-
+instance fingerprint cache, per-instance counters, hot in-process lookups.
+
+**`IDistributedCache`** — composes `ICacheBasic` + `ICacheAtomic` +
+`ICacheBroadcast` + `ICacheSet`.
+Cluster scope. Atomic ops cluster-wide. Every read hits the remote store
+(no L1). Use when freshness matters more than read speed: rate-limit counters,
+distributed locks, ephemeral session lookups.
+
+**`ITieredCache`** — composes `ICacheBasic` + `ICacheAtomic` +
+`ICacheBroadcast`.
+Composed L1+L2. Reads check L1 first / fall through to L2 / populate L1.
+Writes go L2-first (L1 only if L2 succeeded). Atomic ops route through L2 with
+L1 invalidation as side effect. Use for read-heavy entity data where freshness
+within a few seconds is acceptable. **Does NOT compose `ICacheSet`** — set
+primitives are cluster-only and tiered composition would silently hide their
+cluster-wide nature. Callers needing SADD/SCARD inject `IDistributedCache`
+directly.
+
+**Shared blocks vs Set:** Basic + Atomic + Broadcast are method-identical on
+`IDistributedCache` and `ITieredCache`. **`ICacheSet` is only on
+`IDistributedCache`** (not full structural identity). The marker distinction
+is behavioral — DI registration determines the concrete implementation; the
+parameter type at the call site tells the reader whether they consume
+"single-tier remote" or "two-tier composed."
+
+## Supporting types
+
+**`LocalCacheOptions`** / **`LOCAL_CACHE_DEFAULTS`** / **`createLocalCacheOptions`**
+— `maxEntries` (100_000), `defaultExpirationMs` (3_600_000 / 1h),
+`keyPrefix` (`""`). Factory merges an optional partial over defaults and
+returns a fresh mutable object. No POCO validation (mirrors .NET).
+
+**`InputFailures`** — pre-built `validationFailed` factory
+(`required(paramName)` / `required<T>(paramName)`) used by impls so the
+cache surface stays errors-as-values rather than throws for per-call caller
+mistakes. Constructors / DI registration still throw — registration-time
+concern, not per-call input.
+
+**`ICacheSerializer`** — pluggable serialization for distributed caches.
+`contentType: string` (free string, e.g. `"application/json"`);
+`serialize` / `deserialize` with `Uint8Array`. This package owns the port only; a default JSON implementation is part of the
+`@dcsv-io/d2-caching-distributed-redis` package surface. Local
+caches store objects directly and do not need this. Impls use `COULD_NOT_BE_SERIALIZED` /
+`COULD_NOT_BE_DESERIALIZED` failure codes.
+
+**`ICacheInvalidationBackplane`** — optional pub/sub backplane for
+cross-instance L1 invalidation (`AsyncDisposable`). Tiered consumers
+subscribe at construction; `*AndBroadcast*` writes publish on every send.
+Provider-agnostic — swappable for Redis pub/sub, Postgres LISTEN/NOTIFY,
+in-process for tests.
+
+## Result mapping
+
+| Op family | Success / partial | Failure / notes |
+| --- | --- | --- |
+| `get` | hit → `ok(value)` | miss → `notFound`; store down → `serviceUnavailable` |
+| `getMany` | all → `ok(map)`; some → `someFound(partial)` | none → `notFound` |
+| `exists` | `ok(true\|false)` | store down → fail |
+| `getTtl` | remaining ms → `ok(number)`; no expiry → `ok(undefined)` | absent → `notFound` |
+| `set` / `setMany` | `ok` | store down → fail |
+| `remove` / `removeMany` | `ok` (**idempotent**) | store down → fail |
+| `setNx` | wrote → `ok(true)`; exists → `ok(false)` | store down → fail |
+| `increment` | `ok(newValue)`; **TTL applied only on key create; subsequent ops preserve TTL** | type mismatch → `conflict`; store down → fail |
+| `acquireLock` | acquired → `ok(true)`; held → `ok(false)` | **requires** `expirationMs`; store down → fail |
+| `releaseLock` | `ok` (**idempotent** — no-op if not held) | store down → fail |
+| `*AndBroadcast*` | same as plain counterparts | **throws** if no backplane registered (registration error, not D2Result) |
+| `setAdd` | new → `ok(true)`; present → `ok(false)`; **TTL only on set create** | store down → fail |
+| `setCardinality` | `ok(count)`; absent → `ok(0)` | store down → fail |
+| `setRemove` | removed → `ok(true)`; absent → `ok(false)` (**idempotent**) | store down → fail |
+| `setContains` | `ok(true\|false)` | store down → fail |
+| `publishInvalidation` / `Many` | `ok` | backplane error → fail |
+| bad input (falsey key, etc.) | — | `validationFailed` via `InputFailures` (impl duty; ports document) |
+
+**Counter width:** `number` (not `bigint`) is the intentional TS ergonomic
+delta vs .NET `long`. Stay within `Number.MAX_SAFE_INTEGER`.
+
+## Broadcast variants — when to use
+
+The `*AndBroadcast*` methods write/remove AND publish an invalidation message.
+Other instances' tiered caches subscribe to the backplane and drop their L1
+copies on receipt — keeping cluster L1 caches in sync without polling.
+
+**Use the broadcast variant when:**
+
+- The data is shared across instances (user profile, org settings, JWKS).
+- A user-initiated remove must be visible cluster-wide quickly.
+- Coordinated state changes that depend on every instance seeing the new state.
+
+**Use the plain (non-broadcast) variant when:**
+
+- Cache-warming / startup seed.
+- Single-writer-single-reader keys (derived from this instance's process ID).
+- Hot-path writes where the broadcast cost dominates (counter ticks).
+- Refresh writes of effectively-the-same data.
+- Single-instance deployments (don't register a backplane).
+- Short-TTL data where staleness is naturally bounded.
+
+## Invalidation backplane
+
+`ICacheInvalidationBackplane` powers `*AndBroadcast*` writes and any other
+"tell every instance to drop K from its L1" flow.
+
+### Everyone acts
+
+Every subscriber receives every message — **including messages this instance
+itself published**. There is no sender-ID filter. The cost of self-receive is
+bounded (tiered next-read re-fetch from L2, or a no-op remove).
+
+### Dispose unsubscribes / stops further delivery
+
+`subscribe(handler)` returns an `AsyncDisposable`. Disposing a subscription
+**removes that handler from fan-out** and **stops further invalidation key
+delivery** to it. The handler's `AbortSignal` is aborted on dispose
+(accompanies unsubscribe; does not replace it). One handler throw must not
+break delivery to other handlers. Each `subscribe` is independent. Dispose is
+idempotent. Disposing the backplane tears down shared provider resources,
+unsubscribes remaining handlers, and cancels in-flight handler work.
+
+### At-most-once delivery
+
+Missed message → next read hits L2. Acceptable for cache invalidation.
+
+```ts
+const subscription = backplane.subscribe(async (key, signal) => {
+  // Drop L1 entry for `key`. signal aborts when subscription is disposed.
+  await dropLocal(key, signal);
+});
+
+// Later:
+await subscription[Symbol.asyncDispose]();
+```
+
+## Atomic on tiered — how it works
+
+`ITieredCache` exposes the same atomic surface as `IDistributedCache` because
+the atomicity guarantee comes from L2 (the cluster source of truth). Pattern:
+
+- **`increment`** → L2 atomic increment; on success invalidate L1 + broadcast.
+- **`setNx`** → L2 SetNx; on success write L1 + broadcast; on fail invalidate L1.
+- **`acquireLock` / `releaseLock`** → pure delegation to L2 (lock state is
+  coordination, not a cached value).
+
+L1 is never authoritative for atomic state. L2 is. L1 just reflects (or
+invalidates). Concrete behavior lands in `@dcsv-io/d2-caching-tiered`.
+
+## Configuration carve-out
+
+There is **no** shared `DistributedCacheOptions` in abstractions. Provider-
+specific options (Redis connection string, Sentinel topology, channel name
+for pub/sub, retry config, etc.) live on the implementation package's own
+options class. The few common fields (`defaultExpirationMs`, `keyPrefix`) are
+easier to redeclare per-impl than to inherit. Same for tiered: the tiered
+package declares its own options when there is a real knob to expose.
+
+The invalidation channel constant (`d2:cache:invalidations`) lives on the
+Redis package options — abstractions own the **interface only**.
+
+## Usage
+
+Inject markers at composition roots; this package registers nothing.
+
+```ts
+import type { ILocalCache, IDistributedCache, ITieredCache } from "@dcsv-io/d2-caching-abstractions";
+import { InputFailures, createLocalCacheOptions } from "@dcsv-io/d2-caching-abstractions";
+
+// Domain / handler code depends only on the marker:
+async function loadProfile(cache: ITieredCache, userId: string) {
+  return cache.get<Profile>(`Profile:${userId}`);
+}
+
+// Impls use InputFailures for per-call validation:
+function guardKey(key: string) {
+  if (!key) return InputFailures.required("key");
+  return undefined;
+}
+
+const localOpts = createLocalCacheOptions({ keyPrefix: "jwks:" });
+```
+
+## Telemetry
+
+**N/A in this package** — abstractions are hook-free. Metrics live in
+**local-default + redis** implementations; **tiered owns structured logs
+(not meters)**.
+
+## Dependencies
+
+- `@dcsv-io/d2-result` — every op returns `D2Result` / `D2Result<T>`
+- `@dcsv-io/d2-i18n-keys` — `TK.common.errors.NOT_NULL_VIOLATION` for `InputFailures`
+
+No runtime deps beyond those (no DI, no logging, no provider libs). This
+abstraction stays domain-safe so any handler can declare a cache dependency
+without dragging in implementation runtime.
+
+## References
+
+- [`local-default/README.md`](../local-default/README.md) — local in-process impl
+- [`distributed-redis/README.md`](../distributed-redis/README.md) — Redis + backplane
+- [`tiered/README.md`](../tiered/README.md) — L1+L2 composition
+- .NET twin: `packages/dotnet/caching/abstractions/`

package/dist/i-cache-atomic.d.ts

@@ -0,0 +1,69 @@
+import type { D2Result } from "@dcsv-io/d2-result";
+/**
+ * Atomic primitives — set-if-absent, increment, lock acquire/release.
+ * Implemented by every cache flavor ({@link ILocalCache},
+ * {@link IDistributedCache}, {@link ITieredCache}); the atomicity
+ * scope depends on the implementing cache.
+ *
+ * **Scope per marker:**
+ * - {@link ILocalCache}: per-process. Atomicity guaranteed within this
+ *   instance only.
+ * - {@link IDistributedCache}: cluster-wide. Atomicity enforced by the
+ *   remote store (e.g. Redis SETNX / INCR).
+ * - {@link ITieredCache}: cluster-wide. Routes through L2 (the source
+ *   of truth); L1 is invalidated or refreshed as a side effect.
+ *
+ * Callers pick the scope by injecting the appropriate marker interface.
+ * The same atomic op called via `ILocalCache` coordinates within one
+ * process; via `IDistributedCache` or `ITieredCache` it coordinates
+ * across the cluster.
+ *
+ * **Counter width:** `number` (not `bigint`) is an intentional TS
+ * ergonomic delta vs .NET `long`. Implementations must stay within
+ * `Number.MAX_SAFE_INTEGER`.
+ */
+export interface ICacheAtomic {
+    /**
+     * Sets a value only if the key is not already present (atomic).
+     *
+     * @returns `ok(true)` if the value was written. `ok(false)` if the
+     *   key already existed (no write). Failure on backing-store error.
+     */
+    setNx<T>(key: string, value: T, expirationMs?: number, signal?: AbortSignal): Promise<D2Result<boolean>>;
+    /**
+     * Atomically increments a numeric counter and returns the new value.
+     * Creates the key if absent (initial value = 0 + amount).
+     *
+     * **TTL-on-create-only:** the optional `expirationMs` is applied
+     * **only when the key is created**; subsequent increments on an
+     * existing key **preserve the existing TTL**.
+     *
+     * @param amount - Amount to add (may be negative). Default `1`.
+     * @returns `ok(newValue)` on success. `conflict` if the existing key
+     *   holds a non-numeric value (Redis WRONGTYPE parity). Failure on
+     *   backing-store error.
+     */
+    increment(key: string, amount?: number, expirationMs?: number, signal?: AbortSignal): Promise<D2Result<number>>;
+    /**
+     * Attempts to acquire a lock on the given key. The caller-supplied
+     * `lockId` identifies the holder and is required for release. Locks
+     * expire automatically after `expirationMs` to prevent indefinite
+     * hold by a crashed process.
+     *
+     * @param expirationMs - **Required** lock TTL in milliseconds —
+     *   locks must auto-expire (matches .NET `TimeSpan expiration` with
+     *   no default).
+     * @returns `ok(true)` on acquisition. `ok(false)` if the lock is
+     *   held by someone else. Failure on backing-store error.
+     */
+    acquireLock(key: string, lockId: string, expirationMs: number, signal?: AbortSignal): Promise<D2Result<boolean>>;
+    /**
+     * Releases a lock previously acquired with {@link acquireLock}.
+     * Releasing a lock you don't hold (or one that's already expired) is
+     * a no-op rather than an error — release is **idempotent**.
+     *
+     * @returns `ok`; failure on backing-store error.
+     */
+    releaseLock(key: string, lockId: string, signal?: AbortSignal): Promise<D2Result>;
+}
+//# sourceMappingURL=i-cache-atomic.d.ts.map

package/dist/i-cache-atomic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-cache-atomic.d.ts","sourceRoot":"","sources":["../src/i-cache-atomic.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;OAKG;IACH,KAAK,CAAC,CAAC,EACL,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,CAAC,EACR,YAAY,CAAC,EAAE,MAAM,EACrB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IAE9B;;;;;;;;;;;;OAYG;IACH,SAAS,CACP,GAAG,EAAE,MAAM,EACX,MAAM,CAAC,EAAE,MAAM,EACf,YAAY,CAAC,EAAE,MAAM,EACrB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IAE7B;;;;;;;;;;;OAWG;IACH,WAAW,CACT,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IAE9B;;;;;;OAMG;IACH,WAAW,CACT,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,QAAQ,CAAC,CAAC;CACtB"}

package/dist/i-cache-atomic.js

@@ -0,0 +1,5 @@
+// -----------------------------------------------------------------------
+// Copyright (c) DCSV. Licensed under the Apache License, Version 2.0.
+// -----------------------------------------------------------------------
+export {};
+//# sourceMappingURL=i-cache-atomic.js.map

package/dist/i-cache-atomic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-cache-atomic.js","sourceRoot":"","sources":["../src/i-cache-atomic.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,sEAAsE;AACtE,0EAA0E"}

package/dist/i-cache-basic.d.ts

@@ -0,0 +1,90 @@
+import type { D2Result } from "@dcsv-io/d2-result";
+/**
+ * Core read + write surface common to every cache flavor (local,
+ * distributed, tiered). Every method returns `D2Result` / `D2Result<T>`.
+ * Cache misses surface as `notFound`; partial bulk hits as `someFound`
+ * (callers discriminate via `success` / `isPartialSuccess` / `errorCode`).
+ * Generic infrastructure failures (couldn't reach the backing store,
+ * serializer threw, etc.) surface as `serviceUnavailable` /
+ * `unhandledException`.
+ *
+ * Falsey inputs (missing key, missing keys collection, missing entries
+ * map) return `validationFailed` with an `InputError` naming the
+ * offending parameter (built via `InputFailures.required(...)`).
+ * Implementations never throw for **per-call** caller mistakes —
+ * every per-call failure shape is observable on the result.
+ *
+ * **Behavior per marker:**
+ * - {@link ILocalCache}: in-process reads/writes. Sub-microsecond per op.
+ * - {@link IDistributedCache}: every read and write hits the remote store.
+ *   No L1 buffer. Predictable freshness, network-bound latency.
+ * - {@link ITieredCache}: reads check L1 first / fall through to L2 /
+ *   populate L1. Writes go L2-first — L1 only writes if L2 succeeded —
+ *   so partial-write states are impossible and the result is binary
+ *   (success or the L2 failure bubbled up).
+ *
+ * **PII:** keep PII out of cache **keys** — keys leak into logs, traces,
+ * and store inspection tooling. Hash user-supplied identifiers first.
+ */
+export interface ICacheBasic {
+    /**
+     * Reads a single value by key.
+     *
+     * @returns `ok(value)` on hit, `notFound` on miss, failure on
+     *   backing-store error.
+     */
+    get<T>(key: string, signal?: AbortSignal): Promise<D2Result<T>>;
+    /**
+     * Reads many keys in one round-trip.
+     *
+     * @returns `ok(map)` when every key hit, `someFound(partial)` when
+     *   some hit and some missed, `notFound` when none hit, or a failure
+     *   on backing-store error. Callers may build the input via
+     *   `new Map(Object.entries(record))` when they hold a record.
+     */
+    getMany<T>(keys: readonly string[], signal?: AbortSignal): Promise<D2Result<ReadonlyMap<string, T>>>;
+    /**
+     * Returns whether a key is currently present.
+     *
+     * @returns `ok(true|false)`; failure on backing-store error.
+     */
+    exists(key: string, signal?: AbortSignal): Promise<D2Result<boolean>>;
+    /**
+     * Returns the remaining TTL for a key in milliseconds.
+     *
+     * @returns `notFound` if the key is absent. `ok(undefined)` if the key
+     *   exists with no expiration set. `ok(ms)` with the remaining time
+     *   when expiration is set. Failure on backing-store error.
+     */
+    getTtl(key: string, signal?: AbortSignal): Promise<D2Result<number | undefined>>;
+    /**
+     * Writes (or overwrites) a value.
+     *
+     * @param expirationMs - Optional TTL in milliseconds; omitted means
+     *   use the cache's default.
+     * @returns `ok` on success; failure on backing-store error.
+     */
+    set<T>(key: string, value: T, expirationMs?: number, signal?: AbortSignal): Promise<D2Result>;
+    /**
+     * Writes many entries in one round-trip.
+     *
+     * @param entries - Key/value pairs to store (`ReadonlyMap`).
+     * @param expirationMs - Optional TTL applied to every entry.
+     * @returns `ok` on success; failure on backing-store error.
+     */
+    setMany<T>(entries: ReadonlyMap<string, T>, expirationMs?: number, signal?: AbortSignal): Promise<D2Result>;
+    /**
+     * Removes a key. **Idempotent** — succeeds whether the key existed
+     * or not.
+     *
+     * @returns `ok`; failure on backing-store error.
+     */
+    remove(key: string, signal?: AbortSignal): Promise<D2Result>;
+    /**
+     * Removes many keys. **Idempotent**.
+     *
+     * @returns `ok`; failure on backing-store error.
+     */
+    removeMany(keys: readonly string[], signal?: AbortSignal): Promise<D2Result>;
+}
+//# sourceMappingURL=i-cache-basic.d.ts.map

package/dist/i-cache-basic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-cache-basic.d.ts","sourceRoot":"","sources":["../src/i-cache-basic.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;;OAKG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhE;;;;;;;OAOG;IACH,OAAO,CAAC,CAAC,EACP,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAE7C;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IAEtE;;;;;;OAMG;IACH,MAAM,CACJ,GAAG,EAAE,MAAM,EACX,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;IAEzC;;;;;;OAMG;IACH,GAAG,CAAC,CAAC,EACH,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,CAAC,EACR,YAAY,CAAC,EAAE,MAAM,EACrB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,QAAQ,CAAC,CAAC;IAErB;;;;;;OAMG;IACH,OAAO,CAAC,CAAC,EACP,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,EAC/B,YAAY,CAAC,EAAE,MAAM,EACrB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,QAAQ,CAAC,CAAC;IAErB;;;;;OAKG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE7D;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC9E"}

package/dist/i-cache-basic.js

@@ -0,0 +1,5 @@
+// -----------------------------------------------------------------------
+// Copyright (c) DCSV. Licensed under the Apache License, Version 2.0.
+// -----------------------------------------------------------------------
+export {};
+//# sourceMappingURL=i-cache-basic.js.map

package/dist/i-cache-basic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-cache-basic.js","sourceRoot":"","sources":["../src/i-cache-basic.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,sEAAsE;AACtE,0EAA0E"}