@metamask/profile-sync-controller 0.5.0 → 0.6.0

package/dist/{types/controllers/user-storage/UserStorageController.d.ts → controllers/user-storage/UserStorageController.d.cts}

@@ -1,10 +1,24 @@
-import type { AccountsControllerListAccountsAction, AccountsControllerUpdateAccountMetadataAction, AccountsControllerGetAccountByAddressAction, AccountsControllerAccountRenamedEvent, AccountsControllerAccountAddedEvent } from '@metamask/accounts-controller';
-import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedControllerMessenger } from '@metamask/base-controller';
-import { BaseController } from '@metamask/base-controller';
-import type { KeyringControllerGetStateAction, KeyringControllerLockEvent, KeyringControllerUnlockEvent, KeyringControllerAddNewAccountAction } from '@metamask/keyring-controller';
-import type { HandleSnapRequest } from '@metamask/snaps-controllers';
-import type { AuthenticationControllerGetBearerToken, AuthenticationControllerGetSessionProfile, AuthenticationControllerIsSignedIn, AuthenticationControllerPerformSignIn, AuthenticationControllerPerformSignOut } from '../authentication/AuthenticationController';
-import type { UserStoragePathWithFeatureAndKey, UserStoragePathWithFeatureOnly } from './schema';
+import type { AccountsControllerListAccountsAction, AccountsControllerUpdateAccountMetadataAction, AccountsControllerAccountRenamedEvent, AccountsControllerAccountAddedEvent } from "@metamask/accounts-controller";
+import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedControllerMessenger } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { InternalAccount } from "@metamask/keyring-api";
+import type { KeyringControllerGetStateAction, KeyringControllerLockEvent, KeyringControllerUnlockEvent, KeyringControllerAddNewAccountAction } from "@metamask/keyring-controller";
+import type { NetworkConfiguration } from "@metamask/network-controller";
+import type { HandleSnapRequest } from "@metamask/snaps-controllers";
+import type { AuthenticationControllerGetBearerToken, AuthenticationControllerGetSessionProfile, AuthenticationControllerIsSignedIn, AuthenticationControllerPerformSignIn, AuthenticationControllerPerformSignOut } from "../authentication/AuthenticationController.cjs";
+import type { UserStoragePathWithFeatureAndKey, UserStoragePathWithFeatureOnly } from "./schema.cjs";
+type NetworkControllerNetworkAddedEvent = {
+    type: 'NetworkController:networkAdded';
+    payload: [networkConfiguration: NetworkConfiguration];
+};
+type NetworkControllerNetworkChangedEvent = {
+    type: 'NetworkController:networkChanged';
+    payload: [networkConfiguration: NetworkConfiguration];
+};
+type NetworkControllerNetworkDeletedEvent = {
+    type: 'NetworkController:networkDeleted';
+    payload: [networkConfiguration: NetworkConfiguration];
+};
 export declare type NotificationServicesControllerDisableNotificationServices = {
     type: `NotificationServicesController:disableNotificationServices`;
     handler: () => Promise<void>;
@@ -26,6 +40,20 @@ export type UserStorageControllerState = {
     isProfileSyncingUpdateLoading: boolean;
 };
 export declare const defaultState: UserStorageControllerState;
+type ControllerConfig = {
+    accountSyncing?: {
+        /**
+         * Callback that fires when account sync adds an account.
+         * This is used for analytics.
+         */
+        onAccountAdded?: (profileId: string) => void;
+        /**
+         * Callback that fires when account sync updates the name of an account.
+         * This is used for analytics.
+         */
+        onAccountNameUpdated?: (profileId: string) => void;
+    };
+};
 type CreateActionsObj<Controller extends keyof UserStorageController> = {
     [K in Controller]: {
         type: `${typeof controllerName}:${K}`;
@@ -43,10 +71,8 @@ export type UserStorageControllerEnableProfileSyncing = ActionsObj['enableProfil
 export type UserStorageControllerDisableProfileSyncing = ActionsObj['disableProfileSyncing'];
 export type UserStorageControllerSyncInternalAccountsWithUserStorage = ActionsObj['syncInternalAccountsWithUserStorage'];
 export type UserStorageControllerSaveInternalAccountToUserStorage = ActionsObj['saveInternalAccountToUserStorage'];
+export type AllowedActions = KeyringControllerGetStateAction | HandleSnapRequest | AuthenticationControllerGetBearerToken | AuthenticationControllerGetSessionProfile | AuthenticationControllerPerformSignIn | AuthenticationControllerIsSignedIn | AuthenticationControllerPerformSignOut | NotificationServicesControllerDisableNotificationServices | NotificationServicesControllerSelectIsNotificationServicesEnabled | AccountsControllerListAccountsAction | AccountsControllerUpdateAccountMetadataAction | KeyringControllerAddNewAccountAction;
 export type UserStorageControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, UserStorageControllerState>;
-export type Events = UserStorageControllerStateChangeEvent;
-export type AllowedActions = KeyringControllerGetStateAction | HandleSnapRequest | AuthenticationControllerGetBearerToken | AuthenticationControllerGetSessionProfile | AuthenticationControllerPerformSignIn | AuthenticationControllerIsSignedIn | AuthenticationControllerPerformSignOut | NotificationServicesControllerDisableNotificationServices | NotificationServicesControllerSelectIsNotificationServicesEnabled | AccountsControllerListAccountsAction | AccountsControllerGetAccountByAddressAction | AccountsControllerUpdateAccountMetadataAction | KeyringControllerAddNewAccountAction;
-export type UserStorageControllerChangeEvent = ControllerStateChangeEvent<typeof controllerName, UserStorageControllerState>;
 export type UserStorageControllerAccountSyncingInProgress = {
     type: `${typeof controllerName}:accountSyncingInProgress`;
     payload: [boolean];
@@ -55,7 +81,8 @@ export type UserStorageControllerAccountSyncingComplete = {
     type: `${typeof controllerName}:accountSyncingComplete`;
     payload: [boolean];
 };
-export type AllowedEvents = UserStorageControllerChangeEvent | UserStorageControllerAccountSyncingInProgress | UserStorageControllerAccountSyncingComplete | KeyringControllerLockEvent | KeyringControllerUnlockEvent | AccountsControllerAccountAddedEvent | AccountsControllerAccountRenamedEvent;
+export type Events = UserStorageControllerStateChangeEvent | UserStorageControllerAccountSyncingInProgress | UserStorageControllerAccountSyncingComplete;
+export type AllowedEvents = UserStorageControllerStateChangeEvent | UserStorageControllerAccountSyncingInProgress | UserStorageControllerAccountSyncingComplete | KeyringControllerLockEvent | KeyringControllerUnlockEvent | AccountsControllerAccountAddedEvent | AccountsControllerAccountRenamedEvent | NetworkControllerNetworkAddedEvent | NetworkControllerNetworkChangedEvent | NetworkControllerNetworkDeletedEvent;
 export type UserStorageControllerMessenger = RestrictedControllerMessenger<typeof controllerName, Actions | AllowedActions, Events | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
 /**
  * Reusable controller that allows any team to store synchronized data for a given user.
@@ -68,11 +95,13 @@ export type UserStorageControllerMessenger = RestrictedControllerMessenger<typeo
 export default class UserStorageController extends BaseController<typeof controllerName, UserStorageControllerState, UserStorageControllerMessenger> {
     #private;
     getMetaMetricsState: () => boolean;
-    constructor({ messenger, state, env, getMetaMetricsState, nativeScryptCrypto, }: {
+    constructor({ messenger, state, env, config, getMetaMetricsState, nativeScryptCrypto, }: {
         messenger: UserStorageControllerMessenger;
         state?: UserStorageControllerState;
+        config?: ControllerConfig;
         env?: {
             isAccountSyncingEnabled?: boolean;
+            isNetworkSyncingEnabled?: boolean;
         };
         getMetaMetricsState: () => boolean;
         nativeScryptCrypto?: NativeScrypt;
@@ -119,9 +148,9 @@ export default class UserStorageController extends BaseController<typeof control
     syncInternalAccountsWithUserStorage(): Promise<void>;
     /**
      * Saves an individual internal account to the user storage.
-     * @param address - The address of the internal account to save
+     * @param internalAccount - The internal account to save
      */
-    saveInternalAccountToUserStorage(address: string): Promise<void>;
+    saveInternalAccountToUserStorage(internalAccount: InternalAccount): Promise<void>;
 }
 export {};
-//# sourceMappingURL=UserStorageController.d.ts.map
+//# sourceMappingURL=UserStorageController.d.cts.map

package/dist/controllers/user-storage/UserStorageController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserStorageController.d.cts","sourceRoot":"","sources":["../../../src/controllers/user-storage/UserStorageController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oCAAoC,EACpC,6CAA6C,EAC7C,qCAAqC,EACrC,mCAAmC,EACpC,sCAAsC;AACvC,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,6BAA6B,EAE9B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,8BAA8B;AAC7D,OAAO,KAAK,EACV,+BAA+B,EAC/B,0BAA0B,EAC1B,4BAA4B,EAC5B,oCAAoC,EACrC,qCAAqC;AACtC,OAAO,KAAK,EAAE,oBAAoB,EAAE,qCAAqC;AACzE,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAoC;AAGrE,OAAO,KAAK,EACV,sCAAsC,EACtC,yCAAyC,EACzC,kCAAkC,EAClC,qCAAqC,EACrC,sCAAsC,EACvC,uDAAmD;AAQpD,OAAO,KAAK,EACV,gCAAgC,EAChC,8BAA8B,EAC/B,qBAAiB;AASlB,KAAK,kCAAkC,GAAG;IACxC,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAC;CACvD,CAAC;AAIF,KAAK,oCAAoC,GAAG;IAC1C,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAC;CACvD,CAAC;AAIF,KAAK,oCAAoC,GAAG;IAC1C,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAC;CACvD,CAAC;AAGF,MAAM,CAAC,OAAO,MAAM,yDAAyD,GAC3E;IACE,IAAI,EAAE,4DAA4D,CAAC;IACnE,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B,CAAC;AAEJ,MAAM,CAAC,OAAO,MAAM,iEAAiE,GACnF;IACE,IAAI,EAAE,oEAAoE,CAAC;IAC3E,OAAO,EAAE,MAAM,OAAO,CAAC;CACxB,CAAC;AAEJ,MAAM,CAAC,OAAO,MAAM,YAAY,GAAG,CACjC,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,UAAU,EAChB,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,IAAI,EAAE,MAAM,KACT,OAAO,CAAC,UAAU,CAAC,CAAC;AAEzB,QAAA,MAAM,cAAc,0BAA0B,CAAC;AAG/C,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,uBAAuB,EAAE,OAAO,GAAG,IAAI,CAAC;IACxC;;OAEG;IACH,6BAA6B,EAAE,OAAO,CAAC;CACxC,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,0BAG1B,CAAC;AAaF,KAAK,gBAAgB,GAAG;IACtB,cAAc,CAAC,EAAE;QACf;;;WAGG;QACH,cAAc,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;QAE7C;;;WAGG;QACH,oBAAoB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;KACpD,CAAC;CACH,CAAC;AAGF,KAAK,gBAAgB,CAAC,UAAU,SAAS,MAAM,qBAAqB,IAAI;KACrE,CAAC,IAAI,UAAU,GAAG;QACjB,IAAI,EAAE,GAAG,OAAO,cAAc,IAAI,CAAC,EAAE,CAAC;QACtC,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;KACnC;CACF,CAAC;AACF,KAAK,UAAU,GAAG,gBAAgB,CAC9B,mBAAmB,GACnB,oCAAoC,GACpC,mBAAmB,GACnB,eAAe,GACf,sBAAsB,GACtB,uBAAuB,GACvB,qCAAqC,GACrC,kCAAkC,CACrC,CAAC;AACF,MAAM,MAAM,mCAAmC,GAAG,wBAAwB,CACxE,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AACF,MAAM,MAAM,OAAO,GACf,UAAU,CAAC,MAAM,UAAU,CAAC,GAC5B,mCAAmC,CAAC;AACxC,MAAM,MAAM,sCAAsC,GAChD,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAClC,MAAM,MAAM,uDAAuD,GACjE,UAAU,CAAC,oCAAoC,CAAC,CAAC;AACnD,MAAM,MAAM,sCAAsC,GAChD,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAClC,MAAM,MAAM,kCAAkC,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;AAC7E,MAAM,MAAM,yCAAyC,GACnD,UAAU,CAAC,sBAAsB,CAAC,CAAC;AACrC,MAAM,MAAM,0CAA0C,GACpD,UAAU,CAAC,uBAAuB,CAAC,CAAC;AACtC,MAAM,MAAM,wDAAwD,GAClE,UAAU,CAAC,qCAAqC,CAAC,CAAC;AACpD,MAAM,MAAM,qDAAqD,GAC/D,UAAU,CAAC,kCAAkC,CAAC,CAAC;AAEjD,MAAM,MAAM,cAAc,GAEtB,+BAA+B,GAE/B,iBAAiB,GAEjB,sCAAsC,GACtC,yCAAyC,GACzC,qCAAqC,GACrC,kCAAkC,GAClC,sCAAsC,GAEtC,yDAAyD,GACzD,iEAAiE,GAEjE,oCAAoC,GACpC,6CAA6C,GAC7C,oCAAoC,CAAC;AAGzC,MAAM,MAAM,qCAAqC,GAAG,0BAA0B,CAC5E,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AACF,MAAM,MAAM,6CAA6C,GAAG;IAC1D,IAAI,EAAE,GAAG,OAAO,cAAc,2BAA2B,CAAC;IAC1D,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,GAAG,OAAO,cAAc,yBAAyB,CAAC;IACxD,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,MAAM,GACd,qCAAqC,GACrC,6CAA6C,GAC7C,2CAA2C,CAAC;AAEhD,MAAM,MAAM,aAAa,GACrB,qCAAqC,GACrC,6CAA6C,GAC7C,2CAA2C,GAC3C,0BAA0B,GAC1B,4BAA4B,GAE5B,mCAAmC,GACnC,qCAAqC,GAErC,kCAAkC,GAClC,oCAAoC,GACpC,oCAAoC,CAAC;AAGzC,MAAM,MAAM,8BAA8B,GAAG,6BAA6B,CACxE,OAAO,cAAc,EACrB,OAAO,GAAG,cAAc,EACxB,MAAM,GAAG,aAAa,EACtB,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,cAAc,CAC/D,OAAO,cAAc,EACrB,0BAA0B,EAC1B,8BAA8B,CAC/B;;IAwJC,mBAAmB,EAAE,MAAM,OAAO,CAAC;gBAEvB,EACV,SAAS,EACT,KAAK,EACL,GAAG,EACH,MAAM,EACN,mBAAmB,EACnB,kBAAkB,GACnB,EAAE;QACD,SAAS,EAAE,8BAA8B,CAAC;QAC1C,KAAK,CAAC,EAAE,0BAA0B,CAAC;QACnC,MAAM,CAAC,EAAE,gBAAgB,CAAC;QAC1B,GAAG,CAAC,EAAE;YACJ,uBAAuB,CAAC,EAAE,OAAO,CAAC;YAClC,uBAAuB,CAAC,EAAE,OAAO,CAAC;SACnC,CAAC;QACF,mBAAmB,EAAE,MAAM,OAAO,CAAC;QACnC,kBAAkB,CAAC,EAAE,YAAY,CAAC;KACnC;IAmFY,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC;IAuBrC,0BAA0B,CACrC,uBAAuB,EAAE,OAAO,GAC/B,OAAO,CAAC,IAAI,CAAC;IAMH,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;IAoCnD;;;;;;OAMG;IACU,iBAAiB,CAC5B,IAAI,EAAE,gCAAgC,GACrC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAgBzB;;;;;;OAMG;IACU,kCAAkC,CAC7C,IAAI,EAAE,8BAA8B,GACnC,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC;IAgB3B;;;;;;;OAOG;IACU,iBAAiB,CAC5B,IAAI,EAAE,gCAAgC,EACtC,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC;IAchB;;;;OAIG;IACU,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAmF7C;;;;OAIG;IACG,mCAAmC,IAAI,OAAO,CAAC,IAAI,CAAC;IA6I1D;;;OAGG;IACG,gCAAgC,CACpC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAAC,IAAI,CAAC;CAcjB"}

package/dist/controllers/user-storage/UserStorageController.d.mts

@@ -0,0 +1,156 @@
+import type { AccountsControllerListAccountsAction, AccountsControllerUpdateAccountMetadataAction, AccountsControllerAccountRenamedEvent, AccountsControllerAccountAddedEvent } from "@metamask/accounts-controller";
+import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedControllerMessenger } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { InternalAccount } from "@metamask/keyring-api";
+import type { KeyringControllerGetStateAction, KeyringControllerLockEvent, KeyringControllerUnlockEvent, KeyringControllerAddNewAccountAction } from "@metamask/keyring-controller";
+import type { NetworkConfiguration } from "@metamask/network-controller";
+import type { HandleSnapRequest } from "@metamask/snaps-controllers";
+import type { AuthenticationControllerGetBearerToken, AuthenticationControllerGetSessionProfile, AuthenticationControllerIsSignedIn, AuthenticationControllerPerformSignIn, AuthenticationControllerPerformSignOut } from "../authentication/AuthenticationController.mjs";
+import type { UserStoragePathWithFeatureAndKey, UserStoragePathWithFeatureOnly } from "./schema.mjs";
+type NetworkControllerNetworkAddedEvent = {
+    type: 'NetworkController:networkAdded';
+    payload: [networkConfiguration: NetworkConfiguration];
+};
+type NetworkControllerNetworkChangedEvent = {
+    type: 'NetworkController:networkChanged';
+    payload: [networkConfiguration: NetworkConfiguration];
+};
+type NetworkControllerNetworkDeletedEvent = {
+    type: 'NetworkController:networkDeleted';
+    payload: [networkConfiguration: NetworkConfiguration];
+};
+export declare type NotificationServicesControllerDisableNotificationServices = {
+    type: `NotificationServicesController:disableNotificationServices`;
+    handler: () => Promise<void>;
+};
+export declare type NotificationServicesControllerSelectIsNotificationServicesEnabled = {
+    type: `NotificationServicesController:selectIsNotificationServicesEnabled`;
+    handler: () => boolean;
+};
+export declare type NativeScrypt = (passwd: string, salt: Uint8Array, N: number, r: number, p: number, size: number) => Promise<Uint8Array>;
+declare const controllerName = "UserStorageController";
+export type UserStorageControllerState = {
+    /**
+     * Condition used by UI and to determine if we can use some of the User Storage methods.
+     */
+    isProfileSyncingEnabled: boolean | null;
+    /**
+     * Loading state for the profile syncing update
+     */
+    isProfileSyncingUpdateLoading: boolean;
+};
+export declare const defaultState: UserStorageControllerState;
+type ControllerConfig = {
+    accountSyncing?: {
+        /**
+         * Callback that fires when account sync adds an account.
+         * This is used for analytics.
+         */
+        onAccountAdded?: (profileId: string) => void;
+        /**
+         * Callback that fires when account sync updates the name of an account.
+         * This is used for analytics.
+         */
+        onAccountNameUpdated?: (profileId: string) => void;
+    };
+};
+type CreateActionsObj<Controller extends keyof UserStorageController> = {
+    [K in Controller]: {
+        type: `${typeof controllerName}:${K}`;
+        handler: UserStorageController[K];
+    };
+};
+type ActionsObj = CreateActionsObj<'performGetStorage' | 'performGetStorageAllFeatureEntries' | 'performSetStorage' | 'getStorageKey' | 'enableProfileSyncing' | 'disableProfileSyncing' | 'syncInternalAccountsWithUserStorage' | 'saveInternalAccountToUserStorage'>;
+export type UserStorageControllerGetStateAction = ControllerGetStateAction<typeof controllerName, UserStorageControllerState>;
+export type Actions = ActionsObj[keyof ActionsObj] | UserStorageControllerGetStateAction;
+export type UserStorageControllerPerformGetStorage = ActionsObj['performGetStorage'];
+export type UserStorageControllerPerformGetStorageAllFeatureEntries = ActionsObj['performGetStorageAllFeatureEntries'];
+export type UserStorageControllerPerformSetStorage = ActionsObj['performSetStorage'];
+export type UserStorageControllerGetStorageKey = ActionsObj['getStorageKey'];
+export type UserStorageControllerEnableProfileSyncing = ActionsObj['enableProfileSyncing'];
+export type UserStorageControllerDisableProfileSyncing = ActionsObj['disableProfileSyncing'];
+export type UserStorageControllerSyncInternalAccountsWithUserStorage = ActionsObj['syncInternalAccountsWithUserStorage'];
+export type UserStorageControllerSaveInternalAccountToUserStorage = ActionsObj['saveInternalAccountToUserStorage'];
+export type AllowedActions = KeyringControllerGetStateAction | HandleSnapRequest | AuthenticationControllerGetBearerToken | AuthenticationControllerGetSessionProfile | AuthenticationControllerPerformSignIn | AuthenticationControllerIsSignedIn | AuthenticationControllerPerformSignOut | NotificationServicesControllerDisableNotificationServices | NotificationServicesControllerSelectIsNotificationServicesEnabled | AccountsControllerListAccountsAction | AccountsControllerUpdateAccountMetadataAction | KeyringControllerAddNewAccountAction;
+export type UserStorageControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, UserStorageControllerState>;
+export type UserStorageControllerAccountSyncingInProgress = {
+    type: `${typeof controllerName}:accountSyncingInProgress`;
+    payload: [boolean];
+};
+export type UserStorageControllerAccountSyncingComplete = {
+    type: `${typeof controllerName}:accountSyncingComplete`;
+    payload: [boolean];
+};
+export type Events = UserStorageControllerStateChangeEvent | UserStorageControllerAccountSyncingInProgress | UserStorageControllerAccountSyncingComplete;
+export type AllowedEvents = UserStorageControllerStateChangeEvent | UserStorageControllerAccountSyncingInProgress | UserStorageControllerAccountSyncingComplete | KeyringControllerLockEvent | KeyringControllerUnlockEvent | AccountsControllerAccountAddedEvent | AccountsControllerAccountRenamedEvent | NetworkControllerNetworkAddedEvent | NetworkControllerNetworkChangedEvent | NetworkControllerNetworkDeletedEvent;
+export type UserStorageControllerMessenger = RestrictedControllerMessenger<typeof controllerName, Actions | AllowedActions, Events | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+/**
+ * Reusable controller that allows any team to store synchronized data for a given user.
+ * These can be settings shared cross MetaMask clients, or data we want to persist when uninstalling/reinstalling.
+ *
+ * NOTE:
+ * - data stored on UserStorage is FULLY encrypted, with the only keys stored/managed on the client.
+ * - No one can access this data unless they are have the SRP and are able to run the signing snap.
+ */
+export default class UserStorageController extends BaseController<typeof controllerName, UserStorageControllerState, UserStorageControllerMessenger> {
+    #private;
+    getMetaMetricsState: () => boolean;
+    constructor({ messenger, state, env, config, getMetaMetricsState, nativeScryptCrypto, }: {
+        messenger: UserStorageControllerMessenger;
+        state?: UserStorageControllerState;
+        config?: ControllerConfig;
+        env?: {
+            isAccountSyncingEnabled?: boolean;
+            isNetworkSyncingEnabled?: boolean;
+        };
+        getMetaMetricsState: () => boolean;
+        nativeScryptCrypto?: NativeScrypt;
+    });
+    enableProfileSyncing(): Promise<void>;
+    setIsProfileSyncingEnabled(isProfileSyncingEnabled: boolean): Promise<void>;
+    disableProfileSyncing(): Promise<void>;
+    /**
+     * Allows retrieval of stored data. Data stored is string formatted.
+     * Developers can extend the entry path and entry name through the `schema.ts` file.
+     *
+     * @param path - string in the form of `${feature}.${key}` that matches schema
+     * @returns the decrypted string contents found from user storage (or null if not found)
+     */
+    performGetStorage(path: UserStoragePathWithFeatureAndKey): Promise<string | null>;
+    /**
+     * Allows retrieval of all stored data for a specific feature. Data stored is formatted as an array of strings.
+     * Developers can extend the entry path through the `schema.ts` file.
+     *
+     * @param path - string in the form of `${feature}` that matches schema
+     * @returns the array of decrypted string contents found from user storage (or null if not found)
+     */
+    performGetStorageAllFeatureEntries(path: UserStoragePathWithFeatureOnly): Promise<string[] | null>;
+    /**
+     * Allows storage of user data. Data stored must be string formatted.
+     * Developers can extend the entry path and entry name through the `schema.ts` file.
+     *
+     * @param path - string in the form of `${feature}.${key}` that matches schema
+     * @param value - The string data you want to store.
+     * @returns nothing. NOTE that an error is thrown if fails to store data.
+     */
+    performSetStorage(path: UserStoragePathWithFeatureAndKey, value: string): Promise<void>;
+    /**
+     * Retrieves the storage key, for internal use only!
+     *
+     * @returns the storage key
+     */
+    getStorageKey(): Promise<string>;
+    /**
+     * Syncs the internal accounts list with the user storage accounts list.
+     * This method is used to make sure that the internal accounts list is up-to-date with the user storage accounts list and vice-versa.
+     * It will add new accounts to the internal accounts list, update/merge conflicting names and re-upload the results in some cases to the user storage.
+     */
+    syncInternalAccountsWithUserStorage(): Promise<void>;
+    /**
+     * Saves an individual internal account to the user storage.
+     * @param internalAccount - The internal account to save
+     */
+    saveInternalAccountToUserStorage(internalAccount: InternalAccount): Promise<void>;
+}
+export {};
+//# sourceMappingURL=UserStorageController.d.mts.map

package/dist/controllers/user-storage/UserStorageController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserStorageController.d.mts","sourceRoot":"","sources":["../../../src/controllers/user-storage/UserStorageController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oCAAoC,EACpC,6CAA6C,EAC7C,qCAAqC,EACrC,mCAAmC,EACpC,sCAAsC;AACvC,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,6BAA6B,EAE9B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,8BAA8B;AAC7D,OAAO,KAAK,EACV,+BAA+B,EAC/B,0BAA0B,EAC1B,4BAA4B,EAC5B,oCAAoC,EACrC,qCAAqC;AACtC,OAAO,KAAK,EAAE,oBAAoB,EAAE,qCAAqC;AACzE,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAoC;AAGrE,OAAO,KAAK,EACV,sCAAsC,EACtC,yCAAyC,EACzC,kCAAkC,EAClC,qCAAqC,EACrC,sCAAsC,EACvC,uDAAmD;AAQpD,OAAO,KAAK,EACV,gCAAgC,EAChC,8BAA8B,EAC/B,qBAAiB;AASlB,KAAK,kCAAkC,GAAG;IACxC,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAC;CACvD,CAAC;AAIF,KAAK,oCAAoC,GAAG;IAC1C,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAC;CACvD,CAAC;AAIF,KAAK,oCAAoC,GAAG;IAC1C,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAC;CACvD,CAAC;AAGF,MAAM,CAAC,OAAO,MAAM,yDAAyD,GAC3E;IACE,IAAI,EAAE,4DAA4D,CAAC;IACnE,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B,CAAC;AAEJ,MAAM,CAAC,OAAO,MAAM,iEAAiE,GACnF;IACE,IAAI,EAAE,oEAAoE,CAAC;IAC3E,OAAO,EAAE,MAAM,OAAO,CAAC;CACxB,CAAC;AAEJ,MAAM,CAAC,OAAO,MAAM,YAAY,GAAG,CACjC,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,UAAU,EAChB,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,IAAI,EAAE,MAAM,KACT,OAAO,CAAC,UAAU,CAAC,CAAC;AAEzB,QAAA,MAAM,cAAc,0BAA0B,CAAC;AAG/C,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,uBAAuB,EAAE,OAAO,GAAG,IAAI,CAAC;IACxC;;OAEG;IACH,6BAA6B,EAAE,OAAO,CAAC;CACxC,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,0BAG1B,CAAC;AAaF,KAAK,gBAAgB,GAAG;IACtB,cAAc,CAAC,EAAE;QACf;;;WAGG;QACH,cAAc,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;QAE7C;;;WAGG;QACH,oBAAoB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;KACpD,CAAC;CACH,CAAC;AAGF,KAAK,gBAAgB,CAAC,UAAU,SAAS,MAAM,qBAAqB,IAAI;KACrE,CAAC,IAAI,UAAU,GAAG;QACjB,IAAI,EAAE,GAAG,OAAO,cAAc,IAAI,CAAC,EAAE,CAAC;QACtC,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;KACnC;CACF,CAAC;AACF,KAAK,UAAU,GAAG,gBAAgB,CAC9B,mBAAmB,GACnB,oCAAoC,GACpC,mBAAmB,GACnB,eAAe,GACf,sBAAsB,GACtB,uBAAuB,GACvB,qCAAqC,GACrC,kCAAkC,CACrC,CAAC;AACF,MAAM,MAAM,mCAAmC,GAAG,wBAAwB,CACxE,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AACF,MAAM,MAAM,OAAO,GACf,UAAU,CAAC,MAAM,UAAU,CAAC,GAC5B,mCAAmC,CAAC;AACxC,MAAM,MAAM,sCAAsC,GAChD,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAClC,MAAM,MAAM,uDAAuD,GACjE,UAAU,CAAC,oCAAoC,CAAC,CAAC;AACnD,MAAM,MAAM,sCAAsC,GAChD,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAClC,MAAM,MAAM,kCAAkC,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;AAC7E,MAAM,MAAM,yCAAyC,GACnD,UAAU,CAAC,sBAAsB,CAAC,CAAC;AACrC,MAAM,MAAM,0CAA0C,GACpD,UAAU,CAAC,uBAAuB,CAAC,CAAC;AACtC,MAAM,MAAM,wDAAwD,GAClE,UAAU,CAAC,qCAAqC,CAAC,CAAC;AACpD,MAAM,MAAM,qDAAqD,GAC/D,UAAU,CAAC,kCAAkC,CAAC,CAAC;AAEjD,MAAM,MAAM,cAAc,GAEtB,+BAA+B,GAE/B,iBAAiB,GAEjB,sCAAsC,GACtC,yCAAyC,GACzC,qCAAqC,GACrC,kCAAkC,GAClC,sCAAsC,GAEtC,yDAAyD,GACzD,iEAAiE,GAEjE,oCAAoC,GACpC,6CAA6C,GAC7C,oCAAoC,CAAC;AAGzC,MAAM,MAAM,qCAAqC,GAAG,0BAA0B,CAC5E,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AACF,MAAM,MAAM,6CAA6C,GAAG;IAC1D,IAAI,EAAE,GAAG,OAAO,cAAc,2BAA2B,CAAC;IAC1D,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,GAAG,OAAO,cAAc,yBAAyB,CAAC;IACxD,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,MAAM,GACd,qCAAqC,GACrC,6CAA6C,GAC7C,2CAA2C,CAAC;AAEhD,MAAM,MAAM,aAAa,GACrB,qCAAqC,GACrC,6CAA6C,GAC7C,2CAA2C,GAC3C,0BAA0B,GAC1B,4BAA4B,GAE5B,mCAAmC,GACnC,qCAAqC,GAErC,kCAAkC,GAClC,oCAAoC,GACpC,oCAAoC,CAAC;AAGzC,MAAM,MAAM,8BAA8B,GAAG,6BAA6B,CACxE,OAAO,cAAc,EACrB,OAAO,GAAG,cAAc,EACxB,MAAM,GAAG,aAAa,EACtB,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,cAAc,CAC/D,OAAO,cAAc,EACrB,0BAA0B,EAC1B,8BAA8B,CAC/B;;IAwJC,mBAAmB,EAAE,MAAM,OAAO,CAAC;gBAEvB,EACV,SAAS,EACT,KAAK,EACL,GAAG,EACH,MAAM,EACN,mBAAmB,EACnB,kBAAkB,GACnB,EAAE;QACD,SAAS,EAAE,8BAA8B,CAAC;QAC1C,KAAK,CAAC,EAAE,0BAA0B,CAAC;QACnC,MAAM,CAAC,EAAE,gBAAgB,CAAC;QAC1B,GAAG,CAAC,EAAE;YACJ,uBAAuB,CAAC,EAAE,OAAO,CAAC;YAClC,uBAAuB,CAAC,EAAE,OAAO,CAAC;SACnC,CAAC;QACF,mBAAmB,EAAE,MAAM,OAAO,CAAC;QACnC,kBAAkB,CAAC,EAAE,YAAY,CAAC;KACnC;IAmFY,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC;IAuBrC,0BAA0B,CACrC,uBAAuB,EAAE,OAAO,GAC/B,OAAO,CAAC,IAAI,CAAC;IAMH,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;IAoCnD;;;;;;OAMG;IACU,iBAAiB,CAC5B,IAAI,EAAE,gCAAgC,GACrC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAgBzB;;;;;;OAMG;IACU,kCAAkC,CAC7C,IAAI,EAAE,8BAA8B,GACnC,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC;IAgB3B;;;;;;;OAOG;IACU,iBAAiB,CAC5B,IAAI,EAAE,gCAAgC,EACtC,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC;IAchB;;;;OAIG;IACU,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAmF7C;;;;OAIG;IACG,mCAAmC,IAAI,OAAO,CAAC,IAAI,CAAC;IA6I1D;;;OAGG;IACG,gCAAgC,CACpC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAAC,IAAI,CAAC;CAcjB"}