@vuu-ui/vuu-data-types 2.1.19-beta.2 → 2.1.19-beta.4

package/index.d.ts

@@ -188,7 +188,9 @@ export declare type IsSelected = number;
 type Timestamp = number;
 type IsNew = boolean;
 
-export declare type DataSourceRow = [
+export declare type DataSourceRow<
+  T extends bigint | VuuRowDataItemType = VuuRowDataItemType,
+> = [
   RowIndex,
   RenderKey,
   IsLeaf,
@@ -199,9 +201,13 @@ export declare type DataSourceRow = [
   IsSelected,
   Timestamp,
   IsNew,
-  ...VuuRowDataItemType[],
+  ...T[],
 ];
 
+export declare type DataSourceRowWithBigint = DataSourceRow<
+  bigint | VuuRowDataItemType
+>;
+
 export declare type DataSourceRowObject = {
   index: number;
   key: string;
@@ -381,6 +387,7 @@ export declare type ConfigChangeMessage =
 export declare type ConfigChangeHandler = (msg: ConfigChangeMessage) => void;
 
 export declare type SchemaColumn = {
+  editable?: boolean;
   name: string;
   serverDataType: VuuColumnDataType;
 };
@@ -496,8 +503,17 @@ export declare type DataSourceEvents = {
   "visual-link-removed": () => void;
 };
 
+/**
+ * Controls how a row deletion is applied.
+ * - `"soft"` - marks the row as pending deletion (e.g. sets `vuuMsg` to `"SOFT_DELETED"`)
+ *   without removing it from the table. The deletion is only committed when the edit
+ *   session ends with `saveChanges = true`.
+ * - `"hard"` - removes the row from the table immediately and irreversibly.
+ */
+export declare type DeleteRowMode = "soft" | "hard";
 export declare type DataSourceDeleteHandler = (
   key: string,
+  mode?: DeleteRowMode,
 ) => Promise<true | string>;
 export declare type DataSourceInsertHandler = (
   key: string,
@@ -558,6 +574,7 @@ export declare type DataSourceSuspenseProps = {
  * the existing component. e.g. directly edit cells within a table.
  */
 export declare type InlineEditSessionMode = "inline-all-rows";
+
 /**
  * A standalone edit session re-renders editable data in an edit component.
  * e.g an edit panel may be displayed in a dialog.
@@ -566,27 +583,79 @@ export declare type StandaloneEditSessionMode =
   | "selected-rows"
   | "all-rows"
   | "empty-session-table";
+
+/**
+ * Short-form values accepted by the beginEditSession RPC (remote and local).
+ * The client-side EditApi maps the long-form StandaloneEditSessionMode values
+ * to one of these before dispatching the RPC call:
+ * - `"All"`      ← `"all-rows"`
+ * - `"Empty"`    ← `"empty-session-table"`
+ * - `"Selected"` ← `"selected-rows"`
+ * `"inline-all-rows"` is a client-only concept and is NOT mapped — it passes
+ * through to the RPC unchanged so the server can create an all-rows session table.
+ */
+export declare type CopyOption = "All" | "Empty" | "Selected";
+/**
+ * @deprecated Prefer `CopyOption` ("All" | "Empty" | "Selected") for standalone
+ * edit sessions supported by vuu server. Long-form values (e.g. `"all-rows"`) are used 
+ * by `beginEditSession`; new code should use `CopyOption` with `createSessionDataSource`.
+ */
 export declare type EditSessionMode =
   | InlineEditSessionMode
   | StandaloneEditSessionMode;
 
-export interface EditApi {
+export interface EditApi<
+  T extends DataSourceRow | DataSourceRowWithBigint = DataSourceRow,
+> {
   beginEditSession?: (
     editSessionMode?: EditSessionMode,
-  ) => Promise<DataSource | undefined>;
+  ) => Promise<DataSource<T> | undefined>;
+  addRow?: (
+    rowData?: Record<string, VuuRowDataItemType>,
+  ) => Promise<RpcResult> | undefined;
+  deleteRow?: (
+    key: string,
+    mode?: DeleteRowMode,
+  ) => Promise<RpcResult> | undefined;
+  deleteSelectedRows?: (mode?: DeleteRowMode) => Promise<RpcResult> | undefined;
   editCell?: (
     rowKey: string,
-    colun: string,
+    column: string,
     value: VuuRowDataItemType,
   ) => Promise<RpcResult> | undefined;
+  undoRowChange?: (key: string) => Promise<RpcResult> | undefined;
+  /**
+   * Create a session datasource by requesting the server to create a session table
+   * via the `createSessionTable` RPC and wrapping the returned table.
+   */
+  createSessionDataSource?: (
+    copyOption: CopyOption,
+  ) => Promise<DataSource<T> | undefined>;
   endEditSession?: (
     saveChanges?: boolean,
     force?: boolean,
   ) => Promise<RpcResult> | undefined;
 }
 
-export interface DataSource
-  extends EditApi,
+/**
+ * Data payload returned in RpcResultSuccess.data by the beginEditSession service.
+ * Contains the server-assigned session table reference used to create the session datasource.
+ */
+export declare type BeginEditSessionResult = {
+  table: VuuTable;
+};
+
+export declare type DeleteSelectedRowsResult = {
+  deletedKeys: string[];
+};
+
+export declare type UndoRowChangeResult = {
+  wasInsertedRow?: boolean;
+};
+
+export interface DataSourceBase<
+  T extends DataSourceRow | DataSourceRowWithBigint = DataSourceRow,
+> extends EditApi<T>,
     IEventEmitter<DataSourceEvents>,
     Partial<TypeaheadSuggestionProvider> {
   aggregations: VuuAggregation[];
@@ -632,13 +701,6 @@ export interface DataSource
   resume?: (callback?: DataSourceSubscribeCallback) => void;
 
   deleteRow?: DataSourceDeleteHandler;
-  /**
-   * create a DataSource on a session table. The concrete DataSource implementation that
-   * implements this method will always return a session table datasource of the same concrete type.
-   * @param table the sessionTable  (module and table name)
-   * @returns
-   */
-  createSessionDataSource?: (table: VuuTable) => DataSource;
   /**
    * For a dataSource that has been previously disabled and is currently in disabled state , this will restore
    * the subscription to active status. Fresh data will be dispatched to client. The enable call optionally
@@ -676,16 +738,16 @@ export interface DataSource
    * @param visibleOnly
    * @returns
    */
-  getChildRows?: (rowKey: string) => DataSourceRow[];
+  getChildRows?: (rowKey: string) => T[];
 
-  getRowAtIndex?: (rowIndex: number) => DataSourceRow | undefined;
+  getRowAtIndex?: (rowIndex: number) => T | undefined;
   /**
    * Only implemented on JSON DataSource
    * @param depth
    * @param visibleOnly
    * @returns
    */
-  getRowsAtDepth?: (depth: number, visibleOnly?: boolean) => DataSourceRow[];
+  getRowsAtDepth?: (depth: number, visibleOnly?: boolean) => T[];
   groupBy?: VuuGroupBy;
   insertRow?: DataSourceInsertHandler;
   links?: LinkDescriptorWithLabel[];
@@ -719,6 +781,10 @@ export interface DataSource
   visualLink?: LinkDescriptorWithLabel;
 }
 
+export declare type DataSource =
+  | DataSourceBase
+  | DataSourceBase<DataSourceRowWithBigint>;
+
 export interface MenuRpcResponse<
   TAction extends MenuRpcAction = MenuRpcAction,
 > {

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@vuu-ui/vuu-data-types",
-  "version": "2.1.19-beta.2",
+  "version": "2.1.19-beta.4",
   "author": "heswell",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@vuu-ui/vuu-filter-types": "2.1.19-beta.2",
-    "@vuu-ui/vuu-protocol-types": "2.1.19-beta.2"
+    "@vuu-ui/vuu-filter-types": "2.1.19-beta.4",
+    "@vuu-ui/vuu-protocol-types": "2.1.19-beta.4"
   },
   "dependencies": {},
   "peerDependencies": {},