@oondemand/oon-core-front 0.3.10 → 0.3.12

package/dist/index.d.ts

@@ -40,6 +40,7 @@ interface MenuMeta {
     section?: string;
     order?: number;
     permissions?: string[];
+    capabilities?: string[];
     children?: OonMenuItem[];
     badge?: string | number;
     external?: boolean;
@@ -99,8 +100,22 @@ interface OonUser {
     tipo: string;
     nome: string;
     email: string;
+    capabilities?: string[];
+    permissoes?: {
+        capabilities?: string[];
+        [extra: string]: unknown;
+    };
+    aplicativo?: {
+        capabilities?: string[];
+        permissoes?: {
+            capabilities?: string[];
+            [extra: string]: unknown;
+        };
+        [extra: string]: unknown;
+    };
     [extra: string]: unknown;
 }
+type OonAppKind = "root-central" | "member-central" | "portal-cockpit";
 interface OonAppConfig {
     id: string;
     name: string;
@@ -108,6 +123,13 @@ interface OonAppConfig {
     logo?: string;
     favicon?: string;
     version?: string;
+    /**
+     * Perfil arquitetural da aplicação no Ecossistema Oon.
+     * - root-central: Central de Ativações.
+     * - member-central: Central publicada para tenant/licença/ambiente.
+     * - portal-cockpit: Portal/Cockpit como Meus Apps.
+     */
+    kind?: OonAppKind;
 }
 interface OonApiConfig {
     baseUrl: string;
@@ -117,8 +139,9 @@ interface OonApiConfig {
     versionPrefix?: string;
     timeout?: number;
 }
+type OonAuthMode = "bearer" | "cookie" | "external-sso" | "central-instance" | "central-client";
 interface OonAuthConfig {
-    mode?: "bearer" | "cookie" | "external-sso";
+    mode?: OonAuthMode;
     /** URL de login externo (Meus Apps) para redirect quando sem token. */
     loginUrl?: string;
     /** Nome do query param que carrega o token na volta do SSO. Default: "code". */
@@ -159,6 +182,7 @@ interface OonRoute {
     /** rota pública não passa pelo RouteGuard. */
     public?: boolean;
     permissions?: string[];
+    capabilities?: string[];
 }
 interface OonMenuItem {
     label: string;
@@ -167,6 +191,7 @@ interface OonMenuItem {
     section?: string;
     order?: number;
     permissions?: string[];
+    capabilities?: string[];
     children?: OonMenuItem[];
     badge?: string | number;
     external?: boolean;
@@ -219,6 +244,7 @@ interface OonColumnDef {
     width?: number;
     renderer?: string;
     permissions?: string[];
+    capabilities?: string[];
 }
 interface OonFormFieldDef {
     field: string;
@@ -230,6 +256,7 @@ interface OonFormFieldDef {
     ref?: string;
     renderer?: string;
     permissions?: string[];
+    capabilities?: string[];
 }
 /** Definição de uma coleção nas três formas da Seção 4.4. */
 interface OonActionDef {
@@ -237,8 +264,141 @@ interface OonActionDef {
     label?: string;
     renderer?: string;
     permissions?: string[];
+    capabilities?: string[];
     action?: string;
 }
+type OonListFilterDef = {
+    field: string;
+    label?: string;
+    type?: "text" | "select" | "date" | "dateRange" | "numberRange" | "boolean" | "ref";
+    options?: Array<{
+        label: string;
+        value: string | number | boolean | null;
+    }>;
+    defaultValue?: unknown;
+    placeholder?: string;
+};
+type OonConditionDef = {
+    field: string;
+    exists: boolean;
+} | {
+    field: string;
+    equals: unknown;
+} | {
+    field: string;
+    notEquals: unknown;
+} | {
+    field: string;
+    in: unknown[];
+} | {
+    field: string;
+    gt: number;
+} | {
+    field: string;
+    gte: number;
+} | {
+    field: string;
+    lt: number;
+} | {
+    field: string;
+    lte: number;
+};
+type OonRowActionDef = {
+    id?: string;
+    label: string;
+    icon?: string;
+    type: "openDetailModal" | "navigate" | "apiAction" | "customAction";
+    method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+    endpoint?: string;
+    href?: string;
+    initialTab?: string;
+    confirm?: {
+        title?: string;
+        description?: string;
+    };
+    disabledWhen?: OonConditionDef;
+    hiddenWhen?: OonConditionDef;
+    refresh?: Array<"self" | "parent" | "all" | string>;
+    roles?: string[];
+    permissions?: string[];
+    capabilities?: string[];
+    renderer?: string;
+};
+type OonCollectionListConfig = {
+    filters?: OonListFilterDef[];
+    columns?: Array<string | OonColumnDef>;
+    rowActions?: OonRowActionDef[];
+};
+type OonRelationDef = {
+    model: string;
+    foreignKey: string;
+    parentKey?: string;
+    label?: string;
+};
+type OonRelatedGridColumnDef = OonColumnDef & {
+    editable?: boolean;
+    readonly?: boolean;
+    format?: "text" | "number" | "currency" | "percent" | "date" | "badge";
+    editor?: "string" | "number" | "currency" | "date" | "enum" | "select" | "ref" | "boolean" | "textarea";
+    hidden?: boolean;
+    roles?: string[];
+    required?: boolean;
+    display?: "badgeExists" | "badge" | string;
+};
+type OonSummaryCardDef = {
+    label: string;
+    source?: "field" | "relatedCount" | "relatedSum" | "relatedAvg" | "customMetric";
+    field?: string;
+    relation?: string | OonRelationDef;
+    metric?: string;
+    format?: "text" | "number" | "currency" | "percent" | "date" | "badge";
+};
+type OonDetailTabDef = {
+    id: string;
+    label: string;
+    type: "summary";
+    cards?: OonSummaryCardDef[];
+} | {
+    id: string;
+    label: string;
+    type: "form";
+    groups?: Array<{
+        label: string;
+        description?: string;
+        fields: string[];
+        columns?: 1 | 2 | 3 | 4;
+    }>;
+    fields?: string[];
+} | {
+    id: string;
+    label: string;
+    type: "relatedGrid";
+    relation: string | OonRelationDef;
+    editable?: boolean;
+    editMode?: "inline" | "modal" | "drawer";
+    columns?: Array<string | OonRelatedGridColumnDef>;
+    rowActions?: OonRowActionDef[];
+} | {
+    id: string;
+    label: string;
+    type: "readonlyGrid";
+    relation: string | OonRelationDef;
+    columns?: Array<string | OonRelatedGridColumnDef>;
+    rowActions?: OonRowActionDef[];
+} | {
+    id: string;
+    label: string;
+    type: "customComponent";
+    component: string;
+    props?: Record<string, unknown>;
+};
+type OonDetailModalConfig = {
+    enabled?: boolean;
+    titleField?: string;
+    size?: "md" | "lg" | "xl" | "full";
+    defaultTab?: string;
+    tabs: OonDetailTabDef[];
+};
 interface CollectionViewDef {
     type: "collection";
     /** id de rota/menu; default = model em minúsculas. */
@@ -258,7 +418,11 @@ interface CollectionViewDef {
     renderer?: string;
     cardRenderer?: string;
     actions?: OonActionDef[];
+    list?: OonCollectionListConfig;
+    relations?: Record<string, OonRelationDef>;
+    detailModal?: OonDetailModalConfig;
     permissions?: string[];
+    capabilities?: string[];
 }
 interface DocumentViewDef {
     type: "document";
@@ -271,6 +435,7 @@ interface DocumentViewDef {
     approval?: boolean;
     attachments?: boolean;
     permissions?: string[];
+    capabilities?: string[];
 }
 interface PipelineViewDef {
     type: "pipeline";
@@ -289,6 +454,7 @@ interface PipelineViewDef {
         label: string;
     }>;
     permissions?: string[];
+    capabilities?: string[];
 }
 interface DashboardViewDef {
     type: "dashboard";
@@ -298,6 +464,8 @@ interface DashboardViewDef {
     icon?: ReactNode;
     section?: string;
     widgets?: DashboardWidgetDef[];
+    permissions?: string[];
+    capabilities?: string[];
 }
 type OonPageLayout = "default" | "content-only" | "portal";
 interface OonPageDef {
@@ -311,6 +479,7 @@ interface OonPageDef {
     blocks?: OonBlockDef[];
     component?: string;
     permissions?: string[];
+    capabilities?: string[];
     hidden?: boolean;
     order?: number;
 }
@@ -319,6 +488,7 @@ interface OonBaseBlockDef {
     id?: string;
     title?: string;
     permissions?: string[];
+    capabilities?: string[];
     hidden?: boolean;
 }
 interface OonCustomBlockDef extends OonBaseBlockDef {
@@ -399,6 +569,10 @@ interface CentralUiManifest {
         metadataUrl?: string;
     };
     schemaVersion?: 1 | 2;
+    /** Perfil arquitetural: root-central, member-central ou portal-cockpit. */
+    appKind?: OonAppKind;
+    /** Configuração declarativa de autenticação. Segredos nunca entram aqui. */
+    auth?: Pick<OonAuthConfig, "mode" | "loginUrl" | "tokenParam">;
     layout?: OonLayoutConfig;
     registry?: OonComponentRegistry;
     navigation?: OonNavigationConfig;
@@ -409,6 +583,9 @@ interface CentralUiManifest {
         path?: string;
         label?: string;
         section?: string;
+        list?: OonCollectionListConfig;
+        relations?: Record<string, OonRelationDef>;
+        detailModal?: OonDetailModalConfig;
     }>;
     pipelines?: Array<{
         name?: string;
@@ -429,7 +606,7 @@ interface CentralUiManifest {
         attachments?: boolean;
     }>;
 }
-/** Dados de runtime que o `central.ui.json` não carrega (vêm do .env). */
+/** Dados de runtime que o `central.ui.json` não carrega (vêm do .env/código). */
 interface ManifestRuntime {
     apiBaseUrl: string;
     meusAppsUrl?: string;
@@ -437,6 +614,14 @@ interface ManifestRuntime {
     versionPrefix?: string;
     /** Token local enviado ao backend somente quando o consumidor o configurar. */
     devToken?: string;
+    /** Registry de componentes React, registrado em código TypeScript. */
+    registry?: OonComponentRegistry;
+    /** Atalho para registrar páginas/componentes custom sem reescrever o frontend. */
+    customComponents?: OonComponentRegistry["pageComponents"];
+    /** Overrides de autenticação vindos do runtime/env. */
+    auth?: Partial<OonAuthConfig>;
+    /** Override do perfil arquitetural da aplicação. */
+    appKind?: OonAppKind;
 }
 /** Converte o manifesto declarativo + runtime em config do Core. */
 declare function manifestToConfig(manifest: CentralUiManifest, runtime: ManifestRuntime): OonCoreFrontConfig;
@@ -470,8 +655,11 @@ interface CoreCollectionProps {
     columns?: OonColumnDef[];
     form?: OonFormFieldDef[];
     importExport?: boolean;
+    list?: OonCollectionListConfig;
+    relations?: Record<string, OonRelationDef>;
+    detailModal?: OonDetailModalConfig;
 }
-declare function CoreCollection({ model, label, section, mode, endpoint, columns, form, importExport }: CoreCollectionProps): react.JSX.Element;
+declare function CoreCollection({ model, label, section, mode, endpoint, columns, form, importExport, list, relations, detailModal }: CoreCollectionProps): react.JSX.Element;
 
 interface CoreDocumentProps {
     model: string;
@@ -607,6 +795,7 @@ type AuthStatus = "loading" | "authenticated" | "unauthenticated" | "forbidden"
 interface AuthContextValue {
     user: OonUser | null;
     roles: string[];
+    capabilities: string[];
     status: AuthStatus;
     isAuthenticated: boolean;
     hasPermission: (permission?: string | string[]) => boolean;
@@ -686,4 +875,4 @@ declare function useCoreMetadata(): _tanstack_react_query.UseQueryResult<NoInfer
 /** Descrição de uma model específica — base do modo "dynamic". */
 declare function useModelSchema(name: string): _tanstack_react_query.UseQueryResult<NoInfer<ModelSummary>, Error>;
 
-export { type CentralUiManifest, type CollectionMode, type CollectionViewDef, CoreActions, CoreAssistant, CoreCards, CoreCollection, CoreCurrency, CoreDashboard, CoreDataGrid, CoreDocument, CoreEmptyState, CoreField, CoreForm, CoreIntegration, CoreLoadingState, type CoreMetadata, CorePage, CorePageHeader, CorePipeline, CoreRelationField, CoreToolbar, type DashboardViewDef, type DashboardWidgetDef, type DocumentViewDef, type FieldKind, type FieldMeta, type ListParams, type ManifestRuntime, type ModelSummary, type OonActionDef, type OonApiConfig, type OonAppConfig, type OonAuthConfig, type OonBlockDef, type OonColumnDef, type OonComponentRegistry, type OonCoreFrontConfig, type OonError, type OonFormFieldDef, type OonLayoutConfig, type OonMenuItem, type OonModule, type OonNavigationConfig, type OonNavigationMode, type OonPageDef, type OonRoute, type OonSchemaVersion, type OonSecurityConfig, type OonUiManifest, type OonUser, type OonViewDefinition, type PaginatedResult, type Pagination, PermissionGate, type PipelineViewDef, defineCollectionView, defineDashboard, defineDocumentView, defineOonModule, definePipelineView, manifestToConfig, oonCoreFront, start, startFromManifest, useCoreMetadata, useModelSchema, useOonApi, useOonAuth, useOonResource };
+export { type CentralUiManifest, type CollectionMode, type CollectionViewDef, CoreActions, CoreAssistant, CoreCards, CoreCollection, CoreCurrency, CoreDashboard, CoreDataGrid, CoreDocument, CoreEmptyState, CoreField, CoreForm, CoreIntegration, CoreLoadingState, type CoreMetadata, CorePage, CorePageHeader, CorePipeline, CoreRelationField, CoreToolbar, type DashboardViewDef, type DashboardWidgetDef, type DocumentViewDef, type FieldKind, type FieldMeta, type ListParams, type ManifestRuntime, type ModelSummary, type OonActionDef, type OonApiConfig, type OonAppConfig, type OonAppKind, type OonAuthConfig, type OonAuthMode, type OonBlockDef, type OonColumnDef, type OonComponentRegistry, type OonCoreFrontConfig, type OonError, type OonFormFieldDef, type OonLayoutConfig, type OonMenuItem, type OonModule, type OonNavigationConfig, type OonNavigationMode, type OonPageDef, type OonRoute, type OonSchemaVersion, type OonSecurityConfig, type OonUiManifest, type OonUser, type OonViewDefinition, type PaginatedResult, type Pagination, PermissionGate, type PipelineViewDef, defineCollectionView, defineDashboard, defineDocumentView, defineOonModule, definePipelineView, manifestToConfig, oonCoreFront, start, startFromManifest, useCoreMetadata, useModelSchema, useOonApi, useOonAuth, useOonResource };