Skip to content

Commit

Permalink
Update changelog formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Mrtenz committed Sep 19, 2024
1 parent d1f7d9e commit 447b4f1
Showing 1 changed file with 0 additions and 83 deletions.
83 changes: 0 additions & 83 deletions packages/snaps-sdk/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
Expand All @@ -8,41 +7,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

## [6.5.1]

### Fixed

- Fix package exports ([#2737](https://github.com/MetaMask/snaps/pull/2737))

## [6.5.0]

### Added

- Add `center` prop to `Box` component ([#2716](https://github.com/MetaMask/snaps/pull/2716))
- Add `form` prop to `Button` component ([#2712](https://github.com/MetaMask/snaps/pull/2712))
- This allows the `Button` component to be used outside of forms, but still
submit a form when clicked.

### Fixed

- Fix invalid types in type declaration in some cases ([#2714](https://github.com/MetaMask/snaps/pull/2714))
- Fix type issue with `Field` children ([#2715](https://github.com/MetaMask/snaps/pull/2715))
- `Field` now accepts booleans and `null` as children, in addition to the
existing types.

## [6.4.0]

### Added

- Add `Section` component ([#2672](https://github.com/MetaMask/snaps/pull/2672))
- Add support for element before input in the `Field` component ([#2699](https://github.com/MetaMask/snaps/pull/2699))

### Changed

- Allow CAIP-10 addresses in the `Address` component ([#2680](https://github.com/MetaMask/snaps/pull/2680))
- Improve error messaging ([#2696](https://github.com/MetaMask/snaps/pull/2696), [#2693](https://github.com/MetaMask/snaps/pull/2693))

### Fixed

- Allow any element as the child of the `Container` component ([#2698](https://github.com/MetaMask/snaps/pull/2698))
- Disallow images and icons in footers ([#2676](https://github.com/MetaMask/snaps/pull/2676))
- Fix ESM version of the package ([#2682](https://github.com/MetaMask/snaps/pull/2682))
Expand All @@ -52,40 +42,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Bump other MetaMask dependencies ([#2703](https://github.com/MetaMask/snaps/pull/2703))

## [6.3.0]

### Added

- Add `Selector` component ([#2645](https://github.com/MetaMask/snaps/pull/2645))
- Add `Icon` component ([#2638](https://github.com/MetaMask/snaps/pull/2638))
- Add `color` prop to `Text` component ([#2660](https://github.com/MetaMask/snaps/pull/2660))

### Changed

- `Button` children are now allowed to be `Image` and `Icon` ([#2641](https://github.com/MetaMask/snaps/pull/2641))

## [6.2.1]

### Fixed

- Add structs to `typedUnion` schema ([#2623](https://github.com/MetaMask/snaps/pull/2623))

## [6.2.0]

### Added

- Add `snap_getPreferences` ([#2607](https://github.com/MetaMask/snaps/pull/2607))
- Add `RadioGroup` component ([#2592](https://github.com/MetaMask/snaps/pull/2592))

## [6.1.1]

### Changed

- Bump `@metamask/providers` from `17.0.0` to `^17.1.2` ([#2598](https://github.com/metamask/snaps/pull/2598))

## [6.1.0]

### Added

- Add non-restricted RPC method `snap_resolveInterface` ([#2509](https://github.com/metamask/snaps/pull/2509))
- This method allows a Snap to resolve a given user interface bound to a `snap_dialog` with a custom value.
- Add new types `ResolveInterfaceParams`, `ResolveInterfaceResult`.
Expand All @@ -94,23 +73,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Add `Container` and `Footer` components ([#2517](https://github.com/metamask/snaps/pull/2517))

### Changed

- Update `RootJSXElement` to allow `Container` or `Box` at the root ([#2526](https://github.com/metamask/snaps/pull/2526))
- Bump `@metamask/key-tree` from `^9.1.1` to `^9.1.2` ([#2445](https://github.com/MetaMask/snaps/pull/2445))
- Bump `@metamask/rpc-errors` from `^6.2.1` to `^6.3.1` ([#2445](https://github.com/MetaMask/snaps/pull/2445))
- Bump `@metamask/utils` from `^8.3.0` to `^9.1.0` ([#2445](https://github.com/MetaMask/snaps/pull/2445))

### Fixed

- Replace `superstruct` with ESM-compatible `@metamask/superstruct` `^3.1.0` ([#2445](https://github.com/MetaMask/snaps/pull/2445))
- This fixes the issue of this package being unusable by any TypeScript project that uses `Node16` or `NodeNext` as its `moduleResolution` option.
- Set `@metamask/providers` from `^17.0.0` to `17.0.0` ([#2445](https://github.com/MetaMask/snaps/pull/2445))
- `17.1.0` and `17.1.1` introduce regressions.

## [6.0.0]

### Added

- **BREAKING:** Add `FileInput` component ([#2469](https://github.com/MetaMask/snaps/pull/2469), [#2504](https://github.com/MetaMask/snaps/pull/2504))
- `FormSubmitEvent` may now contain values of type `File`.
- **BREAKING:** Add `Checkbox` component ([#2501](https://github.com/MetaMask/snaps/pull/2501))
Expand All @@ -121,79 +96,59 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Support conditional children in most JSX components ([#2506](https://github.com/MetaMask/snaps/pull/2506))

## [5.0.0]

### Added

- Allow row tooltips ([#2483](https://github.com/MetaMask/snaps/pull/2483))
- Support nested children in JSX ([#2482](https://github.com/MetaMask/snaps/pull/2482))

### Changed

- Update `onNameLookup` response types ([#2484](https://github.com/MetaMask/snaps/pull/2484))

### Removed

- **BREAKING:** Remove `parseSvg` and `isSvg` internals ([#2475](https://github.com/MetaMask/snaps/pull/2475))

### Fixed

- Correct Row variant in JSX ([#2486](https://github.com/MetaMask/snaps/pull/2486))
- Revert requiring at least one child in JSX components ([#2481](https://github.com/MetaMask/snaps/pull/2481), [#2470](https://github.com/MetaMask/snaps/pull/2470))
- Correct docs for `Input` and `Dropdown` ([#2479](https://github.com/MetaMask/snaps/pull/2479))

## [4.4.2]

### Fixed

- Require at least 1 child in JSX components ([#2466](https://github.com/MetaMask/snaps/pull/2466))

## [4.4.1]

### Fixed

- Fix invalid `@metamask/snaps-sdk` imports ([#2452](https://github.com/MetaMask/snaps/pull/2452))

## [4.4.0]

### Added

- Add origin to lifecycle hooks ([#2441](https://github.com/MetaMask/snaps/pull/2441))
- Lifecycle hooks can now use the `origin` parameter to determine the origin
of the installation or update.

### Changed

- Bump `@metamask/providers` from `16.1.0` to `17.0.0` ([#2442](https://github.com/MetaMask/snaps/pull/2442))
- Bump `@metamask/key-tree` from `9.1.0` to `9.1.1` ([#2431](https://github.com/MetaMask/snaps/pull/2431))

## [4.3.0]

### Added

- Add `Value` component ([#2435](https://github.com/MetaMask/snaps/pull/2435))
- Add `Dropdown` component ([#2420](https://github.com/MetaMask/snaps/pull/2420))
- Add positioning props to `Box` ([#2422](https://github.com/MetaMask/snaps/pull/2422))
- Allow `Button` within `Input` ([#2407](https://github.com/MetaMask/snaps/pull/2407))
- Add `context` field to `snap_createInterface` ([#2413](https://github.com/MetaMask/snaps/pull/2413), [#2427](https://github.com/MetaMask/snaps/pull/2427))

### Fixed

- Correct validation for children of Box component ([#2423](https://github.com/MetaMask/snaps/pull/2423))

## [4.2.0]

### Added

- Add support for BIP-32-Ed25519 / CIP-3 key derivation ([#2408](https://github.com/MetaMask/snaps/pull/2408))

### Fixed

- Add missing TypeScript declarations for JSX entry points ([#2404](https://github.com/MetaMask/snaps/pull/2404))

## [4.1.0]

### Added

- Add JSX support for custom UI ([#2258](https://github.com/MetaMask/snaps/pull/2258), [#2379](https://github.com/MetaMask/snaps/pull/2379))
- It's now possible to use JSX components from this package to build user
interfaces for Snaps.
Expand All @@ -204,69 +159,50 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
will be used automatically.

### Changed

- Deprecate legacy UI components ([#2388](https://github.com/MetaMask/snaps/pull/2388))
- Bump `@metamask/providers` from `16.0.0` to `16.1.0` ([#2386](https://github.com/MetaMask/snaps/pull/2386))

## [4.0.1]

### Fixed

- Allow `null` in `FormSubmitEventStruct` form state ([#2333](https://github.com/MetaMask/snaps/pull/2333))

## [4.0.0]

### Removed

- **BREAKING:** Remove broken `ethereum` properties ([#2296](https://github.com/MetaMask/snaps/pull/2296))
- Snaps can no longer access `on` and `removeListener` on `ethereum`.
- This feature was already non-functional.

## [3.2.0]

### Added

- Add support for importing SVG, PNG, and JPEG files directly ([#2284](https://github.com/MetaMask/snaps/pull/2284))

### Changed

- Narrow type for `endowment:name-lookup` ([#2293](https://github.com/MetaMask/snaps/pull/2293))
- Bump MetaMask dependencies ([#2270](https://github.com/MetaMask/snaps/pull/2270))

## [3.1.1]

### Changed

- Bump `@metamask/providers` to `^15.0.0` ([#2231](https://github.com/MetaMask/snaps/pull/2231))

### Fixed

- Fix address validation in row component ([#2257](https://github.com/MetaMask/snaps/pull/2257))

## [3.1.0]

### Added

- Add `InputChangeEvent` event ([#2237](https://github.com/MetaMask/snaps/pull/2237))
- Add `error` prop to input component ([#2239](https://github.com/MetaMask/snaps/pull/2239))

## [3.0.1]

### Fixed

- Fix minor build configuration problems ([#2220](https://github.com/MetaMask/snaps/pull/2220))

## [3.0.0]

### Changed

- **BREAKING:** Update ESM build to be fully compliant with the ESM standard ([#2210](https://github.com/MetaMask/snaps/pull/2210))
- Bump `@metamask/rpc-errors` to `^6.2.1` ([#2209](https://github.com/MetaMask/snaps/pull/2209))

## [2.1.0]

### Changed

- Improve support for Snap errors without a message ([#2176](https://github.com/MetaMask/snaps/pull/2176))
- You can now add data to an error without having to specify a message. For example:
```ts
Expand All @@ -275,71 +211,52 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Strip empty `data` from Snap errors ([#2179](https://github.com/MetaMask/snaps/pull/2179))

## [2.0.0]

### Changed

- **BREAKING:** Update name lookup API types ([#2113](https://github.com/MetaMask/snaps/pull/2113))
- The return value and the permission format has changed, see [SIP-12](https://metamask.github.io/SIPs/SIPS/sip-12) for more details.
- Add support for dynamic user interfaces ([#1465](https://github.com/MetaMask/snaps/pull/1465), [#2126](https://github.com/MetaMask/snaps/pull/2126), [#2143](https://github.com/MetaMask/snaps/pull/2143))
- Add support for snap defined execution timeouts ([#2098](https://github.com/MetaMask/snaps/pull/2098))

### Fixed

- Fix initial permissions types ([#2111](https://github.com/MetaMask/snaps/pull/2111))

## [1.4.0]

### Added

- Add support for signature insights ([#2074](https://github.com/MetaMask/snaps/pull/2074), [#2079](https://github.com/MetaMask/snaps/pull/2079))
- Add types for `snap_getClientStatus` ([#2051](https://github.com/MetaMask/snaps/pull/2051))

### Changed

- Bump @metamask/utils from 8.2.1 to 8.3.0 ([#2100](https://github.com/MetaMask/snaps/pull/2100))

## [1.3.2]

### Fixed

- Fix missing `sensitive` property in `Copyable` type ([#2070](https://github.com/MetaMask/snaps/pull/2070))

## [1.3.1]

### Fixed

- Export error wrappers ([#2043](https://github.com/MetaMask/snaps/pull/2043))

## [1.3.0]

### Added

- Add image fetching utility functions ([#1995](https://github.com/MetaMask/snaps/pull/1995))
- This adds two functions:
- `getImageComponent` to get an `image` component from a PNG or JPEG URL.
- `getImageData` to get a base64 data string, which can be embedded in an SVG image.

## [1.2.0]

### Added

- Add `row` and `address` component ([#1968](https://github.com/MetaMask/snaps/pull/1968))
- Add `enumValue`, `literal` and `union` from `snaps-utils` ([#1968](https://github.com/MetaMask/snaps/pull/1968))

### Changed

- Bump several MetaMask dependencies ([#1964](https://github.com/MetaMask/snaps/pull/1964))

## [1.1.0]

### Added

- Add Snap error wrappers of JSON-RPC errors ([#1924](https://github.com/MetaMask/snaps/pull/1924))

## [1.0.0]

### Added

- Initial release of this package.

[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-sdk@6.5.1...HEAD
Expand Down

0 comments on commit 447b4f1

Please sign in to comment.