@agile-team/mach-table-react 0.23.0 → 0.24.0

package/dist/workflows-CoKf5zIV.d.ts

@@ -1,138 +0,0 @@
-import { GridApi, GridChange, GridBatchSaveResult, SaveChangeIssue, SaveChangeConflict, SaveChangesHandler, SortModel, FilterModel, AdvancedFilterModel, GridOptions, OverlayContent, OverlayTemplate, MachTableCommands } from '@agile-team/mach-table';
-import { MutableRefObject } from 'react';
-
-interface UseMachGridReturn<TData = any> {
-    apiRef: MutableRefObject<GridApi<TData> | null>;
-    api: GridApi<TData> | null;
-    ready: boolean;
-}
-declare function useMachGrid<TData = any>(): UseMachGridReturn<TData>;
-
-interface UseMachTableEditingOptions<TData = any> {
-    guardBeforeUnload?: boolean;
-    beforeUnloadMessage?: string;
-    onSaveSuccess?(saved: readonly GridChange<TData>[]): void;
-    onSaveResult?(result: GridBatchSaveResult<TData>): void;
-    onSaveError?(error: unknown): void;
-}
-interface UseMachTableEditingReturn<TData = any> {
-    changes: GridChange<TData>[];
-    dirtyRowIds: string[];
-    dirty: boolean;
-    saving: boolean;
-    saveError: unknown | null;
-    lastSaveResult: GridBatchSaveResult<TData> | null;
-    saveIssues: Array<SaveChangeIssue | SaveChangeConflict<TData>>;
-    failedRowIds: string[];
-    save(handler: SaveChangesHandler<TData>, rowIds?: readonly string[]): Promise<GridChange<TData>[]>;
-    saveDetailed(handler: SaveChangesHandler<TData>, rowIds?: readonly string[]): Promise<GridBatchSaveResult<TData>>;
-    clearSaveIssues(): void;
-    resolveConflict(rowId: string, strategy: "acceptServer" | "keepLocal"): boolean;
-    rollback(rowIds?: readonly string[]): boolean;
-    markSaved(rowIds?: readonly string[]): void;
-    reveal(rowId: string, colId?: string, edit?: boolean): boolean;
-    refresh(): void;
-}
-/** Reactive dirty/save workflow layered over useMachGrid(). */
-declare function useMachTableEditing<TData = any>(table: UseMachGridReturn<TData>, options?: UseMachTableEditingOptions<TData>): UseMachTableEditingReturn<TData>;
-
-type MachTableQuerySource<TQuery> = TQuery | (() => TQuery);
-interface MachTablePageRequest<TQuery> {
-    page: number;
-    pageSize: number;
-    query: TQuery;
-    sortModel: SortModel;
-    filterModel: FilterModel;
-    advancedFilterModel: AdvancedFilterModel | null;
-    quickFilterText: string | null;
-    signal: AbortSignal;
-}
-interface MachTablePageResult<TData> {
-    rows: readonly TData[];
-    total: number;
-}
-type MachTableRemoteSelectionState = {
-    mode: "explicit";
-    selectedKeys: string[];
-} | {
-    mode: "allMatching";
-    excludedKeys: string[];
-};
-interface UseMachTableQueryOptions<TData, TQuery = Record<string, unknown>> {
-    request(params: MachTablePageRequest<TQuery>): Promise<MachTablePageResult<TData>>;
-    query: MachTableQuerySource<TQuery>;
-    /** Memoize object queries in React; queryKey can explicitly control reload dependencies. */
-    queryKey?: unknown;
-    rowKey: string | ((row: TData) => string | number);
-    initialPage?: number;
-    pageSize?: number;
-    pageSizeOptions?: readonly number[];
-    immediate?: boolean;
-    mode?: "auto" | "manual";
-    debounceMs?: number;
-    keepPreviousData?: boolean;
-    selectionScope?: "page" | "preserve" | "query";
-    clearSelectionOnQueryChange?: boolean;
-    initialQuickFilterText?: string | null;
-    errorOverlay?(context: {
-        error: unknown;
-        retry(): Promise<void>;
-    }): OverlayContent;
-    emptyOverlay?: OverlayTemplate;
-    onSuccess?(result: MachTablePageResult<TData>): void;
-    onError?(error: unknown): void;
-}
-interface UseMachTableQueryReturn<TData> {
-    rows: TData[];
-    loading: boolean;
-    error: unknown | null;
-    page: number;
-    pageSize: number;
-    total: number;
-    sortModel: SortModel;
-    filterModel: FilterModel;
-    advancedFilterModel: AdvancedFilterModel | null;
-    quickFilterText: string | null;
-    setQuickFilterText(value: string | null): void;
-    selectedKeys: string[];
-    selectedRows: TData[];
-    selectionState: MachTableRemoteSelectionState;
-    gridProps: GridOptions<TData>;
-    bindings: GridOptions<TData>;
-    reload(options?: {
-        resetPage?: boolean;
-    }): Promise<void>;
-    retry(): Promise<void>;
-    reset(): Promise<void>;
-    abort(): void;
-    clearSelection(): void;
-    selectAllMatching(): void;
-    applySelectionState(state: MachTableRemoteSelectionState): void;
-}
-/** React remote-list controller with cancellation, stale guards and cross-page selection. */
-declare function useMachTableQuery<TData, TQuery = Record<string, unknown>>(options: UseMachTableQueryOptions<TData, TQuery>): UseMachTableQueryReturn<TData>;
-
-interface UseMachTableControllerOptions<TData> {
-    /** Pass the result of useMachTableQuery for remote workflows. */
-    query?: UseMachTableQueryReturn<TData>;
-    editing?: UseMachTableEditingOptions<TData>;
-    initialSearch?: string;
-}
-interface UseMachTableControllerReturn<TData> {
-    table: UseMachGridReturn<TData>;
-    query: UseMachTableQueryReturn<TData> | null;
-    editing: UseMachTableEditingReturn<TData>;
-    bindings: GridOptions<TData>;
-    search: string;
-    setSearch(value: string): void;
-    selectedRows: TData[];
-    selectedCount: number;
-    busy: boolean;
-    error: unknown | null;
-    commands: MachTableCommands;
-    reload(): Promise<void>;
-}
-/** Cohesive React controller for API readiness, selection, editing and toolbar commands. */
-declare function useMachTableController<TData>(options?: UseMachTableControllerOptions<TData>): UseMachTableControllerReturn<TData>;
-
-export { type MachTablePageRequest as M, type UseMachGridReturn as U, type MachTablePageResult as a, type MachTableQuerySource as b, type MachTableRemoteSelectionState as c, type UseMachTableControllerOptions as d, type UseMachTableControllerReturn as e, type UseMachTableEditingOptions as f, type UseMachTableEditingReturn as g, type UseMachTableQueryOptions as h, type UseMachTableQueryReturn as i, useMachTableController as j, useMachTableEditing as k, useMachTableQuery as l, useMachGrid as u };