@edgeiq/edgeiq-api-js 1.0.0

package/dist/__tests__/users.test.js

@@ -0,0 +1,208 @@
+"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('Users', 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 user = testConstants_1.EmptyUser;
+    var user2 = testConstants_1.EmptyUser;
+    it('Creates a 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, __1.Users.create(testConstants_1.TestUser)];
+                case 1:
+                    result = _a.sent();
+                    expect(result._id).not.toBeNull();
+                    expect(result.email).toBe(testConstants_1.TestUser.email);
+                    user = result;
+                    return [2];
+            }
+        });
+    }); });
+    it('User 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.Users.create(testConstants_1.TestUser)];
+                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.emailUsed(testConstants_1.TestUser.email));
+                    }
+                    return [3, 3];
+                case 3: return [2];
+            }
+        });
+    }); });
+    it('Creates a second 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, __1.Users.create(testConstants_1.TestUser2)];
+                case 1:
+                    result = _a.sent();
+                    expect(result._id).not.toBeNull();
+                    expect(result.email).toBe(testConstants_1.TestUser2.email);
+                    user2 = result;
+                    return [2];
+            }
+        });
+    }); });
+    it('Gets the first user 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.Users.getOneById(user._id)];
+                case 1:
+                    result = _a.sent();
+                    expect(result.email).toBe(user.email);
+                    return [2];
+            }
+        });
+    }); });
+    it('Gets the second user created by email', 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.Users.getOneByEmail(user2.email)];
+                case 1:
+                    result = _a.sent();
+                    expect(result.email).toBe(user2.email);
+                    return [2];
+            }
+        });
+    }); });
+    it('Updates a user', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!user._id) return [3, 2];
+                    return [4, __1.Users.update(__assign(__assign({}, user), { first_name: testConstants_1.NewTestUserName }))];
+                case 1:
+                    result = _a.sent();
+                    expect(result.first_name).toBe(testConstants_1.NewTestUserName);
+                    _a.label = 2;
+                case 2: return [2];
+            }
+        });
+    }); });
+    it('List the users 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 = {
+                        first_name: {
+                            operator: 'like',
+                            value: testConstants_1.TestUser.first_name,
+                        },
+                        last_name: {
+                            operator: 'like',
+                            value: testConstants_1.TestUser.last_name,
+                        },
+                    };
+                    return [4, __1.Users.list(filters)];
+                case 1:
+                    result = _a.sent();
+                    expect(result.users).toBeDefined();
+                    expect(result.users).toBeInstanceOf(Array);
+                    expect(result.users).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 users 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 (!user._id) return [3, 2];
+                    return [4, __1.Users.delete(user._id)];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe((0, helpers_1.getReturnDeleteMessage)('user'));
+                    _a.label = 2;
+                case 2:
+                    if (!user2._id) return [3, 4];
+                    return [4, __1.Users.delete(user2._id)];
+                case 3:
+                    result = _a.sent();
+                    expect(result).toBe((0, helpers_1.getReturnDeleteMessage)('user'));
+                    _a.label = 4;
+                case 4: return [2];
+            }
+        });
+    }); });
+});

package/dist/auth/index.d.ts

@@ -0,0 +1,6 @@
+import { EIQLoginUser, User } from '../users/models';
+declare const Authentication: {
+    login: (user: string, password: string) => Promise<EIQLoginUser>;
+    me: () => Promise<User>;
+};
+export { Authentication };

package/dist/auth/index.js

@@ -0,0 +1,95 @@
+"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 });
+exports.Authentication = void 0;
+var __1 = require("..");
+var constants_1 = require("../constants");
+var helpers_1 = require("../helpers");
+var Authentication = {
+    login: function (user, password) { return __awaiter(void 0, void 0, void 0, function () {
+        var axios, data, result, error_1;
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    _b.trys.push([0, 2, , 3]);
+                    __1.EdgeIQAPI.logAction("Logging with user: " + user);
+                    axios = __1.EdgeIQAPI.getAxios();
+                    data = JSON.stringify({
+                        email: user,
+                        password: password,
+                    });
+                    return [4, axios.post(constants_1.Endpoints.login, data)];
+                case 1:
+                    result = _b.sent();
+                    __1.EdgeIQAPI.setSessionToken((_a = result === null || result === void 0 ? void 0 : result.data) === null || _a === void 0 ? void 0 : _a.session_token);
+                    return [2, result === null || result === void 0 ? void 0 : result.data];
+                case 2:
+                    error_1 = _b.sent();
+                    if ((0, helpers_1.isApiError)(error_1)) {
+                        throw error_1;
+                    }
+                    throw error_1;
+                case 3: return [2];
+            }
+        });
+    }); },
+    me: function () { return __awaiter(void 0, void 0, void 0, function () {
+        var axios, result, error_2;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    _a.trys.push([0, 2, , 3]);
+                    __1.EdgeIQAPI.logAction("Getting logged user data.");
+                    axios = __1.EdgeIQAPI.getAxios();
+                    return [4, axios.get(constants_1.Endpoints.me)];
+                case 1:
+                    result = _a.sent();
+                    return [2, result === null || result === void 0 ? void 0 : result.data];
+                case 2:
+                    error_2 = _a.sent();
+                    if ((0, helpers_1.isApiError)(error_2)) {
+                        throw error_2;
+                    }
+                    throw error_2;
+                case 3: return [2];
+            }
+        });
+    }); },
+};
+exports.Authentication = Authentication;

package/dist/bulkResponses/index.d.ts

@@ -0,0 +1,8 @@
+import { PaginationFilter } from '../models';
+import { BulkResponse, PaginatedBulkResponses, BulkResponsesFilters } from './models';
+interface BulkResponsesInterface {
+    list(filters?: BulkResponsesFilters, pagination?: PaginationFilter): Promise<PaginatedBulkResponses>;
+    getOneById(id: string): Promise<BulkResponse>;
+}
+export declare const BulkResponses: BulkResponsesInterface;
+export {};

package/dist/bulkResponses/index.js

@@ -0,0 +1,124 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+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 });
+exports.BulkResponses = void 0;
+var __1 = require("..");
+var constants_1 = require("../constants");
+var ModelClass_1 = require("../core/ModelClass");
+var filtersParser_1 = require("../filtersParser");
+var helpers_1 = require("../helpers");
+exports.BulkResponses = (function (_super) {
+    __extends(class_1, _super);
+    function class_1() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    class_1.list = function (filters, pagination) {
+        var _a, _b, _c, _d;
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, result, error_1;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        _e.trys.push([0, 2, , 3]);
+                        this.logAction("Listing bulk responses with following filters: " + (filters !== null && filters !== void 0 ? filters : '{}') + ".\n And pagination " + (pagination !== null && pagination !== void 0 ? pagination : '{}'));
+                        axios = __1.EdgeIQAPI.getAxios();
+                        return [4, axios.get(constants_1.Endpoints.bulkResponse, {
+                                params: (0, filtersParser_1.parseFilters)(filters, pagination),
+                            })];
+                    case 1:
+                        result = _e.sent();
+                        return [2, {
+                                bulkResponses: (_a = result === null || result === void 0 ? void 0 : result.data) === null || _a === void 0 ? void 0 : _a.resources,
+                                pagination: {
+                                    page: (_b = result === null || result === void 0 ? void 0 : result.data) === null || _b === void 0 ? void 0 : _b.page,
+                                    itemsPerPage: (_c = result === null || result === void 0 ? void 0 : result.data) === null || _c === void 0 ? void 0 : _c.per_page,
+                                    total: (_d = result === null || result === void 0 ? void 0 : result.data) === null || _d === void 0 ? void 0 : _d.total,
+                                },
+                            }];
+                    case 2:
+                        error_1 = _e.sent();
+                        if ((0, helpers_1.isApiError)(error_1)) {
+                            throw error_1;
+                        }
+                        throw error_1;
+                    case 3: return [2];
+                }
+            });
+        });
+    };
+    class_1.getOneById = function (id) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, result, error_2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        this.logAction("Getting bulk response with id: " + id);
+                        axios = __1.EdgeIQAPI.getAxios();
+                        return [4, axios.get(constants_1.Endpoints.bulkResponse + "/" + id)];
+                    case 1:
+                        result = _a.sent();
+                        return [2, result === null || result === void 0 ? void 0 : result.data];
+                    case 2:
+                        error_2 = _a.sent();
+                        if ((0, helpers_1.isApiError)(error_2)) {
+                            throw error_2;
+                        }
+                        throw error_2;
+                    case 3: return [2];
+                }
+            });
+        });
+    };
+    return class_1;
+}(ModelClass_1.BaseModelClass));

package/dist/bulkResponses/models.d.ts

@@ -0,0 +1,43 @@
+import { Base, Filter, Filters, Pagination } from '../models';
+export declare type BulkResponseStatusType = 'success' | 'fail';
+export interface BulkSingleResponse {
+    status?: number;
+    id?: string;
+    error?: string;
+    messages?: string[];
+}
+export interface BulkResponseUpdate {
+    status: string;
+    success?: {
+        [key: string]: BulkSingleResponse;
+    };
+    fail?: {
+        [key: string]: BulkSingleResponse;
+    };
+}
+export interface CSVError {
+    row: number;
+    messages: string[];
+}
+export interface BulkResponseStatus {
+    status_code?: number;
+    status?: BulkResponseStatusType;
+    error?: string;
+    messages?: string[];
+    csv_errors?: CSVError[];
+    bulk_response_id: string;
+    device_id: string;
+    workflow_record_id?: string;
+}
+export interface BulkResponse extends Base {
+    type: string;
+    total: number;
+    bulk_response_statuses: (BulkResponseStatus | undefined)[];
+}
+export interface BulkResponsesFilters extends Filters {
+    type?: Filter;
+}
+export interface PaginatedBulkResponses {
+    bulkResponses: BulkResponse[];
+    pagination: Pagination;
+}

package/dist/bulkResponses/models.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/commands/index.d.ts

@@ -0,0 +1,9 @@
+import { BaseModelInterface } from '../core/ModelClass';
+import { BulkActionResponse } from '../models';
+import { Command, CommandInput, CommandsFilters, PaginatedCommands } from './models';
+interface CommandsInterface extends BaseModelInterface<Command, CommandInput, CommandsFilters, PaginatedCommands> {
+    update(command: Command): Promise<Command>;
+    deleteMultiple(ids: string[]): Promise<BulkActionResponse>;
+}
+export declare const Commands: CommandsInterface;
+export {};