@fleetbase/fleetops-engine 0.3.6 → 0.3.8

package/server/src/Models/ServiceArea.php

@@ -2,7 +2,7 @@
 
 namespace Fleetbase\FleetOps\Models;
 
-use Fleetbase\FleetOps\Casts\MultiPolygon;
+use Fleetbase\FleetOps\Casts\MultiPolygon as MultiPolygonCast;
 use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Models\Model;
 use Fleetbase\Traits\HasApiModelBehavior;
@@ -11,7 +11,16 @@ use Fleetbase\Traits\HasUuid;
 use Fleetbase\Traits\SendsWebhooks;
 use Fleetbase\Traits\TracksApiCredential;
 use Grimzy\LaravelMysqlSpatial\Eloquent\SpatialTrait;
+use Grimzy\LaravelMysqlSpatial\Types\LineString;
+use Grimzy\LaravelMysqlSpatial\Types\MultiPolygon;
+use Grimzy\LaravelMysqlSpatial\Types\Point;
+use Grimzy\LaravelMysqlSpatial\Types\Polygon;
+use Illuminate\Support\Arr;
 
+/**
+ * @var \Grimzy\LaravelMysqlSpatial\Types\Point        $location
+ * @var \Grimzy\LaravelMysqlSpatial\Types\MultiPolygon $border
+ */
 class ServiceArea extends Model
 {
     use HasUuid;
@@ -83,7 +92,7 @@ class ServiceArea extends Model
      * @var array
      */
     protected $casts = [
-        'border' => MultiPolygon::class,
+        'border' => MultiPolygonCast::class,
     ];
 
     /**
@@ -119,39 +128,297 @@ class ServiceArea extends Model
     }
 
     /**
-     * Creates a 100m polygon from the coorddinates.
+     * Creates a polygon from a given point and radius.
      *
-     * @var Polygon
+     * @param \Grimzy\LaravelMysqlSpatial\Types\Point $point  the central point from which to create the polygon
+     * @param int                                     $meters The radius in meters for the polygon. Default is 500 meters.
+     *
+     * @return \Grimzy\LaravelMysqlSpatial\Types\Polygon returns a Polygon object
+     */
+    public static function createPolygonFromPoint(Point $point, int $meters = 500): Polygon
+    {
+        $coordinates = array_map(
+            function ($coord) {
+                return new Point(...$coord);
+            },
+            Utils::coordsToCircle($point->getLat(), $point->getLng(), $meters)
+        );
+
+        return new Polygon([new LineString($coordinates)]);
+    }
+
+    /**
+     * Creates a multi-polygon from a given point and radius.
+     *
+     * @param \Grimzy\LaravelMysqlSpatial\Types\Point $point  the central point from which to create the multi-polygon
+     * @param int                                     $meters The radius in meters for the multi-polygon. Default is 500 meters.
+     *
+     * @return \Grimzy\LaravelMysqlSpatial\Types\MultiPolygon returns a MultiPolygon object
+     */
+    public static function createMultiPolygonFromPoint(Point $point, int $meters = 500): MultiPolygon
+    {
+        $coordinates = Utils::coordsToCircle($point->getLat(), $point->getLng(), $meters);
+
+        // first and last positions should be equivalent
+        if (Arr::first($coordinates) !== Arr::last($coordinates)) {
+            $coordinates[] = Arr::first($coordinates);
+        }
+
+        // conver the coordinate pairs to points
+        $coordinates = array_map(
+            function ($coord) {
+                return new Point(...$coord);
+            },
+            $coordinates
+        );
+
+        $polygon = new Polygon([new LineString($coordinates)]);
+
+        return new MultiPolygon([$polygon]);
+    }
+
+    /**
+     * Retrieves the location attribute as a point.
+     *
+     * @return \Grimzy\LaravelMysqlSpatial\Types\Point returns the centroid of the border as a Point object
+     */
+    public function getLocationAttribute(): Point
+    {
+        $centroid = $this->getCentroid();
+
+        return new Point($centroid->x(), $centroid->y());
+    }
+
+    /**
+     * Retrieves the latitude component of the location attribute.
+     *
+     * @return float returns the latitude value
+     */
+    public function getLatitudeAttribute(): float
+    {
+        return $this->location->getLat();
+    }
+
+    /**
+     * Retrieves the longitude component of the location attribute.
+     *
+     * @return float returns the longitude value
      */
-    public function polygon($meters = 100)
+    public function getLongitudeAttribute(): float
     {
-        return new \League\Geotools\Polygon\Polygon(Utils::coordsToCircle($this->latitude, $this->longitude, $meters));
+        return $this->location->getLng();
     }
 
     /**
-     * Determines if coordinates fall within zone.
+     * Creates a polygon from the center point of the current object.
      *
-     * @param int $latitude
-     * @param int $longitude
+     * @param int $meters The radius in meters for the polygon. Default is 500 meters.
      *
-     * @return bool
+     * @return \League\Geotools\Polygon\Polygon returns a Polygon object
      */
-    public function inZone($latitude, $longitude)
+    public function createPolygonFromCenter(int $meters = 500): \League\Geotools\Polygon\Polygon
     {
-        return $this->polygon()->pointInPolygon(new \League\Geotools\Coordinate\Coordinate([$latitude, $longitude]));
+        $coordinates = Utils::coordsToCircle($this->latitude, $this->longitude, $meters);
+
+        return new \League\Geotools\Polygon\Polygon($coordinates);
+    }
+
+    /**
+     * Converts the border attribute to a MultiPolygon object.
+     *
+     * @return \League\Geotools\Polygon\MultiPolygon returns a MultiPolygon object representing the border
+     */
+    public function asMultiPolygon(): \League\Geotools\Polygon\MultiPolygon
+    {
+        $polygons = [];
+
+        if (is_iterable($this->border)) {
+            foreach ($this->border as $polygon) {
+                $coordinates = [];
+                foreach ($polygon as $lineString) {
+                    foreach ($lineString as $point) {
+                        $coordinates[] = [$point->getLat(), $point->getLng()];
+                    }
+                }
+
+                if (count($coordinates)) {
+                    $polygons[] = new \League\Geotools\Polygon\Polygon($coordinates);
+                }
+            }
+        }
+
+        if (empty($polygons)) {
+            return null;
+        }
+
+        return new \League\Geotools\Polygon\MultiPolygon($polygons);
     }
 
     /**
-     * Determines if multiple coordinates fall within zone.
+     * Converts the border's coordinates to an array of \Brick\Geo\Point objects.
      *
-     * @param array $coords
+     * @return \Brick\Geo\Point[] an array of \Brick\Geo\Point objects representing the coordinates
+     */
+    public function toGeosCoordinates(): array
+    {
+        $coordinates = [];
+
+        if (is_iterable($this->border)) {
+            foreach ($this->border as $polygon) {
+                foreach ($polygon as $lineString) {
+                    foreach ($lineString as $point) {
+                        $coordinates[] = \Brick\Geo\Point::fromText('POINT (' . $point->getLat() . ' ' . $point->getLng() . ')');
+                    }
+                }
+            }
+        }
+
+        return $coordinates;
+    }
+
+    /**
+     * Converts the border's coordinates to an array of \Brick\Geo\LineString objects.
      *
-     * @return bool
+     * @return \Brick\Geo\LineString[] an array of \Brick\Geo\LineString objects
      */
-    public function pointsInZone($coords)
+    public function toGeosLineStrings(): array
     {
-        foreach ($coords as $coord) {
-            if (!$this->polygon()->pointInPolygon(new \League\Geotools\Coordinate\Coordinate([$coord[0], $coord[1]]))) {
+        $lineStrings = [];
+        if (is_iterable($this->border)) {
+            foreach ($this->border as $polygon) {
+                $points = [];
+
+                foreach ($polygon as $lineString) {
+                    foreach ($lineString as $point) {
+                        $points[] = \Brick\Geo\Point::fromText('POINT (' . $point->getLat() . ' ' . $point->getLng() . ')');
+                    }
+                }
+
+                if ($points) {
+                    $lineStrings[] = \Brick\Geo\LineString::of(...$points);
+                }
+            }
+        }
+
+        return $lineStrings;
+    }
+
+    /**
+     * Converts the first LineString from the border into a \Brick\Geo\Polygon.
+     *
+     * @return \Brick\Geo\Polygon a \Brick\Geo\Polygon object created from the first line string of the border
+     */
+    public function toGeosPolygon(): ?\Brick\Geo\Polygon
+    {
+        $lineString = Arr::first($this->toGeosLineStrings());
+
+        if (empty($lineString)) {
+            return null;
+        }
+
+        return \Brick\Geo\Polygon::of($lineString);
+    }
+
+    /**
+     * Converts the border's coordinates to a \Brick\Geo\MultiPolygon object.
+     *
+     * @return \Brick\Geo\MultiPolygon a \Brick\Geo\MultiPolygon object representing the border
+     */
+    public function toGeosMultiPolygon(): ?\Brick\Geo\MultiPolygon
+    {
+        $polygons = [];
+
+        if (is_iterable($this->border)) {
+            foreach ($this->border as $polygon) {
+                $points = [];
+
+                foreach ($polygon as $lineString) {
+                    foreach ($lineString as $point) {
+                        $points[] = \Brick\Geo\Point::fromText('POINT (' . $point->getLat() . ' ' . $point->getLng() . ')');
+                    }
+                }
+
+                $lineString = \Brick\Geo\LineString::of(...$points);
+                $polygons[] = \Brick\Geo\Polygon::of($lineString);
+            }
+        }
+
+        if (empty($polygons)) {
+            return null;
+        }
+
+        return \Brick\Geo\MultiPolygon::of(...$polygons);
+    }
+
+    /**
+     * Calculates the centroid of the border as a \Brick\Geo\Point.
+     *
+     * @return \Brick\Geo\Point the centroid of the border as a \Brick\Geo\Point object
+     */
+    public function getCentroid(): \Brick\Geo\Point
+    {
+        $geometryEngine       = new \Brick\Geo\Engine\GEOSEngine();
+        $borderAsMultiPolygon = $this->toGeosMultiPolygon();
+
+        if ($borderAsMultiPolygon instanceof \Brick\Geo\Geometry) {
+            return $geometryEngine->centroid($borderAsMultiPolygon);
+        }
+
+        return \Brick\Geo\Point::fromText('POINT (0 0)');
+    }
+
+    /**
+     * Converts the border attribute to a Polygon object.
+     *
+     * @return \League\Geotools\Polygon\Polygon returns the first Polygon object from the border
+     */
+    public function asPolygon(): ?\League\Geotools\Polygon\Polygon
+    {
+        $polygons = [];
+
+        if (is_iterable($this->border)) {
+            foreach ($this->border as $polygon) {
+                $coordinates = [];
+                foreach ($polygon as $point) {
+                    $coordinates[] = [$point->getLat(), $point->getLng()];
+                }
+                $polygons[] = new \League\Geotools\Polygon\Polygon($coordinates);
+            }
+        }
+
+        return Arr::first($polygons);
+    }
+
+    /**
+     * Checks if a given point is included within the border.
+     *
+     * @param Point $point the point to check
+     *
+     * @return bool returns true if the point is inside the polygon, false otherwise
+     */
+    public function includesPoint(Point $point): bool
+    {
+        $latitude   = $point->getLat();
+        $longitude  = $point->getLng();
+        $coordinate = new \League\Geotools\Coordinate\Coordinate([$latitude, $longitude]);
+
+        return $this->asPolygon()->pointInPolygon($coordinate);
+    }
+
+    /**
+     * Checks if a set of points are all included within the border.
+     *
+     * @param array $coordinates an array of coordinates to check
+     *
+     * @return bool returns true if all points are inside the polygon, false otherwise
+     */
+    public function includesPoints(array $coordinates = []): bool
+    {
+        foreach ($coordinates as $coord) {
+            $point         = Utils::getPointFromMixed($coord);
+            $includesPoint = $this->includesPoint($point);
+
+            if (!$includesPoint) {
                 return false;
             }
         }

package/server/src/Models/ServiceRate.php

@@ -81,10 +81,10 @@ class ServiceRate extends Model
      * @var array
      */
     protected $casts = [
-        'base_fee'                => Money::class . ':currency',
-        'per_meter_flat_rate_fee' => Money::class . ':currency',
-        'cod_flat_fee'            => Money::class . ':currency',
-        'peak_hours_flat_fee'     => Money::class . ':currency',
+        'base_fee'                => Money::class,
+        'per_meter_flat_rate_fee' => Money::class,
+        'cod_flat_fee'            => Money::class,
+        'peak_hours_flat_fee'     => Money::class,
     ];
 
     /**
@@ -461,7 +461,11 @@ class ServiceRate extends Model
         $serviceRates = $serviceRatesQuery->get();
 
         $waypoints = collect($places)->map(function ($place) {
-            return $place->getLocationAsPoint();
+            $place = Place::createFromMixed($place);
+
+            if ($place instanceof Place) {
+                return $place->getLocationAsPoint();
+            }
         });
 
         foreach ($serviceRates as $serviceRate) {
@@ -726,7 +730,7 @@ class ServiceRate extends Model
         ]);
 
         // Prepare all waypoints and origin and destination
-        $waypoints    = $payload->getAllStops()->mapInto(Place::class);
+        $waypoints    = $payload->getAllStops();
         $origin       = $waypoints->first();
         $destinations = $waypoints->skip(1)->toArray();
 

package/server/src/Models/TrackingNumber.php

@@ -88,7 +88,9 @@ class TrackingNumber extends Model
      */
     public function getLastStatusAttribute()
     {
-        return $this->status->status;
+        $this->load('status');
+
+        return data_get($this, 'status.status');
     }
 
     /**
@@ -96,7 +98,9 @@ class TrackingNumber extends Model
      */
     public function getLastStatusCodeAttribute()
     {
-        return $this->status->code;
+        $this->load('status');
+
+        return data_get($this, 'status.code');
     }
 
     /**
@@ -104,13 +108,13 @@ class TrackingNumber extends Model
      */
     public function getLastStatusUpdatedAtAttribute()
     {
-        return $this->status->created_at;
+        $this->load('status');
+
+        return data_get($this, 'status.created_at');
     }
 
     /**
-     * Get the service details.
-     *
-     * @var Model
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
     public function status()
     {
@@ -118,9 +122,7 @@ class TrackingNumber extends Model
     }
 
     /**
-     * Tracking statuses by this tracking number.
-     *
-     * @var Model
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
      */
     public function statuses()
     {
@@ -128,9 +130,7 @@ class TrackingNumber extends Model
     }
 
     /**
-     * Get the order status belongss to.
-     *
-     * @var Model
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
     public function order()
     {
@@ -138,9 +138,7 @@ class TrackingNumber extends Model
     }
 
     /**
-     * Get the entity tracking number belongss to.
-     *
-     * @var Model
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
     public function entity()
     {
@@ -148,9 +146,7 @@ class TrackingNumber extends Model
     }
 
     /**
-     * Get the tracking number owner, could be order or entity.
-     *
-     * @var Model
+     * @return \Illuminate\Database\Eloquent\Relations\MorphTo
      */
     public function owner()
     {
@@ -158,9 +154,7 @@ class TrackingNumber extends Model
     }
 
     /**
-     * Get the tracking number type.
-     *
-     * @var Model
+     * @return string
      */
     public function getTypeAttribute()
     {
@@ -170,9 +164,9 @@ class TrackingNumber extends Model
     /**
      * Generates a fleetbase tracking number.
      *
-     * @var array
+     * @var string
      */
-    public static function generateTrackingNumber($region = 'SG', $length = 10)
+    public static function generateTrackingNumber($region = 'SG', $length = 10): string
     {
         $company     = \Fleetbase\Models\Company::where('uuid', session('company'))->withoutGlobalScopes()->first();
         $companyName = $company ? strtoupper(substr($company->name, 0, 3)) : null;
@@ -188,7 +182,7 @@ class TrackingNumber extends Model
     /**
      * Generates a unique fleetbase tracking number.
      *
-     * @var array
+     * @var string
      */
     public static function generateNumber($region = 'SG', $length = 10)
     {

package/server/src/Models/TrackingStatus.php

@@ -110,9 +110,7 @@ class TrackingStatus extends Model
     protected $hidden = [];
 
     /**
-     * The tracking number.
-     *
-     * @var Model
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
     public function trackingNumber()
     {
@@ -120,9 +118,7 @@ class TrackingStatus extends Model
     }
 
     /**
-     * The proof if any.
-     *
-     * @var Model
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
     public function proof()
     {

package/server/src/Models/Vehicle.php

@@ -49,7 +49,7 @@ class Vehicle extends Model
      *
      * @var array
      */
-    protected $searchableColumns = ['make', 'model', 'year', 'plate_number', 'internal_id', 'vin', 'public_id'];
+    protected $searchableColumns = ['make', 'model', 'year', 'plate_number', 'vin', 'public_id'];
 
     /**
      * Attributes that is filterable on this model.
@@ -233,7 +233,7 @@ class Vehicle extends Model
         $nameSegments = [];
 
         // Populate the nameSegments array with the values of the attributes
-        $keys = ['year', 'make', 'model', 'trim', 'plate_number', 'internal_id'];
+        $keys = ['year', 'make', 'model', 'trim', 'plate_number'];
         foreach ($keys as $key) {
             if (!empty($this->{$key})) {
                 $nameSegments[] = $this->{$key};

package/server/src/Models/Waypoint.php

@@ -146,16 +146,6 @@ class Waypoint extends Model
         return $this->belongsTo(\Fleetbase\Models\Company::class);
     }
 
-    /**
-     * Waypoint has completed instance.
-     *
-     * @var Model
-     */
-    public function completed()
-    {
-        return $this->hasOne(WaypointCompleted::class, 'place_uuid', 'place_uuid')->where('payload_uuid', $this->payload_uuid);
-    }
-
     /**
      * The tracking number for waypoint.
      */