orbcafe-ui 1.0.5 → 1.0.6

package/README.md

@@ -10,6 +10,51 @@
 
 ---
 
+## 重点组件：CMessageBox（请优先使用）
+
+`CMessageBox` 是标准体系里用于统一提示/确认交互的基础分子组件，适用于：
+
+- 删除确认
+- 保存成功提示
+- 警告/错误弹窗
+- 通用信息提醒
+
+> 建议在项目中统一使用 `CMessageBox`，避免各页面自行拼装不一致的 Dialog 样式。
+
+### Import
+
+```tsx
+import { CMessageBox } from 'orbcafe-ui';
+```
+
+### 最小示例
+
+```tsx
+const [open, setOpen] = useState(false);
+
+<CMessageBox
+  open={open}
+  type="warning"
+  title="Delete Item"
+  message="Are you sure you want to delete this record?"
+  confirmText="Delete"
+  cancelText="Cancel"
+  onClose={() => setOpen(false)}
+  onConfirm={() => {
+    // do delete
+    setOpen(false);
+  }}
+/>;
+```
+
+### 标准约定
+
+- `type`: `success | warning | error | info | default`
+- 默认支持确认与取消按钮，可通过 `showCancel` 控制
+- 建议所有业务确认弹窗统一走该组件，保证品牌与交互一致
+
+---
+
 ## Installation
 
 ```bash
@@ -33,6 +78,53 @@ module.exports = {
 
 ---
 
+## Internationalization (i18n)
+
+ORBCAFE UI 标准组件已内置 6 种语言：
+
+- `en` (English)
+- `zh` (中文)
+- `fr` (Français)
+- `de` (Deutsch)
+- `ja` (日本語)
+- `ko` (한국어)
+
+可通过 `OrbcafeI18nProvider` 或 `CAppPageLayout.locale` 统一控制语言。
+
+### 方式 1：在应用根部包裹 Provider
+
+```tsx
+import { OrbcafeI18nProvider } from 'orbcafe-ui';
+
+<OrbcafeI18nProvider locale="de">
+  <YourApp />
+</OrbcafeI18nProvider>
+```
+
+### 方式 2：使用 PageLayout 时直接传 `locale`
+
+```tsx
+<CAppPageLayout
+  appTitle="ORBCAFE"
+  locale="ja"
+  menuData={menuData}
+>
+  {children}
+</CAppPageLayout>
+```
+
+组件内部统一使用同一套翻译 key，避免出现中英混搭。
+
+### 国际化维护规范（必须）
+
+- 所有标准组件可见文案必须通过 `useOrbcafeI18n().t()` 读取，不允许新增硬编码文案。
+- 统一词条源：`src/i18n/messages.ts`。
+- 新增文案时必须同时补齐 6 个语言分支：`en/zh/fr/de/ja/ko`。
+- 业务字段值（如状态、类别）建议采用“稳定 value + 本地化 label”模式，避免筛选逻辑与展示文案耦合。
+- 示例工程（`examples/app/std-report/page.tsx`）已按该模式实现，作为接入参考。
+
+---
+
 ## ORBCAFE UI 标准化规范（Template Spec）
 
 以下规范适用于“成形组件（Standard Component）”，例如：
@@ -169,4 +261,3 @@ const { navigationIslandProps } = useNavigationIsland({
 ## License
 
 MIT
-

package/dist/index.d.mts

@@ -88,6 +88,53 @@ interface UseNavigationIslandResult {
  */
 declare const useNavigationIsland: (options?: UseNavigationIslandOptions) => UseNavigationIslandResult;
 
+/**
+ * @file 10_Frontend/components/sap/ui/Common/Molecules/CMessageBox.tsx
+ *
+ * @summary Core frontend CMessageBox module for the ORBAI Core project
+ * @author ORBAICODER
+ * @version 1.0.0
+ * @date 2025-01-19
+ *
+ * @description
+ * This file is responsible for:
+ *  - Implementing CMessageBox functionality within frontend workflows
+ *  - Integrating with shared ORBAI Core application processes under frontend
+ *
+ * @logic
+ * 1. Import required dependencies and configuration
+ * 2. Execute the primary logic for CMessageBox
+ * 3. Export the resulting APIs, hooks, or components for reuse
+ *
+ * @changelog
+ * V1.0.0 - 2025-01-19 - Initial creation
+ */
+/**
+ * File Overview
+ *
+ * START CODING
+ *
+ * --------------------------
+ * SECTION 1: CMessageBox Core Logic
+ * Section overview and description.
+ * --------------------------
+ */
+
+type CMessageBoxType = 'success' | 'warning' | 'error' | 'info' | 'default';
+interface CMessageBoxProps {
+    open: boolean;
+    title?: string;
+    message?: string | React__default.ReactNode;
+    onClose: () => void;
+    onConfirm?: () => void;
+    confirmText?: string;
+    cancelText?: string;
+    showCancel?: boolean;
+    maxWidth?: 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+    type?: CMessageBoxType;
+}
+declare const CMessageBox: React__default.FC<CMessageBoxProps>;
+
 interface GraphReportFieldMapping {
     primaryDimension: string;
     secondaryDimension: string;
@@ -106,6 +153,39 @@ interface GraphReportConfig {
     statusFlagValues?: string[];
 }
 
+interface CTableQuickCreateConfig {
+    enabled?: boolean;
+    title?: string;
+    description?: string;
+    submitLabel?: string;
+    cancelLabel?: string;
+    fields?: string[];
+    excludeFields?: string[];
+    initialValues?: Record<string, any>;
+    onSubmit?: (payload: Record<string, any>) => void | Promise<void>;
+}
+interface CTableQuickEditConfig {
+    enabled?: boolean;
+    title?: string;
+    description?: string;
+    submitLabel?: string;
+    cancelLabel?: string;
+    fields?: string[];
+    excludeFields?: string[];
+    editableFields?: string[];
+    nonEditableFields?: string[];
+    primaryKeys?: string[];
+    getInitialValues?: (row: Record<string, any>) => Record<string, any>;
+    onSubmit?: (payload: Record<string, any>, row: Record<string, any>) => void | Promise<void>;
+}
+interface CTableQuickDeleteConfig {
+    enabled?: boolean;
+    title?: string;
+    message?: string;
+    confirmText?: string;
+    cancelText?: string;
+    onConfirm?: (rows: Record<string, any>[]) => void | Promise<void>;
+}
 interface CTableProps {
     appId?: string;
     title?: string;
@@ -137,6 +217,9 @@ interface CTableProps {
     orderBy?: string;
     onSortChange?: (property: string, direction: 'asc' | 'desc') => void;
     graphReport?: GraphReportConfig;
+    quickCreate?: CTableQuickCreateConfig;
+    quickEdit?: CTableQuickEditConfig;
+    quickDelete?: CTableQuickDeleteConfig;
 }
 interface CTableHeadProps {
     columns: any[];
@@ -165,6 +248,7 @@ interface CTableBodyProps {
     loading?: boolean;
     expandedGroups?: Set<string>;
     toggleGroupExpand?: (groupId: string) => void;
+    isGroupFullyExpanded?: (groupId: string) => boolean;
     handleExpandGroupRecursively?: (groupId: string) => void;
     handleCollapseGroupRecursively?: (groupId: string) => void;
     handleClick?: (event: React.MouseEvent, row: any) => void;
@@ -512,8 +596,10 @@ interface ReportMetadata {
 interface UseStandardReportOptions {
     metadata: ReportMetadata;
     fetchData?: (params: any) => Promise<any>;
+    initialRowsPerPage?: number;
+    rowsPerPageOptions?: number[];
 }
-declare const useStandardReport: ({ metadata, fetchData }: UseStandardReportOptions) => {
+declare const useStandardReport: ({ metadata, fetchData, initialRowsPerPage, rowsPerPageOptions, }: UseStandardReportOptions) => {
     pageProps: CStandardPageProps;
     filters: Record<string, any>;
     rows: any[];
@@ -521,6 +607,162 @@ declare const useStandardReport: ({ metadata, fetchData }: UseStandardReportOpti
     refresh: () => void;
 };
 
+type OrbcafeLocale = 'en' | 'zh' | 'fr' | 'de' | 'ja' | 'ko';
+declare const en: {
+    readonly 'common.cancel': "Cancel";
+    readonly 'common.save': "Save";
+    readonly 'common.ok': "OK";
+    readonly 'common.done': "Done";
+    readonly 'common.search': "Search";
+    readonly 'common.none': "None";
+    readonly 'common.all': "All";
+    readonly 'common.noData': "No data";
+    readonly 'common.copy': "Copy";
+    readonly 'common.delete': "Delete";
+    readonly 'common.loading': "Loading...";
+    readonly 'header.searchPlaceholder': "Ask me...";
+    readonly 'header.theme.system': "Theme: System";
+    readonly 'header.theme.dark': "Theme: Dark";
+    readonly 'header.theme.light': "Theme: Light";
+    readonly 'header.menu.setting': "Setting";
+    readonly 'header.menu.logout': "Logout";
+    readonly 'navigation.expand': "Expand navigation";
+    readonly 'navigation.collapse': "Collapse navigation";
+    readonly 'navigation.searchPlaceholder': "Search menu...";
+    readonly 'navigation.noMatch': "No matching menu items";
+    readonly 'navigation.noAccessibleApp': "No accessible applications";
+    readonly 'navigation.noItems': "No items to display";
+    readonly 'navigation.expandView': "Expand {title}";
+    readonly 'table.toolbar.searchPlaceholder': "Search...";
+    readonly 'table.title.default': "Data Table";
+    readonly 'table.toolbar.groupBy': "Group By";
+    readonly 'table.toolbar.summary': "Summary";
+    readonly 'table.toolbar.columns': "Columns";
+    readonly 'table.toolbar.export': "Export";
+    readonly 'table.toolbar.itemsPerPage': "Items per page:";
+    readonly 'table.toolbar.pageOf': "Page {current} of {total}";
+    readonly 'table.toolbar.newItem': "New Item";
+    readonly 'table.toolbar.editItem': "Edit Item";
+    readonly 'table.toolbar.deleteItem': "Delete Item";
+    readonly 'table.toolbar.graphicReport': "Graphic Report";
+    readonly 'table.toolbar.saveLayout': "Save Layout";
+    readonly 'table.menu.groupBy': "Group By";
+    readonly 'table.menu.clearAll': "Clear All";
+    readonly 'table.menu.visibleColumns': "Visible Columns";
+    readonly 'table.menu.showSummaryRow': "Show Summary Row";
+    readonly 'table.menu.noNumericColumns': "No numeric columns";
+    readonly 'table.group.expandAll': "Expand All Groups";
+    readonly 'table.group.collapseAll': "Collapse All Groups";
+    readonly 'table.mobile.notImplemented': "Mobile View Not Implemented";
+    readonly 'smartFilter.adaptFilters': "Adapt Filters";
+    readonly 'smartFilter.addFilters': "Add Filters";
+    readonly 'smartFilter.go': "Go";
+    readonly 'smartFilter.visibleFilters': "Visible Filters";
+    readonly 'smartFilter.searchPlaceholder': "Search...";
+    readonly 'smartFilter.noOptionsFound': "No options found";
+    readonly 'smartFilter.min': "Min";
+    readonly 'smartFilter.max': "Max";
+    readonly 'smartFilter.minMaxPlaceholder': "Min - Max";
+    readonly 'smartFilter.operator.equals': "Equals";
+    readonly 'smartFilter.operator.contains': "Contains";
+    readonly 'smartFilter.operator.notContains': "Does Not Contain";
+    readonly 'smartFilter.operator.wildcard': "Wildcard Search";
+    readonly 'smartFilter.operator.notEquals': "Not Equals";
+    readonly 'smartFilter.operator.greaterThan': "Greater Than";
+    readonly 'smartFilter.operator.lessThan': "Less Than";
+    readonly 'smartFilter.operator.greaterOrEqual': "Greater Than or Equal";
+    readonly 'smartFilter.operator.lessOrEqual': "Less Than or Equal";
+    readonly 'smartFilter.operator.between': "Between";
+    readonly 'variant.noOptions': "No options";
+    readonly 'variant.defaultSuffix': "Default";
+    readonly 'variant.selectVariant': "Select Variant";
+    readonly 'variant.saveView': "Save View";
+    readonly 'variant.newVariant': "New Variant";
+    readonly 'variant.viewName': "View Name";
+    readonly 'variant.setDefault': "Set as Default";
+    readonly 'variant.publicAllUsers': "Public (All Users)";
+    readonly 'variant.toast.fetchFailed': "Failed to load variants";
+    readonly 'variant.toast.saveFailed': "Failed to save variant";
+    readonly 'variant.toast.saveSuccess': "Variant saved successfully";
+    readonly 'variant.toast.deleteFailed': "Failed to delete variant";
+    readonly 'variant.toast.deleteSuccess': "Variant deleted successfully";
+    readonly 'variant.toast.defaultFailed': "Failed to update default variant";
+    readonly 'variant.toast.defaultSuccess': "Default variant updated";
+    readonly 'layout.saveLayout': "Save Layout";
+    readonly 'layout.layoutOptions': "Layout Options";
+    readonly 'layout.selectLayout': "Select Layout";
+    readonly 'layout.saveCurrentLayout': "Save Current Layout...";
+    readonly 'layout.noSavedLayouts': "No saved layouts";
+    readonly 'layout.removeDefault': "Remove Default";
+    readonly 'layout.setAsDefault': "Set as Default";
+    readonly 'layout.layoutName': "Layout Name";
+    readonly 'layout.layoutDescription': "Description";
+    readonly 'layout.layoutNameHelper': "e.g., 'Compact View'";
+    readonly 'layout.warningOverwrite': "Warning: Existing layout will be overwritten";
+    readonly 'layout.useAsDefault': "Use as Default Layout";
+    readonly 'layout.publicAllUsers': "Public (Visible to all users)";
+    readonly 'layout.toast.loadFallback': "Failed to load layouts from backend, fallback to local storage";
+    readonly 'layout.toast.saveSuccess': "Layout saved successfully";
+    readonly 'layout.toast.saveLocalSuccess': "Layout saved to local storage";
+    readonly 'layout.toast.backendUnavailableSavedLocal': "Backend unavailable, saved to local storage";
+    readonly 'layout.toast.deleteSuccess': "Layout deleted successfully";
+    readonly 'layout.toast.deleteLocalSuccess': "Layout deleted from local storage";
+    readonly 'layout.toast.backendUnavailableDeletedLocal': "Backend unavailable, deleted from local storage";
+    readonly 'layout.toast.defaultSuccess': "Default layout set";
+    readonly 'layout.toast.defaultLocalSuccess': "Default layout set in local storage";
+    readonly 'layout.toast.backendUnavailableDefaultLocal': "Backend unavailable, default saved to local storage";
+    readonly 'dateRange.label': "Date Range";
+    readonly 'dateRange.startDate': "Start Date";
+    readonly 'dateRange.endDate': "End Date";
+    readonly 'dateRange.select': "Select...";
+    readonly 'dateRange.today': "Today";
+    readonly 'dateRange.thisWeek': "This Week";
+    readonly 'dateRange.thisMonth': "This Month";
+    readonly 'graph.records': "{count} records";
+    readonly 'graph.kpi.totalRecords': "Total Records";
+    readonly 'graph.kpi.totalReport': "Total Report";
+    readonly 'graph.kpi.totalBillable': "Total Billable";
+    readonly 'graph.kpi.efficiency': "Efficiency";
+    readonly 'graph.kpi.amount': "Amount";
+    readonly 'graph.kpi.flagged': "Flagged";
+    readonly 'graph.chart.billable.title': "Billable by Dimension";
+    readonly 'graph.chart.billable.subtitle': "Top values by billable hours";
+    readonly 'graph.chart.efficiency.title': "Efficiency by Person";
+    readonly 'graph.chart.efficiency.subtitle': "Lowest efficiency first";
+    readonly 'graph.chart.status.title': "Status Distribution";
+    readonly 'graph.chart.status.subtitle': "Record ratio by status";
+    readonly 'graph.dataBody': "Data Body";
+    readonly 'graph.reportTitle': "Graphic Report";
+    readonly 'graph.unassigned': "Unassigned";
+    readonly 'graph.column.reportHours': "Report Hours";
+    readonly 'graph.column.billableHours': "Billable Hours";
+    readonly 'quickCreate.newItem': "New Item";
+    readonly 'quickCreate.createWithTitle': "Create {title}";
+    readonly 'quickEdit.editWithTitle': "Edit {title}";
+    readonly 'quickDelete.confirmTitle': "Confirm Delete";
+    readonly 'quickDelete.confirmMessageSingle': "Are you sure you want to delete the selected record?";
+    readonly 'quickDelete.confirmMessageMultiple': "Are you sure you want to delete {count} selected records?";
+    readonly 'messageBox.confirm': "OK";
+    readonly 'messageBox.cancel': "Cancel";
+};
+type OrbcafeMessages = Record<keyof typeof en, string>;
+type OrbcafeMessageKey = keyof OrbcafeMessages;
+type OrbcafeMessageParams = Record<string, string | number>;
+type OrbcafeLocaleMessages = Record<OrbcafeMessageKey, string>;
+declare const ORBCAFE_I18N_MESSAGES: Record<OrbcafeLocale, OrbcafeLocaleMessages>;
+
+interface OrbcafeI18nContextValue {
+    locale: OrbcafeLocale;
+    t: (key: OrbcafeMessageKey, params?: OrbcafeMessageParams) => string;
+}
+interface OrbcafeI18nProviderProps {
+    locale?: OrbcafeLocale;
+    messages?: Partial<Record<OrbcafeLocale, Partial<OrbcafeLocaleMessages>>>;
+    children: React__default.ReactNode;
+}
+declare const OrbcafeI18nProvider: ({ locale, messages, children, }: OrbcafeI18nProviderProps) => react_jsx_runtime.JSX.Element;
+declare const useOrbcafeI18n: () => OrbcafeI18nContextValue;
+
 interface CAppHeaderUser {
     name: string;
     subtitle?: string;
@@ -532,7 +774,10 @@ interface CAppHeaderProps {
     logo?: ReactNode;
     mode?: 'light' | 'dark' | 'system';
     onToggleMode?: () => void;
+    locale?: OrbcafeLocale;
     localeLabel?: string;
+    localeOptions?: OrbcafeLocale[];
+    onLocaleChange?: (locale: OrbcafeLocale) => void;
     searchPlaceholder?: string;
     onSearch?: (query: string) => void;
     user?: CAppHeaderUser;
@@ -544,7 +789,10 @@ interface CAppPageLayoutProps {
     menuData?: TreeMenuItem[];
     children: ReactNode;
     showNavigation?: boolean;
+    locale?: OrbcafeLocale;
     localeLabel?: string;
+    localeOptions?: OrbcafeLocale[];
+    onLocaleChange?: (locale: OrbcafeLocale) => void;
     user?: CAppHeaderUser;
     logo?: ReactNode;
     onSearch?: (query: string) => void;
@@ -553,9 +801,9 @@ interface CAppPageLayoutProps {
     contentSx?: SxProps<Theme>;
 }
 
-declare const CAppPageLayout: ({ appTitle, menuData, children, showNavigation, localeLabel, user, logo, onSearch, rightHeaderSlot, leftHeaderSlot, contentSx, }: CAppPageLayoutProps) => react_jsx_runtime.JSX.Element;
+declare const CAppPageLayout: ({ appTitle, menuData, children, showNavigation, locale, localeLabel, localeOptions, onLocaleChange, user, logo, onSearch, rightHeaderSlot, leftHeaderSlot, contentSx, }: CAppPageLayoutProps) => react_jsx_runtime.JSX.Element;
 
-declare const CAppHeader: ({ appTitle, logo, mode, onToggleMode, localeLabel, searchPlaceholder, onSearch, user, leftSlot, rightSlot, }: CAppHeaderProps) => react_jsx_runtime.JSX.Element;
+declare const CAppHeader: ({ appTitle, logo, mode, onToggleMode, locale: localeProp, localeLabel, localeOptions, onLocaleChange, searchPlaceholder, onSearch, user, leftSlot, rightSlot, }: CAppHeaderProps) => react_jsx_runtime.JSX.Element;
 
 interface UsePageLayoutOptions {
     menuData?: TreeMenuItem[];
@@ -566,4 +814,4 @@ declare const usePageLayout: ({ menuData, initialNavigationCollapsed, }?: UsePag
     navigationMaxHeight: number;
 };
 
-export { Button, type ButtonProps, CAppHeader, type CAppHeaderProps, type CAppHeaderUser, CAppPageLayout, type CAppPageLayoutProps, CLayoutManagement, type CLayoutManagementProps, CLayoutManager, type CLayoutManagerProps, CPageLayout, type CPageLayoutProps, CSmartFilter, type CSmartFilterProps, CSmartTable, CStandardPage, type CStandardPageProps, CTable, CTableBody, type CTableBodyProps, CTableCell, type CTableCellProps, CTableContainer, type CTableContainerProps, CTableHead, type CTableHeadProps, type CTableProps, CTableRow, type CTableRowProps, CVariantManagement, type CVariantManagementProps, CVariantManager, type DateOperator, type FilterField, type FilterOperator, type FilterType, type FilterValue, type IVariantService, type LayoutMetadata, NavigationIsland, type NavigationIslandProps, type NumberOperator, type ReportColumn, type ReportFilter, type ReportMetadata, type SelectOperator, type TextOperator, TreeMenu, type TreeMenuItem, type UseNavigationIslandOptions, type UseNavigationIslandResult, type UsePageLayoutOptions, type UseStandardReportOptions, type VariantMetadata, buttonVariants, useNavigationIsland, usePageLayout, useStandardReport };
+export { Button, type ButtonProps, CAppHeader, type CAppHeaderProps, type CAppHeaderUser, CAppPageLayout, type CAppPageLayoutProps, CLayoutManagement, type CLayoutManagementProps, CLayoutManager, type CLayoutManagerProps, CMessageBox, type CMessageBoxProps, type CMessageBoxType, CPageLayout, type CPageLayoutProps, CSmartFilter, type CSmartFilterProps, CSmartTable, CStandardPage, type CStandardPageProps, CTable, CTableBody, type CTableBodyProps, CTableCell, type CTableCellProps, CTableContainer, type CTableContainerProps, CTableHead, type CTableHeadProps, type CTableProps, type CTableQuickCreateConfig, type CTableQuickDeleteConfig, type CTableQuickEditConfig, CTableRow, type CTableRowProps, CVariantManagement, type CVariantManagementProps, CVariantManager, type DateOperator, type FilterField, type FilterOperator, type FilterType, type FilterValue, type IVariantService, type LayoutMetadata, NavigationIsland, type NavigationIslandProps, type NumberOperator, ORBCAFE_I18N_MESSAGES, type OrbcafeI18nContextValue, OrbcafeI18nProvider, type OrbcafeI18nProviderProps, type OrbcafeLocale, type OrbcafeLocaleMessages, type OrbcafeMessageKey, type OrbcafeMessageParams, type ReportColumn, type ReportFilter, type ReportMetadata, type SelectOperator, type TextOperator, TreeMenu, type TreeMenuItem, type UseNavigationIslandOptions, type UseNavigationIslandResult, type UsePageLayoutOptions, type UseStandardReportOptions, type VariantMetadata, buttonVariants, useNavigationIsland, useOrbcafeI18n, usePageLayout, useStandardReport };