@fiduswriter/editor 0.1.47 → 0.1.50

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(
                     () => {},
                     () => {

package/src/index.ts

@@ -7,7 +7,6 @@ import {
     addAlert,
     deactivateWait,
     ensureCSS,
-    postJson,
     showSystemMessage,
     whenReady
 } from "fwtoolkit"
@@ -309,19 +308,21 @@ export class Editor {
                 initPromises.push(this._createE2EEDocument())
             } else {
                 initPromises.push(
-                    postJson("/api/document/create_doc/", {
-                        template_id: this.docInfo.templateId,
-                        path: this.docInfo.path
-                    }).then(({json}: {json: any}) => {
-                        this.docInfo.id = json.id
-                        window.history.replaceState(
-                            "",
-                            "",
-                            `/document/${this.docInfo.id}/`
-                        )
-                        delete this.docInfo.templateId
-                        return Promise.resolve()
-                    })
+                    this.app.apiConnectors.document
+                        .createDocument({
+                            template_id: this.docInfo.templateId,
+                            path: this.docInfo.path
+                        })
+                        .then(({json}: {json: any}) => {
+                            this.docInfo.id = json.id
+                            window.history.replaceState(
+                                "",
+                                "",
+                                `/document/${this.docInfo.id}/`
+                            )
+                            delete this.docInfo.templateId
+                            return Promise.resolve()
+                        })
                 )
             }
         }
@@ -329,9 +330,9 @@ export class Editor {
         if (uuid4Pattern.test(this.docInfo.id)) {
             this.docInfo.token = this.docInfo.id
             initPromises.push(
-                postJson(
-                    `/api/document/share_token/validate/${this.docInfo.token}/`
-                ).then(({json, status}: {json: any; status: number}) => {
+                this.app.apiConnectors.document
+                    .validateShareToken(this.docInfo.token as string)
+                    .then(({json, status}: {json: any; status: number}) => {
                     if (status === 200 && json.document_id) {
                         this.docInfo.id = json.document_id
                         this.docInfo.access_rights = json.rights
@@ -362,22 +363,22 @@ export class Editor {
                 }
                 const editorSaveMode = this.app.settings.EDITOR_SAVE_MODE
                 const collaborativeEditing = editorSaveMode === "collaborative"
+                const documentApi = this.app.apiConnectors.document
                 const wsBasePromise = collaborativeEditing
                     ? this.docInfo.wsBase
                         ? Promise.resolve({
                               json: {ws_base: this.docInfo.wsBase}
                           })
-                        : postJson("/api/document/get_ws_base/", {
-                              id: this.docInfo.id
+                        : documentApi.getWebSocketBase({
+                              id: this.docInfo.id as number,
+                              token: this.docInfo.token
                           })
                     : Promise.resolve({json: {ws_base: ""}})
-                const stylesPromise = postJson(
-                    "/api/document/get_doc_styles/",
-                    stylesPayload
+                const stylesPromise = documentApi.getDocumentStyles(
+                    stylesPayload as {id: number; token?: string}
                 )
-                const docDataPromise = postJson(
-                    "/api/document/get_doc_data/",
-                    stylesPayload
+                const docDataPromise = documentApi.getDocumentData(
+                    stylesPayload as {id: number; token?: string}
                 )
                 return Promise.all([
                     wsBasePromise,
@@ -538,11 +539,13 @@ export class Editor {
                                     // our version (v) lets the endpoint include the
                                     // covering diffs as `m` so adjustDocument can
                                     // do a precise merge.
-                                    postJson("/api/document/get_doc_data/", {
-                                        id: this.docInfo.id,
-                                        token: this.docInfo.token,
-                                        v: this.docInfo.version
-                                    }).then(({json}) => {
+                                    this.app.apiConnectors.document
+                                        .getDocumentData({
+                                            id: this.docInfo.id as number,
+                                            token: this.docInfo.token,
+                                            v: this.docInfo.version as number
+                                        })
+                                        .then(({json}) => {
                                         this.mod.collab.doc.receiveDocument(
                                             json
                                         )
@@ -707,6 +710,7 @@ export class Editor {
                                                     use_current_view: true
                                                 })
                                                 new ExportFidusFile(
+                                                    this.app,
                                                     doc,
                                                     this.mod.db.bibDB,
                                                     this.mod.db.imageDB,
@@ -776,6 +780,7 @@ export class Editor {
     handleAccessRightModification(): void {
         // This function when invoked creates a copy of document in FW format and closes editor operation.
         new ExportFidusFile(
+            this.app,
             this.getDoc({use_current_view: true}),
             this.mod.db.bibDB,
             this.mod.db.imageDB
@@ -896,24 +901,25 @@ export class Editor {
         )
 
         // Create the document on the server with E2EE parameters
-        const {json, status} = await postJson("/api/document/create_doc/", {
+        const {json, status} = await this.app.apiConnectors.document.createDocument({
             template_id: this.docInfo.templateId,
             path: this.docInfo.path,
             e2ee: true,
             e2ee_salt: saltBase64,
             e2ee_iterations: iterations
-        }) as {json: any; status: number}
+        })
 
+        const createData = json as {id: number; error?: string}
         if (status === 403) {
             addAlert(
                 "error",
-                json.error || gettext("E2EE is not enabled on this server.")
+                createData.error || gettext("E2EE is not enabled on this server.")
             )
             window.location.href = "/"
             return
         }
 
-        this.docInfo.id = json.id
+        this.docInfo.id = createData.id
         window.history.replaceState("", "", `/document/${this.docInfo.id}/`)
         delete this.docInfo.templateId
 
@@ -1310,3 +1316,9 @@ export class Editor {
         return
     }
 }
+
+export type {
+    EditorDocumentApi,
+    EditorDocumentImportApi,
+    EditorContactsApi
+} from "./types.js"

package/src/menus/headerbar/model.ts

@@ -2,7 +2,6 @@ import {
     Dialog,
     addAlert,
     addProgress,
-    postJson,
     shortFileTitle
 } from "fwtoolkit"
 import type {BibDB, ExportDoc, ImageDB} from "@fiduswriter/document"
@@ -137,10 +136,11 @@ export const headerbarModel = () => ({
                             !editor.docInfo.is_owner
                         ) {
                             // TokenUser requesting access
-                            postJson("/api/document/request_access/", {
-                                document_id: editor.docInfo.id,
-                                rights: "write"
-                            })
+                            editor.app.apiConnectors.document
+                                .requestAccess({
+                                    document_id: editor.docInfo.id as number,
+                                    rights: "write"
+                                })
                                 .then(({json}: {json: unknown}) => {
                                     const data = json as {
                                         success?: boolean
@@ -189,9 +189,10 @@ export const headerbarModel = () => ({
                                 const noPassphraseUsers: string[] = []
                                 for (const ar of userRecipients) {
                                     try {
+                                        const holderId = ar.holder?.id as number
                                         const hasKeys =
                                             await PassphraseManager.userHasEncryptionKeys(
-                                                ar.holder?.id as number
+                                                holderId
                                             )
                                         if (hasKeys) {
                                             // Recipient has passphrase keys —
@@ -199,7 +200,7 @@ export const headerbarModel = () => ({
                                             await PassphraseManager.saveDocumentPassword(
                                                 editor.docInfo.id as number,
                                                 editor.e2ee.password,
-                                                ar.holder?.id as number,
+                                                holderId,
                                                 "user",
                                                 false
                                             )
@@ -252,7 +253,9 @@ export const headerbarModel = () => ({
                             editor.e2ee?.encrypted || false,
                             editor.e2ee?.password || "",
                             onShareSuccess,
-                            editor.app.settings
+                            editor.app.settings,
+                            editor.app.apiConnectors.contacts,
+                            editor.app.apiConnectors.document
                         )
                         shareDialog.init()
                     },
@@ -343,7 +346,10 @@ export const headerbarModel = () => ({
                             getExportDoc(editor),
                             db.bibDB,
                             db.imageDB,
-                            editor.user
+                            editor.user,
+                            null,
+                            null,
+                            editor.app.apiConnectors.documentImport
                         )
                         copier
                             .init()
@@ -368,6 +374,7 @@ export const headerbarModel = () => ({
                     action: (editor: Editor) => {
                         const db = getDB(editor)
                         new ExportFidusFile(
+                            editor.app,
                             getExportDoc(editor),
                             db.bibDB,
                             db.imageDB,
@@ -787,6 +794,7 @@ export const headerbarModel = () => ({
                     action: (editor: Editor) => {
                         const db = getDB(editor)
                         new ExportFidusFile(
+                            editor.app,
                             getExportDoc(editor),
                             db.bibDB,
                             db.imageDB,