@metamask-previews/profile-sync-controller 24.0.0-preview-b13da658 → 24.0.0-preview-a421f85b

package/dist/controllers/user-storage/account-syncing/sync-utils.mjs

@@ -0,0 +1,55 @@
+import { KeyringTypes } from "@metamask/keyring-controller";
+import { USER_STORAGE_FEATURE_NAMES } from "../../../shared/storage-schema.mjs";
+/**
+ * Checks if account syncing can be performed based on a set of conditions
+ *
+ * @param options - parameters used for checking if account syncing can be performed
+ * @returns Returns true if account syncing can be performed, false otherwise.
+ */
+export function canPerformAccountSyncing(options) {
+    const { getMessenger, getUserStorageControllerInstance } = options;
+    const { isBackupAndSyncEnabled, isAccountSyncingEnabled, isAccountSyncingInProgress, } = getUserStorageControllerInstance().state;
+    const isAuthEnabled = getMessenger().call('AuthenticationController:isSignedIn');
+    if (!isBackupAndSyncEnabled ||
+        !isAccountSyncingEnabled ||
+        !isAuthEnabled ||
+        isAccountSyncingInProgress) {
+        return false;
+    }
+    return true;
+}
+/**
+ * Get the list of internal accounts
+ * This function returns only the internal accounts that are from the primary SRP
+ * and are from the HD keyring
+ *
+ * @param options - parameters used for getting the list of internal accounts
+ * @param entropySourceId - The entropy source ID used to derive the key,
+ * when multiple sources are available (Multi-SRP).
+ * @returns the list of internal accounts
+ */
+export async function getInternalAccountsList(options, entropySourceId) {
+    const { getMessenger } = options;
+    let internalAccountsList = getMessenger().call('AccountsController:listAccounts');
+    const doEachInternalAccountHaveEntropySource = internalAccountsList.every((account) => Boolean(account.options.entropySource));
+    if (!doEachInternalAccountHaveEntropySource) {
+        await getMessenger().call('AccountsController:updateAccounts');
+        internalAccountsList = getMessenger().call('AccountsController:listAccounts');
+    }
+    return internalAccountsList.filter((account) => entropySourceId === account.options.entropySource &&
+        account.metadata.keyring.type === String(KeyringTypes.hd));
+}
+/**
+ * Get the list of user storage accounts
+ *
+ * @param options - parameters used for getting the list of user storage accounts
+ * @param entropySourceId - The entropy source ID used to derive the storage key,
+ * when multiple sources are available (Multi-SRP).
+ * @returns the list of user storage accounts
+ */
+export async function getUserStorageAccountsList(options, entropySourceId) {
+    const { getUserStorageControllerInstance } = options;
+    const rawAccountsListResponse = await getUserStorageControllerInstance().performGetStorageAllFeatureEntries(USER_STORAGE_FEATURE_NAMES.accounts, entropySourceId);
+    return (rawAccountsListResponse?.map((rawAccount) => JSON.parse(rawAccount)) ?? null);
+}
+//# sourceMappingURL=sync-utils.mjs.map

package/dist/controllers/user-storage/account-syncing/sync-utils.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-utils.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/sync-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAI5D,OAAO,EAAE,0BAA0B,EAAE,2CAAuC;AAE5E;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CACtC,OAA8B;IAE9B,MAAM,EAAE,YAAY,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;IAEnE,MAAM,EACJ,sBAAsB,EACtB,uBAAuB,EACvB,0BAA0B,GAC3B,GAAG,gCAAgC,EAAE,CAAC,KAAK,CAAC;IAC7C,MAAM,aAAa,GAAG,YAAY,EAAE,CAAC,IAAI,CACvC,qCAAqC,CACtC,CAAC;IAEF,IACE,CAAC,sBAAsB;QACvB,CAAC,uBAAuB;QACxB,CAAC,aAAa;QACd,0BAA0B,EAC1B;QACA,OAAO,KAAK,CAAC;KACd;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,OAA8B,EAC9B,eAAuB;IAEvB,MAAM,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;IAEjC,IAAI,oBAAoB,GAAG,YAAY,EAAE,CAAC,IAAI,CAC5C,iCAAiC,CAClC,CAAC;IAEF,MAAM,sCAAsC,GAAG,oBAAoB,CAAC,KAAK,CACvE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,CACpD,CAAC;IAEF,IAAI,CAAC,sCAAsC,EAAE;QAC3C,MAAM,YAAY,EAAE,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;QAC/D,oBAAoB,GAAG,YAAY,EAAE,CAAC,IAAI,CACxC,iCAAiC,CAClC,CAAC;KACH;IAED,OAAO,oBAAoB,CAAC,MAAM,CAChC,CAAC,OAAO,EAAE,EAAE,CACV,eAAe,KAAK,OAAO,CAAC,OAAO,CAAC,aAAa;QACjD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,CAC5D,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC9C,OAA8B,EAC9B,eAAwB;IAExB,MAAM,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;IAErD,MAAM,uBAAuB,GAC3B,MAAM,gCAAgC,EAAE,CAAC,kCAAkC,CACzE,0BAA0B,CAAC,QAAQ,EACnC,eAAe,CAChB,CAAC;IAEJ,OAAO,CACL,uBAAuB,EAAE,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,IAAI,CAC7E,CAAC;AACJ,CAAC","sourcesContent":["import { KeyringTypes } from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\n\nimport type { AccountSyncingOptions, UserStorageAccount } from './types';\nimport { USER_STORAGE_FEATURE_NAMES } from '../../../shared/storage-schema';\n\n/**\n * Checks if account syncing can be performed based on a set of conditions\n *\n * @param options - parameters used for checking if account syncing can be performed\n * @returns Returns true if account syncing can be performed, false otherwise.\n */\nexport function canPerformAccountSyncing(\n  options: AccountSyncingOptions,\n): boolean {\n  const { getMessenger, getUserStorageControllerInstance } = options;\n\n  const {\n    isBackupAndSyncEnabled,\n    isAccountSyncingEnabled,\n    isAccountSyncingInProgress,\n  } = getUserStorageControllerInstance().state;\n  const isAuthEnabled = getMessenger().call(\n    'AuthenticationController:isSignedIn',\n  );\n\n  if (\n    !isBackupAndSyncEnabled ||\n    !isAccountSyncingEnabled ||\n    !isAuthEnabled ||\n    isAccountSyncingInProgress\n  ) {\n    return false;\n  }\n\n  return true;\n}\n\n/**\n * Get the list of internal accounts\n * This function returns only the internal accounts that are from the primary SRP\n * and are from the HD keyring\n *\n * @param options - parameters used for getting the list of internal accounts\n * @param entropySourceId - The entropy source ID used to derive the key,\n * when multiple sources are available (Multi-SRP).\n * @returns the list of internal accounts\n */\nexport async function getInternalAccountsList(\n  options: AccountSyncingOptions,\n  entropySourceId: string,\n): Promise<InternalAccount[]> {\n  const { getMessenger } = options;\n\n  let internalAccountsList = getMessenger().call(\n    'AccountsController:listAccounts',\n  );\n\n  const doEachInternalAccountHaveEntropySource = internalAccountsList.every(\n    (account) => Boolean(account.options.entropySource),\n  );\n\n  if (!doEachInternalAccountHaveEntropySource) {\n    await getMessenger().call('AccountsController:updateAccounts');\n    internalAccountsList = getMessenger().call(\n      'AccountsController:listAccounts',\n    );\n  }\n\n  return internalAccountsList.filter(\n    (account) =>\n      entropySourceId === account.options.entropySource &&\n      account.metadata.keyring.type === String(KeyringTypes.hd), // sync only EVM accounts until we support multichain accounts\n  );\n}\n\n/**\n * Get the list of user storage accounts\n *\n * @param options - parameters used for getting the list of user storage accounts\n * @param entropySourceId - The entropy source ID used to derive the storage key,\n * when multiple sources are available (Multi-SRP).\n * @returns the list of user storage accounts\n */\nexport async function getUserStorageAccountsList(\n  options: AccountSyncingOptions,\n  entropySourceId?: string,\n): Promise<UserStorageAccount[] | null> {\n  const { getUserStorageControllerInstance } = options;\n\n  const rawAccountsListResponse =\n    await getUserStorageControllerInstance().performGetStorageAllFeatureEntries(\n      USER_STORAGE_FEATURE_NAMES.accounts,\n      entropySourceId,\n    );\n\n  return (\n    rawAccountsListResponse?.map((rawAccount) => JSON.parse(rawAccount)) ?? null\n  );\n}\n"]}

package/dist/controllers/user-storage/account-syncing/types.cjs

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

package/dist/controllers/user-storage/account-syncing/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { TraceCallback } from '@metamask/controller-utils';\n\nimport type {\n  USER_STORAGE_VERSION_KEY,\n  USER_STORAGE_VERSION,\n} from './constants';\nimport type { UserStorageControllerMessenger } from '../UserStorageController';\nimport type UserStorageController from '../UserStorageController';\n\nexport type UserStorageAccount = {\n  /**\n   * The Version 'v' of the User Storage.\n   * NOTE - will allow us to support upgrade/downgrades in the future\n   */\n  [USER_STORAGE_VERSION_KEY]: typeof USER_STORAGE_VERSION;\n  /** the id 'i' of the account */\n  i: string;\n  /** the address 'a' of the account */\n  a: string;\n  /** the name 'n' of the account */\n  n: string;\n  /** the nameLastUpdatedAt timestamp 'nlu' of the account */\n  nlu?: number;\n};\n\nexport type AccountSyncingOptions = {\n  getUserStorageControllerInstance: () => UserStorageController;\n  getMessenger: () => UserStorageControllerMessenger;\n  trace?: TraceCallback;\n};\n"]}

package/dist/controllers/user-storage/account-syncing/types.d.cts

@@ -0,0 +1,25 @@
+import type { TraceCallback } from "@metamask/controller-utils";
+import type { USER_STORAGE_VERSION_KEY, USER_STORAGE_VERSION } from "./constants.cjs";
+import type { UserStorageControllerMessenger } from "../UserStorageController.cjs";
+import type UserStorageController from "../UserStorageController.cjs";
+export type UserStorageAccount = {
+    /**
+     * The Version 'v' of the User Storage.
+     * NOTE - will allow us to support upgrade/downgrades in the future
+     */
+    [USER_STORAGE_VERSION_KEY]: typeof USER_STORAGE_VERSION;
+    /** the id 'i' of the account */
+    i: string;
+    /** the address 'a' of the account */
+    a: string;
+    /** the name 'n' of the account */
+    n: string;
+    /** the nameLastUpdatedAt timestamp 'nlu' of the account */
+    nlu?: number;
+};
+export type AccountSyncingOptions = {
+    getUserStorageControllerInstance: () => UserStorageController;
+    getMessenger: () => UserStorageControllerMessenger;
+    trace?: TraceCallback;
+};
+//# sourceMappingURL=types.d.cts.map

package/dist/controllers/user-storage/account-syncing/types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,mCAAmC;AAEhE,OAAO,KAAK,EACV,wBAAwB,EACxB,oBAAoB,EACrB,wBAAoB;AACrB,OAAO,KAAK,EAAE,8BAA8B,EAAE,qCAAiC;AAC/E,OAAO,KAAK,qBAAqB,qCAAiC;AAElE,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;OAGG;IACH,CAAC,wBAAwB,CAAC,EAAE,OAAO,oBAAoB,CAAC;IACxD,gCAAgC;IAChC,CAAC,EAAE,MAAM,CAAC;IACV,qCAAqC;IACrC,CAAC,EAAE,MAAM,CAAC;IACV,kCAAkC;IAClC,CAAC,EAAE,MAAM,CAAC;IACV,2DAA2D;IAC3D,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,gCAAgC,EAAE,MAAM,qBAAqB,CAAC;IAC9D,YAAY,EAAE,MAAM,8BAA8B,CAAC;IACnD,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB,CAAC"}

package/dist/controllers/user-storage/account-syncing/types.d.mts

@@ -0,0 +1,25 @@
+import type { TraceCallback } from "@metamask/controller-utils";
+import type { USER_STORAGE_VERSION_KEY, USER_STORAGE_VERSION } from "./constants.mjs";
+import type { UserStorageControllerMessenger } from "../UserStorageController.mjs";
+import type UserStorageController from "../UserStorageController.mjs";
+export type UserStorageAccount = {
+    /**
+     * The Version 'v' of the User Storage.
+     * NOTE - will allow us to support upgrade/downgrades in the future
+     */
+    [USER_STORAGE_VERSION_KEY]: typeof USER_STORAGE_VERSION;
+    /** the id 'i' of the account */
+    i: string;
+    /** the address 'a' of the account */
+    a: string;
+    /** the name 'n' of the account */
+    n: string;
+    /** the nameLastUpdatedAt timestamp 'nlu' of the account */
+    nlu?: number;
+};
+export type AccountSyncingOptions = {
+    getUserStorageControllerInstance: () => UserStorageController;
+    getMessenger: () => UserStorageControllerMessenger;
+    trace?: TraceCallback;
+};
+//# sourceMappingURL=types.d.mts.map

package/dist/controllers/user-storage/account-syncing/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,mCAAmC;AAEhE,OAAO,KAAK,EACV,wBAAwB,EACxB,oBAAoB,EACrB,wBAAoB;AACrB,OAAO,KAAK,EAAE,8BAA8B,EAAE,qCAAiC;AAC/E,OAAO,KAAK,qBAAqB,qCAAiC;AAElE,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;OAGG;IACH,CAAC,wBAAwB,CAAC,EAAE,OAAO,oBAAoB,CAAC;IACxD,gCAAgC;IAChC,CAAC,EAAE,MAAM,CAAC;IACV,qCAAqC;IACrC,CAAC,EAAE,MAAM,CAAC;IACV,kCAAkC;IAClC,CAAC,EAAE,MAAM,CAAC;IACV,2DAA2D;IAC3D,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,gCAAgC,EAAE,MAAM,qBAAqB,CAAC;IAC9D,YAAY,EAAE,MAAM,8BAA8B,CAAC;IACnD,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB,CAAC"}

package/dist/controllers/user-storage/account-syncing/types.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.mjs.map

package/dist/controllers/user-storage/account-syncing/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { TraceCallback } from '@metamask/controller-utils';\n\nimport type {\n  USER_STORAGE_VERSION_KEY,\n  USER_STORAGE_VERSION,\n} from './constants';\nimport type { UserStorageControllerMessenger } from '../UserStorageController';\nimport type UserStorageController from '../UserStorageController';\n\nexport type UserStorageAccount = {\n  /**\n   * The Version 'v' of the User Storage.\n   * NOTE - will allow us to support upgrade/downgrades in the future\n   */\n  [USER_STORAGE_VERSION_KEY]: typeof USER_STORAGE_VERSION;\n  /** the id 'i' of the account */\n  i: string;\n  /** the address 'a' of the account */\n  a: string;\n  /** the name 'n' of the account */\n  n: string;\n  /** the nameLastUpdatedAt timestamp 'nlu' of the account */\n  nlu?: number;\n};\n\nexport type AccountSyncingOptions = {\n  getUserStorageControllerInstance: () => UserStorageController;\n  getMessenger: () => UserStorageControllerMessenger;\n  trace?: TraceCallback;\n};\n"]}

package/dist/controllers/user-storage/account-syncing/utils.cjs

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapInternalAccountToUserStorageAccount = exports.isNameDefaultAccountName = void 0;
+const constants_1 = require("./constants.cjs");
+/**
+ * Tells if the given name is a default account name.
+ * Default account names are localized names that are automatically generated by the clients.
+ *
+ * @param name - the name to check
+ * @returns true if the name is a default account name, false otherwise
+ */
+const isNameDefaultAccountName = (name) => {
+    return constants_1.LOCALIZED_DEFAULT_ACCOUNT_NAMES.some((prefix) => {
+        return new RegExp(`^${prefix} ([0-9]+)$`, 'u').test(name);
+    });
+};
+exports.isNameDefaultAccountName = isNameDefaultAccountName;
+/**
+ * Map an internal account to a user storage account
+ *
+ * @param internalAccount - An internal account
+ * @returns A user storage account
+ */
+const mapInternalAccountToUserStorageAccount = (internalAccount) => {
+    const { address, id, metadata } = internalAccount;
+    const { name, nameLastUpdatedAt } = metadata;
+    return {
+        [constants_1.USER_STORAGE_VERSION_KEY]: constants_1.USER_STORAGE_VERSION,
+        a: address,
+        i: id,
+        n: name,
+        ...((0, exports.isNameDefaultAccountName)(name) ? {} : { nlu: nameLastUpdatedAt }),
+    };
+};
+exports.mapInternalAccountToUserStorageAccount = mapInternalAccountToUserStorageAccount;
+//# sourceMappingURL=utils.cjs.map

package/dist/controllers/user-storage/account-syncing/utils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.cjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/utils.ts"],"names":[],"mappings":";;;AAEA,+CAIqB;AAGrB;;;;;;GAMG;AAEI,MAAM,wBAAwB,GAAG,CAAC,IAAY,EAAE,EAAE;IACvD,OAAO,2CAA+B,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;QACrD,OAAO,IAAI,MAAM,CAAC,IAAI,MAAM,YAAY,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAJW,QAAA,wBAAwB,4BAInC;AAEF;;;;;GAKG;AACI,MAAM,sCAAsC,GAAG,CACpD,eAAgC,EACZ,EAAE;IACtB,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,eAAe,CAAC;IAClD,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,QAAQ,CAAC;IAE7C,OAAO;QACL,CAAC,oCAAwB,CAAC,EAAE,gCAAoB;QAChD,CAAC,EAAE,OAAO;QACV,CAAC,EAAE,EAAE;QACL,CAAC,EAAE,IAAI;QACP,GAAG,CAAC,IAAA,gCAAwB,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,iBAAiB,EAAE,CAAC;KACtE,CAAC;AACJ,CAAC,CAAC;AAbW,QAAA,sCAAsC,0CAajD","sourcesContent":["import type { InternalAccount } from '@metamask/keyring-internal-api';\n\nimport {\n  USER_STORAGE_VERSION_KEY,\n  USER_STORAGE_VERSION,\n  LOCALIZED_DEFAULT_ACCOUNT_NAMES,\n} from './constants';\nimport type { UserStorageAccount } from './types';\n\n/**\n * Tells if the given name is a default account name.\n * Default account names are localized names that are automatically generated by the clients.\n *\n * @param name - the name to check\n * @returns true if the name is a default account name, false otherwise\n */\n\nexport const isNameDefaultAccountName = (name: string) => {\n  return LOCALIZED_DEFAULT_ACCOUNT_NAMES.some((prefix) => {\n    return new RegExp(`^${prefix} ([0-9]+)$`, 'u').test(name);\n  });\n};\n\n/**\n * Map an internal account to a user storage account\n *\n * @param internalAccount - An internal account\n * @returns A user storage account\n */\nexport const mapInternalAccountToUserStorageAccount = (\n  internalAccount: InternalAccount,\n): UserStorageAccount => {\n  const { address, id, metadata } = internalAccount;\n  const { name, nameLastUpdatedAt } = metadata;\n\n  return {\n    [USER_STORAGE_VERSION_KEY]: USER_STORAGE_VERSION,\n    a: address,\n    i: id,\n    n: name,\n    ...(isNameDefaultAccountName(name) ? {} : { nlu: nameLastUpdatedAt }),\n  };\n};\n"]}

package/dist/controllers/user-storage/account-syncing/utils.d.cts

@@ -0,0 +1,18 @@
+import type { InternalAccount } from "@metamask/keyring-internal-api";
+import type { UserStorageAccount } from "./types.cjs";
+/**
+ * Tells if the given name is a default account name.
+ * Default account names are localized names that are automatically generated by the clients.
+ *
+ * @param name - the name to check
+ * @returns true if the name is a default account name, false otherwise
+ */
+export declare const isNameDefaultAccountName: (name: string) => boolean;
+/**
+ * Map an internal account to a user storage account
+ *
+ * @param internalAccount - An internal account
+ * @returns A user storage account
+ */
+export declare const mapInternalAccountToUserStorageAccount: (internalAccount: InternalAccount) => UserStorageAccount;
+//# sourceMappingURL=utils.d.cts.map

package/dist/controllers/user-storage/account-syncing/utils.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.cts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AAOtE,OAAO,KAAK,EAAE,kBAAkB,EAAE,oBAAgB;AAElD;;;;;;GAMG;AAEH,eAAO,MAAM,wBAAwB,SAAU,MAAM,YAIpD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,sCAAsC,oBAChC,eAAe,KAC/B,kBAWF,CAAC"}

package/dist/controllers/user-storage/account-syncing/utils.d.mts

@@ -0,0 +1,18 @@
+import type { InternalAccount } from "@metamask/keyring-internal-api";
+import type { UserStorageAccount } from "./types.mjs";
+/**
+ * Tells if the given name is a default account name.
+ * Default account names are localized names that are automatically generated by the clients.
+ *
+ * @param name - the name to check
+ * @returns true if the name is a default account name, false otherwise
+ */
+export declare const isNameDefaultAccountName: (name: string) => boolean;
+/**
+ * Map an internal account to a user storage account
+ *
+ * @param internalAccount - An internal account
+ * @returns A user storage account
+ */
+export declare const mapInternalAccountToUserStorageAccount: (internalAccount: InternalAccount) => UserStorageAccount;
+//# sourceMappingURL=utils.d.mts.map

package/dist/controllers/user-storage/account-syncing/utils.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AAOtE,OAAO,KAAK,EAAE,kBAAkB,EAAE,oBAAgB;AAElD;;;;;;GAMG;AAEH,eAAO,MAAM,wBAAwB,SAAU,MAAM,YAIpD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,sCAAsC,oBAChC,eAAe,KAC/B,kBAWF,CAAC"}

package/dist/controllers/user-storage/account-syncing/utils.mjs

@@ -0,0 +1,31 @@
+import { USER_STORAGE_VERSION_KEY, USER_STORAGE_VERSION, LOCALIZED_DEFAULT_ACCOUNT_NAMES } from "./constants.mjs";
+/**
+ * Tells if the given name is a default account name.
+ * Default account names are localized names that are automatically generated by the clients.
+ *
+ * @param name - the name to check
+ * @returns true if the name is a default account name, false otherwise
+ */
+export const isNameDefaultAccountName = (name) => {
+    return LOCALIZED_DEFAULT_ACCOUNT_NAMES.some((prefix) => {
+        return new RegExp(`^${prefix} ([0-9]+)$`, 'u').test(name);
+    });
+};
+/**
+ * Map an internal account to a user storage account
+ *
+ * @param internalAccount - An internal account
+ * @returns A user storage account
+ */
+export const mapInternalAccountToUserStorageAccount = (internalAccount) => {
+    const { address, id, metadata } = internalAccount;
+    const { name, nameLastUpdatedAt } = metadata;
+    return {
+        [USER_STORAGE_VERSION_KEY]: USER_STORAGE_VERSION,
+        a: address,
+        i: id,
+        n: name,
+        ...(isNameDefaultAccountName(name) ? {} : { nlu: nameLastUpdatedAt }),
+    };
+};
+//# sourceMappingURL=utils.mjs.map

package/dist/controllers/user-storage/account-syncing/utils.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/account-syncing/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,wBAAwB,EACxB,oBAAoB,EACpB,+BAA+B,EAChC,wBAAoB;AAGrB;;;;;;GAMG;AAEH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,IAAY,EAAE,EAAE;IACvD,OAAO,+BAA+B,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;QACrD,OAAO,IAAI,MAAM,CAAC,IAAI,MAAM,YAAY,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sCAAsC,GAAG,CACpD,eAAgC,EACZ,EAAE;IACtB,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,eAAe,CAAC;IAClD,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,QAAQ,CAAC;IAE7C,OAAO;QACL,CAAC,wBAAwB,CAAC,EAAE,oBAAoB;QAChD,CAAC,EAAE,OAAO;QACV,CAAC,EAAE,EAAE;QACL,CAAC,EAAE,IAAI;QACP,GAAG,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,iBAAiB,EAAE,CAAC;KACtE,CAAC;AACJ,CAAC,CAAC","sourcesContent":["import type { InternalAccount } from '@metamask/keyring-internal-api';\n\nimport {\n  USER_STORAGE_VERSION_KEY,\n  USER_STORAGE_VERSION,\n  LOCALIZED_DEFAULT_ACCOUNT_NAMES,\n} from './constants';\nimport type { UserStorageAccount } from './types';\n\n/**\n * Tells if the given name is a default account name.\n * Default account names are localized names that are automatically generated by the clients.\n *\n * @param name - the name to check\n * @returns true if the name is a default account name, false otherwise\n */\n\nexport const isNameDefaultAccountName = (name: string) => {\n  return LOCALIZED_DEFAULT_ACCOUNT_NAMES.some((prefix) => {\n    return new RegExp(`^${prefix} ([0-9]+)$`, 'u').test(name);\n  });\n};\n\n/**\n * Map an internal account to a user storage account\n *\n * @param internalAccount - An internal account\n * @returns A user storage account\n */\nexport const mapInternalAccountToUserStorageAccount = (\n  internalAccount: InternalAccount,\n): UserStorageAccount => {\n  const { address, id, metadata } = internalAccount;\n  const { name, nameLastUpdatedAt } = metadata;\n\n  return {\n    [USER_STORAGE_VERSION_KEY]: USER_STORAGE_VERSION,\n    a: address,\n    i: id,\n    n: name,\n    ...(isNameDefaultAccountName(name) ? {} : { nlu: nameLastUpdatedAt }),\n  };\n};\n"]}

package/dist/controllers/user-storage/constants.cjs

@@ -15,5 +15,8 @@ exports.TraceName = {
     ContactSyncSaveBatch: 'Contact Sync Save Batch',
     ContactSyncUpdateRemote: 'Contact Sync Update Remote',
     ContactSyncDeleteRemote: 'Contact Sync Delete Remote',
+    // Account syncing traces
+    AccountSyncFull: 'Account Sync Full',
+    AccountSyncSaveIndividual: 'Account Sync Save Individual',
 };
 //# sourceMappingURL=constants.cjs.map

package/dist/controllers/user-storage/constants.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"constants.cjs","sourceRoot":"","sources":["../../../src/controllers/user-storage/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,sBAAsB,GAAG;IACpC,IAAI,EAAE,MAAM;IACZ,cAAc,EAAE,gBAAgB;IAChC,cAAc,EAAE,gBAAgB;CACxB,CAAC;AAEX;;GAEG;AACU,QAAA,SAAS,GAAG;IACvB,yBAAyB;IACzB,eAAe,EAAE,mBAAmB;IACpC,oBAAoB,EAAE,yBAAyB;IAC/C,uBAAuB,EAAE,4BAA4B;IACrD,uBAAuB,EAAE,4BAA4B;CAC7C,CAAC","sourcesContent":["export const BACKUPANDSYNC_FEATURES = {\n  main: 'main',\n  accountSyncing: 'accountSyncing',\n  contactSyncing: 'contactSyncing',\n} as const;\n\n/**\n * Trace names for UserStorage syncing operations\n */\nexport const TraceName = {\n  // Contact syncing traces\n  ContactSyncFull: 'Contact Sync Full',\n  ContactSyncSaveBatch: 'Contact Sync Save Batch',\n  ContactSyncUpdateRemote: 'Contact Sync Update Remote',\n  ContactSyncDeleteRemote: 'Contact Sync Delete Remote',\n} as const;\n"]}
+{"version":3,"file":"constants.cjs","sourceRoot":"","sources":["../../../src/controllers/user-storage/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,sBAAsB,GAAG;IACpC,IAAI,EAAE,MAAM;IACZ,cAAc,EAAE,gBAAgB;IAChC,cAAc,EAAE,gBAAgB;CACxB,CAAC;AAEX;;GAEG;AACU,QAAA,SAAS,GAAG;IACvB,yBAAyB;IACzB,eAAe,EAAE,mBAAmB;IACpC,oBAAoB,EAAE,yBAAyB;IAC/C,uBAAuB,EAAE,4BAA4B;IACrD,uBAAuB,EAAE,4BAA4B;IAErD,yBAAyB;IACzB,eAAe,EAAE,mBAAmB;IACpC,yBAAyB,EAAE,8BAA8B;CACjD,CAAC","sourcesContent":["export const BACKUPANDSYNC_FEATURES = {\n  main: 'main',\n  accountSyncing: 'accountSyncing',\n  contactSyncing: 'contactSyncing',\n} as const;\n\n/**\n * Trace names for UserStorage syncing operations\n */\nexport const TraceName = {\n  // Contact syncing traces\n  ContactSyncFull: 'Contact Sync Full',\n  ContactSyncSaveBatch: 'Contact Sync Save Batch',\n  ContactSyncUpdateRemote: 'Contact Sync Update Remote',\n  ContactSyncDeleteRemote: 'Contact Sync Delete Remote',\n\n  // Account syncing traces\n  AccountSyncFull: 'Account Sync Full',\n  AccountSyncSaveIndividual: 'Account Sync Save Individual',\n} as const;\n"]}

package/dist/controllers/user-storage/constants.d.cts

@@ -11,5 +11,7 @@ export declare const TraceName: {
     readonly ContactSyncSaveBatch: "Contact Sync Save Batch";
     readonly ContactSyncUpdateRemote: "Contact Sync Update Remote";
     readonly ContactSyncDeleteRemote: "Contact Sync Delete Remote";
+    readonly AccountSyncFull: "Account Sync Full";
+    readonly AccountSyncSaveIndividual: "Account Sync Save Individual";
 };
 //# sourceMappingURL=constants.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"constants.d.cts","sourceRoot":"","sources":["../../../src/controllers/user-storage/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sBAAsB;;;;CAIzB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,SAAS;;;;;CAMZ,CAAC"}
+{"version":3,"file":"constants.d.cts","sourceRoot":"","sources":["../../../src/controllers/user-storage/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sBAAsB;;;;CAIzB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,SAAS;;;;;;;CAUZ,CAAC"}

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

@@ -11,5 +11,7 @@ export declare const TraceName: {
     readonly ContactSyncSaveBatch: "Contact Sync Save Batch";
     readonly ContactSyncUpdateRemote: "Contact Sync Update Remote";
     readonly ContactSyncDeleteRemote: "Contact Sync Delete Remote";
+    readonly AccountSyncFull: "Account Sync Full";
+    readonly AccountSyncSaveIndividual: "Account Sync Save Individual";
 };
 //# sourceMappingURL=constants.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"constants.d.mts","sourceRoot":"","sources":["../../../src/controllers/user-storage/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sBAAsB;;;;CAIzB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,SAAS;;;;;CAMZ,CAAC"}
+{"version":3,"file":"constants.d.mts","sourceRoot":"","sources":["../../../src/controllers/user-storage/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sBAAsB;;;;CAIzB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,SAAS;;;;;;;CAUZ,CAAC"}

package/dist/controllers/user-storage/constants.mjs

@@ -12,5 +12,8 @@ export const TraceName = {
     ContactSyncSaveBatch: 'Contact Sync Save Batch',
     ContactSyncUpdateRemote: 'Contact Sync Update Remote',
     ContactSyncDeleteRemote: 'Contact Sync Delete Remote',
+    // Account syncing traces
+    AccountSyncFull: 'Account Sync Full',
+    AccountSyncSaveIndividual: 'Account Sync Save Individual',
 };
 //# sourceMappingURL=constants.mjs.map

package/dist/controllers/user-storage/constants.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"constants.mjs","sourceRoot":"","sources":["../../../src/controllers/user-storage/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,IAAI,EAAE,MAAM;IACZ,cAAc,EAAE,gBAAgB;IAChC,cAAc,EAAE,gBAAgB;CACxB,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,yBAAyB;IACzB,eAAe,EAAE,mBAAmB;IACpC,oBAAoB,EAAE,yBAAyB;IAC/C,uBAAuB,EAAE,4BAA4B;IACrD,uBAAuB,EAAE,4BAA4B;CAC7C,CAAC","sourcesContent":["export const BACKUPANDSYNC_FEATURES = {\n  main: 'main',\n  accountSyncing: 'accountSyncing',\n  contactSyncing: 'contactSyncing',\n} as const;\n\n/**\n * Trace names for UserStorage syncing operations\n */\nexport const TraceName = {\n  // Contact syncing traces\n  ContactSyncFull: 'Contact Sync Full',\n  ContactSyncSaveBatch: 'Contact Sync Save Batch',\n  ContactSyncUpdateRemote: 'Contact Sync Update Remote',\n  ContactSyncDeleteRemote: 'Contact Sync Delete Remote',\n} as const;\n"]}
+{"version":3,"file":"constants.mjs","sourceRoot":"","sources":["../../../src/controllers/user-storage/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,IAAI,EAAE,MAAM;IACZ,cAAc,EAAE,gBAAgB;IAChC,cAAc,EAAE,gBAAgB;CACxB,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,yBAAyB;IACzB,eAAe,EAAE,mBAAmB;IACpC,oBAAoB,EAAE,yBAAyB;IAC/C,uBAAuB,EAAE,4BAA4B;IACrD,uBAAuB,EAAE,4BAA4B;IAErD,yBAAyB;IACzB,eAAe,EAAE,mBAAmB;IACpC,yBAAyB,EAAE,8BAA8B;CACjD,CAAC","sourcesContent":["export const BACKUPANDSYNC_FEATURES = {\n  main: 'main',\n  accountSyncing: 'accountSyncing',\n  contactSyncing: 'contactSyncing',\n} as const;\n\n/**\n * Trace names for UserStorage syncing operations\n */\nexport const TraceName = {\n  // Contact syncing traces\n  ContactSyncFull: 'Contact Sync Full',\n  ContactSyncSaveBatch: 'Contact Sync Save Batch',\n  ContactSyncUpdateRemote: 'Contact Sync Update Remote',\n  ContactSyncDeleteRemote: 'Contact Sync Delete Remote',\n\n  // Account syncing traces\n  AccountSyncFull: 'Account Sync Full',\n  AccountSyncSaveIndividual: 'Account Sync Save Individual',\n} as const;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/profile-sync-controller",
-  "version": "24.0.0-preview-b13da658",
+  "version": "24.0.0-preview-a421f85b",
   "description": "The profile sync helps developers synchronize data across multiple clients and devices in a privacy-preserving way. All data saved in the user storage database is encrypted client-side to preserve privacy. The user storage provides a modular design, giving developers the flexibility to construct and manage their storage spaces in a way that best suits their needs",
   "keywords": [
     "MetaMask",
@@ -112,6 +112,7 @@
   "devDependencies": {
     "@lavamoat/allow-scripts": "^3.0.4",
     "@lavamoat/preinstall-always-fail": "^2.1.0",
+    "@metamask/accounts-controller": "^33.0.0",
     "@metamask/auto-changelog": "^3.4.4",
     "@metamask/keyring-api": "^20.1.0",
     "@metamask/keyring-controller": "^23.0.0",
@@ -131,6 +132,7 @@
     "webextension-polyfill": "^0.12.0"
   },
   "peerDependencies": {
+    "@metamask/accounts-controller": "^33.0.0",
     "@metamask/keyring-controller": "^23.0.0",
     "@metamask/providers": "^22.0.0",
     "@metamask/snaps-controllers": "^14.0.0",