@engagently/types 2.2.2 → 2.3.0

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

@@ -1,6 +1,6 @@
+import type { defaultResources } from '../../i18n/i18n';
+import type { AvailableThemes, ColorSchemesConfig } from '../../ui/themes/_types';
 import type { PaletteConfig } from '../../ui/themes/config';
-import type { ColorSchemesConfig, AvailableThemes } from '../../ui/themes/_types';
-import type { Resource } from 'i18next';
 import type { CombinedError, Operation } from '@urql/preact';
 import type { EgyEntities, MessageEvents } from './WidgetDefinitions';
 import type { DsmFeatureName, PlmFeatureName } from '../lib/api/enums';
@@ -18,13 +18,12 @@ export declare const EventHookMessageEventMap: Record<EventHooks, MessageEvents
  */
 export interface EngageConfig {
     communityId: string;
-    token?: string;
+    token?: string | null;
     strategy?: string;
-    anonymous?: boolean;
     palette?: PaletteConfig;
     theme?: `${AvailableThemes}`;
     defaultLanguage?: string;
-    translations?: Resource;
+    translations?: Record<string, Partial<typeof defaultResources.en>>;
     dev?: boolean;
     colorScheme?: `${ColorSchemesConfig}`;
     cta?: Partial<Record<DsmFeatureName | PlmFeatureName, CallbackFn>>;

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

@@ -33,7 +33,7 @@ export type DiscussionAttributesHTMLElement = {
     'discussion-title'?: string;
     signature?: string;
     url?: string;
-    'is-live'?: string;
+    'is-live'?: boolean;
     'image-url'?: string;
 };
 export type DiscussionAttributesComponent = {
@@ -42,7 +42,7 @@ export type DiscussionAttributesComponent = {
     discussionTitle?: string;
     signature?: string;
     url?: string;
-    isLive?: string;
+    isLive?: boolean;
     imageUrl?: string;
 };
 export declare enum DiscussionSlots {
@@ -88,12 +88,11 @@ export interface PollWidget {
 /**
  * Events that can be used by the pub/sub implementation for window.postMessage
  */
-export type MessageEvents = 'EGY_SIGN_IN' | 'EGY_SIGN_OUT' | 'EGY_SIGNED_OUT' | 'EGY_AUTHENTICATED' | 'EGY_AUTHENTICATION_FAILED' | 'EGY_TOGGLE_COLOR_SCHEME' | 'EGY_CHANGE_LANGUAGE' | 'EGY_CHANGE_VIEW_MODE' | 'EGY_LOAD_MORE_COMMENTS' | 'EGY_LOAD_MORE_REPLIES';
+export type MessageEvents = 'EGY_SIGN_IN' | 'EGY_SIGN_OUT' | 'EGY_SIGNED_OUT' | 'EGY_AUTHENTICATED' | 'EGY_AUTHENTICATION_FAILED' | 'EGY_TOGGLE_COLOR_SCHEME' | 'EGY_CHANGE_LANGUAGE' | 'EGY_CHANGE_VIEW_MODE' | 'EGY_LOAD_MORE_COMMENTS' | 'EGY_LOAD_MORE_REPLIES' | 'EGY_REINIT';
 export declare const EGY_AUTH = "egy_auth";
 export type EgyAuth = {
     accessToken: string;
     expiresAt: string;
-    anonymous: boolean;
 };
 export type ChangeLanguagePayload = {
     language: string;

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

@@ -2,6 +2,12 @@ export declare enum DsmCommentariesSort {
     CreatedAtAsc = "CREATED_AT_ASC",
     CreatedAtDesc = "CREATED_AT_DESC"
 }
+export declare enum DsmDiscussionEffectiveState {
+    Archived = "ARCHIVED",
+    Closed = "CLOSED",
+    Open = "OPEN",
+    TransientClosed = "TRANSIENT_CLOSED"
+}
 export declare enum DsmDiscussionState {
     Archived = "ARCHIVED",
     Closed = "CLOSED",

package/dist/i18n/i18n.d.ts

@@ -151,6 +151,11 @@ export declare const defaultResources: {
             "recently-used": string;
             search: string;
         };
+        errors: {
+            inline: {
+                "write-comment": string;
+            };
+        };
         features: {
             COMMENT: {
                 "call-to-action": string;
@@ -206,6 +211,7 @@ export declare const defaultResources: {
         };
         messages: {
             "discussion-closed": string;
+            "discussion-global-closed": string;
             "log-in-to-comment": string;
             "user-suspended": string;
         };
@@ -366,6 +372,11 @@ export declare const defaultResources: {
             "recently-used": string;
             search: string;
         };
+        errors: {
+            inline: {
+                "write-comment": string;
+            };
+        };
         features: {
             COMMENT: {
                 "call-to-action": string;
@@ -421,6 +432,7 @@ export declare const defaultResources: {
         };
         messages: {
             "discussion-closed": string;
+            "discussion-global-closed": string;
             "log-in-to-comment": string;
             "user-suspended": string;
         };

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

@@ -1,10 +1,13 @@
 import type { CommunityConfig, EngageConfig } from '../../common/_types/ConfigDefinition';
-export type Engagently = Partial<{
-    config: EngageConfig;
-    communityConfig: DeepPartial<CommunityConfig>;
+import type { SignOutOptions } from '../../common/lib/api/session';
+export type Engagently = {
+    config?: EngageConfig;
+    communityConfig?: DeepPartial<CommunityConfig>;
     changeLanguage: (languageCode: string) => void;
     toggleColorScheme: (mode: 'auto' | 'dark' | 'light') => void;
-}> & {
+    signOut: (options?: SignOutOptions) => Promise<null | void>;
+    reinit: (config: Partial<EngageConfig>) => Promise<void>;
+} & {
     Configuration: (config: EngageConfig) => Promise<EngageConfig>;
 };
 declare const main: void;

package/package.json

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