@servicetitan/table 22.1.0 → 22.1.1

package/dist/table-state.d.ts

@@ -0,0 +1,161 @@
+import { ReactElement } from 'react';
+import { AggregateDescriptor, CompositeFilterDescriptor, GroupDescriptor, SortDescriptor, DataResult, GroupResult, DataSource, IdType } from '@servicetitan/data-query';
+import { ExcelExport, ExcelExportData, ExcelExportColumnProps } from '@progress/kendo-react-excel-export';
+import { TableExpandChangeEvent, TableFilterChangeEvent, TableGroupChangeEvent, TablePageChangeEvent, TableSortChangeEvent } from '@servicetitan/design-system';
+import { GridPDFExport as TablePDFExport } from '@progress/kendo-react-pdf';
+import { WorkbookOptions } from '@progress/kendo-ooxml';
+import { FormState, FieldState } from 'formstate';
+export declare type Selectable<T> = {
+    readonly selected: boolean | undefined;
+} & T;
+export declare type Editable<T> = {
+    readonly inEdit: boolean | undefined;
+} & T;
+export declare type Expandable<T> = {
+    readonly expanded: boolean | undefined;
+} & T;
+export declare type Materialized<T> = {
+    readonly materializedPath: string;
+} & T;
+declare type Data<T> = DataResult<T>['data'];
+export declare function isGroupItem<T>(item: T | GroupResult<T>, groups: GroupDescriptor[]): item is GroupResult<T>;
+export declare type PossibleFormState<T> = FormState<{
+    [P in keyof T]-?: FieldState<T[P]>;
+}>;
+export interface TableStateModel<TId extends IdType = never> {
+    skip: number;
+    selectedIds: TId[];
+    expandedIds: TId[];
+    collapsedGroups: string[];
+    sort: SortDescriptor[];
+    filter?: CompositeFilterDescriptor;
+    aggregates: AggregateDescriptor[];
+    group: GroupDescriptor[];
+}
+interface TableStateConstructorParams<T, TId extends IdType = never, P = never, PId extends IdType = never> {
+    dataSource?: DataSource<T, TId> | null;
+    pageSize?: number;
+    /** For use with tables that enable selection only. Specifies if the item is selectable in the checkbox */
+    isRowUnselectable?: (row: T) => boolean;
+    selectionLimit?: number;
+    getFormState?(row: T): PossibleFormState<T>;
+    parent?: {
+        row: P;
+        tableState: TableState<P, PId>;
+    };
+    getDetailTableState?: (row: T) => TableState<any, any, any, any> | undefined;
+    initialState?: TableStateModel<TId>;
+    alwaysEditable?: boolean;
+}
+interface FetchDataParams {
+    newSkip?: number;
+    newSort?: SortDescriptor[];
+    newFilter?: CompositeFilterDescriptor | null;
+    newAggregates?: AggregateDescriptor[];
+    newGroup?: GroupDescriptor[];
+}
+interface SelectionOptions {
+    ignoreUnselectable?: boolean;
+    recursive?: boolean;
+}
+interface SetDataSourceParams<TId extends IdType = never> {
+    reset?: boolean;
+    initialState?: TableStateModel<TId>;
+}
+interface EditingForm<T> {
+    form: PossibleFormState<T>;
+    field?: keyof T;
+}
+/** Interface for unit testing purposes.*/
+export interface ITableState<T, TId extends IdType = never> {
+    totalCount?: number;
+    selectedCount?: number;
+    addToDataSource?: (row: T, select?: boolean | undefined) => Promise<void>;
+    removeFromDataSource?: (id: TId) => Promise<T | undefined>;
+    selectAll?: () => Promise<void>;
+    deselectAll?: () => void;
+    setDataSource?: (dataSource: DataSource<T, TId> | null, setDataSourceParams?: boolean | SetDataSourceParams<TId>) => Promise<void>;
+    isRowUnselectable?: (row: T) => boolean;
+}
+export declare class TableState<T, TId extends IdType = never, P = never, PId extends IdType = never> {
+    private innerDataSource;
+    get dataSource(): DataSource<T, TId> | null;
+    private traverse;
+    private get originalData();
+    parent?: {
+        row: P;
+        tableState: TableState<P, PId>;
+    };
+    getDetailTableState?: (row: T) => TableState<any, any, any, any> | undefined;
+    selectedIds: Set<TId>;
+    inEdit: Map<TId, EditingForm<T>>;
+    expandedIds: Set<TId>;
+    collapsedGroups: Set<string>;
+    isRowUnselectable: (row: T) => boolean;
+    selectionLimit: number;
+    getFormState?(row: T): PossibleFormState<T>;
+    data: Data<Selectable<T>>;
+    totalCount: number;
+    filteredCount: number;
+    selectedCount: number;
+    unselectableCount: number;
+    get unselectedCount(): number;
+    get selectableCount(): number;
+    get filteredUnselectableCount(): number;
+    get filteredSelectableCount(): number;
+    private get totalFilteredSelectableCountPromise();
+    get totalFilteredSelectableCount(): number;
+    sort: SortDescriptor[];
+    filter: CompositeFilterDescriptor | undefined;
+    aggregates: AggregateDescriptor[];
+    innerGroup: GroupDescriptor[];
+    get group(): GroupDescriptor[];
+    set group(value: GroupDescriptor[]);
+    skip: number;
+    pageSize?: number;
+    private tablePdfExport;
+    private tableExcelExport;
+    alwaysEditable: boolean;
+    constructor({ dataSource, pageSize, isRowUnselectable, selectionLimit, getFormState, parent, getDetailTableState, initialState, alwaysEditable, }?: TableStateConstructorParams<T, TId, P, PId>);
+    addToDataSource(row: T, select?: boolean, index?: number): Promise<void>;
+    removeFromDataSource(id: TId): Promise<T | undefined>;
+    setRowsSelection(rows: T[], value: boolean, { ignoreUnselectable, recursive }?: SelectionOptions): Promise<void>;
+    selectPage(options?: SelectionOptions): Promise<void>;
+    deselectPage(options?: SelectionOptions): Promise<void>;
+    private setAllSelection;
+    selectAll(options?: SelectionOptions): Promise<void>;
+    deselectAll(options?: SelectionOptions): Promise<void>;
+    edit(row: T, field?: keyof T): void;
+    saveEdit(row: T, beforeSave?: (changed: T, field?: keyof T) => Promise<void>): Promise<void>;
+    cancelEdit(row: T): void;
+    editAll(): Promise<void>;
+    saveEditAll(beforeSave?: (changed: T[]) => Promise<void>): Promise<void>;
+    cancelEditAll(): void;
+    reset(): void;
+    setDataSource(dataSource: DataSource<T, TId> | null, setDataSourceParams?: SetDataSourceParams<TId> | boolean): Promise<void>;
+    private fetchInitialData;
+    private addPropertiesToRows;
+    handleFilterChange: (ev: TableFilterChangeEvent) => void;
+    handleGroupChange: (ev: TableGroupChangeEvent) => void;
+    handleExpandChange: ({ dataItem, value }: TableExpandChangeEvent) => void;
+    handleSortChange: (ev: TableSortChangeEvent) => void;
+    handlePageChange: (ev: TablePageChangeEvent) => void;
+    /** Call without params if unchanged */
+    fetchData: ({ newSkip, newSort, newFilter, newAggregates, newGroup, }?: FetchDataParams) => Promise<void>;
+    isRowSelectable: (row: Selectable<T>) => boolean;
+    toggleRowSelection(row: T, options?: SelectionOptions): Promise<void>;
+    get isAllPageRowsSelected(): boolean;
+    get isSomePageRowsSelected(): boolean;
+    get isAllRowsSelected(): boolean;
+    get isSomeRowsSelected(): boolean;
+    setTablePdfExportRef: (el: TablePDFExport | null) => TablePDFExport | null;
+    setTableExcelExportRef: (el: ExcelExport | null) => ExcelExport | null;
+    exportPdf: () => Promise<void>;
+    exportExcel: (data?: any[] | WorkbookOptions | ExcelExportData | undefined, columns?: ExcelExportColumnProps[] | ReactElement<ExcelExportColumnProps, string | import("react").JSXElementConstructor<any>>[] | undefined) => Promise<void>;
+    filteredSortedUnpaginatedData: () => Promise<DataResult<T>>;
+    getRowsBetween: (start: Selectable<T>, end: Selectable<T>) => Selectable<T>[];
+    exportState(): TableStateModel<TId>;
+    importState(data: TableStateModel<TId>): void;
+}
+export {};
+//# sourceMappingURL=table-state.d.ts.map

package/dist/table-state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"table-state.d.ts","sourceRoot":"","sources":["../src/table-state.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAGrC,OAAO,EACH,mBAAmB,EACnB,yBAAyB,EACzB,eAAe,EACf,cAAc,EACd,UAAU,EACV,WAAW,EACX,UAAU,EACV,MAAM,EACT,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACH,WAAW,EACX,eAAe,EACf,sBAAsB,EACzB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACH,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EACrB,oBAAoB,EACpB,oBAAoB,EACvB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,aAAa,IAAI,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC5E,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAGlD,oBAAY,UAAU,CAAC,CAAC,IAAI;IAAE,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;CAAE,GAAG,CAAC,CAAC;AAC3E,oBAAY,QAAQ,CAAC,CAAC,IAAI;IAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,CAAA;CAAE,GAAG,CAAC,CAAC;AACvE,oBAAY,UAAU,CAAC,CAAC,IAAI;IAAE,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;CAAE,GAAG,CAAC,CAAC;AAC3E,oBAAY,YAAY,CAAC,CAAC,IAAI;IAAE,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAA;CAAE,GAAG,CAAC,CAAC;AAExE,aAAK,IAAI,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AAErC,wBAAgB,WAAW,CAAC,CAAC,EACzB,IAAI,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EACxB,MAAM,EAAE,eAAe,EAAE,GAC1B,IAAI,IAAI,WAAW,CAAC,CAAC,CAAC,CAIxB;AASD,oBAAY,iBAAiB,CAAC,CAAC,IAAI,SAAS,CAAC;KACxC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACrC,CAAC,CAAC;AAEH,MAAM,WAAW,eAAe,CAAC,GAAG,SAAS,MAAM,GAAG,KAAK;IACvD,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,GAAG,EAAE,CAAC;IACnB,WAAW,EAAE,GAAG,EAAE,CAAC;IACnB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,IAAI,EAAE,cAAc,EAAE,CAAC;IACvB,MAAM,CAAC,EAAE,yBAAyB,CAAC;IACnC,UAAU,EAAE,mBAAmB,EAAE,CAAC;IAClC,KAAK,EAAE,eAAe,EAAE,CAAC;CAC5B;AAED,UAAU,2BAA2B,CACjC,CAAC,EACD,GAAG,SAAS,MAAM,GAAG,KAAK,EAC1B,CAAC,GAAG,KAAK,EACT,GAAG,SAAS,MAAM,GAAG,KAAK;IAE1B,UAAU,CAAC,EAAE,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0GAA0G;IAC1G,iBAAiB,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,OAAO,CAAC;IACxC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAC5C,MAAM,CAAC,EAAE;QACL,GAAG,EAAE,CAAC,CAAC;QACP,UAAU,EAAE,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;KAClC,CAAC;IACF,mBAAmB,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,SAAS,CAAC;IAC7E,YAAY,CAAC,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC;IACpC,cAAc,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,UAAU,eAAe;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAC3B,SAAS,CAAC,EAAE,yBAAyB,GAAG,IAAI,CAAC;IAC7C,aAAa,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACtC,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;CAChC;AAED,UAAU,gBAAgB;IACtB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,UAAU,mBAAmB,CAAC,GAAG,SAAS,MAAM,GAAG,KAAK;IACpD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,YAAY,CAAC,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC;CACvC;AAED,UAAU,WAAW,CAAC,CAAC;IACnB,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;CACnB;AAED,0CAA0C;AAC1C,MAAM,WAAW,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,MAAM,GAAG,KAAK;IACtD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1E,oBAAoB,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAC3D,SAAS,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,IAAI,CAAC;IACzB,aAAa,CAAC,EAAE,CACZ,UAAU,EAAE,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,EACrC,mBAAmB,CAAC,EAAE,OAAO,GAAG,mBAAmB,CAAC,GAAG,CAAC,KACvD,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,iBAAiB,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,OAAO,CAAC;CAC3C;AAED,qBAAa,UAAU,CAAC,CAAC,EAAE,GAAG,SAAS,MAAM,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK,EAAE,GAAG,SAAS,MAAM,GAAG,KAAK;IAC5E,OAAO,CAAC,eAAe,CAA4B;IAC/D,IAAc,UAAU,8BAEvB;IAED,OAAO,CAAC,QAAQ;IAyBN,OAAO,KAAK,YAAY,GAQjC;IAED,MAAM,CAAC,EAAE;QACL,GAAG,EAAE,CAAC,CAAC;QACP,UAAU,EAAE,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;KAClC,CAAC;IACF,mBAAmB,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,SAAS,CAAC;IAEjE,WAAW,WAAkB;IAC7B,MAAM,2BAAkC;IACxC,WAAW,WAAkB;IAC7B,eAAe,cAAqB;IAEhD,iBAAiB,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,OAAO,CAAC;IACvC,cAAc,EAAE,MAAM,CAAC;IAEvB,YAAY,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC;IAE/B,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAM;IAC/B,UAAU,SAAK;IACf,aAAa,SAAK;IAClB,aAAa,SAAK;IAClB,iBAAiB,SAAK;IAClC,IAAc,eAAe,WAE5B;IACD,IAAc,eAAe,WAE5B;IACD,IAAc,yBAAyB,WAEtC;IACD,IAAc,uBAAuB,WAEpC;IACS,OAAO,KAAK,mCAAmC,GAoBxD;IACD,IAAc,4BAA4B,IAAI,MAAM,CAEnD;IACW,IAAI,EAAE,cAAc,EAAE,CAAM;IAC5B,MAAM,EAAE,yBAAyB,GAAG,SAAS,CAAC;IAE9C,UAAU,EAAE,mBAAmB,EAAE,CAAM;IAEvC,UAAU,EAAE,eAAe,EAAE,CAAM;IAC/C,IACI,KAAK,IAAI,eAAe,EAAE,CAE7B;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,eAAe,EAAE,EAEjC;IAEW,IAAI,SAAK;IACT,QAAQ,CAAC,EAAE,MAAM,CAAC;IAE9B,OAAO,CAAC,cAAc,CAA+B;IACrD,OAAO,CAAC,gBAAgB,CAA4B;IAEpD,cAAc,EAAE,OAAO,CAAC;gBAEZ,EACR,UAAiB,EACjB,QAAQ,EACR,iBAA+B,EAC/B,cAAyB,EACzB,YAAY,EACZ,MAAM,EACN,mBAAmB,EACnB,YAAY,EACZ,cAAsB,GACzB,GAAE,2BAA2B,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAM;IA0B7C,eAAe,CAAC,GAAG,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM;IA8BxD,oBAAoB,CAAC,EAAE,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAqCrD,gBAAgB,CAClB,IAAI,EAAE,CAAC,EAAE,EACT,KAAK,EAAE,OAAO,EACd,EAAE,kBAAyB,EAAE,SAAgB,EAAE,GAAE,gBAAqB;IAqDpE,UAAU,CAAC,OAAO,CAAC,EAAE,gBAAgB;IAIrC,YAAY,CAAC,OAAO,CAAC,EAAE,gBAAgB;YAI/B,eAAe;IAYvB,SAAS,CAAC,OAAO,CAAC,EAAE,gBAAgB;IAQpC,WAAW,CAAC,OAAO,CAAC,EAAE,gBAAgB;IAK5C,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAsBtB,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC;IAsClF,UAAU,CAAC,GAAG,EAAE,CAAC;IAkBX,OAAO;IA+BP,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC;IAiC9D,aAAa;IAcL,KAAK;IAgBP,aAAa,CACf,UAAU,EAAE,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,EACrC,mBAAmB,CAAC,EAAE,mBAAmB,CAAC,GAAG,CAAC,GAAG,OAAO;IAyB5D,OAAO,CAAC,gBAAgB,CAqBtB;IAEF,OAAO,CAAC,mBAAmB;IAgE3B,kBAAkB,OAAQ,sBAAsB,UAI9C;IAGF,iBAAiB,OAAQ,qBAAqB,UAM5C;IAGF,kBAAkB,wBAAyB,sBAAsB,UA0B/D;IAGF,gBAAgB,OAAQ,oBAAoB,UAI1C;IAGF,gBAAgB,OAAQ,oBAAoB,UAU1C;IAEF,uCAAuC;IACvC,SAAS,+DAMN,eAAe,mBA2EhB;IAEF,eAAe,QAAS,WAAW,CAAC,CAAC,aAIa;IAG5C,kBAAkB,CAAC,GAAG,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,gBAAgB;IAgB3D,IAAc,qBAAqB,YAKlC;IAED,IAAc,sBAAsB,YAEnC;IAED,IAAc,iBAAiB,YAM9B;IAED,IAAc,kBAAkB,YAM/B;IAED,oBAAoB,OAAQ,cAAc,GAAG,IAAI,2BAAgC;IACjF,sBAAsB,OAAQ,WAAW,GAAG,IAAI,wBAAkC;IAElF,SAAS,sBAKP;IAEF,WAAW,gOAUT;IAEF,6BAA6B,+BAS3B;IAEF,cAAc,UAAW,WAAW,CAAC,CAAC,OAAO,WAAW,CAAC,CAAC,qBA6BxD;IAEF,WAAW,IAAI,eAAe,CAAC,GAAG,CAAC;IAcnC,WAAW,CAAC,IAAI,EAAE,eAAe,CAAC,GAAG,CAAC;CAUzC"}