@edgeiq/edgeiq-api-js 1.0.0

package/dist/users/index.js

@@ -0,0 +1,252 @@
+"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.Users = 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.Users = (function (_super) {
+    __extends(class_1, _super);
+    function class_1() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    class_1.create = function (user) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, data, result, error_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        this.logAction("Creating a user with email: " + user.email);
+                        axios = __1.EdgeIQAPI.getAxios();
+                        data = JSON.stringify(user);
+                        return [4, axios.post(constants_1.Endpoints.user, data)];
+                    case 1:
+                        result = _a.sent();
+                        return [2, result === null || result === void 0 ? void 0 : result.data];
+                    case 2:
+                        error_1 = _a.sent();
+                        if ((0, helpers_1.isApiError)(error_1)) {
+                            throw error_1;
+                        }
+                        throw error_1;
+                    case 3: return [2];
+                }
+            });
+        });
+    };
+    class_1.update = function (user) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, data, result, error_2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        this.logAction("Updating user with id: " + user._id);
+                        axios = __1.EdgeIQAPI.getAxios();
+                        data = JSON.stringify(user);
+                        return [4, axios.put(constants_1.Endpoints.user + "/" + user._id, data)];
+                    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];
+                }
+            });
+        });
+    };
+    class_1.list = function (filters, pagination) {
+        var _a, _b, _c, _d;
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, result, error_3;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        _e.trys.push([0, 2, , 3]);
+                        this.logAction("Listing users 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.user, {
+                                params: (0, filtersParser_1.parseFilters)(filters, pagination),
+                            })];
+                    case 1:
+                        result = _e.sent();
+                        return [2, {
+                                users: (_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_3 = _e.sent();
+                        if ((0, helpers_1.isApiError)(error_3)) {
+                            throw error_3;
+                        }
+                        throw error_3;
+                    case 3: return [2];
+                }
+            });
+        });
+    };
+    class_1.getOneById = function (id) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, result, error_4;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        this.logAction("Getting user with id: " + id);
+                        axios = __1.EdgeIQAPI.getAxios();
+                        return [4, axios.get(constants_1.Endpoints.user + "/" + id)];
+                    case 1:
+                        result = _a.sent();
+                        return [2, result === null || result === void 0 ? void 0 : result.data];
+                    case 2:
+                        error_4 = _a.sent();
+                        if ((0, helpers_1.isApiError)(error_4)) {
+                            throw error_4;
+                        }
+                        throw error_4;
+                    case 3: return [2];
+                }
+            });
+        });
+    };
+    class_1.getOneByEmail = function (email) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, result, error_5;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        this.logAction("Getting user with email: " + email);
+                        axios = __1.EdgeIQAPI.getAxios();
+                        return [4, axios.get(constants_1.Endpoints.user, {
+                                params: {
+                                    email: email,
+                                },
+                            })];
+                    case 1:
+                        result = _a.sent();
+                        return [2, result === null || result === void 0 ? void 0 : result.data[0]];
+                    case 2:
+                        error_5 = _a.sent();
+                        if ((0, helpers_1.isApiError)(error_5)) {
+                            throw error_5;
+                        }
+                        throw error_5;
+                    case 3: return [2];
+                }
+            });
+        });
+    };
+    class_1.delete = function (id) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, error_6;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        this.logAction("Deleting user with id " + id);
+                        axios = __1.EdgeIQAPI.getAxios();
+                        return [4, axios.delete(constants_1.Endpoints.user + "/" + id)];
+                    case 1:
+                        _a.sent();
+                        return [2, (0, helpers_1.getReturnDeleteMessage)('user')];
+                    case 2:
+                        error_6 = _a.sent();
+                        if ((0, helpers_1.isApiError)(error_6)) {
+                            throw error_6;
+                        }
+                        throw error_6;
+                    case 3: return [2];
+                }
+            });
+        });
+    };
+    class_1.deleteMultiple = function (ids) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, result, error_7;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        this.logAction("Deleting users with ids " + ids.join(', '));
+                        axios = __1.EdgeIQAPI.getAxios();
+                        return [4, axios.delete(constants_1.Endpoints.user + "/bulk", {
+                                data: { ids: ids },
+                            })];
+                    case 1:
+                        result = _a.sent();
+                        return [2, result === null || result === void 0 ? void 0 : result.data];
+                    case 2:
+                        error_7 = _a.sent();
+                        if ((0, helpers_1.isApiError)(error_7)) {
+                            throw error_7;
+                        }
+                        throw error_7;
+                    case 3: return [2];
+                }
+            });
+        });
+    };
+    return class_1;
+}(ModelClass_1.BaseModelClass));

package/dist/users/models.d.ts

@@ -0,0 +1,41 @@
+import { Base, Filter, Filters, Pagination } from '../models';
+interface BaseUser {
+    company_id: string;
+    email: string;
+    first_name: string;
+    last_name: string;
+    user_type_id: string;
+    phone_number?: string;
+    logo_url?: string;
+    company_ids?: string[];
+    metadata?: {
+        [key: string]: unknown;
+    };
+}
+export interface UserInput extends BaseUser {
+    password: string;
+    password_confirmation: string;
+}
+export interface User extends BaseUser, Base {
+}
+export interface EIQLoginUser extends User {
+    session_token?: string;
+    session_expires_at?: string;
+}
+export interface UsersFilters extends Filters {
+    email?: Filter;
+    first_name?: Filter;
+    last_name?: Filter;
+    phone_number?: Filter;
+    logo_url?: Filter;
+    user_type_id?: Filter;
+    company_ids?: Filter;
+    metadata?: {
+        [key: string]: Filter;
+    };
+}
+export interface PaginatedUsers {
+    users: User[];
+    pagination: Pagination;
+}
+export {};

package/dist/users/models.js

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

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@edgeiq/edgeiq-api-js",
+  "version": "1.0.0",
+  "author": "EdgeIQ",
+  "license": "ISC",
+  "description": "This project presents EdgeIQ API SDK.",
+  "keywords": [
+    "edgeiq",
+    "edgeiq-sdk"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/EdgeIQ/edgeiq-api-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/EdgeIQ/edgeiq-api-js/issues"
+  },
+  "homepage": "https://github.com/EdgeIQ/edgeiq-api-js#readme",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "eslint . --cache --fix",
+    "postversion": "git push && git push --tags",
+    "prepare": "npm run build && husky install",
+    "prepublishOnly": "npm run lint",
+    "preversion": "npm run lint",
+    "test": "jest --config jestconfig.json --runInBand --detectOpenHandles",
+    "version": "npm run format && git add -A src"
+  },
+  "dependencies": {
+    "axios": "^0.21.4",
+    "chalk": "^4.1.2"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.0.2",
+    "@typescript-eslint/eslint-plugin": "^4.33.0",
+    "@typescript-eslint/parser": "^4.33.0",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "husky": "^7.0.2",
+    "jest": "^27.2.1",
+    "lint-staged": "^11.2.0",
+    "prettier": "^2.4.1",
+    "ts-jest": "^27.0.5",
+    "typescript": "^4.4.3"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "lint-staged": {
+    "*.ts": "npm run lint"
+  }
+}