@veltdev/types-dev 6.0.20 → 6.0.21

package/app/models/data/comment-resolver.data.model.d.ts

@@ -3,6 +3,7 @@ import { PartialAttachment } from "./attachment-resolver.data.model";
 import { BaseMetadata } from "./base-metadata.data.model";
 import { CommentAnnotation } from "./comment-annotation.data.model";
 import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
+import { SuggestionData } from "./suggestion.data.model";
 export interface CommentAnnotationDataProvider {
     get?: (request: GetCommentResolverRequest) => Promise<ResolverResponse<Record<string, PartialCommentAnnotation>>>;
     save?: (request: SaveCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
@@ -29,6 +30,11 @@ export interface SaveCommentResolverRequest {
      * The save event. One of the 4 core PII events (`ResolverActions`) or, when the customer
      * opts in via `ResolverConfig.additionalSaveEvents`, a non-core annotation-level event
      * (`CommentResolverSaveEvent`). See specs/comment-resolver iteration-2.
+     *
+     * Exception (comment-resolver iteration-3): `comment_annotation.suggestion_reject` is sent WITHOUT
+     * opt-in whenever the annotation carries a `suggestion` — it is the only suggestion transition that
+     * carries new content (`rejectReason`). A backend must answer 2xx and upsert for ANY event value,
+     * and an event name alone never means "apply the change": read `suggestion.status`.
      */
     event?: ResolverActions | CommentResolverSaveEvent;
     metadata?: BaseMetadata;
@@ -73,6 +79,13 @@ export interface PartialCommentAnnotationResult {
      * `CommonDbUtilsService` forwards it to the Velt-DB filter as `keepContextText`.
      */
     veltCopyKeepsContextText?: boolean;
+    /**
+     * INTERNAL (SDK write path only, never sent to a resolver). True when `originalData.suggestion`
+     * still carries its content keys on purpose (comment-resolver AC-032): a legacy row whose resolver
+     * copy does not hold them yet and this save is not a core hand-off. Forwarded by
+     * `CommonDbUtilsService` to the Velt-DB filter as `keepSuggestionContent`.
+     */
+    veltCopyKeepsSuggestionContent?: boolean;
 }
 export interface PartialTargetTextRange {
     text: string;
@@ -103,5 +116,14 @@ export interface PartialCommentAnnotation {
     };
     targetTextRange?: PartialTargetTextRange;
     resolvedByUserId?: string | null;
+    /**
+     * The suggestion (comment-resolver iteration-3) — present when the annotation carries one. Its
+     * content keys (`oldValue`, `newValue`, `summary`, `rejectReason`) are PII: they live only here,
+     * never in Velt. When sent it is always COMPLETE (the content your store already holds plus this
+     * write), so a backend may replace the stored value wholesale. `resolvedBy` may be `{ userId }`
+     * under a user resolver. On `get`, only the content keys are read back — Velt stays authoritative
+     * for `status`, `resolvedBy` and `resolvedAt`. Backends must persist and return it.
+     */
+    suggestion?: Partial<SuggestionData>;
     [key: string]: any;
 }

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

@@ -116,7 +116,7 @@ export interface TargetEditCommitResult {
      * attributes are preserved.
      */
     summaryHtml?: string;
-    /** Customer metadata persisted on the resulting Suggestion. */
+    /** Customer metadata persisted on the resulting suggestion (`Suggestion.metadata`). */
     metadata?: Record<string, unknown>;
 }
 /**
@@ -204,6 +204,11 @@ export interface SuggestionData {
      */
     resolvedBy: User | null;
     resolvedAt: number | null;
+    /**
+     * Customer metadata from `CommitSuggestionConfig.metadata` (a JSON clone; absent when none was given).
+     * Self-hosting: content — with a comment resolver it is stored by the resolver only.
+     */
+    metadata?: Record<string, unknown>;
 }
 /**
  * Fields shared across every Suggestion regardless of status.
@@ -222,7 +227,10 @@ interface SuggestionBase<T = unknown> {
     newValue: T;
     /** Optional human-readable description. */
     summary: string | null;
-    /** Customer-defined metadata supplied via CommitSuggestionConfig.metadata. */
+    /**
+     * Customer-defined metadata supplied via CommitSuggestionConfig.metadata (always an object;
+     * `{}` when none was given). Contains only the customer's keys.
+     */
     metadata: Record<string, any>;
     /** True iff the live value at approve time differed from oldValue. */
     driftDetected: boolean;
@@ -297,7 +305,11 @@ export interface CommitSuggestionConfig<T = unknown> {
      * `style` attributes are preserved so rich diff styling survives.
      */
     summaryHtml?: string;
-    /** Optional customer-defined metadata. Stored on Suggestion.metadata. */
+    /**
+     * Optional customer-defined metadata (a plain JSON object). Stored on the suggestion
+     * (`annotation.suggestion.metadata`) and returned as `Suggestion.metadata`. With a comment
+     * resolver (self-hosting) it is stored by the resolver only.
+     */
     metadata?: Record<string, unknown>;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/types-dev",
-    "version": "6.0.20",
+    "version": "6.0.21",
     "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": [