All notable changes to this project are documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

• Require Node JS 20+.

• Modify the library packaging to make ECMAScript modules (ESM) optional.
• Substitute the 'ky' dependency with native fetch API.
• Reduce the default timeout setting to 5 seconds.
• Implement retries, up to two times, with exponential backoff in the event of a timeout.

• Add missing fields size and status to type AutonomousSystemPrefix.

• Fix a packaging issue.

• New IpregistryClient#batchLookupAsns method.
• New IpregistryClient#lookupAsn method.
• New IpregistryClient#originLookupAsn method.
• New IpregistryConfigBuilder.withEuBaseUrl method. Once configured, requests will be handled by nodes deployed in the European Union only.
• New IpregistryRequestHandler#batchLookupAsns method.
• New IpregistryRequestHandler#lookupAsn method.
• New IpregistryRequestHandler#originLookupAsn method.

• Rename IpregistryClient#batchLookup to IpregistryClient#batchLookupIps.
• Rename IpregistryClient#lookup to IpregistryClient#lookupIp.
• Rename IpregistryClient#originLookup to IpregistryClient#originLookupIp.
• Rename IpregistryClient#parse to IpregistryClient#parseUserAgents.
• Rename IpregistryConfigBuilder.withApiUrl to IpregistryConfigBuilder.withBaseUrl.
• Rename IpregistryRequestHandler#batchLookup to IpregistryRequestHandler#batchLookupIps.
• Rename IpregistryRequestHandler#lookup to IpregistryRequestHandler#lookupIp.
• Rename IpregistryRequestHandler#originLookup to IpregistryRequestHandler#originLookupIp.
• Rename IpregistryRequestHandler#parse to IpregistryRequestHandler#parseUserAgents.
• Rename utility class UserAgent to UserAgents.
• Replace Axios by ky to bring support to Cloudflare Workers in addition to browser and NodeJS environments.
• Require NodeJS 18+.

• Fixed origin requests returning wrong information when caching is enabled. Cache is now automatically disabled for origin requests since it is incompatible.

• New is_vpn field in security object.

• Invalid field name security.is_tor_exit_node has been renamed to security.is_tor_exit.

• Upgrade dependencies.

• Upgrade dependencies.

• New security.is_relay field.

• New parse method in IpregistryClient for parsing user-agent header values.

• Deprecate IpregistryConfigBuilder.withApiUrl in favor of IpregistryConfigBuilder.withBaseUrl.

• Replace invalid operating_system field in UserAgent by os.

• IpInfo responses have a new company field.
• The Connection type field includes a new value of INACTIVE.

• New connection type government.

• Improve utility function to detect bots/crawlers/spiders based on user-agent value.

• Fix invalid property names: language.name_native -> language.native and time_zone.daylight_saving -> time_zone.in_daylight_saving.

• Merge connection type cdn with hosting.

• [BREAKING] Rename DefaultCache to InMemoryCache.
• Upgrade dependencies.

• Use Authorization header instead of the key query parameter to pass API keys.

• Upgrade dependencies to fix an issue affecting TypeScript users (axios/axios#3219).

• Access to remaining credits was always returning null due to a packaging issue.

• Caching is now optional and disabled by default.
• Default timeout value has been increased to 15s from 3s.

• Fix access to remaining credits due to the removal of the response header ipregistry-credits from the Ipregistry API.

• [BREAKING] All client methods use a new ApiResponse type as response. You can now access usage data (i.e. remaining credits, throttling info) in addition to IP payloads.

• New field connection.route in response model.
• Introduce new value cdn for field connection.type.

• Define a null union type for all fields that can have a null value.

• New currency fields name_native and plural_native.

• Decrease the default cache period to 10min from 24h. This is to better handle use cases that require fresh security data. Indeed, such data is updated multiple times each hour. You can still configure the cache period to a higher value: https://github.com/ipregistry/ipregistry-javascript#configuring-cache-max-age

• Fix a packaging issue.

• Add examples for cache configuration, hostname lookup and fields selection.
• Add BAD_REQUEST and FORBIDDEN_IP_ORIGIN error codes.

• Export ipregistry as default export in client side module.

• License headers.
• Types for new fields returned by the Ipregistry API.

• All custom errors extend IpregistryError.

• Ignore case when checking if User-Agent is spider/bot.

• Fix deployment to NPM. No code change.

• Rename browser file to index.js from index.browser.js.

• Browser support.

• First public release.