CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Changed

• Bump @metamask/superstruct from ^3.1.0 to ^3.4.1 (#9754)

0.8.0

Added

• Add AiDigestController.fetchFrontPageItem(id) (and the underlying AiDigestService.fetchFrontPageItem) which fetches a single market overview "front page" by id from GET /market-overview/front-page/:id, exposed via the AiDigestController:fetchFrontPageItem messenger action (#9394)
• Add MarketOverviewFrontPage and MarketOverviewItem types (#9394)

Changed

• Bump @metamask/utils from ^11.9.0 to ^11.11.0 (#9074)
• Bump @metamask/messenger from ^1.2.0 to ^2.0.0 (#9392)

0.7.0

Changed

• Bump @metamask/messenger from ^1.0.0 to ^1.2.0 (#8364, #8373, #8632)
• Bump @metamask/base-controller from ^9.0.1 to ^9.1.0 (#8457)

Fixed

• RelatedAsset.name and RelatedAsset.sourceAssetId are now optional in both the superstruct schema and TypeScript type, so a relatedAsset missing either field no longer causes fetchMarketOverview to throw API_INVALID_RESPONSE. (#8920)

0.6.3

Fixed

• RelatedAsset.caip19 is now optional (string[] | undefined) to match the live API, which omits the field for perps-only synthetic assets (e.g. ETHFI). AiDigestService.fetchMarketOverview normalises absent caip19 values to [] so consumers always receive a string[]. (#8326)

0.6.2

Changed

• Bump @metamask/base-controller from ^9.0.0 to ^9.0.1 (#8317)
• Bump @metamask/messenger from ^0.3.0 to ^1.0.0 (#8317)

0.6.1

Changed

• RelatedAsset.hlPerpsMarket is now string[] (optional) instead of string to match the /market-overview API payload shape. AiDigestService.fetchMarketOverview now validates hlPerpsMarket as an array of strings and rejects string values. (#8308)

0.6.0

Added

• MarketInsightsReport now includes a required digestId field containing the unique UUID returned in the /asset-summary API response envelope. (#8283)
• AiDigestService now requires the { id, digest } / { id, report } envelope shape and exposes id as digestId on the returned report objects; bare (non-enveloped) responses are no longer accepted. (#8283)

0.5.0

Changed

• AiDigestService.searchDigest now uses the universal asset query parameter instead of the previous caipAssetType / hlPerpsMarket branching logic. The public TypeScript API is unchanged; any identifier (CAIP-19, ticker, name, perps market id) can be passed as before. (#8263)
• RelatedAsset.hlPerpsMarket now covers all HyperLiquid market identifiers — both regular crypto tokens (BTC, ETH) and purely synthetic perps assets (xyz:TSLA). No separate field is needed; clients use caip19 presence to decide the icon resolution strategy. (#8263)

0.4.0

Added

• Export new RelatedAsset type representing a rich asset object returned in MarketOverviewTrend.relatedAssets. (#8218)

Changed

• MarketOverviewTrend.relatedAssets is now RelatedAsset[] instead of string[]. Each entry includes name, symbol, caip19, sourceAssetId, and optional hlPerpsMarket fields. (#8218)
• MarketOverview.headline, summary, and sources have been removed; they are not part of the /market-overview API response. (#8218)
• MarketOverviewTrend.category and impact are now optional to match the live API response shape. (#8218)
• AiDigestService.fetchMarketOverview now accepts both flat MarketOverview and { report: MarketOverview } enveloped responses, matching the live API shape. (#8218)

0.3.0

Changed

• AiDigestService.searchDigest and AiDigestController.fetchMarketInsights now accept any string identifier rather than only CAIP-19 asset types. CAIP-19 identifiers continue to use the caipAssetType query parameter; all other strings (e.g. perps market symbols like ETH) use the new hlPerpsMarket query parameter. (#8182)
• Rename caip19Id parameter to assetIdentifier in DigestService.searchDigest, MarketInsightsEntry, and AiDigestController.fetchMarketInsights. (#8182)
• Replace INVALID_CAIP_ASSET_TYPE error message constant with INVALID_ASSET_IDENTIFIER in AiDigestControllerErrorMessage. (#8182)

0.2.0

Added

• Add fetchMarketOverview method to AiDigestService, with superstruct validation of the MarketOverview response shape. (#8109)
• Export new shared sub-types Article, Tweet, Source, AIResponseMetadata, MarketOverview, MarketOverviewEntry, MarketOverviewTrend, and AiDigestControllerFetchMarketOverviewAction. (#8109)

Changed

• Strengthen AiDigestService response validation using nested superstruct schemas for market insights payloads, including deep validation of trends/sources items and support for optional top-level social entries while allowing additional unknown API fields for forward compatibility. (#8006)
• Rename shared sub-types MarketInsightsArticle, MarketInsightsTweet, and MarketInsightsSource to Article, Tweet, and Source; original names are kept as type aliases for backward compatibility. (#8109)
• Tighten MarketInsightsTrend.category and MarketInsightsTrend.impact to closed string unions matching the API spec; Source.type is also now a closed union ('news' | 'data' | 'social'). (#8109)
• Update searchDigest endpoint from /digests to /asset-summary. (#8109)
• Add optional metadata field to MarketInsightsReport. (#8109)

0.1.0

Added

• Initial release (#7693)
• Add AiDigestController for fetching and caching AI-generated asset digests (#7746)
• Add Market Insights support to AiDigestController with fetchMarketInsights action (#7930)
• Add searchDigest method to AiDigestService for calling the GET endpoint (currently mocked) (#7930)

Changed

• Validate searchDigest API responses and throw when the payload does not match the expected MarketInsightsReport shape.
• Normalize searchDigest responses from either direct report payloads or digest envelope payloads.

Removed

• Remove legacy digest APIs and digest cache from AiDigestController and AiDigestService; only market insights APIs remain.
  • Removes fetchDigest, clearDigest, and clearAllDigests actions from the controller action surface.
  • Removes DigestData/DigestEntry types and the digests state branch.