@pawells/nestjs-auth 1.0.0-dev.4c8c698

package/build/admin/client/services/realm.service.js

@@ -0,0 +1,80 @@
+import { BaseService } from './base-service.js';
+/**
+ * Service for managing Keycloak realms.
+ *
+ * Provides methods for querying and updating realm-level configuration, including realm properties,
+ * security policy, login settings, and event configuration. Requires `realms:read` and `realms:write`
+ * scopes depending on the operation.
+ *
+ * Part of {@link KeycloakAdminService.realms | KeycloakAdminService#realms}.
+ *
+ * @example
+ * ```typescript
+ * const realm = await keycloak.realms.get('my-realm');
+ * const realms = await keycloak.realms.list();
+ * await keycloak.realms.update('my-realm', { accessTokenLifespan: 3600 });
+ * ```
+ */
+export class RealmService extends BaseService {
+    /**
+     * List all realms
+     */
+    async list() {
+        this.requireScope('realms:read');
+        try {
+            return (await this.withRetry(() => this.adminClient.realms.find()));
+        }
+        catch (error) {
+            return this.handleError(error);
+        }
+    }
+    /**
+     * Get a realm by name
+     */
+    async get(realm) {
+        this.requireScope('realms:read');
+        try {
+            return (await this.withRetry(() => this.adminClient.realms.findOne({ realm })));
+        }
+        catch (error) {
+            return this.handleError(error);
+        }
+    }
+    /**
+     * Create a new realm
+     */
+    async create(realm) {
+        this.requireScope('realms:write');
+        try {
+            await this.withRetry(() => this.adminClient.realms.create(realm));
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+    /**
+     * Update a realm
+     */
+    async update(realmName, realm) {
+        this.requireScope('realms:write');
+        try {
+            await this.withRetry(() => this.adminClient.realms.update({ realm: realmName }, realm));
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+    /**
+     * Delete a realm
+     */
+    async delete(realm) {
+        this.requireScope('realms:write');
+        try {
+            await this.withRetry(() => this.adminClient.realms.del({ realm }));
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+}
+//# sourceMappingURL=realm.service.js.map

package/build/admin/client/services/realm.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"realm.service.js","sourceRoot":"","sources":["../../../../src/admin/client/services/realm.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC5C;;OAEG;IACI,KAAK,CAAC,IAAI;QAChB,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACjC,IAAI,CAAC;YACJ,OAAO,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAQ,CAAC;QAC5E,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,GAAG,CAAC,KAAa;QAC7B,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACjC,IAAI,CAAC;YACJ,OAAO,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,CAC1C,CAAQ,CAAC;QACX,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM,CAAC,KAA0B;QAC7C,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;QAClC,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACnE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,KAA0B;QAChE,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;QAClC,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CACzB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,KAAK,CAAC,CAC3D,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM,CAAC,KAAa;QAChC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;QAClC,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QACpE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;IACF,CAAC;CACD"}

package/build/admin/client/services/role.service.d.ts

@@ -0,0 +1,45 @@
+import type { RoleRepresentation } from '../types/index.js';
+import { BaseService } from './base-service.js';
+/**
+ * Service for managing Keycloak roles.
+ *
+ * Provides methods for creating, listing, and deleting both realm-wide and client-specific roles.
+ * Realm roles are shared across all clients in the realm, while client roles are scoped to a single client.
+ * Requires `roles:read` and `roles:write` scopes depending on the operation.
+ *
+ * Part of {@link KeycloakAdminService.roles | KeycloakAdminService#roles}.
+ *
+ * @example
+ * ```typescript
+ * const roles = await keycloak.roles.listRealm('my-realm');
+ * const adminRole = await keycloak.roles.getByName('my-realm', 'admin');
+ * await keycloak.roles.create('my-realm', { name: 'editor', enabled: true });
+ * ```
+ */
+export declare class RoleService extends BaseService {
+    /**
+     * List all realm roles
+     */
+    listRealm(realm: string): Promise<RoleRepresentation[]>;
+    /**
+     * List client roles
+     */
+    listClient(realm: string, clientId: string): Promise<RoleRepresentation[]>;
+    /**
+     * Get a realm role by name
+     */
+    getByName(realm: string, name: string): Promise<RoleRepresentation>;
+    /**
+     * Create a realm role
+     */
+    create(realm: string, role: RoleRepresentation): Promise<void>;
+    /**
+     * Update a realm role
+     */
+    update(realm: string, name: string, role: RoleRepresentation): Promise<void>;
+    /**
+     * Delete a realm role
+     */
+    delete(realm: string, name: string): Promise<void>;
+}
+//# sourceMappingURL=role.service.d.ts.map

package/build/admin/client/services/role.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"role.service.d.ts","sourceRoot":"","sources":["../../../../src/admin/client/services/role.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC3C;;OAEG;IACU,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IASpE;;OAEG;IACU,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAWvF;;OAEG;IACU,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAWhF;;OAEG;IACU,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAS3E;;OAEG;IACU,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAWzF;;OAEG;IACU,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAQ/D"}

package/build/admin/client/services/role.service.js

@@ -0,0 +1,92 @@
+import { BaseService } from './base-service.js';
+/**
+ * Service for managing Keycloak roles.
+ *
+ * Provides methods for creating, listing, and deleting both realm-wide and client-specific roles.
+ * Realm roles are shared across all clients in the realm, while client roles are scoped to a single client.
+ * Requires `roles:read` and `roles:write` scopes depending on the operation.
+ *
+ * Part of {@link KeycloakAdminService.roles | KeycloakAdminService#roles}.
+ *
+ * @example
+ * ```typescript
+ * const roles = await keycloak.roles.listRealm('my-realm');
+ * const adminRole = await keycloak.roles.getByName('my-realm', 'admin');
+ * await keycloak.roles.create('my-realm', { name: 'editor', enabled: true });
+ * ```
+ */
+export class RoleService extends BaseService {
+    /**
+     * List all realm roles
+     */
+    async listRealm(realm) {
+        this.requireScope('roles:read');
+        try {
+            return (await this.withRetry(() => this.adminClient.roles.find({ realm })));
+        }
+        catch (error) {
+            return this.handleError(error);
+        }
+    }
+    /**
+     * List client roles
+     */
+    async listClient(realm, clientId) {
+        this.requireScope('roles:read');
+        try {
+            return (await this.withRetry(() => this.adminClient.clients.listRoles({ realm, id: clientId })));
+        }
+        catch (error) {
+            return this.handleError(error);
+        }
+    }
+    /**
+     * Get a realm role by name
+     */
+    async getByName(realm, name) {
+        this.requireScope('roles:read');
+        try {
+            return (await this.withRetry(() => this.adminClient.roles.findOneByName({ realm, name })));
+        }
+        catch (error) {
+            return this.handleError(error);
+        }
+    }
+    /**
+     * Create a realm role
+     */
+    async create(realm, role) {
+        this.requireScope('roles:write');
+        try {
+            await this.withRetry(() => this.adminClient.roles.create({ ...role, realm }));
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+    /**
+     * Update a realm role
+     */
+    async update(realm, name, role) {
+        this.requireScope('roles:write');
+        try {
+            await this.withRetry(() => this.adminClient.roles.updateByName({ realm, name }, role));
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+    /**
+     * Delete a realm role
+     */
+    async delete(realm, name) {
+        this.requireScope('roles:write');
+        try {
+            await this.withRetry(() => this.adminClient.roles.delByName({ realm, name }));
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+}
+//# sourceMappingURL=role.service.js.map

package/build/admin/client/services/role.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"role.service.js","sourceRoot":"","sources":["../../../../src/admin/client/services/role.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC3C;;OAEG;IACI,KAAK,CAAC,SAAS,CAAC,KAAa;QACnC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAChC,IAAI,CAAC;YACJ,OAAO,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAQ,CAAC;QACpF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,UAAU,CAAC,KAAa,EAAE,QAAgB;QACtD,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAChC,IAAI,CAAC;YACJ,OAAO,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,CAC3D,CAAQ,CAAC;QACX,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CAAC,KAAa,EAAE,IAAY;QACjD,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAChC,IAAI,CAAC;YACJ,OAAO,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CACrD,CAAQ,CAAC;QACX,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,IAAwB;QAC1D,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACjC,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAC/E,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,IAAY,EAAE,IAAwB;QACxE,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACjC,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CACzB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,CAAC,CAC1D,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,IAAY;QAC9C,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACjC,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC/E,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;IACF,CAAC;CACD"}

package/build/admin/client/services/user.service.d.ts

@@ -0,0 +1,84 @@
+import type { UserRepresentation, UserQuery, CredentialRepresentation, RoleRepresentation } from '../types/index.js';
+import { BaseService } from './base-service.js';
+/**
+ * Service for managing Keycloak users.
+ *
+ * Provides methods for CRUD operations on Keycloak users, including user creation,
+ * role assignment, group membership, and credential management. Requires `users:read`
+ * and `users:write` scopes depending on the operation.
+ *
+ * Part of {@link KeycloakAdminService.users | KeycloakAdminService#users}.
+ *
+ * @example
+ * ```typescript
+ * const users = await keycloak.users.list('my-realm');
+ * await keycloak.users.create('my-realm', {
+ *   email: 'user@example.com',
+ *   firstName: 'John',
+ *   lastName: 'Doe',
+ *   enabled: true,
+ * });
+ * ```
+ */
+export declare class UserService extends BaseService {
+    /**
+     * List users in a realm
+     */
+    list(realm: string, query?: UserQuery): Promise<UserRepresentation[]>;
+    /**
+     * Get a user by ID
+     */
+    get(realm: string, userId: string): Promise<UserRepresentation>;
+    /**
+     * Create a new user
+     */
+    create(realm: string, user: UserRepresentation): Promise<{
+        id: string;
+    }>;
+    /**
+     * Update a user
+     */
+    update(realm: string, userId: string, user: UserRepresentation): Promise<void>;
+    /**
+     * Delete a user
+     */
+    delete(realm: string, userId: string): Promise<void>;
+    /**
+     * Reset a user's password
+     */
+    resetPassword(realm: string, userId: string, credential: CredentialRepresentation): Promise<void>;
+    /**
+     * Add realm roles to a user
+     */
+    addRealmRoles(realm: string, userId: string, roles: RoleRepresentation[]): Promise<void>;
+    /**
+     * Get realm roles for a user
+     */
+    getRealmRoles(realm: string, userId: string): Promise<RoleRepresentation[]>;
+    /**
+     * Delete realm roles from a user
+     */
+    deleteRealmRoles(realm: string, userId: string, roles: RoleRepresentation[]): Promise<void>;
+    /**
+     * Add client roles to a user
+     */
+    addClientRoles(realm: string, userId: string, clientId: string, roles: RoleRepresentation[]): Promise<void>;
+    /**
+     * Get client roles for a user
+     */
+    getClientRoles(realm: string, userId: string, clientId: string): Promise<RoleRepresentation[]>;
+    /**
+     * Delete client roles from a user
+     */
+    deleteClientRoles(realm: string, userId: string, clientId: string, roles: RoleRepresentation[]): Promise<void>;
+    /**
+     * Find a user by their federated identity (external provider ID).
+     * Useful for adapter microservices looking up users by Steam ID, Nintendo ID, etc.
+     * Returns null if no user is found.
+     *
+     * @param idpAlias - The identity provider alias configured in Keycloak (e.g. 'steam')
+     * @param idpUserId - The user's ID at the external provider
+     */
+    findByFederatedIdentity(idpAlias: string, idpUserId: string): Promise<UserRepresentation | null>;
+}
+//# sourceMappingURL=user.service.d.ts.map

package/build/admin/client/services/user.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.service.d.ts","sourceRoot":"","sources":["../../../../src/admin/client/services/user.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,kBAAkB,EAClB,SAAS,EACT,wBAAwB,EACxB,kBAAkB,EAClB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC3C;;OAEG;IACU,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAWlF;;OAEG;IACU,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAW5E;;OAEG;IACU,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC;IAWrF;;OAEG;IACU,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAW3F;;OAEG;IACU,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAWjE;;OAEG;IACU,aAAa,CACzB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,wBAAwB,GAClC,OAAO,CAAC,IAAI,CAAC;IAehB;;OAEG;IACU,aAAa,CACzB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,kBAAkB,EAAE,GACzB,OAAO,CAAC,IAAI,CAAC;IAehB;;OAEG;IACU,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAWxF;;OAEG;IACU,gBAAgB,CAC5B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,kBAAkB,EAAE,GACzB,OAAO,CAAC,IAAI,CAAC;IAehB;;OAEG;IACU,cAAc,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,kBAAkB,EAAE,GACzB,OAAO,CAAC,IAAI,CAAC;IAgBhB;;OAEG;IACU,cAAc,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,GACd,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAehC;;OAEG;IACU,iBAAiB,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,kBAAkB,EAAE,GACzB,OAAO,CAAC,IAAI,CAAC;IAgBhB;;;;;;;OAOG;IACU,uBAAuB,CACnC,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,GACf,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC;CAgBrC"}

package/build/admin/client/services/user.service.js

@@ -0,0 +1,216 @@
+import { BaseService } from './base-service.js';
+/**
+ * Service for managing Keycloak users.
+ *
+ * Provides methods for CRUD operations on Keycloak users, including user creation,
+ * role assignment, group membership, and credential management. Requires `users:read`
+ * and `users:write` scopes depending on the operation.
+ *
+ * Part of {@link KeycloakAdminService.users | KeycloakAdminService#users}.
+ *
+ * @example
+ * ```typescript
+ * const users = await keycloak.users.list('my-realm');
+ * await keycloak.users.create('my-realm', {
+ *   email: 'user@example.com',
+ *   firstName: 'John',
+ *   lastName: 'Doe',
+ *   enabled: true,
+ * });
+ * ```
+ */
+export class UserService extends BaseService {
+    /**
+     * List users in a realm
+     */
+    async list(realm, query) {
+        this.requireScope('users:read');
+        try {
+            return (await this.withRetry(() => this.adminClient.users.find({ ...query, realm })));
+        }
+        catch (error) {
+            return this.handleError(error);
+        }
+    }
+    /**
+     * Get a user by ID
+     */
+    async get(realm, userId) {
+        this.requireScope('users:read');
+        try {
+            return (await this.withRetry(() => this.adminClient.users.findOne({ realm, id: userId })));
+        }
+        catch (error) {
+            return this.handleError(error);
+        }
+    }
+    /**
+     * Create a new user
+     */
+    async create(realm, user) {
+        this.requireScope('users:write');
+        try {
+            return await this.withRetry(() => this.adminClient.users.create({ ...user, realm }));
+        }
+        catch (error) {
+            return this.handleError(error);
+        }
+    }
+    /**
+     * Update a user
+     */
+    async update(realm, userId, user) {
+        this.requireScope('users:write');
+        try {
+            await this.withRetry(() => this.adminClient.users.update({ realm, id: userId }, user));
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+    /**
+     * Delete a user
+     */
+    async delete(realm, userId) {
+        this.requireScope('users:write');
+        try {
+            await this.withRetry(() => this.adminClient.users.del({ realm, id: userId }));
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+    /**
+     * Reset a user's password
+     */
+    async resetPassword(realm, userId, credential) {
+        this.requireScope('users:write');
+        try {
+            await this.withRetry(() => this.adminClient.users.resetPassword({
+                realm,
+                id: userId,
+                credential,
+            }));
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+    /**
+     * Add realm roles to a user
+     */
+    async addRealmRoles(realm, userId, roles) {
+        this.requireScope('users:write');
+        try {
+            await this.withRetry(() => this.adminClient.users.addRealmRoleMappings({
+                realm,
+                id: userId,
+                roles: roles,
+            }));
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+    /**
+     * Get realm roles for a user
+     */
+    async getRealmRoles(realm, userId) {
+        this.requireScope('users:read');
+        try {
+            return (await this.withRetry(() => this.adminClient.users.listRealmRoleMappings({ realm, id: userId })));
+        }
+        catch (error) {
+            return this.handleError(error);
+        }
+    }
+    /**
+     * Delete realm roles from a user
+     */
+    async deleteRealmRoles(realm, userId, roles) {
+        this.requireScope('users:write');
+        try {
+            await this.withRetry(() => this.adminClient.users.delRealmRoleMappings({
+                realm,
+                id: userId,
+                roles: roles,
+            }));
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+    /**
+     * Add client roles to a user
+     */
+    async addClientRoles(realm, userId, clientId, roles) {
+        this.requireScope('users:write');
+        try {
+            await this.withRetry(() => this.adminClient.users.addClientRoleMappings({
+                realm,
+                id: userId,
+                clientUniqueId: clientId,
+                roles: roles,
+            }));
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+    /**
+     * Get client roles for a user
+     */
+    async getClientRoles(realm, userId, clientId) {
+        this.requireScope('users:read');
+        try {
+            return (await this.withRetry(() => this.adminClient.users.listClientRoleMappings({
+                realm,
+                id: userId,
+                clientUniqueId: clientId,
+            })));
+        }
+        catch (error) {
+            return this.handleError(error);
+        }
+    }
+    /**
+     * Delete client roles from a user
+     */
+    async deleteClientRoles(realm, userId, clientId, roles) {
+        this.requireScope('users:write');
+        try {
+            await this.withRetry(() => this.adminClient.users.delClientRoleMappings({
+                realm,
+                id: userId,
+                clientUniqueId: clientId,
+                roles: roles,
+            }));
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+    /**
+     * Find a user by their federated identity (external provider ID).
+     * Useful for adapter microservices looking up users by Steam ID, Nintendo ID, etc.
+     * Returns null if no user is found.
+     *
+     * @param idpAlias - The identity provider alias configured in Keycloak (e.g. 'steam')
+     * @param idpUserId - The user's ID at the external provider
+     */
+    async findByFederatedIdentity(idpAlias, idpUserId) {
+        this.requireScope('users:read');
+        try {
+            const results = (await this.withRetry(() => this.adminClient.users.find({
+                idpAlias,
+                idpUserId,
+                exact: true,
+            })));
+            return results[0] ?? null;
+        }
+        catch (error) {
+            return this.handleError(error);
+        }
+    }
+}
+//# sourceMappingURL=user.service.js.map

package/build/admin/client/services/user.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.service.js","sourceRoot":"","sources":["../../../../src/admin/client/services/user.service.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC3C;;OAEG;IACI,KAAK,CAAC,IAAI,CAAC,KAAa,EAAE,KAAiB;QACjD,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAChC,IAAI,CAAC;YACJ,OAAO,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,CAAC,CAChD,CAAQ,CAAC;QACX,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,GAAG,CAAC,KAAa,EAAE,MAAc;QAC7C,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAChC,IAAI,CAAC;YACJ,OAAO,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CACrD,CAAQ,CAAC;QACX,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,IAAwB;QAC1D,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACjC,IAAI,CAAC;YACJ,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAChC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,CAAC,CACjD,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,MAAc,EAAE,IAAwB;QAC1E,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACjC,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CACzB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,CAAC,CAC1D,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,MAAc;QAChD,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACjC,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CACzB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CACjD,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,aAAa,CACzB,KAAa,EACb,MAAc,EACd,UAAoC;QAEpC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACjC,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CACzB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,aAAa,CAAC;gBACpC,KAAK;gBACL,EAAE,EAAE,MAAM;gBACV,UAAU;aACV,CAAC,CACF,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,aAAa,CACzB,KAAa,EACb,MAAc,EACd,KAA2B;QAE3B,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACjC,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CACzB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,oBAAoB,CAAC;gBAC3C,KAAK;gBACL,EAAE,EAAE,MAAM;gBACV,KAAK,EAAE,KAAY;aACnB,CAAC,CACF,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,aAAa,CAAC,KAAa,EAAE,MAAc;QACvD,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAChC,IAAI,CAAC;YACJ,OAAO,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,qBAAqB,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CACnE,CAAQ,CAAC;QACX,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,gBAAgB,CAC5B,KAAa,EACb,MAAc,EACd,KAA2B;QAE3B,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACjC,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CACzB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,oBAAoB,CAAC;gBAC3C,KAAK;gBACL,EAAE,EAAE,MAAM;gBACV,KAAK,EAAE,KAAY;aACnB,CAAC,CACF,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc,CAC1B,KAAa,EACb,MAAc,EACd,QAAgB,EAChB,KAA2B;QAE3B,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACjC,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CACzB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,qBAAqB,CAAC;gBAC5C,KAAK;gBACL,EAAE,EAAE,MAAM;gBACV,cAAc,EAAE,QAAQ;gBACxB,KAAK,EAAE,KAAY;aACnB,CAAC,CACF,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc,CAC1B,KAAa,EACb,MAAc,EACd,QAAgB;QAEhB,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAChC,IAAI,CAAC;YACJ,OAAO,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,sBAAsB,CAAC;gBAC7C,KAAK;gBACL,EAAE,EAAE,MAAM;gBACV,cAAc,EAAE,QAAQ;aACxB,CAAC,CACF,CAAQ,CAAC;QACX,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,iBAAiB,CAC7B,KAAa,EACb,MAAc,EACd,QAAgB,EAChB,KAA2B;QAE3B,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACjC,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CACzB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,qBAAqB,CAAC;gBAC5C,KAAK;gBACL,EAAE,EAAE,MAAM;gBACV,cAAc,EAAE,QAAQ;gBACxB,KAAK,EAAE,KAAY;aACnB,CAAC,CACF,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;IACF,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,uBAAuB,CACnC,QAAgB,EAChB,SAAiB;QAEjB,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAChC,IAAI,CAAC;YACJ,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAC1C,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC3B,QAAQ;gBACR,SAAS;gBACT,KAAK,EAAE,IAAI;aACX,CAAC,CACF,CAAyB,CAAC;YAE3B,OAAO,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;QAC3B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACF,CAAC;CACD"}

package/build/admin/client/types/config.types.d.ts

@@ -0,0 +1,59 @@
+import type { RetryConfig } from '../utils/index.js';
+import type { Logger } from '@pawells/logger';
+/**
+ * Keycloak client configuration
+ */
+export interface KeycloakClientConfig {
+    /**
+     * Base URL of the Keycloak server
+     * @example 'http://localhost:8080'
+     */
+    baseUrl: string;
+    /**
+     * Realm name to operate on
+     * @default 'master'
+     */
+    realmName?: string;
+    /**
+     * Authentication credentials
+     */
+    credentials: KeycloakCredentials;
+    /**
+     * Request timeout in milliseconds
+     * @default 30000
+     */
+    timeout?: number;
+    /**
+     * Retry configuration
+     */
+    retry?: RetryConfig;
+    /**
+     * Logger instance for client logging
+     */
+    logger?: Logger;
+}
+/**
+ * Keycloak authentication credentials (username/password or client credentials)
+ */
+export type KeycloakCredentials = {
+    username: string;
+    password: string;
+} | {
+    clientId: string;
+    clientSecret: string;
+};
+/**
+ * Check if credentials are username/password
+ */
+export declare function isPasswordCredentials(credentials: KeycloakCredentials): credentials is {
+    username: string;
+    password: string;
+};
+/**
+ * Check if credentials are client credentials
+ */
+export declare function isClientCredentials(credentials: KeycloakCredentials): credentials is {
+    clientId: string;
+    clientSecret: string;
+};
+//# sourceMappingURL=config.types.d.ts.map

package/build/admin/client/types/config.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.types.d.ts","sourceRoot":"","sources":["../../../../src/admin/client/types/config.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,mBAAmB,CAAC;IAEjC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC5B;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CACjB,GACC;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACrB,CAAC;AAEH;;GAEG;AACH,wBAAgB,qBAAqB,CACpC,WAAW,EAAE,mBAAmB,GAC9B,WAAW,IAAI;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAEvD;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAClC,WAAW,EAAE,mBAAmB,GAC9B,WAAW,IAAI;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE,CAE3D"}

package/build/admin/client/types/config.types.js

@@ -0,0 +1,13 @@
+/**
+ * Check if credentials are username/password
+ */
+export function isPasswordCredentials(credentials) {
+    return 'username' in credentials && 'password' in credentials;
+}
+/**
+ * Check if credentials are client credentials
+ */
+export function isClientCredentials(credentials) {
+    return 'clientId' in credentials && 'clientSecret' in credentials;
+}
+//# sourceMappingURL=config.types.js.map

package/build/admin/client/types/config.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.types.js","sourceRoot":"","sources":["../../../../src/admin/client/types/config.types.ts"],"names":[],"mappings":"AAsDA;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACpC,WAAgC;IAEhC,OAAO,UAAU,IAAI,WAAW,IAAI,UAAU,IAAI,WAAW,CAAC;AAC/D,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAClC,WAAgC;IAEhC,OAAO,UAAU,IAAI,WAAW,IAAI,cAAc,IAAI,WAAW,CAAC;AACnE,CAAC"}