@prisma/orm-extension-middleware-cache 0.16.0-dev.36

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2026] [Prisma Data, Inc]
+
+   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,23 @@
+# @prisma/orm-extension-middleware-cache
+
+Opt-in query caching for Prisma Next runtimes, for both the SQL and Mongo families.
+
+```bash
+pnpm add @prisma/orm-extension-middleware-cache
+```
+
+The whole surface is the package root:
+
+```ts
+import { cache, cacheAnnotation, type CacheStore } from '@prisma/orm-extension-middleware-cache';
+```
+
+## Responsibilities
+
+A runtime middleware that short-circuits repeated reads: on a hit it returns cached rows and never invokes the driver; on a miss it buffers the driver's rows and commits them to the store only when the execution completes successfully. Cache keys come from the family runtime's content hash of the execution, or from a per-query `cacheAnnotation({ key })` override; `ttl` and `skip` are per-query too. Connection- and transaction-scoped executions bypass the cache.
+
+It ships an in-memory LRU-with-TTL store and exposes the `CacheStore` interface so Redis, Memcached, or any other backend can be dropped in.
+
+## Dependencies
+
+`@prisma/orm-framework` at an exact lockstep version, and nothing else. It depends on no family runtime and no target, which is why one middleware serves every database.

package/dist/index.d.mts

@@ -0,0 +1,219 @@
+import { CrossFamilyMiddleware } from "@prisma/orm-framework/components/runtime";
+//#region ../../../3-extensions/middleware-cache/dist/index.d.mts
+//#region src/cache-annotation.d.ts
+/**
+ * Payload accepted when calling the `cacheAnnotation` handle.
+ *
+ * - `ttl` — Time-to-live for the cached entry, in milliseconds. When
+ *   omitted, the cache middleware passes the query through untouched —
+ *   presence of the annotation alone is not sufficient to enable caching.
+ *   This makes the cache strictly opt-in per query.
+ * - `skip` — When `true`, the cache middleware passes the query through
+ *   untouched even if a `ttl` is set. Useful for selectively bypassing
+ *   the cache on a per-call basis without removing the annotation
+ *   entirely (e.g. a "force refresh" knob in user code).
+ * - `key` — Per-query override of the cache key. When supplied, replaces
+ *   the default `RuntimeMiddlewareContext.contentHash(exec)` digest.
+ *   The supplied string is stored as-is — the cache middleware does
+ *   **not** rehash it, so the caller is responsible for ensuring the
+ *   string is bounded in size and free of sensitive data they do not
+ *   want flowing into logs / Redis `KEYS` / persistence dumps.
+ */
+interface CachePayload {
+  readonly ttl?: number;
+  readonly skip?: boolean;
+  readonly key?: string;
+}
+/**
+ * Read-only annotation handle for the cache middleware.
+ *
+ * Declared with `applicableTo: ['read']`. Write terminals supply
+ * `K = 'write'` to the type-level `ValidAnnotations<'write', As>` gate
+ * (and the runtime `assertAnnotationsApplicable(annotations, 'write', ...)`
+ * check); the join `K extends Kinds` fails for this annotation, making
+ * "cache a mutation" structurally impossible without an `as any` cast
+ * bypass at both type *and* runtime levels.
+ *
+ * Stored under namespace `'cache'` in `plan.meta.annotations`. The cache
+ * middleware reads it via `cacheAnnotation.read(plan)`.
+ *
+ * @example
+ * ```typescript
+ * import { cacheAnnotation } from '@internal/middleware-cache';
+ *
+ * // ORM read terminal — accepts the read-only annotation via the meta callback.
+ * const user = await db.User.first(
+ *   { id },
+ *   (meta) => meta.annotate(cacheAnnotation({ ttl: 60_000 })),
+ * );
+ *
+ * // SQL DSL select builder — chainable.
+ * const plan = db.sql
+ *   .from(tables.user)
+ *   .annotate(cacheAnnotation({ ttl: 60_000 }))
+ *   .select({ id: tables.user.columns.id })
+ *   .build();
+ * ```
+ */
+declare const cacheAnnotation: import("@prisma/orm-framework/components/runtime").AnnotationHandle<CachePayload, "read">;
+//#endregion
+//#region src/cache-store.d.ts
+/**
+ * A cached set of rows produced by a single execution.
+ *
+ * - `rows` are stored raw (undecoded). The SQL runtime's `decodeRow` pass
+ *   wraps the orchestrator output, so intercepted rows go through the
+ *   same codec decoding as driver rows on the way to the consumer. The
+ *   cache stores wire-format values; decoding happens once per consumer
+ *   read regardless of where the rows came from.
+ * - `storedAt` is the clock value at the moment the entry was committed
+ *   to the store. It is informational metadata for callers (debugging,
+ *   telemetry) and is **not** used by the in-memory store itself for
+ *   expiry — TTL is driven by the store's own clock plus the `ttlMs`
+ *   passed to `set`. Custom stores may use it differently.
+ */
+interface CachedEntry {
+  readonly rows: readonly Record<string, unknown>[];
+  readonly storedAt: number;
+}
+/**
+ * Pluggable cache backend used by the cache middleware.
+ *
+ * The default implementation is an in-memory LRU with TTL produced by
+ * `createInMemoryCacheStore`. Users can supply Redis, Memcached, or any
+ * other backend by implementing this interface.
+ *
+ * The interface is intentionally minimal:
+ *
+ * - `get` returns the entry if it exists and has not expired, or
+ *   `undefined` otherwise. Implementations that gate on TTL should
+ *   treat an expired entry as absent (return `undefined`) and may
+ *   evict it as a side effect.
+ * - `set` writes the entry under the key with an associated TTL in
+ *   milliseconds. Implementations may evict other entries to make
+ *   room (LRU, LFU, etc.) and may treat the operation as fire-and-
+ *   forget at scale; the cache middleware does not rely on `set`
+ *   completing before subsequent `get`s.
+ *
+ * Both methods are async to leave the door open for I/O-backed stores
+ * (Redis, S3, etc.). The default in-memory store completes
+ * synchronously and wraps the result in `Promise.resolve` for type
+ * conformance.
+ */
+interface CacheStore {
+  get(key: string): Promise<CachedEntry | undefined>;
+  set(key: string, entry: CachedEntry, ttlMs: number): Promise<void>;
+}
+/**
+ * Options accepted by `createInMemoryCacheStore`.
+ *
+ * - `maxEntries` — hard cap on the number of live entries. Once the cap
+ *   is exceeded, the least recently used entry is evicted. Reads and
+ *   writes both count as "uses" for ordering purposes.
+ * - `clock` — injectable time source for TTL math. Defaults to
+ *   `Date.now`. Tests inject a controlled clock to verify expiry without
+ *   real-time waits.
+ */
+interface InMemoryCacheStoreOptions {
+  readonly maxEntries: number;
+  readonly clock?: () => number;
+}
+/**
+ * Default cache backend. An LRU with per-entry TTL, backed by a `Map`.
+ *
+ * Eviction policy:
+ *
+ * - On `set` of a fresh key whose insertion would push the live count
+ *   above `maxEntries`, the least recently used entry is evicted.
+ *   Setting an existing key updates the entry in place and refreshes its
+ *   recency without changing the live count.
+ * - On `get` of an existing key, recency is bumped (so the entry is no
+ *   longer the LRU candidate).
+ * - On `get` of an expired entry, the entry is removed from the map and
+ *   `undefined` is returned. The slot becomes available for new writes
+ *   without counting against `maxEntries`.
+ *
+ * `Map` insertion order is the LRU order: the first key is the LRU
+ * candidate; the last key is the most recently used. Bumping recency is
+ * a delete-then-set on the underlying map.
+ *
+ * The default store is **not** coherent across processes or replicas —
+ * each process holds its own Map. Users who need a shared cache supply
+ * their own `CacheStore` (Redis, Memcached, etc.).
+ */
+declare function createInMemoryCacheStore(options: InMemoryCacheStoreOptions): CacheStore;
+//#endregion
+//#region src/cache-middleware.d.ts
+/**
+ * Options accepted by `createCacheMiddleware`.
+ *
+ * - `store` — pluggable cache backend. Defaults to an in-process LRU
+ *   produced by `createInMemoryCacheStore`. Users supply Redis,
+ *   Memcached, or any other backend by implementing the `CacheStore`
+ *   interface.
+ * - `maxEntries` — only consulted when `store` is omitted. Sets the
+ *   `maxEntries` cap on the default in-memory store. Defaults to 1000.
+ * - `clock` — injectable time source for `storedAt` stamping on
+ *   committed entries. Defaults to `Date.now`. Tests inject a controlled
+ *   clock to make commit-time observable. Note: TTL math lives inside
+ *   the store, not the middleware — supplying a clock here only affects
+ *   the `storedAt` field on committed `CachedEntry` values.
+ */
+interface CacheMiddlewareOptions {
+  readonly store?: CacheStore;
+  readonly maxEntries?: number;
+  readonly clock?: () => number;
+}
+/**
+ * Creates a family-agnostic caching middleware.
+ *
+ * The middleware uses three hooks:
+ *
+ * - `intercept` — on each execution, checks the cache. On a hit, returns
+ *   the cached raw rows; the runtime skips `runDriver` and `onRow`
+ *   (`beforeExecute` is not affected — it has already run for every
+ *   middleware before any `intercept` is consulted) and yields the
+ *   cached rows to the consumer (which, in the SQL runtime, sees them
+ *   after the standard `decodeRow` pass — i.e. the cache stores
+ *   wire-format values). On a miss, records a pending buffer keyed on
+ *   the `exec` object identity and returns `undefined` (passthrough).
+ * - `onRow` — on the miss path, appends each row yielded by the driver
+ *   to the pending buffer.
+ * - `afterExecute` — on the miss path, commits the buffer to the store
+ *   if and only if `result.completed === true && result.source === 'driver'`.
+ *   Failed executions and middleware-served executions never populate
+ *   the cache. The pending buffer is cleared in all branches so a stale
+ *   `WeakMap` entry cannot leak between executions sharing an `exec`.
+ *
+ * The middleware bypasses the cache entirely when:
+ * - the plan has no `cache` annotation, or
+ * - the annotation has `skip: true`, or
+ * - the annotation has no `ttl`, or
+ * - `ctx.scope !== 'runtime'` (connection / transaction scopes opt out).
+ *
+ * Returns a cross-family `RuntimeMiddleware` (no `familyId` /
+ * `targetId`). The package depends only on
+ * `@internal/framework-components/runtime`; cache keys come from
+ * `ctx.contentHash(exec)`, populated by the family runtime, so SQL and
+ * Mongo runtimes both work out of the box.
+ *
+ * @example
+ * ```typescript
+ * import { createCacheMiddleware, cacheAnnotation } from '@internal/middleware-cache';
+ *
+ * const db = postgres({
+ *   contractJson,
+ *   url: process.env['DATABASE_URL']!,
+ *   middleware: [createCacheMiddleware({ maxEntries: 1000 })],
+ * });
+ *
+ * const user = await db.User.first(
+ *   { id },
+ *   (meta) => meta.annotate(cacheAnnotation({ ttl: 60_000 })),
+ * );
+ * ```
+ */
+declare function createCacheMiddleware(options?: CacheMiddlewareOptions): CrossFamilyMiddleware;
+//#endregion
+export { type CacheMiddlewareOptions, type CachePayload, type CacheStore, type CachedEntry, type InMemoryCacheStoreOptions, cacheAnnotation, createCacheMiddleware, createInMemoryCacheStore };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../../../../3-extensions/middleware-cache/dist/index.d.mts"],"mappings":";;;;;;;;;;;;;;;;;;;;;UAoBU;WACC;WACA;WACA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAiCG,kEAAkE,iBAAiB;;;;;;;;;;;;;;;;;UAiBvF;WACC,eAAe;WACf;;;;;;;;;;;;;;;;;;;;;;;;;;UA0BD;EACR,IAAI,cAAc,QAAQ;EAC1B,IAAI,aAAa,OAAO,aAAa,gBAAgB;;;;;;;;;;;;UAY7C;WACC;WACA;;;;;;;;;;;;;;;;;;;;;;;;;iBAyBM,yBAAyB,SAAS,4BAA4B;;;;;;;;;;;;;;;;;;UAkBrE;WACC,QAAQ;WACR;WACA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmDM,sBAAsB,UAAU,yBAAyB"}

package/dist/index.mjs

@@ -0,0 +1,243 @@
+import { defineAnnotation } from "@prisma/orm-framework/components/runtime";
+//#region ../../../3-extensions/middleware-cache/dist/index.mjs
+/**
+* Read-only annotation handle for the cache middleware.
+*
+* Declared with `applicableTo: ['read']`. Write terminals supply
+* `K = 'write'` to the type-level `ValidAnnotations<'write', As>` gate
+* (and the runtime `assertAnnotationsApplicable(annotations, 'write', ...)`
+* check); the join `K extends Kinds` fails for this annotation, making
+* "cache a mutation" structurally impossible without an `as any` cast
+* bypass at both type *and* runtime levels.
+*
+* Stored under namespace `'cache'` in `plan.meta.annotations`. The cache
+* middleware reads it via `cacheAnnotation.read(plan)`.
+*
+* @example
+* ```typescript
+* import { cacheAnnotation } from '@internal/middleware-cache';
+*
+* // ORM read terminal — accepts the read-only annotation via the meta callback.
+* const user = await db.User.first(
+*   { id },
+*   (meta) => meta.annotate(cacheAnnotation({ ttl: 60_000 })),
+* );
+*
+* // SQL DSL select builder — chainable.
+* const plan = db.sql
+*   .from(tables.user)
+*   .annotate(cacheAnnotation({ ttl: 60_000 }))
+*   .select({ id: tables.user.columns.id })
+*   .build();
+* ```
+*/
+const cacheAnnotation = defineAnnotation()({
+	namespace: "cache",
+	applicableTo: ["read"]
+});
+/**
+* Default cache backend. An LRU with per-entry TTL, backed by a `Map`.
+*
+* Eviction policy:
+*
+* - On `set` of a fresh key whose insertion would push the live count
+*   above `maxEntries`, the least recently used entry is evicted.
+*   Setting an existing key updates the entry in place and refreshes its
+*   recency without changing the live count.
+* - On `get` of an existing key, recency is bumped (so the entry is no
+*   longer the LRU candidate).
+* - On `get` of an expired entry, the entry is removed from the map and
+*   `undefined` is returned. The slot becomes available for new writes
+*   without counting against `maxEntries`.
+*
+* `Map` insertion order is the LRU order: the first key is the LRU
+* candidate; the last key is the most recently used. Bumping recency is
+* a delete-then-set on the underlying map.
+*
+* The default store is **not** coherent across processes or replicas —
+* each process holds its own Map. Users who need a shared cache supply
+* their own `CacheStore` (Redis, Memcached, etc.).
+*/
+function createInMemoryCacheStore(options) {
+	const maxEntries = options.maxEntries;
+	const clock = options.clock ?? Date.now;
+	const map = /* @__PURE__ */ new Map();
+	function get(key) {
+		const record = map.get(key);
+		if (record === void 0) return Promise.resolve(void 0);
+		if (clock() >= record.expiresAt) {
+			map.delete(key);
+			return Promise.resolve(void 0);
+		}
+		map.delete(key);
+		map.set(key, record);
+		return Promise.resolve(record.entry);
+	}
+	function set(key, entry, ttlMs) {
+		const expiresAt = clock() + ttlMs;
+		if (map.has(key)) map.delete(key);
+		map.set(key, {
+			entry,
+			expiresAt
+		});
+		while (map.size > maxEntries) {
+			const oldest = map.keys().next();
+			if (oldest.done) break;
+			map.delete(oldest.value);
+		}
+		return Promise.resolve();
+	}
+	return {
+		get,
+		set
+	};
+}
+/**
+* Default `maxEntries` for the built-in in-memory store. Bounded so a
+* runaway producer cannot exhaust process memory; users who need
+* different bounds supply a custom `CacheStore`.
+*/
+const DEFAULT_MAX_ENTRIES = 1e3;
+/**
+* Reads the cache payload from the plan, if present and branded.
+*
+* Returns `undefined` when:
+* - the plan has no `meta.annotations`, or
+* - the `cache` namespace key is absent, or
+* - the value under `cache` is not a branded `AnnotationValue` (the
+*   `cacheAnnotation.read` defensive check covers this).
+*/
+function readCachePayload(plan) {
+	return cacheAnnotation.read(plan);
+}
+/**
+* Computes the cache key for an execution.
+*
+* Two-tier resolution:
+*
+* 1. Per-query override: `cacheAnnotation({ key })` — the supplied
+*    string is used verbatim. Not rehashed; the user is responsible for
+*    keeping the string bounded and free of sensitive data.
+* 2. Default: `ctx.contentHash(exec)` — the family runtime owns this and
+*    returns an opaque, bounded digest (SHA-512 in the SQL and Mongo
+*    runtimes today).
+*
+* The returned string is consumed directly as the `Map<string, …>` key
+* by the underlying `CacheStore`; the cache middleware does not perform
+* any further transformation.
+*/
+async function resolveCacheKey(payload, exec, ctx) {
+	if (payload.key !== void 0) return payload.key;
+	return ctx.contentHash(exec);
+}
+/**
+* Creates a family-agnostic caching middleware.
+*
+* The middleware uses three hooks:
+*
+* - `intercept` — on each execution, checks the cache. On a hit, returns
+*   the cached raw rows; the runtime skips `runDriver` and `onRow`
+*   (`beforeExecute` is not affected — it has already run for every
+*   middleware before any `intercept` is consulted) and yields the
+*   cached rows to the consumer (which, in the SQL runtime, sees them
+*   after the standard `decodeRow` pass — i.e. the cache stores
+*   wire-format values). On a miss, records a pending buffer keyed on
+*   the `exec` object identity and returns `undefined` (passthrough).
+* - `onRow` — on the miss path, appends each row yielded by the driver
+*   to the pending buffer.
+* - `afterExecute` — on the miss path, commits the buffer to the store
+*   if and only if `result.completed === true && result.source === 'driver'`.
+*   Failed executions and middleware-served executions never populate
+*   the cache. The pending buffer is cleared in all branches so a stale
+*   `WeakMap` entry cannot leak between executions sharing an `exec`.
+*
+* The middleware bypasses the cache entirely when:
+* - the plan has no `cache` annotation, or
+* - the annotation has `skip: true`, or
+* - the annotation has no `ttl`, or
+* - `ctx.scope !== 'runtime'` (connection / transaction scopes opt out).
+*
+* Returns a cross-family `RuntimeMiddleware` (no `familyId` /
+* `targetId`). The package depends only on
+* `@internal/framework-components/runtime`; cache keys come from
+* `ctx.contentHash(exec)`, populated by the family runtime, so SQL and
+* Mongo runtimes both work out of the box.
+*
+* @example
+* ```typescript
+* import { createCacheMiddleware, cacheAnnotation } from '@internal/middleware-cache';
+*
+* const db = postgres({
+*   contractJson,
+*   url: process.env['DATABASE_URL']!,
+*   middleware: [createCacheMiddleware({ maxEntries: 1000 })],
+* });
+*
+* const user = await db.User.first(
+*   { id },
+*   (meta) => meta.annotate(cacheAnnotation({ ttl: 60_000 })),
+* );
+* ```
+*/
+function createCacheMiddleware(options) {
+	const store = options?.store ?? createInMemoryCacheStore({ maxEntries: options?.maxEntries ?? DEFAULT_MAX_ENTRIES });
+	const clock = options?.clock ?? Date.now;
+	const pending = /* @__PURE__ */ new WeakMap();
+	async function intercept(exec, ctx) {
+		if (ctx.scope !== "runtime") return;
+		const payload = readCachePayload(exec);
+		if (payload === void 0) return;
+		if (payload.skip === true) return;
+		if (payload.ttl === void 0) return;
+		const key = await resolveCacheKey(payload, exec, ctx);
+		const hit = await store.get(key);
+		if (hit !== void 0) {
+			ctx.log.debug?.({
+				event: "middleware.cache.hit",
+				middleware: "cache",
+				key
+			});
+			return { rows: hit.rows };
+		}
+		pending.set(exec, {
+			key,
+			ttlMs: payload.ttl,
+			buffer: []
+		});
+		ctx.log.debug?.({
+			event: "middleware.cache.miss",
+			middleware: "cache",
+			key
+		});
+	}
+	async function onRow(row, exec, _ctx) {
+		const slot = pending.get(exec);
+		if (slot === void 0) return;
+		slot.buffer.push(row);
+	}
+	async function afterExecute(exec, result, ctx) {
+		const slot = pending.get(exec);
+		if (slot === void 0) return;
+		pending.delete(exec);
+		if (!result.completed || result.source !== "driver") return;
+		await store.set(slot.key, {
+			rows: slot.buffer,
+			storedAt: clock()
+		}, slot.ttlMs);
+		ctx.log.debug?.({
+			event: "middleware.cache.store",
+			middleware: "cache",
+			key: slot.key
+		});
+	}
+	return {
+		name: "cache",
+		intercept,
+		onRow,
+		afterExecute
+	};
+}
+//#endregion
+export { cacheAnnotation, createCacheMiddleware, createInMemoryCacheStore };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../../../../3-extensions/middleware-cache/dist/index.mjs"],"sourcesContent":["import { defineAnnotation } from \"@internal/framework-components/runtime\";\n//#region src/cache-annotation.ts\n/**\n* Read-only annotation handle for the cache middleware.\n*\n* Declared with `applicableTo: ['read']`. Write terminals supply\n* `K = 'write'` to the type-level `ValidAnnotations<'write', As>` gate\n* (and the runtime `assertAnnotationsApplicable(annotations, 'write', ...)`\n* check); the join `K extends Kinds` fails for this annotation, making\n* \"cache a mutation\" structurally impossible without an `as any` cast\n* bypass at both type *and* runtime levels.\n*\n* Stored under namespace `'cache'` in `plan.meta.annotations`. The cache\n* middleware reads it via `cacheAnnotation.read(plan)`.\n*\n* @example\n* ```typescript\n* import { cacheAnnotation } from '@internal/middleware-cache';\n*\n* // ORM read terminal — accepts the read-only annotation via the meta callback.\n* const user = await db.User.first(\n*   { id },\n*   (meta) => meta.annotate(cacheAnnotation({ ttl: 60_000 })),\n* );\n*\n* // SQL DSL select builder — chainable.\n* const plan = db.sql\n*   .from(tables.user)\n*   .annotate(cacheAnnotation({ ttl: 60_000 }))\n*   .select({ id: tables.user.columns.id })\n*   .build();\n* ```\n*/\nconst cacheAnnotation = defineAnnotation()({\n\tnamespace: \"cache\",\n\tapplicableTo: [\"read\"]\n});\n//#endregion\n//#region src/cache-store.ts\n/**\n* Default cache backend. An LRU with per-entry TTL, backed by a `Map`.\n*\n* Eviction policy:\n*\n* - On `set` of a fresh key whose insertion would push the live count\n*   above `maxEntries`, the least recently used entry is evicted.\n*   Setting an existing key updates the entry in place and refreshes its\n*   recency without changing the live count.\n* - On `get` of an existing key, recency is bumped (so the entry is no\n*   longer the LRU candidate).\n* - On `get` of an expired entry, the entry is removed from the map and\n*   `undefined` is returned. The slot becomes available for new writes\n*   without counting against `maxEntries`.\n*\n* `Map` insertion order is the LRU order: the first key is the LRU\n* candidate; the last key is the most recently used. Bumping recency is\n* a delete-then-set on the underlying map.\n*\n* The default store is **not** coherent across processes or replicas —\n* each process holds its own Map. Users who need a shared cache supply\n* their own `CacheStore` (Redis, Memcached, etc.).\n*/\nfunction createInMemoryCacheStore(options) {\n\tconst maxEntries = options.maxEntries;\n\tconst clock = options.clock ?? Date.now;\n\tconst map = /* @__PURE__ */ new Map();\n\tfunction get(key) {\n\t\tconst record = map.get(key);\n\t\tif (record === void 0) return Promise.resolve(void 0);\n\t\tif (clock() >= record.expiresAt) {\n\t\t\tmap.delete(key);\n\t\t\treturn Promise.resolve(void 0);\n\t\t}\n\t\tmap.delete(key);\n\t\tmap.set(key, record);\n\t\treturn Promise.resolve(record.entry);\n\t}\n\tfunction set(key, entry, ttlMs) {\n\t\tconst expiresAt = clock() + ttlMs;\n\t\tif (map.has(key)) map.delete(key);\n\t\tmap.set(key, {\n\t\t\tentry,\n\t\t\texpiresAt\n\t\t});\n\t\twhile (map.size > maxEntries) {\n\t\t\tconst oldest = map.keys().next();\n\t\t\tif (oldest.done) break;\n\t\t\tmap.delete(oldest.value);\n\t\t}\n\t\treturn Promise.resolve();\n\t}\n\treturn {\n\t\tget,\n\t\tset\n\t};\n}\n//#endregion\n//#region src/cache-middleware.ts\n/**\n* Default `maxEntries` for the built-in in-memory store. Bounded so a\n* runaway producer cannot exhaust process memory; users who need\n* different bounds supply a custom `CacheStore`.\n*/\nconst DEFAULT_MAX_ENTRIES = 1e3;\n/**\n* Reads the cache payload from the plan, if present and branded.\n*\n* Returns `undefined` when:\n* - the plan has no `meta.annotations`, or\n* - the `cache` namespace key is absent, or\n* - the value under `cache` is not a branded `AnnotationValue` (the\n*   `cacheAnnotation.read` defensive check covers this).\n*/\nfunction readCachePayload(plan) {\n\treturn cacheAnnotation.read(plan);\n}\n/**\n* Computes the cache key for an execution.\n*\n* Two-tier resolution:\n*\n* 1. Per-query override: `cacheAnnotation({ key })` — the supplied\n*    string is used verbatim. Not rehashed; the user is responsible for\n*    keeping the string bounded and free of sensitive data.\n* 2. Default: `ctx.contentHash(exec)` — the family runtime owns this and\n*    returns an opaque, bounded digest (SHA-512 in the SQL and Mongo\n*    runtimes today).\n*\n* The returned string is consumed directly as the `Map<string, …>` key\n* by the underlying `CacheStore`; the cache middleware does not perform\n* any further transformation.\n*/\nasync function resolveCacheKey(payload, exec, ctx) {\n\tif (payload.key !== void 0) return payload.key;\n\treturn ctx.contentHash(exec);\n}\n/**\n* Creates a family-agnostic caching middleware.\n*\n* The middleware uses three hooks:\n*\n* - `intercept` — on each execution, checks the cache. On a hit, returns\n*   the cached raw rows; the runtime skips `runDriver` and `onRow`\n*   (`beforeExecute` is not affected — it has already run for every\n*   middleware before any `intercept` is consulted) and yields the\n*   cached rows to the consumer (which, in the SQL runtime, sees them\n*   after the standard `decodeRow` pass — i.e. the cache stores\n*   wire-format values). On a miss, records a pending buffer keyed on\n*   the `exec` object identity and returns `undefined` (passthrough).\n* - `onRow` — on the miss path, appends each row yielded by the driver\n*   to the pending buffer.\n* - `afterExecute` — on the miss path, commits the buffer to the store\n*   if and only if `result.completed === true && result.source === 'driver'`.\n*   Failed executions and middleware-served executions never populate\n*   the cache. The pending buffer is cleared in all branches so a stale\n*   `WeakMap` entry cannot leak between executions sharing an `exec`.\n*\n* The middleware bypasses the cache entirely when:\n* - the plan has no `cache` annotation, or\n* - the annotation has `skip: true`, or\n* - the annotation has no `ttl`, or\n* - `ctx.scope !== 'runtime'` (connection / transaction scopes opt out).\n*\n* Returns a cross-family `RuntimeMiddleware` (no `familyId` /\n* `targetId`). The package depends only on\n* `@internal/framework-components/runtime`; cache keys come from\n* `ctx.contentHash(exec)`, populated by the family runtime, so SQL and\n* Mongo runtimes both work out of the box.\n*\n* @example\n* ```typescript\n* import { createCacheMiddleware, cacheAnnotation } from '@internal/middleware-cache';\n*\n* const db = postgres({\n*   contractJson,\n*   url: process.env['DATABASE_URL']!,\n*   middleware: [createCacheMiddleware({ maxEntries: 1000 })],\n* });\n*\n* const user = await db.User.first(\n*   { id },\n*   (meta) => meta.annotate(cacheAnnotation({ ttl: 60_000 })),\n* );\n* ```\n*/\nfunction createCacheMiddleware(options) {\n\tconst store = options?.store ?? createInMemoryCacheStore({ maxEntries: options?.maxEntries ?? DEFAULT_MAX_ENTRIES });\n\tconst clock = options?.clock ?? Date.now;\n\tconst pending = /* @__PURE__ */ new WeakMap();\n\tasync function intercept(exec, ctx) {\n\t\tif (ctx.scope !== \"runtime\") return;\n\t\tconst payload = readCachePayload(exec);\n\t\tif (payload === void 0) return;\n\t\tif (payload.skip === true) return;\n\t\tif (payload.ttl === void 0) return;\n\t\tconst key = await resolveCacheKey(payload, exec, ctx);\n\t\tconst hit = await store.get(key);\n\t\tif (hit !== void 0) {\n\t\t\tctx.log.debug?.({\n\t\t\t\tevent: \"middleware.cache.hit\",\n\t\t\t\tmiddleware: \"cache\",\n\t\t\t\tkey\n\t\t\t});\n\t\t\treturn { rows: hit.rows };\n\t\t}\n\t\tpending.set(exec, {\n\t\t\tkey,\n\t\t\tttlMs: payload.ttl,\n\t\t\tbuffer: []\n\t\t});\n\t\tctx.log.debug?.({\n\t\t\tevent: \"middleware.cache.miss\",\n\t\t\tmiddleware: \"cache\",\n\t\t\tkey\n\t\t});\n\t}\n\tasync function onRow(row, exec, _ctx) {\n\t\tconst slot = pending.get(exec);\n\t\tif (slot === void 0) return;\n\t\tslot.buffer.push(row);\n\t}\n\tasync function afterExecute(exec, result, ctx) {\n\t\tconst slot = pending.get(exec);\n\t\tif (slot === void 0) return;\n\t\tpending.delete(exec);\n\t\tif (!result.completed || result.source !== \"driver\") return;\n\t\tawait store.set(slot.key, {\n\t\t\trows: slot.buffer,\n\t\t\tstoredAt: clock()\n\t\t}, slot.ttlMs);\n\t\tctx.log.debug?.({\n\t\t\tevent: \"middleware.cache.store\",\n\t\t\tmiddleware: \"cache\",\n\t\t\tkey: slot.key\n\t\t});\n\t}\n\treturn {\n\t\tname: \"cache\",\n\t\tintercept,\n\t\tonRow,\n\t\tafterExecute\n\t};\n}\n//#endregion\nexport { cacheAnnotation, createCacheMiddleware, createInMemoryCacheStore };\n\n//# sourceMappingURL=index.mjs.map"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCA,MAAM,kBAAkB,iBAAiB,CAAC,CAAC;CAC1C,WAAW;CACX,cAAc,CAAC,MAAM;AACtB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;AA0BD,SAAS,yBAAyB,SAAS;CAC1C,MAAM,aAAa,QAAQ;CAC3B,MAAM,QAAQ,QAAQ,SAAS,KAAK;CACpC,MAAM,sBAAsB,IAAI,IAAI;CACpC,SAAS,IAAI,KAAK;EACjB,MAAM,SAAS,IAAI,IAAI,GAAG;EAC1B,IAAI,WAAW,KAAK,GAAG,OAAO,QAAQ,QAAQ,KAAK,CAAC;EACpD,IAAI,MAAM,KAAK,OAAO,WAAW;GAChC,IAAI,OAAO,GAAG;GACd,OAAO,QAAQ,QAAQ,KAAK,CAAC;EAC9B;EACA,IAAI,OAAO,GAAG;EACd,IAAI,IAAI,KAAK,MAAM;EACnB,OAAO,QAAQ,QAAQ,OAAO,KAAK;CACpC;CACA,SAAS,IAAI,KAAK,OAAO,OAAO;EAC/B,MAAM,YAAY,MAAM,IAAI;EAC5B,IAAI,IAAI,IAAI,GAAG,GAAG,IAAI,OAAO,GAAG;EAChC,IAAI,IAAI,KAAK;GACZ;GACA;EACD,CAAC;EACD,OAAO,IAAI,OAAO,YAAY;GAC7B,MAAM,SAAS,IAAI,KAAK,CAAC,CAAC,KAAK;GAC/B,IAAI,OAAO,MAAM;GACjB,IAAI,OAAO,OAAO,KAAK;EACxB;EACA,OAAO,QAAQ,QAAQ;CACxB;CACA,OAAO;EACN;EACA;CACD;AACD;;;;;;AAQA,MAAM,sBAAsB;;;;;;;;;;AAU5B,SAAS,iBAAiB,MAAM;CAC/B,OAAO,gBAAgB,KAAK,IAAI;AACjC;;;;;;;;;;;;;;;;;AAiBA,eAAe,gBAAgB,SAAS,MAAM,KAAK;CAClD,IAAI,QAAQ,QAAQ,KAAK,GAAG,OAAO,QAAQ;CAC3C,OAAO,IAAI,YAAY,IAAI;AAC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkDA,SAAS,sBAAsB,SAAS;CACvC,MAAM,QAAQ,SAAS,SAAS,yBAAyB,EAAE,YAAY,SAAS,cAAc,oBAAoB,CAAC;CACnH,MAAM,QAAQ,SAAS,SAAS,KAAK;CACrC,MAAM,0BAA0B,IAAI,QAAQ;CAC5C,eAAe,UAAU,MAAM,KAAK;EACnC,IAAI,IAAI,UAAU,WAAW;EAC7B,MAAM,UAAU,iBAAiB,IAAI;EACrC,IAAI,YAAY,KAAK,GAAG;EACxB,IAAI,QAAQ,SAAS,MAAM;EAC3B,IAAI,QAAQ,QAAQ,KAAK,GAAG;EAC5B,MAAM,MAAM,MAAM,gBAAgB,SAAS,MAAM,GAAG;EACpD,MAAM,MAAM,MAAM,MAAM,IAAI,GAAG;EAC/B,IAAI,QAAQ,KAAK,GAAG;GACnB,IAAI,IAAI,QAAQ;IACf,OAAO;IACP,YAAY;IACZ;GACD,CAAC;GACD,OAAO,EAAE,MAAM,IAAI,KAAK;EACzB;EACA,QAAQ,IAAI,MAAM;GACjB;GACA,OAAO,QAAQ;GACf,QAAQ,CAAC;EACV,CAAC;EACD,IAAI,IAAI,QAAQ;GACf,OAAO;GACP,YAAY;GACZ;EACD,CAAC;CACF;CACA,eAAe,MAAM,KAAK,MAAM,MAAM;EACrC,MAAM,OAAO,QAAQ,IAAI,IAAI;EAC7B,IAAI,SAAS,KAAK,GAAG;EACrB,KAAK,OAAO,KAAK,GAAG;CACrB;CACA,eAAe,aAAa,MAAM,QAAQ,KAAK;EAC9C,MAAM,OAAO,QAAQ,IAAI,IAAI;EAC7B,IAAI,SAAS,KAAK,GAAG;EACrB,QAAQ,OAAO,IAAI;EACnB,IAAI,CAAC,OAAO,aAAa,OAAO,WAAW,UAAU;EACrD,MAAM,MAAM,IAAI,KAAK,KAAK;GACzB,MAAM,KAAK;GACX,UAAU,MAAM;EACjB,GAAG,KAAK,KAAK;EACb,IAAI,IAAI,QAAQ;GACf,OAAO;GACP,YAAY;GACZ,KAAK,KAAK;EACX,CAAC;CACF;CACA,OAAO;EACN,MAAM;EACN;EACA;EACA;CACD;AACD"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@prisma/orm-extension-middleware-cache",
+  "version": "0.16.0-dev.36",
+  "license": "Apache-2.0",
+  "type": "module",
+  "sideEffects": false,
+  "description": "Family-agnostic caching middleware for Prisma Next runtimes",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@prisma/orm-framework": "0.16.0-dev.36"
+  },
+  "devDependencies": {
+    "@internal/middleware-cache": "0.16.0-dev.36",
+    "@repo/tsconfig": "0.16.0-dev.36",
+    "@repo/tsdown": "0.16.0-dev.36",
+    "tsdown": "0.22.14",
+    "typescript": "5.9.3"
+  },
+  "peerDependencies": {
+    "typescript": ">=5.9"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/prisma/prisma.git",
+    "directory": "packages/9-public/@prisma/orm-extension-middleware-cache"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "lint": "biome check . --error-on-warnings",
+    "clean": "rm -rf dist src-gen"
+  }
+}