@ssplib/react-components 0.0.327 → 0.0.329

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ssplib/react-components",
-    "version": "0.0.327",
+    "version": "0.0.329",
     "description": "SSP React Components",
     "author": "Pedro Henrique <sr.hudrick@gmail.com>",
     "license": "MIT",

package/types/auth.d.ts

@@ -1,15 +1,52 @@
-import { KeycloakTokenParsed } from 'keycloak-js';
+import { KeycloakLoginOptions, KeycloakLogoutOptions, KeycloakTokenParsed } from 'keycloak-js';
+export type { KeycloakLoginOptions, KeycloakLogoutOptions, KeycloakTokenParsed };
 export interface User extends KeycloakTokenParsed {
     token: string | undefined;
-    roles: any[];
+    roles: string[];
     image?: string;
 }
+/**
+ * Opções customizadas para o login do Keycloak
+ * Extende KeycloakLoginOptions com callbacks adicionais
+ *
+ * Opções nativas do Keycloak incluídas:
+ * - `redirectUri`: URI para redirecionar após login
+ * - `prompt`: Controla comportamento de prompt ('none' | 'login' | 'consent')
+ * - `maxAge`: Tempo máximo desde última autenticação
+ * - `loginHint`: Preenche campo de login automaticamente
+ * - `idpHint`: Pula para um IdP específico (ex: 'google', 'facebook')
+ * - `action`: Ação a executar ('register' para registro)
+ * - `locale`: Localidade preferida para o login
+ * - `acr`: Authentication Context Class Reference
+ * - `scope`: Escopos adicionais a solicitar
+ * - `cordovaOptions`: Opções específicas para Cordova
+ */
+export interface LoginOptions extends KeycloakLoginOptions {
+    /** Callback executado após login bem-sucedido */
+    onSuccess?: () => void;
+    /** Callback executado em caso de erro no login */
+    onError?: (error: Error) => void;
+}
+/**
+ * Opções customizadas para o logout do Keycloak
+ * Extende KeycloakLogoutOptions com callbacks adicionais
+ *
+ * Opções nativas do Keycloak incluídas:
+ * - `redirectUri`: URI para redirecionar após logout
+ * - `logoutMethod`: Método de logout ('GET' | 'POST') - POST para RP-Initiated Logout
+ */
+export interface LogoutOptions extends KeycloakLogoutOptions {
+    /** Callback executado antes do logout (pode ser async para cleanup) */
+    onBeforeLogout?: () => void | Promise<void>;
+    /** Callback executado após logout bem-sucedido */
+    onSuccess?: () => void;
+}
 export interface AuthData {
     isAuth: boolean;
     user: User | null | undefined;
     userLoaded: boolean;
-    login: () => void;
-    logout: () => void;
+    login: (options?: LoginOptions) => void;
+    logout: (options?: LogoutOptions) => void;
 }
 export interface AuthClaims {
     sub: string;
@@ -62,11 +99,28 @@ export interface AuthSspToken {
     sub: string;
 }
 export interface AuthReturnData {
+    /** Indica se o usuário está autenticado */
     isAuth: boolean;
+    /** Tipo de autenticação */
     type: 'govbr' | 'ad';
-    user: User | null | undefined;
+    /** Dados do usuário autenticado */
+    user: User | null;
+    /** Indica se os dados do usuário já foram carregados (loading completo) */
     userLoaded: boolean;
-    login: () => void;
+    /** Inicia o fluxo de login com opções customizáveis */
+    login: (options?: LoginOptions) => void;
+    /** Salva dados do usuário vindos de token externo */
     saveUserData: (token: AuthReturn) => void;
-    logout: () => void;
+    /** Inicia o fluxo de logout com opções customizáveis */
+    logout: (options?: LogoutOptions) => void;
+    /** Atualiza o token manualmente */
+    refreshToken: () => Promise<boolean>;
+    /** Verifica se o usuário possui uma role específica */
+    hasRole: (role: string) => boolean;
+    /** Verifica se o usuário possui todas as roles especificadas */
+    hasAllRoles: (roles: string[]) => boolean;
+    /** Verifica se o usuário possui pelo menos uma das roles especificadas */
+    hasAnyRole: (roles: string[]) => boolean;
+    /** Token de acesso atual */
+    accessToken: string | undefined;
 }