@retorquere/bibtex-parser 6.4.3 → 6.4.5

package/index.d.ts

@@ -63,6 +63,13 @@ export interface Entry {
      * will be set to `true` if sentence casing was applied to the entry
      */
     sentenceCased?: boolean;
+    /**
+     * list of fields that have been inherited/donated using crossref/xdata
+     */
+    crossref: {
+        donated: string[];
+        inherited: string[];
+    };
 }
 /**
  * Markup mapping. As the bibtex file is parsed, markup will be transformed according to this table

package/index.js

@@ -11,6 +11,7 @@ exports.jabref = jabref;
 const jabref_1 = require("./jabref");
 const unicode2latex_1 = require("unicode2latex");
 const crossref_json_1 = tslib_1.__importDefault(require("./crossref.json"));
+const fields_json_1 = tslib_1.__importDefault(require("./fields.json"));
 const xregexp_1 = tslib_1.__importDefault(require("xregexp"));
 function restore(text, orig, preserve) {
     for (const { start, end } of preserve) {
@@ -386,6 +387,46 @@ class Parser {
         }
         return this.parsed();
     }
+    applyCrossrefField(parent, parentfield, child, childfield) {
+        let applied = false;
+        for (const field of ['fields', 'creators']) {
+            if (!child[field][childfield] && parent[field][parentfield]) {
+                child[field][childfield] = parent[field][parentfield];
+                applied = true;
+                if (!child.crossref.inherited.includes(childfield))
+                    child.crossref.inherited.push(childfield);
+                if (!parent.crossref.donated.includes(parentfield))
+                    parent.crossref.donated.push(parentfield);
+            }
+        }
+        return applied;
+    }
+    applyCrossref(entry, entries) {
+        for (const xref of ['crossref', 'xdata']) {
+            if (!entry.fields[xref])
+                continue;
+            for (const parents of entry.fields[xref]) {
+                let applied = false;
+                for (const parent of parents.split(/\s*,\s*/).map(key => entries[key]).filter(p => p)) {
+                    this.applyCrossref(parent, entries);
+                    for (const mappings of [crossref_json_1.default[entry.type], crossref_json_1.default['*']].filter(m => m)) {
+                        for (const mapping of [mappings[parent.type], mappings['*']].filter(m => m)) {
+                            for (const [target, source] of Object.entries(mapping)) {
+                                if (this.applyCrossrefField(parent, source, entry, target))
+                                    applied = true;
+                            }
+                            for (const field of (fields_json_1.default[entry.type] || [])) {
+                                if (this.applyCrossrefField(parent, field, entry, field))
+                                    applied = true;
+                            }
+                        }
+                    }
+                }
+                if (applied)
+                    delete entry.fields[xref];
+            }
+        }
+    }
     parsed() {
         this.field = null;
         const strings = {};
@@ -411,24 +452,7 @@ class Parser {
                 return acc;
             }, {});
             for (const entry of this.entries) {
-                if (entry.fields.crossref) {
-                    let applied;
-                    for (const parent_key of entry.fields.crossref) {
-                        const parent = entries[parent_key];
-                        if (!parent)
-                            continue;
-                        for (const mapping of crossref_json_1.default.filter(xref => xref.source.includes(parent.type) && xref.target.includes(entry.type))) {
-                            for (const { source, target } of mapping.fields) {
-                                if (parent.fields[source] && !entry.fields[target]) {
-                                    applied = true;
-                                    entry.fields[target] = JSON.parse(JSON.stringify(parent.fields[source]));
-                                }
-                            }
-                        }
-                    }
-                    if (applied)
-                        delete entry.fields.crossref;
-                }
+                this.applyCrossref(entry, entries);
             }
         }
         const { comments, jabref } = (0, jabref_1.parse)(this.comments); // eslint-disable-line @typescript-eslint/no-shadow
@@ -1277,6 +1301,10 @@ class Parser {
             type: node.type,
             fields: {},
             creators: {},
+            crossref: {
+                inherited: [],
+                donated: [],
+            },
         };
         this.entries.push(this.entry);
         // order these first for language-dependent sentence casing

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@retorquere/bibtex-parser",
-  "version": "6.4.3",
+  "version": "6.4.5",
   "description": "BibTeX parser",
   "main": "index.js",
   "typings": "./index.d.ts",
@@ -13,7 +13,7 @@
     "test": "tap test/tap --no-timeout --no-coverage",
     "snap": "npm test --snapshot",
     "snap:big": "npm test --snapshot --big",
-    "minitest": "peggy grammar.peggy && tsc -d && node i.js",
+    "minitest": "peggy grammar.peggy && ./build/crossref.py && tsc -d && node i.js",
     "list": "tar tvf $(npm pack)",
     "prepublishOnly": "npm start",
     "abbr": "./build/abbr.py",
@@ -22,7 +22,7 @@
     "update-cases": "curl -s https://raw.githubusercontent.com/retorquere/zotero-better-bibtex/master/test/loaded.json | jq -r '.[] | select(test(\"\\\\.bib((la)?tex)?$\"))' | rsync -av --delete -m --files-from=- ../better-bibtex/test/fixtures/ test/better-bibtex/",
     "x-docs": "rm -rf docs temp && typedoc --name 'BibTeX parser' index.ts && touch docs/.nojekyll",
     "docs": "mkdir -p etc temp && npm run api-extractor && npm run api-documenter",
-    "ncu": "./build/submodules.py && ncu -u && npm i && git add package.json package-lock.json && npm audit fix && git commit -m ncu",
+    "ncu": "./build/submodules.py && ./build/crossref.py && ncu -u && npm i && git add package.json package-lock.json && npm audit fix && git commit -m ncu",
     "api-documenter": "api-documenter markdown --input temp --output docs",
     "api-extractor": "api-extractor run --local --verbose"
   },
@@ -39,14 +39,14 @@
     "@microsoft/api-documenter": "^7.19.27",
     "@microsoft/api-extractor": "^7.33.7",
     "@types/node": "^18.11.18",
-    "@typescript-eslint/eslint-plugin": "^5.48.0",
-    "@typescript-eslint/parser": "^5.48.0",
+    "@typescript-eslint/eslint-plugin": "^5.48.1",
+    "@typescript-eslint/parser": "^5.48.1",
     "command-line-args": "^5.2.1",
     "csv": "^6.2.5",
     "digital-tree": "^2.0.4",
     "ejs": "^3.1.8",
     "eslint": "^8.31.0",
-    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-import": "^2.27.4",
     "eslint-plugin-prefer-arrow": "^1.2.3",
     "glob": "^8.0.3",
     "mkdirp": "^1.0.4",
@@ -54,7 +54,7 @@
     "peggy": "^2.0.1",
     "piscina": "^3.2.0",
     "slug": "^8.2.2",
-    "tap": "^16.3.2",
+    "tap": "^16.3.3",
     "ts-node": "^10.9.1",
     "tslib": "^2.4.1",
     "typescript": "^4.9.4"
@@ -75,6 +75,7 @@
     "jabref.js",
     "README.md",
     "crossref.json",
+    "fields.json",
     "strings.bib",
     "unabbrev.json"
   ],