@memberjunction/core-entities 2.75.0 → 2.76.0

package/dist/generated/entity_subclasses.d.ts

@@ -4865,6 +4865,130 @@ export declare const AIAgentRunSchema: z.ZodObject<{
     TotalPromptIterations?: number;
 }>;
 export type AIAgentRunEntityType = z.infer<typeof AIAgentRunSchema>;
+/**
+ * zod schema definition for the entity MJ: AI Agent Step Paths
+ */
+export declare const AIAgentStepPathSchema: z.ZodObject<{
+    ID: z.ZodString;
+    OriginStepID: z.ZodString;
+    DestinationStepID: z.ZodString;
+    Condition: z.ZodNullable<z.ZodString>;
+    Priority: z.ZodNumber;
+    Description: z.ZodNullable<z.ZodString>;
+    PathPoints: z.ZodNullable<z.ZodString>;
+    __mj_CreatedAt: z.ZodDate;
+    __mj_UpdatedAt: z.ZodDate;
+    OriginStep: z.ZodString;
+    DestinationStep: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    ID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    Description?: string;
+    Priority?: number;
+    OriginStepID?: string;
+    DestinationStepID?: string;
+    Condition?: string;
+    PathPoints?: string;
+    OriginStep?: string;
+    DestinationStep?: string;
+}, {
+    ID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    Description?: string;
+    Priority?: number;
+    OriginStepID?: string;
+    DestinationStepID?: string;
+    Condition?: string;
+    PathPoints?: string;
+    OriginStep?: string;
+    DestinationStep?: string;
+}>;
+export type AIAgentStepPathEntityType = z.infer<typeof AIAgentStepPathSchema>;
+/**
+ * zod schema definition for the entity MJ: AI Agent Steps
+ */
+export declare const AIAgentStepSchema: z.ZodObject<{
+    ID: z.ZodString;
+    AgentID: z.ZodString;
+    Name: z.ZodString;
+    Description: z.ZodNullable<z.ZodString>;
+    StepType: z.ZodUnion<[z.ZodLiteral<"Action">, z.ZodLiteral<"Sub-Agent">, z.ZodLiteral<"Prompt">]>;
+    StartingStep: z.ZodBoolean;
+    TimeoutSeconds: z.ZodNullable<z.ZodNumber>;
+    RetryCount: z.ZodNumber;
+    OnErrorBehavior: z.ZodUnion<[z.ZodLiteral<"fail">, z.ZodLiteral<"continue">, z.ZodLiteral<"retry">]>;
+    ActionID: z.ZodNullable<z.ZodString>;
+    SubAgentID: z.ZodNullable<z.ZodString>;
+    PromptID: z.ZodNullable<z.ZodString>;
+    ActionOutputMapping: z.ZodNullable<z.ZodString>;
+    PositionX: z.ZodNumber;
+    PositionY: z.ZodNumber;
+    Width: z.ZodNumber;
+    Height: z.ZodNumber;
+    __mj_CreatedAt: z.ZodDate;
+    __mj_UpdatedAt: z.ZodDate;
+    Status: z.ZodUnion<[z.ZodLiteral<"Active">, z.ZodLiteral<"Pending">, z.ZodLiteral<"Disabled">]>;
+    ActionInputMapping: z.ZodNullable<z.ZodString>;
+    Agent: z.ZodNullable<z.ZodString>;
+    Action: z.ZodNullable<z.ZodString>;
+    SubAgent: z.ZodNullable<z.ZodString>;
+    Prompt: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    ID?: string;
+    ActionID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    Action?: string;
+    Name?: string;
+    Description?: string;
+    Status?: "Disabled" | "Active" | "Pending";
+    AgentID?: string;
+    Agent?: string;
+    Prompt?: string;
+    PromptID?: string;
+    StepType?: "Action" | "Prompt" | "Sub-Agent";
+    StartingStep?: boolean;
+    TimeoutSeconds?: number;
+    RetryCount?: number;
+    OnErrorBehavior?: "fail" | "continue" | "retry";
+    SubAgentID?: string;
+    ActionOutputMapping?: string;
+    PositionX?: number;
+    PositionY?: number;
+    Width?: number;
+    Height?: number;
+    ActionInputMapping?: string;
+    SubAgent?: string;
+}, {
+    ID?: string;
+    ActionID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    Action?: string;
+    Name?: string;
+    Description?: string;
+    Status?: "Disabled" | "Active" | "Pending";
+    AgentID?: string;
+    Agent?: string;
+    Prompt?: string;
+    PromptID?: string;
+    StepType?: "Action" | "Prompt" | "Sub-Agent";
+    StartingStep?: boolean;
+    TimeoutSeconds?: number;
+    RetryCount?: number;
+    OnErrorBehavior?: "fail" | "continue" | "retry";
+    SubAgentID?: string;
+    ActionOutputMapping?: string;
+    PositionX?: number;
+    PositionY?: number;
+    Width?: number;
+    Height?: number;
+    ActionInputMapping?: string;
+    SubAgent?: string;
+}>;
+export type AIAgentStepEntityType = z.infer<typeof AIAgentStepSchema>;
 /**
  * zod schema definition for the entity MJ: AI Agent Types
  */
@@ -4878,6 +5002,9 @@ export declare const AIAgentTypeSchema: z.ZodObject<{
     __mj_UpdatedAt: z.ZodDate;
     AgentPromptPlaceholder: z.ZodNullable<z.ZodString>;
     DriverClass: z.ZodNullable<z.ZodString>;
+    UIFormSectionKey: z.ZodNullable<z.ZodString>;
+    UIFormKey: z.ZodNullable<z.ZodString>;
+    UIFormSectionExpandedByDefault: z.ZodBoolean;
     SystemPrompt: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     ID?: string;
@@ -4889,6 +5016,9 @@ export declare const AIAgentTypeSchema: z.ZodObject<{
     IsActive?: boolean;
     SystemPromptID?: string;
     AgentPromptPlaceholder?: string;
+    UIFormSectionKey?: string;
+    UIFormKey?: string;
+    UIFormSectionExpandedByDefault?: boolean;
     SystemPrompt?: string;
 }, {
     ID?: string;
@@ -4900,6 +5030,9 @@ export declare const AIAgentTypeSchema: z.ZodObject<{
     IsActive?: boolean;
     SystemPromptID?: string;
     AgentPromptPlaceholder?: string;
+    UIFormSectionKey?: string;
+    UIFormKey?: string;
+    UIFormSectionExpandedByDefault?: boolean;
     SystemPrompt?: string;
 }>;
 export type AIAgentTypeEntityType = z.infer<typeof AIAgentTypeSchema>;
@@ -21711,6 +21844,380 @@ each time the agent processes a prompt step.
     */
     get User(): string | null;
 }
+/**
+ * MJ: AI Agent Step Paths - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: AIAgentStepPath
+ * * Base View: vwAIAgentStepPaths
+ * * @description Defines paths (edges) between steps in a flow-based AI agent execution graph
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class AIAgentStepPathEntity extends BaseEntity<AIAgentStepPathEntityType> {
+    /**
+    * Loads the MJ: AI Agent Step Paths record from the database
+    * @param ID: string - primary key value to load the MJ: AI Agent Step Paths record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof AIAgentStepPathEntity
+    * @method
+    * @override
+    */
+    Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Validate() method override for MJ: AI Agent Step Paths entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
+    * * Table-Level: This rule ensures that the origin step and destination step must be different. In other words, a step cannot connect to itself.
+    * @public
+    * @method
+    * @override
+    */
+    Validate(): ValidationResult;
+    /**
+    * This rule ensures that the origin step and destination step must be different. In other words, a step cannot connect to itself.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateOriginStepIDIsNotEqualToDestinationStepID(result: ValidationResult): void;
+    /**
+    * * Field Name: ID
+    * * Display Name: ID
+    * * SQL Data Type: uniqueidentifier
+    * * Default Value: newsequentialid()
+    */
+    get ID(): string;
+    set ID(value: string);
+    /**
+    * * Field Name: OriginStepID
+    * * Display Name: Origin Step ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: MJ: AI Agent Steps (vwAIAgentSteps.ID)
+    */
+    get OriginStepID(): string;
+    set OriginStepID(value: string);
+    /**
+    * * Field Name: DestinationStepID
+    * * Display Name: Destination Step ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: MJ: AI Agent Steps (vwAIAgentSteps.ID)
+    */
+    get DestinationStepID(): string;
+    set DestinationStepID(value: string);
+    /**
+    * * Field Name: Condition
+    * * Display Name: Condition
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: Boolean expression to evaluate. If null, path is always taken. Evaluated against payload and step results.
+    */
+    get Condition(): string | null;
+    set Condition(value: string | null);
+    /**
+    * * Field Name: Priority
+    * * Display Name: Priority
+    * * SQL Data Type: int
+    * * Default Value: 0
+    * * Description: Path evaluation priority. Higher values are evaluated first. Use 0 or negative values for default/fallback paths that execute when no other conditions match.
+    */
+    get Priority(): number;
+    set Priority(value: number);
+    /**
+    * * Field Name: Description
+    * * Display Name: Description
+    * * SQL Data Type: nvarchar(255)
+    */
+    get Description(): string | null;
+    set Description(value: string | null);
+    /**
+    * * Field Name: PathPoints
+    * * Display Name: Path Points
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get PathPoints(): string | null;
+    set PathPoints(value: string | null);
+    /**
+    * * Field Name: __mj_CreatedAt
+    * * Display Name: Created At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_CreatedAt(): Date;
+    /**
+    * * Field Name: __mj_UpdatedAt
+    * * Display Name: Updated At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_UpdatedAt(): Date;
+    /**
+    * * Field Name: OriginStep
+    * * Display Name: Origin Step
+    * * SQL Data Type: nvarchar(255)
+    */
+    get OriginStep(): string;
+    /**
+    * * Field Name: DestinationStep
+    * * Display Name: Destination Step
+    * * SQL Data Type: nvarchar(255)
+    */
+    get DestinationStep(): string;
+}
+/**
+ * MJ: AI Agent Steps - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: AIAgentStep
+ * * Base View: vwAIAgentSteps
+ * * @description Defines individual steps (nodes) in a flow-based AI agent execution graph
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class AIAgentStepEntity extends BaseEntity<AIAgentStepEntityType> {
+    /**
+    * Loads the MJ: AI Agent Steps record from the database
+    * @param ID: string - primary key value to load the MJ: AI Agent Steps record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof AIAgentStepEntity
+    * @method
+    * @override
+    */
+    Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Validate() method override for MJ: AI Agent Steps entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
+    * * RetryCount: This rule ensures that the RetryCount value cannot be negative. It must be zero or higher.
+    * * TimeoutSeconds: This rule makes sure that the value for TimeoutSeconds must be greater than zero. Negative values or zero are not allowed.
+    * @public
+    * @method
+    * @override
+    */
+    Validate(): ValidationResult;
+    /**
+    * This rule ensures that the RetryCount value cannot be negative. It must be zero or higher.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateRetryCountIsNonNegative(result: ValidationResult): void;
+    /**
+    * This rule makes sure that the value for TimeoutSeconds must be greater than zero. Negative values or zero are not allowed.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateTimeoutSecondsGreaterThanZero(result: ValidationResult): void;
+    /**
+    * * Field Name: ID
+    * * Display Name: ID
+    * * SQL Data Type: uniqueidentifier
+    * * Default Value: newsequentialid()
+    */
+    get ID(): string;
+    set ID(value: string);
+    /**
+    * * Field Name: AgentID
+    * * Display Name: Agent ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: AI Agents (vwAIAgents.ID)
+    */
+    get AgentID(): string;
+    set AgentID(value: string);
+    /**
+    * * Field Name: Name
+    * * Display Name: Name
+    * * SQL Data Type: nvarchar(255)
+    */
+    get Name(): string;
+    set Name(value: string);
+    /**
+    * * Field Name: Description
+    * * Display Name: Description
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get Description(): string | null;
+    set Description(value: string | null);
+    /**
+    * * Field Name: StepType
+    * * Display Name: Step Type
+    * * SQL Data Type: nvarchar(20)
+    * * Value List Type: List
+    * * Possible Values
+    *   * Action
+    *   * Sub-Agent
+    *   * Prompt
+    * * Description: Type of step: Action (execute an action), Sub-Agent (delegate to another agent), or Prompt (run an AI prompt)
+    */
+    get StepType(): 'Action' | 'Sub-Agent' | 'Prompt';
+    set StepType(value: 'Action' | 'Sub-Agent' | 'Prompt');
+    /**
+    * * Field Name: StartingStep
+    * * Display Name: Starting Step
+    * * SQL Data Type: bit
+    * * Default Value: 0
+    * * Description: If true, this step is executed when the agent starts
+    */
+    get StartingStep(): boolean;
+    set StartingStep(value: boolean);
+    /**
+    * * Field Name: TimeoutSeconds
+    * * Display Name: Timeout Seconds
+    * * SQL Data Type: int
+    * * Default Value: 600
+    */
+    get TimeoutSeconds(): number | null;
+    set TimeoutSeconds(value: number | null);
+    /**
+    * * Field Name: RetryCount
+    * * Display Name: Retry Count
+    * * SQL Data Type: int
+    * * Default Value: 0
+    */
+    get RetryCount(): number;
+    set RetryCount(value: number);
+    /**
+    * * Field Name: OnErrorBehavior
+    * * Display Name: On Error Behavior
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: fail
+    * * Value List Type: List
+    * * Possible Values
+    *   * fail
+    *   * continue
+    *   * retry
+    */
+    get OnErrorBehavior(): 'fail' | 'continue' | 'retry';
+    set OnErrorBehavior(value: 'fail' | 'continue' | 'retry');
+    /**
+    * * Field Name: ActionID
+    * * Display Name: Action ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Actions (vwActions.ID)
+    */
+    get ActionID(): string | null;
+    set ActionID(value: string | null);
+    /**
+    * * Field Name: SubAgentID
+    * * Display Name: Sub Agent ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: AI Agents (vwAIAgents.ID)
+    */
+    get SubAgentID(): string | null;
+    set SubAgentID(value: string | null);
+    /**
+    * * Field Name: PromptID
+    * * Display Name: Prompt ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: AI Prompts (vwAIPrompts.ID)
+    */
+    get PromptID(): string | null;
+    set PromptID(value: string | null);
+    /**
+    * * Field Name: ActionOutputMapping
+    * * Display Name: Action Output Mapping
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: JSON configuration for mapping action output parameters to payload paths. Example: {"outputParam1": "payload.customer.status", "*": "payload.lastResult"}
+    */
+    get ActionOutputMapping(): string | null;
+    set ActionOutputMapping(value: string | null);
+    /**
+    * * Field Name: PositionX
+    * * Display Name: Position X
+    * * SQL Data Type: int
+    * * Default Value: 0
+    */
+    get PositionX(): number;
+    set PositionX(value: number);
+    /**
+    * * Field Name: PositionY
+    * * Display Name: Position Y
+    * * SQL Data Type: int
+    * * Default Value: 0
+    */
+    get PositionY(): number;
+    set PositionY(value: number);
+    /**
+    * * Field Name: Width
+    * * Display Name: Width
+    * * SQL Data Type: int
+    * * Default Value: 200
+    */
+    get Width(): number;
+    set Width(value: number);
+    /**
+    * * Field Name: Height
+    * * Display Name: Height
+    * * SQL Data Type: int
+    * * Default Value: 80
+    */
+    get Height(): number;
+    set Height(value: number);
+    /**
+    * * Field Name: __mj_CreatedAt
+    * * Display Name: Created At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_CreatedAt(): Date;
+    /**
+    * * Field Name: __mj_UpdatedAt
+    * * Display Name: Updated At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_UpdatedAt(): Date;
+    /**
+    * * Field Name: Status
+    * * Display Name: Status
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: Active
+    * * Value List Type: List
+    * * Possible Values
+    *   * Active
+    *   * Pending
+    *   * Disabled
+    * * Description: Controls whether this step is executed. Active=normal execution, Pending=skip but may activate later, Disabled=never execute
+    */
+    get Status(): 'Active' | 'Pending' | 'Disabled';
+    set Status(value: 'Active' | 'Pending' | 'Disabled');
+    /**
+    * * Field Name: ActionInputMapping
+    * * Display Name: Action Input Mapping
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: JSON configuration for mapping static values or payload paths to action input parameters. Example: {"param1": "staticValue", "param2": "payload.dynamicValue"}
+    */
+    get ActionInputMapping(): string | null;
+    set ActionInputMapping(value: string | null);
+    /**
+    * * Field Name: Agent
+    * * Display Name: Agent
+    * * SQL Data Type: nvarchar(255)
+    */
+    get Agent(): string | null;
+    /**
+    * * Field Name: Action
+    * * Display Name: Action
+    * * SQL Data Type: nvarchar(425)
+    */
+    get Action(): string | null;
+    /**
+    * * Field Name: SubAgent
+    * * Display Name: Sub Agent
+    * * SQL Data Type: nvarchar(255)
+    */
+    get SubAgent(): string | null;
+    /**
+    * * Field Name: Prompt
+    * * Display Name: Prompt
+    * * SQL Data Type: nvarchar(255)
+    */
+    get Prompt(): string | null;
+}
 /**
  * MJ: AI Agent Types - strongly typed entity sub-class
  * * Schema: __mj
@@ -21809,6 +22316,31 @@ export declare class AIAgentTypeEntity extends BaseEntity<AIAgentTypeEntityType>
     get DriverClass(): string | null;
     set DriverClass(value: string | null);
     /**
+    * * Field Name: UIFormSectionKey
+    * * Display Name: UI Form Section Key
+    * * SQL Data Type: nvarchar(500)
+    * * Description: Optional Angular component key name for a subclass of BaseFormSectionComponent that provides a custom form section for this agent type. When specified, this component will be dynamically loaded and displayed as the first expandable section in the AI Agent form. This allows agent types to have specialized UI elements. The class must be registered with the MemberJunction class factory via @RegisterClass
+    */
+    get UIFormSectionKey(): string | null;
+    set UIFormSectionKey(value: string | null);
+    /**
+    * * Field Name: UIFormKey
+    * * Display Name: UI Form Key
+    * * SQL Data Type: nvarchar(500)
+    * * Description: Optional Angular component key name for a subclass of BaseFormComponent that will completely overrides the default AI Agent form for this agent type. When specified, this component will be used instead of the standard AI Agent form, allowing for completely custom form implementations. The class must be registered with the MemberJunction class factory via @RegisterClass. If both UIFormClass and UIFormSectionClass are specified, UIFormClass takes precedence.
+    */
+    get UIFormKey(): string | null;
+    set UIFormKey(value: string | null);
+    /**
+    * * Field Name: UIFormSectionExpandedByDefault
+    * * Display Name: UI Form Section Expanded By Default
+    * * SQL Data Type: bit
+    * * Default Value: 1
+    * * Description: Determines whether the custom form section (specified by UIFormSectionClass) should be expanded by default when the AI Agent form loads. True means the section starts expanded, False means it starts collapsed. Only applies when UIFormSectionClass is specified. Defaults to 1 (expanded).
+    */
+    get UIFormSectionExpandedByDefault(): boolean;
+    set UIFormSectionExpandedByDefault(value: boolean);
+    /**
     * * Field Name: SystemPrompt
     * * Display Name: System Prompt
     * * SQL Data Type: nvarchar(255)