@orchesty/connector-nutshell 1.0.0

package/src/Connector/NutshellNewTaskConnector.ts

@@ -0,0 +1,107 @@
+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';
+import crypto from 'crypto';
+
+export const NAME = 'nutshell-new-task-connector';
+
+export default class NutshellNewTaskConnector extends AConnector {
+
+    public getName(): string {
+        return NAME;
+    }
+
+    public async processAction(dto: ProcessDto<IInput>): Promise<ProcessDto<IOutput>> {
+        const appInstall = await this.getApplicationInstallFromProcess(dto);
+
+        const data = {
+            jsonrpc: '2.0',
+            method: 'newTask',
+            params: dto.getJsonData(),
+            id: crypto.randomBytes(4).toString('hex'),
+        };
+        const req = await this.getApplication().getRequestDto(
+            dto,
+            appInstall,
+            HttpMethods.POST,
+            undefined,
+            data,
+        );
+
+        const resp = await this.getSender().send<IResponse>(req, [200]);
+        const response = resp.getJsonBody();
+
+        return dto.setNewJsonData(response.result);
+    }
+
+}
+
+interface IResponse {
+    result: IOutput;
+    id: string;
+    jsonrpc: string;
+}
+
+export interface IOutput {
+    title: string;
+    id: number;
+    entityType: string;
+    rev: string;
+    createdTime: string;
+    description: string;
+    dueTime: string;
+    completedTime: null;
+    completedUser: null;
+    assignee: {
+        stub: boolean;
+        id: number;
+        rev: string;
+        entityType: string;
+        modifiedTime: string;
+        createdTime: string;
+        name: string;
+        emails: string[];
+        isEnabled: boolean;
+        isAdministrator: boolean;
+    };
+    entity: {
+        stub: boolean;
+        id: number;
+        rev: string;
+        entityType: string;
+        modifiedTime: string;
+        createdTime: string;
+        name: string;
+        regions: string[];
+    };
+    creator: {
+        stub: boolean;
+        id: number;
+        rev: string;
+        entityType: string;
+        modifiedTime: string;
+        createdTime: string;
+        name: string;
+        emails: string[];
+        isEnabled: boolean;
+        isAdministrator: boolean;
+    };
+
+}
+
+export interface IInput {
+    task: {
+        title: string;
+        description?: string;
+        dueTime?: string;
+        assignee?: {
+            entityType?: string;
+            id?: number;
+        };
+        entity?: {
+            entityType?: string;
+            id?: number;
+        };
+    };
+
+}

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

@@ -0,0 +1,8 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {
+        "accountId": 116
+    }
+}

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

@@ -0,0 +1,37 @@
+{
+    "http": "POST https://app.nutshell.com/api/v1/json",
+    "code": 200,
+    "body": {
+        "result": {
+            "id": 116,
+            "entityType": "Accounts",
+            "rev": "0",
+            "modifiedTime": "2022-08-10T15:49:23+0000",
+            "createdTime": "2022-08-10T15:49:23+0000",
+            "name": "New Account Name",
+            "htmlUrl": "https:\/\/app.nutshell.com\/company\/116-new-account-name",
+            "htmlUrlPath": "\/company\/116-new-account-name",
+            "avatarUrl": "https:\/\/app.nutshell.com\/avatar\/accounts\/116\/346392\/K1K9OUzMRMiFaepwtAneseVXZs-THejW7xPt9zhTSDM.2\/1660146563",
+            "accountType": {
+                "id": 1,
+                "name": "Standard Account"
+            },
+            "industry": null,
+            "creator": null,
+            "owner": null,
+            "tags": [
+            ],
+            "lastContactedDate": null,
+            "contacts": [
+            ],
+            "description": null,
+            "legacyId": null,
+            "notes": [
+            ],
+            "leads": [
+            ]
+        },
+        "id": "apeye",
+        "jsonrpc": "2.0"
+    }
+}

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

@@ -0,0 +1,34 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {
+        "id": 116,
+        "entityType": "Accounts",
+        "rev": "0",
+        "modifiedTime": "2022-08-10T15:49:23+0000",
+        "createdTime": "2022-08-10T15:49:23+0000",
+        "name": "New Account Name",
+        "htmlUrl": "https:\/\/app.nutshell.com\/company\/116-new-account-name",
+        "htmlUrlPath": "\/company\/116-new-account-name",
+        "avatarUrl": "https:\/\/app.nutshell.com\/avatar\/accounts\/116\/346392\/K1K9OUzMRMiFaepwtAneseVXZs-THejW7xPt9zhTSDM.2\/1660146563",
+        "accountType": {
+            "id": 1,
+            "name": "Standard Account"
+        },
+        "industry": null,
+        "creator": null,
+        "owner": null,
+        "tags": [
+        ],
+        "lastContactedDate": null,
+        "contacts": [
+        ],
+        "description": null,
+        "legacyId": null,
+        "notes": [
+        ],
+        "leads": [
+        ]
+    }
+}

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

@@ -0,0 +1,10 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {
+        "account": {
+            "name": "New Account Name"
+        }
+    }
+}

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

@@ -0,0 +1,34 @@
+{
+    "http": "POST https://app.nutshell.com/api/v1/json",
+    "code": 200,
+    "body": {
+        "result": {
+            "accountType": {
+                "id": 1,
+                "name": "Standard Account"
+            },
+            "avatarUrl": "https://app.nutshell.com/avatar/accounts/116/346392/K1K9OUzMRMiFaepwtAneseVXZs-THejW7xPt9zhTSDM.2/1660146563",
+            "contacts": [],
+            "createdTime": "2022-08-10T15:49:23+0000",
+            "creator": null,
+            "description": null,
+            "entityType": "Accounts",
+            "htmlUrl": "https://app.nutshell.com/company/116-new-account-name",
+            "htmlUrlPath": "/company/116-new-account-name",
+            "id": 116,
+            "industry": null,
+            "lastContactedDate": null,
+            "leads": [],
+            "legacyId": null,
+            "modifiedTime": "2022-08-10T15:49:23+0000",
+            "name": "New Account Name",
+            "notes": [],
+            "owner": null,
+            "rev": "0",
+            "tags": []
+        },
+        "id": "apeye",
+        "jsonrpc": "2.0"
+    }
+}
+

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

@@ -0,0 +1,30 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {
+        "accountType": {
+            "id": 1,
+            "name": "Standard Account"
+        },
+        "avatarUrl": "https://app.nutshell.com/avatar/accounts/116/346392/K1K9OUzMRMiFaepwtAneseVXZs-THejW7xPt9zhTSDM.2/1660146563",
+        "contacts": [],
+        "createdTime": "2022-08-10T15:49:23+0000",
+        "creator": null,
+        "description": null,
+        "entityType": "Accounts",
+        "htmlUrl": "https://app.nutshell.com/company/116-new-account-name",
+        "htmlUrlPath": "/company/116-new-account-name",
+        "id": 116,
+        "industry": null,
+        "lastContactedDate": null,
+        "leads": [],
+        "legacyId": null,
+        "modifiedTime": "2022-08-10T15:49:23+0000",
+        "name": "New Account Name",
+        "notes": [],
+        "owner": null,
+        "rev": "0",
+        "tags": []
+    }
+}

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

@@ -0,0 +1,10 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {
+        "lead": {
+            "description": "A great new lead"
+        }
+    }
+}

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

@@ -0,0 +1,77 @@
+{
+    "http": "POST https://app.nutshell.com/api/v1/json",
+    "code": 200,
+    "body": {
+        "result": {
+            "id": 1004,
+            "entityType": "Leads",
+            "rev": "1",
+            "modifiedTime": "2022-08-10T16:18:05+0000",
+            "createdTime": "2022-08-10T16:18:05+0000",
+            "name": "Lead\u20131001",
+            "description": "A great new lead",
+            "htmlUrl": "https:\/\/app.nutshell.com\/lead\/1001",
+            "htmlUrlPath": "\/lead\/1001",
+            "avatarUrl": "https:\/\/app.nutshell.com\/avatar\/leads\/v1\/0\/1\/3\/0",
+            "creator": null,
+            "primaryAccount": null,
+            "milestone": {
+                "stub": true,
+                "id": 101,
+                "rev": "0",
+                "entityType": "Milestones",
+                "name": "Qualify"
+            },
+            "stageset": {
+                "stub": true,
+                "id": 1,
+                "entityType": "Stagesets",
+                "name": "Default Pipeline"
+            },
+            "activitiesCount": {
+                "0": 0,
+                "1": 0,
+                "2": 0,
+                "-1": 0
+            },
+            "status": 0,
+            "confidence": 25,
+            "completion": 0,
+            "urgency": "0",
+            "isOverdue": false,
+            "lastContactedDate": null,
+            "market": {
+                "stub": true,
+                "id": 1,
+                "rev": "0",
+                "entityType": "Markets",
+                "name": "U.S."
+            },
+            "assignee": null,
+            "sources": [],
+            "competitors": [],
+            "products": [],
+            "contacts": [],
+            "accounts": [],
+            "tags": [],
+            "priority": 0,
+            "processes": [
+                {
+                    "stub": true,
+                    "id": 8,
+                    "rev": "0",
+                    "entityType": "Processes",
+                    "name": "Default Pipeline",
+                    "type": "0",
+                    "startedTime": "2022-08-10T16:18:05+0000",
+                    "closedTime": null,
+                    "currentMilestoneId": "101",
+                    "processTemplateId": "1"
+                }
+            ],
+            "notes": []
+        },
+        "id": "7a21312a",
+        "jsonrpc": "2.0"
+    }
+}

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

@@ -0,0 +1,74 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {
+        "accounts": [],
+        "activitiesCount": {
+            "0": 0,
+            "1": 0,
+            "2": 0,
+            "-1": 0
+        },
+        "assignee": null,
+        "avatarUrl": "https://app.nutshell.com/avatar/leads/v1/0/1/3/0",
+        "competitors": [],
+        "completion": 0,
+        "confidence": 25,
+        "contacts": [],
+        "createdTime": "2022-08-10T16:18:05+0000",
+        "creator": null,
+        "description": "A great new lead",
+        "entityType": "Leads",
+        "htmlUrl": "https://app.nutshell.com/lead/1001",
+        "htmlUrlPath": "/lead/1001",
+        "id": 1004,
+        "isOverdue": false,
+        "lastContactedDate": null,
+        "market": {
+            "entityType": "Markets",
+            "id": 1,
+            "name": "U.S.",
+            "rev": "0",
+            "stub": true
+        },
+        "milestone": {
+            "entityType": "Milestones",
+            "id": 101,
+            "name": "Qualify",
+            "rev": "0",
+            "stub": true
+        },
+        "modifiedTime": "2022-08-10T16:18:05+0000",
+        "name": "Lead–1001",
+        "notes": [],
+        "primaryAccount": null,
+        "priority": 0,
+        "processes": [
+            {
+                "closedTime": null,
+                "currentMilestoneId": "101",
+                "entityType": "Processes",
+                "id": 8,
+                "name": "Default Pipeline",
+                "processTemplateId": "1",
+                "rev": "0",
+                "startedTime": "2022-08-10T16:18:05+0000",
+                "stub": true,
+                "type": "0"
+            }
+        ],
+        "products": [],
+        "rev": "1",
+        "sources": [],
+        "stageset": {
+            "entityType": "Stagesets",
+            "id": 1,
+            "name": "Default Pipeline",
+            "stub": true
+        },
+        "status": 0,
+        "tags": [],
+        "urgency": "0"
+    }
+}

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

@@ -0,0 +1,11 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {
+        "task": {
+            "title": "Send product sheet"
+        }
+    }
+}
+

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

@@ -0,0 +1,22 @@
+{
+    "http": "POST https://app.nutshell.com/api/v1/json",
+    "code": 200,
+    "body": {
+        "id": "c172cb2d",
+        "jsonrpc": "2.0",
+        "result": {
+            "assignee": null,
+            "completedTime": null,
+            "completedUser": null,
+            "createdTime": "2022-08-11T07:06:54+0000",
+            "creator": null,
+            "description": null,
+            "dueTime": "2022-08-12T15:00:00+0000",
+            "entity": null,
+            "entityType": "Tasks",
+            "id": 12,
+            "rev": "0",
+            "title": "Send product sheet"
+        }
+    }
+}

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

@@ -0,0 +1,19 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {
+        "assignee": null,
+        "completedTime": null,
+        "completedUser": null,
+        "createdTime": "2022-08-11T07:06:54+0000",
+        "creator": null,
+        "description": null,
+        "dueTime": "2022-08-12T15:00:00+0000",
+        "entity": null,
+        "entityType": "Tasks",
+        "id": 12,
+        "rev": "0",
+        "title": "Send product sheet"
+    }
+}

package/src/Connector/__tests__/NutshellGetAccountConnector.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 NUTSHELL_GET_ACCOUNT_CONNECTOR } from '../NutshellGetAccountConnector';
+
+let tester: NodeTester;
+
+describe('Tests for NutshellGetAccountConnector', () => {
+    beforeEach(() => {
+        tester = new NodeTester(container, __filename);
+        init();
+    });
+
+    it('process - ok', async () => {
+        await tester.testConnector(NUTSHELL_GET_ACCOUNT_CONNECTOR);
+    });
+});

package/src/Connector/__tests__/NutshellNewAccountConnector.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 NUTSHELL_NEW_ACCOUNT_CONNECTOR } from '../NutshellNewAccountConnector';
+
+let tester: NodeTester;
+
+describe('Tests for NutshellNewAccountConnector', () => {
+    beforeEach(() => {
+        tester = new NodeTester(container, __filename);
+        init();
+    });
+
+    it('process - ok', async () => {
+        await tester.testConnector(NUTSHELL_NEW_ACCOUNT_CONNECTOR);
+    });
+});

package/src/Connector/__tests__/NutshellNewLeadConnector.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 NUTSHELL_NEW_LEAD_CONNECTOR } from '../NutshellNewLeadConnector';
+
+let tester: NodeTester;
+
+describe('Tests for NutshellNewLeadConnector', () => {
+    beforeEach(() => {
+        tester = new NodeTester(container, __filename);
+        init();
+    });
+
+    it('process - ok', async () => {
+        await tester.testConnector(NUTSHELL_NEW_LEAD_CONNECTOR);
+    });
+});

package/src/Connector/__tests__/NutshellNewTaskConnector.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 NUTSHELL_NEW_TASK_CONNECTOR } from '../NutshellNewTaskConnector';
+
+let tester: NodeTester;
+
+describe('Tests for NutshellNewTaskConnector', () => {
+    beforeEach(() => {
+        tester = new NodeTester(container, __filename);
+        init();
+    });
+
+    it('process - ok', async () => {
+        await tester.testConnector(NUTSHELL_NEW_TASK_CONNECTOR);
+    });
+});

package/src/NutshellApplication.ts

@@ -0,0 +1,73 @@
+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,
+    PASSWORD,
+    USER,
+} 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 { encode } from '@orchesty/nodejs-sdk/dist/lib/Utils/Base64';
+import { CommonHeaders, JSON_TYPE } from '@orchesty/nodejs-sdk/dist/lib/Utils/Headers';
+
+export const NAME = 'nutshell';
+
+export default class NutshellApplication extends ABasicApplication {
+
+    public getDescription(): string {
+        return 'Affordable, easy-to-use CRM that helps small-business sales teams win more deals';
+    }
+
+    public getName(): string {
+        return NAME;
+    }
+
+    public getPublicName(): string {
+        return 'Nutshell';
+    }
+
+    public getLogo(): string {
+        return 'data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDI1LjAuMCwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IlZyc3R2YV8xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4PSIwcHgiIHk9IjBweCIKCSB2aWV3Qm94PSIwIDAgMTAwIDEwMCIgc3R5bGU9ImVuYWJsZS1iYWNrZ3JvdW5kOm5ldyAwIDAgMTAwIDEwMDsiIHhtbDpzcGFjZT0icHJlc2VydmUiPgo8c3R5bGUgdHlwZT0idGV4dC9jc3MiPgoJLnN0MHtmaWxsOiNGRTU4MDA7fQoJLnN0MXtmaWxsOiNGRkZGRkY7fQo8L3N0eWxlPgo8Zz4KCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik0wLjEsMC4xaDk5Ljd2OTkuN0gwLjFWMC4xeiIvPgoJPHBhdGggY2xhc3M9InN0MSIgZD0iTTU1LjUsMjkuMmMtMS4xLDAtMi0xLTEuOS0yLjFjMC0wLjEsMC0wLjIsMC0wLjNsMS40LTcuM2MwLTAuMSwwLTAuMiwwLTAuM2MwLTEuNS0yLjItMS43LTUtMS43cy01LDAuMi01LDEuNwoJCWMwLDAuMSwwLDAuMiwwLDAuM2wxLjQsNy4zYzAuMiwxLjEtMC41LDIuMi0xLjYsMi40Yy0wLjEsMC0wLjIsMC0wLjMsMGMtMTMuNCwwLjUtMjIuOSw0LjktMjIuOSwxMi45djMuMWMwLDAuOCwwLjcsMS41LDEuNSwxLjUKCQljMCwwLDAsMCwwLDBoMjQuNGMxLDAsMS41LDAuNywxLjUsMS41YzAsMC43LTAuNSwxLjMtMS4yLDEuNEwyOS43LDUzYy0wLjcsMC4xLTEuMiwwLjctMS4yLDEuNHY2LjJjMCwxMS45LDkuMywyMS45LDIxLjUsMjEuOQoJCWMxMS45LDAsMjEuNS05LjcsMjEuNS0yMS41di0xM2MwLTAuOCwwLjctMS40LDEuNC0xLjRjMCwwLDAsMCwwLDBoMy45YzAuOCwwLDEuNS0wLjcsMS41LTEuNWMwLDAsMCwwLDAsMHYtMy4xCgkJQzc4LjQsMzQsNjguOSwzMCw1NS41LDI5LjJMNTUuNSwyOS4yeiIvPgo8L2c+Cjwvc3ZnPgo=';
+    }
+
+    public getRequestDto(
+        dto: AProcessDto,
+        applicationInstall: ApplicationInstall,
+        method: HttpMethods,
+        url?: string,
+        data?: unknown,
+    ): Promise<RequestDto> | RequestDto {
+        const request = new RequestDto('https://app.nutshell.com/api/v1/json', method, dto);
+        request.setHeaders({
+            [CommonHeaders.CONTENT_TYPE]: JSON_TYPE,
+            [CommonHeaders.ACCEPT]: JSON_TYPE,
+            [CommonHeaders.AUTHORIZATION]: `Basic ${this.getToken(applicationInstall)}`,
+        });
+        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, USER, 'Username', undefined, true))
+            .addField(new Field(FieldType.TEXT, PASSWORD, 'API Key', undefined, true));
+
+        return new FormStack().addForm(form);
+    }
+
+    private getToken(applicationInstall: ApplicationInstall): string {
+        return encode(
+
+            `${applicationInstall.getSettings()[CoreFormsEnum.AUTHORIZATION_FORM][USER]}:${applicationInstall.getSettings()[CoreFormsEnum.AUTHORIZATION_FORM][PASSWORD]}`,
+        );
+    }
+
+}