@edgeiq/edgeiq-api-js 1.4.13 → 1.4.15

package/README.md

@@ -1,55 +1,66 @@
-## 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:
-
-Run:
-```
-$ npm publish
-```
-
-## How to use it
-
-Install the dependency via the command line.
-  `npm install --save @edgeiq/edgeiq-api-js`
-  # OR
-  `yarn add @edgeiq/edgeiq-api-js`
+## 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
+```
+- Testing single test file
+```
+$ npm test src/__tests__/<file_name>
+```
+- To test the version locally before publishing:
+  . In the `edgeiq-api-js` local copy run `yarn link`
+  . In the project local copy, where it is needed to install this version (`eiq30` fro example), run `yarn link @edgeiq/edgeiq-api-js`
+  . This will “connect” the two repositories (via a symlink), so `node_modules/@edgeiq/edgeiq-api-js` actually points to your local copy.
+  . You can then run `yarn build` in `edgeiq-api-js` and `eiq30` will pick up the changes you did locally, so no need to publish a new SDK to test something
+  . These commadns will change the `yarn.lock` and `package.json` of the project where the sdk is being used `eiq30`, to revert that run `yarn unlink  @edgeiq/edgeiq-api-js`
+## Publishing:
+
+Run:
+```
+$ npm publish
+```
+
+## How to use it
+
+- Install the dependency via the command line.
+  `npm install --save @edgeiq/edgeiq-api-js`
+  # OR
+  `yarn add @edgeiq/edgeiq-api-js`
+
+This will install the latest version in npm

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

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

package/dist/__tests__/auth.test.js

@@ -1,159 +1,159 @@
-"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(testConstants_1.stageURL);
-    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 loggedUser;
-        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:
-                    loggedUser = _a.sent();
-                    expect(loggedUser.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];
-            }
-        });
-    }); });
-    it("Doesn't allow token expiration to be set longer than a week", function () { return __awaiter(void 0, void 0, void 0, function () {
-        var oneWeekOneSecond, error_3, err, error_4, err;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    oneWeekOneSecond = 604801000;
-                    _a.label = 1;
-                case 1:
-                    _a.trys.push([1, 3, , 4]);
-                    return [4, __2.Authentication.login(testConstants_1.TestAuth.username, testConstants_1.TestAuth.noUser, oneWeekOneSecond)];
-                case 2:
-                    _a.sent();
-                    return [3, 4];
-                case 3:
-                    error_3 = _a.sent();
-                    err = error_3;
-                    expect(err.message).toBe(constants_1.ResponseErrorsMessages.invalidTokenExpiration);
-                    return [3, 4];
-                case 4:
-                    _a.trys.push([4, 6, , 7]);
-                    return [4, __2.Authentication.login(testConstants_1.TestAuth.username, testConstants_1.TestAuth.noUser, 0)];
-                case 5:
-                    _a.sent();
-                    return [3, 7];
-                case 6:
-                    error_4 = _a.sent();
-                    err = error_4;
-                    expect(err.message).toBe(constants_1.ResponseErrorsMessages.invalidTokenExpiration);
-                    return [3, 7];
-                case 7: return [2];
-            }
-        });
-    }); });
-    it('Resets user API token', function () { return __awaiter(void 0, void 0, void 0, function () {
-        var loggedUser, 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:
-                    loggedUser = _a.sent();
-                    expect(loggedUser.session_token).not.toBeNull();
-                    return [4, __2.Authentication.tokenReset(testConstants_1.TestAuth.username, testConstants_1.TestAuth.pass)];
-                case 2:
-                    result = _a.sent();
-                    expect(result.api_token).not.toEqual(loggedUser.session_token);
-                    return [2];
-            }
-        });
-    }); });
-});
+"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(testConstants_1.stageURL);
+    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 loggedUser;
+        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:
+                    loggedUser = _a.sent();
+                    expect(loggedUser.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];
+            }
+        });
+    }); });
+    it("Doesn't allow token expiration to be set longer than a week", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var oneWeekOneSecond, error_3, err, error_4, err;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    oneWeekOneSecond = 604801000;
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    return [4, __2.Authentication.login(testConstants_1.TestAuth.username, testConstants_1.TestAuth.noUser, oneWeekOneSecond)];
+                case 2:
+                    _a.sent();
+                    return [3, 4];
+                case 3:
+                    error_3 = _a.sent();
+                    err = error_3;
+                    expect(err.message).toBe(constants_1.ResponseErrorsMessages.invalidTokenExpiration);
+                    return [3, 4];
+                case 4:
+                    _a.trys.push([4, 6, , 7]);
+                    return [4, __2.Authentication.login(testConstants_1.TestAuth.username, testConstants_1.TestAuth.noUser, 0)];
+                case 5:
+                    _a.sent();
+                    return [3, 7];
+                case 6:
+                    error_4 = _a.sent();
+                    err = error_4;
+                    expect(err.message).toBe(constants_1.ResponseErrorsMessages.invalidTokenExpiration);
+                    return [3, 7];
+                case 7: return [2];
+            }
+        });
+    }); });
+    it('Resets user API token', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var loggedUser, 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:
+                    loggedUser = _a.sent();
+                    expect(loggedUser.session_token).not.toBeNull();
+                    return [4, __2.Authentication.tokenReset(testConstants_1.TestAuth.username, testConstants_1.TestAuth.pass)];
+                case 2:
+                    result = _a.sent();
+                    expect(result.api_token).not.toEqual(loggedUser.session_token);
+                    return [2];
+            }
+        });
+    }); });
+});

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

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