feat: Allow to validate sent packets using zod

packages/web-core/CHANGELOG.md

@@ -5,6 +5,7 @@
 - Server to Client log events
 - Latency reporting support
 - S2C logs added to conversation history
+- Allow to validate sent packets using zod
 
 ### Changed
 

packages/web-core/__tests__/connection/web-socket.connection.spec.ts

@@ -67,6 +67,7 @@ const createWebSocket = (props: {
     onReady,
     onMessage: props.onMessage || onMessage,
     onDisconnect,
+    eventFactory,
   });
 };
 
@@ -473,6 +474,7 @@ describe('open', () => {
       onReady,
       onMessage,
       onDisconnect,
+      eventFactory,
     });
     jest.spyOn(WebSocket.prototype, 'send').mockImplementation(jest.fn());
 

packages/web-core/__tests__/factories/event.spec.ts

@@ -299,7 +299,7 @@ describe('event types', () => {
   });
 
   test('should generate session control capabilities', () => {
-    const event = EventFactory.sessionControl({
+    const event = factory.sessionControl({
       capabilities: capabilitiesProps,
     });
 
@@ -317,7 +317,7 @@ describe('event types', () => {
 
   test('should generate session control session configuration', () => {
     const sessionConfiguration = { gameSessionId: v4() };
-    const event = EventFactory.sessionControl({ sessionConfiguration });
+    const event = factory.sessionControl({ sessionConfiguration });
 
     expect(event).toHaveProperty('routing');
     expect(event).toHaveProperty('timestamp');
@@ -337,7 +337,7 @@ describe('event types', () => {
       version: v4(),
       description: v4(),
     };
-    const event = EventFactory.sessionControl({ clientConfiguration });
+    const event = factory.sessionControl({ clientConfiguration });
 
     expect(event).toHaveProperty('routing');
     expect(event).toHaveProperty('timestamp');
@@ -357,7 +357,7 @@ describe('event types', () => {
       fullName: v4(),
       profile: { fields: [{ id: v4(), value: v4() }] },
     };
-    const event = EventFactory.sessionControl({ userConfiguration });
+    const event = factory.sessionControl({ userConfiguration });
 
     expect(event).toHaveProperty('routing');
     expect(event).toHaveProperty('timestamp');
@@ -384,7 +384,7 @@ describe('event types', () => {
       continuationType:
         ContinuationContinuationType.CONTINUATION_TYPE_DIALOG_HISTORY,
     };
-    const event = EventFactory.sessionControl({ continuation });
+    const event = factory.sessionControl({ continuation });
 
     expect(event).toHaveProperty('routing');
     expect(event).toHaveProperty('timestamp');
@@ -404,7 +404,7 @@ describe('event types', () => {
       continuationType:
         ContinuationContinuationType.CONTINUATION_TYPE_EXTERNALLY_SAVED_STATE,
     };
-    const event = EventFactory.sessionControl({ continuation });
+    const event = factory.sessionControl({ continuation });
 
     expect(event).toHaveProperty('routing');
     expect(event).toHaveProperty('timestamp');
@@ -420,7 +420,7 @@ describe('event types', () => {
 
   test('should generate session control history', () => {
     const sessionHistory = {};
-    const event = EventFactory.sessionControl({ sessionHistory });
+    const event = factory.sessionControl({ sessionHistory });
 
     expect(event).toHaveProperty('routing');
     expect(event).toHaveProperty('timestamp');
@@ -434,7 +434,7 @@ describe('event types', () => {
 
   test('should generate conversation start event', () => {
     const characters = [v4(), v4()];
-    const event = EventFactory.conversation(characters, {
+    const event = factory.conversation(characters, {
       conversationId,
     });
     expect(event.control?.action).toEqual(

packages/web-core/__tests__/services/entity.service.spec.ts

@@ -33,7 +33,10 @@ beforeEach(() => {
 });
 
 test('should create or update items', async () => {
-  const createOrUpdateItems = jest.spyOn(EventFactory, 'createOrUpdateItems');
+  const createOrUpdateItems = jest.spyOn(
+    EventFactory.prototype,
+    'createOrUpdateItems',
+  );
 
   const items = [
     {
@@ -67,7 +70,7 @@ test('should create or update items', async () => {
 });
 
 test('should remove items', async () => {
-  const removeItems = jest.spyOn(EventFactory, 'removeItems');
+  const removeItems = jest.spyOn(EventFactory.prototype, 'removeItems');
 
   const ids = [v4(), v4()];
 
@@ -82,7 +85,7 @@ test.each([
   ItemsInEntitiesOperationType.REMOVE,
   ItemsInEntitiesOperationType.REPLACE,
 ])('shout execute $type', async (type) => {
-  const itemsInEntities = jest.spyOn(EventFactory, 'itemsInEntities');
+  const itemsInEntities = jest.spyOn(EventFactory.prototype, 'itemsInEntities');
 
   const itemIds = [v4(), v4()];
   const entityNames = [v4(), v4()];

packages/web-core/package.json

@@ -45,6 +45,7 @@
   "dependencies": {
     "base64-arraybuffer": "^1.0.2",
     "defer-promise": "^3.0.0",
+    "snakecase-keys": "^8.0.1",
     "uuid": "^9.0.0",
     "zod": "^3.23.8"
   }

packages/web-core/src/common/data_structures.ts

@@ -107,6 +107,7 @@ export interface ClientConfiguration {
   capabilities?: Capabilities;
   audioPlayback?: AudioPlaybackConfig;
   history?: HistoryConfig;
+  validateData?: boolean;
 }
 
 export interface InternalClientConfiguration {
@@ -115,6 +116,7 @@ export interface InternalClientConfiguration {
   capabilities: CapabilitiesConfiguration;
   audioPlayback?: AudioPlaybackConfig;
   history?: HistoryConfig;
+  validateData?: boolean;
 }
 
 export interface CancelResponses {

packages/web-core/src/connection/web-socket.connection.ts

@@ -54,6 +54,7 @@ interface ConnectionProps<
   onError: (err: InworldError) => Awaitable<void>;
   onMessage: (packet: ProtoPacket) => Awaitable<void>;
   extension: Extension<InworldPacketT, HistoryItemT>;
+  eventFactory: EventFactory;
 }
 
 export interface QueueItem<InworldPacketT> {
@@ -302,7 +303,11 @@ export class WebSocketConnection<
     resolve: (value: LoadedScene) => void;
     reject: (reason: InworldError) => void;
   }) {
-    const { parseEvent, onMessage } = this;
+    const {
+      parseEvent,
+      onMessage,
+      connectionProps: { eventFactory },
+    } = this;
     let historyLoaded = true;
     let sceneStatus: CurrentSceneStatus;
 
@@ -329,7 +334,7 @@ export class WebSocketConnection<
         if (!!sceneStatus && !historyLoaded && needHistory) {
           write({
             getPacket: () =>
-              EventFactory.sessionControl({ sessionHistory: {} }),
+              eventFactory.sessionControl({ sessionHistory: {} }),
           });
         } else {
           ws.removeEventListener('message', this);
@@ -353,12 +358,14 @@ export class WebSocketConnection<
     gameSessionId?: string;
     useDefaultClient?: boolean;
   }) {
+    const { eventFactory } = this.connectionProps;
+
     const continuation = this.getContinuation({
       sessionContinuation: props.sessionContinuation,
     });
 
     const packets: ProtoPacket[] = [
-      EventFactory.sessionControl({
+      eventFactory.sessionControl({
         ...(props.capabilities && {
           capabilities: props.capabilities,
         }),
@@ -375,7 +382,7 @@ export class WebSocketConnection<
         }),
         ...(continuation && { continuation }),
       }),
-      EventFactory.loadScene(props.name),
+      eventFactory.loadScene(props.name),
     ];
 
     return this.extension.beforeLoadScene?.(packets) || packets;