@boarteam/fix-dict-fix44 0.2.0 → 2.0.0

package/README.md

@@ -1,13 +1,12 @@
 # @boarteam/fix-dict-fix44
 
-The **complete FIX 4.4 dictionary as data** (912 fields / 26 components / 93 messages / 25
+The **complete FIX 4.4 dictionary as data** (912 fields / 93 messages / 105 components / 23
 datatypes) for the [`@boarteam/fix`](https://www.npmjs.com/package/@boarteam/fix) engine.
-Generated from the FIX 4.4 specification and cross-checked against the QuickFIX `FIX44.xml`
-dictionary by a CI drift gate — never hand-maintained.
+Generated directly from the QuickFIX `FIX44.xml` data dictionary — never hand-maintained.
 
 On a 0.x line and actively developed. See the
-[project README](https://github.com/boarteam/fix-protocol#readme) for coverage, the cross-check
-report, and declared coverage gaps.
+[project README](https://github.com/boarteam/fix-protocol#readme) for coverage and declared
+coverage gaps.
 
 ```ts
 import { createFixEngine } from '@boarteam/fix';
@@ -17,8 +16,42 @@ const fix = createFixEngine(dictionary);
 const wire = fix.encode({ msgType: MsgType.NewOrderSingle, fields: { [Tags.ClOrdID]: 'A1' } });
 ```
 
-Exports: `dictionary` (the data), `Tags` (field name → tag), `MsgType` (message name →
-MsgType value), and `DICTIONARY_VERSION`.
+Or build the same message with the **typed `message` factory** — statically typed to each
+message's fields/groups, rendering byte-identical to `encode`:
+
+```ts
+import { message, MsgType } from '@boarteam/fix-dict-fix44';
+
+const wire = message(MsgType.NewOrderSingle)
+  .set('ClOrdID', 'A1')
+  .set('Side', '1') // typed to the Side value union
+  .render({
+    SenderCompID: 'ME',
+    TargetCompID: 'YOU',
+    MsgSeqNum: 1,
+    SendingTime: '20260716-12:00:00',
+  });
+```
+
+Exports: `dictionary` (the data), `Tags` (field name → tag), `TagNames` (tag → field
+name), `MsgType` (message name → MsgType value), `MsgTypeNames` (MsgType value →
+message name), `Enums` (field name → spec value name → wire string, e.g.
+`Enums.MDEntryType.BID === '0'`), a top-level const per enumerated field (`Side`,
+`OrdType`, `MDEntryType`, ...), and `DICTIONARY_VERSION`. `MsgType` and every
+per-field const are also same-name types — unions of their wire values — so
+`msgType: MsgType` and `side: Side` work in type positions. The one enumerated
+field without a top-level const is `MsgType` (tag 35), whose name belongs to the
+message-type map: use `Enums.MsgType`.
+
+For the typed encode side it also exports `message` (a factory bound to this dictionary),
+`MessageBodies` (the `MsgType` value → body-type registry), and a named body type per message
+(`NewOrderSingleBody`, `MarketDataSnapshotFullRefreshBody`, …) plus augmentable per-container
+group/component `interface`s (`SecListGrp_NoRelatedSymEntry`, `InstrumentFields`, …) that venue
+extensions patch via declaration merging. For the read side it exports `isMessageType` — a type
+guard that narrows a `MessageView<any>` of unknown type to a specific message's body keyed on its
+`MsgType` value (so `get()` becomes typed) — and `MessageOf<M>`, the matching annotation alias.
+See the [`@boarteam/fix` README](https://www.npmjs.com/package/@boarteam/fix) for the
+typed-message API.
 
 Requires `@boarteam/fix` as a peer dependency.