@decafhub/decaf-client-extras 0.5.0 → 0.5.1

package/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.5.0"
+  ".": "0.5.1"
 }

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.5.1](https://github.com/teloscube/decaf-client-javascript-extras/compare/v0.5.0...v0.5.1) (2024-08-31)
+
+
+### Bug Fixes
+
+* make grouping option configurable for holdings tree function ([ae97991](https://github.com/teloscube/decaf-client-javascript-extras/commit/ae97991f23393d04d85f782baedbd635a247db88))
+
 ## [0.5.0](https://github.com/teloscube/decaf-client-javascript-extras/compare/v0.4.0...v0.5.0) (2024-08-14)
 
 

package/es/reports/valuation/-valuation-report-holdings-tree/-machinery.d.ts

@@ -1,10 +1,10 @@
 import { Decimal } from '@telostat/prelude';
 import { ValuationReportHolding, ValuationReportHoldingClassification } from '../-valuation-report-shared';
-import { ValuationReportHoldingsTreeNode, ValuationReportHoldingsTreeNodeValue } from './-types';
+import { AvailableAddresserKeys, ValuationReportHoldingsTreeNode, ValuationReportHoldingsTreeNodeValue } from './-types';
 export declare function makeValuationReportHoldingsTreeNodeValue(): ValuationReportHoldingsTreeNodeValue;
 export declare function updateTotals(nav: Decimal, investment: Decimal, tree: ValuationReportHoldingsTreeNode): ValuationReportHoldingsTreeNodeValue;
 export declare function resortChildren(node: ValuationReportHoldingsTreeNode): ValuationReportHoldingsTreeNode[];
 export declare function retreatTree(nav: Decimal, investment: Decimal, tree: ValuationReportHoldingsTreeNode): void;
 export declare function makeValuationReportHoldingsTreeNode(address: ValuationReportHoldingClassification): ValuationReportHoldingsTreeNode;
 export declare function addValuationReportHoldingToTree(tree: ValuationReportHoldingsTreeNode, address: ValuationReportHoldingClassification, holding: ValuationReportHolding): void;
-export declare function makeValuationReportHoldingsTree(nav: Decimal, investment: Decimal, holdings: ValuationReportHolding[]): ValuationReportHoldingsTreeNode;
+export declare function makeValuationReportHoldingsTree(nav: Decimal, investment: Decimal, holdings: ValuationReportHolding[], addressKey?: AvailableAddresserKeys): ValuationReportHoldingsTreeNode;

package/es/reports/valuation/-valuation-report-holdings-tree/-machinery.js

@@ -1,5 +1,5 @@
 import { Just, List, Maybe, Nothing, safeDiv, sumDecimals, Tuple, zero } from '@telostat/prelude';
-import { compareStringArrays } from './-utils';
+import { addressers, compareStringArrays } from './-utils';
 export function makeValuationReportHoldingsTreeNodeValue() {
     return {
         investment: zero,
@@ -102,13 +102,15 @@ export function addValuationReportHoldingToTree(tree, address, holding) {
     // Done, we append the holding to the current node and return from the procedure:
     node.holdings.push(holding);
 }
-export function makeValuationReportHoldingsTree(nav, investment, holdings) {
+export function makeValuationReportHoldingsTree(nav, investment, holdings, addressKey = 'classification') {
     // Initialize the tree:
     const tree = makeValuationReportHoldingsTreeNode([]);
     tree.name = '« Total »';
     // Iterate over the holdings and attempt to add to the tree:
     for (const holding of holdings) {
-        addValuationReportHoldingToTree(tree, holding.classification, holding);
+        // Get the address of the holding:
+        const address = addressers[addressKey](holding);
+        addValuationReportHoldingToTree(tree, address, holding);
     }
     // Retreat the tree:
     retreatTree(nav, investment, tree);

package/es/reports/valuation/-valuation-report-holdings-tree/-types.d.ts

@@ -21,3 +21,6 @@ export interface ValuationReportHoldingsTreeNodeValue {
     pnl: Decimal;
     pnlRatio: Decimal;
 }
+export type HoldingAddress = ValuationReportHoldingClassification;
+export type HoldingAddresser = (holding: ValuationReportHolding) => HoldingAddress;
+export type AvailableAddresserKeys = 'classification' | 'currency' | 'country' | 'issuer' | 'sector';

package/es/reports/valuation/-valuation-report-holdings-tree/-utils.d.ts

@@ -1 +1,7 @@
+import { Maybe } from '@telostat/prelude';
+import { ValuationReportHolding } from '../-valuation-report-shared';
+import { AvailableAddresserKeys, HoldingAddresser } from './-types';
 export declare function compareStringArrays(x: string[], y: string[]): number;
+export declare function composeHoldingAddressers(addressers: Array<HoldingAddresser>): HoldingAddresser;
+export declare function makeSimpleAddresser(def: string, labeler: (holding: ValuationReportHolding) => Maybe<string>): HoldingAddresser;
+export declare const addressers: Record<AvailableAddresserKeys, HoldingAddresser>;

package/es/reports/valuation/-valuation-report-holdings-tree/-utils.js

@@ -10,3 +10,32 @@ export function compareStringArrays(x, y) {
     }
     return Math.sign(xLen - yLen);
 }
+export function composeHoldingAddressers(addressers) {
+    return (holding) => addressers.reduce((p, c) => [...p, ...c(holding)], []);
+}
+export function makeSimpleAddresser(def, labeler) {
+    return (holding) => {
+        // Attempt to get the label:
+        const label = labeler(holding).orDefault('') || def;
+        // Get the value:
+        const value = label.toUpperCase();
+        // Done, return:
+        return [{ name: value, order: value }];
+    };
+}
+export const addressers = {
+    classification: (holding) => {
+        // Get the classification:
+        const classification = holding.classification;
+        // Build the address and return:
+        return classification.map((x) => ({
+            // label: x.name,
+            name: x.name.toUpperCase(),
+            order: `${x.order}`.toUpperCase(),
+        }));
+    },
+    currency: makeSimpleAddresser('[Undefined Currency]', (holding) => holding.artifact.ccy),
+    country: makeSimpleAddresser('[Undefined Country]', (holding) => holding.artifact.country),
+    issuer: makeSimpleAddresser('[Undefined Issuer]', (holding) => holding.artifact.issuer),
+    sector: makeSimpleAddresser('[Undefined Sector]', (holding) => holding.artifact.sector),
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decafhub/decaf-client-extras",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "DECAF Client Extras",
   "author": "Teloscube Pte Ltd",
   "license": "MIT",

package/reports/valuation/-valuation-report-holdings-tree/-machinery.d.ts

@@ -1,10 +1,10 @@
 import { Decimal } from '@telostat/prelude';
 import { ValuationReportHolding, ValuationReportHoldingClassification } from '../-valuation-report-shared';
-import { ValuationReportHoldingsTreeNode, ValuationReportHoldingsTreeNodeValue } from './-types';
+import { AvailableAddresserKeys, ValuationReportHoldingsTreeNode, ValuationReportHoldingsTreeNodeValue } from './-types';
 export declare function makeValuationReportHoldingsTreeNodeValue(): ValuationReportHoldingsTreeNodeValue;
 export declare function updateTotals(nav: Decimal, investment: Decimal, tree: ValuationReportHoldingsTreeNode): ValuationReportHoldingsTreeNodeValue;
 export declare function resortChildren(node: ValuationReportHoldingsTreeNode): ValuationReportHoldingsTreeNode[];
 export declare function retreatTree(nav: Decimal, investment: Decimal, tree: ValuationReportHoldingsTreeNode): void;
 export declare function makeValuationReportHoldingsTreeNode(address: ValuationReportHoldingClassification): ValuationReportHoldingsTreeNode;
 export declare function addValuationReportHoldingToTree(tree: ValuationReportHoldingsTreeNode, address: ValuationReportHoldingClassification, holding: ValuationReportHolding): void;
-export declare function makeValuationReportHoldingsTree(nav: Decimal, investment: Decimal, holdings: ValuationReportHolding[]): ValuationReportHoldingsTreeNode;
+export declare function makeValuationReportHoldingsTree(nav: Decimal, investment: Decimal, holdings: ValuationReportHolding[], addressKey?: AvailableAddresserKeys): ValuationReportHoldingsTreeNode;

package/reports/valuation/-valuation-report-holdings-tree/-machinery.js

@@ -165,8 +165,9 @@ function addValuationReportHoldingToTree(tree, address, holding) {
     node.holdings.push(holding);
 }
 exports.addValuationReportHoldingToTree = addValuationReportHoldingToTree;
-function makeValuationReportHoldingsTree(nav, investment, holdings) {
+function makeValuationReportHoldingsTree(nav, investment, holdings, addressKey) {
     var e_2, _a;
+    if (addressKey === void 0) { addressKey = 'classification'; }
     // Initialize the tree:
     var tree = makeValuationReportHoldingsTreeNode([]);
     tree.name = '« Total »';
@@ -174,7 +175,9 @@ function makeValuationReportHoldingsTree(nav, investment, holdings) {
         // Iterate over the holdings and attempt to add to the tree:
         for (var holdings_1 = __values(holdings), holdings_1_1 = holdings_1.next(); !holdings_1_1.done; holdings_1_1 = holdings_1.next()) {
             var holding = holdings_1_1.value;
-            addValuationReportHoldingToTree(tree, holding.classification, holding);
+            // Get the address of the holding:
+            var address = _utils_1.addressers[addressKey](holding);
+            addValuationReportHoldingToTree(tree, address, holding);
         }
     }
     catch (e_2_1) { e_2 = { error: e_2_1 }; }

package/reports/valuation/-valuation-report-holdings-tree/-types.d.ts

@@ -21,3 +21,6 @@ export interface ValuationReportHoldingsTreeNodeValue {
     pnl: Decimal;
     pnlRatio: Decimal;
 }
+export type HoldingAddress = ValuationReportHoldingClassification;
+export type HoldingAddresser = (holding: ValuationReportHolding) => HoldingAddress;
+export type AvailableAddresserKeys = 'classification' | 'currency' | 'country' | 'issuer' | 'sector';

package/reports/valuation/-valuation-report-holdings-tree/-utils.d.ts

@@ -1 +1,7 @@
+import { Maybe } from '@telostat/prelude';
+import { ValuationReportHolding } from '../-valuation-report-shared';
+import { AvailableAddresserKeys, HoldingAddresser } from './-types';
 export declare function compareStringArrays(x: string[], y: string[]): number;
+export declare function composeHoldingAddressers(addressers: Array<HoldingAddresser>): HoldingAddresser;
+export declare function makeSimpleAddresser(def: string, labeler: (holding: ValuationReportHolding) => Maybe<string>): HoldingAddresser;
+export declare const addressers: Record<AvailableAddresserKeys, HoldingAddresser>;

package/reports/valuation/-valuation-report-holdings-tree/-utils.js

@@ -1,6 +1,31 @@
 "use strict";
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.compareStringArrays = void 0;
+exports.addressers = exports.makeSimpleAddresser = exports.composeHoldingAddressers = exports.compareStringArrays = void 0;
 function compareStringArrays(x, y) {
     var xLen = x.length;
     var yLen = y.length;
@@ -14,3 +39,36 @@ function compareStringArrays(x, y) {
     return Math.sign(xLen - yLen);
 }
 exports.compareStringArrays = compareStringArrays;
+function composeHoldingAddressers(addressers) {
+    return function (holding) {
+        return addressers.reduce(function (p, c) { return __spreadArray(__spreadArray([], __read(p), false), __read(c(holding)), false); }, []);
+    };
+}
+exports.composeHoldingAddressers = composeHoldingAddressers;
+function makeSimpleAddresser(def, labeler) {
+    return function (holding) {
+        // Attempt to get the label:
+        var label = labeler(holding).orDefault('') || def;
+        // Get the value:
+        var value = label.toUpperCase();
+        // Done, return:
+        return [{ name: value, order: value }];
+    };
+}
+exports.makeSimpleAddresser = makeSimpleAddresser;
+exports.addressers = {
+    classification: function (holding) {
+        // Get the classification:
+        var classification = holding.classification;
+        // Build the address and return:
+        return classification.map(function (x) { return ({
+            // label: x.name,
+            name: x.name.toUpperCase(),
+            order: "".concat(x.order).toUpperCase(),
+        }); });
+    },
+    currency: makeSimpleAddresser('[Undefined Currency]', function (holding) { return holding.artifact.ccy; }),
+    country: makeSimpleAddresser('[Undefined Country]', function (holding) { return holding.artifact.country; }),
+    issuer: makeSimpleAddresser('[Undefined Issuer]', function (holding) { return holding.artifact.issuer; }),
+    sector: makeSimpleAddresser('[Undefined Sector]', function (holding) { return holding.artifact.sector; }),
+};

package/src/reports/index.test.ts

@@ -154,7 +154,7 @@ describe('Reports', () => {
         const nav = value.figures.nav;
         const inv = value.figures.investment;
         const holdings = value.holdings;
-        const tree = makeValuationReportHoldingsTree(nav, inv, holdings);
+        const tree = makeValuationReportHoldingsTree(nav, inv, holdings, 'country');
         expect(tree).toBeDefined();
         expect(safeDiv(tree.totals.netExposure, nav).orDefault(zero)).toEqual(tree.totals.netExposureRatio);
       },

package/src/reports/valuation/-valuation-report-holdings-tree/-machinery.ts

@@ -1,8 +1,12 @@
 import { Decimal, Just, List, Maybe, Nothing, safeDiv, sumDecimals, Tuple, zero } from '@telostat/prelude';
 import { ValuationReportHolding, ValuationReportHoldingClassification } from '../-valuation-report-shared';
 import { DecafArtifactTypeId } from '../../../commons';
-import { ValuationReportHoldingsTreeNode, ValuationReportHoldingsTreeNodeValue } from './-types';
-import { compareStringArrays } from './-utils';
+import {
+  AvailableAddresserKeys,
+  ValuationReportHoldingsTreeNode,
+  ValuationReportHoldingsTreeNodeValue,
+} from './-types';
+import { addressers, compareStringArrays } from './-utils';
 
 export function makeValuationReportHoldingsTreeNodeValue(): ValuationReportHoldingsTreeNodeValue {
   return {
@@ -161,7 +165,8 @@ export function addValuationReportHoldingToTree(
 export function makeValuationReportHoldingsTree(
   nav: Decimal,
   investment: Decimal,
-  holdings: ValuationReportHolding[]
+  holdings: ValuationReportHolding[],
+  addressKey: AvailableAddresserKeys = 'classification'
 ): ValuationReportHoldingsTreeNode {
   // Initialize the tree:
   const tree = makeValuationReportHoldingsTreeNode([]);
@@ -169,7 +174,10 @@ export function makeValuationReportHoldingsTree(
 
   // Iterate over the holdings and attempt to add to the tree:
   for (const holding of holdings) {
-    addValuationReportHoldingToTree(tree, holding.classification, holding);
+    // Get the address of the holding:
+    const address = addressers[addressKey](holding);
+
+    addValuationReportHoldingToTree(tree, address, holding);
   }
 
   // Retreat the tree:

package/src/reports/valuation/-valuation-report-holdings-tree/-types.ts

@@ -23,3 +23,13 @@ export interface ValuationReportHoldingsTreeNodeValue {
   pnl: Decimal;
   pnlRatio: Decimal;
 }
+
+// export interface HoldingAddressSegment {
+//   value: string;
+//   label: string;
+//   order: string | number;
+// }
+
+export type HoldingAddress = ValuationReportHoldingClassification; // HoldingAddressSegment[];
+export type HoldingAddresser = (holding: ValuationReportHolding) => HoldingAddress;
+export type AvailableAddresserKeys = 'classification' | 'currency' | 'country' | 'issuer' | 'sector';

package/src/reports/valuation/-valuation-report-holdings-tree/-utils.ts

@@ -1,3 +1,7 @@
+import { Maybe } from '@telostat/prelude';
+import { ValuationReportHolding } from '../-valuation-report-shared';
+import { AvailableAddresserKeys, HoldingAddress, HoldingAddresser } from './-types';
+
 export function compareStringArrays(x: string[], y: string[]): number {
   const xLen = x.length;
   const yLen = y.length;
@@ -13,3 +17,42 @@ export function compareStringArrays(x: string[], y: string[]): number {
 
   return Math.sign(xLen - yLen);
 }
+
+export function composeHoldingAddressers(addressers: Array<HoldingAddresser>): HoldingAddresser {
+  return (holding: ValuationReportHolding) =>
+    addressers.reduce((p: HoldingAddress, c: HoldingAddresser) => [...p, ...c(holding)], []);
+}
+
+export function makeSimpleAddresser(
+  def: string,
+  labeler: (holding: ValuationReportHolding) => Maybe<string>
+): HoldingAddresser {
+  return (holding: ValuationReportHolding) => {
+    // Attempt to get the label:
+    const label = labeler(holding).orDefault('') || def;
+
+    // Get the value:
+    const value = label.toUpperCase();
+
+    // Done, return:
+    return [{ name: value, order: value }];
+  };
+}
+
+export const addressers: Record<AvailableAddresserKeys, HoldingAddresser> = {
+  classification: (holding: ValuationReportHolding) => {
+    // Get the classification:
+    const classification = holding.classification;
+
+    // Build the address and return:
+    return classification.map((x) => ({
+      // label: x.name,
+      name: x.name.toUpperCase(),
+      order: `${x.order}`.toUpperCase(),
+    }));
+  },
+  currency: makeSimpleAddresser('[Undefined Currency]', (holding: ValuationReportHolding) => holding.artifact.ccy),
+  country: makeSimpleAddresser('[Undefined Country]', (holding: ValuationReportHolding) => holding.artifact.country),
+  issuer: makeSimpleAddresser('[Undefined Issuer]', (holding: ValuationReportHolding) => holding.artifact.issuer),
+  sector: makeSimpleAddresser('[Undefined Sector]', (holding: ValuationReportHolding) => holding.artifact.sector),
+};