vdc-editor 0.1.274 → 0.1.276

package/lib/src/components/BulkSpellChecker.vue.d.ts

@@ -4,8 +4,15 @@ interface Props {
     editor: Editor;
     editorComment?: Editor;
     isEnableSpellCheckRealTime: boolean;
+    align?: 'left' | 'right';
 }
-declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<Props>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<Props>>> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, {
+    align: string;
+}>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, {
+    align: string;
+}>>> & Readonly<{}>, {
+    align: "left" | "right";
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 export default _default;
 type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
 type __VLS_TypePropsToRuntimeProps<T> = {
@@ -16,3 +23,11 @@ type __VLS_TypePropsToRuntimeProps<T> = {
         required: true;
     };
 };
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/lib/src/constants/bulkSpellChecker.d.ts

@@ -1,7 +1,3 @@
-export declare const ERROR_TYPE: {
-    SPACING: number;
-    SPELLING: number;
-};
 export declare const SPELL_CHECK_CODE: {
     readonly NOTHING_TO_CHANGE: "NOTHING_TO_CHANGE";
 };

package/lib/src/constants/index.d.ts

@@ -1,6 +1,7 @@
 export * from './bulkSpellChecker';
 export * from './actions-bridge';
 export * from './platform';
+export * from './spellChecker';
 /** Default lang */
 export declare const DEFAULT_LANG_VALUE: "ko";
 /** Throttle time for editor input (milliseconds) */

package/lib/src/constants/spellChecker.d.ts

@@ -0,0 +1,14 @@
+export declare const ERROR_TYPE: {
+    SPACING: number;
+    SPELLING: number;
+};
+export declare const SPELLCHECK_HIGHLIGHT_MODE: {
+    readonly SINGLE: "single";
+    readonly ERROR_TYPE: "error_type";
+};
+export type SpellcheckHighlightMode = (typeof SPELLCHECK_HIGHLIGHT_MODE)[keyof typeof SPELLCHECK_HIGHLIGHT_MODE];
+export declare const DEFAULT_SPELLCHECK_HIGHLIGHT_COLOR = "#ff4d4f";
+/** Base Tailwind classes for each error type (shared by real-time and bulk spellchecker) */
+export declare const SPELL_ERROR_COLOR_MAP: Record<number, string>;
+/** Fallback class for unknown / integrated error types */
+export declare const SPELL_ERROR_COLOR_MAP_FALLBACK = "text-green-500 border-b-2 border-green-500";

package/lib/src/extensions/SpellChecker/spellchecker-extension.d.ts

@@ -2,6 +2,7 @@ import { Extension } from '@tiptap/core';
 import { default as Spellchecker } from './spellchecker';
 import { Proofreader } from './proofreader';
 import { Component } from 'vue';
+import { SpellcheckHighlightMode } from '../../constants';
 
 export declare const SPELLCHECKER_META_LIST: {
     readonly SPELLCHECKER_TRANSACTION: "spellcheckerTransaction";
@@ -25,6 +26,8 @@ export interface ISpellcheckerOptions {
     uiStrings?: IUiStrings;
     onShowSuggestionsEvent?: (word: string) => void;
     bulkSpellCheckerButton?: Component;
+    spellcheckHighlightMode?: SpellcheckHighlightMode;
+    spellcheckHighlightColor?: string;
 }
 export interface ISpellcheckerStorage {
     didPaste: boolean;

package/lib/src/extensions/SpellChecker/spellchecker.d.ts

@@ -3,6 +3,7 @@ import { Transaction } from 'prosemirror-state';
 import { DecorationSet, EditorView } from 'prosemirror-view';
 import { IProofreaderInterface, IChangedNodes } from '../../type';
 import { IUiStrings, ISpellcheckerStorage } from './spellchecker-extension';
+import { SpellcheckHighlightMode } from '../../constants';
 
 interface IGetMatchAndSetDecorationsList {
     text: string;
@@ -27,9 +28,11 @@ export default class Spellchecker {
     private isEnableSuggestion;
     private isMobile;
     private limit;
+    private spellcheckHighlightMode;
+    private spellcheckHighlightColor;
     private _debouncedProofreadDoc;
     private _debouncedHandleEnterKey;
-    constructor(proofreader: IProofreaderInterface, uiStrings?: IUiStrings, showSuggestionsEvent?: (word: string) => void, limit?: number);
+    constructor(proofreader: IProofreaderInterface, uiStrings?: IUiStrings, showSuggestionsEvent?: (word: string) => void, limit?: number, spellcheckHighlightMode?: SpellcheckHighlightMode, spellcheckHighlightColor?: string);
     getProofreader(): IProofreaderInterface;
     toggleIsEnabledSpellCheck(): void;
     setEnabledProofreadText(isEnabled: boolean): void;

package/lib/src/index.d.ts

@@ -12,7 +12,7 @@ export { useConfigTiptap, useTiptapStore } from './hooks';
 export * as nodeNames from './utils/node-names';
 export type { ExtensionName } from './utils/node-names';
 export type * from './type';
-export { EditorMode } from './constants';
+export { EditorMode, SPELLCHECK_HIGHLIGHT_MODE, DEFAULT_SPELLCHECK_HIGHLIGHT_COLOR } from './constants';
 export type { HistoryOptions } from '@tiptap/extension-history';
 export { useEditor } from '@tiptap/vue-3';
 export type { Editor as EditorInstance } from '@tiptap/core';

package/lib/src/type.d.ts

@@ -160,6 +160,7 @@ export interface ITextWithPosition {
     startIndex: number;
     length: number;
     wrongWord: string;
+    errorType?: number;
 }
 export interface ITransferSpellData {
     errorText: ITextWithPosition;
@@ -171,6 +172,10 @@ export type SpellCheckDataType = {
     endIndex: number;
     wrongWordIndex: number;
     wrongWord: string;
+    errorHelpDtos?: {
+        errorType: number;
+        errorMessage: string;
+    }[];
 };
 type SingleEditorState = {
     editor: CoreEditor | null;

package/lib/src/utils/bulkSpellchecker.d.ts

@@ -1,7 +1,16 @@
+import { SpellcheckHighlightMode } from '../constants';
 import { WrongWordItem } from '../type';
 import { Editor } from '@tiptap/core';
 
-export declare function applyHighlights(editor: Editor, errors: WrongWordItem[]): void;
+/**
+ * Returns the CSS class string and inline style for a bulk highlight decoration
+ * based on the configured spellcheck highlight mode.
+ */
+export declare function getSpellcheckHighlightAttrs(mode: SpellcheckHighlightMode, color: string, errorType?: number): {
+    class: string;
+    style: string;
+};
+export declare function applyHighlights(editor: Editor, errors: WrongWordItem[], mode?: SpellcheckHighlightMode, color?: string): void;
 export declare function clearHighlights(editor: Editor): void;
 export declare function buildPlainIndexToDocPosMap(editor: Editor, blockSeparator?: string): (number | null)[];
 export declare function findDocPosFromOffset(editor: Editor, offset: number, blockSeparator?: string): number;