@battle-racing/br-common-lib 1.0.1 → 1.1.0

package/dist/definitions/RoleDefinitions.d.ts

@@ -0,0 +1,2 @@
+import type { RoleDefinition } from '../types/role/RoleDefinition';
+export declare const ROLE_DEFINITIONS: RoleDefinition[];

package/dist/definitions/RoleDefinitions.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ROLE_DEFINITIONS = void 0;
+const Permission_1 = require("../types/role/Permission");
+const UserRole_1 = require("../types/role/UserRole");
+exports.ROLE_DEFINITIONS = [
+    {
+        role: UserRole_1.USER_ROLE.SUPER_ADMIN,
+        description: 'Complete access to all features and settings',
+        permissions: [
+            Permission_1.PERMISSIONS.FULL_ACCESS,
+            Permission_1.PERMISSIONS.KARTS_HARDWARE_TEST,
+            Permission_1.PERMISSIONS.KARTS_POWER_UP_TEST,
+            Permission_1.PERMISSIONS.GAME_TRACK_CONFIG_HARDWARE,
+            Permission_1.PERMISSIONS.GAME_TRACK_CONFIG_KARTS,
+            Permission_1.PERMISSIONS.GAME_TRACK_MANAGE_GAMES,
+            Permission_1.PERMISSIONS.KARTS_TRACKING,
+        ],
+    },
+    {
+        role: UserRole_1.USER_ROLE.OPERATOR,
+        description: 'Game Track Operator',
+        permissions: [Permission_1.PERMISSIONS.GAME_TRACK_MANAGE_GAMES],
+    },
+];

package/dist/definitions/index.d.ts

@@ -0,0 +1 @@
+export * from './RoleDefinitions';

package/dist/definitions/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./RoleDefinitions"), exports);

package/dist/index.d.ts

@@ -1,20 +1,3 @@
-/**
- * This types are shared wihin the 3 Repositories
- * Webapp, Backend and Raspberry
- */
-export * from './checkpoint';
-export * from './color';
-export * from './command';
-export * from './damage';
-export * from './flow';
-export * from './game';
-export * from './gameTrack';
-export * from './hardware';
-export * from './kart';
-export * from './kartTracking';
-export * from './powerUp';
-export * from './response';
-export * from './socket';
-export * from './sounds';
-export * from './user';
+export * from './definitions';
+export * from './types';
 export * from './utils';

package/dist/index.js

@@ -1,8 +1,4 @@
 "use strict";
-/**
- * This types are shared wihin the 3 Repositories
- * Webapp, Backend and Raspberry
- */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -18,19 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./checkpoint"), exports);
-__exportStar(require("./color"), exports);
-__exportStar(require("./command"), exports);
-__exportStar(require("./damage"), exports);
-__exportStar(require("./flow"), exports);
-__exportStar(require("./game"), exports);
-__exportStar(require("./gameTrack"), exports);
-__exportStar(require("./hardware"), exports);
-__exportStar(require("./kart"), exports);
-__exportStar(require("./kartTracking"), exports);
-__exportStar(require("./powerUp"), exports);
-__exportStar(require("./response"), exports);
-__exportStar(require("./socket"), exports);
-__exportStar(require("./sounds"), exports);
-__exportStar(require("./user"), exports);
+__exportStar(require("./definitions"), exports);
+__exportStar(require("./types"), exports);
 __exportStar(require("./utils"), exports);

package/dist/{damage → types/damage}/Damage.d.ts

@@ -1,4 +1,4 @@
-import type { KartEffect } from '../hardware';
+import type { FlagMediaName, KartEffect } from '../hardware';
 import type { SoundName } from '../sounds';
 import type { DamageEffectName } from './DamageName';
 import type { DamageTarget } from './DamageTarget';
@@ -11,4 +11,5 @@ export interface Damage {
     rgbEffect: KartEffect;
     /** Quantity of damage will affect the Kart */
     amount: number;
+    flagMediaName: FlagMediaName;
 }

package/dist/types/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This types are shared wihin the 3 Repositories
+ * Webapp, Backend and Raspberry
+ */
+export * from './checkpoint';
+export * from './color';
+export * from './command';
+export * from './damage';
+export * from './flow';
+export * from './game';
+export * from './gameTrack';
+export * from './hardware';
+export * from './kart';
+export * from './kartTracking';
+export * from './powerUp';
+export * from './response';
+export * from './role';
+export * from './socket';
+export * from './sounds';
+export * from './user';
+export * from './utils';

package/dist/types/index.js

@@ -0,0 +1,37 @@
+"use strict";
+/**
+ * This types are shared wihin the 3 Repositories
+ * Webapp, Backend and Raspberry
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./checkpoint"), exports);
+__exportStar(require("./color"), exports);
+__exportStar(require("./command"), exports);
+__exportStar(require("./damage"), exports);
+__exportStar(require("./flow"), exports);
+__exportStar(require("./game"), exports);
+__exportStar(require("./gameTrack"), exports);
+__exportStar(require("./hardware"), exports);
+__exportStar(require("./kart"), exports);
+__exportStar(require("./kartTracking"), exports);
+__exportStar(require("./powerUp"), exports);
+__exportStar(require("./response"), exports);
+__exportStar(require("./role"), exports);
+__exportStar(require("./socket"), exports);
+__exportStar(require("./sounds"), exports);
+__exportStar(require("./user"), exports);
+__exportStar(require("./utils"), exports);

package/dist/types/role/Permission.d.ts

@@ -0,0 +1,11 @@
+import type { ObjectValues } from '../utils';
+export declare const PERMISSIONS: {
+    readonly FULL_ACCESS: "FULL_ACCESS";
+    readonly KARTS_HARDWARE_TEST: "MANAGE_KARTS";
+    readonly KARTS_POWER_UP_TEST: "MANAGE_POWER_UPS";
+    readonly GAME_TRACK_MANAGE_GAMES: "MANAGE_GAMES";
+    readonly GAME_TRACK_CONFIG_KARTS: "CONFIG_KARTS";
+    readonly GAME_TRACK_CONFIG_HARDWARE: "CONFIG_HARDWARE";
+    readonly KARTS_TRACKING: "KARTS_TRACKING";
+};
+export type Permission = ObjectValues<typeof PERMISSIONS>;

package/dist/types/role/Permission.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PERMISSIONS = void 0;
+exports.PERMISSIONS = {
+    FULL_ACCESS: 'FULL_ACCESS',
+    KARTS_HARDWARE_TEST: 'MANAGE_KARTS',
+    KARTS_POWER_UP_TEST: 'MANAGE_POWER_UPS',
+    GAME_TRACK_MANAGE_GAMES: 'MANAGE_GAMES',
+    GAME_TRACK_CONFIG_KARTS: 'CONFIG_KARTS',
+    GAME_TRACK_CONFIG_HARDWARE: 'CONFIG_HARDWARE',
+    KARTS_TRACKING: 'KARTS_TRACKING',
+};

package/dist/types/role/RoleDefinition.d.ts

@@ -0,0 +1,7 @@
+import type { Permission } from './Permission';
+import type { UserRole } from './UserRole';
+export interface RoleDefinition {
+    role: UserRole;
+    permissions: Permission[];
+    description: string;
+}

package/dist/types/role/UserRole.d.ts

@@ -0,0 +1,6 @@
+import type { ObjectValues } from '../utils';
+export declare const USER_ROLE: {
+    readonly SUPER_ADMIN: "SUPER_ADMIN";
+    readonly OPERATOR: "OPERATOR";
+};
+export type UserRole = ObjectValues<typeof USER_ROLE>;

package/dist/types/role/UserRole.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.USER_ROLE = void 0;
+exports.USER_ROLE = {
+    SUPER_ADMIN: 'SUPER_ADMIN',
+    OPERATOR: 'OPERATOR',
+};

package/dist/types/role/index.d.ts

@@ -0,0 +1,3 @@
+export * from './Permission';
+export * from './RoleDefinition';
+export * from './UserRole';

package/dist/types/role/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Permission"), exports);
+__exportStar(require("./RoleDefinition"), exports);
+__exportStar(require("./UserRole"), exports);

package/dist/{user → types/user}/User.d.ts

@@ -1,7 +1,9 @@
+import type { UserRole } from '../role/UserRole';
 import type { UserOrigin } from './UserOrigin';
 export interface User {
     id: string;
     username: string;
     name: string;
     origin: UserOrigin;
+    role: UserRole;
 }

package/dist/types/utils/ObjectValues.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './ObjectValues';
+export * from './ArithmeticString';

package/dist/types/utils/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ObjectValues"), exports);
+__exportStar(require("./ArithmeticString"), exports);

package/dist/utils/index.d.ts

@@ -1,2 +1 @@
-export * from './ObjectValues';
-export * from './ArithmeticString';
+export * from './roles.utils';

package/dist/utils/index.js

@@ -14,5 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./ObjectValues"), exports);
-__exportStar(require("./ArithmeticString"), exports);
+__exportStar(require("./roles.utils"), exports);

package/dist/utils/roles.utils.d.ts

@@ -0,0 +1,4 @@
+import { Permission, UserRole } from '../types';
+export declare function hasPermission(userRole: UserRole, requiredPermission: Permission): boolean;
+export declare function hasAnyPermission(userRole: UserRole, requiredPermissions: Permission[]): boolean;
+export declare function hasAllPermissions(userRole: UserRole, requiredPermissions: Permission[]): boolean;

package/dist/utils/roles.utils.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasPermission = hasPermission;
+exports.hasAnyPermission = hasAnyPermission;
+exports.hasAllPermissions = hasAllPermissions;
+const definitions_1 = require("../definitions");
+const types_1 = require("../types");
+function hasPermission(userRole, requiredPermission) {
+    if (userRole === types_1.USER_ROLE.SUPER_ADMIN) {
+        return true;
+    }
+    const roleDefinition = definitions_1.ROLE_DEFINITIONS.find((def) => def.role === userRole);
+    return roleDefinition ? roleDefinition.permissions.includes(requiredPermission) : false;
+}
+function hasAnyPermission(userRole, requiredPermissions) {
+    return requiredPermissions.some((perm) => hasPermission(userRole, perm));
+}
+function hasAllPermissions(userRole, requiredPermissions) {
+    return requiredPermissions.every((perm) => hasPermission(userRole, perm));
+}

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@battle-racing/br-common-lib",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Common library for all Battle Racing Repositorios",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "release": "npm run build && npm publish"
   },
   "keywords": [
     "Battle",

package/src/definitions/RoleDefinitions.ts

@@ -0,0 +1,24 @@
+import { PERMISSIONS } from '../types/role/Permission';
+import type { RoleDefinition } from '../types/role/RoleDefinition';
+import { USER_ROLE } from '../types/role/UserRole';
+
+export const ROLE_DEFINITIONS: RoleDefinition[] = [
+  {
+    role: USER_ROLE.SUPER_ADMIN,
+    description: 'Complete access to all features and settings',
+    permissions: [
+      PERMISSIONS.FULL_ACCESS,
+      PERMISSIONS.KARTS_HARDWARE_TEST,
+      PERMISSIONS.KARTS_POWER_UP_TEST,
+      PERMISSIONS.GAME_TRACK_CONFIG_HARDWARE,
+      PERMISSIONS.GAME_TRACK_CONFIG_KARTS,
+      PERMISSIONS.GAME_TRACK_MANAGE_GAMES,
+      PERMISSIONS.KARTS_TRACKING,
+    ],
+  },
+  {
+    role: USER_ROLE.OPERATOR,
+    description: 'Game Track Operator',
+    permissions: [PERMISSIONS.GAME_TRACK_MANAGE_GAMES],
+  },
+];

package/src/definitions/index.ts

@@ -0,0 +1 @@
+export * from './RoleDefinitions';

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './definitions';
+export * from './types';
+export * from './utils';

package/src/types/index.ts

@@ -15,7 +15,9 @@ export * from './kart';
 export * from './kartTracking';
 export * from './powerUp';
 export * from './response';
+export * from './role';
 export * from './socket';
 export * from './sounds';
 export * from './user';
 export * from './utils';
+

package/src/types/role/Permission.ts

@@ -0,0 +1,16 @@
+import type { ObjectValues } from '../utils';
+
+export const PERMISSIONS = {
+  FULL_ACCESS: 'FULL_ACCESS',
+
+  KARTS_HARDWARE_TEST: 'MANAGE_KARTS',
+  KARTS_POWER_UP_TEST: 'MANAGE_POWER_UPS',
+
+  GAME_TRACK_MANAGE_GAMES: 'MANAGE_GAMES',
+  GAME_TRACK_CONFIG_KARTS: 'CONFIG_KARTS',
+  GAME_TRACK_CONFIG_HARDWARE: 'CONFIG_HARDWARE',
+
+  KARTS_TRACKING: 'KARTS_TRACKING',
+} as const;
+
+export type Permission = ObjectValues<typeof PERMISSIONS>;

package/src/types/role/RoleDefinition.ts

@@ -0,0 +1,8 @@
+import type { Permission } from './Permission';
+import type { UserRole } from './UserRole';
+
+export interface RoleDefinition {
+  role: UserRole;
+  permissions: Permission[];
+  description: string;
+}

package/src/types/role/UserRole.ts

@@ -0,0 +1,8 @@
+import type { ObjectValues } from '../utils';
+
+export const USER_ROLE = {
+  SUPER_ADMIN: 'SUPER_ADMIN',
+  OPERATOR: 'OPERATOR',
+} as const;
+
+export type UserRole = ObjectValues<typeof USER_ROLE>;

package/src/types/role/index.ts

@@ -0,0 +1,3 @@
+export * from './Permission';
+export * from './RoleDefinition';
+export * from './UserRole';

package/src/types/user/User.ts

@@ -1,3 +1,4 @@
+import type { UserRole } from '../role/UserRole';
 import type { UserOrigin } from './UserOrigin';
 
 export interface User {
@@ -5,4 +6,5 @@ export interface User {
   username: string;
   name: string;
   origin: UserOrigin;
+  role: UserRole;
 }

package/src/utils/index.ts

@@ -0,0 +1 @@
+export * from './roles.utils';

package/src/utils/roles.utils.ts

@@ -0,0 +1,20 @@
+import { ROLE_DEFINITIONS } from '../definitions';
+import { Permission, USER_ROLE, UserRole } from '../types';
+
+export function hasPermission(userRole: UserRole, requiredPermission: Permission): boolean {
+  if (userRole === USER_ROLE.SUPER_ADMIN) {
+    return true;
+  }
+
+  const roleDefinition = ROLE_DEFINITIONS.find((def) => def.role === userRole);
+
+  return roleDefinition ? roleDefinition.permissions.includes(requiredPermission) : false;
+}
+
+export function hasAnyPermission(userRole: UserRole, requiredPermissions: Permission[]): boolean {
+  return requiredPermissions.some((perm) => hasPermission(userRole, perm));
+}
+
+export function hasAllPermissions(userRole: UserRole, requiredPermissions: Permission[]): boolean {
+  return requiredPermissions.every((perm) => hasPermission(userRole, perm));
+}