jspurefix 5.11.3 → 5.11.4

package/.gitattributes

@@ -2,3 +2,7 @@
 # letting eol normalisation rewrite them on checkout.
 *.crt -text
 *.key -text
+
+# scattered component corpus - the whole point of an entry is that its bytes do not
+# change, so keep them identical on every platform.
+data/corpus/**/*.txt -text

package/dist/buffer/index.d.ts

@@ -9,3 +9,9 @@ export * from './segment/segment-summary';
 export * from './structure';
 export * from './tag/tag-pos';
 export * from './tag/tags';
+export * from './segment/segment-view';
+export * from './segment/segment-type';
+export * from './tag/tag-type';
+export * from './ascii/ascii-parser';
+export * from './ascii/ascii-parser-state';
+export * from './ascii/parse-state';

package/dist/buffer/index.js

@@ -25,4 +25,10 @@ __exportStar(require("./segment/segment-summary"), exports);
 __exportStar(require("./structure"), exports);
 __exportStar(require("./tag/tag-pos"), exports);
 __exportStar(require("./tag/tags"), exports);
+__exportStar(require("./segment/segment-view"), exports);
+__exportStar(require("./segment/segment-type"), exports);
+__exportStar(require("./tag/tag-type"), exports);
+__exportStar(require("./ascii/ascii-parser"), exports);
+__exportStar(require("./ascii/ascii-parser-state"), exports);
+__exportStar(require("./ascii/parse-state"), exports);
 //# sourceMappingURL=index.js.map

package/dist/buffer/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/buffer/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAgC;AAChC,iDAA8B;AAC9B,kDAA+B;AAC/B,gDAA6B;AAC7B,+CAA4B;AAC5B,6CAA0B;AAC1B,gEAA6C;AAC7C,4DAAyC;AACzC,8CAA2B;AAC3B,gDAA6B;AAC7B,6CAA0B","sourcesContent":["export * from './elastic-buffer'\nexport * from './encode-proxy'\nexport * from './encoder-state'\nexport * from './msg-encoder'\nexport * from './msg-parser'\nexport * from './msg-view'\nexport * from './segment/segment-description'\nexport * from './segment/segment-summary'\nexport * from './structure'\nexport * from './tag/tag-pos'\nexport * from './tag/tags'\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/buffer/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAgC;AAChC,iDAA8B;AAC9B,kDAA+B;AAC/B,gDAA6B;AAC7B,+CAA4B;AAC5B,6CAA0B;AAC1B,gEAA6C;AAC7C,4DAAyC;AACzC,8CAA2B;AAC3B,gDAA6B;AAC7B,6CAA0B;AAC1B,yDAAsC;AACtC,yDAAsC;AACtC,iDAA8B;AAC9B,uDAAoC;AACpC,6DAA0C;AAC1C,sDAAmC","sourcesContent":["export * from './elastic-buffer'\nexport * from './encode-proxy'\nexport * from './encoder-state'\nexport * from './msg-encoder'\nexport * from './msg-parser'\nexport * from './msg-view'\nexport * from './segment/segment-description'\nexport * from './segment/segment-summary'\nexport * from './structure'\nexport * from './tag/tag-pos'\nexport * from './tag/tags'\nexport * from './segment/segment-view'\nexport * from './segment/segment-type'\nexport * from './tag/tag-type'\nexport * from './ascii/ascii-parser'\nexport * from './ascii/ascii-parser-state'\nexport * from './ascii/parse-state'\n"]}

package/dist/collections/index.d.ts

@@ -0,0 +1 @@
+export * from './collection';

package/dist/collections/index.js

@@ -1,2 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./collection"), exports);
 //# sourceMappingURL=index.js.map

package/dist/collections/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/collections/index.ts"],"names":[],"mappings":"","sourcesContent":["\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/collections/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA4B","sourcesContent":["export * from './collection'\n"]}

package/dist/dictionary/contained/index.d.ts

@@ -9,3 +9,6 @@ export * from './contained-group-field';
 export * from './contained-simple-field';
 export * from './fields-dispatch';
 export * from './contained-set-builder';
+export * from './contained-field-set';
+export * from './contained-field-dispatcher';
+export * from './field-dispatcher';

package/dist/dictionary/contained/index.js

@@ -25,4 +25,7 @@ __exportStar(require("./contained-group-field"), exports);
 __exportStar(require("./contained-simple-field"), exports);
 __exportStar(require("./fields-dispatch"), exports);
 __exportStar(require("./contained-set-builder"), exports);
+__exportStar(require("./contained-field-set"), exports);
+__exportStar(require("./contained-field-dispatcher"), exports);
+__exportStar(require("./field-dispatcher"), exports);
 //# sourceMappingURL=index.js.map

package/dist/dictionary/contained/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/dictionary/contained/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8DAA2C;AAC3C,yDAAsC;AACtC,oDAAiC;AACjC,6DAA0C;AAC1C,oDAAiC;AACjC,kDAA+B;AAC/B,0DAAuC;AACvC,0DAAuC;AACvC,2DAAwC;AACxC,oDAAiC;AACjC,0DAAuC","sourcesContent":["export * from './contained-component-field'\nexport * from './contained-field-type'\nexport * from './contained-field'\nexport * from './contained-field-dispatch'\nexport * from './fields-dispatch'\nexport * from './contained-set'\nexport * from './contained-set-builder'\nexport * from './contained-group-field'\nexport * from './contained-simple-field'\nexport * from './fields-dispatch'\nexport * from './contained-set-builder'\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/dictionary/contained/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8DAA2C;AAC3C,yDAAsC;AACtC,oDAAiC;AACjC,6DAA0C;AAC1C,oDAAiC;AACjC,kDAA+B;AAC/B,0DAAuC;AACvC,0DAAuC;AACvC,2DAAwC;AACxC,oDAAiC;AACjC,0DAAuC;AACvC,wDAAqC;AACrC,+DAA4C;AAC5C,qDAAkC","sourcesContent":["export * from './contained-component-field'\nexport * from './contained-field-type'\nexport * from './contained-field'\nexport * from './contained-field-dispatch'\nexport * from './fields-dispatch'\nexport * from './contained-set'\nexport * from './contained-set-builder'\nexport * from './contained-group-field'\nexport * from './contained-simple-field'\nexport * from './fields-dispatch'\nexport * from './contained-set-builder'\nexport * from './contained-field-set'\nexport * from './contained-field-dispatcher'\nexport * from './field-dispatcher'\n"]}

package/dist/dictionary/index.d.ts

@@ -5,3 +5,8 @@ export * from './fix-parser';
 export * from './fix-versions';
 export * from './fragment-safety';
 export * from './set-reduce';
+export * from './definition';
+export * from './contained';
+export * from './type-dispatcher';
+export * from './contained-set-type';
+export * from './fix-definition-source';

package/dist/dictionary/index.js

@@ -21,4 +21,9 @@ __exportStar(require("./fix-parser"), exports);
 __exportStar(require("./fix-versions"), exports);
 __exportStar(require("./fragment-safety"), exports);
 __exportStar(require("./set-reduce"), exports);
+__exportStar(require("./definition"), exports);
+__exportStar(require("./contained"), exports);
+__exportStar(require("./type-dispatcher"), exports);
+__exportStar(require("./contained-set-type"), exports);
+__exportStar(require("./fix-definition-source"), exports);
 //# sourceMappingURL=index.js.map

package/dist/dictionary/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/dictionary/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAgC;AAChC,+CAA4B;AAC5B,8DAA2C;AAC3C,+CAA4B;AAC5B,iDAA8B;AAC9B,oDAAiC;AACjC,+CAA4B","sourcesContent":["export * from './dict-primitive'\nexport * from './field-enum'\nexport * from './contained/fields-dispatch'\nexport * from './fix-parser'\nexport * from './fix-versions'\nexport * from './fragment-safety'\nexport * from './set-reduce'\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/dictionary/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAgC;AAChC,+CAA4B;AAC5B,8DAA2C;AAC3C,+CAA4B;AAC5B,iDAA8B;AAC9B,oDAAiC;AACjC,+CAA4B;AAC5B,+CAA4B;AAC5B,8CAA2B;AAC3B,oDAAiC;AACjC,uDAAoC;AACpC,0DAAuC","sourcesContent":["export * from './dict-primitive'\nexport * from './field-enum'\nexport * from './contained/fields-dispatch'\nexport * from './fix-parser'\nexport * from './fix-versions'\nexport * from './fragment-safety'\nexport * from './set-reduce'\nexport * from './definition'\nexport * from './contained'\nexport * from './type-dispatcher'\nexport * from './contained-set-type'\nexport * from './fix-definition-source'\n"]}

package/dist/generator/applicability.d.ts

@@ -0,0 +1,3 @@
+import { AssetClass } from './instrument-universe';
+export declare function fieldApplies(name: string, assetClass: AssetClass): boolean;
+export declare function setApplies(name: string, assetClass: AssetClass): boolean;

package/dist/generator/applicability.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fieldApplies = fieldApplies;
+exports.setApplies = setApplies;
+const instrument_universe_1 = require("./instrument-universe");
+const bond = [instrument_universe_1.AssetClass.Bond];
+const option = [instrument_universe_1.AssetClass.Option];
+const listed = [instrument_universe_1.AssetClass.Future, instrument_universe_1.AssetClass.Option, instrument_universe_1.AssetClass.Spread];
+const multileg = [instrument_universe_1.AssetClass.Spread];
+const fieldRestrictions = [
+    {
+        test: /Coupon|Repurchase|RepoCollateral|Redemption|CreditRating|Issuer|IssueDate|DatedDate|InterestAccrual|AccruedInterest|NumDaysInterest|Factor$|Pool$|InstrRegistry|CountryOfIssue|StateOrProvinceOfIssue|LocaleOfIssue|CPProgram|CPRegType|MarginRatio|TerminationType|DeliveryForm|(Start|End)Cash$/,
+        classes: bond
+    },
+    {
+        test: /Yield|BenchmarkCurve|BenchmarkPrice|BenchmarkSecurity|Stipulation|Concession|TotalTakedown/,
+        classes: bond
+    },
+    {
+        test: /StrikePrice$|StrikeCurrency$|StrikeMultiplier$|StrikeValue$|PutOrCall$|OptAttribute$|ExerciseStyle$/,
+        classes: option
+    },
+    {
+        test: /MaturityMonthYear$|MaturityDate$|MaturityDay$|ContractMultiplier$|ContractSettlMonth$/,
+        classes: listed
+    }
+];
+const setRestrictions = [
+    { test: /^(YieldData|SpreadOrBenchmarkCurveData|FinancingDetails)$/, classes: bond },
+    { test: /Stipulations|Stips/, classes: bond },
+    { test: /Leg(s|Grp|$|[A-Z])|InstrmtLeg/, classes: multileg },
+    { test: /Und(erlying|Instrmt)/, classes: [instrument_universe_1.AssetClass.Spread, instrument_universe_1.AssetClass.Option] }
+];
+function applies(restrictions, name, assetClass) {
+    for (const r of restrictions) {
+        if (r.test.test(name)) {
+            return r.classes.includes(assetClass);
+        }
+    }
+    return true;
+}
+function fieldApplies(name, assetClass) {
+    return applies(fieldRestrictions, name, assetClass);
+}
+function setApplies(name, assetClass) {
+    return applies(setRestrictions, name, assetClass);
+}
+//# sourceMappingURL=applicability.js.map

package/dist/generator/applicability.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"applicability.js","sourceRoot":"","sources":["../../src/generator/applicability.ts"],"names":[],"mappings":";;AA6EA,oCAEC;AAKD,gCAEC;AAtFD,+DAAkD;AAwBlD,MAAM,IAAI,GAAG,CAAC,gCAAU,CAAC,IAAI,CAAC,CAAA;AAC9B,MAAM,MAAM,GAAG,CAAC,gCAAU,CAAC,MAAM,CAAC,CAAA;AAClC,MAAM,MAAM,GAAG,CAAC,gCAAU,CAAC,MAAM,EAAE,gCAAU,CAAC,MAAM,EAAE,gCAAU,CAAC,MAAM,CAAC,CAAA;AACxE,MAAM,QAAQ,GAAG,CAAC,gCAAU,CAAC,MAAM,CAAC,CAAA;AAOpC,MAAM,iBAAiB,GAA4B;IACjD;QAGE,IAAI,EAAE,mSAAmS;QACzS,OAAO,EAAE,IAAI;KACd;IACD;QAEE,IAAI,EAAE,4FAA4F;QAClG,OAAO,EAAE,IAAI;KACd;IACD;QACE,IAAI,EAAE,qGAAqG;QAC3G,OAAO,EAAE,MAAM;KAChB;IACD;QAEE,IAAI,EAAE,uFAAuF;QAC7F,OAAO,EAAE,MAAM;KAChB;CACF,CAAA;AAED,MAAM,eAAe,GAA4B;IAC/C,EAAE,IAAI,EAAE,2DAA2D,EAAE,OAAO,EAAE,IAAI,EAAE;IACpF,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,EAAE,IAAI,EAAE;IAE7C,EAAE,IAAI,EAAE,+BAA+B,EAAE,OAAO,EAAE,QAAQ,EAAE;IAC5D,EAAE,IAAI,EAAE,sBAAsB,EAAE,OAAO,EAAE,CAAC,gCAAU,CAAC,MAAM,EAAE,gCAAU,CAAC,MAAM,CAAC,EAAE;CAClF,CAAA;AAED,SAAS,OAAO,CAAE,YAAqC,EAAE,IAAY,EAAE,UAAsB;IAC3F,KAAK,MAAM,CAAC,IAAI,YAAY,EAAE,CAAC;QAC7B,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,OAAO,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QACvC,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAKD,SAAgB,YAAY,CAAE,IAAY,EAAE,UAAsB;IAChE,OAAO,OAAO,CAAC,iBAAiB,EAAE,IAAI,EAAE,UAAU,CAAC,CAAA;AACrD,CAAC;AAKD,SAAgB,UAAU,CAAE,IAAY,EAAE,UAAsB;IAC9D,OAAO,OAAO,CAAC,eAAe,EAAE,IAAI,EAAE,UAAU,CAAC,CAAA;AACnD,CAAC","sourcesContent":["import { AssetClass } from './instrument-universe'\n\n/**\n * Which optional fields belong on which kind of instrument.\n *\n * FIX puts every asset class through one `Instrument` component, so the dictionary is\n * perfectly happy for a Brent future to carry a repurchase rate, a credit rating and a\n * coupon payment date.  Nothing rejects it and nothing in the engine cares - but it is\n * the single loudest tell that a message was generated rather than captured, and it\n * makes a fixture harder to read than a dense one, because the eye keeps stopping on\n * fields that should not be there.\n *\n * The gate is written over field *names* rather than tags, and that is the whole trick.\n * FIX mirrors the instrument block for legs and underlyings by prefixing it -\n * `CouponRate`, `LegCouponRate`, `UnderlyingCouponRate` - so one pattern covers all\n * three, and covers the same field in a dictionary that renumbered it.  A tag list would\n * have to be recited three times and would still miss whatever the next version adds.\n *\n * The gate is advisory.  A field the dictionary marks required is emitted whatever this\n * says, and so is anything the caller has explicitly asked for - a house dialect is\n * entitled to put a coupon on a future, and refusing to generate that would be worse\n * than generating it by accident.\n */\n\nconst bond = [AssetClass.Bond]\nconst option = [AssetClass.Option]\nconst listed = [AssetClass.Future, AssetClass.Option, AssetClass.Spread]\nconst multileg = [AssetClass.Spread]\n\ninterface IRestriction {\n  readonly test: RegExp\n  readonly classes: readonly AssetClass[]\n}\n\nconst fieldRestrictions: readonly IRestriction[] = [\n  {\n    // coupon, issuance, redemption, rating and registry - the fixed income half of the\n    // instrument block, plus its repo and financing neighbours\n    test: /Coupon|Repurchase|RepoCollateral|Redemption|CreditRating|Issuer|IssueDate|DatedDate|InterestAccrual|AccruedInterest|NumDaysInterest|Factor$|Pool$|InstrRegistry|CountryOfIssue|StateOrProvinceOfIssue|LocaleOfIssue|CPProgram|CPRegType|MarginRatio|TerminationType|DeliveryForm|(Start|End)Cash$/,\n    classes: bond\n  },\n  {\n    // yield, benchmark spread, stipulations and the new issue economics\n    test: /Yield|BenchmarkCurve|BenchmarkPrice|BenchmarkSecurity|Stipulation|Concession|TotalTakedown/,\n    classes: bond\n  },\n  {\n    test: /StrikePrice$|StrikeCurrency$|StrikeMultiplier$|StrikeValue$|PutOrCall$|OptAttribute$|ExerciseStyle$/,\n    classes: option\n  },\n  {\n    // a listed contract has an expiry and a multiplier; cash equity and spot FX do not\n    test: /MaturityMonthYear$|MaturityDate$|MaturityDay$|ContractMultiplier$|ContractSettlMonth$/,\n    classes: listed\n  }\n]\n\nconst setRestrictions: readonly IRestriction[] = [\n  { test: /^(YieldData|SpreadOrBenchmarkCurveData|FinancingDetails)$/, classes: bond },\n  { test: /Stipulations|Stips/, classes: bond },\n  // legs describe a strategy, so they belong to an instrument that has one\n  { test: /Leg(s|Grp|$|[A-Z])|InstrmtLeg/, classes: multileg },\n  { test: /Und(erlying|Instrmt)/, classes: [AssetClass.Spread, AssetClass.Option] }\n]\n\nfunction applies (restrictions: readonly IRestriction[], name: string, assetClass: AssetClass): boolean {\n  for (const r of restrictions) {\n    if (r.test.test(name)) {\n      return r.classes.includes(assetClass)\n    }\n  }\n  return true\n}\n\n/**\n * whether an optional field of this name is plausible on this kind of instrument\n */\nexport function fieldApplies (name: string, assetClass: AssetClass): boolean {\n  return applies(fieldRestrictions, name, assetClass)\n}\n\n/**\n * whether an optional component or group of this name is plausible here\n */\nexport function setApplies (name: string, assetClass: AssetClass): boolean {\n  return applies(setRestrictions, name, assetClass)\n}\n"]}

package/dist/generator/case-builder.d.ts

@@ -0,0 +1,34 @@
+import { ILooseObject } from '../collections/collection';
+import { FixDefinitions } from '../dictionary/definition';
+import { IFragmentSafetyFinding } from '../dictionary/fragment-safety';
+import { IScatterPlan } from './scatter';
+import { IGeneratorOptions } from './realistic-generator';
+export interface ICaseOptions {
+    readonly scenario?: string;
+    readonly msgType?: string;
+    readonly seed?: number;
+    readonly depth?: number;
+    readonly fragments?: number;
+    readonly delimiter: string;
+    readonly generator?: IGeneratorOptions;
+}
+export interface IGeneratedCase {
+    readonly name: string;
+    readonly msgType: string;
+    readonly seed: number;
+    readonly object: ILooseObject;
+    readonly canonical: string;
+    readonly scattered: string;
+    readonly plan: IScatterPlan;
+    readonly requestedDepth: number;
+    readonly safety: readonly IFragmentSafetyFinding[];
+}
+export type Encode = (msgType: string, object: ILooseObject) => string;
+export declare class CaseBuilder {
+    readonly definitions: FixDefinitions;
+    readonly encode: Encode;
+    constructor(definitions: FixDefinitions, encode: Encode);
+    build(options: ICaseOptions): IGeneratedCase;
+    private safetyOf;
+}
+export declare function describeCase(c: IGeneratedCase, delimiter: string): string;

package/dist/generator/case-builder.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CaseBuilder = void 0;
+exports.describeCase = describeCase;
+const fragment_safety_1 = require("../dictionary/fragment-safety");
+const layout_1 = require("./layout");
+const scatter_1 = require("./scatter");
+const realistic_generator_1 = require("./realistic-generator");
+const rng_1 = require("./rng");
+const scenarios_1 = require("./scenarios");
+class CaseBuilder {
+    constructor(definitions, encode) {
+        this.definitions = definitions;
+        this.encode = encode;
+    }
+    build(options) {
+        var _a, _b, _c, _d, _e, _f, _g, _h;
+        const seed = (_a = options.seed) !== null && _a !== void 0 ? _a : 0x5eed;
+        const scenario = options.scenario ? scenarios_1.Scenarios.get(options.scenario) : undefined;
+        if (options.scenario && !scenario) {
+            throw new Error(`no scenario named ${options.scenario} - try one of ${scenarios_1.Scenarios.names().join(', ')}`);
+        }
+        const msgType = (_b = options.msgType) !== null && _b !== void 0 ? _b : scenario === null || scenario === void 0 ? void 0 : scenario.msgType;
+        if (!msgType) {
+            throw new Error('a case needs either a scenario or a message type');
+        }
+        const generatorOptions = Object.assign(Object.assign(Object.assign({}, ((_c = scenario === null || scenario === void 0 ? void 0 : scenario.options) !== null && _c !== void 0 ? _c : {})), ((_d = options.generator) !== null && _d !== void 0 ? _d : {})), { seed });
+        const generator = new realistic_generator_1.RealisticGenerator(this.definitions, generatorOptions);
+        const message = generator.generate(msgType);
+        const canonical = this.encode(message.msgType, message.object);
+        const depth = (_e = options.depth) !== null && _e !== void 0 ? _e : 0;
+        if (depth <= 0) {
+            return {
+                name: (_f = scenario === null || scenario === void 0 ? void 0 : scenario.name) !== null && _f !== void 0 ? _f : message.name,
+                msgType: message.msgType,
+                seed,
+                object: message.object,
+                canonical,
+                scattered: canonical,
+                plan: { depth: 0, sites: [] },
+                requestedDepth: 0,
+                safety: []
+            };
+        }
+        const layout = layout_1.Layout.build(canonical, options.delimiter, message.object, message.definition);
+        const scatterer = new scatter_1.Scatterer(layout, new rng_1.Rng(seed ^ 0x9e37), (_g = options.fragments) !== null && _g !== void 0 ? _g : 2);
+        const result = scatterer.scatter(depth, options.delimiter);
+        return {
+            name: (_h = scenario === null || scenario === void 0 ? void 0 : scenario.name) !== null && _h !== void 0 ? _h : message.name,
+            msgType: message.msgType,
+            seed,
+            object: message.object,
+            canonical,
+            scattered: result.wire,
+            plan: result.plan,
+            requestedDepth: depth,
+            safety: this.safetyOf(result.plan)
+        };
+    }
+    safetyOf(plan) {
+        var _a;
+        const out = [];
+        for (const site of plan.sites) {
+            const leaf = (_a = site.component.split('.').pop()) !== null && _a !== void 0 ? _a : '';
+            const name = leaf.replace(/\[[0-9]+\]$/, '');
+            const set = this.definitions.component.get(name);
+            if (!set)
+                continue;
+            for (const f of fragment_safety_1.FragmentSafety.analyseSet(set, site.component)) {
+                out.push(f);
+            }
+        }
+        return out;
+    }
+}
+exports.CaseBuilder = CaseBuilder;
+function describeCase(c, delimiter) {
+    const lines = [];
+    lines.push(`scenario   ${c.name}`);
+    lines.push(`msgType    ${c.msgType}`);
+    lines.push(`seed       ${c.seed}`);
+    if (c.requestedDepth > 0) {
+        const short = c.plan.depth < c.requestedDepth
+            ? ` (asked for ${c.requestedDepth}; the message could not express more)`
+            : '';
+        lines.push(`doll depth ${c.plan.depth}${short}`);
+        for (const site of c.plan.sites) {
+            lines.push(`  ${site.component}  (${site.containment})`);
+            lines.push(`    level     ${site.level}  (structure depth ${site.structureDepth})`);
+            lines.push(`    runs      ${site.fragments}`);
+            lines.push(`    tags      ${site.tags.join(' ')}`);
+            if (site.contendedTags.length > 0) {
+                lines.push(`    contended ${site.contendedTags.join(' ')} - also claimed by a sibling of this component`);
+            }
+        }
+        if (c.safety.length > 0) {
+            lines.push('  fragment safety');
+            for (const f of c.safety) {
+                lines.push(`    ${(0, fragment_safety_1.describeFinding)(f)}`);
+            }
+        }
+    }
+    else {
+        lines.push('doll depth 0 (canonical, nothing moved)');
+    }
+    const before = (0, layout_1.tokenise)(c.canonical, delimiter).length;
+    const after = (0, layout_1.tokenise)(c.scattered, delimiter).length;
+    lines.push(`tokens     ${before} canonical, ${after} scattered`);
+    return lines.join('\n');
+}
+//# sourceMappingURL=case-builder.js.map

package/dist/generator/case-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"case-builder.js","sourceRoot":"","sources":["../../src/generator/case-builder.ts"],"names":[],"mappings":";;;AAsIA,oCAgCC;AApKD,mEAAuG;AACvG,qCAA2C;AAC3C,uCAAmD;AACnD,+DAA6E;AAC7E,+BAA2B;AAC3B,2CAAuC;AA+CvC,MAAa,WAAW;IACtB,YACkB,WAA2B,EAC3B,MAAc;QADd,gBAAW,GAAX,WAAW,CAAgB;QAC3B,WAAM,GAAN,MAAM,CAAQ;IAChC,CAAC;IAEM,KAAK,CAAE,OAAqB;;QACjC,MAAM,IAAI,GAAG,MAAA,OAAO,CAAC,IAAI,mCAAI,MAAM,CAAA;QACnC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,qBAAS,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QAC/E,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,qBAAqB,OAAO,CAAC,QAAQ,iBAAiB,qBAAS,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACvG,CAAC;QACD,MAAM,OAAO,GAAG,MAAA,OAAO,CAAC,OAAO,mCAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,CAAA;QACpD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;QACrE,CAAC;QACD,MAAM,gBAAgB,iDACjB,CAAC,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,mCAAI,EAAE,CAAC,GACzB,CAAC,MAAA,OAAO,CAAC,SAAS,mCAAI,EAAE,CAAC,KAC5B,IAAI,GACL,CAAA;QACD,MAAM,SAAS,GAAG,IAAI,wCAAkB,CAAC,IAAI,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAA;QAC5E,MAAM,OAAO,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;QAC3C,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;QAE9D,MAAM,KAAK,GAAG,MAAA,OAAO,CAAC,KAAK,mCAAI,CAAC,CAAA;QAChC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;YACf,OAAO;gBACL,IAAI,EAAE,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,mCAAI,OAAO,CAAC,IAAI;gBACpC,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,IAAI;gBACJ,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,SAAS;gBACT,SAAS,EAAE,SAAS;gBACpB,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;gBAC7B,cAAc,EAAE,CAAC;gBACjB,MAAM,EAAE,EAAE;aACX,CAAA;QACH,CAAC;QAED,MAAM,MAAM,GAAG,eAAM,CAAC,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,CAAC,CAAA;QAC7F,MAAM,SAAS,GAAG,IAAI,mBAAS,CAAC,MAAM,EAAE,IAAI,SAAG,CAAC,IAAI,GAAG,MAAM,CAAC,EAAE,MAAA,OAAO,CAAC,SAAS,mCAAI,CAAC,CAAC,CAAA;QACvF,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;QAC1D,OAAO;YACL,IAAI,EAAE,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,mCAAI,OAAO,CAAC,IAAI;YACpC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,IAAI;YACJ,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,SAAS;YACT,SAAS,EAAE,MAAM,CAAC,IAAI;YACtB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,cAAc,EAAE,KAAK;YACrB,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC;SACnC,CAAA;IACH,CAAC;IAMO,QAAQ,CAAE,IAAkB;;QAClC,MAAM,GAAG,GAA6B,EAAE,CAAA;QACxC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC9B,MAAM,IAAI,GAAG,MAAA,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,mCAAI,EAAE,CAAA;YAClD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAA;YAC5C,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;YAChD,IAAI,CAAC,GAAG;gBAAE,SAAQ;YAClB,KAAK,MAAM,CAAC,IAAI,gCAAc,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC/D,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACb,CAAC;QACH,CAAC;QACD,OAAO,GAAG,CAAA;IACZ,CAAC;CACF;AAzED,kCAyEC;AAOD,SAAgB,YAAY,CAAE,CAAiB,EAAE,SAAiB;IAChE,MAAM,KAAK,GAAa,EAAE,CAAA;IAC1B,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;IAClC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;IACrC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;IAClC,IAAI,CAAC,CAAC,cAAc,GAAG,CAAC,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,cAAc;YAC3C,CAAC,CAAC,eAAe,CAAC,CAAC,cAAc,uCAAuC;YACxE,CAAC,CAAC,EAAE,CAAA;QACN,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,EAAE,CAAC,CAAA;QAChD,KAAK,MAAM,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAChC,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,SAAS,MAAM,IAAI,CAAC,WAAW,GAAG,CAAC,CAAA;YACxD,KAAK,CAAC,IAAI,CAAC,iBAAiB,IAAI,CAAC,KAAK,sBAAsB,IAAI,CAAC,cAAc,GAAG,CAAC,CAAA;YACnF,KAAK,CAAC,IAAI,CAAC,iBAAiB,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;YAC7C,KAAK,CAAC,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YAClD,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAClC,KAAK,CAAC,IAAI,CAAC,iBAAiB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAA;YAC3G,CAAC;QACH,CAAC;QACD,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;YAC/B,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;gBACzB,KAAK,CAAC,IAAI,CAAC,OAAO,IAAA,iCAAe,EAAC,CAAC,CAAC,EAAE,CAAC,CAAA;YACzC,CAAC;QACH,CAAC;IACH,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAA;IACvD,CAAC;IACD,MAAM,MAAM,GAAG,IAAA,iBAAQ,EAAC,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,MAAM,CAAA;IACtD,MAAM,KAAK,GAAG,IAAA,iBAAQ,EAAC,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,MAAM,CAAA;IACrD,KAAK,CAAC,IAAI,CAAC,cAAc,MAAM,eAAe,KAAK,YAAY,CAAC,CAAA;IAChE,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACzB,CAAC","sourcesContent":["import { ILooseObject } from '../collections/collection'\nimport { FixDefinitions } from '../dictionary/definition'\nimport { FragmentSafety, IFragmentSafetyFinding, describeFinding } from '../dictionary/fragment-safety'\nimport { Layout, tokenise } from './layout'\nimport { IScatterPlan, Scatterer } from './scatter'\nimport { IGeneratorOptions, RealisticGenerator } from './realistic-generator'\nimport { Rng } from './rng'\nimport { Scenarios } from './scenarios'\n\n/**\n * One test case: a message, the canonical encoding of it, and a legal re-ordering of the\n * same bytes with one or more components taken apart.\n *\n * The canonical encoding is the oracle.  It is contiguous by construction, because the\n * encoder emits in dictionary order, so today's parser handles it and the object it\n * produces is by definition the right answer.  The scattered variant is a permutation of\n * the same body tokens, so it says exactly the same thing - and any difference in what\n * the parser makes of it is a defect, with no hand written expectation to be wrong about.\n *\n * A case also carries the fragment safety findings for the component it took apart.  If\n * two children of a set both claim a tag then no repair can attribute it by tag alone,\n * and a case built over that shape is unfair rather than failing - see phase 0 of\n * `docs/scattered-components.md`, and the 57 collisions in the QuickFIX FIX50SP2\n * dictionary that motivated recording it.\n */\n\nexport interface ICaseOptions {\n  /** a named scenario, or a message type with generator options of your own */\n  readonly scenario?: string\n  readonly msgType?: string\n  readonly seed?: number\n  /** how many nested scatter sites to ask for; 0 leaves the message canonical */\n  readonly depth?: number\n  /** how many runs to break each scattered component into */\n  readonly fragments?: number\n  readonly delimiter: string\n  readonly generator?: IGeneratorOptions\n}\n\nexport interface IGeneratedCase {\n  readonly name: string\n  readonly msgType: string\n  readonly seed: number\n  readonly object: ILooseObject\n  readonly canonical: string\n  readonly scattered: string\n  readonly plan: IScatterPlan\n  /** what was asked for, which may exceed what the message could express */\n  readonly requestedDepth: number\n  readonly safety: readonly IFragmentSafetyFinding[]\n}\n\nexport type Encode = (msgType: string, object: ILooseObject) => string\n\nexport class CaseBuilder {\n  constructor (\n    public readonly definitions: FixDefinitions,\n    public readonly encode: Encode) {\n  }\n\n  public build (options: ICaseOptions): IGeneratedCase {\n    const seed = options.seed ?? 0x5eed\n    const scenario = options.scenario ? Scenarios.get(options.scenario) : undefined\n    if (options.scenario && !scenario) {\n      throw new Error(`no scenario named ${options.scenario} - try one of ${Scenarios.names().join(', ')}`)\n    }\n    const msgType = options.msgType ?? scenario?.msgType\n    if (!msgType) {\n      throw new Error('a case needs either a scenario or a message type')\n    }\n    const generatorOptions: IGeneratorOptions = {\n      ...(scenario?.options ?? {}),\n      ...(options.generator ?? {}),\n      seed\n    }\n    const generator = new RealisticGenerator(this.definitions, generatorOptions)\n    const message = generator.generate(msgType)\n    const canonical = this.encode(message.msgType, message.object)\n\n    const depth = options.depth ?? 0\n    if (depth <= 0) {\n      return {\n        name: scenario?.name ?? message.name,\n        msgType: message.msgType,\n        seed,\n        object: message.object,\n        canonical,\n        scattered: canonical,\n        plan: { depth: 0, sites: [] },\n        requestedDepth: 0,\n        safety: []\n      }\n    }\n\n    const layout = Layout.build(canonical, options.delimiter, message.object, message.definition)\n    const scatterer = new Scatterer(layout, new Rng(seed ^ 0x9e37), options.fragments ?? 2)\n    const result = scatterer.scatter(depth, options.delimiter)\n    return {\n      name: scenario?.name ?? message.name,\n      msgType: message.msgType,\n      seed,\n      object: message.object,\n      canonical,\n      scattered: result.wire,\n      plan: result.plan,\n      requestedDepth: depth,\n      safety: this.safetyOf(result.plan)\n    }\n  }\n\n  /**\n   * findings for the sets the plan actually touched, rather than for the whole\n   * dictionary - a collision three components away is not this case's problem\n   */\n  private safetyOf (plan: IScatterPlan): IFragmentSafetyFinding[] {\n    const out: IFragmentSafetyFinding[] = []\n    for (const site of plan.sites) {\n      const leaf = site.component.split('.').pop() ?? ''\n      const name = leaf.replace(/\\[[0-9]+\\]$/, '')\n      const set = this.definitions.component.get(name)\n      if (!set) continue\n      for (const f of FragmentSafety.analyseSet(set, site.component)) {\n        out.push(f)\n      }\n    }\n    return out\n  }\n}\n\n/**\n * A human readable account of what was done to a message, for the header of a fixture\n * file.  A scattered message is hard to read precisely because it is scattered, so\n * something has to say which tags moved and where they went.\n */\nexport function describeCase (c: IGeneratedCase, delimiter: string): string {\n  const lines: string[] = []\n  lines.push(`scenario   ${c.name}`)\n  lines.push(`msgType    ${c.msgType}`)\n  lines.push(`seed       ${c.seed}`)\n  if (c.requestedDepth > 0) {\n    const short = c.plan.depth < c.requestedDepth\n      ? ` (asked for ${c.requestedDepth}; the message could not express more)`\n      : ''\n    lines.push(`doll depth ${c.plan.depth}${short}`)\n    for (const site of c.plan.sites) {\n      lines.push(`  ${site.component}  (${site.containment})`)\n      lines.push(`    level     ${site.level}  (structure depth ${site.structureDepth})`)\n      lines.push(`    runs      ${site.fragments}`)\n      lines.push(`    tags      ${site.tags.join(' ')}`)\n      if (site.contendedTags.length > 0) {\n        lines.push(`    contended ${site.contendedTags.join(' ')} - also claimed by a sibling of this component`)\n      }\n    }\n    if (c.safety.length > 0) {\n      lines.push('  fragment safety')\n      for (const f of c.safety) {\n        lines.push(`    ${describeFinding(f)}`)\n      }\n    }\n  } else {\n    lines.push('doll depth 0 (canonical, nothing moved)')\n  }\n  const before = tokenise(c.canonical, delimiter).length\n  const after = tokenise(c.scattered, delimiter).length\n  lines.push(`tokens     ${before} canonical, ${after} scattered`)\n  return lines.join('\\n')\n}\n"]}

package/dist/generator/corpus-store.d.ts

@@ -0,0 +1,43 @@
+import { IScatterPlan } from './scatter';
+import { CaseOutcome } from './outcome';
+import { IGeneratedCase } from './case-builder';
+export interface ICorpusEntry {
+    readonly name: string;
+    readonly note: string;
+    readonly dictionary: string;
+    readonly session: string;
+    readonly delimiter: string;
+    readonly expected: CaseOutcome;
+    readonly missing?: string[];
+    readonly added?: string[];
+    readonly changed?: string[];
+    readonly origin?: {
+        readonly scenario?: string;
+        readonly seed?: number;
+        readonly depth?: number;
+        readonly fragments?: number;
+        readonly asOf?: string;
+    };
+    readonly plan: IScatterPlan;
+}
+export interface ILoadedCase {
+    readonly entry: ICorpusEntry;
+    readonly canonical: string;
+    readonly scattered: string;
+    readonly directory: string;
+}
+export declare class CorpusStore {
+    readonly root: string;
+    constructor(root: string);
+    names(): string[];
+    load(name: string): ILoadedCase;
+    loadAll(): ILoadedCase[];
+    save(entry: ICorpusEntry, canonical: string, scattered: string): string;
+    static fromCase(name: string, note: string, dictionary: string, session: string, delimiter: string, generated: IGeneratedCase, expected: CaseOutcome, detail: {
+        missing: string[];
+        added: string[];
+        changed: string[];
+    }, asOf?: Date): ICorpusEntry;
+    private static wireFile;
+    private static readWire;
+}

package/dist/generator/corpus-store.js

@@ -0,0 +1,115 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CorpusStore = void 0;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const CASE_FILE = 'case.json';
+const CANONICAL_FILE = 'canonical.txt';
+const SCATTERED_FILE = 'scattered.txt';
+class CorpusStore {
+    constructor(root) {
+        this.root = root;
+    }
+    names() {
+        if (!fs.existsSync(this.root))
+            return [];
+        return fs.readdirSync(this.root)
+            .filter(name => fs.existsSync(path.join(this.root, name, CASE_FILE)))
+            .sort();
+    }
+    load(name) {
+        const directory = path.join(this.root, name);
+        const entry = JSON.parse(fs.readFileSync(path.join(directory, CASE_FILE), 'utf8'));
+        return {
+            entry,
+            canonical: CorpusStore.readWire(path.join(directory, CANONICAL_FILE)),
+            scattered: CorpusStore.readWire(path.join(directory, SCATTERED_FILE)),
+            directory
+        };
+    }
+    loadAll() {
+        return this.names().map(name => this.load(name));
+    }
+    save(entry, canonical, scattered) {
+        const directory = path.join(this.root, entry.name);
+        fs.mkdirSync(directory, { recursive: true });
+        fs.writeFileSync(path.join(directory, CASE_FILE), `${JSON.stringify(entry, null, 2)}\n`, 'utf8');
+        fs.writeFileSync(path.join(directory, CANONICAL_FILE), CorpusStore.wireFile(entry, 'canonical - dictionary order, contiguous, the oracle', canonical), 'utf8');
+        fs.writeFileSync(path.join(directory, SCATTERED_FILE), CorpusStore.wireFile(entry, 'scattered - the same bytes, legally re-ordered', scattered), 'utf8');
+        return directory;
+    }
+    static fromCase(name, note, dictionary, session, delimiter, generated, expected, detail, asOf) {
+        return {
+            name,
+            note,
+            dictionary,
+            session,
+            delimiter,
+            expected,
+            missing: detail.missing.length > 0 ? detail.missing : undefined,
+            added: detail.added.length > 0 ? detail.added : undefined,
+            changed: detail.changed.length > 0 ? detail.changed : undefined,
+            origin: {
+                scenario: generated.name,
+                seed: generated.seed,
+                depth: generated.requestedDepth,
+                asOf: asOf ? asOf.toISOString() : undefined
+            },
+            plan: generated.plan
+        };
+    }
+    static wireFile(entry, what, wire) {
+        const lines = [];
+        lines.push(`# ${entry.name} - ${what}`);
+        lines.push(`# ${entry.note}`);
+        lines.push(`# dictionary ${entry.dictionary}, expected ${entry.expected}`);
+        for (const site of entry.plan.sites) {
+            lines.push(`# scattered: ${site.component} at structure depth ${site.structureDepth}, ${site.fragments} runs`);
+        }
+        lines.push(wire);
+        return `${lines.join('\n')}\n`;
+    }
+    static readWire(file) {
+        const text = fs.readFileSync(file, 'utf8');
+        for (const line of text.split(/\r?\n/)) {
+            if (line.startsWith('8='))
+                return line;
+        }
+        throw new Error(`${file} contains no message - expected a line beginning 8=`);
+    }
+}
+exports.CorpusStore = CorpusStore;
+//# sourceMappingURL=corpus-store.js.map

package/dist/generator/corpus-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"corpus-store.js","sourceRoot":"","sources":["../../src/generator/corpus-store.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAwB;AACxB,2CAA4B;AA8D5B,MAAM,SAAS,GAAG,WAAW,CAAA;AAC7B,MAAM,cAAc,GAAG,eAAe,CAAA;AACtC,MAAM,cAAc,GAAG,eAAe,CAAA;AAEtC,MAAa,WAAW;IACtB,YAA6B,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IACzC,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC;YAAE,OAAO,EAAE,CAAA;QACxC,OAAO,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC;aAC7B,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;aACpE,IAAI,EAAE,CAAA;IACX,CAAC;IAEM,IAAI,CAAE,IAAY;QACvB,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAC5C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,CAAiB,CAAA;QAClG,OAAO;YACL,KAAK;YACL,SAAS,EAAE,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;YACrE,SAAS,EAAE,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;YACrE,SAAS;SACV,CAAA;IACH,CAAC;IAEM,OAAO;QACZ,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IAClD,CAAC;IAOM,IAAI,CAAE,KAAmB,EAAE,SAAiB,EAAE,SAAiB;QACpE,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;QAClD,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAC5C,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAChG,EAAE,CAAC,aAAa,CACd,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,EACpC,WAAW,CAAC,QAAQ,CAAC,KAAK,EAAE,sDAAsD,EAAE,SAAS,CAAC,EAC9F,MAAM,CAAC,CAAA;QACT,EAAE,CAAC,aAAa,CACd,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,EACpC,WAAW,CAAC,QAAQ,CAAC,KAAK,EAAE,gDAAgD,EAAE,SAAS,CAAC,EACxF,MAAM,CAAC,CAAA;QACT,OAAO,SAAS,CAAA;IAClB,CAAC;IAEM,MAAM,CAAC,QAAQ,CACpB,IAAY,EACZ,IAAY,EACZ,UAAkB,EAClB,OAAe,EACf,SAAiB,EACjB,SAAyB,EACzB,QAAqB,EACrB,MAAiE,EACjE,IAAW;QACX,OAAO;YACL,IAAI;YACJ,IAAI;YACJ,UAAU;YACV,OAAO;YACP,SAAS;YACT,QAAQ;YACR,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;YAC/D,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;YACzD,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;YAC/D,MAAM,EAAE;gBACN,QAAQ,EAAE,SAAS,CAAC,IAAI;gBACxB,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,KAAK,EAAE,SAAS,CAAC,cAAc;gBAC/B,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS;aAC5C;YACD,IAAI,EAAE,SAAS,CAAC,IAAI;SACrB,CAAA;IACH,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAE,KAAmB,EAAE,IAAY,EAAE,IAAY;QACtE,MAAM,KAAK,GAAa,EAAE,CAAA;QAC1B,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,IAAI,MAAM,IAAI,EAAE,CAAC,CAAA;QACvC,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;QAC7B,KAAK,CAAC,IAAI,CAAC,gBAAgB,KAAK,CAAC,UAAU,cAAc,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;QAC1E,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YACpC,KAAK,CAAC,IAAI,CAAC,gBAAgB,IAAI,CAAC,SAAS,uBAAuB,IAAI,CAAC,cAAc,KAAK,IAAI,CAAC,SAAS,OAAO,CAAC,CAAA;QAChH,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAChB,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAA;IAChC,CAAC;IAKO,MAAM,CAAC,QAAQ,CAAE,IAAY;QACnC,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAC1C,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YACvC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;gBAAE,OAAO,IAAI,CAAA;QACxC,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,qDAAqD,CAAC,CAAA;IAC/E,CAAC;CACF;AAlGD,kCAkGC","sourcesContent":["import * as fs from 'fs'\nimport * as path from 'path'\nimport { IScatterPlan } from './scatter'\nimport { CaseOutcome } from './outcome'\nimport { IGeneratedCase } from './case-builder'\n\n/**\n * The corpus: edge cases kept as bytes, not as recipes.\n *\n * The generator is how a case is *found*; it is not what a case *is*.  A seed reproduces\n * a message only while the generator is unchanged - adjust one probability in the value\n * conventions and the random stream reshuffles, so every seed produces a different\n * message and every recorded expectation quietly stops describing what it was written\n * for.  A corpus that has to be regenerated to be read is not a corpus.\n *\n * So an entry is the two encodings, frozen, plus the expectation someone looked at and\n * agreed with.  Adding one is: generate until the tool proposes something interesting,\n * read it, commit it.  From then on it tests the same bytes forever, and it keeps\n * testing them if the generator is deleted.\n *\n * Layout, one directory per case:\n *\n *     data/corpus/<name>/case.json        metadata, plan and expected outcome\n *     data/corpus/<name>/canonical.txt    the contiguous encoding - the oracle\n *     data/corpus/<name>/scattered.txt    the legal re-ordering under test\n */\n\nexport interface ICorpusEntry {\n  readonly name: string\n  /** what this case is here to demonstrate, in a sentence */\n  readonly note: string\n  /** dictionary the case was built against, e.g. `repo44` */\n  readonly dictionary: string\n  /** session description used to encode and parse, relative to `data/` */\n  readonly session: string\n  readonly delimiter: string\n  /** what the engine does with it today, agreed by whoever added the case */\n  readonly expected: CaseOutcome\n  /**\n   * when `expected` is not `round-trips`, the leaf paths involved.  Recorded so a change\n   * in *how* a case fails is a test failure too, not just a change in whether it does.\n   */\n  readonly missing?: string[]\n  readonly added?: string[]\n  readonly changed?: string[]\n  /** how the case was originally found - provenance, not a way to rebuild it */\n  readonly origin?: {\n    readonly scenario?: string\n    readonly seed?: number\n    readonly depth?: number\n    readonly fragments?: number\n    readonly asOf?: string\n  }\n  readonly plan: IScatterPlan\n}\n\nexport interface ILoadedCase {\n  readonly entry: ICorpusEntry\n  readonly canonical: string\n  readonly scattered: string\n  readonly directory: string\n}\n\nconst CASE_FILE = 'case.json'\nconst CANONICAL_FILE = 'canonical.txt'\nconst SCATTERED_FILE = 'scattered.txt'\n\nexport class CorpusStore {\n  constructor (public readonly root: string) {\n  }\n\n  public names (): string[] {\n    if (!fs.existsSync(this.root)) return []\n    return fs.readdirSync(this.root)\n      .filter(name => fs.existsSync(path.join(this.root, name, CASE_FILE)))\n      .sort()\n  }\n\n  public load (name: string): ILoadedCase {\n    const directory = path.join(this.root, name)\n    const entry = JSON.parse(fs.readFileSync(path.join(directory, CASE_FILE), 'utf8')) as ICorpusEntry\n    return {\n      entry,\n      canonical: CorpusStore.readWire(path.join(directory, CANONICAL_FILE)),\n      scattered: CorpusStore.readWire(path.join(directory, SCATTERED_FILE)),\n      directory\n    }\n  }\n\n  public loadAll (): ILoadedCase[] {\n    return this.names().map(name => this.load(name))\n  }\n\n  /**\n   * A case file is a fixture a person is expected to read, so it is written with the\n   * commentary a person needs: what the case demonstrates and what the engine does with\n   * it, above the wire.  Everything from the first `8=` is the message.\n   */\n  public save (entry: ICorpusEntry, canonical: string, scattered: string): string {\n    const directory = path.join(this.root, entry.name)\n    fs.mkdirSync(directory, { recursive: true })\n    fs.writeFileSync(path.join(directory, CASE_FILE), `${JSON.stringify(entry, null, 2)}\\n`, 'utf8')\n    fs.writeFileSync(\n      path.join(directory, CANONICAL_FILE),\n      CorpusStore.wireFile(entry, 'canonical - dictionary order, contiguous, the oracle', canonical),\n      'utf8')\n    fs.writeFileSync(\n      path.join(directory, SCATTERED_FILE),\n      CorpusStore.wireFile(entry, 'scattered - the same bytes, legally re-ordered', scattered),\n      'utf8')\n    return directory\n  }\n\n  public static fromCase (\n    name: string,\n    note: string,\n    dictionary: string,\n    session: string,\n    delimiter: string,\n    generated: IGeneratedCase,\n    expected: CaseOutcome,\n    detail: { missing: string[], added: string[], changed: string[] },\n    asOf?: Date): ICorpusEntry {\n    return {\n      name,\n      note,\n      dictionary,\n      session,\n      delimiter,\n      expected,\n      missing: detail.missing.length > 0 ? detail.missing : undefined,\n      added: detail.added.length > 0 ? detail.added : undefined,\n      changed: detail.changed.length > 0 ? detail.changed : undefined,\n      origin: {\n        scenario: generated.name,\n        seed: generated.seed,\n        depth: generated.requestedDepth,\n        asOf: asOf ? asOf.toISOString() : undefined\n      },\n      plan: generated.plan\n    }\n  }\n\n  private static wireFile (entry: ICorpusEntry, what: string, wire: string): string {\n    const lines: string[] = []\n    lines.push(`# ${entry.name} - ${what}`)\n    lines.push(`# ${entry.note}`)\n    lines.push(`# dictionary ${entry.dictionary}, expected ${entry.expected}`)\n    for (const site of entry.plan.sites) {\n      lines.push(`# scattered: ${site.component} at structure depth ${site.structureDepth}, ${site.fragments} runs`)\n    }\n    lines.push(wire)\n    return `${lines.join('\\n')}\\n`\n  }\n\n  /**\n   * the message, ignoring the commentary above it\n   */\n  private static readWire (file: string): string {\n    const text = fs.readFileSync(file, 'utf8')\n    for (const line of text.split(/\\r?\\n/)) {\n      if (line.startsWith('8=')) return line\n    }\n    throw new Error(`${file} contains no message - expected a line beginning 8=`)\n  }\n}\n"]}

package/dist/generator/index.d.ts

@@ -0,0 +1,12 @@
+export * from './rng';
+export * from './instrument-universe';
+export * from './market-context';
+export * from './value-conventions';
+export * from './realistic-generator';
+export * from './applicability';
+export * from './scenarios';
+export * from './layout';
+export * from './scatter';
+export * from './outcome';
+export * from './case-builder';
+export * from './corpus-store';

package/dist/generator/index.js

@@ -0,0 +1,29 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./rng"), exports);
+__exportStar(require("./instrument-universe"), exports);
+__exportStar(require("./market-context"), exports);
+__exportStar(require("./value-conventions"), exports);
+__exportStar(require("./realistic-generator"), exports);
+__exportStar(require("./applicability"), exports);
+__exportStar(require("./scenarios"), exports);
+__exportStar(require("./layout"), exports);
+__exportStar(require("./scatter"), exports);
+__exportStar(require("./outcome"), exports);
+__exportStar(require("./case-builder"), exports);
+__exportStar(require("./corpus-store"), exports);
+//# sourceMappingURL=index.js.map

package/dist/generator/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/generator/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAqB;AACrB,wDAAqC;AACrC,mDAAgC;AAChC,sDAAmC;AACnC,wDAAqC;AACrC,kDAA+B;AAC/B,8CAA2B;AAC3B,2CAAwB;AACxB,4CAAyB;AACzB,4CAAyB;AACzB,iDAA8B;AAC9B,iDAA8B","sourcesContent":["export * from './rng'\nexport * from './instrument-universe'\nexport * from './market-context'\nexport * from './value-conventions'\nexport * from './realistic-generator'\nexport * from './applicability'\nexport * from './scenarios'\nexport * from './layout'\nexport * from './scatter'\nexport * from './outcome'\nexport * from './case-builder'\nexport * from './corpus-store'\n"]}