@wise/dynamic-flow-types 4.14.0-experimental-2996a75 → 4.15.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 (132) hide show
  1. package/build/renderers/BaseInputRendererProps.d.ts +5 -0
  2. package/build/renderers/BaseInputRendererProps.d.ts.map +1 -1
  3. package/build/renderers/RendererProps.d.ts +4 -5
  4. package/build/renderers/RendererProps.d.ts.map +1 -1
  5. package/build/renderers/SubflowRendererProps.d.ts +17 -7
  6. package/build/renderers/SubflowRendererProps.d.ts.map +1 -1
  7. package/build/renderers/index.d.ts +12 -4
  8. package/build/renderers/index.d.ts.map +1 -1
  9. package/build/spec/feature/Action.d.ts +6 -6
  10. package/build/spec/feature/ActionBehavior.d.ts +6 -0
  11. package/build/spec/feature/ActionBehavior.d.ts.map +1 -1
  12. package/build/spec/feature/Behavior.d.ts +2 -1
  13. package/build/spec/feature/Behavior.d.ts.map +1 -1
  14. package/build/spec/feature/ContainerBehavior.d.ts +5 -0
  15. package/build/spec/feature/ContainerBehavior.d.ts.map +1 -1
  16. package/build/spec/feature/CopyBehavior.d.ts +6 -0
  17. package/build/spec/feature/CopyBehavior.d.ts.map +1 -1
  18. package/build/spec/feature/DismissBehavior.d.ts +6 -0
  19. package/build/spec/feature/DismissBehavior.d.ts.map +1 -1
  20. package/build/spec/feature/DownloadBehavior.d.ts +21 -0
  21. package/build/spec/feature/DownloadBehavior.d.ts.map +1 -0
  22. package/build/spec/feature/External.d.ts +1 -1
  23. package/build/spec/feature/LinkBehavior.d.ts +6 -0
  24. package/build/spec/feature/LinkBehavior.d.ts.map +1 -1
  25. package/build/spec/feature/ModalBehavior.d.ts +6 -0
  26. package/build/spec/feature/ModalBehavior.d.ts.map +1 -1
  27. package/build/spec/feature/NavigationBackBehavior.d.ts +8 -1
  28. package/build/spec/feature/NavigationBackBehavior.d.ts.map +1 -1
  29. package/build/spec/feature/NavigationStackBehavior.d.ts +4 -0
  30. package/build/spec/feature/NavigationStackBehavior.d.ts.map +1 -1
  31. package/build/spec/feature/PersistAsync.d.ts +1 -0
  32. package/build/spec/feature/PersistAsync.d.ts.map +1 -1
  33. package/build/spec/feature/Polling.d.ts +2 -2
  34. package/build/spec/feature/RefreshBehavior.d.ts +6 -0
  35. package/build/spec/feature/RefreshBehavior.d.ts.map +1 -1
  36. package/build/spec/feature/SubflowBehavior.d.ts +6 -1
  37. package/build/spec/feature/SubflowBehavior.d.ts.map +1 -1
  38. package/build/spec/feature/ValidateAsync.d.ts +1 -0
  39. package/build/spec/feature/ValidateAsync.d.ts.map +1 -1
  40. package/build/spec/feature/subflow/DynamicLaunchConfig.d.ts +1 -1
  41. package/build/spec/feature/subflow/LaunchConfig.d.ts +9 -2
  42. package/build/spec/feature/subflow/LaunchConfig.d.ts.map +1 -1
  43. package/build/spec/feature/subflow/NativeLaunchConfig.d.ts +58 -0
  44. package/build/spec/feature/subflow/NativeLaunchConfig.d.ts.map +1 -0
  45. package/build/spec/index.d.ts +1 -1
  46. package/build/spec/index.d.ts.map +1 -1
  47. package/build/spec/layout/AlertLayout.d.ts +5 -0
  48. package/build/spec/layout/AlertLayout.d.ts.map +1 -1
  49. package/build/spec/layout/AlertLayoutCallToAction.d.ts +2 -2
  50. package/build/spec/layout/BoxLayout.d.ts +1 -0
  51. package/build/spec/layout/BoxLayout.d.ts.map +1 -1
  52. package/build/spec/layout/ButtonLayout.d.ts +1 -1
  53. package/build/spec/layout/ColumnsLayout.d.ts +1 -0
  54. package/build/spec/layout/ColumnsLayout.d.ts.map +1 -1
  55. package/build/spec/layout/DecisionLayout.d.ts +8 -1
  56. package/build/spec/layout/DecisionLayout.d.ts.map +1 -1
  57. package/build/spec/layout/DividerLayout.d.ts +1 -0
  58. package/build/spec/layout/DividerLayout.d.ts.map +1 -1
  59. package/build/spec/layout/HeadingLayout.d.ts +1 -0
  60. package/build/spec/layout/HeadingLayout.d.ts.map +1 -1
  61. package/build/spec/layout/ImageLayout.d.ts +2 -0
  62. package/build/spec/layout/ImageLayout.d.ts.map +1 -1
  63. package/build/spec/layout/InstructionsLayout.d.ts +7 -0
  64. package/build/spec/layout/InstructionsLayout.d.ts.map +1 -1
  65. package/build/spec/layout/ItemCallToAction.d.ts +2 -2
  66. package/build/spec/layout/Layout.d.ts +3 -4
  67. package/build/spec/layout/Layout.d.ts.map +1 -1
  68. package/build/spec/layout/ListLayout.d.ts +7 -0
  69. package/build/spec/layout/ListLayout.d.ts.map +1 -1
  70. package/build/spec/layout/ListLayoutCallToAction.d.ts +1 -1
  71. package/build/spec/layout/LoadingIndicatorLayout.d.ts +1 -0
  72. package/build/spec/layout/LoadingIndicatorLayout.d.ts.map +1 -1
  73. package/build/spec/layout/MarkdownLayout.d.ts +1 -0
  74. package/build/spec/layout/MarkdownLayout.d.ts.map +1 -1
  75. package/build/spec/layout/MediaLayout.d.ts +1 -1
  76. package/build/spec/layout/ModalLayout.d.ts +5 -0
  77. package/build/spec/layout/ModalLayout.d.ts.map +1 -1
  78. package/build/spec/layout/ParagraphLayout.d.ts +1 -0
  79. package/build/spec/layout/ParagraphLayout.d.ts.map +1 -1
  80. package/build/spec/layout/ProgressLayout.d.ts +6 -0
  81. package/build/spec/layout/ProgressLayout.d.ts.map +1 -1
  82. package/build/spec/layout/ReviewLayout.d.ts +8 -0
  83. package/build/spec/layout/ReviewLayout.d.ts.map +1 -1
  84. package/build/spec/layout/ReviewLayoutCallToAction.d.ts +1 -1
  85. package/build/spec/layout/ReviewLayoutField.d.ts +1 -1
  86. package/build/spec/layout/SearchLayout.d.ts +6 -1
  87. package/build/spec/layout/SearchLayout.d.ts.map +1 -1
  88. package/build/spec/layout/SectionLayout.d.ts +5 -0
  89. package/build/spec/layout/SectionLayout.d.ts.map +1 -1
  90. package/build/spec/layout/SectionLayoutCallToAction.d.ts +1 -1
  91. package/build/spec/layout/StatusListLayout.d.ts +5 -0
  92. package/build/spec/layout/StatusListLayout.d.ts.map +1 -1
  93. package/build/spec/layout/TabsLayout.d.ts +1 -0
  94. package/build/spec/layout/TabsLayout.d.ts.map +1 -1
  95. package/build/spec/layout/UpsellLayout.d.ts +5 -0
  96. package/build/spec/layout/UpsellLayout.d.ts.map +1 -1
  97. package/build/spec/layout/UpsellLayoutCallToAction.d.ts +2 -2
  98. package/build/spec/main.js +37 -100
  99. package/build/spec/main.mjs +37 -100
  100. package/build/spec/misc/Request.d.ts +4 -0
  101. package/build/spec/misc/Request.d.ts.map +1 -1
  102. package/build/spec/responses/NoOpResponseBody.d.ts +4 -1
  103. package/build/spec/responses/NoOpResponseBody.d.ts.map +1 -1
  104. package/build/spec/responses/search/SearchInitialLayoutConfig.d.ts +1 -1
  105. package/build/spec/responses/subflow/SubflowResponseBody.d.ts +2 -2
  106. package/build/spec/schema/ArraySchema.d.ts +1 -0
  107. package/build/spec/schema/ArraySchema.d.ts.map +1 -1
  108. package/build/spec/schema/BlobSchema.d.ts +1 -0
  109. package/build/spec/schema/BlobSchema.d.ts.map +1 -1
  110. package/build/spec/schema/BooleanSchema.d.ts +1 -0
  111. package/build/spec/schema/BooleanSchema.d.ts.map +1 -1
  112. package/build/spec/schema/IntegerSchema.d.ts +1 -0
  113. package/build/spec/schema/IntegerSchema.d.ts.map +1 -1
  114. package/build/spec/schema/NumberSchema.d.ts +1 -0
  115. package/build/spec/schema/NumberSchema.d.ts.map +1 -1
  116. package/build/spec/schema/ObjectSchema.d.ts +1 -0
  117. package/build/spec/schema/ObjectSchema.d.ts.map +1 -1
  118. package/build/spec/schema/OneOfSchema.d.ts +15 -3
  119. package/build/spec/schema/OneOfSchema.d.ts.map +1 -1
  120. package/build/spec/schema/StringSchema.d.ts +20 -0
  121. package/build/spec/schema/StringSchema.d.ts.map +1 -1
  122. package/build/spec/step/Step.d.ts +19 -1
  123. package/build/spec/step/Step.d.ts.map +1 -1
  124. package/build/tsconfig.tsbuildinfo +1 -1
  125. package/build/zod/schemas.d.ts +159 -120
  126. package/build/zod/schemas.d.ts.map +1 -1
  127. package/build/zod/schemas.ts +643 -718
  128. package/package.json +3 -3
  129. package/build/renderers/CollectionRendererProps.d.ts +0 -62
  130. package/build/renderers/CollectionRendererProps.d.ts.map +0 -1
  131. package/build/spec/layout/CollectionLayout.d.ts +0 -86
  132. package/build/spec/layout/CollectionLayout.d.ts.map +0 -1
@@ -1,7 +1,7 @@
1
1
  import type { Request } from '../../misc/Request';
2
2
  import type { Presentation } from './Presentation';
3
3
  /**
4
- * Launches a [Subflow] that is powered by Dynamic Flow.
4
+ * Launches a [com.wise.dynamicflow.feature.subflow.Subflow] that is powered by Dynamic Flow.
5
5
  * The subflow must be started with a request to the server.
6
6
  */
7
7
  export type DynamicLaunchConfig = {
@@ -1,6 +1,13 @@
1
1
  import type { DynamicLaunchConfig } from './DynamicLaunchConfig';
2
+ import type { NativeLaunchConfig } from './NativeLaunchConfig';
2
3
  /**
3
- * Describes how a [Subflow] should be launched.
4
+ * Describes how a [com.wise.dynamicflow.feature.subflow.Subflow] should be launched.
5
+ * There are two launch config types:
6
+ * - [com.wise.dynamicflow.feature.subflow.DynamicLaunchConfig] starts another Dynamic Flow from a server request.
7
+ * - [com.wise.dynamicflow.feature.subflow.NativeLaunchConfig] routes to a native subflow handler registered on
8
+ * the client.
9
+ * Both launch types use the same [com.wise.dynamicflow.feature.subflow.Subflow] callbacks for completion,
10
+ * failure, and result merging.
4
11
  */
5
- export type LaunchConfig = DynamicLaunchConfig;
12
+ export type LaunchConfig = DynamicLaunchConfig | NativeLaunchConfig;
6
13
  //# sourceMappingURL=LaunchConfig.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"LaunchConfig.d.ts","sourceRoot":"","sources":["../../../../src/spec/feature/subflow/LaunchConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAEhE;;EAEE;AACF,MAAM,MAAM,YAAY,GAAG,mBAAmB,CAAC"}
1
+ {"version":3,"file":"LaunchConfig.d.ts","sourceRoot":"","sources":["../../../../src/spec/feature/subflow/LaunchConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAChE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAE9D;;;;;;;;EAQE;AACF,MAAM,MAAM,YAAY,GAAG,mBAAmB,GAAG,kBAAkB,CAAC"}
@@ -0,0 +1,58 @@
1
+ import type { JsonElement } from '../../JsonElement';
2
+ /**
3
+ * Launches a [com.wise.dynamicflow.feature.subflow.Subflow] that is handled by native platform functionality.
4
+ * Native subflows let a DF flow hand off to functionality that cannot be implemented within the spec,
5
+ * while still using the standard subflow completion and error callbacks. This is useful for platform capabilities
6
+ * and SDKs, for example, biometric authentication, passkey enrolment, permissions, or external SDKs.
7
+ * The native flow must be handled by a native subflow handler registered on the client. The `id` in this launch
8
+ * config is used to route to that handler, and will match the capability ID that the client advertises in the
9
+ * `X-DF-Native-Capabilities` header.
10
+ * If the client receives a native launch config and cannot find a handler for the `id`, the subflow is treated as failed
11
+ * and the parent subflow's `onError` behavior is triggered.
12
+ * Native subflow handler integration is platform-specific, so reasonable divergence between clients is expected
13
+ * when it helps provide the most complete implementation.
14
+ * ## When to use
15
+ * - When a flow needs to launch a native capability, browser capability, or SDK that Dynamic Flow cannot render.
16
+ * - When the parent flow needs a structured result from that native capability before continuing.
17
+ * - When clients with a registered handler should get a native experience and other clients should get a fallback.
18
+ * ## When not to use
19
+ * - To custom render components of a DF step, continue to use traditional custom rendering solutions.
20
+ * ## Checking support
21
+ * We expect simple client platform and version checks to be sufficient for most use cases. Some use cases need
22
+ * more in-depth information about the client integration. Backend implementations can use
23
+ * [com.wise.dynamicflow.misc.NativeCapabilities] before returning a native subflow when they need more specific
24
+ * information, such as SDK version requirements or whether a supported native subflow has the required hardware
25
+ * available.
26
+ * Integrations report their IDs by default because IDs are mandatory at integration sites. Integrations can also
27
+ * provide comments for more detailed capability information.
28
+ * ## Result handling
29
+ * Dynamic Flow passes the `id`, optional `payload`, and any additional context required by the platform to the
30
+ * native handler. On success, the handler
31
+ * returns a JSON-compatible result. If `onCompletion` is an [com.wise.dynamicflow.feature.ActionBehavior], that
32
+ * result is merged into the action payload using `resultKey`, following the same rules as a dynamic subflow.
33
+ * ## Payload guidance
34
+ * Use `payload` for configuration that the native handler needs to launch the experience. Keep it small, stable,
35
+ * and specific to the handler. Clients should not include the payload in analytics.
36
+ * ## Experience
37
+ * Unlike dynamic subflows, native subflows only have as much control over the navigation stack as the platform
38
+ * allows. It is generally the handler's responsibility to decide the navigation semantics.
39
+ */
40
+ export type NativeLaunchConfig = {
41
+ /**
42
+ * It must be `native`.
43
+ */
44
+ type: 'native';
45
+ /**
46
+ * Identifies which native flow should be launched.
47
+ * This ID must match a handler registered on the client platform. By convention, it should also match the
48
+ * capability ID advertised by the client in the `X-DF-Native-Capabilities` header.
49
+ */
50
+ id: string;
51
+ /**
52
+ * Optional configuration payload for the native flow.
53
+ * The structure is determined by the native handler implementation. The payload should contain only the
54
+ * configuration needed to launch the native experience, and should not be included in analytics.
55
+ */
56
+ payload?: JsonElement;
57
+ };
58
+ //# sourceMappingURL=NativeLaunchConfig.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"NativeLaunchConfig.d.ts","sourceRoot":"","sources":["../../../../src/spec/feature/subflow/NativeLaunchConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqCE;AACF,MAAM,MAAM,kBAAkB,GAAG;IAC7B;;MAEE;IACF,IAAI,EAAE,QAAQ,CAAC;IACf;;;;MAIE;IACF,EAAE,EAAE,MAAM,CAAC;IACX;;;;MAIE;IACF,OAAO,CAAC,EAAE,WAAW,CAAC;CACzB,CAAC"}
@@ -16,6 +16,7 @@ export type { ActionBehavior } from './feature/ActionBehavior';
16
16
  export type { Behavior } from './feature/Behavior';
17
17
  export type { CopyBehavior } from './feature/CopyBehavior';
18
18
  export type { DismissBehavior } from './feature/DismissBehavior';
19
+ export type { DownloadBehavior } from './feature/DownloadBehavior';
19
20
  export type { LinkBehavior } from './feature/LinkBehavior';
20
21
  export type { ModalBehavior } from './feature/ModalBehavior';
21
22
  export type { RefreshBehavior } from './feature/RefreshBehavior';
@@ -42,7 +43,6 @@ export type { AlertLayoutCallToAction } from './layout/AlertLayoutCallToAction';
42
43
  export type { BoxLayout } from './layout/BoxLayout';
43
44
  export type { ButtonLayout } from './layout/ButtonLayout';
44
45
  export type { ColumnsLayout } from './layout/ColumnsLayout';
45
- export type { CollectionLayout, CollectionCallToAction, CollectionFilter, CollectionSearch, CollectionState, CollectionSection, CollectionItem, CollectionResponse, } from './layout/CollectionLayout';
46
46
  export type { DecisionLayout } from './layout/DecisionLayout';
47
47
  export type { DecisionLayoutOption } from './layout/DecisionLayoutOption';
48
48
  export type { DividerLayout } from './layout/DividerLayout';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/spec/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,UAAU,IAAI,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAE7E,YAAY,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC/C,YAAY,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,YAAY,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAC;AACjF,YAAY,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D,YAAY,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,YAAY,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC/D,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,YAAY,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AACnE,YAAY,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AACnE,YAAY,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAC;AACjF,YAAY,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,YAAY,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAE3E,YAAY,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC/D,YAAY,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACnD,YAAY,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D,YAAY,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,YAAY,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,YAAY,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,YAAY,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAEjE,YAAY,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD,YAAY,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAClE,YAAY,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,YAAY,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,YAAY,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAC1C,YAAY,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAC5E,YAAY,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,YAAY,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACxC,YAAY,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAC1C,YAAY,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,YAAY,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,YAAY,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAChD,YAAY,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,YAAY,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,YAAY,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,YAAY,EAAE,IAAI,IAAI,MAAM,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACxD,YAAY,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAChF,YAAY,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,YAAY,EACV,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,iBAAiB,EACjB,cAAc,EACd,kBAAkB,GACnB,MAAM,2BAA2B,CAAC;AACnC,YAAY,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,YAAY,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,YAAY,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,YAAY,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,YAAY,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,YAAY,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,YAAY,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,YAAY,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,YAAY,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,YAAY,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,YAAY,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,YAAY,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,YAAY,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,YAAY,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,YAAY,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,YAAY,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,YAAY,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,YAAY,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AACpF,YAAY,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,YAAY,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,YAAY,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,YAAY,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,YAAY,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAElF,MAAM,MAAM,UAAU,GAAG,mBAAmB,GAAG;IAAE,MAAM,CAAC,EAAE,SAAS,CAAA;CAAE,CAAC;AAEtE,YAAY,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAChF,YAAY,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACxE,YAAY,EAAE,wBAAwB,EAAE,MAAM,6CAA6C,CAAC;AAC5F,YAAY,EAAE,yBAAyB,EAAE,MAAM,8CAA8C,CAAC;AAC9F,YAAY,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AACpE,YAAY,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAChF,YAAY,EAAE,yBAAyB,EAAE,MAAM,8CAA8C,CAAC;AAC9F,YAAY,EAAE,0BAA0B,EAAE,MAAM,+CAA+C,CAAC;AAEhG,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE1D,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,YAAY,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,YAAY,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAEtE,YAAY,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAChF,YAAY,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,YAAY,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,YAAY,EAAE,mBAAmB,EAAE,MAAM,yCAAyC,CAAC;AAEnF,YAAY,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACzD,YAAY,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AACrE,YAAY,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAEjE,YAAY,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAExC,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEvF,MAAM,MAAM,KAAK,GAAG,WAAW,CAAC;AAChC,MAAM,MAAM,eAAe,GAAG,WAAW,CAAC;AAE1C,MAAM,MAAM,SAAS,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAEzC,OAAO,EACL,YAAY,EACZ,sBAAsB,EACtB,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,mBAAmB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/spec/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,UAAU,IAAI,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAE7E,YAAY,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC/C,YAAY,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,YAAY,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAC;AACjF,YAAY,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D,YAAY,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,YAAY,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC/D,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,YAAY,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AACnE,YAAY,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AACnE,YAAY,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAC;AACjF,YAAY,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,YAAY,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAE3E,YAAY,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC/D,YAAY,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACnD,YAAY,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D,YAAY,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACnE,YAAY,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,YAAY,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,YAAY,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAEjE,YAAY,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD,YAAY,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAClE,YAAY,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,YAAY,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,YAAY,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAC1C,YAAY,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAC5E,YAAY,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,YAAY,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACxC,YAAY,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAC1C,YAAY,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,YAAY,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,YAAY,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAChD,YAAY,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,YAAY,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,YAAY,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,YAAY,EAAE,IAAI,IAAI,MAAM,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACxD,YAAY,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAChF,YAAY,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,YAAY,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,YAAY,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,YAAY,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,YAAY,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,YAAY,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,YAAY,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,YAAY,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,YAAY,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,YAAY,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,YAAY,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,YAAY,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,YAAY,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,YAAY,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,YAAY,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,YAAY,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,YAAY,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,YAAY,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,YAAY,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AACpF,YAAY,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,YAAY,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,YAAY,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,YAAY,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,YAAY,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAElF,MAAM,MAAM,UAAU,GAAG,mBAAmB,GAAG;IAAE,MAAM,CAAC,EAAE,SAAS,CAAA;CAAE,CAAC;AAEtE,YAAY,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAChF,YAAY,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACxE,YAAY,EAAE,wBAAwB,EAAE,MAAM,6CAA6C,CAAC;AAC5F,YAAY,EAAE,yBAAyB,EAAE,MAAM,8CAA8C,CAAC;AAC9F,YAAY,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AACpE,YAAY,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAChF,YAAY,EAAE,yBAAyB,EAAE,MAAM,8CAA8C,CAAC;AAC9F,YAAY,EAAE,0BAA0B,EAAE,MAAM,+CAA+C,CAAC;AAEhG,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE1D,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,YAAY,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,YAAY,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAEtE,YAAY,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAChF,YAAY,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,YAAY,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,YAAY,EAAE,mBAAmB,EAAE,MAAM,yCAAyC,CAAC;AAEnF,YAAY,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACzD,YAAY,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AACrE,YAAY,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAEjE,YAAY,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAExC,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEvF,MAAM,MAAM,KAAK,GAAG,WAAW,CAAC;AAChC,MAAM,MAAM,eAAe,GAAG,WAAW,CAAC;AAE1C,MAAM,MAAM,SAAS,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAEzC,OAAO,EACL,YAAY,EACZ,sBAAsB,EACtB,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,mBAAmB,CAAC"}
@@ -4,6 +4,11 @@ import type { AlertLayoutCallToAction } from './AlertLayoutCallToAction';
4
4
  /**
5
5
  * Show an attention-grabbing message.
6
6
  * Alerts can be used to communicate important messages to the user, drawing more attention than a standard paragraph or info layout.
7
+ * <!-- fixture: alert -->
8
+ * ## When to use
9
+ * - When the user needs to perform an action, or be aware of some key information that may impact them.
10
+ * ## When not to use
11
+ * - When the content is supplementary, consider using an [UpsellLayout] instead.
7
12
  */
8
13
  export type AlertLayout = {
9
14
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"AlertLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/AlertLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AAExE;;;EAGE;AACF,MAAM,MAAM,WAAW,GAAG;IACtB;;MAEE;IACF,IAAI,EAAE,OAAO,CAAC;IACd;;;MAGE;IACF,QAAQ,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,YAAY,CAAC,EAAE,uBAAuB,CAAC;IACvC;;MAEE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;MAEE;IACF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"AlertLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/AlertLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AAExE;;;;;;;;EAQE;AACF,MAAM,MAAM,WAAW,GAAG;IACtB;;MAEE;IACF,IAAI,EAAE,OAAO,CAAC;IACd;;;MAGE;IACF,QAAQ,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;MAEE;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;MAEE;IACF,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;MAEE;IACF,YAAY,CAAC,EAAE,uBAAuB,CAAC;IACvC;;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 Alert.
4
+ * The call to action configuration to be used by [com.wise.dynamicflow.layout.AlertLayout].
5
5
  */
6
6
  export type AlertLayoutCallToAction = {
7
7
  /**
@@ -13,7 +13,7 @@ export type AlertLayoutCallToAction = {
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 { Layout } from './Layout';
2
2
  import type { Size } from '../misc/Size';
3
3
  /**
4
4
  * A container for a group of components with an optional border.
5
+ * <!-- fixture: box -->
5
6
  */
6
7
  export type BoxLayout = {
7
8
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"BoxLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/BoxLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACtC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;EAEE;AACF,MAAM,MAAM,SAAS,GAAG;IACpB;;MAEE;IACF,IAAI,EAAE,KAAK,CAAC;IACZ;;MAEE;IACF,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB;;MAEE;IACF,KAAK,CAAC,EAAE,IAAI,CAAC;IACb;;;MAGE;IACF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;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":"BoxLayout.d.ts","sourceRoot":"","sources":["../../../src/spec/layout/BoxLayout.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACtC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAExC;;;EAGE;AACF,MAAM,MAAM,SAAS,GAAG;IACpB;;MAEE;IACF,IAAI,EAAE,KAAK,CAAC;IACZ;;MAEE;IACF,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB;;MAEE;IACF,KAAK,CAAC,EAAE,IAAI,CAAC;IACb;;;MAGE;IACF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;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"}
@@ -5,7 +5,7 @@ import type { Context } from '../misc/Context';
5
5
  import type { Media } from '../misc/media/Media';
6
6
  /**
7
7
  * A component which performs a [com.wise.dynamicflow.feature.Behavior] when pressed.
8
- * You can affect the button appearance using the "control" and "context" properties.
8
+ * <!-- fixture: button -->
9
9
  */
10
10
  export type ButtonLayout = {
11
11
  /**
@@ -4,6 +4,7 @@ import type { Size } from '../misc/Size';
4
4
  /**
5
5
  * Allows content to be displayed in two columns.
6
6
  * If screen space is limited, the contents will be collapsed into a single column.
7
+ * <!-- fixture: columns -->
7
8
  */
8
9
  export type ColumnsLayout = {
9
10
  /**
@@ -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
  /**