@fiduswriter/editor 0.1.19 → 0.1.21

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

@@ -1,4 +1,9 @@
-export const deleteContactCell = contact =>
+interface Contact {
+    type: string
+    id: number
+}
+
+export const deleteContactCell = (contact: Contact) =>
     `<span class="fw-link-text delete-single-contact"
             data-type="${contact.type}" data-id="${contact.id}">
         <i class="fa fa-trash-alt"></i>
@@ -11,7 +16,7 @@ export const addContactTemplate = () =>
                 placeholder="${gettext("E-mail address or username")}" />
     </td></tr></tbody></table>`
 
-export const displayContactType = ({type}) => {
+export const displayContactType = ({type}: {type: string}) => {
     switch (type) {
         case "user":
             return gettext("User")
@@ -20,9 +25,10 @@ export const displayContactType = ({type}) => {
         case "to_userinvite":
             return gettext("Invite you received")
     }
+    return ""
 }
 
-export const respondInviteCell = contact =>
+export const respondInviteCell = (contact: Contact) =>
     `<button class="fw-button fw-small fw-dark respond-invite" data-id="${contact.id}">
     ${gettext("Respond")}
 </button>`

package/src/copyright_dialog/{index.js → index.ts}

@@ -4,10 +4,24 @@ import {Dialog, InputList, TypeSwitch, escapeText} from "fwtoolkit"
 import {
     copyrightTemplate,
     licenseInputTemplate,
-    licenseSelectTemplate
+    licenseSelectTemplate,
+    type CopyrightParams
 } from "./templates.js"
 
-export const LICENSE_URLS = [
+interface License {
+    url: string
+    title: string
+    start?: string | false
+}
+
+export interface Copyright {
+    holder?: string | false
+    year?: number | false
+    freeToRead?: boolean
+    licenses?: License[]
+}
+
+export const LICENSE_URLS: Array<[string, string]> = [
     ["CC BY 4.0", "https://creativecommons.org/licenses/by/4.0/"],
     ["CC BY-SA 4.0", "https://creativecommons.org/licenses/by-sa/4.0/"],
     ["CC BY-ND 4.0", "https://creativecommons.org/licenses/by-nd/4.0/"],
@@ -17,40 +31,49 @@ export const LICENSE_URLS = [
     ["CC0", "https://creativecommons.org/publicdomain/zero/1.0/"]
 ]
 
-function getLicenseTitle(url) {
+function getLicenseTitle(url: string): string {
     const license = LICENSE_URLS.find(license => license[1] === url)
     return license ? license[0] : ""
 }
 
 export class CopyrightDialog {
-    constructor(copyright) {
+    copyright: Copyright
+    origCopyright: Copyright
+    dialog: Dialog | false
+    licensesList?: InputList<License>
+
+    constructor(copyright: Copyright) {
         this.copyright = copyright
         this.origCopyright = copyright
         this.dialog = false
     }
 
-    getCurrentValue() {
+    getCurrentValue(): void {
         this.copyright = {}
-        const holder = this.dialog.dialogEl.querySelector(".holder").value
-        this.copyright.holder = holder.length ? holder : false
-        const year = this.dialog.dialogEl.querySelector(".year").value
-        this.copyright.year = year.length
-            ? Math.max(0, Math.min(Number.parseInt(year) || 0, 2100))
+        const holder = (
+            this.dialog as Dialog
+        ).dialogEl.querySelector(".holder") as HTMLInputElement
+        this.copyright.holder = holder.value.length ? holder.value : false
+        const year = (
+            this.dialog as Dialog
+        ).dialogEl.querySelector(".year") as HTMLInputElement
+        this.copyright.year = year.value.length
+            ? Math.max(0, Math.min(Number.parseInt(year.value) || 0, 2100))
             : false
-        this.copyright.freeToRead = this.dialog.dialogEl.querySelector(
-            ".free-to-read:checked"
-        )
+        this.copyright.freeToRead = (
+            this.dialog as Dialog
+        ).dialogEl.querySelector(".free-to-read:checked")
             ? true
             : false
         const licenseStartDates = Array.from(
-            this.dialog.dialogEl.querySelectorAll(".license-start")
-        ).map(el => el.value)
-        this.copyright.licenses = this.licensesList.values
-            .map((license, index) => {
+            (this.dialog as Dialog).dialogEl.querySelectorAll(".license-start")
+        ).map(el => (el as HTMLInputElement).value)
+        this.copyright.licenses = (this.licensesList as InputList<License>).values
+            .map((license: License, index: number) => {
                 if (!license.url.length) {
                     return false
                 }
-                const returnValue = {
+                const returnValue: License = {
                     url: license.url,
                     title: license.title
                 }
@@ -67,36 +90,36 @@ export class CopyrightDialog {
                 }
                 return returnValue
             })
-            .filter(license => license)
+            .filter((license): license is License => Boolean(license))
     }
 
-    init() {
+    init(): Promise<Copyright | false> {
         return new Promise(resolve => {
-            const buttons = []
-            buttons.push({
-                text: gettext("Change"),
-                classes: "fw-dark",
-                click: () => {
-                    this.dialog.close()
-                    this.getCurrentValue()
-                    if (deepEqual(this.copyright, this.origCopyright)) {
-                        // No change.
-                        resolve(false)
+            const buttons = [
+                {
+                    text: gettext("Change"),
+                    classes: "fw-dark",
+                    click: () => {
+                        ;(this.dialog as Dialog).close()
+                        this.getCurrentValue()
+                        if (deepEqual(this.copyright, this.origCopyright)) {
+                            // No change.
+                            resolve(false)
+                        }
+                        resolve(this.copyright)
                     }
-                    resolve(this.copyright)
+                },
+                {
+                    type: "cancel" as const
                 }
-            })
-
-            buttons.push({
-                type: "cancel"
-            })
+            ]
 
             this.dialog = new Dialog({
                 width: 940,
                 height: 300,
                 id: "configure-copyright",
                 title: gettext("Set copyright information"),
-                body: copyrightTemplate(this.copyright),
+                body: copyrightTemplate(this.copyright as CopyrightParams),
                 buttons
             })
 
@@ -105,22 +128,24 @@ export class CopyrightDialog {
         })
     }
 
-    bind() {
-        this.licensesList = new InputList({
-            dom: this.dialog.dialogEl.querySelector(".copyright-licenses-list"),
+    bind(): void {
+        this.licensesList = new InputList<License>({
+            dom: (this.dialog as Dialog).dialogEl.querySelector(
+                ".copyright-licenses-list"
+            ) as HTMLElement,
             initialValues: this.copyright.licenses || [],
             emptyValue: {url: "", title: "", start: false},
-            renderItem: license => ({
+            renderItem: (license: License) => ({
                 html: `<div class="copyright-license-switch"></div>
                     <div class="field-part field-part-small">
                         <input type="text" class="license-start" value="${license.start ? escapeText(license.start) : ""}" placeholder="${gettext("Start date")}">
                     </div>`,
                 bind: el => {
-                    const licenseContainer = el.closest("tr")
+                    const licenseContainer = el.closest("tr") as HTMLElement
                     const startInput =
                         licenseContainer.querySelector(".license-start")
                     if (license.start) {
-                        startInput.value = license.start
+                        ;(startInput as HTMLInputElement).value = license.start
                     }
 
                     const mode =
@@ -131,12 +156,13 @@ export class CopyrightDialog {
                             ? 1
                             : 2
                     new TypeSwitch({
-                        dom: el.querySelector(".copyright-license-switch"),
+                        dom: el.querySelector(
+                            ".copyright-license-switch"
+                        ) as HTMLElement,
                         label1: gettext("From list"),
                         label2: gettext("Custom"),
                         initialMode: mode,
-                        render1: () =>
-                            licenseSelectTemplate({url: license.url}),
+                        render1: () => licenseSelectTemplate({url: license.url}),
                         render2: () =>
                             licenseInputTemplate({
                                 url: license.url,
@@ -148,30 +174,39 @@ export class CopyrightDialog {
                                 ".fw-type-switch-input-inner input, .fw-type-switch-input-inner select"
                             )
                             if (focusable) {
-                                focusable.focus()
+                                ;(focusable as HTMLElement).focus()
                             }
                         }
                     })
                 }
             }),
-            getValue: el => {
+            getValue: (el): License => {
                 const licenseInput = el.querySelector(
                     ".fw-type-switch-input-inner"
-                )
+                ) as HTMLElement
                 const selectEl = licenseInput.querySelector("select.license")
-                let url, title
+                let url: string, title: string
                 if (selectEl) {
-                    url = selectEl.value
+                    url = (selectEl as HTMLSelectElement).value
                     title = getLicenseTitle(url)
                 } else {
-                    url = licenseInput.querySelector("input.license").value
-                    title = licenseInput.querySelector(
-                        "input.license-title"
+                    url = (
+                        licenseInput.querySelector("input.license") as
+                            | HTMLInputElement
+                            | undefined
+                    )?.value as string
+                    title = (
+                        licenseInput.querySelector(
+                            "input.license-title"
+                        ) as HTMLInputElement
                     ).value
                 }
-                const start =
-                    el.closest("tr").querySelector(".license-start").value ||
-                    false
+                const startValue =
+                    (el.closest("tr")?.querySelector(".license-start") as
+                        | HTMLInputElement
+                        | undefined
+                    )?.value
+                const start: string | false = startValue || false
                 return {url, title, start}
             }
         })

package/src/copyright_dialog/{templates.js → templates.ts}

@@ -1,7 +1,22 @@
 import {escapeText} from "fwtoolkit"
 import {LICENSE_URLS} from "./index.js"
 
-export const licenseSelectTemplate = ({url}) =>
+interface LicenseSelectParams {
+    url: string
+}
+
+interface LicenseInputParams {
+    url: string
+    title: string
+}
+
+export interface CopyrightParams {
+    holder?: string
+    year?: number
+    freeToRead?: boolean
+}
+
+export const licenseSelectTemplate = ({url}: LicenseSelectParams) =>
     `<select class="license">
         <option value=""></option>
         ${LICENSE_URLS.map(
@@ -11,7 +26,7 @@ export const licenseSelectTemplate = ({url}) =>
     </select>
     <div class="fw-select-arrow fa fa-caret-down"></div>`
 
-export const licenseInputTemplate = ({url, title}) =>
+export const licenseInputTemplate = ({url, title}: LicenseInputParams) =>
     `<div class="field-part field-part-huge">
         <input type='text' class='license' value="${escapeText(url)}" placeholder="${gettext("License URL")}">
     </div>
@@ -19,7 +34,7 @@ export const licenseInputTemplate = ({url, title}) =>
         <input type='text' class='license-title' value="${escapeText(title)}" placeholder="${gettext("License Title")}">
     </div>`
 
-export const copyrightTemplate = ({holder, year, freeToRead}) =>
+export const copyrightTemplate = ({holder, year, freeToRead}: CopyrightParams) =>
     `<table class="fw-dialog-table">
         <tbody>
             <tr>

package/src/databases/{bibliography.js → bibliography.ts}

@@ -1,11 +1,17 @@
 import deepEqual from "fast-deep-equal"
 
-function randomID() {
+function randomID(): number {
     return Math.floor(Math.random() * 0xffffffff)
 }
 
 export class ModBibliographyDB {
-    constructor(mod) {
+    mod: any
+    db: Record<string, any> | false
+    unsent: {type: string; id?: number; reference?: any}[]
+    // cats aren't used, but we keep this for consistency
+    cats: any[]
+
+    constructor(mod: any) {
         mod.bibDB = this
         this.mod = mod
         this.db = false
@@ -14,12 +20,12 @@ export class ModBibliographyDB {
         this.cats = []
     }
 
-    setDB(db) {
+    setDB(db: Record<string, any>): void {
         this.db = db
         this.unsent = []
     }
 
-    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(
@@ -31,8 +37,11 @@ export class ModBibliographyDB {
     // function saveBibEntries is the same as in user's individual BibliographyDB.
     // Function added to make document's and user's bibDBs be connectable to the
     // same interface functions.
-    saveBibEntries(tmpDB, isNew) {
-        const idTranslations = []
+    saveBibEntries(
+        tmpDB: Record<string, any>,
+        isNew: boolean
+    ): Promise<[number, number][]> {
+        const idTranslations: [number, number][] = []
         Object.keys(tmpDB).forEach(bibKey => {
             const reference = tmpDB[bibKey],
                 bibId = Number.parseInt(bibKey)
@@ -55,30 +64,33 @@ export class ModBibliographyDB {
 
     // Function added here for compatibility with user's bibDB. See comment at
     // saveBibEntries function.
-    updateLocalBibEntries(tmpDB, idTranslations) {
+    updateLocalBibEntries(
+        tmpDB: Record<string, any>,
+        idTranslations: [number, number][]
+    ): [number, number][] {
         idTranslations.forEach(bibTrans => {
-            this.updateLocalReference([bibTrans[1]], tmpDB[bibTrans[0]])
+            this.updateLocalReference([bibTrans[1]], tmpDB[String(bibTrans[0])])
         })
         return idTranslations
     }
 
     // Function added here for compatibility with user's bibDB. See comment at
     // saveBibEntries function.
-    deleteBibEntries(ids) {
+    deleteBibEntries(ids: number[]): Promise<number[]> {
         ids.forEach(id => this.deleteReference(id))
         return Promise.resolve(ids)
     }
 
     // This function only makes real sense in the user's bibDB. It is kept here
     // for compatibility reasons.
-    getDB() {
+    getDB(): Promise<{bibPks: number[]; bibCats: any[]}> {
         return new Promise(resolve => {
             window.setTimeout(() => resolve({bibPks: [], bibCats: []}), 100)
         })
     }
 
-    addReference(reference, id) {
-        while (!id || this.db[id]) {
+    addReference(reference: any, id: number): number {
+        while (!id || (this.db && (this.db as Record<string, any>)[String(id)])) {
             id = randomID()
         }
         this.updateReference(id, reference)
@@ -86,7 +98,7 @@ export class ModBibliographyDB {
     }
 
     // Add or update a reference to the bibliography database both remotely and locally.
-    updateReference(id, reference) {
+    updateReference(id: number, reference: any): void {
         this.updateLocalReference(id, reference)
         this.unsent.push({
             type: "update",
@@ -96,9 +108,13 @@ export class ModBibliographyDB {
     }
 
     // Add or update a reference only locally.
-    updateLocalReference(id, reference) {
-        const preExisting = this.db[id] ? true : false
-        this.db[id] = reference
+    updateLocalReference(id: number | number[], reference: any): void {
+        if (Array.isArray(id)) {
+            id = id[0]
+        }
+        const preExisting =
+            this.db && (this.db as Record<string, any>)[String(id)] ? true : false
+        ;(this.db as Record<string, any>)[String(id)] = reference
         if (preExisting) {
             this.mod.editor.mod.citations.resetCitations()
         } else {
@@ -106,7 +122,7 @@ export class ModBibliographyDB {
         }
     }
 
-    deleteReference(id) {
+    deleteReference(id: number): void {
         this.deleteLocalReference(id)
         this.unsent.push({
             type: "delete",
@@ -115,21 +131,25 @@ export class ModBibliographyDB {
         this.mustSend()
     }
 
-    deleteLocalReference(id) {
-        delete this.db[id]
+    deleteLocalReference(id: number): void {
+        if (this.db) {
+            delete (this.db as Record<string, any>)[String(id)]
+        }
     }
 
-    hasUnsentEvents() {
+    hasUnsentEvents(): number {
         return this.unsent.length
     }
 
-    unsentEvents() {
+    unsentEvents(): {type: string; id?: number; reference?: any}[] {
         return this.unsent.map(event => {
             if (event.type === "delete") {
                 return event
             } else if (event.type === "update") {
                 // Check bib entry still exists. Otherwise ignore.
-                const reference = this.db[event.id]
+                const reference =
+                    this.db &&
+                    (this.db as Record<string, any>)[String(event.id)]
                 if (reference) {
                     return {
                         type: "update",
@@ -142,35 +162,41 @@ export class ModBibliographyDB {
                     }
                 }
             }
+            return {type: "ignore"}
         })
     }
 
-    eventsSent(n) {
+    eventsSent(n: {length: number}): void {
         this.unsent = this.unsent.slice(n.length)
     }
 
-    receive(events) {
+    receive(events: {type: string; id?: number; reference?: any}[]): void {
         events.forEach(event => {
             if (event.type == "delete") {
-                this.deleteLocalReference(event.id)
+                this.deleteLocalReference(event.id as number)
             } else if (event.type == "update") {
-                this.updateLocalReference(event.id, event.reference)
+                this.updateLocalReference(event.id as number, event.reference)
             }
         })
     }
 
-    findReference(ref) {
-        return Object.keys(this.db).find(id => {
-            const bib = this.db[id]
-            return (
-                bib.bib_type === ref.bib_type &&
-                deepEqual(bib.fields, ref.fields)
-            )
-        })
+    findReference(ref: any): number {
+        if (!this.db) {
+            return 0
+        }
+        return Number(
+            Object.keys(this.db).find(id => {
+                const bib = (this.db as Record<string, any>)[id]
+                return (
+                    bib.bib_type === ref.bib_type &&
+                    deepEqual(bib.fields, ref.fields)
+                )
+            }) || 0
+        )
     }
 
-    hasReference(ref) {
-        if (this.findReference(ref) !== undefined) {
+    hasReference(ref: any): boolean {
+        if (this.findReference(ref) !== 0) {
             return true
         } else {
             return false