@wise/dynamic-flow-types 3.18.0 → 3.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/build/main.js CHANGED
@@ -852,7 +852,10 @@ var allOfSchemaSchema = import_zod.z.lazy(
852
852
  analyticsId: import_zod.z.string().optional(),
853
853
  alert: alertLayoutSchema.optional(),
854
854
  media: mediaSchema.optional(),
855
- tags: import_zod.z.array(import_zod.z.string()).optional()
855
+ tags: import_zod.z.array(import_zod.z.string()).optional(),
856
+ additionalText: import_zod.z.string().optional(),
857
+ supportingValues: supportingValuesSchema.optional(),
858
+ inlineAlert: inlineAlertSchema.optional()
856
859
  })
857
860
  );
858
861
  var arraySchemaSchema = import_zod.z.lazy(
@@ -881,7 +884,10 @@ var blobSchemaSchema = import_zod.z.lazy(
881
884
  source: uploadSourceSchema.optional(),
882
885
  disabled: import_zod.z.boolean().optional(),
883
886
  media: mediaSchema.optional(),
884
- tags: import_zod.z.array(import_zod.z.string()).optional()
887
+ tags: import_zod.z.array(import_zod.z.string()).optional(),
888
+ additionalText: import_zod.z.string().optional(),
889
+ supportingValues: supportingValuesSchema.optional(),
890
+ inlineAlert: inlineAlertSchema.optional()
885
891
  })
886
892
  );
887
893
  var booleanSchemaSchema = import_zod.z.lazy(
@@ -912,14 +918,16 @@ var booleanSchemaSchema = import_zod.z.lazy(
912
918
  help: helpSchema.optional(),
913
919
  onChange: behaviorSchema.optional(),
914
920
  media: mediaSchema.optional(),
915
- tags: import_zod.z.array(import_zod.z.string()).optional()
921
+ tags: import_zod.z.array(import_zod.z.string()).optional(),
922
+ additionalText: import_zod.z.string().optional(),
923
+ supportingValues: supportingValuesSchema.optional(),
924
+ inlineAlert: inlineAlertSchema.optional()
916
925
  })
917
926
  );
918
927
  var constSchemaSchema = import_zod.z.lazy(
919
928
  () => import_zod.z.object({
920
929
  hidden: import_zod.z.boolean().optional(),
921
930
  control: import_zod.z.string().optional(),
922
- tags: import_zod.z.array(import_zod.z.string()).optional(),
923
931
  promoted: import_zod.z.boolean().optional(),
924
932
  $id: import_zod.z.string().optional(),
925
933
  const: jsonElementSchema,
@@ -933,7 +941,11 @@ var constSchemaSchema = import_zod.z.lazy(
933
941
  disabled: import_zod.z.boolean().optional(),
934
942
  media: mediaSchema.optional(),
935
943
  alert: alertLayoutSchema.optional(),
936
- layout: import_zod.z.array(layoutSchema).optional()
944
+ layout: import_zod.z.array(layoutSchema).optional(),
945
+ tags: import_zod.z.array(import_zod.z.string()).optional(),
946
+ additionalText: import_zod.z.string().optional(),
947
+ supportingValues: supportingValuesSchema.optional(),
948
+ inlineAlert: inlineAlertSchema.optional()
937
949
  })
938
950
  );
939
951
  var integerSchemaSchema = import_zod.z.lazy(
@@ -969,7 +981,10 @@ var integerSchemaSchema = import_zod.z.lazy(
969
981
  help: helpSchema.optional(),
970
982
  onChange: behaviorSchema.optional(),
971
983
  media: mediaSchema.optional(),
972
- tags: import_zod.z.array(import_zod.z.string()).optional()
984
+ tags: import_zod.z.array(import_zod.z.string()).optional(),
985
+ additionalText: import_zod.z.string().optional(),
986
+ supportingValues: supportingValuesSchema.optional(),
987
+ inlineAlert: inlineAlertSchema.optional()
973
988
  })
974
989
  );
975
990
  var numberSchemaSchema = import_zod.z.lazy(
@@ -1005,7 +1020,10 @@ var numberSchemaSchema = import_zod.z.lazy(
1005
1020
  help: helpSchema.optional(),
1006
1021
  onChange: behaviorSchema.optional(),
1007
1022
  media: mediaSchema.optional(),
1008
- tags: import_zod.z.array(import_zod.z.string()).optional()
1023
+ tags: import_zod.z.array(import_zod.z.string()).optional(),
1024
+ additionalText: import_zod.z.string().optional(),
1025
+ supportingValues: supportingValuesSchema.optional(),
1026
+ inlineAlert: inlineAlertSchema.optional()
1009
1027
  })
1010
1028
  );
1011
1029
  var objectSchemaSchema = import_zod.z.lazy(
@@ -1030,7 +1048,10 @@ var objectSchemaSchema = import_zod.z.lazy(
1030
1048
  alert: alertLayoutSchema.optional(),
1031
1049
  media: mediaSchema.optional(),
1032
1050
  tags: import_zod.z.array(import_zod.z.string()).optional(),
1033
- format: import_zod.z.string().optional()
1051
+ format: import_zod.z.string().optional(),
1052
+ additionalText: import_zod.z.string().optional(),
1053
+ supportingValues: supportingValuesSchema.optional(),
1054
+ inlineAlert: inlineAlertSchema.optional()
1034
1055
  })
1035
1056
  );
1036
1057
  var oneOfSchemaSchema = import_zod.z.lazy(
@@ -1063,7 +1084,10 @@ var oneOfSchemaSchema = import_zod.z.lazy(
1063
1084
  disabled: import_zod.z.boolean().optional(),
1064
1085
  onChange: behaviorSchema.optional(),
1065
1086
  media: mediaSchema.optional(),
1066
- tags: import_zod.z.array(import_zod.z.string()).optional()
1087
+ tags: import_zod.z.array(import_zod.z.string()).optional(),
1088
+ additionalText: import_zod.z.string().optional(),
1089
+ supportingValues: supportingValuesSchema.optional(),
1090
+ inlineAlert: inlineAlertSchema.optional()
1067
1091
  })
1068
1092
  );
1069
1093
  var stringSchemaSchema = import_zod.z.lazy(
@@ -1111,7 +1135,10 @@ var stringSchemaSchema = import_zod.z.lazy(
1111
1135
  suggestions: suggestionsSchema.optional(),
1112
1136
  onChange: behaviorSchema.optional(),
1113
1137
  media: mediaSchema.optional(),
1114
- tags: import_zod.z.array(import_zod.z.string()).optional()
1138
+ tags: import_zod.z.array(import_zod.z.string()).optional(),
1139
+ additionalText: import_zod.z.string().optional(),
1140
+ supportingValues: supportingValuesSchema.optional(),
1141
+ inlineAlert: inlineAlertSchema.optional()
1115
1142
  })
1116
1143
  );
1117
1144
  var arraySchemaListSchema = import_zod.z.lazy(
@@ -1140,7 +1167,10 @@ var arraySchemaListSchema = import_zod.z.lazy(
1140
1167
  validationMessages: import_zod.z.record(import_zod.z.string()).optional(),
1141
1168
  disabled: import_zod.z.boolean().optional(),
1142
1169
  media: mediaSchema.optional(),
1143
- tags: import_zod.z.array(import_zod.z.string()).optional()
1170
+ tags: import_zod.z.array(import_zod.z.string()).optional(),
1171
+ additionalText: import_zod.z.string().optional(),
1172
+ supportingValues: supportingValuesSchema.optional(),
1173
+ inlineAlert: inlineAlertSchema.optional()
1144
1174
  })
1145
1175
  );
1146
1176
  var persistAsyncSchema = import_zod.z.lazy(
@@ -1171,7 +1201,10 @@ var arraySchemaTupleSchema = import_zod.z.lazy(
1171
1201
  validationAsync: validateAsyncSchema.optional(),
1172
1202
  alert: alertLayoutSchema.optional(),
1173
1203
  media: mediaSchema.optional(),
1174
- tags: import_zod.z.array(import_zod.z.string()).optional()
1204
+ tags: import_zod.z.array(import_zod.z.string()).optional(),
1205
+ additionalText: import_zod.z.string().optional(),
1206
+ supportingValues: supportingValuesSchema.optional(),
1207
+ inlineAlert: inlineAlertSchema.optional()
1175
1208
  })
1176
1209
  );
1177
1210
  var pollingOnErrorSchema = import_zod.z.lazy(
package/build/main.mjs CHANGED
@@ -824,7 +824,10 @@ var allOfSchemaSchema = z.lazy(
824
824
  analyticsId: z.string().optional(),
825
825
  alert: alertLayoutSchema.optional(),
826
826
  media: mediaSchema.optional(),
827
- tags: z.array(z.string()).optional()
827
+ tags: z.array(z.string()).optional(),
828
+ additionalText: z.string().optional(),
829
+ supportingValues: supportingValuesSchema.optional(),
830
+ inlineAlert: inlineAlertSchema.optional()
828
831
  })
829
832
  );
830
833
  var arraySchemaSchema = z.lazy(
@@ -853,7 +856,10 @@ var blobSchemaSchema = z.lazy(
853
856
  source: uploadSourceSchema.optional(),
854
857
  disabled: z.boolean().optional(),
855
858
  media: mediaSchema.optional(),
856
- tags: z.array(z.string()).optional()
859
+ tags: z.array(z.string()).optional(),
860
+ additionalText: z.string().optional(),
861
+ supportingValues: supportingValuesSchema.optional(),
862
+ inlineAlert: inlineAlertSchema.optional()
857
863
  })
858
864
  );
859
865
  var booleanSchemaSchema = z.lazy(
@@ -884,14 +890,16 @@ var booleanSchemaSchema = z.lazy(
884
890
  help: helpSchema.optional(),
885
891
  onChange: behaviorSchema.optional(),
886
892
  media: mediaSchema.optional(),
887
- tags: z.array(z.string()).optional()
893
+ tags: z.array(z.string()).optional(),
894
+ additionalText: z.string().optional(),
895
+ supportingValues: supportingValuesSchema.optional(),
896
+ inlineAlert: inlineAlertSchema.optional()
888
897
  })
889
898
  );
890
899
  var constSchemaSchema = z.lazy(
891
900
  () => z.object({
892
901
  hidden: z.boolean().optional(),
893
902
  control: z.string().optional(),
894
- tags: z.array(z.string()).optional(),
895
903
  promoted: z.boolean().optional(),
896
904
  $id: z.string().optional(),
897
905
  const: jsonElementSchema,
@@ -905,7 +913,11 @@ var constSchemaSchema = z.lazy(
905
913
  disabled: z.boolean().optional(),
906
914
  media: mediaSchema.optional(),
907
915
  alert: alertLayoutSchema.optional(),
908
- layout: z.array(layoutSchema).optional()
916
+ layout: z.array(layoutSchema).optional(),
917
+ tags: z.array(z.string()).optional(),
918
+ additionalText: z.string().optional(),
919
+ supportingValues: supportingValuesSchema.optional(),
920
+ inlineAlert: inlineAlertSchema.optional()
909
921
  })
910
922
  );
911
923
  var integerSchemaSchema = z.lazy(
@@ -941,7 +953,10 @@ var integerSchemaSchema = z.lazy(
941
953
  help: helpSchema.optional(),
942
954
  onChange: behaviorSchema.optional(),
943
955
  media: mediaSchema.optional(),
944
- tags: z.array(z.string()).optional()
956
+ tags: z.array(z.string()).optional(),
957
+ additionalText: z.string().optional(),
958
+ supportingValues: supportingValuesSchema.optional(),
959
+ inlineAlert: inlineAlertSchema.optional()
945
960
  })
946
961
  );
947
962
  var numberSchemaSchema = z.lazy(
@@ -977,7 +992,10 @@ var numberSchemaSchema = z.lazy(
977
992
  help: helpSchema.optional(),
978
993
  onChange: behaviorSchema.optional(),
979
994
  media: mediaSchema.optional(),
980
- tags: z.array(z.string()).optional()
995
+ tags: z.array(z.string()).optional(),
996
+ additionalText: z.string().optional(),
997
+ supportingValues: supportingValuesSchema.optional(),
998
+ inlineAlert: inlineAlertSchema.optional()
981
999
  })
982
1000
  );
983
1001
  var objectSchemaSchema = z.lazy(
@@ -1002,7 +1020,10 @@ var objectSchemaSchema = z.lazy(
1002
1020
  alert: alertLayoutSchema.optional(),
1003
1021
  media: mediaSchema.optional(),
1004
1022
  tags: z.array(z.string()).optional(),
1005
- format: z.string().optional()
1023
+ format: z.string().optional(),
1024
+ additionalText: z.string().optional(),
1025
+ supportingValues: supportingValuesSchema.optional(),
1026
+ inlineAlert: inlineAlertSchema.optional()
1006
1027
  })
1007
1028
  );
1008
1029
  var oneOfSchemaSchema = z.lazy(
@@ -1035,7 +1056,10 @@ var oneOfSchemaSchema = z.lazy(
1035
1056
  disabled: z.boolean().optional(),
1036
1057
  onChange: behaviorSchema.optional(),
1037
1058
  media: mediaSchema.optional(),
1038
- tags: z.array(z.string()).optional()
1059
+ tags: z.array(z.string()).optional(),
1060
+ additionalText: z.string().optional(),
1061
+ supportingValues: supportingValuesSchema.optional(),
1062
+ inlineAlert: inlineAlertSchema.optional()
1039
1063
  })
1040
1064
  );
1041
1065
  var stringSchemaSchema = z.lazy(
@@ -1083,7 +1107,10 @@ var stringSchemaSchema = z.lazy(
1083
1107
  suggestions: suggestionsSchema.optional(),
1084
1108
  onChange: behaviorSchema.optional(),
1085
1109
  media: mediaSchema.optional(),
1086
- tags: z.array(z.string()).optional()
1110
+ tags: z.array(z.string()).optional(),
1111
+ additionalText: z.string().optional(),
1112
+ supportingValues: supportingValuesSchema.optional(),
1113
+ inlineAlert: inlineAlertSchema.optional()
1087
1114
  })
1088
1115
  );
1089
1116
  var arraySchemaListSchema = z.lazy(
@@ -1112,7 +1139,10 @@ var arraySchemaListSchema = z.lazy(
1112
1139
  validationMessages: z.record(z.string()).optional(),
1113
1140
  disabled: z.boolean().optional(),
1114
1141
  media: mediaSchema.optional(),
1115
- tags: z.array(z.string()).optional()
1142
+ tags: z.array(z.string()).optional(),
1143
+ additionalText: z.string().optional(),
1144
+ supportingValues: supportingValuesSchema.optional(),
1145
+ inlineAlert: inlineAlertSchema.optional()
1116
1146
  })
1117
1147
  );
1118
1148
  var persistAsyncSchema = z.lazy(
@@ -1143,7 +1173,10 @@ var arraySchemaTupleSchema = z.lazy(
1143
1173
  validationAsync: validateAsyncSchema.optional(),
1144
1174
  alert: alertLayoutSchema.optional(),
1145
1175
  media: mediaSchema.optional(),
1146
- tags: z.array(z.string()).optional()
1176
+ tags: z.array(z.string()).optional(),
1177
+ additionalText: z.string().optional(),
1178
+ supportingValues: supportingValuesSchema.optional(),
1179
+ inlineAlert: inlineAlertSchema.optional()
1147
1180
  })
1148
1181
  );
1149
1182
  var pollingOnErrorSchema = z.lazy(
@@ -5,8 +5,8 @@ import type { PollingOnError } from './PollingOnError';
5
5
  * The client may continue to another step or end the flow.
6
6
  * ### Example
7
7
  * Given the step below, the client will start making requests to the specified URL every 5 seconds.
8
- * To progress the flow, the response should be a [FlowResponse] with the `X-DF-Response-Type` header set accordingly.
9
- * *Note that older clients only support [ActionResponseBody]*
8
+ * To progress the flow, the response should be a [com.wise.dynamicflow.responses.FlowResponse] with the `X-DF-Response-Type` header set accordingly.
9
+ * *Note that older clients only support [com.wise.dynamicflow.responses.action.ActionResponseBody]*
10
10
  * To continue Polling, the response should have a 2xx status code and an empty body. The client will continue to make requests until the flow progresses or [maxAttempts] is reached.
11
11
  * ```kt
12
12
  * Step.build {
@@ -17,16 +17,18 @@ import type { PollingOnError } from './PollingOnError';
17
17
  * timeout = 60
18
18
  * maxAttempts = 100
19
19
  * onError {
20
- * action {
21
- * exit = true
22
- * result = encodeToJsonElement(mapOf("exit-action-data" to "EXIT!!!"))
20
+ * behavior = ActionBehavior.build {
21
+ * action {
22
+ * exit = true
23
+ * result = encodeToJsonElement(mapOf("exit-action-data" to "EXIT!!!"))
24
+ * }
23
25
  * }
24
26
  * }
25
27
  * }
26
28
  * }
27
29
  * ```
28
30
  * #### Error handling
29
- * Given the above step, the action in the `onError` object is triggered if:
31
+ * Given the above step, the behaviour in the `onError` object is triggered if:
30
32
  * - the response status code is a failure (>=400).
31
33
  * - the number of attempts exceeds the specified `maxAttempts`
32
34
  * - the response body does not match the `X-DF-Response-Type` header provided
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Refreshes the current step with the behavior is triggered
2
+ * Refreshes the current step when the behavior is triggered. See [com.wise.dynamicflow.feature.RefreshOnChange] for more details.
3
3
  */
4
4
  export type RefreshBehavior = {
5
5
  /**
@@ -2,6 +2,7 @@ import type { JsonElement } from './JsonElement';
2
2
  import type { FormLayout as GeneratedFormLayout } from './layout/FormLayout';
3
3
  export type { Action } from './feature/Action';
4
4
  export type { Navigation } from './feature/Navigation';
5
+ export type { NavigationStackBehavior } from './feature/NavigationStackBehavior';
5
6
  export type { PersistAsync } from './feature/PersistAsync';
6
7
  export type { Polling } from './feature/Polling';
7
8
  export type { PollingOnError } from './feature/PollingOnError';
@@ -4,6 +4,8 @@ import type { Image } from '../misc/Image';
4
4
  import type { SummaryProvider } from '../feature/SummaryProvider';
5
5
  import type { AlertLayout } from '../layout/AlertLayout';
6
6
  import type { Media } from '../misc/media/Media';
7
+ import type { SupportingValues } from '../misc/SupportingValues';
8
+ import type { InlineAlert } from '../misc/InlineAlert';
7
9
  /**
8
10
  * A schema which merges the value of its child schemas.
9
11
  * Use an allOf schema to represent a form section where the submission payload is the result of merging the allOf's child schemas.
@@ -82,4 +84,17 @@ export type AllOfSchema = {
82
84
  * An optional list of identifiers used to configure renderers.
83
85
  */
84
86
  tags?: string[];
87
+ /**
88
+ * Additional information to be displayed to the user.
89
+ */
90
+ additionalText?: string;
91
+ /**
92
+ * An object containing two strings representing two user-facing values.
93
+ * One being clearly more important than the other.
94
+ */
95
+ supportingValues?: SupportingValues;
96
+ /**
97
+ * An alert that will be displayed inline with the item.
98
+ */
99
+ inlineAlert?: InlineAlert;
85
100
  };
@@ -6,6 +6,8 @@ import type { PersistAsync } from '../feature/PersistAsync';
6
6
  import type { ValidateAsync } from '../feature/ValidateAsync';
7
7
  import type { AlertLayout } from '../layout/AlertLayout';
8
8
  import type { Media } from '../misc/media/Media';
9
+ import type { SupportingValues } from '../misc/SupportingValues';
10
+ import type { InlineAlert } from '../misc/InlineAlert';
9
11
  /**
10
12
  * A variable length array where each item matches the items JSON schema. This can be used, for example, to create a
11
13
  * repeating form section, or multi-file upload.
@@ -121,4 +123,17 @@ export type ArraySchemaList = {
121
123
  * An optional list of identifiers used to configure renderers.
122
124
  */
123
125
  tags?: string[];
126
+ /**
127
+ * Additional information to be displayed to the user.
128
+ */
129
+ additionalText?: string;
130
+ /**
131
+ * An object containing two strings representing two user-facing values.
132
+ * One being clearly more important than the other.
133
+ */
134
+ supportingValues?: SupportingValues;
135
+ /**
136
+ * An alert that will be displayed inline with the item.
137
+ */
138
+ inlineAlert?: InlineAlert;
124
139
  };
@@ -6,6 +6,8 @@ import type { PersistAsync } from '../feature/PersistAsync';
6
6
  import type { ValidateAsync } from '../feature/ValidateAsync';
7
7
  import type { AlertLayout } from '../layout/AlertLayout';
8
8
  import type { Media } from '../misc/media/Media';
9
+ import type { SupportingValues } from '../misc/SupportingValues';
10
+ import type { InlineAlert } from '../misc/InlineAlert';
9
11
  /**
10
12
  * A fixed-length array where each schema represents the data at the corresponding element in the array.
11
13
  * As ordering needs to remain consistent, the submission value will include null values where applicable.
@@ -90,4 +92,17 @@ export type ArraySchemaTuple = {
90
92
  * An optional list of identifiers used to configure renderers.
91
93
  */
92
94
  tags?: string[];
95
+ /**
96
+ * Additional information to be displayed to the user.
97
+ */
98
+ additionalText?: string;
99
+ /**
100
+ * An object containing two strings representing two user-facing values.
101
+ * One being clearly more important than the other.
102
+ */
103
+ supportingValues?: SupportingValues;
104
+ /**
105
+ * An alert that will be displayed inline with the item.
106
+ */
107
+ inlineAlert?: InlineAlert;
93
108
  };
@@ -6,6 +6,8 @@ import type { AlertLayout } from '../layout/AlertLayout';
6
6
  import type { JsonElement } from '../JsonElement';
7
7
  import type { UploadSource } from '../feature/UploadSource';
8
8
  import type { Media } from '../misc/media/Media';
9
+ import type { SupportingValues } from '../misc/SupportingValues';
10
+ import type { InlineAlert } from '../misc/InlineAlert';
9
11
  /**
10
12
  * Represents a binary data submission using Form Data rather than JSON.
11
13
  * It can only be used as the schema of a [com.wise.dynamicflow.feature.PersistAsync] configuration.
@@ -110,4 +112,17 @@ export type BlobSchema = {
110
112
  * An optional list of identifiers used to configure renderers.
111
113
  */
112
114
  tags?: string[];
115
+ /**
116
+ * Additional information to be displayed to the user.
117
+ */
118
+ additionalText?: string;
119
+ /**
120
+ * An object containing two strings representing two user-facing values.
121
+ * One being clearly more important than the other.
122
+ */
123
+ supportingValues?: SupportingValues;
124
+ /**
125
+ * An alert that will be displayed inline with the item.
126
+ */
127
+ inlineAlert?: InlineAlert;
113
128
  };
@@ -7,6 +7,8 @@ import type { AlertLayout } from '../layout/AlertLayout';
7
7
  import type { Help } from '../feature/Help';
8
8
  import type { Behavior } from '../feature/Behavior';
9
9
  import type { Media } from '../misc/media/Media';
10
+ import type { SupportingValues } from '../misc/SupportingValues';
11
+ import type { InlineAlert } from '../misc/InlineAlert';
10
12
  /**
11
13
  * Represents a boolean value in the submission.
12
14
  * The submission value is either `true` or `false`, defaulting to `false`.
@@ -143,4 +145,17 @@ export type BooleanSchema = {
143
145
  * An optional list of identifiers used to configure renderers.
144
146
  */
145
147
  tags?: string[];
148
+ /**
149
+ * Additional information to be displayed to the user.
150
+ */
151
+ additionalText?: string;
152
+ /**
153
+ * An object containing two strings representing two user-facing values.
154
+ * One being clearly more important than the other.
155
+ */
156
+ supportingValues?: SupportingValues;
157
+ /**
158
+ * An alert that will be displayed inline with the item.
159
+ */
160
+ inlineAlert?: InlineAlert;
146
161
  };
@@ -5,6 +5,8 @@ import type { SummaryProvider } from '../feature/SummaryProvider';
5
5
  import type { Media } from '../misc/media/Media';
6
6
  import type { AlertLayout } from '../layout/AlertLayout';
7
7
  import type { Layout } from '../layout/Layout';
8
+ import type { SupportingValues } from '../misc/SupportingValues';
9
+ import type { InlineAlert } from '../misc/InlineAlert';
8
10
  /**
9
11
  * Represents a constant value in the submission.
10
12
  */
@@ -19,10 +21,6 @@ export type ConstSchema = {
19
21
  */
20
22
  control?: string;
21
23
  /**
22
- * An optional list of identifiers used to configure renderers.
23
- */
24
- tags?: string[];
25
- /**
26
24
  * @deprecated Please use nested oneOf schemas instead.
27
25
  */
28
26
  promoted?: boolean;
@@ -84,4 +82,21 @@ export type ConstSchema = {
84
82
  * An array of layouts representing the schema.
85
83
  */
86
84
  layout?: Layout[];
85
+ /**
86
+ * An optional list of identifiers used to configure renderers.
87
+ */
88
+ tags?: string[];
89
+ /**
90
+ * Additional information to be displayed to the user.
91
+ */
92
+ additionalText?: string;
93
+ /**
94
+ * An object containing two strings representing two user-facing values.
95
+ * One being clearly more important than the other.
96
+ */
97
+ supportingValues?: SupportingValues;
98
+ /**
99
+ * An alert that will be displayed inline with the item.
100
+ */
101
+ inlineAlert?: InlineAlert;
87
102
  };
@@ -8,6 +8,8 @@ import type { AutocompleteToken } from '../misc/AutocompleteToken';
8
8
  import type { Help } from '../feature/Help';
9
9
  import type { Behavior } from '../feature/Behavior';
10
10
  import type { Media } from '../misc/media/Media';
11
+ import type { SupportingValues } from '../misc/SupportingValues';
12
+ import type { InlineAlert } from '../misc/InlineAlert';
11
13
  /**
12
14
  * Represents a numeric value which must be a whole number. For floating point numbers, use a [NumberSchema] instead.
13
15
  * When not provided, the submission value is `null`.
@@ -169,4 +171,17 @@ export type IntegerSchema = {
169
171
  * An optional list of identifiers used to configure renderers.
170
172
  */
171
173
  tags?: string[];
174
+ /**
175
+ * Additional information to be displayed to the user.
176
+ */
177
+ additionalText?: string;
178
+ /**
179
+ * An object containing two strings representing two user-facing values.
180
+ * One being clearly more important than the other.
181
+ */
182
+ supportingValues?: SupportingValues;
183
+ /**
184
+ * An alert that will be displayed inline with the item.
185
+ */
186
+ inlineAlert?: InlineAlert;
172
187
  };
@@ -8,6 +8,8 @@ import type { AutocompleteToken } from '../misc/AutocompleteToken';
8
8
  import type { Help } from '../feature/Help';
9
9
  import type { Behavior } from '../feature/Behavior';
10
10
  import type { Media } from '../misc/media/Media';
11
+ import type { SupportingValues } from '../misc/SupportingValues';
12
+ import type { InlineAlert } from '../misc/InlineAlert';
11
13
  /**
12
14
  * Represents any numeric value - either an integer or a floating point number.
13
15
  * If the value should always be an integer, consider using an [IntegerSchema] instead.
@@ -170,4 +172,17 @@ export type NumberSchema = {
170
172
  * An optional list of identifiers used to configure renderers.
171
173
  */
172
174
  tags?: string[];
175
+ /**
176
+ * Additional information to be displayed to the user.
177
+ */
178
+ additionalText?: string;
179
+ /**
180
+ * An object containing two strings representing two user-facing values.
181
+ * One being clearly more important than the other.
182
+ */
183
+ supportingValues?: SupportingValues;
184
+ /**
185
+ * An alert that will be displayed inline with the item.
186
+ */
187
+ inlineAlert?: InlineAlert;
173
188
  };
@@ -5,6 +5,8 @@ import type { Image } from '../misc/Image';
5
5
  import type { SummaryProvider } from '../feature/SummaryProvider';
6
6
  import type { AlertLayout } from '../layout/AlertLayout';
7
7
  import type { Media } from '../misc/media/Media';
8
+ import type { SupportingValues } from '../misc/SupportingValues';
9
+ import type { InlineAlert } from '../misc/InlineAlert';
8
10
  /**
9
11
  * Represents an object value in the submission.
10
12
  * The value for submission includes only non-null property values. If all property values are null, the value is an empty object.
@@ -106,4 +108,17 @@ export type ObjectSchema = {
106
108
  * The type of data the object represents.
107
109
  */
108
110
  format?: string;
111
+ /**
112
+ * Additional information to be displayed to the user.
113
+ */
114
+ additionalText?: string;
115
+ /**
116
+ * An object containing two strings representing two user-facing values.
117
+ * One being clearly more important than the other.
118
+ */
119
+ supportingValues?: SupportingValues;
120
+ /**
121
+ * An alert that will be displayed inline with the item.
122
+ */
123
+ inlineAlert?: InlineAlert;
109
124
  };
@@ -8,6 +8,8 @@ import type { Help } from '../feature/Help';
8
8
  import type { AutocompleteToken } from '../misc/AutocompleteToken';
9
9
  import type { Behavior } from '../feature/Behavior';
10
10
  import type { Media } from '../misc/media/Media';
11
+ import type { SupportingValues } from '../misc/SupportingValues';
12
+ import type { InlineAlert } from '../misc/InlineAlert';
11
13
  /**
12
14
  * Offers a choice between a number of child schemas.
13
15
  * Use a oneOf schema to represent either the selection of one of many constant values (e.g. a select box or dropdown)
@@ -223,4 +225,17 @@ export type OneOfSchema = {
223
225
  * An optional list of identifiers used to configure renderers.
224
226
  */
225
227
  tags?: string[];
228
+ /**
229
+ * Additional information to be displayed to the user.
230
+ */
231
+ additionalText?: string;
232
+ /**
233
+ * An object containing two strings representing two user-facing values.
234
+ * One being clearly more important than the other.
235
+ */
236
+ supportingValues?: SupportingValues;
237
+ /**
238
+ * An alert that will be displayed inline with the item.
239
+ */
240
+ inlineAlert?: InlineAlert;
226
241
  };
@@ -13,6 +13,8 @@ import type { Help } from '../feature/Help';
13
13
  import type { Suggestions } from '../feature/Suggestions';
14
14
  import type { Behavior } from '../feature/Behavior';
15
15
  import type { Media } from '../misc/media/Media';
16
+ import type { SupportingValues } from '../misc/SupportingValues';
17
+ import type { InlineAlert } from '../misc/InlineAlert';
16
18
  /**
17
19
  * Represents a string value in the submission.
18
20
  * This could be used for standard text input, or a format can be provided
@@ -232,4 +234,17 @@ export type StringSchema = {
232
234
  * An optional list of identifiers used to configure renderers.
233
235
  */
234
236
  tags?: string[];
237
+ /**
238
+ * Additional information to be displayed to the user.
239
+ */
240
+ additionalText?: string;
241
+ /**
242
+ * An object containing two strings representing two user-facing values.
243
+ * One being clearly more important than the other.
244
+ */
245
+ supportingValues?: SupportingValues;
246
+ /**
247
+ * An alert that will be displayed inline with the item.
248
+ */
249
+ inlineAlert?: InlineAlert;
235
250
  };
@@ -88,7 +88,7 @@ export type Step = {
88
88
  */
89
89
  navigation?: Navigation;
90
90
  /**
91
- * The URL to use to fetch an updated step when the value of a schema marked refreshStepOnChange is updated.
91
+ * The URL to use to fetch an updated step when a [com.wise.dynamicflow.feature.RefreshBehavior] is triggered, or when the value of a schema marked 'refreshStepOnChange' is updated.
92
92
  */
93
93
  refreshUrl?: string;
94
94
  /**
@@ -1,6 +1,10 @@
1
+ import { InlineAlert, SupportingValues } from './constants';
1
2
  import { BaseInputRendererProps } from './BaseInputRendererProps';
2
3
  export type CheckboxInputRendererProps = BaseInputRendererProps & {
3
4
  type: 'input-checkbox';
5
+ additionalText?: string;
6
+ inlineAlert?: InlineAlert;
7
+ supportingValues?: SupportingValues;
4
8
  value: boolean;
5
9
  onChange: (value: boolean) => void;
6
10
  };