@vuu-ui/vuu-utils 0.8.22-debug → 0.8.23-debug

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@vuu-ui/vuu-utils",
-  "version": "0.8.22-debug",
+  "version": "0.8.23-debug",
   "author": "heswell",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@vuu-ui/vuu-data-types": "0.8.22-debug",
-    "@vuu-ui/vuu-table-types": "0.8.22-debug",
-    "@vuu-ui/vuu-filter-types": "0.8.22-debug",
-    "@vuu-ui/vuu-protocol-types": "0.8.22-debug"
+    "@vuu-ui/vuu-data-types": "0.8.23-debug",
+    "@vuu-ui/vuu-table-types": "0.8.23-debug",
+    "@vuu-ui/vuu-filter-types": "0.8.23-debug",
+    "@vuu-ui/vuu-protocol-types": "0.8.23-debug"
   },
   "peerDependencies": {
     "react": ">=17.0.2",

package/types/column-utils.d.ts

@@ -1,7 +1,7 @@
 import type { DataSourceFilter, DataSourceRow, SchemaColumn, TableSchema } from "@vuu-ui/vuu-data-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 { ColumnAlignment, ColumnDescriptor, ColumnType, ColumnTypeDescriptor, ColumnTypeFormatting, ColumnTypeRendering, ColumnTypeSimple, ColumnTypeWithValidationRules, DefaultColumnConfiguration, GroupColumnDescriptor, LookupRenderer, MappedValueTypeRenderer, PinLocation, RuntimeColumnDescriptor, TableHeadings, ValueListRenderer, DateTimeColumnDescriptor } from "@vuu-ui/vuu-table-types";
+import type { ColumnAlignment, ColumnDescriptor, ColumnType, ColumnTypeDescriptor, ColumnTypeFormatting, ColumnTypeRendering, ColumnTypeSimple, ColumnTypeWithValidationRules, DefaultColumnConfiguration, GroupColumnDescriptor, LookupRenderer, MappedValueTypeRenderer, PinLocation, RuntimeColumnDescriptor, TableHeadings, ValueListRenderer, DateTimeColumnDescriptor, TableCellRendererProps } from "@vuu-ui/vuu-table-types";
 import type { CSSProperties } from "react";
 /**
  * ColumnMap provides a lookup of the index position of a data item within a row
@@ -18,7 +18,6 @@ export declare function mapSortCriteria(sortCriteria: SortCriteriaItem[], column
 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 RuntimeColumnDescriptor;
 export declare const fromServerDataType: (serverDataType: VuuColumnDataType) => ColumnTypeSimple;
 export declare const isNumericColumn: ({ serverDataType, type }: ColumnDescriptor) => boolean;
 export declare const isDateTimeColumn: (column: ColumnDescriptor) => column is DateTimeColumnDescriptor;
@@ -57,9 +56,14 @@ export declare const flattenColumnGroup: (columns: RuntimeColumnDescriptor[]) =>
 export declare function extractGroupColumn(columns: RuntimeColumnDescriptor[], groupBy?: VuuGroupBy, confirmed?: boolean): [GroupColumnDescriptor | null, RuntimeColumnDescriptor[]];
 export declare const isGroupColumn: (column: RuntimeColumnDescriptor) => column is GroupColumnDescriptor;
 export declare const isJsonAttribute: (value: unknown) => boolean;
-export declare const isJsonGroup: (column: RuntimeColumnDescriptor, row: VuuDataRow) => boolean;
+export declare const isJsonGroup: (column: RuntimeColumnDescriptor, row: VuuDataRow, columnMap: ColumnMap) => boolean;
 export declare const isJsonColumn: (column: RuntimeColumnDescriptor) => boolean;
 export declare const sortPinnedColumns: (columns: RuntimeColumnDescriptor[]) => RuntimeColumnDescriptor[];
+export declare const measurePinnedColumns: (columns: RuntimeColumnDescriptor[], selectionEndSize: number) => {
+    pinnedWidthLeft: number;
+    pinnedWidthRight: number;
+    unpinnedWidth: number;
+};
 export declare const getTableHeadings: (columns: RuntimeColumnDescriptor[]) => TableHeadings;
 export declare const getColumnStyle: ({ pin, pinnedOffset, width, }: RuntimeColumnDescriptor) => CSSProperties;
 export declare const setAggregations: (aggregations: VuuAggregation[], column: RuntimeColumnDescriptor, aggType: VuuAggType) => VuuAggregation[];
@@ -70,17 +74,18 @@ export declare const applyFilterToColumns: (columns: RuntimeColumnDescriptor[],
 export declare const isFilteredColumn: (column: RuntimeColumnDescriptor) => boolean;
 export declare const stripFilterFromColumns: (columns: RuntimeColumnDescriptor[]) => {
     align?: "left" | "right" | undefined;
-    CellRenderer?: import("react").FunctionComponent<import("@vuu-ui/vuu-table-types").TableCellRendererProps> | undefined;
+    CellRenderer?: import("react").FunctionComponent<TableCellRendererProps> | undefined;
     HeaderCellLabelRenderer?: import("react").FunctionComponent<import("@vuu-ui/vuu-table-types").HeaderCellProps> | undefined;
     HeaderCellContentRenderer?: import("react").FunctionComponent<import("@vuu-ui/vuu-table-types").HeaderCellProps> | undefined;
+    canStretch?: boolean | undefined;
     className?: string | undefined;
-    clientSideEditValidationCheck?: import("packages/vuu-ui-controls/src").ClientSideValidationChecker | undefined;
+    clientSideEditValidationCheck?: any;
     endPin?: true | undefined;
     flex?: number | undefined;
     heading?: string[] | undefined;
+    index?: number | undefined;
     isGroup?: boolean | undefined;
     isSystemColumn?: boolean | undefined;
-    key: number;
     label: string;
     locked?: boolean | undefined;
     marginLeft?: number | undefined;
@@ -91,18 +96,19 @@ export declare const stripFilterFromColumns: (columns: RuntimeColumnDescriptor[]
     resizing?: boolean | undefined;
     sortable?: boolean | undefined;
     sorted?: import("@vuu-ui/vuu-table-types").ColumnSort | undefined;
-    type?: ColumnType | undefined;
-    valueFormatter: ValueFormatter;
+    valueFormatter: import("@vuu-ui/vuu-table-types").ValueFormatter;
     width: number;
     aggregate?: VuuAggType | undefined;
     colHeaderContentRenderer?: string | undefined;
     colHeaderLabelRenderer?: string | undefined;
     editable?: boolean | undefined;
     hidden?: boolean | undefined;
+    maxWidth?: number | undefined;
     minWidth?: number | undefined;
     name: string;
     pin?: PinLocation | undefined;
     serverDataType?: VuuColumnDataType | undefined;
+    type?: ColumnType | undefined;
 }[];
 export declare const getColumnName: (name: string) => string;
 export declare const getColumnLabel: (column: ColumnDescriptor) => string;
@@ -115,7 +121,7 @@ export declare const isDataLoading: (columns: RuntimeColumnDescriptor[]) => bool
 export declare const getColumnsInViewport: (columns: RuntimeColumnDescriptor[], vpStart: number, vpEnd: number) => [RuntimeColumnDescriptor[], number];
 export declare const isNotHidden: (column: RuntimeColumnDescriptor) => boolean;
 export declare const visibleColumnAtIndex: (columns: RuntimeColumnDescriptor[], index: number) => RuntimeColumnDescriptor | undefined;
-export declare const getGroupValueAndOffset: (columns: RuntimeColumnDescriptor[], row: DataSourceRow) => [unknown, number];
+export declare const getGroupValueAndOffset: (columns: RuntimeColumnDescriptor[], row: DataSourceRow, columnMap: ColumnMap) => [unknown, number];
 export declare const getDefaultColumnType: (serverDataType?: VuuColumnDataType) => ColumnTypeSimple;
 export declare const updateColumnFormatting: <T extends ColumnDescriptor = ColumnDescriptor>(column: T, formatting: ColumnTypeFormatting) => T;
 export declare function updateColumnType<T extends ColumnDescriptor = ColumnDescriptor>(column: T, type: ColumnTypeSimple): T;
@@ -140,3 +146,30 @@ export declare const moveColumnTo: (columns: ColumnDescriptor[], column: ColumnD
 export declare function replaceColumn<C extends ColumnDescriptor = RuntimeColumnDescriptor>(columns: C[], column: C): C[];
 export declare const applyDefaultColumnConfig: ({ columns, table }: TableSchema, getDefaultColumnConfig?: DefaultColumnConfiguration) => SchemaColumn[];
 export declare const getColumnByName: (schema: TableSchema, name?: string) => SchemaColumn | undefined;
+export type ColumnLayout = "Static" | "Fit";
+export type columnOptions = {
+    availableWidth?: number;
+    columnLayout?: ColumnLayout;
+    defaultWidth?: number;
+    defaultMinWidth?: number;
+    defaultMaxWidth?: number;
+    defaultFlex?: number;
+};
+export declare function applyWidthToColumns(columns: RuntimeColumnDescriptor[], options: {
+    columnLayout: "Static";
+    defaultMinWidth?: number;
+    defaultMaxWidth?: number;
+    defaultWidth?: number;
+} | {
+    columnLayout: "Fit";
+    availableWidth?: number;
+    defaultMinWidth?: number;
+    defaultMaxWidth?: number;
+    defaultWidth?: number;
+}): RuntimeColumnDescriptor[];
+/**
+ * A memo compare function for cell renderers. Can be used to suppress
+ * render where column and data are both unchanged. Avoids render
+ * when row changes, where changes in row are unrelated to this cell.
+ */
+export declare const dataAndColumnUnchanged: (p: TableCellRendererProps, p1: TableCellRendererProps) => boolean;

package/types/date/formatter.d.ts

@@ -1,2 +1,4 @@
+import { DateFormatter } from "@internationalized/date";
 import { DateTimePattern } from "./types";
 export declare function formatDate(pattern: DateTimePattern): (d: Date) => string;
+export declare function getDateFormatter(locale: string, options?: Intl.DateTimeFormatOptions): DateFormatter;

package/types/date/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./formatter";
 export { isDateTimePattern, type DateTimePattern, supportedDateTimePatterns, } from "./types";
-export { defaultPatternsByType, fallbackDateTimePattern } from "./helpers";
+export { toCalendarDate } from "./utils";
+export { dateTimePattern, defaultPatternsByType, fallbackDateTimePattern, } from "./dateTimePattern";

package/types/date/utils.d.ts

@@ -0,0 +1,2 @@
+import { CalendarDate } from "@internationalized/date";
+export declare function toCalendarDate(d: Date): CalendarDate;

package/types/filters/filterAsQuery.d.ts

@@ -0,0 +1,5 @@
+import { ColumnDescriptorsByName, Filter, SingleValueFilterClause } from "@vuu-ui/vuu-filter-types";
+export declare const filterAsQuery: (f: Filter, opts?: {
+    columnsByName?: ColumnDescriptorsByName;
+}) => string;
+export declare function dateFilterAsQuery(f: SingleValueFilterClause<number>): string;

package/types/filters/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./utils";
+export { filterAsQuery } from "./filterAsQuery";

package/types/{filter-utils.d.ts → filters/utils.d.ts}

@@ -3,14 +3,11 @@ import { AndFilter, Filter, FilterClauseOp, FilterWithPartialClause, MultiClause
 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>;
-export declare const isFilterClause: (f?: Partial<Filter>) => f is MultiValueFilterClause | SingleValueFilterClause<string | number | boolean>;
-export declare const isMultiValueFilter: (f?: Partial<Filter>) => f is MultiValueFilterClause;
-export declare const isInFilter: (f: Partial<Filter>) => f is MultiValueFilterClause;
+export declare const isFilterClause: (f?: Partial<Filter>) => f is SingleValueFilterClause<string | number | boolean> | MultiValueFilterClause<number[] | string[] | boolean[]>;
+export declare const isMultiValueFilter: (f?: Partial<Filter>) => f is MultiValueFilterClause<number[] | string[] | boolean[]>;
+export declare const isInFilter: (f: Partial<Filter>) => f is MultiValueFilterClause<number[] | string[] | boolean[]>;
 export declare const isAndFilter: (f: Partial<Filter>) => f is AndFilter;
 export declare const isOrFilter: (f: Partial<Filter>) => f is OrFilter;
 export declare const isCompleteFilter: (filter: Partial<Filter>) => filter is Filter;
 export declare function isMultiClauseFilter(f?: Partial<Filter> | FilterWithPartialClause): f is MultiClauseFilter;
-export declare const filterValue: (value: string | number | boolean) => string | number | boolean;
-export declare const quotedStrings: (value: string | number | boolean) => string | number | boolean;
-export declare const filterAsQuery: (f: Filter) => string;
 export declare const removeColumnFromFilter: (column: RuntimeColumnDescriptor, filter: Filter) => [Filter | undefined, string];

package/types/formatting-utils.d.ts

@@ -1,5 +1,4 @@
-import { ColumnDescriptor } from "@vuu-ui/vuu-table-types";
-export type ValueFormatter = (value: unknown) => string;
+import { ColumnDescriptor, ValueFormatter } from "@vuu-ui/vuu-table-types";
 export type ValueFormatters = {
     [key: string]: ValueFormatter;
 };

package/types/index.d.ts

@@ -10,7 +10,7 @@ export * from "./datasource-action-utils";
 export * from "./datasource-utils";
 export * from "./date";
 export * from "./debug-utils";
-export * from "./filter-utils";
+export * from "./filters";
 export * from "./html-utils";
 export * from "./event-emitter";
 export * from "./formatting-utils";
@@ -24,7 +24,9 @@ export * from "./keyboard-utils";
 export * from "./keyset";
 export * from "./logging-utils";
 export * from "./menu-utils";
+export * from "./module-utils";
 export * from "./nanoid";
+export * from "./react-utils";
 export * from "./round-decimal";
 export * from "./perf-utils";
 export * from "./range-utils";

package/types/keyset.d.ts

@@ -1,11 +1,12 @@
 import { VuuRange } from "@vuu-ui/vuu-protocol-types";
 export declare class KeySet {
     private keys;
-    private free;
     private nextKeyValue;
+    private range;
     constructor(range: VuuRange);
-    next(): number;
-    reset({ from, to }: VuuRange): void;
+    next(free?: number[]): number;
+    private init;
+    reset(range: VuuRange): boolean;
     keyFor(rowIndex: number): number;
     toDebugString(): string;
 }

package/types/module-utils.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+export type ReactComponent = {
+    (props?: any): JSX.Element;
+};
+export declare const isModule: (entity: Module | ReactComponent) => entity is Module<ReactComponent>;
+export interface Module<T = ReactComponent> {
+    [key: string]: Module<T> | T;
+}
+export declare const assertModuleExportsAtLeastOneComponent: (module: Module) => void;

package/types/range-utils.d.ts

@@ -9,7 +9,8 @@ interface FromToRange {
     to: number;
 }
 export declare const NULL_RANGE: VuuRange;
-export declare function getFullRange({ from, to }: VuuRange, bufferSize?: number, rowCount?: number): FromToRange;
+export declare const rangesAreSame: (r1: VuuRange | undefined, r2: VuuRange | undefined) => boolean;
+export declare function getFullRange({ from, to }: VuuRange, bufferSize?: number, totalRowCount?: number): FromToRange;
 export declare function resetRange({ from, to, bufferSize }: VuuRange): VuuRange;
 export declare const withinRange: (value: number, { from, to }: VuuRange) => boolean;
 export declare const rangeNewItems: ({ from: from1, to: to1 }: VuuRange, newRange: VuuRange) => VuuRange;

package/types/react-utils.d.ts

@@ -0,0 +1,2 @@
+import { ReactElement, ReactNode } from "react";
+export declare const asReactElements: (children: ReactNode) => ReactElement[];