@fleetbase/fleetops-engine 0.4.16 → 0.4.18

package/server/src/Support/FleetOps.php

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

package/server/src/Support/Utils.php

@@ -2,6 +2,7 @@
 
 namespace Fleetbase\FleetOps\Support;
 
+use Fleetbase\FleetOps\Flow\Activity;
 use Fleetbase\Support\Utils as FleetbaseUtils;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\DB;
@@ -1276,4 +1277,20 @@ class Utils extends FleetbaseUtils
 
         return $theta_deg;
     }
+
+    /**
+     * Determines if a given object is an instance of Activity.
+     *
+     * This static method is used to check if a provided object is an
+     * instance of the Activity class. This can be useful in contexts where
+     * there is a need to verify the type of a given resource or object.
+     *
+     * @param mixed $activity the object to check
+     *
+     * @return bool returns true if the provided object is an instance of Activity, false otherwise
+     */
+    public static function isActivity($activity)
+    {
+        return $activity && $activity instanceof Activity && !empty($activity->code);
+    }
 }

package/server/src/Traits/HasTrackingNumber.php

@@ -2,6 +2,7 @@
 
 namespace Fleetbase\FleetOps\Traits;
 
+use Fleetbase\FleetOps\Flow\Activity;
 use Fleetbase\FleetOps\Models\Proof;
 use Fleetbase\FleetOps\Models\TrackingNumber;
 use Fleetbase\FleetOps\Models\TrackingStatus;
@@ -47,16 +48,16 @@ trait HasTrackingNumber
     /**
      * Creates activity for this resource tracking number.
      *
-     * @param string                              $status   the short status update
-     * @param string                              $details  the detailed update
      * @param array|Point                         $location the location of the update, can be either [lat, lng] or a \Fleetbase\LaravelMysqlSpatial\Types\Point instance
-     * @param string                              $code     the onew word status code
      * @param \Fleetbase\Models\Proof|string|null $proof    resolvable proof of delivery/activity
      *
      * @return \Fleetbase\Models\TrackingStatus
      */
-    public function createActivity(string $status, string $details = '', $location = [], string $code = '', $proof = null): TrackingStatus
+    public function createActivity(Activity $activity, $location = [], $proof = null): TrackingStatus
     {
+        $status   = $activity->get('status');
+        $details  = $activity->get('details');
+        $code     = $activity->get('code');
         $proof    = static::resolveProof($proof);
         $activity = TrackingStatus::create([
             'company_uuid'         => data_get($this, 'company_uuid', session('company')),
@@ -82,14 +83,14 @@ trait HasTrackingNumber
     /**
      * Inserts activity for this resource tracking number.
      *
-     * @param string                              $status   the short status update
-     * @param string                              $details  the detailed update
      * @param array|Point                         $location the location of the update, can be either [lat, lng] or a \Fleetbase\LaravelMysqlSpatial\Types\Point instance
      * @param \Fleetbase\Models\Proof|string|null $proof    resolvable proof of delivery/activity
-     * @param string                              $code     the onew word status code
      */
-    public function insertActivity(string $status, string $details = '', $location = [], string $code = '', $proof = null): string
+    public function insertActivity(Activity $activity, $location = [], $proof = null): string
     {
+        $status     = $activity->get('status');
+        $details    = $activity->get('details');
+        $code       = $activity->get('code');
         $proof      = static::resolveProof($proof);
         $activityId = TrackingStatus::insertGetUuid([
             'company_uuid'         => data_get($this, 'company_uuid', session('company')),
@@ -158,7 +159,6 @@ trait HasTrackingNumber
         $this->status = $status;
 
         if ($andSave) {
-            // static::where('uuid', $this->uuid)->update(['status' => $status]);
             $this->save();
         }
 

package/server/src/routes.php

@@ -13,6 +13,8 @@ use Illuminate\Support\Facades\Route;
 |
 */
 
+Route::get('fleet-ops-test', 'Fleetbase\FleetOps\Http\Controllers\Controller@test');
+
 Route::prefix(config('fleetops.api.routing.prefix', null))->namespace('Fleetbase\FleetOps\Http\Controllers')->group(
     function ($router) {
         /*
@@ -60,6 +62,9 @@ Route::prefix(config('fleetops.api.routing.prefix', null))->namespace('Fleetbase
                     $router->put('{id}', 'VendorController@update');
                     $router->delete('{id}', 'VendorController@delete');
                 });
+                $router->fleetbaseRoutes(
+                    'issues'
+                );
                 // orders routes
                 $router->group(['prefix' => 'orders'], function () use ($router) {
                     $router->post('/', 'OrderController@create');
@@ -76,6 +81,7 @@ Route::prefix(config('fleetops.api.routing.prefix', null))->namespace('Fleetbase
                     $router->match(['post', 'patch'], '{id}/set-destination/{placeId}', 'OrderController@setDestination');
                     $router->post('{id}/capture-signature/{subjectId?}', 'OrderController@captureSignature');
                     $router->post('{id}/capture-qr/{subjectId?}', 'OrderController@captureQrScan');
+                    $router->post('{id}/capture-photo/{subjectId?}', 'OrderController@capturePhoto');
                     $router->put('{id}', 'OrderController@update');
                     $router->delete('{id}', 'OrderController@delete');
                 });
@@ -177,6 +183,17 @@ Route::prefix(config('fleetops.api.routing.prefix', null))->namespace('Fleetbase
                 });
             });
 
+        /*
+         |--------------------------------------------------------------------------
+         | Publicly Consumable FleetOps API Routes
+         |--------------------------------------------------------------------------
+         |
+         | End-user API routes, these are routes that the SDK and applications will interface with, that DO NOT REQUIRE API credentials.
+         */
+        $router->group(['prefix' => 'v1', 'namespace' => 'Api\v1'], function () use ($router) {
+            $router->get('organizations', 'OrganizationController@listOrganizations');
+        });
+
         /*
         |--------------------------------------------------------------------------
         | Navigator App API
@@ -209,6 +226,7 @@ Route::prefix(config('fleetops.api.routing.prefix', null))->namespace('Fleetbase
                         $router->post('{id}/set-destination/{placeId}', 'Api\v1\OrderController@setDestination');
                         $router->post('{id}/capture-signature/{subjectId?}', 'Api\v1\OrderController@captureSignature');
                         $router->post('{id}/capture-qr/{subjectId?}', 'Api\v1\OrderController@captureQrScan');
+                        $router->post('{id}/capture-photo/{subjectId?}', 'Api\v1\OrderController@capturePhoto');
                         $router->put('{id}', 'Api\v1\OrderController@update');
                         $router->delete('{id}', 'Api\v1\OrderController@delete');
                     });
@@ -320,6 +338,7 @@ Route::prefix(config('fleetops.api.routing.prefix', null))->namespace('Fleetbase
                                 $router->delete('bulk-delete', $controller('bulkDelete'));
                             }
                         );
+                        $router->fleetbaseRoutes('order-configs');
                         $router->fleetbaseRoutes('payloads');
                         $router->fleetbaseRoutes(
                             'places',
@@ -393,17 +412,6 @@ Route::prefix(config('fleetops.api.routing.prefix', null))->namespace('Fleetbase
                         $router->group(
                             ['prefix' => 'fleet-ops'],
                             function ($router) {
-                                $router->group(
-                                    ['prefix' => 'order-configs'],
-                                    function () use ($router) {
-                                        $router->get('get-installed', 'OrderConfigController@getInstalled');
-                                        $router->get('dynamic-meta-fields', 'OrderConfigController@getDynamicMetaFields');
-                                        $router->post('save', 'OrderConfigController@save');
-                                        $router->post('new', 'OrderConfigController@new');
-                                        $router->post('clone', 'OrderConfigController@clone');
-                                        $router->delete('{id}', 'OrderConfigController@delete');
-                                    }
-                                );
                                 $router->group(
                                     ['prefix' => 'lookup'],
                                     function ($router) {

package/translations/en-us.yaml

@@ -93,8 +93,134 @@ fleet-ops:
     zone: Zone
     total: Total
     back: Back
+    done: Done
 
   component:
+    activity-logic-builder:
+      activity-logic: Activity Logic
+      activity-logic-help-text: Define custom logic conditions that determine when an activity becomes available in the workflow. This feature allows you to tailor the flow based on specific criteria, ensuring that each activity is triggered only when its predefined conditions are met.
+      activity-logic-add-logic-help-text: Create a new set of conditions that will define when an activity should be activated. Click this to start crafting a new logical rule.
+      activity-logic-select-logic-type-help-text: Choose the type of logic that this condition will follow. Select 'If' for a direct condition, 'And'/'Or' for compound conditions, or 'Not' to negate a condition.
+      activity-logic-add-condition-help-text: Add a specific requirement that must be satisfied within this logic set. Use this to specify additional criteria that control the activity's availability.
+      field: Field
+      value: Value
+      add-logic: Add Logic
+    activity-event-selector:
+      activity-events: Activity Events
+      activity-events-select-to-fire: Select which events will be activated when this activity occurs.
+      activity-events-select-events-info: Select the specific event you want to trigger in response to this activity.
+      select-event-to-add: Select event to add...
+    custom-field-form-panel:
+      meta-col-span: 'Meta: Column-Span'
+      col-span-size: Column Span Size
+      custom-field-title-concat: 'Custom Field: '
+      new-custom-field: New custom field
+      close-new-custom-field: Cancel custom field changes
+      save-custom-field: Save Changes
+      create-custom-field: Create New Field
+      field-name: Field Name
+      field-label: Field Label
+      field-type: Field Type
+      select-field-type: Select field type...
+      field-description: Field Description
+      field-help-text: Field Help Text
+      field-default-value: Field Default Value
+      field-is-required: Field is Required
+      field-is-editable: Field is Editable
+      field-options: Field Options
+      field-validation-rules: Field Validation Rules
+      field-model-type: Field Model Type
+      field-select-model-type: Select model type
+      add-new-option: Add new option
+    activity-form-panel:
+      title-concat: 'Activity: '
+      new-activity-title: Create new activity
+      key: Key
+      code: Code
+      status: Status
+      details: Details
+      completes-order: Completes Order
+      complete: Complete
+      key-help: "Enter a key used for programmatic decision-making. This key can represent one or several activities with the same identifier. Note: This key is not required to be unique."
+      code-help: Enter a unique identifier specific to this activity.
+      status-help: Specify the status displayed to the end-user when this activity is triggered.
+      details-help: Provide a detailed description of the activity for the end-user's understanding.
+    custom-entity-issue-form-panel: 
+        new-custom-entity: New Custom Entity
+        name: Name
+        description: Description
+        details: Details
+        type: Type
+        length: Length
+        width: Width
+        height: Height
+        weight: Weight
+        entity-image: Entity Image
+        measurements: Measurements
+    order-config-manager:
+      title: Orders Configuration
+      message: Order configurations allow you to define dynamic configurations which will tell Fleetbase how different types of orders should be executed.
+      configuration: Configuration
+      new-order-config: New Order Config
+      select-order-config: Select Order Config
+      create-new-title: Create a new order configuration
+      create-warning-message: Order configuration requires a name
+      create-success-message: New order config created successfully.
+      no-order-config-selected: No order configuration selected.
+      saved-success-message: '{orderConfigName} configuration saved.'
+      cloned-success-message: Order config successfully cloned.
+      enter-clone-name: Enter name of cloned configuration
+      no-config-name-warning-message: No config name entered.
+      delete-warning-message: Once this order configuration is deleted you will not be able to create orders using it anymore. Are you sure?
+      uninstall-order-config: Uninstall Configuration
+      uninstall-order-config-success-message: Extension {extensionName} uninstalled.
+      select-order-config-to-start: Select or create an order config to start.
+      details:
+        details: Details
+        name: Name
+        description: Description
+        tags: Tags
+        add-tags: Add Tags
+        key: Key
+        version: Version
+        namespace: Namespace
+        controls: Controls
+        delete-config: Delete Config
+        delete:
+          delete-title: Delete this order config?
+          delete-body-message: Once this order config is deleted it will not be recoverable and you will lose all configurations.
+          confirm-delete: Delete
+      activity-flow:
+        save-activity-flow: Save Activity Flow
+        edit-activity-unique-code-warning: Activity code must be unique!
+      custom-fields:
+        new-field-group: New field group
+        new-custom-field: Create new custom field
+        grid-size: Grid Size
+        delete-custom-field-prompt:
+          modal-title: Delete this custom field?
+          delete-body-message: Once this custom field is deleted it will not be recoverable and you will lose all configurations.
+          confirm-delete: Delete
+        delete-custom-field-group-prompt:
+          modal-title: Delete this field group?
+          delete-body-message: Once this field group is deleted it will not be recoverable and you will lose all custom fields inside.
+          confirm-delete: Delete
+      entities: 
+        new-custom-entity: New Custom Entity
+        name: Name
+        description: Description
+        type: Type
+        length: Length
+        width: Width
+        height: Height
+        weight: Weight
+        delete-custom-entity-title: Delete this custom entity?
+        delete-custom-entity-body: Once this custom entity is deleted it will not be recoverable and you will lose all configurations.
+        confirm-delete: Confirm
+      types:
+        no-order-installed: No order configurations installed!
+        you-have-no-configs: You currently have no order configs installed, check at the extensions to install an order configuration to get started.
+        view-extensions: View extensions
     avatar-picker:
       avatar: Avatar
       select-map-avatar: Select map avatar
@@ -146,6 +272,7 @@ fleet-ops:
         issues: Issues
         title: Create new order
         settings: Settings
+        order-config: Order Config
     live-map-drawer:
       driver-listing:
         location: Location
@@ -202,6 +329,9 @@ fleet-ops:
         visibility: Visibility Controls
         scope: Scope
     modals:
+      new-custom-field-group:
+        modal-title: Create a new custom field group
+        group-name: Group Name
       assign-driver:
         select-driver: Select Driver
         select-assign: Select Driver to Assign
@@ -1056,6 +1186,8 @@ fleet-ops:
         title: Vendors
         delete-vendors: Delete Vendors
   operations:
+    order-config:
+      route-loading-message: Loading Order Config Builder
     orders:
       index:
         payload: Payload
@@ -1143,6 +1275,7 @@ fleet-ops:
           add-item-order: Add Item to Order
           items-drop: Items drop at
           add-item-button: Add Item
+          add-entity: Add Entity
           sku: SKU
           select-destination: Select Destination
           edit-item: Edit Item
@@ -1170,6 +1303,7 @@ fleet-ops:
           value-warning: Custom field must have a value
           edit-field-title: Edit custom field
           edit-metadata: Edit Metadata
+          input-field-required: The {inputFieldName} is required.
         view:
           purchase-rate-panel-title: Purchase Rate
           documents-panel-title: Documents & Files
@@ -1236,6 +1370,9 @@ fleet-ops:
           order-title: Order Label
           waypoint-title: Waypoint Label
           proof-of-delivery: Proof of Delivery
+          notes-placeholder: Enter order notes here....
+          save-order-note: Save Order Note
+          order-notes-updated: Order notes updated.
         config:
           title: Orders Configuration
           message: Order configurations allow you to define dynamic configurations which will tell Fleetbase how different types of orders should be executed.

package/server/src/Flow/Config.php

@@ -1,7 +0,0 @@
-<?php
-
-namespace Fleetbase\FleetOps\Flow;
-
-class Config
-{
-}