@vuu-ui/vuu-utils 4.0.0-alpha.22 → 4.0.0-alpha.23

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.0.0-alpha.22",
+  "version": "4.0.0-alpha.23",
   "author": "heswell",
   "main": "./src/index.js",
   "license": "Apache-2.0",
@@ -16,14 +16,14 @@
   },
   "devDependencies": {
     "@dnd-kit/react": "^0.1.21",
-    "@vuu-ui/vuu-data-types": "4.0.0-alpha.22",
-    "@vuu-ui/vuu-table-types": "4.0.0-alpha.22",
-    "@vuu-ui/vuu-filter-types": "4.0.0-alpha.22",
-    "@vuu-ui/vuu-protocol-types": "4.0.0-alpha.22"
+    "@vuu-ui/vuu-data-types": "4.0.0-alpha.23",
+    "@vuu-ui/vuu-table-types": "4.0.0-alpha.23",
+    "@vuu-ui/vuu-filter-types": "4.0.0-alpha.23",
+    "@vuu-ui/vuu-protocol-types": "4.0.0-alpha.23"
   },
   "peerDependencies": {
     "@internationalized/date": "^3.0.0",
-    "@vuu-ui/vuu-filter-parser": "4.0.0-alpha.22",
+    "@vuu-ui/vuu-filter-parser": "4.0.0-alpha.23",
     "clsx": "^2.0.0",
     "react": "^19.2.3",
     "react-dom": "^19.2.3"

package/types/filters/scaled-decimal-filter.d.ts

@@ -0,0 +1,58 @@
+import type { ExtendedFilterOptions, ScaledDecimalFilterOptions, SingleValueFilterClause } from "@vuu-ui/vuu-filter-types";
+import type { DataValueDescriptor } from "@vuu-ui/vuu-data-types";
+export type ScaledDecimalScale = ScaledDecimalFilterOptions["scale"];
+export declare const getScaledDecimalScale: (serverDataType?: string) => ScaledDecimalScale | undefined;
+export declare const isValidDecimalString: (value: string) => boolean;
+export declare const isScaledDecimalFilterOptions: (options?: ExtendedFilterOptions) => options is ScaledDecimalFilterOptions;
+/**
+ * A decimal (not exponential) string representation of a filter value.
+ */
+export declare const toDecimalString: (value: unknown, scale: ScaledDecimalScale) => string;
+/**
+ * Convert a decimal string to its scaled integer representation. Digits beyond
+ * the scale are truncated, as the Vuu server does.
+ */
+export declare const toScaledInteger: (value: string, scale: ScaledDecimalScale) => bigint;
+/**
+ * Convert a scaled integer to a decimal string with 'scale' decimal places,
+ * the literal form in which scaled decimals are expressed in a filter query.
+ */
+export declare const fromScaledInteger: (value: bigint, scale: ScaledDecimalScale) => string;
+/**
+ * The filter options for a clause on a scaled decimal column, describing the
+ * precision with which the column displays values. These mirror the formatting
+ * rules of numericFormatter: a column with no type descriptor displays the full
+ * value, a type descriptor with no decimals displays 4 decimal places.
+ */
+export declare const getScaledDecimalFilterOptions: (column: Pick<DataValueDescriptor, "serverDataType" | "type">) => ScaledDecimalFilterOptions | undefined;
+/**
+ * The range of scaled integer values, inclusive at both ends, matched by a
+ * filter value. A value with no more decimal places than are displayed matches
+ * every value that displays as that value, e.g 1.23, displayed with 2 decimals,
+ * rounded, matches [1.225, 1.235). Display rounding applies to the magnitude,
+ * so -1.23 matches (-1.235, -1.225]. A value with more decimal places than are
+ * displayed is matched at its own precision, by the same rounding rule, e.g
+ * 1.234 matches [1.2335, 1.2345). A value with as many decimal places as the
+ * column holds, or any value where every decimal is displayed, is matched exactly.
+ */
+export declare const getScaledDecimalMatchRange: (value: string, { scale, decimals, roundingRule }: ScaledDecimalFilterOptions) => [bigint, bigint];
+/**
+ * Serialize a filter clause on a scaled decimal column. Where the value matches
+ * a range of values (see getScaledDecimalMatchRange), each operator applies to
+ * that range, e.g '>' matches values greater than every value in the range.
+ * Note: '!=' on a range is expressed as '< from or > to', which, unlike an
+ * exact '!=', does not match a null value.
+ */
+export declare const scaledDecimalFilterAsQuery: ({ column, op, value, }: Pick<SingleValueFilterClause, "column" | "op" | "value">, options: ScaledDecimalFilterOptions) => string;
+export interface ScaledDecimalCellFilter {
+    /** The value as displayed */
+    label: string;
+    op: "=";
+    value: string;
+}
+/**
+ * The filter for a cell value on a scaled decimal column, matching the value as
+ * displayed, e.g a cell displaying 1.23 (underlying value 1.234567) creates a
+ * filter matching every value that displays as 1.23.
+ */
+export declare const getScaledDecimalCellFilter: (column: Pick<DataValueDescriptor, "serverDataType" | "type">, value: unknown) => ScaledDecimalCellFilter | undefined;