@veltdev/sdk 4.5.0-beta.25 → 4.5.0-beta.27

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.
@@ -1,11 +1,13 @@
1
1
  import { CommentAnnotation } from "./comment-annotation.data.model";
2
2
  import { UnreadCommentsMap } from "./comment-utils.data.model";
3
3
  import { Comment } from "./comment.data.model";
4
+ import { CustomFilters } from "./custom-filter.data.model";
4
5
  import { VeltEventMetadata } from "./event-metadata.data.model";
5
6
  import { Notification } from "./notification.model";
6
7
  export interface VeltButtonClickEvent extends VeltButtonData {
7
8
  buttonContext?: VeltButtonContext;
8
9
  metadata?: VeltEventMetadata;
10
+ customFilters?: CustomFilters;
9
11
  }
10
12
  export interface VeltButtonContext {
11
13
  type?: string;
@@ -1,6 +1,11 @@
1
1
  import { CommentAnnotation } from "./comment-annotation.data.model";
2
2
  import { UnreadCommentsMap } from "./comment-utils.data.model";
3
+ import { CustomFilters } from "./custom-filter.data.model";
3
4
  import { Location } from "./location.model";
5
+ declare class FilterOption {
6
+ id: string;
7
+ name: string;
8
+ }
4
9
  declare class FilterTypeConfig {
5
10
  name?: string;
6
11
  enable?: boolean;
@@ -8,6 +13,9 @@ declare class FilterTypeConfig {
8
13
  enableGrouping?: boolean;
9
14
  order?: string[];
10
15
  placeholder?: string;
16
+ id?: string;
17
+ type?: 'custom' | 'system';
18
+ options?: FilterOption[];
11
19
  }
12
20
  export declare class CommentSidebarFilterConfig {
13
21
  location?: FilterTypeConfig;
@@ -20,6 +28,7 @@ export declare class CommentSidebarFilterConfig {
20
28
  category?: FilterTypeConfig;
21
29
  commentType?: FilterTypeConfig;
22
30
  version?: FilterTypeConfig;
31
+ [key: string]: FilterTypeConfig | undefined;
23
32
  }
24
33
  export declare class CommentSidebarGroupConfig {
25
34
  enable?: boolean;
@@ -53,6 +62,10 @@ export declare class CommentSidebarFilters {
53
62
  id: string;
54
63
  name?: string;
55
64
  }[];
65
+ [key: string]: {
66
+ id?: string;
67
+ name?: string;
68
+ }[] | string[] | undefined;
56
69
  }
57
70
  export interface CommentSidebarCustomActionsState {
58
71
  [key: string]: boolean;
@@ -62,6 +75,7 @@ export interface CommentSidebarCustomActionEventData {
62
75
  data: CommentAnnotation[];
63
76
  unreadDataMap: UnreadCommentsMap;
64
77
  systemFilteredData: CommentAnnotation[];
78
+ customFilters: CustomFilters;
65
79
  }
66
80
  export declare class CommentSidebarData {
67
81
  groupId?: string;
@@ -13,6 +13,14 @@ export interface CustomStatus extends CustomFilter {
13
13
  svg?: string;
14
14
  iconUrl?: string;
15
15
  }
16
+ export interface CustomFilterOption {
17
+ id: string;
18
+ name: string;
19
+ selected: boolean;
20
+ }
21
+ export interface CustomFilters {
22
+ [key: string]: CustomFilterOption[];
23
+ }
16
24
  export interface CustomCategory extends CustomFilter {
17
25
  }
18
26
  export interface CustomCategoryMap {
@@ -793,14 +793,26 @@ export declare class CommentElement {
793
793
 
794
794
  /**
795
795
  * To enable group multiple match
796
+ * @deprecated Use enableGroupMatchedComments instead
796
797
  */
797
798
  public enableGroupMultipleMatch: () => void;
798
799
 
799
800
  /**
800
801
  * To disable group multiple match
802
+ * @deprecated Use disableGroupMatchedComments instead
801
803
  */
802
804
  public disableGroupMultipleMatch: () => void;
803
805
 
806
+ /**
807
+ * To enable group matched comments
808
+ */
809
+ public enableGroupMatchedComments: () => void;
810
+
811
+ /**
812
+ * To disable group matched comments
813
+ */
814
+ public disableGroupMatchedComments: () => void;
815
+
804
816
  /**
805
817
  * To update context of comment annotation
806
818
  * @param annotationId Comment annotation id
@@ -1933,14 +1945,26 @@ export declare class CommentElement {
1933
1945
 
1934
1946
  /**
1935
1947
  * To enable group multiple match
1948
+ * @deprecated Use enableGroupMatchedComments instead
1936
1949
  */
1937
1950
  private _enableGroupMultipleMatch;
1938
1951
 
1939
1952
  /**
1940
1953
  * To disable group multiple match
1954
+ * @deprecated Use disableGroupMatchedComments instead
1941
1955
  */
1942
1956
  private _disableGroupMultipleMatch;
1943
1957
 
1958
+ /**
1959
+ * To enable group matched comments
1960
+ */
1961
+ private _enableGroupMatchedComments;
1962
+
1963
+ /**
1964
+ * To disable group matched comments
1965
+ */
1966
+ private _disableGroupMatchedComments;
1967
+
1944
1968
  /**
1945
1969
  * To update context of comment annotation
1946
1970
  * @param annotationId Comment annotation id
@@ -261,7 +261,7 @@ export type ReactionPinType = 'timeline' | 'comment';
261
261
  export type SidebarPosition = 'left' | 'right';
262
262
  export type SidebarSortingCriteria = 'date' | 'unread' | null;
263
263
  export type SidebarFilterCriteria = 'all' | 'read' | 'unread' | 'resolved';
264
- export type SidebarFilterSearchType = 'people' | 'assigned' | 'tagged' | 'pages' | 'documents' | 'statuses' | 'priorities' | 'categories' | 'versions';
264
+ export type SidebarFilterSearchType = 'people' | 'assigned' | 'tagged' | 'pages' | 'documents' | 'statuses' | 'priorities' | 'categories' | 'versions' | string;
265
265
  export type InlineSortingCriteria = 'createdFirst' | 'createdLast' | 'updatedFirst' | 'updatedLast';
266
266
  export type NotificationPanelMode = 'popover' | 'sidebar';
267
267
  export type SidebarActionButtonType = 'default' | 'toggle';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veltdev/sdk",
3
- "version": "4.5.0-beta.25",
3
+ "version": "4.5.0-beta.27",
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": [