@fiduswriter/editor 0.1.20 → 0.1.21

package/src/comments/{store.js → store.ts}

@@ -1,44 +1,78 @@
+import type {Node as ProseMirrorNode} from "prosemirror-model"
+import type {Transaction} from "prosemirror-state"
+import type {EditorView} from "prosemirror-view"
 import {randomCommentId} from "@fiduswriter/document/schema/common/index"
+
+import type {Editor} from "../types.js"
 import {
     addCommentDuringCreationDecoration,
     removeCommentDuringCreationDecoration
 } from "../state_plugins/index.js"
 import {Comment} from "./comment.js"
 
+interface StoreMod {
+    editor: Editor
+    interactions: {
+        isCurrentlyEditing(): boolean
+        activeCommentId: string | number | boolean
+        activateComment(id: string | number): void
+    }
+    [key: string]: any
+}
+
+interface CommentDuringCreation {
+    comment: Comment
+    inDOM: boolean
+    view: EditorView | null
+}
+
+interface UnsentEvent {
+    type: string
+    id?: string | number
+    answerId?: string | number
+}
+
 export class ModCommentStore {
-    constructor(mod) {
+    mod: StoreMod
+    commentDuringCreation: CommentDuringCreation | false
+    comments: Record<number | string, Comment>
+    unsent: UnsentEvent[]
+
+    constructor(mod: StoreMod) {
         mod.store = this
         this.mod = mod
         // a comment object for a comment that is still under construction
         this.commentDuringCreation = false
-        this.reset()
+        this.comments = {}
+        this.unsent = []
     }
 
-    reset() {
-        this.comments = Object.create(null)
+    reset(): void {
+        this.comments = {}
         this.unsent = []
     }
 
-    findComment(id) {
-        let found = false
+    findComment(id: number | string): Comment | false {
         if (id in this.comments) {
-            found = this.comments[id]
+            return this.comments[id]
         }
-        return found
+        return false
     }
 
-    mustSend() {
+    mustSend(): void {
         // Set a timeout so that the update can be combines with other updates
         // if they happen more or less simultaneously.
         window.setTimeout(
-            () => this.mod.editor.mod.collab.doc.sendToCollaborators(),
+            () =>
+                (this.mod.editor.mod as any).collab.doc.sendToCollaborators(),
             100
         )
     }
+
     // Create a new temporary comment. This one is not going into the store yet,
     // as it is empty, shouldn't be shared and if canceled, it should go away
     // entirely.
-    addCommentDuringCreation(view) {
+    addCommentDuringCreation(view: EditorView): void {
         const state = view.state,
             tr = addCommentDuringCreationDecoration(state, state.tr)
 
@@ -49,14 +83,14 @@ export class ModCommentStore {
 
         view.dispatch(tr)
 
-        let username
+        let username: string
 
         if (
             ["review", "review-tracked"].includes(
-                this.mod.editor.docInfo.access_rights
+                this.mod.editor.docInfo.access_rights as string
             )
         ) {
-            username = `${gettext("Reviewer")} ${this.mod.editor.user.id}`
+            username = `${gettext("Reviewer")} ${(this.mod.editor.user as any).id}`
         } else {
             username = this.mod.editor.user.username
         }
@@ -64,9 +98,10 @@ export class ModCommentStore {
         this.commentDuringCreation = {
             comment: new Comment({
                 id: "-1",
-                user: this.mod.editor.user.id,
+                user: (this.mod.editor.user as any).id,
                 username,
-                date: Date.now() - this.mod.editor.clientTimeAdjustment
+                date: Date.now() - this.mod.editor.clientTimeAdjustment,
+                isGlobal: true
             }),
             inDOM: false,
             view
@@ -75,15 +110,15 @@ export class ModCommentStore {
 
     // Create a new temporary global comment. Like addCommentDuringCreation,
     // this is not shared until it has content.
-    addGlobalCommentDuringCreation() {
-        let username
+    addGlobalCommentDuringCreation(): void {
+        let username: string
 
         if (
             ["review", "review-tracked"].includes(
-                this.mod.editor.docInfo.access_rights
+                this.mod.editor.docInfo.access_rights as string
             )
         ) {
-            username = `${gettext("Reviewer")} ${this.mod.editor.user.id}`
+            username = `${gettext("Reviewer")} ${(this.mod.editor.user as any).id}`
         } else {
             username = this.mod.editor.user.username
         }
@@ -91,7 +126,7 @@ export class ModCommentStore {
         this.commentDuringCreation = {
             comment: new Comment({
                 id: "-1",
-                user: this.mod.editor.user.id,
+                user: (this.mod.editor.user as any).id,
                 username,
                 date: Date.now() - this.mod.editor.clientTimeAdjustment,
                 isGlobal: true
@@ -101,7 +136,7 @@ export class ModCommentStore {
         }
     }
 
-    removeCommentDuringCreation() {
+    removeCommentDuringCreation(): void {
         if (this.commentDuringCreation) {
             const view = this.commentDuringCreation.view
             this.commentDuringCreation = false
@@ -119,7 +154,12 @@ export class ModCommentStore {
     }
 
     // Add a new comment to the comment database both remotely and locally.
-    addComment(commentData, posFrom, posTo, view) {
+    addComment(
+        commentData: any,
+        posFrom: number,
+        posTo: number,
+        view: EditorView
+    ): void {
         const id = randomCommentId(),
             markType = view.state.schema.marks.comment.create({id}),
             tr = this.addMark(view.state.tr, posFrom, posTo, markType)
@@ -138,7 +178,7 @@ export class ModCommentStore {
     }
 
     // Add a new global comment that refers to the entire document.
-    addGlobalComment(commentData) {
+    addGlobalComment(commentData: any): number | string {
         const id = randomCommentId()
         commentData.id = id
         commentData.answers = []
@@ -153,16 +193,24 @@ export class ModCommentStore {
     }
 
     // Add marks to leaf nodes and inline nodes.
-    addMark(tr, from, to, mark) {
+    addMark(
+        tr: Transaction,
+        from: number,
+        to: number,
+        mark: ProseMirrorNode["marks"][0]
+    ): Transaction | undefined {
         // add to inline nodes
         tr.addMark(from, to, mark)
         // add to leaf nodes
-        tr.doc.nodesBetween(from, to, (node, pos, parent) => {
+        tr.doc.nodesBetween(from, to, (node: ProseMirrorNode, pos: number, parent: ProseMirrorNode | null) => {
             if (!node.isLeaf) {
                 return
             }
             const marks = node.marks
-            if (!mark.isInSet(marks) && parent.type.allowsMarkType(mark.type)) {
+            if (
+                !mark.isInSet(marks) &&
+                parent && parent.type.allowsMarkType(mark.type)
+            ) {
                 const newMarks = mark.addToSet(marks)
                 tr.setNodeMarkup(pos, null, node.attrs, newMarks)
             }
@@ -173,11 +221,16 @@ export class ModCommentStore {
         return tr
     }
 
-    removeMark(tr, from, to, mark) {
+    removeMark(
+        tr: Transaction,
+        from: number,
+        to: number,
+        mark: ProseMirrorNode["marks"][0]
+    ): void {
         // remove from inline nodes
         tr.removeMark(from, to, mark)
         // remove from leaf nodes
-        tr.doc.nodesBetween(from, to, (node, pos) => {
+        tr.doc.nodesBetween(from, to, (node: ProseMirrorNode, pos: number) => {
             if (!node.isLeaf) {
                 return
             }
@@ -189,32 +242,33 @@ export class ModCommentStore {
         })
     }
 
-    loadComments(commentsData) {
+    loadComments(commentsData: Record<number | string, any>): void {
         Object.entries(commentsData).forEach(([id, comment]) =>
             this.addLocalComment(Object.assign({id}, comment))
         )
     }
 
-    addLocalComment(commentData, local) {
+    addLocalComment(commentData: any, local?: boolean): void {
         // Don't add to pastParticipants if user is undefined (e.g. new unsaved comments)
         if (
             commentData.user !== undefined &&
-            !this.mod.editor.mod.collab.pastParticipants.find(
-                participant => participant.id === commentData.user
+            !(this.mod.editor.mod as any).collab.pastParticipants.find(
+                (participant: {id: number}) => participant.id === commentData.user
             )
         ) {
-            this.mod.editor.mod.collab.pastParticipants.push({
+            ;(this.mod.editor.mod as any).collab.pastParticipants.push({
                 id: commentData.user,
                 name: commentData.username
             })
         }
         if (
             commentData.assignedUser &&
-            !this.mod.editor.mod.collab.pastParticipants.find(
-                participant => participant.id === commentData.assignedUser
+            !(this.mod.editor.mod as any).collab.pastParticipants.find(
+                (participant: {id: number}) =>
+                    participant.id === commentData.assignedUser
             )
         ) {
-            this.mod.editor.mod.collab.pastParticipants.push({
+            ;(this.mod.editor.mod as any).collab.pastParticipants.push({
                 id: commentData.assignedUser,
                 name: commentData.assignedUsername || ""
             })
@@ -223,11 +277,11 @@ export class ModCommentStore {
             this.comments[commentData.id] = new Comment(commentData)
         }
         if (local || !this.mod.interactions.isCurrentlyEditing()) {
-            this.mod.editor.mod.marginboxes.updateDOM()
+            ;(this.mod.editor.mod as any).marginboxes.updateDOM()
         }
     }
 
-    updateComment(commentData) {
+    updateComment(commentData: any): void {
         this.updateLocalComment(commentData, true)
         this.unsent.push({
             type: "update",
@@ -236,14 +290,15 @@ export class ModCommentStore {
         this.mustSend()
     }
 
-    updateLocalComment(commentData, local) {
+    updateLocalComment(commentData: any, local?: boolean): void {
         if (
             commentData.assignedUser &&
-            !this.mod.editor.mod.collab.pastParticipants.find(
-                participant => participant.id === commentData.assignedUser
+            !(this.mod.editor.mod as any).collab.pastParticipants.find(
+                (participant: {id: number}) =>
+                    participant.id === commentData.assignedUser
             )
         ) {
-            this.mod.editor.mod.collab.pastParticipants.push({
+            ;(this.mod.editor.mod as any).collab.pastParticipants.push({
                 id: commentData.assignedUser,
                 name: commentData.assignedUsername || ""
             })
@@ -252,16 +307,16 @@ export class ModCommentStore {
             Object.assign(this.comments[commentData.id], commentData)
         }
         if (local || !this.mod.interactions.isCurrentlyEditing()) {
-            this.mod.editor.mod.marginboxes.updateDOM()
+            ;(this.mod.editor.mod as any).marginboxes.updateDOM()
         }
     }
 
-    removeCommentMarks(id) {
+    removeCommentMarks(id: number | string): void {
         // remove comment marks with the given ID in both views.
         ;[
             this.mod.editor.view,
-            this.mod.editor.mod.footnotes.fnEditor.view
-        ].forEach(view => {
+            (this.mod.editor.mod as any).footnotes.fnEditor.view
+        ].forEach((view: EditorView) => {
             const tr = view.state.tr,
                 markType = view.state.schema.marks.comment.create({id})
             view.state.doc.descendants((node, pos) => {
@@ -279,19 +334,23 @@ export class ModCommentStore {
         })
     }
 
-    deleteLocalComment(id, local) {
+    deleteLocalComment(id: number | string, local?: boolean): boolean {
         const found = this.comments[id]
         if (found) {
             delete this.comments[id]
+            if (local || !this.mod.interactions.isCurrentlyEditing()) {
+                ;(this.mod.editor.mod as any).marginboxes.updateDOM()
+            }
             return true
         }
         if (local || !this.mod.interactions.isCurrentlyEditing()) {
-            this.mod.editor.mod.marginboxes.updateDOM()
+            ;(this.mod.editor.mod as any).marginboxes.updateDOM()
         }
+        return false
     }
 
     // Removes the comment from store, optionally also removes marks from document.
-    deleteComment(id, removeMarks) {
+    deleteComment(id: number | string, removeMarks?: boolean): void {
         if (this.deleteLocalComment(id, true)) {
             this.unsent.push({
                 type: "delete",
@@ -304,13 +363,17 @@ export class ModCommentStore {
         }
     }
 
-    addLocalAnswer(id, answer, local) {
+    addLocalAnswer(
+        id: number | string,
+        answer: any,
+        local?: boolean
+    ): void {
         if (this.comments[id]) {
             if (!this.comments[id].answers) {
                 this.comments[id].answers = []
             }
             const answerFound = this.comments[id].answers.find(
-                Answer => Answer.id === answer.id
+                (existingAnswer: any) => existingAnswer.id === answer.id
             )
             if (!answerFound) {
                 this.comments[id].answers.push(answer)
@@ -318,14 +381,14 @@ export class ModCommentStore {
         }
 
         if (local || !this.mod.interactions.isCurrentlyEditing()) {
-            this.mod.editor.mod.marginboxes.updateDOM()
+            ;(this.mod.editor.mod as any).marginboxes.updateDOM()
             if (!local && this.mod.interactions.activeCommentId === id) {
                 this.mod.interactions.activateComment(id)
             }
         }
     }
 
-    addAnswer(id, answer) {
+    addAnswer(id: number | string, answer: any): void {
         answer.id = randomCommentId()
         this.addLocalAnswer(id, answer, true)
         this.unsent.push({
@@ -336,21 +399,25 @@ export class ModCommentStore {
         this.mustSend()
     }
 
-    deleteLocalAnswer(id, answerId, local) {
+    deleteLocalAnswer(
+        id: number | string,
+        answerId: number | string,
+        local?: boolean
+    ): void {
         if (this.comments[id]?.answers) {
             this.comments[id].answers = this.comments[id].answers.filter(
-                answer => answer.id !== answerId
+                (answer: any) => answer.id !== answerId
             )
         }
         if (local || !this.mod.interactions.isCurrentlyEditing()) {
-            this.mod.editor.mod.marginboxes.updateDOM()
+            ;(this.mod.editor.mod as any).marginboxes.updateDOM()
             if (!local && this.mod.interactions.activeCommentId === id) {
                 this.mod.interactions.activateComment(id)
             }
         }
     }
 
-    deleteAnswer(id, answerId) {
+    deleteAnswer(id: number | string, answerId: number | string): void {
         this.deleteLocalAnswer(id, answerId, true)
         this.unsent.push({
             type: "delete_answer",
@@ -360,24 +427,33 @@ export class ModCommentStore {
         this.mustSend()
     }
 
-    updateLocalAnswer(id, answerId, answerText, local) {
+    updateLocalAnswer(
+        id: number | string,
+        answerId: number | string,
+        answerText: string,
+        local?: boolean
+    ): void {
         if (this.comments[id]?.answers) {
             const answer = this.comments[id].answers.find(
-                answer => answer.id === answerId
+                (existingAnswer: any) => existingAnswer.id === answerId
             )
             if (answer) {
                 answer.answer = answerText
             }
         }
         if (local || !this.mod.interactions.isCurrentlyEditing()) {
-            this.mod.editor.mod.marginboxes.updateDOM()
+            ;(this.mod.editor.mod as any).marginboxes.updateDOM()
             if (!local && this.mod.interactions.activeCommentId === id) {
                 this.mod.interactions.activateComment(id)
             }
         }
     }
 
-    updateAnswer(id, answerId, answerText) {
+    updateAnswer(
+        id: number | string,
+        answerId: number | string,
+        answerText: string
+    ): void {
         this.updateLocalAnswer(id, answerId, answerText, true)
         this.unsent.push({
             type: "update_answer",
@@ -387,8 +463,8 @@ export class ModCommentStore {
         this.mustSend()
     }
 
-    unsentEvents() {
-        const result = []
+    unsentEvents(): any[] {
+        const result: any[] = []
         for (let i = 0; i < this.unsent.length; i++) {
             const event = this.unsent[i]
             if (event.type == "delete") {
@@ -397,7 +473,7 @@ export class ModCommentStore {
                     id: event.id
                 })
             } else if (event.type == "update") {
-                const found = this.comments[event.id]
+                const found = this.comments[event.id as number | string]
                 if (found?.id) {
                     result.push(Object.assign({type: "update"}, found))
                 } else {
@@ -406,7 +482,7 @@ export class ModCommentStore {
                     })
                 }
             } else if (event.type == "create") {
-                const found = this.comments[event.id]
+                const found = this.comments[event.id as number | string]
                 if (found?.id) {
                     result.push(Object.assign({type: "create"}, found))
                 } else {
@@ -415,11 +491,11 @@ export class ModCommentStore {
                     })
                 }
             } else if (event.type == "add_answer") {
-                const found = this.comments[event.id]
+                const found = this.comments[event.id as number | string]
                 let foundAnswer
                 if (found?.id && found?.answers) {
                     foundAnswer = found.answers.find(
-                        answer => answer.id === event.answerId
+                        (answer: any) => answer.id === event.answerId
                     )
                 }
                 if (foundAnswer) {
@@ -436,7 +512,7 @@ export class ModCommentStore {
                     })
                 }
             } else if (event.type == "delete_answer") {
-                const found = this.comments[event.id]
+                const found = this.comments[event.id as number | string]
                 if (found?.id && found?.answers) {
                     result.push({
                         type: "delete_answer",
@@ -449,11 +525,11 @@ export class ModCommentStore {
                     })
                 }
             } else if (event.type == "update_answer") {
-                const found = this.comments[event.id]
+                const found = this.comments[event.id as number | string]
                 let foundAnswer
                 if (found?.id && found?.answers) {
                     foundAnswer = found.answers.find(
-                        answer => answer.id === event.answerId
+                        (answer: any) => answer.id === event.answerId
                     )
                 }
                 if (foundAnswer) {
@@ -474,11 +550,11 @@ export class ModCommentStore {
         return result
     }
 
-    eventsSent(n) {
+    eventsSent(n: any[]): void {
         this.unsent = this.unsent.slice(n.length)
     }
 
-    receive(events) {
+    receive(events: any[]): void {
         events.forEach(event => {
             if (event.type == "delete") {
                 this.deleteLocalComment(event.id, false)

package/src/contacts/{add_dialog.js → add_dialog.ts}

@@ -1,27 +1,38 @@
 import {Dialog, cancelPromise, escapeText, postJson} from "fwtoolkit"
 import {addContactTemplate} from "./templates.js"
 
+interface ContactResponse {
+    contact?: unknown
+    error?: number
+}
+
 //dialog for adding a user to contacts
 export class AddContactDialog {
-    constructor(settings) {
+    settings: Record<string, unknown>
+
+    constructor(settings: Record<string, unknown>) {
         this.settings = settings
     }
 
-    init() {
+    init(): Promise<unknown[]> {
         return new Promise(resolve => {
             const buttons = [
                 {
                     text: gettext("Submit"),
                     classes: "fw-dark",
                     click: () => {
-                        const userString = document.getElementById(
-                            "new-contact-user-string"
+                        const userString = (
+                            document.getElementById(
+                                "new-contact-user-string"
+                            ) as HTMLInputElement
                         ).value
                         document
                             .querySelectorAll("#add-new-contact .fw-warning")
-                            .forEach(el => el.parentElement.removeChild(el))
+                            .forEach(el =>
+                                el.parentElement?.removeChild(el)
+                            )
                         const userStrings = userString.split(/[\s,;]+/)
-                        let chain = Promise.resolve([])
+                        let chain: Promise<unknown[]> = Promise.resolve([])
 
                         userStrings
                             .filter(singleUserString => singleUserString.length)
@@ -42,7 +53,7 @@ export class AddContactDialog {
                     }
                 },
                 {
-                    type: "cancel"
+                    type: "cancel" as const
                 }
             ]
 
@@ -61,12 +72,15 @@ export class AddContactDialog {
 
             dialog.open()
 
-            document.getElementById("new-contact-user-string").style.width =
-                "340"
+            ;(
+                document.getElementById(
+                    "new-contact-user-string"
+                ) as HTMLElement
+            ).style.width = "340"
         })
     }
 
-    addContact(userString) {
+    async addContact(userString: string): Promise<unknown> {
         //add a user to contact per ajax
         if (null === userString || "undefined" == typeof userString) {
             return cancelPromise()
@@ -77,34 +91,33 @@ export class AddContactDialog {
             return cancelPromise()
         }
 
-        return postJson("/api/user/invites/add/", {
+        const {json, status} = (await postJson("/api/user/invites/add/", {
             user_string: userString
-        }).then(({json, status}) => {
-            if (status == 201) {
-                //user added to the contacts
-                return json.contact
-            } else {
-                //user not found
-                let responseHtml
-                if (json.error === 1) {
-                    responseHtml = gettext(
-                        "You cannot add yourself to your contacts!"
-                    )
-                } else if (json.error === 2) {
-                    responseHtml = gettext(
-                        "This person is already in your contacts!"
-                    )
-                } else if (json.error === 3) {
-                    responseHtml = gettext("Invalid email!")
-                }
-                document
-                    .getElementById("add-new-contact")
-                    .insertAdjacentHTML(
-                        "beforeend",
-                        `<div class="fw-warning" style="padding: 8px;">${escapeText(userString)}: ${responseHtml}</div>`
-                    )
-                return cancelPromise()
+        })) as {json: ContactResponse; status: number}
+        if (status == 201) {
+            //user added to the contacts
+            return json.contact
+        } else {
+            //user not found
+            let responseHtml
+            if (json.error === 1) {
+                responseHtml = gettext(
+                    "You cannot add yourself to your contacts!"
+                )
+            } else if (json.error === 2) {
+                responseHtml = gettext(
+                    "This person is already in your contacts!"
+                )
+            } else if (json.error === 3) {
+                responseHtml = gettext("Invalid email!")
             }
-        })
+            document
+                .getElementById("add-new-contact")
+                ?.insertAdjacentHTML(
+                    "beforeend",
+                    `<div class="fw-warning" style="padding: 8px;">${escapeText(userString)}: ${responseHtml}</div>`
+                )
+            return cancelPromise()
+        }
     }
 }