@veltdev/sdk 4.2.0 → 4.2.1-beta.10

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

@@ -1,6 +1,6 @@
 // @ts-nocheck
 import { Observable } from "rxjs";
-import { Config } from "../models/data/config.data.model";
+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 } from "../models/data/user.data.model";
@@ -26,7 +26,7 @@ import { DocumentMetadata } from "../models/data/document-metadata.model";
 import { ReactionElement } from "../models/element/reaction-element.model";
 import { VeltEventMetadata } from "../models/data/event-metadata.data.model";
 import { CoreEventTypesMap } from "../models/data/core-events.data.model";
-import { Document, SetDocumentsRequestOptions, FetchDocumentsRequest, FetchFoldersRequest, UpdateDocumentsRequest } from "../models/data/document.data.model";
+import { Document, SetDocumentsRequestOptions, FetchDocumentsRequest, FetchFoldersRequest, UpdateDocumentsRequest, UpdateLocationsRequest } 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 { VeltDataProvider } from "../models/data/provider.data.model";
@@ -76,6 +76,8 @@ export declare class Snippyly {
     */
    updateDocuments: (request: UpdateDocumentsRequest) => Promise<any>;
 
+   updateLocations: (request: UpdateLocationsRequest) => Promise<any>;
+
    /**
     * To fetch folders
     */
@@ -120,25 +122,25 @@ export declare class Snippyly {
    /**
     * Get the Presence Element Object to access the raw presence data.
     *
-    * This is for Pros who don’t want to use Snippyly Presence web component and want to design their own UI.
+    * This is for Pros who don't want to use Snippyly Presence web component and want to design their own UI.
     */
    getPresenceElement: () => PresenceElement;
    /**
     * Get the Cursor Element Object to access the raw cursor data.
     *
-    * This is for Pros who don’t want to use Snippyly Presence web component and want to design their own UI.
+    * This is for Pros who don't want to use Snippyly Presence web component and want to design their own UI.
     */
    getCursorElement: () => CursorElement;
    /**
     * Get the Comment Element Object to access the raw comment data.
     *
-    * This is for Pros who don’t want to use Snippyly Comment web component and want to design their own UI.
+    * This is for Pros who don't want to use Snippyly Comment web component and want to design their own UI.
     */
    getCommentElement: () => CommentElement;
    /**
     * Get the Tag Pin Annotation Object to access the raw tag data.
     *
-    * This is for Pros who don’t want to use Snippyly Tag web component and want to design their own UI.
+    * This is for Pros who don't want to use Snippyly Tag web component and want to design their own UI.
     */
    getTagElement: () => TagElement;
    /**
@@ -258,11 +260,10 @@ export declare class Snippyly {
    setLanguage: (language: string) => void;
 
    /**
-    * To set the translations for the language.
-    * @param language Language code
-    * @param translations Translations object
+    * To set translations for multiple languages
+    * @param translations Object containing translations for multiple languages
     */
-   setTranslations: (language: string, translations: { [key: string]: string }) => void;
+   setTranslations: (translations: { [language: string]: { [key: string]: string } }) => void;
 
    /**
     * To enable auto translation.
@@ -308,5 +309,5 @@ export declare class Snippyly {
    /**
     * To disable logs.
     */
-   disableLogs: () => void;
+   disableLogs: (config?: DisableLogsConfig) => void;
 }

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

@@ -1,10 +1,12 @@
+import { ResolverActions } from "../../utils/enums";
 import { BaseMetadata } from "./base-metadata.data.model";
 import { CommentAnnotation } from "./comment-annotation.data.model";
+import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
 export interface CommentAnnotationDataProvider {
-    get: (request: GetCommentRequest) => Promise<Record<string, PartialCommentAnnotation>>;
-    save: (request: SaveCommentRequest) => Promise<void>;
-    delete: (request: DeleteCommentRequest) => Promise<void>;
-    resolveTimeout?: number;
+    get: (request: GetCommentRequest) => Promise<ResolverResponse<Record<string, PartialCommentAnnotation>>>;
+    save: (request: SaveCommentRequest) => Promise<ResolverResponse<undefined>>;
+    delete: (request: DeleteCommentRequest) => Promise<ResolverResponse<undefined>>;
+    config?: ResolverConfig;
 }
 export interface GetCommentRequest {
     organizationId: string;
@@ -16,11 +18,14 @@ export interface GetCommentRequest {
 export interface DeleteCommentRequest {
     commentAnnotationId: string;
     metadata?: BaseMetadata;
+    event?: ResolverActions;
 }
 export interface SaveCommentRequest {
     commentAnnotation: {
         [key: string]: PartialCommentAnnotation;
     };
+    event?: ResolverActions;
+    commentId?: string;
 }
 export interface PartialComment {
     commentId: string | number;
@@ -32,6 +37,7 @@ export interface PartialCommentAnnotationResult {
         [annotationId: string]: PartialCommentAnnotation;
     } | null;
     originalData: CommentAnnotation | null;
+    eventType?: ResolverActions;
 }
 export interface PartialCommentAnnotation {
     annotationId: string;

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

@@ -58,3 +58,7 @@ export interface AdvancedQueries {
     advancedQueriesEnabled: boolean;
     advancedQueriesEnabledTime: number;
 }
+export interface DisableLogsConfig {
+    warnings?: boolean;
+    suppressAll?: boolean;
+}

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

@@ -9,12 +9,22 @@ export interface SetDocumentsRequestOptions {
     allDocuments?: boolean;
     locationId?: string;
 }
-export interface UpdateDocumentsRequest {
+export interface UpdateDocumentsRequest<T = unknown> {
     organizationId?: string;
-    documents?: {
-        documentId: string;
-        [key: string]: any;
-    }[];
+    documents?: UpdateDocumentMetadata<T>[];
+}
+export interface UpdateDocumentMetadata<T = unknown> {
+    documentId: string;
+    [key: string]: T | string;
+}
+export interface UpdateLocationsRequest<T = unknown> {
+    organizationId?: string;
+    documentIds?: string[];
+    locations?: UpdateLocationMetadata<T>[];
+}
+export interface UpdateLocationMetadata<T = unknown> {
+    id: string;
+    [key: string]: T | string;
 }
 export interface FetchDocumentsRequest {
     organizationId?: string;
@@ -22,6 +32,12 @@ export interface FetchDocumentsRequest {
     folderId?: string;
     allDocuments?: boolean;
 }
+export interface FetchLocationsRequest {
+    organizationId?: string;
+    documentIds?: string[];
+    folderId?: string;
+    allDocuments?: boolean;
+}
 export interface FetchFoldersRequest {
     organizationId?: string;
     folderId?: string;

package/app/models/data/location-metadata.model.d.ts

@@ -1,3 +1,4 @@
+import { BaseMetadata } from "./base-metadata.data.model";
 import { Location } from "./location.model";
 import { PageInfo } from "./page-info.model";
 export declare class LocationMetadata {
@@ -5,6 +6,10 @@ export declare class LocationMetadata {
      * Unique location id generated from client location information
      */
     locationId?: number;
+    /**
+     * Location id generated from velt location information
+     */
+    veltLocationId?: string;
     /**
      * Location object provided by a client
      */
@@ -13,4 +18,13 @@ export declare class LocationMetadata {
      * Page metadata
      */
     pageInfo?: PageInfo;
+    /**
+     * Location metadata
+     */
+    metadata?: BaseMetadata;
+}
+export interface LocationMetadatas {
+    [documentId: string]: {
+        [locationId: string]: LocationMetadata;
+    };
 }

package/app/models/data/media-preview-config.data.model.d.ts

@@ -6,6 +6,7 @@ export declare class MediaPreviewConfig {
     video?: {
         enabled?: boolean;
         deviceId?: string;
+        track?: MediaStreamTrack;
     };
     screen?: {
         enabled?: boolean;

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

@@ -1,6 +1,8 @@
 import { CommentAnnotationDataProvider } from "./comment-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;
 }

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

@@ -49,6 +49,7 @@ export declare class ReactionAnnotation {
     pageInfo?: PageInfo;
     from?: User;
     icon?: string;
+    isReactionResolverUsed?: boolean;
     iconUrl?: string;
     iconEmoji?: string;
     metadata?: ReactionMetadata;

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

@@ -0,0 +1,39 @@
+import { BaseMetadata } from "./base-metadata.data.model";
+import { ReactionAnnotation } from "./reaction-annotation.data.model";
+import { ResolverResponse, ResolverConfig } from "./resolver.data.model";
+import { ResolverActions } from "../../utils/enums";
+export interface ReactionAnnotationDataProvider {
+    get: (request: GetReactionRequest) => Promise<ResolverResponse<Record<string, PartialReactionAnnotation>>>;
+    save: (request: SaveReactionRequest) => Promise<ResolverResponse<undefined>>;
+    delete: (request: DeleteReactionRequest) => Promise<ResolverResponse<undefined>>;
+    config?: ResolverConfig;
+}
+export interface GetReactionRequest {
+    organizationId: string;
+    reactionAnnotationIds?: string[];
+    documentIds?: string[];
+    folderId?: string;
+    allDocuments?: boolean;
+}
+export interface DeleteReactionRequest {
+    reactionAnnotationId: string;
+    metadata?: BaseMetadata;
+    event?: ResolverActions;
+}
+export interface SaveReactionRequest {
+    reactionAnnotation: {
+        [key: string]: PartialReactionAnnotation;
+    };
+    event?: ResolverActions;
+}
+export interface PartialReactionAnnotationResult {
+    strippedData: {
+        [annotationId: string]: PartialReactionAnnotation;
+    } | null;
+    originalData: ReactionAnnotation | null;
+}
+export interface PartialReactionAnnotation {
+    annotationId: string;
+    metadata?: BaseMetadata;
+    icon?: string;
+}

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

@@ -0,0 +1,21 @@
+export interface ResolverConfig {
+    resolveTimeout?: number;
+    saveRetryConfig?: RetryConfig;
+    deleteRetryConfig?: RetryConfig;
+}
+export interface ResolverResponse<T> {
+    data?: T;
+    success: boolean;
+    message?: string;
+    timestamp?: number;
+    statusCode: number;
+}
+export interface RetryConfig {
+    retryCount?: number;
+    retryDelay?: number;
+    revertOnFailure?: boolean;
+}
+export interface ResolverResponseConfig {
+    revertOnFailure?: boolean;
+    isSuccess?: boolean;
+}

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

@@ -1,5 +1,5 @@
 import { User } from "./user.data.model";
 export interface UserDataProvider {
-    getUsers(userIds: string[]): Promise<Record<string, User>>;
+    get(userIds: string[]): Promise<Record<string, User>>;
     resolveTimeout?: number;
 }

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

@@ -1093,6 +1093,16 @@ export declare class CommentElement {
    */
   public fetchCommentAnnotations: (fetchCommentAnnotationsRequest: FetchCommentAnnotationsRequest) => Promise<FetchCommentAnnotationsResponse>;
 
+  /**
+   * To enable svg as img
+   */
+  public enableSvgAsImg: () => void;
+
+  /**
+   * To disable svg as img
+   */
+  public disableSvgAsImg: () => void;
+
   constructor();
   /**
    * Subscribe to comments on the current document.
@@ -2167,4 +2177,14 @@ export declare class CommentElement {
    * To fetch comment annotations
    */
   private _fetchCommentAnnotations;
+
+  /**
+   * To enable svg as img
+   */
+  private _enableSvgAsImg;
+
+  /**
+   * To disable svg as img
+   */
+  private _disableSvgAsImg;
 }

package/app/utils/constants.d.ts

@@ -250,6 +250,7 @@ export declare class Constants {
         VELT_SHADOW_DOM_INTERNAL: string;
     };
     static ATTRIBUTES: {
+        VELT_COMMENT_CONTAINER: string;
         VELT_TARGET_COMMENT_ELEMENT_ID: string;
         VELT_COMMENT_TYPE: string;
         TARGET_INLINE_COMMENT_ELEMENT_ID: string;
@@ -316,6 +317,7 @@ export declare class Constants {
         VELT_COMMENT_DIALOG_PORTAL_INTERNAL: string;
         ANNOTATION_ID: string;
         MULTI_THREAD_ANNOTATION_ID: string;
+        SLATE_EDITOR: string;
     };
     static INJECTION_STYLE_PROPS: {
         /**

package/app/utils/enums.d.ts

@@ -16,6 +16,15 @@ export declare enum CommentStatus {
     SUBSCRIBED = "subscribed",
     UNSUBSCRIBED = "unsubscribed"
 }
+export declare enum ResolverActions {
+    COMMENT_ANNOTATION_ADD = "comment_annotation.add",
+    COMMENT_ANNOTATION_DELETE = "comment_annotation.delete",
+    COMMENT_ADD = "comment.add",
+    COMMENT_DELETE = "comment.delete",
+    COMMENT_UPDATE = "comment.update",
+    REACTION_ADD = "reaction.add",
+    REACTION_DELETE = "reaction.delete"
+}
 export declare const CommentEventTypes: {
     readonly ADD_COMMENT_ANNOTATION: "addCommentAnnotation";
     readonly DELETE_COMMENT_ANNOTATION: "deleteCommentAnnotation";

package/package.json

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