@rokt/dcui-orchestrator 0.2.1-rc.9 → 0.3.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 (557) hide show
  1. package/dist/extensions/address-form/src/actions/forms.d.ts +11 -0
  2. package/dist/extensions/address-form/src/actions/index.d.ts +1 -0
  3. package/dist/extensions/address-form/src/components/address-form.d.ts +96 -0
  4. package/dist/extensions/address-form/src/components/edit-address-form-view.d.ts +23 -0
  5. package/dist/extensions/address-form/src/components/form-button.d.ts +15 -0
  6. package/dist/extensions/address-form/src/components/input-field.d.ts +34 -0
  7. package/dist/extensions/address-form/src/index.d.ts +3 -0
  8. package/dist/extensions/address-form/src/models/form-state.d.ts +1 -0
  9. package/dist/extensions/address-form/src/models/index.d.ts +1 -0
  10. package/dist/extensions/address-form/src/reducers/forms.d.ts +4 -0
  11. package/dist/extensions/address-form/src/reducers/index.d.ts +1 -0
  12. package/dist/extensions/address-form/src/sagas/cart-service/index.d.ts +1 -0
  13. package/dist/extensions/address-form/src/sagas/cart-service/sagas.d.ts +9 -0
  14. package/dist/extensions/address-form/src/sagas/index.d.ts +2 -0
  15. package/dist/extensions/address-form/src/types.d.ts +63 -0
  16. package/dist/extensions/address-form/src/utils.d.ts +15 -0
  17. package/dist/extensions/minimized-bottomsheet/src/components/bottom-sheet/bottom-sheet.d.ts +2 -0
  18. package/dist/extensions/minimized-bottomsheet/src/components/bottom-sheet/factory.d.ts +1 -0
  19. package/dist/extensions/minimized-bottomsheet/src/components/bottom-sheet/hooks.d.ts +2 -1
  20. package/dist/extensions/minimized-bottomsheet/src/components/bottomsheet-wrapper/overlay-wrapper.d.ts +2 -2
  21. package/dist/extensions/shimmer-background/src/index.d.ts +10 -0
  22. package/dist/extensions/shimmer-background/src/shimmer-background.d.ts +11 -0
  23. package/dist/index.cjs +97 -46
  24. package/dist/index.js +102 -51
  25. package/dist/libraries/dcui-components/src/components/action-button/action-button.d.ts +24 -0
  26. package/dist/libraries/dcui-components/src/components/action-button/factory.d.ts +2 -0
  27. package/dist/libraries/dcui-components/src/components/action-button/index.d.ts +2 -0
  28. package/dist/libraries/dcui-components/src/components/catalog-carousel-collection/hooks.d.ts +7 -0
  29. package/dist/libraries/{layout-renderer-utils → dcui-components}/src/components/close-button/factory.d.ts +1 -1
  30. package/dist/libraries/dcui-components/src/components/data-image-carousel/carousel-indicators.d.ts +20 -0
  31. package/dist/libraries/dcui-components/src/components/data-image-carousel/data-image-carousel.d.ts +100 -0
  32. package/dist/libraries/dcui-components/src/components/data-image-carousel/factory.d.ts +2 -0
  33. package/dist/libraries/dcui-components/src/components/data-image-carousel/index.d.ts +2 -0
  34. package/dist/libraries/dcui-components/src/components/data-mapper/form-state-projection.d.ts +31 -0
  35. package/dist/libraries/dcui-components/src/components/data-mapper/index.d.ts +1 -0
  36. package/dist/libraries/dcui-components/src/components/extension/context.d.ts +2 -1
  37. package/dist/libraries/dcui-components/src/components/extension/models.d.ts +2 -1
  38. package/dist/libraries/dcui-components/src/components/form/factory.d.ts +2 -0
  39. package/dist/libraries/dcui-components/src/components/form/form.d.ts +24 -0
  40. package/dist/libraries/dcui-components/src/components/form/index.d.ts +2 -0
  41. package/dist/libraries/dcui-components/src/components/icon-group/factory.d.ts +2 -0
  42. package/dist/libraries/dcui-components/src/components/icon-group/icon-group.d.ts +36 -0
  43. package/dist/libraries/dcui-components/src/components/icon-group/index.d.ts +2 -0
  44. package/dist/libraries/dcui-components/src/components/index.d.ts +5 -0
  45. package/dist/libraries/dcui-components/src/components/layout-timer/index.d.ts +5 -0
  46. package/dist/libraries/dcui-components/src/components/layout-timer/layout-timer.d.ts +7 -0
  47. package/dist/libraries/dcui-components/src/components/layout-timer/timer-countdown-provider.d.ts +8 -0
  48. package/dist/libraries/dcui-components/src/components/layout-timer/use-layout-timer.d.ts +11 -0
  49. package/dist/libraries/dcui-components/src/components/layout-timer/use-timer-action-dispatch.d.ts +9 -0
  50. package/dist/libraries/dcui-components/src/components/rich-text/rich-text.d.ts +2 -0
  51. package/dist/libraries/dcui-components/src/components/scrollable-column/scrollable-column.d.ts +1 -1
  52. package/dist/libraries/dcui-components/src/components/scrollable-row/scrollable-row.d.ts +1 -1
  53. package/dist/libraries/dcui-components/src/components/style-mapper/get-css-writer.d.ts +1 -0
  54. package/dist/libraries/dcui-components/src/components/style-mapper/transformers/index.d.ts +1 -0
  55. package/dist/libraries/dcui-components/src/components/style-mapper/transformers/scroll-mask-transformer.d.ts +8 -0
  56. package/dist/libraries/dcui-components/src/components/style-mapper/types.d.ts +2 -2
  57. package/dist/libraries/dcui-components/src/components/text-input/factory.d.ts +2 -0
  58. package/dist/libraries/dcui-components/src/components/text-input/index.d.ts +2 -0
  59. package/dist/libraries/dcui-components/src/components/text-input/text-input.d.ts +23 -0
  60. package/dist/libraries/dcui-components/src/components/when/form-state.d.ts +9 -0
  61. package/dist/libraries/dcui-components/src/contexts/form-context.d.ts +15 -0
  62. package/dist/libraries/dcui-components/src/contexts/index.d.ts +2 -0
  63. package/dist/libraries/dcui-components/src/contexts/minimizable-context.d.ts +2 -0
  64. package/dist/libraries/dcui-components/src/contexts/offer-data-context.d.ts +1 -0
  65. package/dist/libraries/dcui-components/src/failure-codes.d.ts +1 -0
  66. package/dist/libraries/dcui-components/src/utils/get-scroll-mask-config.d.ts +20 -0
  67. package/dist/libraries/dcui-components/src/utils/index.d.ts +2 -0
  68. package/dist/libraries/dcui-components/src/utils/use-scroll-mask-visibility.d.ts +22 -0
  69. package/dist/libraries/dcui-schema/src/models/nodes/close-button.d.ts +3 -1
  70. package/dist/libraries/domain/src/behaviors/cart-item-event.d.ts +44 -0
  71. package/dist/libraries/domain/src/behaviors/dismiss-overlay.d.ts +9 -0
  72. package/dist/libraries/domain/src/behaviors/domain-states.d.ts +2 -2
  73. package/dist/libraries/domain/src/behaviors/form-state.d.ts +66 -0
  74. package/dist/libraries/domain/src/behaviors/global-actions.d.ts +17 -1
  75. package/dist/libraries/domain/src/behaviors/index.d.ts +6 -0
  76. package/dist/libraries/domain/src/behaviors/layout-events.d.ts +17 -0
  77. package/dist/libraries/domain/src/behaviors/offer-engagement.d.ts +3 -1
  78. package/dist/libraries/domain/src/behaviors/report-error.d.ts +26 -0
  79. package/dist/libraries/domain/src/behaviors/send-partner.d.ts +40 -3
  80. package/dist/libraries/domain/src/behaviors/trigger-action.d.ts +19 -0
  81. package/dist/libraries/domain/src/models/domain-state-keys.d.ts +5 -0
  82. package/dist/libraries/domain/src/models/form-state.d.ts +85 -0
  83. package/dist/libraries/domain/src/models/global-state.d.ts +4 -1
  84. package/dist/libraries/domain/src/models/index.d.ts +3 -0
  85. package/dist/libraries/domain/src/models/layout/index.d.ts +1 -0
  86. package/dist/libraries/domain/src/models/layout/layout-catalog-item.d.ts +2 -0
  87. package/dist/libraries/domain/src/models/layout/layout-child-config.d.ts +2 -0
  88. package/dist/libraries/domain/src/models/layout/layout-config.d.ts +2 -2
  89. package/dist/libraries/domain/src/models/layout/layout-offer.d.ts +2 -0
  90. package/dist/libraries/domain/src/models/layout/layout-signal-type.d.ts +3 -1
  91. package/dist/libraries/domain/src/models/layout/layout-transaction-data.d.ts +31 -0
  92. package/dist/libraries/domain/src/models/partner-event.d.ts +2 -2
  93. package/dist/libraries/domain/src/models/plugin/index.d.ts +2 -0
  94. package/dist/libraries/domain/src/models/plugin/plugin-catalog-item-group.d.ts +17 -0
  95. package/dist/libraries/domain/src/models/plugin/plugin-catalog-item.d.ts +8 -0
  96. package/dist/libraries/domain/src/models/plugin/plugin-child-layout-model.d.ts +2 -0
  97. package/dist/libraries/domain/src/models/plugin/plugin-model.d.ts +3 -3
  98. package/dist/libraries/domain/src/models/plugin/plugin-offer.d.ts +4 -0
  99. package/dist/libraries/domain/src/models/plugin/plugin-signal-type.d.ts +4 -1
  100. package/dist/libraries/domain/src/models/plugin/plugin-transaction-data.d.ts +31 -0
  101. package/dist/libraries/domain/src/models/purchase.d.ts +54 -0
  102. package/dist/libraries/domain/src/models/shipping.d.ts +25 -0
  103. package/dist/libraries/domain/src/models/signals.d.ts +19 -5
  104. package/dist/libraries/layout-renderer-utils/src/actions/domain-states.d.ts +14 -0
  105. package/dist/libraries/layout-renderer-utils/src/actions/form-states.d.ts +37 -0
  106. package/dist/libraries/layout-renderer-utils/src/actions/index.d.ts +15 -3
  107. package/dist/libraries/layout-renderer-utils/src/actions/overlay.d.ts +15 -8
  108. package/dist/libraries/layout-renderer-utils/src/actions/settings.d.ts +10 -3
  109. package/dist/libraries/layout-renderer-utils/src/components/index.d.ts +4 -1
  110. package/dist/libraries/layout-renderer-utils/src/components/minimizable-bottomsheet/connector.d.ts +2 -0
  111. package/dist/libraries/layout-renderer-utils/src/components/minimizable-bottomsheet/drag-handle.d.ts +7 -0
  112. package/dist/libraries/layout-renderer-utils/src/components/minimizable-bottomsheet/extract-border-styles.d.ts +25 -0
  113. package/dist/libraries/layout-renderer-utils/src/components/minimizable-bottomsheet/factory.d.ts +13 -0
  114. package/dist/libraries/layout-renderer-utils/src/components/minimizable-bottomsheet/hooks.d.ts +23 -0
  115. package/dist/libraries/layout-renderer-utils/src/components/minimizable-bottomsheet/index.d.ts +2 -0
  116. package/dist/libraries/layout-renderer-utils/src/components/minimizable-bottomsheet/minimizable-bottomsheet-wrapper.d.ts +12 -0
  117. package/dist/libraries/layout-renderer-utils/src/components/minimizable-bottomsheet/minimizable-bottomsheet.d.ts +27 -0
  118. package/dist/libraries/layout-renderer-utils/src/components/minimizable-bottomsheet/sheet-gesture.d.ts +18 -0
  119. package/dist/libraries/layout-renderer-utils/src/components/minimizable-bottomsheet/types.d.ts +63 -0
  120. package/dist/libraries/layout-renderer-utils/src/components/minimize-button/factory.d.ts +2 -0
  121. package/dist/libraries/layout-renderer-utils/src/components/minimize-button/index.d.ts +2 -0
  122. package/dist/libraries/layout-renderer-utils/src/components/minimize-button/minimize-button.d.ts +12 -0
  123. package/dist/libraries/layout-renderer-utils/src/components/overlay/overlay.d.ts +1 -0
  124. package/dist/libraries/layout-renderer-utils/src/components/overlay-wrapper/attached-overlay-wrapper.d.ts +19 -0
  125. package/dist/libraries/layout-renderer-utils/src/components/overlay-wrapper/index.d.ts +1 -0
  126. package/dist/libraries/layout-renderer-utils/src/components/utils.d.ts +1 -0
  127. package/dist/libraries/layout-renderer-utils/src/constant.d.ts +1 -1
  128. package/dist/libraries/layout-renderer-utils/src/hooks/useEscToClose.d.ts +1 -0
  129. package/dist/libraries/layout-renderer-utils/src/models/state/fired-events.d.ts +17 -0
  130. package/dist/libraries/layout-renderer-utils/src/models/state/form-states.d.ts +11 -0
  131. package/dist/libraries/layout-renderer-utils/src/models/state/index.d.ts +9 -2
  132. package/dist/libraries/layout-renderer-utils/src/models/state/layout.d.ts +2 -1
  133. package/dist/libraries/layout-renderer-utils/src/models/state/settings.d.ts +6 -0
  134. package/dist/libraries/layout-renderer-utils/src/reducers/fired-events/index.d.ts +1 -0
  135. package/dist/libraries/layout-renderer-utils/src/reducers/fired-events/reducer.d.ts +5 -0
  136. package/dist/libraries/layout-renderer-utils/src/reducers/form-states/index.d.ts +1 -0
  137. package/dist/libraries/layout-renderer-utils/src/reducers/form-states/reducer.d.ts +4 -0
  138. package/dist/libraries/layout-renderer-utils/src/reducers/index.d.ts +6 -0
  139. package/dist/libraries/layout-renderer-utils/src/reducers/settings/reducer.d.ts +3 -3
  140. package/dist/libraries/layout-renderer-utils/src/sagas/error/error-codes.d.ts +2 -0
  141. package/dist/libraries/layout-renderer-utils/src/sagas/form-states/index.d.ts +1 -0
  142. package/dist/libraries/layout-renderer-utils/src/sagas/form-states/sagas.d.ts +16 -0
  143. package/dist/libraries/layout-renderer-utils/src/sagas/index.d.ts +2 -0
  144. package/dist/libraries/layout-renderer-utils/src/sagas/plugin/attached-bottomsheet.d.ts +18 -0
  145. package/dist/libraries/layout-renderer-utils/src/sagas/plugin/display.d.ts +7 -13
  146. package/dist/libraries/layout-renderer-utils/src/sagas/plugin/sagas.d.ts +1 -1
  147. package/dist/libraries/layout-renderer-utils/src/sagas/trigger-action/index.d.ts +1 -0
  148. package/dist/libraries/layout-renderer-utils/src/sagas/trigger-action/sagas.d.ts +12 -0
  149. package/dist/libraries/layout-renderer-utils/src/selectors/fired-events/selectors.d.ts +7 -0
  150. package/dist/libraries/layout-renderer-utils/src/selectors/form-state/index.d.ts +1 -0
  151. package/dist/libraries/layout-renderer-utils/src/selectors/form-state/selectors.d.ts +8 -0
  152. package/dist/libraries/layout-renderer-utils/src/selectors/index.d.ts +2 -0
  153. package/dist/libraries/layout-renderer-utils/src/utils/signals.d.ts +2 -2
  154. package/dist/libraries/module-connector/src/main.d.ts +1 -1
  155. package/dist/libraries/module-connector/src/models/gateway.d.ts +4 -3
  156. package/dist/libraries/module-connector/src/models/module-connector-builder.d.ts +4 -1
  157. package/dist/libraries/module-utils/src/actions/child-layouts.d.ts +11 -0
  158. package/dist/libraries/module-utils/src/actions/dynamic-data.d.ts +7 -0
  159. package/dist/libraries/module-utils/src/actions/index.d.ts +2 -0
  160. package/dist/libraries/module-utils/src/index.d.ts +5 -0
  161. package/dist/libraries/module-utils/src/models/index.d.ts +1 -0
  162. package/dist/libraries/module-utils/src/models/state/child-layouts.d.ts +4 -0
  163. package/dist/libraries/module-utils/src/models/state/dynamic-data.d.ts +3 -0
  164. package/dist/libraries/module-utils/src/models/state/index.d.ts +3 -0
  165. package/dist/libraries/module-utils/src/models/state/static-data.d.ts +6 -0
  166. package/dist/libraries/module-utils/src/reducers/child-layouts/index.d.ts +1 -0
  167. package/dist/libraries/module-utils/src/reducers/child-layouts/reducer.d.ts +5 -0
  168. package/dist/libraries/module-utils/src/reducers/dynamic-data/index.d.ts +1 -0
  169. package/dist/libraries/module-utils/src/reducers/dynamic-data/reducer.d.ts +4 -0
  170. package/dist/libraries/module-utils/src/reducers/index.d.ts +3 -0
  171. package/dist/libraries/module-utils/src/reducers/static-data/index.d.ts +1 -0
  172. package/dist/libraries/module-utils/src/reducers/static-data/reducer.d.ts +4 -0
  173. package/dist/libraries/module-utils/src/sagas/child-layouts/index.d.ts +1 -0
  174. package/dist/libraries/module-utils/src/sagas/child-layouts/sagas.d.ts +5 -0
  175. package/dist/libraries/module-utils/src/sagas/error-codes.d.ts +1 -0
  176. package/dist/libraries/module-utils/src/sagas/index.d.ts +1 -0
  177. package/dist/libraries/module-utils/src/selectors/child-layouts/index.d.ts +1 -0
  178. package/dist/libraries/module-utils/src/selectors/child-layouts/selectors.d.ts +4 -0
  179. package/dist/libraries/module-utils/src/selectors/dynamic-data/index.d.ts +1 -0
  180. package/dist/libraries/module-utils/src/selectors/dynamic-data/selectors.d.ts +4 -0
  181. package/dist/libraries/module-utils/src/selectors/index.d.ts +3 -0
  182. package/dist/libraries/module-utils/src/selectors/static-data/index.d.ts +1 -0
  183. package/dist/libraries/module-utils/src/selectors/static-data/selectors.d.ts +7 -0
  184. package/dist/libraries/orchestrator/src/actions/domain-states.d.ts +2 -2
  185. package/dist/libraries/orchestrator/src/actions/index.d.ts +14 -4
  186. package/dist/libraries/orchestrator/src/actions/trigger-action.d.ts +2 -0
  187. package/dist/libraries/orchestrator/src/global-store-proxy.d.ts +2 -0
  188. package/dist/libraries/orchestrator/src/models/index.d.ts +1 -1
  189. package/dist/libraries/orchestrator/src/models/state/domain-states.d.ts +2 -2
  190. package/dist/libraries/orchestrator/src/models/state/index.d.ts +0 -2
  191. package/dist/libraries/orchestrator/src/reducers/domain-states/reducer.d.ts +2 -1
  192. package/dist/libraries/orchestrator/src/reducers/index.d.ts +3 -1
  193. package/dist/libraries/orchestrator/src/sagas/plugin/config-transformer.d.ts +2 -2
  194. package/dist/libraries/orchestrator/src/sagas/plugin/migrate-schema.d.ts +2 -2
  195. package/dist/libraries/orchestrator/src/sagas/plugin/migrations/migration-mapper.d.ts +3 -3
  196. package/dist/libraries/orchestrator/src/sagas/plugin/migrations/v1.0.d.ts +2 -2
  197. package/dist/libraries/orchestrator/src/sagas/plugin/sagas.d.ts +2 -2
  198. package/dist/libraries/orchestrator/src/sagas/progression/sagas.d.ts +2 -1
  199. package/dist/libraries/orchestrator/src/sagas/trigger-action/index.d.ts +1 -0
  200. package/dist/libraries/orchestrator/src/sagas/trigger-action/sagas.d.ts +3 -0
  201. package/dist/libraries/orchestrator/src/selectors/domain-state/selectors.d.ts +2 -2
  202. package/dist/libraries/orchestrator/src/selectors/index.d.ts +1 -1
  203. package/dist/libraries/plugin-utils/src/translate-config.d.ts +5 -1
  204. package/dist/libraries/saga-utils/src/sagas/handle-variant-action.d.ts +12 -0
  205. package/dist/libraries/saga-utils/src/sagas/index.d.ts +1 -0
  206. package/dist/libraries/saga-utils/src/utils/catalog-translator.d.ts +1 -0
  207. package/dist/modules/add-to-cart/src/components/escape-hatch/factory.d.ts +1 -1
  208. package/dist/modules/add-to-cart/src/components/mapped-icons/icon-registry-data.d.ts +10 -0
  209. package/dist/modules/add-to-cart/src/components/mapped-icons/icon-registry.d.ts +9 -0
  210. package/dist/modules/add-to-cart/src/components/mapped-icons/mapped-icon.d.ts +15 -0
  211. package/dist/modules/add-to-cart/src/components/read-more-text/read-more-text.d.ts +29 -0
  212. package/dist/modules/add-to-cart/src/components/read-more-text-container/read-more-text-container.d.ts +34 -0
  213. package/dist/modules/add-to-cart/src/components/scroll-to-target/scroll-to-target.d.ts +56 -0
  214. package/dist/modules/add-to-cart/src/components/tooltip/tooltip.d.ts +42 -0
  215. package/dist/modules/add-to-cart/src/components/when-catalog-quantity/when-catalog-quantity.d.ts +22 -0
  216. package/dist/modules/add-to-cart/src/reducers/index.d.ts +1 -1
  217. package/dist/modules/add-to-cart/src/sagas/cart-service-response/index.d.ts +1 -0
  218. package/dist/modules/add-to-cart/src/sagas/cart-service-response/sagas.d.ts +11 -0
  219. package/dist/modules/add-to-cart/src/sagas/index.d.ts +11 -0
  220. package/dist/modules/add-to-cart/src/selectors/catalogItems/selectors.d.ts +2 -0
  221. package/dist/modules/add-to-cart/src/selectors/creative/index.d.ts +1 -0
  222. package/dist/modules/add-to-cart/src/selectors/creative/selectors.d.ts +3 -0
  223. package/dist/modules/add-to-cart/src/selectors/index.d.ts +2 -1
  224. package/dist/modules/add-to-cart/src/selectors/offerDataState/index.d.ts +1 -0
  225. package/dist/modules/add-to-cart/src/selectors/{globalOfferDataState → offerDataState}/selectors.d.ts +1 -1
  226. package/dist/modules/instant-purchase/src/actions/device-pay.d.ts +60 -0
  227. package/dist/modules/instant-purchase/src/actions/index.d.ts +2 -0
  228. package/dist/modules/instant-purchase/src/actions/instant-purchase.d.ts +52 -2
  229. package/dist/modules/instant-purchase/src/actions/paypal.d.ts +35 -0
  230. package/dist/modules/instant-purchase/src/channels/channel.d.ts +5 -1
  231. package/dist/modules/instant-purchase/src/components/catalog-device-pay-button/apple-pay-button.d.ts +36 -0
  232. package/dist/modules/instant-purchase/src/components/catalog-device-pay-button/catalog-device-pay-button.d.ts +59 -0
  233. package/dist/modules/instant-purchase/src/components/catalog-device-pay-button/factory.d.ts +2 -0
  234. package/dist/modules/instant-purchase/src/components/catalog-device-pay-button/retryable-device-pay-error.d.ts +1 -0
  235. package/dist/modules/instant-purchase/src/components/catalog-discount-callout-tag/catalog-discount-callout-tag.d.ts +90 -0
  236. package/dist/modules/instant-purchase/src/components/catalog-dropdown/catalog-dropdown.d.ts +6 -0
  237. package/dist/modules/instant-purchase/src/components/catalog-dropdown/dropdown-options-context.d.ts +17 -0
  238. package/dist/modules/instant-purchase/src/components/catalog-dropdown/factory.d.ts +2 -0
  239. package/dist/modules/instant-purchase/src/components/catalog-imagegallery/catalog-gallery-index.d.ts +1 -0
  240. package/dist/modules/instant-purchase/src/components/catalog-imagegallery/catalog-image-gallery.d.ts +6 -0
  241. package/dist/modules/instant-purchase/src/components/catalog-imagegallery/factory.d.ts +2 -0
  242. package/dist/modules/instant-purchase/src/components/catalog-selectors-stacked/catalog-selectors-stacked.d.ts +6 -0
  243. package/dist/modules/instant-purchase/src/components/catalog-selectors-stacked/factory.d.ts +2 -0
  244. package/dist/modules/instant-purchase/src/components/catalog-thumbnail-gallery/catalog-thumbnail-gallery.d.ts +6 -0
  245. package/dist/modules/instant-purchase/src/components/catalog-thumbnail-gallery/factory.d.ts +2 -0
  246. package/dist/modules/instant-purchase/src/components/checkbox/checkbox.d.ts +1 -0
  247. package/dist/modules/instant-purchase/src/components/checkout-state-button-trigger/checkout-state-button-trigger.d.ts +2 -0
  248. package/dist/modules/instant-purchase/src/components/custom-state-validation-trigger-button/custom-state-validation-trigger-button.d.ts +28 -0
  249. package/dist/modules/instant-purchase/src/components/dismiss-instant-purchase-button/dismiss-instant-purchase-button.d.ts +1 -0
  250. package/dist/modules/instant-purchase/src/components/escape-hatch/factory.d.ts +1 -1
  251. package/dist/modules/instant-purchase/src/components/escape-hatch/index.d.ts +1 -0
  252. package/dist/modules/instant-purchase/src/components/{catalog-drop-down → escapehatch-catalog-drop-down}/catalog-drop-down.d.ts +2 -0
  253. package/dist/modules/instant-purchase/src/components/{catalog-image-gallery → escapehatch-catalog-image-gallery}/catalog-image-gallery.d.ts +15 -4
  254. package/dist/modules/instant-purchase/src/components/escapehatch-catalog-image-gallery/constants.d.ts +9 -0
  255. package/dist/modules/instant-purchase/src/components/inline-container/factory.d.ts +2 -0
  256. package/dist/modules/instant-purchase/src/components/inline-container/inline-container.d.ts +55 -0
  257. package/dist/modules/instant-purchase/src/components/loading-spinner/loading-spinner.d.ts +2 -1
  258. package/dist/modules/instant-purchase/src/components/offer-lifecycle-timer/offer-lifecycle-timer.d.ts +2 -0
  259. package/dist/modules/instant-purchase/src/components/read-more-text-container/read-more-text-container.d.ts +1 -0
  260. package/dist/modules/instant-purchase/src/components/rich-text/factory.d.ts +2 -0
  261. package/dist/modules/instant-purchase/src/components/rich-text/rich-text.d.ts +64 -0
  262. package/dist/modules/instant-purchase/src/components/snackbar/snackbar.d.ts +25 -0
  263. package/dist/modules/instant-purchase/src/constants/device-pay-error.d.ts +4 -0
  264. package/dist/modules/instant-purchase/src/constants/device-pay-providers.d.ts +26 -0
  265. package/dist/modules/instant-purchase/src/constants/index.d.ts +2 -0
  266. package/dist/modules/instant-purchase/src/models/state/device-pay-availability.d.ts +5 -0
  267. package/dist/modules/instant-purchase/src/models/state/index.d.ts +1 -0
  268. package/dist/modules/instant-purchase/src/models/state/instant-purchase.d.ts +70 -2
  269. package/dist/modules/instant-purchase/src/reducers/device-pay-availability/index.d.ts +1 -0
  270. package/dist/modules/instant-purchase/src/reducers/device-pay-availability/reducer.d.ts +4 -0
  271. package/dist/modules/instant-purchase/src/reducers/index.d.ts +17 -2
  272. package/dist/modules/instant-purchase/src/reducers/instant-purchase/index.d.ts +3 -0
  273. package/dist/modules/instant-purchase/src/reducers/instant-purchase/offer-lifecycle-event/index.d.ts +1 -0
  274. package/dist/modules/instant-purchase/src/reducers/instant-purchase/offer-lifecycle-event/reducer.d.ts +4 -0
  275. package/dist/modules/instant-purchase/src/reducers/instant-purchase/purchase-id/index.d.ts +1 -0
  276. package/dist/modules/instant-purchase/src/reducers/instant-purchase/purchase-id/reducer.d.ts +4 -0
  277. package/dist/modules/instant-purchase/src/reducers/instant-purchase/tax-and-shipping-data-cache/index.d.ts +1 -0
  278. package/dist/modules/instant-purchase/src/reducers/instant-purchase/tax-and-shipping-data-cache/reducer.d.ts +4 -0
  279. package/dist/modules/instant-purchase/src/reducers/paypal-purchase-context/index.d.ts +2 -0
  280. package/dist/modules/instant-purchase/src/reducers/paypal-purchase-context/reducer.d.ts +5 -0
  281. package/dist/modules/instant-purchase/src/reducers/paypal-transaction-details/index.d.ts +2 -0
  282. package/dist/modules/instant-purchase/src/reducers/paypal-transaction-details/reducer.d.ts +5 -0
  283. package/dist/modules/instant-purchase/src/sagas/checkout-lifecycle/sagas.d.ts +1 -1
  284. package/dist/modules/instant-purchase/src/sagas/device-pay/index.d.ts +1 -0
  285. package/dist/modules/instant-purchase/src/sagas/device-pay/sagas.d.ts +116 -0
  286. package/dist/modules/instant-purchase/src/sagas/dismiss-overlay/index.d.ts +1 -0
  287. package/dist/modules/instant-purchase/src/sagas/dismiss-overlay/sagas.d.ts +7 -0
  288. package/dist/modules/instant-purchase/src/sagas/error-codes.d.ts +14 -0
  289. package/dist/modules/instant-purchase/src/sagas/index.d.ts +16 -1
  290. package/dist/modules/instant-purchase/src/sagas/instant-purchase/sagas.d.ts +20 -72
  291. package/dist/modules/instant-purchase/src/sagas/instant-purchase-signals.d.ts +4 -0
  292. package/dist/modules/instant-purchase/src/sagas/layout-events.d.ts +9 -0
  293. package/dist/modules/instant-purchase/src/sagas/offer-engagement.d.ts +3 -0
  294. package/dist/modules/instant-purchase/src/sagas/paypal/index.d.ts +1 -0
  295. package/dist/modules/instant-purchase/src/sagas/paypal/sagas.d.ts +83 -0
  296. package/dist/modules/instant-purchase/src/sagas/tax-and-shipping/index.d.ts +1 -0
  297. package/dist/modules/instant-purchase/src/sagas/tax-and-shipping/sagas.d.ts +50 -0
  298. package/dist/modules/instant-purchase/src/sagas/variant-action-overrides.d.ts +11 -0
  299. package/dist/modules/instant-purchase/src/selectors/creative/index.d.ts +1 -0
  300. package/dist/modules/instant-purchase/src/selectors/creative/selectors.d.ts +5 -0
  301. package/dist/modules/instant-purchase/src/selectors/device-pay-availability/index.d.ts +1 -0
  302. package/dist/modules/instant-purchase/src/selectors/device-pay-availability/selectors.d.ts +13 -0
  303. package/dist/modules/instant-purchase/src/selectors/index.d.ts +4 -0
  304. package/dist/modules/instant-purchase/src/selectors/paypal-transaction-details/index.d.ts +1 -0
  305. package/dist/modules/instant-purchase/src/selectors/paypal-transaction-details/selectors.d.ts +3 -0
  306. package/dist/modules/instant-purchase/src/selectors/tax-and-shipping/index.d.ts +1 -0
  307. package/dist/modules/instant-purchase/src/selectors/tax-and-shipping/selectors.d.ts +3 -0
  308. package/dist/modules/instant-purchase/src/utils/create-tax-and-shipping-cache-key.d.ts +4 -0
  309. package/dist/modules/layouts-xp-sandbox/src/reducers/index.d.ts +1 -1
  310. package/dist/modules/layouts-xp-sandbox/src/sagas/index.d.ts +11 -0
  311. package/dist/modules/layouts-xp-sandbox/src/sagas/offer-engagement/sagas.d.ts +1 -1
  312. package/dist/modules/standard-marketing/src/components/escape-hatch/factory.d.ts +2 -0
  313. package/dist/modules/standard-marketing/src/components/escape-hatch-checkbox/escape-hatch-checkbox.d.ts +28 -0
  314. package/dist/modules/standard-marketing/src/reducers/index.d.ts +1 -1
  315. package/dist/modules/standard-marketing/src/sagas/index.d.ts +11 -0
  316. package/dist/modules/standard-marketing/src/sagas/offer-engagement/channels.d.ts +4 -1
  317. package/dist/modules/standard-marketing/src/sagas/offer-engagement/sagas.d.ts +3 -3
  318. package/node_modules/@rokt/dcui-layout-schema/dist/schema.d.ts +4694 -117
  319. package/node_modules/@rokt/dcui-layout-schema/dist/schema.js +1 -1
  320. package/node_modules/@rokt/dcui-layout-schema/dist/tsconfig.tsbuildinfo +1 -1
  321. package/node_modules/@rokt/dcui-layout-schema/package.json +1 -1
  322. package/node_modules/@rokt/dcui-layout-schema/v0.1/index.d.ts +953 -29
  323. package/node_modules/@rokt/dcui-layout-schema/v0.1/index.js +1 -1
  324. package/node_modules/@rokt/dcui-layout-schema/v0.10/index.d.ts +1087 -35
  325. package/node_modules/@rokt/dcui-layout-schema/v0.10/index.js +1 -1
  326. package/node_modules/@rokt/dcui-layout-schema/v0.11/index.d.ts +1143 -35
  327. package/node_modules/@rokt/dcui-layout-schema/v0.11/index.js +1 -1
  328. package/node_modules/@rokt/dcui-layout-schema/v0.12/index.d.ts +1147 -35
  329. package/node_modules/@rokt/dcui-layout-schema/v0.12/index.js +1 -1
  330. package/node_modules/@rokt/dcui-layout-schema/v0.13/index.d.ts +1218 -35
  331. package/node_modules/@rokt/dcui-layout-schema/v0.13/index.js +1 -1
  332. package/node_modules/@rokt/dcui-layout-schema/v0.14/index.d.ts +1258 -37
  333. package/node_modules/@rokt/dcui-layout-schema/v0.14/index.js +1 -1
  334. package/node_modules/@rokt/dcui-layout-schema/v0.15/index.d.ts +1272 -38
  335. package/node_modules/@rokt/dcui-layout-schema/v0.15/index.js +1 -1
  336. package/node_modules/@rokt/dcui-layout-schema/v0.16/index.d.ts +1334 -38
  337. package/node_modules/@rokt/dcui-layout-schema/v0.16/index.js +1 -1
  338. package/node_modules/@rokt/dcui-layout-schema/v0.17/index.d.ts +1353 -39
  339. package/node_modules/@rokt/dcui-layout-schema/v0.17/index.js +1 -1
  340. package/node_modules/@rokt/dcui-layout-schema/v0.18/index.d.ts +1406 -39
  341. package/node_modules/@rokt/dcui-layout-schema/v0.18/index.js +1 -1
  342. package/node_modules/@rokt/dcui-layout-schema/v0.19/index.d.ts +1407 -39
  343. package/node_modules/@rokt/dcui-layout-schema/v0.19/index.js +1 -1
  344. package/node_modules/@rokt/dcui-layout-schema/v0.2/index.d.ts +1013 -33
  345. package/node_modules/@rokt/dcui-layout-schema/v0.2/index.js +1 -1
  346. package/node_modules/@rokt/dcui-layout-schema/v0.20/index.d.ts +1439 -39
  347. package/node_modules/@rokt/dcui-layout-schema/v0.20/index.js +1 -1
  348. package/node_modules/@rokt/dcui-layout-schema/v0.21/index.d.ts +1482 -39
  349. package/node_modules/@rokt/dcui-layout-schema/v0.21/index.js +1 -1
  350. package/node_modules/@rokt/dcui-layout-schema/v0.22/index.d.ts +1512 -39
  351. package/node_modules/@rokt/dcui-layout-schema/v0.22/index.js +1 -1
  352. package/node_modules/@rokt/dcui-layout-schema/v0.23/index.d.ts +1522 -40
  353. package/node_modules/@rokt/dcui-layout-schema/v0.23/index.js +1 -1
  354. package/node_modules/@rokt/dcui-layout-schema/v0.3/index.d.ts +1013 -33
  355. package/node_modules/@rokt/dcui-layout-schema/v0.3/index.js +1 -1
  356. package/node_modules/@rokt/dcui-layout-schema/v0.4/index.d.ts +1041 -33
  357. package/node_modules/@rokt/dcui-layout-schema/v0.4/index.js +1 -1
  358. package/node_modules/@rokt/dcui-layout-schema/v0.5/index.d.ts +1065 -33
  359. package/node_modules/@rokt/dcui-layout-schema/v0.5/index.js +1 -1
  360. package/node_modules/@rokt/dcui-layout-schema/v0.6/index.d.ts +1065 -33
  361. package/node_modules/@rokt/dcui-layout-schema/v0.6/index.js +1 -1
  362. package/node_modules/@rokt/dcui-layout-schema/v0.7/index.d.ts +1066 -33
  363. package/node_modules/@rokt/dcui-layout-schema/v0.7/index.js +1 -1
  364. package/node_modules/@rokt/dcui-layout-schema/v0.8/index.d.ts +1069 -33
  365. package/node_modules/@rokt/dcui-layout-schema/v0.8/index.js +1 -1
  366. package/node_modules/@rokt/dcui-layout-schema/v0.9/index.d.ts +1070 -33
  367. package/node_modules/@rokt/dcui-layout-schema/v0.9/index.js +1 -1
  368. package/node_modules/@rokt/dcui-layout-schema/v1.0/index.d.ts +1827 -59
  369. package/node_modules/@rokt/dcui-layout-schema/v1.0/index.js +1 -1
  370. package/node_modules/@rokt/dcui-layout-schema/v1.1/index.d.ts +1851 -59
  371. package/node_modules/@rokt/dcui-layout-schema/v1.1/index.js +1 -1
  372. package/node_modules/@rokt/dcui-layout-schema/v1.10/index.d.ts +5322 -0
  373. package/node_modules/@rokt/dcui-layout-schema/v1.10/index.js +4 -0
  374. package/node_modules/@rokt/dcui-layout-schema/v1.11/index.d.ts +5486 -0
  375. package/node_modules/@rokt/dcui-layout-schema/v1.11/index.js +4 -0
  376. package/node_modules/@rokt/dcui-layout-schema/v1.12/index.d.ts +5496 -0
  377. package/node_modules/@rokt/dcui-layout-schema/v1.12/index.js +4 -0
  378. package/node_modules/@rokt/dcui-layout-schema/v1.13/index.d.ts +5498 -0
  379. package/node_modules/@rokt/dcui-layout-schema/v1.13/index.js +4 -0
  380. package/node_modules/@rokt/dcui-layout-schema/v1.14/index.d.ts +5828 -0
  381. package/node_modules/@rokt/dcui-layout-schema/v1.14/index.js +4 -0
  382. package/node_modules/@rokt/dcui-layout-schema/v1.15/index.d.ts +6085 -0
  383. package/node_modules/@rokt/dcui-layout-schema/v1.15/index.js +4 -0
  384. package/node_modules/@rokt/dcui-layout-schema/v1.16/index.d.ts +6324 -0
  385. package/node_modules/@rokt/dcui-layout-schema/v1.16/index.js +4 -0
  386. package/node_modules/@rokt/dcui-layout-schema/v1.17/index.d.ts +6439 -0
  387. package/node_modules/@rokt/dcui-layout-schema/v1.17/index.js +4 -0
  388. package/node_modules/@rokt/dcui-layout-schema/v1.18/index.d.ts +6439 -0
  389. package/node_modules/@rokt/dcui-layout-schema/v1.18/index.js +4 -0
  390. package/node_modules/@rokt/dcui-layout-schema/v1.19/index.d.ts +6439 -0
  391. package/node_modules/@rokt/dcui-layout-schema/v1.19/index.js +4 -0
  392. package/node_modules/@rokt/dcui-layout-schema/v1.2/index.d.ts +1861 -59
  393. package/node_modules/@rokt/dcui-layout-schema/v1.2/index.js +1 -1
  394. package/node_modules/@rokt/dcui-layout-schema/v1.20/index.d.ts +6558 -0
  395. package/node_modules/@rokt/dcui-layout-schema/v1.20/index.js +4 -0
  396. package/node_modules/@rokt/dcui-layout-schema/v1.3/index.d.ts +1948 -59
  397. package/node_modules/@rokt/dcui-layout-schema/v1.3/index.js +1 -1
  398. package/node_modules/@rokt/dcui-layout-schema/v1.4/index.d.ts +2115 -60
  399. package/node_modules/@rokt/dcui-layout-schema/v1.4/index.js +1 -1
  400. package/node_modules/@rokt/dcui-layout-schema/v1.5/index.d.ts +2137 -60
  401. package/node_modules/@rokt/dcui-layout-schema/v1.5/index.js +1 -1
  402. package/node_modules/@rokt/dcui-layout-schema/v1.6/index.d.ts +2308 -60
  403. package/node_modules/@rokt/dcui-layout-schema/v1.6/index.js +1 -1
  404. package/node_modules/@rokt/dcui-layout-schema/v1.7/index.d.ts +2578 -68
  405. package/node_modules/@rokt/dcui-layout-schema/v1.7/index.js +1 -1
  406. package/node_modules/@rokt/dcui-layout-schema/v1.8/index.d.ts +2680 -68
  407. package/node_modules/@rokt/dcui-layout-schema/v1.8/index.js +1 -1
  408. package/node_modules/@rokt/dcui-layout-schema/v1.9/index.d.ts +5222 -0
  409. package/node_modules/@rokt/dcui-layout-schema/v1.9/index.js +4 -0
  410. package/node_modules/@rokt/partner-integration/README.md +85 -0
  411. package/node_modules/@rokt/partner-integration/dist/cart/index.barrel.d.ts +2 -0
  412. package/node_modules/@rokt/partner-integration/dist/cart/index.d.ts +3 -0
  413. package/node_modules/@rokt/partner-integration/dist/cart/v1/delete-alert-partner-message-body.d.ts +7 -0
  414. package/node_modules/@rokt/partner-integration/dist/cart/v1/events.d.ts +23 -0
  415. package/node_modules/@rokt/partner-integration/dist/cart/v1/index.d.ts +5 -0
  416. package/node_modules/@rokt/partner-integration/dist/cart/v1/update-cart-item.d.ts +48 -0
  417. package/node_modules/@rokt/partner-integration/dist/cart/v1/upsert-alert-partner-message-body.d.ts +15 -0
  418. package/node_modules/@rokt/partner-integration/dist/cart/v1/upsert-delivery-details-message-body.d.ts +12 -0
  419. package/node_modules/@rokt/partner-integration/dist/cart/v2/cart-item-updated-placement-message-body.d.ts +48 -0
  420. package/node_modules/@rokt/partner-integration/dist/cart/v2/index.d.ts +4 -0
  421. package/node_modules/@rokt/partner-integration/dist/cart/v2/partner-message.d.ts +8 -0
  422. package/node_modules/@rokt/partner-integration/dist/cart/v2/placement-message.d.ts +10 -0
  423. package/node_modules/@rokt/partner-integration/dist/cart/v2/update-cart-item-partner-message-body.d.ts +4 -0
  424. package/node_modules/@rokt/partner-integration/dist/core/events.d.ts +45 -0
  425. package/node_modules/@rokt/partner-integration/dist/core/index.d.ts +1 -0
  426. package/node_modules/@rokt/partner-integration/dist/delivery-details/delivery-details.d.ts +20 -0
  427. package/node_modules/@rokt/partner-integration/dist/delivery-details/index.barrel.d.ts +2 -0
  428. package/node_modules/@rokt/partner-integration/dist/delivery-details/index.d.ts +2 -0
  429. package/node_modules/@rokt/partner-integration/dist/delivery-details/placement-message.d.ts +10 -0
  430. package/node_modules/@rokt/partner-integration/dist/extensions/extension-mapping.d.ts +9 -0
  431. package/node_modules/@rokt/partner-integration/dist/extensions/extension.d.ts +6 -0
  432. package/node_modules/@rokt/partner-integration/dist/extensions/index.barrel.d.ts +2 -0
  433. package/node_modules/@rokt/partner-integration/dist/extensions/index.d.ts +2 -0
  434. package/node_modules/@rokt/partner-integration/dist/index.d.ts +11 -0
  435. package/node_modules/@rokt/partner-integration/dist/index.js +1 -0
  436. package/node_modules/@rokt/partner-integration/dist/instant-purchase/cart-item-instant-purchase-message-body.d.ts +6 -0
  437. package/node_modules/@rokt/partner-integration/dist/instant-purchase/cart-item-instant-purchase-response-message-body.d.ts +11 -0
  438. package/node_modules/@rokt/partner-integration/dist/instant-purchase/index.barrel.d.ts +5 -0
  439. package/node_modules/@rokt/partner-integration/dist/instant-purchase/index.d.ts +2 -0
  440. package/node_modules/@rokt/partner-integration/dist/instant-purchase/partner-message.d.ts +8 -0
  441. package/node_modules/@rokt/partner-integration/dist/instant-purchase/placement-message.d.ts +9 -0
  442. package/node_modules/@rokt/partner-integration/dist/instant-purchase/v2/index.barrel.d.ts +5 -0
  443. package/node_modules/@rokt/partner-integration/dist/instant-purchase/v2/index.d.ts +1 -0
  444. package/node_modules/@rokt/partner-integration/dist/instant-purchase/v2/partner-message.d.ts +8 -0
  445. package/node_modules/@rokt/partner-integration/dist/instant-purchase/v2/placement-message.d.ts +9 -0
  446. package/node_modules/@rokt/partner-integration/dist/instant-purchase/v2/upsell-item-instant-purchase-message-body.d.ts +8 -0
  447. package/node_modules/@rokt/partner-integration/dist/instant-purchase/v2/upsell-item-instant-purchase-response-message-body.d.ts +11 -0
  448. package/node_modules/@rokt/partner-integration/dist/instant-purchase/v2/upsell-item.d.ts +26 -0
  449. package/node_modules/@rokt/partner-integration/dist/journey/index.barrel.d.ts +1 -0
  450. package/node_modules/@rokt/partner-integration/dist/journey/index.d.ts +2 -0
  451. package/node_modules/@rokt/partner-integration/dist/journey/journey-extension.d.ts +39 -0
  452. package/node_modules/@rokt/partner-integration/dist/link-navigation/index.d.ts +2 -0
  453. package/node_modules/@rokt/partner-integration/dist/link-navigation/link-navigation-message.d.ts +9 -0
  454. package/node_modules/@rokt/partner-integration/dist/link-navigation/link-navigation-request-body.d.ts +3 -0
  455. package/node_modules/@rokt/partner-integration/dist/partner-validation/events.d.ts +17 -0
  456. package/node_modules/@rokt/partner-integration/dist/partner-validation/index.barrel.d.ts +4 -0
  457. package/node_modules/@rokt/partner-integration/dist/partner-validation/index.d.ts +2 -0
  458. package/node_modules/@rokt/partner-integration/dist/partner-validation/partner-validation-extension.d.ts +7 -0
  459. package/node_modules/@rokt/partner-integration/dist/partner-validation/partner-validation-status.d.ts +10 -0
  460. package/node_modules/@rokt/partner-integration/dist/partner-validation/set-partner-validation-status.d.ts +12 -0
  461. package/node_modules/@rokt/partner-integration/dist/promotions-extension/index.d.ts +2 -0
  462. package/node_modules/@rokt/partner-integration/dist/promotions-extension/realtime-conversion-promotion-events.d.ts +6 -0
  463. package/node_modules/@rokt/partner-integration/dist/promotions-extension/realtime-conversion-promotion-payload.d.ts +1 -0
  464. package/node_modules/@rokt/partner-integration/dist/thank-you-page/index.barrel.d.ts +1 -0
  465. package/node_modules/@rokt/partner-integration/dist/thank-you-page/index.d.ts +2 -0
  466. package/node_modules/@rokt/partner-integration/dist/thank-you-page/thank-you-page-extension.d.ts +22 -0
  467. package/node_modules/@rokt/partner-integration/dist/upsells-offers/index.barrel.d.ts +5 -0
  468. package/node_modules/@rokt/partner-integration/dist/upsells-offers/index.d.ts +2 -0
  469. package/node_modules/@rokt/partner-integration/dist/upsells-offers/partner-message.d.ts +9 -0
  470. package/node_modules/@rokt/partner-integration/dist/upsells-offers/placement-message.d.ts +21 -0
  471. package/node_modules/@rokt/partner-integration/dist/upsells-offers/upsell-creative-sent-message-body.d.ts +14 -0
  472. package/node_modules/@rokt/partner-integration/dist/upsells-offers/upsells-offer.d.ts +35 -0
  473. package/node_modules/@rokt/partner-integration/dist/upsells-offers/upsells-offers-sent-body.d.ts +11 -0
  474. package/node_modules/@rokt/partner-integration/dist/user-action/index.barrel.d.ts +2 -0
  475. package/node_modules/@rokt/partner-integration/dist/user-action/index.d.ts +2 -0
  476. package/node_modules/@rokt/partner-integration/dist/user-action/user-action-event.d.ts +11 -0
  477. package/node_modules/@rokt/partner-integration/dist/user-action/user-action-extension.d.ts +4 -0
  478. package/node_modules/@rokt/partner-integration/package.json +34 -0
  479. package/node_modules/@rokt/plugin/bootstrap/bootstrap.d.ts +1 -2
  480. package/node_modules/@rokt/plugin/bootstrap/bootstrap.js +5 -30
  481. package/node_modules/@rokt/plugin/interface/context.d.ts +1 -0
  482. package/node_modules/@rokt/plugin/interface/display.d.ts +1 -0
  483. package/node_modules/@rokt/plugin/lib/index.barrel.d.ts +1 -14
  484. package/node_modules/@rokt/plugin/lib/index.barrel.js +1 -14
  485. package/node_modules/@rokt/plugin/lib/is-preload-frame.d.ts +1 -1
  486. package/node_modules/@rokt/plugin/lib/is-preload-frame.js +3 -1
  487. package/node_modules/@rokt/plugin/lib/plugin-instance.d.ts +13 -27
  488. package/node_modules/@rokt/plugin/lib/plugin-instance.js +1 -99
  489. package/node_modules/@rokt/plugin/package.json +15 -16
  490. package/node_modules/@rokt/plugin/standalone/standalone.d.ts +14 -2
  491. package/node_modules/@rokt/plugin/standalone/standalone.js +1 -0
  492. package/node_modules/@rokt/plugin/testing/mock-child-plugin-factory.d.ts +1 -1
  493. package/node_modules/@rokt/plugin/testing/mock-child-plugin-factory.js +2 -1
  494. package/node_modules/@rokt/plugin/testing/mock-child-plugin.d.ts +5 -5
  495. package/node_modules/@rokt/plugin/testing/mock-child-plugin.js +6 -5
  496. package/node_modules/@rokt/plugin/testing/mock-context.d.ts +18 -17
  497. package/node_modules/@rokt/plugin/testing/mock-context.js +19 -17
  498. package/node_modules/@rokt/plugin/testing/mock-display.d.ts +1 -1
  499. package/node_modules/@rokt/plugin/testing/mock-display.js +2 -1
  500. package/node_modules/@rokt/plugin/testing/mock-engine.d.ts +1 -2
  501. package/node_modules/@rokt/plugin/testing/mock-error.d.ts +1 -1
  502. package/node_modules/@rokt/plugin/testing/mock-error.js +2 -1
  503. package/node_modules/@rokt/plugin/testing/mock-function.d.ts +1 -0
  504. package/node_modules/@rokt/plugin/testing/mock-function.js +31 -0
  505. package/node_modules/@rokt/plugin/testing/mock-metrics.d.ts +4 -4
  506. package/node_modules/@rokt/plugin/testing/mock-metrics.js +5 -4
  507. package/node_modules/@rokt/plugin/testing/mock-parent-interaction.d.ts +2 -2
  508. package/node_modules/@rokt/plugin/testing/mock-parent-interaction.js +3 -2
  509. package/node_modules/@rokt/plugin/testing/mock-partner-interaction.d.ts +2 -2
  510. package/node_modules/@rokt/plugin/testing/mock-partner-interaction.js +3 -2
  511. package/node_modules/@rokt/plugin/testing/mock-rdn.d.ts +3 -3
  512. package/node_modules/@rokt/plugin/testing/mock-rdn.js +4 -3
  513. package/node_modules/@rokt/plugin/types/library-loaded.d.ts +0 -2
  514. package/node_modules/@rokt/plugin/types/library-loaded.js +0 -2
  515. package/package.json +8 -7
  516. package/dist/modules/instant-purchase/src/components/catalog-variation-selection-button/catalog-variation-selection-button.d.ts +0 -28
  517. package/node_modules/@rokt/plugin/lib/bootstrap-v1.d.ts +0 -3
  518. package/node_modules/@rokt/plugin/lib/bootstrap-v1.js +0 -9
  519. package/node_modules/@rokt/plugin/lib/child-plugin-factory.d.ts +0 -14
  520. package/node_modules/@rokt/plugin/lib/child-plugin-factory.js +0 -12
  521. package/node_modules/@rokt/plugin/lib/child-plugin.d.ts +0 -26
  522. package/node_modules/@rokt/plugin/lib/child-plugin.js +0 -81
  523. package/node_modules/@rokt/plugin/lib/context.d.ts +0 -23
  524. package/node_modules/@rokt/plugin/lib/context.js +0 -95
  525. package/node_modules/@rokt/plugin/lib/debug.d.ts +0 -19
  526. package/node_modules/@rokt/plugin/lib/debug.js +0 -36
  527. package/node_modules/@rokt/plugin/lib/display.d.ts +0 -13
  528. package/node_modules/@rokt/plugin/lib/display.js +0 -81
  529. package/node_modules/@rokt/plugin/lib/error.d.ts +0 -9
  530. package/node_modules/@rokt/plugin/lib/error.js +0 -35
  531. package/node_modules/@rokt/plugin/lib/is-inside-plugin-container.d.ts +0 -8
  532. package/node_modules/@rokt/plugin/lib/is-inside-plugin-container.js +0 -6
  533. package/node_modules/@rokt/plugin/lib/metrics.d.ts +0 -13
  534. package/node_modules/@rokt/plugin/lib/metrics.js +0 -55
  535. package/node_modules/@rokt/plugin/lib/parent-interaction.d.ts +0 -13
  536. package/node_modules/@rokt/plugin/lib/parent-interaction.js +0 -46
  537. package/node_modules/@rokt/plugin/lib/partner-interaction.d.ts +0 -11
  538. package/node_modules/@rokt/plugin/lib/partner-interaction.js +0 -35
  539. package/node_modules/@rokt/plugin/lib/plugin-runtime-connection.d.ts +0 -6
  540. package/node_modules/@rokt/plugin/lib/plugin-runtime-connection.js +0 -35
  541. package/node_modules/@rokt/plugin/lib/private-context.d.ts +0 -39
  542. package/node_modules/@rokt/plugin/lib/private-context.js +0 -76
  543. package/node_modules/@rokt/plugin/lib/rdn.d.ts +0 -15
  544. package/node_modules/@rokt/plugin/lib/rdn.js +0 -58
  545. package/node_modules/@rokt/plugin/lib/sender-receiver.d.ts +0 -5
  546. package/node_modules/@rokt/plugin/lib/sender-receiver.js +0 -1
  547. package/node_modules/@rokt/plugin/lib/theme.d.ts +0 -8
  548. package/node_modules/@rokt/plugin/lib/theme.js +0 -8
  549. package/node_modules/@rokt/plugin/lib/to-observable.d.ts +0 -4
  550. package/node_modules/@rokt/plugin/lib/to-observable.js +0 -12
  551. package/node_modules/@rokt/plugin/lib/unsafe.d.ts +0 -3
  552. package/node_modules/@rokt/plugin/lib/unsafe.js +0 -2
  553. package/node_modules/@rokt/plugin/lib/with-error-reporting.d.ts +0 -2
  554. package/node_modules/@rokt/plugin/lib/with-error-reporting.js +0 -22
  555. /package/dist/libraries/{layout-renderer-utils → dcui-components}/src/components/close-button/close-button.d.ts +0 -0
  556. /package/dist/libraries/{layout-renderer-utils → dcui-components}/src/components/close-button/index.d.ts +0 -0
  557. /package/dist/{modules/add-to-cart/src/selectors/globalOfferDataState → libraries/layout-renderer-utils/src/selectors/fired-events}/index.d.ts +0 -0
@@ -1,161 +1,486 @@
1
+ /** A URL value that supports light and dark mode themes. */
1
2
  export interface ThemeUrl {
3
+ /** The URL for light mode. */
2
4
  light: string;
5
+ /** The URL for dark mode. Omit to use the light mode URL in both themes. */
3
6
  dark?: null | string;
4
7
  }
5
- export type BackgroundImagePosition = "top" | "right" | "bottom" | "left" | "center" | "top-right" | "top-left" | "bottom-left" | "bottom-right";
6
- export type BackgroundImageScale = "crop" | "fit" | "fill";
8
+ /**
9
+ * Positioning of a background image within its container.
10
+ * Specifies which area of the container the image aligns to.
11
+ */
12
+ export type BackgroundImagePosition =
13
+ /** Positions the image at the top center. */
14
+ "top"
15
+ /** Positions the image at the center right. */
16
+ | "right"
17
+ /** Positions the image at the bottom center. */
18
+ | "bottom"
19
+ /** Positions the image at the center left. */
20
+ | "left"
21
+ /** Positions the image at the center of the container. */
22
+ | "center"
23
+ /** Positions the image at the top right corner. */
24
+ | "top-right"
25
+ /** Positions the image at the top left corner. */
26
+ | "top-left"
27
+ /** Positions the image at the bottom left corner. */
28
+ | "bottom-left"
29
+ /** Positions the image at the bottom right corner. */
30
+ | "bottom-right";
31
+ /**
32
+ * How a background image is scaled to fit its container.
33
+ * Controls the trade-off between covering the container and preserving aspect ratio.
34
+ */
35
+ export type BackgroundImageScale =
36
+ /** Scales the image to cover the entire container, cropping edges that overflow. */
37
+ "crop"
38
+ /** Scales the image to fit entirely within the container, potentially leaving empty space. */
39
+ | "fit"
40
+ /** Stretches the image to fill the container exactly, potentially distorting aspect ratio. */
41
+ | "fill";
42
+ /**
43
+ * A background image with themed URL support.
44
+ * Use this to display an image behind element content with control over positioning and scaling.
45
+ */
7
46
  export interface BackgroundImage {
47
+ /** The image URL. Uses themed values for light/dark mode. */
8
48
  url: ThemeUrl;
49
+ /** Where the image is positioned within the element. */
9
50
  position?: null | BackgroundImagePosition;
51
+ /** How the image is scaled to fit the element. */
10
52
  scale?: null | BackgroundImageScale;
11
53
  }
54
+ /**
55
+ * A color value that supports light and dark mode themes. Always provide the light mode value.
56
+ * Provide dark mode only if the color should differ from light mode.
57
+ * Colors are hex strings in `#RRGGBB` or `#AARRGGBB` format. NOTE: the alpha channel comes
58
+ * BEFORE the RGB channels (e.g. `#80000000` for 50% transparent black), unlike CSS where alpha is last.
59
+ */
12
60
  export interface ThemeColor {
61
+ /** The color hex code for light mode. Format: `#RRGGBB` or `#AARRGGBB` (e.g. "#FF0000", "#80000000"). */
13
62
  light: string;
63
+ /** The color hex code for dark mode. Omit to use the light mode value in both themes. */
14
64
  dark?: null | string;
15
65
  }
66
+ /**
67
+ * Background styling properties for elements.
68
+ * All fields are optional. Only include the properties you want to override.
69
+ */
16
70
  export interface BackgroundStylingProperties {
71
+ /** The background fill color. */
17
72
  backgroundColor?: null | ThemeColor;
73
+ /** A background image to display behind the element content. */
18
74
  backgroundImage?: null | BackgroundImage;
19
75
  }
76
+ /** A styling block that defines styles for different interaction states. The 'default' state is required; other states are optional and override default styles when active. */
20
77
  export interface BasicStateStylingBlock<StyleProperties> {
78
+ /** The base styles applied in the normal state. This is always required. */
21
79
  default: StyleProperties;
80
+ /** Styles applied when the element is being pressed/clicked. Only applicable to interactive elements. */
22
81
  pressed?: null | StyleProperties;
82
+ /** Styles applied when the cursor is over the element. Only applicable to interactive elements. */
23
83
  hovered?: null | StyleProperties;
84
+ /** Styles applied when the element has keyboard focus. */
24
85
  focussed?: null | StyleProperties;
86
+ /** Styles applied when the element is disabled. */
25
87
  disabled?: null | StyleProperties;
26
88
  }
27
- export type DimensionWidthValue = {
89
+ /**
90
+ * Width value specification. MUST be an object with 'type' and 'value' properties.
91
+ * Do NOT use bare numbers or CSS strings. Example: {"type": "percentage", "value": 100}.
92
+ */
93
+ export type DimensionWidthValue =
94
+ /** A fixed width in platform units (px on Web, pt on iOS, dp on Android). Value: {"type": "fixed", "value": <number>}. */
95
+ {
28
96
  type: "fixed";
29
97
  value: number;
30
- } | {
98
+ }
99
+ /** A percentage of the parent container width. Value: {"type": "percentage", "value": <0-100>}. */
100
+ | {
31
101
  type: "percentage";
32
102
  value: number;
33
- } | {
103
+ }
104
+ /** Sizes to fit content. Value: {"type": "fit", "value": "wrap-content" or "fit-width"}. */
105
+ | {
34
106
  type: "fit";
35
107
  value: DimensionWidthFitValue;
36
108
  };
37
- export type DimensionHeightValue = {
109
+ /**
110
+ * Height value specification. MUST be an object with 'type' and 'value' properties.
111
+ * Do NOT use bare numbers or CSS strings. Example: {"type": "fixed", "value": 200}.
112
+ */
113
+ export type DimensionHeightValue =
114
+ /** A fixed height in platform units (px on Web, pt on iOS, dp on Android). Value: {"type": "fixed", "value": <number>}. */
115
+ {
38
116
  type: "fixed";
39
117
  value: number;
40
- } | {
118
+ }
119
+ /** A percentage of the parent container height. Value: {"type": "percentage", "value": <0-100>}. */
120
+ | {
41
121
  type: "percentage";
42
122
  value: number;
43
- } | {
123
+ }
124
+ /** Sizes to fit content. Value: {"type": "fit", "value": "wrap-content" or "fit-height"}. */
125
+ | {
44
126
  type: "fit";
45
127
  value: DimensionHeightFitValue;
46
128
  };
129
+ /**
130
+ * Dimension and size styling properties. Numeric values are in platform units (px on Web, pt on iOS, dp on Android). Plain numbers (e.g. minWidth: 100)
131
+ * while width/height use typed objects. Do NOT use bare numbers for width or height.
132
+ * All fields are optional. Only include the properties you want to override.
133
+ */
47
134
  export interface DimensionStylingProperties {
135
+ /** Minimum width in platform units. */
48
136
  minWidth?: null | number;
137
+ /** Maximum width in platform units. */
49
138
  maxWidth?: null | number;
139
+ /**
140
+ * The width value. MUST be a typed object, e.g. {"type": "percentage", "value": 100}.
141
+ * Do NOT use bare numbers.
142
+ */
50
143
  width?: null | DimensionWidthValue;
144
+ /** Minimum height in platform units. */
51
145
  minHeight?: null | number;
146
+ /** Maximum height in platform units. */
52
147
  maxHeight?: null | number;
148
+ /**
149
+ * The height value. MUST be a typed object, e.g. {"type": "fixed", "value": 200}.
150
+ * Do NOT use bare numbers.
151
+ */
53
152
  height?: null | DimensionHeightValue;
153
+ /** Rotation around the z-axis in degrees. */
54
154
  rotateZ?: null | number;
55
155
  }
56
156
  export type FlexChildFlexPosition = "center" | "flex-start" | "flex-end" | "stretch";
157
+ /**
158
+ * Properties that control how this element behaves as a child within a flex container (Row or Column).
159
+ * All fields are optional. Only include the properties you want to override.
160
+ */
57
161
  export interface FlexChildStylingProperties {
162
+ /**
163
+ * The flex grow weight. Determines how remaining space is distributed.
164
+ * A child with weight 2 gets twice the extra space as one with weight 1.
165
+ */
58
166
  weight?: null | number;
167
+ /** The visual order of this child within its container. Lower values appear first. */
59
168
  order?: null | number;
169
+ /** Overrides the parent container's alignItems for this specific child. */
60
170
  alignSelf?: null | FlexChildFlexPosition;
61
171
  }
172
+ /**
173
+ * Spacing properties for padding, margin and offset.
174
+ * Values are specified as space-separated strings of numeric values in platform units (px on Web, pt on iOS, dp on Android) following CSS shorthand.
175
+ * All fields are optional. Only include the properties you want to override.
176
+ */
62
177
  export interface SpacingStylingProperties {
178
+ /**
179
+ * Internal spacing between the element border and its content. Specified as a
180
+ * space-separated string of numeric values following CSS shorthand: '10' for all sides,
181
+ * '10 20' for vertical/horizontal, '10 20 10 20' for top/right/bottom/left.
182
+ */
63
183
  padding?: null | string;
184
+ /** External spacing around the outside of the element border. Same format as padding. */
64
185
  margin?: null | string;
186
+ /** Positional offset from the element's normal position. Same format as padding. */
65
187
  offset?: null | string;
66
188
  }
67
- export type FontWeight = "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900";
68
- export type FontJustification = "left" | "right" | "center" | "start" | "end" | "justify";
69
- export type FontBaselineAlignment = "super" | "sub" | "baseline";
70
- export type FontStyle = "normal" | "italic";
71
- export type TextTransform = "capitalize" | "uppercase" | "lowercase" | "none";
72
- export type TextDecoration = "underline" | "strike-through" | "none";
189
+ /**
190
+ * The weight (boldness) of the font. Values are CSS-standard numeric weights.
191
+ * MUST be one of the predefined weight values. Do NOT use arbitrary numbers.
192
+ */
193
+ export type FontWeight =
194
+ /** Thin (Hairline). The lightest available weight. */
195
+ "100"
196
+ /** Extra Light (Ultra Light). */
197
+ | "200"
198
+ /** Light. */
199
+ | "300"
200
+ /** Normal / Regular. The default font weight. */
201
+ | "400"
202
+ /** Medium. Slightly bolder than normal. */
203
+ | "500"
204
+ /** Semi Bold (Demi Bold). */
205
+ | "600"
206
+ /** Bold. */
207
+ | "700"
208
+ /** Extra Bold (Ultra Bold). */
209
+ | "800"
210
+ /** Black (Heavy). The boldest available weight. */
211
+ | "900";
212
+ /**
213
+ * Horizontal text alignment within the text element.
214
+ * MUST use one of the specified alignment values. Do NOT use CSS text-align strings directly.
215
+ */
216
+ export type FontJustification =
217
+ /** Aligns text to the left edge. */
218
+ "left"
219
+ /** Aligns text to the right edge. */
220
+ | "right"
221
+ /** Centers text horizontally. */
222
+ | "center"
223
+ /** Aligns text to the start edge (left in LTR, right in RTL). */
224
+ | "start"
225
+ /** Aligns text to the end edge (right in LTR, left in RTL). */
226
+ | "end"
227
+ /** Stretches text so each line fills the full width, adjusting spacing between words. */
228
+ | "justify";
229
+ /**
230
+ * Vertical alignment of text relative to the baseline.
231
+ * Use this to position text as superscript, subscript, or at the normal baseline.
232
+ */
233
+ export type FontBaselineAlignment =
234
+ /** Raises text above the baseline (superscript). */
235
+ "super"
236
+ /** Lowers text below the baseline (subscript). */
237
+ | "sub"
238
+ /** Aligns text to the normal baseline position. */
239
+ | "baseline";
240
+ /**
241
+ * The style of the font.
242
+ * Controls whether text is rendered upright or italicised.
243
+ */
244
+ export type FontStyle =
245
+ /** Standard upright text. */
246
+ "normal"
247
+ /** Italicised text. */
248
+ | "italic";
249
+ /**
250
+ * Controls text capitalisation.
251
+ * Applied as a visual transform; does not alter the underlying text data.
252
+ */
253
+ export type TextTransform =
254
+ /** Capitalises the first letter of each word. */
255
+ "capitalize"
256
+ /** Transforms all text to uppercase. */
257
+ | "uppercase"
258
+ /** Transforms all text to lowercase. */
259
+ | "lowercase"
260
+ /** No transformation applied. */
261
+ | "none";
262
+ /**
263
+ * Decorative line applied to text.
264
+ * Use to add visual emphasis such as underline or strikethrough.
265
+ */
266
+ export type TextDecoration =
267
+ /** Adds a line beneath the text. */
268
+ "underline"
269
+ /** Adds a line through the middle of the text. */
270
+ | "strike-through"
271
+ /** No decoration applied. */
272
+ | "none";
273
+ /**
274
+ * Typography styling properties for text elements.
275
+ * All fields are optional. Only include the properties you want to override.
276
+ */
73
277
  export interface TextStylingProperties {
278
+ /** The text color. Uses themed values for light/dark mode support. */
74
279
  textColor?: null | ThemeColor;
280
+ /** Font size in platform units (px on Web, pt on iOS, dp on Android). */
75
281
  fontSize?: null | number;
282
+ /** The font family name. Use 'rokt-icons' for icon fonts. */
76
283
  fontFamily?: null | string;
284
+ /** The weight (boldness) of the font. */
77
285
  fontWeight?: null | FontWeight;
286
+ /** Line height in platform units. Controls the spacing between lines of text. */
78
287
  lineHeight?: null | number;
288
+ /** Horizontal text alignment within the element. */
79
289
  horizontalTextAlign?: null | FontJustification;
290
+ /** Vertical alignment of text relative to the baseline. */
80
291
  baselineTextAlign?: null | FontBaselineAlignment;
292
+ /** Normal or italic text rendering. */
81
293
  fontStyle?: null | FontStyle;
294
+ /** Controls automatic text capitalisation. */
82
295
  textTransform?: null | TextTransform;
296
+ /** Additional spacing between characters in platform units. */
83
297
  letterSpacing?: null | number;
298
+ /** Decorative line applied to text (underline, strikethrough). */
84
299
  textDecoration?: null | TextDecoration;
300
+ /** Maximum number of lines to display. Text beyond this limit is truncated. */
85
301
  lineLimit?: null | number;
86
302
  }
303
+ /** Visual styles for the BasicText node. */
87
304
  export interface BasicTextStyle {
305
+ /** Width, height and rotation properties. */
88
306
  dimension?: null | DimensionStylingProperties;
307
+ /** Properties controlling behaviour as a flex child. */
89
308
  flexChild?: null | FlexChildStylingProperties;
309
+ /** Padding, margin and offset properties. */
90
310
  spacing?: null | SpacingStylingProperties;
311
+ /** Background color and image properties. */
91
312
  background?: null | BackgroundStylingProperties;
313
+ /** Typography properties. */
92
314
  text?: null | TextStylingProperties;
93
315
  }
316
+ /** Style elements for the BasicText node. */
94
317
  export interface BasicTextElements {
318
+ /** Style blocks for the node's primary element. Array represents breakpoint-specific styles. */
95
319
  own: BasicStateStylingBlock<BasicTextStyle>[];
96
320
  }
97
321
  export type LayoutStyleTransition<Styles> = {
98
322
  type: "Conditional";
99
323
  transition: ConditionalStyleTransition<Styles>;
100
324
  };
325
+ /** The top-level style object for a node. Contains element styling and optional conditional transitions. */
101
326
  export interface LayoutStyle<ElementsStyles, TransitionsStyles> {
327
+ /** Defines the visual styles for each styleable element of this node. MUST contain at least an 'own' key with a styling block array. */
102
328
  elements?: null | ElementsStyles;
103
329
  transitions?: null | LayoutStyleTransition<TransitionsStyles>;
104
330
  }
331
+ /** Transition definitions for the BasicText node. */
105
332
  export interface BasicTextTransitions {
333
+ /** Transition properties for the primary element. */
106
334
  own?: null | BasicTextStyle;
107
335
  }
336
+ /** Renders a paragraph of plain text. Use for simple text content. For text with HTML formatting use RichText instead. */
108
337
  export interface BasicTextModel {
338
+ /** Visual styles for the text element. */
109
339
  styles?: null | LayoutStyle<BasicTextElements, BasicTextTransitions>;
340
+ /** The text content to display. Supports data binding placeholders in the format %^DATA.key^% for dynamic creative content. */
110
341
  value: string;
111
342
  }
112
- export type BorderStyle = "solid" | "dashed";
343
+ /**
344
+ * The visual style of the border line.
345
+ * MUST be one of the supported values. Do NOT use CSS border-style strings directly.
346
+ */
347
+ export type BorderStyle =
348
+ /** A solid continuous border line. */
349
+ "solid"
350
+ /** A dashed border line. */
351
+ | "dashed";
352
+ /**
353
+ * Border styling properties for elements.
354
+ * All fields are optional. Only include the properties you want to override.
355
+ */
113
356
  export interface BorderStylingProperties {
357
+ /** Corner radius in platform units (px on Web, pt on iOS, dp on Android). Applies uniformly to all corners. */
114
358
  borderRadius?: null | number;
359
+ /** The border color. Uses themed values for light/dark mode support. */
115
360
  borderColor?: null | ThemeColor;
361
+ /**
362
+ * Border width specified as a space-separated string of numeric values in platform units.
363
+ * Follows CSS shorthand: '2' for all sides, '2 4' for vertical/horizontal,
364
+ * '1 2 3 4' for top/right/bottom/left.
365
+ */
116
366
  borderWidth?: null | string;
367
+ /** The visual style of the border line (solid or dashed). */
117
368
  borderStyle?: null | BorderStyle;
118
369
  }
119
- export type OrderableWhenCondition = "is" | "is-not" | "is-below" | "is-above";
370
+ /**
371
+ * Condition operators for numeric/orderable comparisons. Use these to compare
372
+ * values that have a natural ordering (numbers, positions, breakpoints).
373
+ * Serialized as kebab-case strings: "is", "is-not", "is-below", "is-above".
374
+ */
375
+ export type OrderableWhenCondition =
376
+ /** True when the value equals the specified value. */
377
+ "is"
378
+ /** True when the value does not equal the specified value. */
379
+ | "is-not"
380
+ /** True when the value is less than the specified value. */
381
+ | "is-below"
382
+ /** True when the value is greater than the specified value. */
383
+ | "is-above";
384
+ /**
385
+ * Tests the viewport width against a breakpoint value. Use for
386
+ * responsive layouts that adapt to different screen sizes. The value MUST
387
+ * be a string representation of a number in platform units.
388
+ */
120
389
  export interface BreakpointPredicate {
390
+ /** The comparison operator. Use "is-above" or "is-below" for responsive breakpoints. */
121
391
  condition: OrderableWhenCondition;
392
+ /**
393
+ * The breakpoint width in platform units to compare against. MUST be a string
394
+ * representation of a number, e.g. "768".
395
+ */
122
396
  value: string;
123
397
  }
398
+ /** A styling block with only a default state. Used for non-interactive elements. */
124
399
  export interface StatelessStylingBlock<StyleProperties> {
400
+ /** The styles to apply. Always required. */
125
401
  default: StyleProperties;
126
402
  }
127
- export type FlexPosition = "center" | "flex-start" | "flex-end";
403
+ /** Position options within a flex context. */
404
+ export type FlexPosition =
405
+ /** Centers items along the main axis. */
406
+ "center"
407
+ /** Packs items toward the start of the main axis. */
408
+ | "flex-start"
409
+ /** Packs items toward the end of the main axis. */
410
+ | "flex-end";
411
+ /** Defines a box shadow effect. All offset and radius values are in platform units (px on Web, pt on iOS, dp on Android). */
128
412
  export interface Shadow {
413
+ /** Horizontal offset of the shadow. Positive values move the shadow right. */
129
414
  offsetX?: null | number;
415
+ /** Vertical offset of the shadow. Positive values move the shadow down. */
130
416
  offsetY?: null | number;
417
+ /** The blur radius. Higher values create a more diffuse shadow. */
131
418
  blurRadius?: null | number;
419
+ /** The spread radius. Positive values expand the shadow, negative values shrink it. */
132
420
  spreadRadius?: null | number;
421
+ /** The shadow color. */
133
422
  color: ThemeColor;
134
423
  }
135
- export type Overflow = "auto" | "hidden" | "visible" | "scroll";
424
+ /** Controls visibility of content that overflows the container bounds. */
425
+ export type Overflow = "auto"
426
+ /** Content that overflows is clipped and not visible. */
427
+ | "hidden"
428
+ /** Content that overflows remains visible outside the container bounds. */
429
+ | "visible" | "scroll";
430
+ /** Styling properties for container layout behaviour. Only applicable to nodes that contain children. */
136
431
  export interface ContainerStylingProperties {
432
+ /** Controls how children are distributed along the main axis. For a Row this is horizontal, for a Column this is vertical. */
137
433
  justifyContent?: null | FlexPosition;
434
+ /** Controls how children are aligned along the cross axis. For a Row this is vertical, for a Column this is horizontal. */
138
435
  alignItems?: null | FlexPosition;
436
+ /** Applies a box shadow effect around the container. */
139
437
  shadow?: null | Shadow;
438
+ /** Controls whether content overflowing the container bounds is visible or hidden. */
140
439
  overflow?: null | Overflow;
440
+ /** The gap in platform units between children in the container. */
141
441
  gap?: null | number;
442
+ /** Applies a Gaussian blur effect. Value is the blur radius in platform units. */
142
443
  blur?: null | number;
143
444
  }
445
+ /**
446
+ * Visual style properties for the CarouselDistribution container.
447
+ * Contains the standard style categories: container layout, background colors,
448
+ * border appearance, dimensions, flex child positioning, and spacing.
449
+ */
144
450
  export interface CarouselDistributionStyles {
451
+ /** Container layout styles (e.g. flex direction, alignment). */
145
452
  container?: null | ContainerStylingProperties;
453
+ /** Background color and gradient styles. */
146
454
  background?: null | BackgroundStylingProperties;
455
+ /** Border width, color, and radius styles. */
147
456
  border?: null | BorderStylingProperties;
457
+ /** Width and height dimension styles. */
148
458
  dimension?: null | DimensionStylingProperties;
459
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
149
460
  flexChild?: null | FlexChildStylingProperties;
461
+ /** Padding and margin spacing styles. */
150
462
  spacing?: null | SpacingStylingProperties;
151
463
  }
464
+ /**
465
+ * Styling elements for the CarouselDistribution container.
466
+ * The `own` array contains stateless styling blocks applied to the carousel container itself.
467
+ */
152
468
  export interface CarouselDistributionElements {
469
+ /** Array of stateless styling blocks for the carousel container. */
153
470
  own: StatelessStylingBlock<CarouselDistributionStyles>[];
154
471
  }
155
- export type PeekThroughSize = {
472
+ /**
473
+ * The size of the peek-through area showing adjacent carousel items.
474
+ * Controls how much of the next/previous items are visible at the edges.
475
+ */
476
+ export type PeekThroughSize =
477
+ /** A fixed size in platform units (px on Web, pt on iOS, dp on Android) for the peek-through area. */
478
+ {
156
479
  type: "Fixed";
157
480
  value: number;
158
- } | {
481
+ }
482
+ /** A percentage-based size for the peek-through area, relative to the carousel width. */
483
+ | {
159
484
  type: "Percentage";
160
485
  value: number;
161
486
  };
@@ -163,210 +488,612 @@ export interface CarouselSettings {
163
488
  viewableItems: number[];
164
489
  peekThroughSize: PeekThroughSize[];
165
490
  }
491
+ /** Transition styles for animating CarouselDistribution style changes. */
166
492
  export interface CarouselDistributionTransitions {
493
+ /** Transition properties for the carousel container's own styles. */
167
494
  own?: null | CarouselDistributionStyles;
168
495
  }
496
+ /**
497
+ * Presents offers in a horizontally scrollable carousel.
498
+ * Used EXCLUSIVELY in the Outer Layout. This is the container into which offers (Layout Variants) are rendered.
499
+ * Users can swipe left/right to browse offers.
500
+ *
501
+ * Use `viewableItems` to control how many items are visible at once per breakpoint.
502
+ * Use `peekThroughSize` to hint that more items exist by showing partial adjacent items.
503
+ */
169
504
  export interface CarouselDistributionModel {
170
505
  settings: CarouselSettings;
506
+ /**
507
+ * Visual styles for the carousel container.
508
+ * Uses the LayoutStyle wrapper with conditional style transitions.
509
+ */
171
510
  styles?: null | LayoutStyle<CarouselDistributionElements, CarouselDistributionTransitions>;
172
511
  }
512
+ /**
513
+ * Visual style properties for the stacked collection container.
514
+ * Controls the layout and appearance of the outer wrapper that holds
515
+ * the stacked catalog item cards.
516
+ */
173
517
  export interface CatalogStackedCollectionStyles {
518
+ /** Layout properties for the flex container. */
174
519
  container?: null | ContainerStylingProperties;
520
+ /** Background color and image properties. */
175
521
  background?: null | BackgroundStylingProperties;
522
+ /** Border radius, color, width and style. */
176
523
  border?: null | BorderStylingProperties;
524
+ /** Width, height and rotation properties. */
177
525
  dimension?: null | DimensionStylingProperties;
526
+ /** Properties controlling behaviour as a flex child. */
178
527
  flexChild?: null | FlexChildStylingProperties;
528
+ /** Padding, margin and offset properties. */
179
529
  spacing?: null | SpacingStylingProperties;
180
530
  }
531
+ /**
532
+ * Breakpoint-specific style elements for a catalog stacked collection.
533
+ * Uses stateless styling blocks since this is a static container without
534
+ * interactive states.
535
+ */
181
536
  export interface CatalogStackedCollectionElements {
537
+ /** Style blocks for the node's primary element. Array represents breakpoint-specific styles. */
182
538
  own: StatelessStylingBlock<CatalogStackedCollectionStyles>[];
183
539
  }
540
+ /** Transition properties for animating style changes on a catalog stacked collection. */
184
541
  export interface CatalogStackedCollectionTransitions {
542
+ /** Transition properties for the primary element. */
185
543
  own?: null | CatalogStackedCollectionStyles;
186
544
  }
545
+ /**
546
+ * A vertically stacked collection of catalog items for add-to-cart flows.
547
+ * Renders each catalog product as a card in a vertical stack layout, where items
548
+ * are presented one below another. The visual content of each item is defined by
549
+ * a reusable template node that is instantiated per product in the collection.
550
+ */
187
551
  export interface CatalogStackedCollectionModel<NodeTemplate> {
552
+ /**
553
+ * Responsive and conditional styling for this collection container, including
554
+ * breakpoint-specific element styles and animated transitions.
555
+ */
188
556
  styles?: null | LayoutStyle<CatalogStackedCollectionElements, CatalogStackedCollectionTransitions>;
557
+ /**
558
+ * Template node used to render each catalog item in the stacked collection.
559
+ * This template is instantiated once per product, with product-specific data
560
+ * bound at runtime.
561
+ */
189
562
  template: NodeTemplate;
190
563
  }
564
+ /**
565
+ * Visual style properties for the CloseButton.
566
+ * Contains the standard style categories: container layout, background colors,
567
+ * border appearance, dimensions, flex child positioning, and spacing.
568
+ */
191
569
  export interface CloseButtonStyles {
570
+ /** Container layout styles (e.g. flex direction, alignment). */
192
571
  container?: null | ContainerStylingProperties;
572
+ /** Background color and gradient styles. */
193
573
  background?: null | BackgroundStylingProperties;
574
+ /** Border width, color, and radius styles. */
194
575
  border?: null | BorderStylingProperties;
576
+ /** Width and height dimension styles. */
195
577
  dimension?: null | DimensionStylingProperties;
578
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
196
579
  flexChild?: null | FlexChildStylingProperties;
580
+ /** Padding and margin spacing styles. */
197
581
  spacing?: null | SpacingStylingProperties;
198
582
  }
583
+ /**
584
+ * Styling elements for the CloseButton.
585
+ * The `own` array contains state-dependent styling blocks (e.g. default, pressed)
586
+ * applied to the close button itself.
587
+ */
199
588
  export interface CloseButtonElements {
589
+ /**
590
+ * Array of state-dependent styling blocks for the close button.
591
+ * Each block targets a specific interaction state (default, pressed, etc.).
592
+ */
200
593
  own: BasicStateStylingBlock<CloseButtonStyles>[];
201
594
  }
595
+ /**
596
+ * Transition styles for animating CloseButton style changes.
597
+ * Defines which style properties should animate when the button's conditional styles change.
598
+ */
202
599
  export interface CloseButtonTransitions {
600
+ /** Transition properties for the close button's own styles. */
203
601
  own?: null | CloseButtonStyles;
204
602
  }
603
+ /**
604
+ * A button that closes/dismisses the layout when clicked.
605
+ * Typically contains a StaticIcon with the 'Close' icon.
606
+ *
607
+ * MUST include child content (usually a StaticIcon with name `"Close"`).
608
+ * Do NOT use CreativeResponse for dismissal; use CloseButton instead so that
609
+ * the dismiss action is correctly tracked.
610
+ */
205
611
  export interface CloseButtonModel<Children> {
612
+ /** Visual styles for the close button. Uses the LayoutStyle wrapper with conditional style transitions. */
206
613
  styles?: null | LayoutStyle<CloseButtonElements, CloseButtonTransitions>;
614
+ /**
615
+ * Child nodes forming the button content. Typically a StaticIcon with name `"Close"`.
616
+ * MUST contain at least one child to display the close icon or label.
617
+ */
207
618
  children: Children[];
619
+ /**
620
+ * Optional dismissal method configuration.
621
+ * Controls how the dismissal is reported for analytics purposes.
622
+ */
208
623
  dismissalMethod?: null | string;
209
624
  }
625
+ /**
626
+ * Available style categories for the Column element. Each optional field enables a specific
627
+ * category of visual styling. Omit a field to leave that category unstyled.
628
+ */
210
629
  export interface ColumnStyle {
630
+ /**
631
+ * Layout properties for the flex container (justification, alignment, gap, overflow).
632
+ * MUST be used to control how children are arranged within the column.
633
+ */
211
634
  container?: null | ContainerStylingProperties;
635
+ /**
636
+ * Background color and image properties. Use to set a solid color, gradient, or image
637
+ * behind the column content.
638
+ */
212
639
  background?: null | BackgroundStylingProperties;
640
+ /**
641
+ * Border radius, color, width and style properties. Use to add visible borders or
642
+ * rounded corners to the column.
643
+ */
213
644
  border?: null | BorderStylingProperties;
645
+ /**
646
+ * Width, height and rotation properties. Use to explicitly size the column or apply
647
+ * rotation transforms. Do NOT set width/height if the column should size to its content.
648
+ */
214
649
  dimension?: null | DimensionStylingProperties;
650
+ /**
651
+ * Properties controlling this element's behaviour as a child of a flex container.
652
+ * Use to set flex-grow, flex-shrink, flex-basis, and align-self.
653
+ */
215
654
  flexChild?: null | FlexChildStylingProperties;
655
+ /** Padding, margin and offset properties. Use to add spacing inside or outside the column. */
216
656
  spacing?: null | SpacingStylingProperties;
217
657
  }
658
+ /**
659
+ * Styleable elements of the Column node. The Column has a single styleable element: its own
660
+ * container.
661
+ */
218
662
  export interface ColumnElements {
663
+ /**
664
+ * Style blocks for the column container itself. The array represents breakpoint-specific
665
+ * styles: first item is the default (no breakpoint), subsequent items correspond to
666
+ * breakpoints in ascending order. MUST contain at least one item for the default style.
667
+ */
219
668
  own: BasicStateStylingBlock<ColumnStyle>[];
220
669
  }
670
+ /** Transition styles for the Column node. Use to animate style changes smoothly. */
221
671
  export interface ColumnTransitions {
672
+ /**
673
+ * Transition properties for the column container. Specifies which style properties
674
+ * should animate and their duration/easing when values change.
675
+ */
222
676
  own?: null | ColumnStyle;
223
677
  }
678
+ /**
679
+ * A vertical flex container that arranges its children in a column (top to bottom). Use for
680
+ * vertical layouts. Children are laid out along the vertical axis by default. To control
681
+ * alignment and distribution, configure the container styles. Do NOT nest Columns
682
+ * unnecessarily when a single Column with appropriate styling would suffice.
683
+ */
224
684
  export interface ColumnModel<Children> {
685
+ /**
686
+ * Visual styles for this column. See styling documentation for the structure. Omit to use
687
+ * default (unstyled) rendering.
688
+ */
225
689
  styles?: null | LayoutStyle<ColumnElements, ColumnTransitions>;
690
+ /**
691
+ * Child nodes rendered vertically within this column.
692
+ * Children are laid out top to bottom in source order.
693
+ */
226
694
  children: Children[];
227
695
  }
228
- export type WhenPredicate = {
696
+ /**
697
+ * All available predicate types for conditional rendering in the full layout
698
+ * schema. Used with the When node to conditionally show or hide children.
699
+ * Each predicate MUST include a "type" field to identify the predicate kind
700
+ * and a "predicate" field containing the predicate configuration.
701
+ */
702
+ export type WhenPredicate =
703
+ /** Tests the viewport width against a breakpoint value. */
704
+ {
229
705
  type: "Breakpoint";
230
706
  predicate: BreakpointPredicate;
231
- } | {
707
+ }
708
+ /** Tests the position index of the current item in a collection. */
709
+ | {
232
710
  type: "Position";
233
711
  predicate: PositionPredicate;
234
- } | {
712
+ }
713
+ /** Tests which offer index is currently visible. */
714
+ | {
235
715
  type: "Progression";
236
716
  predicate: ProgressionPredicate;
237
- } | {
717
+ }
718
+ /** Tests whether dark mode is active. */
719
+ | {
238
720
  type: "DarkMode";
239
721
  predicate: DarkModePredicate;
240
- } | {
722
+ }
723
+ /** Tests whether a creative data attribute exists. */
724
+ | {
241
725
  type: "CreativeCopy";
242
726
  predicate: CreativeCopyPredicate;
243
- } | {
727
+ }
728
+ /** Evaluates a hardcoded boolean value. */
729
+ | {
244
730
  type: "StaticBoolean";
245
731
  predicate: StaticBooleanPredicate;
246
- } | {
732
+ }
733
+ /** Tests a custom state value set by state trigger nodes. */
734
+ | {
247
735
  type: "CustomState";
248
736
  predicate: CustomStatePredicate;
249
737
  };
738
+ /** Defines a style transition that is applied when the specified predicates evaluate to true. */
250
739
  export interface ConditionalStyleTransition<Styles> {
740
+ /** The list of conditions that must all be true for this transition to apply. */
251
741
  predicates: WhenPredicate[];
742
+ /** The transition duration in milliseconds. */
252
743
  duration: number;
744
+ /** The style properties to apply when all predicates are met. */
253
745
  value: Styles;
254
746
  }
255
- export type ExistenceWhenCondition = "exists" | "not-exists";
747
+ /**
748
+ * Condition operators for checking whether a value exists. Use these to
749
+ * conditionally render content based on whether data is present.
750
+ * Serialized as kebab-case strings: "exists", "not-exists".
751
+ */
752
+ export type ExistenceWhenCondition =
753
+ /** True when the value is present and non-empty. */
754
+ "exists"
755
+ /** True when the value is absent or empty. */
756
+ | "not-exists";
757
+ /**
758
+ * Tests whether a creative data attribute exists. Use to conditionally show
759
+ * content only when specific creative data is available. Do NOT use this for
760
+ * non-creative data checks.
761
+ */
256
762
  export interface CreativeCopyPredicate {
763
+ /** Whether to check for existence or non-existence of the creative attribute. */
257
764
  condition: ExistenceWhenCondition;
765
+ /**
766
+ * The dot-notation path to the creative attribute, e.g.
767
+ * "creative.socialProof.number". MUST use dot notation to reference
768
+ * nested creative data fields.
769
+ */
258
770
  value: string;
259
771
  }
772
+ /**
773
+ * Visual style properties for the CreativeResponse button.
774
+ * Contains the standard style categories: container layout, background colors,
775
+ * border appearance, dimensions, flex child positioning, and spacing.
776
+ */
260
777
  export interface CreativeResponseStyles {
778
+ /** Container layout styles (e.g. flex direction, alignment). */
261
779
  container?: null | ContainerStylingProperties;
780
+ /** Background color and gradient styles. */
262
781
  background?: null | BackgroundStylingProperties;
782
+ /** Border width, color, and radius styles. */
263
783
  border?: null | BorderStylingProperties;
784
+ /** Width and height dimension styles. */
264
785
  dimension?: null | DimensionStylingProperties;
786
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
265
787
  flexChild?: null | FlexChildStylingProperties;
788
+ /** Padding and margin spacing styles. */
266
789
  spacing?: null | SpacingStylingProperties;
267
790
  }
791
+ /**
792
+ * Styling elements for the CreativeResponse button.
793
+ * The `own` array contains state-dependent styling blocks (e.g. default, pressed, disabled)
794
+ * applied to the button itself.
795
+ */
268
796
  export interface CreativeResponseElements {
797
+ /**
798
+ * Array of state-dependent styling blocks for the button.
799
+ * Each block targets a specific interaction state (default, pressed, disabled, etc.).
800
+ */
269
801
  own: BasicStateStylingBlock<CreativeResponseStyles>[];
270
802
  }
803
+ /**
804
+ * Transition styles for animating CreativeResponse style changes.
805
+ * Defines which style properties should animate when the button's conditional styles change.
806
+ */
271
807
  export interface CreativeResponseTransitions {
808
+ /** Transition properties for the button's own styles. */
272
809
  own?: null | CreativeResponseStyles;
273
810
  }
274
- export type LinkOpenTarget = "internally" | "externally";
811
+ /**
812
+ * Controls how links are opened when clicked. MUST be one of the valid
813
+ * kebab-case string values. Determines the navigation behavior when a
814
+ * user activates a link action.
815
+ */
816
+ export type LinkOpenTarget =
817
+ /**
818
+ * Opens the link within the current context (in-app webview or same
819
+ * window). Use for links that should keep the user in the application.
820
+ */
821
+ "internally"
822
+ /**
823
+ * Opens the link in the system browser. Use for external URLs that
824
+ * should leave the application context.
825
+ */
826
+ | "externally";
827
+ /**
828
+ * A button that triggers a creative response (positive or negative).
829
+ * This is the primary call-to-action node for offer interactions.
830
+ * Children inside this node become the button content.
831
+ *
832
+ * MUST have a `responseKey` of either `"positive"` or `"negative"`.
833
+ * Use `"positive"` for accept/CTA buttons and `"negative"` for decline/dismiss buttons.
834
+ * Do NOT use this node for non-response actions like navigation; use StaticLink or ButtonStateTrigger instead.
835
+ */
275
836
  export interface CreativeResponseModel<Children> {
837
+ /**
838
+ * The response type. Use `"positive"` for accept/CTA buttons, `"negative"` for decline/dismiss buttons.
839
+ * Do NOT use arbitrary strings; only `"positive"` and `"negative"` are valid.
840
+ */
276
841
  responseKey: string;
842
+ /** Visual styles for the button. Uses the LayoutStyle wrapper with conditional style transitions. */
277
843
  styles?: null | LayoutStyle<CreativeResponseElements, CreativeResponseTransitions>;
844
+ /**
845
+ * Controls how the response URL is opened when clicked.
846
+ * If omitted, the default link opening behaviour is used.
847
+ */
278
848
  openLinks?: null | LinkOpenTarget;
849
+ /**
850
+ * Child nodes that form the button's visible content.
851
+ * Typically contains a BasicText node with the CTA label.
852
+ * MUST contain at least one child to display button content.
853
+ */
279
854
  children: Children[];
280
855
  }
856
+ /**
857
+ * Tests a custom state value. Custom states are set by state trigger nodes
858
+ * such as ButtonStateTrigger, ToggleButtonStateTrigger, and similar components.
859
+ * The value is an integer that represents the current state.
860
+ */
281
861
  export interface CustomStatePredicate {
862
+ /**
863
+ * The custom state key to check. MUST match the key used in the
864
+ * corresponding state trigger node.
865
+ */
282
866
  key: string;
867
+ /** The comparison operator. */
283
868
  condition: OrderableWhenCondition;
869
+ /** The integer value to compare the custom state against. */
284
870
  value: number;
285
871
  }
286
- export type EqualityWhenCondition = "is" | "is-not";
872
+ /**
873
+ * Condition operators for equality comparisons. Use these when you only need
874
+ * to test if two values are equal or not equal.
875
+ * Serialized as kebab-case strings: "is", "is-not".
876
+ */
877
+ export type EqualityWhenCondition =
878
+ /** True when the value equals the specified value. */
879
+ "is"
880
+ /** True when the value does not equal the specified value. */
881
+ | "is-not";
882
+ /**
883
+ * Tests whether dark mode is active. Use to provide different styling or
884
+ * content for light and dark modes.
885
+ */
287
886
  export interface DarkModePredicate {
887
+ /** Use "is" to check if dark mode matches the value, "is-not" for the inverse. */
288
888
  condition: EqualityWhenCondition;
889
+ /**
890
+ * The boolean value to compare against. Set to true to test for dark mode,
891
+ * false to test for light mode.
892
+ */
289
893
  value: boolean;
290
894
  }
895
+ /** Visual styles for the DataIcon node. */
291
896
  export interface DataIconStyles {
897
+ /** Typography properties. */
292
898
  text?: null | TextStylingProperties;
899
+ /** Width, height and rotation properties. */
293
900
  dimension?: null | DimensionStylingProperties;
901
+ /** Properties controlling behaviour as a flex child. */
294
902
  flexChild?: null | FlexChildStylingProperties;
903
+ /** Padding, margin and offset properties. */
295
904
  spacing?: null | SpacingStylingProperties;
905
+ /** Background color and image properties. */
296
906
  background?: null | BackgroundStylingProperties;
907
+ /** Border radius, color, width and style. */
297
908
  border?: null | BorderStylingProperties;
298
909
  }
910
+ /** Style elements for the DataIcon node. */
299
911
  export interface DataIconElements {
912
+ /** Style blocks for the node's primary element. Array represents breakpoint-specific styles. */
300
913
  own: BasicStateStylingBlock<DataIconStyles>[];
301
914
  }
915
+ /** Transition definitions for the DataIcon node. */
302
916
  export interface DataIconTransitions {
917
+ /** Transition properties for the primary element. */
303
918
  own?: null | DataIconStyles;
304
919
  }
920
+ /** Renders an icon from creative data. The icon is resolved from the creative object using the iconKey. */
305
921
  export interface DataIconModel {
922
+ /** Visual styles for the icon. */
306
923
  styles?: null | LayoutStyle<DataIconElements, DataIconTransitions>;
924
+ /** The key identifying which icon from the creative data to display. */
307
925
  iconKey: string;
308
926
  isImportantForAccessibility?: null | boolean;
309
927
  }
928
+ /** Visual styles for the DataImage node. */
310
929
  export interface DataImageStyles {
930
+ /** Background color and image properties. */
311
931
  background?: null | BackgroundStylingProperties;
932
+ /** Border radius, color, width and style. */
312
933
  border?: null | BorderStylingProperties;
934
+ /** Width, height and rotation properties. */
313
935
  dimension?: null | DimensionStylingProperties;
936
+ /** Properties controlling behaviour as a flex child. */
314
937
  flexChild?: null | FlexChildStylingProperties;
938
+ /** Padding, margin and offset properties. */
315
939
  spacing?: null | SpacingStylingProperties;
316
940
  }
941
+ /** Style elements for the DataImage node. */
317
942
  export interface DataImageElements {
943
+ /** Style blocks for the node's primary element. Array represents breakpoint-specific styles. */
318
944
  own: BasicStateStylingBlock<DataImageStyles>[];
319
945
  }
946
+ /** Transition definitions for the DataImage node. */
320
947
  export interface DataImageTransitions {
948
+ /** Transition properties for the primary element. */
321
949
  own?: null | DataImageStyles;
322
950
  }
951
+ /** Renders an image from creative data. The image URL is resolved from the creative object using the imageKey. Use for offer-specific images. */
323
952
  export interface DataImageModel {
953
+ /** Visual styles for the image element. */
324
954
  styles?: null | LayoutStyle<DataImageElements, DataImageTransitions>;
955
+ /** The key identifying which image from the creative data to display. */
325
956
  imageKey: string;
326
957
  isImportantForAccessibility?: null | boolean;
327
958
  }
959
+ /** Settings for a bidirectional fade-in/fade-out transition. */
328
960
  export interface FadeInOutTransitionSettings {
961
+ /**
962
+ * The transition duration in milliseconds. MUST be a positive integer.
963
+ * Common values: 200 for fast, 400 for medium, 1000 for slow.
964
+ */
329
965
  duration: number;
330
966
  }
967
+ /** Settings for a fade-in (enter) transition. */
331
968
  export interface FadeInTransitionSettings {
969
+ /**
970
+ * The transition duration in milliseconds. MUST be a positive integer.
971
+ * Common values: 200 for fast, 400 for medium, 1000 for slow.
972
+ */
332
973
  duration: number;
333
974
  }
975
+ /** Settings for a fade-out (exit) transition. */
334
976
  export interface FadeOutTransitionSettings {
977
+ /**
978
+ * The transition duration in milliseconds. MUST be a positive integer.
979
+ * Common values: 200 for fast, 400 for medium, 1000 for slow.
980
+ */
335
981
  duration: number;
336
982
  }
983
+ /**
984
+ * Available style categories for the FlowRow element. Each optional field enables a specific
985
+ * category of visual styling. Omit a field to leave that category unstyled.
986
+ */
337
987
  export interface FlowRowStyle {
988
+ /**
989
+ * Layout properties for the flex container (justification, alignment, gap, overflow).
990
+ * MUST be used to control how children are arranged and wrapped within the flow row.
991
+ */
338
992
  container?: null | ContainerStylingProperties;
993
+ /**
994
+ * Background color and image properties. Use to set a solid color, gradient, or image
995
+ * behind the flow row content.
996
+ */
339
997
  background?: null | BackgroundStylingProperties;
998
+ /**
999
+ * Border radius, color, width and style properties. Use to add visible borders or
1000
+ * rounded corners to the flow row.
1001
+ */
340
1002
  border?: null | BorderStylingProperties;
1003
+ /**
1004
+ * Width, height and rotation properties. Use to explicitly size the flow row or apply
1005
+ * rotation transforms. Do NOT set width/height if the flow row should size to its content.
1006
+ */
341
1007
  dimension?: null | DimensionStylingProperties;
1008
+ /**
1009
+ * Properties controlling this element's behaviour as a child of a flex container.
1010
+ * Use to set flex-grow, flex-shrink, flex-basis, and align-self.
1011
+ */
342
1012
  flexChild?: null | FlexChildStylingProperties;
1013
+ /** Padding, margin and offset properties. Use to add spacing inside or outside the flow row. */
343
1014
  spacing?: null | SpacingStylingProperties;
344
1015
  }
1016
+ /**
1017
+ * Styleable elements of the FlowRow node. The FlowRow has a single styleable element: its
1018
+ * own container.
1019
+ */
345
1020
  export interface FlowRowElements {
1021
+ /**
1022
+ * Style blocks for the flow row container itself. The array represents breakpoint-specific
1023
+ * styles: first item is the default (no breakpoint), subsequent items correspond to
1024
+ * breakpoints in ascending order. MUST contain at least one item for the default style.
1025
+ */
346
1026
  own: BasicStateStylingBlock<FlowRowStyle>[];
347
1027
  }
1028
+ /** Transition styles for the FlowRow node. Use to animate style changes smoothly. */
348
1029
  export interface FlowRowTransitions {
1030
+ /**
1031
+ * Transition properties for the flow row container. Specifies which style properties
1032
+ * should animate and their duration/easing when values change.
1033
+ */
349
1034
  own?: null | FlowRowStyle;
350
1035
  }
1036
+ /**
1037
+ * A horizontal flex container that wraps children to the next line when they exceed the
1038
+ * container width. Like Row but with line wrapping. Use when you have a dynamic number of
1039
+ * items that should flow naturally across lines (e.g., tags, chips, badges). Do NOT use
1040
+ * FlowRow when you need a single non-wrapping horizontal row; use Row instead.
1041
+ */
351
1042
  export interface FlowRowModel<Children> {
1043
+ /**
1044
+ * Visual styles for this flow row. See styling documentation for the structure. Omit to
1045
+ * use default (unstyled) rendering.
1046
+ */
352
1047
  styles?: null | LayoutStyle<FlowRowElements, FlowRowTransitions>;
1048
+ /**
1049
+ * Child nodes rendered horizontally with wrapping within this flow row. MUST contain at
1050
+ * least one child. Children wrap to the next line when they exceed the container width.
1051
+ */
353
1052
  children: Children[];
354
1053
  }
1054
+ /**
1055
+ * Visual style properties for the GroupedDistribution container.
1056
+ * Contains the standard style categories: container layout, background colors,
1057
+ * border appearance, dimensions, flex child positioning, and spacing.
1058
+ */
355
1059
  export interface GroupedDistributionStyles {
1060
+ /** Container layout styles (e.g. flex direction, alignment). */
356
1061
  container?: null | ContainerStylingProperties;
1062
+ /** Background color and gradient styles. */
357
1063
  background?: null | BackgroundStylingProperties;
1064
+ /** Border width, color, and radius styles. */
358
1065
  border?: null | BorderStylingProperties;
1066
+ /** Width and height dimension styles. */
359
1067
  dimension?: null | DimensionStylingProperties;
1068
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
360
1069
  flexChild?: null | FlexChildStylingProperties;
1070
+ /** Padding and margin spacing styles. */
361
1071
  spacing?: null | SpacingStylingProperties;
362
1072
  }
1073
+ /**
1074
+ * Styling elements for the GroupedDistribution container.
1075
+ * The `own` array contains stateless styling blocks applied to the grouped container itself.
1076
+ */
363
1077
  export interface GroupedDistributionElements {
1078
+ /** Array of stateless styling blocks for the grouped container. */
364
1079
  own: StatelessStylingBlock<GroupedDistributionStyles>[];
365
1080
  }
1081
+ /** Transition styles for animating GroupedDistribution style changes. */
366
1082
  export interface GroupedDistributionTransitions {
1083
+ /** Transition properties for the grouped container's own styles. */
367
1084
  own?: null | GroupedDistributionStyles;
368
1085
  }
369
- export type Transition = {
1086
+ /**
1087
+ * A bidirectional transition that applies both when showing and hiding an
1088
+ * element. MUST be an object with a "type" field and a "settings" field.
1089
+ * Currently only "FadeInOut" is supported.
1090
+ */
1091
+ export type Transition =
1092
+ /**
1093
+ * A fade-in/fade-out transition. The element fades in when shown and
1094
+ * fades out when hidden, using the specified duration.
1095
+ */
1096
+ {
370
1097
  type: "FadeInOut";
371
1098
  settings: FadeInOutTransitionSettings;
372
1099
  };
@@ -374,381 +1101,1047 @@ export interface GroupedSettings {
374
1101
  viewableItems: number[];
375
1102
  transition: Transition;
376
1103
  }
1104
+ /**
1105
+ * Presents offers in groups, progressing through groups sequentially.
1106
+ * Used EXCLUSIVELY in the Outer Layout. This is the container into which offers (Layout Variants) are rendered.
1107
+ * Each group shows a fixed number of offers at once, and the user advances through groups.
1108
+ *
1109
+ * Pair with ProgressControl nodes for group navigation.
1110
+ * Use `viewableItems` to control how many offers appear per group at each breakpoint.
1111
+ */
377
1112
  export interface GroupedDistributionModel {
1113
+ /**
1114
+ * Visual styles for the grouped container.
1115
+ * Uses the LayoutStyle wrapper with conditional style transitions.
1116
+ */
378
1117
  styles?: null | LayoutStyle<GroupedDistributionElements, GroupedDistributionTransitions>;
379
1118
  settings: GroupedSettings;
380
1119
  }
1120
+ /**
1121
+ * Typography styling for inline text elements. A subset of TextStylingProperties
1122
+ * without line-level controls (lineHeight, horizontalTextAlign, lineLimit).
1123
+ * All fields are optional. Only include the properties you want to override.
1124
+ */
381
1125
  export interface InlineTextStylingProperties {
1126
+ /** The text color. Uses themed values for light/dark mode support. */
382
1127
  textColor?: null | ThemeColor;
1128
+ /** Font size in platform units (px on Web, pt on iOS, dp on Android). */
383
1129
  fontSize?: null | number;
1130
+ /** The font family name. Use 'rokt-icons' for icon fonts. */
384
1131
  fontFamily?: null | string;
1132
+ /** The weight (boldness) of the font. */
385
1133
  fontWeight?: null | FontWeight;
1134
+ /** Vertical alignment of text relative to the baseline. */
386
1135
  baselineTextAlign?: null | FontBaselineAlignment;
1136
+ /** Normal or italic text rendering. */
387
1137
  fontStyle?: null | FontStyle;
1138
+ /** Controls automatic text capitalisation. */
388
1139
  textTransform?: null | TextTransform;
1140
+ /** Additional spacing between characters in platform units. */
389
1141
  letterSpacing?: null | number;
1142
+ /** Decorative line applied to text (underline, strikethrough). */
390
1143
  textDecoration?: null | TextDecoration;
391
1144
  }
1145
+ /** Inline text styling for elements like links within rich text. */
392
1146
  export interface InLineTextStyle {
1147
+ /** Typography properties for the inline text element. */
393
1148
  text: InlineTextStylingProperties;
394
1149
  }
1150
+ /**
1151
+ * Visual style properties for individual indicator items (dots, bars, etc.).
1152
+ * Includes text styling for number-based indicators.
1153
+ */
395
1154
  export interface IndicatorStyles {
1155
+ /** Container layout styles (e.g. flex direction, alignment). */
396
1156
  container?: null | ContainerStylingProperties;
1157
+ /** Background color and gradient styles. */
397
1158
  background?: null | BackgroundStylingProperties;
1159
+ /** Border width, color, and radius styles. */
398
1160
  border?: null | BorderStylingProperties;
1161
+ /** Width and height dimension styles. */
399
1162
  dimension?: null | DimensionStylingProperties;
1163
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
400
1164
  flexChild?: null | FlexChildStylingProperties;
1165
+ /** Padding and margin spacing styles. */
401
1166
  spacing?: null | SpacingStylingProperties;
1167
+ /** Text styling for number-based indicators. */
402
1168
  text?: null | TextStylingProperties;
403
1169
  }
1170
+ /** Platform-specific settings for the layout behaviour. */
404
1171
  export interface LayoutSettings {
1172
+ /** Whether to automatically close the layout after the user completes the interaction flow. */
405
1173
  closeOnComplete?: null | boolean;
406
1174
  }
1175
+ /**
1176
+ * Visual style properties for the OneByOneDistribution container.
1177
+ * Contains the standard style categories: container layout, background colors,
1178
+ * border appearance, dimensions, flex child positioning, and spacing.
1179
+ */
407
1180
  export interface OneByOneDistributionStyles {
1181
+ /** Container layout styles (e.g. flex direction, alignment). */
408
1182
  container?: null | ContainerStylingProperties;
1183
+ /** Background color and gradient styles. */
409
1184
  background?: null | BackgroundStylingProperties;
1185
+ /** Border width, color, and radius styles. */
410
1186
  border?: null | BorderStylingProperties;
1187
+ /** Width and height dimension styles. */
411
1188
  dimension?: null | DimensionStylingProperties;
1189
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
412
1190
  flexChild?: null | FlexChildStylingProperties;
1191
+ /** Padding and margin spacing styles. */
413
1192
  spacing?: null | SpacingStylingProperties;
414
1193
  }
1194
+ /**
1195
+ * Styling elements for the OneByOneDistribution container.
1196
+ * The `own` array contains stateless styling blocks applied to the distribution container itself.
1197
+ */
415
1198
  export interface OneByOneDistributionElements {
1199
+ /** Array of stateless styling blocks for the distribution container. */
416
1200
  own: StatelessStylingBlock<OneByOneDistributionStyles>[];
417
1201
  }
1202
+ /** Transition styles for animating OneByOneDistribution style changes. */
418
1203
  export interface OneByOneDistributionTransitions {
1204
+ /** Transition properties for the distribution container's own styles. */
419
1205
  own?: null | OneByOneDistributionStyles;
420
1206
  }
1207
+ /**
1208
+ * Presents offers one at a time, allowing the user to progress through them sequentially.
1209
+ * Used EXCLUSIVELY in the Outer Layout. This is the container into which offers (Layout Variants) are rendered.
1210
+ *
1211
+ * Pair with ProgressControl nodes to enable forward/backward navigation between offers.
1212
+ * Pair with ProgressIndicator to show the user's current position.
1213
+ * Do NOT use this for displaying all offers at once; use StackedDistribution instead.
1214
+ */
421
1215
  export interface OneByOneDistributionModel {
1216
+ /**
1217
+ * Visual styles for the distribution container.
1218
+ * Uses the LayoutStyle wrapper with conditional style transitions.
1219
+ */
422
1220
  styles?: null | LayoutStyle<OneByOneDistributionElements, OneByOneDistributionTransitions>;
1221
+ /**
1222
+ * The animation transition between offers.
1223
+ * Defines how the current offer exits and the next offer enters.
1224
+ */
423
1225
  transition: Transition;
424
1226
  }
1227
+ /**
1228
+ * Available style categories for the Overlay content element. Each optional field enables a
1229
+ * specific category of visual styling. Omit a field to leave that category unstyled.
1230
+ */
425
1231
  export interface OverlayStyles {
1232
+ /**
1233
+ * Layout properties for the flex container (justification, alignment, gap, overflow).
1234
+ * MUST be used to control how children are arranged within the overlay content area.
1235
+ */
426
1236
  container?: null | ContainerStylingProperties;
1237
+ /**
1238
+ * Background color and image properties. Use to set a solid color, gradient, or image
1239
+ * behind the overlay content.
1240
+ */
427
1241
  background?: null | BackgroundStylingProperties;
1242
+ /**
1243
+ * Border radius, color, width and style properties. Use to add visible borders or
1244
+ * rounded corners to the overlay content area.
1245
+ */
428
1246
  border?: null | BorderStylingProperties;
1247
+ /**
1248
+ * Width, height and rotation properties. Use to explicitly size the overlay content area.
1249
+ * Do NOT set width/height if the overlay should size to its content.
1250
+ */
429
1251
  dimension?: null | DimensionStylingProperties;
1252
+ /**
1253
+ * Properties controlling this element's behaviour as a child of a flex container.
1254
+ * Use to set flex-grow, flex-shrink, flex-basis, and align-self.
1255
+ */
430
1256
  flexChild?: null | FlexChildStylingProperties;
1257
+ /**
1258
+ * Padding, margin and offset properties. Use to add spacing inside or outside the
1259
+ * overlay content area.
1260
+ */
431
1261
  spacing?: null | SpacingStylingProperties;
432
1262
  }
1263
+ /**
1264
+ * Style categories for the Overlay wrapper (backdrop) element. Controls the appearance of
1265
+ * the area behind the overlay content.
1266
+ */
433
1267
  export interface OverlayWrapperStyles {
1268
+ /** Layout properties for the wrapper container that positions the overlay content. */
434
1269
  container?: null | ContainerStylingProperties;
1270
+ /**
1271
+ * Background color for the backdrop. Typically a semi-transparent color (using `#AARRGGBB`
1272
+ * format, e.g. `#80000000`) to dim the content behind the overlay.
1273
+ */
435
1274
  background?: null | BackgroundStylingProperties;
436
1275
  }
1276
+ /**
1277
+ * Styleable elements of the Overlay node. The Overlay has two styleable elements: its own
1278
+ * content area and its wrapper (backdrop).
1279
+ */
437
1280
  export interface OverlayElements {
1281
+ /**
1282
+ * Style blocks for the overlay content area. The array represents breakpoint-specific
1283
+ * styles: first item is the default (no breakpoint), subsequent items correspond to
1284
+ * breakpoints in ascending order. MUST contain at least one item for the default style.
1285
+ */
438
1286
  own: BasicStateStylingBlock<OverlayStyles>[];
1287
+ /**
1288
+ * Style blocks for the overlay wrapper (backdrop). The array represents
1289
+ * breakpoint-specific styles: first item is the default, subsequent items correspond
1290
+ * to breakpoints in ascending order.
1291
+ */
439
1292
  wrapper: BasicStateStylingBlock<OverlayWrapperStyles>[];
440
1293
  }
441
1294
  export interface OverlaySettings {
442
1295
  allowBackdropToClose: boolean;
443
1296
  }
1297
+ /** Transition styles for the Overlay node. Use to animate style changes smoothly. */
444
1298
  export interface OverlayTransitions {
1299
+ /**
1300
+ * Transition properties for the overlay content area. Specifies which style properties
1301
+ * should animate and their duration/easing when values change.
1302
+ */
445
1303
  own?: null | OverlayStyles;
1304
+ /** Transition properties for the overlay wrapper (backdrop). */
446
1305
  wrapper?: null | OverlayWrapperStyles;
447
1306
  }
1307
+ /**
1308
+ * A modal overlay that appears on top of the main content with a backdrop. Use for dialogs,
1309
+ * confirmations, and modal interactions that require user attention. The overlay blocks
1310
+ * interaction with the content behind it. Do NOT use Overlay for inline content layering;
1311
+ * use ZStack instead.
1312
+ */
448
1313
  export interface OverlayModel<Children> {
449
1314
  settings: OverlaySettings;
1315
+ /**
1316
+ * Visual styles for this overlay. See styling documentation for the structure. Omit to
1317
+ * use default (unstyled) rendering.
1318
+ */
450
1319
  styles?: null | LayoutStyle<OverlayElements, OverlayTransitions>;
1320
+ /** The content displayed within the overlay. */
451
1321
  children: Children[];
452
1322
  }
1323
+ /**
1324
+ * Tests the position index of the current item within a collection. Use to
1325
+ * style items differently based on their position (e.g. first item, last item).
1326
+ */
453
1327
  export interface PositionPredicate {
1328
+ /** The comparison operator. */
454
1329
  condition: OrderableWhenCondition;
1330
+ /**
1331
+ * The position index to compare against. MUST be a string representation
1332
+ * of a number, e.g. "0" for the first item.
1333
+ */
455
1334
  value: string;
456
1335
  }
1336
+ /**
1337
+ * Visual style properties for the ProgressControl button.
1338
+ * Contains the standard style categories: container layout, background colors,
1339
+ * border appearance, dimensions, flex child positioning, and spacing.
1340
+ */
457
1341
  export interface ProgressControlStyle {
1342
+ /** Container layout styles (e.g. flex direction, alignment). */
458
1343
  container?: null | ContainerStylingProperties;
1344
+ /** Background color and gradient styles. */
459
1345
  background?: null | BackgroundStylingProperties;
1346
+ /** Border width, color, and radius styles. */
460
1347
  border?: null | BorderStylingProperties;
1348
+ /** Width and height dimension styles. */
461
1349
  dimension?: null | DimensionStylingProperties;
1350
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
462
1351
  flexChild?: null | FlexChildStylingProperties;
1352
+ /** Padding and margin spacing styles. */
463
1353
  spacing?: null | SpacingStylingProperties;
464
1354
  }
1355
+ /**
1356
+ * Styling elements for the ProgressControl button.
1357
+ * The `own` array contains state-dependent styling blocks (e.g. default, pressed, disabled)
1358
+ * applied to the control button itself.
1359
+ */
465
1360
  export interface ProgressControlElements {
1361
+ /**
1362
+ * Array of state-dependent styling blocks for the control button.
1363
+ * Each block targets a specific interaction state (default, pressed, disabled, etc.).
1364
+ */
466
1365
  own: BasicStateStylingBlock<ProgressControlStyle>[];
467
1366
  }
1367
+ /** Transition styles for animating ProgressControl style changes. */
468
1368
  export interface ProgressControlTransitions {
1369
+ /** Transition properties for the control button's own styles. */
469
1370
  own?: null | ProgressControlStyle;
470
1371
  }
471
- export type ProgressionDirection = "Forward" | "Backward";
1372
+ /** The direction in which the progress control advances offers. */
1373
+ export type ProgressionDirection =
1374
+ /** Advance to the next offer or group. */
1375
+ "Forward"
1376
+ /** Return to the previous offer or group. */
1377
+ | "Backward";
1378
+ /**
1379
+ * A button that advances or reverses offer progression.
1380
+ * Used with OneByOneDistribution or GroupedDistribution for navigation.
1381
+ *
1382
+ * MUST specify a `direction` (Forward or Backward).
1383
+ * Pair with a distribution node for the control to have an effect.
1384
+ * Typically contains an arrow icon as child content.
1385
+ */
472
1386
  export interface ProgressControlModel<Children> {
1387
+ /** Visual styles for the control. Uses the LayoutStyle wrapper with conditional style transitions. */
473
1388
  styles?: null | LayoutStyle<ProgressControlElements, ProgressControlTransitions>;
1389
+ /** The direction to progress. MUST be either Forward or Backward. */
474
1390
  direction: ProgressionDirection;
1391
+ /**
1392
+ * Child nodes forming the button content (e.g. an arrow icon).
1393
+ * MUST contain at least one child for the control to have visible content.
1394
+ */
475
1395
  children: Children[];
476
1396
  }
1397
+ /**
1398
+ * Visual style properties for the ProgressIndicator container.
1399
+ * Contains the standard style categories for the outer indicator wrapper.
1400
+ */
477
1401
  export interface ProgressIndicatorStyles {
1402
+ /** Container layout styles (e.g. flex direction, alignment). */
478
1403
  container?: null | ContainerStylingProperties;
1404
+ /** Background color and gradient styles. */
479
1405
  background?: null | BackgroundStylingProperties;
1406
+ /** Border width, color, and radius styles. */
480
1407
  border?: null | BorderStylingProperties;
1408
+ /** Width and height dimension styles. */
481
1409
  dimension?: null | DimensionStylingProperties;
1410
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
482
1411
  flexChild?: null | FlexChildStylingProperties;
1412
+ /** Padding and margin spacing styles. */
483
1413
  spacing?: null | SpacingStylingProperties;
484
1414
  }
1415
+ /**
1416
+ * Styling elements for the ProgressIndicator.
1417
+ * Contains styling blocks for the container, individual indicators, and special indicator states.
1418
+ */
485
1419
  export interface ProgressIndicatorElements {
1420
+ /** Array of state-dependent styling blocks for the indicator container. */
486
1421
  own: BasicStateStylingBlock<ProgressIndicatorStyles>[];
1422
+ /** Styling blocks for each individual indicator item (default state). */
487
1423
  indicator: BasicStateStylingBlock<IndicatorStyles>[];
1424
+ /**
1425
+ * Optional styling blocks for the currently active indicator.
1426
+ * If omitted, the default indicator styling is used.
1427
+ */
488
1428
  activeIndicator?: null | BasicStateStylingBlock<IndicatorStyles>[];
1429
+ /**
1430
+ * Optional styling blocks for indicators that have been seen/visited.
1431
+ * If omitted, the default indicator styling is used.
1432
+ */
489
1433
  seenIndicator?: null | BasicStateStylingBlock<IndicatorStyles>[];
490
1434
  }
1435
+ /**
1436
+ * Transition styles for animating ProgressIndicator style changes.
1437
+ * Defines transitions for the container and each indicator state.
1438
+ */
491
1439
  export interface ProgressIndicatorTransitions {
1440
+ /** Transition properties for the indicator container's own styles. */
492
1441
  own?: null | ProgressIndicatorStyles;
1442
+ /** Transition properties for the default indicator styles. */
493
1443
  indicator?: null | IndicatorStyles;
1444
+ /** Transition properties for the active indicator styles. */
494
1445
  activeIndicator?: null | IndicatorStyles;
1446
+ /** Transition properties for the seen indicator styles. */
495
1447
  seenIndicator?: null | IndicatorStyles;
496
1448
  }
497
1449
  export interface ProgressIndicatorSettings {
498
1450
  startPosition?: null | number;
499
1451
  }
1452
+ /**
1453
+ * Displays visual progress indicators (dots, bars) showing the user's position
1454
+ * within a series of offers.
1455
+ *
1456
+ * MUST be paired with a distribution node (OneByOneDistribution, GroupedDistribution, etc.)
1457
+ * to track position. The indicator automatically reflects the current offer position.
1458
+ * Use `indicator` to specify the type (e.g. "dot", "bar", "number").
1459
+ */
500
1460
  export interface ProgressIndicatorModel {
1461
+ /**
1462
+ * Visual styles for the progress indicators.
1463
+ * Uses the LayoutStyle wrapper with conditional style transitions.
1464
+ */
501
1465
  styles?: null | LayoutStyle<ProgressIndicatorElements, ProgressIndicatorTransitions>;
1466
+ /**
1467
+ * The type of indicator to display (e.g. "dot", "bar", "number").
1468
+ * MUST be a valid indicator type string.
1469
+ */
502
1470
  indicator: string;
503
1471
  settings?: null | ProgressIndicatorSettings;
504
1472
  isImportantForAccessibility?: null | boolean;
505
1473
  }
1474
+ /**
1475
+ * Tests which offer index is currently visible in a carousel or progression.
1476
+ * Use 0 for the first offer, -1 for the last offer.
1477
+ */
506
1478
  export interface ProgressionPredicate {
1479
+ /** The comparison operator. */
507
1480
  condition: OrderableWhenCondition;
1481
+ /**
1482
+ * The progression index to compare against. MUST be a string representation
1483
+ * of a number. Use "0" for the first offer, "-1" for the last offer.
1484
+ */
508
1485
  value: string;
509
1486
  }
1487
+ /** Visual styles for the RichText node. */
510
1488
  export interface RichTextStyle {
1489
+ /** Width, height and rotation properties. */
511
1490
  dimension?: null | DimensionStylingProperties;
1491
+ /** Properties controlling behaviour as a flex child. */
512
1492
  flexChild?: null | FlexChildStylingProperties;
1493
+ /** Padding, margin and offset properties. */
513
1494
  spacing?: null | SpacingStylingProperties;
1495
+ /** Background color and image properties. */
514
1496
  background?: null | BackgroundStylingProperties;
1497
+ /** Typography properties. */
515
1498
  text?: null | TextStylingProperties;
516
1499
  }
1500
+ /** Style elements for the RichText node. */
517
1501
  export interface RichTextElements {
1502
+ /** Style blocks for the node's primary element. Array represents breakpoint-specific styles. */
518
1503
  own: BasicStateStylingBlock<RichTextStyle>[];
1504
+ /** Style blocks for link elements within the rich text content. */
519
1505
  link?: null | BasicStateStylingBlock<InLineTextStyle>[];
520
1506
  }
1507
+ /** Transition definitions for the RichText node. */
521
1508
  export interface RichTextTransitions {
1509
+ /** Transition properties for the primary element. */
522
1510
  own?: null | RichTextStyle;
1511
+ /** Transition properties for link elements. */
523
1512
  link?: null | InLineTextStyle;
524
1513
  }
1514
+ /** Renders HTML-formatted text content. Supports `<a>`, `<strong>`, `<em>`, `<br>` and other inline HTML elements. Use BasicText for plain text without HTML. */
525
1515
  export interface RichTextModel {
1516
+ /** Visual styles for the text element. */
526
1517
  styles?: null | LayoutStyle<RichTextElements, RichTextTransitions>;
1518
+ /** Controls how links within the rich text are opened when clicked. */
527
1519
  openLinks?: null | LinkOpenTarget;
1520
+ /** The HTML text content to display. Supports inline HTML tags and data binding placeholders in the format %^DATA.key^% or %^ATTRIBUTE.key^%. */
528
1521
  value: string;
529
1522
  }
1523
+ /**
1524
+ * The top-level schema structure for an outer layout. Contains the layout tree,
1525
+ * breakpoint definitions, settings and display configuration.
1526
+ */
530
1527
  export interface RootSchemaModel<Layout, Display, Settings> {
1528
+ /**
1529
+ * Map of breakpoint names to viewport width thresholds in platform units.
1530
+ * Defines responsive breakpoints for the layout.
1531
+ */
531
1532
  breakpoints: Record<string, number>;
1533
+ /** The root node of the layout tree. */
532
1534
  layout: Layout;
1535
+ /** Platform-specific layout settings. */
533
1536
  settings?: null | Settings;
1537
+ /** Controls how the layout is displayed (fullscreen, embedded, etc). */
534
1538
  display?: null | Display;
535
1539
  }
1540
+ /**
1541
+ * Available style categories for the Row element. Each optional field enables a specific
1542
+ * category of visual styling. Omit a field to leave that category unstyled.
1543
+ */
536
1544
  export interface RowStyle {
1545
+ /**
1546
+ * Layout properties for the flex container (justification, alignment, gap, overflow).
1547
+ * MUST be used to control how children are arranged within the row.
1548
+ */
537
1549
  container?: null | ContainerStylingProperties;
1550
+ /**
1551
+ * Background color and image properties. Use to set a solid color, gradient, or image
1552
+ * behind the row content.
1553
+ */
538
1554
  background?: null | BackgroundStylingProperties;
1555
+ /**
1556
+ * Border radius, color, width and style properties. Use to add visible borders or
1557
+ * rounded corners to the row.
1558
+ */
539
1559
  border?: null | BorderStylingProperties;
1560
+ /**
1561
+ * Width, height and rotation properties. Use to explicitly size the row or apply rotation
1562
+ * transforms. Do NOT set width/height if the row should size to its content.
1563
+ */
540
1564
  dimension?: null | DimensionStylingProperties;
1565
+ /**
1566
+ * Properties controlling this element's behaviour as a child of a flex container.
1567
+ * Use to set flex-grow, flex-shrink, flex-basis, and align-self.
1568
+ */
541
1569
  flexChild?: null | FlexChildStylingProperties;
1570
+ /** Padding, margin and offset properties. Use to add spacing inside or outside the row. */
542
1571
  spacing?: null | SpacingStylingProperties;
543
1572
  }
1573
+ /**
1574
+ * Styleable elements of the Row node. The Row has a single styleable element: its own
1575
+ * container.
1576
+ */
544
1577
  export interface RowElements {
1578
+ /**
1579
+ * Style blocks for the row container itself. The array represents breakpoint-specific
1580
+ * styles: first item is the default (no breakpoint), subsequent items correspond to
1581
+ * breakpoints in ascending order. MUST contain at least one item for the default style.
1582
+ */
545
1583
  own: BasicStateStylingBlock<RowStyle>[];
546
1584
  }
1585
+ /** Transition styles for the Row node. Use to animate style changes smoothly. */
547
1586
  export interface RowTransitions {
1587
+ /**
1588
+ * Transition properties for the row container. Specifies which style properties
1589
+ * should animate and their duration/easing when values change.
1590
+ */
548
1591
  own?: null | RowStyle;
549
1592
  }
1593
+ /**
1594
+ * A horizontal flex container that arranges its children in a row (left to right). Use for
1595
+ * horizontal layouts. Children are laid out along the horizontal axis by default. To control
1596
+ * alignment and distribution, configure the container styles. Do NOT nest Rows unnecessarily
1597
+ * when a single Row with appropriate styling would suffice.
1598
+ */
550
1599
  export interface RowModel<Children> {
1600
+ /**
1601
+ * Visual styles for this row. See styling documentation for the structure. Omit to use
1602
+ * default (unstyled) rendering.
1603
+ */
551
1604
  styles?: null | LayoutStyle<RowElements, RowTransitions>;
1605
+ /**
1606
+ * Child nodes rendered horizontally within this row.
1607
+ * Children are laid out left to right in source order.
1608
+ */
552
1609
  children: Children[];
553
1610
  }
1611
+ /**
1612
+ * Visual style properties for the SlideStateTrigger container.
1613
+ * Contains the standard style categories for the slider's outer container.
1614
+ */
554
1615
  export interface SlideStateTriggerOwnStyles {
1616
+ /** Container layout styles (e.g. flex direction, alignment). */
555
1617
  container?: null | ContainerStylingProperties;
1618
+ /** Background color and gradient styles. */
556
1619
  background?: null | BackgroundStylingProperties;
1620
+ /** Border width, color, and radius styles. */
557
1621
  border?: null | BorderStylingProperties;
1622
+ /** Width and height dimension styles. */
558
1623
  dimension?: null | DimensionStylingProperties;
1624
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
559
1625
  flexChild?: null | FlexChildStylingProperties;
1626
+ /** Padding and margin spacing styles. */
560
1627
  spacing?: null | SpacingStylingProperties;
561
1628
  }
1629
+ /** Visual style properties for the slider thumb (the draggable handle). */
562
1630
  export interface SlideStateTriggerThumbStyles {
1631
+ /** Text styling for the thumb label. */
563
1632
  text?: null | TextStylingProperties;
1633
+ /** Background color and gradient styles for the thumb. */
564
1634
  background?: null | BackgroundStylingProperties;
1635
+ /** Border width, color, and radius styles for the thumb. */
565
1636
  border?: null | BorderStylingProperties;
1637
+ /** Width and height dimension styles for the thumb. */
566
1638
  dimension?: null | DimensionStylingProperties;
1639
+ /** Flex child sizing and alignment styles for the thumb. */
567
1640
  flexChild?: null | FlexChildStylingProperties;
1641
+ /** Padding and margin spacing styles for the thumb. */
568
1642
  spacing?: null | SpacingStylingProperties;
569
1643
  }
1644
+ /** Visual style properties for the slider label. */
570
1645
  export interface SlideStateTriggerLabelStyles {
1646
+ /** Text styling for the label. */
571
1647
  text?: null | TextStylingProperties;
1648
+ /** Padding and margin spacing styles for the label. */
572
1649
  spacing?: null | SpacingStylingProperties;
573
1650
  }
1651
+ /** Visual style properties for the slider fill (the filled portion of the track). */
574
1652
  export interface SlideStateTriggerFillStyles {
1653
+ /** Background color and gradient styles for the fill. */
575
1654
  background?: null | BackgroundStylingProperties;
1655
+ /** Border width, color, and radius styles for the fill. */
576
1656
  border?: null | BorderStylingProperties;
577
1657
  }
1658
+ /**
1659
+ * Styling elements for the SlideStateTrigger.
1660
+ * Contains styling blocks for the container, thumb, label, and fill sub-elements.
1661
+ */
578
1662
  export interface SlideStateTriggerElements {
1663
+ /** Array of stateless styling blocks for the slider container. */
579
1664
  own: StatelessStylingBlock<SlideStateTriggerOwnStyles>[];
1665
+ /** Optional styling blocks for the slider thumb (draggable handle). */
580
1666
  thumb?: null | StatelessStylingBlock<SlideStateTriggerThumbStyles>[];
1667
+ /** Optional styling blocks for the slider label. */
581
1668
  label?: null | StatelessStylingBlock<SlideStateTriggerLabelStyles>[];
1669
+ /** Optional styling blocks for the slider fill (filled track portion). */
582
1670
  fill?: null | StatelessStylingBlock<SlideStateTriggerFillStyles>[];
583
1671
  }
1672
+ /** Configuration for the slider label. */
584
1673
  export interface SlideStateTriggerLabel {
1674
+ /** Optional text value to display as the slider label. */
585
1675
  value?: null | string;
586
1676
  }
1677
+ /**
1678
+ * Transition styles for animating SlideStateTrigger style changes.
1679
+ * Defines transitions for all slider sub-elements.
1680
+ */
587
1681
  export interface SlideStateTriggerTransitions {
1682
+ /** Transition properties for the slider container's own styles. */
588
1683
  own?: null | SlideStateTriggerOwnStyles;
1684
+ /** Transition properties for the thumb styles. */
589
1685
  thumb?: null | SlideStateTriggerThumbStyles;
1686
+ /** Transition properties for the label styles. */
590
1687
  label?: null | SlideStateTriggerLabelStyles;
1688
+ /** Transition properties for the fill styles. */
591
1689
  fill?: null | SlideStateTriggerFillStyles;
592
1690
  }
1691
+ /** Configuration for the slider thumb (draggable handle). */
593
1692
  export interface SlideStateTriggerThumb {
1693
+ /** Optional icon name to display inside the thumb. */
594
1694
  icon?: null | string;
595
1695
  }
1696
+ /**
1697
+ * A slider control that updates a custom state value as the user drags.
1698
+ * The slider thumb can be dragged to set the state to a value proportional to the position.
1699
+ * Use with When nodes to conditionally show/hide content based on the slider state.
1700
+ *
1701
+ * MUST provide a `customStateKey` that matches the key in When predicates.
1702
+ * Optionally provide `customStateValue` to set the slider's initial position.
1703
+ */
596
1704
  export interface SlideStateTriggerModel {
1705
+ /** Visual styles for the slider. Uses the LayoutStyle wrapper with conditional style transitions. */
597
1706
  styles?: null | LayoutStyle<SlideStateTriggerElements, SlideStateTriggerTransitions>;
1707
+ /** Configuration for the slider thumb (draggable handle). */
598
1708
  thumb?: null | SlideStateTriggerThumb;
1709
+ /** Configuration for the slider label. */
599
1710
  label?: null | SlideStateTriggerLabel;
1711
+ /**
1712
+ * The custom state key to update as the slider is dragged.
1713
+ * MUST match the key referenced in When node predicates.
1714
+ */
600
1715
  customStateKey: string;
1716
+ /**
1717
+ * The initial value of the custom state (slider position).
1718
+ * If omitted, defaults to the minimum position.
1719
+ */
601
1720
  customStateValue?: null | number;
602
1721
  }
1722
+ /**
1723
+ * Visual style properties for the StackedDistribution container.
1724
+ * Contains the standard style categories: container layout, background colors,
1725
+ * border appearance, dimensions, flex child positioning, and spacing.
1726
+ */
603
1727
  export interface StackedDistributionStyles {
1728
+ /** Container layout styles (e.g. flex direction, alignment). */
604
1729
  container?: null | ContainerStylingProperties;
1730
+ /** Background color and gradient styles. */
605
1731
  background?: null | BackgroundStylingProperties;
1732
+ /** Border width, color, and radius styles. */
606
1733
  border?: null | BorderStylingProperties;
1734
+ /** Width and height dimension styles. */
607
1735
  dimension?: null | DimensionStylingProperties;
1736
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
608
1737
  flexChild?: null | FlexChildStylingProperties;
1738
+ /** Padding and margin spacing styles. */
609
1739
  spacing?: null | SpacingStylingProperties;
610
1740
  }
1741
+ /**
1742
+ * Styling elements for the StackedDistribution container.
1743
+ * The `own` array contains stateless styling blocks applied to the stacked container itself.
1744
+ */
611
1745
  export interface StackedDistributionElements {
1746
+ /** Array of stateless styling blocks for the stacked container. */
612
1747
  own: StatelessStylingBlock<StackedDistributionStyles>[];
613
1748
  }
1749
+ /** Transition styles for animating StackedDistribution style changes. */
614
1750
  export interface StackedDistributionTransitions {
1751
+ /** Transition properties for the stacked container's own styles. */
615
1752
  own?: null | StackedDistributionStyles;
616
1753
  }
1754
+ /**
1755
+ * Presents multiple offers stacked vertically, all visible at once.
1756
+ * Used EXCLUSIVELY in the Outer Layout. This is the container into which offers (Layout Variants) are rendered.
1757
+ *
1758
+ * Use this when all offers should be visible simultaneously.
1759
+ * Do NOT use this for sequential one-at-a-time presentation; use OneByOneDistribution instead.
1760
+ */
617
1761
  export interface StackedDistributionModel {
1762
+ /**
1763
+ * Visual styles for the stacked container.
1764
+ * Uses the LayoutStyle wrapper with conditional style transitions.
1765
+ */
618
1766
  styles?: null | LayoutStyle<StackedDistributionElements, StackedDistributionTransitions>;
619
1767
  }
620
- export type BooleanWhenCondition = "is-true" | "is-false";
1768
+ /**
1769
+ * Condition operators for boolean values. Use these to test boolean flags.
1770
+ * Serialized as kebab-case strings: "is-true", "is-false".
1771
+ */
1772
+ export type BooleanWhenCondition =
1773
+ /** True when the value is true. */
1774
+ "is-true"
1775
+ /** True when the value is false. */
1776
+ | "is-false";
1777
+ /**
1778
+ * A predicate with a hardcoded boolean value. Useful for enabling or disabling
1779
+ * sections during development or for static feature flags.
1780
+ */
621
1781
  export interface StaticBooleanPredicate {
1782
+ /** The boolean condition. Use "is-true" or "is-false". */
622
1783
  condition: BooleanWhenCondition;
1784
+ /** The static boolean value to evaluate against the condition. */
623
1785
  value: boolean;
624
1786
  }
1787
+ /** Visual styles for the StaticIcon node. MUST include text styles with fontFamily set to 'rokt-icons' to render correctly. */
625
1788
  export interface StaticIconStyles {
1789
+ /** Typography properties. MUST include fontFamily set to 'rokt-icons' for the icon to render correctly. */
626
1790
  text?: null | TextStylingProperties;
1791
+ /** Width, height and rotation properties. */
627
1792
  dimension?: null | DimensionStylingProperties;
1793
+ /** Properties controlling behaviour as a flex child. */
628
1794
  flexChild?: null | FlexChildStylingProperties;
1795
+ /** Padding, margin and offset properties. */
629
1796
  spacing?: null | SpacingStylingProperties;
1797
+ /** Background color and image properties. */
630
1798
  background?: null | BackgroundStylingProperties;
1799
+ /** Border radius, color, width and style. */
631
1800
  border?: null | BorderStylingProperties;
632
1801
  }
1802
+ /** Style elements for the StaticIcon node. */
633
1803
  export interface StaticIconElements {
1804
+ /** Style blocks for the node's primary element. Array represents breakpoint-specific styles. */
634
1805
  own: BasicStateStylingBlock<StaticIconStyles>[];
635
1806
  }
1807
+ /** Transition definitions for the StaticIcon node. */
636
1808
  export interface StaticIconTransitions {
1809
+ /** Transition properties for the primary element. */
637
1810
  own?: null | StaticIconStyles;
638
1811
  }
1812
+ /** Renders an SVG icon from the Rokt icon font. The icon is selected by name from the available icon set. */
639
1813
  export interface StaticIconModel {
1814
+ /** Visual styles for the icon. MUST include text styles with fontFamily set to 'rokt-icons' to render correctly. */
640
1815
  styles?: null | LayoutStyle<StaticIconElements, StaticIconTransitions>;
1816
+ /** The icon name. Available icons include: Car, CreditCard, Ticket, Star, Mobile, Train, Utensils, Calculator, Couch, CheckApproved, Check, Lock, Shield, ThumbUp, ShoppingCart, TrendingUp, Wallet, Luggage, Close, ChevronLeft, ChevronRight, ExpandMore, ExpandLess, ArrowBack, ArrowForward, ArrowUpward, ArrowDownward, Add, Remove, ExternalLink, CircleCheck, Help, Info. */
641
1817
  name: string;
1818
+ /** Accessibility description of the icon for screen readers. */
642
1819
  description?: null | string;
643
1820
  isImportantForAccessibility?: null | boolean;
644
1821
  }
1822
+ /** Visual styles for the StaticImage node. */
645
1823
  export interface StaticImageStyles {
1824
+ /** Background color and image properties. */
646
1825
  background?: null | BackgroundStylingProperties;
1826
+ /** Border radius, color, width and style. */
647
1827
  border?: null | BorderStylingProperties;
1828
+ /** Width, height and rotation properties. */
648
1829
  dimension?: null | DimensionStylingProperties;
1830
+ /** Properties controlling behaviour as a flex child. */
649
1831
  flexChild?: null | FlexChildStylingProperties;
1832
+ /** Padding, margin and offset properties. */
650
1833
  spacing?: null | SpacingStylingProperties;
651
1834
  }
1835
+ /** Style elements for the StaticImage node. */
652
1836
  export interface StaticImageElements {
1837
+ /** Style blocks for the node's primary element. Array represents breakpoint-specific styles. */
653
1838
  own: BasicStateStylingBlock<StaticImageStyles>[];
654
1839
  }
1840
+ /** Transition definitions for the StaticImage node. */
655
1841
  export interface StaticImageTransitions {
1842
+ /** Transition properties for the primary element. */
656
1843
  own?: null | StaticImageStyles;
657
1844
  }
1845
+ /** URL configuration for a static image with themed light/dark mode support. */
658
1846
  export interface StaticImageUrl {
1847
+ /** The image URL for light mode. MUST be a valid URL. */
659
1848
  light: string;
1849
+ /** The image URL for dark mode. If not provided, the light URL is used for both modes. */
660
1850
  dark?: null | string;
661
1851
  }
1852
+ /** Renders a static image from a provided URL. Use for images with known URLs (logos, icons, decorative images). */
662
1853
  export interface StaticImageModel {
1854
+ /** Visual styles for the image element. */
663
1855
  styles?: null | LayoutStyle<StaticImageElements, StaticImageTransitions>;
1856
+ /** Alt text for accessibility. Describes the image for screen readers. */
664
1857
  alt?: null | string;
1858
+ /** Title text shown on hover. */
665
1859
  title?: null | string;
1860
+ /** The image URL with themed light/dark mode support. */
666
1861
  url: StaticImageUrl;
667
1862
  isImportantForAccessibility?: null | boolean;
668
1863
  }
1864
+ /**
1865
+ * Visual style properties for the StaticLink.
1866
+ * Contains the standard style categories: container layout, background colors,
1867
+ * border appearance, dimensions, flex child positioning, and spacing.
1868
+ */
669
1869
  export interface StaticLinkStyles {
1870
+ /** Container layout styles (e.g. flex direction, alignment). */
670
1871
  container?: null | ContainerStylingProperties;
1872
+ /** Background color and gradient styles. */
671
1873
  background?: null | BackgroundStylingProperties;
1874
+ /** Border width, color, and radius styles. */
672
1875
  border?: null | BorderStylingProperties;
1876
+ /** Width and height dimension styles. */
673
1877
  dimension?: null | DimensionStylingProperties;
1878
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
674
1879
  flexChild?: null | FlexChildStylingProperties;
1880
+ /** Padding and margin spacing styles. */
675
1881
  spacing?: null | SpacingStylingProperties;
676
1882
  }
1883
+ /**
1884
+ * Styling elements for the StaticLink.
1885
+ * The `own` array contains state-dependent styling blocks (e.g. default, pressed)
1886
+ * applied to the link itself.
1887
+ */
677
1888
  export interface StaticLinkElements {
1889
+ /**
1890
+ * Array of state-dependent styling blocks for the link.
1891
+ * Each block targets a specific interaction state (default, pressed, etc.).
1892
+ */
678
1893
  own: BasicStateStylingBlock<StaticLinkStyles>[];
679
1894
  }
1895
+ /**
1896
+ * Transition styles for animating StaticLink style changes.
1897
+ * Defines which style properties should animate when the link's conditional styles change.
1898
+ */
680
1899
  export interface StaticLinkTransitions {
1900
+ /** Transition properties for the link's own styles. */
681
1901
  own?: null | StaticLinkStyles;
682
1902
  }
1903
+ /**
1904
+ * A clickable link that wraps its children. Opens the specified URL when clicked.
1905
+ *
1906
+ * Use this node for navigation to external URLs. Do NOT use CreativeResponse for link navigation;
1907
+ * CreativeResponse is for offer accept/decline actions only.
1908
+ * The `src` field MUST be a valid URL string.
1909
+ */
683
1910
  export interface StaticLinkModel<Children> {
1911
+ /**
1912
+ * The destination URL to open when the link is clicked.
1913
+ * MUST be a valid URL string (e.g. "https://example.com").
1914
+ */
684
1915
  src: string;
1916
+ /** Controls how the link URL is opened (e.g. in-app browser, external browser). */
685
1917
  open: LinkOpenTarget;
1918
+ /** Visual styles for the link. Uses the LayoutStyle wrapper with conditional style transitions. */
686
1919
  styles?: null | LayoutStyle<StaticLinkElements, StaticLinkTransitions>;
1920
+ /**
1921
+ * Child nodes that form the clickable link content.
1922
+ * MUST contain at least one child for the link to have visible, tappable content.
1923
+ */
687
1924
  children: Children[];
688
1925
  }
1926
+ /**
1927
+ * Visual style properties for the ToggleButtonStateTrigger.
1928
+ * Contains the standard style categories: container layout, background colors,
1929
+ * border appearance, dimensions, flex child positioning, and spacing.
1930
+ */
689
1931
  export interface ToggleButtonStateTriggerStyle {
1932
+ /** Container layout styles (e.g. flex direction, alignment). */
690
1933
  container?: null | ContainerStylingProperties;
1934
+ /** Background color and gradient styles. */
691
1935
  background?: null | BackgroundStylingProperties;
1936
+ /** Border width, color, and radius styles. */
692
1937
  border?: null | BorderStylingProperties;
1938
+ /** Width and height dimension styles. */
693
1939
  dimension?: null | DimensionStylingProperties;
1940
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
694
1941
  flexChild?: null | FlexChildStylingProperties;
1942
+ /** Padding and margin spacing styles. */
695
1943
  spacing?: null | SpacingStylingProperties;
696
1944
  }
1945
+ /**
1946
+ * Styling elements for the ToggleButtonStateTrigger.
1947
+ * The `own` array contains state-dependent styling blocks applied to the toggle button itself.
1948
+ */
697
1949
  export interface ToggleButtonStateTriggerElements {
1950
+ /** Array of state-dependent styling blocks for the toggle button. */
698
1951
  own: BasicStateStylingBlock<ToggleButtonStateTriggerStyle>[];
699
1952
  }
1953
+ /** Transition styles for animating ToggleButtonStateTrigger style changes. */
700
1954
  export interface ToggleButtonStateTriggerTransitions {
1955
+ /** Transition properties for the toggle button's own styles. */
701
1956
  own?: null | ToggleButtonStateTriggerStyle;
702
1957
  }
1958
+ /**
1959
+ * A toggle button that cycles a custom state between values when clicked.
1960
+ * Each click toggles the state value, typically between 0 and 1.
1961
+ * Use with When nodes to conditionally show/hide content based on the toggled state.
1962
+ *
1963
+ * MUST provide a `customStateKey` that matches the key in When predicates.
1964
+ * Unlike ButtonStateTrigger, this does NOT require a `value` field; it toggles automatically.
1965
+ */
703
1966
  export interface ToggleButtonStateTriggerModel<Children> {
1967
+ /** Visual styles for the toggle button. */
704
1968
  styles?: null | LayoutStyle<ToggleButtonStateTriggerElements, ToggleButtonStateTriggerTransitions>;
1969
+ /** Child nodes forming the toggle button content. */
705
1970
  children: Children[];
1971
+ /**
1972
+ * The custom state key to toggle when the button is pressed.
1973
+ * MUST match the key referenced in When node predicates.
1974
+ */
706
1975
  customStateKey: string;
707
1976
  }
708
- export type InTransition = {
1977
+ /**
1978
+ * A transition that applies only when an element enters (becomes visible).
1979
+ * MUST be an object with a "type" field and a "settings" field.
1980
+ * Currently only "FadeIn" is supported.
1981
+ */
1982
+ export type InTransition =
1983
+ /**
1984
+ * A fade-in transition. The element gradually becomes visible over the
1985
+ * specified duration.
1986
+ */
1987
+ {
709
1988
  type: "FadeIn";
710
1989
  settings: FadeInTransitionSettings;
711
1990
  };
712
- export type OutTransition = {
1991
+ /**
1992
+ * A transition that applies only when an element exits (becomes hidden).
1993
+ * MUST be an object with a "type" field and a "settings" field.
1994
+ * Currently only "FadeOut" is supported.
1995
+ */
1996
+ export type OutTransition =
1997
+ /**
1998
+ * A fade-out transition. The element gradually becomes invisible over
1999
+ * the specified duration.
2000
+ */
2001
+ {
713
2002
  type: "FadeOut";
714
2003
  settings: FadeOutTransitionSettings;
715
2004
  };
2005
+ /**
2006
+ * Transition configuration for when visibility changes.
2007
+ * Defines enter and exit animations for the When node's children.
2008
+ */
716
2009
  export interface WhenTransition {
717
2010
  in?: null | InTransition[];
718
2011
  out?: null | OutTransition[];
719
2012
  }
720
- export type WhenHidden = "visually" | "functionally";
2013
+ /**
2014
+ * Controls the hiding behaviour of When children.
2015
+ * Determines whether hidden children still occupy space in the layout.
2016
+ */
2017
+ export type WhenHidden =
2018
+ /**
2019
+ * Children are visually hidden but remain in the layout (take up space).
2020
+ * Use this when you need to preserve layout dimensions even when content is hidden.
2021
+ */
2022
+ "visually"
2023
+ /**
2024
+ * Children are fully removed from the layout.
2025
+ * They take up no space and do not affect sibling positioning.
2026
+ */
2027
+ | "functionally";
2028
+ /**
2029
+ * Conditional rendering node. Shows or hides its children based on predicate conditions.
2030
+ * All predicates MUST evaluate to true for children to be shown (AND logic).
2031
+ *
2032
+ * Use this node to conditionally display content based on custom state, offer count, or other
2033
+ * predicate conditions. Do NOT nest When nodes unnecessarily; combine predicates in a single
2034
+ * When node instead.
2035
+ */
721
2036
  export interface WhenModel<Children> {
2037
+ /**
2038
+ * Array of conditions that MUST ALL be true for children to render.
2039
+ * Uses AND logic: if any predicate is false, children are hidden.
2040
+ * MUST contain at least one predicate.
2041
+ */
722
2042
  predicates: WhenPredicate[];
2043
+ /** Child nodes to conditionally show or hide based on the predicates. */
723
2044
  children: Children[];
2045
+ /**
2046
+ * Optional transition animation configuration for when visibility changes.
2047
+ * Controls how children animate in and out when predicates change.
2048
+ */
724
2049
  transition?: null | WhenTransition;
2050
+ /**
2051
+ * Controls how hidden children are treated in the layout.
2052
+ * If omitted, defaults to functionally hiding (fully removed from layout).
2053
+ */
725
2054
  hide?: null | WhenHidden;
726
2055
  }
2056
+ /** Styling properties for ZStack container layout. ZStack layers children on top of each other. */
727
2057
  export interface ZStackContainerStylingProperties {
2058
+ /** Controls horizontal positioning of children within the ZStack. */
728
2059
  justifyContent?: null | FlexPosition;
2060
+ /** Controls vertical positioning of children within the ZStack. */
729
2061
  alignItems?: null | FlexPosition;
2062
+ /** Applies a box shadow effect around the container. */
730
2063
  shadow?: null | Shadow;
2064
+ /** Controls whether content overflowing the container bounds is visible or hidden. */
731
2065
  overflow?: null | Overflow;
2066
+ /** Applies a Gaussian blur effect. Value is the blur radius in platform units. */
732
2067
  blur?: null | number;
733
2068
  }
2069
+ /**
2070
+ * Available style categories for the ZStack element. Each optional field enables a specific
2071
+ * category of visual styling. Omit a field to leave that category unstyled.
2072
+ */
734
2073
  export interface ZStackStyle {
2074
+ /**
2075
+ * Layout properties for the ZStack container (alignment of stacked children).
2076
+ * MUST be used to control how children are positioned within the stack.
2077
+ */
735
2078
  container?: null | ZStackContainerStylingProperties;
2079
+ /**
2080
+ * Background color and image properties. Use to set a solid color, gradient, or image
2081
+ * behind the stacked content.
2082
+ */
736
2083
  background?: null | BackgroundStylingProperties;
2084
+ /**
2085
+ * Border radius, color, width and style properties. Use to add visible borders or
2086
+ * rounded corners to the ZStack.
2087
+ */
737
2088
  border?: null | BorderStylingProperties;
2089
+ /**
2090
+ * Width, height and rotation properties. Use to explicitly size the ZStack or apply
2091
+ * rotation transforms. Do NOT set width/height if the ZStack should size to its content.
2092
+ */
738
2093
  dimension?: null | DimensionStylingProperties;
2094
+ /**
2095
+ * Properties controlling this element's behaviour as a child of a flex container.
2096
+ * Use to set flex-grow, flex-shrink, flex-basis, and align-self.
2097
+ */
739
2098
  flexChild?: null | FlexChildStylingProperties;
2099
+ /** Padding, margin and offset properties. Use to add spacing inside or outside the ZStack. */
740
2100
  spacing?: null | SpacingStylingProperties;
741
2101
  }
2102
+ /**
2103
+ * Styleable elements of the ZStack node. The ZStack has a single styleable element: its own
2104
+ * container.
2105
+ */
742
2106
  export interface ZStackElements {
2107
+ /**
2108
+ * Style blocks for the ZStack container itself. The array represents breakpoint-specific
2109
+ * styles: first item is the default (no breakpoint), subsequent items correspond to
2110
+ * breakpoints in ascending order. MUST contain at least one item for the default style.
2111
+ */
743
2112
  own: BasicStateStylingBlock<ZStackStyle>[];
744
2113
  }
2114
+ /** Transition styles for the ZStack node. Use to animate style changes smoothly. */
745
2115
  export interface ZStackTransitions {
2116
+ /**
2117
+ * Transition properties for the ZStack container. Specifies which style properties
2118
+ * should animate and their duration/easing when values change.
2119
+ */
746
2120
  own?: null | ZStackStyle;
747
2121
  }
2122
+ /**
2123
+ * A layered container that stacks children on top of each other along the z-axis. Later
2124
+ * children render on top of earlier ones. Use for overlapping content such as badges on
2125
+ * images, text overlays, or layered decorative elements. Do NOT use ZStack for simple
2126
+ * sequential layouts; use Row or Column instead.
2127
+ */
748
2128
  export interface ZStackModel<Children> {
2129
+ /**
2130
+ * Visual styles for this ZStack. See styling documentation for the structure. Omit to use
2131
+ * default (unstyled) rendering.
2132
+ */
749
2133
  styles?: null | LayoutStyle<ZStackElements, ZStackTransitions>;
2134
+ /**
2135
+ * Child nodes stacked on top of each other within this ZStack. MUST contain at least one
2136
+ * child. Children are rendered in source order, with later children appearing on top of
2137
+ * earlier ones.
2138
+ */
750
2139
  children: Children[];
751
2140
  }
2141
+ /**
2142
+ * Root node types for a catalog stacked collection item template. Must be a Row or Column
2143
+ * that contains CatalogStackedCollectionTemplateNodeChildren.
2144
+ */
752
2145
  export type CatalogStackedCollectionTemplateNode = {
753
2146
  type: "Row";
754
2147
  node: RowModel<CatalogStackedCollectionTemplateNodeChildren>;
@@ -756,6 +2149,11 @@ export type CatalogStackedCollectionTemplateNode = {
756
2149
  type: "Column";
757
2150
  node: ColumnModel<CatalogStackedCollectionTemplateNodeChildren>;
758
2151
  };
2152
+ /**
2153
+ * Child node types allowed inside a catalog stacked collection template row or column.
2154
+ * Includes layout containers, text, images, icons, data-bound content, interactive triggers,
2155
+ * catalog response buttons, radio groups, and quantity counters.
2156
+ */
759
2157
  export type CatalogStackedCollectionTemplateNodeChildren = {
760
2158
  type: "Row";
761
2159
  node: RowModel<CatalogStackedCollectionTemplateNodeChildren>;
@@ -855,9 +2253,36 @@ export type CreativeResponseChildren = {
855
2253
  type: "StaticIcon";
856
2254
  node: StaticIconModel;
857
2255
  };
858
- export type DimensionHeightFitValue = "wrap-content" | "fit-height";
859
- export type DimensionWidthFitValue = "wrap-content" | "fit-width";
860
- export type LayoutDisplayPreset = "FULLSCREEN" | "EMBEDDED" | "ATTACHED";
2256
+ /**
2257
+ * Fit behaviour options for height.
2258
+ * Used as the 'value' inside a {"type": "fit", "value": ...} height specification.
2259
+ */
2260
+ export type DimensionHeightFitValue =
2261
+ /** Shrinks to fit the content height. */
2262
+ "wrap-content"
2263
+ /** Expands to fill the available height. */
2264
+ | "fit-height";
2265
+ /**
2266
+ * Fit behaviour options for width.
2267
+ * Used as the 'value' inside a {"type": "fit", "value": ...} width specification.
2268
+ */
2269
+ export type DimensionWidthFitValue =
2270
+ /** Shrinks to fit the content width. */
2271
+ "wrap-content"
2272
+ /** Expands to fill the available width. */
2273
+ | "fit-width";
2274
+ /** Controls how the layout is displayed on the page. */
2275
+ export type LayoutDisplayPreset =
2276
+ /** Layout covers the full viewport. */
2277
+ "FULLSCREEN"
2278
+ /** Layout is embedded inline within the page content. */
2279
+ | "EMBEDDED"
2280
+ /** Layout is attached/anchored to a specific position. */
2281
+ | "ATTACHED";
2282
+ /**
2283
+ * All node types supported in the web platform schema. This is the union type used by SDKs.
2284
+ * Layouts are authored using OuterLayoutSchemaModel or LayoutVariantSchemaModel instead.
2285
+ */
861
2286
  export type LayoutSchemaModel = {
862
2287
  type: "Row";
863
2288
  node: RowModel<LayoutSchemaModel>;
@@ -931,6 +2356,11 @@ export type LayoutSchemaModel = {
931
2356
  type: "CatalogStackedCollection";
932
2357
  node: CatalogStackedCollectionModel<CatalogStackedCollectionTemplateNode>;
933
2358
  };
2359
+ /**
2360
+ * Recursive child node types allowed within layout variant containers. Includes all layout
2361
+ * variant nodes such as layout, text, images, data-bound content, interactive triggers,
2362
+ * catalog components, and escape hatches.
2363
+ */
934
2364
  export type LayoutVariantChildren = {
935
2365
  type: "Row";
936
2366
  node: RowModel<LayoutVariantChildren>;
@@ -980,6 +2410,10 @@ export type LayoutVariantChildren = {
980
2410
  type: "CatalogStackedCollection";
981
2411
  node: CatalogStackedCollectionModel<CatalogStackedCollectionTemplateNode>;
982
2412
  };
2413
+ /**
2414
+ * Node types valid for use in layout variants (offer formats). Layout variants contain the
2415
+ * offer-specific creative content including images, text, response buttons, and catalog components.
2416
+ */
983
2417
  export type LayoutVariantSchemaModel = {
984
2418
  type: "Row";
985
2419
  node: RowModel<LayoutVariantChildren>;
@@ -1029,6 +2463,10 @@ export type LayoutVariantSchemaModel = {
1029
2463
  type: "CatalogStackedCollection";
1030
2464
  node: CatalogStackedCollectionModel<CatalogStackedCollectionTemplateNode>;
1031
2465
  };
2466
+ /**
2467
+ * Recursive child node types allowed within outer layout containers. Includes structural,
2468
+ * distribution, navigation, and presentational nodes scoped to outer layout predicates.
2469
+ */
1032
2470
  export type OuterLayoutChildren = {
1033
2471
  type: "Row";
1034
2472
  node: RowModel<OuterLayoutChildren>;
@@ -1087,6 +2525,11 @@ export type OuterLayoutChildren = {
1087
2525
  type: "ToggleButtonStateTrigger";
1088
2526
  node: ToggleButtonStateTriggerModel<ToggleButtonStateTriggerOuterLayoutChildren>;
1089
2527
  };
2528
+ /**
2529
+ * Node types valid for use in outer layouts. Outer layouts define the frame and offer
2530
+ * distribution but do not contain offer-specific content. They include structural containers,
2531
+ * distribution nodes, navigation controls, and close buttons.
2532
+ */
1090
2533
  export type OuterLayoutSchemaModel = {
1091
2534
  type: "Row";
1092
2535
  node: RowModel<OuterLayoutChildren>;