@fiduswriter/editor 0.1.49 → 0.1.50

package/src/clipboard/copy/serializers.ts

@@ -43,7 +43,7 @@ class ClipboardDOMSerializer {
             settings.citationstyle,
             bibliographyHeader,
             (this.editor.mod.db as any).bibDB,
-            (this.editor.app as any).csl,
+            this.editor.app.csl,
             true // synchronous. Should work as the editor has used the same style previously.
         )
         const fm = citRenderer.fm as any

package/src/collab/doc.ts

@@ -1439,7 +1439,7 @@ export class ModCollabDoc {
                 rid: data["rid"],
                 footnoterender: data["footnoterender"],
                 reject_request_id: data["reject_request_id"],
-                ...decryptedPayload
+                ...(decryptedPayload as Record<string, unknown>)
             }
 
             // Process the decrypted diff normally

package/src/collab/merge/index.ts

@@ -444,6 +444,7 @@ export class Merge {
 
         // Prepare Export
         new ExportFidusFile(
+            this.mod.editor.app,
             this.getDocData(offlineDoc),
             this.mod.editor.mod.db!.bibDB,
             this.mod.editor.mod.db!.imageDB

package/src/comments/editors/comment.ts

@@ -297,7 +297,12 @@ export class CommentEditor {
             const comment = this.view.state.doc,
                 docId = this.mod.editor.docInfo.id as number
             newUserTags.forEach(userId =>
-                notifyMentionedUser(docId, userId, comment)
+                notifyMentionedUser(
+                    this.mod.editor.app.apiConnectors.document,
+                    docId,
+                    userId,
+                    comment
+                )
             )
         }
     }

package/src/comments/editors/notify.ts

@@ -1,14 +1,15 @@
-import {post} from "fwtoolkit"
 import {serializeCommentNode} from "./schema.js"
 import type {Node} from "prosemirror-model"
+import type {EditorDocumentApi} from "../../types.js"
 
 export const notifyMentionedUser = (
+    documentApi: EditorDocumentApi,
     docId: number,
     userId: number,
     comment: Node
 ) => {
     const {html, text} = serializeCommentNode(comment)
-    return post("/api/document/comment_notify/", {
+    return documentApi.commentNotify({
         doc_id: docId,
         collaborator_id: userId,
         comment_html: html,

package/src/comments/interactions.ts

@@ -3,7 +3,7 @@ import {TextSelection} from "prosemirror-state"
 import {GapCursor} from "prosemirror-gapcursor"
 import type {EditorView} from "prosemirror-view"
 
-import {findTarget, post} from "fwtoolkit"
+import {findTarget} from "fwtoolkit"
 import {READ_ONLY_ROLES} from "../index.js"
 import type {Editor} from "../types.js"
 import {
@@ -389,7 +389,7 @@ export class ModCommentInteractions {
         const comment = this.mod.store.findComment(id)
         const {html, text} = serializeComment(comment.comment)
 
-        post("/api/document/comment_notify/", {
+        this.mod.editor.app.apiConnectors.document.commentNotify({
             doc_id: this.mod.editor.docInfo.id,
             collaborator_id: user,
             comment_html: html,

package/src/contacts/add_dialog.ts

@@ -1,5 +1,6 @@
-import {Dialog, cancelPromise, escapeText, postJson} from "fwtoolkit"
+import {Dialog, cancelPromise, escapeText} from "fwtoolkit"
 import {addContactTemplate} from "./templates.js"
+import type {EditorContactsApi} from "../types.js"
 
 interface ContactResponse {
     contact?: unknown
@@ -9,9 +10,14 @@ interface ContactResponse {
 //dialog for adding a user to contacts
 export class AddContactDialog {
     settings: Record<string, unknown>
+    contactsApi: EditorContactsApi
 
-    constructor(settings: Record<string, unknown>) {
+    constructor(
+        settings: Record<string, unknown>,
+        contactsApi: EditorContactsApi
+    ) {
         this.settings = settings
+        this.contactsApi = contactsApi
     }
 
     init(): Promise<unknown[]> {
@@ -91,24 +97,25 @@ export class AddContactDialog {
             return cancelPromise()
         }
 
-        const {json, status} = (await postJson("/api/user/invites/add/", {
+        const {json, status} = await this.contactsApi.add({
             user_string: userString
-        })) as {json: ContactResponse; status: number}
+        })
+        const data = json as ContactResponse
         if (status == 201) {
             //user added to the contacts
-            return json.contact
+            return data.contact
         } else {
             //user not found
             let responseHtml
-            if (json.error === 1) {
+            if (data.error === 1) {
                 responseHtml = gettext(
                     "You cannot add yourself to your contacts!"
                 )
-            } else if (json.error === 2) {
+            } else if (data.error === 2) {
                 responseHtml = gettext(
                     "This person is already in your contacts!"
                 )
-            } else if (json.error === 3) {
+            } else if (data.error === 3) {
                 responseHtml = gettext("Invalid email!")
             }
             document

package/src/databases/images.ts

@@ -9,7 +9,7 @@
  For E2EE documents, images are encrypted client-side and uploaded directly
  via a dedicated endpoint to an EncryptedDocumentImage model.
 */
-import {addAlert, get, post, postJson} from "fwtoolkit"
+import {addAlert, get} from "fwtoolkit"
 
 import type {Editor} from "../types.js"
 
@@ -60,7 +60,7 @@ export class ModImageDB {
         // Set a timeout so that the update can be combines with other updates
         // if they happen more or less simultaneously.
         window.setTimeout(
-            () => (this.mod as any).editor.mod.collab.doc.sendToCollaborators(),
+            () => this.mod.editor.mod.collab!.doc.sendToCollaborators(),
             100
         )
     }
@@ -79,7 +79,9 @@ export class ModImageDB {
         const isE2EE = this.mod.editor.e2ee?.encrypted === true
         if (!isE2EE) {
             // Non-E2EE documents must use the user's imageDB
-            return (this.mod.editor.app as any).imageDB.saveImage(imageData)
+            return this.mod.editor.app.imageDB.saveImage(
+                imageData as unknown as Record<string, unknown>
+            )
         }
 
         // E2EE path: upload encrypted image directly to the document
@@ -103,7 +105,8 @@ export class ModImageDB {
             }
         }
 
-        return postJson("/api/document/e2ee_image/", jsonData, files)
+        return this.mod.editor.app.apiConnectors.document
+            .saveE2EEImage(jsonData, files)
             .then(({json}: {json: any}) => {
                 const dbEntry: ImageEntry = {
                     id: json.id,
@@ -122,7 +125,7 @@ export class ModImageDB {
                 this.setImage(json.id, dbEntry)
                 return json.id
             })
-            .catch(error => {
+            .catch((error: unknown) => {
                 addAlert("error", gettext("Could not save encrypted image"))
                 throw error
             })
@@ -160,12 +163,14 @@ export class ModImageDB {
     }
 
     deleteE2EEImageFromServer(id: number): void {
-        post("/api/document/delete_e2ee_image/", {
-            doc_id: this.mod.editor.docInfo.id,
-            image_id: id
-        }).catch(() => {
-            // Silently ignore — orphaned image records are acceptable
-        })
+        this.mod.editor.app.apiConnectors.document
+            .deleteE2EEImage({
+                doc_id: this.mod.editor.docInfo.id as number,
+                image_id: id
+            })
+            .catch(() => {
+                // Silently ignore — orphaned image records are acceptable
+            })
     }
 
     deleteLocalImage(id: number): void {
@@ -186,10 +191,10 @@ export class ModImageDB {
             // document's unique key and are not reusable across documents.
             return
         }
-        const appImageDB = (this.mod.editor.app as any).imageDB
+        const appImageDB = this.mod.editor.app.imageDB
         if (Object.keys(appImageDB.db).includes(String(id))) {
             // Just directly reset the image as we already have the image present in user Image DB
-            this.setImage(id, appImageDB.db[id])
+            this.setImage(id, appImageDB.db[id] as unknown as ImageEntry)
         } else {
             // If image is not present in both the userImage DB and docDB we can safely assume that we have to upload again.
             this.reUploadImage(
@@ -256,15 +261,13 @@ export class ModImageDB {
                             cats: [],
                             copyright: copyright
                         }
-                        ;(this.mod.editor.app as any).imageDB.saveImage(x).then(
+                        this.mod.editor.app.imageDB.saveImage(x).then(
                             (newId: number) => {
                                 const imageData = JSON.parse(
                                     JSON.stringify(
-                                        (this.mod.editor.app as any).imageDB.db[
-                                            newId
-                                        ]
+                                        this.mod.editor.app.imageDB.db[newId]
                                     )
-                                )
+                                ) as unknown as ImageEntry
                                 this.setImage(newId, imageData)
                                 this.mod.editor.view.state.doc.descendants(
                                     (node, pos) => {

package/src/dialogs/citation.ts

@@ -160,8 +160,8 @@ export class CitationDialog {
                 )
             )
         })
-        Object.keys((this.editor.app as any).bibDB.db).forEach(id => {
-            const bib = (this.editor.app as any).bibDB.db[id]
+        Object.keys(this.editor.app.bibDB!.db).forEach(id => {
+            const bib = this.editor.app.bibDB!.db[id]
             if (!(this.editor.mod.db as any).bibDB.hasReference(bib)) {
                 data.push(this.createTableRow(bib, Number.parseInt(id), "user"))
             }
@@ -457,7 +457,7 @@ export class CitationDialog {
                 if (db === "user") {
                     // entry is from user's bibDB. We need to import it into the
                     // document's bibDB.
-                    const bib = (this.editor.app as any).bibDB.db[id]
+                    const bib = this.editor.app.bibDB!.db[String(id)]
                     id = (this.editor.mod.db as any).bibDB.addReference(bib, id)
                 }
                 const returnObj: CitationReference = {

package/src/document_template/exporter.ts

@@ -2,7 +2,6 @@ import download from "downloadjs"
 
 import {createSlug} from "@fiduswriter/document/exporter/tools/file"
 import {ZipFileCreator} from "fwtoolkit/file/zip"
-import {postJson} from "fwtoolkit"
 
 interface HttpFile {
     filename: string
@@ -33,7 +32,10 @@ interface TemplateResponse {
 
 export class DocumentTemplateExporter {
     id: number | string
-    getUrl: string
+    getTemplateForDoc: (
+        id: number | string,
+        token: string | false
+    ) => Promise<{json: unknown; status: number}>
     download: boolean
     token: string | false
     zipFileName: string | false
@@ -43,12 +45,15 @@ export class DocumentTemplateExporter {
 
     constructor(
         id: number | string,
-        getUrl = "/api/document/admin/get_template/",
+        getTemplateForDoc: (
+            id: number | string,
+            token: string | false
+        ) => Promise<{json: unknown; status: number}>,
         download = true,
         token: string | false = false
     ) {
         this.id = id
-        this.getUrl = getUrl
+        this.getTemplateForDoc = getTemplateForDoc
         this.download = download
         this.token = token
 
@@ -59,10 +64,7 @@ export class DocumentTemplateExporter {
     }
 
     init(): Promise<void> {
-        const params = this.token
-            ? {id: this.id, token: this.token}
-            : {id: this.id}
-        return postJson(this.getUrl, params).then(({json}) => {
+        return this.getTemplateForDoc(this.id, this.token).then(({json}) => {
             const data = json as TemplateResponse
             this.docVersion = data.doc_version
             this.zipFileName = `${createSlug(data.title)}.fidustemplate`

package/src/document_template/index.ts

@@ -224,7 +224,8 @@ export class ModDocumentTemplate {
                                                 "select"
                                             ) as HTMLSelectElement
                                         ).value as any,
-                                        e2eeOptions
+                                        e2eeOptions,
+                                        editor.app.apiConnectors.documentImport
                                     )
                                     copier
                                         .init()
@@ -232,7 +233,7 @@ export class ModDocumentTemplate {
                                             const url = targetE2EE
                                                 ? `/document/${docInfo.id}/?e2ee=1`
                                                 : `/document/${docInfo.id}/`
-                                            ;(editor.app as any).goTo(url)
+                                            editor.app.goTo(url)
                                         })
                                         .catch(() => false)
                                     selectTemplateDialog.close()

package/src/documents/access_rights/index.ts

@@ -6,13 +6,12 @@ import {
     enableDatePicker,
     ensureCSS,
     findTarget,
-    post,
-    postJson,
     setCheckableLabel
 } from "fwtoolkit"
 import type {ContentMenuInit} from "fwtoolkit/content_menu"
 
 import {AddContactDialog} from "../../contacts/add_dialog.js"
+import type {EditorContactsApi, EditorDocumentApi} from "../../types.js"
 import {
     collaboratorsTemplate,
     contactsTemplate,
@@ -66,6 +65,8 @@ interface AccessRightsTabOptions {
     onShareSuccess?: (accessRights: AccessRight[]) => void
     settings: Record<string, unknown>
     container?: HTMLElement | null
+    documentApi: EditorDocumentApi
+    contactsApi: EditorContactsApi
 }
 
 interface AccessRightMenuItem {
@@ -146,6 +147,8 @@ export class AccessRightsTab {
     container: HTMLElement | null
     accessRights: AccessRight[]
     dialogTabs!: DialogTabs
+    documentApi: EditorDocumentApi
+    contactsApi: EditorContactsApi
 
     constructor({
         documentIds,
@@ -155,7 +158,9 @@ export class AccessRightsTab {
         documentPassword = "",
         onShareSuccess,
         settings,
-        container = null
+        container = null,
+        documentApi,
+        contactsApi
     }: AccessRightsTabOptions) {
         this.documentIds = documentIds
         this.contacts = contacts
@@ -168,12 +173,15 @@ export class AccessRightsTab {
         this.settings = settings
         this.container = container || null
         this.accessRights = []
+        this.documentApi = documentApi
+        this.contactsApi = contactsApi
     }
 
     load(): Promise<void> {
-        return postJson("/api/document/get_access_rights/", {
-            document_ids: this.documentIds
-        })
+        return this.documentApi
+            .getAccessRights({
+                document_ids: this.documentIds
+            })
             .catch(error => {
                 addAlert("error", gettext("Cannot load document access data."))
                 throw error
@@ -521,9 +529,8 @@ export class AccessRightsTab {
             return
         }
         listEl.innerHTML = `<p class="fw-ar-loading">${gettext("Loading…")}</p>`
-        postJson("/api/document/share_token/list/", {
-            document_id: this.singleDocumentId
-        })
+        this.documentApi
+            .listShareTokens(this.singleDocumentId as number)
             .then(({json}: {json: unknown}) => {
                 const data = json as {tokens: ShareToken[]}
                 listEl.innerHTML = shareTokenListTemplate({
@@ -564,12 +571,13 @@ export class AccessRightsTab {
                                 "#share-token-note"
                             ) as HTMLInputElement
                         ).value.trim()
-                        postJson("/api/document/share_token/create/", {
-                            document_id: this.singleDocumentId,
-                            rights,
-                            expires_at: expiresRaw || "",
-                            note
-                        })
+                        this.documentApi
+                            .createShareToken({
+                                document_id: this.singleDocumentId,
+                                rights,
+                                expires_at: expiresRaw || "",
+                                note
+                            } as Record<string, unknown>)
                             .then(({json}: {json: unknown}) => {
                                 const data = json as ShareToken
                                 let shareUrl = data.share_url
@@ -624,7 +632,8 @@ export class AccessRightsTab {
     }
 
     revokeShareToken(tokenId: number, rowEl: HTMLElement): void {
-        postJson("/api/document/share_token/revoke/", {token_id: tokenId})
+        this.documentApi
+            .revokeShareToken(tokenId)
             .then(({json}: {json: unknown}) => {
                 const data = json as {success: boolean}
                 if (data.success) {
@@ -648,10 +657,11 @@ export class AccessRightsTab {
 
     submit(): Promise<void> {
         const accessRights = collectAccessRights(this.container!)
-        return post("/api/document/save_access_rights/", {
-            document_ids: this.documentIds,
-            access_rights: accessRights
-        })
+        return this.documentApi
+            .saveAccessRights({
+                document_ids: this.documentIds,
+                access_rights: accessRights
+            })
             .then(() => {
                 addAlert("success", gettext("Access rights have been saved"))
                 if (this.onShareSuccess) {
@@ -676,6 +686,8 @@ export class DocumentAccessRightsDialog {
     documentPassword: string
     onShareSuccess?: (accessRights: AccessRight[]) => void
     settings: Record<string, unknown>
+    contactsApi: EditorContactsApi
+    documentApi: EditorDocumentApi
     tab!: AccessRightsTab
     dialog!: Dialog
 
@@ -686,7 +698,9 @@ export class DocumentAccessRightsDialog {
         e2ee: boolean,
         documentPassword = "",
         onShareSuccess?: (accessRights: AccessRight[]) => void,
-        settings: Record<string, unknown> = {}
+        settings: Record<string, unknown> = {},
+        contactsApi?: EditorContactsApi,
+        documentApi?: EditorDocumentApi
     ) {
         this.documentIds = documentIds
         this.contacts = contacts
@@ -695,6 +709,8 @@ export class DocumentAccessRightsDialog {
         this.documentPassword = documentPassword
         this.onShareSuccess = onShareSuccess
         this.settings = settings
+        this.contactsApi = contactsApi as EditorContactsApi
+        this.documentApi = documentApi as EditorDocumentApi
     }
 
     init(): void {
@@ -705,7 +721,9 @@ export class DocumentAccessRightsDialog {
             e2ee: this.e2ee,
             documentPassword: this.documentPassword,
             onShareSuccess: this.onShareSuccess,
-            settings: this.settings
+            settings: this.settings,
+            documentApi: this.documentApi,
+            contactsApi: this.contactsApi
         })
         this.tab.load().then(() => this.createDialog())
     }
@@ -722,7 +740,10 @@ export class DocumentAccessRightsDialog {
                         : gettext("Add contact"),
                 classes: "fw-light fw-add-button",
                 click: () => {
-                    const dialog = new AddContactDialog(this.settings)
+                    const dialog = new AddContactDialog(
+                        this.settings,
+                        this.contactsApi
+                    )
                     dialog.init().then(contactsData => {
                         ;(contactsData as Contact[]).forEach(contactData => {
                             if (contactData.id) {

package/src/exporter/native/copy.ts

@@ -9,9 +9,10 @@ import type {
 } from "@fiduswriter/document"
 import {SaveCopy as GenericSaveCopy} from "@fiduswriter/document/exporter/native"
 import {NativeImporter} from "@fiduswriter/document/importer/native"
-import {addAlert, addProgress, gettext, postJson, shortFileTitle} from "fwtoolkit"
+import {addAlert, addProgress, gettext, shortFileTitle} from "fwtoolkit"
 import {E2EEEncryptor} from "fwtoolkit/e2ee/encryptor"
 import {E2EEKeyManager} from "fwtoolkit/e2ee/key-manager"
+import type {EditorDocumentImportApi} from "../../types.js"
 
 type ProgressCallback = (message: string, percentage?: number | null) => void
 
@@ -115,7 +116,8 @@ async function maybeDecryptImage(
 
 function createNativeImporterBackend(
     _user: User,
-    _e2eeOptions: E2EEOptions | null
+    _e2eeOptions: E2EEOptions | null,
+    documentImportApi: EditorDocumentImportApi
 ): NativeImporterBackend {
     return {
         createDoc: (template, importId, path, e2ee, files) => {
@@ -140,7 +142,8 @@ function createNativeImporterBackend(
                     jsonData.e2ee_iterations = e2ee.iterations
                 }
             }
-            return postJson("/api/document/import/create/", jsonData, files)
+            return documentImportApi
+                .createDoc(jsonData, files)
                 .then(({json}) => {
                     const data = json as Record<string, unknown>
                     return {
@@ -157,9 +160,6 @@ function createNativeImporterBackend(
         },
         saveImages: async (images, docId, e2ee) => {
             const isE2EE = e2ee?.enabled
-            const endpoint = isE2EE
-                ? "/api/document/e2ee_image/"
-                : "/api/document/import/image/"
             const imageTranslationTable: Record<number | string, number> = {}
             await Promise.all(
                 Object.values(images.db).map(async imageEntry => {
@@ -184,7 +184,9 @@ function createNativeImporterBackend(
                             filename: entry.image.split("/").pop() as string
                         }
                     }
-                    const {json} = await postJson(endpoint, jsonData, files)
+                    const {json} = isE2EE
+                        ? await documentImportApi.saveE2EEImage(jsonData, files)
+                        : await documentImportApi.saveImage(jsonData, files)
                     const response = json as Record<string, unknown>
                     imageTranslationTable[entry.id] = response.id as number
                 })
@@ -210,7 +212,8 @@ function createNativeImporterBackend(
                     e2ee.key
                 )
             }
-            return postJson("/api/document/import/", saveData)
+            return documentImportApi
+                .saveDocument(saveData)
                 .then(({json}) => {
                     const data = json as Record<string, unknown>
                     return {
@@ -243,7 +246,8 @@ export class SaveCopy extends GenericSaveCopy {
         imageDB: ImageDB,
         newUser: User,
         importId: string | number | null = null,
-        e2eeOptions: E2EEOptions | null = null
+        e2eeOptions: E2EEOptions | null = null,
+        documentImportApi?: EditorDocumentImportApi
     ) {
         const title = shortFileTitle(doc.title as string, (doc.path as string) || "")
         const task = addProgress(
@@ -282,7 +286,11 @@ export class SaveCopy extends GenericSaveCopy {
                     content: Blob | ArrayBuffer | string
                 }>,
                 opts.user,
-                createNativeImporterBackend(opts.user, opts.e2eeOptions ?? null),
+                createNativeImporterBackend(
+                    opts.user,
+                    opts.e2eeOptions ?? null,
+                    documentImportApi as EditorDocumentImportApi
+                ),
                 {
                     importId: opts.importId,
                     requestedPath: opts.requestedPath,

package/src/exporter/native/file.ts

@@ -2,9 +2,17 @@ import type {BibDB, ExportDoc, ImageDB} from "@fiduswriter/document"
 import {ExportFidusFile as GenericExportFidusFile} from "@fiduswriter/document/exporter/native"
 import {addProgress, gettext, shortFileTitle} from "fwtoolkit"
 import {DocumentTemplateExporter} from "../../document_template/exporter.js"
+import type {EditorDocumentApi} from "../../types.js"
+
+interface ExportFidusFileApp {
+    apiConnectors: {
+        document: Pick<EditorDocumentApi, "getTemplateForDoc">
+    }
+}
 
 export class ExportFidusFile extends GenericExportFidusFile {
     constructor(
+        app: ExportFidusFileApp,
         doc: ExportDoc,
         bibDB: BibDB,
         imageDB: ImageDB,
@@ -22,7 +30,7 @@ export class ExportFidusFile extends GenericExportFidusFile {
         const getTemplateFiles = (docId: number | string, token: string | boolean) => {
             const templateExporter = new DocumentTemplateExporter(
                 docId,
-                "/api/document/get_template_for_doc/",
+                app.apiConnectors.document.getTemplateForDoc,
                 false,
                 token as string | false
             )

package/src/exporter/native/revision.ts

@@ -1,7 +1,7 @@
 import type {BibDB, ExportDoc, ImageDB, UploadRevision} from "@fiduswriter/document"
 import {SaveRevision as GenericSaveRevision} from "@fiduswriter/document/exporter/native"
 import {createSlug} from "@fiduswriter/document/exporter/tools/file"
-import {addAlert, addProgress, gettext, post, shortFileTitle} from "fwtoolkit"
+import {addAlert, addProgress, gettext, shortFileTitle} from "fwtoolkit"
 import type {EditorApp} from "../../types.js"
 import {DocumentTemplateExporter} from "../../document_template/exporter.js"
 
@@ -40,7 +40,7 @@ export class SaveRevision extends GenericSaveRevision {
         const getTemplateFiles = (docId: number | string, token: string | boolean) => {
             const templateExporter = new DocumentTemplateExporter(
                 docId,
-                "/api/document/get_template_for_doc/",
+                app.apiConnectors.document.getTemplateForDoc,
                 false,
                 token as string | false
             )
@@ -51,21 +51,21 @@ export class SaveRevision extends GenericSaveRevision {
         }
 
         const uploadRevision: UploadRevision = (blob, doc) => {
-            return post(
-                "/api/document/upload/",
-                {
-                    note,
-                    document_id: doc.id
-                },
-                {
-                    file: {
-                        file: blob,
-                        filename: `${createSlug(
-                            shortFileTitle(doc.title as string, doc.path as string)
-                        )}.fidus`
+            return app.apiConnectors.document
+                .uploadRevision(
+                    {
+                        note,
+                        document_id: doc.id as number
+                    },
+                    {
+                        file: {
+                            file: blob,
+                            filename: `${createSlug(
+                                shortFileTitle(doc.title as string, doc.path as string)
+                            )}.fidus`
+                        }
                     }
-                }
-            )
+                )
                 .then(
                     () => {},
                     () => {