@orchesty/connector-productboard 1.0.1 → 2.0.1
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/README.md +77 -0
- package/dist/package.json +2 -2
- package/package.json +6 -3
package/README.md
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# Productboard Connector
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@orchesty/connector-productboard)
|
|
4
|
+
[](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE)
|
|
5
|
+
|
|
6
|
+
An [Orchesty](https://orchesty.io) connector for Productboard, a customer-driven product management system that empowers teams to get the right products to market faster.
|
|
7
|
+
|
|
8
|
+
## Application Type
|
|
9
|
+
|
|
10
|
+
**Basic**
|
|
11
|
+
|
|
12
|
+
This connector authenticates using a personal API token sent as a Bearer token in the `Authorization` header.
|
|
13
|
+
|
|
14
|
+
| Field | Description |
|
|
15
|
+
|---|---|
|
|
16
|
+
| `token` | Your Productboard API access token |
|
|
17
|
+
|
|
18
|
+
## Components
|
|
19
|
+
|
|
20
|
+
| Class | Type | Description |
|
|
21
|
+
|---|---|---|
|
|
22
|
+
| `ProductboardCreateNewFeatureConnector` | Connector | Creates a new feature (or subfeature) via `POST /features` |
|
|
23
|
+
| `ProductboardListAllFeaturesBatch` | Batch | Paginates through all features (100 per page) via `GET /features` |
|
|
24
|
+
| `ProductboardListAllProductsBatch` | Batch | Paginates through all products (100 per page) via `GET /products` |
|
|
25
|
+
|
|
26
|
+
## Setup
|
|
27
|
+
|
|
28
|
+
### Credentials
|
|
29
|
+
|
|
30
|
+
1. Log in to [Productboard](https://app.productboard.com/).
|
|
31
|
+
2. Navigate to **Profile settings → API tokens** and create a new token.
|
|
32
|
+
3. Copy the token and paste it into the **Token** field in Orchesty.
|
|
33
|
+
|
|
34
|
+
### API Documentation
|
|
35
|
+
|
|
36
|
+
Productboard Public API: [https://developer.productboard.com/](https://developer.productboard.com/)
|
|
37
|
+
|
|
38
|
+
## Installation & Usage
|
|
39
|
+
|
|
40
|
+
Install the package:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npm install @orchesty/connector-productboard @orchesty/nodejs-sdk
|
|
44
|
+
# or
|
|
45
|
+
pnpm add @orchesty/connector-productboard @orchesty/nodejs-sdk
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Register the application and nodes in your Orchesty DI container:
|
|
49
|
+
|
|
50
|
+
```typescript
|
|
51
|
+
import { container } from '@orchesty/nodejs-sdk';
|
|
52
|
+
import ProductboardApplication from '@orchesty/connector-productboard/dist/ProductboardApplication';
|
|
53
|
+
import ProductboardCreateNewFeatureConnector from '@orchesty/connector-productboard/dist/Connector/ProductboardCreateNewFeatureConnector';
|
|
54
|
+
import ProductboardListAllFeaturesBatch from '@orchesty/connector-productboard/dist/Batch/ProductboardListAllFeaturesBatch';
|
|
55
|
+
import ProductboardListAllProductsBatch from '@orchesty/connector-productboard/dist/Batch/ProductboardListAllProductsBatch';
|
|
56
|
+
|
|
57
|
+
const app = new ProductboardApplication();
|
|
58
|
+
container.setApplication(app);
|
|
59
|
+
container.setNode(new ProductboardCreateNewFeatureConnector(), app);
|
|
60
|
+
container.setNode(new ProductboardListAllFeaturesBatch(), app);
|
|
61
|
+
container.setNode(new ProductboardListAllProductsBatch(), app);
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## License
|
|
65
|
+
|
|
66
|
+
This connector is released under the **Apache License 2.0**. See the [LICENSE](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE) file for the full license text.
|
|
67
|
+
|
|
68
|
+
## Contributing
|
|
69
|
+
|
|
70
|
+
Contributions are welcome! This connector is part of the open-source [Orchesty Node.js Connectors](https://github.com/Orchesty/orchesty-nodejs-connectors) monorepo.
|
|
71
|
+
|
|
72
|
+
For guidelines on how to create or update connectors — including project setup, coding conventions, and how to write tests — please refer to the **[Contributing to Connectors](https://orchesty.io/community/contributing-to-connectors)** guide.
|
|
73
|
+
|
|
74
|
+
All contributions should include:
|
|
75
|
+
- Source code in `src/` following the existing connector structure
|
|
76
|
+
- Tests in `src/**/__tests__/` with `input.json`, `mock.json`, and `output.json` fixtures
|
|
77
|
+
- An updated `CHANGELOG.md` entry
|
package/dist/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-productboard",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.0.0",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
7
|
"repository": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"keywords": [],
|
|
18
18
|
"author": "info@hanaboso.com",
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@orchesty/nodejs-sdk": "^
|
|
20
|
+
"@orchesty/nodejs-sdk": "^5.0.13"
|
|
21
21
|
},
|
|
22
22
|
"engines": {
|
|
23
23
|
"node": ">=24"
|
package/package.json
CHANGED
|
@@ -1,17 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-productboard",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.0.1",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
|
-
"repository":
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors"
|
|
10
|
+
},
|
|
8
11
|
"files": [
|
|
9
12
|
"dist"
|
|
10
13
|
],
|
|
11
14
|
"keywords": [],
|
|
12
15
|
"author": "info@hanaboso.com",
|
|
13
16
|
"dependencies": {
|
|
14
|
-
"@orchesty/nodejs-sdk": "^
|
|
17
|
+
"@orchesty/nodejs-sdk": "^5.0.13"
|
|
15
18
|
},
|
|
16
19
|
"engines": {
|
|
17
20
|
"node": ">=24"
|