@engagently/types 3.1.3 → 4.0.0

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

@@ -1,9 +1,13 @@
 import type { defaultResources } from '../../i18n/i18n';
 import type { AvailableThemes, ColorSchemesConfig } from '../../ui/themes/_types';
-import type { PaletteConfig, ThemeSettings } from '../../ui/themes/config';
+import type { ThemeSettings } from '../../ui/themes/config';
 import type { CombinedError, Operation } from '@urql/preact';
 import type { EgyEntities, MessageEvents } from './WidgetDefinitions';
-import type { DsmFeatureName, PlmFeatureName } from '../lib/api/enums';
+import type { DsmFeatureName } from '../lib/api/enums';
+export declare enum ExperienceCallBackNames {
+    POLL_BAR = "POLL_BAR",
+    POLL_SLIDER = "POLL_SLIDER"
+}
 export type CallbackFn = (data: {
     from: EgyEntities;
     type?: string;
@@ -21,14 +25,13 @@ export interface EngageConfig {
     communityId: string;
     token?: string | null;
     strategy?: string;
-    palette?: PaletteConfig;
     theme?: `${AvailableThemes}`;
     themeSettings?: Partial<ThemeSettings>;
     defaultLanguage?: string;
     translations?: Translations;
     dev?: boolean;
     colorScheme?: `${ColorSchemesConfig}`;
-    cta?: Partial<Record<DsmFeatureName | PlmFeatureName, CallbackFn>>;
+    cta?: Partial<Record<DsmFeatureName | ExperienceCallBackNames, CallbackFn>>;
     error?: ErrorCallbackFn;
     events?: Partial<Record<EventHooks, CallbackFn>>;
 }

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

@@ -1,4 +1,7 @@
 import type { VNode } from 'preact';
+import type { ExperienceParticipationFragment } from '../../widgets/src/poll/data/ExperienceFragments.generated';
+import type { PollBarData } from '../../ui/core/PollBar/PollBar';
+import type { ChartData } from '../../ui/core/Charts/Chart';
 /**
  * Type Definitions for all available entities
  *
@@ -11,9 +14,14 @@ import type { VNode } from 'preact';
 export declare enum EgyEntities {
     EGY_TS = "engagently.ts",
     EGY_DISCUSSION = "egy-discussion",
-    EGY_POLL = "egy-poll"
+    EGY_POLL = "egy-poll",
+    EGY_POLL_BAR = "egy-poll-bar",
+    EGY_POLL_SLIDER = "egy-poll-slider"
 }
 export type EgyEntitiesValues = `${EgyEntities}`;
+export declare enum SharedSlots {
+    CTA_HEADER = "ctaHeader"
+}
 /**
  * MAKE SURE TO UPDATE THE TYPES IN THE FOLLOWING PLACES WHEN CHANGING ATTRS:
  * - DiscussionAttributesHTMLElement
@@ -46,10 +54,20 @@ export type DiscussionAttributesComponent = {
     isLive?: boolean;
     imageUrl?: string;
 };
-export declare enum DiscussionSlots {
+export declare enum DiscussionMessagesSlots {
+    DISCUSSION_CLOSED = "messages_discussionClosed",
+    DISCUSSION_GLOBAL_CLOSED = "messages_discussionGlobalClosed",
+    DISCUSSION_LIVE_CLOSED = "messages_discussionLiveClosed",
+    DISCUSSION_PREAMBLE = "messages_discussionPreamble",
+    LOG_IN_TO_COMMENT = "messages_logInToComment",
+    USER_SANCTION_BLOCK = "messages_userSanctionBlock",
+    USER_SANCTION_BLOCK_UNTIL = "messages_userSanctionBlockUntil",
+    USER_SANCTION_WARN = "messages_userSanctionWarn",
+    USERNAME_CHANGE = "messages_usernameChange"
+}
+export declare enum DiscussionIconSlots {
     BOOKMARK_ICON = "bookmarkIcon",
     BOOKMARK_ICON_ACTIVE = "bookmarkIconActive",
-    CUSTOM_CALL_TO_ACTION = "customCallToAction",
     DELETE_ICON = "deleteIcon",
     EDIT_ICON = "editIcon",
     LIVE_MODE_ICON = "liveModeIcon",
@@ -65,11 +83,17 @@ export declare enum DiscussionSlots {
     REPORT_ICON_ACTIVE = "reportIconActive",
     SETTINGS_ICON = "settingsIcon",
     SHARE_ICON = "shareIcon",
-    USER_ICON = "userIcon"
+    USER_ICON = "userIcon",
+    REPLIES_TOGGLE_ICON_open = "repliesToggleIcon_open",
+    REPLIES_TOGGLE_ICON_closed = "repliesToggleIcon_closed"
 }
+export declare enum DiscussionSlots {
+    CUSTOM_CALL_TO_ACTION = "customCallToAction"
+}
+export type DiscussionSlotValues = `${SharedSlots}` | `${DiscussionSlots}` | `${DiscussionIconSlots}` | `${DiscussionMessagesSlots}`;
 export interface DiscussionWidget {
     name: EgyEntities.EGY_DISCUSSION;
-    slots: Array<`${DiscussionSlots}`>;
+    slots: Array<DiscussionSlotValues>;
     attributes: Array<`${DiscussionAttributes}`>;
 }
 export declare enum DiscussionCommentaryActions {
@@ -107,13 +131,144 @@ export type PollAttributesComponent = {
     pollId: string;
     type?: string;
 };
-export declare enum PollSlots {
-    ICON = "icon"
+export declare enum PollEvents {
+    INIT = "egy-poll:init",
+    VOTE = "egy-poll:vote"
+}
+export interface PollWidgetEvents {
+    [PollEvents.INIT]: CustomEvent<{
+        entity: EgyEntities;
+    }>;
+    [PollEvents.VOTE]: CustomEvent<{
+        optionId?: string;
+        value?: number;
+        entity: EgyEntities;
+    }>;
 }
+export type PollSlotValues = `${SharedSlots}`;
 export interface PollWidget {
     name: EgyEntities.EGY_POLL;
     attributes: Array<`${PollAttributes}`>;
-    slots: Array<`${PollSlots}`>;
+    slots: Array<PollSlotValues>;
+}
+/**
+ * MAKE SURE TO UPDATE THE TYPES IN THE FOLLOWING PLACES WHEN CHANGING ATTRS:
+ * - PollBarAttributesHTMLElement
+ * - PollBarAttributesComponent
+ *
+ * also make sure to update the assignment in the PollBarPortal component, and
+ * extend the PollBar Widget!
+ */
+export declare enum PollBarAttributes {
+    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 PollBarAttributesHTMLElement {
+    ['poll-data']?: PollBarData | 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 PollBarAttributesComponent {
+    pollData?: PollBarData | 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 PollBarWidget {
+    name: EgyEntities.EGY_POLL_BAR;
+    slots: Array<PollSlotValues>;
+    attributes: Array<`${PollBarAttributes}`>;
+}
+/**
+ * MAKE SURE TO UPDATE THE TYPES IN THE FOLLOWING PLACES WHEN CHANGING ATTRS:
+ * - PollSliderAttributesHTMLElement
+ * - PollSliderAttributesComponent
+ *
+ * also make sure to update the assignment in the PollSliderPortal component,
+ * and extend the PollSlider Widget!
+ */
+export declare enum PollSliderAttributes {
+    POLL_DATA = "poll-data",
+    CURRENT_USER_PARTICIPATION = "current-user-participation",
+    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",
+    USER_NAME = "user-name",
+    USER_THUMBNAIL_URL = "user-thumbnail-url",
+    REFRESH_KEY = "refresh-key",
+    DISPLAY_STATS = "display-stats"
+}
+export interface PollSliderAttributesHTMLElement {
+    ['poll-data']?: ChartData | null;
+    ['current-user-participation']?: ExperienceParticipationFragment | null;
+    ['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;
+    ['user-name']?: string | null;
+    ['user-thumbnail-url']?: string | null;
+    ['refresh-key']?: string;
+    ['display-stats']?: boolean | string;
+}
+export interface PollSliderAttributesComponent {
+    pollData?: ChartData | null;
+    currentUserParticipation?: ExperienceParticipationFragment | null;
+    isLoading?: boolean;
+    isDisabled?: boolean;
+    voteActionEnabled?: boolean;
+    voteDisplay?: boolean;
+    voteCtaEnabled?: boolean;
+    voteCtaMessage?: string | null;
+    resultActionEnabled?: boolean;
+    userName?: string | null;
+    userThumbnailUrl?: string | null;
+    refreshKey?: string;
+    displayStats?: boolean;
+}
+export interface PollSliderWidget {
+    name: EgyEntities.EGY_POLL_SLIDER;
+    slots: Array<PollSlotValues>;
+    attributes: Array<`${PollSliderAttributes}`>;
 }
 /**
  * Events that can be used by the pub/sub implementation for window.postMessage

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

@@ -42,9 +42,25 @@ export declare enum DsmViewName {
     Share = "SHARE",
     Thread = "THREAD"
 }
-export declare enum PlmFeatureName {
-    SimpleResult = "SIMPLE_RESULT",
-    SimpleVote = "SIMPLE_VOTE"
+export declare enum ExmExperienceParticipation {
+    Anonymous = "ANONYMOUS",
+    Any = "ANY",
+    Authenticated = "AUTHENTICATED",
+    Paid = "PAID"
+}
+export declare enum ExmExperienceTypeName {
+    Poll = "POLL",
+    Quiz = "QUIZ",
+    Survey = "SURVEY"
+}
+export declare enum ExmQuestionChoiceType {
+    Bucket = "BUCKET",
+    Choice = "CHOICE",
+    Input = "INPUT"
+}
+export declare enum ExmQuestionType {
+    Bar = "BAR",
+    Slider = "SLIDER"
 }
 export declare enum PageStatus {
     Empty = "EMPTY",

package/dist/i18n/i18n.d.ts

@@ -124,10 +124,6 @@ export declare const defaultResources: {
             labels: {
                 "sort-comments": string;
             };
-            "live-controls": {
-                pause: string;
-                resume: string;
-            };
             "new-commentary": string;
             "new-commentary_other": string;
             "no-more-comments": string;
@@ -225,12 +221,6 @@ export declare const defaultResources: {
             SHARE: {
                 "call-to-action": string;
             };
-            SIMPLE_RESULT: {
-                "call-to-action": string;
-            };
-            SIMPLE_VOTE: {
-                "call-to-action": string;
-            };
         };
         interpolation: {
             comment: string;
@@ -257,15 +247,17 @@ export declare const defaultResources: {
         messages: {
             "discussion-closed": string;
             "discussion-global-closed": string;
+            "discussion-live-closed": string;
             "discussion-preamble": string;
             "log-in-to-comment": string;
-            "user-sanction-block": string;
             "user-sanction-block-until": string;
+            "user-sanction-block": string;
             "user-sanction-warn": string;
             "username-change": string;
         };
         poll: {
             "thank-you-for-vote": string;
+            "call-to-action": string;
         };
     };
     en: {
@@ -391,10 +383,6 @@ export declare const defaultResources: {
             labels: {
                 "sort-comments": string;
             };
-            "live-controls": {
-                pause: string;
-                resume: string;
-            };
             "new-commentary": string;
             "new-commentary_other": string;
             "no-more-comments": string;
@@ -491,12 +479,6 @@ export declare const defaultResources: {
             SHARE: {
                 "call-to-action": string;
             };
-            SIMPLE_RESULT: {
-                "call-to-action": string;
-            };
-            SIMPLE_VOTE: {
-                "call-to-action": string;
-            };
         };
         interpolation: {
             comment: string;
@@ -523,15 +505,17 @@ export declare const defaultResources: {
         messages: {
             "discussion-closed": string;
             "discussion-global-closed": string;
+            "discussion-live-closed": string;
             "discussion-preamble": string;
             "log-in-to-comment": string;
-            "user-sanction-block": string;
             "user-sanction-block-until": string;
+            "user-sanction-block": string;
             "user-sanction-warn": string;
             "username-change": string;
         };
         poll: {
             "thank-you-for-vote": string;
+            "call-to-action": string;
         };
     };
 };

package/dist/main/lib/engagently.d.ts

@@ -4,6 +4,8 @@ import type { Exchange } from '@urql/preact';
 type SignInOptions = Partial<{
     token: string | null;
 }>;
+export declare const reinit: (partialConfig?: Partial<EngageConfig>) => Promise<void>;
+export declare const signOut: ({ anonymousSession }?: SignOutOptions) => Promise<void>;
 export type Engagently = {
     config?: EngageConfig;
     communityConfig?: DeepPartial<CommunityConfig>;

package/dist/types/engagently.d.ts

@@ -2,10 +2,14 @@ import type { HTMLAttributes } from 'vue';
 
 import type { Engagently } from '../main/lib/engagently';
 import type {
+  PollEvents,
+  PollWidgetEvents,
   DiscussionAttributesHTMLElement,
   PollAttributesHTMLElement,
   DiscussionAttributesComponent,
   PollAttributesComponent,
+  PollBarAttributesHTMLElement,
+  PollSliderAttributesHTMLElement,
 } from '../common/_types/WidgetDefinitions';
 
 ////// exposed types package exports
@@ -13,6 +17,16 @@ import type {
 declare const webkit: Webkit;
 export { EngageConfig } from '../common/_types/ConfigDefinition';
 
+export { PollEvents, PollWidgetEvents };
+export {
+  DiscussionAttributesHTMLElement,
+  PollAttributesHTMLElement,
+  DiscussionAttributesComponent,
+  PollAttributesComponent,
+  PollBarAttributesHTMLElement,
+  PollSliderAttributesHTMLElement,
+};
+
 //////
 declare module 'vue' {
   export interface GlobalComponents {
@@ -38,9 +52,21 @@ declare global {
         React.HTMLAttributes<HTMLElement> & PollAttributesHTMLElement,
         HTMLElement
       >;
+      'egy-poll-bar': React.DetailedHTMLProps<
+        React.HTMLAttributes<HTMLElement> & PollBarAttributesHTMLElement,
+        HTMLElement
+      >;
+      'egy-poll-slider': React.DetailedHTMLProps<
+        React.HTMLAttributes<HTMLElement> & PollSliderAttributesHTMLElement,
+        HTMLElement
+      >;
     }
   }
 
+  declare global {
+    interface HTMLElementEventMap extends PollWidgetEvents {}
+  }
+
   interface Window {
     engagently?: Engagently;
     initEngagently?: () => void;

package/dist/ui/themes/config/palette.d.ts

@@ -49,10 +49,6 @@ export type ThemePalette = {
     white: string;
     mode: 'light' | 'dark';
 };
-export type PaletteConfig = {
-    dark: DeepPartial<Omit<ThemePalette, 'mode'>>;
-    light: DeepPartial<Omit<ThemePalette, 'mode'>>;
-};
 declare const generateDefaultPalette: () => Omit<ThemePalette, 'background' | 'text' | 'mode' | 'elements' | 'default'>;
 declare const generatePaletteLight: () => ThemePalette;
 declare const generatePaletteDark: () => ThemePalette;

package/package.json

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