@fleetbase/fleetops-engine 0.6.48 → 0.6.50

package/server/src/Models/ServiceRate.php

@@ -216,6 +216,14 @@ class ServiceRate extends Model
         return $this->rate_calculation_method === 'per_meter';
     }
 
+    /**
+     * Check if the rate calculation method is "multi_zone_distance".
+     */
+    public function isMultiZoneDistance(): bool
+    {
+        return $this->rate_calculation_method === 'multi_zone_distance';
+    }
+
     /**
      * Check if the rate calculation method is "per_drop".
      */
@@ -329,6 +337,16 @@ class ServiceRate extends Model
             return $this;
         }
 
+        $serviceRateFees = collect($serviceRateFees)
+            ->map(fn ($fee) => $this->normalizeServiceRateFeePayload($fee))
+            ->filter()
+            ->values()
+            ->toArray();
+
+        if (!$serviceRateFees) {
+            return $this;
+        }
+
         $iterate = count($serviceRateFees);
 
         for ($i = 0; $i < $iterate; $i++) {
@@ -356,6 +374,43 @@ class ServiceRate extends Model
         return $this;
     }
 
+    /**
+     * Normalize embedded service-rate fee payloads before persistence.
+     */
+    public function normalizeServiceRateFeePayload($fee): ?array
+    {
+        if (!is_array($fee)) {
+            return null;
+        }
+
+        $fee['service_area_uuid'] ??= data_get($fee, 'service_area.uuid');
+        $fee['zone_uuid'] ??= data_get($fee, 'zone.uuid');
+
+        if (Utils::castBoolean($fee['is_fallback'] ?? false)) {
+            $fee['service_area_uuid'] = null;
+            $fee['zone_uuid']         = null;
+        }
+
+        return collect($fee)
+            ->only([
+                'uuid',
+                'service_rate_uuid',
+                'service_area_uuid',
+                'zone_uuid',
+                'label',
+                'priority',
+                'is_fallback',
+                'distance',
+                'distance_unit',
+                'min',
+                'max',
+                'unit',
+                'fee',
+                'currency',
+            ])
+            ->toArray();
+    }
+
     /**
      * Set the service rate parcel fees for the current object.
      *
@@ -506,7 +561,7 @@ class ServiceRate extends Model
     public static function getServicableForPlaces($places = [], $service = null, $currency = null, ?\Closure $queryCallback = null): array
     {
         $reader            = new GeoJSONReader();
-        $serviceRatesQuery = static::with(['zone', 'serviceArea', 'rateFees', 'parcelFees']);
+        $serviceRatesQuery = static::with(['zone', 'serviceArea', 'rateFees.zone', 'rateFees.serviceArea', 'parcelFees']);
 
         if ($currency) {
             $serviceRatesQuery->whereRaw('lower(currency) = ?', [strtolower($currency)]);
@@ -738,6 +793,12 @@ class ServiceRate extends Model
             ]);
         }
 
+        if ($this->isMultiZoneDistance()) {
+            [$multiZoneFee, $multiZoneLines] = $this->quoteMultiZoneDistance($waypoints, $totalDistance);
+            $subTotal += $multiZoneFee;
+            $lines = $lines->merge($multiZoneLines);
+        }
+
         if ($this->isAlgorithm()) {
             $resolvedEndpointCount = $endpointCount ?? $this->inferEndpointCountFromStops($waypoints);
             $rateFee               = $this->normalizeCalculatedMoney(Algo::exec(
@@ -927,6 +988,12 @@ class ServiceRate extends Model
             ]);
         }
 
+        if ($this->isMultiZoneDistance()) {
+            [$multiZoneFee, $multiZoneLines] = $this->quoteMultiZoneDistance($waypoints, $totalDistance);
+            $subTotal += $multiZoneFee;
+            $lines = $lines->merge($multiZoneLines);
+        }
+
         if ($this->isAlgorithm()) {
             $rateFee = $this->normalizeCalculatedMoney(Algo::exec(
                 $this->algorithm,
@@ -1086,6 +1153,211 @@ class ServiceRate extends Model
         return 2;
     }
 
+    protected function quoteMultiZoneDistance($waypoints = [], ?int $totalDistance = 0): array
+    {
+        $this->loadMissing(['rateFees.zone', 'rateFees.serviceArea']);
+
+        $rules = $this->rateFees
+            ->filter(fn ($rule) => !$rule->is_fallback && ($rule->zone || $rule->serviceArea))
+            ->sortByDesc(fn ($rule) => (int) ($rule->priority ?? 0))
+            ->values();
+
+        $fallbackRule = $this->rateFees
+            ->filter(fn ($rule) => (bool) $rule->is_fallback)
+            ->sortByDesc(fn ($rule) => (int) ($rule->priority ?? 0))
+            ->first();
+
+        if ($rules->isEmpty() && !$fallbackRule) {
+            return [0, collect()];
+        }
+
+        $pricedDistances = $this->calculateMultiZoneDistances($waypoints, $rules, $fallbackRule, $totalDistance);
+        $lines           = collect();
+        $subTotal        = 0;
+
+        foreach ($pricedDistances as $entry) {
+            $rule = $entry['rule'];
+            if (!$rule instanceof ServiceRateFee) {
+                continue;
+            }
+
+            $distanceInMeters = (float) ($entry['distance_m'] ?? 0);
+            if ($distanceInMeters <= 0) {
+                continue;
+            }
+
+            $unit     = strtolower($rule->distance_unit ?: 'km');
+            $distance = $this->normalizeDistanceForUnit($distanceInMeters, $unit);
+            $fee      = $this->normalizeCalculatedMoney($distance * Utils::numbersOnly($rule->fee ?? 0));
+            $subTotal += $fee;
+
+            if ($rule->is_fallback) {
+                $label = 'Out-of-zone distance charge';
+            } else {
+                $label = data_get($rule, 'zone.name') ?: data_get($rule, 'serviceArea.name') ?: $rule->label ?: 'Geographic';
+            }
+
+            if (!$rule->is_fallback && !str_ends_with(strtolower($label), 'distance charge')) {
+                $label .= ' distance charge';
+            }
+
+            $lines->push([
+                'details'          => sprintf('%s (%s %s x %s)', $label, round($distance, 2), $unit, Utils::moneyFormat($rule->fee, $this->currency)),
+                'amount'           => $fee,
+                'formatted_amount' => Utils::moneyFormat($fee, $this->currency),
+                'currency'         => $this->currency,
+                'code'             => 'MULTI_ZONE_DISTANCE_FEE',
+            ]);
+        }
+
+        return [$subTotal, $lines];
+    }
+
+    protected function calculateMultiZoneDistances($waypoints, $rules, ?ServiceRateFee $fallbackRule = null, ?int $totalDistance = 0): array
+    {
+        $places = collect($waypoints)->map(fn ($place) => Place::createFromMixed($place))->filter()->values();
+
+        if ($places->count() < 2 || (int) $totalDistance <= 0) {
+            return $fallbackRule ? [['rule' => $fallbackRule, 'distance_m' => (float) ($totalDistance ?? 0)]] : [];
+        }
+
+        $reader         = new GeoJSONReader();
+        $ruleGeometries = $rules->map(function ($rule) use ($reader) {
+            return [
+                'rule'      => $rule,
+                'geometry'  => $this->readRateRuleGeometry($rule, $reader),
+            ];
+        })->filter(fn ($entry) => $entry['geometry'])->values();
+
+        if ($ruleGeometries->isEmpty()) {
+            return $fallbackRule ? [['rule' => $fallbackRule, 'distance_m' => (float) $totalDistance]] : [];
+        }
+
+        $distances    = [];
+        $sampledTotal = 0;
+
+        for ($i = 0; $i < $places->count() - 1; $i++) {
+            $start = $this->getLngLatFromPlace($places[$i]);
+            $end   = $this->getLngLatFromPlace($places[$i + 1]);
+
+            if (!$start || !$end) {
+                continue;
+            }
+
+            $legDistance = $this->haversineDistanceInMeters($start['lat'], $start['lng'], $end['lat'], $end['lng']);
+            $steps       = max(1, min(500, (int) ceil($legDistance / 1000)));
+
+            for ($step = 0; $step < $steps; $step++) {
+                $fromRatio = $step / $steps;
+                $toRatio   = ($step + 1) / $steps;
+                $midRatio  = ($fromRatio + $toRatio) / 2;
+
+                $from = $this->interpolateLngLat($start, $end, $fromRatio);
+                $to   = $this->interpolateLngLat($start, $end, $toRatio);
+                $mid  = $this->interpolateLngLat($start, $end, $midRatio);
+
+                $sampleDistance = $this->haversineDistanceInMeters($from['lat'], $from['lng'], $to['lat'], $to['lng']);
+                $sampledTotal += $sampleDistance;
+
+                $matchedRule = $this->matchMultiZoneRule($mid, $ruleGeometries) ?: $fallbackRule;
+                if (!$matchedRule instanceof ServiceRateFee) {
+                    continue;
+                }
+
+                $key = $matchedRule->uuid ?? spl_object_hash($matchedRule);
+                if (!isset($distances[$key])) {
+                    $distances[$key] = ['rule' => $matchedRule, 'distance_m' => 0];
+                }
+
+                $distances[$key]['distance_m'] += $sampleDistance;
+            }
+        }
+
+        if ($sampledTotal > 0 && $totalDistance > 0) {
+            $scale = $totalDistance / $sampledTotal;
+            foreach ($distances as &$entry) {
+                $entry['distance_m'] *= $scale;
+            }
+            unset($entry);
+        }
+
+        return array_values($distances);
+    }
+
+    protected function readRateRuleGeometry(ServiceRateFee $rule, GeoJSONReader $reader)
+    {
+        $border = data_get($rule, 'zone.border') ?: data_get($rule, 'serviceArea.border');
+
+        if (!$border) {
+            return null;
+        }
+
+        try {
+            if (is_object($border) && method_exists($border, 'toJson')) {
+                return $reader->read($border->toJson());
+            }
+
+            if (is_array($border) || is_object($border)) {
+                return $reader->read(json_encode($border, JSON_UNESCAPED_UNICODE));
+            }
+
+            if (is_string($border)) {
+                return $reader->read($border);
+            }
+        } catch (\Throwable $e) {
+            return null;
+        }
+
+        return null;
+    }
+
+    protected function matchMultiZoneRule(array $point, $ruleGeometries): ?ServiceRateFee
+    {
+        $brickPoint = \Brick\Geo\Point::fromText(sprintf('POINT (%F %F)', $point['lng'], $point['lat']), 4326);
+
+        foreach ($ruleGeometries as $entry) {
+            if ($entry['geometry']->contains($brickPoint)) {
+                return $entry['rule'];
+            }
+        }
+
+        return null;
+    }
+
+    protected function getLngLatFromPlace(?Place $place): ?array
+    {
+        if (!$place instanceof Place) {
+            return null;
+        }
+
+        $point = $place->getLocationAsPoint();
+
+        if (!$point || !method_exists($point, 'getLat') || !method_exists($point, 'getLng')) {
+            return null;
+        }
+
+        return ['lat' => (float) $point->getLat(), 'lng' => (float) $point->getLng()];
+    }
+
+    protected function interpolateLngLat(array $start, array $end, float $ratio): array
+    {
+        return [
+            'lat' => $start['lat'] + (($end['lat'] - $start['lat']) * $ratio),
+            'lng' => $start['lng'] + (($end['lng'] - $start['lng']) * $ratio),
+        ];
+    }
+
+    protected function haversineDistanceInMeters(float $lat1, float $lng1, float $lat2, float $lng2): float
+    {
+        $earthRadius = 6371000;
+        $latDelta    = deg2rad($lat2 - $lat1);
+        $lngDelta    = deg2rad($lng2 - $lng1);
+
+        $a = sin($latDelta / 2) ** 2 + cos(deg2rad($lat1)) * cos(deg2rad($lat2)) * sin($lngDelta / 2) ** 2;
+
+        return $earthRadius * 2 * atan2(sqrt($a), sqrt(1 - $a));
+    }
+
     /**
      * Find the ServiceRateFee based on the total distance.
      *

package/server/src/Models/ServiceRateFee.php

@@ -7,6 +7,7 @@ use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Models\Model;
 use Fleetbase\Traits\HasUuid;
 use Fleetbase\Traits\TracksApiCredential;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 class ServiceRateFee extends Model
 {
@@ -32,7 +33,22 @@ class ServiceRateFee extends Model
      *
      * @var array
      */
-    protected $fillable = ['_key', 'service_rate_uuid', 'distance', 'distance_unit', 'min', 'max', 'unit', 'fee', 'currency'];
+    protected $fillable = [
+        '_key',
+        'service_rate_uuid',
+        'service_area_uuid',
+        'zone_uuid',
+        'label',
+        'priority',
+        'is_fallback',
+        'distance',
+        'distance_unit',
+        'min',
+        'max',
+        'unit',
+        'fee',
+        'currency',
+    ];
 
     /**
      * The attributes that should be cast to native types.
@@ -40,10 +56,12 @@ class ServiceRateFee extends Model
      * @var array
      */
     protected $casts = [
-        'min'      => 'integer',
-        'max'      => 'integer',
-        'fee'      => Money::class,
-        'distance' => 'integer',
+        'min'         => 'integer',
+        'max'         => 'integer',
+        'fee'         => Money::class,
+        'distance'    => 'integer',
+        'priority'    => 'integer',
+        'is_fallback' => 'boolean',
     ];
 
     /**
@@ -62,14 +80,26 @@ class ServiceRateFee extends Model
 
     public static function onRowInsert($row)
     {
-        $row['fee']      = Money::apply($row['fee'] ?? 0);
-        $row['distance'] = Utils::numbersOnly($row['distance'] ?? null);
-        $row['min']      = Utils::numbersOnly($row['min'] ?? null);
-        $row['max']      = Utils::numbersOnly($row['max'] ?? null);
+        $row['fee']         = Money::apply($row['fee'] ?? 0);
+        $row['distance']    = Utils::numbersOnly($row['distance'] ?? null);
+        $row['min']         = Utils::numbersOnly($row['min'] ?? null);
+        $row['max']         = Utils::numbersOnly($row['max'] ?? null);
+        $row['priority']    = Utils::numbersOnly($row['priority'] ?? 0);
+        $row['is_fallback'] = Utils::castBoolean($row['is_fallback'] ?? false);
 
         return $row;
     }
 
+    public function serviceArea(): BelongsTo
+    {
+        return $this->belongsTo(ServiceArea::class, 'service_area_uuid', 'uuid');
+    }
+
+    public function zone(): BelongsTo
+    {
+        return $this->belongsTo(Zone::class, 'zone_uuid', 'uuid');
+    }
+
     public function setDistanceAttribute($value)
     {
         $this->attributes['distance'] = Utils::numbersOnly($value);

package/server/src/Models/TrackingNumber.php

@@ -14,6 +14,7 @@ use Fleetbase\Traits\SendsWebhooks;
 use Fleetbase\Traits\TracksApiCredential;
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Schema;
 use Illuminate\Support\Str;
 use Milon\Barcode\Facades\DNS2DFacade as DNS2D;
 
@@ -242,7 +243,7 @@ class TrackingNumber extends Model
         $status = strtolower($trackingStatus->code);
         $owner  = $this->load(['owner'])->getRelationValue('owner');
 
-        if ($owner && $owner->isFillable('status') && $owner->status !== $status) {
+        if ($owner && static::ownerHasStatusColumn($owner) && $owner->isFillable('status') && $owner->status !== $status) {
             $this->owner->status = $status;
 
             $this->owner->save();
@@ -303,7 +304,7 @@ class TrackingNumber extends Model
         TrackingNumber::where('uuid', $uuid)->update(['status_uuid' => $trackingStatusId]);
 
         // update owner status
-        if ($owner && $owner instanceof Model && $owner->isFillable('status')) {
+        if ($owner && $owner instanceof Model && static::ownerHasStatusColumn($owner) && $owner->isFillable('status')) {
             // runs event cycles
             // $model->update([ 'status' => 'created' ]);
 
@@ -313,4 +314,9 @@ class TrackingNumber extends Model
 
         return $uuid;
     }
+
+    protected static function ownerHasStatusColumn(Model $owner): bool
+    {
+        return Schema::hasColumn($owner->getTable(), 'status');
+    }
 }

package/server/src/Models/Vehicle.php

@@ -223,6 +223,7 @@ class Vehicle extends Model
      */
     protected $attributes = [
         'avatar_url' => 'https://flb-assets.s3-ap-southeast-1.amazonaws.com/static/vehicle-icons/mini_bus.svg',
+        'status'     => 'available',
     ];
 
     /**
@@ -324,6 +325,14 @@ class Vehicle extends Model
         return $this->hasOne(Driver::class, 'vehicle_uuid', 'uuid')->without(['vehicle']);
     }
 
+    /**
+     * Set the vehicle status attribute.
+     */
+    public function setStatusAttribute(?string $status = 'available'): void
+    {
+        $this->attributes['status'] = $status === null || $status === 'active' ? 'available' : $status;
+    }
+
     public function category(): BelongsTo
     {
         return $this->belongsTo(Category::class, 'category_uuid', 'uuid');
@@ -597,6 +606,14 @@ class Vehicle extends Model
         return $this;
     }
 
+    public function unassignDriver(): self
+    {
+        Driver::where('vehicle_uuid', $this->uuid)->update(['vehicle_uuid' => null]);
+        $this->unsetRelation('driver');
+
+        return $this;
+    }
+
     /**
      * Retrieves the last known position of the driver within the current company context.
      *
@@ -727,9 +744,8 @@ class Vehicle extends Model
             'plate_number'           => $plateNumber,
             'vin'                    => $vin,
             'type'                   => $type,
-            'status'                 => 'active',
+            'status'                 => 'available',
             'online'                 => 0,
-            'status'                 => 'active',
         ]);
 
         // If driver was resolved assign driver to vehicle

package/server/src/Models/Waypoint.php

@@ -2,8 +2,8 @@
 
 namespace Fleetbase\FleetOps\Models;
 
-use Barryvdh\DomPDF\Facade\Pdf;
 use Fleetbase\Casts\PolymorphicType;
+use Fleetbase\FleetOps\Support\LabelPdf;
 use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\FleetOps\Traits\HasTrackingNumber;
 use Fleetbase\FleetOps\Traits\PayloadAccessors;
@@ -94,7 +94,7 @@ class Waypoint extends Model
      */
     public function pdfLabel()
     {
-        return Pdf::loadHTML($this->label());
+        return LabelPdf::fromHtml($this->label());
     }
 
     /**

package/server/src/Notifications/LateDeparture.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Fleetbase\FleetOps\Notifications;
+
+use Fleetbase\FleetOps\Models\Order;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
+
+class LateDeparture extends Notification implements ShouldQueue
+{
+    use Queueable;
+
+    public static string $name        = 'Late Departure';
+    public static string $description = 'Notify when an order has not departed after the configured grace period.';
+    public static string $package     = 'fleet-ops';
+
+    public function __construct(public Order $order, public array $context = [])
+    {
+    }
+
+    public function via($notifiable): array
+    {
+        return ['mail', 'database'];
+    }
+
+    public function toMail($notifiable): MailMessage
+    {
+        $orderId = $this->order->tracking ?? $this->order->public_id;
+
+        return (new MailMessage())
+            ->subject("Late departure detected for {$orderId}")
+            ->line("Order {$orderId} has not departed within the configured grace period.")
+            ->line('Please review the order and dispatch status.');
+    }
+
+    public function toArray($notifiable): array
+    {
+        return [
+            'event'      => 'order.late_departure',
+            'order_id'   => $this->order->public_id,
+            'order_uuid' => $this->order->uuid,
+            'context'    => $this->context,
+            'message'    => sprintf('Order %s has not departed within the configured grace period.', $this->order->tracking ?? $this->order->public_id),
+        ];
+    }
+}

package/server/src/Notifications/ProlongedStoppage.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Fleetbase\FleetOps\Notifications;
+
+use Fleetbase\FleetOps\Models\Order;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
+
+class ProlongedStoppage extends Notification implements ShouldQueue
+{
+    use Queueable;
+
+    public static string $name        = 'Prolonged Stoppage';
+    public static string $description = 'Notify when a vehicle remains stopped during an active trip beyond the configured threshold.';
+    public static string $package     = 'fleet-ops';
+
+    public function __construct(public Order $order, public array $context = [])
+    {
+    }
+
+    public function via($notifiable): array
+    {
+        return ['mail', 'database'];
+    }
+
+    public function toMail($notifiable): MailMessage
+    {
+        $orderId = $this->order->tracking ?? $this->order->public_id;
+
+        return (new MailMessage())
+            ->subject("Prolonged stoppage detected for {$orderId}")
+            ->line("The vehicle assigned to order {$orderId} has remained stopped beyond the configured threshold.")
+            ->line('Please review the active trip and vehicle location.');
+    }
+
+    public function toArray($notifiable): array
+    {
+        return [
+            'event'      => 'order.prolonged_stoppage',
+            'order_id'   => $this->order->public_id,
+            'order_uuid' => $this->order->uuid,
+            'context'    => $this->context,
+            'message'    => sprintf('The vehicle assigned to order %s has remained stopped beyond the configured threshold.', $this->order->tracking ?? $this->order->public_id),
+        ];
+    }
+}

package/server/src/Notifications/RouteDeviation.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Fleetbase\FleetOps\Notifications;
+
+use Fleetbase\FleetOps\Models\Order;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
+
+class RouteDeviation extends Notification implements ShouldQueue
+{
+    use Queueable;
+
+    public static string $name        = 'Route Deviation';
+    public static string $description = 'Notify when tracked vehicle location deviates from the active route beyond the configured threshold.';
+    public static string $package     = 'fleet-ops';
+
+    public function __construct(public Order $order, public array $context = [])
+    {
+    }
+
+    public function via($notifiable): array
+    {
+        return ['mail', 'database'];
+    }
+
+    public function toMail($notifiable): MailMessage
+    {
+        $orderId = $this->order->tracking ?? $this->order->public_id;
+
+        return (new MailMessage())
+            ->subject("Route deviation detected for {$orderId}")
+            ->line("The vehicle assigned to order {$orderId} has deviated from the active route beyond the configured threshold.")
+            ->line('Please review the route and current vehicle position.');
+    }
+
+    public function toArray($notifiable): array
+    {
+        return [
+            'event'      => 'order.route_deviation',
+            'order_id'   => $this->order->public_id,
+            'order_uuid' => $this->order->uuid,
+            'context'    => $this->context,
+            'message'    => sprintf('The vehicle assigned to order %s has deviated from the active route beyond the configured threshold.', $this->order->tracking ?? $this->order->public_id),
+        ];
+    }
+}

package/server/src/Observers/ContactObserver.php

@@ -31,6 +31,8 @@ class ContactObserver
             throw new \Exception('Customer contact type cannot be changed.');
         }
 
+        $contact->assertCustomerIdentityIsAvailable();
+
         // Get the contacts assosciated user
         if ($contact->doesntHaveUser()) {
             $contact->createUser();