@battle-racing/br-common-lib 1.0.0

package/dist/socket/serverToClient/SocketWebAppServerToClientEventsParams.d.ts

@@ -0,0 +1,24 @@
+import type { Game } from '../../game';
+import type { Kart } from '../../kart';
+import type { CheckpointEvent } from '../../kartTracking';
+import type { Response } from '../../response';
+import type { MacAddressGameTrackConnection } from '../inputs';
+import type { SocketHardwareOnDataEventsParams } from '../SocketHardwareOnDataEventsParams';
+export interface SocketWebAppServerToClientEventsParams {
+    'karts:authenticate:response': Response<void>;
+    'karts:list:response': Response<Kart[]>;
+    'karts:onKartsUpdated': Kart[];
+    'karts:onHardwareData': {
+        kartGuid: string;
+        socketEvent: keyof SocketHardwareOnDataEventsParams;
+        payload: SocketHardwareOnDataEventsParams[keyof SocketHardwareOnDataEventsParams];
+    };
+    'karts:tracking:checkpointEvent': {
+        checkpointEvent: CheckpointEvent;
+    };
+    'game:changed': {
+        game: Game;
+    };
+    'gameTracks:onGameTrackUpdated': MacAddressGameTrackConnection[];
+    'gameTracks:list:response': Response<MacAddressGameTrackConnection[]>;
+}

package/dist/socket/serverToClient/SocketWebAppServerToClientEventsParams.js

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

package/dist/socket/serverToClient/index.d.ts

@@ -0,0 +1,3 @@
+export * from './SocketGameTrackServerToClientEventParams';
+export * from './SocketKartServerToClientEventsParams';
+export * from './SocketWebAppServerToClientEventsParams';

package/dist/socket/serverToClient/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("./SocketGameTrackServerToClientEventParams"), exports);
+__exportStar(require("./SocketKartServerToClientEventsParams"), exports);
+__exportStar(require("./SocketWebAppServerToClientEventsParams"), exports);

package/dist/socket/utils/SocketParamsToEvents.d.ts

@@ -0,0 +1,10 @@
+/** Map the Events Params Types to Event to be used on Socket.io  */
+export type EmptyEventParams = () => void;
+export type EventParams<EventParams> = (payload: EventParams) => void;
+export type EmptyEventParamsWithExtra<Extra> = (params: Extra) => void;
+export type EventParamsWithExtra<EventParams, Extra> = (params: Extra & {
+    payload: EventParams;
+}) => void;
+export type SocketParamsToEvents<Event, Extra = undefined> = {
+    [EventKey in keyof Event]: Event[EventKey] extends undefined ? Extra extends undefined ? EmptyEventParams : EmptyEventParamsWithExtra<Extra> : Extra extends undefined ? EventParams<Event[EventKey]> : EventParamsWithExtra<Event[EventKey], Extra>;
+};

package/dist/socket/utils/SocketParamsToEvents.js

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

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

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

package/dist/socket/utils/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("./SocketParamsToEvents"), exports);

package/dist/sounds/SoundName.d.ts

@@ -0,0 +1 @@
+export type SoundName = 'battle_god_activation.mp3' | 'battle_laser_activation.mp3' | 'battle_laser_damage.mp3' | 'battle_pulse_activation.mp3' | 'battle_pulse_damage.mp3' | 'battle_shield_activation.mp3' | 'battle_shot_activation.mp3' | 'battle_shot_damage.mp3' | 'battle_star_damage.mp3' | 'battle_trap_activation.mp3' | 'battle_trap_damage.mp3' | 'battle_turbo_activation.mp3' | 'countdown_3_2_1.mp3' | 'emergency_alert.mp3' | 'engine_start.mp3' | 'final_lap_mario_kart.mp3' | 'kart_skiding.mp3' | 'pick_coin_x2.mp3' | 'power_up_selection.mp3' | 'sad_trumpet_loser.mp3' | 'system_started.mp3' | 'warning_alert_this_is_not_a_test.mp3' | 'winner_laugh.mp3';

package/dist/sounds/SoundName.js

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

package/dist/sounds/index.d.ts

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

package/dist/sounds/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("./SoundName"), exports);

package/dist/user/User.d.ts

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

package/dist/user/User.js

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

package/dist/user/UserOrigin.d.ts

@@ -0,0 +1 @@
+export type UserOrigin = 'webapp' | 'hardware';

package/dist/user/UserOrigin.js

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

package/dist/user/index.d.ts

@@ -0,0 +1,2 @@
+export * from './User';
+export * from './UserOrigin';

package/dist/user/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("./User"), exports);
+__exportStar(require("./UserOrigin"), exports);

package/dist/utils/ArithmeticString.d.ts

@@ -0,0 +1,9 @@
+export type ArithmeticOperator = '+' | '-' | '*' | '/';
+/**
+ * The Value is determined by an arithmetic operator followed by a number.
+ */
+export type SimpleArithmeticString = `${ArithmeticOperator}${number}`;
+export type KartContextVariable = '$kart.configuredSpeed';
+export type ContextVariable = KartContextVariable;
+export type ContextArithmeticString = `${ContextVariable} ${ArithmeticOperator} ${number}`;
+export type ArithmeticExpression = number | SimpleArithmeticString | ContextArithmeticString;

package/dist/utils/ArithmeticString.js

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

package/dist/utils/ObjectValues.d.ts

@@ -0,0 +1 @@
+export type ObjectValues<T> = T[keyof T];

package/dist/utils/ObjectValues.js

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

package/dist/utils/index.d.ts

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

package/dist/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/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@battle-racing/br-common-lib",
+  "version": "1.0.0",
+  "description": "Common library for all Battle Racing Repositorios",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc"
+  },
+  "keywords": [
+    "Battle",
+    "Racing",
+    "Common",
+    "Library"
+  ],
+  "author": "jdmaldonado",
+  "license": "MIT",
+  "private": false,
+  "devDependencies": {
+    "typescript": "^5.8.3"
+  }
+}

package/src/types/checkpoint/Checkpoint.ts

@@ -0,0 +1,11 @@
+import type { CheckpointType } from './CheckpointType';
+
+export interface Checkpoint {
+  /** Autogenerated Id */
+  id: string;
+  /** This is the received from Flag Module */
+  address: number;
+  name?: string;
+  type: CheckpointType;
+  progress: number;
+}

package/src/types/checkpoint/CheckpointType.ts

@@ -0,0 +1,6 @@
+export type CheckpointType = 'Track' | 'PowerUp' | null;
+
+export enum checkpointType {
+  Track = 'Track',
+  PowerUp = 'PowerUp',
+}

package/src/types/checkpoint/index.ts

@@ -0,0 +1,2 @@
+export * from './Checkpoint';
+export * from './CheckpointType';

package/src/types/color/ColorInfo.ts

@@ -0,0 +1,4 @@
+export interface ColorInfo {
+  fastLedId: number;
+  hex: string;
+}

package/src/types/color/ColorName.ts

@@ -0,0 +1,13 @@
+export type ColorName =
+  | 'Black'
+  | 'Red'
+  | 'Blue'
+  | 'Green'
+  | 'Yellow'
+  | 'Violet'
+  | 'Cyan'
+  | 'Magenta'
+  | 'Orange'
+  | 'White'
+  | 'GreenYellow'
+  | 'SaddleBrown';

package/src/types/color/index.ts

@@ -0,0 +1,2 @@
+export * from './ColorInfo';
+export * from './ColorName';

package/src/types/command/CommandConfig.ts

@@ -0,0 +1,91 @@
+import type {
+  ConfigDiskSensorBallShooterModuleOptions,
+  ConfigureBallSensorDiskThrowerModuleOptions,
+  FlagConfigurationOptions,
+  FlagShowMediaOptions,
+  PlaySoundOptions,
+  RGBConfigurationOptions,
+  RGBShowEffectOptions,
+  ScreenCountdownParams,
+  ScreenFinishViewInput,
+  ScreenUpdateGameViewInput,
+  SpeedChangeOptions,
+  SpeedConfiguration,
+  StarLaserConfigureModuleOptions,
+  StarLaserSendActionsOptions,
+} from '../hardware';
+import type { ArithmeticExpression } from '../utils';
+
+export interface ChangeSpeedActionCommandOptions extends Omit<SpeedChangeOptions, 'speed'> {
+  speed: number | ArithmeticExpression;
+}
+
+export type BallSensorDiskThrowerModuleCommands =
+  | { module: 'ballSensorDiskThrower'; action: 'activateSensor'; params?: undefined }
+  | { module: 'ballSensorDiskThrower'; action: 'deactivateSensor'; params?: undefined }
+  | {
+      module: 'ballSensorDiskThrower';
+      action: 'configureModule';
+      params: ConfigureBallSensorDiskThrowerModuleOptions;
+    }
+  | { module: 'ballSensorDiskThrower'; action: 'throwDisk'; params?: undefined }
+  | { module: 'ballSensorDiskThrower'; action: 'activateDiskThrower'; params?: undefined }
+  | { module: 'ballSensorDiskThrower'; action: 'deactivateDiskThrower'; params?: undefined };
+
+export type DiskSensorBallShooterModuleCommands =
+  | { module: 'diskSensorBallShooter'; action: 'configure'; params: ConfigDiskSensorBallShooterModuleOptions }
+  | { module: 'diskSensorBallShooter'; action: 'prepareShooter'; params?: undefined }
+  | { module: 'diskSensorBallShooter'; action: 'shootBall'; params?: undefined }
+  | { module: 'diskSensorBallShooter'; action: 'activateSensor'; params?: undefined }
+  | { module: 'diskSensorBallShooter'; action: 'deactivateSensor'; params?: undefined }
+  | { module: 'diskSensorBallShooter'; action: 'calibrateSensor'; params?: undefined };
+
+export type FlagModuleCommands =
+  | { module: 'flag'; action: 'activate'; params?: undefined }
+  | { module: 'flag'; action: 'deactivate'; params?: undefined }
+  | { module: 'flag'; action: 'configure'; params: FlagConfigurationOptions }
+  | { module: 'flag'; action: 'showMediaIndefinitely'; params: FlagShowMediaOptions }
+  | { module: 'flag'; action: 'showMediaTemporarily'; params: FlagShowMediaOptions };
+
+export type RGBModuleCommands =
+  | { module: 'rgb'; action: 'configure'; params: RGBConfigurationOptions }
+  | { module: 'rgb'; action: 'showEffect'; params: RGBShowEffectOptions };
+
+export type SpeedModuleCommands =
+  | { module: 'speed'; action: 'activate'; params?: undefined }
+  | { module: 'speed'; action: 'deactivate'; params?: undefined }
+  | { module: 'speed'; action: 'change'; params: ChangeSpeedActionCommandOptions }
+  | { module: 'speed'; action: 'configure'; params: SpeedConfiguration };
+
+export type LeftStarBackLaserModuleCommands =
+  | { module: 'leftStarBackLaser'; action: 'action'; params: StarLaserSendActionsOptions }
+  | { module: 'leftStarBackLaser'; action: 'configure'; params: StarLaserConfigureModuleOptions };
+
+export type RightStarFrontLaserModuleCommands =
+  | { module: 'rightStarFrontLaser'; action: 'action'; params: StarLaserSendActionsOptions }
+  | { module: 'rightStarFrontLaser'; action: 'configure'; params: StarLaserConfigureModuleOptions };
+
+export type ScreenModuleCommands =
+  | { module: 'screen'; action: 'showHomeView'; params?: undefined }
+  | { module: 'screen'; action: 'showCountdownView'; params: ScreenCountdownParams }
+  | { module: 'screen'; action: 'updateGameView'; params: ScreenUpdateGameViewInput }
+  | { module: 'screen'; action: 'showScreenVictoryView'; params: ScreenFinishViewInput }
+  | { module: 'screen'; action: 'showScreenDefeatView'; params: ScreenFinishViewInput };
+
+export type SteeringWheelModuleCommands =
+  | { module: 'steeringWheel'; action: 'turnLedOn'; params?: undefined }
+  | { module: 'steeringWheel'; action: 'turnLedOff'; params?: undefined };
+
+export type SoundModuleCommands = { module: 'sound'; action: 'play'; params: PlaySoundOptions };
+
+export type AllCommandsConfig =
+  | BallSensorDiskThrowerModuleCommands
+  | DiskSensorBallShooterModuleCommands
+  | FlagModuleCommands
+  | RGBModuleCommands
+  | SpeedModuleCommands
+  | LeftStarBackLaserModuleCommands
+  | RightStarFrontLaserModuleCommands
+  | ScreenModuleCommands
+  | SteeringWheelModuleCommands
+  | SoundModuleCommands;

package/src/types/command/index.ts

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

package/src/types/damage/Damage.ts

@@ -0,0 +1,15 @@
+import type { KartEffect } from '../hardware';
+import type { SoundName } from '../sounds';
+import type { DamageEffectName } from './DamageName';
+import type { DamageTarget } from './DamageTarget';
+
+export interface Damage {
+  name: DamageEffectName;
+  target: DamageTarget;
+  /** Time in seconds */
+  duration: number;
+  sound: SoundName;
+  rgbEffect: KartEffect;
+  /** Quantity of damage will affect the Kart */
+  amount: number;
+}

package/src/types/damage/DamageName.ts

@@ -0,0 +1 @@
+export type DamageEffectName = 'Trap Hit' | 'Pulse Hit' | 'Star Hit Left' | 'Star Hit Right' | 'Shot Hit';

package/src/types/damage/DamageTarget.ts

@@ -0,0 +1 @@
+export type DamageTarget = 'Any' | 'All' | 'First' | 'Last' | 'Next' | 'Previous';

package/src/types/damage/index.ts

@@ -0,0 +1,3 @@
+export * from './Damage';
+export * from './DamageName';
+export * from './DamageTarget';

package/src/types/flow/Flow.ts

@@ -0,0 +1,8 @@
+import type { AllCommandsConfig } from '../command';
+
+export interface Flow {
+  id: number;
+  name: string;
+  description?: string;
+  commands: AllCommandsConfig[];
+}

package/src/types/flow/index.ts

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

package/src/types/game/Game.ts

@@ -0,0 +1,39 @@
+import type { GameTrack } from '../gameTrack';
+import type { PowerUp } from '../powerUp';
+import type { GameStatus } from './GameStatus';
+import type { GameType } from './GameType';
+import type { KartRankingItem } from './KartRankingItem';
+
+export enum GameFinishedReason {
+  /** The time set for the game was over */
+  TIME_IS_OVER = 'TIME_IS_OVER',
+  /** There is a winner on the game */
+  GAME_KARTS_FINISHED = 'GAME_KARTS_FINISHED',
+  /** The game was stopped by an emergency */
+  EMERGENCY = 'EMERGENCY',
+  /** The Controller of the game finished the game */
+  BY_CONTROLLER = 'BY_CONTROLLER',
+}
+
+export interface GameKartState {
+  coins: number;
+}
+
+export interface Game {
+  id: number;
+  status: GameStatus;
+  kartsGuids: string[];
+  powerUpsIds: PowerUp['id'][];
+  gameTrackId: GameTrack['id'];
+  type: GameType;
+  coins: number;
+  /** Time set in seconds */
+  time: number;
+  createdAt: Date;
+  startedAt?: Date;
+  finishedAt?: Date;
+  finishedReason?: GameFinishedReason;
+  /** The key is the kart guid */
+  kartsState: Record<string, GameKartState>;
+  gameRanking: KartRankingItem[];
+}

package/src/types/game/GameStatus.ts

@@ -0,0 +1,10 @@
+export const gameStatus = ['non-started', 'active', 'yellow-flag', 'red-flag', 'finished'] as const;
+export type GameStatus = (typeof gameStatus)[number];
+
+export enum GameStatusEnum {
+  NON_STARTED,
+  ACTIVE,
+  YELLOW_FLAG,
+  RED_FLAG,
+  FINISHED,
+}

package/src/types/game/GameType.ts

@@ -0,0 +1,6 @@
+export type GameType = 'Race' | 'Battle';
+
+export enum GameTypeEnum {
+  Race,
+  Battle,
+}

package/src/types/game/GameWarningEvent.ts

@@ -0,0 +1 @@
+export type GameWarningEvent = 'yellow-flag' | 'red-flag';

package/src/types/game/KartRankingItem.ts

@@ -0,0 +1,5 @@
+export interface KartRankingItem {
+  kartGuid: string;
+  position: number;
+  time: number;
+}

package/src/types/game/battle/Battle.ts

@@ -0,0 +1,11 @@
+import type { Game, GameKartState } from '../Game';
+
+export interface BattleKartState extends GameKartState {
+  lives: number;
+}
+
+export interface Battle extends Game {
+  type: 'Battle';
+  lives: number;
+  kartsState: Record<string, BattleKartState>;
+}

package/src/types/game/battle/index.ts

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

package/src/types/game/index.ts

@@ -0,0 +1,7 @@
+export * from './battle';
+export * from './Game';
+export * from './GameStatus';
+export * from './GameType';
+export * from './GameWarningEvent';
+export * from './KartRankingItem';
+export * from './race';

package/src/types/game/race/KartProgress.ts

@@ -0,0 +1,10 @@
+export interface KartProgress {
+  checkpointId: string;
+  checkpointProgress: number;
+  timestampISO: {
+    origin: string;
+    server: string;
+  };
+  lap: number;
+  totalProgress: number;
+}

package/src/types/game/race/Race.ts

@@ -0,0 +1,20 @@
+import type { Game, GameKartState } from '../Game';
+import type { KartRankingItem } from '../KartRankingItem';
+import type { KartProgress } from './KartProgress';
+
+export interface RaceKartState extends GameKartState {
+  currentLap: number;
+}
+
+export interface RaceRakingItem extends KartRankingItem {
+  progress: number;
+  lapsCompleted: number;
+}
+
+export interface Race extends Game {
+  type: 'Race';
+  laps: number;
+  kartsState: Record<string, RaceKartState>;
+  kartsProgress: Record<string, KartProgress[]>;
+  gameRanking: RaceRakingItem[];
+}

package/src/types/game/race/index.ts

@@ -0,0 +1,2 @@
+export * from './KartProgress';
+export * from './Race';

package/src/types/gameTrack/GameTrack.ts

@@ -0,0 +1,13 @@
+import type { Checkpoint } from '../checkpoint';
+import type { GameType } from '../game';
+import type { GameTrackKartsConfig } from './GameTrackKartsConfig';
+
+export interface GameTrack {
+  id: string;
+  name: string;
+  type: GameType;
+  checkpoints: Checkpoint[];
+  kartsConfig: GameTrackKartsConfig;
+  macAddress?: string;
+  isConnected: boolean;
+}

package/src/types/gameTrack/GameTrackKartsConfig.ts

@@ -0,0 +1,25 @@
+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.
+ *
+ * powerUpTime: Will be the time configuration of each Module.
+ */
+export interface GameTrackKartsConfig {
+  /** Percentage (0% - 100%) */
+  defaultSpeed: number;
+  /** Time in seconds: (1s - 25s) */
+  powerUpTime: number;
+  /** % Of Brightness (0 - 100) */
+  rgbBrightness: number;
+  /** % Of Brightness (0 - 100) */
+  flagBrightness: number;
+  /** Full Configuration of the Disk Sensor Ball Shooter */
+  diskSensorBallShooter: ConfigDiskSensorBallShooterModuleOptions;
+  /** Full Configuration of the Ball Sensor Disk Thrower */
+  ballSensorDiskThrower: ConfigureBallSensorDiskThrowerModuleOptions;
+}

package/src/types/gameTrack/index.ts

@@ -0,0 +1,2 @@
+export * from './GameTrack';
+export * from './GameTrackKartsConfig';

package/src/types/hardware/KartEffect.ts

@@ -0,0 +1,19 @@
+export type KartEffect =
+  | 'Show Color Kart'
+  | 'Star Effect'
+  | 'Ray Effect'
+  | 'Ray Hit Effect'
+  | 'Speed Boost Effect'
+  | 'Charged Power Effect'
+  | 'Roulette Effect'
+  | 'Shield Effect'
+  | 'Broken Shield Effect'
+  | 'Hit Right Effect'
+  | 'Hit Left Effect'
+  | 'Hit Front Effect'
+  | 'Hit Back Effect'
+  | 'Hit Disk Effect'
+  | 'Ball Shot Effect'
+  | 'Disk Shot Effect'
+  | 'Emergency Effect'
+  | 'Wait Effect';

package/src/types/hardware/ModuleName.ts

@@ -0,0 +1,10 @@
+export type ModuleName =
+  | 'speed'
+  | 'flag'
+  | 'rgb'
+  | 'disk-sensor-ball-shooter'
+  | 'ball-sensor-disk-thrower'
+  | 'left-star-back-laser'
+  | 'right-star-front-laser'
+  | 'screen'
+  | 'emergency';