@vuu-ui/vuu-data-react 0.13.47 → 0.13.49

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

@@ -1,34 +0,0 @@
-import type { MenuRpcAction, MenuRpcResponse, OpenDialogActionWithSchema, RpcResponse, TableSchema, VuuUiMessageInRequestResponse } from "@vuu-ui/vuu-data-types";
-import { VuuRpcMenuRequest, OpenDialogAction, VuuRpcEditCellRequest, VuuRpcRequest, VuuRpcEditAddRowRequest, VuuDataRowDto, VuuRpcEditDeleteRowRequest, VuuRpcResponse, VuuRpcMenuSuccess, VuuViewportRpcTypeaheadRequest, VuuRpcServiceRequest, ViewportRpcContext, OpenComponentInDialogAction, VuuLoginResponse, VuuRowDataItemType, SelectRequest, SelectResponse, SelectSuccessWithRowCount } from "@vuu-ui/vuu-protocol-types";
-export declare const isSelectRequest: (message: object) => message is SelectRequest;
-export declare const isSelectSuccessWithRowCount: (response: SelectResponse | SelectSuccessWithRowCount) => response is SelectSuccessWithRowCount;
-export declare const isRpcServiceRequest: (message: {
-    type: string;
-}) => message is VuuRpcServiceRequest | Omit<VuuRpcServiceRequest, "context">;
-export declare const hasViewPortContext: (message: VuuRpcServiceRequest) => message is VuuRpcServiceRequest<ViewportRpcContext>;
-export declare const isVuuMenuRpcRequest: (message: VuuRpcRequest | Omit<VuuRpcRequest, "vpId">) => message is VuuRpcMenuRequest;
-export declare const isLoginResponse: (message: object) => message is VuuLoginResponse;
-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;
-export declare const isTypeaheadRequest: (request: Omit<VuuRpcRequest, "vpId">) => request is Omit<VuuViewportRpcTypeaheadRequest, "vpId">;
-export declare function isEditCellRequest(request: VuuRpcRequest): request is VuuRpcEditCellRequest;
-export declare function isEditCellRequest(request: Omit<VuuRpcRequest, "vpId">): request is Omit<VuuRpcEditCellRequest, "vpId">;
-export declare function vuuEditCellRequest(rowKey: string, field: string, value: VuuRowDataItemType, vpId: string): VuuRpcEditCellRequest;
-export declare function vuuEditCellRequest(rowKey: string, field: string, value: VuuRowDataItemType): Omit<VuuRpcEditCellRequest, "vpId">;
-export declare function vuuAddRowRequest(rowKey: string, data: VuuDataRowDto, vpId: string): VuuRpcEditAddRowRequest;
-export declare function vuuAddRowRequest(rowKey: string, data: VuuDataRowDto): Omit<VuuRpcEditAddRowRequest, "vpId">;
-export declare function vuuDeleteRowRequest(rowKey: string, vpId: string): VuuRpcEditDeleteRowRequest;
-export declare function vuuDeleteRowRequest(rowKey: string): Omit<VuuRpcEditDeleteRowRequest, "vpId">;
-export declare const isSessionTable: (table?: unknown) => boolean;
-export declare function isActionMessage(rpcResponse: VuuRpcResponse): rpcResponse is VuuRpcMenuSuccess;
-export declare function isActionMessage(rpcResponse: Omit<VuuRpcResponse, "vpId">): rpcResponse is Omit<VuuRpcMenuSuccess, "vpId">;
-export declare function isSessionTableActionMessage(rpcResponse: VuuRpcResponse): rpcResponse is VuuRpcMenuSuccess<OpenDialogAction & {
-    tableSchema: TableSchema;
-}>;
-export declare function isSessionTableActionMessage(rpcResponse: Omit<VuuRpcResponse, "vpId">): rpcResponse is Omit<VuuRpcMenuSuccess<OpenDialogAction & {
-    tableSchema: TableSchema;
-}>, "vpId">;
-export declare function isCustomComponentActionMessage(rpcResponse: VuuRpcResponse | Omit<VuuRpcResponse, "vpId">): rpcResponse is VuuRpcMenuSuccess<OpenComponentInDialogAction & {
-    tableSchema: TableSchema;
-}>;

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

@@ -1,31 +0,0 @@
-import { VuuRange } from "@vuu-ui/vuu-protocol-types";
-interface FromToRange {
-    from: number;
-    to: number;
-}
-export interface Range extends VuuRange {
-    equals: (vuuRange: VuuRange) => boolean;
-    firstRowInViewport: number;
-    lastRowInViewport: number;
-    renderBufferSize?: number;
-    reset: Range;
-    rowCount?: number;
-}
-export interface RangeOptions {
-    renderBufferSize?: number;
-    rowCount?: number;
-}
-export declare const Range: (from: number, to: number, rangeOptions?: RangeOptions) => Range;
-export declare const NULL_RANGE: Range;
-export declare function getFullRange({ from, to }: VuuRange, bufferSize?: number, totalRowCount?: number): FromToRange;
-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,8 +0,0 @@
-import { ReactElement, ReactNode, SetStateAction } from "react";
-export declare const asReactElements: (children: ReactNode) => ReactElement[];
-export declare const useIsMounted: (id?: string) => import("react").RefObject<boolean>;
-export declare const isSimpleStateValue: <T>(arg: SetStateAction<T>) => arg is T;
-/**
- * From an example by stack overflow user Maxim G
- */
-export declare const createSyntheticEvent: <T extends Element, E extends Event>(event: E) => React.SyntheticEvent<T, E>;

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,27 +0,0 @@
-import type { DataSourceRow, DataSourceRowObject } from "@vuu-ui/vuu-data-types";
-import { ColumnMap } from "./column-utils";
-import { IKeySet } from "./keyset";
-import { VuuRow } from "@vuu-ui/vuu-protocol-types";
-import { RefObject } from "react";
-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: RefObject<number>) => RowPositioning;
-export type RowToObjectMapper = (row: DataSourceRow, columnMap: ColumnMap) => DataSourceRowObject;
-export declare const asDataSourceRowObject: RowToObjectMapper;
-export declare const vuuRowToDataSourceRow: ({ rowIndex, rowKey, sel: isSelected, ts, data }: VuuRow, keys: IKeySet) => DataSourceRow;

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

@@ -1,4 +0,0 @@
-import { TableSelectionModel } from "@vuu-ui/vuu-table-types";
-import { SelectRequest } from "@vuu-ui/vuu-protocol-types";
-export declare const deselectItem: (selectionModel: TableSelectionModel, rowKey: string, rangeSelect: boolean, preserveExistingSelection?: boolean) => Omit<SelectRequest, "vpId"> | undefined;
-export declare const selectItem: (selectionModel: TableSelectionModel, rowKey: string, rangeSelect: boolean, preserveExistingSelection?: boolean, activeRowKey?: string) => Omit<SelectRequest, "vpId"> | undefined;

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

@@ -1,15 +0,0 @@
-import { ValueOf } from "./ts-utils";
-/**
- * The Vuu Shell creates the outermost application layout. This includes some
- * 'special' identifiers that can be targetted by layout commands to effect or
- * react to layout changes.
- */
-export declare const VuuShellLocation: {
-    readonly ContextPanel: "context-panel";
-    readonly MultiWorkspaceContainer: "vuu-multi-workspace-container";
-    readonly SidePanel: "vuu-side-panel";
-    readonly SideToolbar: "vuu-side-toolbar";
-    readonly Workspace: "vuu-workspace";
-    readonly WorkspaceContainer: "vuu-workspace-container";
-};
-export type VuuShellLocation = ValueOf<typeof VuuShellLocation>;

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

@@ -1,11 +0,0 @@
-import { ColumnDescriptor } 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: ColumnDescriptor, sortType?: "A" | "D") => VuuSort;
-export declare const addSortColumn: ({ sortDefs }: VuuSort, column: ColumnDescriptor, sortType?: "A" | "D") => VuuSort;
-export type ColumnSortStatus = "no-sort" | "sort-other-column" | "single-sort-asc" | "single-sort-desc" | "multi-sort-includes-column-asc" | "multi-sort-includes-column-desc";
-/**
- * Given a VuuSort definition and a column, determine whether the given column
- * is included in the sort and if so, in what position/direction.
- */
-export declare const getSortStatus: (columnName: string, vuuSort?: VuuSort) => ColumnSortStatus;

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/tree-types.d.ts

@@ -1,9 +0,0 @@
-export interface TreeSourceNode<T = unknown> {
-    nodeData?: T;
-    id: string;
-    icon?: string;
-    header?: boolean;
-    label: string;
-    childNodes?: TreeSourceNode<T>[];
-    tags?: string[];
-}

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

@@ -1,9 +0,0 @@
-import { TreeSourceNode } from "./tree-types";
-import { ColumnDescriptor } from "@vuu-ui/vuu-table-types";
-import { DataSourceRow } from "@vuu-ui/vuu-data-types";
-import { IconProvider } from "@vuu-ui/vuu-data-local/src/tree-data-source/IconProvider";
-export declare const treeToDataSourceRows: (treeSourceNodes: TreeSourceNode[], iconProvider?: IconProvider) => [ColumnDescriptor[], DataSourceRow[]];
-export declare const lastPathSegment: (path: string, separator?: string) => string;
-export declare const dropLastPathSegment: (path: string, separator?: string) => string;
-export declare const getParentRow: (rows: DataSourceRow[], row: DataSourceRow) => DataSourceRow | undefined;
-export declare const missingAncestor: (row: DataSourceRow, previousRow?: DataSourceRow) => boolean;

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

@@ -1,20 +0,0 @@
-import { JSXElementConstructor, ReactElement } from "react";
-import { LayoutJSON } from "./json-types";
-export declare function isNotNullOrUndefined<T>(value: T | undefined | null): value is NonNullable<T>;
-export declare const isObject: (o: unknown) => o is object;
-export type OptionalProperty<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
-export type ValueOf<T> = T[keyof T];
-/**
- * test whether a given react element implements a custom toJSON
- * serialisation (static) method.
- */
-type JsonEnabledJSXElementConstructor<P> = JSXElementConstructor<P> & {
-    toJSON: (el: ReactElement) => LayoutJSON<any>;
-};
-interface ReactElementWithJSON<P = any, T extends JsonEnabledJSXElementConstructor<any> = JsonEnabledJSXElementConstructor<any>> {
-    type: T;
-    props: P;
-    key: string | null;
-}
-export declare const elementImplementsJSONSerialization: (element: ReactElement) => element is ReactElementWithJSON;
-export {};

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

@@ -1 +0,0 @@
-export declare const NO_DATA_MATCH: string[];

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/useStateRef.d.ts

@@ -1,2 +0,0 @@
-import { Dispatch, MutableRefObject, SetStateAction } from "react";
-export declare const useStateRef: <T = string>(initialValue: T) => [MutableRefObject<T>, Dispatch<SetStateAction<T>>];

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

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