@luminix/mui-cms 1.2.0 → 1.2.2

package/docs/tipos.md

@@ -1,248 +0,0 @@
-# Referência de tipos
-
-Todos os tipos abaixo são exportados de `@luminix/mui-cms`.
-
----
-
-## Ações
-
-### StaticAction
-
-```ts
-type StaticAction = {
-    key?:     string;
-    label:    string;
-    icon?:    React.ReactNode;
-    callback: (e: ActionCallbackEvent) => void;
-};
-```
-
-### InstanceAction
-
-```ts
-type InstanceAction = {
-    key?:     string;
-    label:    string;
-    icon?:    React.ReactNode;
-    callback: (e: InstanceActionCallbackEvent) => void;
-};
-```
-
-### MassAction
-
-```ts
-type MassAction = {
-    key:      string;  // obrigatório
-    label:    string;
-    callback: (e: MassActionCallbackEvent) => void;
-};
-```
-
-### ActionCallbackEvent
-
-```ts
-type ActionCallbackEvent = {
-    navigate: (path: string) => void;
-    refresh:  () => void;
-    notify:   NotifyFunction;
-    dialog:   DialogFunction;
-    t:        TFunction;  // i18next
-};
-```
-
-### InstanceActionCallbackEvent
-
-```ts
-type InstanceActionCallbackEvent = ActionCallbackEvent & {
-    item: ModelType;
-};
-```
-
-### MassActionCallbackEvent
-
-```ts
-type MassActionCallbackEvent = ActionCallbackEvent & {
-    selected: Collection<ModelType>;
-};
-```
-
----
-
-## Tabela
-
-### Column
-
-Estende `TableCellProps` do MUI:
-
-```ts
-type Column = TableCellProps & {
-    key:       string;
-    label:     string;
-    sortable?: boolean;
-};
-```
-
----
-
-## Rotas
-
-### RouteObject
-
-Re-exportado de `react-router-dom`. Use para tipar rotas adicionadas via redutor `cmsRoutes`:
-
-```ts
-import type { RouteObject } from '@luminix/mui-cms';
-```
-
----
-
-## Configuração
-
-### CmsConfig
-
-```ts
-type CmsConfig = {
-    layout?: {
-        breakpoint?: 'xs' | 'sm' | 'md' | 'lg' | 'xl';
-        drawer?: {
-            width?: number;
-        };
-        appBar?: {
-            height?: number;
-            color?:  string;
-        };
-    };
-};
-```
-
-### LogoutButtonProps
-
-Props recebidas pelo componente `Layout.Drawer.LogoutButton`. Relevante ao substituir o componente via redutor `componentMap`.
-
-```ts
-type LogoutButtonProps = {
-    collapsed?: boolean; // true quando o drawer está recolhido no desktop
-};
-```
-
----
-
-## Componente LuminixCms
-
-### LuminixCmsProps
-
-```ts
-type LuminixCmsProps = Partial<LuminixProviderProps> & {
-    theme?:     ThemeOptions;  // MUI ThemeOptions
-    themeArgs?: object[];      // argumentos adicionais para createTheme()
-};
-```
-
-`LuminixProviderProps` vem de `@luminix/react`. Consulte a documentação desse pacote para ver as props herdadas.
-
----
-
-## Filtros
-
-### FilterColumn
-
-Representa uma coluna disponível para filtragem:
-
-```ts
-type FilterColumn = {
-    key:         string;
-    label:       string;
-    type:        string;   // tipo do atributo (int, date, text, autocomplete, ...)
-    nullable:    boolean;
-    is_relation: boolean;
-};
-```
-
-### FilteredColumn
-
-Estado de uma linha ativa no painel de filtros:
-
-```ts
-type FilteredColumn = {
-    key:      string;
-    type:     string;
-    operator: string;
-    value:    unknown;
-};
-```
-
----
-
-## Notificações
-
-### NotifyFunction
-
-```ts
-type NotifyFunction = (notification: string | Notification) => void;
-```
-
-### Notification
-
-```ts
-type Notification = {
-    message:   React.ReactNode;
-    severity?: 'success' | 'error' | 'warning' | 'info';
-    title?:    React.ReactNode;
-    actions?:  NotificationAction[];
-};
-
-type NotificationAction = {
-    label:    React.ReactNode;
-    callback: () => void;
-};
-```
-
----
-
-## Diálogos
-
-### DialogFunction
-
-```ts
-type DialogFunction = (message: string | DialogMessage) => Promise<boolean | string>;
-```
-
-### DialogMessage
-
-```ts
-type DialogMessage = {
-    title?:          React.ReactNode;
-    message:         React.ReactNode;
-    type?:           'alert' | 'confirm' | 'prompt';
-    dismissable?:    boolean;
-    confirmText?:    string;
-    cancelText?:     string;
-    defaultValue?:   string;
-    dialogProps?:    Partial<DialogProps>;
-    textFieldProps?: Partial<TextFieldProps>;
-};
-```
-
----
-
-## Menu
-
-### MenuItem
-
-```ts
-type MenuItem = {
-    key:      string;
-    text:     string;
-    to?:      string;
-    icon?:    React.ReactNode;
-    children?: MenuItem[];
-};
-```
-
----
-
-## Próximos passos
-
-- [Ações](acoes.md) — como usar esses tipos na prática
-- [Extensibilidade](extensibilidade.md) — redutores e customizações
-- [Volta ao índice](index.md)

package/tsconfig.json

@@ -1,26 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "useDefineForClassFields": true,
-    "lib": ["ES2020", "DOM", "DOM.Iterable", "ES2021.String"],
-    "module": "ESNext",
-    "skipLibCheck": true,
-
-    /* Bundler mode */
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "noEmit": true,
-    "jsx": "react-jsx",
-
-    /* Linting */
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noFallthroughCasesInSwitch": true
-  },
-  "include": ["src"],
-  "exclude": ["src/__tests__"],
-  "references": [{ "path": "./tsconfig.node.json" }]
-}

package/tsconfig.node.json

@@ -1,11 +0,0 @@
-{
-  "compilerOptions": {
-    "composite": true,
-    "skipLibCheck": true,
-    "module": "ESNext",
-    "moduleResolution": "bundler",
-    "allowSyntheticDefaultImports": true,
-    "strict": true
-  },
-  "include": ["vite.config.ts"]
-}

package/tsconfig.test.json

@@ -1,16 +0,0 @@
-{
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "skipLibCheck": true,
-        "moduleResolution": "bundler",
-        "noUnusedLocals": false,
-        "noUnusedParameters": false,
-        "types": [
-            "vite/client",
-            "vitest/globals",
-            "@testing-library/jest-dom"
-        ]
-    },
-    "include": ["src"],
-    "exclude": []
-}

package/vitest.config.ts

@@ -1,22 +0,0 @@
-import { defineConfig } from 'vitest/config';
-import { resolve } from 'path';
-
-export default defineConfig({
-    resolve: {
-        alias: {
-            '@luminix/react': resolve(__dirname, 'node_modules/@luminix/react/dist/react.js'),
-            '@luminix/core': resolve(__dirname, 'node_modules/@luminix/core/dist/core.js'),
-            '@luminix/support': resolve(__dirname, 'node_modules/@luminix/support/dist/support.js'),
-        },
-    },
-    test: {
-        environment: 'jsdom',
-        globals: true,
-        setupFiles: ['./src/__tests__/setup.ts'],
-        coverage: {
-            provider: 'v8',
-            include: ['src/**/*.{ts,tsx}'],
-            exclude: ['src/__tests__/**', 'src/**/*.d.ts', 'src/main.tsx'],
-        },
-    },
-});