@hestia-earth/api 0.24.27 → 0.24.28

package/dist/files/model/model.d.ts

@@ -174,7 +174,7 @@ export declare const isAuthorized: ({ authorizedUsers }: Partial<File>, user: Us
 export declare const isAssigned: ({ assignedUsers }: Partial<File>, user: User) => boolean;
 export declare const canRemove: (file: Partial<File>, user: User) => boolean;
 export declare const validatedStatuses: FileStatus[];
-export declare const canValidate: ({ status, isPrivate, archived }: Partial<File>, user: Partial<User>) => boolean;
+export declare const canValidate: ({ status, isPrivate, archived }: Partial<File>, user: Pick<User, 'role'>) => boolean;
 export declare const isValidated: ({ validatedAt, status }: Partial<File>) => boolean;
 export declare const canSubmit: (file: Partial<File>, user: User) => boolean;
 export declare const canFeedback: ({ status }: File) => boolean;

package/dist/users/model/model.d.ts

@@ -11,6 +11,15 @@ export declare enum UserRole {
     Reviewer = "reviewer",
     Admin = "admin"
 }
+export declare enum UserPermission {
+    aggregationsCreate = "aggregations-create",
+    aggregationsRead = "aggregations-read",
+    aggregationsDelete = "aggregations-delete",
+    reconciliationsCreate = "reconciliations-create",
+    reconciliationsRead = "reconciliations-view",
+    reconciliationsUpdate = "reconciliations-update",
+    reconciliationsDelete = "reconciliations-delete"
+}
 export declare class User extends BaseModel {
     email: string;
     firstName: string;
@@ -24,6 +33,7 @@ export declare class User extends BaseModel {
     dataPrivate: boolean;
     validFilesCount: number;
     canCommitHestiaData: boolean;
+    permissions: UserPermission[];
     emailNotificationsSuccess: boolean;
     emailNotificationsFailure: boolean;
     emailNotificationsFeedback: boolean;
@@ -44,9 +54,10 @@ export declare class User extends BaseModel {
     readonly actorId?: string;
 }
 export declare const name: ({ firstName, lastName }: Partial<User>) => string;
-export declare const isAdmin: (user?: Partial<User>) => boolean;
-export declare const isReviewer: (user?: Partial<User>) => boolean;
-export declare const isDeveloper: (user?: Partial<User>) => boolean;
+export declare const isAdmin: (user?: Pick<User, 'role'>) => boolean;
+export declare const isReviewer: (user?: Pick<User, 'role'>) => boolean;
+export declare const isDeveloper: (user?: Pick<User, 'role'>) => boolean;
+export declare const hasPermission: (permission: UserPermission, user?: Pick<User, 'role' | 'permissions'>) => boolean;
 export declare const contains: (users: Partial<User>[], user: Partial<User>) => boolean;
 export declare const actorId: (user: Partial<User>) => string;
 export declare const userToActor: (user: Partial<User>, domain?: string) => Partial<IActorJSONLD>;

package/dist/users/model/model.js

@@ -26,7 +26,7 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.userToActor = exports.actorId = exports.contains = exports.isDeveloper = exports.isReviewer = exports.isAdmin = exports.name = exports.User = exports.UserRole = exports.MaxUploads = exports.defaultMaxApiCalls = void 0;
+exports.userToActor = exports.actorId = exports.contains = exports.hasPermission = exports.isDeveloper = exports.isReviewer = exports.isAdmin = exports.name = exports.User = exports.UserPermission = exports.UserRole = exports.MaxUploads = exports.defaultMaxApiCalls = void 0;
 var schema_1 = require("@hestia-earth/schema");
 var model_base_1 = require("../../db/model.base");
 exports.defaultMaxApiCalls = 100;
@@ -42,6 +42,16 @@ var UserRole;
     UserRole["Reviewer"] = "reviewer";
     UserRole["Admin"] = "admin";
 })(UserRole = exports.UserRole || (exports.UserRole = {}));
+var UserPermission;
+(function (UserPermission) {
+    UserPermission["aggregationsCreate"] = "aggregations-create";
+    UserPermission["aggregationsRead"] = "aggregations-read";
+    UserPermission["aggregationsDelete"] = "aggregations-delete";
+    UserPermission["reconciliationsCreate"] = "reconciliations-create";
+    UserPermission["reconciliationsRead"] = "reconciliations-view";
+    UserPermission["reconciliationsUpdate"] = "reconciliations-update";
+    UserPermission["reconciliationsDelete"] = "reconciliations-delete";
+})(UserPermission = exports.UserPermission || (exports.UserPermission = {}));
 var User = (function (_super) {
     __extends(User, _super);
     function User() {
@@ -52,6 +62,7 @@ var User = (function (_super) {
         _this.dataPrivate = false;
         _this.validFilesCount = 0;
         _this.canCommitHestiaData = false;
+        _this.permissions = [];
         _this.emailNotificationsSuccess = false;
         _this.emailNotificationsFailure = false;
         _this.emailNotificationsFeedback = false;
@@ -74,6 +85,8 @@ var isDeveloper = function (user) {
     return [UserRole.Developer, UserRole.Reviewer, UserRole.Admin].includes(user === null || user === void 0 ? void 0 : user.role);
 };
 exports.isDeveloper = isDeveloper;
+var hasPermission = function (permission, user) { var _a; return (0, exports.isAdmin)(user) || ((_a = user === null || user === void 0 ? void 0 : user.permissions) !== null && _a !== void 0 ? _a : []).includes(permission); };
+exports.hasPermission = hasPermission;
 var contains = function (users, user) { return users.some(function (u) { return u.email === user.email; }); };
 exports.contains = contains;
 var actorId = function (user) { return "".concat((user._id || user.id).toString()); };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/api",
-  "version": "0.24.27",
+  "version": "0.24.28",
   "description": "Hestia API definitions",
   "main": "dist/models.js",
   "typings": "dist/models.d.ts",
@@ -52,6 +52,7 @@
     "@types/cors": "^2.8.12",
     "@types/express": "4.17.6",
     "@types/express-serve-static-core": "4.17.5",
+    "@types/jsonwebtoken": "^9.0.6",
     "@types/lodash.get": "^4.4.6",
     "@types/lodash.orderby": "^4.6.6",
     "@types/lodash.pick": "^4.4.6",
@@ -86,6 +87,7 @@
     "http2-express-bridge": "^1.0.7",
     "husky": "^4.3.8",
     "js-levenshtein": "^1.1.6",
+    "jsonwebtoken": "^9.0.2",
     "lodash.get": "^4.4.2",
     "lodash.orderby": "^4.6.0",
     "lodash.pick": "^4.4.0",