@vuu-ui/vuu-layout 0.8.66 → 0.8.67

package/types/vuu-utils/src/filters/utils.d.ts

@@ -1,55 +0,0 @@
-/// <reference types="react" />
-import type { DataSourceFilter } from "@vuu-ui/vuu-data-types";
-import { AndFilter, Filter, FilterClauseOp, FilterWithPartialClause, MultiClauseFilter, MultiValueFilterClause, OrFilter, SingleValueFilterClause } from "@vuu-ui/vuu-filter-types";
-import { RuntimeColumnDescriptor } from "@vuu-ui/vuu-table-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>;
-export declare const isFilterClause: (f?: Partial<Filter>) => f is SingleValueFilterClause<string | number | boolean> | MultiValueFilterClause<string[] | number[] | boolean[]>;
-export declare const isMultiValueFilter: (f?: Partial<Filter>) => f is MultiValueFilterClause<string[] | number[] | boolean[]>;
-export declare const isInFilter: (f: Partial<Filter>) => f is MultiValueFilterClause<string[] | number[] | 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 applyFilterToColumns: (columns: RuntimeColumnDescriptor[], { filterStruct }: DataSourceFilter) => RuntimeColumnDescriptor[];
-export declare const isFilteredColumn: (column: RuntimeColumnDescriptor) => boolean;
-export declare const stripFilterFromColumns: (columns: RuntimeColumnDescriptor[]) => {
-    align?: "right" | "left" | undefined;
-    CellRenderer?: import("react").FunctionComponent<import("@vuu-ui/vuu-table-types").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?: any;
-    endPin?: true | undefined;
-    flex?: number | undefined;
-    heading?: string[] | undefined;
-    index?: number | undefined;
-    isGroup?: boolean | undefined;
-    isSystemColumn?: boolean | undefined;
-    label: string;
-    locked?: boolean | undefined;
-    marginLeft?: number | undefined;
-    moving?: boolean | undefined;
-    originalIdx?: number | undefined;
-    pinnedOffset?: number | undefined;
-    resizeable?: boolean | undefined;
-    resizing?: boolean | undefined;
-    sortable?: boolean | undefined;
-    sorted?: import("@vuu-ui/vuu-table-types").ColumnSort | undefined;
-    valueFormatter: import("@vuu-ui/vuu-table-types").ValueFormatter;
-    width: number;
-    aggregate?: import("packages/vuu-protocol-types").VuuAggType | undefined;
-    colHeaderContentRenderer?: string | undefined;
-    colHeaderLabelRenderer?: string | undefined;
-    editable?: boolean | undefined;
-    hidden?: boolean | undefined;
-    maxWidth?: number | undefined;
-    minWidth?: number | undefined;
-    name: string;
-    pin?: import("@vuu-ui/vuu-table-types").PinLocation | undefined;
-    serverDataType?: import("packages/vuu-protocol-types").VuuColumnDataType | undefined;
-    type?: import("@vuu-ui/vuu-table-types").ColumnType | undefined;
-}[];
-export declare const extractFilterForColumn: (filter: Filter | undefined, columnName: string) => Filter | undefined;

package/types/vuu-utils/src/form-utils.d.ts

@@ -1,6 +0,0 @@
-/**
- * Use with the following convention:
- *
- * <FormField data-field="my-field-name">
- */
-export declare const getFieldName: (input: HTMLInputElement | HTMLButtonElement) => string;

package/types/vuu-utils/src/formatting-utils.d.ts

@@ -1,7 +0,0 @@
-import { ColumnDescriptor, ValueFormatter } from "@vuu-ui/vuu-table-types";
-export type ValueFormatters = {
-    [key: string]: ValueFormatter;
-};
-export declare const defaultValueFormatter: (value: unknown) => string;
-export declare const numericFormatter: ({ align, type, }: Partial<ColumnDescriptor>) => (value: unknown) => string;
-export declare const getValueFormatter: (column: ColumnDescriptor, serverDataType?: import("packages/vuu-protocol-types").VuuColumnDataType | undefined) => ValueFormatter;

package/types/vuu-utils/src/getUniqueId.d.ts

@@ -1 +0,0 @@
-export declare const getUniqueId: () => string;

package/types/vuu-utils/src/group-utils.d.ts

@@ -1,3 +0,0 @@
-import { RuntimeColumnDescriptor } from "@vuu-ui/vuu-table-types";
-import { VuuGroupBy } from "@vuu-ui/vuu-protocol-types";
-export declare function addGroupColumn(groupBy: VuuGroupBy, column: RuntimeColumnDescriptor): string[];

package/types/vuu-utils/src/html-utils.d.ts

@@ -1,18 +0,0 @@
-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 queryClosest: <T extends HTMLElement = HTMLElement>(el: HTMLElement | EventTarget | null, cssQueryString: string) => T | null;
-export declare const getClosest: (el: HTMLElement, dataProperty: string) => HTMLElement | null;
-export declare const getClosestIndexItem: (el: HTMLElement) => HTMLElement | null;
-export declare function getElementByDataIndex(c: HTMLElement | null | undefined, i: number | string, throwIfNotFound: true): HTMLElement;
-export declare function getElementByDataIndex(c: HTMLElement | null | undefined, i: number | string, throwIfNotFound?: false): HTMLElement | undefined;
-export declare const focusFirstFocusableElement: (el: HTMLElement | null, tabIndex?: number) => void;
-export declare const isSelectableElement: (el?: HTMLElement | null) => boolean;
-export declare const hasOpenOptionList: (el: HTMLElement | EventTarget | null) => boolean | undefined;
-export declare function getScrollbarSize(): number;
-export type MouseEventTypes = "dblclick" | "click";
-export type KeyboardEventTypes = "keydown" | "keypress" | "keyup";
-export declare const dispatchMouseEvent: (el: HTMLElement, type: MouseEventTypes) => void;
-export declare const dispatchKeyboardEvent: (el: HTMLElement, type: KeyboardEventTypes, key: string) => void;
-export type VuuDomEventType = "vuu-commit" | "vuu-dropped";
-export declare const dispatchCustomEvent: (el: HTMLElement, type: VuuDomEventType) => void;

package/types/vuu-utils/src/index.d.ts

@@ -1,50 +0,0 @@
-export * from "./array-utils";
-export * from "./box-utils";
-export * from "./broadcast-channel";
-export * from "./column-utils";
-export * from "./cookie-utils";
-export * from "./component-registry";
-export * from "./DataWindow";
-export * from "./common-types";
-export * from "./css-utils";
-export * from "./data-utils";
-export * from "./datasource-action-utils";
-export * from "./datasource-utils";
-export * from "./date";
-export * from "./debug-utils";
-export * from "./filters";
-export * from "./html-utils";
-export * from "./event-emitter";
-export * from "./feature-utils";
-export * from "./form-utils";
-export * from "./formatting-utils";
-export * from "./getUniqueId";
-export * from "./group-utils";
-export * from "./input-utils";
-export * from "./invariant";
-export * from "./itemToString";
-export * from "./json-utils";
-export * from "./keyboard-utils";
-export * from "./keyset";
-export * from "./list-utils";
-export * from "./local-storage-utils";
-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 "./protocol-message-utils";
-export * from "./range-utils";
-export * from "./row-utils";
-export * from "./selection-utils";
-export * from "./sort-utils";
-export * from "./table-schema-utils";
-export * from "./text-utils";
-export * from "./ThemeProvider";
-export * from "./ts-utils";
-export * from "./url-utils";
-export * from "./useId";
-export * from "./user-types";
-export * from "./useLayoutEffectSkipFirst";

package/types/vuu-utils/src/input-utils.d.ts

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

package/types/vuu-utils/src/invariant.d.ts

@@ -1 +0,0 @@
-export declare function invariant(condition: boolean, message: string): void;

package/types/vuu-utils/src/itemToString.d.ts

@@ -1,2 +0,0 @@
-export type ItemToStringFunction = (item: any) => string;
-export declare function itemToString(item: unknown): string;

package/types/vuu-utils/src/json-utils.d.ts

@@ -1,6 +0,0 @@
-import { DataSourceRow } from "@vuu-ui/vuu-data-types";
-import { ColumnDescriptor } from "@vuu-ui/vuu-table-types";
-export type JsonData = {
-    [key: string]: unknown;
-} | JsonData[];
-export declare const jsonToDataSourceRows: (json: JsonData) => [ColumnDescriptor[], DataSourceRow[]];

package/types/vuu-utils/src/keyboard-utils.d.ts

@@ -1,12 +0,0 @@
-export declare const ArrowUp = "ArrowUp";
-export declare const ArrowDown = "ArrowDown";
-export declare const ArrowLeft = "ArrowLeft";
-export declare const ArrowRight = "ArrowRight";
-export declare const Enter = "Enter";
-export declare const Escape = "Escape";
-export declare const Home = "Home";
-export declare const End = "End";
-export declare const PageUp = "PageUp";
-export declare const PageDown = "PageDown";
-export declare const Space = " ";
-export declare const Tab = "Tab";

package/types/vuu-utils/src/keyset.d.ts

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

package/types/vuu-utils/src/list-utils.d.ts

@@ -1,2 +0,0 @@
-import type { ListOption } from "@vuu-ui/vuu-table-types";
-export declare const getSelectedOption: (values: ListOption[], selectedValue: string | number | undefined) => ListOption | undefined;

package/types/vuu-utils/src/local-storage-utils.d.ts

@@ -1,3 +0,0 @@
-export declare const getLocalEntity: <T>(url: string) => T | undefined;
-export declare const getAllLocalEntity: <T>(url: string) => T[];
-export declare const saveLocalEntity: <T>(url: string, data: T) => T | undefined;

package/types/vuu-utils/src/logging-utils.d.ts

@@ -1,44 +0,0 @@
-declare global {
-    const loggingSettings: loggingSettings;
-}
-export interface LogFn {
-    (message?: unknown, ...optionalParams: unknown[]): void;
-}
-export interface AssertLogFn {
-    (condition: boolean, message?: unknown, errorMessaage?: unknown): void;
-}
-export interface TableLogFn {
-    (properties?: object): void;
-}
-type loggingSettings = {
-    loggingLevel: LogLevel;
-};
-export interface Logger {
-    warn: LogFn;
-    error: LogFn;
-    debug: LogFn;
-    info: LogFn;
-}
-export type LogLevel = keyof Logger;
-export type BuildEnv = "production" | "development";
-export declare const logger: (category: string) => {
-    errorEnabled: boolean;
-    error: (message: string) => void;
-    debugEnabled?: undefined;
-    infoEnabled?: undefined;
-    warnEnabled?: undefined;
-    info?: undefined;
-    warn?: undefined;
-    debug?: undefined;
-} | {
-    debugEnabled: boolean;
-    infoEnabled: boolean;
-    warnEnabled: boolean;
-    errorEnabled: boolean;
-    info: (message: string) => void;
-    warn: (message: string) => void;
-    debug: (message: string) => void;
-    error: (message: string) => void;
-};
-export declare const getLoggingConfigForWorker: () => string;
-export {};

package/types/vuu-utils/src/menu-utils.d.ts

@@ -1,20 +0,0 @@
-import { ContextMenuGroupItemDescriptor, ContextMenuItemDescriptor, DataSourceRow, MenuRpcResponse, OpenDialogActionWithSchema, RpcResponse } from "@vuu-ui/vuu-data-types";
-import { ClientToServerMenuRPC, VuuMenu, VuuMenuItem } from "@vuu-ui/vuu-protocol-types";
-import { TableMenuLocation, VuuCellMenuItem, VuuRowMenuItem } from "@vuu-ui/vuu-table-types";
-import { type ColumnMap } from "./column-utils";
-export type VuuServerMenuOptions = {
-    columnMap: ColumnMap;
-    columnName: string;
-    row: DataSourceRow;
-    selectedRows: DataSourceRow[];
-    viewport: string;
-};
-export declare const isRoot: (menu: VuuMenu) => boolean;
-export declare const isCellMenu: (options: VuuMenuItem) => options is VuuCellMenuItem;
-export declare const isRowMenu: (options: VuuMenuItem) => options is VuuRowMenuItem;
-export declare const isSelectionMenu: (options: VuuMenuItem) => options is VuuMenuItem;
-export declare const isGroupMenuItemDescriptor: (menuItem?: ContextMenuItemDescriptor) => menuItem is ContextMenuGroupItemDescriptor;
-export declare const isTableLocation: (location: string) => location is TableMenuLocation;
-export declare const buildMenuDescriptorFromVuuMenu: (menu: VuuMenu | VuuMenuItem, tableLocation: TableMenuLocation, options: VuuServerMenuOptions) => ContextMenuItemDescriptor | undefined;
-export declare const getMenuRpcRequest: (options: VuuMenuItem) => Omit<ClientToServerMenuRPC, "vpId">;
-export declare const isOpenBulkEditResponse: (res: RpcResponse) => res is MenuRpcResponse<OpenDialogActionWithSchema>;

package/types/vuu-utils/src/module-utils.d.ts

@@ -1,9 +0,0 @@
-/// <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/vuu-utils/src/nanoid/index.d.ts

@@ -1 +0,0 @@
-export declare const uuid: (size?: number) => string;

package/types/vuu-utils/src/perf-utils.d.ts

@@ -1,5 +0,0 @@
-type VoidFunction = (...args: any) => void;
-export type PerfFunction<T extends VoidFunction> = (...args: Parameters<T>) => void;
-export declare function debounce<T extends VoidFunction>(callback: T, timeInterval: number): PerfFunction<T>;
-export declare function throttle<T extends VoidFunction>(callback: T, limit: number): PerfFunction<T>;
-export {};

package/types/vuu-utils/src/protocol-message-utils.d.ts

@@ -1,6 +0,0 @@
-import type { MenuRpcAction, MenuRpcResponse, OpenDialogActionWithSchema, RpcResponse, VuuUIMessageOut, VuuUiMessageInRequestResponse } from "@vuu-ui/vuu-data-types";
-import { ClientToServerMenuRPC, OpenDialogAction, VuuRpcRequest } from "@vuu-ui/vuu-protocol-types";
-export declare const isVuuMenuRpcRequest: (message: VuuUIMessageOut | VuuRpcRequest | ClientToServerMenuRPC) => message is ClientToServerMenuRPC;
-export declare const isRequestResponse: (message: object) => message is VuuUiMessageInRequestResponse;
-export declare const isOpenSessionTableDialogMessage: (rpcResponse: RpcResponse) => rpcResponse is MenuRpcResponse<OpenDialogActionWithSchema>;
-export declare const isOpenDialogAction: (action?: MenuRpcAction) => action is OpenDialogAction;

package/types/vuu-utils/src/range-utils.d.ts

@@ -1,25 +0,0 @@
-export interface VuuRange {
-    from: number;
-    to: number;
-    bufferSize?: number;
-    reset?: boolean;
-}
-interface FromToRange {
-    from: number;
-    to: number;
-}
-export declare const NULL_RANGE: VuuRange;
-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;
-export declare class WindowRange {
-    from: number;
-    to: number;
-    constructor(from: number, to: number);
-    isWithin(index: number): boolean;
-    overlap(from: number, to: number): [number, number];
-    copy(): WindowRange;
-}
-export {};

package/types/vuu-utils/src/react-utils.d.ts

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

package/types/vuu-utils/src/round-decimal.d.ts

@@ -1 +0,0 @@
-export declare function roundDecimal(value?: number, align?: string, decimals?: number, zeroPad?: boolean, alignOnDecimals?: boolean): string;

package/types/vuu-utils/src/row-utils.d.ts

@@ -1,25 +0,0 @@
-import type { DataSourceRow, DataSourceRowObject } from "@vuu-ui/vuu-data-types";
-import type { MutableRefObject } from "react";
-import { ColumnMap } from "./column-utils";
-export type RowOffsetFunc = (row: DataSourceRow, pctScrollTop?: number) => number;
-export type RowAtPositionFunc = (position: number) => number;
-/**
- * RowOffset function, RowAtPosition function, isVirtualScroll
- */
-export type RowPositioning = [RowOffsetFunc, RowAtPositionFunc, boolean];
-export declare const actualRowPositioning: (rowHeight: number) => RowPositioning;
-/**
- * return functions for determining a) the pixel offset to apply to a row, given the
- * row index and b) the index of the row at a given scroll offset. This implementation
- * is used when we are forced to 'virtualise' scrolling - because the number of rows
- * is high enough that we cannot create a large enough HTML content container.
- *
- * @param rowHeight
- * @param virtualisedExtent
- * @param pctScrollTop
- * @returns
- */
-export declare const virtualRowPositioning: (rowHeight: number, virtualisedExtent: number, pctScrollTop: MutableRefObject<number>) => RowPositioning;
-export declare const getRowElementAtIndex: (container: HTMLDivElement | EventTarget, rowIndex: number) => HTMLElement | null;
-export declare const getIndexFromRowElement: (rowElement: HTMLElement) => number;
-export declare const asDataSourceRowObject: (row: DataSourceRow, columnMap: ColumnMap) => DataSourceRowObject;

package/types/vuu-utils/src/selection-utils.d.ts

@@ -1,28 +0,0 @@
-import { DataSourceRow, Selection, SelectionItem } from "@vuu-ui/vuu-data-types";
-import { TableSelectionModel } from "@vuu-ui/vuu-table-types";
-export declare const RowSelected: {
-    False: number;
-    True: number;
-    First: number;
-    Last: number;
-};
-export declare const isRowSelected: (row: DataSourceRow) => boolean;
-export declare const isRowSelectedLast: (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[];
-    removed: SelectionItem[];
-};

package/types/vuu-utils/src/sort-utils.d.ts

@@ -1,5 +0,0 @@
-import { ColumnDescriptor, RuntimeColumnDescriptor } from "@vuu-ui/vuu-table-types";
-import { VuuSort, VuuSortType } from "@vuu-ui/vuu-protocol-types";
-export declare const toggleOrApplySort: ({ sortDefs }: VuuSort, { name: column }: ColumnDescriptor, extendSort?: boolean, sortType?: VuuSortType) => VuuSort;
-export declare const setSortColumn: ({ sortDefs }: VuuSort, column: RuntimeColumnDescriptor, sortType?: "A" | "D") => VuuSort;
-export declare const addSortColumn: ({ sortDefs }: VuuSort, column: RuntimeColumnDescriptor, sortType?: "A" | "D") => VuuSort;

package/types/vuu-utils/src/table-schema-utils.d.ts

@@ -1,3 +0,0 @@
-import { TableSchemaTable } from "@vuu-ui/vuu-data-types";
-import { VuuTable } from "@vuu-ui/vuu-protocol-types";
-export declare const getVuuTable: (schemaTable: TableSchemaTable) => VuuTable;

package/types/vuu-utils/src/text-utils.d.ts

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

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

@@ -1 +0,0 @@
-export declare function isNotNullOrUndefined<T>(value: T | undefined | null): value is NonNullable<T>;

package/types/vuu-utils/src/url-utils.d.ts

@@ -1,2 +0,0 @@
-export declare const getUrlParameter: (paramName: string, defaultValue?: string) => string | undefined;
-export declare const hasUrlParameter: (paramName: string) => boolean;

package/types/vuu-utils/src/useId.d.ts

@@ -1 +0,0 @@
-export declare const useId: (id?: string) => string;

package/types/vuu-utils/src/useLayoutEffectSkipFirst.d.ts

@@ -1,2 +0,0 @@
-import { DependencyList, EffectCallback } from "react";
-export declare const useLayoutEffectSkipFirst: (func: EffectCallback, deps: DependencyList) => void;

package/types/vuu-utils/src/user-types.d.ts

@@ -1,4 +0,0 @@
-export type VuuUser = {
-    username: string;
-    token: string;
-};