@fieldia/core 0.6.0 → 0.7.0

package/src/lib/format/field.d.mts

@@ -1,16 +1,5 @@
 import * as z from 'zod';
-/**
- * Field definitions: what a page knows about each value it shows or collects.
- *
- * A page declares its fields once, by name, and its layout points at them —
- * the same split a backend's own field metadata uses, so an app can generate
- * these definitions from it. Names follow Fieldia's naming rule: a backend's
- * vocabulary stays unless it is a product name, jargon, or a clash.
- */
-/** A field name: what expressions and layout nodes use to refer to a field. */
-export declare const FIELD_NAME: RegExp;
-export declare const FIELD_TYPES: readonly ["char", "text", "html", "integer", "float", "monetary", "boolean", "date", "datetime", "selection", "binary", "image", "many2one", "many2many", "one2many", "reference", "properties", "json"];
-export type FieldType = (typeof FIELD_TYPES)[number];
+export { FIELD_NAME, FIELD_TYPES, type FieldType } from './names.mjs';
 /** One choice in a selection or reference. */
 export declare const OptionSchema: z.ZodObject<{
     value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
@@ -18,13 +7,16 @@ export declare const OptionSchema: z.ZodObject<{
 }, z.core.$strict>;
 export type Option = z.infer<typeof OptionSchema>;
 /**
- * One condition limiting which records a relation may point to. Conditions in
- * a filter all apply together. `valueFrom` compares against another field of
- * the record being edited, so a region list can follow the chosen country.
+ * One condition limiting which records a relation may point to. `valueFrom`
+ * compares against another field of the record being edited, so a region list
+ * can follow the chosen country. `like` finds text inside; `ilike`,
+ * `startswith` and `endswith` whatever the case; `set` and `notset` take no
+ * value; `between` takes `[low, high]`, both ends included.
  */
 export declare const FilterConditionSchema: z.ZodObject<{
     field: z.ZodString;
     op: z.ZodEnum<{
+        set: "set";
         "=": "=";
         "!=": "!=";
         "<": "<";
@@ -35,11 +27,57 @@ export declare const FilterConditionSchema: z.ZodObject<{
         "not in": "not in";
         like: "like";
         ilike: "ilike";
+        startswith: "startswith";
+        endswith: "endswith";
+        notset: "notset";
+        between: "between";
     }>;
     value: z.ZodOptional<z.ZodJSONSchema>;
     valueFrom: z.ZodOptional<z.ZodString>;
 }, z.core.$strict>;
 export type FilterCondition = z.infer<typeof FilterConditionSchema>;
+/**
+ * What a filter holds: conditions, and groups of them. The items of a filter
+ * all apply together; an `any` group holds when one of its items does, an
+ * `all` group when each does, and groups nest.
+ */
+export type FilterItem = FilterCondition | {
+    any: FilterItem[];
+} | {
+    all: FilterItem[];
+};
+export declare const FilterAnySchema: z.ZodObject<{
+    any: z.ZodArray<typeof FilterItemSchema>;
+}, z.core.$strict>;
+export declare const FilterAllSchema: z.ZodObject<{
+    all: z.ZodArray<typeof FilterItemSchema>;
+}, z.core.$strict>;
+export declare const FilterItemSchema: z.ZodUnion<readonly [z.ZodObject<{
+    field: z.ZodString;
+    op: z.ZodEnum<{
+        set: "set";
+        "=": "=";
+        "!=": "!=";
+        "<": "<";
+        ">": ">";
+        "<=": "<=";
+        ">=": ">=";
+        in: "in";
+        "not in": "not in";
+        like: "like";
+        ilike: "ilike";
+        startswith: "startswith";
+        endswith: "endswith";
+        notset: "notset";
+        between: "between";
+    }>;
+    value: z.ZodOptional<z.ZodJSONSchema>;
+    valueFrom: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    any: z.ZodArray<typeof FilterItemSchema>;
+}, z.core.$strict>, z.ZodObject<{
+    all: z.ZodArray<typeof FilterItemSchema>;
+}, z.core.$strict>]>;
 /** One property of a properties field: its own small field, edited with the widget for its type. */
 export declare const PropertyDefinitionSchema: z.ZodObject<{
     name: z.ZodString;
@@ -167,9 +205,10 @@ export declare const LineFieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     type: z.ZodLiteral<"image">;
 }, z.core.$strict>, z.ZodObject<{
     relation: z.ZodString;
-    filter: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    filter: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
         field: z.ZodString;
         op: z.ZodEnum<{
+            set: "set";
             "=": "=";
             "!=": "!=";
             "<": "<";
@@ -180,10 +219,18 @@ export declare const LineFieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
             "not in": "not in";
             like: "like";
             ilike: "ilike";
+            startswith: "startswith";
+            endswith: "endswith";
+            notset: "notset";
+            between: "between";
         }>;
         value: z.ZodOptional<z.ZodJSONSchema>;
         valueFrom: z.ZodOptional<z.ZodString>;
-    }, z.core.$strict>>>;
+    }, z.core.$strict>, z.ZodObject<{
+        any: z.ZodArray<typeof FilterItemSchema>;
+    }, z.core.$strict>, z.ZodObject<{
+        all: z.ZodArray<typeof FilterItemSchema>;
+    }, z.core.$strict>]>>>;
     label: z.ZodString;
     help: z.ZodOptional<z.ZodString>;
     required: z.ZodOptional<z.ZodBoolean>;
@@ -192,9 +239,10 @@ export declare const LineFieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     type: z.ZodLiteral<"many2one">;
 }, z.core.$strict>, z.ZodObject<{
     relation: z.ZodString;
-    filter: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    filter: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
         field: z.ZodString;
         op: z.ZodEnum<{
+            set: "set";
             "=": "=";
             "!=": "!=";
             "<": "<";
@@ -205,10 +253,18 @@ export declare const LineFieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
             "not in": "not in";
             like: "like";
             ilike: "ilike";
+            startswith: "startswith";
+            endswith: "endswith";
+            notset: "notset";
+            between: "between";
         }>;
         value: z.ZodOptional<z.ZodJSONSchema>;
         valueFrom: z.ZodOptional<z.ZodString>;
-    }, z.core.$strict>>>;
+    }, z.core.$strict>, z.ZodObject<{
+        any: z.ZodArray<typeof FilterItemSchema>;
+    }, z.core.$strict>, z.ZodObject<{
+        all: z.ZodArray<typeof FilterItemSchema>;
+    }, z.core.$strict>]>>>;
     label: z.ZodString;
     help: z.ZodOptional<z.ZodString>;
     required: z.ZodOptional<z.ZodBoolean>;
@@ -378,9 +434,10 @@ export declare const FieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     type: z.ZodLiteral<"image">;
 }, z.core.$strict>, z.ZodObject<{
     relation: z.ZodString;
-    filter: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    filter: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
         field: z.ZodString;
         op: z.ZodEnum<{
+            set: "set";
             "=": "=";
             "!=": "!=";
             "<": "<";
@@ -391,10 +448,18 @@ export declare const FieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
             "not in": "not in";
             like: "like";
             ilike: "ilike";
+            startswith: "startswith";
+            endswith: "endswith";
+            notset: "notset";
+            between: "between";
         }>;
         value: z.ZodOptional<z.ZodJSONSchema>;
         valueFrom: z.ZodOptional<z.ZodString>;
-    }, z.core.$strict>>>;
+    }, z.core.$strict>, z.ZodObject<{
+        any: z.ZodArray<typeof FilterItemSchema>;
+    }, z.core.$strict>, z.ZodObject<{
+        all: z.ZodArray<typeof FilterItemSchema>;
+    }, z.core.$strict>]>>>;
     label: z.ZodString;
     help: z.ZodOptional<z.ZodString>;
     required: z.ZodOptional<z.ZodBoolean>;
@@ -403,9 +468,10 @@ export declare const FieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     type: z.ZodLiteral<"many2one">;
 }, z.core.$strict>, z.ZodObject<{
     relation: z.ZodString;
-    filter: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    filter: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
         field: z.ZodString;
         op: z.ZodEnum<{
+            set: "set";
             "=": "=";
             "!=": "!=";
             "<": "<";
@@ -416,10 +482,18 @@ export declare const FieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
             "not in": "not in";
             like: "like";
             ilike: "ilike";
+            startswith: "startswith";
+            endswith: "endswith";
+            notset: "notset";
+            between: "between";
         }>;
         value: z.ZodOptional<z.ZodJSONSchema>;
         valueFrom: z.ZodOptional<z.ZodString>;
-    }, z.core.$strict>>>;
+    }, z.core.$strict>, z.ZodObject<{
+        any: z.ZodArray<typeof FilterItemSchema>;
+    }, z.core.$strict>, z.ZodObject<{
+        all: z.ZodArray<typeof FilterItemSchema>;
+    }, z.core.$strict>]>>>;
     label: z.ZodString;
     help: z.ZodOptional<z.ZodString>;
     required: z.ZodOptional<z.ZodBoolean>;
@@ -535,9 +609,10 @@ export declare const FieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
         type: z.ZodLiteral<"image">;
     }, z.core.$strict>, z.ZodObject<{
         relation: z.ZodString;
-        filter: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        filter: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
             field: z.ZodString;
             op: z.ZodEnum<{
+                set: "set";
                 "=": "=";
                 "!=": "!=";
                 "<": "<";
@@ -548,10 +623,18 @@ export declare const FieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
                 "not in": "not in";
                 like: "like";
                 ilike: "ilike";
+                startswith: "startswith";
+                endswith: "endswith";
+                notset: "notset";
+                between: "between";
             }>;
             value: z.ZodOptional<z.ZodJSONSchema>;
             valueFrom: z.ZodOptional<z.ZodString>;
-        }, z.core.$strict>>>;
+        }, z.core.$strict>, z.ZodObject<{
+            any: z.ZodArray<typeof FilterItemSchema>;
+        }, z.core.$strict>, z.ZodObject<{
+            all: z.ZodArray<typeof FilterItemSchema>;
+        }, z.core.$strict>]>>>;
         label: z.ZodString;
         help: z.ZodOptional<z.ZodString>;
         required: z.ZodOptional<z.ZodBoolean>;
@@ -560,9 +643,10 @@ export declare const FieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
         type: z.ZodLiteral<"many2one">;
     }, z.core.$strict>, z.ZodObject<{
         relation: z.ZodString;
-        filter: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        filter: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
             field: z.ZodString;
             op: z.ZodEnum<{
+                set: "set";
                 "=": "=";
                 "!=": "!=";
                 "<": "<";
@@ -573,10 +657,18 @@ export declare const FieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
                 "not in": "not in";
                 like: "like";
                 ilike: "ilike";
+                startswith: "startswith";
+                endswith: "endswith";
+                notset: "notset";
+                between: "between";
             }>;
             value: z.ZodOptional<z.ZodJSONSchema>;
             valueFrom: z.ZodOptional<z.ZodString>;
-        }, z.core.$strict>>>;
+        }, z.core.$strict>, z.ZodObject<{
+            any: z.ZodArray<typeof FilterItemSchema>;
+        }, z.core.$strict>, z.ZodObject<{
+            all: z.ZodArray<typeof FilterItemSchema>;
+        }, z.core.$strict>]>>>;
         label: z.ZodString;
         help: z.ZodOptional<z.ZodString>;
         required: z.ZodOptional<z.ZodBoolean>;
@@ -790,9 +882,10 @@ export declare const FieldsSchema: z.ZodRecord<z.ZodString, z.ZodDiscriminatedUn
     type: z.ZodLiteral<"image">;
 }, z.core.$strict>, z.ZodObject<{
     relation: z.ZodString;
-    filter: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    filter: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
         field: z.ZodString;
         op: z.ZodEnum<{
+            set: "set";
             "=": "=";
             "!=": "!=";
             "<": "<";
@@ -803,10 +896,18 @@ export declare const FieldsSchema: z.ZodRecord<z.ZodString, z.ZodDiscriminatedUn
             "not in": "not in";
             like: "like";
             ilike: "ilike";
+            startswith: "startswith";
+            endswith: "endswith";
+            notset: "notset";
+            between: "between";
         }>;
         value: z.ZodOptional<z.ZodJSONSchema>;
         valueFrom: z.ZodOptional<z.ZodString>;
-    }, z.core.$strict>>>;
+    }, z.core.$strict>, z.ZodObject<{
+        any: z.ZodArray<typeof FilterItemSchema>;
+    }, z.core.$strict>, z.ZodObject<{
+        all: z.ZodArray<typeof FilterItemSchema>;
+    }, z.core.$strict>]>>>;
     label: z.ZodString;
     help: z.ZodOptional<z.ZodString>;
     required: z.ZodOptional<z.ZodBoolean>;
@@ -815,9 +916,10 @@ export declare const FieldsSchema: z.ZodRecord<z.ZodString, z.ZodDiscriminatedUn
     type: z.ZodLiteral<"many2one">;
 }, z.core.$strict>, z.ZodObject<{
     relation: z.ZodString;
-    filter: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    filter: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
         field: z.ZodString;
         op: z.ZodEnum<{
+            set: "set";
             "=": "=";
             "!=": "!=";
             "<": "<";
@@ -828,10 +930,18 @@ export declare const FieldsSchema: z.ZodRecord<z.ZodString, z.ZodDiscriminatedUn
             "not in": "not in";
             like: "like";
             ilike: "ilike";
+            startswith: "startswith";
+            endswith: "endswith";
+            notset: "notset";
+            between: "between";
         }>;
         value: z.ZodOptional<z.ZodJSONSchema>;
         valueFrom: z.ZodOptional<z.ZodString>;
-    }, z.core.$strict>>>;
+    }, z.core.$strict>, z.ZodObject<{
+        any: z.ZodArray<typeof FilterItemSchema>;
+    }, z.core.$strict>, z.ZodObject<{
+        all: z.ZodArray<typeof FilterItemSchema>;
+    }, z.core.$strict>]>>>;
     label: z.ZodString;
     help: z.ZodOptional<z.ZodString>;
     required: z.ZodOptional<z.ZodBoolean>;
@@ -947,9 +1057,10 @@ export declare const FieldsSchema: z.ZodRecord<z.ZodString, z.ZodDiscriminatedUn
         type: z.ZodLiteral<"image">;
     }, z.core.$strict>, z.ZodObject<{
         relation: z.ZodString;
-        filter: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        filter: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
             field: z.ZodString;
             op: z.ZodEnum<{
+                set: "set";
                 "=": "=";
                 "!=": "!=";
                 "<": "<";
@@ -960,10 +1071,18 @@ export declare const FieldsSchema: z.ZodRecord<z.ZodString, z.ZodDiscriminatedUn
                 "not in": "not in";
                 like: "like";
                 ilike: "ilike";
+                startswith: "startswith";
+                endswith: "endswith";
+                notset: "notset";
+                between: "between";
             }>;
             value: z.ZodOptional<z.ZodJSONSchema>;
             valueFrom: z.ZodOptional<z.ZodString>;
-        }, z.core.$strict>>>;
+        }, z.core.$strict>, z.ZodObject<{
+            any: z.ZodArray<typeof FilterItemSchema>;
+        }, z.core.$strict>, z.ZodObject<{
+            all: z.ZodArray<typeof FilterItemSchema>;
+        }, z.core.$strict>]>>>;
         label: z.ZodString;
         help: z.ZodOptional<z.ZodString>;
         required: z.ZodOptional<z.ZodBoolean>;
@@ -972,9 +1091,10 @@ export declare const FieldsSchema: z.ZodRecord<z.ZodString, z.ZodDiscriminatedUn
         type: z.ZodLiteral<"many2one">;
     }, z.core.$strict>, z.ZodObject<{
         relation: z.ZodString;
-        filter: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        filter: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
             field: z.ZodString;
             op: z.ZodEnum<{
+                set: "set";
                 "=": "=";
                 "!=": "!=";
                 "<": "<";
@@ -985,10 +1105,18 @@ export declare const FieldsSchema: z.ZodRecord<z.ZodString, z.ZodDiscriminatedUn
                 "not in": "not in";
                 like: "like";
                 ilike: "ilike";
+                startswith: "startswith";
+                endswith: "endswith";
+                notset: "notset";
+                between: "between";
             }>;
             value: z.ZodOptional<z.ZodJSONSchema>;
             valueFrom: z.ZodOptional<z.ZodString>;
-        }, z.core.$strict>>>;
+        }, z.core.$strict>, z.ZodObject<{
+            any: z.ZodArray<typeof FilterItemSchema>;
+        }, z.core.$strict>, z.ZodObject<{
+            all: z.ZodArray<typeof FilterItemSchema>;
+        }, z.core.$strict>]>>>;
         label: z.ZodString;
         help: z.ZodOptional<z.ZodString>;
         required: z.ZodOptional<z.ZodBoolean>;