@engagently/types 2.2.1

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

@@ -0,0 +1,54 @@
+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';
+export type CallbackFn = (data: {
+    from: EgyEntities;
+    type?: string;
+    payload?: unknown;
+}) => void;
+export type ErrorCallbackFn = (error: CombinedError, operation: Operation) => void;
+export type EventHooks = 'onAny' | 'onChangeViewMode' | 'onLoadMoreComments' | 'onLoadMoreReplies';
+export declare const EventHookMessageEventMap: Record<EventHooks, MessageEvents | MessageEvents[]>;
+/**
+ * Definition for the configuration that the client will pass when
+ * initializing engagently
+ */
+export interface EngageConfig {
+    communityId: string;
+    token?: string;
+    strategy?: string;
+    anonymous?: boolean;
+    palette?: PaletteConfig;
+    theme?: `${AvailableThemes}`;
+    defaultLanguage?: string;
+    translations?: Resource;
+    dev?: boolean;
+    colorScheme?: `${ColorSchemesConfig}`;
+    cta?: Partial<Record<DsmFeatureName | PlmFeatureName, CallbackFn>>;
+    error?: ErrorCallbackFn;
+    events?: Partial<Record<EventHooks, CallbackFn>>;
+}
+/**
+ * Definition for the configuration related to the current community
+ */
+export type CommunityConfig = {
+    Appearance: {
+        logo_url: string | null;
+        title: string | null;
+        url: string | null;
+    } | null;
+    CommunityId: string | null;
+    ServiceId: string | null;
+    Config?: {
+        poll: {
+            settings: Record<string, number>;
+        };
+        discussion: {
+            settings: Record<CommentarySetting, 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

@@ -0,0 +1,117 @@
+/**
+ * Type Definitions for all available entities
+ *
+ * Includes widget tag name, attributes and configuration options, this is used
+ * anywhere a component is defined as a single source of truth, and ensures
+ * that the loading scripts have the same types as the widgets themselves.
+ *
+ * When adding a new widget, make sure to update the types package!
+ */
+export declare enum EgyEntities {
+    EGY_TS = "engagently.ts",
+    EGY_DISCUSSION = "egy-discussion",
+    EGY_POLL = "egy-poll"
+}
+export type EgyEntitiesValues = `${EgyEntities}`;
+/**
+ * MAKE SURE TO UPDATE THE TYPES IN THE FOLLOWING PLACES WHEN CHANGING ATTRS:
+ * - DiscussionAttributesHTMLElement
+ * - DiscussionAttributesComponent
+ */
+export declare enum DiscussionAttributes {
+    DISCUSSION_ID = "discussionId",
+    SCROLL_CONTAINER_ID = "scrollContainerId",
+    DISCUSSION_TITLE = "discussionTitle",
+    SIGNATURE = "signature",
+    URL = "url",
+    IS_LIVE = "isLive",
+    IMAGE_URL = "imageUrl"
+}
+export type DiscussionAttributesHTMLElement = {
+    'discussion-id': string;
+    'scroll-container-id'?: string;
+    'discussion-title'?: string;
+    signature?: string;
+    url?: string;
+    'is-live'?: string;
+    'image-url'?: string;
+};
+export type DiscussionAttributesComponent = {
+    discussionId: string;
+    scrollContainerId?: string;
+    discussionTitle?: string;
+    signature?: string;
+    url?: string;
+    isLive?: string;
+    imageUrl?: string;
+};
+export declare enum DiscussionSlots {
+    REPLY_ICON = "replyIcon",
+    REACTION1 = "reaction1",
+    REACTION1_active = "reaction1_active",
+    REACTION2 = "reaction2",
+    REACTION2_active = "reaction2_active",
+    REACTION3 = "reaction3",
+    REACTION3_active = "reaction3_active",
+    WELCOME_MESSAGE = "welcome"
+}
+export interface DiscussionWidget {
+    name: EgyEntities.EGY_DISCUSSION;
+    slots: Array<`${DiscussionSlots}`>;
+    attributes: Array<`${DiscussionAttributes}`>;
+}
+/**
+ * MAKE SURE TO UPDATE THE TYPES IN THE FOLLOWING PLACES WHEN CHANGING ATTRS:
+ * - PollAttributesHTMLElement
+ * - PollAttributesComponent
+ */
+export declare enum PollAttributes {
+    POLL_ID = "pollId",
+    TYPE = "type"
+}
+export type PollAttributesHTMLElement = {
+    'poll-id': string;
+    type?: string;
+};
+export type PollAttributesComponent = {
+    pollId: string;
+    type?: string;
+};
+export declare enum PollSlots {
+    ICON = "icon"
+}
+export interface PollWidget {
+    name: EgyEntities.EGY_POLL;
+    attributes: Array<`${PollAttributes}`>;
+    slots: Array<`${PollSlots}`>;
+}
+/**
+ * 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 declare const EGY_AUTH = "egy_auth";
+export type EgyAuth = {
+    accessToken: string;
+    expiresAt: string;
+    anonymous: boolean;
+};
+export type ChangeLanguagePayload = {
+    language: string;
+};
+export type ToggleColorSchemePayload = {
+    mode: string;
+};
+/**
+ * Will convert an array type -> ["foo", "bar"] as keys for an object type
+ * requiring strings -> { foo: string; bar: string }
+ */
+export type AttributesToComponentProps<T extends Array<string>> = {
+    [Key in T[number]]: string;
+};
+/**
+ * Will convert an array type -> ["foo", "bar"] as keys for an object type
+ * requiring React Elements -> { foo: JSX.Element; bar: JSX.Element }
+ */
+export type SlotsToComponentProps<T extends Array<string>> = {
+    [Key in T[number]]: HTMLElement;
+};

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

@@ -0,0 +1,56 @@
+export declare enum DsmCommentariesSort {
+    CreatedAtAsc = "CREATED_AT_ASC",
+    CreatedAtDesc = "CREATED_AT_DESC"
+}
+export declare enum DsmDiscussionState {
+    Archived = "ARCHIVED",
+    Closed = "CLOSED",
+    Open = "OPEN"
+}
+export declare enum DsmFeatureName {
+    Comment = "COMMENT",
+    CommentaryRead = "COMMENTARY_READ",
+    Profile = "PROFILE",
+    Reaction = "REACTION",
+    Reply = "REPLY",
+    Report = "REPORT",
+    Share = "SHARE"
+}
+export declare enum DsmReactionName {
+    Reaction1 = "REACTION1",
+    Reaction2 = "REACTION2",
+    Reaction3 = "REACTION3"
+}
+export declare enum DsmViewName {
+    Featured = "FEATURED",
+    List = "LIST",
+    Live = "LIVE",
+    Share = "SHARE",
+    Thread = "THREAD"
+}
+export declare enum PlmFeatureName {
+    SimpleResult = "SIMPLE_RESULT",
+    SimpleVote = "SIMPLE_VOTE"
+}
+export declare enum PageStatus {
+    Empty = "EMPTY",
+    Full = "FULL",
+    Partial = "PARTIAL"
+}
+export declare enum UserFlag {
+    Anonymous = "ANONYMOUS",
+    Any = "ANY",
+    Authenticated = "AUTHENTICATED",
+    Eligible = "ELIGIBLE",
+    Paid = "PAID",
+    Sanctioned = "SANCTIONED"
+}
+export declare enum UserPenalty {
+    Block = "BLOCK",
+    Mute = "MUTE",
+    Suspend = "SUSPEND"
+}
+export declare enum UserRole {
+    Moderator = "MODERATOR",
+    Staff = "STAFF"
+}

package/dist/engagently.mjs

@@ -0,0 +1 @@
+

package/dist/engagently.umd.js

@@ -0,0 +1 @@
+(function(n){typeof define=="function"&&define.amd?define(n):n()})(function(){"use strict"});

package/dist/i18n/i18n.d.ts

@@ -0,0 +1,432 @@
+import i18n from 'i18next';
+export declare const defaultResources: {
+    de: {
+        common: {
+            account: {
+                account: string;
+                bookmarks: string;
+                "last-active": string;
+                "member-since": string;
+                profile: string;
+                "profile-not-public": string;
+                "recent-activity": string;
+                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;
+            };
+            and: string;
+            comment: string;
+            "comment-in-thread": string;
+            comment_other: string;
+            commentary: string;
+            commentary_other: string;
+            "copy-to-clipboard": string;
+            "date-and-time": string;
+            "featured-comment": string;
+            live: string;
+            "load-more": string;
+            "load-newer-comments": string;
+            "load-older-comments": string;
+            reply: string;
+            "reply-do": string;
+            reply_other: string;
+            "reply-count": string;
+            "reply-count_other": string;
+            "shared-comment": string;
+            user: {
+                bio: string;
+                name: string;
+                "private-profile": string;
+            };
+            vote: string;
+            vote_other: string;
+        };
+        discussions: {
+            alerts: {
+                "featured-comments-only": {
+                    message: string;
+                    title_one: string;
+                    title_other: string;
+                };
+                limit: {
+                    message: string;
+                };
+                "no-bookmarks": {
+                    message: string;
+                    title: string;
+                };
+                "no-comments": {
+                    message: string;
+                    title: string;
+                };
+            };
+            "comment-as": string;
+            "commentary-not-available": string;
+            filters: {
+                CREATED_AT_ASC: {
+                    description: string;
+                    header: string;
+                    title: string;
+                };
+                CREATED_AT_DESC: {
+                    description: string;
+                    header: string;
+                    title: string;
+                };
+                LIST: {
+                    description: string;
+                    header: string;
+                    title: string;
+                };
+                THREAD: {
+                    description: string;
+                    header: string;
+                    title: string;
+                };
+                sort: string;
+            };
+            labels: {
+                "sort-comments": string;
+            };
+            "live-controls": {
+                pause: string;
+                resume: string;
+            };
+            "new-commentary": string;
+            "new-commentary_other": string;
+            "no-more-comments": string;
+            "no-recent-comments": string;
+            placeholders: {
+                "new-commentary": string;
+                "new-reply": string;
+            };
+            reactions: {
+                REACTION1: string;
+                REACTION2: string;
+                REACTION3: string;
+            };
+            "reply-as": string;
+            "reply-to": string;
+            "show-less": string;
+            "show-more": string;
+            "view-modes": {
+                "all-comments": string;
+                featured: string;
+                focus: string;
+                list: string;
+                live: string;
+                thread: string;
+            };
+        };
+        emojis: {
+            categories: {
+                people: string;
+                nature: string;
+                foods: string;
+                activity: string;
+                places: string;
+                objects: string;
+                symbols: string;
+                flags: string;
+            };
+            choose: string;
+            "recently-used": string;
+            search: string;
+        };
+        features: {
+            COMMENT: {
+                "call-to-action": string;
+            };
+            COMMENTARY_READ: {
+                "call-to-action": string;
+            };
+            PROFILE: {
+                "call-to-action": string;
+            };
+            REACTION: {
+                "call-to-action": string;
+            };
+            REPLY: {
+                "call-to-action": string;
+            };
+            REPORT: {
+                "call-to-action": string;
+            };
+            SHARE: {
+                "call-to-action": string;
+            };
+            SIMPLE_RESULT: {
+                "call-to-action": string;
+            };
+            SIMPLE_VOTE: {
+                "call-to-action": string;
+            };
+        };
+        interpolation: {
+            comment: string;
+            "comment-do": string;
+            comments: string;
+            conversation: string;
+            conversations: string;
+            discussion: string;
+            discussions: string;
+            list: string;
+            lists: string;
+            message: string;
+            messages: string;
+            poll: string;
+            polls: string;
+            replies: string;
+            reply: string;
+            "reply-do": string;
+            "sub-thread": string;
+            "sub-threads": string;
+            thread: string;
+            threads: string;
+            vote: string;
+            votes: string;
+        };
+        messages: {
+            "discussion-closed": string;
+            "log-in-to-comment": string;
+            "user-suspended": string;
+        };
+        poll: {
+            "thank-you-for-vote": string;
+        };
+    };
+    en: {
+        common: {
+            account: {
+                account: string;
+                bookmarks: string;
+                "last-active": string;
+                "member-since": string;
+                profile: string;
+                "profile-not-public": string;
+                "recent-activity": string;
+                settings: string;
+                "sign-in": string;
+                "sign-out": 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;
+            };
+            and: string;
+            comment: string;
+            "comment-in-thread": string;
+            comment_other: string;
+            commentary: string;
+            commentary_other: string;
+            "copy-to-clipboard": string;
+            "date-and-time": string;
+            "featured-comment": string;
+            live: string;
+            "load-more": string;
+            "load-newer-comments": string;
+            "load-older-comments": string;
+            reply: string;
+            "reply-do": string;
+            reply_other: string;
+            "reply-count": string;
+            "reply-count_other": string;
+            "shared-comment": string;
+            user: {
+                bio: string;
+                name: string;
+                "private-profile": string;
+            };
+            vote: string;
+            vote_other: string;
+        };
+        discussions: {
+            alerts: {
+                "featured-comments-only": {
+                    message: string;
+                    title_one: string;
+                    title_other: string;
+                };
+                limit: {
+                    message: string;
+                };
+                "no-bookmarks": {
+                    message: string;
+                    title: string;
+                };
+                "no-comments": {
+                    message: string;
+                    title: string;
+                };
+            };
+            "comment-as": string;
+            "commentary-not-available": string;
+            filters: {
+                CREATED_AT_ASC: {
+                    description: string;
+                    header: string;
+                    title: string;
+                };
+                CREATED_AT_DESC: {
+                    description: string;
+                    header: string;
+                    title: string;
+                };
+                LIST: {
+                    description: string;
+                    header: string;
+                    title: string;
+                };
+                THREAD: {
+                    description: string;
+                    header: string;
+                    title: string;
+                };
+                sort: string;
+            };
+            labels: {
+                "sort-comments": string;
+            };
+            "live-controls": {
+                pause: string;
+                resume: string;
+            };
+            "new-commentary": string;
+            "new-commentary_other": string;
+            "no-more-comments": string;
+            "no-recent-comments": string;
+            placeholders: {
+                "new-commentary": string;
+                "new-reply": string;
+            };
+            reactions: {
+                REACTION1: string;
+                REACTION2: string;
+                REACTION3: string;
+            };
+            "reply-as": string;
+            "reply-to": string;
+            "show-less": string;
+            "show-more": string;
+            "view-modes": {
+                "all-comments": string;
+                featured: string;
+                focus: string;
+                list: string;
+                live: string;
+                thread: string;
+            };
+        };
+        emojis: {
+            categories: {
+                people: string;
+                nature: string;
+                foods: string;
+                activity: string;
+                places: string;
+                objects: string;
+                symbols: string;
+                flags: string;
+            };
+            choose: string;
+            "recently-used": string;
+            search: string;
+        };
+        features: {
+            COMMENT: {
+                "call-to-action": string;
+            };
+            COMMENTARY_READ: {
+                "call-to-action": string;
+            };
+            PROFILE: {
+                "call-to-action": string;
+            };
+            REACTION: {
+                "call-to-action": string;
+            };
+            REPLY: {
+                "call-to-action": string;
+            };
+            REPORT: {
+                "call-to-action": string;
+            };
+            SHARE: {
+                "call-to-action": string;
+            };
+            SIMPLE_RESULT: {
+                "call-to-action": string;
+            };
+            SIMPLE_VOTE: {
+                "call-to-action": string;
+            };
+        };
+        interpolation: {
+            comment: string;
+            "comment-do": string;
+            comments: string;
+            conversation: string;
+            conversations: string;
+            discussion: string;
+            discussions: string;
+            list: string;
+            lists: string;
+            message: string;
+            messages: string;
+            poll: string;
+            polls: string;
+            replies: string;
+            reply: string;
+            "reply-do": string;
+            "sub-thread": string;
+            "sub-threads": string;
+            thread: string;
+            threads: string;
+            vote: string;
+            votes: string;
+        };
+        messages: {
+            "discussion-closed": string;
+            "log-in-to-comment": string;
+            "user-suspended": string;
+        };
+        poll: {
+            "thank-you-for-vote": string;
+        };
+    };
+};
+export default i18n;

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

@@ -0,0 +1,11 @@
+import type { CommunityConfig, EngageConfig } from '../../common/_types/ConfigDefinition';
+export type Engagently = Partial<{
+    config: EngageConfig;
+    communityConfig: DeepPartial<CommunityConfig>;
+    changeLanguage: (languageCode: string) => void;
+    toggleColorScheme: (mode: 'auto' | 'dark' | 'light') => void;
+}> & {
+    Configuration: (config: EngageConfig) => Promise<EngageConfig>;
+};
+declare const main: void;
+export default main;

package/dist/types/engagently.d.ts

@@ -0,0 +1,72 @@
+import type { HTMLAttributes } from 'vue';
+
+import type { Engagently } from '../main/lib/engagently';
+import type {
+  DiscussionAttributesHTMLElement,
+  PollAttributesHTMLElement,
+  DiscussionAttributesComponent,
+  PollAttributesComponent,
+} from '../common/_types/WidgetDefinitions';
+
+declare const webkit: Webkit;
+
+declare module 'vue' {
+  export interface GlobalComponents {
+    EgyDiscussion: HTMLAttributes & DiscussionAttributesComponent;
+    EgyPoll: HTMLAttributes & PollAttributesComponent;
+  }
+}
+
+declare global {
+  type DeepPartial<T> = T extends object
+    ? {
+        [P in keyof T]?: DeepPartial<T[P]>;
+      }
+    : T;
+
+  namespace JSX {
+    interface IntrinsicElements {
+      'egy-discussion': React.DetailedHTMLProps<
+        React.HTMLAttributes<HTMLElement> & DiscussionAttributesHTMLElement,
+        HTMLElement
+      >;
+      'egy-poll': React.DetailedHTMLProps<
+        React.HTMLAttributes<HTMLElement> & PollAttributesHTMLElement,
+        HTMLElement
+      >;
+    }
+  }
+
+  interface Window {
+    engagently?: Engagently;
+    initEngagently?: () => void;
+    webkit: Webkit;
+    /**
+     * A convenience API that we seem to expose in iOS.
+     * Not sure whether Android does the same.
+     * @see: https://github.com/react-native-community/react-native-webview/blob/25552977852427cf5fdc7b233fd1bbc7c77c18b0/ios/RNCWebView.m#L1128-L1146
+     */
+    ReactNativeWebView: {
+      postMessage(msg: string): void;
+    };
+  }
+
+  interface Webkit {
+    messageHandlers: {
+      /**
+       * Added due to our call to addScriptMessageHandler.
+       * @see: https://github.com/react-native-community/react-native-webview/blob/25552977852427cf5fdc7b233fd1bbc7c77c18b0/ios/RNCWebView.m#L1244
+       */
+      ReactNativeWebView: {
+        postMessage(message: string): void;
+      };
+      /**
+       * Added due to our call to addScriptMessageHandler.
+       * @see: https://github.com/react-native-community/react-native-webview/blob/25552977852427cf5fdc7b233fd1bbc7c77c18b0/ios/RNCWebView.m#L214
+       */
+      ReactNativeHistoryShim: {
+        postMessage(message: string): void;
+      };
+    };
+  }
+}

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

@@ -0,0 +1,9 @@
+export declare enum AvailableThemes {
+    default = "default",
+    unstyled = "unstyled"
+}
+export declare enum ColorSchemesConfig {
+    auto = "auto",
+    light = "light",
+    dark = "dark"
+}

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

@@ -0,0 +1,60 @@
+export type ThemePalette = {
+    primary: {
+        color: string;
+        contrast: string;
+    };
+    secondary: {
+        color: string;
+        contrast: string;
+    };
+    background: string;
+    error: {
+        color: string;
+        contrast: string;
+    };
+    info: {
+        color: string;
+        contrast: string;
+    };
+    warning: {
+        color: string;
+        contrast: string;
+    };
+    success: {
+        color: string;
+        contrast: string;
+    };
+    default: {
+        color: string;
+        contrast: string;
+    };
+    elements: {
+        line: string;
+        paper: string;
+        textEditor: {
+            background: string;
+            color: string;
+            placeholder: string;
+        };
+        button: {
+            disabled: string;
+        };
+    };
+    text: {
+        primary: string;
+        secondary: string;
+        hint: string;
+    };
+    black: string;
+    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;
+declare const mergePalette: (p1: ThemePalette, p2?: DeepPartial<ThemePalette>) => ThemePalette;
+export { generateDefaultPalette, generatePaletteDark, generatePaletteLight, mergePalette, };

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@engagently/types",
+  "version": "2.2.1",
+  "main": "./index.ts",
+  "types": "dist/types/engagently.d.ts",
+  "files": [
+    "dist"
+  ],
+  "keywords": [],
+  "author": {
+    "name": "ferret go GmbH",
+    "email": "support@ferret-go.com"
+  },
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "vite build",
+    "clean": "rimraf dist"
+  },
+  "devDependencies": {
+    "vite": "^3.0.0",
+    "vite-plugin-dts": "^3.4.0"
+  }
+}

package/readme.md

@@ -0,0 +1,40 @@
+# @engagently/types
+
+Type definitions for integrating Engagently into your typescript project.
+
+## Installation
+
+1. Install the package via npm or yarn:
+
+   ```sh
+   npm install @engagently/types --save-dev
+   ```
+
+   Or if you are using yarn:
+
+   ```sh
+   yarn add @engagently/types --dev
+   ```
+
+## Important Notes
+
+- Always make sure to use the latest version of `@engagently/types`. Regular updates are made to ensure the types are in sync with the latest features and changes. To ensure you're using the latest, always check the version in your `package.json` and compare it with the latest version on the npm registry.
+
+- After installing or updating, you need to include `@engagently/types` in the `types` array of your `tsconfig.json` to ensure TypeScript recognizes and uses the types from this package.
+
+## Configuration
+
+In your `tsconfig.json`, add `@engagently/types` to the types array:
+
+```json
+{
+  "compilerOptions": {
+    // ... other options
+    "types": ["@engagently/types", ...otherTypes]
+  }
+}
+```
+
+## Support
+
+For any issues or questions related to `@engagently/types`, please contact our support or refer to the official documentation.