@fleetbase/fleetops-engine 0.3.6 → 0.3.7

package/addon/components/admin/navigator-app.hbs

@@ -1,5 +1,8 @@
 <ContentPanel @title="Navigator App" @open={{true}} @pad={{true}} @panelBodyClass="bg-white dark:bg-gray-800">
-    <InputGroup @name="URL">
-        <ClickToCopy>{{this.url}}</ClickToCopy>
+    <InputGroup @name="Instance Linking URL">
+        <ClickToCopy class="px-4 py-2 border rounded-md bg-gray-100 shadow-sm dark:bg-gray-700 border-gray-200 dark:border-gray-800" @value={{this.url}}>{{this.url}}</ClickToCopy>
+        <Attach::Tooltip @class="clean" @animation="scale" @placement="top">
+            <InputInfo>Use this URL to link the official Navigator app to this {{t "app.name"}} instance. Opening this URL on a mobile device will open the Navigator app and update it's configuration and branding.</InputInfo>
+        </Attach::Tooltip>
     </InputGroup>
-</ContentPanel>
+</ContentPanel>

package/addon/controllers/management/drivers/index/edit.js

@@ -25,13 +25,6 @@ export default class ManagementDriversIndexEditController extends BaseController
      */
     @tracked overlay;
 
-    /**
-     * The universe service.
-     *
-     * @memberof ManagementDriversIndexEditController
-     */
-    @tracked universe;
-
     /**
      * When exiting the overlay.
      *
@@ -115,23 +108,4 @@ export default class ManagementDriversIndexEditController extends BaseController
             ...options,
         });
     }
-
-    /**
-     * Transitions to a specified route within the '@fleetbase/fleetops-engine' engine.
-     *
-     * This action is a wrapper around the `transitionToEngineRoute` method of the `universe` service (or object),
-     * specifically targeting the '@fleetbase/fleetops-engine'. It allows for easy transitioning to routes
-     * within this engine, abstracting away the need to repeatedly specify the engine name.
-     *
-     * @param {string} route - The route within the '@fleetbase/fleetops-engine' to transition to.
-     * @param {...any} args - Additional arguments to pass to the transitionToEngineRoute method.
-     * @returns {Promise} A Promise that resolves with the result of the transitionToEngineRoute method.
-     *
-     * @example
-     * // To transition to the 'management.fleets.index.new' route within the '@fleetbase/fleetops-engine'
-     * this.transitionToRoute('management.fleets.index.new');
-     */
-    @action _transitionToRoute(route, ...args) {
-        return this.universe.transitionToEngineRoute('@fleetbase/fleetops-engine', route, ...args);
-    }
 }

package/addon/engine.js

@@ -4,7 +4,7 @@ import Resolver from 'ember-resolver';
 import config from './config/environment';
 import services from '@fleetbase/ember-core/exports/services';
 import AdminVisibilityControlsComponent from './components/admin/visibility-controls';
-import NavigatorAppControlsComponent from './components/admin/navigator-app';
+import NavigatorAppConfigComponent from './components/admin/navigator-app';
 
 const { modulePrefix } = config;
 const externalRoutes = ['console', 'extensions'];
@@ -30,9 +30,9 @@ export default class FleetOpsEngine extends Engine {
                     component: AdminVisibilityControlsComponent,
                 },
                 {
-                    title: 'Navigator Apps',
-                    icon: 'key',
-                    component: NavigatorAppControlsComponent,
+                    title: 'Navigator App',
+                    icon: 'location-arrow',
+                    component: NavigatorAppConfigComponent,
                 },
             ],
             {

package/composer.json

@@ -1,6 +1,6 @@
 {
     "name": "fleetbase/fleetops-api",
-    "version": "0.3.6",
+    "version": "0.3.7",
     "description": "Fleet & Transport Management Extension for Fleetbase",
     "keywords": [
         "fleetbase-extension",
@@ -22,7 +22,7 @@
     ],
     "require": {
         "php": "^7.4|^8.0",
-        "fleetbase/core-api": "^1.3.2",
+        "fleetbase/core-api": "^1.3.4",
         "barryvdh/laravel-dompdf": "^2.0",
         "brick/geo": "0.7.2",
         "cknow/laravel-money": "^7.1",

package/extension.json

@@ -1,6 +1,6 @@
 {
     "name": "Fleet-Ops",
-    "version": "0.3.6",
+    "version": "0.3.7",
     "description": "Fleet & Transport Management Extension for Fleetbase",
     "repository": "https://github.com/fleetbase/fleetops",
     "license": "MIT",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fleetbase/fleetops-engine",
-    "version": "0.3.6",
+    "version": "0.3.7",
     "description": "Fleet & Transport Management Extension for Fleetbase",
     "fleetbase": {
         "route": "fleet-ops",

package/server/config/fleetops.php

@@ -12,7 +12,10 @@ return [
             'prefix' => null,
             'internal_prefix' => 'int'
         ]
-    ], 
+    ],
+    'navigator' => [
+        'bypass_verification_code' => env('NAVIGATOR_BYPASS_VERIFICATION_CODE', '999000')
+    ],
     'connection' => [
         'db' => env('DB_CONNECTION', 'mysql')
     ]

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

@@ -353,10 +353,10 @@ class DriverController extends Controller
             return response()->error('Authentication failed using password provided.', 401);
         }
 
-        // get the current company session
+        // Get the company session for the user
         $company = Flow::getCompanySessionForUser($user);
 
-        // get driver record
+        // Get driver record
         $driver = Driver::firstOrCreate(
             [
                 'user_uuid'    => $user->uuid,
@@ -365,9 +365,10 @@ class DriverController extends Controller
             [
                 'user_uuid'    => $user->uuid,
                 'company_uuid' => $company->uuid,
-                'name'         => $attrs['name'] ?? $user->name,
-                'phone'        => $attrs['phone'] ?? $user->phone,
-                'email'        => $attrs['email'] ?? $user->email,
+                'name'         => data_get($attrs, 'name', $user->name),
+                'phone'        => data_get($attrs, 'phone', $user->phone),
+                'email'        => data_get($attrs, 'email', $user->email),
+                'location'     => new Point(0, 0),
             ]
         );
 
@@ -443,7 +444,7 @@ class DriverController extends Controller
         // find and verify code
         $verificationCode = VerificationCode::where(['subject_uuid' => $user->uuid, 'code' => $code, 'for' => $for])->exists();
 
-        if (!$verificationCode && $code !== '999000') {
+        if (!$verificationCode && $code !== config('fleetops.navigator.bypass_verification_code')) {
             return response()->error('Invalid verification code!');
         }
 

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

@@ -4,14 +4,18 @@ namespace Fleetbase\FleetOps\Http\Controllers\Internal\v1;
 
 use Fleetbase\Exceptions\FleetbaseRequestValidationException;
 use Fleetbase\FleetOps\Exports\DriverExport;
+use Fleetbase\FleetOps\Http\Controllers\Api\v1\DriverController as ApiDriverController;
 use Fleetbase\FleetOps\Http\Controllers\FleetOpsController;
+use Fleetbase\FleetOps\Http\Requests\Internal\AssignOrderRequest;
 use Fleetbase\FleetOps\Http\Requests\Internal\CreateDriverRequest;
 use Fleetbase\FleetOps\Http\Requests\Internal\UpdateDriverRequest;
 use Fleetbase\FleetOps\Models\Driver;
+use Fleetbase\FleetOps\Models\Order;
 use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Http\Requests\ExportRequest;
 use Fleetbase\Models\Invite;
 use Fleetbase\Models\User;
+use Fleetbase\Models\VerificationCode;
 use Fleetbase\Notifications\UserInvited;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\DB;
@@ -267,4 +271,148 @@ class DriverController extends FleetOpsController
 
         return Excel::download(new DriverExport(), $fileName);
     }
+
+    /**
+     * Assigns a driver to a specified order.
+     *
+     * @param Fleetbase\FleetOps\Http\Requests\Internal\AssignOrderRequest $request
+     *
+     * @return \Illuminate\Http\Response $response
+     */
+    public function assignOrder(AssignOrderRequest $request)
+    {
+        $driver = Driver::where('public_id', $request->driver)->first();
+        $order  = Order::where('public_id', $request->order)->first();
+
+        if ($order->hasDriverAssigned) {
+            return response()->error('A driver is already assigned to this order.');
+        }
+
+        if ($order->isDriver($driver)) {
+            return response()->error('The driver is already assigned to this order.');
+        }
+
+        $order->assignDriver($driver);
+
+        return response()->json([
+            'status'  => 'ok',
+            'message' => 'Driver assigned',
+        ]);
+    }
+
+    /**
+     * Update drivers geolocation data.
+     *
+     * @return \Illuminate\Http\Response
+     */
+    public function track(string $id, Request $request)
+    {
+        return app(ApiDriverController::class)->track($id, $request);
+    }
+
+    /**
+     * Query for Storefront Customer orders.
+     *
+     * @return \Fleetbase\Http\Resources\Storefront\Customer
+     */
+    public function registerDevice(Request $request)
+    {
+        return app(ApiDriverController::class)->registerDevice($request);
+    }
+
+    /**
+     * Authenticates customer using login credentials and returns with auth token.
+     *
+     * @return \Fleetbase\Http\Resources\Storefront\Customer
+     */
+    public function login(Request $request)
+    {
+        return app(ApiDriverController::class)->login($request);
+    }
+
+    /**
+     * Attempts authentication with phone number via SMS verification.
+     *
+     * @return \Illuminate\Http\Response
+     */
+    public function loginWithPhone()
+    {
+        $phone = static::phone();
+
+        // Check if user exists
+        $user = User::where('phone', $phone)->whereNull('deleted_at')->withoutGlobalScopes()->first();
+
+        if (!$user) {
+            return response()->error('No driver with this phone # found.');
+        }
+
+        // Generate verification token
+        VerificationCode::generateSmsVerificationFor($user, 'driver_login', function ($verification) {
+            return 'Your ' . config('app.name') . ' verification code is ' . $verification->code;
+        });
+
+        return response()->json(['status' => 'OK']);
+    }
+
+    /**
+     * Verifys SMS code and sends auth token with driver resource.
+     *
+     * @return \Fleetbase\Http\Resources\FleetOps\Driver
+     */
+    public function verifyCode(Request $request)
+    {
+        $identity = Utils::isEmail($request->identity) ? $request->identity : static::phone($request->identity);
+        $code     = $request->input('code');
+        $for      = $request->input('for', 'driver_login');
+        $attrs    = $request->input(['name', 'phone', 'email']);
+
+        if ($for === 'create_driver') {
+            return app(ApiDriverController::class)->create($request);
+        }
+
+        // Check if user exists
+        $user = User::where('phone', $identity)->orWhere('email', $identity)->first();
+        if (!$user) {
+            return response()->error('Unable to verify code.');
+        }
+
+        // Find and verify code
+        $verificationCode = VerificationCode::where(['subject_uuid' => $user->uuid, 'code' => $code, 'for' => $for])->exists();
+        if (!$verificationCode && $code !== config('fleetops.navigator.bypass_verification_code')) {
+            return response()->error('Invalid verification code!');
+        }
+
+        // Get driver record
+        $driver = Driver::where('user_uuid', $user->uuid)->whereNull('deleted_at')->withoutGlobalScopes()->first();
+        if (!$driver) {
+            return response()->error('No driver/agent record found for login.');
+        }
+
+        // Generate auth token
+        try {
+            $token = $user->createToken($driver->uuid);
+        } catch (\Exception $e) {
+            return response()->error($e->getMessage());
+        }
+
+        $driver->token = $token->plainTextToken;
+
+        return new $this->resource($driver);
+    }
+
+    /**
+     * Patches phone number with international code.
+     */
+    public static function phone(string $phone = null): string
+    {
+        if ($phone === null) {
+            $phone = request()->input('phone');
+        }
+
+        if (!Str::startsWith($phone, '+')) {
+            $phone = '+' . $phone;
+        }
+
+        return $phone;
+    }
 }

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

@@ -3,8 +3,12 @@
 namespace Fleetbase\FleetOps\Http\Controllers\Internal\v1;
 
 use Fleetbase\Http\Controllers\Controller;
+use Fleetbase\Http\Resources\Organization;
 use Fleetbase\Models\ApiCredential;
+use Fleetbase\Models\Company;
 use Fleetbase\Models\User;
+use Illuminate\Http\Request;
+use Illuminate\Support\Str;
 
 class NavigatorController extends Controller
 {
@@ -38,4 +42,38 @@ class NavigatorController extends Controller
             'linkUrl' => url('int/v1/fleet-ops/navigator/link-app'),
         ]);
     }
+
+    public function getCurrentOrganization(Request $request)
+    {
+        $token       = $request->bearerToken();
+        $isSecretKey = Str::startsWith($token, '$');
+
+        // Depending on API key format set the connection to find credential on
+        $connection = Str::startsWith($token, 'flb_test_') ? 'sandbox' : 'mysql';
+
+        // Find the API Credential record
+        $findApKey = ApiCredential::on($connection)
+            ->where(function ($query) use ($isSecretKey, $token) {
+                if ($isSecretKey) {
+                    $query->where('secret', $token);
+                } else {
+                    $query->where('key', $token);
+                }
+            })
+            ->with(['company.owner'])
+            ->withoutGlobalScopes();
+
+        // Get the api credential model record
+        $apiCredential = $findApKey->first();
+
+        // Handle no api credential found
+        if (!$apiCredential) {
+            return response()->error('No API key found to fetch company details with.');
+        }
+
+        // Get the organization owning the API key
+        $organization = Company::where('uuid', $apiCredential->company_uuid)->first();
+
+        return new Organization($organization);
+    }
 }

package/server/src/routes.php

@@ -175,6 +175,60 @@ Route::prefix(config('fleetops.api.routing.prefix', null))->namespace('Fleetbase
                 });
             });
 
+        /*
+        |--------------------------------------------------------------------------
+        | Navigator App API
+        |--------------------------------------------------------------------------
+        |
+        | Internal routes specific for instance wide authentication/use for navigator app
+        */
+        Route::prefix('navigator/v1')
+            ->group(function ($router) {
+                // driver/auth routes
+                $router->group(['prefix' => 'drivers', 'namespace' => 'Internal\v1'], function () use ($router) {
+                    $router->post('login-with-sms', 'DriverController@loginWithPhone');
+                    $router->post('verify-code', 'DriverController@verifyCode');
+                    $router->post('login', 'DriverController@login');
+                });
+
+                // auth:sanctum
+                $router->group(['middleware' => ['fleetbase.protected', \Fleetbase\FleetOps\Http\Middleware\TransformLocationMiddleware::class]], function () use ($router) {
+                    $router->group(['prefix' => 'orders'], function () use ($router) {
+                        $router->post('/', 'Api\v1\OrderController@create');
+                        $router->get('/', 'Api\v1\OrderController@query');
+                        $router->get('{id}', 'Api\v1\OrderController@find');
+                        $router->get('{id}/distance-and-time', 'Api\v1\OrderController@getDistanceMatrix');
+                        $router->post('{id}/dispatch', 'Api\v1\OrderController@dispatchOrder');
+                        $router->post('{id}/start', 'Api\v1\OrderController@startOrder');
+                        $router->delete('{id}/cancel', 'Api\v1\OrderController@cancelOrder');
+                        $router->post('{id}/update-activity', 'Api\v1\OrderController@updateActivity');
+                        $router->post('{id}/complete', 'Api\v1\OrderController@completeOrder');
+                        $router->get('{id}/next-activity', 'Api\v1\OrderController@getNextActivity');
+                        $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->put('{id}', 'Api\v1\OrderController@update');
+                        $router->delete('{id}', 'Api\v1\OrderController@delete');
+                    });
+
+                    $router->group(['prefix' => 'drivers'], function () use ($router) {
+                        $router->post('{id}/register-device', 'Api\v1\DriverController@registerDevice');
+                        $router->post('{id}/track', 'Api\v1\DriverController@track');
+                        $router->post('{id}/switch-organization', 'Api\v1\DriverController@switchOrganization');
+                        $router->post('/', 'Api\v1\DriverController@create');
+                        $router->get('/', 'Api\v1\DriverController@query');
+                        $router->get('{id}', 'Api\v1\DriverController@find');
+                        $router->get('{id}/organizations', 'Api\v1\DriverController@listOrganizations');
+                        $router->put('{id}', 'Api\v1\DriverController@update');
+                        $router->delete('{id}', 'Api\v1\DriverController@delete');
+                    });
+
+                    $router->group(['prefix' => 'organizations'], function ($router) {
+                        $router->get('current', 'Internal\v1\NavigatorController@getCurrentOrganization');
+                    });
+                });
+            });
+
         /*
         |--------------------------------------------------------------------------
         | Internal FleetOps API Routes