@fiduswriter/editor 0.1.20 → 0.1.21

package/src/state_plugins/track/{plugin.js → plugin.ts}

@@ -1,5 +1,8 @@
 import {Plugin, PluginKey} from "prosemirror-state"
 import {Decoration, DecorationSet} from "prosemirror-view"
+import type {Node} from "prosemirror-model"
+
+import type {Editor} from "../../types.js"
 
 import {findSelectedChanges} from "./find_selected_changes.js"
 
@@ -9,7 +12,7 @@ export const selectedDeletionSpec = {}
 export const selectedChangeFormatSpec = {}
 export const selectedChangeBlockSpec = {}
 
-export function trackPlugin(options) {
+export function trackPlugin(options: {editor: Editor}) {
     return new Plugin({
         key,
         state: {
@@ -17,11 +20,15 @@ export function trackPlugin(options) {
                 // Make sure there are colors for all users who have left marks
                 // in the document and that they are registered as past
                 // participants for the marginbox filter.
-                const users = {}
-                users[options.editor.user.id] = options.editor.user.name
-                state.doc.descendants(node => {
+                const users: Record<number, string> = {}
+                users[(options.editor.user as unknown as {id: number}).id] =
+                    options.editor.user.name || ""
+                state.doc.descendants((node: Node) => {
                     if (node.attrs.track) {
-                        node.attrs.track.forEach(track => {
+                        ;(node.attrs.track as Array<{
+                            user: number
+                            username: string
+                        }>).forEach(track => {
                             if (!users[track.user] && track.user !== 0) {
                                 users[track.user] = track.username
                             }
@@ -46,13 +53,26 @@ export function trackPlugin(options) {
                 if (options.editor.mod.collab) {
                     Object.entries(users).forEach(([id, userName]) => {
                         const userId = Number.parseInt(id)
-                        options.editor.mod.collab.colors.ensureUserColor(userId)
+                        ;(
+                            options.editor.mod.collab as {
+                                colors: {ensureUserColor: (id: number) => void}
+                                pastParticipants: {id: number; name: string}[]
+                            }
+                        ).colors.ensureUserColor(userId)
                         if (
-                            !options.editor.mod.collab.pastParticipants.find(
+                            !(
+                                options.editor.mod.collab as {
+                                    pastParticipants: {id: number; name: string}[]
+                                }
+                            ).pastParticipants.find(
                                 participant => participant.id === userId
                             )
                         ) {
-                            options.editor.mod.collab.pastParticipants.push({
+                            ;(
+                                options.editor.mod.collab as {
+                                    pastParticipants: {id: number; name: string}[]
+                                }
+                            ).pastParticipants.push({
                                 id: userId,
                                 name: userName
                             })
@@ -64,7 +84,7 @@ export function trackPlugin(options) {
                     decos: DecorationSet.empty
                 }
             },
-            apply(tr, _prev, oldState, state) {
+            apply(tr, _prev, _oldState, state) {
                 const meta = tr.getMeta(key)
                 if (meta) {
                     // There has been an update, return values from meta instead
@@ -72,13 +92,13 @@ export function trackPlugin(options) {
                     return meta
                 }
 
-                let {decos} = this.getState(oldState)
+                let {decos} = key.getState(state) as {decos: DecorationSet}
 
                 if (tr.selectionSet) {
                     const {insertion, deletion, formatChange} =
                         findSelectedChanges(state)
                     decos = DecorationSet.empty
-                    const decoType = tr.selection.node
+                    const decoType = (tr.selection as {node?: Node}).node
                         ? Decoration.node
                         : Decoration.inline
                     if (insertion) {
@@ -127,12 +147,16 @@ export function trackPlugin(options) {
         },
         props: {
             decorations(state) {
-                const {decos} = this.getState(state)
-                return decos
+                const pluginState = this.getState(state) as {decos: DecorationSet}
+                return pluginState.decos
             },
             handleDOMEvents: {
                 focus: (_view, _event) => {
-                    options.editor.mod.comments.interactions.deactivateSelectedChanges()
+                    ;(
+                        options.editor.mod.comments as {
+                            interactions: {deactivateSelectedChanges: () => void}
+                        }
+                    ).interactions.deactivateSelectedChanges()
                 }
             }
         }

package/src/tools/key_bindings/{index.js → index.ts}

@@ -4,17 +4,21 @@ import {keyBindingsTemplate} from "./templates.js"
  * originally by Gabriel Lopez <gabriel.marcos.lopez@gmail.com>
  */
 
+import type {Editor} from "../../types.js"
+
 export class KeyBindingsDialog {
-    constructor(editor) {
+    editor: Editor
+
+    constructor(editor: Editor) {
         this.editor = editor
     }
 
-    init() {
+    init(): void {
         const dialog = new Dialog({
             title: gettext("Keyboard Shortcuts"),
             body: keyBindingsTemplate(),
             width: 850,
-            buttons: [{type: "close"}]
+            buttons: [{type: "close" as const}]
         })
         dialog.open()
     }

package/src/tools/key_bindings/{templates.js → templates.ts}

@@ -1,4 +1,4 @@
-export const keyBindingsTemplate = () =>
+export const keyBindingsTemplate = (): string =>
     `<div id="helpListWrap" class="help-list-wrap">
         <ul class="help-list">
           <li class="help-key-unit">

package/src/tools/search_replace/{index.js → index.ts}

@@ -1,5 +1,7 @@
 import {Dialog, addAlert} from "fwtoolkit"
+
 import {COMMENT_ONLY_ROLES, READ_ONLY_ROLES} from "../../index.js"
+import type {Editor} from "../../types.js"
 import {
     deselectSearchMatch,
     endSearch,
@@ -7,25 +9,50 @@ import {
     getSearchMatches,
     selectNextSearchMatch,
     selectPreviousSearchMatch,
-    setSearchTerm
+    setSearchTerm,
+    type Match
 } from "../../state_plugins/index.js"
+
 import {searchDialogTemplate} from "./templates.js"
 
+interface SearchMatches {
+    matches: Match[]
+    selected: number | false
+}
+
+interface DialogButtonSpec {
+    text?: string
+    classes?: string
+    click?: () => void
+    type?: "cancel" | "close" | "ok"
+    icon?: string
+    dropdown?: boolean
+}
+
 export class SearchReplaceDialog {
-    constructor(editor) {
+    editor: Editor
+    dialog: InstanceType<typeof Dialog> | false
+    matches: SearchMatches
+    fnMatches: SearchMatches
+    canWrite: boolean
+    searchInput!: HTMLInputElement
+    replaceInput!: HTMLInputElement
+    resultCountEl!: HTMLElement
+
+    constructor(editor: Editor) {
         this.editor = editor
         this.dialog = false
         this.matches = {matches: [], selected: false}
         this.fnMatches = {matches: [], selected: false}
         this.canWrite =
-            READ_ONLY_ROLES.includes(this.editor.docInfo.access_rights) ||
-            COMMENT_ONLY_ROLES.includes(this.editor.docInfo.access_rights)
+            READ_ONLY_ROLES.includes(this.editor.docInfo.access_rights as string) ||
+            COMMENT_ONLY_ROLES.includes(this.editor.docInfo.access_rights as string)
                 ? false
                 : true
     }
 
-    init() {
-        let buttons = [
+    init(): void {
+        let buttons: DialogButtonSpec[] = [
             {
                 text: gettext("Previous"),
                 classes: "fw-light disabled",
@@ -44,10 +71,10 @@ export class SearchReplaceDialog {
                             this.editor.view.dispatch(
                                 deselectSearchMatch(this.editor.view.state)
                             )
-                            this.editor.mod.footnotes.fnEditor.view.dispatch(
+                            ;(this.editor.mod as any).footnotes.fnEditor.view.dispatch(
                                 selectPreviousSearchMatch(
-                                    this.editor.mod.footnotes.fnEditor.view
-                                        .state
+                                    (this.editor.mod as any).footnotes.fnEditor
+                                        .view.state
                                 )
                             )
                         }
@@ -56,17 +83,17 @@ export class SearchReplaceDialog {
                             this.fnMatches.selected > 0 ||
                             !this.matches.matches.length
                         ) {
-                            this.editor.mod.footnotes.fnEditor.view.dispatch(
+                            ;(this.editor.mod as any).footnotes.fnEditor.view.dispatch(
                                 selectPreviousSearchMatch(
-                                    this.editor.mod.footnotes.fnEditor.view
-                                        .state
+                                    (this.editor.mod as any).footnotes.fnEditor
+                                        .view.state
                                 )
                             )
                         } else {
-                            this.editor.mod.footnotes.fnEditor.view.dispatch(
+                            ;(this.editor.mod as any).footnotes.fnEditor.view.dispatch(
                                 deselectSearchMatch(
-                                    this.editor.mod.footnotes.fnEditor.view
-                                        .state
+                                    (this.editor.mod as any).footnotes.fnEditor
+                                        .view.state
                                 )
                             )
                             this.editor.view.dispatch(
@@ -95,10 +122,10 @@ export class SearchReplaceDialog {
                             this.editor.view.dispatch(
                                 deselectSearchMatch(this.editor.view.state)
                             )
-                            this.editor.mod.footnotes.fnEditor.view.dispatch(
+                            ;(this.editor.mod as any).footnotes.fnEditor.view.dispatch(
                                 selectNextSearchMatch(
-                                    this.editor.mod.footnotes.fnEditor.view
-                                        .state
+                                    (this.editor.mod as any).footnotes.fnEditor
+                                        .view.state
                                 )
                             )
                         }
@@ -108,17 +135,17 @@ export class SearchReplaceDialog {
                                 this.fnMatches.matches.length - 1 ||
                             !this.matches.matches.length
                         ) {
-                            this.editor.mod.footnotes.fnEditor.view.dispatch(
+                            ;(this.editor.mod as any).footnotes.fnEditor.view.dispatch(
                                 selectNextSearchMatch(
-                                    this.editor.mod.footnotes.fnEditor.view
-                                        .state
+                                    (this.editor.mod as any).footnotes.fnEditor
+                                        .view.state
                                 )
                             )
                         } else {
-                            this.editor.mod.footnotes.fnEditor.view.dispatch(
+                            ;(this.editor.mod as any).footnotes.fnEditor.view.dispatch(
                                 deselectSearchMatch(
-                                    this.editor.mod.footnotes.fnEditor.view
-                                        .state
+                                    (this.editor.mod as any).footnotes.fnEditor
+                                        .view.state
                                 )
                             )
                             this.editor.view.dispatch(
@@ -157,20 +184,20 @@ export class SearchReplaceDialog {
                         } else if (this.fnMatches.selected !== false) {
                             const match =
                                 this.fnMatches.matches[this.fnMatches.selected]
-                            const originalDoc =
-                                this.editor.mod.footnotes.fnEditor.view.state
-                                    .doc
-                            const tr =
-                                this.editor.mod.footnotes.fnEditor.view.state.tr.insertText(
-                                    this.replaceInput.value,
-                                    match.from,
-                                    match.to
-                                )
-                            this.editor.mod.footnotes.fnEditor.view.dispatch(tr)
+                            const originalDoc = (this.editor.mod as any)
+                                .footnotes.fnEditor.view.state.doc
+                            const tr = (this.editor.mod as any).footnotes.fnEditor.view.state.tr.insertText(
+                                this.replaceInput.value,
+                                match.from,
+                                match.to
+                            )
+                            ;(this.editor.mod as any).footnotes.fnEditor.view.dispatch(
+                                tr
+                            )
                             // In case there was a match within protected range , the change
                             // would be rejected. Show alert when replace is successfull.
                             if (
-                                !this.editor.mod.footnotes.fnEditor.view.state.doc.eq(
+                                !(this.editor.mod as any).footnotes.fnEditor.view.state.doc.eq(
                                     originalDoc
                                 )
                             ) {
@@ -189,13 +216,14 @@ export class SearchReplaceDialog {
                         if (this.matches.matches.length) {
                             const tr = this.editor.view.state.tr
                             const originalDoc = this.editor.view.state.doc
-                            const protectedRanges = getProtectedRanges(
+                            const protectedRanges: Array<{from: number; to: number}> = getProtectedRanges(
                                 this.editor.view.state
                             )
                             const matches = this.matches.matches.slice()
                             while (matches.length) {
                                 const match = matches.pop() // We take them backward so that there is no need for mapping steps
                                 if (
+                                    match &&
                                     !protectedRanges.find(
                                         ({from, to}) =>
                                             !(
@@ -225,25 +253,28 @@ export class SearchReplaceDialog {
                             }
                         }
                         if (this.fnMatches.matches.length) {
-                            const tr =
-                                this.editor.mod.footnotes.fnEditor.view.state.tr
-                            const originalDoc =
-                                this.editor.mod.footnotes.fnEditor.view.state
-                                    .doc
+                            const tr = (this.editor.mod as any).footnotes
+                                .fnEditor.view.state.tr
+                            const originalDoc = (this.editor.mod as any)
+                                .footnotes.fnEditor.view.state.doc
                             const matches = this.fnMatches.matches.slice()
                             while (matches.length) {
                                 const match = matches.pop() // We take them backward so that there is no need for mapping steps
-                                tr.insertText(
-                                    this.replaceInput.value,
-                                    match.from,
-                                    match.to
-                                )
+                                if (match) {
+                                    tr.insertText(
+                                        this.replaceInput.value,
+                                        match.from,
+                                        match.to
+                                    )
+                                }
                             }
-                            this.editor.mod.footnotes.fnEditor.view.dispatch(tr)
+                            ;(this.editor.mod as any).footnotes.fnEditor.view.dispatch(
+                                tr
+                            )
                             // In case there was a match within protected range , the change
                             // would be rejected. Show alert when replace is successfull.
                             if (
-                                !this.editor.mod.footnotes.fnEditor.view.state.doc.eq(
+                                !(this.editor.mod as any).footnotes.fnEditor.view.state.doc.eq(
                                     originalDoc
                                 )
                             ) {
@@ -277,21 +308,30 @@ export class SearchReplaceDialog {
                     "Please note that there are match(es) within non-editable parts of the document, these match(es) won't be replaced when using 'replace' or 'replace all'"
                 )
             }
-        })
+        }) as InstanceType<typeof Dialog>
 
         this.dialog.open()
 
-        this.searchInput = this.dialog.dialogEl.querySelector(".fw-search")
-        this.replaceInput = this.dialog.dialogEl.querySelector(".replace")
+        this.searchInput = this.dialog.dialogEl.querySelector(
+            ".fw-search"
+        ) as HTMLInputElement
+        this.replaceInput = this.dialog.dialogEl.querySelector(
+            ".replace"
+        ) as HTMLInputElement
         this.resultCountEl = this.dialog.dialogEl.querySelector(
             ".search-result-count"
-        )
-        this.dialog.dialogEl.querySelector("input[type=text]").focus()
+        ) as HTMLElement
+        ;(this.dialog.dialogEl.querySelector("input[type=text]") as
+            | HTMLInputElement
+            | null)?.focus()
 
         this.bind()
     }
 
-    setButtonState() {
+    setButtonState(): void {
+        if (!this.dialog) {
+            return
+        }
         if (this.matches.matches.length + this.fnMatches.matches.length > 1) {
             this.dialog.buttons[0].classes = "fw-light"
             this.dialog.buttons[1].classes = "fw-light"
@@ -312,13 +352,17 @@ export class SearchReplaceDialog {
         this.dialog.refreshButtons()
     }
 
-    setNoteState() {
-        const protectedRanges = getProtectedRanges(this.editor.view.state)
+    setNoteState(): void {
+        if (!this.dialog) {
+            return
+        }
+        const protectedRanges: Array<{from: number; to: number}> = getProtectedRanges(this.editor.view.state)
         const matches = this.matches.matches.slice()
         let matchWithinPR = false
         while (matches.length && !matchWithinPR) {
             const match = matches.pop()
             if (
+                match &&
                 protectedRanges.find(
                     ({from, to}) =>
                         !(
@@ -339,13 +383,13 @@ export class SearchReplaceDialog {
         this.dialog.refreshNote()
     }
 
-    updateResultCount() {
+    updateResultCount(): void {
         const totalMatches =
             this.matches.matches.length + this.fnMatches.matches.length
         this.resultCountEl.textContent = `(${totalMatches})`
     }
 
-    bind() {
+    bind(): void {
         this.searchInput.addEventListener("input", () => {
             this.search(this.searchInput.value)
             this.setNoteState()
@@ -357,10 +401,10 @@ export class SearchReplaceDialog {
         }
     }
 
-    onUpdate() {
+    onUpdate(): void {
         this.matches = getSearchMatches(this.editor.view.state)
         this.fnMatches = getSearchMatches(
-            this.editor.mod.footnotes.fnEditor.view.state
+            (this.editor.mod as any).footnotes.fnEditor.view.state
         )
         const selectedSearch = document.querySelector(
             "#paper-editable .fw-search.fw-selected"
@@ -374,7 +418,7 @@ export class SearchReplaceDialog {
         this.updateResultCount()
     }
 
-    search(term) {
+    search(term: string): void {
         const setSearchTermResult = setSearchTerm(
             this.editor.view.state,
             term,
@@ -384,11 +428,13 @@ export class SearchReplaceDialog {
         let {tr} = setSearchTermResult
         const {matches, selected} = setSearchTermResult
         const setSearchTermResultFn = setSearchTerm(
-            this.editor.mod.footnotes.fnEditor.view.state,
+            (this.editor.mod as any).footnotes.fnEditor.view.state,
             term,
-            this.editor.mod.footnotes.fnEditor.view === this.editor.currentView
+            (this.editor.mod as any).footnotes.fnEditor.view ===
+                this.editor.currentView
                 ? 0
-                : false
+                : false,
+            this
         )
         let {tr: fnTr} = setSearchTermResultFn
         const {matches: fnMatches, selected: fnSelected} = setSearchTermResultFn
@@ -401,21 +447,21 @@ export class SearchReplaceDialog {
                 tr = setSearchTerm(this.editor.view.state, term, 0, this).tr
             } else {
                 fnTr = setSearchTerm(
-                    this.editor.mod.footnotes.fnEditor.view.state,
+                    (this.editor.mod as any).footnotes.fnEditor.view.state,
                     term,
                     0
                 ).tr
             }
         }
-        this.editor.mod.footnotes.fnEditor.view.dispatch(fnTr)
+        ;(this.editor.mod as any).footnotes.fnEditor.view.dispatch(fnTr)
         this.editor.view.dispatch(tr)
         this.updateResultCount()
     }
 
-    endSearch() {
+    endSearch(): void {
         this.editor.view.dispatch(endSearch(this.editor.view.state))
-        this.editor.mod.footnotes.fnEditor.view.dispatch(
-            endSearch(this.editor.mod.footnotes.fnEditor.view.state)
+        ;(this.editor.mod as any).footnotes.fnEditor.view.dispatch(
+            endSearch((this.editor.mod as any).footnotes.fnEditor.view.state)
         )
     }
 }

package/src/tools/search_replace/{templates.js → templates.ts}

@@ -1,4 +1,9 @@
-export const searchDialogTemplate = ({canWrite}) => `<table class="fw-dialog-table">
+interface SearchDialogParams {
+    canWrite: boolean
+}
+
+export const searchDialogTemplate = ({canWrite}: SearchDialogParams) =>
+    `<table class="fw-dialog-table">
     <tbody>
         <tr>
             <th><h4 class="fw-tablerow-title">${gettext("Find")}</h4></th>

package/src/tools/word_count/{index.js → index.ts}

@@ -2,30 +2,40 @@ import {getNonDeletedTextContent} from "@fiduswriter/document/schema/text"
 import {Dialog} from "fwtoolkit"
 
 import {wordCounterDialogTemplate} from "./templates.js"
+import type {Editor} from "../../types.js"
 
 export class WordCountDialog {
-    constructor(editor) {
+    editor: Editor
+
+    constructor(editor: Editor) {
         this.editor = editor
     }
 
-    init() {
+    init(): void {
         const dialog = new Dialog({
             title: gettext("Word counter"),
             body: wordCounterDialogTemplate(this.countWords()),
-            buttons: [{type: "close"}]
+            buttons: [{type: "close" as const}]
         })
         dialog.open()
     }
 
-    countWords() {
+    countWords(): {
+        docNumWords: number
+        docNumNoSpace: number
+        docNumChars: number
+        selectionNumWords: number
+        selectionNumNoSpace: number
+        selectionNumChars: number
+    } {
         const textContent = getNonDeletedTextContent(
                 this.editor.view.state.doc
             ),
             footnoteContent = getNonDeletedTextContent(
-                this.editor.mod.footnotes.fnEditor.view.state.doc
+                (this.editor.mod.footnotes as {fnEditor: {view: {state: {doc: import("prosemirror-model").Node}}}}).fnEditor.view.state.doc
             ),
             bibliographyContent =
-                document.querySelector(".doc-bibliography").textContent
+                document.querySelector(".doc-bibliography")?.textContent || ""
         const docContent =
             textContent + " " + footnoteContent + " " + bibliographyContent
         const docNumChars = docContent.split("\n").join("").length - 2 // Subtract two for added spaces

package/src/tools/word_count/{templates.js → templates.ts}

@@ -1,3 +1,12 @@
+interface WordCountParams {
+    docNumWords: number
+    docNumNoSpace: number
+    docNumChars: number
+    selectionNumWords: number
+    selectionNumNoSpace: number
+    selectionNumChars: number
+}
+
 export const wordCounterDialogTemplate = ({
     docNumWords,
     docNumNoSpace,
@@ -5,7 +14,7 @@ export const wordCounterDialogTemplate = ({
     selectionNumWords,
     selectionNumNoSpace,
     selectionNumChars
-}) =>
+}: WordCountParams) =>
     `<table class="fw-data-table">
         <thead class="fw-data-table-header">
             <tr>

package/src/track/{accept.js → accept.ts}

@@ -1,20 +1,31 @@
 import {AddMarkStep, Mapping, RemoveMarkStep} from "prosemirror-transform"
+import type {Node} from "prosemirror-model"
+import type {EditorView} from "prosemirror-view"
 
-import {deactivateAllSelectedChanges} from "../state_plugins/index.js"
+import {deactivateAllSelectedChanges} from "../state_plugins/track/index.js"
 
 import {deleteNode} from "./delete.js"
 
-export const accept = (type, pos, view) => {
+export const accept = (
+    type: string,
+    pos: number,
+    view: EditorView
+): void => {
     const tr = view.state.tr.setMeta("track", true),
         map = new Mapping()
     let reachedEnd = false
-    const trackMark = view.state.doc
-        .nodeAt(pos)
-        .marks.find(mark => mark.type.name === type)
+    const nodeAtPos = view.state.doc.nodeAt(pos)
+    if (!nodeAtPos) {
+        return
+    }
+    const trackMark = nodeAtPos.marks.find(mark => mark.type.name === type)
+    if (!trackMark) {
+        return
+    }
     view.state.doc.nodesBetween(
         pos,
         view.state.doc.nodeSize - 2,
-        (node, nodePos) => {
+        (node: Node, nodePos: number) => {
             if (nodePos < pos) {
                 return true
             }
@@ -36,10 +47,10 @@ export const accept = (type, pos, view) => {
                     deleteNode(tr, node, nodePos, map, true)
                 } else if (type === "insertion") {
                     if (node.attrs.track) {
-                        const track = node.attrs.track.filter(
+                        const track = (node.attrs.track as Array<{type: string}>).filter(
                             track => track.type !== "insertion"
                         )
-                        if (node.attrs.track.length === track) {
+                        if ((node.attrs.track as Array<{type: string}>).length === track.length) {
                             return true
                         }
                         tr.setNodeMarkup(
@@ -78,7 +89,7 @@ export const accept = (type, pos, view) => {
                         )
                     )
                 } else if (type === "block_change") {
-                    const track = node.attrs.track.filter(
+                    const track = (node.attrs.track as Array<{type: string}>).filter(
                         track => track.type !== "block_change"
                     )
                     tr.setNodeMarkup(