@eui/core 17.0.0-rc.7 → 17.0.1-snapshot-1700608878397

package/docs/classes/ApiQueueServiceMock.html

@@ -415,10 +415,17 @@
 
             <tr>
                 <td class="col-md-4">
-                        <div class="io-description"><p>Process all items in queue after it order them based on their timestamp. Beware that order
-matter in execution of Http Request in queue. When a request completes only then next will begin. Emission
-or Http response follows order.</p>
-</div>
+                        <div class="io-description"><p>Processes all items in the queue sequentially, based on their timestamp ordering.</p>
+<p>This method first orders the items in the API queue by their timestamp, either in ascending or descending
+order as specified by the <code>ascending</code> parameter. It then processes each item using <code>buildHttpRequest</code>, ensuring
+that each request is completed before the next begins. This sequential processing is crucial when the order of
+execution matters for HTTP requests in the queue. The method returns an Observable that emits the responses
+following the same order as the queue items were processed.</p>
+<p>The function currently returns <code>Observable&lt;any&gt;</code>, indicating a broad type. Future improvements should focus on
+specifying a more accurate return type or utilizing generics for increased type safety.</p>
+<b>Example :</b><div><pre class="line-numbers"><code class="language-none">                                timestamp. Defaults to `true`.</code></pre></div><b>Example :</b><div><pre class="line-numbers"><code class="language-html">this.processAllQueueItemsSequential().subscribe(response =&gt; {
+  // Handle each response in the order of queue processing
+});</code></pre></div></div>
 
                             <div class="io-description">
                                 <b>Parameters :</b>
@@ -446,7 +453,8 @@ or Http response follows order.</p>
 
                                             <td>
                                                     <ul>
-<li>sets the order of queue items based on timestamp</li>
+<li>Determines whether the queue items are processed in ascending order of their
+ timestamp. Defaults to <code>true</code>.</li>
 </ul>
 
                                             </td>
@@ -459,7 +467,8 @@ or Http response follows order.</p>
 
                         </div>
                             <div class="io-description">
-                                
+                                <p>An Observable emitting the responses of the HTTP requests in the order they were processed.</p>
+
                             </div>
                 </td>
             </tr>

package/docs/dependencies.html

@@ -249,9 +249,9 @@
         <li>
             <b>@stackblitz/sdk</b> : 1.9.0</li>
         <li>
-            <b>@eui/styles-base</b> : 17.0.0-rc.6</li>
+            <b>@eui/styles-base</b> : 17.0.0-rc.8</li>
         <li>
-            <b>@eui/ecl</b> : 17.0.0-rc.6</li>
+            <b>@eui/ecl</b> : 17.0.0-rc.8</li>
         <li>
             <b>@eui/tools</b> : ^6.0.0</li>
     </ul>

package/docs/injectables/ApiQueueService.html

@@ -63,6 +63,35 @@
         </p>
 
 
+            <p class="comment">
+                <h3>Description</h3>
+            </p>
+            <p class="comment">
+                <p>Service class for managing and processing a queue of API requests.</p>
+<p>This service provides functionality to add, remove, process, and manage HTTP requests stored in a queue.
+It enables sequential or bulk processing of requests, ensuring controlled execution and handling of API calls.
+The service methods offer features like processing individual items, processing all items in the queue either
+sequentially or all at once, and removing items from the queue. Each method is designed to handle specific aspects
+of queue management and processing, with attention to details like order of execution and error handling.</p>
+<p>Usage of this service is ideal in scenarios where API requests need to be managed in a queue structure, allowing
+for controlled execution and monitoring of these requests.</p>
+<b>Example :</b><div><pre class="line-numbers"><code class="language-html">// Adding a new item to the queue
+apiQueueService.addQueueItem({ id: &#39;item124&#39;, method: &#39;POST&#39;, uri: &#39;/api/data&#39;, payload: {...} });</code></pre></div><p>// Processing a single item from the queue
+apiQueueService.processQueueItem(&#39;item123&#39;).subscribe(result =&gt; {
+  console.log(&#39;Processed item 123 with result:&#39;, result);
+});</p>
+<p>// Processing all items in the queue in sequential order
+apiQueueService.processAllQueueItemsSequential(false).subscribe(results =&gt; {
+  console.log(&#39;Processed all items in descending order of their timestamp:&#39;, results);
+});</p>
+<p>// Removing an item from the queue
+apiQueueService.removeQueueItem(&#39;item123&#39;);</p>
+<p>// Processing all items in the queue and continuing on error
+apiQueueService.processAllQueueItems(true).subscribe(results =&gt; {
+  console.log(&#39;Processed all items in the queue with continuation on errors:&#39;, results);
+});</p>
+
+            </p>
 
 
 
@@ -210,9 +239,17 @@
 
             <tr>
                 <td class="col-md-4">
-                        <div class="io-description"><p>Adds an item in the queue by dispatching an action to the store.
-WARNING if matches any other queue item id will overwrite it.</p>
-</div>
+                        <div class="io-description"><p>Adds an item to the queue by dispatching an action to the store.
+This function is specifically designed to enqueue API call requests represented by <code>ApiQueueItem</code> objects.
+Each item is identified by a unique <code>id</code>, which is used to manage the queue.</p>
+<b>Example :</b><div><pre class="line-numbers"><code class="language-none">                 If an item with the same ID already exists, the new item will overwrite the existing one.
+                 WARNING: Duplicate IDs will lead to overwriting of queue items.
+
+                         The `method` property of the item must be one of the allowed methods (&#39;post&#39;, &#39;put&#39;, &#39;get&#39;).
+                         If an unsupported method is provided, the function will throw an error.
+
+            The error message is: `[ApiQueue] method &quot;${item.method}&quot; is not allowed`.</code></pre></div><b>Example :</b><div><pre class="line-numbers"><code class="language-html">// Example of adding an item to the API queue
+addQueueItem(&#39;12345&#39;, { method: &#39;post&#39;, url: &#39;/api/data&#39;, payload: {...} });</code></pre></div></div>
 
                             <div class="io-description">
                                 <b>Parameters :</b>
@@ -240,8 +277,9 @@ WARNING if matches any other queue item id will overwrite it.</p>
 
                                             <td>
                                                     <ul>
-<li>The id of the item inside the queue.
-WARNING if matches any other queue item id will overwrite it.</li>
+<li>The unique identifier for the queue item. It&#39;s crucial to ensure that this ID is unique within the queue.
+If an item with the same ID already exists, the new item will overwrite the existing one.
+WARNING: Duplicate IDs will lead to overwriting of queue items.</li>
 </ul>
 
                                             </td>
@@ -259,7 +297,9 @@ WARNING if matches any other queue item id will overwrite it.</li>
 
                                             <td>
                                                     <ul>
-<li>an item for Queue</li>
+<li>The item to be enqueued. This should be an object of type <code>ApiQueueItem</code>.
+The <code>method</code> property of the item must be one of the allowed methods (&#39;post&#39;, &#39;put&#39;, &#39;get&#39;).
+If an unsupported method is provided, the function will throw an error.</li>
 </ul>
 
                                             </td>
@@ -272,7 +312,8 @@ WARNING if matches any other queue item id will overwrite it.</li>
 
                         </div>
                             <div class="io-description">
-                                
+                                <p>This function does not return a value. It adds the item to the queue via a dispatch action.</p>
+
                             </div>
                 </td>
             </tr>
@@ -300,15 +341,27 @@ WARNING if matches any other queue item id will overwrite it.</li>
 
             <tr>
                 <td class="col-md-4">
-                        <div class="io-description"><p>Subscribes to the store to retrieve queue and then converts the queue object to an array of items.</p>
-</div>
+                        <div class="io-description"><p>Retrieves the current state of the API queue and converts it into an array of Observables.</p>
+<p>This method subscribes to the store to access the API queue. It then maps the queue object,
+which is an associative array, into a linear array of ApiQueueItem instances. If the queue is empty,
+a warning is logged. This method is useful for tracking the state and contents of the API queue
+at a given moment.</p>
+<p>Note: This method takes a snapshot of the queue at the time of subscription. It does not provide
+a continuous stream of queue updates. To get real-time updates, consider subscribing directly
+to the store&#39;s observable.</p>
+<p>The array represents all items currently in the queue. If the queue is empty, it emits an empty array.</p>
+<b>Example :</b><div><pre class="line-numbers"><code class="language-html">// Example usage
+this.getQueue().subscribe(queueItems =&gt; {
+  console.log(&#39;Current queue items:&#39;, queueItems);
+});</code></pre></div></div>
 
                         <div class="io-description">
                             <b>Returns : </b>    <code>Observable&lt;ApiQueueItem[]&gt;</code>
 
                         </div>
                             <div class="io-description">
-                                <p>An Observable of array of all items inside the current queue (ApiQueueItem[])</p>
+                                <p>An Observable that emits an array of ApiQueueItem.
+The array represents all items currently in the queue. If the queue is empty, it emits an empty array.</p>
 
                             </div>
                 </td>
@@ -337,8 +390,22 @@ WARNING if matches any other queue item id will overwrite it.</li>
 
             <tr>
                 <td class="col-md-4">
-                        <div class="io-description"><p>Subscribes to the store to retrieve an item from the queue.</p>
-</div>
+                        <div class="io-description"><p>Retrieves a specific item from the API queue by its ID.</p>
+<p>This method subscribes to the store and selects a single item from the API queue based on the provided ID.
+It employs a pipeline to fetch the item: the <code>getApiQueueItem</code> selector is used to retrieve the item,
+and a <code>map</code> operator processes the result. If the item with the specified ID does not exist in the queue,
+a warning is logged, and <code>null</code> is returned.</p>
+<p>This method is ideal for accessing a specific queue item when its ID is known, allowing for targeted
+operations or checks on that particular item.</p>
+<p>If no item with the given ID exists in the queue, the Observable emits <code>null</code>.</p>
+<b>Example :</b><div><pre class="line-numbers"><code class="language-html">// Example usage
+this.getQueueItem(&#39;item123&#39;).subscribe(item =&gt; {
+  if (item) {
+    console.log(&#39;Found item:&#39;, item);
+  } else {
+    console.log(&#39;Item not found in the queue&#39;);
+  }
+});</code></pre></div></div>
 
                             <div class="io-description">
                                 <b>Parameters :</b>
@@ -366,7 +433,7 @@ WARNING if matches any other queue item id will overwrite it.</li>
 
                                             <td>
                                                     <ul>
-<li>id of the item inside the queue</li>
+<li>The unique identifier of the item within the queue.</li>
 </ul>
 
                                             </td>
@@ -379,7 +446,8 @@ WARNING if matches any other queue item id will overwrite it.</li>
 
                         </div>
                             <div class="io-description">
-                                <p>An Observable of ApiQueueItem type</p>
+                                <p>An Observable emitting the requested ApiQueueItem.
+If no item with the given ID exists in the queue, the Observable emits <code>null</code>.</p>
 
                             </div>
                 </td>
@@ -405,11 +473,27 @@ WARNING if matches any other queue item id will overwrite it.</li>
 
 
 
+                    <tr>
+                        <td class="col-md-4">
+                            <b>Type parameters :</b>
+                            <ul class="type-parameters">
+                                    <li>T</li>
+                            </ul>
+                        </td>
+                    </tr>
 
             <tr>
                 <td class="col-md-4">
-                        <div class="io-description"><p>Process all the items inside the queue.</p>
-</div>
+                        <div class="io-description"><p>Processes all items in the API queue and collects their responses.</p>
+<p>Iterates over each item in the queue and processes them using <code>buildHttpRequest</code>. If a request fails,
+the method can either continue processing the remaining items or stop, based on the <code>continueOnError</code> parameter.
+It returns an Observable that emits an array containing the responses or errors from all the processed items.</p>
+<p>The function currently returns <code>Observable&lt;any[]&gt;</code> indicating an array of any type. Future improvements
+should aim to specify a more accurate return type or utilize generics for increased type safety.</p>
+<b>Example :</b><div><pre class="line-numbers"><code class="language-none">                                      after a request failure. Defaults to `true`.
+                         queue items.</code></pre></div><b>Example :</b><div><pre class="line-numbers"><code class="language-html">this.processAllQueueItems().subscribe(results =&gt; {
+  // Handle the array of responses or errors
+});</code></pre></div></div>
 
                             <div class="io-description">
                                 <b>Parameters :</b>
@@ -437,7 +521,8 @@ WARNING if matches any other queue item id will overwrite it.</li>
 
                                             <td>
                                                     <ul>
-<li>in case of an item request fails continue with the rest in queue</li>
+<li>Determines whether to continue with the next item in the queue
+ after a request failure. Defaults to <code>true</code>.</li>
 </ul>
 
                                             </td>
@@ -446,11 +531,12 @@ WARNING if matches any other queue item id will overwrite it.</li>
                                 </table>
                             </div>
                         <div class="io-description">
-                            <b>Returns : </b>    <code>Observable&lt;any[]&gt;</code>
+                            <b>Returns : </b>    <code>Observable&lt;T[]&gt;</code>
 
                         </div>
                             <div class="io-description">
-                                <p>An Observable with an array which contains all responses from all items in queue.</p>
+                                <p>An Observable emitting an array of either responses or errors from the processed
+queue items.</p>
 
                             </div>
                 </td>
@@ -479,10 +565,17 @@ WARNING if matches any other queue item id will overwrite it.</li>
 
             <tr>
                 <td class="col-md-4">
-                        <div class="io-description"><p>Process all items in queue after it order them based on their timestamp. Beware that order
-matter in execution of Http Request in queue. When a request completes only then next will begin. Emission
-or Http response follows order.</p>
-</div>
+                        <div class="io-description"><p>Processes all items in the queue sequentially, based on their timestamp ordering.</p>
+<p>This method first orders the items in the API queue by their timestamp, either in ascending or descending
+order as specified by the <code>ascending</code> parameter. It then processes each item using <code>buildHttpRequest</code>, ensuring
+that each request is completed before the next begins. This sequential processing is crucial when the order of
+execution matters for HTTP requests in the queue. The method returns an Observable that emits the responses
+following the same order as the queue items were processed.</p>
+<p>The function currently returns <code>Observable&lt;any&gt;</code>, indicating a broad type. Future improvements should focus on
+specifying a more accurate return type or utilizing generics for increased type safety.</p>
+<b>Example :</b><div><pre class="line-numbers"><code class="language-none">                                timestamp. Defaults to `true`.</code></pre></div><b>Example :</b><div><pre class="line-numbers"><code class="language-html">this.processAllQueueItemsSequential().subscribe(response =&gt; {
+  // Handle each response in the order of queue processing
+});</code></pre></div></div>
 
                             <div class="io-description">
                                 <b>Parameters :</b>
@@ -510,7 +603,8 @@ or Http response follows order.</p>
 
                                             <td>
                                                     <ul>
-<li>sets the order of queue items based on timestamp</li>
+<li>Determines whether the queue items are processed in ascending order of their
+ timestamp. Defaults to <code>true</code>.</li>
 </ul>
 
                                             </td>
@@ -523,7 +617,8 @@ or Http response follows order.</p>
 
                         </div>
                             <div class="io-description">
-                                
+                                <p>An Observable emitting the responses of the HTTP requests in the order they were processed.</p>
+
                             </div>
                 </td>
             </tr>
@@ -551,8 +646,18 @@ or Http response follows order.</p>
 
             <tr>
                 <td class="col-md-4">
-                        <div class="io-description"><p>Process an item from the queue.</p>
-</div>
+                        <div class="io-description"><p>Processes an item from the API queue identified by its ID.</p>
+<p>Retrieves the specified item from the queue and applies processing logic as defined in <code>buildHttpRequest</code>.
+If the item is not found, logs a warning and returns an Observable emitting <code>null</code>.</p>
+<p>If the item does not exist, the Observable emits <code>null</code>.</p>
+<b>Example :</b><div><pre class="line-numbers"><code class="language-html">// Example usage
+this.processQueueItem(&#39;item123&#39;).subscribe(result =&gt; {
+  if (result) {
+    console.log(&#39;Processing result:&#39;, result);
+  } else {
+    console.log(&#39;Item not found in the queue&#39;);
+  }
+});</code></pre></div></div>
 
                             <div class="io-description">
                                 <b>Parameters :</b>
@@ -580,7 +685,7 @@ or Http response follows order.</p>
 
                                             <td>
                                                     <ul>
-<li>id of the item inside the queue</li>
+<li>The unique identifier of the item within the queue to be processed.</li>
 </ul>
 
                                             </td>
@@ -593,7 +698,8 @@ or Http response follows order.</p>
 
                         </div>
                             <div class="io-description">
-                                <p>An Observable of type any</p>
+                                <p>An Observable that emits the result of processing the queue item.
+If the item does not exist, the Observable emits <code>null</code>.</p>
 
                             </div>
                 </td>
@@ -622,13 +728,23 @@ or Http response follows order.</p>
 
             <tr>
                 <td class="col-md-4">
-                        <div class="io-description"><p>Removes all items placed in the queue.</p>
-</div>
+                        <div class="io-description"><p>Clears all items from the API queue.</p>
+<p>This method dispatches an action to empty the entire API queue, effectively removing all items that are currently queued.
+It is useful for scenarios where a complete reset of the queue is required, such as during initialization or after processing
+a batch of items. The function does not return any value, as its primary purpose is to trigger a state change in the store.</p>
+<p>Note: Use this method with caution as it will irreversibly clear all items in the queue. Ensure that this action does not
+disrupt any ongoing processes that rely on the queue&#39;s contents.</p>
+<b>Example :</b><div><pre class="line-numbers"><code class="language-html">// Example usage
+this.removeAllQueueItem();
+// This will dispatch an action to empty the entire API queue.</code></pre></div></div>
 
                         <div class="io-description">
                             <b>Returns : </b>        <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
 
                         </div>
+                            <div class="io-description">
+                                
+                            </div>
                 </td>
             </tr>
         </tbody>
@@ -655,8 +771,16 @@ or Http response follows order.</p>
 
             <tr>
                 <td class="col-md-4">
-                        <div class="io-description"><p>Removes a given item from the queue.</p>
-</div>
+                        <div class="io-description"><p>Removes a specific item from the API queue using its ID.</p>
+<p>This method dispatches an action to remove an item from the queue, identified by the provided ID.
+It is essential for managing the queue by eliminating items that are no longer needed or have been processed.
+The function does not return any value, as it primarily triggers an action within the store.</p>
+<p>Note: This method assumes the existence of the item in the queue. It does not perform a check
+to confirm the presence of the item before attempting to remove it. Therefore, it&#39;s recommended
+to verify the item&#39;s existence in the queue if uncertainty exists.</p>
+<b>Example :</b><div><pre class="line-numbers"><code class="language-html">// Example usage
+this.removeQueueItem(&#39;item123&#39;);
+// The item with ID &#39;item123&#39; will be dispatched for removal from the queue.</code></pre></div></div>
 
                             <div class="io-description">
                                 <b>Parameters :</b>
@@ -684,7 +808,7 @@ or Http response follows order.</p>
 
                                             <td>
                                                     <ul>
-<li>id of the item inside the queue</li>
+<li>The unique identifier of the item to be removed from the queue.</li>
 </ul>
 
                                             </td>