@difizen/libro-codemirror 0.0.2-alpha.0

package/es/editor.d.ts

@@ -0,0 +1,361 @@
+import type { ChangeSet, Extension, Range, StateEffectType, StateCommand, Text } from '@codemirror/state';
+import { EditorState, StateField } from '@codemirror/state';
+import { Decoration, EditorView } from '@codemirror/view';
+import type { Command, DecorationSet, ViewUpdate } from '@codemirror/view';
+import type { IEditor, IEditorConfig, IEditorSelectionStyle, KeydownHandler, IEditorOptions, IModel, IPosition, IRange, ICoordinate, ITextSelection, IToken } from '@difizen/libro-code-editor';
+import { Disposable, Emitter } from '@difizen/mana-app';
+import type { CodeMirrorConfig } from './config.js';
+import { EditorConfiguration } from './config.js';
+/**
+ * The time that a collaborator name hover persists.
+ */
+/**
+ * The default configuration options for an editor.
+ */
+export declare const codeMirrorDefaultConfig: Required<CodeMirrorConfig>;
+export declare class CodeMirrorEditor implements IEditor {
+    /**
+     * Construct a CodeMirror editor.
+     */
+    constructor(options: IOptions);
+    handleTooltipChange: (val: boolean) => void;
+    /**
+     * Initialize the editor binding.
+     */
+    save: () => void;
+    /**
+     * A signal emitted when either the top or bottom edge is requested.
+     */
+    readonly edgeRequestedEmitter: Emitter<any>;
+    readonly edgeRequested: import("@difizen/mana-app").Event<any>;
+    /**
+     * The DOM node that hosts the editor.
+     */
+    readonly host: HTMLElement;
+    /**
+     * The uuid of this editor;
+     */
+    get uuid(): string;
+    set uuid(value: string);
+    protected modalChangeEmitter: Emitter<boolean>;
+    get onModalChange(): import("@difizen/mana-app").Event<boolean>;
+    /**
+     * The selection style of this editor.
+     */
+    get selectionStyle(): IEditorSelectionStyle;
+    set selectionStyle(value: IEditorSelectionStyle);
+    /**
+     * Get the codemirror editor wrapped by the editor.
+     */
+    get editor(): EditorView;
+    /**
+     * Get the codemirror doc wrapped by the widget.
+     */
+    get doc(): Text;
+    /**
+     * Get the number of lines in the editor.
+     */
+    get lineCount(): number;
+    /**
+     * Returns a model for this editor.
+     */
+    get model(): IModel;
+    /**
+     * The height of a line in the editor in pixels.
+     */
+    get lineHeight(): number;
+    /**
+     * The widget of a character in the editor in pixels.
+     */
+    get charWidth(): number;
+    /**
+     * Tests whether the editor is disposed.
+     */
+    get isDisposed(): boolean;
+    /**
+     * Dispose of the resources held by the widget.
+     */
+    dispose(): void;
+    /**
+     * Get a config option for the editor.
+     */
+    getOption<K extends keyof IConfig>(option: K): IConfig[K];
+    /**
+     * Set a config option for the editor.
+     */
+    setOption<K extends keyof IEditorConfig>(option: K, value: IEditorConfig[K]): void;
+    /**
+     * Set config options for the editor.
+     *
+     * This method is preferred when setting several options. The
+     * options are set within an operation, which only performs
+     * the costly update at the end, and not after every option
+     * is set.
+     */
+    setOptions(options: Partial<IEditorConfig>): void;
+    injectExtension(ext: Extension): void;
+    /**
+     * Returns the content for the given line number.
+     */
+    getLine(line: number): string | undefined;
+    /**
+     * Find an offset for the given position.
+     */
+    getOffsetAt(position: IPosition): number;
+    /**
+     * Find a position for the given offset.
+     */
+    getPositionAt(offset: number): IPosition;
+    /**
+     * Undo one edit (if any undo events are stored).
+     */
+    undo(): void;
+    /**
+     * Redo one undone edit.
+     */
+    redo(): void;
+    /**
+     * Clear the undo history.
+     */
+    clearHistory(): void;
+    /**
+     * Brings browser focus to this editor text.
+     */
+    focus(): void;
+    /**
+     * Test whether the editor has keyboard focus.
+     */
+    hasFocus(): boolean;
+    /**
+     * Explicitly blur the editor.
+     */
+    blur(): void;
+    /**
+     * Refresh the editor if it is focused;
+     * otherwise postpone refreshing till focusing.
+     */
+    resizeToFit(): void;
+    get state(): EditorState;
+    firstLine(): number;
+    lastLine(): number;
+    cursorCoords(where: boolean): {
+        left: number;
+        top: number;
+        bottom: number;
+    };
+    getRange(from: {
+        line: number;
+        ch: number;
+    }, to: {
+        line: number;
+        ch: number;
+    }): string;
+    /**
+     * Add a keydown handler to the editor.
+     *
+     * @param handler - A keydown handler.
+     *
+     * @returns A disposable that can be used to remove the handler.
+     */
+    addKeydownHandler(handler: KeydownHandler): Disposable;
+    /**
+     * Reveal the given position in the editor.
+     */
+    revealPosition(position: IPosition): void;
+    /**
+     * Reveal the given selection in the editor.
+     */
+    revealSelection(selection: IRange): void;
+    /**
+     * Get the window coordinates given a cursor position.
+     */
+    getCoordinateForPosition(position: IPosition): ICoordinate;
+    /**
+     * Get the cursor position given window coordinates.
+     *
+     * @param coordinate - The desired coordinate.
+     *
+     * @returns The position of the coordinates, or null if not
+     *   contained in the editor.
+     */
+    getPositionForCoordinate(coordinate: ICoordinate): IPosition | null;
+    /**
+     * Returns the primary position of the cursor, never `null`.
+     */
+    getCursorPosition(): IPosition;
+    /**
+     * Set the primary position of the cursor.
+     *
+     * #### Notes
+     * This will remove any secondary cursors.
+     */
+    setCursorPosition(position: IPosition): void;
+    /**
+     * Returns the primary selection, never `null`.
+     */
+    getSelection(): ITextSelection;
+    /**
+     * Set the primary selection. This will remove any secondary cursors.
+     */
+    setSelection(selection: IRange): void;
+    /**
+     * Gets the selections for all the cursors, never `null` or empty.
+     */
+    getSelections(): ITextSelection[];
+    /**
+     * Sets the selections for all the cursors, should not be empty.
+     * Cursors will be removed or added, as necessary.
+     * Passing an empty array resets a cursor position to the start of a document.
+     */
+    setSelections(selections: IRange[]): void;
+    /**
+     * Replaces the current selection with the given text.
+     *
+     * @param text The text to be inserted.
+     */
+    replaceSelection(text: string): void;
+    /**
+     * Get a list of tokens for the current editor text content.
+     */
+    getTokens(): IToken[];
+    /**
+     * Get the token at a given editor position.
+     */
+    getTokenAt(offset: number): IToken;
+    /**
+     * Get the token a the cursor position.
+     */
+    getTokenAtCursor(): IToken;
+    /**
+     * Insert a new indented line at the current cursor position.
+     */
+    newIndentedLine(): void;
+    /**
+     * Execute a codemirror command on the editor.
+     *
+     * @param command - The name of the command to execute.
+     */
+    execCommand(command: Command | StateCommand): void;
+    /**
+     * Handle keydown events from the editor.
+     */
+    protected onKeydown(event: KeyboardEvent): boolean;
+    /**
+     * Handles a mime type change.
+     */
+    protected _onMimeTypeChanged(): void;
+    protected _buildMarkDecoration(uuid: string, _selections: ISelectionText[]): Range<Decoration>[];
+    /**
+     * Converts the selection style to a text marker options.
+     */
+    /**
+     * Construct a caret element representing the position
+     * of a collaborator's cursor.
+     */
+    /**
+     * Handles a cursor activity event.
+     */
+    protected _onCursorActivity(): void;
+    /**
+     * Converts a code mirror selection to an editor selection.
+     */
+    protected _toSelection(selection: {
+        anchor: {
+            line: number;
+            ch: number;
+        };
+        head: {
+            line: number;
+            ch: number;
+        };
+    }): ITextSelection;
+    /**
+     * Convert a code mirror position to an editor position.
+     */
+    protected _toPosition(position: {
+        line: number;
+        ch: number;
+    }): {
+        line: number;
+        column: number;
+    };
+    /**
+     * Convert an editor position to a code mirror position.
+     */
+    protected _toCodeMirrorPosition(position: IPosition): {
+        line: number;
+        ch: number;
+    };
+    /**
+     * Handles document changes.
+     */
+    protected _onDocChanged(update: ViewUpdate): void;
+    /**
+     * Handle the DOM events for the editor.
+     *
+     * @param event - The DOM event sent to the editor.
+     *
+     * #### Notes
+     * This method implements the DOM `EventListener` interface and is
+     * called in response to events on the editor's DOM node. It should
+     * not be called directly by user code.
+     */
+    handleEvent(event: Event): void;
+    /**
+     * Handle `focus` events for the editor.
+     */
+    protected _evtFocus(): void;
+    /**
+     * Handle `blur` events for the editor.
+     */
+    protected _evtBlur(): void;
+    /**
+     * Handle `scroll` events for the editor.
+     */
+    protected _evtScroll(): void;
+    /**
+     * Clear the hover for a caret, due to things like
+     * scrolling, resizing, deactivation, etc, where
+     * the position is no longer valid.
+     */
+    protected _clearHover(): void;
+    protected _model: IModel;
+    protected _editor: EditorView;
+    protected _selectionMarkers: Record<string, Range<Decoration>[]>;
+    protected _caretHover: HTMLElement | null;
+    protected _config: IConfig;
+    protected _hoverTimeout: number | undefined;
+    protected _hoverId: string | undefined;
+    protected _keydownHandlers: KeydownHandler[];
+    protected _selectionStyle: IEditorSelectionStyle;
+    protected _uuid: string;
+    protected _isDisposed: boolean;
+    protected _lastChange: ChangeSet | null;
+    protected _editorConfig: EditorConfiguration;
+    protected _addMark: StateEffectType<ICollabSelectionText>;
+    protected _removeMark: StateEffectType<ICollabDecorationSet>;
+    protected _markField: StateField<DecorationSet>;
+}
+export type IConfig = CodeMirrorConfig;
+export interface IOptions extends IEditorOptions {
+    [x: string]: any;
+    /**
+     * The configuration options for the editor.
+     */
+    config?: Partial<IConfig>;
+}
+export declare function createEditor(host: HTMLElement, config: IConfig, value: string, editorConfig: EditorConfiguration, additionalExtensions: Extension[]): EditorView;
+export interface ISelectionText {
+    from: number;
+    to: number;
+    style: IEditorSelectionStyle;
+}
+export interface ICollabSelectionText {
+    uuid: string;
+    selections: ISelectionText[];
+}
+export interface ICollabDecorationSet {
+    uuid: string;
+    decorations: Range<Decoration>[];
+}
+//# sourceMappingURL=editor.d.ts.map

package/es/editor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"editor.d.ts","sourceRoot":"","sources":["../src/editor.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,SAAS,EACT,SAAS,EACT,KAAK,EACL,eAAe,EACf,YAAY,EACZ,IAAI,EACL,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAEL,WAAW,EAGX,UAAU,EACX,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC3E,OAAO,KAAK,EACV,OAAO,EACP,aAAa,EACb,qBAAqB,EACrB,cAAc,EACd,cAAc,EACd,MAAM,EACN,SAAS,EACT,MAAM,EACN,WAAW,EACX,cAAc,EACd,MAAM,EACP,MAAM,4BAA4B,CAAC;AAGpC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAKxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAkClD;;GAEG;AAEH;;GAEG;AAQH,eAAO,MAAM,uBAAuB,EAAE,QAAQ,CAAC,gBAAgB,CA8C9D,CAAC;AAEF,qBAAa,gBAAiB,YAAW,OAAO;IAC9C;;OAEG;gBACS,OAAO,EAAE,QAAQ;IAwH7B,mBAAmB,QAAS,OAAO,UAEjC;IAEF;;OAEG;IAUH,IAAI,EAAE,MAAM,IAAI,CAEd;IACF;;OAEG;IACH,QAAQ,CAAC,oBAAoB,eAAiB;IAC9C,QAAQ,CAAC,aAAa,yCAAmC;IACzD;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IACD,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,EAErB;IAED,SAAS,CAAC,kBAAkB,mBAA0B;IAEtD,IAAI,aAAa,+CAEhB;IAED;;OAEG;IACH,IAAI,cAAc,IAAI,qBAAqB,CAE1C;IACD,IAAI,cAAc,CAAC,KAAK,EAAE,qBAAqB,EAE9C;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,UAAU,CAEvB;IAED;;OAEG;IACH,IAAI,GAAG,IAAI,IAAI,CAEd;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;OAEG;IACH,OAAO,IAAI,IAAI;IAaf;;OAEG;IACH,SAAS,CAAC,CAAC,SAAS,MAAM,OAAO,EAAE,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAIzD;;OAEG;IACH,SAAS,CAAC,CAAC,SAAS,MAAM,aAAa,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI;IAelF;;;;;;;OAOG;IACH,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI;IAKjD,eAAe,CAAC,GAAG,EAAE,SAAS,GAAG,IAAI;IAIrC;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAMzC;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,SAAS,GAAG,MAAM;IAKxC;;OAEG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IAMxC;;OAEG;IACH,IAAI,IAAI,IAAI;IAOZ;;OAEG;IACH,IAAI,IAAI,IAAI;IAOZ;;OAEG;IACH,YAAY,IAAI,IAAI;IAIpB;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;OAEG;IACH,QAAQ,IAAI,OAAO;IAInB;;OAEG;IACH,IAAI,IAAI,IAAI;IAIZ;;;OAGG;IACH,WAAW,IAAI,IAAI;IAInB,IAAI,KAAK,IAAI,WAAW,CAEvB;IAED,SAAS,IAAI,MAAM;IAKnB,QAAQ,IAAI,MAAM;IAIlB,YAAY,CACV,KAAK,EAAE,OAAO,GAEb;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE;IAOhD,QAAQ,CACN,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,EAClC,EAAE,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,GAE/B,MAAM;IAMT;;;;;;OAMG;IACH,iBAAiB,CAAC,OAAO,EAAE,cAAc,GAAG,UAAU;IAOtD;;OAEG;IACH,cAAc,CAAC,QAAQ,EAAE,SAAS,GAAG,IAAI;IAOzC;;OAEG;IACH,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAQxC;;OAEG;IACH,wBAAwB,CAAC,QAAQ,EAAE,SAAS,GAAG,WAAW;IAK1D;;;;;;;OAOG;IACH,wBAAwB,CAAC,UAAU,EAAE,WAAW,GAAG,SAAS,GAAG,IAAI;IAQnE;;OAEG;IACH,iBAAiB,IAAI,SAAS;IAK9B;;;;;OAKG;IACH,iBAAiB,CACf,QAAQ,EAAE,SAAS,GAElB,IAAI;IAcP;;OAEG;IACH,YAAY,IAAI,cAAc;IAI9B;;OAEG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAIrC;;OAEG;IACH,aAAa,IAAI,cAAc,EAAE;IAgBjC;;;;OAIG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI;IASzC;;;;OAIG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAIpC;;OAEG;IACH,SAAS,IAAI,MAAM,EAAE;IAkBrB;;OAEG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAiBlC;;OAEG;IACH,gBAAgB,IAAI,MAAM;IAI1B;;OAEG;IACH,eAAe,IAAI,IAAI;IAOvB;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,YAAY,GAAG,IAAI;IAIlD;;OAEG;IACH,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO;IAgClD;;OAEG;IACH,SAAS,CAAC,kBAAkB,IAAI,IAAI;IAepC,SAAS,CAAC,oBAAoB,CAC5B,IAAI,EAAE,MAAM,EAEZ,WAAW,EAAE,cAAc,EAAE;IAyC/B;;OAEG;IAaH;;;OAGG;IAkBH;;OAEG;IACH,SAAS,CAAC,iBAAiB,IAAI,IAAI;IASnC;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE;QAChC,MAAM,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,EAAE,EAAE,MAAM,CAAA;SAAE,CAAC;QACrC,IAAI,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,EAAE,EAAE,MAAM,CAAA;SAAE,CAAC;KACpC,GAAG,cAAc;IAQlB;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE;;;;IAO5D;;OAEG;IACH,SAAS,CAAC,qBAAqB,CAAC,QAAQ,EAAE,SAAS;;;;IAOnD;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,MAAM,EAAE,UAAU;IAW1C;;;;;;;;;OASG;IACH,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAgB/B;;OAEG;IACH,SAAS,CAAC,SAAS,IACnB,IAAI;IASJ;;OAEG;IACH,SAAS,CAAC,QAAQ,IAClB,IAAI;IAIJ;;OAEG;IACH,SAAS,CAAC,UAAU,IAAI,IAAI;IAK5B;;;;OAIG;IACH,SAAS,CAAC,WAAW,IAAI,IAAI;IAO7B,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC;IAC9B,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAM;IACtE,SAAS,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI,CAAQ;IACjD,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAa;IACxD,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAa;IACnD,SAAS,CAAC,gBAAgB,mBAA+B;IACzD,SAAS,CAAC,eAAe,EAAE,qBAAqB,CAAC;IACjD,SAAS,CAAC,KAAK,SAAM;IACrB,SAAS,CAAC,WAAW,UAAS;IAC9B,SAAS,CAAC,WAAW,EAAE,SAAS,GAAG,IAAI,CAAQ;IAG/C,SAAS,CAAC,aAAa,EAAE,mBAAmB,CAAC;IAC7C,SAAS,CAAC,QAAQ,EAAE,eAAe,CAAC,oBAAoB,CAAC,CAAC;IAC1D,SAAS,CAAC,WAAW,EAAE,eAAe,CAAC,oBAAoB,CAAC,CAAC;IAC7D,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC;CACjD;AAED,MAAM,MAAM,OAAO,GAAG,gBAAgB,CAAC;AAEvC,MAAM,WAAW,QAAS,SAAQ,cAAc;IAC9C,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;CAC3B;AAED,wBAAgB,YAAY,CAC1B,IAAI,EAAE,WAAW,EACjB,MAAM,EAAE,OAAO,EACf,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,mBAAmB,EACjC,oBAAoB,EAAE,SAAS,EAAE,GAChC,UAAU,CAiBZ;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,qBAAqB,CAAC;CAC9B;AACD,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,cAAc,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;CAClC"}