@fiduswriter/bibliography-manager 0.1.7 → 0.1.8

package/src/schema/{title.js → title.ts}

@@ -14,7 +14,7 @@ import {marks} from "prosemirror-schema-basic"
 const nocase = {
     parseDOM: [{tag: "span.nocase"}],
     toDOM() {
-        return ["span", {class: "nocase"}]
+        return ["span", {class: "nocase"}] as const
     }
 }
 

package/src/{tools.js → tools.ts}

@@ -1,6 +1,8 @@
+import type {NameDictObject, NodeArray, TextNodeObject} from "./types/biblio.js"
+
 // Extract a display year from an EDTF date string.
 // Handles simple years, ranges (2023/2024), uncertainty (?, *, u), and open-ended dates.
-export function dateToYear(dateStr) {
+export function dateToYear(dateStr: string): string {
     if (!dateStr) {
         return ""
     }
@@ -11,17 +13,17 @@ export function dateToYear(dateStr) {
 }
 
 // Takes any richtext text field as used in bibliography and returns the text contents
-export function litToText(litStringArray) {
+export function litToText(litStringArray: NodeArray): string {
     let outText = ""
     litStringArray.forEach(litString => {
         if (litString.type === "text") {
-            outText += litString.text
+            outText += (litString as TextNodeObject).text
         }
     })
     return outText
 }
 
-function nameListItemToString(nameListItem) {
+function nameListItemToString(nameListItem: NameDictObject): string {
     let nameString = ""
     if (nameListItem["family"]) {
         nameString += litToText(nameListItem["family"])
@@ -34,7 +36,7 @@ function nameListItemToString(nameListItem) {
     return nameString
 }
 
-export function nameToText(nameList) {
+export function nameToText(nameList: NameDictObject[]): string {
     let nameString
     switch (nameList.length) {
         case 0:

package/src/types/biblio.ts

@@ -0,0 +1,189 @@
+import {BibFieldTypes, BibTypes} from "bibliojson"
+import type {BibDB as BiblioBibDB} from "bibliojson"
+
+// Derive bibliojson's `EntryObject` from its exported `BibDB` type so we can
+// extend it without importing the unexported `EntryObject` symbol.
+export type EntryObject = BiblioBibDB[number]
+
+// Derive the bibliojson field/type descriptors from their runtime objects.
+export type BibFieldType = (typeof BibFieldTypes)[string] & {title?: string}
+export type BibType = (typeof BibTypes)[string]
+
+// Local types that mirror the shapes declared by bibliojson but are not
+// exported from that package.
+
+export interface MarkObject {
+    type: string
+}
+
+export interface TextNodeObject {
+    type: "text"
+    text: string
+    marks?: MarkObject[]
+    attrs?: Record<string, unknown>
+}
+
+export interface OtherNodeObject {
+    type: string
+    marks?: MarkObject[]
+    attrs?: Record<string, unknown>
+}
+
+export type NodeObject = OtherNodeObject | TextNodeObject
+
+export type NodeArray = NodeObject[]
+
+export type NameDictObject = {
+    literal?: NodeArray
+    family?: NodeArray
+    given?: NodeArray
+    prefix?: NodeArray
+    suffix?: NodeArray
+    useprefix?: boolean
+}
+
+export type RangeArray = [NodeArray, NodeArray] | [NodeArray]
+
+/** A single bibliography category stored on the client. */
+export interface BibCategory {
+    id: number
+    category_title: string
+}
+
+/** Client-side bibliography entry.
+ *
+ * Composes bibliojson's `EntryObject` with the extra `cats` field and the
+ * server-side `id` the Fidus Writer backend attaches to each entry.
+ */
+export interface BibDBEntry extends EntryObject {
+    /** Categories the entry belongs to. */
+    cats: number[]
+    /** Server-side primary key (present in entries received from the server). */
+    id?: number
+}
+
+/** Client-side bibliography database, keyed by server id. */
+export type BibDB = Record<number, BibDBEntry>
+
+/** Translation of a temporary client-side id to the server-side id. */
+export type IdTranslation = [number, number]
+
+/** Single bibliography item as returned in the server's `bib_list` array. */
+export interface ServerBibItem {
+    id: number
+    bibDBEntry: BibDBEntry
+}
+
+/** Shape of the response from `POST /api/bibliography/biblist/`. */
+export interface BiblistResponse {
+    bib_categories: BibCategory[]
+    bib_list?: BibDBEntry[]
+    last_modified: number
+    number_of_entries: number
+    user_id: number
+}
+
+/** Shape of the request body for `POST /api/bibliography/save/`. */
+export interface SaveBibEntriesRequest {
+    is_new: boolean
+    bibs: Record<number, BibDBEntry>
+}
+
+/** Shape of the response from `POST /api/bibliography/save/`. */
+export interface SaveBibEntriesResponse {
+    id_translations: IdTranslation[]
+}
+
+/** Shape of the request body for `POST /api/bibliography/save_category/`. */
+export interface SaveCategoriesRequest {
+    ids: number[]
+    titles: string[]
+}
+
+/** Shape of the response from `POST /api/bibliography/save_category/`. */
+export interface SaveCategoriesResponse {
+    entries: BibCategory[]
+}
+
+/** Shape of the request body for `POST /api/bibliography/delete_category/`. */
+export interface DeleteCategoryRequest {
+    ids: number[]
+}
+
+/** Shape of the request body for `POST /api/bibliography/delete/`. */
+export interface DeleteBibEntriesRequest {
+    ids: number[]
+}
+
+/** Union of all possible field values handled by the form field classes. */
+export type FieldValue =
+    | string
+    | number
+    | boolean
+    | NodeArray
+    | NameDictObject[]
+    | RangeArray[]
+    | string[]
+    | number[]
+
+/** Common interface implemented by every bibliography form field class. */
+export interface FieldForm {
+    init(): void
+    readonly value: unknown
+    check(): boolean
+}
+
+/** Constructor signature for a class that implements `FieldForm`. */
+export interface FieldFormConstructor {
+    new (
+        dom: HTMLElement,
+        initialValue?: unknown,
+        placeHolder?: string | false,
+        fieldType?: BibFieldType
+    ): FieldForm
+}
+
+/** Map from `BibFieldType.type` to the form field class that renders it. */
+export type FieldFormsMap = Record<string, FieldFormConstructor | undefined>
+
+/** Object describing the current values of a bibliography entry being edited. */
+export interface CurrentBibValues {
+    bib_type: string | false
+    cats: number[]
+    entry_key: string
+    fields: Record<string, unknown>
+}
+
+/** Shape returned by `BibEntryForm.value`. */
+export interface FormValue {
+    bib_type: string
+    cats: (string | number)[]
+    entry_key: string
+    fields: Record<string, unknown>
+}
+
+/** Operations exposed by the bibliography database manager. */
+export interface BibDBCollection {
+    db: BibDB
+    cats: BibCategory[]
+    saveBibEntries(
+        tmpDB: Record<number, BibDBEntry>,
+        isNew: boolean
+    ): Promise<IdTranslation[]>
+    saveCategories(cats: SaveCategoriesRequest): Promise<BibCategory[]>
+    deleteBibEntries(ids: number[]): Promise<number[]>
+}
+
+/** Subset of the main Fidus Writer app object used by bibliography code. */
+export interface BibliographyApp {
+    bibDB: BibDBCollection
+    isOffline: () => boolean
+    settings: {
+        APPS: string[]
+    }
+    name: string
+}
+
+// Maintain the legacy `BibDB` alias for bibliojson's type as well, but export
+// our own BibDB as the primary type.
+export type {BiblioBibDB}

package/src/database/server_connector.js

@@ -1,57 +0,0 @@
-import {post, postJson} from "fwtoolkit/network"
-
-// class for server calls of BibliographyDB.
-export class BibliographyDBServerConnector {
-    constructor() {}
-
-    getDB(lastModified, numberOfEntries, localStorageOwnerId) {
-        return postJson("/api/bibliography/biblist/", {
-            last_modified: lastModified,
-            number_of_entries: numberOfEntries,
-            user_id: localStorageOwnerId
-        }).then(({json}) => {
-            return {
-                bibCats: json["bib_categories"],
-                bibList: json.hasOwnProperty("bib_list")
-                    ? json["bib_list"].map(item =>
-                          this.serverBibItemToBibDB(item)
-                      )
-                    : false,
-                lastModified: json["last_modified"],
-                numberOfEntries: json["number_of_entries"],
-                userId: json["user_id"]
-            }
-        })
-    }
-
-    /** Converts a bibliography item as it arrives from the server to a BibDB object.
-     * @function serverBibItemToBibDB
-     * @param item The bibliography item from the server.
-     */
-    serverBibItemToBibDB(bibDBEntry) {
-        return {id: bibDBEntry["id"], bibDBEntry}
-    }
-
-    saveBibEntries(tmpDB, isNew) {
-        return postJson("/api/bibliography/save/", {
-            is_new: isNew,
-            bibs: tmpDB
-        }).then(({json}) => json["id_translations"])
-    }
-
-    saveCategories(cats) {
-        return postJson("/api/bibliography/save_category/", cats).then(
-            ({json}) => {
-                return json.entries
-            }
-        )
-    }
-
-    deleteCategory(ids) {
-        return post("/api/bibliography/delete_category/", {ids})
-    }
-
-    deleteBibEntries(ids) {
-        return post("/api/bibliography/delete/", {ids})
-    }
-}

package/src/form/fields/name_list.js

@@ -1,42 +0,0 @@
-import {InputList} from "fwtoolkit"
-import {NameFieldForm} from "./name.js"
-
-export class NameListForm {
-    constructor(dom, initialValue = [[]]) {
-        this.dom = dom
-        this.fieldHandlers = new WeakMap()
-        this.inputList = new InputList({
-            dom,
-            initialValues: initialValue,
-            emptyValue: [],
-            renderItem: value => ({
-                html: `<div class="name-field"></div>`,
-                bind: el => {
-                    const fieldHandler = new NameFieldForm(
-                        el.firstElementChild,
-                        value
-                    )
-                    fieldHandler.init()
-                    this.fieldHandlers.set(el, fieldHandler)
-                }
-            }),
-            getValue: el => this.fieldHandlers.get(el).value
-        })
-    }
-
-    init() {
-        // InputList is already rendered by the constructor.
-    }
-
-    get value() {
-        const formValue = this.inputList.values.filter(value => value !== false)
-        if (formValue.length === 0) {
-            return false
-        }
-        return formValue
-    }
-
-    check() {
-        return true
-    }
-}

package/src/import/index.js

@@ -1,2 +0,0 @@
-export {BibliographyFileImportDialog} from "./dialog.js"
-export {BibliographyImporter} from "./bibliography_import.js"

package/src/plugins/bibliography_overview/index.js

@@ -1 +0,0 @@
-export const plugins = []