@retorquere/bibtex-parser 12.1.11 → 13.0.1

package/dist/wasm/bibtex_parser.js

@@ -19,6 +19,7 @@ export function parse(input, options) {
 }
 
 /**
+ * Parse and render BibTeX cooperatively, yielding between directive and entry batches.
  * @param {string} input
  * @param {any | null} [options]
  * @returns {Promise<any>}
@@ -47,6 +48,7 @@ export function parseVerbatim(input, options) {
 }
 
 /**
+ * Parse raw BibTeX cooperatively, yielding between directive batches and returning a JS object.
  * @param {string} input
  * @param {any | null} [options]
  * @returns {Promise<any>}
@@ -58,12 +60,15 @@ export function parseVerbatimAsync(input, options) {
     return ret;
 }
 
+/**
+ * Install the browser-console panic hook once when the WASM module is initialized.
+ */
 export function start() {
     wasm.start();
 }
 
 /**
- * Apply sentence casing with the standalone TypeScript API's defaulted option object.
+ * Apply sentence casing using optional `guess`, `subSentenceCapitalization`, and `preserveQuoted` flags.
  * @param {string} input
  * @param {any | null} [options]
  * @returns {string}
@@ -88,21 +93,6 @@ export function toSentenceCase(input, options) {
         wasm.__wbindgen_free(deferred3_0, deferred3_1, 1);
     }
 }
-
-/**
- * Tokenize Unicode title text using the same token record shape as TypeScript.
- * @param {string} input
- * @returns {any}
- */
-export function tokenize(input) {
-    const ptr0 = passStringToWasm0(input, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-    const len0 = WASM_VECTOR_LEN;
-    const ret = wasm.tokenize(ptr0, len0);
-    if (ret[2]) {
-        throw takeFromExternrefTable0(ret[1]);
-    }
-    return takeFromExternrefTable0(ret[0]);
-}
 function __wbg_get_imports() {
     const import0 = {
         __proto__: null,
@@ -312,7 +302,7 @@ function __wbg_get_imports() {
                     const a = state0.a;
                     state0.a = 0;
                     try {
-                        return wasm_bindgen_27e16af4bbf8dd6f___convert__closures_____invoke___js_sys_8149d826ad841366___Function_fn_wasm_bindgen_27e16af4bbf8dd6f___JsValue_____wasm_bindgen_27e16af4bbf8dd6f___sys__Undefined___js_sys_8149d826ad841366___Function_fn_wasm_bindgen_27e16af4bbf8dd6f___JsValue_____wasm_bindgen_27e16af4bbf8dd6f___sys__Undefined_______true_(a, state0.b, arg0, arg1);
+                        return wasm_bindgen_7c27bb0bb2b93bf___convert__closures_____invoke___js_sys_4854f420e42f68ae___Function_fn_wasm_bindgen_7c27bb0bb2b93bf___JsValue_____wasm_bindgen_7c27bb0bb2b93bf___sys__Undefined___js_sys_4854f420e42f68ae___Function_fn_wasm_bindgen_7c27bb0bb2b93bf___JsValue_____wasm_bindgen_7c27bb0bb2b93bf___sys__Undefined_______true_(a, state0.b, arg0, arg1);
                     } finally {
                         state0.a = a;
                     }
@@ -391,8 +381,8 @@ function __wbg_get_imports() {
             return ret;
         },
         __wbindgen_generic_0000000000000001: function(arg0, arg1) {
-            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 85, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
-            const ret = makeMutClosure(arg0, arg1, wasm_bindgen_27e16af4bbf8dd6f___convert__closures_____invoke___wasm_bindgen_27e16af4bbf8dd6f___JsValue__core_37ee0ce0c4cd57d5___result__Result_____wasm_bindgen_27e16af4bbf8dd6f___JsError___true_);
+            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 87, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
+            const ret = makeMutClosure(arg0, arg1, wasm_bindgen_7c27bb0bb2b93bf___convert__closures_____invoke___wasm_bindgen_7c27bb0bb2b93bf___JsValue__core_37ee0ce0c4cd57d5___result__Result_____wasm_bindgen_7c27bb0bb2b93bf___JsError___true_);
             return ret;
         },
         __wbindgen_generic_0000000000000002: function(arg0) {
@@ -432,15 +422,15 @@ function __wbg_get_imports() {
     };
 }
 
-function wasm_bindgen_27e16af4bbf8dd6f___convert__closures_____invoke___wasm_bindgen_27e16af4bbf8dd6f___JsValue__core_37ee0ce0c4cd57d5___result__Result_____wasm_bindgen_27e16af4bbf8dd6f___JsError___true_(arg0, arg1, arg2) {
-    const ret = wasm.wasm_bindgen_27e16af4bbf8dd6f___convert__closures_____invoke___wasm_bindgen_27e16af4bbf8dd6f___JsValue__core_37ee0ce0c4cd57d5___result__Result_____wasm_bindgen_27e16af4bbf8dd6f___JsError___true_(arg0, arg1, arg2);
+function wasm_bindgen_7c27bb0bb2b93bf___convert__closures_____invoke___wasm_bindgen_7c27bb0bb2b93bf___JsValue__core_37ee0ce0c4cd57d5___result__Result_____wasm_bindgen_7c27bb0bb2b93bf___JsError___true_(arg0, arg1, arg2) {
+    const ret = wasm.wasm_bindgen_7c27bb0bb2b93bf___convert__closures_____invoke___wasm_bindgen_7c27bb0bb2b93bf___JsValue__core_37ee0ce0c4cd57d5___result__Result_____wasm_bindgen_7c27bb0bb2b93bf___JsError___true_(arg0, arg1, arg2);
     if (ret[1]) {
         throw takeFromExternrefTable0(ret[0]);
     }
 }
 
-function wasm_bindgen_27e16af4bbf8dd6f___convert__closures_____invoke___js_sys_8149d826ad841366___Function_fn_wasm_bindgen_27e16af4bbf8dd6f___JsValue_____wasm_bindgen_27e16af4bbf8dd6f___sys__Undefined___js_sys_8149d826ad841366___Function_fn_wasm_bindgen_27e16af4bbf8dd6f___JsValue_____wasm_bindgen_27e16af4bbf8dd6f___sys__Undefined_______true_(arg0, arg1, arg2, arg3) {
-    wasm.wasm_bindgen_27e16af4bbf8dd6f___convert__closures_____invoke___js_sys_8149d826ad841366___Function_fn_wasm_bindgen_27e16af4bbf8dd6f___JsValue_____wasm_bindgen_27e16af4bbf8dd6f___sys__Undefined___js_sys_8149d826ad841366___Function_fn_wasm_bindgen_27e16af4bbf8dd6f___JsValue_____wasm_bindgen_27e16af4bbf8dd6f___sys__Undefined_______true_(arg0, arg1, arg2, arg3);
+function wasm_bindgen_7c27bb0bb2b93bf___convert__closures_____invoke___js_sys_4854f420e42f68ae___Function_fn_wasm_bindgen_7c27bb0bb2b93bf___JsValue_____wasm_bindgen_7c27bb0bb2b93bf___sys__Undefined___js_sys_4854f420e42f68ae___Function_fn_wasm_bindgen_7c27bb0bb2b93bf___JsValue_____wasm_bindgen_7c27bb0bb2b93bf___sys__Undefined_______true_(arg0, arg1, arg2, arg3) {
+    wasm.wasm_bindgen_7c27bb0bb2b93bf___convert__closures_____invoke___js_sys_4854f420e42f68ae___Function_fn_wasm_bindgen_7c27bb0bb2b93bf___JsValue_____wasm_bindgen_7c27bb0bb2b93bf___sys__Undefined___js_sys_4854f420e42f68ae___Function_fn_wasm_bindgen_7c27bb0bb2b93bf___JsValue_____wasm_bindgen_7c27bb0bb2b93bf___sys__Undefined_______true_(arg0, arg1, arg2, arg3);
 }
 
 function addToExternrefTable0(obj) {

package/dist/wasm/bibtex_parser_bg.wasm.d.ts

@@ -7,9 +7,8 @@ export const parseVerbatim: (a: number, b: number, c: number) => [number, number
 export const parseVerbatimAsync: (a: number, b: number, c: number) => any;
 export const start: () => void;
 export const toSentenceCase: (a: number, b: number, c: number) => [number, number, number, number];
-export const tokenize: (a: number, b: number) => [number, number, number];
-export const wasm_bindgen_27e16af4bbf8dd6f___convert__closures_____invoke___js_sys_8149d826ad841366___Function_fn_wasm_bindgen_27e16af4bbf8dd6f___JsValue_____wasm_bindgen_27e16af4bbf8dd6f___sys__Undefined___js_sys_8149d826ad841366___Function_fn_wasm_bindgen_27e16af4bbf8dd6f___JsValue_____wasm_bindgen_27e16af4bbf8dd6f___sys__Undefined_______true_: (a: number, b: number, c: any, d: any) => void;
-export const wasm_bindgen_27e16af4bbf8dd6f___convert__closures_____invoke___wasm_bindgen_27e16af4bbf8dd6f___JsValue__core_37ee0ce0c4cd57d5___result__Result_____wasm_bindgen_27e16af4bbf8dd6f___JsError___true_: (a: number, b: number, c: any) => [number, number];
+export const wasm_bindgen_7c27bb0bb2b93bf___convert__closures_____invoke___js_sys_4854f420e42f68ae___Function_fn_wasm_bindgen_7c27bb0bb2b93bf___JsValue_____wasm_bindgen_7c27bb0bb2b93bf___sys__Undefined___js_sys_4854f420e42f68ae___Function_fn_wasm_bindgen_7c27bb0bb2b93bf___JsValue_____wasm_bindgen_7c27bb0bb2b93bf___sys__Undefined_______true_: (a: number, b: number, c: any, d: any) => void;
+export const wasm_bindgen_7c27bb0bb2b93bf___convert__closures_____invoke___wasm_bindgen_7c27bb0bb2b93bf___JsValue__core_37ee0ce0c4cd57d5___result__Result_____wasm_bindgen_7c27bb0bb2b93bf___JsError___true_: (a: number, b: number, c: any) => [number, number];
 export const __wbindgen_malloc: (a: number, b: number) => number;
 export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
 export const __wbindgen_exn_store: (a: number) => void;

package/dist/wasm/english.json

@@ -0,0 +1,27 @@
+[
+  "",
+  "american",
+  "british",
+  "canadian",
+  "english",
+  "australian",
+  "newzealand",
+  "usenglish",
+  "ukenglish",
+  "en",
+  "eng",
+  "en-au",
+  "en-bz",
+  "en-ca",
+  "en-cb",
+  "en-gb",
+  "en-ie",
+  "en-jm",
+  "en-nz",
+  "en-ph",
+  "en-tt",
+  "en-us",
+  "en-za",
+  "en-zw",
+  "anglais"
+]

package/dist/wasm/index.d.ts

@@ -1,26 +1,67 @@
-/** @module wasm */
+/** @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';
-export type { InitInput, InitOutput, SyncInitInput } from './bibtex_parser.js';
-/** Initializes the WebAssembly parser; await this before using its exports. */
-export { init, initSync };
+/** 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. */
+export type { SyncInitInput } from './bibtex_parser.js';
+/** @ignore */
+export type { InitOutput } from './bibtex_parser.js';
+/**
+ * Loads and initializes the WebAssembly parser asynchronously.
+ *
+ * With no argument, the browser build fetches the package's WASM file relative to this module. Pass a URL-like resource to choose another location, or pass bytes when the caller loads the binary itself. Initialize once before calling parser functions.
+ *
+ * @example
+ * ```ts
+ * import init, { parse } from '@retorquere/bibtex-parser'
+ *
+ * await init()
+ * const library = parse('@article{example, title={A title}}')
+ * ```
+ */
+export { init };
+/**
+ * Initializes the WebAssembly parser from bytes or a compiled module without fetching it.
+ * Call this before any parser function; prefer {@link init} when the binary should be loaded asynchronously.
+ *
+ * @example
+ * ```ts
+ * import { readFile } from 'node:fs/promises'
+ * import { initSync, parse } from '@retorquere/bibtex-parser'
+ *
+ * initSync({ module: await readFile('bibtex_parser_bg.wasm') })
+ * const library = parse('@article{example, title={A title}}')
+ * ```
+ */
+export { initSync };
 export default init;
 /** Describes how a BibTeX field is interpreted. */
 export type ParseMode = 'creatorlist' | 'title' | 'verbatim' | 'richtext' | 'literallist' | 'literal' | 'verbatimlist';
 /** A parsed personal or organizational name. */
 export interface Creator {
+    /** Complete name when the parser cannot safely separate the name into components. */
     name?: string;
+    /** Family name, including any parsed name prefix. */
     lastName?: string;
+    /** Given name. */
     firstName?: string;
+    /** Name particle, such as "von" or "de", when separated from the family name. */
     prefix?: string;
+    /** Generational or other name suffix. */
     suffix?: string;
+    /** Initials of the given name. */
     initial?: string;
+    /** Whether the parsed family name includes a name prefix. */
     useprefix?: boolean;
+    /** Whether the source separated the suffix from the name with a comma. */
     juniorcomma?: boolean;
 }
+/** A normalized field value: scalar text, a list of strings, or parsed creator records. */
 export type FieldValue = string | string[] | Creator[];
+/** Creator-list fields whose values are returned as arrays of {@link Creator} objects. */
 export type CreatorFields = {
     author?: Creator[];
     bookauthor?: Creator[];
@@ -35,6 +76,7 @@ export type CreatorFields = {
     scriptwriter?: Creator[];
     translator?: Creator[];
 };
+/** List-valued fields whose elements remain strings. */
 export type ArrayFields = {
     keywords?: string[];
     institution?: string[];
@@ -44,52 +86,56 @@ export type ArrayFields = {
     location?: string[];
     origlocation?: string[];
 };
+/** The known creator-list and string-list fields in a normalized entry. */
 export type TypedFields = CreatorFields & ArrayFields;
+/** Normalized BibTeX fields: known list fields have structured values; other fields are strings. */
 export type Fields = TypedFields & Omit<Record<string, string>, keyof TypedFields>;
 /** A normalized BibTeX entry returned by the parser. */
 export interface Entry {
+    /** Entry type from the source, such as `article` or `inproceedings`. */
     type: string;
+    /** Citation key identifying this entry. */
     key: string;
+    /** Parsed field values, with known creator and list fields represented as arrays. */
     fields: Fields;
+    /** Parsing mode used for each field; see {@link ParseMode}. */
     mode: Record<string, ParseMode>;
+    /** For fields inherited through `crossref`, records the parent entry key and source field name. */
     crossref?: Record<string, {
         parent: string;
         field: string;
     }>;
+    /** Source text for this entry. */
     input: string;
 }
 /** A parsing diagnostic. */
 export interface ParseError {
+    /** Human-readable diagnostic describing the parse or normalization issue. */
     error: string;
+    /** Source fragment associated with the diagnostic, when available. */
     input?: 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. */
     errors: ParseError[];
+    /** Successfully parsed entries, in source order. */
     entries: Entry[];
+    /** Text from `@comment` directives. */
     comments: string[];
+    /** Resolved values declared by `@string` directives. */
     strings: Record<string, string>;
+    /** Values from `@preamble` directives, in source order. */
     preambles: string[];
+    /** JabRef metadata extracted from the library, including groups and file settings. */
     jabref: JabRefMetadata;
 }
-/** Options controlling title sentence casing. */
+/** Options used for sentence casing during BibTeX field normalization. */
 export interface SentenceCaseOptions {
     guess?: boolean;
     subSentence?: boolean;
     preserveQuoted?: boolean;
 }
-/** A classified text token returned by {@link tokenize}. */
-export interface Token {
-    type: 'word' | 'domain' | 'whitespace' | 'number' | 'email' | 'handle' | 'website' | 'markup' | 'other' | 'punctuation';
-    subtype: '' | 'preposition' | 'acronym' | 'contraction' | 'ordinal' | 'word' | 'end' | 'colon' | 'ellipsis';
-    text: string;
-    start: number;
-    end: number;
-    shape: string;
-    sentenceStart: boolean;
-    subSentenceStart: boolean;
-    hyphenated?: Token[];
-}
 /** Options for normalized BibTeX parsing. */
 export interface Options extends ParserOptions {
     /** Language identifiers treated as English for title casing. */
@@ -100,10 +146,14 @@ export interface Options extends ParserOptions {
     sentenceCase?: SentenceCaseOptions;
     /** Control preservation of capitalization inside braces. */
     caseProtection?: 'off' | 'as-needed' | 'strict';
+    /** Merge adjacent equal markup spans separated only by whitespace (default true). */
+    collapseMarkup?: boolean;
+    /** Render URL commands as HTML links (default true), or as case-protected destinations. */
+    richURL?: boolean;
     /** Policy for unsupported TeX commands and environments. */
     unsupported?: 'tex' | 'text' | 'ignore' | 'throw';
-    /** Fields parsed as verbatim text rather than TeX. */
-    verbatimFields?: (string | RegExp)[];
+    /** Field-name glob patterns parsed as verbatim text rather than TeX (`*`, `?`, and `\\`). */
+    verbatimFields?: string[];
     /** Fields for which a redundant outer brace pair is removed. */
     removeOuterBraces?: string[];
     /** Override the default parsing mode for individual fields. */
@@ -115,36 +165,64 @@ export interface Options extends ParserOptions {
 }
 /** Options shared by the normalized and verbatim parsers. */
 export interface ParserOptions {
-    /** Stop after this many entries have been parsed. */
+    /** Stop after this many entries have been parsed; useful for quickly checking whether text is BibTeX. */
     maxEntries?: number;
-    /** Preload string definitions as a dictionary or BibTeX source. */
+    /** Preload `@string` definitions as a name-to-value map or BibTeX source text. */
     strings?: Record<string, string> | string;
 }
-/** An entry whose field values retain their original BibTeX text. */
+/** An entry whose field values retain their BibTeX text instead of being interpreted as LaTeX. */
 export interface VerbatimEntry {
+    /** Source text for this entry. */
     input: string;
+    /** Entry type from the source. */
     type: string;
+    /** Citation key identifying this entry. */
     key: string;
+    /** Field names mapped to their text values; creator names and LaTeX are not normalized. */
     fields: Record<string, string>;
 }
-/** The library returned by the verbatim parser. */
+/** The library returned by the verbatim parser, before normalized field parsing. */
 export interface VerbatimLibrary {
+    /** Successfully parsed entries, in source order. */
     entries: VerbatimEntry[];
+    /** Resolved values declared by `@string` directives. */
     strings: Record<string, string>;
+    /** Text from `@comment` directives. */
     comments: string[];
+    /** Diagnostics collected while parsing. */
     errors: ParseError[];
+    /** Values from `@preamble` directives, in source order. */
     preambles: string[];
+    /** JabRef metadata extracted from the library. */
     jabref: JabRefMetadata;
 }
 /** Default language identifiers treated as English. */
 export declare const english: string[];
-/** Parses BibTeX while leaving field contents uninterpreted. */
+/**
+ * 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.
+ *
+ * @example
+ * ```ts
+ * const library = parseVerbatim('@article{example, title={A \\LaTeX title}}')
+ * const rawTitle = library.entries[0]?.fields.title
+ * ```
+ */
 export declare function parseVerbatim(input: string, options?: ParserOptions): VerbatimLibrary;
-/** Asynchronous variant of {@link parseVerbatim}. */
+/** Asynchronous variant of {@link parseVerbatim}; yields while processing large inputs. */
 export declare function parseVerbatimAsync(input: string, options?: ParserOptions): Promise<VerbatimLibrary>;
-/** Parses BibTeX or BibLaTeX source into a normalized library. */
+/**
+ * Parses BibTeX or BibLaTeX source into normalized entries and field values.
+ * Recoverable problems are reported in `Library.errors`; set `unsupported: 'throw'` to throw on unsupported TeX commands or environments.
+ *
+ * @example
+ * ```ts
+ * const { entries, errors } = parse('@article{example, author={Ada Lovelace}, title={A title}}')
+ * const title = entries[0]?.fields.title
+ * ```
+ */
 export declare function parse(input: string, options?: Options): Library;
-/** Asynchronous variant of {@link parse}, yielding during large parses. */
+/** Asynchronous variant of {@link parse}; returns the same result shape and yields between batches for large inputs. */
 export declare function parseAsync(input: string, options?: Options): Promise<Library>;
 /** Converts a title to sentence case using heuristic token classification. */
 export declare function toSentenceCase(input: string, options?: {
@@ -152,5 +230,3 @@ export declare function toSentenceCase(input: string, options?: {
     subSentenceCapitalization?: boolean;
     guess?: boolean;
 }): string;
-/** Splits text into classified tokens with source offsets. */
-export declare function tokenize(input: string, markup?: RegExp): Token[];

package/dist/wasm/index.js

@@ -1,38 +1,39 @@
-/** @module wasm */
-import init, { initSync, parse as parseWasm, parseAsync as parseAsyncWasm, parseVerbatim as parseVerbatimWasm, parseVerbatimAsync as parseVerbatimAsyncWasm, tokenize as tokenizeWasm, toSentenceCase as toSentenceCaseWasm } from './bibtex_parser.js';
+/** @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 };
-/** Initializes the WebAssembly parser; await this before using its exports. */
-export { init, initSync };
+/**
+ * Loads and initializes the WebAssembly parser asynchronously.
+ *
+ * With no argument, the browser build fetches the package's WASM file relative to this module. Pass a URL-like resource to choose another location, or pass bytes when the caller loads the binary itself. Initialize once before calling parser functions.
+ *
+ * @example
+ * ```ts
+ * import init, { parse } from '@retorquere/bibtex-parser'
+ *
+ * await init()
+ * const library = parse('@article{example, title={A title}}')
+ * ```
+ */
+export { init };
+/**
+ * Initializes the WebAssembly parser from bytes or a compiled module without fetching it.
+ * Call this before any parser function; prefer {@link init} when the binary should be loaded asynchronously.
+ *
+ * @example
+ * ```ts
+ * import { readFile } from 'node:fs/promises'
+ * import { initSync, parse } from '@retorquere/bibtex-parser'
+ *
+ * initSync({ module: await readFile('bibtex_parser_bg.wasm') })
+ * const library = parse('@article{example, title={A title}}')
+ * ```
+ */
+export { initSync };
 export default init;
 /** Default language identifiers treated as English. */
-export const english = [
-    '',
-    'american',
-    'british',
-    'canadian',
-    'english',
-    'australian',
-    'newzealand',
-    'usenglish',
-    'ukenglish',
-    'en',
-    'eng',
-    'en-au',
-    'en-bz',
-    'en-ca',
-    'en-cb',
-    'en-gb',
-    'en-ie',
-    'en-jm',
-    'en-nz',
-    'en-ph',
-    'en-tt',
-    'en-us',
-    'en-za',
-    'en-zw',
-    'anglais',
-];
+export const english = englishDefaults;
 function prepare(input, options = {}) {
     const parserOptions = Object.fromEntries(Object.entries(options).filter(([, value]) => value !== undefined));
     if (typeof parserOptions.strings === 'string') {
@@ -42,15 +43,6 @@ function prepare(input, options = {}) {
     if (parserOptions.unsupported !== undefined && !['tex', 'text', 'ignore', 'throw'].includes(parserOptions.unsupported)) {
         throw new TypeError('unsupported must be tex, text, ignore, or throw');
     }
-    if (Array.isArray(parserOptions.verbatimFields)) {
-        parserOptions.verbatimFields = parserOptions.verbatimFields.map((field) => {
-            if (typeof field === 'string')
-                return field;
-            const flags = `${field.multiline ? 'm' : ''}${field.dotAll ? 's' : ''}`;
-            const source = flags ? `(?${flags}:${field.source})` : field.source;
-            return { source: field.sticky ? `\\A(?:${source})` : source };
-        });
-    }
     return { input, options: parserOptions };
 }
 function throwOnUnsupported(result) {
@@ -63,17 +55,35 @@ function withJabRef(result) {
     result.jabref = new JabRefMetadata(result.jabref);
     return result;
 }
-/** Parses BibTeX while leaving field contents uninterpreted. */
+/**
+ * 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.
+ *
+ * @example
+ * ```ts
+ * const library = parseVerbatim('@article{example, title={A \\LaTeX title}}')
+ * const rawTitle = library.entries[0]?.fields.title
+ * ```
+ */
 export function parseVerbatim(input, options = {}) {
     const prepared = prepare(input, options);
     return withJabRef(parseVerbatimWasm(prepared.input, prepared.options));
 }
-/** Asynchronous variant of {@link parseVerbatim}. */
+/** Asynchronous variant of {@link parseVerbatim}; yields while processing large inputs. */
 export async function parseVerbatimAsync(input, options = {}) {
     const prepared = prepare(input, options);
     return withJabRef(await parseVerbatimAsyncWasm(prepared.input, prepared.options));
 }
-/** Parses BibTeX or BibLaTeX source into a normalized library. */
+/**
+ * Parses BibTeX or BibLaTeX source into normalized entries and field values.
+ * Recoverable problems are reported in `Library.errors`; set `unsupported: 'throw'` to throw on unsupported TeX commands or environments.
+ *
+ * @example
+ * ```ts
+ * const { entries, errors } = parse('@article{example, author={Ada Lovelace}, title={A title}}')
+ * const title = entries[0]?.fields.title
+ * ```
+ */
 export function parse(input, options = {}) {
     const prepared = prepare(input, options);
     const result = withJabRef(parseWasm(prepared.input, prepared.options));
@@ -81,7 +91,7 @@ export function parse(input, options = {}) {
         return throwOnUnsupported(result);
     return result;
 }
-/** Asynchronous variant of {@link parse}, yielding during large parses. */
+/** 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));
@@ -93,10 +103,3 @@ export async function parseAsync(input, options = {}) {
 export function toSentenceCase(input, options = {}) {
     return toSentenceCaseWasm(input, options);
 }
-/** Splits text into classified tokens with source offsets. */
-export function tokenize(input, markup) {
-    if (!(markup instanceof RegExp))
-        return tokenizeWasm(input);
-    const masked = input.replace(markup, match => '\u2060'.repeat(match.length));
-    return tokenizeWasm(masked);
-}

package/dist/wasm/jabref.d.ts

@@ -2,37 +2,25 @@
  * A JabRef group.
  */
 export interface Group {
-    /**
-     * the group name
-     */
+    /** Name displayed for this group in JabRef. */
     name: string;
-    /**
-     * The citation keys which are specified to belong to this group, after intersection calculation has been applied
-     */
+    /** Citation keys belonging to this group after supported group rules are applied. */
     entries: string[];
-    /**
-     * Sub-groups under this group
-     */
+    /** Direct child groups. */
     groups: Group[];
 }
+/** JabRef metadata parsed from a BibTeX library, including its group tree and file settings. */
 export declare class JabRefMetadata {
     #private;
-    /**
-     * The root groups. You can find the nested groups in their `groups` property
-     */
+    /** Top-level groups; nested groups are available through each group's `groups` property. */
     root: Group[];
-    /**
-     * The base path for file paths
-     */
+    /** Base directory used to resolve relative attachment paths. */
     fileDirectory?: string;
-    /**
-     * The JabRef metadata format version
-     */
+    /** JabRef group metadata format version. */
     groupsversion?: number;
-    /**
-     * The JabRef metadata database type
-     */
+    /** 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;

package/dist/wasm/jabref.js

@@ -18,12 +18,12 @@ function decode(s = '', sep = ';') {
     }
     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();
-    /**
-     * The root groups. You can find the nested groups in their `groups` property
-     */
+    /** 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']) {