@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,5 +1,6 @@
1
1
  import { Media } from './Media';
2
2
  import { BaseRendererProps } from './RendererProps';
3
+ import { InlineAlert } from './constants';
3
4
  export type BaseInputRendererProps = BaseRendererProps & {
4
5
  id: string;
5
6
  description?: string;
@@ -8,6 +9,8 @@ export type BaseInputRendererProps = BaseRendererProps & {
8
9
  placeholder?: string;
9
10
  required: boolean;
10
11
  validationState: ValidationResult | undefined;
12
+ inlineAlert?: InlineAlert;
13
+ fieldLoadingState: FieldLoadingState;
11
14
  media?: Media;
12
15
  title?: string;
13
16
  onBlur: () => void;
@@ -20,4 +23,6 @@ export type ValidationResult = {
20
23
  status: 'invalid';
21
24
  message: string;
22
25
  };
26
+ type FieldLoadingState = 'idle' | 'validating' | 'persisting';
27
+ export {};
23
28
  //# sourceMappingURL=BaseInputRendererProps.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"BaseInputRendererProps.d.ts","sourceRoot":"","sources":["../../src/renderers/BaseInputRendererProps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,GAAG;IACvD,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,eAAe,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAC9C,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACxB;IACE,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GACD;IACE,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}
1
+ {"version":3,"file":"BaseInputRendererProps.d.ts","sourceRoot":"","sources":["../../src/renderers/BaseInputRendererProps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,GAAG;IACvD,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,eAAe,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAC9C,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACxB;IACE,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GACD;IACE,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEN,KAAK,iBAAiB,GAAG,MAAM,GAAG,YAAY,GAAG,YAAY,CAAC"}
@@ -1,7 +1,6 @@
1
1
  import type { JSX } from 'react';
2
2
  import type { AlertRendererProps } from './AlertRendererProps';
3
3
  import type { BoxRendererProps } from './BoxRendererProps';
4
- import type { CollectionRendererProps } from './CollectionRendererProps';
5
4
  import type { ButtonRendererProps } from './ButtonRendererProps';
6
5
  import type { CheckboxInputRendererProps } from './CheckboxInputRendererProps';
7
6
  import type { ColumnsRendererProps } from './ColumnsRendererProps';
@@ -16,11 +15,11 @@ import type { FormSectionRendererProps } from './FormSectionRendererProps';
16
15
  import type { HeadingRendererProps } from './HeadingRendererProps';
17
16
  import type { HiddenRendererProps } from './HiddenRendererProps';
18
17
  import type { ImageRendererProps } from './ImageRendererProps';
19
- import type { LoadingStateRendererProps } from './LoadingStateRendererProps';
20
18
  import type { InstructionsRendererProps } from './InstructionsRendererProps';
21
19
  import type { IntegerInputRendererProps } from './IntegerInputRendererProps';
22
20
  import type { ListRendererProps } from './ListRendererProps';
23
21
  import type { LoadingIndicatorRendererProps } from './LoadingIndicatorRendererProps';
22
+ import type { LoadingStateRendererProps } from './LoadingStateRendererProps';
24
23
  import type { MarkdownRendererProps } from './MarkdownRendererProps';
25
24
  import type { MediaRendererProps } from './MediaRendererProps';
26
25
  import type { ModalLayoutRendererProps } from './ModalLayoutRendererProps';
@@ -39,12 +38,12 @@ import type { SectionRendererProps } from './SectionRendererProps';
39
38
  import type { SelectInputRendererProps } from './SelectInputRendererProps';
40
39
  import type { StatusListRendererProps } from './StatusListRendererProps';
41
40
  import type { AnalyticsEventDispatcher, LoadingState, StepRendererProps } from './StepRendererProps';
42
- import { SubflowRendererProps } from './SubflowRendererProps';
41
+ import { NativeSubflowRendererProps, DynamicSubflowRendererProps } from './SubflowRendererProps';
43
42
  import { TabsRendererProps } from './TabsRendererProps';
44
43
  import type { TextInputRendererProps } from './TextInputRendererProps';
45
44
  import type { UploadInputRendererProps } from './UploadInputRendererProps';
46
45
  import type { UpsellRendererProps } from './UpsellRendererProps';
47
- export type RendererProps = AlertRendererProps | CheckboxInputRendererProps | BoxRendererProps | CollectionRendererProps | ButtonRendererProps | CollectionRendererProps | ColumnsRendererProps | CoreContainerRendererProps | DateInputRendererProps | DecisionRendererProps | DividerRendererProps | ExternalConfirmationRendererProps | FormattedValueRendererProps | FormRendererProps | HeadingRendererProps | HiddenRendererProps | ImageRendererProps | LoadingStateRendererProps | InstructionsRendererProps | IntegerInputRendererProps | ListRendererProps | LoadingIndicatorRendererProps | MarkdownRendererProps | MediaRendererProps | ModalLayoutRendererProps | ModalRendererProps | MoneyInputRendererProps | MultiSelectInputRendererProps | MultiUploadInputRendererProps | NumberInputRendererProps | ParagraphRendererProps | ProgressRendererProps | RepeatableRendererProps | ReviewRendererProps | RootRendererProps | SearchRendererProps | FormSectionRendererProps | SelectInputRendererProps | SectionRendererProps | StatusListRendererProps | StepRendererProps | SubflowRendererProps | TabsRendererProps | TextInputRendererProps | UploadInputRendererProps | UpsellRendererProps;
46
+ export type RendererProps = AlertRendererProps | CheckboxInputRendererProps | BoxRendererProps | ButtonRendererProps | ColumnsRendererProps | CoreContainerRendererProps | DateInputRendererProps | DecisionRendererProps | DividerRendererProps | ExternalConfirmationRendererProps | FormattedValueRendererProps | FormRendererProps | HeadingRendererProps | HiddenRendererProps | ImageRendererProps | LoadingStateRendererProps | InstructionsRendererProps | IntegerInputRendererProps | ListRendererProps | LoadingIndicatorRendererProps | MarkdownRendererProps | MediaRendererProps | ModalLayoutRendererProps | ModalRendererProps | MoneyInputRendererProps | MultiSelectInputRendererProps | MultiUploadInputRendererProps | NativeSubflowRendererProps | NumberInputRendererProps | ParagraphRendererProps | ProgressRendererProps | RepeatableRendererProps | ReviewRendererProps | RootRendererProps | SearchRendererProps | FormSectionRendererProps | SelectInputRendererProps | SectionRendererProps | StatusListRendererProps | StepRendererProps | DynamicSubflowRendererProps | TabsRendererProps | TextInputRendererProps | UploadInputRendererProps | UpsellRendererProps;
48
47
  export type Renderer<P extends RendererProps> = {
49
48
  canRenderType: P['type'];
50
49
  canRender?: (props: P) => boolean;
@@ -54,7 +53,7 @@ export type RendererContext = {
54
53
  render: RenderFunction;
55
54
  };
56
55
  export type RenderFunction = (props: RendererProps | null) => JSX.Element | null;
57
- export type Renderers = readonly (Renderer<StepRendererProps> | Renderer<CoreContainerRendererProps> | Renderer<AlertRendererProps> | Renderer<BoxRendererProps> | Renderer<CollectionRendererProps> | Renderer<ColumnsRendererProps> | Renderer<DecisionRendererProps> | Renderer<DividerRendererProps> | Renderer<ExternalConfirmationRendererProps> | Renderer<FormattedValueRendererProps> | Renderer<FormRendererProps> | Renderer<HeadingRendererProps> | Renderer<LoadingStateRendererProps> | Renderer<InstructionsRendererProps> | Renderer<ListRendererProps> | Renderer<LoadingIndicatorRendererProps> | Renderer<MarkdownRendererProps> | Renderer<ImageRendererProps> | Renderer<MediaRendererProps> | Renderer<ModalLayoutRendererProps> | Renderer<ModalRendererProps> | Renderer<ParagraphRendererProps> | Renderer<ProgressRendererProps> | Renderer<ReviewRendererProps> | Renderer<SearchRendererProps> | Renderer<StatusListRendererProps> | Renderer<CheckboxInputRendererProps> | Renderer<ButtonRendererProps> | Renderer<DateInputRendererProps> | Renderer<HiddenRendererProps> | Renderer<IntegerInputRendererProps> | Renderer<MoneyInputRendererProps> | Renderer<NumberInputRendererProps> | Renderer<RepeatableRendererProps> | Renderer<RootRendererProps> | Renderer<FormSectionRendererProps> | Renderer<SelectInputRendererProps> | Renderer<SectionRendererProps> | Renderer<SubflowRendererProps> | Renderer<MultiSelectInputRendererProps> | Renderer<TabsRendererProps> | Renderer<TextInputRendererProps> | Renderer<UploadInputRendererProps> | Renderer<MultiUploadInputRendererProps> | Renderer<UpsellRendererProps>)[];
56
+ export type Renderers = readonly (Renderer<StepRendererProps> | Renderer<CoreContainerRendererProps> | Renderer<AlertRendererProps> | Renderer<BoxRendererProps> | Renderer<ColumnsRendererProps> | Renderer<DecisionRendererProps> | Renderer<DividerRendererProps> | Renderer<ExternalConfirmationRendererProps> | Renderer<FormattedValueRendererProps> | Renderer<FormRendererProps> | Renderer<HeadingRendererProps> | Renderer<LoadingStateRendererProps> | Renderer<InstructionsRendererProps> | Renderer<ListRendererProps> | Renderer<LoadingIndicatorRendererProps> | Renderer<MarkdownRendererProps> | Renderer<ImageRendererProps> | Renderer<MediaRendererProps> | Renderer<ModalLayoutRendererProps> | Renderer<ModalRendererProps> | Renderer<ParagraphRendererProps> | Renderer<ProgressRendererProps> | Renderer<ReviewRendererProps> | Renderer<SearchRendererProps> | Renderer<StatusListRendererProps> | Renderer<CheckboxInputRendererProps> | Renderer<ButtonRendererProps> | Renderer<DateInputRendererProps> | Renderer<HiddenRendererProps> | Renderer<IntegerInputRendererProps> | Renderer<MoneyInputRendererProps> | Renderer<NativeSubflowRendererProps> | Renderer<NumberInputRendererProps> | Renderer<RepeatableRendererProps> | Renderer<RootRendererProps> | Renderer<FormSectionRendererProps> | Renderer<SelectInputRendererProps> | Renderer<SectionRendererProps> | Renderer<DynamicSubflowRendererProps> | Renderer<MultiSelectInputRendererProps> | Renderer<TabsRendererProps> | Renderer<TextInputRendererProps> | Renderer<UploadInputRendererProps> | Renderer<MultiUploadInputRendererProps> | Renderer<UpsellRendererProps>)[];
58
57
  export type BaseRendererProps = {
59
58
  uid: string;
60
59
  analyticsId?: string;
@@ -1 +1 @@
1
- {"version":3,"file":"RendererProps.d.ts","sourceRoot":"","sources":["../../src/renderers/RendererProps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC/E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC/E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AAC7F,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AACjF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACrF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACrF,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACrF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,KAAK,EACV,wBAAwB,EACxB,YAAY,EACZ,iBAAiB,EAClB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,aAAa,GACrB,kBAAkB,GAClB,0BAA0B,GAC1B,gBAAgB,GAChB,uBAAuB,GACvB,mBAAmB,GACnB,uBAAuB,GACvB,oBAAoB,GACpB,0BAA0B,GAC1B,sBAAsB,GACtB,qBAAqB,GACrB,oBAAoB,GACpB,iCAAiC,GACjC,2BAA2B,GAC3B,iBAAiB,GACjB,oBAAoB,GACpB,mBAAmB,GACnB,kBAAkB,GAClB,yBAAyB,GACzB,yBAAyB,GACzB,yBAAyB,GACzB,iBAAiB,GACjB,6BAA6B,GAC7B,qBAAqB,GACrB,kBAAkB,GAClB,wBAAwB,GACxB,kBAAkB,GAClB,uBAAuB,GACvB,6BAA6B,GAC7B,6BAA6B,GAC7B,wBAAwB,GACxB,sBAAsB,GACtB,qBAAqB,GACrB,uBAAuB,GACvB,mBAAmB,GACnB,iBAAiB,GACjB,mBAAmB,GACnB,wBAAwB,GACxB,wBAAwB,GACxB,oBAAoB,GACpB,uBAAuB,GACvB,iBAAiB,GACjB,oBAAoB,GACpB,iBAAiB,GACjB,sBAAsB,GACtB,wBAAwB,GACxB,mBAAmB,CAAC;AAExB,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,aAAa,IAAI;IAC9C,aAAa,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;IACzB,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC;IAClC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI,KAAK,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC;AAEjF,MAAM,MAAM,SAAS,GAAG,SAAS,CAC7B,QAAQ,CAAC,iBAAiB,CAAC,GAC3B,QAAQ,CAAC,0BAA0B,CAAC,GACpC,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,QAAQ,CAAC,gBAAgB,CAAC,GAC1B,QAAQ,CAAC,uBAAuB,CAAC,GACjC,QAAQ,CAAC,oBAAoB,CAAC,GAC9B,QAAQ,CAAC,qBAAqB,CAAC,GAC/B,QAAQ,CAAC,oBAAoB,CAAC,GAC9B,QAAQ,CAAC,iCAAiC,CAAC,GAC3C,QAAQ,CAAC,2BAA2B,CAAC,GACrC,QAAQ,CAAC,iBAAiB,CAAC,GAC3B,QAAQ,CAAC,oBAAoB,CAAC,GAC9B,QAAQ,CAAC,yBAAyB,CAAC,GACnC,QAAQ,CAAC,yBAAyB,CAAC,GACnC,QAAQ,CAAC,iBAAiB,CAAC,GAC3B,QAAQ,CAAC,6BAA6B,CAAC,GACvC,QAAQ,CAAC,qBAAqB,CAAC,GAC/B,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,QAAQ,CAAC,wBAAwB,CAAC,GAClC,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,QAAQ,CAAC,sBAAsB,CAAC,GAChC,QAAQ,CAAC,qBAAqB,CAAC,GAC/B,QAAQ,CAAC,mBAAmB,CAAC,GAC7B,QAAQ,CAAC,mBAAmB,CAAC,GAC7B,QAAQ,CAAC,uBAAuB,CAAC,GACjC,QAAQ,CAAC,0BAA0B,CAAC,GACpC,QAAQ,CAAC,mBAAmB,CAAC,GAC7B,QAAQ,CAAC,sBAAsB,CAAC,GAChC,QAAQ,CAAC,mBAAmB,CAAC,GAC7B,QAAQ,CAAC,yBAAyB,CAAC,GACnC,QAAQ,CAAC,uBAAuB,CAAC,GACjC,QAAQ,CAAC,wBAAwB,CAAC,GAClC,QAAQ,CAAC,uBAAuB,CAAC,GACjC,QAAQ,CAAC,iBAAiB,CAAC,GAC3B,QAAQ,CAAC,wBAAwB,CAAC,GAClC,QAAQ,CAAC,wBAAwB,CAAC,GAClC,QAAQ,CAAC,oBAAoB,CAAC,GAC9B,QAAQ,CAAC,oBAAoB,CAAC,GAC9B,QAAQ,CAAC,6BAA6B,CAAC,GACvC,QAAQ,CAAC,iBAAiB,CAAC,GAC3B,QAAQ,CAAC,sBAAsB,CAAC,GAChC,QAAQ,CAAC,wBAAwB,CAAC,GAClC,QAAQ,CAAC,6BAA6B,CAAC,GACvC,QAAQ,CAAC,mBAAmB,CAAC,CAChC,EAAE,CAAC;AAEJ,MAAM,MAAM,iBAAiB,GAAG;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,cAAc,CAAC;IACvB,UAAU,EAAE,OAAO,KAAK,CAAC;IACzB,UAAU,EAAE,wBAAwB,CAAC;IACrC,gBAAgB,EAAE,YAAY,CAAC;IAC/B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC"}
1
+ {"version":3,"file":"RendererProps.d.ts","sourceRoot":"","sources":["../../src/renderers/RendererProps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC/E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC/E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AAC7F,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AACjF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACrF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACrF,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACrF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,KAAK,EACV,wBAAwB,EACxB,YAAY,EACZ,iBAAiB,EAClB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AACjG,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,aAAa,GACrB,kBAAkB,GAClB,0BAA0B,GAC1B,gBAAgB,GAChB,mBAAmB,GACnB,oBAAoB,GACpB,0BAA0B,GAC1B,sBAAsB,GACtB,qBAAqB,GACrB,oBAAoB,GACpB,iCAAiC,GACjC,2BAA2B,GAC3B,iBAAiB,GACjB,oBAAoB,GACpB,mBAAmB,GACnB,kBAAkB,GAClB,yBAAyB,GACzB,yBAAyB,GACzB,yBAAyB,GACzB,iBAAiB,GACjB,6BAA6B,GAC7B,qBAAqB,GACrB,kBAAkB,GAClB,wBAAwB,GACxB,kBAAkB,GAClB,uBAAuB,GACvB,6BAA6B,GAC7B,6BAA6B,GAC7B,0BAA0B,GAC1B,wBAAwB,GACxB,sBAAsB,GACtB,qBAAqB,GACrB,uBAAuB,GACvB,mBAAmB,GACnB,iBAAiB,GACjB,mBAAmB,GACnB,wBAAwB,GACxB,wBAAwB,GACxB,oBAAoB,GACpB,uBAAuB,GACvB,iBAAiB,GACjB,2BAA2B,GAC3B,iBAAiB,GACjB,sBAAsB,GACtB,wBAAwB,GACxB,mBAAmB,CAAC;AAExB,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,aAAa,IAAI;IAC9C,aAAa,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;IACzB,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC;IAClC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI,KAAK,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC;AAEjF,MAAM,MAAM,SAAS,GAAG,SAAS,CAC7B,QAAQ,CAAC,iBAAiB,CAAC,GAC3B,QAAQ,CAAC,0BAA0B,CAAC,GACpC,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,QAAQ,CAAC,gBAAgB,CAAC,GAC1B,QAAQ,CAAC,oBAAoB,CAAC,GAC9B,QAAQ,CAAC,qBAAqB,CAAC,GAC/B,QAAQ,CAAC,oBAAoB,CAAC,GAC9B,QAAQ,CAAC,iCAAiC,CAAC,GAC3C,QAAQ,CAAC,2BAA2B,CAAC,GACrC,QAAQ,CAAC,iBAAiB,CAAC,GAC3B,QAAQ,CAAC,oBAAoB,CAAC,GAC9B,QAAQ,CAAC,yBAAyB,CAAC,GACnC,QAAQ,CAAC,yBAAyB,CAAC,GACnC,QAAQ,CAAC,iBAAiB,CAAC,GAC3B,QAAQ,CAAC,6BAA6B,CAAC,GACvC,QAAQ,CAAC,qBAAqB,CAAC,GAC/B,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,QAAQ,CAAC,wBAAwB,CAAC,GAClC,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,QAAQ,CAAC,sBAAsB,CAAC,GAChC,QAAQ,CAAC,qBAAqB,CAAC,GAC/B,QAAQ,CAAC,mBAAmB,CAAC,GAC7B,QAAQ,CAAC,mBAAmB,CAAC,GAC7B,QAAQ,CAAC,uBAAuB,CAAC,GACjC,QAAQ,CAAC,0BAA0B,CAAC,GACpC,QAAQ,CAAC,mBAAmB,CAAC,GAC7B,QAAQ,CAAC,sBAAsB,CAAC,GAChC,QAAQ,CAAC,mBAAmB,CAAC,GAC7B,QAAQ,CAAC,yBAAyB,CAAC,GACnC,QAAQ,CAAC,uBAAuB,CAAC,GACjC,QAAQ,CAAC,0BAA0B,CAAC,GACpC,QAAQ,CAAC,wBAAwB,CAAC,GAClC,QAAQ,CAAC,uBAAuB,CAAC,GACjC,QAAQ,CAAC,iBAAiB,CAAC,GAC3B,QAAQ,CAAC,wBAAwB,CAAC,GAClC,QAAQ,CAAC,wBAAwB,CAAC,GAClC,QAAQ,CAAC,oBAAoB,CAAC,GAC9B,QAAQ,CAAC,2BAA2B,CAAC,GACrC,QAAQ,CAAC,6BAA6B,CAAC,GACvC,QAAQ,CAAC,iBAAiB,CAAC,GAC3B,QAAQ,CAAC,sBAAsB,CAAC,GAChC,QAAQ,CAAC,wBAAwB,CAAC,GAClC,QAAQ,CAAC,6BAA6B,CAAC,GACvC,QAAQ,CAAC,mBAAmB,CAAC,CAChC,EAAE,CAAC;AAEJ,MAAM,MAAM,iBAAiB,GAAG;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,cAAc,CAAC;IACvB,UAAU,EAAE,OAAO,KAAK,CAAC;IACzB,UAAU,EAAE,wBAAwB,CAAC;IACrC,gBAAgB,EAAE,YAAY,CAAC;IAC/B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC"}
@@ -1,12 +1,25 @@
1
1
  import { JsonElement, Request } from '../spec';
2
2
  import { BaseRendererProps } from './RendererProps';
3
3
  import { AnalyticsEventDispatcher } from './StepRendererProps';
4
+ type BaseSubflowRendererProps = BaseRendererProps & {
5
+ onCompletion: (result: JsonElement) => void;
6
+ onError: (error: unknown, status?: number) => void;
7
+ onCancellation: () => void;
8
+ onEvent: AnalyticsEventDispatcher;
9
+ };
4
10
  /**
5
11
  * @experimental These renderer props may change in the future without notice.
6
12
  */
7
- export type SubflowRendererProps = BaseRendererProps & {
8
- type: 'subflow';
9
- uid: string;
13
+ export type NativeSubflowRendererProps = BaseSubflowRendererProps & {
14
+ type: 'subflow-native';
15
+ id: string;
16
+ payload: JsonElement | undefined;
17
+ };
18
+ /**
19
+ * @experimental These renderer props may change in the future without notice.
20
+ */
21
+ export type DynamicSubflowRendererProps = BaseSubflowRendererProps & {
22
+ type: 'subflow-dynamic';
10
23
  presentation: {
11
24
  type: 'push';
12
25
  } | {
@@ -14,13 +27,10 @@ export type SubflowRendererProps = BaseRendererProps & {
14
27
  };
15
28
  initialRequest: Request;
16
29
  requestCache?: RequestCache;
17
- onCompletion: (result: JsonElement) => void;
18
- onError: (error: unknown, status?: number) => void;
19
- onCancellation: () => void;
20
- onEvent: AnalyticsEventDispatcher;
21
30
  };
22
31
  export type RequestCache = {
23
32
  get: (requestParams: Parameters<typeof fetch>) => Promise<Response | null> | undefined;
24
33
  set: (requestParams: Parameters<typeof fetch>, responsePromise: Promise<Response | null>) => void;
25
34
  };
35
+ export {};
26
36
  //# sourceMappingURL=SubflowRendererProps.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SubflowRendererProps.d.ts","sourceRoot":"","sources":["../../src/renderers/SubflowRendererProps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,GAAG;IACrD,IAAI,EAAE,SAAS,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE,CAAC;IACnD,cAAc,EAAE,OAAO,CAAC;IACxB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,YAAY,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC;IAC5C,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACnD,cAAc,EAAE,MAAM,IAAI,CAAC;IAC3B,OAAO,EAAE,wBAAwB,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE,CAAC,aAAa,EAAE,UAAU,CAAC,OAAO,KAAK,CAAC,KAAK,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;IACvF,GAAG,EAAE,CAAC,aAAa,EAAE,UAAU,CAAC,OAAO,KAAK,CAAC,EAAE,eAAe,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC;CACnG,CAAC"}
1
+ {"version":3,"file":"SubflowRendererProps.d.ts","sourceRoot":"","sources":["../../src/renderers/SubflowRendererProps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAE/D,KAAK,wBAAwB,GAAG,iBAAiB,GAAG;IAClD,YAAY,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC;IAC5C,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACnD,cAAc,EAAE,MAAM,IAAI,CAAC;IAC3B,OAAO,EAAE,wBAAwB,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,wBAAwB,GAAG;IAClE,IAAI,EAAE,gBAAgB,CAAC;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,WAAW,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,wBAAwB,GAAG;IACnE,IAAI,EAAE,iBAAiB,CAAC;IACxB,YAAY,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE,CAAC;IACnD,cAAc,EAAE,OAAO,CAAC;IACxB,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE,CAAC,aAAa,EAAE,UAAU,CAAC,OAAO,KAAK,CAAC,KAAK,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;IACvF,GAAG,EAAE,CAAC,aAAa,EAAE,UAAU,CAAC,OAAO,KAAK,CAAC,EAAE,eAAe,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC;CACnG,CAAC"}
@@ -1,6 +1,8 @@
1
+ import type { JSX } from 'react';
2
+ import { JsonElement, Presentation } from '../spec';
3
+ import { NativeSubflowRendererProps } from './SubflowRendererProps';
1
4
  export type { AlertRendererProps } from './AlertRendererProps';
2
5
  export type { BoxRendererProps } from './BoxRendererProps';
3
- export type { CollectionRendererProps, CollectionSection, CollectionItem, CollectionSearch, CollectionFilter, CollectionFilterOption, } from './CollectionRendererProps';
4
6
  export type { ButtonRendererProps } from './ButtonRendererProps';
5
7
  export type { CheckboxInputRendererProps } from './CheckboxInputRendererProps';
6
8
  export type { ColumnsRendererProps } from './ColumnsRendererProps';
@@ -15,11 +17,11 @@ export type { FormSectionRendererProps } from './FormSectionRendererProps';
15
17
  export type { HeadingRendererProps } from './HeadingRendererProps';
16
18
  export type { HiddenRendererProps } from './HiddenRendererProps';
17
19
  export type { ImageRendererProps } from './ImageRendererProps';
18
- export type { LoadingStateRendererProps } from './LoadingStateRendererProps';
19
20
  export type { InstructionItem, InstructionsRendererProps } from './InstructionsRendererProps';
20
21
  export type { IntegerInputRendererProps } from './IntegerInputRendererProps';
21
22
  export type { ListRendererProps } from './ListRendererProps';
22
23
  export type { LoadingIndicatorRendererProps } from './LoadingIndicatorRendererProps';
24
+ export type { LoadingStateRendererProps } from './LoadingStateRendererProps';
23
25
  export type { MarkdownRendererProps } from './MarkdownRendererProps';
24
26
  export type { MediaRendererProps } from './MediaRendererProps';
25
27
  export type { ModalLayoutRendererProps } from './ModalLayoutRendererProps';
@@ -43,12 +45,18 @@ export type { TextInputRendererProps } from './TextInputRendererProps';
43
45
  export type { UploadInputRendererProps } from './UploadInputRendererProps';
44
46
  export type { UpsellRendererProps } from './UpsellRendererProps';
45
47
  export type { ValidationResult } from './BaseInputRendererProps';
46
- export type { SubflowRendererProps } from './SubflowRendererProps';
48
+ export type { DynamicSubflowRendererProps, NativeSubflowRendererProps, } from './SubflowRendererProps';
47
49
  export type { Align, Context, Margin, Size } from './constants';
48
50
  export type { Icon } from './Icon';
49
51
  export type { Image } from './Image';
50
- export type { Media, MediaAvatar, MediaImage, LegacyMedia, AvatarContent, AvatarTextContent, AvatarUriContent, } from './Media';
52
+ export type { AvatarContent, AvatarTextContent, AvatarUriContent, LegacyMedia, Media, MediaAvatar, MediaImage, } from './Media';
51
53
  export type { AdditionalInfo, InlineAlert, SupportingValues } from './constants';
52
54
  export type { Renderer, RendererProps, Renderers, RenderFunction } from './RendererProps';
53
55
  export type { CallToAction } from './CallToAction';
56
+ export type NativeSubflowHandler = {
57
+ id: string;
58
+ getCapabilityComments?: () => Record<string, string>;
59
+ getPresentationMode: (payload: JsonElement | undefined) => Presentation['type'];
60
+ render: (props: NativeSubflowRendererProps) => JSX.Element | null;
61
+ };
54
62
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/renderers/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,YAAY,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,YAAY,EACV,uBAAuB,EACvB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,sBAAsB,GACvB,MAAM,2BAA2B,CAAC;AACnC,YAAY,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,YAAY,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC/E,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,YAAY,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC/E,YAAY,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,YAAY,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrF,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,YAAY,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AAC7F,YAAY,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AACjF,YAAY,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,YAAY,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,YAAY,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,YAAY,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,YAAY,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAC7E,YAAY,EAAE,eAAe,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAC9F,YAAY,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAC7E,YAAY,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,YAAY,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACrF,YAAY,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,YAAY,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,YAAY,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,YAAY,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,YAAY,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACzE,YAAY,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACrF,YAAY,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACrF,YAAY,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,YAAY,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,YAAY,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,YAAY,EACV,2BAA2B,EAC3B,uBAAuB,GACxB,MAAM,2BAA2B,CAAC;AACnC,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC9E,YAAY,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,YAAY,EACV,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,YAAY,EACZ,WAAW,GACZ,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,YAAY,EACV,yBAAyB,EACzB,wBAAwB,GACzB,MAAM,4BAA4B,CAAC;AACpC,YAAY,EACV,cAAc,EACd,oBAAoB,EACpB,uBAAuB,GACxB,MAAM,2BAA2B,CAAC;AACnC,YAAY,EACV,wBAAwB,EACxB,YAAY,EACZ,iBAAiB,GAClB,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EAAE,GAAG,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAClE,YAAY,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,YAAY,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,YAAY,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,YAAY,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAEjE,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAChE,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,YAAY,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,YAAY,EACV,KAAK,EACL,WAAW,EACX,UAAU,EACV,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,SAAS,CAAC;AAEjB,YAAY,EAAE,cAAc,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEjF,YAAY,EAAE,QAAQ,EAAE,aAAa,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAE1F,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/renderers/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACpD,OAAO,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AAEpE,YAAY,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,YAAY,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,YAAY,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,YAAY,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC/E,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,YAAY,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC/E,YAAY,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,YAAY,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrF,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,YAAY,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AAC7F,YAAY,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AACjF,YAAY,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,YAAY,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,YAAY,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,YAAY,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,YAAY,EAAE,eAAe,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAC9F,YAAY,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAC7E,YAAY,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,YAAY,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACrF,YAAY,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAC7E,YAAY,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,YAAY,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,YAAY,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,YAAY,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,YAAY,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACzE,YAAY,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACrF,YAAY,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACrF,YAAY,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,YAAY,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,YAAY,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,YAAY,EACV,2BAA2B,EAC3B,uBAAuB,GACxB,MAAM,2BAA2B,CAAC;AACnC,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC9E,YAAY,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,YAAY,EACV,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,YAAY,EACZ,WAAW,GACZ,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,YAAY,EACV,yBAAyB,EACzB,wBAAwB,GACzB,MAAM,4BAA4B,CAAC;AACpC,YAAY,EACV,cAAc,EACd,oBAAoB,EACpB,uBAAuB,GACxB,MAAM,2BAA2B,CAAC;AACnC,YAAY,EACV,wBAAwB,EACxB,YAAY,EACZ,iBAAiB,GAClB,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EAAE,GAAG,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAClE,YAAY,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,YAAY,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,YAAY,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,YAAY,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAEjE,YAAY,EACV,2BAA2B,EAC3B,0BAA0B,GAC3B,MAAM,wBAAwB,CAAC;AAEhC,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAChE,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,YAAY,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,YAAY,EACV,aAAa,EACb,iBAAiB,EACjB,gBAAgB,EAChB,WAAW,EACX,KAAK,EACL,WAAW,EACX,UAAU,GACX,MAAM,SAAS,CAAC;AAEjB,YAAY,EAAE,cAAc,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEjF,YAAY,EAAE,QAAQ,EAAE,aAAa,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAE1F,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,oBAAoB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,qBAAqB,CAAC,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrD,mBAAmB,EAAE,CAAC,OAAO,EAAE,WAAW,GAAG,SAAS,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;IAChF,MAAM,EAAE,CAAC,KAAK,EAAE,0BAA0B,KAAK,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC;CACnE,CAAC"}
@@ -6,7 +6,7 @@ import type { JsonElement } from '../JsonElement';
6
6
  * An action typically defines its URL and HTTP method to submit step data, and can optionally indicate that, on success,
7
7
  * the flow must end.
8
8
  * An endpoint can respond to a submitting action with an error status code and the standard error response format in order to display errors to the user.
9
- * ### Behavior
9
+ * ## Behavior
10
10
  * If an action does not specify the `exit` property as true, it is expected that the action will submit the step payload.
11
11
  * For example, the following action is a non-exiting action.
12
12
  * ```kt
@@ -15,12 +15,12 @@ import type { JsonElement } from '../JsonElement';
15
15
  * method = HttpMethod.POST
16
16
  * }
17
17
  * ```
18
- * #### Exiting Actions
18
+ * ### Exiting Actions
19
19
  * If an action specifies `exit` as `true`, it is expected that this action should terminate the flow. For exiting actions,
20
20
  * the `url` property is optional.
21
21
  * If the `url` property is not specified, when the action is taken the flow will be terminated and the value of the result
22
22
  * property will be used as the result of the flow.
23
- * ##### Example
23
+ * #### Example
24
24
  * Given the following action:
25
25
  * ```kt
26
26
  * action {
@@ -36,18 +36,18 @@ import type { JsonElement } from '../JsonElement';
36
36
  * "someKey": "someValue"
37
37
  * }
38
38
  * ```
39
- * #### Submitting Exiting Actions (Not recommended)
39
+ * ### Submitting Exiting Actions (Not recommended)
40
40
  * If the `url` property is specified, the step payload will be submitted. On a successful response, the `result` property of the action (if provided)
41
41
  * will be merged with the response to the submission, and that combined result will be used as the result of the flow, which will terminate. In case
42
42
  * of any conflicts in the merge, the value of the result property of the action takes precedence.
43
43
  * **However, it is not recommended to use this approach.** Instead, a non-exiting action should be used to submit the step payload, and the flow should be
44
44
  * terminated by the server by returning an `X-DF-Response-Type: exit` header in the response. See "Actions Which Sometimes Exit" for more information.
45
- * #### Actions Which Sometimes Exit
45
+ * ### Actions Which Sometimes Exit
46
46
  * In some cases, the provider of the step will not know if a submitting action will exit. For example, depending on the data entered by the user,
47
47
  * the flow may be complete, or we may need to ask them some follow-up questions. In these cases the `exit` property shouldn’t be specified. Instead,
48
48
  * the response to the submission should include an `X-DF-Response-Type: exit` header. When the client receives this header
49
49
  * in the response, it will continue in the same way as it would for a submitting exiting action. See [com.wise.dynamicflow.responses.FlowResponse].
50
- * #### Summary
50
+ * ### Summary
51
51
  * This tree summarises the possible paths an action can lead to:
52
52
  * - If `exit` is `true`:
53
53
  * - If `url` is `null`:
@@ -1,6 +1,7 @@
1
1
  import type { Action } from './Action';
2
2
  /**
3
3
  * Performs an [com.wise.dynamicflow.feature.Action] when the behavior is triggered.
4
+ * <!-- fixture: actionbehavior -->
4
5
  */
5
6
  export type ActionBehavior = {
6
7
  /**
@@ -11,5 +12,10 @@ export type ActionBehavior = {
11
12
  * The action to perform
12
13
  */
13
14
  action: Action;
15
+ /**
16
+ * Additional data to be included in behavior analytics events. The keys/values in this object will be included in all events
17
+ * generated by clients.
18
+ */
19
+ analytics?: Record<string, string>;
14
20
  };
15
21
  //# sourceMappingURL=ActionBehavior.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ActionBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/ActionBehavior.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEtC;;EAEE;AACF,MAAM,MAAM,cAAc,GAAG;IACzB;;MAEE;IACF,IAAI,EAAE,QAAQ,CAAC;IACf;;MAEE;IACF,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC"}
1
+ {"version":3,"file":"ActionBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/ActionBehavior.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEtC;;;EAGE;AACF,MAAM,MAAM,cAAc,GAAG;IACzB;;MAEE;IACF,IAAI,EAAE,QAAQ,CAAC;IACf;;MAEE;IACF,MAAM,EAAE,MAAM,CAAC;IACf;;;MAGE;IACF,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC,CAAC"}
@@ -2,6 +2,7 @@ import type { ActionBehavior } from './ActionBehavior';
2
2
  import type { ContainerBehavior } from './ContainerBehavior';
3
3
  import type { CopyBehavior } from './CopyBehavior';
4
4
  import type { DismissBehavior } from './DismissBehavior';
5
+ import type { DownloadBehavior } from './DownloadBehavior';
5
6
  import type { LinkBehavior } from './LinkBehavior';
6
7
  import type { ModalBehavior } from './ModalBehavior';
7
8
  import type { RefreshBehavior } from './RefreshBehavior';
@@ -9,5 +10,5 @@ import type { SubflowBehavior } from './SubflowBehavior';
9
10
  /**
10
11
  * Describes the result of performing some interaction.
11
12
  */
12
- export type Behavior = ActionBehavior | ContainerBehavior | CopyBehavior | DismissBehavior | LinkBehavior | ModalBehavior | RefreshBehavior | SubflowBehavior;
13
+ export type Behavior = ActionBehavior | ContainerBehavior | CopyBehavior | DismissBehavior | DownloadBehavior | LinkBehavior | ModalBehavior | RefreshBehavior | SubflowBehavior;
13
14
  //# sourceMappingURL=Behavior.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Behavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/Behavior.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACtD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AACpD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAExD;;EAEE;AACF,MAAM,MAAM,QAAQ,GAAG,cAAc,GAAG,iBAAiB,GAAG,YAAY,GAAG,eAAe,GAAG,YAAY,GAAG,aAAa,GAAG,eAAe,GAAG,eAAe,CAAC"}
1
+ {"version":3,"file":"Behavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/Behavior.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACtD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AACpD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAExD;;EAEE;AACF,MAAM,MAAM,QAAQ,GAAG,cAAc,GAAG,iBAAiB,GAAG,YAAY,GAAG,eAAe,GAAG,gBAAgB,GAAG,YAAY,GAAG,aAAa,GAAG,eAAe,GAAG,eAAe,CAAC"}
@@ -6,5 +6,10 @@ import type { Link } from './Link';
6
6
  export type ContainerBehavior = {
7
7
  action?: Action;
8
8
  link?: Link;
9
+ /**
10
+ * Additional data to be included in behavior analytics events. The keys/values in this object will be included in all events
11
+ * generated by clients.
12
+ */
13
+ analytics?: Record<string, string>;
9
14
  };
10
15
  //# sourceMappingURL=ContainerBehavior.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ContainerBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/ContainerBehavior.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACtC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAElC;;EAEE;AACF,MAAM,MAAM,iBAAiB,GAAG;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,IAAI,CAAC;CACf,CAAC"}
1
+ {"version":3,"file":"ContainerBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/ContainerBehavior.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACtC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAElC;;EAEE;AACF,MAAM,MAAM,iBAAiB,GAAG;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;;MAGE;IACF,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC,CAAC"}
@@ -1,5 +1,6 @@
1
1
  /**
2
2
  * Places the provided contents into the system clipboard when triggered
3
+ * <!-- fixture: copybehavior -->
3
4
  */
4
5
  export type CopyBehavior = {
5
6
  /**
@@ -10,5 +11,10 @@ export type CopyBehavior = {
10
11
  * The content to be copied to the clipboard.
11
12
  */
12
13
  content: string;
14
+ /**
15
+ * Additional data to be included in behavior analytics events. The keys/values in this object will be included in all events
16
+ * generated by clients.
17
+ */
18
+ analytics?: Record<string, string>;
13
19
  };
14
20
  //# sourceMappingURL=CopyBehavior.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"CopyBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/CopyBehavior.ts"],"names":[],"mappings":"AAAA;;EAEE;AACF,MAAM,MAAM,YAAY,GAAG;IACvB;;MAEE;IACF,IAAI,EAAE,MAAM,CAAC;IACb;;MAEE;IACF,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"CopyBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/CopyBehavior.ts"],"names":[],"mappings":"AAAA;;;EAGE;AACF,MAAM,MAAM,YAAY,GAAG;IACvB;;MAEE;IACF,IAAI,EAAE,MAAM,CAAC;IACb;;MAEE;IACF,OAAO,EAAE,MAAM,CAAC;IAChB;;;MAGE;IACF,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC,CAAC"}
@@ -1,10 +1,16 @@
1
1
  /**
2
2
  * Dismisses the top-most modal content when the behavior is triggered.
3
+ * <!-- fixture: dismissbehavior -->
3
4
  */
4
5
  export type DismissBehavior = {
5
6
  /**
6
7
  * It must be `dismiss`.
7
8
  */
8
9
  type: 'dismiss';
10
+ /**
11
+ * Additional data to be included in behavior analytics events. The keys/values in this object will be included in all events
12
+ * generated by clients.
13
+ */
14
+ analytics?: Record<string, string>;
9
15
  };
10
16
  //# sourceMappingURL=DismissBehavior.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"DismissBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/DismissBehavior.ts"],"names":[],"mappings":"AAAA;;EAEE;AACF,MAAM,MAAM,eAAe,GAAG;IAC1B;;MAEE;IACF,IAAI,EAAE,SAAS,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"DismissBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/DismissBehavior.ts"],"names":[],"mappings":"AAAA;;;EAGE;AACF,MAAM,MAAM,eAAe,GAAG;IAC1B;;MAEE;IACF,IAAI,EAAE,SAAS,CAAC;IAChB;;;MAGE;IACF,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC,CAAC"}
@@ -0,0 +1,21 @@
1
+ import type { Request } from '../misc/Request';
2
+ /**
3
+ * Downloads a file from the given HTTP request.
4
+ * <!-- fixture: downloadbehavior -->
5
+ */
6
+ export type DownloadBehavior = {
7
+ /**
8
+ * It must be `download`.
9
+ */
10
+ type: 'download';
11
+ /**
12
+ * The HTTP request to fetch the file
13
+ */
14
+ request: Request;
15
+ /**
16
+ * Additional data to be included in behavior analytics events. The keys/values in this object will be included in all events
17
+ * generated by clients.
18
+ */
19
+ analytics?: Record<string, string>;
20
+ };
21
+ //# sourceMappingURL=DownloadBehavior.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DownloadBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/DownloadBehavior.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE9C;;;EAGE;AACF,MAAM,MAAM,gBAAgB,GAAG;IAC3B;;MAEE;IACF,IAAI,EAAE,UAAU,CAAC;IACjB;;MAEE;IACF,OAAO,EAAE,OAAO,CAAC;IACjB;;;MAGE;IACF,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC,CAAC"}
@@ -6,7 +6,7 @@
6
6
  * Mobile:
7
7
  * - Open a URL in the default browser.
8
8
  * - Or open another app via a universal link.
9
- * External is typically used alongside [Polling].
9
+ * External is typically used alongside [com.wise.dynamicflow.feature.Polling].
10
10
  * ### Example
11
11
  * ```kt
12
12
  * Step.build {
@@ -1,5 +1,6 @@
1
1
  /**
2
2
  * Opens a link when the behavior is triggered.
3
+ * <!-- fixture: linkbehavior -->
3
4
  */
4
5
  export type LinkBehavior = {
5
6
  /**
@@ -10,5 +11,10 @@ export type LinkBehavior = {
10
11
  * The URL of the link to open
11
12
  */
12
13
  url: string;
14
+ /**
15
+ * Additional data to be included in behavior analytics events. The keys/values in this object will be included in all events
16
+ * generated by clients.
17
+ */
18
+ analytics?: Record<string, string>;
13
19
  };
14
20
  //# sourceMappingURL=LinkBehavior.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"LinkBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/LinkBehavior.ts"],"names":[],"mappings":"AAAA;;EAEE;AACF,MAAM,MAAM,YAAY,GAAG;IACvB;;MAEE;IACF,IAAI,EAAE,MAAM,CAAC;IACb;;MAEE;IACF,GAAG,EAAE,MAAM,CAAC;CACf,CAAC"}
1
+ {"version":3,"file":"LinkBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/LinkBehavior.ts"],"names":[],"mappings":"AAAA;;;EAGE;AACF,MAAM,MAAM,YAAY,GAAG;IACvB;;MAEE;IACF,IAAI,EAAE,MAAM,CAAC;IACb;;MAEE;IACF,GAAG,EAAE,MAAM,CAAC;IACZ;;;MAGE;IACF,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC,CAAC"}
@@ -1,6 +1,7 @@
1
1
  import type { Layout } from '../layout/Layout';
2
2
  /**
3
3
  * Opens a modal when the behavior is triggered.
4
+ * <!-- fixture: modalbehavior -->
4
5
  */
5
6
  export type ModalBehavior = {
6
7
  /**
@@ -17,5 +18,10 @@ export type ModalBehavior = {
17
18
  * this can lead to an undesirable user experience with validation.
18
19
  */
19
20
  content: Layout[];
21
+ /**
22
+ * Additional data to be included in behavior analytics events. The keys/values in this object will be included in all events
23
+ * generated by clients.
24
+ */
25
+ analytics?: Record<string, string>;
20
26
  };
21
27
  //# sourceMappingURL=ModalBehavior.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ModalBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/ModalBehavior.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAE9C;;EAEE;AACF,MAAM,MAAM,aAAa,GAAG;IACxB;;MAEE;IACF,IAAI,EAAE,OAAO,CAAC;IACd;;MAEE;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;MAIE;IACF,OAAO,EAAE,MAAM,EAAE,CAAC;CACrB,CAAC"}
1
+ {"version":3,"file":"ModalBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/ModalBehavior.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAE9C;;;EAGE;AACF,MAAM,MAAM,aAAa,GAAG;IACxB;;MAEE;IACF,IAAI,EAAE,OAAO,CAAC;IACd;;MAEE;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;MAIE;IACF,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB;;;MAGE;IACF,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC,CAAC"}
@@ -1,6 +1,13 @@
1
1
  import type { Action } from './Action';
2
2
  /**
3
- * Describes how back navigation should be handled.
3
+ * Describes how back navigation should be handled. If omitted, clients will handle
4
+ * back navigation natively. This means they will return to the previous step if possible,
5
+ * or exit the flow.
6
+ * <!-- fixture: backnavigation -->
7
+ * ## When to use
8
+ * - When navigating back requires a new step from the server, e.g. if the content is invalid and needs to be regenerated.
9
+ * ## When not to use
10
+ * - If the step the user just navigated from is still valid, and is a logical place to go back to, then this property should be omitted so the native behavior is left intact.
4
11
  */
5
12
  export type NavigationBackBehavior = {
6
13
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"NavigationBackBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/NavigationBackBehavior.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEtC;;EAEE;AACF,MAAM,MAAM,sBAAsB,GAAG;IACjC;;MAEE;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;MAGE;IACF,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC"}
1
+ {"version":3,"file":"NavigationBackBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/NavigationBackBehavior.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEtC;;;;;;;;;EASE;AACF,MAAM,MAAM,sBAAsB,GAAG;IACjC;;MAEE;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;MAGE;IACF,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC"}
@@ -1,5 +1,9 @@
1
1
  /**
2
2
  * Describes the behavior of the navigation stack when the step is presented.
3
+ * ## When to use
4
+ * - When an intermediate step (e.g. a step that displays a loader) which should not be kept on the stack, a `remove-previous` stack behaviour could be used.
5
+ * - When returning to previous steps is invalid, for example on a success screen after an operation has been completed, it might make sense to completely clear the stack with a `remove-all` stack behavior.
6
+ * - When the current step is being replaced, to give the appearance of refreshing, a `replace-current` stack behavior could be used.
3
7
  */
4
8
  export type NavigationStackBehavior = 'default' | 'remove-previous' | 'remove-all' | 'replace-current';
5
9
  //# sourceMappingURL=NavigationStackBehavior.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"NavigationStackBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/NavigationStackBehavior.ts"],"names":[],"mappings":"AAAA;;EAEE;AACF,MAAM,MAAM,uBAAuB,GAAG,SAAS,GAAG,iBAAiB,GAAG,YAAY,GAAG,iBAAiB,CAAC"}
1
+ {"version":3,"file":"NavigationStackBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/NavigationStackBehavior.ts"],"names":[],"mappings":"AAAA;;;;;;EAME;AACF,MAAM,MAAM,uBAAuB,GAAG,SAAS,GAAG,iBAAiB,GAAG,YAAY,GAAG,iBAAiB,CAAC"}
@@ -8,6 +8,7 @@ import type { HttpMethod } from '../misc/HttpMethod';
8
8
  * Note that the schema on which the `persistAsync` property is set should reflect the value that is
9
9
  * submitted (i.e. the token/identifier), while the [schema] property defines
10
10
  * the schema that is shown to the user and submitted to the persist async endpoint.
11
+ * <!-- fixture: upload -->
11
12
  * ### Example
12
13
  * When the value of the field changes, a request is sent to the URL defined in the `persistAsync` object, where the request body is
13
14
  * a JSON object containing the value of the field under a property matching the value of `persistAsync.param`.
@@ -1 +1 @@
1
- {"version":3,"file":"PersistAsync.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/PersistAsync.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyDE;AACF,MAAM,MAAM,YAAY,GAAG;IACvB;;MAEE;IACF,KAAK,EAAE,MAAM,CAAC;IACd;;MAEE;IACF,UAAU,EAAE,MAAM,CAAC;IACnB;;MAEE;IACF,MAAM,EAAE,MAAM,CAAC;IACf;;MAEE;IACF,GAAG,EAAE,MAAM,CAAC;IACZ;;MAEE;IACF,MAAM,EAAE,UAAU,CAAC;CACtB,CAAC"}
1
+ {"version":3,"file":"PersistAsync.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/PersistAsync.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0DE;AACF,MAAM,MAAM,YAAY,GAAG;IACvB;;MAEE;IACF,KAAK,EAAE,MAAM,CAAC;IACd;;MAEE;IACF,UAAU,EAAE,MAAM,CAAC;IACnB;;MAEE;IACF,MAAM,EAAE,MAAM,CAAC;IACf;;MAEE;IACF,GAAG,EAAE,MAAM,CAAC;IACZ;;MAEE;IACF,MAAM,EAAE,UAAU,CAAC;CACtB,CAAC"}
@@ -5,9 +5,9 @@ import type { PollingOnError } from './PollingOnError';
5
5
  * The client may continue to another step or end the flow.
6
6
  * ### Example
7
7
  * Given the step below, the client will start making requests to the specified URL every 5 seconds.
8
- * To progress the flow, the response should be a [com.wise.dynamicflow.responses.FlowResponse] with the `X-DF-Response-Type` header set accordingly.
8
+ * **To continue polling**, the response should have a 2xx status code and an empty body. The client will continue to make requests until the flow progresses or [maxAttempts] is reached.
9
+ * **To stop polling**, the response should be a [com.wise.dynamicflow.responses.FlowResponse] with the `X-DF-Response-Type` header set accordingly.
9
10
  * *Note that older clients only support [com.wise.dynamicflow.responses.action.ActionResponseBody]*
10
- * To continue Polling, the response should have a 2xx status code and an empty body. The client will continue to make requests until the flow progresses or [maxAttempts] is reached.
11
11
  * ```kt
12
12
  * Step.build {
13
13
  * layout { }
@@ -1,10 +1,16 @@
1
1
  /**
2
2
  * Refreshes the current step when the behavior is triggered. See [com.wise.dynamicflow.feature.RefreshOnChange] for more details.
3
+ * <!-- fixture: refreshbehavior -->
3
4
  */
4
5
  export type RefreshBehavior = {
5
6
  /**
6
7
  * It must be `refresh`.
7
8
  */
8
9
  type: 'refresh';
10
+ /**
11
+ * Additional data to be included in behavior analytics events. The keys/values in this object will be included in all events
12
+ * generated by clients.
13
+ */
14
+ analytics?: Record<string, string>;
9
15
  };
10
16
  //# sourceMappingURL=RefreshBehavior.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"RefreshBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/RefreshBehavior.ts"],"names":[],"mappings":"AAAA;;EAEE;AACF,MAAM,MAAM,eAAe,GAAG;IAC1B;;MAEE;IACF,IAAI,EAAE,SAAS,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"RefreshBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/RefreshBehavior.ts"],"names":[],"mappings":"AAAA;;;EAGE;AACF,MAAM,MAAM,eAAe,GAAG;IAC1B;;MAEE;IACF,IAAI,EAAE,SAAS,CAAC;IAChB;;;MAGE;IACF,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC,CAAC"}
@@ -22,7 +22,7 @@ export type SubflowBehavior = {
22
22
  resultKey?: string;
23
23
  /**
24
24
  * The behavior performed on successful completion of the subflow. If this is an ActionBehavior,
25
- * the result of the subflow will be merged into the payload according to the [resultKey].
25
+ * the result of the subflow will be merged into the payload according to the `resultKey`.
26
26
  */
27
27
  onCompletion?: Behavior;
28
28
  /**
@@ -30,5 +30,10 @@ export type SubflowBehavior = {
30
30
  * parent flow will be ended and its onError will be called.
31
31
  */
32
32
  onError?: Behavior;
33
+ /**
34
+ * Additional data to be included in behavior analytics events. The keys/values in this object will be included in all events
35
+ * generated by clients.
36
+ */
37
+ analytics?: Record<string, string>;
33
38
  };
34
39
  //# sourceMappingURL=SubflowBehavior.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SubflowBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/SubflowBehavior.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAE1C;;EAEE;AACF,MAAM,MAAM,eAAe,GAAG;IAC1B;;MAEE;IACF,IAAI,EAAE,SAAS,CAAC;IAChB;;MAEE;IACF,UAAU,EAAE,MAAM,CAAC;IACnB;;MAEE;IACF,YAAY,EAAE,YAAY,CAAC;IAC3B;;MAEE;IACF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;MAGE;IACF,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB;;;MAGE;IACF,OAAO,CAAC,EAAE,QAAQ,CAAC;CACtB,CAAC"}
1
+ {"version":3,"file":"SubflowBehavior.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/SubflowBehavior.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAE1C;;EAEE;AACF,MAAM,MAAM,eAAe,GAAG;IAC1B;;MAEE;IACF,IAAI,EAAE,SAAS,CAAC;IAChB;;MAEE;IACF,UAAU,EAAE,MAAM,CAAC;IACnB;;MAEE;IACF,YAAY,EAAE,YAAY,CAAC;IAC3B;;MAEE;IACF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;MAGE;IACF,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB;;;MAGE;IACF,OAAO,CAAC,EAAE,QAAQ,CAAC;IACnB;;;MAGE;IACF,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC,CAAC"}
@@ -14,6 +14,7 @@ import type { HttpMethod } from '../misc/HttpMethod';
14
14
  * Also, in the case where the validation-async network call fails or returns an unexpected response,
15
15
  * the client ignores the problem and allows the user to submit.
16
16
  * For these reasons, any validation which is critical should also be performed by the server on submission.
17
+ * <!-- fixture: validationasync -->
17
18
  * ### Example
18
19
  * Given a schema defined as:
19
20
  * ```kt
@@ -1 +1 @@
1
- {"version":3,"file":"ValidateAsync.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/ValidateAsync.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA8CE;AACF,MAAM,MAAM,aAAa,GAAG;IACxB;;MAEE;IACF,KAAK,EAAE,MAAM,CAAC;IACd;;MAEE;IACF,MAAM,EAAE,UAAU,CAAC;IACnB;;MAEE;IACF,GAAG,EAAE,MAAM,CAAC;CACf,CAAC"}
1
+ {"version":3,"file":"ValidateAsync.d.ts","sourceRoot":"","sources":["../../../src/spec/feature/ValidateAsync.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+CE;AACF,MAAM,MAAM,aAAa,GAAG;IACxB;;MAEE;IACF,KAAK,EAAE,MAAM,CAAC;IACd;;MAEE;IACF,MAAM,EAAE,UAAU,CAAC;IACnB;;MAEE;IACF,GAAG,EAAE,MAAM,CAAC;CACf,CAAC"}