@vuu-ui/vuu-utils 2.3.0 → 3.0.0-beta.1

package/types/data-editing/EditSession.d.ts

@@ -1,53 +0,0 @@
-import { CopyOption, DataSource, DeleteRowMode, EditApi, EditSessionMode } from "@vuu-ui/vuu-data-types";
-import type { VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
-import { EventEmitter } from "../event-emitter";
-export declare const isCopyOption: (mode?: EditSessionMode | CopyOption) => mode is CopyOption;
-export type EditState = "clean" | "dirty" | "invalid" | "stale";
-export declare class EditError extends Error {
-}
-type CellEdit = {
-    originalValue: VuuRowDataItemType;
-    editedValue: VuuRowDataItemType;
-    isValid?: boolean;
-    isDeleted?: boolean;
-};
-export declare class StaleUpdateError extends Error {
-}
-type RowEditDetails = {
-    /**
-     * Column name => cell edit details
-     */
-    cellEdits: Map<string, CellEdit>;
-};
-type EditSessionEvents = {
-    editState: (editState: EditState) => void;
-};
-export declare class EditSession extends EventEmitter<EditSessionEvents> {
-    #private;
-    constructor(dataSource: EditApi, deleteMode?: DeleteRowMode);
-    get editCount(): number;
-    set editCount(val: number);
-    get invalidCount(): number;
-    set invalidCount(val: number);
-    get deleteCount(): number;
-    set deleteCount(val: number);
-    get addCount(): number;
-    set addCount(val: number);
-    deleteSelectedRows(): Promise<void>;
-    addRows(count?: number, rowData?: Record<string, VuuRowDataItemType>): void;
-    restoreRows(keys: string[]): void;
-    hasRowChanges(key: string): boolean;
-    undoRowChange(key: string): Promise<void>;
-    clear(): void;
-    /** @deprecated Pass a `CopyOption` ("All" | "Empty" | "Selected") to use `createSessionDataSource` instead. Long-form `EditSessionMode` values will be removed in a future release. */
-    begin(mode: EditSessionMode): Promise<DataSource | undefined>;
-    begin(mode?: CopyOption): Promise<DataSource | undefined>;
-    get dataSource(): EditApi<import("@vuu-ui/vuu-data-types").DataSourceRow<VuuRowDataItemType>> | undefined;
-    end(saveChanges?: boolean, force?: boolean): Promise<void>;
-    get inEditMode(): boolean;
-    get editState(): EditState;
-    getOrCreateRowEdits(key: string): RowEditDetails;
-    storeCellEdit(cellEdits: Map<string, CellEdit>, column: string, originalValue: VuuRowDataItemType, editedValue: VuuRowDataItemType, isValid: boolean): CellEdit;
-    commit(key: string, columnName: string, originalValue: VuuRowDataItemType, typedValue: string | number | boolean, isValid: boolean): Promise<any>;
-}
-export {};

package/types/data-editing/edit-utils.d.ts

@@ -1,4 +0,0 @@
-import { EditSessionMode, InlineEditSessionMode } from "@vuu-ui/vuu-data-types";
-import { DataRow, RuntimeColumnDescriptor } from "@vuu-ui/vuu-table-types";
-export declare const isInlineEditingSession: (editSessionMode: EditSessionMode) => editSessionMode is InlineEditSessionMode;
-export declare const getVuuEditMessage: (dataRow: DataRow, column: RuntimeColumnDescriptor, originalValue: string) => import("react/jsx-runtime").JSX.Element | undefined;

package/types/data-editing/useEditableTable.d.ts

@@ -1,34 +0,0 @@
-import { CopyOption, DataSource, DeleteRowMode, EditSessionMode } from "@vuu-ui/vuu-data-types";
-import type { VuuTable } from "@vuu-ui/vuu-protocol-types";
-import { EditSession } from "./EditSession";
-export type EditMode = "edit" | "view";
-export interface EditableTableHookProps {
-    /**
-     * columns to be included in subscription. If not provided,
-     * default will be '*'. Ignored if dataSource prop present.
-     */
-    columns?: string[];
-    dataSource?: DataSource;
-    addRowsCount?: number;
-    deleteMode?: DeleteRowMode;
-    editSessionMode?: EditSessionMode | CopyOption;
-    isEditMode: boolean;
-    onCancel: () => void;
-    onSave: () => void;
-    /**
-     * If dataSource not provided, new DataSource
-     * will be created using table and columns
-     */
-    table?: VuuTable;
-}
-export declare const useEditableTable: ({ addRowsCount, columns, dataSource: dataSourceProp, deleteMode, editSessionMode, isEditMode, onCancel, onSave, table, }: EditableTableHookProps) => {
-    dataSource: DataSource;
-    editSession: EditSession;
-    hasSelection: boolean;
-    onAddRows: () => void;
-    onCancel: () => Promise<void>;
-    onDelete: () => Promise<void>;
-    onSave: (force?: boolean) => Promise<void>;
-    onUndoRowChange: (key: string) => undefined;
-    sessionDataSource: DataSource | undefined;
-};