@hytopia.com/server-protocol 1.4.23 → 1.4.25

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hytopia.com/server-protocol",
-  "version": "1.4.23",
+  "version": "1.4.25",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -12,8 +12,7 @@
   },
   "dependencies": {
     "@hytopia.com/server-protocol": "^1.1.3",
-    "ajv": "^8.17.1",
-    "mediasoup": "^3.15.7"
+    "ajv": "^8.17.1"
   },
   "repository": {
     "type": "git",

package/schemas/BlockType.ts

@@ -6,7 +6,6 @@ export type BlockTypeSchema = {
   ll?: number;            // light level
   n?: string;             // name
   t?: string;             // textureUri
-  th?: string;            // texture hash
 }
 
 export const blockTypeSchema: JSONSchemaType<BlockTypeSchema> = {
@@ -17,7 +16,6 @@ export const blockTypeSchema: JSONSchemaType<BlockTypeSchema> = {
     ll: { type: 'number', nullable: true },
     n: { type: 'string', nullable: true },
     t: { type: 'string', nullable: true },
-    th: { type: 'string', nullable: true },
   },
   required: [ 'i' ],
   additionalProperties: false,

package/schemas/Connection.ts

@@ -1,178 +1,9 @@
-import * as mediasoup from 'mediasoup';
 import { JSONSchemaType } from 'ajv';
 
-/**
- * Types
- */
-
-type WrtcConnectAck = {
-  i: string; // transport id
-}
-
-type WrtcDataChannel = {
-  i?: string;                              // data channel id (server -> client channel only)
-  pi?: string;                             // data producer id (server -> client channel only)
-  l: string;                               // label
-  s: mediasoup.types.SctpStreamParameters; // sctp stream parameters
-}
-
-type WrtcProduceDataAck = {
-  i: string; // producer id
-  l: string; // label, used for client reference of ack
-}
-
-type WrtcTransport = {
-  i: string;                          // transport id
-  f: 'cs' | 'sc';                     // data flow (cs: client -> server | sc: server -> client)
-  d: mediasoup.types.DtlsParameters;  // dtls parameters
-  ic: mediasoup.types.IceCandidate[]; // ice candidates
-  ip: mediasoup.types.IceParameters;  // ice parameters
-  s: mediasoup.types.SctpParameters;  // sctp parameters
-}
-
-type WrtcTransportConnect = {
-  i: string;                         // transport id
-  d: mediasoup.types.DtlsParameters; // dtls parameters
-}
-
 export type ConnectionSchema = {
-  i?: string;               // connection id          | server -> client  | on initial WS connection
-  k?: boolean               // kill connection        | server -> client  | tells client to close connection & not reconnect
-  c?: WrtcTransportConnect, // wrtc transport connect | client -> server  | 2nd wrtc packet
-  ca?: WrtcConnectAck,      // wrtc connect ack       | server -> client  | 3rd wrtc packet
-  d?: WrtcDataChannel[],    // wrtc data channels     | server <-> client | 1st wrtc packet s->c, 4th wrtc packet c->s
-  pa?: WrtcProduceDataAck,  // wrtc produce data ack  | server -> client  | 5th wrtc packet
-  t?: WrtcTransport[],      // wrtc transports        | server -> client  | 1st wrtc packet
-};
-
-/**
- * Schemas
- */
-
-const wrtcConnectAckSchema: JSONSchemaType<WrtcConnectAck> = {
-  type: 'object',
-  properties: {
-    i: { type: 'string' },
-  },
-  required: [ 'i' ],
-  additionalProperties: false,
-};
-
-const wrtcDtlsParametersSchema: JSONSchemaType<mediasoup.types.DtlsParameters> = {
-  type: 'object',
-  properties: {
-    role: { type: 'string', enum: [ 'auto', 'client', 'server' ], nullable: true },
-    fingerprints: {
-      type: 'array',
-      items: {
-        type: 'object',
-        properties: {
-          algorithm: { type: 'string', enum: [ 'sha-1', 'sha-224', 'sha-256', 'sha-384', 'sha-512' ] },
-          value: { type: 'string' },
-        },
-        required: [ 'algorithm', 'value' ],
-      }
-    },
-  },
-  required: [ 'fingerprints' ],
-  additionalProperties: false,
-};
-
-const wrtcIceCandidateSchema: JSONSchemaType<mediasoup.types.IceCandidate> = {
-  type: 'object',
-  properties: {
-    foundation: { type: 'string' },
-    priority: { type: 'number' },
-    ip: { type: 'string' },
-    address: { type: 'string' },
-    protocol: { type: 'string', enum: [ 'udp', 'tcp' ] },
-    port: { type: 'number' },
-    type: { type: 'string', enum: [ 'host' ] },
-    tcpType: { type: 'string', enum: [ 'passive' ], nullable: true },
-  },
-  required: [ 'foundation', 'priority', 'ip', 'address', 'protocol', 'port', 'type' ],
-  additionalProperties: false,
-};
-
-const wrtcIceParametersSchema: JSONSchemaType<mediasoup.types.IceParameters> = {
-  type: 'object',
-  properties: {
-    usernameFragment: { type: 'string' },
-    password: { type: 'string' },
-    iceLite: { type: 'boolean', nullable: true },
-  },
-  required: [ 'usernameFragment', 'password' ],
-  additionalProperties: false,
-};
-
-const wrtcProduceDataAckSchema: JSONSchemaType<WrtcProduceDataAck> = {
-  type: 'object',
-  properties: {
-    i: { type: 'string' },
-    l: { type: 'string' },
-  },
-  required: [ 'i', 'l' ],
-  additionalProperties: false,
-};
-
-const wrtcSctpParametersSchema: JSONSchemaType<mediasoup.types.SctpParameters> = {
-  type: 'object',
-  properties: {
-    port: { type: 'number' },
-    OS: { type: 'number' },
-    MIS: { type: 'number' },
-    maxMessageSize: { type: 'number' },
-  },
-  required: [ 'port', 'OS', 'MIS', 'maxMessageSize' ],
-  additionalProperties: true, // May be an SCTPParametersDump
-};
-
-const wrtcSctpStreamParametersSchema: JSONSchemaType<mediasoup.types.SctpStreamParameters> = {
-  type: 'object',
-  properties: {
-    streamId: { type: 'number' },
-    ordered: { type: 'boolean', nullable: true },
-    maxPacketLifeTime: { type: 'number', nullable: true },
-    maxRetransmits: { type: 'number', nullable: true },
-  },
-  required: [ 'streamId' ],
-  additionalProperties: false,
-};
-
-const wrtcTransportSchema: JSONSchemaType<WrtcTransport> = {
-  type: 'object',
-  properties: {
-    i: { type: 'string' },
-    f: { type: 'string', enum: [ 'cs', 'sc' ] },
-    ip: wrtcIceParametersSchema,
-    ic: { type: 'array', items: wrtcIceCandidateSchema },
-    d: wrtcDtlsParametersSchema,
-    s: wrtcSctpParametersSchema,
-  },
-  required: [ 'i', 'f', 'ip', 'ic', 'd', 's' ],
-  additionalProperties: false,
-};
-
-const wrtcTransportConnectSchema: JSONSchemaType<WrtcTransportConnect> = {
-  type: 'object',
-  properties: {
-    i: { type: 'string' },
-    d: wrtcDtlsParametersSchema,
-  },
-  required: [ 'i', 'd' ],
-  additionalProperties: false,
-};
-
-const wrtcDataChannelSchema: JSONSchemaType<WrtcDataChannel> = {
-  type: 'object',
-  properties: {
-    i: { type: 'string', nullable: true },
-    pi: { type: 'string', nullable: true },
-    l: { type: 'string' },
-    s: wrtcSctpStreamParametersSchema,
-  },
-  required: [ 'l', 's' ],
-  additionalProperties: false,
+  i?: string;  // connection id   | server -> client | on initial WS connection
+  k?: boolean; // kill connection | server -> client | tells client to close connection & not reconnect
+  ts?: string; // transport secret | server -> client | used by the client to upgrade to a WebTransport connection
 };
 
 export const connectionSchema: JSONSchemaType<ConnectionSchema> = {
@@ -180,11 +11,7 @@ export const connectionSchema: JSONSchemaType<ConnectionSchema> = {
   properties: {
     i: { type: 'string', nullable: true },
     k: { type: 'boolean', nullable: true },
-    c: { ...wrtcTransportConnectSchema, nullable: true },
-    ca: { ...wrtcConnectAckSchema, nullable: true },
-    d: { type: 'array', items: { ...wrtcDataChannelSchema }, nullable: true },
-    pa: { ...wrtcProduceDataAckSchema, nullable: true },
-    t: { type: 'array', items: { ...wrtcTransportSchema }, nullable: true },
+    ts: { type: 'string', nullable: true },
   },
   additionalProperties: false,
 };