@battle-racing/br-common-lib 6.0.0-rc.0 → 6.1.0-rc.0

package/RELEASING.md

@@ -0,0 +1,111 @@
+# Publicar versiones de `br-common-lib`
+
+Esta librería la consumen cuatro repositorios (`game-manager-backend`, `kart-manager`,
+`webapp-battle-racing`, `screen-web-RPI`). Un cambio incompatible los rompe a todos, así que
+todo cambio se prueba primero como **release candidate (RC)** y solo se publica como versión
+oficial cuando ya se validó el cambio.
+
+Hay dos roles:
+
+| Rol                     | Qué publica        | Cómo                                 |
+| :---------------------- | :----------------- | :----------------------------------- |
+| Cualquier desarrollador | RCs (`X.Y.Z-rc.N`) | GitHub Actions → **Publish RC**      |
+| Mantenedor              | Versión oficial    | `npm run release:*` desde su máquina |
+
+---
+
+## Elegir el bump: la tabla que evita el error
+
+Esta es la parte donde se equivoca todo el mundo. La pregunta no es "qué tan grande es mi
+cambio", sino **"¿es la primera RC de este cambio, o ya venía iterando?"**
+
+| Situación                                                | Bump         | Ejemplo desde `6.0.0-rc.0` |
+| :------------------------------------------------------- | :----------- | :------------------------- |
+| **Primera** RC de un cambio incompatible                 | `premajor`   | `7.0.0-rc.0`               |
+| **Primera** RC de una funcionalidad retrocompatible      | `preminor`   | `6.1.0-rc.0`               |
+| **Primera** RC de un arreglo menor                       | `prepatch`   | `6.0.1-rc.0`               |
+| **Otra** RC del mismo cambio (corregir algo, reintentar) | `prerelease` | `6.0.0-rc.1`               |
+
+> **La regla:** `premajor` / `preminor` / `prepatch` se usan **una sola vez por cambio**.
+> A partir de ahí, siempre `prerelease`.
+
+Si te equivocas y usas `premajor` dos veces, terminas con una versión mayor que nunca existió
+como release (`5.0.0` saltando a `6.0.0`). El error que cometió el bruto de JD **No es grave y no hay que arreglarlo:** `latest` no
+se movió y nadie consumió esa versión. Sigue con `prerelease` desde donde quedaste. Las
+versiones publicadas en npm no se pueden reutilizar ni borrar, así que no intentes "volver atrás".
+
+---
+
+## Publicar una RC
+
+0. Has push de tu rama.
+1. Repositorio → pestaña **Actions**
+2. En la barra izquierda: **Publish RC**
+3. **Run workflow**
+4. **Branch:** la rama que estás probando
+5. **Version bump:** según la tabla de arriba
+6. **Run workflow**
+
+Al terminar, abrí el run → **Summary**. Ahí está la línea lista para pegar en el consumidor.
+
+### Probarla en un consumidor
+
+Versión **exacta**, sin `^`:
+
+```json
+"@battle-racing/br-common-lib": "6.0.0-rc.1"
+```
+
+El caret con prereleases se comporta de forma poco intuitiva, y sobre hardware querés saber
+exactamente qué build está corriendo.
+
+```bash
+npm install @battle-racing/br-common-lib@6.0.0-rc.1
+```
+
+### Verificar que salió bien
+
+```bash
+npm view @battle-racing/br-common-lib dist-tags
+# esperado:  { latest: '<la oficial>', rc: '6.0.0-rc.1' }
+```
+
+Si `latest` se movió, algo está mal en el workflow. Pará y avisá antes de seguir.
+
+---
+
+## Publicar la versión oficial
+
+Solo el mantenedor, y solo cuando la RC ya se validó en pista.
+
+```bash
+git checkout main && git pull
+npm run release:major     # o release:minor / release:patch
+```
+
+Desde `6.0.0-rc.3`, `release:major` publica `6.0.0` — quita el sufijo de RC, no salta a `7.0.0`.
+
+Después, repinear los consumidores a la versión final y quitar el pin exacto de la RC.
+
+---
+
+## Qué protege a `latest`
+
+- El workflow tiene `--tag rc` **hardcodeado**, sin input. Desde Actions no se puede mover `latest`.
+- Los rangos de semver nunca resuelven a prereleases salvo que se pidan explícitamente: un
+  consumidor en `^4.9.1` no va a agarrar una `6.0.0-rc.0` ni por accidente.
+- La publicación usa **trusted publishing (OIDC)**: no hay token de npm en ningún lado.
+
+**Límite conocido:** al despachar el workflow se ejecuta la copia del `.yml` **de la rama
+seleccionada**. Quien tenga permiso de escritura puede editar ese archivo en su rama y quitar
+el `--tag rc`. La protección real contra eso es un Environment con revisor obligatorio, que
+requiere repo público o plan de pago.
+
+---
+
+## Notas
+
+- El commit y el tag de versión quedan en la rama desde la que publicaste. Al mergear a `main`
+  puede haber conflicto en el `package.json` si `main` avanzó por otro lado.
+- Las RC publicadas son públicas y permanentes (se pueden deprecar, pero solo desaparecen si se
+  despublican dentro de las primeras 72 horas).

package/dist/domains/hardware/KartHardwareState.schema.d.ts

@@ -52,10 +52,11 @@ export declare const kartHardwareStateSchema: z.ZodObject<{
     steeringWheel: z.ZodNullable<z.ZodObject<{
         ledStatus: z.ZodEnum<{
             readonly OFF: "Off";
-            readonly IDLE: "Idle";
-            readonly POWER_UP: "Power-Up";
-            readonly EMERGENCY: "Emergency";
+            readonly COLOR: "Color";
+            readonly EFFECT: "Effect";
             readonly CONFIG: "Config";
+            readonly ERROR: "Error";
+            readonly UNKNOWN: "Unknown";
         }>;
         buttons: z.ZodObject<{
             powerRightPressed: z.ZodBoolean;

package/dist/domains/hardware/ModuleStatus.schema.d.ts

@@ -109,10 +109,11 @@ export declare const moduleStatusSchema: z.ZodUnion<readonly [z.ZodObject<{
 }, z.core.$strip>, z.ZodObject<{
     ledStatus: z.ZodEnum<{
         readonly OFF: "Off";
-        readonly IDLE: "Idle";
-        readonly POWER_UP: "Power-Up";
-        readonly EMERGENCY: "Emergency";
+        readonly COLOR: "Color";
+        readonly EFFECT: "Effect";
         readonly CONFIG: "Config";
+        readonly ERROR: "Error";
+        readonly UNKNOWN: "Unknown";
     }>;
     buttons: z.ZodObject<{
         powerRightPressed: z.ZodBoolean;

package/dist/domains/hardware/screen/ScreenDebug.schema.d.ts

@@ -52,10 +52,11 @@ export declare const screenDebugViewInputSchema: z.ZodObject<{
     steeringWheel: z.ZodNullable<z.ZodObject<{
         ledStatus: z.ZodEnum<{
             readonly OFF: "Off";
-            readonly IDLE: "Idle";
-            readonly POWER_UP: "Power-Up";
-            readonly EMERGENCY: "Emergency";
+            readonly COLOR: "Color";
+            readonly EFFECT: "Effect";
             readonly CONFIG: "Config";
+            readonly ERROR: "Error";
+            readonly UNKNOWN: "Unknown";
         }>;
         buttons: z.ZodObject<{
             powerRightPressed: z.ZodBoolean;

package/dist/domains/hardware/steering-wheel/SteeringWheel.const.d.ts

@@ -6,15 +6,26 @@ export declare const STEERING_WHEEL_ACTION_COMMAND: {
     readonly CONFIGURE_LEDS: "ConfigureLeds";
 };
 export declare const STEERING_WHEEL_SHOW_LED_EFFECT_OPTIONS: {
-    readonly SHOW_LED_IDLE_EFFECT: "ShowLedIdleEffect";
-    readonly SHOW_LED_POWERUP_EFFECT: "ShowLedPowerupEffect";
-    readonly SHOW_LED_EMERGENCY_EFFECT: "ShowLedEmergencyEffect";
-    readonly SHOW_LED_CONFIG_EFFECT: "ShowLedConfigEffect";
+    readonly SHOW_COLOR: "ShowColor";
+    readonly STAR: "Star";
+    readonly RAY: "Ray";
+    readonly RAY_HIT: "RayHit";
+    readonly SPEED_BOOST: "SpeedBoost";
+    readonly CHARGED_POWER: "ChargedPower";
+    readonly ROULETTE: "Roulette";
+    readonly SHIELD: "Shield";
+    readonly BROKEN_SHIELD: "BrokenShield";
+    readonly WAIT: "Wait";
+    readonly STANDARD: "Standard";
+    readonly POWER_UP: "PowerUp";
+    readonly EMERGENCY: "Emergency";
+    readonly TRAFFIC_LIGHT: "TrafficLight";
 };
 export declare const STEERING_WHEEL_LED_STATUS: {
     readonly OFF: "Off";
-    readonly IDLE: "Idle";
-    readonly POWER_UP: "Power-Up";
-    readonly EMERGENCY: "Emergency";
+    readonly COLOR: "Color";
+    readonly EFFECT: "Effect";
     readonly CONFIG: "Config";
+    readonly ERROR: "Error";
+    readonly UNKNOWN: "Unknown";
 };

package/dist/domains/hardware/steering-wheel/SteeringWheel.const.js

@@ -9,15 +9,26 @@ exports.STEERING_WHEEL_ACTION_COMMAND = {
     CONFIGURE_LEDS: 'ConfigureLeds',
 };
 exports.STEERING_WHEEL_SHOW_LED_EFFECT_OPTIONS = {
-    SHOW_LED_IDLE_EFFECT: 'ShowLedIdleEffect',
-    SHOW_LED_POWERUP_EFFECT: 'ShowLedPowerupEffect',
-    SHOW_LED_EMERGENCY_EFFECT: 'ShowLedEmergencyEffect',
-    SHOW_LED_CONFIG_EFFECT: 'ShowLedConfigEffect',
+    SHOW_COLOR: 'ShowColor',
+    STAR: 'Star',
+    RAY: 'Ray',
+    RAY_HIT: 'RayHit',
+    SPEED_BOOST: 'SpeedBoost',
+    CHARGED_POWER: 'ChargedPower',
+    ROULETTE: 'Roulette',
+    SHIELD: 'Shield',
+    BROKEN_SHIELD: 'BrokenShield',
+    WAIT: 'Wait',
+    STANDARD: 'Standard',
+    POWER_UP: 'PowerUp',
+    EMERGENCY: 'Emergency',
+    TRAFFIC_LIGHT: 'TrafficLight',
 };
 exports.STEERING_WHEEL_LED_STATUS = {
     OFF: 'Off',
-    IDLE: 'Idle',
-    POWER_UP: 'Power-Up',
-    EMERGENCY: 'Emergency',
+    COLOR: 'Color',
+    EFFECT: 'Effect',
     CONFIG: 'Config',
+    ERROR: 'Error',
+    UNKNOWN: 'Unknown',
 };

package/dist/domains/hardware/steering-wheel/SteeringWheel.schema.d.ts

@@ -7,18 +7,20 @@ export declare const steeringWheelActionCommandSchema: z.ZodEnum<{
 }>;
 export declare const steeringWheelLedStatusSchema: z.ZodEnum<{
     readonly OFF: "Off";
-    readonly IDLE: "Idle";
-    readonly POWER_UP: "Power-Up";
-    readonly EMERGENCY: "Emergency";
+    readonly COLOR: "Color";
+    readonly EFFECT: "Effect";
     readonly CONFIG: "Config";
+    readonly ERROR: "Error";
+    readonly UNKNOWN: "Unknown";
 }>;
 export declare const steeringWheelModuleStatusSchema: z.ZodObject<{
     ledStatus: z.ZodEnum<{
         readonly OFF: "Off";
-        readonly IDLE: "Idle";
-        readonly POWER_UP: "Power-Up";
-        readonly EMERGENCY: "Emergency";
+        readonly COLOR: "Color";
+        readonly EFFECT: "Effect";
         readonly CONFIG: "Config";
+        readonly ERROR: "Error";
+        readonly UNKNOWN: "Unknown";
     }>;
     buttons: z.ZodObject<{
         powerRightPressed: z.ZodBoolean;
@@ -30,12 +32,36 @@ export declare const steeringWheelModuleStatusSchema: z.ZodObject<{
     }, z.core.$strip>;
 }, z.core.$strip>;
 export declare const steeringWheelShowLedsEffectOptionsSchema: z.ZodEnum<{
-    readonly SHOW_LED_IDLE_EFFECT: "ShowLedIdleEffect";
-    readonly SHOW_LED_POWERUP_EFFECT: "ShowLedPowerupEffect";
-    readonly SHOW_LED_EMERGENCY_EFFECT: "ShowLedEmergencyEffect";
-    readonly SHOW_LED_CONFIG_EFFECT: "ShowLedConfigEffect";
+    readonly SHOW_COLOR: "ShowColor";
+    readonly STAR: "Star";
+    readonly RAY: "Ray";
+    readonly RAY_HIT: "RayHit";
+    readonly SPEED_BOOST: "SpeedBoost";
+    readonly CHARGED_POWER: "ChargedPower";
+    readonly ROULETTE: "Roulette";
+    readonly SHIELD: "Shield";
+    readonly BROKEN_SHIELD: "BrokenShield";
+    readonly WAIT: "Wait";
+    readonly STANDARD: "Standard";
+    readonly POWER_UP: "PowerUp";
+    readonly EMERGENCY: "Emergency";
+    readonly TRAFFIC_LIGHT: "TrafficLight";
 }>;
 export declare const steeringWheelConfigureLedsOptionsSchema: z.ZodObject<{
     brightness: z.ZodNumber;
     durationSeconds: z.ZodNumber;
+    colorBody: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+        readonly Black: "Black";
+        readonly Red: "Red";
+        readonly Blue: "Blue";
+        readonly Green: "Green";
+        readonly Yellow: "Yellow";
+        readonly Violet: "Violet";
+        readonly Cyan: "Cyan";
+        readonly Magenta: "Magenta";
+        readonly Orange: "Orange";
+        readonly White: "White";
+        readonly GreenYellow: "GreenYellow";
+        readonly SaddleBrown: "SaddleBrown";
+    }>>>;
 }, z.core.$strip>;

package/dist/domains/hardware/steering-wheel/SteeringWheel.schema.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.steeringWheelConfigureLedsOptionsSchema = exports.steeringWheelShowLedsEffectOptionsSchema = exports.steeringWheelModuleStatusSchema = exports.steeringWheelLedStatusSchema = exports.steeringWheelActionCommandSchema = void 0;
 const zod_1 = require("zod");
+const Color_schema_1 = require("../../color/Color.schema");
+const Color_const_1 = require("../../color/Color.const");
 const SteeringWheel_const_1 = require("./SteeringWheel.const");
 exports.steeringWheelActionCommandSchema = zod_1.z.enum(SteeringWheel_const_1.STEERING_WHEEL_ACTION_COMMAND);
 exports.steeringWheelLedStatusSchema = zod_1.z.enum(SteeringWheel_const_1.STEERING_WHEEL_LED_STATUS);
@@ -20,4 +22,5 @@ exports.steeringWheelShowLedsEffectOptionsSchema = zod_1.z.enum(SteeringWheel_co
 exports.steeringWheelConfigureLedsOptionsSchema = zod_1.z.object({
     brightness: zod_1.z.number().min(0).max(100),
     durationSeconds: zod_1.z.number().min(1).max(25),
+    colorBody: Color_schema_1.colorNameSchema.optional().default(Color_const_1.COLOR_NAME.Red),
 });

package/dist/domains/kart/Kart.schema.d.ts

@@ -116,10 +116,11 @@ export declare const kartSchema: z.ZodObject<{
         steeringWheel: z.ZodNullable<z.ZodObject<{
             ledStatus: z.ZodEnum<{
                 readonly OFF: "Off";
-                readonly IDLE: "Idle";
-                readonly POWER_UP: "Power-Up";
-                readonly EMERGENCY: "Emergency";
+                readonly COLOR: "Color";
+                readonly EFFECT: "Effect";
                 readonly CONFIG: "Config";
+                readonly ERROR: "Error";
+                readonly UNKNOWN: "Unknown";
             }>;
             buttons: z.ZodObject<{
                 powerRightPressed: z.ZodBoolean;

package/package.json

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

package/src/domains/hardware/steering-wheel/SteeringWheel.const.ts

@@ -7,16 +7,27 @@ export const STEERING_WHEEL_ACTION_COMMAND = {
 } as const;
 
 export const STEERING_WHEEL_SHOW_LED_EFFECT_OPTIONS = {
-  SHOW_LED_IDLE_EFFECT: 'ShowLedIdleEffect',
-  SHOW_LED_POWERUP_EFFECT: 'ShowLedPowerupEffect',
-  SHOW_LED_EMERGENCY_EFFECT: 'ShowLedEmergencyEffect',
-  SHOW_LED_CONFIG_EFFECT: 'ShowLedConfigEffect',
+  SHOW_COLOR: 'ShowColor',
+  STAR: 'Star',
+  RAY: 'Ray',
+  RAY_HIT: 'RayHit',
+  SPEED_BOOST: 'SpeedBoost',
+  CHARGED_POWER: 'ChargedPower',
+  ROULETTE: 'Roulette',
+  SHIELD: 'Shield',
+  BROKEN_SHIELD: 'BrokenShield',
+  WAIT: 'Wait',
+  STANDARD: 'Standard',
+  POWER_UP: 'PowerUp',
+  EMERGENCY: 'Emergency',
+  TRAFFIC_LIGHT: 'TrafficLight',
 } as const;
 
 export const STEERING_WHEEL_LED_STATUS = {
   OFF: 'Off',
-  IDLE: 'Idle',
-  POWER_UP: 'Power-Up',
-  EMERGENCY: 'Emergency',
+  COLOR: 'Color',
+  EFFECT: 'Effect',
   CONFIG: 'Config',
+  ERROR: 'Error',
+  UNKNOWN: 'Unknown',
 } as const;

package/src/domains/hardware/steering-wheel/SteeringWheel.schema.ts

@@ -1,4 +1,6 @@
 import { z } from 'zod';
+import { colorNameSchema } from '../../color/Color.schema';
+import { COLOR_NAME } from '../../color/Color.const';
 import {
   STEERING_WHEEL_ACTION_COMMAND,
   STEERING_WHEEL_LED_STATUS,
@@ -25,4 +27,5 @@ export const steeringWheelShowLedsEffectOptionsSchema = z.enum(STEERING_WHEEL_SH
 export const steeringWheelConfigureLedsOptionsSchema = z.object({
   brightness: z.number().min(0).max(100),
   durationSeconds: z.number().min(1).max(25),
+  colorBody: colorNameSchema.optional().default(COLOR_NAME.Red),
 });