@siteping/adapter-drizzle 0.1.0

package/dist/store-helpers.d.cts

@@ -0,0 +1,140 @@
+/**
+ * Record-construction helpers and the collection-store engine.
+ *
+ * Every snapshot-style adapter (memory, localStorage, flat file, KV, …)
+ * 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.
+ *
+ * `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 `SitepingStore` — writing a new snapshot adapter is ~20 lines
+ * plus its storage specifics.
+ */
+import type { AnnotationCreateInput, AnnotationRecord, CommentCreateInput, CommentRecord, FeedbackCreateInput, FeedbackRecord, SitepingStore } from "./types.cjs";
+/**
+ * Build a persisted `AnnotationRecord` from its create input — normalizes
+ * the optional anchor fields to `null` and stamps identity/timestamp.
+ */
+export declare function buildAnnotationRecord(input: AnnotationCreateInput, ctx: {
+    id: string;
+    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;
+    annotationId: () => string;
+    now?: Date;
+}): FeedbackRecord;
+/**
+ * Storage primitives behind a collection store. `load`/`persist` may be
+ * 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 {
+    /**
+     * Return the current full snapshot of feedback records. The engine never
+     * mutates this array — handing out a live cache is safe.
+     */
+    load(): FeedbackRecord[] | Promise<FeedbackRecord[]>;
+    /**
+     * Persist the full snapshot — always a new array, never the one `load()`
+     * returned. Throw `StorePersistenceError` when the write is lost (quota,
+     * storage disabled, …) — never swallow the failure. Because the loaded
+     * snapshot is left untouched, a throw here leaves a cached `load()` result
+     * consistent with durable storage: no phantom record, no half-applied
+     * update.
+     */
+    persist(feedbacks: FeedbackRecord[]): void | Promise<void>;
+    /** 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` guaranteed —
+ * what `createCollectionStore` returns, which also guarantees
+ * `createFeedbackIfAbsent`.
+ */
+export type CollectionStore = SitepingStore & Required<Pick<SitepingStore, "verifyProjectOwnership">>;
+/**
+ * Build a fully conformant `SitepingStore` 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,
+ * `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.
+ *
+ * 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 {
+ *   private feedbacks: FeedbackRecord[] = [];
+ *   private readonly store = createCollectionStore({
+ *     load: () => this.feedbacks,
+ *     persist: (next) => {
+ *       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 & {
+    comments: true;
+}): CollectionStore & Required<Pick<SitepingStore, "createFeedbackIfAbsent" | "addComment" | "deleteComment">>;
+export declare function createCollectionStore(backend: CollectionStoreBackend): CollectionStore & Required<Pick<SitepingStore, "createFeedbackIfAbsent">>;

package/dist/store-helpers.d.ts

@@ -0,0 +1,140 @@
+/**
+ * Record-construction helpers and the collection-store engine.
+ *
+ * Every snapshot-style adapter (memory, localStorage, flat file, KV, …)
+ * 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.
+ *
+ * `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 `SitepingStore` — writing a new snapshot adapter is ~20 lines
+ * plus its storage specifics.
+ */
+import type { AnnotationCreateInput, AnnotationRecord, CommentCreateInput, CommentRecord, FeedbackCreateInput, FeedbackRecord, SitepingStore } from "./types.js";
+/**
+ * Build a persisted `AnnotationRecord` from its create input — normalizes
+ * the optional anchor fields to `null` and stamps identity/timestamp.
+ */
+export declare function buildAnnotationRecord(input: AnnotationCreateInput, ctx: {
+    id: string;
+    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;
+    annotationId: () => string;
+    now?: Date;
+}): FeedbackRecord;
+/**
+ * Storage primitives behind a collection store. `load`/`persist` may be
+ * 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 {
+    /**
+     * Return the current full snapshot of feedback records. The engine never
+     * mutates this array — handing out a live cache is safe.
+     */
+    load(): FeedbackRecord[] | Promise<FeedbackRecord[]>;
+    /**
+     * Persist the full snapshot — always a new array, never the one `load()`
+     * returned. Throw `StorePersistenceError` when the write is lost (quota,
+     * storage disabled, …) — never swallow the failure. Because the loaded
+     * snapshot is left untouched, a throw here leaves a cached `load()` result
+     * consistent with durable storage: no phantom record, no half-applied
+     * update.
+     */
+    persist(feedbacks: FeedbackRecord[]): void | Promise<void>;
+    /** 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` guaranteed —
+ * what `createCollectionStore` returns, which also guarantees
+ * `createFeedbackIfAbsent`.
+ */
+export type CollectionStore = SitepingStore & Required<Pick<SitepingStore, "verifyProjectOwnership">>;
+/**
+ * Build a fully conformant `SitepingStore` 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,
+ * `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.
+ *
+ * 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 {
+ *   private feedbacks: FeedbackRecord[] = [];
+ *   private readonly store = createCollectionStore({
+ *     load: () => this.feedbacks,
+ *     persist: (next) => {
+ *       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 & {
+    comments: true;
+}): CollectionStore & Required<Pick<SitepingStore, "createFeedbackIfAbsent" | "addComment" | "deleteComment">>;
+export declare function createCollectionStore(backend: CollectionStoreBackend): CollectionStore & Required<Pick<SitepingStore, "createFeedbackIfAbsent">>;

package/dist/type-utils.d.cts

@@ -0,0 +1,66 @@
+/**
+ * General-purpose TypeScript utility types used across `@siteping/*`.
+ *
+ * These are kept dependency-free and re-exported from the package entry
+ * so adapters and integrators can rely on the same primitives the core
+ * uses internally.
+ */
+/**
+ * Force TypeScript to expand a computed type into a flat object literal in
+ * tooltips and error messages. Purely cosmetic — same structural type, just
+ * easier to read.
+ *
+ * @example
+ *   type Raw = Omit<FeedbackRecord, "annotations"> & { annotations: number };
+ *   type Pretty = Prettify<Raw>; // displayed as a flat object
+ */
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+/**
+ * Returns `Y` when `A` is exactly assignable to `B` and vice-versa,
+ * otherwise `N`. Powers compile-time equality assertions.
+ */
+export type IfEquals<A, B, Y = true, N = false> = (<T>() => T extends A ? 1 : 2) extends <T>() => T extends B ? 1 : 2 ? Y : N;
+/**
+ * Compile-time exact-type guard — resolves to `true` when `Actual` and
+ * `Expected` are identical, `never` otherwise. Assign the result to a
+ * `const _lock: AssertEqual<A, B> = true;` so any drift becomes a compile
+ * error at the declaration site.
+ */
+export type AssertEqual<Actual, Expected> = IfEquals<Actual, Expected, true, never>;
+/**
+ * JSON-serialized shape of `T` — the wire form produced by `Response.json()`
+ * / `JSON.stringify`: `Date` becomes ISO `string` (nullability preserved),
+ * arrays are serialized element-wise, everything else is untouched.
+ *
+ * Used to derive the `*Response` API types from the `*Record` store types so
+ * the two can never drift: add a field to `FeedbackRecord` and
+ * `FeedbackResponse` follows automatically.
+ */
+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.
+ */
+export declare function isRecord(value: unknown): value is Record<PropertyKey, unknown>;
+/**
+ * Returns true when `value` is an object that exposes the requested key.
+ * Type-narrows `value` so the property can be accessed without further
+ * casting — a strictly typed replacement for `"k" in obj`.
+ *
+ * Named after the standardised `Object.hasOwn` helper rather than the
+ * legacy `Object.prototype.hasOwnProperty`, which the linter forbids
+ * shadowing.
+ */
+export declare function hasOwn<K extends PropertyKey>(value: unknown, key: K): value is Record<K, unknown>;

package/dist/type-utils.d.ts

@@ -0,0 +1,66 @@
+/**
+ * General-purpose TypeScript utility types used across `@siteping/*`.
+ *
+ * These are kept dependency-free and re-exported from the package entry
+ * so adapters and integrators can rely on the same primitives the core
+ * uses internally.
+ */
+/**
+ * Force TypeScript to expand a computed type into a flat object literal in
+ * tooltips and error messages. Purely cosmetic — same structural type, just
+ * easier to read.
+ *
+ * @example
+ *   type Raw = Omit<FeedbackRecord, "annotations"> & { annotations: number };
+ *   type Pretty = Prettify<Raw>; // displayed as a flat object
+ */
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+/**
+ * Returns `Y` when `A` is exactly assignable to `B` and vice-versa,
+ * otherwise `N`. Powers compile-time equality assertions.
+ */
+export type IfEquals<A, B, Y = true, N = false> = (<T>() => T extends A ? 1 : 2) extends <T>() => T extends B ? 1 : 2 ? Y : N;
+/**
+ * Compile-time exact-type guard — resolves to `true` when `Actual` and
+ * `Expected` are identical, `never` otherwise. Assign the result to a
+ * `const _lock: AssertEqual<A, B> = true;` so any drift becomes a compile
+ * error at the declaration site.
+ */
+export type AssertEqual<Actual, Expected> = IfEquals<Actual, Expected, true, never>;
+/**
+ * JSON-serialized shape of `T` — the wire form produced by `Response.json()`
+ * / `JSON.stringify`: `Date` becomes ISO `string` (nullability preserved),
+ * arrays are serialized element-wise, everything else is untouched.
+ *
+ * Used to derive the `*Response` API types from the `*Record` store types so
+ * the two can never drift: add a field to `FeedbackRecord` and
+ * `FeedbackResponse` follows automatically.
+ */
+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.
+ */
+export declare function isRecord(value: unknown): value is Record<PropertyKey, unknown>;
+/**
+ * Returns true when `value` is an object that exposes the requested key.
+ * Type-narrows `value` so the property can be accessed without further
+ * casting — a strictly typed replacement for `"k" in obj`.
+ *
+ * Named after the standardised `Object.hasOwn` helper rather than the
+ * legacy `Object.prototype.hasOwnProperty`, which the linter forbids
+ * shadowing.
+ */
+export declare function hasOwn<K extends PropertyKey>(value: unknown, key: K): value is Record<K, unknown>;