@adatechnology/keycloak-admin 1.0.0-rc.0 → 1.0.0-rc.1

package/README.md

@@ -32,8 +32,12 @@ const { id } = await keycloak.createUser({
 })
 ```
 
-Operações: `createUser`, `findUserByEmail`, `updateUser`, `setEnabled`, `updateAttributes`,
-`deleteUser`, `setPassword`, `setTemporaryPassword`.
+Operações: `createUser`, `findUserByEmail`, `listUsers`, `updateUser`, `setEnabled`,
+`updateAttributes`, `deleteUser`, `setPassword`, `setTemporaryPassword`.
+
+`listUsers({ first, limit, search })` devolve `{ users, hasMore }`. O realm não informa total, então
+a página pede um registro a mais que o limite e descarta-o: é assim que `hasMore` sai sem uma
+segunda chamada.
 
 ## Token
 

package/dist/index.d.ts

@@ -88,6 +88,19 @@ type CreateUserResult = {
 type FindUserByEmailParams = {
     readonly email: string;
 };
+/**
+ * O realm não devolve página infinita: `first`/`max` são o recorte que o Keycloak entende, e quem
+ * chama precisa saber se ainda há mais — daí `hasMore`, derivado de pedir um a mais que o limite.
+ */
+type ListUsersParams = {
+    readonly first?: number;
+    readonly limit?: number;
+    readonly search?: string;
+};
+type ListUsersResult = {
+    readonly hasMore: boolean;
+    readonly users: readonly KeycloakUser[];
+};
 type UpdateUserParams = {
     readonly user: Readonly<Partial<Pick<KeycloakUser, 'email' | 'emailVerified' | 'firstName' | 'lastName' | 'username'>>>;
     readonly userId: string;
@@ -116,6 +129,7 @@ type KeycloakAdminClient = {
     createUser(params: CreateUserParams): Promise<CreateUserResult>;
     deleteUser(params: DeleteUserParams): Promise<void>;
     findUserByEmail(params: FindUserByEmailParams): Promise<KeycloakUser | undefined>;
+    listUsers(params?: ListUsersParams): Promise<ListUsersResult>;
     setEnabled(params: SetEnabledParams): Promise<void>;
     setPassword(params: SetPasswordParams): Promise<void>;
     setTemporaryPassword(params: SetTemporaryPasswordParams): Promise<void>;
@@ -141,4 +155,4 @@ declare function parseKeycloakAdminConfig(value: unknown): KeycloakAdminConfig;
 
 declare function createKeycloakAdminClient({ config: rawConfig, fetch: injectedFetch, now, }: CreateKeycloakAdminClientParams): KeycloakAdminClient;
 
-export { type CreateKeycloakAdminClientParams, type CreateUserParams, type CreateUserResult, type DeleteUserParams, type FetchLike, type FindUserByEmailParams, KEYCLOAK_ADMIN_ERROR_CODE, KEYCLOAK_ADMIN_TOKEN_RENEWAL_SKEW_MS, type KeycloakAdminClient, type KeycloakAdminConfig, type KeycloakAdminEndpoints, KeycloakAdminError, type KeycloakAdminErrorCode, type KeycloakAdminErrorContext, type KeycloakAdminErrorParams, type KeycloakPassword, type KeycloakUser, type KeycloakUserAttributes, type SerializedKeycloakAdminError, type SetEnabledParams, type SetPasswordParams, type SetTemporaryPasswordParams, type UpdateAttributesParams, type UpdateUserParams, buildKeycloakAdminEndpoints, createKeycloakAdminClient, isKeycloakAdminError, keycloakAdminConfigSchema, parseKeycloakAdminConfig };
+export { type CreateKeycloakAdminClientParams, type CreateUserParams, type CreateUserResult, type DeleteUserParams, type FetchLike, type FindUserByEmailParams, KEYCLOAK_ADMIN_ERROR_CODE, KEYCLOAK_ADMIN_TOKEN_RENEWAL_SKEW_MS, type KeycloakAdminClient, type KeycloakAdminConfig, type KeycloakAdminEndpoints, KeycloakAdminError, type KeycloakAdminErrorCode, type KeycloakAdminErrorContext, type KeycloakAdminErrorParams, type KeycloakPassword, type KeycloakUser, type KeycloakUserAttributes, type ListUsersParams, type ListUsersResult, type SerializedKeycloakAdminError, type SetEnabledParams, type SetPasswordParams, type SetTemporaryPasswordParams, type UpdateAttributesParams, type UpdateUserParams, buildKeycloakAdminEndpoints, createKeycloakAdminClient, isKeycloakAdminError, keycloakAdminConfigSchema, parseKeycloakAdminConfig };

package/dist/index.js

@@ -293,6 +293,17 @@ function createKeycloakAdminClient({
       const found = await response.json();
       return found.at(0);
     },
+    /**
+     * Pede um a mais que o limite para saber se há próxima página sem uma segunda chamada — o
+     * Keycloak não devolve total, e contar o realm inteiro só para desenhar um botão é caro.
+     */
+    async listUsers({ first = 0, limit = 100, search } = {}) {
+      const query = new URLSearchParams({ first: String(first), max: String(limit + 1) });
+      if (search !== void 0 && search !== "") query.set("search", search);
+      const response = await adminRequest({ method: "GET", url: `${endpoints.users}?${query}` });
+      const found = await response.json();
+      return { hasMore: found.length > limit, users: found.slice(0, limit) };
+    },
     async setEnabled({ enabled, userId }) {
       await adminRequest({ body: { enabled }, method: "PUT", url: endpoints.user(userId) });
     },

package/package.json

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