@agile-team/mach-table-vue 0.23.0 → 0.25.0

package/dist/workflows-CyXKgNRx.d.ts

@@ -1,145 +0,0 @@
-import { Ref, ShallowRef, ComputedRef } from 'vue';
-import { GridApi, GridChange, GridBatchSaveResult, SaveChangeIssue, SaveChangeConflict, SaveChangesHandler, SortModel, FilterModel, AdvancedFilterModel, OverlayContent, OverlayTemplate, GridOptions, MachTableCommands } from '@agile-team/mach-table';
-import { b as MachTableVueExposed } from './MachTable-DH0offab.js';
-
-interface UseMachTableReturn<TData = any> {
-    ref: Ref<MachTableVueExposed<TData> | null>;
-    api: ShallowRef<GridApi<TData> | null>;
-    ready: ShallowRef<boolean>;
-}
-declare function useMachTable<TData = any>(): UseMachTableReturn<TData>;
-
-interface UseMachTableEditingOptions<TData = any> {
-    /** Warn before closing/reloading a browser tab with unsaved changes. */
-    guardBeforeUnload?: boolean;
-    beforeUnloadMessage?: string;
-    onSaveSuccess?(saved: readonly GridChange<TData>[]): void;
-    onSaveResult?(result: GridBatchSaveResult<TData>): void;
-    onSaveError?(error: unknown): void;
-}
-interface UseMachTableEditingReturn<TData = any> {
-    changes: ShallowRef<GridChange<TData>[]>;
-    dirtyRowIds: Ref<string[]>;
-    dirty: ComputedRef<boolean>;
-    saving: Ref<boolean>;
-    saveError: ShallowRef<unknown | null>;
-    lastSaveResult: ShallowRef<GridBatchSaveResult<TData> | null>;
-    saveIssues: ComputedRef<Array<SaveChangeIssue | SaveChangeConflict<TData>>>;
-    failedRowIds: ComputedRef<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;
-    /** Scrolls to a loaded changed row and optionally opens the failed cell editor. */
-    reveal(rowId: string, colId?: string, edit?: boolean): boolean;
-    refresh(): void;
-}
-/** Reactive dirty/save workflow layered over useMachTable(). */
-declare function useMachTableEditing<TData = any>(table: UseMachTableReturn<TData>, options?: UseMachTableEditingOptions<TData>): UseMachTableEditingReturn<TData>;
-
-type MachTableQuerySource<TQuery> = TQuery | Readonly<Ref<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>;
-    /** Stable row key used for updates and cross-page selection. */
-    rowKey: string | ((row: TData) => string | number);
-    initialPage?: number;
-    pageSize?: number;
-    pageSizeOptions?: readonly number[];
-    immediate?: boolean;
-    /** auto reloads when query/grid criteria change; manual waits for reload/reset. */
-    mode?: "auto" | "manual";
-    debounceMs?: number;
-    keepPreviousData?: boolean;
-    /** `query` additionally enables compact select-all-matching rules. */
-    selectionScope?: "page" | "preserve" | "query";
-    /** Defaults true: a different business/filter query cannot inherit stale selections. */
-    clearSelectionOnQueryChange?: boolean;
-    quickFilterText?: Ref<string | null>;
-    /** Renders inside the first-class error overlay for the latest failed request. */
-    errorOverlay?(context: {
-        error: unknown;
-        retry(): Promise<void>;
-    }): OverlayContent;
-    emptyOverlay?: OverlayTemplate;
-    onSuccess?(result: MachTablePageResult<TData>): void;
-    onError?(error: unknown): void;
-}
-interface UseMachTableQueryReturn<TData> {
-    rows: ShallowRef<TData[]>;
-    loading: Ref<boolean>;
-    error: ShallowRef<unknown | null>;
-    page: Ref<number>;
-    pageSize: Ref<number>;
-    total: Ref<number>;
-    sortModel: ShallowRef<SortModel>;
-    filterModel: ShallowRef<FilterModel>;
-    advancedFilterModel: ShallowRef<AdvancedFilterModel | null>;
-    selectedKeys: Ref<string[]>;
-    selectedRows: ShallowRef<TData[]>;
-    selectionState: ComputedRef<MachTableRemoteSelectionState>;
-    gridProps: ComputedRef<GridOptions<TData>>;
-    bindings: ComputedRef<GridOptions<TData>>;
-    reload(options?: {
-        resetPage?: boolean;
-    }): Promise<void>;
-    retry(): Promise<void>;
-    reset(): Promise<void>;
-    abort(): void;
-    clearSelection(): void;
-    /** Selects the complete server query without downloading every row ID. */
-    selectAllMatching(): void;
-    applySelectionState(state: MachTableRemoteSelectionState): void;
-}
-/**
- * B-side remote-list controller: paging, sorting, filtering, cancellation,
- * stale-response protection and cross-page selection in one typed binding.
- */
-declare function useMachTableQuery<TData, TQuery = Record<string, unknown>>(options: UseMachTableQueryOptions<TData, TQuery>): UseMachTableQueryReturn<TData>;
-
-interface UseMachTableControllerOptions<TData, TQuery = Record<string, unknown>> {
-    /** Omit for local rowData; provide for a complete remote table workflow. */
-    query?: UseMachTableQueryOptions<TData, TQuery>;
-    editing?: UseMachTableEditingOptions<TData>;
-    initialSearch?: string;
-}
-interface UseMachTableControllerReturn<TData> {
-    table: UseMachTableReturn<TData>;
-    query: UseMachTableQueryReturn<TData> | null;
-    editing: UseMachTableEditingReturn<TData>;
-    bindings: ComputedRef<GridOptions<TData>>;
-    search: Ref<string>;
-    selectedRows: ShallowRef<TData[]>;
-    selectedCount: ComputedRef<number>;
-    busy: ComputedRef<boolean>;
-    error: ComputedRef<unknown | null>;
-    commands: MachTableCommands;
-    reload(): Promise<void>;
-}
-/** One cohesive controller for API readiness, query, selection, editing and toolbar commands. */
-declare function useMachTableController<TData, TQuery = Record<string, unknown>>(options?: UseMachTableControllerOptions<TData, TQuery>): UseMachTableControllerReturn<TData>;
-
-export { type MachTablePageRequest as M, type UseMachTableControllerOptions as U, type MachTablePageResult as a, type MachTableQuerySource as b, type MachTableRemoteSelectionState as c, type UseMachTableControllerReturn as d, type UseMachTableEditingOptions as e, type UseMachTableEditingReturn as f, type UseMachTableQueryOptions as g, type UseMachTableQueryReturn as h, type UseMachTableReturn as i, useMachTableController as j, useMachTableEditing as k, useMachTableQuery as l, useMachTable as u };

package/dist/workflows-DEOJrSuj.d.cts

@@ -1,145 +0,0 @@
-import { Ref, ShallowRef, ComputedRef } from 'vue';
-import { GridApi, GridChange, GridBatchSaveResult, SaveChangeIssue, SaveChangeConflict, SaveChangesHandler, SortModel, FilterModel, AdvancedFilterModel, OverlayContent, OverlayTemplate, GridOptions, MachTableCommands } from '@agile-team/mach-table';
-import { b as MachTableVueExposed } from './MachTable-DH0offab.cjs';
-
-interface UseMachTableReturn<TData = any> {
-    ref: Ref<MachTableVueExposed<TData> | null>;
-    api: ShallowRef<GridApi<TData> | null>;
-    ready: ShallowRef<boolean>;
-}
-declare function useMachTable<TData = any>(): UseMachTableReturn<TData>;
-
-interface UseMachTableEditingOptions<TData = any> {
-    /** Warn before closing/reloading a browser tab with unsaved changes. */
-    guardBeforeUnload?: boolean;
-    beforeUnloadMessage?: string;
-    onSaveSuccess?(saved: readonly GridChange<TData>[]): void;
-    onSaveResult?(result: GridBatchSaveResult<TData>): void;
-    onSaveError?(error: unknown): void;
-}
-interface UseMachTableEditingReturn<TData = any> {
-    changes: ShallowRef<GridChange<TData>[]>;
-    dirtyRowIds: Ref<string[]>;
-    dirty: ComputedRef<boolean>;
-    saving: Ref<boolean>;
-    saveError: ShallowRef<unknown | null>;
-    lastSaveResult: ShallowRef<GridBatchSaveResult<TData> | null>;
-    saveIssues: ComputedRef<Array<SaveChangeIssue | SaveChangeConflict<TData>>>;
-    failedRowIds: ComputedRef<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;
-    /** Scrolls to a loaded changed row and optionally opens the failed cell editor. */
-    reveal(rowId: string, colId?: string, edit?: boolean): boolean;
-    refresh(): void;
-}
-/** Reactive dirty/save workflow layered over useMachTable(). */
-declare function useMachTableEditing<TData = any>(table: UseMachTableReturn<TData>, options?: UseMachTableEditingOptions<TData>): UseMachTableEditingReturn<TData>;
-
-type MachTableQuerySource<TQuery> = TQuery | Readonly<Ref<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>;
-    /** Stable row key used for updates and cross-page selection. */
-    rowKey: string | ((row: TData) => string | number);
-    initialPage?: number;
-    pageSize?: number;
-    pageSizeOptions?: readonly number[];
-    immediate?: boolean;
-    /** auto reloads when query/grid criteria change; manual waits for reload/reset. */
-    mode?: "auto" | "manual";
-    debounceMs?: number;
-    keepPreviousData?: boolean;
-    /** `query` additionally enables compact select-all-matching rules. */
-    selectionScope?: "page" | "preserve" | "query";
-    /** Defaults true: a different business/filter query cannot inherit stale selections. */
-    clearSelectionOnQueryChange?: boolean;
-    quickFilterText?: Ref<string | null>;
-    /** Renders inside the first-class error overlay for the latest failed request. */
-    errorOverlay?(context: {
-        error: unknown;
-        retry(): Promise<void>;
-    }): OverlayContent;
-    emptyOverlay?: OverlayTemplate;
-    onSuccess?(result: MachTablePageResult<TData>): void;
-    onError?(error: unknown): void;
-}
-interface UseMachTableQueryReturn<TData> {
-    rows: ShallowRef<TData[]>;
-    loading: Ref<boolean>;
-    error: ShallowRef<unknown | null>;
-    page: Ref<number>;
-    pageSize: Ref<number>;
-    total: Ref<number>;
-    sortModel: ShallowRef<SortModel>;
-    filterModel: ShallowRef<FilterModel>;
-    advancedFilterModel: ShallowRef<AdvancedFilterModel | null>;
-    selectedKeys: Ref<string[]>;
-    selectedRows: ShallowRef<TData[]>;
-    selectionState: ComputedRef<MachTableRemoteSelectionState>;
-    gridProps: ComputedRef<GridOptions<TData>>;
-    bindings: ComputedRef<GridOptions<TData>>;
-    reload(options?: {
-        resetPage?: boolean;
-    }): Promise<void>;
-    retry(): Promise<void>;
-    reset(): Promise<void>;
-    abort(): void;
-    clearSelection(): void;
-    /** Selects the complete server query without downloading every row ID. */
-    selectAllMatching(): void;
-    applySelectionState(state: MachTableRemoteSelectionState): void;
-}
-/**
- * B-side remote-list controller: paging, sorting, filtering, cancellation,
- * stale-response protection and cross-page selection in one typed binding.
- */
-declare function useMachTableQuery<TData, TQuery = Record<string, unknown>>(options: UseMachTableQueryOptions<TData, TQuery>): UseMachTableQueryReturn<TData>;
-
-interface UseMachTableControllerOptions<TData, TQuery = Record<string, unknown>> {
-    /** Omit for local rowData; provide for a complete remote table workflow. */
-    query?: UseMachTableQueryOptions<TData, TQuery>;
-    editing?: UseMachTableEditingOptions<TData>;
-    initialSearch?: string;
-}
-interface UseMachTableControllerReturn<TData> {
-    table: UseMachTableReturn<TData>;
-    query: UseMachTableQueryReturn<TData> | null;
-    editing: UseMachTableEditingReturn<TData>;
-    bindings: ComputedRef<GridOptions<TData>>;
-    search: Ref<string>;
-    selectedRows: ShallowRef<TData[]>;
-    selectedCount: ComputedRef<number>;
-    busy: ComputedRef<boolean>;
-    error: ComputedRef<unknown | null>;
-    commands: MachTableCommands;
-    reload(): Promise<void>;
-}
-/** One cohesive controller for API readiness, query, selection, editing and toolbar commands. */
-declare function useMachTableController<TData, TQuery = Record<string, unknown>>(options?: UseMachTableControllerOptions<TData, TQuery>): UseMachTableControllerReturn<TData>;
-
-export { type MachTablePageRequest as M, type UseMachTableControllerOptions as U, type MachTablePageResult as a, type MachTableQuerySource as b, type MachTableRemoteSelectionState as c, type UseMachTableControllerReturn as d, type UseMachTableEditingOptions as e, type UseMachTableEditingReturn as f, type UseMachTableQueryOptions as g, type UseMachTableQueryReturn as h, type UseMachTableReturn as i, useMachTableController as j, useMachTableEditing as k, useMachTableQuery as l, useMachTable as u };