@ahoo-wang/fetcher-viewer 3.8.9 → 3.9.2

package/dist/viewer/useTableStateReducer.d.ts

@@ -1,18 +1,181 @@
 import { ViewColumn } from './types';
 import { ReducerActionCapable } from '../types';
 import { SizeType } from 'antd/es/config-provider/SizeContext';
+/**
+ * Table State Interface
+ *
+ * Represents the complete state of the table system including column configurations
+ * and table sizing preferences.
+ */
 export interface TableState {
+    /** Array of column configurations with visibility, width, and positioning */
     columns: ViewColumn[];
+    /** Table size preference (small, middle, large) following Ant Design conventions */
     tableSize: SizeType;
 }
+/**
+ * Table State Reducer Action Types
+ *
+ * Defines the available actions that can be dispatched to update table state.
+ */
 export type TableStateReducerActionType = 'UPDATE_COLUMNS' | 'UPDATE_TABLE_SIZE';
+/**
+ * Table State Reducer Action Interface
+ *
+ * Extends the base reducer action interface with table-specific action types.
+ */
 export interface TableStateReducerAction extends ReducerActionCapable<TableStateReducerActionType> {
 }
+/**
+ * Table State Reducer Return Interface
+ *
+ * Defines the return type of the useTableStateReducer hook, providing
+ * access to current state and state update functions.
+ */
 export interface UseTableStateReducerReturn {
+    /** Current array of column configurations */
     columns: ViewColumn[];
+    /** Current table size setting */
     tableSize: SizeType;
+    /** Function to update the columns configuration array */
     updateColumns: (columns: ViewColumn[]) => void;
+    /** Function to change the table size */
     updateTableSize: (tableSize: SizeType) => void;
 }
+/**
+ * Table State Reducer Hook
+ *
+ * Custom React hook that provides table state management using useReducer.
+ * Manages column configurations and table sizing with optimized callback functions
+ * for performance and prevents unnecessary re-renders.
+ *
+ * @param state - Initial table state configuration
+ * @param state.columns - Initial array of column configurations
+ * @param state.tableSize - Initial table size preference
+ * @returns Table state management interface with current state and update functions
+ *
+ * @example
+ * ```tsx
+ * import { useTableStateReducer } from './useTableStateReducer';
+ * import type { ViewColumn } from './types';
+ * import type { SizeType } from 'antd/es/config-provider/SizeContext';
+ *
+ * function TableManager() {
+ *   const tableState = useTableStateReducer({
+ *     columns: [
+ *       { dataIndex: 'id', fixed: false, visible: true, width: '100px' },
+ *       { dataIndex: 'name', fixed: false, visible: true, width: '200px' },
+ *       { dataIndex: 'email', fixed: false, visible: false }
+ *     ],
+ *     tableSize: 'middle'
+ *   });
+ *
+ *   const {
+ *     columns,
+ *     tableSize,
+ *     updateColumns,
+ *     updateTableSize
+ *   } = tableState;
+ *
+ *   const handleColumnVisibilityChange = (columnId: string, visible: boolean) => {
+ *     const updatedColumns = columns.map(col =>
+ *       col.dataIndex === columnId
+ *         ? { ...col, visible }
+ *         : col
+ *     );
+ *     updateColumns(updatedColumns);
+ *   };
+ *
+ *   const handleSizeChange = (newSize: SizeType) => {
+ *     updateTableSize(newSize);
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       <TableSizeSelector
+ *         currentSize={tableSize}
+ *         onChange={handleSizeChange}
+ *       />
+ *       <ColumnManager
+ *         columns={columns}
+ *         onVisibilityChange={handleColumnVisibilityChange}
+ *       />
+ *       <ViewTable
+ *         columns={columns}
+ *         tableSize={tableSize}
+ *       />
+ *     </div>
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // Integration with Viewer component
+ * function DataViewer({ viewDefinition }) {
+ *   const tableState = useTableStateReducer({
+ *     columns: viewDefinition.columns,
+ *     tableSize: viewDefinition.tableSize || 'middle'
+ *   });
+ *
+ *   // Use table state in Viewer
+ *   return (
+ *     <TableStateContextProvider
+ *       columns={tableState.columns}
+ *       tableSize={tableState.tableSize}
+ *       updateColumns={tableState.updateColumns}
+ *       updateTableSize={tableState.updateTableSize}
+ *       refreshData={() => handleRefresh()}
+ *     >
+ *       <Viewer definition={viewDefinition} />
+ *     </TableStateContextProvider>
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // Advanced column management
+ * function AdvancedTableController() {
+ *   const tableState = useTableStateReducer({
+ *     columns: [],
+ *     tableSize: 'middle'
+ *   });
+ *
+ *   const addColumn = useCallback((newColumn: ViewColumn) => {
+ *     tableState.updateColumns([...tableState.columns, newColumn]);
+ *   }, [tableState]);
+ *
+ *   const removeColumn = useCallback((columnId: string) => {
+ *     const filteredColumns = tableState.columns.filter(
+ *       col => col.dataIndex !== columnId
+ *     );
+ *     tableState.updateColumns(filteredColumns);
+ *   }, [tableState]);
+ *
+ *   const reorderColumns = useCallback((fromIndex: number, toIndex: number) => {
+ *     const newColumns = [...tableState.columns];
+ *     const [movedColumn] = newColumns.splice(fromIndex, 1);
+ *     newColumns.splice(toIndex, 0, movedColumn);
+ *     tableState.updateColumns(newColumns);
+ *   }, [tableState]);
+ *
+ *   return (
+ *     <div>
+ *       <ColumnList
+ *         columns={tableState.columns}
+ *         onAdd={addColumn}
+ *         onRemove={removeColumn}
+ *         onReorder={reorderColumns}
+ *       />
+ *       <TableSizeControls
+ *         size={tableState.tableSize}
+ *         onChange={tableState.updateTableSize}
+ *       />
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
 export declare function useTableStateReducer(state: TableState): UseTableStateReducerReturn;
 //# sourceMappingURL=useTableStateReducer.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"useTableStateReducer.d.ts","sourceRoot":"","sources":["../../src/viewer/useTableStateReducer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAEhD,OAAO,EAAE,QAAQ,EAAE,MAAM,qCAAqC,CAAC;AAE/D,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,SAAS,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,MAAM,2BAA2B,GACnC,gBAAgB,GAChB,mBAAmB,CAAC;AAExB,MAAM,WAAW,uBAAwB,SAAQ,oBAAoB,CAAC,2BAA2B,CAAC;CAAG;AAErG,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,SAAS,EAAE,QAAQ,CAAC;IACpB,aAAa,EAAE,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,IAAI,CAAC;IAC/C,eAAe,EAAE,CAAC,SAAS,EAAE,QAAQ,KAAK,IAAI,CAAC;CAChD;AAgBD,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,UAAU,GAChB,0BAA0B,CAoB5B"}
+{"version":3,"file":"useTableStateReducer.d.ts","sourceRoot":"","sources":["../../src/viewer/useTableStateReducer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAEhD,OAAO,EAAE,QAAQ,EAAE,MAAM,qCAAqC,CAAC;AAE/D;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,6EAA6E;IAC7E,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,oFAAoF;IACpF,SAAS,EAAE,QAAQ,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GACnC,gBAAgB,GAChB,mBAAmB,CAAC;AAExB;;;;GAIG;AACH,MAAM,WAAW,uBAAwB,SAAQ,oBAAoB,CAAC,2BAA2B,CAAC;CAAG;AAErG;;;;;GAKG;AACH,MAAM,WAAW,0BAA0B;IACzC,6CAA6C;IAC7C,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,iCAAiC;IACjC,SAAS,EAAE,QAAQ,CAAC;IACpB,yDAAyD;IACzD,aAAa,EAAE,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,IAAI,CAAC;IAC/C,wCAAwC;IACxC,eAAe,EAAE,CAAC,SAAS,EAAE,QAAQ,KAAK,IAAI,CAAC;CAChD;AA0BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsIG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,UAAU,GAChB,0BAA0B,CA2C5B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahoo-wang/fetcher-viewer",
-  "version": "3.8.9",
+  "version": "3.9.2",
   "description": "A comprehensive React component library for API documentation viewing and data filtering, built on top of Ant Design and the Fetcher ecosystem. Provides reusable UI components for building rich data-driven applications with advanced filtering capabilities and remote data selection.",
   "keywords": [
     "react",

package/dist/viewer/ViewerSharedValueContext.d.ts

@@ -1,17 +0,0 @@
-import { ReactNode } from 'react';
-import { View } from './types';
-export interface ViewerSharedValue {
-    aggregateName: string;
-    view: View;
-    showFilterPanel: boolean;
-    setShowFilterPanel: (showFilterPanel: boolean) => void;
-    refreshData: () => void;
-}
-export type ViewerSharedValueContext = ViewerSharedValue;
-export declare const ViewerSharedValueContext: import('react').Context<ViewerSharedValue | undefined>;
-export interface ViewerSharedValueOptions extends ViewerSharedValue {
-    children: ReactNode;
-}
-export declare function ViewerSharedValueProvider({ children, ...options }: ViewerSharedValueOptions): import("react/jsx-runtime").JSX.Element;
-export declare function useViewerSharedValue(): ViewerSharedValueContext;
-//# sourceMappingURL=ViewerSharedValueContext.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"ViewerSharedValueContext.d.ts","sourceRoot":"","sources":["../../src/viewer/ViewerSharedValueContext.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAiB,SAAS,EAAc,MAAM,OAAO,CAAC;AAC7D,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAE/B,MAAM,WAAW,iBAAiB;IAChC,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,IAAI,CAAC;IAEX,eAAe,EAAE,OAAO,CAAC;IACzB,kBAAkB,EAAE,CAAC,eAAe,EAAE,OAAO,KAAK,IAAI,CAAC;IAEvD,WAAW,EAAE,MAAM,IAAI,CAAC;CACzB;AAED,MAAM,MAAM,wBAAwB,GAAG,iBAAiB,CAAC;AAEzD,eAAO,MAAM,wBAAwB,wDAEzB,CAAC;AAEb,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IACjE,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,wBAAgB,yBAAyB,CAAC,EACxC,QAAQ,EACR,GAAG,OAAO,EACX,EAAE,wBAAwB,2CAM1B;AAED,wBAAgB,oBAAoB,IAAI,wBAAwB,CAM/D"}