@metamask-previews/assets-controller 0.2.0-preview-55087dcda → 0.2.0-preview-429bf064c

package/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Removed
+
+- **BREAKING:** Remove `initDataSources` and related exports (`InitDataSourcesOptions`, `DataSources`, `DataSourceActions`, `DataSourceEvents`, `DataSourceAllowedActions`, `DataSourceAllowedEvents`, `RootMessenger`). Initialize assets by creating `AssetsController` with `queryApiClient`; the controller instantiates all data sources internally ([#7859](https://github.com/MetaMask/core/pull/7859))
+
 ## [0.2.0]
 
 ### Added

package/dist/AssetsController-method-action-types.cjs

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=AssetsController-method-action-types.cjs.map

package/dist/AssetsController-method-action-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssetsController-method-action-types.cjs","sourceRoot":"","sources":["../src/AssetsController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { AssetsController } from './AssetsController';\n\nexport type AssetsControllerGetAssetsAction = {\n  type: `AssetsController:getAssets`;\n  handler: AssetsController['getAssets'];\n};\n\nexport type AssetsControllerGetAssetsBalanceAction = {\n  type: `AssetsController:getAssetsBalance`;\n  handler: AssetsController['getAssetsBalance'];\n};\n\nexport type AssetsControllerGetAssetMetadataAction = {\n  type: `AssetsController:getAssetMetadata`;\n  handler: AssetsController['getAssetMetadata'];\n};\n\nexport type AssetsControllerGetAssetsPriceAction = {\n  type: `AssetsController:getAssetsPrice`;\n  handler: AssetsController['getAssetsPrice'];\n};\n\n/**\n * Add a custom asset for an account.\n * Custom assets are included in subscription and fetch operations.\n * Adding a custom asset also unhides it if it was previously hidden.\n *\n * @param accountId - The account ID to add the custom asset for.\n * @param assetId - The CAIP-19 asset ID to add.\n */\nexport type AssetsControllerAddCustomAssetAction = {\n  type: `AssetsController:addCustomAsset`;\n  handler: AssetsController['addCustomAsset'];\n};\n\n/**\n * Remove a custom asset from an account.\n *\n * @param accountId - The account ID to remove the custom asset from.\n * @param assetId - The CAIP-19 asset ID to remove.\n */\nexport type AssetsControllerRemoveCustomAssetAction = {\n  type: `AssetsController:removeCustomAsset`;\n  handler: AssetsController['removeCustomAsset'];\n};\n\n/**\n * Get all custom assets for an account.\n *\n * @param accountId - The account ID to get custom assets for.\n * @returns Array of CAIP-19 asset IDs for the account's custom assets.\n */\nexport type AssetsControllerGetCustomAssetsAction = {\n  type: `AssetsController:getCustomAssets`;\n  handler: AssetsController['getCustomAssets'];\n};\n\n/**\n * Hide an asset globally.\n * Hidden assets are excluded from the asset list returned by getAssets.\n * The hidden state is stored in assetPreferences.\n *\n * @param assetId - The CAIP-19 asset ID to hide.\n */\nexport type AssetsControllerHideAssetAction = {\n  type: `AssetsController:hideAsset`;\n  handler: AssetsController['hideAsset'];\n};\n\n/**\n * Unhide an asset globally.\n *\n * @param assetId - The CAIP-19 asset ID to unhide.\n */\nexport type AssetsControllerUnhideAssetAction = {\n  type: `AssetsController:unhideAsset`;\n  handler: AssetsController['unhideAsset'];\n};\n\n/**\n * Union of all AssetsController action types.\n */\nexport type AssetsControllerMethodActions =\n  | AssetsControllerGetAssetsAction\n  | AssetsControllerGetAssetsBalanceAction\n  | AssetsControllerGetAssetMetadataAction\n  | AssetsControllerGetAssetsPriceAction\n  | AssetsControllerAddCustomAssetAction\n  | AssetsControllerRemoveCustomAssetAction\n  | AssetsControllerGetCustomAssetsAction\n  | AssetsControllerHideAssetAction\n  | AssetsControllerUnhideAssetAction;\n"]}

package/dist/AssetsController-method-action-types.d.cts

@@ -0,0 +1,78 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { AssetsController } from "./AssetsController.cjs";
+export type AssetsControllerGetAssetsAction = {
+    type: `AssetsController:getAssets`;
+    handler: AssetsController['getAssets'];
+};
+export type AssetsControllerGetAssetsBalanceAction = {
+    type: `AssetsController:getAssetsBalance`;
+    handler: AssetsController['getAssetsBalance'];
+};
+export type AssetsControllerGetAssetMetadataAction = {
+    type: `AssetsController:getAssetMetadata`;
+    handler: AssetsController['getAssetMetadata'];
+};
+export type AssetsControllerGetAssetsPriceAction = {
+    type: `AssetsController:getAssetsPrice`;
+    handler: AssetsController['getAssetsPrice'];
+};
+/**
+ * Add a custom asset for an account.
+ * Custom assets are included in subscription and fetch operations.
+ * Adding a custom asset also unhides it if it was previously hidden.
+ *
+ * @param accountId - The account ID to add the custom asset for.
+ * @param assetId - The CAIP-19 asset ID to add.
+ */
+export type AssetsControllerAddCustomAssetAction = {
+    type: `AssetsController:addCustomAsset`;
+    handler: AssetsController['addCustomAsset'];
+};
+/**
+ * Remove a custom asset from an account.
+ *
+ * @param accountId - The account ID to remove the custom asset from.
+ * @param assetId - The CAIP-19 asset ID to remove.
+ */
+export type AssetsControllerRemoveCustomAssetAction = {
+    type: `AssetsController:removeCustomAsset`;
+    handler: AssetsController['removeCustomAsset'];
+};
+/**
+ * Get all custom assets for an account.
+ *
+ * @param accountId - The account ID to get custom assets for.
+ * @returns Array of CAIP-19 asset IDs for the account's custom assets.
+ */
+export type AssetsControllerGetCustomAssetsAction = {
+    type: `AssetsController:getCustomAssets`;
+    handler: AssetsController['getCustomAssets'];
+};
+/**
+ * Hide an asset globally.
+ * Hidden assets are excluded from the asset list returned by getAssets.
+ * The hidden state is stored in assetPreferences.
+ *
+ * @param assetId - The CAIP-19 asset ID to hide.
+ */
+export type AssetsControllerHideAssetAction = {
+    type: `AssetsController:hideAsset`;
+    handler: AssetsController['hideAsset'];
+};
+/**
+ * Unhide an asset globally.
+ *
+ * @param assetId - The CAIP-19 asset ID to unhide.
+ */
+export type AssetsControllerUnhideAssetAction = {
+    type: `AssetsController:unhideAsset`;
+    handler: AssetsController['unhideAsset'];
+};
+/**
+ * Union of all AssetsController action types.
+ */
+export type AssetsControllerMethodActions = AssetsControllerGetAssetsAction | AssetsControllerGetAssetsBalanceAction | AssetsControllerGetAssetMetadataAction | AssetsControllerGetAssetsPriceAction | AssetsControllerAddCustomAssetAction | AssetsControllerRemoveCustomAssetAction | AssetsControllerGetCustomAssetsAction | AssetsControllerHideAssetAction | AssetsControllerUnhideAssetAction;
+//# sourceMappingURL=AssetsController-method-action-types.d.cts.map

package/dist/AssetsController-method-action-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssetsController-method-action-types.d.cts","sourceRoot":"","sources":["../src/AssetsController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,+BAA2B;AAE3D,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;CAChD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;CACxC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GACrC,+BAA+B,GAC/B,sCAAsC,GACtC,sCAAsC,GACtC,oCAAoC,GACpC,oCAAoC,GACpC,uCAAuC,GACvC,qCAAqC,GACrC,+BAA+B,GAC/B,iCAAiC,CAAC"}

package/dist/AssetsController-method-action-types.d.mts

@@ -0,0 +1,78 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { AssetsController } from "./AssetsController.mjs";
+export type AssetsControllerGetAssetsAction = {
+    type: `AssetsController:getAssets`;
+    handler: AssetsController['getAssets'];
+};
+export type AssetsControllerGetAssetsBalanceAction = {
+    type: `AssetsController:getAssetsBalance`;
+    handler: AssetsController['getAssetsBalance'];
+};
+export type AssetsControllerGetAssetMetadataAction = {
+    type: `AssetsController:getAssetMetadata`;
+    handler: AssetsController['getAssetMetadata'];
+};
+export type AssetsControllerGetAssetsPriceAction = {
+    type: `AssetsController:getAssetsPrice`;
+    handler: AssetsController['getAssetsPrice'];
+};
+/**
+ * Add a custom asset for an account.
+ * Custom assets are included in subscription and fetch operations.
+ * Adding a custom asset also unhides it if it was previously hidden.
+ *
+ * @param accountId - The account ID to add the custom asset for.
+ * @param assetId - The CAIP-19 asset ID to add.
+ */
+export type AssetsControllerAddCustomAssetAction = {
+    type: `AssetsController:addCustomAsset`;
+    handler: AssetsController['addCustomAsset'];
+};
+/**
+ * Remove a custom asset from an account.
+ *
+ * @param accountId - The account ID to remove the custom asset from.
+ * @param assetId - The CAIP-19 asset ID to remove.
+ */
+export type AssetsControllerRemoveCustomAssetAction = {
+    type: `AssetsController:removeCustomAsset`;
+    handler: AssetsController['removeCustomAsset'];
+};
+/**
+ * Get all custom assets for an account.
+ *
+ * @param accountId - The account ID to get custom assets for.
+ * @returns Array of CAIP-19 asset IDs for the account's custom assets.
+ */
+export type AssetsControllerGetCustomAssetsAction = {
+    type: `AssetsController:getCustomAssets`;
+    handler: AssetsController['getCustomAssets'];
+};
+/**
+ * Hide an asset globally.
+ * Hidden assets are excluded from the asset list returned by getAssets.
+ * The hidden state is stored in assetPreferences.
+ *
+ * @param assetId - The CAIP-19 asset ID to hide.
+ */
+export type AssetsControllerHideAssetAction = {
+    type: `AssetsController:hideAsset`;
+    handler: AssetsController['hideAsset'];
+};
+/**
+ * Unhide an asset globally.
+ *
+ * @param assetId - The CAIP-19 asset ID to unhide.
+ */
+export type AssetsControllerUnhideAssetAction = {
+    type: `AssetsController:unhideAsset`;
+    handler: AssetsController['unhideAsset'];
+};
+/**
+ * Union of all AssetsController action types.
+ */
+export type AssetsControllerMethodActions = AssetsControllerGetAssetsAction | AssetsControllerGetAssetsBalanceAction | AssetsControllerGetAssetMetadataAction | AssetsControllerGetAssetsPriceAction | AssetsControllerAddCustomAssetAction | AssetsControllerRemoveCustomAssetAction | AssetsControllerGetCustomAssetsAction | AssetsControllerHideAssetAction | AssetsControllerUnhideAssetAction;
+//# sourceMappingURL=AssetsController-method-action-types.d.mts.map

package/dist/AssetsController-method-action-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssetsController-method-action-types.d.mts","sourceRoot":"","sources":["../src/AssetsController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,+BAA2B;AAE3D,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;CAChD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;CACxC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GACrC,+BAA+B,GAC/B,sCAAsC,GACtC,sCAAsC,GACtC,oCAAoC,GACpC,oCAAoC,GACpC,uCAAuC,GACvC,qCAAqC,GACrC,+BAA+B,GAC/B,iCAAiC,CAAC"}

package/dist/AssetsController-method-action-types.mjs

@@ -0,0 +1,6 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+export {};
+//# sourceMappingURL=AssetsController-method-action-types.mjs.map

package/dist/AssetsController-method-action-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssetsController-method-action-types.mjs","sourceRoot":"","sources":["../src/AssetsController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { AssetsController } from './AssetsController';\n\nexport type AssetsControllerGetAssetsAction = {\n  type: `AssetsController:getAssets`;\n  handler: AssetsController['getAssets'];\n};\n\nexport type AssetsControllerGetAssetsBalanceAction = {\n  type: `AssetsController:getAssetsBalance`;\n  handler: AssetsController['getAssetsBalance'];\n};\n\nexport type AssetsControllerGetAssetMetadataAction = {\n  type: `AssetsController:getAssetMetadata`;\n  handler: AssetsController['getAssetMetadata'];\n};\n\nexport type AssetsControllerGetAssetsPriceAction = {\n  type: `AssetsController:getAssetsPrice`;\n  handler: AssetsController['getAssetsPrice'];\n};\n\n/**\n * Add a custom asset for an account.\n * Custom assets are included in subscription and fetch operations.\n * Adding a custom asset also unhides it if it was previously hidden.\n *\n * @param accountId - The account ID to add the custom asset for.\n * @param assetId - The CAIP-19 asset ID to add.\n */\nexport type AssetsControllerAddCustomAssetAction = {\n  type: `AssetsController:addCustomAsset`;\n  handler: AssetsController['addCustomAsset'];\n};\n\n/**\n * Remove a custom asset from an account.\n *\n * @param accountId - The account ID to remove the custom asset from.\n * @param assetId - The CAIP-19 asset ID to remove.\n */\nexport type AssetsControllerRemoveCustomAssetAction = {\n  type: `AssetsController:removeCustomAsset`;\n  handler: AssetsController['removeCustomAsset'];\n};\n\n/**\n * Get all custom assets for an account.\n *\n * @param accountId - The account ID to get custom assets for.\n * @returns Array of CAIP-19 asset IDs for the account's custom assets.\n */\nexport type AssetsControllerGetCustomAssetsAction = {\n  type: `AssetsController:getCustomAssets`;\n  handler: AssetsController['getCustomAssets'];\n};\n\n/**\n * Hide an asset globally.\n * Hidden assets are excluded from the asset list returned by getAssets.\n * The hidden state is stored in assetPreferences.\n *\n * @param assetId - The CAIP-19 asset ID to hide.\n */\nexport type AssetsControllerHideAssetAction = {\n  type: `AssetsController:hideAsset`;\n  handler: AssetsController['hideAsset'];\n};\n\n/**\n * Unhide an asset globally.\n *\n * @param assetId - The CAIP-19 asset ID to unhide.\n */\nexport type AssetsControllerUnhideAssetAction = {\n  type: `AssetsController:unhideAsset`;\n  handler: AssetsController['unhideAsset'];\n};\n\n/**\n * Union of all AssetsController action types.\n */\nexport type AssetsControllerMethodActions =\n  | AssetsControllerGetAssetsAction\n  | AssetsControllerGetAssetsBalanceAction\n  | AssetsControllerGetAssetMetadataAction\n  | AssetsControllerGetAssetsPriceAction\n  | AssetsControllerAddCustomAssetAction\n  | AssetsControllerRemoveCustomAssetAction\n  | AssetsControllerGetCustomAssetsAction\n  | AssetsControllerHideAssetAction\n  | AssetsControllerUnhideAssetAction;\n"]}