forlogic-core 1.10.2 → 1.10.3

package/README.md

@@ -218,6 +218,105 @@ VITE_IS_QUALIEX=true
 
 ---
 
+## 🚀 Quick Setup: CoreProviders
+
+O `CoreProviders` é um componente que encapsula todos os providers essenciais da biblioteca, simplificando drasticamente a configuração de novos projetos.
+
+### O que está incluído
+
+O `CoreProviders` encapsula automaticamente:
+
+| Provider | Descrição |
+|----------|-----------|
+| `ErrorBoundary` | Captura e trata erros de renderização React |
+| `I18nextProvider` | Sistema de internacionalização (i18n) |
+| `QueryClientProvider` | Cache e gerenciamento de queries (React Query) |
+| `AuthProvider` | Autenticação e gerenciamento de sessão |
+| `LocaleProvider` | Gerenciamento de locale (idioma, timezone, formato de data) |
+| `TranslationLoader` | Carregamento dinâmico de traduções do banco de dados |
+
+### Uso Básico
+
+```tsx
+import { CoreProviders } from 'forlogic-core';
+import { BrowserRouter, Routes, Route } from 'react-router-dom';
+
+function App() {
+  return (
+    <CoreProviders>
+      <BrowserRouter>
+        <Routes>
+          {/* Suas rotas aqui */}
+        </Routes>
+      </BrowserRouter>
+    </CoreProviders>
+  );
+}
+```
+
+### Com QueryClient Customizado
+
+Se você precisar de configurações específicas para o React Query:
+
+```tsx
+import { CoreProviders } from 'forlogic-core';
+import { QueryClient } from '@tanstack/react-query';
+import { BrowserRouter } from 'react-router-dom';
+
+const queryClient = new QueryClient({
+  defaultOptions: {
+    queries: {
+      staleTime: 10 * 60 * 1000, // 10 minutos
+      retry: 2,
+      refetchOnWindowFocus: false,
+    },
+  },
+});
+
+function App() {
+  return (
+    <CoreProviders queryClient={queryClient}>
+      <BrowserRouter>
+        {/* Suas rotas */}
+      </BrowserRouter>
+    </CoreProviders>
+  );
+}
+```
+
+### Props
+
+| Prop | Tipo | Obrigatório | Descrição |
+|------|------|-------------|-----------|
+| `children` | `ReactNode` | ✅ | Componentes filhos a serem envolvidos |
+| `queryClient` | `QueryClient` | ❌ | Instância customizada do QueryClient. Se não fornecido, um default é criado |
+
+### QueryClient Default
+
+Se você não fornecer um `queryClient`, o `CoreProviders` cria um com as seguintes configurações:
+
+```typescript
+{
+  defaultOptions: {
+    queries: {
+      staleTime: 5 * 60 * 1000, // 5 minutos
+      retry: 1,
+    },
+  },
+}
+```
+
+### Benefícios
+
+- ✅ **Zero configuração de i18n** - Traduções funcionam automaticamente
+- ✅ **Autenticação pronta** - `useAuth()` disponível em qualquer componente filho
+- ✅ **Tratamento de erros** - ErrorBoundary captura erros de renderização
+- ✅ **React Query configurado** - Cache e queries prontos para uso
+- ✅ **Locale gerenciado** - Preferências de idioma, timezone e formato de data
+- ✅ **Atualizações centralizadas** - Novos providers são adicionados automaticamente
+
+---
+
 <!-- AUTO_GENERATED_START -->
 
 ### 📚 Estatísticas da Documentação

package/dist/README.md

@@ -218,6 +218,105 @@ VITE_IS_QUALIEX=true
 
 ---
 
+## 🚀 Quick Setup: CoreProviders
+
+O `CoreProviders` é um componente que encapsula todos os providers essenciais da biblioteca, simplificando drasticamente a configuração de novos projetos.
+
+### O que está incluído
+
+O `CoreProviders` encapsula automaticamente:
+
+| Provider | Descrição |
+|----------|-----------|
+| `ErrorBoundary` | Captura e trata erros de renderização React |
+| `I18nextProvider` | Sistema de internacionalização (i18n) |
+| `QueryClientProvider` | Cache e gerenciamento de queries (React Query) |
+| `AuthProvider` | Autenticação e gerenciamento de sessão |
+| `LocaleProvider` | Gerenciamento de locale (idioma, timezone, formato de data) |
+| `TranslationLoader` | Carregamento dinâmico de traduções do banco de dados |
+
+### Uso Básico
+
+```tsx
+import { CoreProviders } from 'forlogic-core';
+import { BrowserRouter, Routes, Route } from 'react-router-dom';
+
+function App() {
+  return (
+    <CoreProviders>
+      <BrowserRouter>
+        <Routes>
+          {/* Suas rotas aqui */}
+        </Routes>
+      </BrowserRouter>
+    </CoreProviders>
+  );
+}
+```
+
+### Com QueryClient Customizado
+
+Se você precisar de configurações específicas para o React Query:
+
+```tsx
+import { CoreProviders } from 'forlogic-core';
+import { QueryClient } from '@tanstack/react-query';
+import { BrowserRouter } from 'react-router-dom';
+
+const queryClient = new QueryClient({
+  defaultOptions: {
+    queries: {
+      staleTime: 10 * 60 * 1000, // 10 minutos
+      retry: 2,
+      refetchOnWindowFocus: false,
+    },
+  },
+});
+
+function App() {
+  return (
+    <CoreProviders queryClient={queryClient}>
+      <BrowserRouter>
+        {/* Suas rotas */}
+      </BrowserRouter>
+    </CoreProviders>
+  );
+}
+```
+
+### Props
+
+| Prop | Tipo | Obrigatório | Descrição |
+|------|------|-------------|-----------|
+| `children` | `ReactNode` | ✅ | Componentes filhos a serem envolvidos |
+| `queryClient` | `QueryClient` | ❌ | Instância customizada do QueryClient. Se não fornecido, um default é criado |
+
+### QueryClient Default
+
+Se você não fornecer um `queryClient`, o `CoreProviders` cria um com as seguintes configurações:
+
+```typescript
+{
+  defaultOptions: {
+    queries: {
+      staleTime: 5 * 60 * 1000, // 5 minutos
+      retry: 1,
+    },
+  },
+}
+```
+
+### Benefícios
+
+- ✅ **Zero configuração de i18n** - Traduções funcionam automaticamente
+- ✅ **Autenticação pronta** - `useAuth()` disponível em qualquer componente filho
+- ✅ **Tratamento de erros** - ErrorBoundary captura erros de renderização
+- ✅ **React Query configurado** - Cache e queries prontos para uso
+- ✅ **Locale gerenciado** - Preferências de idioma, timezone e formato de data
+- ✅ **Atualizações centralizadas** - Novos providers são adicionados automaticamente
+
+---
+
 <!-- AUTO_GENERATED_START -->
 
 ### 📚 Estatísticas da Documentação