@acrolinx/sidebar-sdk 2.0.2 → 2.1.0

package/dist/index.d.ts

@@ -11,6 +11,7 @@ import { DocumentSelection } from '@acrolinx/sidebar-interface';
 import { Editor } from 'tinymce';
 import { EditorFromTextArea } from 'codemirror';
 import { EditorView } from '@codemirror/view';
+import { EditorView as EditorView_2 } from 'prosemirror-view';
 import { ExternalContent } from '@acrolinx/sidebar-interface';
 import { InitParameters } from '@acrolinx/sidebar-interface';
 import { InitResult } from '@acrolinx/sidebar-interface';
@@ -105,7 +106,9 @@ export declare interface AcrolinxSidebarIntegration {
         CKEditorAdapter: typeof CKEditorAdapter;
         CodeMirror6Adapter: typeof CodeMirror6Adapter;
         CodeMirrorAdapter: typeof CodeMirrorAdapter;
+        ProseMirrorAdapter: typeof ProseMirrorAdapter;
         ContentEditableAdapter: typeof ContentEditableAdapter;
+        HerettoContentEditableAdapter: typeof HerettoContentEditableAdapter;
         AsyncContentEditableAdapter: typeof StateBasedContentEditableAdapter;
         InputAdapter: typeof InputAdapter;
         MultiEditorAdapter: typeof MultiEditorAdapter;
@@ -203,6 +206,7 @@ export declare class AutoBindAdapter implements AdapterInterface {
 
 export declare interface AutobindConfig extends CommonAdapterConf {
     enableQuipAdapter?: boolean;
+    enableHerettoAdapter?: boolean;
 }
 
 export declare function autoBindFloatingSidebar(basicConf: AutoBindFloatingSidebarConfig): Promise<FloatingSidebar>;
@@ -468,6 +472,49 @@ export declare interface HasError {
 
 export declare function hasError(a: ContentExtractionResult): a is HasError;
 
+/**
+ * Custom adapter for Heretto.com that extends AsyncContentEditableAdapter
+ * with custom selectRanges and replaceRanges implementation.
+ *
+ */
+export declare class HerettoContentEditableAdapter extends StateBasedContentEditableAdapter {
+    constructor(conf: AdapterConf);
+    /**
+     * Override selectRanges to add Heretto-specific event dispatching.
+     *
+     * @param checkId - The check ID
+     * @param matches - Array of matches to select
+     * @returns Promise that resolves when selection is complete
+     */
+    selectRanges(checkId: string, matches: Match[]): Promise<void>;
+    /**
+     * Dispatch mouseup and selectionchange events to notify Heretto's GWT editor
+     * about the selection change.
+     */
+    private dispatchHerettoSelectionEvents;
+    /**
+     * Override replaceRanges with custom implementation for Heretto.com.
+     * Uses paste event to apply replacements in the Heretto editor.
+     *
+     * The replacement is done asynchronously:
+     * 1. First select the text
+     * 2. Wait for selection events to propagate
+     * 3. Apply replacement via paste event
+     *
+     * @param checkId - The check ID
+     * @param matchesWithReplacement - Array of matches with replacement suggestions
+     * @returns Promise that resolves when replacement is complete, rejects on error
+     */
+    replaceRanges(checkId: string, matchesWithReplacement: MatchWithReplacement[]): Promise<void>;
+    /**
+     * Apply replacement text using the paste event.
+     *
+     * @param replacementText - The text to insert in place of the selection
+     * @throws Error if editor is not found or not editable
+     */
+    private applyReplacementViaPaste;
+}
+
 export declare function initFloatingSidebar(config: FloatingSidebarConfig): FloatingSidebar;
 
 export declare class InputAdapter implements AdapterInterface {
@@ -520,6 +567,19 @@ export declare function isDisplayed(element: Element): boolean;
 
 export declare function isFromSameOrigin(url: string): boolean;
 
+/**
+ * Check if the element is in a Heretto.com DITA editor.
+ *
+ * Detection is based on multiple robust identifiers:
+ * 1. Domain check: must be on heretto.com
+ * 2. Iframe ID: element must be inside iframe with id "gwt-debug-PreviewViewImpl.previewFrame"
+ * 3. Body class: Heretto editor body has class "heretto"
+ *
+ * @param el - The element to check
+ * @returns true if element is in the Heretto DITA editor
+ */
+export declare function isHeretto(el: Element): boolean;
+
 export declare function isIFrame(el: Element): el is HTMLIFrameElement;
 
 export declare function isProbablyUndesiredField(el: Element): boolean;
@@ -629,6 +689,32 @@ export declare interface PositionUpdate {
 
 export declare type PromiseProvider<T> = () => PromiseLike<T>;
 
+export declare class ProseMirrorAdapter implements AdapterInterface {
+    private config;
+    private currentContentChecking?;
+    private lastContentChecked?;
+    private formatDetectedByCheck;
+    constructor(conf: ProseMirrorAdapterConf);
+    configure(partialConfig: Partial<ProseMirrorAdapterConf>): void;
+    private validateConf;
+    getContent(): string;
+    getFormat(): string;
+    extractContentForCheck(opts: ExtractContentForCheckOpts): ContentExtractionResult;
+    private getSelection;
+    registerCheckResult(checkResult: SuccessfulCheckResult): void;
+    registerCheckCall(_checkInfo: Check): void;
+    private lookupMatchesOrThrow;
+    selectRanges(_checkId: string, matches: Match[]): void;
+    replaceRanges(_checkId: string, matchesWithReplacement: MatchWithReplacement[]): void;
+    private getEscapeFunction;
+    private selectRangeAndScroll;
+}
+
+declare type ProseMirrorAdapterConf = {
+    editor: EditorView_2;
+    format?: string;
+};
+
 /**
  * Just a proof of concept.
  */