xlport 0.3.0 → 0.3.2

package/dist/shared.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=shared.types.js.map

package/dist/shared.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.types.js","sourceRoot":"","sources":["../lib/shared.types.ts"],"names":[],"mappings":""}

package/dist/tests/client/client.e2e.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/client/client.e2e.spec.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const lib_1 = require("../../lib");
+const dotenv = require("dotenv");
+const simpleExport = require("./export/simple-export/request.json");
+const import1Object = require("./import/1object/expected.json");
+const import1Table = require("./import/1table/expected.json");
+const importLargeTable = require("./import/1table-10col-100rows/expected.json");
+const importMultipleObjects = require("./import/multipleObjects/expected.json");
+const importMultipleObjectsAndTables = require("./import/multipleObjectsAndTables/expected.json");
+const fs_1 = require("fs");
+const round = (value, precision) => Math.round(value * Math.pow(10, precision)) / Math.pow(10, precision);
+const roundNumbers = (obj, precision = 8) => {
+    if (Array.isArray(obj)) {
+        obj.forEach((element) => {
+            if (typeof element === 'number') {
+                element = round(element, precision);
+            }
+            else {
+                roundNumbers(element, precision);
+            }
+        });
+    }
+    else if (typeof obj === 'object') {
+        for (const key in obj) {
+            if (obj.hasOwnProperty(key)) {
+                const element = obj[key];
+                if (typeof element === 'number') {
+                    obj[key] = round(element, precision);
+                }
+                else {
+                    roundNumbers(element, precision);
+                }
+            }
+        }
+    }
+    else if (typeof obj === 'number') {
+        obj = round(obj, precision);
+    }
+    return obj;
+};
+describe('Client', () => {
+    const getClient = () => {
+        dotenv.config({ path: './tests/client/.env' });
+        return new lib_1.Client({ apiKey: process.env.XLPORT_APIKEY });
+    };
+    it('should throw if API Key is undefined', () => {
+        expect(() => new lib_1.Client({ apiKey: undefined })).toThrow();
+    });
+    it('should be able to create a client', () => {
+        const client = getClient();
+        expect(client).toBeDefined();
+    });
+    it('should be able to download a file', async () => {
+        const client = getClient();
+        const file = await client.exportToFile(simpleExport);
+        expect(file).toBeDefined();
+    });
+    it('should be able to upload a template', async () => {
+        const client = getClient();
+        const result = await client.exportToFile({
+            template: fs_1.createReadStream('./tests/client/export/simple-export/template.xlsx'),
+            data: { test: 'Test' },
+        });
+        expect(result).toBeDefined();
+    });
+    it('should import data - 1object', async () => {
+        const client = getClient();
+        const result = await client.importFromFile('./tests/client/import/1object/Source.xlsx');
+        expect(result.status).toBe('success');
+        if (result.status === 'success') {
+            expect(result.data.properties).toEqual(import1Object.properties);
+        }
+    });
+    it('should import data - 1table', async () => {
+        const client = getClient();
+        const result = await client.importFromFile('./tests/client/import/1table/Source.xlsx');
+        expect(result.status).toBe('success');
+        if (result.status === 'success') {
+            expect(result.data.tables).toEqual(import1Table.tables);
+        }
+    });
+    it('should import data - large table', async () => {
+        const client = getClient();
+        const result = await client.importFromFile('./tests/client/import/1table-10col-100rows/Source.xlsx');
+        expect(result.status).toBe('success');
+        if (result.status === 'success') {
+            expect(roundNumbers(result.data.tables)).toEqual(roundNumbers(importLargeTable.tables));
+        }
+    });
+    it('should import data - multipleObjects', async () => {
+        const client = getClient();
+        const result = await client.importFromFile('./tests/client/import/multipleObjects/Source.xlsx');
+        expect(result.status).toBe('success');
+        if (result.status === 'success') {
+            expect(result.data.properties).toEqual(importMultipleObjects.properties);
+        }
+    });
+    it('should import data - multipleObjectsAndTables', async () => {
+        const client = getClient();
+        const result = await client.importFromFile('./tests/client/import/multipleObjectsAndTables/Source.xlsx');
+        expect(result.status).toBe('success');
+        if (result.status === 'success') {
+            expect(result.data.properties).toEqual(importMultipleObjectsAndTables.properties);
+            expect(result.data.tables).toEqual(importMultipleObjectsAndTables.tables);
+        }
+    });
+});
+//# sourceMappingURL=client.e2e.spec.js.map

package/dist/tests/client/client.e2e.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.e2e.spec.js","sourceRoot":"","sources":["../../../tests/client/client.e2e.spec.ts"],"names":[],"mappings":";;AAAA,mCAAkC;AAClC,iCAAgC;AAKhC,oEAAmE;AACnE,gEAA+D;AAC/D,8DAA6D;AAC7D,gFAA+E;AAC/E,gFAA+E;AAC/E,kGAAiG;AACjG,2BAAqC;AASrC,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,SAAiB,EAAE,EAAE,CACjD,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,CAAC,CAAA;AACvE,MAAM,YAAY,GAAG,CAAC,GAAQ,EAAE,SAAS,GAAG,CAAC,EAAE,EAAE;IAC/C,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACtB,GAAG,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACtB,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;gBAE/B,OAAO,GAAG,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;aACpC;iBAAM;gBACL,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;aACjC;QACH,CAAC,CAAC,CAAA;KACH;SAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAClC,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE;YACrB,IAAI,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;gBAC3B,MAAM,OAAO,GAAG,GAAG,CAAC,GAAG,CAAC,CAAA;gBACxB,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;oBAC/B,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;iBACrC;qBAAM;oBACL,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;iBACjC;aACF;SACF;KACF;SAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAClC,GAAG,GAAG,KAAK,CAAC,GAAG,EAAE,SAAS,CAAC,CAAA;KAC5B;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AACD,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,MAAM,SAAS,GAAG,GAAG,EAAE;QACrB,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC,CAAA;QAC9C,OAAO,IAAI,YAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,aAAc,EAAE,CAAC,CAAA;IAC3D,CAAC,CAAA;IAED,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,YAAM,CAAC,EAAE,MAAM,EAAE,SAAgB,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAA;IAClE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;QAC1B,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAA;IAC9B,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;QAC1B,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,CAAA;QACpD,MAAM,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAA;IAC5B,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACnD,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;QAC1B,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC;YACvC,QAAQ,EAAE,qBAAgB,CAAC,mDAAmD,CAAC;YAC/E,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;SACvB,CAAC,CAAA;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAA;IAC9B,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;QAC5C,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;QAC1B,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,2CAA2C,CAAC,CAAA;QACvF,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACrC,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE;YAC/B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;SACjE;IACH,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QAC3C,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;QAC1B,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,0CAA0C,CAAC,CAAA;QACtF,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACrC,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE;YAC/B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;SACxD;IACH,CAAC,CAAC,CAAA;IACF,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;QAC1B,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,wDAAwD,CAAC,CAAA;QACpG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACrC,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE;YAC/B,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAA;SACxF;IACH,CAAC,CAAC,CAAA;IACF,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;QACpD,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;QAC1B,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,mDAAmD,CAAC,CAAA;QAC/F,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACrC,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE;YAC/B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAA;SACzE;IACH,CAAC,CAAC,CAAA;IACF,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;QAC1B,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,4DAA4D,CAAC,CAAA;QACxG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACrC,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE;YAC/B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,8BAA8B,CAAC,UAAU,CAAC,CAAA;YACjF,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAA;SAC1E;IACH,CAAC,CAAC,CAAA;AA4BJ,CAAC,CAAC,CAAA"}

package/dist/tests/client/export/simple-export/request.json

@@ -0,0 +1,6 @@
+{
+    "templateId": "simple-export/template.xlsx",
+    "data": {
+        "test": "Test"
+    }
+}

package/dist/tests/client/import/1object/expected.json

@@ -0,0 +1,10 @@
+{
+    "properties": {
+        "Boolean": true,
+        "Float": -143242.25,
+        "Integer": 114325352,
+        "LastUpdated": "2019-01-01T00:00:00.000Z",
+        "ProjectId": "pid1",
+        "ProjectLabel": "Project Name"
+    }
+}

package/dist/tests/client/import/1table/expected.json

@@ -0,0 +1,39 @@
+{
+    "tables": {
+        "Initiatives": [
+            {
+                "Id": "uuidInitiative1",
+                "Name": "Initiative 1",
+                "StatusId": "uuidStatus1",
+                "SavingsPotential": 123.3,
+                "Achievement": 0.12,
+                "IsComplete": false,
+                "Date": "2018-04-11T00:00:00.000Z",
+                "Integer": 1,
+                "Calculated column": 146.727
+            },
+            {
+                "Id": "uuidInitiative2",
+                "Name": "Initiative 2",
+                "StatusId": "uuidStatus2",
+                "SavingsPotential": null,
+                "Achievement": 0,
+                "IsComplete": true,
+                "Date": "1966-05-01T00:00:00.000Z",
+                "Integer": -246537347,
+                "Calculated column": 0
+            },
+            {
+                "Id": "uuidInitiative3",
+                "Name": "Initiative 3",
+                "StatusId": "uuidStatus3",
+                "SavingsPotential": 456,
+                "Achievement": 0.2,
+                "IsComplete": false,
+                "Date": "2020-01-01T00:00:00.000Z",
+                "Integer": 1324275242,
+                "Calculated column": 542.64
+            }
+        ]
+    }
+}