@engagently/types 7.6.2 → 8.0.1

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.
@@ -24,34 +24,55 @@ export declare enum EgyEntities {
24
24
  EGY_POLL = "egy-poll",
25
25
  EGY_POLL_BAR = "egy-poll-bar",
26
26
  EGY_POLL_GRID = "egy-poll-grid",
27
- EGY_POLL_SLIDER = "egy-poll-slider"
27
+ EGY_POLL_SLIDER = "egy-poll-slider",
28
+ EGY_GALLERY = "egy-gallery"
28
29
  }
29
30
  export type EgyEntitiesValues = `${EgyEntities}`;
30
31
  export declare enum SharedSlots {
31
- CTA_HEADER = "ctaHeader"
32
+ CTA_HEADER = "ctaHeader",
33
+ ERROR_ICON = "errorIcon",
34
+ WARNING_ICON = "warningIcon",
35
+ INFO_ICON = "infoIcon",
36
+ SUCCESS_ICON = "successIcon",
37
+ DROPDOWN_TRIGGER_CARET = "dropdownTriggerCaret"
32
38
  }
33
39
  export declare enum CommentaryActionIconSlots {
34
40
  BOOKMARK_ICON = "bookmarkIcon",
35
41
  BOOKMARK_ICON_ACTIVE = "bookmarkIconActive",
42
+ CONTINUE_READING_ICON = "continueReadingIcon",
36
43
  DELETE_ICON = "deleteIcon",
37
44
  EDIT_ICON = "editIcon",
38
45
  IGNORE_ICON = "ignoreIcon",
39
46
  IGNORE_ICON_ACTIVE = "ignoreIconActive",
47
+ MENU_TRIGGER_ICON = "menuTriggerIcon",
40
48
  MODERATE_ICON = "moderateIcon",
49
+ REACTION_AGREE = "reactionAgree",
50
+ REACTION_AGREE_active = "reactionAgree_active",
51
+ REACTION_DISAGREE = "reactionDisagree",
52
+ REACTION_DISAGREE_active = "reactionDisagree_active",
41
53
  REACTION1 = "reaction1",
42
54
  REACTION1_active = "reaction1_active",
43
55
  REACTION2 = "reaction2",
44
56
  REACTION2_active = "reaction2_active",
45
57
  REACTION3 = "reaction3",
46
58
  REACTION3_active = "reaction3_active",
47
- REACTION_AGREE = "reactionAgree",
48
- REACTION_DISAGREE = "reactionDisagree",
49
- REACTION_AGREE_active = "reactionAgree_active",
50
- REACTION_DISAGREE_active = "reactionDisagree_active",
51
59
  REPLY_ICON = "replyIcon",
60
+ REPLIES_ICON = "repliesToggleIcon_closed",
61
+ REPLIES_ACTIVE_ICON = "repliesToggleIcon_open",
62
+ REPLIES_SECONDARY_ICON = "repliesSecondaryIcon",
52
63
  REPORT_ICON = "reportIcon",
53
64
  REPORT_ICON_ACTIVE = "reportIconActive",
54
- SHARE_ICON = "shareIcon"
65
+ SHARE_ICON = "shareIcon",
66
+ SHOW_REPLIES_ICON = "showRepliesIcon",
67
+ SHOW_MORE_TEXT_ICON = "showMoreTextIcon",
68
+ SHOW_LESS_TEXT_ICON = "showLessTextIcon",
69
+ LOAD_MORE_ICON = "loadMoreIcon"
70
+ }
71
+ export declare enum CommentarySortIconSlots {
72
+ SORT_ASC_ICON = "sortAscIcon",
73
+ SORT_DESC_ICON = "sortDescIcon",
74
+ SORT_POPULARITY_ICON = "sortPopularityIcon",
75
+ SORT_SELECTED_ICON = "sortSelectedIcon"
55
76
  }
56
77
  /**
57
78
  * MAKE SURE TO UPDATE THE TYPES IN THE FOLLOWING PLACES WHEN CHANGING ATTRS:
@@ -108,7 +129,7 @@ export declare enum DiscussionIconSlots {
108
129
  export declare enum DiscussionSlots {
109
130
  CUSTOM_CALL_TO_ACTION = "customCallToAction"
110
131
  }
111
- export type DiscussionSlotValues = `${SharedSlots}` | `${CommentaryActionIconSlots}` | `${UserIconSlots}` | `${DiscussionSlots}` | `${DiscussionIconSlots}` | `${DiscussionMessagesSlots}`;
132
+ export type DiscussionSlotValues = `${SharedSlots}` | `${CommentaryActionIconSlots}` | `${CommentarySortIconSlots}` | `${UserIconSlots}` | `${DiscussionSlots}` | `${DiscussionIconSlots}` | `${DiscussionMessagesSlots}`;
112
133
  export interface DiscussionWidget {
113
134
  name: EgyEntities.EGY_DISCUSSION;
114
135
  slots: Array<DiscussionSlotValues>;
@@ -124,11 +145,13 @@ export declare enum CommentaryActions {
124
145
  REACTION2 = "reaction2",
125
146
  REACTION3 = "reaction3",
126
147
  REPLY = "reply",
148
+ REPLIES = "replies",
127
149
  REPORT = "report",
128
150
  SHARE = "share"
129
151
  }
130
152
  export type CommentaryActionPlacements = {
131
153
  footer?: Array<`${CommentaryActions}`>;
154
+ footerEnd?: Array<`${CommentaryActions}`>;
132
155
  header?: Array<`${CommentaryActions}`>;
133
156
  menu?: Array<`${CommentaryActions}`>;
134
157
  };
@@ -152,7 +175,8 @@ export declare enum UserIconSlots {
152
175
  USER_ICON = "userIcon"
153
176
  }
154
177
  export declare enum UserSlots {
155
- ACTION_ELEMENT = "actionElement"
178
+ ACTION_ELEMENT = "actionElement",
179
+ BEFORE_WIDGET = "beforeWidget"
156
180
  }
157
181
  export declare enum UserMessagesSlots {
158
182
  LOG_IN_TO_VIEW_USER = "messages_logInToViewUser",
@@ -162,6 +186,14 @@ export declare enum UserMessagesSlots {
162
186
  USERNAME_CHANGE = "messages_usernameChange",
163
187
  USERNAME_CHANGE_PRESCRIBED = "messages_usernameChangePrescribed"
164
188
  }
189
+ export declare enum UserEvents {
190
+ SIGN_OUT = "egy-user:sign-out"
191
+ }
192
+ export interface UserWidgetEvents {
193
+ [UserEvents.SIGN_OUT]: CustomEvent<{
194
+ entity: EgyEntities;
195
+ }>;
196
+ }
165
197
  export type UserSlotValues = `${SharedSlots}` | `${CommentaryActionIconSlots}` | `${UserIconSlots}` | `${UserSlots}` | `${UserMessagesSlots}`;
166
198
  export interface UserWidget {
167
199
  name: EgyEntities.EGY_USER;
@@ -177,14 +209,24 @@ export type DebateAttributesHTMLElement = {
177
209
  export type DebateAttributesComponent = {
178
210
  debateId: string;
179
211
  };
180
- export declare enum DebateIconSlots {
212
+ export declare enum DebateStatsIconSlots {
213
+ TOTAL_COMMENTARIES_ICON = "totalCommentariesIcon",
181
214
  VISITS_ICON = "visitsIcon",
182
- PARTICIPATIONS_ICON = "participationsIcon",
215
+ PARTICIPATIONS_ICON = "participationsIcon"
216
+ }
217
+ export declare enum DebateIconSlots {
218
+ LABELS_ICON = "labelsIcon",
219
+ REPLIES_TOGGLE_ICON_closed = "repliesToggleIcon_closed",
183
220
  REPLIES_TOGGLE_ICON_open = "repliesToggleIcon_open",
184
- REPLIES_TOGGLE_ICON_closed = "repliesToggleIcon_closed"
221
+ SHOW_RESULTS_ICON = "showResultsIcon",
222
+ CHOSEN_OPTION_ICON = "chosenOptionIcon",
223
+ FINISHED_ICON = "finishedIcon",
224
+ BACK_TO_DEBATE_ICON = "backToDebateIcon"
185
225
  }
186
226
  export declare enum DebateSlots {
187
- CUSTOM_CALL_TO_ACTION = "customCallToAction"
227
+ CUSTOM_CALL_TO_ACTION = "customCallToAction",
228
+ AFTER_POLL = "afterPoll",
229
+ AFTER_DESC = "afterDesc"
188
230
  }
189
231
  export declare enum DebateMessagesSlots {
190
232
  DEBATE_CLOSED = "messages_debateClosed",
@@ -196,10 +238,9 @@ export declare enum DebateMessagesSlots {
196
238
  USER_SANCTION_BLOCK_UNTIL = "messages_userSanctionBlockUntil",
197
239
  USER_SANCTION_WARN = "messages_userSanctionWarn",
198
240
  USERNAME_CHANGE = "messages_usernameChange",
199
- USERNAME_CHANGE_PRESCRIBED = "messages_usernameChangePrescribed",
200
- VOTE_TO_DEBATE = "messages_voteToDebate"
241
+ USERNAME_CHANGE_PRESCRIBED = "messages_usernameChangePrescribed"
201
242
  }
202
- export type DebateSlotValues = `${SharedSlots}` | `${CommentaryActionIconSlots}` | `${UserIconSlots}` | `${DebateIconSlots}` | `${DebateSlots}` | `${DebateMessagesSlots}`;
243
+ export type DebateSlotValues = `${SharedSlots}` | `${CommentaryActionIconSlots}` | `${CommentarySortIconSlots}` | `${UserIconSlots}` | `${DebateIconSlots}` | `${DebateStatsIconSlots}` | `${DebateSlots}` | `${DebateMessagesSlots}`;
203
244
  export interface DebateWidget {
204
245
  name: EgyEntities.EGY_DEBATE;
205
246
  attributes: Array<`${DebateAttributes}`>;
@@ -207,6 +248,7 @@ export interface DebateWidget {
207
248
  }
208
249
  export type ArgumentActionPlacements = {
209
250
  footer?: Array<`${CommentaryActions}`>;
251
+ footerEnd?: Array<`${CommentaryActions}`>;
210
252
  header?: Array<`${CommentaryActions}`>;
211
253
  menu?: Array<`${CommentaryActions}`>;
212
254
  };
@@ -230,9 +272,9 @@ export type DebatesAttributesComponent = {
230
272
  export interface DebatesWidget {
231
273
  name: EgyEntities.EGY_DEBATES;
232
274
  attributes: Array<`${DebatesAttributes}`>;
233
- slots: Array<DebateSlotValues>;
275
+ slots: Array<DebatesSlotValues>;
234
276
  }
235
- export type DebatesSlotValues = `${SharedSlots}`;
277
+ export type DebatesSlotValues = `${SharedSlots}` | `${DebateStatsIconSlots}`;
236
278
  export interface DebateTeasersResponse {
237
279
  debates: DebateTeaser[];
238
280
  /** ISO timestamp string, e.g. "2025-09-18T16:51:35.479659Z" */
@@ -322,11 +364,12 @@ export type DebateTeaserAttributesComponent = {
322
364
  controlled?: boolean;
323
365
  data?: DebateTeasersResponse;
324
366
  };
367
+ export type DebateTeaserSlotValues = `${DebateStatsIconSlots}`;
325
368
  export interface DebateTeaserWidget {
326
369
  name: EgyEntities.EGY_DEBATE_TEASER;
327
370
  attributes: Array<`${DebateTeaserAttributes}`>;
371
+ slots: Array<DebateTeaserSlotValues>;
328
372
  }
329
- export type DebateTeaserSlotValues = `${SharedSlots}`;
330
373
  export declare enum DebatePollEvents {
331
374
  INIT = "egy-debate-poll:init",
332
375
  VOTE = "egy-debate-poll:vote"
@@ -349,6 +392,7 @@ export declare enum DebatePollAttributes {
349
392
  STATS = "stats",
350
393
  SHOW_VISITS = "show-visits",
351
394
  SHOW_PARTICIPATIONS = "show-participations",
395
+ SHOW_COMMENTARIES = "show-commentaries",
352
396
  COLOR_SCHEME = "color-scheme"
353
397
  }
354
398
  export interface DebatePollWidgetEvents {
@@ -379,6 +423,7 @@ export type DebatePollAttributesHTMLElement = {
379
423
  stats?: DebateStats | null;
380
424
  'show-visits'?: boolean | string;
381
425
  'show-participations'?: boolean | string;
426
+ 'show-commentaries'?: boolean | string;
382
427
  'color-scheme'?: string;
383
428
  };
384
429
  export type DebatePollAttributesComponent = {
@@ -393,6 +438,7 @@ export type DebatePollAttributesComponent = {
393
438
  resultCtaMessage?: string | null;
394
439
  resultDisplay?: boolean;
395
440
  showParticipations?: boolean;
441
+ showCommentaries?: boolean;
396
442
  showSkeleton?: boolean;
397
443
  showVisits?: boolean;
398
444
  stats?: DebateStats | null;
@@ -424,7 +470,7 @@ export type PollAttributesComponent = {
424
470
  type?: string;
425
471
  };
426
472
  export declare enum PollEvents {
427
- INIT = "egy-poll:init",
473
+ INIT = "egy-poll:init",// JS Loaded
428
474
  VOTE = "egy-poll:vote"
429
475
  }
430
476
  export interface PollWidgetEvents {
@@ -677,7 +723,7 @@ export type QuizAttributesComponent = {
677
723
  type?: string;
678
724
  };
679
725
  export declare enum QuizEvents {
680
- INIT = "egy-quiz:init",
726
+ INIT = "egy-quiz:init",// JS Loaded
681
727
  PARTICIPATE = "egy-quiz:participate"
682
728
  }
683
729
  export interface QuizWidgetEvents {
@@ -780,10 +826,42 @@ export interface QuizBarWidget {
780
826
  slots: Array<QuizSlotValues>;
781
827
  attributes: Array<`${QuizBarAttributes}`>;
782
828
  }
829
+ export declare enum GalleryAttributes {
830
+ DISCUSSION_ID = "discussionId",
831
+ DISCUSSION_TITLE = "discussionTitle",
832
+ SCROLL_CONTAINER_ID = "scrollContainerId",
833
+ SIGNATURE = "signature",
834
+ DISCUSSION_DATA = "discussionData",
835
+ URL = "url",
836
+ IS_LIVE = "isLive",
837
+ IMAGE_URL = "imageUrl",
838
+ FORM_POSITION = "formPosition"
839
+ }
840
+ export type GalleryAttributesHTMLElement = {
841
+ 'discussion-id': string;
842
+ 'form-position'?: 'before-gallery' | 'after-gallery';
843
+ };
844
+ export type GalleryAttributesComponent = {
845
+ discussionId: string;
846
+ formPosition?: 'before-gallery' | 'after-gallery';
847
+ };
848
+ export declare enum GallerySlots {
849
+ BEFORE_GALLERY = "beforeGallery",
850
+ AFTER_GALLERY = "afterGallery"
851
+ }
852
+ export declare enum GalleryIconSlots {
853
+ COMMENT_ICON = "commentIcon"
854
+ }
855
+ export type GallerySlotValues = `${SharedSlots}` | `${CommentaryActionIconSlots}` | `${CommentarySortIconSlots}` | `${DiscussionIconSlots}` | `${DiscussionMessagesSlots}` | `${DiscussionSlots}` | `${UserIconSlots}` | `${GallerySlots}` | `${GalleryIconSlots}`;
856
+ export interface GalleryWidget {
857
+ name: EgyEntities.EGY_GALLERY;
858
+ attributes: Array<`${GalleryAttributes}`>;
859
+ slots: Array<GallerySlotValues>;
860
+ }
783
861
  /**
784
862
  * Events that can be used by the pub/sub implementation for window.postMessage
785
863
  */
786
- export type MessageEvents = 'EGY_SETUP' | 'EGY_SIGN_IN' | 'EGY_SIGNED_OUT' | 'EGY_AUTHENTICATED' | 'EGY_TOGGLE_COLOR_SCHEME' | 'EGY_CHANGE_LANGUAGE' | 'EGY_CHANGE_VIEW_MODE' | 'EGY_LOAD_MORE_COMMENTS' | 'EGY_LOAD_MORE_REPLIES' | 'EGY_SUBMIT_COMMENTARY' | 'EGY_COMMENTARY_ACTION' | 'EGY_REINIT' | 'EGY_CAN_LOGOUT' | 'EGY_EXPERIENCE_PARTICIPATED' | 'EGY_EXPERIENCE_COMPLETED';
864
+ export type MessageEvents = 'EGY_SETUP' | 'EGY_SIGN_IN' | 'EGY_SIGNED_OUT' | 'EGY_AUTHENTICATED' | 'EGY_TOGGLE_COLOR_SCHEME' | 'EGY_CHANGE_LANGUAGE' | 'EGY_CHANGE_VIEW_MODE' | 'EGY_LOAD_MORE_COMMENTS' | 'EGY_LOAD_MORE_REPLIES' | 'EGY_SUBMIT_COMMENTARY' | 'EGY_COMMENTARY_ACTION' | 'EGY_REINIT' | 'EGY_CAN_LOGOUT' | 'EGY_EXPERIENCE_PARTICIPATED' | 'EGY_EXPERIENCE_COMPLETED' | 'EGY_SCROLL_TO_DISCUSSION';
787
865
  export declare const EGY_AUTH = "egy_auth";
788
866
  export type EgyAuth = {
789
867
  accessToken: string;
@@ -89,6 +89,10 @@ export declare const defaultResources: {
89
89
  "current-debates": string;
90
90
  "desc-header": string;
91
91
  "filter-by": string;
92
+ "filter-counter": {
93
+ "all-arguments": string;
94
+ "choice-arguments": string;
95
+ };
92
96
  filters: {
93
97
  ACTIVE: {
94
98
  description: string;
@@ -108,6 +112,8 @@ export declare const defaultResources: {
108
112
  };
109
113
  };
110
114
  inactive: string;
115
+ "inactive-desc": string;
116
+ "jump-to-comments": string;
111
117
  labels: {
112
118
  "filter-debates": string;
113
119
  "sort-debates": string;
@@ -122,11 +128,14 @@ export declare const defaultResources: {
122
128
  "new-commentary": string;
123
129
  };
124
130
  "thank-you-for-vote": string;
131
+ "view-results": string;
125
132
  viewed: string;
126
133
  vote_one: string;
127
134
  vote_other: string;
135
+ "vote-to-debate": string;
128
136
  voted: string;
129
- "your-vote-heading": string;
137
+ "voting-hint-changeable": string;
138
+ "voting-hint-fixed": string;
130
139
  };
131
140
  readonly discussions: {
132
141
  alerts: {
@@ -176,7 +185,12 @@ export declare const defaultResources: {
176
185
  deletable: string;
177
186
  inactive: string;
178
187
  };
179
- delete: string;
188
+ delete: {
189
+ action: string;
190
+ hint: string;
191
+ submitted: string;
192
+ title: string;
193
+ };
180
194
  edit: string;
181
195
  ignore: {
182
196
  action: string;
@@ -197,6 +211,8 @@ export declare const defaultResources: {
197
211
  REACTION3: string;
198
212
  REACTION3_zero: string;
199
213
  };
214
+ replies: string;
215
+ replies_other: string;
200
216
  reply: string;
201
217
  report: {
202
218
  action: string;
@@ -333,6 +349,8 @@ export declare const defaultResources: {
333
349
  title: string;
334
350
  };
335
351
  share: string;
352
+ "show-replies_one": string;
353
+ "show-replies_other": string;
336
354
  unignore: string;
337
355
  };
338
356
  "commentary-not-available": string;
@@ -500,6 +518,15 @@ export declare const defaultResources: {
500
518
  required: string;
501
519
  };
502
520
  };
521
+ readonly gallery: {
522
+ "back-to-gallery": string;
523
+ consent: string;
524
+ entry_one: string;
525
+ entry_other: string;
526
+ placeholders: {
527
+ "new-commentary": string;
528
+ };
529
+ };
503
530
  readonly interpolation: {
504
531
  comment: string;
505
532
  "comment-do": string;
@@ -547,7 +574,6 @@ export declare const defaultResources: {
547
574
  "user-sanction-warn": string;
548
575
  "username-change": string;
549
576
  "username-change-prescribed": string;
550
- "vote-to-debate": string;
551
577
  };
552
578
  readonly poll: {
553
579
  "call-to-action": string;
@@ -696,6 +722,10 @@ export declare const defaultResources: {
696
722
  "current-debates": string;
697
723
  "desc-header": string;
698
724
  "filter-by": string;
725
+ "filter-counter": {
726
+ "all-arguments": string;
727
+ "choice-arguments": string;
728
+ };
699
729
  filters: {
700
730
  ACTIVE: {
701
731
  description: string;
@@ -715,6 +745,8 @@ export declare const defaultResources: {
715
745
  };
716
746
  };
717
747
  inactive: string;
748
+ "inactive-desc": string;
749
+ "jump-to-comments": string;
718
750
  labels: {
719
751
  "filter-debates": string;
720
752
  "sort-debates": string;
@@ -729,11 +761,14 @@ export declare const defaultResources: {
729
761
  "new-commentary": string;
730
762
  };
731
763
  "thank-you-for-vote": string;
764
+ "view-results": string;
732
765
  viewed: string;
733
766
  vote_one: string;
734
767
  vote_other: string;
768
+ "vote-to-debate": string;
735
769
  voted: string;
736
- "your-vote-heading": string;
770
+ "voting-hint-changeable": string;
771
+ "voting-hint-fixed": string;
737
772
  };
738
773
  readonly discussions: {
739
774
  alerts: {
@@ -783,7 +818,12 @@ export declare const defaultResources: {
783
818
  deletable: string;
784
819
  inactive: string;
785
820
  };
786
- delete: string;
821
+ delete: {
822
+ action: string;
823
+ hint: string;
824
+ submitted: string;
825
+ title: string;
826
+ };
787
827
  edit: string;
788
828
  ignore: {
789
829
  action: string;
@@ -804,6 +844,8 @@ export declare const defaultResources: {
804
844
  REACTION3: string;
805
845
  REACTION3_zero: string;
806
846
  };
847
+ replies: string;
848
+ replies_other: string;
807
849
  reply: string;
808
850
  report: {
809
851
  action: string;
@@ -940,6 +982,8 @@ export declare const defaultResources: {
940
982
  title: string;
941
983
  };
942
984
  share: string;
985
+ "show-replies_one": string;
986
+ "show-replies_other": string;
943
987
  unignore: string;
944
988
  };
945
989
  "commentary-not-available": string;
@@ -1106,6 +1150,15 @@ export declare const defaultResources: {
1106
1150
  required: string;
1107
1151
  };
1108
1152
  };
1153
+ readonly gallery: {
1154
+ "back-to-gallery": string;
1155
+ consent: string;
1156
+ entry_one: string;
1157
+ entry_other: string;
1158
+ placeholders: {
1159
+ "new-commentary": string;
1160
+ };
1161
+ };
1109
1162
  readonly interpolation: {
1110
1163
  comment: string;
1111
1164
  "comment-do": string;
@@ -1153,7 +1206,6 @@ export declare const defaultResources: {
1153
1206
  "user-sanction-warn": string;
1154
1207
  "username-change": string;
1155
1208
  "username-change-prescribed": string;
1156
- "vote-to-debate": string;
1157
1209
  };
1158
1210
  readonly poll: {
1159
1211
  "call-to-action": string;
@@ -1302,6 +1354,10 @@ export declare const defaultResources: {
1302
1354
  "current-debates": string;
1303
1355
  "desc-header": string;
1304
1356
  "filter-by": string;
1357
+ "filter-counter": {
1358
+ "all-arguments": string;
1359
+ "choice-arguments": string;
1360
+ };
1305
1361
  filters: {
1306
1362
  ACTIVE: {
1307
1363
  description: string;
@@ -1335,11 +1391,14 @@ export declare const defaultResources: {
1335
1391
  "new-commentary": string;
1336
1392
  };
1337
1393
  "thank-you-for-vote": string;
1394
+ "view-results": string;
1338
1395
  viewed: string;
1339
1396
  vote_one: string;
1340
1397
  vote_other: string;
1398
+ "vote-to-debate": string;
1341
1399
  voted: string;
1342
- "your-vote-heading": string;
1400
+ "voting-hint-changeable": string;
1401
+ "voting-hint-fixed": string;
1343
1402
  };
1344
1403
  readonly discussions: {
1345
1404
  alerts: {
@@ -1389,7 +1448,12 @@ export declare const defaultResources: {
1389
1448
  deletable: string;
1390
1449
  inactive: string;
1391
1450
  };
1392
- delete: string;
1451
+ delete: {
1452
+ action: string;
1453
+ hint: string;
1454
+ submitted: string;
1455
+ title: string;
1456
+ };
1393
1457
  edit: string;
1394
1458
  ignore: {
1395
1459
  action: string;
@@ -1410,6 +1474,8 @@ export declare const defaultResources: {
1410
1474
  REACTION3: string;
1411
1475
  REACTION3_zero: string;
1412
1476
  };
1477
+ replies: string;
1478
+ replies_other: string;
1413
1479
  reply: string;
1414
1480
  report: {
1415
1481
  action: string;
@@ -1545,6 +1611,8 @@ export declare const defaultResources: {
1545
1611
  title: string;
1546
1612
  };
1547
1613
  share: string;
1614
+ "show-replies_one": string;
1615
+ "show-replies_other": string;
1548
1616
  unignore: string;
1549
1617
  };
1550
1618
  "commentary-not-available": string;
@@ -1710,6 +1778,15 @@ export declare const defaultResources: {
1710
1778
  required: string;
1711
1779
  };
1712
1780
  };
1781
+ readonly gallery: {
1782
+ "back-to-gallery": string;
1783
+ consent: string;
1784
+ entry_one: string;
1785
+ entry_other: string;
1786
+ placeholders: {
1787
+ "new-commentary": string;
1788
+ };
1789
+ };
1713
1790
  readonly interpolation: {
1714
1791
  comment: string;
1715
1792
  "comment-do": string;
@@ -1757,7 +1834,6 @@ export declare const defaultResources: {
1757
1834
  "user-sanction-warn": string;
1758
1835
  "username-change": string;
1759
1836
  "username-change-prescribed": string;
1760
- "vote-to-debate": string;
1761
1837
  };
1762
1838
  readonly poll: {
1763
1839
  "call-to-action": string;
@@ -1908,6 +1984,10 @@ declare const resources: {
1908
1984
  "current-debates": string;
1909
1985
  "desc-header": string;
1910
1986
  "filter-by": string;
1987
+ "filter-counter": {
1988
+ "all-arguments": string;
1989
+ "choice-arguments": string;
1990
+ };
1911
1991
  filters: {
1912
1992
  ACTIVE: {
1913
1993
  description: string;
@@ -1927,6 +2007,8 @@ declare const resources: {
1927
2007
  };
1928
2008
  };
1929
2009
  inactive: string;
2010
+ "inactive-desc": string;
2011
+ "jump-to-comments": string;
1930
2012
  labels: {
1931
2013
  "filter-debates": string;
1932
2014
  "sort-debates": string;
@@ -1941,11 +2023,14 @@ declare const resources: {
1941
2023
  "new-commentary": string;
1942
2024
  };
1943
2025
  "thank-you-for-vote": string;
2026
+ "view-results": string;
1944
2027
  viewed: string;
1945
2028
  vote_one: string;
1946
2029
  vote_other: string;
2030
+ "vote-to-debate": string;
1947
2031
  voted: string;
1948
- "your-vote-heading": string;
2032
+ "voting-hint-changeable": string;
2033
+ "voting-hint-fixed": string;
1949
2034
  };
1950
2035
  readonly discussions: {
1951
2036
  alerts: {
@@ -1995,7 +2080,12 @@ declare const resources: {
1995
2080
  deletable: string;
1996
2081
  inactive: string;
1997
2082
  };
1998
- delete: string;
2083
+ delete: {
2084
+ action: string;
2085
+ hint: string;
2086
+ submitted: string;
2087
+ title: string;
2088
+ };
1999
2089
  edit: string;
2000
2090
  ignore: {
2001
2091
  action: string;
@@ -2016,6 +2106,8 @@ declare const resources: {
2016
2106
  REACTION3: string;
2017
2107
  REACTION3_zero: string;
2018
2108
  };
2109
+ replies: string;
2110
+ replies_other: string;
2019
2111
  reply: string;
2020
2112
  report: {
2021
2113
  action: string;
@@ -2152,6 +2244,8 @@ declare const resources: {
2152
2244
  title: string;
2153
2245
  };
2154
2246
  share: string;
2247
+ "show-replies_one": string;
2248
+ "show-replies_other": string;
2155
2249
  unignore: string;
2156
2250
  };
2157
2251
  "commentary-not-available": string;
@@ -2319,6 +2413,15 @@ declare const resources: {
2319
2413
  required: string;
2320
2414
  };
2321
2415
  };
2416
+ readonly gallery: {
2417
+ "back-to-gallery": string;
2418
+ consent: string;
2419
+ entry_one: string;
2420
+ entry_other: string;
2421
+ placeholders: {
2422
+ "new-commentary": string;
2423
+ };
2424
+ };
2322
2425
  readonly interpolation: {
2323
2426
  comment: string;
2324
2427
  "comment-do": string;
@@ -2366,7 +2469,6 @@ declare const resources: {
2366
2469
  "user-sanction-warn": string;
2367
2470
  "username-change": string;
2368
2471
  "username-change-prescribed": string;
2369
- "vote-to-debate": string;
2370
2472
  };
2371
2473
  readonly poll: {
2372
2474
  "call-to-action": string;
@@ -2515,6 +2617,10 @@ declare const resources: {
2515
2617
  "current-debates": string;
2516
2618
  "desc-header": string;
2517
2619
  "filter-by": string;
2620
+ "filter-counter": {
2621
+ "all-arguments": string;
2622
+ "choice-arguments": string;
2623
+ };
2518
2624
  filters: {
2519
2625
  ACTIVE: {
2520
2626
  description: string;
@@ -2534,6 +2640,8 @@ declare const resources: {
2534
2640
  };
2535
2641
  };
2536
2642
  inactive: string;
2643
+ "inactive-desc": string;
2644
+ "jump-to-comments": string;
2537
2645
  labels: {
2538
2646
  "filter-debates": string;
2539
2647
  "sort-debates": string;
@@ -2548,11 +2656,14 @@ declare const resources: {
2548
2656
  "new-commentary": string;
2549
2657
  };
2550
2658
  "thank-you-for-vote": string;
2659
+ "view-results": string;
2551
2660
  viewed: string;
2552
2661
  vote_one: string;
2553
2662
  vote_other: string;
2663
+ "vote-to-debate": string;
2554
2664
  voted: string;
2555
- "your-vote-heading": string;
2665
+ "voting-hint-changeable": string;
2666
+ "voting-hint-fixed": string;
2556
2667
  };
2557
2668
  readonly discussions: {
2558
2669
  alerts: {
@@ -2602,7 +2713,12 @@ declare const resources: {
2602
2713
  deletable: string;
2603
2714
  inactive: string;
2604
2715
  };
2605
- delete: string;
2716
+ delete: {
2717
+ action: string;
2718
+ hint: string;
2719
+ submitted: string;
2720
+ title: string;
2721
+ };
2606
2722
  edit: string;
2607
2723
  ignore: {
2608
2724
  action: string;
@@ -2623,6 +2739,8 @@ declare const resources: {
2623
2739
  REACTION3: string;
2624
2740
  REACTION3_zero: string;
2625
2741
  };
2742
+ replies: string;
2743
+ replies_other: string;
2626
2744
  reply: string;
2627
2745
  report: {
2628
2746
  action: string;
@@ -2759,6 +2877,8 @@ declare const resources: {
2759
2877
  title: string;
2760
2878
  };
2761
2879
  share: string;
2880
+ "show-replies_one": string;
2881
+ "show-replies_other": string;
2762
2882
  unignore: string;
2763
2883
  };
2764
2884
  "commentary-not-available": string;
@@ -2925,6 +3045,15 @@ declare const resources: {
2925
3045
  required: string;
2926
3046
  };
2927
3047
  };
3048
+ readonly gallery: {
3049
+ "back-to-gallery": string;
3050
+ consent: string;
3051
+ entry_one: string;
3052
+ entry_other: string;
3053
+ placeholders: {
3054
+ "new-commentary": string;
3055
+ };
3056
+ };
2928
3057
  readonly interpolation: {
2929
3058
  comment: string;
2930
3059
  "comment-do": string;
@@ -2972,7 +3101,6 @@ declare const resources: {
2972
3101
  "user-sanction-warn": string;
2973
3102
  "username-change": string;
2974
3103
  "username-change-prescribed": string;
2975
- "vote-to-debate": string;
2976
3104
  };
2977
3105
  readonly poll: {
2978
3106
  "call-to-action": string;
@@ -3121,6 +3249,10 @@ declare const resources: {
3121
3249
  "current-debates": string;
3122
3250
  "desc-header": string;
3123
3251
  "filter-by": string;
3252
+ "filter-counter": {
3253
+ "all-arguments": string;
3254
+ "choice-arguments": string;
3255
+ };
3124
3256
  filters: {
3125
3257
  ACTIVE: {
3126
3258
  description: string;
@@ -3154,11 +3286,14 @@ declare const resources: {
3154
3286
  "new-commentary": string;
3155
3287
  };
3156
3288
  "thank-you-for-vote": string;
3289
+ "view-results": string;
3157
3290
  viewed: string;
3158
3291
  vote_one: string;
3159
3292
  vote_other: string;
3293
+ "vote-to-debate": string;
3160
3294
  voted: string;
3161
- "your-vote-heading": string;
3295
+ "voting-hint-changeable": string;
3296
+ "voting-hint-fixed": string;
3162
3297
  };
3163
3298
  readonly discussions: {
3164
3299
  alerts: {
@@ -3208,7 +3343,12 @@ declare const resources: {
3208
3343
  deletable: string;
3209
3344
  inactive: string;
3210
3345
  };
3211
- delete: string;
3346
+ delete: {
3347
+ action: string;
3348
+ hint: string;
3349
+ submitted: string;
3350
+ title: string;
3351
+ };
3212
3352
  edit: string;
3213
3353
  ignore: {
3214
3354
  action: string;
@@ -3229,6 +3369,8 @@ declare const resources: {
3229
3369
  REACTION3: string;
3230
3370
  REACTION3_zero: string;
3231
3371
  };
3372
+ replies: string;
3373
+ replies_other: string;
3232
3374
  reply: string;
3233
3375
  report: {
3234
3376
  action: string;
@@ -3364,6 +3506,8 @@ declare const resources: {
3364
3506
  title: string;
3365
3507
  };
3366
3508
  share: string;
3509
+ "show-replies_one": string;
3510
+ "show-replies_other": string;
3367
3511
  unignore: string;
3368
3512
  };
3369
3513
  "commentary-not-available": string;
@@ -3529,6 +3673,15 @@ declare const resources: {
3529
3673
  required: string;
3530
3674
  };
3531
3675
  };
3676
+ readonly gallery: {
3677
+ "back-to-gallery": string;
3678
+ consent: string;
3679
+ entry_one: string;
3680
+ entry_other: string;
3681
+ placeholders: {
3682
+ "new-commentary": string;
3683
+ };
3684
+ };
3532
3685
  readonly interpolation: {
3533
3686
  comment: string;
3534
3687
  "comment-do": string;
@@ -3576,7 +3729,6 @@ declare const resources: {
3576
3729
  "user-sanction-warn": string;
3577
3730
  "username-change": string;
3578
3731
  "username-change-prescribed": string;
3579
- "vote-to-debate": string;
3580
3732
  };
3581
3733
  readonly poll: {
3582
3734
  "call-to-action": string;
@@ -24,6 +24,7 @@ import type {
24
24
  QuizBarAttributesHTMLElement,
25
25
  QuizWidgetEvents,
26
26
  UserAttributesHTMLElement,
27
+ UserWidgetEvents,
27
28
  } from '../common/_types/WidgetDefinitions';
28
29
 
29
30
  ////// exposed types package exports
@@ -37,6 +38,7 @@ export {
37
38
  QuizEvents,
38
39
  QuizWidgetEvents,
39
40
  DebatePollWidgetEvents,
41
+ UserWidgetEvents,
40
42
  };
41
43
  export {
42
44
  DebateAttributesComponent,
@@ -133,6 +135,7 @@ declare global {
133
135
 
134
136
  interface HTMLElementEventMap extends PollWidgetEvents {}
135
137
  interface HTMLElementEventMap extends QuizWidgetEvents {}
138
+ interface HTMLElementEventMap extends UserWidgetEvents {}
136
139
 
137
140
  interface Window {
138
141
  engagently?: Engagently;
@@ -130,6 +130,7 @@ export type DebatePollData = {
130
130
  showCommentaries?: boolean;
131
131
  commentaries?: number;
132
132
  };
133
+ labels?: Array<string> | null;
133
134
  };
134
135
  export type DebatePollChoice = {
135
136
  id?: string;
@@ -21,7 +21,11 @@ export type ThemeSettings = {
21
21
  buttonDiscussionFocusVariant: ButtonVariants;
22
22
  buttonRepliesColor?: ComponentColorScheme;
23
23
  buttonRepliesVariant: ButtonVariants;
24
+ commentaryChoicePosition?: 'author' | 'comment';
25
+ commentaryCounterDisplayMode?: 'countdown' | 'progress';
26
+ commentaryDatePosition?: 'author' | 'comment';
24
27
  commentaryActionPlacements?: CommentaryActionPlacements;
28
+ commentaryMenuPosition?: 'header' | 'footer';
25
29
  lineThickness: number;
26
30
  userNavType?: 'icon' | 'text' | 'icon-text';
27
31
  viewControlTabSize?: ButtonSizes;
@@ -50,7 +50,7 @@ export type ThemePalette = {
50
50
  white: string;
51
51
  mode: 'light' | 'dark';
52
52
  };
53
- declare const generateDefaultPalette: () => Omit<ThemePalette, 'background' | 'text' | 'mode' | 'elements' | 'default'>;
53
+ declare const generateDefaultPalette: () => Omit<ThemePalette, "background" | "text" | "mode" | "elements" | "default">;
54
54
  declare const generatePaletteLight: () => ThemePalette;
55
55
  declare const generatePaletteDark: () => ThemePalette;
56
56
  export { generateDefaultPalette, generatePaletteDark, generatePaletteLight };
@@ -1,6 +1,6 @@
1
1
  type IsNumberOrString<T> = T extends undefined ? string : number;
2
2
  export type ThemeSpacing = typeof spacing;
3
3
  declare const spacing: <T extends true | undefined = undefined>(space: number, options?: {
4
- asNumber?: T | undefined;
5
- } | undefined) => IsNumberOrString<T>;
4
+ asNumber?: T;
5
+ }) => IsNumberOrString<T>;
6
6
  export { spacing };
package/package.json CHANGED
@@ -14,7 +14,7 @@
14
14
  "main": "./index.ts",
15
15
  "name": "@engagently/types",
16
16
  "types": "dist/types/engagently.d.ts",
17
- "version": "7.6.2",
17
+ "version": "8.0.1",
18
18
  "scripts": {
19
19
  "build": "vite build",
20
20
  "clean": "rimraf dist"