@fiduswriter/document 0.1.0-alpha.3 → 0.1.0-alpha.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fiduswriter/document",
-  "version": "0.1.0-alpha.3",
+  "version": "0.1.0-alpha.5",
   "description": "Fidus Writer document schema, importers and exporters",
   "repository": {
     "type": "git",
@@ -9,20 +9,43 @@
   "license": "AGPL-3.0",
   "author": "Johannes Wilm",
   "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
-    ".": "./src/index.js",
-    "./schema": "./src/schema/index.js",
-    "./schema/*": "./src/schema/*",
-    "./importer/*": "./src/importer/*",
-    "./exporter/*": "./src/exporter/*",
-    "./citations/*": "./src/citations/*",
-    "./bibliography/*": "./src/bibliography/*"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./schema": {
+      "types": "./dist/schema/index.d.ts",
+      "default": "./dist/schema/index.js"
+    },
+    "./schema/*": {
+      "types": "./dist/schema/*.d.ts",
+      "default": "./dist/schema/*.js"
+    },
+    "./importer/*": {
+      "types": "./dist/importer/*.d.ts",
+      "default": "./dist/importer/*.js"
+    },
+    "./exporter/*": {
+      "types": "./dist/exporter/*.d.ts",
+      "default": "./dist/exporter/*.js"
+    },
+    "./citations/*": {
+      "types": "./dist/citations/*.d.ts",
+      "default": "./dist/citations/*.js"
+    },
+    "./bibliography/*": {
+      "types": "./dist/bibliography/*.d.ts",
+      "default": "./dist/bibliography/*.js"
+    }
   },
-  "main": "jest.config.js",
   "directories": {
     "test": "test"
   },
   "files": [
+    "dist/",
     "src/",
     "scripts/",
     "schema.json",
@@ -30,17 +53,20 @@
     "LICENSE"
   ],
   "scripts": {
-    "build-schema": "node scripts/export-schema.js",
-    "prepare": "node scripts/export-schema.js",
-    "prepublishOnly": "node scripts/export-schema.js",
+    "build": "tsc",
+    "build-schema": "tsx scripts/export-schema.js",
+    "prepare": "npm run build && npm run build-schema",
+    "prepublishOnly": "npm run build && npm run build-schema",
+    "typecheck": "tsc --noEmit",
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --config jest.config.js"
   },
   "dependencies": {
-    "fwtoolkit": "^0.1.1",
+    "@vivliostyle/print": "^2.42.0",
     "biblatex-csl-converter": "^3.0.0",
     "downloadjs": "^1.4.7",
     "fast-deep-equal": "^3.1.3",
     "fast-xml-parser": "^4.5.0",
+    "fwtoolkit": "^0.1.1",
     "jszip": "^3.10.1",
     "mathlive": "^0.104.0",
     "mathml-to-latex": "^1.4.3",
@@ -49,10 +75,19 @@
     "pretty": "^2.0.0",
     "prosemirror-model": "^1.25.0",
     "prosemirror-schema-basic": "^1.2.4",
-    "prosemirror-tables": "^1.6.4",
-    "@vivliostyle/print": "^2.42.0"
+    "prosemirror-tables": "^1.6.4"
   },
   "devDependencies": {
-    "jest": "^29.7.0"
+    "@types/node": "^26.0.1",
+    "@types/prosemirror-model": "^1.16.2",
+    "@types/prosemirror-schema-basic": "^1.0.2",
+    "@types/prosemirror-tables": "^0.8.0",
+    "@xmldom/xmldom": "^0.9.10",
+    "happy-dom": "^20.10.6",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.4.11",
+    "ts-jest-resolver": "^2.0.1",
+    "tsx": "^4.22.4",
+    "typescript": "^6.0.3"
   }
 }

package/scripts/export-schema.js

@@ -4,7 +4,7 @@ import {writeFileSync} from "node:fs"
 import {dirname, join} from "node:path"
 import {fileURLToPath} from "node:url"
 
-import {SchemaExport} from "../src/schema/export.js"
+import {SchemaExport} from "../dist/schema/export.js"
 
 const __dirname = dirname(fileURLToPath(import.meta.url))
 const outPath = join(__dirname, "..", "schema.json")

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

@@ -1,8 +1,10 @@
-export const text = {
+import type {MarkSpec, NodeSpec} from "prosemirror-model"
+
+export const text: NodeSpec = {
     group: "inline"
 }
 
-export const literal = {
+export const literal: NodeSpec = {
     content: "inline*",
     marks: "_",
     parseDOM: [{tag: "div.literal"}],
@@ -17,7 +19,7 @@ export const literal = {
     }
 }
 
-export const variable = {
+export const variable: NodeSpec = {
     inline: true,
     group: "inline",
     attrs: {
@@ -27,8 +29,9 @@ export const variable = {
         {
             tag: "span[data-variable]",
             getAttrs(dom) {
+                const element = dom as Element
                 return {
-                    variable: dom.getAttribute("data-variable")
+                    variable: element.getAttribute("data-variable")
                 }
             }
         }
@@ -36,13 +39,13 @@ export const variable = {
     toDOM(node) {
         return [
             "span",
-            {"data-variable": node.attrs.variable},
-            node.attrs.variable
+            {"data-variable": node.attrs.variable as string},
+            node.attrs.variable as string
         ]
     }
 }
 
-export const sup = {
+export const sup: MarkSpec = {
     parseDOM: [
         {tag: "sup"},
         {style: "vertical-align", getAttrs: value => value == "super" && null}
@@ -52,7 +55,7 @@ export const sup = {
     }
 }
 
-export const sub = {
+export const sub: MarkSpec = {
     parseDOM: [
         {tag: "sub"},
         {style: "vertical-align", getAttrs: value => value == "sub" && null}
@@ -62,7 +65,7 @@ export const sub = {
     }
 }
 
-export const smallcaps = {
+export const smallcaps: MarkSpec = {
     parseDOM: [
         {tag: "span.smallcaps"},
         {
@@ -75,16 +78,16 @@ export const smallcaps = {
     }
 }
 
-//Currently unsupported
+// Currently unsupported
 
-export const url = {
+export const url: MarkSpec = {
     parseDOM: [{tag: "span.url"}],
     toDOM() {
         return ["span", {class: "url"}]
     }
 }
 
-export const enquote = {
+export const enquote: MarkSpec = {
     parseDOM: [{tag: "span.enquote"}],
     toDOM() {
         return ["span", {class: "enquote"}]

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

@@ -1,13 +1,14 @@
 import {Schema} from "prosemirror-model"
 import {marks} from "prosemirror-schema-basic"
+
 import {smallcaps, sub, sup, text} from "./common.js"
 
-const doc = {content: "cslbib"}
+const doc: import("prosemirror-model").NodeSpec = {content: "cslbib"}
 
-const cslbib = {
+const cslbib: import("prosemirror-model").NodeSpec = {
     content: "cslentry*",
     parseDOM: [{tag: "div.csl-bib-body"}],
-    toDOM(_node) {
+    toDOM() {
         return [
             "div",
             {
@@ -18,10 +19,10 @@ const cslbib = {
     }
 }
 
-const cslentry = {
+const cslentry: import("prosemirror-model").NodeSpec = {
     content: "block*",
     parseDOM: [{tag: "div.csl-entry"}],
-    toDOM(_node) {
+    toDOM() {
         return [
             "div",
             {
@@ -36,12 +37,12 @@ const cslentry = {
 // system doesn't allow for the mixing of inline and block content, it "imagines"
 // that this block exists. This---rather than other blocks---is chosen, because
 // it's the first in the list.
-const cslinline = {
+const cslinline: import("prosemirror-model").NodeSpec = {
     group: "block",
     content: "text*",
     marks: "_",
     parseDOM: [{tag: "div.csl-inline"}],
-    toDOM(_node) {
+    toDOM() {
         return [
             "div",
             {
@@ -52,12 +53,12 @@ const cslinline = {
     }
 }
 
-const cslblock = {
+const cslblock: import("prosemirror-model").NodeSpec = {
     group: "block",
     content: "text*",
     marks: "_",
     parseDOM: [{tag: "div.csl-block"}],
-    toDOM(_node) {
+    toDOM() {
         return [
             "div",
             {
@@ -68,12 +69,12 @@ const cslblock = {
     }
 }
 
-const cslleftmargin = {
+const cslleftmargin: import("prosemirror-model").NodeSpec = {
     group: "block",
     content: "text*",
     marks: "_",
     parseDOM: [{tag: "div.csl-left-margin"}],
-    toDOM(_node) {
+    toDOM() {
         return [
             "div",
             {
@@ -84,12 +85,12 @@ const cslleftmargin = {
     }
 }
 
-const cslrightinline = {
+const cslrightinline: import("prosemirror-model").NodeSpec = {
     group: "block",
     content: "text*",
     marks: "_",
     parseDOM: [{tag: "div.csl-right-inline"}],
-    toDOM(_node) {
+    toDOM() {
         return [
             "div",
             {
@@ -100,12 +101,12 @@ const cslrightinline = {
     }
 }
 
-const cslindent = {
+const cslindent: import("prosemirror-model").NodeSpec = {
     group: "block",
     content: "text*",
     marks: "_",
     parseDOM: [{tag: "div.csl-indent"}],
-    toDOM(_node) {
+    toDOM() {
         return [
             "div",
             {

package/src/citations/{citeproc_sys.js → citeproc_sys.ts}

@@ -1,23 +1,37 @@
 /* Connects Fidus Writer citation system with citeproc */
 import {CSLExporter} from "biblatex-csl-converter"
 
+import type {BibDB} from "../types.js"
+
 export class citeprocSys {
-    constructor(bibDB) {
+    bibDB: BibDB
+    abbreviations: Record<string, Record<string, Record<string, string>>>
+    abbrevsname: string
+    // We cache values retrieved once.
+    items: Record<string, Record<string, unknown>>
+    missingItems: string[]
+
+    constructor(bibDB: BibDB) {
         this.bibDB = bibDB
         this.abbreviations = {
             default: {}
         }
         this.abbrevsname = "default"
-        // We cache values retrieved once.
         this.items = {}
         this.missingItems = []
     }
 
-    retrieveItem(id) {
+    retrieveItem(id: string): Record<string, unknown> {
         if (!this.items[id]) {
             if (this.bibDB.db[id]) {
-                const cslGetter = new CSLExporter(this.bibDB.db, [id])
-                const cslOutput = cslGetter.parse()
+                const cslGetter = new CSLExporter(
+                    this.bibDB.db as Record<string, any>,
+                    [id]
+                )
+                const cslOutput = cslGetter.parse() as Record<
+                    string,
+                    Record<string, unknown>
+                >
                 Object.assign(this.items, cslOutput)
             } else {
                 this.missingItems.push(id)
@@ -27,7 +41,13 @@ export class citeprocSys {
         return this.items[id]
     }
 
-    getAbbreviation(_dummy, obj, _jurisdiction, vartype, key) {
+    getAbbreviation(
+        _dummy: string,
+        obj: Record<string, Record<string, Record<string, string>>>,
+        _jurisdiction: string,
+        vartype: string,
+        key: string
+    ): void {
         try {
             if (this.abbreviations[this.abbrevsname][vartype][key]) {
                 obj["default"][vartype][key] =

package/src/citations/{format.js → format.ts}

@@ -1,16 +1,42 @@
 import {escapeText} from "fwtoolkit"
+
+import type {
+    BibDB,
+    BibliographyResult,
+    CiteprocInstance,
+    CSL
+} from "../types.js"
 import {citeprocSys} from "./citeproc_sys.js"
-/*
- * Use CSL and bibDB to format all citations for the given prosemirror json citation nodes
- */
 
+interface CitationInfo {
+    format: string
+    references: Array<{id: number; [key: string]: unknown}>
+}
+
+/**
+ * Use CSL and bibDB to format all citations for the given ProseMirror JSON citation nodes.
+ */
 export class FormatCitations {
+    csl: CSL
+    allCitationInfos: CitationInfo[]
+    citationStyle: string
+    bibliographyHeader: string
+    bibDB: BibDB
+    synchronous: boolean
+    lang: string
+
+    bibliography: BibliographyResult | false
+    citations: Array<{citationItems: unknown[]; properties: {noteIndex: number}}>
+    bibFormats: string[]
+    citationTexts: string[]
+    citationType: string
+
     constructor(
-        csl,
-        allCitationInfos,
-        citationStyle,
-        bibliographyHeader,
-        bibDB,
+        csl: CSL,
+        allCitationInfos: CitationInfo[],
+        citationStyle: string,
+        bibliographyHeader: string,
+        bibDB: BibDB,
         synchronous = false,
         lang = "en-US"
     ) {
@@ -21,9 +47,15 @@ export class FormatCitations {
         this.bibDB = bibDB
         this.synchronous = synchronous
         this.lang = lang
+
+        this.bibliography = false
+        this.citations = []
+        this.bibFormats = []
+        this.citationTexts = []
+        this.citationType = ""
     }
 
-    init() {
+    init(): boolean | Promise<void> {
         this.bibliography = false
         this.citations = []
         this.bibFormats = []
@@ -33,7 +65,7 @@ export class FormatCitations {
         return this.getFormattedCitations()
     }
 
-    formatAllCitations() {
+    formatAllCitations(): void {
         this.allCitationInfos.forEach(cInfo => {
             this.bibFormats.push(cInfo.format)
             this.citations.push({
@@ -45,7 +77,7 @@ export class FormatCitations {
         })
     }
 
-    get bibHTML() {
+    get bibHTML(): string {
         if (!this.bibliography || !this.bibliography[0].entry_ids.length) {
             return ""
         }
@@ -55,7 +87,7 @@ export class FormatCitations {
     }
 
     // CSS
-    get bibCSS() {
+    get bibCSS(): string {
         if (!this.bibliography || !this.bibliography[0].entry_ids.length) {
             return ""
         }
@@ -86,7 +118,7 @@ export class FormatCitations {
         return css
     }
 
-    reloadCitations(missingItems) {
+    reloadCitations(missingItems: string[]): Promise<void> {
         // Not all citations could be found in the database.
         // Reload the database if possible, but don't cycle if no new matches are found.
         if (!this.bibDB.getDB) {
@@ -95,16 +127,19 @@ export class FormatCitations {
 
         return this.bibDB.getDB().then(() => {
             if (missingItems.some(item => this.bibDB.db.hasOwnProperty(item))) {
-                return this.init()
+                return this.init() as Promise<void>
             } else {
                 return Promise.resolve()
             }
         })
     }
 
-    getFormattedCitations() {
+    getFormattedCitations(): boolean | Promise<void> {
         const citeprocConnector = new citeprocSys(this.bibDB)
         if (this.synchronous) {
+            if (!this.csl.getEngineSync) {
+                return false
+            }
             const citeprocInstance = this.csl.getEngineSync(
                 citeprocConnector,
                 this.citationStyle,
@@ -116,6 +151,9 @@ export class FormatCitations {
             this.process(citeprocInstance)
             return true
         } else {
+            if (!this.csl.getEngine) {
+                return Promise.resolve()
+            }
             return this.csl
                 .getEngine(citeprocConnector, this.citationStyle, this.lang)
                 .then(citeprocInstance => {
@@ -131,10 +169,10 @@ export class FormatCitations {
         }
     }
 
-    process(citeprocInstance) {
-        const allIds = []
+    process(citeprocInstance: CiteprocInstance): void {
+        const allIds: string[] = []
         this.citations.forEach(cit =>
-            cit.citationItems.forEach(item => allIds.push(String(item.id)))
+            cit.citationItems.forEach(item => allIds.push(String((item as {id: number}).id)))
         )
         citeprocInstance.updateItems(allIds)
 
@@ -147,18 +185,32 @@ export class FormatCitations {
                     true
                 )
             if (inText && "textcite" == this.bibFormats[i]) {
-                const items = citation.citationItems
+                const items = citation.citationItems as Array<{
+                    id: number
+                    locator?: string
+                    prefix?: string
+                }>
                 let newCiteText = ""
 
                 for (let j = 0; j < items.length; j++) {
-                    const onlyNameOption = [
+                    const onlyNameOption: Array<{
+                        id: number
+                        "author-only": number
+                        locator?: string
+                        prefix?: string
+                    }> = [
                         {
                             id: items[j].id,
                             "author-only": 1
                         }
                     ]
 
-                    const onlyDateOption = [
+                    const onlyDateOption: Array<{
+                        id: number
+                        "suppress-author": number
+                        locator?: string
+                        prefix?: string
+                    }> = [
                         {
                             id: items[j].id,
                             "suppress-author": 1
@@ -180,8 +232,12 @@ export class FormatCitations {
                     }
                     newCiteText += `${citeprocInstance.makeCitationCluster(onlyNameOption)} ${citeprocInstance.makeCitationCluster(onlyDateOption)}`
                 }
-                citationTexts.find(citationText => citationText[0] === i)[1] =
-                    newCiteText
+                const target = citationTexts.find(
+                    citationText => citationText[0] === i
+                )
+                if (target) {
+                    target[1] = newCiteText
+                }
             }
             citationTexts.forEach(
                 ([index, citationText]) =>
@@ -189,6 +245,6 @@ export class FormatCitations {
             )
         }
         this.citationType = citeprocInstance.cslXml.dataObj.attrs.class
-        this.bibliography = citeprocInstance.makeBibliography()
+        this.bibliography = citeprocInstance.makeBibliography() as BibliographyResult
     }
 }