@cundi/refine-xaf 1.0.7 → 1.0.8

package/README.md

@@ -6,14 +6,19 @@ This is an SDK integrating XAF backend with Refine frontend, including core logi
 
 - **Auth Provider**: Handles login, logout, Token management, and permission checks.
 - **Data Provider**: Data access layer designed specifically for XAF OData.
+  - Supports `meta.expand` for OData `$expand` (navigation properties)
 - **UI Components**:
     - `Header`: Application header including user menu and theme toggle (Dark/Light Mode).
     - `LoginPage`: Standard login page.
     - `SmartList`, `RelatedList`: Highly encapsulated generic list and detail components. (**Note**: To use `defaultVisible` prop, import `@cundi/refine-xaf/dist/antd-column-ext` in your app entry)
     - `TiptapEditor`: Rich text editor with support for Images, Tables, Tasks, Math (LaTeX), YouTube, Emoji, Highlight, and Text Color.
     - `DrawioEditor`: Draw.io diagram editor with i18n language sync support.
+    - `Base64Upload`: Image upload component for XAF byte[] fields.
     - `ApplicationUser`: Complete user management (List, Create, Edit, Role Assignment).
     - `PermissionPolicyRole`: Complete role and permission management.
+    - `TriggerRule`: Webhook trigger rule management (List, Create, Edit).
+    - `TriggerLog`: Webhook execution log viewer with detail drawer.
+    - `MirrorTypeMappingConfig`: Data mirror type mapping configuration.
 
 ## How to use in a new project
 
@@ -220,6 +225,36 @@ export const DemoObjectList = () => {
 };
 ```
 
+### SmartList with Navigation Properties
+
+To display data from related entities, use the `meta` prop with `expand` and nested `dataIndex`:
+
+```tsx
+import { SmartList } from "@cundi/refine-xaf";
+import { Table, Typography } from "antd";
+
+const { Text } = Typography;
+
+export const OrderList = () => {
+    return (
+        <SmartList 
+            searchFields={["OrderNumber"]}
+            meta={{ expand: ["Customer"] }}  // OData $expand
+        >
+            <Table.Column dataIndex="OrderNumber" title="Order #" defaultVisible />
+            {/* Nested dataIndex for navigation property */}
+            <Table.Column 
+                dataIndex={["Customer", "Name"]} 
+                title="Customer" 
+                render={(value) => value ? <Text>{value}</Text> : '-'}
+                defaultVisible
+            />
+            <Table.Column dataIndex="Total" title="Total" />
+        </SmartList>
+    );
+};
+```
+
 ### Create/Edit Page
 
 Use standard Refine hooks (`useForm`) combined with Ant Design Form components. For file uploads (like Images), use the `Base64Upload` component provided by the SDK.
@@ -326,7 +361,18 @@ console.log(claims.sub, claims.exp);
 
 ## Changelog
 
-### v1.0.5 (Latest)
+### v1.0.8 (Latest)
+- Added `TriggerRuleList`, `TriggerRuleCreate`, `TriggerRuleEdit` components
+- Added `TriggerLogList` component with detail drawer
+- Added `MirrorTypeMappingConfigList`, `MirrorTypeMappingConfigCreate`, `MirrorTypeMappingConfigEdit` components
+- Added `meta` prop to `SmartList` for OData `$expand` support
+- Added support for nested `dataIndex` (array format) in `SmartList`
+- Added `getList` support for `meta.expand` in Data Provider
+- Added `useModelTypes` hook for dynamic type selection
+- Full i18n support for all new components (en, zh-TW)
+- Filtered TriggerRule/TriggerLog from target type selection to prevent recursion
+
+### v1.0.5
 - Added `DrawioEditor` component for Draw.io diagram editing
 - DrawioEditor supports automatic i18n language synchronization
 - Added `react-drawio` dependency

package/dist/index.d.mts

@@ -109,6 +109,95 @@ interface IJwtClaims {
     /** Allow additional claims */
     [key: string]: unknown;
 }
+/**
+ * HTTP method types for webhook requests
+ */
+declare enum HttpMethodType {
+    Post = "Post",
+    Get = "Get",
+    Put = "Put",
+    Patch = "Patch",
+    Delete = "Delete"
+}
+/**
+ * Trigger event types
+ */
+declare enum TriggerEventType {
+    Create = "Create",
+    Update = "Update",
+    Delete = "Delete"
+}
+/**
+ * Trigger rule configuration for webhook automation
+ */
+interface ITriggerRule extends IXafEntity {
+    /** Rule name */
+    Name: string;
+    /** Optional description */
+    Description?: string;
+    /** Full type name of the monitored object */
+    TargetTypeName?: string;
+    /** Trigger on object creation */
+    OnCreated: boolean;
+    /** Trigger on object modification */
+    OnModified: boolean;
+    /** Trigger on object deletion */
+    OnRemoved: boolean;
+    /** Whether the rule is active */
+    IsActive: boolean;
+    /** HTTP method for webhook */
+    HttpMethod: HttpMethodType;
+    /** Webhook URL */
+    WebhookUrl: string;
+    /** Custom headers in JSON format */
+    CustomHeaders?: string;
+    /** Only trigger if object matches criteria */
+    OnlyObjectFitsCriteria: boolean;
+    /** Criteria expression */
+    Criteria?: string;
+    /** Associated logs */
+    TriggerLogs?: ITriggerLog[];
+}
+/**
+ * Trigger execution log
+ */
+interface ITriggerLog extends IXafEntity {
+    /** Associated trigger rule */
+    TriggerRule?: ITriggerRule;
+    /** Execution timestamp */
+    ExecutionTime: string;
+    /** Object type that triggered the webhook */
+    ObjectType: string;
+    /** Object primary key */
+    ObjectKey: string;
+    /** Event type */
+    EventType: TriggerEventType;
+    /** HTTP method used */
+    HttpMethod: HttpMethodType;
+    /** Whether execution was successful */
+    IsSuccess: boolean;
+    /** HTTP status code */
+    StatusCode?: number;
+    /** Response body */
+    ResponseBody?: string;
+    /** Error message if failed */
+    ErrorMessage?: string;
+    /** JSON payload sent */
+    Payload?: string;
+}
+/**
+ * Mirror type mapping configuration for cross-system data sync
+ */
+interface IMirrorTypeMappingConfig extends IXafEntity {
+    /** Source system type name */
+    SourceTypeName: string;
+    /** Local type name */
+    LocalTypeName?: string;
+    /** Whether this mapping is active */
+    IsActive: boolean;
+    /** Optional description */
+    Description?: string;
+}
 
 declare const TOKEN_KEY = "refine-auth";
 declare class HttpError extends Error {
@@ -293,6 +382,117 @@ declare const refineXafTranslations: {
             roles: string;
             settings: string;
             backgroundJobs: string;
+            triggerRules: string;
+            triggerLogs: string;
+            mirrorConfigs: string;
+        };
+        users: {
+            fields: {
+                photo: string;
+                displayName: string;
+                userName: string;
+                email: string;
+                isActive: string;
+                accessFailedCount: string;
+            };
+            actions: {
+                resetPassword: string;
+            };
+            resetPasswordModal: {
+                title: string;
+                newPassword: string;
+                inputPlaceholder: string;
+                inputRequired: string;
+                generatePassword: string;
+            };
+        };
+        roles: {
+            fields: {
+                name: string;
+                isAdministrative: string;
+                permissionPolicy: string;
+                typePermissions: string;
+            };
+        };
+        triggerRules: {
+            fields: {
+                name: string;
+                description: string;
+                targetTypeName: string;
+                onCreated: string;
+                onModified: string;
+                onRemoved: string;
+                isActive: string;
+                httpMethod: string;
+                webhookUrl: string;
+                customHeaders: string;
+                onlyObjectFitsCriteria: string;
+                criteria: string;
+                triggerEvents: string;
+            };
+            tooltips: {
+                targetTypeName: string;
+                customHeaders: string;
+                criteria: string;
+            };
+            placeholders: {
+                name: string;
+                description: string;
+                webhookUrl: string;
+                customHeaders: string;
+                criteria: string;
+            };
+            validation: {
+                nameRequired: string;
+                webhookUrlRequired: string;
+                webhookUrlInvalid: string;
+            };
+        };
+        triggerLogs: {
+            fields: {
+                executionTime: string;
+                status: string;
+                eventType: string;
+                objectType: string;
+                objectKey: string;
+                httpMethod: string;
+                statusCode: string;
+                error: string;
+                payload: string;
+                responseBody: string;
+            };
+            status: {
+                success: string;
+                failed: string;
+            };
+            drawer: {
+                title: string;
+            };
+        };
+        mirrorConfigs: {
+            fields: {
+                sourceTypeName: string;
+                localTypeName: string;
+                isActive: string;
+                description: string;
+                status: string;
+            };
+            tooltips: {
+                sourceTypeName: string;
+                localTypeName: string;
+            };
+            placeholders: {
+                sourceTypeName: string;
+                description: string;
+            };
+            validation: {
+                sourceTypeNameRequired: string;
+                localTypeNameRequired: string;
+            };
+            statusLabels: {
+                active: string;
+                inactive: string;
+            };
         };
         backgroundJobs: {
             title: string;
@@ -443,6 +643,117 @@ declare const refineXafTranslations: {
             roles: string;
             settings: string;
             backgroundJobs: string;
+            triggerRules: string;
+            triggerLogs: string;
+            mirrorConfigs: string;
+        };
+        users: {
+            fields: {
+                photo: string;
+                displayName: string;
+                userName: string;
+                email: string;
+                isActive: string;
+                accessFailedCount: string;
+            };
+            actions: {
+                resetPassword: string;
+            };
+            resetPasswordModal: {
+                title: string;
+                newPassword: string;
+                inputPlaceholder: string;
+                inputRequired: string;
+                generatePassword: string;
+            };
+        };
+        roles: {
+            fields: {
+                name: string;
+                isAdministrative: string;
+                permissionPolicy: string;
+                typePermissions: string;
+            };
+        };
+        triggerRules: {
+            fields: {
+                name: string;
+                description: string;
+                targetTypeName: string;
+                onCreated: string;
+                onModified: string;
+                onRemoved: string;
+                isActive: string;
+                httpMethod: string;
+                webhookUrl: string;
+                customHeaders: string;
+                onlyObjectFitsCriteria: string;
+                criteria: string;
+                triggerEvents: string;
+            };
+            tooltips: {
+                targetTypeName: string;
+                customHeaders: string;
+                criteria: string;
+            };
+            placeholders: {
+                name: string;
+                description: string;
+                webhookUrl: string;
+                customHeaders: string;
+                criteria: string;
+            };
+            validation: {
+                nameRequired: string;
+                webhookUrlRequired: string;
+                webhookUrlInvalid: string;
+            };
+        };
+        triggerLogs: {
+            fields: {
+                executionTime: string;
+                status: string;
+                eventType: string;
+                objectType: string;
+                objectKey: string;
+                httpMethod: string;
+                statusCode: string;
+                error: string;
+                payload: string;
+                responseBody: string;
+            };
+            status: {
+                success: string;
+                failed: string;
+            };
+            drawer: {
+                title: string;
+            };
+        };
+        mirrorConfigs: {
+            fields: {
+                sourceTypeName: string;
+                localTypeName: string;
+                isActive: string;
+                description: string;
+                status: string;
+            };
+            tooltips: {
+                sourceTypeName: string;
+                localTypeName: string;
+            };
+            placeholders: {
+                sourceTypeName: string;
+                description: string;
+            };
+            validation: {
+                sourceTypeNameRequired: string;
+                localTypeNameRequired: string;
+            };
+            statusLabels: {
+                active: string;
+                inactive: string;
+            };
         };
         backgroundJobs: {
             title: string;
@@ -503,8 +814,12 @@ interface SmartListProps {
     children?: React.ReactNode;
     resource?: string;
     searchFields?: string[];
+    meta?: {
+        expand?: string[];
+        [key: string]: any;
+    };
 }
-declare const SmartList: <T extends BaseRecord = BaseRecord>({ children, resource, searchFields, }: SmartListProps) => React.JSX.Element;
+declare const SmartList: <T extends BaseRecord = BaseRecord>({ children, resource, searchFields, meta, }: SmartListProps) => React.JSX.Element;
 
 interface RelatedListProps<TItem extends BaseRecord> {
     resource: string;
@@ -589,6 +904,48 @@ interface BackgroundJobListProps {
  */
 declare const BackgroundJobList: React.FC<BackgroundJobListProps>;
 
+/**
+ * TriggerRule list page component
+ * Displays webhook trigger rules with their configurations
+ */
+declare const TriggerRuleList: React.FC<IResourceComponentsProps>;
+
+/**
+ * TriggerRule create page component
+ * Form for creating new webhook trigger rules
+ */
+declare const TriggerRuleCreate: React.FC<IResourceComponentsProps>;
+
+/**
+ * TriggerRule edit page component
+ * Form for editing existing webhook trigger rules
+ */
+declare const TriggerRuleEdit: React.FC<IResourceComponentsProps>;
+
+/**
+ * TriggerLog list page component
+ * Displays webhook execution logs
+ */
+declare const TriggerLogList: React.FC<IResourceComponentsProps>;
+
+/**
+ * MirrorTypeMappingConfig list page component
+ * Displays type mapping configurations for cross-system data synchronization
+ */
+declare const MirrorTypeMappingConfigList: React.FC<IResourceComponentsProps>;
+
+/**
+ * MirrorTypeMappingConfig create page component
+ * Form for creating new type mapping configurations
+ */
+declare const MirrorTypeMappingConfigCreate: React.FC<IResourceComponentsProps>;
+
+/**
+ * MirrorTypeMappingConfig edit page component
+ * Form for editing existing type mapping configurations
+ */
+declare const MirrorTypeMappingConfigEdit: React.FC<IResourceComponentsProps>;
+
 type ColorModeContextType = {
     mode: "light" | "dark";
     setMode: (mode: "light" | "dark") => void;
@@ -607,4 +964,4 @@ interface IModelType {
 }
 declare const useModelTypes: () => _tanstack_react_query.UseQueryResult<IModelType[], Error>;
 
-export { ApplicationUserCreate, ApplicationUserEdit, ApplicationUserList, AuthCallback, BackgroundJobList, type BackgroundJobListProps, Base64Upload, ColorModeContext, ColorModeContextProvider, DrawioEditor, type DrawioEditorProps, Header, HttpError, type IApplicationUser, type IJwtClaims, type IModelType, type IPermissionPolicyRole, type IPermissionPolicyTypePermissionObject, type IXafEntity, KeycloakLoginPage, type KeycloakTokenResponse, LoginPage, RelatedList, type RequestOptions, RoleCreate, RoleEdit, RoleList, SecurityPermissionPolicy, SecurityPermissionState, SmartList, TOKEN_KEY, TiptapEditor, type TiptapEditorProps, authProvider, authService, dataProvider, generatePassword, getBaseUrl, httpClient, keycloakService, parseJwt, refineXafTranslations, useColorMode, useModelTypes, validatePasswordStrength };
+export { ApplicationUserCreate, ApplicationUserEdit, ApplicationUserList, AuthCallback, BackgroundJobList, type BackgroundJobListProps, Base64Upload, ColorModeContext, ColorModeContextProvider, DrawioEditor, type DrawioEditorProps, Header, HttpError, HttpMethodType, type IApplicationUser, type IJwtClaims, type IMirrorTypeMappingConfig, type IModelType, type IPermissionPolicyRole, type IPermissionPolicyTypePermissionObject, type ITriggerLog, type ITriggerRule, type IXafEntity, KeycloakLoginPage, type KeycloakTokenResponse, LoginPage, MirrorTypeMappingConfigCreate, MirrorTypeMappingConfigEdit, MirrorTypeMappingConfigList, RelatedList, type RequestOptions, RoleCreate, RoleEdit, RoleList, SecurityPermissionPolicy, SecurityPermissionState, SmartList, TOKEN_KEY, TiptapEditor, type TiptapEditorProps, TriggerEventType, TriggerLogList, TriggerRuleCreate, TriggerRuleEdit, TriggerRuleList, authProvider, authService, dataProvider, generatePassword, getBaseUrl, httpClient, keycloakService, parseJwt, refineXafTranslations, useColorMode, useModelTypes, validatePasswordStrength };