@engagently/types 2.3.0 → 2.5.0

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

@@ -12,6 +12,7 @@ export type CallbackFn = (data: {
 export type ErrorCallbackFn = (error: CombinedError, operation: Operation) => void;
 export type EventHooks = 'onAny' | 'onChangeViewMode' | 'onLoadMoreComments' | 'onLoadMoreReplies';
 export declare const EventHookMessageEventMap: Record<EventHooks, MessageEvents | MessageEvents[]>;
+export type Translations = Record<string, DeepPartial<typeof defaultResources.en>>;
 /**
  * Definition for the configuration that the client will pass when
  * initializing engagently
@@ -23,7 +24,7 @@ export interface EngageConfig {
     palette?: PaletteConfig;
     theme?: `${AvailableThemes}`;
     defaultLanguage?: string;
-    translations?: Record<string, Partial<typeof defaultResources.en>>;
+    translations?: Translations;
     dev?: boolean;
     colorScheme?: `${ColorSchemesConfig}`;
     cta?: Partial<Record<DsmFeatureName | PlmFeatureName, CallbackFn>>;
@@ -46,8 +47,17 @@ export type CommunityConfig = {
             settings: Record<string, number>;
         };
         discussion: {
-            settings: Record<CommentarySetting, number>;
+            settings: {
+                COMMENTARY_MAX_LENGTH: number;
+                COMMENTARY_PREVIEW_LENGTH: number;
+                PREAMBLE_ENABLED: boolean;
+                THREAD_MORE_COMMENTS_SIZE: number;
+                THREAD_REPLIES_SIZE: number;
+                THREAD_COMMENTS_SIZE: number;
+                THREAD_MORE_REPLIES_SIZE: number;
+                LIST_COMMENTARIES_SIZE: number;
+                LIST_MORE_COMMENTARIES_SIZE: number;
+            };
         };
     } | null;
 };
-export type CommentarySetting = 'COMMENTARY_MAX_LENGTH' | 'COMMENTARY_PREVIEW_LENGTH' | 'THREAD_MORE_COMMENTS_SIZE' | 'THREAD_REPLIES_SIZE' | 'THREAD_COMMENTS_SIZE' | 'THREAD_MORE_REPLIES_SIZE' | 'LIST_COMMENTARIES_SIZE' | 'LIST_MORE_COMMENTARIES_SIZE';

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

@@ -1,3 +1,4 @@
+import type { VNode } from 'preact';
 /**
  * Type Definitions for all available entities
  *
@@ -46,14 +47,19 @@ export type DiscussionAttributesComponent = {
     imageUrl?: string;
 };
 export declare enum DiscussionSlots {
+    PROFILE_ICON = "dialogProfileIcon",
+    COMMENTS_ICON = "dialogCommentsIcon",
+    BOOKMARK = "dialogBookmarkIcon",
+    ACCOUNT_ICON = "dialogAccountIcon",
+    SETTINGS_ICON = "dialogSettingsIcon",
+    LIVE_MODE_ICON = "liveModeIcon",
     REPLY_ICON = "replyIcon",
     REACTION1 = "reaction1",
     REACTION1_active = "reaction1_active",
     REACTION2 = "reaction2",
     REACTION2_active = "reaction2_active",
     REACTION3 = "reaction3",
-    REACTION3_active = "reaction3_active",
-    WELCOME_MESSAGE = "welcome"
+    REACTION3_active = "reaction3_active"
 }
 export interface DiscussionWidget {
     name: EgyEntities.EGY_DISCUSSION;
@@ -112,5 +118,5 @@ export type AttributesToComponentProps<T extends Array<string>> = {
  * requiring React Elements -> { foo: JSX.Element; bar: JSX.Element }
  */
 export type SlotsToComponentProps<T extends Array<string>> = {
-    [Key in T[number]]: HTMLElement;
+    [Key in T[number]]: VNode;
 };

package/dist/i18n/i18n.d.ts

@@ -40,16 +40,19 @@ export declare const defaultResources: {
             commentary_other: string;
             "copy-to-clipboard": string;
             "date-and-time": string;
+            edited: string;
             "featured-comment": string;
             live: string;
             "load-more": string;
             "load-newer-comments": string;
             "load-older-comments": string;
+            options: string;
             reply: string;
             "reply-do": string;
             reply_other: string;
             "reply-count": string;
             "reply-count_other": string;
+            share: string;
             "shared-comment": string;
             user: {
                 bio: string;
@@ -93,12 +96,10 @@ export declare const defaultResources: {
                 };
                 LIST: {
                     description: string;
-                    header: string;
                     title: string;
                 };
                 THREAD: {
                     description: string;
-                    header: string;
                     title: string;
                 };
                 sort: string;
@@ -127,6 +128,13 @@ export declare const defaultResources: {
             "reply-to": string;
             "show-less": string;
             "show-more": string;
+            "text-editor": {
+                bold: string;
+                emojis: string;
+                italic: string;
+                underline: string;
+            };
+            "view-mode": string;
             "view-modes": {
                 "all-comments": string;
                 featured: string;
@@ -202,8 +210,6 @@ export declare const defaultResources: {
             replies: string;
             reply: string;
             "reply-do": string;
-            "sub-thread": string;
-            "sub-threads": string;
             thread: string;
             threads: string;
             vote: string;
@@ -212,6 +218,7 @@ export declare const defaultResources: {
         messages: {
             "discussion-closed": string;
             "discussion-global-closed": string;
+            "discussion-preamble": string;
             "log-in-to-comment": string;
             "user-suspended": string;
         };
@@ -230,8 +237,6 @@ export declare const defaultResources: {
                 "profile-not-public": string;
                 "recent-activity": string;
                 settings: string;
-                "sign-in": string;
-                "sign-out": string;
             };
             actions: {
                 bookmarked: string;
@@ -261,16 +266,19 @@ export declare const defaultResources: {
             commentary_other: string;
             "copy-to-clipboard": string;
             "date-and-time": string;
+            edited: string;
             "featured-comment": string;
             live: string;
             "load-more": string;
             "load-newer-comments": string;
             "load-older-comments": string;
+            options: string;
             reply: string;
             "reply-do": string;
             reply_other: string;
             "reply-count": string;
             "reply-count_other": string;
+            share: string;
             "shared-comment": string;
             user: {
                 bio: string;
@@ -314,12 +322,10 @@ export declare const defaultResources: {
                 };
                 LIST: {
                     description: string;
-                    header: string;
                     title: string;
                 };
                 THREAD: {
                     description: string;
-                    header: string;
                     title: string;
                 };
                 sort: string;
@@ -348,13 +354,19 @@ export declare const defaultResources: {
             "reply-to": string;
             "show-less": string;
             "show-more": string;
+            "text-editor": {
+                bold: string;
+                emojis: string;
+                italic: string;
+                underline: string;
+            };
+            "view-mode": string;
             "view-modes": {
                 "all-comments": string;
                 featured: string;
                 focus: string;
                 list: string;
                 live: string;
-                thread: string;
             };
         };
         emojis: {
@@ -423,8 +435,6 @@ export declare const defaultResources: {
             replies: string;
             reply: string;
             "reply-do": string;
-            "sub-thread": string;
-            "sub-threads": string;
             thread: string;
             threads: string;
             vote: string;
@@ -433,6 +443,7 @@ export declare const defaultResources: {
         messages: {
             "discussion-closed": string;
             "discussion-global-closed": string;
+            "discussion-preamble": string;
             "log-in-to-comment": string;
             "user-suspended": string;
         };

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

@@ -1,4 +1,4 @@
-import type { CommunityConfig, EngageConfig } from '../../common/_types/ConfigDefinition';
+import type { CommunityConfig, EngageConfig, Translations } from '../../common/_types/ConfigDefinition';
 import type { SignOutOptions } from '../../common/lib/api/session';
 export type Engagently = {
     config?: EngageConfig;
@@ -7,6 +7,7 @@ export type Engagently = {
     toggleColorScheme: (mode: 'auto' | 'dark' | 'light') => void;
     signOut: (options?: SignOutOptions) => Promise<null | void>;
     reinit: (config: Partial<EngageConfig>) => Promise<void>;
+    remoteTranslations?: Translations | null;
 } & {
     Configuration: (config: EngageConfig) => Promise<EngageConfig>;
 };

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

@@ -1,6 +1,7 @@
 export declare enum AvailableThemes {
     default = "default",
-    unstyled = "unstyled"
+    unstyled = "unstyled",
+    thread = "thread"
 }
 export declare enum ColorSchemesConfig {
     auto = "auto",

package/package.json

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