mirror of
https://github.com/BookStackApp/BookStack.git
synced 2025-08-07 23:03:00 +03:00
MD Editor: Starting conversion to typescript
This commit is contained in:
Dan Brown
554
resources/js/markdown/actions.ts
Normal file
554
resources/js/markdown/actions.ts
Normal file
@@ -0,0 +1,554 @@
|
||||
import * as DrawIO from '../services/drawio';
|
||||
import {MarkdownEditor} from "./index.mjs";
|
||||
import {EntitySelectorPopup, ImageManager} from "../components";
|
||||
import {ChangeSpec, SelectionRange, TransactionSpec} from "@codemirror/state";
|
||||
|
||||
interface ImageManagerImage {
|
||||
id: number;
|
||||
name: string;
|
||||
thumbs: { display: string; };
|
||||
url: string;
|
||||
}
|
||||
|
||||
export class Actions {
|
||||
|
||||
protected readonly editor: MarkdownEditor;
|
||||
protected lastContent: { html: string; markdown: string } = {
|
||||
html: '',
|
||||
markdown: '',
|
||||
};
|
||||
|
||||
constructor(editor: MarkdownEditor) {
|
||||
this.editor = editor;
|
||||
}
|
||||
|
||||
updateAndRender() {
|
||||
const content = this.#getText();
|
||||
this.editor.config.inputEl.value = content;
|
||||
|
||||
const html = this.editor.markdown.render(content);
|
||||
window.$events.emit('editor-html-change', '');
|
||||
window.$events.emit('editor-markdown-change', '');
|
||||
this.lastContent.html = html;
|
||||
this.lastContent.markdown = content;
|
||||
this.editor.display.patchWithHtml(html);
|
||||
}
|
||||
|
||||
getContent() {
|
||||
return this.lastContent;
|
||||
}
|
||||
|
||||
showImageInsert() {
|
||||
const imageManager = window.$components.first('image-manager') as ImageManager;
|
||||
|
||||
imageManager.show((image: ImageManagerImage) => {
|
||||
const imageUrl = image.thumbs?.display || image.url;
|
||||
const selectedText = this.#getSelectionText();
|
||||
const newText = `[](${image.url})`;
|
||||
this.#replaceSelection(newText, newText.length);
|
||||
}, 'gallery');
|
||||
}
|
||||
|
||||
insertImage() {
|
||||
const newText = ``;
|
||||
this.#replaceSelection(newText, newText.length - 1);
|
||||
}
|
||||
|
||||
insertLink() {
|
||||
const selectedText = this.#getSelectionText();
|
||||
const newText = `[${selectedText}]()`;
|
||||
const cursorPosDiff = (selectedText === '') ? -3 : -1;
|
||||
this.#replaceSelection(newText, newText.length + cursorPosDiff);
|
||||
}
|
||||
|
||||
showImageManager() {
|
||||
const selectionRange = this.#getSelectionRange();
|
||||
const imageManager = window.$components.first('image-manager') as ImageManager;
|
||||
imageManager.show((image: ImageManagerImage) => {
|
||||
this.#insertDrawing(image, selectionRange);
|
||||
}, 'drawio');
|
||||
}
|
||||
|
||||
// Show the popup link selector and insert a link when finished
|
||||
showLinkSelector() {
|
||||
const selectionRange = this.#getSelectionRange();
|
||||
|
||||
const selector = window.$components.first('entity-selector-popup') as EntitySelectorPopup;
|
||||
const selectionText = this.#getSelectionText(selectionRange);
|
||||
selector.show(entity => {
|
||||
const selectedText = selectionText || entity.name;
|
||||
const newText = `[${selectedText}](${entity.link})`;
|
||||
this.#replaceSelection(newText, newText.length, selectionRange);
|
||||
}, {
|
||||
initialValue: selectionText,
|
||||
searchEndpoint: '/search/entity-selector',
|
||||
entityTypes: 'page,book,chapter,bookshelf',
|
||||
entityPermission: 'view',
|
||||
});
|
||||
}
|
||||
|
||||
// Show draw.io if enabled and handle save.
|
||||
startDrawing() {
|
||||
const url = this.editor.config.drawioUrl;
|
||||
if (!url) return;
|
||||
|
||||
const selectionRange = this.#getSelectionRange();
|
||||
|
||||
DrawIO.show(url, () => Promise.resolve(''), async pngData => {
|
||||
const data = {
|
||||
image: pngData,
|
||||
uploaded_to: Number(this.editor.config.pageId),
|
||||
};
|
||||
|
||||
try {
|
||||
const resp = await window.$http.post('/images/drawio', data);
|
||||
this.#insertDrawing(resp.data as ImageManagerImage, selectionRange);
|
||||
DrawIO.close();
|
||||
} catch (err) {
|
||||
this.handleDrawingUploadError(err);
|
||||
throw new Error(`Failed to save image with error: ${err}`);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
#insertDrawing(image: ImageManagerImage, originalSelectionRange: SelectionRange) {
|
||||
const newText = `<div drawio-diagram="${image.id}"><img src="${image.url}"></div>`;
|
||||
this.#replaceSelection(newText, newText.length, originalSelectionRange);
|
||||
}
|
||||
|
||||
// Show draw.io if enabled and handle save.
|
||||
editDrawing(imgContainer: HTMLElement) {
|
||||
const {drawioUrl} = this.editor.config;
|
||||
if (!drawioUrl) {
|
||||
return;
|
||||
}
|
||||
|
||||
const selectionRange = this.#getSelectionRange();
|
||||
const drawingId = imgContainer.getAttribute('drawio-diagram') || '';
|
||||
if (!drawingId) {
|
||||
return;
|
||||
}
|
||||
|
||||
DrawIO.show(drawioUrl, () => DrawIO.load(drawingId), async pngData => {
|
||||
const data = {
|
||||
image: pngData,
|
||||
uploaded_to: Number(this.editor.config.pageId),
|
||||
};
|
||||
|
||||
try {
|
||||
const resp = await window.$http.post('/images/drawio', data);
|
||||
const image = resp.data as ImageManagerImage;
|
||||
const newText = `<div drawio-diagram="${image.id}"><img src="${image.url}"></div>`;
|
||||
const newContent = this.#getText().split('\n').map(line => {
|
||||
if (line.indexOf(`drawio-diagram="${drawingId}"`) !== -1) {
|
||||
return newText;
|
||||
}
|
||||
return line;
|
||||
}).join('\n');
|
||||
this.#setText(newContent, selectionRange);
|
||||
DrawIO.close();
|
||||
} catch (err) {
|
||||
this.handleDrawingUploadError(err);
|
||||
throw new Error(`Failed to save image with error: ${err}`);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
handleDrawingUploadError(error: any): void {
|
||||
if (error.status === 413) {
|
||||
window.$events.emit('error', this.editor.config.text.serverUploadLimit);
|
||||
} else {
|
||||
window.$events.emit('error', this.editor.config.text.imageUploadError);
|
||||
}
|
||||
console.error(error);
|
||||
}
|
||||
|
||||
// Make the editor full screen
|
||||
fullScreen() {
|
||||
const {container} = this.editor.config;
|
||||
const alreadyFullscreen = container.classList.contains('fullscreen');
|
||||
container.classList.toggle('fullscreen', !alreadyFullscreen);
|
||||
document.body.classList.toggle('markdown-fullscreen', !alreadyFullscreen);
|
||||
}
|
||||
|
||||
// Scroll to a specified text
|
||||
scrollToText(searchText: string): void {
|
||||
if (!searchText) {
|
||||
return;
|
||||
}
|
||||
|
||||
const text = this.editor.cm.state.doc;
|
||||
let lineCount = 1;
|
||||
let scrollToLine = -1;
|
||||
for (const line of text.iterLines()) {
|
||||
if (line.includes(searchText)) {
|
||||
scrollToLine = lineCount;
|
||||
break;
|
||||
}
|
||||
lineCount += 1;
|
||||
}
|
||||
|
||||
if (scrollToLine === -1) {
|
||||
return;
|
||||
}
|
||||
|
||||
const line = text.line(scrollToLine);
|
||||
this.#setSelection(line.from, line.to, true);
|
||||
this.focus();
|
||||
}
|
||||
|
||||
focus() {
|
||||
if (!this.editor.cm.hasFocus) {
|
||||
this.editor.cm.focus();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Insert content into the editor.
|
||||
*/
|
||||
insertContent(content: string) {
|
||||
this.#replaceSelection(content, content.length);
|
||||
}
|
||||
|
||||
/**
|
||||
* Prepend content to the editor.
|
||||
*/
|
||||
prependContent(content: string): void {
|
||||
content = this.#cleanTextForEditor(content);
|
||||
const selectionRange = this.#getSelectionRange();
|
||||
const selectFrom = selectionRange.from + content.length + 1;
|
||||
this.#dispatchChange(0, 0, `${content}\n`, selectFrom);
|
||||
this.focus();
|
||||
}
|
||||
|
||||
/**
|
||||
* Append content to the editor.
|
||||
*/
|
||||
appendContent(content: string): void {
|
||||
content = this.#cleanTextForEditor(content);
|
||||
const end = this.editor.cm.state.doc.length;
|
||||
this.#dispatchChange(end, end, `\n${content}`);
|
||||
this.focus();
|
||||
}
|
||||
|
||||
/**
|
||||
* Replace the editor's contents
|
||||
*/
|
||||
replaceContent(content: string): void {
|
||||
this.#setText(content);
|
||||
}
|
||||
|
||||
/**
|
||||
* Replace the start of the line
|
||||
* @param {String} newStart
|
||||
*/
|
||||
replaceLineStart(newStart: string): void {
|
||||
const selectionRange = this.#getSelectionRange();
|
||||
const line = this.editor.cm.state.doc.lineAt(selectionRange.from);
|
||||
|
||||
const lineContent = line.text;
|
||||
const lineStart = lineContent.split(' ')[0];
|
||||
|
||||
// Remove symbol if already set
|
||||
if (lineStart === newStart) {
|
||||
const newLineContent = lineContent.replace(`${newStart} `, '');
|
||||
const selectFrom = selectionRange.from + (newLineContent.length - lineContent.length);
|
||||
this.#dispatchChange(line.from, line.to, newLineContent, selectFrom);
|
||||
return;
|
||||
}
|
||||
|
||||
let newLineContent = lineContent;
|
||||
const alreadySymbol = /^[#>`]/.test(lineStart);
|
||||
if (alreadySymbol) {
|
||||
newLineContent = lineContent.replace(lineStart, newStart).trim();
|
||||
} else if (newStart !== '') {
|
||||
newLineContent = `${newStart} ${lineContent}`;
|
||||
}
|
||||
|
||||
const selectFrom = selectionRange.from + (newLineContent.length - lineContent.length);
|
||||
this.#dispatchChange(line.from, line.to, newLineContent, selectFrom);
|
||||
}
|
||||
|
||||
/**
|
||||
* Wrap the selection in the given contents start and end contents.
|
||||
*/
|
||||
wrapSelection(start: string, end: string): void {
|
||||
const selectRange = this.#getSelectionRange();
|
||||
const selectionText = this.#getSelectionText(selectRange);
|
||||
if (!selectionText) {
|
||||
this.#wrapLine(start, end);
|
||||
return;
|
||||
}
|
||||
|
||||
let newSelectionText = selectionText;
|
||||
let newRange;
|
||||
|
||||
if (selectionText.startsWith(start) && selectionText.endsWith(end)) {
|
||||
newSelectionText = selectionText.slice(start.length, selectionText.length - end.length);
|
||||
newRange = selectRange.extend(selectRange.from, selectRange.to - (start.length + end.length));
|
||||
} else {
|
||||
newSelectionText = `${start}${selectionText}${end}`;
|
||||
newRange = selectRange.extend(selectRange.from, selectRange.to + (start.length + end.length));
|
||||
}
|
||||
|
||||
this.#dispatchChange(
|
||||
selectRange.from,
|
||||
selectRange.to,
|
||||
newSelectionText,
|
||||
newRange.anchor,
|
||||
newRange.head,
|
||||
);
|
||||
}
|
||||
|
||||
replaceLineStartForOrderedList() {
|
||||
const selectionRange = this.#getSelectionRange();
|
||||
const line = this.editor.cm.state.doc.lineAt(selectionRange.from);
|
||||
const prevLine = this.editor.cm.state.doc.line(line.number - 1);
|
||||
|
||||
const listMatch = prevLine.text.match(/^(\s*)(\d)([).])\s/) || [];
|
||||
|
||||
const number = (Number(listMatch[2]) || 0) + 1;
|
||||
const whiteSpace = listMatch[1] || '';
|
||||
const listMark = listMatch[3] || '.';
|
||||
|
||||
const prefix = `${whiteSpace}${number}${listMark}`;
|
||||
return this.replaceLineStart(prefix);
|
||||
}
|
||||
|
||||
/**
|
||||
* Cycles through the type of callout block within the selection.
|
||||
* Creates a callout block if none existing, and removes it if cycling past the danger type.
|
||||
*/
|
||||
cycleCalloutTypeAtSelection() {
|
||||
const selectionRange = this.#getSelectionRange();
|
||||
const line = this.editor.cm.state.doc.lineAt(selectionRange.from);
|
||||
|
||||
const formats = ['info', 'success', 'warning', 'danger'];
|
||||
const joint = formats.join('|');
|
||||
const regex = new RegExp(`class="((${joint})\\s+callout|callout\\s+(${joint}))"`, 'i');
|
||||
const matches = regex.exec(line.text) || [''];
|
||||
const format = (matches ? (matches[2] || matches[3]) : '').toLowerCase();
|
||||
|
||||
if (format === formats[formats.length - 1]) {
|
||||
this.#wrapLine(`<p class="callout ${formats[formats.length - 1]}">`, '</p>');
|
||||
} else if (format === '') {
|
||||
this.#wrapLine('<p class="callout info">', '</p>');
|
||||
} else {
|
||||
const newFormatIndex = formats.indexOf(format) + 1;
|
||||
const newFormat = formats[newFormatIndex];
|
||||
const newContent = line.text.replace(matches[0], matches[0].replace(format, newFormat));
|
||||
const lineDiff = newContent.length - line.text.length;
|
||||
this.#dispatchChange(
|
||||
line.from,
|
||||
line.to,
|
||||
newContent,
|
||||
selectionRange.anchor + lineDiff,
|
||||
selectionRange.head + lineDiff,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
syncDisplayPosition(event: Event): void {
|
||||
// Thanks to http://liuhao.im/english/2015/11/10/the-sync-scroll-of-markdown-editor-in-javascript.html
|
||||
const scrollEl = event.target as HTMLElement;
|
||||
const atEnd = Math.abs(scrollEl.scrollHeight - scrollEl.clientHeight - scrollEl.scrollTop) < 1;
|
||||
if (atEnd) {
|
||||
this.editor.display.scrollToIndex(-1);
|
||||
return;
|
||||
}
|
||||
|
||||
const blockInfo = this.editor.cm.lineBlockAtHeight(scrollEl.scrollTop);
|
||||
const range = this.editor.cm.state.sliceDoc(0, blockInfo.from);
|
||||
const parser = new DOMParser();
|
||||
const doc = parser.parseFromString(this.editor.markdown.render(range), 'text/html');
|
||||
const totalLines = doc.documentElement.querySelectorAll('body > *');
|
||||
this.editor.display.scrollToIndex(totalLines.length);
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch and insert the template of the given ID.
|
||||
* The page-relative position provided can be used to determine insert location if possible.
|
||||
*/
|
||||
async insertTemplate(templateId: string, posX: number, posY: number): Promise<void> {
|
||||
const cursorPos = this.editor.cm.posAtCoords({x: posX, y: posY}, false);
|
||||
const responseData = (await window.$http.get(`/templates/${templateId}`)).data as {markdown: string, html: string};
|
||||
const content = responseData.markdown || responseData.html;
|
||||
this.#dispatchChange(cursorPos, cursorPos, content, cursorPos);
|
||||
}
|
||||
|
||||
/**
|
||||
* Insert multiple images from the clipboard from an event at the provided
|
||||
* screen coordinates (Typically form a paste event).
|
||||
*/
|
||||
insertClipboardImages(images: File[], posX: number, posY: number): void {
|
||||
const cursorPos = this.editor.cm.posAtCoords({x: posX, y: posY}, false);
|
||||
for (const image of images) {
|
||||
this.uploadImage(image, cursorPos);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle image upload and add image into markdown content
|
||||
*/
|
||||
async uploadImage(file: File, position: number|null = null): Promise<void> {
|
||||
if (file === null || file.type.indexOf('image') !== 0) return;
|
||||
let ext = 'png';
|
||||
|
||||
if (position === null) {
|
||||
position = this.#getSelectionRange().from;
|
||||
}
|
||||
|
||||
if (file.name) {
|
||||
const fileNameMatches = file.name.match(/\.(.+)$/);
|
||||
if (fileNameMatches && fileNameMatches.length > 1) {
|
||||
ext = fileNameMatches[1];
|
||||
}
|
||||
}
|
||||
|
||||
// Insert image into markdown
|
||||
const id = `image-${Math.random().toString(16).slice(2)}`;
|
||||
const placeholderImage = window.baseUrl(`/loading.gif#upload${id}`);
|
||||
const placeHolderText = ``;
|
||||
this.#dispatchChange(position, position, placeHolderText, position);
|
||||
|
||||
const remoteFilename = `image-${Date.now()}.${ext}`;
|
||||
const formData = new FormData();
|
||||
formData.append('file', file, remoteFilename);
|
||||
formData.append('uploaded_to', this.editor.config.pageId);
|
||||
|
||||
try {
|
||||
const image = (await window.$http.post('/images/gallery', formData)).data as ImageManagerImage;
|
||||
const newContent = `[](${image.url})`;
|
||||
this.#findAndReplaceContent(placeHolderText, newContent);
|
||||
} catch (err: any) {
|
||||
window.$events.error(err?.data?.message || this.editor.config.text.imageUploadError);
|
||||
this.#findAndReplaceContent(placeHolderText, '');
|
||||
console.error(err);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the current text of the editor instance.
|
||||
* @return {string}
|
||||
*/
|
||||
#getText() {
|
||||
return this.editor.cm.state.doc.toString();
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the text of the current editor instance.
|
||||
*/
|
||||
#setText(text: string, selectionRange: SelectionRange|null = null) {
|
||||
selectionRange = selectionRange || this.#getSelectionRange();
|
||||
const newDoc = this.editor.cm.state.toText(text);
|
||||
const newSelectFrom = Math.min(selectionRange.from, newDoc.length);
|
||||
const scrollTop = this.editor.cm.scrollDOM.scrollTop;
|
||||
this.#dispatchChange(0, this.editor.cm.state.doc.length, text, newSelectFrom);
|
||||
this.focus();
|
||||
window.requestAnimationFrame(() => {
|
||||
this.editor.cm.scrollDOM.scrollTop = scrollTop;
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Replace the current selection and focus the editor.
|
||||
* Takes an offset for the cursor, after the change, relative to the start of the provided string.
|
||||
* Can be provided a selection range to use instead of the current selection range.
|
||||
*/
|
||||
#replaceSelection(newContent: string, cursorOffset: number = 0, selectionRange: SelectionRange|null = null) {
|
||||
selectionRange = selectionRange || this.#getSelectionRange();
|
||||
const selectFrom = selectionRange.from + cursorOffset;
|
||||
this.#dispatchChange(selectionRange.from, selectionRange.to, newContent, selectFrom);
|
||||
this.focus();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the text content of the main current selection.
|
||||
*/
|
||||
#getSelectionText(selectionRange: SelectionRange|null = null): string {
|
||||
selectionRange = selectionRange || this.#getSelectionRange();
|
||||
return this.editor.cm.state.sliceDoc(selectionRange.from, selectionRange.to);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the range of the current main selection.
|
||||
*/
|
||||
#getSelectionRange(): SelectionRange {
|
||||
return this.editor.cm.state.selection.main;
|
||||
}
|
||||
|
||||
/**
|
||||
* Cleans the given text to work with the editor.
|
||||
* Standardises line endings to what's expected.
|
||||
*/
|
||||
#cleanTextForEditor(text: string): string {
|
||||
return text.replace(/\r\n|\r/g, '\n');
|
||||
}
|
||||
|
||||
/**
|
||||
* Find and replace the first occurrence of [search] with [replace]
|
||||
*/
|
||||
#findAndReplaceContent(search: string, replace: string): void {
|
||||
const newText = this.#getText().replace(search, replace);
|
||||
this.#setText(newText);
|
||||
}
|
||||
|
||||
/**
|
||||
* Wrap the line in the given start and end contents.
|
||||
*/
|
||||
#wrapLine(start: string, end: string): void {
|
||||
const selectionRange = this.#getSelectionRange();
|
||||
const line = this.editor.cm.state.doc.lineAt(selectionRange.from);
|
||||
const lineContent = line.text;
|
||||
let newLineContent;
|
||||
let lineOffset = 0;
|
||||
|
||||
if (lineContent.startsWith(start) && lineContent.endsWith(end)) {
|
||||
newLineContent = lineContent.slice(start.length, lineContent.length - end.length);
|
||||
lineOffset = -(start.length);
|
||||
} else {
|
||||
newLineContent = `${start}${lineContent}${end}`;
|
||||
lineOffset = start.length;
|
||||
}
|
||||
|
||||
this.#dispatchChange(line.from, line.to, newLineContent, selectionRange.from + lineOffset);
|
||||
}
|
||||
|
||||
/**
|
||||
* Dispatch changes to the editor.
|
||||
*/
|
||||
#dispatchChange(from: number, to: number|null = null, text: string|null = null, selectFrom: number|null = null, selectTo: number|null = null): void {
|
||||
const change: ChangeSpec = {from};
|
||||
if (to) {
|
||||
change.to = to;
|
||||
}
|
||||
if (text) {
|
||||
change.insert = text;
|
||||
}
|
||||
const tr: TransactionSpec = {changes: change};
|
||||
|
||||
if (selectFrom) {
|
||||
tr.selection = {anchor: selectFrom};
|
||||
if (selectTo) {
|
||||
tr.selection.head = selectTo;
|
||||
}
|
||||
}
|
||||
|
||||
this.editor.cm.dispatch(tr);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the current selection range.
|
||||
* Optionally will scroll the new range into view.
|
||||
* @param {Number} from
|
||||
* @param {Number} to
|
||||
* @param {Boolean} scrollIntoView
|
||||
*/
|
||||
#setSelection(from: number, to: number, scrollIntoView = false) {
|
||||
this.editor.cm.dispatch({
|
||||
selection: {anchor: from, head: to},
|
||||
scrollIntoView,
|
||||
});
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user