Skip to content

Latest commit

 

History

History
162 lines (106 loc) · 8.86 KB

CHANGELOG.md

File metadata and controls

162 lines (106 loc) · 8.86 KB

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.

Added

  • add isSnapConnected method to the Authentication SDK (#4668)
  • add accountAdded and accountRenamed events when triggering account syncing (#4665)
  • prevent accounts controller events being used when sync is in progress (#4675)
    • add isAccountSyncingInProgress to UserStorageController
    • add isAccountSyncingInProgress checks to abort processing accountAdded and accountRenamed events.

Removed

  • account sync throttling (#4675)
    • remove maxSyncInterval; lastSyncedAt; shouldSync from UserStorageController

Added

  • add maxSyncInterval for account syncing to UserStorageController prevent multiple sync requests (#4659)
  • add optional NativeScrypt property to UserStorageController to allow the scrypt implementation to be swapped out for a native version. Improving mobile performance (#4656)

Added

  • add granular account syncing (#4629)
    • add accounts user storage schema
    • add method saveInternalAccountToUserStorage to UserStorageController
    • add method syncInternalAccountsWithUserStorage to UserStorageController
    • add @metamask/accounts-controller dev dependency
    • add @metamask/keyring-api dev dependency
  • add infura OIDC identifier (#4654)
  • define and export new types: AuthenticationControllerGetStateAction, AuthenticationControllerStateChangeEvent, Events (#4633)
  • SDK and controller support for GET /api/v1/userstorage/:feature endpoint (#4626)
    • add method performGetStorageAllFeatureEntries to UserStorageController
    • add ALLOW_ARBITRARY_KEYS to USER_STORAGE_SCHEMA to allow wildcard/getAll for entries for a feature
  • add subpath exports to @metamask/profile-sync-controller (#4604)
    • add @metamask/profile-sync-controller/sdk export
    • add @metamask/profile-sync-controller/user-storage export
    • add @metamask/profile-sync-controller/auth export

Changed

  • Bump typescript from ~5.1.6 to ~5.2.2 (#4584)
  • Fix controllers with missing or incorrect messenger action/event types (#4633)
  • BREAKING: AuthenticationControllerMessenger must allow internal events defined in the Events type (#4633)
  • AuthenticationControllerActions is widened to include the AuthenticationController:getState action (#4633)
  • Replaced @metamask/profile-sync-controller/sdk to use the same encryption file as UserStorageController (#4649)

Fixed

  • update subpath exports internal package.json files to resolve jest-haste-map errors (#4650)

Added

  • unlock checks for when controller methods are called (#4569)

Changed

  • BREAKING made MOCK_ENCRYPTED_STORAGE_DATA fixture a function to be lazily evaluated (#4592)
  • Bump typescript from ~5.0.4 to ~5.1.6 (#4576)

Added

  • Add and export object USER_STORAGE_SCHEMA, function getFeatureAndKeyFromPath, and type UserStoragePath (#4543)
  • Add connectSnap method to the JwtBearerAuth class for connecting to snap after initializing the Profile Sync SDK (#4560)

Changed

  • BREAKING: Enforce UserStorageSchema usage in all functions that get or set user storage (#4543)
    • Keeps user storage entries consistent, and improves DX for consumers of user storage.
    • BREAKING: Remove entryKey function parameter from performGetStorage and performSetStorage methods of UserStorageController, and replace with path parameter of type UserStoragePath.
    • BREAKING: Remove entryKey function parameter from createEntryPath, and replace with path parameter of type UserStoragePath.
    • BREAKING: Remove entryKey property from type UserStorageOptions, and replace with path property of type UserStoragePath.
  • BREAKING: Bump peerDependency @metamask/snaps-controllers from ^8.1.1 to ^9.3.0 (#3645)
  • Remove @metamask/snaps-controllers dependency #4556
    • This was listed under peerDependencies already, so it was redundant as a dependency.
  • Widen isProfileSyncingEnabled property of the UserStorageControllerState type from boolean to boolean | null (#4551)
  • Upgrade TypeScript version to ~5.0.4 and set moduleResolution option to Node16 (#3645)
  • Bump @metamask/base-controller from ^6.0.1 to ^6.0.2 (#4544)
  • Bump @metamask/snaps-sdk from ^4.2.0 to ^6.1.1 (#3645, #4547)
  • Add new dependency @metamask/snaps-utils (#3645, #4547)

Removed

  • Remove object USER_STORAGE_ENTRIES and type UserStorageEntryKeys (#4543)

Added

  • added LoginResponse validation in profile syncing SDK (#4541)

  • added snap caching when calling the message signing snap (#4532)

Removed

  • removed a server-side node dependency from profile-sync-sdk (#4539)

Fixed

  • removed a catch statement call in AuthenticationController to prevent infinite crashes. (#4533)

Changed

  • Switch ethers to a devDependency (#4518)

Added

  • added platform field when logging in to receive correct OIDC access token (#4480)

  • added metametrics validation in constructor (#4480)

Changed

  • updated the getMetaMetricsId interface to support async calls to metametrics ID (#4477)

Added

  • export defaultState for AuthenticationController and UserStorageController. (#4441)

Changed

  • AuthType, Env, Platform are changed from const enums to enums (#4441)

Added

  • Initial release