jspurefix 5.11.3 → 5.11.4

package/dist/generator/instrument-universe.d.ts

@@ -0,0 +1,54 @@
+import { Rng } from './rng';
+export declare enum AssetClass {
+    Equity = "equity",
+    Future = "future",
+    Option = "option",
+    Spread = "spread",
+    Fx = "fx",
+    Bond = "bond"
+}
+export interface ILegSpec {
+    readonly symbol: string;
+    readonly securityId: string;
+    readonly securityIdSource: string;
+    readonly securityType: string;
+    readonly maturityMonthYear?: string;
+    readonly side: string;
+    readonly ratio: number;
+    readonly refPx: number;
+}
+export interface IInstrumentSpec {
+    readonly name: string;
+    readonly assetClass: AssetClass;
+    readonly symbol: string;
+    readonly securityId: string;
+    readonly securityIdSource: string;
+    readonly securityExchange: string;
+    readonly securityType: string;
+    readonly cfiCode: string;
+    readonly currency: string;
+    readonly refPx: number;
+    readonly tick: number;
+    readonly lotSize: number;
+    readonly contractMultiplier?: number;
+    readonly maturityMonthYear?: string;
+    readonly maturityDate?: string;
+    readonly strikePrice?: number;
+    readonly putOrCall?: number;
+    readonly product?: number;
+    readonly legs?: readonly ILegSpec[];
+}
+declare function byClass(assetClass: AssetClass): readonly IInstrumentSpec[];
+export declare const InstrumentUniverse: {
+    equities: readonly IInstrumentSpec[];
+    futures: readonly IInstrumentSpec[];
+    options: readonly IInstrumentSpec[];
+    fx: readonly IInstrumentSpec[];
+    bonds: readonly IInstrumentSpec[];
+    spreads: readonly IInstrumentSpec[];
+    all: readonly IInstrumentSpec[];
+    byClass: typeof byClass;
+    byName(name: string): IInstrumentSpec | undefined;
+    choose(rng: Rng, assetClass?: AssetClass): IInstrumentSpec;
+};
+export {};

package/dist/generator/instrument-universe.js

@@ -0,0 +1,286 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InstrumentUniverse = exports.AssetClass = void 0;
+var AssetClass;
+(function (AssetClass) {
+    AssetClass["Equity"] = "equity";
+    AssetClass["Future"] = "future";
+    AssetClass["Option"] = "option";
+    AssetClass["Spread"] = "spread";
+    AssetClass["Fx"] = "fx";
+    AssetClass["Bond"] = "bond";
+})(AssetClass || (exports.AssetClass = AssetClass = {}));
+const equities = [
+    {
+        name: 'Apple Inc',
+        assetClass: AssetClass.Equity,
+        symbol: 'AAPL',
+        securityId: 'US0378331005',
+        securityIdSource: '4',
+        securityExchange: 'XNAS',
+        securityType: 'CS',
+        cfiCode: 'ESVUFR',
+        currency: 'USD',
+        refPx: 214.5,
+        tick: 0.01,
+        lotSize: 100,
+        product: 5
+    },
+    {
+        name: 'Vodafone Group',
+        assetClass: AssetClass.Equity,
+        symbol: 'VOD.L',
+        securityId: 'GB00BH4HKS39',
+        securityIdSource: '4',
+        securityExchange: 'XLON',
+        securityType: 'CS',
+        cfiCode: 'ESVUFR',
+        currency: 'GBP',
+        refPx: 0.762,
+        tick: 0.0001,
+        lotSize: 1000,
+        product: 5
+    },
+    {
+        name: 'SAP SE',
+        assetClass: AssetClass.Equity,
+        symbol: 'SAP',
+        securityId: 'DE0007164600',
+        securityIdSource: '4',
+        securityExchange: 'XETR',
+        securityType: 'CS',
+        cfiCode: 'ESVUFR',
+        currency: 'EUR',
+        refPx: 196.3,
+        tick: 0.01,
+        lotSize: 100,
+        product: 5
+    }
+];
+const futures = [
+    {
+        name: 'ICE Brent Crude Jan26',
+        assetClass: AssetClass.Future,
+        symbol: 'BRN',
+        securityId: 'BRN FMF0026!',
+        securityIdSource: '8',
+        securityExchange: 'IFEU',
+        securityType: 'FUT',
+        cfiCode: 'FCEPSX',
+        currency: 'USD',
+        refPx: 71.35,
+        tick: 0.01,
+        lotSize: 1,
+        contractMultiplier: 1000,
+        maturityMonthYear: '202601',
+        maturityDate: '20251130',
+        product: 2
+    },
+    {
+        name: 'ICE Low Sulphur Gasoil Feb26',
+        assetClass: AssetClass.Future,
+        symbol: 'GAS',
+        securityId: 'GAS FMG0026!',
+        securityIdSource: '8',
+        securityExchange: 'IFEU',
+        securityType: 'FUT',
+        cfiCode: 'FCEPSX',
+        currency: 'USD',
+        refPx: 668.25,
+        tick: 0.25,
+        lotSize: 1,
+        contractMultiplier: 100,
+        maturityMonthYear: '202602',
+        maturityDate: '20260112',
+        product: 2
+    },
+    {
+        name: 'CME E-mini S and P 500 Dec25',
+        assetClass: AssetClass.Future,
+        symbol: 'ES',
+        securityId: 'ESZ5',
+        securityIdSource: '8',
+        securityExchange: 'XCME',
+        securityType: 'FUT',
+        cfiCode: 'FFICSX',
+        currency: 'USD',
+        refPx: 6042.25,
+        tick: 0.25,
+        lotSize: 1,
+        contractMultiplier: 50,
+        maturityMonthYear: '202512',
+        maturityDate: '20251219',
+        product: 5
+    }
+];
+const options = [
+    {
+        name: 'CME E-mini Dec25 6000 Call',
+        assetClass: AssetClass.Option,
+        symbol: 'ES',
+        securityId: 'ESZ5 C6000',
+        securityIdSource: '8',
+        securityExchange: 'XCME',
+        securityType: 'OPT',
+        cfiCode: 'OCEFCS',
+        currency: 'USD',
+        refPx: 118.75,
+        tick: 0.25,
+        lotSize: 1,
+        contractMultiplier: 50,
+        maturityMonthYear: '202512',
+        maturityDate: '20251219',
+        strikePrice: 6000,
+        putOrCall: 1,
+        product: 5
+    }
+];
+const fx = [
+    {
+        name: 'EUR/USD spot',
+        assetClass: AssetClass.Fx,
+        symbol: 'EUR/USD',
+        securityId: 'EURUSD',
+        securityIdSource: '8',
+        securityExchange: 'XOFF',
+        securityType: 'FXSPOT',
+        cfiCode: 'MRCXXX',
+        currency: 'EUR',
+        refPx: 1.0842,
+        tick: 0.00005,
+        lotSize: 1000000,
+        product: 4
+    }
+];
+const bonds = [
+    {
+        name: 'US Treasury 4.25 Nov 2034',
+        assetClass: AssetClass.Bond,
+        symbol: 'T 4.25 11/34',
+        securityId: 'US91282CLW12',
+        securityIdSource: '4',
+        securityExchange: 'XOFF',
+        securityType: 'TBOND',
+        cfiCode: 'DBFUFR',
+        currency: 'USD',
+        refPx: 99.421875,
+        tick: 0.015625,
+        lotSize: 1000,
+        maturityDate: '20341115',
+        product: 6
+    }
+];
+const spreads = [
+    {
+        name: 'ICE Brent Jan26/Feb26 calendar spread',
+        assetClass: AssetClass.Spread,
+        symbol: 'BRN',
+        securityId: 'BRN JAN26-FEB26',
+        securityIdSource: '8',
+        securityExchange: 'IFEU',
+        securityType: 'MLEG',
+        cfiCode: 'FMEPSX',
+        currency: 'USD',
+        refPx: 0.34,
+        tick: 0.01,
+        lotSize: 1,
+        contractMultiplier: 1000,
+        maturityMonthYear: '202601',
+        product: 2,
+        legs: [
+            {
+                symbol: 'BRN',
+                securityId: 'BRN FMF0026!',
+                securityIdSource: '8',
+                securityType: 'FUT',
+                maturityMonthYear: '202601',
+                side: '1',
+                ratio: 1,
+                refPx: 71.35
+            },
+            {
+                symbol: 'BRN',
+                securityId: 'BRN FMG0026!',
+                securityIdSource: '8',
+                securityType: 'FUT',
+                maturityMonthYear: '202602',
+                side: '2',
+                ratio: 1,
+                refPx: 71.01
+            }
+        ]
+    },
+    {
+        name: 'ICE Brent/Gasoil crack spread',
+        assetClass: AssetClass.Spread,
+        symbol: 'BRNGAS',
+        securityId: 'BRN-GAS CRACK',
+        securityIdSource: '8',
+        securityExchange: 'IFEU',
+        securityType: 'MLEG',
+        cfiCode: 'FMEPSX',
+        currency: 'USD',
+        refPx: 12.68,
+        tick: 0.01,
+        lotSize: 1,
+        contractMultiplier: 1000,
+        maturityMonthYear: '202602',
+        product: 2,
+        legs: [
+            {
+                symbol: 'GAS',
+                securityId: 'GAS FMG0026!',
+                securityIdSource: '8',
+                securityType: 'FUT',
+                maturityMonthYear: '202602',
+                side: '1',
+                ratio: 1,
+                refPx: 668.25
+            },
+            {
+                symbol: 'BRN',
+                securityId: 'BRN FMG0026!',
+                securityIdSource: '8',
+                securityType: 'FUT',
+                maturityMonthYear: '202602',
+                side: '2',
+                ratio: 1,
+                refPx: 71.2
+            }
+        ]
+    }
+];
+function byClass(assetClass) {
+    switch (assetClass) {
+        case AssetClass.Equity: return equities;
+        case AssetClass.Future: return futures;
+        case AssetClass.Option: return options;
+        case AssetClass.Fx: return fx;
+        case AssetClass.Bond: return bonds;
+        case AssetClass.Spread: return spreads;
+        default: return equities;
+    }
+}
+const all = [
+    ...equities, ...futures, ...options, ...fx, ...bonds, ...spreads
+];
+exports.InstrumentUniverse = {
+    equities,
+    futures,
+    options,
+    fx,
+    bonds,
+    spreads,
+    all,
+    byClass,
+    byName(name) {
+        const lower = name.toLowerCase();
+        return all.find(i => i.symbol.toLowerCase() === lower ||
+            i.securityId.toLowerCase() === lower ||
+            i.name.toLowerCase() === lower);
+    },
+    choose(rng, assetClass) {
+        return rng.pick(assetClass ? byClass(assetClass) : all);
+    }
+};
+//# sourceMappingURL=instrument-universe.js.map

package/dist/generator/instrument-universe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instrument-universe.js","sourceRoot":"","sources":["../../src/generator/instrument-universe.ts"],"names":[],"mappings":";;;AAcA,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;IACjB,uBAAS,CAAA;IACT,2BAAa,CAAA;AACf,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AAoCD,MAAM,QAAQ,GAA+B;IAC3C;QACE,IAAI,EAAE,WAAW;QACjB,UAAU,EAAE,UAAU,CAAC,MAAM;QAC7B,MAAM,EAAE,MAAM;QACd,UAAU,EAAE,cAAc;QAC1B,gBAAgB,EAAE,GAAG;QACrB,gBAAgB,EAAE,MAAM;QACxB,YAAY,EAAE,IAAI;QAClB,OAAO,EAAE,QAAQ;QACjB,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,GAAG;QACZ,OAAO,EAAE,CAAC;KACX;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,UAAU,EAAE,UAAU,CAAC,MAAM;QAC7B,MAAM,EAAE,OAAO;QACf,UAAU,EAAE,cAAc;QAC1B,gBAAgB,EAAE,GAAG;QACrB,gBAAgB,EAAE,MAAM;QACxB,YAAY,EAAE,IAAI;QAClB,OAAO,EAAE,QAAQ;QACjB,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,CAAC;KACX;IACD;QACE,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,UAAU,CAAC,MAAM;QAC7B,MAAM,EAAE,KAAK;QACb,UAAU,EAAE,cAAc;QAC1B,gBAAgB,EAAE,GAAG;QACrB,gBAAgB,EAAE,MAAM;QACxB,YAAY,EAAE,IAAI;QAClB,OAAO,EAAE,QAAQ;QACjB,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,GAAG;QACZ,OAAO,EAAE,CAAC;KACX;CACF,CAAA;AAED,MAAM,OAAO,GAA+B;IAC1C;QACE,IAAI,EAAE,uBAAuB;QAC7B,UAAU,EAAE,UAAU,CAAC,MAAM;QAC7B,MAAM,EAAE,KAAK;QACb,UAAU,EAAE,cAAc;QAC1B,gBAAgB,EAAE,GAAG;QACrB,gBAAgB,EAAE,MAAM;QACxB,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,QAAQ;QACjB,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,CAAC;QACV,kBAAkB,EAAE,IAAI;QACxB,iBAAiB,EAAE,QAAQ;QAC3B,YAAY,EAAE,UAAU;QACxB,OAAO,EAAE,CAAC;KACX;IACD;QACE,IAAI,EAAE,8BAA8B;QACpC,UAAU,EAAE,UAAU,CAAC,MAAM;QAC7B,MAAM,EAAE,KAAK;QACb,UAAU,EAAE,cAAc;QAC1B,gBAAgB,EAAE,GAAG;QACrB,gBAAgB,EAAE,MAAM;QACxB,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,QAAQ;QACjB,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,CAAC;QACV,kBAAkB,EAAE,GAAG;QACvB,iBAAiB,EAAE,QAAQ;QAC3B,YAAY,EAAE,UAAU;QACxB,OAAO,EAAE,CAAC;KACX;IACD;QACE,IAAI,EAAE,8BAA8B;QACpC,UAAU,EAAE,UAAU,CAAC,MAAM;QAC7B,MAAM,EAAE,IAAI;QACZ,UAAU,EAAE,MAAM;QAClB,gBAAgB,EAAE,GAAG;QACrB,gBAAgB,EAAE,MAAM;QACxB,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,QAAQ;QACjB,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,OAAO;QACd,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,CAAC;QACV,kBAAkB,EAAE,EAAE;QACtB,iBAAiB,EAAE,QAAQ;QAC3B,YAAY,EAAE,UAAU;QACxB,OAAO,EAAE,CAAC;KACX;CACF,CAAA;AAED,MAAM,OAAO,GAA+B;IAC1C;QACE,IAAI,EAAE,4BAA4B;QAClC,UAAU,EAAE,UAAU,CAAC,MAAM;QAC7B,MAAM,EAAE,IAAI;QACZ,UAAU,EAAE,YAAY;QACxB,gBAAgB,EAAE,GAAG;QACrB,gBAAgB,EAAE,MAAM;QACxB,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,QAAQ;QACjB,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,CAAC;QACV,kBAAkB,EAAE,EAAE;QACtB,iBAAiB,EAAE,QAAQ;QAC3B,YAAY,EAAE,UAAU;QACxB,WAAW,EAAE,IAAI;QACjB,SAAS,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC;KACX;CACF,CAAA;AAED,MAAM,EAAE,GAA+B;IACrC;QACE,IAAI,EAAE,cAAc;QACpB,UAAU,EAAE,UAAU,CAAC,EAAE;QACzB,MAAM,EAAE,SAAS;QACjB,UAAU,EAAE,QAAQ;QACpB,gBAAgB,EAAE,GAAG;QACrB,gBAAgB,EAAE,MAAM;QACxB,YAAY,EAAE,QAAQ;QACtB,OAAO,EAAE,QAAQ;QACjB,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,OAAO;QACb,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE,CAAC;KACX;CACF,CAAA;AAED,MAAM,KAAK,GAA+B;IACxC;QACE,IAAI,EAAE,2BAA2B;QACjC,UAAU,EAAE,UAAU,CAAC,IAAI;QAC3B,MAAM,EAAE,cAAc;QACtB,UAAU,EAAE,cAAc;QAC1B,gBAAgB,EAAE,GAAG;QACrB,gBAAgB,EAAE,MAAM;QACxB,YAAY,EAAE,OAAO;QACrB,OAAO,EAAE,QAAQ;QACjB,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,IAAI;QACb,YAAY,EAAE,UAAU;QACxB,OAAO,EAAE,CAAC;KACX;CACF,CAAA;AAQD,MAAM,OAAO,GAA+B;IAC1C;QACE,IAAI,EAAE,uCAAuC;QAC7C,UAAU,EAAE,UAAU,CAAC,MAAM;QAC7B,MAAM,EAAE,KAAK;QACb,UAAU,EAAE,iBAAiB;QAC7B,gBAAgB,EAAE,GAAG;QACrB,gBAAgB,EAAE,MAAM;QACxB,YAAY,EAAE,MAAM;QACpB,OAAO,EAAE,QAAQ;QACjB,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,IAAI;QACX,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,CAAC;QACV,kBAAkB,EAAE,IAAI;QACxB,iBAAiB,EAAE,QAAQ;QAC3B,OAAO,EAAE,CAAC;QACV,IAAI,EAAE;YACJ;gBACE,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE,cAAc;gBAC1B,gBAAgB,EAAE,GAAG;gBACrB,YAAY,EAAE,KAAK;gBACnB,iBAAiB,EAAE,QAAQ;gBAC3B,IAAI,EAAE,GAAG;gBACT,KAAK,EAAE,CAAC;gBACR,KAAK,EAAE,KAAK;aACb;YACD;gBACE,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE,cAAc;gBAC1B,gBAAgB,EAAE,GAAG;gBACrB,YAAY,EAAE,KAAK;gBACnB,iBAAiB,EAAE,QAAQ;gBAC3B,IAAI,EAAE,GAAG;gBACT,KAAK,EAAE,CAAC;gBACR,KAAK,EAAE,KAAK;aACb;SACF;KACF;IACD;QACE,IAAI,EAAE,+BAA+B;QACrC,UAAU,EAAE,UAAU,CAAC,MAAM;QAC7B,MAAM,EAAE,QAAQ;QAChB,UAAU,EAAE,eAAe;QAC3B,gBAAgB,EAAE,GAAG;QACrB,gBAAgB,EAAE,MAAM;QACxB,YAAY,EAAE,MAAM;QACpB,OAAO,EAAE,QAAQ;QACjB,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,CAAC;QACV,kBAAkB,EAAE,IAAI;QACxB,iBAAiB,EAAE,QAAQ;QAC3B,OAAO,EAAE,CAAC;QACV,IAAI,EAAE;YACJ;gBACE,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE,cAAc;gBAC1B,gBAAgB,EAAE,GAAG;gBACrB,YAAY,EAAE,KAAK;gBACnB,iBAAiB,EAAE,QAAQ;gBAC3B,IAAI,EAAE,GAAG;gBACT,KAAK,EAAE,CAAC;gBACR,KAAK,EAAE,MAAM;aACd;YACD;gBACE,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE,cAAc;gBAC1B,gBAAgB,EAAE,GAAG;gBACrB,YAAY,EAAE,KAAK;gBACnB,iBAAiB,EAAE,QAAQ;gBAC3B,IAAI,EAAE,GAAG;gBACT,KAAK,EAAE,CAAC;gBACR,KAAK,EAAE,IAAI;aACZ;SACF;KACF;CACF,CAAA;AAED,SAAS,OAAO,CAAE,UAAsB;IACtC,QAAQ,UAAU,EAAE,CAAC;QACnB,KAAK,UAAU,CAAC,MAAM,CAAC,CAAC,OAAO,QAAQ,CAAA;QACvC,KAAK,UAAU,CAAC,MAAM,CAAC,CAAC,OAAO,OAAO,CAAA;QACtC,KAAK,UAAU,CAAC,MAAM,CAAC,CAAC,OAAO,OAAO,CAAA;QACtC,KAAK,UAAU,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,CAAA;QAC7B,KAAK,UAAU,CAAC,IAAI,CAAC,CAAC,OAAO,KAAK,CAAA;QAClC,KAAK,UAAU,CAAC,MAAM,CAAC,CAAC,OAAO,OAAO,CAAA;QACtC,OAAO,CAAC,CAAC,OAAO,QAAQ,CAAA;IAC1B,CAAC;AACH,CAAC;AAED,MAAM,GAAG,GAA+B;IACtC,GAAG,QAAQ,EAAE,GAAG,OAAO,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,EAAE,GAAG,KAAK,EAAE,GAAG,OAAO;CACjE,CAAA;AAEY,QAAA,kBAAkB,GAAG;IAChC,QAAQ;IACR,OAAO;IACP,OAAO;IACP,EAAE;IACF,KAAK;IACL,OAAO;IACP,GAAG;IACH,OAAO;IAEP,MAAM,CAAE,IAAY;QAClB,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAA;QAChC,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAClB,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,KAAK;YAChC,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,KAAK;YACpC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,CAAA;IACnC,CAAC;IAED,MAAM,CAAE,GAAQ,EAAE,UAAuB;QACvC,OAAO,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;IACzD,CAAC;CACF,CAAA","sourcesContent":["import { Rng } from './rng'\n\n/**\n * A small book of instruments that read like instruments.\n *\n * The point is not coverage - it is that a generated message can be scanned by eye and\n * recognised.  `55=BRN` with `541=20251231` and `44=71.35` is a Brent future at a\n * plausible price; `55=Lorem` with `44=-4534.7` is noise that happens to encode.\n *\n * Prices carry a tick and a lot size so quantities and prices agree with the contract\n * they claim to be, and a spread carries its legs so a multileg message can be built\n * with parent and legs that actually correspond.\n */\n\nexport enum AssetClass {\n  Equity = 'equity',\n  Future = 'future',\n  Option = 'option',\n  Spread = 'spread',\n  Fx = 'fx',\n  Bond = 'bond'\n}\n\nexport interface ILegSpec {\n  readonly symbol: string\n  readonly securityId: string\n  readonly securityIdSource: string\n  readonly securityType: string\n  readonly maturityMonthYear?: string\n  readonly side: string\n  readonly ratio: number\n  readonly refPx: number\n}\n\nexport interface IInstrumentSpec {\n  readonly name: string\n  readonly assetClass: AssetClass\n  readonly symbol: string\n  readonly securityId: string\n  /** 1 CUSIP, 2 SEDOL, 4 ISIN, 8 exchange symbol, 9 CTA */\n  readonly securityIdSource: string\n  readonly securityExchange: string\n  readonly securityType: string\n  readonly cfiCode: string\n  readonly currency: string\n  readonly refPx: number\n  readonly tick: number\n  readonly lotSize: number\n  readonly contractMultiplier?: number\n  readonly maturityMonthYear?: string\n  readonly maturityDate?: string\n  readonly strikePrice?: number\n  readonly putOrCall?: number\n  readonly product?: number\n  readonly legs?: readonly ILegSpec[]\n}\n\nconst equities: readonly IInstrumentSpec[] = [\n  {\n    name: 'Apple Inc',\n    assetClass: AssetClass.Equity,\n    symbol: 'AAPL',\n    securityId: 'US0378331005',\n    securityIdSource: '4',\n    securityExchange: 'XNAS',\n    securityType: 'CS',\n    cfiCode: 'ESVUFR',\n    currency: 'USD',\n    refPx: 214.5,\n    tick: 0.01,\n    lotSize: 100,\n    product: 5\n  },\n  {\n    name: 'Vodafone Group',\n    assetClass: AssetClass.Equity,\n    symbol: 'VOD.L',\n    securityId: 'GB00BH4HKS39',\n    securityIdSource: '4',\n    securityExchange: 'XLON',\n    securityType: 'CS',\n    cfiCode: 'ESVUFR',\n    currency: 'GBP',\n    refPx: 0.762,\n    tick: 0.0001,\n    lotSize: 1000,\n    product: 5\n  },\n  {\n    name: 'SAP SE',\n    assetClass: AssetClass.Equity,\n    symbol: 'SAP',\n    securityId: 'DE0007164600',\n    securityIdSource: '4',\n    securityExchange: 'XETR',\n    securityType: 'CS',\n    cfiCode: 'ESVUFR',\n    currency: 'EUR',\n    refPx: 196.3,\n    tick: 0.01,\n    lotSize: 100,\n    product: 5\n  }\n]\n\nconst futures: readonly IInstrumentSpec[] = [\n  {\n    name: 'ICE Brent Crude Jan26',\n    assetClass: AssetClass.Future,\n    symbol: 'BRN',\n    securityId: 'BRN FMF0026!',\n    securityIdSource: '8',\n    securityExchange: 'IFEU',\n    securityType: 'FUT',\n    cfiCode: 'FCEPSX',\n    currency: 'USD',\n    refPx: 71.35,\n    tick: 0.01,\n    lotSize: 1,\n    contractMultiplier: 1000,\n    maturityMonthYear: '202601',\n    maturityDate: '20251130',\n    product: 2\n  },\n  {\n    name: 'ICE Low Sulphur Gasoil Feb26',\n    assetClass: AssetClass.Future,\n    symbol: 'GAS',\n    securityId: 'GAS FMG0026!',\n    securityIdSource: '8',\n    securityExchange: 'IFEU',\n    securityType: 'FUT',\n    cfiCode: 'FCEPSX',\n    currency: 'USD',\n    refPx: 668.25,\n    tick: 0.25,\n    lotSize: 1,\n    contractMultiplier: 100,\n    maturityMonthYear: '202602',\n    maturityDate: '20260112',\n    product: 2\n  },\n  {\n    name: 'CME E-mini S and P 500 Dec25',\n    assetClass: AssetClass.Future,\n    symbol: 'ES',\n    securityId: 'ESZ5',\n    securityIdSource: '8',\n    securityExchange: 'XCME',\n    securityType: 'FUT',\n    cfiCode: 'FFICSX',\n    currency: 'USD',\n    refPx: 6042.25,\n    tick: 0.25,\n    lotSize: 1,\n    contractMultiplier: 50,\n    maturityMonthYear: '202512',\n    maturityDate: '20251219',\n    product: 5\n  }\n]\n\nconst options: readonly IInstrumentSpec[] = [\n  {\n    name: 'CME E-mini Dec25 6000 Call',\n    assetClass: AssetClass.Option,\n    symbol: 'ES',\n    securityId: 'ESZ5 C6000',\n    securityIdSource: '8',\n    securityExchange: 'XCME',\n    securityType: 'OPT',\n    cfiCode: 'OCEFCS',\n    currency: 'USD',\n    refPx: 118.75,\n    tick: 0.25,\n    lotSize: 1,\n    contractMultiplier: 50,\n    maturityMonthYear: '202512',\n    maturityDate: '20251219',\n    strikePrice: 6000,\n    putOrCall: 1,\n    product: 5\n  }\n]\n\nconst fx: readonly IInstrumentSpec[] = [\n  {\n    name: 'EUR/USD spot',\n    assetClass: AssetClass.Fx,\n    symbol: 'EUR/USD',\n    securityId: 'EURUSD',\n    securityIdSource: '8',\n    securityExchange: 'XOFF',\n    securityType: 'FXSPOT',\n    cfiCode: 'MRCXXX',\n    currency: 'EUR',\n    refPx: 1.0842,\n    tick: 0.00005,\n    lotSize: 1000000,\n    product: 4\n  }\n]\n\nconst bonds: readonly IInstrumentSpec[] = [\n  {\n    name: 'US Treasury 4.25 Nov 2034',\n    assetClass: AssetClass.Bond,\n    symbol: 'T 4.25 11/34',\n    securityId: 'US91282CLW12',\n    securityIdSource: '4',\n    securityExchange: 'XOFF',\n    securityType: 'TBOND',\n    cfiCode: 'DBFUFR',\n    currency: 'USD',\n    refPx: 99.421875,\n    tick: 0.015625,\n    lotSize: 1000,\n    maturityDate: '20341115',\n    product: 6\n  }\n]\n\n/**\n * The shape the whole scattered component exercise is really about.  ICE publishes\n * calendar and crack spreads as single tradeable instruments whose fills report a parent\n * and one leg per contract, and a trade capture for one of these is where deep nesting\n * shows up in real life.\n */\nconst spreads: readonly IInstrumentSpec[] = [\n  {\n    name: 'ICE Brent Jan26/Feb26 calendar spread',\n    assetClass: AssetClass.Spread,\n    symbol: 'BRN',\n    securityId: 'BRN JAN26-FEB26',\n    securityIdSource: '8',\n    securityExchange: 'IFEU',\n    securityType: 'MLEG',\n    cfiCode: 'FMEPSX',\n    currency: 'USD',\n    refPx: 0.34,\n    tick: 0.01,\n    lotSize: 1,\n    contractMultiplier: 1000,\n    maturityMonthYear: '202601',\n    product: 2,\n    legs: [\n      {\n        symbol: 'BRN',\n        securityId: 'BRN FMF0026!',\n        securityIdSource: '8',\n        securityType: 'FUT',\n        maturityMonthYear: '202601',\n        side: '1',\n        ratio: 1,\n        refPx: 71.35\n      },\n      {\n        symbol: 'BRN',\n        securityId: 'BRN FMG0026!',\n        securityIdSource: '8',\n        securityType: 'FUT',\n        maturityMonthYear: '202602',\n        side: '2',\n        ratio: 1,\n        refPx: 71.01\n      }\n    ]\n  },\n  {\n    name: 'ICE Brent/Gasoil crack spread',\n    assetClass: AssetClass.Spread,\n    symbol: 'BRNGAS',\n    securityId: 'BRN-GAS CRACK',\n    securityIdSource: '8',\n    securityExchange: 'IFEU',\n    securityType: 'MLEG',\n    cfiCode: 'FMEPSX',\n    currency: 'USD',\n    refPx: 12.68,\n    tick: 0.01,\n    lotSize: 1,\n    contractMultiplier: 1000,\n    maturityMonthYear: '202602',\n    product: 2,\n    legs: [\n      {\n        symbol: 'GAS',\n        securityId: 'GAS FMG0026!',\n        securityIdSource: '8',\n        securityType: 'FUT',\n        maturityMonthYear: '202602',\n        side: '1',\n        ratio: 1,\n        refPx: 668.25\n      },\n      {\n        symbol: 'BRN',\n        securityId: 'BRN FMG0026!',\n        securityIdSource: '8',\n        securityType: 'FUT',\n        maturityMonthYear: '202602',\n        side: '2',\n        ratio: 1,\n        refPx: 71.2\n      }\n    ]\n  }\n]\n\nfunction byClass (assetClass: AssetClass): readonly IInstrumentSpec[] {\n  switch (assetClass) {\n    case AssetClass.Equity: return equities\n    case AssetClass.Future: return futures\n    case AssetClass.Option: return options\n    case AssetClass.Fx: return fx\n    case AssetClass.Bond: return bonds\n    case AssetClass.Spread: return spreads\n    default: return equities\n  }\n}\n\nconst all: readonly IInstrumentSpec[] = [\n  ...equities, ...futures, ...options, ...fx, ...bonds, ...spreads\n]\n\nexport const InstrumentUniverse = {\n  equities,\n  futures,\n  options,\n  fx,\n  bonds,\n  spreads,\n  all,\n  byClass,\n\n  byName (name: string): IInstrumentSpec | undefined {\n    const lower = name.toLowerCase()\n    return all.find(i =>\n      i.symbol.toLowerCase() === lower ||\n      i.securityId.toLowerCase() === lower ||\n      i.name.toLowerCase() === lower)\n  },\n\n  choose (rng: Rng, assetClass?: AssetClass): IInstrumentSpec {\n    return rng.pick(assetClass ? byClass(assetClass) : all)\n  }\n}\n"]}

package/dist/generator/layout.d.ts

@@ -0,0 +1,46 @@
+import { ILooseObject } from '../collections/collection';
+import { IContainedSet } from '../dictionary/contained';
+export interface IToken {
+    readonly tag: number;
+    readonly text: string;
+}
+export declare enum LayoutKind {
+    Message = "message",
+    Component = "component",
+    Group = "group",
+    Instance = "instance",
+    Field = "field"
+}
+export declare class LayoutNode {
+    readonly kind: LayoutKind;
+    readonly name: string;
+    readonly path: string;
+    readonly tokenIndex: number;
+    readonly set: IContainedSet | null;
+    readonly extraTokenIndex: number;
+    readonly children: LayoutNode[];
+    constructor(kind: LayoutKind, name: string, path: string, tokenIndex?: number, set?: IContainedSet | null, extraTokenIndex?: number);
+    canonical(into?: number[]): number[];
+    get isLevel(): boolean;
+}
+export declare function tokenise(wire: string, delimiter: string): IToken[];
+export declare function assemble(tokens: readonly IToken[], order: readonly number[], delimiter: string): string;
+export interface ILayout {
+    readonly root: LayoutNode;
+    readonly tokens: readonly IToken[];
+    readonly bodyStart: number;
+    readonly bodyEnd: number;
+}
+export declare class Layout {
+    private index;
+    private constructor();
+    static build(wire: string, delimiter: string, object: ILooseObject, set: IContainedSet): ILayout;
+    private static expectedTags;
+    private static locate;
+    private static presentFields;
+    private static instancesOf;
+    private static lengthField;
+    private static lengthName;
+    private static lengthTag;
+    private walk;
+}

package/dist/generator/layout.js

@@ -0,0 +1,208 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Layout = exports.LayoutNode = exports.LayoutKind = void 0;
+exports.tokenise = tokenise;
+exports.assemble = assemble;
+const contained_1 = require("../dictionary/contained");
+const tag_type_1 = require("../buffer/tag/tag-type");
+var LayoutKind;
+(function (LayoutKind) {
+    LayoutKind["Message"] = "message";
+    LayoutKind["Component"] = "component";
+    LayoutKind["Group"] = "group";
+    LayoutKind["Instance"] = "instance";
+    LayoutKind["Field"] = "field";
+})(LayoutKind || (exports.LayoutKind = LayoutKind = {}));
+class LayoutNode {
+    constructor(kind, name, path, tokenIndex = -1, set = null, extraTokenIndex = -1) {
+        this.kind = kind;
+        this.name = name;
+        this.path = path;
+        this.tokenIndex = tokenIndex;
+        this.set = set;
+        this.extraTokenIndex = extraTokenIndex;
+        this.children = [];
+    }
+    canonical(into = []) {
+        if (this.tokenIndex >= 0)
+            into.push(this.tokenIndex);
+        if (this.extraTokenIndex >= 0)
+            into.push(this.extraTokenIndex);
+        for (const c of this.children) {
+            c.canonical(into);
+        }
+        return into;
+    }
+    get isLevel() {
+        return this.kind === LayoutKind.Message || this.kind === LayoutKind.Instance;
+    }
+}
+exports.LayoutNode = LayoutNode;
+function tokenise(wire, delimiter) {
+    const parts = wire.split(delimiter);
+    const tokens = [];
+    for (const p of parts) {
+        if (p.length === 0)
+            continue;
+        const eq = p.indexOf('=');
+        if (eq <= 0)
+            continue;
+        tokens.push({ tag: parseInt(p.substring(0, eq), 10), text: p });
+    }
+    return tokens;
+}
+function assemble(tokens, order, delimiter) {
+    let out = '';
+    for (const i of order) {
+        out += tokens[i].text;
+        out += delimiter;
+    }
+    return out;
+}
+class Layout {
+    constructor(start) {
+        this.index = 0;
+        this.index = start;
+    }
+    static build(wire, delimiter, object, set) {
+        const tokens = tokenise(wire, delimiter);
+        const expected = Layout.expectedTags(object, set);
+        const bodyStart = Layout.locate(tokens, expected);
+        const builder = new Layout(bodyStart);
+        const root = new LayoutNode(LayoutKind.Message, set.name, set.name, -1, set);
+        builder.walk(object, set, root, set.name);
+        return {
+            root,
+            tokens,
+            bodyStart,
+            bodyEnd: builder.index
+        };
+    }
+    static expectedTags(object, set) {
+        const out = [];
+        const collect = (o, s) => {
+            for (const field of Layout.presentFields(o, s)) {
+                switch (field.type) {
+                    case contained_1.ContainedFieldType.Simple: {
+                        const sf = field;
+                        if (sf.definition.tagType === tag_type_1.TagType.RawData && o[Layout.lengthName(s, sf)] == null) {
+                            out.push(Layout.lengthTag(s, sf));
+                        }
+                        out.push(sf.definition.tag);
+                        break;
+                    }
+                    case contained_1.ContainedFieldType.Component: {
+                        const cf = field;
+                        collect(o[cf.name], cf.definition);
+                        break;
+                    }
+                    case contained_1.ContainedFieldType.Group: {
+                        const gf = field;
+                        const nof = gf.definition.noOfField;
+                        if (!nof)
+                            break;
+                        out.push(nof.tag);
+                        const instances = Layout.instancesOf(o, gf);
+                        for (const instance of instances) {
+                            collect(instance, gf.definition);
+                        }
+                        break;
+                    }
+                    default:
+                        break;
+                }
+            }
+        };
+        collect(object, set);
+        return out;
+    }
+    static locate(tokens, expected) {
+        if (expected.length === 0)
+            return 0;
+        for (let start = 0; start + expected.length <= tokens.length; ++start) {
+            let ok = true;
+            for (let i = 0; i < expected.length; ++i) {
+                if (tokens[start + i].tag !== expected[i]) {
+                    ok = false;
+                    break;
+                }
+            }
+            if (ok)
+                return start;
+        }
+        throw new Error('layout walk does not match the encoded message - the mirror of AsciiEncoder has drifted');
+    }
+    static presentFields(o, set) {
+        const fields = [];
+        for (const key of Object.keys(o)) {
+            const field = set.localNameToField.get(key);
+            if (field)
+                fields.push(field);
+        }
+        fields.sort((a, b) => a.position - b.position);
+        return fields;
+    }
+    static instancesOf(o, gf) {
+        var _a;
+        const nof = gf.definition.noOfField;
+        const instances = (_a = o[gf.name]) !== null && _a !== void 0 ? _a : (nof ? o[nof.name] : null);
+        return Array.isArray(instances) ? instances : [];
+    }
+    static lengthField(set, sf) {
+        const prior = set.fields[sf.position - 1];
+        if (!prior || prior.type !== contained_1.ContainedFieldType.Simple)
+            return null;
+        return prior;
+    }
+    static lengthName(set, sf) {
+        var _a, _b;
+        return (_b = (_a = Layout.lengthField(set, sf)) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : '';
+    }
+    static lengthTag(set, sf) {
+        var _a, _b;
+        return (_b = (_a = Layout.lengthField(set, sf)) === null || _a === void 0 ? void 0 : _a.definition.tag) !== null && _b !== void 0 ? _b : 0;
+    }
+    walk(o, set, parent, path) {
+        for (const field of Layout.presentFields(o, set)) {
+            switch (field.type) {
+                case contained_1.ContainedFieldType.Simple: {
+                    const sf = field;
+                    let lengthIndex = -1;
+                    if (sf.definition.tagType === tag_type_1.TagType.RawData && o[Layout.lengthName(set, sf)] == null) {
+                        lengthIndex = this.index++;
+                    }
+                    const dataIndex = this.index++;
+                    parent.children.push(new LayoutNode(LayoutKind.Field, sf.name, `${path}.${sf.name}`, lengthIndex >= 0 ? lengthIndex : dataIndex, null, lengthIndex >= 0 ? dataIndex : -1));
+                    break;
+                }
+                case contained_1.ContainedFieldType.Component: {
+                    const cf = field;
+                    const node = new LayoutNode(LayoutKind.Component, cf.name, `${path}.${cf.name}`, -1, cf.definition);
+                    parent.children.push(node);
+                    this.walk(o[cf.name], cf.definition, node, node.path);
+                    break;
+                }
+                case contained_1.ContainedFieldType.Group: {
+                    const gf = field;
+                    const nof = gf.definition.noOfField;
+                    if (!nof)
+                        break;
+                    const countIndex = this.index++;
+                    const node = new LayoutNode(LayoutKind.Group, gf.name, `${path}.${gf.name}`, countIndex, gf.definition);
+                    parent.children.push(node);
+                    const instances = Layout.instancesOf(o, gf);
+                    for (let i = 0; i < instances.length; ++i) {
+                        const instance = new LayoutNode(LayoutKind.Instance, `${gf.name}[${i}]`, `${node.path}[${i}]`, -1, gf.definition);
+                        node.children.push(instance);
+                        this.walk(instances[i], gf.definition, instance, instance.path);
+                    }
+                    break;
+                }
+                default:
+                    break;
+            }
+        }
+    }
+}
+exports.Layout = Layout;
+//# sourceMappingURL=layout.js.map

package/dist/generator/layout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"layout.js","sourceRoot":"","sources":["../../src/generator/layout.ts"],"names":[],"mappings":";;;AAwEA,4BAUC;AAED,4BAOC;AA1FD,uDAOgC;AAChC,qDAAgD;AAsBhD,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,iCAAmB,CAAA;IACnB,qCAAuB,CAAA;IACvB,6BAAe,CAAA;IACf,mCAAqB,CAAA;IACrB,6BAAe,CAAA;AACjB,CAAC,EANW,UAAU,0BAAV,UAAU,QAMrB;AAED,MAAa,UAAU;IAGrB,YACkB,IAAgB,EAChB,IAAY,EACZ,IAAY,EAEZ,aAAqB,CAAC,CAAC,EACvB,MAA4B,IAAI,EAEhC,kBAA0B,CAAC,CAAC;QAP5B,SAAI,GAAJ,IAAI,CAAY;QAChB,SAAI,GAAJ,IAAI,CAAQ;QACZ,SAAI,GAAJ,IAAI,CAAQ;QAEZ,eAAU,GAAV,UAAU,CAAa;QACvB,QAAG,GAAH,GAAG,CAA6B;QAEhC,oBAAe,GAAf,eAAe,CAAa;QAV9B,aAAQ,GAAiB,EAAE,CAAA;IAW3C,CAAC;IAGM,SAAS,CAAE,OAAiB,EAAE;QACnC,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC;YAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QACpD,IAAI,IAAI,CAAC,eAAe,IAAI,CAAC;YAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;QAC9D,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC9B,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QACnB,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,QAAQ,CAAA;IAC9E,CAAC;CACF;AA3BD,gCA2BC;AAMD,SAAgB,QAAQ,CAAE,IAAY,EAAE,SAAiB;IACvD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;IACnC,MAAM,MAAM,GAAa,EAAE,CAAA;IAC3B,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;QACtB,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC;YAAE,SAAQ;QAC5B,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QACzB,IAAI,EAAE,IAAI,CAAC;YAAE,SAAQ;QACrB,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAA;IACjE,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED,SAAgB,QAAQ,CAAE,MAAyB,EAAE,KAAwB,EAAE,SAAiB;IAC9F,IAAI,GAAG,GAAG,EAAE,CAAA;IACZ,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;QACtB,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QACrB,GAAG,IAAI,SAAS,CAAA;IAClB,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC;AAWD,MAAa,MAAM;IAGjB,YAAqB,KAAa;QAF1B,UAAK,GAAW,CAAC,CAAA;QAGvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;IASM,MAAM,CAAC,KAAK,CACjB,IAAY,EACZ,SAAiB,EACjB,MAAoB,EACpB,GAAkB;QAClB,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,CAAA;QACxC,MAAM,QAAQ,GAAG,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QACjD,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;QACjD,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,SAAS,CAAC,CAAA;QACrC,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;QAC5E,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAA;QACzC,OAAO;YACL,IAAI;YACJ,MAAM;YACN,SAAS;YACT,OAAO,EAAE,OAAO,CAAC,KAAK;SACvB,CAAA;IACH,CAAC;IAMO,MAAM,CAAC,YAAY,CAAE,MAAoB,EAAE,GAAkB;QACnE,MAAM,GAAG,GAAa,EAAE,CAAA;QACxB,MAAM,OAAO,GAAG,CAAC,CAAe,EAAE,CAAgB,EAAQ,EAAE;YAC1D,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;gBAC/C,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;oBACnB,KAAK,8BAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;wBAC/B,MAAM,EAAE,GAAG,KAA6B,CAAA;wBACxC,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,KAAK,kBAAO,CAAC,OAAO,IAAI,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;4BACrF,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;wBACnC,CAAC;wBACD,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;wBAC3B,MAAK;oBACP,CAAC;oBACD,KAAK,8BAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;wBAClC,MAAM,EAAE,GAAG,KAAgC,CAAA;wBAC3C,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAiB,EAAE,EAAE,CAAC,UAAU,CAAC,CAAA;wBAClD,MAAK;oBACP,CAAC;oBACD,KAAK,8BAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;wBAC9B,MAAM,EAAE,GAAG,KAA4B,CAAA;wBACvC,MAAM,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,SAAS,CAAA;wBACnC,IAAI,CAAC,GAAG;4BAAE,MAAK;wBACf,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;wBACjB,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;wBAC3C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;4BACjC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,UAAU,CAAC,CAAA;wBAClC,CAAC;wBACD,MAAK;oBACP,CAAC;oBACD;wBACE,MAAK;gBACT,CAAC;YACH,CAAC;QACH,CAAC,CAAA;QACD,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QACpB,OAAO,GAAG,CAAA;IACZ,CAAC;IAEO,MAAM,CAAC,MAAM,CAAE,MAAyB,EAAE,QAA2B;QAC3E,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,CAAC,CAAA;QACnC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC;YACtE,IAAI,EAAE,GAAG,IAAI,CAAA;YACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;gBACzC,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC1C,EAAE,GAAG,KAAK,CAAA;oBACV,MAAK;gBACP,CAAC;YACH,CAAC;YACD,IAAI,EAAE;gBAAE,OAAO,KAAK,CAAA;QACtB,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,yFAAyF,CAAC,CAAA;IAC5G,CAAC;IAOO,MAAM,CAAC,aAAa,CAAE,CAAe,EAAE,GAAkB;QAC/D,MAAM,MAAM,GAAqB,EAAE,CAAA;QACnC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YACjC,MAAM,KAAK,GAAG,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAC3C,IAAI,KAAK;gBAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAA;QAC9C,OAAO,MAAM,CAAA;IACf,CAAC;IAEO,MAAM,CAAC,WAAW,CAAE,CAAe,EAAE,EAAuB;;QAClE,MAAM,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,SAAS,CAAA;QACnC,MAAM,SAAS,GAAG,MAAA,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,mCAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;QAC1D,OAAO,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAA;IAClD,CAAC;IAEO,MAAM,CAAC,WAAW,CAAE,GAAkB,EAAE,EAAwB;QACtE,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAA;QACzC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,8BAAkB,CAAC,MAAM;YAAE,OAAO,IAAI,CAAA;QACnE,OAAO,KAA6B,CAAA;IACtC,CAAC;IAEO,MAAM,CAAC,UAAU,CAAE,GAAkB,EAAE,EAAwB;;QACrE,OAAO,MAAA,MAAA,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,CAAC,0CAAE,IAAI,mCAAI,EAAE,CAAA;IAChD,CAAC;IAEO,MAAM,CAAC,SAAS,CAAE,GAAkB,EAAE,EAAwB;;QACpE,OAAO,MAAA,MAAA,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,CAAC,0CAAE,UAAU,CAAC,GAAG,mCAAI,CAAC,CAAA;IACzD,CAAC;IAEO,IAAI,CAAE,CAAe,EAAE,GAAkB,EAAE,MAAkB,EAAE,IAAY;QACjF,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;YACjD,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;gBACnB,KAAK,8BAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;oBAC/B,MAAM,EAAE,GAAG,KAA6B,CAAA;oBACxC,IAAI,WAAW,GAAG,CAAC,CAAC,CAAA;oBACpB,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,KAAK,kBAAO,CAAC,OAAO,IAAI,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;wBACvF,WAAW,GAAG,IAAI,CAAC,KAAK,EAAE,CAAA;oBAC5B,CAAC;oBACD,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,EAAE,CAAA;oBAG9B,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,UAAU,CACjC,UAAU,CAAC,KAAK,EAChB,EAAE,CAAC,IAAI,EACP,GAAG,IAAI,IAAI,EAAE,CAAC,IAAI,EAAE,EACpB,WAAW,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,EAC1C,IAAI,EACJ,WAAW,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;oBACrC,MAAK;gBACP,CAAC;gBACD,KAAK,8BAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;oBAClC,MAAM,EAAE,GAAG,KAAgC,CAAA;oBAC3C,MAAM,IAAI,GAAG,IAAI,UAAU,CACzB,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAA;oBACzE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;oBAC1B,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAiB,EAAE,EAAE,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;oBACrE,MAAK;gBACP,CAAC;gBACD,KAAK,8BAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;oBAC9B,MAAM,EAAE,GAAG,KAA4B,CAAA;oBACvC,MAAM,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,SAAS,CAAA;oBACnC,IAAI,CAAC,GAAG;wBAAE,MAAK;oBACf,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,EAAE,CAAA;oBAC/B,MAAM,IAAI,GAAG,IAAI,UAAU,CACzB,UAAU,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,CAAA;oBAC7E,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;oBAC1B,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;oBAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;wBAC1C,MAAM,QAAQ,GAAG,IAAI,UAAU,CAC7B,UAAU,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAA;wBACnF,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;wBAC5B,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAA;oBACjE,CAAC;oBACD,MAAK;gBACP,CAAC;gBACD;oBACE,MAAK;YACT,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAhLD,wBAgLC","sourcesContent":["import { ILooseObject } from '../collections/collection'\nimport {\n  ContainedComponentField,\n  ContainedField,\n  ContainedFieldType,\n  ContainedGroupField,\n  ContainedSimpleField,\n  IContainedSet\n} from '../dictionary/contained'\nimport { TagType } from '../buffer/tag/tag-type'\n\n/**\n * Where every tag on the wire came from in the dictionary.\n *\n * The parser answers this question from position, which is exactly the assumption the\n * scattered component work is about, so it cannot be the source of truth here.  Instead\n * the layout is built by walking the object and the dictionary in lock step with\n * `AsciiEncoder.encodeObject` - same field ordering, same treatment of components,\n * groups and raw data - and consuming one token per emission.  The walk is not a parse:\n * it knows what the encoder was about to write before it wrote it.\n *\n * If the two ever disagree the token stream will not line up and `Layout.build` throws,\n * which makes this a standing check that the mirror is still faithful.\n */\n\nexport interface IToken {\n  readonly tag: number\n  /** the `tag=value` text exactly as encoded, without the delimiter */\n  readonly text: string\n}\n\nexport enum LayoutKind {\n  Message = 'message',\n  Component = 'component',\n  Group = 'group',\n  Instance = 'instance',\n  Field = 'field'\n}\n\nexport class LayoutNode {\n  public readonly children: LayoutNode[] = []\n\n  constructor (\n    public readonly kind: LayoutKind,\n    public readonly name: string,\n    public readonly path: string,\n    /** for a field, its token; for a group, the token carrying NoXXX */\n    public readonly tokenIndex: number = -1,\n    public readonly set: IContainedSet | null = null,\n    /** a raw data field is written as a Length token and then the data token */\n    public readonly extraTokenIndex: number = -1) {\n  }\n\n  /** token indices below this node, in the order the encoder wrote them */\n  public canonical (into: number[] = []): number[] {\n    if (this.tokenIndex >= 0) into.push(this.tokenIndex)\n    if (this.extraTokenIndex >= 0) into.push(this.extraTokenIndex)\n    for (const c of this.children) {\n      c.canonical(into)\n    }\n    return into\n  }\n\n  public get isLevel (): boolean {\n    return this.kind === LayoutKind.Message || this.kind === LayoutKind.Instance\n  }\n}\n\n/**\n * split a wire message into tokens.  Values containing the delimiter would defeat this,\n * which is why the generator never produces one.\n */\nexport function tokenise (wire: string, delimiter: string): IToken[] {\n  const parts = wire.split(delimiter)\n  const tokens: IToken[] = []\n  for (const p of parts) {\n    if (p.length === 0) continue\n    const eq = p.indexOf('=')\n    if (eq <= 0) continue\n    tokens.push({ tag: parseInt(p.substring(0, eq), 10), text: p })\n  }\n  return tokens\n}\n\nexport function assemble (tokens: readonly IToken[], order: readonly number[], delimiter: string): string {\n  let out = ''\n  for (const i of order) {\n    out += tokens[i].text\n    out += delimiter\n  }\n  return out\n}\n\nexport interface ILayout {\n  readonly root: LayoutNode\n  readonly tokens: readonly IToken[]\n  /** index of the first body token; everything before it is the standard header */\n  readonly bodyStart: number\n  /** index one past the last body token; everything from here is the trailer */\n  readonly bodyEnd: number\n}\n\nexport class Layout {\n  private index: number = 0\n\n  private constructor (start: number) {\n    this.index = start\n  }\n\n  /**\n   * Build the layout of `object` encoded as `wire`.\n   *\n   * The header and trailer are written by the transmitter rather than from the object,\n   * so their extent is discovered rather than walked: the body is located by matching\n   * the tag sequence the walk predicts against the token stream.\n   */\n  public static build (\n    wire: string,\n    delimiter: string,\n    object: ILooseObject,\n    set: IContainedSet): ILayout {\n    const tokens = tokenise(wire, delimiter)\n    const expected = Layout.expectedTags(object, set)\n    const bodyStart = Layout.locate(tokens, expected)\n    const builder = new Layout(bodyStart)\n    const root = new LayoutNode(LayoutKind.Message, set.name, set.name, -1, set)\n    builder.walk(object, set, root, set.name)\n    return {\n      root,\n      tokens,\n      bodyStart,\n      bodyEnd: builder.index\n    }\n  }\n\n  /**\n   * the tag sequence the encoder will write for this object, used only to find where\n   * the body begins\n   */\n  private static expectedTags (object: ILooseObject, set: IContainedSet): number[] {\n    const out: number[] = []\n    const collect = (o: ILooseObject, s: IContainedSet): void => {\n      for (const field of Layout.presentFields(o, s)) {\n        switch (field.type) {\n          case ContainedFieldType.Simple: {\n            const sf = field as ContainedSimpleField\n            if (sf.definition.tagType === TagType.RawData && o[Layout.lengthName(s, sf)] == null) {\n              out.push(Layout.lengthTag(s, sf))\n            }\n            out.push(sf.definition.tag)\n            break\n          }\n          case ContainedFieldType.Component: {\n            const cf = field as ContainedComponentField\n            collect(o[cf.name] as ILooseObject, cf.definition)\n            break\n          }\n          case ContainedFieldType.Group: {\n            const gf = field as ContainedGroupField\n            const nof = gf.definition.noOfField\n            if (!nof) break\n            out.push(nof.tag)\n            const instances = Layout.instancesOf(o, gf)\n            for (const instance of instances) {\n              collect(instance, gf.definition)\n            }\n            break\n          }\n          default:\n            break\n        }\n      }\n    }\n    collect(object, set)\n    return out\n  }\n\n  private static locate (tokens: readonly IToken[], expected: readonly number[]): number {\n    if (expected.length === 0) return 0\n    for (let start = 0; start + expected.length <= tokens.length; ++start) {\n      let ok = true\n      for (let i = 0; i < expected.length; ++i) {\n        if (tokens[start + i].tag !== expected[i]) {\n          ok = false\n          break\n        }\n      }\n      if (ok) return start\n    }\n    throw new Error('layout walk does not match the encoded message - the mirror of AsciiEncoder has drifted')\n  }\n\n  /**\n   * the fields of `set` that `o` actually carries, in the order the encoder writes them.\n   * This is `AsciiEncoder.getFields`, deliberately duplicated rather than shared, because\n   * the encoder is a hot path and should not grow a seam for a test tool.\n   */\n  private static presentFields (o: ILooseObject, set: IContainedSet): ContainedField[] {\n    const fields: ContainedField[] = []\n    for (const key of Object.keys(o)) {\n      const field = set.localNameToField.get(key)\n      if (field) fields.push(field)\n    }\n    fields.sort((a, b) => a.position - b.position)\n    return fields\n  }\n\n  private static instancesOf (o: ILooseObject, gf: ContainedGroupField): ILooseObject[] {\n    const nof = gf.definition.noOfField\n    const instances = o[gf.name] ?? (nof ? o[nof.name] : null)\n    return Array.isArray(instances) ? instances : []\n  }\n\n  private static lengthField (set: IContainedSet, sf: ContainedSimpleField): ContainedSimpleField | null {\n    const prior = set.fields[sf.position - 1]\n    if (!prior || prior.type !== ContainedFieldType.Simple) return null\n    return prior as ContainedSimpleField\n  }\n\n  private static lengthName (set: IContainedSet, sf: ContainedSimpleField): string {\n    return Layout.lengthField(set, sf)?.name ?? ''\n  }\n\n  private static lengthTag (set: IContainedSet, sf: ContainedSimpleField): number {\n    return Layout.lengthField(set, sf)?.definition.tag ?? 0\n  }\n\n  private walk (o: ILooseObject, set: IContainedSet, parent: LayoutNode, path: string): void {\n    for (const field of Layout.presentFields(o, set)) {\n      switch (field.type) {\n        case ContainedFieldType.Simple: {\n          const sf = field as ContainedSimpleField\n          let lengthIndex = -1\n          if (sf.definition.tagType === TagType.RawData && o[Layout.lengthName(set, sf)] == null) {\n            lengthIndex = this.index++\n          }\n          const dataIndex = this.index++\n          // the length and its data are one indivisible unit - separating them would\n          // produce a message that is not merely scattered but unparseable\n          parent.children.push(new LayoutNode(\n            LayoutKind.Field,\n            sf.name,\n            `${path}.${sf.name}`,\n            lengthIndex >= 0 ? lengthIndex : dataIndex,\n            null,\n            lengthIndex >= 0 ? dataIndex : -1))\n          break\n        }\n        case ContainedFieldType.Component: {\n          const cf = field as ContainedComponentField\n          const node = new LayoutNode(\n            LayoutKind.Component, cf.name, `${path}.${cf.name}`, -1, cf.definition)\n          parent.children.push(node)\n          this.walk(o[cf.name] as ILooseObject, cf.definition, node, node.path)\n          break\n        }\n        case ContainedFieldType.Group: {\n          const gf = field as ContainedGroupField\n          const nof = gf.definition.noOfField\n          if (!nof) break\n          const countIndex = this.index++\n          const node = new LayoutNode(\n            LayoutKind.Group, gf.name, `${path}.${gf.name}`, countIndex, gf.definition)\n          parent.children.push(node)\n          const instances = Layout.instancesOf(o, gf)\n          for (let i = 0; i < instances.length; ++i) {\n            const instance = new LayoutNode(\n              LayoutKind.Instance, `${gf.name}[${i}]`, `${node.path}[${i}]`, -1, gf.definition)\n            node.children.push(instance)\n            this.walk(instances[i], gf.definition, instance, instance.path)\n          }\n          break\n        }\n        default:\n          break\n      }\n    }\n  }\n}\n"]}