@battle-racing/br-common-lib 2.4.1 → 3.0.0

package/dist/constants/hardware/index.d.ts

@@ -4,4 +4,6 @@ export * from './flag-media-name';
 export * from './flag-status';
 export * from './lights-effect';
 export * from './rgb-status';
+export * from './screen-status';
+export * from './screen-view';
 export * from './speed-status';

package/dist/constants/hardware/index.js

@@ -20,4 +20,6 @@ __exportStar(require("./flag-media-name"), exports);
 __exportStar(require("./flag-status"), exports);
 __exportStar(require("./lights-effect"), exports);
 __exportStar(require("./rgb-status"), exports);
+__exportStar(require("./screen-status"), exports);
+__exportStar(require("./screen-view"), exports);
 __exportStar(require("./speed-status"), exports);

package/dist/constants/hardware/screen-status.d.ts

@@ -0,0 +1,7 @@
+export declare const SCREEN_STATUS: {
+    readonly DEBUG: "Debug";
+    readonly ACTIVATED: "Activated";
+    readonly DEACTIVATED: "Deactivated";
+    readonly UNKNOWN: "Unknown";
+    readonly ERROR: "Error";
+};

package/dist/constants/hardware/screen-status.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SCREEN_STATUS = void 0;
+const base_hardware_status_1 = require("./base-hardware-status");
+exports.SCREEN_STATUS = {
+    ...base_hardware_status_1.BASE_HARDWARE_STATUS,
+    DEBUG: 'Debug',
+};

package/dist/constants/hardware/screen-view.d.ts

@@ -0,0 +1,9 @@
+export declare const SCREEN_VIEW: {
+    readonly HOME: "Home";
+    readonly COUNTDOWN: "Countdown";
+    readonly RACE: "Race";
+    readonly GAME_SUMMARY: "GameSummary";
+    readonly INSTRUCTION_VIDEO: "InstructionVideo";
+    readonly BATTLE: "Battle";
+    readonly DEBUG: "Debug";
+};

package/dist/constants/hardware/screen-view.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SCREEN_VIEW = void 0;
+exports.SCREEN_VIEW = {
+    HOME: 'Home',
+    COUNTDOWN: 'Countdown',
+    RACE: 'Race',
+    GAME_SUMMARY: 'GameSummary',
+    INSTRUCTION_VIDEO: 'InstructionVideo',
+    BATTLE: 'Battle',
+    DEBUG: 'Debug',
+};

package/dist/types/hardware/KartHardwareState.d.ts

@@ -1,10 +1,12 @@
 import type { FlagStatus } from './flag';
 import type { RGBStatus } from './rgb';
+import type { ScreenStatus } from './screen';
 import type { SpeedStatus } from './speed';
 export type KartHardwareState = {
     speed: SpeedStatus | null;
     rgb: RGBStatus | null;
     flag: FlagStatus | null;
+    screen: ScreenStatus | null;
     isConnectedToServer: boolean;
     isSteeringWheelPressed: boolean;
 };

package/dist/types/hardware/screen/ScreenModuleStatus.d.ts

@@ -0,0 +1,6 @@
+import { ScreenStatus } from './ScreenStatus';
+import { ScreenView } from './ScreenView';
+export interface ScreenModuleStatus {
+    latestView: ScreenView;
+    screenStatus: ScreenStatus;
+}

package/dist/types/hardware/screen/ScreenModuleStatus.js

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

package/dist/types/hardware/screen/ScreenStatus.d.ts

@@ -0,0 +1,3 @@
+import { SCREEN_STATUS } from '../../../constants';
+import { ObjectValues } from '../../utils';
+export type ScreenStatus = ObjectValues<typeof SCREEN_STATUS>;

package/dist/types/hardware/screen/ScreenStatus.js

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

package/dist/types/hardware/screen/ScreenView.d.ts

@@ -1 +1,3 @@
-export type ScreenView = 'Home' | 'Countdown' | 'Race' | 'Battle' | 'Victory' | 'Defeat';
+import { SCREEN_VIEW } from '../../../constants';
+import { ObjectValues } from '../../utils';
+export type ScreenView = ObjectValues<typeof SCREEN_VIEW>;

package/dist/types/hardware/screen/index.d.ts

@@ -4,7 +4,9 @@ export * from './ScreenDebugViewInput';
 export * from './ScreenFinishViewInput';
 export * from './ScreenGameTimeLeft';
 export * from './ScreenHomeViewInput';
+export * from './ScreenModuleStatus';
 export * from './ScreenRaceViewConfig';
+export * from './ScreenStatus';
 export * from './ScreenUpdateGameViewInput';
 export * from './ScreenView';
 export * from './ScreenViewBaseConfig';

package/dist/types/hardware/screen/index.js

@@ -20,7 +20,9 @@ __exportStar(require("./ScreenDebugViewInput"), exports);
 __exportStar(require("./ScreenFinishViewInput"), exports);
 __exportStar(require("./ScreenGameTimeLeft"), exports);
 __exportStar(require("./ScreenHomeViewInput"), exports);
+__exportStar(require("./ScreenModuleStatus"), exports);
 __exportStar(require("./ScreenRaceViewConfig"), exports);
+__exportStar(require("./ScreenStatus"), exports);
 __exportStar(require("./ScreenUpdateGameViewInput"), exports);
 __exportStar(require("./ScreenView"), exports);
 __exportStar(require("./ScreenViewBaseConfig"), exports);

package/dist/types/response/Response.d.ts

@@ -1,3 +1,3 @@
 import type { ErrorResponse } from './ErrorResponse';
-import type { SuccesResponse } from './SuccesResponse';
-export type Response<T> = SuccesResponse<T> | ErrorResponse;
+import type { SuccessResponse } from './SuccessResponse';
+export type Response<T> = SuccessResponse<T> | ErrorResponse;

package/dist/types/response/SuccesResponse.d.ts

@@ -1,4 +1,4 @@
-export interface SuccesResponse<T> {
+export interface SuccessResponse<T> {
     status: 'success';
     code: 200;
     data?: T;

package/dist/types/response/SuccessResponse.d.ts

@@ -0,0 +1,5 @@
+export interface SuccessResponse<T> {
+    status: 'success';
+    code: 200;
+    data?: T;
+}

package/dist/types/response/SuccessResponse.js

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

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

@@ -1,3 +1,3 @@
 export type { ErrorResponse } from './ErrorResponse';
-export type { SuccesResponse } from './SuccesResponse';
+export type { SuccessResponse } from './SuccessResponse';
 export type { Response } from './Response';

package/dist/types/socket/SocketHardwareOnDataEventsParams.d.ts

@@ -1,4 +1,4 @@
-import type { BallSensorDiskThrowerModuleStatus, DiskSensorBallShooterModuleStatus, EmergencyModuleStatus, FlagModuleStatus, RGBModuleStatus, SpeedModuleStatus, StarLaserModuleStatus, SteeringWheelModuleStatus } from '../hardware';
+import type { BallSensorDiskThrowerModuleStatus, DiskSensorBallShooterModuleStatus, EmergencyModuleStatus, FlagModuleStatus, RGBModuleStatus, ScreenModuleStatus, SpeedModuleStatus, StarLaserModuleStatus, SteeringWheelModuleStatus } from '../hardware';
 /** Data that are triggered from Hardware Modules of Kart */
 export type SocketHardwareOnDataEventsParams = {
     'hardware:disk-sensor-ball-shooter:onModuleStatus': DiskSensorBallShooterModuleStatus;
@@ -9,6 +9,7 @@ export type SocketHardwareOnDataEventsParams = {
     'hardware:left-star-back-laser:onModuleStatus': StarLaserModuleStatus;
     'hardware:right-star-front-laser:onModuleStatus': StarLaserModuleStatus;
     'hardware:steering-wheel:onModuleStatus': SteeringWheelModuleStatus;
+    'hardware:screen:onModuleStatus': ScreenModuleStatus;
 };
 /** Data that are triggered from Hardware Modules of Game Track */
 export type SocketGameTrackHardwareOnDataEventsParams = {

package/dist/types/socket/serverToClient/SocketKartServerToClientEventsParams.d.ts

@@ -14,7 +14,10 @@ export interface SocketKartEventsParams {
     'kart:updated': {
         kart: Kart;
     };
-    'kart:init:response': Response<Kart>;
+    'kart:init:response': Response<{
+        kart: Kart;
+        gameTrack: GameTrack;
+    }>;
     /** Whenever the Game Track config changed */
     'kart:gameTrack:updated': {
         gameTrack: GameTrack;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@battle-racing/br-common-lib",
-  "version": "2.4.1",
+  "version": "3.0.0",
   "description": "Common library for all Battle Racing Repositorios",
   "main": "dist/index.js",
   "module": "dist/index.js",

package/src/constants/hardware/index.ts

@@ -4,4 +4,6 @@ export * from './flag-media-name';
 export * from './flag-status';
 export * from './lights-effect';
 export * from './rgb-status';
+export * from './screen-status';
+export * from './screen-view';
 export * from './speed-status';

package/src/constants/hardware/screen-status.ts

@@ -0,0 +1,6 @@
+import { BASE_HARDWARE_STATUS } from './base-hardware-status';
+
+export const SCREEN_STATUS = {
+  ...BASE_HARDWARE_STATUS,
+  DEBUG: 'Debug',
+} as const;

package/src/constants/hardware/screen-view.ts

@@ -0,0 +1,9 @@
+export const SCREEN_VIEW = {
+  HOME: 'Home',
+  COUNTDOWN: 'Countdown',
+  RACE: 'Race',
+  GAME_SUMMARY: 'GameSummary',
+  INSTRUCTION_VIDEO: 'InstructionVideo',
+  BATTLE: 'Battle',
+  DEBUG: 'Debug',
+} as const;

package/src/types/hardware/KartHardwareState.ts

@@ -1,11 +1,13 @@
 import type { FlagStatus } from './flag';
 import type { RGBStatus } from './rgb';
+import type { ScreenStatus } from './screen';
 import type { SpeedStatus } from './speed';
 
 export type KartHardwareState = {
   speed: SpeedStatus | null;
   rgb: RGBStatus | null;
   flag: FlagStatus | null;
+  screen: ScreenStatus | null;
   isConnectedToServer: boolean;
   isSteeringWheelPressed: boolean;
 };

package/src/types/hardware/screen/ScreenModuleStatus.ts

@@ -0,0 +1,7 @@
+import { ScreenStatus } from './ScreenStatus';
+import { ScreenView } from './ScreenView';
+
+export interface ScreenModuleStatus {
+  latestView: ScreenView;
+  screenStatus: ScreenStatus;
+}

package/src/types/hardware/screen/ScreenStatus.ts

@@ -0,0 +1,4 @@
+import { SCREEN_STATUS } from '../../../constants';
+import { ObjectValues } from '../../utils';
+
+export type ScreenStatus = ObjectValues<typeof SCREEN_STATUS>;

package/src/types/hardware/screen/ScreenView.ts

@@ -1 +1,4 @@
-export type ScreenView = 'Home' | 'Countdown' | 'Race' | 'Battle' | 'Victory' | 'Defeat';
+import { SCREEN_VIEW } from '../../../constants';
+import { ObjectValues } from '../../utils';
+
+export type ScreenView = ObjectValues<typeof SCREEN_VIEW>;

package/src/types/hardware/screen/index.ts

@@ -4,7 +4,9 @@ export * from './ScreenDebugViewInput';
 export * from './ScreenFinishViewInput';
 export * from './ScreenGameTimeLeft';
 export * from './ScreenHomeViewInput';
+export * from './ScreenModuleStatus';
 export * from './ScreenRaceViewConfig';
+export * from './ScreenStatus';
 export * from './ScreenUpdateGameViewInput';
 export * from './ScreenView';
 export * from './ScreenViewBaseConfig';

package/src/types/response/Response.ts

@@ -1,4 +1,4 @@
 import type { ErrorResponse } from './ErrorResponse';
-import type { SuccesResponse } from './SuccesResponse';
+import type { SuccessResponse } from './SuccessResponse';
 
-export type Response<T> = SuccesResponse<T> | ErrorResponse;
+export type Response<T> = SuccessResponse<T> | ErrorResponse;

package/src/types/response/{SuccesResponse.ts → SuccessResponse.ts}

@@ -1,4 +1,4 @@
-export interface SuccesResponse<T> {
+export interface SuccessResponse<T> {
   status: 'success';
   code: 200;
   data?: T;

package/src/types/response/index.ts

@@ -1,3 +1,3 @@
 export type { ErrorResponse } from './ErrorResponse';
-export type { SuccesResponse } from './SuccesResponse';
+export type { SuccessResponse } from './SuccessResponse';
 export type { Response } from './Response';

package/src/types/socket/SocketHardwareOnDataEventsParams.ts

@@ -4,6 +4,7 @@ import type {
   EmergencyModuleStatus,
   FlagModuleStatus,
   RGBModuleStatus,
+  ScreenModuleStatus,
   SpeedModuleStatus,
   StarLaserModuleStatus,
   SteeringWheelModuleStatus,
@@ -19,6 +20,7 @@ export type SocketHardwareOnDataEventsParams = {
   'hardware:left-star-back-laser:onModuleStatus': StarLaserModuleStatus;
   'hardware:right-star-front-laser:onModuleStatus': StarLaserModuleStatus;
   'hardware:steering-wheel:onModuleStatus': SteeringWheelModuleStatus;
+  'hardware:screen:onModuleStatus': ScreenModuleStatus;
 };
 
 /** Data that are triggered from Hardware Modules of Game Track */

package/src/types/socket/serverToClient/SocketKartServerToClientEventsParams.ts

@@ -17,7 +17,7 @@ export type SocketKartPowerUpEventsParams = {
 export interface SocketKartEventsParams {
   'kart:updated': { kart: Kart };
   // Response from server
-  'kart:init:response': Response<Kart>;
+  'kart:init:response': Response<{ kart: Kart; gameTrack: GameTrack }>;
   /** Whenever the Game Track config changed */
   'kart:gameTrack:updated': { gameTrack: GameTrack };
   /** When the physical button of the game track is pressed */