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

package/src/schema/const.ts

@@ -0,0 +1,58 @@
+export const LANGUAGES: Array<[string, string, string]> = [
+    ["af-ZA", gettext("Afrikaans"), "ltr"],
+    ["sq-AL", gettext("Albanian"), "ltr"],
+    ["ar", gettext("Arabic"), "rtl"],
+    ["ast", gettext("Asturian"), "ltr"],
+    ["be", gettext("Belarusian"), "ltr"],
+    ["br", gettext("Breton"), "ltr"],
+    ["bg", gettext("Bulgarian"), "ltr"],
+    ["ca", gettext("Catalan"), "ltr"],
+    ["ca-ES-Valencia", gettext("Catalan (Valencia)"), "ltr"],
+    ["zh-CN", gettext("Chinese (Simplified)"), "ltr"],
+    ["da", gettext("Danish"), "ltr"],
+    ["nl", gettext("Dutch"), "ltr"],
+    ["en-AU", gettext("English (Australia)"), "ltr"],
+    ["en-CA", gettext("English (Canada)"), "ltr"],
+    ["en-NZ", gettext("English (New Zealand)"), "ltr"],
+    ["en-ZA", gettext("English (South Africa)"), "ltr"],
+    ["en-GB", gettext("English (United Kingdom)"), "ltr"],
+    ["en-US", gettext("English (United States)"), "ltr"],
+    ["eo", gettext("Esperanto"), "ltr"],
+    ["fr", gettext("French"), "ltr"],
+    ["gl", gettext("Galician"), "ltr"],
+    ["de-DE", gettext("German (Germany)"), "ltr"],
+    ["de-AU", gettext("German (Austria)"), "ltr"],
+    ["de-CH", gettext("German (Switzerland)"), "ltr"],
+    ["el", gettext("Greek"), "ltr"],
+    ["he", gettext("Hebrew"), "rtl"],
+    ["is", gettext("Icelandic"), "ltr"],
+    ["it", gettext("Italian"), "ltr"],
+    ["ja", gettext("Japanese"), "ltr"],
+    ["km", gettext("Khmer"), "ltr"],
+    ["lt", gettext("Lithuanian"), "ltr"],
+    ["ml", gettext("Malayalam"), "ltr"],
+    ["nb-NO", gettext("Norwegian (bokmål)"), "ltr"],
+    ["nn-NO", gettext("Norwegian (nynorsk)"), "ltr"],
+    ["fa", gettext("Persian"), "rtl"],
+    ["pl", gettext("Polish"), "ltr"],
+    ["pt-BR", gettext("Portuguese (Brazil)"), "ltr"],
+    ["pt-PT", gettext("Portuguese (Portugal)"), "ltr"],
+    ["ro", gettext("Romanian"), "ltr"],
+    ["ru", gettext("Russian"), "ltr"],
+    ["tr", gettext("Turkish"), "ltr"],
+    ["sr-SP-Cy", gettext("Serbian (Cyrillic)"), "ltr"],
+    ["sr-SP-Lt", gettext("Serbian (Latin)"), "ltr"],
+    ["sk", gettext("Slovak"), "ltr"],
+    ["sl", gettext("Slovenian"), "ltr"],
+    ["es", gettext("Spanish"), "ltr"],
+    ["sv", gettext("Swedish"), "ltr"],
+    ["ta", gettext("Tamil"), "ltr"],
+    ["tl", gettext("Tagalog"), "ltr"],
+    ["uk", gettext("Ukrainian"), "ltr"]
+]
+
+export const PAPER_SIZES: Array<[string, string]> = [
+    /* [Fidus Writer value, CSS value]*/
+    ["A4", "A4"],
+    ["US Letter", "letter"]
+]

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

@@ -1,3 +1,7 @@
+// @ts-nocheck
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type {BibDB, FidusDoc} from "../types.js"
+
 /* To convert to and from how the document is stored in the database to how ProseMirror expects it.
  We use the DOM import for ProseMirror as the JSON we store in the database is really jsonized HTML.
 */
@@ -1246,7 +1250,7 @@ const convertNodeV32 = (node, ids = []) => {
 
 const convertDocV32 = doc => {
     const returnDoc = JSON.parse(JSON.stringify(doc))
-    convertNodeV32(returnDoc.content)
+    convertNodeV32(returnDoc)
     return returnDoc
 }
 
@@ -1260,7 +1264,7 @@ const convertDocV33 = doc => {
 const convertDocV34 = doc => {
     // The top node needs to be changed from "article" to "doc".
     const returnDoc = JSON.parse(JSON.stringify(doc))
-    returnDoc.content.type = "doc"
+    returnDoc.type = "doc"
     return returnDoc
 }
 

package/src/schema/document/{content.js → content.ts}

@@ -1,8 +1,10 @@
 import {escapeText} from "fwtoolkit"
+import type {MarkSpec, NodeSpec} from "prosemirror-model"
+
 import {parseTracks} from "../common/index.js"
 import {fnNodeToHtml, htmlToFnNode} from "../footnotes_convert.js"
 
-export const randomCodeBlockId = () => {
+export const randomCodeBlockId = (): string => {
     return `C${Math.round(Math.random() * 10000000) + 1}`
 }
 
@@ -21,12 +23,12 @@ export const contributor = {
     parseDOM: [
         {
             tag: "span.contributor",
-            getAttrs(dom) {
+            getAttrs(dom: HTMLElement) {
                 return {
-                    firstname: dom.dataset.firstname,
-                    lastname: dom.dataset.lastname,
-                    email: dom.dataset.email,
-                    institution: dom.dataset.institution,
+                    firstname: dom.dataset.firstname || false,
+                    lastname: dom.dataset.lastname || false,
+                    email: dom.dataset.email || false,
+                    institution: dom.dataset.institution || false,
                     id_type: dom.dataset.id_type || false,
                     id_value: dom.dataset.id_value || false
                 }
@@ -36,17 +38,17 @@ export const contributor = {
     toDOM(node) {
         const dom = document.createElement("span")
         dom.classList.add("contributor")
-        dom.dataset.firstname = node.attrs.firstname
-        dom.dataset.lastname = node.attrs.lastname
-        dom.dataset.email = node.attrs.email
-        dom.dataset.institution = node.attrs.institution
+        dom.dataset.firstname = node.attrs.firstname || ""
+        dom.dataset.lastname = node.attrs.lastname || ""
+        dom.dataset.email = node.attrs.email || ""
+        dom.dataset.institution = node.attrs.institution || ""
         if (node.attrs.id_type) {
             dom.dataset.id_type = node.attrs.id_type
         }
         if (node.attrs.id_value) {
             dom.dataset.id_value = node.attrs.id_value
         }
-        const content = []
+        const content: string[] = []
         if (node.attrs.firstname) {
             content.push(escapeText(node.attrs.firstname))
         }
@@ -71,7 +73,7 @@ export const contributor = {
 
         return dom
     }
-}
+} satisfies NodeSpec
 
 export const tag = {
     inline: true,
@@ -84,7 +86,7 @@ export const tag = {
     parseDOM: [
         {
             tag: "span.tag",
-            getAttrs(dom) {
+            getAttrs(dom: HTMLElement) {
                 return {
                     tag: dom.innerText
                 }
@@ -94,7 +96,7 @@ export const tag = {
     toDOM(node) {
         return ["span", {class: "tag"}, node.attrs.tag]
     }
-}
+} satisfies NodeSpec
 
 export const footnote = {
     inline: true,
@@ -111,9 +113,9 @@ export const footnote = {
     parseDOM: [
         {
             tag: "span.footnote-marker[data-footnote]",
-            getAttrs(dom) {
+            getAttrs(dom: HTMLElement) {
                 return {
-                    footnote: htmlToFnNode(dom.dataset.footnote)
+                    footnote: htmlToFnNode(dom.dataset.footnote || "")
                 }
             }
         }
@@ -125,7 +127,7 @@ export const footnote = {
         dom.innerHTML = " "
         return dom
     }
-}
+} satisfies NodeSpec
 
 export const code_block = {
     content: "text*",
@@ -154,7 +156,7 @@ export const code_block = {
         {
             tag: "pre",
             preserveWhitespace: "full",
-            getAttrs(dom) {
+            getAttrs(dom: HTMLElement) {
                 return {
                     track: parseTracks(dom.dataset.track),
                     language: dom.dataset.language || "",
@@ -166,7 +168,7 @@ export const code_block = {
         }
     ],
     toDOM(node) {
-        const attrs = {}
+        const attrs: Record<string, unknown> = {}
         if (node.attrs.track.length) {
             attrs["data-track"] = JSON.stringify(node.attrs.track)
         }
@@ -184,4 +186,4 @@ export const code_block = {
         }
         return ["pre", attrs, ["code", 0]]
     }
-}
+} satisfies NodeSpec

package/src/schema/document/{structure.js → structure.ts}

@@ -1,3 +1,5 @@
+import type {NodeSpec} from "prosemirror-model"
+
 export const doc = {
     content: "title part*",
     selectable: false,
@@ -200,7 +202,7 @@ export const doc = {
     parseDOM: [
         {
             tag: "div.doc",
-            getAttrs(dom) {
+            getAttrs(dom: HTMLElement) {
                 return {
                     papersize: dom.dataset.papersize,
                     citationstyle: dom.dataset.citationstyle,
@@ -221,9 +223,13 @@ export const doc = {
             0
         ]
     }
-}
+} satisfies NodeSpec
 
-const partSpec = (type, content, attrs = {}) => ({
+const partSpec = (
+    type: string,
+    content: string,
+    extraAttrs: Record<string, {default: unknown}> = {}
+): NodeSpec => ({
     content,
     group: "part",
     marks: "annotation track",
@@ -259,12 +265,12 @@ const partSpec = (type, content, attrs = {}) => ({
                 default: false
             }
         },
-        attrs
+        extraAttrs
     ),
     parseDOM: [
         {
             tag: `div.doc-${type}`,
-            getAttrs(dom) {
+            getAttrs(dom: HTMLElement) {
                 return {
                     hidden: dom.dataset.hidden === "true" ? true : false
                 }
@@ -272,7 +278,7 @@ const partSpec = (type, content, attrs = {}) => ({
         }
     ],
     toDOM(node) {
-        const attrs = {
+        const attrs: Record<string, unknown> = {
             class: `doc-part doc-${type} ${node.attrs.id ? `doc-${node.attrs.id}` : "doc-no-id"}`
         }
         if (node.attrs.hidden) {
@@ -400,7 +406,7 @@ export const table_of_contents = {
         dom.innerHTML = `<h1 class="toc">${node.attrs.title}</h1>`
         return dom
     }
-}
+} satisfies NodeSpec
 
 export const separator_part = {
     marks: "annotation track",
@@ -422,7 +428,7 @@ export const separator_part = {
         dom.classList.add(`doc-${node.attrs.id}`)
         return dom
     }
-}
+} satisfies NodeSpec
 
 export const title = {
     content: "text*",
@@ -449,4 +455,4 @@ export const title = {
             0
         ]
     }
-}
+} satisfies NodeSpec

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

@@ -1,12 +1,14 @@
 import {docSchema} from "./document/index.js"
 
 export class SchemaExport {
+    schema: typeof docSchema
+
     constructor() {
         this.schema = docSchema
     }
 
-    init() {
-        const spec = {
+    init(): string {
+        const spec: {nodes: Record<string, unknown>; marks: Record<string, unknown>} = {
             nodes: {},
             marks: {}
         }

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

@@ -1,4 +1,5 @@
 import OrderedMap from "orderedmap"
+import type {Node, NodeSpec} from "prosemirror-model"
 import {Schema} from "prosemirror-model"
 import {marks, nodes} from "prosemirror-schema-basic"
 import {tableNodes} from "prosemirror-tables"
@@ -32,18 +33,18 @@ import {
     underline
 } from "./common/index.js"
 
-const footnotecontainer = {
+const footnotecontainer: NodeSpec = {
     group: "part",
     selectable: false,
     content: "(block|table_block)+",
     marks: "annotation",
     parseDOM: [{tag: "div.footnote-container"}],
-    toDOM(_node) {
+    toDOM(_node: Node) {
         return ["div", {class: "footnote-container"}, 0]
     }
 }
 
-const doc = {
+const doc: NodeSpec = {
     content: "part*",
     selectable: false
 }
@@ -91,20 +92,22 @@ const spec = {
 spec.nodes = spec.nodes.append(
     tableNodes({
         tableGroup: "table_block",
-        cellContent: "block+"
+        cellContent: "block+",
+        cellAttributes: {}
     })
 )
 
+const tableSpec = spec.nodes.get("table") || {}
 spec.nodes = spec.nodes.update(
     "table",
-    Object.assign({}, spec.nodes.get("table"), {
+    Object.assign({}, tableSpec, {
         attrs: {
             track: {default: []}
         },
         parseDOM: [
             {
                 tag: "table",
-                getAttrs(dom) {
+                getAttrs(dom: HTMLElement) {
                     return {
                         track: dom.dataset.track
                             ? JSON.parse(dom.dataset.track)
@@ -113,8 +116,8 @@ spec.nodes = spec.nodes.update(
                 }
             }
         ],
-        toDOM(node) {
-            const attrs = {}
+        toDOM(node: Node) {
+            const attrs: Record<string, unknown> = {}
             if (node.attrs.track.length) {
                 attrs["data-track"] = JSON.stringify(node.attrs.track)
             }

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

@@ -3,20 +3,22 @@ import {DOMParser, DOMSerializer, Node} from "prosemirror-model"
 import {fnSchema} from "./footnotes.js"
 
 // Convert the footnote HTML stored with the marker to a PM node representation of the footnote.
-export const htmlToFnNode = content => {
+export const htmlToFnNode = (content: string): unknown[] => {
     const footnoteDOM = document.createElement("div")
     footnoteDOM.classList.add("footnote-container")
     footnoteDOM.innerHTML = content
     const node = DOMParser.fromSchema(fnSchema).parse(footnoteDOM, {
         preserveWhitespace: true,
-        topNode: false
+        topNode: false as unknown as Node
     })
-    const json = node.firstChild.toJSON().content
-
-    return json
+    const firstChild = node.firstChild
+    if (!firstChild) {
+        return []
+    }
+    return firstChild.toJSON().content
 }
 
-export const fnNodeToPmNode = fnContents => {
+export const fnNodeToPmNode = (fnContents: unknown[]): Node => {
     const footnote = {
         type: "footnotecontainer",
         content: fnContents
@@ -24,8 +26,9 @@ export const fnNodeToPmNode = fnContents => {
     return Node.fromJSON(fnSchema, footnote)
 }
 
-export const fnNodeToHtml = jsonString => {
+export const fnNodeToHtml = (jsonString: unknown[]): string => {
     const pmNode = fnNodeToPmNode(jsonString),
         serializer = DOMSerializer.fromSchema(fnSchema)
-    return serializer.serializeNode(pmNode).innerHTML
+    const dom = serializer.serializeNode(pmNode)
+    return dom instanceof HTMLElement ? dom.innerHTML : ""
 }