@hytopia.com/server-protocol 1.3.18 → 1.3.20

package/package.json

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

package/packets/PacketCore.ts

@@ -23,6 +23,7 @@ export enum PacketId {
   INPUT = 1,
   STATE_REQUEST = 2,
   CHAT_MESSAGE_SEND = 3,
+  UI_MESSAGE_SEND = 4,
 
   // Standard Outbound Packet Types: 32 - 127 range
   SYNC_RESPONSE = 32,
@@ -34,6 +35,8 @@ export enum PacketId {
   ENTITIES = 38,
   WORLD = 39,
   CAMERA = 40,
+  UI = 41,
+  UI_MESSAGES = 42,
 
   // Debug Inbound Packet Types: 128 - 191 range
   DEBUG_CONFIG = 128,

package/packets/inbound/UIMessageSend.ts

@@ -0,0 +1,11 @@
+import { definePacket, PacketId } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
+import { uiMessageSchema } from '../../schemas/UIMessage';
+import type { UIMessageSchema } from '../../schemas/UIMessage';
+
+export type UIMessageSendPacket = IPacket<typeof PacketId.UI_MESSAGE_SEND, UIMessageSchema>;
+
+export const uiMessageSendPacketDefinition = definePacket(
+  PacketId.UI_MESSAGE_SEND,
+  uiMessageSchema
+);

package/packets/inbound/index.ts

@@ -3,3 +3,4 @@ export * from './DebugConfig';
 export * from './Input';
 export * from './StateRequest';
 export * from './SyncRequest';
+export * from './UIMessageSend';

package/packets/outbound/UI.ts

@@ -0,0 +1,12 @@
+import { definePacket, PacketId } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
+import { uiSchema } from '../../schemas/UI';
+import type { UISchema } from '../../schemas/UI';
+import type { WorldTick } from '../PacketCore';
+
+export type UIPacket = IPacket<typeof PacketId.UI, UISchema> & [WorldTick];
+
+export const uiPacketDefinition = definePacket(
+  PacketId.UI,
+  uiSchema,
+);

package/packets/outbound/UIMessages.ts

@@ -0,0 +1,12 @@
+import { definePacket, PacketId } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
+import { uiMessagesSchema } from '../../schemas/UIMessages';
+import type { UIMessagesSchema } from '../../schemas/UIMessages';
+import type { WorldTick } from '../PacketCore';
+
+export type UIMessagesPacket = IPacket<typeof PacketId.UI_MESSAGES, UIMessagesSchema> & [WorldTick];
+
+export const uiMessagesPacketDefinition = definePacket(
+  PacketId.UI_MESSAGES,
+  uiMessagesSchema,
+);

package/packets/outbound/index.ts

@@ -8,4 +8,6 @@ export * from './Entities';
 export * from './PhysicsDebugRender';
 export * from './PhysicsDebugRaycasts';
 export * from './SyncResponse';
+export * from './UI';
+export * from './UIMessages';
 export * from './World';

package/schemas/Entity.ts

@@ -13,6 +13,7 @@ export type EntitySchema = {
   as?: string[];        // model animations stop
   bh?: VectorSchema;    // block half extents
   bt?: string;          // block texture uri
+  h?: string[];         // model parts to hide
   m?: string;           // model uri
   n?: string;           // name
   p?: VectorSchema;     // position
@@ -31,6 +32,7 @@ export const entitySchema: JSONSchemaType<EntitySchema> = {
     as: { type: 'array', items: { type: 'string' }, nullable: true },
     bh: { ...vectorSchema, nullable: true },
     bt: { type: 'string', nullable: true },
+    h: { type: 'array', items: { type: 'string' }, nullable: true },
     m: { type: 'string', nullable: true },
     n: { type: 'string', nullable: true },
     p: { ...vectorSchema, nullable: true },

package/schemas/UI.ts

@@ -0,0 +1,17 @@
+import type { JSONSchemaType } from 'ajv';
+
+export type UISchema = {
+  c?: string[]; // css uris
+  h?: string[]; // html uris
+  j?: string[]; // js uris
+};
+
+export const uiSchema: JSONSchemaType<UISchema> = {
+  type: 'object',
+  properties: {
+    c: { type: 'array', items: { type: 'string' }, nullable: true },
+    h: { type: 'array', items: { type: 'string' }, nullable: true },
+    j: { type: 'array', items: { type: 'string' }, nullable: true },
+  },
+  additionalProperties: false,
+}

package/schemas/UIMessage.ts

@@ -0,0 +1,11 @@
+import type { JSONSchemaType } from 'ajv';
+
+export type UIMessageSchema = {
+  [key: string]: any;
+}
+
+export const uiMessageSchema: JSONSchemaType<UIMessageSchema> = {
+  type: 'object',
+  properties: {},
+  additionalProperties: true,
+}

package/schemas/UIMessages.ts

@@ -0,0 +1,10 @@
+import { uiMessageSchema } from './UIMessage';
+import type { JSONSchemaType } from 'ajv';
+import type { UIMessageSchema } from './UIMessage';
+
+export type UIMessagesSchema = UIMessageSchema[];
+
+export const uiMessagesSchema: JSONSchemaType<UIMessagesSchema> = {
+  type: 'array',
+  items: { ...uiMessageSchema },
+}

package/schemas/index.ts

@@ -22,6 +22,9 @@ export * from './RgbColor';
 export * from './StateRequest';
 export * from './SyncRequest';
 export * from './SyncResponse';
+export * from './UI';
+export * from './UIMessage';
+export * from './UIMessages';
 export * from './Vector';
 export * from './VectorBoolean';
 export * from './World';