Breaking changes:
- Updated
RestClient
interface. Classes implementingRestClient
interface must now return HTTP response headers in addition to the response body. - Updated
createFromTemplate
iModel operation error handling. If iModel initialization times out, the error code of the thrown error will now beIModelFromTemplateInitializationTimedOut
instead ofIModelFromTemplateInitializationFailed
.
Breaking changes:
- Dropped support for Node.js versions older than 18.12.0.
Breaking changes:
- Updated client to use iModels API V2 by default. All references to the term "Project" were updated to use "iTwin" (
projectId
->iTwinId
, ...).
Breaking changes:
- Removed
FileHandler
interface and defaultAzureFileHandler
implementation. Storage operations now use@itwin/object-storage-core
and@itwin/object-storage-azure
packages. - Removed internal code exports from the main
index.ts
file that should not be used directly by package users. The following components are no longer part of the public package API:- Operation classes (
IModelOperations
,ChangesetOperations
, etc.) - Utility types (raw API response interfaces, etc.)
- Default IModelsClient option implementations (
AxiosRestClient
) - Default iModels API parser class
- Operation classes (
- Changed
_links
property type in entity interfaces fromLink
toLink | null
as per iModels API definition.
Non-breaking changes:
- Surfaced more iModels API operations. Please see the package documentation for an updated list of supported operations and entities: link to docs.