@beezping/adapter-memory 0.6.0 → 0.7.0

package/dist/screenshot-storage.d.ts

@@ -1,16 +1,17 @@
 /**
  * Pluggable storage for feedback screenshots.
  *
- * `adapter-prisma` accepts an optional `screenshotStorage` config. When
- * provided, the adapter forwards the widget-supplied data URL to `upload()`
- * and persists the returned URL on `Feedback.screenshotUrl`. When not
- * provided, the adapter falls back to inline base64 (with a one-time warn) —
- * fine for dev and small deployments, a footgun for production Postgres.
+ * `adapter-prisma` and `adapter-drizzle` accept an optional
+ * `screenshotStorage` config. When provided, the adapter forwards the
+ * widget-supplied data URL to `upload()` and persists the returned URL on
+ * `Feedback.screenshotUrl`. When not provided, the adapter falls back to
+ * inline base64 (with a one-time warn) — fine for dev and small
+ * deployments, a footgun for production Postgres.
  *
- * Implementations typically wrap an object store: S3, Cloudflare R2,
- * Backblaze B2, Cloudflare Images, local filesystem, etc. They are
- * intentionally not shipped from this package — wire your own based on
- * existing infra.
+ * `@beezping/screenshot-storage` implements it over any S3-compatible
+ * bucket (AWS S3, Cloudflare R2, Backblaze B2, MinIO…), Cloudflare Images,
+ * a database table, the local filesystem or memory. Implement it yourself
+ * for anything else.
  *
  * @example
  * ```ts
@@ -19,17 +20,17 @@
  *
  * const s3 = new S3Client({ region: "eu-west-3" });
  * const screenshotStorage: ScreenshotStorage = {
- *   async upload(dataUrl, ctx) {
- *     const buf = Buffer.from(dataUrl.split(",")[1], "base64");
- *     const key = `feedback/${ctx.feedbackId}.jpg`;
+ *   async upload(dataUrl, { mimeType }) {
+ *     const body = Buffer.from(dataUrl.slice(dataUrl.indexOf(",") + 1), "base64");
+ *     const key = `beezping/${crypto.randomUUID()}`; // fresh per upload, see URL ownership
  *     await s3.send(new PutObjectCommand({
- *       Bucket: "my-bucket", Key: key, Body: buf, ContentType: ctx.mimeType,
+ *       Bucket: "my-bucket", Key: key, Body: body, ContentType: mimeType,
  *     }));
  *     return { url: `https://cdn.example.com/${key}` };
  *   },
  * };
  *
- * createSitepingHandler({ prisma, screenshotStorage });
+ * createBeezpingHandler({ prisma, screenshotStorage });
  * ```
  */
 export interface ScreenshotStorage {
@@ -44,17 +45,19 @@ export interface ScreenshotStorage {
      * `ctx.feedbackId` identifies the upload. Adapters that upload before the
      * record exists pass the *client-generated* `clientId` (Prisma); the
      * Drizzle adapter passes the server-generated id the create attempt will
-     * insert the record under — unique per attempt, so racing submissions of
-     * one `clientId` never write the same object key.
+     * insert the record under.
      *
-     * **URL ownership:** the returned URL must be unique to `ctx.feedbackId` —
-     * key the object by it (as the example does), never by a content hash or a
-     * fixed name. Adapters treat each URL as the exclusive property of the one
-     * record that stores it and may pass it to `delete` once that record is
-     * deleted or its upload discarded, without coordinating with concurrent
-     * creates. A URL shared by several records (content-addressed or
-     * id-ignoring keys) breaks this contract: deleting one record can remove
-     * the object another record still points at.
+     * **URL ownership:** every call must return a URL no other call returns —
+     * key the object by a fresh random value (`crypto.randomUUID()`, as the
+     * example does), never by `ctx.feedbackId` alone nor by a content hash.
+     * Adapters treat each URL as the property of the one record that stores it
+     * and may pass it to `delete` once that record is deleted, or once its
+     * create lost a race: two submissions of one `clientId` both upload, and
+     * the object of the one that is not stored is deleted. Under Prisma,
+     * `ctx.feedbackId` is that client-supplied `clientId`, so an object keyed
+     * by it is rewritten by every replay — a retry, or anyone who learns the
+     * id — and a URL shared by several records lets deleting one remove the
+     * object another still points at.
      *
      * **Security note:** treat `ctx.feedbackId` as attacker-controlled:
      * sanitize before using it in filesystem paths or object keys, even though
@@ -67,12 +70,34 @@ export interface ScreenshotStorage {
         url: string;
     }>;
     /**
-     * Optional cleanup hook called when the feedback is deleted, or when an
-     * uploaded screenshot is discarded because its record was not stored.
-     * Receives only URLs returned by {@link ScreenshotStorage.upload}, each
-     * owned by a single record (see its URL ownership rule). Adapters call
-     * this best-effort and swallow errors — orphaned objects are preferred
-     * over failed deletes.
+     * Optional cleanup hook called when the feedback is deleted, and for an
+     * object uploaded by a create whose record was not stored: one rejected
+     * because its `clientId` is already stored, or — in adapters that key
+     * uploads per attempt, like Drizzle — one whose insert failed. An object a
+     * stored row still references (a deterministic key reused by the replay)
+     * is kept. Receives only URLs returned by {@link ScreenshotStorage.upload}.
+     * Adapters call this best-effort and swallow errors — orphaned objects are
+     * preferred over failed deletes.
      */
     delete?: (url: string) => Promise<void>;
 }
+/**
+ * Most `ScreenshotStorage.delete` calls one cleanup keeps in flight — a
+ * project delete may free thousands of objects, and firing them all at once
+ * can exhaust sockets (one per request with `fetch`) or memory and trip
+ * object-store rate limits. It stays under the 50 sockets the AWS SDK opens
+ * per client by default, yet a project delete, which waits for its cleanup,
+ * is not serialised: 1,000 objects take 32 rounds. Adapters run their
+ * deletes through `settleWithConcurrencyLimit` with this bound.
+ */
+export declare const SCREENSHOT_DELETE_CONCURRENCY = 32;
+/**
+ * MIME type an adapter reports to {@link ScreenshotStorage.upload}: the one
+ * an image data URL declares (`data:image/png;base64,…` → `image/png`),
+ * limited to the JPEG, PNG and WebP the HTTP schema accepts. Stores are
+ * public and may be fed unvalidated data URLs, and an `image/svg+xml` label
+ * would make the stored object script-capable when served inline. Anything
+ * else — including a data URL that declares no type — reports JPEG, the
+ * widget's capture format.
+ */
+export declare function screenshotMimeType(dataUrl: string): string;

package/dist/store-helpers.d.cts

@@ -5,15 +5,15 @@
  * needs the same three ingredients: turn a `FeedbackCreateInput` into a
  * `FeedbackRecord` (null-normalizing optional fields, stamping ids and
  * timestamps), filter/paginate with `applyFeedbackFilters`, and implement
- * the dedup/update/delete choreography of the `SitepingStore` contract.
+ * the dedup/update/delete choreography of the `BeezpingStore` contract.
  *
- * `buildFeedbackRecord` / `buildAnnotationRecord` cover the first part for
- * any adapter. `createCollectionStore` covers all of it: give it `load`,
- * `persist`, and `generateId`, and it returns a fully conformant
- * `SitepingStore` — writing a new snapshot adapter is ~20 lines plus its
- * storage specifics.
+ * `buildFeedbackRecord` / `buildAnnotationRecord` / `buildCommentRecord`
+ * cover the first part for any adapter. `createCollectionStore` covers all
+ * of it: give it `load`, `persist`, and `generateId`, and it returns a fully
+ * conformant `BeezpingStore` — writing a new snapshot adapter is ~20 lines
+ * plus its storage specifics.
  */
-import type { AnnotationCreateInput, AnnotationRecord, FeedbackCreateInput, FeedbackRecord, SitepingStore } from "./types.cjs";
+import type { AnnotationCreateInput, AnnotationRecord, BeezpingStore, CommentCreateInput, CommentRecord, FeedbackCreateInput, FeedbackRecord } from "./types.cjs";
 /**
  * Build a persisted `AnnotationRecord` from its create input — normalizes
  * the optional anchor fields to `null` and stamps identity/timestamp.
@@ -23,12 +23,20 @@ export declare function buildAnnotationRecord(input: AnnotationCreateInput, ctx:
     feedbackId: string;
     now: Date;
 }): AnnotationRecord;
+/** Build a persisted `CommentRecord` from its create input — stamps identity, thread and timestamp. */
+export declare function buildCommentRecord(input: CommentCreateInput, ctx: {
+    id: string;
+    feedbackId: string;
+    now?: Date;
+}): CommentRecord;
 /**
  * Build a persisted `FeedbackRecord` (with its annotations) from a create
  * input — normalizes every optional field to `null` and stamps ids and
  * timestamps. Adapters without external screenshot storage keep the data
  * URL inline on `screenshotUrl`, which is what this helper does; adapters
  * with a `ScreenshotStorage` upload first and override `screenshotUrl`.
+ * It leaves `comments` out, so the record minus its `annotations` stays an
+ * insertable feedback row; a store with threads returns `comments: []` itself.
  */
 export declare function buildFeedbackRecord(input: FeedbackCreateInput, ctx: {
     id: string;
@@ -37,8 +45,11 @@ export declare function buildFeedbackRecord(input: FeedbackCreateInput, ctx: {
 }): FeedbackRecord;
 /**
  * Storage primitives behind a collection store. `load`/`persist` may be
- * sync or async — the engine awaits both, so in-memory arrays, localStorage
- * and async KV stores all fit the same three functions.
+ * sync or async, so in-memory arrays, localStorage and async KV stores all
+ * fit the same three functions. When both are sync, a mutation runs from
+ * `load` to `persist` without yielding, so no other code in the realm can
+ * write in between; an async backend is only serialized against the
+ * engine's own queue.
  */
 export interface CollectionStoreBackend {
     /**
@@ -55,47 +66,60 @@ export interface CollectionStoreBackend {
      * update.
      */
     persist(feedbacks: FeedbackRecord[]): void | Promise<void>;
-    /** Generate a unique id for a new feedback or annotation record. */
+    /** Generate a unique id for a new feedback, annotation or comment record. */
     generateId(): string;
+    /**
+     * Keep discussion threads on the records: the store gains `addComment` and
+     * `deleteComment`, and new records start with `comments: []`. Opt in once
+     * `load` hands back what `persist` wrote for them, each comment's
+     * `createdAt` a `Date` again (a JSON backend revives it like the record's
+     * own dates). Off by default, so an adapter written before threads never
+     * gains them — over storage never written for them — on an engine update.
+     */
+    comments?: boolean | undefined;
 }
 /**
- * A `SitepingStore` with the optional `verifyProjectOwnership` and
- * `createFeedbackIfAbsent` guaranteed — what `createCollectionStore` returns.
+ * A `BeezpingStore` with the optional `verifyProjectOwnership` guaranteed —
+ * what `createCollectionStore` returns, which also guarantees
+ * `createFeedbackIfAbsent`.
  */
-export type CollectionStore = SitepingStore & Required<Pick<SitepingStore, "verifyProjectOwnership" | "createFeedbackIfAbsent">>;
+export type CollectionStore = BeezpingStore & Required<Pick<BeezpingStore, "verifyProjectOwnership">>;
 /**
- * Build a fully conformant `SitepingStore` on top of a snapshot backend.
+ * Build a fully conformant `BeezpingStore` on top of a snapshot backend.
  *
  * The engine implements the whole store contract: clientId dedup (idempotent
  * create, with `createFeedbackIfAbsent` reporting inserts), newest-first
- * ordering, the standard filter/pagination pipeline,
- * `StoreNotFoundError` on missing update/delete, project-scoped bulk delete,
- * and `verifyProjectOwnership`. The snapshot returned by `load` is never
- * mutated: every write hands `persist` a new array, so a failed write leaves
+ * ordering, the standard filter/pagination pipeline, `StoreNotFoundError` on
+ * missing update/delete, project-scoped bulk delete,
+ * `verifyProjectOwnership`, and — with `comments: true` — discussion threads
+ * (`addComment`, `deleteComment`) kept on each record. The snapshot returned by `load` is
+ * never mutated: every write hands `persist` a new array, so a failed write leaves
  * a cached snapshot exactly as it was. When `persist` fails during `createFeedback`
  * and the record carries an inline screenshot, the engine retries once
  * without the screenshot (by far the heaviest field) so the text feedback
  * survives a storage-quota hit; if that also fails, the error propagates —
  * returning the record would claim a success that was never persisted.
  *
- * Every read-modify-write mutation (`createFeedbackIfAbsent`,
- * `createFeedback`, `updateFeedback`, `deleteFeedback`,
- * `deleteAllFeedbacks`) runs through one promise queue per returned store,
- * so its `load` → check → `persist` sequence never interleaves with another
- * mutation of the same instance. That makes `createFeedbackIfAbsent` report
- * `created: true` exactly once per `clientId` and prevents concurrent writes
- * from overwriting each other's snapshot. The guarantee is scoped to one
- * store instance in one JS process: two instances over the same storage (two
- * server processes on a shared file, two browser tabs on the same
- * localStorage key) are not coordinated — backends that need that must
- * provide their own atomic primitive (a unique constraint, a transaction, a
- * compare-and-set). A failed mutation rejects with its original error and
- * does not block the ones queued after it. Reads are not queued: they see the
- * last persisted snapshot.
+ * Mutations (`createFeedbackIfAbsent`, `createFeedback`, `updateFeedback`,
+ * `deleteFeedback`, `deleteAllFeedbacks`, `addComment`, `deleteComment`) run
+ * one at a time through a queue owned by the returned store, so concurrent
+ * calls — the widget's `Promise.all` bulk resolve/delete, a comment posted
+ * while its feedback is resolved — never start from the same snapshot and
+ * overwrite each other, and `createFeedbackIfAbsent` reports `created: true`
+ * exactly once per `clientId`. A failed mutation rejects with its own error
+ * and does not block the ones queued after it, but `load` and `persist` must
+ * always settle: one that never does stalls every later mutation on the
+ * store, so give network-backed primitives a timeout. Reads are not queued: they see the
+ * last persisted snapshot. The guarantee is scoped to one store instance in
+ * one JS realm — two instances over the same storage (two
+ * `LocalStorageStore`s on one key, two browser tabs, several server
+ * processes sharing a KV or a file) are not coordinated; a backend that
+ * needs that must bring its own atomic primitive (a transaction, a
+ * compare-and-set).
  *
  * @example
  * ```ts
- * export class MemoryStore implements SitepingStore {
+ * export class MemoryStore implements BeezpingStore {
  *   private feedbacks: FeedbackRecord[] = [];
  *   private readonly store = createCollectionStore({
  *     load: () => this.feedbacks,
@@ -103,10 +127,14 @@ export type CollectionStore = SitepingStore & Required<Pick<SitepingStore, "veri
  *       this.feedbacks = next;
  *     },
  *     generateId: () => crypto.randomUUID(),
+ *     comments: true,
  *   });
  *   createFeedback = this.store.createFeedback;
  *   // …delegate the remaining methods the same way
  * }
  * ```
  */
-export declare function createCollectionStore(backend: CollectionStoreBackend): CollectionStore;
+export declare function createCollectionStore(backend: CollectionStoreBackend & {
+    comments: true;
+}): CollectionStore & Required<Pick<BeezpingStore, "createFeedbackIfAbsent" | "addComment" | "deleteComment">>;
+export declare function createCollectionStore(backend: CollectionStoreBackend): CollectionStore & Required<Pick<BeezpingStore, "createFeedbackIfAbsent">>;

package/dist/store-helpers.d.ts

@@ -5,15 +5,15 @@
  * needs the same three ingredients: turn a `FeedbackCreateInput` into a
  * `FeedbackRecord` (null-normalizing optional fields, stamping ids and
  * timestamps), filter/paginate with `applyFeedbackFilters`, and implement
- * the dedup/update/delete choreography of the `SitepingStore` contract.
+ * the dedup/update/delete choreography of the `BeezpingStore` contract.
  *
- * `buildFeedbackRecord` / `buildAnnotationRecord` cover the first part for
- * any adapter. `createCollectionStore` covers all of it: give it `load`,
- * `persist`, and `generateId`, and it returns a fully conformant
- * `SitepingStore` — writing a new snapshot adapter is ~20 lines plus its
- * storage specifics.
+ * `buildFeedbackRecord` / `buildAnnotationRecord` / `buildCommentRecord`
+ * cover the first part for any adapter. `createCollectionStore` covers all
+ * of it: give it `load`, `persist`, and `generateId`, and it returns a fully
+ * conformant `BeezpingStore` — writing a new snapshot adapter is ~20 lines
+ * plus its storage specifics.
  */
-import type { AnnotationCreateInput, AnnotationRecord, FeedbackCreateInput, FeedbackRecord, SitepingStore } from "./types.js";
+import type { AnnotationCreateInput, AnnotationRecord, BeezpingStore, CommentCreateInput, CommentRecord, FeedbackCreateInput, FeedbackRecord } from "./types.js";
 /**
  * Build a persisted `AnnotationRecord` from its create input — normalizes
  * the optional anchor fields to `null` and stamps identity/timestamp.
@@ -23,12 +23,20 @@ export declare function buildAnnotationRecord(input: AnnotationCreateInput, ctx:
     feedbackId: string;
     now: Date;
 }): AnnotationRecord;
+/** Build a persisted `CommentRecord` from its create input — stamps identity, thread and timestamp. */
+export declare function buildCommentRecord(input: CommentCreateInput, ctx: {
+    id: string;
+    feedbackId: string;
+    now?: Date;
+}): CommentRecord;
 /**
  * Build a persisted `FeedbackRecord` (with its annotations) from a create
  * input — normalizes every optional field to `null` and stamps ids and
  * timestamps. Adapters without external screenshot storage keep the data
  * URL inline on `screenshotUrl`, which is what this helper does; adapters
  * with a `ScreenshotStorage` upload first and override `screenshotUrl`.
+ * It leaves `comments` out, so the record minus its `annotations` stays an
+ * insertable feedback row; a store with threads returns `comments: []` itself.
  */
 export declare function buildFeedbackRecord(input: FeedbackCreateInput, ctx: {
     id: string;
@@ -37,8 +45,11 @@ export declare function buildFeedbackRecord(input: FeedbackCreateInput, ctx: {
 }): FeedbackRecord;
 /**
  * Storage primitives behind a collection store. `load`/`persist` may be
- * sync or async — the engine awaits both, so in-memory arrays, localStorage
- * and async KV stores all fit the same three functions.
+ * sync or async, so in-memory arrays, localStorage and async KV stores all
+ * fit the same three functions. When both are sync, a mutation runs from
+ * `load` to `persist` without yielding, so no other code in the realm can
+ * write in between; an async backend is only serialized against the
+ * engine's own queue.
  */
 export interface CollectionStoreBackend {
     /**
@@ -55,47 +66,60 @@ export interface CollectionStoreBackend {
      * update.
      */
     persist(feedbacks: FeedbackRecord[]): void | Promise<void>;
-    /** Generate a unique id for a new feedback or annotation record. */
+    /** Generate a unique id for a new feedback, annotation or comment record. */
     generateId(): string;
+    /**
+     * Keep discussion threads on the records: the store gains `addComment` and
+     * `deleteComment`, and new records start with `comments: []`. Opt in once
+     * `load` hands back what `persist` wrote for them, each comment's
+     * `createdAt` a `Date` again (a JSON backend revives it like the record's
+     * own dates). Off by default, so an adapter written before threads never
+     * gains them — over storage never written for them — on an engine update.
+     */
+    comments?: boolean | undefined;
 }
 /**
- * A `SitepingStore` with the optional `verifyProjectOwnership` and
- * `createFeedbackIfAbsent` guaranteed — what `createCollectionStore` returns.
+ * A `BeezpingStore` with the optional `verifyProjectOwnership` guaranteed —
+ * what `createCollectionStore` returns, which also guarantees
+ * `createFeedbackIfAbsent`.
  */
-export type CollectionStore = SitepingStore & Required<Pick<SitepingStore, "verifyProjectOwnership" | "createFeedbackIfAbsent">>;
+export type CollectionStore = BeezpingStore & Required<Pick<BeezpingStore, "verifyProjectOwnership">>;
 /**
- * Build a fully conformant `SitepingStore` on top of a snapshot backend.
+ * Build a fully conformant `BeezpingStore` on top of a snapshot backend.
  *
  * The engine implements the whole store contract: clientId dedup (idempotent
  * create, with `createFeedbackIfAbsent` reporting inserts), newest-first
- * ordering, the standard filter/pagination pipeline,
- * `StoreNotFoundError` on missing update/delete, project-scoped bulk delete,
- * and `verifyProjectOwnership`. The snapshot returned by `load` is never
- * mutated: every write hands `persist` a new array, so a failed write leaves
+ * ordering, the standard filter/pagination pipeline, `StoreNotFoundError` on
+ * missing update/delete, project-scoped bulk delete,
+ * `verifyProjectOwnership`, and — with `comments: true` — discussion threads
+ * (`addComment`, `deleteComment`) kept on each record. The snapshot returned by `load` is
+ * never mutated: every write hands `persist` a new array, so a failed write leaves
  * a cached snapshot exactly as it was. When `persist` fails during `createFeedback`
  * and the record carries an inline screenshot, the engine retries once
  * without the screenshot (by far the heaviest field) so the text feedback
  * survives a storage-quota hit; if that also fails, the error propagates —
  * returning the record would claim a success that was never persisted.
  *
- * Every read-modify-write mutation (`createFeedbackIfAbsent`,
- * `createFeedback`, `updateFeedback`, `deleteFeedback`,
- * `deleteAllFeedbacks`) runs through one promise queue per returned store,
- * so its `load` → check → `persist` sequence never interleaves with another
- * mutation of the same instance. That makes `createFeedbackIfAbsent` report
- * `created: true` exactly once per `clientId` and prevents concurrent writes
- * from overwriting each other's snapshot. The guarantee is scoped to one
- * store instance in one JS process: two instances over the same storage (two
- * server processes on a shared file, two browser tabs on the same
- * localStorage key) are not coordinated — backends that need that must
- * provide their own atomic primitive (a unique constraint, a transaction, a
- * compare-and-set). A failed mutation rejects with its original error and
- * does not block the ones queued after it. Reads are not queued: they see the
- * last persisted snapshot.
+ * Mutations (`createFeedbackIfAbsent`, `createFeedback`, `updateFeedback`,
+ * `deleteFeedback`, `deleteAllFeedbacks`, `addComment`, `deleteComment`) run
+ * one at a time through a queue owned by the returned store, so concurrent
+ * calls — the widget's `Promise.all` bulk resolve/delete, a comment posted
+ * while its feedback is resolved — never start from the same snapshot and
+ * overwrite each other, and `createFeedbackIfAbsent` reports `created: true`
+ * exactly once per `clientId`. A failed mutation rejects with its own error
+ * and does not block the ones queued after it, but `load` and `persist` must
+ * always settle: one that never does stalls every later mutation on the
+ * store, so give network-backed primitives a timeout. Reads are not queued: they see the
+ * last persisted snapshot. The guarantee is scoped to one store instance in
+ * one JS realm — two instances over the same storage (two
+ * `LocalStorageStore`s on one key, two browser tabs, several server
+ * processes sharing a KV or a file) are not coordinated; a backend that
+ * needs that must bring its own atomic primitive (a transaction, a
+ * compare-and-set).
  *
  * @example
  * ```ts
- * export class MemoryStore implements SitepingStore {
+ * export class MemoryStore implements BeezpingStore {
  *   private feedbacks: FeedbackRecord[] = [];
  *   private readonly store = createCollectionStore({
  *     load: () => this.feedbacks,
@@ -103,10 +127,14 @@ export type CollectionStore = SitepingStore & Required<Pick<SitepingStore, "veri
  *       this.feedbacks = next;
  *     },
  *     generateId: () => crypto.randomUUID(),
+ *     comments: true,
  *   });
  *   createFeedback = this.store.createFeedback;
  *   // …delegate the remaining methods the same way
  * }
  * ```
  */
-export declare function createCollectionStore(backend: CollectionStoreBackend): CollectionStore;
+export declare function createCollectionStore(backend: CollectionStoreBackend & {
+    comments: true;
+}): CollectionStore & Required<Pick<BeezpingStore, "createFeedbackIfAbsent" | "addComment" | "deleteComment">>;
+export declare function createCollectionStore(backend: CollectionStoreBackend): CollectionStore & Required<Pick<BeezpingStore, "createFeedbackIfAbsent">>;

package/dist/type-utils.d.cts

@@ -41,6 +41,14 @@ export type AssertEqual<Actual, Expected> = IfEquals<Actual, Expected, true, nev
 export type Serialized<T> = {
     [K in keyof T]: T[K] extends Date ? string : T[K] extends Date | null ? string | null : T[K] extends (infer U)[] ? Serialized<U>[] : T[K];
 };
+/**
+ * Read-only all the way down, for plain data that is deeply frozen at
+ * runtime: nested objects get read-only properties, arrays become
+ * `readonly` arrays.
+ */
+export type DeepReadonly<T> = T extends readonly (infer U)[] ? readonly DeepReadonly<U>[] : T extends object ? {
+    readonly [K in keyof T]: DeepReadonly<T[K]>;
+} : T;
 /**
  * Type guard that narrows `value` to a non-null `Record<PropertyKey, unknown>`.
  * Useful when validating arbitrary inputs before reading fields.

package/dist/type-utils.d.ts

@@ -41,6 +41,14 @@ export type AssertEqual<Actual, Expected> = IfEquals<Actual, Expected, true, nev
 export type Serialized<T> = {
     [K in keyof T]: T[K] extends Date ? string : T[K] extends Date | null ? string | null : T[K] extends (infer U)[] ? Serialized<U>[] : T[K];
 };
+/**
+ * Read-only all the way down, for plain data that is deeply frozen at
+ * runtime: nested objects get read-only properties, arrays become
+ * `readonly` arrays.
+ */
+export type DeepReadonly<T> = T extends readonly (infer U)[] ? readonly DeepReadonly<U>[] : T extends object ? {
+    readonly [K in keyof T]: DeepReadonly<T[K]>;
+} : T;
 /**
  * Type guard that narrows `value` to a non-null `Record<PropertyKey, unknown>`.
  * Useful when validating arbitrary inputs before reading fields.