@oondemand/oon-core-front 0.2.0 → 0.3.0

package/README.md

@@ -1,122 +1,3 @@
-# @oondemand/oon-core-front
+# OonCore Front - ativação de instâncias
 
-📖 **[Documentação completa → ooncoredoc.vercel.app](https://ooncoredoc.vercel.app)**
-
-Core de **frontend** para Centrais Oon. Uma Central de frontend passa a ser
-apenas **declaração**: você escreve um `central.ui.ts` (identidade + views) e
-sobe tudo com `oonCore-front dev`.
-
-Todo o resto — bootstrap, providers (React Query + Chakra), roteamento por
-metadata, autenticação, RBAC, layout, menu, SDK REST único do `/core/*`,
-auditoria e os componentes `Core*` (Coleção, Documento, Esteira, Multi-moedas,
-Assistente, Dashboard) — vive aqui dentro.
-
-É o par de frontend do [`@oondemand/oon-core-back`](../oonCore-back): o back
-descreve as models em `/core/metadata`; o front monta as telas a partir disso,
-sem código de UI por entidade.
-
-## Instalação
-
-```bash
-npm install @oondemand/oon-core-front
-# peers: react, react-dom, react-router-dom, @tanstack/react-query,
-#        @tanstack/react-table, @chakra-ui/react
-```
-
-## Uso mínimo
-
-`central.ui.ts`:
-
-```ts
-import { defineCollectionView, type OonCoreFrontConfig } from "@oondemand/oon-core-front";
-
-export const appConfig: OonCoreFrontConfig = {
-  app: { id: "minha-central", name: "Minha Central" },
-  api: { baseUrl: import.meta.env.VITE_API_URL },
-  auth: { mode: "bearer", tokenParam: "code" },
-  ui: {
-    views: [
-      // 100% dinâmico: nada além do nome da model. Grid, form, rota e menu
-      // são montados a partir de /core/models/Cotacao.
-      defineCollectionView({ model: "Cotacao", mode: "dynamic" }),
-    ],
-  },
-};
-```
-
-`src/main.tsx`:
-
-```ts
-import { start } from "@oondemand/oon-core-front";
-import { appConfig } from "../central.ui";
-
-start(appConfig);
-```
-
-`main.tsx` não conhece providers, router, auth, layout, menu nem serviços.
-
-## Três formas de declarar uma coleção (Seção 4.4)
-
-```ts
-// 1. JSON completo — colunas e form explícitos (mode "full").
-defineCollectionView({
-  model: "Pessoa",
-  mode: "full",
-  columns: [{ field: "nome", label: "Nome", sortable: true }],
-  form: [{ field: "nome", label: "Nome", required: true }],
-});
-
-// 2. Registro mínimo — só model + label; Core deriva tudo da metadata.
-defineCollectionView({ model: "Pessoa", label: "Prestadores", mode: "minimal" });
-
-// 3. 100% dinâmico — consome /core/models/Pessoa e monta sozinho.
-defineCollectionView({ model: "Pessoa", mode: "dynamic" });
-```
-
-Ou direto no JSX, sem registrar view:
-
-```tsx
-import { CoreCollection } from "@oondemand/oon-core-front";
-
-<CoreCollection model="Pessoa" />;
-```
-
-## CLI
-
-```bash
-oonCore-front dev             # vite dev
-oonCore-front build           # vite build
-oonCore-front preview         # vite preview
-oonCore-front sync:metadata   # baixa /core/metadata do back e cacheia em src/.oon/metadata.json
-```
-
-## Componentes Core
-
-| Componente       | Para quê                                                            |
-| ---------------- | ------------------------------------------------------------------- |
-| `CoreCollection` | CRUD genérico: grid + form (3 modos).                               |
-| `CoreDocument`   | Tipos documentais com aprovação/anexos sobre a coleção.             |
-| `CorePipeline`   | Esteira kanban agrupada por etapa (enum da metadata).               |
-| `CoreCurrency`   | Multi-moedas: lista + ação `actions/update-rates`.                  |
-| `CoreIntegration`| Painel de `/core/integrations` + reprocessar ativos.               |
-| `CoreAssistant`  | Chat de IA seguro — envia só `assistantCode`/`entity`/`message`.    |
-| `CoreDashboard`  | Widgets `count`/`sum`/`custom` declarados na Central.               |
-
-## Segurança por design
-
-- **Sem segredos no front**: o assistente nunca envia chave de IA — só
-  `assistantCode`, `entity` e `message`; o back resolve modelo/prompt/chave.
-- **Token encapsulado** em `tokenStorage` (try/catch, captura de `?code=` e
-  limpeza da URL); 401 dispara logout + redirect para o login externo.
-- **RBAC de UX**: `RouteGuard`/`PermissionGate` escondem o que o usuário não
-  pode usar — o back continua sendo a autoridade final.
-- **Auditoria**: toda mutação leva headers `x-oon-origin/module/entity`.
-
-## Contrato com o back
-
-| `/core/*` (back)        | Uso no front                                   |
-| ----------------------- | ---------------------------------------------- |
-| `GET /core/metadata`    | `useCoreMetadata()` — menu/dashboard/derivação |
-| `GET /core/models/:n`   | `useModelSchema(n)` — modo dynamic             |
-| CRUD em `basePath`      | `useOonResource(basePath)` — list/get/CRUD     |
-| `GET /auth/validar-token` | `AuthProvider` resolve o usuário             |
+O frontend inclui a rota pública `/ativacao` e um `ActivationProvider` que consulta `/ativacao/status` antes de liberar rotas privadas. Centrais `member` não ativas são enviadas para o assistente de ativação; estados `suspensa` e `revogada` usam páginas próprias. O código de ativação fica apenas em memória e é limpo após conclusão.

package/dist/index.d.ts

@@ -11,6 +11,7 @@ interface FieldMeta {
     kind: FieldKind;
     label?: string;
     searchable?: boolean;
+    required?: boolean;
     /** model referenciada quando kind === "ref". */
     ref?: string;
     /** valores possíveis quando kind === "enum". */
@@ -116,6 +117,12 @@ interface OonAuthConfig {
     loginUrl?: string;
     /** Nome do query param que carrega o token na volta do SSO. Default: "code". */
     tokenParam?: string;
+    /**
+     * Token usado somente no desenvolvimento local. Quando informado, tem
+     * prioridade sobre um token antigo do storage, é persistido e validado no
+     * backend normalmente antes de qualquer redirecionamento.
+     */
+    devToken?: string;
 }
 interface OonSecurityConfig {
     enableRouteGuard?: boolean;
@@ -177,6 +184,8 @@ interface OonFormFieldDef {
     kind?: FieldKind;
     required?: boolean;
     options?: string[];
+    /** model relacionada quando kind === "ref". */
+    ref?: string;
 }
 /** Definição de uma coleção nas três formas da Seção 4.4. */
 interface CollectionViewDef {
@@ -311,6 +320,8 @@ interface ManifestRuntime {
     meusAppsUrl?: string;
     assistantBaseUrl?: string;
     versionPrefix?: string;
+    /** Token local enviado ao backend somente quando o consumidor o configurar. */
+    devToken?: string;
 }
 /** Converte o manifesto declarativo + runtime em config do Core. */
 declare function manifestToConfig(manifest: CentralUiManifest, runtime: ManifestRuntime): OonCoreFrontConfig;
@@ -338,26 +349,14 @@ declare function defineOonModule(mod: OonModule): OonModule;
 interface CoreCollectionProps {
     model: string;
     label?: string;
-    /**
-     * Três formas de declarar a coleção (Seção 4.4):
-     *  - "full"    : colunas + form explícitos (passe `columns` e `form`).
-     *  - "minimal" : só `model`; Core busca a metadata e deriva tudo.
-     *  - "dynamic" : 100% dirigido por /core/models/:model (default).
-     */
+    section?: string;
     mode?: CollectionMode;
-    /** basePath do recurso; default vem da metadata da model. */
     endpoint?: string;
     columns?: OonColumnDef[];
     form?: OonFormFieldDef[];
     importExport?: boolean;
 }
-/**
- * Componente Core de coleção. Renderiza grid + form de qualquer model do back
- * sem código de UI por entidade. No modo dinâmico, lê /core/models/:model e
- * monta colunas, formulário e endpoint a partir da metadata — esse é o
- * critério de pronto da Fase 3.
- */
-declare function CoreCollection({ model, label, mode, endpoint, columns, form, importExport }: CoreCollectionProps): react.JSX.Element;
+declare function CoreCollection({ model, label, section, mode, endpoint, columns, form, importExport }: CoreCollectionProps): react.JSX.Element;
 
 interface CoreDocumentProps {
     model: string;
@@ -382,21 +381,14 @@ interface CorePipelineProps {
     model: string;
     label?: string;
     endpoint?: string;
-    /** campo do registro que define a coluna/etapa. Default: "status". */
     stageField?: string;
-    /** etapas fixas; se omitido, derivadas do enum de `stageField`. */
     stages?: Array<{
         id: string;
         label: string;
     }>;
-    /** campo exibido como título do card. Default: primeiro string. */
     titleField?: string;
 }
-/**
- * Esteira (kanban) genérica do Core. Agrupa registros por `stageField` em
- * colunas. As etapas vêm das props ou são derivadas do enum declarado na
- * metadata da model — nenhuma esteira específica hardcoded.
- */
+/** Esteira horizontal padrão, com tickets clicáveis e formulário completo em modal. */
 declare function CorePipeline({ model, label, endpoint, stageField, stages, titleField }: CorePipelineProps): react.JSX.Element;
 
 interface CoreIntegrationProps {
@@ -450,12 +442,15 @@ interface CoreDashboardProps {
  */
 declare function CoreDashboard({ label, widgets }: CoreDashboardProps): react.JSX.Element;
 
+type AuthStatus = "loading" | "authenticated" | "unauthenticated" | "forbidden" | "error";
 interface AuthContextValue {
     user: OonUser | null;
     roles: string[];
-    status: "loading" | "authenticated" | "unauthenticated";
+    status: AuthStatus;
     isAuthenticated: boolean;
     hasPermission: (permission?: string | string[]) => boolean;
+    login: (email: string, password: string) => Promise<void>;
+    retry: () => Promise<void>;
     logout: () => void;
 }
 declare function useOonAuth(): AuthContextValue;