@vuu-ui/vuu-utils 0.8.17-debug → 0.8.18-debug

package/package.json

@@ -1,17 +1,19 @@
 {
   "name": "@vuu-ui/vuu-utils",
-  "version": "0.8.17-debug",
+  "version": "0.8.18-debug",
   "author": "heswell",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@vuu-ui/vuu-table-types": "0.8.17-debug",
-    "@vuu-ui/vuu-filter-types": "0.8.17-debug",
-    "@vuu-ui/vuu-protocol-types": "0.8.17-debug"
+    "@vuu-ui/vuu-data-types": "0.8.18-debug",
+    "@vuu-ui/vuu-table-types": "0.8.18-debug",
+    "@vuu-ui/vuu-filter-types": "0.8.18-debug",
+    "@vuu-ui/vuu-protocol-types": "0.8.18-debug"
   },
   "peerDependencies": {
     "react": ">=17.0.2",
     "react-dom": ">=17.0.2"
   },
+  "sideEffects": false,
   "files": [
     "cjs",
     "esm",

package/types/ThemeProvider.d.ts

@@ -0,0 +1,32 @@
+import React, { ReactNode } from "react";
+export declare const DEFAULT_DENSITY: Density;
+export declare const DEFAULT_THEME = "salt-theme";
+export declare const DEFAULT_THEME_MODE: ThemeMode;
+export type Density = "high" | "medium" | "low" | "touch";
+export type ThemeMode = "light" | "dark";
+export type TargetElement = "root" | "scope" | "child";
+export interface ThemeContextProps {
+    density: Density;
+    theme: string;
+    themeMode: ThemeMode;
+}
+export declare const ThemeContext: React.Context<ThemeContextProps>;
+export type ThemeClasses = [string, string, ThemeMode];
+export type ThemeAttributes = {
+    themeClass: string;
+    densityClass: string;
+    dataMode: ThemeMode;
+};
+export declare const useThemeAttributes: (themeAttributes?: ThemeAttributes) => [string, string, ThemeMode];
+interface ThemeProviderProps {
+    applyThemeClasses?: boolean;
+    children: ReactNode;
+    density?: Density;
+    theme?: string;
+    themeMode?: ThemeMode;
+}
+export declare const ThemeProvider: {
+    ({ applyThemeClasses, children, theme: themeProp, themeMode: themeModeProp, density: densityProp, }: ThemeProviderProps): JSX.Element;
+    displayName: string;
+};
+export {};

package/types/column-utils.d.ts

@@ -1,9 +1,7 @@
-import type { SchemaColumn, TableSchema } from "@vuu-ui/vuu-data";
-import type { DataSourceFilter, DataSourceRow } from "@vuu-ui/vuu-data-types";
-import type { ColumnAlignment, ColumnDescriptor, ColumnType, ColumnTypeDescriptor, ColumnTypeRendering, ColumnTypeWithValidationRules, GroupColumnDescriptor, RuntimeColumnDescriptor, MappedValueTypeRenderer, PinLocation, TableHeadings, ColumnTypeFormatting, LookupRenderer, ValueListRenderer, DateTimeColumnTypeSimple } from "@vuu-ui/vuu-table-types";
+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 { DefaultColumnConfiguration } from "@vuu-ui/vuu-shell";
+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 { CSSProperties } from "react";
 /**
  * ColumnMap provides a lookup of the index position of a data item within a row
@@ -23,22 +21,12 @@ 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;
-type DateTimeColumnType = DateTimeColumnTypeSimple | (Omit<ColumnTypeDescriptor, "name"> & {
-    name: DateTimeColumnTypeSimple;
-});
-export type DateTimeColumnDescriptor = Omit<ColumnDescriptor, "type"> & {
-    type: DateTimeColumnType;
-};
-export declare const isDateColumn: ({ type }: ColumnDescriptor) => boolean;
-export declare const isTimeColumn: ({ type }: ColumnDescriptor) => boolean;
 export declare const isDateTimeColumn: (column: ColumnDescriptor) => column is DateTimeColumnDescriptor;
 export declare const isPinned: (column: ColumnDescriptor) => boolean;
 export declare const hasHeadings: (column: ColumnDescriptor) => boolean;
 export declare const isResizing: (column: RuntimeColumnDescriptor) => boolean | undefined;
 export declare const isTextColumn: ({ serverDataType }: ColumnDescriptor) => boolean;
 export declare const toColumnDescriptor: (name: string) => ColumnDescriptor;
-export declare const isSimpleColumnType: (value: unknown) => value is ColumnTypeSimple;
-export declare type ColumnTypeSimple = "string" | "number" | "boolean" | "json" | "date" | "time" | "checkbox";
 /**
  *
  */
@@ -83,8 +71,8 @@ export declare const isFilteredColumn: (column: RuntimeColumnDescriptor) => bool
 export declare const stripFilterFromColumns: (columns: RuntimeColumnDescriptor[]) => {
     align?: "left" | "right" | undefined;
     CellRenderer?: import("react").FunctionComponent<import("@vuu-ui/vuu-table-types").TableCellRendererProps> | undefined;
-    HeaderCellLabelRenderer?: import("react").FunctionComponent<HeaderCellProps> | undefined;
-    HeaderCellContentRenderer?: import("react").FunctionComponent<HeaderCellProps> | 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;
     className?: string | undefined;
     clientSideEditValidationCheck?: import("packages/vuu-ui-controls/src").ClientSideValidationChecker | undefined;
     endPin?: true | undefined;
@@ -129,7 +117,8 @@ 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 getDefaultColumnType: (serverDataType?: VuuColumnDataType) => ColumnTypeSimple;
-export declare const updateColumnType: <T extends ColumnDescriptor = ColumnDescriptor>(column: T, formatting: ColumnTypeFormatting) => T;
+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;
 export declare const updateColumnRenderProps: <T extends ColumnDescriptor = ColumnDescriptor>(column: T, renderer: ColumnTypeRendering) => T;
 export declare const getTypeFormattingFromColumn: (column: ColumnDescriptor) => ColumnTypeFormatting;
 /**
@@ -150,4 +139,3 @@ export declare const setCalculatedColumnExpression: (column: ColumnDescriptor, e
 export declare const moveColumnTo: (columns: ColumnDescriptor[], column: ColumnDescriptor, newIndex: number) => ColumnDescriptor[];
 export declare function replaceColumn<C extends ColumnDescriptor = RuntimeColumnDescriptor>(columns: C[], column: C): C[];
 export declare const applyDefaultColumnConfig: ({ columns, table }: TableSchema, getDefaultColumnConfig?: DefaultColumnConfiguration) => SchemaColumn[];
-export {};

package/types/component-registry.d.ts

@@ -1,7 +1,6 @@
 import { FunctionComponent as FC, HTMLAttributes } from "react";
-import { ColumnDescriptor, ColumnDescriptorCustomRenderer, ColumnTypeRendering, EditValidationRule, TableCellRendererProps } from "@vuu-ui/vuu-table-types";
+import { ColumnDescriptor, ColumnDescriptorCustomRenderer, ColumnTypeRendering, EditValidationRule, HeaderCellProps, TableCellRendererProps } from "@vuu-ui/vuu-table-types";
 import { VuuColumnDataType, VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
-import { HeaderCellProps } from "@vuu-ui/vuu-table";
 export interface CellConfigPanelProps extends HTMLAttributes<HTMLDivElement> {
     onConfigChange: () => void;
 }
@@ -13,7 +12,7 @@ export interface ConfigurationEditorProps {
 }
 export type ConfigEditorComponent = FC<CellConfigPanelProps>;
 export type EditRuleValidator = (editRule: EditValidationRule, value?: VuuRowDataItemType) => boolean | string;
-export type ComponentType = "cell-renderer" | "cell-config-panel" | "data-edit-validator";
+export type ComponentType = "cell-renderer" | "column-header-content-renderer" | "column-header-label-renderer" | "cell-config-panel" | "data-edit-validator";
 type CellRendererOptions = {
     configEditor?: string;
     description?: string;
@@ -27,7 +26,9 @@ export declare function registerComponent<T extends TableCellRendererProps | Cel
 export declare const registerConfigurationEditor: (componentName: string, configurationEditor: FC<ConfigurationEditorProps>) => void;
 export declare const getRegisteredCellRenderers: (serverDataType?: VuuColumnDataType | "json") => CellRendererDescriptor[];
 export declare const getCellRendererOptions: (renderName: string) => CellRendererOptions | undefined;
-export declare function getCellRenderer(column: ColumnDescriptor, cellType?: "cell" | "col-content" | "col-label"): FC<TableCellRendererProps> | undefined;
+export declare function getCellRenderer(column: ColumnDescriptor): FC<TableCellRendererProps> | undefined;
+export declare function getColumnHeaderContentRenderer(column: ColumnDescriptor): FC<HeaderCellProps> | undefined;
+export declare function getColumnHeaderLabelRenderer(column: ColumnDescriptor): FC<HeaderCellProps> | undefined;
 export declare function getConfigurationEditor(configEditor?: string): FC<ConfigurationEditorProps> | undefined;
 export declare function getCellConfigPanelRenderer(name: string): ConfigEditorComponent | undefined;
 export declare function getEditRuleValidator(name: string): EditRuleValidator | undefined;

package/types/datasource-action-utils.d.ts

@@ -0,0 +1,7 @@
+import { DataSourceMenusMessage, DataSourceVisualLinkCreatedMessage, DataSourceVisualLinkRemovedMessage, DataSourceVisualLinksMessage, VuuFeatureMessage } from "@vuu-ui/vuu-data-types";
+import { GridAction } from "@vuu-ui/vuu-table-types";
+export declare const isVisualLinksAction: (action: GridAction) => action is DataSourceVisualLinksMessage;
+export declare const isVisualLinkCreatedAction: (action: GridAction) => action is DataSourceVisualLinkCreatedMessage;
+export declare const isVisualLinkRemovedAction: (action: GridAction) => action is DataSourceVisualLinkRemovedMessage;
+export declare const isViewportMenusAction: (action: GridAction) => action is DataSourceMenusMessage;
+export declare const isVuuFeatureAction: (action: GridAction) => action is VuuFeatureMessage;

package/types/datasource-utils.d.ts

@@ -0,0 +1,25 @@
+import { ConnectionQualityMetrics, ConnectionStatusMessage, DataSourceConfig, MenuRpcResponse, RpcResponse, TypeaheadSuggestionProvider, VuuUIMessageIn, VuuUIMessageInRPC, VuuUIMessageInRPCEditReject, VuuUIMessageInRPCEditResponse, VuuUIMessageInTableMeta, VuuUIMessageOutViewport, WithFilter, WithFullConfig, WithGroupBy, WithSort } from "@vuu-ui/vuu-data-types";
+import { LinkDescriptorWithLabel, VuuFilter, VuuSort } from "@vuu-ui/vuu-protocol-types";
+export declare const NoFilter: VuuFilter;
+export declare const NoSort: VuuSort;
+export declare const vanillaConfig: WithFullConfig;
+type DataConfigPredicate = (config: DataSourceConfig, newConfig: DataSourceConfig) => boolean;
+export declare const columnsChanged: DataConfigPredicate;
+export declare const filterChanged: DataConfigPredicate;
+export declare const groupByChanged: DataConfigPredicate;
+export declare const configChanged: (config: DataSourceConfig | undefined, newConfig: DataSourceConfig | undefined) => boolean;
+export declare const hasGroupBy: (config?: DataSourceConfig) => config is WithGroupBy;
+export declare const hasFilter: (config?: DataSourceConfig) => config is WithFilter;
+export declare const hasSort: (config?: DataSourceConfig) => config is WithSort;
+export declare const isTypeaheadSuggestionProvider: (source: unknown) => source is TypeaheadSuggestionProvider;
+export declare const isTableSchema: (message: VuuUIMessageIn) => message is VuuUIMessageInTableMeta;
+export declare const isConnectionStatusMessage: (msg: object | ConnectionStatusMessage) => msg is ConnectionStatusMessage;
+export declare const isConnectionQualityMetrics: (msg: object) => msg is ConnectionQualityMetrics;
+export declare const messageHasResult: (msg: object) => msg is VuuUIMessageInRPC;
+export declare const isErrorResponse: (response?: RpcResponse) => response is VuuUIMessageInRPCEditReject;
+export declare const hasAction: (response?: RpcResponse) => response is MenuRpcResponse | VuuUIMessageInRPCEditResponse;
+export declare const isViewporttMessage: (msg: object) => msg is VuuUIMessageOutViewport;
+export declare const withConfigDefaults: (config: DataSourceConfig) => WithFullConfig & {
+    visualLink?: LinkDescriptorWithLabel;
+};
+export {};

package/types/date/helpers.d.ts

@@ -1,5 +1,8 @@
-import { DateTimeColumnTypeSimple } from "@vuu-ui/vuu-table-types";
-import { DateTimeColumnDescriptor } from "../column-utils";
+import { DateTimeColumnDescriptor } from "@vuu-ui/vuu-table-types";
 import { DateTimePattern } from "./types";
-export declare const defaultPatternByTypes: Record<DateTimeColumnTypeSimple, DateTimePattern>;
+export declare const defaultPatternsByType: {
+    readonly time: "hh:mm:ss";
+    readonly date: "dd.mm.yyyy";
+};
+export declare const fallbackDateTimePattern: DateTimePattern;
 export declare function dateTimePattern(type: DateTimeColumnDescriptor["type"]): DateTimePattern;

package/types/date/index.d.ts

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

package/types/date/types.d.ts

@@ -1,7 +1,18 @@
+import { ColumnTypeFormatting } from "@vuu-ui/vuu-table-types";
 declare const supportedDatePatterns: readonly ["dd.mm.yyyy", "dd/mm/yyyy", "dd MMM yyyy", "dd MMMM yyyy", "mm/dd/yyyy", "MMM dd, yyyy", "MMMM dd, yyyy"];
 declare const supportedTimePatterns: readonly ["hh:mm:ss", "hh:mm:ss a"];
+export declare const supportedDateTimePatterns: {
+    date: readonly ["dd.mm.yyyy", "dd/mm/yyyy", "dd MMM yyyy", "dd MMMM yyyy", "mm/dd/yyyy", "MMM dd, yyyy", "MMMM dd, yyyy"];
+    time: readonly ["hh:mm:ss", "hh:mm:ss a"];
+};
 export type DatePattern = (typeof supportedDatePatterns)[number];
 export type TimePattern = (typeof supportedTimePatterns)[number];
-export type DateTimePattern = DatePattern | TimePattern;
-export declare const isDateTimePattern: (pattern?: string) => pattern is DateTimePattern;
+export type DateTimePattern = {
+    date?: DatePattern;
+    time: TimePattern;
+} | {
+    date: DatePattern;
+    time?: TimePattern;
+};
+export declare const isDateTimePattern: (pattern?: ColumnTypeFormatting["pattern"]) => pattern is DateTimePattern;
 export {};

package/types/event-emitter.d.ts

@@ -1,6 +1,13 @@
 type Listener = (...args: any[]) => void;
 export type EmittedEvents = Record<string, Listener>;
-export declare class EventEmitter<Events extends EmittedEvents> {
+export interface IEventEmitter<Events extends EmittedEvents> {
+    addListener<E extends keyof Events>(event: E, listener: Events[E]): void;
+    emit<E extends keyof Events>(event: E, ...args: Parameters<Events[E]>): void;
+    on<E extends keyof Events>(event: E, listener: Events[E]): void;
+    removeListener<E extends keyof Events>(event: E, listener: Events[E]): void;
+    removeAllListeners<E extends keyof Events>(event?: E): void;
+}
+export declare class EventEmitter<Events extends EmittedEvents> implements IEventEmitter<Events> {
     #private;
     addListener<E extends keyof Events>(event: E, listener: Events[E]): void;
     removeListener<E extends keyof Events>(event: E, listener: Events[E]): void;

package/types/index.d.ts

@@ -6,6 +6,8 @@ export * from "./component-registry";
 export * from "./DataWindow";
 export * from "./common-types";
 export * from "./data-utils";
+export * from "./datasource-action-utils";
+export * from "./datasource-utils";
 export * from "./date";
 export * from "./debug-utils";
 export * from "./filter-utils";
@@ -30,5 +32,8 @@ export * from "./row-utils";
 export * from "./selection-utils";
 export * from "./sort-utils";
 export * from "./text-utils";
+export * from "./ThemeProvider";
+export * from "./ts-utils";
 export * from "./url-utils";
-export * from "./screenshot-utils";
+export * from "./useId";
+export * from "./useLayoutEffectSkipFirst";

package/types/selection-utils.d.ts

@@ -1,5 +1,5 @@
-import { DataSourceRow } from "@vuu-ui/vuu-data-types";
-import { Selection, SelectionItem, TableSelectionModel } from "@vuu-ui/vuu-table-types";
+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;

package/types/ts-utils.d.ts

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

package/types/useId.d.ts

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

package/types/useLayoutEffectSkipFirst.d.ts

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

package/types/screenshot-utils.d.ts

@@ -1,6 +0,0 @@
-/**
- * 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>;