@decafhub/decaf-client-extras 0.0.2 → 0.0.4

package/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.0.2"
+  ".": "0.0.4"
 }

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.0.4](https://github.com/teloscube/decaf-client-javascript-extras/compare/v0.0.3...v0.0.4) (2022-11-07)
+
+
+### Miscellaneous Chores
+
+* release 0.0.4 ([b3f7a12](https://github.com/teloscube/decaf-client-javascript-extras/commit/b3f7a12b5dbd1ffac7db06f03958d71581889d92))
+
+## [0.0.3](https://github.com/teloscube/decaf-client-javascript-extras/compare/v0.0.2...v0.0.3) (2022-08-25)
+
+
+### Bug Fixes
+
+* pxRefCcy and pxClsCcy types are wrong in share class values ([1862e1a](https://github.com/teloscube/decaf-client-javascript-extras/commit/1862e1abde3d6e5f8a539233e1408557e9465b07)), closes [#16](https://github.com/teloscube/decaf-client-javascript-extras/issues/16)
+
 ## [0.0.2](https://github.com/teloscube/decaf-client-javascript-extras/compare/v0.0.1...v0.0.2) (2022-08-19)
 
 

package/README.md

@@ -4,7 +4,19 @@
 [![npm](https://img.shields.io/npm/dm/@decafhub/decaf-client-extras.svg)](https://www.npmjs.com/package/@decafhub/decaf-client-extras)
 ![GitHub](https://img.shields.io/github/license/teloscube/decaf-client-javascript-extras)
 
-> **TODO:** Add README content.
+## Install
+
+Install @decafhub/decaf-client-extras along with its peer dependency @decafhub/decaf-client:
+
+```bash
+npm install --save @decafhub/decaf-client-extras @decafhub/decaf-client
+```
+
+Or with yarn:
+
+```bash
+yarn add @decafhub/decaf-client-extras @decafhub/decaf-client
+```
 
 ## Testing
 

package/commons/-currency.d.ts

@@ -11,32 +11,32 @@ import { Maybe, NewTypeWithPhantom } from '@telostat/prelude';
  */
 export declare type CurrencyCode = NewTypeWithPhantom<'CurrencyCode', string>;
 /**
- * Attempts to create a [[CurrencyCode]] value with the given currency code.
+ * Attempts to create a {@link CurrencyCode} value with the given currency code.
  *
  * This function returns a `Maybe` value. For the version that throws an
- * error, see [[mkCurrencyCodeError]].
+ * error, see {@link mkCurrencyCodeError}.
  *
  * @param x A currency code represented as string.
  * @returns If the argument has leading or trailing spaces OR it is empty,
- * `Nothing` is retured, `Just` [[CurrencyCode]] otherwise.
+ * `Nothing` is retured, `Just` {@link CurrencyCode} otherwise.
  */
 export declare function mkCurrencyCode(x: string): Maybe<CurrencyCode>;
 /**
- * (Unsafely) attempts to create a [[CurrencyCode]] value with the given
+ * (Unsafely) attempts to create a {@link CurrencyCode} value with the given
  * currency code.
  *
  * This function may throw an error if the given argument is not a valid
- * currency code. For the monadic version, see [[mkCurrencyCode]].
+ * currency code. For the monadic version, see {@link mkCurrencyCode}.
  *
  * @param x A currency code represented as string.
  * @returns If the argument has leading or trailing spaces OR it is empty, an
- * error is thrown, [[CurrencyCode]] is returned otherwise.
+ * error is thrown, {@link CurrencyCode} is returned otherwise.
  */
 export declare function mkCurrencyCodeError(x: string): CurrencyCode;
 /**
  * Return the currency code as a string value.
  *
- * @param x [[CurrencyCode]] to be extracted string from.
+ * @param x {@link CurrencyCode} to be extracted string from.
  * @returns Currency code as a string.
  */
 export declare function unCurrencyCode(x: CurrencyCode): string;

package/commons/-currency.js

@@ -8,29 +8,29 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.unCurrencyCode = exports.mkCurrencyCodeError = exports.mkCurrencyCode = void 0;
 var prelude_1 = require("@telostat/prelude");
 /**
- * Attempts to create a [[CurrencyCode]] value with the given currency code.
+ * Attempts to create a {@link CurrencyCode} value with the given currency code.
  *
  * This function returns a `Maybe` value. For the version that throws an
- * error, see [[mkCurrencyCodeError]].
+ * error, see {@link mkCurrencyCodeError}.
  *
  * @param x A currency code represented as string.
  * @returns If the argument has leading or trailing spaces OR it is empty,
- * `Nothing` is retured, `Just` [[CurrencyCode]] otherwise.
+ * `Nothing` is retured, `Just` {@link CurrencyCode} otherwise.
  */
 function mkCurrencyCode(x) {
     return x !== x.trim() || x === '' ? prelude_1.Nothing : (0, prelude_1.Just)((0, prelude_1.mkPhantom)(x));
 }
 exports.mkCurrencyCode = mkCurrencyCode;
 /**
- * (Unsafely) attempts to create a [[CurrencyCode]] value with the given
+ * (Unsafely) attempts to create a {@link CurrencyCode} value with the given
  * currency code.
  *
  * This function may throw an error if the given argument is not a valid
- * currency code. For the monadic version, see [[mkCurrencyCode]].
+ * currency code. For the monadic version, see {@link mkCurrencyCode}.
  *
  * @param x A currency code represented as string.
  * @returns If the argument has leading or trailing spaces OR it is empty, an
- * error is thrown, [[CurrencyCode]] is returned otherwise.
+ * error is thrown, {@link CurrencyCode} is returned otherwise.
  */
 function mkCurrencyCodeError(x) {
     return mkCurrencyCode(x).orDefaultLazy(function () {
@@ -41,7 +41,7 @@ exports.mkCurrencyCodeError = mkCurrencyCodeError;
 /**
  * Return the currency code as a string value.
  *
- * @param x [[CurrencyCode]] to be extracted string from.
+ * @param x {@link CurrencyCode} to be extracted string from.
  * @returns Currency code as a string.
  */
 function unCurrencyCode(x) {

package/es/commons/-currency.d.ts

@@ -11,32 +11,32 @@ import { Maybe, NewTypeWithPhantom } from '@telostat/prelude';
  */
 export declare type CurrencyCode = NewTypeWithPhantom<'CurrencyCode', string>;
 /**
- * Attempts to create a [[CurrencyCode]] value with the given currency code.
+ * Attempts to create a {@link CurrencyCode} value with the given currency code.
  *
  * This function returns a `Maybe` value. For the version that throws an
- * error, see [[mkCurrencyCodeError]].
+ * error, see {@link mkCurrencyCodeError}.
  *
  * @param x A currency code represented as string.
  * @returns If the argument has leading or trailing spaces OR it is empty,
- * `Nothing` is retured, `Just` [[CurrencyCode]] otherwise.
+ * `Nothing` is retured, `Just` {@link CurrencyCode} otherwise.
  */
 export declare function mkCurrencyCode(x: string): Maybe<CurrencyCode>;
 /**
- * (Unsafely) attempts to create a [[CurrencyCode]] value with the given
+ * (Unsafely) attempts to create a {@link CurrencyCode} value with the given
  * currency code.
  *
  * This function may throw an error if the given argument is not a valid
- * currency code. For the monadic version, see [[mkCurrencyCode]].
+ * currency code. For the monadic version, see {@link mkCurrencyCode}.
  *
  * @param x A currency code represented as string.
  * @returns If the argument has leading or trailing spaces OR it is empty, an
- * error is thrown, [[CurrencyCode]] is returned otherwise.
+ * error is thrown, {@link CurrencyCode} is returned otherwise.
  */
 export declare function mkCurrencyCodeError(x: string): CurrencyCode;
 /**
  * Return the currency code as a string value.
  *
- * @param x [[CurrencyCode]] to be extracted string from.
+ * @param x {@link CurrencyCode} to be extracted string from.
  * @returns Currency code as a string.
  */
 export declare function unCurrencyCode(x: CurrencyCode): string;

package/es/commons/-currency.js

@@ -5,28 +5,28 @@
  */
 import { Just, mkPhantom, Nothing, unPhantom } from '@telostat/prelude';
 /**
- * Attempts to create a [[CurrencyCode]] value with the given currency code.
+ * Attempts to create a {@link CurrencyCode} value with the given currency code.
  *
  * This function returns a `Maybe` value. For the version that throws an
- * error, see [[mkCurrencyCodeError]].
+ * error, see {@link mkCurrencyCodeError}.
  *
  * @param x A currency code represented as string.
  * @returns If the argument has leading or trailing spaces OR it is empty,
- * `Nothing` is retured, `Just` [[CurrencyCode]] otherwise.
+ * `Nothing` is retured, `Just` {@link CurrencyCode} otherwise.
  */
 export function mkCurrencyCode(x) {
     return x !== x.trim() || x === '' ? Nothing : Just(mkPhantom(x));
 }
 /**
- * (Unsafely) attempts to create a [[CurrencyCode]] value with the given
+ * (Unsafely) attempts to create a {@link CurrencyCode} value with the given
  * currency code.
  *
  * This function may throw an error if the given argument is not a valid
- * currency code. For the monadic version, see [[mkCurrencyCode]].
+ * currency code. For the monadic version, see {@link mkCurrencyCode}.
  *
  * @param x A currency code represented as string.
  * @returns If the argument has leading or trailing spaces OR it is empty, an
- * error is thrown, [[CurrencyCode]] is returned otherwise.
+ * error is thrown, {@link CurrencyCode} is returned otherwise.
  */
 export function mkCurrencyCodeError(x) {
     return mkCurrencyCode(x).orDefaultLazy(() => {
@@ -36,7 +36,7 @@ export function mkCurrencyCodeError(x) {
 /**
  * Return the currency code as a string value.
  *
- * @param x [[CurrencyCode]] to be extracted string from.
+ * @param x {@link CurrencyCode} to be extracted string from.
  * @returns Currency code as a string.
  */
 export function unCurrencyCode(x) {

package/es/reports/valuation/-remote-valuation-report-consolidated.d.ts

@@ -60,7 +60,7 @@ export declare function fetchRemoteConsolidatedValuationReport(client: DecafClie
 export declare function recompileConsolidatedValuationReport(x: RemoteConsolidatedValuationReport): Either<CustomError, ConsolidatedValuationReport>;
 /**
  * Attempts to retrieve remote consolidated valuation report, compiles it to
- * [[ConsolidatedValuationReport]] and return it.
+ * {@link ConsolidatedValuationReport} and return it.
  *
  * @param client DECAF Barista client.
  * @param query Remote consolidated valuation report endpoint query parameters.

package/es/reports/valuation/-remote-valuation-report-consolidated.js

@@ -42,7 +42,7 @@ export function recompileConsolidatedValuationReport(x) {
 }
 /**
  * Attempts to retrieve remote consolidated valuation report, compiles it to
- * [[ConsolidatedValuationReport]] and return it.
+ * {@link ConsolidatedValuationReport} and return it.
  *
  * @param client DECAF Barista client.
  * @param query Remote consolidated valuation report endpoint query parameters.

package/es/reports/valuation/-remote-valuation-report-portfolio.d.ts

@@ -141,7 +141,7 @@ export declare function toShareClassValue(x: RemoteValuationShareClassValue): Po
 export declare function recompilePortfolioValuationReport(x: RemotePortfolioValuationReport): Either<CustomError, PortfolioValuationReport>;
 /**
  * Attempts to retrieve remote portfolio valuation report, compiles it to
- * [[PortfolioValuationReport]] and return it.
+ * {@link PortfolioValuationReport} and return it.
  *
  * @param client DECAF Barista client.
  * @param query Remote portolio valuation report endpoint query parameters.

package/es/reports/valuation/-remote-valuation-report-portfolio.js

@@ -91,8 +91,8 @@ export function toShareClassValue(x) {
         sharecountPrev: asDecimal(x.sharecount_prev),
         sharecountCurr: asDecimal(x.sharecount_curr),
         sharecountDiff: asDecimal(x.sharecount_diff),
-        pxRefCcy: asDecimal(x.px_refccy),
-        pxClsCcy: asDecimal(x.px_clsccy),
+        pxRefCcy: maybeDecimal(x.px_refccy),
+        pxClsCcy: maybeDecimal(x.px_clsccy),
         ytdExt: maybeDecimal(x.ytdext),
         ytdInt: maybeDecimal(x.ytdint),
     };
@@ -120,7 +120,7 @@ export function recompilePortfolioValuationReport(x) {
 }
 /**
  * Attempts to retrieve remote portfolio valuation report, compiles it to
- * [[PortfolioValuationReport]] and return it.
+ * {@link PortfolioValuationReport} and return it.
  *
  * @param client DECAF Barista client.
  * @param query Remote portolio valuation report endpoint query parameters.

package/es/reports/valuation/-valuation-report-portfolio.d.ts

@@ -18,8 +18,8 @@ export interface PortfolioValuationReportShareClassValue {
     sharecountPrev: Decimal;
     sharecountCurr: Decimal;
     sharecountDiff: Decimal;
-    pxRefCcy: Decimal;
-    pxClsCcy: Decimal;
+    pxRefCcy: Maybe<Decimal>;
+    pxClsCcy: Maybe<Decimal>;
     ytdExt: Maybe<Decimal>;
     ytdInt: Maybe<Decimal>;
 }

package/es/reports/valuation/-valuation-report-shared.d.ts

@@ -63,7 +63,7 @@ export interface ValuationReportHoldingClassificationNode {
 }
 /**
  * Type definition for base valuation report holding (shared by
- * [[ValuationReportHolding]] and [[ValuationReportChildHolding]]).
+ * {@link ValuationReportHolding} and {@link ValuationReportChildHolding}).
  */
 export interface BaseValuationReportHolding {
     artifact: ValuationReportArtifact;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decafhub/decaf-client-extras",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "DECAF Client Extras",
   "author": "Teloscube Pte Ltd",
   "license": "MIT",
@@ -26,36 +26,36 @@
     "node": ">=14"
   },
   "peerDependencies": {
-    "@decafhub/decaf-client": "~0.2"
+    "@decafhub/decaf-client": "^0.3.1"
   },
   "dependencies": {
     "@telostat/prelude": "^0.1.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.0.3",
-    "@commitlint/config-conventional": "^17.0.3",
-    "@decafhub/decaf-client": "^0.2.2",
-    "@types/jest": "^28.1.6",
-    "@types/node": "^18.6.1",
-    "@typescript-eslint/eslint-plugin": "^5.30.7",
-    "@typescript-eslint/parser": "^5.30.7",
-    "dotenv": "^16.0.1",
-    "eslint": "^8.20.0",
+    "@commitlint/cli": "^17.2.0",
+    "@commitlint/config-conventional": "^17.2.0",
+    "@decafhub/decaf-client": "^0.3.1",
+    "@types/jest": "^29.2.2",
+    "@types/node": "^18.11.9",
+    "@typescript-eslint/eslint-plugin": "^5.42.0",
+    "@typescript-eslint/parser": "^5.42.0",
+    "dotenv": "^16.0.3",
+    "eslint": "^8.27.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-config-standard": "^17.0.0",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-n": "^15.2.4",
+    "eslint-plugin-n": "^15.5.0",
     "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-standard": "^5.0.0",
     "gh-pages": "^4.0.0",
-    "husky": "^8.0.0",
-    "jest": "^28.1.3",
+    "husky": "^8.0.1",
+    "jest": "^29.2.2",
     "lint-staged": "^13.0.3",
     "prettier": "^2.7.1",
-    "ts-jest": "^28.0.7",
-    "typedoc": "^0.23.9",
-    "typescript": "^4.7.4"
+    "ts-jest": "^29.0.3",
+    "typedoc": "^0.23.20",
+    "typescript": "^4.8.4"
   },
   "lint-staged": {
     "src/**/*.{ts,tsx}": [

package/reports/valuation/-remote-valuation-report-consolidated.d.ts

@@ -60,7 +60,7 @@ export declare function fetchRemoteConsolidatedValuationReport(client: DecafClie
 export declare function recompileConsolidatedValuationReport(x: RemoteConsolidatedValuationReport): Either<CustomError, ConsolidatedValuationReport>;
 /**
  * Attempts to retrieve remote consolidated valuation report, compiles it to
- * [[ConsolidatedValuationReport]] and return it.
+ * {@link ConsolidatedValuationReport} and return it.
  *
  * @param client DECAF Barista client.
  * @param query Remote consolidated valuation report endpoint query parameters.

package/reports/valuation/-remote-valuation-report-consolidated.js

@@ -90,7 +90,7 @@ function recompileConsolidatedValuationReport(x) {
 exports.recompileConsolidatedValuationReport = recompileConsolidatedValuationReport;
 /**
  * Attempts to retrieve remote consolidated valuation report, compiles it to
- * [[ConsolidatedValuationReport]] and return it.
+ * {@link ConsolidatedValuationReport} and return it.
  *
  * @param client DECAF Barista client.
  * @param query Remote consolidated valuation report endpoint query parameters.

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

@@ -141,7 +141,7 @@ export declare function toShareClassValue(x: RemoteValuationShareClassValue): Po
 export declare function recompilePortfolioValuationReport(x: RemotePortfolioValuationReport): Either<CustomError, PortfolioValuationReport>;
 /**
  * Attempts to retrieve remote portfolio valuation report, compiles it to
- * [[PortfolioValuationReport]] and return it.
+ * {@link PortfolioValuationReport} and return it.
  *
  * @param client DECAF Barista client.
  * @param query Remote portolio valuation report endpoint query parameters.

package/reports/valuation/-remote-valuation-report-portfolio.js

@@ -142,8 +142,8 @@ function toShareClassValue(x) {
         sharecountPrev: (0, prelude_1.asDecimal)(x.sharecount_prev),
         sharecountCurr: (0, prelude_1.asDecimal)(x.sharecount_curr),
         sharecountDiff: (0, prelude_1.asDecimal)(x.sharecount_diff),
-        pxRefCcy: (0, prelude_1.asDecimal)(x.px_refccy),
-        pxClsCcy: (0, prelude_1.asDecimal)(x.px_clsccy),
+        pxRefCcy: (0, prelude_1.maybeDecimal)(x.px_refccy),
+        pxClsCcy: (0, prelude_1.maybeDecimal)(x.px_clsccy),
         ytdExt: (0, prelude_1.maybeDecimal)(x.ytdext),
         ytdInt: (0, prelude_1.maybeDecimal)(x.ytdint),
     };
@@ -168,7 +168,7 @@ function recompilePortfolioValuationReport(x) {
 exports.recompilePortfolioValuationReport = recompilePortfolioValuationReport;
 /**
  * Attempts to retrieve remote portfolio valuation report, compiles it to
- * [[PortfolioValuationReport]] and return it.
+ * {@link PortfolioValuationReport} and return it.
  *
  * @param client DECAF Barista client.
  * @param query Remote portolio valuation report endpoint query parameters.

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

@@ -18,8 +18,8 @@ export interface PortfolioValuationReportShareClassValue {
     sharecountPrev: Decimal;
     sharecountCurr: Decimal;
     sharecountDiff: Decimal;
-    pxRefCcy: Decimal;
-    pxClsCcy: Decimal;
+    pxRefCcy: Maybe<Decimal>;
+    pxClsCcy: Maybe<Decimal>;
     ytdExt: Maybe<Decimal>;
     ytdInt: Maybe<Decimal>;
 }

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

@@ -63,7 +63,7 @@ export interface ValuationReportHoldingClassificationNode {
 }
 /**
  * Type definition for base valuation report holding (shared by
- * [[ValuationReportHolding]] and [[ValuationReportChildHolding]]).
+ * {@link ValuationReportHolding} and {@link ValuationReportChildHolding}).
  */
 export interface BaseValuationReportHolding {
     artifact: ValuationReportArtifact;

package/src/commons/-currency.ts

@@ -14,29 +14,29 @@ import { Just, Maybe, mkPhantom, NewTypeWithPhantom, Nothing, unPhantom } from '
 export type CurrencyCode = NewTypeWithPhantom<'CurrencyCode', string>;
 
 /**
- * Attempts to create a [[CurrencyCode]] value with the given currency code.
+ * Attempts to create a {@link CurrencyCode} value with the given currency code.
  *
  * This function returns a `Maybe` value. For the version that throws an
- * error, see [[mkCurrencyCodeError]].
+ * error, see {@link mkCurrencyCodeError}.
  *
  * @param x A currency code represented as string.
  * @returns If the argument has leading or trailing spaces OR it is empty,
- * `Nothing` is retured, `Just` [[CurrencyCode]] otherwise.
+ * `Nothing` is retured, `Just` {@link CurrencyCode} otherwise.
  */
 export function mkCurrencyCode(x: string): Maybe<CurrencyCode> {
   return x !== x.trim() || x === '' ? Nothing : Just(mkPhantom(x));
 }
 
 /**
- * (Unsafely) attempts to create a [[CurrencyCode]] value with the given
+ * (Unsafely) attempts to create a {@link CurrencyCode} value with the given
  * currency code.
  *
  * This function may throw an error if the given argument is not a valid
- * currency code. For the monadic version, see [[mkCurrencyCode]].
+ * currency code. For the monadic version, see {@link mkCurrencyCode}.
  *
  * @param x A currency code represented as string.
  * @returns If the argument has leading or trailing spaces OR it is empty, an
- * error is thrown, [[CurrencyCode]] is returned otherwise.
+ * error is thrown, {@link CurrencyCode} is returned otherwise.
  */
 export function mkCurrencyCodeError(x: string): CurrencyCode {
   return mkCurrencyCode(x).orDefaultLazy(() => {
@@ -47,7 +47,7 @@ export function mkCurrencyCodeError(x: string): CurrencyCode {
 /**
  * Return the currency code as a string value.
  *
- * @param x [[CurrencyCode]] to be extracted string from.
+ * @param x {@link CurrencyCode} to be extracted string from.
  * @returns Currency code as a string.
  */
 export function unCurrencyCode(x: CurrencyCode): string {

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

@@ -103,7 +103,7 @@ export function recompileConsolidatedValuationReport(
 
 /**
  * Attempts to retrieve remote consolidated valuation report, compiles it to
- * [[ConsolidatedValuationReport]] and return it.
+ * {@link ConsolidatedValuationReport} and return it.
  *
  * @param client DECAF Barista client.
  * @param query Remote consolidated valuation report endpoint query parameters.

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

@@ -242,8 +242,8 @@ export function toShareClassValue(x: RemoteValuationShareClassValue): PortfolioV
     sharecountPrev: asDecimal(x.sharecount_prev),
     sharecountCurr: asDecimal(x.sharecount_curr),
     sharecountDiff: asDecimal(x.sharecount_diff),
-    pxRefCcy: asDecimal(x.px_refccy),
-    pxClsCcy: asDecimal(x.px_clsccy),
+    pxRefCcy: maybeDecimal(x.px_refccy),
+    pxClsCcy: maybeDecimal(x.px_clsccy),
     ytdExt: maybeDecimal(x.ytdext),
     ytdInt: maybeDecimal(x.ytdint),
   };
@@ -276,7 +276,7 @@ export function recompilePortfolioValuationReport(
 
 /**
  * Attempts to retrieve remote portfolio valuation report, compiles it to
- * [[PortfolioValuationReport]] and return it.
+ * {@link PortfolioValuationReport} and return it.
  *
  * @param client DECAF Barista client.
  * @param query Remote portolio valuation report endpoint query parameters.

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

@@ -29,8 +29,8 @@ export interface PortfolioValuationReportShareClassValue {
   sharecountPrev: Decimal;
   sharecountCurr: Decimal;
   sharecountDiff: Decimal;
-  pxRefCcy: Decimal;
-  pxClsCcy: Decimal;
+  pxRefCcy: Maybe<Decimal>;
+  pxClsCcy: Maybe<Decimal>;
   ytdExt: Maybe<Decimal>;
   ytdInt: Maybe<Decimal>;
 }

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

@@ -70,7 +70,7 @@ export interface ValuationReportHoldingClassificationNode {
 
 /**
  * Type definition for base valuation report holding (shared by
- * [[ValuationReportHolding]] and [[ValuationReportChildHolding]]).
+ * {@link ValuationReportHolding} and {@link ValuationReportChildHolding}).
  */
 export interface BaseValuationReportHolding {
   artifact: ValuationReportArtifact;