@fleetbase/ember-core 0.2.1 → 0.2.3

package/addon/services/universe.js

@@ -29,6 +29,10 @@ export default class UniverseService extends Service.extend(Evented) {
         menuItems: A([]),
         menuPanels: A([]),
     };
+    @tracked dashboardWidgets = {
+        defaultWidgets: A([]),
+        widgets: A([]),
+    };
 
     /**
      * Computed property that returns all administrative menu items.
@@ -264,6 +268,42 @@ export default class UniverseService extends Service.extend(Evented) {
         return this;
     }
 
+    /**
+     * Creates multiple registries from a given array of registries. Each registry can be either a string or an array.
+     * If a registry is an array, it expects two elements: the registry name (string) and registry options (object).
+     * If a registry is a string, only the registry name is needed.
+     *
+     * The function iterates over each element in the `registries` array and creates a registry using the `createRegistry` method.
+     * It supports two types of registry definitions:
+     * 1. Array format: [registryName, registryOptions] - where registryOptions is an optional object.
+     * 2. String format: "registryName" - in this case, only the name is provided and the registry is created with default options.
+     *
+     * @param {Array} registries - An array of registries to be created. Each element can be either a string or an array.
+     * @action
+     * @memberof YourComponentOrClassName
+     */
+    @action createRegistries(registries = []) {
+        if (!isArray(registries)) {
+            throw new Error('`createRegistries()` method must take an array.');
+        }
+
+        for (let i = 0; i < registries.length; i++) {
+            const registry = registries[i];
+
+            if (isArray(registry) && registry.length === 2) {
+                let registryName = registry[0];
+                let registryOptions = registry[1] ?? {};
+
+                this.createRegistry(registryName, registryOptions);
+                continue;
+            }
+
+            if (typeof registry === 'string') {
+                this.createRegistry(registry);
+            }
+        }
+    }
+
     /**
      * Triggers an event on for a universe registry.
      *
@@ -656,6 +696,115 @@ export default class UniverseService extends Service.extend(Evented) {
         this.registerMenuPanel('settings', title, items, options);
     }
 
+    /**
+     * Registers a new dashboard widget in the universe service.
+     *
+     * @method registerDashboardWidgets
+     * @public
+     * @memberof UniverseService
+     * @param {Object} widget - The widget object containing name, component, gridOptions, and options.
+     *   @property {String} name - The name of the widget.
+     *   @property {String} icon - The iron of the widget.
+     *   @property {Function} component - The component associated with the widget.
+     *   @property {Object} gridOptions - The grid options for the widget.
+     *   @property {Object} options - Additional options for the widget.
+     */
+    registerDashboardWidgets(widget) {
+        if (isArray(widget)) {
+            widget.forEach((w) => this.registerDashboardWidgets(w));
+            return;
+        }
+
+        const newWidget = this._createDashboardWidget(widget);
+        this.dashboardWidgets.widgets.pushObject(newWidget);
+        this.trigger('widget.registered', newWidget);
+    }
+
+    /**
+     * Retrieves the widgets registered in the universe service.
+     *
+     * @method getDashboardWidgets
+     * @public
+     * @memberof UniverseService
+     * @returns {Array} An array of registered widgets
+     */
+    getDashboardWidgets() {
+        return this.dashboardWidgets.widgets;
+    }
+
+    /**
+     * Registers a new dashboard widget in the universe service.
+     *
+     * @method registerDefaultDashboardWidgets
+     * @public
+     * @memberof UniverseService
+     * @param {Object} widget - The widget object containing name, component, gridOptions, and options.
+     *   @property {String} name - The name of the widget.
+     *   @property {String} icon - The iron of the widget.
+     *   @property {Function} component - The component associated with the widget.
+     *   @property {Object} gridOptions - The grid options for the widget.
+     *   @property {Object} options - Additional options for the widget.
+     */
+    registerDefaultDashboardWidgets(widget) {
+        if (isArray(widget)) {
+            widget.forEach((w) => this.registerDefaultDashboardWidgets(w));
+            return;
+        }
+
+        const newWidget = this._createDashboardWidget(widget);
+        this.dashboardWidgets.defaultWidgets.pushObject(newWidget);
+        this.trigger('widget.registered', newWidget);
+    }
+
+    /**
+     * Retrieves the widgets registered in the universe service.
+     *
+     * @method getDefaultDashboardWidgets
+     * @public
+     * @memberof UniverseService
+     * @returns {Array} An array of registered widgets
+     */
+    getDefaultDashboardWidgets() {
+        return this.dashboardWidgets.defaultWidgets;
+    }
+
+    /**
+     * Creates a dashboard widget object
+     *
+     * @param {Object} widget
+     * @return {Widgetobject}
+     * @memberof UniverseService
+     */
+    _createDashboardWidget(widget) {
+        // Extract properties from the widget object
+        let { did, name, description, icon, component, grid_options, options } = widget;
+
+        // If component is a definition register to host application
+        if (typeof component === 'function') {
+            const owner = getOwner(this);
+
+            if (owner) {
+                owner.register(`component:${component.name}`, component);
+
+                // Update component name
+                component = component.name;
+            }
+        }
+
+        // Create a new widget object with the extracted properties
+        const newWidget = {
+            did,
+            name,
+            description,
+            icon,
+            component,
+            grid_options,
+            options,
+        };
+
+        return newWidget;
+    }
+
     /**
      * Registers a new settings menu item.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fleetbase/ember-core",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Provides all the core services, decorators and utilities for building a Fleetbase extension for the Console.",
   "keywords": [
     "fleetbase-core",