@jetbrains/teamcity-api NPM

TeamCity UI Plugin definitions module

This module contains typings for the updated TeamCity UI Plugin development guide. It provides typings for both Flow JS and TypeScript and should be used as a helper in time you develop the Plugin for the TeamCity.

Warning! This module is still under active development. Some APIs will be changed by the time of TeamCity 2020.2 release.

There are some useful resources for this repository:

Usage

To start using the package, import it as a module:

import TeamCityAPI from "@jetbrains/teamcity-api"

Module contains a bunch of useful items to assist you during plugin development. The set of items is not in a final version yet.

Components — set of reusable TeamCity Components.

React — exposed React instance. It's vital to use the same React library version to integrate your plugin into the TeamCity React vDOM tree (see the full explanation).

ReactDOM — exposed ReactDOM instance. It's vital to use the same React library version to integrate your plugin into the TeamCity React vDOM tree (see the full explanation).

utils — set of utilities

utils.requestJSON — function to request and parse a JSON from the server. It already contains all the headers for the request and automatically parses the response.

utils.requestTEXT — function to request and parse a TEXT from the server. It already contains all the headers for the request and automatically parses the response.

Plugin — plugin constructor. It expects you to specify PlaceID and content options as arguments (read more about controlled plugins).

pluginRegistry — plugin registry which you could use to find a certain instance of your plugin.

Feedback, feature-requests and bug-reports

There is a dedicated tag in YouTrack: SakuraUI-plugin. Using the Fix Version property you can filter the tasks, which are going to be released in the next Major / Minor version of TeamCity.