@edicarlos.lds/businessmap-mcp 2.3.0 → 3.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CONTRIBUTING.md +73 -0
- package/README.md +24 -4
- package/SECURITY.md +36 -0
- package/dist/client/businessmap-client.d.ts +17 -100
- package/dist/client/businessmap-client.d.ts.map +1 -1
- package/dist/client/businessmap-client.js +63 -283
- package/dist/client/businessmap-client.js.map +1 -1
- package/dist/client/businessmap-error.d.ts +16 -0
- package/dist/client/businessmap-error.d.ts.map +1 -0
- package/dist/client/businessmap-error.js +43 -0
- package/dist/client/businessmap-error.js.map +1 -0
- package/dist/client/modules/board-client.d.ts.map +1 -1
- package/dist/client/modules/board-client.js +16 -2
- package/dist/client/modules/board-client.js.map +1 -1
- package/dist/client/modules/card-client.d.ts +19 -5
- package/dist/client/modules/card-client.d.ts.map +1 -1
- package/dist/client/modules/card-client.js +61 -13
- package/dist/client/modules/card-client.js.map +1 -1
- package/dist/client/modules/custom-field-client.js +1 -1
- package/dist/client/modules/custom-field-client.js.map +1 -1
- package/dist/client/modules/doc-client.d.ts +44 -0
- package/dist/client/modules/doc-client.d.ts.map +1 -0
- package/dist/client/modules/doc-client.js +73 -0
- package/dist/client/modules/doc-client.js.map +1 -0
- package/dist/client/modules/index.d.ts +1 -0
- package/dist/client/modules/index.d.ts.map +1 -1
- package/dist/client/modules/index.js +1 -0
- package/dist/client/modules/index.js.map +1 -1
- package/dist/config/environment.d.ts +3 -0
- package/dist/config/environment.d.ts.map +1 -1
- package/dist/config/environment.js +60 -1
- package/dist/config/environment.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +19 -9
- package/dist/index.js.map +1 -1
- package/dist/schemas/card-schemas.d.ts +111 -85
- package/dist/schemas/card-schemas.d.ts.map +1 -1
- package/dist/schemas/card-schemas.js +39 -162
- package/dist/schemas/card-schemas.js.map +1 -1
- package/dist/schemas/common-schemas.d.ts +10 -4
- package/dist/schemas/common-schemas.d.ts.map +1 -1
- package/dist/schemas/common-schemas.js +25 -0
- package/dist/schemas/common-schemas.js.map +1 -1
- package/dist/schemas/doc-schemas.d.ts +176 -0
- package/dist/schemas/doc-schemas.d.ts.map +1 -0
- package/dist/schemas/doc-schemas.js +141 -0
- package/dist/schemas/doc-schemas.js.map +1 -0
- package/dist/schemas/index.d.ts +1 -0
- package/dist/schemas/index.d.ts.map +1 -1
- package/dist/schemas/index.js +1 -0
- package/dist/schemas/index.js.map +1 -1
- package/dist/schemas/setup-schemas.d.ts +418 -0
- package/dist/schemas/setup-schemas.d.ts.map +1 -1
- package/dist/schemas/setup-schemas.js +30 -7
- package/dist/schemas/setup-schemas.js.map +1 -1
- package/dist/schemas/workspace-schemas.d.ts +3 -0
- package/dist/schemas/workspace-schemas.d.ts.map +1 -1
- package/dist/schemas/workspace-schemas.js +6 -0
- package/dist/schemas/workspace-schemas.js.map +1 -1
- package/dist/server/http.d.ts +7 -1
- package/dist/server/http.d.ts.map +1 -1
- package/dist/server/http.js +140 -31
- package/dist/server/http.js.map +1 -1
- package/dist/server/mcp-server.d.ts.map +1 -1
- package/dist/server/mcp-server.js +2 -1
- package/dist/server/mcp-server.js.map +1 -1
- package/dist/server/resources/board-resources.js +2 -2
- package/dist/server/resources/board-resources.js.map +1 -1
- package/dist/server/resources/card-resources.d.ts.map +1 -1
- package/dist/server/resources/card-resources.js +26 -2
- package/dist/server/resources/card-resources.js.map +1 -1
- package/dist/server/resources/workspace-resources.js +1 -1
- package/dist/server/resources/workspace-resources.js.map +1 -1
- package/dist/server/tools/base-tool.d.ts +39 -0
- package/dist/server/tools/base-tool.d.ts.map +1 -1
- package/dist/server/tools/base-tool.js +130 -0
- package/dist/server/tools/base-tool.js.map +1 -1
- package/dist/server/tools/board-tools.d.ts +0 -13
- package/dist/server/tools/board-tools.d.ts.map +1 -1
- package/dist/server/tools/board-tools.js +168 -257
- package/dist/server/tools/board-tools.js.map +1 -1
- package/dist/server/tools/card-tools.d.ts +6 -42
- package/dist/server/tools/card-tools.d.ts.map +1 -1
- package/dist/server/tools/card-tools.js +506 -702
- package/dist/server/tools/card-tools.js.map +1 -1
- package/dist/server/tools/custom-field-tools.d.ts +1 -2
- package/dist/server/tools/custom-field-tools.d.ts.map +1 -1
- package/dist/server/tools/custom-field-tools.js +8 -16
- package/dist/server/tools/custom-field-tools.js.map +1 -1
- package/dist/server/tools/doc-tools.d.ts +15 -0
- package/dist/server/tools/doc-tools.d.ts.map +1 -0
- package/dist/server/tools/doc-tools.js +307 -0
- package/dist/server/tools/doc-tools.js.map +1 -0
- package/dist/server/tools/index.d.ts +1 -0
- package/dist/server/tools/index.d.ts.map +1 -1
- package/dist/server/tools/index.js +1 -0
- package/dist/server/tools/index.js.map +1 -1
- package/dist/server/tools/setup-tools.d.ts +13 -2
- package/dist/server/tools/setup-tools.d.ts.map +1 -1
- package/dist/server/tools/setup-tools.js +145 -96
- package/dist/server/tools/setup-tools.js.map +1 -1
- package/dist/server/tools/user-tools.d.ts +0 -4
- package/dist/server/tools/user-tools.d.ts.map +1 -1
- package/dist/server/tools/user-tools.js +36 -65
- package/dist/server/tools/user-tools.js.map +1 -1
- package/dist/server/tools/utility-tools.d.ts +0 -2
- package/dist/server/tools/utility-tools.d.ts.map +1 -1
- package/dist/server/tools/utility-tools.js +15 -28
- package/dist/server/tools/utility-tools.js.map +1 -1
- package/dist/server/tools/workflow-tools.d.ts +0 -8
- package/dist/server/tools/workflow-tools.d.ts.map +1 -1
- package/dist/server/tools/workflow-tools.js +84 -139
- package/dist/server/tools/workflow-tools.js.map +1 -1
- package/dist/server/tools/workspace-tools.d.ts +0 -4
- package/dist/server/tools/workspace-tools.d.ts.map +1 -1
- package/dist/server/tools/workspace-tools.js +35 -65
- package/dist/server/tools/workspace-tools.js.map +1 -1
- package/dist/types/base.d.ts +1 -0
- package/dist/types/base.d.ts.map +1 -1
- package/dist/types/card.d.ts +21 -5
- package/dist/types/card.d.ts.map +1 -1
- package/dist/types/doc.d.ts +96 -0
- package/dist/types/doc.d.ts.map +1 -0
- package/dist/types/doc.js +3 -0
- package/dist/types/doc.js.map +1 -0
- package/dist/types/index.d.ts +1 -0
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/index.js +1 -0
- package/dist/types/index.js.map +1 -1
- package/dist/types/workspace.d.ts +1 -0
- package/dist/types/workspace.d.ts.map +1 -1
- package/dist/utils/logger.d.ts +7 -12
- package/dist/utils/logger.d.ts.map +1 -1
- package/dist/utils/logger.js +73 -10
- package/dist/utils/logger.js.map +1 -1
- package/dist/utils/request-context.d.ts +7 -0
- package/dist/utils/request-context.d.ts.map +1 -0
- package/dist/utils/request-context.js +9 -0
- package/dist/utils/request-context.js.map +1 -0
- package/docs/LOGGING.md +15 -0
- package/docs/MIDDLEWARE.md +26 -4
- package/docs/TOOLS.md +43 -8
- package/package.json +4 -1
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
Thank you for helping improve BusinessMap MCP.
|
|
4
|
+
|
|
5
|
+
## Local setup
|
|
6
|
+
|
|
7
|
+
Requirements:
|
|
8
|
+
|
|
9
|
+
- Node.js 18 or newer
|
|
10
|
+
- npm
|
|
11
|
+
|
|
12
|
+
Install dependencies:
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm ci
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Most development checks do not need BusinessMap credentials:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npm run lint
|
|
22
|
+
npm test -- --runInBand
|
|
23
|
+
npm run build
|
|
24
|
+
npm run knip
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Run `npm run test:coverage` when changing core client, transport, or tool
|
|
28
|
+
registration behavior. The coverage thresholds are intentionally incremental
|
|
29
|
+
and must not regress.
|
|
30
|
+
|
|
31
|
+
The API-backed smoke tests are optional for contributors and require
|
|
32
|
+
`BUSINESSMAP_API_URL` and `BUSINESSMAP_API_TOKEN`:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npm run test:npx
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Never commit `.env` files or API tokens.
|
|
39
|
+
|
|
40
|
+
## Project structure
|
|
41
|
+
|
|
42
|
+
- `src/client/`: BusinessMap HTTP client and domain modules
|
|
43
|
+
- `src/schemas/`: Zod input schemas for MCP tools
|
|
44
|
+
- `src/server/tools/`: MCP tool registration and handlers
|
|
45
|
+
- `src/server/resources/`: MCP resources
|
|
46
|
+
- `src/server/prompts/`: guided MCP prompts
|
|
47
|
+
- `src/config/`: runtime configuration
|
|
48
|
+
- `docs/`: user and maintainer documentation
|
|
49
|
+
|
|
50
|
+
## Pull requests
|
|
51
|
+
|
|
52
|
+
Keep changes focused and include tests for behavior changes. Before opening a
|
|
53
|
+
pull request, run the local checks listed above. CI runs the same checks on
|
|
54
|
+
Node.js 18 and 22.
|
|
55
|
+
|
|
56
|
+
Use conventional commits when practical:
|
|
57
|
+
|
|
58
|
+
```text
|
|
59
|
+
feat: add a new capability
|
|
60
|
+
fix: correct existing behavior
|
|
61
|
+
docs: improve documentation
|
|
62
|
+
refactor: restructure without changing behavior
|
|
63
|
+
test: add or improve tests
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Changes to tool names, input schemas, response shapes, or default behavior must
|
|
67
|
+
remain backward compatible unless the pull request explicitly targets a major
|
|
68
|
+
release.
|
|
69
|
+
|
|
70
|
+
## Reporting security issues
|
|
71
|
+
|
|
72
|
+
Do not open a public issue for a suspected vulnerability. Follow the private
|
|
73
|
+
reporting process in [SECURITY.md](SECURITY.md).
|
package/README.md
CHANGED
|
@@ -13,8 +13,8 @@ Model Context Protocol (MCP) server for BusinessMap/Kanbanize. It gives AI clien
|
|
|
13
13
|
|
|
14
14
|
## What You Get
|
|
15
15
|
|
|
16
|
-
-
|
|
17
|
-
-
|
|
16
|
+
- Up to 92 MCP tools for workspaces, boards, cards, docs, users, custom fields, workflow management, batch board setup, and health checks
|
|
17
|
+
- 6 MCP resources for direct workspace, board, and paginated card reads
|
|
18
18
|
- 4 guided prompts for board analysis, reporting, card creation, and workspace summaries
|
|
19
19
|
- Optional read-only mode for safer exploration
|
|
20
20
|
- `stdio` transport for local MCP clients and HTTP transport for remote usage
|
|
@@ -54,11 +54,16 @@ Optional settings:
|
|
|
54
54
|
| --- | --- | --- |
|
|
55
55
|
| `BUSINESSMAP_READ_ONLY_MODE` | `false` | Use `true` to register only read-only tools. |
|
|
56
56
|
| `BUSINESSMAP_DEFAULT_WORKSPACE_ID` | unset | Default workspace ID for tools that can use one. |
|
|
57
|
+
| `BUSINESSMAP_TOOL_PROFILE` | `full` | Use `essential` for a smaller, general-purpose tool catalog. |
|
|
57
58
|
| `LOG_LEVEL` | `1` | `0` debug, `1` info, `2` warn, `3` error, `4` none. |
|
|
59
|
+
| `LOG_FORMAT` | `text` | Use `json` for structured logs. |
|
|
58
60
|
| `TRANSPORT` | `stdio` | Use `stdio` or `http`. |
|
|
59
61
|
| `PORT` | `3000` | HTTP server port. |
|
|
60
62
|
| `ALLOWED_ORIGINS` | `http://localhost` | CORS allowlist for HTTP mode. |
|
|
61
63
|
| `ALLOWED_HOSTS` | unset | Host header allowlist for HTTP mode. |
|
|
64
|
+
| `HTTP_BODY_LIMIT` | `1mb` | Maximum JSON request body size (`b`, `kb`, or `mb`). |
|
|
65
|
+
| `HTTP_MAX_SESSIONS` | `100` | Maximum concurrent initialized HTTP sessions. |
|
|
66
|
+
| `HTTP_SESSION_TIMEOUT_MS` | `1800000` | Idle session timeout in milliseconds. |
|
|
62
67
|
|
|
63
68
|
## MCP Client Setup
|
|
64
69
|
|
|
@@ -85,6 +90,11 @@ Client-specific examples for Claude Desktop, Claude Code, Cursor, VS Code, Winds
|
|
|
85
90
|
|
|
86
91
|
Use HTTP mode when deploying the server remotely or when your client supports Streamable HTTP:
|
|
87
92
|
|
|
93
|
+
> **Security:** The HTTP transport does not enable authentication by default.
|
|
94
|
+
> Do not expose it publicly without TLS, authentication, authorization, and
|
|
95
|
+
> rate limiting. See [Programmatic middleware](docs/MIDDLEWARE.md) and
|
|
96
|
+
> [Security Policy](SECURITY.md).
|
|
97
|
+
|
|
88
98
|
```bash
|
|
89
99
|
TRANSPORT=http \
|
|
90
100
|
PORT=3000 \
|
|
@@ -99,6 +109,10 @@ Configure your MCP client with:
|
|
|
99
109
|
http://your-server:3000/mcp
|
|
100
110
|
```
|
|
101
111
|
|
|
112
|
+
Use `/health` for liveness and `/ready` for readiness. The server stops
|
|
113
|
+
accepting new sessions when capacity is exhausted and closes active sessions
|
|
114
|
+
gracefully on `SIGINT` or `SIGTERM`.
|
|
115
|
+
|
|
102
116
|
For custom authentication, authorization, logging, or rate limiting, see [docs/MIDDLEWARE.md](docs/MIDDLEWARE.md).
|
|
103
117
|
|
|
104
118
|
## Local Development
|
|
@@ -173,6 +187,8 @@ Logging details are documented in [docs/LOGGING.md](docs/LOGGING.md).
|
|
|
173
187
|
|
|
174
188
|
## Contributing
|
|
175
189
|
|
|
190
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md) for local setup, project structure, and pull request guidance.
|
|
191
|
+
|
|
176
192
|
Use conventional commits when possible:
|
|
177
193
|
|
|
178
194
|
```bash
|
|
@@ -185,10 +201,14 @@ refactor: improve code structure
|
|
|
185
201
|
Before opening a pull request:
|
|
186
202
|
|
|
187
203
|
```bash
|
|
188
|
-
npm
|
|
189
|
-
npm
|
|
204
|
+
npm run lint
|
|
205
|
+
npm test -- --runInBand
|
|
206
|
+
npm run build
|
|
207
|
+
npm run knip
|
|
190
208
|
```
|
|
191
209
|
|
|
210
|
+
`npm run test:npx` is an optional API-backed smoke test and requires BusinessMap credentials.
|
|
211
|
+
|
|
192
212
|
## Support
|
|
193
213
|
|
|
194
214
|
For issues and questions:
|
package/SECURITY.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Supported versions
|
|
4
|
+
|
|
5
|
+
Security fixes are provided for the latest published major version. Users
|
|
6
|
+
should upgrade to the latest available release before reporting an issue.
|
|
7
|
+
|
|
8
|
+
## Reporting a vulnerability
|
|
9
|
+
|
|
10
|
+
Please use GitHub private vulnerability reporting for this repository:
|
|
11
|
+
|
|
12
|
+
1. Open the repository's **Security** tab.
|
|
13
|
+
2. Select **Report a vulnerability**.
|
|
14
|
+
3. Include affected versions, reproduction steps, impact, and any suggested
|
|
15
|
+
mitigation.
|
|
16
|
+
|
|
17
|
+
If private reporting is unavailable, contact the maintainer using the address
|
|
18
|
+
listed in `package.json`. Do not include active API tokens, customer data, or
|
|
19
|
+
other secrets in the report.
|
|
20
|
+
|
|
21
|
+
Please allow reasonable time for investigation and remediation before public
|
|
22
|
+
disclosure.
|
|
23
|
+
|
|
24
|
+
## Deployment guidance
|
|
25
|
+
|
|
26
|
+
- Prefer `BUSINESSMAP_READ_ONLY_MODE=true` unless write operations are required.
|
|
27
|
+
- Use a dedicated BusinessMap token with the minimum necessary permissions.
|
|
28
|
+
- Never commit tokens or `.env` files.
|
|
29
|
+
- Rotate a token immediately if it may have been exposed.
|
|
30
|
+
- Treat the HTTP transport as an internal service unless authentication,
|
|
31
|
+
authorization, TLS, and rate limiting are configured.
|
|
32
|
+
- Restrict `ALLOWED_ORIGINS` and `ALLOWED_HOSTS` to known clients.
|
|
33
|
+
- Keep the package and container image updated.
|
|
34
|
+
|
|
35
|
+
The built-in read-only mode and network allowlists are defense-in-depth
|
|
36
|
+
controls; they do not replace authentication for remotely accessible servers.
|
|
@@ -1,17 +1,24 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
|
|
1
|
+
import { BoardClient, CardClient, CustomFieldClient, DocClient, UserClient, UtilityClient, WorkflowClient, WorkspaceClient } from './modules/index.js';
|
|
2
|
+
import { BusinessMapConfig } from '../types/index.js';
|
|
3
|
+
/**
|
|
4
|
+
* BusinessMap API client, organized in domain modules.
|
|
5
|
+
* Access the API through the public module properties, e.g.:
|
|
6
|
+
* client.cards.getCard(id)
|
|
7
|
+
* client.boards.getColumns(boardId)
|
|
8
|
+
* client.docs.getDocs()
|
|
9
|
+
*/
|
|
4
10
|
export declare class BusinessMapClient {
|
|
5
11
|
private readonly http;
|
|
6
12
|
private readonly config;
|
|
7
13
|
private isInitialized;
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
14
|
+
readonly workspaces: WorkspaceClient;
|
|
15
|
+
readonly boards: BoardClient;
|
|
16
|
+
readonly cards: CardClient;
|
|
17
|
+
readonly users: UserClient;
|
|
18
|
+
readonly customFields: CustomFieldClient;
|
|
19
|
+
readonly docs: DocClient;
|
|
20
|
+
readonly utility: UtilityClient;
|
|
21
|
+
readonly workflows: WorkflowClient;
|
|
15
22
|
constructor(config: BusinessMapConfig);
|
|
16
23
|
/**
|
|
17
24
|
* Initialize the client by verifying the connection to the BusinessMap API
|
|
@@ -21,95 +28,5 @@ export declare class BusinessMapClient {
|
|
|
21
28
|
* Check if the client has been initialized
|
|
22
29
|
*/
|
|
23
30
|
get initialized(): boolean;
|
|
24
|
-
private transformError;
|
|
25
|
-
getWorkspaces(): Promise<import("../types/workspace.js").Workspace[]>;
|
|
26
|
-
getWorkspace(workspaceId: number): Promise<import("../types/workspace.js").Workspace>;
|
|
27
|
-
createWorkspace(params: Parameters<WorkspaceClient['createWorkspace']>[0]): Promise<import("../types/workspace.js").Workspace>;
|
|
28
|
-
updateWorkspace(workspaceId: number, params: Parameters<WorkspaceClient['updateWorkspace']>[1]): Promise<import("../types/workspace.js").Workspace>;
|
|
29
|
-
deleteWorkspace(workspaceId: number): Promise<void>;
|
|
30
|
-
getBoards(filters?: BoardFilters): Promise<import("../types/board.js").Board[]>;
|
|
31
|
-
getBoard(boardId: number): Promise<import("../types/board.js").Board>;
|
|
32
|
-
createBoard(params: Parameters<BoardClient['createBoard']>[0]): Promise<import("../types/board.js").Board>;
|
|
33
|
-
updateBoard(boardId: number, params: Parameters<BoardClient['updateBoard']>[1]): Promise<import("../types/board.js").Board>;
|
|
34
|
-
deleteBoard(boardId: number): Promise<void>;
|
|
35
|
-
getBoardStructure(boardId: number): Promise<any>;
|
|
36
|
-
getColumns(boardId: number): Promise<import("../types/board.js").Column[]>;
|
|
37
|
-
getLanes(boardId: number): Promise<import("../types/lane.js").Lane[]>;
|
|
38
|
-
getLane(boardId: number, laneId: number): Promise<import("../types/lane.js").Lane>;
|
|
39
|
-
createLane(boardId: number, params: Parameters<BoardClient['createLane']>[1]): Promise<import("../types/lane.js").Lane>;
|
|
40
|
-
updateLane(boardId: number, laneId: number, params: Parameters<BoardClient['updateLane']>[2]): Promise<import("../types/lane.js").Lane>;
|
|
41
|
-
getCurrentBoardStructure(boardId: number): Promise<import("../types/board.js").CurrentBoardStructure>;
|
|
42
|
-
createColumn(boardId: number, params: Parameters<BoardClient['createColumn']>[1]): Promise<import("../types/board.js").Column>;
|
|
43
|
-
updateColumn(boardId: number, columnId: number, params: Parameters<BoardClient['updateColumn']>[2]): Promise<import("../types/board.js").Column>;
|
|
44
|
-
deleteColumn(boardId: number, columnId: number): Promise<void>;
|
|
45
|
-
getCards(boardId: number, filters?: CardFilters): Promise<import("../types/card.js").Card[]>;
|
|
46
|
-
searchCards(filters?: Parameters<CardClient['searchCards']>[0]): Promise<import("../types/card.js").Card[] | {
|
|
47
|
-
pagination?: unknown;
|
|
48
|
-
data: import("../types/card.js").Card[];
|
|
49
|
-
}>;
|
|
50
|
-
getCardTransitions(cardId: number): Promise<import("../types/card.js").Card | undefined>;
|
|
51
|
-
getCardBlockTimes(cardId: number): Promise<import("../types/card.js").Card | undefined>;
|
|
52
|
-
getCardLoggedTimes(cardId: number, includeSubtasks?: boolean): Promise<import("../types/card.js").LoggedTime[]>;
|
|
53
|
-
getCard(cardId: number): Promise<import("../types/card.js").Card>;
|
|
54
|
-
createCard(params: Parameters<CardClient['createCard']>[0]): Promise<import("../types/card.js").Card>;
|
|
55
|
-
updateCard(params: Parameters<CardClient['updateCard']>[0]): Promise<import("../types/card.js").Card>;
|
|
56
|
-
moveCard(cardId: number, columnId: number, laneId?: number, position?: number): Promise<import("../types/card.js").Card>;
|
|
57
|
-
deleteCard(cardId: number): Promise<void>;
|
|
58
|
-
getCardComments(cardId: number): Promise<import("../types/card.js").Comment[]>;
|
|
59
|
-
getCardComment(cardId: number, commentId: number): Promise<import("../types/card.js").Comment>;
|
|
60
|
-
getCardCustomFields(cardId: number): Promise<import("../types/card.js").CardCustomField[]>;
|
|
61
|
-
getCardTypes(): Promise<import("../types/card.js").CardType[]>;
|
|
62
|
-
getCardHistory(cardId: number, outcomeId: number): Promise<import("../types/card.js").CardHistoryItem[]>;
|
|
63
|
-
getCardOutcomes(cardId: number): Promise<import("../types/card.js").Outcome[]>;
|
|
64
|
-
getCardLinkedCards(cardId: number): Promise<import("../types/card.js").LinkedCardItem[]>;
|
|
65
|
-
getCardSubtasks(cardId: number): Promise<import("../types/card.js").Subtask[]>;
|
|
66
|
-
getCardSubtask(cardId: number, subtaskId: number): Promise<import("../types/card.js").Subtask>;
|
|
67
|
-
createCardSubtask(cardId: number, params: Parameters<CardClient['createCardSubtask']>[1]): Promise<import("../types/card.js").Subtask>;
|
|
68
|
-
updateCardSubtask(cardId: number, subtaskId: number, params: Parameters<CardClient['updateCardSubtask']>[2]): Promise<import("../types/card.js").Subtask>;
|
|
69
|
-
deleteCardSubtask(cardId: number, subtaskId: number): Promise<void>;
|
|
70
|
-
getCardParents(cardId: number): Promise<import("../types/card.js").ParentCardItem[]>;
|
|
71
|
-
getCardParent(cardId: number, parentCardId: number): Promise<{
|
|
72
|
-
position: number;
|
|
73
|
-
}>;
|
|
74
|
-
addCardParent(cardId: number, parentCardId: number): Promise<{
|
|
75
|
-
position: number;
|
|
76
|
-
}>;
|
|
77
|
-
removeCardParent(cardId: number, parentCardId: number): Promise<void>;
|
|
78
|
-
getCardParentGraph(cardId: number): Promise<import("../types/card.js").ParentGraphItem[]>;
|
|
79
|
-
getCardChildren(cardId: number): Promise<import("../types/card.js").ChildCardItem[]>;
|
|
80
|
-
blockCard(cardId: number, reason: string): Promise<void>;
|
|
81
|
-
unblockCard(cardId: number): Promise<void>;
|
|
82
|
-
createCardComment(cardId: number, params: CreateCommentParams): Promise<import("../types/card.js").Comment>;
|
|
83
|
-
updateCardComment(cardId: number, commentId: number, params: UpdateCommentParams): Promise<import("../types/card.js").Comment>;
|
|
84
|
-
deleteCardComment(cardId: number, commentId: number): Promise<void>;
|
|
85
|
-
createTag(params: CreateTagParams): Promise<import("../types/card.js").Tag>;
|
|
86
|
-
addTagToCard(cardId: number, tagId: number): Promise<void>;
|
|
87
|
-
removeTagFromCard(cardId: number, tagId: number): Promise<void>;
|
|
88
|
-
addStickerToCard(cardId: number, stickerId: number): Promise<import("../types/card.js").CardStickerItem>;
|
|
89
|
-
removeStickerFromCard(cardId: number, stickerCardId: number): Promise<void>;
|
|
90
|
-
addPredecessor(cardId: number, predecessorCardId: number, params?: Parameters<CardClient['addPredecessor']>[2]): Promise<void>;
|
|
91
|
-
removePredecessor(cardId: number, predecessorCardId: number): Promise<void>;
|
|
92
|
-
getUsers(): Promise<import("../types/user.js").User[]>;
|
|
93
|
-
getUser(userId: number): Promise<import("../types/user.js").User>;
|
|
94
|
-
getCurrentUser(): Promise<import("../types/user.js").CurrentUser>;
|
|
95
|
-
inviteUser(params: Parameters<UserClient['inviteUser']>[0]): Promise<import("../types/user.js").InvitedUser>;
|
|
96
|
-
getCustomField(customFieldId: number): Promise<import("../types/custom-field.js").CustomField>;
|
|
97
|
-
getWorkflowCycleTimeColumns(boardId: number, workflowId: number): Promise<import("../types/workflow.js").WorkflowCycleTimeColumn[]>;
|
|
98
|
-
getWorkflowEffectiveCycleTimeColumns(boardId: number, workflowId: number): Promise<import("../types/workflow.js").WorkflowCycleTimeColumn[]>;
|
|
99
|
-
getWorkflows(boardId: number): Promise<import("../types/workflow.js").BoardWorkflow[]>;
|
|
100
|
-
getWorkflow(boardId: number, workflowId: number): Promise<import("../types/workflow.js").BoardWorkflow>;
|
|
101
|
-
createWorkflow(boardId: number, params: Parameters<WorkflowClient['createWorkflow']>[1]): Promise<import("../types/workflow.js").BoardWorkflow>;
|
|
102
|
-
updateWorkflow(boardId: number, workflowId: number, params: Parameters<WorkflowClient['updateWorkflow']>[2]): Promise<import("../types/workflow.js").BoardWorkflow>;
|
|
103
|
-
linkRelatedWorkflow(boardId: number, workflowId: number, position?: number): Promise<void>;
|
|
104
|
-
unlinkRelatedWorkflow(boardId: number, workflowId: number): Promise<void>;
|
|
105
|
-
healthCheck(): Promise<boolean>;
|
|
106
|
-
getApiInfo(): Promise<{
|
|
107
|
-
message: string;
|
|
108
|
-
endpoint: string;
|
|
109
|
-
status: string;
|
|
110
|
-
note: string;
|
|
111
|
-
api_version: string;
|
|
112
|
-
documentation: string;
|
|
113
|
-
}>;
|
|
114
31
|
}
|
|
115
32
|
//# sourceMappingURL=businessmap-client.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"businessmap-client.d.ts","sourceRoot":"","sources":["../../src/client/businessmap-client.ts"],"names":[],"mappings":"AACA,OAAO,
|
|
1
|
+
{"version":3,"file":"businessmap-client.d.ts","sourceRoot":"","sources":["../../src/client/businessmap-client.ts"],"names":[],"mappings":"AACA,OAAO,EACL,WAAW,EACX,UAAU,EACV,iBAAiB,EACjB,SAAS,EACT,UAAU,EACV,aAAa,EACb,cAAc,EACd,eAAe,EAChB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAKtD;;;;;;GAMG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAgB;IACrC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAoB;IAC3C,OAAO,CAAC,aAAa,CAAkB;IAGvC,QAAQ,CAAC,UAAU,kBAAyB;IAC5C,QAAQ,CAAC,MAAM,cAAqB;IACpC,QAAQ,CAAC,KAAK,aAAoB;IAClC,QAAQ,CAAC,KAAK,aAAoB;IAClC,QAAQ,CAAC,YAAY,oBAA2B;IAChD,QAAQ,CAAC,IAAI,YAAmB;IAChC,QAAQ,CAAC,OAAO,gBAAuB;IACvC,QAAQ,CAAC,SAAS,iBAAwB;gBAE9B,MAAM,EAAE,iBAAiB;IAgErC;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IA8CjC;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;CACF"}
|