@fleetbase/fleetops-engine 0.4.16 → 0.4.18

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

@@ -2,268 +2,75 @@
 
 namespace Fleetbase\FleetOps\Http\Controllers\Internal\v1;
 
-use Fleetbase\FleetOps\Models\Order;
-use Fleetbase\FleetOps\Support\Flow;
-use Fleetbase\FleetOps\Support\Utils;
-use Fleetbase\Http\Controllers\Controller;
-use Fleetbase\Models\Category;
-use Fleetbase\Models\Extension;
-use Fleetbase\Models\ExtensionInstall;
-use Fleetbase\Models\Type;
+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\Str;
+use Illuminate\Support\Facades\Validator;
 
-class OrderConfigController extends Controller
+class OrderConfigController extends FleetOpsController
 {
     /**
-     * Retrieve all installed or created order configurations.
+     * The resource to query.
      *
-     * @return \Illuminate\Http\Response
-     */
-    public function getInstalled(Request $request)
-    {
-        $key                 = $request->input('key');
-        $namespace           = $request->input('namespace');
-        $single              = $request->input('single', false);
-        $installedExtensions = [];
-
-        // get all installed order configs
-        $installed = ExtensionInstall::where('company_uuid', session('company'))
-            ->whereHas(
-                'extension',
-                function ($query) {
-                    $query->where('meta_type', 'order_config');
-                }
-            )
-            ->with('extension')->get();
-
-        // morph installed into extensions
-        foreach ($installed as $install) {
-            $installedExtensions[] = $install->asExtension();
-        }
-
-        // get authored extension installs
-        $authored = Extension::where(['author_uuid' => session('company'), 'meta_type' => 'order_config', 'status' => 'private'])->get();
-
-        // create array of configs
-        $configs = collect([...$installedExtensions, ...$authored]);
-
-        // if no installed configs always place default config
-        if ($configs->isEmpty()) {
-            $configs = $configs->merge(Flow::getAllDefaultOrderConfigs());
-        }
-
-        // filter by key
-        if ($key) {
-            $configs = $configs->where('key', $key);
-        }
-
-        // filter by namespace
-        if ($namespace) {
-            $configs = $configs->where('namespace', $namespace);
-        }
-
-        if ($single) {
-            return response()->json($configs->first());
-        }
-
-        return response()->json($configs->values()->toArray());
-    }
-
-    /**
-     * Save an order extension, whether installed or authored.
-     *
-     * @return \Illuminate\Http\Response
-     */
-    public function save(Request $request)
-    {
-        $data        = $request->input('data', []);
-        $isInstalled = isset($data['installed']) && Utils::isTrue($data['installed']);
-
-        // if the extension is from installed
-        if ($isInstalled) {
-            // get the extension install record
-            $install = ExtensionInstall::where('uuid', $data['install_uuid'])->first();
-
-            // update install record
-            $overwrite                = $install->overwrite ?? [];
-            $overwrite['name']        = $data['name'];
-            $overwrite['description'] = $data['description'];
-
-            // update json fields
-            $install->overwrite = $overwrite;
-            $install->meta      = $data['meta'];
-
-            // save changes
-            $install->save();
-
-            return response()->json(['status' => 'OK']);
-        }
-
-        // get the extension record
-        $extension = Extension::where('uuid', $data['uuid'])->first();
-
-        // update extension record
-        $extension->name        = $data['name'];
-        $extension->description = $data['description'];
-        $extension->meta        = $data['meta'];
-
-        // save
-        $extension->save();
-
-        return response()->json(['status' => 'OK']);
-    }
-
-    /**
-     * Creates a new empty order configuration.
-     *
-     * @return \Illuminate\Http\Response
+     * @var string
      */
-    public function new(Request $request)
-    {
-        $name        = $request->input('name');
-        $description = $request->input('description');
-        $tags        = $request->input('tags', []);
-
-        $company  = Flow::getCompanySession();
-        $category = Category::where(['for' => 'extension', 'name' => 'Logistics'])->first();
-        $type     = Type::where(['for' => 'extension', 'key' => 'config'])->first();
-
-        $orderConfig = Extension::create(
-            [
-                'author_uuid'   => session('company'),
-                'category_uuid' => $category->uuid,
-                'type_uuid'     => $type->uuid,
-                'name'          => $name,
-                'description'   => $description,
-                'display_name'  => $name,
-                'key'           => Str::slug($name),
-                'tags'          => $tags,
-                'namespace'     => Extension::createNamespace($company->slug, 'order-config', $name),
-                'version'       => '0.0.1',
-                'core_service'  => 0,
-                'meta'          => ['flow' => Flow::getDefaultOrderFlow()],
-                'meta_type'     => 'order_config',
-                'config'        => [],
-                'status'        => 'private',
-            ]
-        );
-
-        return response()->json($orderConfig);
-    }
+    public $resource = 'order-config';
 
     /**
-     * Clones an order configuration into a new configuration.
+     * Creates a record with request payload.
      *
      * @return \Illuminate\Http\Response
      */
-    public function clone(Request $request)
+    public function createRecord(Request $request)
     {
-        $name        = $request->input('name');
-        $description = $request->input('description');
-        $id          = $request->input('id');
-        $installed   = $request->input('installed', false);
-        $company     = Flow::getCompanySession();
-
-        if (!$id) {
-            return response()->json(
-                [
-                    'errors' => ['Extension attempted to clone not found'],
-                ],
-                400
-            );
+        // 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);
         }
 
-        // if the extension is from installed
-        if ($installed) {
-            // get the extension install record
-            $install = ExtensionInstall::where('uuid', $id)->first();
-
-            // replicate the install
-            $clonedInstall            = $install->replicate();
-            $clonedInstall->id        = null;
-            $clonedInstall->uuid      = Extension::generateUuid();
-            $clonedInstall->overwrite = [
-                'name'         => $name,
-                'display_name' => $name,
-                'description'  => $description,
-                'key'          => Str::slug($name),
-                'namespace'    => Extension::createNamespace($company->slug, 'order-config', $name, Str::random(5)),
-            ];
-
-            // save clone
-            $clonedInstall->save();
+        try {
+            $record = $this->model->createRecordFromRequest($request);
 
-            return response()->json($clonedInstall->asExtension());
+            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());
         }
-
-        // get the extension record
-        $extension = Extension::where('uuid', $id)->first();
-
-        // replicate the extension record
-        $clonedExtension               = $extension->replicate();
-        $clonedExtension->id           = null;
-        $clonedExtension->uuid         = Extension::generateUuid();
-        $clonedExtension->public_id    = Extension::generatePublicId('ext');
-        $clonedExtension->name         = $name;
-        $clonedExtension->display_name = $name;
-        $clonedExtension->description  = $description;
-        $clonedExtension->key          = Str::slug($name);
-        $clonedExtension->namespace    = Extension::createNamespace($company->slug, 'order-config', $name, Str::random(5));
-        $clonedExtension->status       = 'private';
-
-        // save clone
-        $clonedExtension->save();
-
-        return response()->json($clonedExtension);
     }
 
     /**
-     * Pull all dynamically created meta fields throughout orders of a specific type.
+     * Delete's an order config.
      *
      * @return \Illuminate\Http\Response
      */
-    public function getDynamicMetaFields(Request $request)
+    public function deleteRecord($id, Request $request)
     {
-        $type          = $request->input('type', 'transport');
-        $orders        = Order::select('meta')->where('type', $type)->whereNull('deleted_at')->get();
-        $dynamicFields = collect();
-
-        foreach ($orders as $order) {
-            $dynamicFields = $dynamicFields->merge(array_keys($order->meta));
+        $orderConfig = OrderConfig::where('uuid', $id)->first();
+        if (!$orderConfig) {
+            return response()->error('No order config found.');
         }
 
-        return response()->json($dynamicFields->unique()->values());
-    }
-
-    /**
-     * Pull all dynamically created meta fields throughout orders of a specific type.
-     *
-     * @return \Illuminate\Http\Response
-     */
-    public function delete(string $id)
-    {
-        $extension = Extension::where(['uuid' => $id, 'author_uuid' => session('company'), 'meta_type' => 'order_config'])->first();
-
-        if ($extension) {
-            $extension->delete();
-
-            return response()->json(['status' => 'OK', 'deleted' => $extension->uuid]);
+        // `core_service` order configs cannot be deleted
+        if ($orderConfig->core_service) {
+            return response()->error('Core service order config\'s cannot be deleted.');
         }
 
-        $installedExtension = ExtensionInstall::where(['uuid' => $id, 'company_uuid' => session('company')])->first();
+        if ($orderConfig) {
+            $orderConfig->delete();
 
-        if ($installedExtension) {
-            $installedExtension->delete();
+            $this->resource::wrap($this->resourceSingularlName);
 
-            return response()->json(['status' => 'OK', 'deleted' => $installedExtension->uuid]);
+            return new $this->resource($orderConfig);
         }
-
-        return response()->json(
-            [
-                'errors' => 'Unable to uninstall order configuration',
-            ],
-            400
-        );
     }
 }

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

@@ -6,8 +6,10 @@ use Fleetbase\Exceptions\FleetbaseRequestValidationException;
 use Fleetbase\FleetOps\Events\OrderDispatchFailed;
 use Fleetbase\FleetOps\Events\OrderReady;
 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;
@@ -17,13 +19,14 @@ use Fleetbase\FleetOps\Models\Place;
 use Fleetbase\FleetOps\Models\ServiceQuote;
 use Fleetbase\FleetOps\Models\TrackingStatus;
 use Fleetbase\FleetOps\Models\Waypoint;
-use Fleetbase\FleetOps\Support\Flow;
 use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Http\Requests\Internal\BulkDeleteRequest;
+use Fleetbase\Models\CustomFieldValue;
 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;
 
@@ -43,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) {
@@ -78,11 +89,12 @@ class OrderController extends FleetOpsController
                     $isIntegratedVendorOrder = isset($requestInput['integrated_vendor_order']);
                     $serviceQuote            = ServiceQuote::resolveFromRequest($request);
 
-                    $route     = Utils::get($input, 'route');
-                    $payload   = Utils::get($input, 'payload');
-                    $waypoints = Utils::get($input, 'payload.waypoints');
-                    $entities  = Utils::get($input, 'payload.entities');
-                    $uploads   = Utils::get($input, 'files', []);
+                    $route               = Utils::get($input, 'route');
+                    $payload             = Utils::get($input, 'payload');
+                    $waypoints           = Utils::get($input, 'payload.waypoints');
+                    $entities            = Utils::get($input, 'payload.entities');
+                    $uploads             = Utils::get($input, 'files', []);
+                    $customFieldValues   = Utils::get($input, 'custom_field_values', []);
 
                     // save order route & payload with request input
                     $order
@@ -102,6 +114,20 @@ class OrderController extends FleetOpsController
                         }
                     }
 
+                    // save custom field values
+                    if (is_array($customFieldValues)) {
+                        foreach ($customFieldValues as $customFieldValue) {
+                            CustomFieldValue::create([
+                                'company_uuid'      => session('company'),
+                                'custom_field_uuid' => data_get($customFieldValue, 'custom_field_uuid'),
+                                'subject_uuid'      => $order->uuid,
+                                'subject_type'      => Utils::getMutationType($order),
+                                'value'             => data_get($customFieldValue, 'value'),
+                                'value_type'        => data_get($customFieldValue, 'value_type', 'text'),
+                            ]);
+                        }
+                    }
+
                     // if it's integrated vendor order apply to meta
                     if ($isIntegratedVendorOrder) {
                         $order->updateMeta(
@@ -357,7 +383,7 @@ class OrderController extends FleetOpsController
         /**
          * @var \Fleetbase\Models\Order
          */
-        $order = Order::select(['uuid', 'driver_assigned_uuid', 'adhoc', 'dispatched', 'dispatched_at'])->where('uuid', $request->input('order'))->withoutGlobalScopes()->first();
+        $order = Order::select(['uuid', 'driver_assigned_uuid', 'order_config_uuid', 'adhoc', 'dispatched', 'dispatched_at'])->where('uuid', $request->input('order'))->withoutGlobalScopes()->first();
 
         if (!$order->hasDriverAssigned && !$order->adhoc) {
             return response()->error('No driver assigned to dispatch!');
@@ -367,7 +393,7 @@ class OrderController extends FleetOpsController
             return response()->error('Order has already been dispatched!');
         }
 
-        $order->dispatch();
+        $order->dispatchWithActivity();
 
         return response()->json(
             [
@@ -425,7 +451,7 @@ class OrderController extends FleetOpsController
         $driver->save();
 
         // get the next order activity
-        $flow = $activity = Flow::getNextActivity($order);
+        $flow = $activity = $order->config()->nextFirstActivity();
 
         /**
          * @var \Fleetbase\LaravelMysqlSpatial\Types\Point
@@ -443,11 +469,11 @@ class OrderController extends FleetOpsController
 
             // update activity for each waypoint and entity
             foreach ($payload->waypointMarkers as $waypointMarker) {
-                $waypointMarker->insertActivity($activity['status'], $activity['details'], $location, $activity['code']);
+                $waypointMarker->insertActivity($activity, $location);
             }
 
             foreach ($payload->entities as $entity) {
-                $entity->insertActivity($activity['status'], $activity['details'], $location, $activity['code']);
+                $entity->insertActivity($activity, $location);
             }
         }
 
@@ -477,10 +503,11 @@ class OrderController extends FleetOpsController
             return response()->error('No order found.');
         }
 
-        $activity = $request->input('activity');
+        $activity = $request->array('activity');
+        $activity = new Activity($activity, $order->getConfigFlow());
 
-        // handle pickup/dropoff order activity update as normal
-        if (is_array($activity) && $activity['code'] === 'dispatched') {
+        // Handle pickup/dropoff order activity update as normal
+        if (Utils::isActivity($activity) && $activity->is('dispatched')) {
             // make sure driver is assigned if not trigger failed dispatch
             if (!$order->hasDriverAssigned && !$order->adhoc) {
                 event(new OrderDispatchFailed($order, 'No driver assigned for order to dispatch to.'));
@@ -493,28 +520,31 @@ class OrderController extends FleetOpsController
             return response()->json(['status' => 'dispatched']);
         }
 
-        if (is_array($activity) && $activity['code'] === 'completed' && $order->driverAssigned) {
-            // unset from driver current job
-            $order->driverAssigned->unassignCurrentOrder();
-            $order->notifyCompleted();
-        }
-
         /**
          * @var \Fleetbase\LaravelMysqlSpatial\Types\Point
          */
         $location = $order->getLastLocation();
-
-        $order->setStatus($activity['code']);
-        $order->insertActivity($activity['status'], $activity['details'], $location, $activity['code']);
+        $order->setStatus($activity->code);
+        $order->insertActivity($activity, $location);
 
         // also update for each order entities if not multiple drop order
         // all entities will share the same activity status as is one drop order
         if (!$order->payload->isMultipleDropOrder) {
             foreach ($order->payload->entities as $entity) {
-                $entity->insertActivity($activity['status'], $activity['details'], $location, $activity['code']);
+                $entity->insertActivity($activity, $location);
             }
         }
 
+        // Handle order completed
+        if (Utils::isActivity($activity) && $activity->completesOrder() && $order->driverAssigned) {
+            // unset from driver current job
+            $order->driverAssigned->unassignCurrentOrder();
+            $order->complete();
+        }
+
+        // Fire activity events
+        $activity->fireEvents($order);
+
         return response()->json(['status' => 'ok']);
     }
 
@@ -534,9 +564,9 @@ class OrderController extends FleetOpsController
             return response()->error('No order found.');
         }
 
-        $flow = Flow::getOrderFlow($order);
+        $nextActivities = $order->config()->nextActivity();
 
-        return response()->json($flow);
+        return response()->json($nextActivities);
     }
 
     /**

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

@@ -11,6 +11,15 @@ use Illuminate\Http\Request;
  */
 class SettingController extends Controller
 {
+    /**
+     * Retrieves the current visibility settings.
+     *
+     * This method fetches the visibility settings for 'fleet-ops' from the database and
+     * returns them in a JSON response. The settings are retrieved based on a specific key
+     * from the 'Setting' model.
+     *
+     * @return \Illuminate\Http\Response the visibility settings in JSON format
+     */
     public function getVisibilitySettings()
     {
         $visibilitySettings = Setting::where('key', 'fleet-ops.visibility')->value('value');
@@ -18,6 +27,17 @@ class SettingController extends Controller
         return response()->json(['visibilitySettings' => $visibilitySettings]);
     }
 
+    /**
+     * Saves the visibility settings provided in the request.
+     *
+     * This method accepts visibility settings via the request and updates them in the database.
+     * The new settings are saved using a specific key in the 'Setting' model. The method
+     * returns the updated settings in a JSON response.
+     *
+     * @param Request $request the HTTP request containing the visibility settings
+     *
+     * @return \Illuminate\Http\Response the updated visibility settings in JSON format
+     */
     public function saveVisibilitySettings(Request $request)
     {
         $visibilitySettings = $request->input('visibilitySettings', []);

package/server/src/Http/Filter/OrderConfigFilter.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Fleetbase\FleetOps\Http\Filter;
+
+use Fleetbase\Http\Filter\Filter;
+
+class OrderConfigFilter extends Filter
+{
+    public function queryForInternal()
+    {
+        $this->builder->where('company_uuid', $this->session->get('company'));
+    }
+}

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

@@ -0,0 +1,19 @@
+<?php
+
+namespace Fleetbase\FleetOps\Http\Requests;
+
+use Fleetbase\Http\Requests\FleetbaseRequest;
+
+class CreateIssueRequest extends FleetbaseRequest
+{
+    public function rules()
+    {
+        return [
+            'driver'       => ['required'],
+            'location'     => ['required'],
+            'category'     => ['nullable'],
+            'type'         => ['nullable'],
+            'priority'     => ['nullable'],
+        ];
+    }
+}

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'),
+            ],
+        ];
+    }
+}