@veltdev/sdk 4.0.0-beta.1 → 4.0.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -26,6 +26,7 @@ import { DocumentMetadata } from "../models/data/document-metadata.model";
26
26
  import { ReactionElement } from "../models/element/reaction-element.model";
27
27
  import { VeltEventMetadata } from "../models/data/event-metadata.data.model";
28
28
  import { CoreEventTypesMap } from "../models/data/core-events.data.model";
29
+ import { Document, SetDocumentsRequestOptions } from "../models/data/document.data.model";
29
30
  export declare class Snippyly {
30
31
  constructor();
31
32
  initConfig: (apiKey: string, config?: Config) => void;
@@ -48,6 +49,10 @@ export declare class Snippyly {
48
49
  * @param id unique document ID
49
50
  */
50
51
  setDocumentId: (id: string) => void;
52
+ /**
53
+ * To set multiple documents
54
+ */
55
+ setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => void;
51
56
  /**
52
57
  * To unset the document id
53
58
  */
@@ -59,10 +59,16 @@ export interface DeleteCommentAnnotationRequest {
59
59
  annotationId: string;
60
60
  options?: RequestOptions;
61
61
  }
62
- export interface GetCommentAnnotationRequest {
62
+ export interface GetCommentAnnotationsRequest {
63
+ documentIds?: string[];
64
+ locationIds?: string[];
65
+ statusIds?: string[];
63
66
  options?: RequestOptions;
64
67
  }
65
68
  export interface GetCommentAnnotationsCountRequest {
69
+ documentIds?: string[];
70
+ locationIds?: string[];
71
+ statusIds?: string[];
66
72
  options?: RequestOptions;
67
73
  }
68
74
  export interface SubscribeCommentAnnotationRequest {
@@ -126,18 +126,19 @@ export interface DeleteCommentAnnotationEvent {
126
126
  commentAnnotation: CommentAnnotation;
127
127
  metadata: VeltEventMetadata;
128
128
  }
129
- export interface GetCommentAnnotationEvent {
129
+ export interface GetCommentAnnotationsEvent {
130
130
  commentAnnotations: CommentAnnotation[];
131
131
  metadata: VeltEventMetadata;
132
132
  }
133
- export interface GetCommentAnnotationResponse {
134
- [documentId: string]: CommentAnnotation[];
133
+ export interface GetCommentAnnotationsResponse {
134
+ data: Record<string, CommentAnnotation[]>;
135
135
  }
136
136
  export interface GetCommentAnnotationsCountResponse {
137
- [documentId: string]: {
138
- total: number;
139
- unread: number;
140
- };
137
+ data: Record<string, CommentAnnotationsCount>;
138
+ }
139
+ export interface CommentAnnotationsCount {
140
+ unread: number;
141
+ total: number;
141
142
  }
142
143
  export interface SubscribeCommentAnnotationEvent {
143
144
  annotationId: string;
@@ -12,6 +12,7 @@ export declare class CommentSidebarFilterConfig {
12
12
  location?: FilterTypeConfig;
13
13
  people?: FilterTypeConfig;
14
14
  priority?: FilterTypeConfig;
15
+ status?: FilterTypeConfig;
15
16
  category?: FilterTypeConfig;
16
17
  commentType?: FilterTypeConfig;
17
18
  version?: FilterTypeConfig;
@@ -0,0 +1,8 @@
1
+ import { DocumentMetadata } from "./document-metadata.model";
2
+ export interface Document {
3
+ id: string;
4
+ metadata?: DocumentMetadata;
5
+ }
6
+ export interface SetDocumentsRequestOptions {
7
+ organizationId?: string;
8
+ }
@@ -2,7 +2,7 @@ import { DocumentMetadata } from "./document-metadata.model";
2
2
  import { Location } from "./location.model";
3
3
  import { OrganizationMetadata } from "./organization-metadata.model";
4
4
  export interface VeltEventMetadata {
5
- organizationMetadata?: OrganizationMetadata | null;
6
- documentMetadata?: DocumentMetadata | null;
7
- location?: Location | null;
5
+ organization?: OrganizationMetadata | null;
6
+ documents?: DocumentMetadata[];
7
+ locations?: Location[];
8
8
  }
@@ -1,13 +1,13 @@
1
1
  // @ts-nocheck
2
2
  import { Observable } from "rxjs";
3
3
  import { CommentAnnotation, CommentOnElementConfig, CommentSelectionChangeData, ManualCommentAnnotationConfig, UpdateContextConfig } from "../data/comment-annotation.data.model";
4
- 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";
4
+ 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";
5
5
  import { CustomCategory, CustomPriority, CustomStatus } from "../data/custom-filter.data.model";
6
6
  import { CustomAnnotationDropdownData } from "../data/custom-chip-dropdown.data.model";
7
7
  import { AutocompleteData } from "../data/autocomplete.data.model";
8
8
  import { CommentSidebarCustomActionEventData, CommentSidebarData, CommentSidebarDataOptions } from "../data/comment-sidebar-config.model";
9
9
  export { ReactionMap } from '../data/reaction-annotation.data.model';
10
- 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";
10
+ 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";
11
11
  import { UnreadCommentsCount } from "../data/comment-utils.data.model";
12
12
  export declare class CommentElement {
13
13
  /**
@@ -953,6 +953,16 @@ export declare class CommentElement {
953
953
  */
954
954
  public deleteCommentAnnotation: (config: DeleteCommentAnnotationRequest) => Promise<DeleteCommentAnnotationEvent | null>;
955
955
 
956
+ /**
957
+ * To get comment annotations
958
+ */
959
+ public getCommentAnnotations: (config: GetCommentAnnotationsRequest) => Observable<GetCommentAnnotationsEvent | null>;
960
+
961
+ /**
962
+ * To get comment annotations count
963
+ */
964
+ public getCommentAnnotationsCount: (config: GetCommentAnnotationsCountRequest) => Observable<GetCommentAnnotationsCountEvent | null>;
965
+
956
966
  /**
957
967
  * To assign user to comment annotation
958
968
  */
@@ -1998,6 +2008,16 @@ export declare class CommentElement {
1998
2008
  */
1999
2009
  private _deleteCommentAnnotation;
2000
2010
 
2011
+ /**
2012
+ * To get comment annotations
2013
+ */
2014
+ private _getCommentAnnotations;
2015
+
2016
+ /**
2017
+ * To get comment annotations count
2018
+ */
2019
+ private _getCommentAnnotationsCount;
2020
+
2001
2021
  /**
2002
2022
  * To assign user to comment annotation
2003
2023
  */
package/models.d.ts CHANGED
@@ -16,6 +16,7 @@ export * from './app/models/data/cursor-user.data.model';
16
16
  export * from './app/models/data/custom-css.data.model';
17
17
  export * from './app/models/data/custom-chip-dropdown.data.model';
18
18
  export * from './app/models/data/device-info.model';
19
+ export * from './app/models/data/document.data.model';
19
20
  export * from './app/models/data/document-iam.data.model';
20
21
  export * from './app/models/data/document-metadata.model';
21
22
  export * from './app/models/data/document-paths.data.model';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veltdev/sdk",
3
- "version": "4.0.0-beta.1",
3
+ "version": "4.0.0-beta.2",
4
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.",
5
5
  "homepage": "https://velt.dev",
6
6
  "keywords": [