dash-button-web 0.0.21 → 0.0.23-beta.0

package/readme.md

@@ -28,11 +28,14 @@ If it is a framework, you wll need to configure more options. Therefore, follow
 
 Here, we show how to integrate DashButton into your frontend application.
 
-#### Step 1 - Setup Keycloak Server Application
+> Note: From version v0.0.17 onward, configuring or managing the Keycloak instance is no longer required. It is handled by the Portal application backend services. Keycloak configuration (Step 1) can therefore be skipped.
+
+
+### Step 1 - Setup Keycloak Server Application
 
 First, you need to start your own **Keycloak instance** or use the **DS2 version**. We recommend using the DS2-based Keycloak instance.
 
-##### Option 1 – Use DS2 Keycloak details
+#### Option 1 – Use DS2 Keycloak details
 You can use predefined Keycloak credentials to configure DashButton. The required details are summarized below.
 
 - Keyclaok URL: **https://keycloak.ds2.icelab.cloud**
@@ -40,7 +43,7 @@ You can use predefined Keycloak credentials to configure DashButton. The require
 - Client ID: **dashbtn**
 
 
-##### Option 2 – Configure your own Keycloak client
+#### Option 2 – Configure your own Keycloak client
 If you use your own version, you need to configure the realm, client, and test users.  
 Make sure the client is set up with a **client ID** and that **client authentication is disabled**.
 
@@ -83,25 +86,16 @@ Next, you need to put the script file path in the **src/index.html** file header
 
 After that, you can pass configuration options as follows using the web component.
 
+> **Note:** From version v0.0.17 onward, Keycloak configuration is no longer required. These settings have been removed from the DashButton configuration and are automatically retrieved from the Portal API backend. Please ensure that the portal-api-url is configured correctly.
+
 #### Configuration options
 
 | Attribute         | Description | Type      | Default                   |
 | ----------------- | ----------- | --------- | ------------------------- |
-| `client-id`       | `Keycloak client ID` | `string`  | ``               |
-| `keycloak-uri`    | `Keycloak server URI` | `string`  | `"http://localhost:8080"` |
-| `realm`           |`Keycloak realm`| `string`  | ``                  |
+| `portal-api-url` | `Portal API URL` | `string` | ``                   |
 | `redirect-uri`    | `Application redirect URI` | `string`  | ``               |
 | `show-post-login-text` | `Successfully logged in shows a custom button message` | `boolean` | `false`                   |
 | `auth-method` | `Authentication method` | `string` | `check-sso`, `(login-required)`                   |
-| `app-id` | `Application unique ID` | `string` | ``                   |
-| `portal-url` | `Portal URL` | `string` | ``                   |
-| `portal-api-url` | `Portal API URL` | `string` | ``                   |
-| `show-unauthorized-modal` | `Show unauthorized modal` | `boolean` | `false`                   |
-| `other-link-type` | `Add new links for the menu` | `string` | `local or global`                   |
-| `application-display-name` | `Menu application display name` | `string` | `Applications`                   |
-| `disable-application-tab` | `disable application tab` | `boolean` | `false`                   |
-| `menu-view-type` | `the style of the menu` | `string` | `grid/list`                   |
-
 
 #### Theme Configuration options
 
@@ -120,11 +114,15 @@ Now, you are almost done. In the final stage, you can place the web-component bu
 
 > Note: Replace DashButton configuration with actual values.
 
-To get the module link for the Dashbutton, use the **portal-api-url** attribute and provide the Portal backend API endpoint URL.
-For the DS2 platform, you can use **https://portal-api.ds2.icelab.cloud** as the Portal API URL..
+To retrieve all configurations for the DashButton, use the **portal-api-url** attribute and provide the Portal backend API endpoint URL.
+For the DS2 platform, you can use **https://portal-api.ds2.icelab.cloud** as the Portal API URL.
 
 ```sh
-<dash-button keycloak-uri="http://localhost:8080" realm="demo" client-id="testapp" portal-api-url="replace_url" auth-method="login-required" show-post-login-text="false"></dash-button>
+<dash-button
+  portal-api-url="replace_url"
+  auth-method="login-required"
+  show-post-login-text="false">
+</dash-button>
 ```
 After that test your application can be test with user credentials and then you can get an output similar to this.
 
@@ -151,15 +149,41 @@ First, you need to import the script tag into the header section of your main HT
 After that, all you need to do is place the dash button in your preferred location on the web page. To do so, use the following web component button tag and place it in your application with preferred configuration options.
 
 ```sh
-<dash-button keycloak-uri="http://localhost:8080" realm="demo" client-id="testapp"></dash-button>
+<dash-button 
+  portal-api-url="replace_url">
+</dash-button>
 ```
 
+## Work with Secure Applications
+
+Starting from v0.0.21, an application access permission validation workflow has been introduced.
+
+With this update, users cannot proceed with restricted applications if they do not have the required permissions.
+
+> Note: This validation is not applied to all available applications globally (for example: Portal, Marketplace, etc.).
+
+#### Skipping the Security Check Warning
+
+To add your application as a secure application, follow these steps:
+1. Go to the Portal Edit Profile Page
+2. Navigate to the Organization URL section
+3. Add your Organization Domain URL
+4. Save the changes
+
+After completing these steps, you can continue accessing the application without receiving the warning.
+
 That's it, enjoy!
 
 ---
 
 ##### Changelog:
 
+**v0.0.23**
+- Fixed restricted page access logic
+
+**v0.0.22**
+- Fixed an issue with local module link generation.
+
 **v0.0.21**
 - Added access permission verification using organization URL and public links (shows blocked modal)