@retorquere/bibtex-parser 13.0.3 → 13.0.5

package/dist/wasm/index.d.ts

@@ -1,8 +1,5 @@
 /** @module @retorquere/bibtex-parser */
 import init, { initSync } from './bibtex_parser.js';
-import { JabRefMetadata } from './jabref.js';
-export { JabRefMetadata };
-export type { Group as JabRefGroup } from './jabref.js';
 /** Inputs for asynchronous WASM initialization: a URL-like resource to fetch, bytes, or a compiled module. */
 export type { InitInput } from './bibtex_parser.js';
 /** Inputs for synchronous WASM initialization: bytes or a compiled module; synchronous initialization cannot fetch a URL. */
@@ -115,6 +112,19 @@ export interface ParseError {
     /** Source fragment associated with the diagnostic, when available. */
     input?: string;
 }
+/** A JabRef group serialized by the Rust parser. */
+export interface JabRefGroup {
+    name: string;
+    entries: string[];
+    groups: JabRefGroup[];
+}
+/** JabRef metadata serialized by the Rust parser. */
+export interface JabRefMetadata {
+    root: JabRefGroup[];
+    fileDirectory?: string;
+    groupsversion?: number;
+    databaseType?: string;
+}
 /** The parsed contents of a BibTeX library. */
 export interface Library {
     /** Diagnostics collected while parsing; recoverable errors do not necessarily prevent entries from being returned. */

package/dist/wasm/index.js

@@ -1,8 +1,6 @@
 /** @module @retorquere/bibtex-parser */
 import init, { initSync, parse as parseWasm, parseAsync as parseAsyncWasm, parseVerbatim as parseVerbatimWasm, parseVerbatimAsync as parseVerbatimAsyncWasm, toSentenceCase as toSentenceCaseWasm } from './bibtex_parser.js';
-import { JabRefMetadata } from './jabref.js';
 import englishDefaults from './english.json' with { type: 'json' };
-export { JabRefMetadata };
 /**
  * Loads and initializes the WebAssembly parser asynchronously.
  *
@@ -51,10 +49,6 @@ function throwOnUnsupported(result) {
         throw new Error(unsupported.error);
     return result;
 }
-function withJabRef(result) {
-    result.jabref = new JabRefMetadata(result.jabref);
-    return result;
-}
 /**
  * Parses BibTeX without converting LaTeX field contents to Unicode or structured creator values.
  * `@string` references are resolved, while each entry's fields remain strings for later processing.
@@ -86,7 +80,7 @@ export async function parseVerbatimAsync(input, options = {}) {
  */
 export function parse(input, options = {}) {
     const prepared = prepare(input, options);
-    const result = withJabRef(parseWasm(prepared.input, prepared.options));
+    const result = parseWasm(prepared.input, prepared.options);
     if (options.unsupported === 'throw')
         return throwOnUnsupported(result);
     return result;
@@ -94,7 +88,7 @@ export function parse(input, options = {}) {
 /** Asynchronous variant of {@link parse}; returns the same result shape and yields between batches for large inputs. */
 export async function parseAsync(input, options = {}) {
     const prepared = prepare(input, options);
-    const result = withJabRef(await parseAsyncWasm(prepared.input, prepared.options));
+    const result = await parseAsyncWasm(prepared.input, prepared.options);
     if (options.unsupported === 'throw')
         return throwOnUnsupported(result);
     return result;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@retorquere/bibtex-parser",
-  "version": "13.0.3",
+  "version": "13.0.5",
   "description": "BibTeX parser",
   "type": "module",
   "module": "./dist/wasm/index.js",
@@ -38,8 +38,8 @@
     "pretest:js": "npm run build:ts",
     "test:js": "node test/js.js",
     "pretest:all": "npm run build:all",
-    "test:all": "npm run test:wasm && npm run test:js && node --test test/package.test.js",
-    "test:release": "npm run test:wasm && node --test test/package.test.js",
+    "test:all": "npm run test:wasm && npm run test:js",
+    "test:release": "npm run test:wasm",
     "test:rust": "cargo test --manifest-path rust/Cargo.toml",
     "minitest": "./build/crossref.py && npm run build && node i.js",
     "list": "tar tvf $(npm pack)",
@@ -63,16 +63,16 @@
   "author": "Emiliano Heyns",
   "license": "ISC",
   "devDependencies": {
-    "@types/node": "^26.6.5",
+    "@types/node": "^26.6.6",
     "@unified-latex/unified-latex-types": "^1.8.4",
     "command-line-args": "^6.0.2",
     "csv": "^6.6.4",
     "digital-tree": "^2.0.4",
-    "dprint": "^0.63.0",
-    "ejs": "^7.0.1",
+    "dprint": "^0.64.3",
+    "ejs": "^7.0.2",
     "esbuild": "^0.28.2",
-    "glob": "^13.0.6",
-    "js-yaml": "^5.4.3",
+    "glob": "^14.0.3",
+    "js-yaml": "^5.5.0",
     "minimist": "^1.2.8",
     "mkdirp": "^3.0.1",
     "node-fetch": "^3.3.2",
@@ -80,7 +80,7 @@
     "slug": "^12.0.1",
     "tap": "^21.8.0",
     "ts-node": "^10.9.2",
-    "tslib": "^2.8.1",
+    "tslib": "^2.9.1",
     "typedoc": "^0.28.20",
     "typescript": "npm:@typescript/typescript6@^6.0.2"
   },
@@ -93,7 +93,7 @@
     "lodash.merge": "^4.6.2",
     "moo": "^0.5.3",
     "nearley": "^2.20.1",
-    "unicode2latex": "^7.0.37",
+    "unicode2latex": "^7.0.38",
     "wink-eng-lite-web-model": "^1.8.1",
     "wink-nlp": "^2.4.0"
   },
@@ -107,6 +107,6 @@
   },
   "allowScripts": {
     "esbuild@0.28.2": true,
-    "dprint@0.63.0": true
+    "dprint@0.64.3": true
   }
 }

package/dist/wasm/jabref.d.ts

@@ -1,41 +0,0 @@
-/**
- * A JabRef group.
- */
-export interface Group {
-    /** Name displayed for this group in JabRef. */
-    name: string;
-    /** Citation keys belonging to this group after supported group rules are applied. */
-    entries: string[];
-    /** Direct child groups. */
-    groups: Group[];
-}
-/** JabRef metadata parsed from a BibTeX library, including its group tree and file settings. */
-export declare class JabRefMetadata {
-    #private;
-    /** Top-level groups; nested groups are available through each group's `groups` property. */
-    root: Group[];
-    /** Base directory used to resolve relative attachment paths. */
-    fileDirectory?: string;
-    /** JabRef group metadata format version. */
-    groupsversion?: number;
-    /** Database type recorded in the JabRef metadata. */
-    databaseType?: string;
-    /** Creates metadata from parsed JabRef properties and indexes groups for membership updates. */
-    constructor(data?: Partial<Pick<JabRefMetadata, 'root' | 'fileDirectory' | 'groupsversion' | 'databaseType'>>);
-    /** Populates JabRef 3.8+ memberships in `root` by group name; duplicate names select the first node. */
-    addEntry(name: string, key: string): boolean;
-}
-/**
- * Import the JabRef groups from the `@string` comments in which they were stored. You would typically pass the comments parsed by [[bibtex.parse]] in here.
- *
- * JabRef knows several group types, and this parser parses most, but not all of them:
- *
- * * independent group: the keys listed in the group are the entries that are considered to belong to it
- * * intersection: the keys listed in the group are considered to belong to the group if they're also in the parent group
- * * union: the keys listed in the group are considered to belong to the group, and also the keys that are in the parent group
- * * query: not supported by this parser
- */
-export declare function parse(comments: string[]): {
-    comments: string[];
-    jabref: JabRefMetadata;
-};

package/dist/wasm/jabref.js

@@ -1,133 +0,0 @@
-function decode(s = '', sep = ';') {
-    s = s.replace(/\r?\n/g, '');
-    let pos = 0;
-    const records = [''];
-    while (pos < s.length) {
-        switch (s[pos]) {
-            case '\\':
-                pos++;
-                records[0] += s[pos];
-                break;
-            case sep:
-                records.unshift('');
-                break;
-            default:
-                records[0] += s[pos];
-        }
-        pos++;
-    }
-    return records.reverse().filter(record => record);
-}
-/** JabRef metadata parsed from a BibTeX library, including its group tree and file settings. */
-export class JabRefMetadata {
-    #groups = new Map();
-    /** Top-level groups; nested groups are available through each group's `groups` property. */
-    root = [];
-    /** Creates metadata from parsed JabRef properties and indexes groups for membership updates. */
-    constructor(data = {}) {
-        this.root = data.root ?? [];
-        for (const field of ['fileDirectory', 'groupsversion', 'databaseType']) {
-            if (data[field] !== undefined)
-                Object.assign(this, { [field]: data[field] });
-        }
-        const index = (groups) => {
-            for (const group of groups) {
-                if (!this.#groups.has(group.name))
-                    this.#groups.set(group.name, group);
-                index(group.groups);
-            }
-        };
-        index(this.root);
-    }
-    /** Populates JabRef 3.8+ memberships in `root` by group name; duplicate names select the first node. */
-    addEntry(name, key) {
-        const group = this.#groups.get(name);
-        if (!group)
-            return false;
-        if (!group.entries.includes(key))
-            group.entries.push(key);
-        return true;
-    }
-}
-/**
- * Import the JabRef groups from the `@string` comments in which they were stored. You would typically pass the comments parsed by [[bibtex.parse]] in here.
- *
- * JabRef knows several group types, and this parser parses most, but not all of them:
- *
- * * independent group: the keys listed in the group are the entries that are considered to belong to it
- * * intersection: the keys listed in the group are considered to belong to the group if they're also in the parent group
- * * union: the keys listed in the group are considered to belong to the group, and also the keys that are in the parent group
- * * query: not supported by this parser
- */
-export function parse(comments) {
-    const result = new JabRefMetadata();
-    const levels = [];
-    const decoded = {
-        fileDirectory: null,
-        groupsversion: null,
-        groupstree: null,
-        grouping: null,
-        databaseType: null,
-    };
-    comments = comments.filter(comment => {
-        const m = comment.match(/^jabref-meta:\s*([^:]+):([\s\S]*)/); // use \s\S because mozilla doesn't understand /s
-        if (m) {
-            decoded[m[1]] = decode(m[2]);
-            return false;
-        }
-        return true;
-    });
-    if (decoded.groupsversion)
-        result.groupsversion = parseInt(decoded.groupsversion[0].trim()); // eslint-disable-line @typescript-eslint/no-unsafe-argument
-    if (decoded.fileDirectory)
-        result.fileDirectory = decoded.fileDirectory[0];
-    if (decoded.databaseType)
-        result.databaseType = decoded.databaseType[0];
-    for (const tree of ['groupstree', 'grouping']) {
-        if (!decoded[tree])
-            continue;
-        for (const encoded of decoded[tree]) {
-            const fields = decode(encoded);
-            const level_type_name = decode(fields.shift(), ':');
-            const m = /^([0-9]+) (.+)/.exec(level_type_name[0]);
-            if (!m)
-                break;
-            const level = parseInt(m[1]);
-            const type = m[2]; // test for StaticGroup?
-            if (type === 'AllEntriesGroup')
-                continue; // root
-            const name = level_type_name[1];
-            const intersection = decode(fields.shift())[0];
-            const keys = tree === 'grouping' ? [] : fields.map(field => decode(field)[0]);
-            const group = {
-                name,
-                entries: keys,
-                groups: [],
-            };
-            if (levels.length < level) {
-                levels.push(group);
-            }
-            else {
-                levels[level - 1] = group;
-            }
-            if (level === 1) {
-                result.root.push(group);
-            }
-            else {
-                const parent = levels[level - 2];
-                switch (intersection) {
-                    case '0': // independent
-                        break;
-                    case '1': // intersect
-                        group.entries = group.entries.filter(key => parent.entries.includes(key));
-                        break;
-                    case '2': // union
-                        group.entries = group.entries.concat(parent.entries.filter(key => !group.entries.includes(key)));
-                        break;
-                }
-                levels[level - 2].groups.push(group);
-            }
-        }
-    }
-    return { comments, jabref: new JabRefMetadata(result) };
-}