@hytopia.com/server-protocol 1.0.27 → 1.0.29

package/package.json

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

package/packets/PacketCore.ts

@@ -49,10 +49,11 @@ export interface IPacketDefinition<TId extends PacketId, TSchema> {
   validate: ValidateFunction<TSchema>;
 }
 
-export type IPacket<TId extends PacketId, TSchema> = [
-  TId,     // packet id
-  TSchema  // packet data
-];
+export type WorldTick = number;
+
+export type IPacket<TId extends PacketId, TSchema, TRequireWorldTick extends boolean = false> = TRequireWorldTick extends true
+  ? [TId, TSchema, WorldTick]
+  : [TId, TSchema];
 
 export type AnyPacket = IPacket<PacketId, unknown>;
 
@@ -64,18 +65,23 @@ export interface Serializable {
   serialize(): AnySchema;
 }
 
-export function createPacket<TId extends number, TSchema>(
+export function createPacket<TId extends PacketId, TSchema, TRequireWorldTick extends boolean = false>(
   packetDef: IPacketDefinition<TId, TSchema>,
   data: TSchema,
-): IPacket<TId, TSchema> {
+  worldTick?: TRequireWorldTick extends true ? WorldTick : WorldTick | undefined
+): IPacket<TId, TSchema, TRequireWorldTick> {
   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)}`);
+  }
+
+  if (worldTick === undefined) {
+    return [packetDef.id, data] as IPacket<TId, TSchema, TRequireWorldTick>;
   }
 
-  return [ packetDef.id, data ];
+  return [packetDef.id, data, worldTick] as IPacket<TId, TSchema, TRequireWorldTick>;
 }
 
-export function definePacket<TId extends PacketId, TSchema>(
+export function definePacket<TId extends PacketId, TSchema, TRequireWorldTick extends boolean = false>(
   id: TId,
   schema: JSONSchemaType<TSchema>,
 ): IPacketDefinition<TId, TSchema> {

package/packets/PacketDefinitions.ts

@@ -22,10 +22,11 @@ for (const packet of Object.values(allPackets)) {
 
 export function isValidPacket(packet: unknown): packet is AnyPacket {
   if (
-    typeof packet !== 'object' || 
-    packet === null || 
+    !Array.isArray(packet) ||
+    packet.length < 2 || packet.length > 3 ||
     typeof packet[0] !== 'number' || packet[0] < 0 ||
-    packet[1] === undefined
+    packet[1] === undefined ||
+    (packet.length === 3 && typeof packet[2] !== 'number')
   ) {
     return false;
   }

package/packets/outbound/Block.ts

@@ -3,9 +3,9 @@ import type { IPacket } from '../PacketCore';
 import { blockSchema } from '../../schemas/Block';
 import type { BlockSchema } from '../../schemas/Block';
 
-export type BlockPacket = IPacket<typeof PacketId.BLOCK, BlockSchema>;
+export type BlockPacket = IPacket<typeof PacketId.BLOCK, BlockSchema, true>;
 
-export const blockPacketDefinition = definePacket(
+export const blockPacketDefinition = definePacket<typeof PacketId.BLOCK, BlockSchema, true>(
   PacketId.BLOCK,
   blockSchema,
 );

package/packets/outbound/BlockType.ts

@@ -3,9 +3,9 @@ import type { IPacket } from '../PacketCore';
 import { blockTypeSchema } from '../../schemas/BlockType';
 import type { BlockTypeSchema } from '../../schemas/BlockType';
 
-export type BlockTypePacket = IPacket<typeof PacketId.BLOCK_TYPE, BlockTypeSchema>;
+export type BlockTypePacket = IPacket<typeof PacketId.BLOCK_TYPE, BlockTypeSchema, true>;
 
-export const blockTypePacketDefinition = definePacket(
+export const blockTypePacketDefinition = definePacket<typeof PacketId.BLOCK_TYPE, BlockTypeSchema, true>(
   PacketId.BLOCK_TYPE,
   blockTypeSchema,
 );

package/packets/outbound/BlockTypeRegistry.ts

@@ -2,10 +2,11 @@ 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, true>;
 
-export const blockTypeRegistryPacketDefinition = definePacket(
+export const blockTypeRegistryPacketDefinition = definePacket<typeof PacketId.BLOCK_TYPE_REGISTRY, BlockTypeRegistrySchema, true>(
   PacketId.BLOCK_TYPE_REGISTRY,
   blockTypeRegistrySchema,
 );

package/packets/outbound/Chunk.ts

@@ -3,9 +3,9 @@ import type { IPacket } from '../PacketCore';
 import { chunkSchema } from '../../schemas/Chunk';
 import type { ChunkSchema } from '../../schemas/Chunk';
 
-export type ChunkPacket = IPacket<typeof PacketId.CHUNK, ChunkSchema>;
+export type ChunkPacket = IPacket<typeof PacketId.CHUNK, ChunkSchema, true>;
 
-export const chunkPacketDefinition = definePacket(
+export const chunkPacketDefinition = definePacket<typeof PacketId.CHUNK, ChunkSchema, true>(
   PacketId.CHUNK,
   chunkSchema,
 );

package/packets/outbound/Entity.ts

@@ -3,9 +3,9 @@ import type { IPacket } from '../PacketCore';
 import { entitySchema } from '../../schemas/Entity';
 import type { EntitySchema } from '../../schemas/Entity';
 
-export type EntityPacket = IPacket<typeof PacketId.ENTITY, EntitySchema>;
+export type EntityPacket = IPacket<typeof PacketId.ENTITY, EntitySchema, true>;
 
-export const entityPacketDefinition = definePacket(
+export const entityPacketDefinition = definePacket<typeof PacketId.ENTITY, EntitySchema, true>(
   PacketId.ENTITY,
   entitySchema,
 );

package/packets/outbound/PhysicsDebugRender.ts

@@ -3,9 +3,9 @@ import type { IPacket } from '../PacketCore';
 import { physicsDebugRenderSchema } from '../../schemas/PhysicsDebugRender';
 import type { PhysicsDebugRenderSchema } from '../../schemas/PhysicsDebugRender';
 
-export type PhysicsDebugRenderPacket = IPacket<typeof PacketId.PHYSICS_DEBUG_RENDER, PhysicsDebugRenderSchema>;
+export type PhysicsDebugRenderPacket = IPacket<typeof PacketId.PHYSICS_DEBUG_RENDER, PhysicsDebugRenderSchema, true>;
 
-export const physicsDebugRenderPacketDefinition = definePacket(
+export const physicsDebugRenderPacketDefinition = definePacket<typeof PacketId.PHYSICS_DEBUG_RENDER, PhysicsDebugRenderSchema, true>(
   PacketId.PHYSICS_DEBUG_RENDER,
   physicsDebugRenderSchema,
 );

package/packets/outbound/World.ts

@@ -3,9 +3,9 @@ import type { IPacket } from '../PacketCore';
 import { worldSchema } from '../../schemas/World';
 import type { WorldSchema } from '../../schemas/World';
 
-export type WorldPacket = IPacket<typeof PacketId.WORLD, WorldSchema>;
+export type WorldPacket = IPacket<typeof PacketId.WORLD, WorldSchema, true>;
 
-export const worldPacketDefinition = definePacket(
+export const worldPacketDefinition = definePacket<typeof PacketId.WORLD, WorldSchema, true>(
   PacketId.WORLD,
   worldSchema,
 );