FEAT: internationalization of permissions

src/authentication/authentication.guard.spec.ts

@@ -13,7 +13,7 @@ import {
   RequireSomePermission,
 } from './authentication.decorator';
 import { AuthenticationGuard } from './authentication.guard';
-import { Permissions } from './permissions.enum';
+import { PERMISSIONS } from './permissions.enum';
 import { AuthClientService } from '../modules/auth/auth.service';
 
 import ErrorCodes from '../utils/errorCodes';
@@ -32,19 +32,19 @@ class NoClassAuthController {
   }
 
   @Get('required-permission')
-  @RequireSomePermission(Permissions.ZENDESK.OPEN)
+  @RequireSomePermission(PERMISSIONS.ZENDESK.OPEN)
   async requiredPermission(@Body() body) {
     return { body };
   }
 
   @Get('has-all-permissions')
-  @RequireAllPermissions(Permissions.ZENDESK.OPEN, Permissions.METABASE.OPEN)
+  @RequireAllPermissions(PERMISSIONS.ZENDESK.OPEN, PERMISSIONS.METABASE.OPEN)
   async hasAllPermissions(@Body() body) {
     return { body };
   }
 
   @Get('has-some-permission')
-  @RequireSomePermission(Permissions.ZENDESK.OPEN, Permissions.METABASE.OPEN)
+  @RequireSomePermission(PERMISSIONS.ZENDESK.OPEN, PERMISSIONS.METABASE.OPEN)
   async hasSomePermission(@Body() body) {
     return { body };
   }
@@ -52,7 +52,7 @@ class NoClassAuthController {
 
 @Controller('class-auth-condition')
 @AuthenticateCondition((req) => req.get('x-on-class') === 'ok')
-@RequireSomePermission(Permissions.METABASE.OPEN)
+@RequireSomePermission(PERMISSIONS.METABASE.OPEN)
 class ClassAuthConditionController {
   @Get('body')
   async getBody(@Body() body) {
@@ -67,7 +67,7 @@ class ClassAuthConditionController {
 
   @Get('required-permission')
   @AuthenticateCondition((req) => req.get('x-on-route') === 'ok')
-  @RequireSomePermission(Permissions.ZENDESK.OPEN)
+  @RequireSomePermission(PERMISSIONS.ZENDESK.OPEN)
   async requiredPermission(@Body() body) {
     return { body };
   }
@@ -430,17 +430,17 @@ describe('authentication.guard', () => {
   NoClassAuthTest(null, null);
   ClassAuthConditionTest(null, null);
 
-  const tokenZ = CreateToken([Permissions.ZENDESK.OPEN]);
+  const tokenZ = CreateToken([PERMISSIONS.ZENDESK.OPEN]);
   NoClassAuthTest(tokenZ, ['zendesk']);
   ClassAuthConditionTest(tokenZ, ['zendesk']);
 
-  const tokenM = CreateToken([Permissions.METABASE.OPEN]);
+  const tokenM = CreateToken([PERMISSIONS.METABASE.OPEN]);
   NoClassAuthTest(tokenM, ['metabase']);
   ClassAuthConditionTest(tokenM, ['metabase']);
 
   const tokenZM = CreateToken([
-    Permissions.ZENDESK.OPEN,
-    Permissions.METABASE.OPEN,
+    PERMISSIONS.ZENDESK.OPEN,
+    PERMISSIONS.METABASE.OPEN,
   ]);
   NoClassAuthTest(tokenZM, ['zendesk', 'metabase']);
   ClassAuthConditionTest(tokenZM, ['zendesk', 'metabase']);

src/authentication/permissions.enum.ts

@@ -12,7 +12,17 @@ export interface Permission {
   seqid: number;
   claim: string;
   usage: PermissionUsages;
-  name?: string;
+  name?: {
+    'pt-br': string;
+    'en-us': string;
+  };
+}
+export interface PermissionGroup {
+  title: {
+    'pt-br': string;
+    'en-us': string;
+  };
+  permissions: Record<string, Permission>;
 }
 
 /*
@@ -23,224 +33,406 @@ export interface Permission {
 /*export const Permissions: {
   [P in keyof any]: { [Q in keyof any]: Permission };
 } = {*/
-export const Permissions: Record<any, Record<string, Permission>> = {
+export const PERMISSIONS = {
   AUTH: {
-    CREATE: {
-      seqid: 18,
-      claim: 'POST /auth',
-      usage: PermissionUsages.PUBLIC,
+    title: {
+      'pt-br': 'Autenticação',
+      'en-us': 'Authentication',
+    },
+    permissions: {
+      CREATE: {
+        seqid: 18,
+        claim: 'POST /auth',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': '',
+          'en-us': '',
+        },
+      },
     },
   },
 
   PIPELINE: {
-    CREATE: {
-      seqid: 23,
-      claim: 'pipeline:create',
-      usage: PermissionUsages.PUBLIC,
-      name: 'PERMISSIONS.NAMES.PIPELINE_CREATE',
+    title: {
+      'pt-br': 'Pipelines',
+      'en-us': 'Pipelines',
     },
-    GET: {
-      seqid: 13,
-      claim: 'pipeline:get',
-      usage: PermissionUsages.PUBLIC,
-      name: 'PERMISSIONS.NAMES.PIPELINE_GET',
-    },
-    UPDATE: {
-      seqid: 29,
-      claim: 'pipeline:update',
-      usage: PermissionUsages.PUBLIC,
-      name: 'PERMISSIONS.NAMES.PIPELINE_PUT',
-    },
-    DELETE: {
-      seqid: 5,
-      claim: 'pipeline:delete',
-      usage: PermissionUsages.PUBLIC,
-      name: 'PERMISSIONS.NAMES.PIPELINE_DELETE',
+    permissions: {
+      CREATE: {
+        seqid: 23,
+        claim: 'POST /pipelines',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Criar pipelines',
+          'en-us': 'Create pipelines',
+        },
+      },
+      GET: {
+        seqid: 13,
+        claim: 'GET /pipelines',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Buscar pipelines',
+          'en-us': 'Get pipelines',
+        },
+      },
+      UPDATE: {
+        seqid: 29,
+        claim: 'PUT /pipelines',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Atualizar pipeline',
+          'en-us': 'Update pipeline',
+        },
+      },
+      DELETE: {
+        seqid: 5,
+        claim: 'DELETE /pipelines',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Remover pipeline',
+          'en-us': 'Delete pipeline',
+        },
+      },
     },
   },
 
   INPUT: {
-    CREATE: {
-      seqid: 21,
-      claim: 'POST /inputs',
-      usage: PermissionUsages.PUBLIC,
-      name: 'Criar conexões',
+    title: {
+      'pt-br': 'Conexões',
+      'en-us': 'Connections',
     },
-    GET: {
-      seqid: 9,
-      claim: 'GET /inputs',
-      usage: PermissionUsages.PUBLIC,
-      name: 'Buscar conexões',
-    },
-    UPDATE: {
-      seqid: 27,
-      claim: 'PUT /inputs',
-      usage: PermissionUsages.PUBLIC,
-      name: 'Atualizar conexões',
-    },
-    UPDATE_PARTIAL: {
-      seqid: 17,
-      claim: 'PATCH /inputs',
-      usage: PermissionUsages.PUBLIC,
-      name: 'Atualizar conexões',
-    },
-    DELETE: {
-      seqid: 3,
-      claim: 'DELETE /inputs',
-      usage: PermissionUsages.PUBLIC,
-    },
-    GET_ENTITIES: {
-      seqid: 10,
-      claim: 'GET /inputs/available-entities',
-      usage: PermissionUsages.PUBLIC,
+    permissions: {
+      CREATE: {
+        seqid: 21,
+        claim: 'POST /inputs',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Criar conexões',
+          'en-us': 'Create connections',
+        },
+      },
+      GET: {
+        seqid: 9,
+        claim: 'GET /inputs',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Buscar conexões',
+          'en-us': 'Get connections',
+        },
+      },
+      UPDATE: {
+        seqid: 27,
+        claim: 'PUT /inputs',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Atualizar conexões',
+          'en-us': 'Create connections',
+        },
+      },
+      DELETE: {
+        seqid: 3,
+        claim: 'DELETE /inputs',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Remover conexões',
+          'en-us': 'Delete connections',
+        },
+      },
+      GET_ENTITIES: {
+        seqid: 10,
+        claim: 'GET /inputs/available-entities',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Remover conexões',
+          'en-us': 'Delete connections',
+        },
+      },
     },
   },
 
   OUTPUT: {
-    CREATE: {
-      seqid: 22,
-      claim: 'POST /outputs',
-      usage: PermissionUsages.PUBLIC,
+    title: {
+      'pt-br': 'Output',
+      'en-us': 'Output',
     },
-    GET: {
-      seqid: 12,
-      claim: 'GET /outputs',
-      usage: PermissionUsages.PUBLIC,
-    },
-    UPDATE: {
-      seqid: 28,
-      claim: 'PUT /outputs',
-      usage: PermissionUsages.PUBLIC,
-    },
-    DELETE: {
-      seqid: 4,
-      claim: 'DELETE /outputs',
-      usage: PermissionUsages.PUBLIC,
+    permissions: {
+      CREATE: {
+        seqid: 22,
+        claim: 'POST /outputs',
+        usage: PermissionUsages.INTERNAL,
+        name: {
+          'pt-br': 'Criar outputs',
+          'en-us': 'Create outputs',
+        },
+      },
+      GET: {
+        seqid: 12,
+        claim: 'GET /outputs',
+        usage: PermissionUsages.INTERNAL,
+        name: {
+          'pt-br': 'Buscar outputs',
+          'en-us': 'Get outputs',
+        },
+      },
+      UPDATE: {
+        seqid: 28,
+        claim: 'PUT /outputs',
+        usage: PermissionUsages.INTERNAL,
+        name: {
+          'pt-br': 'Editar outputs',
+          'en-us': 'Edit outputs',
+        },
+      },
+      DELETE: {
+        seqid: 4,
+        claim: 'DELETE /outputs',
+        usage: PermissionUsages.INTERNAL,
+        name: {
+          'pt-br': 'Remover outputs',
+          'en-us': 'Remove outputs',
+        },
+      },
     },
   },
 
   TRANSFORMATIONS: {
-    CREATE: {
-      seqid: 24,
-      claim: 'POST /transformations',
-      usage: PermissionUsages.PUBLIC,
+    title: {
+      'pt-br': 'Micro-transformações',
+      'en-us': 'Micro-transformations',
     },
-    GET: {
-      seqid: 15,
-      claim: 'GET /transformations',
-      usage: PermissionUsages.PUBLIC,
-    },
-    UPDATE: {
-      seqid: 30,
-      claim: 'PUT /transformations',
-      usage: PermissionUsages.PUBLIC,
-    },
-    DELETE: {
-      seqid: 6,
-      claim: 'DELETE /transformations',
-      usage: PermissionUsages.PUBLIC,
+    permissions: {
+      CREATE: {
+        seqid: 24,
+        claim: 'POST /transformations',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Criar micro-transformações',
+          'en-us': 'Create micro-transformations',
+        },
+      },
+      GET: {
+        seqid: 15,
+        claim: 'GET /transformations',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Buscar micro-transformações',
+          'en-us': 'Get micro-transformations',
+        },
+      },
+      UPDATE: {
+        seqid: 30,
+        claim: 'PUT /transformations',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Editar micro-transformações',
+          'en-us': 'Edit micro-transformations',
+        },
+      },
+      DELETE: {
+        seqid: 6,
+        claim: 'DELETE /transformations',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Remover micro-transformações',
+          'en-us': 'Remove micro-transformations',
+        },
+      },
     },
   },
 
   CATALOG: {
-    CREATE: {
-      seqid: 19,
-      claim: 'POST /catalog',
-      usage: PermissionUsages.PUBLIC,
+    title: {
+      'pt-br': 'Catálogo',
+      'en-us': 'Catalog',
     },
-    GET: {
-      seqid: 7,
-      claim: 'GET /catalog',
-      usage: PermissionUsages.PUBLIC,
-    },
-    UPDATE: {
-      seqid: 25,
-      claim: 'PUT /catalog',
-      usage: PermissionUsages.PUBLIC,
-    },
-    DELETE: {
-      seqid: 1,
-      claim: 'DELETE /catalog',
-      usage: PermissionUsages.PUBLIC,
+    permissions: {
+      CREATE: {
+        seqid: 19,
+        claim: 'POST /catalog',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Criar atributos no catálogo',
+          'en-us': 'Create catalog attributes',
+        },
+      },
+      GET: {
+        seqid: 7,
+        claim: 'GET /catalog',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Buscar catálogos',
+          'en-us': 'Get catalogs',
+        },
+      },
+      UPDATE: {
+        seqid: 25,
+        claim: 'PUT /catalog',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Editar catálogo',
+          'en-us': 'Edit catalogs',
+        },
+      },
+      DELETE: {
+        seqid: 1,
+        claim: 'DELETE /catalog',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Remover catálogo',
+          'en-us': 'Remove catalogs',
+        },
+      },
     },
   },
 
   CONNECTORS: {
-    CREATE: {
-      seqid: 20,
-      claim: 'POST /connectors',
-      usage: PermissionUsages.PUBLIC,
+    title: {
+      'pt-br': 'Conectores',
+      'en-us': 'Connectors',
     },
-    GET: {
-      seqid: 8,
-      claim: 'GET /connectors',
-      usage: PermissionUsages.PUBLIC,
-    },
-    UPDATE: {
-      seqid: 26,
-      claim: 'PUT /connectors',
-      usage: PermissionUsages.PUBLIC,
-    },
-    DELETE: {
-      seqid: 2,
-      claim: 'DELETE /connectors',
-      usage: PermissionUsages.PUBLIC,
+    permissions: {
+      CREATE: {
+        seqid: 20,
+        claim: 'POST /connectors',
+        usage: PermissionUsages.INTERNAL,
+        name: {
+          'pt-br': 'Criar conectores',
+          'en-us': 'Create connectors',
+        },
+      },
+      GET: {
+        seqid: 8,
+        claim: 'GET /connectors',
+        usage: PermissionUsages.INTERNAL,
+        name: {
+          'pt-br': 'Buscar conectores',
+          'en-us': 'Get connectors',
+        },
+      },
+      UPDATE: {
+        seqid: 26,
+        claim: 'PUT /connectors',
+        usage: PermissionUsages.INTERNAL,
+        name: {
+          'pt-br': 'Editar conectores',
+          'en-us': 'Edit connectors',
+        },
+      },
+      DELETE: {
+        seqid: 2,
+        claim: 'DELETE /connectors',
+        usage: PermissionUsages.INTERNAL,
+        name: {
+          'pt-br': 'Remover conectores',
+          'en-us': 'Remove connectors',
+        },
+      },
     },
   },
 
   SNOWFLAKE: {
-    OPEN: {
-      seqid: 14,
-      claim: 'GET /snowflake',
-      usage: PermissionUsages.PUBLIC,
+    title: {
+      'pt-br': 'Snowflake',
+      'en-us': 'Snowflake',
+    },
+    permissions: {
+      OPEN: {
+        seqid: 14,
+        claim: 'GET /snowflake',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Acessar Snowflake',
+          'en-us': 'Access Snowflake',
+        },
+      },
     },
   },
 
   ZENDESK: {
-    OPEN: {
-      seqid: 16,
-      claim: 'GET /zendesk',
-      usage: PermissionUsages.PUBLIC,
+    title: {
+      'pt-br': 'Zendesk',
+      'en-us': 'Zendesk',
+    },
+    permissions: {
+      OPEN: {
+        seqid: 16,
+        claim: 'GET /zendesk',
+        usage: PermissionUsages.INTERNAL,
+        name: {
+          'pt-br': 'Acessar Zendesk',
+          'en-us': 'Access Zendesk',
+        },
+      },
     },
   },
 
   METABASE: {
-    OPEN: {
-      seqid: 11,
-      claim: 'GET /metabase',
-      usage: PermissionUsages.PUBLIC,
+    title: {
+      'pt-br': 'Metabase',
+      'en-us': 'Metabase',
+    },
+    permissions: {
+      OPEN: {
+        seqid: 11,
+        claim: 'GET /metabase',
+        usage: PermissionUsages.INTERNAL,
+        name: {
+          'pt-br': 'Acessar Metabase',
+          'en-us': 'Access Metabase',
+        },
+      },
     },
   },
 
   ORCHEST: {
-    INTELLIGENCE: {
-      seqid: 31,
-      claim: 'intelligence:open',
-      usage: PermissionUsages.PUBLIC,
+    title: {
+      'pt-br': 'Orchest',
+      'en-us': 'Orchest',
     },
-    APP_BUILDER: {
-      seqid: 32,
-      claim: 'app-builder:open',
-      usage: PermissionUsages.PUBLIC,
-    },
-    MACHINE_LEARNING: {
-      seqid: 33,
-      claim: 'machine-learning:open',
-      usage: PermissionUsages.PUBLIC,
+    permissions: {
+      INTELLIGENCE: {
+        seqid: 31,
+        claim: 'intelligence:open',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Acessar inteligência',
+          'en-us': 'Access intelligence',
+        },
+      },
+      APP_BUILDER: {
+        seqid: 32,
+        claim: 'app-builder:open',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Acessar App Builder',
+          'en-us': 'Access App Builder',
+        },
+      },
+      MACHINE_LEARNING: {
+        seqid: 33,
+        claim: 'machine-learning:open',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Acessar Machine Learning',
+          'en-us': 'Access Machine Learning',
+        },
+      },
     },
   },
 };
+export type PermissionsObject = typeof PERMISSIONS;
 
 // traverses the object searching for duplicate seqids or claims (executes at runtime)
 let nextAvailableSeqid = 0;
-const seqids = Object.values(Permissions).flatMap((namespace) =>
-  Object.values(namespace).map(({ seqid }) => seqid),
+const seqids = Object.values(PERMISSIONS).flatMap((namespace) =>
+  Object.values(namespace.permissions).map(({ seqid }) => seqid),
 );
-const claims = Object.values(Permissions).flatMap((namespace) =>
-  Object.values(namespace).map(({ claim }) => claim),
+const claims = Object.values(PERMISSIONS).flatMap((namespace) =>
+  Object.values(namespace.permissions).map(({ claim }) => claim),
 );
-Object.values(Permissions).map((namespace) =>
-  Object.values(namespace).map(({ seqid, claim }) => {
+Object.values(PERMISSIONS).map((namespace) =>
+  Object.values(namespace.permissions).map(({ seqid, claim }) => {
     const seqidsCount = seqids.filter((x) => x === seqid).length;
     assert(seqidsCount === 1, `seqid ${seqid} count is not 1`);
 

src/authentication/user.decorator.spec.ts

@@ -11,7 +11,7 @@ import { AuthClientService } from '../modules/auth/auth.service';
 
 import ErrorCodes from '../utils/errorCodes';
 import { User } from './user.decorator';
-import { Permissions } from './permissions.enum';
+import { PERMISSIONS } from './permissions.enum';
 
 @Controller('user')
 class UserController {
@@ -45,7 +45,7 @@ describe('user.decorator', () => {
   const fakeUserPayload = {
     user_id: 'd50d33c7-6c2b-463c-861f-e21667e7c125',
     username: 'super.admin',
-    permissions: [Permissions.METABASE.OPEN].map(({ seqid }) => seqid),
+    permissions: [PERMISSIONS.METABASE.OPEN].map(({ seqid }) => seqid),
     customer_id: '9d18e8ae-24b9-41a3-9e8f-a25ce57555b11',
     customer_name: 'dadosfera',
     customer_tier: 'BASIC',