@edular/permissions 3.2.5 → 4.0.0

package/lib/constants.d.ts

@@ -0,0 +1,48 @@
+export declare enum UserProfileType {
+    ApiKey = "api_key",
+    Admin = "admin",
+    Staff = "staff",
+    Student = "student",
+    Others = "others"
+}
+export declare type PermissionDetails = {
+    permissionId: number;
+    name: string;
+    departmentId?: number;
+    subunitId?: number;
+};
+export declare enum PermissionType {
+    View = "view",
+    Add = "add",
+    Edit = "edit",
+    Delete = "delete"
+}
+export declare enum DepartmentPermissionTarget {
+    DocumentsListView = "documents.list_view",
+    DocumentsDetailView = "documents.detail_view",
+    Activities = "activities",
+    Tasks = "tasks",
+    TasksAccessOthers = "tasks.access_others"
+}
+export declare const DepartmentPermissionTargetTypes: {
+    "documents.list_view": PermissionType[];
+    "documents.detail_view": PermissionType[];
+    activities: PermissionType[];
+    tasks: PermissionType[];
+    "tasks.access_others": PermissionType[];
+};
+export declare type ProfilePermissionsDetails = {
+    type: UserProfileType.Staff;
+    enabledPermissionIds: number[];
+    enabledDepartmentPermissionIds: number[];
+} | {
+    type: UserProfileType.Student;
+    enabledPermissionIds: number[];
+} | {
+    type: UserProfileType.Admin;
+} | {
+    type: UserProfileType.ApiKey;
+} | {
+    type: UserProfileType.Others;
+    enabledPermissionIds: number[];
+};

package/lib/constants.js

@@ -0,0 +1,53 @@
+"use strict";
+var _a;
+exports.__esModule = true;
+exports.DepartmentPermissionTargetTypes = exports.DepartmentPermissionTarget = exports.PermissionType = exports.UserProfileType = void 0;
+var UserProfileType;
+(function (UserProfileType) {
+    UserProfileType["ApiKey"] = "api_key";
+    UserProfileType["Admin"] = "admin";
+    UserProfileType["Staff"] = "staff";
+    UserProfileType["Student"] = "student";
+    UserProfileType["Others"] = "others";
+})(UserProfileType = exports.UserProfileType || (exports.UserProfileType = {}));
+var PermissionType;
+(function (PermissionType) {
+    PermissionType["View"] = "view";
+    PermissionType["Add"] = "add";
+    PermissionType["Edit"] = "edit";
+    PermissionType["Delete"] = "delete";
+})(PermissionType = exports.PermissionType || (exports.PermissionType = {}));
+var DepartmentPermissionTarget;
+(function (DepartmentPermissionTarget) {
+    DepartmentPermissionTarget["DocumentsListView"] = "documents.list_view";
+    DepartmentPermissionTarget["DocumentsDetailView"] = "documents.detail_view";
+    DepartmentPermissionTarget["Activities"] = "activities";
+    DepartmentPermissionTarget["Tasks"] = "tasks";
+    DepartmentPermissionTarget["TasksAccessOthers"] = "tasks.access_others";
+})(DepartmentPermissionTarget = exports.DepartmentPermissionTarget || (exports.DepartmentPermissionTarget = {}));
+exports.DepartmentPermissionTargetTypes = (_a = {},
+    _a[DepartmentPermissionTarget.DocumentsListView] = [PermissionType.View],
+    _a[DepartmentPermissionTarget.DocumentsDetailView] = [
+        PermissionType.View,
+        PermissionType.Add,
+        PermissionType.Edit,
+        PermissionType.Delete,
+    ],
+    _a[DepartmentPermissionTarget.Activities] = [
+        PermissionType.View,
+        PermissionType.Add,
+        PermissionType.Edit,
+        PermissionType.Delete,
+    ],
+    _a[DepartmentPermissionTarget.Tasks] = [
+        PermissionType.View,
+        PermissionType.Add,
+        PermissionType.Edit,
+        PermissionType.Delete,
+    ],
+    _a[DepartmentPermissionTarget.TasksAccessOthers] = [
+        PermissionType.View,
+        PermissionType.Edit,
+        PermissionType.Delete,
+    ],
+    _a);

package/lib/helpers.d.ts

@@ -0,0 +1,4 @@
+import { DepartmentPermissionTarget, PermissionDetails, PermissionType, ProfilePermissionsDetails } from './constants';
+export declare const checkIfProfileHasNeededPermissions: (profilePermissions: ProfilePermissionsDetails, permissionIds: number[]) => boolean;
+export declare const getEnabledPermissionsForTarget: (permissions: PermissionDetails[], target: DepartmentPermissionTarget, type: PermissionType) => PermissionDetails[];
+export declare const checkPermissionsForSubunits: (permissions: PermissionDetails[], target: DepartmentPermissionTarget, type: PermissionType, subunitIds: number[]) => boolean;

package/lib/helpers.js

@@ -0,0 +1,30 @@
+"use strict";
+exports.__esModule = true;
+exports.checkPermissionsForSubunits = exports.getEnabledPermissionsForTarget = exports.checkIfProfileHasNeededPermissions = void 0;
+var constants_1 = require("./constants");
+var checkIfProfileHasNeededPermissions = function (profilePermissions, permissionIds) {
+    if (permissionIds.length === 0) {
+        throw new Error("Permission IDs can't be an empty array");
+    }
+    if (profilePermissions.type === constants_1.UserProfileType.Admin ||
+        profilePermissions.type === constants_1.UserProfileType.ApiKey) {
+        return true;
+    }
+    return permissionIds.every(function (permissionId) {
+        return profilePermissions.enabledPermissionIds.includes(permissionId);
+    });
+};
+exports.checkIfProfileHasNeededPermissions = checkIfProfileHasNeededPermissions;
+var getEnabledPermissionsForTarget = function (permissions, target, type) {
+    return permissions.filter(function (permission) {
+        return permission.name.endsWith(target + "." + type);
+    });
+};
+exports.getEnabledPermissionsForTarget = getEnabledPermissionsForTarget;
+var checkPermissionsForSubunits = function (permissions, target, type, subunitIds) {
+    var enabledPermissions = (0, exports.getEnabledPermissionsForTarget)(permissions, target, type);
+    return subunitIds.every(function (subunitId) {
+        return enabledPermissions.find(function (permission) { return permission.subunitId === subunitId; });
+    });
+};
+exports.checkPermissionsForSubunits = checkPermissionsForSubunits;

package/lib/index.d.ts

@@ -1 +1,3 @@
 export * from './permissions';
+export * from './constants';
+export * from './helpers';

package/lib/index.js

@@ -11,3 +11,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 exports.__esModule = true;
 __exportStar(require("./permissions"), exports);
+__exportStar(require("./constants"), exports);
+__exportStar(require("./helpers"), exports);

package/lib/permissions.d.ts

@@ -610,6 +610,12 @@ export declare const Permissions: {
                 Edit: number;
                 Delete: number;
             };
+            Access: {
+                View: number;
+                Add: number;
+                Edit: number;
+                Delete: number;
+            };
         };
         Tasks: {
             Assigned: {

package/lib/permissions.js

@@ -612,6 +612,12 @@ exports.Permissions = {
                 Add: 2782,
                 Edit: 2783,
                 Delete: 2784
+            },
+            Access: {
+                View: 5911,
+                Add: 5912,
+                Edit: 5913,
+                Delete: 5914
             }
         },
         Tasks: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edular/permissions",
-  "version": "3.2.5",
+  "version": "4.0.0",
   "author": "Edular",
   "license": "MIT",
   "main": "lib/index.js",