@battle-racing/br-common-lib 6.2.0-rc.8 → 6.2.0

package/src/domains/socket/serverToClient/SocketWebAppServerToClientEventsParams.ts

@@ -3,6 +3,7 @@ import type { GameTrack } from '../../gameTrack';
 import type { Kart } from '../../kart';
 import type { CheckpointEvent } from '../../kartTracking';
 import type { Response } from '../../response';
+import type { TutorialSession } from '../../tutorial';
 import type { MacAddressGameTrackConnections } from '../inputs';
 import type { SocketHardwareOnDataEventsParams } from '../SocketHardwareOnDataEventsParams';
 
@@ -19,6 +20,7 @@ export interface SocketWebAppServerToClientEventsParams {
     checkpointEvent: CheckpointEvent;
   };
   'game:changed': { game: Game };
+  'tutorial:session:changed': { session: TutorialSession };
   'gameTracks:onGameTrackUpdated': GameTrack[];
   'gameTracks:connectedRasperries': { macAddress: string }[];
   'gameTracks:list:response': Response<MacAddressGameTrackConnections>;

package/src/domains/tutorial/Tutorial.const.ts

@@ -61,19 +61,3 @@ export const TUTORIAL_CHECKPOINT_TARGET = {
 export const TUTORIAL_INPUT_SIGNAL_TYPE = {
   STEERING_WHEEL_BUTTON_PRESSED: 'SteeringWheelButtonPressed',
 } as const;
-
-export const DRIVING_TUTORIAL_STEPS = [
-  TUTORIAL_SCREEN_STEP.PEDAL,
-  TUTORIAL_SCREEN_STEP.DRIVE_TO_CONTROLS,
-  TUTORIAL_SCREEN_STEP.HUD_OVERVIEW,
-  TUTORIAL_SCREEN_STEP.POWER_UP_WAITING,
-  TUTORIAL_SCREEN_STEP.POWER_UP_NITRO_READY,
-  TUTORIAL_SCREEN_STEP.POWER_UP_RETURN_TO_HUD,
-] as const;
-
-export const isDrivingTutorialStep = (step?: string | null): boolean => {
-  if (!step) {
-    return false;
-  }
-  return (DRIVING_TUTORIAL_STEPS as readonly string[]).includes(step);
-};

package/src/domains/tutorial/Tutorial.schema.ts

@@ -1,4 +1,7 @@
 import { z } from 'zod';
+import { startBattleSchema } from '../game/battle/Battle.schema';
+import { gameTypeSchema } from '../game/Game.schema';
+import { startRaceSchema } from '../game/race/Race.schema';
 import { screenTutorialHudSchema } from '../hardware/screen/ScreenTutorial.schema';
 import {
   TUTORIAL_INPUT_SIGNAL_TYPE,
@@ -59,6 +62,11 @@ export const tutorialSteeringWheelButtonSchema = z.enum([
   TUTORIAL_STEERING_WHEEL_BUTTON.ANY,
 ]);
 
+export const tutorialInputButtonSchema = z.enum([
+  TUTORIAL_STEERING_WHEEL_BUTTON.RIGHT,
+  TUTORIAL_STEERING_WHEEL_BUTTON.LEFT,
+]);
+
 export const tutorialCheckpointTargetSchema = z.enum([
   TUTORIAL_CHECKPOINT_TARGET.TRACK,
   TUTORIAL_CHECKPOINT_TARGET.POWER_UP,
@@ -79,7 +87,7 @@ export const tutorialKartSnapshotSchema = z.object({
   awaitingCheckpointTarget: tutorialCheckpointTargetSchema.nullable().optional(),
   latestCheckpointId: z.string().optional(),
   latestCheckpointProgress: z.number().optional(),
-  updatedAtISO: z.string().datetime(),
+  updatedAtISO: z.iso.datetime(),
 });
 
 export const tutorialInputSignalTypeSchema = z.enum([TUTORIAL_INPUT_SIGNAL_TYPE.STEERING_WHEEL_BUTTON_PRESSED]);
@@ -89,12 +97,12 @@ export const tutorialKartEventBaseSchema = z.object({
   deviceId: z.string().min(1),
   revision: z.number().int().nonnegative(),
   sequence: z.number().int().nonnegative(),
-  originTimestampISO: z.string().datetime(),
+  originTimestampISO: z.iso.datetime(),
 });
 
 export const tutorialSteeringWheelButtonPressedSchema = tutorialKartEventBaseSchema.extend({
   type: z.literal(TUTORIAL_INPUT_SIGNAL_TYPE.STEERING_WHEEL_BUTTON_PRESSED),
-  button: tutorialSteeringWheelButtonSchema,
+  button: tutorialInputButtonSchema,
 });
 
 export const tutorialInputSignalSchema = z.discriminatedUnion('type', [tutorialSteeringWheelButtonPressedSchema]);
@@ -107,7 +115,7 @@ export const tutorialConfigurationSchema = z.object({
 });
 
 export const tutorialParticipantSchema = z.object({
-  deviceId: z.string().min(1),
+  kartGuid: z.string().min(1),
   playerId: z.string().optional(),
   status: tutorialStatusSchema,
   currentPhaseId: tutorialPhaseIdSchema,
@@ -126,34 +134,26 @@ export const tutorialParticipantSchema = z.object({
     })
     .optional(),
   totalDurationSeconds: z.number().int().default(180),
-  startedAtISO: z.string().optional(),
-  updatedAtISO: z.string(),
+  startedAtISO: z.iso.datetime().optional(),
+  updatedAtISO: z.iso.datetime(),
 });
 
 export const tutorialSessionSchema = z.object({
   id: z.string().min(1),
   gameTurnId: z.string().optional(),
-  gameId: z.union([z.string(), z.number()]).optional(),
+  gameId: z.number().int(),
+  gameType: gameTypeSchema,
   status: tutorialStatusSchema,
   participants: z.array(tutorialParticipantSchema),
-  createdAtISO: z.string(),
-  updatedAtISO: z.string(),
+  createdAtISO: z.iso.datetime(),
+  updatedAtISO: z.iso.datetime(),
 });
 
-export const startOperatorTutorialSchema = z.object({
-  gameId: z.number().int(),
-  gameType: z.enum(['Race', 'Battle']),
+const startTutorialOptionsSchema = z.object({
   tutorialConfigId: z.string().optional().default('BR_TUTORIAL_DEFAULT'),
-  params: z.object({
-    laps: z.number().int().optional(),
-    lives: z.number().int().optional(),
-    coins: z.number().int().min(0).max(254),
-    kartsGuids: z.array(z.string()).min(1),
-    powerUpsIds: z.array(z.string()).min(1),
-    time: z.number().int().min(30).max(1200),
-    speedConfig: z.number().int().min(20).max(100),
-    playerKartMap: z.record(z.string(), z.string()).optional(),
-  }),
   tutorialParams: tutorialConfigurationSchema.optional(),
 });
 
+export const startRaceTutorialSchema = startRaceSchema.extend(startTutorialOptionsSchema.shape);
+
+export const startBattleTutorialSchema = startBattleSchema.extend(startTutorialOptionsSchema.shape);

package/src/domains/tutorial/Tutorial.types.ts

@@ -10,10 +10,12 @@ import {
   tutorialStatusSchema,
   tutorialSteeringWheelButtonPressedSchema,
   tutorialSteeringWheelButtonSchema,
+  tutorialInputButtonSchema,
   tutorialConfigurationSchema,
   tutorialParticipantSchema,
   tutorialSessionSchema,
-  startOperatorTutorialSchema,
+  startRaceTutorialSchema,
+  startBattleTutorialSchema,
 } from './Tutorial.schema';
 
 export type TutorialScreenStep = z.infer<typeof tutorialScreenStepSchema>;
@@ -21,6 +23,7 @@ export type TutorialStatus = z.infer<typeof tutorialStatusSchema>;
 export type TutorialPhaseId = z.infer<typeof tutorialPhaseIdSchema>;
 export type TutorialListenEventOn = z.infer<typeof tutorialListenEventOnSchema>;
 export type TutorialSteeringWheelButton = z.infer<typeof tutorialSteeringWheelButtonSchema>;
+export type TutorialInputButton = z.infer<typeof tutorialInputButtonSchema>;
 export type TutorialCheckpointTarget = z.infer<typeof tutorialCheckpointTargetSchema>;
 export type TutorialKartSnapshot = z.infer<typeof tutorialKartSnapshotSchema>;
 export type TutorialInputSignalType = z.infer<typeof tutorialInputSignalTypeSchema>;
@@ -29,5 +32,5 @@ export type TutorialInputSignal = z.infer<typeof tutorialInputSignalSchema>;
 export type TutorialConfiguration = z.infer<typeof tutorialConfigurationSchema>;
 export type TutorialParticipant = z.infer<typeof tutorialParticipantSchema>;
 export type TutorialSession = z.infer<typeof tutorialSessionSchema>;
-export type StartOperatorTutorial = z.infer<typeof startOperatorTutorialSchema>;
-
+export type StartRaceTutorial = z.infer<typeof startRaceTutorialSchema>;
+export type StartBattleTutorial = z.infer<typeof startBattleTutorialSchema>;

package/src/domains/tutorial/TutorialConfig.schema.ts

@@ -36,6 +36,7 @@ export const tutorialStepConfigSchema = z.object({
   screenStep: tutorialScreenStepSchema,
   listenEvent: tutorialListenEventSchema,
   triggerCommands: z.array(allCommandsConfigSchema),
+  executePowerUpId: z.string().optional(),
 });
 
 export const tutorialPhaseConfigSchema = z.object({

package/src/domains/utils/Utils.schema.ts

@@ -5,10 +5,15 @@ export const arithmeticOperatorSchema = z.enum(['+', '-', '*', '/']);
 // Regex for SimpleArithmeticString: check for operator followed by numbers
 export const simpleArithmeticStringSchema = z.string().regex(/^[\+\-\*\/]-?\d+(\.\d+)?$/);
 
-// Regex for ContextArithmeticString: $variable operator number
-export const kartContextVariableSchema = z.enum(['$kart.configuredSpeed', '$kart.powerUpTime']);
+// Regex for ContextArithmeticString: $variable, optionally followed by operator number
+export const kartContextVariableSchema = z.enum([
+  '$kart.configuredSpeed',
+  '$kart.powerUpTime',
+  '$kart.tutorialSpeed',
+  '$kart.tutorialReturnSpeed',
+]);
 
-export const contextArithmeticStringSchema = z.string().regex(/^\$[a-zA-Z0-9\.]+\s[\+\-\*\/]\s-?\d+(\.\d+)?$/);
+export const contextArithmeticStringSchema = z.string().regex(/^\$[a-zA-Z0-9\.]+(\s[\+\-\*\/]\s-?\d+(\.\d+)?)?$/);
 
 export const arithmeticExpressionSchema = z.union([
   z.number(),