@luminix/mui-cms 0.2.13 → 1.1.0

package/docs/tipos.md

@@ -0,0 +1,248 @@
+# 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/package.json

@@ -1,10 +1,13 @@
 {
   "name": "@luminix/mui-cms",
-  "version": "0.2.13",
+  "version": "1.1.0",
   "type": "module",
   "main": "bundle/mui-cms.js",
   "module": "dist/mui-cms.js",
   "types": "types/index.d.ts",
+  "repository": {
+    "url": "git+https://github.com/luminix-cms/js-mui-cms"
+  },
   "scripts": {
     "dev": "vite --port=3333 --config=vite.config.dev.ts",
     "build": "npm run build:bundle && npm run build:dist",
@@ -12,15 +15,17 @@
     "build:dist": "tsc && vite build",
     "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "preview": "vite preview",
-    "publish:beta": "npm run build && npm publish --tag beta"
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest"
   },
   "peerDependencies": {
     "@emotion/react": "^11.13.0",
     "@emotion/styled": "^11.13.0",
     "@fontsource/roboto": "^5.0.12",
-    "@luminix/core": "^0.4.0",
-    "@luminix/react": "^0.4.0",
-    "@luminix/support": "^0.4.9",
+    "@luminix/core": "^1.0.0",
+    "@luminix/react": "^1.0.0",
+    "@luminix/support": "^1.0.1",
     "@mui/icons-material": "^5.16.5",
     "@mui/material": "^5.16.5",
     "i18next": "^23.12.2",
@@ -30,17 +35,24 @@
     "react-router-dom": "6.25.1"
   },
   "devDependencies": {
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.2",
+    "@testing-library/user-event": "^14.6.1",
+    "@types/node": "^25.8.0",
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18.3.0",
     "@typescript-eslint/eslint-plugin": "^7.2.0",
     "@typescript-eslint/parser": "^7.2.0",
     "@vitejs/plugin-react": "^4.2.1",
+    "@vitest/coverage-v8": "^4.1.6",
     "eslint": "^8.57.0",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.6",
+    "jsdom": "^29.1.1",
     "terser": "^5.31.6",
     "typescript": "^5.2.2",
     "vite": "^5.2.0",
-    "vite-plugin-dts": "^4.0.3"
+    "vite-plugin-dts": "^4.0.3",
+    "vitest": "^4.1.6"
   }
 }

package/tsconfig.json

@@ -21,5 +21,6 @@
     "noFallthroughCasesInSwitch": true
   },
   "include": ["src"],
+  "exclude": ["src/__tests__"],
   "references": [{ "path": "./tsconfig.node.json" }]
 }

package/tsconfig.test.json

@@ -0,0 +1,16 @@
+{
+    "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/types/components/Layout/Drawer/LogoutButton.d.ts

@@ -0,0 +1,4 @@
+import { default as React } from 'react';
+import { LogoutButtonProps } from '../../../types/PropTypes';
+declare const LogoutButton: React.FunctionComponent<LogoutButtonProps>;
+export default LogoutButton;

package/types/dist.d.ts

@@ -2,6 +2,7 @@ import { default as CmsServiceProvider } from './providers/CmsServiceProvider';
 import { default as i18NextServiceProvider } from './providers/i18NextServiceProvider';
 import { default as LuminixCms } from './components/LuminixCms';
 import { default as Link } from './components/Link';
+import { default as LogoutButton } from './components/Layout/Drawer/LogoutButton';
 import { default as DialogProvider } from './components/providers/DialogProvider';
 import { default as LayoutProvider } from './components/providers/LayoutProvider';
 import { default as ModelProvider } from './components/providers/ModelProvider';
@@ -26,6 +27,7 @@ import { default as useTable } from './hooks/useTable';
 import { default as Cms } from './facades/Cms';
 import { default as Icon } from './facades/Icon';
 import { default as Filter } from './facades/Filter';
-export { CmsServiceProvider, i18NextServiceProvider, LuminixCms, Link, Cms, Filter, Icon, useActionEvent, useBackButton, useCurrentModel, useDialog, useDisplaceNotifications, useHandleError, useHasSearch, useIsDesktopMode, useLayoutConfig, useMenu, useNotify, usePageTitle, useSearch, useSelection, useSetPageTitle, useTable, DialogProvider, LayoutProvider, ModelProvider, NotificationProvider, TableProvider, };
+export { CmsServiceProvider, i18NextServiceProvider, LuminixCms, Link, LogoutButton, Cms, Filter, Icon, useActionEvent, useBackButton, useCurrentModel, useDialog, useDisplaceNotifications, useHandleError, useHasSearch, useIsDesktopMode, useLayoutConfig, useMenu, useNotify, usePageTitle, useSearch, useSelection, useSetPageTitle, useTable, DialogProvider, LayoutProvider, ModelProvider, NotificationProvider, TableProvider, };
 export type { RouteObject, } from './types/Reducers';
+export type { LogoutButtonProps, } from './types/PropTypes';
 export type { InstanceAction, StaticAction, MassAction, ActionCallbackEvent, InstanceActionCallbackEvent, MassActionCallbackEvent, Column, } from './types/Table';

package/types/services/CmsService.d.ts

@@ -7,11 +7,14 @@ import { StaticAction, MassAction } from '../types/Table';
 export declare class CmsService {
     [key: string]: any;
     private components;
+    private logoutCallback;
     booted(): void;
     getComponents(): Record<string, React.ComponentType<any>>;
     getComponent(name: string): React.ComponentType<any>;
     getRoutes(): RouteObject[];
     getMenuItems(): MenuItem[];
+    logoutUsing(callback: () => void): void;
+    getLogoutCallback(): () => void;
     getModelFormProps(item: ModelType): ModelFormProps;
     getMassActions(ModelClass: typeof ModelType, currentTab: string): MassAction[];
     getInstanceActions(ModelClass: typeof ModelType, currentTab: string): StaticAction[];

package/types/types/PropTypes.d.ts

@@ -91,6 +91,9 @@ export type BreadcrumbsProps = BreadcrumbsOwnProps & {
         href?: string;
     }[];
 };
+export type LogoutButtonProps = {
+    collapsed?: boolean;
+};
 export type InputOption = {
     key: string;
     label: string;

package/vitest.config.ts

@@ -0,0 +1,22 @@
+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'],
+        },
+    },
+});