@adatechnology/auth-keycloak 0.0.1

package/README.md

@@ -0,0 +1,81 @@
+## @adatechnology/auth-keycloak
+
+Módulo Keycloak para autenticação de clients e usuários, seguindo o padrão do `HttpModule` do monorepo.
+
+Este pacote fornece um cliente leve para interagir com o Keycloak (obter/refresh de tokens, introspecção, userinfo)
+e um interceptor opcional. O módulo foi projetado para ser usado junto ao `@adatechnology/http-client`.
+
+Principais exportações
+
+- `KeycloakModule` — módulo principal. Suporta `KeycloakModule.forRoot(config?)` (padrão dinâmico).
+- `KEYCLOAK_CLIENT` — provider token para injetar o cliente Keycloak (use `@Inject(KEYCLOAK_CLIENT)`).
+- `KEYCLOAK_HTTP_INTERCEPTOR` — provider token para injetar o interceptor (se necessário).
+
+Instalação
+
+Este pacote já declara dependência interna de workspace para `@adatechnology/http-client`. Em um monorepo PNPM/Turbo o pacote é resolvido automaticamente.
+
+Uso
+
+- Configuração via código (recomendado quando quiser injetar configuração manualmente):
+
+```ts
+import { Module } from "@nestjs/common";
+import { HttpModule } from "@adatechnology/http-client";
+import { KeycloakModule } from "@adatechnology/auth-keycloak";
+
+@Module({
+  imports: [
+    HttpModule.forRoot({ baseURL: "https://pokeapi.co/api/v2", timeout: 5000 }),
+    KeycloakModule.forRoot({
+      baseUrl: "https://keycloak.example.com",
+      realm: "BACKEND",
+      credentials: {
+        clientId: "backend-api",
+        clientSecret: "backend-api-secret",
+        grantType: "client_credentials",
+      },
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+- Configuração via `ConfigService` / variáveis de ambiente (padrão quando não passar `forRoot`):
+
+As variáveis usadas pelo módulo interno são:
+
+- `KEYCLOAK_BASE_URL` (padrão: `http://localhost:8081`)
+- `KEYCLOAK_REALM` (padrão: `BACKEND`)
+- `KEYCLOAK_CLIENT_ID` (padrão: `backend-api`)
+- `KEYCLOAK_CLIENT_SECRET` (padrão: `backend-api-secret`)
+
+API rápida (via token)
+
+- `KEYCLOAK_CLIENT.getAccessToken()` — obtém token com cache e deduplicação de requisições.
+- `KEYCLOAK_CLIENT.refreshToken(refreshToken)` — renova token.
+- `KEYCLOAK_CLIENT.validateToken(token)` — introspecção no Keycloak.
+- `KEYCLOAK_CLIENT.getUserInfo(token)` — retorna userinfo.
+
+Exemplo de injeção no NestJS:
+
+```ts
+import { Inject } from '@nestjs/common';
+import { KEYCLOAK_CLIENT } from '@adatechnology/auth-keycloak';
+import type { KeycloakClientInterface } from '@adatechnology/auth-keycloak';
+
+constructor(@Inject(KEYCLOAK_CLIENT) private readonly keycloakClient: KeycloakClientInterface) {}
+```
+
+Notas
+
+- Este módulo depende de `@adatechnology/http-client` (provider `HTTP_PROVIDER`) para realizar chamadas HTTP ao Keycloak. Configure o `HttpModule` conforme necessário na aplicação que consome este pacote.
+- O interceptor `KeycloakHttpInterceptor` é fornecido caso queira integrar com outras camadas que aceitem interceptors.
+
+Contribuições
+
+Relate issues/PRs no repositório principal. Mantenha compatibilidade com o padrão usado pelo `HttpModule`.
+
+Licença
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,65 @@
+import { DynamicModule } from '@nestjs/common';
+import { AxiosRequestConfig, AxiosInstance } from 'axios';
+
+/**
+ * Keycloak token response
+ */
+interface KeycloakTokenResponse {
+    access_token: string;
+    expires_in: number;
+    refresh_expires_in: number;
+    refresh_token: string;
+    token_type: string;
+    'not-before-policy': number;
+    session_state: string;
+    scope: string;
+}
+/**
+ * Keycloak client credentials
+ */
+interface KeycloakCredentials {
+    clientId: string;
+    clientSecret: string;
+    username?: string;
+    password?: string;
+    grantType: 'client_credentials' | 'password';
+}
+/**
+ * Keycloak configuration
+ */
+interface KeycloakConfig {
+    baseUrl: string;
+    realm: string;
+    credentials: KeycloakCredentials;
+}
+/**
+ * Keycloak client interface
+ */
+interface KeycloakClientInterface {
+    /**
+     * Get access token
+     */
+    getAccessToken(): Promise<string>;
+    /**
+     * Refresh access token
+     */
+    refreshToken(refreshToken: string): Promise<KeycloakTokenResponse>;
+    /**
+     * Validate token
+     */
+    validateToken(token: string): Promise<boolean>;
+    /**
+     * Get user info
+     */
+    getUserInfo(token: string): Promise<any>;
+}
+
+declare class KeycloakModule {
+    static forRoot(config: KeycloakConfig, httpConfig?: AxiosRequestConfig | AxiosInstance): DynamicModule;
+}
+
+declare const KEYCLOAK_CONFIG = "KEYCLOAK_CONFIG";
+declare const KEYCLOAK_CLIENT = "KEYCLOAK_CLIENT";
+declare const KEYCLOAK_HTTP_INTERCEPTOR = "KEYCLOAK_HTTP_INTERCEPTOR";
+
+export { KEYCLOAK_CLIENT, KEYCLOAK_CONFIG, KEYCLOAK_HTTP_INTERCEPTOR, KeycloakClientInterface, KeycloakConfig, KeycloakModule, KeycloakTokenResponse };