@retorquere/bibtex-parser 8.0.3 → 8.0.5

package/index.d.ts

@@ -124,7 +124,7 @@ export interface Options {
      */
     applyCrossRef?: boolean;
 }
-interface Creator {
+export interface Creator {
     name?: string;
     lastName?: string;
     firstName?: string;
@@ -134,7 +134,7 @@ interface Creator {
     useprefix?: boolean;
     juniorcomma?: boolean;
 }
-interface Entry {
+export interface Entry {
     type: string;
     key: string;
     fields: {

package/index.js

@@ -670,6 +670,8 @@ class BibTeXParser {
         return (node.content[0].type !== 'macro');
     }
     mode(field) {
+        if (this.options.verbatimFields && this.options.verbatimFields.find(name => typeof name === 'string' ? (name === field) : field.match(name)))
+            return 'verbatim';
         let mode = 'literal';
         for (const [selected, fields] of Object.entries(this.fieldMode)) {
             if (fields.find(match => typeof match === 'string' ? field === match : field.match(match)))
@@ -897,6 +899,8 @@ class BibTeXParser {
         this.options = Object.assign(Object.assign({ caseProtection: 'as-needed', unabbreviations: true, applyCrossRef: (_a = options.applyCrossRef) !== null && _a !== void 0 ? _a : true, fieldMode: {} }, options), { sentenceCase });
         if (this.options.caseProtection === true)
             this.options.caseProtection = 'as-needed';
+        if (this.options.verbatimFields)
+            this.options.verbatimFields = this.options.verbatimFields.map(f => typeof f === 'string' ? f.toLowerCase() : new RegExp(f.source, f.flags + (f.flags.includes('i') ? '' : 'i')));
         if (typeof this.options.sentenceCase.langids === 'boolean')
             this.options.sentenceCase.langids = this.options.sentenceCase.langids ? English : [];
         this.options.sentenceCase.langids = this.options.sentenceCase.langids.map(langid => langid.toLowerCase());
@@ -946,6 +950,8 @@ class BibTeXParser {
                     delete entry.fields[field];
                     continue;
                 }
+                if (this.options.raw)
+                    continue;
                 this.field(entry, field, value, sentenceCase);
                 if (field.match(/^keywords\[\d+\]$/)) {
                     keywords = [...keywords, entry.fields[field]];
@@ -1027,7 +1033,7 @@ class BibTeXParser {
     }
     parse(input, options = {}) {
         this.reset(options);
-        const base = bibtex.parse(input);
+        const base = bibtex.parse(input, { strings: options.strings });
         this.prep(base);
         for (const entry of base.entries) {
             this.reparse(entry);
@@ -1038,7 +1044,7 @@ class BibTeXParser {
     async parseAsync(input, options = {}) {
         var _a, e_1, _b, _c;
         this.reset(options);
-        const base = await bibtex.promises.parse(input);
+        const base = await bibtex.promises.parse(input, { strings: options.strings });
         this.prep(base);
         try {
             for (var _d = true, _e = __asyncValues(asyncGenerator(base.entries)), _f; _f = await _e.next(), _a = _f.done, !_a; _d = true) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@retorquere/bibtex-parser",
-  "version": "8.0.3",
+  "version": "8.0.5",
   "description": "BibTeX parser",
   "main": "index.js",
   "typings": "./index.d.ts",

package/verbatim.d.ts

@@ -7,16 +7,16 @@ export type Entry = {
 export interface ParseError {
     error: string;
     input: string;
-    location?: {
-        line: number;
-        column: number;
-    };
 }
 export interface ParserOptions {
     /**
      * stop parsing after `max_entries` entries have been found. Useful for quick detection if a text file is in fact a bibtex file
      */
     max_entries?: number;
+    /**
+      * preload these strings
+      */
+    strings?: string | Record<string, string>;
 }
 declare class Parser {
     parsing: string;
@@ -36,10 +36,6 @@ declare class Parser {
     private max_entries;
     private keywords;
     constructor(input: string, options?: ParserOptions);
-    location(pos: number): {
-        line: number;
-        column: number;
-    };
     parse(): void;
     parseAsync(): Promise<void>;
     private isWhitespace;

package/verbatim.js

@@ -86,23 +86,20 @@ class Parser {
         this.input = input;
         this.parsing = null;
         this.keywords = 0;
+        if (typeof options.strings === 'string') {
+            this.input = options.strings + '\n' + input; // eslint-disable-line prefer-template
+        }
+        else if (options.strings) {
+            for (const [k, v] of Object.entries(options.strings)) {
+                this.default_strings[k.toUpperCase()] = v;
+            }
+        }
         let pos = input.indexOf('\n');
         while (pos !== -1) {
             this.linebreaks.push(pos);
             pos = input.indexOf('\n', pos + 1);
         }
     }
-    location(pos) {
-        let line = 1;
-        let column = 1;
-        for (const linebreak of this.linebreaks) {
-            if (pos < linebreak)
-                break;
-            line++;
-            column = pos - linebreak;
-        }
-        return { line, column };
-    }
     parse() {
         this.bibtex();
         this.entries.reverse();
@@ -232,7 +229,6 @@ class Parser {
             if (typeof resolved === 'undefined') {
                 this.errors.push({
                     error: `Unresolved @string reference ${JSON.stringify(bare)}`,
-                    location: this.location(this.pos),
                     input: bare,
                 });
             }