@echecs/pgn 3.6.2 → 3.7.0

package/CHANGELOG.md

@@ -8,6 +8,25 @@ and this project adheres to
 
 ## [Unreleased]
 
+## [3.7.0] - 2026-03-15
+
+### Added
+
+- `onWarning` option for `parse()` and `stream()`: fires once per missing STR
+  tag. Emitted in alphabetical key order: `Black`, `Date`, `Event`, `Result`,
+  `Round`, `Site`, `White`.
+- `ParseWarning` is now an exported type with the same shape as `ParseError`.
+
+### Fixed
+
+- `parse()` and `stream()` now strip a UTF-8 BOM (`\uFEFF`) at the start of
+  input. Chessbase and Windows editors commonly produce BOM-prefixed PGN files
+  that previously failed silently.
+- Tag values containing escaped quotes (`\"`) or escaped backslashes (`\\`) now
+  parse correctly per PGN spec section 7.
+- Games with no tag pairs (bare move list + result) now parse correctly per PGN
+  spec section 8.1 ("zero or more tag pairs"). These games return `meta: {}`.
+
 ## [3.6.2] - 2026-03-15
 
 ### Performance

package/README.md

@@ -135,6 +135,31 @@ for await (const game of stream(chunks, { onError: console.error })) {
 > (truncated input). Incomplete input at end-of-stream is treated as expected
 > behaviour, not a parse error.
 
+### Warnings
+
+Pass `onWarning` to observe spec-compliance issues that do not prevent parsing:
+
+```typescript
+import parse, { type ParseWarning } from '@echecs/pgn';
+
+const games = parse(input, {
+  onWarning(warn: ParseWarning) {
+    console.warn(warn.message);
+  },
+});
+```
+
+`onWarning` receives a `ParseWarning` with the same fields as `ParseError`:
+`message`, `offset`, `line`, `column`.
+
+Currently fires for: missing STR tags (`Event`, `Site`, `Date`, `Round`,
+`White`, `Black`, `Result`). Warnings are emitted in alphabetical key order.
+
+The same option is accepted by `stream()`.
+
+> **Note:** `onWarning` position fields (`offset`, `line`, `column`) are nominal
+> placeholders — missing tags have no source location.
+
 ### PGN object
 
 ```typescript