@veltdev/sdk 4.1.0 → 4.2.0-beta.1

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

@@ -29,6 +29,7 @@ import { CoreEventTypesMap } from "../models/data/core-events.data.model";
 import { Document, SetDocumentsRequestOptions, FetchDocumentsRequest, FetchFoldersRequest } from "../models/data/document.data.model";
 import { FetchDocumentsResponse, FetchFoldersResponse } from "../models/data/document-events.data.model";
 import { UserDataProvider } from "../models/data/user-resolver.data.model";
+import { IVeltDataProvider } from "../models/data/provider.data.model";
 
 export declare class Snippyly {
    constructor();
@@ -78,6 +79,10 @@ export declare class Snippyly {
     * To set the user data provider.
     */
    setUserDataProvider: (userDataProvider: UserDataProvider) => void;
+   /**
+    * To set the data provider.
+    */
+   setDataProviders: (dataProvider: IVeltDataProvider) => void;
    /**
     * Get Document ID
     */

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

@@ -0,0 +1,41 @@
+import { BaseMetadata } from "./base-metadata.data.model";
+import { CommentAnnotation } from "./comment-annotation.data.model";
+export interface CommentAnnotationDataProvider {
+    get: (request: CommentAnnotationRequest) => Promise<Record<string, IStrippedCommentAnnotation>>;
+    save: (request: ISaveAnnotationRequest) => Promise<IStrippedCommentAnnotation>;
+    delete: ({ commentAnnotationId, metadata }: {
+        commentAnnotationId: string | number;
+        metadata?: BaseMetadata;
+    }) => Promise<void>;
+    resolveTimeout?: number;
+}
+export interface CommentAnnotationRequest {
+    organizationId: string;
+    commentAnnotationIds?: string[];
+    documentIds?: string[];
+    folderId?: string;
+    allDocuments?: boolean;
+}
+export interface ISaveAnnotationRequest {
+    commentAnnotation: {
+        [key: string]: IStrippedCommentAnnotation;
+    };
+}
+export interface StrippedComment {
+    commentId: string | number;
+    commentHtml?: string;
+    commentText?: string;
+}
+export interface StrippedCommentAnnotationResult {
+    strippedData: {
+        [annotationId: string]: IStrippedCommentAnnotation;
+    } | null;
+    originalData: CommentAnnotation | null;
+}
+export interface IStrippedCommentAnnotation {
+    annotationId: string;
+    metadata?: any;
+    comments: {
+        [commentId: string]: StrippedComment;
+    };
+}

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

@@ -19,7 +19,12 @@ export declare class Comment {
      * Comment Text.
      *
      */
-    commentText: string;
+    commentText?: string;
+    /**
+     * To check if comment text is available.
+     */
+    isCommentTextAvailable?: boolean;
+    isCommentResolverUsed?: boolean;
     /**
      * Same comment text in HTML.
      *

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

@@ -133,7 +133,11 @@ export declare class Notification {
      */
     displayBodyMessage?: string;
     /**
-       * Display body message template
+     * Is comment text available
+     */
+    isCommentResolverUsed?: boolean;
+    /**
+     * Display body message template
        */
     displayBodyMessageTemplate?: string;
     /**

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

@@ -0,0 +1,6 @@
+import { CommentAnnotationDataProvider } from "./comment-resolver.data.model";
+import { UserDataProvider } from "./user-resolver.data.model";
+export interface IVeltDataProvider {
+    comment?: CommentAnnotationDataProvider;
+    user?: UserDataProvider;
+}

package/models.d.ts

@@ -67,3 +67,4 @@ export * from './app/models/data/organization-metadata.model';
 export * from './app/models/data/user-organization.data.model';
 export * from './app/models/data/event-metadata.data.model';
 export * from './app/models/data/user-resolver.data.model';
+export * from './app/models/data/provider.data.model';

package/package.json

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