@veltdev/types 5.0.3 → 6.0.0-beta.1

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

@@ -24,7 +24,6 @@ import { TagElement } from "../models/element/tag-element.model";
 import { FeatureType } from "../utils/enums";
 import { UserContact } from "../models/data/user-contact.data.model";
 import { DocumentMetadata } from "../models/data/document-metadata.model";
-import { PageInfo } from "../models/data/page-info.model";
 import { ReactionElement } from "../models/element/reaction-element.model";
 import { CrdtElement } from "../models/element/crdt-element.model";
 import { VeltEventMetadata, VeltDebugInfo } from "../models/data/event-metadata.data.model";
@@ -56,23 +55,6 @@ export declare class Snippyly {
     * @param documentMetadata Document Metadata
     */
    setDocument: (id: string, documentMetadata?: DocumentMetadata) => Promise<void>;
-   /**
-    * Provide custom page info that the SDK should use instead of generating it from the browser
-    * (`window.location` / `document.title`). Newly created data (comments, reactions, recordings,
-    * presence, cursors, etc.) will use the provided page info. Already saved/existing data is not
-    * affected.
-    * @param pageInfo client-provided page info
-    * @param options optional; pass a `documentId` to scope the page info to a specific document
-    *                (per-document page info takes precedence over the global page info)
-    */
-   setPageInfo: (pageInfo: PageInfo, options?: { documentId?: string; }) => void;
-   /**
-    * Clear custom page info previously set via `setPageInfo`. The SDK will resume generating
-    * page info from the browser.
-    * @param options optional; pass a `documentId` to clear only that document's page info,
-    *                otherwise the global page info is cleared
-    */
-   clearPageInfo: (options?: { documentId?: string; }) => void;
    /**
     * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
     * @param id unique document ID

package/app/{models/data/arrow-annotation.data.model.d.ts → features/arrow/models/arrow-annotation.model.d.ts}

@@ -1,9 +1,9 @@
-import { AnnotationProperty } from "./annotation-property.data.model";
-import { CursorPosition } from "./cursor-position.data.model";
-import { Location } from "./location.model";
-import { PageInfo } from "./page-info.model";
-import { TargetElement } from "./target-element.data.model";
-import { User } from "./user.data.model";
+import { AnnotationProperty } from "../../../models/data/annotation-property.data.model";
+import { CursorPosition } from "../../../models/data/cursor-position.data.model";
+import { Location } from "../../../models/data/location.model";
+import { PageInfo } from "../../../models/data/page-info.model";
+import { TargetElement } from "../../../models/data/target-element.data.model";
+import { User } from "../../../models/data/user.data.model";
 export declare class ArrowAnnotation {
     /**
      * Unique identifier for the arrow pin annotation.

package/app/features/user-request/models/user-request.data.model.d.ts

@@ -0,0 +1,37 @@
+import { DocumentMetadata } from "../../../models/data/document-metadata.model";
+import { PageInfo } from "../../../models/data/page-info.model";
+import { User } from "../../../models/data/user.data.model";
+export declare class UserRequest {
+    /**
+     * Unique id of the feedback
+     */
+    id?: string;
+    /**
+     * apiKey of the client
+     */
+    apiKey?: string | null;
+    /**
+     * Email id of the feedback giver
+     */
+    emailId?: string;
+    /**
+     * Message given by the user
+     */
+    message?: string;
+    /**
+     * User who added the feedback
+     */
+    from?: User | null;
+    /**
+     * Date when the feedback was added
+     */
+    lastUpdated?: any;
+    /**
+     * Document metadata
+     */
+    metadata?: DocumentMetadata | null;
+    /**
+     * User's page info
+     */
+    pageInfo?: PageInfo;
+}

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/models/data/user-contact-us.data.model.d.ts

@@ -1,3 +1,3 @@
-import { UserRequest } from "./user-request.data.model";
+import { UserRequest } from "../../features/user-request/models/user-request.data.model";
 export declare class UserContactUs extends UserRequest {
 }

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

@@ -1,3 +1,3 @@
-import { UserRequest } from "./user-request.data.model";
+import { UserRequest } from "../../features/user-request/models/user-request.data.model";
 export declare class UserFeedback extends UserRequest {
 }

package/app/models/data/user-report-bug.data.model.d.ts

@@ -1,3 +1,3 @@
-import { UserRequest } from "./user-request.data.model";
+import { UserRequest } from "../../features/user-request/models/user-request.data.model";
 export declare class UserReportBug extends UserRequest {
 }

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

@@ -948,8 +948,6 @@ export declare class CommentElement {
    * To disable collapsed comment
    */
   public disableCollapsedComments: () => void;
-  public enableCollapsedRepliesPreview: () => void;
-  public disableCollapsedRepliesPreview: () => void;
 
   /**
    * To enable query params comments
@@ -2300,8 +2298,6 @@ export declare class CommentElement {
    * To disable collapsed comment
    */
   private _disableCollapsedComments;
-  private _enableCollapsedRepliesPreview;
-  private _disableCollapsedRepliesPreview;
 
   /**
    * To enable query params comments

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

@@ -1,6 +1,6 @@
 // @ts-nocheck
 
-import { CrossOrganizationConfig, GetNotificationsDataQuery, Notification, NotificationInitialSettingsConfig, NotificationSettingsConfig, NotificationTabConfig } from "../data/notification.model";
+import { GetNotificationsDataQuery, Notification, NotificationInitialSettingsConfig, NotificationSettingsConfig, NotificationTabConfig } from "../data/notification.model";
 
 export declare class NotificationElement {
     /**
@@ -128,16 +128,6 @@ export declare class NotificationElement {
      */
     disableCurrentDocumentOnly: () => void;
 
-    /**
-     * Opt in to cross-organization "For You" notifications.
-     */
-    enableCrossOrganization: (config?: CrossOrganizationConfig | null) => void;
-
-    /**
-     * Opt out of cross-organization "For You" notifications.
-     */
-    disableCrossOrganization: () => void;
-
     constructor();
 
     /**
@@ -264,8 +254,4 @@ export declare class NotificationElement {
      * To disable current document only
      */
     private _disableCurrentDocumentOnly;
-
-    private _enableCrossOrganization;
-
-    private _disableCrossOrganization;
 }

package/app/utils/constants.d.ts

@@ -203,8 +203,11 @@ export declare class Constants {
         VELT_TAGS: string;
         VELT_RECORDER_NOTES: string;
         VELT_RECORDER_CONTROL_PANEL: string;
-        VELT_RECORDER_CONTROL_PANEL_INTERNAL: string;
+        VELT_RECORDER_CONTROL_PANEL_EMBED: string;
+        SNIPPYLY_RECORDER_CONTROL_PANEL_EMBED: string;
         VELT_RECORDER_PLAYER: string;
+        VELT_RECORDER_PLAYER_EMBED: string;
+        SNIPPYLY_RECORDER_PLAYER_EMBED: string;
         VELT_VIDEO_EDITOR: string;
         VELT_TEXT_HIGHLIGHT: string;
         VELT_COMMENT_TEXT_PORTAL: string;
@@ -271,6 +274,8 @@ export declare class Constants {
         VELT_COMMENT_BUBBLE_UNREAD_ICON: string;
         VELT_COMMENT_THREAD: string;
         VELT_COMMENT_PIN: string;
+        VELT_COMMENT_PIN_EMBED: string;
+        SNIPPYLY_COMMENT_PIN_EMBED: string;
         VELT_COMMENT_PIN_NUMBER: string;
         VELT_COMMENT_PIN_INDEX: string;
         VELT_COMMENT_PIN_TRIANGLE: string;
@@ -332,7 +337,11 @@ export declare class Constants {
         VELT_VIDEO_PLAYER: string;
         VELT_VIDEO_COMMENTS_TIMELINE: string;
         VELT_REACTION_TOOL: string;
+        SNIPPYLY_REACTION_TOOL: string;
+        VELT_REACTION_PIN: string;
+        SNIPPYLY_REACTION_PIN: string;
         VELT_INLINE_REACTIONS_SECTION: string;
+        SNIPPYLY_INLINE_REACTIONS_SECTION: string;
         VELT_VIEW_ANALYTICS: string;
         VELT_NOTIFICATIONS_TOOL: string;
         VELT_NOTIFICATIONS_TOOL_ICON: string;

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";
@@ -199,7 +224,12 @@ export declare enum Features {
     LIVE_SELECTION = "liveSelection",
     NOTIFICATION = "notification",
     REACTION = "reaction",
-    ACTIVITY = "activity"
+    ACTIVITY = "activity",
+    VIEWS = "views",
+    USER_INVITE = "userInvite",
+    USER_REQUEST = "userRequest",
+    VIDEO_PLAYER = "videoPlayer",
+    CRDT = "crdt"
 }
 export declare enum AnalyticsFeatures {
     AREA = "area",
@@ -221,7 +251,7 @@ export declare enum AnalyticsFeatures {
     INLINE_COMMENT = "inlineComment",
     COMMENT_SIDEBAR = "commentSidebar"
 }
-export type FeatureType = 'area' | 'arrow' | 'audioHuddle' | 'comment' | 'cursor' | 'huddle' | 'liveStateSync' | 'presence' | 'recorder' | 'rewriter' | 'tag' | 'liveSelection' | 'notification' | 'reaction' | 'multiThread' | 'activity';
+export type FeatureType = 'area' | 'arrow' | 'audioHuddle' | 'comment' | 'cursor' | 'huddle' | 'liveStateSync' | 'presence' | 'recorder' | 'rewriter' | 'tag' | 'liveSelection' | 'notification' | 'reaction' | 'multiThread' | 'activity' | 'views' | 'userInvite' | 'userRequest' | 'videoPlayer' | 'crdt';
 export type AssignToType = 'dropdown' | 'checkbox';
 export declare enum DeviceType {
     DESKTOP = "Desktop",

package/models.d.ts

@@ -3,7 +3,7 @@ export * from './app/models/data/anchor-record.data.model';
 export * from './app/models/data/attachment.model';
 export * from './app/models/data/activity.data.model';
 export * from './app/models/data/area-annotation.data.model';
-export * from './app/models/data/arrow-annotation.data.model';
+export * from './app/features/arrow/models/arrow-annotation.model';
 export * from './app/models/data/agent-suggestion.data.model';
 export * from './app/models/data/base-metadata.data.model';
 export * from './app/models/data/button.data.model';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/types",
-    "version": "5.0.3",
+    "version": "6.0.0-beta.1",
     "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": [

package/types.d.ts

@@ -14,7 +14,6 @@ export * from './app/models/element/selection-element.model';
 export * from './app/models/element/tag-element.model';
 export * from './app/models/element/views-element.model';
 export * from './app/models/element/notification-element.model';
-export * from './app/models/element/cross-organization-config.model';
 export * from './app/models/element/autocomplete-element.model';
 export * from './app/models/element/reaction-element.model';
 export * from './app/models/element/crdt-element.model';