Skip to content

Type Alias: UIActionDto

@kortexya/reasoninglayer


@kortexya/reasoninglayer / UIActionDto

UIActionDto = { fieldTypes: Record<string, string>; osfqlTemplate: string; riskTier: RiskTier; sortName: string; statementId?: string | null; type: "submit_form"; } | { osfqlQuery: string; riskTier: RiskTier; statementId?: string | null; type: "load_data"; } | { fieldTypes: Record<string, string>; osfqlTemplate: string; riskTier: RiskTier; sortName: string; statementId?: string | null; type: "update_form"; } | { osfqlTemplate?: string | null; riskTier: RiskTier; sortName: string; statementId?: string | null; type: "delete_record"; } | { osfqlDerive: string; riskTier: RiskTier; statementId?: string | null; type: "trigger_inference"; } | { riskTier: RiskTier; sortId: string; statementId?: string | null; termId?: string | null; type: "navigate"; viewMode: string; } | { riskTier: RiskTier; statementId?: string | null; type: "refresh"; } | { fieldTypes: Record<string, string>; osfqlTemplate: string; riskTier: RiskTier; statementId: string; title: string; type: "run_osfql"; }

Defined in: src/types/ui.ts:98

UI action discriminated union.

{ fieldTypes: Record<string, string>; osfqlTemplate: string; riskTier: RiskTier; sortName: string; statementId?: string | null; type: "submit_form"; }

fieldTypes: Record<string, string>

Feature name → value type. A "sort_ref" field takes a term UUID in values, stored as a Reference; see UIActionRequest.fieldTypes.

osfqlTemplate: string

riskTier: RiskTier

sortName: string

optional statementId?: string | null

type: "submit_form"


{ osfqlQuery: string; riskTier: RiskTier; statementId?: string | null; type: "load_data"; }


{ fieldTypes: Record<string, string>; osfqlTemplate: string; riskTier: RiskTier; sortName: string; statementId?: string | null; type: "update_form"; }

fieldTypes: Record<string, string>

Feature name → value type. A "sort_ref" field takes a term UUID in values, stored as a Reference; see UIActionRequest.fieldTypes.

osfqlTemplate: string

riskTier: RiskTier

sortName: string

optional statementId?: string | null

type: "update_form"


{ osfqlTemplate?: string | null; riskTier: RiskTier; sortName: string; statementId?: string | null; type: "delete_record"; }

optional osfqlTemplate?: string | null

OSFQL template with {field} placeholders — present for feature-based deletes.

riskTier: RiskTier

sortName: string

optional statementId?: string | null

type: "delete_record"


{ osfqlDerive: string; riskTier: RiskTier; statementId?: string | null; type: "trigger_inference"; }


{ riskTier: RiskTier; sortId: string; statementId?: string | null; termId?: string | null; type: "navigate"; viewMode: string; }


{ riskTier: RiskTier; statementId?: string | null; type: "refresh"; }


{ fieldTypes: Record<string, string>; osfqlTemplate: string; riskTier: RiskTier; statementId: string; title: string; type: "run_osfql"; }

fieldTypes: Record<string, string>

Feature name → value type. A "sort_ref" field takes a term UUID in values, stored as a Reference; see UIActionRequest.fieldTypes.

osfqlTemplate: string

riskTier: RiskTier

statementId: string

Catalog statement id whose OSFQL template this action runs.

title: string

Human-readable label for the catalog statement.

type: "run_osfql"

Every variant carries a RiskTier (riskTier) and an optional catalog statementId — the server derives both from the action kind and echoes them on the descriptor. run_osfql is the catalog-authored variant: its statementId is required because it names the catalog statement whose OSFQL template the action runs.