@veltdev/sdk-dev 6.0.0-beta.1 → 6.0.0-beta.11

package/app/client/snippyly.model.d.ts

@@ -1,9 +1,8 @@
-// @ts-nocheck
 import { Observable } from "rxjs";
 import { Config, DisableLogsConfig } from "../models/data/config.data.model";
 import { DocumentUser } from "../models/data/document-user.data.model";
 import { Location } from "../models/data/location.model";
-import { User, UserOptions, VeltAuthProvider, VeltPermissionProvider } from "../models/data/user.data.model";
+import { User, Options, VeltAuthProvider, VeltPermissionProvider } from "../models/data/user.data.model";
 import { CustomCss } from "../models/data/custom-css.data.model";
 import { ActivityElement } from "../models/element/activity-element.model";
 import { AreaElement } from "../models/element/area-element.model";
@@ -40,7 +39,7 @@ import { HeartbeatConfig, Heartbeat, GetHeartbeatResponse } from "../models/data
 export declare class Snippyly {
    constructor();
    initConfig: (apiKey: string, config?: Config) => void;
-   identify: (user: User, userOptions?: UserOptions) => Promise<unknown>;
+   identify: (user: User, userOptions?: Options) => Promise<unknown>;
    setVeltAuthProvider: (veltAuthProvider: VeltAuthProvider) => Promise<User | null>;
    /**
     * Tell us who the currently logged in user is.

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-events.data.model.d.ts

@@ -89,6 +89,10 @@ export type CommentEventTypesMap = {
     [CommentEventTypes.COMMENT_TOOL_CLICKED]: CommentToolClickedEvent;
     [CommentEventTypes.SIDEBAR_BUTTON_CLICK]: SidebarButtonClickEvent;
     [CommentEventTypes.SIDEBAR_BUTTON_CLICKED]: SidebarButtonClickedEvent;
+    [CommentEventTypes.SIDEBAR_OPEN]: SidebarOpenEvent;
+    [CommentEventTypes.SIDEBAR_CLOSE]: SidebarCloseEvent;
+    [CommentEventTypes.COMMENT_CLICK]: CommentClickEvent;
+    [CommentEventTypes.COMMENT_NAVIGATION_BUTTON_CLICK]: CommentNavigationButtonClickEvent;
     [CommentEventTypes.ATTACHMENT_DOWNLOAD_CLICKED]: AttachmentDownloadClickedEvent;
     [CommentEventTypes.COMMENT_SAVED]: CommentSavedEvent;
     [CommentEventTypes.COMMENT_SAVE_TRIGGERED]: CommentSaveTriggeredEvent;
@@ -347,6 +351,31 @@ export interface SidebarButtonClickEvent {
 }
 export interface SidebarButtonClickedEvent extends SidebarButtonClickEvent {
 }
+/** Fired when the comment sidebar opens. Subscribe via `commentElement.on('sidebarOpen')`. */
+export interface SidebarOpenEvent {
+    metadata?: VeltEventMetadata;
+}
+/** Fired when the comment sidebar closes. Subscribe via `commentElement.on('sidebarClose')`. */
+export interface SidebarCloseEvent {
+    metadata?: VeltEventMetadata;
+}
+/** Fired when a comment is clicked in the sidebar list. Subscribe via `commentElement.on('commentClick')`. */
+export interface CommentClickEvent {
+    documentId?: string | null;
+    location?: Location | null;
+    targetElementId?: string | null;
+    context?: {
+        [key: string]: any;
+    };
+    annotation?: CommentAnnotation;
+    metadata?: VeltEventMetadata;
+}
+/**
+ * Fired when the navigation ("go to") button on a sidebar comment is clicked.
+ * Subscribe via `commentElement.on('commentNavigationButtonClick')`.
+ */
+export interface CommentNavigationButtonClickEvent extends CommentClickEvent {
+}
 export interface AttachmentDownloadClickedEvent {
     annotationId: string;
     commentAnnotation: CommentAnnotation;

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/models/data/selection.model.d.ts

@@ -21,14 +21,16 @@ export declare class Selection {
     pageInfo: PageInfo;
     timestamp: number;
 }
-export declare enum UserIndicatorPosition {
-    Start = "start",
-    End = "end"
-}
-export declare enum UserIndicatorType {
-    Avatar = "avatar",
-    Label = "label"
-}
+export declare const UserIndicatorPosition: {
+    readonly Start: "start";
+    readonly End: "end";
+};
+export type UserIndicatorPosition = (typeof UserIndicatorPosition)[keyof typeof UserIndicatorPosition];
+export declare const UserIndicatorType: {
+    readonly Avatar: "avatar";
+    readonly Label: "label";
+};
+export type UserIndicatorType = (typeof UserIndicatorType)[keyof typeof UserIndicatorType];
 export declare class LiveSelectionData {
     [userIdHash: string]: Selection;
 }

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

@@ -61,12 +61,14 @@ export interface GetUserPermissionsResponse {
         };
     };
 }
-export declare enum UserPermissionAccessRole {
-    EDITOR = "editor",
-    VIEWER = "viewer"
-}
-export declare enum UserPermissionAccessRoleResult {
-    DOES_NOT_EXIST = "does_not_exist",
-    PERMISSION_DENIED = "permission_denied",
-    SOMETHING_WENT_WRONG = "something_went_wrong"
-}
+export declare const UserPermissionAccessRole: {
+    readonly EDITOR: "editor";
+    readonly VIEWER: "viewer";
+};
+export type UserPermissionAccessRole = (typeof UserPermissionAccessRole)[keyof typeof UserPermissionAccessRole];
+export declare const UserPermissionAccessRoleResult: {
+    readonly DOES_NOT_EXIST: "does_not_exist";
+    readonly PERMISSION_DENIED: "permission_denied";
+    readonly SOMETHING_WENT_WRONG: "something_went_wrong";
+};
+export type UserPermissionAccessRoleResult = (typeof UserPermissionAccessRoleResult)[keyof typeof UserPermissionAccessRoleResult];

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

@@ -125,18 +125,20 @@ export interface VeltAuthProvider {
     generateToken?: () => Promise<string>;
     onError?: (err: unknown) => void;
 }
-export declare enum RevokeAccessOnType {
-    DOCUMENT_UNSET = "document_unset",
-    USER_LOGOUT = "user_logout"
-}
-export declare enum PermissionSource {
-    SET_DOCUMENTS = "setDocuments",
-    IDENTIFY = "identify",
-    GET_NOTIFICATIONS = "getNotifications",
-    SET_NOTIFICATIONS = "setNotifications",
-    REVOKE_ACCESS_ON_USER_LOGOUT = "revokeAccessOnUserLogout",
-    REVOKE_ACCESS_ON_DOCUMENT_UNSET = "revokeAccessOnDocumentUnset"
-}
+export declare const RevokeAccessOnType: {
+    readonly DOCUMENT_UNSET: "document_unset";
+    readonly USER_LOGOUT: "user_logout";
+};
+export type RevokeAccessOnType = (typeof RevokeAccessOnType)[keyof typeof RevokeAccessOnType];
+export declare const PermissionSource: {
+    readonly SET_DOCUMENTS: "setDocuments";
+    readonly IDENTIFY: "identify";
+    readonly GET_NOTIFICATIONS: "getNotifications";
+    readonly SET_NOTIFICATIONS: "setNotifications";
+    readonly REVOKE_ACCESS_ON_USER_LOGOUT: "revokeAccessOnUserLogout";
+    readonly REVOKE_ACCESS_ON_DOCUMENT_UNSET: "revokeAccessOnDocumentUnset";
+};
+export type PermissionSource = (typeof PermissionSource)[keyof typeof PermissionSource];
 export interface RevokeAccessOn {
     type: RevokeAccessOnType;
     revokeOrganizationAccess?: boolean;
@@ -192,12 +194,13 @@ export interface PermissionResolverRequest {
         requests: PermissionQuery[];
     };
 }
-export declare enum PermissionResourceType {
-    FOLDER = "folder",
-    DOCUMENT = "document",
-    ORGANIZATION = "organization",
-    CONTEXT = "context"
-}
+export declare const PermissionResourceType: {
+    readonly FOLDER: "folder";
+    readonly DOCUMENT: "document";
+    readonly ORGANIZATION: "organization";
+    readonly CONTEXT: "context";
+};
+export type PermissionResourceType = (typeof PermissionResourceType)[keyof typeof PermissionResourceType];
 export interface PermissionQuery {
     userId: string;
     resource: {

package/app/models/element/activity-element.model.d.ts

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import { Observable } from "rxjs";
 import { ActivityRecord, ActivitySubscribeConfig, CreateActivityData } from "../data/activity.data.model";
 

package/app/models/element/area-element.model.d.ts

@@ -1,4 +1,3 @@
-// @ts-nocheck
 export declare class AreaElement {
     /**
      * To enable area feature

package/app/models/element/arrow-element.model.d.ts

@@ -1,10 +1,9 @@
-// @ts-nocheck
 export declare class ArrowElement {
     /**
      * To allow arrow in specific elements only
      * @param elementIds Element ids to be allowed for arrow
      */
-    public allowedElementIds: (elementIds: string[]) => any;
+    public allowedElementIds: (elementIds: string[]) => void;
 
     constructor();
 

package/app/models/element/autocomplete-element.model.d.ts

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import { Observable } from "rxjs";
 import { AutocompleteData, AutocompleteChipData } from "../data/autocomplete.data.model";
 export declare class AutocompleteElement {