@fleetbase/fleetops-engine 0.2.9 → 0.3.1

package/addon/components/vehicle-form-panel.js

@@ -1,62 +1,122 @@
 import Component from '@glimmer/component';
+import { tracked } from '@glimmer/tracking';
 import { inject as service } from '@ember/service';
 import { action } from '@ember/object';
+import contextComponentCallback from '../utils/context-component-callback';
+import applyContextComponentArguments from '../utils/apply-context-component-arguments';
 
 export default class VehicleFormPanelComponent extends Component {
+    /**
+     * @service store
+     */
     @service store;
+
+    /**
+     * @service notifications
+     */
     @service notifications;
+
+    /**
+     * @service hostRouter
+     */
     @service hostRouter;
+
+    /**
+     * @service loader
+     */
     @service loader;
+
+    /**
+     * @service contextPanel
+     */
     @service contextPanel;
 
+    /**
+     * Overlay context.
+     * @type {any}
+     */
+    @tracked context;
+
+    /**
+     * Indicates whether the component is in a loading state.
+     * @type {boolean}
+     */
+    @tracked isLoading = false;
+
+    /**
+     * Constructs the component and applies initial state.
+     */
     constructor() {
         super(...arguments);
         this.vehicle = this.args.vehicle;
-        this.applyDynamicArguments();
+        applyContextComponentArguments(this);
     }
 
-    applyDynamicArguments() {
-        // Apply context if available
-        if (this.args.context) {
-            this.vehicle = this.args.context;
-        }
-
-        // Apply dynamic arguments if available
-        if (this.args.dynamicArgs) {
-            const keys = Object.keys(this.args.dynamicArgs);
-
-            keys.forEach((key) => {
-                this[key] = this.args.dynamicArgs[key];
-            });
-        }
+    /**
+     * Sets the overlay context.
+     *
+     * @action
+     * @param {OverlayContextObject} overlayContext
+     */
+    @action setOverlayContext(overlayContext) {
+        this.context = overlayContext;
+        contextComponentCallback(this, 'onLoad', ...arguments);
     }
 
+    /**
+     * Saves the vehicle changes.
+     *
+     * @action
+     * @returns {Promise<any>}
+     */
     @action save() {
-        const { onAfterSave } = this.args;
         const { vehicle } = this;
 
-        this.loader.showLoader('.overlay-inner-content', 'Saving vehicle...');
+        this.loader.showLoader('.next-content-overlay-panel-container', { loadingMessage: 'Saving vehicle...', preserveTargetPosition: true });
+        this.isLoading = true;
+
+        contextComponentCallback(this, 'onBeforeSave', vehicle);
 
         try {
             return vehicle
                 .save()
                 .then((vehicle) => {
                     this.notifications.success(`Vehicle (${vehicle.displayName}) saved successfully.`);
-
-                    if (typeof onAfterSave === 'function') {
-                        onAfterSave(vehicle);
-                    }
+                    contextComponentCallback(this, 'onAfterSave', vehicle);
+                })
+                .catch((error) => {
+                    this.notifications.serverError(error);
                 })
-                .catch(this.notifications.serverError)
                 .finally(() => {
-                    this.loader.removeLoader();
+                    this.loader.removeLoader('.next-content-overlay-panel-container ');
+                    this.isLoading = false;
                 });
         } catch (error) {
-            this.loader.removeLoader();
+            this.loader.removeLoader('.next-content-overlay-panel-container ');
+            this.isLoading = false;
+        }
+    }
+
+    /**
+     * View the details of the vehicle.
+     *
+     * @action
+     */
+    @action onViewDetails() {
+        const isActionOverrided = contextComponentCallback(this, 'onViewDetails', this.vehicle);
+
+        if (!isActionOverrided) {
+            this.contextPanel.focus(this.vehicle, 'viewing');
         }
     }
 
-    @action viewDetails() {
-        this.contextPanel.focus(this.vehicle, 'viewing');
+    /**
+     * Handles cancel button press.
+     *
+     * @action
+     * @returns {any}
+     */
+    @action onPressCancel() {
+        return contextComponentCallback(this, 'onPressCancel', this.vehicle);
     }
 }

package/addon/components/vehicle-panel.hbs

@@ -1,11 +1,11 @@
-<Overlay @position="right" @noBackdrop={{true}} @fullHeight={{true}} @isResizable={{or this.isResizable @isResizable}} @width={{or this.width @width "600px"}}>
+<Overlay @onLoad={{this.setOverlayContext}} @position="right" @noBackdrop={{true}} @fullHeight={{true}} @isResizable={{or this.isResizable @isResizable}} @width={{or this.width @width "600px"}}>
     <Overlay::Header @hideLeftSection={{true}} @actionsWrapperClass="flex-1 flex-col py-3" class="h-auto-i min-h-[127px]">
         <div class="flex flex-row items-center justify-between w-full mb-4">
             <div class="flex flex-1 space-x-2">
-                <Button @type="default" @icon="pen" @helpText="Edit vehicle" @onClick={{this.editVehicle}} />
+                <Button @type="default" @icon="pen" @helpText="Edit vehicle" @onClick={{this.onEdit}} />
             </div>
             <div class="flex flex-1 justify-end">
-                <Button @type="default" @icon="times" @helpText="Close vehicle details" @onClick={{@onPressCancel}} />
+                <Button @type="default" @icon="times" @helpText="Close vehicle details" @onClick={{this.onPressCancel}} />
             </div>
         </div>
         <div class="flex flex-row justify-between w-full">
@@ -44,7 +44,7 @@
             <div class="ui-tabs mt-4">
                 <nav>
                     {{#each this.tabs as |tab|}}
-                        <a href="javascript:;" class="ui-tab {{if (eq this.currentTab tab.slug) 'active' }}" {{on "click" (fn this.changeTab tab.slug)}}>
+                        <a href="javascript:;" class="ui-tab {{if (eq this.tab.slug tab.slug) 'active' }}" {{on "click" (fn this.onTabChanged tab.slug)}}>
                             <FaIcon @icon={{tab.icon}} class="mr-1" />
                             <span>{{tab.title}}</span>
                         </a>
@@ -52,7 +52,7 @@
                 </nav>
             </div>
         </div>
-        <div class="tab-content tab-{{this.currentTab}}">
+        <div class="tab-content tab-{{this.tab.slug}}">
             {{component this.tab.component vehicle=this.vehicle tabOptions=this.tab params=this.tab.componentParams}}
         </div>
     </Overlay::Body>

package/addon/components/vehicle-panel.js

@@ -1,22 +1,82 @@
 import Component from '@glimmer/component';
 import { tracked } from '@glimmer/tracking';
-import { action, computed } from '@ember/object';
+import { action } from '@ember/object';
 import { inject as service } from '@ember/service';
 import { isArray } from '@ember/array';
 import VehiclePanelDetailComponent from './vehicle-panel/details';
+import contextComponentCallback from '../utils/context-component-callback';
+import applyContextComponentArguments from '../utils/apply-context-component-arguments';
 
+/**
+ * Represents the vehicle panel component, handling vehicle information display and editing.
+ *
+ * @class VehiclePanelComponent
+ * @extends Component
+ */
 export default class VehiclePanelComponent extends Component {
+    /**
+     * Service for fetching data.
+     *
+     * @type {Service}
+     */
     @service fetch;
+
+    /**
+     * Service for managing modals.
+     *
+     * @type {Service}
+     */
     @service modalsManager;
+
+    /**
+     * Universe service for managing global data and settings.
+     *
+     * @type {Service}
+     */
     @service universe;
+
+    /**
+     * Ember data store service.
+     *
+     * @type {Service}
+     */
     @service store;
+
+    /**
+     * Service for managing routing within the host app.
+     *
+     * @type {Service}
+     */
     @service hostRouter;
+
+    /**
+     * Service for managing the context panel.
+     *
+     * @type {Service}
+     */
     @service contextPanel;
-    @tracked currentTab;
-    @tracked devices = [];
-    @tracked deviceApi = {};
+
+    /**
+     * The current active tab.
+     *
+     * @type {Object}
+     * @tracked
+     */
+    @tracked tab;
+
+    /**
+     * The vehicle being displayed or edited.
+     *
+     * @type {VehicleModel}
+     * @tracked
+     */
     @tracked vehicle;
 
+    /**
+     * Returns the array of tabs available for the panel.
+     *
+     * @type {Array}
+     */
     get tabs() {
         const registeredTabs = this.universe.getMenuItemsFromRegistry('component:vehicle-panel');
         // this.universe._createMenuItem('Tracking', null, { icon: 'satellite-dish', component: VehiclePanelTrackingComponent }),
@@ -29,46 +89,79 @@ export default class VehiclePanelComponent extends Component {
         return defaultTabs;
     }
 
-    @computed('currentTab', 'tabs') get tab() {
-        if (this.currentTab) {
-            return this.tabs.find(({ slug }) => slug === this.currentTab);
-        }
-
-        return null;
-    }
-
+    /**
+     * Initializes the vehicle panel component.
+     */
     constructor() {
         super(...arguments);
         this.vehicle = this.args.vehicle;
-        this.changeTab(this.args.tab);
-        this.applyDynamicArguments();
+        this.tab = this.getTabUsingSlug(this.args.tab);
+        applyContextComponentArguments(this);
     }
 
-    applyDynamicArguments() {
-        // Apply context if available
-        if (this.args.context) {
-            this.vehicle = this.args.context;
-        }
+    /**
+     * Sets the overlay context.
+     *
+     * @action
+     * @param {OverlayContextObject} overlayContext
+     */
+    @action setOverlayContext(overlayContext) {
+        this.context = overlayContext;
+        contextComponentCallback(this, 'onLoad', ...arguments);
+    }
 
-        // Apply dynamic arguments if available
-        if (this.args.dynamicArgs) {
-            const keys = Object.keys(this.args.dynamicArgs);
+    /**
+     * Handles changing the active tab.
+     *
+     * @method
+     * @param {String} tab - The new tab to switch to.
+     * @action
+     */
+    @action onTabChanged(tab) {
+        this.tab = this.getTabUsingSlug(tab);
+        contextComponentCallback(this, 'onTabChanged', tab);
+    }
+
+    /**
+     * Handles edit action for the vehicle.
+     *
+     * @method
+     * @action
+     */
+    @action onEdit() {
+        const isActionOverrided = contextComponentCallback(this, 'onEdit', this.vehicle);
 
-            keys.forEach((key) => {
-                this[key] = this.args.dynamicArgs[key];
+        if (!isActionOverrided) {
+            this.contextPanel.focus(this.vehicle, 'editing', {
+                onAfterSave: () => {
+                    this.contextPanel.clear();
+                },
             });
         }
     }
 
-    @action async changeTab(tab = 'details') {
-        this.currentTab = tab;
+    /**
+     * Handles the cancel action.
+     *
+     * @method
+     * @action
+     * @returns {Boolean} Indicates whether the cancel action was overridden.
+     */
+    @action onPressCancel() {
+        return contextComponentCallback(this, 'onPressCancel', this.vehicle);
+    }
 
-        if (typeof this.args.onTabChanged === 'function') {
-            this.args.onTabChanged(tab);
+    /**
+     * Finds and returns a tab based on its slug.
+     *
+     * @param {String} tabSlug - The slug of the tab.
+     * @returns {Object|null} The found tab or null.
+     */
+    getTabUsingSlug(tabSlug) {
+        if (tabSlug) {
+            return this.tabs.find(({ slug }) => slug === tabSlug);
         }
-    }
 
-    @action editVehicle() {
-        this.contextPanel.focus(this.vehicle, 'editing');
+        return this.tabs[0];
     }
 }

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

@@ -1,8 +1,61 @@
 import Controller from '@ember/controller';
+import { tracked } from '@glimmer/tracking';
 import { action } from '@ember/object';
 
+/**
+ * Controller for managing the details view within the "Management -> Drivers -> Index" route.
+ *
+ * @class ManagementDriversIndexDetailsController
+ * @extends Controller
+ */
 export default class ManagementDriverIndexDetailsController extends Controller {
+    /**
+     * The currently active view tab ('details' by default).
+     *
+     * @type {String}
+     * @tracked
+     */
+    @tracked view = 'details';
+
+    /**
+     * An array of query parameters to be serialized in the URL.
+     *
+     * @type {String[]}
+     * @tracked
+     */
+    @tracked queryParams = ['view'];
+
+    /**
+     * Transitions back to the "management.drivers.index" route.
+     *
+     * @method
+     * @action
+     * @returns {Transition} The transition object representing the route change.
+     */
     @action transitionBack() {
         return this.transitionToRoute('management.drivers.index');
     }
+
+    /**
+     * Transitions to the edit view for a specific vehicle.
+     *
+     * @method
+     * @param {DriverModel} driver - The vehicle to be edited.
+     * @action
+     * @returns {Transition} The transition object representing the route change.
+     */
+    @action onEdit(driver) {
+        return this.transitionToRoute('management.drivers.index.edit', driver);
+    }
+
+    /**
+     * Updates the active view tab.
+     *
+     * @method
+     * @param {String} tab - The name of the tab to activate.
+     * @action
+     */
+    @action onTabChanged(tab) {
+        this.view = tab;
+    }
 }

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

@@ -5,76 +5,107 @@ import { action } from '@ember/object';
 
 export default class ManagementDriversIndexEditController extends Controller {
     /**
-     * True if updating service rate.
+     * Inject the `hostRouter` service
      *
-     * @var {Boolean}
+     * @memberof ManagementDriversIndexEditController
      */
-    @tracked isUpdatingDriver = false;
+    @service hostRouter;
+
     /**
-     * Inject the `loader` service
+     * Inject the `hostRouter` service
      *
-     * @var {Service}
+     * @memberof ManagementDriversIndexEditController
      */
-    @service loader;
+    @service modalsManager;
+
     /**
-     * Inject the `notifications` service
+     * The overlay component context.
      *
-     * @var {Service}
+     * @memberof ManagementDriversIndexEditController
      */
-    @service notifications;
+    @tracked overlay;
+
     /**
-     * Inject the `hostRouter` service
+     * When exiting the overlay.
      *
-     * @var {Service}
+     * @return {Transition}
+     * @memberof ManagementDriversIndexEditController
      */
-    @service hostRouter;
+    @action transitionBack(driver) {
+        // check if driver record has been edited and prompt for confirmation
+        if (driver.hasDirtyAttributes) {
+            return this.confirmContinueWithUnsavedChanges(driver, {
+                confirm: () => {
+                    driver.rollbackAttributes();
+                    return this.transitionToRoute('management.drivers.index');
+                },
+            });
+        }
+
+        return this.transitionToRoute('management.drivers.index');
+    }
+
     /**
-     * Inject the `currentUser` service
+     * Set the overlay component context object.
      *
-     * @var {Service}
+     * @param {OverlayContext} overlay
+     * @memberof ManagementDriversIndexEditController
      */
-    @service store;
+    @action setOverlayContext(overlay) {
+        this.overlay = overlay;
+    }
+
     /**
-     * Updates the drivers to server
+     * When driver details button is clicked in overlay.
      *
-     * @void
+     * @param {VehicleModel} driver
+     * @return {Promise}
+     * @memberof ManagementDriversIndexEditController
      */
-    @action updateDriver() {
-        const { driver } = this;
+    @action onViewDetails(driver) {
+        // check if driver record has been edited and prompt for confirmation
+        if (driver.hasDirtyAttributes) {
+            return this.confirmContinueWithUnsavedChanges(driver);
+        }
 
-        this.isUpdatingDriver = true;
-        this.loader.showLoader('.overlay-inner-content', 'Updating driver...');
+        return this.transitionToRoute('management.drivers.index.details', driver);
+    }
 
-        try {
-            return driver
-                .save()
-                .then((driver) => {
-                    return this.transitionToRoute('management.drivers.index').then(() => {
-                        this.notifications.success(`Driver '${driver.name}' updated`);
-                        this.resetForm();
-                        this.hostRouter.refresh();
-                    });
-                })
-                .catch(this.notifications.serverError)
-                .finally(() => {
-                    this.isUpdatingDriver = false;
-                    this.loader.removeLoader();
-                });
-        } catch (error) {
-            this.isUpdatingDriver = false;
-            this.loader.removeLoader();
+    /**
+     * Trigger a route refresh and focus the new driver created.
+     *
+     * @param {VehicleModel} driver
+     * @return {Promise}
+     * @memberof ManagementDriversIndexEditController
+     */
+    @action onAfterSave(driver) {
+        if (this.overlay) {
+            this.overlay.close();
         }
-    }
 
-    @action transitionBack() {
-        return this.transitionToRoute('management.drivers.index');
+        this.hostRouter.refresh();
+        return this.transitionToRoute('management.drivers.index.details', driver);
     }
+
     /**
-     * Resets the driver form
+     * Prompts the user to confirm if they wish to continue with unsaved changes.
      *
-     * @void
+     * @method
+     * @param {VehicleModel} driver - The driver object with unsaved changes.
+     * @param {Object} [options={}] - Additional options for configuring the modal.
+     * @returns {Promise} A promise that resolves when the user confirms, and transitions to a new route.
+     * @memberof ManagementDriversIndexEditController
      */
-    @action resetForm() {
-        this.driver = this.store.createRecord('driver');
+    confirmContinueWithUnsavedChanges(driver, options = {}) {
+        return this.modalsManager.confirm({
+            title: 'Continue Without Saving?',
+            body: 'Unsaved changes to this driver will be lost. Click continue to proceed.',
+            acceptButtonText: 'Continue without saving',
+            confirm: () => {
+                driver.rollbackAttributes();
+                return this.transitionToRoute('management.drivers.index.details', driver);
+            },
+            ...options,
+        });
     }
 }