@wxn0brp/gate-warden 0.5.1 → 0.5.3

package/dist/check.js

@@ -1,6 +1,7 @@
 import hasFieldsAdvanced from "@wxn0brp/db-core/utils/hasFieldsAdvanced";
 import { COLORS } from "./log.js";
 import { convertPath } from "./utils.js";
+import { collections } from "./const.js";
 /**
  * Checks if a user has the given flag on the given entity by checking the entity's ACL.
  * @param db The DB instance
@@ -13,9 +14,9 @@ import { convertPath } from "./utils.js";
  *   - -1 if the entity does not have an ACL
  */
 export async function aclCheck({ db, entityId, flag, user }) {
-    if (!await db.issetCollection("acl/" + entityId))
+    if (!await db.issetCollection(collections.acl + "/" + entityId))
         return -1;
-    const rules = await db.find("acl/" + entityId, {
+    const rules = await db.find(collections.acl + "/" + entityId, {
         $or: [
             { uid: user._id },
             {
@@ -43,7 +44,7 @@ export async function aclCheck({ db, entityId, flag, user }) {
  */
 export async function rbacCheck({ db, flag, user, entityId }) {
     for (const role of user.roles) {
-        const rolesEntity = await db.find("role/" + role, { _id: entityId });
+        const rolesEntity = await db.find(collections.role + "/" + role, { _id: entityId });
         for (const entity of rolesEntity) {
             if (entity.p & flag)
                 return true;
@@ -61,9 +62,9 @@ export async function rbacCheck({ db, flag, user, entityId }) {
  * @returns `true` if access is granted, `false` otherwise
  */
 export async function abacCheck({ db, entityId, flag, user, debugLog }) {
-    if (!await db.issetCollection("abac/" + entityId))
+    if (!await db.issetCollection(collections.abac + "/" + entityId))
         return false;
-    const rules = await db.find("abac/" + entityId, { flag });
+    const rules = await db.find(collections.abac + "/" + entityId, { flag });
     if (rules.length === 0)
         return false;
     for (const rule of rules) {

package/dist/const.d.ts

@@ -0,0 +1,7 @@
+export declare const collections: {
+    users: string;
+    roles: string;
+    acl: string;
+    role: string;
+    abac: string;
+};

package/dist/const.js

@@ -0,0 +1,7 @@
+export const collections = {
+    users: "users",
+    roles: "roles",
+    acl: "acl",
+    role: "role",
+    abac: "abac"
+};

package/dist/log.d.ts

@@ -1,4 +1,4 @@
-import Id from "@wxn0brp/db-core/types/Id";
+import { Id } from "@wxn0brp/db-core/types/Id";
 export declare const COLORS: {
     reset: string;
     green: string;

package/dist/mgr.d.ts

@@ -1,12 +1,12 @@
 import { Id, ValtheraCompatible } from "@wxn0brp/db-core";
-import { ABACRule, ACLRule, Role, RoleEntity } from "./types/system.js";
+import { ABACRule, ACLRule, Role, RoleRule } from "./types/system.js";
 export declare class WardenManager {
     private db;
     constructor(db: ValtheraCompatible);
     changeRoleNameToId(name: string): Promise<Id>;
     addRole(role: Role | Omit<Role, "_id">): Promise<Role>;
     addACLRule(entityId: string, p: number, uid?: Id): Promise<ACLRule>;
-    addRBACRule(role_id: string, entity_id: string, p: number): Promise<RoleEntity>;
+    addRBACRule(role_id: string, entity_id: string, p: number): Promise<RoleRule>;
     addABACRule(entity_id: string, flag: number, condition: ABACRule["condition"]): Promise<ABACRule>;
     removeRole(roleId: string): Promise<boolean>;
     removeACLRule(entityId: string, uid?: string): Promise<boolean>;

package/dist/mgr.js

@@ -1,39 +1,40 @@
+import { collections } from "./const.js";
 export class WardenManager {
     db;
     constructor(db) {
         this.db = db;
     }
     async changeRoleNameToId(name) {
-        return await this.db.findOne("roles", { name }).then((r) => r._id);
+        return await this.db.findOne(collections.roles, { name }).then((r) => r._id);
     }
     // ADD
     async addRole(role) {
-        return await this.db.add("roles", role);
+        return await this.db.add(collections.roles, role);
     }
     async addACLRule(entityId, p, uid) {
         const rule = { p };
         if (uid)
             rule.uid = uid;
-        return await this.db.add("acl/" + entityId, rule, false);
+        return await this.db.add(collections.acl + "/" + entityId, rule, false);
     }
     async addRBACRule(role_id, entity_id, p) {
-        return await this.db.add("role/" + role_id, { _id: entity_id, p }, false);
+        return await this.db.add(collections.role + "/" + role_id, { _id: entity_id, p }, false);
     }
     async addABACRule(entity_id, flag, condition) {
-        return await this.db.add("abac/" + entity_id, { flag, condition }, true);
+        return await this.db.add(collections.abac + "/" + entity_id, { flag, condition }, true);
     }
     // DELETE
     async removeRole(roleId) {
-        return await this.db.removeOne("roles", { roleId });
+        return await this.db.removeOne(collections.roles, { _id: roleId });
     }
     async removeACLRule(entityId, uid) {
         const q = uid ? { uid } : { $not: { $exists: { "uid": true } } };
-        return await this.db.removeOne("acl/" + entityId, q);
+        return await this.db.removeOne(collections.acl + "/" + entityId, q);
     }
     async removeRBACRule(roleId, entityId) {
-        return await this.db.removeOne("role/" + roleId, { _id: entityId });
+        return await this.db.removeOne(collections.role + "/" + roleId, { _id: entityId });
     }
     async removeABACRule(entityId, flag) {
-        return await this.db.removeOne("abac/" + entityId, { flag });
+        return await this.db.removeOne(collections.abac + "/" + entityId, { flag });
     }
 }

package/dist/types/check.d.ts

@@ -1,5 +1,5 @@
 import { ValtheraCompatible } from "@wxn0brp/db-core";
-import Id from "@wxn0brp/db-core/types/Id";
+import { Id } from "@wxn0brp/db-core/types/Id";
 import { User } from "./system.js";
 export interface CheckParams {
     db: ValtheraCompatible;

package/dist/types/system.d.ts

@@ -4,7 +4,7 @@ export interface Role {
     _id: Id;
     name: string;
 }
-export interface RoleEntity {
+export interface RoleRule {
     _id: Id;
     p: number;
 }

package/dist/user.js

@@ -1,3 +1,4 @@
+import { collections } from "./const.js";
 export class UserManager {
     db;
     constructor(db) {
@@ -13,7 +14,7 @@ export class UserManager {
             roles: userData.roles || [],
             attrib: userData.attrib || {},
         };
-        return await this.db.add("users", newUser, false);
+        return await this.db.add(collections.users, newUser, false);
     }
     /**
      * Retrieves a user by _id
@@ -21,7 +22,7 @@ export class UserManager {
      * @returns User or null if it doesn't exist
      */
     async getUser(user_id) {
-        return this.db.findOne("users", { _id: user_id });
+        return this.db.findOne(collections.users, { _id: user_id });
     }
     /**
      * Updates a user's data
@@ -33,14 +34,14 @@ export class UserManager {
         if (!existingUser)
             throw new Error("User not found");
         const updatedUser = { ...existingUser, ...updates };
-        await this.db.update("users", { _id: user_id }, updatedUser);
+        await this.db.update(collections.users, { _id: user_id }, updatedUser);
     }
     /**
      * Deletes a user
      * @param user_id User _id
      */
     async deleteUser(user_id) {
-        await this.db.removeOne("users", { _id: user_id });
+        await this.db.removeOne(collections.users, { _id: user_id });
     }
     /**
      * Adds a role to a user
@@ -53,7 +54,7 @@ export class UserManager {
             throw new Error("User not found");
         if (!user.roles.includes(role_id)) {
             user.roles.push(role_id);
-            await this.db.update("users", { _id: user_id }, user);
+            await this.db.update(collections.users, { _id: user_id }, user);
         }
     }
     /**
@@ -68,7 +69,7 @@ export class UserManager {
         const index = user.roles.indexOf(role_id);
         if (index !== -1) {
             user.roles.splice(index, 1);
-            await this.db.update("users", { _id: user_id }, user);
+            await this.db.update(collections.users, { _id: user_id }, user);
         }
     }
     /**
@@ -81,6 +82,6 @@ export class UserManager {
         if (!user)
             throw new Error("User not found");
         user.attrib = { ...user.attrib, ...attributes };
-        await this.db.update("users", { _id: user_id }, user);
+        await this.db.update(collections.users, { _id: user_id }, user);
     }
 }

package/dist/warden.js

@@ -1,7 +1,8 @@
 import { abacCheck, aclCheck, rbacCheck } from "./check.js";
 import { COLORS, logAccess } from "./log.js";
+import { collections } from "./const.js";
 export async function fetchUser(db, userId) {
-    const user = await db.findOne("users", { _id: userId });
+    const user = await db.findOne(collections.users, { _id: userId });
     if (!user)
         throw new Error("User not found");
     return user;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wxn0brp/gate-warden",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "wxn0brP",
@@ -15,12 +15,12 @@
   "devDependencies": {
     "@types/bun": "*",
     "@types/node": "*",
-    "@wxn0brp/db-core": "^0.3.0",
+    "@wxn0brp/db-core": "^0.4.0",
     "tsc-alias": "*",
     "typescript": "*"
   },
   "peerDependencies": {
-    "@wxn0brp/db-core": ">=0.3.0"
+    "@wxn0brp/db-core": ">=0.4.0"
   },
   "files": [
     "dist"