@fintekkers/ledger-models 0.1.136 → 0.1.138

package/node/wrappers/models/position/measure.d.ts

@@ -0,0 +1,29 @@
+import { MeasureProto } from '../../../fintekkers/models/position/measure_pb';
+/**
+ * Static helpers around the MeasureProto enum, mirroring the wrapper pattern
+ * shipped in v0.1.133–v0.1.135 (PRs #188 Identifier, #189 SecurityType +
+ * AssetClass, #190 PositionFilterOperator).
+ *
+ * Strict: takes / returns proto enum NAMES ("PRESENT_VALUE",
+ * "MODIFIED_DURATION", ...). Consumers (including UI URL conventions and
+ * dropdown labels) should standardize on proto names — ledger-models is
+ * the source-of-truth vocabulary and should not absorb consumer-side
+ * naming conventions. See FinTekkers/ui-service#149 for the consumer
+ * surface that motivated this wrapper.
+ */
+export declare class Measure {
+    /**
+     * Returns the names of all known MeasureProto values, EXCLUDING the
+     * sentinel `UNKNOWN_MEASURE`. Drives UI dropdowns / pickers so adding
+     * a new proto enum variant auto-propagates to consumers.
+     *
+     * Order matches proto declaration order.
+     */
+    static getAllTypeNames(): string[];
+    /**
+     * Resolve a proto enum NAME (e.g., "PRESENT_VALUE", "DIRTY_PRICE") to
+     * its numeric MeasureProto value. Throws on unknown name; the error
+     * lists the valid names so typos are fixable without grepping the proto.
+     */
+    static fromName(name: string): MeasureProto;
+}

package/node/wrappers/models/position/measure.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Measure = void 0;
+const measure_pb_1 = require("../../../fintekkers/models/position/measure_pb");
+/**
+ * Static helpers around the MeasureProto enum, mirroring the wrapper pattern
+ * shipped in v0.1.133–v0.1.135 (PRs #188 Identifier, #189 SecurityType +
+ * AssetClass, #190 PositionFilterOperator).
+ *
+ * Strict: takes / returns proto enum NAMES ("PRESENT_VALUE",
+ * "MODIFIED_DURATION", ...). Consumers (including UI URL conventions and
+ * dropdown labels) should standardize on proto names — ledger-models is
+ * the source-of-truth vocabulary and should not absorb consumer-side
+ * naming conventions. See FinTekkers/ui-service#149 for the consumer
+ * surface that motivated this wrapper.
+ */
+class Measure {
+    /**
+     * Returns the names of all known MeasureProto values, EXCLUDING the
+     * sentinel `UNKNOWN_MEASURE`. Drives UI dropdowns / pickers so adding
+     * a new proto enum variant auto-propagates to consumers.
+     *
+     * Order matches proto declaration order.
+     */
+    static getAllTypeNames() {
+        return Object.keys(measure_pb_1.MeasureProto).filter(k => k !== 'UNKNOWN_MEASURE');
+    }
+    /**
+     * Resolve a proto enum NAME (e.g., "PRESENT_VALUE", "DIRTY_PRICE") to
+     * its numeric MeasureProto value. Throws on unknown name; the error
+     * lists the valid names so typos are fixable without grepping the proto.
+     */
+    static fromName(name) {
+        const enumObj = measure_pb_1.MeasureProto;
+        const enumValue = enumObj[name];
+        if (enumValue === undefined) {
+            throw new Error(`Unknown Measure name: '${name}'. Valid names: ${Measure.getAllTypeNames().join(', ')}`);
+        }
+        return enumValue;
+    }
+}
+exports.Measure = Measure;
+//# sourceMappingURL=measure.js.map

package/node/wrappers/models/position/measure.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"measure.js","sourceRoot":"","sources":["measure.ts"],"names":[],"mappings":";;;AAAA,+EAA8E;AAE9E;;;;;;;;;;;GAWG;AACH,MAAa,OAAO;IAEhB;;;;;;OAMG;IACH,MAAM,CAAC,eAAe;QAClB,OAAO,MAAM,CAAC,IAAI,CAAC,yBAAY,CAAC,CAAC,MAAM,CACnC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,iBAAiB,CAC/B,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAY;QACxB,MAAM,OAAO,GAAG,yBAAiD,CAAC;QAClE,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAChC,IAAI,SAAS,KAAK,SAAS,EAAE;YACzB,MAAM,IAAI,KAAK,CACX,0BAA0B,IAAI,mBAAmB,OAAO,CAAC,eAAe,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC1F,CAAC;SACL;QACD,OAAO,SAAyB,CAAC;IACrC,CAAC;CACJ;AA9BD,0BA8BC"}

package/node/wrappers/models/position/measure.test.d.ts

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

package/node/wrappers/models/position/measure.test.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const measure_1 = require("./measure");
+const measure_pb_1 = require("../../../fintekkers/models/position/measure_pb");
+describe('Measure.fromName', () => {
+    test.each(measure_1.Measure.getAllTypeNames())('fromName("%s") returns the matching numeric enum value', (name) => {
+        const value = measure_1.Measure.fromName(name);
+        const expected = measure_pb_1.MeasureProto[name];
+        expect(value).toBe(expected);
+    });
+    test('throws on unknown name and lists valid names in the error', () => {
+        let err;
+        try {
+            measure_1.Measure.fromName('NOT_A_REAL_MEASURE');
+        }
+        catch (e) {
+            err = e;
+        }
+        expect(err).toBeDefined();
+        expect(err.message).toContain('NOT_A_REAL_MEASURE');
+        // Hint with known valid entries.
+        expect(err.message).toContain('PRESENT_VALUE');
+        expect(err.message).toContain('DIRTY_PRICE');
+    });
+    test('throws on lowercase / friendly-label input (proto-name strict)', () => {
+        // ledger-models is the source-of-truth vocabulary; consumers
+        // (UI dropdown labels, URL params) standardize on proto names.
+        // Pin the strict behavior so this contract is loudly tested.
+        expect(() => measure_1.Measure.fromName('present_value')).toThrow();
+        expect(() => measure_1.Measure.fromName('Dirty Price')).toThrow();
+    });
+    test('accepts UNKNOWN_MEASURE — sentinel is a valid enum key', () => {
+        // Excluded from getAllTypeNames (no dropdown surface) but still a
+        // valid proto enum value. Mirrors Identifier / SecurityType /
+        // AssetClass / PositionFilterOperator behavior.
+        expect(measure_1.Measure.fromName('UNKNOWN_MEASURE')).toBe(measure_pb_1.MeasureProto.UNKNOWN_MEASURE);
+    });
+});
+describe('Measure.getAllTypeNames', () => {
+    test('returns the expected set in proto-declaration order, excluding UNKNOWN_MEASURE', () => {
+        // Proto-declared order in measure.proto (post-PR #192 additions):
+        //   UNKNOWN_MEASURE = 0;             (excluded)
+        //   DIRECTED_QUANTITY = 1;
+        //   MARKET_VALUE = 2;
+        //   UNADJUSTED_COST_BASIS = 3;
+        //   ADJUSTED_COST_BASIS = 4;
+        //   CURRENT_YIELD = 5;
+        //   YIELD_TO_MATURITY = 7;           (note: no tag 6)
+        //   MACAULAY_DURATION = 8;
+        //   PRESENT_VALUE = 9;
+        //   REAL_YIELD = 10;
+        //   INFLATION_ADJUSTED_PRINCIPAL = 11;
+        //   PRESENT_VALUE_CASHFLOWS = 12;
+        //   DISCOUNT_MARGIN = 13;
+        //   SPREAD_DURATION = 14;
+        //   PAR_YIELD = 15;
+        //   SPOT_YIELD = 16;
+        //   FORWARD_YIELD = 17;
+        //   PROFIT_LOSS = 18;
+        //   PROFIT_LOSS_PERCENT = 19;
+        //   ACCRUED_INTEREST = 20;
+        //   CONVEXITY = 21;
+        //   DIRTY_PRICE = 22;
+        //   CLEAN_PRICE = 23;
+        //   MODIFIED_DURATION = 24;
+        //   DV01 = 25;
+        expect(measure_1.Measure.getAllTypeNames()).toEqual([
+            'DIRECTED_QUANTITY',
+            'MARKET_VALUE',
+            'UNADJUSTED_COST_BASIS',
+            'ADJUSTED_COST_BASIS',
+            'CURRENT_YIELD',
+            'YIELD_TO_MATURITY',
+            'MACAULAY_DURATION',
+            'PRESENT_VALUE',
+            'REAL_YIELD',
+            'INFLATION_ADJUSTED_PRINCIPAL',
+            'PRESENT_VALUE_CASHFLOWS',
+            'DISCOUNT_MARGIN',
+            'SPREAD_DURATION',
+            'PAR_YIELD',
+            'SPOT_YIELD',
+            'FORWARD_YIELD',
+            'PROFIT_LOSS',
+            'PROFIT_LOSS_PERCENT',
+            'ACCRUED_INTEREST',
+            'CONVEXITY',
+            'DIRTY_PRICE',
+            'CLEAN_PRICE',
+            'MODIFIED_DURATION',
+            'DV01',
+        ]);
+    });
+    test('excludes the UNKNOWN_MEASURE sentinel', () => {
+        expect(measure_1.Measure.getAllTypeNames()).not.toContain('UNKNOWN_MEASURE');
+    });
+});
+//# sourceMappingURL=measure.test.js.map

package/node/wrappers/models/position/measure.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"measure.test.js","sourceRoot":"","sources":["measure.test.ts"],"names":[],"mappings":";;AAAA,uCAAoC;AACpC,+EAA8E;AAE9E,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAC9B,IAAI,CAAC,IAAI,CAAC,iBAAO,CAAC,eAAe,EAAE,CAAC,CAChC,wDAAwD,EACxD,CAAC,IAAY,EAAE,EAAE;QACb,MAAM,KAAK,GAAG,iBAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,QAAQ,GAAI,yBAAkD,CAAC,IAAI,CAAC,CAAC;QAC3E,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC,CACJ,CAAC;IAEF,IAAI,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,IAAI,GAAsB,CAAC;QAC3B,IAAI;YACA,iBAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC;SAC1C;QAAC,OAAO,CAAC,EAAE;YACR,GAAG,GAAG,CAAU,CAAC;SACpB;QACD,MAAM,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;QAC1B,MAAM,CAAC,GAAI,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;QACrD,iCAAiC;QACjC,MAAM,CAAC,GAAI,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAChD,MAAM,CAAC,GAAI,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,6DAA6D;QAC7D,+DAA+D;QAC/D,6DAA6D;QAC7D,MAAM,CAAC,GAAG,EAAE,CAAC,iBAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QAC1D,MAAM,CAAC,GAAG,EAAE,CAAC,iBAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAChE,kEAAkE;QAClE,8DAA8D;QAC9D,gDAAgD;QAChD,MAAM,CAAC,iBAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAC5C,yBAAY,CAAC,eAAe,CAC/B,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACrC,IAAI,CAAC,gFAAgF,EAAE,GAAG,EAAE;QACxF,kEAAkE;QAClE,gDAAgD;QAChD,2BAA2B;QAC3B,sBAAsB;QACtB,+BAA+B;QAC/B,6BAA6B;QAC7B,uBAAuB;QACvB,sDAAsD;QACtD,2BAA2B;QAC3B,uBAAuB;QACvB,qBAAqB;QACrB,uCAAuC;QACvC,kCAAkC;QAClC,0BAA0B;QAC1B,0BAA0B;QAC1B,oBAAoB;QACpB,qBAAqB;QACrB,wBAAwB;QACxB,sBAAsB;QACtB,8BAA8B;QAC9B,2BAA2B;QAC3B,oBAAoB;QACpB,sBAAsB;QACtB,sBAAsB;QACtB,4BAA4B;QAC5B,eAAe;QACf,MAAM,CAAC,iBAAO,CAAC,eAAe,EAAE,CAAC,CAAC,OAAO,CAAC;YACtC,mBAAmB;YACnB,cAAc;YACd,uBAAuB;YACvB,qBAAqB;YACrB,eAAe;YACf,mBAAmB;YACnB,mBAAmB;YACnB,eAAe;YACf,YAAY;YACZ,8BAA8B;YAC9B,yBAAyB;YACzB,iBAAiB;YACjB,iBAAiB;YACjB,WAAW;YACX,YAAY;YACZ,eAAe;YACf,aAAa;YACb,qBAAqB;YACrB,kBAAkB;YAClB,WAAW;YACX,aAAa;YACb,aAAa;YACb,mBAAmB;YACnB,MAAM;SACT,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,CAAC,iBAAO,CAAC,eAAe,EAAE,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/node/wrappers/models/position/measure.test.ts

@@ -0,0 +1,105 @@
+import { Measure } from './measure';
+import { MeasureProto } from '../../../fintekkers/models/position/measure_pb';
+
+describe('Measure.fromName', () => {
+    test.each(Measure.getAllTypeNames())(
+        'fromName("%s") returns the matching numeric enum value',
+        (name: string) => {
+            const value = Measure.fromName(name);
+            const expected = (MeasureProto as unknown as Record<string, number>)[name];
+            expect(value).toBe(expected);
+        }
+    );
+
+    test('throws on unknown name and lists valid names in the error', () => {
+        let err: Error | undefined;
+        try {
+            Measure.fromName('NOT_A_REAL_MEASURE');
+        } catch (e) {
+            err = e as Error;
+        }
+        expect(err).toBeDefined();
+        expect(err!.message).toContain('NOT_A_REAL_MEASURE');
+        // Hint with known valid entries.
+        expect(err!.message).toContain('PRESENT_VALUE');
+        expect(err!.message).toContain('DIRTY_PRICE');
+    });
+
+    test('throws on lowercase / friendly-label input (proto-name strict)', () => {
+        // ledger-models is the source-of-truth vocabulary; consumers
+        // (UI dropdown labels, URL params) standardize on proto names.
+        // Pin the strict behavior so this contract is loudly tested.
+        expect(() => Measure.fromName('present_value')).toThrow();
+        expect(() => Measure.fromName('Dirty Price')).toThrow();
+    });
+
+    test('accepts UNKNOWN_MEASURE — sentinel is a valid enum key', () => {
+        // Excluded from getAllTypeNames (no dropdown surface) but still a
+        // valid proto enum value. Mirrors Identifier / SecurityType /
+        // AssetClass / PositionFilterOperator behavior.
+        expect(Measure.fromName('UNKNOWN_MEASURE')).toBe(
+            MeasureProto.UNKNOWN_MEASURE
+        );
+    });
+});
+
+describe('Measure.getAllTypeNames', () => {
+    test('returns the expected set in proto-declaration order, excluding UNKNOWN_MEASURE', () => {
+        // Proto-declared order in measure.proto (post-PR #192 additions):
+        //   UNKNOWN_MEASURE = 0;             (excluded)
+        //   DIRECTED_QUANTITY = 1;
+        //   MARKET_VALUE = 2;
+        //   UNADJUSTED_COST_BASIS = 3;
+        //   ADJUSTED_COST_BASIS = 4;
+        //   CURRENT_YIELD = 5;
+        //   YIELD_TO_MATURITY = 7;           (note: no tag 6)
+        //   MACAULAY_DURATION = 8;
+        //   PRESENT_VALUE = 9;
+        //   REAL_YIELD = 10;
+        //   INFLATION_ADJUSTED_PRINCIPAL = 11;
+        //   PRESENT_VALUE_CASHFLOWS = 12;
+        //   DISCOUNT_MARGIN = 13;
+        //   SPREAD_DURATION = 14;
+        //   PAR_YIELD = 15;
+        //   SPOT_YIELD = 16;
+        //   FORWARD_YIELD = 17;
+        //   PROFIT_LOSS = 18;
+        //   PROFIT_LOSS_PERCENT = 19;
+        //   ACCRUED_INTEREST = 20;
+        //   CONVEXITY = 21;
+        //   DIRTY_PRICE = 22;
+        //   CLEAN_PRICE = 23;
+        //   MODIFIED_DURATION = 24;
+        //   DV01 = 25;
+        expect(Measure.getAllTypeNames()).toEqual([
+            'DIRECTED_QUANTITY',
+            'MARKET_VALUE',
+            'UNADJUSTED_COST_BASIS',
+            'ADJUSTED_COST_BASIS',
+            'CURRENT_YIELD',
+            'YIELD_TO_MATURITY',
+            'MACAULAY_DURATION',
+            'PRESENT_VALUE',
+            'REAL_YIELD',
+            'INFLATION_ADJUSTED_PRINCIPAL',
+            'PRESENT_VALUE_CASHFLOWS',
+            'DISCOUNT_MARGIN',
+            'SPREAD_DURATION',
+            'PAR_YIELD',
+            'SPOT_YIELD',
+            'FORWARD_YIELD',
+            'PROFIT_LOSS',
+            'PROFIT_LOSS_PERCENT',
+            'ACCRUED_INTEREST',
+            'CONVEXITY',
+            'DIRTY_PRICE',
+            'CLEAN_PRICE',
+            'MODIFIED_DURATION',
+            'DV01',
+        ]);
+    });
+
+    test('excludes the UNKNOWN_MEASURE sentinel', () => {
+        expect(Measure.getAllTypeNames()).not.toContain('UNKNOWN_MEASURE');
+    });
+});

package/node/wrappers/models/position/measure.ts

@@ -0,0 +1,45 @@
+import { MeasureProto } from '../../../fintekkers/models/position/measure_pb';
+
+/**
+ * Static helpers around the MeasureProto enum, mirroring the wrapper pattern
+ * shipped in v0.1.133–v0.1.135 (PRs #188 Identifier, #189 SecurityType +
+ * AssetClass, #190 PositionFilterOperator).
+ *
+ * Strict: takes / returns proto enum NAMES ("PRESENT_VALUE",
+ * "MODIFIED_DURATION", ...). Consumers (including UI URL conventions and
+ * dropdown labels) should standardize on proto names — ledger-models is
+ * the source-of-truth vocabulary and should not absorb consumer-side
+ * naming conventions. See FinTekkers/ui-service#149 for the consumer
+ * surface that motivated this wrapper.
+ */
+export class Measure {
+
+    /**
+     * Returns the names of all known MeasureProto values, EXCLUDING the
+     * sentinel `UNKNOWN_MEASURE`. Drives UI dropdowns / pickers so adding
+     * a new proto enum variant auto-propagates to consumers.
+     *
+     * Order matches proto declaration order.
+     */
+    static getAllTypeNames(): string[] {
+        return Object.keys(MeasureProto).filter(
+            k => k !== 'UNKNOWN_MEASURE'
+        );
+    }
+
+    /**
+     * Resolve a proto enum NAME (e.g., "PRESENT_VALUE", "DIRTY_PRICE") to
+     * its numeric MeasureProto value. Throws on unknown name; the error
+     * lists the valid names so typos are fixable without grepping the proto.
+     */
+    static fromName(name: string): MeasureProto {
+        const enumObj = MeasureProto as unknown as Record<string, number>;
+        const enumValue = enumObj[name];
+        if (enumValue === undefined) {
+            throw new Error(
+                `Unknown Measure name: '${name}'. Valid names: ${Measure.getAllTypeNames().join(', ')}`
+            );
+        }
+        return enumValue as MeasureProto;
+    }
+}

package/package.json

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