@veltdev/sdk 4.4.0-beta.2 → 4.4.0-beta.4

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

@@ -0,0 +1,52 @@
+import { ResolverActions } from "../../utils/enums";
+import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
+export interface AttachmentDataProvider {
+    save: (request: SaveAttachmentResolverRequest) => Promise<ResolverResponse<SaveAttachmentResolverData>>;
+    delete: (request: DeleteAttachmentResolverRequest) => Promise<ResolverResponse<undefined>>;
+    config?: ResolverConfig;
+}
+export interface DeleteAttachmentResolverRequest {
+    attachmentId: number;
+    metadata?: AttachmentResolverMetadata;
+    event?: ResolverActions;
+}
+export interface SaveAttachmentResolverRequest {
+    attachment: ResolverAttachment;
+    metadata?: AttachmentResolverMetadata;
+    event?: ResolverActions;
+}
+export interface PartialAttachment {
+    url: string;
+    name: string;
+    attachmentId: number;
+}
+export interface ResolverAttachment {
+    attachmentId: number;
+    /**
+     * File to be uploaded
+     */
+    file: File;
+    /**
+     * File name
+     */
+    name?: string;
+    /**
+     * Metadata of an attachment
+     */
+    metadata?: AttachmentResolverMetadata;
+    /**
+     * Mime type of an attachment
+     */
+    mimeType?: string;
+}
+export interface AttachmentResolverMetadata {
+    organizationId: string | null;
+    documentId: string | null;
+    folderId?: string | null;
+    attachmentId: number | null;
+    commentAnnotationId: string | null;
+    apiKey: string | null;
+}
+export interface SaveAttachmentResolverData {
+    url: string;
+}

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

@@ -6,6 +6,10 @@ export declare class Attachment {
      * Auto generated.
      */
     attachmentId: number;
+    /**
+     * To check if attachment resolver is used
+     */
+    isAttachmentResolverUsed?: boolean;
     /**
      * File name
      */
@@ -40,3 +44,9 @@ export declare class Attachment {
      */
     mimeType?: any;
 }
+export interface UploadFileOptions {
+    path: string;
+    file: File;
+    useAttachmentResolver?: boolean;
+    metadata?: any;
+}

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

@@ -1,4 +1,5 @@
 import { ResolverActions } from "../../utils/enums";
+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";
@@ -25,12 +26,16 @@ export interface SaveCommentResolverRequest {
         [key: string]: PartialCommentAnnotation;
     };
     event?: ResolverActions;
+    metadata?: BaseMetadata;
     commentId?: string;
 }
 export interface PartialComment {
     commentId: string | number;
     commentHtml?: string;
     commentText?: string;
+    attachments?: {
+        [attachmentId: number]: PartialAttachment;
+    };
 }
 export interface PartialCommentAnnotationResult {
     strippedData: {

package/app/models/data/live-state-data.data.model.d.ts

@@ -20,6 +20,12 @@ export declare class LiveStateData {
     tabId?: string | null;
     isDataStringified?: boolean;
 }
+export declare class SetLiveStateDataConfig {
+    /**
+     * To merge data with existing data.
+     */
+    merge?: boolean;
+}
 export declare class SingleEditorLiveStateData {
     editor?: User | null;
     requestEditorAccess?: {

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

@@ -1,8 +1,10 @@
 import { CommentAnnotationDataProvider } from "./comment-resolver.data.model";
+import { AttachmentDataProvider } from "./attachment-resolver.data.model";
 import { ReactionAnnotationDataProvider } from "./reaction-resolver.data.model";
 import { UserDataProvider } from "./user-resolver.data.model";
 export interface VeltDataProvider {
     comment?: CommentAnnotationDataProvider;
     user?: UserDataProvider;
     reaction?: ReactionAnnotationDataProvider;
+    attachment?: AttachmentDataProvider;
 }

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

@@ -24,6 +24,7 @@ export interface SaveReactionResolverRequest {
     reactionAnnotation: {
         [key: string]: PartialReactionAnnotation;
     };
+    metadata?: BaseMetadata;
     event?: ResolverActions;
 }
 export interface PartialReactionAnnotationResult {

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

@@ -2,6 +2,7 @@ export interface ResolverConfig {
     resolveTimeout?: number;
     saveRetryConfig?: RetryConfig;
     deleteRetryConfig?: RetryConfig;
+    getRetryConfig?: RetryConfig;
 }
 export interface ResolverResponse<T> {
     data?: T;

package/app/models/element/live-state-sync-element.model.d.ts

@@ -1,5 +1,5 @@
 // @ts-nocheck
-import { SingleEditorConfig, UserEditorAccess, EditorAccessTimer, LiveStateDataConfig, LiveStateDataConfig } from '../data/live-state-data.data.model';
+import { SingleEditorConfig, UserEditorAccess, EditorAccessTimer, LiveStateDataConfig, SetLiveStateDataConfig } from '../data/live-state-data.data.model';
 import { User } from '../data/user.data.model';
 import { ServerConnectionState } from '../../utils/enums';
 
@@ -22,7 +22,7 @@ export declare class LiveStateSyncElement {
     /**
      * Sets live state data for the provided ID and data.
      */
-    setLiveStateData: (liveStateDataId: string, liveStateData: any) => any;
+    setLiveStateData: (liveStateDataId: string, liveStateData: any, config?: SetLiveStateDataConfig) => any;
 
     /**
      * Enables the single editor mode.

package/app/utils/constants.d.ts

@@ -248,6 +248,7 @@ export declare class Constants {
         VELT_COMMENT_COMPOSER: string;
         VELT_SKELETON_LOADER: string;
         VELT_SHADOW_DOM_INTERNAL: string;
+        VELT_LIVE_STATE_SYNC_PANEL: string;
     };
     static ATTRIBUTES: {
         VELT_COMMENT_CONTAINER: string;

package/app/utils/enums.d.ts

@@ -23,7 +23,9 @@ export declare enum ResolverActions {
     COMMENT_DELETE = "comment.delete",
     COMMENT_UPDATE = "comment.update",
     REACTION_ADD = "reaction.add",
-    REACTION_DELETE = "reaction.delete"
+    REACTION_DELETE = "reaction.delete",
+    ATTACHMENT_ADD = "attachment.add",
+    ATTACHMENT_DELETE = "attachment.delete"
 }
 export declare const CommentEventTypes: {
     readonly ADD_COMMENT_ANNOTATION: "addCommentAnnotation";
@@ -119,6 +121,25 @@ export declare enum Features {
     NOTIFICATION = "notification",
     REACTION = "reaction"
 }
+export declare enum AnalyticsFeatures {
+    AREA = "area",
+    ARROW = "arrow",
+    AUDIO_HUDDLE = "audioHuddle",
+    COMMENT = "comment",
+    MULTI_THREAD = "multiThread",
+    CURSOR = "cursor",
+    HUDDLE = "huddle",
+    LIVE_STATE_SYNC = "liveStateSync",
+    PRESENCE = "presence",
+    TAG = "tag",
+    RECORDER = "recorder",
+    REWRITER = "rewriter",
+    LIVE_SELECTION = "liveSelection",
+    NOTIFICATION = "notification",
+    REACTION = "reaction",
+    AREA_COMMENT = "areaComment",
+    INLINE_COMMENT = "inlineComment"
+}
 export type FeatureType = 'area' | 'arrow' | 'audioHuddle' | 'comment' | 'cursor' | 'huddle' | 'liveStateSync' | 'presence' | 'recorder' | 'rewriter' | 'tag' | 'liveSelection' | 'notification' | 'reaction' | 'multiThread';
 export declare enum DeviceType {
     DESKTOP = "Desktop",

package/models.d.ts

@@ -64,6 +64,7 @@ export * from './app/models/data/views.data.model';
 export * from './app/models/data/autocomplete.data.model';
 export * from './app/models/data/reaction-annotation.data.model';
 export * from './app/models/data/reaction-resolver.data.model';
+export * from './app/models/data/attachment-resolver.data.model';
 export * from './app/models/data/reaction.data.model';
 export * from './app/models/data/organization-groups.data.model';
 export * from './app/models/data/organization-metadata.model';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk",
-    "version": "4.4.0-beta.2",
+    "version": "4.4.0-beta.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": [