@fleetbase/fleetops-engine 0.6.70 → 0.6.72

package/addon/services/order-presentation.js

@@ -0,0 +1,129 @@
+import Service, { inject as service } from '@ember/service';
+import { isArray } from '@ember/array';
+
+/**
+ * Resolves an extension-owned presentation profile for an order.
+ *
+ * A profile lets an extension compose the order form, details and actions for orders
+ * whose Order Config opts in via `order_config.meta.presentation_profile`. When no
+ * profile applies every consumer renders the standard Fleet-Ops presentation.
+ *
+ * Extensions register profiles through the registry service so registration does not
+ * depend on the Fleet-Ops engine having loaded:
+ *
+ *   registryService.register('fleet-ops:order-presentation', 'profiles', 'my-profile', {
+ *       id: 'my-profile',
+ *       isEnabled() { return true; },
+ *       form: { sections: ['details', 'route', new ExtensionComponent('@org/engine', 'my-section'), 'notes'] },
+ *       details: { sections: [...] },
+ *       hidden: { fields: ['driver', 'dispatch'], actions: ['dispatch', 'assign-driver'] },
+ *       prepare(order) {},
+ *   });
+ *
+ * Native section names — form: details, route, payload, service-rate, notes, documents,
+ * orchestrator-constraints, metadata, custom-fields. Details: activity, detail, custom-fields,
+ * purchase-rate, tracking, proof, notes, integrated-vendor-details, route, payload,
+ * documents, comments, metadata.
+ *
+ * `hidden.actions` takes built-in action ids, the same ids the order table and details use in
+ * the resource view registries: dispatch, assign-driver, unassign-driver, edit-order-details,
+ * update-activity, view-label, listen-to-socket-channel, view-metadata, cancel, delete.
+ */
+export const ORDER_PRESENTATION_REGISTRY = 'fleet-ops:order-presentation';
+
+export default class OrderPresentationService extends Service {
+    @service('universe/registry-service') registryService;
+
+    get profiles() {
+        return this.registryService.getRegistry(ORDER_PRESENTATION_REGISTRY, 'profiles') ?? [];
+    }
+
+    /**
+     * Returns the presentation profile applying to an order or order config, or null.
+     *
+     * @param {Object} orderOrConfig an order (with `order_config`) or an order-config
+     * @returns {Object|null}
+     */
+    profileFor(orderOrConfig) {
+        const orderConfig = this.#resolveOrderConfig(orderOrConfig);
+        const profileId = orderConfig?.meta?.presentation_profile;
+        if (!profileId) {
+            return null;
+        }
+
+        const profile = this.profiles.find((candidate) => candidate?.id === profileId);
+        if (!profile) {
+            return null;
+        }
+
+        if (typeof profile.isEnabled === 'function' && profile.isEnabled(orderConfig) !== true) {
+            return null;
+        }
+
+        return profile;
+    }
+
+    /**
+     * Returns the ordered sections of a profile surface ("form" or "details").
+     */
+    sectionsFor(profile, surface) {
+        const sections = profile?.[surface]?.sections;
+        return isArray(sections) ? sections : [];
+    }
+
+    /**
+     * Returns renderable section descriptors for a surface ("form" or "details").
+     * Native sections resolve to `order/<surface>/<name>`; anything else is an ExtensionComponent.
+     */
+    renderableSectionsFor(profile, surface) {
+        return this.sectionsFor(profile, surface).map((section, index) => {
+            if (typeof section === 'string') {
+                return { key: `native:${section}`, native: true, name: section, componentName: `order/${surface}/${section}` };
+            }
+
+            return { key: `extension:${section?.path ?? section?.name ?? index}`, native: false, component: section };
+        });
+    }
+
+    /**
+     * Determines if a field or action is hidden by the profile applying to the subject.
+     *
+     * @param {Object} orderOrConfig
+     * @param {String} group "fields" or "actions"
+     * @param {String} key a field key, or a built-in action id
+     */
+    isHidden(orderOrConfig, group, key) {
+        const profile = this.profileFor(orderOrConfig);
+        const hidden = profile?.hidden?.[group];
+        return isArray(hidden) && hidden.includes(key);
+    }
+
+    hiddenFieldsFor(orderOrConfig) {
+        const hidden = this.profileFor(orderOrConfig)?.hidden?.fields;
+        return isArray(hidden) ? hidden : [];
+    }
+
+    /**
+     * Lets the profile normalize an order when it starts to apply (e.g. clear dispatch-only values).
+     */
+    prepare(order) {
+        const profile = this.profileFor(order);
+        if (profile && typeof profile.prepare === 'function') {
+            profile.prepare(order);
+        }
+        return profile;
+    }
+
+    #resolveOrderConfig(orderOrConfig) {
+        if (!orderOrConfig) {
+            return null;
+        }
+
+        // An order-config has a flow; an order references its config.
+        if (orderOrConfig.flow !== undefined && orderOrConfig.order_config === undefined) {
+            return orderOrConfig;
+        }
+
+        return orderOrConfig.order_config ?? null;
+    }
+}

package/addon/services/part-actions.js

@@ -46,6 +46,7 @@ export default class PartActionsService extends ResourceActionService {
         },
         view: (part, options = {}) => {
             return this.resourceContextPanel.open({
+                registry: this.detailsRegistry,
                 part,
                 title: part?.name,
                 header: 'part/panel-header',

package/addon/services/place-actions.js

@@ -52,6 +52,7 @@ export default class PlaceActionsService extends ResourceActionService {
             }
 
             return this.resourceContextPanel.open({
+                registry: this.detailsRegistry,
                 place,
                 title: place?.name ?? place?.street1,
                 actionButtons: [{ icon: 'pencil', permission: 'fleet-ops update place', fn: () => closePanelsThen(this.resourceContextPanel, () => this.panel.edit(place)) }],

package/addon/services/sensor-actions.js

@@ -35,6 +35,7 @@ export default class SensorActionsService extends ResourceActionService {
         },
         view: (sensor) => {
             return this.resourceContextPanel.open({
+                registry: this.detailsRegistry,
                 sensor,
                 header: 'sensor/panel-header',
                 tabs: [

package/addon/services/service-area-actions.js

@@ -41,6 +41,7 @@ export default class ServiceAreaActionsService extends ResourceActionService {
         },
         view: (serviceArea, options = {}) => {
             return this.resourceContextPanel.open({
+                registry: this.detailsRegistry,
                 serviceArea,
                 title: serviceArea?.name,
                 actionButtons: [

package/addon/services/service-rate-actions.js

@@ -51,6 +51,7 @@ export default class ServiceRateActionsService extends ResourceActionService {
         },
         view: (serviceRate) => {
             return this.resourceContextPanel.open({
+                registry: this.detailsRegistry,
                 serviceRate,
                 tabs: [
                     {

package/addon/services/telematic-actions.js

@@ -41,6 +41,7 @@ export default class TelematicActionsService extends ResourceActionService {
         },
         view: (telematic) => {
             return this.resourceContextPanel.open({
+                registry: this.detailsRegistry,
                 telematic,
                 tabs: [
                     {

package/addon/services/trailer-actions.js

@@ -2,9 +2,7 @@ import ResourceActionService, { inject as service } from '@fleetbase/ember-core/
 import leafletIcon from '@fleetbase/ember-core/utils/leaflet-icon';
 import config from 'ember-get-config';
 import { action } from '@ember/object';
-import { isArray } from '@ember/array';
-import { dasherize } from '@ember/string';
-import { PANEL_DEFAULTS, closePanelsThen } from '../utils/context-panel';
+import { PANEL_DEFAULTS, closePanelsThen, registeredPanelTabs } from '../utils/context-panel';
 
 /**
  * Trailer resource actions.
@@ -32,17 +30,8 @@ export default class TrailerActionsService extends ResourceActionService {
     }
 
     get registeredTabs() {
-        const registeredTabs = this.menuService.getMenuItems('fleet-ops:component:trailer:details');
-
-        return (isArray(registeredTabs) ? registeredTabs : [])
-            .map((tab) => {
-                delete tab.route;
-                if (!tab.key) {
-                    tab.key = tab.id ?? dasherize(tab.label ?? tab.title);
-                }
-                return tab;
-            })
-            .filter((tab) => !tab.component);
+        // Copies, so the shared registry items keep the \`route\` their routed details view needs.
+        return registeredPanelTabs(this.menuService, 'fleet-ops:component:trailer:details');
     }
 
     get panelTabs() {
@@ -132,6 +121,7 @@ export default class TrailerActionsService extends ResourceActionService {
             const service = this;
 
             return this.resourceContextPanel.open({
+                registry: this.detailsRegistry,
                 trailer,
                 header: 'trailer/panel-header',
                 actionButtons: [

package/addon/services/vehicle-actions.js

@@ -2,9 +2,7 @@ import ResourceActionService, { inject as service } from '@fleetbase/ember-core/
 import leafletIcon from '@fleetbase/ember-core/utils/leaflet-icon';
 import config from 'ember-get-config';
 import { action } from '@ember/object';
-import { isArray } from '@ember/array';
-import { dasherize } from '@ember/string';
-import { PANEL_DEFAULTS, closePanelsThen } from '../utils/context-panel';
+import { PANEL_DEFAULTS, closePanelsThen, registeredPanelTabs } from '../utils/context-panel';
 
 export default class VehicleActionsService extends ResourceActionService {
     @service('universe/menu-service') menuService;
@@ -15,16 +13,8 @@ export default class VehicleActionsService extends ResourceActionService {
     @service issueActions;
 
     get registeredTabs() {
-        const registeredTabs = this.menuService.getMenuItems('fleet-ops:component:vehicle:details');
-        return (isArray(registeredTabs) ? registeredTabs : [])
-            .map((tab) => {
-                delete tab.route;
-                if (!tab.key) {
-                    tab.key = tab.id ?? dasherize(tab.label ?? tab.title);
-                }
-                return tab;
-            })
-            .filter((tab) => !tab.component);
+        // Copies, so the shared registry items keep the \`route\` their routed details view needs.
+        return registeredPanelTabs(this.menuService, 'fleet-ops:component:vehicle:details');
     }
 
     get panelTabs() {
@@ -148,6 +138,7 @@ export default class VehicleActionsService extends ResourceActionService {
             const service = this;
 
             return this.resourceContextPanel.open({
+                registry: this.detailsRegistry,
                 vehicle,
                 header: 'vehicle/panel-header',
                 actionButtons: [

package/addon/services/vendor-actions.js

@@ -43,6 +43,7 @@ export default class VendorActionsService extends ResourceActionService {
         },
         view: (vendor, options = {}) => {
             return this.resourceContextPanel.open({
+                registry: this.detailsRegistry,
                 vendor,
                 title: vendor?.name,
                 header: 'vendor/panel-header',

package/addon/services/work-order-actions.js

@@ -41,6 +41,7 @@ export default class WorkOrderActionsService extends ResourceActionService {
         },
         view: (workOrder, options = {}) => {
             return this.resourceContextPanel.open({
+                registry: this.detailsRegistry,
                 workOrder,
                 title: workOrder?.code ?? workOrder?.subject,
                 header: 'work-order/panel-header',

package/addon/services/zone-actions.js

@@ -36,6 +36,7 @@ export default class ZoneActionsService extends ResourceActionService {
         },
         view: (zone, options = {}) => {
             return this.resourceContextPanel.open({
+                registry: this.detailsRegistry,
                 zone,
                 title: zone?.name,
                 actionButtons: [