- NEW: Add support for node 22.x
- CHANGED:
DomainCollaborators
have been deprecated and will be removed in the next major version. Please use our Domain Access Control feature. - CHANGED: Updated dependencies
-
Getting the built-in
Fecther
default instance for theDNSimple
class constructor has been made more robust to cover more scenarios wherefetch
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'sfetcher
parameter. -
Housekeeping:
- Development stack has been updated, including a migration of the test suite to Jest and
fetchMock
- Development stack has been updated, including a migration of the test suite to Jest and
- Upgraded NodeJS runtime requirements to Node JS 18 or higher
ENHANCEMENTS:
- NEW: Added
secondary
,last_transferred_at
,active
toZone
(#196)
FEATURES:
- NEW: Added
Billing.listCharges
to retrieve the list of billing charges for an account. (#189)
FEATURES:
- NEW: Added
listRegistrantChanges
,createRegistrantChange
,checkRegistrantChange
,getRegistrantChange
, anddeleteRegistrantChange
APIs to manage registrant changes. (#181) - NEW: Added
getDomainTransferLock
,enableDomainTransferLock
,disableDomainTransferLock
APIs to manage domain transfer locks. (#183)
FEATURES:
- NEW: Added
Zones.activateDns
to activate DNS services (resolution) for a zone. (#180) - NEW: Added
Zones.deactivateDns
to deactivate DNS services (resolution) for a zone. (#180)
FEATURES
- Most TypeScript types have been named and exported, instead of being inline anonymous types that are hard to reference and use. (#175)
- Enum type values are now declared, instead of a generic
string
ornumber
, allowing for better type checking and autocomplete. (#175)
NOTES
- 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.
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. For the full breakdown of all changes in detail, see the PR (#170). Here are the major noteworthy changes:
-
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.
-
Request errors are now full JS classes that allow more type-safe and ergonomic error handling.
-
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.
-
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.
-
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).
Not all changes have been listed here. For more details, view the PR (#170) and UPGRADE.md.
- NEW: Add support for getDomainRegistration and getDomainRenewal Registrar APIs (#169)
- CHANGED: Bump dependency version
- CHANGED: Add getter for attribute errors in
error
object (#150) - CHANGED: Deprecate Certificate's
contact_id
(#133)
- NEW: Adds NodeJS v18 to Travis build
- CHANGED: Deprecates support for NodeJS v12 (EOL)
- CHANGED: Bump dependency versions
- CHANGED: Updated DNSSEC-related test to reflect DS record key-data interface. (#110)
- NEW: Adds NodeJS v16 to Travis build
- NEW: Adds NodeJS node (latest) to Travis build
- CHANGED: Moves lockfileVersion to v2
- CHANGED: Deprecates support for NodeJS v10 (EOL)
- CHANGED: Deprecates
registrar.getDomainPremiumPrice
in favour ofregistrar.getDomainPrices
- NEW: Added
registrar.getDomainPrices
to retrieve whether a domain is premium and the prices to register, transfer, and renew. (#88) - REMOVED: Drop the inexistent
domains.resetDomainToken
method (dnsimple-node#89)
- NEW: Adds NodeJS v15 to Travis build
- CHANGED: Removes NodeJS v13 from Travis build
- CHANGED: Bump semistandard from 14.2.0 to 14.2.2
- CHANGED: Bump nock from 12.0.3 to 13.0.0
- CHANGED: Bump mocha from 7.1.2 to 8.0.1
- CHANGED: Bump js-yaml from 3.13.1 to 3.14.0
- CHANGED: Domain object deprecates
expires_on
attribute in favor ofexpires_at
. (#43) - CHANGED: Certificate object deprecates
expires_on
attribute in favor ofexpires_at
. (#45)
- NEW: Adds NodeJS v14 to Travis build
- NEW: Added
registrar.getDomainTransfer
to retrieve a domain transfer. (#40) - NEW: Added
registrar.cancelDomainTransfer
to cancel an in progress domain transfer. (#40) - CHANGED: Bump mocha from 7.1.1 to 7.1.2
- NEW: Adds NodeJS v13 to Travis build
- CHANGED: Deprecates support for NodeJS v8
- CHANGED: Deprecates JSCS usage. Implements https://www.npmjs.com/package/semistandard
- CHANGED: Simplifies testing instructions
- CHANGED: Bump lodash from 4.17.14 to 4.17.15
- CHANGED: Bump chai from 4.1.2 to 4.2.0
- CHANGED: Bump mocha from 5.2.0 to 7.1.1
- CHANGED: Bump nock from 9.3.2 to 12.0.3
- FIX: Fixes typo in test helper
- FIX: Fixes bad Certificates endpoint specs
- CHANGED: Default timeout is now hard-coded to ensure compatibility with Node.js 13. (GH-25) @jonchurch
- CHANGED: User-agent format has been changed to prepend custom token before default token.
- CHANGED: Dropped dependency on
npm
- NEW: Updates to support Node v8. Node v6 is deprecated.
- NEW: Added WHOIS privacy renewal (GH-17)
- NEW: Added zone distribution and zone record distribution (GH-16)
-
NEW: Added Let's Encrypt certificate methods (GH-14)
-
CHANGED: Updated registrar URLs (GH-12)