@wise/dynamic-flow-types 3.17.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.
Files changed (31) hide show
  1. package/build/main.js +50 -14
  2. package/build/main.mjs +50 -14
  3. package/build/next/feature/Polling.d.ts +8 -6
  4. package/build/next/feature/RefreshBehavior.d.ts +1 -1
  5. package/build/next/index.d.ts +1 -0
  6. package/build/next/layout/MarkdownLayout.d.ts +4 -0
  7. package/build/next/layout/ParagraphLayout.d.ts +4 -0
  8. package/build/next/schema/AllOfSchema.d.ts +15 -0
  9. package/build/next/schema/ArraySchemaList.d.ts +15 -0
  10. package/build/next/schema/ArraySchemaTuple.d.ts +15 -0
  11. package/build/next/schema/BlobSchema.d.ts +15 -0
  12. package/build/next/schema/BooleanSchema.d.ts +15 -0
  13. package/build/next/schema/ConstSchema.d.ts +19 -4
  14. package/build/next/schema/IntegerSchema.d.ts +15 -0
  15. package/build/next/schema/NumberSchema.d.ts +15 -0
  16. package/build/next/schema/ObjectSchema.d.ts +15 -0
  17. package/build/next/schema/OneOfSchema.d.ts +15 -0
  18. package/build/next/schema/StringSchema.d.ts +15 -0
  19. package/build/next/step/Step.d.ts +1 -1
  20. package/build/renderers/CheckboxInputRendererProps.d.ts +4 -0
  21. package/build/renderers/DecisionRendererProps.d.ts +0 -3
  22. package/build/renderers/FormSectionRendererProps.d.ts +5 -5
  23. package/build/renderers/MarkdownRendererProps.d.ts +2 -1
  24. package/build/renderers/MoneyInputRendererProps.d.ts +29 -0
  25. package/build/renderers/ParagraphRendererProps.d.ts +2 -1
  26. package/build/renderers/RendererProps.d.ts +3 -2
  27. package/build/renderers/SelectInputRendererProps.d.ts +7 -2
  28. package/build/renderers/index.d.ts +1 -0
  29. package/build/zod/schemas.d.ts +6 -0
  30. package/build/zod/schemas.ts +886 -851
  31. package/package.json +1 -1
package/build/main.js CHANGED
@@ -181,7 +181,8 @@ var paragraphLayoutSchema = import_zod.z.object({
181
181
  control: import_zod.z.string().optional(),
182
182
  margin: sizeSchema.optional(),
183
183
  analyticsId: import_zod.z.string().optional(),
184
- tags: import_zod.z.array(import_zod.z.string()).optional()
184
+ tags: import_zod.z.array(import_zod.z.string()).optional(),
185
+ size: sizeSchema.optional()
185
186
  });
186
187
  var dividerLayoutSchema = import_zod.z.object({
187
188
  type: import_zod.z.literal("divider"),
@@ -285,7 +286,8 @@ var markdownLayoutSchema = import_zod.z.object({
285
286
  control: import_zod.z.string().optional(),
286
287
  margin: sizeSchema.optional(),
287
288
  analyticsId: import_zod.z.string().optional(),
288
- tags: import_zod.z.array(import_zod.z.string()).optional()
289
+ tags: import_zod.z.array(import_zod.z.string()).optional(),
290
+ size: sizeSchema.optional()
289
291
  });
290
292
  var progressLayoutSchema = import_zod.z.object({
291
293
  type: import_zod.z.literal("progress"),
@@ -850,7 +852,10 @@ var allOfSchemaSchema = import_zod.z.lazy(
850
852
  analyticsId: import_zod.z.string().optional(),
851
853
  alert: alertLayoutSchema.optional(),
852
854
  media: mediaSchema.optional(),
853
- 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()
854
859
  })
855
860
  );
856
861
  var arraySchemaSchema = import_zod.z.lazy(
@@ -879,7 +884,10 @@ var blobSchemaSchema = import_zod.z.lazy(
879
884
  source: uploadSourceSchema.optional(),
880
885
  disabled: import_zod.z.boolean().optional(),
881
886
  media: mediaSchema.optional(),
882
- 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()
883
891
  })
884
892
  );
885
893
  var booleanSchemaSchema = import_zod.z.lazy(
@@ -910,14 +918,16 @@ var booleanSchemaSchema = import_zod.z.lazy(
910
918
  help: helpSchema.optional(),
911
919
  onChange: behaviorSchema.optional(),
912
920
  media: mediaSchema.optional(),
913
- 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()
914
925
  })
915
926
  );
916
927
  var constSchemaSchema = import_zod.z.lazy(
917
928
  () => import_zod.z.object({
918
929
  hidden: import_zod.z.boolean().optional(),
919
930
  control: import_zod.z.string().optional(),
920
- tags: import_zod.z.array(import_zod.z.string()).optional(),
921
931
  promoted: import_zod.z.boolean().optional(),
922
932
  $id: import_zod.z.string().optional(),
923
933
  const: jsonElementSchema,
@@ -931,7 +941,11 @@ var constSchemaSchema = import_zod.z.lazy(
931
941
  disabled: import_zod.z.boolean().optional(),
932
942
  media: mediaSchema.optional(),
933
943
  alert: alertLayoutSchema.optional(),
934
- 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()
935
949
  })
936
950
  );
937
951
  var integerSchemaSchema = import_zod.z.lazy(
@@ -967,7 +981,10 @@ var integerSchemaSchema = import_zod.z.lazy(
967
981
  help: helpSchema.optional(),
968
982
  onChange: behaviorSchema.optional(),
969
983
  media: mediaSchema.optional(),
970
- 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()
971
988
  })
972
989
  );
973
990
  var numberSchemaSchema = import_zod.z.lazy(
@@ -1003,7 +1020,10 @@ var numberSchemaSchema = import_zod.z.lazy(
1003
1020
  help: helpSchema.optional(),
1004
1021
  onChange: behaviorSchema.optional(),
1005
1022
  media: mediaSchema.optional(),
1006
- 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()
1007
1027
  })
1008
1028
  );
1009
1029
  var objectSchemaSchema = import_zod.z.lazy(
@@ -1027,7 +1047,11 @@ var objectSchemaSchema = import_zod.z.lazy(
1027
1047
  analyticsId: import_zod.z.string().optional(),
1028
1048
  alert: alertLayoutSchema.optional(),
1029
1049
  media: mediaSchema.optional(),
1030
- tags: import_zod.z.array(import_zod.z.string()).optional()
1050
+ tags: import_zod.z.array(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()
1031
1055
  })
1032
1056
  );
1033
1057
  var oneOfSchemaSchema = import_zod.z.lazy(
@@ -1060,7 +1084,10 @@ var oneOfSchemaSchema = import_zod.z.lazy(
1060
1084
  disabled: import_zod.z.boolean().optional(),
1061
1085
  onChange: behaviorSchema.optional(),
1062
1086
  media: mediaSchema.optional(),
1063
- 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()
1064
1091
  })
1065
1092
  );
1066
1093
  var stringSchemaSchema = import_zod.z.lazy(
@@ -1108,7 +1135,10 @@ var stringSchemaSchema = import_zod.z.lazy(
1108
1135
  suggestions: suggestionsSchema.optional(),
1109
1136
  onChange: behaviorSchema.optional(),
1110
1137
  media: mediaSchema.optional(),
1111
- 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()
1112
1142
  })
1113
1143
  );
1114
1144
  var arraySchemaListSchema = import_zod.z.lazy(
@@ -1137,7 +1167,10 @@ var arraySchemaListSchema = import_zod.z.lazy(
1137
1167
  validationMessages: import_zod.z.record(import_zod.z.string()).optional(),
1138
1168
  disabled: import_zod.z.boolean().optional(),
1139
1169
  media: mediaSchema.optional(),
1140
- 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()
1141
1174
  })
1142
1175
  );
1143
1176
  var persistAsyncSchema = import_zod.z.lazy(
@@ -1168,7 +1201,10 @@ var arraySchemaTupleSchema = import_zod.z.lazy(
1168
1201
  validationAsync: validateAsyncSchema.optional(),
1169
1202
  alert: alertLayoutSchema.optional(),
1170
1203
  media: mediaSchema.optional(),
1171
- 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()
1172
1208
  })
1173
1209
  );
1174
1210
  var pollingOnErrorSchema = import_zod.z.lazy(
package/build/main.mjs CHANGED
@@ -153,7 +153,8 @@ var paragraphLayoutSchema = z.object({
153
153
  control: z.string().optional(),
154
154
  margin: sizeSchema.optional(),
155
155
  analyticsId: z.string().optional(),
156
- tags: z.array(z.string()).optional()
156
+ tags: z.array(z.string()).optional(),
157
+ size: sizeSchema.optional()
157
158
  });
158
159
  var dividerLayoutSchema = z.object({
159
160
  type: z.literal("divider"),
@@ -257,7 +258,8 @@ var markdownLayoutSchema = z.object({
257
258
  control: z.string().optional(),
258
259
  margin: sizeSchema.optional(),
259
260
  analyticsId: z.string().optional(),
260
- tags: z.array(z.string()).optional()
261
+ tags: z.array(z.string()).optional(),
262
+ size: sizeSchema.optional()
261
263
  });
262
264
  var progressLayoutSchema = z.object({
263
265
  type: z.literal("progress"),
@@ -822,7 +824,10 @@ var allOfSchemaSchema = z.lazy(
822
824
  analyticsId: z.string().optional(),
823
825
  alert: alertLayoutSchema.optional(),
824
826
  media: mediaSchema.optional(),
825
- 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()
826
831
  })
827
832
  );
828
833
  var arraySchemaSchema = z.lazy(
@@ -851,7 +856,10 @@ var blobSchemaSchema = z.lazy(
851
856
  source: uploadSourceSchema.optional(),
852
857
  disabled: z.boolean().optional(),
853
858
  media: mediaSchema.optional(),
854
- 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()
855
863
  })
856
864
  );
857
865
  var booleanSchemaSchema = z.lazy(
@@ -882,14 +890,16 @@ var booleanSchemaSchema = z.lazy(
882
890
  help: helpSchema.optional(),
883
891
  onChange: behaviorSchema.optional(),
884
892
  media: mediaSchema.optional(),
885
- 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()
886
897
  })
887
898
  );
888
899
  var constSchemaSchema = z.lazy(
889
900
  () => z.object({
890
901
  hidden: z.boolean().optional(),
891
902
  control: z.string().optional(),
892
- tags: z.array(z.string()).optional(),
893
903
  promoted: z.boolean().optional(),
894
904
  $id: z.string().optional(),
895
905
  const: jsonElementSchema,
@@ -903,7 +913,11 @@ var constSchemaSchema = z.lazy(
903
913
  disabled: z.boolean().optional(),
904
914
  media: mediaSchema.optional(),
905
915
  alert: alertLayoutSchema.optional(),
906
- 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()
907
921
  })
908
922
  );
909
923
  var integerSchemaSchema = z.lazy(
@@ -939,7 +953,10 @@ var integerSchemaSchema = z.lazy(
939
953
  help: helpSchema.optional(),
940
954
  onChange: behaviorSchema.optional(),
941
955
  media: mediaSchema.optional(),
942
- 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()
943
960
  })
944
961
  );
945
962
  var numberSchemaSchema = z.lazy(
@@ -975,7 +992,10 @@ var numberSchemaSchema = z.lazy(
975
992
  help: helpSchema.optional(),
976
993
  onChange: behaviorSchema.optional(),
977
994
  media: mediaSchema.optional(),
978
- 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()
979
999
  })
980
1000
  );
981
1001
  var objectSchemaSchema = z.lazy(
@@ -999,7 +1019,11 @@ var objectSchemaSchema = z.lazy(
999
1019
  analyticsId: z.string().optional(),
1000
1020
  alert: alertLayoutSchema.optional(),
1001
1021
  media: mediaSchema.optional(),
1002
- tags: z.array(z.string()).optional()
1022
+ tags: z.array(z.string()).optional(),
1023
+ format: z.string().optional(),
1024
+ additionalText: z.string().optional(),
1025
+ supportingValues: supportingValuesSchema.optional(),
1026
+ inlineAlert: inlineAlertSchema.optional()
1003
1027
  })
1004
1028
  );
1005
1029
  var oneOfSchemaSchema = z.lazy(
@@ -1032,7 +1056,10 @@ var oneOfSchemaSchema = z.lazy(
1032
1056
  disabled: z.boolean().optional(),
1033
1057
  onChange: behaviorSchema.optional(),
1034
1058
  media: mediaSchema.optional(),
1035
- 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()
1036
1063
  })
1037
1064
  );
1038
1065
  var stringSchemaSchema = z.lazy(
@@ -1080,7 +1107,10 @@ var stringSchemaSchema = z.lazy(
1080
1107
  suggestions: suggestionsSchema.optional(),
1081
1108
  onChange: behaviorSchema.optional(),
1082
1109
  media: mediaSchema.optional(),
1083
- 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()
1084
1114
  })
1085
1115
  );
1086
1116
  var arraySchemaListSchema = z.lazy(
@@ -1109,7 +1139,10 @@ var arraySchemaListSchema = z.lazy(
1109
1139
  validationMessages: z.record(z.string()).optional(),
1110
1140
  disabled: z.boolean().optional(),
1111
1141
  media: mediaSchema.optional(),
1112
- 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()
1113
1146
  })
1114
1147
  );
1115
1148
  var persistAsyncSchema = z.lazy(
@@ -1140,7 +1173,10 @@ var arraySchemaTupleSchema = z.lazy(
1140
1173
  validationAsync: validateAsyncSchema.optional(),
1141
1174
  alert: alertLayoutSchema.optional(),
1142
1175
  media: mediaSchema.optional(),
1143
- 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()
1144
1180
  })
1145
1181
  );
1146
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';
@@ -39,4 +39,8 @@ export type MarkdownLayout = {
39
39
  * An optional list of identifiers used to configure renderers.
40
40
  */
41
41
  tags?: string[];
42
+ /**
43
+ * The size of the content. Default to `md`.
44
+ */
45
+ size?: Size;
42
46
  };
@@ -32,4 +32,8 @@ export type ParagraphLayout = {
32
32
  * An optional list of identifiers used to configure renderers.
33
33
  */
34
34
  tags?: string[];
35
+ /**
36
+ * The size of the content. Default to `md`.
37
+ */
38
+ size?: Size;
35
39
  };
@@ -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
  };