@swiss-ai-hub/web 0.317.1 → 0.319.0

package/sdk/client/types.gen.ts

@@ -355,6 +355,7 @@ export type AgentClassDto = {
     | Checkbox
     | ChipsInput
     | ColorPicker
+    | CronInput
     | DatePicker
     | Group
     | IconSelector
@@ -419,6 +420,12 @@ export type AgentClassDto = {
    * Whether the agent class can participate in a chat-based conversation
    */
   is_conversational: boolean;
+  /**
+   * Is Schedulable
+   *
+   * Whether the agent class can be run automatically on a cron schedule
+   */
+  is_schedulable?: boolean;
   /**
    * Is Online
    *
@@ -482,6 +489,7 @@ export type AgentConfigDto = {
     | Checkbox
     | ChipsInput
     | ColorPicker
+    | CronInput
     | DatePicker
     | Group
     | IconSelector
@@ -3850,6 +3858,7 @@ export type ContextualizedAgentEvent = {
     | ToolEvent
     | UserMessageEvent
     | RagStartEvent
+    | ScheduledStartEvent
     | ExceptionEvent
     | RagSuccessStopEvent
     | RagFailureStopEvent
@@ -4141,6 +4150,144 @@ export type CreateTokenResponse = {
   token: string;
 };
 
+/**
+ * CronInput
+ *
+ * A FormKit element for editing the cron schedule of a schedulable agent profile.
+ *
+ * The element renders the five cron positions plus a timezone selector, and the submitted value
+ * matches the fields of `AgentSchedule`:
+ * {
+ * "minute": str,
+ * "hour": str,
+ * "day_of_month": str,
+ * "month": str,
+ * "day_of_week": str,
+ * "timezone": str,
+ * }
+ *
+ * Presets and the plain-language summary of the current schedule are delivered by the Admin UI
+ * (see the cron schedule configuration UI issue); this element only declares the contract.
+ *
+ * ### Form Duality
+ * ```python
+ * from swiss_ai_hub.core.form.elements.cron_input import CronInput
+ * from swiss_ai_hub.core.scheduling.agent_schedule import AgentSchedule
+ *
+ * class MyAgentConfig(AgentConfig):
+ * schedule: Annotated[
+ * AgentSchedule | CronInput | None,
+ * Field(description="When this profile runs automatically"),
+ * ] = None
+ *
+ * # Form mode - for rendering:
+ * config = MyAgentConfig(schedule=CronInput(label=LocaleString(en="Schedule")))
+ *
+ * # Data mode - from submission (Pydantic validates into AgentSchedule):
+ * config = MyAgentConfig(schedule=AgentSchedule(hour="12", timezone="Europe/Zurich"))
+ * ```
+ */
+export type CronInput = {
+  /**
+   * Is Formkit Element
+   *
+   * Indicates that this element is a FormKit element
+   */
+  is_formkit_element?: true;
+  /**
+   * If
+   *
+   * Conditional expression to show this element
+   */
+  if?: string | null;
+  /**
+   * Id
+   *
+   * Unique identifier for this element
+   */
+  id?: string | null;
+  /**
+   * Nullable
+   *
+   * Render with a sibling toggle that sets this field to null when off
+   */
+  nullable?: boolean;
+  /**
+   * Defaultenabled
+   *
+   * For a nullable element, whether its toggle should start enabled on a fresh form (i.e. the field's data default is non-null). Ignored for non-nullable elements.
+   */
+  defaultEnabled?: boolean | null;
+  /**
+   * Formkit
+   *
+   * Cron schedule input element.
+   */
+  formkit?: "cronInput";
+  /**
+   * Name
+   *
+   * Name of this field
+   */
+  name?: string | null;
+  /**
+   * Label
+   *
+   * Label of this field
+   */
+  label: LocaleString | string;
+  /**
+   * Help
+   *
+   * Help text of this field
+   */
+  help?: LocaleString | string | null;
+  /**
+   * Value
+   *
+   * Default value for this field
+   */
+  value?:
+    | string
+    | number
+    | number
+    | boolean
+    | Array<string>
+    | {
+        [key: string]: string;
+      }
+    | null;
+  /**
+   * Required
+   *
+   * Whether this field is required
+   */
+  required?: boolean;
+  /**
+   * Additional Validation Rules
+   *
+   * Validation expression
+   */
+  additional_validation_rules?: string | null;
+  /**
+   * Timezoneplaceholder
+   *
+   * Placeholder for the timezone select
+   */
+  timezonePlaceholder?: LocaleString | string | null;
+  /**
+   * Filter
+   *
+   * Whether to enable filtering/search on the timezone select
+   */
+  filter?: boolean;
+  /**
+   * Validation
+   */
+  readonly validation: string;
+  [key: string]: unknown;
+};
+
 /**
  * Custom
  *
@@ -5638,6 +5785,12 @@ export type FullAgentInstanceDto = {
    * Whether the agent can participate in a chat-based conversation
    */
   is_conversational: boolean;
+  /**
+   * Is Schedulable
+   *
+   * Whether the agent can be run automatically on a cron schedule
+   */
+  is_schedulable?: boolean;
   /**
    * Start Events
    *
@@ -5749,6 +5902,7 @@ export type FullProcessInstanceDto = {
     | Checkbox
     | ChipsInput
     | ColorPicker
+    | CronInput
     | DatePicker
     | Group
     | IconSelector
@@ -5917,6 +6071,12 @@ export type Group = {
    * Optional label displayed above the group
    */
   label?: LocaleString | string | null;
+  /**
+   * Help
+   *
+   * Optional explanatory text rendered on the group's enable toggle
+   */
+  help?: LocaleString | string | null;
   /**
    * Children
    *
@@ -5929,6 +6089,7 @@ export type Group = {
     | Checkbox
     | ChipsInput
     | ColorPicker
+    | CronInput
     | DatePicker
     | Group
     | IconSelector
@@ -6284,6 +6445,7 @@ export type HumanInDto = {
     | Checkbox
     | ChipsInput
     | ColorPicker
+    | CronInput
     | DatePicker
     | Group
     | IconSelector
@@ -6364,6 +6526,7 @@ export type HumanInSpecs = {
     | Checkbox
     | ChipsInput
     | ColorPicker
+    | CronInput
     | DatePicker
     | Group
     | IconSelector
@@ -9134,6 +9297,13 @@ export type LocaleInput = {
   placeholder?: LocaleString | string | null;
   /**
    * Validation
+   *
+   * Emits `localeRequired` where other elements emit FormKit's `required`.
+   *
+   * FormKit's `required` rule only asks whether a value is present, and this element's
+   * value is always a `{de, en, fr, it}` object — non-empty, therefore passing, even when
+   * every locale inside it is blank. `localeRequired` (registered in the frontend FormKit
+   * config) looks at the locale values themselves.
    */
   readonly validation: string;
   [key: string]: unknown;
@@ -9420,6 +9590,10 @@ export type MailFetchedEvent = {
    * References to the message's attachments stored in S3.
    */
   attachments?: Array<MailAttachmentRef>;
+  /**
+   * Reference to the original RFC822 message stored in S3, or null when it was not stored.
+   */
+  original_message?: MailMessageRef | null;
   /**
    * Event Name
    *
@@ -9436,6 +9610,43 @@ export type MailFetchedEvent = {
   [key: string]: unknown;
 };
 
+/**
+ * MailMessageRef
+ *
+ * Reference to a fetched message's original RFC822 bytes, stored in S3 rather than carried in the event.
+ *
+ * Mirrors ``MailAttachmentRef``: the message is referenced by ``file_id`` so the raw mail — which may be
+ * orders of magnitude larger than the summary the event carries — never enters the audit trail or the
+ * WebSocket stream. The stored object is the message **verbatim**, so it also preserves what the event
+ * deliberately omits: the recipients and the untrusted HTML body.
+ */
+export type MailMessageRef = {
+  /**
+   * Filename
+   *
+   * Filename the message is stored under, e.g. '1234.eml'. Must not contain path separators.
+   */
+  filename: string;
+  /**
+   * Content Type
+   *
+   * MIME type of the stored message.
+   */
+  content_type?: string;
+  /**
+   * File Id
+   *
+   * UUID4 file identifier; the S3 object key is derived from the agent identity at runtime.
+   */
+  file_id: string;
+  /**
+   * Size Bytes
+   *
+   * Size of the stored message in bytes.
+   */
+  size_bytes: number;
+};
+
 /**
  * MailMovedEvent
  *
@@ -10000,6 +10211,12 @@ export type MinimalAgentInstanceDto = {
    * Whether the agent can participate in a chat-based conversation
    */
   is_conversational: boolean;
+  /**
+   * Is Schedulable
+   *
+   * Whether the agent can be run automatically on a cron schedule
+   */
+  is_schedulable?: boolean;
 };
 
 /**
@@ -11476,6 +11693,7 @@ export type ProcessClassDto = {
     | Checkbox
     | ChipsInput
     | ColorPicker
+    | CronInput
     | DatePicker
     | Group
     | IconSelector
@@ -12510,6 +12728,7 @@ export type Repeater = {
     | Checkbox
     | ChipsInput
     | ColorPicker
+    | CronInput
     | DatePicker
     | Group
     | IconSelector
@@ -13092,6 +13311,70 @@ export type RunStatistics = {
   agent: MinimalAgentInstanceDto;
 };
 
+/**
+ * ScheduledStartEvent
+ *
+ * Start event fired by the cron scheduler — handling it is what makes an agent schedulable.
+ *
+ * Mirrors how accepting a `UserMessageEvent` makes an agent conversational: `AgentRunner` derives
+ * `is_schedulable` from the start events an agent declares, so a blueprint opts in by adding a step
+ * that consumes this event, with no separate registration.
+ *
+ * Scheduled runs are system runs, so `user` is always None and the agent must not depend on an
+ * initiating identity. Whatever tenant context the agent needs comes from its own profile
+ * configuration (as `OrgMemoryWriteConfig.tenant_id` already does), never from the run.
+ */
+export type ScheduledStartEvent = {
+  /**
+   * Event Id
+   */
+  event_id?: string;
+  /**
+   * Created At
+   *
+   * The time (in ns since epoch) the event was stored in the event store
+   */
+  created_at?: number;
+  /**
+   * Display name for the event
+   */
+  display_name?: LocaleString | null;
+  /**
+   * Display description for the event
+   */
+  display_description?: LocaleString | null;
+  /**
+   * Locale
+   *
+   * The locale the scheduled run reports its display output in.
+   */
+  locale?: string;
+  /**
+   * Always None — scheduled runs are system-initiated and carry no execution identity.
+   */
+  user?: UserIdentity | null;
+  /**
+   * Scheduled For
+   *
+   * The cron occurrence this run fires for, in UTC. Distinct from `created_at`, which records when the scheduler published the event — the two differ by the scheduler's tick latency.
+   */
+  scheduled_for: Date;
+  /**
+   * Event Name
+   *
+   * The event type name, usually the class name. If unknown, uses _unknown_event_name.
+   * Used during deserialization to decide which subclass to instantiate.
+   */
+  readonly _event_name: string;
+  /**
+   * Parent Event Names
+   *
+   * Contains the names of all parent classes up until BaseEvent, ordered from deepest to least deep inheritance.
+   */
+  readonly _parent_event_names: Array<string>;
+  [key: string]: unknown;
+};
+
 /**
  * SearchContextCostPerQueryDTO
  *
@@ -14397,9 +14680,9 @@ export type TextToSpeechRequest = {
   /**
    * Model
    *
-   * The TTS model to use. Available options: 'tts-1' or 'tts-1-hd'.
+   * The TTS model to use, e.g. 'speech/<model-name>'.
    */
-  model: "tts-1" | "tts-1-hd";
+  model: string;
   /**
    * Input
    *
@@ -16605,6 +16888,7 @@ export type AgentClassDtoWritable = {
     | CheckboxWritable
     | ChipsInputWritable
     | ColorPickerWritable
+    | CronInputWritable
     | DatePickerWritable
     | GroupWritable
     | IconSelectorWritable
@@ -16669,6 +16953,12 @@ export type AgentClassDtoWritable = {
    * Whether the agent class can participate in a chat-based conversation
    */
   is_conversational: boolean;
+  /**
+   * Is Schedulable
+   *
+   * Whether the agent class can be run automatically on a cron schedule
+   */
+  is_schedulable?: boolean;
   /**
    * Is Online
    *
@@ -16732,6 +17022,7 @@ export type AgentConfigDtoWritable = {
     | CheckboxWritable
     | ChipsInputWritable
     | ColorPickerWritable
+    | CronInputWritable
     | DatePickerWritable
     | GroupWritable
     | IconSelectorWritable
@@ -18248,6 +18539,7 @@ export type ContextualizedAgentEventWritable = {
     | ToolEventWritable
     | UserMessageEventWritable
     | RagStartEventWritable
+    | ScheduledStartEventWritable
     | ExceptionEventWritable
     | RagSuccessStopEventWritable
     | RagFailureStopEventWritable
@@ -18341,6 +18633,140 @@ export type ConversationTitleEventWritable = {
   [key: string]: unknown;
 };
 
+/**
+ * CronInput
+ *
+ * A FormKit element for editing the cron schedule of a schedulable agent profile.
+ *
+ * The element renders the five cron positions plus a timezone selector, and the submitted value
+ * matches the fields of `AgentSchedule`:
+ * {
+ * "minute": str,
+ * "hour": str,
+ * "day_of_month": str,
+ * "month": str,
+ * "day_of_week": str,
+ * "timezone": str,
+ * }
+ *
+ * Presets and the plain-language summary of the current schedule are delivered by the Admin UI
+ * (see the cron schedule configuration UI issue); this element only declares the contract.
+ *
+ * ### Form Duality
+ * ```python
+ * from swiss_ai_hub.core.form.elements.cron_input import CronInput
+ * from swiss_ai_hub.core.scheduling.agent_schedule import AgentSchedule
+ *
+ * class MyAgentConfig(AgentConfig):
+ * schedule: Annotated[
+ * AgentSchedule | CronInput | None,
+ * Field(description="When this profile runs automatically"),
+ * ] = None
+ *
+ * # Form mode - for rendering:
+ * config = MyAgentConfig(schedule=CronInput(label=LocaleString(en="Schedule")))
+ *
+ * # Data mode - from submission (Pydantic validates into AgentSchedule):
+ * config = MyAgentConfig(schedule=AgentSchedule(hour="12", timezone="Europe/Zurich"))
+ * ```
+ */
+export type CronInputWritable = {
+  /**
+   * Is Formkit Element
+   *
+   * Indicates that this element is a FormKit element
+   */
+  is_formkit_element?: true;
+  /**
+   * If
+   *
+   * Conditional expression to show this element
+   */
+  if?: string | null;
+  /**
+   * Id
+   *
+   * Unique identifier for this element
+   */
+  id?: string | null;
+  /**
+   * Nullable
+   *
+   * Render with a sibling toggle that sets this field to null when off
+   */
+  nullable?: boolean;
+  /**
+   * Defaultenabled
+   *
+   * For a nullable element, whether its toggle should start enabled on a fresh form (i.e. the field's data default is non-null). Ignored for non-nullable elements.
+   */
+  defaultEnabled?: boolean | null;
+  /**
+   * Formkit
+   *
+   * Cron schedule input element.
+   */
+  formkit?: "cronInput";
+  /**
+   * Name
+   *
+   * Name of this field
+   */
+  name?: string | null;
+  /**
+   * Label
+   *
+   * Label of this field
+   */
+  label: LocaleString | string;
+  /**
+   * Help
+   *
+   * Help text of this field
+   */
+  help?: LocaleString | string | null;
+  /**
+   * Value
+   *
+   * Default value for this field
+   */
+  value?:
+    | string
+    | number
+    | number
+    | boolean
+    | Array<string>
+    | {
+        [key: string]: string;
+      }
+    | null;
+  /**
+   * Required
+   *
+   * Whether this field is required
+   */
+  required?: boolean;
+  /**
+   * Additional Validation Rules
+   *
+   * Validation expression
+   */
+  additional_validation_rules?: string | null;
+  /**
+   * Timezoneplaceholder
+   *
+   * Placeholder for the timezone select
+   */
+  timezonePlaceholder?: LocaleString | string | null;
+  /**
+   * Filter
+   *
+   * Whether to enable filtering/search on the timezone select
+   */
+  filter?: boolean;
+  [key: string]: unknown;
+};
+
 /**
  * DatePicker
  *
@@ -18851,6 +19277,12 @@ export type FullAgentInstanceDtoWritable = {
    * Whether the agent can participate in a chat-based conversation
    */
   is_conversational: boolean;
+  /**
+   * Is Schedulable
+   *
+   * Whether the agent can be run automatically on a cron schedule
+   */
+  is_schedulable?: boolean;
   /**
    * Start Events
    *
@@ -18962,6 +19394,7 @@ export type FullProcessInstanceDtoWritable = {
     | CheckboxWritable
     | ChipsInputWritable
     | ColorPickerWritable
+    | CronInputWritable
     | DatePickerWritable
     | GroupWritable
     | IconSelectorWritable
@@ -19069,6 +19502,12 @@ export type GroupWritable = {
    * Optional label displayed above the group
    */
   label?: LocaleString | string | null;
+  /**
+   * Help
+   *
+   * Optional explanatory text rendered on the group's enable toggle
+   */
+  help?: LocaleString | string | null;
   /**
    * Children
    *
@@ -19081,6 +19520,7 @@ export type GroupWritable = {
     | CheckboxWritable
     | ChipsInputWritable
     | ColorPickerWritable
+    | CronInputWritable
     | DatePickerWritable
     | GroupWritable
     | IconSelectorWritable
@@ -19284,6 +19724,7 @@ export type HumanInDtoWritable = {
     | CheckboxWritable
     | ChipsInputWritable
     | ColorPickerWritable
+    | CronInputWritable
     | DatePickerWritable
     | GroupWritable
     | IconSelectorWritable
@@ -19364,6 +19805,7 @@ export type HumanInSpecsWritable = {
     | CheckboxWritable
     | ChipsInputWritable
     | ColorPickerWritable
+    | CronInputWritable
     | DatePickerWritable
     | GroupWritable
     | IconSelectorWritable
@@ -21471,6 +21913,10 @@ export type MailFetchedEventWritable = {
    * References to the message's attachments stored in S3.
    */
   attachments?: Array<MailAttachmentRef>;
+  /**
+   * Reference to the original RFC822 message stored in S3, or null when it was not stored.
+   */
+  original_message?: MailMessageRef | null;
   [key: string]: unknown;
 };
 
@@ -21649,6 +22095,12 @@ export type MinimalAgentInstanceDtoWritable = {
    * Whether the agent can participate in a chat-based conversation
    */
   is_conversational: boolean;
+  /**
+   * Is Schedulable
+   *
+   * Whether the agent can be run automatically on a cron schedule
+   */
+  is_schedulable?: boolean;
 };
 
 /**
@@ -22262,6 +22714,7 @@ export type ProcessClassDtoWritable = {
     | CheckboxWritable
     | ChipsInputWritable
     | ColorPickerWritable
+    | CronInputWritable
     | DatePickerWritable
     | GroupWritable
     | IconSelectorWritable
@@ -22933,6 +23386,7 @@ export type RepeaterWritable = {
     | CheckboxWritable
     | ChipsInputWritable
     | ColorPickerWritable
+    | CronInputWritable
     | DatePickerWritable
     | GroupWritable
     | IconSelectorWritable
@@ -23318,6 +23772,57 @@ export type RunStatisticsWritable = {
   agent: MinimalAgentInstanceDtoWritable;
 };
 
+/**
+ * ScheduledStartEvent
+ *
+ * Start event fired by the cron scheduler — handling it is what makes an agent schedulable.
+ *
+ * Mirrors how accepting a `UserMessageEvent` makes an agent conversational: `AgentRunner` derives
+ * `is_schedulable` from the start events an agent declares, so a blueprint opts in by adding a step
+ * that consumes this event, with no separate registration.
+ *
+ * Scheduled runs are system runs, so `user` is always None and the agent must not depend on an
+ * initiating identity. Whatever tenant context the agent needs comes from its own profile
+ * configuration (as `OrgMemoryWriteConfig.tenant_id` already does), never from the run.
+ */
+export type ScheduledStartEventWritable = {
+  /**
+   * Event Id
+   */
+  event_id?: string;
+  /**
+   * Created At
+   *
+   * The time (in ns since epoch) the event was stored in the event store
+   */
+  created_at?: number;
+  /**
+   * Display name for the event
+   */
+  display_name?: LocaleString | null;
+  /**
+   * Display description for the event
+   */
+  display_description?: LocaleString | null;
+  /**
+   * Locale
+   *
+   * The locale the scheduled run reports its display output in.
+   */
+  locale?: string;
+  /**
+   * Always None — scheduled runs are system-initiated and carry no execution identity.
+   */
+  user?: UserIdentity | null;
+  /**
+   * Scheduled For
+   *
+   * The cron occurrence this run fires for, in UTC. Distinct from `created_at`, which records when the scheduler published the event — the two differ by the scheduler's tick latency.
+   */
+  scheduled_for: Date;
+  [key: string]: unknown;
+};
+
 /**
  * Select
  *