@vuu-ui/vuu-data-types 0.9.0 → 0.9.2

package/index.d.ts

@@ -61,6 +61,7 @@ export declare type DataValueValidationResult =
 
 export declare type DataValueValidationChecker = (
   value?: VuuRowDataItemType,
+  phase: EditPhase | "*",
 ) => DataValueValidationResult;
 
 export declare type EditRuleValidationSuccessResult = {
@@ -90,6 +91,8 @@ export declare type EditRuleValidator = (
   value?: VuuRowDataItemType,
 ) => EditRuleValidationResult;
 
+export declare type EditPhase = "commit" | "change";
+
 /**
  * Edit validation functions (EditRuleValidator) must be registered with the component registry.
  * They can then be referenced by name from EditValidationRule(s)
@@ -97,10 +100,10 @@ export declare type EditRuleValidator = (
 export interface EditValidationRule {
   /**
    * when is the rule applied
-   * - 'commit' - when suer commits change, e.g. by pressent ENTER (on an input), or TAB
+   * - 'commit' - when user commits change, e.g. by pressent ENTER (on an input), or TAB
    * - 'change' - for a text input, on every keystroke
    * */
-  apply?: "commit" | "change";
+  phase?: EditPhase;
   name: string;
   message?: string;
   value?: string;
@@ -466,12 +469,15 @@ export declare type RowSelectionEventHandler = (
   selectedRowCount: number,
 ) => void;
 
+export type DataSourceConfigChangeHandler = (
+  config: WithBaseFilter<WithFullConfig>,
+  range: VuuRange,
+  confirmed?: boolean,
+  configChanges?: DataSourceConfigChanges,
+) => void;
+
 export declare type DataSourceEvents = {
-  config: (
-    config: DataSourceConfig | undefined,
-    confirmed?: boolean,
-    configChanges?: DataSourceConfigChanges,
-  ) => void;
+  config: DataSourceConfigChangeHandler;
   optimize: (optimize: OptimizeStrategy) => void;
   "page-count": (pageCount: number) => void;
   range: (range: VuuRange) => void;
@@ -576,9 +582,9 @@ export interface DataSource
      */
     preserveExistingConfigAttributes?: boolean,
   ) => DataSourceConfigChanges | undefined;
-  closeTreeNode: (key: string, cascade?: boolean) => void;
+  closeTreeNode: (keyOrIndex: string | number, cascade?: boolean) => void;
   columns: string[];
-  config: WithBaseFilter<DataSourceConfig>;
+  config: WithBaseFilter<WithFullConfig>;
   status: DataSourceStatus;
   /**
    *
@@ -627,6 +633,8 @@ export interface DataSource
    * @returns
    */
   getChildRows?: (rowKey: string) => DataSourceRow[];
+
+  getRowAtIndex?: (rowIndex: number) => DataSourceRow | undefined;
   /**
    * Only implemented on JSON DataSource
    * @param depth
@@ -634,7 +642,7 @@ export interface DataSource
    * @returns
    */
   getRowsAtDepth?: (depth: number, visibleOnly?: boolean) => DataSourceRow[];
-  groupBy: VuuGroupBy;
+  groupBy?: VuuGroupBy;
   insertRow?: DataSourceInsertHandler;
   links?: LinkDescriptorWithLabel[];
   menu?: VuuMenu;
@@ -646,7 +654,7 @@ export interface DataSource
   rpcCall?: <T extends VuuRpcResponse = VuuRpcResponse>(
     rpcRequest: Omit<VuuRpcRequest, "vpId">,
   ) => Promise<T>;
-  openTreeNode: (key: string) => void;
+  openTreeNode: (keyOrIndex: string | number) => void;
   range: VuuRange;
   remoteProcedureCall: <T extends VuuRpcResponse = VuuRpcResponse>(
     message: VuuRpcRequest,
@@ -849,7 +857,8 @@ export interface VuuUIMessageOutViewRange extends ViewportMessageOut {
   };
 }
 export interface VuuUIMessageOutCloseTreeNode extends ViewportMessageOut {
-  key: string;
+  index?: number;
+  key?: string;
   type: "closeTreeNode";
 }
 export interface VuuUIMessageOutRemoveLink extends ViewportMessageOut {
@@ -867,7 +876,8 @@ export interface VuuUIMessageOutEnable extends ViewportMessageOut {
   type: "enable";
 }
 export interface VuuUIMessageOutOpenTreeNode extends ViewportMessageOut {
-  key: string;
+  index?: number;
+  key?: string;
   type: "openTreeNode";
 }
 export interface VuuUIMessageOutResume extends ViewportMessageOut {

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@vuu-ui/vuu-data-types",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "author": "heswell",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@vuu-ui/vuu-filter-types": "0.9.0",
-    "@vuu-ui/vuu-protocol-types": "0.9.0"
+    "@vuu-ui/vuu-filter-types": "0.9.2",
+    "@vuu-ui/vuu-protocol-types": "0.9.2"
   },
   "dependencies": {},
   "peerDependencies": {},