@unitn-asa/deliveroo-js-sdk 1.3.4 → 1.3.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unitn-asa/deliveroo-js-sdk",
-  "version": "1.3.4",
+  "version": "1.3.10",
   "description": "Software development kit for Deliveroo.js",
   "author": "Marco Robol <marco.robol@unitn.it>",
   "type": "module",

package/src/client/DjsClientSocket.js

@@ -5,7 +5,7 @@ import { Socket } from 'socket.io-client';
  * @typedef {import("../types/IOParcel.js").IOParcel} IOParcel
  * @typedef {import("../types/IOTile.js").IOTile} IOTile
  * @typedef {import("../types/IOConfig.js").IOConfig} IOConfig
- * @typedef {import("../types/IOInfo.js").IOInfo} IOInfo
+ * @typedef {import("../types/IOMetrics.js").IOMetrics} IOMetrics
  * 
  * @typedef {import("../types/IOSocketEvents.js").IOSensing} IOSensing
  * @typedef {import("../types/IOSocketEvents.js").IOClientEvents} IOClientEvents
@@ -118,10 +118,10 @@ export class DjsClientSocket extends Socket {
     
     /**
      * Listen to 'info' events
-     * @param { function( IOInfo ) : void } callback
+     * @param { function( ) : void } callback
+     * @deprecated 'info' events are deprecated, use 'metrics' instead (only for admin)
      */
     onInfo ( callback ) {
-        this.on( "info", callback )
     }
     
     /**
@@ -264,7 +264,7 @@ export class DjsClientSocket extends Socket {
             let proto = MixinClass.prototype;
 
             const descriptors = Object.getOwnPropertyDescriptors(proto);
-            // @ts-expect-error
+            // @ts-ignore
             delete descriptors.constructor;
             
             Object.defineProperties(target, descriptors);

package/src/client/DjsConnect.js

@@ -36,7 +36,7 @@ export function DjsConnect ( host = process.env.HOST || 'http://localhost:8080',
     try {
         enhancedClientSocket.on( "ping", ( pingData, callback ) => {
             try {
-                callback( { clientTimestamp: performance.now() } );
+                callback();
             } catch (error) {
                 console.warn("Error handling ping event");
             }

package/src/client/index.js

@@ -10,8 +10,8 @@
  * @typedef {import("../types/IOTile.js").IOTile} IOTile
  * 
  * @typedef {import("../types/IOIdentity.js").IOIdentity} IOIdentity
- * @typedef {import("../types/IOInfo.js").IOInfo} IOInfo
  * @typedef {import("../types/IOSensing.js").IOSensing} IOSensing
+ * @typedef {import("../types/IOMetrics.js").IOMetrics} IOMetrics
  * 
  * @typedef {import("../types/IOSocketEvents.js").IOClientEvents} IOClientEvents
  * @typedef {import("../types/IOSocketEvents.js").IOServerEvents} IOServerEvents

package/src/server/DjsServer.js

@@ -6,7 +6,7 @@ import { DjsServerSocket } from './DjsServerSocket.js';
  * @typedef {import("../types/IOParcel.js").IOParcel} IOParcel
  * @typedef {import("../types/IOTile.js").IOTile} IOTile
  * @typedef {import("../types/IOConfig.js").IOConfig} IOConfig
- * @typedef {import("../types/IOInfo.js").IOInfo} IOInfo
+ * @typedef {import("../types/IOMetrics.js").IOMetrics} IOMetrics
  *
  * @typedef {import("../types/IOSocketEvents.js").IOSensing} IOSensing
  * @typedef {import("../types/IOSocketEvents.js").IOClientEvents} IOClientEvents on the client side these are to be emitted with .emit
@@ -67,11 +67,10 @@ export class DjsServer extends Server {
     /**
      * Broadcast a log message to all connected clients
      * @param { 'server' | { socket:string, id:string, name:string } } src - 'server' or client
-     * @param { IOInfo } info
      * @param { ...any } message
      */
-    broadcastLog(src, info, ...message) {
-        this.emit('log', src, info, ...message);
+    broadcastLog(src, ...message) {
+        this.emit('log', src, ...message);
     }
 
     // /**
@@ -117,6 +116,7 @@ export class DjsServer extends Server {
             let proto = MixinClass.prototype;
 
             const descriptors = Object.getOwnPropertyDescriptors(proto);
+            // @ts-ignore
             delete descriptors.constructor;
 
             Object.defineProperties(target, descriptors);

package/src/server/DjsServerSocket.js

@@ -5,7 +5,7 @@ import { Socket } from 'socket.io';
  * @typedef {import("../types/IOParcel.js").IOParcel} IOParcel
  * @typedef {import("../types/IOTile.js").IOTile} IOTile
  * @typedef {import("../types/IOConfig.js").IOConfig} IOConfig
- * @typedef {import("../types/IOInfo.js").IOInfo} IOInfo
+ * @typedef {import("../types/IOMetrics.js").IOMetrics} IOMetrics
  * 
  * @typedef {import("../types/IOSocketEvents.js").IOSensing} IOSensing
  * @typedef {import("../types/IOSocketEvents.js").IOClientEvents} IOClientEvents on the client side these are to be emitted with .emit
@@ -28,7 +28,9 @@ export class DjsServerSocket extends Socket {
     //  * @param {IOClientEvents[K]} listener
     //  * @returns {void}
     //  */
+    // @ts-ignore
     on ( event, listener ) {
+        // @ts-ignore
         return super.on( event, (...args) => {
             try {
                 return listener.apply( this, args );
@@ -95,10 +97,10 @@ export class DjsServerSocket extends Socket {
     }
     
     /**
-     * @param { IOInfo } info
+     * @param { IOMetrics } metrics
      */
-    emitInfo ( info ) {
-        super.emit( 'info', info );
+    emitMetrics ( metrics ) {
+        super.emit( 'metrics', metrics );
     }
 
 
@@ -106,7 +108,7 @@ export class DjsServerSocket extends Socket {
     /**
      * @callback onMoveCallback
      * @param { 'up' | 'right' | 'left' | 'down' } direction
-     * @param { function( { x:number, y:number } | false ) : void } replyAcknowledgmentCallback ( reply )
+     * @param { function( { x:number, y:number } | false ) : void = } replyAcknowledgmentCallback ( reply )
      */
     /**
      * @param { onMoveCallback } callback ( direction, acknowledgementCallback )
@@ -117,7 +119,7 @@ export class DjsServerSocket extends Socket {
     
     /**
      * @callback onPickupCallback
-     * @param { function( { id:string } [] ) : void } acknowledgementCallback
+     * @param { function( { id:string } [] ) : void = } acknowledgementCallback
      */
     /**
      * @param { onPickupCallback } callback ( acknowledgementCallback )
@@ -128,11 +130,11 @@ export class DjsServerSocket extends Socket {
 
     /**
      * @callback onPutdownCallback
-     * @param { string [] } selected ids of parcels to drop
-     * @param { function( { id:string } [] ) : void } acknowledgementCallback
+     * @param { string [] = } selected ids of parcels to drop
+     * @param { function( { id:string } [] ) : void = } acknowledgementCallback
      */
     /**
-     * @param { onPutdownCallback } callback ( selected, acknowledgementCallback )
+     * @param { onPutdownCallback } callback
      */
     onPutdown ( callback ) {
         super.on( 'putdown', callback );
@@ -184,6 +186,7 @@ export class DjsServerSocket extends Socket {
         const sockets = await super.to( "agent:" + toId ).fetchSockets();
         const emissionPromises = sockets.map( socket => {
             return new Promise( (res) => {
+                // @ts-ignore
                 socket.timeout(1000).emit( 'msg', me.id, me.name, msg, (err, response) => {
                     if (err)
                         res('timeout');
@@ -202,6 +205,7 @@ export class DjsServerSocket extends Socket {
     }
 
     /**
+     * @param { IOAgent } me
      * @param { any } msg
      * @returns { void } reply
      */
@@ -217,21 +221,18 @@ export class DjsServerSocket extends Socket {
     }
     
     /**
-     * @param { string } myId
-     * @param { string } myName
      * @param { 'server' | { socket:string, id:string, name:string } } src - 'server' or client
-     * @param { IOInfo } info
      * @param { ...any } message
      */
-    broadcastLog ( myId, myName, src, info, ...message ) {
-        super.broadcast.emit( 'log', src, info, ...message );
+    broadcastLog ( src, ...message ) {
+        super.broadcast.emit( 'log', src, ...message );
     }
 
 
 
     /**
      * Process request for creating a parcel on x, y or disposing or setting its reward given the id
-     * @param { function ( 'create' | 'dispose' | 'set', {id:string, x:number, y:number, reward:number} ) : void } callback 
+     * @param { function ( 'create' | 'dispose' | 'set', { x:number, y:number } | { id:string, reward?:number } ) : void } callback 
      */
     onParcel ( callback ) {
         super.on( 'parcel', callback );
@@ -253,6 +254,14 @@ export class DjsServerSocket extends Socket {
         super.on( 'restart', callback );
     }
 
+    /**
+     * Process request for rewarding an agent with a certain amount of points
+     * @param { function ( {agentId: string, points: number} ) : void } callback
+     */
+    onReward ( callback ) {
+        super.on( 'reward', callback );
+    }
+
 
 
     /**
@@ -265,11 +274,13 @@ export class DjsServerSocket extends Socket {
         /**
          * Mixin function to copy methods from a class prototype to an object
          */
+        // @ts-ignore
         function applyMixin(target, MixinClass) {
             
             let proto = MixinClass.prototype;
 
             const descriptors = Object.getOwnPropertyDescriptors(proto);
+            // @ts-ignore
             delete descriptors.constructor;
             
             Object.defineProperties(target, descriptors);

package/src/server/index.js

@@ -10,8 +10,8 @@
  * @typedef {import("../types/IOTile.js").IOTile} IOTile
  * 
  * @typedef {import("../types/IOIdentity.js").IOIdentity} IOIdentity
- * @typedef {import("../types/IOInfo.js").IOInfo} IOInfo
  * @typedef {import("../types/IOSensing.js").IOSensing} IOSensing
+ * @typedef {import("../types/IOMetrics.js").IOMetrics} IOMetrics
  * 
  * @typedef {import("../types/IOSocketEvents.js").IOClientEvents} IOClientEvents
  * @typedef {import("../types/IOSocketEvents.js").IOServerEvents} IOServerEvents

package/src/types/IOClockEvent.js

@@ -1,6 +1,6 @@
 
 /**
- * @typedef { 'frame' | '1s' | '2s' | '5s' | '10s' | 'infinite' } IOClockEvent
+ * @typedef { 'frame' | '1s' | '2s' | '5s' | '10s' | '1m' | '1h' | 'infinite' } IOClockEvent
  */
 
 
@@ -10,7 +10,7 @@
  * @returns { IOClockEvent }
  */
 function parseClockEvent ( event ) {
-    if ( event == 'frame' || event == '1s' || event == '2s' || event == '5s' || event == '10s' || event == 'infinite' )
+    if ( event == 'frame' || event == '1s' || event == '2s' || event == '5s' || event == '10s' || event == '1m' || event == '1h' || event == 'infinite' )
         return event;
     else
         console.warn( `IOClockEvent: invalid event '${event}', defaulting to '1s'` );

package/src/types/IOMetrics.js

@@ -0,0 +1,17 @@
+
+/**
+ * @typedef {Object} IOMetrics
+ * @property { {ms: number, frame: number, fps: number, uptime: number} } timing
+ * @property { {heapUsed: number, heapTotal: number, rss: number, external: number} } memory
+ * @property { {current: number} } cpu
+ * @property { {currentLag: number, maxLag: number, avgLag: number} } eventLoop
+ * @property { {avg: number, min: number, max: number, byAgent: Object.<string, {
+ *      id: string,
+ *      name: string,
+ *      teamId: string,
+ *      teamName: string,
+ *      sockets: ( { socketId: string, frame: number, avg: number, min: number, max: number } ) []
+ *  }> } } latency
+ */
+
+export { };

package/src/types/IOSocketEvents.js

@@ -1,26 +1,10 @@
 
 /** @typedef {import('./IOAgent.js').IOAgent} IOAgent */
 /** @typedef {import('./IOTile.js').IOTile} IOTile */
-/** @typedef {import('./IOInfo.js').IOInfo} IOInfo */
 /** @typedef {import('./IOSensing.js').IOSensing} IOSensing */
+/** @typedef {import('./IOMetrics.js').IOMetrics} IOMetrics */
 
-/**
- * @typedef {Object} IOLatency
- * @property {number} roundTrip - Total round trip time in milliseconds
- * @property {number} clientProcessing - Time spent processing on the client side in milliseconds
- * @property {number} serverProcessing - Time spent processing on the server side in milliseconds
- * @property {number} networkLag - Estimated network latency in milliseconds
- * @property {number} timestamp - Timestamp when the latency was measured (in milliseconds since epoch)
- */
 
-/**
- * @typedef {Object} IOMetrics
- * @property { {ms: number, frame: number, fps: number, uptime: number} } timing
- * @property { {heapUsed: number, heapTotal: number, rss: number, external: number} } memory
- * @property { {current: number, samples: number[]} } cpu
- * @property { {currentLag: number, maxLag: number, avgLag: number} } eventLoop
- * @property { {count: number, avg: number, min: number, max: number, samples: IOLatency[], byAgent: Object.<string, {id: string, name: string, teamId: string, teamName: string, sockets: []}>} } latency
- */
 
 /**
  * Client -> Server events. Emitted by the client and listened by the server.
@@ -36,6 +20,7 @@
  *      'crate':        function ( 'create' | 'dispose', { x:number, y:number } ) : void,
  *      'restart':      function () : void,
  *      'tile':         function ( IOTile ) : void,
+ *      'reward':       function ( { agentId: string, points: number } ) : void,
  *      'log':          function ( ...any ) : void
  * }} IOClientEvents
  */
@@ -52,8 +37,7 @@
  *      'controller':       function ( 'connected' | 'disconnected', {id:string, name:string, teamId:string, teamName:string, score:number} ) : void,
  *      'you':              function ( IOAgent ) : void,
  *      'sensing':          function ( IOSensing ) : void,
- *      'info':             function ( IOInfo ) : void,
- *      'ping':             function ( { timestamp: number }, function ( { clientTimestamp: number } ) : void ) : void,
+ *      'ping':             function ( { frame: number, roundTrip: number }, function () : void ) : void,
  *      'metrics':          function ( IOMetrics ) : void,
  *      'msg':              function ( string, string, Object, function ( Object ) : void = ) : Object,
  *      'log':              function ( 'server' | { socket:string, id:string, name:string }, ...any ) : void

package/src/types/IOInfo.js

@@ -1,11 +0,0 @@
-
-/**
- * @typedef IOInfo
- * @property {number} ms
- * @property {number} frame
- * @property {number} fps
- * @property {number} heapUsed
- * @property {number} heapTotal
- */
-
-export { };