Skip to content

CHANGELOG.md

Latest commit

 

History

History
368 lines (232 loc) · 17 KB

CHANGELOG.md

File metadata and controls

368 lines (232 loc) · 17 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.

Unreleased

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)

9.0.1

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)

9.0.0

Added

  • New addRequest() public method (#8183)
  • Expose missing public ApprovalController methods through its messenger (#8183)
    • The following actions are now available:
      • ApprovalController:add
      • ApprovalController:addAndShowApprovalRequest
      • ApprovalController:get
      • ApprovalController:getApprovalCount
      • ApprovalController:getTotalApprovalCount
    • Corresponding action types (e.g. ApprovalControllerAddAction) are available as well.

Changed

  • BREAKING: Standardize names of ApprovalController methods (#8183)
    • All existing methods for handling requests have been renamed so they include Request (e.g. clear() -> clearRequest()). You will need to update usage appropriately.
    • The error handling method error() has been renamed to include show (error() -> showError()). You will need to update usage appropriately.
  • BREAKING: Rename get-state action type: GetApprovalsState → ApprovalControllerGetStateAction (#8183)
  • Upgrade @metamask/utils from ^11.8.1 to ^11.9.0 (#7511)

8.0.0

Changed

  • BREAKING: Use new Messenger from @metamask/messenger (#6386)
    • Previously, ApprovalController accepted a RestrictedMessenger instance from @metamask/base-controller.
  • Bump @metamask/base-controller from ^8.4.2 to ^9.0.0 (#6962)

7.2.1

Changed

  • Bump @metamask/base-controller from ^8.4.1 to ^8.4.2 (#6917)

7.2.0

Added

  • Add two new controller state metadata properties: includeInStateLogs and usedInUi (#6473)

Changed

7.1.3

Changed

  • Bump @metamask/base-controller from ^7.1.0 to ^8.0.0 (#5135), (#5305)
  • Bump @metamask/utils from ^11.0.1 to ^11.1.0 (#5223)

7.1.2

Changed

  • Bump nanoid from ^3.1.31 to ^3.3.8 (#5073)
  • Bump @metamask/utils from ^10.0.0 to ^11.0.1 (#5080)
  • Bump @metamask/rpc-errors from ^7.0.0 to ^7.0.2 (#5080)
  • Bump @metamask/base-controller from ^7.0.0 to ^7.1.0 (#5079)

7.1.1

Changed

  • Bump @metamask/utils from ^9.1.0 to ^10.0.0 (#4831)

7.1.0

Added

  • Add deleteAfterResult option to accept method to delay removal of approval request from state (#4715)

7.0.4

Fixed

  • Produce and export ESM-compatible TypeScript type declaration files in addition to CommonJS-compatible declaration files (#4648)
    • Previously, this package shipped with only one variant of type declaration files, and these files were only CommonJS-compatible, and the exports field in package.json linked to these files. This is an anti-pattern and was rightfully flagged by the "Are the Types Wrong?" tool as "masquerading as CJS". All of the ATTW checks now pass.
  • Remove chunk files (#4648).
    • Previously, the build tool we used to generate JavaScript files extracted common code to "chunk" files. While this was intended to make this package more tree-shakeable, it also made debugging more difficult for our development teams. These chunk files are no longer present.

7.0.3

Changed

  • Bump @metamask/base-controller from ^6.0.2 to ^7.0.0 (#4625, #4643)
  • Bump typescript from ~5.0.4 to ~5.2.2 (#4576, #4584)

7.0.2

Changed

  • Bump TypeScript version to ~5.0.4 and set moduleResolution option to Node16 (#3645)
  • Bump @metamask/base-controller from ^6.0.1 from ^6.0.2 (#4544)
  • Bump @metamask/utils from ^9.0.0 to ^9.1.0 (#4529)

7.0.1

Changed

  • Bump @metamask/rpc-errors from 6.2.1 to ^6.3.1 (#4516)
  • Bump @metamask/utils from ^8.3.0 to ^9.0.0 (#4516)
  • Bump @metamask/base-controller to ^6.0.1 (#4517)

7.0.0

Changed

  • BREAKING: Bump minimum Node version to 18.18 (#3611)
  • Bump @metamask/base-controller to ^6.0.0 (#4352)

6.0.2

Changed

  • Bump TypeScript version to ~4.9.5 (#4084)
  • Bump @metamask/base-controller to ^5.0.2 (#4232)

6.0.1

Fixed

  • Fix types field in package.json (#4047)

6.0.0

Added

  • BREAKING: Add ESM build (#3998)
    • It's no longer possible to import files from ./dist directly.

Changed

  • BREAKING: Bump @metamask/base-controller to ^5.0.0 (#4039)
    • This version has a number of breaking changes. See the changelog for more.

Fixed

  • BREAKING: Narrow ApprovalControllerMessenger type parameters AllowedAction and AllowedEvent from string to never (#4031)
    • Allowlisting or using any external actions or events will now produce a type error.

5.1.3

Changed

  • Bump @metamask/rpc-errors to ^6.2.1 (#3954)

5.1.2

Changed

  • Bump @metamask/utils to ^8.3.0 (#3769)
  • Bump @metamask/base-controller to ^4.1.1 (#3760, #3821)

5.1.1

Changed

  • Bump @metamask/base-controller to ^4.0.1 (#3695)

5.1.0

Added

  • Add title and icon options to success and error methods (#3675)

5.0.0

Changed

  • BREAKING: Bump @metamask/base-controller to ^4.0.0 (TODO: THIS PR)
    • This is breaking because the type of the messenger has backward-incompatible changes. See the changelog for this package for more.
  • Bump @metamask/utils to ^8.2.0 (#1957)

4.1.0

Added

  • Add show option for startFlow (#1886)
    • This option lets you initiate a new approval flow without triggering the UI immediately.

4.0.1

Changed

  • Bump dependency on @metamask/rpc-errors to ^6.1.0 (#1653)

4.0.0

Changed

  • BREAKING: Move eth-rpc-errors@^4.0.2 dependency to @metamask/rpc-errors@^6.0.2 (#1743)
    • Upon upgrading, you may need to also use @metamask/rpc-errors@^6.0.2, which restricts valid data that can be used to build messages
  • Bump dependency on @metamask/utils to ^8.1.0 (#1639)
  • Bump dependency on @metamask/base-controller to ^3.2.3

3.5.2

Changed

  • Update TypeScript to v4.8.x (#1718)

3.5.1

Changed

  • Bump dependency on @metamask/base-controller to ^3.2.1

3.5.0

Changed

  • Update @metamask/utils to ^6.2.0 (#1514)

3.4.0

Added

  • Add success and error methods to display result pages (#1442)

3.3.0

Added

  • Add setFlowLoadingText method to ApprovalController (#1419)

3.2.0

Added

  • Add startFlow and endFlow methods to ApprovalController (#1394)

Fixed

  • Fix ApprovalController constructor so that it accepts a messenger created by calling getRestricted without having type parameters explicitly specified (#1417)

3.1.0

Added

  • Optional feedback when accepting an approval request (#1396)

3.0.0

Changed

  • BREAKING: Bump to Node 16 (#1262)
  • Replace @metamask/controller-utils dependency with @metamask/utils (#1370)

2.1.1

Changed

  • deps: eth-rpc-errors@4.0.0->4.0.2 (#1215)

2.1.0

Added

  • Option to exclude types from rate limiting (#1185)

2.0.0

Removed

  • BREAKING: Remove isomorphic-fetch (#1106)
    • Consumers must now import isomorphic-fetch or another polyfill themselves if they are running in an environment without fetch

1.1.0

Added

  • Add updateRequestState action to ApprovalController (#1059)

Changed

  • Rename this repository to core (#1031)
  • Update @metamask/controller-utils package (#1041)

1.0.1

Changed

  • Relax dependencies on @metamask/base-controller and @metamask/controller-utils (use ^ instead of ~) (#998)

1.0.0

Added

  • Initial release

    • As a result of converting our shared controllers repo into a monorepo (#831), we've created this package from select parts of @metamask/controllers v33.0.0, namely:

      • Everything in src/approval

      All changes listed after this point were applied to this package following the monorepo conversion.