@engagently/types 7.0.0 → 7.1.0

package/dist/common/_types/WidgetDefinitions.d.ts

@@ -16,8 +16,9 @@ export declare enum EgyEntities {
     EGY_DISCUSSION = "egy-discussion",
     EGY_DEBATE = "egy-debate",
     EGY_DEBATES = "egy-debates",
-    EGY_DEBATE_PREVIEW = "egy-debate-preview",
+    EGY_DEBATE_TEASER = "egy-debate-teaser",
     EGY_DEBATE_POLL = "egy-debate-poll",
+    EGY_USER = "egy-user",
     EGY_QUIZ = "egy-quiz",
     EGY_QUIZ_BAR = "egy-quiz-bar",
     EGY_POLL = "egy-poll",
@@ -29,6 +30,25 @@ export type EgyEntitiesValues = `${EgyEntities}`;
 export declare enum SharedSlots {
     CTA_HEADER = "ctaHeader"
 }
+export declare enum CommentaryActionsSlots {
+    BOOKMARK_ICON = "bookmarkIcon",
+    BOOKMARK_ICON_ACTIVE = "bookmarkIconActive",
+    DELETE_ICON = "deleteIcon",
+    EDIT_ICON = "editIcon",
+    IGNORE_ICON = "ignoreIcon",
+    IGNORE_ICON_ACTIVE = "ignoreIconActive",
+    MODERATE_ICON = "moderateIcon",
+    REACTION1 = "reaction1",
+    REACTION1_active = "reaction1_active",
+    REACTION2 = "reaction2",
+    REACTION2_active = "reaction2_active",
+    REACTION3 = "reaction3",
+    REACTION3_active = "reaction3_active",
+    REPLY_ICON = "replyIcon",
+    REPORT_ICON = "reportIcon",
+    REPORT_ICON_ACTIVE = "reportIconActive",
+    SHARE_ICON = "shareIcon"
+}
 /**
  * MAKE SURE TO UPDATE THE TYPES IN THE FOLLOWING PLACES WHEN CHANGING ATTRS:
  * - DiscussionAttributesHTMLElement
@@ -77,25 +97,8 @@ export declare enum DiscussionMessagesSlots {
     USERNAME_CHANGE_PRESCRIBED = "messages_usernameChangePrescribed"
 }
 export declare enum DiscussionIconSlots {
-    BOOKMARK_ICON = "bookmarkIcon",
-    BOOKMARK_ICON_ACTIVE = "bookmarkIconActive",
-    DELETE_ICON = "deleteIcon",
-    EDIT_ICON = "editIcon",
-    IGNORE_ICON = "ignoreIcon",
-    IGNORE_ICON_ACTIVE = "ignoreIconActive",
     LIVE_MODE_ICON = "liveModeIcon",
-    MODERATE_ICON = "moderateIcon",
-    REACTION1 = "reaction1",
-    REACTION1_active = "reaction1_active",
-    REACTION2 = "reaction2",
-    REACTION2_active = "reaction2_active",
-    REACTION3 = "reaction3",
-    REACTION3_active = "reaction3_active",
-    REPLY_ICON = "replyIcon",
-    REPORT_ICON = "reportIcon",
-    REPORT_ICON_ACTIVE = "reportIconActive",
     SETTINGS_ICON = "settingsIcon",
-    SHARE_ICON = "shareIcon",
     USER_ICON = "userIcon",
     REPLIES_TOGGLE_ICON_open = "repliesToggleIcon_open",
     REPLIES_TOGGLE_ICON_closed = "repliesToggleIcon_closed"
@@ -103,7 +106,7 @@ export declare enum DiscussionIconSlots {
 export declare enum DiscussionSlots {
     CUSTOM_CALL_TO_ACTION = "customCallToAction"
 }
-export type DiscussionSlotValues = `${SharedSlots}` | `${DiscussionSlots}` | `${DiscussionIconSlots}` | `${DiscussionMessagesSlots}`;
+export type DiscussionSlotValues = `${SharedSlots}` | `${CommentaryActionsSlots}` | `${DiscussionSlots}` | `${DiscussionIconSlots}` | `${DiscussionMessagesSlots}`;
 export interface DiscussionWidget {
     name: EgyEntities.EGY_DISCUSSION;
     slots: Array<DiscussionSlotValues>;
@@ -128,6 +131,35 @@ export type CommentaryActionPlacements = {
     menu?: Array<`${DiscussionCommentaryActions}`>;
 };
 export declare const DEFAULT_COMMENT_ACTIONS_PLACEMENTS: CommentaryActionPlacements;
+export declare enum UserAttributes {
+    INITIAL_VIEW = "initialView"
+}
+export type UserAttributesHTMLElement = {
+    'initial-view': string;
+};
+export type UserAttributesComponent = {
+    initialView: string;
+};
+export declare enum UserSlots {
+    SETTINGS_ICON = "settingsIcon",
+    USER_ICON = "userIcon",
+    IGNORE_ICON_ACTIVE = "ignoreIconActive",
+    ACTION_ELEMENT = "actionElement"
+}
+export declare enum UserMessagesSlots {
+    LOG_IN_TO_VIEW_USER = "messages_logInToViewUser",
+    USER_SANCTION_BLOCK = "messages_userSanctionBlock",
+    USER_SANCTION_BLOCK_UNTIL = "messages_userSanctionBlockUntil",
+    USER_SANCTION_WARN = "messages_userSanctionWarn",
+    USERNAME_CHANGE = "messages_usernameChange",
+    USERNAME_CHANGE_PRESCRIBED = "messages_usernameChangePrescribed"
+}
+export type UserSlotValues = `${SharedSlots}` | `${CommentaryActionsSlots}` | `${UserSlots}` | `${UserMessagesSlots}`;
+export interface UserWidget {
+    name: EgyEntities.EGY_USER;
+    attributes: Array<`${UserAttributes}`>;
+    slots: Array<`${UserSlotValues}`>;
+}
 export declare enum DebateAttributes {
     DEBATE_ID = "debateId"
 }
@@ -142,11 +174,6 @@ export declare enum DebateIconSlots {
     PARTICIPATIONS_ICON = "participationsIcon",
     USER_ICON = "userIcon",
     SETTINGS_ICON = "settingsIcon",
-    REPLY_ICON = "replyIcon",
-    REACTION1 = "reaction1",
-    REACTION1_active = "reaction1_active",
-    REACTION2 = "reaction2",
-    REACTION2_active = "reaction2_active",
     REPLIES_TOGGLE_ICON_open = "repliesToggleIcon_open",
     REPLIES_TOGGLE_ICON_closed = "repliesToggleIcon_closed"
 }
@@ -166,23 +193,27 @@ export declare enum DebateMessagesSlots {
     USERNAME_CHANGE_PRESCRIBED = "messages_usernameChangePrescribed",
     VOTE_TO_DEBATE = "messages_voteToDebate"
 }
-export type DebateSlotValues = `${SharedSlots}` | `${DebateIconSlots}` | `${DebateSlots}` | `${DebateMessagesSlots}`;
+export type DebateSlotValues = `${SharedSlots}` | `${CommentaryActionsSlots}` | `${DebateIconSlots}` | `${DebateSlots}` | `${DebateMessagesSlots}`;
 export interface DebateWidget {
     name: EgyEntities.EGY_DEBATE;
     attributes: Array<`${DebateAttributes}`>;
     slots: Array<DebateSlotValues>;
 }
+export declare enum DebatesTarget {
+    BLANK = "_blank",
+    SELF = "_self"
+}
 export declare enum DebatesAttributes {
     COUNT = "count",
     TARGET = "target"
 }
 export type DebatesAttributesHTMLElement = {
     count?: string;
-    target?: '_blank' | '_self';
+    target?: string;
 };
 export type DebatesAttributesComponent = {
     count?: string;
-    target?: '_blank' | '_self';
+    target?: DebatesTarget;
 };
 export interface DebatesWidget {
     name: EgyEntities.EGY_DEBATES;
@@ -190,26 +221,52 @@ export interface DebatesWidget {
     slots: Array<DebateSlotValues>;
 }
 export type DebatesSlotValues = `${SharedSlots}`;
-export declare enum DebatePreviewAttributes {
-    DEBATE_ID = "debate-id",
-    JSON_URL = "json-url",
-    TARGET = "target"
-}
-export type DebatePreviewAttributesHTMLElement = {
+export declare enum DebateTeaserTarget {
+    BLANK = "_blank",
+    SELF = "_self"
+}
+export declare enum DebateTeaserSort {
+    MOST_COMMENTED = "most_commented",
+    NEWEST = "newest",
+    MOST_PARTICIPATED = "most_participated",
+    MOST_VISITED = "most_visited",
+    RANDOM = "random"
+}
+export declare enum DebateTeaserAttributes {
+    BASIS = "basis",
+    COUNT = "count",
+    DEBATE_ID = "debateId",
+    HOST = "host",
+    SORT = "sort",
+    TARGET = "target",
+    SECTIONS = "sections",
+    LABELS = "labels"
+}
+export type DebateTeaserAttributesHTMLElement = {
+    basis?: string;
+    count?: string;
     'debate-id'?: string;
-    'json-url'?: string;
-    target?: '_blank' | '_self';
+    host?: string;
+    sort?: string;
+    target?: string;
+    sections?: string;
+    labels?: string;
 };
-export type DebatePreviewAttributesComponent = {
-    debateId?: string;
-    jsonUrl?: string;
-    target?: '_blank' | '_self';
+export type DebateTeaserAttributesComponent = {
+    basis: string;
+    count?: number;
+    debateId?: string[];
+    host?: string;
+    sort?: DebateTeaserSort;
+    target?: DebateTeaserTarget;
+    sections?: string[];
+    labels?: string[];
 };
-export interface DebatePreviewWidget {
-    name: EgyEntities.EGY_DEBATE_PREVIEW;
-    attributes: Array<`${DebatePreviewAttributes}`>;
+export interface DebateTeaserWidget {
+    name: EgyEntities.EGY_DEBATE_TEASER;
+    attributes: Array<`${DebateTeaserAttributes}`>;
 }
-export type DebatePreviewSlotValues = `${SharedSlots}`;
+export type DebateTeaserSlotValues = `${SharedSlots}`;
 export declare enum DebatePollEvents {
     INIT = "egy-debate-poll:init",
     VOTE = "egy-debate-poll:vote"

package/dist/common/lib/api/enums.d.ts

@@ -4,6 +4,7 @@ export declare enum DsmCommentariesSort {
     PopularityDesc = "POPULARITY_DESC"
 }
 export declare enum DsmCommentaryReportReason {
+    Behaviour = "BEHAVIOUR",
     Bully = "BULLY",
     Fake = "FAKE",
     Hate = "HATE",
@@ -14,6 +15,7 @@ export declare enum DsmCommentaryReportReason {
     Spam = "SPAM",
     Terms = "TERMS",
     Toxic = "TOXIC",
+    Username = "USERNAME",
     Violence = "VIOLENCE"
 }
 export declare enum DsmFeatureName {

package/dist/i18n/i18n.d.ts

@@ -57,6 +57,8 @@ export declare const defaultResources: {
             session: string;
             share: string;
             "shared-comment": string;
+            "shared-argument": string;
+            "shared-reply": string;
             user: {
                 bio: string;
                 name: string;
@@ -153,9 +155,13 @@ export declare const defaultResources: {
                     active: string;
                     deletable: string;
                 };
-                ignore: string;
+                ignore: {
+                    action: string;
+                    title: string;
+                    hint: string;
+                    submitted: string;
+                };
                 unignore: string;
-                "ignore-hint": string;
                 edit: string;
                 delete: string;
                 moderate: string;
@@ -176,6 +182,8 @@ export declare const defaultResources: {
                         FAKE: string;
                         TERMS: string;
                         LEGAL: string;
+                        USERNAME: string;
+                        BEHAVIOUR: string;
                     };
                     submitted: string;
                 };
@@ -376,6 +384,7 @@ export declare const defaultResources: {
             "discussion-live-closed": string;
             "discussion-preamble": string;
             "log-in-to-comment": string;
+            "log-in-to-view-user": string;
             "user-sanction-block-until": string;
             "user-sanction-block": string;
             "user-sanction-warn": string;
@@ -409,6 +418,45 @@ export declare const defaultResources: {
             participation_other: string;
             reparticipate: string;
         };
+        readonly user: {
+            alerts: {
+                "bookmark-limit": {
+                    message: string;
+                };
+                "no-bookmarks": {
+                    message: string;
+                    title: string;
+                };
+                "ignore-user-limit": {
+                    message: string;
+                };
+                "no-ignored-users": {
+                    message: string;
+                    title: string;
+                };
+            };
+            "onboarding-username-change": string;
+            "username-change-blocked": string;
+            "username-change-confirm": string;
+            views: {
+                me: {
+                    nav: string;
+                    title: string;
+                    tabs: {
+                        comments: string;
+                        bookmarks: string;
+                        "ignored-users": string;
+                        settings: {
+                            nav: string;
+                            sections: {
+                                account: string;
+                                "ignored-users": string;
+                            };
+                        };
+                    };
+                };
+            };
+        };
     };
     en: {
         readonly common: {
@@ -464,6 +512,8 @@ export declare const defaultResources: {
             session: string;
             share: string;
             "shared-comment": string;
+            "shared-argument": string;
+            "shared-reply": string;
             user: {
                 bio: string;
                 name: string;
@@ -560,9 +610,13 @@ export declare const defaultResources: {
                     active: string;
                     deletable: string;
                 };
-                ignore: string;
+                ignore: {
+                    action: string;
+                    title: string;
+                    hint: string;
+                    submitted: string;
+                };
                 unignore: string;
-                "ignore-hint": string;
                 edit: string;
                 delete: string;
                 moderate: string;
@@ -583,6 +637,8 @@ export declare const defaultResources: {
                         FAKE: string;
                         TERMS: string;
                         LEGAL: string;
+                        USERNAME: string;
+                        BEHAVIOUR: string;
                     };
                     submitted: string;
                 };
@@ -782,6 +838,7 @@ export declare const defaultResources: {
             "discussion-live-closed": string;
             "discussion-preamble": string;
             "log-in-to-comment": string;
+            "log-in-to-view-user": string;
             "user-sanction-block-until": string;
             "user-sanction-block": string;
             "user-sanction-warn": string;
@@ -815,6 +872,45 @@ export declare const defaultResources: {
             participation_other: string;
             reparticipate: string;
         };
+        readonly user: {
+            alerts: {
+                "bookmark-limit": {
+                    message: string;
+                };
+                "no-bookmarks": {
+                    message: string;
+                    title: string;
+                };
+                "ignore-user-limit": {
+                    message: string;
+                };
+                "no-ignored-users": {
+                    message: string;
+                    title: string;
+                };
+            };
+            "onboarding-username-change": string;
+            "username-change-blocked": string;
+            "username-change-confirm": string;
+            views: {
+                me: {
+                    nav: string;
+                    title: string;
+                    tabs: {
+                        comments: string;
+                        bookmarks: string;
+                        "ignored-users": string;
+                        settings: {
+                            nav: string;
+                            sections: {
+                                account: string;
+                                "ignored-users": string;
+                            };
+                        };
+                    };
+                };
+            };
+        };
     };
 };
 declare const resources: {
@@ -872,6 +968,8 @@ declare const resources: {
             session: string;
             share: string;
             "shared-comment": string;
+            "shared-argument": string;
+            "shared-reply": string;
             user: {
                 bio: string;
                 name: string;
@@ -968,9 +1066,13 @@ declare const resources: {
                     active: string;
                     deletable: string;
                 };
-                ignore: string;
+                ignore: {
+                    action: string;
+                    title: string;
+                    hint: string;
+                    submitted: string;
+                };
                 unignore: string;
-                "ignore-hint": string;
                 edit: string;
                 delete: string;
                 moderate: string;
@@ -991,6 +1093,8 @@ declare const resources: {
                         FAKE: string;
                         TERMS: string;
                         LEGAL: string;
+                        USERNAME: string;
+                        BEHAVIOUR: string;
                     };
                     submitted: string;
                 };
@@ -1191,6 +1295,7 @@ declare const resources: {
             "discussion-live-closed": string;
             "discussion-preamble": string;
             "log-in-to-comment": string;
+            "log-in-to-view-user": string;
             "user-sanction-block-until": string;
             "user-sanction-block": string;
             "user-sanction-warn": string;
@@ -1224,6 +1329,45 @@ declare const resources: {
             participation_other: string;
             reparticipate: string;
         };
+        readonly user: {
+            alerts: {
+                "bookmark-limit": {
+                    message: string;
+                };
+                "no-bookmarks": {
+                    message: string;
+                    title: string;
+                };
+                "ignore-user-limit": {
+                    message: string;
+                };
+                "no-ignored-users": {
+                    message: string;
+                    title: string;
+                };
+            };
+            "onboarding-username-change": string;
+            "username-change-blocked": string;
+            "username-change-confirm": string;
+            views: {
+                me: {
+                    nav: string;
+                    title: string;
+                    tabs: {
+                        comments: string;
+                        bookmarks: string;
+                        "ignored-users": string;
+                        settings: {
+                            nav: string;
+                            sections: {
+                                account: string;
+                                "ignored-users": string;
+                            };
+                        };
+                    };
+                };
+            };
+        };
     };
     en: {
         readonly common: {
@@ -1279,6 +1423,8 @@ declare const resources: {
             session: string;
             share: string;
             "shared-comment": string;
+            "shared-argument": string;
+            "shared-reply": string;
             user: {
                 bio: string;
                 name: string;
@@ -1375,9 +1521,13 @@ declare const resources: {
                     active: string;
                     deletable: string;
                 };
-                ignore: string;
+                ignore: {
+                    action: string;
+                    title: string;
+                    hint: string;
+                    submitted: string;
+                };
                 unignore: string;
-                "ignore-hint": string;
                 edit: string;
                 delete: string;
                 moderate: string;
@@ -1398,6 +1548,8 @@ declare const resources: {
                         FAKE: string;
                         TERMS: string;
                         LEGAL: string;
+                        USERNAME: string;
+                        BEHAVIOUR: string;
                     };
                     submitted: string;
                 };
@@ -1597,6 +1749,7 @@ declare const resources: {
             "discussion-live-closed": string;
             "discussion-preamble": string;
             "log-in-to-comment": string;
+            "log-in-to-view-user": string;
             "user-sanction-block-until": string;
             "user-sanction-block": string;
             "user-sanction-warn": string;
@@ -1630,6 +1783,45 @@ declare const resources: {
             participation_other: string;
             reparticipate: string;
         };
+        readonly user: {
+            alerts: {
+                "bookmark-limit": {
+                    message: string;
+                };
+                "no-bookmarks": {
+                    message: string;
+                    title: string;
+                };
+                "ignore-user-limit": {
+                    message: string;
+                };
+                "no-ignored-users": {
+                    message: string;
+                    title: string;
+                };
+            };
+            "onboarding-username-change": string;
+            "username-change-blocked": string;
+            "username-change-confirm": string;
+            views: {
+                me: {
+                    nav: string;
+                    title: string;
+                    tabs: {
+                        comments: string;
+                        bookmarks: string;
+                        "ignored-users": string;
+                        settings: {
+                            nav: string;
+                            sections: {
+                                account: string;
+                                "ignored-users": string;
+                            };
+                        };
+                    };
+                };
+            };
+        };
     };
 };
 declare const options: InitOptions;

package/dist/types/engagently.d.ts

@@ -8,8 +8,8 @@ import type {
   DebatePollAttributesComponent,
   DebatePollAttributesHTMLElement,
   DebatePollWidgetEvents,
-  DebatePreviewAttributesComponent,
-  DebatePreviewAttributesHTMLElement,
+  DebateTeaserAttributesComponent,
+  DebateTeaserAttributesHTMLElement,
   DebatesAttributesComponent,
   DebatesAttributesHTMLElement,
   DiscussionAttributesComponent,
@@ -42,8 +42,8 @@ export {
   DebateAttributesHTMLElement,
   DebatePollAttributesComponent,
   DebatePollAttributesHTMLElement,
-  DebatePreviewAttributesComponent,
-  DebatePreviewAttributesHTMLElement,
+  DebateTeaserAttributesComponent,
+  DebateTeaserAttributesHTMLElement,
   DebatesAttributesComponent,
   DebatesAttributesHTMLElement,
   DiscussionAttributesComponent,
@@ -62,7 +62,7 @@ declare module 'vue' {
   export interface GlobalComponents {
     EgyDebate: HTMLAttributes & DebateAttributesComponent;
     EgyDebatePoll: HTMLAttributes & DebatePollAttributesComponent;
-    EgyDebatePreview: HTMLAttributes & DebatePreviewAttributesComponent;
+    EgyDebateTeaser: HTMLAttributes & DebateTeaserAttributesComponent;
     EgyDebates: HTMLAttributes & DebatesAttributesComponent;
     EgyDiscussion: HTMLAttributes & DiscussionAttributesComponent;
     EgyPoll: HTMLAttributes & PollAttributesComponent;
@@ -87,8 +87,8 @@ declare global {
         React.HTMLAttributes<HTMLElement> & DebatePollAttributesHTMLElement,
         HTMLElement
       >;
-      'egy-debate-preview': React.DetailedHTMLProps<
-        React.HTMLAttributes<HTMLElement> & DebatePreviewAttributesHTMLElement,
+      'egy-debate-teaser': React.DetailedHTMLProps<
+        React.HTMLAttributes<HTMLElement> & DebateTeaserAttributesHTMLElement,
         HTMLElement
       >;
       'egy-debates': React.DetailedHTMLProps<

package/dist/ui/core/_types.d.ts

@@ -127,6 +127,8 @@ export type DebatePollData = {
         participations?: number;
         showVisits?: boolean;
         visits?: number;
+        showCommentaries?: boolean;
+        commentaries?: number;
     };
 };
 export type DebatePollChoice = {
@@ -144,4 +146,6 @@ export interface DebateStats {
     participations?: number;
     showVisits?: boolean;
     visits?: number;
+    showCommentaries?: boolean;
+    commentaries?: number;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@engagently/types",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "main": "./index.ts",
   "types": "dist/types/engagently.d.ts",
   "files": [