@vef-framework-react/starter 2.1.4 → 2.1.5

package/dist/types/components/pro-table/components/column-setting-item.d.ts

@@ -1,12 +0,0 @@
-import { Key } from '@vef-framework-react/shared';
-import { ReactNode, NamedExoticComponent } from 'react';
-interface ColumnSettingItemProps {
-    columnId: Key;
-    title: ReactNode;
-    fixed?: "start" | "end" | false;
-    width?: number;
-    visible: boolean;
-    index: number;
-}
-export declare const ColumnSettingItem: NamedExoticComponent<ColumnSettingItemProps>;
-export {};

package/dist/types/components/pro-table/components/column-settings-panel.d.ts

@@ -1,2 +0,0 @@
-import { MemoExoticComponent } from 'react';
-export declare const ColumnSettingsPanel: MemoExoticComponent<() => import("@emotion/react/jsx-runtime").JSX.Element>;

package/dist/types/components/pro-table/components/column-settings.d.ts

@@ -1,6 +0,0 @@
-import { NamedExoticComponent } from 'react';
-interface ColumnSettingsProps {
-    className?: string;
-}
-export declare const ColumnSettings: NamedExoticComponent<ColumnSettingsProps>;
-export {};

package/dist/types/components/pro-table/components/index.d.ts

@@ -1,8 +0,0 @@
-export { ColumnSettingItem } from './column-setting-item';
-export { ColumnSettings } from './column-settings';
-export { ColumnSettingsPanel } from './column-settings-panel';
-export { OperationButtonGroup, type OperationButtonGroupProps } from './operation-button-group';
-export { ProTableRefHolder } from './ref';
-export { NonPaginatedTable, PaginatedTable } from './table';
-export { TableSubscriber, type TableSubscriberProps } from './table-subscriber';
-export { WidthPopover } from './width-popover';

package/dist/types/components/pro-table/components/operation-button-group.d.ts

@@ -1,7 +0,0 @@
-import { FC, ReactNode } from 'react';
-import { ProTableState } from '../store';
-export interface OperationButtonGroupProps<TSelected = NoInfer<ProTableState>> {
-    selector?: (state: NoInfer<ProTableState>) => TSelected;
-    children: ((state: NoInfer<TSelected>) => ReactNode) | ReactNode;
-}
-export declare const OperationButtonGroup: (<TSelected = NoInfer<ProTableState>>(props: OperationButtonGroupProps<TSelected>) => ReactNode) & Pick<FC, "displayName">;

package/dist/types/components/pro-table/components/ref.d.ts

@@ -1,3 +0,0 @@
-import { PropsWithRef } from '@vef-framework-react/components';
-import { ProTableRef } from '../types';
-export declare function ProTableRefHolder({ ref }: PropsWithRef<ProTableRef>): null;

package/dist/types/components/pro-table/components/table-subscriber.d.ts

@@ -1,9 +0,0 @@
-import { FC, ReactNode } from 'react';
-import { ProTableState } from '../store';
-export interface TableSubscriberProps<TSelected = NoInfer<ProTableState>, TRow = unknown> {
-    selector?: (state: NoInfer<ProTableState> & {
-        data: readonly TRow[];
-    }) => TSelected;
-    children: ((state: NoInfer<TSelected>) => ReactNode) | ReactNode;
-}
-export declare const TableSubscriber: (<TSelected = NoInfer<ProTableState>>(props: TableSubscriberProps<TSelected>) => ReactNode) & Pick<FC, "displayName">;

package/dist/types/components/pro-table/components/table-summary.d.ts

@@ -1,7 +0,0 @@
-import { ReactNode, NamedExoticComponent } from 'react';
-interface TableSummaryProps {
-    summary: ReactNode;
-    data: readonly unknown[];
-}
-export declare const TableSummary: NamedExoticComponent<TableSummaryProps>;
-export {};

package/dist/types/components/pro-table/components/table-title.d.ts

@@ -1,7 +0,0 @@
-import { ReactNode, NamedExoticComponent } from 'react';
-interface TableTitleProps {
-    title: ReactNode;
-    data: readonly unknown[];
-}
-export declare const TableTitle: NamedExoticComponent<TableTitleProps>;
-export {};

package/dist/types/components/pro-table/components/table.d.ts

@@ -1,12 +0,0 @@
-import { AnyObject } from '@vef-framework-react/shared';
-import { NonPaginatedProTableProps, PaginatedProTableProps } from '../props';
-import { ColumnSettingsProp } from '../types';
-type PaginatedTableProps<TRow extends AnyObject, TParams extends AnyObject> = Pick<PaginatedProTableProps<TRow, TParams>, "className" | "style" | "size" | "queryFn" | "queryEnabled" | "queryParams" | "columns" | "rowKey" | "rowSelection" | "showSequenceColumn" | "operationColumn" | "selectedRowKeys" | "virtual" | "title" | "summary" | "onSelectedRowKeysChange"> & {
-    columnSettings: ColumnSettingsProp;
-};
-type NonPaginatedTableProps<TRow extends AnyObject, TParams extends AnyObject> = Pick<NonPaginatedProTableProps<TRow, TParams>, "className" | "style" | "size" | "queryFn" | "queryEnabled" | "queryParams" | "columns" | "rowKey" | "rowSelection" | "showSequenceColumn" | "operationColumn" | "selectedRowKeys" | "virtual" | "title" | "summary" | "onSelectedRowKeysChange"> & {
-    columnSettings: ColumnSettingsProp;
-};
-export declare function PaginatedTable<TRow extends AnyObject, TParams extends AnyObject>({ className, style, size, queryFn, columns, columnSettings, rowKey, rowSelection, queryEnabled, queryParams, showSequenceColumn, operationColumn, selectedRowKeys, virtual, title, summary, onSelectedRowKeysChange }: PaginatedTableProps<TRow, TParams>): import("@emotion/react/jsx-runtime").JSX.Element;
-export declare function NonPaginatedTable<TRow extends AnyObject, TParams extends AnyObject>({ className, style, size, queryFn, columns, columnSettings, rowKey, rowSelection, queryEnabled, queryParams, showSequenceColumn, operationColumn, selectedRowKeys, virtual, title, summary, onSelectedRowKeysChange }: NonPaginatedTableProps<TRow, TParams>): import("@emotion/react/jsx-runtime").JSX.Element;
-export {};

package/dist/types/components/pro-table/components/width-popover.d.ts

@@ -1,9 +0,0 @@
-import { ReactNode, NamedExoticComponent } from 'react';
-interface WidthPopoverProps {
-    currentWidth?: number;
-    disabled?: boolean;
-    children: ReactNode;
-    onWidthChange: (width: number) => void;
-}
-export declare const WidthPopover: NamedExoticComponent<WidthPopoverProps>;
-export {};

package/dist/types/components/pro-table/context.d.ts

@@ -1,5 +0,0 @@
-import { Provider } from 'react';
-export declare const DataProvider: Provider<readonly unknown[]>;
-export declare function useData(): readonly unknown[];
-export declare const ColumnSettingsStorageKeyProvider: Provider<string | undefined>;
-export declare function useColumnSettingsStorageKey(): string | undefined;

package/dist/types/components/pro-table/event.d.ts

@@ -1,16 +0,0 @@
-import { EventEmitter } from '@vef-framework-react/shared';
-export type ProTableEvents = {
-    /**
-     * Trigger table data refetch
-     */
-    refetch: void;
-    /**
-     * Emitted when table starts loading data
-     */
-    loading: void;
-    /**
-     * Emitted when table finishes loading data
-     */
-    loaded: void;
-};
-export declare function createEventEmitter(): EventEmitter<ProTableEvents>;

package/dist/types/components/pro-table/hooks/index.d.ts

@@ -1,3 +0,0 @@
-export { clearColumnSettingsStorage, useColumnSettingsPersistence } from './use-column-settings-persistence';
-export { useRowSelection } from './use-row-selection';
-export { useTableColumns } from './use-table-columns';

package/dist/types/components/pro-table/hooks/use-column-settings-persistence.d.ts

@@ -1,7 +0,0 @@
-export declare function clearColumnSettingsStorage(storageKey: string): {
-    skipNextSave: () => void;
-};
-/**
- * Hook to handle column settings persistence to localStorage
- */
-export declare function useColumnSettingsPersistence(storageKey: string | undefined): void;

package/dist/types/components/pro-table/hooks/use-row-selection.d.ts

@@ -1,7 +0,0 @@
-import { TableRowSelection } from '@vef-framework-react/components';
-import { Key } from '@vef-framework-react/shared';
-import { RowSelectionConfig } from '../types';
-/**
- * Hook to create row selection configuration for ProTable.
- */
-export declare function useRowSelection<TRow>(config: RowSelectionConfig<TRow> | true | undefined, selectedRowKeys?: Key[], onSelectedRowKeysChange?: (selectedRowKeys: Key[], selectedRows: TRow[]) => void): TableRowSelection<TRow> | undefined;

package/dist/types/components/pro-table/hooks/use-table-columns.d.ts

@@ -1,13 +0,0 @@
-import { TableColumn } from '@vef-framework-react/components';
-import { AnyObject } from '@vef-framework-react/shared';
-import { ColumnSettingsProp, OperationColumnConfig } from '../types';
-/**
- * The hook to use the table columns.
- *
- * @param tableColumns - The columns of the table.
- * @param operationColumn - The operation column of the table.
- * @param showSequenceColumn - Whether to show the sequence column. Default is true.
- * @param columnSettingsProp - Column settings configuration.
- * @returns The table columns.
- */
-export declare function useTableColumns<TRow extends AnyObject>(tableColumns: Array<TableColumn<TRow>>, operationColumn?: OperationColumnConfig<TRow>, showSequenceColumn?: boolean, columnSettingsProp?: ColumnSettingsProp): Array<TableColumn<TRow>>;

package/dist/types/components/pro-table/index.d.ts

@@ -1,11 +0,0 @@
-import { AnyObject, Awaitable } from '@vef-framework-react/shared';
-import { FC, ReactNode } from 'react';
-import { ProTableProps } from './props';
-import { ProTableRef } from './types';
-export declare const ProTable: (<TRow extends AnyObject, TParams extends AnyObject>(props: ProTableProps<TRow, TParams> & {
-    ref?: React.Ref<ProTableRef>;
-}) => Awaitable<ReactNode>) & Pick<FC, "displayName">;
-export { OperationButtonGroup, TableSubscriber as ProTableSubscriber, type OperationButtonGroupProps, type TableSubscriberProps as ProTableSubscriberProps } from './components';
-export type { ProTableProps } from './props';
-export type { ProTableState } from './store';
-export type { ColumnSettingsConfig, ColumnSettingsProp, OperationColumnConfig, ParamsWithPagination, ParamsWithSort, ProTableRef, RowSelectionConfig } from './types';

package/dist/types/components/pro-table/props.d.ts

@@ -1,127 +0,0 @@
-import { TableColumn, TableProps } from '@vef-framework-react/components';
-import { PaginationResult, QueryFunction } from '@vef-framework-react/core';
-import { AnyObject, DeepKeys, Key } from '@vef-framework-react/shared';
-import { CSSProperties, ReactNode } from 'react';
-import { ColumnSettingsProp, OperationColumnConfig, ParamsWithPagination, ParamsWithSort, RowSelectionConfig } from './types';
-/**
- * Base props for ProTable component
- *
- * @template TRow - The type of table row data
- * @template TParams - The type of query parameters
- */
-interface BaseProTableProps<TRow extends AnyObject, TParams extends AnyObject> extends Pick<TableProps<TRow>, "size"> {
-    /**
-     * Class name for the table container
-     */
-    className?: string;
-    /**
-     * Inline styles for the table container
-     */
-    style?: CSSProperties;
-    /**
-     * Table column definitions
-     */
-    columns: Array<TableColumn<NoInfer<TRow>>>;
-    /**
-     * Column settings configuration.
-     * - `false`: Disable column settings feature
-     * - `{ storageKey?: string }`: Enable with optional localStorage persistence
-     *
-     * @default {}
-     */
-    columnSettings?: ColumnSettingsProp;
-    /**
-     * Whether to show the sequence (row number) column. Default is true.
-     */
-    showSequenceColumn?: boolean;
-    /**
-     * Row key extractor: either a deep key of the row model or a function
-     */
-    rowKey?: DeepKeys<NoInfer<TRow>> | ((row: NoInfer<TRow>) => Key);
-    /**
-     * Enable virtual scrolling for the table to improve performance with large datasets
-     *
-     * @default false
-     */
-    virtual?: boolean;
-    /**
-     * Currently selected row keys
-     */
-    selectedRowKeys?: Key[];
-    /**
-     * Operation column configuration for per-row actions
-     */
-    operationColumn?: OperationColumnConfig<NoInfer<TRow>>;
-    /**
-     * Row selection configuration
-     * - `true`: Enable row selection with default configuration
-     * - `RowSelectionConfig<TRow>`: Enable row selection with custom configuration
-     * - `undefined`: Disable row selection (default)
-     */
-    rowSelection?: RowSelectionConfig<NoInfer<TRow>> | true;
-    /**
-     * Function to determine whether the query should be enabled
-     */
-    queryEnabled?: (params?: TParams) => boolean;
-    /**
-     * Query parameters that trigger re-fetching when changed.
-     */
-    queryParams?: TParams;
-    /**
-     * Custom header content to be rendered above the title
-     */
-    header?: ReactNode;
-    /**
-     * Title to be displayed above the table
-     */
-    title?: ReactNode;
-    /**
-     * Summary information to be displayed below the table
-     */
-    summary?: ReactNode;
-    /**
-     * Custom footer content to be rendered below the summary
-     */
-    footer?: ReactNode;
-    /**
-     * Callback when selected row keys change
-     */
-    onSelectedRowKeysChange?: (keys: Key[], rows: TRow[]) => void;
-}
-/**
- * Props for paginated ProTable
- *
- * @template TRow - The type of table row data
- * @template TParams - The type of query parameters
- */
-export interface PaginatedProTableProps<TRow extends AnyObject, TParams extends AnyObject> extends BaseProTableProps<TRow, TParams> {
-    /**
-     * Enable pagination mode. Default is true.
-     */
-    isPaginated?: true;
-    /**
-     * Query function for fetching paginated data
-     */
-    queryFn: QueryFunction<PaginationResult<TRow>, ParamsWithSort<ParamsWithPagination<TParams>>>;
-}
-/**
- * Props for non-paginated ProTable
- *
- * @template TRow - The type of table row data
- * @template TParams - The type of query parameters
- */
-export interface NonPaginatedProTableProps<TRow extends AnyObject, TParams extends AnyObject> extends BaseProTableProps<TRow, TParams> {
-    /**
-     * Disable pagination mode for this variant
-     */
-    isPaginated: false;
-    /**
-     * Query function for fetching the full list data
-     */
-    queryFn: QueryFunction<TRow[], ParamsWithSort<TParams>>;
-}
-/**
- * Discriminated union of paginated and non-paginated ProTable props
- */
-export type ProTableProps<TRow extends AnyObject, TParams extends AnyObject> = PaginatedProTableProps<TRow, TParams> | NonPaginatedProTableProps<TRow, TParams>;
-export {};

package/dist/types/components/pro-table/store.d.ts

@@ -1,105 +0,0 @@
-import { TableColumn } from '@vef-framework-react/components';
-import { DragDropEvents, PaginationParams, StoreProviderProps, UseStore, UnboundStore } from '@vef-framework-react/core';
-import { EventEmitter, Key } from '@vef-framework-react/shared';
-import { ReactNode, ComponentType } from 'react';
-import { OrderSpec } from '../../types';
-import { ProTableEvents } from './event';
-/**
- * Column setting configuration
- */
-export interface ColumnSetting {
-    /**
-     * Column unique identifier
-     */
-    id: Key;
-    /**
-     * Column display title
-     */
-    title: ReactNode;
-    /**
-     * Column fixed position
-     */
-    fixed?: "start" | "end" | false;
-    /**
-     * Column width in pixels
-     */
-    width?: number;
-    /**
-     * Whether the column is visible
-     */
-    visible: boolean;
-    /**
-     * Original column index for reference
-     */
-    originalIndex: number;
-}
-/**
- * State for the ProTable component
- */
-export interface ProTableState {
-    /**
-     * Internal event bus used for cross-part communication within ProTable.
-     */
-    eventEmitter: EventEmitter<ProTableEvents>;
-    /**
-     * Current pagination parameters
-     */
-    paginationParams: PaginationParams;
-    /**
-     * Update pagination parameters
-     */
-    setPaginationParams: (params: PaginationParams) => void;
-    /**
-     * Current sort order specifications
-     */
-    sort: OrderSpec[];
-    /**
-     * Update sort order specifications
-     */
-    setSort: (sort: OrderSpec[]) => void;
-    /**
-     * Refetch data with current query params, current pagination and sort parameters
-     */
-    refetch: () => void;
-    /**
-     * Column settings state for customization
-     */
-    columnSettings: ColumnSetting[];
-    /**
-     * Original column settings for reset functionality
-     */
-    originalColumnSettings: ColumnSetting[];
-    /**
-     * Initialize column settings from columns prop
-     */
-    initColumnSettings: (columns: TableColumn[]) => void;
-    /**
-     * Set column settings directly
-     */
-    setColumnSettings: (settings: ColumnSetting[]) => void;
-    /**
-     * Reorder columns by drag event
-     */
-    reorderColumns: (event: Parameters<DragDropEvents["dragend"]>[0]) => void;
-    /**
-     * Toggle column fixed state
-     */
-    setColumnFixed: (id: Key, fixed: "start" | "end" | false) => void;
-    /**
-     * Update column width
-     */
-    setColumnWidth: (id: Key, width: number) => void;
-    /**
-     * Toggle column visibility
-     */
-    setColumnVisible: (id: Key, visible: boolean) => void;
-    /**
-     * Reset column settings to original state
-     *
-     * @param clearStorage - Optional callback to clear localStorage
-     */
-    resetColumnSettings: (clearStorage?: () => void) => void;
-}
-export declare function getColumnId(column: TableColumn, index: number): string;
-export declare function createColumnSetting(column: TableColumn, index: number): ColumnSetting;
-export declare const ProTableStoreProvider: ComponentType<StoreProviderProps<never>>, useProTableStore: UseStore<ProTableState>, useProTableStoreApi: <TStrictState extends ProTableState = ProTableState>() => UnboundStore<TStrictState>;

package/dist/types/components/pro-table/types.d.ts

@@ -1,103 +0,0 @@
-import { Length } from '@vef-framework-react/components';
-import { PaginationParams } from '@vef-framework-react/core';
-import { Key } from '@vef-framework-react/shared';
-import { ReactNode } from 'react';
-import { SYMBOL_PAGINATION, SYMBOL_SORT } from '../../constants';
-import { OrderSpec } from '../../types';
-/**
- * Configuration for column settings feature
- */
-export interface ColumnSettingsConfig {
-    /**
-     * Storage key for persisting column settings to localStorage.
-     * If provided, settings will be saved with key: `__VEF_PRO_TABLE_COLUMN_SETTINGS__${storageKey}`
-     * If not provided, settings will not be persisted.
-     */
-    storageKey?: string;
-}
-/**
- * Column settings prop type.
- * - `false`: Disable column settings feature, hide settings icon
- * - `ColumnSettingsConfig`: Enable column settings with optional persistence
- */
-export type ColumnSettingsProp = false | ColumnSettingsConfig;
-/**
- * Imperative handle for ProTable component.
- * Exposed via ref to allow parent components to programmatically control the table.
- */
-export interface ProTableRef {
-    /**
-     * Manually trigger a data refetch.
-     * Useful when you need to refresh the table data after external changes.
-     */
-    refetch: () => void;
-    /**
-     * Register a callback to be invoked when table starts loading data
-     */
-    onLoading: (callback: () => void) => () => void;
-    /**
-     * Register a callback to be invoked when table finishes loading data
-     */
-    onLoaded: (callback: () => void) => () => void;
-}
-/**
- * Represents request parameters enhanced with pagination metadata.
- */
-export type ParamsWithPagination<TParams> = TParams & {
-    [SYMBOL_PAGINATION]?: PaginationParams;
-};
-/**
- * Represents request parameters enhanced with sort metadata.
- */
-export type ParamsWithSort<TParams> = TParams & {
-    [SYMBOL_SORT]?: OrderSpec[];
-};
-/**
- * Configuration for the operation column which renders per-row actions
- */
-export interface OperationColumnConfig<TRow> {
-    /**
-     * Column width. Accepts any valid `Length` value.
-     */
-    width?: Length;
-    /**
-     * Column header title. Can be plain text or a React node.
-     */
-    title?: ReactNode;
-    /**
-     * Permission tokens required to display the operation content.
-     * Use this to conditionally hide actions based on authorization.
-     */
-    permTokens?: string[];
-    /**
-     * Render function for the operation cell of a row.
-     * Receives the current row data and its index, and should return a React node
-     * that contains operation elements (e.g., buttons, menus).
-     */
-    render: (row: TRow, index: number) => ReactNode;
-}
-/**
- * The configuration for the row selection of the table.
- */
-export interface RowSelectionConfig<TRow> {
-    /**
-     * If set, row selection will be disabled for the row with the function returns true
-     */
-    rowSelectDisabled?: (model: TRow) => boolean;
-    /**
-     * Keep the selection keys in list even the key not exist in `dataSource` anymore
-     */
-    checkStrictly?: boolean;
-    /**
-     * Whether hide select all checkbox
-     */
-    hideSelectAll?: boolean;
-    /**
-     * Keep the selection keys in list even the key not exist in `dataSource` anymore
-     */
-    preserveSelectedRowKeys?: boolean;
-    /**
-     * The default selected row keys
-     */
-    defaultSelectedRowKeys?: Key[];
-}

package/dist/types/constants/symbols.d.ts

@@ -1,2 +0,0 @@
-export declare const SYMBOL_PAGINATION: unique symbol;
-export declare const SYMBOL_SORT: unique symbol;