@keycloak/keycloak-admin-client 22.0.3 → 22.0.5

package/lib/defs/featureRepresentation.d.ts

@@ -0,0 +1,15 @@
+export default interface FeatureRepresentation {
+    name: string;
+    label: string;
+    type: FeatureType;
+    enabled: boolean;
+    dependencies: string[];
+}
+export declare enum FeatureType {
+    Default = "DEFAULT",
+    DisabledByDefault = "DISABLED_BY_DEFAULT",
+    Preview = "PREVIEW",
+    PreviewDisabledByDefault = "PREVIEW_DISABLED_BY_DEFAULT",
+    Experimental = "EXPERIMENTAL",
+    Deprecated = "DEPRECATED"
+}

package/lib/defs/featureRepresentation.js

@@ -0,0 +1,9 @@
+export var FeatureType;
+(function (FeatureType) {
+    FeatureType["Default"] = "DEFAULT";
+    FeatureType["DisabledByDefault"] = "DISABLED_BY_DEFAULT";
+    FeatureType["Preview"] = "PREVIEW";
+    FeatureType["PreviewDisabledByDefault"] = "PREVIEW_DISABLED_BY_DEFAULT";
+    FeatureType["Experimental"] = "EXPERIMENTAL";
+    FeatureType["Deprecated"] = "DEPRECATED";
+})(FeatureType || (FeatureType = {}));

package/lib/defs/serverInfoRepesentation.d.ts

@@ -1,5 +1,6 @@
 import type ComponentTypeRepresentation from "./componentTypeRepresentation.js";
 import type { ConfigPropertyRepresentation } from "./configPropertyRepresentation.js";
+import FeatureRepresentation from "./featureRepresentation.js";
 import type PasswordPolicyTypeRepresentation from "./passwordPolicyTypeRepresentation.js";
 import type ProfileInfoRepresentation from "./profileInfoRepresentation.js";
 import type ProtocolMapperRepresentation from "./protocolMapperRepresentation.js";
@@ -11,6 +12,7 @@ export interface ServerInfoRepresentation {
     systemInfo?: SystemInfoRepresentation;
     memoryInfo?: MemoryInfoRepresentation;
     profileInfo?: ProfileInfoRepresentation;
+    features?: FeatureRepresentation[];
     cryptoInfo?: CryptoInfoRepresentation;
     themes?: {
         [index: string]: ThemeInfoRepresentation[];

package/lib/defs/userProfileConfig.d.ts

@@ -1,4 +1,4 @@
-export default interface UserProfileConfig {
+export interface UserProfileConfig {
     attributes?: UserProfileAttribute[];
     groups?: UserProfileGroup[];
 }
@@ -7,7 +7,6 @@ export interface UserProfileAttribute {
     validations?: Record<string, Record<string, unknown>>;
     annotations?: Record<string, unknown>;
     required?: UserProfileAttributeRequired;
-    readOnly?: boolean;
     permissions?: UserProfileAttributePermissions;
     selector?: UserProfileAttributeSelector;
     displayName?: string;

package/lib/defs/userProfileMetadata.d.ts

@@ -0,0 +1,19 @@
+export interface UserProfileMetadata {
+    attributes?: UserProfileAttributeMetadata[];
+    groups?: UserProfileAttributeGroupMetadata[];
+}
+export interface UserProfileAttributeMetadata {
+    name?: string;
+    displayName?: string;
+    required?: boolean;
+    readOnly?: boolean;
+    group?: string;
+    annotations?: Record<string, unknown>;
+    validators?: Record<string, Record<string, unknown>>;
+}
+export interface UserProfileAttributeGroupMetadata {
+    name?: string;
+    displayHeader?: string;
+    displayDescription?: string;
+    annotations?: Record<string, unknown>;
+}

package/lib/defs/userProfileMetadata.js

@@ -0,0 +1 @@
+export {};

package/lib/defs/userRepresentation.d.ts

@@ -1,8 +1,8 @@
-import type UserConsentRepresentation from "./userConsentRepresentation.js";
 import type CredentialRepresentation from "./credentialRepresentation.js";
 import type FederatedIdentityRepresentation from "./federatedIdentityRepresentation.js";
 import type { RequiredActionAlias } from "./requiredActionProviderRepresentation.js";
-import type UserProfileConfig from "./userProfileConfig.js";
+import type UserConsentRepresentation from "./userConsentRepresentation.js";
+import type { UserProfileMetadata } from "./userProfileMetadata.js";
 export default interface UserRepresentation {
     id?: string;
     createdTimestamp?: number;
@@ -28,5 +28,5 @@ export default interface UserRepresentation {
     realmRoles?: string[];
     self?: string;
     serviceAccountClientId?: string;
-    userProfileMetadata?: UserProfileConfig;
+    userProfileMetadata?: UserProfileMetadata;
 }

package/lib/resources/users.d.ts

@@ -1,15 +1,16 @@
-import Resource from "./resource.js";
-import type UserRepresentation from "../defs/userRepresentation.js";
-import type UserConsentRepresentation from "../defs/userConsentRepresentation.js";
-import type UserSessionRepresentation from "../defs/userSessionRepresentation.js";
 import type { KeycloakAdminClient } from "../client.js";
+import type CredentialRepresentation from "../defs/credentialRepresentation.js";
+import type FederatedIdentityRepresentation from "../defs/federatedIdentityRepresentation.js";
+import type GroupRepresentation from "../defs/groupRepresentation.js";
 import type MappingsRepresentation from "../defs/mappingsRepresentation.js";
 import type RoleRepresentation from "../defs/roleRepresentation.js";
 import type { RoleMappingPayload } from "../defs/roleRepresentation.js";
-import type FederatedIdentityRepresentation from "../defs/federatedIdentityRepresentation.js";
-import type GroupRepresentation from "../defs/groupRepresentation.js";
-import type CredentialRepresentation from "../defs/credentialRepresentation.js";
-import type UserProfileConfig from "../defs/userProfileConfig.js";
+import type UserConsentRepresentation from "../defs/userConsentRepresentation.js";
+import type { UserProfileConfig } from "../defs/userProfileConfig.js";
+import type { UserProfileMetadata } from "../defs/userProfileMetadata.js";
+import type UserRepresentation from "../defs/userRepresentation.js";
+import type UserSessionRepresentation from "../defs/userSessionRepresentation.js";
+import Resource from "./resource.js";
 interface SearchQuery {
     search?: string;
 }
@@ -66,6 +67,9 @@ export declare class Users extends Resource<{
     updateProfile: (payload?: (UserProfileConfig & {
         realm?: string | undefined;
     }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<UserProfileConfig>;
+    getProfileMetadata: (payload?: {
+        realm?: string | undefined;
+    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<UserProfileMetadata>;
     /**
      * role mappings
      */

package/lib/resources/users.js

@@ -38,6 +38,10 @@ export class Users extends Resource {
         method: "PUT",
         path: "/profile",
     });
+    getProfileMetadata = this.makeRequest({
+        method: "GET",
+        path: "/profile/metadata",
+    });
     /**
      * role mappings
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keycloak/keycloak-admin-client",
-  "version": "22.0.3",
+  "version": "22.0.5",
   "description": "A client to interact with Keycloak's Administration API",
   "type": "module",
   "main": "lib/index.js",