@wise/dynamic-flow-types 2.18.0 → 2.18.1

package/build/next/feature/Action.d.ts

@@ -6,7 +6,7 @@ import type { JsonElement } from '../JsonElement';
 * An action typically defines its URL and HTTP method to submit step data, and can optionally indicate that on success
 * this action will end the flow.
 * An endpoint can respond to a submitting action with an error status code and the standard error response format in order to display errors to the user.
-* ### Behaviour
+* ### Behavior
 * #### Non-Exiting Actions
 * If an action does not specify the `exit` property as true, it is expected that the action will submit the step payload.
 * For example, the following action is a non-exiting action.

package/build/next/feature/External.d.ts

@@ -1,5 +1,5 @@
 /**
-* External specifies a URL to be opened automatically when a step loads. Url-opening behaviour depends on the platform.
+* External specifies a URL to be opened automatically when a step loads. Url-opening behavior depends on the platform.
 * General guidance is as follows:
 * Web:
 * - Open a URL in a new browser tab.

package/build/next/feature/NavigationStackBehavior.d.ts

@@ -1,5 +1,5 @@
 /**
-* Describes the behaviour of the navigation stack when the step is presented.
+* Describes the behavior of the navigation stack when the step is presented.
 * @experimental This feature may be changed in the future without notice.
 */
 export type NavigationStackBehavior = 'default' | 'remove-previous' | 'remove-all' | 'replace-current';

package/build/next/step/Step.d.ts

@@ -10,7 +10,7 @@ import type { Navigation } from '../feature/Navigation';
 /**
 * A step represents a single screen in a flow. It is made up of schemas, which represent data to be collected from the
 * user, layouts which describe how the screen looks, and a number of advanced features to provide more complex
-* behaviours.
+* behaviors.
 * ### Step Response
 * A response is determined to be a Step when the status code is in the 200-299 range, the `exit` property in the triggering action was not set to `true`, and the `X-DF-Response-Type: step` header is provided.
 */
@@ -40,10 +40,6 @@ export type Step = {
     */
     title: string;
     /**
-    * A user-facing subtitle.
-    */
-    description?: string;
-    /**
     * An array of schemas describing the data for the user to input. Each root schemas which should be displayed to the
     * user must be referenced by a [com.wise.dynamicflow.layout.FormLayout] in the `layout` property. If a schema is
     * not referenced by a [com.wise.dynamicflow.layout.FormLayout], it won't be displayed, but it will still be submitted.
@@ -56,6 +52,10 @@ export type Step = {
     */
     layout: Layout[];
     /**
+    * A user-facing subtitle.
+    */
+    description?: string;
+    /**
     * The data to use when initialising the step. It must follow the structure the schemas array describes, and any
     * data which doesn't correspond to the schema is ignored.
     */
@@ -65,7 +65,7 @@ export type Step = {
     */
     external?: External;
     /**
-    * Used to configure a polling behaviour, allowing the flow to progress automatically.
+    * Used to configure a polling behavior, allowing the flow to progress automatically.
     */
     polling?: Polling;
     /**
@@ -82,7 +82,7 @@ export type Step = {
     */
     errors?: StepError;
     /**
-    * Used to configure navigational behaviour of the step, for example to provide an
+    * Used to configure navigational behavior of the step, for example to provide an
     * [com.wise.dynamicflow.feature.Action] to perform when navigating back.
     */
     navigation?: Navigation;

package/build/zod/schemas.ts

@@ -916,9 +916,9 @@ export const stepSchema: z.ZodSchema<Step> = z.lazy(() =>
     refreshFormUrl: z.string().optional(),
     id: z.string(),
     title: z.string(),
-    description: z.string().optional(),
     schemas: z.array(schemaSchema),
     layout: z.array(layoutSchema),
+    description: z.string().optional(),
     model: jsonElementSchema.optional(),
     external: externalSchema.optional(),
     polling: pollingSchema.optional(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wise/dynamic-flow-types",
-  "version": "2.18.0",
+  "version": "2.18.1",
   "description": "Dynamic Flow TypeScript Types",
   "license": "Apache-2.0",
   "repository": {