@ones-editor/editor 2.9.8 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/@ones-editor/cke-html/package.json +7 -0
  2. package/@ones-editor/cke-html/src/html/cke-html.d.ts +4 -0
  3. package/@ones-editor/cke-html/src/html/combine-html.d.ts +2 -0
  4. package/@ones-editor/cke-html/src/html/comment.d.ts +6 -0
  5. package/@ones-editor/cke-html/src/html/converter.d.ts +7 -0
  6. package/@ones-editor/cke-html/src/html/data-helper/link-data.d.ts +0 -0
  7. package/@ones-editor/cke-html/src/html/image.d.ts +4 -0
  8. package/@ones-editor/cke-html/src/html/link.d.ts +2 -0
  9. package/@ones-editor/cke-html/src/html/markdown.d.ts +2 -0
  10. package/@ones-editor/cke-html/src/html/mention.d.ts +4 -0
  11. package/@ones-editor/cke-html/src/index.d.ts +2 -0
  12. package/@ones-editor/context-menu/src/helper/command-items.d.ts +3 -1
  13. package/@ones-editor/context-menu/src/menu/index.d.ts +1 -0
  14. package/@ones-editor/core/src/core/composition/editor-input.d.ts +2 -0
  15. package/@ones-editor/core/src/core/doc/doc.d.ts +4 -1
  16. package/@ones-editor/core/src/core/editor-doc/editor-doc.d.ts +1 -0
  17. package/@ones-editor/core/src/core/input-handler/remove-unknown-components.d.ts +3 -0
  18. package/@ones-editor/core/src/core/selection/actions/index.d.ts +2 -2
  19. package/@ones-editor/core/src/core/selection/actions/select-all.d.ts +1 -0
  20. package/@ones-editor/core/src/core/types.d.ts +4 -0
  21. package/@ones-editor/core/src/local-doc/index.d.ts +1 -0
  22. package/@ones-editor/core/src/users/remote-users.d.ts +1 -1
  23. package/@ones-editor/file/src/file-embed/card/index.d.ts +6 -2
  24. package/@ones-editor/file/src/index.d.ts +2 -1
  25. package/@ones-editor/file/src/locale/en-us.d.ts +2 -0
  26. package/@ones-editor/file/src/locale/ja-jp.d.ts +2 -0
  27. package/@ones-editor/file/src/locale/zh-cn.d.ts +2 -0
  28. package/@ones-editor/file/src/locale/zh-hant-hk.d.ts +2 -0
  29. package/@ones-editor/file/src/types.d.ts +1 -0
  30. package/@ones-editor/find-dialog/src/highlights/highlight-dom.d.ts +2 -0
  31. package/@ones-editor/graph-embed/src/helper/graph-dom/code-editor.d.ts +1 -0
  32. package/@ones-editor/html-to-doc/src/html-to-doc/normal-html/super-script.d.ts +1 -0
  33. package/@ones-editor/list-block/src/index.d.ts +2 -0
  34. package/@ones-editor/main-toolbar/src/index.d.ts +8 -1
  35. package/@ones-editor/main-toolbar/src/items/file.d.ts +10 -0
  36. package/@ones-editor/main-toolbar/src/items/index.d.ts +5 -2
  37. package/@ones-editor/main-toolbar/src/items/insert.d.ts +3 -0
  38. package/@ones-editor/main-toolbar/src/items/mention.d.ts +8 -0
  39. package/@ones-editor/main-toolbar/src/items/paragraph.d.ts +2 -1
  40. package/@ones-editor/main-toolbar/src/locale/en-us.d.ts +3 -0
  41. package/@ones-editor/main-toolbar/src/locale/ja-jp.d.ts +3 -0
  42. package/@ones-editor/main-toolbar/src/locale/zh-cn.d.ts +3 -0
  43. package/@ones-editor/main-toolbar/src/locale/zh-hant-hk.d.ts +3 -0
  44. package/@ones-editor/server-tools/src/index.d.ts +4 -1
  45. package/@ones-editor/sharedb-doc/src/doc/sharedb-doc.d.ts +2 -0
  46. package/@ones-editor/tsconfig.tsbuildinfo +1 -1
  47. package/@ones-editor/ui/src/providers/list.d.ts +1 -1
  48. package/@ones-editor/ui/src/quick-menu/index.d.ts +3 -3
  49. package/@ones-editor/ui/src/toolbar/toolbar-handler.d.ts +1 -0
  50. package/@ones-editor/ui-base/src/command-bar/command-bar.d.ts +2 -1
  51. package/@ones-editor/ui-base/src/command-bar/fixed-toolbar.d.ts +1 -0
  52. package/@ones-editor/ui-base/src/command-bar/manual-command-bar.d.ts +7 -3
  53. package/@ones-editor/ui-base/src/command-bar/types.d.ts +17 -8
  54. package/@ones-editor/ui-base/src/icons/index.d.ts +4 -1
  55. package/@ones-editor/versions/src/history-doc/history-doc.d.ts +3 -1
  56. package/@ones-editor/versions/src/version-dialog/index.d.ts +2 -1
  57. package/dist/index.d.ts +4 -1
  58. package/dist/index.js +3000 -1797
  59. package/dist/types.d.ts +3 -0
  60. package/package.json +1 -1
@@ -7,7 +7,7 @@ export default class ListProvider implements OnesEditorCommandProvider {
7
7
  getAvailableCommands(editor: OnesEditor, block: BlockElement, range: SelectionRange, params?: CommandParams): CommandItem[];
8
8
  getInsertCommands(): CommandItem[];
9
9
  convertToList(editor: OnesEditor, block: BlockElement, listType: 'unordered' | 'ordered' | 'unchecked'): void;
10
- insertList(editor: OnesEditor, containerId: string, blockIndex: number, listType: 'unordered' | 'ordered' | 'unchecked'): void;
10
+ insertList(editor: OnesEditor, containerId: string, blockIndex: number, listType: 'unordered' | 'ordered' | 'unchecked', command: CommandItem): void;
11
11
  executeCommand(editor: OnesEditor, block: BlockElement, range: SelectionRange, command: CommandItem): boolean;
12
12
  executeInsertCommand: (editor: OnesEditor, containerId: string, blockIndex: number, command: CommandItem) => boolean;
13
13
  }
@@ -1,13 +1,13 @@
1
- import { OnesEditor, CommandItem, CommandItemWithSource, CommandFilterId, CommandFilter } from '../../../../@ones-editor/core';
1
+ import { OnesEditor, CommandItem, OnesEditorCommandProviders, CommandItemWithSource, CommandFilterId, CommandFilter } from '../../../../@ones-editor/core';
2
2
  import { OnesEditorAutoSuggest } from '../../../../@ones-editor/ui-base';
3
3
  import { QuickMenuOptions } from './types';
4
4
  export default class OnesEditorQuickMenu {
5
5
  protected editor: OnesEditor;
6
6
  private options;
7
7
  protected suggest: OnesEditorAutoSuggest;
8
- private items;
8
+ protected items: CommandItem[];
9
9
  private firstEmptyOffset;
10
- private quickCommandProviders;
10
+ quickCommandProviders: OnesEditorCommandProviders;
11
11
  constructor(editor: OnesEditor, options?: QuickMenuOptions);
12
12
  get menu(): import("@ones-editor/ui-base").ManualMenu | import("@ones-editor/ui-base/src/mobile-command-bar/mobile-bottom-menu").MobileBottomMenu;
13
13
  addFilter(id: CommandFilterId, filter: CommandFilter): void;
@@ -12,6 +12,7 @@ export default class OnesEditorToolbar implements OnesEditorHoveringBlockFilter,
12
12
  private oldRange;
13
13
  private hoveringBlock;
14
14
  private hoveringTextChild;
15
+ private targetTextChild;
15
16
  private _disableTextToolbar;
16
17
  private _lastClickTime;
17
18
  private _disabled;
@@ -14,7 +14,7 @@ export default abstract class CommandBar extends TypedEmitter<CommandBarEvents>
14
14
  private header;
15
15
  private footer;
16
16
  constructor(items: CommandItem[], closeable?: Closeable, options?: CommandBarOptions);
17
- close(reason: CloseReason): void;
17
+ close(reason: CloseReason, e?: MouseEvent | null): void;
18
18
  click(item: CommandItem, target: HTMLElement): void;
19
19
  createPopperOptions(flip?: boolean): Partial<import("@popperjs/core").Options>;
20
20
  destroy(): void;
@@ -22,6 +22,7 @@ export default abstract class CommandBar extends TypedEmitter<CommandBarEvents>
22
22
  get isSubCommandBar(): boolean;
23
23
  updateItems(items: CommandItem[]): void;
24
24
  handleDocumentKeydown: (event: KeyboardEvent) => boolean;
25
+ protected canClose(): boolean;
25
26
  protected handleDocumentMouseDown: (event: MouseEvent | TouchEvent) => void;
26
27
  protected handleHidden: () => void;
27
28
  protected handleShown: () => void;
@@ -6,6 +6,7 @@ export default class FixedToolbar extends CommandBar {
6
6
  handleDocumentKeydown: (event: KeyboardEvent) => boolean;
7
7
  protected initCommandBarElement(elem: HTMLElement): void;
8
8
  protected initItemElement(item: CommandItem, elem: CommandItemElement): void;
9
+ protected canClose(): boolean;
9
10
  close(): void;
10
11
  getSubBarCreateOptions: (item: CommandItem) => CommandBarOptions;
11
12
  getSubBarOptions: (item: CommandItem) => ManualShowCommandBarOptions;
@@ -1,12 +1,16 @@
1
- import { CloseReason } from '../../../../@ones-editor/core';
1
+ import { CloseReason, CommandItem, Closeable } from '../../../../@ones-editor/core';
2
2
  import { Instance } from 'tippy.js';
3
3
  import CommandBar from './command-bar';
4
- import { AbstractManualCommandBar, ManualShowCommandBarOptions } from './types';
4
+ import { AbstractManualCommandBar, CommandBarOptions, ManualShowCommandBarOptions } from './types';
5
5
  export default abstract class ManualCommandBar extends CommandBar implements AbstractManualCommandBar {
6
+ private manualCommandBarOptions?;
6
7
  tippyInstance: Instance | null;
8
+ _target: HTMLElement | null;
9
+ constructor(items: CommandItem[], closeable?: Closeable, manualCommandBarOptions?: CommandBarOptions | undefined);
10
+ handleBeforeClose: (event?: MouseEvent | TouchEvent) => boolean;
7
11
  setProps: (props: ManualShowCommandBarOptions) => void;
8
12
  manualShow(target: HTMLElement, options?: ManualShowCommandBarOptions): void;
9
- close(reason: CloseReason): void;
13
+ close(reason: CloseReason, e?: MouseEvent | null): void;
10
14
  destroy(): void;
11
15
  protected getCommandBarRoot(): HTMLElement | null;
12
16
  get isVisible(): boolean;
@@ -3,13 +3,13 @@ import { TypedEmitter } from 'tiny-typed-emitter';
3
3
  import type { GetReferenceClientRect, Placement } from 'tippy.js';
4
4
  export { Placement };
5
5
  export interface CommandBarEvents {
6
- 'show': (bar: AbstractCommandBar) => void;
7
- 'shown': (bar: AbstractCommandBar) => void;
8
- 'click': (bar: AbstractCommandBar, item: CommandItem, elem: HTMLElement) => void;
9
- 'close': (bar: AbstractCommandBar) => void;
10
- 'selectionChange': (bar: AbstractCommandBar, id: string) => void;
11
- 'closing': (bar: AbstractCommandBar, event: MouseEvent | TouchEvent) => boolean | undefined;
12
- 'subBarShown': (bar: AbstractCommandBar, subBar: AbstractCommandBar) => void;
6
+ show: (bar: AbstractCommandBar) => void;
7
+ shown: (bar: AbstractCommandBar) => void;
8
+ click: (bar: AbstractCommandBar, item: CommandItem, elem: HTMLElement) => void;
9
+ close: (bar: AbstractCommandBar) => void;
10
+ selectionChange: (bar: AbstractCommandBar, id: string) => void;
11
+ closing: (bar: AbstractCommandBar, event: MouseEvent | TouchEvent) => boolean | undefined;
12
+ subBarShown: (bar: AbstractCommandBar, subBar: AbstractCommandBar) => void;
13
13
  }
14
14
  export interface ManualShowCommandBarOptions {
15
15
  placement?: Placement;
@@ -25,7 +25,8 @@ export interface ManualShowCommandBarOptions {
25
25
  export interface AbstractCommandBar extends TypedEmitter<CommandBarEvents> {
26
26
  readonly isVisible: boolean;
27
27
  readonly parentItem: CommandItem | null;
28
- close: (reason: CloseReason) => void;
28
+ closeable: Closeable | null;
29
+ close: (reason: CloseReason, e?: MouseEvent | null) => void;
29
30
  destroy: () => void;
30
31
  isInCommandBar: (target: EventTarget | null) => boolean;
31
32
  handleDocumentKeydown: (event: KeyboardEvent) => boolean;
@@ -50,6 +51,7 @@ export type CommandBarContentElement = HTMLElement & {
50
51
  __neverUse: 'CommandBarContentElement';
51
52
  };
52
53
  export interface CommandBarOptions {
54
+ rootId?: string;
53
55
  id?: string;
54
56
  parentItem?: CommandItem;
55
57
  itemElementTag?: keyof HTMLElementTagNameMap;
@@ -62,15 +64,22 @@ export interface CommandBarOptions {
62
64
  disableSelectedScroll?: boolean;
63
65
  refuseOverflow?: boolean;
64
66
  overflowBoundary?: Element;
67
+ overflowBoundaryPadding?: number;
65
68
  header?: HTMLElement | (() => HTMLElement | null);
66
69
  footer?: HTMLElement | (() => HTMLElement | null);
67
70
  padding?: number;
68
71
  beforeClose?: (event?: MouseEvent | TouchEvent) => boolean;
69
72
  showName?: boolean;
70
73
  maxWidth?: number | string;
74
+ appendTo?: Element;
71
75
  }
72
76
  export type CreateManualCommandBarFunction = (parentItem: CommandItem, closeable: Closeable, options?: CommandBarOptions) => AbstractManualCommandBar;
73
77
  export type PopoverOptions = {
74
78
  overflowBoundary?: Element;
79
+ overflowBoundaryPadding?: number;
80
+ appendTo?: Element;
81
+ };
82
+ export type ObjectToolbarOptions = {
83
+ appendTo?: Element;
75
84
  };
76
85
  export type SelectItemFrom = 'event' | 'manual';
@@ -127,4 +127,7 @@ import ShiftTabIcon from './shift-tab.svg?raw';
127
127
  import TableEditIcon from './table-edit.svg?raw';
128
128
  import AdjustWidthIcon from './adjust-width.svg?raw';
129
129
  import TocIcon from './toc.svg?raw';
130
- export { TableEditIcon, TabIcon, ShiftTabIcon, DownloadIcon, AddEmojiIcon, BallIcon, CardIcon, FoodIcon, LightIcon, SmileIcon, SymbolIcon, TreeIcon, TimeIcon, ClearIcon, CloseIcon, PrevIcon, NextIcon, MoreIcon, TextColorIcon, AddIcon, ArrowDownIcon, ArrowUpIcon, ArrowLeftIcon, ArrowRightIcon, DeleteRowIcon, DeleteColIcon, MergeCellIcon, SplitCellIcon, DeleteTableIcon, Heading1Icon, Heading2Icon, Heading3Icon, Heading4Icon, Heading5Icon, Heading6Icon, Heading7Icon, Heading8Icon, HeadingNIcon, OrderedListIcon, UnorderedListIcon, CheckListIcon, BlockquoteIcon, AlignCenterIcon, AlignLeftIcon, AlignRightIcon, ImageIcon, ImageMenuIcon, ImageErrorIcon, ImageEmptyIcon, LinkIcon, LinkOffIcon, WarningIcon, PasteSpecialIcon, LaunchIcon, CodeIcon, LayoutIcon, AudioIcon, GraphIcon, VideoIcon, FileIcon, MathIcon, MathMenuIcon, TableIcon, TableMenuIcon, BilibiliIcon, YoukuIcon, ModaoIcon, FigmaIcon, EditIcon, CommentIcon, RefreshIcon, HelpIcon, CheckMarkIcon, CircleCheckMarkIcon, TextIcon, RightArrowIcon, TencentVideoIcon, WebPageIcon, UmlIcon, DividingLineIcon, HeadingH1Icon, HeadingH2Icon, HeadingH3Icon, HeadingH4Icon, HeadingH5Icon, HeadingH6Icon, HeadingH7Icon, HeadingH8Icon, CheckboxIcon, QuoteIcon, LinkHrefIcon, OrderedIcon, UnorderedIcon, CopyIcon, CutIcon, DeleteIcon, LockBlockIcon, UnLockBlockIcon, InsertBeforeIcon, InsertAfterIcon, MentionIcon, CircleAddIcon, LoadingIcon, DragIcon, UmlBrandIcon, OnesLoadingIcon, BoldIcon, ItalicIcon, UnderlineIcon, LineThroughIcon, SubscriptIcon, SuperscriptIcon, InlineCodeIcon, ToMindMapIcon, FitIcon, FullScreenIcon, ExitFullScreenIcon, CaretDownIcon, StatusIcon, AlertEmojiIcon, ForbiddenIcon, WarningFilledIcon, InformationFilledIcon, SearchIcon, CalloutIcon, LoadingCircleIcon, TextGroupIcon, AdjustWidthIcon, TocIcon, };
130
+ import AttachmentIcon from './attachment.svg?raw';
131
+ import Mention2Icon from './mention.svg?raw';
132
+ import CircleCloseIcon from './circle-close.svg?raw';
133
+ export { TableEditIcon, TabIcon, ShiftTabIcon, DownloadIcon, AddEmojiIcon, BallIcon, CardIcon, FoodIcon, LightIcon, SmileIcon, SymbolIcon, TreeIcon, TimeIcon, ClearIcon, CloseIcon, PrevIcon, NextIcon, MoreIcon, TextColorIcon, AddIcon, ArrowDownIcon, ArrowUpIcon, ArrowLeftIcon, ArrowRightIcon, DeleteRowIcon, DeleteColIcon, MergeCellIcon, SplitCellIcon, DeleteTableIcon, Heading1Icon, Heading2Icon, Heading3Icon, Heading4Icon, Heading5Icon, Heading6Icon, Heading7Icon, Heading8Icon, HeadingNIcon, OrderedListIcon, UnorderedListIcon, CheckListIcon, BlockquoteIcon, AlignCenterIcon, AlignLeftIcon, AlignRightIcon, ImageIcon, ImageMenuIcon, ImageErrorIcon, ImageEmptyIcon, LinkIcon, LinkOffIcon, WarningIcon, PasteSpecialIcon, LaunchIcon, CodeIcon, LayoutIcon, AudioIcon, GraphIcon, VideoIcon, FileIcon, MathIcon, MathMenuIcon, TableIcon, TableMenuIcon, BilibiliIcon, YoukuIcon, ModaoIcon, FigmaIcon, EditIcon, CommentIcon, RefreshIcon, HelpIcon, CheckMarkIcon, CircleCheckMarkIcon, TextIcon, RightArrowIcon, TencentVideoIcon, WebPageIcon, UmlIcon, DividingLineIcon, HeadingH1Icon, HeadingH2Icon, HeadingH3Icon, HeadingH4Icon, HeadingH5Icon, HeadingH6Icon, HeadingH7Icon, HeadingH8Icon, CheckboxIcon, QuoteIcon, LinkHrefIcon, OrderedIcon, UnorderedIcon, CopyIcon, CutIcon, DeleteIcon, LockBlockIcon, UnLockBlockIcon, InsertBeforeIcon, InsertAfterIcon, MentionIcon, CircleAddIcon, LoadingIcon, DragIcon, UmlBrandIcon, OnesLoadingIcon, BoldIcon, ItalicIcon, UnderlineIcon, LineThroughIcon, SubscriptIcon, SuperscriptIcon, InlineCodeIcon, ToMindMapIcon, FitIcon, FullScreenIcon, ExitFullScreenIcon, CaretDownIcon, StatusIcon, AlertEmojiIcon, ForbiddenIcon, WarningFilledIcon, InformationFilledIcon, SearchIcon, CalloutIcon, LoadingCircleIcon, TextGroupIcon, AdjustWidthIcon, TocIcon, AttachmentIcon, Mention2Icon, CircleCloseIcon, };
@@ -3,10 +3,12 @@ import { HistoryUser } from '../types';
3
3
  export default class HistoryDoc extends EventCallbacks<OnesEditorDocCallbacks> implements OnesEditorDoc {
4
4
  private server;
5
5
  private docObject;
6
- constructor(server: OnesEditorDocServer, docObject: DocObject);
6
+ private editorOptions?;
7
+ constructor(server: OnesEditorDocServer, docObject: DocObject, editorOptions?: unknown);
7
8
  beginBatchUpdate(): number;
8
9
  endBatchUpdate(): number;
9
10
  toJSON(): DocObject;
11
+ applyingOps(): boolean;
10
12
  getContainerBlocks(containerId: string): DocBlock[];
11
13
  findContainerBlocks(containerId: string): DocBlock[];
12
14
  getBlockData(containerId: string, blockIndex: number): DocBlock;
@@ -2,6 +2,7 @@ import { OnesEditor, OnesEditorCustom, OnesEditorDocServer } from '../../../../@
2
2
  import type { OnesEditorVersionsProvider, VersionDialogOptions } from '../types';
3
3
  export declare class OnesEditorVersionsDialog implements OnesEditorCustom {
4
4
  private server;
5
+ private editorOptions?;
5
6
  private dialog;
6
7
  private oldViewer;
7
8
  private versionOptions?;
@@ -11,7 +12,7 @@ export declare class OnesEditorVersionsDialog implements OnesEditorCustom {
11
12
  private components;
12
13
  get versionHelper(): import("@ones-editor/core").OnesEditorDocVersionHelper;
13
14
  get editor(): OnesEditor | null;
14
- constructor(server: OnesEditorDocServer, provider: OnesEditorVersionsProvider);
15
+ constructor(server: OnesEditorDocServer, provider: OnesEditorVersionsProvider, editorOptions?: unknown);
15
16
  private handleRevert;
16
17
  private handleSelectVersion;
17
18
  private handleCompareWithVersion;
package/dist/index.d.ts CHANGED
@@ -42,10 +42,11 @@ export { resetListStart, getListAllNextBrothers, toMindmap, Mindmap } from '../@
42
42
  export * from '../@ones-editor/exclusive-block';
43
43
  export * from '../@ones-editor/templates';
44
44
  export * from 'tiny-typed-emitter';
45
- export { ShareDBDocVersionsProvider, OnesEditorIcons, isLayoutBlock, LayoutQuickMenuItemFilter, CalloutQuickMenuItemFilter, MobileCommandHandler, PasteSpecialHandler };
45
+ export { ShareDBDocVersionsProvider, OnesEditorIcons, isLayoutBlock, LayoutQuickMenuItemFilter, CalloutQuickMenuItemFilter, MobileCommandHandler, PasteSpecialHandler, };
46
46
  export type { FileBoxData, FileEmbedData } from '../@ones-editor/file';
47
47
  export * from './helper';
48
48
  export { OnesEditorComments, OnesEditorCommentsRender } from '../@ones-editor/comments';
49
+ export * from '../@ones-editor/cke-html';
49
50
  export { type DocListBlock } from '../@ones-editor/list-block';
50
51
  export declare function getDefaultOnesEditorOptions(options: CreateOnesEditorOptions): {
51
52
  id: string | undefined;
@@ -53,6 +54,7 @@ export declare function getDefaultOnesEditorOptions(options: CreateOnesEditorOpt
53
54
  enableComments: boolean | undefined;
54
55
  enableResolveComments: boolean | undefined;
55
56
  enableContextMenu: boolean | undefined;
57
+ dateTimeFormatter: ((v: Date, source?: string | undefined) => string) | undefined;
56
58
  components: {
57
59
  blocks: import("@ones-editor/core").Block[];
58
60
  embeds: import("@ones-editor/core").Embed[];
@@ -103,5 +105,6 @@ export interface ShowDocVersionsOptions2 {
103
105
  userId: string;
104
106
  displayName: string;
105
107
  options?: VersionDialogOptions;
108
+ editorOptions?: CreateOnesEditorOptions;
106
109
  }
107
110
  export declare function showDocVersions2(parent: HTMLElement, options: ShowDocVersionsOptions2): Promise<OnesEditorVersionsDialog>;