@fleetbase/storefront-engine 0.1.6 → 0.1.8

package/addon/controllers/networks/index/network/index.js

@@ -3,27 +3,103 @@ import { tracked } from '@glimmer/tracking';
 import { inject as service } from '@ember/service';
 import { alias } from '@ember/object/computed';
 import { action } from '@ember/object';
-import getPodMethods from '@fleetbase/console/utils/get-pod-methods';
+import getPodMethods from '@fleetbase/ember-core/utils/get-pod-methods';
 
+/**
+ * NetworksIndexNetworkIndexController
+ *
+ * This controller handles the logic for managing networks, gateways, and notification channels.
+ *
+ * @class NetworksIndexNetworkIndexController
+ * @extends Controller
+ */
 export default class NetworksIndexNetworkIndexController extends Controller {
+    /**
+     * Controller for managing gateways.
+     *
+     * @property {Controller} gatewaysController
+     */
     @controller('settings.gateways') gatewaysController;
+
+    /**
+     * Controller for managing notifications.
+     *
+     * @property {Controller} notificationsController
+     */
     @controller('settings.notifications') notificationsController;
+
+    /**
+     * Notifications service to handle notification logic.
+     *
+     * @property {Service} notifications
+     */
     @service notifications;
+
+    /**
+     * Fetch service to handle file uploads and other network requests.
+     *
+     * @property {Service} fetch
+     */
     @service fetch;
+
+    /**
+     * Proof of delivery methods.
+     *
+     * @property {Array} podMethods
+     */
     @tracked podMethods = getPodMethods();
+
+    /**
+     * Loading state, indicating whether a network request is in progress.
+     *
+     * @property {Boolean} isLoading
+     */
     @tracked isLoading = false;
+
+    /**
+     * Alias for model.gateways, representing the gateways associated with the network.
+     *
+     * @property {Array} gateways
+     */
     @alias('model.gateways') gateways;
+
+    /**
+     * Alias for model.notification_channels, representing the notification channels associated with the network.
+     *
+     * @property {Array} channels
+     */
     @alias('model.notification_channels') channels;
 
+    /**
+     * Save network settings.
+     *
+     * @method saveSettings
+     * @public
+     */
     @action saveSettings() {
         this.isLoading = true;
 
-        this.model.save().then(() => {
-            this.notifications.success('Changes saved');
-            this.isLoading = false;
-        });
+        this.model
+            .save()
+            .then(() => {
+                this.notifications.success('Changes to network saved.');
+            })
+            .catch((error) => {
+                this.notifications.serverError(error);
+            })
+            .finally(() => {
+                this.isLoading = false;
+            });
     }
 
+    /**
+     * Upload a file.
+     *
+     * @method uploadFile
+     * @param {String} type - Type of the file.
+     * @param {File} file - File to upload.
+     * @public
+     */
     @action uploadFile(type, file) {
         const prefix = type.replace('storefront_', '');
 
@@ -32,23 +108,29 @@ export default class NetworksIndexNetworkIndexController extends Controller {
             {
                 path: `uploads/storefront/${this.model.id}/${type}`,
                 key_uuid: this.model.id,
-                key_type: `network:storefront`,
+                key_type: `storefront:network`,
                 type,
             },
             (uploadedFile) => {
                 this.model.setProperties({
                     [`${prefix}_uuid`]: uploadedFile.id,
-                    [`${prefix}_url`]: uploadedFile.s3url,
+                    [`${prefix}_url`]: uploadedFile.url,
                     [prefix]: uploadedFile,
                 });
             }
         );
     }
 
+    /**
+     * Create a new payment gateway.
+     *
+     * @method createGateway
+     * @public
+     */
     @action createGateway() {
         const gateway = this.store.createRecord('gateway', {
             owner_uuid: this.model.id,
-            owner_type: 'network:storefront',
+            owner_type: 'storefront:network',
         });
 
         this.editGateway(gateway, {
@@ -69,6 +151,14 @@ export default class NetworksIndexNetworkIndexController extends Controller {
         });
     }
 
+    /**
+     * Edit a payment gateway.
+     *
+     * @method editGateway
+     * @param {Object} gateway - The gateway object to edit.
+     * @param {Object} [options={}] - Optional parameters for editing the gateway.
+     * @public
+     */
     @action editGateway(gateway, options = {}) {
         if (options === null) {
             options = {};
@@ -87,14 +177,26 @@ export default class NetworksIndexNetworkIndexController extends Controller {
         return this.gatewaysController.editGateway(gateway, options);
     }
 
+    /**
+     * Delete a payment gateway.
+     *
+     * @method deleteGateway
+     * @public
+     */
     @action deleteGateway() {
         return this.gatewaysController.deleteGateway(...arguments);
     }
 
+    /**
+     * Create a new notification channel.
+     *
+     * @method createChannel
+     * @public
+     */
     @action createChannel() {
         const channel = this.store.createRecord('notification-channel', {
             owner_uuid: this.model.id,
-            owner_type: 'network:storefront',
+            owner_type: 'storefront:network',
         });
 
         this.editChannel(channel, {
@@ -115,6 +217,14 @@ export default class NetworksIndexNetworkIndexController extends Controller {
         });
     }
 
+    /**
+     * Edit a notification channel.
+     *
+     * @method editChannel
+     * @param {Object} channel - The channel object to edit.
+     * @param {Object} [options={}] - Optional parameters for editing the channel.
+     * @public
+     */
     @action editChannel(channel, options = {}) {
         if (options === null) {
             options = {};
@@ -133,10 +243,24 @@ export default class NetworksIndexNetworkIndexController extends Controller {
         return this.notificationsController.editChannel(channel, options);
     }
 
+    /**
+     * Delete a notification channel.
+     *
+     * @method deleteChannel
+     * @public
+     */
     @action deleteChannel() {
         return this.notificationsController.deleteChannel(...arguments);
     }
 
+    /**
+     * Make an alertable action.
+     *
+     * @method makeAlertable
+     * @param {String} reason - Reason for the alert.
+     * @param {Array} models - Models associated with the alert.
+     * @public
+     */
     @action makeAlertable(reason, models) {
         if (!this.model.alertable || !this.model.alertable?.length) {
             this.model.set('alertable', {});