@retorquere/bibtex-parser 6.4.2 → 6.4.4

package/index.d.ts

@@ -1,4 +1,6 @@
 import * as bibtex from './grammar';
+import * as chunker from './chunker';
+import * as jabref from './jabref';
 import { JabRefMetadata } from './jabref';
 export declare function toSentenceCase(text: string, ignoreHTML?: boolean): string;
 type Node = bibtex.Bibliography | bibtex.Math | bibtex.Environment | bibtex.Block | bibtex.RegularCommand | bibtex.DiacriticCommand | bibtex.Entry | bibtex.Field | bibtex.NumberValue | bibtex.StringDeclaration | bibtex.StringReference | bibtex.SubscriptCommand | bibtex.SuperscriptCommand | bibtex.SymbolCommand | bibtex.TextValue | bibtex.PreambleExpression | bibtex.BracedComment | bibtex.LineComment | bibtex.Markup | bibtex.NonEntryText;
@@ -208,7 +210,7 @@ export interface ParserOptions {
      */
     caseProtection?: 'as-needed' | 'strict' | boolean;
     /**
-     * The parser can change TeX markup (\textsc, \emph, etc) to a text equivalent. The defaults are HTML-oriented, but you can pass in your own configuration here
+     * The parser can change TeX markup (\\textsc, \\emph, etc) to a text equivalent. The defaults are HTML-oriented, but you can pass in your own configuration here
      */
     markup?: MarkupMapping;
     /**
@@ -264,5 +266,6 @@ export declare function ast(input: string, options?: ParserOptions, clean?: bool
 export declare const promises: {
     parse(input: string, options?: ParserOptions): Promise<Bibliography>;
 };
-export * as chunker from './chunker';
-export * as jabref from './jabref';
+export { chunker };
+export { jabref };
+//# sourceMappingURL=index.d.ts.map

package/index.js

@@ -5,9 +5,13 @@ const tslib_1 = require("tslib");
 /* eslint-disable @typescript-eslint/no-unsafe-argument */
 const bibtex = tslib_1.__importStar(require("./grammar"));
 const chunker = tslib_1.__importStar(require("./chunker"));
+exports.chunker = chunker;
+const jabref = tslib_1.__importStar(require("./jabref"));
+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) {
@@ -383,6 +387,42 @@ class Parser {
         }
         return this.parsed();
     }
+    applyField(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;
+            }
+        }
+        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.applyField(parent, source, entry, target))
+                                    applied = true;
+                            }
+                            for (const field of (fields_json_1.default[entry.type] || [])) {
+                                if (this.applyField(parent, field, entry, field))
+                                    applied = true;
+                            }
+                        }
+                    }
+                }
+                if (applied)
+                    delete entry.fields[xref];
+            }
+        }
+    }
     parsed() {
         this.field = null;
         const strings = {};
@@ -408,22 +448,10 @@ class Parser {
                 return acc;
             }, {});
             for (const entry of this.entries) {
-                if (entry.fields.crossref) {
-                    for (const parent_key of entry.fields.crossref) {
-                        const parent = entries[parent_key];
-                        const mapping = parent && crossref_json_1.default.find(xref => xref.source.includes(parent.type) && xref.target.includes(entry.type));
-                        if (parent && mapping) {
-                            for (const { source, target } of mapping.fields) {
-                                if (parent.fields[source] && !entry.fields[target]) {
-                                    entry.fields[target] = JSON.parse(JSON.stringify(parent.fields[source]));
-                                }
-                            }
-                        }
-                    }
-                }
+                this.applyCrossref(entry, entries);
             }
         }
-        const { comments, jabref } = (0, jabref_1.parse)(this.comments);
+        const { comments, jabref } = (0, jabref_1.parse)(this.comments); // eslint-disable-line @typescript-eslint/no-shadow
         return {
             errors: this.errors,
             entries: this.entries,
@@ -1538,6 +1566,4 @@ exports.promises = {
         return await parser.parseAsync(input);
     },
 };
-exports.chunker = tslib_1.__importStar(require("./chunker"));
-exports.jabref = tslib_1.__importStar(require("./jabref"));
 //# sourceMappingURL=index.js.map

package/jabref.d.ts

@@ -55,3 +55,4 @@ export declare function parse(comments: string[]): {
     comments: string[];
     jabref: JabRefMetadata;
 };
+//# sourceMappingURL=jabref.d.ts.map

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@retorquere/bibtex-parser",
-  "version": "6.4.2",
+  "version": "6.4.4",
   "description": "BibTeX parser",
   "main": "index.js",
+  "typings": "./index.d.ts",
   "scripts": {
     "lint": "eslint . --ext .ts --cache --cache-location .eslintcache/",
     "prestart": "npm run lint && peggy grammar.peggy",
@@ -12,15 +13,18 @@
     "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",
     "preversion": "npm test && npm run abbr",
     "postversion": "git push --follow-tags",
     "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/",
-    "docs": "rm -rf docs && typedoc --name 'BibTeX parser' index.ts && touch docs/.nojekyll",
-    "ncu": "./build/submodules.py && ncu -u && npm i && git add package.json package-lock.json && npm audit fix && git commit -m ncu"
+    "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 && ./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"
   },
   "repository": {
     "type": "git",
@@ -32,15 +36,17 @@
   "author": "Emiliano Heyns",
   "license": "ISC",
   "devDependencies": {
+    "@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",
@@ -48,10 +54,9 @@
     "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",
-    "typedoc": "^0.23.23",
     "typescript": "^4.9.4"
   },
   "dependencies": {
@@ -70,6 +75,7 @@
     "jabref.js",
     "README.md",
     "crossref.json",
+    "fields.json",
     "strings.bib",
     "unabbrev.json"
   ],