@battle-racing/br-common-lib 1.5.1 → 2.0.0

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

@@ -0,0 +1,9 @@
+export declare const DAMAGE_EFFECT: {
+    readonly GENERIC: "Generic";
+    readonly TRAP_HIT: "Trap Hit";
+    readonly PULSE_HIT: "Pulse Hit";
+    readonly STAR_HIT_LEFT: "Star Hit Left";
+    readonly STAR_HIT_RIGHT: "Star Hit Right";
+    readonly SHOT_HIT: "Shot Hit";
+    readonly SHORTCUT: "Shortcut";
+};

package/dist/constants/hardware/damage.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DAMAGE_EFFECT = void 0;
+exports.DAMAGE_EFFECT = {
+    GENERIC: 'Generic',
+    TRAP_HIT: 'Trap Hit',
+    PULSE_HIT: 'Pulse Hit',
+    STAR_HIT_LEFT: 'Star Hit Left',
+    STAR_HIT_RIGHT: 'Star Hit Right',
+    SHOT_HIT: 'Shot Hit',
+    SHORTCUT: 'Shortcut',
+};

package/dist/constants/kart-status.d.ts

@@ -6,3 +6,7 @@ export declare const KART_STATUS: {
     readonly PITS: "pits";
     readonly ELIMINATED: "eliminated";
 };
+export declare const KART_FINAL_STATE: {
+    readonly VICTORY: "Victory";
+    readonly DEFEAT: "Defeat";
+};

package/dist/constants/kart-status.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KART_STATUS = void 0;
+exports.KART_FINAL_STATE = exports.KART_STATUS = void 0;
 exports.KART_STATUS = {
     STAND_BY: 'standBy',
     IN_GAME: 'in-game',
@@ -9,3 +9,7 @@ exports.KART_STATUS = {
     PITS: 'pits',
     ELIMINATED: 'eliminated',
 };
+exports.KART_FINAL_STATE = {
+    VICTORY: 'Victory',
+    DEFEAT: 'Defeat',
+};

package/dist/types/damage/DamageName.d.ts

@@ -1 +1,3 @@
-export type DamageEffectName = 'Trap Hit' | 'Pulse Hit' | 'Star Hit Left' | 'Star Hit Right' | 'Shot Hit';
+import { DAMAGE_EFFECT } from '../../constants/hardware/damage';
+import { ObjectValues } from '../utils';
+export type DamageEffectName = ObjectValues<typeof DAMAGE_EFFECT>;

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

@@ -1,4 +1,4 @@
-import type { ScreenViewBaseConfig } from './ScreenViewBaseConfig';
+import type { ScreenViewBaseConfig, ScreenCurrentTotal } from './ScreenViewBaseConfig';
 export type ScreenBattleViewConfig = ScreenViewBaseConfig & {
-    lives?: number | null;
+    lives?: ScreenCurrentTotal;
 };

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

@@ -1,7 +1,10 @@
+import { KART_FINAL_STATE } from '../../../constants';
+import { ObjectValues } from '../../utils';
+import { ScreenCurrentTotal } from './ScreenViewBaseConfig';
+export type KartFinalState = ObjectValues<typeof KART_FINAL_STATE>;
 export type ScreenFinishViewInput = {
-    kartPosition: {
-        currentPosition: number;
-        totalKarts: number;
-    };
+    kartNumber?: number;
+    kartPosition: ScreenCurrentTotal;
     coins: number;
+    finalState?: KartFinalState;
 };

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

@@ -0,0 +1,3 @@
+export type ScreenHomeViewInput = {
+    kartNumber?: number | null;
+};

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

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

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

@@ -1,5 +1,4 @@
-import type { ScreenRaceLaps } from './ScreenRaceLaps';
-import type { ScreenViewBaseConfig } from './ScreenViewBaseConfig';
+import type { ScreenViewBaseConfig, ScreenCurrentTotal } from './ScreenViewBaseConfig';
 export type ScreenRaceViewConfig = ScreenViewBaseConfig & {
-    laps?: ScreenRaceLaps;
+    laps?: ScreenCurrentTotal;
 };

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

@@ -1,11 +1,16 @@
 import type { DamageEffectName } from '../../damage';
 import type { PowerUpName } from '../../powerUp';
 import type { ScreenGameTimeLeft } from './ScreenGameTimeLeft';
-import type { ScreenKartPosition } from './ScreenKartPosition';
+export type ScreenCurrentTotal = {
+    current: number | null;
+    total: number | null;
+};
 export type ScreenViewBaseConfig = {
-    position?: ScreenKartPosition;
+    position?: ScreenCurrentTotal;
     coins?: number | null;
     gameTimeLeft?: ScreenGameTimeLeft;
     powerUp?: PowerUpName | 'Clear PowerUp' | null;
-    damageEffect?: DamageEffectName | null;
+    powerUpAnimationTimeSeconds?: number | null;
+    damageEffect?: DamageEffectName | 'Yellow Flag' | 'Red Flag' | null;
+    damageAnimationTimeSeconds?: 'Infinite' | number | null;
 };

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

@@ -2,8 +2,7 @@ export * from './ScreenBattleViewConfig';
 export * from './ScreenCountdownParams';
 export * from './ScreenFinishViewInput';
 export * from './ScreenGameTimeLeft';
-export * from './ScreenKartPosition';
-export * from './ScreenRaceLaps';
+export * from './ScreenHomeViewInput';
 export * from './ScreenRaceViewConfig';
 export * from './ScreenUpdateGameViewInput';
 export * from './ScreenView';

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

@@ -18,8 +18,7 @@ __exportStar(require("./ScreenBattleViewConfig"), exports);
 __exportStar(require("./ScreenCountdownParams"), exports);
 __exportStar(require("./ScreenFinishViewInput"), exports);
 __exportStar(require("./ScreenGameTimeLeft"), exports);
-__exportStar(require("./ScreenKartPosition"), exports);
-__exportStar(require("./ScreenRaceLaps"), exports);
+__exportStar(require("./ScreenHomeViewInput"), exports);
 __exportStar(require("./ScreenRaceViewConfig"), exports);
 __exportStar(require("./ScreenUpdateGameViewInput"), exports);
 __exportStar(require("./ScreenView"), exports);

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

@@ -1,4 +1,4 @@
-import type { ConfigDiskSensorBallShooterModuleOptions, ConfigureBallSensorDiskThrowerModuleOptions, FlagConfigurationOptions, FlagShowMediaOptions, PlaySoundOptions, RGBConfigurationOptions, RGBShowEffectOptions, ScreenCountdownParams, ScreenFinishViewInput, ScreenUpdateGameViewInput, SpeedChangeOptions, SpeedConfiguration, StarLaserConfigureModuleOptions, StarLaserSendActionsOptions } from '../hardware';
+import type { ConfigDiskSensorBallShooterModuleOptions, ConfigureBallSensorDiskThrowerModuleOptions, FlagConfigurationOptions, FlagShowMediaOptions, PlaySoundOptions, RGBConfigurationOptions, RGBShowEffectOptions, ScreenCountdownParams, ScreenFinishViewInput, ScreenHomeViewInput, ScreenUpdateGameViewInput, SpeedChangeOptions, SpeedConfiguration, StarLaserConfigureModuleOptions, StarLaserSendActionsOptions } from '../hardware';
 export type SocketHardwareDataSubscriptionEventsParams = {
     'hardware:data:subscribe': undefined;
     'hardware:data:unsubscribe': undefined;
@@ -45,7 +45,7 @@ export type SocketHardwareRightStarFrontLaserModuleEventsParams = {
     'hardware:right-star-front-laser:configure': StarLaserConfigureModuleOptions;
 };
 export type SocketHardwareScreenModuleEventsParams = {
-    'hardware:screen:showHomeView': undefined;
+    'hardware:screen:showHomeView': ScreenHomeViewInput;
     'hardware:screen:showCountdownView': ScreenCountdownParams;
     'hardware:screen:updateGameView': ScreenUpdateGameViewInput;
     'hardware:screen:showScreenVictoryView': ScreenFinishViewInput;

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

@@ -1,6 +1,6 @@
 import type { Game, GameType } from '../../game';
 import type { GameTrack } from '../../gameTrack';
-import type { Kart } from '../../kart';
+import type { Kart, KartStatus } from '../../kart';
 import type { Response } from '../../response';
 import type { SocketPowerUpEventsParams } from '../SocketPowerUpEventsParams';
 interface BaseGameEventParams {
@@ -23,6 +23,10 @@ export interface SocketKartEventsParams {
     'kart:gameTrack:emergency:started': undefined;
     /** When the physical button of the game track is released */
     'kart:gameTrack:emergency:stopped': undefined;
+    /** Force kart to change status */
+    'kart:status:change': {
+        status: KartStatus;
+    };
 }
 export interface SocketGameEventParams {
     /** Kart is selected for a game */

package/package.json

@@ -1,12 +1,24 @@
 {
   "name": "@battle-racing/br-common-lib",
-  "version": "1.5.1",
+  "version": "2.0.0",
   "description": "Common library for all Battle Racing Repositorios",
   "main": "dist/index.js",
+  "module": "dist/index.js",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "scripts": {
     "build": "tsc",
-    "release": "rm -rf dist && npm run build && npm publish --access public"
+    "release": "npm run build && npm publish --access public",
+    "release:patch": "npm version patch && npm run release",
+    "release:minor": "npm version minor && npm run release",
+    "release:major": "npm version major && npm run release",
+    "prepublishOnly": "npm run build"
   },
   "keywords": [
     "Battle",

package/src/constants/hardware/damage.ts

@@ -0,0 +1,9 @@
+export const DAMAGE_EFFECT = {
+  GENERIC: 'Generic',
+  TRAP_HIT: 'Trap Hit',
+  PULSE_HIT: 'Pulse Hit',
+  STAR_HIT_LEFT: 'Star Hit Left',
+  STAR_HIT_RIGHT: 'Star Hit Right',
+  SHOT_HIT: 'Shot Hit',
+  SHORTCUT: 'Shortcut',
+} as const;

package/src/constants/kart-status.ts

@@ -6,3 +6,8 @@ export const KART_STATUS = {
   PITS: 'pits',
   ELIMINATED: 'eliminated',
 } as const;
+
+export const KART_FINAL_STATE = {
+  VICTORY: 'Victory',
+  DEFEAT: 'Defeat',
+} as const;

package/src/types/damage/DamageName.ts

@@ -1 +1,4 @@
-export type DamageEffectName = 'Trap Hit' | 'Pulse Hit' | 'Star Hit Left' | 'Star Hit Right' | 'Shot Hit';
+import { DAMAGE_EFFECT } from '../../constants/hardware/damage';
+import { ObjectValues } from '../utils';
+
+export type DamageEffectName = ObjectValues<typeof DAMAGE_EFFECT>;

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

@@ -1,5 +1,5 @@
-import type { ScreenViewBaseConfig } from './ScreenViewBaseConfig';
+import type { ScreenViewBaseConfig, ScreenCurrentTotal } from './ScreenViewBaseConfig';
 
 export type ScreenBattleViewConfig = ScreenViewBaseConfig & {
-  lives?: number | null;
+  lives?: ScreenCurrentTotal;
 };

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

@@ -1,7 +1,12 @@
+import { KART_FINAL_STATE } from '../../../constants';
+import { ObjectValues } from '../../utils';
+import { ScreenCurrentTotal } from './ScreenViewBaseConfig';
+
+export type KartFinalState = ObjectValues<typeof KART_FINAL_STATE>;
+
 export type ScreenFinishViewInput = {
-  kartPosition: {
-    currentPosition: number;
-    totalKarts: number;
-  };
+  kartNumber?: number;
+  kartPosition: ScreenCurrentTotal;
   coins: number;
+  finalState?: KartFinalState;
 };

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

@@ -0,0 +1,3 @@
+export type ScreenHomeViewInput = {
+  kartNumber?: number | null;
+};

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

@@ -1,6 +1,5 @@
-import type { ScreenRaceLaps } from './ScreenRaceLaps';
-import type { ScreenViewBaseConfig } from './ScreenViewBaseConfig';
+import type { ScreenViewBaseConfig, ScreenCurrentTotal } from './ScreenViewBaseConfig';
 
 export type ScreenRaceViewConfig = ScreenViewBaseConfig & {
-  laps?: ScreenRaceLaps;
+  laps?: ScreenCurrentTotal;
 };

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

@@ -1,12 +1,18 @@
 import type { DamageEffectName } from '../../damage';
 import type { PowerUpName } from '../../powerUp';
 import type { ScreenGameTimeLeft } from './ScreenGameTimeLeft';
-import type { ScreenKartPosition } from './ScreenKartPosition';
+
+export type ScreenCurrentTotal = {
+  current: number | null;
+  total: number | null;
+};
 
 export type ScreenViewBaseConfig = {
-  position?: ScreenKartPosition;
+  position?: ScreenCurrentTotal;
   coins?: number | null;
   gameTimeLeft?: ScreenGameTimeLeft;
   powerUp?: PowerUpName | 'Clear PowerUp' | null;
-  damageEffect?: DamageEffectName | null;
+  powerUpAnimationTimeSeconds?: number | null;
+  damageEffect?: DamageEffectName | 'Yellow Flag' | 'Red Flag' | null;
+  damageAnimationTimeSeconds?: 'Infinite' | number | null;
 };

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

@@ -2,8 +2,7 @@ export * from './ScreenBattleViewConfig';
 export * from './ScreenCountdownParams';
 export * from './ScreenFinishViewInput';
 export * from './ScreenGameTimeLeft';
-export * from './ScreenKartPosition';
-export * from './ScreenRaceLaps';
+export * from './ScreenHomeViewInput';
 export * from './ScreenRaceViewConfig';
 export * from './ScreenUpdateGameViewInput';
 export * from './ScreenView';

package/src/types/socket/SocketHardwareModulesEventsParams.ts

@@ -8,6 +8,7 @@ import type {
   RGBShowEffectOptions,
   ScreenCountdownParams,
   ScreenFinishViewInput,
+  ScreenHomeViewInput,
   ScreenUpdateGameViewInput,
   SpeedChangeOptions,
   SpeedConfiguration,
@@ -69,7 +70,7 @@ export type SocketHardwareRightStarFrontLaserModuleEventsParams = {
 };
 
 export type SocketHardwareScreenModuleEventsParams = {
-  'hardware:screen:showHomeView': undefined;
+  'hardware:screen:showHomeView': ScreenHomeViewInput;
   'hardware:screen:showCountdownView': ScreenCountdownParams;
   'hardware:screen:updateGameView': ScreenUpdateGameViewInput;
   'hardware:screen:showScreenVictoryView': ScreenFinishViewInput;

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

@@ -1,6 +1,6 @@
 import type { Game, GameType } from '../../game';
 import type { GameTrack } from '../../gameTrack';
-import type { Kart } from '../../kart';
+import type { Kart, KartStatus } from '../../kart';
 import type { Response } from '../../response';
 import type { SocketPowerUpEventsParams } from '../SocketPowerUpEventsParams';
 
@@ -24,6 +24,8 @@ export interface SocketKartEventsParams {
   'kart:gameTrack:emergency:started': undefined;
   /** When the physical button of the game track is released */
   'kart:gameTrack:emergency:stopped': undefined;
+  /** Force kart to change status */
+  'kart:status:change': { status: KartStatus };
 }
 
 export interface SocketGameEventParams {

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

@@ -1,4 +0,0 @@
-export type ScreenKartPosition = {
-  currentPosition: number | null;
-  totalKarts: number | null;
-};

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

@@ -1,4 +0,0 @@
-export type ScreenRaceLaps = {
-  currentLap: number | null;
-  totalLaps: number | null;
-};