@deepdesk/deepdesk-sdk 11.6.1-beta.2 → 11.6.1-beta.4

package/dist/index.d.mts

@@ -214,7 +214,7 @@ type SelectionRange = {
 /**
  * A selection range representation for textarea's and contenteditables only using offsets.
  */
-type Caret = {
+type CaretPosition = {
     top: number;
     left: number;
 };
@@ -224,19 +224,18 @@ interface InputEventMap {
      */
     change: (event: {
         plainText: string;
+        rawHTML: string | null;
     }) => void;
     /**
-     * Updated value after User, platform and plugin changes
+     * Emits selection changes.
      */
-    updated: (event: {
-        plainText: string;
-    }) => void;
+    selection: (event: SelectionRange | null) => void;
     /**
-     * Emits when only the caret/selection changes. (No other state changes).
+     * Emits when the position of the caret on the screen changed
      */
-    selection: (event: SelectionRange | null) => void;
-    caret: (event: Caret | null) => void;
+    caretposition: (event: CaretPosition | null) => void;
     keydown: (event: KeyboardEvent) => void;
+    keyup: (event: KeyboardEvent) => void;
     paste: (event: {
         pastedText: string;
         selectionText: string;
@@ -255,40 +254,34 @@ type InputHandler<K extends keyof InputEventMap> = InputEventMap[K];
 type InputEventListeners<K extends keyof InputEventMap> = Record<K, InputHandler<K>[]>;
 declare abstract class InputMediator<HTMLElementType extends HTMLElement> {
     protected element: HTMLElementType;
+    isFocused: boolean;
+    isActive: boolean;
+    isDisposed: boolean;
     protected eventListeners: Partial<InputEventListeners<keyof InputEventMap>>;
     protected disposeHandlers: (() => void)[];
-    protected currentText: string;
-    protected currentCaret: Caret | null;
-    protected currentSelection: SelectionRange;
-    protected currentHTML: string | null;
-    protected isFocused: boolean;
-    protected isActive: boolean;
-    protected isSettingValue: boolean;
+    protected cachedText: string;
+    protected cachedCaretPosition: CaretPosition | null;
+    protected cachedSelection: SelectionRange;
+    protected cachedHTML: string | null;
     protected isSubmitting: boolean;
     protected isPossibleClearInputAction: boolean;
-    protected isDisposed: boolean;
     constructor(element: HTMLElementType);
     protected addEventListener(eventName: string, listener: EventListenerOrEventListenerObject): void;
     protected removeEventListener(eventName: string, listener: EventListenerOrEventListenerObject): void;
-    protected triggerChange(): void;
-    protected triggerSelection(): void;
-    protected triggerCaretPosition(): void;
+    protected handleInteraction(): void;
     abstract getSelectedText(): string;
-    protected handleKeyUp(event: KeyboardEvent): void;
     protected handleClick(): void;
     protected handleFocus(): void;
     protected handleBlur(): void;
     protected handleKeyDown(event: KeyboardEvent): void;
+    protected handleKeyUp(event: KeyboardEvent): void;
     protected handleCut(): void;
     protected handlePaste(event: ClipboardEvent): void;
-    protected listen(options?: {
-        shouldObserve?: boolean;
-    }): void;
+    protected listen(): void;
     abstract getText(): string;
     abstract getHTML(): string | null;
     abstract getSelection(): SelectionRange;
-    abstract getCaretPosition(): Caret | null;
-    abstract applyChanges(callback: (element: HTMLElementType) => void | Promise<void>): void | Promise<void>;
+    abstract getCaretPosition(): CaretPosition | null;
     focus(): void;
     emit<K extends keyof InputEventMap>(type: K, ...args: Parameters<InputHandler<K>>): void;
     on<K extends keyof InputEventMap>(type: K, handler: InputHandler<K>): void;
@@ -1049,6 +1042,7 @@ declare namespace Server {
         nickname?: string;
         first_name?: string;
         last_name?: string;
+        default_locale?: string;
     };
     /**
      * Profile
@@ -1467,6 +1461,7 @@ type AgentInfo = {
     agentName?: string;
     agentEmail?: string;
     agentTimeZone?: string;
+    agentDefaultLocale?: string;
 };
 type KnowledgeAssistant = CamelCaseKeys<Server.KnowledgeAssistant>;
 type User = CamelCaseKeys<Server.User>;
@@ -1524,7 +1519,6 @@ declare enum FetchState {
     ERROR = "error"
 }
 
-type KeyboardMetric = Pick<KeyboardEvent, 'key' | 'shiftKey' | 'ctrlKey' | 'altKey' | 'metaKey'>;
 type StageSuggestion = {
     text: string;
     suggestion: TextSuggestion;
@@ -1554,14 +1548,12 @@ type State$6 = {
     text: string;
     html: string | null;
     selection: SelectionRange;
-    stagedSuggestion: StageSuggestion | null;
-    userCommitted: {
+    beforeKeyUp: {
         text: string;
         selection: SelectionRange;
-    };
-    tabCompletionSuggestion?: TextSuggestion;
+    } | null;
+    mixedSuggestion: TextSuggestion | null;
     metrics: MetricState;
-    previousKeyDownEvent: KeyboardMetric | null;
     textSuggestions: TextSuggestion[];
     selectedSuggestionIndex: number;
 };
@@ -2222,19 +2214,8 @@ declare class DeepdeskSDK {
      * Only refresh text suggestions when the agent is not typing.
      */
     refresh(): Promise<void>;
-    /**
-     * Method to call when the agent input has changed
-     */
-    private notifyInputChanged;
-    /**
-     * Method to call for the agent input keydown event
-     */
-    private notifyKeyDown;
-    private notifyPaste;
-    private notifyCut;
     notifyExternalSuggestion(suggestion: StageSuggestion): void;
     evaluateRule(label: string, params?: Record<string, any>, options?: EvaluateRuleOptions): Promise<Cue[]>;
-    private handleInputChanged;
     private handleKeyDown;
     private handleAfterSendMessage;
     handlingTimeStart(): void;
@@ -2248,10 +2229,7 @@ declare class DeepdeskSDK {
     notifySubmit(options?: {
         text?: string;
     }): void;
-    stageSelectedSuggestion(eventMetrics: SuggestionEventMetrics): void;
-    emit<K extends keyof SDKEventMap>(type: K, eventPayload: SDKEventMap[K], options?: {
-        mayApplyChanges?: boolean;
-    }): void;
+    emit<K extends keyof SDKEventMap>(type: K, eventPayload: SDKEventMap[K]): void;
     /**
      * Attach listener to SDK event
      * Returns removeListener
@@ -2317,11 +2295,7 @@ declare class ContentEditableInput extends InputMediator<HTMLDivElement> {
     } | null;
     getSelection(): SelectionRange;
     getSelectedText(): string;
-    applyChanges(callback: (element: HTMLDivElement) => void | Promise<void>): void | Promise<void>;
-    listen(options?: {
-        shouldObserve?: boolean;
-    }): void;
-    dispose(): void;
+    listen(): void;
 }
 
 declare class TextAreaInput extends InputMediator<HTMLTextAreaElement> {
@@ -2330,8 +2304,7 @@ declare class TextAreaInput extends InputMediator<HTMLTextAreaElement> {
     getHTML(): string | null;
     getSelection(): SelectionRange;
     getSelectedText(): string;
-    getCaretPosition(): Caret | null;
-    applyChanges(callback: (element: HTMLTextAreaElement) => void | Promise<void>): void | Promise<void>;
+    getCaretPosition(): CaretPosition | null;
     listen(): void;
 }
 

package/dist/index.d.ts

@@ -214,7 +214,7 @@ type SelectionRange = {
 /**
  * A selection range representation for textarea's and contenteditables only using offsets.
  */
-type Caret = {
+type CaretPosition = {
     top: number;
     left: number;
 };
@@ -224,19 +224,18 @@ interface InputEventMap {
      */
     change: (event: {
         plainText: string;
+        rawHTML: string | null;
     }) => void;
     /**
-     * Updated value after User, platform and plugin changes
+     * Emits selection changes.
      */
-    updated: (event: {
-        plainText: string;
-    }) => void;
+    selection: (event: SelectionRange | null) => void;
     /**
-     * Emits when only the caret/selection changes. (No other state changes).
+     * Emits when the position of the caret on the screen changed
      */
-    selection: (event: SelectionRange | null) => void;
-    caret: (event: Caret | null) => void;
+    caretposition: (event: CaretPosition | null) => void;
     keydown: (event: KeyboardEvent) => void;
+    keyup: (event: KeyboardEvent) => void;
     paste: (event: {
         pastedText: string;
         selectionText: string;
@@ -255,40 +254,34 @@ type InputHandler<K extends keyof InputEventMap> = InputEventMap[K];
 type InputEventListeners<K extends keyof InputEventMap> = Record<K, InputHandler<K>[]>;
 declare abstract class InputMediator<HTMLElementType extends HTMLElement> {
     protected element: HTMLElementType;
+    isFocused: boolean;
+    isActive: boolean;
+    isDisposed: boolean;
     protected eventListeners: Partial<InputEventListeners<keyof InputEventMap>>;
     protected disposeHandlers: (() => void)[];
-    protected currentText: string;
-    protected currentCaret: Caret | null;
-    protected currentSelection: SelectionRange;
-    protected currentHTML: string | null;
-    protected isFocused: boolean;
-    protected isActive: boolean;
-    protected isSettingValue: boolean;
+    protected cachedText: string;
+    protected cachedCaretPosition: CaretPosition | null;
+    protected cachedSelection: SelectionRange;
+    protected cachedHTML: string | null;
     protected isSubmitting: boolean;
     protected isPossibleClearInputAction: boolean;
-    protected isDisposed: boolean;
     constructor(element: HTMLElementType);
     protected addEventListener(eventName: string, listener: EventListenerOrEventListenerObject): void;
     protected removeEventListener(eventName: string, listener: EventListenerOrEventListenerObject): void;
-    protected triggerChange(): void;
-    protected triggerSelection(): void;
-    protected triggerCaretPosition(): void;
+    protected handleInteraction(): void;
     abstract getSelectedText(): string;
-    protected handleKeyUp(event: KeyboardEvent): void;
     protected handleClick(): void;
     protected handleFocus(): void;
     protected handleBlur(): void;
     protected handleKeyDown(event: KeyboardEvent): void;
+    protected handleKeyUp(event: KeyboardEvent): void;
     protected handleCut(): void;
     protected handlePaste(event: ClipboardEvent): void;
-    protected listen(options?: {
-        shouldObserve?: boolean;
-    }): void;
+    protected listen(): void;
     abstract getText(): string;
     abstract getHTML(): string | null;
     abstract getSelection(): SelectionRange;
-    abstract getCaretPosition(): Caret | null;
-    abstract applyChanges(callback: (element: HTMLElementType) => void | Promise<void>): void | Promise<void>;
+    abstract getCaretPosition(): CaretPosition | null;
     focus(): void;
     emit<K extends keyof InputEventMap>(type: K, ...args: Parameters<InputHandler<K>>): void;
     on<K extends keyof InputEventMap>(type: K, handler: InputHandler<K>): void;
@@ -1049,6 +1042,7 @@ declare namespace Server {
         nickname?: string;
         first_name?: string;
         last_name?: string;
+        default_locale?: string;
     };
     /**
      * Profile
@@ -1467,6 +1461,7 @@ type AgentInfo = {
     agentName?: string;
     agentEmail?: string;
     agentTimeZone?: string;
+    agentDefaultLocale?: string;
 };
 type KnowledgeAssistant = CamelCaseKeys<Server.KnowledgeAssistant>;
 type User = CamelCaseKeys<Server.User>;
@@ -1524,7 +1519,6 @@ declare enum FetchState {
     ERROR = "error"
 }
 
-type KeyboardMetric = Pick<KeyboardEvent, 'key' | 'shiftKey' | 'ctrlKey' | 'altKey' | 'metaKey'>;
 type StageSuggestion = {
     text: string;
     suggestion: TextSuggestion;
@@ -1554,14 +1548,12 @@ type State$6 = {
     text: string;
     html: string | null;
     selection: SelectionRange;
-    stagedSuggestion: StageSuggestion | null;
-    userCommitted: {
+    beforeKeyUp: {
         text: string;
         selection: SelectionRange;
-    };
-    tabCompletionSuggestion?: TextSuggestion;
+    } | null;
+    mixedSuggestion: TextSuggestion | null;
     metrics: MetricState;
-    previousKeyDownEvent: KeyboardMetric | null;
     textSuggestions: TextSuggestion[];
     selectedSuggestionIndex: number;
 };
@@ -2222,19 +2214,8 @@ declare class DeepdeskSDK {
      * Only refresh text suggestions when the agent is not typing.
      */
     refresh(): Promise<void>;
-    /**
-     * Method to call when the agent input has changed
-     */
-    private notifyInputChanged;
-    /**
-     * Method to call for the agent input keydown event
-     */
-    private notifyKeyDown;
-    private notifyPaste;
-    private notifyCut;
     notifyExternalSuggestion(suggestion: StageSuggestion): void;
     evaluateRule(label: string, params?: Record<string, any>, options?: EvaluateRuleOptions): Promise<Cue[]>;
-    private handleInputChanged;
     private handleKeyDown;
     private handleAfterSendMessage;
     handlingTimeStart(): void;
@@ -2248,10 +2229,7 @@ declare class DeepdeskSDK {
     notifySubmit(options?: {
         text?: string;
     }): void;
-    stageSelectedSuggestion(eventMetrics: SuggestionEventMetrics): void;
-    emit<K extends keyof SDKEventMap>(type: K, eventPayload: SDKEventMap[K], options?: {
-        mayApplyChanges?: boolean;
-    }): void;
+    emit<K extends keyof SDKEventMap>(type: K, eventPayload: SDKEventMap[K]): void;
     /**
      * Attach listener to SDK event
      * Returns removeListener
@@ -2317,11 +2295,7 @@ declare class ContentEditableInput extends InputMediator<HTMLDivElement> {
     } | null;
     getSelection(): SelectionRange;
     getSelectedText(): string;
-    applyChanges(callback: (element: HTMLDivElement) => void | Promise<void>): void | Promise<void>;
-    listen(options?: {
-        shouldObserve?: boolean;
-    }): void;
-    dispose(): void;
+    listen(): void;
 }
 
 declare class TextAreaInput extends InputMediator<HTMLTextAreaElement> {
@@ -2330,8 +2304,7 @@ declare class TextAreaInput extends InputMediator<HTMLTextAreaElement> {
     getHTML(): string | null;
     getSelection(): SelectionRange;
     getSelectedText(): string;
-    getCaretPosition(): Caret | null;
-    applyChanges(callback: (element: HTMLTextAreaElement) => void | Promise<void>): void | Promise<void>;
+    getCaretPosition(): CaretPosition | null;
     listen(): void;
 }