@eui/core 17.0.0-rc.8 → 17.0.1-snapshot-1700665462888

package/assets/i18n-eui/en.json

@@ -108,6 +108,7 @@
     "eui.uxtree.SELECT-ALL": "Select all",
     "eui.uxtree.UNSELECT-ALL": "Unselect all",
     "eui.languageSelector.modalTitle": "Select language",
+    "eui.growl.dismiss-all": "Dismiss all",
     "eui.euitable.NO-SORTING-ICON": "No sorting icon",
     "eui.euitable.ASCENDING-ICON": "Ascending order icon",
     "eui.euitable.DESCENDING-ICON": "Descending order icon",

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.7</li>
+            <b>@eui/styles-base</b> : 17.0.1-snapshot-1700608878397</li>
         <li>
-            <b>@eui/ecl</b> : 17.0.0-rc.7</li>
+            <b>@eui/ecl</b> : 17.0.1-snapshot-1700608878397</li>
         <li>
             <b>@eui/tools</b> : ^6.0.0</li>
     </ul>

package/docs/injectables/EuiPermissionService.html

@@ -63,6 +63,22 @@
         </p>
 
 
+            <p class="comment">
+                <h3>Description</h3>
+            </p>
+            <p class="comment">
+                <p>Service for managing user permissions within the application.
+This class extends <code>EuiService</code> and is responsible for handling user rights and permissions.
+It provides methods to initialize the service with user rights, check specific rights and permissions,
+and subscribe to changes in the user rights state.</p>
+<p>See EuiService</p>
+<b>Example :</b><div><pre class="line-numbers"><code class="language-html">// Example of using the EuiPermissionService in an application
+const permissionService = new EuiPermissionService();
+permissionService.init([{ id: &#39;ADMIN&#39;, permissions: [&#39;CREATE&#39;, &#39;READ&#39;, &#39;UPDATE&#39;, &#39;DELETE&#39;] }]);
+if (permissionService.checkRight(&#39;ADMIN&#39;)) {
+  console.log(&#39;User has ADMIN rights&#39;);
+}</code></pre></div>
+            </p>
 
             <p class="comment">
                 <h3>Extends</h3>
@@ -198,10 +214,15 @@
 
             <tr>
                 <td class="col-md-4">
-                        <div class="io-description"><p>accepts a string of right and or a permission. In string first comes the right and or followed by permission in
-a dot separated way e.g. &#39;RIGHT.PERMISSION&#39; or &#39;RIGHT&#39;. The string can contain more that 2 separated fields.
-In that case the last field should be the permission and all the others a Right. e.g. &#39;RIGHT1.RIGHT2.PERMISSION&#39;
-The last part is useful where you want a user to have multiple rights and the permission of the last right.</p>
+                        <div class="io-description"><p>Checks if the user has the specified attribute permission.
+This method interprets a string that represents a combination of rights and/or permissions
+and determines whether the user has the specified permissions. The string format can be
+&#39;RIGHT.PERMISSION&#39; or just &#39;RIGHT&#39;. For multiple rights, it can be &#39;RIGHT1.RIGHT2.PERMISSION&#39;.</p>
+<b>Example :</b><div><pre class="line-numbers"><code class="language-none">                                  Format can be &#39;RIGHT&#39;, &#39;RIGHT.PERMISSION&#39;, or &#39;RIGHT1.RIGHT2.PERMISSION&#39;.</code></pre></div><b>Example :</b><div><pre class="line-numbers"><code class="language-html">// Check a single right
+const hasRight = permissionService.checkAttributePermission(&#39;VIEW&#39;);</code></pre></div><p>// Check a right with a specific permission
+const hasRightWithPermission = permissionService.checkAttributePermission(&#39;EDIT.APPROVE&#39;);</p>
+<p>// Check multiple rights with a specific permission
+const hasMultipleRights = permissionService.checkAttributePermission(&#39;ADMIN.VIEW.APPROVE&#39;);</p>
 </div>
 
                             <div class="io-description">
@@ -213,6 +234,7 @@ The last part is useful where you want a user to have multiple rights and the pe
                                             <td>Name</td>
                                                 <td>Type</td>
                                             <td>Optional</td>
+                                                <td>Description</td>
                                         </tr>
                                     </thead>
                                     <tbody>
@@ -227,6 +249,13 @@ The last part is useful where you want a user to have multiple rights and the pe
                                             </td>
 
 
+                                            <td>
+                                                    <ul>
+<li>A string representing the rights and/or permissions to check.
+Format can be &#39;RIGHT&#39;, &#39;RIGHT.PERMISSION&#39;, or &#39;RIGHT1.RIGHT2.PERMISSION&#39;.</li>
+</ul>
+
+                                            </td>
                                         </tr>
                                     </tbody>
                                 </table>
@@ -236,7 +265,8 @@ The last part is useful where you want a user to have multiple rights and the pe
 
                         </div>
                             <div class="io-description">
-                                
+                                <p>True if the user has the specified attribute permission, false otherwise.</p>
+
                             </div>
                 </td>
             </tr>
@@ -264,8 +294,10 @@ The last part is useful where you want a user to have multiple rights and the pe
 
             <tr>
                 <td class="col-md-4">
-                        <div class="io-description"><p>check if a user has that right and that right has the permission given.</p>
-</div>
+                        <div class="io-description"><p>Checks if the user has a specific permission within a right.
+This method determines whether the user has a specific permission associated with a given right.</p>
+<b>Example :</b><div><pre class="line-numbers"><code class="language-html">// Check if the user has &#39;APPROVE&#39; permission in the &#39;EDIT&#39; right
+const canApproveEdit = permissionService.checkPermission(&#39;EDIT&#39;, &#39;APPROVE&#39;);</code></pre></div></div>
 
                             <div class="io-description">
                                 <b>Parameters :</b>
@@ -292,7 +324,9 @@ The last part is useful where you want a user to have multiple rights and the pe
 
 
                                             <td>
-                                                    <p>the right of the user</p>
+                                                    <ul>
+<li>The ID of the right.</li>
+</ul>
 
                                             </td>
                                         </tr>
@@ -308,7 +342,9 @@ The last part is useful where you want a user to have multiple rights and the pe
 
 
                                             <td>
-                                                    <p>the permission of the right</p>
+                                                    <ul>
+<li>The permission to check within the right.</li>
+</ul>
 
                                             </td>
                                         </tr>
@@ -320,7 +356,8 @@ The last part is useful where you want a user to have multiple rights and the pe
 
                         </div>
                             <div class="io-description">
-                                
+                                <p>True if the user has the specified permission in the given right, false otherwise.</p>
+
                             </div>
                 </td>
             </tr>
@@ -348,8 +385,10 @@ The last part is useful where you want a user to have multiple rights and the pe
 
             <tr>
                 <td class="col-md-4">
-                        <div class="io-description"><p>check if a user has the right.</p>
-</div>
+                        <div class="io-description"><p>Checks if the user has a specific right.
+This method determines whether the user possesses a particular right identified by its ID.</p>
+<b>Example :</b><div><pre class="line-numbers"><code class="language-html">// Check if the user has the &#39;ADMIN&#39; right
+const isAdmin = permissionService.checkRight(&#39;ADMIN&#39;);</code></pre></div></div>
 
                             <div class="io-description">
                                 <b>Parameters :</b>
@@ -376,7 +415,9 @@ The last part is useful where you want a user to have multiple rights and the pe
 
 
                                             <td>
-                                                    <p>the id of Right</p>
+                                                    <ul>
+<li>The ID of the right to check.</li>
+</ul>
 
                                             </td>
                                         </tr>
@@ -388,7 +429,8 @@ The last part is useful where you want a user to have multiple rights and the pe
 
                         </div>
                             <div class="io-description">
-                                
+                                <p>True if the user has the specified right, false otherwise.</p>
+
                             </div>
                 </td>
             </tr>
@@ -424,13 +466,28 @@ The last part is useful where you want a user to have multiple rights and the pe
 
             <tr>
                 <td class="col-md-4">
-                        <div class="io-description"><p>get the user&#39;s Rights from the state</p>
+                        <div class="io-description"><p>Retrieves the current state of user rights by subscribing to changes.
+This method is used to access the current state of user rights in the service. It returns an Observable
+that emits the current user rights. The method is generic and can be parameterized to return a specific
+type that extends from <code>EuiUserRight[]</code>.</p>
+<b>Example :</b><div><pre class="line-numbers"><code class="language-none">                     The type of the emitted value is `K`, which is `EuiUserRight[]` by default.</code></pre></div><b>Example :</b><div><pre class="line-numbers"><code class="language-html">// Example of subscribing to the user rights state
+permissionService.getState().subscribe(currentRights =&gt; {
+  console.log(&#39;Current User Rights:&#39;, currentRights);
+});</code></pre></div><p>// Example with a specific type
+permissionService.getState&lt;CustomUserRightType[]&gt;().subscribe(customRights =&gt; {
+  console.log(&#39;Custom User Rights:&#39;, customRights);
+});</p>
 </div>
 
                         <div class="io-description">
                             <b>Returns : </b>    <code>Observable&lt;K&gt;</code>
 
                         </div>
+                            <div class="io-description">
+                                <p>An Observable that emits the current state of user rights.
+The type of the emitted value is <code>K</code>, which is <code>EuiUserRight[]</code> by default.</p>
+
+                            </div>
                 </td>
             </tr>
         </tbody>
@@ -457,8 +514,26 @@ The last part is useful where you want a user to have multiple rights and the pe
 
             <tr>
                 <td class="col-md-4">
-                        <div class="io-description"><p>initialize the service by providing a state</p>
-</div>
+                        <div class="io-description"><p>Initializes the permission service with a set of user rights.
+This method sets up the initial state of the service based on the provided user rights.
+It should be called before using other methods of the service to ensure it is properly configured.</p>
+<b>Example :</b><div><pre class="line-numbers"><code class="language-none">                             Each `EuiUserRight` object should contain at least an `id` property,
+                             and optionally a `permissions` property which is an array of strings.
+
+                                    The status object includes a `success` boolean indicating
+                                    whether the initialization was successful, and an `error` property
+                                    with a message in case of failure.</code></pre></div><b>Example :</b><div><pre class="line-numbers"><code class="language-html">// Example of initializing the service with two user rights
+const userRights = [
+  { id: &#39;ADMIN&#39;, permissions: [&#39;CREATE&#39;, &#39;READ&#39;, &#39;UPDATE&#39;, &#39;DELETE&#39;] },
+  { id: &#39;USER&#39;, permissions: [&#39;READ&#39;] }
+];
+permissionService.init(userRights).subscribe(status =&gt; {
+  if (status.success) {
+    console.log(&#39;Initialization successful&#39;);
+  } else {
+    console.error(&#39;Initialization failed:&#39;, status.error);
+  }
+});</code></pre></div></div>
 
                             <div class="io-description">
                                 <b>Parameters :</b>
@@ -469,6 +544,7 @@ The last part is useful where you want a user to have multiple rights and the pe
                                             <td>Name</td>
                                                 <td>Type</td>
                                             <td>Optional</td>
+                                                <td>Description</td>
                                         </tr>
                                     </thead>
                                     <tbody>
@@ -483,6 +559,14 @@ The last part is useful where you want a user to have multiple rights and the pe
                                             </td>
 
 
+                                            <td>
+                                                    <ul>
+<li>An array of user rights to initialize the service with.
+Each <code>EuiUserRight</code> object should contain at least an <code>id</code> property,
+and optionally a <code>permissions</code> property which is an array of strings.</li>
+</ul>
+
+                                            </td>
                                         </tr>
                                     </tbody>
                                 </table>
@@ -492,7 +576,11 @@ The last part is useful where you want a user to have multiple rights and the pe
 
                         </div>
                             <div class="io-description">
-                                
+                                <p>An Observable that emits the status of the initialization.
+The status object includes a <code>success</code> boolean indicating
+whether the initialization was successful, and an <code>error</code> property
+with a message in case of failure.</p>
+
                             </div>
                 </td>
             </tr>
@@ -520,8 +608,16 @@ The last part is useful where you want a user to have multiple rights and the pe
 
             <tr>
                 <td class="col-md-4">
-                        <div class="io-description"><p>update the state with the given user&#39;s rights</p>
-</div>
+                        <div class="io-description"><p>Updates the state of the service with a new set of user rights.
+This method is used to modify the current user rights in the service. It takes an array of <code>EuiUserRight</code>
+objects and updates the service&#39;s state. This change is then propagated to all subscribers of the state.</p>
+<b>Example :</b><div><pre class="line-numbers"><code class="language-none">                             Each `EuiUserRight` object should contain an `id` property,
+                             and optionally a `permissions` property which is an array of strings.</code></pre></div><b>Example :</b><div><pre class="line-numbers"><code class="language-html">// Example of updating the service&#39;s state with new user rights
+const newUserRights = [
+  { id: &#39;USER&#39;, permissions: [&#39;READ&#39;, &#39;COMMENT&#39;] },
+  { id: &#39;MODERATOR&#39;, permissions: [&#39;READ&#39;, &#39;WRITE&#39;, &#39;DELETE&#39;] }
+];
+permissionService.updateState(newUserRights);</code></pre></div></div>
 
                             <div class="io-description">
                                 <b>Parameters :</b>
@@ -532,6 +628,7 @@ The last part is useful where you want a user to have multiple rights and the pe
                                             <td>Name</td>
                                                 <td>Type</td>
                                             <td>Optional</td>
+                                                <td>Description</td>
                                         </tr>
                                     </thead>
                                     <tbody>
@@ -546,6 +643,14 @@ The last part is useful where you want a user to have multiple rights and the pe
                                             </td>
 
 
+                                            <td>
+                                                    <ul>
+<li>An array of <code>EuiUserRight</code> objects to update the service&#39;s state with.
+Each <code>EuiUserRight</code> object should contain an <code>id</code> property,
+and optionally a <code>permissions</code> property which is an array of strings.</li>
+</ul>
+
+                                            </td>
                                         </tr>
                                     </tbody>
                                 </table>