@engagently/types 3.0.0 → 3.1.2

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

@@ -42,6 +42,7 @@ export type CommunityConfig = {
         url: string | null;
     } | null;
     CommunityId: string | null;
+    EmbedBackend: string | null;
     ServiceId: string | null;
     Config?: {
         poll: {
@@ -49,15 +50,17 @@ export type CommunityConfig = {
         };
         discussion: {
             settings: {
+                BOOKMARK_MAX_COUNT: number;
                 COMMENTARY_MAX_LENGTH: number;
                 COMMENTARY_PREVIEW_LENGTH: number;
+                LIST_COMMENTARIES_SIZE: number;
+                LIST_MORE_COMMENTARIES_SIZE: number;
                 PREAMBLE_ENABLED: boolean;
-                THREAD_MORE_COMMENTS_SIZE: number;
-                THREAD_REPLIES_SIZE: number;
                 THREAD_COMMENTS_SIZE: number;
+                THREAD_INCLUDE_TOMBSTONES: boolean;
+                THREAD_MORE_COMMENTS_SIZE: number;
                 THREAD_MORE_REPLIES_SIZE: number;
-                LIST_COMMENTARIES_SIZE: number;
-                LIST_MORE_COMMENTARIES_SIZE: number;
+                THREAD_REPLIES_SIZE: number;
             };
         };
     } | null;

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

@@ -47,23 +47,49 @@ export type DiscussionAttributesComponent = {
     imageUrl?: string;
 };
 export declare enum DiscussionSlots {
-    USER_ICON = "userIcon",
-    SETTINGS_ICON = "settingsIcon",
-    LIVE_MODE_ICON = "liveModeIcon",
+    BOOKMARK_ICON = "bookmarkIcon",
+    BOOKMARK_ICON_ACTIVE = "bookmarkIconActive",
     CUSTOM_CALL_TO_ACTION = "customCallToAction",
-    REPLY_ICON = "replyIcon",
+    DELETE_ICON = "deleteIcon",
+    EDIT_ICON = "editIcon",
+    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"
+    REACTION3_active = "reaction3_active",
+    REPLY_ICON = "replyIcon",
+    REPORT_ICON = "reportIcon",
+    REPORT_ICON_ACTIVE = "reportIconActive",
+    SETTINGS_ICON = "settingsIcon",
+    SHARE_ICON = "shareIcon",
+    USER_ICON = "userIcon"
 }
 export interface DiscussionWidget {
     name: EgyEntities.EGY_DISCUSSION;
     slots: Array<`${DiscussionSlots}`>;
     attributes: Array<`${DiscussionAttributes}`>;
 }
+export declare enum DiscussionCommentaryActions {
+    BOOKMARK = "bookmark",
+    DELETE = "delete",
+    EDIT = "edit",
+    MODERATE = "moderate",
+    REACTION1 = "reaction1",
+    REACTION2 = "reaction2",
+    REACTION3 = "reaction3",
+    REPLY = "reply",
+    REPORT = "report",
+    SHARE = "share"
+}
+export type CommentaryActionPlacements = {
+    footer?: Array<`${DiscussionCommentaryActions}`>;
+    header?: Array<`${DiscussionCommentaryActions}`>;
+    menu?: Array<`${DiscussionCommentaryActions}`>;
+};
+export declare const DEFAULT_COMMENT_ACTIONS_PLACEMENTS: CommentaryActionPlacements;
 /**
  * MAKE SURE TO UPDATE THE TYPES IN THE FOLLOWING PLACES WHEN CHANGING ATTRS:
  * - PollAttributesHTMLElement

package/dist/i18n/i18n.d.ts

@@ -1,3 +1,4 @@
+import type { InitOptions } from 'i18next';
 import i18n from 'i18next';
 export declare const defaultResources: {
     de: {
@@ -13,22 +14,13 @@ export declare const defaultResources: {
                 settings: string;
             };
             actions: {
-                bookmarked: string;
                 cancel: string;
                 close: string;
-                "create-bookmark": string;
-                delete: string;
-                "delete-bookmark": string;
-                edit: string;
                 "open-discussion": string;
                 "go-to-discussion": string;
-                moderation: string;
                 na: string;
-                report: string;
-                reported: string;
                 save: string;
                 send: string;
-                share: string;
                 "show-all-comments": string;
                 view: string;
             };
@@ -50,7 +42,6 @@ export declare const defaultResources: {
             "load-older-replies": string;
             options: string;
             reply: string;
-            "reply-do": string;
             reply_other: string;
             "reply-count": string;
             "reply-count_other": string;
@@ -84,6 +75,30 @@ export declare const defaultResources: {
                 };
             };
             "comment-as": string;
+            "commentary-actions": {
+                bookmark: {
+                    inactive: string;
+                    active: string;
+                    deletable: string;
+                };
+                edit: string;
+                delete: string;
+                moderate: string;
+                reply: string;
+                report: {
+                    inactive: string;
+                    active: string;
+                };
+                reaction: {
+                    REACTION1: string;
+                    REACTION1_zero: string;
+                    REACTION2: string;
+                    REACTION2_zero: string;
+                    REACTION3: string;
+                    REACTION3_zero: string;
+                };
+                share: string;
+            };
             "commentary-not-available": string;
             filters: {
                 CREATED_AT_ASC: {
@@ -122,14 +137,6 @@ export declare const defaultResources: {
                 "new-commentary": string;
                 "new-reply": string;
             };
-            reactions: {
-                REACTION1: string;
-                REACTION1_zero: string;
-                REACTION2: string;
-                REACTION2_zero: string;
-                REACTION3: string;
-                REACTION3_zero: string;
-            };
             "reply-as": string;
             "reply-to": string;
             "show-less": string;
@@ -274,22 +281,13 @@ export declare const defaultResources: {
                 settings: string;
             };
             actions: {
-                bookmarked: string;
                 cancel: string;
                 close: string;
-                "create-bookmark": string;
-                delete: string;
-                "delete-bookmark": string;
-                edit: string;
                 "open-discussion": string;
                 "go-to-discussion": string;
-                moderation: string;
                 na: string;
-                report: string;
-                reported: string;
                 save: string;
                 send: string;
-                share: string;
                 "show-all-comments": string;
                 view: string;
             };
@@ -311,7 +309,6 @@ export declare const defaultResources: {
             "load-older-replies": string;
             options: string;
             reply: string;
-            "reply-do": string;
             reply_other: string;
             "reply-count": string;
             "reply-count_other": string;
@@ -345,6 +342,30 @@ export declare const defaultResources: {
                 };
             };
             "comment-as": string;
+            "commentary-actions": {
+                bookmark: {
+                    inactive: string;
+                    active: string;
+                    deletable: string;
+                };
+                edit: string;
+                delete: string;
+                moderate: string;
+                reply: string;
+                report: {
+                    inactive: string;
+                    active: string;
+                };
+                reaction: {
+                    REACTION1: string;
+                    REACTION1_zero: string;
+                    REACTION2: string;
+                    REACTION2_zero: string;
+                    REACTION3: string;
+                    REACTION3_zero: string;
+                };
+                share: string;
+            };
             "commentary-not-available": string;
             filters: {
                 CREATED_AT_ASC: {
@@ -383,14 +404,6 @@ export declare const defaultResources: {
                 "new-commentary": string;
                 "new-reply": string;
             };
-            reactions: {
-                REACTION1: string;
-                REACTION1_zero: string;
-                REACTION2: string;
-                REACTION2_zero: string;
-                REACTION3: string;
-                REACTION3_zero: string;
-            };
             "reply-as": string;
             "reply-to": string;
             "show-less": string;
@@ -522,4 +535,6 @@ export declare const defaultResources: {
         };
     };
 };
+declare const options: InitOptions;
+export { options };
 export default i18n;

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

@@ -1,5 +1,6 @@
 import type { CommunityConfig, EngageConfig, Translations } from '../../common/_types/ConfigDefinition';
 import type { SignOutOptions } from '../../common/lib/api/session';
+import type { Exchange } from '@urql/preact';
 type SignInOptions = Partial<{
     token: string | null;
 }>;
@@ -12,6 +13,10 @@ export type Engagently = {
     signIn: (options?: SignInOptions) => Promise<void>;
     reinit: (config: Partial<EngageConfig>) => Promise<void>;
     remoteTranslations?: Translations | null;
+    core: {
+        authExchange?: Exchange;
+        subscriptionExchange?: Exchange;
+    };
 } & {
     Configuration: (config: EngageConfig) => Promise<EngageConfig>;
 };

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

@@ -1,3 +1,4 @@
+import type { CommentaryActionPlacements } from '../../../common';
 import type emptyTheme from '../../themes/unstyled';
 import type { ButtonSizes, ButtonVariants, ComponentColorScheme, ThemeAnimations, ThemeBreakpoints, ThemeLevels, ThemePalette, ThemeShadows, ThemeShape, ThemeSpacing, ThemeTypography } from '../../themes/config';
 import type { ColorSchemesConfig } from '../../themes/_types';
@@ -19,6 +20,7 @@ export type ThemeSettings = {
     buttonDiscussionFocusVariant: ButtonVariants;
     buttonRepliesColor?: ComponentColorScheme;
     buttonRepliesVariant: ButtonVariants;
+    commentaryActionPlacements?: CommentaryActionPlacements;
     lineThickness: number;
     userNavType?: 'icon' | 'text' | 'icon-text';
     viewControlTabSize?: ButtonSizes;

package/index.ts

@@ -0,0 +1 @@
+export type { Engagently } from '../main/lib/engagently';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@engagently/types",
-  "version": "3.0.0",
+  "version": "3.1.2",
   "main": "./index.ts",
   "types": "dist/types/engagently.d.ts",
   "files": [
@@ -12,11 +12,11 @@
     "email": "support@ferret-go.com"
   },
   "license": "UNLICENSED",
+  "devDependencies": {
+    "vite-plugin-dts": "^3.4.0"
+  },
   "scripts": {
     "build": "vite build",
     "clean": "rimraf dist"
-  },
-  "devDependencies": {
-    "vite-plugin-dts": "^3.4.0"
   }
-}
+}