@wise/dynamic-flow-types 4.14.0-experimental-a850677 → 4.14.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 (121) hide show
  1. package/build/renderers/RendererProps.d.ts +4 -5
  2. package/build/renderers/RendererProps.d.ts.map +1 -1
  3. package/build/renderers/SubflowRendererProps.d.ts +17 -7
  4. package/build/renderers/SubflowRendererProps.d.ts.map +1 -1
  5. package/build/renderers/index.d.ts +12 -4
  6. package/build/renderers/index.d.ts.map +1 -1
  7. package/build/spec/feature/Action.d.ts +6 -6
  8. package/build/spec/feature/ActionBehavior.d.ts +1 -0
  9. package/build/spec/feature/ActionBehavior.d.ts.map +1 -1
  10. package/build/spec/feature/CopyBehavior.d.ts +1 -0
  11. package/build/spec/feature/CopyBehavior.d.ts.map +1 -1
  12. package/build/spec/feature/DismissBehavior.d.ts +1 -0
  13. package/build/spec/feature/DismissBehavior.d.ts.map +1 -1
  14. package/build/spec/feature/External.d.ts +1 -1
  15. package/build/spec/feature/LinkBehavior.d.ts +1 -0
  16. package/build/spec/feature/LinkBehavior.d.ts.map +1 -1
  17. package/build/spec/feature/ModalBehavior.d.ts +1 -0
  18. package/build/spec/feature/ModalBehavior.d.ts.map +1 -1
  19. package/build/spec/feature/NavigationBackBehavior.d.ts +8 -1
  20. package/build/spec/feature/NavigationBackBehavior.d.ts.map +1 -1
  21. package/build/spec/feature/NavigationStackBehavior.d.ts +4 -0
  22. package/build/spec/feature/NavigationStackBehavior.d.ts.map +1 -1
  23. package/build/spec/feature/PersistAsync.d.ts +1 -0
  24. package/build/spec/feature/PersistAsync.d.ts.map +1 -1
  25. package/build/spec/feature/Polling.d.ts +2 -2
  26. package/build/spec/feature/RefreshBehavior.d.ts +1 -0
  27. package/build/spec/feature/RefreshBehavior.d.ts.map +1 -1
  28. package/build/spec/feature/SubflowBehavior.d.ts +1 -1
  29. package/build/spec/feature/ValidateAsync.d.ts +1 -0
  30. package/build/spec/feature/ValidateAsync.d.ts.map +1 -1
  31. package/build/spec/feature/subflow/DynamicLaunchConfig.d.ts +1 -1
  32. package/build/spec/feature/subflow/LaunchConfig.d.ts +3 -2
  33. package/build/spec/feature/subflow/LaunchConfig.d.ts.map +1 -1
  34. package/build/spec/feature/subflow/NativeLaunchConfig.d.ts +22 -0
  35. package/build/spec/feature/subflow/NativeLaunchConfig.d.ts.map +1 -0
  36. package/build/spec/index.d.ts +0 -1
  37. package/build/spec/index.d.ts.map +1 -1
  38. package/build/spec/layout/AlertLayout.d.ts +5 -0
  39. package/build/spec/layout/AlertLayout.d.ts.map +1 -1
  40. package/build/spec/layout/AlertLayoutCallToAction.d.ts +2 -2
  41. package/build/spec/layout/BoxLayout.d.ts +1 -0
  42. package/build/spec/layout/BoxLayout.d.ts.map +1 -1
  43. package/build/spec/layout/ButtonLayout.d.ts +1 -1
  44. package/build/spec/layout/ColumnsLayout.d.ts +1 -0
  45. package/build/spec/layout/ColumnsLayout.d.ts.map +1 -1
  46. package/build/spec/layout/DecisionLayout.d.ts +8 -1
  47. package/build/spec/layout/DecisionLayout.d.ts.map +1 -1
  48. package/build/spec/layout/DividerLayout.d.ts +1 -0
  49. package/build/spec/layout/DividerLayout.d.ts.map +1 -1
  50. package/build/spec/layout/HeadingLayout.d.ts +1 -0
  51. package/build/spec/layout/HeadingLayout.d.ts.map +1 -1
  52. package/build/spec/layout/ImageLayout.d.ts +2 -0
  53. package/build/spec/layout/ImageLayout.d.ts.map +1 -1
  54. package/build/spec/layout/InstructionsLayout.d.ts +7 -0
  55. package/build/spec/layout/InstructionsLayout.d.ts.map +1 -1
  56. package/build/spec/layout/ItemCallToAction.d.ts +2 -2
  57. package/build/spec/layout/Layout.d.ts +3 -4
  58. package/build/spec/layout/Layout.d.ts.map +1 -1
  59. package/build/spec/layout/ListLayout.d.ts +7 -0
  60. package/build/spec/layout/ListLayout.d.ts.map +1 -1
  61. package/build/spec/layout/ListLayoutCallToAction.d.ts +1 -1
  62. package/build/spec/layout/LoadingIndicatorLayout.d.ts +1 -0
  63. package/build/spec/layout/LoadingIndicatorLayout.d.ts.map +1 -1
  64. package/build/spec/layout/MarkdownLayout.d.ts +1 -0
  65. package/build/spec/layout/MarkdownLayout.d.ts.map +1 -1
  66. package/build/spec/layout/MediaLayout.d.ts +1 -1
  67. package/build/spec/layout/ModalLayout.d.ts +5 -0
  68. package/build/spec/layout/ModalLayout.d.ts.map +1 -1
  69. package/build/spec/layout/ParagraphLayout.d.ts +1 -0
  70. package/build/spec/layout/ParagraphLayout.d.ts.map +1 -1
  71. package/build/spec/layout/ProgressLayout.d.ts +6 -0
  72. package/build/spec/layout/ProgressLayout.d.ts.map +1 -1
  73. package/build/spec/layout/ReviewLayout.d.ts +8 -0
  74. package/build/spec/layout/ReviewLayout.d.ts.map +1 -1
  75. package/build/spec/layout/ReviewLayoutCallToAction.d.ts +1 -1
  76. package/build/spec/layout/ReviewLayoutField.d.ts +1 -1
  77. package/build/spec/layout/SearchLayout.d.ts +6 -1
  78. package/build/spec/layout/SearchLayout.d.ts.map +1 -1
  79. package/build/spec/layout/SectionLayout.d.ts +5 -0
  80. package/build/spec/layout/SectionLayout.d.ts.map +1 -1
  81. package/build/spec/layout/SectionLayoutCallToAction.d.ts +1 -1
  82. package/build/spec/layout/StatusListLayout.d.ts +5 -0
  83. package/build/spec/layout/StatusListLayout.d.ts.map +1 -1
  84. package/build/spec/layout/TabsLayout.d.ts +1 -0
  85. package/build/spec/layout/TabsLayout.d.ts.map +1 -1
  86. package/build/spec/layout/UpsellLayout.d.ts +5 -0
  87. package/build/spec/layout/UpsellLayout.d.ts.map +1 -1
  88. package/build/spec/layout/UpsellLayoutCallToAction.d.ts +2 -2
  89. package/build/spec/main.js +11 -89
  90. package/build/spec/main.mjs +11 -89
  91. package/build/spec/responses/NoOpResponseBody.d.ts +4 -1
  92. package/build/spec/responses/NoOpResponseBody.d.ts.map +1 -1
  93. package/build/spec/responses/search/SearchInitialLayoutConfig.d.ts +1 -1
  94. package/build/spec/responses/subflow/SubflowResponseBody.d.ts +2 -2
  95. package/build/spec/schema/ArraySchema.d.ts +1 -0
  96. package/build/spec/schema/ArraySchema.d.ts.map +1 -1
  97. package/build/spec/schema/BlobSchema.d.ts +1 -0
  98. package/build/spec/schema/BlobSchema.d.ts.map +1 -1
  99. package/build/spec/schema/BooleanSchema.d.ts +1 -0
  100. package/build/spec/schema/BooleanSchema.d.ts.map +1 -1
  101. package/build/spec/schema/IntegerSchema.d.ts +1 -0
  102. package/build/spec/schema/IntegerSchema.d.ts.map +1 -1
  103. package/build/spec/schema/NumberSchema.d.ts +1 -0
  104. package/build/spec/schema/NumberSchema.d.ts.map +1 -1
  105. package/build/spec/schema/ObjectSchema.d.ts +1 -0
  106. package/build/spec/schema/ObjectSchema.d.ts.map +1 -1
  107. package/build/spec/schema/OneOfSchema.d.ts +15 -3
  108. package/build/spec/schema/OneOfSchema.d.ts.map +1 -1
  109. package/build/spec/schema/StringSchema.d.ts +20 -0
  110. package/build/spec/schema/StringSchema.d.ts.map +1 -1
  111. package/build/spec/step/Step.d.ts +14 -1
  112. package/build/spec/step/Step.d.ts.map +1 -1
  113. package/build/tsconfig.tsbuildinfo +1 -1
  114. package/build/zod/schemas.d.ts +85 -120
  115. package/build/zod/schemas.d.ts.map +1 -1
  116. package/build/zod/schemas.ts +7 -98
  117. package/package.json +1 -1
  118. package/build/renderers/CollectionRendererProps.d.ts +0 -59
  119. package/build/renderers/CollectionRendererProps.d.ts.map +0 -1
  120. package/build/spec/layout/CollectionLayout.d.ts +0 -85
  121. package/build/spec/layout/CollectionLayout.d.ts.map +0 -1
@@ -1 +1 @@
1
- {"version":3,"file":"ColumnsLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/ColumnsLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAC5D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;;EAGE;AACF,MAAM,MAAM,aAAa,GAAG;IACxB;;MAEE;IACF,IAAI,EAAE,SAAS,CAAC;IAChB;;MAEE;IACF,IAAI,EAAE,MAAM,EAAE,CAAC;IACf;;MAEE;IACF,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB;;MAEE;IACF,IAAI,CAAC,EAAE,iBAAiB,CAAC;IACzB;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"ColumnsLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/ColumnsLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAC5D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;;;EAIE;AACF,MAAM,MAAM,aAAa,GAAG;IACxB;;MAEE;IACF,IAAI,EAAE,SAAS,CAAC;IAChB;;MAEE;IACF,IAAI,EAAE,MAAM,EAAE,CAAC;IACf;;MAEE;IACF,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB;;MAEE;IACF,IAAI,CAAC,EAAE,iBAAiB,CAAC;IACzB;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
@@ -1,7 +1,14 @@
1
1
  import type { DecisionLayoutOption } from './DecisionLayoutOption';
2
2
  import type { Size } from '../misc/Size';
3
3
  /**
4
- * A set of options which each perform an [com.wise.dynamicflow.feature.Action].
4
+ * A set of options which each perform a [com.wise.dynamicflow.feature.Behavior].
5
+ * <!-- fixture: decision -->
6
+ * ## When to use
7
+ * - When the only (or primary) way for a user to progress is to choose between a set of options.
8
+ * For example, choosing a country, or the type of document they wish to verify with.
9
+ * ## When not to use
10
+ * - When each option represents an entity which is being managed, consider using a [com.wise.dynamicflow.layout.ListLayout] instead.
11
+ * For example, managing a list of bank cards or recipients.
5
12
  */
6
13
  export type DecisionLayout = {
7
14
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"DecisionLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/DecisionLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAClE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;EAEE;AACF,MAAM,MAAM,cAAc,GAAG;IACzB;;MAEE;IACF,IAAI,EAAE,UAAU,CAAC;IACjB;;MAEE;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;MAEE;IACF,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAChC;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"DecisionLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/DecisionLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAClE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;;;;;;;;EASE;AACF,MAAM,MAAM,cAAc,GAAG;IACzB;;MAEE;IACF,IAAI,EAAE,UAAU,CAAC;IACjB;;MAEE;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;MAEE;IACF,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAChC;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
@@ -1,6 +1,7 @@
1
1
  import type { Size } from '../misc/Size';
2
2
  /**
3
3
  * A divider can be used to create a visual separation between elements
4
+ * <!-- fixture: divider -->
4
5
  */
5
6
  export type DividerLayout = {
6
7
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"DividerLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/DividerLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;EAEE;AACF,MAAM,MAAM,aAAa,GAAG;IACxB;;MAEE;IACF,IAAI,EAAE,SAAS,CAAC;IAChB;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"DividerLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/DividerLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;;EAGE;AACF,MAAM,MAAM,aAAa,GAAG;IACxB;;MAEE;IACF,IAAI,EAAE,SAAS,CAAC;IAChB;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
@@ -2,6 +2,7 @@ import type { Size } from '../misc/Size';
2
2
  import type { Align } from '../misc/Align';
3
3
  /**
4
4
  * A heading which can be used to title or separate sections of a layout.
5
+ * <!-- fixture: heading -->
5
6
  */
6
7
  export type HeadingLayout = {
7
8
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"HeadingLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/HeadingLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAE1C;;EAEE;AACF,MAAM,MAAM,aAAa,GAAG;IACxB;;MAEE;IACF,IAAI,EAAE,SAAS,CAAC;IAChB;;MAEE;IACF,IAAI,EAAE,MAAM,CAAC;IACb;;MAEE;IACF,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;MAEE;IACF,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"HeadingLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/HeadingLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAE1C;;;EAGE;AACF,MAAM,MAAM,aAAa,GAAG;IACxB;;MAEE;IACF,IAAI,EAAE,SAAS,CAAC;IAChB;;MAEE;IACF,IAAI,EAAE,MAAM,CAAC;IACb;;MAEE;IACF,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;MAEE;IACF,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
@@ -4,6 +4,8 @@ import type { Align } from '../misc/Align';
4
4
  /**
5
5
  * An Image, specified by URI. Accepted schemes are `http`, `https` and `urn`.
6
6
  * Relative URL or paths, are also supported.
7
+ * This layout has been superseded by [com.wise.dynamicflow.layout.MediaLayout]. If you can,
8
+ * consider using that instead.
7
9
  */
8
10
  export type ImageLayout = {
9
11
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"ImageLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/ImageLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAE1C;;;EAGE;AACF,MAAM,MAAM,WAAW,GAAG;IACtB;;MAEE;IACF,IAAI,EAAE,OAAO,CAAC;IACd;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;MAEE;IACF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;MAEE;IACF,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC;;MAEE;IACF,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB;;;;;MAKE;IACF,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"ImageLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/ImageLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAE1C;;;;;EAKE;AACF,MAAM,MAAM,WAAW,GAAG;IACtB;;MAEE;IACF,IAAI,EAAE,OAAO,CAAC;IACd;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;MAEE;IACF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;MAEE;IACF,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC;;MAEE;IACF,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB;;;;;MAKE;IACF,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
@@ -2,6 +2,13 @@ import type { InstructionsLayoutItem } from './InstructionsLayoutItem';
2
2
  import type { Size } from '../misc/Size';
3
3
  /**
4
4
  * A list of fields used to inform the user of actions to do and not do.
5
+ * <!-- fixture: instructions -->
6
+ * ## When to use
7
+ * - When providing a list of things the user should and should not do, for example,
8
+ * when creating a password, DO use something unique, with special characters. DON'T use your date of birth.
9
+ * ## When not to use
10
+ * - When building a list of items which have positive/negative sentiments but are not instructions, consider using a [com.wise.dynamicflow.layout.StatusListLayout] instead.
11
+ * For example, a list of features which are and aren't included in a subscription.
5
12
  */
6
13
  export type InstructionsLayout = {
7
14
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"InstructionsLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/InstructionsLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AACtE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;EAEE;AACF,MAAM,MAAM,kBAAkB,GAAG;IAC7B;;MAEE;IACF,IAAI,EAAE,cAAc,CAAC;IACrB;;MAEE;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;MAEE;IACF,KAAK,EAAE,sBAAsB,EAAE,CAAC;IAChC;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"InstructionsLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/InstructionsLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AACtE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;;;;;;;;EASE;AACF,MAAM,MAAM,kBAAkB,GAAG;IAC7B;;MAEE;IACF,IAAI,EAAE,cAAc,CAAC;IACrB;;MAEE;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;MAEE;IACF,KAAK,EAAE,sBAAsB,EAAE,CAAC;IAChC;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
@@ -1,7 +1,7 @@
1
1
  import type { Behavior } from '../feature/Behavior';
2
2
  import type { Context } from '../misc/Context';
3
3
  /**
4
- * The call to action configuration to be used by the status list item.
4
+ * The call to action configuration to be used by the [com.wise.dynamicflow.layout.StatusListLayout.Item].
5
5
  */
6
6
  export type ItemCallToAction = {
7
7
  /**
@@ -13,7 +13,7 @@ export type ItemCallToAction = {
13
13
  */
14
14
  accessibilityDescription?: string;
15
15
  /**
16
- * Behavior that should be performed when user interacts with call to action.
16
+ * The [com.wise.dynamicflow.feature.Behavior] that should be performed when user interacts with call to action.
17
17
  */
18
18
  behavior: Behavior;
19
19
  /**
@@ -1,7 +1,6 @@
1
1
  import type { AlertLayout } from './AlertLayout';
2
2
  import type { BoxLayout } from './BoxLayout';
3
3
  import type { ButtonLayout } from './ButtonLayout';
4
- import { CollectionLayout } from './CollectionLayout';
5
4
  import type { ColumnsLayout } from './ColumnsLayout';
6
5
  import type { DecisionLayout } from './DecisionLayout';
7
6
  import type { DividerLayout } from './DividerLayout';
@@ -24,7 +23,7 @@ import type { StatusListLayout } from './StatusListLayout';
24
23
  import type { TabsLayout } from './TabsLayout';
25
24
  import type { UpsellLayout } from './UpsellLayout';
26
25
  /**
27
- * Layouts allow you to display information to the user and customise how a step is structured.
28
- */
29
- export type Layout = AlertLayout | BoxLayout | ButtonLayout | CollectionLayout | ColumnsLayout | DecisionLayout | DividerLayout | FormLayout | HeadingLayout | ImageLayout | InfoLayout | InstructionsLayout | ListLayout | LoadingIndicatorLayout | MarkdownLayout | MediaLayout | ModalLayout | ParagraphLayout | ProgressLayout | ReviewLayout | SearchLayout | SectionLayout | StatusListLayout | TabsLayout | UpsellLayout;
26
+ * Layouts allow you to display information to the user and customise how a step is structured.
27
+ */
28
+ export type Layout = AlertLayout | BoxLayout | ButtonLayout | ColumnsLayout | DecisionLayout | DividerLayout | FormLayout | HeadingLayout | ImageLayout | InfoLayout | InstructionsLayout | ListLayout | LoadingIndicatorLayout | MarkdownLayout | MediaLayout | ModalLayout | ParagraphLayout | ProgressLayout | ReviewLayout | SearchLayout | SectionLayout | StatusListLayout | TabsLayout | UpsellLayout;
30
29
  //# sourceMappingURL=Layout.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Layout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/Layout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,MAAM,GACd,WAAW,GACX,SAAS,GACT,YAAY,GACZ,gBAAgB,GAChB,aAAa,GACb,cAAc,GACd,aAAa,GACb,UAAU,GACV,aAAa,GACb,WAAW,GACX,UAAU,GACV,kBAAkB,GAClB,UAAU,GACV,sBAAsB,GACtB,cAAc,GACd,WAAW,GACX,WAAW,GACX,eAAe,GACf,cAAc,GACd,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,gBAAgB,GAChB,UAAU,GACV,YAAY,CAAC"}
1
+ {"version":3,"file":"Layout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/Layout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AACpD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AACpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC1D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAElD;;EAEE;AACF,MAAM,MAAM,MAAM,GAAG,WAAW,GAAG,SAAS,GAAG,YAAY,GAAG,aAAa,GAAG,cAAc,GAAG,aAAa,GAAG,UAAU,GAAG,aAAa,GAAG,WAAW,GAAG,UAAU,GAAG,kBAAkB,GAAG,UAAU,GAAG,sBAAsB,GAAG,cAAc,GAAG,WAAW,GAAG,WAAW,GAAG,eAAe,GAAG,cAAc,GAAG,YAAY,GAAG,YAAY,GAAG,aAAa,GAAG,gBAAgB,GAAG,UAAU,GAAG,YAAY,CAAC"}
@@ -3,6 +3,13 @@ import type { ListLayoutItem } from './ListLayoutItem';
3
3
  import type { Size } from '../misc/Size';
4
4
  /**
5
5
  * A list of read-only fields displaying information with optional images or icons for the user.
6
+ * <!-- fixture: list -->
7
+ * ## When to use
8
+ * - When each item represents an entity with meaning to the user.
9
+ * - When building experiences to manage/edit a list of entities, for example a list of saved bank cards.
10
+ * ## When not to use
11
+ * - When each item represents a choice, rather than an existing entity, consider using a [com.wise.dynamicflow.layout.DecisionLayout] instead.
12
+ * - If the purpose of the list is to provide a summary of information which the user needs to check, consider using a [com.wise.dynamicflow.layout.ReviewLayout] instead.
6
13
  */
7
14
  export type ListLayout = {
8
15
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"ListLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/ListLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;EAEE;AACF,MAAM,MAAM,UAAU,GAAG;IACrB;;MAEE;IACF,IAAI,EAAE,MAAM,CAAC;IACb;;MAEE;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;MAEE;IACF,YAAY,CAAC,EAAE,sBAAsB,CAAC;IACtC;;MAEE;IACF,KAAK,EAAE,cAAc,EAAE,CAAC;IACxB;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"ListLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/ListLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;;;;;;;;EASE;AACF,MAAM,MAAM,UAAU,GAAG;IACrB;;MAEE;IACF,IAAI,EAAE,MAAM,CAAC;IACb;;MAEE;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;MAEE;IACF,YAAY,CAAC,EAAE,sBAAsB,CAAC;IACtC;;MAEE;IACF,KAAK,EAAE,cAAc,EAAE,CAAC;IACxB;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
@@ -13,7 +13,7 @@ export type ListLayoutCallToAction = {
13
13
  */
14
14
  accessibilityDescription?: string;
15
15
  /**
16
- * Behavior that should be performed when user interacts with call to action.
16
+ * The [com.wise.dynamicflow.feature.Behavior] that should be performed when user interacts with call to action.
17
17
  */
18
18
  behavior: Behavior;
19
19
  /**
@@ -2,6 +2,7 @@ import type { Size } from '../misc/Size';
2
2
  /**
3
3
  * A symbol indicating an indeterminate loading or pending state, when the user should wait for something to happen.
4
4
  * Typically used in conjunction with [com.wise.dynamicflow.feature.LinkHandler] or [com.wise.dynamicflow.feature.Polling].
5
+ * <!-- fixture: loadingindicator -->
5
6
  */
6
7
  export type LoadingIndicatorLayout = {
7
8
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"LoadingIndicatorLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/LoadingIndicatorLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;;EAGE;AACF,MAAM,MAAM,sBAAsB,GAAG;IACjC;;MAEE;IACF,IAAI,EAAE,mBAAmB,CAAC;IAC1B;;MAEE;IACF,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"LoadingIndicatorLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/LoadingIndicatorLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;;;EAIE;AACF,MAAM,MAAM,sBAAsB,GAAG;IACjC;;MAEE;IACF,IAAI,EAAE,mBAAmB,CAAC;IAC1B;;MAEE;IACF,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
@@ -9,6 +9,7 @@ import type { Size } from '../misc/Size';
9
9
  * - Emphasis
10
10
  * - Strong Emphasis
11
11
  * - Links
12
+ * <!-- fixture: markdown -->
12
13
  */
13
14
  export type MarkdownLayout = {
14
15
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"MarkdownLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/MarkdownLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;;;;;;;;EASE;AACF,MAAM,MAAM,cAAc,GAAG;IACzB;;MAEE;IACF,IAAI,EAAE,UAAU,CAAC;IACjB;;MAEE;IACF,OAAO,EAAE,MAAM,CAAC;IAChB;;MAEE;IACF,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB;;MAEE;IACF,IAAI,CAAC,EAAE,IAAI,CAAC;CACf,CAAC"}
1
+ {"version":3,"file":"MarkdownLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/MarkdownLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;;;;;;;;;EAUE;AACF,MAAM,MAAM,cAAc,GAAG;IACzB;;MAEE;IACF,IAAI,EAAE,UAAU,CAAC;IACjB;;MAEE;IACF,OAAO,EAAE,MAAM,CAAC;IAChB;;MAEE;IACF,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB;;MAEE;IACF,IAAI,CAAC,EAAE,IAAI,CAAC;CACf,CAAC"}
@@ -2,7 +2,7 @@ import type { Media } from '../misc/media/Media';
2
2
  import type { Align } from '../misc/Align';
3
3
  import type { Size } from '../misc/Size';
4
4
  /**
5
- * Contains a [Media] which is added to the Layout.
5
+ * Contains a [com.wise.dynamicflow.misc.media.Media] which is added to the Layout.
6
6
  */
7
7
  export type MediaLayout = {
8
8
  /**
@@ -4,6 +4,11 @@ import type { ModalLayoutContent } from './ModalLayoutContent';
4
4
  /**
5
5
  * A button that triggers a modal with the specified layout components.
6
6
  * **Note**: We do not support the use of forms inside a modal.
7
+ * <!-- fixture: modal -->
8
+ * ## When to use
9
+ * - When there is a small amount of content to show to the user that is purely informational.
10
+ * ## When not to use
11
+ * - When the content is more complex and requires user interaction, or validation from the server. Consider using a [com.wise.dynamicflow.feature.subflow.Subflow] instead.
7
12
  */
8
13
  export type ModalLayout = {
9
14
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"ModalLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/ModalLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAE9D;;;EAGE;AACF,MAAM,MAAM,WAAW,GAAG;IACtB;;MAEE;IACF,IAAI,EAAE,OAAO,CAAC;IACd;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,OAAO,EAAE,kBAAkB,CAAC;IAC5B;;MAEE;IACF,OAAO,EAAE,kBAAkB,CAAC;IAC5B;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"ModalLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/ModalLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAE9D;;;;;;;;EAQE;AACF,MAAM,MAAM,WAAW,GAAG;IACtB;;MAEE;IACF,IAAI,EAAE,OAAO,CAAC;IACd;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,OAAO,EAAE,kBAAkB,CAAC;IAC5B;;MAEE;IACF,OAAO,EAAE,kBAAkB,CAAC;IAC5B;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
@@ -2,6 +2,7 @@ import type { Align } from '../misc/Align';
2
2
  import type { Size } from '../misc/Size';
3
3
  /**
4
4
  * A block of plain text. For richer formatting and layout options consider using [MarkdownLayout].
5
+ * <!-- fixture: paragraph -->
5
6
  */
6
7
  export type ParagraphLayout = {
7
8
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"ParagraphLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/ParagraphLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;EAEE;AACF,MAAM,MAAM,eAAe,GAAG;IAC1B;;MAEE;IACF,IAAI,EAAE,WAAW,CAAC;IAClB;;MAEE;IACF,IAAI,EAAE,MAAM,CAAC;IACb;;MAEE;IACF,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB;;MAEE;IACF,IAAI,CAAC,EAAE,IAAI,CAAC;CACf,CAAC"}
1
+ {"version":3,"file":"ParagraphLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/ParagraphLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;;EAGE;AACF,MAAM,MAAM,eAAe,GAAG;IAC1B;;MAEE;IACF,IAAI,EAAE,WAAW,CAAC;IAClB;;MAEE;IACF,IAAI,EAAE,MAAM,CAAC;IACb;;MAEE;IACF,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB;;MAEE;IACF,IAAI,CAAC,EAAE,IAAI,CAAC;CACf,CAAC"}
@@ -3,6 +3,12 @@ import type { Help } from '../feature/Help';
3
3
  import type { Size } from '../misc/Size';
4
4
  /**
5
5
  * An indicator which can be used to show progress towards a goal or limit.
6
+ * <!-- fixture: progress -->
7
+ * ## When to use
8
+ * - When showing the user's progress which is based on their actions, or some long-running process.
9
+ * ## When not to use
10
+ * - When showing a loading state for a task that is expected to complete quickly, consider showing a [com.wise.dynamicflow.layout.LoadingIndicatorLayout], or
11
+ * some informational content instead.
6
12
  */
7
13
  export type ProgressLayout = {
8
14
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"ProgressLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/ProgressLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;EAEE;AACF,MAAM,MAAM,cAAc,GAAG;IACzB;;MAEE;IACF,IAAI,EAAE,UAAU,CAAC;IACjB;;MAEE;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,QAAQ,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,YAAY,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;MAEE;IACF,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"ProgressLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/ProgressLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;;;;;;;EAQE;AACF,MAAM,MAAM,cAAc,GAAG;IACzB;;MAEE;IACF,IAAI,EAAE,UAAU,CAAC;IACjB;;MAEE;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,QAAQ,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,YAAY,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;MAEE;IACF,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
@@ -4,6 +4,14 @@ import type { ReviewLayoutCallToAction } from './ReviewLayoutCallToAction';
4
4
  import type { Size } from '../misc/Size';
5
5
  /**
6
6
  * A list of read-only fields used to show information to the user for review.
7
+ * <!-- fixture: review -->
8
+ * ## When to use
9
+ * - When the users attention is meant to be on the values, rather than the labels. For example, when the user is being asked
10
+ * to check a number of fields that they have previously entered.
11
+ * ## When not to use
12
+ * - When the primary action of the step is tied to an individual item, consider using a [com.wise.dynamicflow.layout.DecisionLayout] instead.
13
+ * - When the content being displayed represents separate entities of the same category, consider using a [com.wise.dynamicflow.layout.ListLayout] instead.
14
+ * - If the focus is on the labels rather than the values, consider using a [com.wise.dynamicflow.layout.ListLayout] instead.
7
15
  */
8
16
  export type ReviewLayout = {
9
17
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"ReviewLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/ReviewLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAC5D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAC1E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;EAEE;AACF,MAAM,MAAM,YAAY,GAAG;IACvB;;MAEE;IACF,IAAI,EAAE,QAAQ,CAAC;IACf;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;MAEE;IACF,MAAM,EAAE,iBAAiB,EAAE,CAAC;IAC5B;;MAEE;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;MAEE;IACF,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"ReviewLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/ReviewLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAC5D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAC1E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;;;;;;;;;EAUE;AACF,MAAM,MAAM,YAAY,GAAG;IACvB;;MAEE;IACF,IAAI,EAAE,QAAQ,CAAC;IACf;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;MAEE;IACF,MAAM,EAAE,iBAAiB,EAAE,CAAC;IAC5B;;MAEE;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;MAEE;IACF,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
@@ -2,7 +2,7 @@ import type { Action } from '../feature/Action';
2
2
  import type { Behavior } from '../feature/Behavior';
3
3
  import type { Context } from '../misc/Context';
4
4
  /**
5
- * Adds an [com.wise.dynamicflow.feature.Action] to the review layout. For example, it could be used to provide an edit action.
5
+ * The call to action configuration used by [com.wise.dynamicflow.layout.ReviewLayout] or individual fields ([com.wise.dynamicflow.layout.ReviewLayout.Field]). For example, it could be used to provide an edit action.
6
6
  */
7
7
  export type ReviewLayoutCallToAction = {
8
8
  /**
@@ -6,7 +6,7 @@ import type { InlineAlert } from '../misc/InlineAlert';
6
6
  import type { ReviewLayoutCallToAction } from './ReviewLayoutCallToAction';
7
7
  import type { Media } from '../misc/media/Media';
8
8
  /**
9
- * A single field in a [ReviewLayout]
9
+ * A single field in a [com.wise.dynamicflow.layout.ReviewLayout].
10
10
  */
11
11
  export type ReviewLayoutField = {
12
12
  /**
@@ -3,7 +3,12 @@ import type { Size } from '../misc/Size';
3
3
  import type { SearchInitialState } from '../responses/search/SearchInitialState';
4
4
  /**
5
5
  * Displays a search input field, which performs a search and returns a [com.wise.dynamicflow.responses.search.SearchResult].
6
- * Results are actions or further searches.
6
+ * <!-- fixture: search -->
7
+ * ## When to use
8
+ * - When there are a large number of options which cannot all be provided. For example, an address lookup.
9
+ * ## When not to use
10
+ * - When there are a small number of options which could all be provided on the step, consider using a [com.wise.dynamicflow.layout.DecisionLayout] with filtering instead.
11
+ * For example, a list of countries.
7
12
  */
8
13
  export type SearchLayout = {
9
14
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"SearchLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/SearchLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAA;AAEhF;;;EAGE;AACF,MAAM,MAAM,YAAY,GAAG;IACvB;;MAEE;IACF,IAAI,EAAE,QAAQ,CAAC;IACf;;MAEE;IACF,KAAK,EAAE,MAAM,CAAC;IACd;;MAEE;IACF,MAAM,EAAE,UAAU,CAAC;IACnB;;MAEE;IACF,GAAG,EAAE,MAAM,CAAC;IACZ;;;MAGE;IACF,KAAK,EAAE,MAAM,CAAC;IACd;;MAEE;IACF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;MAGE;IACF,YAAY,CAAC,EAAE,kBAAkB,CAAC;CACrC,CAAC"}
1
+ {"version":3,"file":"SearchLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/SearchLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAA;AAEhF;;;;;;;;EAQE;AACF,MAAM,MAAM,YAAY,GAAG;IACvB;;MAEE;IACF,IAAI,EAAE,QAAQ,CAAC;IACf;;MAEE;IACF,KAAK,EAAE,MAAM,CAAC;IACd;;MAEE;IACF,MAAM,EAAE,UAAU,CAAC;IACnB;;MAEE;IACF,GAAG,EAAE,MAAM,CAAC;IACZ;;;MAGE;IACF,KAAK,EAAE,MAAM,CAAC;IACd;;MAEE;IACF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;MAGE;IACF,YAAY,CAAC,EAAE,kBAAkB,CAAC;CACrC,CAAC"}
@@ -3,6 +3,11 @@ import type { SectionLayoutCallToAction } from './SectionLayoutCallToAction';
3
3
  import type { Size } from '../misc/Size';
4
4
  /**
5
5
  * A container for a group of layout components topped with a section header.
6
+ * <!-- fixture: section -->
7
+ * ## When to use
8
+ * - When content is grouped under a shared title, or for accessibility reasons.
9
+ * ## When not to use
10
+ * - When the content is a single layout which has its own title, consider using that layout directly instead. For example, [com.wise.dynamicflow.layout.DecisionLayout], [com.wise.dynamicflow.layout.ReviewLayout], or [com.wise.dynamicflow.layout.ListLayout].
6
11
  */
7
12
  export type SectionLayout = {
8
13
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"SectionLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/SectionLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACtC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAC5E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;EAEE;AACF,MAAM,MAAM,aAAa,GAAG;IACxB;;MAEE;IACF,IAAI,EAAE,SAAS,CAAC;IAChB;;MAEE;IACF,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB;;MAEE;IACF,KAAK,EAAE,MAAM,CAAC;IACd;;MAEE;IACF,YAAY,CAAC,EAAE,yBAAyB,CAAC;IACzC;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"SectionLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/SectionLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACtC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAC5E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;;;;;;EAOE;AACF,MAAM,MAAM,aAAa,GAAG;IACxB;;MAEE;IACF,IAAI,EAAE,SAAS,CAAC;IAChB;;MAEE;IACF,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB;;MAEE;IACF,KAAK,EAAE,MAAM,CAAC;IACd;;MAEE;IACF,YAAY,CAAC,EAAE,yBAAyB,CAAC;IACzC;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
@@ -13,7 +13,7 @@ export type SectionLayoutCallToAction = {
13
13
  */
14
14
  accessibilityDescription?: string;
15
15
  /**
16
- * Behavior that should be performed when user interacts with call to action.
16
+ * The [com.wise.dynamicflow.feature.Behavior] that should be performed when user interacts with call to action.
17
17
  */
18
18
  behavior: Behavior;
19
19
  /**
@@ -2,6 +2,11 @@ import type { StatusListLayoutItem } from './StatusListLayoutItem';
2
2
  import type { Size } from '../misc/Size';
3
3
  /**
4
4
  * A list of items with statuses.
5
+ * <!-- fixture: statuslist -->
6
+ * ## When to use
7
+ * - When showing a list of actions for the user to take and their states.
8
+ * ## When not to use
9
+ * - When the items are all instructions, and do not have a 'state', for example password requirements, consider using an [com.wise.dynamicflow.layout.InstructionsLayout] instead.
5
10
  */
6
11
  export type StatusListLayout = {
7
12
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"StatusListLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/StatusListLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAClE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;EAEE;AACF,MAAM,MAAM,gBAAgB,GAAG;IAC3B;;MAEE;IACF,IAAI,EAAE,aAAa,CAAC;IACpB;;MAEE;IACF,KAAK,EAAE,oBAAoB,EAAE,CAAC;IAC9B;;MAEE;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"StatusListLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/StatusListLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAClE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;;;;;;EAOE;AACF,MAAM,MAAM,gBAAgB,GAAG;IAC3B;;MAEE;IACF,IAAI,EAAE,aAAa,CAAC;IACpB;;MAEE;IACF,KAAK,EAAE,oBAAoB,EAAE,CAAC;IAC9B;;MAEE;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
@@ -2,6 +2,7 @@ import type { TabsLayoutTab } from './TabsLayoutTab';
2
2
  import type { Size } from '../misc/Size';
3
3
  /**
4
4
  * A container divided into groups of layout components with each group being visible upon user-selection
5
+ * <!-- fixture: layouttabs -->
5
6
  */
6
7
  export type TabsLayout = {
7
8
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"TabsLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/TabsLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AACpD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;EAEE;AACF,MAAM,MAAM,UAAU,GAAG;IACrB;;MAEE;IACF,IAAI,EAAE,MAAM,CAAC;IACb;;MAEE;IACF,IAAI,EAAE,aAAa,EAAE,CAAC;IACtB;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"TabsLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/TabsLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AACpD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;;EAGE;AACF,MAAM,MAAM,UAAU,GAAG;IACrB;;MAEE;IACF,IAAI,EAAE,MAAM,CAAC;IACb;;MAEE;IACF,IAAI,EAAE,aAAa,EAAE,CAAC;IACtB;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
@@ -4,6 +4,11 @@ import type { Request } from '../misc/Request';
4
4
  import type { Size } from '../misc/Size';
5
5
  /**
6
6
  * A component used to encourage the user to perform an action whilst showing an attention-grabbing message.
7
+ * <!-- fixture: upsell -->
8
+ * ## When to use
9
+ * - When the information/associated action is optional. For example, encouraging users to enable a new feature.
10
+ * ## When not to use
11
+ * - When the information/action is critical for the user to progress, consider using an [com.wise.dynamicflow.layout.AlertLayout] instead.
7
12
  */
8
13
  export type UpsellLayout = {
9
14
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"UpsellLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/UpsellLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAC1E,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;EAEE;AACF,MAAM,MAAM,YAAY,GAAG;IACvB;;MAEE;IACF,IAAI,EAAE,QAAQ,CAAC;IACf;;MAEE;IACF,IAAI,EAAE,MAAM,CAAC;IACb;;MAEE;IACF,YAAY,EAAE,wBAAwB,CAAC;IACvC;;MAEE;IACF,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;;MAGE;IACF,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"UpsellLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/UpsellLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAC1E,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;;;;;;EAOE;AACF,MAAM,MAAM,YAAY,GAAG;IACvB;;MAEE;IACF,IAAI,EAAE,QAAQ,CAAC;IACf;;MAEE;IACF,IAAI,EAAE,MAAM,CAAC;IACb;;MAEE;IACF,YAAY,EAAE,wBAAwB,CAAC;IACvC;;MAEE;IACF,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;;MAGE;IACF,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
@@ -1,7 +1,7 @@
1
1
  import type { Behavior } from '../feature/Behavior';
2
2
  import type { Context } from '../misc/Context';
3
3
  /**
4
- * The call to action configuration to be used by the Upsell.
4
+ * The call to action configuration to be used by the [com.wise.dynamicflow.layout.UpsellLayout].
5
5
  */
6
6
  export type UpsellLayoutCallToAction = {
7
7
  /**
@@ -13,7 +13,7 @@ export type UpsellLayoutCallToAction = {
13
13
  */
14
14
  accessibilityDescription?: string;
15
15
  /**
16
- * Behavior that should be performed when user interacts with call to action.
16
+ * The [com.wise.dynamicflow.feature.Behavior] that should be performed when user interacts with call to action.
17
17
  */
18
18
  behavior: Behavior;
19
19
  /**
@@ -237,24 +237,6 @@ var statusListLayoutStatusSchema = import_zod.z.union([
237
237
  import_zod.z.literal("pending"),
238
238
  import_zod.z.literal("done")
239
239
  ]);
240
- var collectionSearchSchema = import_zod.z.object({
241
- param: import_zod.z.string(),
242
- title: import_zod.z.string().optional(),
243
- hint: import_zod.z.string().optional()
244
- });
245
- var collectionFilterSchema = import_zod.z.object({
246
- type: import_zod.z.literal("select"),
247
- param: import_zod.z.string(),
248
- options: import_zod.z.array(
249
- import_zod.z.object({
250
- id: import_zod.z.string(),
251
- title: import_zod.z.string(),
252
- accessibilityDescription: import_zod.z.string().optional(),
253
- selected: import_zod.z.boolean().optional()
254
- })
255
- ),
256
- multiSelection: import_zod.z.boolean().optional()
257
- });
258
240
  var instructionsLayoutItemSchema = import_zod.z.object({
259
241
  text: import_zod.z.string(),
260
242
  context: contextSchema,
@@ -459,6 +441,11 @@ var modalPresentationSchema = import_zod.z.object({
459
441
  var pushPresentationSchema = import_zod.z.object({
460
442
  type: import_zod.z.literal("push")
461
443
  });
444
+ var nativeLaunchConfigSchema = import_zod.z.object({
445
+ type: import_zod.z.literal("native"),
446
+ id: import_zod.z.string(),
447
+ payload: jsonElementSchema.optional()
448
+ });
462
449
  var linkBehaviorSchema = import_zod.z.object({
463
450
  type: import_zod.z.literal("link"),
464
451
  url: import_zod.z.string()
@@ -508,7 +495,7 @@ var dynamicLaunchConfigSchema = import_zod.z.object({
508
495
  request: requestSchema,
509
496
  presentation: presentationSchema
510
497
  });
511
- var launchConfigSchema = dynamicLaunchConfigSchema;
498
+ var launchConfigSchema = import_zod.z.union([dynamicLaunchConfigSchema, nativeLaunchConfigSchema]);
512
499
  var searchResponseBodySchema = import_zod.z.object({
513
500
  type: import_zod.z.literal("results").optional(),
514
501
  results: import_zod.z.array(searchResultSchema)
@@ -710,76 +697,23 @@ var statusListLayoutItemSchema = import_zod.z.lazy(
710
697
  tags: import_zod.z.array(import_zod.z.string()).optional()
711
698
  })
712
699
  );
713
- var collectionLayoutSchema = import_zod.z.lazy(
700
+ var sectionLayoutSchema = import_zod.z.lazy(
714
701
  () => import_zod.z.object({
715
- type: import_zod.z.literal("collection"),
716
- url: import_zod.z.string(),
717
- method: httpMethodSchema,
718
- initialState: collectionStateSchema,
719
- search: collectionSearchSchema,
720
- filters: import_zod.z.array(collectionFilterSchema),
702
+ type: import_zod.z.literal("section"),
703
+ components: import_zod.z.array(layoutSchema),
704
+ title: import_zod.z.string(),
705
+ callToAction: sectionLayoutCallToActionSchema.optional(),
721
706
  control: import_zod.z.string().optional(),
722
707
  margin: sizeSchema.optional(),
723
708
  analyticsId: import_zod.z.string().optional(),
724
709
  tags: import_zod.z.array(import_zod.z.string()).optional()
725
710
  })
726
711
  );
727
- var collectionStateSchema = import_zod.z.lazy(
728
- () => import_zod.z.object({
729
- type: import_zod.z.literal("collection-content"),
730
- sections: import_zod.z.array(collectionSectionSchema),
731
- nextCursor: import_zod.z.string().optional()
732
- })
733
- );
734
- var collectionSectionSchema = import_zod.z.lazy(
735
- () => import_zod.z.object({
736
- id: import_zod.z.string(),
737
- title: import_zod.z.string().optional(),
738
- callToAction: collectionCallToActionSchema.optional(),
739
- items: import_zod.z.array(collectionItemSchema)
740
- })
741
- );
742
- var collectionCallToActionSchema = import_zod.z.lazy(
743
- () => import_zod.z.object({
744
- title: import_zod.z.string(),
745
- accessibilityDescription: import_zod.z.string().optional(),
746
- behavior: behaviorSchema,
747
- context: contextSchema.optional()
748
- })
749
- );
750
- var collectionItemSchema = import_zod.z.lazy(
751
- () => import_zod.z.object({
752
- title: import_zod.z.string().optional(),
753
- description: import_zod.z.string().optional(),
754
- disabled: import_zod.z.boolean().optional(),
755
- additionalInfo: additionalInfoSchema.optional(),
756
- supportingValues: supportingValuesSchema.optional(),
757
- inlineAlert: inlineAlertSchema.optional(),
758
- media: mediaSchema.optional(),
759
- callToAction: collectionCallToActionSchema.optional(),
760
- analyticsId: import_zod.z.string().optional(),
761
- tags: import_zod.z.array(import_zod.z.string()).optional()
762
- })
763
- );
764
- var collectionResponseSchema = import_zod.z.lazy(
765
- () => import_zod.z.union([
766
- import_zod.z.object({
767
- type: import_zod.z.literal("collection-content"),
768
- sections: import_zod.z.array(collectionSectionSchema),
769
- nextCursor: import_zod.z.string().optional()
770
- }),
771
- import_zod.z.object({
772
- type: import_zod.z.literal("empty"),
773
- content: import_zod.z.array(layoutSchema)
774
- })
775
- ])
776
- );
777
712
  var layoutSchema = import_zod.z.lazy(
778
713
  () => import_zod.z.union([
779
714
  alertLayoutSchema,
780
715
  boxLayoutSchema,
781
716
  buttonLayoutSchema,
782
- collectionLayoutSchema,
783
717
  columnsLayoutSchema,
784
718
  decisionLayoutSchema,
785
719
  dividerLayoutSchema,
@@ -803,18 +737,6 @@ var layoutSchema = import_zod.z.lazy(
803
737
  upsellLayoutSchema
804
738
  ])
805
739
  );
806
- var sectionLayoutSchema = import_zod.z.lazy(
807
- () => import_zod.z.object({
808
- type: import_zod.z.literal("section"),
809
- components: import_zod.z.array(layoutSchema),
810
- title: import_zod.z.string(),
811
- callToAction: sectionLayoutCallToActionSchema.optional(),
812
- control: import_zod.z.string().optional(),
813
- margin: sizeSchema.optional(),
814
- analyticsId: import_zod.z.string().optional(),
815
- tags: import_zod.z.array(import_zod.z.string()).optional()
816
- })
817
- );
818
740
  var itemCallToActionSchema = import_zod.z.lazy(
819
741
  () => import_zod.z.object({
820
742
  title: import_zod.z.string(),