[NAE-2116] Frontend remote configuration

- documentation

Author: camperko

projects/netgrif-components-core/src/lib/configuration/application-configuration.ts

@@ -1,5 +1,29 @@
 import {NetgrifApplicationEngine} from '../../commons/schema';
 
+/**
+ * Interface representing the configuration settings for an application.
+ * This configuration defines the essential properties required to initialize
+ * or operate an application within a specific context or environment.
+ *
+ * @interface ApplicationConfiguration
+ *
+ * @property application
+ * Specifies the name or identifier of the application.
+ *
+ * @property type
+ * Indicates the type or category of the application.
+ *
+ * @property [resolve_configuration]
+ * Optional flag that determines whether the configuration should
+ * be resolved dynamically.
+ *
+ * @property [gateway_url]
+ * Optional URL used as the gateway endpoint for the application's communication.
+ *
+ * @property [properties]
+ * Properties of the application representing the whole application configuration
+ * that is typically located inside nae.json.
+ */
 export interface ApplicationConfiguration {
     application: string;
     type: string;

projects/netgrif-components-core/src/lib/configuration/configuration.service.ts

@@ -259,6 +259,13 @@ export abstract class ConfigurationService {
         return config.providers.auth.address + config.providers.auth.endpoints[endpointKey];
     }
 
+    /**
+     * Loads the configuration for the application by fetching data from the resource provider
+     * and initializes the application settings based on the fetched configuration.
+     *
+     * @return {Promise<any>} A promise that resolves with the fetched configuration or returns null
+     * if the configuration resolution is not enabled.
+     */
     public loadConfiguration(): Promise<any> {
         if (!this.APPLICATION_CONFIG.resolve_configuration) {
             return null;

projects/netgrif-components-core/src/lib/utility/load-configuration.ts

@@ -1,6 +1,12 @@
 import {ConfigurationService} from '../configuration/configuration.service';
 
 
+/**
+ * Loads the configuration from admin node using the provided configuration service.
+ *
+ * @param {ConfigurationService} configurationService - The service responsible for loading the configuration.
+ * @return {Function} - A function that, when called, returns a Promise resolving to the loaded configuration or void.
+ */
 export function loadConfiguration(configurationService: ConfigurationService): () => Promise<any> | void {
     return (): Promise<any> => {
         return configurationService.loadConfiguration();