@fleetbase/fleetops-engine 0.4.16 → 0.4.17

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

@@ -5,6 +5,7 @@ namespace Fleetbase\FleetOps\Http\Controllers\Api\v1;
 use Fleetbase\FleetOps\Events\OrderDispatchFailed;
 use Fleetbase\FleetOps\Events\OrderReady;
 use Fleetbase\FleetOps\Events\OrderStarted;
+use Fleetbase\FleetOps\Flow\Activity;
 use Fleetbase\FleetOps\Http\Requests\CreateOrderRequest;
 use Fleetbase\FleetOps\Http\Requests\ScheduleOrderRequest;
 use Fleetbase\FleetOps\Http\Requests\UpdateOrderRequest;
@@ -19,7 +20,6 @@ use Fleetbase\FleetOps\Models\Place;
 use Fleetbase\FleetOps\Models\Proof;
 use Fleetbase\FleetOps\Models\ServiceQuote;
 use Fleetbase\FleetOps\Models\Waypoint;
-use Fleetbase\FleetOps\Support\Flow;
 use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Http\Controllers\Controller;
 use Fleetbase\Models\Company;
@@ -35,7 +35,7 @@ class OrderController extends Controller
     /**
      * Creates a new Fleetbase Order resource.
      *
-     * @param \Illuminate\Http\Request|\Fleetbase\Http\Requests\CreateOrderRequest $request
+     * @param Request|\Fleetbase\Http\Requests\CreateOrderRequest $request
      *
      * @return \Fleetbase\Http\Resources\Order
      */
@@ -779,23 +779,21 @@ class OrderController extends Controller
             return response()->apiError('No driver assigned to order.');
         }
 
-        // get the next order activity
-        $flow = $activity = Flow::getNextActivity($order);
+        // Get the order config
+        $orderConfig = $order->config();
 
-        // order is not dispatched if next activity code is dispatch or order is not flagged as dispatched
-        $isNotDispatched = $activity['code'] === 'dispatched' || $order->isNotDispatched;
+        // Get the order started activity
+        $activity = $orderConfig->getStartedActivity();
 
-        // if order is not dispatched yet $activity['code'] === 'dispatched' || $order->dispatched === true
+        // Order is not dispatched if next activity code is dispatch or order is not flagged as dispatched
+        $isNotDispatched = $order->isNotDispatched;
+
+        // If order is not dispatched yet $activity->is('dispatched') || $order->dispatched === true
         // and not skipping throw order not dispatched error
         if ($isNotDispatched && !$skipDispatch) {
             return response()->apiError('Order has not been dispatched yet and cannot be started.');
         }
 
-        // if we're going to skip the dispatch get the next activity status and flow and continue
-        if ($isNotDispatched && $skipDispatch) {
-            $flow = $activity = Flow::getAfterNextActivity($order);
-        }
-
         // set order to started
         $order->started    = true;
         $order->started_at = now();
@@ -816,7 +814,7 @@ class OrderController extends Controller
         $order->setRelation('payload', $payload);
 
         // update order activity
-        $updateActivityRequest = new Request(['activity' => $flow]);
+        $updateActivityRequest = new Request(['activity' => $activity->serialize()]);
 
         // update activity
         return $this->updateActivity($order, $updateActivityRequest);
@@ -869,15 +867,20 @@ class OrderController extends Controller
             return response()->apiError('Order is already completed.');
         }
 
-        $activity = $request->input('activity', Flow::getNextActivity($order));
+        // Get the order config
+        $orderConfig = $order->config();
+        $activity    = $request->array('activity');
+        if (!Utils::isActivity($activity)) {
+            $activity = new Activity($activity, $order->getConfigFlow());
+        }
 
         // if we're going to skip the dispatch get the next activity status and flow and continue
-        if (is_array($activity) && $activity['code'] === 'dispatched' && $skipDispatch) {
-            $activity = Flow::getAfterNextActivity($order);
+        if (Utils::isActivity($activity) && $activity->is('dispatched') && $skipDispatch) {
+            $activity = $orderConfig->getStartedActivity();
         }
 
         // handle pickup/dropoff order activity update as normal
-        if (is_array($activity) && $activity['code'] === 'dispatched') {
+        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.'));
@@ -898,7 +901,7 @@ class OrderController extends Controller
             $order->payload->setFirstWaypoint($activity, $location);
         }
 
-        if (is_array($activity) && $activity['code'] === 'completed' && $order->payload->isMultipleDropOrder) {
+        if (Utils::isActivity($activity) && $activity->completesOrder() && $order->payload->isMultipleDropOrder) {
             // confirm every waypoint is completed
             $isCompleted = $order->payload->waypointMarkers->every(function ($waypoint) {
                 return $waypoint->status_code === 'COMPLETED';
@@ -921,24 +924,26 @@ class OrderController extends Controller
             }
         }
 
-        if (is_array($activity) && $activity['code'] === 'completed' && $order->driverAssigned) {
-            // unset from driver current job
-            $order->driverAssigned->unassignCurrentOrder();
-            $order->notifyCompleted();
-        }
-
+        // Update activity
         $order->updateActivity($activity, $proof);
 
         // 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'], $proof);
+                $entity->insertActivity($activity, $location, $proof);
             }
         } else {
             $order->payload->updateWaypointActivity($activity, $location);
         }
 
+        // Handle order completion
+        if (Utils::isActivity($activity) && $activity->completesOrder()) {
+            // unset from driver current job
+            $order->driverAssigned->unassignCurrentOrder();
+            $order->complete();
+        }
+
         return new OrderResource($order);
     }
 
@@ -947,10 +952,8 @@ class OrderController extends Controller
      *
      * @return \Illuminate\Http\Response
      */
-    public function getNextActivity(string $id, Request $request)
+    public function getNextActivity(string $id)
     {
-        $waypointId = $request->input('waypoint');
-
         try {
             $order = Order::findRecordOrFail($id, ['payload']);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
@@ -962,22 +965,7 @@ class OrderController extends Controller
             );
         }
 
-        $isMultipleDropOrder = $order->payload->isMultipleDropOrder;
-
-        if ($waypointId && $isMultipleDropOrder) {
-            $waypoint = Waypoint::where('payload_uuid', $order->payload_uuid)->where(function ($q) use ($waypointId) {
-                $q->whereHas('place', function ($q) use ($waypointId) {
-                    $q->where('public_id', $waypointId);
-                });
-                $q->orWhere('public_id', $waypointId);
-            })->withoutGlobalScopes()->first();
-
-            $activity = Flow::getOrderWaypointFlow($order, $waypoint);
-
-            return response()->json($activity);
-        }
-
-        $activity = Flow::getOrderFlow($order);
+        $activity = $order->config()->nextActivity();
 
         return response()->json($activity);
     }
@@ -1010,24 +998,17 @@ class OrderController extends Controller
             return response()->apiError('Not all waypoints completed for order.');
         }
 
-        $activity = [
-            'status'  => 'Order completed',
-            'details' => 'Driver has completed order for all waypoints',
-            'code'    => 'completed',
-        ];
-
+        $activity = $order->config()->getCompletedActivity();
         if ($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);
+        $order->notifyCompleted();
 
         return new OrderResource($order);
     }
@@ -1112,7 +1093,7 @@ class OrderController extends Controller
      *
      * @return void
      */
-    public function captureQrScan(string $id, ?string $subjectId = null, Request $request)
+    public function captureQrScan(Request $request, string $id, ?string $subjectId = null)
     {
         $code    = $request->input('code');
         $data    = $request->input('data', []);
@@ -1183,7 +1164,7 @@ class OrderController extends Controller
      *
      * @return void
      */
-    public function captureSignature(string $id, ?string $subjectId = null, Request $request)
+    public function captureSignature(Request $request, string $id, ?string $subjectId = null)
     {
         $disk         = $request->input('disk', config('filesystems.default'));
         $bucket       = $request->input('bucket', config('filesystems.disks.' . $disk . '.bucket', config('filesystems.disks.s3.bucket')));
@@ -1269,4 +1250,96 @@ class OrderController extends Controller
 
         return new ProofResource($proof);
     }
+
+    /**
+     * Validate a photo.
+     *
+     * @return void
+     */
+    public function capturePhoto(Request $request, string $id, ?string $subjectId = null)
+    {
+        $disk         = $request->input('disk', config('filesystems.default'));
+        $bucket       = $request->input('bucket', config('filesystems.disks.' . $disk . '.bucket', config('filesystems.disks.s3.bucket')));
+        $photo        = $request->input('photo');
+        $data         = $request->input('data', []);
+        $remarks      = $request->input('remarks', 'Verified by Photo');
+        $type         = $subjectId ? strtok($subjectId, '_') : null;
+
+        try {
+            $order = Order::findRecordOrFail($id);
+        } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
+            return response()->json(
+                [
+                    'error' => 'Order resource not found.',
+                ],
+                404
+            );
+        }
+
+        if (!$photo) {
+            return response()->apiError('No photo data to capture.');
+        }
+
+        $subject = $type === null ? $order : null;
+
+        switch ($type) {
+            case 'place':
+            case 'waypoint':
+                $subject = Waypoint::where('payload_uuid', $order->payload_uuid)->where(function ($q) use ($subjectId) {
+                    $q->whereHas('place', function ($q) use ($subjectId) {
+                        $q->where('public_id', $subjectId);
+                    });
+                    $q->orWhere('public_id', $subjectId);
+                })->withoutGlobalScopes()->first();
+                break;
+
+            case 'entity':
+                $subject = Entity::where('public_id', $subjectId)->withoutGlobalScopes()->first();
+                break;
+
+            default:
+                break;
+        }
+
+        if (!$subject) {
+            return response()->apiError('Unable to capture photo');
+        }
+
+        // create proof instance
+        $proof = Proof::create([
+            'company_uuid' => session('company'),
+            'order_uuid'   => $order->uuid,
+            'subject_uuid' => $subject->uuid,
+            'subject_type' => Utils::getModelClassName($subject),
+            'remarks'      => $remarks,
+            'raw_data'     => $photo,
+            'data'         => $data,
+        ]);
+
+        // set the photo storage path
+        $path = 'uploads/' . session('company') . '/photos/' . $proof->public_id . '.png';
+
+        // upload photo
+        Storage::disk($disk)->put($path, base64_decode($photo));
+
+        // create file record for upload
+        $file = File::create([
+            'company_uuid'      => session('company'),
+            'uploader_uuid'     => session('user'),
+            'name'              => basename($path),
+            'original_filename' => basename($path),
+            'extension'         => 'png',
+            'content_type'      => 'image/png',
+            'path'              => $path,
+            'bucket'            => $bucket,
+            'type'              => 'photo',
+            'size'              => Utils::getBase64ImageSize($photo),
+        ])->setKey($proof);
+
+        // set file to proof
+        $proof->file_uuid = $file->uuid;
+        $proof->save();
+
+        return new ProofResource($proof);
+    }
 }

package/server/src/Http/Controllers/Api/v1/OrganizationController.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Fleetbase\FleetOps\Http\Controllers\Api\v1;
+
+use Fleetbase\Http\Controllers\Controller;
+use Fleetbase\Http\Resources\Organization;
+use Fleetbase\Models\Company;
+
+class OrganizationController extends Controller
+{
+    /**
+     * Return List organizations.
+     *
+     * @return Organization
+     */
+    public function listOrganizations()
+    {
+        $companies = Company::whereHas('users')->take(10)->get()->map(function ($company) {
+            return [
+                'name' => $company->name,
+                'id'   => $company->public_id,
+            ];
+        });
+
+        return response()->json($companies);
+    }
+}

package/server/src/Http/Controllers/Api/v1/PlaceController.php

@@ -130,9 +130,8 @@ class PlaceController extends Controller
         ]);
 
         // check if missing location
-        $isMissingLocation = empty($input['location']);
-
         // set a default location for creation
+        $isMissingLocation = empty($input['location']);
         if ($isMissingLocation) {
             $input['location'] = new Point(0, 0);
         }
@@ -141,7 +140,7 @@ class PlaceController extends Controller
         $place->fill($input);
 
         // attempt to find and set latitude and longitude
-        if ($isMissingLocation || $request->missing(['latitude', 'longitude', 'location']) || $place->isMissing('country')) {
+        if ($isMissingLocation || $request->missing(['latitude', 'longitude', 'location']) || empty($place->country)) {
             $geocoded = Geocoder::geocode($place->toAddressString(['name']))
                 ->get()
                 ->first();

package/server/src/Http/Controllers/Controller.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Fleetbase\FleetOps\Http\Controllers;
+
+use Illuminate\Routing\Controller as BaseController;
+
+class Controller extends BaseController
+{
+}

package/server/src/Http/Controllers/FleetOpsController.php

@@ -2,6 +2,7 @@
 
 namespace Fleetbase\FleetOps\Http\Controllers;
 
+use Fleetbase\FleetOps\Models\Order;
 use Fleetbase\Http\Controllers\FleetbaseController;
 
 class FleetOpsController extends FleetbaseController
@@ -10,4 +11,10 @@ class FleetOpsController extends FleetbaseController
      * The package namespace used to resolve from.
      */
     public string $namespace = '\\Fleetbase\\FleetOps';
+
+    public function test()
+    {
+        $order = Order::where('public_id', '')->first();
+        dd($order->config()->getNextActivity());
+    }
 }

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

@@ -2,268 +2,14 @@
 
 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 Illuminate\Http\Request;
-use Illuminate\Support\Str;
+use Fleetbase\FleetOps\Http\Controllers\FleetOpsController;
 
-class OrderConfigController extends Controller
+class OrderConfigController extends FleetOpsController
 {
     /**
-     * Retrieve all installed or created order configurations.
+     * The resource to query.
      *
-     * @return \Illuminate\Http\Response
+     * @var string
      */
-    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
-     */
-    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);
-    }
-
-    /**
-     * Clones an order configuration into a new configuration.
-     *
-     * @return \Illuminate\Http\Response
-     */
-    public function clone(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
-            );
-        }
-
-        // 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();
-
-            return response()->json($clonedInstall->asExtension());
-        }
-
-        // 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.
-     *
-     * @return \Illuminate\Http\Response
-     */
-    public function getDynamicMetaFields(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));
-        }
-
-        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]);
-        }
-
-        $installedExtension = ExtensionInstall::where(['uuid' => $id, 'company_uuid' => session('company')])->first();
-
-        if ($installedExtension) {
-            $installedExtension->delete();
-
-            return response()->json(['status' => 'OK', 'deleted' => $installedExtension->uuid]);
-        }
-
-        return response()->json(
-            [
-                'errors' => 'Unable to uninstall order configuration',
-            ],
-            400
-        );
-    }
+    public $resource = 'order-config';
 }