@fleetbase/fleetops-engine 0.6.17 → 0.6.18

package/server/src/Models/Order.php

@@ -14,11 +14,10 @@ use Fleetbase\FleetOps\Support\OrderTracker;
 use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\FleetOps\Traits\HasTrackingNumber;
 use Fleetbase\LaravelMysqlSpatial\Types\Point;
-use Fleetbase\Models\CustomField;
-use Fleetbase\Models\CustomFieldValue;
 use Fleetbase\Models\Model;
 use Fleetbase\Models\Transaction;
 use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasCustomFields;
 use Fleetbase\Traits\HasInternalId;
 use Fleetbase\Traits\HasMetaAttributes;
 use Fleetbase\Traits\HasOptionsAttributes;
@@ -34,6 +33,7 @@ use Illuminate\Database\Eloquent\Relations\HasManyThrough;
 use Illuminate\Database\Eloquent\Relations\MorphTo;
 use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Support\Carbon;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 use Spatie\Activitylog\LogOptions;
 use Spatie\Activitylog\Traits\LogsActivity;
@@ -51,6 +51,7 @@ class Order extends Model
     use Searchable;
     use LogsActivity;
     use HasTrackingNumber;
+    use HasCustomFields;
 
     /**
      * The database table used by the model.
@@ -348,16 +349,6 @@ class Order extends Model
         return $this->hasMany(\Fleetbase\Models\File::class, 'subject_uuid')->latest();
     }
 
-    public function customFields(): HasMany
-    {
-        return $this->hasMany(CustomField::class, 'subject_uuid')->orderBy('order');
-    }
-
-    public function customFieldValues(): HasMany
-    {
-        return $this->hasMany(CustomFieldValue::class, 'subject_uuid');
-    }
-
     public function drivers(): HasManyThrough
     {
         return $this->hasManyThrough(Driver::class, Entity::class, 'tracking_number_uuid', 'tracking_number_uuid');
@@ -1141,7 +1132,7 @@ class Order extends Model
      */
     public function firstDispatch(): Order
     {
-        if ($this->dispatched) {
+        if (!$this->dispatched) {
             $this->dispatch();
         }
 
@@ -1156,7 +1147,7 @@ class Order extends Model
      */
     public function firstDispatchWithActivity(): Order
     {
-        if ($this->dispatched) {
+        if (!$this->dispatched) {
             $this->dispatchWithActivity();
         }
 
@@ -1603,104 +1594,6 @@ class Order extends Model
         return (int) Utils::get($this, 'adhoc_distance', Utils::get($this, 'company.options.fleetops.adhoc_distance', 6000));
     }
 
-    /**
-     * Retrieves a custom field by its key.
-     *
-     * This method searches for a custom field where the name or label matches the given key.
-     *
-     * @param string $key the key used to search for the custom field
-     *
-     * @return CustomField|null the found CustomField object or null if not found
-     */
-    public function getCustomField(string $key): ?CustomField
-    {
-        $name         = Str::slug($key);
-        $label        = Str::title($key);
-
-        return $this->customFields()->where('name', $name)->orWhere('label', $label)->first();
-    }
-
-    /**
-     * Retrieves the custom field value for the specified custom field.
-     *
-     * @param CustomField $customField the custom field to retrieve the value for
-     *
-     * @return CustomFieldValue|null the custom field value, or null if not found
-     */
-    public function getCustomFieldValue(CustomField $customField): ?CustomFieldValue
-    {
-        $customFieldValue = $this->customFieldValues()->where('custom_field_uuid', $customField->uuid)->first();
-        if ($customFieldValue) {
-            return $customFieldValue;
-        }
-
-        return null;
-    }
-
-    /**
-     * Retrieves the value of a custom field by its key.
-     *
-     * @param string $key the key of the custom field
-     *
-     * @return mixed|null the value of the custom field, or null if not found
-     */
-    public function getCustomFieldValueByKey(string $key)
-    {
-        $customField = $this->getCustomField($key);
-        if ($customField) {
-            $customFieldValue = $this->getCustomFieldValue($customField);
-            if ($customFieldValue) {
-                return $customFieldValue->value;
-            }
-        }
-
-        return null;
-    }
-
-    /**
-     * Checks if a custom field exists.
-     *
-     * @param string $key the key of the custom field
-     */
-    public function isCustomField(string $key): bool
-    {
-        $name         = Str::slug($key);
-        $label        = Str::title($key);
-
-        return $this->customFields()->where('name', $name)->orWhere('label', $label)->exists();
-    }
-
-    /**
-     * Retrieves all custom field values associated with the order.
-     *
-     * @return array an array of custom field values
-     */
-    public function getCustomFieldValues(): array
-    {
-        $customFields = [];
-        foreach ($this->customFieldValues as $customFieldValue) {
-            $key = Str::snake(strtolower($customFieldValue->custom_field_label));
-            if ($key) {
-                $customFields[$key] = $customFieldValue->value;
-            }
-        }
-
-        return $customFields;
-    }
-
-    public function getCustomFieldKeys(): array
-    {
-        $keys = [];
-        foreach ($this->customFieldValues as $customFieldValue) {
-            $key = Str::snake(strtolower($customFieldValue->custom_field_label));
-            if ($key) {
-                $keys[] = $key;
-            }
-        }
-
-        return $keys;
-    }
-
     /**
      * Retrieves the OrderConfig associated with this order.
      *
@@ -1925,4 +1818,31 @@ class Order extends Model
 
         return $this->{$property};
     }
+
+    public function findClosestDrivers(int $distance = 6000): Collection
+    {
+        $pickup   = $this->getPickupLocation();
+        $distance = $distance;
+
+        if (!Utils::isPoint($pickup)) {
+            return collect();
+        }
+
+        $drivers = Driver::where(['status' => 'active', 'online' => 1])
+            ->whereHas('company', function ($q) {
+                $q->whereHas('users', function ($q) {
+                    $q->whereHas('driver', function ($q) {
+                        $q->where(['status' => 'active', 'online' => 1]);
+                        $q->whereNull('deleted_at');
+                    });
+                });
+            })
+            ->whereNull('deleted_at')
+            ->distanceSphere('location', $pickup, $distance)
+            ->distanceSphereValue('location', $pickup)
+            ->withoutGlobalScopes()
+            ->get();
+
+        return $drivers;
+    }
 }

package/server/src/Models/OrderConfig.php

@@ -368,6 +368,14 @@ class OrderConfig extends Model
         return collect();
     }
 
+    /**
+     * Gets an activity from the order config by it's code.
+     */
+    public function getActivityByCode(string $code): ?Activity
+    {
+        return $this->activities()->firstWhere('code', $code);
+    }
+
     /**
      * Creates an Activity instance representing a canceled order.
      *

package/server/src/Models/Part.php

@@ -0,0 +1,502 @@
+<?php
+
+namespace Fleetbase\FleetOps\Models;
+
+use Fleetbase\Casts\Json;
+use Fleetbase\FleetOps\Traits\Maintainable;
+use Fleetbase\Models\Alert;
+use Fleetbase\Models\File;
+use Fleetbase\Models\Model;
+use Fleetbase\Models\User;
+use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasMetaAttributes;
+use Fleetbase\Traits\HasPublicId;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\Searchable;
+use Fleetbase\Traits\TracksApiCredential;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
+use Spatie\Activitylog\LogOptions;
+use Spatie\Activitylog\Traits\LogsActivity;
+use Spatie\Sluggable\HasSlug;
+use Spatie\Sluggable\SlugOptions;
+
+/**
+ * Class Part.
+ *
+ * Represents a stocked, replaceable component in the fleet management system.
+ * Parts can include filters, tires, belts, and other components with quantity and cost tracking.
+ */
+class Part extends Model
+{
+    use HasUuid;
+    use HasPublicId;
+    use TracksApiCredential;
+    use Maintainable;
+    use HasApiModelBehavior;
+    use HasSlug;
+    use LogsActivity;
+    use HasMetaAttributes;
+    use Searchable;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'parts';
+
+    /**
+     * The type of public Id to generate.
+     *
+     * @var string
+     */
+    protected $publicIdType = 'part';
+
+    /**
+     * The attributes that can be queried.
+     *
+     * @var array
+     */
+    protected $searchableColumns = ['sku', 'name', 'manufacturer', 'model', 'serial_number', 'barcode', 'public_id'];
+
+    /**
+     * The attributes that can be used for filtering.
+     *
+     * @var array
+     */
+    protected $filterParams = ['vendor_uuid', 'manufacturer', 'status', 'asset_type', 'warranty_uuid'];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'company_uuid',
+        'vendor_uuid',
+        'warranty_uuid',
+        'photo_uuid',
+        'sku',
+        'name',
+        'manufacturer',
+        'model',
+        'serial_number',
+        'barcode',
+        'description',
+        'quantity_on_hand',
+        'unit_cost',
+        'msrp',
+        'asset_type',
+        'asset_uuid',
+        'type',
+        'status',
+        'specs',
+        'meta',
+        'slug',
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object.
+     *
+     * @var array
+     */
+    protected $appends = [
+        'vendor_name',
+        'warranty_name',
+        'photo_url',
+        'total_value',
+        'is_in_stock',
+        'is_low_stock',
+        'asset_name',
+    ];
+
+    /**
+     * The attributes excluded from the model's JSON form.
+     *
+     * @var array
+     */
+    protected $hidden = ['vendor', 'warranty', 'photo', 'asset'];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'quantity_on_hand' => 'integer',
+        'unit_cost'        => 'decimal:2',
+        'msrp'             => 'decimal:2',
+        'specs'            => Json::class,
+        'meta'             => Json::class,
+    ];
+
+    /**
+     * Properties which activity needs to be logged.
+     *
+     * @var array
+     */
+    protected static $logAttributes = '*';
+
+    /**
+     * Do not log empty changed.
+     *
+     * @var bool
+     */
+    protected static $submitEmptyLogs = false;
+
+    /**
+     * The name of the subject to log.
+     *
+     * @var string
+     */
+    protected static $logName = 'part';
+
+    /**
+     * Get the options for generating the slug.
+     */
+    public function getSlugOptions(): SlugOptions
+    {
+        return SlugOptions::create()
+            ->generateSlugsFrom(['name', 'sku'])
+            ->saveSlugsTo('slug');
+    }
+
+    /**
+     * Get the activity log options for the model.
+     */
+    public function getActivitylogOptions(): LogOptions
+    {
+        return LogOptions::defaults()->logAll();
+    }
+
+    public function vendor(): BelongsTo
+    {
+        return $this->belongsTo(Vendor::class, 'vendor_uuid', 'uuid');
+    }
+
+    public function warranty(): BelongsTo
+    {
+        return $this->belongsTo(Warranty::class, 'warranty_uuid', 'uuid');
+    }
+
+    public function photo(): BelongsTo
+    {
+        return $this->belongsTo(File::class, 'photo_uuid', 'uuid');
+    }
+
+    public function createdBy(): BelongsTo
+    {
+        return $this->belongsTo(User::class, 'created_by_uuid', 'uuid');
+    }
+
+    public function updatedBy(): BelongsTo
+    {
+        return $this->belongsTo(User::class, 'updated_by_uuid', 'uuid');
+    }
+
+    public function asset(): MorphTo
+    {
+        return $this->morphTo();
+    }
+
+    /**
+     * Get the vendor name.
+     */
+    public function getVendorNameAttribute(): ?string
+    {
+        return $this->vendor?->name;
+    }
+
+    /**
+     * Get the warranty name.
+     */
+    public function getWarrantyNameAttribute(): ?string
+    {
+        return $this->warranty?->name;
+    }
+
+    /**
+     * Get the photo URL.
+     */
+    public function getPhotoUrlAttribute(): ?string
+    {
+        return $this->photo?->url;
+    }
+
+    /**
+     * Get the total value of parts in stock.
+     */
+    public function getTotalValueAttribute(): float
+    {
+        return $this->quantity_on_hand * ($this->unit_cost ?? 0);
+    }
+
+    /**
+     * Check if the part is in stock.
+     */
+    public function getIsInStockAttribute(): bool
+    {
+        return $this->quantity_on_hand > 0;
+    }
+
+    /**
+     * Check if the part is low on stock.
+     */
+    public function getIsLowStockAttribute(): bool
+    {
+        $specs             = $this->specs ?? [];
+        $lowStockThreshold = $specs['low_stock_threshold'] ?? 5;
+
+        return $this->quantity_on_hand <= $lowStockThreshold;
+    }
+
+    /**
+     * Get the asset name if associated.
+     */
+    public function getAssetNameAttribute(): ?string
+    {
+        if ($this->asset) {
+            return $this->asset->name ?? $this->asset->display_name ?? null;
+        }
+
+        return null;
+    }
+
+    /**
+     * Scope to get parts in stock.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $query
+     *
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function scopeInStock($query)
+    {
+        return $query->where('quantity_on_hand', '>', 0);
+    }
+
+    /**
+     * Scope to get parts that are out of stock.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $query
+     *
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function scopeOutOfStock($query)
+    {
+        return $query->where('quantity_on_hand', '<=', 0);
+    }
+
+    /**
+     * Scope to get parts with low stock.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $query
+     *
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function scopeLowStock($query, ?int $threshold = null)
+    {
+        $threshold = $threshold ?? 5;
+
+        return $query->where('quantity_on_hand', '<=', $threshold)
+                    ->where('quantity_on_hand', '>', 0);
+    }
+
+    /**
+     * Scope to get parts by manufacturer.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $query
+     *
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function scopeByManufacturer($query, string $manufacturer)
+    {
+        return $query->where('manufacturer', $manufacturer);
+    }
+
+    /**
+     * Add stock to the part.
+     */
+    public function addStock(int $quantity, ?string $reason = null): bool
+    {
+        if ($quantity <= 0) {
+            return false;
+        }
+
+        $oldQuantity = $this->quantity_on_hand;
+        $newQuantity = $oldQuantity + $quantity;
+
+        $updated = $this->update(['quantity_on_hand' => $newQuantity]);
+
+        if ($updated) {
+            activity('stock_added')
+                ->performedOn($this)
+                ->withProperties([
+                    'old_quantity'   => $oldQuantity,
+                    'added_quantity' => $quantity,
+                    'new_quantity'   => $newQuantity,
+                    'reason'         => $reason,
+                ])
+                ->log("Added {$quantity} units to stock");
+        }
+
+        return $updated;
+    }
+
+    /**
+     * Remove stock from the part.
+     */
+    public function removeStock(int $quantity, ?string $reason = null): bool
+    {
+        if ($quantity <= 0 || $quantity > $this->quantity_on_hand) {
+            return false;
+        }
+
+        $oldQuantity = $this->quantity_on_hand;
+        $newQuantity = $oldQuantity - $quantity;
+
+        $updated = $this->update(['quantity_on_hand' => $newQuantity]);
+
+        if ($updated) {
+            activity('stock_removed')
+                ->performedOn($this)
+                ->withProperties([
+                    'old_quantity'     => $oldQuantity,
+                    'removed_quantity' => $quantity,
+                    'new_quantity'     => $newQuantity,
+                    'reason'           => $reason,
+                ])
+                ->log("Removed {$quantity} units from stock");
+
+            // Check if stock is now low and create alert if needed
+            if ($this->is_low_stock) {
+                $this->createLowStockAlert();
+            }
+        }
+
+        return $updated;
+    }
+
+    /**
+     * Set the stock quantity.
+     */
+    public function setStock(int $quantity, ?string $reason = null): bool
+    {
+        if ($quantity < 0) {
+            return false;
+        }
+
+        $oldQuantity = $this->quantity_on_hand;
+        $updated     = $this->update(['quantity_on_hand' => $quantity]);
+
+        if ($updated) {
+            activity('stock_adjusted')
+                ->performedOn($this)
+                ->withProperties([
+                    'old_quantity' => $oldQuantity,
+                    'new_quantity' => $quantity,
+                    'adjustment'   => $quantity - $oldQuantity,
+                    'reason'       => $reason,
+                ])
+                ->log("Stock adjusted from {$oldQuantity} to {$quantity}");
+        }
+
+        return $updated;
+    }
+
+    /**
+     * Create a low stock alert.
+     */
+    protected function createLowStockAlert(): void
+    {
+        // Check if there's already an open low stock alert
+        $existingAlert = Alert::where('subject_type', static::class)
+            ->where('subject_uuid', $this->uuid)
+            ->where('type', 'low_stock')
+            ->where('status', 'open')
+            ->first();
+
+        if (!$existingAlert) {
+            Alert::create([
+                'company_uuid' => $this->company_uuid,
+                'type'         => 'low_stock',
+                'severity'     => 'medium',
+                'status'       => 'open',
+                'subject_type' => static::class,
+                'subject_uuid' => $this->uuid,
+                'message'      => "Part '{$this->name}' (SKU: {$this->sku}) is low on stock ({$this->quantity_on_hand} remaining)",
+                'context'      => [
+                    'part_name'           => $this->name,
+                    'sku'                 => $this->sku,
+                    'current_quantity'    => $this->quantity_on_hand,
+                    'low_stock_threshold' => $this->specs['low_stock_threshold'] ?? 5,
+                ],
+                'triggered_at' => now(),
+            ]);
+        }
+    }
+
+    /**
+     * Check if the part is compatible with an asset.
+     */
+    public function isCompatibleWith(Asset $asset): bool
+    {
+        $specs            = $this->specs ?? [];
+        $compatibleAssets = $specs['compatible_assets'] ?? [];
+
+        if (empty($compatibleAssets)) {
+            return true; // No restrictions
+        }
+
+        // Check by asset type
+        if (in_array($asset->type, $compatibleAssets)) {
+            return true;
+        }
+
+        // Check by make/model
+        $assetIdentifier = $asset->make . ' ' . $asset->model;
+        if (in_array($assetIdentifier, $compatibleAssets)) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Get the reorder point for this part.
+     */
+    public function getReorderPoint(): int
+    {
+        $specs = $this->specs ?? [];
+
+        return $specs['reorder_point'] ?? $specs['low_stock_threshold'] ?? 5;
+    }
+
+    /**
+     * Get the reorder quantity for this part.
+     */
+    public function getReorderQuantity(): int
+    {
+        $specs = $this->specs ?? [];
+
+        return $specs['reorder_quantity'] ?? 10;
+    }
+
+    /**
+     * Check if the part needs to be reordered.
+     */
+    public function needsReorder(): bool
+    {
+        return $this->quantity_on_hand <= $this->getReorderPoint();
+    }
+
+    /**
+     * Get the estimated cost for a quantity of this part.
+     */
+    public function getEstimatedCost(int $quantity = 1, bool $useRetailPrice = false): float
+    {
+        $price = $useRetailPrice ? ($this->msrp ?? $this->unit_cost) : $this->unit_cost;
+
+        return $quantity * ($price ?? 0);
+    }
+}