@unitn-asa/deliveroo-js-sdk 1.2.6 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unitn-asa/deliveroo-js-sdk",
-  "version": "1.2.6",
+  "version": "1.3.0",
   "description": "Software development kit for Deliveroo.js",
   "author": "Marco Robol <marco.robol@unitn.it>",
   "type": "module",
@@ -31,7 +31,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "aafc2442cb50b860033f5196e4a30b410b9959fd",
+  "gitHead": "704da8315162c2b98b00d6f4736f5e7631c5b4c5",
   "dependencies": {
     "getopts": "^2.3.0"
   }

package/src/client/DjsClientSocket.js

@@ -80,7 +80,7 @@ export class DjsClientSocket extends Socket {
     }
     
     /**
-     * @param { function( IOTile, IOInfo ) : void } callback
+     * @param { function( IOTile ) : void } callback
      */
     onTile ( callback ) {
         this.on( "tile", callback )
@@ -95,41 +95,33 @@ export class DjsClientSocket extends Socket {
     }
     
     /**
-     * @param { function( IOAgent, IOInfo ) : void } callback
+     * @param { function( IOAgent ) : void } callback
      */
     onYou ( callback ) {
         this.on( "you", callback )
     }
 
     /**
-     * @param { function( IOAgent, IOInfo ) : void } callback
+     * @param { function( IOAgent ) : void } callback
      */
     onceYou ( callback ) {
         this.once( "you", callback )
     }
     
     /**
-     * Listen to 'agents sensing' events
-     * @param { function( IOSensing [] ) : void } callback
+     * Listen to 'sensing' events
+     * @param { function( IOSensing ) : void } callback
      */
-    onAgentsSensing ( callback ) {
-        this.on( "agents sensing", callback )
+    onSensing ( callback ) {
+        this.on( "sensing", callback )
     }
     
     /**
-     * Listen to 'parcels sensing' events
-     * @param { function( IOSensing [] ) : void } callback
+     * Listen to 'info' events
+     * @param { function( IOInfo ) : void } callback
      */
-    onParcelsSensing ( callback ) {
-        this.on( "parcels sensing", callback )
-    }
-
-    /**
-     * Listen to 'crates sensing' events
-     * @param { function( IOSensing [] ) : void } callback
-     */
-    onCratesSensing ( callback ) {
-        this.on( "crates sensing", callback )
+    onInfo ( callback ) {
+        this.on( "info", callback )
     }
     
     /**
@@ -206,11 +198,11 @@ export class DjsClientSocket extends Socket {
     /**
      * When movement completes, it resolves to true.
      * In case of failure when moving, it resolves to false
-     * @param { 'up' | 'right' | 'left' | 'down' | { x:number, y:number } } directionOrXy It can be either: 'up', 'right', 'left', 'down', or destination Xy
+     * @param { 'up' | 'right' | 'left' | 'down' } direction It can be either: 'up', 'right', 'left', 'down'
      * @returns { Promise < { x:number, y:number } | false > }
      */
-    async emitMove ( directionOrXy ) {
-        return this.emitAndResolveOnAck( 'move', directionOrXy );
+    async emitMove ( direction ) {
+        return this.emitAndResolveOnAck( 'move', direction );
     }
 
     /**

package/src/client/DjsRestClient.js

@@ -205,7 +205,7 @@ export class DjsRestClient {
                 }
                 throw new Error(`Error generating token, Status code: ${response.status}`);
             })
-            .then(data => {
+            .then( (/** @type {{token:string}} */ data) => {
                 console.log("token ottenuto: " + data.token.slice(-30));
                 resolve(data);
             })

package/src/server/DjsServer.js

@@ -40,10 +40,9 @@ export class DjsServer extends Server {
     /**
      * Broadcast a tile update to all connected clients
      * @param { IOTile } tile
-     * @param { IOInfo } info
      */
-    broadcastTile({ x, y, type }, info) {
-        this.emit('tile', { x, y, type }, info);
+    broadcastTile({ x, y, type }) {
+        this.emit('tile', { x, y, type });
     }
 
     /**

package/src/server/DjsServerSocket.js

@@ -46,7 +46,7 @@ export class DjsServerSocket extends Socket {
      * @param { function() : void } callback
      */
     onDisconnect ( callback ) {
-        this.on( 'disconnect', callback);
+        super.on( 'disconnect', callback);
     }
 
     /**
@@ -67,10 +67,9 @@ export class DjsServerSocket extends Socket {
 
     /**
      * @param { IOTile } tile
-     * @param { IOInfo } info
      */
-    emitTile ( { x, y, type }, info ) {
-        super.emit( 'tile', {x, y, type}, info );
+    emitTile ( { x, y, type } ) {
+        super.emit( 'tile', {x, y, type} );
     }
 
     /**
@@ -83,48 +82,37 @@ export class DjsServerSocket extends Socket {
     
     /**
      * @param { IOAgent } you
-     * @param { IOInfo } info
      */
-    emitYou ( {id, name, teamId, teamName, x, y, score, penalty}, info ) {
-        super.emit( 'you', {id, name, teamId, teamName, x, y, score, penalty}, info );
+    emitYou ( {id, name, teamId, teamName, x, y, score, penalty} ) {
+        super.emit( 'you', {id, name, teamId, teamName, x, y, score, penalty} );
     }
 
     /**
-     * @param { IOSensing [] } agents
-     * @param { IOInfo } info
+     * @param { IOSensing } sensing
      */
-    emitAgentsSensing ( agents, info ) {
-        super.emit( 'agents sensing', agents, info );
+    emitSensing ( sensing ) {
+        super.emit( 'sensing', sensing );
     }
     
     /**
-     * @param { IOSensing [] } parcels
-     * @param { IOInfo } info
-     */
-    emitParcelSensing ( parcels, info ) {
-        super.emit( 'parcels sensing', parcels, info );
-    }
-
-    /**
-     * @param { IOSensing [] } crates
      * @param { IOInfo } info
      */
-    emitCrateSensing ( crates, info ) {
-        super.emit( 'crates sensing', crates, info );
+    emitInfo ( info ) {
+        super.emit( 'info', info );
     }
 
 
 
     /**
      * @callback onMoveCallback
-     * @param { 'up' | 'right' | 'left' | 'down' | { x:number, y:number } } directionOrXy
+     * @param { 'up' | 'right' | 'left' | 'down' } direction
      * @param { function( { x:number, y:number } | false ) : void } replyAcknowledgmentCallback ( reply )
      */
     /**
      * @param { onMoveCallback } callback ( direction, acknowledgementCallback )
      */
     onMove ( callback ) {
-        this.on( 'move', callback );
+        super.on( 'move', callback );
     }
     
     /**
@@ -135,7 +123,7 @@ export class DjsServerSocket extends Socket {
      * @param { onPickupCallback } callback ( acknowledgementCallback )
      */
     onPickup ( callback ) {
-        this.on( 'pickup', callback );
+        super.on( 'pickup', callback );
     }
 
     /**
@@ -147,7 +135,7 @@ export class DjsServerSocket extends Socket {
      * @param { onPutdownCallback } callback ( selected, acknowledgementCallback )
      */
     onPutdown ( callback ) {
-        this.on( 'putdown', callback );
+        super.on( 'putdown', callback );
     }
 
 
@@ -156,21 +144,21 @@ export class DjsServerSocket extends Socket {
      * @param { function ( string, any, function ( 'successful' ) : void ) : void } callback ( toId, msg, ack )
      */
     onSay ( callback ) {
-        this.on( 'say', callback );
+        super.on( 'say', callback );
     }
 
     /**
      * @param { function ( string, any, function ( any ) : void ) : void } callback ( toId, msg, ack(reply) )
      */
     onAsk ( callback ) {
-        this.on( 'ask', callback );
+        super.on( 'ask', callback );
     }
 
     /**
      * @param { function ( any, function ( any ) : void ) : void } callback ( msg, ack(reply) )
      */
     onShout ( callback ) {
-        this.on( 'shout', callback );
+        super.on( 'shout', callback );
     }
 
     /**
@@ -225,7 +213,7 @@ export class DjsServerSocket extends Socket {
      * @param { function ( ...any ) : void } callback ( ...msgArgs )
      */
     onLog ( callback ) {
-        this.on( 'log', callback );
+        super.on( 'log', callback );
     }
     
     /**
@@ -246,7 +234,7 @@ export class DjsServerSocket extends Socket {
      * @param { function ( 'create' | 'dispose' | 'set', {id:string, x:number, y:number, reward:number} ) : void } callback 
      */
     onParcel ( callback ) {
-        this.on( 'parcel', callback );
+        super.on( 'parcel', callback );
     }
 
     /**
@@ -254,7 +242,7 @@ export class DjsServerSocket extends Socket {
      * @param { function ( IOTile ) : void } callback
      */
     onTile ( callback ) {
-        this.on( 'tile', callback );
+        super.on( 'tile', callback );
     }
 
     /**
@@ -262,7 +250,7 @@ export class DjsServerSocket extends Socket {
      * @param { function () : void } callback
      */
     onRestart ( callback ) {
-        this.on( 'restart', callback );
+        super.on( 'restart', callback );
     }
 
 

package/src/types/IOAgent.js

@@ -5,8 +5,8 @@
  * @property {string} name
  * @property {string} teamId
  * @property {string} teamName
- * @property {number} x
- * @property {number} y
+ * @property {number=} x
+ * @property {number=} y
  * @property {number} score
  * @property {number} penalty
  */

package/src/types/IOClockEvent.js

@@ -1,7 +1,6 @@
 
 /**
  * @typedef { 'frame' | '1s' | '2s' | '5s' | '10s' | 'infinite' } IOClockEvent
- * @export
  */
 
 

package/src/types/IOGameOptions.js

@@ -46,8 +46,7 @@
  * Player configuration object
  * @property {string} agent_type                        Agent class
  * @property {number} movement_duration                 Duration of each movement in ms
- * @property {number} agents_observation_distance       Observation distance for agents
- * @property {number} parcels_observation_distance      Observation distance for parcels
+ * @property {number|'infinite'} observation_distance   Observation distance
  * @property {number} capacity                          Capacity
  */
 

package/src/types/IONPC.js

@@ -0,0 +1,9 @@
+/**
+ * @typedef IONPC
+ * @property {string} id
+ * @property {string} name
+ * @property {boolean} running
+ * @property {boolean} stopRequested
+ */
+
+export { };

package/src/types/IOSensing.js

@@ -5,11 +5,10 @@
 
 /**
  * @typedef IOSensing
- * @property {number} x
- * @property {number} y
- * @property {IOAgent=} agent
- * @property {IOParcel=} parcel
- * @property {IOCrate=} crate
+ * @property {{x:number, y:number}[]} positions
+ * @property {IOAgent[]} agents
+ * @property {IOParcel[]} parcels
+ * @property {IOCrate[]} crates
  */
 
 export { };

package/src/types/IOSocketEvents.js

@@ -8,7 +8,7 @@
  * Client -> Server events. Emitted by the client and listened by the server.
  * @typedef {{
  *      'disconnect':   function () : void,
- *      'move':         function ( 'up' | 'right' | 'left' | 'down' | { x:number, y:number }, function ( { x:number, y:number } | false ) : void = ) : { x:number, y:number } | false,
+ *      'move':         function ( 'up' | 'right' | 'left' | 'down', function ( { x:number, y:number } | false ) : void = ) : { x:number, y:number } | false,
  *      'pickup':       function ( function ( { id:string } [] ) : void = ) : { id:string } [],
  *      'putdown':      function ( string [] =, function ( { id:string } [] ) : void = ) : { id:string } [],
  *      'say':          function ( string, any, function( 'successful' ) : void ) : void,
@@ -30,14 +30,13 @@
  *      'token':            function ( string ) : void,
  *      'config':           function ( any ) : void,
  *      'map':              function ( number, number, IOTile[] ) : void,
- *      'tile':             function ( IOTile, IOInfo ) : void,
+ *      'tile':             function ( IOTile ) : void,
  *      'controller':       function ( 'connected' | 'disconnected', {id:string, name:string, teamId:string, teamName:string, score:number} ) : void,
- *      'you':              function ( IOAgent, IOInfo ) : void,
- *      'agents sensing':   function ( IOSensing[], IOInfo ) : void,
- *      'parcels sensing':  function ( IOSensing[], IOInfo ) : void,
- *      'crates sensing':   function ( IOSensing[], IOInfo ) : void,
+ *      'you':              function ( IOAgent ) : void,
+ *      'sensing':          function ( IOSensing ) : void,
+ *      'info':             function ( IOInfo ) : void,
  *      'msg':              function ( string, string, Object, function ( Object ) : void = ) : Object,
- *      'log':              function ( 'server' | { socket:string, id:string, name:string }, IOInfo, ...any ) : void
+ *      'log':              function ( 'server' | { socket:string, id:string, name:string }, ...any ) : void
  * }} IOServerEvents
  */
 

package/src/types/parseClockEvent.js

@@ -1,5 +1,5 @@
 
-/** @typedef {import("./IOClockEvent.js").IOClockEvent} IOClockEvent */
+/** @import { IOClockEvent } from "./IOClockEvent.js" */