@vuu-ui/vuu-utils 0.8.8-debug → 0.8.9-debug

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@vuu-ui/vuu-utils",
-  "version": "0.8.8-debug",
+  "version": "0.8.9-debug",
   "author": "heswell",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@vuu-ui/vuu-datagrid-types": "0.8.8-debug",
-    "@vuu-ui/vuu-filter-types": "0.8.8-debug",
-    "@vuu-ui/vuu-protocol-types": "0.8.8-debug"
+    "@vuu-ui/vuu-datagrid-types": "0.8.9-debug",
+    "@vuu-ui/vuu-filter-types": "0.8.9-debug",
+    "@vuu-ui/vuu-protocol-types": "0.8.9-debug"
   },
   "peerDependencies": {
     "react": "^17.0.2",

package/types/array-utils.d.ts

@@ -2,4 +2,5 @@ export type PartitionTest<T> = (value: T, index: number) => boolean;
 export declare function partition<T>(array: T[], test: PartitionTest<T>, pass?: T[], fail?: T[]): [T[], T[]];
 export declare function itemsChanged<T = unknown>(currentItems: T[], newItems: T[], identityProperty?: string): boolean;
 export declare function itemsOrOrderChanged<T = unknown>(currentItems: T[], newItems: T[], identityProperty?: string): boolean;
-export declare const moveItem: <T = unknown>(items: T[], item: T, moveTo: number) => T[];
+export declare const moveItemDeprecated: <T = unknown>(items: T[], item: T, moveTo: number) => T[];
+export declare const moveItem: <T = unknown>(items: T[], fromIndex: number, toIndex: number) => T[];

package/types/box-utils.d.ts

@@ -0,0 +1,9 @@
+export interface rect {
+    bottom: number;
+    left: number;
+    right: number;
+    top: number;
+}
+export type rectTuple = [number, number, number, number];
+export type dimension = "width" | "height";
+export declare function boxContainsPoint(rect: rect, x: number, y: number): boolean | undefined;

package/types/column-utils.d.ts

@@ -1,8 +1,10 @@
-import { DataSourceFilter, DataSourceRow } from "@vuu-ui/vuu-data-types";
-import { ColumnDescriptor, ColumnType, ColumnTypeDescriptor, ColumnTypeRenderer, GroupColumnDescriptor, KeyedColumnDescriptor, MappedValueTypeRenderer, TableHeadings } from "@vuu-ui/vuu-datagrid-types";
-import { Filter } from "@vuu-ui/vuu-filter-types";
-import { VuuAggregation, VuuAggType, VuuColumnDataType, VuuDataRow, VuuGroupBy, VuuRowRecord, VuuSort } from "@vuu-ui/vuu-protocol-types";
-import { CSSProperties } from "react";
+import type { DataSourceFilter, DataSourceRow } from "@vuu-ui/vuu-data-types";
+import type { ColumnAlignment, ColumnDescriptor, ColumnType, ColumnTypeDescriptor, ColumnTypeRenderer, ColumnTypeWithValidationRules, GroupColumnDescriptor, KeyedColumnDescriptor, MappedValueTypeRenderer, PinLocation, TableHeadings, TypeFormatting } from "@vuu-ui/vuu-datagrid-types";
+import type { Filter } from "@vuu-ui/vuu-filter-types";
+import type { VuuAggregation, VuuAggType, VuuColumnDataType, VuuDataRow, VuuGroupBy, VuuRowRecord, VuuSort } from "@vuu-ui/vuu-protocol-types";
+import type { SchemaColumn } from "@vuu-ui/vuu-data";
+import type { CSSProperties } from "react";
+import type { CellRendererDescriptor } from "./component-registry";
 export interface ColumnMap {
     [columnName: string]: number;
 }
@@ -11,6 +13,9 @@ export declare const AggregationType: {
     [key: string]: VuuAggType;
 };
 export declare function mapSortCriteria(sortCriteria: SortCriteriaItem[], columnMap: ColumnMap, metadataOffset?: number): [number, "asc"][];
+export declare const getDefaultAlignment: (serverDataType?: VuuColumnDataType) => ColumnAlignment;
+export declare const isValidColumnAlignment: (v: string) => v is ColumnAlignment;
+export declare const isValidPinLocation: (v: string) => v is PinLocation;
 export declare const isKeyedColumn: (column: ColumnDescriptor) => column is KeyedColumnDescriptor;
 export declare const fromServerDataType: (serverDataType: VuuColumnDataType) => ColumnTypeSimple;
 export declare const isNumericColumn: ({ serverDataType, type }: ColumnDescriptor) => boolean;
@@ -27,8 +32,9 @@ export declare const isSimpleColumnType: (value: unknown) => value is ColumnType
 export declare type ColumnTypeSimple = "string" | "number" | "boolean" | "json" | "date" | "time" | "checkbox";
 export declare const isTypeDescriptor: (type?: ColumnType) => type is ColumnTypeDescriptor;
 export declare const isColumnTypeRenderer: (renderer?: unknown) => renderer is ColumnTypeRenderer;
+export declare const hasValidationRules: (type?: ColumnType) => type is ColumnTypeWithValidationRules;
 export declare const isMappedValueTypeRenderer: (renderer?: unknown) => renderer is MappedValueTypeRenderer;
-export declare function buildColumnMap(columns?: (KeyedColumnDescriptor | string)[]): ColumnMap;
+export declare function buildColumnMap(columns?: (KeyedColumnDescriptor | SchemaColumn | string)[]): ColumnMap;
 export declare function projectUpdates(updates: number[]): number[];
 export declare const metadataKeys: {
     readonly IDX: 0;
@@ -62,8 +68,9 @@ export declare const applyFilterToColumns: (columns: KeyedColumnDescriptor[], {
 export declare const isFilteredColumn: (column: KeyedColumnDescriptor) => boolean;
 export declare const stripFilterFromColumns: (columns: KeyedColumnDescriptor[]) => {
     align?: "left" | "right" | undefined;
-    CellRenderer?: import("react").FunctionComponent<import("@vuu-ui/vuu-datagrid-types").TableCellProps> | undefined;
+    CellRenderer?: import("react").FunctionComponent<import("@vuu-ui/vuu-datagrid-types").TableCellRendererProps> | undefined;
     className?: string | undefined;
+    clientSideEditValidationCheck?: import("packages/vuu-ui-controls/src").ClientSideValidationChecker | undefined;
     endPin?: true | undefined;
     flex?: number | undefined;
     heading?: string[] | undefined;
@@ -89,7 +96,7 @@ export declare const stripFilterFromColumns: (columns: KeyedColumnDescriptor[])
     hidden?: boolean | undefined;
     minWidth?: number | undefined;
     name: string;
-    pin?: import("@vuu-ui/vuu-datagrid-types").PinLocation | undefined;
+    pin?: PinLocation | undefined;
     serverDataType?: VuuColumnDataType | undefined;
 }[];
 export declare const getColumnName: (name: string) => string;
@@ -102,3 +109,22 @@ export declare const isDataLoading: (columns: KeyedColumnDescriptor[]) => boolea
 export declare const getColumnsInViewport: (columns: KeyedColumnDescriptor[], vpStart: number, vpEnd: number) => [KeyedColumnDescriptor[], number];
 export declare const visibleColumnAtIndex: (columns: KeyedColumnDescriptor[], index: number) => KeyedColumnDescriptor | undefined;
 export declare const getGroupValueAndOffset: (columns: KeyedColumnDescriptor[], row: DataSourceRow) => [unknown, number];
+export declare const getDefaultColumnType: (serverDataType?: VuuColumnDataType) => ColumnTypeSimple;
+export declare const updateColumnType: <T extends ColumnDescriptor = ColumnDescriptor>(column: T, formatting: TypeFormatting) => T;
+export declare const updateColumnRenderer: <T extends ColumnDescriptor = ColumnDescriptor>(column: T, cellRenderer: CellRendererDescriptor) => T;
+export declare const getTypeSettingsFromColumn: (column: ColumnDescriptor) => TypeFormatting;
+/**
+ *
+ * return a filter predicate that will reject columns, names of which
+ * are not in provided list.
+ */
+export declare const subscribedOnly: (columnNames?: string[]) => (column: ColumnDescriptor) => boolean | undefined;
+export declare const addColumnToSubscribedColumns: (subscribedColumns: ColumnDescriptor[], availableColumns: SchemaColumn[], columnName: string) => ColumnDescriptor[];
+export declare const isCalculatedColumn: (columnName?: string) => boolean;
+export declare const getCalculatedColumnDetails: (column: ColumnDescriptor) => string[];
+export declare const getCalculatedColumnName: (column: ColumnDescriptor) => string;
+export declare const getCalculatedColumnExpression: (column: ColumnDescriptor) => string;
+export declare const getCalculatedColumnType: (column: ColumnDescriptor) => VuuColumnDataType;
+export declare const setCalculatedColumnName: (column: ColumnDescriptor, name: string) => ColumnDescriptor;
+export declare const setCalculatedColumnExpression: (column: ColumnDescriptor, expression: string) => ColumnDescriptor;
+export declare const setCalculatedColumnType: (column: ColumnDescriptor, type: string) => ColumnDescriptor;

package/types/component-registry.d.ts

@@ -1,19 +1,23 @@
 import { FunctionComponent as FC, HTMLAttributes } from "react";
-import { ColumnTypeRenderer, MappedValueTypeRenderer, TableCellProps } from "@vuu-ui/vuu-datagrid-types";
-import { VuuColumnDataType } from "@vuu-ui/vuu-protocol-types";
+import { ColumnTypeRenderer, EditValidationRule, MappedValueTypeRenderer, TableCellRendererProps } from "@vuu-ui/vuu-datagrid-types";
+import { VuuColumnDataType, VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
 export interface CellConfigPanelProps extends HTMLAttributes<HTMLDivElement> {
     onConfigChange: () => void;
 }
-export type ComponentType = "cell-renderer" | "cell-config-panel";
+export type EditRuleValidator = (editRule: EditValidationRule, value: VuuRowDataItemType) => boolean | string;
+export type ComponentType = "cell-renderer" | "cell-config-panel" | "data-edit-validator";
 type CellRendererOptions = {
     [key: string]: unknown;
-    serverDataType?: VuuColumnDataType | VuuColumnDataType[];
+    description?: string;
+    label?: string;
+    serverDataType?: VuuColumnDataType | VuuColumnDataType[] | "json" | "private";
 };
 export interface CellRendererDescriptor extends CellRendererOptions {
     name: string;
 }
-export declare function registerComponent<T extends TableCellProps | CellConfigPanelProps = TableCellProps>(componentName: string, component: FC<T>, type: ComponentType | undefined, options: CellRendererOptions): void;
-export declare const getRegisteredCellRenderers: (serverDataType?: VuuColumnDataType) => CellRendererDescriptor[];
-export declare function getCellRenderer(renderer?: ColumnTypeRenderer | MappedValueTypeRenderer): FC<TableCellProps> | undefined;
+export declare function registerComponent<T extends TableCellRendererProps | CellConfigPanelProps | EditRuleValidator = TableCellRendererProps>(componentName: string, component: T extends EditRuleValidator ? T : FC<T>, type: ComponentType | undefined, options: CellRendererOptions): void;
+export declare const getRegisteredCellRenderers: (serverDataType?: VuuColumnDataType | "json") => CellRendererDescriptor[];
+export declare function getCellRenderer(renderer?: ColumnTypeRenderer | MappedValueTypeRenderer): FC<TableCellRendererProps> | undefined;
 export declare function getCellConfigPanelRenderer(name: string): FC<CellConfigPanelProps> | undefined;
+export declare function getEditRuleValidator(name: string): EditRuleValidator | undefined;
 export {};

package/types/data-utils.d.ts

@@ -9,6 +9,6 @@ export declare const shallowEquals: (o1?: {
 }, o2?: {
     [key: string]: unknown;
 }) => boolean;
-export declare function getMovingValueDirection(newValue: number, direction?: valueChangeDirection, prevValue?: number, 
+export declare function getMovingValueDirection(newValue?: number, direction?: valueChangeDirection, prevValue?: number, 
 /** the number of decimal places to take into account when highlighting a change  */
 decimalPlaces?: number): valueChangeDirection;

package/types/filter-utils.d.ts

@@ -1,5 +1,5 @@
 import { KeyedColumnDescriptor } from "@vuu-ui/vuu-datagrid-types";
-import { AndFilter, Filter, FilterClauseOp, MultiClauseFilter, MultiValueFilterClause, OrFilter, SingleValueFilterClause } from "@vuu-ui/vuu-filter-types";
+import { AndFilter, Filter, FilterClauseOp, FilterWithPartialClause, MultiClauseFilter, MultiValueFilterClause, OrFilter, SingleValueFilterClause } from "@vuu-ui/vuu-filter-types";
 export declare const isValidFilterClauseOp: (op?: string) => op is FilterClauseOp;
 export declare const isNamedFilter: (f?: Filter) => boolean;
 export declare const isSingleValueFilter: (f?: Partial<Filter>) => f is SingleValueFilterClause<string | number | boolean>;
@@ -8,6 +8,7 @@ export declare const isMultiValueFilter: (f?: Partial<Filter>) => f is MultiValu
 export declare const isInFilter: (f: Partial<Filter>) => f is MultiValueFilterClause;
 export declare const isAndFilter: (f: Partial<Filter>) => f is AndFilter;
 export declare const isOrFilter: (f: Partial<Filter>) => f is OrFilter;
-export declare function isMultiClauseFilter(f?: Partial<Filter>): f is MultiClauseFilter;
+export declare const isCompleteFilter: (filter: Partial<Filter>) => filter is Filter;
+export declare function isMultiClauseFilter(f?: Partial<Filter> | FilterWithPartialClause): f is MultiClauseFilter;
 export declare const filterAsQuery: (f: Filter) => string;
 export declare const removeColumnFromFilter: (column: KeyedColumnDescriptor, filter: Filter) => [Filter | undefined, string];

package/types/formatting-utils.d.ts

@@ -5,5 +5,5 @@ export type ValueFormatters = {
 };
 export declare const defaultValueFormatter: (value: unknown) => string;
 export declare const dateFormatter: (column: ColumnDescriptor) => (value: unknown) => string;
-export declare const numericFormatter: ({ align, type, }: ColumnDescriptor) => (value: unknown) => string;
+export declare const numericFormatter: ({ align, type, }: Partial<ColumnDescriptor>) => (value: unknown) => string;
 export declare const getValueFormatter: (column: ColumnDescriptor) => ValueFormatter;

package/types/html-utils.d.ts

@@ -1,3 +1,12 @@
 export declare const createEl: (elementType: "div" | "p" | "span", className?: string, textContent?: string) => HTMLElement;
 export declare const getFocusableElement: (el: HTMLElement | null, tabIndex?: number) => HTMLElement | undefined;
+export declare const getElementDataIndex: (el: HTMLElement | null) => number;
+export declare const getClosest: (el: HTMLElement, dataProperty: string) => HTMLElement;
+export declare const getClosestIndexItem: (el: HTMLElement) => HTMLElement;
+export declare function getElementByDataIndex(c: HTMLElement | null, i: number | string, throwIfNotFound: true): HTMLElement;
+export declare function getElementByDataIndex(c: HTMLElement | null, i: number | string, throwIfNotFound?: false): HTMLElement | undefined;
 export declare const focusFirstFocusableElement: (el: HTMLElement | null, tabIndex?: number) => void;
+export declare const isSelectableElement: (el?: HTMLElement) => boolean;
+export declare function getScrollbarSize(): number;
+export type MouseEventTypes = "dblclick" | "click";
+export declare const dispatchMouseEvent: (el: HTMLElement, type: MouseEventTypes) => void;

package/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./array-utils";
+export * from "./box-utils";
 export * from "./column-utils";
 export * from "./cookie-utils";
 export * from "./component-registry";
@@ -30,3 +31,4 @@ export * from "./selection-utils";
 export * from "./sort-utils";
 export * from "./text-utils";
 export * from "./url-utils";
+export * from "./screenshot-utils";

package/types/input-utils.d.ts

@@ -1,2 +1,2 @@
-export declare const isCharacterKey: (evt: KeyboardEvent) => boolean | undefined;
+export declare const isCharacterKey: (key: string) => boolean;
 export declare const isQuoteKey: (evt: KeyboardEvent) => boolean;

package/types/range-utils.d.ts

@@ -8,6 +8,7 @@ interface FromToRange {
     from: number;
     to: number;
 }
+export declare const NULL_RANGE: VuuRange;
 export declare function getFullRange({ from, to }: VuuRange, bufferSize?: number, rowCount?: number): FromToRange;
 export declare function resetRange({ from, to, bufferSize }: VuuRange): VuuRange;
 export declare const withinRange: (value: number, { from, to }: VuuRange) => boolean;

package/types/screenshot-utils.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Takes a screenshot of the given node and returns the base64 encoded image url
+ * @param node Node to take screenshot of
+ * @returns Base64 encoded image url
+ */
+export declare function takeScreenshot(node: HTMLElement): Promise<string | undefined>;

package/types/selection-utils.d.ts

@@ -9,8 +9,17 @@ export declare const RowSelected: {
 export declare const isRowSelected: (row: DataSourceRow) => boolean;
 export declare const deselectItem: (selectionModel: TableSelectionModel, selected: Selection, itemIndex: number, rangeSelect: boolean, keepExistingSelection?: boolean) => Selection;
 export declare const selectItem: (selectionModel: TableSelectionModel, selected: Selection, itemIndex: number, rangeSelect: boolean, keepExistingSelection?: boolean, activeItemIndex?: number) => Selection;
+/**
+ *  Determine the value for selected. We use a bitmap to represent a number of selection states
+ * a row might exhibit. selected/not-selected is the fundamental value. We also identify first
+ * row of a selected block, last row of a selected block;
+ */
 export declare const getSelectionStatus: (selected: Selection, itemIndex: number) => number;
 export declare const isSelected: (selected: Selection, itemIndex: number) => boolean;
+/**
+ * Vuu server expects a full list if indexes of selected rows. Client represents selection in a more
+ * efficient structure. This converts client structure to full server format.
+ */
 export declare const expandSelection: (selected: Selection) => number[];
 export type SelectionDiff = {
     added: SelectionItem[];

package/types/text-utils.d.ts

@@ -1 +1,2 @@
 export declare const lastWord: (text: string) => string;
+export declare const wordify: (text: string) => string;