@fiduswriter/bibliography-manager 0.1.6 → 0.1.8

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

@@ -1,6 +1,23 @@
 import {BibFieldTypes, BibTypes} from "bibliojson"
-import {Dialog, DialogTabs, InfoRow, addAlert} from "fwtoolkit"
+import {
+    Dialog,
+    DialogTabs,
+    InfoRow,
+    addAlert
+} from "fwtoolkit"
+import type {DialogButtonSpec} from "fwtoolkit/dialog"
 import {dateToYear, litToText, nameToText} from "../tools.js"
+import type {
+    BibDBCollection,
+    BibDBEntry,
+    BibliographyApp,
+    FieldForm,
+    FieldFormConstructor,
+    FieldFormsMap,
+    FormValue,
+    IdTranslation,
+    NameDictObject
+} from "../types/biblio.js"
 import {CatsForm} from "./cats.js"
 import {DateFieldForm} from "./fields/date.js"
 import {KeyFieldForm} from "./fields/key.js"
@@ -22,32 +39,61 @@ import {
 } from "./strings.js"
 import {bibDialog} from "./templates.js"
 
-const FIELD_FORMS = {
-    f_date: DateFieldForm,
-    f_integer: LiteralFieldForm,
-    f_literal: LiteralFieldForm,
-    l_literal: LiteralListForm,
-    f_long_literal: LiteralLongFieldForm,
-    f_key: KeyFieldForm,
-    l_key: KeyListForm,
-    l_name: NameListForm,
-    l_range: RangeListForm,
-    l_tag: TagListForm,
-    f_title: TitleFieldForm,
-    f_uri: URIFieldForm,
-    f_verbatim: VerbatimFieldForm
+const FIELD_FORMS: FieldFormsMap = {
+    f_date: DateFieldForm as FieldFormConstructor,
+    f_integer: LiteralFieldForm as FieldFormConstructor,
+    f_literal: LiteralFieldForm as FieldFormConstructor,
+    l_literal: LiteralListForm as FieldFormConstructor,
+    f_long_literal: LiteralLongFieldForm as FieldFormConstructor,
+    f_key: KeyFieldForm as FieldFormConstructor,
+    l_key: KeyListForm as FieldFormConstructor,
+    l_name: NameListForm as FieldFormConstructor,
+    l_range: RangeListForm as FieldFormConstructor,
+    l_tag: TagListForm as FieldFormConstructor,
+    f_title: TitleFieldForm as FieldFormConstructor,
+    f_uri: URIFieldForm as FieldFormConstructor,
+    f_verbatim: VerbatimFieldForm as FieldFormConstructor
 }
 
+export {BibFieldHelp, BibFieldTitles, BibTypeTitles, getBibFieldTitle}
+
 export class BibEntryForm {
-    constructor(bibDB, app = false, itemId = false) {
+    bibDB: BibDBCollection
+    itemId: number | false
+    app: BibliographyApp | false
+    fields: Record<string, FieldForm>
+    currentValues: {
+        bib_type: string | false
+        cats: number[]
+        entry_key: string
+        fields: Record<string, unknown>
+    }
+    dialog?: Dialog
+    dialogHeader?: string
+    dialogTabs?: DialogTabs
+    catsForm?: CatsForm
+    entryKeyAutoGenerate = false
+    programmaticallySettingKey = false
+    lastAutoGeneratedKey: string | null = null
+
+    constructor(
+        bibDB: BibDBCollection,
+        app: BibliographyApp | false = false,
+        itemId: number | false = false
+    ) {
         this.bibDB = bibDB
         this.itemId = itemId
         this.app = app
         this.fields = {}
-        this.currentValues = {}
+        this.currentValues = {
+            bib_type: false,
+            cats: [],
+            entry_key: "",
+            fields: {}
+        }
     }
 
-    init() {
+    init(): Promise<IdTranslation[] | void> {
         if (this.app && this.app.isOffline()) {
             // Diable the editing of main user bibliography , since Document bibliography is stored in Editor/Document.
             addAlert(
@@ -74,9 +120,9 @@ export class BibEntryForm {
         return this.createForm()
     }
 
-    addDialogToDOM() {
+    addDialogToDOM(): Promise<IdTranslation[] | void> {
         // Add form to DOM
-        const buttons = [
+        const buttons: DialogButtonSpec[] = [
             {
                 type: "close"
             }
@@ -89,7 +135,7 @@ export class BibEntryForm {
                 click: () => {
                     if (this.check()) {
                         const returnValue = this.save()
-                        this.dialog.close()
+                        this.dialog!.close()
                         resolve(returnValue)
                     }
                 }
@@ -106,7 +152,7 @@ export class BibEntryForm {
                 width: 940,
                 body: bibDialog({
                     bib_type: this.currentValues.bib_type,
-                    BibTypes,
+                    bibTypes: BibTypes,
                     hasCats
                 }),
                 buttons
@@ -138,11 +184,13 @@ export class BibEntryForm {
                 ],
                 {containerId: "bib-dialog-tabs"}
             )
-            this.dialogTabs.bind(
-                this.dialog.dialogEl.querySelector("#bib-dialog-tabs")
+            this.dialogTabs!.bind(
+                this.dialog.dialogEl.querySelector("#bib-dialog-tabs") as HTMLElement
             )
 
-            const entryKeyInput = document.getElementById("entry-key")
+            const entryKeyInput = document.getElementById(
+                "entry-key"
+            ) as HTMLInputElement | null
             if (entryKeyInput) {
                 entryKeyInput.value = this.currentValues.entry_key || ""
                 entryKeyInput.addEventListener("input", () => {
@@ -163,17 +211,16 @@ export class BibEntryForm {
                 })
             }
 
-            document
-                .getElementById("select-bibtype")
+            ;(document.getElementById("select-bibtype") as HTMLElement)
                 .addEventListener("change", () => resolve(this.changeBibType()))
         })
     }
 
-    addField(fieldName, dom) {
+    addField(fieldName: string, dom: HTMLElement): void {
         const fieldType = BibFieldTypes[fieldName]
         const fieldTitleText = getBibFieldTitle(
             fieldName,
-            this.currentValues.bib_type
+            this.currentValues.bib_type || null
         )
 
         const row = new InfoRow({
@@ -182,7 +229,7 @@ export class BibEntryForm {
             fieldClass: fieldName
         })
         dom.insertAdjacentHTML("beforeend", row.html())
-        const fieldDOM = dom.lastChild.lastChild
+        const fieldDOM = dom.lastChild!.lastChild as HTMLElement
         const FieldClass = FIELD_FORMS[fieldType.type]
         if (FieldClass) {
             const fieldHandler = new FieldClass(
@@ -196,22 +243,22 @@ export class BibEntryForm {
         }
     }
 
-    createForm() {
+    createForm(): Promise<IdTranslation[] | void> {
         const dialogPromise = this.addDialogToDOM()
         if (this.currentValues.bib_type !== false) {
-            const eitherOrFields = document.getElementById("eo-fields")
+            const eitherOrFields = document.getElementById("eo-fields")!
             BibTypes[this.currentValues.bib_type].eitheror.forEach(
                 fieldName => {
                     this.addField(fieldName, eitherOrFields)
                 }
             )
-            const reqFields = document.getElementById("req-fields")
+            const reqFields = document.getElementById("req-fields")!
             BibTypes[this.currentValues.bib_type].required.forEach(
                 fieldName => {
                     this.addField(fieldName, reqFields)
                 }
             )
-            const optFields = document.getElementById("opt-fields")
+            const optFields = document.getElementById("opt-fields")!
             BibTypes[this.currentValues.bib_type].optional.forEach(
                 fieldName => {
                     this.addField(fieldName, optFields)
@@ -230,36 +277,36 @@ export class BibEntryForm {
         return dialogPromise
     }
 
-    changeBibType() {
+    changeBibType(): Promise<IdTranslation[] | void> {
         // Add all current values into temporary currentValues, in case the
         // user still wants them.
         const formValue = this.value
         Object.assign(this.currentValues.fields, formValue.fields)
-        this.currentValues.cats = formValue.cats
+        this.currentValues.cats = formValue.cats as number[]
         this.currentValues.bib_type = formValue.bib_type
         // Reset fields and close dialog.
         this.fields = {}
-        this.dialog.close()
+        this.dialog!.close()
         return this.createForm()
     }
 
-    createEntryKey(bibItem) {
+    createEntryKey(bibItem: FormValue): void {
         // We attempt to create a biblatex compatible entry key if there is no entry
         // key so far.
         let entryKey = ""
         if (bibItem.fields.author) {
-            entryKey += nameToText(bibItem.fields.author).replace(
-                /\s|,|=|;|:|{|}/g,
+            entryKey += nameToText(bibItem.fields.author as NameDictObject[]).replace(
+                /\s|,|=|;|:|\{|}/g,
                 ""
             )
         } else if (bibItem.fields.editor) {
-            entryKey += nameToText(bibItem.fields.editor).replace(
-                /\s|,|=|;|:|{|}/g,
+            entryKey += nameToText(bibItem.fields.editor as NameDictObject[]).replace(
+                /\s|,|=|;|:|\{|}/g,
                 ""
             )
         }
         if (bibItem.fields.date) {
-            entryKey += bibItem.fields.date
+            entryKey += (bibItem.fields.date as string)
                 .split("/")[0]
                 .replace(/\?|\*|u|~|-/g, "")
         }
@@ -268,11 +315,11 @@ export class BibEntryForm {
         }
     }
 
-    maybeAutoGenerateEntryKey() {
+    maybeAutoGenerateEntryKey(): void {
         if (!this.entryKeyAutoGenerate) {
             return
         }
-        const input = document.getElementById("entry-key")
+        const input = document.getElementById("entry-key") as HTMLInputElement | null
         if (!input) {
             return
         }
@@ -283,8 +330,12 @@ export class BibEntryForm {
 
         let lastName = ""
         const nameField = this.fields.author || this.fields.editor
-        if (nameField && nameField.value && nameField.value.length) {
-            const firstAuthor = nameField.value[0]
+        if (
+            nameField &&
+            nameField.value &&
+            (nameField.value as unknown[]).length
+        ) {
+            const firstAuthor = (nameField.value as NameDictObject[])[0]
             if (firstAuthor.family && firstAuthor.family.length) {
                 lastName = litToText(firstAuthor.family)
             } else if (firstAuthor.literal && firstAuthor.literal.length) {
@@ -295,7 +346,7 @@ export class BibEntryForm {
 
         let year = ""
         if (this.fields.date && this.fields.date.value) {
-            const yearStr = dateToYear(this.fields.date.value)
+            const yearStr = dateToYear(this.fields.date.value as string)
             const yearMatch = yearStr.match(/-?(\d+)/)
             year = yearMatch ? yearMatch[1] : ""
         }
@@ -311,7 +362,7 @@ export class BibEntryForm {
                 .filter(
                     ([id]) =>
                         Number.parseInt(id) !==
-                        Number.parseInt(this.itemId || 0)
+                        Number.parseInt((this.itemId || 0) as unknown as string)
                 )
                 .map(([, entry]) => entry.entry_key)
         )
@@ -337,8 +388,8 @@ export class BibEntryForm {
         this.checkEntryKey()
     }
 
-    checkEntryKey() {
-        const input = document.getElementById("entry-key")
+    checkEntryKey(): void {
+        const input = document.getElementById("entry-key") as HTMLInputElement | null
         const warningEl = document.getElementById("entry-key-warning")
         if (!input || !warningEl) {
             return
@@ -359,7 +410,8 @@ export class BibEntryForm {
         const duplicate = Object.entries(this.bibDB.db).find(
             ([id, entry]) =>
                 entry.entry_key === value &&
-                Number.parseInt(id) !== Number.parseInt(this.itemId || 0)
+                Number.parseInt(id) !==
+                    Number.parseInt((this.itemId || 0) as unknown as string)
         )
         if (duplicate) {
             warningEl.textContent = gettext(
@@ -370,13 +422,14 @@ export class BibEntryForm {
         }
     }
 
-    get value() {
-        const entryKeyInput = document.querySelector("#entry-key")
+    get value(): FormValue {
+        const entryKeyInput = document.querySelector("#entry-key") as HTMLInputElement | null
         const entryKey = entryKeyInput
             ? entryKeyInput.value.trim()
             : this.currentValues.entry_key
-        const returnObj = {
-            bib_type: document.querySelector("#select-bibtype").value,
+        const returnObj: FormValue = {
+            bib_type: (document.querySelector("#select-bibtype") as HTMLSelectElement)
+                .value,
             cats: this.catsForm ? this.catsForm.value : [],
             entry_key: entryKey,
             fields: {}
@@ -390,7 +443,7 @@ export class BibEntryForm {
         return returnObj
     }
 
-    save() {
+    save(): Promise<IdTranslation[]> {
         const isNew = this.itemId === false ? true : false,
             itemId = this.itemId === false ? 0 : this.itemId,
             item = this.value
@@ -398,12 +451,12 @@ export class BibEntryForm {
         if (!item.entry_key) {
             this.createEntryKey(item)
         }
-        const saveObj = {}
-        saveObj[itemId] = item
+        const saveObj: Record<number, BibDBEntry> = {}
+        saveObj[itemId] = item as unknown as BibDBEntry
         return this.bibDB.saveBibEntries(saveObj, isNew)
     }
 
-    check() {
+    check(): boolean {
         let passed = true
         if (!this.currentValues.bib_type) {
             return false

package/src/form/{strings.js → strings.ts}

@@ -8,14 +8,16 @@ import {
     getOtherOptionTitle,
     getTypeTitle
 } from "bibliojson"
+import type {Locale} from "bibliojson"
+import type {BibFieldType} from "../types/biblio.js"
 
 // Cache for the current locale to avoid repeated lookups
-let cachedLocale = null
-let cachedLang = null
+let cachedLocale: Locale | null = null
+let cachedLang: string | null = null
 
-function getCachedLocale() {
+function getCachedLocale(): Locale {
     const lang = document.documentElement.lang || "en"
-    if (lang !== cachedLang) {
+    if (lang !== cachedLang || !cachedLocale) {
         cachedLocale = getLocale(lang)
         cachedLang = lang
     }
@@ -23,13 +25,13 @@ function getCachedLocale() {
 }
 
 // Dynamic field title getter that uses bibliojson's i18n
-export function getBibFieldTitle(fieldKey, bibType = null) {
+export function getBibFieldTitle(fieldKey: string, bibType: string | null = null): string {
     const locale = getCachedLocale()
     if (bibType && BibTypes[bibType]) {
         return getFieldTitle(locale, bibType, fieldKey)
     }
     // Fallback to generic field title
-    const fieldType = BibFieldTypes[fieldKey]
+    const fieldType = BibFieldTypes[fieldKey] as BibFieldType
     if (fieldType && fieldType.title) {
         return fieldType.title
     }
@@ -37,25 +39,25 @@ export function getBibFieldTitle(fieldKey, bibType = null) {
 }
 
 // Dynamic type title getter
-export function getBibTypeTitle(typeKey) {
+export function getBibTypeTitle(typeKey: string): string {
     const locale = getCachedLocale()
     return getTypeTitle(locale, typeKey)
 }
 
 // Dynamic field help getter
-export function getBibFieldHelp(fieldKey) {
+export function getBibFieldHelp(fieldKey: string): string | undefined {
     const locale = getCachedLocale()
     return getFieldHelp(locale, fieldKey)
 }
 
 // Dynamic option title getter (for editortype, pagination, pubstate, etc.)
-export function getBibOptionTitle(optionKey) {
+export function getBibOptionTitle(optionKey: string): string {
     const locale = getCachedLocale()
     return getOtherOptionTitle(locale, optionKey)
 }
 
 // Dynamic langid title getter
-export function getBibLangidTitle(langidKey) {
+export function getBibLangidTitle(langidKey: string): string {
     const locale = getCachedLocale()
     return getLangidTitle(locale, langidKey)
 }
@@ -63,45 +65,45 @@ export function getBibLangidTitle(langidKey) {
 // For backward compatibility, create proxy objects that dynamically return translations
 // These should be used sparingly - prefer using the function versions above
 export const BibFieldTitles = new Proxy(
-    {},
+    {} as Record<string, string>,
     {
         get(_target, prop) {
-            return getBibFieldTitle(prop)
+            return getBibFieldTitle(String(prop))
         }
     }
 )
 
 export const BibTypeTitles = new Proxy(
-    {},
+    {} as Record<string, string>,
     {
         get(_target, prop) {
-            return getBibTypeTitle(prop)
+            return getBibTypeTitle(String(prop))
         }
     }
 )
 
 export const BibFieldHelp = new Proxy(
-    {},
+    {} as Record<string, string | undefined>,
     {
         get(_target, prop) {
-            return getBibFieldHelp(prop)
+            return getBibFieldHelp(String(prop))
         }
     }
 )
 
 export const BibOptionTitles = new Proxy(
-    {},
+    {} as Record<string, string>,
     {
         get(_target, prop) {
-            return getBibOptionTitle(prop)
+            return getBibOptionTitle(String(prop))
         }
     }
 )
 
 // Export a function to get all type titles as an object (for templates that need to map all types)
-export function getAllTypeTitles() {
+export function getAllTypeTitles(): Record<string, string> {
     const locale = getCachedLocale()
-    const titles = {}
+    const titles: Record<string, string> = {}
     Object.keys(BibTypes).forEach(typeKey => {
         titles[typeKey] = getTypeTitle(locale, typeKey)
     })
@@ -109,9 +111,9 @@ export function getAllTypeTitles() {
 }
 
 // Export a function to get all field help texts
-export function getAllFieldHelp() {
+export function getAllFieldHelp(): Record<string, string> {
     const locale = getCachedLocale()
-    const help = {}
+    const help: Record<string, string> = {}
     Object.keys(BibFieldTypes).forEach(fieldKey => {
         const helpText = getFieldHelp(locale, fieldKey)
         if (helpText) {

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

@@ -1,15 +1,16 @@
 /** A template for the bibliography item edit dialog. */
 import {DialogTabs} from "fwtoolkit"
+import {BibTypes} from "bibliojson"
 import {getAllTypeTitles} from "./strings.js"
 
-const requiredFieldsTemplate = () =>
+const requiredFieldsTemplate = (): string =>
     `<table class="fw-dialog-table"><tbody id="eo-fields"></tbody></table>
     <table class="fw-dialog-table"><tbody id="req-fields"></tbody></table>`
 
-const optionalFieldsTemplate = () =>
+const optionalFieldsTemplate = (): string =>
     `<table class="fw-dialog-table"><tbody id="opt-fields"></tbody></table>`
 
-const categoriesTemplate = () =>
+const categoriesTemplate = (): string =>
     `<table class="fw-dialog-table">
         <tbody>
             <tr>
@@ -19,7 +20,15 @@ const categoriesTemplate = () =>
         </tbody>
     </table>`
 
-export const bibDialog = ({bib_type, BibTypes, hasCats}) => {
+export const bibDialog = ({
+    bib_type,
+    bibTypes,
+    hasCats
+}: {
+    bib_type: string | false
+    bibTypes: typeof BibTypes
+    hasCats: boolean
+}): string => {
     const typeTitles = getAllTypeTitles()
     const tabs = [
         {
@@ -49,7 +58,7 @@ export const bibDialog = ({bib_type, BibTypes, hasCats}) => {
                             ? `<option class="fw-placeholder" selected disabled value="">${gettext("Select source type")}</option>`
                             : ""
                     }
-                    ${Object.keys(BibTypes)
+                    ${Object.keys(bibTypes)
                         .map(
                             key =>
                                 `<option value="${key}"

package/src/global.d.ts

@@ -0,0 +1,75 @@
+// Ambient declarations for dependencies without bundled types.
+
+declare module "tokenfield" {
+    export interface TokenFieldItem {
+        id: number
+        name: string
+    }
+
+    export interface TokenFieldOptions {
+        el: HTMLInputElement
+        setItems?: TokenFieldItem[]
+        keys?: Record<number, string>
+    }
+
+    export default class TokenField {
+        constructor(options: TokenFieldOptions)
+        getItems(): TokenFieldItem[]
+    }
+}
+
+declare module "fix-utf8" {
+    function fixUTF8(str: string): string
+    export default fixUTF8
+}
+
+declare module "downloadjs" {
+    function download(
+        data: Blob | string,
+        filename: string,
+        mimeType?: string
+    ): void
+    export default download
+}
+
+declare module "fwtoolkit/file/zip" {
+    export interface ZipFileSpec {
+        filename: string
+        contents: string
+    }
+
+    export class ZipFileCreator {
+        constructor(files: ZipFileSpec[])
+        init(): Promise<Blob>
+    }
+}
+
+declare module "@fiduswriter/common" {
+    export function baseBodyTemplate(...args: unknown[]): string
+    export class FeedbackTab {
+        init(): void
+    }
+    export class SiteMenu {
+        constructor(app: unknown, section: string)
+        init(): void
+    }
+}
+
+// Globals provided by the Fidus Writer host page.
+
+declare function gettext(msgid: string): string
+
+declare function interpolate(
+    fmt: string,
+    args: unknown[],
+    named?: boolean
+): string
+
+declare function staticUrl(path: string): string
+
+declare const settings: Record<string, unknown>
+
+interface Window {
+    settings?: Record<string, unknown>
+    csrfToken?: string
+}