@fiduswriter/editor 0.1.49 → 0.1.51

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,

package/src/no_collab_save/index.ts

@@ -1,4 +1,4 @@
-import {addAlert, postJson} from "fwtoolkit"
+import {addAlert} from "fwtoolkit"
 import {receiveTransaction} from "prosemirror-collab"
 import {recreateTransform} from "../collab/merge/recreate_transform.js"
 import type {Editor} from "../types.js"
@@ -10,7 +10,7 @@ import type {Node} from "prosemirror-model"
  */
 export class NoCollabSave {
     editor: Editor
-    saveInterval: ReturnType<typeof setInterval> | null
+    saveInterval: number | null
     savePromise: Promise<void> | null
     _beforeUnloadHandler: (() => void) | null
     _lastSaveTime: number
@@ -126,20 +126,19 @@ export class NoCollabSave {
         }
 
         try {
-            const {json, status} = (await postJson(
-                "/api/document/save/",
+            const {json, status} = await this.editor.app.apiConnectors.document.saveDocument(
                 payload,
-                {},
                 {keepalive}
-            )) as {json: Record<string, unknown>; status: number}
+            )
             if (status === 409) {
                 if (!keepalive) {
                     await this._handleVersionConflict()
                 }
                 return
             }
-            if (json.version !== undefined) {
-                this.editor.docInfo.version = json.version as number
+            const saveData = json as {version?: number}
+            if (saveData.version !== undefined) {
+                this.editor.docInfo.version = saveData.version
             }
             this.editor.docInfo.updated = new Date()
             this.editor.docInfo.confirmedDoc = this.editor.view.state.doc
@@ -167,15 +166,15 @@ export class NoCollabSave {
             payload.token = this.editor.docInfo.token
         }
         try {
-            const {json} = (await postJson(
-                "/api/document/get_doc_data/",
-                payload
-            )) as {json: Record<string, unknown>}
+            const {json} = await this.editor.app.apiConnectors.document.getDocumentData(
+                payload as {id: number; token?: string}
+            )
+            const data = json as {
+                doc: Record<string, unknown>
+                time: string
+            }
             const serverDoc = this.editor.schema.nodeFromJSON(
-                (json.doc as Record<string, unknown>).content as Record<
-                    string,
-                    unknown
-                >
+                (data.doc.content as Record<string, unknown>) || {}
             )
             const currentDoc = this.editor.view.state.doc
             const confirmedDoc = this.editor.docInfo.confirmedDoc as Node
@@ -203,18 +202,17 @@ export class NoCollabSave {
 
             // Update metadata from server
             ;(this.editor.mod.db?.bibDB as {setDB(value: unknown): void}).setDB(
-                (json.doc as Record<string, unknown>).bibliography
+                data.doc.bibliography
             )
             ;(this.editor.mod.db?.imageDB as {setDB(value: unknown): void}).setDB(
-                (json.doc as Record<string, unknown>).images
+                data.doc.images
             )
             ;(this.editor.mod.comments as any).store.loadComments(
-                (json.doc as Record<string, unknown>).comments
+                data.doc.comments
             )
-            this.editor.docInfo.version = (json.doc as Record<string, unknown>)
-                .v as number
+            this.editor.docInfo.version = data.doc.v as number
             this.editor.docInfo.confirmedDoc = this.editor.view.state.doc
-            this.editor.docInfo.updated = new Date(json.time as string)
+            this.editor.docInfo.updated = new Date(data.time)
             ;(this.editor.mod.footnotes as any).fnEditor.renderAllFootnotes()
 
             // Retry save with the merged document

package/src/state_plugins/inline_reference/dropup.ts

@@ -156,8 +156,8 @@ export function buildBibliographyList(editor: Editor): BibliographyEntry[] {
     if (editor.mod?.db?.bibDB?.db) {
         addEntries(editor.mod.db.bibDB.db as Record<number, any>, "doc")
     }
-    if ((editor.app as any).bibDB?.db) {
-        addEntries((editor.app as any).bibDB.db as Record<number, any>, "user")
+    if (editor.app.bibDB?.db) {
+        addEntries(editor.app.bibDB.db as Record<string, any>, "user")
     }
 
     return entries

package/src/state_plugins/settings.ts

@@ -243,7 +243,7 @@ export const settingsPlugin = (options: SettingsOptions) => {
                     )
                     setDocTitle(
                         view.state.doc.firstChild?.textContent || "",
-                        options.editor.app as any
+                        options.editor.app
                     )
                 }
             }

package/src/types.ts

@@ -14,13 +14,15 @@ import type {EditorView} from "prosemirror-view"
 import type {
     BibDB,
     BibDBEntries,
+    BibDBEntry,
     CommentData,
     CSL,
     ImageDB,
     ImageDBEntries
 } from "@fiduswriter/document"
+import type {ImageApi} from "@fiduswriter/image-manager"
 
-export type {BibDB, BibDBEntries, CommentData, CSL, ImageDB, ImageDBEntries}
+export type {BibDB, BibDBEntries, BibDBEntry, CommentData, CSL, ImageDB, ImageDBEntries}
 
 /** Image database interface used by the editor (document and user DBs). */
 export interface EditorImageDB extends ImageDB {
@@ -28,16 +30,104 @@ export interface EditorImageDB extends ImageDB {
     setImage(id: number, imageData: Record<string, unknown>): void
 }
 
+/** Bibliography database interface used by the editor. */
+export interface EditorBibDB {
+    db: Record<string, BibDBEntry>
+}
+
+/** API connector for document-level operations used by the editor. */
+export interface EditorDocumentApi {
+    createDocument(
+        data: Record<string, unknown>
+    ): Promise<{json: unknown; status: number}>
+    getWebSocketBase(
+        data: {id: number; token?: string}
+    ): Promise<{json: unknown; status: number}>
+    getDocumentStyles(
+        data: {id: number; token?: string}
+    ): Promise<{json: unknown; status: number}>
+    getDocumentData(
+        data: {id: number; token?: string; v?: number}
+    ): Promise<{json: unknown; status: number}>
+    saveDocument(
+        data: Record<string, unknown>,
+        options?: {keepalive?: boolean}
+    ): Promise<{json: unknown; status: number}>
+    commentNotify(data: Record<string, unknown>): Promise<unknown>
+    requestAccess(
+        data: {document_id: number; rights: string}
+    ): Promise<{json: unknown; status: number}>
+    validateShareToken(
+        token: string
+    ): Promise<{json: unknown; status: number}>
+    listShareTokens(document_id: number): Promise<{json: unknown; status: number}>
+    createShareToken(
+        data: Record<string, unknown>
+    ): Promise<{json: unknown; status: number}>
+    revokeShareToken(token_id: number): Promise<{json: unknown; status: number}>
+    getAccessRights(
+        data: {document_ids: number[]}
+    ): Promise<{json: unknown; status: number}>
+    saveAccessRights(data: {
+        document_ids: number[]
+        access_rights: unknown[]
+    }): Promise<unknown>
+    saveE2EEImage(
+        data: Record<string, unknown>,
+        files?: Record<string, unknown>
+    ): Promise<{json: unknown; status: number}>
+    deleteE2EEImage(data: {doc_id: number; image_id: number}): Promise<unknown>
+    uploadRevision(
+        data: {note: string; document_id: number},
+        files: Record<string, unknown>
+    ): Promise<unknown>
+    getTemplateForDoc(
+        id: number | string,
+        token: string | false
+    ): Promise<{json: unknown; status: number}>
+}
+
+/** API connector for contact operations used by the editor. */
+export interface EditorContactsApi {
+    add(data: {user_string: string}): Promise<{json: unknown; status: number}>
+}
+
+/** API connector for document import/copy operations used by the editor. */
+export interface EditorDocumentImportApi {
+    createDoc(
+        data: Record<string, unknown>,
+        files?: Record<string, unknown>
+    ): Promise<{json: unknown; status: number}>
+    saveImage(
+        data: Record<string, unknown>,
+        files: Record<string, unknown>
+    ): Promise<{json: unknown; status: number}>
+    saveE2EEImage(
+        data: Record<string, unknown>,
+        files: Record<string, unknown>
+    ): Promise<{json: unknown; status: number}>
+    saveDocument(
+        data: Record<string, unknown>
+    ): Promise<{json: unknown; status: number}>
+}
+
 /** Minimal app interface — only the fields the Editor actually uses. */
 export interface EditorApp {
     routes: Record<string, {app: string; [key: string]: unknown}>
     goTo: (url: string) => void
     settings: {APPS: string[]; [key: string]: unknown}
     menuPlugins?: Array<[string, Record<string, {new (...args: unknown[]): {init(): void}}>]>
-    name?: string
+    name: string
     isOffline(): boolean
     csl: CSL
+    bibDB?: EditorBibDB
     imageDB: EditorImageDB
+    apiConnectors: {
+        document: EditorDocumentApi
+        documentImport: EditorDocumentImportApi
+        image: ImageApi
+        contacts: EditorContactsApi
+    }
 }
 
 /** Document access role constants. */