@sonarwatch/portfolio-core 0.16.3 → 0.16.5

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [0.16.5](https://github.com/sonarwatch/portfolio/compare/core-0.16.4...core-0.16.5) (2025-07-07)
+
+
+### Bug Fixes
+
+* **core:** handle empty yield items and correct revenue calculations in calcYieldSummary ([39ba5f3](https://github.com/sonarwatch/portfolio/commit/39ba5f3b6bb334b970e7b8e146cf80d24d45293c))
+
+
+### Features
+
+* **core:** add calcYieldSummary utility and FetcherResult types to enhance yield data calculations and integration ([9c26a0f](https://github.com/sonarwatch/portfolio/commit/9c26a0f618826a8dbec19ff7cf7685182aff27e5))
+* **core:** add optional error field to FetcherResult ([76e3b84](https://github.com/sonarwatch/portfolio/commit/76e3b84bfb8ab07a42d3c238e256611885bd2b52))
+* **plugins:** add netApy support across element builders and simplify yield calculations ([f0c97b7](https://github.com/sonarwatch/portfolio/commit/f0c97b74727e320370fcc6a298ff14eb7b74c256))
+
+
+
+## [0.16.4](https://github.com/sonarwatch/portfolio/compare/core-0.16.3...core-0.16.4) (2025-07-04)
+
+
+
 ## [0.16.3](https://github.com/sonarwatch/portfolio/compare/core-0.16.2...core-0.16.3) (2025-07-04)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sonarwatch/portfolio-core",
-  "version": "0.16.3",
+  "version": "0.16.5",
   "type": "commonjs",
   "types": "./src/index.d.ts",
   "dependencies": {

package/src/FetcherResult.d.ts

@@ -0,0 +1,38 @@
+import { NetworkIdType } from './Network';
+import { AddressSystemType } from './Address';
+import { UsdValue } from './UsdValue';
+import { TokenInfo } from './TokenList';
+import { PortfolioElement } from './Portfolio';
+/**
+ * Represents the result of a fetcher.
+ */
+export type FetcherResult = {
+    owner: string;
+    fetcherId: string;
+    networdkId: NetworkIdType;
+    duration: number;
+    elements: PortfolioElement[];
+    error?: string;
+};
+/**
+ * Represents the report of a fetcher.
+ */
+export type FetcherReport = {
+    id: string;
+    status: 'succeeded' | 'failed';
+    duration?: number;
+    error?: string;
+};
+/**
+ * Represents the result of multiple fetchers.
+ */
+export type FetchersResult = {
+    date: number;
+    owner: string;
+    addressSystem: AddressSystemType;
+    fetcherReports: FetcherReport[];
+    value: UsdValue;
+    elements: PortfolioElement[];
+    duration: number;
+    tokenInfo?: Partial<Record<NetworkIdType, Record<string, TokenInfo>>>;
+};

package/src/FetcherResult.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=FetcherResult.js.map

package/src/FetcherResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetcherResult.js","sourceRoot":"","sources":["../../../../packages/core/src/FetcherResult.ts"],"names":[],"mappings":""}

package/src/Portfolio.d.ts

@@ -1,8 +1,6 @@
 import { UsdValue } from './UsdValue';
 import { NetworkIdType } from './Network';
 import { Yield } from './Yield';
-import { AddressSystemType } from './Address';
-import { TokenInfo } from './TokenList';
 /**
  * Represents the type of portfolio asset.
  */
@@ -154,6 +152,13 @@ export type PortfolioElementCommon = {
     name?: string;
     tags?: string[];
     proxyInfo?: ProxyInfo;
+    /**
+     * Net APY (Annual Percentage Yield) as fraction.
+     * Includes internal token yields
+     * 0.28 means 28% APY
+     * -0.28 means -28% APR
+     */
+    netApy?: number;
 };
 /**
  * Represents the data of a multiple portfolio element.
@@ -391,36 +396,3 @@ export type PortfolioElementBorrowLend = PortfolioElementCommon & {
  * Represents a portfolio element.
  */
 export type PortfolioElement = PortfolioElementMultiple | PortfolioElementLiquidity | PortfolioElementLeverage | PortfolioElementBorrowLend | PortfolioElementTrade;
-/**
- * Represents the result of a fetcher.
- */
-export type FetcherResult = {
-    owner: string;
-    fetcherId: string;
-    networdkId: NetworkIdType;
-    duration: number;
-    elements: PortfolioElement[];
-    error?: string;
-};
-/**
- * Represents the report of a fetcher.
- */
-export type FetcherReport = {
-    id: string;
-    status: 'succeeded' | 'failed';
-    duration?: number;
-    error?: string;
-};
-/**
- * Represents the result of multiple fetchers.
- */
-export type FetchersResult = {
-    date: number;
-    owner: string;
-    addressSystem: AddressSystemType;
-    fetcherReports: FetcherReport[];
-    value: UsdValue;
-    elements: PortfolioElement[];
-    duration: number;
-    tokenInfo?: Partial<Record<NetworkIdType, Record<string, TokenInfo>>>;
-};

package/src/Portfolio.js.map

@@ -1 +1 @@
-{"version":3,"file":"Portfolio.js","sourceRoot":"","sources":["../../../../packages/core/src/Portfolio.ts"],"names":[],"mappings":";;;AAMA;;GAEG;AACU,QAAA,kBAAkB,GAAG;IAChC,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,aAAa;CAClB,CAAC;AA6CX;;GAEG;AACU,QAAA,oBAAoB,GAAG;IAClC,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;IACtB,UAAU,EAAE,YAAY;IACxB,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;CACN,CAAC;AA2OX,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,6BAAa,CAAA;IACb,+BAAe,CAAA;AACjB,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB"}
+{"version":3,"file":"Portfolio.js","sourceRoot":"","sources":["../../../../packages/core/src/Portfolio.ts"],"names":[],"mappings":";;;AAIA;;GAEG;AACU,QAAA,kBAAkB,GAAG;IAChC,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,aAAa;CAClB,CAAC;AA6CX;;GAEG;AACU,QAAA,oBAAoB,GAAG;IAClC,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;IACtB,UAAU,EAAE,YAAY;IACxB,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;CACN,CAAC;AAkPX,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,6BAAa,CAAA;IACb,+BAAe,CAAA;AACjB,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB"}

package/src/Yield.d.ts

@@ -42,3 +42,7 @@ export declare const yieldFromApr: (apr: number) => Yield;
  * @returns The Yield object with the calculated APR.
  */
 export declare const yieldFromApy: (apy: number) => Yield;
+export type YieldElement = {
+    apy: number;
+    value: number;
+};

package/src/index.d.ts

@@ -15,3 +15,4 @@ export * from './TokenYield';
 export * from './Yield';
 export * from './BorrowLendRate';
 export * from './Transaction';
+export * from './FetcherResult';

package/src/index.js

@@ -31,4 +31,5 @@ __exportStar(require("./TokenYield"), exports);
 __exportStar(require("./Yield"), exports);
 __exportStar(require("./BorrowLendRate"), exports);
 __exportStar(require("./Transaction"), exports);
+__exportStar(require("./FetcherResult"), exports);
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/core/src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,2CAAyB;AACzB,iDAA+B;AAC/B,0CAAwB;AACxB,0CAAwB;AACxB,4CAA0B;AAC1B,4CAA0B;AAC1B,6CAA2B;AAC3B,2CAAyB;AACzB,4CAA0B;AAC1B,8CAA4B;AAC5B,8CAA4B;AAC5B,+CAA6B;AAC7B,+CAA6B;AAC7B,0CAAwB;AACxB,mDAAiC;AACjC,gDAA8B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/core/src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,2CAAyB;AACzB,iDAA+B;AAC/B,0CAAwB;AACxB,0CAAwB;AACxB,4CAA0B;AAC1B,4CAA0B;AAC1B,6CAA2B;AAC3B,2CAAyB;AACzB,4CAA0B;AAC1B,8CAA4B;AAC5B,8CAA4B;AAC5B,+CAA6B;AAC7B,+CAA6B;AAC7B,0CAAwB;AACxB,mDAAiC;AACjC,gDAA8B;AAC9B,kDAAgC"}

package/src/utils/index.d.ts

@@ -48,3 +48,4 @@ export * from './getIsVerifiedFromAsset';
 export * from './TokenPriceMap';
 export * from './applyPricesToElements';
 export * from './fixUsdValue';
+export * from './reduceYieldElements';

package/src/utils/index.js

@@ -64,4 +64,5 @@ __exportStar(require("./getIsVerifiedFromAsset"), exports);
 __exportStar(require("./TokenPriceMap"), exports);
 __exportStar(require("./applyPricesToElements"), exports);
 __exportStar(require("./fixUsdValue"), exports);
+__exportStar(require("./reduceYieldElements"), exports);
 //# sourceMappingURL=index.js.map

package/src/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/core/src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAuB;AACvB,oDAAkC;AAClC,kEAAgD;AAChD,sDAAoC;AACpC,iDAA+B;AAC/B,sDAAoC;AACpC,kDAAgC;AAChC,uDAAqC;AACrC,4DAA0C;AAC1C,+DAA6C;AAC7C,gDAA8B;AAC9B,oDAAkC;AAClC,mDAAiC;AACjC,wDAAsC;AACtC,qDAAmC;AACnC,+DAA6C;AAC7C,2DAAyC;AACzC,uDAAqC;AACrC,mDAAiC;AACjC,wDAAsC;AACtC,2DAAyC;AACzC,+DAA6C;AAC7C,kEAAgD;AAChD,yDAAuC;AACvC,0DAAwC;AACxC,4DAA0C;AAC1C,8DAA4C;AAC5C,mDAAiC;AACjC,yDAAuC;AACvC,mEAAiD;AACjD,oEAAkD;AAClD,+CAA6B;AAC7B,yDAAuC;AACvC,0DAAwC;AACxC,4DAA0C;AAC1C,wDAAsC;AACtC,2DAAyC;AACzC,sDAAoC;AACpC,uDAAqC;AACrC,uDAAqC;AACrC,sDAAoC;AACpC,uDAAqC;AACrC,8DAA4C;AAC5C,8DAA4C;AAC5C,mDAAiC;AACjC,uDAAqC;AACrC,2DAAyC;AACzC,kDAAgC;AAChC,0DAAwC;AACxC,gDAA8B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/core/src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAuB;AACvB,oDAAkC;AAClC,kEAAgD;AAChD,sDAAoC;AACpC,iDAA+B;AAC/B,sDAAoC;AACpC,kDAAgC;AAChC,uDAAqC;AACrC,4DAA0C;AAC1C,+DAA6C;AAC7C,gDAA8B;AAC9B,oDAAkC;AAClC,mDAAiC;AACjC,wDAAsC;AACtC,qDAAmC;AACnC,+DAA6C;AAC7C,2DAAyC;AACzC,uDAAqC;AACrC,mDAAiC;AACjC,wDAAsC;AACtC,2DAAyC;AACzC,+DAA6C;AAC7C,kEAAgD;AAChD,yDAAuC;AACvC,0DAAwC;AACxC,4DAA0C;AAC1C,8DAA4C;AAC5C,mDAAiC;AACjC,yDAAuC;AACvC,mEAAiD;AACjD,oEAAkD;AAClD,+CAA6B;AAC7B,yDAAuC;AACvC,0DAAwC;AACxC,4DAA0C;AAC1C,wDAAsC;AACtC,2DAAyC;AACzC,sDAAoC;AACpC,uDAAqC;AACrC,uDAAqC;AACrC,sDAAoC;AACpC,uDAAqC;AACrC,8DAA4C;AAC5C,8DAA4C;AAC5C,mDAAiC;AACjC,uDAAqC;AACrC,2DAAyC;AACzC,kDAAgC;AAChC,0DAAwC;AACxC,gDAA8B;AAC9B,wDAAsC"}

package/src/utils/reduceYieldElements.d.ts

@@ -0,0 +1,2 @@
+import { YieldElement } from '../Yield';
+export declare const reduceYieldElements: (yieldItems: YieldElement[]) => number;

package/src/utils/reduceYieldElements.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reduceYieldElements = void 0;
+const getUsdValueSum_1 = require("./getUsdValueSum");
+const reduceYieldElements = (yieldItems) => {
+    const totalValue = (0, getUsdValueSum_1.getUsdValueSum)(yieldItems.map((ye) => ye.value));
+    return yieldItems
+        .filter((ye) => ye.apy !== 0)
+        .reduce((sum, ye) => sum + (ye.apy * ye.value) / totalValue, 0);
+};
+exports.reduceYieldElements = reduceYieldElements;
+//# sourceMappingURL=reduceYieldElements.js.map

package/src/utils/reduceYieldElements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reduceYieldElements.js","sourceRoot":"","sources":["../../../../../packages/core/src/utils/reduceYieldElements.ts"],"names":[],"mappings":";;;AAAA,qDAAkD;AAG3C,MAAM,mBAAmB,GAAG,CAAC,UAA0B,EAAE,EAAE;IAChE,MAAM,UAAU,GAAG,IAAA,+BAAc,EAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IACpE,OAAO,UAAU;SACd,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC;SAC5B,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;AACpE,CAAC,CAAC;AALW,QAAA,mBAAmB,uBAK9B"}