Skip to content

Commit 6197ade

Browse files
committed
Reformat CHANGELOG
1 parent 86f3449 commit 6197ade

File tree

2 files changed

+190
-128
lines changed

2 files changed

+190
-128
lines changed

CHANGELOG.md

Lines changed: 185 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -2,190 +2,274 @@
22

33
## main
44

5-
## 11.0.0
5+
## 11.0.0 - 2025-08-20
66

7-
- REMOVED: Remove from and to from Email Forward
8-
- CHANGED: Add active attribute to Email Forward
9-
- CHANGED: Updated dependencies
7+
### Changed
108

11-
## 10.0.0
9+
- Add active attribute to Email Forward
10+
- Update dependencies
1211

13-
- REMOVED: `DomainCollaborators` have been removed. Please use our Domain Access Control feature.
14-
- REMOVED: Dropped support for node 18.x. Upgraded NodeJS runtime requirements to Node JS 20 or higher
15-
- NEW: Add support for node 24.x
16-
- CHANGED: Updated dependencies
12+
### Removed
1713

18-
## 9.0.0
14+
- **Breaking:** Remove from and to from Email Forward
1915

20-
- NEW: Add support for node 22.x
21-
- CHANGED: `DomainCollaborators` have been deprecated and will be removed in the next major version. Please use our Domain Access Control feature.
22-
- CHANGED: Updated dependencies
16+
## 10.0.0 - 2025-05-09
2317

24-
## 8.1.0
18+
### Changed
2519

26-
- Getting the built-in `Fecther` default instance for the `DNSimple` class constructor has been made more robust to cover more scenarios where `fetch` might be present.
20+
- **Breaking:** Upgrade NodeJS runtime requirements to Node JS 20 or higher
21+
- Update dependencies
2722

28-
Now it also throws an actionable user error when no built-in `Fetcher` instance can be produced so that end-users can provide an implementation through the constructor's `fetcher` parameter.
23+
### Added
2924

30-
- Housekeeping:
31-
- Development stack has been updated, including a migration of the test suite to Jest and `fetchMock`
25+
- Add support for node 24.x
3226

33-
## 8.0.0
27+
### Removed
3428

35-
- Upgraded NodeJS runtime requirements to Node JS 18 or higher
29+
- **Breaking:** Remove `DomainCollaborators`. Please use our Domain Access Control feature.
30+
- **Breaking:** Drop support for node 18.x
3631

37-
## 7.4.0
32+
## 9.0.0 - 2024-12-12
3833

39-
ENHANCEMENTS:
34+
### Changed
4035

41-
- NEW: Added `secondary`, `last_transferred_at`, `active` to `Zone` (dnsimple/dnsimple-node#196)
36+
- Deprecate `DomainCollaborators`. Will be removed in the next major version. Please use our Domain Access Control feature.
37+
- Update dependencies
4238

43-
## 7.3.0
39+
### Added
4440

45-
FEATURES:
41+
- Add support for node 22.x
4642

47-
- NEW: Added `Billing.listCharges` to retrieve the list of billing charges for an account. (#189)
43+
## 8.1.0 - 2024-10-11
4844

49-
## 7.2.0
45+
### Changed
5046

51-
FEATURES:
47+
- Make the built-in `Fetcher` default instance for the `DNSimple` class constructor more robust to cover more scenarios where `fetch` might be present. Now it also throws an actionable user error when no built-in `Fetcher` instance can be produced so that end-users can provide an implementation through the constructor's `fetcher` parameter.
48+
- Update development stack, including a migration of the test suite to Jest and `fetchMock`
5249

53-
- NEW: Added `listRegistrantChanges`, `createRegistrantChange`, `checkRegistrantChange`, `getRegistrantChange`, and `deleteRegistrantChange` APIs to manage registrant changes. (dnsimple/dnsimple-node#181)
54-
- NEW: Added `getDomainTransferLock`, `enableDomainTransferLock`, `disableDomainTransferLock` APIs to manage domain transfer locks. (dnsimple/dnsimple-node#183)
50+
## 8.0.0 - 2024-03-08
5551

56-
## 7.1.1
52+
### Changed
5753

58-
FEATURES:
54+
- **Breaking:** Upgrade NodeJS runtime requirements to Node JS 18 or higher
5955

60-
- NEW: Added `Zones.activateDns` to activate DNS services (resolution) for a zone. (dnsimple/dnsimple-node#180)
61-
- NEW: Added `Zones.deactivateDns` to deactivate DNS services (resolution) for a zone. (dnsimple/dnsimple-node#180)
56+
## 7.4.0 - 2023-12-12
6257

63-
## 7.1.0
58+
### Added
6459

65-
FEATURES
60+
- Add `secondary`, `last_transferred_at`, `active` to `Zone` (#196)
6661

67-
- Most TypeScript types have been named and exported, instead of being inline anonymous types that are hard to reference and use. (dnsimple/dnsimple-node#175)
68-
- Enum type values are now declared, instead of a generic `string` or `number`, allowing for better type checking and autocomplete. (dnsimple/dnsimple-node#175)
62+
## 7.3.0 - 2023-12-06
6963

70-
NOTES
64+
### Added
7165

72-
- As enums are now typed, incorrect or unknown values will be rejected by the TypeScript type checker. Instead of strings, the types are unions of valid constant string values. `as const` can be used to make TypeScript infer a literal string as a constant string type.
66+
- Add `Billing.listCharges` to retrieve the list of billing charges for an account (#189)
7367

74-
## 7.0.0
68+
## 7.2.0 - 2023-09-07
7569

76-
This is a major change that brings TypeScript support as well as many quality-of-life improvements and internal improvements. For details on important changes and how to migrate, see [UPGRADE.md](./UPGRADE.md). For the full breakdown of all changes in detail, see the PR (dnsimple/dnsimple-node#170). Here are the major noteworthy changes:
70+
### Added
7771

78-
- All method parameters and return types are now typed by TypeScript. This means that usages can be checked and bugs can be detected before runtime, and text editors and IDEs can now provide automatic completions and hints on all of DNSimple's APIs easily and accurately.
72+
- Add `listRegistrantChanges`, `createRegistrantChange`, `checkRegistrantChange`, `getRegistrantChange`, and `deleteRegistrantChange` APIs to manage registrant changes (#181)
73+
- Add `getDomainTransferLock`, `enableDomainTransferLock`, `disableDomainTransferLock` APIs to manage domain transfer locks (#183)
7974

80-
- Request errors are now full JS classes that allow more type-safe and ergonomic error handling.
75+
## 7.1.1 - 2023-08-10
8176

82-
- The client has no dependencies on Node.js libraries and can also run in the browser, which we will work towards creating builds for in the future. The HTTP requester is now abstract and varies depending on the platform (browser or Node.js), and can also be replaced with custom logic, such as other libraries, retry strategies, intercepting and mutating, or logging and tracing.
77+
### Added
8378

84-
- All paginated API methods have helper submethods that provide an async iterator or array of all items across all pages effortlessly, transparently fetching each page request in the background. Use the new async iterator method for efficient retrieval that doesn't make requests until necessary, or use the array method to quickly fetch all values into a familar Array object with its methods. Both are also fully typed by TypeScript.
79+
- Add `Zones.activateDns` to activate DNS services (resolution) for a zone (#180)
80+
- Add `Zones.deactivateDns` to deactivate DNS services (resolution) for a zone (#180)
8581

86-
- All exports are now named and written in ESM syntax, which allows for future migration to the new standard that has better browser and tooling support. The output JS still uses CommonJS syntax for compatibility with most of today's programs (including Node.js and Webpack).
82+
## 7.1.0 - 2023-03-30
8783

88-
Not all changes have been listed here. For more details, view the PR (dnsimple/dnsimple-node#170) and [UPGRADE.md](./UPGRADE.md).
84+
### Changed
8985

90-
## 6.2.0
86+
- Name and export most TypeScript types, instead of using inline anonymous types that are hard to reference and use (#175)
87+
- Declare enum type values, instead of a generic `string` or `number`, allowing for better type checking and autocomplete (#175)
9188

92-
- NEW: Add support for getDomainRegistration and getDomainRenewal Registrar APIs (dnsimple/dnsimple-node#169)
93-
- CHANGED: Bump dependency version
89+
As enums are now typed, incorrect or unknown values will be rejected by the TypeScript type checker. Instead of strings, the types are unions of valid constant string values. `as const` can be used to make TypeScript infer a literal string as a constant string type.
9490

95-
## 6.1.0
91+
## 7.0.0 - 2023-03-21
9692

97-
- CHANGED: Add getter for attribute errors in `error` object (dnsimple/dnsimple-node#150)
98-
- CHANGED: Deprecate Certificate's `contact_id` (dnsimple/dnsimple-node#133)
93+
This is a major change that brings TypeScript support as well as many quality-of-life improvements and internal improvements. For details on important changes and how to migrate, see [UPGRADE.md](./UPGRADE.md). For the full breakdown of all changes in detail, see the PR (#170).
9994

100-
## 6.0.0
95+
### Changed
10196

102-
- NEW: Adds NodeJS v18 to Travis build
103-
- CHANGED: Deprecates support for NodeJS v12 (EOL)
97+
- **Breaking:** Type all method parameters and return types with TypeScript. Usages can be checked and bugs can be detected before runtime, and text editors and IDEs can now provide automatic completions and hints on all of DNSimple's APIs easily and accurately.
98+
- **Breaking:** Make request errors full JS classes that allow more type-safe and ergonomic error handling.
99+
- **Breaking:** Make all exports named and written in ESM syntax, which allows for future migration to the new standard that has better browser and tooling support. The output JS still uses CommonJS syntax for compatibility with most of today's programs (including Node.js and Webpack).
100+
- Remove dependencies on Node.js libraries. The client can also run in the browser. The HTTP requester is now abstract and varies depending on the platform (browser or Node.js), and can also be replaced with custom logic, such as other libraries, retry strategies, intercepting and mutating, or logging and tracing.
104101

105-
## 5.1.1
102+
### Added
106103

107-
- CHANGED: Bump dependency versions
104+
- Add helper submethods to all paginated API methods that provide an async iterator or array of all items across all pages effortlessly, transparently fetching each page request in the background
108105

109-
## 5.1.0
106+
## 6.2.0 - 2023-03-03
110107

111-
- CHANGED: Updated DNSSEC-related test to reflect DS record key-data interface. (dnsimple/dnsimple-node#110)
108+
### Changed
112109

113-
## 5.0.0
110+
- Bump dependency version
114111

115-
- NEW: Adds NodeJS v16 to Travis build
116-
- NEW: Adds NodeJS node (latest) to Travis build
117-
- CHANGED: Moves lockfileVersion to v2
118-
- CHANGED: Deprecates support for NodeJS v10 (EOL)
119-
- CHANGED: Deprecates `registrar.getDomainPremiumPrice` in favour of `registrar.getDomainPrices`
112+
### Added
120113

121-
## 4.4.0
114+
- Add support for getDomainRegistration and getDomainRenewal Registrar APIs (#169)
122115

123-
- NEW: Added `registrar.getDomainPrices` to retrieve whether a domain is premium and the prices to register, transfer, and renew. (dnsimple/dnsimple-node#88)
124-
- REMOVED: Drop the inexistent `domains.resetDomainToken` method (dnsimple-node#89)
116+
## 6.1.0 - 2022-09-20
125117

126-
## 4.3.0
118+
### Changed
127119

128-
- NEW: Adds NodeJS v15 to Travis build
129-
- CHANGED: Removes NodeJS v13 from Travis build
120+
- Add getter for attribute errors in `error` object (#150)
121+
- Deprecate Certificate's `contact_id` (#133)
122+
123+
## 6.0.0 - 2022-05-04
124+
125+
### Changed
126+
127+
- **Breaking:** Deprecate support for NodeJS v12 (EOL)
128+
129+
### Added
130+
131+
- Add NodeJS v18 to Travis build
132+
133+
## 5.1.1 - 2022-01-20
134+
135+
### Changed
136+
137+
- Bump dependency versions
138+
139+
## 5.1.0 - 2021-11-29
140+
141+
### Changed
142+
143+
- Update DNSSEC-related test to reflect DS record key-data interface (#110)
144+
145+
## 5.0.0 - 2021-06-07
146+
147+
### Changed
148+
149+
- **Breaking:** Deprecate support for NodeJS v10 (EOL)
150+
- Move lockfileVersion to v2
151+
- Deprecate `registrar.getDomainPremiumPrice` in favour of `registrar.getDomainPrices`
152+
153+
### Added
154+
155+
- Add NodeJS v16 to Travis build
156+
- Add NodeJS node (latest) to Travis build
157+
158+
## 4.4.0 - 2021-04-22
159+
160+
### Added
161+
162+
- Add `registrar.getDomainPrices` to retrieve whether a domain is premium and the prices to register, transfer, and renew (#88)
163+
164+
### Removed
165+
166+
- Drop the inexistent `domains.resetDomainToken` method (#89)
167+
168+
## 4.3.0 - 2020-11-20
169+
170+
### Changed
171+
172+
- Remove NodeJS v13 from Travis build
173+
174+
### Added
175+
176+
- Add NodeJS v15 to Travis build
130177

131178
## 4.2.1 - 2020-06-29
132179

133-
- CHANGED: Bump semistandard from 14.2.0 to 14.2.2
134-
- CHANGED: Bump nock from 12.0.3 to 13.0.0
180+
### Changed
181+
182+
- Bump semistandard from 14.2.0 to 14.2.2
183+
- Bump nock from 12.0.3 to 13.0.0
135184

136185
## 4.2.0 - 2020-06-22
137186

138-
- CHANGED: Bump mocha from 7.1.2 to 8.0.1
139-
- CHANGED: Bump js-yaml from 3.13.1 to 3.14.0
140-
- CHANGED: Domain object deprecates `expires_on` attribute in favor of `expires_at`. (dnsimple/dnsimple-node#43)
141-
- CHANGED: Certificate object deprecates `expires_on` attribute in favor of `expires_at`. (dnsimple/dnsimple-node#45)
187+
### Changed
188+
189+
- Bump mocha from 7.1.2 to 8.0.1
190+
- Bump js-yaml from 3.13.1 to 3.14.0
191+
- Deprecate Domain object `expires_on` attribute in favor of `expires_at` (#43)
192+
- Deprecate Certificate object `expires_on` attribute in favor of `expires_at` (#45)
142193

143194
## 4.1.0 - 2020-05-18
144195

145-
- NEW: Adds NodeJS v14 to Travis build
146-
- NEW: Added `registrar.getDomainTransfer` to retrieve a domain transfer. (dnsimple/dnsimple-node#40)
147-
- NEW: Added `registrar.cancelDomainTransfer` to cancel an in progress domain transfer. (dnsimple/dnsimple-node#40)
148-
- CHANGED: Bump mocha from 7.1.1 to 7.1.2
196+
### Changed
197+
198+
- Bump mocha from 7.1.1 to 7.1.2
199+
200+
### Added
201+
202+
- Add NodeJS v14 to Travis build
203+
- Add `registrar.getDomainTransfer` to retrieve a domain transfer (#40)
204+
- Add `registrar.cancelDomainTransfer` to cancel an in progress domain transfer (#40)
149205

150206
## 4.0.0 - 2020-03-19
151207

152-
- NEW: Adds NodeJS v13 to Travis build
153-
- CHANGED: Deprecates support for NodeJS v8
154-
- CHANGED: Deprecates JSCS usage. Implements [https://www.npmjs.com/package/semistandard](https://www.npmjs.com/package/semistandard)
155-
- CHANGED: Simplifies testing instructions
156-
- CHANGED: Bump lodash from 4.17.14 to 4.17.15
157-
- CHANGED: Bump chai from 4.1.2 to 4.2.0
158-
- CHANGED: Bump mocha from 5.2.0 to 7.1.1
159-
- CHANGED: Bump nock from 9.3.2 to 12.0.3
160-
- FIX: Fixes typo in test helper
161-
- FIX: Fixes bad Certificates endpoint specs
208+
### Changed
209+
210+
- **Breaking:** Deprecate support for NodeJS v8
211+
- Deprecate JSCS usage. Implement [semistandard](https://www.npmjs.com/package/semistandard)
212+
- Simplify testing instructions
213+
- Bump lodash from 4.17.14 to 4.17.15
214+
- Bump chai from 4.1.2 to 4.2.0
215+
- Bump mocha from 5.2.0 to 7.1.1
216+
- Bump nock from 9.3.2 to 12.0.3
217+
218+
### Added
219+
220+
- Add NodeJS v13 to Travis build
221+
222+
### Fixed
223+
224+
- Fix typo in test helper
225+
- Fix bad Certificates endpoint specs
162226

163227
## 3.0.3 - 2020-02-27
164228

165-
- CHANGED: Default timeout is now hard-coded to ensure compatibility with Node.js 13. (GH-25) @jonchurch
229+
### Changed
230+
231+
- Hard-code default timeout to ensure compatibility with Node.js 13 (GH-25)
166232

167233
## 3.0.2 - 2020-02-11
168234

169-
- CHANGED: User-agent format has been changed to prepend custom token before default token.
235+
### Changed
236+
237+
- Change user-agent format to prepend custom token before default token
170238

171239
## 3.0.1 - 2019-07-29
172240

173-
- CHANGED: Dropped dependency on `npm`
241+
### Changed
242+
243+
- Drop dependency on `npm`
174244

175245
## 3.0.0 - 2019-07-18
176246

177-
- NEW: Updates to support Node v8. Node v6 is deprecated.
247+
### Changed
248+
249+
- **Breaking:** Deprecate Node v6
250+
251+
### Added
252+
253+
- Add support for Node v8
178254

179255
## 2.9.0 - 2019-02-01
180256

181-
- NEW: Added WHOIS privacy renewal (GH-17)
257+
### Added
258+
259+
- Add WHOIS privacy renewal (GH-17)
182260

183261
## 2.8.0 - 2018-10-16
184262

185-
- NEW: Added zone distribution and zone record distribution (GH-16)
263+
### Added
264+
265+
- Add zone distribution and zone record distribution (GH-16)
186266

187267
## 2.7.0 - 2018-01-28
188268

189-
- NEW: Added Let's Encrypt certificate methods (GH-14)
269+
### Changed
270+
271+
- Update registrar URLs (GH-12)
272+
273+
### Added
190274

191-
- CHANGED: Updated registrar URLs (GH-12)
275+
- Add Let's Encrypt certificate methods (GH-14)

0 commit comments

Comments
 (0)