@battle-racing/br-common-lib 2.3.0 → 2.4.0

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

@@ -0,0 +1,6 @@
+export declare const BASE_HARDWARE_STATUS: {
+    readonly ACTIVATED: "Activated";
+    readonly DEACTIVATED: "Deactivated";
+    readonly UNKNOWN: "Unknown";
+    readonly ERROR: "Error";
+};

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

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BASE_HARDWARE_STATUS = void 0;
+exports.BASE_HARDWARE_STATUS = {
+    ACTIVATED: 'Activated',
+    DEACTIVATED: 'Deactivated',
+    UNKNOWN: 'Unknown',
+    ERROR: 'Error',
+};

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

@@ -1,9 +1,10 @@
 export declare const FLAG_STATUS: {
     readonly STANDBY: "Standby";
-    readonly DEACTIVATED: "Deactivated";
-    readonly ACTIVATED: "Activated";
     readonly HIT: "Hit";
     readonly SHOWING_IMAGE: "Showing Image";
     readonly SHOWING_ANIMATION: "Showing Animation";
+    readonly ACTIVATED: "Activated";
+    readonly DEACTIVATED: "Deactivated";
     readonly UNKNOWN: "Unknown";
+    readonly ERROR: "Error";
 };

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

@@ -1,12 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FLAG_STATUS = void 0;
+const base_hardware_status_1 = require("./base-hardware-status");
 exports.FLAG_STATUS = {
+    ...base_hardware_status_1.BASE_HARDWARE_STATUS,
     STANDBY: 'Standby',
-    DEACTIVATED: 'Deactivated',
-    ACTIVATED: 'Activated',
     HIT: 'Hit',
     SHOWING_IMAGE: 'Showing Image',
     SHOWING_ANIMATION: 'Showing Animation',
-    UNKNOWN: 'Unknown',
 };

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

@@ -1,4 +1,6 @@
+export * from './base-hardware-status';
 export * from './damage';
 export * from './flag-media-name';
 export * from './flag-status';
 export * from './lights-effect';
+export * from './speed-status';

package/dist/constants/hardware/index.js

@@ -14,7 +14,9 @@ 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("./base-hardware-status"), exports);
 __exportStar(require("./damage"), exports);
 __exportStar(require("./flag-media-name"), exports);
 __exportStar(require("./flag-status"), exports);
 __exportStar(require("./lights-effect"), exports);
+__exportStar(require("./speed-status"), exports);

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

@@ -0,0 +1,8 @@
+export declare const RGB_STATUS: {
+    readonly SHOWING_COLOR: "Showing Color";
+    readonly NOT_CONFIGURED: "Not Configured";
+    readonly CONFIGURING_RGB: "Configuring RGB";
+    readonly SHOWING_EFFECT: "Showing Effect";
+    readonly UNKNOWN: "Unknown";
+    readonly ERROR: "Error";
+};

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

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RGB_STATUS = void 0;
+exports.RGB_STATUS = {
+    SHOWING_COLOR: 'Showing Color',
+    NOT_CONFIGURED: 'Not Configured',
+    CONFIGURING_RGB: 'Configuring RGB',
+    SHOWING_EFFECT: 'Showing Effect',
+    UNKNOWN: 'Unknown',
+    ERROR: 'Error',
+};

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

@@ -0,0 +1,9 @@
+export declare const SPEED_STATUS: {
+    readonly STANDBY: "Standby";
+    readonly CHANGING_SPEED: "Changing Speed";
+    readonly IN_EMERGENCY: "In Emergency";
+    readonly ACTIVATED: "Activated";
+    readonly DEACTIVATED: "Deactivated";
+    readonly UNKNOWN: "Unknown";
+    readonly ERROR: "Error";
+};

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

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SPEED_STATUS = void 0;
+const base_hardware_status_1 = require("./base-hardware-status");
+exports.SPEED_STATUS = {
+    ...base_hardware_status_1.BASE_HARDWARE_STATUS,
+    STANDBY: 'Standby',
+    CHANGING_SPEED: 'Changing Speed',
+    IN_EMERGENCY: 'In Emergency',
+};

package/dist/types/gameTrack/GameTrackKartsConfig.d.ts

@@ -1,7 +1,7 @@
 import type { ConfigDiskSensorBallShooterModuleOptions, ConfigureBallSensorDiskThrowerModuleOptions } from '../hardware';
 /**
  * Global Karts Config are provided from the Game Track.
- * Leting the specific Kart values like times, Ids, or other specific values to be set during the game.
+ * Letting the specific Kart values like times, Ids, or other specific values to be set during the game.
  *
  * powerUpTime: Will be the time configuration of each Module.
  */
@@ -18,4 +18,6 @@ export interface GameTrackKartsConfig {
     diskSensorBallShooter: ConfigDiskSensorBallShooterModuleOptions;
     /** Full Configuration of the Ball Sensor Disk Thrower */
     ballSensorDiskThrower: ConfigureBallSensorDiskThrowerModuleOptions;
+    /** Low Speed (0 - 100) */
+    lowSpeed: number;
 }

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

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

package/dist/types/hardware/KartHardwareState.js

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

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

@@ -5,6 +5,7 @@ export * from './diskThrower';
 export * from './emergency';
 export * from './flag';
 export * from './KartEffect';
+export * from './KartHardwareState';
 export * from './lights';
 export * from './ModuleName';
 export * from './ModuleStatus';

package/dist/types/hardware/index.js

@@ -21,6 +21,7 @@ __exportStar(require("./diskThrower"), exports);
 __exportStar(require("./emergency"), exports);
 __exportStar(require("./flag"), exports);
 __exportStar(require("./KartEffect"), exports);
+__exportStar(require("./KartHardwareState"), exports);
 __exportStar(require("./lights"), exports);
 __exportStar(require("./ModuleName"), exports);
 __exportStar(require("./ModuleStatus"), exports);

package/dist/types/hardware/rgb/RGBStatus.d.ts

@@ -1 +1,3 @@
-export type RGBStatus = 'Showing Color' | 'Not Configured' | 'Configuring RGB' | 'Showing Effect' | 'Unknown';
+import { RGB_STATUS } from '../../../constants/hardware/rgb-status';
+import type { ObjectValues } from '../../utils';
+export type RGBStatus = ObjectValues<typeof RGB_STATUS>;

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

@@ -0,0 +1,4 @@
+import type { KartHardwareState } from '../KartHardwareState';
+export type ScreenDebugViewInput = KartHardwareState & {
+    kartNumber: number;
+};

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

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

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

@@ -1,5 +1,6 @@
 export * from './ScreenBattleViewConfig';
 export * from './ScreenCountdownParams';
+export * from './ScreenDebugViewInput';
 export * from './ScreenFinishViewInput';
 export * from './ScreenGameTimeLeft';
 export * from './ScreenHomeViewInput';

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

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ScreenBattleViewConfig"), exports);
 __exportStar(require("./ScreenCountdownParams"), exports);
+__exportStar(require("./ScreenDebugViewInput"), exports);
 __exportStar(require("./ScreenFinishViewInput"), exports);
 __exportStar(require("./ScreenGameTimeLeft"), exports);
 __exportStar(require("./ScreenHomeViewInput"), exports);

package/dist/types/hardware/speed/SpeedStatus.d.ts

@@ -1 +1,3 @@
-export type SpeedStatus = 'Standby' | 'Deactivated' | 'Activated' | 'Changing Speed' | 'In Emergency' | 'Unknown';
+import { SPEED_STATUS } from '../../../constants/hardware';
+import { ObjectValues } from '../../utils';
+export type SpeedStatus = ObjectValues<typeof SPEED_STATUS>;

package/package.json

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

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

@@ -0,0 +1,6 @@
+export const BASE_HARDWARE_STATUS = {
+  ACTIVATED: 'Activated',
+  DEACTIVATED: 'Deactivated',
+  UNKNOWN: 'Unknown',
+  ERROR: 'Error',
+} as const;

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

@@ -1,9 +1,9 @@
+import { BASE_HARDWARE_STATUS } from './base-hardware-status';
+
 export const FLAG_STATUS = {
+  ...BASE_HARDWARE_STATUS,
   STANDBY: 'Standby',
-  DEACTIVATED: 'Deactivated',
-  ACTIVATED: 'Activated',
   HIT: 'Hit',
   SHOWING_IMAGE: 'Showing Image',
   SHOWING_ANIMATION: 'Showing Animation',
-  UNKNOWN: 'Unknown',
 } as const;

package/src/constants/hardware/index.ts

@@ -1,5 +1,6 @@
+export * from './base-hardware-status';
 export * from './damage';
 export * from './flag-media-name';
 export * from './flag-status';
 export * from './lights-effect';
-
+export * from './speed-status';

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

@@ -0,0 +1,8 @@
+export const RGB_STATUS = {
+  SHOWING_COLOR: 'Showing Color',
+  NOT_CONFIGURED: 'Not Configured',
+  CONFIGURING_RGB: 'Configuring RGB',
+  SHOWING_EFFECT: 'Showing Effect',
+  UNKNOWN: 'Unknown',
+  ERROR: 'Error',
+} as const;

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

@@ -0,0 +1,8 @@
+import { BASE_HARDWARE_STATUS } from './base-hardware-status';
+
+export const SPEED_STATUS = {
+  ...BASE_HARDWARE_STATUS,
+  STANDBY: 'Standby',
+  CHANGING_SPEED: 'Changing Speed',
+  IN_EMERGENCY: 'In Emergency',
+} as const;

package/src/types/gameTrack/GameTrackKartsConfig.ts

@@ -5,7 +5,7 @@ import type {
 
 /**
  * Global Karts Config are provided from the Game Track.
- * Leting the specific Kart values like times, Ids, or other specific values to be set during the game.
+ * Letting the specific Kart values like times, Ids, or other specific values to be set during the game.
  *
  * powerUpTime: Will be the time configuration of each Module.
  */
@@ -22,4 +22,6 @@ export interface GameTrackKartsConfig {
   diskSensorBallShooter: ConfigDiskSensorBallShooterModuleOptions;
   /** Full Configuration of the Ball Sensor Disk Thrower */
   ballSensorDiskThrower: ConfigureBallSensorDiskThrowerModuleOptions;
+  /** Low Speed (0 - 100) */
+  lowSpeed: number;
 }

package/src/types/hardware/KartHardwareState.ts

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

package/src/types/hardware/index.ts

@@ -5,6 +5,7 @@ export * from './diskThrower';
 export * from './emergency';
 export * from './flag';
 export * from './KartEffect';
+export * from './KartHardwareState';
 export * from './lights';
 export * from './ModuleName';
 export * from './ModuleStatus';

package/src/types/hardware/rgb/RGBStatus.ts

@@ -1 +1,4 @@
-export type RGBStatus = 'Showing Color' | 'Not Configured' | 'Configuring RGB' | 'Showing Effect' | 'Unknown';
+import { RGB_STATUS } from '../../../constants/hardware/rgb-status';
+import type { ObjectValues } from '../../utils';
+
+export type RGBStatus = ObjectValues<typeof RGB_STATUS >;

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

@@ -0,0 +1,5 @@
+import type { KartHardwareState } from '../KartHardwareState';
+
+export type ScreenDebugViewInput = KartHardwareState & {
+  kartNumber: number;
+};

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

@@ -1,5 +1,6 @@
 export * from './ScreenBattleViewConfig';
 export * from './ScreenCountdownParams';
+export * from './ScreenDebugViewInput';
 export * from './ScreenFinishViewInput';
 export * from './ScreenGameTimeLeft';
 export * from './ScreenHomeViewInput';

package/src/types/hardware/speed/SpeedStatus.ts

@@ -1 +1,4 @@
-export type SpeedStatus = 'Standby' | 'Deactivated' | 'Activated' | 'Changing Speed' | 'In Emergency' | 'Unknown';
+import { SPEED_STATUS } from '../../../constants/hardware';
+import { ObjectValues } from '../../utils';
+
+export type SpeedStatus = ObjectValues<typeof SPEED_STATUS>;