@edgeiq/edgeiq-api-js 1.0.0

package/README.md

@@ -0,0 +1,74 @@
+## Description
+
+An SDK Wrapper to use EdgeIQ API
+We will be using:
+- Typescript
+- Axios
+- Jest
+- Prettier
+<br/>
+
+## Requirements
+
+- Node
+<br/>
+
+## Initial Setup
+
+Just install the packages needed
+```
+$ npm install
+```
+<br/>
+
+## Available Commands
+
+- Building:
+```
+$ npm run build
+```
+- Linting:
+```
+$ npm run lint
+```
+- Formatting:
+```
+$ npm run format
+```
+- Testing
+```
+$ npm test
+```
+
+## Publishing:
+
+The gemfury registry is already set in the `.npmrc` file.
+So before publishing run:
+```
+$ npm login --registry=https://npm.fury.io/edgeiq/
+```
+Use your gemfuty credentials.
+Once this is done, run:
+```
+$ npm publish
+```
+
+And the package will be uploaded.
+To make sure it has been uploaded correctly, go to: `https://manage.fury.io/dashboard/edgeiq` and look for the package.
+
+## How to use it
+1. Add `.npmrc` in the consuming project and add this line:
+  `@edgeiq:registry=https://npm-proxy.fury.io/edgeiq/`
+
+2. Login via npm CLI with Gemfury credentials.
+  `npm login --registry https://npm-proxy.fury.io/edgeiq/`
+
+  This will add or edit the users global .npmrc file located in their home directory with this line:
+
+  `# ~/.npmrc`
+  `//npm-proxy.fury.io/organization/:_authToken=${SECRET_TOKEN}`
+
+3. Install the dependency via the command line.
+  `npm install --save @edgeiq/edgeiq-api-js`
+  # OR
+  `yarn add @edgeiq/edgeiq-api-js`

package/dist/__tests__/auth.test.d.ts

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

package/dist/__tests__/auth.test.js

@@ -0,0 +1,110 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var __1 = require("..");
+var __2 = require("..");
+var constants_1 = require("../constants");
+var helpers_1 = require("../helpers");
+var testConstants_1 = require("../testConstants");
+describe('Authentication', function () {
+    __1.EdgeIQAPI.init();
+    it('Wrong user', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var error_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    _a.trys.push([0, 2, , 3]);
+                    return [4, __2.Authentication.login(testConstants_1.TestAuth.noUser, testConstants_1.TestAuth.noUser)];
+                case 1:
+                    _a.sent();
+                    return [3, 3];
+                case 2:
+                    error_1 = _a.sent();
+                    if ((0, helpers_1.isApiError)(error_1)) {
+                        expect(error_1.message).toBe(constants_1.ResponseErrorsMessages.noUser);
+                    }
+                    return [3, 3];
+                case 3: return [2];
+            }
+        });
+    }); });
+    it('Wrong password', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var error_2;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    _a.trys.push([0, 2, , 3]);
+                    return [4, __2.Authentication.login(testConstants_1.TestAuth.username, testConstants_1.TestAuth.noUser)];
+                case 1:
+                    _a.sent();
+                    return [3, 3];
+                case 2:
+                    error_2 = _a.sent();
+                    if ((0, helpers_1.isApiError)(error_2)) {
+                        expect(error_2.message).toBe(constants_1.ResponseErrorsMessages.invalidPassword);
+                    }
+                    return [3, 3];
+                case 3: return [2];
+            }
+        });
+    }); });
+    it('Correct user and password', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4, __2.Authentication.login(testConstants_1.TestAuth.username, testConstants_1.TestAuth.pass)];
+                case 1:
+                    result = _a.sent();
+                    expect(result.session_token).not.toBeNull();
+                    return [2];
+            }
+        });
+    }); });
+    it('Gets logged user data', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4, __2.Authentication.me()];
+                case 1:
+                    result = _a.sent();
+                    expect(result._id).not.toBeNull();
+                    return [2];
+            }
+        });
+    }); });
+});

package/dist/__tests__/companies.test.d.ts

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

package/dist/__tests__/companies.test.js

@@ -0,0 +1,196 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var __1 = require("..");
+var __2 = require("..");
+var constants_1 = require("../constants");
+var helpers_1 = require("../helpers");
+var testConstants_1 = require("../testConstants");
+describe('Companies', function () {
+    __1.EdgeIQAPI.init();
+    it('Logs User', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4, __2.Authentication.login(testConstants_1.TestAuth.username, testConstants_1.TestAuth.pass)];
+                case 1:
+                    result = _a.sent();
+                    expect(result.session_token).not.toBeNull();
+                    return [2];
+            }
+        });
+    }); });
+    var company = testConstants_1.EmptyCompany;
+    var company2 = testConstants_1.EmptyCompany;
+    it('Creates a company', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4, __1.Companies.create(testConstants_1.TestCompany)];
+                case 1:
+                    result = _a.sent();
+                    expect(result._id).not.toBeNull();
+                    expect(result.name).toBe(testConstants_1.TestCompany.name);
+                    company = result;
+                    return [2];
+            }
+        });
+    }); });
+    it('Company already exists', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var error_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    _a.trys.push([0, 2, , 3]);
+                    return [4, __1.Companies.create(testConstants_1.TestCompany)];
+                case 1:
+                    _a.sent();
+                    return [3, 3];
+                case 2:
+                    error_1 = _a.sent();
+                    if ((0, helpers_1.isApiError)(error_1)) {
+                        expect(error_1.message).toBe(constants_1.ResponseErrorsMessages.uniqueConstraint('companies'));
+                    }
+                    return [3, 3];
+                case 3: return [2];
+            }
+        });
+    }); });
+    it('Creates a second company', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4, __1.Companies.create(testConstants_1.TestCompany2)];
+                case 1:
+                    result = _a.sent();
+                    expect(result._id).not.toBeNull();
+                    expect(result.name).toBe(testConstants_1.TestCompany2.name);
+                    company2 = result;
+                    return [2];
+            }
+        });
+    }); });
+    it('Gets the first company created by _id', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4, __1.Companies.getOneById(company._id)];
+                case 1:
+                    result = _a.sent();
+                    expect(result.name).toBe(company.name);
+                    return [2];
+            }
+        });
+    }); });
+    it('Updates a company', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!company._id) return [3, 2];
+                    return [4, __1.Companies.update(__assign(__assign({}, company), { name: testConstants_1.NewTestCompanyName }))];
+                case 1:
+                    result = _a.sent();
+                    expect(result.name).toBe(testConstants_1.NewTestCompanyName);
+                    _a.label = 2;
+                case 2: return [2];
+            }
+        });
+    }); });
+    it('List the companies created', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var filters, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    filters = {
+                        name: {
+                            operator: 'like',
+                            value: testConstants_1.TestCompany.name,
+                        },
+                        _id: {
+                            operator: 'like',
+                            value: testConstants_1.TestCompany._id,
+                        },
+                    };
+                    return [4, __1.Companies.list(filters)];
+                case 1:
+                    result = _a.sent();
+                    expect(result.companies).toBeDefined();
+                    expect(result.companies).toBeInstanceOf(Array);
+                    expect(result.companies).toHaveLength(2);
+                    expect(result.pagination.page).toBe(constants_1.DefaultPagination.page);
+                    expect(result.pagination.total).toBe(2);
+                    expect(result.pagination.itemsPerPage).toBe(constants_1.DefaultPagination.itemsPerPage);
+                    return [2];
+            }
+        });
+    }); });
+    it('Deletes the companies created', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!company._id) return [3, 2];
+                    return [4, __1.Companies.delete(company._id)];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe((0, helpers_1.getReturnDeleteMessage)('company'));
+                    _a.label = 2;
+                case 2:
+                    if (!company2._id) return [3, 4];
+                    return [4, __1.Companies.delete(company2._id)];
+                case 3:
+                    result = _a.sent();
+                    expect(result).toBe((0, helpers_1.getReturnDeleteMessage)('company'));
+                    _a.label = 4;
+                case 4: return [2];
+            }
+        });
+    }); });
+});

package/dist/__tests__/deviceTypes.test.d.ts

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

package/dist/__tests__/deviceTypes.test.js

@@ -0,0 +1,172 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var __1 = require("..");
+var __2 = require("..");
+var constants_1 = require("../constants");
+var helpers_1 = require("../helpers");
+var testConstants_1 = require("../testConstants");
+describe('Device Types', function () {
+    __1.EdgeIQAPI.init();
+    it('Logs User', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4, __2.Authentication.login(testConstants_1.TestAuth.username, testConstants_1.TestAuth.pass)];
+                case 1:
+                    result = _a.sent();
+                    expect(result.session_token).not.toBeNull();
+                    return [2];
+            }
+        });
+    }); });
+    var deviceType = testConstants_1.EmptyDeviceType;
+    var deviceType2 = testConstants_1.EmptyDeviceType;
+    it('Creates a device type', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4, __1.DeviceTypes.create(testConstants_1.TestDeviceType)];
+                case 1:
+                    result = _a.sent();
+                    expect(result._id).not.toBeNull();
+                    expect(result.name).toBe(testConstants_1.TestDeviceType.name);
+                    deviceType = result;
+                    return [2];
+            }
+        });
+    }); });
+    it('Creates a second device type', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4, __1.DeviceTypes.create(testConstants_1.TestDeviceType2)];
+                case 1:
+                    result = _a.sent();
+                    expect(result._id).not.toBeNull();
+                    expect(result.name).toBe(testConstants_1.TestDeviceType2.name);
+                    deviceType2 = result;
+                    return [2];
+            }
+        });
+    }); });
+    it('Gets the first device type created by _id', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4, __1.DeviceTypes.getOneById(deviceType._id)];
+                case 1:
+                    result = _a.sent();
+                    expect(result.name).toBe(deviceType.name);
+                    return [2];
+            }
+        });
+    }); });
+    it('Updates a device type', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!deviceType._id) return [3, 2];
+                    return [4, __1.DeviceTypes.update(__assign(__assign({}, deviceType), { name: testConstants_1.NewTestDeviceTypeName }))];
+                case 1:
+                    result = _a.sent();
+                    expect(result.name).toBe(testConstants_1.NewTestDeviceTypeName);
+                    _a.label = 2;
+                case 2: return [2];
+            }
+        });
+    }); });
+    it('List the device types created', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var filters, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    filters = {
+                        name: {
+                            operator: 'like',
+                            value: testConstants_1.TestDeviceType.name,
+                        },
+                    };
+                    return [4, __1.DeviceTypes.list(filters)];
+                case 1:
+                    result = _a.sent();
+                    expect(result.deviceTypes).toBeDefined();
+                    expect(result.deviceTypes).toBeInstanceOf(Array);
+                    expect(result.deviceTypes).toHaveLength(2);
+                    expect(result.pagination.page).toBe(constants_1.DefaultPagination.page);
+                    expect(result.pagination.total).toBe(2);
+                    expect(result.pagination.itemsPerPage).toBe(constants_1.DefaultPagination.itemsPerPage);
+                    return [2];
+            }
+        });
+    }); });
+    it('Deletes the device types created', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!deviceType._id) return [3, 2];
+                    return [4, __1.DeviceTypes.delete(deviceType._id)];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe((0, helpers_1.getReturnDeleteMessage)('device type'));
+                    _a.label = 2;
+                case 2:
+                    if (!deviceType2._id) return [3, 4];
+                    return [4, __1.DeviceTypes.delete(deviceType2._id)];
+                case 3:
+                    result = _a.sent();
+                    expect(result).toBe((0, helpers_1.getReturnDeleteMessage)('device type'));
+                    _a.label = 4;
+                case 4: return [2];
+            }
+        });
+    }); });
+});

package/dist/__tests__/devices.test.d.ts

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