@ecodrix/erix-api 1.2.0 → 1.2.1

package/src/types/metadata.ts

@@ -0,0 +1,71 @@
+/**
+ * The specific UI control type suggested for a field.
+ */
+export type FieldType =
+  | "string"
+  | "number"
+  | "boolean"
+  | "date"
+  | "datetime"
+  | "select"
+  | "multi-select"
+  | "phone"
+  | "email"
+  | "currency"
+  | "json"
+  | "textarea"
+  | "richtext"
+  | "file"
+  | "image";
+
+/**
+ * Metadata defining a single field within a resource.
+ * Used by UI kits to automatically generate forms and validation logic.
+ */
+export interface FieldManifest {
+  /** The technical key name used in API requests. */
+  key: string;
+  /** Human-readable label (localized if possible). */
+  label: string;
+  /** Suggested UI type. */
+  type: FieldType;
+  /** Short hint/placeholder text. */
+  description?: string;
+  /** Whether the field is required for creation. */
+  required: boolean;
+  /** Whether the field should be hidden from standard create/edit forms. */
+  hidden?: boolean;
+  /** If type is 'select', the available options. */
+  options?: Array<{ label: string; value: string | number }>;
+  /** Validation constraints. */
+  validation?: {
+    regex?: string;
+    min?: number;
+    max?: number;
+    message?: string;
+  };
+  /** Whether the field is read-only. */
+  readOnly?: boolean;
+  /** UI grouping/category name. */
+  group?: string;
+}
+
+/**
+ * A logical grouping of fields and UI hints for a top-level resource.
+ * Provides a 'blueprint' for erix-react components.
+ */
+export interface ResourceManifest {
+  /** The unique name of the resource (e.g., 'Lead', 'Template'). */
+  name: string;
+  /** All available fields for this resource. */
+  fields: FieldManifest[];
+  /** Suggested UI configurations. */
+  uiHints?: {
+    icon?: string;
+    primaryColor?: string;
+    /** Default sort order. */
+    defaultSort?: { field: string; direction: "asc" | "desc" };
+    /** Fields to show in a compact table view. */
+    summaryFields?: string[];
+  };
+}