@fleetbase/fleetops-engine 0.4.17 → 0.4.19

package/server/config/fleetops.php

@@ -2,10 +2,15 @@
 
 /**
  * -------------------------------------------
- * Fleetbase Core API Configuration
+ * FleetOps API Configuration
  * -------------------------------------------
  */
 return [
+    /*
+    |--------------------------------------------------------------------------
+    | API Config
+    |--------------------------------------------------------------------------
+    */
     'api' => [
         'version' => '0.0.1',
         'routing' => [
@@ -13,10 +18,128 @@ return [
             'internal_prefix' => 'int'
         ]
     ],
+    'connection' => [
+        'db' => env('DB_CONNECTION', 'mysql')
+    ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Navigator App
+    |--------------------------------------------------------------------------
+    */
     'navigator' => [
         'bypass_verification_code' => env('NAVIGATOR_BYPASS_VERIFICATION_CODE', '999000')
     ],
-    'connection' => [
-        'db' => env('DB_CONNECTION', 'mysql')
-    ]
+
+    /*
+    |--------------------------------------------------------------------------
+    | API Events
+    |--------------------------------------------------------------------------
+    */
+    'events' => [
+        // order events
+        'order.created',
+        'order.updated',
+        'order.deleted',
+        'order.dispatched',
+        'order.dispatch_failed',
+        'order.completed',
+        'order.failed',
+        'order.driver_assigned',
+        'order.completed',
+
+        // payload events
+        'payload.created',
+        'payload.updated',
+        'payload.deleted',
+
+        // entity events
+        'entity.created',
+        'entity.updated',
+        'entity.deleted',
+        'entity.driver_assigned',
+
+        // driver events
+        'driver.created',
+        'driver.updated',
+        'driver.deleted',
+        'driver.assigned',
+        // 'driver.entered_zone',
+        // 'driver.exited_zone',
+
+        // fleet events
+        'fleet.created',
+        'fleet.updated',
+        'fleet.deleted',
+
+        // purchase_rate events
+        'purchase_rate.created',
+        'purchase_rate.updated',
+        'purchase_rate.deleted',
+
+        // contact events
+        'contact.created',
+        'contact.updated',
+        'contact.deleted',
+
+        // place events
+        'place.created',
+        'place.updated',
+        'place.deleted',
+
+        // service_area events
+        'service_area.created',
+        'service_area.updated',
+        'service_area.deleted',
+
+        // service_quote events
+        'service_quote.created',
+        'service_quote.updated',
+        'service_quote.deleted',
+
+        // service_rate events
+        'service_rate.created',
+        'service_rate.updated',
+        'service_rate.deleted',
+
+        // tracking_number events
+        'tracking_number.created',
+        'tracking_number.updated',
+        'tracking_number.deleted',
+
+        // tracking_status events
+        'tracking_status.created',
+        'tracking_status.updated',
+        'tracking_status.deleted',
+
+        // vehicle events
+        'vehicle.created',
+        'vehicle.updated',
+        'vehicle.deleted',
+
+        // vendor events
+        'vendor.created',
+        'vendor.updated',
+        'vendor.deleted',
+
+        // zone events
+        'zone.created',
+        'zone.updated',
+        'zone.deleted',
+    ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Proof of Delivery Methods
+    |--------------------------------------------------------------------------
+    */
+    'pod_methods' => 'scan,signature,photo',
+
+    /*
+    |--------------------------------------------------------------------------
+    | API/Webhook Versions
+    |--------------------------------------------------------------------------
+    */
+    'versions' => ['2020-09-30', '2024-03-12'],
+    'version' => '2024-03-12',
 ];

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/migrations/2024_03_13_061249_add_order_config_uuid_column_to_service_rates_table.php

@@ -0,0 +1,28 @@
+<?php
+
+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('service_rates', function (Blueprint $table) {
+            $table->foreignUuid('order_config_uuid')->nullable()->after('zone_uuid')->references('uuid')->on('order_configs')->onUpdate('CASCADE')->onDelete('CASCADE');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::table('service_rates', function (Blueprint $table) {
+            $table->dropForeign(['order_config_uuid']);
+            $table->dropColumn(['order_config_uuid']);
+        });
+    }
+};

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/Console/Commands/FixLegacyOrderConfigs.php

@@ -4,9 +4,9 @@ namespace Fleetbase\FleetOps\Console\Commands;
 
 use Fleetbase\FleetOps\Models\Order;
 use Fleetbase\FleetOps\Models\OrderConfig;
-use Fleetbase\Support\Utils;
+use Fleetbase\FleetOps\Support\FleetOps;
+use Fleetbase\Models\Company;
 use Illuminate\Console\Command;
-use Illuminate\Support\Facades\Artisan;
 
 class FixLegacyOrderConfigs extends Command
 {
@@ -15,7 +15,7 @@ class FixLegacyOrderConfigs extends Command
      *
      * @var string
      */
-    protected $signature = 'fleetops:fix-legacy-order-configs';
+    protected $signature = 'fleetops:fix-legacy-order-configs {--create-configs}';
 
     /**
      * The console command description.
@@ -35,14 +35,20 @@ class FixLegacyOrderConfigs extends Command
      */
     public function handle()
     {
-        if (Utils::classExists('\\Fleetbase\\FleetOps\\Seeders\\OrderConfigSeeder')) {
-            $this->info('Starting the database seeding...');
-
-            Artisan::call('db:seed', [
-                '--class' => '\\Fleetbase\\FleetOps\\Seeders\\OrderConfigSeeder',
-            ]);
-
-            $this->info('Database seeding completed.');
+        $shouldCreateConfigs = $this->option('create-configs');
+        if ($shouldCreateConfigs) {
+            $companies      = Company::all();
+            $totalCompanies = $companies->count();
+            $this->info('Initializing transport config for ' . $totalCompanies . ' companies.');
+            $progressBar = $this->output->createProgressBar($totalCompanies);
+            $progressBar->start();
+            foreach ($companies as $company) {
+                FleetOps::createTransportConfig($company);
+                $progressBar->advance();
+            }
+            $progressBar->finish();
+            $this->line('');
+            $this->info('All transport configs created.');
         }
 
         $orders      = Order::whereNull('order_config_uuid')->get();

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/Api/v1/ServiceQuoteController.php

@@ -4,6 +4,7 @@ namespace Fleetbase\FleetOps\Http\Controllers\Api\v1;
 
 use Fleetbase\FleetOps\Http\Requests\QueryServiceQuotesRequest;
 use Fleetbase\FleetOps\Http\Resources\v1\ServiceQuote as ServiceQuoteResource;
+use Fleetbase\FleetOps\Models\Entity;
 use Fleetbase\FleetOps\Models\IntegratedVendor;
 use Fleetbase\FleetOps\Models\Payload;
 use Fleetbase\FleetOps\Models\Place;
@@ -76,11 +77,15 @@ class ServiceQuoteController extends Controller
 
         // if quote for single service
         if ($service && $service !== 'all') {
-            $serviceRate = ServiceRate::where('uuid', $service)->where(function ($q) use ($currency) {
-                if ($currency) {
-                    $q->where(DB::raw('lower(currency)'), strtolower($currency));
-                }
-            })->first();
+            $serviceRate = ServiceRate::where(
+                function ($query) use ($service) {
+                    $query->where('uuid', $service)->orWhere('public_id', $service);
+                })->where(
+                    function ($q) use ($currency) {
+                        if ($currency) {
+                            $q->where(DB::raw('lower(currency)'), strtolower($currency));
+                        }
+                    })->first();
             $serviceQuotes = collect();
 
             if ($serviceRate) {

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/Controllers/Internal/v1/ServiceRateController.php

@@ -39,6 +39,9 @@ class ServiceRateController extends FleetOpsController
             $waypoints,
             function ($query) use ($request) {
                 $query->where('company_uuid', $request->session()->get('company'));
+                if ($request->filled('service_type')) {
+                    $query->where('service_type', $request->input('service_type'));
+                }
             }
         );