feat(prisma): add i18n support for translating error messages and acc…

…ess operations

feat(prisma): introduce translate function to provide human-readable error messages
feat(index.ts): implement translation function for RBAC error messages
feat(types.ts): add translate function to RBACOptions and ExecuteRBACParams interfaces

readme.md

@@ -12,8 +12,9 @@ It also allows defining permissions on a per-user basis. This makes it suitable
 ## Features
 - **Easy Integration**: You can add this library to your Prisma client without much hassle, making it easy to start using role-based access control in your application.
 - **Fine-Grained Control**: This feature lets you set up detailed permissions for different actions on different models. For example, you can allow some users to read data but not update it, while others can do both.
-- **Mismatch Handling**: If the permissions in your application don't match the current settings (maybe because of changes in production), this feature helps identify and fix those issues automatically, making maintenance easier.
-- **Synonym Support**: In Prisma schemas, relationships between models can have different names. For example, you might have a model note that is referred to as notes in another model's relationship. This feature manages permissions for these synonyms.
+- **Mismatch Handler**: If the permissions in your application don't match the current settings (maybe because of changes in production), this feature helps identify and fix those issues, making maintenance easier.
+- **Support for Synonyms**: In Prisma schemas, relationships between models can have different names. For example, you might have a model note that is referred to as notes in another model's relationship. This feature manages permissions for these synonyms.
+- **I18n**: Pass translation function to get human readable error messages.
 
 
 ## Installation
@@ -112,6 +113,30 @@ app.post('/notes', async (req, res) => {
 | `allowedActions` | `Array<string>`               | Lists the operations that are publicly accessible without RBAC checks.                           |
 | `synonyms`          | `Record<string, string[]>`    | Maps model synonyms to their actual model names, useful for handling schema relation mismatches.  |
 | `mismatchHandler`  | `(mismatch: string[]) => void`| Handles cases where users don't have permissions or permission models have changed, simplifying maintenance and fixing discrepancies. |
+| `translate`        | `(key: TranslationKeys, options?: Record<string, unknown>) => string` | Optional i18next function to return access errors in human language. |
+
+### i18n
+The i18n should have structure similar to this to work:
+
+```json
+{
+  "errors": {
+    "noPermission": "คุณไม่มีสิทธิ์ในการดำเนินการ {{operation}} บน {{model}}."
+  },
+  "operations": {
+    "read": "อ่าน",
+    "create": "สร้าง",
+    "update": "อัปเดต",
+    "delete": "ลบ"
+  },
+  "models": {
+    "User": "ผู้ใช้",
+    "Post": "โพสต์",
+    "Comment": "ความคิดเห็น"
+  }
+}
+```
+
 
 ### Performance
 Prisma-RBAC is optimized for performance, ensuring minimal overhead on your application's data access operations. Internal functions have been benchmarked to execute quickly (~0.003 ms), even under heavy load.

src/index.ts

@@ -40,6 +40,7 @@ const operationToActionMap: Record<string, CRUDOperations> = Object.fromEntries(
 );
 
 export function applyRBAC<T>({
+  translate = (key, options) => key,
   restrictedModels = [],
   allowedActions = [],
   mismatchHandler,
@@ -67,6 +68,7 @@ export function applyRBAC<T>({
             restrictedModels,
             allowedActions,
             permissions,
+            translate,
             synonyms,
           }),
       },
@@ -79,6 +81,7 @@ function processRBAC({
   allowedActions,
   permissions,
   operation,
+  translate,
   synonyms,
   model,
   query,
@@ -92,11 +95,11 @@ function processRBAC({
   }
 
   if (!isPermissionGranted(permissions, action, model)) {
-    throw new Error("No permission");
+    throw new RBACError(action, model, translate);
   }
 
   if (!validateNestedPermissions({ permissions, synonyms, model, args })) {
-    throw new Error("No permission");
+    throw new RBACError(action, model, translate);
   }
 
   return query(args);
@@ -158,3 +161,21 @@ export function mapModelAlias(
 
   return model;
 }
+
+class RBACError extends Error {
+  constructor(
+    public operation: CRUDOperations,
+    public model: string,
+    translate?: (key: string, options?: Record<string, unknown>) => string,
+  ) {
+    super();
+    this.name = "RBACError";
+    const translateFn = translate || ((key: string) => key);
+    const translatedOperation = translateFn(`operations.${operation}`);
+    const translatedModel = translateFn(`models.${model}`);
+    this.message = translateFn("errors.noPermission", {
+      operation: translatedOperation,
+      model: translatedModel,
+    });
+  }
+}

src/types.ts

@@ -5,6 +5,7 @@ export interface ResourcePermissions {
 }
 
 export interface RBACOptions<T> {
+  translate?: (key: string, options?: Record<string, unknown>) => string;
   permissions: ResourcePermissions | undefined | null;
   restrictedModels?: (undefined | string | any)[];
   mismatchHandler?: (mismatch: string[]) => void;
@@ -36,6 +37,7 @@ export interface CheckNestedPermissionsParams {
 }
 
 export interface ExecuteRBACParams {
+  translate?: (key: string, options?: Record<string, unknown>) => string;
   permissions: ResourcePermissions | undefined | null;
   restrictedModels: (undefined | string | any)[];
   synonyms?: Record<string, string[]>;