fix(types): fix circular deps (#1099)

Author: makhnatkin

packages/editor/scripts/check-circular-deps.js

@@ -1,4 +1,4 @@
-/* eslint-disable no-console, import/no-extraneous-dependencies, no-undef */
+/* eslint-disable no-console, no-undef */
 const process = require('process');
 
 const {parseDependencyTree, parseCircular, prettyCircular} = require('dpdm');
@@ -9,9 +9,7 @@ if (isNaN(threshold)) {
     process.exit(1);
 }
 
-parseDependencyTree('./src/index.ts', {
-    transform: true,
-}).then((tree) => {
+parseDependencyTree('./src/index.ts', {}).then((tree) => {
     const circulars = parseCircular(tree);
     if (circulars.length > threshold) {
         console.error(prettyCircular(circulars));

packages/editor/src/bundle/Editor.ts

@@ -26,6 +26,8 @@ import type {DirectiveSyntaxContext} from '../utils/directive';
 
 import {MarkupManager} from './MarkupManager';
 import {createDynamicModifiers} from './config/dynamicModifiers';
+import type {ChangeEditorModeOptions, MarkdownEditorInstance} from './editor-public-types';
+import type {EventMap, ToolbarActionData} from './events';
 import type {
     MarkdownEditorMode as EditorMode,
     MarkdownEditorPreset as EditorPreset,
@@ -37,23 +39,7 @@ import type {
     MarkdownEditorSplitMode as SplitMode,
 } from './types';
 
-export type ToolbarActionData = {
-    editorMode: EditorMode;
-    id: string;
-    attrs?: {[key: string]: any};
-};
-
-export interface EventMap {
-    change: null;
-    cancel: null;
-    submit: null;
-
-    'toolbar-action': ToolbarActionData;
-
-    'change-editor-mode': {mode: EditorMode};
-    'change-toolbar-visibility': {visible: boolean};
-    'change-split-mode-enabled': {splitModeEnabled: boolean};
-}
+export type {ToolbarActionData, EventMap, ChangeEditorModeOptions};
 
 // internal events
 interface EventMapInt extends EventMap {
@@ -62,18 +48,7 @@ interface EventMapInt extends EventMap {
     'cm-scroll': {event: Event};
 }
 
-export interface Editor extends Receiver<EventMap>, CommonEditor {
-    readonly logger: Logger2.LogReceiver;
-    readonly currentMode: EditorMode;
-    readonly toolbarVisible: boolean;
-
-    setEditorMode(mode: EditorMode, opts?: SetEditorModeOptions): void;
-
-    moveCursor(position: 'start' | 'end' | {line: number}): void;
-
-    /** @internal used in demo for dev-tools */
-    readonly _wysiwygView?: PMEditorView;
-}
+export type Editor = MarkdownEditorInstance;
 
 /** @internal */
 export interface EditorInt
@@ -117,12 +92,6 @@ export interface EditorInt
 
 type SetEditorModeOptions = Pick<ChangeEditorModeOptions, 'emit'>;
 
-export type ChangeEditorModeOptions = {
-    mode: EditorMode;
-    reason: 'error-boundary' | 'settings' | 'manually';
-    emit?: boolean;
-};
-
 export type EditorOptions = Pick<
     MarkdownEditorOptions,
     'md' | 'initial' | 'handlers' | 'experimental' | 'markupConfig' | 'wysiwygConfig' | 'mobile'

packages/editor/src/bundle/MarkdownEditorView.tsx

@@ -28,7 +28,7 @@ import {useMarkdownEditorContext} from './context';
 import {cnEditorComponent} from './editor-classname';
 import {EditorSettings, type EditorSettingsProps, type SettingItems} from './settings';
 import {stickyCn} from './sticky';
-import type {MToolbarData, MToolbarItemData, WToolbarData, WToolbarItemData} from './toolbar/types';
+import type {ToolbarConfigs} from './toolbar/types';
 import {getToolbarsConfigs} from './toolbar/utils/toolbarsConfigs';
 import type {MarkdownEditorMode} from './types';
 
@@ -244,25 +244,6 @@ const EditorWrapper = forwardRef<HTMLDivElement, EditorWrapperProps>(
 
 EditorWrapper.displayName = 'EditorWrapper';
 
-type ToolbarConfigs = {
-    /**
-     * @deprecated use `toolbarsPreset` instead
-     */
-    markupToolbarConfig?: MToolbarData;
-    /**
-     * @deprecated use `toolbarsPreset` instead
-     */
-    wysiwygToolbarConfig?: WToolbarData;
-    /**
-     * @deprecated use `toolbarsPreset` instead
-     */
-    markupHiddenActionsConfig?: MToolbarItemData[];
-    /**
-     * @deprecated use `toolbarsPreset` instead
-     */
-    wysiwygHiddenActionsConfig?: WToolbarItemData[];
-};
-
 type ViewProps = {
     editor?: Editor;
     autofocus?: boolean;

packages/editor/src/bundle/config/dynamicModifiers.test.ts

@@ -1,7 +1,7 @@
 import {ExtensionsManager} from '../../core';
 import {SchemaDynamicModifier} from '../../core/SchemaDynamicModifier';
 import {MarkdownParserDynamicModifier} from '../../core/markdown/MarkdownParser';
-import {MarkdownSerializerDynamicModifier} from '../../core/markdown/MarkdownSerializerDynamicModifier';
+import {MarkdownSerializerDynamicModifier} from '../../core/markdown/MarkdownSerializer';
 import {convertDynamicModifiersConfigs} from '../../core/utils/dynamicModifiers';
 import {Logger2} from '../../logger';
 import {FullSpecsPreset} from '../../presets/full-specs';

packages/editor/src/bundle/config/wysiwyg.ts

@@ -11,6 +11,7 @@ import type {
 import {i18n as i18nHint} from '../../i18n/hints';
 import {i18n} from '../../i18n/menubar';
 import {Action as A, formatter as f} from '../../shortcuts';
+import type {MarkdownEditorPreset} from '../preset-base-types';
 import {ToolbarDataType} from '../toolbar/types';
 import type {
     WToolbarData,
@@ -26,7 +27,6 @@ import {
     WToolbarTextSelect,
     type WToolbarTextSelectProps,
 } from '../toolbar/wysiwyg/WToolbarTextSelect';
-import type {MarkdownEditorPreset} from '../types';
 
 import {ActionName} from './action-names';
 import {icons} from './icons';

packages/editor/src/bundle/editor-public-types.ts

@@ -0,0 +1,24 @@
+import type {EditorView as PMEditorView} from 'prosemirror-view';
+
+import type {CommonEditor} from '../common';
+import type {Logger2} from '../logger';
+import type {Receiver} from '../utils';
+
+import type {EventMap} from './events';
+import type {MarkdownEditorMode} from './preset-base-types';
+
+export type ChangeEditorModeOptions = {
+    mode: MarkdownEditorMode;
+    reason: 'error-boundary' | 'settings' | 'manually';
+    emit?: boolean;
+};
+
+export interface MarkdownEditorInstance extends Receiver<EventMap>, CommonEditor {
+    readonly logger: Logger2.LogReceiver;
+    readonly currentMode: MarkdownEditorMode;
+    readonly toolbarVisible: boolean;
+    setEditorMode(mode: MarkdownEditorMode, opts?: Pick<ChangeEditorModeOptions, 'emit'>): void;
+    moveCursor(position: 'start' | 'end' | {line: number}): void;
+    /** @internal used in demo for dev-tools */
+    readonly _wysiwygView?: PMEditorView;
+}

packages/editor/src/bundle/events.ts

@@ -0,0 +1,19 @@
+import type {MarkdownEditorMode} from './preset-base-types';
+
+export type ToolbarActionData = {
+    editorMode: MarkdownEditorMode;
+    id: string;
+    attrs?: {[key: string]: any};
+};
+
+export interface EventMap {
+    change: null;
+    cancel: null;
+    submit: null;
+
+    'toolbar-action': ToolbarActionData;
+
+    'change-editor-mode': {mode: MarkdownEditorMode};
+    'change-toolbar-visibility': {visible: boolean};
+    'change-split-mode-enabled': {splitModeEnabled: boolean};
+}

packages/editor/src/bundle/preset-base-types.ts

@@ -0,0 +1,16 @@
+export type MarkdownEditorMode = 'wysiwyg' | 'markup';
+export type MarkdownEditorPreset = 'zero' | 'commonmark' | 'default' | 'yfm' | 'full';
+export type MarkdownEditorSplitMode = false | 'horizontal' | 'vertical';
+
+export type WysiwygPlaceholderOptions = {
+    value?: string | (() => string);
+    /**
+     * Default – empty-doc.
+     *
+     * Values:
+     * - 'empty-doc' – The placeholder will only be shown when the document is completely empty;
+     * - 'empty-row-top-level' – The placeholder will be displayed in an empty line that is at the top level of the document structure;
+     * - 'empty-row' – The placeholder will be shown in any empty line within the document, regardless of its nesting level.
+     */
+    behavior?: 'empty-doc' | 'empty-row-top-level' | 'empty-row';
+};

packages/editor/src/bundle/toolbar/types.ts

@@ -1,5 +1,5 @@
 import type {ActionStorage} from '../../core';
-import type {CodeEditor} from '../../markup';
+import type {CodeEditor} from '../../markup/editor';
 import type {ToolbarListButtonData} from '../../toolbar';
 import type {
     ToolbarBaseProps,
@@ -35,3 +35,14 @@ export type MToolbarReactComponentData = ToolbarReactComponentData<CodeEditor>;
 export type MToolbarListButtonData = ToolbarListButtonData<CodeEditor>;
 export type MToolbarListItemData = ToolbarListItemData<CodeEditor>;
 export type MToolbarButtonPopupData = ToolbarButtonPopupData<CodeEditor>;
+
+export type ToolbarConfigs = {
+    /** @deprecated use `toolbarsPreset` instead */
+    markupToolbarConfig?: MToolbarData;
+    /** @deprecated use `toolbarsPreset` instead */
+    wysiwygToolbarConfig?: WToolbarData;
+    /** @deprecated use `toolbarsPreset` instead */
+    markupHiddenActionsConfig?: MToolbarItemData[];
+    /** @deprecated use `toolbarsPreset` instead */
+    wysiwygHiddenActionsConfig?: WToolbarItemData[];
+};

packages/editor/src/bundle/toolbar/utils/toolbarsConfigs.ts

@@ -6,10 +6,9 @@ import type {
     ToolbarItemWysiwyg,
     ToolbarsPreset,
 } from '../../../modules/toolbars/types';
-import type {MarkdownEditorViewProps} from '../../MarkdownEditorView';
 import type {MarkdownEditorPreset} from '../../types';
 import {ToolbarDataType} from '../types';
-import type {MToolbarData, ToolbarIconData, WToolbarData} from '../types';
+import type {MToolbarData, ToolbarConfigs, ToolbarIconData, WToolbarData} from '../types';
 
 import {flattenPreset} from './flattenPreset';
 
@@ -97,13 +96,7 @@ export const createToolbarConfig = <T extends WToolbarData | MToolbarData>(
 
 interface GetToolbarsConfigsArgs {
     toolbarsPreset?: ToolbarsPreset;
-    props: Pick<
-        MarkdownEditorViewProps,
-        | 'markupToolbarConfig'
-        | 'wysiwygToolbarConfig'
-        | 'wysiwygHiddenActionsConfig'
-        | 'markupHiddenActionsConfig'
-    >;
+    props: ToolbarConfigs;
     preset: MarkdownEditorPreset;
 }
 export const getToolbarsConfigs = ({toolbarsPreset, props, preset}: GetToolbarsConfigsArgs) => {