https://github.com/itwin/imodels-clients
Monorepo for iModels API clients
https://github.com/itwin/imodels-clients
Last synced: 7 days ago
JSON representation
Monorepo for iModels API clients
- Host: GitHub
- URL: https://github.com/itwin/imodels-clients
- Owner: iTwin
- License: mit
- Created: 2021-08-04T09:44:03.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-14T07:50:10.000Z (12 days ago)
- Last Synced: 2025-04-14T08:27:19.230Z (12 days ago)
- Language: TypeScript
- Size: 2.03 MB
- Stars: 8
- Watchers: 32
- Forks: 2
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# iModels API Client Libraries
Copyright © Bentley Systems, Incorporated. All rights reserved. See [LICENSE.md](./LICENSE.md) for license terms and full copyright notice.
## About this Repository
This repository contains packages that help consumption of iModels API. Please visit the [iModels API documentation page](https://developer.bentley.com/apis/imodels-v2/) on iTwin developer portal to learn more about the iModels service and its APIs. API clients contain methods that either act as a thin wrapper for sending a single request to the API or combine several requests to execute a more complex operation.
iModels API is a part of [iTwin Platform](https://developer.bentley.com/). iTwin platform together with an open source [iTwin.js][iTwinJS] library provides capabilities for creating, querying, modifying, and displaying Infrastructure Digital Twins.
This repository contains multiple packages:
- [`@itwin/imodels-client-management`](clients/imodels-client-management/README.md) is an API client that exposes a subset of iModels API operations and is intended to use in iModel management applications. Such applications do not edit the iModel file itself, they allow user to perform administrative tasks - create Named Versions, view Changeset metadata and such.
- [`@itwin/imodels-client-authoring`](clients/imodels-client-authoring/README.md) is an API client that extends `@itwin/imodels-client-management` and exposes additional API operations to facilitate iModel editing workflows. This client should not be used directly as the operations it exposes can only be used meaningfully via [iTwin.js](https://www.itwinjs.org/) library.
- [`@itwin/imodels-access-frontend`](itwin-platform-access/imodels-access-frontend/README.md) package contains an implementation of [`FrontendHubAccess`](https://github.com/iTwin/itwinjs-core/blob/master/core/frontend/src/FrontendHubAccess.ts) interface which enables the iTwin.js platform to use iModels API.
- [`@itwin/imodels-access-backend`](itwin-platform-access/imodels-access-backend/README.md) package contains an implementation of [`BackendHubAccess`](https://github.com/iTwin/itwinjs-core/blob/master/core/backend/src/BackendHubAccess.ts) interface which enables the iTwin.js platform to use iModels API.
- [`@itwin/imodels-client-common-config`](utils/imodels-client-common-config/README.md) package is used internally to share common configuration across the API clients.
- [`@itwin/imodels-clients-tests`](tests/imodels-clients-tests/README.md) package is used internally for `@itwin/imodels-client-management` and `@itwin/imodels-client-authoring` package testing.
- [`@itwin/imodels-access-backend-tests`](tests/imodels-access-backend-tests/README.md) package is used internally for API client testing.
## iTwin.js versions supported by @itwin/imodels-access-* packages
Please refer to the table below for guidance on which versions of `@itwin/imodels-access-frontend` and `@itwin/imodels-access-backend` packages are compatible with a specific [iTwin.js][iTwinJS] version.
| iTwin.js version | @itwin/imodels-access-* version |
|------------------|---------------------------------|
| >=3.0.0 <3.3.0 | >=1.0.1 <2.0.0 |
| >=3.3.0 <3.6.0 | >=2.0.0 <3.0.0 |
| >=3.6.0 <4.0.0 | >=3.0.0 <4.0.0 |
| >=4.0.0 | >=4.0.0, >=5.0.0 |
[iTwinJS]: https://www.itwinjs.org/