@oondemand/oon-core-front 0.5.6 → 0.6.0

package/dist/types-BEVt-nU8.d.ts

@@ -0,0 +1,666 @@
+import { ReactNode, ComponentType } from 'react';
+import { O as OonThemeDefinition } from './theme-Clhoswb3.js';
+
+/** Tipos de campo emitidos pelo `fields` do back (Seção 2.4). */
+type FieldKind = "string" | "number" | "boolean" | "date" | "ref" | "enum" | "currency" | "currencyCode" | "currencyConverted" | "raw";
+/** Metadata de um campo de model, vinda de `metaFields` no back. */
+interface FieldMeta {
+    name: string;
+    kind: FieldKind;
+    label?: string;
+    searchable?: boolean;
+    required?: boolean;
+    /** model referenciada quando kind === "ref". */
+    ref?: string;
+    /** valores possíveis quando kind === "enum". */
+    options?: string[];
+    /** moeda base quando kind === "currencyConverted". */
+    base?: string;
+}
+/** Resumo de uma model (resposta de /core/models e /core/models/:name). */
+interface ModelSummary {
+    name: string;
+    singular: string;
+    /** basePath em que o CRUD está montado no back (ex.: "/cotacoes"). */
+    basePath: string;
+    crud: boolean;
+    roles: {
+        read?: string[];
+        write?: string[];
+    };
+    fields: FieldMeta[];
+    searchable: string[];
+}
+interface MenuMeta {
+    label: string;
+    href?: string;
+    icon?: string;
+    section?: string;
+    order?: number;
+    permissions?: string[];
+    capabilities?: string[];
+    children?: OonMenuItem[];
+    badge?: string | number;
+    external?: boolean;
+    hidden?: boolean;
+    action?: string;
+    renderer?: string;
+}
+/** Resposta completa de GET /core/metadata. */
+interface CoreMetadata {
+    service: {
+        name: string;
+        version: string;
+    };
+    models: ModelSummary[];
+    collections: unknown[];
+    documents: unknown[];
+    pipelines: unknown[];
+    features: unknown[];
+    menus: MenuMeta[];
+}
+interface Pagination {
+    currentPage: number;
+    totalPages: number;
+    totalItems: number;
+    itemsPerPage: number;
+}
+interface PaginatedResult<T = Record<string, unknown>> {
+    results: T[];
+    pagination: Pagination;
+}
+interface ListParams {
+    pageIndex?: number;
+    pageSize?: number;
+    searchTerm?: string;
+    /** ex.: "nome.asc" | "criadoEm.desc" */
+    sort?: string;
+    /** filtros adicionais viram query string. */
+    [filter: string]: unknown;
+}
+/** Erro normalizado (errorNormalizer). */
+interface OonError {
+    code: string;
+    message: string;
+    status?: number;
+    details?: unknown;
+    requestId?: string;
+}
+/** Origem de auditoria enviada nos headers x-oon-* das mutações. */
+type AuditOrigin = "datagrid" | "form" | "workflow" | "assistant" | "import";
+interface AuditContext {
+    origem?: AuditOrigin;
+    module?: string;
+    entity?: string;
+}
+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";
+type OonTenancyModel = "none" | "single_tenant" | "multi_tenant";
+interface OonAppConfig {
+    id: string;
+    name: string;
+    title?: string;
+    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;
+    /** Define se o runtime pode selecionar e persistir tenant para este App. */
+    tenancyModel?: OonTenancyModel;
+    capabilities?: string[];
+    capabilitySettings?: Record<string, unknown>;
+}
+interface OonApiConfig {
+    baseUrl: string;
+    assistantBaseUrl?: string;
+    meusAppsUrl?: string;
+    /** Control Plane público usado somente por cadastro e confirmação. */
+    onboardingBaseUrl?: string;
+    /** Prefixo de versão concatenado às chamadas. Default: "". */
+    versionPrefix?: string;
+    timeout?: number;
+}
+type OonAuthMode = "bearer" | "cookie" | "external-sso" | "central-instance" | "central-client";
+type OonRuntimeMode = "platform" | "local";
+interface OonAuthConfig {
+    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". */
+    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;
+    enablePermissionGate?: boolean;
+    redactAssistantContext?: boolean;
+    disableConsoleInProduction?: boolean;
+}
+interface OonCoreFrontConfig {
+    app: OonAppConfig;
+    api: OonApiConfig;
+    /** Runtime local desconectado ou execução integrada à plataforma. */
+    runtimeMode?: OonRuntimeMode;
+    auth?: OonAuthConfig;
+    theme?: OonThemeDefinition | Record<string, unknown>;
+    themes?: OonThemeDefinition[];
+    defaultThemeId?: string;
+    modules?: OonModule[];
+    /**
+     * Composição declarativa opcional para coleções, documentos e esteiras.
+     */
+    ui?: OonUiManifest;
+    layout?: OonLayoutConfig;
+    registry?: OonComponentRegistry;
+    security?: OonSecurityConfig;
+    /** Substituições explícitas para experiências de sistema, sem liberar a rota reservada. */
+    systemPages?: OonSystemPages;
+    /** Elemento DOM onde montar. Default: #root. */
+    rootElementId?: string;
+}
+/** Contrato code-first do app. Código local permanece no grafo de frontend. */
+interface OonAppDefinition {
+    app: OonAppConfig;
+    api: OonApiConfig;
+    runtimeMode?: OonRuntimeMode;
+    auth?: OonAuthConfig;
+    routes?: OonRoute[];
+    navigation?: OonNavigationConfig | OonMenuItem[];
+    shell?: OonLayoutConfig;
+    layouts?: OonComponentRegistry["layoutSlots"];
+    components?: OonComponentRegistry;
+    pages?: OonPageDef[];
+    modules?: OonModule[];
+    /** Composição declarativa opcional para casos simples. */
+    ui?: OonUiManifest;
+    theme?: OonThemeDefinition | Record<string, unknown>;
+    themes?: OonThemeDefinition[];
+    defaultThemeId?: string;
+    security?: OonSecurityConfig;
+    systemPages?: OonSystemPages;
+    rootElementId?: string;
+}
+interface OonSystemPages {
+    login?: ComponentType;
+}
+interface OonRoute {
+    path: string;
+    /** Elemento React já construído. Use apenas uma fonte de renderização por rota. */
+    element?: ReactNode;
+    /** Página React convencional, instanciada pelo roteador do Core. */
+    component?: ComponentType;
+    /** Lazy import convencional: () => import("./MinhaPagina"). */
+    lazy?: () => Promise<{
+        default: ComponentType;
+    }>;
+    /** Layout local aplicado somente à rota. */
+    layout?: ComponentType<{
+        children: ReactNode;
+    }>;
+    /** rota pública não passa pelo RouteGuard. */
+    public?: boolean;
+    permissions?: string[];
+    capabilities?: string[];
+}
+interface OonMenuItem {
+    label: string;
+    href: string;
+    icon?: ReactNode;
+    section?: string;
+    order?: number;
+    permissions?: string[];
+    capabilities?: string[];
+    children?: OonMenuItem[];
+    badge?: string | number;
+    external?: boolean;
+    hidden?: boolean;
+    action?: string;
+    renderer?: string;
+}
+type OonSchemaVersion = 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;
+    label: string;
+    version?: string;
+    routes?: OonRoute[];
+    menu?: OonMenuItem[];
+    /** views declarativas que o Core transforma em rota + menu. */
+    views?: OonViewDefinition[];
+}
+type CollectionMode = "full" | "minimal" | "dynamic";
+type OonValueFormat = "text" | "number" | "currency" | "percent" | "date" | "datetime" | "badge";
+interface OonColumnDef {
+    field: string;
+    label?: string;
+    /** kind sobrescreve o inferido da metadata. */
+    kind?: FieldKind;
+    /** Formato de apresentação; datetime preserva data e hora no locale do usuário. */
+    format?: OonValueFormat;
+    sortable?: boolean;
+    width?: number;
+    renderer?: string;
+    permissions?: string[];
+    capabilities?: string[];
+}
+type OonFormFieldWidget = "default" | "checkbox";
+interface OonSelectOption {
+    value: string;
+    label: string;
+    description?: string;
+}
+interface OonFormFieldDef {
+    field: string;
+    label?: string;
+    kind?: FieldKind;
+    required?: boolean;
+    options?: Array<string | OonSelectOption>;
+    /** Endpoint de opções dependente dos valores atuais do formulário. */
+    optionsEndpoint?: string;
+    /** Caminho da lista na resposta do endpoint. Default: "options". */
+    optionsResponsePath?: string;
+    /** Campos usados como value/label/descrição em cada item remoto. */
+    optionsValueField?: string;
+    optionsLabelField?: string;
+    optionsDescriptionField?: string;
+    /** Caminho booleano que informa se a seleção pode ser alterada. */
+    optionsEditablePath?: string;
+    /** Campos do formulário que invalidam/recarregam as opções. */
+    optionsDependsOn?: string[];
+    /** Opções seguras usadas quando o endpoint falha ou retorna lista vazia. */
+    fallbackOptions?: Array<string | OonSelectOption>;
+    /** Bloqueia a seleção enquanto usa fallback. Default: true. */
+    readonlyOnFallback?: boolean;
+    /** Texto auxiliar exibido quando o fallback está ativo. */
+    optionsUnavailableMessage?: string;
+    readonly?: boolean;
+    /** model relacionada quando kind === "ref". */
+    ref?: string;
+    renderer?: string;
+    /** Controle visual pontual sem substituir a página/formulário inteiro. */
+    widget?: OonFormFieldWidget;
+    /** Valor persistido quando um checkbox está marcado. Default: true. */
+    checkedValue?: string | number | boolean;
+    /** Valor persistido quando um checkbox está desmarcado. Default: false. */
+    uncheckedValue?: string | number | boolean;
+    /** Agrupa campos relacionados em um bloco visual comum. */
+    group?: string;
+    /** Rótulo exibido uma vez acima do grupo. Default: group. */
+    groupLabel?: string;
+    groupDescription?: string;
+    /** Exibe controles do mesmo grupo na mesma linha quando houver espaço. */
+    inline?: boolean;
+    permissions?: string[];
+    capabilities?: 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[];
+    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;
+    /** Exibe somente o ícone, preservando label em title e aria-label. */
+    iconOnly?: boolean;
+    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[];
+    /** Permite ocultar ações CRUD nativas quando a Central fornece ações de negócio próprias. */
+    builtInActions?: {
+        create?: boolean;
+        edit?: boolean;
+        delete?: boolean;
+    };
+};
+type OonRelationDef = {
+    model: string;
+    foreignKey: string;
+    parentKey?: string;
+    label?: string;
+};
+type OonRelatedGridColumnDef = OonColumnDef & {
+    editable?: boolean;
+    readonly?: boolean;
+    format?: OonValueFormat;
+    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?: OonValueFormat;
+};
+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. */
+    id?: string;
+    model: string;
+    label?: string;
+    path?: string;
+    icon?: ReactNode;
+    section?: string;
+    /** Mantém a rota disponível, mas remove a coleção do menu lateral. */
+    hidden?: boolean;
+    /** "dynamic" monta tudo a partir de /core/models/:model. */
+    mode?: CollectionMode;
+    /** modo "full": colunas explícitas. */
+    columns?: OonColumnDef[];
+    /** Campos explícitos ou overrides pontuais sobre a metadata do model. */
+    form?: OonFormFieldDef[];
+    importExport?: boolean;
+    renderer?: string;
+    cardRenderer?: string;
+    actions?: OonActionDef[];
+    list?: OonCollectionListConfig;
+    relations?: Record<string, OonRelationDef>;
+    detailModal?: OonDetailModalConfig;
+    permissions?: string[];
+    capabilities?: string[];
+}
+interface DocumentViewDef {
+    type: "document";
+    id?: string;
+    model: string;
+    endpoint?: string;
+    label?: string;
+    path?: string;
+    icon?: ReactNode;
+    section?: string;
+    approval?: boolean;
+    attachments?: boolean;
+    /** Experiência de uso: CRUD operacional (legado) ou biblioteca para leitura. */
+    display?: "crud" | "library";
+    categoryField?: string;
+    titleField?: string;
+    descriptionField?: string;
+    contentField?: string;
+    statusField?: string;
+    updatedAtField?: string;
+    permissions?: string[];
+    capabilities?: string[];
+}
+interface PipelineViewDef {
+    type: "pipeline";
+    id?: string;
+    /** model dos cards (tickets). */
+    model: string;
+    label?: string;
+    path?: string;
+    icon?: ReactNode;
+    section?: string;
+    /** campo do registro que define a etapa/coluna. */
+    stageField?: string;
+    /** etapas fixas; se omitido, derivadas do enum de stageField. */
+    stages?: Array<{
+        id: string;
+        label: string;
+    }>;
+    permissions?: string[];
+    capabilities?: string[];
+}
+interface DashboardViewDef {
+    type: "dashboard";
+    id?: string;
+    label?: string;
+    path?: string;
+    icon?: ReactNode;
+    section?: string;
+    widgets?: DashboardWidgetDef[];
+    permissions?: string[];
+    capabilities?: string[];
+}
+type OonPageLayout = "default" | "content-only" | "portal";
+interface OonPageDef {
+    id?: string;
+    path: string;
+    /** Rota pública declarada, usada por entradas customizadas como o login do portal. */
+    public?: boolean;
+    label?: string;
+    title?: string;
+    section?: string;
+    icon?: ReactNode;
+    layout?: OonPageLayout;
+    blocks?: OonBlockDef[];
+    component?: string;
+    permissions?: string[];
+    capabilities?: string[];
+    hidden?: boolean;
+    order?: number;
+}
+type OonBlockDef = OonCustomBlockDef | OonCollectionDataGridBlockDef | OonCollectionCardsBlockDef | OonSectionBlockDef | OonMarkdownBlockDef | OonNavigationCardsBlockDef | OonGenericBlockDef;
+interface OonBaseBlockDef {
+    id?: string;
+    title?: string;
+    permissions?: string[];
+    capabilities?: 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 OonNavigationCardDef {
+    title: string;
+    description?: string;
+    href: string;
+    actionLabel?: string;
+    external?: boolean;
+}
+interface OonNavigationCardsBlockDef extends OonBaseBlockDef {
+    type: "navigation.cards";
+    cards: OonNavigationCardDef[];
+    columns?: 1 | 2 | 3 | 4;
+}
+interface OonGenericBlockDef extends OonBaseBlockDef {
+    type: "collection.form" | "pipeline.board" | "document.viewer" | "dashboard.kpi" | "tabs";
+    [key: string]: unknown;
+}
+interface DashboardWidgetDef {
+    id: string;
+    label: string;
+    /** model de onde puxar a contagem/agregação. */
+    model?: string;
+    kind?: "count" | "sum" | "custom";
+    /** campo somado quando kind === "sum". */
+    field?: string;
+    render?: () => ReactNode;
+}
+type OonViewDefinition = CollectionViewDef | DocumentViewDef | PipelineViewDef | DashboardViewDef;
+interface OonUiManifest {
+    schemaVersion?: OonSchemaVersion;
+    layout?: OonLayoutConfig;
+    registry?: OonComponentRegistry;
+    navigation?: OonNavigationConfig;
+    views: OonViewDefinition[];
+    pages?: OonPageDef[];
+    blocks?: OonBlockDef[];
+}
+
+export type { OonSecurityConfig as A, OonSystemPages as B, CollectionViewDef as C, DashboardViewDef as D, OonTenancyModel as E, FieldKind as F, OonUiManifest as G, OonUser as H, OonViewDefinition as I, Pagination as J, PipelineViewDef as K, ListParams as L, ModelSummary as M, AuditContext as N, OonMenuItem as O, PaginatedResult as P, OonRowActionDef as Q, OonDetailModalConfig as R, OonDetailTabDef as S, OonRelationDef as T, OonListFilterDef as U, OonCollectionListConfig as V, OonRoute as a, OonNavigationConfig as b, OonAppDefinition as c, OonCoreFrontConfig as d, DocumentViewDef as e, OonModule as f, CollectionMode as g, CoreMetadata as h, DashboardWidgetDef as i, FieldMeta as j, OonActionDef as k, OonApiConfig as l, OonAppConfig as m, OonAppKind as n, OonAuthConfig as o, OonAuthMode as p, OonBlockDef as q, OonColumnDef as r, OonComponentRegistry as s, OonError as t, OonFormFieldDef as u, OonLayoutConfig as v, OonNavigationMode as w, OonPageDef as x, OonRuntimeMode as y, OonSchemaVersion as z };