@orchesty/connector-base 1.0.0

package/src/Connector/Orders.ts

@@ -0,0 +1,148 @@
+import ProcessDto from '@orchesty/nodejs-sdk/dist/lib/Utils/ProcessDto';
+import ABaseConnector from './ABaseConnector';
+
+export const NAME = 'orders';
+
+export default class Orders extends ABaseConnector<IInput, IOutput> {
+
+    public getName(): string {
+        return NAME;
+    }
+
+    protected getMethod(): string {
+        return 'getOrders';
+    }
+
+    // eslint-disable-next-line @typescript-eslint/require-await
+    protected async getParameters(dto: ProcessDto<IInput>): Promise<object> {
+        const {
+            orderId,
+            dateConfirmedFrom,
+            dateFrom,
+            idFrom,
+            getUnconfirmedOrders,
+            includeCustomExtraFields,
+            statusId,
+            filterEmail,
+            filterOrderSource,
+            filterOrderSourceId,
+            withCommission,
+        } = dto.getJsonData();
+
+        /* eslint-disable @typescript-eslint/naming-convention */
+        return {
+            order_id: orderId,
+            date_confirmed_from: dateConfirmedFrom,
+            date_from: dateFrom,
+            id_from: idFrom,
+            get_unconfirmed_orders: getUnconfirmedOrders,
+            include_custom_extra_fields: includeCustomExtraFields,
+            status_id: statusId,
+            filter_email: filterEmail,
+            filter_order_source: filterOrderSource,
+            filter_order_source_id: filterOrderSourceId,
+            with_commission: withCommission,
+        };
+        /* eslint-enable @typescript-eslint/naming-convention */
+    }
+
+}
+
+export interface IInput {
+    orderId?: number;
+    dateConfirmedFrom?: number;
+    dateFrom?: number;
+    idFrom?: number;
+    getUnconfirmedOrders?: boolean;
+    includeCustomExtraFields?: boolean;
+    statusId?: number;
+    filterEmail?: string;
+    filterOrderSource?: string;
+    filterOrderSourceId?: number;
+    withCommission?: boolean;
+}
+
+/* eslint-disable @typescript-eslint/naming-convention */
+export interface Order {
+    order_id: number;
+    shop_order_id: number;
+    external_order_id: string;
+    order_source: string;
+    order_source_id: number;
+    order_source_info: string;
+    order_status_id: number;
+    date_add: number;
+    date_confirmed: number;
+    date_in_status: number;
+    user_login: string;
+    phone: string;
+    email: string;
+    user_comments: string;
+    admin_comments: string;
+    currency: string;
+    payment_method: string;
+    payment_method_cod: string;
+    payment_done: string;
+    delivery_method: string;
+    delivery_price: number;
+    delivery_package_module: string;
+    delivery_package_nr: string;
+    delivery_fullname: string;
+    delivery_company: string;
+    delivery_address: string;
+    delivery_city: string;
+    delivery_state: string;
+    delivery_postcode: string;
+    delivery_country: string;
+    delivery_country_code: string;
+    delivery_point_id: string;
+    delivery_point_name: string;
+    delivery_point_address: string;
+    delivery_point_postcode: string;
+    delivery_point_city: string;
+    invoice_fullname: string;
+    invoice_company: string;
+    invoice_nip: string;
+    invoice_address: string;
+    invoice_city: string;
+    invoice_state: string;
+    invoice_postcode: string;
+    invoice_country: string;
+    invoice_country_code: string;
+    want_invoice: string;
+    extra_field_1: string;
+    extra_field_2: string;
+    custom_extra_fields: Record<string, string>;
+    order_page: string;
+    pick_status: string;
+    pack_status: string;
+    commission: {
+        net: number;
+        gross: number;
+        currency: string;
+    },
+    products:
+    {
+        storage: string;
+        storage_id: number;
+        order_product_id: number;
+        product_id: string;
+        variant_id: number;
+        name: string;
+        attributes: string;
+        sku: string;
+        ean: string;
+        location: string;
+        auction_id: string;
+        price_brutto: number;
+        tax_rate: number;
+        quantity: number;
+        weight: number;
+        bundle_id: number;
+    }[]
+}
+/* eslint-enable @typescript-eslint/naming-convention */
+
+export interface IOutput {
+    orders: Order[]
+}

package/src/Connector/SetOrderStatus.ts

@@ -0,0 +1,31 @@
+import ProcessDto from '@orchesty/nodejs-sdk/dist/lib/Utils/ProcessDto';
+import ABaseConnector from './ABaseConnector';
+
+export const NAME = 'set-order-status';
+
+export default class SetOrderStatus extends ABaseConnector<IInput, unknown> {
+
+    public getName(): string {
+        return NAME;
+    }
+
+    protected getMethod(): string {
+        return 'setOrderStatus';
+    }
+
+    // eslint-disable-next-line @typescript-eslint/require-await
+    protected async getParameters(dto: ProcessDto<IInput>): Promise<object> {
+        const { orderId, statusId } = dto.getJsonData();
+
+        return {
+            order_id: orderId,
+            status_id: statusId,
+        };
+    }
+
+}
+
+export interface IInput {
+    orderId: number
+    statusId: number
+}

package/src/Connector/UpdateInventoryProductsStock.ts

@@ -0,0 +1,36 @@
+import ProcessDto from '@orchesty/nodejs-sdk/dist/lib/Utils/ProcessDto';
+import ABaseConnector from './ABaseConnector';
+
+export const NAME = 'update-inventory-products-stock';
+
+export default class UpdateInventoryProductsStock extends ABaseConnector<IInput, IOutput> {
+
+    public getName(): string {
+        return NAME;
+    }
+
+    protected getMethod(): string {
+        return 'updateInventoryProductsStock';
+    }
+
+    // eslint-disable-next-line @typescript-eslint/require-await
+    protected async getParameters(dto: ProcessDto<IInput>): Promise<object> {
+        const { inventoryId, products } = dto.getJsonData();
+
+        return {
+            inventory_id: inventoryId,
+            products,
+        };
+    }
+
+}
+
+export interface IInput {
+    inventoryId: string;
+    products: Record<string, Record<string, number>>;
+}
+
+export interface IOutput {
+    counter: number;
+    warnings: string;
+}

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

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

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

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

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

@@ -0,0 +1,8 @@
+{
+  "headers": {
+    "user": "TestUser"
+  },
+  "data": {
+    "courierCode": "pkwid"
+  }
+}

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

@@ -0,0 +1,106 @@
+{
+  "http": "POST https://api.baselinker.com/connector.php",
+  "code": 200,
+  "body": {
+    "status": "SUCCESS",
+    "multi_packages": false,
+    "fields": [
+      {
+        "id": "courier",
+        "name": "Courier",
+        "type": "select",
+        "desc": "",
+        "options": {
+          "2": "KEX",
+          "4": "GLS",
+          "5": "FedEx",
+          "6": "InPost Paczkomaty",
+          "8": "DHL",
+          "10": "FedEx Lotniczy",
+          "11": "Paczka w ruchu",
+          "12": "InPost Kurier",
+          "13": "Delta city",
+          "30": "UPS Express Saver",
+          "31": "UPS Standard"
+        }
+      },
+      {
+        "id": "package_type",
+        "name": "Type",
+        "type": "select",
+        "options": {
+          "paczka": "parcel",
+          "paleta": "palette",
+          "koperta": "envelope"
+        },
+        "show_field": {
+          "paleta": [
+            "before_delivery_notification"
+          ]
+        }
+      },
+      {
+        "id": "pickup_date",
+        "name": "Dispatch date",
+        "type": "date",
+        "desc": "Order pickup for specific day",
+        "value": 1487085753
+      },
+      {
+        "id": "cod",
+        "name": "Cash on delivery",
+        "type": "text"
+      },
+      {
+        "id": "insurance",
+        "name": "Insurance",
+        "type": "text"
+      },
+      {
+        "id": "package_description",
+        "name": "Content description",
+        "type": "text"
+      },
+      {
+        "id": "before_delivery_notification",
+        "name": "Notification before delivery",
+        "type": "checkbox",
+        "desc": "Available only for DHL Palette",
+        "options": {
+          "1": "Yes"
+        }
+      }
+    ],
+    "package_fields": [
+      {
+        "id": "weight",
+        "name": "Weight",
+        "type": "text"
+      },
+      {
+        "id": "size_length",
+        "name": "Length",
+        "type": "text"
+      },
+      {
+        "id": "size_width",
+        "name": "Width",
+        "type": "text"
+      },
+      {
+        "id": "size_height",
+        "name": "Height",
+        "type": "text"
+      },
+      {
+        "id": "size_custom",
+        "name": "Custom",
+        "type": "checkbox",
+        "options": {
+          "1": "Unusual shape"
+        },
+        "default": "0"
+      }
+    ]
+  }
+}

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

@@ -0,0 +1,106 @@
+{
+  "headers": {
+    "user": "TestUser"
+  },
+  "data": {
+    "multi_packages": false,
+    "fields": [
+      {
+        "id": "courier",
+        "name": "Courier",
+        "type": "select",
+        "desc": "",
+        "options": {
+          "2": "KEX",
+          "4": "GLS",
+          "5": "FedEx",
+          "6": "InPost Paczkomaty",
+          "8": "DHL",
+          "10": "FedEx Lotniczy",
+          "11": "Paczka w ruchu",
+          "12": "InPost Kurier",
+          "13": "Delta city",
+          "30": "UPS Express Saver",
+          "31": "UPS Standard"
+        }
+      },
+      {
+        "id": "package_type",
+        "name": "Type",
+        "type": "select",
+        "options": {
+          "paczka": "parcel",
+          "paleta": "palette",
+          "koperta": "envelope"
+        },
+        "show_field": {
+          "paleta": [
+            "before_delivery_notification"
+          ]
+        }
+      },
+      {
+        "id": "pickup_date",
+        "name": "Dispatch date",
+        "type": "date",
+        "desc": "Order pickup for specific day",
+        "value": 1487085753
+      },
+      {
+        "id": "cod",
+        "name": "Cash on delivery",
+        "type": "text"
+      },
+      {
+        "id": "insurance",
+        "name": "Insurance",
+        "type": "text"
+      },
+      {
+        "id": "package_description",
+        "name": "Content description",
+        "type": "text"
+      },
+      {
+        "id": "before_delivery_notification",
+        "name": "Notification before delivery",
+        "type": "checkbox",
+        "desc": "Available only for DHL Palette",
+        "options": {
+          "1": "Yes"
+        }
+      }
+    ],
+    "package_fields": [
+      {
+        "id": "weight",
+        "name": "Weight",
+        "type": "text"
+      },
+      {
+        "id": "size_length",
+        "name": "Length",
+        "type": "text"
+      },
+      {
+        "id": "size_width",
+        "name": "Width",
+        "type": "text"
+      },
+      {
+        "id": "size_height",
+        "name": "Height",
+        "type": "text"
+      },
+      {
+        "id": "size_custom",
+        "name": "Custom",
+        "type": "checkbox",
+        "options": {
+          "1": "Unusual shape"
+        },
+        "default": "0"
+      }
+    ]
+  }
+}

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

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

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

@@ -0,0 +1,57 @@
+{
+  "http": "POST https://api.baselinker.com/connector.php",
+  "code": 200,
+  "body": {
+    "status": "SUCCESS",
+    "couriers": [
+      {
+        "code": "dhl",
+        "name": "DHL"
+      },
+      {
+        "code": "dpd",
+        "name": "DPD"
+      },
+      {
+        "code": "fedexpl",
+        "name": "FedEx"
+      },
+      {
+        "code": "globkurier",
+        "name": "Globkurier"
+      },
+      {
+        "code": "gls",
+        "name": "GLS"
+      },
+      {
+        "code": "inpostkurier",
+        "name": "InPost"
+      },
+      {
+        "code": "kex2",
+        "name": "K-EX Geis"
+      },
+      {
+        "code": "paczkomaty",
+        "name": "Paczkomaty"
+      },
+      {
+        "code": "pkwid",
+        "name": "PKWiD"
+      },
+      {
+        "code": "pocztapolska",
+        "name": "Poczta Polska"
+      },
+      {
+        "code": "qlink",
+        "name": "Qlink"
+      },
+      {
+        "code": "ruch",
+        "name": "Ruch"
+      }
+    ]
+  }
+}

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

@@ -0,0 +1,57 @@
+{
+  "headers": {
+    "user": "TestUser"
+  },
+  "data": {
+    "couriers": [
+      {
+        "code": "dhl",
+        "name": "DHL"
+      },
+      {
+        "code": "dpd",
+        "name": "DPD"
+      },
+      {
+        "code": "fedexpl",
+        "name": "FedEx"
+      },
+      {
+        "code": "globkurier",
+        "name": "Globkurier"
+      },
+      {
+        "code": "gls",
+        "name": "GLS"
+      },
+      {
+        "code": "inpostkurier",
+        "name": "InPost"
+      },
+      {
+        "code": "kex2",
+        "name": "K-EX Geis"
+      },
+      {
+        "code": "paczkomaty",
+        "name": "Paczkomaty"
+      },
+      {
+        "code": "pkwid",
+        "name": "PKWiD"
+      },
+      {
+        "code": "pocztapolska",
+        "name": "Poczta Polska"
+      },
+      {
+        "code": "qlink",
+        "name": "Qlink"
+      },
+      {
+        "code": "ruch",
+        "name": "Ruch"
+      }
+    ]
+  }
+}

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

@@ -0,0 +1,37 @@
+{
+  "headers": {
+    "user": "TestUser"
+  },
+  "data": {
+    "order_id": 6910995,
+    "courier_code": "dhl",
+    "account_id": 33,
+    "fields": [
+      {
+        "id": "service",
+        "value": "dhl"
+      },
+      {
+        "id": "cod",
+        "value": "101"
+      },
+      {
+        "id": "insurance",
+        "value": "55"
+      },
+      {
+        "id": "package_description",
+        "value": "Shipment description"
+      }
+    ],
+    "packages": [
+      {
+        "length": 11,
+        "height": 12,
+        "width": 13,
+        "weight": 4,
+        "size_custom": 1
+      }
+    ]
+  }
+}

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

@@ -0,0 +1,10 @@
+{
+  "http": "POST https://api.baselinker.com/connector.php",
+  "code": 200,
+  "body": {
+    "status": "SUCCESS",
+    "package_id": 77014696,
+    "package_number": "622222044730624327700198",
+    "courier_inner_number": "12387890"
+  }
+}

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

@@ -0,0 +1,10 @@
+{
+  "headers": {
+    "user": "TestUser"
+  },
+  "data": {
+    "package_id": 77014696,
+    "package_number": "622222044730624327700198",
+    "courier_inner_number": "12387890"
+  }
+}