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

package/dist/schema/mini_json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mini_json.js","sourceRoot":"","sources":["../../src/schema/mini_json.js"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,iBAAiB,CAAA;AAEvC,MAAM,UAAU,UAAU,CAAC,IAAI;IAC3B,uDAAuD;IACvD,uEAAuE;IACvE,+BAA+B;IAC/B,oIAAoI;IACpI,MAAM,GAAG,GAAG,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAC,CAAA;IAClC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAC5B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YAC9D,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;gBACb,GAAG,CAAC,KAAK,GAAG,EAAE,CAAA;YAClB,CAAC;YACD,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,QAAQ,CACtD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAC1B;gBACG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;gBAClB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACtD,CAAC;IACL,CAAC;IACD,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QACpB,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAC/C,UAAU,CAAC,SAAS,CAAC,CACxB,CAAA;IACL,CAAC;IAED,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QACpB,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAA;IAC5D,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACZ,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;IACxB,CAAC;IAED,OAAO,GAAG,CAAA;AACd,CAAC;AAED,SAAS,cAAc,CAAC,IAAI;IACxB,kIAAkI;IAClI,MAAM,GAAG,GAAG,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAC,CAAA;IAClC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAC5B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YAC9D,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;gBACb,GAAG,CAAC,KAAK,GAAG,EAAE,CAAA;YAClB,CAAC;YACD,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,QAAQ,CACtD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAC1B;gBACG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;gBAClB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACtD,CAAC;IACL,CAAC;IACD,OAAO,GAAG,CAAA;AACd,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,QAAQ,EAAE,MAAM;IACvC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QACjB,QAAQ,CAAC,IAAI,GAAG,KAAK,CAAA;IACzB,CAAC;IACD,OAAO,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,CAAA;AACjD,CAAC"}

package/dist/schema/text.d.ts

@@ -0,0 +1,2 @@
+export function getNonDeletedTextContent(topNode: any): string;
+//# sourceMappingURL=text.d.ts.map

package/dist/schema/text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../src/schema/text.js"],"names":[],"mappings":"AAAA,+DAqBC"}

package/dist/schema/text.js

@@ -0,0 +1,23 @@
+export function getNonDeletedTextContent(topNode) {
+    let text = "";
+    topNode.descendants(node => {
+        if (node.marks.find(mark => mark.type.name === "deletion") ||
+            (node.attrs &&
+                (node.attrs.track?.find(track => track.type === "deletion") ||
+                    node.attrs.hidden))) {
+            return;
+        }
+        else if (node.isBlock) {
+            text += "\n";
+        }
+        else if (node.isText) {
+            text += node.text;
+        }
+    });
+    return text
+        .replace(/(^\s*)|(\s*$)/gi, "")
+        .replace(/[ ]{2,}/gi, " ")
+        .replace(/\n /, "\n")
+        .replace(/\n{2,}/gi, "\n");
+}
+//# sourceMappingURL=text.js.map

package/dist/schema/text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.js","sourceRoot":"","sources":["../../src/schema/text.js"],"names":[],"mappings":"AAAA,MAAM,UAAU,wBAAwB,CAAC,OAAO;IAC5C,IAAI,IAAI,GAAG,EAAE,CAAA;IACb,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE;QACvB,IACI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC;YACtD,CAAC,IAAI,CAAC,KAAK;gBACP,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,UAAU,CAAC;oBACvD,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAC7B,CAAC;YACC,OAAM;QACV,CAAC;aAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACtB,IAAI,IAAI,IAAI,CAAA;QAChB,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACrB,IAAI,IAAI,IAAI,CAAC,IAAI,CAAA;QACrB,CAAC;IACL,CAAC,CAAC,CAAA;IACF,OAAO,IAAI;SACN,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC;SAC9B,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC;SACzB,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC;SACpB,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;AAClC,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,122 @@
+/**
+ * Core types shared across the @fiduswriter/document package.
+ *
+ * These types describe the JSON-shaped document tree that Fidus Writer stores
+ * and exchanges with its importers/exporters. They intentionally mirror the
+ * ProseMirror schema while staying serialisable.
+ */
+/** A generic JSON value. */
+export type JSONValue = string | number | boolean | null | JSONValue[] | {
+    [key: string]: JSONValue;
+};
+/** Attributes that every Fidus node may carry. */
+export interface NodeAttrs {
+    [key: string]: unknown;
+    id?: string;
+    track?: Track[];
+    hidden?: boolean;
+}
+/** A tracked change entry attached to a node or mark. */
+export interface Track {
+    type: "insertion" | "deletion" | "block_change";
+    user: number;
+    username: string;
+    date: number;
+    approved?: boolean;
+    before?: FidusNode;
+}
+/** A Fidus document mark (inline formatting or annotation). */
+export interface FidusMark {
+    type: string;
+    attrs?: NodeAttrs;
+}
+/** A node in the Fidus document tree. */
+export interface FidusNode {
+    type: string;
+    attrs?: NodeAttrs;
+    content?: FidusNode[];
+    marks?: FidusMark[];
+    text?: string;
+}
+/** Top-level document settings stored on the `doc` node. */
+export interface DocSettings {
+    documentstyle?: string;
+    tracked?: boolean;
+    citationstyle?: string;
+    citationstyles?: string[];
+    language?: string;
+    languages?: string[];
+    papersize?: string;
+    papersizes?: string[];
+    footnote_marks?: string[];
+    footnote_elements?: string[];
+    bibliography_header?: FidusNode;
+    metadata?: Record<string, JSONValue>;
+    [key: string]: unknown;
+}
+/** The root Fidus document node. */
+export interface FidusDoc {
+    type: "doc";
+    attrs?: DocSettings;
+    content: FidusNode[];
+}
+/** A fully populated document object passed to exporters. */
+export interface ExportDoc {
+    title: string;
+    path?: string;
+    content: FidusNode[];
+    settings: DocSettings;
+    comments?: Record<string, CommentData>;
+    version?: string;
+}
+/** A single comment thread. */
+export interface CommentData {
+    id: number;
+    user: number;
+    username: string;
+    date: number;
+    resolved?: boolean;
+    comments: Array<{
+        user: number;
+        username: string;
+        date: number;
+        comment: string;
+    }>;
+}
+/** A bibliographic database entry (format depends on the CSL engine). */
+export interface BibDBEntry {
+    [key: string]: JSONValue | undefined;
+}
+export type BibDB = Record<string, BibDBEntry>;
+/** An entry in the image database. */
+export interface ImageDBEntry {
+    id: number;
+    title?: string;
+    file_type?: string;
+    image?: string | ArrayBuffer | Blob;
+    copyright?: Record<string, JSONValue>;
+    [key: string]: unknown;
+}
+export type ImageDB = Record<string, ImageDBEntry>;
+/** A CSL/CSL-M stylesheet reference. */
+export interface CSL {
+    citationType?: string;
+    [key: string]: JSONValue | undefined;
+}
+/** Common constructor options for exporters. */
+export interface ExporterOptions {
+    doc: ExportDoc;
+    templateUrl?: string;
+    bibDB?: BibDB;
+    imageDB?: ImageDB;
+    csl?: CSL;
+}
+/** JSON representation of a DOM node used by the native exporter. */
+export interface NativeDomNode {
+    t?: string;
+    co?: string;
+    nn?: string;
+    a?: Array<[string, string]>;
+    c?: NativeDomNode[];
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,4BAA4B;AAC5B,MAAM,MAAM,SAAS,GACf,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,EAAE,GACX;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAC,CAAA;AAEhC,kDAAkD;AAClD,MAAM,WAAW,SAAS;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;IACtB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,KAAK,CAAC,EAAE,KAAK,EAAE,CAAA;IACf,MAAM,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,yDAAyD;AACzD,MAAM,WAAW,KAAK;IAClB,IAAI,EAAE,WAAW,GAAG,UAAU,GAAG,cAAc,CAAA;IAC/C,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,SAAS,CAAA;CACrB;AAED,+DAA+D;AAC/D,MAAM,WAAW,SAAS;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,SAAS,CAAA;CACpB;AAED,yCAAyC;AACzC,MAAM,WAAW,SAAS;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,OAAO,CAAC,EAAE,SAAS,EAAE,CAAA;IACrB,KAAK,CAAC,EAAE,SAAS,EAAE,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,4DAA4D;AAC5D,MAAM,WAAW,WAAW;IACxB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IACrB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAA;IACzB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC5B,mBAAmB,CAAC,EAAE,SAAS,CAAA;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACpC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACzB;AAED,oCAAoC;AACpC,MAAM,WAAW,QAAQ;IACrB,IAAI,EAAE,KAAK,CAAA;IACX,KAAK,CAAC,EAAE,WAAW,CAAA;IACnB,OAAO,EAAE,SAAS,EAAE,CAAA;CACvB;AAED,6DAA6D;AAC7D,MAAM,WAAW,SAAS;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,SAAS,EAAE,CAAA;IACpB,QAAQ,EAAE,WAAW,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IACtC,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,+BAA+B;AAC/B,MAAM,WAAW,WAAW;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,EAAE,KAAK,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAC,CAAC,CAAA;CACnF;AAED,yEAAyE;AACzE,MAAM,WAAW,UAAU;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAA;CACvC;AAED,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;AAE9C,sCAAsC;AACtC,MAAM,WAAW,YAAY;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,CAAA;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACrC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACzB;AAED,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;AAElD,wCAAwC;AACxC,MAAM,WAAW,GAAG;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAA;CACvC;AAED,gDAAgD;AAChD,MAAM,WAAW,eAAe;IAC5B,GAAG,EAAE,SAAS,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,GAAG,CAAC,EAAE,GAAG,CAAA;CACZ;AAED,qEAAqE;AACrE,MAAM,WAAW,aAAa;IAC1B,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;IAC3B,CAAC,CAAC,EAAE,aAAa,EAAE,CAAA;CACtB"}

package/dist/types.js

@@ -0,0 +1,9 @@
+/**
+ * Core types shared across the @fiduswriter/document package.
+ *
+ * These types describe the JSON-shaped document tree that Fidus Writer stores
+ * and exchanges with its importers/exporters. They intentionally mirror the
+ * ProseMirror schema while staying serialisable.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fiduswriter/document",
-  "version": "0.1.0-alpha.3",
+  "version": "0.1.0-alpha.4",
   "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,16 @@
     "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",
+    "@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/exporter/tools/{file.js → file.ts}

@@ -1,4 +1,4 @@
-export const createSlug = str => {
+export const createSlug = (str: string): string => {
     if (str === "") {
         str = gettext("Untitled")
     }

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

@@ -1,6 +1,13 @@
-/** Same functionality as objToNode/nodeToObj in diffDOM.js, but also offers output in XHTML format (obj2Node) and without form support. */
-export const obj2Node = (obj, docType) => {
-    let parser
+import type {NativeDomNode} from "../../types.js"
+
+/** Same functionality as objToNode/nodeToObj in diffDOM.js, but also offers
+ *  output in XHTML format (obj2Node) and without form support.
+ */
+export const obj2Node = (
+    obj: NativeDomNode | undefined,
+    docType?: "xhtml"
+): Node | false => {
+    let parser: Document
     if (obj === undefined) {
         return false
     }
@@ -10,28 +17,28 @@ export const obj2Node = (obj, docType) => {
         parser = document
     }
 
-    function inner(obj, insideSvg) {
-        let node
-        if (obj.hasOwnProperty("t")) {
-            node = parser.createTextNode(obj.t)
-        } else if (obj.hasOwnProperty("co")) {
-            node = parser.createComment(obj.co)
+    function inner(obj: NativeDomNode, insideSvg = false): Node {
+        let node: Node
+        if (Object.prototype.hasOwnProperty.call(obj, "t")) {
+            node = parser.createTextNode(obj.t as string)
+        } else if (Object.prototype.hasOwnProperty.call(obj, "co")) {
+            node = parser.createComment(obj.co as string)
         } else {
             if (obj.nn === "svg" || insideSvg) {
                 node = parser.createElementNS(
                     "http://www.w3.org/2000/svg",
-                    obj.nn
+                    obj.nn as string
                 )
                 insideSvg = true
             } else if (obj.nn === "script") {
                 // Do not allow scripts
                 return parser.createTextNode("")
             } else {
-                node = parser.createElement(obj.nn.toLowerCase())
+                node = parser.createElement((obj.nn as string).toLowerCase())
             }
             if (obj.a) {
                 for (let i = 0; i < obj.a.length; i++) {
-                    node.setAttribute(obj.a[i][0], obj.a[i][1])
+                    ;(node as Element).setAttribute(obj.a[i][0], obj.a[i][1])
                 }
             }
             if (obj.c) {
@@ -45,19 +52,23 @@ export const obj2Node = (obj, docType) => {
     return inner(obj)
 }
 
-export const node2Obj = node => {
-    const obj = {}
+export const node2Obj = (node: Node): NativeDomNode => {
+    const obj: NativeDomNode = {}
 
     if (node.nodeType === 3) {
-        obj.t = node.data
+        obj.t = (node as Text).data
     } else if (node.nodeType === 8) {
-        obj.co = node.data
+        obj.co = (node as Comment).data
     } else {
         obj.nn = node.nodeName
-        if (node.attributes?.length > 0) {
+        const element = node as Element
+        if (element.attributes?.length > 0) {
             obj.a = []
-            for (let i = 0; i < node.attributes.length; i++) {
-                obj.a.push([node.attributes[i].name, node.attributes[i].value])
+            for (let i = 0; i < element.attributes.length; i++) {
+                obj.a.push([
+                    element.attributes[i].name,
+                    element.attributes[i].value
+                ])
             }
         }
         if (node.childNodes?.length > 0) {

package/src/global.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Global functions provided by Fidus Writer's runtime environment.
+ * These are injected by the Django JavaScript catalog and other runtime scripts.
+ */
+declare function gettext(msgid: string): string
+
+declare function interpolate(
+    fmt: string,
+    args: Array<string | number>,
+    named?: boolean
+): string

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/types.ts

@@ -0,0 +1,136 @@
+/**
+ * Core types shared across the @fiduswriter/document package.
+ *
+ * These types describe the JSON-shaped document tree that Fidus Writer stores
+ * and exchanges with its importers/exporters. They intentionally mirror the
+ * ProseMirror schema while staying serialisable.
+ */
+
+/** A generic JSON value. */
+export type JSONValue =
+    | string
+    | number
+    | boolean
+    | null
+    | JSONValue[]
+    | {[key: string]: JSONValue}
+
+/** Attributes that every Fidus node may carry. */
+export interface NodeAttrs {
+    [key: string]: unknown
+    id?: string
+    track?: Track[]
+    hidden?: boolean
+}
+
+/** A tracked change entry attached to a node or mark. */
+export interface Track {
+    type: "insertion" | "deletion" | "block_change"
+    user: number
+    username: string
+    date: number
+    approved?: boolean
+    before?: FidusNode
+}
+
+/** A Fidus document mark (inline formatting or annotation). */
+export interface FidusMark {
+    type: string
+    attrs?: NodeAttrs
+}
+
+/** A node in the Fidus document tree. */
+export interface FidusNode {
+    type: string
+    attrs?: NodeAttrs
+    content?: FidusNode[]
+    marks?: FidusMark[]
+    text?: string
+}
+
+/** Top-level document settings stored on the `doc` node. */
+export interface DocSettings {
+    documentstyle?: string
+    tracked?: boolean
+    citationstyle?: string
+    citationstyles?: string[]
+    language?: string
+    languages?: string[]
+    papersize?: string
+    papersizes?: string[]
+    footnote_marks?: string[]
+    footnote_elements?: string[]
+    bibliography_header?: FidusNode
+    metadata?: Record<string, JSONValue>
+    [key: string]: unknown
+}
+
+/** The root Fidus document node. */
+export interface FidusDoc {
+    type: "doc"
+    attrs?: DocSettings
+    content: FidusNode[]
+}
+
+/** A fully populated document object passed to exporters. */
+export interface ExportDoc {
+    title: string
+    path?: string
+    content: FidusNode[]
+    settings: DocSettings
+    comments?: Record<string, CommentData>
+    version?: string
+}
+
+/** A single comment thread. */
+export interface CommentData {
+    id: number
+    user: number
+    username: string
+    date: number
+    resolved?: boolean
+    comments: Array<{user: number; username: string; date: number; comment: string}>
+}
+
+/** A bibliographic database entry (format depends on the CSL engine). */
+export interface BibDBEntry {
+    [key: string]: JSONValue | undefined
+}
+
+export type BibDB = Record<string, BibDBEntry>
+
+/** An entry in the image database. */
+export interface ImageDBEntry {
+    id: number
+    title?: string
+    file_type?: string
+    image?: string | ArrayBuffer | Blob
+    copyright?: Record<string, JSONValue>
+    [key: string]: unknown
+}
+
+export type ImageDB = Record<string, ImageDBEntry>
+
+/** A CSL/CSL-M stylesheet reference. */
+export interface CSL {
+    citationType?: string
+    [key: string]: JSONValue | undefined
+}
+
+/** Common constructor options for exporters. */
+export interface ExporterOptions {
+    doc: ExportDoc
+    templateUrl?: string
+    bibDB?: BibDB
+    imageDB?: ImageDB
+    csl?: CSL
+}
+
+/** JSON representation of a DOM node used by the native exporter. */
+export interface NativeDomNode {
+    t?: string
+    co?: string
+    nn?: string
+    a?: Array<[string, string]>
+    c?: NativeDomNode[]
+}

package/jest.config.js

@@ -1,24 +0,0 @@
-export default {
-    rootDir: ".",
-    testEnvironment: "node",
-    transform: {},
-    moduleDirectories: ["node_modules"],
-    moduleNameMapper: {
-        "^downloadjs$": "<rootDir>/test/exporter/mocks/downloadjs.js",
-        "^mathlive$": "<rootDir>/test/exporter/mocks/mathlive.js",
-        "^mathml2omml$": "<rootDir>/test/exporter/mocks/mathml2omml.js",
-        "^@vivliostyle/print$": "<rootDir>/test/exporter/mocks/vivliostyle.js",
-        "^pretty$": "<rootDir>/test/exporter/mocks/pretty.js",
-        "^biblatex-csl-converter$": "<rootDir>/test/exporter/mocks/biblatex-csl-converter.js",
-        "^jszip$": "<rootDir>/test/importer/mocks/jszip.js",
-        "^mathml-to-latex$": "<rootDir>/test/importer/mocks/mathml-to-latex.js",
-        "^fwtoolkit$": "<rootDir>/test/exporter/mocks/common.js",
-        "^fwtoolkit/.*": "<rootDir>/test/exporter/mocks/common.js",
-        "^@fiduswriter/document/citations/format$": "<rootDir>/test/exporter/mocks/citations-format.js",
-        "^@fiduswriter/document/bibliography/csl_bib$": "<rootDir>/test/exporter/mocks/csl-bib-schema.js",
-        "^@fiduswriter/document/mathlive/opf_includes$": "<rootDir>/test/exporter/mocks/empty-module.js"
-    },
-    testMatch: ["<rootDir>/test/**/*.test.js"],
-    setupFiles: ["<rootDir>/test/setup.js"],
-    moduleFileExtensions: ["js", "mjs", "json"]
-}