@orchesty/connector-productboard 1.0.0

package/src/Batch/ProductboardListAllFeaturesBatch.ts

@@ -0,0 +1,72 @@
+import ABatchNode from '@orchesty/nodejs-sdk/dist/lib/Batch/ABatchNode';
+import { HttpMethods } from '@orchesty/nodejs-sdk/dist/lib/Transport/HttpMethods';
+import BatchProcessDto from '@orchesty/nodejs-sdk/dist/lib/Utils/BatchProcessDto';
+import { BASE_URL } from '../ProductboardApplication';
+
+export const NAME = 'productboard-list-all-features-batch';
+export default class ProductboardListAllFeaturesBatch extends ABatchNode {
+
+    public getName(): string {
+        return NAME;
+    }
+
+    public async processAction(dto: BatchProcessDto): Promise<BatchProcessDto> {
+        const appInstall = await this.getApplicationInstallFromProcess(dto);
+        const url = dto.getBatchCursor('features?pageLimit=100&pageOffset=0');
+        const req = await this.getApplication().getRequestDto(
+            dto,
+            appInstall,
+            HttpMethods.GET,
+            url,
+        );
+        const resp = await this.getSender().send<IResponse>(req, [200]);
+        const response = resp.getJsonBody();
+
+        dto.setItemList(response.data ?? []);
+        if (response.links.next) {
+            dto.setBatchCursor(response.links.next.replace(`${BASE_URL}/`, ''));
+        }
+
+        return dto;
+    }
+
+}
+
+interface IResponse {
+    data: IOutput[];
+    links: {
+        next: string;
+    };
+}
+
+export interface IOutput {
+    id: string;
+    name: string;
+    description: string;
+    type: string;
+    archived: boolean;
+    status: {
+        id: string;
+        name: string;
+    };
+    parent: {
+        feature: {
+            id: string;
+            links: {
+                self: string;
+            };
+        };
+    };
+    links: {
+        self: string;
+        html: string;
+    };
+    timeframe: {
+        startDate: string;
+        endDate: string;
+        granularity: string;
+    };
+    owner: {
+        email: string;
+    };
+}

package/src/Batch/ProductboardListAllProductsBatch.ts

@@ -0,0 +1,58 @@
+import ABatchNode from '@orchesty/nodejs-sdk/dist/lib/Batch/ABatchNode';
+import { HttpMethods } from '@orchesty/nodejs-sdk/dist/lib/Transport/HttpMethods';
+import BatchProcessDto from '@orchesty/nodejs-sdk/dist/lib/Utils/BatchProcessDto';
+import { BASE_URL } from '../ProductboardApplication';
+
+export const NAME = 'productboard-list-all-products-batch';
+export default class ProductboardListAllProductsBatch extends ABatchNode {
+
+    public getName(): string {
+        return NAME;
+    }
+
+    public async processAction(dto: BatchProcessDto): Promise<BatchProcessDto> {
+        const appInstall = await this.getApplicationInstallFromProcess(dto);
+        const url = dto.getBatchCursor('products?pageLimit=100&pageOffset=0');
+        const req = await this.getApplication().getRequestDto(
+            dto,
+            appInstall,
+            HttpMethods.GET,
+            url,
+        );
+        const resp = await this.getSender().send<IResponse>(req, [200]);
+        const response = resp.getJsonBody();
+
+        dto.setItemList(response.data ?? []);
+        if (response.links.next) {
+            dto.setBatchCursor(response.links.next.replace(`${BASE_URL}/`, ''));
+        }
+
+        return dto;
+    }
+
+}
+
+interface IResponse {
+    data: IOutput[];
+    links: {
+        next: string;
+    };
+}
+
+export interface IOutput {
+    data: {
+        id: string;
+        name: string;
+        description: string;
+        owner: {
+            email: string;
+        };
+        links: {
+            self: string;
+            html: string;
+        };
+    }[];
+    links: {
+        next: string;
+    };
+}

package/src/Batch/__tests__/Data/ProductboardListAllFeaturesBatch/input.json

@@ -0,0 +1,6 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {}
+}

package/src/Batch/__tests__/Data/ProductboardListAllFeaturesBatch/mock.json

@@ -0,0 +1,42 @@
+{
+    "http": "GET https://api.productboard.com/features?pageLimit=100&pageOffset=0",
+    "code": 200,
+    "body": {
+        "data": [
+            {
+                "id": "00000000-0000-0000-0000-000000000000",
+                "name": "Zlack Messaging App",
+                "description": "<p>Custom <s>branding</s> for the agent and user portals.</p>",
+                "type": "feature",
+                "archived": false,
+                "status": {
+                    "id": "00000000-0000-0000-0000-000000000000",
+                    "name": "In Progress"
+                },
+                "parent": {
+                    "feature": {
+                        "id": "00000000-0000-0000-0000-000000000000",
+                        "links": {
+                            "self": "https://api.productboard.com/features/00000000-0000-0000-0000-000000000000"
+                        }
+                    }
+                },
+                "links": {
+                    "self": "https://api.productboard.com/features/00000000-0000-0000-0000-000000000000",
+                    "html": "https://space.productboard.com/feature-board/planning/features/00000000-0000-0000-0000-000000000000"
+                },
+                "timeframe": {
+                    "startDate": "2021-01-01",
+                    "endDate": "2021-03-31",
+                    "granularity": "quarter"
+                },
+                "owner": {
+                    "email": "email@example.com"
+                }
+            }
+        ],
+        "links": {
+            "next": null
+        }
+    }
+}

package/src/Batch/__tests__/Data/ProductboardListAllFeaturesBatch/output.json

@@ -0,0 +1,11 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": [
+        {
+            "body": "{\"id\":\"00000000-0000-0000-0000-000000000000\",\"name\":\"Zlack Messaging App\",\"description\":\"<p>Custom <s>branding</s> for the agent and user portals.</p>\",\"type\":\"feature\",\"archived\":false,\"status\":{\"id\":\"00000000-0000-0000-0000-000000000000\",\"name\":\"In Progress\"},\"parent\":{\"feature\":{\"id\":\"00000000-0000-0000-0000-000000000000\",\"links\":{\"self\":\"https://api.productboard.com/features/00000000-0000-0000-0000-000000000000\"}}},\"links\":{\"self\":\"https://api.productboard.com/features/00000000-0000-0000-0000-000000000000\",\"html\":\"https://space.productboard.com/feature-board/planning/features/00000000-0000-0000-0000-000000000000\"},\"timeframe\":{\"startDate\":\"2021-01-01\",\"endDate\":\"2021-03-31\",\"granularity\":\"quarter\"},\"owner\":{\"email\":\"email@example.com\"}}",
+            "headers": {}
+        }
+    ]
+}

package/src/Batch/__tests__/Data/ProductboardListAllProductsBatch/input.json

@@ -0,0 +1,6 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {}
+}

package/src/Batch/__tests__/Data/ProductboardListAllProductsBatch/mock.json

@@ -0,0 +1,23 @@
+{
+    "http": "GET https://api.productboard.com/products?pageLimit=100&pageOffset=0",
+    "code": 200,
+    "body": {
+        "data": [
+            {
+                "id": "00000000-0000-0000-0000-000000000000",
+                "name": "Zlack Messaging App",
+                "description": "<p>Custom <s>branding</s> for the agent and user portals.</p>",
+                "owner": {
+                    "email": "email@example.com"
+                },
+                "links": {
+                    "self": "https://api.productboard.com/products/00000000-0000-0000-0000-000000000000",
+                    "html": "https://space.productboard.com/feature-board/planning/features/00000000-0000-0000-0000-000000000000"
+                }
+            }
+        ],
+        "links": {
+            "next": null
+        }
+    }
+}

package/src/Batch/__tests__/Data/ProductboardListAllProductsBatch/output.json

@@ -0,0 +1,11 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": [
+        {
+            "body": "{\"id\":\"00000000-0000-0000-0000-000000000000\",\"name\":\"Zlack Messaging App\",\"description\":\"<p>Custom <s>branding</s> for the agent and user portals.</p>\",\"owner\":{\"email\":\"email@example.com\"},\"links\":{\"self\":\"https://api.productboard.com/products/00000000-0000-0000-0000-000000000000\",\"html\":\"https://space.productboard.com/feature-board/planning/features/00000000-0000-0000-0000-000000000000\"}}",
+            "headers": {}
+        }
+    ]
+}

package/src/Batch/__tests__/ProductboardListAllFeaturesBatch.ts

@@ -0,0 +1,17 @@
+import { container } from '@orchesty/nodejs-connectors/test/TestAbstract';
+import NodeTester from '@orchesty/nodejs-sdk/dist/test/Testers/NodeTester';
+import init from '../../../test/dataProvider';
+import { NAME as PRODUCTBOARD_LIST_ALL_FEATURES_BATCH } from '../ProductboardListAllFeaturesBatch';
+
+let tester: NodeTester;
+
+describe('Tests for ProductboardListAllFeaturesBatch', () => {
+    beforeEach(() => {
+        tester = new NodeTester(container, __filename);
+        init();
+    });
+
+    it('process - ok', async () => {
+        await tester.testBatch(PRODUCTBOARD_LIST_ALL_FEATURES_BATCH);
+    });
+});

package/src/Batch/__tests__/ProductboardListAllProductsBatch.ts

@@ -0,0 +1,17 @@
+import { container } from '@orchesty/nodejs-connectors/test/TestAbstract';
+import NodeTester from '@orchesty/nodejs-sdk/dist/test/Testers/NodeTester';
+import init from '../../../test/dataProvider';
+import { NAME as PRODUCTBOARD_LIST_ALL_PRODUCTS_BATCH } from '../ProductboardListAllProductsBatch';
+
+let tester: NodeTester;
+
+describe('Tests for ProductboardListAllProductsBatch', () => {
+    beforeEach(() => {
+        tester = new NodeTester(container, __filename);
+        init();
+    });
+
+    it('process - ok', async () => {
+        await tester.testBatch(PRODUCTBOARD_LIST_ALL_PRODUCTS_BATCH);
+    });
+});

package/src/Connector/ProductboardCreateNewFeatureConnector.ts

@@ -0,0 +1,102 @@
+import AConnector from '@orchesty/nodejs-sdk/dist/lib/Connector/AConnector';
+import { HttpMethods } from '@orchesty/nodejs-sdk/dist/lib/Transport/HttpMethods';
+import ProcessDto from '@orchesty/nodejs-sdk/dist/lib/Utils/ProcessDto';
+
+export const NAME = 'productboard-create-new-feature-connector';
+
+export default class ProductboardCreateNewFeatureConnector extends AConnector {
+
+    public getName(): string {
+        return NAME;
+    }
+
+    public async processAction(dto: ProcessDto<IInput>): Promise<ProcessDto<IOutput>> {
+        const body = dto.getJsonData();
+
+        const appInstall = await this.getApplicationInstallFromProcess(dto);
+        const url = 'features';
+        const req = await this.getApplication().getRequestDto(dto, appInstall, HttpMethods.POST, url, body);
+        const resp = await this.getSender().send<IOutput>(req, [200]);
+
+        return dto.setNewJsonData(resp.getJsonBody());
+    }
+
+}
+
+export interface IInput {
+    data: {
+        name: string;
+        description: string;
+        type: 'feature' | 'subfeature';
+        status: {
+            id: string;
+            name: string;
+        };
+        parent: {
+            feature?: {
+                id: string;
+            };
+            product?: {
+                id: string;
+            };
+            component?: {
+                id: string;
+            };
+        };
+        archived: boolean;
+        timeframe: {
+            startDate: string;
+            endDate: string;
+            granularity: string;
+        };
+        owner?: {
+            email: string;
+        };
+    };
+}
+
+export interface IOutput {
+    data: {
+        id: string;
+        name: string;
+        description: string;
+        type: string;
+        archived: boolean;
+        status: {
+            id: string;
+            name: string;
+        };
+        parent: {
+            feature?: {
+                id: string;
+                links: {
+                    self: string;
+                };
+            };
+            product?: {
+                id: string;
+                links: {
+                    self: string;
+                };
+            };
+            component?: {
+                id: string;
+                links: {
+                    self: string;
+                };
+            };
+        };
+        links: {
+            self: string;
+            html: string;
+        };
+        timeframe: {
+            startDate: string;
+            endDate: string;
+            granularity: string;
+        };
+        owner?: {
+            email: string;
+        };
+    };
+}

package/src/Connector/__tests__/Data/ProductboardCreateNewFeatureConnector/input.json

@@ -0,0 +1,28 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {
+        "name": "Custom branding",
+        "description": "<p>Custom <s>branding</s> for the agent and user portals.</p>",
+        "type": "feature",
+        "status": {
+            "id": "00000000-0000-0000-0000-000000000000",
+            "name": "In Progress"
+        },
+        "parent": {
+            "feature": {
+                "id": "00000000-0000-0000-0000-000000000000"
+            }
+        },
+        "archived": false,
+        "timeframe": {
+            "startDate": "2021-01-01",
+            "endDate": "2021-03-31",
+            "granularity": "quarter"
+        },
+        "owner": {
+            "email": "email@example.com"
+        }
+    }
+}

package/src/Connector/__tests__/Data/ProductboardCreateNewFeatureConnector/mock.json

@@ -0,0 +1,35 @@
+{
+    "http": "POST https://api.productboard.com/features",
+    "code": 200,
+    "body": {
+        "id": "00000000-0000-0000-0000-000000000000",
+        "name": "Zlack Messaging App",
+        "description": "<p>Custom <s>branding</s> for the agent and user portals.</p>",
+        "type": "feature",
+        "archived": false,
+        "status": {
+            "id": "00000000-0000-0000-0000-000000000000",
+            "name": "In Progress"
+        },
+        "parent": {
+            "feature": {
+                "id": "00000000-0000-0000-0000-000000000000",
+                "links": {
+                    "self": "https://api.productboard.com/features/00000000-0000-0000-0000-000000000000"
+                }
+            }
+        },
+        "links": {
+            "self": "https://api.productboard.com/features/00000000-0000-0000-0000-000000000000",
+            "html": "https://space.productboard.com/feature-board/planning/features/00000000-0000-0000-0000-000000000000"
+        },
+        "timeframe": {
+            "startDate": "2021-01-01",
+            "endDate": "2021-03-31",
+            "granularity": "quarter"
+        },
+        "owner": {
+            "email": "email@example.com"
+        }
+    }
+}

package/src/Connector/__tests__/Data/ProductboardCreateNewFeatureConnector/output.json

@@ -0,0 +1,37 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {
+        "id": "00000000-0000-0000-0000-000000000000",
+        "name": "Zlack Messaging App",
+        "description": "<p>Custom <s>branding</s> for the agent and user portals.</p>",
+        "type": "feature",
+        "archived": false,
+        "status": {
+            "id": "00000000-0000-0000-0000-000000000000",
+            "name": "In Progress"
+        },
+        "parent": {
+            "feature": {
+                "id": "00000000-0000-0000-0000-000000000000",
+                "links": {
+                    "self": "https://api.productboard.com/features/00000000-0000-0000-0000-000000000000"
+                }
+            }
+        },
+        "links": {
+            "self": "https://api.productboard.com/features/00000000-0000-0000-0000-000000000000",
+            "html": "https://space.productboard.com/feature-board/planning/features/00000000-0000-0000-0000-000000000000"
+        },
+        "timeframe": {
+            "startDate": "2021-01-01",
+            "endDate": "2021-03-31",
+            "granularity": "quarter"
+        },
+        "owner": {
+            "email": "email@example.com"
+        }
+    }
+}
+

package/src/Connector/__tests__/ProductboardCreateNewFeatureConnector.ts

@@ -0,0 +1,17 @@
+import { container } from '@orchesty/nodejs-connectors/test/TestAbstract';
+import NodeTester from '@orchesty/nodejs-sdk/dist/test/Testers/NodeTester';
+import init from '../../../test/dataProvider';
+import { NAME as PRODUCTBOARD_CREATE_NEW_FEATURE_CONNECTOR } from '../ProductboardCreateNewFeatureConnector';
+
+let tester: NodeTester;
+
+describe('Tests for ProductboardCreateNewFeatureConnector', () => {
+    beforeEach(() => {
+        tester = new NodeTester(container, __filename);
+        init();
+    });
+
+    it('process - ok', async () => {
+        await tester.testConnector(PRODUCTBOARD_CREATE_NEW_FEATURE_CONNECTOR);
+    });
+});

package/src/ProductboardApplication.ts

@@ -0,0 +1,63 @@
+import CoreFormsEnum, { getFormName } from '@orchesty/nodejs-sdk/dist/lib/Application/Base/CoreFormsEnum';
+import { ApplicationInstall } from '@orchesty/nodejs-sdk/dist/lib/Application/Database/ApplicationInstall';
+import Field from '@orchesty/nodejs-sdk/dist/lib/Application/Model/Form/Field';
+import FieldType from '@orchesty/nodejs-sdk/dist/lib/Application/Model/Form/FieldType';
+import Form from '@orchesty/nodejs-sdk/dist/lib/Application/Model/Form/Form';
+import FormStack from '@orchesty/nodejs-sdk/dist/lib/Application/Model/Form/FormStack';
+import { ABasicApplication } from '@orchesty/nodejs-sdk/dist/lib/Authorization/Type/Basic/ABasicApplication';
+import RequestDto from '@orchesty/nodejs-sdk/dist/lib/Transport/Curl/RequestDto';
+import { HttpMethods } from '@orchesty/nodejs-sdk/dist/lib/Transport/HttpMethods';
+import AProcessDto from '@orchesty/nodejs-sdk/dist/lib/Utils/AProcessDto';
+import { CommonHeaders, JSON_TYPE } from '@orchesty/nodejs-sdk/dist/lib/Utils/Headers';
+
+export const NAME = 'productboard';
+export const TOKEN = 'token';
+export const BASE_URL = 'https://api.productboard.com';
+export default class ProductboardApplication extends ABasicApplication {
+
+    public getName(): string {
+        return NAME;
+    }
+
+    public getPublicName(): string {
+        return 'Productboard';
+    }
+
+    public getDescription(): string {
+        return 'Customer-driven product management system that empowers teams to get the right products to market, faster';
+    }
+
+    public getLogo(): string {
+        return 'data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDI1LjAuMCwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IlZyc3R2YV8xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4PSIwcHgiIHk9IjBweCIKCSB2aWV3Qm94PSIwIDAgMTAwIDEwMCIgc3R5bGU9ImVuYWJsZS1iYWNrZ3JvdW5kOm5ldyAwIDAgMTAwIDEwMDsiIHhtbDpzcGFjZT0icHJlc2VydmUiPgo8c3R5bGUgdHlwZT0idGV4dC9jc3MiPgoJLnN0MHtmaWxsOiNGRjI2Mzg7fQoJLnN0MXtmaWxsOiNGRkM2MDA7fQoJLnN0MntmaWxsOiMwMDc5RjI7fQo8L3N0eWxlPgo8Zz4KCTxwb2x5Z29uIGNsYXNzPSJzdDAiIHBvaW50cz0iMzMuMyw1MCA2Ni43LDgyLjggMCw4Mi44IAkiLz4KCTxwb2x5Z29uIGNsYXNzPSJzdDEiIHBvaW50cz0iMCwxNy4yIDMzLjMsNTAgNjYuNywxNy4yIAkiLz4KCTxwb2x5Z29uIGNsYXNzPSJzdDIiIHBvaW50cz0iMzMuMyw1MCA2Ni43LDgyLjggMTAwLDUwIDY2LjcsMTcuMiAJIi8+CjwvZz4KPC9zdmc+Cg==';
+    }
+
+    public getRequestDto(
+        dto: AProcessDto,
+        applicationInstall: ApplicationInstall,
+        method: HttpMethods,
+        _url?: string,
+        data?: unknown,
+    ): RequestDto {
+        const url = `${BASE_URL}/${_url}`;
+        const request = new RequestDto(url ?? '', method, dto);
+        request.setHeaders({
+            [CommonHeaders.CONTENT_TYPE]: JSON_TYPE,
+            [CommonHeaders.ACCEPT]: JSON_TYPE,
+            [CommonHeaders.AUTHORIZATION]: `Bearer ${applicationInstall.getSettings()[CoreFormsEnum.AUTHORIZATION_FORM][TOKEN]}`,
+        });
+
+        if (data) {
+            request.setJsonBody(data);
+        }
+
+        return request;
+    }
+
+    public getFormStack(): FormStack {
+        const form = new Form(CoreFormsEnum.AUTHORIZATION_FORM, getFormName(CoreFormsEnum.AUTHORIZATION_FORM))
+            .addField(new Field(FieldType.TEXT, TOKEN, ' Token', undefined, true));
+
+        return new FormStack().addForm(form);
+    }
+
+}

package/test/dataProvider.ts

@@ -0,0 +1,39 @@
+import { appInstall, DEFAULT_ACCESS_TOKEN, DEFAULT_USER } from '@orchesty/nodejs-connectors/test/DataProvider';
+import { container, db, sender } from '@orchesty/nodejs-connectors/test/TestAbstract';
+import CoreFormsEnum from '@orchesty/nodejs-sdk/dist/lib/Application/Base/CoreFormsEnum';
+import { TOKEN } from '@orchesty/nodejs-sdk/dist/lib/Authorization/Type/Basic/ABasicApplication';
+import ProductboardListAllFeaturesBatch from '../src/Batch/ProductboardListAllFeaturesBatch';
+import ProductboardListAllProductsBatch from '../src/Batch/ProductboardListAllProductsBatch';
+import ProductboardCreateNewFeatureConnector
+    from '../src/Connector/ProductboardCreateNewFeatureConnector';
+import ProductboardApplication, { NAME as PRODUCTBOARD_APP } from '../src/ProductboardApplication';
+
+export default function init(): void {
+    appInstall(PRODUCTBOARD_APP, DEFAULT_USER, {
+        [CoreFormsEnum.AUTHORIZATION_FORM]: {
+            [TOKEN]: DEFAULT_ACCESS_TOKEN,
+        },
+    });
+    const app = new ProductboardApplication();
+    container.setApplication(app);
+
+    const listAllFeatures = new ProductboardListAllFeaturesBatch();
+    const listAllProducts = new ProductboardListAllProductsBatch();
+    const createNewFeature = new ProductboardCreateNewFeatureConnector();
+
+    listAllFeatures
+        .setSender(sender)
+        .setDb(db)
+        .setApplication(app);
+    container.setBatch(listAllFeatures);
+    listAllProducts
+        .setSender(sender)
+        .setDb(db)
+        .setApplication(app);
+    container.setBatch(listAllProducts);
+    createNewFeature
+        .setSender(sender)
+        .setDb(db)
+        .setApplication(app);
+    container.setConnector(createNewFeature);
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "composite": true
+  },
+  "include": ["src", "test", "../../test"]
+}

package/tsconfig.prod.json

@@ -0,0 +1,13 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "rootDir": "./src",
+    },
+    "include": [
+        "src",
+    ],
+    "exclude": [
+        "node_modules",
+        "src/**/__tests__",
+    ]
+}