@skbkontur/markdown 2.7.0-alpha.6 → 2.7.0

package/index.d.ts

@@ -2,6 +2,6 @@ export { Markdown, MarkdownProps } from './src/Markdown/Markdown';
 export { MarkdownCombination } from './src/MarkdownCombination/MarkdownCombination';
 export { markdownHelpItems, markdownHelpFiles, markdownHelpLists, markdownHelpOther, } from './src/Markdown/MarkdownHelpItems';
 export { MarkdownViewer } from './src/MarkdownViewer/MarkdownViewer';
-export { MarkdownApi, RefItem, User, Token, HorizontalPaddings, ViewMode, ActionsOptions, AIMethod, AIApi, TrackEventCategory, } from '././src/Markdown/types';
+export { MarkdownApi, RefItem, User, Token, HorizontalPaddings, ViewMode, ActionsOptions, ActionsOptionsKeys, AIMethod, AIApi, } from '././src/Markdown/types';
 export { ThemeMode, ColorScheme } from './src/styles/types';
 export { MarkdownTheme, MarkdownThemeProvider, MarkdownThemeConsumer, MarkdownThemeContext } from './src/styles/theme';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skbkontur/markdown",
-  "version": "2.7.0-alpha.6",
+  "version": "2.7.0",
   "packageManager": "yarn@4.13.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",

package/src/Markdown/Markdown.d.ts

@@ -1,6 +1,6 @@
 import { FC, ReactNode } from 'react';
 import { MarkdownEditorProps } from './MarkdownEditor';
-import { ActionsOptions, TrackEventCategory, HorizontalPaddings, MarkdownApi, ViewMode } from './types';
+import { ActionsOptions, ActionsOptionsKeys, HorizontalPaddings, MarkdownApi, ViewMode } from './types';
 export interface MarkdownProps extends MarkdownEditorProps {
     /** Методы апи для загрузки/скачивания файлов, меншена, ИИ */
     api?: MarkdownApi;
@@ -15,7 +15,7 @@ export interface MarkdownProps extends MarkdownEditorProps {
     /** Колбек, срабатывает на изменение режима редактирования или просмотра */
     onChangeViewMode?: (mode: ViewMode) => void;
     /** Колбек для отправки метрик */
-    onTrackEvent?: (category: TrackEventCategory, action: 'click' | 'hotkey', label?: string) => void;
+    onTrackEvent?: (category: ActionsOptionsKeys, action: 'click' | 'hotkey', label?: string) => void;
     /** Padding markdownActions (кнопки помощи форматирования текста), включает режим panel */
     panelHorizontalPadding?: number;
     /** Url для профиля сотрудника  */

package/src/Markdown/MarkdownActions/MarkdownActions.d.ts

@@ -1,7 +1,7 @@
 import { Textarea } from '@skbkontur/react-ui';
 import { FC, RefObject } from 'react';
 import { EmojiData } from '../Emoji/Emoji.logic';
-import { AIApi, ActionsOptions, TrackEventCategory, HorizontalPaddings, Nullable, ViewMode } from '../types';
+import { AIApi, ActionsOptions, ActionsOptionsKeys, HorizontalPaddings, Nullable, ViewMode } from '../types';
 interface Props {
     horizontalPaddings: HorizontalPaddings;
     onChangeViewMode: (viewMode: ViewMode) => void;
@@ -20,7 +20,7 @@ interface Props {
     isFocused?: boolean;
     isSplitViewAvailable?: boolean;
     loadingFile?: boolean;
-    onTrackEvent?: (category: TrackEventCategory, action: 'click' | 'hotkey', label?: string) => void;
+    onTrackEvent?: (category: ActionsOptionsKeys, action: 'click' | 'hotkey', label?: string) => void;
     selectionEnd?: Nullable<number>;
     selectionStart?: Nullable<number>;
     width?: Nullable<number | string>;

package/src/Markdown/MarkdownActions/MarkdownActions.js

@@ -17,7 +17,7 @@ import { MarkdownFormatButton } from '../MarkdownHelpers/MarkdownFormatButton';
 import { setMarkdown } from '../MarkdownHelpers/markdownHelpers';
 import { markdownHelpHeaders, markdownHelpLists, markdownHelpOther, markdownHelpText } from '../MarkdownHelpItems';
 import { MarkdownTids } from '../MarkdownTids';
-import { ViewMode } from '../types';
+import { ViewMode, MarkdownOtherActions, } from '../types';
 export const MarkdownActions = ({ textAreaRef, selectionStart, selectionEnd, loadingFile, onOpenFileDialog, onClickFullscreen, fullscreen, viewMode, onChangeViewMode, horizontalPaddings, hasFilesApi, width, showActionHints, showShortKeys, hideOptions, onTrackEvent, onSelectEmoji, isSplitViewAvailable, disableFullscreen, AIApi, }) => {
     const isPreviewMode = viewMode === ViewMode.Preview;
     return (React.createElement(MarkdownActionsWrapper, { ...horizontalPaddings, width: width, fullscreen: fullscreen },
@@ -44,13 +44,13 @@ export const MarkdownActions = ({ textAreaRef, selectionStart, selectionEnd, loa
                         handleTrackClick(MarkdownFormat.file);
                         onOpenFileDialog();
                     } })),
-                !hideOptions?.emoji && (React.createElement(EmojiDropdown, { showActionHint: showActionHints, showShortKey: showShortKeys, isPreviewMode: isPreviewMode, onTrackEvent: () => handleTrackClick('emoji'), onSelect: onSelectEmoji })),
-                !hideOptions?.AI && !!AIApi && (React.createElement(AIActionsDropdown, { showActionHint: showActionHints, textareaRef: textAreaRef, isPreviewMode: isPreviewMode, api: AIApi, onTrackEvent: label => handleTrackClick('AI', label) }))),
+                !hideOptions?.emoji && (React.createElement(EmojiDropdown, { showActionHint: showActionHints, showShortKey: showShortKeys, isPreviewMode: isPreviewMode, onTrackEvent: () => handleTrackClick(MarkdownOtherActions.Emoji), onSelect: onSelectEmoji })),
+                !hideOptions?.AI && !!AIApi && (React.createElement(AIActionsDropdown, { showActionHint: showActionHints, textareaRef: textAreaRef, isPreviewMode: isPreviewMode, api: AIApi, onTrackEvent: label => handleTrackClick(MarkdownOtherActions.AI, label) }))),
             React.createElement(ActionsRightWrapper, null,
-                !hideOptions?.help && (React.createElement(MarkdownFormatButton, { showActionHint: showActionHints, dataTid: MarkdownTids.Help, hintText: "\u0414\u043E\u043A\u0443\u043C\u0435\u043D\u0442\u0430\u0446\u0438\u044F Markdown", icon: React.createElement(DocIcon, null), text: "\u0414\u043E\u043A\u0443\u043C\u0435\u043D\u0442\u0430\u0446\u0438\u044F Markdown", href: COMMONMARK_HELP_URL, onClick: () => handleTrackClick('help') })),
+                !hideOptions?.help && (React.createElement(MarkdownFormatButton, { showActionHint: showActionHints, dataTid: MarkdownTids.Help, hintText: "\u0414\u043E\u043A\u0443\u043C\u0435\u043D\u0442\u0430\u0446\u0438\u044F Markdown", icon: React.createElement(DocIcon, null), text: "\u0414\u043E\u043A\u0443\u043C\u0435\u043D\u0442\u0430\u0446\u0438\u044F Markdown", href: COMMONMARK_HELP_URL, onClick: () => handleTrackClick(MarkdownOtherActions.Help) })),
                 !hideOptions?.viewMode && renderViewModeButton(),
                 !hideOptions?.screenMode && !disableFullscreen && (React.createElement(MarkdownFormatButton, { showActionHint: showActionHints, dataTid: MarkdownTids.FullscreenToggle, hintText: fullscreen ? 'Свернуть' : 'Развернуть', icon: fullscreen ? React.createElement(Collapse, null) : React.createElement(Expand, null), text: fullscreen ? 'Свернуть' : '  Развернуть', onClick: () => {
-                        handleTrackClick('screenMode');
+                        handleTrackClick(MarkdownOtherActions.ScreenMode);
                         onClickFullscreen();
                     } }))))));
     function renderViewModeButton() {
@@ -77,7 +77,7 @@ export const MarkdownActions = ({ textAreaRef, selectionStart, selectionEnd, loa
         return hideOptions?.[format];
     }
     function handleChangeViewMode(mode) {
-        handleTrackClick('viewMode', mode);
+        handleTrackClick(MarkdownOtherActions.ViewMode, mode);
         onChangeViewMode(mode);
     }
     function handleTrackClick(category, label) {

package/src/Markdown/MarkdownEditor.d.ts

@@ -1,12 +1,12 @@
 import { Textarea, TextareaProps } from '@skbkontur/react-ui';
 import { ValidationInfo, RenderErrorMessage } from '@skbkontur/react-ui-validations';
 import { FC, RefObject } from 'react';
-import { TrackEventCategory, Nullable } from './types';
+import { ActionsOptionsKeys, Nullable } from './types';
 export interface MarkdownEditorProps extends Omit<TextareaProps, 'rows' | 'maxRows' | 'disableAnimations' | 'extraRow'> {
     disableAnimations?: boolean;
     extraRow?: boolean;
     maxRows?: number;
-    onTrackEvent?: (category: TrackEventCategory, action: 'click' | 'hotkey', label?: string) => void;
+    onTrackEvent?: (category: ActionsOptionsKeys, action: 'click' | 'hotkey', label?: string) => void;
     /** Рендер сообщения валидации react-ui-validations */
     renderMessage?: Nullable<RenderErrorMessage>;
     rows?: number;

package/src/Markdown/MarkdownHelpers/markdownHelpers.d.ts

@@ -1,11 +1,11 @@
 import { Textarea } from '@skbkontur/react-ui';
 import { KeyboardEvent as ReactKeyboardEvent, RefObject } from 'react';
 import { MarkdownFormat } from '../MarkdownFormat';
-import { TrackEventCategory, Nullable, RefItem } from '../types';
+import { ActionsOptionsKeys, Nullable, RefItem } from '../types';
 export { handleMarkdownListEnter } from './markdownListEnterHelpers';
 export declare function setMarkdown(textareaNode: HTMLTextAreaElement, text: string, format: MarkdownFormat, selectionStart: number, selectionEnd?: number | null): void;
 export declare function setMarkdownFiles(file: RefItem, textarea: Textarea, format: MarkdownFormat, cursorPosition?: number | null, fileApiUrl?: string): void;
 export declare function setMarkdownPastedHtml(text: string, textareaNode: HTMLTextAreaElement): void;
 export declare function setTextareaCursor(format: MarkdownFormat, prevCommentPartLength: number, nextCommentPartLength: number, textareaNode: HTMLTextAreaElement, selectionEnd: number): void;
-export declare function createMarkdownHelpKeyDownHandler(text: string, ref?: RefObject<Textarea> | null, callback?: (event: ReactKeyboardEvent<HTMLTextAreaElement>) => void, onTrackHotkey?: (category: TrackEventCategory, label?: string) => void): (event: ReactKeyboardEvent<HTMLTextAreaElement>) => void;
+export declare function createMarkdownHelpKeyDownHandler(text: string, ref?: RefObject<Textarea> | null, callback?: (event: ReactKeyboardEvent<HTMLTextAreaElement>) => void, onTrackHotkey?: (category: ActionsOptionsKeys, label?: string) => void): (event: ReactKeyboardEvent<HTMLTextAreaElement>) => void;
 export declare const usePasteFromClipboard: (textarea: Nullable<Textarea>, uploadFileApi?: ((file: File) => Promise<RefItem>) | undefined, downloadFileApi?: ((id: string) => Promise<File>) | undefined, fileApiUrl?: string) => void;

package/src/Markdown/MarkdownHelpers/markdownHelpers.js

@@ -77,7 +77,7 @@ export function createMarkdownHelpKeyDownHandler(text, ref, callback, onTrackHot
                 onTrackHotkey?.(format);
             }
         }
-        handleMarkdownListEnter(event, textareaNode, label => onTrackHotkey?.('continueList', label));
+        handleMarkdownListEnter(event, textareaNode, format => onTrackHotkey?.(format, 'continueList'));
         callback?.(event);
     };
 }

package/src/Markdown/MarkdownHelpers/markdownListEnterHelpers.d.ts

@@ -1,3 +1,3 @@
 import { KeyboardEvent as ReactKeyboardEvent } from 'react';
 import { MarkdownFormat } from '../MarkdownFormat';
-export declare function handleMarkdownListEnter(event: ReactKeyboardEvent<HTMLTextAreaElement>, textareaNode: HTMLTextAreaElement, onTrackEvent?: (label: MarkdownFormat) => void): boolean | void;
+export declare function handleMarkdownListEnter(event: ReactKeyboardEvent<HTMLTextAreaElement>, textareaNode: HTMLTextAreaElement, onTrackEvent?: (format: MarkdownFormat) => void): boolean | void;

package/src/Markdown/types.d.ts

@@ -5,6 +5,15 @@ export declare enum ViewMode {
     Edit = "Edit",
     Split = "Split"
 }
+export declare enum MarkdownOtherActions {
+    Heading = "heading",
+    Emoji = "emoji",
+    ViewMode = "viewMode",
+    ScreenMode = "screenMode",
+    Help = "help",
+    AllActions = "allActions",
+    AI = "AI"
+}
 export interface Token {
     positions: number[];
     value: string;
@@ -51,5 +60,5 @@ export interface TestCase<V, E> {
     values: V;
 }
 export type ReactUIThemeType = Partial<typeof THEME_2022>;
-export type ActionsOptions = Partial<Record<MarkdownFormat | 'heading' | 'emoji' | 'viewMode' | 'screenMode' | 'help' | 'allActions' | 'AI', boolean>>;
-export type TrackEventCategory = keyof ActionsOptions | 'continueList';
+export type ActionsOptions = Partial<Record<MarkdownFormat | MarkdownOtherActions, boolean>>;
+export type ActionsOptionsKeys = keyof ActionsOptions;

package/src/Markdown/types.js

@@ -4,3 +4,13 @@ export var ViewMode;
     ViewMode["Edit"] = "Edit";
     ViewMode["Split"] = "Split";
 })(ViewMode || (ViewMode = {}));
+export var MarkdownOtherActions;
+(function (MarkdownOtherActions) {
+    MarkdownOtherActions["Heading"] = "heading";
+    MarkdownOtherActions["Emoji"] = "emoji";
+    MarkdownOtherActions["ViewMode"] = "viewMode";
+    MarkdownOtherActions["ScreenMode"] = "screenMode";
+    MarkdownOtherActions["Help"] = "help";
+    MarkdownOtherActions["AllActions"] = "allActions";
+    MarkdownOtherActions["AI"] = "AI";
+})(MarkdownOtherActions || (MarkdownOtherActions = {}));