@veltdev/sdk-staging 5.0.3 → 5.0.4

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

@@ -15,6 +15,13 @@ import { CommentAnnotationViews } from "./views.data.model";
 export interface CommentAnnotationVisibilityConfig {
     type: CommentVisibilityType;
     organizationId?: string;
+    /** Organization IDs for 'organizationPrivate' visibility — mirrors CommentVisibilityConfig.organizationIds (display-only). */
+    organizationIds?: string[];
+    /**
+     * User IDs that can see the comment (display-only mirror of the self tokens in
+     * `context.accessFields`). For non-public comments this ALWAYS includes the author's
+     * userId, reflecting the author self-token invariant (AC-002).
+     */
     userIds?: string[];
 }
 /**

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

@@ -1,4 +1,4 @@
-import { ResolverActions } from "../../utils/enums";
+import { ResolverActions, CommentResolverSaveEvent } from "../../utils/enums";
 import { PartialAttachment } from "./attachment-resolver.data.model";
 import { BaseMetadata } from "./base-metadata.data.model";
 import { CommentAnnotation } from "./comment-annotation.data.model";
@@ -25,9 +25,21 @@ export interface SaveCommentResolverRequest {
     commentAnnotation: {
         [key: string]: PartialCommentAnnotation;
     };
-    event?: ResolverActions;
+    /**
+     * 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.
+     */
+    event?: ResolverActions | CommentResolverSaveEvent;
     metadata?: BaseMetadata;
     commentId?: string;
+    /**
+     * The comment the action occurred on, resolved from `commentId` against the
+     * payload's `commentAnnotation[*].comments` map. Convenience field so the
+     * customer backend does not have to re-derive the target comment from
+     * `commentId`. Omitted when `commentId` is absent or no matching comment is found.
+     */
+    targetComment?: PartialComment;
 }
 export interface PartialUser {
     userId: string;
@@ -53,7 +65,7 @@ export interface PartialCommentAnnotationResult {
         [annotationId: string]: PartialCommentAnnotation;
     } | null;
     originalData: CommentAnnotation | null;
-    eventType?: ResolverActions;
+    eventType?: ResolverActions | CommentResolverSaveEvent;
 }
 export interface PartialTargetTextRange {
     text: string;

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

@@ -1,6 +1,20 @@
+import { CommentResolverSaveEvent } from "../../utils/enums";
 export interface ResolverEndpointConfig {
     url: string;
-    headers?: Record<string, string>;
+    /**
+     * Request headers. Either a static object (captured once) OR an async function
+     * resolved on EVERY request — use the function form to forward a short-lived
+     * per-user token (re-evaluated per retry attempt, so each retry gets a fresh token).
+     */
+    headers?: Record<string, string> | (() => Promise<Record<string, string>>);
+    /**
+     * Forwarded to `fetch()` so cookie/session auth works for resolver endpoints.
+     * When unset the `credentials` key is omitted from the request, so `fetch` keeps
+     * its browser default of `'same-origin'` — byte-identical to the prior behavior
+     * (same-origin cookies are still sent). Set `'include'` for cross-origin cookie/
+     * session auth, or `'omit'` to explicitly suppress credentials.
+     */
+    credentials?: 'include' | 'same-origin' | 'omit';
 }
 export interface ResolverConfig {
     resolveTimeout?: number;
@@ -10,10 +24,21 @@ export interface ResolverConfig {
     resolveUsersConfig?: ResolveUsersConfig;
     fieldsToRemove?: string[];
     additionalFields?: string[];
+    /**
+     * Opt-in list of additional (non-core) annotation-level save events the customer
+     * wants delivered to the existing save endpoint, beyond the 4 core PII events
+     * (add/update/delete). Each entry's `event` is a `CommentResolverSaveEvent`.
+     * Array-of-objects for forward-extensibility. Absent/empty ⇒ iteration-1 behavior
+     * (no extra events) — see specs/comment-resolver iteration-2.
+     */
+    additionalSaveEvents?: AdditionalSaveEventConfig[];
     getConfig?: ResolverEndpointConfig;
     saveConfig?: ResolverEndpointConfig;
     deleteConfig?: ResolverEndpointConfig;
 }
+export interface AdditionalSaveEventConfig {
+    event: CommentResolverSaveEvent;
+}
 export interface ResolveUsersConfig {
     organization?: boolean;
     folder?: boolean;

package/app/utils/enums.d.ts

@@ -33,6 +33,31 @@ export declare enum ResolverActions {
     RECORDER_ANNOTATION_DELETE = "recorder_annotation.delete",
     ACTIVITY_SAVE = "activity.save"
 }
+/**
+ * Opt-in additional (non-core) comment save events for the Comment Annotations Resolver
+ * (specs/comment-resolver iteration-2). Values mirror the non-core `CommentActivityActionTypes`
+ * (single source of truth — enforced by a unit test). A self-hosting customer lists these in
+ * `ResolverConfig.additionalSaveEvents` to also receive annotation-level events (status change,
+ * priority change, assign, …) on the existing save endpoint. The 4 core events keep using
+ * `ResolverActions`. Kept in enums.ts (a leaf module) to avoid a
+ * resolver.data.model ↔ comment-resolver.data.model import cycle.
+ */
+export declare enum CommentResolverSaveEvent {
+    STATUS_CHANGE = "comment_annotation.status_change",
+    PRIORITY_CHANGE = "comment_annotation.priority_change",
+    ASSIGN = "comment_annotation.assign",
+    ACCESS_MODE_CHANGE = "comment_annotation.access_mode_change",
+    CUSTOM_LIST_CHANGE = "comment_annotation.custom_list_change",
+    APPROVE = "comment_annotation.approve",
+    ACCEPT = "comment.accept",
+    REJECT = "comment.reject",
+    SUGGESTION_ACCEPT = "comment_annotation.suggestion_accept",
+    SUGGESTION_REJECT = "comment_annotation.suggestion_reject",
+    REACTION_ADD = "comment.reaction_add",
+    REACTION_DELETE = "comment.reaction_delete",
+    SUBSCRIBE = "comment_annotation.subscribe",
+    UNSUBSCRIBE = "comment_annotation.unsubscribe"
+}
 export declare const CommentEventTypes: {
     readonly ADD_COMMENT_ANNOTATION: "addCommentAnnotation";
     readonly ADD_COMMENT_ANNOTATION_DRAFT: "addCommentAnnotationDraft";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk-staging",
-    "version": "5.0.3",
+    "version": "5.0.4",
     "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": [