@rxap/config 19.2.0-dev.3 → 19.3.0-dev.0

package/compodoc/interfaces/ConfigLoadOptions.html

@@ -189,6 +189,13 @@
                                             fromUrls
                                         </a>
                                 </li>
+                                <li>
+                                            <span class="modifier">Optional</span>
+                                        <a href="#order" 
+>
+                                            order
+                                        </a>
+                                </li>
                                 <li>
                                             <span class="modifier">Optional</span>
                                         <a href="#schema" 
@@ -506,6 +513,53 @@ If true, uses <code>location.hostname</code>. If a string, uses that domain.</p>
 
 
 
+                        </tbody>
+                    </table>
+                    <table class="table table-sm table-bordered">
+                        <tbody>
+                                <tr>
+                                    <td class="col-md-4">
+                                        <a name="order"></a>
+                                        <span class="name "><b>order</b>
+                                            <a href="#order">
+                                                <span class="icon ion-ios-link"></span>
+                                            </a>
+                                        </span>
+                                    </td>
+                                </tr>
+                                <tr>
+                                    <td class="col-md-4">
+                                        <code>order:         <code><a href="../interfaces/Config.html" target="_self" >ConfigLoadMethod[]</a></code>
+</code>
+                                    </td>
+                                </tr>
+
+
+                                    <tr>
+                                        <td class="col-md-4">
+                                            <i>Type : </i>        <code><a href="../interfaces/Config.html" target="_self" >ConfigLoadMethod[]</a></code>
+
+                                        </td>
+                                    </tr>
+
+                                    <tr>
+                                        <td class="col-md-4">
+                                            <i>Optional</i>
+                                        </td>
+                                    </tr>
+
+
+
+
+                            <tr>
+                                <td class="col-md-4">
+                                    <div class="io-description"><p>Defines the order and subset of config sources to load.
+If not specified, defaults to: [FROM_URLS, FROM_LOCAL_STORAGE, FROM_URL_PARAM, FROM_CID]</p>
+<p>Note: static config is always merged first, and Overwrites are always merged last.
+Note: fromDns is not a source itself - it resolves the CID for FROM_CID.</p>
+</div>
+                                </td>
+                            </tr>
                         </tbody>
                     </table>
                     <table class="table table-sm table-bordered">
@@ -699,6 +753,13 @@ export enum ConfigLoadingStrategy {
   FIFO &#x3D; &#x27;fifo&#x27;,
 }
 
+export enum ConfigLoadMethod {
+  FROM_URLS &#x3D; &#x27;fromUrls&#x27;,
+  FROM_LOCAL_STORAGE &#x3D; &#x27;fromLocalStorage&#x27;,
+  FROM_URL_PARAM &#x3D; &#x27;fromUrlParam&#x27;,
+  FROM_CID &#x3D; &#x27;fromCid&#x27;,
+}
+
 export interface ConfigLoadOptions {
   fromUrlParam?: string | boolean;
   fromUrls?: boolean;
@@ -722,6 +783,14 @@ export interface ConfigLoadOptions {
   fetchCidContent?: (cid: string, path?: string) &#x3D;&gt; Promise&lt;Blob | null&gt;;
   dnsServers?: string[];
   strategy?: ConfigLoadingStrategy;
+  /**
+   * Defines the order and subset of config sources to load.
+   * If not specified, defaults to: [FROM_URLS, FROM_LOCAL_STORAGE, FROM_URL_PARAM, FROM_CID]
+   *
+   * Note: static config is always merged first, and Overwrites are always merged last.
+   * Note: fromDns is not a source itself - it resolves the CID for FROM_CID.
+   */
+  order?: ConfigLoadMethod[];
 }
 
 @Injectable({
@@ -794,81 +863,60 @@ export class ConfigService&lt;Config extends Record&lt;string, any&gt; &#x3D; Re
       }
     }
 
+    // Always merge static config first
     config &#x3D; deepMerge(config, options?.static ?? {});
-    let done &#x3D; false;
 
-    if (!done &amp;&amp; options?.fromUrls !&#x3D;&#x3D; false) {
-      try {
-        config &#x3D; deepMerge(config, await this.loadConfigFromUrls(options, environment));
-        if (options.strategy &#x3D;&#x3D;&#x3D; ConfigLoadingStrategy.FIFO) {
-          done &#x3D; true;
-        }
-      } catch (error: any) {
-        if (options.strategy !&#x3D;&#x3D; ConfigLoadingStrategy.FIFO) {
-          console.error(&#x27;Could not load config from urls&#x27;, error);
-          throw error;
-        } else {
-          console.warn(&#x27;Could not load config from urls: &#x27; + error.message + &#x27;. Will try next strategy.&#x27;);
-        }
-      }
-    }
+    // Determine the order of config sources to load
+    const order &#x3D; options.order ?? [
+      ConfigLoadMethod.FROM_URLS,
+      ConfigLoadMethod.FROM_LOCAL_STORAGE,
+      ConfigLoadMethod.FROM_URL_PARAM,
+      ConfigLoadMethod.FROM_CID,
+    ];
 
-    if (!done &amp;&amp; options?.fromLocalStorage !&#x3D;&#x3D; false) {
-      try {
-        config &#x3D; deepMerge(config, this.loadConfigFromLocalStorage(options));
-        if (options.strategy &#x3D;&#x3D;&#x3D; ConfigLoadingStrategy.FIFO) {
-          done &#x3D; true;
-        }
-      } catch (error: any) {
-        if (options.strategy !&#x3D;&#x3D; ConfigLoadingStrategy.FIFO) {
-          console.error(&#x27;Could not load config from local storage&#x27;, error);
-          throw error;
-        } else {
-          console.warn(&#x27;Could not load config from local storage: &#x27; + error.message + &#x27;. Will try next strategy.&#x27;);
-        }
-      }
+    // If fromDns is enabled and FROM_CID is in the order, resolve CID first
+    if (options.fromDns &amp;&amp; order.includes(ConfigLoadMethod.FROM_CID) &amp;&amp; !options.fromCid) {
+      await this.loadConfigFromDns(options as any);
     }
 
-    if (!done &amp;&amp; options?.fromUrlParam) {
-      try {
-        config &#x3D; deepMerge(config, this.loadConfigFromUrlParam(options as any));
-        if (options.strategy &#x3D;&#x3D;&#x3D; ConfigLoadingStrategy.FIFO) {
-          done &#x3D; true;
-        }
-      } catch (error: any) {
-        if (options.strategy !&#x3D;&#x3D; ConfigLoadingStrategy.FIFO) {
-          console.error(&#x27;Could not load config from url param&#x27;, error);
-          throw error;
-        } else {
-          console.warn(&#x27;Could not load config from url param: &#x27; + error.message + &#x27;. Will try next strategy.&#x27;);
-        }
+    // Load configs from sources in the specified order
+    let done &#x3D; false;
+    for (const method of order) {
+      if (done) {
+        break;
       }
-    }
 
-    if (!done &amp;&amp; options?.fromDns) {
-      await this.loadConfigFromDns(options as any);
-    }
+      // Check if the source is enabled
+      if (!this.isSourceEnabled(options, method)) {
+        continue;
+      }
 
-    if (!done &amp;&amp; options?.fromCid) {
       try {
-        config &#x3D; deepMerge(config, await this.loadConfigFromCid(options as any));
+        const loadedConfig &#x3D; await this.loadConfigFromMethod(method, options, environment);
+        if (loadedConfig) {
+          config &#x3D; deepMerge(config, loadedConfig);
+        }
+
+        // If using FIFO strategy, stop after first successful load
         if (options.strategy &#x3D;&#x3D;&#x3D; ConfigLoadingStrategy.FIFO) {
           done &#x3D; true;
         }
       } catch (error: any) {
+        const methodName &#x3D; this.getMethodName(method);
         if (options.strategy !&#x3D;&#x3D; ConfigLoadingStrategy.FIFO) {
-          console.error(&#x27;Could not load config from cid&#x27;, error);
+          console.error(&#x60;Could not load config from ${methodName}&#x60;, error);
           throw error;
         } else {
-          console.warn(&#x27;Could not load config from cid: &#x27; + error.message + &#x27;. Will try next strategy.&#x27;);
+          console.warn(&#x60;Could not load config from ${methodName}: ${error.message}. Will try next strategy.&#x60;);
         }
       }
     }
 
-    if (!done) {
+    if (!done &amp;&amp; order.length &gt; 0) {
       console.warn(&#x27;No config loading strategy succeeded. Using default config.&#x27;);
     }
 
+    // Always merge overwrites last
     config &#x3D; deepMerge(config, this.Overwrites);
 
     console.debug(&#x27;app config&#x27;, config);
@@ -876,6 +924,55 @@ export class ConfigService&lt;Config extends Record&lt;string, any&gt; &#x3D; Re
     this.Config &#x3D; config;
   }
 
+  private static isSourceEnabled(options: ConfigLoadOptions, method: ConfigLoadMethod): boolean {
+    switch (method) {
+      case ConfigLoadMethod.FROM_URLS:
+        return options.fromUrls !&#x3D;&#x3D; false;
+      case ConfigLoadMethod.FROM_LOCAL_STORAGE:
+        return options.fromLocalStorage !&#x3D;&#x3D; false;
+      case ConfigLoadMethod.FROM_URL_PARAM:
+        return !!options.fromUrlParam;
+      case ConfigLoadMethod.FROM_CID:
+        return !!options.fromCid;
+      default:
+        return false;
+    }
+  }
+
+  private static async loadConfigFromMethod(
+    method: ConfigLoadMethod,
+    options: ConfigLoadOptions,
+    environment?: Environment,
+  ): Promise&lt;any&gt; {
+    switch (method) {
+      case ConfigLoadMethod.FROM_URLS:
+        return await this.loadConfigFromUrls(options, environment);
+      case ConfigLoadMethod.FROM_LOCAL_STORAGE:
+        return this.loadConfigFromLocalStorage(options);
+      case ConfigLoadMethod.FROM_URL_PARAM:
+        return this.loadConfigFromUrlParam(options as any);
+      case ConfigLoadMethod.FROM_CID:
+        return await this.loadConfigFromCid(options as any);
+      default:
+        return null;
+    }
+  }
+
+  private static getMethodName(method: ConfigLoadMethod): string {
+    switch (method) {
+      case ConfigLoadMethod.FROM_URLS:
+        return &#x27;urls&#x27;;
+      case ConfigLoadMethod.FROM_LOCAL_STORAGE:
+        return &#x27;local storage&#x27;;
+      case ConfigLoadMethod.FROM_URL_PARAM:
+        return &#x27;url param&#x27;;
+      case ConfigLoadMethod.FROM_CID:
+        return &#x27;cid&#x27;;
+      default:
+        return &#x27;unknown&#x27;;
+    }
+  }
+
   private static loadConfigFromUrlParam(options: ConfigLoadOptions &amp; { fromUrlParam: string | true }) {
     const param &#x3D; typeof options.fromUrlParam &#x3D;&#x3D;&#x3D; &#x27;string&#x27; ? options.fromUrlParam : &#x27;config&#x27;;
     return this.LoadConfigDefaultFromUrlParam(param);