@fleetbase/fleetops-engine 0.4.17 → 0.4.19

package/server/src/Http/Requests/CreateOrderRequest.php

@@ -2,6 +2,7 @@
 
 namespace Fleetbase\FleetOps\Http\Requests;
 
+use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Http\Requests\FleetbaseRequest;
 use Fleetbase\Rules\ExistsInAny;
 
@@ -25,21 +26,26 @@ class CreateOrderRequest extends FleetbaseRequest
     public function rules()
     {
         $validations = [
-            'adhoc'          => 'in:true,false,1,0',
-            'dispatch'       => ['nullable', 'boolean'],
-            'adhoc_distance' => 'numeric',
-            'pod_required'   => 'in:true,false,1,0',
-            'pod_method'     => 'in:' . config('api.pod_methods'),
-            'scheduled_at'   => ['nullable', 'date'],
-            'driver'         => 'nullable|exists:drivers,public_id',
-            'service_quote'  => 'nullable|exists:service_quotes,public_id',
-            'purchase_rate'  => 'nullable|exists:purchase_rates,public_id',
-            'facilitator'    => ['nullable', new ExistsInAny(['vendors', 'contacts', 'integrated_vendors'], ['public_id', 'provider'])],
-            'customer'       => ['nullable', new ExistsInAny(['vendors', 'contacts'], 'public_id')],
-            'status'         => 'string',
-            'type'           => 'string',
+            'adhoc'             => ['nullable', 'boolean'],
+            'dispatch'          => ['nullable', 'boolean'],
+            'adhoc_distance'    => ['nullable', 'numeric'],
+            'pod_required'      => ['nullable', 'boolean'],
+            'pod_method'        => ['nullable', 'in:' . config('fleetops.pod_methods')],
+            'scheduled_at'      => ['nullable', 'date'],
+            'driver'            => ['nullable', 'exists:drivers,public_id'],
+            'service_quote'     => ['nullable', 'exists:service_quotes,public_id'],
+            'purchase_rate'     => ['nullable', 'exists:purchase_rates,public_id'],
+            'facilitator'       => ['nullable', new ExistsInAny(['vendors', 'contacts', 'integrated_vendors'], ['public_id', 'provider'])],
+            'customer'          => ['nullable', new ExistsInAny(['vendors', 'contacts'], 'public_id')],
+            'status'            => ['nullable', 'string'],
+            'type'              => ['string'],
         ];
 
+        // Conditionally require 'pod_method' if 'pod_required' is truthy
+        if (Utils::isTrue($this->input('pod_required'))) {
+            $validations['pod_method'] = ['required', 'in:' . implode(',', config('fleetops.pod_methods'))];
+        }
+
         if ($this->has('payload')) {
             $validations['payload.entities']  = 'array';
             $validations['payload.waypoints'] = 'array';
@@ -77,4 +83,17 @@ class CreateOrderRequest extends FleetbaseRequest
 
         return $validations;
     }
+
+    /**
+     * Get custom attributes for validator errors.
+     *
+     * @return array<string, string>
+     */
+    public function attributes(): array
+    {
+        return [
+            'pod_required' => 'proof of delivery required',
+            'pod_method'   => 'proof of delivery method',
+        ];
+    }
 }

package/server/src/Http/Requests/Internal/CreateOrderConfigRequest.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Fleetbase\FleetOps\Http\Requests\Internal;
+
+use Fleetbase\Http\Requests\FleetbaseRequest;
+use Illuminate\Validation\Rule;
+
+class CreateOrderConfigRequest extends FleetbaseRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+    public function authorize()
+    {
+        return request()->session()->has('company');
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array
+     */
+    public function rules()
+    {
+        return [
+            'name' => [
+                'required',
+                Rule::unique('order_configs', 'name')
+                    ->where('company_uuid', request()->session()->get('company'))->whereNull('deleted_at'),
+            ],
+            'key' => [
+                'required',
+                Rule::unique('order_configs', 'key')
+                    ->where('company_uuid', request()->session()->get('company'))->whereNull('deleted_at'),
+            ],
+        ];
+    }
+}

package/server/src/Http/Requests/Internal/CreateOrderRequest.php

@@ -0,0 +1,97 @@
+<?php
+
+namespace Fleetbase\FleetOps\Http\Requests\Internal;
+
+use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\Http\Requests\FleetbaseRequest;
+use Fleetbase\Rules\ExistsInAny;
+
+class CreateOrderRequest extends FleetbaseRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+    public function authorize()
+    {
+        return request()->session()->has('company');
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array
+     */
+    public function rules()
+    {
+        $validations = [
+            'order_config_uuid' => ['required'],
+            'adhoc'             => ['nullable', 'boolean'],
+            'dispatch'          => ['nullable', 'boolean'],
+            'adhoc_distance'    => ['nullable', 'numeric'],
+            'pod_required'      => ['nullable', 'boolean'],
+            'pod_method'        => ['nullable', 'in:' . config('fleetops.pod_methods')],
+            'scheduled_at'      => ['nullable', 'date'],
+            'driver'            => ['nullable', 'exists:drivers,uuid'],
+            'service_quote'     => ['nullable', 'exists:service_quotes,uuid'],
+            'purchase_rate'     => ['nullable', 'exists:purchase_rates,uuid'],
+            'facilitator'       => ['nullable', new ExistsInAny(['vendors', 'contacts', 'integrated_vendors'], ['uuid', 'provider'])],
+            'customer'          => ['nullable', new ExistsInAny(['vendors', 'contacts'], 'uuid')],
+            'status'            => ['nullable', 'string'],
+            'type'              => ['string'],
+        ];
+
+        // Conditionally require 'pod_method' if 'pod_required' is truthy
+        if (Utils::isTrue($this->input('order.pod_required'))) {
+            $validations['pod_method'] = ['required', 'in:' . config('fleetops.pod_methods')];
+        }
+
+        if ($this->has('payload')) {
+            $validations['payload.entities']  = 'array';
+            $validations['payload.waypoints'] = 'array';
+
+            if ($this->isArray('payload')) {
+                $validations['payload']         = 'required';
+
+                if ($this->missing('payload.waypoints')) {
+                    $validations['payload.pickup_uuid']  = 'required';
+                    $validations['payload.dropoff_uuid'] = 'required';
+                }
+
+                if ($this->missing(['payload.pickup', 'payload.dropoff'])) {
+                    $validations['payload.waypoints'] = 'required|array|min:2';
+                }
+
+                $validations['payload.return_uuid']  = 'nullable';
+            }
+        }
+
+        return $validations;
+    }
+
+    /**
+     * Get the error messages for the defined validation rules.
+     *
+     * @return array<string, string>
+     */
+    public function messages(): array
+    {
+        return [
+            'pod_method.required'   => 'A proof of delivery method is required.',
+        ];
+    }
+
+    /**
+     * Get custom attributes for validator errors.
+     *
+     * @return array<string, string>
+     */
+    public function attributes(): array
+    {
+        return [
+            'pod_required' => 'proof of delivery required',
+            'pod_method'   => 'proof of delivery method',
+        ];
+    }
+}

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

@@ -39,7 +39,7 @@ class Order extends FleetbaseResource
             'service_quote_uuid'   => $this->when(Http::isInternalRequest(), $this->service_quote_uuid),
             'has_driver_assigned'  => $this->when(Http::isInternalRequest(), $this->has_driver_assigned),
             'is_scheduled'         => $this->when(Http::isInternalRequest(), $this->is_scheduled),
-            'order_config'         => $this->when(Http::isInternalRequest(), $this->whenLoaded('orderConfig', $this->orderConfig)),
+            'order_config'         => $this->when(Http::isInternalRequest(), $this->whenLoaded('orderConfig', $this->orderConfig), data_get($this->orderConfig, 'public_id')),
             'custom_field_values'  => $this->when(Http::isInternalRequest(), $this->customFieldValues),
             'customer'             => $this->setCustomerType(Resolve::resourceForMorph($this->customer_type, $this->customer_uuid)),
             'payload'              => new Payload($this->payload),

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

@@ -18,37 +18,40 @@ class ServiceRate extends FleetbaseResource
     public function toArray($request)
     {
         return [
-            'id'                            => $this->when(Http::isInternalRequest(), $this->id, $this->public_id),
-            'uuid'                          => $this->when(Http::isInternalRequest(), $this->uuid),
-            'public_id'                     => $this->when(Http::isInternalRequest(), $this->public_id),
-            'service_area'                  => $this->whenLoaded('serviceArea', new ServiceArea($this->serviceArea)),
-            'service_area_name'             => $this->when(Http::isInternalRequest(), data_get($this, 'serviceArea.name')),
-            'zone'                          => $this->whenLoaded('zone', new Zone($this->zone)),
-            'zone_name'                     => $this->when(Http::isInternalRequest(), data_get($this, 'zone.name')),
-            'service_name'                  => $this->service_name,
-            'service_type'                  => $this->service_type,
-            'base_fee'                      => $this->base_fee,
-            'rate_calculation_method'       => $this->rate_calculation_method,
-            'per_meter_flat_rate_fee'       => $this->per_meter_flat_rate_fee,
-            'per_meter_unit'                => $this->per_meter_unit,
-            'meter_fees'                    => ServiceRateFee::collection($this->rateFees ?? []),
-            'parcel_fees'                   => ServiceRateParcelFee::collection($this->rateFees ?? []),
-            'algorithm'                     => $this->algorithm,
-            'has_cod_fee'                   => Utils::castBoolean($this->has_cod_fee),
-            'cod_calculation_method'        => $this->cod_calculation_method,
-            'cod_flat_fee'                  => $this->cod_flat_fee,
-            'cod_percent'                   => $this->cod_percent,
-            'has_peak_hours_fee'            => Utils::castBoolean($this->has_peak_hours_fee),
-            'peak_hours_calculation_method' => $this->peak_hours_calculation_method,
-            'peak_hours_flat_fee'           => $this->peak_hours_flat_fee,
-            'peak_hours_percent'            => $this->peak_hours_percent,
-            'peak_hours_start'              => $this->peak_hours_start,
-            'peak_hours_end'                => $this->peak_hours_end,
-            'currency'                      => $this->currency,
-            'duration_terms'                => $this->duration_terms,
-            'estimated_days'                => $this->estimated_days,
-            'updated_at'                    => $this->updated_at,
-            'created_at'                    => $this->created_at,
+            'id'                                         => $this->when(Http::isInternalRequest(), $this->id, $this->public_id),
+            'uuid'                                       => $this->when(Http::isInternalRequest(), $this->uuid),
+            'service_area_uuid'                          => $this->when(Http::isInternalRequest(), $this->service_area_uuid),
+            'zone_uuid'                                  => $this->when(Http::isInternalRequest(), $this->zone_uuid),
+            'order_config_uuid'                          => $this->when(Http::isInternalRequest(), $this->order_config_uuid),
+            'public_id'                                  => $this->when(Http::isInternalRequest(), $this->public_id),
+            'service_area'                               => $this->whenLoaded('serviceArea', new ServiceArea($this->serviceArea)),
+            'service_area_name'                          => $this->when(Http::isInternalRequest(), data_get($this, 'serviceArea.name')),
+            'zone'                                       => $this->whenLoaded('zone', new Zone($this->zone)),
+            'zone_name'                                  => $this->when(Http::isInternalRequest(), data_get($this, 'zone.name')),
+            'service_name'                               => $this->service_name,
+            'service_type'                               => $this->service_type,
+            'base_fee'                                   => $this->base_fee,
+            'rate_calculation_method'                    => $this->rate_calculation_method,
+            'per_meter_flat_rate_fee'                    => $this->per_meter_flat_rate_fee,
+            'per_meter_unit'                             => $this->per_meter_unit,
+            'meter_fees'                                 => ServiceRateFee::collection($this->rateFees ?? []),
+            'parcel_fees'                                => ServiceRateParcelFee::collection($this->rateFees ?? []),
+            'algorithm'                                  => $this->algorithm,
+            'has_cod_fee'                                => Utils::castBoolean($this->has_cod_fee),
+            'cod_calculation_method'                     => $this->cod_calculation_method,
+            'cod_flat_fee'                               => $this->cod_flat_fee,
+            'cod_percent'                                => $this->cod_percent,
+            'has_peak_hours_fee'                         => Utils::castBoolean($this->has_peak_hours_fee),
+            'peak_hours_calculation_method'              => $this->peak_hours_calculation_method,
+            'peak_hours_flat_fee'                        => $this->peak_hours_flat_fee,
+            'peak_hours_percent'                         => $this->peak_hours_percent,
+            'peak_hours_start'                           => $this->peak_hours_start,
+            'peak_hours_end'                             => $this->peak_hours_end,
+            'currency'                                   => $this->currency,
+            'duration_terms'                             => $this->duration_terms,
+            'estimated_days'                             => $this->estimated_days,
+            'updated_at'                                 => $this->updated_at,
+            'created_at'                                 => $this->created_at,
         ];
     }
 

package/server/src/Models/OrderConfig.php

@@ -5,10 +5,12 @@ namespace Fleetbase\FleetOps\Models;
 use Fleetbase\Casts\Json;
 use Fleetbase\FleetOps\Casts\OrderConfigEntities;
 use Fleetbase\FleetOps\Flow\Activity;
+use Fleetbase\Models\Company;
 use Fleetbase\Models\Model;
 use Fleetbase\Support\Auth;
 use Fleetbase\Traits\HasApiModelBehavior;
 use Fleetbase\Traits\HasMetaAttributes;
+use Fleetbase\Traits\HasPublicId;
 use Fleetbase\Traits\HasUuid;
 use Fleetbase\Traits\Searchable;
 use Illuminate\Support\Collection;
@@ -17,6 +19,7 @@ use Illuminate\Support\Str;
 class OrderConfig extends Model
 {
     use HasUuid;
+    use HasPublicId;
     use Searchable;
     use HasMetaAttributes;
     use HasApiModelBehavior;
@@ -28,6 +31,13 @@ class OrderConfig extends Model
      */
     protected $table = 'order_configs';
 
+    /**
+     * The type of public Id to generate.
+     *
+     * @var string
+     */
+    protected $publicIdType = 'order_config';
+
     /**
      * These attributes that can be queried.
      *
@@ -41,6 +51,7 @@ class OrderConfig extends Model
      * @var array
      */
     protected $fillable = [
+        'public_id',
         'company_uuid',
         'author_uuid',
         'category_uuid',
@@ -416,4 +427,41 @@ class OrderConfig extends Model
             'complete' => false,
         ], $this->flow);
     }
+
+    /**
+     * Resolves an OrderConfig from a given identifier or an array of identifiers within an optional company context.
+     *
+     * @param string|array $orderConfigIdentifier the identifier(s) for the OrderConfig (namespace, public_id, or key)
+     * @param Company|null $company               the company context, if any, to narrow down the search
+     *
+     * @return OrderConfig|null the found OrderConfig or null if none found
+     */
+    public static function resolveFromIdentifier($orderConfigIdentifier, ?Company $company = null): ?OrderConfig
+    {
+        $query = static::query();
+
+        if ($company instanceof Company) {
+            $query->where('company_uuid', $company->uuid);
+        } else {
+            $companyUuid = session('company');
+            if ($companyUuid) {
+                $query->where('company_uuid', $companyUuid);
+            }
+        }
+
+        $identifiers = is_array($orderConfigIdentifier) ? $orderConfigIdentifier : [$orderConfigIdentifier];
+        foreach ($identifiers as $identifier) {
+            $orderConfig = $query->where(function ($query) use ($identifier) {
+                $query->where('namespace', $identifier)
+                      ->orWhere('public_id', $identifier)
+                      ->orWhere('key', $identifier);
+            })->first();
+
+            if ($orderConfig) {
+                return $orderConfig;
+            }
+        }
+
+        return null;
+    }
 }

package/server/src/Models/ServiceRate.php

@@ -53,6 +53,7 @@ class ServiceRate extends Model
         'company_uuid',
         'service_area_uuid',
         'zone_uuid',
+        'order_config_uuid',
         'service_name',
         'service_type',
         'per_meter_flat_rate_fee',
@@ -124,6 +125,14 @@ class ServiceRate extends Model
         return $this->hasMany(ServiceRateParcelFee::class);
     }
 
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function orderConfig()
+    {
+        return $this->belongsTo(OrderConfig::class)->withTrashed();
+    }
+
     /**
      * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */

package/server/src/Observers/CompanyObserver.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Fleetbase\FleetOps\Observers;
+
+use Fleetbase\FleetOps\Support\FleetOps;
+use Fleetbase\Models\Company;
+
+class CompanyObserver
+{
+    /**
+     * Handle the Company "created" event.
+     *
+     * @return void
+     */
+    public function created(Company $company)
+    {
+        // Add the default transport order config
+        FleetOps::createTransportConfig($company);
+    }
+}

package/server/src/Providers/FleetOpsServiceProvider.php

@@ -34,6 +34,7 @@ class FleetOpsServiceProvider extends CoreServiceProvider
         \Fleetbase\FleetOps\Models\Vehicle::class        => \Fleetbase\FleetOps\Observers\VehicleObserver::class,
         \Fleetbase\FleetOps\Models\Fleet::class          => \Fleetbase\FleetOps\Observers\FleetObserver::class,
         \Fleetbase\Models\User::class                    => \Fleetbase\FleetOps\Observers\UserObserver::class,
+        \Fleetbase\Models\Company::class                 => \Fleetbase\FleetOps\Observers\CompanyObserver::class,
     ];
 
     /**

package/server/src/Support/FleetOps.php

@@ -0,0 +1,137 @@
+<?php
+
+namespace Fleetbase\FleetOps\Support;
+
+use Fleetbase\FleetOps\Models\OrderConfig;
+use Fleetbase\Models\Company;
+use Illuminate\Support\Str;
+
+class FleetOps
+{
+    /**
+     * Creates or retrieves an existing transport configuration for a given company.
+     *
+     * This method attempts to find a transport configuration (`OrderConfig`) for the specified company.
+     * If such a configuration exists, it's returned. Otherwise, a new configuration is created with default values,
+     * such as the company UUID, key, core service flag, status, version, tags, and predefined workflow steps.
+     * These steps include 'created', 'enroute', 'started', 'completed', and 'dispatched', each with specific attributes.
+     *
+     * @param Company $company the company for which the transport configuration is being created or retrieved
+     *
+     * @return OrderConfig the transport configuration associated with the specified company
+     */
+    public static function createTransportConfig(Company $company): OrderConfig
+    {
+        return OrderConfig::firstOrCreate(
+            [
+            'company_uuid' => $company->uuid,
+            'key'          => 'transport',
+            'namespace'    => 'system:order-config:transport',
+        ],
+            [
+            'name'         => 'Transport',
+            'key'          => 'transport',
+            'namespace'    => 'system:order-config:transport',
+            'description'  => 'Default order configuration for transport',
+            'core_service' => 1,
+            'status'       => 'private',
+            'version'      => '0.0.1',
+            'tags'         => ['transport', 'delivery'],
+            'entities'     => [],
+            'meta'         => [],
+            'flow'         => [
+                'created' => [
+                    'key'         => 'created',
+                    'code'        => 'created',
+                    'color'       => '#1f2937',
+                    'logic'       => [],
+                    'events'      => [],
+                    'status'      => 'Order Created',
+                    'actions'     => [],
+                    'details'     => 'New order was created.',
+                    'options'     => [],
+                    'complete'    => false,
+                    'entities'    => [],
+                    'sequence'    => 0,
+                    'activities'  => ['dispatched'],
+                    'internalId'  => Str::uuid(),
+                    'pod_method'  => 'scan',
+                    'require_pod' => false,
+                ],
+                'enroute' => [
+                    'key'         => 'enroute',
+                    'code'        => 'enroute',
+                    'color'       => '#1f2937',
+                    'logic'       => [],
+                    'events'      => [],
+                    'status'      => 'Driver Enroute',
+                    'actions'     => [],
+                    'details'     => 'Driver is en-route.',
+                    'options'     => [],
+                    'complete'    => false,
+                    'entities'    => [],
+                    'sequence'    => 0,
+                    'activities'  => ['completed'],
+                    'internalId'  => Str::uuid(),
+                    'pod_method'  => 'scan',
+                    'require_pod' => false,
+                ],
+                'started' => [
+                    'key'         => 'started',
+                    'code'        => 'started',
+                    'color'       => '#1f2937',
+                    'logic'       => [],
+                    'events'      => [],
+                    'status'      => 'Order Started',
+                    'actions'     => [],
+                    'details'     => 'Order has been started',
+                    'options'     => [],
+                    'complete'    => false,
+                    'entities'    => [],
+                    'sequence'    => 0,
+                    'activities'  => ['enroute'],
+                    'internalId'  => Str::uuid(),
+                    'pod_method'  => 'scan',
+                    'require_pod' => false,
+                ],
+                'completed' => [
+                    'key'         => 'completed',
+                    'code'        => 'completed',
+                    'color'       => '#1f2937',
+                    'logic'       => [],
+                    'events'      => [],
+                    'status'      => 'Order Completed',
+                    'actions'     => [],
+                    'details'     => 'Order has been completed.',
+                    'options'     => [],
+                    'complete'    => true,
+                    'entities'    => [],
+                    'sequence'    => 0,
+                    'activities'  => [],
+                    'internalId'  => Str::uuid(),
+                    'pod_method'  => 'scan',
+                    'require_pod' => false,
+                ],
+                'dispatched' => [
+                    'key'         => 'dispatched',
+                    'code'        => 'dispatched',
+                    'color'       => '#1f2937',
+                    'logic'       => [],
+                    'events'      => [],
+                    'status'      => 'Order Dispatched',
+                    'actions'     => [],
+                    'details'     => 'Order has been dispatched.',
+                    'options'     => [],
+                    'complete'    => false,
+                    'entities'    => [],
+                    'sequence'    => 0,
+                    'activities'  => ['started'],
+                    'internalId'  => Str::uuid(),
+                    'pod_method'  => 'scan',
+                    'require_pod' => false,
+                ],
+            ],
+        ]
+        );
+    }
+}

package/translations/en-us.yaml

@@ -139,6 +139,11 @@ fleet-ops:
       code: Code
       status: Status
       details: Details
+      proof-of-delivery: Proof of Delivery
+      require-pod: Requires Proof of Delivery
+      require-pod-help-text: This activity requires a proof to be created before it can be applied to the order.
+      select-pod-method: Proof of Delivery Method
+      pod-method-placeholder: Select Proof of Delivery Method
       completes-order: Completes Order
       complete: Complete
       key-help: "Enter a key used for programmatic decision-making. This key can represent one or several activities with the same identifier. Note: This key is not required to be unique."
@@ -1406,7 +1411,7 @@ fleet-ops:
           service-name: Service Name
           service-name-help-text: Display name for this service.
           service-order-label: Service Order Type
-          service-order-help-text: Restrict this service rate to an explicit `order type`.
+          service-order-help-text: Select an order configuration to which this service rate will be exclusively applied. This ensures that only orders created with the selected order configuration can utilize this specific service rate.
           service-order-placeholder: Select order type to restrict service to
           base-fee-label: Base Fee
           base-fee-help-text: Set a base fee which represents the minimum cost for this serice.