@fleetbase/fleetops-engine 0.2.8 → 0.3.0

package/addon/controllers/operations/orders/index.js

@@ -7,7 +7,6 @@ import { isArray } from '@ember/array';
 import { isBlank } from '@ember/utils';
 import { timeout } from 'ember-concurrency';
 import { task } from 'ember-concurrency-decorators';
-import isModel from '@fleetbase/ember-core/utils/is-model';
 
 export default class OperationsOrdersIndexController extends Controller {
     /**
@@ -113,6 +112,20 @@ export default class OperationsOrdersIndexController extends Controller {
         'layout',
     ];
 
+    /**
+     * The current driver being focused.
+     *
+     * @var {DriverModel|null}
+     */
+    @tracked focusedDriver;
+
+    /**
+     * The current vehicle being focused.
+     *
+     * @var {VehicleModel|null}
+     */
+    @tracked focusedVehicle;
+
     /**
      * The current page of data being viewed
      *
@@ -616,39 +629,59 @@ export default class OperationsOrdersIndexController extends Controller {
         this.query = value;
     }
 
-    @action viewPlacesOnMap() {
-        const {
-            leafletMap: { liveMap },
-        } = this;
-
-        if (liveMap) {
-            liveMap.togglePlaces();
-        }
-    }
-
+    /**
+     * Hides all elements on the live map.
+     * @action
+     * @memberof OperationsOrdersIndexController
+     */
     @action resetView() {
         if (this.leafletMap && this.leafletMap.liveMap) {
-            this.leafletMap.liveMap.hideDrivers();
-            this.leafletMap.liveMap.hideRoutes();
+            this.leafletMap.liveMap.hideAll();
         }
     }
 
+    /**
+     * Toggles the visibility of the search interface.
+     * @action
+     * @memberof OperationsOrdersIndexController
+     */
     @action toggleSearch() {
         this.isSearchVisible = !this.isSearchVisible;
     }
 
+    /**
+     * Toggles the visibility of the orders panel.
+     * @action
+     * @memberof OperationsOrdersIndexController
+     */
     @action toggleOrdersPanel() {
         this.isOrdersPanelVisible = !this.isOrdersPanelVisible;
     }
 
+    /**
+     * Hides the orders panel.
+     * @action
+     * @memberof OperationsOrdersIndexController
+     */
     @action hideOrdersPanel() {
         this.isOrdersPanelVisible = false;
     }
 
+    /**
+     * Shows the orders panel.
+     * @action
+     * @memberof OperationsOrdersIndexController
+     */
     @action showOrdersPanel() {
         this.isOrdersPanelVisible = true;
     }
 
+    /**
+     * Zooms the map in or out.
+     * @param {string} [direction='in'] - The direction to zoom. Either 'in' or 'out'.
+     * @action
+     * @memberof OperationsOrdersIndexController
+     */
     @action zoomMap(direction = 'in') {
         if (direction === 'in') {
             this.leafletMap?.zoomIn();
@@ -657,6 +690,12 @@ export default class OperationsOrdersIndexController extends Controller {
         }
     }
 
+    /**
+     * Sets the layout mode and triggers a layout change event.
+     * @param {string} mode - The layout mode to set. E.g., 'table'.
+     * @action
+     * @memberof OperationsOrdersIndexController
+     */
     @action setLayoutMode(mode) {
         this.layout = mode;
 
@@ -667,22 +706,57 @@ export default class OperationsOrdersIndexController extends Controller {
         this.universe.trigger('dashboard.layout.changed', mode);
     }
 
-    @action setMapReference({ target }) {
+    /**
+     * Sets the map references for this component.
+     * Extracts the `liveMap` from the `target` object passed in the event and sets it as `this.liveMap`.
+     * Also, sets `target` as `this.leafletMap`.
+     *
+     * @param {Object} event - The event object containing the map references.
+     * @param {Object} event.target - The target map object.
+     * @param {Object} event.target.liveMap - The live map reference.
+     * @action
+     * @memberof OperationsOrdersIndexController
+     */
+    @action setMapReference({ target, target: { liveMap } }) {
         this.leafletMap = target;
+        this.liveMap = liveMap;
     }
 
+    /**
+     * Exports all orders.
+     * @action
+     * @memberof OperationsOrdersIndexController
+     */
     @action exportOrders() {
         this.crud.export('order');
     }
 
+    /**
+     * Redirects to the new order creation page.
+     * @action
+     * @memberof OperationsOrdersIndexController
+     */
     @action createOrder() {
         return this.transitionToRoute('operations.orders.index.new');
     }
 
+    /**
+     * Redirects to the view page of a specific order.
+     * @param {Object} order - The order to view.
+     * @action
+     * @memberof OperationsOrdersIndexController
+     */
     @action viewOrder(order) {
         return this.transitionToRoute('operations.orders.index.view', order);
     }
 
+    /**
+     * Cancels a specific order after confirmation.
+     * @param {Object} order - The order to cancel.
+     * @param {Object} [options={}] - Additional options for the modal.
+     * @action
+     * @memberof OperationsOrdersIndexController
+     */
     @action cancelOrder(order, options = {}) {
         this.modalsManager.confirm({
             title: `Are you sure you wish to cancel this order?`,
@@ -700,6 +774,13 @@ export default class OperationsOrdersIndexController extends Controller {
         });
     }
 
+    /**
+     * Dispatches a specific order after confirmation.
+     * @param {Object} order - The order to dispatch.
+     * @param {Object} [options={}] - Additional options for the modal.
+     * @action
+     * @memberof OperationsOrdersIndexController
+     */
     @action dispatchOrder(order, options = {}) {
         this.modalsManager.confirm({
             title: `Are you sure you want to dispatch this order?`,
@@ -726,6 +807,13 @@ export default class OperationsOrdersIndexController extends Controller {
         });
     }
 
+    /**
+     * Deletes a specific order.
+     * @param {Object} order - The order to delete.
+     * @param {Object} [options={}] - Additional options for deletion.
+     * @action
+     * @memberof OperationsOrdersIndexController
+     */
     @action deleteOrder(order, options = {}) {
         this.crud.delete(order, {
             onSuccess: () => {
@@ -735,6 +823,12 @@ export default class OperationsOrdersIndexController extends Controller {
         });
     }
 
+    /**
+     * Deletes multiple selected orders.
+     * @param {Array} [selected=[]] - Orders selected for deletion.
+     * @action
+     * @memberof OperationsOrdersIndexController
+     */
     @action bulkDeleteOrders(selected = []) {
         selected = selected.length > 0 ? selected : this.table.selectedRows;
 
@@ -747,6 +841,12 @@ export default class OperationsOrdersIndexController extends Controller {
         });
     }
 
+    /**
+     * Cancels multiple selected orders.
+     * @param {Array} [selected=[]] - Orders selected for cancellation.
+     * @action
+     * @memberof OperationsOrdersIndexController
+     */
     @action bulkCancelOrders(selected = []) {
         selected = selected.length > 0 ? selected : this.table.selectedRows;
 
@@ -772,46 +872,20 @@ export default class OperationsOrdersIndexController extends Controller {
         });
     }
 
-    @action applyFilters(columns) {
-        columns.forEach((column) => {
-            // if value is a model only filter by id
-            if (isModel(column.filterValue)) {
-                column.filterValue = column.filterValue.id;
-            }
-
-            // if value is an array of models map to ids
-            if (isArray(column.filterValue) && column.filterValue.every((v) => isModel(v))) {
-                column.filterValue = column.filterValue.map((v) => v.id);
-            }
-
-            // only if filter is active continue
-            if (column.isFilterActive && column.filterValue) {
-                this[column.filterParam || column.valuePath] = column.filterValue;
-            } else {
-                this[column.filterParam || column.valuePath] = undefined;
-                column.isFilterActive = false;
-                column.filterValue = undefined;
-            }
-        });
-
-        this.columns = columns;
-    }
-
-    @action setFilterOptions(valuePath, options) {
-        const updatedColumns = this.columns.map((column) => {
-            if (column.valuePath === valuePath) {
-                column.filterOptions = options;
-            }
-            return column;
-        });
-
-        this.columns = updatedColumns;
-    }
-
+    /**
+     * Triggers when the map container is ready.
+     * @action
+     * @memberof OperationsOrdersIndexController
+     */
     @action onMapContainerReady() {
         this.fetchActiveOrdersCount();
     }
 
+    /**
+     * Fetches the count of active orders.
+     * @action
+     * @memberof OperationsOrdersIndexController
+     */
     @action fetchActiveOrdersCount() {
         this.fetch.get('fleet-ops/metrics/all', { discover: ['orders_in_progress'] }).then((response) => {
             this.activeOrdersCount = response.orders_in_progress;

package/addon/controllers/operations/service-rates/index/edit.js

@@ -34,7 +34,7 @@ export default class OperationsServiceRatesIndexEditController extends Operation
         }
 
         this.isUpdatingServiceRate = true;
-        this.loader.showLoader('.overlay-inner-content', 'Updating service rate...');
+        this.loader.showLoader('.overlay-inner-content', { loadingMessage: 'Updating service rate...' });
 
         try {
             return serviceRate

package/addon/controllers/operations/service-rates/index/new.js

@@ -294,7 +294,7 @@ export default class OperationsServiceRatesIndexNewController extends Controller
         }
 
         this.isCreatingServiceRate = true;
-        this.loader.showLoader('.overlay-inner-content', 'Creating service rate...');
+        this.loader.showLoader('.overlay-inner-content', { loadingMessage: 'Creating service rate...' });
 
         try {
             return serviceRate

package/addon/engine.js

@@ -42,6 +42,12 @@ export default class FleetOpsEngine extends Engine {
 
         // register the driver panel
         universe.createRegistry('component:driver-panel');
+
+        // register vehicle context menu
+        universe.createRegistry('contextmenu:vehicle');
+
+        // register driver context menu
+        universe.createRegistry('contextmenu:driver');
     };
 }
 

package/addon/helpers/is-visibility-control-visible.js

@@ -0,0 +1,18 @@
+import { helper } from '@ember/component/helper';
+import { isNone } from '@ember/utils';
+
+/**
+ * Helper function to determine if a visibility control is set to true.
+ *
+ * @param {Array} params - An array containing the control object and the name of the control.
+ * @returns {boolean} - True if the control is set to true, otherwise false.
+ */
+export default helper(function isVisibilityControlVisible([control, name]) {
+    // Check if an object with visibilityControls is passed
+    if (!isNone(control) && !isNone(control.visibilityControls)) {
+        return control.visibilityControls[name] === true;
+    }
+
+    // Check if control property directly exists and is true
+    return !isNone(control) && control[name] === true;
+});

package/addon/routes/application.js

@@ -7,7 +7,7 @@ export default class ApplicationRoute extends Route {
 
     loading(transition) {
         const resourceName = this.getResouceName(transition);
-        this.loader.showOnInitialTransition(transition, 'section.next-view-section', resourceName ? `Loading ${resourceName}...` : `Loading...`);
+        this.loader.showOnInitialTransition(transition, 'section.next-view-section', { loadingMessage: resourceName ? `Loading ${resourceName}...` : `Loading...` });
     }
 
     model() {

package/addon/routes/home.js

@@ -11,7 +11,7 @@ export default class HomeRoute extends Route {
     @service loader;
 
     @action loading(transition) {
-        const loader = this.loader.show(`Loading FleetOps...`);
+        const loader = this.loader.show({ loadingMessage: `Loading Fleet-Ops...` });
 
         transition.finally(() => {
             this.loader.removeLoader(loader);

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

@@ -1,8 +1,13 @@
 import Route from '@ember/routing/route';
 import { inject as service } from '@ember/service';
+
 export default class ManagementDriversIndexDetailsRoute extends Route {
     @service store;
 
+    queryParams = {
+        view: { refreshModel: false },
+    };
+
     model({ public_id }) {
         return this.store.findRecord('driver', public_id);
     }

package/addon/routes/operations/orders/index/view.js

@@ -8,8 +8,10 @@ export default class OperationsOrdersIndexViewRoute extends Route {
     @service store;
     @service socket;
 
-    @action willTransition() {
-        if (this.controller) {
+    @action willTransition(transition) {
+        const shouldReset = typeof transition.to.name === 'string' && !transition.to.name.includes('operations.orders');
+
+        if (this.controller && shouldReset) {
             this.controller.resetView();
         }
     }

package/addon/routes/operations/orders/index.js

@@ -28,7 +28,11 @@ export default class OperationsOrdersIndexRoute extends Route {
     };
 
     @action willTransition(transition) {
-        this.controller?.resetView(transition);
+        const shouldReset = typeof transition.to.name === 'string' && !transition.to.name.includes('operations.orders');
+
+        if (this.controller && shouldReset) {
+            this.controller.resetView(transition);
+        }
     }
 
     @action model(params) {

package/addon/routes/operations/service-rates/index.js

@@ -23,7 +23,7 @@ export default class OperationsServiceRatesIndexRoute extends Route {
      * @param {Transition} transition
      */
     @action loading(transition) {
-        this.loader.showOnInitialTransition(transition, 'section.next-view-section', 'Loading service rates...');
+        this.loader.showOnInitialTransition(transition, 'section.next-view-section', { loadingMessage: 'Loading service rates...' });
     }
 
     /**

package/addon/routes/operations/zones/index.js

@@ -16,7 +16,7 @@ export default class OperationsZonesIndexRoute extends Route {
      * @param {Transition} transition
      */
     @action loading(transition) {
-        this.loader.showOnInitialTransition(transition, 'section.next-view-section', 'Loading zones...');
+        this.loader.showOnInitialTransition(transition, 'section.next-view-section', { loadingMessage: 'Loading zones...' });
     }
 
     model() {

package/addon/services/context-panel.js

@@ -0,0 +1,173 @@
+import Service from '@ember/service';
+import { tracked } from '@glimmer/tracking';
+import { action } from '@ember/object';
+import getModelName from '@fleetbase/ember-core/utils/get-model-name';
+
+/**
+ * Service for managing the state and interactions of the context panel.
+ *
+ * @class ContextPanelService
+ * @memberof @fleetbase/fleetops
+ * @extends Service
+ */
+export default class ContextPanelService extends Service {
+    /**
+     * Registry mapping model names to their corresponding component details.
+     * @type {Object}
+     */
+    registry = {
+        driver: {
+            viewing: {
+                component: 'driver-panel',
+                componentArguments: [{ isResizable: true }, { width: '600px' }],
+            },
+            editing: {
+                component: 'driver-form-panel',
+                componentArguments: [{ isResizable: true }, { width: '600px' }],
+            },
+        },
+        vehicle: {
+            viewing: {
+                component: 'vehicle-panel',
+                componentArguments: [{ isResizable: true }, { width: '600px' }],
+            },
+            editing: {
+                component: 'vehicle-form-panel',
+                componentArguments: [{ isResizable: true }, { width: '600px' }],
+            },
+        },
+    };
+
+    /**
+     * The current context or model object.
+     * @type {Object}
+     * @tracked
+     */
+    @tracked currentContext;
+
+    /**
+     * The current registry configuration for the current context.
+     * @type {Object}
+     * @tracked
+     */
+    @tracked currentContextRegistry;
+
+    /**
+     * Arguments for the current context component.
+     * @type {Object}
+     * @tracked
+     */
+    @tracked currentContextComponentArguments = {};
+
+    /**
+     * Additional options for controlling the context.
+     * @type {Object}
+     * @tracked
+     */
+    @tracked contextOptions = {};
+
+    /**
+     * Focuses on a given model and intent.
+     *
+     * @method
+     * @param {Object} model - The model to focus on.
+     * @param {String} [intent='viewing'] - The type of intent ('viewing' or 'editing').
+     * @action
+     */
+    @action focus(model, intent = 'viewing', options = {}) {
+        const modelName = getModelName(model);
+        const registry = this.registry[modelName];
+
+        if (registry && registry[intent]) {
+            this.currentContext = model;
+            this.currentContextRegistry = registry[intent];
+            this.currentContextComponentArguments = this.createDynamicArgsFromRegistry(registry[intent], model);
+            this.contextOptions = options;
+        }
+    }
+
+    /**
+     * Clears the current context and associated details.
+     *
+     * @method
+     * @action
+     */
+    @action clear() {
+        this.currentContext = null;
+        this.currentContextRegistry = null;
+        this.currentContextComponentArguments = {};
+        this.contextOptions = {};
+    }
+
+    /**
+     * Changes the intent for the current context.
+     *
+     * @method
+     * @param {String} intent - The new intent.
+     * @action
+     */
+    @action changeIntent(intent) {
+        if (this.currentContext) {
+            return this.focus(this.currentContext, intent);
+        }
+    }
+
+    /**
+     * Sets an option key-value pair.
+     *
+     * @method
+     * @param {String} key - The option key.
+     * @param {*} value - The option value.
+     */
+    setOption(key, value) {
+        this.contextOptions = {
+            ...this.contextOptions,
+            [key]: value,
+        };
+    }
+
+    /**
+     * Retrieves the value of an option key.
+     *
+     * @method
+     * @param {String} key - The option key.
+     * @param {*} [defaultValue=null] - The default value to return if the key is not found.
+     * @returns {*}
+     */
+    getOption(key, defaultValue = null) {
+        const value = this.contextOptions[key];
+
+        if (value === undefined) {
+            return defaultValue;
+        }
+
+        return value;
+    }
+
+    /**
+     * Generates dynamic arguments for a given registry and model.
+     *
+     * @method
+     * @param {Object} registry - The registry details for a given model.
+     * @param {Object} model - The model object.
+     * @returns {Object} The dynamic arguments.
+     */
+    createDynamicArgsFromRegistry(registry, model) {
+        // Generate dynamic arguments object
+        const dynamicArgs = {};
+        const componentArguments = registry.componentArguments || [];
+
+        componentArguments.forEach((arg, index) => {
+            if (typeof arg === 'string') {
+                dynamicArgs[arg] = model[arg]; // Map string arguments to model properties
+            } else if (typeof arg === 'object' && arg !== null) {
+                Object.assign(dynamicArgs, arg);
+            } else {
+                // Handle other types of arguments as needed
+                dynamicArgs[`arg${index}`] = arg;
+            }
+        });
+
+        return dynamicArgs;
+    }
+}