@fleetbase/fleetops-engine 0.3.6 → 0.3.8

package/server/src/Http/Resources/v1/Zone.php

@@ -2,10 +2,8 @@
 
 namespace Fleetbase\FleetOps\Http\Resources\v1;
 
-use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Http\Resources\FleetbaseResource;
 use Fleetbase\Support\Http;
-use Grimzy\LaravelMysqlSpatial\Types\Polygon;
 
 class Zone extends FleetbaseResource
 {
@@ -24,7 +22,7 @@ class Zone extends FleetbaseResource
             'public_id'    => $this->when(Http::isInternalRequest(), $this->public_id),
             'name'         => $this->name,
             'description'  => $this->description,
-            'coordinates'  => $this->when($this->border instanceof Polygon, Utils::getCoordinatesFromPolygon($this->border), []),
+            'center'       => $this->location,
             'border'       => $this->border,
             'color'        => $this->color,
             'stroke_color' => $this->stroke_color,
@@ -45,7 +43,7 @@ class Zone extends FleetbaseResource
             'id'           => $this->public_id,
             'name'         => $this->name,
             'description'  => $this->description,
-            'coordinates'  => data_get($this->border, 'coordinates', []),
+            'center'       => $this->location,
             'border'       => $this->border,
             'color'        => $this->color,
             'stroke_color' => $this->stroke_color,

package/server/src/Models/Entity.php

@@ -197,7 +197,7 @@ class Entity extends Model
      */
     public function payload()
     {
-        return $this->belongsTo(Payload::class);
+        return $this->belongsTo(Payload::class)->without(['entities']);
     }
 
     /**
@@ -273,7 +273,7 @@ class Entity extends Model
     /**
      * The length the entity belongs to.
      *
-     * @var PhpUnitsOfMeasure\PhysicalQuantity\Length
+     * @var \PhpUnitsOfMeasure\PhysicalQuantity\Length
      */
     public function getLengthUnitAttribute()
     {
@@ -283,7 +283,7 @@ class Entity extends Model
     /**
      * The width the entity belongs to.
      *
-     * @var PhpUnitsOfMeasure\PhysicalQuantity\Length
+     * @var \PhpUnitsOfMeasure\PhysicalQuantity\Length
      */
     public function getWidthUnitAttribute()
     {
@@ -350,6 +350,72 @@ class Entity extends Model
         return data_get($this, 'trackingNumber.last_status');
     }
 
+    public function setDestination($destinationKey, Payload $payload, bool $save = true): Entity
+    {
+        // if waypoint index provided
+        if (is_numeric($destinationKey)) {
+            $waypoint = $payload->waypoints->values()->get($destinationKey);
+
+            if ($waypoint) {
+                $this->destination_uuid = $waypoint->uuid;
+            }
+        }
+
+        // if explicitly set to pickup
+        if ($destinationKey === 'pickup' && $payload->pickup) {
+            $this->destination_uuid = $payload->pickup->uuid;
+        }
+
+        // if explicitly set to dropoff
+        if ($destinationKey === 'dropoff' && $payload->dropoff) {
+            $this->destination_uuid = $payload->dropoff->uuid;
+        }
+
+        // if waypoint public_id
+        if (Utils::isPublicId($destinationKey)) {
+            $waypoint = $payload->waypoints->firstWhere('public_id', $destinationKey);
+
+            // if no waypoint found from public_id check pickup/dropoff
+            if (!$waypoint) {
+                $waypoint = collect([$this->pickup, $this->dropoff])->firstWhere('public_id', $destinationKey);
+            }
+
+            if ($waypoint) {
+                $this->destination_uuid = $waypoint->uuid;
+            }
+        }
+
+        // if waypoint uuid
+        if (Str::isUuid($destinationKey)) {
+            $waypoint = $payload->waypoints->firstWhere('uuid', $destinationKey);
+
+            // if no waypoint found from uuid check pickup/dropoff
+            if (!$waypoint) {
+                $waypoint = collect([$payload->pickup, $payload->dropoff])->firstWhere('uuid', $destinationKey);
+            }
+
+            if ($waypoint) {
+                $this->destination_uuid = $waypoint->uuid;
+            }
+        }
+
+        // confirm destination_uuid is indeed a place record
+        if (isset($attributes['destination_uuid']) && Place::where('uuid', $attributes['destination_uuid'])->doesntExist()) {
+            // search waypoints for search_uuid if any
+            $destination = Place::where('meta->search_uuid', $attributes['destination_uuid'])->first();
+
+            if ($destination instanceof Place) {
+                $this->destination_uuid = $destination->uuid;
+            }
+        }
+
+        if ($save) {
+            $this->save();
+        }
+
+        return $this;
+    }
+
     public static function insertGetUuid($values = [], Payload $payload = null)
     {
         if (is_array($values) && isset($values['uuid'])) {
@@ -408,4 +474,34 @@ class Entity extends Model
         $this->customer_uuid = $model->uuid;
         $this->customer_type = Utils::getMutationType($model);
     }
+
+    public function getPayload(): ?Payload
+    {
+        $this->load('payload');
+
+        if ($this->payload instanceof Payload) {
+            return $this->payload;
+        }
+
+        if (Str::isUuid($this->payload_uuid)) {
+            return Payload::where('uuid', $this->payload_uuid)->first();
+        }
+
+        return null;
+    }
+
+    public function getTrashedPayload(): ?Payload
+    {
+        $payload = $this->payload()->withoutGlobalScopes()->first();
+
+        if ($payload instanceof Payload) {
+            return $payload;
+        }
+
+        if (Str::isUuid($this->payload_uuid)) {
+            return Payload::where('uuid', $this->payload_uuid)->withoutGlobalScopes()->first();
+        }
+
+        return null;
+    }
 }

package/server/src/Models/Order.php

@@ -604,12 +604,12 @@ class Order extends Model
 
     public function getIsAssignedNotDispatchedAttribute(): bool
     {
-        return !empty($this->driver_assigned_uuid) && !$this->dispatched_at;
+        return !empty($this->driver_assigned_uuid) && $this->dispatched_at === null;
     }
 
     public function getIsNotDispatchedAttribute(): bool
     {
-        return !$this->dispatched_at;
+        return $this->dispatched_at === null;
     }
 
     public function getIsIntegratedVendorOrderAttribute()
@@ -894,7 +894,7 @@ class Order extends Model
         return !$this->dispatched && Carbon::fromString($this->scheduled_at)->between($min, $max);
     }
 
-    public function dispatch($save = false)
+    public function dispatch($save = true)
     {
         $this->dispatched    = true;
         $this->dispatched_at = now();
@@ -907,11 +907,42 @@ class Order extends Model
         return event(new OrderDispatched($this));
     }
 
-    public function firstDispatch()
+    public function insertDispatchActivity(): Order
+    {
+        // get dispatch activity if any and apply to order
+        $dispatchActivity = Flow::getDispatchActivity($this);
+
+        if ($dispatchActivity) {
+            $this->updateActivity($dispatchActivity);
+        }
+
+        return $this;
+    }
+
+    public function dispatchWithActivity(): Order
+    {
+        $this->dispatch();
+        $this->insertDispatchActivity();
+
+        return $this;
+    }
+
+    public function firstDispatch(): Order
     {
         if ($this->dispatched) {
             $this->dispatch();
         }
+
+        return $this;
+    }
+
+    public function firstDispatchWithActivity(): Order
+    {
+        if ($this->dispatched) {
+            $this->dispatchWithActivity();
+        }
+
+        return $this;
     }
 
     public function cancel()
@@ -936,6 +967,22 @@ class Order extends Model
         }
     }
 
+    public function updateActivity(array $activity = null, $proof = null): Order
+    {
+        $status   = data_get($activity, 'status');
+        $details  = data_get($activity, 'details', '');
+        $code     = data_get($activity, 'code', 'dispatched');
+        $location = $this->getLastLocation();
+
+        // insert dispatch activity
+        $this->insertActivity($status, $details, $location, $code, $proof);
+
+        // update status using code
+        $this->setStatus($code, true);
+
+        return $this;
+    }
+
     public function notifyCompleted()
     {
         return event(new OrderCompleted($this));
@@ -950,7 +997,13 @@ class Order extends Model
     public function setCustomerTypeAttribute($type)
     {
         if (is_string($type)) {
-            if ($type === 'customer' || $type === 'vendor' || !Str::startsWith($type, 'fleet-ops')) {
+            $isNotNamespace           = !Str::contains($type, '\\');
+            $doesNotStartWithFleetOps = !Str::startsWith($type, 'fleet-ops');
+            $isValidType              = $type === 'customer' || $type === 'vendor';
+
+            // preprend fleet-ops IF not a namespace and does not start with fleet-ops
+            // this is for handling ember style registry spacing
+            if ($isNotNamespace && $doesNotStartWithFleetOps && $isValidType) {
                 $type = 'fleet-ops:' . $type;
             }
 
@@ -961,7 +1014,13 @@ class Order extends Model
     public function setFacilitatorTypeAttribute($type)
     {
         if (is_string($type)) {
-            if ($type === 'customer' || $type === 'vendor' || !Str::startsWith($type, 'fleet-ops')) {
+            $isNotNamespace           = !Str::contains($type, '\\');
+            $doesNotStartWithFleetOps = !Str::startsWith($type, 'fleet-ops');
+            $isValidType              = $type === 'customer' || $type === 'vendor';
+
+            // preprend fleet-ops IF not a namespace and does not start with fleet-ops
+            // this is for handling ember style registry spacing
+            if ($isNotNamespace && $doesNotStartWithFleetOps && $isValidType) {
                 $type = 'fleet-ops:' . $type;
             }
 
@@ -1087,7 +1146,16 @@ class Order extends Model
     public function getCurrentOriginPosition()
     {
         if ($this->hasDriverAssigned) {
-            return $this->driverAssigned->location;
+            $this->load(['driverAssigned']);
+            $driverAssigned = $this->driverAssigned;
+
+            if (!$driverAssigned) {
+                $driverAssigned = Driver::where('uuid', $this->driver_assigned_uuid)->first();
+            }
+
+            if ($driverAssigned instanceof Driver) {
+                return $driverAssigned->location;
+            }
         }
 
         $origin = null;

package/server/src/Models/Payload.php

@@ -12,6 +12,7 @@ use Fleetbase\Traits\HasPublicId;
 use Fleetbase\Traits\HasUuid;
 use Fleetbase\Traits\TracksApiCredential;
 use Grimzy\LaravelMysqlSpatial\Types\Point;
+use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Str;
 
 class Payload extends Model
@@ -183,16 +184,6 @@ class Payload extends Model
         return $this->hasManyThrough(Place::class, Waypoint::class, 'payload_uuid', 'uuid', 'uuid', 'place_uuid')->whereNull('waypoints.deleted_at')->withoutGlobalScopes();
     }
 
-    /**
-     * Waypoints between start and end.
-     *
-     * @return \Illuminate\Database\Eloquent\Concerns\HasManyThrough
-     */
-    public function waypointsCompleted()
-    {
-        return $this->hasManyThrough(Place::class, WaypointCompleted::class, 'payload_uuid', 'uuid', 'uuid', 'place_uuid')->withoutGlobalScopes();
-    }
-
     /**
      * Always convert fee and rate to integer before insert.
      */
@@ -216,20 +207,16 @@ class Payload extends Model
                 }
             }
 
-            // confirm destination_uuid is indeed a place record
-            if (isset($attributes['destination_uuid']) && Place::where('uuid', $attributes['destination_uuid'])->doesntExist()) {
-                // search waypoints for search_uuid if any
-                $destination = Place::where('meta->search_uuid', $attributes['destination_uuid'])->first();
-
+            // if a destination or waypoint is explicitly set
+            if (empty($attributes['destination_uuid'])) {
+                $destinationKey = Utils::or($attributes, ['waypoint', 'destination']);
+                $destination    = $this->findDestinationFromKey($destinationKey);
                 if ($destination instanceof Place) {
                     $attributes['destination_uuid'] = $destination->uuid;
-                } else {
-                    unset($attributes['destination_uuid']);
                 }
             }
 
             $entity = new Entity($attributes);
-
             $this->entities()->save($entity);
         }
 
@@ -253,15 +240,12 @@ class Payload extends Model
                 }
             }
 
-            // confirm destination_uuid is indeed a place record
-            if (isset($attributes['destination_uuid']) && Place::where('uuid', $attributes['destination_uuid'])->doesntExist()) {
-                // search waypoints for search_uuid if any
-                $destination = Place::where('meta->search_uuid', $attributes['destination_uuid'])->first();
-
+            // if a destination or waypoint is explicitly set
+            if (empty($attributes['destination_uuid'])) {
+                $destinationKey = Utils::or($attributes, ['waypoint', 'destination']);
+                $destination    = $this->findDestinationFromKey($destinationKey);
                 if ($destination instanceof Place) {
                     $attributes['destination_uuid'] = $destination->uuid;
-                } else {
-                    unset($attributes['destination_uuid']);
                 }
             }
 
@@ -277,8 +261,8 @@ class Payload extends Model
     {
         $this->current_waypoint_uuid = $destination->uuid;
 
-        if ($this->save) {
-            $this->save();
+        if ($save) {
+            DB::table($this->getTable())->where('uuid', $this->uuid)->update(['current_waypoint_uuid' => $destination->uuid]);
         }
 
         return $this;
@@ -429,7 +413,7 @@ class Payload extends Model
         }
 
         if ($this->waypoints()->count()) {
-            return $this->waypoints->first();
+            return $this->waypoints->last();
         }
 
         return null;
@@ -449,7 +433,7 @@ class Payload extends Model
         }
 
         if ($this->waypoints()->count()) {
-            return $this->waypoints->last();
+            return $this->waypoints->first();
         }
 
         return null;
@@ -529,6 +513,19 @@ class Payload extends Model
             }
         }
 
+        // ensure all stops/waypoints are instances of Place
+        $stops = $stops->map(function ($place) {
+            if (is_array($place)) {
+                return new Place($place);
+            }
+
+            if ($place instanceof Place) {
+                return $place;
+            }
+
+            return null;
+        });
+
         return $stops->filter();
     }
 
@@ -557,10 +554,6 @@ class Payload extends Model
 
     public function setPlace($property, Place $place, array $options = [])
     {
-        if (!$place) {
-            return;
-        }
-
         $attr     = $property . '_uuid';
         $instance = Place::createFromMixed($place);
         $save     = data_get($options, 'save', false);
@@ -596,16 +589,28 @@ class Payload extends Model
             return;
         }
 
+        if (!$place instanceof Place) {
+            $place = Place::createFromMixed($place);
+        }
+
         return $this->setPlace('pickup', $place, $options);
     }
 
     public function setDropoff($place, array $options = [])
     {
+        if (!$place instanceof Place) {
+            $place = Place::createFromMixed($place);
+        }
+
         return $this->setPlace('dropoff', $place, $options);
     }
 
     public function setReturn($place, array $options = [])
     {
+        if (!$place instanceof Place) {
+            $place = Place::createFromMixed($place);
+        }
+
         return $this->setPlace('return', $place, $options);
     }
 
@@ -714,4 +719,70 @@ class Payload extends Model
 
         return null;
     }
+
+    public function findDestinationFromKey(string $destinationKey = null): ?Place
+    {
+        if ($destinationKey === null) {
+            return null;
+        }
+
+        // if waypoint index provided
+        if (is_numeric($destinationKey)) {
+            $waypoint = $this->waypoints->values()->get($destinationKey);
+
+            if ($waypoint) {
+                return $waypoint;
+            }
+        }
+
+        // if explicitly set to pickup
+        if ($destinationKey === 'pickup' && $this->pickup) {
+            return $this->pickup;
+        }
+
+        // if explicitly set to dropoff
+        if ($destinationKey === 'dropoff' && $this->dropoff) {
+            return $this->dropoff;
+        }
+
+        // if waypoint public_id
+        if (Utils::isPublicId($destinationKey)) {
+            $waypoint = $this->waypoints->firstWhere('public_id', $destinationKey);
+
+            // if no waypoint found from public_id check pickup/dropoff
+            if (!$waypoint) {
+                $waypoint = collect([$this->pickup, $this->dropoff])->firstWhere('public_id', $destinationKey);
+            }
+
+            if ($waypoint) {
+                return $waypoint;
+            }
+        }
+
+        // if waypoint uuid
+        if (Str::isUuid($destinationKey)) {
+            $waypoint = $this->waypoints->firstWhere('uuid', $destinationKey);
+
+            // if no waypoint found from uuid check pickup/dropoff
+            if (!$waypoint) {
+                $waypoint = collect([$this->pickup, $this->dropoff])->firstWhere('uuid', $destinationKey);
+            }
+
+            if ($waypoint) {
+                return $waypoint;
+            }
+        }
+
+        // confirm destination_uuid is indeed a place record
+        if (isset($attributes['destination_uuid']) && Place::where('uuid', $attributes['destination_uuid'])->doesntExist()) {
+            // search waypoints for search_uuid if any
+            $destination = Place::where('meta->search_uuid', $attributes['destination_uuid'])->first();
+
+            if ($destination instanceof Place) {
+                return $destination;
+            }
+        }
+
+        return null;
+    }
 }

package/server/src/Models/Place.php

@@ -4,6 +4,7 @@ namespace Fleetbase\FleetOps\Models;
 
 use Fleetbase\Casts\Json;
 use Fleetbase\FleetOps\Casts\Point;
+use Fleetbase\FleetOps\Support\Geocoding;
 use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Models\Model;
 use Fleetbase\Traits\HasApiModelBehavior;
@@ -251,8 +252,10 @@ class Place extends Model
 
     /**
      * Create a new Place instance from a Google Address instance and optionally save it to the database.
+     *
+     * @return \Fleetbase\Models\Place|null
      */
-    public static function createFromGoogleAddress(\Geocoder\Provider\GoogleMaps\Model\GoogleAddress $address, bool $saveInstance = false): Place
+    public static function createFromGoogleAddress(\Geocoder\Provider\GoogleMaps\Model\GoogleAddress $address, bool $saveInstance = false): ?Place
     {
         $instance = (new static())->fillWithGoogleAddress($address);
 
@@ -279,8 +282,10 @@ class Place extends Model
      * Create a new Place instance from a geocoding lookup.
      *
      * @param bool $saveInstance
+     *
+     * @return \Fleetbase\Models\Place|null
      */
-    public static function createFromGeocodingLookup(string $address, $saveInstance = false): Place
+    public static function createFromGeocodingLookup(string $address, $saveInstance = false): ?Place
     {
         $results = \Geocoder\Laravel\Facades\Geocoder::geocode($address)->get();
 
@@ -291,20 +296,49 @@ class Place extends Model
         return static::createFromGoogleAddress($results->first(), $saveInstance);
     }
 
+    /**
+     * Create a new Place instance from a geocoding lookup.
+     *
+     * @param bool $saveInstance
+     *
+     * @return \Fleetbase\Models\Place|null
+     */
+    public static function createFromReverseGeocodingLookup(\Grimzy\LaravelMysqlSpatial\Types\Point $point, $saveInstance = false): ?Place
+    {
+        $results = Geocoding::reverseFromCoordinates($point->getLat(), $point->getLng());
+        $place   = $results->first();
+
+        if (!$place) {
+            $place = (new static())->newInstance(['location' => $point]);
+        }
+
+        if ($saveInstance) {
+            $place->save();
+        }
+
+        return $place;
+    }
+
     /**
      * Creates a new Place instance from given coordinates.
      *
-     * @param array $attributes
-     * @param bool  $saveInstance
+     * @param \Grimzy\LaravelMysqlSpatial\Types\Point|array $coordinates
+     * @param bool                                          $saveInstance
      *
-     * @return Place|false
+     * @return \Fleetbase\Models\Place|null
      */
-    public static function createFromCoordinates($coordinates, $attributes = [], $saveInstance = false)
+    public static function createFromCoordinates($coordinates, array $attributes = [], $saveInstance = false): ?Place
     {
         $instance = new Place();
+        $point    = Utils::getPointFromMixed($coordinates);
 
-        $latitude  = Utils::getLatitudeFromCoordinates($coordinates);
-        $longitude = Utils::getLongitudeFromCoordinates($coordinates);
+        if ($coordinates instanceof \Grimzy\LaravelMysqlSpatial\Types\Point) {
+            $latitude               = $coordinates->getLat();
+            $longitude              = $coordinates->getLng();
+        } elseif ($point instanceof \Grimzy\LaravelMysqlSpatial\Types\Point) {
+            $latitude               = $point->getLat();
+            $longitude              = $point->getLng();
+        }
 
         $instance->setAttribute('location', new \Grimzy\LaravelMysqlSpatial\Types\Point($latitude, $longitude));
         $instance->fill($attributes);
@@ -312,7 +346,7 @@ class Place extends Model
         $results = \Geocoder\Laravel\Facades\Geocoder::reverse($latitude, $longitude)->get();
 
         if ($results->isEmpty()) {
-            return false;
+            return null;
         }
 
         $instance->fillWithGoogleAddress($results->first());
@@ -327,15 +361,15 @@ class Place extends Model
     /**
      * Inserts a new place into the database using latitude and longitude coordinates.
      *
+     * @param \Grimzy\LaravelMysqlSpatial\Types\Point|array        $coordinates
      * @param \Grimzy\LaravelMysqlSpatial\Types\Point|string|array $coordinates the coordinates to use for the new place
      *
      * @return mixed returns the UUID of the new place on success or false on failure
      */
-    public static function insertFromCoordinates($coordinates)
+    public static function insertFromCoordinates($coordinates, array $attributes = [])
     {
-        $attributes = [];
-
-        $point = Utils::getPointFromMixed($coordinates);
+        $attributes = array_merge([], $attributes);
+        $point      = Utils::getPointFromMixed($coordinates);
 
         if ($coordinates instanceof \Grimzy\LaravelMysqlSpatial\Types\Point) {
             $attributes['location'] = $coordinates;
@@ -365,10 +399,15 @@ class Place extends Model
      * @param array $attributes
      * @param bool  $saveInstance
      *
-     * @return \App\Models\Place|false
+     * @return \Fleetbase\Models\Place|null
      */
-    public static function createFromMixed($place, $attributes = [], $saveInstance = true)
+    public static function createFromMixed($place, $attributes = [], $saveInstance = true): ?Place
     {
+        // If place is already an instance
+        if ($place instanceof Place) {
+            return $place;
+        }
+
         // If $place is a string
         if (is_string($place)) {
             // Check if $place is a valid public_id, return matching Place object if found
@@ -399,7 +438,7 @@ class Place extends Model
         }
         // If $place is an array of coordinates
         elseif (Utils::isCoordinatesStrict($place)) {
-            return static::insertFromCoordinates($place, true);
+            return static::createFromCoordinates($place, $attributes, $saveInstance);
         }
         // If $place is an array
         elseif (is_array($place)) {
@@ -421,7 +460,7 @@ class Place extends Model
             return static::createFromGoogleAddress($place, $saveInstance);
         }
 
-        return false;
+        return null;
     }
 
     /**