Skip to content
This repository has been archived by the owner on Mar 15, 2023. It is now read-only.

Commit

Permalink
Update CHANGELOG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dillonredding committed Sep 10, 2022
1 parent 8339914 commit d02ef04
Showing 1 changed file with 38 additions and 25 deletions.
63 changes: 38 additions & 25 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,45 @@

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

The format is based on [Keep a Changelog][kac], and this project adheres to
[Semantic Versioning][semver].
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

[kac]: https://keepachangelog.com/en/1.0.0
[semver]: https://semver.org/spec/v2.0.0.html
## [0.4.0]

## Unreleased
### Added

- `stringify` and `parse` functions for generating and parsing Siren JSON

### Changed

- Object creation now done via static factory methods (e.g., `Entity.of({...})`)
- Validation is now done via [class-validator](https://github.com/typestack/class-validator)
- Renamed `Entity`'s and `Action`'s `get*` methods to `find*`

### Removed

- Query methods:
- `Entity.prototype.getActionsByClass()`
- `Entity.prototype.getEntitiesByClass()`
- `Entity.prototype.getLinksByClass()`

## 0.3.2
## [0.3.2] - 2021-07-05

### Changed

- Explicitly mentioning cross-platform support in README

### Fixed

- [#9] - Mentioning minimum TypeScript version in README
- [#10] - Link relation types are now compared in a case-insensitive fashion,
per [RFC 8288][rfc8288].

[#9]: https://github.com/siren-js/core/issues/9
[#10]: https://github.com/siren-js/core/issues/10
[rfc8288]: https://datatracker.ietf.org/doc/html/rfc8288#section-3.3
- [#9](https://github.com/siren-js/core/issues/9) - Mentioning minimum TypeScript version in README
- [#10](https://github.com/siren-js/core/issues/10) - Link relation types are now compared in a case-insensitive fashion, per [RFC 8288](https://datatracker.ietf.org/doc/html/rfc8288#section-3.3).

## 0.3.1 - 2021-04-26
## [0.3.1] - 2021-04-26

### Changed

- Transpiling to CommonJS modules

## 0.3.0 - 2021-04-26
## [0.3.0] - 2021-04-26

### Added

Expand All @@ -47,11 +55,9 @@ The format is based on [Keep a Changelog][kac], and this project adheres to

### Fixed

- [#6] - Extensions are now supported in TypeScript
- [#6](https://github.com/siren-js/core/issues/6) - Extensions are now supported in TypeScript

[#6]: https://github.com/siren-js/core/issues/6

## 0.2.0 - 2021-04-22
## [0.2.0] - 2021-04-22

### Added

Expand All @@ -69,11 +75,9 @@ The format is based on [Keep a Changelog][kac], and this project adheres to

- Serializing `EmbeddedEntity` now includes `rel`
- Generated type for `Entity.prototype.actions`
- [#4] - Type declarations for option objects

[#4]: https://github.com/siren-js/core/issues/4
- [#4](https://github.com/siren-js/core/issues/4) - Type declarations for option objects

## 0.1.2 - 2021-04-09
## [0.1.2] - 2021-04-09

### Added

Expand All @@ -86,14 +90,14 @@ The format is based on [Keep a Changelog][kac], and this project adheres to
is still thrown, but now includes a better message.
- `EmbeddedLink.isValid()` now returns `true` if `rel` is a string.

## 0.1.1 - 2021-04-02
## [0.1.1] - 2021-04-02

### Added

- Component classes documented with [JSDoc](https://jsdoc.app)
- Type declarations for more IDE-friendly development

## 0.1.0 - 2021-03-26
## [0.1.0] - 2021-03-26

### Added

Expand All @@ -104,3 +108,12 @@ The format is based on [Keep a Changelog][kac], and this project adheres to
- Extensions are allowed via the options object.
- Conformance to the core Siren specification is maintained through type
coercion and, in some places, immutability.

[0.4.0]: https://github.com/siren-js/core/compare/v0.3.2...v0.4.0
[0.3.2]: https://github.com/siren-js/core/compare/v0.3.1...v0.3.2
[0.3.1]: https://github.com/siren-js/core/compare/v0.3.0...v0.3.1
[0.3.0]: https://github.com/siren-js/core/compare/v0.2.0...v0.3.0
[0.2.0]: https://github.com/siren-js/core/compare/v0.1.2...v0.2.0
[0.1.2]: https://github.com/siren-js/core/compare/v0.1.1...v0.1.2
[0.1.1]: https://github.com/siren-js/core/compare/v0.1.0...v0.1.1
[0.1.0]: https://github.com/siren-js/core/releases/tag/v0.1.0

0 comments on commit d02ef04

Please sign in to comment.