@engagently/types 4.2.0 → 4.3.1

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

@@ -6,6 +6,7 @@ import type { EgyEntities, MessageEvents } from './WidgetDefinitions';
 import type { DsmFeatureName } from '../lib/api/enums';
 export declare enum ExperienceCallBackNames {
     POLL_BAR = "POLL_BAR",
+    POLL_GRID = "POLL_GRID",
     POLL_SLIDER = "POLL_SLIDER"
 }
 export type CallbackFn = (data: {
@@ -54,6 +55,7 @@ export type CommunityConfig = {
         discussion: {
             settings: {
                 BOOKMARK_MAX_COUNT: number;
+                IGNORE_MAX_COUNT: number;
                 COMMENTARY_MAX_LENGTH: number;
                 COMMENTARY_PREVIEW_LENGTH: number;
                 LIST_COMMENTARIES_SIZE: number;

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

@@ -1,6 +1,6 @@
 import type { VNode } from 'preact';
 import type { ExperienceParticipationFragment } from '../../widgets/src/poll/data/ExperienceFragments.generated';
-import type { PollBarData, ChartData } from '../../ui/core/_types';
+import type { PollBarData, PollGridData, ChartData } from '../../ui/core/_types';
 /**
  * Type Definitions for all available entities
  *
@@ -15,6 +15,7 @@ export declare enum EgyEntities {
     EGY_DISCUSSION = "egy-discussion",
     EGY_POLL = "egy-poll",
     EGY_POLL_BAR = "egy-poll-bar",
+    EGY_POLL_GRID = "egy-poll-grid",
     EGY_POLL_SLIDER = "egy-poll-slider"
 }
 export type EgyEntitiesValues = `${EgyEntities}`;
@@ -31,6 +32,7 @@ export declare enum DiscussionAttributes {
     SCROLL_CONTAINER_ID = "scrollContainerId",
     DISCUSSION_TITLE = "discussionTitle",
     SIGNATURE = "signature",
+    DISCUSSION_DATA = "discussionData",
     URL = "url",
     IS_LIVE = "isLive",
     IMAGE_URL = "imageUrl"
@@ -40,6 +42,7 @@ export type DiscussionAttributesHTMLElement = {
     'scroll-container-id'?: string;
     'discussion-title'?: string;
     signature?: string;
+    'discussion-data'?: string;
     url?: string;
     'is-live'?: boolean;
     'image-url'?: string;
@@ -49,6 +52,7 @@ export type DiscussionAttributesComponent = {
     scrollContainerId?: string;
     discussionTitle?: string;
     signature?: string;
+    discussionData?: string;
     url?: string;
     isLive?: boolean;
     imageUrl?: string;
@@ -69,6 +73,8 @@ export declare enum DiscussionIconSlots {
     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",
@@ -97,6 +103,7 @@ export interface DiscussionWidget {
 }
 export declare enum DiscussionCommentaryActions {
     BOOKMARK = "bookmark",
+    IGNORE = "ignore",
     DELETE = "delete",
     EDIT = "edit",
     MODERATE = "moderate",
@@ -211,6 +218,67 @@ export interface PollBarWidget {
     slots: Array<PollSlotValues>;
     attributes: Array<`${PollBarAttributes}`>;
 }
+/**
+ * MAKE SURE TO UPDATE THE TYPES IN THE FOLLOWING PLACES WHEN CHANGING ATTRS:
+ * - PollGridAttributesHTMLElement
+ * - PollGridAttributesComponent
+ *
+ * also make sure to update the assignment in the PollGridPortal component, and
+ * extend the PollGrid Widget!
+ */
+export declare enum PollGridAttributes {
+    POLL_DATA = "poll-data",
+    CURRENT_USER_PARTICIPATION = "current-user-participation",
+    SHOW_SKELETON = "show-skeleton",
+    IS_LOADING = "is-loading",
+    IS_DISABLED = "is-disabled",
+    VOTE_ACTION_ENABLED = "vote-action-enabled",
+    VOTE_DISPLAY = "vote-display",
+    VOTE_CTA_ENABLED = "vote-cta-enabled",
+    VOTE_CTA_MESSAGE = "vote-cta-message",
+    RESULT_ACTION_ENABLED = "result-action-enabled",
+    RESULT_DISPLAY = "result-display",
+    RESULT_CTA_ENABLED = "result-cta-enabled",
+    RESULT_CTA_MESSAGE = "result-cta-message",
+    DISPLAY_STATS = "display-stats"
+}
+export interface PollGridAttributesHTMLElement {
+    ['poll-data']?: PollGridData | null;
+    ['current-user-participation']?: ExperienceParticipationFragment | null;
+    ['show-skeleton']?: boolean | string;
+    ['is-loading']?: boolean | string;
+    ['is-disabled']?: boolean | string;
+    ['vote-action-enabled']?: boolean | string;
+    ['vote-display']?: boolean | string;
+    ['vote-cta-enabled']?: boolean | string;
+    ['vote-cta-message']?: string | null;
+    ['result-action-enabled']?: boolean | string;
+    ['result-display']?: boolean | string;
+    ['result-cta-enabled']?: boolean | string;
+    ['result-cta-message']?: string | null;
+    ['display-stats']?: boolean | string;
+}
+export interface PollGridAttributesComponent {
+    pollData?: PollGridData | null;
+    currentUserParticipation?: ExperienceParticipationFragment | null;
+    showSkeleton?: boolean;
+    isLoading?: boolean;
+    isDisabled?: boolean;
+    voteActionEnabled?: boolean;
+    voteDisplay?: boolean;
+    voteCtaEnabled?: boolean;
+    voteCtaMessage?: string | null;
+    resultActionEnabled?: boolean;
+    resultDisplay?: boolean;
+    resultCtaEnabled?: boolean;
+    resultCtaMessage?: string | null;
+    displayStats?: boolean;
+}
+export interface PollGridWidget {
+    name: EgyEntities.EGY_POLL_GRID;
+    slots: Array<PollSlotValues>;
+    attributes: Array<`${PollGridAttributes}`>;
+}
 /**
  * MAKE SURE TO UPDATE THE TYPES IN THE FOLLOWING PLACES WHEN CHANGING ATTRS:
  * - PollSliderAttributesHTMLElement

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

@@ -17,6 +17,7 @@ export declare enum DsmDiscussionState {
 export declare enum DsmFeatureName {
     Comment = "COMMENT",
     CommentaryRead = "COMMENTARY_READ",
+    Ignore = "IGNORE",
     InstantContext = "INSTANT_CONTEXT",
     MyProfile = "MY_PROFILE",
     Profile = "PROFILE",
@@ -68,12 +69,6 @@ export declare enum PageStatus {
     Full = "FULL",
     Partial = "PARTIAL"
 }
-export declare enum TieBreakerSort {
-    CreatedAtAsc = "CREATED_AT_ASC",
-    CreatedAtDesc = "CREATED_AT_DESC",
-    IdAsc = "ID_ASC",
-    IdDesc = "ID_DESC"
-}
 export declare enum UserDeletionStatus {
     Completed = "COMPLETED",
     InProgress = "IN_PROGRESS",

package/dist/i18n/i18n.d.ts

@@ -31,6 +31,7 @@ export declare const defaultResources: {
             comment_other: string;
             commentary: string;
             commentary_other: string;
+            confirm: string;
             "copy-to-clipboard": string;
             "date-and-time": string;
             edited: string;
@@ -64,13 +65,20 @@ export declare const defaultResources: {
                     title_one: string;
                     title_other: string;
                 };
-                limit: {
+                "bookmark-limit": {
+                    message: string;
+                };
+                "ignore-user-limit": {
                     message: string;
                 };
                 "no-bookmarks": {
                     message: string;
                     title: string;
                 };
+                "no-ignored-users": {
+                    message: string;
+                    title: string;
+                };
                 "no-comments": {
                     message: string;
                     title: string;
@@ -83,6 +91,9 @@ export declare const defaultResources: {
                     active: string;
                     deletable: string;
                 };
+                ignore: string;
+                unignore: string;
+                "ignore-hint": string;
                 edit: string;
                 delete: string;
                 moderate: string;
@@ -173,6 +184,7 @@ export declare const defaultResources: {
                         tabs: {
                             comments: string;
                             bookmarks: string;
+                            "ignored-users": string;
                         };
                     };
                     settings: {
@@ -233,6 +245,9 @@ export declare const defaultResources: {
             SHARE: {
                 "call-to-action": string;
             };
+            IGNORE: {
+                "call-to-action": string;
+            };
         };
         interpolation: {
             comment: string;
@@ -302,6 +317,7 @@ export declare const defaultResources: {
             comment_other: string;
             commentary: string;
             commentary_other: string;
+            confirm: string;
             "copy-to-clipboard": string;
             "date-and-time": string;
             edited: string;
@@ -335,13 +351,20 @@ export declare const defaultResources: {
                     title_one: string;
                     title_other: string;
                 };
-                limit: {
+                "bookmark-limit": {
+                    message: string;
+                };
+                "ignore-user-limit": {
                     message: string;
                 };
                 "no-bookmarks": {
                     message: string;
                     title: string;
                 };
+                "no-ignored-users": {
+                    message: string;
+                    title: string;
+                };
                 "no-comments": {
                     message: string;
                     title: string;
@@ -354,6 +377,9 @@ export declare const defaultResources: {
                     active: string;
                     deletable: string;
                 };
+                ignore: string;
+                unignore: string;
+                "ignore-hint": string;
                 edit: string;
                 delete: string;
                 moderate: string;
@@ -443,6 +469,7 @@ export declare const defaultResources: {
                         tabs: {
                             comments: string;
                             bookmarks: string;
+                            "ignored-users": string;
                         };
                     };
                     settings: {
@@ -503,6 +530,9 @@ export declare const defaultResources: {
             SHARE: {
                 "call-to-action": string;
             };
+            IGNORE: {
+                "call-to-action": string;
+            };
         };
         interpolation: {
             comment: string;

package/dist/types/engagently.d.ts

@@ -9,6 +9,7 @@ import type {
   DiscussionAttributesComponent,
   PollAttributesComponent,
   PollBarAttributesHTMLElement,
+  PollGridAttributesHTMLElement,
   PollSliderAttributesHTMLElement,
 } from '../common/_types/WidgetDefinitions';
 
@@ -24,6 +25,7 @@ export {
   DiscussionAttributesComponent,
   PollAttributesComponent,
   PollBarAttributesHTMLElement,
+  PollGridAttributesHTMLElement,
   PollSliderAttributesHTMLElement,
 };
 
@@ -56,6 +58,10 @@ declare global {
         React.HTMLAttributes<HTMLElement> & PollBarAttributesHTMLElement,
         HTMLElement
       >;
+      'egy-poll-grid': React.DetailedHTMLProps<
+        React.HTMLAttributes<HTMLElement> & PollGridAttributesHTMLElement,
+        HTMLElement
+      >;
       'egy-poll-slider': React.DetailedHTMLProps<
         React.HTMLAttributes<HTMLElement> & PollSliderAttributesHTMLElement,
         HTMLElement

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

@@ -20,6 +20,25 @@ export type PollBarChoice = {
         clicks: number;
     };
 } | null;
+/** Poll Data for the PollGrid widget */
+export type PollGridData = {
+    question?: {
+        id?: string | null;
+        text?: string | null;
+    };
+    choices?: Array<PollGridChoice> | null;
+    stats: {
+        clicks: number;
+    };
+};
+export type PollGridChoice = {
+    id: string;
+    label: string;
+    imageUrl?: string | null;
+    stats: {
+        clicks: number;
+    };
+} | null;
 /** Poll Data for the PollSlider widget */
 export type ChartData = {
     question?: {

package/package.json

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