@fintekkers/ledger-models 0.4.31 → 0.4.32

package/node/wrappers/models/price/price_rules.d.ts

@@ -0,0 +1,20 @@
+import { PriceProto } from '../../../fintekkers/models/price/price_pb';
+import { FieldViolationProto } from '../../../fintekkers/requests/util/errors/field_violation_pb';
+/**
+ * Price input rules (LM-289): JS counterpart of Java's PriceRules
+ * (docs/adr/typed-input-errors.md). Pure: proto in, violations out.
+ *
+ * Three rules, checked in this order: `security` has a non-empty UUID,
+ * `price` has a non-empty arbitrary_precision_value (zero is valid, see the
+ * PriceProto comment), and `price_type` is not UNKNOWN_PRICE_TYPE. The price
+ * value is not parsed. Never throws on bad or unset input; null or undefined
+ * is checked as an empty PriceProto. Unlike security_rules, a link price is
+ * not skipped: hydrate it first. The Price wrapper does not call these rules.
+ */
+export declare const SECURITY = "security";
+export declare const PRICE = "price";
+export declare const PRICE_TYPE = "price_type";
+/** Returns every field-level violation on this price, or an empty array when it is valid. */
+export declare function validate(proto: PriceProto | null | undefined): FieldViolationProto[];
+/** Throws ModelValidationError carrying every violation if `validate` finds any. */
+export declare function requireValid(proto: PriceProto | null | undefined): void;

package/node/wrappers/models/price/price_rules.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requireValid = exports.validate = exports.PRICE_TYPE = exports.PRICE = exports.SECURITY = void 0;
+const price_pb_1 = require("../../../fintekkers/models/price/price_pb");
+const price_type_pb_1 = require("../../../fintekkers/models/price/price_type_pb");
+const errors_1 = require("../errors");
+const uuid_1 = require("../utils/uuid");
+/**
+ * Price input rules (LM-289): JS counterpart of Java's PriceRules
+ * (docs/adr/typed-input-errors.md). Pure: proto in, violations out.
+ *
+ * Three rules, checked in this order: `security` has a non-empty UUID,
+ * `price` has a non-empty arbitrary_precision_value (zero is valid, see the
+ * PriceProto comment), and `price_type` is not UNKNOWN_PRICE_TYPE. The price
+ * value is not parsed. Never throws on bad or unset input; null or undefined
+ * is checked as an empty PriceProto. Unlike security_rules, a link price is
+ * not skipped: hydrate it first. The Price wrapper does not call these rules.
+ */
+exports.SECURITY = 'security';
+exports.PRICE = 'price';
+exports.PRICE_TYPE = 'price_type';
+/** Returns every field-level violation on this price, or an empty array when it is valid. */
+function validate(proto) {
+    var _a, _b, _c;
+    const p = proto !== null && proto !== void 0 ? proto : new price_pb_1.PriceProto();
+    const id = objectIdOf(p);
+    const out = [];
+    if (!((_b = (_a = p.getSecurity()) === null || _a === void 0 ? void 0 : _a.getUuid()) === null || _b === void 0 ? void 0 : _b.getRawUuid_asU8().length)) {
+        out.push((0, errors_1.violation)(exports.SECURITY, id, 'security with a non-empty uuid is required'));
+    }
+    if (!((_c = p.getPrice()) === null || _c === void 0 ? void 0 : _c.getArbitraryPrecisionValue())) {
+        out.push((0, errors_1.violation)(exports.PRICE, id, 'price is required'));
+    }
+    if (p.getPriceType() === price_type_pb_1.PriceTypeProto.UNKNOWN_PRICE_TYPE) {
+        out.push((0, errors_1.violation)(exports.PRICE_TYPE, id, 'price_type must not be UNKNOWN_PRICE_TYPE'));
+    }
+    return out;
+}
+exports.validate = validate;
+/** Throws ModelValidationError carrying every violation if `validate` finds any. */
+function requireValid(proto) {
+    const violations = validate(proto);
+    if (violations.length > 0)
+        throw new errors_1.ModelValidationError(violations);
+}
+exports.requireValid = requireValid;
+/** The price's UUID, or undefined when it has none or it is not 16 bytes. */
+function objectIdOf(proto) {
+    var _a;
+    const raw = (_a = proto.getUuid()) === null || _a === void 0 ? void 0 : _a.getRawUuid_asU8();
+    return raw && raw.length === 16 ? uuid_1.UUID.fromU8Array(raw) : undefined;
+}
+//# sourceMappingURL=price_rules.js.map

package/node/wrappers/models/price/price_rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"price_rules.js","sourceRoot":"","sources":["price_rules.ts"],"names":[],"mappings":";;;AAAA,wEAAuE;AACvE,kFAAgF;AAEhF,sCAA4D;AAC5D,wCAAqC;AAErC;;;;;;;;;;GAUG;AAEU,QAAA,QAAQ,GAAG,UAAU,CAAC;AACtB,QAAA,KAAK,GAAG,OAAO,CAAC;AAChB,QAAA,UAAU,GAAG,YAAY,CAAC;AAEvC,6FAA6F;AAC7F,SAAgB,QAAQ,CAAC,KAAoC;;IACzD,MAAM,CAAC,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,IAAI,qBAAU,EAAE,CAAC;IACpC,MAAM,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;IACzB,MAAM,GAAG,GAA0B,EAAE,CAAC;IACtC,IAAI,CAAC,CAAA,MAAA,MAAA,CAAC,CAAC,WAAW,EAAE,0CAAE,OAAO,EAAE,0CAAE,eAAe,GAAG,MAAM,CAAA,EAAE;QACvD,GAAG,CAAC,IAAI,CAAC,IAAA,kBAAS,EAAC,gBAAQ,EAAE,EAAE,EAAE,4CAA4C,CAAC,CAAC,CAAC;KACnF;IACD,IAAI,CAAC,CAAA,MAAA,CAAC,CAAC,QAAQ,EAAE,0CAAE,0BAA0B,EAAE,CAAA,EAAE;QAC7C,GAAG,CAAC,IAAI,CAAC,IAAA,kBAAS,EAAC,aAAK,EAAE,EAAE,EAAE,mBAAmB,CAAC,CAAC,CAAC;KACvD;IACD,IAAI,CAAC,CAAC,YAAY,EAAE,KAAK,8BAAc,CAAC,kBAAkB,EAAE;QACxD,GAAG,CAAC,IAAI,CAAC,IAAA,kBAAS,EAAC,kBAAU,EAAE,EAAE,EAAE,2CAA2C,CAAC,CAAC,CAAC;KACpF;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AAdD,4BAcC;AAED,oFAAoF;AACpF,SAAgB,YAAY,CAAC,KAAoC;IAC7D,MAAM,UAAU,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IACnC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,IAAI,6BAAoB,CAAC,UAAU,CAAC,CAAC;AAC1E,CAAC;AAHD,oCAGC;AAED,6EAA6E;AAC7E,SAAS,UAAU,CAAC,KAAiB;;IACjC,MAAM,GAAG,GAAG,MAAA,KAAK,CAAC,OAAO,EAAE,0CAAE,eAAe,EAAE,CAAC;IAC/C,OAAO,GAAG,IAAI,GAAG,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,WAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACxE,CAAC"}

package/node/wrappers/models/price/price_rules.test.d.ts

@@ -0,0 +1 @@
+export {};

package/node/wrappers/models/price/price_rules.test.js

@@ -0,0 +1,112 @@
+"use strict";
+// LM-289: the shared price rule set. The same table runs in Java, Rust and Python.
+Object.defineProperty(exports, "__esModule", { value: true });
+const price_pb_1 = require("../../../fintekkers/models/price/price_pb");
+const price_type_pb_1 = require("../../../fintekkers/models/price/price_type_pb");
+const security_pb_1 = require("../../../fintekkers/models/security/security_pb");
+const decimal_value_pb_1 = require("../../../fintekkers/models/util/decimal_value_pb");
+const uuid_pb_1 = require("../../../fintekkers/models/util/uuid_pb");
+const errors_1 = require("../errors");
+const uuid_1 = require("../utils/uuid");
+const price_rules_1 = require("./price_rules");
+const PRICE_ID = '6a1d2c3e-4b5f-4a6d-8e7f-9a0b1c2d3e4f';
+const SECURITY_ID = '1f0e8a4c-58b1-4d0e-9a3c-7d2b6e5f4a10';
+function decimal(value) {
+    return new decimal_value_pb_1.DecimalValueProto().setArbitraryPrecisionValue(value);
+}
+/** A price that passes every rule. */
+function valid() {
+    return new price_pb_1.PriceProto()
+        .setUuid(new uuid_1.UUID(uuid_1.UUID.fromString(PRICE_ID)).toUUIDProto())
+        .setSecurity(new security_pb_1.SecurityProto().setUuid(new uuid_1.UUID(uuid_1.UUID.fromString(SECURITY_ID)).toUUIDProto()))
+        .setPrice(decimal('100.25'))
+        .setPriceType(price_type_pb_1.PriceTypeProto.PERCENTAGE);
+}
+/** `valid()` with `change` applied; the generated clear* setters return void. */
+function validWith(change) {
+    const p = valid();
+    change(p);
+    return p;
+}
+function fields(proto) {
+    return (0, price_rules_1.validate)(proto).map(v => v.getField());
+}
+describe('price_rules.validate', () => {
+    test('security absent gives one violation on security', () => {
+        expect(fields(validWith(p => p.clearSecurity()))).toEqual(['security']);
+    });
+    test('empty security uuid gives one violation on security', () => {
+        expect(fields(valid().setSecurity(new security_pb_1.SecurityProto().setUuid(new uuid_pb_1.UUIDProto())))).toEqual(['security']);
+    });
+    test('security present but uuid unset gives one violation on security', () => {
+        expect(fields(valid().setSecurity(new security_pb_1.SecurityProto()))).toEqual(['security']);
+    });
+    test('price absent gives one violation on price', () => {
+        expect(fields(validWith(p => p.clearPrice()))).toEqual(['price']);
+    });
+    test('empty price gives one violation on price', () => {
+        expect(fields(valid().setPrice(decimal('')))).toEqual(['price']);
+    });
+    test('zero price is valid', () => {
+        expect(fields(valid().setPrice(decimal('0')))).toEqual([]);
+    });
+    test.each(['-1', 'abc'])('price value %s is not checked', value => {
+        expect(fields(valid().setPrice(decimal(value)))).toEqual([]);
+    });
+    test('UNKNOWN_PRICE_TYPE gives one violation on price_type', () => {
+        expect(fields(valid().setPriceType(price_type_pb_1.PriceTypeProto.UNKNOWN_PRICE_TYPE))).toEqual(['price_type']);
+    });
+    test('unrecognised price_type is valid', () => {
+        expect(fields(valid().setPriceType(99))).toEqual([]);
+    });
+    test('all three problems give three violations in field order', () => {
+        const proto = validWith(p => { p.clearSecurity(); p.clearPrice(); p.setPriceType(price_type_pb_1.PriceTypeProto.UNKNOWN_PRICE_TYPE); });
+        const violations = (0, price_rules_1.validate)(proto);
+        expect(violations.map(v => v.getField())).toEqual(['security', 'price', 'price_type']);
+        for (const v of violations) {
+            expect(uuid_1.UUID.fromU8Array(v.getObjectId().getRawUuid_asU8()).toString()).toBe(PRICE_ID);
+        }
+    });
+    test('every known price type is valid', () => {
+        const values = Object.values(price_type_pb_1.PriceTypeProto).filter((v) => typeof v === 'number');
+        expect(values).toContain(price_type_pb_1.PriceTypeProto.PERCENTAGE);
+        for (const value of values) {
+            if (value === price_type_pb_1.PriceTypeProto.UNKNOWN_PRICE_TYPE)
+                continue;
+            expect(fields(valid().setPriceType(value))).toEqual([]);
+        }
+    });
+    test('empty, null or undefined proto gives three violations without throwing', () => {
+        const expected = ['security', 'price', 'price_type'];
+        expect(fields(new price_pb_1.PriceProto())).toEqual(expected);
+        expect(fields(null)).toEqual(expected);
+        expect(fields(undefined)).toEqual(expected);
+        expect((0, price_rules_1.validate)(null)[0].hasObjectId()).toBe(false);
+    });
+});
+describe('price_rules.requireValid', () => {
+    test('throws the typed error carrying the violations', () => {
+        const proto = validWith(p => p.clearPrice());
+        let err;
+        try {
+            (0, price_rules_1.requireValid)(proto);
+        }
+        catch (e) {
+            err = e;
+        }
+        expect(err).toBeInstanceOf(errors_1.ModelValidationError);
+        expect(err.violations.map(v => v.getField())).toEqual(['price']);
+        expect(() => (0, price_rules_1.requireValid)(valid())).not.toThrow();
+    });
+});
+describe('the published (compiled) price_rules.js', () => {
+    // npm publish runs no tsc: the tracked .js is what consumers get.
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const compiled = require('./price_rules.js');
+    test('all three problems give three violations in field order', () => {
+        const proto = validWith(p => { p.clearSecurity(); p.clearPrice(); p.setPriceType(price_type_pb_1.PriceTypeProto.UNKNOWN_PRICE_TYPE); });
+        const violations = compiled.validate(proto);
+        expect(violations.map(v => v.getField())).toEqual(['security', 'price', 'price_type']);
+    });
+});
+//# sourceMappingURL=price_rules.test.js.map

package/node/wrappers/models/price/price_rules.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"price_rules.test.js","sourceRoot":"","sources":["price_rules.test.ts"],"names":[],"mappings":";AAAA,mFAAmF;;AAEnF,wEAAuE;AACvE,kFAAgF;AAChF,iFAAgF;AAChF,uFAAqF;AACrF,qEAAoE;AACpE,sCAAiD;AACjD,wCAAqC;AACrC,+CAAuD;AAEvD,MAAM,QAAQ,GAAG,sCAAsC,CAAC;AACxD,MAAM,WAAW,GAAG,sCAAsC,CAAC;AAE3D,SAAS,OAAO,CAAC,KAAa;IAC1B,OAAO,IAAI,oCAAiB,EAAE,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;AACrE,CAAC;AAED,sCAAsC;AACtC,SAAS,KAAK;IACV,OAAO,IAAI,qBAAU,EAAE;SAClB,OAAO,CAAC,IAAI,WAAI,CAAC,WAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;SAC1D,WAAW,CAAC,IAAI,2BAAa,EAAE,CAAC,OAAO,CAAC,IAAI,WAAI,CAAC,WAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;SAC9F,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;SAC3B,YAAY,CAAC,8BAAc,CAAC,UAAU,CAAC,CAAC;AACjD,CAAC;AAED,iFAAiF;AACjF,SAAS,SAAS,CAAC,MAA+B;IAC9C,MAAM,CAAC,GAAG,KAAK,EAAE,CAAC;IAClB,MAAM,CAAC,CAAC,CAAC,CAAC;IACV,OAAO,CAAC,CAAC;AACb,CAAC;AAED,SAAS,MAAM,CAAC,KAAoC;IAChD,OAAO,IAAA,sBAAQ,EAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;AAClD,CAAC;AAED,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IAClC,IAAI,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC7D,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,IAAI,2BAAa,EAAE,CAAC,OAAO,CAAC,IAAI,mBAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;IAC5G,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,IAAI,2BAAa,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;IACnF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,qBAAqB,EAAE,GAAG,EAAE;QAC7B,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,+BAA+B,EAAE,KAAK,CAAC,EAAE;QAC9D,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,YAAY,CAAC,8BAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;IACpG,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,YAAY,CAAC,EAAoB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,yDAAyD,EAAE,GAAG,EAAE;QACjE,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,8BAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACxH,MAAM,UAAU,GAAG,IAAA,sBAAQ,EAAC,KAAK,CAAC,CAAC;QACnC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;QACvF,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE;YACxB,MAAM,CAAC,WAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,EAAG,CAAC,eAAe,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAC1F;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,8BAAc,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAuB,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC;QACvG,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,8BAAc,CAAC,UAAU,CAAC,CAAC;QACpD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;YACxB,IAAI,KAAK,KAAK,8BAAc,CAAC,kBAAkB;gBAAE,SAAS;YAC1D,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;SAC3D;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wEAAwE,EAAE,GAAG,EAAE;QAChF,MAAM,QAAQ,GAAG,CAAC,UAAU,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;QACrD,MAAM,CAAC,MAAM,CAAC,IAAI,qBAAU,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACnD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC5C,MAAM,CAAC,IAAA,sBAAQ,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACtC,IAAI,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC;QAC7C,IAAI,GAAY,CAAC;QACjB,IAAI;YACA,IAAA,0BAAY,EAAC,KAAK,CAAC,CAAC;SACvB;QAAC,OAAO,CAAC,EAAE;YACR,GAAG,GAAG,CAAC,CAAC;SACX;QACD,MAAM,CAAC,GAAG,CAAC,CAAC,cAAc,CAAC,6BAAoB,CAAC,CAAC;QACjD,MAAM,CAAE,GAA4B,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QAC3F,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,0BAAY,EAAC,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACtD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,yCAAyC,EAAE,GAAG,EAAE;IACrD,kEAAkE;IAClE,8DAA8D;IAC9D,MAAM,QAAQ,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAE7C,IAAI,CAAC,yDAAyD,EAAE,GAAG,EAAE;QACjE,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,8BAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACxH,MAAM,UAAU,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAA6B,CAAC;QACxE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;IAC3F,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/node/wrappers/models/price/price_rules.test.ts

@@ -0,0 +1,128 @@
+// LM-289: the shared price rule set. The same table runs in Java, Rust and Python.
+
+import { PriceProto } from '../../../fintekkers/models/price/price_pb';
+import { PriceTypeProto } from '../../../fintekkers/models/price/price_type_pb';
+import { SecurityProto } from '../../../fintekkers/models/security/security_pb';
+import { DecimalValueProto } from '../../../fintekkers/models/util/decimal_value_pb';
+import { UUIDProto } from '../../../fintekkers/models/util/uuid_pb';
+import { ModelValidationError } from '../errors';
+import { UUID } from '../utils/uuid';
+import { requireValid, validate } from './price_rules';
+
+const PRICE_ID = '6a1d2c3e-4b5f-4a6d-8e7f-9a0b1c2d3e4f';
+const SECURITY_ID = '1f0e8a4c-58b1-4d0e-9a3c-7d2b6e5f4a10';
+
+function decimal(value: string): DecimalValueProto {
+    return new DecimalValueProto().setArbitraryPrecisionValue(value);
+}
+
+/** A price that passes every rule. */
+function valid(): PriceProto {
+    return new PriceProto()
+        .setUuid(new UUID(UUID.fromString(PRICE_ID)).toUUIDProto())
+        .setSecurity(new SecurityProto().setUuid(new UUID(UUID.fromString(SECURITY_ID)).toUUIDProto()))
+        .setPrice(decimal('100.25'))
+        .setPriceType(PriceTypeProto.PERCENTAGE);
+}
+
+/** `valid()` with `change` applied; the generated clear* setters return void. */
+function validWith(change: (p: PriceProto) => void): PriceProto {
+    const p = valid();
+    change(p);
+    return p;
+}
+
+function fields(proto: PriceProto | null | undefined): string[] {
+    return validate(proto).map(v => v.getField());
+}
+
+describe('price_rules.validate', () => {
+    test('security absent gives one violation on security', () => {
+        expect(fields(validWith(p => p.clearSecurity()))).toEqual(['security']);
+    });
+
+    test('empty security uuid gives one violation on security', () => {
+        expect(fields(valid().setSecurity(new SecurityProto().setUuid(new UUIDProto())))).toEqual(['security']);
+    });
+
+    test('security present but uuid unset gives one violation on security', () => {
+        expect(fields(valid().setSecurity(new SecurityProto()))).toEqual(['security']);
+    });
+
+    test('price absent gives one violation on price', () => {
+        expect(fields(validWith(p => p.clearPrice()))).toEqual(['price']);
+    });
+
+    test('empty price gives one violation on price', () => {
+        expect(fields(valid().setPrice(decimal('')))).toEqual(['price']);
+    });
+
+    test('zero price is valid', () => {
+        expect(fields(valid().setPrice(decimal('0')))).toEqual([]);
+    });
+
+    test.each(['-1', 'abc'])('price value %s is not checked', value => {
+        expect(fields(valid().setPrice(decimal(value)))).toEqual([]);
+    });
+
+    test('UNKNOWN_PRICE_TYPE gives one violation on price_type', () => {
+        expect(fields(valid().setPriceType(PriceTypeProto.UNKNOWN_PRICE_TYPE))).toEqual(['price_type']);
+    });
+
+    test('unrecognised price_type is valid', () => {
+        expect(fields(valid().setPriceType(99 as PriceTypeProto))).toEqual([]);
+    });
+
+    test('all three problems give three violations in field order', () => {
+        const proto = validWith(p => { p.clearSecurity(); p.clearPrice(); p.setPriceType(PriceTypeProto.UNKNOWN_PRICE_TYPE); });
+        const violations = validate(proto);
+        expect(violations.map(v => v.getField())).toEqual(['security', 'price', 'price_type']);
+        for (const v of violations) {
+            expect(UUID.fromU8Array(v.getObjectId()!.getRawUuid_asU8()).toString()).toBe(PRICE_ID);
+        }
+    });
+
+    test('every known price type is valid', () => {
+        const values = Object.values(PriceTypeProto).filter((v): v is PriceTypeProto => typeof v === 'number');
+        expect(values).toContain(PriceTypeProto.PERCENTAGE);
+        for (const value of values) {
+            if (value === PriceTypeProto.UNKNOWN_PRICE_TYPE) continue;
+            expect(fields(valid().setPriceType(value))).toEqual([]);
+        }
+    });
+
+    test('empty, null or undefined proto gives three violations without throwing', () => {
+        const expected = ['security', 'price', 'price_type'];
+        expect(fields(new PriceProto())).toEqual(expected);
+        expect(fields(null)).toEqual(expected);
+        expect(fields(undefined)).toEqual(expected);
+        expect(validate(null)[0].hasObjectId()).toBe(false);
+    });
+});
+
+describe('price_rules.requireValid', () => {
+    test('throws the typed error carrying the violations', () => {
+        const proto = validWith(p => p.clearPrice());
+        let err: unknown;
+        try {
+            requireValid(proto);
+        } catch (e) {
+            err = e;
+        }
+        expect(err).toBeInstanceOf(ModelValidationError);
+        expect((err as ModelValidationError).violations.map(v => v.getField())).toEqual(['price']);
+        expect(() => requireValid(valid())).not.toThrow();
+    });
+});
+
+describe('the published (compiled) price_rules.js', () => {
+    // npm publish runs no tsc: the tracked .js is what consumers get.
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const compiled = require('./price_rules.js');
+
+    test('all three problems give three violations in field order', () => {
+        const proto = validWith(p => { p.clearSecurity(); p.clearPrice(); p.setPriceType(PriceTypeProto.UNKNOWN_PRICE_TYPE); });
+        const violations = compiled.validate(proto) as { getField(): string }[];
+        expect(violations.map(v => v.getField())).toEqual(['security', 'price', 'price_type']);
+    });
+});

package/node/wrappers/models/price/price_rules.ts

@@ -0,0 +1,50 @@
+import { PriceProto } from '../../../fintekkers/models/price/price_pb';
+import { PriceTypeProto } from '../../../fintekkers/models/price/price_type_pb';
+import { FieldViolationProto } from '../../../fintekkers/requests/util/errors/field_violation_pb';
+import { ModelValidationError, violation } from '../errors';
+import { UUID } from '../utils/uuid';
+
+/**
+ * Price input rules (LM-289): JS counterpart of Java's PriceRules
+ * (docs/adr/typed-input-errors.md). Pure: proto in, violations out.
+ *
+ * Three rules, checked in this order: `security` has a non-empty UUID,
+ * `price` has a non-empty arbitrary_precision_value (zero is valid, see the
+ * PriceProto comment), and `price_type` is not UNKNOWN_PRICE_TYPE. The price
+ * value is not parsed. Never throws on bad or unset input; null or undefined
+ * is checked as an empty PriceProto. Unlike security_rules, a link price is
+ * not skipped: hydrate it first. The Price wrapper does not call these rules.
+ */
+
+export const SECURITY = 'security';
+export const PRICE = 'price';
+export const PRICE_TYPE = 'price_type';
+
+/** Returns every field-level violation on this price, or an empty array when it is valid. */
+export function validate(proto: PriceProto | null | undefined): FieldViolationProto[] {
+    const p = proto ?? new PriceProto();
+    const id = objectIdOf(p);
+    const out: FieldViolationProto[] = [];
+    if (!p.getSecurity()?.getUuid()?.getRawUuid_asU8().length) {
+        out.push(violation(SECURITY, id, 'security with a non-empty uuid is required'));
+    }
+    if (!p.getPrice()?.getArbitraryPrecisionValue()) {
+        out.push(violation(PRICE, id, 'price is required'));
+    }
+    if (p.getPriceType() === PriceTypeProto.UNKNOWN_PRICE_TYPE) {
+        out.push(violation(PRICE_TYPE, id, 'price_type must not be UNKNOWN_PRICE_TYPE'));
+    }
+    return out;
+}
+
+/** Throws ModelValidationError carrying every violation if `validate` finds any. */
+export function requireValid(proto: PriceProto | null | undefined): void {
+    const violations = validate(proto);
+    if (violations.length > 0) throw new ModelValidationError(violations);
+}
+
+/** The price's UUID, or undefined when it has none or it is not 16 bytes. */
+function objectIdOf(proto: PriceProto): UUID | undefined {
+    const raw = proto.getUuid()?.getRawUuid_asU8();
+    return raw && raw.length === 16 ? UUID.fromU8Array(raw) : undefined;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@fintekkers/ledger-models",
   "todo": "Replace the version with build script version number",
-  "version": "0.4.31",
+  "version": "0.4.32",
   "description": "ledger model protos ",
   "authors": [
     "David Doherty",