@seedgrid/fe-core 2026.3.19-1 → 2026.3.19-3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +77 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# @seedgrid/fe-core
|
|
2
|
+
|
|
3
|
+
Biblioteca de infraestrutura que padroniza módulos, rotas, persistência e internacionalização do SeedGrid.
|
|
4
|
+
|
|
5
|
+
## Características
|
|
6
|
+
|
|
7
|
+
- **Registro centralizado** de provedores, itens de navegação e rotas (`SeedGridRegistry`).
|
|
8
|
+
- **Manifestos de módulos** com metadata, dependências de i18n e callbacks de registro.
|
|
9
|
+
- **Construção de chaves de persistência** (`buildSgPersistenceKey`) e estratégias (localStorage, API ou compostas).
|
|
10
|
+
- **Utilitários de i18n** para mesclar bundles e manter namespaces organizados.
|
|
11
|
+
- Tipagens prontas para ambientes, provedores e estratégias que facilitam a evolução do portal SeedGrid.
|
|
12
|
+
|
|
13
|
+
## Instalação
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
pnpm add @seedgrid/fe-core
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Como utilizar
|
|
20
|
+
|
|
21
|
+
```tsx
|
|
22
|
+
import {
|
|
23
|
+
SeedGridRegistry,
|
|
24
|
+
SeedGridModuleManifest,
|
|
25
|
+
createLocalStorageStrategy,
|
|
26
|
+
createCompositePersistenceStrategy,
|
|
27
|
+
mergeMessages
|
|
28
|
+
} from "@seedgrid/fe-core";
|
|
29
|
+
|
|
30
|
+
const registry = new SeedGridRegistry();
|
|
31
|
+
|
|
32
|
+
const moduleManifest: SeedGridModuleManifest = {
|
|
33
|
+
id: "my-module",
|
|
34
|
+
name: "Módulo personalizado",
|
|
35
|
+
version: "1.0.0",
|
|
36
|
+
register: (registry) => {
|
|
37
|
+
registry.addNavItem({
|
|
38
|
+
id: "dashboard",
|
|
39
|
+
labelKey: "menu.dashboard",
|
|
40
|
+
href: "/dashboard"
|
|
41
|
+
});
|
|
42
|
+
registry.addRoute({ id: "dashboard", path: "/dashboard" });
|
|
43
|
+
}
|
|
44
|
+
};
|
|
45
|
+
|
|
46
|
+
registry.addNavItem({
|
|
47
|
+
id: "marketing",
|
|
48
|
+
labelKey: "menu.marketing",
|
|
49
|
+
href: "/marketing",
|
|
50
|
+
order: 10
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
const messages = mergeMessages(
|
|
54
|
+
{ app: { welcome: "Bem-vindo" } },
|
|
55
|
+
{ app: { logout: "Sair" } }
|
|
56
|
+
);
|
|
57
|
+
|
|
58
|
+
const persistence = createCompositePersistenceStrategy({
|
|
59
|
+
mode: "mirror",
|
|
60
|
+
primary: createLocalStorageStrategy({ prefix: "sg:" }),
|
|
61
|
+
secondary: createLocalStorageStrategy(),
|
|
62
|
+
});
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Recursos
|
|
66
|
+
|
|
67
|
+
- `SeedGridRegistry` mantém provedores, rotas e os itens de menu com ordenação.
|
|
68
|
+
- `SeedGridModuleManifest` centraliza i18n, versão e o hook de registro de cada módulo.
|
|
69
|
+
- Estruturas de persistência (`createLocalStorageStrategy`, `createApiPersistenceStrategy`, `createCompositePersistenceStrategy`) protegidas por `buildSgPersistenceKey`.
|
|
70
|
+
- `SeedGridMessages` e `mergeMessages` simplificam o carregamento incremental de recursos de tradução.
|
|
71
|
+
|
|
72
|
+
## Exemplos
|
|
73
|
+
|
|
74
|
+
- **Ordenar itens de menu**: use `getNavItems()` após registrar módulos e rely on `order`.
|
|
75
|
+
- **Persistir estado crítico**: combine `createApiPersistenceStrategy` com `createLocalStorageStrategy` para oferecer fallback offline.
|
|
76
|
+
- **Plugins modulares**: cada `register` no `SeedGridModuleManifest` pode adicionar provedores/contextos com `addProvider`.
|
|
77
|
+
|