keycloak-api-manager 2.0.0 → 2.0.2

package/index.js

@@ -22,43 +22,9 @@ var authenticationManagementHandler=require('./Handlers/authenticationManagement
 
 /**
  * ***************************** - ENGLISH - *******************************
- * Async Configuration function for the Keycloak adapter in an Express application.
- * It must be called at app startup, before defining any protected routes.
- * It returns a promise
  *
- * Parameters:
- * - app: Express application instance (e.g., const app = express();)
- * - keyCloakConfig: JSON object containing the Keycloak client configuration.
- *     This can be obtained from the Keycloak admin console:
- *     Clients → [client name] → Installation → "Keycloak OIDC JSON" → Download
- *     Example:
- *     {
- *       "realm": "realm-name",
- *       "auth-server-url": "https://keycloak.example.com/",
- *       "ssl-required": "external",
- *       "resource": "client-name",
- *       "credentials": { "secret": "secret-code" },
- *       "confidential-port": 0
- *     }
- * - keyCloakOptions: advanced configuration options for the adapter.
  *     Main supported options:
- *     - session: Express session configuration (as in express-session)
- *     - scope: authentication scopes (e.g., 'openid profile email offline_access')
- *         Note: to use offline_access, the client must have the option enabled and
- *         the user must have the offline_access role.
- *     - idpHint: to suggest an identity provider to Keycloak during login
- *     - cookies: to enable cookie handling
- *     - realmUrl: to override the realm URL
- *
- * - adminClientCredentials: [Optional] Advanced configuration for setting up the realm-admin user or client,
- *   which will be used as the administrator to manage Keycloak via API.
- *   This is required in order to use the administrative functions exposed by this library.
- *   If this parameter is not provided, it will not be possible to use the administrative functions of Keycloak
- *   exposed by this adapter. In fact, exports.kcAdminClient will be null, so any attempt to call
- *   keycloakAdapter.kcAdminClient will result in a runtime error due to access on an undefined object
- *
- *     Main supported options:
- *     -baseUrl
+ *     -baseUrl: Keycloak base Url
  *     - realmName: [Optional] A String that specifies the realm to authenticate against, if different from the keyCloakConfig.realm parameter.
  *       If you intend to use Keycloak administrator credentials, this should be set to 'master'.
  *     - scope: [Optional] A string that specifies The OAuth2 scope requested during authentication (optional).
@@ -117,6 +83,9 @@ exports.configure=async function(adminClientCredentials){
         //exports = kcAdminClient;
 };
 
+exports.setConfig=async function(configToOverride){
+        return(kcAdminClient.setConfig(configToOverride));
+}
 
 
 /*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keycloak-api-manager",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "Keycloak-api-manager is a lightweight Node.js wrapper for the Keycloak Admin REST API. It provides an easy-to-use functional methods and functions to manage realms, users, roles, clients, groups, and permissions directly from your application code — just like you would from the Keycloak admin console.",
   "main": "index.js",
   "scripts": {