@retorquere/bibtex-parser 12.1.13 → 13.0.2

package/README.md

@@ -12,10 +12,10 @@ Documentation is available at [https://retorque.re/bibtex-parser/](https://retor
 
 ## Choosing a Parser
 
-The TypeScript implementation remains the default:
+The Rust/WebAssembly implementation is the default export (ESM only, see below). The pure TypeScript implementation, which also needs no initialization, is available as an ESM-only `/js` subpath:
 
 ```js
-import { parse } from '@retorquere/bibtex-parser'
+import { parse } from '@retorquere/bibtex-parser/js'
 
 const library = parse('@article{example, title={A title}}')
 ```
@@ -23,19 +23,19 @@ const library = parse('@article{example, title={A title}}')
 For the scanner-level representation, use `parseVerbatim`. Its fields are strings and have not been normalized or interpreted as LaTeX:
 
 ```js
-import { parseVerbatim } from '@retorquere/bibtex-parser'
+import { parseVerbatim } from '@retorquere/bibtex-parser/js'
 
 const library = parseVerbatim('@article{example, title={A title}}')
 ```
 
-The generated API documentation covers the normalized TypeScript API, the root `parseVerbatim` export, and the WASM exports available from `/wasm`.
+The generated API documentation covers the normalized TypeScript API (`/js`), its `parseVerbatim` export, and the WASM exports available from the default entry point.
 
 All parser results expose `preambles: string[]`, retaining multiple `@preamble` directives in source order. The normalized result property was previously named `preamble`; callers should use `preambles` instead.
 
-The WebAssembly implementation is available as an ESM entry point at `/wasm`. Initialize it before calling the parser. In a browser, `init()` loads the binary relative to the module:
+The WebAssembly implementation is the ESM-only default entry point. Initialize it before calling the parser. In a browser, `init()` loads the binary relative to the module:
 
 ```js
-import init, { parse } from '@retorquere/bibtex-parser/wasm'
+import init, { parse } from '@retorquere/bibtex-parser'
 
 await init()
 const library = parse('@article{example, title={A title}}')
@@ -45,9 +45,9 @@ In Node.js, load the exported binary explicitly:
 
 ```js
 import { readFile } from 'node:fs/promises'
-import init, { parse } from '@retorquere/bibtex-parser/wasm'
+import init, { parse } from '@retorquere/bibtex-parser'
 
-const binary = new URL(import.meta.resolve('@retorquere/bibtex-parser/wasm/bibtex_parser_bg.wasm'))
+const binary = new URL(import.meta.resolve('@retorquere/bibtex-parser/bibtex_parser_bg.wasm'))
 await init({ module_or_path: await readFile(binary) })
 const library = parse('@article{example, title={A title}}')
 ```
@@ -56,10 +56,10 @@ Both entry points include TypeScript declarations. Building the package from sou
 
 ### Zotero Plugins
 
-Include the `/wasm` JavaScript entry point in your plugin's build and package the WASM binary as a plugin resource. In the plugin's privileged Zotero context, initialize the parser during startup, before any parsing calls:
+Include the default JavaScript entry point in your plugin's build and package the WASM binary as a plugin resource. In the plugin's privileged Zotero context, initialize the parser during startup, before any parsing calls:
 
 ```js
-import init, { parse } from '@retorquere/bibtex-parser/wasm'
+import init, { parse } from '@retorquere/bibtex-parser'
 
 await init({ module_or_path: 'chrome://zotero-better-bibtex/content/resource/bibtex/bibtex_parser_bg.wasm' })
 
@@ -68,6 +68,10 @@ const library = parse('@article{example, title={A title}}')
 
 Await initialization once during startup; subsequent `parse` or `parseAsync` calls reuse the initialized module.
 
+## URL Commands
+
+Both parsers accept `richURL`, a boolean that defaults to `true`. With `richURL: true`, `\href{http://example.org/{id}}{url}` renders as `<a href="http://example.org/{id}">url</a>` without case-protection spans. With `richURL: false`, it renders as `<span class="nocase">http://example.org/{id}</span>`, discarding the label and preserving the destination's casing regardless of the `caseProtection` setting. The option also applies to `\url`.
+
 ## Unknown TeX Commands
 
 Both `parse` and `parseAsync` accept an `unsupported` option:

package/dist/esm/crossref.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"crossref.d.ts","sourceRoot":"","sources":["../../js/crossref.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAiLlE,CAAA"}

package/dist/esm/crossref.js.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
-  "sources": ["../../crossref.ts"],
+  "sources": ["../../js/crossref.ts"],
   "sourcesContent": ["export const crossref: Record<string, Record<string, Record<string, string>>> = {\n  '*': {\n    '*': {},\n  },\n  article: {\n    periodical: {\n      journalsubtitle: 'subtitle',\n      journaltitle: 'title',\n    },\n  },\n  book: {\n    mvbook: {\n      mainsubtitle: 'subtitle',\n      maintitle: 'title',\n      maintitleaddon: 'titleaddon',\n    },\n  },\n  bookinbook: {\n    book: {\n      bookauthor: 'author',\n      booksubtitle: 'subtitle',\n      booktitle: 'title',\n      booktitleaddon: 'titleaddon',\n    },\n    mvbook: {\n      bookauthor: 'author',\n      mainsubtitle: 'subtitle',\n      maintitle: 'title',\n      maintitleaddon: 'titleaddon',\n    },\n  },\n  collection: {\n    mvcollection: {\n      mainsubtitle: 'subtitle',\n      maintitle: 'title',\n      maintitleaddon: 'titleaddon',\n    },\n    mvreference: {\n      mainsubtitle: 'subtitle',\n      maintitle: 'title',\n      maintitleaddon: 'titleaddon',\n    },\n  },\n  inbook: {\n    '*': {\n      bookauthor: 'author',\n    },\n    book: {\n      bookauthor: 'author',\n      booksubtitle: 'subtitle',\n      booktitle: 'title',\n      booktitleaddon: 'titleaddon',\n    },\n    mvbook: {\n      bookauthor: 'author',\n      mainsubtitle: 'subtitle',\n      maintitle: 'title',\n      maintitleaddon: 'titleaddon',\n    },\n  },\n  incollection: {\n    collection: {\n      booksubtitle: 'subtitle',\n      booktitle: 'title',\n      booktitleaddon: 'titleaddon',\n    },\n    mvcollection: {\n      mainsubtitle: 'subtitle',\n      maintitle: 'title',\n      maintitleaddon: 'titleaddon',\n    },\n    mvreference: {\n      mainsubtitle: 'subtitle',\n      maintitle: 'title',\n      maintitleaddon: 'titleaddon',\n    },\n    reference: {\n      booksubtitle: 'subtitle',\n      booktitle: 'title',\n      booktitleaddon: 'titleaddon',\n    },\n  },\n  inproceedings: {\n    mvproceedings: {\n      mainsubtitle: 'subtitle',\n      maintitle: 'title',\n      maintitleaddon: 'titleaddon',\n    },\n    proceedings: {\n      booksubtitle: 'subtitle',\n      booktitle: 'title',\n      booktitleaddon: 'titleaddon',\n    },\n  },\n  inreference: {\n    collection: {\n      booksubtitle: 'subtitle',\n      booktitle: 'title',\n      booktitleaddon: 'titleaddon',\n    },\n    mvcollection: {\n      mainsubtitle: 'subtitle',\n      maintitle: 'title',\n      maintitleaddon: 'titleaddon',\n    },\n    mvreference: {\n      mainsubtitle: 'subtitle',\n      maintitle: 'title',\n      maintitleaddon: 'titleaddon',\n    },\n    reference: {\n      booksubtitle: 'subtitle',\n      booktitle: 'title',\n      booktitleaddon: 'titleaddon',\n    },\n  },\n  proceedings: {\n    mvproceedings: {\n      mainsubtitle: 'subtitle',\n      maintitle: 'title',\n      maintitleaddon: 'titleaddon',\n    },\n  },\n  reference: {\n    mvcollection: {\n      mainsubtitle: 'subtitle',\n      maintitle: 'title',\n      maintitleaddon: 'titleaddon',\n    },\n    mvreference: {\n      mainsubtitle: 'subtitle',\n      maintitle: 'title',\n      maintitleaddon: 'titleaddon',\n    },\n  },\n  suppbook: {\n    book: {\n      bookauthor: 'author',\n      booksubtitle: 'subtitle',\n      booktitle: 'title',\n      booktitleaddon: 'titleaddon',\n    },\n    mvbook: {\n      bookauthor: 'author',\n      mainsubtitle: 'subtitle',\n      maintitle: 'title',\n      maintitleaddon: 'titleaddon',\n    },\n  },\n  suppcollection: {\n    collection: {\n      booksubtitle: 'subtitle',\n      booktitle: 'title',\n      booktitleaddon: 'titleaddon',\n    },\n    mvcollection: {\n      mainsubtitle: 'subtitle',\n      maintitle: 'title',\n      maintitleaddon: 'titleaddon',\n    },\n    mvreference: {\n      mainsubtitle: 'subtitle',\n      maintitle: 'title',\n      maintitleaddon: 'titleaddon',\n    },\n    reference: {\n      booksubtitle: 'subtitle',\n      booktitle: 'title',\n      booktitleaddon: 'titleaddon',\n    },\n  },\n  suppperiodical: {\n    periodical: {\n      journalsubtitle: 'subtitle',\n      journaltitle: 'title',\n    },\n  },\n} as const\n"],
   "mappings": "AAAO,MAAM,WAAmE;AAAA,EAC9E,KAAK;AAAA,IACH,KAAK,CAAC;AAAA,EACR;AAAA,EACA,SAAS;AAAA,IACP,YAAY;AAAA,MACV,iBAAiB;AAAA,MACjB,cAAc;AAAA,IAChB;AAAA,EACF;AAAA,EACA,MAAM;AAAA,IACJ,QAAQ;AAAA,MACN,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,EACF;AAAA,EACA,YAAY;AAAA,IACV,MAAM;AAAA,MACJ,YAAY;AAAA,MACZ,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,IACA,QAAQ;AAAA,MACN,YAAY;AAAA,MACZ,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,EACF;AAAA,EACA,YAAY;AAAA,IACV,cAAc;AAAA,MACZ,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,IACA,aAAa;AAAA,MACX,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,EACF;AAAA,EACA,QAAQ;AAAA,IACN,KAAK;AAAA,MACH,YAAY;AAAA,IACd;AAAA,IACA,MAAM;AAAA,MACJ,YAAY;AAAA,MACZ,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,IACA,QAAQ;AAAA,MACN,YAAY;AAAA,MACZ,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,EACF;AAAA,EACA,cAAc;AAAA,IACZ,YAAY;AAAA,MACV,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,IACA,cAAc;AAAA,MACZ,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,IACA,aAAa;AAAA,MACX,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,IACA,WAAW;AAAA,MACT,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,EACF;AAAA,EACA,eAAe;AAAA,IACb,eAAe;AAAA,MACb,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,IACA,aAAa;AAAA,MACX,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,EACF;AAAA,EACA,aAAa;AAAA,IACX,YAAY;AAAA,MACV,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,IACA,cAAc;AAAA,MACZ,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,IACA,aAAa;AAAA,MACX,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,IACA,WAAW;AAAA,MACT,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,EACF;AAAA,EACA,aAAa;AAAA,IACX,eAAe;AAAA,MACb,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,EACF;AAAA,EACA,WAAW;AAAA,IACT,cAAc;AAAA,MACZ,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,IACA,aAAa;AAAA,MACX,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,EACF;AAAA,EACA,UAAU;AAAA,IACR,MAAM;AAAA,MACJ,YAAY;AAAA,MACZ,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,IACA,QAAQ;AAAA,MACN,YAAY;AAAA,MACZ,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,EACF;AAAA,EACA,gBAAgB;AAAA,IACd,YAAY;AAAA,MACV,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,IACA,cAAc;AAAA,MACZ,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,IACA,aAAa;AAAA,MACX,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,IACA,WAAW;AAAA,MACT,cAAc;AAAA,MACd,WAAW;AAAA,MACX,gBAAgB;AAAA,IAClB;AAAA,EACF;AAAA,EACA,gBAAgB;AAAA,IACd,YAAY;AAAA,MACV,iBAAiB;AAAA,MACjB,cAAc;AAAA,IAChB;AAAA,EACF;AACF;",
   "names": []

package/dist/esm/fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../js/fields.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAq+NnC,CAAA;AAEV,eAAO,MAAM,UAAU,EAAE,MAAM,EAmBrB,CAAA"}