@fleetbase/fleetops-engine 0.4.17 → 0.4.18

package/server/migrations/2024_03_12_033527_add_public_id_column_to_order_configs_table.php

@@ -0,0 +1,34 @@
+<?php
+
+use Fleetbase\FleetOps\Models\OrderConfig;
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class() extends Migration {
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::table('order_configs', function (Blueprint $table) {
+            $table->string('public_id')->nullable()->after('uuid')->index();
+        });
+
+        // Update order configs with a public id
+        $orderCofigs = OrderConfig::all();
+        foreach ($orderCofigs as $orderCofig) {
+            $orderCofig->update(['public_id' => OrderConfig::generatePublicId('order_config')]);
+        }
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::table('order_configs', function (Blueprint $table) {
+            $table->dropColumn('public_id');
+        });
+    }
+};

package/server/seeders/OrderConfigSeeder.php

@@ -2,10 +2,9 @@
 
 namespace Fleetbase\FleetOps\Seeders;
 
-use Fleetbase\FleetOps\Models\OrderConfig;
+use Fleetbase\FleetOps\Support\FleetOps;
 use Fleetbase\Models\Company;
 use Illuminate\Database\Seeder;
-use Illuminate\Support\Str;
 
 class OrderConfigSeeder extends Seeder
 {
@@ -18,134 +17,7 @@ class OrderConfigSeeder extends Seeder
     {
         $companies = Company::all();
         foreach ($companies as $company) {
-            static::createTransportConfig($company);
+            FleetOps::createTransportConfig($company);
         }
     }
-
-    /**
-     * 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/server/src/Http/Controllers/Api/v1/OrderController.php

@@ -15,6 +15,7 @@ use Fleetbase\FleetOps\Http\Resources\v1\Proof as ProofResource;
 use Fleetbase\FleetOps\Models\Driver;
 use Fleetbase\FleetOps\Models\Entity;
 use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Models\OrderConfig;
 use Fleetbase\FleetOps\Models\Payload;
 use Fleetbase\FleetOps\Models\Place;
 use Fleetbase\FleetOps\Models\Proof;
@@ -42,7 +43,17 @@ class OrderController extends Controller
     public function create(CreateOrderRequest $request)
     {
         // get request input
-        $input = $request->only(['internal_id', 'payload', 'service_quote', 'purchase_rate', 'adhoc', 'adhoc_distance', 'pod_method', 'pod_required', 'scheduled_at', 'type', 'status', 'meta', 'notes']);
+        $input = $request->only(['internal_id', 'payload', 'service_quote', 'purchase_rate', 'adhoc', 'adhoc_distance', 'pod_method', 'pod_required', 'scheduled_at', 'status', 'meta', 'notes']);
+
+        // Get order config
+        $orderConfig = OrderConfig::resolveFromIdentifier($request->only(['type', 'order_config']));
+        if (!$orderConfig) {
+            return response()->apiError('Invalid order `type` or `order_config` provided.');
+        }
+
+        // Set order config to input
+        $input['order_config_uuid'] = $orderConfig->uuid;
+        $input['type']              = $orderConfig->key;
 
         // make sure company is set
         $input['company_uuid'] = session('company');
@@ -965,9 +976,20 @@ class OrderController extends Controller
             );
         }
 
-        $activity = $order->config()->nextActivity();
+        $activities = $order->config()->nextActivity();
+
+        // If activity is to complete order add proof of delivery properties if required
+        // This is a temporary fix until activity is updated to handle POD on it's own
+        $activities = $activities->map(function ($activity) use ($order) {
+            if ($activity->completesOrder() && $order->pod_required) {
+                $activity->set('require_pod', true);
+                $activity->set('pod_method', $order->pod_method);
+            }
+
+            return $activity;
+        });
 
-        return response()->json($activity);
+        return response()->json($activities);
     }
 
     /**

package/server/src/Http/Controllers/Internal/v1/OrderConfigController.php

@@ -2,7 +2,12 @@
 
 namespace Fleetbase\FleetOps\Http\Controllers\Internal\v1;
 
+use Fleetbase\Exceptions\FleetbaseRequestValidationException;
 use Fleetbase\FleetOps\Http\Controllers\FleetOpsController;
+use Fleetbase\FleetOps\Http\Requests\Internal\CreateOrderConfigRequest;
+use Fleetbase\FleetOps\Models\OrderConfig;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Validator;
 
 class OrderConfigController extends FleetOpsController
 {
@@ -12,4 +17,60 @@ class OrderConfigController extends FleetOpsController
      * @var string
      */
     public $resource = 'order-config';
+
+    /**
+     * Creates a record with request payload.
+     *
+     * @return \Illuminate\Http\Response
+     */
+    public function createRecord(Request $request)
+    {
+        // Create validation request
+        $createOrderRequest  = CreateOrderConfigRequest::createFrom($request);
+        $rules               = $createOrderRequest->rules();
+
+        // Manually validate request
+        $validator = Validator::make($request->input('orderConfig'), $rules);
+        if ($validator->fails()) {
+            return $createOrderRequest->responseWithErrors($validator);
+        }
+
+        try {
+            $record = $this->model->createRecordFromRequest($request);
+
+            return ['order_config' => new $this->resource($record)];
+        } catch (\Exception $e) {
+            return response()->error($e->getMessage());
+        } catch (\Illuminate\Database\QueryException $e) {
+            return response()->error($e->getMessage());
+        } catch (FleetbaseRequestValidationException $e) {
+            return response()->error($e->getErrors());
+        }
+    }
+
+    /**
+     * Delete's an order config.
+     *
+     * @return \Illuminate\Http\Response
+     */
+    public function deleteRecord($id, Request $request)
+    {
+        $orderConfig = OrderConfig::where('uuid', $id)->first();
+        if (!$orderConfig) {
+            return response()->error('No order config found.');
+        }
+
+        // `core_service` order configs cannot be deleted
+        if ($orderConfig->core_service) {
+            return response()->error('Core service order config\'s cannot be deleted.');
+        }
+
+        if ($orderConfig) {
+            $orderConfig->delete();
+
+            $this->resource::wrap($this->resourceSingularlName);
+
+            return new $this->resource($orderConfig);
+        }
+    }
 }

package/server/src/Http/Controllers/Internal/v1/OrderController.php

@@ -9,6 +9,7 @@ use Fleetbase\FleetOps\Events\OrderStarted;
 use Fleetbase\FleetOps\Flow\Activity;
 use Fleetbase\FleetOps\Http\Controllers\FleetOpsController;
 use Fleetbase\FleetOps\Http\Requests\CancelOrderRequest;
+use Fleetbase\FleetOps\Http\Requests\Internal\CreateOrderRequest;
 use Fleetbase\FleetOps\Imports\OrdersImport;
 use Fleetbase\FleetOps\Models\Driver;
 use Fleetbase\FleetOps\Models\Entity;
@@ -25,6 +26,7 @@ use Fleetbase\Models\File;
 use Fleetbase\Models\Type;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Validator;
 use Illuminate\Support\Str;
 use Maatwebsite\Excel\Facades\Excel;
 
@@ -44,9 +46,17 @@ class OrderController extends FleetOpsController
      */
     public function createRecord(Request $request)
     {
-        try {
-            $this->validateRequest($request);
+        // Create validation request
+        $createOrderRequest  = CreateOrderRequest::createFrom($request);
+        $rules               = $createOrderRequest->rules();
+
+        // Manually validate request
+        $validator = Validator::make($request->input('order'), $rules);
+        if ($validator->fails()) {
+            return $createOrderRequest->responseWithErrors($validator);
+        }
 
+        try {
             $record = $this->model->createRecordFromRequest(
                 $request,
                 function ($request, &$input) {

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,66 @@
+<?php
+
+namespace Fleetbase\FleetOps\Http\Requests\Internal;
+
+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'             => '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,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',
+        ];
+
+        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;
+    }
+}

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/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/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,
     ];
 
     /**