Interface: SchemaField

Defined in: packages/sdk/src/types/generated/data.ts:157

Strongly-typed field definition for DataType schemas.

Properties

adminOnly?

optional adminOnly: boolean

Defined in: packages/sdk/src/types/generated/data.ts:177

Whether only admins can see this field

---

categories?

optional categories: SchemaFieldCategoriesItem[]

Defined in: packages/sdk/src/types/generated/data.ts:187

Regulatory or content categories for audit and policy

---

celFunction?

optional celFunction: string | null

Defined in: packages/sdk/src/types/generated/data.ts:181

CEL expression that computes this field's value. CONSTRAINT: Can ONLY reference regular fields (TEXT, NUMBER, DATE, etc.). Cannot reference other FUNCTION fields. Syntax: record.data.<field_slug>. Example: 'record.data.score1 + record.data.score2'

---

defaultValue?

optional defaultValue: unknown

Defined in: packages/sdk/src/types/generated/data.ts:179

Default value for the field

---

description?

optional description: string | null

Defined in: packages/sdk/src/types/generated/data.ts:163

Optional field description

---

fieldType?

optional fieldType: "number" | "boolean" | "object" | "function" | "email" | "phone" | "date" | "array" | "enum" | "text" | "longtext" | "integer" | "datetime" | "time_of_day" | "us_zip_code"

Defined in: packages/sdk/src/types/generated/data.ts:165

Field type (text, email, enum, etc.)

---

name

name: string

Defined in: packages/sdk/src/types/generated/data.ts:161

Display name for the field

---

options?

optional options: EnumOption[] | null

Defined in: packages/sdk/src/types/generated/data.ts:171

Options for enum fields as {label, value} objects.

---

order?

optional order: number | null

Defined in: packages/sdk/src/types/generated/data.ts:169

Deprecated: Display order is now determined by array position

---

referencedTypeId?

optional referencedTypeId: number | null

Defined in: packages/sdk/src/types/generated/data.ts:173

Referenced DataType ID for reference fields

---

required?

optional required: boolean

Defined in: packages/sdk/src/types/generated/data.ts:167

Whether field is required

---

sensitivity?

optional sensitivity: SchemaFieldSensitivity

Defined in: packages/sdk/src/types/generated/data.ts:185

Disclosure severity for audit and access policy

---

shouldIndex?

optional shouldIndex: boolean

Defined in: packages/sdk/src/types/generated/data.ts:175

Whether to index this field

---

slug

slug: string

Defined in: packages/sdk/src/types/generated/data.ts:159

Unique field identifier

---

validateCel?

optional validateCel: string | null

Defined in: packages/sdk/src/types/generated/data.ts:183

CEL expression for cross-field validation. Context: 'value' (current field value), 'record.data.<field_slug>' (other fields). Returns: true if valid, or a string error message if invalid. CONSTRAINT: Can only reference non-FUNCTION fields. Example: 'value >= record.data.min_score' or 'value < record.data.min_score ? "Must be >= " + string(record.data.min_score) : true'