@vuu-ui/vuu-data-types 4.0.0-alpha.3 → 4.0.0-alpha.31

package/index.d.ts

@@ -1,4 +1,8 @@
-import type { Filter } from "@vuu-ui/vuu-filter-types";
+import type { ColumnDescriptorsByName, Filter } from "@vuu-ui/vuu-filter-types";
+
+export interface SetFilterOptions {
+  columnsByName?: ColumnDescriptorsByName;
+}
 import type {
   LinkDescriptorWithLabel,
   NoAction,
@@ -109,6 +113,7 @@ export declare type DataValueTypeSimple =
   | "boolean"
   | "json"
   | DateTimeDataValueTypeSimple
+  | DateDataValueTypeSimple
   | TimeDataValueTypeSimple
   | DecimalValueTypeSimple
   | "checkbox";
@@ -117,14 +122,40 @@ export declare type DataValueType =
   | DataValueTypeSimple
   | DataValueTypeDescriptor;
 
+/** Time of day only, date component (if any) is not displayed */
 export declare type TimeDataValueTypeSimple = "time";
+/** Date and time of day */
 export declare type DateTimeDataValueTypeSimple = "date/time";
+/** Calendar date only, time of day (if any) is not displayed */
+export declare type DateDataValueTypeSimple = "date";
+/**
+ * The DataValueTypeSimple values that identify a value as temporal. Can be used to
+ * refine a numeric serverDataType (legacy) or the 'kind' of an epochtimestamp or
+ * epochtimestampnano value.
+ */
+export declare type TemporalDataValueTypeSimple =
+  | DateTimeDataValueTypeSimple
+  | DateDataValueTypeSimple
+  | TimeDataValueTypeSimple;
 export declare type DecimalValueTypeSimple = "decimal" | "scaleddecimal";
 
 export declare type DateTimeDataValueType =
-  | DateTimeColumnTypeSimple
+  | DateTimeDataValueTypeSimple
+  | DateDataValueTypeSimple
+  | (Omit<DataValueTypeDescriptor, "name"> & {
+      name: DateTimeDataValueTypeSimple | DateDataValueTypeSimple;
+    });
+
+export declare type TimeDataValueType =
+  | TimeDataValueTypeSimple
   | (Omit<DataValueTypeDescriptor, "name"> & {
-      name: DateTimeColumnTypeSimple;
+      name: TimeDataValueTypeSimple;
+    });
+
+export declare type TemporalDataValueType =
+  | TemporalDataValueTypeSimple
+  | (Omit<DataValueTypeDescriptor, "name"> & {
+      name: TemporalDataValueTypeSimple;
     });
 
 export declare type BulkEdit = "bulk" | false | "read-only";
@@ -394,8 +425,9 @@ export declare type ConfigChangeMessage =
 export declare type ConfigChangeHandler = (msg: ConfigChangeMessage) => void;
 
 export declare type SchemaColumn = {
-  editable?: boolean;
+  editable?: DataEditable;
   name: string;
+  required?: boolean;
   serverDataType: VuuColumnDataType;
 };
 
@@ -478,6 +510,10 @@ export interface DataSourceConstructorProps
   viewport?: string;
 }
 
+/**
+ * The Vuu server a remote module connects to. Published by the remote in its
+ * `config.json`, not by the module registry.
+ */
 export interface RemoteModuleConnection {
   connectionId: string;
   restUrl?: string;
@@ -740,9 +776,15 @@ export interface DataSourceBase<
    * (or ExtendedFilter) object. The real advantage to using this is the additional set
    * of capabilities the ExtendedFilter offers.
    * Eventually, this will replace the existing filter setter
+   *
+   * Filter clauses on temporal columns are serialized according to the column
+   * type (see temporalFilterAsQuery), e.g a date '=' becomes a day range. Column
+   * types are taken from the tableSchema, where available. Pass columnsByName
+   * where columns are refined on the client (e.g a long column with type 'date/time'
+   * or 'time', or a column with a time zone).
    */
   clearFilter?: () => void;
-  setFilter?: (filter: Filter) => void;
+  setFilter?: (filter: Filter, options?: SetFilterOptions) => void;
 
   /**
    * Only implemented on JSON DataSource

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@vuu-ui/vuu-data-types",
-  "version": "4.0.0-alpha.3",
+  "version": "4.0.0-alpha.31",
   "author": "heswell",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@vuu-ui/vuu-filter-types": "4.0.0-alpha.3",
-    "@vuu-ui/vuu-protocol-types": "4.0.0-alpha.3"
+    "@vuu-ui/vuu-filter-types": "4.0.0-alpha.31",
+    "@vuu-ui/vuu-protocol-types": "4.0.0-alpha.31"
   },
   "dependencies": {},
   "peerDependencies": {},