forlogic-core 2.1.5 → 2.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (196) hide show
  1. package/README.md +53 -1
  2. package/dist/action-plans/components/ActionPlanAttachmentsTab.d.ts +3 -0
  3. package/dist/action-plans/components/ActionPlanCommentsTab.d.ts +3 -0
  4. package/dist/action-plans/components/ActionPlanCostTab.d.ts +5 -0
  5. package/dist/action-plans/components/ActionPlanGeneralTab.d.ts +3 -0
  6. package/dist/action-plans/components/ActionPlanHistoryTab.d.ts +3 -0
  7. package/dist/action-plans/components/ActionPlanPredecessorsTab.d.ts +5 -0
  8. package/dist/action-plans/components/ActionPlanProgressDialog.d.ts +3 -0
  9. package/dist/action-plans/components/ActionPlanProgressTab.d.ts +5 -0
  10. package/dist/action-plans/components/ActionPlanStatusBadge.d.ts +3 -0
  11. package/dist/action-plans/constants.d.ts +24 -0
  12. package/dist/action-plans/hooks/useActionPlan.d.ts +5 -0
  13. package/dist/action-plans/hooks/useActionPlanProgress.d.ts +5 -0
  14. package/dist/action-plans/types.d.ts +60 -0
  15. package/dist/action-plans/utils/formatTime.d.ts +9 -0
  16. package/dist/audit-trail/components/AuditTrailDetails.d.ts +10 -0
  17. package/dist/audit-trail/components/AuditTrailFilter.d.ts +10 -0
  18. package/dist/audit-trail/components/AuditTrailPage.d.ts +10 -0
  19. package/dist/audit-trail/types.d.ts +58 -0
  20. package/dist/audit-trail/utils.d.ts +18 -2
  21. package/dist/auth/components/EditProfileDialog.d.ts +1 -0
  22. package/dist/auth/components/ProtectedRoute.d.ts +5 -0
  23. package/dist/auth/contexts/AuthContext.d.ts +5 -0
  24. package/dist/auth/pages/CallbackPage.d.ts +5 -0
  25. package/dist/auth/services/AuthService.d.ts +5 -0
  26. package/dist/auth/services/TokenManager.d.ts +5 -0
  27. package/dist/auth/services/TokenService.d.ts +10 -0
  28. package/dist/auth/utils/ErrorInterceptor.d.ts +5 -0
  29. package/dist/components/dashboards/dashboard-form.d.ts +15 -0
  30. package/dist/components/dashboards/dashboard-general-view.d.ts +15 -0
  31. package/dist/components/dashboards/dashboard-grid.d.ts +25 -0
  32. package/dist/components/dashboards/dashboard-list.d.ts +10 -0
  33. package/dist/components/dashboards/dashboard-panel-renderer.d.ts +10 -0
  34. package/dist/components/dashboards/dashboard-view.d.ts +10 -0
  35. package/dist/components/dashboards/helpers.d.ts +44 -5
  36. package/dist/components/dashboards/panels/burndown-panel.d.ts +15 -0
  37. package/dist/components/dashboards/panels/cartesian-panel.d.ts +20 -0
  38. package/dist/components/dashboards/panels/list-panel.d.ts +15 -0
  39. package/dist/components/dashboards/panels/matrix-risk-panel.d.ts +25 -0
  40. package/dist/components/dashboards/panels/numeric-panel.d.ts +10 -0
  41. package/dist/components/dashboards/panels/panel-error.d.ts +10 -0
  42. package/dist/components/dashboards/panels/panel-header.d.ts +10 -0
  43. package/dist/components/dashboards/panels/panel-loader.d.ts +10 -0
  44. package/dist/components/dashboards/panels/panel-no-data.d.ts +10 -0
  45. package/dist/components/dashboards/panels/panel-unavailable.d.ts +10 -0
  46. package/dist/components/dashboards/panels/pareto-panel.d.ts +10 -0
  47. package/dist/components/dashboards/panels/performance-panel.d.ts +15 -0
  48. package/dist/components/dashboards/panels/pie-panel.d.ts +10 -0
  49. package/dist/components/dashboards/panels/text-panel.d.ts +10 -0
  50. package/dist/components/dashboards/types.d.ts +230 -0
  51. package/dist/components/modules/AccessDeniedDialog.d.ts +3 -1
  52. package/dist/components/modules/ModuleAccessGuard.d.ts +3 -1
  53. package/dist/components/modules/ModulesContent.d.ts +3 -1
  54. package/dist/components/modules/ModulesDialog.d.ts +1 -1
  55. package/dist/components/modules/ModulesFooterCards.d.ts +3 -1
  56. package/dist/components/modules/types.d.ts +2 -0
  57. package/dist/components/ui/accordion.d.ts +35 -0
  58. package/dist/components/ui/action-button.d.ts +5 -0
  59. package/dist/components/ui/alert-dialog.d.ts +82 -0
  60. package/dist/components/ui/alert.d.ts +32 -0
  61. package/dist/components/ui/avatar.d.ts +30 -0
  62. package/dist/components/ui/badge.d.ts +32 -0
  63. package/dist/components/ui/breadcrumb.d.ts +54 -0
  64. package/dist/components/ui/button-group.d.ts +15 -0
  65. package/dist/components/ui/button.d.ts +55 -0
  66. package/dist/components/ui/calendar.d.ts +16 -0
  67. package/dist/components/ui/card.d.ts +49 -0
  68. package/dist/components/ui/chart.d.ts +35 -0
  69. package/dist/components/ui/checkbox.d.ts +11 -0
  70. package/dist/components/ui/collapsible.d.ts +15 -0
  71. package/dist/components/ui/color-picker.d.ts +5 -0
  72. package/dist/components/ui/combo-tree.d.ts +23 -0
  73. package/dist/components/ui/combobox.d.ts +28 -0
  74. package/dist/components/ui/command.d.ts +66 -0
  75. package/dist/components/ui/context-menu.d.ts +95 -0
  76. package/dist/components/ui/date-picker.d.ts +10 -0
  77. package/dist/components/ui/dialog-wizard.d.ts +22 -4
  78. package/dist/components/ui/dialog.d.ts +181 -0
  79. package/dist/components/ui/drawer.d.ts +72 -0
  80. package/dist/components/ui/dropdown-menu.d.ts +153 -0
  81. package/dist/components/ui/electronic-signature-dialog.d.ts +10 -0
  82. package/dist/components/ui/export-dialog.d.ts +20 -0
  83. package/dist/components/ui/form.d.ts +96 -0
  84. package/dist/components/ui/hover-card.d.ts +15 -0
  85. package/dist/components/ui/icon-picker.d.ts +5 -0
  86. package/dist/components/ui/iframe-dialog.d.ts +10 -0
  87. package/dist/components/ui/input-group.d.ts +16 -0
  88. package/dist/components/ui/input.d.ts +5 -0
  89. package/dist/components/ui/menubar.d.ts +80 -0
  90. package/dist/components/ui/multiselect-permissions.d.ts +25 -0
  91. package/dist/components/ui/navigation-menu.d.ts +45 -0
  92. package/dist/components/ui/onboarding-dialog.d.ts +15 -0
  93. package/dist/components/ui/online-editor-dialog.d.ts +10 -0
  94. package/dist/components/ui/pagination.d.ts +53 -0
  95. package/dist/components/ui/popover.d.ts +8 -0
  96. package/dist/components/ui/radio-group.d.ts +3 -0
  97. package/dist/components/ui/report-request-list.d.ts +20 -0
  98. package/dist/components/ui/resizable.d.ts +15 -0
  99. package/dist/components/ui/rich-text-editor.d.ts +13 -0
  100. package/dist/components/ui/scroll-area.d.ts +3 -0
  101. package/dist/components/ui/select.d.ts +71 -0
  102. package/dist/components/ui/separator.d.ts +13 -0
  103. package/dist/components/ui/sheet.d.ts +76 -0
  104. package/dist/components/ui/sidebar.d.ts +203 -0
  105. package/dist/components/ui/skeleton-variants.d.ts +25 -0
  106. package/dist/components/ui/skeleton.d.ts +12 -0
  107. package/dist/components/ui/slider.d.ts +5 -0
  108. package/dist/components/ui/sonner.d.ts +5 -0
  109. package/dist/components/ui/spinner.d.ts +5 -0
  110. package/dist/components/ui/split-button.d.ts +6 -0
  111. package/dist/components/ui/stack.d.ts +5 -0
  112. package/dist/components/ui/status-badge.d.ts +3 -0
  113. package/dist/components/ui/step-selector.d.ts +5 -0
  114. package/dist/components/ui/stimulsoft-viewer.d.ts +8 -0
  115. package/dist/components/ui/switch.d.ts +21 -0
  116. package/dist/components/ui/tab-page-layout.d.ts +33 -0
  117. package/dist/components/ui/table-resize-handle.d.ts +10 -3
  118. package/dist/components/ui/table.d.ts +102 -0
  119. package/dist/components/ui/tabs.d.ts +59 -0
  120. package/dist/components/ui/terms-of-use-dialog.d.ts +50 -4
  121. package/dist/components/ui/textarea.d.ts +27 -0
  122. package/dist/components/ui/timepicker.d.ts +23 -0
  123. package/dist/components/ui/toggle-group.d.ts +25 -0
  124. package/dist/components/ui/toggle.d.ts +21 -0
  125. package/dist/components/ui/tooltip.d.ts +55 -1
  126. package/dist/components/ui/truncated-cell.d.ts +13 -0
  127. package/dist/components/ui/typography.d.ts +119 -0
  128. package/dist/components/ui/updates-notification.d.ts +33 -0
  129. package/dist/components/ui/users-groups-selector.d.ts +43 -0
  130. package/dist/components/ui/viewer-dialog.d.ts +107 -0
  131. package/dist/crud/components/ActionMenuItems.d.ts +5 -0
  132. package/dist/crud/components/BaseForm.d.ts +46 -0
  133. package/dist/crud/components/ColumnSettingsPopover.d.ts +10 -0
  134. package/dist/crud/components/CrudActionBar.d.ts +20 -0
  135. package/dist/crud/components/CrudGrid.d.ts +10 -0
  136. package/dist/crud/components/CrudPagination.d.ts +5 -0
  137. package/dist/crud/components/CrudTable.d.ts +5 -0
  138. package/dist/crud/components/TableRowActions.d.ts +5 -0
  139. package/dist/crud/createCrudPage.d.ts +41 -8
  140. package/dist/crud/generateCrudConfig.d.ts +13 -8
  141. package/dist/crud/hooks/useBaseForm.d.ts +39 -0
  142. package/dist/crud/hooks/useColumnManager.d.ts +25 -0
  143. package/dist/crud/hooks/useCrud.d.ts +35 -0
  144. package/dist/crud/primitives/ActionMenu.d.ts +41 -0
  145. package/dist/crud/primitives/FilterBar.d.ts +45 -0
  146. package/dist/crud/primitives/Pagination.d.ts +5 -0
  147. package/dist/crud/primitives/Table.d.ts +5 -0
  148. package/dist/crud/primitives/TreeTable.d.ts +5 -0
  149. package/dist/crud/primitives/types.d.ts +57 -0
  150. package/dist/crud/utils/routingHelpers.d.ts +11 -0
  151. package/dist/custom-form-fields/components/CustomFormFields.d.ts +3 -0
  152. package/dist/custom-form-fields/fields/FormDateField.d.ts +3 -0
  153. package/dist/custom-form-fields/fields/FormMultiSelectionField.d.ts +3 -0
  154. package/dist/custom-form-fields/fields/FormNumericField.d.ts +3 -0
  155. package/dist/custom-form-fields/fields/FormQuestionsField.d.ts +3 -0
  156. package/dist/custom-form-fields/fields/FormSingleSelectionField.d.ts +3 -0
  157. package/dist/custom-form-fields/fields/FormTextField.d.ts +3 -0
  158. package/dist/custom-form-fields/fields/FormTimeField.d.ts +3 -0
  159. package/dist/custom-form-fields/fields/FormUrlField.d.ts +3 -0
  160. package/dist/custom-form-fields/fields/ReadOnlyTextField.d.ts +3 -0
  161. package/dist/custom-form-fields/types.d.ts +84 -21
  162. package/dist/exports/integrations.d.ts +1 -0
  163. package/dist/file-upload/components/SingleFileUpload.d.ts +59 -0
  164. package/dist/file-upload/types.d.ts +15 -0
  165. package/dist/file-upload/utils/formatBytes.d.ts +5 -0
  166. package/dist/file-upload/utils/getFileExtension.d.ts +5 -0
  167. package/dist/hooks/useColumnResize.d.ts +24 -0
  168. package/dist/hooks/useRowResize.d.ts +18 -0
  169. package/dist/hooks/useSidebarResize.d.ts +18 -0
  170. package/dist/hooks/useUpdatesNotification.d.ts +16 -0
  171. package/dist/index.css +1 -1
  172. package/dist/index.css.map +1 -1
  173. package/dist/index.esm.js +1 -1
  174. package/dist/index.js +1 -1
  175. package/dist/integrations/clarity/clarityTracking.d.ts +31 -0
  176. package/dist/integrations/clarity/index.d.ts +3 -0
  177. package/dist/integrations/clarity/types.d.ts +46 -0
  178. package/dist/integrations/clarity/useClarity.d.ts +34 -0
  179. package/dist/integrations/index.d.ts +5 -0
  180. package/dist/providers/CoreProviders.d.ts +16 -1
  181. package/dist/qualiex/components/QualiexUserField.d.ts +8 -0
  182. package/dist/qualiex/hooks/useQualiexUsers.d.ts +16 -26
  183. package/dist/qualiex/services/qualiexApi.d.ts +38 -2
  184. package/dist/qualiex/utils/QualiexErrorInterceptor.d.ts +5 -0
  185. package/dist/supabase/SupabaseSingleton.d.ts +34 -0
  186. package/dist/types.d.ts +51 -2
  187. package/dist/vite/index.esm.js +4 -1
  188. package/dist/vite/index.js +4 -1
  189. package/docs/STORAGE_BUCKETS.md +384 -0
  190. package/docs/WORKSPACE_KNOWLEDGE.md +1 -0
  191. package/docs/design-system/README.md +1 -1
  192. package/docs/design-system/dialogs.md +2 -0
  193. package/docs/design-system/patterns/core-providers.md +2 -0
  194. package/docs/design-system/selectors.md +4 -0
  195. package/package.json +7 -1
  196. package/dist/components/ui/__tests__/status-badge.test.d.ts +0 -1
@@ -3,17 +3,28 @@
3
3
  * Ported from Angular v1/v2 detail rendering logic
4
4
  */
5
5
  import type { AuditTrail, AuditTrailDetails, AuditTrailDetailRow, AuditTrailEvent, AuditTrailSoftware } from './types';
6
- /** Process raw trails: translate software/event, compute date, sort desc */
6
+ /** Process raw trails: translate software/event, compute date, sort desc *
7
+ * @example
8
+ * processTrails();
9
+ */
7
10
  export declare function processTrails(trails: AuditTrail[], events: AuditTrailEvent[], softwares: AuditTrailSoftware[], anonymousLabel?: string): AuditTrail[];
8
11
  export declare function translateEvent(eventName: string, events: AuditTrailEvent[]): string;
9
12
  export declare function translateSoftware(software: string, softwares: AuditTrailSoftware[]): string;
10
- /** Build detail rows from AuditTrailDetails (ported from v1/v2 addHeaderRow, addChangesRow, addFooterRow) */
13
+ /** Build detail rows from AuditTrailDetails (ported from v1/v2 addHeaderRow, addChangesRow, addFooterRow) *
14
+ * @example
15
+ * buildDetailRows();
16
+ */
11
17
  export declare function buildDetailRows(details: AuditTrailDetails, options?: {
12
18
  translateProperty?: (eventName: string, propertyResource: string) => string;
13
19
  translatePropertyValue?: (eventName: string, propertyResource: string, value: string) => string | null;
14
20
  formatDate?: (date: string) => string;
15
21
  labels?: Partial<typeof DEFAULT_LABELS>;
16
22
  }): AuditTrailDetailRow[];
23
+ /**
24
+ * Função utilitária `camelToDash`.
25
+ * @example
26
+ * camelToDash();
27
+ */
17
28
  export declare function camelToDash(str: string): string;
18
29
  declare const DEFAULT_LABELS: {
19
30
  readonly event: "Evento";
@@ -34,5 +45,10 @@ declare const DEFAULT_LABELS: {
34
45
  readonly stateModified: "(modificado)";
35
46
  readonly stateRemoved: "(removido)";
36
47
  };
48
+ /**
49
+ * Tipo `AuditTrailLabels` exportado pela lib.
50
+ * @example
51
+ * const value: AuditTrailLabels = {} as AuditTrailLabels;
52
+ */
37
53
  export type AuditTrailLabels = Partial<typeof DEFAULT_LABELS>;
38
54
  export {};
@@ -4,6 +4,7 @@ interface EditProfileDialogProps {
4
4
  onOpenChange: (open: boolean) => void;
5
5
  user: {
6
6
  name?: string | null;
7
+ email?: string | null;
7
8
  };
8
9
  userPhotoUrl: string | null;
9
10
  userInitials: string;
@@ -2,5 +2,10 @@ import React from 'react';
2
2
  interface ProtectedRouteProps {
3
3
  children: React.ReactNode;
4
4
  }
5
+ /**
6
+ * Componente `ProtectedRoute` da lib.
7
+ * @example
8
+ * <ProtectedRoute />
9
+ */
5
10
  export declare const ProtectedRoute: React.FC<ProtectedRouteProps>;
6
11
  export {};
@@ -10,6 +10,11 @@ interface AuthContextType extends AuthState {
10
10
  clearSearch: () => void;
11
11
  refreshData: () => void;
12
12
  }
13
+ /**
14
+ * Componente `AuthProvider` da lib.
15
+ * @example
16
+ * <AuthProvider />
17
+ */
13
18
  export declare const AuthProvider: React.FC<{
14
19
  children: React.ReactNode;
15
20
  }>;
@@ -1 +1,6 @@
1
+ /**
2
+ * Componente `CallbackPage` da lib.
3
+ * @example
4
+ * <CallbackPage />
5
+ */
1
6
  export declare const CallbackPage: () => import("react/jsx-runtime").JSX.Element;
@@ -1,4 +1,9 @@
1
1
  import type { AuthState } from '../../types';
2
+ /**
3
+ * Componente `AuthService` da lib.
4
+ * @example
5
+ * <AuthService />
6
+ */
2
7
  export declare class AuthService {
3
8
  /**
4
9
  * Inicializa o estado de autenticação verificando apenas tokens armazenados
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Componente `TokenManager` da lib.
3
+ * @example
4
+ * <TokenManager />
5
+ */
1
6
  export declare const TokenManager: {
2
7
  setAccessToken: (token: string) => void;
3
8
  getAccessToken: () => string;
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Tipo `JwtPayload` exportado pela lib.
3
+ * @example
4
+ * const value: JwtPayload = {} as JwtPayload;
5
+ */
1
6
  export interface JwtPayload {
2
7
  [key: string]: any;
3
8
  exp?: number;
@@ -12,6 +17,11 @@ interface TokenValidationResult {
12
17
  warnings: string[];
13
18
  errors: string[];
14
19
  }
20
+ /**
21
+ * Componente `TokenService` da lib.
22
+ * @example
23
+ * <TokenService />
24
+ */
15
25
  export declare class TokenService {
16
26
  private static readonly LARGE_PAYLOAD_THRESHOLD;
17
27
  /**
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Componente `AuthErrorInterceptor` da lib.
3
+ * @example
4
+ * <AuthErrorInterceptor />
5
+ */
1
6
  export declare class AuthErrorInterceptor {
2
7
  /**
3
8
  * Intercepts and handles authentication-related errors
@@ -1,4 +1,9 @@
1
1
  import { type Dashboard, DashboardFormTab, DashboardShareType, DashboardUpdateTime, DashboardViewType, DashboardPageTime } from './types';
2
+ /**
3
+ * Tipo `DashboardFormValues` exportado pela lib.
4
+ * @example
5
+ * const value: DashboardFormValues = {} as DashboardFormValues;
6
+ */
2
7
  export interface DashboardFormValues {
3
8
  titlePtBr: string;
4
9
  titleEnUs: string;
@@ -13,6 +18,11 @@ export interface DashboardFormValues {
13
18
  places?: string[];
14
19
  collaborators?: string[];
15
20
  }
21
+ /**
22
+ * Tipo `DashboardFormProps` exportado pela lib.
23
+ * @example
24
+ * const value: DashboardFormProps = {} as DashboardFormProps;
25
+ */
16
26
  export interface DashboardFormProps {
17
27
  /** Existing dashboard for editing; null for creation */
18
28
  dashboard?: Dashboard | null;
@@ -47,4 +57,9 @@ export interface DashboardFormProps {
47
57
  onCancel?: () => void;
48
58
  className?: string;
49
59
  }
60
+ /**
61
+ * Função utilitária `DashboardForm`.
62
+ * @example
63
+ * DashboardForm();
64
+ */
50
65
  export declare function DashboardForm({ dashboard, initialTab, isSaving, isQualitfy, users, groups, places, collaborators, onSave, onCancel, className, }: DashboardFormProps): import("react/jsx-runtime").JSX.Element;
@@ -3,6 +3,11 @@ import { type Dashboard, type DashboardPanel, type DashboardPage, type Dashboard
3
3
  import { type DashboardFormValues } from './dashboard-form';
4
4
  import { type GridPanelLayout } from './dashboard-grid';
5
5
  import { type DashboardPanelRendererProps } from './dashboard-panel-renderer';
6
+ /**
7
+ * Tipo `DashboardViewState` exportado pela lib.
8
+ * @example
9
+ * const value: DashboardViewState = {} as DashboardViewState;
10
+ */
6
11
  export type DashboardViewState = {
7
12
  mode: 'list';
8
13
  } | {
@@ -17,6 +22,11 @@ export type DashboardViewState = {
17
22
  mode: 'share';
18
23
  dashboardId: string;
19
24
  };
25
+ /**
26
+ * Tipo `DashboardGeneralViewProps` exportado pela lib.
27
+ * @example
28
+ * const value: DashboardGeneralViewProps = {} as DashboardGeneralViewProps;
29
+ */
20
30
  export interface DashboardGeneralViewProps {
21
31
  /** All dashboards for the list */
22
32
  dashboards: Dashboard[];
@@ -106,4 +116,9 @@ export interface DashboardGeneralViewProps {
106
116
  viewToolbarActions?: ReactNode;
107
117
  className?: string;
108
118
  }
119
+ /**
120
+ * Função utilitária `DashboardGeneralView`.
121
+ * @example
122
+ * DashboardGeneralView();
123
+ */
109
124
  export declare function DashboardGeneralView({ dashboards, limit, generalView, language, isLoading, canAdd, canEdit, canRemove, canEditStandard, activePanels, activePages, getPanelData, users, groups, places, collaborators, isSaving, onOpen, onBackToList, onRefresh, onRefreshList, onToggleFavorite, onSave, onUpdate, onRemove, onDuplicate, onShare, onAddPanel, onEditPanel, onRemovePanel, onDuplicatePanel, onLayoutChange, onSearch, onQuickFilterChange, onSetGeneralView, viewState: controlledViewState, onViewStateChange, listToolbarExtra, viewToolbarActions, className, }: DashboardGeneralViewProps): import("react/jsx-runtime").JSX.Element;
@@ -1,5 +1,10 @@
1
1
  import { type ReactNode } from 'react';
2
2
  import { DashboardPanelType } from './types';
3
+ /**
4
+ * Tipo `GridPanelLayout` exportado pela lib.
5
+ * @example
6
+ * const value: GridPanelLayout = {} as GridPanelLayout;
7
+ */
3
8
  export interface GridPanelLayout {
4
9
  id: string;
5
10
  col: number;
@@ -9,6 +14,11 @@ export interface GridPanelLayout {
9
14
  minSizeX?: number;
10
15
  minSizeY?: number;
11
16
  }
17
+ /**
18
+ * Tipo `DashboardGridProps` exportado pela lib.
19
+ * @example
20
+ * const value: DashboardGridProps = {} as DashboardGridProps;
21
+ */
12
22
  export interface DashboardGridProps {
13
23
  /**
14
24
  * Panel layout definitions. Each panel gets positioned in an 8-column grid.
@@ -30,12 +40,27 @@ export interface DashboardGridProps {
30
40
  onLayoutChange?: (panels: GridPanelLayout[]) => void;
31
41
  className?: string;
32
42
  }
43
+ /**
44
+ * Função utilitária `getDefaultPanelSize`.
45
+ * @example
46
+ * getDefaultPanelSize();
47
+ */
33
48
  export declare function getDefaultPanelSize(panelType: DashboardPanelType): {
34
49
  x: number;
35
50
  y: number;
36
51
  };
52
+ /**
53
+ * Função utilitária `getMinPanelSize`.
54
+ * @example
55
+ * getMinPanelSize();
56
+ */
37
57
  export declare function getMinPanelSize(panelType: DashboardPanelType): {
38
58
  x: number;
39
59
  y: number;
40
60
  };
61
+ /**
62
+ * Função utilitária `DashboardGrid`.
63
+ * @example
64
+ * DashboardGrid();
65
+ */
41
66
  export declare function DashboardGrid({ panels, columns, cellHeight, cellGap, allowDragging, showGridLines, renderPanel, onLayoutChange, className, }: DashboardGridProps): import("react/jsx-runtime").JSX.Element;
@@ -1,5 +1,10 @@
1
1
  import { type ReactNode } from 'react';
2
2
  import { type Dashboard, type DashboardLimit, QuickFilterDashboard, DashboardLanguage } from './types';
3
+ /**
4
+ * Tipo `DashboardListProps` exportado pela lib.
5
+ * @example
6
+ * const value: DashboardListProps = {} as DashboardListProps;
7
+ */
3
8
  export interface DashboardListProps {
4
9
  /** List of dashboards to display */
5
10
  dashboards: Dashboard[];
@@ -28,4 +33,9 @@ export interface DashboardListProps {
28
33
  toolbarExtra?: ReactNode;
29
34
  className?: string;
30
35
  }
36
+ /**
37
+ * Função utilitária `DashboardList`.
38
+ * @example
39
+ * DashboardList();
40
+ */
31
41
  export declare function DashboardList({ dashboards, limit, isLoading, language, canAdd, canEdit, canRemove, onOpen, onEdit, onShare, onDuplicate, onRemove, onAdd, onToggleFavorite, onRefresh, onSearch, onQuickFilterChange, toolbarExtra, className, }: DashboardListProps): import("react/jsx-runtime").JSX.Element;
@@ -1,6 +1,11 @@
1
1
  import { type ReactNode } from 'react';
2
2
  import { type PanelConfig, type PanelResult, PanelState } from './types';
3
3
  import { type ListPanelColumn, type BurndownDataPoint, type PerformanceDataPoint, type MatrixRule, type MatrixRisk, type CartesianSeries } from './panels';
4
+ /**
5
+ * Tipo `DashboardPanelRendererProps` exportado pela lib.
6
+ * @example
7
+ * const value: DashboardPanelRendererProps = {} as DashboardPanelRendererProps;
8
+ */
4
9
  export interface DashboardPanelRendererProps {
5
10
  config: PanelConfig;
6
11
  state: PanelState;
@@ -18,4 +23,9 @@ export interface DashboardPanelRendererProps {
18
23
  /** Callbacks */
19
24
  onPanelClick?: (data: Record<string, unknown>) => void;
20
25
  }
26
+ /**
27
+ * Função utilitária `DashboardPanelRenderer`.
28
+ * @example
29
+ * DashboardPanelRenderer();
30
+ */
21
31
  export declare function DashboardPanelRenderer({ config, state, data, numericValue, listColumns, cartesianData, cartesianSeries, burndownData, performanceData, matrixRule, matrixRisks, onPanelClick, }: DashboardPanelRendererProps): ReactNode;
@@ -2,6 +2,11 @@ import { type ReactNode } from 'react';
2
2
  import { type Dashboard, type DashboardPage, type DashboardPanel } from './types';
3
3
  import { type GridPanelLayout } from './dashboard-grid';
4
4
  import { type DashboardPanelRendererProps } from './dashboard-panel-renderer';
5
+ /**
6
+ * Tipo `DashboardViewProps` exportado pela lib.
7
+ * @example
8
+ * const value: DashboardViewProps = {} as DashboardViewProps;
9
+ */
5
10
  export interface DashboardViewProps {
6
11
  /** Dashboard metadata */
7
12
  dashboard: Dashboard;
@@ -35,4 +40,9 @@ export interface DashboardViewProps {
35
40
  toolbarActions?: ReactNode;
36
41
  className?: string;
37
42
  }
43
+ /**
44
+ * Função utilitária `DashboardView`.
45
+ * @example
46
+ * DashboardView();
47
+ */
38
48
  export declare function DashboardView({ dashboard, panels, pages, activePageId, canEdit, isFullscreen, isLoading, getPanelData, onRefresh, onToggleFullscreen, onToggleFavorite, onEdit, onShare, onAddPanel, onEditPanel, onRemovePanel, onDuplicatePanel, onLayoutChange, onPageChange, toolbarActions, className, }: DashboardViewProps): import("react/jsx-runtime").JSX.Element;
@@ -1,47 +1,86 @@
1
1
  import type { PanelResult, PlaceAnalysis } from './types';
2
- /** Month abbreviation → number (pt-BR) */
2
+ /** Month abbreviation → number (pt-BR) *
3
+ * @example
4
+ * <MONTHS_MAP />
5
+ */
3
6
  export declare const MONTHS_MAP: Record<string, number>;
4
- /** localStorage keys used by dashboard module */
7
+ /** localStorage keys used by dashboard module *
8
+ * @example
9
+ * <DASHBOARD_STORAGE_KEYS />
10
+ */
5
11
  export declare const DASHBOARD_STORAGE_KEYS: {
6
12
  readonly advancedFilter: "analysisDashboardsListFilter";
7
13
  };
8
- /** Fields known to contain currency values */
14
+ /** Fields known to contain currency values *
15
+ * @example
16
+ * <CURRENCY_FIELDS />
17
+ */
9
18
  export declare const CURRENCY_FIELDS: readonly ["total_calibration_cost", "total_verification_cost", "total_maintenance_cost", "last_calibration_cost", "last_verification_cost", "last_maintenance_cost", "total_cost", "total_reported_cost", "estimated_cost", "last_report_cost_reported_cost", "occurrence_reported_cost", "task_estimated_cost"];
10
- /** Properties that may contain a navigable link in a row */
19
+ /** Properties that may contain a navigable link in a row *
20
+ * @example
21
+ * <LINK_PROPERTIES />
22
+ */
11
23
  export declare const LINK_PROPERTIES: readonly ["link", "link_risk", "risk_link", "link_group", "group_link", "link_occurrence", "occurrence_link", "link_audit", "link_project", "link_program", "link_ideia", "flow_link", "decision_link", "link_supplier", "auditing_link", "fmea_link"];
12
24
  /**
13
25
  * Sort panel results by month/year date (pt-BR format: "jan/2024").
26
+ *
27
+ * @example
28
+ * sortByMonthYear();
14
29
  */
15
30
  export declare function sortByMonthYear(dataSource: PanelResult[]): PanelResult[];
16
31
  /**
17
32
  * Check if a field value is null, undefined, or an empty string.
33
+ *
34
+ * @example
35
+ * isNullOrEmptyField();
18
36
  */
19
37
  export declare function isNullOrEmptyField(field: {
20
38
  value?: string | null;
21
39
  } | null | undefined): boolean;
22
40
  /**
23
41
  * Sanitize the last segment of a URL (title) by removing special chars and encoding.
42
+ *
43
+ * @example
44
+ * processUrl();
24
45
  */
25
46
  export declare function processUrl(url: string): string;
26
47
  /**
27
48
  * Get the first navigable link found in a row object.
49
+ *
50
+ * @example
51
+ * getLinkFromRow();
28
52
  */
29
53
  export declare function getLinkFromRow(row: Record<string, unknown>): string | null;
30
54
  /**
31
55
  * Serialize an object to query-string format (key=value&key=value).
56
+ *
57
+ * @example
58
+ * toQueryString();
32
59
  */
33
60
  export declare function toQueryString(obj: Record<string, unknown> | null | undefined): string | null;
34
61
  /**
35
62
  * Check if a string looks like a currency value.
63
+ *
64
+ * @example
65
+ * isCurrency();
36
66
  */
37
67
  export declare function isCurrency(value: string): boolean;
38
68
  /**
39
69
  * Extract a numeric value from a formatted currency string (pt-BR format).
70
+ *
71
+ * @example
72
+ * extractNumberFromCurrency();
40
73
  */
41
74
  export declare function extractNumberFromCurrency(value: string): number;
42
- /** Pre-built pt-BR currency formatter */
75
+ /** Pre-built pt-BR currency formatter *
76
+ * @example
77
+ * currencyFormatter;
78
+ */
43
79
  export declare const currencyFormatter: Intl.NumberFormat;
44
80
  /**
45
81
  * Build a hierarchical tree from a flat list of places.
82
+ *
83
+ * @example
84
+ * buildPlacesTree();
46
85
  */
47
86
  export declare function buildPlacesTree(places: PlaceAnalysis[]): PlaceAnalysis[];
@@ -1,5 +1,10 @@
1
1
  import { type PanelHeaderProps } from './panel-header';
2
2
  import { PanelState, type PanelConfig } from '../types';
3
+ /**
4
+ * Tipo `BurndownDataPoint` exportado pela lib.
5
+ * @example
6
+ * const value: BurndownDataPoint = {} as BurndownDataPoint;
7
+ */
3
8
  export interface BurndownDataPoint {
4
9
  date: string;
5
10
  executedPercentage: number;
@@ -7,6 +12,11 @@ export interface BurndownDataPoint {
7
12
  tooltipExecuted?: string;
8
13
  tooltipPlanned?: string;
9
14
  }
15
+ /**
16
+ * Tipo `BurndownPanelProps` exportado pela lib.
17
+ * @example
18
+ * const value: BurndownPanelProps = {} as BurndownPanelProps;
19
+ */
10
20
  export interface BurndownPanelProps {
11
21
  config: PanelConfig;
12
22
  state: PanelState;
@@ -23,4 +33,9 @@ export interface BurndownPanelProps {
23
33
  queryUrlBuilder?: PanelHeaderProps['queryUrlBuilder'];
24
34
  className?: string;
25
35
  }
36
+ /**
37
+ * Função utilitária `BurndownPanel`.
38
+ * @example
39
+ * BurndownPanel();
40
+ */
26
41
  export declare function BurndownPanel({ config, state, data, executedLabel, plannedLabel, executedColor, plannedColor, viewOnly, onRefresh, queryUrl, queryUrlBuilder, className, }: BurndownPanelProps): import("react/jsx-runtime").JSX.Element;
@@ -1,6 +1,16 @@
1
1
  import { type PanelHeaderProps } from './panel-header';
2
2
  import { PanelState, type PanelConfig } from '../types';
3
+ /**
4
+ * Tipo `CartesianVariant` exportado pela lib.
5
+ * @example
6
+ * const value: CartesianVariant = {} as CartesianVariant;
7
+ */
3
8
  export type CartesianVariant = 'bar' | 'column' | 'stacked-column' | 'area' | 'line' | 'evolution-line';
9
+ /**
10
+ * Tipo `CartesianSeries` exportado pela lib.
11
+ * @example
12
+ * const value: CartesianSeries = {} as CartesianSeries;
13
+ */
4
14
  export interface CartesianSeries {
5
15
  /** Data key in each data point */
6
16
  dataKey: string;
@@ -11,6 +21,11 @@ export interface CartesianSeries {
11
21
  /** Stack ID for stacked charts */
12
22
  stackId?: string;
13
23
  }
24
+ /**
25
+ * Tipo `CartesianPanelProps` exportado pela lib.
26
+ * @example
27
+ * const value: CartesianPanelProps = {} as CartesianPanelProps;
28
+ */
14
29
  export interface CartesianPanelProps {
15
30
  config: PanelConfig;
16
31
  /** Chart variant to render */
@@ -43,4 +58,9 @@ export interface CartesianPanelProps {
43
58
  queryUrlBuilder?: PanelHeaderProps['queryUrlBuilder'];
44
59
  className?: string;
45
60
  }
61
+ /**
62
+ * Função utilitária `CartesianPanel`.
63
+ * @example
64
+ * CartesianPanel();
65
+ */
46
66
  export declare function CartesianPanel({ config, variant, state, data, series: seriesProp, colors: colorsProp, categoryKey, yAxisFormat, viewOnly, onPointClick, onRefresh, onExport, queryUrl, queryUrlBuilder, className, }: CartesianPanelProps): import("react/jsx-runtime").JSX.Element;
@@ -1,10 +1,20 @@
1
1
  import React from 'react';
2
2
  import { type PanelHeaderProps } from './panel-header';
3
3
  import { PanelState, type PanelConfig, type SelectedColumn } from '../types';
4
+ /**
5
+ * Tipo `ListPanelColumn` exportado pela lib.
6
+ * @example
7
+ * const value: ListPanelColumn = {} as ListPanelColumn;
8
+ */
4
9
  export interface ListPanelColumn extends SelectedColumn {
5
10
  /** Render function override for custom cell content */
6
11
  render?: (value: unknown, row: Record<string, unknown>) => React.ReactNode;
7
12
  }
13
+ /**
14
+ * Tipo `ListPanelProps` exportado pela lib.
15
+ * @example
16
+ * const value: ListPanelProps = {} as ListPanelProps;
17
+ */
8
18
  export interface ListPanelProps {
9
19
  config: PanelConfig;
10
20
  /** Current state of the panel */
@@ -27,4 +37,9 @@ export interface ListPanelProps {
27
37
  enableRowLinks?: boolean;
28
38
  className?: string;
29
39
  }
40
+ /**
41
+ * Função utilitária `ListPanel`.
42
+ * @example
43
+ * ListPanel();
44
+ */
30
45
  export declare function ListPanel({ config, state, data, columns, viewOnly, onRowClick, onRefresh, onExport, queryUrl, queryUrlBuilder, enableRowLinks, className, }: ListPanelProps): import("react/jsx-runtime").JSX.Element;
@@ -1,9 +1,19 @@
1
1
  import { type PanelHeaderProps } from './panel-header';
2
2
  import { PanelState, MatrixViewType, type PanelConfig } from '../types';
3
+ /**
4
+ * Tipo `MatrixParameter` exportado pela lib.
5
+ * @example
6
+ * const value: MatrixParameter = {} as MatrixParameter;
7
+ */
3
8
  export interface MatrixParameter {
4
9
  name: string;
5
10
  position: number;
6
11
  }
12
+ /**
13
+ * Tipo `MatrixRule` exportado pela lib.
14
+ * @example
15
+ * const value: MatrixRule = {} as MatrixRule;
16
+ */
7
17
  export interface MatrixRule {
8
18
  name_x: string;
9
19
  name_y: string;
@@ -15,6 +25,11 @@ export interface MatrixRule {
15
25
  /** Matrix of colors indexed [y][x] */
16
26
  colorMatrix?: string[][];
17
27
  }
28
+ /**
29
+ * Tipo `MatrixRisk` exportado pela lib.
30
+ * @example
31
+ * const value: MatrixRisk = {} as MatrixRisk;
32
+ */
18
33
  export interface MatrixRisk {
19
34
  code: string;
20
35
  name: string;
@@ -29,6 +44,11 @@ export interface MatrixRisk {
29
44
  resultName?: string;
30
45
  link?: string;
31
46
  }
47
+ /**
48
+ * Tipo `MatrixRiskPanelProps` exportado pela lib.
49
+ * @example
50
+ * const value: MatrixRiskPanelProps = {} as MatrixRiskPanelProps;
51
+ */
32
52
  export interface MatrixRiskPanelProps {
33
53
  config: PanelConfig;
34
54
  state: PanelState;
@@ -46,4 +66,9 @@ export interface MatrixRiskPanelProps {
46
66
  queryUrlBuilder?: PanelHeaderProps['queryUrlBuilder'];
47
67
  className?: string;
48
68
  }
69
+ /**
70
+ * Função utilitária `MatrixRiskPanel`.
71
+ * @example
72
+ * MatrixRiskPanel();
73
+ */
49
74
  export declare function MatrixRiskPanel({ config, state, rule, risks, matrixViewType, viewOnly, onCellClick, onRiskClick, onRefresh, queryUrl, queryUrlBuilder, className, }: MatrixRiskPanelProps): import("react/jsx-runtime").JSX.Element;
@@ -1,5 +1,10 @@
1
1
  import { type PanelHeaderProps } from './panel-header';
2
2
  import { PanelState, type PanelConfig } from '../types';
3
+ /**
4
+ * Tipo `NumericPanelProps` exportado pela lib.
5
+ * @example
6
+ * const value: NumericPanelProps = {} as NumericPanelProps;
7
+ */
3
8
  export interface NumericPanelProps {
4
9
  config: PanelConfig;
5
10
  /** Current state of the panel */
@@ -19,4 +24,9 @@ export interface NumericPanelProps {
19
24
  queryUrlBuilder?: PanelHeaderProps['queryUrlBuilder'];
20
25
  className?: string;
21
26
  }
27
+ /**
28
+ * Função utilitária `NumericPanel`.
29
+ * @example
30
+ * NumericPanel();
31
+ */
22
32
  export declare function NumericPanel({ config, state, value, label, viewOnly, onClick, onRefresh, queryUrl, queryUrlBuilder, className, }: NumericPanelProps): import("react/jsx-runtime").JSX.Element;
@@ -1,8 +1,18 @@
1
1
  import type { PanelConfig } from '../types';
2
+ /**
3
+ * Tipo `PanelErrorProps` exportado pela lib.
4
+ * @example
5
+ * const value: PanelErrorProps = {} as PanelErrorProps;
6
+ */
2
7
  export interface PanelErrorProps {
3
8
  config: PanelConfig;
4
9
  /** URL to the query for troubleshooting */
5
10
  queryUrl?: string;
6
11
  className?: string;
7
12
  }
13
+ /**
14
+ * Função utilitária `PanelError`.
15
+ * @example
16
+ * PanelError();
17
+ */
8
18
  export declare function PanelError({ config, queryUrl, className }: PanelErrorProps): import("react/jsx-runtime").JSX.Element;
@@ -1,5 +1,10 @@
1
1
  import { type ReactNode } from 'react';
2
2
  import { type PanelConfig } from '../types';
3
+ /**
4
+ * Tipo `PanelHeaderProps` exportado pela lib.
5
+ * @example
6
+ * const value: PanelHeaderProps = {} as PanelHeaderProps;
7
+ */
3
8
  export interface PanelHeaderProps {
4
9
  config: PanelConfig;
5
10
  /** Hide the options menu (e.g. in general-view mode) */
@@ -14,4 +19,9 @@ export interface PanelHeaderProps {
14
19
  onToggleOnlyMine?: (value: boolean) => void;
15
20
  className?: string;
16
21
  }
22
+ /**
23
+ * Função utilitária `PanelHeader`.
24
+ * @example
25
+ * PanelHeader();
26
+ */
17
27
  export declare function PanelHeader({ config, viewOnly, complement, complementPosition, queryUrlBuilder, onRefresh, onExport, onToggleOnlyMine, className, }: PanelHeaderProps): import("react/jsx-runtime").JSX.Element;
@@ -1,7 +1,17 @@
1
1
  import { DashboardPanelType } from '../types';
2
+ /**
3
+ * Tipo `PanelLoaderProps` exportado pela lib.
4
+ * @example
5
+ * const value: PanelLoaderProps = {} as PanelLoaderProps;
6
+ */
2
7
  export interface PanelLoaderProps {
3
8
  /** Show extra "please wait" message for long-running panel types */
4
9
  panelType?: DashboardPanelType;
5
10
  className?: string;
6
11
  }
12
+ /**
13
+ * Função utilitária `PanelLoader`.
14
+ * @example
15
+ * PanelLoader();
16
+ */
7
17
  export declare function PanelLoader({ panelType, className }: PanelLoaderProps): import("react/jsx-runtime").JSX.Element;
@@ -1,6 +1,16 @@
1
+ /**
2
+ * Tipo `PanelNoDataProps` exportado pela lib.
3
+ * @example
4
+ * const value: PanelNoDataProps = {} as PanelNoDataProps;
5
+ */
1
6
  export interface PanelNoDataProps {
2
7
  /** Whether the panel has a removed column (shows different message) */
3
8
  hasRemovedColumn?: boolean;
4
9
  className?: string;
5
10
  }
11
+ /**
12
+ * Função utilitária `PanelNoData`.
13
+ * @example
14
+ * PanelNoData();
15
+ */
6
16
  export declare function PanelNoData({ hasRemovedColumn, className }: PanelNoDataProps): import("react/jsx-runtime").JSX.Element;