@oondemand/oon-core-front 0.3.7 → 0.3.8

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as react from 'react';
-import { ReactNode } from 'react';
+import { ComponentType, ReactNode } from 'react';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { AxiosInstance } from 'axios';
 
@@ -40,6 +40,12 @@ interface MenuMeta {
     section?: string;
     order?: number;
     permissions?: string[];
+    children?: OonMenuItem[];
+    badge?: string | number;
+    external?: boolean;
+    hidden?: boolean;
+    action?: string;
+    renderer?: string;
 }
 /** Resposta completa de GET /core/metadata. */
 interface CoreMetadata {
@@ -141,6 +147,8 @@ interface OonCoreFrontConfig {
      * registrar coleções/documentos/esteiras sem escrever um módulo inteiro.
      */
     ui?: OonUiManifest;
+    layout?: OonLayoutConfig;
+    registry?: OonComponentRegistry;
     security?: OonSecurityConfig;
     /** Elemento DOM onde montar. Default: #root. */
     rootElementId?: string;
@@ -159,6 +167,38 @@ interface OonMenuItem {
     section?: string;
     order?: number;
     permissions?: string[];
+    children?: OonMenuItem[];
+    badge?: string | number;
+    external?: boolean;
+    hidden?: boolean;
+    action?: string;
+    renderer?: string;
+}
+type OonSchemaVersion = 1 | 2;
+type OonSlotConfig = "core" | "none" | `custom:${string}`;
+interface OonLayoutConfig {
+    shell?: "default" | "portal" | "content-only" | `custom:${string}`;
+    sidebar?: OonSlotConfig;
+    topbar?: OonSlotConfig;
+    header?: "none" | `custom:${string}`;
+    footer?: "core" | "none" | `custom:${string}`;
+    assistant?: "core" | "none" | `custom:${string}`;
+    main?: "core";
+}
+type OonRendererComponent<TProps = Record<string, unknown>> = ComponentType<TProps>;
+interface OonComponentRegistry {
+    layoutSlots?: Record<string, OonRendererComponent<any>>;
+    fieldRenderers?: Record<string, OonRendererComponent<any>>;
+    cellRenderers?: Record<string, OonRendererComponent<any>>;
+    cardRenderers?: Record<string, OonRendererComponent<any>>;
+    actionRenderers?: Record<string, OonRendererComponent<any>>;
+    pageComponents?: Record<string, OonRendererComponent<any>>;
+    menuRenderers?: Record<string, OonRendererComponent<any>>;
+}
+type OonNavigationMode = "auto" | "manual" | "mixed";
+interface OonNavigationConfig {
+    mode?: OonNavigationMode;
+    items?: OonMenuItem[];
 }
 interface OonModule {
     id: string;
@@ -177,6 +217,8 @@ interface OonColumnDef {
     kind?: FieldKind;
     sortable?: boolean;
     width?: number;
+    renderer?: string;
+    permissions?: string[];
 }
 interface OonFormFieldDef {
     field: string;
@@ -186,8 +228,17 @@ interface OonFormFieldDef {
     options?: string[];
     /** model relacionada quando kind === "ref". */
     ref?: string;
+    renderer?: string;
+    permissions?: string[];
 }
 /** Definição de uma coleção nas três formas da Seção 4.4. */
+interface OonActionDef {
+    id: string;
+    label?: string;
+    renderer?: string;
+    permissions?: string[];
+    action?: string;
+}
 interface CollectionViewDef {
     type: "collection";
     /** id de rota/menu; default = model em minúsculas. */
@@ -204,6 +255,9 @@ interface CollectionViewDef {
     /** modo "full": campos de formulário explícitos. */
     form?: OonFormFieldDef[];
     importExport?: boolean;
+    renderer?: string;
+    cardRenderer?: string;
+    actions?: OonActionDef[];
     permissions?: string[];
 }
 interface DocumentViewDef {
@@ -245,6 +299,59 @@ interface DashboardViewDef {
     section?: string;
     widgets?: DashboardWidgetDef[];
 }
+type OonPageLayout = "default" | "content-only" | "portal";
+interface OonPageDef {
+    id?: string;
+    path: string;
+    label?: string;
+    title?: string;
+    section?: string;
+    icon?: ReactNode;
+    layout?: OonPageLayout;
+    blocks?: OonBlockDef[];
+    component?: string;
+    permissions?: string[];
+    hidden?: boolean;
+    order?: number;
+}
+type OonBlockDef = OonCustomBlockDef | OonCollectionDataGridBlockDef | OonCollectionCardsBlockDef | OonSectionBlockDef | OonMarkdownBlockDef | OonGenericBlockDef;
+interface OonBaseBlockDef {
+    id?: string;
+    title?: string;
+    permissions?: string[];
+    hidden?: boolean;
+}
+interface OonCustomBlockDef extends OonBaseBlockDef {
+    type: "custom";
+    component: string;
+    props?: Record<string, unknown>;
+}
+interface OonCollectionDataGridBlockDef extends OonBaseBlockDef {
+    type: "collection.datagrid";
+    model: string;
+    mode?: CollectionMode;
+    renderer?: string;
+    columns?: OonColumnDef[];
+    form?: OonFormFieldDef[];
+}
+interface OonCollectionCardsBlockDef extends OonBaseBlockDef {
+    type: "collection.cards";
+    model: string;
+    renderer?: string;
+}
+interface OonSectionBlockDef extends OonBaseBlockDef {
+    type: "section";
+    description?: string;
+    blocks?: OonBlockDef[];
+}
+interface OonMarkdownBlockDef extends OonBaseBlockDef {
+    type: "markdown";
+    content: string;
+}
+interface OonGenericBlockDef extends OonBaseBlockDef {
+    type: "collection.form" | "pipeline.board" | "document.viewer" | "dashboard.kpi" | "tabs";
+    [key: string]: unknown;
+}
 interface DashboardWidgetDef {
     id: string;
     label: string;
@@ -257,7 +364,13 @@ interface DashboardWidgetDef {
 }
 type OonViewDefinition = CollectionViewDef | DocumentViewDef | PipelineViewDef | DashboardViewDef;
 interface OonUiManifest {
+    schemaVersion?: OonSchemaVersion;
+    layout?: OonLayoutConfig;
+    registry?: OonComponentRegistry;
+    navigation?: OonNavigationConfig;
     views: OonViewDefinition[];
+    pages?: OonPageDef[];
+    blocks?: OonBlockDef[];
 }
 
 /**
@@ -285,9 +398,11 @@ interface CentralUiManifest {
     backend?: {
         metadataUrl?: string;
     };
-    navigation?: {
-        mode?: "auto" | "manual";
-    };
+    schemaVersion?: 1 | 2;
+    layout?: OonLayoutConfig;
+    registry?: OonComponentRegistry;
+    navigation?: OonNavigationConfig;
+    pages?: OonPageDef[];
     collections?: Array<{
         model: string;
         mode?: CollectionMode;
@@ -442,6 +557,52 @@ interface CoreDashboardProps {
  */
 declare function CoreDashboard({ label, widgets }: CoreDashboardProps): react.JSX.Element;
 
+declare function CorePage({ page, registry }: {
+    page: OonPageDef;
+    registry?: OonComponentRegistry;
+}): react.JSX.Element;
+
+declare function CorePageHeader({ title, description, actions }: {
+    title?: string;
+    description?: string;
+    actions?: ReactNode;
+}): react.JSX.Element;
+declare function CoreToolbar({ children }: {
+    children?: ReactNode;
+}): react.JSX.Element;
+declare function CoreDataGrid(props: {
+    model: string;
+    mode?: CollectionMode;
+    columns?: OonColumnDef[];
+    form?: OonFormFieldDef[];
+    label?: string;
+}): react.JSX.Element;
+declare function CoreCards(props: {
+    model: string;
+    renderer?: string;
+}): react.JSX.Element;
+declare function CoreForm(props: {
+    children?: ReactNode;
+}): react.JSX.Element;
+declare function CoreField({ label, children }: {
+    label?: string;
+    children?: ReactNode;
+}): react.JSX.Element;
+declare function CoreRelationField(props: {
+    children?: ReactNode;
+}): react.JSX.Element;
+declare function CoreActions({ children }: {
+    children?: ReactNode;
+}): react.JSX.Element;
+declare function CoreEmptyState({ title, actionLabel, onAction }: {
+    title?: string;
+    actionLabel?: string;
+    onAction?: () => void;
+}): react.JSX.Element;
+declare function CoreLoadingState({ label }: {
+    label?: string;
+}): react.JSX.Element;
+
 type AuthStatus = "loading" | "authenticated" | "unauthenticated" | "forbidden" | "error";
 interface AuthContextValue {
     user: OonUser | null;
@@ -525,4 +686,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, CoreAssistant, CoreCollection, CoreCurrency, CoreDashboard, CoreDocument, CoreIntegration, type CoreMetadata, CorePipeline, type DashboardViewDef, type DashboardWidgetDef, type DocumentViewDef, type FieldKind, type FieldMeta, type ListParams, type ManifestRuntime, type ModelSummary, type OonApiConfig, type OonAppConfig, type OonAuthConfig, type OonColumnDef, type OonCoreFrontConfig, type OonError, type OonFormFieldDef, type OonMenuItem, type OonModule, type OonRoute, 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 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 };