Project SDK
The project SDK provides a set of packages that can be used to interact with projects on the HxDR Platform. This includes creating, updating and deleting projects as well as managing the project's members and their roles.
Installation
To install this package, you need to have access to the private @sdk npm scope.
To integrate the SDK Project package into your project, use the following command with your preferred package manager:
npm install @sdk/projectProject Service
A service has to be set up to use the project SDK. This service can be used to create, update and delete projects. To simplify the creation of the project service, a factory function is available that creates a project service with a default configuration.
// The ready connection client (`Connect.ConnectClientInterface`) from the `@sdk/connect` package.
import myConnectClient from './myConnectClient';
// A configuration (`ConfigInterface`) from the `@sdk/config` package.
import myConfig from './myConfig';
import { projectServiceFactory } from '@sdk/project';
const projectService = projectServiceFactory(myConfig, myConnectClient);