@ahoo-wang/fetcher-viewer 3.8.9 → 3.9.2

package/dist/viewer/panel/ViewItemGroup.d.ts

@@ -1,9 +1,132 @@
 import { View } from '../types';
+/**
+ * Props for the ViewItemGroup component.
+ *
+ * @interface ViewItemGroupProps
+ */
 export interface ViewItemGroupProps {
+    /** Array of view configurations to display in the group */
     views: View[];
+    /** The currently active/selected view */
     activeView: View;
+    /** API endpoint URL for fetching record counts for each view */
     countUrl: string;
+    /** Callback function called when a view is selected/clicked */
     onViewChange: (view: View) => void;
 }
+/**
+ * ViewItemGroup Component
+ *
+ * A container component that displays a vertical list of view items, allowing users to
+ * switch between different views. Each view item shows the view name, system tag (if applicable),
+ * and record count. The component handles click events to change the active view and
+ * provides visual feedback for the currently selected view.
+ *
+ * @param props - The properties for configuring the view item group
+ * @param props.views - Array of view objects to display as selectable items
+ * @param props.activeView - The currently active view (used for visual highlighting)
+ * @param props.countUrl - API endpoint for fetching record counts for each view
+ * @param props.onViewChange - Callback fired when user clicks on a different view
+ *
+ * @example
+ * ```tsx
+ * import { ViewItemGroup } from './ViewItemGroup';
+ * import type { View } from '../types';
+ *
+ * const views: View[] = [
+ *   {
+ *     id: 'all-users',
+ *     name: 'All Users',
+ *     viewType: 'PUBLIC',
+ *     viewSource: 'CUSTOM',
+ *     isDefault: true,
+ *     filters: [],
+ *     columns: [
+ *       { dataIndex: 'id', fixed: false, visible: true },
+ *       { dataIndex: 'name', fixed: false, visible: true },
+ *       { dataIndex: 'email', fixed: false, visible: true }
+ *     ],
+ *     tableSize: 'middle',
+ *     condition: {},
+ *     pageSize: 20,
+ *     sortId: 1
+ *   },
+ *   {
+ *     id: 'active-users',
+ *     name: 'Active Users',
+ *     viewType: 'PERSONAL',
+ *     viewSource: 'CUSTOM',
+ *     isDefault: false,
+ *     filters: [],
+ *     columns: [
+ *       { dataIndex: 'id', fixed: false, visible: true },
+ *       { dataIndex: 'name', fixed: false, visible: true },
+ *       { dataIndex: 'status', fixed: false, visible: true }
+ *     ],
+ *     tableSize: 'middle',
+ *     condition: { status: 'active' },
+ *     pageSize: 20,
+ *     sortId: 2
+ *   },
+ *   {
+ *     id: 'admin-users',
+ *     name: 'Admin Users',
+ *     viewType: 'PUBLIC',
+ *     viewSource: 'SYSTEM',
+ *     isDefault: false,
+ *     filters: [],
+ *     columns: [
+ *       { dataIndex: 'id', fixed: false, visible: true },
+ *       { dataIndex: 'name', fixed: false, visible: true },
+ *       { dataIndex: 'role', fixed: false, visible: true }
+ *     ],
+ *     tableSize: 'middle',
+ *     condition: { role: 'admin' },
+ *     pageSize: 10,
+ *     sortId: 3
+ *   }
+ * ];
+ *
+ * function ViewSelector() {
+ *   const [activeView, setActiveView] = useState(views[0]);
+ *
+ *   const handleViewChange = (view: View) => {
+ *     setActiveView(view);
+ *     // Update table data, filters, etc. based on new view
+ *     console.log('Switched to view:', view.name);
+ *   };
+ *
+ *   return (
+ *     <ViewItemGroup
+ *       views={views}
+ *       activeView={activeView}
+ *       countUrl="/api/users/count"
+ *       onViewChange={handleViewChange}
+ *     />
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // Integration with data fetching
+ * function ViewPanel({ views, onViewSelect }) {
+ *   return (
+ *     <div className="view-panel">
+ *       <h3>Available Views</h3>
+ *       <ViewItemGroup
+ *         views={views}
+ *         activeView={views.find(v => v.isDefault) || views[0]}
+ *         countUrl="/api/records/count"
+ *         onViewChange={(view) => {
+ *           onViewSelect(view);
+ *           // Could trigger data refetch with new view's condition
+ *         }}
+ *       />
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
 export declare function ViewItemGroup(props: ViewItemGroupProps): import("react/jsx-runtime").JSX.Element;
 //# sourceMappingURL=ViewItemGroup.d.ts.map

package/dist/viewer/panel/ViewItemGroup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ViewItemGroup.d.ts","sourceRoot":"","sources":["../../../src/viewer/panel/ViewItemGroup.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAIhC,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,UAAU,EAAE,IAAI,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;CACpC;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,kBAAkB,2CAgBtD"}
+{"version":3,"file":"ViewItemGroup.d.ts","sourceRoot":"","sources":["../../../src/viewer/panel/ViewItemGroup.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAIhC;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,2DAA2D;IAC3D,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,yCAAyC;IACzC,UAAU,EAAE,IAAI,CAAC;IACjB,gEAAgE;IAChE,QAAQ,EAAE,MAAM,CAAC;IACjB,+DAA+D;IAC/D,YAAY,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;CACpC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiHG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,kBAAkB,2CAoBtD"}

package/dist/viewer/panel/ViewPanel.d.ts

@@ -1,12 +1,158 @@
 import { View } from '../types';
+/**
+ * Props for the ViewPanel component.
+ *
+ * @interface ViewPanelProps
+ */
 export interface ViewPanelProps {
+    /** Name of the aggregate/entity being viewed (displayed as panel title) */
     aggregateName: string;
+    /** Array of all available views (both personal and public) */
     views: View[];
+    /** The currently active/selected view */
     activeView: View;
+    /** API endpoint URL for fetching record counts for views */
     countUrl: string;
+    /** Callback function called when user selects a different view */
     onViewChange: (view: View) => void;
+    /** Whether the view panel is currently visible (used for fold/unfold logic) */
     showViewPanel: boolean;
+    /** Callback function called when user clicks the fold/unfold button */
     onViewPanelFold: () => void;
 }
+/**
+ * ViewPanel Component
+ *
+ * A comprehensive panel component that organizes and displays data views in a collapsible,
+ * categorized interface. Views are separated into "Personal" (个人) and "Public" (公共)
+ * sections, allowing users to easily manage their own views while accessing shared ones.
+ * The panel includes a header with the aggregate name and a fold/unfold control.
+ *
+ * @param props - The properties for configuring the view panel
+ * @param props.aggregateName - Display name for the data entity being viewed
+ * @param props.views - Complete array of available views (mixed personal/public)
+ * @param props.activeView - Currently selected view for highlighting
+ * @param props.countUrl - API endpoint for fetching view record counts
+ * @param props.onViewChange - Callback when user selects a different view
+ * @param props.showViewPanel - Current visibility state of the panel
+ * @param props.onViewPanelFold - Callback when user toggles panel visibility
+ *
+ * @example
+ * ```tsx
+ * import { ViewPanel } from './ViewPanel';
+ * import type { View } from '../types';
+ *
+ * const userViews: View[] = [
+ *   {
+ *     id: 'personal-1',
+ *     name: 'My Active Users',
+ *     viewType: 'PERSONAL',
+ *     viewSource: 'CUSTOM',
+ *     isDefault: false,
+ *     filters: [],
+ *     columns: [
+ *       { dataIndex: 'id', fixed: false, visible: true },
+ *       { dataIndex: 'name', fixed: false, visible: true },
+ *       { dataIndex: 'status', fixed: false, visible: true }
+ *     ],
+ *     tableSize: 'middle',
+ *     condition: { status: 'active' },
+ *     pageSize: 20,
+ *     sortId: 1
+ *   },
+ *   {
+ *     id: 'public-1',
+ *     name: 'All Team Members',
+ *     viewType: 'SHARED',
+ *     viewSource: 'CUSTOM',
+ *     isDefault: true,
+ *     filters: [],
+ *     columns: [
+ *       { dataIndex: 'id', fixed: false, visible: true },
+ *       { dataIndex: 'name', fixed: false, visible: true },
+ *       { dataIndex: 'department', fixed: false, visible: true }
+ *     ],
+ *     tableSize: 'middle',
+ *     condition: {},
+ *     pageSize: 25,
+ *     sortId: 2
+ *   },
+ *   {
+ *     id: 'system-1',
+ *     name: 'Admin Users',
+ *     viewType: 'SHARED',
+ *     viewSource: 'SYSTEM',
+ *     isDefault: false,
+ *     filters: [],
+ *     columns: [
+ *       { dataIndex: 'id', fixed: false, visible: true },
+ *       { dataIndex: 'name', fixed: false, visible: true },
+ *       { dataIndex: 'role', fixed: false, visible: true }
+ *     ],
+ *     tableSize: 'middle',
+ *     condition: { role: 'admin' },
+ *     pageSize: 10,
+ *     sortId: 3
+ *   }
+ * ];
+ *
+ * function DataViewer() {
+ *   const [activeView, setActiveView] = useState(userViews[1]); // Default to public view
+ *   const [showPanel, setShowPanel] = useState(true);
+ *
+ *   const handleViewChange = (view: View) => {
+ *     setActiveView(view);
+ *     // Update table data, filters, sorting based on new view
+ *     console.log('Switched to view:', view.name);
+ *   };
+ *
+ *   const handlePanelToggle = () => {
+ *     setShowPanel(!showPanel);
+ *   };
+ *
+ *   return (
+ *     <div className="data-viewer">
+ *       <ViewPanel
+ *         aggregateName="用户管理" // "User Management" in Chinese
+ *         views={userViews}
+ *         activeView={activeView}
+ *         countUrl="/api/users/count"
+ *         onViewChange={handleViewChange}
+ *         showViewPanel={showPanel}
+ *         onViewPanelFold={handlePanelToggle}
+ *       />
+ *     </div>
+ *   );
+ * }
+ *     </div>
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // Integration with routing and URL state
+ * function RoutedViewPanel({ views, currentViewId }) {
+ *   const activeView = views.find(v => v.id === currentViewId) || views[0];
+ *
+ *   const handleViewChange = (view: View) => {
+ *     // Update URL with new view ID
+ *     navigate(`/data?view=${view.id}`);
+ *   };
+ *
+ *   return (
+ *     <ViewPanel
+ *       aggregateName="数据视图"
+ *       views={views}
+ *       activeView={activeView}
+ *       countUrl="/api/records/count"
+ *       onViewChange={handleViewChange}
+ *       showViewPanel={true}
+ *       onViewPanelFold={() => handlePanelToggle()}
+ *     />
+ *   );
+ * }
+ * ```
+ */
 export declare function ViewPanel(props: ViewPanelProps): import("react/jsx-runtime").JSX.Element;
 //# sourceMappingURL=ViewPanel.d.ts.map

package/dist/viewer/panel/ViewPanel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ViewPanel.d.ts","sourceRoot":"","sources":["../../../src/viewer/panel/ViewPanel.tsx"],"names":[],"mappings":"AAGA,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAKhC,MAAM,WAAW,cAAc;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,UAAU,EAAE,IAAI,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;IAEnC,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,EAAE,MAAM,IAAI,CAAC;CAC7B;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,cAAc,2CAiD9C"}
+{"version":3,"file":"ViewPanel.d.ts","sourceRoot":"","sources":["../../../src/viewer/panel/ViewPanel.tsx"],"names":[],"mappings":"AAGA,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAKhC;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,2EAA2E;IAC3E,aAAa,EAAE,MAAM,CAAC;IACtB,8DAA8D;IAC9D,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,yCAAyC;IACzC,UAAU,EAAE,IAAI,CAAC;IACjB,4DAA4D;IAC5D,QAAQ,EAAE,MAAM,CAAC;IACjB,kEAAkE;IAClE,YAAY,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;IAEnC,+EAA+E;IAC/E,aAAa,EAAE,OAAO,CAAC;IACvB,uEAAuE;IACvE,eAAe,EAAE,MAAM,IAAI,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqIG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,cAAc,2CAkE9C"}

package/dist/viewer/types.d.ts

@@ -3,34 +3,34 @@ import { TypeCapable } from '../registry';
 import { AttributesCapable } from '../types';
 import { SortOrder } from 'antd/es/table/interface';
 import { SizeType } from 'antd/es/config-provider/SizeContext';
-import { Condition, FieldSort } from '@ahoo-wang/fetcher-wow';
+import { Condition, FieldSort, PagedQuery } from '@ahoo-wang/fetcher-wow';
 import { default as React } from 'react';
 import { ButtonProps } from 'antd';
+import { NamedCapable } from '@ahoo-wang/fetcher';
 export interface ViewDefinition {
     name: string;
-    columns: ViewColumnDefinition[];
+    fields: ViewColumnDefinition[];
     availableFilters: AvailableFilterGroup[];
-    dataSourceUrl: string;
+    dataUrl: string;
     countUrl: string;
     internalCondition?: Condition;
     checkable?: boolean;
 }
-export interface ViewColumnDefinition extends TypeCapable, AttributesCapable {
-    title: string;
-    dataIndex: string;
+export interface ViewColumnDefinition extends NamedCapable, TypeCapable, AttributesCapable {
+    label: string;
     primaryKey: boolean;
     render?: (value: any, record: any, index: number) => React.ReactNode;
     sorter: boolean | {
         multiple: number;
     };
 }
-export type ViewType = 'PERSONAL' | 'PUBLIC';
+export type ViewType = 'PERSONAL' | 'SHARED';
 export type ViewSource = 'SYSTEM' | 'CUSTOM';
 export interface View {
     id: string;
     name: string;
-    viewType: ViewType;
-    viewSource: ViewSource;
+    type: ViewType;
+    source: ViewSource;
     isDefault: boolean;
     filters: ActiveFilter[];
     columns: ViewColumn[];
@@ -39,9 +39,9 @@ export interface View {
     pageSize: number;
     sort?: FieldSort[];
     sortId: number;
+    pagedQuery: PagedQuery;
 }
-export interface ViewColumn {
-    dataIndex: string;
+export interface ViewColumn extends NamedCapable {
     fixed: boolean;
     visible: boolean;
     width?: string;

package/dist/viewer/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/viewer/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,qCAAqC,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AAEnC,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAChC,gBAAgB,EAAE,oBAAoB,EAAE,CAAC;IACzC,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,SAAS,CAAC;IAC9B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,oBAAqB,SAAQ,WAAW,EAAE,iBAAiB;IAC1E,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,KAAK,KAAK,CAAC,SAAS,CAAC;IACrE,MAAM,EAAE,OAAO,GAAG;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;CACxC;AAED,MAAM,MAAM,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;AAC7C,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAE7C,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;IACvB,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,SAAS,EAAE,QAAQ,CAAC;IACpB,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED,MAAM,WAAW,gBAAgB,CAAC,UAAU,CAAE,SAAQ,iBAAiB,CACrE,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,CAC7B;IACC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,IAAI,CAAC;IACxC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,KAAK,CAAC,SAAS,CAAC;CACnD"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/viewer/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,qCAAqC,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAC1E,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,oBAAoB,EAAE,CAAC;IAC/B,gBAAgB,EAAE,oBAAoB,EAAE,CAAC;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,SAAS,CAAC;IAC9B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,oBACf,SAAQ,YAAY,EAAE,WAAW,EAAE,iBAAiB;IACpD,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,KAAK,KAAK,CAAC,SAAS,CAAC;IACrE,MAAM,EAAE,OAAO,GAAG;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;CACxC;AAED,MAAM,MAAM,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;AAC7C,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAE7C,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE,UAAU,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,SAAS,EAAE,QAAQ,CAAC;IACpB,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC9C,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED,MAAM,WAAW,gBAAgB,CAAC,UAAU,CAAE,SAAQ,iBAAiB,CACrE,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,CAC7B;IACC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,IAAI,CAAC;IACxC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,KAAK,CAAC,SAAS,CAAC;CACnD"}

package/dist/viewer/useFilterStateReducer.d.ts

@@ -1,21 +1,172 @@
-import { ActiveFilter } from '../filter';
+import { ActiveFilter } from '../filter/panel';
 import { ReducerActionCapable } from '../types';
 import { Condition } from '@ahoo-wang/fetcher-wow';
+/**
+ * Filter State Interface
+ *
+ * Represents the complete state of the filter system including active filters,
+ * query conditions, and UI panel visibility.
+ */
 export interface FilterState {
+    /** Array of currently active filters applied to the data */
     activeFilters: ActiveFilter[];
+    /** Query condition object used for data filtering */
     queryCondition: Condition;
+    /** Whether the filter panel is currently visible */
     showFilterPanel: boolean;
 }
+/**
+ * Filter State Reducer Action Types
+ *
+ * Defines the available actions that can be dispatched to update filter state.
+ */
 export type FilterStateReducerActionType = 'UPDATE_ACTIVE_FILTERS' | 'UPDATE_SHOW_FILTER_PANEL' | 'UPDATE_QUERY_CONDITION';
+/**
+ * Filter State Reducer Action Interface
+ *
+ * Extends the base reducer action interface with filter-specific action types.
+ */
 export interface FilterStateReducerAction extends ReducerActionCapable<FilterStateReducerActionType> {
 }
+/**
+ * Filter State Reducer Return Interface
+ *
+ * Defines the return type of the useFilterStateReducer hook, providing
+ * access to current state and state update functions.
+ */
 export interface FilterStateReducerReturn {
+    /** Current array of active filters */
     activeFilters: ActiveFilter[];
+    /** Current filter panel visibility state */
     showFilterPanel: boolean;
+    /** Current query condition for data filtering */
     queryCondition: Condition;
+    /** Function to update the active filters array */
     updateActiveFilters: (activeFilters: ActiveFilter[]) => void;
+    /** Function to show/hide the filter panel */
     updateShowFilterPanel: (showFilterPanel: boolean) => void;
+    /** Function to update the query condition */
     updateQueryCondition: (condition: Condition) => void;
 }
+/**
+ * Filter State Reducer Hook
+ *
+ * Custom React hook that provides filter state management using useReducer.
+ * Manages active filters, query conditions, and filter panel visibility with
+ * optimized callback functions for performance.
+ *
+ * @param state - Initial filter state configuration
+ * @param state.activeFilters - Initial array of active filters
+ * @param state.queryCondition - Initial query condition
+ * @param state.showFilterPanel - Initial filter panel visibility
+ * @returns Filter state management interface with current state and update functions
+ *
+ * @example
+ * ```tsx
+ * import { useFilterStateReducer } from './useFilterStateReducer';
+ * import type { ActiveFilter } from '../filter';
+ * import type { Condition } from '@ahoo-wang/fetcher-wow';
+ *
+ * function FilterableComponent() {
+ *   const filterState = useFilterStateReducer({
+ *     activeFilters: [],
+ *     queryCondition: {},
+ *     showFilterPanel: false
+ *   });
+ *
+ *   const {
+ *     activeFilters,
+ *     showFilterPanel,
+ *     queryCondition,
+ *     updateActiveFilters,
+ *     updateShowFilterPanel,
+ *     updateQueryCondition
+ *   } = filterState;
+ *
+ *   const handleAddFilter = (newFilter: ActiveFilter) => {
+ *     updateActiveFilters([...activeFilters, newFilter]);
+ *   };
+ *
+ *   const handleTogglePanel = () => {
+ *     updateShowFilterPanel(!showFilterPanel);
+ *   };
+ *
+ *   const handleConditionChange = (newCondition: Condition) => {
+ *     updateQueryCondition(newCondition);
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       <button onClick={handleTogglePanel}>
+ *         {showFilterPanel ? 'Hide' : 'Show'} Filters
+ *       </button>
+ *       <FilterPanel
+ *         filters={activeFilters}
+ *         onChange={updateActiveFilters}
+ *         visible={showFilterPanel}
+ *       />
+ *       <DataTable
+ *         condition={queryCondition}
+ *         onConditionChange={handleConditionChange}
+ *       />
+ *     </div>
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // Integration with Viewer component
+ * function DataViewer({ viewDefinition }) {
+ *   const filterState = useFilterStateReducer({
+ *     activeFilters: viewDefinition.filters || [],
+ *     queryCondition: viewDefinition.condition || {},
+ *     showFilterPanel: false
+ *   });
+ *
+ *   // Use filter state in Viewer
+ *   return (
+ *     <FilterStateContextProvider {...filterState}>
+ *       <Viewer definition={viewDefinition} />
+ *     </FilterStateContextProvider>
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // Advanced filter management
+ * function AdvancedFilterManager() {
+ *   const filterState = useFilterStateReducer({
+ *     activeFilters: [],
+ *     queryCondition: {},
+ *     showFilterPanel: true
+ *   });
+ *
+ *   const clearAllFilters = useCallback(() => {
+ *     filterState.updateActiveFilters([]);
+ *     filterState.updateQueryCondition({});
+ *   }, [filterState]);
+ *
+ *   const hasActiveFilters = filterState.activeFilters.length > 0;
+ *
+ *   return (
+ *     <div>
+ *       <FilterControls
+ *         filters={filterState.activeFilters}
+ *         onChange={filterState.updateActiveFilters}
+ *         visible={filterState.showFilterPanel}
+ *         onToggle={filterState.updateShowFilterPanel}
+ *       />
+ *       {hasActiveFilters && (
+ *         <button onClick={clearAllFilters}>
+ *           Clear All Filters ({filterState.activeFilters.length})
+ *         </button>
+ *       )}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
 export declare function useFilterStateReducer(state: FilterState): FilterStateReducerReturn;
 //# sourceMappingURL=useFilterStateReducer.d.ts.map

package/dist/viewer/useFilterStateReducer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useFilterStateReducer.d.ts","sourceRoot":"","sources":["../../src/viewer/useFilterStateReducer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAEhD,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAEnD,MAAM,WAAW,WAAW;IAC1B,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,cAAc,EAAE,SAAS,CAAC;IAC1B,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,MAAM,4BAA4B,GACpC,uBAAuB,GACvB,0BAA0B,GAC1B,wBAAwB,CAAC;AAE7B,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB,CAAC,4BAA4B,CAAC;CAAG;AAEvG,MAAM,WAAW,wBAAwB;IACvC,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,eAAe,EAAE,OAAO,CAAC;IACzB,cAAc,EAAE,SAAS,CAAC;IAC1B,mBAAmB,EAAE,CAAC,aAAa,EAAE,YAAY,EAAE,KAAK,IAAI,CAAC;IAC7D,qBAAqB,EAAE,CAAC,eAAe,EAAE,OAAO,KAAK,IAAI,CAAC;IAC1D,oBAAoB,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,IAAI,CAAC;CACtD;AAkBD,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,WAAW,GACjB,wBAAwB,CA0B1B"}
+{"version":3,"file":"useFilterStateReducer.d.ts","sourceRoot":"","sources":["../../src/viewer/useFilterStateReducer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAEhD,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAEnD;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,4DAA4D;IAC5D,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,qDAAqD;IACrD,cAAc,EAAE,SAAS,CAAC;IAC1B,oDAAoD;IACpD,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GACpC,uBAAuB,GACvB,0BAA0B,GAC1B,wBAAwB,CAAC;AAE7B;;;;GAIG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB,CAAC,4BAA4B,CAAC;CAAG;AAEvG;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC,sCAAsC;IACtC,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,4CAA4C;IAC5C,eAAe,EAAE,OAAO,CAAC;IACzB,iDAAiD;IACjD,cAAc,EAAE,SAAS,CAAC;IAC1B,kDAAkD;IAClD,mBAAmB,EAAE,CAAC,aAAa,EAAE,YAAY,EAAE,KAAK,IAAI,CAAC;IAC7D,6CAA6C;IAC7C,qBAAqB,EAAE,CAAC,eAAe,EAAE,OAAO,KAAK,IAAI,CAAC;IAC1D,6CAA6C;IAC7C,oBAAoB,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,IAAI,CAAC;CACtD;AA4BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuHG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,WAAW,GACjB,wBAAwB,CAuD1B"}