@fintekkers/ledger-models 0.1.119 → 0.1.129

package/node/wrappers/models/transaction/transaction.d.ts

@@ -10,9 +10,23 @@ import { ZonedDateTime } from "../utils/datetime";
 import { UUID } from "../utils/uuid";
 import { LocalDate } from "../utils/date";
 import { Decimal } from "decimal.js";
+interface TransactionConstructorParams {
+    tradeDate: Date;
+    settlementDate: Date;
+    asOfDate: Date;
+    price: Decimal;
+    security: Security;
+    transactionType: TransactionType;
+    portfolio: Portfolio;
+    quantity: Decimal;
+}
 declare class Transaction {
     proto: TransactionProto;
-    constructor(proto: TransactionProto);
+    constructor(protoOrParams: TransactionProto | TransactionConstructorParams);
+    /**
+     * Builds a complete TransactionProto from constructor parameters
+     */
+    private buildProtoFromParams;
     toString(): string;
     getFields(): FieldProto[];
     getField(field: FieldProto): any;
@@ -31,6 +45,50 @@ declare class Transaction {
     getTradeName(): string;
     getPositionStatus(): PositionStatusProto;
     getChildrenTransactions(): TransactionProto[];
+    /**
+     * Adds a child transaction to this transaction's proto
+     * @param child - The child transaction to add
+     */
+    addChildTransaction(child: Transaction): void;
+    /**
+     * Checks if this transaction's security is cash
+     * @returns true if the security is cash, false otherwise
+     */
+    isCashSecurity(): boolean;
+    /**
+     * Searches child transactions for a cash transaction
+     * @returns The cash transaction if found, null otherwise
+     */
+    getCashTransaction(): Transaction | null;
     equals(other: Transaction): boolean;
+    /**
+     * Creates a cash transaction associated with a parent transaction.
+     * The cash transaction represents the cash impact of the parent transaction.
+     * @param cashSecurity - The cash security (e.g., USD)
+     * @param parentTransaction - The parent transaction for which to create the cash transaction
+     * @returns The created cash transaction
+     */
+    static createCashTransaction(cashSecurity: Security, parentTransaction: Transaction): Transaction;
+    /**
+     * Creates a maturation transaction for a bond.
+     * @param transaction - The parent transaction (must be for a bond security)
+     * @param transactionType - The transaction type (MATURATION or MATURATION_OFFSET)
+     * @param cashSecurity - The cash security to use for the cash impact
+     */
+    static addMaturationTransaction(transaction: Transaction, transactionType: TransactionType, cashSecurity: Security): void;
+    /**
+     * Generates additional transactions associated with this transaction.
+     * For instance, a Buy transaction on a bond will also create the maturation transaction.
+     * @param transaction - The parent transaction
+     * @param cashSecurity - The cash security to use for cash impacts
+     */
+    static addDerivedTransactions(transaction: Transaction, cashSecurity: Security): void;
+    /**
+     * Adds a cash impact transaction to this transaction.
+     * If the transaction's security is not cash, creates a cash transaction.
+     * @param transaction - The transaction to add cash impact to
+     * @param cashSecurity - The cash security (e.g., USD) to use for the cash transaction
+     */
+    static addCashImpact(transaction: Transaction, cashSecurity: Security): void;
 }
 export default Transaction;

package/node/wrappers/models/transaction/transaction.derived.test.d.ts

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

package/node/wrappers/models/transaction/transaction.derived.test.js

@@ -0,0 +1,199 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const assert = require("assert");
+const transaction_1 = __importDefault(require("./transaction"));
+const transaction_type_1 = require("./transaction_type");
+const transaction_type_pb_1 = require("../../../fintekkers/models/transaction/transaction_type_pb");
+const security_1 = __importDefault(require("../security/security"));
+const security_pb_1 = require("../../../fintekkers/models/security/security_pb");
+const security_type_pb_1 = require("../../../fintekkers/models/security/security_type_pb");
+const local_date_pb_1 = require("../../../fintekkers/models/util/local_date_pb");
+const decimal_value_pb_1 = require("../../../fintekkers/models/util/decimal_value_pb");
+const security_quantity_type_pb_1 = require("../../../fintekkers/models/security/security_quantity_type_pb");
+const coupon_frequency_pb_1 = require("../../../fintekkers/models/security/coupon_frequency_pb");
+const coupon_type_pb_1 = require("../../../fintekkers/models/security/coupon_type_pb");
+const uuid_1 = require("../utils/uuid");
+const datetime_1 = require("../utils/datetime");
+const decimal_js_1 = require("decimal.js");
+const portfolio_test_1 = require("../portfolio/portfolio.test");
+test('test Transaction createCashTransaction', () => {
+    testCreateCashTransaction();
+});
+test('test Transaction addMaturationTransaction', () => {
+    testAddMaturationTransaction();
+});
+test('test Transaction addDerivedTransactions', () => {
+    testAddDerivedTransactions();
+});
+test('test Transaction addCashImpact', () => {
+    testAddCashImpact();
+});
+test('test Transaction helper methods', () => {
+    testHelperMethods();
+});
+function testCreateCashTransaction() {
+    // Test BUY transaction -> WITHDRAWAL
+    const buyTransaction = createBondTransaction(transaction_type_pb_1.TransactionTypeProto.BUY);
+    const cashSecurity = createCashSecurity();
+    const cashTransaction = transaction_1.default.createCashTransaction(cashSecurity, buyTransaction);
+    assert(cashTransaction.getTransactionType().proto === transaction_type_pb_1.TransactionTypeProto.WITHDRAWAL, 'BUY transaction should create WITHDRAWAL cash transaction');
+    assert(cashTransaction.getSecurity().proto.getSecurityType() === security_type_pb_1.SecurityTypeProto.CASH_SECURITY, 'Cash transaction should have cash security');
+    assert(buyTransaction.getChildrenTransactions().length === 1, 'Parent transaction should have one child');
+    const foundCash = buyTransaction.getCashTransaction();
+    assert(foundCash !== null && foundCash.getID().toString() === cashTransaction.getID().toString(), 'getCashTransaction should return the created cash transaction');
+    // Test SELL transaction -> DEPOSIT
+    const sellTransaction = createBondTransaction(transaction_type_pb_1.TransactionTypeProto.SELL);
+    const cashTransaction2 = transaction_1.default.createCashTransaction(cashSecurity, sellTransaction);
+    assert(cashTransaction2.getTransactionType().proto === transaction_type_pb_1.TransactionTypeProto.DEPOSIT, 'SELL transaction should create DEPOSIT cash transaction');
+}
+function testAddMaturationTransaction() {
+    const bondTransaction = createBondTransaction(transaction_type_pb_1.TransactionTypeProto.BUY);
+    const maturationType = new transaction_type_1.TransactionType(transaction_type_pb_1.TransactionTypeProto.MATURATION);
+    const cashSecurity = createCashSecurity();
+    transaction_1.default.addMaturationTransaction(bondTransaction, maturationType, cashSecurity);
+    const children = bondTransaction.getChildrenTransactions();
+    assert(children.length === 1, 'Should have one child transaction');
+    const maturation = new transaction_1.default(children[0]);
+    assert(maturation.getTransactionType().proto === transaction_type_pb_1.TransactionTypeProto.MATURATION, 'Child should be MATURATION transaction');
+    assert(maturation.getSecurity().getID().toString() === bondTransaction.getSecurity().getID().toString(), 'Maturation should have same security');
+    assert(maturation.getQuantity().equals(bondTransaction.getQuantity()), 'Maturation should have same quantity');
+}
+function testAddDerivedTransactions() {
+    const cashSecurity = createCashSecurity();
+    // Test BUY bond transaction -> should add MATURATION
+    const buyTransaction = createBondTransaction(transaction_type_pb_1.TransactionTypeProto.BUY);
+    transaction_1.default.addDerivedTransactions(buyTransaction, cashSecurity);
+    const children = buyTransaction.getChildrenTransactions();
+    assert(children.length === 1, 'BUY bond should have one derived transaction');
+    const maturation = new transaction_1.default(children[0]);
+    assert(maturation.getTransactionType().proto === transaction_type_pb_1.TransactionTypeProto.MATURATION, 'BUY bond should create MATURATION transaction');
+    // Test SELL bond transaction -> should add MATURATION_OFFSET
+    const sellTransaction = createBondTransaction(transaction_type_pb_1.TransactionTypeProto.SELL);
+    transaction_1.default.addDerivedTransactions(sellTransaction, cashSecurity);
+    const children2 = sellTransaction.getChildrenTransactions();
+    assert(children2.length === 1, 'SELL bond should have one derived transaction');
+    const maturationOffset = new transaction_1.default(children2[0]);
+    assert(maturationOffset.getTransactionType().proto === transaction_type_pb_1.TransactionTypeProto.MATURATION_OFFSET, 'SELL bond should create MATURATION_OFFSET transaction');
+    // Test non-bond transaction -> should not add derived transactions
+    const equityTransaction = createEquityTransaction();
+    transaction_1.default.addDerivedTransactions(equityTransaction, cashSecurity);
+    assert(equityTransaction.getChildrenTransactions().length === 0, 'Non-bond transaction should not have derived transactions');
+}
+function testAddCashImpact() {
+    const bondTransaction = createBondTransaction(transaction_type_pb_1.TransactionTypeProto.BUY);
+    const cashSecurity = createCashSecurity();
+    transaction_1.default.addCashImpact(bondTransaction, cashSecurity);
+    assert(bondTransaction.getCashTransaction() !== null, 'Transaction should have cash transaction after addCashImpact');
+    // Test that adding cash impact twice throws error
+    try {
+        transaction_1.default.addCashImpact(bondTransaction, cashSecurity);
+        assert(false, 'Should throw error when cash transaction already exists');
+    }
+    catch (e) {
+        assert(e instanceof Error && e.message.includes('already has a cash impact'), 'Should throw error about existing cash impact');
+    }
+    // Test that cash security transaction doesn't create cash impact
+    const cashTransaction = createCashTransaction();
+    transaction_1.default.addCashImpact(cashTransaction, cashSecurity);
+    assert(cashTransaction.getChildrenTransactions().length === 0, 'Cash security transaction should not create cash impact');
+}
+function testHelperMethods() {
+    const transaction = createBondTransaction(transaction_type_pb_1.TransactionTypeProto.BUY);
+    // Test isCashSecurity
+    assert(!transaction.isCashSecurity(), 'Bond transaction should not be cash security');
+    const cashTransaction = createCashTransaction();
+    assert(cashTransaction.isCashSecurity(), 'Cash transaction should be cash security');
+    // Test addChildTransaction
+    const child = createBondTransaction(transaction_type_pb_1.TransactionTypeProto.SELL);
+    transaction.addChildTransaction(child);
+    assert(transaction.getChildrenTransactions().length === 1, 'Should have one child after addChildTransaction');
+    // Test getCashTransaction
+    const cashSecurity = createCashSecurity();
+    const cashTxn = transaction_1.default.createCashTransaction(cashSecurity, transaction);
+    const foundCash = transaction.getCashTransaction();
+    assert(foundCash !== null && foundCash.getID().toString() === cashTxn.getID().toString(), 'getCashTransaction should find the cash child transaction');
+}
+function createBondTransaction(transactionType) {
+    const security = createBondSecurity();
+    const portfolio = (0, portfolio_test_1.dummyPortfolio)();
+    const tradeDate = new Date(2024, 0, 15);
+    const settlementDate = new Date(2024, 0, 17);
+    const asOfDate = new Date(2024, 0, 15, 10, 30, 0);
+    const price = new decimal_js_1.Decimal('99.50');
+    const quantity = new decimal_js_1.Decimal('1000.00');
+    return new transaction_1.default({
+        tradeDate,
+        settlementDate,
+        asOfDate,
+        price,
+        security,
+        transactionType: new transaction_type_1.TransactionType(transactionType),
+        portfolio,
+        quantity
+    });
+}
+function createBondSecurity() {
+    return security_1.default.create(new security_pb_1.SecurityProto()
+        .setObjectClass('Security')
+        .setVersion('0.0.1')
+        .setUuid(uuid_1.UUID.random().toUUIDProto())
+        .setSecurityType(security_type_pb_1.SecurityTypeProto.BOND_SECURITY)
+        .setFaceValue(new decimal_value_pb_1.DecimalValueProto().setArbitraryPrecisionValue('1000.00'))
+        .setQuantityType(security_quantity_type_pb_1.SecurityQuantityTypeProto.ORIGINAL_FACE_VALUE)
+        .setAssetClass('FixedIncome')
+        .setIssuerName('Test Issuer')
+        .setCouponRate(new decimal_value_pb_1.DecimalValueProto().setArbitraryPrecisionValue('0.05'))
+        .setCouponFrequency(coupon_frequency_pb_1.CouponFrequencyProto.SEMIANNUALLY)
+        .setCouponType(coupon_type_pb_1.CouponTypeProto.FIXED)
+        .setMaturityDate(new local_date_pb_1.LocalDateProto().setYear(2034).setMonth(1).setDay(1))
+        .setIssueDate(new local_date_pb_1.LocalDateProto().setYear(2024).setMonth(1).setDay(1))
+        .setAsOf(datetime_1.ZonedDateTime.now().toProto())
+        .setDescription('Test bond security'));
+}
+function createEquityTransaction() {
+    const security = security_1.default.create(new security_pb_1.SecurityProto()
+        .setObjectClass('Security')
+        .setVersion('0.0.1')
+        .setUuid(uuid_1.UUID.random().toUUIDProto())
+        .setSecurityType(security_type_pb_1.SecurityTypeProto.EQUITY_SECURITY)
+        .setAssetClass('Equity')
+        .setAsOf(datetime_1.ZonedDateTime.now().toProto()));
+    const portfolio = (0, portfolio_test_1.dummyPortfolio)();
+    return new transaction_1.default({
+        tradeDate: new Date(2024, 0, 15),
+        settlementDate: new Date(2024, 0, 17),
+        asOfDate: new Date(2024, 0, 15, 10, 30, 0),
+        price: new decimal_js_1.Decimal('100.00'),
+        security,
+        transactionType: new transaction_type_1.TransactionType(transaction_type_pb_1.TransactionTypeProto.BUY),
+        portfolio,
+        quantity: new decimal_js_1.Decimal('100.00')
+    });
+}
+function createCashSecurity() {
+    return security_1.default.create(new security_pb_1.SecurityProto()
+        .setObjectClass('Security')
+        .setVersion('0.0.1')
+        .setUuid(uuid_1.UUID.random().toUUIDProto())
+        .setSecurityType(security_type_pb_1.SecurityTypeProto.CASH_SECURITY)
+        .setAssetClass('Cash')
+        .setAsOf(datetime_1.ZonedDateTime.now().toProto()));
+}
+function createCashTransaction() {
+    const cashSecurity = createCashSecurity();
+    const portfolio = (0, portfolio_test_1.dummyPortfolio)();
+    return new transaction_1.default({
+        tradeDate: new Date(2024, 0, 15),
+        settlementDate: new Date(2024, 0, 17),
+        asOfDate: new Date(2024, 0, 15, 10, 30, 0),
+        price: new decimal_js_1.Decimal('1.0'),
+        security: cashSecurity,
+        transactionType: new transaction_type_1.TransactionType(transaction_type_pb_1.TransactionTypeProto.DEPOSIT),
+        portfolio,
+        quantity: new decimal_js_1.Decimal('1000.00')
+    });
+}
+//# sourceMappingURL=transaction.derived.test.js.map

package/node/wrappers/models/transaction/transaction.derived.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.derived.test.js","sourceRoot":"","sources":["transaction.derived.test.ts"],"names":[],"mappings":";;;;;AAAA,iCAAkC;AAClC,gEAAwC;AACxC,yDAAqD;AACrD,oGAAkG;AAElG,oEAA4C;AAE5C,iFAAgF;AAChF,2FAAyF;AACzF,iFAA+E;AAC/E,uFAAqF;AACrF,6GAA0G;AAC1G,iGAA+F;AAC/F,uFAAqF;AACrF,wCAAqC;AACrC,gDAAkD;AAClD,2CAAqC;AACrC,gEAA6D;AAE7D,IAAI,CAAC,wCAAwC,EAAE,GAAG,EAAE;IAChD,yBAAyB,EAAE,CAAC;AAChC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;IACnD,4BAA4B,EAAE,CAAC;AACnC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,yCAAyC,EAAE,GAAG,EAAE;IACjD,0BAA0B,EAAE,CAAC;AACjC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,gCAAgC,EAAE,GAAG,EAAE;IACxC,iBAAiB,EAAE,CAAC;AACxB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,iCAAiC,EAAE,GAAG,EAAE;IACzC,iBAAiB,EAAE,CAAC;AACxB,CAAC,CAAC,CAAC;AAEH,SAAS,yBAAyB;IAC9B,qCAAqC;IACrC,MAAM,cAAc,GAAG,qBAAqB,CAAC,0CAAoB,CAAC,GAAG,CAAC,CAAC;IACvE,MAAM,YAAY,GAAG,kBAAkB,EAAE,CAAC;IAE1C,MAAM,eAAe,GAAG,qBAAW,CAAC,qBAAqB,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;IAExF,MAAM,CAAC,eAAe,CAAC,kBAAkB,EAAE,CAAC,KAAK,KAAK,0CAAoB,CAAC,UAAU,EACjF,2DAA2D,CAAC,CAAC;IACjE,MAAM,CAAC,eAAe,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,oCAAiB,CAAC,aAAa,EAC5F,4CAA4C,CAAC,CAAC;IAClD,MAAM,CAAC,cAAc,CAAC,uBAAuB,EAAE,CAAC,MAAM,KAAK,CAAC,EACxD,0CAA0C,CAAC,CAAC;IAChD,MAAM,SAAS,GAAG,cAAc,CAAC,kBAAkB,EAAE,CAAC;IACtD,MAAM,CAAC,SAAS,KAAK,IAAI,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,KAAK,eAAe,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,EAC5F,+DAA+D,CAAC,CAAC;IAErE,mCAAmC;IACnC,MAAM,eAAe,GAAG,qBAAqB,CAAC,0CAAoB,CAAC,IAAI,CAAC,CAAC;IACzE,MAAM,gBAAgB,GAAG,qBAAW,CAAC,qBAAqB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;IAE1F,MAAM,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,CAAC,KAAK,KAAK,0CAAoB,CAAC,OAAO,EAC/E,yDAAyD,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,4BAA4B;IACjC,MAAM,eAAe,GAAG,qBAAqB,CAAC,0CAAoB,CAAC,GAAG,CAAC,CAAC;IACxE,MAAM,cAAc,GAAG,IAAI,kCAAe,CAAC,0CAAoB,CAAC,UAAU,CAAC,CAAC;IAC5E,MAAM,YAAY,GAAG,kBAAkB,EAAE,CAAC;IAE1C,qBAAW,CAAC,wBAAwB,CAAC,eAAe,EAAE,cAAc,EAAE,YAAY,CAAC,CAAC;IAEpF,MAAM,QAAQ,GAAG,eAAe,CAAC,uBAAuB,EAAE,CAAC;IAC3D,MAAM,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,mCAAmC,CAAC,CAAC;IAEnE,MAAM,UAAU,GAAG,IAAI,qBAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,MAAM,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAC,KAAK,KAAK,0CAAoB,CAAC,UAAU,EAC5E,wCAAwC,CAAC,CAAC;IAC9C,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,KAAK,eAAe,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,EACnG,sCAAsC,CAAC,CAAC;IAC5C,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,WAAW,EAAE,CAAC,EACjE,sCAAsC,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,0BAA0B;IAC/B,MAAM,YAAY,GAAG,kBAAkB,EAAE,CAAC;IAE1C,qDAAqD;IACrD,MAAM,cAAc,GAAG,qBAAqB,CAAC,0CAAoB,CAAC,GAAG,CAAC,CAAC;IACvE,qBAAW,CAAC,sBAAsB,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;IAEjE,MAAM,QAAQ,GAAG,cAAc,CAAC,uBAAuB,EAAE,CAAC;IAC1D,MAAM,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,8CAA8C,CAAC,CAAC;IAC9E,MAAM,UAAU,GAAG,IAAI,qBAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,MAAM,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAC,KAAK,KAAK,0CAAoB,CAAC,UAAU,EAC5E,+CAA+C,CAAC,CAAC;IAErD,6DAA6D;IAC7D,MAAM,eAAe,GAAG,qBAAqB,CAAC,0CAAoB,CAAC,IAAI,CAAC,CAAC;IACzE,qBAAW,CAAC,sBAAsB,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;IAElE,MAAM,SAAS,GAAG,eAAe,CAAC,uBAAuB,EAAE,CAAC;IAC5D,MAAM,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,+CAA+C,CAAC,CAAC;IAChF,MAAM,gBAAgB,GAAG,IAAI,qBAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,MAAM,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,CAAC,KAAK,KAAK,0CAAoB,CAAC,iBAAiB,EACzF,uDAAuD,CAAC,CAAC;IAE7D,mEAAmE;IACnE,MAAM,iBAAiB,GAAG,uBAAuB,EAAE,CAAC;IACpD,qBAAW,CAAC,sBAAsB,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;IACpE,MAAM,CAAC,iBAAiB,CAAC,uBAAuB,EAAE,CAAC,MAAM,KAAK,CAAC,EAC3D,2DAA2D,CAAC,CAAC;AACrE,CAAC;AAED,SAAS,iBAAiB;IACtB,MAAM,eAAe,GAAG,qBAAqB,CAAC,0CAAoB,CAAC,GAAG,CAAC,CAAC;IACxE,MAAM,YAAY,GAAG,kBAAkB,EAAE,CAAC;IAE1C,qBAAW,CAAC,aAAa,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;IAEzD,MAAM,CAAC,eAAe,CAAC,kBAAkB,EAAE,KAAK,IAAI,EAChD,8DAA8D,CAAC,CAAC;IAEpE,kDAAkD;IAClD,IAAI;QACA,qBAAW,CAAC,aAAa,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;QACzD,MAAM,CAAC,KAAK,EAAE,yDAAyD,CAAC,CAAC;KAC5E;IAAC,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,CAAC,YAAY,KAAK,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAC,EACxE,+CAA+C,CAAC,CAAC;KACxD;IAED,iEAAiE;IACjE,MAAM,eAAe,GAAG,qBAAqB,EAAE,CAAC;IAChD,qBAAW,CAAC,aAAa,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;IACzD,MAAM,CAAC,eAAe,CAAC,uBAAuB,EAAE,CAAC,MAAM,KAAK,CAAC,EACzD,yDAAyD,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,iBAAiB;IACtB,MAAM,WAAW,GAAG,qBAAqB,CAAC,0CAAoB,CAAC,GAAG,CAAC,CAAC;IAEpE,sBAAsB;IACtB,MAAM,CAAC,CAAC,WAAW,CAAC,cAAc,EAAE,EAAE,8CAA8C,CAAC,CAAC;IAEtF,MAAM,eAAe,GAAG,qBAAqB,EAAE,CAAC;IAChD,MAAM,CAAC,eAAe,CAAC,cAAc,EAAE,EAAE,0CAA0C,CAAC,CAAC;IAErF,2BAA2B;IAC3B,MAAM,KAAK,GAAG,qBAAqB,CAAC,0CAAoB,CAAC,IAAI,CAAC,CAAC;IAC/D,WAAW,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACvC,MAAM,CAAC,WAAW,CAAC,uBAAuB,EAAE,CAAC,MAAM,KAAK,CAAC,EACrD,iDAAiD,CAAC,CAAC;IAEvD,0BAA0B;IAC1B,MAAM,YAAY,GAAG,kBAAkB,EAAE,CAAC;IAC1C,MAAM,OAAO,GAAG,qBAAW,CAAC,qBAAqB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;IAC7E,MAAM,SAAS,GAAG,WAAW,CAAC,kBAAkB,EAAE,CAAC;IACnD,MAAM,CAAC,SAAS,KAAK,IAAI,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,KAAK,OAAO,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,EACpF,2DAA2D,CAAC,CAAC;AACrE,CAAC;AAED,SAAS,qBAAqB,CAAC,eAAqC;IAChE,MAAM,QAAQ,GAAG,kBAAkB,EAAE,CAAC;IACtC,MAAM,SAAS,GAAG,IAAA,+BAAc,GAAE,CAAC;IACnC,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACxC,MAAM,cAAc,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IAClD,MAAM,KAAK,GAAG,IAAI,oBAAO,CAAC,OAAO,CAAC,CAAC;IACnC,MAAM,QAAQ,GAAG,IAAI,oBAAO,CAAC,SAAS,CAAC,CAAC;IAExC,OAAO,IAAI,qBAAW,CAAC;QACnB,SAAS;QACT,cAAc;QACd,QAAQ;QACR,KAAK;QACL,QAAQ;QACR,eAAe,EAAE,IAAI,kCAAe,CAAC,eAAe,CAAC;QACrD,SAAS;QACT,QAAQ;KACX,CAAC,CAAC;AACP,CAAC;AAED,SAAS,kBAAkB;IACvB,OAAO,kBAAQ,CAAC,MAAM,CAAC,IAAI,2BAAa,EAAE;SACrC,cAAc,CAAC,UAAU,CAAC;SAC1B,UAAU,CAAC,OAAO,CAAC;SACnB,OAAO,CAAC,WAAI,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC;SACpC,eAAe,CAAC,oCAAiB,CAAC,aAAa,CAAC;SAChD,YAAY,CAAC,IAAI,oCAAiB,EAAE,CAAC,0BAA0B,CAAC,SAAS,CAAC,CAAC;SAC3E,eAAe,CAAC,qDAAyB,CAAC,mBAAmB,CAAC;SAC9D,aAAa,CAAC,aAAa,CAAC;SAC5B,aAAa,CAAC,aAAa,CAAC;SAC5B,aAAa,CAAC,IAAI,oCAAiB,EAAE,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC;SACzE,kBAAkB,CAAC,0CAAoB,CAAC,YAAY,CAAC;SACrD,aAAa,CAAC,gCAAe,CAAC,KAAK,CAAC;SACpC,eAAe,CAAC,IAAI,8BAAc,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;SACzE,YAAY,CAAC,IAAI,8BAAc,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;SACtE,OAAO,CAAC,wBAAa,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;SACtC,cAAc,CAAC,oBAAoB,CAAC,CACxC,CAAC;AACN,CAAC;AAED,SAAS,uBAAuB;IAC5B,MAAM,QAAQ,GAAG,kBAAQ,CAAC,MAAM,CAAC,IAAI,2BAAa,EAAE;SAC/C,cAAc,CAAC,UAAU,CAAC;SAC1B,UAAU,CAAC,OAAO,CAAC;SACnB,OAAO,CAAC,WAAI,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC;SACpC,eAAe,CAAC,oCAAiB,CAAC,eAAe,CAAC;SAClD,aAAa,CAAC,QAAQ,CAAC;SACvB,OAAO,CAAC,wBAAa,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAC1C,CAAC;IACF,MAAM,SAAS,GAAG,IAAA,+BAAc,GAAE,CAAC;IAEnC,OAAO,IAAI,qBAAW,CAAC;QACnB,SAAS,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;QAChC,cAAc,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,QAAQ,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAC1C,KAAK,EAAE,IAAI,oBAAO,CAAC,QAAQ,CAAC;QAC5B,QAAQ;QACR,eAAe,EAAE,IAAI,kCAAe,CAAC,0CAAoB,CAAC,GAAG,CAAC;QAC9D,SAAS;QACT,QAAQ,EAAE,IAAI,oBAAO,CAAC,QAAQ,CAAC;KAClC,CAAC,CAAC;AACP,CAAC;AAED,SAAS,kBAAkB;IACvB,OAAO,kBAAQ,CAAC,MAAM,CAAC,IAAI,2BAAa,EAAE;SACrC,cAAc,CAAC,UAAU,CAAC;SAC1B,UAAU,CAAC,OAAO,CAAC;SACnB,OAAO,CAAC,WAAI,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC;SACpC,eAAe,CAAC,oCAAiB,CAAC,aAAa,CAAC;SAChD,aAAa,CAAC,MAAM,CAAC;SACrB,OAAO,CAAC,wBAAa,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAC1C,CAAC;AACN,CAAC;AAED,SAAS,qBAAqB;IAC1B,MAAM,YAAY,GAAG,kBAAkB,EAAE,CAAC;IAC1C,MAAM,SAAS,GAAG,IAAA,+BAAc,GAAE,CAAC;IAEnC,OAAO,IAAI,qBAAW,CAAC;QACnB,SAAS,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;QAChC,cAAc,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,QAAQ,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAC1C,KAAK,EAAE,IAAI,oBAAO,CAAC,KAAK,CAAC;QACzB,QAAQ,EAAE,YAAY;QACtB,eAAe,EAAE,IAAI,kCAAe,CAAC,0CAAoB,CAAC,OAAO,CAAC;QAClE,SAAS;QACT,QAAQ,EAAE,IAAI,oBAAO,CAAC,SAAS,CAAC;KACnC,CAAC,CAAC;AACP,CAAC"}

package/node/wrappers/models/transaction/transaction.derived.test.ts

@@ -0,0 +1,251 @@
+import assert = require('assert');
+import Transaction from './transaction';
+import { TransactionType } from './transaction_type';
+import { TransactionTypeProto } from '../../../fintekkers/models/transaction/transaction_type_pb';
+import { PositionStatusProto } from '../../../fintekkers/models/position/position_status_pb';
+import Security from '../security/security';
+import Portfolio from '../portfolio/portfolio';
+import { SecurityProto } from '../../../fintekkers/models/security/security_pb';
+import { SecurityTypeProto } from '../../../fintekkers/models/security/security_type_pb';
+import { LocalDateProto } from '../../../fintekkers/models/util/local_date_pb';
+import { DecimalValueProto } from '../../../fintekkers/models/util/decimal_value_pb';
+import { SecurityQuantityTypeProto } from '../../../fintekkers/models/security/security_quantity_type_pb';
+import { CouponFrequencyProto } from '../../../fintekkers/models/security/coupon_frequency_pb';
+import { CouponTypeProto } from '../../../fintekkers/models/security/coupon_type_pb';
+import { UUID } from '../utils/uuid';
+import { ZonedDateTime } from '../utils/datetime';
+import { Decimal } from 'decimal.js';
+import { dummyPortfolio } from '../portfolio/portfolio.test';
+
+test('test Transaction createCashTransaction', () => {
+    testCreateCashTransaction();
+});
+
+test('test Transaction addMaturationTransaction', () => {
+    testAddMaturationTransaction();
+});
+
+test('test Transaction addDerivedTransactions', () => {
+    testAddDerivedTransactions();
+});
+
+test('test Transaction addCashImpact', () => {
+    testAddCashImpact();
+});
+
+test('test Transaction helper methods', () => {
+    testHelperMethods();
+});
+
+function testCreateCashTransaction(): void {
+    // Test BUY transaction -> WITHDRAWAL
+    const buyTransaction = createBondTransaction(TransactionTypeProto.BUY);
+    const cashSecurity = createCashSecurity();
+    
+    const cashTransaction = Transaction.createCashTransaction(cashSecurity, buyTransaction);
+    
+    assert(cashTransaction.getTransactionType().proto === TransactionTypeProto.WITHDRAWAL,
+        'BUY transaction should create WITHDRAWAL cash transaction');
+    assert(cashTransaction.getSecurity().proto.getSecurityType() === SecurityTypeProto.CASH_SECURITY,
+        'Cash transaction should have cash security');
+    assert(buyTransaction.getChildrenTransactions().length === 1,
+        'Parent transaction should have one child');
+    const foundCash = buyTransaction.getCashTransaction();
+    assert(foundCash !== null && foundCash.getID().toString() === cashTransaction.getID().toString(),
+        'getCashTransaction should return the created cash transaction');
+    
+    // Test SELL transaction -> DEPOSIT
+    const sellTransaction = createBondTransaction(TransactionTypeProto.SELL);
+    const cashTransaction2 = Transaction.createCashTransaction(cashSecurity, sellTransaction);
+    
+    assert(cashTransaction2.getTransactionType().proto === TransactionTypeProto.DEPOSIT,
+        'SELL transaction should create DEPOSIT cash transaction');
+}
+
+function testAddMaturationTransaction(): void {
+    const bondTransaction = createBondTransaction(TransactionTypeProto.BUY);
+    const maturationType = new TransactionType(TransactionTypeProto.MATURATION);
+    const cashSecurity = createCashSecurity();
+    
+    Transaction.addMaturationTransaction(bondTransaction, maturationType, cashSecurity);
+    
+    const children = bondTransaction.getChildrenTransactions();
+    assert(children.length === 1, 'Should have one child transaction');
+    
+    const maturation = new Transaction(children[0]);
+    assert(maturation.getTransactionType().proto === TransactionTypeProto.MATURATION,
+        'Child should be MATURATION transaction');
+    assert(maturation.getSecurity().getID().toString() === bondTransaction.getSecurity().getID().toString(),
+        'Maturation should have same security');
+    assert(maturation.getQuantity().equals(bondTransaction.getQuantity()),
+        'Maturation should have same quantity');
+}
+
+function testAddDerivedTransactions(): void {
+    const cashSecurity = createCashSecurity();
+    
+    // Test BUY bond transaction -> should add MATURATION
+    const buyTransaction = createBondTransaction(TransactionTypeProto.BUY);
+    Transaction.addDerivedTransactions(buyTransaction, cashSecurity);
+    
+    const children = buyTransaction.getChildrenTransactions();
+    assert(children.length === 1, 'BUY bond should have one derived transaction');
+    const maturation = new Transaction(children[0]);
+    assert(maturation.getTransactionType().proto === TransactionTypeProto.MATURATION,
+        'BUY bond should create MATURATION transaction');
+    
+    // Test SELL bond transaction -> should add MATURATION_OFFSET
+    const sellTransaction = createBondTransaction(TransactionTypeProto.SELL);
+    Transaction.addDerivedTransactions(sellTransaction, cashSecurity);
+    
+    const children2 = sellTransaction.getChildrenTransactions();
+    assert(children2.length === 1, 'SELL bond should have one derived transaction');
+    const maturationOffset = new Transaction(children2[0]);
+    assert(maturationOffset.getTransactionType().proto === TransactionTypeProto.MATURATION_OFFSET,
+        'SELL bond should create MATURATION_OFFSET transaction');
+    
+    // Test non-bond transaction -> should not add derived transactions
+    const equityTransaction = createEquityTransaction();
+    Transaction.addDerivedTransactions(equityTransaction, cashSecurity);
+    assert(equityTransaction.getChildrenTransactions().length === 0,
+        'Non-bond transaction should not have derived transactions');
+}
+
+function testAddCashImpact(): void {
+    const bondTransaction = createBondTransaction(TransactionTypeProto.BUY);
+    const cashSecurity = createCashSecurity();
+    
+    Transaction.addCashImpact(bondTransaction, cashSecurity);
+    
+    assert(bondTransaction.getCashTransaction() !== null,
+        'Transaction should have cash transaction after addCashImpact');
+    
+    // Test that adding cash impact twice throws error
+    try {
+        Transaction.addCashImpact(bondTransaction, cashSecurity);
+        assert(false, 'Should throw error when cash transaction already exists');
+    } catch (e) {
+        assert(e instanceof Error && e.message.includes('already has a cash impact'),
+            'Should throw error about existing cash impact');
+    }
+    
+    // Test that cash security transaction doesn't create cash impact
+    const cashTransaction = createCashTransaction();
+    Transaction.addCashImpact(cashTransaction, cashSecurity);
+    assert(cashTransaction.getChildrenTransactions().length === 0,
+        'Cash security transaction should not create cash impact');
+}
+
+function testHelperMethods(): void {
+    const transaction = createBondTransaction(TransactionTypeProto.BUY);
+    
+    // Test isCashSecurity
+    assert(!transaction.isCashSecurity(), 'Bond transaction should not be cash security');
+    
+    const cashTransaction = createCashTransaction();
+    assert(cashTransaction.isCashSecurity(), 'Cash transaction should be cash security');
+    
+    // Test addChildTransaction
+    const child = createBondTransaction(TransactionTypeProto.SELL);
+    transaction.addChildTransaction(child);
+    assert(transaction.getChildrenTransactions().length === 1,
+        'Should have one child after addChildTransaction');
+    
+    // Test getCashTransaction
+    const cashSecurity = createCashSecurity();
+    const cashTxn = Transaction.createCashTransaction(cashSecurity, transaction);
+    const foundCash = transaction.getCashTransaction();
+    assert(foundCash !== null && foundCash.getID().toString() === cashTxn.getID().toString(),
+        'getCashTransaction should find the cash child transaction');
+}
+
+function createBondTransaction(transactionType: TransactionTypeProto): Transaction {
+    const security = createBondSecurity();
+    const portfolio = dummyPortfolio();
+    const tradeDate = new Date(2024, 0, 15);
+    const settlementDate = new Date(2024, 0, 17);
+    const asOfDate = new Date(2024, 0, 15, 10, 30, 0);
+    const price = new Decimal('99.50');
+    const quantity = new Decimal('1000.00');
+    
+    return new Transaction({
+        tradeDate,
+        settlementDate,
+        asOfDate,
+        price,
+        security,
+        transactionType: new TransactionType(transactionType),
+        portfolio,
+        quantity
+    });
+}
+
+function createBondSecurity(): Security {
+    return Security.create(new SecurityProto()
+        .setObjectClass('Security')
+        .setVersion('0.0.1')
+        .setUuid(UUID.random().toUUIDProto())
+        .setSecurityType(SecurityTypeProto.BOND_SECURITY)
+        .setFaceValue(new DecimalValueProto().setArbitraryPrecisionValue('1000.00'))
+        .setQuantityType(SecurityQuantityTypeProto.ORIGINAL_FACE_VALUE)
+        .setAssetClass('FixedIncome')
+        .setIssuerName('Test Issuer')
+        .setCouponRate(new DecimalValueProto().setArbitraryPrecisionValue('0.05'))
+        .setCouponFrequency(CouponFrequencyProto.SEMIANNUALLY)
+        .setCouponType(CouponTypeProto.FIXED)
+        .setMaturityDate(new LocalDateProto().setYear(2034).setMonth(1).setDay(1))
+        .setIssueDate(new LocalDateProto().setYear(2024).setMonth(1).setDay(1))
+        .setAsOf(ZonedDateTime.now().toProto())
+        .setDescription('Test bond security')
+    );
+}
+
+function createEquityTransaction(): Transaction {
+    const security = Security.create(new SecurityProto()
+        .setObjectClass('Security')
+        .setVersion('0.0.1')
+        .setUuid(UUID.random().toUUIDProto())
+        .setSecurityType(SecurityTypeProto.EQUITY_SECURITY)
+        .setAssetClass('Equity')
+        .setAsOf(ZonedDateTime.now().toProto())
+    );
+    const portfolio = dummyPortfolio();
+    
+    return new Transaction({
+        tradeDate: new Date(2024, 0, 15),
+        settlementDate: new Date(2024, 0, 17),
+        asOfDate: new Date(2024, 0, 15, 10, 30, 0),
+        price: new Decimal('100.00'),
+        security,
+        transactionType: new TransactionType(TransactionTypeProto.BUY),
+        portfolio,
+        quantity: new Decimal('100.00')
+    });
+}
+
+function createCashSecurity(): Security {
+    return Security.create(new SecurityProto()
+        .setObjectClass('Security')
+        .setVersion('0.0.1')
+        .setUuid(UUID.random().toUUIDProto())
+        .setSecurityType(SecurityTypeProto.CASH_SECURITY)
+        .setAssetClass('Cash')
+        .setAsOf(ZonedDateTime.now().toProto())
+    );
+}
+
+function createCashTransaction(): Transaction {
+    const cashSecurity = createCashSecurity();
+    const portfolio = dummyPortfolio();
+    
+    return new Transaction({
+        tradeDate: new Date(2024, 0, 15),
+        settlementDate: new Date(2024, 0, 17),
+        asOfDate: new Date(2024, 0, 15, 10, 30, 0),
+        price: new Decimal('1.0'),
+        security: cashSecurity,
+        transactionType: new TransactionType(TransactionTypeProto.DEPOSIT),
+        portfolio,
+        quantity: new Decimal('1000.00')
+    });
+}