@cundi/refine-xaf 1.0.10 → 1.0.12

package/README.md

@@ -14,6 +14,7 @@ This is an SDK integrating XAF backend with Refine frontend, including core logi
     - `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.
+    - `GlobalSearch`: Full-text search component with type-grouped results and navigation.
     - `ApplicationUser`: Complete user management (List, Create, Edit, Role Assignment).
     - `PermissionPolicyRole`: Complete role and permission management.
     - `TriggerRule`: Webhook trigger rule management (List, Create, Edit).
@@ -322,6 +323,40 @@ import { Form } from "antd";
 // - autosave?: boolean      - Enable autosave (default: true)
 ```
 
+### GlobalSearch Usage
+
+Use the `GlobalSearch` component to provide full-text search across all business objects. The component includes debounced input, type-grouped results, and automatic navigation.
+
+```tsx
+import { GlobalSearch } from "@cundi/refine-xaf";
+
+// Basic usage (typically in Header or layout)
+<GlobalSearch />
+
+// With custom options
+<GlobalSearch 
+    placeholder="Search customers, orders..."
+    maxResults={100}
+    maxPerType={20}
+    width={320}
+/>
+
+// With custom click handler (overrides default navigation)
+<GlobalSearch 
+    onResultClick={(result) => {
+        console.log('Selected:', result);
+        // result: { displayName, objectKey, typeCaption, typeFullName, matchedContent }
+    }}
+/>
+
+// Props:
+// - placeholder?: string        - Search input placeholder
+// - maxResults?: number         - Maximum total results (default: 200)
+// - maxPerType?: number         - Maximum results per type (default: 50)
+// - width?: number | string     - Input width (default: 280)
+// - onResultClick?: (result) => void - Custom click handler
+```
+
 ## Development and Publishing
 
 1. **Install Dependencies**: `npm install`
@@ -361,7 +396,13 @@ console.log(claims.sub, claims.exp);
 
 ## Changelog
 
-### v1.0.8 (Latest)
+### v1.0.12 (Latest)
+- Added `GlobalSearch` component for full-text search across all persistent types
+- Added `globalSearch` service function for API calls
+- GlobalSearch features: debounce input, grouped results by type, click navigation to show/edit pages
+- Full i18n support for GlobalSearch (en, zh-TW)
+
+### v1.0.8
 - Added `TriggerRuleList`, `TriggerRuleCreate`, `TriggerRuleEdit` components
 - Added `TriggerLogList` component with detail drawer
 - Added `MirrorTypeMappingConfigList`, `MirrorTypeMappingConfigCreate`, `MirrorTypeMappingConfigEdit` components

package/dist/index.d.mts

@@ -283,6 +283,49 @@ declare const keycloakService: {
     logout: (idToken?: string) => void;
 };
 
+/**
+ * Individual search result item
+ */
+interface GlobalSearchResult {
+    /** Display name of the matched object */
+    displayName?: string;
+    /** Key value of the matched object */
+    objectKey?: string;
+    /** Human-readable type name */
+    typeCaption?: string;
+    /** Full type name including namespace */
+    typeFullName?: string;
+    /** Summary of where the keyword was matched */
+    matchedContent?: string;
+}
+/**
+ * Response from the global search API
+ */
+interface GlobalSearchResponse {
+    /** The search keyword that was used */
+    keyword?: string;
+    /** Total number of results returned */
+    totalCount: number;
+    /** List of search results */
+    results: GlobalSearchResult[];
+}
+/**
+ * Options for the global search query
+ */
+interface GlobalSearchOptions {
+    /** Maximum total results (default: 200) */
+    maxResults?: number;
+    /** Maximum results per type (default: 50) */
+    maxPerType?: number;
+}
+/**
+ * Execute a global full-text search across all persistent types.
+ * @param keyword - Search keyword (required)
+ * @param options - Optional search parameters
+ * @returns Promise with search results
+ */
+declare function globalSearch(keyword: string, options?: GlobalSearchOptions): Promise<GlobalSearchResponse>;
+
 declare const refineXafTranslations: {
     en: {
         pages: {
@@ -363,6 +406,12 @@ declare const refineXafTranslations: {
             drawioEditor: {
                 loading: string;
             };
+            globalSearch: {
+                placeholder: string;
+                searching: string;
+                noResults: string;
+                resultCount: string;
+            };
         };
         common: {
             actions: {
@@ -624,6 +673,12 @@ declare const refineXafTranslations: {
             drawioEditor: {
                 loading: string;
             };
+            globalSearch: {
+                placeholder: string;
+                searching: string;
+                noResults: string;
+                resultCount: string;
+            };
         };
         common: {
             actions: {
@@ -867,6 +922,25 @@ interface DrawioEditorProps {
 }
 declare const DrawioEditor: React.FC<DrawioEditorProps>;
 
+interface GlobalSearchProps {
+    /** Placeholder text for search input */
+    placeholder?: string;
+    /** Maximum total results (default: 200) */
+    maxResults?: number;
+    /** Maximum results per type (default: 50) */
+    maxPerType?: number;
+    /** Custom click handler for results */
+    onResultClick?: (result: GlobalSearchResult) => void;
+    /** Width of search input (default: 280) */
+    width?: number | string;
+    /** Custom type labels for localization (e.g., { "Article": "文章", "Product": "產品" }) */
+    typeLabels?: Record<string, string>;
+}
+/**
+ * Global full-text search component with dropdown results
+ */
+declare const GlobalSearch: React.FC<GlobalSearchProps>;
+
 declare const LoginPage: React.FC;
 
 declare const KeycloakLoginPage: React.FC;
@@ -964,4 +1038,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, 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 };
+export { ApplicationUserCreate, ApplicationUserEdit, ApplicationUserList, AuthCallback, BackgroundJobList, type BackgroundJobListProps, Base64Upload, ColorModeContext, ColorModeContextProvider, DrawioEditor, type DrawioEditorProps, GlobalSearch, type GlobalSearchOptions, type GlobalSearchProps, type GlobalSearchResponse, type GlobalSearchResult, 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, globalSearch, httpClient, keycloakService, parseJwt, refineXafTranslations, useColorMode, useModelTypes, validatePasswordStrength };

package/dist/index.d.ts

@@ -283,6 +283,49 @@ declare const keycloakService: {
     logout: (idToken?: string) => void;
 };
 
+/**
+ * Individual search result item
+ */
+interface GlobalSearchResult {
+    /** Display name of the matched object */
+    displayName?: string;
+    /** Key value of the matched object */
+    objectKey?: string;
+    /** Human-readable type name */
+    typeCaption?: string;
+    /** Full type name including namespace */
+    typeFullName?: string;
+    /** Summary of where the keyword was matched */
+    matchedContent?: string;
+}
+/**
+ * Response from the global search API
+ */
+interface GlobalSearchResponse {
+    /** The search keyword that was used */
+    keyword?: string;
+    /** Total number of results returned */
+    totalCount: number;
+    /** List of search results */
+    results: GlobalSearchResult[];
+}
+/**
+ * Options for the global search query
+ */
+interface GlobalSearchOptions {
+    /** Maximum total results (default: 200) */
+    maxResults?: number;
+    /** Maximum results per type (default: 50) */
+    maxPerType?: number;
+}
+/**
+ * Execute a global full-text search across all persistent types.
+ * @param keyword - Search keyword (required)
+ * @param options - Optional search parameters
+ * @returns Promise with search results
+ */
+declare function globalSearch(keyword: string, options?: GlobalSearchOptions): Promise<GlobalSearchResponse>;
+
 declare const refineXafTranslations: {
     en: {
         pages: {
@@ -363,6 +406,12 @@ declare const refineXafTranslations: {
             drawioEditor: {
                 loading: string;
             };
+            globalSearch: {
+                placeholder: string;
+                searching: string;
+                noResults: string;
+                resultCount: string;
+            };
         };
         common: {
             actions: {
@@ -624,6 +673,12 @@ declare const refineXafTranslations: {
             drawioEditor: {
                 loading: string;
             };
+            globalSearch: {
+                placeholder: string;
+                searching: string;
+                noResults: string;
+                resultCount: string;
+            };
         };
         common: {
             actions: {
@@ -867,6 +922,25 @@ interface DrawioEditorProps {
 }
 declare const DrawioEditor: React.FC<DrawioEditorProps>;
 
+interface GlobalSearchProps {
+    /** Placeholder text for search input */
+    placeholder?: string;
+    /** Maximum total results (default: 200) */
+    maxResults?: number;
+    /** Maximum results per type (default: 50) */
+    maxPerType?: number;
+    /** Custom click handler for results */
+    onResultClick?: (result: GlobalSearchResult) => void;
+    /** Width of search input (default: 280) */
+    width?: number | string;
+    /** Custom type labels for localization (e.g., { "Article": "文章", "Product": "產品" }) */
+    typeLabels?: Record<string, string>;
+}
+/**
+ * Global full-text search component with dropdown results
+ */
+declare const GlobalSearch: React.FC<GlobalSearchProps>;
+
 declare const LoginPage: React.FC;
 
 declare const KeycloakLoginPage: React.FC;
@@ -964,4 +1038,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, 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 };
+export { ApplicationUserCreate, ApplicationUserEdit, ApplicationUserList, AuthCallback, BackgroundJobList, type BackgroundJobListProps, Base64Upload, ColorModeContext, ColorModeContextProvider, DrawioEditor, type DrawioEditorProps, GlobalSearch, type GlobalSearchOptions, type GlobalSearchProps, type GlobalSearchResponse, type GlobalSearchResult, 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, globalSearch, httpClient, keycloakService, parseJwt, refineXafTranslations, useColorMode, useModelTypes, validatePasswordStrength };