@decafhub/decaf-client-extras 0.0.5 → 0.1.0

package/src/reports/valuation/-remote-valuation-report-portfolio.ts

@@ -1,28 +1,28 @@
 import { DecafClient } from '@decafhub/decaf-client';
 import {
-  asDecimal,
   CustomError,
   customError,
+  decimalFromNullable,
   Either,
   Left,
   Maybe,
-  maybeDecimal,
   Right,
   sanitizedNonEmptyText,
   SDate,
   SDateTime,
+  unsafeDecimal,
   zero,
 } from '@telostat/prelude';
 import {
-  ActionId,
   CurrencyCode,
   DateType,
-  ExternalValuationId,
-  OhlcSeriesId,
-  PortfolioId,
-  PrincipalId,
-  ShareClassFeeScheduleId,
-  ShareClassId,
+  DecafActionId,
+  DecafExternalValuationId,
+  DecafOhlcSeriesId,
+  DecafPortfolioId,
+  DecafPrincipalId,
+  DecafShareClassFeeScheduleId,
+  DecafShareClassId,
 } from '../../commons';
 import { recompileBaseValuationReport, RemoteBaseValuationReport } from './-remote-valuation-report-shared';
 import { PortfolioValuationReport, PortfolioValuationReportShareClassValue } from './-valuation-report-portfolio';
@@ -50,7 +50,7 @@ export interface PortfolioValuationReportQuery {
   /**
    * Portfolio the valuation report is requested for.
    */
-  portfolio: PortfolioId;
+  portfolio: DecafPortfolioId;
 }
 
 /**
@@ -88,13 +88,13 @@ export interface RemoteValuationShareClassValue {
  * Type definition for share class on the remote portfolio valuation report.
  */
 export interface RemoteValuationShareClass {
-  id: ShareClassId;
+  id: DecafShareClassId;
   created: SDateTime;
-  creator: PrincipalId;
+  creator: DecafPrincipalId;
   updated: SDateTime;
-  updater: PrincipalId;
+  updater: DecafPrincipalId;
   guid: string;
-  portfolio: PortfolioId;
+  portfolio: DecafPortfolioId;
   name: string;
   currency: CurrencyCode;
   isin?: string;
@@ -106,11 +106,11 @@ export interface RemoteValuationShareClass {
   subredperiod?: string;
   freqmngt?: number;
   freqperf?: number;
-  benchmark?: OhlcSeriesId;
+  benchmark?: DecafOhlcSeriesId;
   description?: string;
-  feeschedules: ShareClassFeeScheduleId[];
-  effectivefeeschedule?: ShareClassFeeScheduleId;
-  subscriptions: ActionId[];
+  feeschedules: DecafShareClassFeeScheduleId[];
+  effectivefeeschedule?: DecafShareClassFeeScheduleId;
+  subscriptions: DecafActionId[];
   outstanding?: number;
 }
 
@@ -119,14 +119,14 @@ export interface RemoteValuationShareClass {
  * report.
  */
 export interface RemoteValuationExternalValue {
-  id: ExternalValuationId;
+  id: DecafExternalValuationId;
   created: SDateTime;
-  creator: PrincipalId;
+  creator: DecafPrincipalId;
   updated: SDateTime;
-  updater: PrincipalId;
+  updater: DecafPrincipalId;
   guid: string;
-  portfolio: PortfolioId;
-  shareclass?: ShareClassId;
+  portfolio: DecafPortfolioId;
+  shareclass?: DecafShareClassId;
   date: SDate;
   ccy: CurrencyCode;
   shares?: number;
@@ -203,7 +203,7 @@ export function toShareClassValue(x: RemoteValuationShareClassValue): PortfolioV
       feeScheduleIds: x.shareclass.feeschedules,
       effectiveFeeScheduleId: Maybe.fromNullable(x.shareclass.effectivefeeschedule),
       subscriptionIds: x.shareclass.subscriptions,
-      outstanding: maybeDecimal(x.shareclass.outstanding),
+      outstanding: decimalFromNullable(x.shareclass.outstanding),
     },
     external: Maybe.fromNullable(x.external).map((ev) => ({
       id: ev.id,
@@ -216,36 +216,36 @@ export function toShareClassValue(x: RemoteValuationShareClassValue): PortfolioV
       shareclass: Maybe.fromNullable(ev.shareclass),
       date: ev.date,
       ccy: ev.ccy,
-      shares: maybeDecimal(ev.shares),
-      price: maybeDecimal(ev.price),
-      nav: maybeDecimal(ev.nav),
-      aum: maybeDecimal(ev.aum),
-      hedgepnl: maybeDecimal(ev.hedgepnl),
-      feemngt: maybeDecimal(ev.feemngt),
-      feeperf: maybeDecimal(ev.feeperf),
-      otheraccrued: maybeDecimal(ev.otheraccrued),
-      totalaccrued: maybeDecimal(ev.totalaccrued),
-      subred: maybeDecimal(ev.subred),
-      perfdaily: maybeDecimal(ev.perfdaily),
-      perfweekly: maybeDecimal(ev.perfweekly),
-      perfmonthly: maybeDecimal(ev.perfmonthly),
-      perfytd: maybeDecimal(ev.perfytd),
-      perfstart: maybeDecimal(ev.perfstart),
-      coefficient: maybeDecimal(ev.coefficient),
+      shares: decimalFromNullable(ev.shares),
+      price: decimalFromNullable(ev.price),
+      nav: decimalFromNullable(ev.nav),
+      aum: decimalFromNullable(ev.aum),
+      hedgepnl: decimalFromNullable(ev.hedgepnl),
+      feemngt: decimalFromNullable(ev.feemngt),
+      feeperf: decimalFromNullable(ev.feeperf),
+      otheraccrued: decimalFromNullable(ev.otheraccrued),
+      totalaccrued: decimalFromNullable(ev.totalaccrued),
+      subred: decimalFromNullable(ev.subred),
+      perfdaily: decimalFromNullable(ev.perfdaily),
+      perfweekly: decimalFromNullable(ev.perfweekly),
+      perfmonthly: decimalFromNullable(ev.perfmonthly),
+      perfytd: decimalFromNullable(ev.perfytd),
+      perfstart: decimalFromNullable(ev.perfstart),
+      coefficient: decimalFromNullable(ev.coefficient),
     })),
-    nav: asDecimal(x.nav),
-    navAdjusted: asDecimal(x.nav_adjusted),
-    navAdjustedTotal: asDecimal(x.nav_adjusted_total),
-    coefficient: asDecimal(x.coefficient),
-    gavRefccy: asDecimal(x.gav_refccy),
-    gavClsccy: asDecimal(x.gav_clsccy),
-    sharecountPrev: asDecimal(x.sharecount_prev),
-    sharecountCurr: asDecimal(x.sharecount_curr),
-    sharecountDiff: asDecimal(x.sharecount_diff),
-    pxRefCcy: maybeDecimal(x.px_refccy),
-    pxClsCcy: maybeDecimal(x.px_clsccy),
-    ytdExt: maybeDecimal(x.ytdext),
-    ytdInt: maybeDecimal(x.ytdint),
+    nav: unsafeDecimal(x.nav),
+    navAdjusted: unsafeDecimal(x.nav_adjusted),
+    navAdjustedTotal: unsafeDecimal(x.nav_adjusted_total),
+    coefficient: unsafeDecimal(x.coefficient),
+    gavRefccy: unsafeDecimal(x.gav_refccy),
+    gavClsccy: unsafeDecimal(x.gav_clsccy),
+    sharecountPrev: unsafeDecimal(x.sharecount_prev),
+    sharecountCurr: unsafeDecimal(x.sharecount_curr),
+    sharecountDiff: unsafeDecimal(x.sharecount_diff),
+    pxRefCcy: decimalFromNullable(x.px_refccy),
+    pxClsCcy: decimalFromNullable(x.px_clsccy),
+    ytdExt: decimalFromNullable(x.ytdext),
+    ytdInt: decimalFromNullable(x.ytdint),
   };
 }
 
@@ -268,7 +268,7 @@ export function recompilePortfolioValuationReport(
     return {
       ...report,
       portfolio: x.portfolio,
-      subscriptions: maybeDecimal(x.subscriptions).orDefault(zero),
+      subscriptions: decimalFromNullable(x.subscriptions).orDefault(zero),
       shareClassValues: x.scvals.map(toShareClassValue),
     };
   });

package/src/reports/valuation/-remote-valuation-report-shared.ts

@@ -1,19 +1,19 @@
 import {
-  asDecimal,
   CustomError,
   Decimal,
+  decimalFromNullable,
   Either,
   Just,
   Maybe,
-  maybeDecimal,
   Right,
   safeDiv,
   sanitizedNonEmptyText,
   SDate,
   SDateTime,
+  unsafeDecimal,
   zero,
 } from '@telostat/prelude';
-import { ArtifactId, ArtifactTypeId, CurrencyCode, DateType } from '../../commons';
+import { CurrencyCode, DateType, DecafArtifactId, DecafArtifactTypeId } from '../../commons';
 import {
   BaseValuationReport,
   BaseValuationReportHolding,
@@ -124,9 +124,9 @@ export interface RemoteValuationReportChildHolding {
  * Valuation artifact.
  */
 export interface RemoteValuationReportArtifact {
-  id: ArtifactId;
+  id: DecafArtifactId;
   guid: string;
-  type: { id: ArtifactTypeId; name: string; order: number };
+  type: { id: DecafArtifactTypeId; name: string; order: number };
   stype?: string;
   symbol: string;
   name?: string;
@@ -140,7 +140,7 @@ export interface RemoteValuationReportArtifact {
   isin?: string;
   figi?: string;
   expiry?: SDate;
-  underlying_id?: ArtifactId;
+  underlying_id?: DecafArtifactId;
 }
 
 /**
@@ -179,7 +179,7 @@ export function toArtifact(x: RemoteValuationReportArtifact): ValuationReportArt
     symbol: x.symbol,
     name: sanitizedNonEmptyText(x.name),
     ccy: Maybe.fromNullable(x.ccy),
-    quantity: asDecimal(x.quantity),
+    quantity: unsafeDecimal(x.quantity),
     country: sanitizedNonEmptyText(x.country),
     issuer: sanitizedNonEmptyText(x.issuer),
     sector: sanitizedNonEmptyText(x.sector),
@@ -195,14 +195,17 @@ export function toArtifact(x: RemoteValuationReportArtifact): ValuationReportArt
 export function toAccrual(x: RemoteValuationReportAccrual): ValuationReportAccrual {
   return {
     name: x.name,
-    value: asDecimal(x.value),
+    value: unsafeDecimal(x.value),
     accounts: x.accounts.map((y) => ({
       account: y.account,
-      value: asDecimal(y.value),
+      value: unsafeDecimal(y.value),
       accruals: y.accruals.map((z) => ({
         artifact: toArtifact(z.artifact),
         ccy: z.ccy,
-        value: { org: asDecimal(z.value.org || 0), ref: asDecimal(z.value.ref || 0) },
+        value: {
+          org: decimalFromNullable(z.value.org).orDefault(zero),
+          ref: decimalFromNullable(z.value.ref).orDefault(zero),
+        },
       })),
     })),
   };
@@ -210,14 +213,14 @@ export function toAccrual(x: RemoteValuationReportAccrual): ValuationReportAccru
 
 export function toOrgRef(x: { org?: number; ref?: number }): ValuationReportFigureOrgRef {
   return {
-    org: maybeDecimal(x.org).orDefault(zero),
-    ref: maybeDecimal(x.ref).orDefault(zero),
+    org: decimalFromNullable(x.org).orDefault(zero),
+    ref: decimalFromNullable(x.ref).orDefault(zero),
   };
 }
 
 export function toMaybeOrgRef(x?: { org?: number; ref?: number }): Maybe<ValuationReportFigureOrgRef> {
   return Maybe.fromNullable(x).chain(({ org, ref }) =>
-    maybeDecimal(org).chain((o) => maybeDecimal(ref).chain((r) => Just({ org: o, ref: r })))
+    decimalFromNullable(org).chain((o) => decimalFromNullable(ref).chain((r) => Just({ org: o, ref: r })))
   );
 }
 
@@ -227,7 +230,7 @@ export function toBaseHolding(
 ): BaseValuationReportHolding {
   return {
     artifact: toArtifact(x.artifact),
-    quantity: asDecimal(x.quantity),
+    quantity: unsafeDecimal(x.quantity),
     investment: {
       px: toOrgRef(x.investment.px),
       txncosts: toMaybeOrgRef(x.investment.txncosts),
@@ -246,12 +249,12 @@ export function toBaseHolding(
         abs: toOrgRef(x.valuation.exposure.abs),
       },
     },
-    valuePercentage: safeDiv(maybeDecimal(x.valuation.value.net.ref).orDefault(zero), nav),
-    netExposurePercentage: safeDiv(maybeDecimal(x.valuation.exposure.net.ref).orDefault(zero), nav),
-    absExposurePercentage: safeDiv(maybeDecimal(x.valuation.exposure.abs.ref).orDefault(zero), nav),
-    change: maybeDecimal(x.change),
-    pnl: maybeDecimal(x.pnl).orDefault(zero),
-    pnlToInvestment: maybeDecimal(x.pnl_to_investment),
+    valuePercentage: safeDiv(decimalFromNullable(x.valuation.value.net.ref).orDefault(zero), nav),
+    netExposurePercentage: safeDiv(decimalFromNullable(x.valuation.exposure.net.ref).orDefault(zero), nav),
+    absExposurePercentage: safeDiv(decimalFromNullable(x.valuation.exposure.abs.ref).orDefault(zero), nav),
+    change: decimalFromNullable(x.change),
+    pnl: decimalFromNullable(x.pnl).orDefault(zero),
+    pnlToInvestment: decimalFromNullable(x.pnl_to_investment),
     opendate: x.opendate,
     lastdate: x.lastdate,
   };
@@ -282,7 +285,7 @@ export function toHolding(nav: Decimal, x: RemoteValuationReportHolding): Valuat
  * report.
  */
 export function recompileBaseValuationReport(x: RemoteBaseValuationReport): Either<CustomError, BaseValuationReport> {
-  const nav = maybeDecimal(x.nav).orDefault(zero);
+  const nav = decimalFromNullable(x.nav).orDefault(zero);
 
   const report: BaseValuationReport = {
     asof: x.reported,
@@ -292,20 +295,20 @@ export function recompileBaseValuationReport(x: RemoteBaseValuationReport): Eith
     accounts: x.accounts,
     holdings: x.holdings.map((rh) => toHolding(nav, rh)),
     accruals: x.accruals.map(toAccrual),
-    fxRates: x.fxrates.map((r) => ({ ccy1: r.ccy1, ccy2: r.ccy2, value: asDecimal(r.value), asof: r.asof })),
+    fxRates: x.fxrates.map((r) => ({ ccy1: r.ccy1, ccy2: r.ccy2, value: unsafeDecimal(r.value), asof: r.asof })),
     figures: {
-      investment: maybeDecimal(x.investment).orDefault(zero),
+      investment: decimalFromNullable(x.investment).orDefault(zero),
       valuation: {
-        net: maybeDecimal(x.valuation_net).orDefault(zero),
-        abs: maybeDecimal(x.valuation_abs).orDefault(zero),
+        net: decimalFromNullable(x.valuation_net).orDefault(zero),
+        abs: decimalFromNullable(x.valuation_abs).orDefault(zero),
       },
-      accrued: maybeDecimal(x.accrued).orDefault(zero),
-      liabilities: maybeDecimal(x.liabilities).orDefault(zero),
-      gav: maybeDecimal(x.gav).orDefault(zero),
+      accrued: decimalFromNullable(x.accrued).orDefault(zero),
+      liabilities: decimalFromNullable(x.liabilities).orDefault(zero),
+      gav: decimalFromNullable(x.gav).orDefault(zero),
       nav,
-      aum: maybeDecimal(x.aum).orDefault(zero),
-      pnl: maybeDecimal(x.pnl).orDefault(zero),
-      pnlToInvestment: maybeDecimal(x.pnl_to_investment),
+      aum: decimalFromNullable(x.aum).orDefault(zero),
+      pnl: decimalFromNullable(x.pnl).orDefault(zero),
+      pnlToInvestment: decimalFromNullable(x.pnl_to_investment),
     },
   };
 

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

@@ -1,8 +1,6 @@
-import { Decimal, safeDiv, sumDecimals, Tuple, zero } from '@telostat/prelude';
-import { Just, Maybe, Nothing } from 'purify-ts';
-import { List } from 'purify-ts/List';
+import { Decimal, Just, List, Maybe, Nothing, safeDiv, sumDecimals, Tuple, zero } from '@telostat/prelude';
 import { ValuationReportHolding, ValuationReportHoldingClassification } from '../-valuation-report-shared';
-import { ArtifactTypeId } from '../../../commons';
+import { DecafArtifactTypeId } from '../../../commons';
 import { ValuationReportHoldingsTreeNode, ValuationReportHoldingsTreeNodeValue } from './-types';
 import { compareStringArrays } from './-utils';
 
@@ -41,9 +39,9 @@ export function updateTotals(
   const holdingsForExposure = holdings.filter(
     (h) =>
       !(
-        h.artifact.type.id === ('CCY' as unknown as ArtifactTypeId) ||
-        h.artifact.type.id === ('DEPO' as unknown as ArtifactTypeId) ||
-        h.artifact.type.id === ('LOAN' as unknown as ArtifactTypeId)
+        h.artifact.type.id === ('CCY' as unknown as DecafArtifactTypeId) ||
+        h.artifact.type.id === ('DEPO' as unknown as DecafArtifactTypeId) ||
+        h.artifact.type.id === ('LOAN' as unknown as DecafArtifactTypeId)
       )
   );
 

package/src/reports/valuation/-valuation-report-portfolio.ts

@@ -1,13 +1,13 @@
 import { Decimal, Maybe, SDate, SDateTime } from '@telostat/prelude';
 import {
-  ActionId,
+  DecafActionId,
   CurrencyCode,
-  ExternalValuationId,
-  OhlcSeriesId,
-  PortfolioId,
-  PrincipalId,
-  ShareClassFeeScheduleId,
-  ShareClassId,
+  DecafExternalValuationId,
+  DecafOhlcSeriesId,
+  DecafPortfolioId,
+  DecafPrincipalId,
+  DecafShareClassFeeScheduleId,
+  DecafShareClassId,
 } from '../../commons';
 import { BaseValuationReport, ValuationReportPortfolio } from './-valuation-report-shared';
 
@@ -36,13 +36,13 @@ export interface PortfolioValuationReportShareClassValue {
 }
 
 export interface PortfolioValuationReportShareClass {
-  id: ShareClassId;
+  id: DecafShareClassId;
   created: SDateTime;
-  creator: Maybe<PrincipalId>;
+  creator: Maybe<DecafPrincipalId>;
   updated: SDateTime;
-  updater: Maybe<PrincipalId>;
+  updater: Maybe<DecafPrincipalId>;
   guid: string;
-  portfolio: PortfolioId;
+  portfolio: DecafPortfolioId;
   name: string;
   currency: CurrencyCode;
   isin: Maybe<string>;
@@ -54,23 +54,23 @@ export interface PortfolioValuationReportShareClass {
   subscriptionRedemptionPeriod: Maybe<string>;
   managementFeeFrequency: Maybe<number>;
   performanceFeeFrequency: Maybe<number>;
-  benchmark: Maybe<OhlcSeriesId>;
+  benchmark: Maybe<DecafOhlcSeriesId>;
   description: Maybe<string>;
-  feeScheduleIds: ShareClassFeeScheduleId[];
-  effectiveFeeScheduleId: Maybe<ShareClassFeeScheduleId>;
-  subscriptionIds: ActionId[];
+  feeScheduleIds: DecafShareClassFeeScheduleId[];
+  effectiveFeeScheduleId: Maybe<DecafShareClassFeeScheduleId>;
+  subscriptionIds: DecafActionId[];
   outstanding: Maybe<Decimal>;
 }
 
 export interface PortfolioValuationReportExternalValue {
-  id: ExternalValuationId;
+  id: DecafExternalValuationId;
   created: SDateTime;
-  creator: Maybe<PrincipalId>;
+  creator: Maybe<DecafPrincipalId>;
   updated: SDateTime;
-  updater: Maybe<PrincipalId>;
+  updater: Maybe<DecafPrincipalId>;
   guid: string;
-  portfolio: PortfolioId;
-  shareclass: Maybe<ShareClassId>;
+  portfolio: DecafPortfolioId;
+  shareclass: Maybe<DecafShareClassId>;
   date: SDate;
   ccy: CurrencyCode;
   shares: Maybe<Decimal>;

package/src/reports/valuation/-valuation-report-shared.ts

@@ -1,5 +1,12 @@
 import { Decimal, Maybe, SDate, SDateTime } from '@telostat/prelude';
-import { AccountId, ArtifactId, ArtifactTypeId, CurrencyCode, DateType, PortfolioId } from '../../commons';
+import {
+  CurrencyCode,
+  DateType,
+  DecafAccountId,
+  DecafArtifactId,
+  DecafArtifactTypeId,
+  DecafPortfolioId,
+} from '../../commons';
 
 /**
  * Type definition for base valuation report.
@@ -33,7 +40,7 @@ export interface BaseValuationReport {
  * Type definition for account reference in valuation reports.
  */
 export interface ValuationReportAccount {
-  id: AccountId;
+  id: DecafAccountId;
   guid: string;
   name: string;
 }
@@ -42,7 +49,7 @@ export interface ValuationReportAccount {
  * Type definition for portfolio reference in valuation reports.
  */
 export interface ValuationReportPortfolio {
-  id: PortfolioId;
+  id: DecafPortfolioId;
   guid: string;
   name: string;
 }
@@ -181,7 +188,7 @@ export interface ValuationReportAccrualByCurrency {
  * Type definition of the FINREA artifact type.
  */
 export interface ValuationReportArtifactType {
-  id: ArtifactTypeId;
+  id: DecafArtifactTypeId;
   name: string;
   order: number;
 }
@@ -190,7 +197,7 @@ export interface ValuationReportArtifactType {
  * Type definition for the artifact as reported in the valuation.
  */
 export interface ValuationReportArtifact {
-  id: ArtifactId;
+  id: DecafArtifactId;
   guid: string;
   type: ValuationReportArtifactType;
   stype: Maybe<string>;
@@ -206,7 +213,7 @@ export interface ValuationReportArtifact {
   isin: Maybe<string>;
   figi: Maybe<string>;
   expiry: Maybe<SDate>;
-  underlyingId: Maybe<ArtifactId>;
+  underlyingId: Maybe<DecafArtifactId>;
 }
 
 export interface ValuationReportFxRate {