@veltdev/types 6.0.0-beta.11 → 6.0.0-beta.13

package/app/models/data/suggestion.data.model.d.ts

@@ -98,8 +98,24 @@ export interface TargetEditDetails<T = unknown> {
  * auto-commit so a subscriber to `targetEditCommit` can drive it explicitly.
  */
 export interface TargetEditCommitResult {
-    /** Override the SDK's default `${targetId}: ${old} → ${new}` summary. */
+    /**
+     * Override the SDK's default diff summary (`Replace: "{old}" with "{new}"`;
+     * `Add:`/`Remove:` when one side is absent; a per-key op list when both
+     * values are plain objects). When provided without `summaryHtml`, it is
+     * used for BOTH the plain `commentText` and (escaped) the `commentHtml`
+     * of the seeded first comment.
+     */
     summary?: string;
+    /**
+     * Optional HTML version of the summary, used as the `commentHtml` of the
+     * suggestion's seeded first comment (the plain `summary` — or the SDK's
+     * default diff summary — stays in `commentText`). When BOTH are omitted,
+     * the SDK renders a default styled HTML diff (old/removed values in red
+     * italic, new/added values in green italic). Sanitized with DOMPurify at
+     * render time — script/event-handler content is stripped; inline `style`
+     * attributes are preserved.
+     */
+    summaryHtml?: string;
     /** Customer metadata persisted on the resulting Suggestion. */
     metadata?: Record<string, unknown>;
 }
@@ -134,6 +150,24 @@ export interface EnableSuggestionModeConfig {
      * to event subscribers.
      */
     onTargetEditCommit?: TargetEditCommitHandler;
+    /**
+     * When active AND no `onTargetEditCommit` handler is provided, every
+     * detected commit auto-commits with the SDK's default summary/summaryHtml
+     * (equivalent to a handler returning `{}`).
+     *
+     * **Default: true** — a bare `enableSuggestionMode()` turns edits into
+     * suggestions with zero config. Pass `autoCommit: false` for detect-only
+     * mode (events fire, nothing commits until a subscriber calls the event's
+     * `commitSuggestion` builder).
+     *
+     * A provided `onTargetEditCommit` handler always wins — including its
+     * null-return deferral contract — so handler-based integrations are
+     * unaffected. The `targetEditCommit` event still fires; its pre-bound
+     * `commitSuggestion` builder becomes a no-op for edits already
+     * auto-committed by this flag (same double-commit guard as the handler
+     * path).
+     */
+    autoCommit?: boolean;
 }
 /**
  * SDK-managed suggestion data persisted on a CommentAnnotation.
@@ -245,8 +279,24 @@ export interface CommitSuggestionConfig<T = unknown> {
     targetId: string;
     /** Any JSON-serializable value. Customer's apply handler interprets it. */
     newValue: T;
-    /** Optional human-readable string for logs and notifications. */
+    /**
+     * Optional human-readable string for logs and notifications. When provided
+     * without `summaryHtml`, it is used for BOTH the seeded comment's plain
+     * `commentText` and (escaped) its `commentHtml`. When omitted, the seeded
+     * comment falls back to the SDK's default diff summary
+     * (`Replace: "{old}" with "{new}"`; `Add:`/`Remove:` when one side is
+     * absent; a per-key op list when both values are plain objects).
+     */
     summary?: string;
+    /**
+     * Optional HTML version of the summary — becomes the `commentHtml` of the
+     * suggestion's seeded first comment (plain `summary` or the default diff
+     * summary stays in `commentText`). When BOTH are omitted, the SDK renders
+     * a default styled HTML diff (old/removed values in red italic, new/added
+     * values in green italic). Sanitized with DOMPurify at render time; inline
+     * `style` attributes are preserved so rich diff styling survives.
+     */
+    summaryHtml?: string;
     /** Optional customer-defined metadata. Stored on Suggestion.metadata. */
     metadata?: Record<string, unknown>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/types",
-    "version": "6.0.0-beta.11",
+    "version": "6.0.0-beta.13",
     "description": "Velt is an SDK to add collaborative features to your product within minutes. Example: Comments like Figma, Frame.io, Google docs or sheets, Recording like Loom, Huddles like Slack and much more.",
     "homepage": "https://velt.dev",
     "keywords": [