@beezping/adapter-memory 0.6.0 → 0.7.0

package/dist/schema.d.cts

@@ -1,5 +1,5 @@
 /**
- * Siteping database models — single source of truth.
+ * Beezping database models — single source of truth.
  *
  * Used by:
  * - CLI to generate Prisma schema (via prisma-ast)
@@ -9,11 +9,12 @@
  * This is a TS representation, NOT a .prisma file.
  * The CLI generates the actual Prisma schema from this definition.
  */
-/** Prisma scalar types supported by Siteping field definitions. */
+import type { BEEZPING_MODELS } from "./constants/schema.cjs";
+/** Prisma scalar types supported by Beezping field definitions. */
 export type PrismaScalarType = "String" | "Boolean" | "Int" | "BigInt" | "Float" | "Decimal" | "DateTime" | "Json" | "Bytes";
 /** Prisma native column hints applied via `@db.<NativeType>`. */
 export type PrismaNativeType = "Text" | "VarChar" | "Char" | "MediumText" | "LongText" | (string & {});
-/** Relation cardinality between two Siteping models. */
+/** Relation cardinality between two Beezping models. */
 export type RelationKind = "1-to-many" | "many-to-1";
 /** Prisma `onDelete` referential action. */
 export type RelationOnDelete = "Cascade" | "Restrict" | "NoAction" | "SetNull" | "SetDefault";
@@ -33,7 +34,7 @@ export interface RelationDef {
     onDelete?: RelationOnDelete;
 }
 /**
- * Definition of a single field in a Siteping database model.
+ * Definition of a single field in a Beezping database model.
  *
  * The interface intentionally keeps a wide structural shape so it stays
  * easy to extend, but consumers can narrow via {@link isRelationField} /
@@ -63,201 +64,17 @@ export declare function isRelationField(field: FieldDef): field is FieldDef & {
 export declare function isScalarField(field: FieldDef): field is FieldDef & {
     relation?: undefined;
 };
-/** Definition of a composite index on a Siteping database model. */
+/** Definition of a composite index on a Beezping database model. */
 export interface IndexDef {
     fields: readonly string[];
 }
-/** Definition of a single Siteping database model (fields + indexes). */
+/** Definition of a single Beezping database model (fields + indexes). */
 export interface ModelDef {
     fields: Record<string, FieldDef>;
     indexes?: readonly IndexDef[];
 }
-declare const _SITEPING_MODELS: {
-    readonly SitepingFeedback: {
-        readonly fields: {
-            readonly id: {
-                readonly type: "String";
-                readonly isId: true;
-                readonly default: "cuid()";
-            };
-            readonly projectName: {
-                readonly type: "String";
-            };
-            readonly type: {
-                readonly type: "String";
-            };
-            readonly message: {
-                readonly type: "String";
-                readonly nativeType: "Text";
-            };
-            readonly status: {
-                readonly type: "String";
-                readonly default: "\"open\"";
-            };
-            readonly url: {
-                readonly type: "String";
-            };
-            readonly urlPattern: {
-                readonly type: "String";
-                readonly optional: true;
-            };
-            readonly screenshotUrl: {
-                readonly type: "String";
-                readonly optional: true;
-                readonly nativeType: "Text";
-            };
-            readonly screenshotRegion: {
-                readonly type: "Json";
-                readonly optional: true;
-            };
-            readonly diagnostics: {
-                readonly type: "Json";
-                readonly optional: true;
-            };
-            readonly viewport: {
-                readonly type: "String";
-            };
-            readonly userAgent: {
-                readonly type: "String";
-            };
-            readonly authorName: {
-                readonly type: "String";
-            };
-            readonly authorEmail: {
-                readonly type: "String";
-            };
-            readonly clientId: {
-                readonly type: "String";
-                readonly isUnique: true;
-            };
-            readonly resolvedAt: {
-                readonly type: "DateTime";
-                readonly optional: true;
-            };
-            readonly createdAt: {
-                readonly type: "DateTime";
-                readonly default: "now()";
-            };
-            readonly updatedAt: {
-                readonly type: "DateTime";
-                readonly isUpdatedAt: true;
-            };
-            readonly annotations: {
-                readonly type: "SitepingAnnotation";
-                readonly relation: {
-                    readonly kind: "1-to-many";
-                    readonly model: "SitepingAnnotation";
-                };
-            };
-        };
-        readonly indexes: readonly [{
-            readonly fields: readonly ["projectName"];
-        }, {
-            readonly fields: readonly ["projectName", "status", "createdAt"];
-        }, {
-            readonly fields: readonly ["projectName", "url"];
-        }];
-    };
-    readonly SitepingAnnotation: {
-        readonly fields: {
-            readonly id: {
-                readonly type: "String";
-                readonly isId: true;
-                readonly default: "cuid()";
-            };
-            readonly feedbackId: {
-                readonly type: "String";
-            };
-            readonly feedback: {
-                readonly type: "SitepingFeedback";
-                readonly relation: {
-                    readonly kind: "many-to-1";
-                    readonly model: "SitepingFeedback";
-                    readonly fields: readonly ["feedbackId"];
-                    readonly references: readonly ["id"];
-                    readonly onDelete: "Cascade";
-                };
-            };
-            readonly cssSelector: {
-                readonly type: "String";
-                readonly nativeType: "Text";
-            };
-            readonly xpath: {
-                readonly type: "String";
-                readonly nativeType: "Text";
-            };
-            readonly textSnippet: {
-                readonly type: "String";
-                readonly nativeType: "Text";
-            };
-            readonly elementTag: {
-                readonly type: "String";
-            };
-            readonly elementId: {
-                readonly type: "String";
-                readonly optional: true;
-            };
-            readonly textPrefix: {
-                readonly type: "String";
-                readonly nativeType: "Text";
-            };
-            readonly textSuffix: {
-                readonly type: "String";
-                readonly nativeType: "Text";
-            };
-            readonly fingerprint: {
-                readonly type: "String";
-            };
-            readonly neighborText: {
-                readonly type: "String";
-                readonly nativeType: "Text";
-            };
-            readonly anchorKey: {
-                readonly type: "String";
-                readonly optional: true;
-            };
-            readonly xPct: {
-                readonly type: "Float";
-            };
-            readonly yPct: {
-                readonly type: "Float";
-            };
-            readonly wPct: {
-                readonly type: "Float";
-            };
-            readonly hPct: {
-                readonly type: "Float";
-            };
-            readonly scrollX: {
-                readonly type: "Float";
-            };
-            readonly scrollY: {
-                readonly type: "Float";
-            };
-            readonly viewportW: {
-                readonly type: "Int";
-            };
-            readonly viewportH: {
-                readonly type: "Int";
-            };
-            readonly devicePixelRatio: {
-                readonly type: "Float";
-                readonly default: "1";
-            };
-            readonly createdAt: {
-                readonly type: "DateTime";
-                readonly default: "now()";
-            };
-        };
-        readonly indexes: readonly [{
-            readonly fields: readonly ["feedbackId"];
-        }];
-    };
-};
-/** Map of Siteping models keyed by model name — frozen at runtime. */
-export declare const SITEPING_MODELS: typeof _SITEPING_MODELS;
-/** Union of every Siteping model name as a string literal. */
-export type SitepingModelName = keyof typeof SITEPING_MODELS;
-/** Field names declared on a specific Siteping model. */
-export type SitepingModelFieldName<M extends SitepingModelName> = keyof (typeof SITEPING_MODELS)[M]["fields"];
-export {};
+export { BEEZPING_MODELS } from "./constants/schema.cjs";
+/** Union of every Beezping model name as a string literal. */
+export type BeezpingModelName = "BeezpingFeedback" | "BeezpingAnnotation" | "BeezpingComment";
+/** Field names declared on a specific Beezping model. */
+export type BeezpingModelFieldName<M extends BeezpingModelName> = keyof (typeof BEEZPING_MODELS)[M]["fields"];

package/dist/schema.d.ts

@@ -1,5 +1,5 @@
 /**
- * Siteping database models — single source of truth.
+ * Beezping database models — single source of truth.
  *
  * Used by:
  * - CLI to generate Prisma schema (via prisma-ast)
@@ -9,11 +9,12 @@
  * This is a TS representation, NOT a .prisma file.
  * The CLI generates the actual Prisma schema from this definition.
  */
-/** Prisma scalar types supported by Siteping field definitions. */
+import type { BEEZPING_MODELS } from "./constants/schema.js";
+/** Prisma scalar types supported by Beezping field definitions. */
 export type PrismaScalarType = "String" | "Boolean" | "Int" | "BigInt" | "Float" | "Decimal" | "DateTime" | "Json" | "Bytes";
 /** Prisma native column hints applied via `@db.<NativeType>`. */
 export type PrismaNativeType = "Text" | "VarChar" | "Char" | "MediumText" | "LongText" | (string & {});
-/** Relation cardinality between two Siteping models. */
+/** Relation cardinality between two Beezping models. */
 export type RelationKind = "1-to-many" | "many-to-1";
 /** Prisma `onDelete` referential action. */
 export type RelationOnDelete = "Cascade" | "Restrict" | "NoAction" | "SetNull" | "SetDefault";
@@ -33,7 +34,7 @@ export interface RelationDef {
     onDelete?: RelationOnDelete;
 }
 /**
- * Definition of a single field in a Siteping database model.
+ * Definition of a single field in a Beezping database model.
  *
  * The interface intentionally keeps a wide structural shape so it stays
  * easy to extend, but consumers can narrow via {@link isRelationField} /
@@ -63,201 +64,17 @@ export declare function isRelationField(field: FieldDef): field is FieldDef & {
 export declare function isScalarField(field: FieldDef): field is FieldDef & {
     relation?: undefined;
 };
-/** Definition of a composite index on a Siteping database model. */
+/** Definition of a composite index on a Beezping database model. */
 export interface IndexDef {
     fields: readonly string[];
 }
-/** Definition of a single Siteping database model (fields + indexes). */
+/** Definition of a single Beezping database model (fields + indexes). */
 export interface ModelDef {
     fields: Record<string, FieldDef>;
     indexes?: readonly IndexDef[];
 }
-declare const _SITEPING_MODELS: {
-    readonly SitepingFeedback: {
-        readonly fields: {
-            readonly id: {
-                readonly type: "String";
-                readonly isId: true;
-                readonly default: "cuid()";
-            };
-            readonly projectName: {
-                readonly type: "String";
-            };
-            readonly type: {
-                readonly type: "String";
-            };
-            readonly message: {
-                readonly type: "String";
-                readonly nativeType: "Text";
-            };
-            readonly status: {
-                readonly type: "String";
-                readonly default: "\"open\"";
-            };
-            readonly url: {
-                readonly type: "String";
-            };
-            readonly urlPattern: {
-                readonly type: "String";
-                readonly optional: true;
-            };
-            readonly screenshotUrl: {
-                readonly type: "String";
-                readonly optional: true;
-                readonly nativeType: "Text";
-            };
-            readonly screenshotRegion: {
-                readonly type: "Json";
-                readonly optional: true;
-            };
-            readonly diagnostics: {
-                readonly type: "Json";
-                readonly optional: true;
-            };
-            readonly viewport: {
-                readonly type: "String";
-            };
-            readonly userAgent: {
-                readonly type: "String";
-            };
-            readonly authorName: {
-                readonly type: "String";
-            };
-            readonly authorEmail: {
-                readonly type: "String";
-            };
-            readonly clientId: {
-                readonly type: "String";
-                readonly isUnique: true;
-            };
-            readonly resolvedAt: {
-                readonly type: "DateTime";
-                readonly optional: true;
-            };
-            readonly createdAt: {
-                readonly type: "DateTime";
-                readonly default: "now()";
-            };
-            readonly updatedAt: {
-                readonly type: "DateTime";
-                readonly isUpdatedAt: true;
-            };
-            readonly annotations: {
-                readonly type: "SitepingAnnotation";
-                readonly relation: {
-                    readonly kind: "1-to-many";
-                    readonly model: "SitepingAnnotation";
-                };
-            };
-        };
-        readonly indexes: readonly [{
-            readonly fields: readonly ["projectName"];
-        }, {
-            readonly fields: readonly ["projectName", "status", "createdAt"];
-        }, {
-            readonly fields: readonly ["projectName", "url"];
-        }];
-    };
-    readonly SitepingAnnotation: {
-        readonly fields: {
-            readonly id: {
-                readonly type: "String";
-                readonly isId: true;
-                readonly default: "cuid()";
-            };
-            readonly feedbackId: {
-                readonly type: "String";
-            };
-            readonly feedback: {
-                readonly type: "SitepingFeedback";
-                readonly relation: {
-                    readonly kind: "many-to-1";
-                    readonly model: "SitepingFeedback";
-                    readonly fields: readonly ["feedbackId"];
-                    readonly references: readonly ["id"];
-                    readonly onDelete: "Cascade";
-                };
-            };
-            readonly cssSelector: {
-                readonly type: "String";
-                readonly nativeType: "Text";
-            };
-            readonly xpath: {
-                readonly type: "String";
-                readonly nativeType: "Text";
-            };
-            readonly textSnippet: {
-                readonly type: "String";
-                readonly nativeType: "Text";
-            };
-            readonly elementTag: {
-                readonly type: "String";
-            };
-            readonly elementId: {
-                readonly type: "String";
-                readonly optional: true;
-            };
-            readonly textPrefix: {
-                readonly type: "String";
-                readonly nativeType: "Text";
-            };
-            readonly textSuffix: {
-                readonly type: "String";
-                readonly nativeType: "Text";
-            };
-            readonly fingerprint: {
-                readonly type: "String";
-            };
-            readonly neighborText: {
-                readonly type: "String";
-                readonly nativeType: "Text";
-            };
-            readonly anchorKey: {
-                readonly type: "String";
-                readonly optional: true;
-            };
-            readonly xPct: {
-                readonly type: "Float";
-            };
-            readonly yPct: {
-                readonly type: "Float";
-            };
-            readonly wPct: {
-                readonly type: "Float";
-            };
-            readonly hPct: {
-                readonly type: "Float";
-            };
-            readonly scrollX: {
-                readonly type: "Float";
-            };
-            readonly scrollY: {
-                readonly type: "Float";
-            };
-            readonly viewportW: {
-                readonly type: "Int";
-            };
-            readonly viewportH: {
-                readonly type: "Int";
-            };
-            readonly devicePixelRatio: {
-                readonly type: "Float";
-                readonly default: "1";
-            };
-            readonly createdAt: {
-                readonly type: "DateTime";
-                readonly default: "now()";
-            };
-        };
-        readonly indexes: readonly [{
-            readonly fields: readonly ["feedbackId"];
-        }];
-    };
-};
-/** Map of Siteping models keyed by model name — frozen at runtime. */
-export declare const SITEPING_MODELS: typeof _SITEPING_MODELS;
-/** Union of every Siteping model name as a string literal. */
-export type SitepingModelName = keyof typeof SITEPING_MODELS;
-/** Field names declared on a specific Siteping model. */
-export type SitepingModelFieldName<M extends SitepingModelName> = keyof (typeof SITEPING_MODELS)[M]["fields"];
-export {};
+export { BEEZPING_MODELS } from "./constants/schema.js";
+/** Union of every Beezping model name as a string literal. */
+export type BeezpingModelName = "BeezpingFeedback" | "BeezpingAnnotation" | "BeezpingComment";
+/** Field names declared on a specific Beezping model. */
+export type BeezpingModelFieldName<M extends BeezpingModelName> = keyof (typeof BEEZPING_MODELS)[M]["fields"];

package/dist/screenshot-storage.d.cts

@@ -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;