@fleetbase/fleetops-engine 0.2.9 → 0.3.0

package/addon/components/context-panel.hbs

@@ -1,5 +1,5 @@
 {{#if this.contextPanel.currentContextRegistry}}
     {{#let this.contextPanel.currentContext this.contextPanel.currentContextRegistry  this.contextPanel.currentContextComponentArguments as |model registry dynamicArgs|}}
-        {{component registry.component context=model dynamicArgs=dynamicArgs onPressCancel=this.contextPanel.clear}}
+        {{component registry.component context=model dynamicArgs=dynamicArgs onPressCancel=this.contextPanel.clear options=this.contextPanel.contextOptions}}
     {{/let}}
 {{/if}}

package/addon/components/driver-card-mini.js

@@ -1,25 +1,46 @@
 import Component from '@glimmer/component';
-import { inject as controller } from '@ember/controller';
 import { inject as service } from '@ember/service';
 import { action } from '@ember/object';
 
+/**
+ * DriverCardMiniComponent
+ *
+ * A mini-component responsible for displaying a specific driver's card.
+ *
+ * @extends Component
+ *
+ * @property {Service} store - Ember's store service.
+ * @property {Service} fetch - Service for fetching data.
+ * @property {Service} contextPanel - Service for context panel operations.
+ */
 export default class DriverCardMiniComponent extends Component {
-    @controller('management.drivers.index') drivers;
+    /**
+     * Ember's store service.
+     * @type {Service}
+     */
     @service store;
 
-    toModel(record, modelName) {
-        // set id
-        if (!record.id && record.uuid) {
-            record.id = record.uuid;
-        }
+    /**
+     * Fetch service.
+     * @type {Service}
+     */
+    @service fetch;
 
-        const normalized = this.store.normalize(modelName, record);
-        return this.store.push(normalized);
-    }
+    /**
+     * ContextPanel service.
+     * @type {Service}
+     */
+    @service contextPanel;
 
+    /**
+     * View the details of a specific driver.
+     *
+     * @param {Object} record - The driver record to view.
+     * @action
+     * @returns {Promise} Resolves when the driver's details are focused in the context panel.
+     */
     @action viewDriver(record) {
-        const driver = this.toModel(record, 'driver');
-
-        return this.drivers.viewDriver(driver);
+        const driver = this.fetch.jsonToModel(record, 'driver');
+        return this.contextPanel.focus(driver);
     }
 }

package/addon/components/driver-form-panel.hbs

@@ -1,16 +1,16 @@
-<Overlay @position="right" @noBackdrop={{true}} @fullHeight={{true}} @isResizeble={{or this.isResizable @isResizable}} @width={{or this.width @width "600px"}}>
+<Overlay @onLoad={{this.setOverlayContext}} @position="right" @noBackdrop={{true}} @fullHeight={{true}} @isResizeble={{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">
                 {{#if this.driver.id}}
-                    <Button @type="default" @icon="id-card" @helpText="View driver details" @onClick={{this.viewDetails}} />
+                    <Button @type="default" @icon="id-card" @helpText="View driver details" @onClick={{this.onViewDetails}} />
                 {{/if}}
             </div>
             <div class="flex flex-1 justify-end">
                 <div class="mr-2">
                     <Button @icon={{if this.driver.id "save" "check"}} @type="primary" @text={{if this.driver.id "Save Driver" "Create Driver"}} @onClick={{this.save}} />
                 </div>
-                <Button @type="default" @icon="times" @helpText={{if this.driver.id "Cancel edit driver" "Cancel new driver"}} @onClick={{@onPressCancel}} />
+                <Button @type="default" @icon="times" @helpText={{if this.driver.id "Cancel edit driver" "Cancel new driver"}} @onClick={{this.onPressCancel}} />
             </div>
         </div>
         <div class="flex flex-row justify-between w-full">

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

@@ -2,63 +2,121 @@ 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 DriverFormPanelComponent extends Component {
+    /**
+     * @service store
+     */
     @service store;
+
+    /**
+     * @service notifications
+     */
     @service notifications;
+
+    /**
+     * @service hostRouter
+     */
     @service hostRouter;
-    @service contextPanel;
+
+    /**
+     * @service loader
+     */
     @service loader;
-    @tracked driver;
 
+    /**
+     * @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.driver = this.args.driver;
-        this.applyDynamicArguments();
+        applyContextComponentArguments(this);
     }
 
-    applyDynamicArguments() {
-        // Apply context if available
-        if (this.args.context) {
-            this.driver = 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 driver changes.
+     *
+     * @action
+     * @returns {Promise<any>}
+     */
     @action save() {
         const { driver } = this;
-        const { onAfterSave } = this.args;
 
-        this.loader.showLoader('.overlay-inner-content', 'Saving driver...');
+        this.loader.showLoader('.next-content-overlay-panel-container', { loadingMessage: 'Saving driver...', preserveTargetPosition: true });
+        this.isLoading = true;
+
+        contextComponentCallback(this, 'onBeforeSave', driver);
 
         try {
             return driver
                 .save()
-                .then((vehicle) => {
+                .then((driver) => {
                     this.notifications.success(`Driver (${driver.name}) saved successfully.`);
-
-                    if (typeof onAfterSave === 'function') {
-                        onAfterSave(vehicle);
-                    }
+                    contextComponentCallback(this, 'onAfterSave', driver);
+                })
+                .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 driver.
+     *
+     * @action
+     */
+    @action onViewDetails() {
+        const isActionOverrided = contextComponentCallback(this, 'onViewDetails', this.driver);
+
+        if (!isActionOverrided) {
+            this.contextPanel.focus(this.driver, 'viewing');
         }
     }
 
-    @action viewDetails() {
-        this.contextPanel.focus(this.driver, 'viewing');
+    /**
+     * Handles cancel button press.
+     *
+     * @action
+     * @returns {any}
+     */
+    @action onPressCancel() {
+        return contextComponentCallback(this, 'onPressCancel', this.driver);
     }
 }

package/addon/components/driver-panel.hbs

@@ -1,12 +1,12 @@
-<Overlay @position="right" @noBackdrop={{true}} @fullHeight={{true}} @isResizeble={{or this.isResizable @isResizable}} @width={{or this.width @width "600px"}}>
+<Overlay @onLoad={{this.setOverlayContext}} @position="right" @noBackdrop={{true}} @fullHeight={{true}} @isResizeble={{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="location-arrow" @helpText="Locate driver" @onClick={{@onPressCancel}} /> --}}
-                <Button @type="default" @icon="pen" @helpText="Edit driver" @onClick={{this.editDriver}} />
+                <Button @type="default" @icon="pen" @helpText="Edit driver" @onClick={{this.onEdit}} />
             </div>
             <div class="flex flex-1 justify-end">
-                <Button @type="default" @icon="times" @helpText="Close driver details" @onClick={{@onPressCancel}} />
+                <Button @type="default" @icon="times" @helpText="Close driver details" @onClick={{this.onPressCancel}} />
             </div>
         </div>
         <div class="flex flex-row justify-between w-full">
@@ -45,7 +45,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>
@@ -53,7 +53,7 @@
                 </nav>
             </div>
         </div>
-        <div class="tab-content tab-{{this.currentTab}}">
+        <div class="tab-content tab-{{this.tab.slug}}">
             {{component this.tab.component driver=this.driver tabOptions=this.tab params=this.tab.componentParams}}
         </div>
     </Overlay::Body>

package/addon/components/driver-panel.js

@@ -1,22 +1,76 @@
 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 DriverPanelDetailComponent from './driver-panel/details';
+import contextComponentCallback from '../utils/context-component-callback';
+import applyContextComponentArguments from '../utils/apply-context-component-arguments';
 
 export default class DriverPanelComponent 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 driver being displayed or edited.
+     *
+     * @type {DriverModel}
+     * @tracked
+     */
     @tracked driver;
 
+    /**
+     * Returns the array of tabs available for the panel.
+     *
+     * @type {Array}
+     */
     get tabs() {
         const registeredTabs = this.universe.getMenuItemsFromRegistry('component:driver-panel');
         // this.universe._createMenuItem('Tracking', null, { icon: 'satellite-dish', component: DriverPanelTrackingComponent }),
@@ -29,46 +83,79 @@ export default class DriverPanelComponent extends Component {
         return defaultTabs;
     }
 
-    @computed('currentTab', 'tabs') get tab() {
-        if (this.currentTab) {
-            return this.tabs.find(({ slug }) => slug === this.currentTab);
-        }
-
-        return null;
-    }
-
+    /**
+     * Initializes the driver panel component.
+     */
     constructor() {
         super(...arguments);
         this.driver = this.args.driver;
-        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.driver = 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 driver.
+     *
+     * @method
+     * @action
+     */
+    @action onEdit() {
+        const isActionOverrided = contextComponentCallback(this, 'onEdit', this.driver);
 
-            keys.forEach((key) => {
-                this[key] = this.args.dynamicArgs[key];
+        if (!isActionOverrided) {
+            this.contextPanel.focus(this.driver, '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.driver);
+    }
 
-        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 editDriver() {
-        this.contextPanel.focus(this.driver, 'editing');
+        return this.tabs[0];
     }
 }