aboutsummaryrefslogtreecommitdiff
path: root/src/client/views/nodes/formattedText/ProsemirrorExampleTransfer.ts
blob: c66cb502e9a0a6a9553fe75a1fbb785ec1f05bf1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
import { chainCommands, deleteSelection, exitCode, joinBackward, joinDown, joinUp, lift, newlineInCode, selectNodeBackward, setBlockType, splitBlockKeepMarks, toggleMark, wrapIn } from "prosemirror-commands";
import { redo, undo } from "prosemirror-history";
import { Schema } from "prosemirror-model";
import { splitListItem, wrapInList } from "prosemirror-schema-list";
import { EditorState, TextSelection, Transaction } from "prosemirror-state";
import { liftTarget } from "prosemirror-transform";
import { AclAugment, AclSelfEdit, Doc } from "../../../../fields/Doc";
import { GetEffectiveAcl } from "../../../../fields/util";
import { Utils } from "../../../../Utils";
import { Docs } from "../../../documents/Documents";
import { SelectionManager } from "../../../util/SelectionManager";
import { liftListItem, sinkListItem } from "./prosemirrorPatches.js";

const mac = typeof navigator !== "undefined" ? /Mac/.test(navigator.platform) : false;

export type KeyMap = { [key: string]: any };

export let updateBullets = (tx2: Transaction, schema: Schema, assignedMapStyle?: string, from?: number, to?: number) => {
    let mapStyle = assignedMapStyle;
    tx2.doc.descendants((node: any, offset: any, index: any) => {
        if ((from === undefined || to === undefined || (from <= offset + node.nodeSize && to >= offset)) && (node.type === schema.nodes.ordered_list || node.type === schema.nodes.list_item)) {
            const path = (tx2.doc.resolve(offset) as any).path;
            let depth = Array.from(path).reduce((p: number, c: any) => p + (c.hasOwnProperty("type") && c.type === schema.nodes.ordered_list ? 1 : 0), 0);
            if (node.type === schema.nodes.ordered_list) {
                if (depth === 0 && !assignedMapStyle) mapStyle = node.attrs.mapStyle;
                depth++;
            }
            tx2.setNodeMarkup(offset, node.type, { ...node.attrs, mapStyle, bulletStyle: depth, }, node.marks);
        }
    });
    return tx2;
};

export function buildKeymap<S extends Schema<any>>(schema: S, props: any, mapKeys?: KeyMap): KeyMap {
    const keys: { [key: string]: any } = {};

    function bind(key: string, cmd: any) {
        if (mapKeys) {
            const mapped = mapKeys[key];
            if (mapped === false) return;
            if (mapped) key = mapped;
        }
        keys[key] = cmd;
    }

    const canEdit = (state: any) => {
        switch (GetEffectiveAcl(props.DataDoc)) {
            case AclAugment: return false;
            case AclSelfEdit:
                for (var i = state.selection.from; i < state.selection.to; i++) {
                    const marks = state.doc.resolve(i)?.marks?.();
                    if (marks?.some((mark: any) => mark.type === schema.marks.user_mark && mark.attrs.userid !== Doc.CurrentUserEmail)) {
                        return false;
                    }
                }
                break;
        }
        return true;
    };

    const toggleEditableMark = (mark: any) => (state: EditorState<S>, dispatch: (tx: Transaction<S>) => void) => canEdit(state) && toggleMark(mark)(state, dispatch);

    //History commands
    bind("Mod-z", undo);
    bind("Shift-Mod-z", redo);
    !mac && bind("Mod-y", redo);

    //Commands to modify Mark
    bind("Mod-b", toggleEditableMark(schema.marks.strong));
    bind("Mod-B", toggleEditableMark(schema.marks.strong));

    bind("Mod-e", toggleEditableMark(schema.marks.em));
    bind("Mod-E", toggleEditableMark(schema.marks.em));

    bind("Mod-*", toggleEditableMark(schema.marks.code));

    bind("Mod-u", toggleEditableMark(schema.marks.underline));
    bind("Mod-U", toggleEditableMark(schema.marks.underline));

    //Commands for lists
    bind("Ctrl-i", (state: EditorState<S>, dispatch: (tx: Transaction<S>) => void) => canEdit(state) && wrapInList(schema.nodes.ordered_list)(state as any, dispatch as any));

    bind("Ctrl-Tab", () => props.onKey?.(event, props) ? true : true);
    bind("Alt-Tab", () => props.onKey?.(event, props) ? true : true);
    bind("Meta-Tab", () => props.onKey?.(event, props) ? true : true);
    bind("Meta-Enter", () => props.onKey?.(event, props) ? true : true);
    bind("Tab", (state: EditorState<S>, dispatch: (tx: Transaction<S>) => void) => {
        if (props.onKey?.(event, props)) return true;
        if (!canEdit(state)) return true;
        const ref = state.selection;
        const range = ref.$from.blockRange(ref.$to);
        const marks = state.storedMarks || (state.selection.$to.parentOffset && state.selection.$from.marks());
        if (!sinkListItem(schema.nodes.list_item)(state, (tx2: Transaction) => {
            const tx3 = updateBullets(tx2, schema);
            marks && tx3.ensureMarks([...marks]);
            marks && tx3.setStoredMarks([...marks]);
            dispatch(tx3);
        })) { // couldn't sink into an existing list, so wrap in a new one
            const newstate = state.applyTransaction(state.tr.setSelection(TextSelection.create(state.doc, range!.start, range!.end)));
            if (!wrapInList(schema.nodes.ordered_list)(newstate.state as any, (tx2: Transaction) => {
                const tx3 = updateBullets(tx2, schema);
                // when promoting to a list, assume list will format things so don't copy the stored marks.
                marks && tx3.ensureMarks([...marks]);
                marks && tx3.setStoredMarks([...marks]);
                dispatch(tx3);
            })) {
                console.log("bullet promote fail");
            }
        }
    });

    bind("Shift-Tab", (state: EditorState<S>, dispatch: (tx: Transaction<S>) => void) => {
        if (props.onKey?.(event, props)) return true;
        if (!canEdit(state)) return true;
        const marks = state.storedMarks || (state.selection.$to.parentOffset && state.selection.$from.marks());

        if (!liftListItem(schema.nodes.list_item)(state.tr, (tx2: Transaction) => {
            const tx3 = updateBullets(tx2, schema);
            marks && tx3.ensureMarks([...marks]);
            marks && tx3.setStoredMarks([...marks]);
            dispatch(tx3);
        })) {
            console.log("bullet demote fail");
        }
    });

    //Command to create a new Tab with a PDF of all the command shortcuts
    bind("Mod-/", (state: EditorState<S>, dispatch: (tx: Transaction<S>) => void) => {
        const newDoc = Docs.Create.PdfDocument(Utils.prepend("/assets/cheat-sheet.pdf"), { _width: 300, _height: 300 });
        props.addDocTab(newDoc, "add:right");
    });

    //Commands to modify BlockType
    bind("Ctrl->", (state: EditorState<S>, dispatch: (tx: Transaction<S>) => void) => canEdit((state) && wrapIn(schema.nodes.blockquote)(state as any, dispatch as any)));
    bind("Alt-\\", (state: EditorState<S>, dispatch: (tx: Transaction<S>) => void) => canEdit(state) && setBlockType(schema.nodes.paragraph)(state as any, dispatch as any));
    bind("Shift-Ctrl-\\", (state: EditorState<S>, dispatch: (tx: Transaction<S>) => void) => canEdit(state) && setBlockType(schema.nodes.code_block)(state as any, dispatch as any));

    bind("Ctrl-m", (state: EditorState<S>, dispatch: (tx: Transaction<S>) => void) => canEdit(state) && dispatch(state.tr.replaceSelectionWith(schema.nodes.equation.create({ fieldKey: "math" + Utils.GenerateGuid() }))));

    for (let i = 1; i <= 6; i++) {
        bind("Shift-Ctrl-" + i, (state: EditorState<S>, dispatch: (tx: Transaction<S>) => void) => canEdit(state) && setBlockType(schema.nodes.heading, { level: i })(state as any, dispatch as any));
    }

    //Command to create a horizontal break line
    const hr = schema.nodes.horizontal_rule;
    bind("Mod-_", (state: EditorState<S>, dispatch: (tx: Transaction<S>) => void) => canEdit(state) && dispatch(state.tr.replaceSelectionWith(hr.create()).scrollIntoView()));

    //Command to unselect all
    bind("Escape", (state: EditorState<S>, dispatch: (tx: Transaction<S>) => void) => {
        dispatch(state.tr.setSelection(TextSelection.create(state.doc, state.selection.from, state.selection.from)));
        (document.activeElement as any).blur?.();
        SelectionManager.DeselectAll();
    });

    const splitMetadata = (marks: any, tx: Transaction) => {
        marks && tx.ensureMarks(marks.filter((val: any) => val.type !== schema.marks.metadata && val.type !== schema.marks.metadataKey && val.type !== schema.marks.metadataVal));
        marks && tx.setStoredMarks(marks.filter((val: any) => val.type !== schema.marks.metadata && val.type !== schema.marks.metadataKey && val.type !== schema.marks.metadataVal));
        return tx;
    };


    bind("Alt-Enter", () => props.onKey?.(event, props) ? true : true);
    bind("Ctrl-Enter", () => props.onKey?.(event, props) ? true : true);

    // backspace = chainCommands(deleteSelection, joinBackward, selectNodeBackward);
    bind("Backspace", (state: EditorState<S>, dispatch: (tx: Transaction<Schema<any, any>>) => void) => {
        if (props.onKey?.(event, props)) return true;
        if (!canEdit(state)) return true;

        if (!deleteSelection(state, (tx: Transaction<S>) => {
            dispatch(updateBullets(tx, schema));
        })) {
            if (!joinBackward(state, (tx: Transaction<S>) => {
                dispatch(updateBullets(tx, schema));
            })) {
                if (!selectNodeBackward(state, (tx: Transaction<S>) => {
                    dispatch(updateBullets(tx, schema));
                })) {
                    return false;
                }
            }
        }
        return true;
    });

    //newlineInCode, createParagraphNear, liftEmptyBlock, splitBlock
    //command to break line
    bind("Enter", (state: EditorState<S>, dispatch: (tx: Transaction<Schema<any, any>>) => void) => {

        if (props.onKey?.(event, props)) return true;
        if (!canEdit(state)) return true;

        const trange = state.selection.$from.blockRange(state.selection.$to);
        const path = (state.selection.$from as any).path;
        const depth = trange ? liftTarget(trange) : undefined;
        const split = path.length > 5 && !path[path.length - 3].textContent && path[path.length - 6].type !== schema.nodes.list_item;
        if (split && trange && depth !== undefined && depth !== null) {
            dispatch(state.tr.lift(trange, depth) as any);
            return true;
        }

        const marks = state.storedMarks || (state.selection.$to.parentOffset && state.selection.$from.marks());
        const cr = state.selection.$from.node().textContent.endsWith("\n");
        if (cr || !newlineInCode(state, dispatch as any)) {
            if (!splitListItem(schema.nodes.list_item)(state as any, (tx2: Transaction) => {
                const tx3 = updateBullets(tx2, schema);
                marks && tx3.ensureMarks([...marks]);
                marks && tx3.setStoredMarks([...marks]);
                dispatch(tx3);
            })) {
                const fromattrs = state.selection.$from.node().attrs;
                if (!splitBlockKeepMarks(state, (tx3: Transaction) => {
                    const tonode = tx3.selection.$to.node();
                    if (tx3.selection.to && tx3.doc.nodeAt(tx3.selection.to - 1)) {
                        const tx4 = tx3.setNodeMarkup(tx3.selection.to - 1, tonode.type, fromattrs, tonode.marks);
                        splitMetadata(marks, tx4);
                        if (!liftListItem(schema.nodes.list_item)(tx4, dispatch as ((tx: Transaction<Schema<any, any>>) => void))) {
                            dispatch(tx4);
                        }
                    } else dispatch(tx3.insertText("\r\n"));
                })) {
                    return false;
                }
            }
        }
        return true;
    });

    //Command to create a blank space
    bind("Space", (state: EditorState<S>, dispatch: (tx: Transaction<S>) => void) => {
        if (!canEdit(state)) return true;
        const marks = state.storedMarks || (state.selection.$to.parentOffset && state.selection.$from.marks());
        dispatch(splitMetadata(marks, state.tr));
        return false;
    });

    bind("Alt-ArrowUp", (state: EditorState<S>, dispatch: (tx: Transaction<S>) => void) => canEdit(state) && joinUp(state, dispatch as any));
    bind("Alt-ArrowDown", (state: EditorState<S>, dispatch: (tx: Transaction<S>) => void) => canEdit(state) && joinDown(state, dispatch as any));
    bind("Mod-BracketLeft", (state: EditorState<S>, dispatch: (tx: Transaction<S>) => void) => canEdit(state) && lift(state, dispatch as any));

    const cmd = chainCommands(exitCode, (state, dispatch) => {
        if (dispatch) {
            canEdit(state) && dispatch(state.tr.replaceSelectionWith(schema.nodes.hard_break.create()).scrollIntoView());
            return true;
        }
        return false;
    });

    bind("Shift-Enter", cmd);

    return keys;
}