@veltdev/sdk 3.0.87 → 4.0.0-beta.2

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

@@ -26,6 +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 } from "../models/data/document.data.model";
 export declare class Snippyly {
   constructor();
   initConfig: (apiKey: string, config?: Config) => void;
@@ -48,6 +49,10 @@ export declare class Snippyly {
    * @param id unique document ID
    */
   setDocumentId: (id: string) => void;
+  /**
+   * To set multiple documents
+   */
+  setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => void;
   /**
    * To unset the document id
    */

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

@@ -54,9 +54,6 @@ export declare class AreaAnnotation {
     targetAnnotations: AreaTargetAnnotation[];
     metadata?: AreaMetadata;
 }
-export declare class AreaMetadata extends BaseMetadata {
-    [key: string]: any;
-}
 export declare class AreaTargetAnnotation {
     /**
      * Type of the annotation (ex. comment, tag etc.)
@@ -77,3 +74,6 @@ export declare class AreaProperty {
     handle2?: any;
     coordinates?: any;
 }
+export declare class AreaMetadata extends BaseMetadata {
+    [key: string]: any;
+}

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

@@ -1,4 +1,5 @@
 export declare class BaseMetadata {
+    apiKey?: string;
     documentId?: string;
     clientDocumentId?: string;
     organizationId?: string;

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

@@ -10,6 +10,7 @@ export interface RequestOptions {
     organizationId?: string;
     documentId?: string;
     filters?: any;
+    documentIds?: string[];
 }
 export interface UpdatePriorityRequest {
     annotationId: string;
@@ -58,7 +59,16 @@ export interface DeleteCommentAnnotationRequest {
     annotationId: string;
     options?: RequestOptions;
 }
-export interface GetCommentAnnotationRequest {
+export interface GetCommentAnnotationsRequest {
+    documentIds?: string[];
+    locationIds?: string[];
+    statusIds?: string[];
+    options?: RequestOptions;
+}
+export interface GetCommentAnnotationsCountRequest {
+    documentIds?: string[];
+    locationIds?: string[];
+    statusIds?: string[];
     options?: RequestOptions;
 }
 export interface SubscribeCommentAnnotationRequest {

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

@@ -126,10 +126,20 @@ export interface DeleteCommentAnnotationEvent {
     commentAnnotation: CommentAnnotation;
     metadata: VeltEventMetadata;
 }
-export interface GetCommentAnnotationEvent {
+export interface GetCommentAnnotationsEvent {
     commentAnnotations: CommentAnnotation[];
     metadata: VeltEventMetadata;
 }
+export interface GetCommentAnnotationsResponse {
+    data: Record<string, CommentAnnotation[]>;
+}
+export interface GetCommentAnnotationsCountResponse {
+    data: Record<string, CommentAnnotationsCount>;
+}
+export interface CommentAnnotationsCount {
+    unread: number;
+    total: number;
+}
 export interface SubscribeCommentAnnotationEvent {
     annotationId: string;
     commentAnnotation: CommentAnnotation;

package/app/models/data/comment-sidebar-config.model.d.ts

@@ -12,6 +12,7 @@ export declare class CommentSidebarFilterConfig {
     location?: FilterTypeConfig;
     people?: FilterTypeConfig;
     priority?: FilterTypeConfig;
+    status?: FilterTypeConfig;
     category?: FilterTypeConfig;
     commentType?: FilterTypeConfig;
     version?: FilterTypeConfig;

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

@@ -43,7 +43,17 @@ export declare class Config {
      * prefers-color-scheme media query to set the global theme of our components.
      */
     usePrefersColorScheme?: boolean;
+    /**
+     * To enable/disable advanced queries.
+     *
+     * Default: false
+     */
+    advancedQueriesDisabled?: boolean;
 }
 export interface ExtendedFirebaseOptions extends FirebaseOptions {
     storeDbId: string;
 }
+export interface AdvancedQueries {
+    advancedQueriesEnabled: boolean;
+    advancedQueriesEnabledTime: number;
+}

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

@@ -6,6 +6,18 @@ export declare class DocumentMetadata {
      * Unique document id generated from client document id
      */
     documentId?: string;
+    /**
+     * API key
+     */
+    apiKey?: string;
+    /**
+     * Organization id
+     */
+    organizationId?: string;
+    /**
+     * Client organization id
+     */
+    clientOrganizationId?: string;
     /**
      * Document id provided by client
      */
@@ -30,3 +42,6 @@ export declare class DocumentMetadata {
     creator?: User;
     [key: string]: any;
 }
+export interface DocumentMetadatas {
+    [documentId: string]: DocumentMetadata;
+}

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

@@ -7,6 +7,7 @@ export declare class DocumentPaths {
      * Presence path.
      */
     presence?: string;
+    docs?: string;
     /**
      * Cursor path.
      */

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

@@ -0,0 +1,8 @@
+import { DocumentMetadata } from "./document-metadata.model";
+export interface Document {
+    id: string;
+    metadata?: DocumentMetadata;
+}
+export interface SetDocumentsRequestOptions {
+    organizationId?: string;
+}

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

@@ -2,7 +2,7 @@ import { DocumentMetadata } from "./document-metadata.model";
 import { Location } from "./location.model";
 import { OrganizationMetadata } from "./organization-metadata.model";
 export interface VeltEventMetadata {
-    organizationMetadata?: OrganizationMetadata | null;
-    documentMetadata?: DocumentMetadata | null;
-    location?: Location | null;
+    organization?: OrganizationMetadata | null;
+    documents?: DocumentMetadata[];
+    locations?: Location[];
 }

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

@@ -6,6 +6,10 @@ export declare class OrganizationMetadata {
      * Unique organization id generated from client organization id
      */
     organizationId?: string;
+    /**
+     * API key
+     */
+    apiKey?: string;
     /**
      * Document id provided by client
      */

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

@@ -13,6 +13,10 @@ export declare class RecorderAnnotation {
      * Auto generated.
      */
     annotationId: string;
+    /**
+       * Connected comment annotation id of reaction annotation
+       */
+    commentAnnotationId?: string;
     /**
      * The user who created this recorder pin annotation.
      *

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

@@ -1,3 +1,4 @@
+import { BaseMetadata } from "./base-metadata.data.model";
 import { UserContact } from "./user-contact.data.model";
 import { UserRole } from "./user-role.data.model";
 import { User } from "./user.data.model";
@@ -33,4 +34,5 @@ export declare class UserIAM {
     groups?: {
         [groupId: string]: boolean;
     };
+    metadata?: BaseMetadata;
 }

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

@@ -1,19 +1,7 @@
+import { BaseMetadata } from "./base-metadata.data.model";
 import { Location } from "./location.model";
 export declare class Views {
-    comment?: {
-        [commentAnnotationId: string]: {
-            views: {
-                [userSnippylyId: string]: View;
-            };
-            comments: {
-                [commentId: string]: {
-                    views: {
-                        [userSnippylyId: string]: View;
-                    };
-                };
-            };
-        };
-    };
+    comment?: CommentViews;
     notification?: {
         [notificationId: string]: {
             views: {
@@ -22,17 +10,10 @@ export declare class Views {
         };
     };
     documentViews?: {
-        [documentId: string]: {
-            users: ViewsByUser;
-            day: ViewsByDate;
-        };
+        [documentId: string]: DocumentViews;
     };
     locationViews?: {
-        [locationId: string]: {
-            location: Location;
-            users: ViewsByUser;
-            day: ViewsByDate;
-        };
+        [locationId: string]: LocationViews;
     };
 }
 export declare class View {
@@ -48,3 +29,36 @@ export declare class ViewsByUser {
         [date: string]: View;
     };
 }
+export declare class CommentViews {
+    [commentAnnotationId: string]: CommentAnnotationViews;
+}
+export declare class LocationViewsMap {
+    [locationId: string]: LocationViews;
+}
+export declare class CommentAnnotationViews {
+    views: {
+        [userSnippylyId: string]: View;
+    };
+    comments: {
+        [commentId: string]: {
+            views: {
+                [userSnippylyId: string]: View;
+            };
+        };
+    };
+    metadata?: BaseMetadata;
+}
+export declare class DocumentViewsMap {
+    [documentId: string]: DocumentViews;
+}
+export declare class DocumentViews {
+    users: ViewsByUser;
+    day: ViewsByDate;
+    metadata?: BaseMetadata;
+}
+export declare class LocationViews {
+    location: Location;
+    users: ViewsByUser;
+    day: ViewsByDate;
+    metadata?: BaseMetadata;
+}

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

@@ -1,13 +1,13 @@
 // @ts-nocheck
 import { Observable } from "rxjs";
 import { CommentAnnotation, CommentOnElementConfig, CommentSelectionChangeData, ManualCommentAnnotationConfig, UpdateContextConfig } from "../data/comment-annotation.data.model";
-import { AcceptCommentAnnotationEvent, AddCommentAnnotationEvent, AddCommentEvent, AddReactionEvent, ApproveCommentAnnotationEvent, CommentAddEventData, CommentEventTypesMap, CommentUpdateEventData, CopyLinkEvent, DeleteAttachmentEvent, DeleteCommentAnnotationEvent, DeleteCommentEvent, DeleteReactionEvent, DeleteRecordingEvent, GetLinkEvent, RejectCommentAnnotationEvent, ToggleReactionEvent, UpdateAccessEvent, UpdateCommentEvent, UpdatePriorityEvent, UpdateStatusEvent } from "../data/comment-events.data.model";
+import { AcceptCommentAnnotationEvent, AddCommentAnnotationEvent, AddCommentEvent, AddReactionEvent, ApproveCommentAnnotationEvent, CommentAddEventData, CommentEventTypesMap, CommentUpdateEventData, CopyLinkEvent, DeleteAttachmentEvent, DeleteCommentAnnotationEvent, DeleteCommentEvent, DeleteReactionEvent, DeleteRecordingEvent, GetLinkEvent, RejectCommentAnnotationEvent, ToggleReactionEvent, UpdateAccessEvent, UpdateCommentEvent, UpdatePriorityEvent, UpdateStatusEvent, GetCommentAnnotationsResponse, GetCommentAnnotationsCountResponse } from "../data/comment-events.data.model";
 import { CustomCategory, CustomPriority, CustomStatus } from "../data/custom-filter.data.model";
 import { CustomAnnotationDropdownData } from "../data/custom-chip-dropdown.data.model";
 import { AutocompleteData } from "../data/autocomplete.data.model";
 import { CommentSidebarCustomActionEventData, CommentSidebarData, CommentSidebarDataOptions } from "../data/comment-sidebar-config.model";
 export { ReactionMap } from '../data/reaction-annotation.data.model';
-import { AcceptCommentAnnotationRequest, AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationRequest, AddCommentRequest, AddReactionRequest, ApproveCommentAnnotationRequest, AssignUserRequest, AssignUserEvent, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, GetAttachmentRequest, GetCommentRequest, GetLinkRequest, GetRecordingRequest, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubscribeCommentAnnotationRequest, UnsubscribeCommentAnnotationRequest, ToggleReactionRequest, UpdateAccessRequest, UpdateCommentRequest, UpdatePriorityRequest, UpdateStatusRequest } from "../data/comment-actions.data.model";
+import { AcceptCommentAnnotationRequest, AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationRequest, AddCommentRequest, AddReactionRequest, ApproveCommentAnnotationRequest, AssignUserRequest, AssignUserEvent, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, GetCommentAnnotationsRequest, GetCommentAnnotationsCountRequest, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, GetAttachmentRequest, GetCommentRequest, GetLinkRequest, GetRecordingRequest, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubscribeCommentAnnotationRequest, UnsubscribeCommentAnnotationRequest, ToggleReactionRequest, UpdateAccessRequest, UpdateCommentRequest, UpdatePriorityRequest, UpdateStatusRequest } from "../data/comment-actions.data.model";
 import { UnreadCommentsCount } from "../data/comment-utils.data.model";
 export declare class CommentElement {
   /**
@@ -953,6 +953,16 @@ export declare class CommentElement {
    */
   public deleteCommentAnnotation: (config: DeleteCommentAnnotationRequest) => Promise<DeleteCommentAnnotationEvent | null>;
 
+  /**
+   * To get comment annotations
+   */
+  public getCommentAnnotations: (config: GetCommentAnnotationsRequest) => Observable<GetCommentAnnotationsEvent | null>;
+
+  /**
+   * To get comment annotations count
+   */
+  public getCommentAnnotationsCount: (config: GetCommentAnnotationsCountRequest) => Observable<GetCommentAnnotationsCountEvent | null>;
+
   /**
    * To assign user to comment annotation
    */
@@ -1998,6 +2008,16 @@ export declare class CommentElement {
    */
   private _deleteCommentAnnotation;
 
+  /**
+   * To get comment annotations
+   */
+  private _getCommentAnnotations;
+
+  /**
+   * To get comment annotations count
+   */
+  private _getCommentAnnotationsCount;
+
   /**
    * To assign user to comment annotation
    */

package/app/utils/constants.d.ts

@@ -270,6 +270,7 @@ export declare class Constants {
         VELT_RECORDER_DISABLED: string;
         VELT_ANNOTATION_DRAFT: string;
         VELT_ANNOTATION_EDIT_COMMENT: string;
+        VELT_DOCUMENT_ID: string;
         VELT_LOCATION: string;
         VELT_LOCATION_ID: string;
         VELT_THEME: string;
@@ -352,6 +353,7 @@ export declare class Constants {
         VELT_USER: string;
         VELT_USER_FORCE_RE_LOGGED_IN: string;
         VELT_VERSION: string;
+        VELT_ADVANCED_QUERIES: string;
     };
     static NON_NESTABLE_ELEMENTS: {
         [tag: string]: boolean;

package/models.d.ts

@@ -16,6 +16,7 @@ export * from './app/models/data/cursor-user.data.model';
 export * from './app/models/data/custom-css.data.model';
 export * from './app/models/data/custom-chip-dropdown.data.model';
 export * from './app/models/data/device-info.model';
+export * from './app/models/data/document.data.model';
 export * from './app/models/data/document-iam.data.model';
 export * from './app/models/data/document-metadata.model';
 export * from './app/models/data/document-paths.data.model';

package/package.json

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