@veltdev/sdk-staging 4.4.0-beta.4 → 4.4.0-beta.6

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.
@@ -0,0 +1,52 @@
1
+ import { ResolverActions } from "../../utils/enums";
2
+ import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
3
+ export interface AttachmentDataProvider {
4
+ save: (request: SaveAttachmentResolverRequest) => Promise<ResolverResponse<SaveAttachmentResolverData>>;
5
+ delete: (request: DeleteAttachmentResolverRequest) => Promise<ResolverResponse<undefined>>;
6
+ config?: ResolverConfig;
7
+ }
8
+ export interface DeleteAttachmentResolverRequest {
9
+ attachmentId: number;
10
+ metadata?: AttachmentResolverMetadata;
11
+ event?: ResolverActions;
12
+ }
13
+ export interface SaveAttachmentResolverRequest {
14
+ attachment: ResolverAttachment;
15
+ metadata?: AttachmentResolverMetadata;
16
+ event?: ResolverActions;
17
+ }
18
+ export interface PartialAttachment {
19
+ url: string;
20
+ name: string;
21
+ attachmentId: number;
22
+ }
23
+ export interface ResolverAttachment {
24
+ attachmentId: number;
25
+ /**
26
+ * File to be uploaded
27
+ */
28
+ file: File;
29
+ /**
30
+ * File name
31
+ */
32
+ name?: string;
33
+ /**
34
+ * Metadata of an attachment
35
+ */
36
+ metadata?: AttachmentResolverMetadata;
37
+ /**
38
+ * Mime type of an attachment
39
+ */
40
+ mimeType?: string;
41
+ }
42
+ export interface AttachmentResolverMetadata {
43
+ organizationId: string | null;
44
+ documentId: string | null;
45
+ folderId?: string | null;
46
+ attachmentId: number | null;
47
+ commentAnnotationId: string | null;
48
+ apiKey: string | null;
49
+ }
50
+ export interface SaveAttachmentResolverData {
51
+ url: string;
52
+ }
@@ -6,6 +6,10 @@ export declare class Attachment {
6
6
  * Auto generated.
7
7
  */
8
8
  attachmentId: number;
9
+ /**
10
+ * To check if attachment resolver is used
11
+ */
12
+ isAttachmentResolverUsed?: boolean;
9
13
  /**
10
14
  * File name
11
15
  */
@@ -40,3 +44,9 @@ export declare class Attachment {
40
44
  */
41
45
  mimeType?: any;
42
46
  }
47
+ export interface UploadFileOptions {
48
+ path: string;
49
+ file: File;
50
+ useAttachmentResolver?: boolean;
51
+ metadata?: any;
52
+ }
@@ -1,4 +1,5 @@
1
1
  import { ResolverActions } from "../../utils/enums";
2
+ import { PartialAttachment } from "./attachment-resolver.data.model";
2
3
  import { BaseMetadata } from "./base-metadata.data.model";
3
4
  import { CommentAnnotation } from "./comment-annotation.data.model";
4
5
  import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
@@ -25,12 +26,16 @@ export interface SaveCommentResolverRequest {
25
26
  [key: string]: PartialCommentAnnotation;
26
27
  };
27
28
  event?: ResolverActions;
29
+ metadata?: BaseMetadata;
28
30
  commentId?: string;
29
31
  }
30
32
  export interface PartialComment {
31
33
  commentId: string | number;
32
34
  commentHtml?: string;
33
35
  commentText?: string;
36
+ attachments?: {
37
+ [attachmentId: number]: PartialAttachment;
38
+ };
34
39
  }
35
40
  export interface PartialCommentAnnotationResult {
36
41
  strippedData: {
@@ -1,8 +1,10 @@
1
1
  import { CommentAnnotationDataProvider } from "./comment-resolver.data.model";
2
+ import { AttachmentDataProvider } from "./attachment-resolver.data.model";
2
3
  import { ReactionAnnotationDataProvider } from "./reaction-resolver.data.model";
3
4
  import { UserDataProvider } from "./user-resolver.data.model";
4
5
  export interface VeltDataProvider {
5
6
  comment?: CommentAnnotationDataProvider;
6
7
  user?: UserDataProvider;
7
8
  reaction?: ReactionAnnotationDataProvider;
9
+ attachment?: AttachmentDataProvider;
8
10
  }
@@ -24,6 +24,7 @@ export interface SaveReactionResolverRequest {
24
24
  reactionAnnotation: {
25
25
  [key: string]: PartialReactionAnnotation;
26
26
  };
27
+ metadata?: BaseMetadata;
27
28
  event?: ResolverActions;
28
29
  }
29
30
  export interface PartialReactionAnnotationResult {
@@ -2,6 +2,7 @@ export interface ResolverConfig {
2
2
  resolveTimeout?: number;
3
3
  saveRetryConfig?: RetryConfig;
4
4
  deleteRetryConfig?: RetryConfig;
5
+ getRetryConfig?: RetryConfig;
5
6
  }
6
7
  export interface ResolverResponse<T> {
7
8
  data?: T;
@@ -23,7 +23,9 @@ export declare enum ResolverActions {
23
23
  COMMENT_DELETE = "comment.delete",
24
24
  COMMENT_UPDATE = "comment.update",
25
25
  REACTION_ADD = "reaction.add",
26
- REACTION_DELETE = "reaction.delete"
26
+ REACTION_DELETE = "reaction.delete",
27
+ ATTACHMENT_ADD = "attachment.add",
28
+ ATTACHMENT_DELETE = "attachment.delete"
27
29
  }
28
30
  export declare const CommentEventTypes: {
29
31
  readonly ADD_COMMENT_ANNOTATION: "addCommentAnnotation";
package/models.d.ts CHANGED
@@ -64,6 +64,7 @@ export * from './app/models/data/views.data.model';
64
64
  export * from './app/models/data/autocomplete.data.model';
65
65
  export * from './app/models/data/reaction-annotation.data.model';
66
66
  export * from './app/models/data/reaction-resolver.data.model';
67
+ export * from './app/models/data/attachment-resolver.data.model';
67
68
  export * from './app/models/data/reaction.data.model';
68
69
  export * from './app/models/data/organization-groups.data.model';
69
70
  export * from './app/models/data/organization-metadata.model';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veltdev/sdk-staging",
3
- "version": "4.4.0-beta.4",
3
+ "version": "4.4.0-beta.6",
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": [