@veltdev/types-dev 4.2.0-beta.1 → 4.2.0-beta.11

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,10 +26,10 @@ 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, FetchDocumentsRequest, FetchFoldersRequest } from "../models/data/document.data.model";
29
+ import { Document, SetDocumentsRequestOptions, FetchDocumentsRequest, FetchFoldersRequest, UpdateDocumentsRequest } from "../models/data/document.data.model";
30
30
  import { FetchDocumentsResponse, FetchFoldersResponse } from "../models/data/document-events.data.model";
31
31
  import { UserDataProvider } from "../models/data/user-resolver.data.model";
32
- import { IVeltDataProvider } from "../models/data/provider.data.model";
32
+ import { VeltDataProvider } from "../models/data/provider.data.model";
33
33
 
34
34
  export declare class Snippyly {
35
35
  constructor();
@@ -71,6 +71,11 @@ export declare class Snippyly {
71
71
  * To fetch documents
72
72
  */
73
73
  fetchDocuments: (options?: FetchDocumentsRequest) => Promise<FetchDocumentsResponse>;
74
+ /**
75
+ * To update documents
76
+ */
77
+ updateDocuments: (request: UpdateDocumentsRequest) => Promise<any>;
78
+
74
79
  /**
75
80
  * To fetch folders
76
81
  */
@@ -82,7 +87,7 @@ export declare class Snippyly {
82
87
  /**
83
88
  * To set the data provider.
84
89
  */
85
- setDataProviders: (dataProvider: IVeltDataProvider) => void;
90
+ setDataProviders: (dataProvider: VeltDataProvider) => void;
86
91
  /**
87
92
  * Get Document ID
88
93
  */
@@ -222,6 +222,7 @@ export declare class InlineCommentSectionConfig {
222
222
  }
223
223
  export declare class ManualCommentAnnotationConfig {
224
224
  context?: any;
225
+ location?: Location;
225
226
  }
226
227
  export declare class CommentAnnotationSubscribedUsers {
227
228
  [userIdHash: string]: {
@@ -1,41 +1,42 @@
1
1
  import { BaseMetadata } from "./base-metadata.data.model";
2
2
  import { CommentAnnotation } from "./comment-annotation.data.model";
3
3
  export interface CommentAnnotationDataProvider {
4
- get: (request: CommentAnnotationRequest) => Promise<Record<string, IStrippedCommentAnnotation>>;
5
- save: (request: ISaveAnnotationRequest) => Promise<IStrippedCommentAnnotation>;
6
- delete: ({ commentAnnotationId, metadata }: {
7
- commentAnnotationId: string | number;
8
- metadata?: BaseMetadata;
9
- }) => Promise<void>;
4
+ get: (request: GetCommentRequest) => Promise<Record<string, PartialCommentAnnotation>>;
5
+ save: (request: SaveCommentRequest) => Promise<void>;
6
+ delete: (request: DeleteCommentRequest) => Promise<void>;
10
7
  resolveTimeout?: number;
11
8
  }
12
- export interface CommentAnnotationRequest {
9
+ export interface GetCommentRequest {
13
10
  organizationId: string;
14
11
  commentAnnotationIds?: string[];
15
12
  documentIds?: string[];
16
13
  folderId?: string;
17
14
  allDocuments?: boolean;
18
15
  }
19
- export interface ISaveAnnotationRequest {
16
+ export interface DeleteCommentRequest {
17
+ commentAnnotationId: string;
18
+ metadata?: BaseMetadata;
19
+ }
20
+ export interface SaveCommentRequest {
20
21
  commentAnnotation: {
21
- [key: string]: IStrippedCommentAnnotation;
22
+ [key: string]: PartialCommentAnnotation;
22
23
  };
23
24
  }
24
- export interface StrippedComment {
25
+ export interface PartialComment {
25
26
  commentId: string | number;
26
27
  commentHtml?: string;
27
28
  commentText?: string;
28
29
  }
29
- export interface StrippedCommentAnnotationResult {
30
+ export interface PartialCommentAnnotationResult {
30
31
  strippedData: {
31
- [annotationId: string]: IStrippedCommentAnnotation;
32
+ [annotationId: string]: PartialCommentAnnotation;
32
33
  } | null;
33
34
  originalData: CommentAnnotation | null;
34
35
  }
35
- export interface IStrippedCommentAnnotation {
36
+ export interface PartialCommentAnnotation {
36
37
  annotationId: string;
37
- metadata?: any;
38
+ metadata?: BaseMetadata;
38
39
  comments: {
39
- [commentId: string]: StrippedComment;
40
+ [commentId: string]: PartialComment;
40
41
  };
41
42
  }
@@ -9,6 +9,13 @@ export interface SetDocumentsRequestOptions {
9
9
  allDocuments?: boolean;
10
10
  locationId?: string;
11
11
  }
12
+ export interface UpdateDocumentsRequest {
13
+ organizationId?: string;
14
+ documents?: {
15
+ documentId: string;
16
+ [key: string]: any;
17
+ }[];
18
+ }
12
19
  export interface FetchDocumentsRequest {
13
20
  organizationId?: string;
14
21
  documentIds?: string[];
@@ -5,4 +5,5 @@ export interface VeltEventMetadata {
5
5
  organization?: OrganizationMetadata | null;
6
6
  documents?: DocumentMetadata[];
7
7
  locations?: Location[];
8
+ folderId?: string;
8
9
  }
@@ -5,6 +5,10 @@ export declare class LocationMetadata {
5
5
  * Unique location id generated from client location information
6
6
  */
7
7
  locationId?: number;
8
+ /**
9
+ * Location id generated from velt location information
10
+ */
11
+ veltLocationId?: string;
8
12
  /**
9
13
  * Location object provided by a client
10
14
  */
@@ -1,6 +1,6 @@
1
1
  import { CommentAnnotationDataProvider } from "./comment-resolver.data.model";
2
2
  import { UserDataProvider } from "./user-resolver.data.model";
3
- export interface IVeltDataProvider {
3
+ export interface VeltDataProvider {
4
4
  comment?: CommentAnnotationDataProvider;
5
5
  user?: UserDataProvider;
6
6
  }
@@ -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, GetCommentAnnotationsResponse, GetCommentAnnotationsCountResponse } 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, FetchCommentAnnotationsResponse } 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, CommentRequestQuery, CommentRequestQuery, 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, CommentRequestQuery, CommentRequestQuery, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, GetAttachmentRequest, GetCommentRequest, GetLinkRequest, GetRecordingRequest, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubscribeCommentAnnotationRequest, UnsubscribeCommentAnnotationRequest, ToggleReactionRequest, UpdateAccessRequest, UpdateCommentRequest, UpdatePriorityRequest, UpdateStatusRequest, FetchCommentAnnotationsRequest } from "../data/comment-actions.data.model";
11
11
  import { UnreadCommentsCount, TransformContext } from "../data/comment-utils.data.model";
12
12
  export declare class CommentElement {
13
13
  /**
@@ -1088,6 +1088,11 @@ export declare class CommentElement {
1088
1088
  */
1089
1089
  public setTransformContext: (transformContext: TransformContext) => void;
1090
1090
 
1091
+ /**
1092
+ * To fetch comment annotations
1093
+ */
1094
+ public fetchCommentAnnotations: (fetchCommentAnnotationsRequest: FetchCommentAnnotationsRequest) => Promise<FetchCommentAnnotationsResponse>;
1095
+
1091
1096
  constructor();
1092
1097
  /**
1093
1098
  * Subscribe to comments on the current document.
@@ -2157,4 +2162,9 @@ export declare class CommentElement {
2157
2162
  * To set transform context
2158
2163
  */
2159
2164
  private _setTransformContext;
2165
+
2166
+ /**
2167
+ * To fetch comment annotations
2168
+ */
2169
+ private _fetchCommentAnnotations;
2160
2170
  }
@@ -45,6 +45,16 @@ export declare class RecorderElement {
45
45
  */
46
46
  getRecordingData: (query: RecorderRequestQuery) => Promise<GetRecordingDataResponse>;
47
47
 
48
+ /**
49
+ * To enable video editor
50
+ */
51
+ enableVideoEditor: () => void;
52
+
53
+ /**
54
+ * To disable video editor
55
+ */
56
+ disableVideoEditor: () => void;
57
+
48
58
  constructor();
49
59
 
50
60
  private _initRecording;
@@ -86,4 +96,14 @@ export declare class RecorderElement {
86
96
  * To get recording data by recorder ids
87
97
  */
88
98
  private _getRecordingData;
89
- }
99
+
100
+ /**
101
+ * To enable video editor
102
+ */
103
+ private _enableVideoEditor;
104
+
105
+ /**
106
+ * To disable video editor
107
+ */
108
+ private _disableVideoEditor;
109
+ }
@@ -20,6 +20,7 @@ export declare class Constants {
20
20
  static FIREBASE_PARTIAL_PATH_ARROW: string;
21
21
  static FIREBASE_PARTIAL_PATH_AREA: string;
22
22
  static FIREBASE_PARTIAL_PATH_COMMENT: string;
23
+ static FIREBASE_PARTIAL_PATH_LOCATION: string;
23
24
  static FIREBASE_PARTIAL_PATH_MULTI_THREAD: string;
24
25
  static FIREBASE_PARTIAL_PATH_TAG: string;
25
26
  static FIREBASE_PARTIAL_PATH_SELECTION: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veltdev/types-dev",
3
- "version": "4.2.0-beta.1",
3
+ "version": "4.2.0-beta.11",
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": [