@adatechnology/keycloak-admin 1.0.0-rc.2 → 1.0.0-rc.3

package/README.md

@@ -35,6 +35,15 @@ const { id } = await keycloak.createUser({
 Operações de usuário: `createUser`, `findUserByEmail`, `listUsers`, `updateUser`, `setEnabled`,
 `updateAttributes`, `deleteUser`, `setPassword`, `setTemporaryPassword`.
 
+Foto de perfil: `setProfilePicture({ userId, pictureUrl })`. O atributo é `picture`, o nome que o
+OIDC reserva — com um mapeador no realm ele chega ao token, e a tela desenha o avatar sem uma
+consulta por pessoa.
+
+⚠️ O Keycloak **não hospeda imagem**: o valor é uma URL e o arquivo é do produto. Base64 no atributo
+cresce o token até ele parar de caber no cabeçalho, e o sintoma aparece longe — login que funciona
+no navegador e falha no `curl`. A operação lê os atributos antes de gravar, porque o Admin API
+substitui o conjunto: mandar só a foto apagaria `company_id` e o resto.
+
 Operações de grupo: `createGroup`, `updateGroup`, `deleteGroup`, `listGroups`, `addUserToGroup`,
 `removeUserFromGroup`. Só o **primeiro nível** — grupo aninhado muda o significado de "pertencer",
 porque quem está no filho herda o pai, e um produto que não modela hierarquia não deve criá-la por

package/dist/index.d.ts

@@ -113,6 +113,20 @@ type SetEnabledParams = {
     readonly enabled: boolean;
     readonly userId: string;
 };
+/**
+ * O atributo padrão da foto. `picture` é o nome que o OIDC já reserva para isso, e usá-lo é o que
+ * permite a foto chegar ao token por um mapeador do realm em vez de uma consulta extra por tela.
+ *
+ * ⚠️ O Keycloak **não hospeda imagem**: o valor é uma URL, e quem guarda o arquivo é o produto. Um
+ * atributo com base64 dentro cresce o token até ele parar de caber no cabeçalho, e aí o sintoma é
+ * login que funciona no navegador e falha no `curl`.
+ */
+declare const PROFILE_PICTURE_ATTRIBUTE = "picture";
+type SetProfilePictureParams = {
+    /** URL da imagem, ou `undefined` para tirar a foto sem mexer nos outros atributos. */
+    readonly pictureUrl: string | undefined;
+    readonly userId: string;
+};
 type UpdateAttributesParams = {
     readonly attributes: KeycloakUserAttributes;
     readonly userId: string;
@@ -179,6 +193,7 @@ type KeycloakAdminClient = {
     findUserByEmail(params: FindUserByEmailParams): Promise<KeycloakUser | undefined>;
     listUsers(params?: ListUsersParams): Promise<ListUsersResult>;
     setEnabled(params: SetEnabledParams): Promise<void>;
+    setProfilePicture(params: SetProfilePictureParams): Promise<void>;
     setPassword(params: SetPasswordParams): Promise<void>;
     setTemporaryPassword(params: SetTemporaryPasswordParams): Promise<void>;
     updateAttributes(params: UpdateAttributesParams): Promise<void>;
@@ -203,4 +218,4 @@ declare function parseKeycloakAdminConfig(value: unknown): KeycloakAdminConfig;
 
 declare function createKeycloakAdminClient({ config: rawConfig, fetch: injectedFetch, now, }: CreateKeycloakAdminClientParams): KeycloakAdminClient;
 
-export { type CreateGroupParams, type CreateGroupResult, type CreateKeycloakAdminClientParams, type CreateUserParams, type CreateUserResult, type DeleteGroupParams, type DeleteUserParams, type FetchLike, type FindUserByEmailParams, type GroupMembershipParams, KEYCLOAK_ADMIN_ERROR_CODE, KEYCLOAK_ADMIN_TOKEN_RENEWAL_SKEW_MS, type KeycloakAdminClient, type KeycloakAdminConfig, type KeycloakAdminEndpoints, KeycloakAdminError, type KeycloakAdminErrorCode, type KeycloakAdminErrorContext, type KeycloakAdminErrorParams, type KeycloakGroup, type KeycloakPassword, type KeycloakUser, type KeycloakUserAttributes, type ListGroupsParams, type ListGroupsResult, type ListUsersParams, type ListUsersResult, type SerializedKeycloakAdminError, type SetEnabledParams, type SetPasswordParams, type SetTemporaryPasswordParams, type UpdateAttributesParams, type UpdateGroupParams, type UpdateUserParams, buildKeycloakAdminEndpoints, createKeycloakAdminClient, isKeycloakAdminError, keycloakAdminConfigSchema, parseKeycloakAdminConfig };
+export { type CreateGroupParams, type CreateGroupResult, type CreateKeycloakAdminClientParams, type CreateUserParams, type CreateUserResult, type DeleteGroupParams, type DeleteUserParams, type FetchLike, type FindUserByEmailParams, type GroupMembershipParams, KEYCLOAK_ADMIN_ERROR_CODE, KEYCLOAK_ADMIN_TOKEN_RENEWAL_SKEW_MS, type KeycloakAdminClient, type KeycloakAdminConfig, type KeycloakAdminEndpoints, KeycloakAdminError, type KeycloakAdminErrorCode, type KeycloakAdminErrorContext, type KeycloakAdminErrorParams, type KeycloakGroup, type KeycloakPassword, type KeycloakUser, type KeycloakUserAttributes, type ListGroupsParams, type ListGroupsResult, type ListUsersParams, type ListUsersResult, PROFILE_PICTURE_ATTRIBUTE, type SerializedKeycloakAdminError, type SetEnabledParams, type SetPasswordParams, type SetProfilePictureParams, type SetTemporaryPasswordParams, type UpdateAttributesParams, type UpdateGroupParams, type UpdateUserParams, buildKeycloakAdminEndpoints, createKeycloakAdminClient, isKeycloakAdminError, keycloakAdminConfigSchema, parseKeycloakAdminConfig };

package/dist/index.js

@@ -187,6 +187,9 @@ function createKeycloakTokenProvider({
   };
 }
 
+// src/keycloak-admin.types.ts
+var PROFILE_PICTURE_ATTRIBUTE = "picture";
+
 // src/keycloak-admin.client.ts
 var HTTP_CONFLICT = 409;
 var HTTP_NOT_FOUND = 404;
@@ -344,6 +347,26 @@ function createKeycloakAdminClient({
       const found = await response.json();
       return { hasMore: found.length > limit, users: found.slice(0, limit) };
     },
+    /**
+     * A foto é atributo, e o Admin API **substitui o conjunto** quando recebe `attributes`. Por isso
+     * esta operação lê o usuário antes: mandar só a foto apagaria `company_id`, `tax_id` e qualquer
+     * outro atributo do produto — e o sintoma seria login entrando sem empresa, longe daqui.
+     */
+    async setProfilePicture({ pictureUrl, userId }) {
+      const response = await adminRequest({ method: "GET", url: endpoints.user(userId) });
+      const current = await response.json();
+      const attributes = { ...current.attributes ?? {} };
+      if (pictureUrl === void 0 || pictureUrl === "") {
+        delete attributes[PROFILE_PICTURE_ATTRIBUTE];
+      } else {
+        attributes[PROFILE_PICTURE_ATTRIBUTE] = pictureUrl;
+      }
+      await adminRequest({
+        body: { attributes: normalizeAttributes(attributes) },
+        method: "PUT",
+        url: endpoints.user(userId)
+      });
+    },
     async setEnabled({ enabled, userId }) {
       await adminRequest({ body: { enabled }, method: "PUT", url: endpoints.user(userId) });
     },
@@ -367,6 +390,7 @@ export {
   KEYCLOAK_ADMIN_ERROR_CODE,
   KEYCLOAK_ADMIN_TOKEN_RENEWAL_SKEW_MS,
   KeycloakAdminError,
+  PROFILE_PICTURE_ATTRIBUTE,
   buildKeycloakAdminEndpoints,
   createKeycloakAdminClient,
   isKeycloakAdminError,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adatechnology/keycloak-admin",
-  "version": "1.0.0-rc.2",
+  "version": "1.0.0-rc.3",
   "description": "Agnostic Keycloak Admin API client authenticated as a service account (client_credentials)",
   "type": "module",
   "main": "dist/index.js",