@acrolinx/sidebar-sdk 2.0.0-dev1 → 2.0.1

package/README.md

@@ -89,11 +89,10 @@ The process to update your existing integration is straightforward and involves
 - Run `npm i`
 - Run `npm run build` to run all tests and build distribution
 
-## Serve for Development
+## Serve Tests for Development
 
-- Run 'npm run webpack-dev-server'
-- Include '<script src="http://0.0.0.0:8081/dist/acrolinx-sidebar-sdk.js"></script>' into your project.
-- Check the output of the above npm task and correct the host port if needed.
+- Run 'npm run test'
+- Browser with ViTest running will open 
 
 ## License
 

package/dist/index.d.ts

@@ -7,6 +7,7 @@ import { CheckResult } from '@acrolinx/sidebar-interface';
 import { default as default_2 } from '@ckeditor/ckeditor5-build-inline';
 import { DocumentSelection } from '@acrolinx/sidebar-interface';
 import { Editor } from 'tinymce';
+import { EditorFromTextArea } from 'codemirror';
 import { EditorView } from '@codemirror/view';
 import { ExternalContent } from '@acrolinx/sidebar-interface';
 import { InitParameters } from '@acrolinx/sidebar-interface';
@@ -96,7 +97,9 @@ export declare interface AcrolinxSidebarIntegration {
         AutoBindAdapter: typeof AutoBindAdapter;
         AsyncAutoBindAdapter: typeof AsyncAutoBindAdapter;
         CKEditor5Adapter: typeof CKEditor5Adapter;
+        CKEditorAdapter: typeof CKEditorAdapter;
         CodeMirror6Adapter: typeof CodeMirror6Adapter;
+        CodeMirrorAdapter: typeof CodeMirrorAdapter;
         ContentEditableAdapter: typeof ContentEditableAdapter;
         AsyncContentEditableAdapter: typeof StateBasedContentEditableAdapter;
         InputAdapter: typeof InputAdapter;
@@ -226,6 +229,18 @@ export declare class CKEditor5Adapter extends AbstractRichtextEditorAdapter {
     isInSourceEditingMode(): boolean;
 }
 
+export declare class CKEditorAdapter extends AbstractRichtextEditorAdapter {
+    editorId: string;
+    constructor(conf: HasEditorID);
+    getEditor(): CKEDITOR.editor;
+    getEditorDocument(): Document;
+    getContent(): string;
+    extractContentForCheck(): ContentExtractionResult;
+    selectRanges(checkId: string, matches: Match[]): void;
+    replaceRanges(checkId: string, matchesWithReplacementArg: MatchWithReplacement[]): void;
+    isInWysiwygMode(): boolean;
+}
+
 export declare class CodeMirror6Adapter implements AdapterInterface {
     private config;
     private currentContentChecking?;
@@ -254,6 +269,36 @@ declare type CodeMirror6AdapterConf = {
     format?: string;
 };
 
+export declare class CodeMirrorAdapter implements AdapterInterface {
+    private config;
+    private currentContentChecking?;
+    private lastContentChecked?;
+    private formatDetectedByCheck;
+    constructor(conf: CodeMirrorAdapterConf);
+    configure(partialConfig: Partial<CodeMirrorAdapterConf>): void;
+    private validateConf;
+    getContent(): string;
+    getFormat(): string;
+    private getFormatFromCodeMirror;
+    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 getDoc;
+    private selectRange;
+    private selectRangeAndScroll;
+    private cmSelectionToRange;
+}
+
+declare type CodeMirrorAdapterConf = {
+    editor: CodeMirror.Editor | EditorFromTextArea;
+    format?: string;
+};
+
 declare interface CommonAdapterConf {
     scrollOffsetY?: number;
     disableInputEventSimulation?: boolean;