@vuu-ui/vuu-table-extras 4.0.0-alpha.18 → 4.0.0-alpha.19

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.0.0-alpha.18",
+  "version": "4.0.0-alpha.19",
   "author": "heswell",
   "main": "./src/index.js",
   "license": "Apache-2.0",
@@ -12,20 +12,20 @@
     "lezer-generate:column": "lezer-generator --output ./src/column-expression-input/column-language-parser/generated/column-parser.ts ./src/column-expression-input/column-language-parser/grammar/column.grammar"
   },
   "devDependencies": {
-    "@vuu-ui/vuu-filter-types": "4.0.0-alpha.18",
-    "@vuu-ui/vuu-protocol-types": "4.0.0-alpha.18"
+    "@vuu-ui/vuu-filter-types": "4.0.0-alpha.19",
+    "@vuu-ui/vuu-protocol-types": "4.0.0-alpha.19"
   },
   "dependencies": {
-    "@vuu-ui/core": "4.0.0-alpha.18",
-    "@vuu-ui/vuu-codemirror": "4.0.0-alpha.18",
-    "@vuu-ui/vuu-data-editing": "4.0.0-alpha.18",
-    "@vuu-ui/vuu-data-react": "4.0.0-alpha.18",
-    "@vuu-ui/vuu-data-types": "4.0.0-alpha.18",
-    "@vuu-ui/vuu-table-types": "4.0.0-alpha.18",
-    "@vuu-ui/vuu-popups": "4.0.0-alpha.18",
-    "@vuu-ui/vuu-table": "4.0.0-alpha.18",
-    "@vuu-ui/vuu-utils": "4.0.0-alpha.18",
-    "@vuu-ui/vuu-ui-controls": "4.0.0-alpha.18",
+    "@vuu-ui/core": "4.0.0-alpha.19",
+    "@vuu-ui/vuu-codemirror": "4.0.0-alpha.19",
+    "@vuu-ui/vuu-data-editing": "4.0.0-alpha.19",
+    "@vuu-ui/vuu-data-react": "4.0.0-alpha.19",
+    "@vuu-ui/vuu-data-types": "4.0.0-alpha.19",
+    "@vuu-ui/vuu-table-types": "4.0.0-alpha.19",
+    "@vuu-ui/vuu-popups": "4.0.0-alpha.19",
+    "@vuu-ui/vuu-table": "4.0.0-alpha.19",
+    "@vuu-ui/vuu-utils": "4.0.0-alpha.19",
+    "@vuu-ui/vuu-ui-controls": "4.0.0-alpha.19",
     "@lezer/lr": "1.4.2",
     "@salt-ds/core": "1.67.0",
     "@salt-ds/lab": "1.0.0-alpha.99",

package/src/column-expression-input/useColumnExpressionSuggestionProvider.js

@@ -1,6 +1,6 @@
 import { AnnotationType, getRelationalOperators, numericOperators, stringOperators, toSuggestions } from "@vuu-ui/vuu-codemirror";
 import { getTypeaheadParams, useTypeaheadSuggestions } from "@vuu-ui/vuu-data-react";
-import { isNumericColumn, isTextColumn } from "@vuu-ui/vuu-utils";
+import { isNumericColumn, isTemporalColumn, isTextColumn } from "@vuu-ui/vuu-utils";
 import { useCallback, useRef } from "react";
 import { columnFunctionDescriptors } from "./column-function-descriptors.js";
 import { functionDocInfo } from "./functionDocInfo.js";
@@ -64,7 +64,7 @@ const arithmeticOperators = [
     }
 ];
 const getOperators = (column)=>{
-    if (void 0 === column || isNumericColumn(column)) return arithmeticOperators;
+    if (void 0 === column || isNumericColumn(column) || isTemporalColumn(column)) return arithmeticOperators;
     return NO_OPERATORS;
 };
 const getConditionOperators = (column)=>{

package/src/column-formatting-settings/ColumnFormattingPanel.js

@@ -1,5 +1,5 @@
 import { jsx, jsxs } from "react/jsx-runtime";
-import { getCellRendererOptions, getConfigurationEditor, isColumnTypeRenderer, isTypeDescriptor } from "@vuu-ui/vuu-utils";
+import { getCellRendererOptions, getConfigurationEditor, isColumnTypeRenderer, isTemporalColumn, isTypeDescriptor } from "@vuu-ui/vuu-utils";
 import { Dropdown, FormField, FormFieldLabel, Option } from "@salt-ds/core";
 import clsx from "clsx";
 import { useCallback, useMemo } from "react";
@@ -88,21 +88,24 @@ const ColumnFormattingPanel = ({ availableRenderers, className, column, onChange
 function getFormattingSettingsComponent(props) {
     const { column } = props;
     switch(column.serverDataType){
+        case "long":
+            return /*#__PURE__*/ jsx(LongTypeFormattingSettings, {
+                ...props
+            });
+        case "epochtimestamp":
+        case "epochtimestampnano":
+            return /*#__PURE__*/ jsx(DateTimeFormattingSettings, {
+                ...props
+            });
         case "double":
         case "scaleddecimal2":
         case "scaleddecimal4":
         case "scaleddecimal6":
         case "scaleddecimal8":
         case "int":
-            return /*#__PURE__*/ jsx(BaseNumericFormattingSettings, {
+            return isTemporalColumn(column) ? /*#__PURE__*/ jsx(DateTimeFormattingSettings, {
                 ...props
-            });
-        case "long":
-            return /*#__PURE__*/ jsx(LongTypeFormattingSettings, {
-                ...props
-            });
-        case "epochtimestamp":
-            return /*#__PURE__*/ jsx(DateTimeFormattingSettings, {
+            }) : /*#__PURE__*/ jsx(BaseNumericFormattingSettings, {
                 ...props
             });
         default:

package/src/column-formatting-settings/DateTimeFormattingSettings.js

@@ -1,5 +1,5 @@
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
-import { dateTimeLabelByType, defaultPatternsByType, fallbackDateTimePattern, getTypeFormattingFromColumn, isDatePattern, isTimePattern, supportedDateTimePatterns } from "@vuu-ui/vuu-utils";
+import { dateTimeLabelByType, dateTimePattern, defaultPatternsByType, fallbackDateTimePattern, getTemporalInfo, getTypeFormattingFromColumn, isDatePattern, isTimePattern, supportedDateTimePatterns } from "@vuu-ui/vuu-utils";
 import { Dropdown, FormField, FormFieldLabel, Option, ToggleButton, ToggleButtonGroup } from "@salt-ds/core";
 import { useCallback, useMemo, useState } from "react";
 const toggleValues = [
@@ -7,6 +7,32 @@ const toggleValues = [
     "time",
     "both"
 ];
+const DEFAULT = "default";
+const fractionalSecondDigitOptions = [
+    DEFAULT,
+    "0",
+    "3",
+    "6",
+    "9"
+];
+const timeZoneOptions = [
+    DEFAULT,
+    "local",
+    "UTC",
+    "Europe/London",
+    "Europe/Paris",
+    "America/New_York",
+    "Asia/Tokyo",
+    "Asia/Hong_Kong"
+];
+const localeOptions = [
+    DEFAULT,
+    "en-GB",
+    "en-US",
+    "de-DE",
+    "fr-FR",
+    "ja-JP"
+];
 function getToggleValue(pattern) {
     return pattern.time ? pattern.date ? "both" : "time" : "date";
 }
@@ -20,7 +46,8 @@ const getSelectedPattern = (pattern)=>{
 };
 const DateTimeFormattingSettings = ({ column, onChangeFormatting: onChange })=>{
     const formatting = getTypeFormattingFromColumn(column);
-    const { pattern = fallbackDateTimePattern } = formatting;
+    const temporalInfo = getTemporalInfo(column);
+    const { pattern = temporalInfo ? dateTimePattern(column.type, temporalInfo.kind) : fallbackDateTimePattern } = formatting;
     const toggleValue = useMemo(()=>getToggleValue(pattern), [
         pattern
     ]);
@@ -28,6 +55,26 @@ const DateTimeFormattingSettings = ({ column, onChangeFormatting: onChange })=>{
         time: pattern.time ?? defaultPatternsByType.time,
         date: pattern.date ?? defaultPatternsByType.date
     });
+    const onFractionalSecondDigitsChange = useCallback((_, [value])=>{
+        const { fractionalSecondDigits, ...rest } = formatting;
+        onChange(value === DEFAULT ? rest : {
+            ...rest,
+            fractionalSecondDigits: parseInt(value, 10)
+        });
+    }, [
+        formatting,
+        onChange
+    ]);
+    const onFormattingOptionChange = useCallback((key)=>(_, [value])=>{
+            const { [key]: _previous, ...rest } = formatting;
+            onChange(value === DEFAULT ? rest : {
+                ...rest,
+                [key]: value
+            });
+        }, [
+        formatting,
+        onChange
+    ]);
     const onPatternChange = useCallback((pattern)=>onChange({
             ...formatting,
             pattern
@@ -109,7 +156,64 @@ const DateTimeFormattingSettings = ({ column, onChangeFormatting: onChange })=>{
                                 }, i))
                         })
                     ]
-                }, v))
+                }, v)),
+            pattern.time ? /*#__PURE__*/ jsxs(FormField, {
+                labelPlacement: "top",
+                children: [
+                    /*#__PURE__*/ jsx(FormFieldLabel, {
+                        children: "Fractional second digits"
+                    }),
+                    /*#__PURE__*/ jsx(Dropdown, {
+                        onSelectionChange: onFractionalSecondDigitsChange,
+                        selected: [
+                            `${formatting.fractionalSecondDigits ?? DEFAULT}`
+                        ],
+                        value: `${formatting.fractionalSecondDigits ?? DEFAULT}`,
+                        children: fractionalSecondDigitOptions.filter((digits)=>temporalInfo?.precision === "ns" || "6" !== digits && "9" !== digits).map((digits)=>/*#__PURE__*/ jsx(Option, {
+                                value: digits,
+                                children: digits
+                            }, digits))
+                    })
+                ]
+            }) : null,
+            /*#__PURE__*/ jsxs(FormField, {
+                labelPlacement: "top",
+                children: [
+                    /*#__PURE__*/ jsx(FormFieldLabel, {
+                        children: "Time zone"
+                    }),
+                    /*#__PURE__*/ jsx(Dropdown, {
+                        onSelectionChange: onFormattingOptionChange("timeZone"),
+                        selected: [
+                            formatting.timeZone ?? DEFAULT
+                        ],
+                        value: formatting.timeZone ?? DEFAULT,
+                        children: timeZoneOptions.map((timeZone)=>/*#__PURE__*/ jsx(Option, {
+                                value: timeZone,
+                                children: timeZone
+                            }, timeZone))
+                    })
+                ]
+            }),
+            /*#__PURE__*/ jsxs(FormField, {
+                labelPlacement: "top",
+                children: [
+                    /*#__PURE__*/ jsx(FormFieldLabel, {
+                        children: "Locale"
+                    }),
+                    /*#__PURE__*/ jsx(Dropdown, {
+                        onSelectionChange: onFormattingOptionChange("locale"),
+                        selected: [
+                            formatting.locale ?? DEFAULT
+                        ],
+                        value: formatting.locale ?? DEFAULT,
+                        children: localeOptions.map((locale)=>/*#__PURE__*/ jsx(Option, {
+                                value: locale,
+                                children: locale
+                            }, locale))
+                    })
+                ]
+            })
         ]
     });
 };

package/src/column-formatting-settings/LongTypeFormattingSettings.js

@@ -5,7 +5,8 @@ import { useWindow } from "@salt-ds/window";
 import { useCallback } from "react";
 import { BaseNumericFormattingSettings } from "./BaseNumericFormattingSettings.js";
 import LongTypeFormattingSettings from "./LongTypeFormattingSettings.css";
-import { isTypeDescriptor } from "@vuu-ui/vuu-utils";
+import { isTemporalColumn, isTypeDescriptor } from "@vuu-ui/vuu-utils";
+import { DateTimeFormattingSettings } from "./DateTimeFormattingSettings.js";
 const classBase = "vuuLongColumnFormattingSettings";
 const LongTypeFormattingSettings_LongTypeFormattingSettings = (props)=>{
     const targetWindow = useWindow();
@@ -41,7 +42,9 @@ const LongTypeFormattingSettings_LongTypeFormattingSettings = (props)=>{
                     })
                 ]
             }),
-            /*#__PURE__*/ jsx(BaseNumericFormattingSettings, {
+            isTemporalColumn(column) ? /*#__PURE__*/ jsx(DateTimeFormattingSettings, {
+                ...props
+            }) : /*#__PURE__*/ jsx(BaseNumericFormattingSettings, {
                 ...props
             })
         ]
@@ -49,6 +52,8 @@ const LongTypeFormattingSettings_LongTypeFormattingSettings = (props)=>{
 };
 const toggleValues = [
     "number",
-    "date/time"
+    "date/time",
+    "date",
+    "time"
 ];
 export { LongTypeFormattingSettings_LongTypeFormattingSettings as LongTypeFormattingSettings };

package/src/csv-export/export-utils.js

@@ -1,4 +1,4 @@
-import { Range, isSessionTable, metadataKeys } from "@vuu-ui/vuu-utils";
+import { Range, buildColumnMap, getValueFormatter, isSessionTable, metadataKeys } from "@vuu-ui/vuu-utils";
 const EXPORT_EXCLUDED_COLUMNS = new Set([
     "vuuMsg",
     "vuuAction",
@@ -28,10 +28,31 @@ const triggerCsvDownload = (csv, filename)=>{
     document.body.removeChild(a);
     setTimeout(()=>URL.revokeObjectURL(url), 10000);
 };
+const createRowAccessor = (row, columnMap)=>new Proxy({}, {
+        get (_, prop) {
+            if ("string" == typeof prop) {
+                const idx = columnMap[prop];
+                if (void 0 !== idx) return row[idx];
+            }
+        },
+        has (_, prop) {
+            return "string" == typeof prop && void 0 !== columnMap[prop];
+        }
+    });
+const isExportableColumn = (descriptor)=>{
+    if (!descriptor) return true;
+    if (false === descriptor.exportable) return false;
+    if (descriptor.hidden) return false;
+    if (descriptor.isSystemColumn) return false;
+    if (true === descriptor.exportable) return true;
+    if ("client" === descriptor.source && !descriptor.exportFormatter) return false;
+    return true;
+};
 const exportCsvTemplate = async (dataSource, options = {})=>{
     const { filename = "template.csv", excludeColumns = [], columns, overrides, timeout = DEFAULT_TEMPLATE_TIMEOUT, onError, onSuccess } = options;
-    const sessionOverrides = overrides ?? (columns ? {
-        columns
+    const targetColumnNames = columns ? columns.filter((col)=>"string" == typeof col ? true : isExportableColumn(col) && "client" !== col.source).map((col)=>"string" == typeof col ? col : col.name) : void 0;
+    const sessionOverrides = overrides ?? (targetColumnNames ? {
+        columns: targetColumnNames
     } : void 0);
     if (!isSessionTable(dataSource.table) && dataSource.createSessionDataSource && "initialising" !== dataSource.status && "unsubscribed" !== dataSource.status) try {
         const sessionDataSource = await dataSource.createSessionDataSource("Empty", "export", sessionOverrides);
@@ -72,7 +93,7 @@ const exportCsvTemplate = async (dataSource, options = {})=>{
         console.warn("[exportCsvTemplate] createSessionDataSource failed, falling back to tableSchema", error);
     }
     const schema = dataSource.tableSchema;
-    const targetColumns = columns ?? overrides?.columns;
+    const targetColumns = targetColumnNames ?? overrides?.columns;
     if (void 0 !== targetColumns) {
         if (schema) {
             const schemaColumnNames = new Set(schema.columns.map((col)=>col.name));
@@ -99,7 +120,18 @@ const exportCsvTemplate = async (dataSource, options = {})=>{
     onSuccess?.();
 };
 const exportSessionTableToCsv = async (dataSource, options = {})=>{
-    const { filename = "export.csv", copyOption = "All", excludeColumns = [], maxRows = MAX_EXPORT_ROWS, columnDescriptors, overrides, timeout = DEFAULT_EXPORT_TIMEOUT, onError, onSuccess } = options;
+    const { filename = "export.csv", copyOption = "All", excludeColumns = [], maxRows = MAX_EXPORT_ROWS, columnDescriptors: rawColumnDescriptors, columns: rawColumns, overrides, timeout = DEFAULT_EXPORT_TIMEOUT, onError, onSuccess } = options;
+    const rawInputColumns = rawColumns ?? rawColumnDescriptors;
+    const columnDescriptors = rawInputColumns?.map((col)=>"string" == typeof col ? {
+            name: col
+        } : col);
+    const sessionOverrides = overrides ? {
+        ...overrides,
+        columns: overrides.columns?.filter((name)=>{
+            const desc = columnDescriptors?.find((d)=>d.name === name);
+            return desc?.source !== "client";
+        })
+    } : void 0;
     const isRemote = !!dataSource.isRemote;
     if (isRemote && !isSessionTable(dataSource.table) && ("initialising" === dataSource.status || "unsubscribed" === dataSource.status)) {
         const error = new Error(`exportSessionTableToCsv: dataSource must be subscribed before exporting (current status: "${dataSource.status}")`);
@@ -108,7 +140,7 @@ const exportSessionTableToCsv = async (dataSource, options = {})=>{
     }
     let sessionDataSource;
     if (!isSessionTable(dataSource.table) && dataSource.createSessionDataSource) try {
-        sessionDataSource = await dataSource.createSessionDataSource(copyOption, "export", overrides);
+        sessionDataSource = await dataSource.createSessionDataSource(copyOption, "export", sessionOverrides);
     } catch (err) {
         const error = err instanceof Error ? err : new Error(String(err));
         if (onError) return void onError(error);
@@ -152,18 +184,23 @@ const exportSessionTableToCsv = async (dataSource, options = {})=>{
                 const { columns } = message;
                 if (columnDescriptors) {
                     const subscribedSet = new Set(columns);
-                    const unknown = columnDescriptors.filter((d)=>!excluded.has(d.name) && !subscribedSet.has(d.name)).map((d)=>d.name);
+                    const unknown = columnDescriptors.filter((d)=>"client" !== d.source && !excluded.has(d.name) && !subscribedSet.has(d.name)).map((d)=>d.name);
                     if (unknown.length > 0) return void fail(new Error(`exportToCsv: unknown column(s) in columnDescriptors: ${unknown.join(", ")}`));
                     descriptorMap = Object.fromEntries(columnDescriptors.map((d)=>[
                             d.name,
                             d
                         ]));
                 }
-                exportCols = columns.filter((name)=>!excluded.has(name));
-                colNameToRowIdx = Object.fromEntries(columns.map((name, i)=>[
-                        name,
-                        metadataKeys.count + i
-                    ]));
+                if (rawColumns) exportCols = rawColumns.map((c)=>"string" == typeof c ? c : c.name).filter((name)=>!excluded.has(name) && isExportableColumn(descriptorMap[name]));
+                else if (columnDescriptors?.some((d)=>"client" === d.source)) {
+                    const definedNames = new Set(columnDescriptors.map((d)=>d.name));
+                    const remainingSubscribed = columns.filter((name)=>!excluded.has(name) && !definedNames.has(name) && isExportableColumn(descriptorMap[name]));
+                    exportCols = [
+                        ...columnDescriptors.filter((d)=>!excluded.has(d.name) && isExportableColumn(d)).map((d)=>d.name),
+                        ...remainingSubscribed
+                    ];
+                } else exportCols = columns.filter((name)=>!excluded.has(name) && isExportableColumn(descriptorMap[name]));
+                colNameToRowIdx = buildColumnMap(columns);
             } else if ("viewport-update" === message.type) {
                 if ("size-only" === message.mode) {
                     totalSize = message.size ?? 0;
@@ -191,11 +228,21 @@ const exportSessionTableToCsv = async (dataSource, options = {})=>{
                         ];
                         for(let i = 0; i < totalSize; i++){
                             const row = collectedRows.get(i);
-                            if (row) lines.push(exportCols.map((c)=>{
-                                const raw = row[colNameToRowIdx[c]];
-                                const formatter = descriptorMap[c]?.exportFormatter;
-                                return csvCell(formatter ? formatter(raw) : raw);
-                            }).join(","));
+                            if (row) {
+                                const rowAccessor = createRowAccessor(row, colNameToRowIdx);
+                                lines.push(exportCols.map((c)=>{
+                                    const descriptor = descriptorMap[c];
+                                    const isClientCol = descriptor?.source === "client";
+                                    const raw = isClientCol ? void 0 : void 0 !== colNameToRowIdx[c] ? row[colNameToRowIdx[c]] : void 0;
+                                    let formatted;
+                                    if (descriptor?.exportFormatter) formatted = descriptor.exportFormatter(raw, rowAccessor);
+                                    else if (descriptor && ("type" in descriptor || "serverDataType" in descriptor)) {
+                                        const tableFormatter = getValueFormatter(descriptor);
+                                        formatted = tableFormatter(raw);
+                                    } else formatted = raw;
+                                    return csvCell(formatted);
+                                }).join(","));
+                            }
                         }
                         triggerCsvDownload(lines.join("\r\n"), filename);
                         onSuccess?.();
@@ -213,9 +260,9 @@ const exportSessionTableToCsv = async (dataSource, options = {})=>{
         };
         activeSessionDataSource.subscribe({
             range: Range(0, 0),
-            columns: overrides?.columns
+            columns: sessionOverrides?.columns
         }, handleMessage);
     });
 };
 const exportToCsv = async (dataSource, options)=>exportSessionTableToCsv(dataSource, options);
-export { exportCsvTemplate, exportSessionTableToCsv, exportToCsv };
+export { exportCsvTemplate, exportSessionTableToCsv, exportToCsv, isExportableColumn };

package/src/csv-export/index.js

@@ -1,2 +1,2 @@
-export { exportCsvTemplate, exportSessionTableToCsv, exportToCsv } from "./export-utils.js";
+export { exportCsvTemplate, exportSessionTableToCsv, exportToCsv, isExportableColumn } from "./export-utils.js";
 export { useCsvExport } from "./useCsvExport.js";

package/src/csv-export/useCsvExport.js

@@ -6,7 +6,7 @@ function useCsvExport(propsOrDataSource) {
     const config = propsOrDataSource && "table" in propsOrDataSource ? {
         dataSource: propsOrDataSource
     } : propsOrDataSource ?? {};
-    const { dataSource: defaultDataSource, onError, onSuccess } = config;
+    const { dataSource: defaultDataSource, tableConfig, columns: defaultColumns, onError, onSuccess } = config;
     const exportCsv = useCallback(async (options, overrideDataSource)=>{
         const activeDataSource = overrideDataSource ?? defaultDataSource;
         if (!activeDataSource) {
@@ -19,7 +19,9 @@ function useCsvExport(propsOrDataSource) {
         setIsExporting(true);
         setError(null);
         try {
+            const columnsToExport = options?.columns ?? options?.columnDescriptors ?? defaultColumns ?? tableConfig?.columns;
             await exportToCsv(activeDataSource, {
+                columns: columnsToExport,
                 ...options,
                 onError: (err)=>{
                     setError(err);
@@ -42,6 +44,8 @@ function useCsvExport(propsOrDataSource) {
         }
     }, [
         defaultDataSource,
+        defaultColumns,
+        tableConfig,
         onError,
         onSuccess
     ]);
@@ -57,7 +61,9 @@ function useCsvExport(propsOrDataSource) {
         setIsExporting(true);
         setError(null);
         try {
+            const templateColumns = options?.columns ?? defaultColumns ?? tableConfig?.columns;
             await exportCsvTemplate(activeDataSource, {
+                columns: templateColumns,
                 ...options,
                 onError: (err)=>{
                     setError(err);
@@ -80,6 +86,8 @@ function useCsvExport(propsOrDataSource) {
         }
     }, [
         defaultDataSource,
+        defaultColumns,
+        tableConfig,
         onError,
         onSuccess
     ]);

package/src/table-footer/TableFooter.js

@@ -4,10 +4,10 @@ import { useComponentCssInjection } from "@salt-ds/styles";
 import { useWindow } from "@salt-ds/window";
 import TableFooter from "./TableFooter.css";
 const classBase = "vuuTableFooter";
-const TableFooterTray = ({ children, position = 'end' })=>/*#__PURE__*/ jsx("div", {
+const TableFooterTray = ({ children, position = "end" })=>/*#__PURE__*/ jsx("div", {
         className: clsx(`${classBase}Tray`, {
-            [`${classBase}Tray-center`]: 'center' === position,
-            [`${classBase}Tray-end`]: 'end' === position
+            [`${classBase}Tray-center`]: "center" === position,
+            [`${classBase}Tray-end`]: "end" === position
         }),
         children: children
     });

package/types/column-formatting-settings/DateTimeFormattingSettings.d.ts

@@ -1,3 +1,3 @@
-import { FormattingSettingsProps } from "@vuu-ui/vuu-table-types";
+import type { FormattingSettingsProps } from "@vuu-ui/vuu-table-types";
 import React from "react";
 export declare const DateTimeFormattingSettings: React.FC<FormattingSettingsProps>;

package/types/csv-export/export-utils.d.ts

@@ -1,16 +1,28 @@
 import type { CopyOption, DataSource, SessionDataSourceOverrides } from "@vuu-ui/vuu-data-types";
-export type ExportColumnDescriptor<TName extends string = string> = {
-    name: TName;
-    /** Override the column name used as the CSV header label. */
+import type { ColumnDescriptor, RowAccessor } from "@vuu-ui/vuu-table-types";
+export type { RowAccessor };
+export type ExportServerColumnDescriptor = Omit<ColumnDescriptor, "source" | "exportFormatter"> & {
+    name: string;
+    source?: "server";
     label?: string;
-    exportFormatter?: (value: unknown) => string;
+    exportable?: boolean;
+    exportFormatter?: (value: unknown, row: RowAccessor) => string;
 };
-export interface ExportToCsvOptions<TName extends string = string> {
+export type ExportClientColumnDescriptor = Omit<ColumnDescriptor, "source" | "exportFormatter"> & {
+    name: string;
+    source: "client";
+    label?: string;
+    exportable?: boolean;
+    exportFormatter: (value: unknown, row: RowAccessor) => string;
+};
+export type ExportColumnDescriptor = ExportServerColumnDescriptor | ExportClientColumnDescriptor;
+export interface ExportToCsvOptions {
     filename?: string;
     copyOption?: CopyOption;
     excludeColumns?: string[];
     maxRows?: number;
-    columnDescriptors?: ExportColumnDescriptor<TName>[];
+    columnDescriptors?: readonly (ExportColumnDescriptor | ColumnDescriptor)[];
+    columns?: readonly (string | ExportColumnDescriptor | ColumnDescriptor)[];
     overrides?: SessionDataSourceOverrides;
     /** Timeout in milliseconds before the export times out. Default: 30_000ms (0 to disable). */
     timeout?: number;
@@ -20,13 +32,14 @@ export interface ExportToCsvOptions<TName extends string = string> {
 export interface ExportCsvTemplateOptions {
     filename?: string;
     excludeColumns?: string[];
-    columns?: string[];
+    columns?: readonly (string | ColumnDescriptor)[];
     overrides?: SessionDataSourceOverrides;
     /** Timeout in milliseconds before template generation times out. Default: 10_000ms (0 to disable). */
     timeout?: number;
     onError?: (error: Error) => void;
     onSuccess?: () => void;
 }
+export declare const isExportableColumn: (descriptor?: ExportColumnDescriptor | ColumnDescriptor) => boolean;
 /** Downloads a single-row CSV containing only the column headers, for use as an import template. */
 export declare const exportCsvTemplate: (dataSource: DataSource, options?: ExportCsvTemplateOptions) => Promise<void>;
 /**
@@ -35,8 +48,8 @@ export declare const exportCsvTemplate: (dataSource: DataSource, options?: Expor
  * then triggers a browser download. The session data source is unsubscribed automatically once the download
  * is initiated.
  */
-export declare const exportSessionTableToCsv: <TName extends string = string>(dataSource: DataSource, options?: ExportToCsvOptions<TName>) => Promise<void>;
+export declare const exportSessionTableToCsv: (dataSource: DataSource, options?: ExportToCsvOptions) => Promise<void>;
 /**
  * Creates an export session table from `dataSource`, collects all rows in memory, then triggers a CSV download.
  */
-export declare const exportToCsv: <TName extends string = string>(dataSource: DataSource, options?: ExportToCsvOptions<TName>) => Promise<void>;
+export declare const exportToCsv: (dataSource: DataSource, options?: ExportToCsvOptions) => Promise<void>;

package/types/csv-export/index.d.ts

@@ -1,2 +1,2 @@
-export { exportCsvTemplate, exportSessionTableToCsv, exportToCsv, type ExportColumnDescriptor, type ExportCsvTemplateOptions, type ExportToCsvOptions, } from "./export-utils";
+export { exportCsvTemplate, exportSessionTableToCsv, exportToCsv, isExportableColumn, type ExportClientColumnDescriptor, type ExportColumnDescriptor, type ExportCsvTemplateOptions, type ExportServerColumnDescriptor, type ExportToCsvOptions, type RowAccessor, } from "./export-utils";
 export { useCsvExport, type UseCsvExportProps, type UseCsvExportResult, } from "./useCsvExport";

package/types/csv-export/useCsvExport.d.ts

@@ -1,14 +1,17 @@
 import type { DataSource } from "@vuu-ui/vuu-data-types";
-import { type ExportCsvTemplateOptions, type ExportToCsvOptions } from "./export-utils";
+import type { ColumnDescriptor, TableConfig } from "@vuu-ui/vuu-table-types";
+import { type ExportColumnDescriptor, type ExportCsvTemplateOptions, type ExportToCsvOptions } from "./export-utils";
 export interface UseCsvExportProps {
     dataSource?: DataSource;
+    tableConfig?: TableConfig;
+    columns?: readonly (string | ExportColumnDescriptor | ColumnDescriptor)[];
     onError?: (error: Error) => void;
     onSuccess?: () => void;
 }
 export interface UseCsvExportResult {
     isExporting: boolean;
     error: Error | null;
-    exportCsv: <TName extends string = string>(options?: ExportToCsvOptions<TName>, overrideDataSource?: DataSource) => Promise<void>;
+    exportCsv: (options?: ExportToCsvOptions, overrideDataSource?: DataSource) => Promise<void>;
     exportTemplate: (options?: ExportCsvTemplateOptions, overrideDataSource?: DataSource) => Promise<void>;
 }
 export declare function useCsvExport(propsOrDataSource?: DataSource | UseCsvExportProps): UseCsvExportResult;

package/types/inline-add-row/useInlineAddRow.d.ts

@@ -16,7 +16,8 @@ export declare const useInlineAddRow: ({ columns }: UseInlineAddRowProps) => {
         allowColumnHeaderMenu?: false;
         colHeaderContentRenderer?: string;
         colHeaderLabelRenderer?: string;
-        exportFormatter?: (value: unknown) => string;
+        exportable?: boolean;
+        exportFormatter?: (value: unknown, row: import("@vuu-ui/vuu-table-types").RowAccessor) => string;
         getIcon?: (row: DataRow) => string | undefined;
         groupable?: boolean;
         hidden?: boolean;

package/types/table-footer/TableFooter.d.ts

@@ -3,8 +3,8 @@ export interface TableFooterProps extends HTMLAttributes<HTMLDivElement> {
     onInvokeAction?: (action: string) => void;
     tooltrayActions?: ReactNode;
 }
-export declare const TableFooterTray: ({ children, position }: {
+export declare const TableFooterTray: ({ children, position, }: {
     children: ReactNode;
-    position?: 'center' | 'end';
+    position?: "center" | "end";
 }) => import("react").JSX.Element;
 export declare const TableFooter: ({ children, className, onInvokeAction, tooltrayActions, ...htmlAttributes }: TableFooterProps) => import("react").JSX.Element;