@vuu-ui/vuu-data-editing 3.4.0 → 3.4.1

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.4.0",
+  "version": "3.4.1",
   "description": "Shared data editing APIs and React components for VUU UI",
   "main": "./src/index.js",
   "author": "heswell",
@@ -12,13 +12,13 @@
   },
   "dependencies": {
     "@salt-ds/core": "1.54.1",
-    "@vuu-ui/vuu-ui-controls": "3.4.0",
-    "@vuu-ui/vuu-utils": "3.4.0"
+    "@vuu-ui/vuu-ui-controls": "3.4.1",
+    "@vuu-ui/vuu-utils": "3.4.1"
   },
   "devDependencies": {
-    "@vuu-ui/vuu-data-types": "3.4.0",
-    "@vuu-ui/vuu-protocol-types": "3.4.0",
-    "@vuu-ui/vuu-table-types": "3.4.0"
+    "@vuu-ui/vuu-data-types": "3.4.1",
+    "@vuu-ui/vuu-protocol-types": "3.4.1",
+    "@vuu-ui/vuu-table-types": "3.4.1"
   },
   "peerDependencies": {
     "react": "^19.2.3"

package/src/DataEditingProvider.js

@@ -1,5 +1,6 @@
 import { jsx } from "react/jsx-runtime";
 import { createContext, useContext } from "react";
+import { EditSession } from "./EditSession.js";
 const DataEditingContext = /*#__PURE__*/ createContext(void 0);
 const DataEditingProvider = ({ children, editSession })=>/*#__PURE__*/ jsx(DataEditingContext.Provider, {
         value: editSession,
@@ -7,7 +8,8 @@ const DataEditingProvider = ({ children, editSession })=>/*#__PURE__*/ jsx(DataE
     });
 function useEditSession(throwIfUnavailable = false) {
     const editSession = useContext(DataEditingContext);
-    if (void 0 !== editSession) return editSession;
-    if (throwIfUnavailable) throw Error("[useEditSession] no DataEditingContext in scope. You need to enclose editable component(s) with DataEditingProvider");
+    if (editSession instanceof EditSession) return editSession;
+    if (throwIfUnavailable) throw Error(void 0 === editSession ? "[useEditSession] no DataEditingContext in scope. You need to enclose editable component(s) with DataEditingProvider" : "[useEditSession] DataEditingProvider does not provide an EditSession");
 }
-export { DataEditingProvider, useEditSession };
+const useTableEditSession = ()=>useContext(DataEditingContext);
+export { DataEditingProvider, useEditSession, useTableEditSession };

package/src/DirectEditSession.js

@@ -0,0 +1,35 @@
+import { EventEmitter } from "@vuu-ui/vuu-utils";
+class DirectEditSession extends EventEmitter {
+    #dataSource;
+    constructor({ dataSource }){
+        super();
+        this.#dataSource = dataSource;
+    }
+    get dataSource() {
+        return this.#dataSource;
+    }
+    get inEditMode() {
+        return false;
+    }
+    isCellEdited(_key, _columnName) {
+        return false;
+    }
+    async cancel(_key, _columnName, _restoredValue) {
+        return {
+            data: void 0,
+            type: "SUCCESS_RESULT"
+        };
+    }
+    async commit(key, columnName, _originalValue, typedValue, isValid) {
+        if (!isValid) return {
+            errorMessage: "Invalid value",
+            type: "ERROR_RESULT"
+        };
+        const editCell = this.#dataSource.editCell;
+        if (void 0 === editCell) throw Error("[DirectEditSession] datasource does not support editCell");
+        const response = await editCell.call(this.#dataSource, key, columnName, typedValue);
+        if (void 0 === response) throw Error("[DirectEditSession] datasource returned no response from editCell");
+        return response;
+    }
+}
+export { DirectEditSession };

package/src/EditSession.js

@@ -471,6 +471,15 @@ class EditSession extends EventEmitter {
     #isLatestCellCommit(key, columnName, revision) {
         return this.#cellCommitRevisions.get(key)?.get(columnName) === revision;
     }
+    async cancel(key, columnName, restoredValue) {
+        const cellEdits = this.#rowEdits.get(key)?.cellEdits;
+        const cellEdit = cellEdits?.get(columnName);
+        if (this.inEditMode && cellEdits && cellEdit && !cellEdit.isValid) this.#storeCellEdit(key, cellEdits, columnName, cellEdit.originalValue, restoredValue, true);
+        return {
+            data: void 0,
+            type: "SUCCESS_RESULT"
+        };
+    }
     async commit(key, columnName, originalValue, typedValue, isValid) {
         if ("active" !== this.#lifecycle.status && !("error" === this.#lifecycle.status && "end" === this.#lifecycle.operation)) throw new Error("No edit session in progress");
         const revision = this.#setCellCommitRevision(key, columnName);

package/src/edit-utils.js

@@ -4,7 +4,7 @@ const timeFormatter = formatDate({
     time: "hh:mm:ss"
 });
 const dataRowEditErrors = Symbol("vuuDataRowEditErrors");
-const isEditRowReadOnly = (dataRow)=>"deleteRow" === dataRow.vuuAction;
+const isEditRowReadOnly = (dataRow)=>dataRow.hasColumn("vuuAction") && "deleteRow" === dataRow.vuuAction;
 const withDataRowEditErrors = (dataRow, errors)=>{
     Object.defineProperty(dataRow, dataRowEditErrors, {
         configurable: true,

package/src/index.js

@@ -1,4 +1,5 @@
-export { DataEditingProvider, useEditSession } from "./DataEditingProvider.js";
+export { DataEditingProvider, useEditSession, useTableEditSession } from "./DataEditingProvider.js";
+export { DirectEditSession } from "./DirectEditSession.js";
 export { useCellEdited } from "./useCellEdited.js";
 export { useEditState } from "./useEditState.js";
 export { getVuuEditMessage, isEditRowReadOnly, isInlineEditingSession, withDataRowEditErrors } from "./edit-utils.js";

package/types/DataEditingProvider.d.ts

@@ -1,8 +1,20 @@
 import { type ReactNode } from "react";
-import type { EditSession } from "./EditSession";
+import { EditSession } from "./EditSession";
+import type { TableEditSession } from "./TableEditSession";
 export declare const DataEditingProvider: ({ children, editSession, }: {
     children: ReactNode;
-    editSession: EditSession;
+    editSession: TableEditSession;
 }) => import("react/jsx-runtime").JSX.Element;
+/**
+ * Returns the EditSession provided by an enclosing DataEditingProvider. If the
+ * provider holds some other TableEditSession (e.g. DirectEditSession), there is
+ * no EditSession in scope and undefined is returned.
+ */
 export declare function useEditSession(throwIfUnavailable?: false): EditSession | undefined;
 export declare function useEditSession(throwIfUnavailable: true): EditSession;
+/**
+ * Returns whichever TableEditSession is provided by an enclosing
+ * DataEditingProvider. Intended for use by Table cells, which commit and
+ * cancel edits regardless of the type of session.
+ */
+export declare const useTableEditSession: () => TableEditSession | undefined;

package/types/DirectEditSession.d.ts

@@ -0,0 +1,22 @@
+import type { DataSource } from "@vuu-ui/vuu-data-types";
+import type { RpcResult, VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
+import { EventEmitter } from "@vuu-ui/vuu-utils";
+import type { TableEditSession, TableEditSessionEvents } from "./TableEditSession";
+export type DirectEditSessionConstructorProps = {
+    dataSource: DataSource;
+};
+/**
+ * A lightweight edit session for services that allow cells to be edited
+ * directly on the source table. There is no begin/end lifecycle, no session
+ * table and no local tracking of edits - each committed edit is sent
+ * immediately via the dataSource editCell RPC.
+ */
+export declare class DirectEditSession extends EventEmitter<TableEditSessionEvents> implements TableEditSession {
+    #private;
+    constructor({ dataSource }: DirectEditSessionConstructorProps);
+    get dataSource(): DataSource;
+    get inEditMode(): boolean;
+    isCellEdited(_key: string, _columnName: string): boolean;
+    cancel(_key: string, _columnName: string, _restoredValue: VuuRowDataItemType): Promise<RpcResult>;
+    commit(key: string, columnName: string, _originalValue: VuuRowDataItemType, typedValue: string | number | boolean, isValid: boolean): Promise<RpcResult>;
+}

package/types/EditSession.d.ts

@@ -1,6 +1,7 @@
 import type { CopyOption, DataSource, DeleteRowMode, SessionType } from "@vuu-ui/vuu-data-types";
 import type { RpcResult, VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
 import { EventEmitter } from "@vuu-ui/vuu-utils";
+import type { TableEditSession } from "./TableEditSession";
 export type EditState = "clean" | "dirty" | "invalid" | "stale";
 export type EditActionType = "deleteRow" | "addRow" | "editCell";
 /** Column name to default value mapping applied to every addRow call when a column is absent from the row data. */
@@ -49,7 +50,7 @@ type EditSessionEvents = {
     lifecycle: (lifecycle: EditLifecycle) => void;
     newRow: (newRowState: NewRowState) => void;
 };
-export declare class EditSession extends EventEmitter<EditSessionEvents> {
+export declare class EditSession extends EventEmitter<EditSessionEvents> implements TableEditSession {
     #private;
     static readonly newRowKey = "__vuu_new_row__";
     constructor({ dataSource, deleteMode, editSessionApi, rowDefaults, }: EditSessionConstructorProps);
@@ -82,6 +83,7 @@ export declare class EditSession extends EventEmitter<EditSessionEvents> {
     end(saveChanges?: boolean, force?: boolean): Promise<void>;
     get lifecycle(): EditLifecycle;
     get inEditMode(): boolean;
+    cancel(key: string, columnName: string, restoredValue: VuuRowDataItemType): Promise<RpcResult>;
     commit(key: string, columnName: string, originalValue: VuuRowDataItemType, typedValue: string | number | boolean, isValid: boolean): Promise<RpcResult>;
 }
 export {};

package/types/TableEditSession.d.ts

@@ -0,0 +1,28 @@
+import type { RpcResult, VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
+export type TableEditSessionEvents = {
+    cellEditChanged: (key: string, columnName: string) => void;
+};
+/**
+ * The subset of edit session behaviour consumed by Table and its cells.
+ * Implemented by EditSession (edits staged in a session table, committed or
+ * discarded at end of session) and DirectEditSession (edits applied directly
+ * to the source table).
+ */
+export interface TableEditSession {
+    /**
+     * True while a staged edit session is in progress. Always false for
+     * DirectEditSession.
+     */
+    readonly inEditMode: boolean;
+    commit(key: string, columnName: string, originalValue: VuuRowDataItemType, typedValue: string | number | boolean, isValid: boolean): Promise<RpcResult>;
+    /**
+     * Invoked when user abandons an in-progress cell edit, restoring the value
+     * the cell held before editing began. Values that have only been typed, not
+     * committed, have never been sent to the server, so nothing is sent here.
+     * Any invalid edit previously recorded for the cell is discarded.
+     */
+    cancel(key: string, columnName: string, restoredValue: VuuRowDataItemType): Promise<RpcResult>;
+    isCellEdited(key: string, columnName: string): boolean;
+    on<E extends keyof TableEditSessionEvents>(event: E, listener: TableEditSessionEvents[E]): void;
+    removeListener<E extends keyof TableEditSessionEvents>(event: E, listener: TableEditSessionEvents[E]): void;
+}

package/types/edit-field/EditField.d.ts

@@ -0,0 +1,21 @@
+import type { DataRow } from "@vuu-ui/vuu-table-types";
+import type { VuuTable } from "@vuu-ui/vuu-protocol-types";
+import { type OptionMap } from "../lookup-values/useLookupValues";
+import "./EditField.css";
+export type TextFieldType = "email" | "password";
+export type EditFieldType = "checkbox" | "dropdown" | TextFieldType;
+export interface EditFieldProps {
+    dataRow: DataRow;
+    deferNewRow?: boolean;
+    label: string;
+    name: string;
+    readOnly?: boolean;
+    required?: boolean;
+    type?: EditFieldType;
+}
+export interface DropdownEditFieldProps extends EditFieldProps {
+    type: "dropdown";
+    optionMap: OptionMap;
+    table: VuuTable;
+}
+export declare const EditField: ({ dataRow, deferNewRow, label, name, readOnly, required, type, ...options }: EditFieldProps | DropdownEditFieldProps) => import("react").JSX.Element;

package/types/edit-field/useEditField.d.ts

@@ -0,0 +1,26 @@
+import type { VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
+import type { RuntimeColumnDescriptor, TableCellEditHandler } from "@vuu-ui/vuu-table-types";
+import { type ChangeEventHandler, type FocusEventHandler, type KeyboardEvent, type SyntheticEvent } from "react";
+import type { LookupOption } from "../lookup-values/useLookupValues";
+import type { TextFieldType } from "./EditField";
+export interface EditFieldHookProps<T extends VuuRowDataItemType = VuuRowDataItemType> {
+    column: Pick<RuntimeColumnDescriptor, "clientSideEditValidationCheck" | "label" | "name">;
+    value?: T;
+    onEdit?: TableCellEditHandler;
+    textType?: TextFieldType;
+    type?: "string" | "number" | "boolean";
+}
+export declare const useEditField: <T extends string | number | boolean = string>({ column, value, onEdit, textType, type, }: EditFieldHookProps<T>) => {
+    editing: boolean;
+    inputProps: {
+        onBlur: FocusEventHandler<HTMLElement>;
+        onFocus: FocusEventHandler<HTMLElement>;
+        type: TextFieldType | undefined;
+    };
+    onKeyDown: (evt: KeyboardEvent<HTMLElement>) => Promise<void>;
+    previousValue: string | undefined;
+    value: string;
+    warningMessage: string | undefined;
+    onChange: ChangeEventHandler;
+    onDropdownSelectionChange: (_evt: SyntheticEvent, [selectedOption]: LookupOption[]) => void;
+};

package/types/index.d.ts

@@ -1,4 +1,6 @@
-export { DataEditingProvider, useEditSession } from "./DataEditingProvider";
+export { DataEditingProvider, useEditSession, useTableEditSession, } from "./DataEditingProvider";
+export { DirectEditSession, type DirectEditSessionConstructorProps, } from "./DirectEditSession";
+export type { TableEditSession, TableEditSessionEvents, } from "./TableEditSession";
 export { useCellEdited } from "./useCellEdited";
 export { useEditState } from "./useEditState";
 export { getVuuEditMessage, isInlineEditingSession, isEditRowReadOnly, withDataRowEditErrors, } from "./edit-utils";

package/types/lookup-values/useLookupValues.d.ts

@@ -0,0 +1,19 @@
+import type { DataSourceRow } from "@vuu-ui/vuu-data-types";
+import type { VuuTable } from "@vuu-ui/vuu-protocol-types";
+export type LookupOption = {
+    label: string;
+    metadata?: Record<string, string>;
+    value: number | string;
+};
+export type OptionMap = {
+    additionalFields?: readonly string[];
+    label: string;
+    value: string;
+};
+export interface LookupValuedHookProps {
+    enabled: boolean;
+    optionMap?: OptionMap;
+    table?: VuuTable;
+}
+export declare const lookupOptionsFromRows: (columns: string[], rows: DataSourceRow[], optionMap: OptionMap) => LookupOption[];
+export declare const useLookupValues: ({ enabled, optionMap, table, }: LookupValuedHookProps) => LookupOption[];

package/types/src/DataEditingProvider.d.ts

@@ -0,0 +1,8 @@
+import { type ReactNode } from "react";
+import type { EditSession } from "./EditSession";
+export declare const DataEditingProvider: ({ children, editSession, }: {
+    children: ReactNode;
+    editSession: EditSession;
+}) => import("react").JSX.Element;
+export declare function useEditSession(throwIfUnavailable?: false): EditSession | undefined;
+export declare function useEditSession(throwIfUnavailable: true): EditSession;

package/types/src/EditButtons.d.ts

@@ -0,0 +1,14 @@
+import type { EditSession } from "./EditSession";
+export interface EditButtonProps {
+    canCancel: boolean;
+    canSave: boolean;
+    editSession?: EditSession;
+    hasSelection?: boolean;
+    onCancel?: () => void;
+    onDelete?: () => void;
+    onSave: (force?: boolean) => void;
+    saveLabel?: string;
+    confirmSave?: () => boolean | Promise<boolean>;
+    confirmCancel?: () => boolean | Promise<boolean>;
+}
+export declare const EditButtons: ({ canCancel, canSave, confirmCancel, confirmSave, editSession, hasSelection, onCancel, onDelete, onSave, saveLabel, }: EditButtonProps) => import("react").JSX.Element;

package/types/src/EditModeProvider.d.ts

@@ -0,0 +1,13 @@
+import { ReactNode } from "react";
+export interface EditModeContextProps {
+    isEditMode: boolean;
+    setEditMode: (inEditMode: boolean) => void;
+}
+/**
+ * Implemented as a standalone Provider so that EditMode cna be implemented
+ * at higher level than individual edit controls.
+ */
+export declare const EditModeProvider: ({ children }: {
+    children: ReactNode;
+}) => import("react").JSX.Element;
+export declare const useEditMode: () => EditModeContextProps;

package/types/src/EditSession.d.ts

@@ -0,0 +1,86 @@
+import type { CopyOption, DataSource, DeleteRowMode, SessionType } from "@vuu-ui/vuu-data-types";
+import type { RpcResult, VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
+import { EventEmitter } from "@vuu-ui/vuu-utils";
+export type EditState = "clean" | "dirty" | "invalid" | "stale";
+export type EditActionType = "deleteRow" | "addRow" | "editCell";
+/** Column name to default value mapping applied to every addRow call when a column is absent from the row data. */
+export type RowDefaultDataItemValues = Record<string, VuuRowDataItemType>;
+export type EditSessionApi = "createSessionDataSource" | "beginEditSession";
+export type EditSessionConstructorProps = {
+    dataSource: DataSource;
+    /** @default "soft" */
+    deleteMode?: DeleteRowMode;
+    /** @default "createSessionDataSource" */
+    editSessionApi?: EditSessionApi;
+    /** Default column values merged into every addRow call for absent columns. Pass a stable reference. */
+    rowDefaults?: RowDefaultDataItemValues;
+};
+export type NewRowState = {
+    columns: readonly string[];
+    requiredColumns?: readonly string[];
+    draftRevision: number;
+    errors: Readonly<Record<string, string>>;
+    submitting: boolean;
+    values: Readonly<Record<string, VuuRowDataItemType>>;
+};
+export type EditLifecycle = {
+    status: "idle";
+} | {
+    status: "starting";
+} | {
+    status: "active";
+    sessionDataSource: DataSource;
+} | {
+    status: "ending";
+    sessionDataSource: DataSource;
+} | {
+    status: "error";
+    operation: "begin" | "end";
+    error: Error;
+    sessionDataSource?: DataSource;
+};
+export declare class EditError extends Error {
+}
+export declare class SupersededEditError extends Error {
+}
+type EditSessionEvents = {
+    cellEditChanged: (key: string, columnName: string) => void;
+    editState: (editState: EditState) => void;
+    lifecycle: (lifecycle: EditLifecycle) => void;
+    newRow: (newRowState: NewRowState) => void;
+};
+export declare class EditSession extends EventEmitter<EditSessionEvents> {
+    #private;
+    static readonly newRowKey = "__vuu_new_row__";
+    constructor({ dataSource, deleteMode, editSessionApi, rowDefaults, }: EditSessionConstructorProps);
+    get editCount(): number;
+    get invalidCount(): number;
+    get deleteCount(): number;
+    get addCount(): number;
+    get editState(): EditState;
+    get newRowState(): NewRowState;
+    isNewRow(key: string): key is "__vuu_new_row__";
+    isNewRowFinalColumn(columnName: string): boolean;
+    isNewRowComplete(): boolean;
+    configureNewRow(columns: readonly string[], requiredColumns?: readonly string[]): void;
+    setNewRowValue(column: string, value: VuuRowDataItemType): void;
+    addNewRow(): Promise<RpcResult>;
+    deleteSelectedRows(): Promise<RpcResult>;
+    addRow(rowData?: Record<string, VuuRowDataItemType>): Promise<RpcResult>;
+    hasRowChanges(key: string): boolean;
+    isCellEdited(key: string, columnName: string): boolean;
+    undoRowChange(key: string, action: EditActionType): Promise<RpcResult | undefined>;
+    begin(copyOption?: CopyOption, sessionType?: SessionType): Promise<DataSource>;
+    /**
+     * Safe to call repeatedly - schema of a remote session table typically arrives
+     * after begin() resolves, so callers re-invoke this once 'subscribed' fires.
+     */
+    reconcileWithSessionSchema(): void;
+    get dataSource(): import("@vuu-ui/vuu-data-types").DataSourceBase<import("@vuu-ui/vuu-data-types").DataSourceRowWithBigint> | undefined;
+    get sessionDataSource(): DataSource | undefined;
+    end(saveChanges?: boolean, force?: boolean): Promise<void>;
+    get lifecycle(): EditLifecycle;
+    get inEditMode(): boolean;
+    commit(key: string, columnName: string, originalValue: VuuRowDataItemType, typedValue: string | number | boolean, isValid: boolean): Promise<RpcResult>;
+}
+export {};

package/types/src/UndoCellRenderer.d.ts

@@ -0,0 +1,12 @@
+import type { TableCellRendererProps } from "@vuu-ui/vuu-table-types";
+export declare const UNDO_CELL_RENDERER = "vuu.undo-cell";
+export interface UndoCellRendererComponentProps {
+    icon?: string;
+    text?: string | false;
+}
+export declare const getUndoButtonContent: (componentProps?: UndoCellRendererComponentProps) => {
+    icon: string | undefined;
+    text: string | undefined;
+};
+export declare const getUndoTooltipContent: (action: unknown) => "Undo delete row" | "Undo insert row" | "Undo row edits" | undefined;
+export declare const UndoCellRenderer: ({ column, dataRow, }: TableCellRendererProps) => import("react").JSX.Element | null;

package/types/src/edit-utils.d.ts

@@ -0,0 +1,5 @@
+import type { DataRow, RuntimeColumnDescriptor } from "@vuu-ui/vuu-table-types";
+export { isInlineEditingSession } from "@vuu-ui/vuu-utils";
+export declare const isEditRowReadOnly: (dataRow: DataRow) => boolean;
+export declare const withDataRowEditErrors: <T extends DataRow>(dataRow: T, errors: Record<string, string>) => T;
+export declare const getVuuEditMessage: (dataRow: DataRow, column: RuntimeColumnDescriptor, originalValue: string) => string | import("react").JSX.Element | undefined;

package/types/src/editActionRowClassNameGenerator.d.ts

@@ -0,0 +1,3 @@
+import type { DataRow } from "@vuu-ui/vuu-table-types";
+export declare const EDIT_ACTION_ROW_CLASS_NAME_GENERATOR = "vuu-edit-actions";
+export declare const editActionRowClassNameGenerator: (dataRow: DataRow) => "vuuTableRow-deleted" | "vuuTableRow-inserted" | undefined;

package/types/src/index.d.ts

@@ -0,0 +1,10 @@
+export { DataEditingProvider, useEditSession } from "./DataEditingProvider";
+export { useCellEdited } from "./useCellEdited";
+export { getVuuEditMessage, isInlineEditingSession, isEditRowReadOnly, withDataRowEditErrors, } from "./edit-utils";
+export { EditButtons, type EditButtonProps } from "./EditButtons";
+export { EditModeProvider, useEditMode, type EditModeContextProps, } from "./EditModeProvider";
+export { EditError, EditSession, SupersededEditError, type EditActionType, type EditLifecycle, type EditSessionConstructorProps, type NewRowState, type EditState, type RowDefaultDataItemValues, } from "./EditSession";
+export { StaleUpdateError } from "@vuu-ui/vuu-utils";
+export { EDIT_ACTION_ROW_CLASS_NAME_GENERATOR, editActionRowClassNameGenerator, } from "./editActionRowClassNameGenerator";
+export { getUndoButtonContent, getUndoTooltipContent, UNDO_CELL_RENDERER, UndoCellRenderer, type UndoCellRendererComponentProps, } from "./UndoCellRenderer";
+export { useEditableTable, type EditableTableHookProps, type EditMode, } from "./useEditableTable";

package/types/src/useCellEdited.d.ts

@@ -0,0 +1,2 @@
+import type { EditSession } from "./EditSession";
+export declare const useCellEdited: (editSession: EditSession | undefined, key: string, columnName: string) => boolean;

package/types/src/useEditableTable.d.ts

@@ -0,0 +1,44 @@
+import type { CopyOption, DataSource, DeleteRowMode } from "@vuu-ui/vuu-data-types";
+import type { VuuTable } from "@vuu-ui/vuu-protocol-types";
+import { EditSession, type EditActionType, type EditLifecycle, type EditSessionApi, type RowDefaultDataItemValues } 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;
+    editSessionApi?: EditSessionApi;
+    copyOption?: CopyOption;
+    isEditMode: boolean;
+    onCancel: () => void;
+    onSave: () => void;
+    /** Default column values applied to every addRow call. Pass a stable reference — a new object triggers EditSession recreation. */
+    rowDefaults?: RowDefaultDataItemValues;
+    /**
+     * If dataSource not provided, new DataSource
+     * will be created using table and columns
+     */
+    table?: VuuTable;
+}
+export declare const useEditableTable: ({ columns, dataSource: dataSourceProp, deleteMode, editSessionApi, copyOption, isEditMode, onCancel, onSave, rowDefaults, table, }: EditableTableHookProps) => {
+    canCancel: boolean;
+    canSave: boolean;
+    columnsDiverge: boolean;
+    dataSource: DataSource;
+    editSchema: import("@vuu-ui/vuu-data-types").TableSchema | undefined;
+    editSession: EditSession;
+    lifecycle: EditLifecycle;
+    hasSelection: boolean;
+    isEditSessionReady: boolean;
+    onCancel: () => Promise<void>;
+    onDelete: () => Promise<void>;
+    onSave: (force?: boolean) => Promise<void>;
+    onUndoRowChange: (key: string, action: EditActionType) => undefined;
+    rowClassNameGenerators: string[] | undefined;
+    sessionDataSource: import("@vuu-ui/vuu-data-types").DataSourceBase<import("@vuu-ui/vuu-data-types").DataSourceRowWithBigint> | undefined;
+    sourceDataSource: DataSource;
+};

package/types/useCellEdited.d.ts

@@ -1,2 +1,2 @@
-import type { EditSession } from "./EditSession";
-export declare const useCellEdited: (editSession: EditSession | undefined, key: string, columnName: string) => boolean;
+import type { TableEditSession } from "./TableEditSession";
+export declare const useCellEdited: (editSession: TableEditSession | undefined, key: string, columnName: string) => boolean;

package/types/useEditable.d.ts

@@ -0,0 +1,13 @@
+import type { CopyOption, DataSource } from "@vuu-ui/vuu-data-types";
+import { EditSession } from ".";
+export interface EditableHookProps {
+    copyOption?: CopyOption;
+    dataSource: DataSource;
+    onCancel: () => void;
+    onSave: () => void;
+}
+export declare const useEditable: ({ copyOption, dataSource, onCancel, onSave }: EditableHookProps) => {
+    editSession: EditSession;
+    onCancel: () => Promise<void>;
+    onSave: (force?: boolean) => Promise<void>;
+};