@hytopia.com/server-protocol 1.0.1 → 1.0.3

package/README.md

@@ -0,0 +1,3 @@
+# HYTOPIA Server Protcol
+
+This repo contains all of the packet and payload schemas defined by the HYTOPIA server's protocol. 

package/index.ts

@@ -0,0 +1,7 @@
+import * as inboundPackets from './packets/inbound';
+import * as outboundPackets from './packets/outbound';
+
+
+export { inboundPackets, outboundPackets };
+export * from './schemas';
+export * from './packets/PacketCore';

package/package.json

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

package/packets/{PacketTypes.ts → PacketCore.ts}

@@ -17,7 +17,7 @@ import type { JSONSchemaType, ValidateFunction } from 'ajv';
  * in encoded format.
  */
 
-export enum PacketType {
+export enum PacketIds {
   // Standard Inbound Packet Types: 0 - 31 range
   HEARTBEAT = 0,
   INPUT = 1,
@@ -40,28 +40,37 @@ export enum PacketType {
  * Generators for packet definitions and validators.
  */
 
-export interface IPacketDefinition<TId extends PacketType, TPayload> {
+export interface IPacketDefinition<TId extends PacketIds, TSchema> {
   id: TId;
-  schema: JSONSchemaType<TPayload>;
-  validate: ValidateFunction<TPayload>;
+  schema: JSONSchemaType<TSchema>;
+  validate: ValidateFunction<TSchema>;
 }
 
-export interface IPacket<TId extends PacketType, TPayload> {
+export interface IPacket<TId extends PacketIds, TSchema> {
   id: TId;
-  payload: TPayload;
+  payload: TSchema;
 }
 
-export const definePacket = <TId extends PacketType, TPayload>(
+export type AnyPacket = IPacket<PacketIds, unknown>;
+
+export type AnyPacketDefinition = IPacketDefinition<number, unknown>;
+
+export const createPacket = <TId extends number, TSchema>(
+  packetDef: IPacketDefinition<TId, TSchema>,
+  payload: TSchema,
+): IPacket<TId, TSchema> => {
+  if (!packetDef.validate(payload)) {
+    throw new Error(`createPacket(): Invalid payload for packet with id ${packetDef.id}, error: ${Ajv.instance.errorsText(packetDef.validate.errors)}`);
+  }
+
+  return { id: packetDef.id, payload };
+}
+
+export const definePacket = <TId extends PacketIds, TSchema>(
   id: TId,
-  schema: JSONSchemaType<TPayload>,
-): IPacketDefinition<TId, TPayload> => ({
+  schema: JSONSchemaType<TSchema>,
+): IPacketDefinition<TId, TSchema> => ({
   id,
   schema,
   validate: Ajv.instance.compile(schema),
 });
-
-// Represents any packet type
-export type AnyPacket = IPacket<PacketType, unknown>;
-
-// Represents any packet definition type
-export type AnyPacketDefinition = IPacketDefinition<number, unknown>;

package/packets/inbound/Heartbeat.ts

@@ -1,11 +1,11 @@
-import { definePacket, PacketType } from '../PacketTypes';
-import type { IPacket } from '../PacketTypes';
+import { definePacket, PacketIds } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
 import { heartbeatSchema } from '../../schemas/Heartbeat';
 import type { Heartbeat } from '../../schemas/Heartbeat';
 
-export type HeartbeatPacket = IPacket<typeof PacketType.HEARTBEAT, Heartbeat>;
+export type HeartbeatPacket = IPacket<typeof PacketIds.HEARTBEAT, Heartbeat>;
 
 export const heartbeatPacketDefinition = definePacket(
-  PacketType.HEARTBEAT,
+  PacketIds.HEARTBEAT,
   heartbeatSchema
 );

package/packets/inbound/Input.ts

@@ -1,11 +1,11 @@
-import { definePacket, PacketType } from '../PacketTypes';
-import type { IPacket } from '../PacketTypes';
+import { definePacket, PacketIds } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
 import { inputSchema } from '../../schemas/Input';
 import type { Input } from '../../schemas/Input';
 
-export type InputPacket = IPacket<typeof PacketType.INPUT, Input>;
+export type InputPacket = IPacket<typeof PacketIds.INPUT, Input>;
 
 export const inputPacketDefinition = definePacket(
-  PacketType.INPUT,
+  PacketIds.INPUT,
   inputSchema
 );

package/packets/inbound/index.ts

@@ -0,0 +1,2 @@
+export * from './Heartbeat';
+export * from './Input';

package/packets/outbound/Block.ts

@@ -1,11 +1,11 @@
-import { definePacket, PacketType } from '../PacketTypes';
-import type { IPacket } from '../PacketTypes';
+import { definePacket, PacketIds } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
 import { blockSchema } from '../../schemas/Block';
 import type { Block } from '../../schemas/Block';
 
-export type BlockPacket = IPacket<typeof PacketType.BLOCK, Block>;
+export type BlockPacket = IPacket<typeof PacketIds.BLOCK, Block>;
 
 export const blockPacketDefinition = definePacket(
-  PacketType.BLOCK,
+  PacketIds.BLOCK,
   blockSchema,
 );

package/packets/outbound/BlockRegistry.ts

@@ -1,11 +1,11 @@
-import { definePacket, PacketType } from '../PacketTypes';
-import type { IPacket } from '../PacketTypes';
+import { definePacket, PacketIds } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
 import { blockRegistrySchema } from '../../schemas/BlockRegistry';
 import type { BlockRegistry } from '../../schemas/BlockRegistry';
 
-export type BlockRegistryPacket = IPacket<typeof PacketType.BLOCK_REGISTRY, BlockRegistry>;
+export type BlockRegistryPacket = IPacket<typeof PacketIds.BLOCK_REGISTRY, BlockRegistry>;
 
 export const blockRegistryPacketDefinition = definePacket(
-  PacketType.BLOCK_REGISTRY,
+  PacketIds.BLOCK_REGISTRY,
   blockRegistrySchema,
 );

package/packets/outbound/BlockType.ts

@@ -1,11 +1,11 @@
-import { definePacket, PacketType } from '../PacketTypes';
-import type { IPacket } from '../PacketTypes';
+import { definePacket, PacketIds } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
 import { blockTypeSchema } from '../../schemas/BlockType';
 import type { BlockType } from '../../schemas/BlockType';
 
-export type BlockTypePacket = IPacket<typeof PacketType.BLOCK_TYPE, BlockType>;
+export type BlockTypePacket = IPacket<typeof PacketIds.BLOCK_TYPE, BlockType>;
 
 export const blockTypePacketDefinition = definePacket(
-  PacketType.BLOCK_TYPE,
+  PacketIds.BLOCK_TYPE,
   blockTypeSchema,
 );

package/packets/outbound/Chunk.ts

@@ -1,11 +1,11 @@
-import { definePacket, PacketType } from '../PacketTypes';
-import type { IPacket } from '../PacketTypes';
+import { definePacket, PacketIds } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
 import { chunkSchema } from '../../schemas/Chunk';
 import type { Chunk } from '../../schemas/Chunk';
 
-export type ChunkPacket = IPacket<typeof PacketType.CHUNK, Chunk>;
+export type ChunkPacket = IPacket<typeof PacketIds.CHUNK, Chunk>;
 
 export const chunkPacketDefinition = definePacket(
-  PacketType.CHUNK,
+  PacketIds.CHUNK,
   chunkSchema,
 );

package/packets/outbound/Entity.ts

@@ -1,11 +1,11 @@
-import { definePacket, PacketType } from '../PacketTypes';
-import type { IPacket } from '../PacketTypes';
+import { definePacket, PacketIds } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
 import { entitySchema } from '../../schemas/Entity';
 import type { Entity } from '../../schemas/Entity';
 
-export type EntityPacket = IPacket<typeof PacketType.ENTITY, Entity>;
+export type EntityPacket = IPacket<typeof PacketIds.ENTITY, Entity>;
 
 export const entityPacketDefinition = definePacket(
-  PacketType.ENTITY,
+  PacketIds.ENTITY,
   entitySchema,
 );

package/packets/outbound/PhysicsDebugRender.ts

@@ -1,11 +1,11 @@
-import { definePacket, PacketType } from '../PacketTypes';
-import type { IPacket } from '../PacketTypes';
+import { definePacket, PacketIds } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
 import { physicsDebugRenderSchema } from '../../schemas/PhysicsDebugRender';
 import type { PhysicsDebugRender } from '../../schemas/PhysicsDebugRender';
 
-export type PhysicsDebugRenderPacket = IPacket<typeof PacketType.PHYSICS_DEBUG_RENDER, PhysicsDebugRender>;
+export type PhysicsDebugRenderPacket = IPacket<typeof PacketIds.PHYSICS_DEBUG_RENDER, PhysicsDebugRender>;
 
 export const physicsDebugRenderPacketDefinition = definePacket(
-  PacketType.PHYSICS_DEBUG_RENDER,
+  PacketIds.PHYSICS_DEBUG_RENDER,
   physicsDebugRenderSchema,
 );

package/packets/outbound/index.ts

@@ -0,0 +1,6 @@
+export * from './Block';
+export * from './BlockRegistry';
+export * from './BlockType';
+export * from './Chunk';
+export * from './Entity';
+export * from './PhysicsDebugRender';

package/schemas/index.ts

@@ -0,0 +1,16 @@
+export * from './Block';
+export * from './BlockRegistry';
+export * from './BlockType';
+export * from './Chunk';
+export * from './Collider';
+export * from './ColliderDesc';
+export * from './Entity';
+export * from './Heartbeat';
+export * from './Input';
+export * from './PhysicsDebugRender';
+export * from './Quaternion';
+export * from './RigidBody';
+export * from './RigidBodyDesc';
+export * from './Shape';
+export * from './Vector';
+export * from './VectorBoolean';

package/packets/index.ts

@@ -1,26 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-
-const inboundPackets: Record<string, any> = {};
-const outboundPackets: Record<string, any> = {};
-
-const importPackets = async () => {
-  for (const directory of ['inbound', 'outbound']) {
-    const directoryPath = path.join(__dirname, directory);
-    const files = fs.readdirSync(directoryPath);
-
-    for (const file of files) {
-      if (file.endsWith('.ts')) {
-        const name = path.basename(file, '.ts');
-        const module = await import(`./${directory}/${name}`);
-        const typePackets = directory === 'inbound' ? inboundPackets : outboundPackets;
-        const lcfName = name.charAt(0).toLowerCase() + name.slice(1);
-        typePackets[`${lcfName}PacketDefinition`] = module[`${lcfName}PacketDefinition`];
-      }
-    }
-  }
-};
-
-await importPackets();
-
-export default { inboundPackets, outboundPackets };