@hytopia.com/server-protocol 1.0.26 → 1.0.28

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hytopia.com/server-protocol",
-  "version": "1.0.26",
+  "version": "1.0.28",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/packets/PacketCore.ts

@@ -49,9 +49,12 @@ export interface IPacketDefinition<TId extends PacketId, TSchema> {
   validate: ValidateFunction<TSchema>;
 }
 
+export type WorldTick = number;
+
 export type IPacket<TId extends PacketId, TSchema> = [
   TId,     // packet id
-  TSchema  // packet data
+  TSchema, // packet data
+  WorldTick?,  // world tick
 ];
 
 export type AnyPacket = IPacket<PacketId, unknown>;
@@ -64,15 +67,22 @@ export interface Serializable {
   serialize(): AnySchema;
 }
 
-export function createPacket<TId extends number, TSchema>(
+export function createPacket<TId extends PacketId, TSchema>(
   packetDef: IPacketDefinition<TId, TSchema>,
   data: TSchema,
+  worldTick?: WorldTick,
 ): IPacket<TId, TSchema> {
   if (!packetDef.validate(data)) {
-    throw new Error(`createPacket(): Invalid payload for packet with id ${packetDef.id}, error: ${Ajv.instance.errorsText(packetDef.validate.errors)}`);
+    throw new Error(`Invalid payload for packet with id ${packetDef.id}. Error: ${Ajv.instance.errorsText(packetDef.validate.errors)}`);
+  }
+
+  const packet: IPacket<TId, TSchema> = [packetDef.id, data];
+
+  if (typeof worldTick === 'number') {
+    packet.push(worldTick);
   }
 
-  return [ packetDef.id, data ];
+  return packet;
 }
 
 export function definePacket<TId extends PacketId, TSchema>(

package/packets/PacketDefinitions.ts

@@ -25,7 +25,8 @@ export function isValidPacket(packet: unknown): packet is AnyPacket {
     typeof packet !== 'object' || 
     packet === null || 
     typeof packet[0] !== 'number' || packet[0] < 0 ||
-    packet[1] === undefined
+    packet[1] === undefined ||
+    (packet[2] !== undefined && (typeof packet[2] !== 'number' || packet[2] < 0))
   ) {
     return false;
   }

package/packets/outbound/Block.ts

@@ -2,8 +2,9 @@ import { definePacket, PacketId } from '../PacketCore';
 import type { IPacket } from '../PacketCore';
 import { blockSchema } from '../../schemas/Block';
 import type { BlockSchema } from '../../schemas/Block';
+import type { WorldTick } from '../PacketCore';
 
-export type BlockPacket = IPacket<typeof PacketId.BLOCK, BlockSchema>;
+export type BlockPacket = IPacket<typeof PacketId.BLOCK, BlockSchema> & [WorldTick];
 
 export const blockPacketDefinition = definePacket(
   PacketId.BLOCK,

package/packets/outbound/BlockType.ts

@@ -2,8 +2,9 @@ import { definePacket, PacketId } from '../PacketCore';
 import type { IPacket } from '../PacketCore';
 import { blockTypeSchema } from '../../schemas/BlockType';
 import type { BlockTypeSchema } from '../../schemas/BlockType';
+import type { WorldTick } from '../PacketCore';
 
-export type BlockTypePacket = IPacket<typeof PacketId.BLOCK_TYPE, BlockTypeSchema>;
+export type BlockTypePacket = IPacket<typeof PacketId.BLOCK_TYPE, BlockTypeSchema> & [WorldTick];
 
 export const blockTypePacketDefinition = definePacket(
   PacketId.BLOCK_TYPE,

package/packets/outbound/BlockTypeRegistry.ts

@@ -2,8 +2,9 @@ import { definePacket, PacketId } from '../PacketCore';
 import type { IPacket } from '../PacketCore';
 import { blockTypeRegistrySchema } from '../../schemas/BlockTypeRegistry';
 import type { BlockTypeRegistrySchema } from '../../schemas/BlockTypeRegistry';
+import type { WorldTick } from '../PacketCore';
 
-export type BlockTypeRegistryPacket = IPacket<typeof PacketId.BLOCK_TYPE_REGISTRY, BlockTypeRegistrySchema>;
+export type BlockTypeRegistryPacket = IPacket<typeof PacketId.BLOCK_TYPE_REGISTRY, BlockTypeRegistrySchema> & [WorldTick];
 
 export const blockTypeRegistryPacketDefinition = definePacket(
   PacketId.BLOCK_TYPE_REGISTRY,

package/packets/outbound/Chunk.ts

@@ -2,8 +2,9 @@ import { definePacket, PacketId } from '../PacketCore';
 import type { IPacket } from '../PacketCore';
 import { chunkSchema } from '../../schemas/Chunk';
 import type { ChunkSchema } from '../../schemas/Chunk';
+import type { WorldTick } from '../PacketCore';
 
-export type ChunkPacket = IPacket<typeof PacketId.CHUNK, ChunkSchema>;
+export type ChunkPacket = IPacket<typeof PacketId.CHUNK, ChunkSchema> & [WorldTick];
 
 export const chunkPacketDefinition = definePacket(
   PacketId.CHUNK,

package/packets/outbound/Entity.ts

@@ -2,8 +2,9 @@ import { definePacket, PacketId } from '../PacketCore';
 import type { IPacket } from '../PacketCore';
 import { entitySchema } from '../../schemas/Entity';
 import type { EntitySchema } from '../../schemas/Entity';
+import type { WorldTick } from '../PacketCore';
 
-export type EntityPacket = IPacket<typeof PacketId.ENTITY, EntitySchema>;
+export type EntityPacket = IPacket<typeof PacketId.ENTITY, EntitySchema> & [WorldTick];
 
 export const entityPacketDefinition = definePacket(
   PacketId.ENTITY,

package/packets/outbound/PhysicsDebugRender.ts

@@ -2,8 +2,9 @@ import { definePacket, PacketId } from '../PacketCore';
 import type { IPacket } from '../PacketCore';
 import { physicsDebugRenderSchema } from '../../schemas/PhysicsDebugRender';
 import type { PhysicsDebugRenderSchema } from '../../schemas/PhysicsDebugRender';
+import type { WorldTick } from '../PacketCore';
 
-export type PhysicsDebugRenderPacket = IPacket<typeof PacketId.PHYSICS_DEBUG_RENDER, PhysicsDebugRenderSchema>;
+export type PhysicsDebugRenderPacket = IPacket<typeof PacketId.PHYSICS_DEBUG_RENDER, PhysicsDebugRenderSchema> & [WorldTick];
 
 export const physicsDebugRenderPacketDefinition = definePacket(
   PacketId.PHYSICS_DEBUG_RENDER,

package/packets/outbound/World.ts

@@ -2,8 +2,9 @@ import { definePacket, PacketId } from '../PacketCore';
 import type { IPacket } from '../PacketCore';
 import { worldSchema } from '../../schemas/World';
 import type { WorldSchema } from '../../schemas/World';
+import type { WorldTick } from '../PacketCore';
 
-export type WorldPacket = IPacket<typeof PacketId.WORLD, WorldSchema>;
+export type WorldPacket = IPacket<typeof PacketId.WORLD, WorldSchema> & [WorldTick];
 
 export const worldPacketDefinition = definePacket(
   PacketId.WORLD,

package/schemas/World.ts

@@ -4,6 +4,7 @@ export type WorldSchema = {
   i: number;   // id
   f?: boolean; // focused
   n?: string;  // name
+  s?: string;  // skyboxUri
 };
 
 export const worldSchema: JSONSchemaType<WorldSchema> = {
@@ -11,7 +12,8 @@ export const worldSchema: JSONSchemaType<WorldSchema> = {
   properties: {
     i: { type: 'number' },
     f: { type: 'boolean', nullable: true },
-    n: { type: 'string', nullable: true }
+    n: { type: 'string', nullable: true },
+    s: { type: 'string', nullable: true }
   },
   required: [ 'i' ],
   additionalProperties: false,