convex-feedback 0.1.0 → 0.1.2

package/dist/client/api.d.ts

@@ -1,72 +1,271 @@
 import type { FunctionReference, PaginationOptions, PaginationResult } from "convex/server";
 import type { CommentSort, EntryKind, EntrySort, EntryStatus, FeedbackComment, FeedbackEntry, SimilarEntriesResult } from "../component/model.js";
-export interface FeedbackPublicApi<Name extends string | undefined = string | undefined> {
-    listEntries: FunctionReference<"query", "public", {
-        paginationOpts: PaginationOptions;
-        kind?: EntryKind;
-        status?: EntryStatus;
-        sort?: EntrySort;
-    }, PaginationResult<FeedbackEntry>, Name>;
-    getEntry: FunctionReference<"query", "public", {
-        entryId: string;
-    }, FeedbackEntry | null, Name>;
-    searchEntries: FunctionReference<"query", "public", {
-        searchQuery: string;
-        kind?: EntryKind;
-        status?: EntryStatus;
-        limit?: number;
-    }, FeedbackEntry[], Name>;
-    findSimilarEntries: FunctionReference<"query", "public", {
-        title: string;
-        body: string;
-        kind?: EntryKind;
-        limit?: number;
-    }, SimilarEntriesResult, Name>;
-    createEntry: FunctionReference<"mutation", "public", {
-        kind: EntryKind;
-        title: string;
-        body: string;
-    }, string, Name>;
-    updateEntry: FunctionReference<"mutation", "public", {
-        entryId: string;
-        title: string;
-        body: string;
-    }, null, Name>;
-    setEntryStatus: FunctionReference<"mutation", "public", {
-        entryId: string;
-        status: EntryStatus;
-    }, null, Name>;
-    setEntryUpvote: FunctionReference<"mutation", "public", {
-        entryId: string;
-        desiredState: boolean;
-    }, {
-        active: boolean;
-        upvoteCount: number;
-    }, Name>;
-    listComments: FunctionReference<"query", "public", {
-        paginationOpts: PaginationOptions;
-        entryId: string;
-        parentCommentId?: string;
-        sort?: CommentSort;
-    }, PaginationResult<FeedbackComment>, Name>;
-    createComment: FunctionReference<"mutation", "public", {
-        entryId: string;
-        parentCommentId?: string;
-        body: string;
-    }, string, Name>;
-    updateComment: FunctionReference<"mutation", "public", {
-        commentId: string;
-        body: string;
-    }, null, Name>;
-    deleteComment: FunctionReference<"mutation", "public", {
-        commentId: string;
-    }, null, Name>;
-    setCommentLike: FunctionReference<"mutation", "public", {
-        commentId: string;
-        desiredState: boolean;
-    }, {
-        active: boolean;
-        likeCount: number;
-    }, Name>;
+/**
+ * Arguments for cursor-paginated entry listing.
+ */
+export type ListEntriesArgs = {
+    /**
+     * Convex cursor-pagination options.
+     *
+     * React consumers normally do not construct this directly; `useEntries`
+     * manages it through `usePaginatedQuery`.
+     */
+    paginationOpts: PaginationOptions;
+    /**
+     * Entry kinds to include.
+     *
+     * Filtering is performed by Convex before pagination. Omit this field to
+     * include every kind.
+     *
+     * Must contain at least one kind when provided.
+     */
+    kinds?: EntryKind[];
+    /** Restricts entries to this workflow status. */
+    status?: EntryStatus;
+    /**
+     * Server-side ordering strategy.
+     *
+     * When omitted, `config.entries.defaultSort` is used.
+     */
+    sort?: EntrySort;
+};
+/**
+ * Arguments for retrieving one entry.
+ */
+export type GetEntryArgs = {
+    /** Identifier returned by the component for the requested entry. */
+    entryId: string;
+};
+/**
+ * Arguments for full-text entry search.
+ */
+export type SearchEntriesArgs = {
+    /** Full-text query matched against the entry's indexed search text. */
+    searchQuery: string;
+    /**
+     * Entry kinds to include.
+     *
+     * Filtering occurs inside the Convex query rather than after results reach
+     * the client.
+     */
+    kinds?: EntryKind[];
+    /** Optional workflow-status restriction. */
+    status?: EntryStatus;
+    /**
+     * Maximum number of results to return.
+     *
+     * When omitted, `config.search.defaultLimit` is used. The server clamps the
+     * value to `config.search.maxLimit`.
+     */
+    limit?: number;
+};
+/**
+ * Arguments for exact/similar duplicate detection.
+ */
+export type FindSimilarEntriesArgs = {
+    /**
+     * Proposed entry title.
+     *
+     * Its normalized form is used for exact duplicate detection.
+     */
+    title: string;
+    /**
+     * Proposed entry body.
+     *
+     * Combined with the title for the full-text similarity search.
+     */
+    body: string;
+    /**
+     * Restricts duplicate detection to one entry kind.
+     *
+     * Omit to search every kind.
+     */
+    kind?: EntryKind;
+    /**
+     * Maximum combined number of suggestions returned.
+     *
+     * Exact normalized-title matches consume this limit first. Only remaining
+     * slots are available to full-text matches.
+     *
+     * Therefore:
+     *
+     * `result.exact.length + result.similar.length <= limit`
+     *
+     * When omitted, `config.search.duplicateSuggestionLimit` is used.
+     */
+    limit?: number;
+};
+/**
+ * Arguments for creating an entry.
+ */
+export type CreateEntryArgs = {
+    /** Category of entry to create. */
+    kind: EntryKind;
+    /** Entry title. */
+    title: string;
+    /** Entry description/body. */
+    body: string;
+};
+/**
+ * Arguments for editing an existing entry.
+ */
+export type UpdateEntryArgs = {
+    /** Entry to update. */
+    entryId: string;
+    /** Complete replacement title. */
+    title: string;
+    /** Complete replacement body. */
+    body: string;
+};
+/**
+ * Arguments for changing an entry workflow status.
+ */
+export type SetEntryStatusArgs = {
+    /** Entry whose status should change. */
+    entryId: string;
+    /** Desired workflow status. */
+    status: EntryStatus;
+};
+/**
+ * Arguments for setting the current actor's entry-upvote state.
+ */
+export type SetEntryUpvoteArgs = {
+    /** Entry whose upvote state should change. */
+    entryId: string;
+    /**
+     * Desired final state.
+     *
+     * `true` ensures the current actor has an upvote.
+     * `false` ensures the current actor does not have an upvote.
+     *
+     * This is intentionally state-setting rather than toggle semantics, making
+     * the mutation idempotent and safe to retry.
+     */
+    desiredState: boolean;
+};
+/**
+ * Authoritative entry-upvote state returned after a mutation.
+ */
+export type SetEntryUpvoteResult = {
+    /** Final upvote state for the current actor. */
+    active: boolean;
+    /** Updated total number of entry upvotes. */
+    upvoteCount: number;
+};
+/**
+ * Arguments for cursor-paginated comment/reply listing.
+ */
+export type ListCommentsArgs = {
+    /** Convex cursor-pagination options. */
+    paginationOpts: PaginationOptions;
+    /** Entry whose conversation should be queried. */
+    entryId: string;
+    /**
+     * Direct parent comment.
+     *
+     * Omit to query top-level comments. When supplied, only direct children of
+     * this comment are returned; deeper descendants are not loaded.
+     */
+    parentCommentId?: string;
+    /**
+     * Server-side comment ordering strategy.
+     *
+     * When omitted, `config.comments.defaultSort` is used.
+     */
+    sort?: CommentSort;
+};
+/**
+ * Arguments for creating a top-level comment or reply.
+ */
+export type CreateCommentArgs = {
+    /** Entry the comment belongs to. */
+    entryId: string;
+    /**
+     * Direct parent comment.
+     *
+     * Omit to create a top-level comment.
+     */
+    parentCommentId?: string;
+    /** Comment/reply text. */
+    body: string;
+};
+/**
+ * Arguments for editing a comment.
+ */
+export type UpdateCommentArgs = {
+    /** Comment to edit. */
+    commentId: string;
+    /** Complete replacement body. */
+    body: string;
+};
+/**
+ * Arguments for soft-deleting a comment.
+ */
+export type DeleteCommentArgs = {
+    /** Comment to soft-delete. */
+    commentId: string;
+};
+/**
+ * Arguments for setting the current actor's comment-like state.
+ */
+export type SetCommentLikeArgs = {
+    /** Comment whose like state should change. */
+    commentId: string;
+    /**
+     * Desired final state.
+     *
+     * `true` ensures the actor likes the comment.
+     * `false` ensures the actor does not like the comment.
+     *
+     * This is idempotent rather than toggle-based.
+     */
+    desiredState: boolean;
+};
+/**
+ * Authoritative comment-like state returned after a mutation.
+ */
+export type SetCommentLikeResult = {
+    /** Final like state for the current actor. */
+    active: boolean;
+    /** Updated total number of comment likes. */
+    likeCount: number;
+};
+/**
+ * Public Convex API exposed by `exposeFeedbackApi`.
+ *
+ * The host application exposes these wrappers from its own Convex deployment
+ * after resolving authentication and configuration.
+ *
+ * @typeParam RateLimitResult A validated rejection value returned by mutations
+ * when non-throwing rate limiting is configured. The default `never` preserves
+ * the original success-only mutation results.
+ */
+export interface FeedbackPublicApi<Name extends string | undefined = string | undefined, RateLimitResult = never> {
+    /** Returns a cursor-paginated entry list. */
+    listEntries: FunctionReference<"query", "public", ListEntriesArgs, PaginationResult<FeedbackEntry>, Name>;
+    /** Returns one entry or `null` when it does not exist. */
+    getEntry: FunctionReference<"query", "public", GetEntryArgs, FeedbackEntry | null, Name>;
+    /** Performs full-text entry search. */
+    searchEntries: FunctionReference<"query", "public", SearchEntriesArgs, FeedbackEntry[], Name>;
+    /** Finds exact and likely duplicate entries. */
+    findSimilarEntries: FunctionReference<"query", "public", FindSimilarEntriesArgs, SimilarEntriesResult, Name>;
+    /** Creates an entry, returning its identifier or a rate-limit rejection. */
+    createEntry: FunctionReference<"mutation", "public", CreateEntryArgs, string | RateLimitResult, Name>;
+    /** Replaces entry content, or returns a configured rate-limit rejection. */
+    updateEntry: FunctionReference<"mutation", "public", UpdateEntryArgs, null | RateLimitResult, Name>;
+    /** Changes entry status, or returns a configured rate-limit rejection. */
+    setEntryStatus: FunctionReference<"mutation", "public", SetEntryStatusArgs, null | RateLimitResult, Name>;
+    /** Sets entry-upvote state, or returns a configured rate-limit rejection. */
+    setEntryUpvote: FunctionReference<"mutation", "public", SetEntryUpvoteArgs, SetEntryUpvoteResult | RateLimitResult, Name>;
+    /** Returns one paginated level of comments or replies. */
+    listComments: FunctionReference<"query", "public", ListCommentsArgs, PaginationResult<FeedbackComment>, Name>;
+    /** Creates a comment/reply, returning its ID or a rate-limit rejection. */
+    createComment: FunctionReference<"mutation", "public", CreateCommentArgs, string | RateLimitResult, Name>;
+    /** Replaces comment content, or returns a configured rate-limit rejection. */
+    updateComment: FunctionReference<"mutation", "public", UpdateCommentArgs, null | RateLimitResult, Name>;
+    /** Soft-deletes a comment, or returns a configured rate-limit rejection. */
+    deleteComment: FunctionReference<"mutation", "public", DeleteCommentArgs, null | RateLimitResult, Name>;
+    /** Sets comment-like state, or returns a configured rate-limit rejection. */
+    setCommentLike: FunctionReference<"mutation", "public", SetCommentLikeArgs, SetCommentLikeResult | RateLimitResult, Name>;
 }
 //# sourceMappingURL=api.d.ts.map

package/dist/client/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/client/api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EACV,WAAW,EACX,SAAS,EACT,SAAS,EACT,WAAW,EACX,eAAe,EACf,aAAa,EACb,oBAAoB,EACrB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,WAAW,iBAAiB,CAChC,IAAI,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS;IAEpD,WAAW,EAAE,iBAAiB,CAC5B,OAAO,EACP,QAAQ,EACR;QACE,cAAc,EAAE,iBAAiB,CAAC;QAClC,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,IAAI,CAAC,EAAE,SAAS,CAAC;KAClB,EACD,gBAAgB,CAAC,aAAa,CAAC,EAC/B,IAAI,CACL,CAAC;IACF,QAAQ,EAAE,iBAAiB,CACzB,OAAO,EACP,QAAQ,EACR;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,EACnB,aAAa,GAAG,IAAI,EACpB,IAAI,CACL,CAAC;IACF,aAAa,EAAE,iBAAiB,CAC9B,OAAO,EACP,QAAQ,EACR;QACE,WAAW,EAAE,MAAM,CAAC;QACpB,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,EACD,aAAa,EAAE,EACf,IAAI,CACL,CAAC;IACF,kBAAkB,EAAE,iBAAiB,CACnC,OAAO,EACP,QAAQ,EACR;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,SAAS,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EACjE,oBAAoB,EACpB,IAAI,CACL,CAAC;IACF,WAAW,EAAE,iBAAiB,CAC5B,UAAU,EACV,QAAQ,EACR;QAAE,IAAI,EAAE,SAAS,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAChD,MAAM,EACN,IAAI,CACL,CAAC;IACF,WAAW,EAAE,iBAAiB,CAC5B,UAAU,EACV,QAAQ,EACR;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAChD,IAAI,EACJ,IAAI,CACL,CAAC;IACF,cAAc,EAAE,iBAAiB,CAC/B,UAAU,EACV,QAAQ,EACR;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,WAAW,CAAA;KAAE,EACxC,IAAI,EACJ,IAAI,CACL,CAAC;IACF,cAAc,EAAE,iBAAiB,CAC/B,UAAU,EACV,QAAQ,EACR;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,OAAO,CAAA;KAAE,EAC1C;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,EACxC,IAAI,CACL,CAAC;IACF,YAAY,EAAE,iBAAiB,CAC7B,OAAO,EACP,QAAQ,EACR;QACE,cAAc,EAAE,iBAAiB,CAAC;QAClC,OAAO,EAAE,MAAM,CAAC;QAChB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,IAAI,CAAC,EAAE,WAAW,CAAC;KACpB,EACD,gBAAgB,CAAC,eAAe,CAAC,EACjC,IAAI,CACL,CAAC;IACF,aAAa,EAAE,iBAAiB,CAC9B,UAAU,EACV,QAAQ,EACR;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,eAAe,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAC3D,MAAM,EACN,IAAI,CACL,CAAC;IACF,aAAa,EAAE,iBAAiB,CAC9B,UAAU,EACV,QAAQ,EACR;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EACnC,IAAI,EACJ,IAAI,CACL,CAAC;IACF,aAAa,EAAE,iBAAiB,CAC9B,UAAU,EACV,QAAQ,EACR;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,EACrB,IAAI,EACJ,IAAI,CACL,CAAC;IACF,cAAc,EAAE,iBAAiB,CAC/B,UAAU,EACV,QAAQ,EACR;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,OAAO,CAAA;KAAE,EAC5C;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,EACtC,IAAI,CACL,CAAC;CACH"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/client/api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EACV,WAAW,EACX,SAAS,EACT,SAAS,EACT,WAAW,EACX,eAAe,EACf,aAAa,EACb,oBAAoB,EACrB,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;;OAKG;IACH,cAAc,EAAE,iBAAiB,CAAC;IAElC;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC;IAEpB,iDAAiD;IACjD,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;;;OAIG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,oEAAoE;IACpE,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,uEAAuE;IACvE,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC;IAEpB,4CAA4C;IAC5C,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IAEjB;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,mCAAmC;IACnC,IAAI,EAAE,SAAS,CAAC;IAEhB,mBAAmB;IACnB,KAAK,EAAE,MAAM,CAAC;IAEd,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,uBAAuB;IACvB,OAAO,EAAE,MAAM,CAAC;IAEhB,kCAAkC;IAClC,KAAK,EAAE,MAAM,CAAC;IAEd,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,wCAAwC;IACxC,OAAO,EAAE,MAAM,CAAC;IAEhB,+BAA+B;IAC/B,MAAM,EAAE,WAAW,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;OAQG;IACH,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,gDAAgD;IAChD,MAAM,EAAE,OAAO,CAAC;IAEhB,6CAA6C;IAC7C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,wCAAwC;IACxC,cAAc,EAAE,iBAAiB,CAAC;IAElC,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,oCAAoC;IACpC,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,uBAAuB;IACvB,SAAS,EAAE,MAAM,CAAC;IAElB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,8BAA8B;IAC9B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,8CAA8C;IAC9C,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;OAOG;IACH,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,8CAA8C;IAC9C,MAAM,EAAE,OAAO,CAAC;IAEhB,6CAA6C;IAC7C,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,WAAW,iBAAiB,CAChC,IAAI,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EACpD,eAAe,GAAG,KAAK;IAEvB,6CAA6C;IAC7C,WAAW,EAAE,iBAAiB,CAC5B,OAAO,EACP,QAAQ,EACR,eAAe,EACf,gBAAgB,CAAC,aAAa,CAAC,EAC/B,IAAI,CACL,CAAC;IAEF,0DAA0D;IAC1D,QAAQ,EAAE,iBAAiB,CACzB,OAAO,EACP,QAAQ,EACR,YAAY,EACZ,aAAa,GAAG,IAAI,EACpB,IAAI,CACL,CAAC;IAEF,uCAAuC;IACvC,aAAa,EAAE,iBAAiB,CAC9B,OAAO,EACP,QAAQ,EACR,iBAAiB,EACjB,aAAa,EAAE,EACf,IAAI,CACL,CAAC;IAEF,gDAAgD;IAChD,kBAAkB,EAAE,iBAAiB,CACnC,OAAO,EACP,QAAQ,EACR,sBAAsB,EACtB,oBAAoB,EACpB,IAAI,CACL,CAAC;IAEF,4EAA4E;IAC5E,WAAW,EAAE,iBAAiB,CAC5B,UAAU,EACV,QAAQ,EACR,eAAe,EACf,MAAM,GAAG,eAAe,EACxB,IAAI,CACL,CAAC;IAEF,4EAA4E;IAC5E,WAAW,EAAE,iBAAiB,CAC5B,UAAU,EACV,QAAQ,EACR,eAAe,EACf,IAAI,GAAG,eAAe,EACtB,IAAI,CACL,CAAC;IAEF,0EAA0E;IAC1E,cAAc,EAAE,iBAAiB,CAC/B,UAAU,EACV,QAAQ,EACR,kBAAkB,EAClB,IAAI,GAAG,eAAe,EACtB,IAAI,CACL,CAAC;IAEF,6EAA6E;IAC7E,cAAc,EAAE,iBAAiB,CAC/B,UAAU,EACV,QAAQ,EACR,kBAAkB,EAClB,oBAAoB,GAAG,eAAe,EACtC,IAAI,CACL,CAAC;IAEF,0DAA0D;IAC1D,YAAY,EAAE,iBAAiB,CAC7B,OAAO,EACP,QAAQ,EACR,gBAAgB,EAChB,gBAAgB,CAAC,eAAe,CAAC,EACjC,IAAI,CACL,CAAC;IAEF,2EAA2E;IAC3E,aAAa,EAAE,iBAAiB,CAC9B,UAAU,EACV,QAAQ,EACR,iBAAiB,EACjB,MAAM,GAAG,eAAe,EACxB,IAAI,CACL,CAAC;IAEF,8EAA8E;IAC9E,aAAa,EAAE,iBAAiB,CAC9B,UAAU,EACV,QAAQ,EACR,iBAAiB,EACjB,IAAI,GAAG,eAAe,EACtB,IAAI,CACL,CAAC;IAEF,4EAA4E;IAC5E,aAAa,EAAE,iBAAiB,CAC9B,UAAU,EACV,QAAQ,EACR,iBAAiB,EACjB,IAAI,GAAG,eAAe,EACtB,IAAI,CACL,CAAC;IAEF,6EAA6E;IAC7E,cAAc,EAAE,iBAAiB,CAC/B,UAAU,EACV,QAAQ,EACR,kBAAkB,EAClB,oBAAoB,GAAG,eAAe,EACtC,IAAI,CACL,CAAC;CACH"}

package/dist/client/config.d.ts

@@ -1,36 +1,175 @@
 import type { CommentSort, EntryKind, EntrySort, EntryStatus } from "../component/model.js";
+/**
+ * Entry-related component configuration.
+ */
+export interface FeedbackEntriesConfig {
+    /**
+     * Entry kinds that may be created through this component instance.
+     *
+     * @default ["feedback", "feature_request", "bug_report"]
+     */
+    enabledKinds: readonly EntryKind[];
+    /**
+     * Status assigned to newly created entries.
+     *
+     * @default "open"
+     */
+    defaultStatus: EntryStatus;
+    /**
+     * Default server-side entry ordering when callers do not specify `sort`.
+     *
+     * @default "top"
+     */
+    defaultSort: EntrySort;
+    /**
+     * Maximum number of entries a caller may request in one pagination batch.
+     *
+     * Larger requested page sizes are clamped to this value.
+     *
+     * @default 50
+     */
+    maxPageSize: number;
+    /**
+     * Whether entry authors may edit their own title and body.
+     *
+     * Moderators are governed separately by the resolved actor permissions.
+     *
+     * @default true
+     */
+    editableByAuthor: boolean;
+}
+/**
+ * Comment and reply configuration.
+ */
+export interface FeedbackCommentsConfig {
+    /**
+     * Maximum allowed nesting depth.
+     *
+     * Top-level comments have depth `0`. Attempts to create replies deeper than
+     * this limit are rejected by the component.
+     *
+     * @default 5
+     */
+    maxDepth: number;
+    /**
+     * Maximum number of comments or replies that may be requested in one
+     * pagination batch.
+     *
+     * @default 50
+     */
+    maxPageSize: number;
+    /**
+     * Default server-side comment ordering.
+     *
+     * @default "top"
+     */
+    defaultSort: CommentSort;
+    /**
+     * Whether comment authors may edit their own comments.
+     *
+     * @default true
+     */
+    editableByAuthor: boolean;
+    /**
+     * Whether comment authors may soft-delete their own comments.
+     *
+     * Deletion preserves the document so nested replies retain their structure.
+     *
+     * @default true
+     */
+    deletableByAuthor: boolean;
+}
+/**
+ * Full-text search and duplicate-detection configuration.
+ */
+export interface FeedbackSearchConfig {
+    /**
+     * Whether similar/duplicate suggestions are enabled.
+     *
+     * When disabled, duplicate-search queries return empty `exact` and
+     * `similar` arrays.
+     *
+     * @default true
+     */
+    duplicateSuggestions: boolean;
+    /**
+     * Default combined result limit for duplicate suggestions when the caller
+     * does not provide `limit`.
+     *
+     * Exact matches consume this limit before similar matches.
+     *
+     * @default 5
+     */
+    duplicateSuggestionLimit: number;
+    /**
+     * Default result limit for normal full-text entry search.
+     *
+     * @default 20
+     */
+    defaultLimit: number;
+    /**
+     * Maximum allowed result limit for search and duplicate queries.
+     *
+     * Larger requested limits are clamped to this value.
+     *
+     * @default 50
+     */
+    maxLimit: number;
+}
+/**
+ * Maximum lengths accepted for user-generated content.
+ */
+export interface FeedbackContentLimits {
+    /**
+     * Maximum entry-title length.
+     *
+     * @default 160
+     */
+    titleLength: number;
+    /**
+     * Maximum entry-body length.
+     *
+     * @default 10000
+     */
+    bodyLength: number;
+    /**
+     * Maximum comment/reply length.
+     *
+     * @default 5000
+     */
+    commentLength: number;
+}
+/**
+ * Complete server-side configuration for a feedback component instance.
+ *
+ * Configuration is supplied by the host application and is not persisted in
+ * an additional component table.
+ */
 export interface FeedbackConfig {
-    entries: {
-        enabledKinds: readonly EntryKind[];
-        defaultStatus: EntryStatus;
-        defaultSort: EntrySort;
-        maxPageSize: number;
-        editableByAuthor: boolean;
-    };
-    comments: {
-        maxDepth: number;
-        maxPageSize: number;
-        defaultSort: CommentSort;
-        editableByAuthor: boolean;
-        deletableByAuthor: boolean;
-    };
-    search: {
-        duplicateSuggestions: boolean;
-        duplicateSuggestionLimit: number;
-        defaultLimit: number;
-        maxLimit: number;
-    };
-    limits: {
-        titleLength: number;
-        bodyLength: number;
-        commentLength: number;
-    };
+    /** Entry creation, ordering, pagination, and editing rules. */
+    entries: FeedbackEntriesConfig;
+    /** Comment nesting, ordering, pagination, and editing rules. */
+    comments: FeedbackCommentsConfig;
+    /** Search and duplicate-detection behavior. */
+    search: FeedbackSearchConfig;
+    /** User-generated content limits. */
+    limits: FeedbackContentLimits;
 }
+/**
+ * Partial configuration accepted by `createFeedbackConfig` and
+ * `exposeFeedbackApi`.
+ *
+ * Missing values fall back to `defaultFeedbackConfig`.
+ */
 export interface FeedbackConfigOverrides {
-    entries?: Partial<FeedbackConfig["entries"]>;
-    comments?: Partial<FeedbackConfig["comments"]>;
-    search?: Partial<FeedbackConfig["search"]>;
-    limits?: Partial<FeedbackConfig["limits"]>;
+    /** Overrides for entry configuration. */
+    entries?: Partial<FeedbackEntriesConfig>;
+    /** Overrides for comment configuration. */
+    comments?: Partial<FeedbackCommentsConfig>;
+    /** Overrides for search configuration. */
+    search?: Partial<FeedbackSearchConfig>;
+    /** Overrides for content limits. */
+    limits?: Partial<FeedbackContentLimits>;
 }
 export declare const defaultFeedbackConfig: FeedbackConfig;
 export declare function createFeedbackConfig(overrides?: FeedbackConfigOverrides): FeedbackConfig;

package/dist/client/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/client/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,SAAS,EACT,SAAS,EACT,WAAW,EACZ,MAAM,uBAAuB,CAAC;AAE/B,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE;QACP,YAAY,EAAE,SAAS,SAAS,EAAE,CAAC;QACnC,aAAa,EAAE,WAAW,CAAC;QAC3B,WAAW,EAAE,SAAS,CAAC;QACvB,WAAW,EAAE,MAAM,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;IACF,QAAQ,EAAE;QACR,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,EAAE,WAAW,CAAC;QACzB,gBAAgB,EAAE,OAAO,CAAC;QAC1B,iBAAiB,EAAE,OAAO,CAAC;KAC5B,CAAC;IACF,MAAM,EAAE;QACN,oBAAoB,EAAE,OAAO,CAAC;QAC9B,wBAAwB,EAAE,MAAM,CAAC;QACjC,YAAY,EAAE,MAAM,CAAC;QACrB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,MAAM,EAAE;QACN,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,EAAE,MAAM,CAAC;QACnB,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC;CACH;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC;IAC7C,QAAQ,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;IAC/C,MAAM,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC3C,MAAM,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;CAC5C;AAED,eAAO,MAAM,qBAAqB,EAAE,cA0BnC,CAAC;AAEF,wBAAgB,oBAAoB,CAClC,SAAS,GAAE,uBAA4B,GACtC,cAAc,CAOhB"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/client/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,SAAS,EACT,SAAS,EACT,WAAW,EACZ,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,YAAY,EAAE,SAAS,SAAS,EAAE,CAAC;IAEnC;;;;OAIG;IACH,aAAa,EAAE,WAAW,CAAC;IAE3B;;;;OAIG;IACH,WAAW,EAAE,SAAS,CAAC;IAEvB;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,gBAAgB,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;;;OAOG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;;;OAIG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;;;;;OAMG;IACH,iBAAiB,EAAE,OAAO,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;;;OAOG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;;;;;;OAOG;IACH,wBAAwB,EAAE,MAAM,CAAC;IAEjC;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,+DAA+D;IAC/D,OAAO,EAAE,qBAAqB,CAAC;IAE/B,gEAAgE;IAChE,QAAQ,EAAE,sBAAsB,CAAC;IAEjC,+CAA+C;IAC/C,MAAM,EAAE,oBAAoB,CAAC;IAE7B,qCAAqC;IACrC,MAAM,EAAE,qBAAqB,CAAC;CAC/B;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC,yCAAyC;IACzC,OAAO,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAEzC,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAE3C,0CAA0C;IAC1C,MAAM,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEvC,oCAAoC;IACpC,MAAM,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;CACzC;AAED,eAAO,MAAM,qBAAqB,EAAE,cA0BnC,CAAC;AAEF,wBAAgB,oBAAoB,CAClC,SAAS,GAAE,uBAA4B,GACtC,cAAc,CAOhB"}

package/dist/client/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/client/config.ts"],"names":[],"mappings":"AA0CA,MAAM,CAAC,MAAM,qBAAqB,GAAmB;IACnD,OAAO,EAAE;QACP,YAAY,EAAE,CAAC,UAAU,EAAE,iBAAiB,EAAE,YAAY,CAAC;QAC3D,aAAa,EAAE,MAAM;QACrB,WAAW,EAAE,KAAK;QAClB,WAAW,EAAE,EAAE;QACf,gBAAgB,EAAE,IAAI;KACvB;IACD,QAAQ,EAAE;QACR,QAAQ,EAAE,CAAC;QACX,WAAW,EAAE,EAAE;QACf,WAAW,EAAE,KAAK;QAClB,gBAAgB,EAAE,IAAI;QACtB,iBAAiB,EAAE,IAAI;KACxB;IACD,MAAM,EAAE;QACN,oBAAoB,EAAE,IAAI;QAC1B,wBAAwB,EAAE,CAAC;QAC3B,YAAY,EAAE,EAAE;QAChB,QAAQ,EAAE,EAAE;KACb;IACD,MAAM,EAAE;QACN,WAAW,EAAE,GAAG;QAChB,UAAU,EAAE,MAAM;QAClB,aAAa,EAAE,KAAK;KACrB;CACF,CAAC;AAEF,MAAM,UAAU,oBAAoB,CAClC,YAAqC,EAAE;IAEvC,OAAO;QACL,OAAO,EAAE,EAAE,GAAG,qBAAqB,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,OAAO,EAAE;QACnE,QAAQ,EAAE,EAAE,GAAG,qBAAqB,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,QAAQ,EAAE;QACtE,MAAM,EAAE,EAAE,GAAG,qBAAqB,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE;QAChE,MAAM,EAAE,EAAE,GAAG,qBAAqB,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE;KACjE,CAAC;AACJ,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/client/config.ts"],"names":[],"mappings":"AA4MA,MAAM,CAAC,MAAM,qBAAqB,GAAmB;IACnD,OAAO,EAAE;QACP,YAAY,EAAE,CAAC,UAAU,EAAE,iBAAiB,EAAE,YAAY,CAAC;QAC3D,aAAa,EAAE,MAAM;QACrB,WAAW,EAAE,KAAK;QAClB,WAAW,EAAE,EAAE;QACf,gBAAgB,EAAE,IAAI;KACvB;IACD,QAAQ,EAAE;QACR,QAAQ,EAAE,CAAC;QACX,WAAW,EAAE,EAAE;QACf,WAAW,EAAE,KAAK;QAClB,gBAAgB,EAAE,IAAI;QACtB,iBAAiB,EAAE,IAAI;KACxB;IACD,MAAM,EAAE;QACN,oBAAoB,EAAE,IAAI;QAC1B,wBAAwB,EAAE,CAAC;QAC3B,YAAY,EAAE,EAAE;QAChB,QAAQ,EAAE,EAAE;KACb;IACD,MAAM,EAAE;QACN,WAAW,EAAE,GAAG;QAChB,UAAU,EAAE,MAAM;QAClB,aAAa,EAAE,KAAK;KACrB;CACF,CAAC;AAEF,MAAM,UAAU,oBAAoB,CAClC,YAAqC,EAAE;IAEvC,OAAO;QACL,OAAO,EAAE,EAAE,GAAG,qBAAqB,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,OAAO,EAAE;QACnE,QAAQ,EAAE,EAAE,GAAG,qBAAqB,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,QAAQ,EAAE;QACtE,MAAM,EAAE,EAAE,GAAG,qBAAqB,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE;QAChE,MAAM,EAAE,EAAE,GAAG,qBAAqB,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE;KACjE,CAAC;AACJ,CAAC"}