@zitadel/api 0.1.0-alpha.5 → 0.1.0-alpha.8

package/src/generated/model/{getFlowStep200StepActions.ts → submitFlowStep200StepActionsItem.ts}

@@ -7,22 +7,22 @@
  */
 
 /**
- * Unordered dictionary of available user actions. Keyed by action name.
-The LiquidJS template controls positioning and presentation.
+ * Configuration for a user-invokable action on a step. The `name` is sent
+back in the submit request as `action`.
 
  */
-export type GetFlowStep200StepActions = {
-  [key: string]: {
-    /** Marks this as the default/primary action. The runtime template uses
+export type SubmitFlowStep200StepActionsItem = {
+  /** Action identifier. Sent back in the submit request as `action`. */
+  name: string;
+  /** Marks this as the default/primary action. The runtime template uses
   this hint to choose visual emphasis. At most one action per step
   should be primary; this is not enforced here.
    */
-    primary?: boolean;
-    /** Optional localization key override for the action's label. When
+  primary?: boolean;
+  /** Optional localization key override for the action's label. When
   omitted, the engine derives a key from the step and action names.
   Display text is resolved client-side from a locale dictionary, never
   by the engine.
    */
-    text_key?: string;
-  };
+  text_key?: string;
 };

package/src/generated/model/submitFlowStep200StepFieldsItem.ts

@@ -0,0 +1,46 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { SubmitFlowStep200StepFieldsItemType } from "./submitFlowStep200StepFieldsItemType";
+import type { SubmitFlowStep200StepFieldsItemValidation } from "./submitFlowStep200StepFieldsItemValidation";
+
+/**
+ * A data input capability. Describes what the user must provide.
+Does not contain display text — only a `text_key` resolved client-side.
+
+ */
+export type SubmitFlowStep200StepFieldsItem = {
+  /** Field name, matching a property in the flow's user schema. Carries
+  the submitted value back to the engine.
+   */
+  name: string;
+  /** The input kind the client should render. Encodes the formats and
+  JSON types that map to a familiar HTML input: `email`, `url`,
+  `date` come from `format`; `checkbox` from JSON `type: boolean`;
+  `select` from a closed `enum`. For other formats (e.g. uuid) the
+  type is `text` and `validation.format` carries the rule.
+   */
+  type: SubmitFlowStep200StepFieldsItemType;
+  /** Localization key for the field label. */
+  text_key: string;
+  /** The field MUST be present and non-empty on submit. Mirrors the
+  schema's top-level `required` array.
+   */
+  required?: boolean;
+  /** Pre-filled value (e.g., an identifier carried over from a pivot). */
+  value?: unknown;
+  /** Schema-derived rules the frontend SHOULD apply at input time. The
+  server runs the same rules on submit and is the only authority on
+  whether the step advances — these rules are a UX hint to reduce
+  round trips, not a contract guarantee.
+
+  Omitted entirely when the field has no rules beyond its `type`.
+  Each key mirrors a JSON Schema keyword on the underlying user
+  property; absent keys mean no rule.
+   */
+  validation?: SubmitFlowStep200StepFieldsItemValidation;
+};

package/src/generated/model/{createFlow201StepFieldsType.ts → submitFlowStep200StepFieldsItemType.ts}

@@ -14,10 +14,10 @@ JSON types that map to a familiar HTML input: `email`, `url`,
 type is `text` and `validation.format` carries the rule.
 
  */
-export type CreateFlow201StepFieldsType =
-  (typeof CreateFlow201StepFieldsType)[keyof typeof CreateFlow201StepFieldsType];
+export type SubmitFlowStep200StepFieldsItemType =
+  (typeof SubmitFlowStep200StepFieldsItemType)[keyof typeof SubmitFlowStep200StepFieldsItemType];
 
-export const CreateFlow201StepFieldsType = {
+export const SubmitFlowStep200StepFieldsItemType = {
   text: "text",
   email: "email",
   password: "password",

package/src/generated/model/{submitFlowStep400StepFieldsValidation.ts → submitFlowStep200StepFieldsItemValidation.ts}

@@ -5,7 +5,7 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { SubmitFlowStep400StepFieldsValidationFormat } from "./submitFlowStep400StepFieldsValidationFormat";
+import type { SubmitFlowStep200StepFieldsItemValidationFormat } from "./submitFlowStep200StepFieldsItemValidationFormat";
 
 /**
  * Schema-derived rules the frontend SHOULD apply at input time. The
@@ -18,14 +18,14 @@ Each key mirrors a JSON Schema keyword on the underlying user
 property; absent keys mean no rule.
 
  */
-export type SubmitFlowStep400StepFieldsValidation = {
+export type SubmitFlowStep200StepFieldsItemValidation = {
   /** Semantic format the value must match. Values mirror the user
   meta-schema. When `type` already encodes the format (email,
   url, date), this key is informative and the input type is
   sufficient for client-side validation. When `type` is `text`
   (e.g. `format: uuid`), this key is the only signal.
    */
-  format?: SubmitFlowStep400StepFieldsValidationFormat;
+  format?: SubmitFlowStep200StepFieldsItemValidationFormat;
   /**
    * Minimum length in characters (inclusive). Mirrors `minLength`.
    * @minimum 0

package/src/generated/model/{createFlow201StepFieldsValidationFormat.ts → submitFlowStep200StepFieldsItemValidationFormat.ts}

@@ -14,10 +14,10 @@ sufficient for client-side validation. When `type` is `text`
 (e.g. `format: uuid`), this key is the only signal.
 
  */
-export type CreateFlow201StepFieldsValidationFormat =
-  (typeof CreateFlow201StepFieldsValidationFormat)[keyof typeof CreateFlow201StepFieldsValidationFormat];
+export type SubmitFlowStep200StepFieldsItemValidationFormat =
+  (typeof SubmitFlowStep200StepFieldsItemValidationFormat)[keyof typeof SubmitFlowStep200StepFieldsItemValidationFormat];
 
-export const CreateFlow201StepFieldsValidationFormat = {
+export const SubmitFlowStep200StepFieldsItemValidationFormat = {
   email: "email",
   "date-time": "date-time",
   uuid: "uuid",

package/src/generated/model/submitFlowStep400.ts

@@ -18,9 +18,10 @@ export type SubmitFlowStep400 = {
   session_id: string;
   /** Reserved for future rotation. The sealed `_zflow` cookie carries the flow state today. */
   session_token?: string;
-  /** A step contains unordered capability dictionaries: what to collect (fields),
+  /** A step contains ordered capability arrays: what to collect (fields),
   what the user can do (actions), and what security gates must be satisfied (gates).
-  Layout and element ordering are controlled by the LiquidJS template in `branding.liquid_template`.
+  The LiquidJS template in `branding.liquid_template` iterates these arrays in order
+  and builds name-keyed indexes locally for lookup.
    */
   step: SubmitFlowStep400Step;
   /** Resolved branding configuration. Inherited from the app → team → project

package/src/generated/model/submitFlowStep400Step.ts

@@ -5,18 +5,19 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { SubmitFlowStep400StepActions } from "./submitFlowStep400StepActions";
+import type { SubmitFlowStep400StepActionsItem } from "./submitFlowStep400StepActionsItem";
 import type { SubmitFlowStep400StepChallenge } from "./submitFlowStep400StepChallenge";
 import type { SubmitFlowStep400StepComplete } from "./submitFlowStep400StepComplete";
-import type { SubmitFlowStep400StepFields } from "./submitFlowStep400StepFields";
+import type { SubmitFlowStep400StepFieldsItem } from "./submitFlowStep400StepFieldsItem";
 import type { SubmitFlowStep400StepGates } from "./submitFlowStep400StepGates";
 import type { SubmitFlowStep400StepSsoProvidersItem } from "./submitFlowStep400StepSsoProvidersItem";
 import type { SubmitFlowStep400StepTexts } from "./submitFlowStep400StepTexts";
 
 /**
- * A step contains unordered capability dictionaries: what to collect (fields),
+ * A step contains ordered capability arrays: what to collect (fields),
 what the user can do (actions), and what security gates must be satisfied (gates).
-Layout and element ordering are controlled by the LiquidJS template in `branding.liquid_template`.
+The LiquidJS template in `branding.liquid_template` iterates these arrays in order
+and builds name-keyed indexes locally for lookup.
 
  */
 export type SubmitFlowStep400Step = {
@@ -35,16 +36,16 @@ export type SubmitFlowStep400Step = {
   complete?: SubmitFlowStep400StepComplete;
   /** URL to navigate to (e.g., SSO provider redirect). */
   redirect_url?: string;
-  /** Unordered dictionary of input fields to collect. Keyed by field name.
-  The LiquidJS template controls which fields appear and in what order.
-  Field metadata (type, validation) is resolved by the engine from the
-  flow's user schema.
+  /** Ordered list of input fields to collect. Field metadata (type, validation)
+  is resolved by the engine from the flow's user schema. The LiquidJS
+  template iterates this array; for keyed lookup it builds a name-indexed
+  map locally.
    */
-  fields: SubmitFlowStep400StepFields;
-  /** Unordered dictionary of available user actions. Keyed by action name.
-  The LiquidJS template controls positioning and presentation.
+  fields: SubmitFlowStep400StepFieldsItem[];
+  /** Ordered list of available user actions. The LiquidJS template iterates
+  this array and builds a name-indexed map locally for keyed lookup.
    */
-  actions: SubmitFlowStep400StepActions;
+  actions: SubmitFlowStep400StepActionsItem[];
   /** Security gates that must be satisfied before the step can be submitted.
   The engine injects gates dynamically based on policy, even if they
   are not declared in the flow definition.

package/src/generated/model/{submitFlowStep400StepActions.ts → submitFlowStep400StepActionsItem.ts}

@@ -7,22 +7,22 @@
  */
 
 /**
- * Unordered dictionary of available user actions. Keyed by action name.
-The LiquidJS template controls positioning and presentation.
+ * Configuration for a user-invokable action on a step. The `name` is sent
+back in the submit request as `action`.
 
  */
-export type SubmitFlowStep400StepActions = {
-  [key: string]: {
-    /** Marks this as the default/primary action. The runtime template uses
+export type SubmitFlowStep400StepActionsItem = {
+  /** Action identifier. Sent back in the submit request as `action`. */
+  name: string;
+  /** Marks this as the default/primary action. The runtime template uses
   this hint to choose visual emphasis. At most one action per step
   should be primary; this is not enforced here.
    */
-    primary?: boolean;
-    /** Optional localization key override for the action's label. When
+  primary?: boolean;
+  /** Optional localization key override for the action's label. When
   omitted, the engine derives a key from the step and action names.
   Display text is resolved client-side from a locale dictionary, never
   by the engine.
    */
-    text_key?: string;
-  };
+  text_key?: string;
 };

package/src/generated/model/submitFlowStep400StepFieldsItem.ts

@@ -0,0 +1,46 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { SubmitFlowStep400StepFieldsItemType } from "./submitFlowStep400StepFieldsItemType";
+import type { SubmitFlowStep400StepFieldsItemValidation } from "./submitFlowStep400StepFieldsItemValidation";
+
+/**
+ * A data input capability. Describes what the user must provide.
+Does not contain display text — only a `text_key` resolved client-side.
+
+ */
+export type SubmitFlowStep400StepFieldsItem = {
+  /** Field name, matching a property in the flow's user schema. Carries
+  the submitted value back to the engine.
+   */
+  name: string;
+  /** The input kind the client should render. Encodes the formats and
+  JSON types that map to a familiar HTML input: `email`, `url`,
+  `date` come from `format`; `checkbox` from JSON `type: boolean`;
+  `select` from a closed `enum`. For other formats (e.g. uuid) the
+  type is `text` and `validation.format` carries the rule.
+   */
+  type: SubmitFlowStep400StepFieldsItemType;
+  /** Localization key for the field label. */
+  text_key: string;
+  /** The field MUST be present and non-empty on submit. Mirrors the
+  schema's top-level `required` array.
+   */
+  required?: boolean;
+  /** Pre-filled value (e.g., an identifier carried over from a pivot). */
+  value?: unknown;
+  /** Schema-derived rules the frontend SHOULD apply at input time. The
+  server runs the same rules on submit and is the only authority on
+  whether the step advances — these rules are a UX hint to reduce
+  round trips, not a contract guarantee.
+
+  Omitted entirely when the field has no rules beyond its `type`.
+  Each key mirrors a JSON Schema keyword on the underlying user
+  property; absent keys mean no rule.
+   */
+  validation?: SubmitFlowStep400StepFieldsItemValidation;
+};

package/src/generated/model/{getFlowStep200StepFieldsType.ts → submitFlowStep400StepFieldsItemType.ts}

@@ -14,10 +14,10 @@ JSON types that map to a familiar HTML input: `email`, `url`,
 type is `text` and `validation.format` carries the rule.
 
  */
-export type GetFlowStep200StepFieldsType =
-  (typeof GetFlowStep200StepFieldsType)[keyof typeof GetFlowStep200StepFieldsType];
+export type SubmitFlowStep400StepFieldsItemType =
+  (typeof SubmitFlowStep400StepFieldsItemType)[keyof typeof SubmitFlowStep400StepFieldsItemType];
 
-export const GetFlowStep200StepFieldsType = {
+export const SubmitFlowStep400StepFieldsItemType = {
   text: "text",
   email: "email",
   password: "password",

package/src/generated/model/{getFlowStep200StepFieldsValidation.ts → submitFlowStep400StepFieldsItemValidation.ts}

@@ -5,7 +5,7 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { GetFlowStep200StepFieldsValidationFormat } from "./getFlowStep200StepFieldsValidationFormat";
+import type { SubmitFlowStep400StepFieldsItemValidationFormat } from "./submitFlowStep400StepFieldsItemValidationFormat";
 
 /**
  * Schema-derived rules the frontend SHOULD apply at input time. The
@@ -18,14 +18,14 @@ Each key mirrors a JSON Schema keyword on the underlying user
 property; absent keys mean no rule.
 
  */
-export type GetFlowStep200StepFieldsValidation = {
+export type SubmitFlowStep400StepFieldsItemValidation = {
   /** Semantic format the value must match. Values mirror the user
   meta-schema. When `type` already encodes the format (email,
   url, date), this key is informative and the input type is
   sufficient for client-side validation. When `type` is `text`
   (e.g. `format: uuid`), this key is the only signal.
    */
-  format?: GetFlowStep200StepFieldsValidationFormat;
+  format?: SubmitFlowStep400StepFieldsItemValidationFormat;
   /**
    * Minimum length in characters (inclusive). Mirrors `minLength`.
    * @minimum 0

package/src/generated/model/{getFlowStep200StepFieldsValidationFormat.ts → submitFlowStep400StepFieldsItemValidationFormat.ts}

@@ -14,10 +14,10 @@ sufficient for client-side validation. When `type` is `text`
 (e.g. `format: uuid`), this key is the only signal.
 
  */
-export type GetFlowStep200StepFieldsValidationFormat =
-  (typeof GetFlowStep200StepFieldsValidationFormat)[keyof typeof GetFlowStep200StepFieldsValidationFormat];
+export type SubmitFlowStep400StepFieldsItemValidationFormat =
+  (typeof SubmitFlowStep400StepFieldsItemValidationFormat)[keyof typeof SubmitFlowStep400StepFieldsItemValidationFormat];
 
-export const GetFlowStep200StepFieldsValidationFormat = {
+export const SubmitFlowStep400StepFieldsItemValidationFormat = {
   email: "email",
   "date-time": "date-time",
   uuid: "uuid",

package/src/generated/model/updateFlowDefinition200FlowDefinitionStepsItem.ts

@@ -5,7 +5,7 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { UpdateFlowDefinition200FlowDefinitionStepsItemActions } from "./updateFlowDefinition200FlowDefinitionStepsItemActions";
+import type { UpdateFlowDefinition200FlowDefinitionStepsItemActionsItem } from "./updateFlowDefinition200FlowDefinitionStepsItemActionsItem";
 import type { UpdateFlowDefinition200FlowDefinitionStepsItemComplete } from "./updateFlowDefinition200FlowDefinitionStepsItemComplete";
 import type { UpdateFlowDefinition200FlowDefinitionStepsItemGates } from "./updateFlowDefinition200FlowDefinitionStepsItemGates";
 import type { UpdateFlowDefinition200FlowDefinitionStepsItemOnSuccess } from "./updateFlowDefinition200FlowDefinitionStepsItemOnSuccess";
@@ -36,11 +36,11 @@ export type UpdateFlowDefinition200FlowDefinitionStepsItem = {
   transition outcome).
    */
   fields?: string[];
-  /** Actions the user can take. Keyed by action name.
-  The action name is what the frontend sends back in the submit request.
-  If omitted, the engine provides a default `submit` action.
+  /** Ordered list of actions the user can take. The action name is what the
+  frontend sends back in the submit request. If omitted, the engine
+  provides a default `submit` action.
    */
-  actions?: UpdateFlowDefinition200FlowDefinitionStepsItemActions;
+  actions?: UpdateFlowDefinition200FlowDefinitionStepsItemActionsItem[];
   /** Security gates that must be satisfied before submission. Keyed by gate
   name. Each gate selects a kind (e.g. "captcha") and provider-specific
   configuration. The engine may also inject gates dynamically based on
@@ -62,7 +62,7 @@ export type UpdateFlowDefinition200FlowDefinitionStepsItem = {
   complete?: UpdateFlowDefinition200FlowDefinitionStepsItemComplete;
   /** Maps action/outcome names to their transition descriptor.
 
-  Keys match action names from the `actions` dict. Additional keys
+  Keys match action names from the `actions` array. Additional keys
   come from implicit outcomes based on schema annotations
   (e.g. `user_not_found` from `x-unique` fields) and engine
   events (e.g. `sso`, `callback`).

package/src/generated/model/{updateFlowDefinition200FlowDefinitionStepsItemActions.ts → updateFlowDefinition200FlowDefinitionStepsItemActionsItem.ts}

@@ -7,23 +7,22 @@
  */
 
 /**
- * Actions the user can take. Keyed by action name.
-The action name is what the frontend sends back in the submit request.
-If omitted, the engine provides a default `submit` action.
+ * Configuration for a user-invokable action on a step. The `name` is sent
+back in the submit request as `action`.
 
  */
-export type UpdateFlowDefinition200FlowDefinitionStepsItemActions = {
-  [key: string]: {
-    /** Marks this as the default/primary action. The runtime template uses
+export type UpdateFlowDefinition200FlowDefinitionStepsItemActionsItem = {
+  /** Action identifier. Sent back in the submit request as `action`. */
+  name: string;
+  /** Marks this as the default/primary action. The runtime template uses
   this hint to choose visual emphasis. At most one action per step
   should be primary; this is not enforced here.
    */
-    primary?: boolean;
-    /** Optional localization key override for the action's label. When
+  primary?: boolean;
+  /** Optional localization key override for the action's label. When
   omitted, the engine derives a key from the step and action names.
   Display text is resolved client-side from a locale dictionary, never
   by the engine.
    */
-    text_key?: string;
-  };
+  text_key?: string;
 };

package/src/generated/model/updateFlowDefinition200FlowDefinitionStepsItemTransitions.ts

@@ -9,7 +9,7 @@
 /**
  * Maps action/outcome names to their transition descriptor.
 
-Keys match action names from the `actions` dict. Additional keys
+Keys match action names from the `actions` array. Additional keys
 come from implicit outcomes based on schema annotations
 (e.g. `user_not_found` from `x-unique` fields) and engine
 events (e.g. `sso`, `callback`).

package/src/generated/model/updateFlowDefinitionBodyStepsItem.ts

@@ -5,7 +5,7 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { UpdateFlowDefinitionBodyStepsItemActions } from "./updateFlowDefinitionBodyStepsItemActions";
+import type { UpdateFlowDefinitionBodyStepsItemActionsItem } from "./updateFlowDefinitionBodyStepsItemActionsItem";
 import type { UpdateFlowDefinitionBodyStepsItemComplete } from "./updateFlowDefinitionBodyStepsItemComplete";
 import type { UpdateFlowDefinitionBodyStepsItemGates } from "./updateFlowDefinitionBodyStepsItemGates";
 import type { UpdateFlowDefinitionBodyStepsItemOnSuccess } from "./updateFlowDefinitionBodyStepsItemOnSuccess";
@@ -36,11 +36,11 @@ export type UpdateFlowDefinitionBodyStepsItem = {
   transition outcome).
    */
   fields?: string[];
-  /** Actions the user can take. Keyed by action name.
-  The action name is what the frontend sends back in the submit request.
-  If omitted, the engine provides a default `submit` action.
+  /** Ordered list of actions the user can take. The action name is what the
+  frontend sends back in the submit request. If omitted, the engine
+  provides a default `submit` action.
    */
-  actions?: UpdateFlowDefinitionBodyStepsItemActions;
+  actions?: UpdateFlowDefinitionBodyStepsItemActionsItem[];
   /** Security gates that must be satisfied before submission. Keyed by gate
   name. Each gate selects a kind (e.g. "captcha") and provider-specific
   configuration. The engine may also inject gates dynamically based on
@@ -62,7 +62,7 @@ export type UpdateFlowDefinitionBodyStepsItem = {
   complete?: UpdateFlowDefinitionBodyStepsItemComplete;
   /** Maps action/outcome names to their transition descriptor.
 
-  Keys match action names from the `actions` dict. Additional keys
+  Keys match action names from the `actions` array. Additional keys
   come from implicit outcomes based on schema annotations
   (e.g. `user_not_found` from `x-unique` fields) and engine
   events (e.g. `sso`, `callback`).

package/src/generated/model/updateFlowDefinitionBodyStepsItemActionsItem.ts

@@ -0,0 +1,28 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+
+/**
+ * Configuration for a user-invokable action on a step. The `name` is sent
+back in the submit request as `action`.
+
+ */
+export type UpdateFlowDefinitionBodyStepsItemActionsItem = {
+  /** Action identifier. Sent back in the submit request as `action`. */
+  name: string;
+  /** Marks this as the default/primary action. The runtime template uses
+  this hint to choose visual emphasis. At most one action per step
+  should be primary; this is not enforced here.
+   */
+  primary?: boolean;
+  /** Optional localization key override for the action's label. When
+  omitted, the engine derives a key from the step and action names.
+  Display text is resolved client-side from a locale dictionary, never
+  by the engine.
+   */
+  text_key?: string;
+};

package/src/generated/model/updateFlowDefinitionBodyStepsItemTransitions.ts

@@ -9,7 +9,7 @@
 /**
  * Maps action/outcome names to their transition descriptor.
 
-Keys match action names from the `actions` dict. Additional keys
+Keys match action names from the `actions` array. Additional keys
 come from implicit outcomes based on schema annotations
 (e.g. `user_not_found` from `x-unique` fields) and engine
 events (e.g. `sso`, `callback`).