@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,160 +1,484 @@
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;
54
153
  }
55
154
  export type FlexChildFlexPosition = "center" | "flex-start" | "flex-end" | "stretch";
155
+ /**
156
+ * Properties that control how this element behaves as a child within a flex container (Row or Column).
157
+ * All fields are optional. Only include the properties you want to override.
158
+ */
56
159
  export interface FlexChildStylingProperties {
160
+ /**
161
+ * The flex grow weight. Determines how remaining space is distributed.
162
+ * A child with weight 2 gets twice the extra space as one with weight 1.
163
+ */
57
164
  weight?: null | number;
165
+ /** The visual order of this child within its container. Lower values appear first. */
58
166
  order?: null | number;
167
+ /** Overrides the parent container's alignItems for this specific child. */
59
168
  alignSelf?: null | FlexChildFlexPosition;
60
169
  }
170
+ /**
171
+ * Spacing properties for padding, margin and offset.
172
+ * 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.
173
+ * All fields are optional. Only include the properties you want to override.
174
+ */
61
175
  export interface SpacingStylingProperties {
176
+ /**
177
+ * Internal spacing between the element border and its content. Specified as a
178
+ * space-separated string of numeric values following CSS shorthand: '10' for all sides,
179
+ * '10 20' for vertical/horizontal, '10 20 10 20' for top/right/bottom/left.
180
+ */
62
181
  padding?: null | string;
182
+ /** External spacing around the outside of the element border. Same format as padding. */
63
183
  margin?: null | string;
184
+ /** Positional offset from the element's normal position. Same format as padding. */
64
185
  offset?: null | string;
65
186
  }
66
- export type FontWeight = "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900";
67
- export type FontJustification = "left" | "right" | "center" | "start" | "end" | "justify";
68
- export type FontBaselineAlignment = "super" | "sub" | "baseline";
69
- export type FontStyle = "normal" | "italic";
70
- export type TextTransform = "capitalize" | "uppercase" | "lowercase" | "none";
71
- export type TextDecoration = "underline" | "strike-through" | "none";
187
+ /**
188
+ * The weight (boldness) of the font. Values are CSS-standard numeric weights.
189
+ * MUST be one of the predefined weight values. Do NOT use arbitrary numbers.
190
+ */
191
+ export type FontWeight =
192
+ /** Thin (Hairline). The lightest available weight. */
193
+ "100"
194
+ /** Extra Light (Ultra Light). */
195
+ | "200"
196
+ /** Light. */
197
+ | "300"
198
+ /** Normal / Regular. The default font weight. */
199
+ | "400"
200
+ /** Medium. Slightly bolder than normal. */
201
+ | "500"
202
+ /** Semi Bold (Demi Bold). */
203
+ | "600"
204
+ /** Bold. */
205
+ | "700"
206
+ /** Extra Bold (Ultra Bold). */
207
+ | "800"
208
+ /** Black (Heavy). The boldest available weight. */
209
+ | "900";
210
+ /**
211
+ * Horizontal text alignment within the text element.
212
+ * MUST use one of the specified alignment values. Do NOT use CSS text-align strings directly.
213
+ */
214
+ export type FontJustification =
215
+ /** Aligns text to the left edge. */
216
+ "left"
217
+ /** Aligns text to the right edge. */
218
+ | "right"
219
+ /** Centers text horizontally. */
220
+ | "center"
221
+ /** Aligns text to the start edge (left in LTR, right in RTL). */
222
+ | "start"
223
+ /** Aligns text to the end edge (right in LTR, left in RTL). */
224
+ | "end"
225
+ /** Stretches text so each line fills the full width, adjusting spacing between words. */
226
+ | "justify";
227
+ /**
228
+ * Vertical alignment of text relative to the baseline.
229
+ * Use this to position text as superscript, subscript, or at the normal baseline.
230
+ */
231
+ export type FontBaselineAlignment =
232
+ /** Raises text above the baseline (superscript). */
233
+ "super"
234
+ /** Lowers text below the baseline (subscript). */
235
+ | "sub"
236
+ /** Aligns text to the normal baseline position. */
237
+ | "baseline";
238
+ /**
239
+ * The style of the font.
240
+ * Controls whether text is rendered upright or italicised.
241
+ */
242
+ export type FontStyle =
243
+ /** Standard upright text. */
244
+ "normal"
245
+ /** Italicised text. */
246
+ | "italic";
247
+ /**
248
+ * Controls text capitalisation.
249
+ * Applied as a visual transform; does not alter the underlying text data.
250
+ */
251
+ export type TextTransform =
252
+ /** Capitalises the first letter of each word. */
253
+ "capitalize"
254
+ /** Transforms all text to uppercase. */
255
+ | "uppercase"
256
+ /** Transforms all text to lowercase. */
257
+ | "lowercase"
258
+ /** No transformation applied. */
259
+ | "none";
260
+ /**
261
+ * Decorative line applied to text.
262
+ * Use to add visual emphasis such as underline or strikethrough.
263
+ */
264
+ export type TextDecoration =
265
+ /** Adds a line beneath the text. */
266
+ "underline"
267
+ /** Adds a line through the middle of the text. */
268
+ | "strike-through"
269
+ /** No decoration applied. */
270
+ | "none";
271
+ /**
272
+ * Typography styling properties for text elements.
273
+ * All fields are optional. Only include the properties you want to override.
274
+ */
72
275
  export interface TextStylingProperties {
276
+ /** The text color. Uses themed values for light/dark mode support. */
73
277
  textColor?: null | ThemeColor;
278
+ /** Font size in platform units (px on Web, pt on iOS, dp on Android). */
74
279
  fontSize?: null | number;
280
+ /** The font family name. Use 'rokt-icons' for icon fonts. */
75
281
  fontFamily?: null | string;
282
+ /** The weight (boldness) of the font. */
76
283
  fontWeight?: null | FontWeight;
284
+ /** Line height in platform units. Controls the spacing between lines of text. */
77
285
  lineHeight?: null | number;
286
+ /** Horizontal text alignment within the element. */
78
287
  horizontalTextAlign?: null | FontJustification;
288
+ /** Vertical alignment of text relative to the baseline. */
79
289
  baselineTextAlign?: null | FontBaselineAlignment;
290
+ /** Normal or italic text rendering. */
80
291
  fontStyle?: null | FontStyle;
292
+ /** Controls automatic text capitalisation. */
81
293
  textTransform?: null | TextTransform;
294
+ /** Additional spacing between characters in platform units. */
82
295
  letterSpacing?: null | number;
296
+ /** Decorative line applied to text (underline, strikethrough). */
83
297
  textDecoration?: null | TextDecoration;
298
+ /** Maximum number of lines to display. Text beyond this limit is truncated. */
84
299
  lineLimit?: null | number;
85
300
  }
301
+ /** Visual styles for the BasicText node. */
86
302
  export interface BasicTextStyle {
303
+ /** Width, height and rotation properties. */
87
304
  dimension?: null | DimensionStylingProperties;
305
+ /** Properties controlling behaviour as a flex child. */
88
306
  flexChild?: null | FlexChildStylingProperties;
307
+ /** Padding, margin and offset properties. */
89
308
  spacing?: null | SpacingStylingProperties;
309
+ /** Background color and image properties. */
90
310
  background?: null | BackgroundStylingProperties;
311
+ /** Typography properties. */
91
312
  text?: null | TextStylingProperties;
92
313
  }
314
+ /** Style elements for the BasicText node. */
93
315
  export interface BasicTextElements {
316
+ /** Style blocks for the node's primary element. Array represents breakpoint-specific styles. */
94
317
  own: BasicStateStylingBlock<BasicTextStyle>[];
95
318
  }
96
319
  export type LayoutStyleTransition<Styles> = {
97
320
  type: "Conditional";
98
321
  transition: ConditionalStyleTransition<Styles>;
99
322
  };
323
+ /** The top-level style object for a node. Contains element styling and optional conditional transitions. */
100
324
  export interface LayoutStyle<ElementsStyles, TransitionsStyles> {
325
+ /** Defines the visual styles for each styleable element of this node. MUST contain at least an 'own' key with a styling block array. */
101
326
  elements?: null | ElementsStyles;
102
327
  transitions?: null | LayoutStyleTransition<TransitionsStyles>;
103
328
  }
329
+ /** Transition definitions for the BasicText node. */
104
330
  export interface BasicTextTransitions {
331
+ /** Transition properties for the primary element. */
105
332
  own?: null | BasicTextStyle;
106
333
  }
334
+ /** Renders a paragraph of plain text. Use for simple text content. For text with HTML formatting use RichText instead. */
107
335
  export interface BasicTextModel {
336
+ /** Visual styles for the text element. */
108
337
  styles?: null | LayoutStyle<BasicTextElements, BasicTextTransitions>;
338
+ /** The text content to display. Supports data binding placeholders in the format %^DATA.key^% for dynamic creative content. */
109
339
  value: string;
110
340
  }
111
- export type BorderStyle = "solid" | "dashed";
341
+ /**
342
+ * The visual style of the border line.
343
+ * MUST be one of the supported values. Do NOT use CSS border-style strings directly.
344
+ */
345
+ export type BorderStyle =
346
+ /** A solid continuous border line. */
347
+ "solid"
348
+ /** A dashed border line. */
349
+ | "dashed";
350
+ /**
351
+ * Border styling properties for elements.
352
+ * All fields are optional. Only include the properties you want to override.
353
+ */
112
354
  export interface BorderStylingProperties {
355
+ /** Corner radius in platform units (px on Web, pt on iOS, dp on Android). Applies uniformly to all corners. */
113
356
  borderRadius?: null | number;
357
+ /** The border color. Uses themed values for light/dark mode support. */
114
358
  borderColor?: null | ThemeColor;
359
+ /**
360
+ * Border width specified as a space-separated string of numeric values in platform units.
361
+ * Follows CSS shorthand: '2' for all sides, '2 4' for vertical/horizontal,
362
+ * '1 2 3 4' for top/right/bottom/left.
363
+ */
115
364
  borderWidth?: null | string;
365
+ /** The visual style of the border line (solid or dashed). */
116
366
  borderStyle?: null | BorderStyle;
117
367
  }
118
- export type OrderableWhenCondition = "is" | "is-not" | "is-below" | "is-above";
368
+ /**
369
+ * Condition operators for numeric/orderable comparisons. Use these to compare
370
+ * values that have a natural ordering (numbers, positions, breakpoints).
371
+ * Serialized as kebab-case strings: "is", "is-not", "is-below", "is-above".
372
+ */
373
+ export type OrderableWhenCondition =
374
+ /** True when the value equals the specified value. */
375
+ "is"
376
+ /** True when the value does not equal the specified value. */
377
+ | "is-not"
378
+ /** True when the value is less than the specified value. */
379
+ | "is-below"
380
+ /** True when the value is greater than the specified value. */
381
+ | "is-above";
382
+ /**
383
+ * Tests the viewport width against a breakpoint value. Use for
384
+ * responsive layouts that adapt to different screen sizes. The value MUST
385
+ * be a string representation of a number in platform units.
386
+ */
119
387
  export interface BreakpointPredicate {
388
+ /** The comparison operator. Use "is-above" or "is-below" for responsive breakpoints. */
120
389
  condition: OrderableWhenCondition;
390
+ /**
391
+ * The breakpoint width in platform units to compare against. MUST be a string
392
+ * representation of a number, e.g. "768".
393
+ */
121
394
  value: string;
122
395
  }
396
+ /** A styling block with only a default state. Used for non-interactive elements. */
123
397
  export interface StatelessStylingBlock<StyleProperties> {
398
+ /** The styles to apply. Always required. */
124
399
  default: StyleProperties;
125
400
  }
126
- export type FlexPosition = "center" | "flex-start" | "flex-end";
401
+ /** Position options within a flex context. */
402
+ export type FlexPosition =
403
+ /** Centers items along the main axis. */
404
+ "center"
405
+ /** Packs items toward the start of the main axis. */
406
+ | "flex-start"
407
+ /** Packs items toward the end of the main axis. */
408
+ | "flex-end";
409
+ /** Defines a box shadow effect. All offset and radius values are in platform units (px on Web, pt on iOS, dp on Android). */
127
410
  export interface Shadow {
411
+ /** Horizontal offset of the shadow. Positive values move the shadow right. */
128
412
  offsetX?: null | number;
413
+ /** Vertical offset of the shadow. Positive values move the shadow down. */
129
414
  offsetY?: null | number;
415
+ /** The blur radius. Higher values create a more diffuse shadow. */
130
416
  blurRadius?: null | number;
417
+ /** The spread radius. Positive values expand the shadow, negative values shrink it. */
131
418
  spreadRadius?: null | number;
419
+ /** The shadow color. */
132
420
  color: ThemeColor;
133
421
  }
134
- export type Overflow = "auto" | "hidden" | "visible" | "scroll";
422
+ /** Controls visibility of content that overflows the container bounds. */
423
+ export type Overflow = "auto"
424
+ /** Content that overflows is clipped and not visible. */
425
+ | "hidden"
426
+ /** Content that overflows remains visible outside the container bounds. */
427
+ | "visible" | "scroll";
428
+ /** Styling properties for container layout behaviour. Only applicable to nodes that contain children. */
135
429
  export interface ContainerStylingProperties {
430
+ /** Controls how children are distributed along the main axis. For a Row this is horizontal, for a Column this is vertical. */
136
431
  justifyContent?: null | FlexPosition;
432
+ /** Controls how children are aligned along the cross axis. For a Row this is vertical, for a Column this is horizontal. */
137
433
  alignItems?: null | FlexPosition;
434
+ /** Applies a box shadow effect around the container. */
138
435
  shadow?: null | Shadow;
436
+ /** Controls whether content overflowing the container bounds is visible or hidden. */
139
437
  overflow?: null | Overflow;
438
+ /** The gap in platform units between children in the container. */
140
439
  gap?: null | number;
440
+ /** Applies a Gaussian blur effect. Value is the blur radius in platform units. */
141
441
  blur?: null | number;
142
442
  }
443
+ /**
444
+ * Visual style properties for the CarouselDistribution container.
445
+ * Contains the standard style categories: container layout, background colors,
446
+ * border appearance, dimensions, flex child positioning, and spacing.
447
+ */
143
448
  export interface CarouselDistributionStyles {
449
+ /** Container layout styles (e.g. flex direction, alignment). */
144
450
  container?: null | ContainerStylingProperties;
451
+ /** Background color and gradient styles. */
145
452
  background?: null | BackgroundStylingProperties;
453
+ /** Border width, color, and radius styles. */
146
454
  border?: null | BorderStylingProperties;
455
+ /** Width and height dimension styles. */
147
456
  dimension?: null | DimensionStylingProperties;
457
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
148
458
  flexChild?: null | FlexChildStylingProperties;
459
+ /** Padding and margin spacing styles. */
149
460
  spacing?: null | SpacingStylingProperties;
150
461
  }
462
+ /**
463
+ * Styling elements for the CarouselDistribution container.
464
+ * The `own` array contains stateless styling blocks applied to the carousel container itself.
465
+ */
151
466
  export interface CarouselDistributionElements {
467
+ /** Array of stateless styling blocks for the carousel container. */
152
468
  own: StatelessStylingBlock<CarouselDistributionStyles>[];
153
469
  }
154
- export type PeekThroughSize = {
470
+ /**
471
+ * The size of the peek-through area showing adjacent carousel items.
472
+ * Controls how much of the next/previous items are visible at the edges.
473
+ */
474
+ export type PeekThroughSize =
475
+ /** A fixed size in platform units (px on Web, pt on iOS, dp on Android) for the peek-through area. */
476
+ {
155
477
  type: "Fixed";
156
478
  value: number;
157
- } | {
479
+ }
480
+ /** A percentage-based size for the peek-through area, relative to the carousel width. */
481
+ | {
158
482
  type: "Percentage";
159
483
  value: number;
160
484
  };
@@ -162,166 +486,468 @@ export interface CarouselSettings {
162
486
  viewableItems: number[];
163
487
  peekThroughSize: PeekThroughSize[];
164
488
  }
489
+ /** Transition styles for animating CarouselDistribution style changes. */
165
490
  export interface CarouselDistributionTransitions {
491
+ /** Transition properties for the carousel container's own styles. */
166
492
  own?: null | CarouselDistributionStyles;
167
493
  }
494
+ /**
495
+ * Presents offers in a horizontally scrollable carousel.
496
+ * Used EXCLUSIVELY in the Outer Layout. This is the container into which offers (Layout Variants) are rendered.
497
+ * Users can swipe left/right to browse offers.
498
+ *
499
+ * Use `viewableItems` to control how many items are visible at once per breakpoint.
500
+ * Use `peekThroughSize` to hint that more items exist by showing partial adjacent items.
501
+ */
168
502
  export interface CarouselDistributionModel {
169
503
  settings: CarouselSettings;
504
+ /**
505
+ * Visual styles for the carousel container.
506
+ * Uses the LayoutStyle wrapper with conditional style transitions.
507
+ */
170
508
  styles?: null | LayoutStyle<CarouselDistributionElements, CarouselDistributionTransitions>;
171
509
  }
510
+ /**
511
+ * Visual style properties for the CloseButton.
512
+ * Contains the standard style categories: container layout, background colors,
513
+ * border appearance, dimensions, flex child positioning, and spacing.
514
+ */
172
515
  export interface CloseButtonStyles {
516
+ /** Container layout styles (e.g. flex direction, alignment). */
173
517
  container?: null | ContainerStylingProperties;
518
+ /** Background color and gradient styles. */
174
519
  background?: null | BackgroundStylingProperties;
520
+ /** Border width, color, and radius styles. */
175
521
  border?: null | BorderStylingProperties;
522
+ /** Width and height dimension styles. */
176
523
  dimension?: null | DimensionStylingProperties;
524
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
177
525
  flexChild?: null | FlexChildStylingProperties;
526
+ /** Padding and margin spacing styles. */
178
527
  spacing?: null | SpacingStylingProperties;
179
528
  }
529
+ /**
530
+ * Styling elements for the CloseButton.
531
+ * The `own` array contains state-dependent styling blocks (e.g. default, pressed)
532
+ * applied to the close button itself.
533
+ */
180
534
  export interface CloseButtonElements {
535
+ /**
536
+ * Array of state-dependent styling blocks for the close button.
537
+ * Each block targets a specific interaction state (default, pressed, etc.).
538
+ */
181
539
  own: BasicStateStylingBlock<CloseButtonStyles>[];
182
540
  }
541
+ /**
542
+ * Transition styles for animating CloseButton style changes.
543
+ * Defines which style properties should animate when the button's conditional styles change.
544
+ */
183
545
  export interface CloseButtonTransitions {
546
+ /** Transition properties for the close button's own styles. */
184
547
  own?: null | CloseButtonStyles;
185
548
  }
549
+ /**
550
+ * A button that closes/dismisses the layout when clicked.
551
+ * Typically contains a StaticIcon with the 'Close' icon.
552
+ *
553
+ * MUST include child content (usually a StaticIcon with name `"Close"`).
554
+ * Do NOT use CreativeResponse for dismissal; use CloseButton instead so that
555
+ * the dismiss action is correctly tracked.
556
+ */
186
557
  export interface CloseButtonModel<Children> {
558
+ /** Visual styles for the close button. Uses the LayoutStyle wrapper with conditional style transitions. */
187
559
  styles?: null | LayoutStyle<CloseButtonElements, CloseButtonTransitions>;
560
+ /**
561
+ * Child nodes forming the button content. Typically a StaticIcon with name `"Close"`.
562
+ * MUST contain at least one child to display the close icon or label.
563
+ */
188
564
  children: Children[];
565
+ /**
566
+ * Optional dismissal method configuration.
567
+ * Controls how the dismissal is reported for analytics purposes.
568
+ */
189
569
  dismissalMethod?: null | string;
190
570
  }
571
+ /**
572
+ * Available style categories for the Column element. Each optional field enables a specific
573
+ * category of visual styling. Omit a field to leave that category unstyled.
574
+ */
191
575
  export interface ColumnStyle {
576
+ /**
577
+ * Layout properties for the flex container (justification, alignment, gap, overflow).
578
+ * MUST be used to control how children are arranged within the column.
579
+ */
192
580
  container?: null | ContainerStylingProperties;
581
+ /**
582
+ * Background color and image properties. Use to set a solid color, gradient, or image
583
+ * behind the column content.
584
+ */
193
585
  background?: null | BackgroundStylingProperties;
586
+ /**
587
+ * Border radius, color, width and style properties. Use to add visible borders or
588
+ * rounded corners to the column.
589
+ */
194
590
  border?: null | BorderStylingProperties;
591
+ /**
592
+ * Width, height and rotation properties. Use to explicitly size the column or apply
593
+ * rotation transforms. Do NOT set width/height if the column should size to its content.
594
+ */
195
595
  dimension?: null | DimensionStylingProperties;
596
+ /**
597
+ * Properties controlling this element's behaviour as a child of a flex container.
598
+ * Use to set flex-grow, flex-shrink, flex-basis, and align-self.
599
+ */
196
600
  flexChild?: null | FlexChildStylingProperties;
601
+ /** Padding, margin and offset properties. Use to add spacing inside or outside the column. */
197
602
  spacing?: null | SpacingStylingProperties;
198
603
  }
604
+ /**
605
+ * Styleable elements of the Column node. The Column has a single styleable element: its own
606
+ * container.
607
+ */
199
608
  export interface ColumnElements {
609
+ /**
610
+ * Style blocks for the column container itself. The array represents breakpoint-specific
611
+ * styles: first item is the default (no breakpoint), subsequent items correspond to
612
+ * breakpoints in ascending order. MUST contain at least one item for the default style.
613
+ */
200
614
  own: BasicStateStylingBlock<ColumnStyle>[];
201
615
  }
616
+ /** Transition styles for the Column node. Use to animate style changes smoothly. */
202
617
  export interface ColumnTransitions {
618
+ /**
619
+ * Transition properties for the column container. Specifies which style properties
620
+ * should animate and their duration/easing when values change.
621
+ */
203
622
  own?: null | ColumnStyle;
204
623
  }
624
+ /**
625
+ * A vertical flex container that arranges its children in a column (top to bottom). Use for
626
+ * vertical layouts. Children are laid out along the vertical axis by default. To control
627
+ * alignment and distribution, configure the container styles. Do NOT nest Columns
628
+ * unnecessarily when a single Column with appropriate styling would suffice.
629
+ */
205
630
  export interface ColumnModel<Children> {
631
+ /**
632
+ * Visual styles for this column. See styling documentation for the structure. Omit to use
633
+ * default (unstyled) rendering.
634
+ */
206
635
  styles?: null | LayoutStyle<ColumnElements, ColumnTransitions>;
636
+ /**
637
+ * Child nodes rendered vertically within this column.
638
+ * Children are laid out top to bottom in source order.
639
+ */
207
640
  children: Children[];
208
641
  }
209
- export type WhenPredicate = {
642
+ /**
643
+ * All available predicate types for conditional rendering in the full layout
644
+ * schema. Used with the When node to conditionally show or hide children.
645
+ * Each predicate MUST include a "type" field to identify the predicate kind
646
+ * and a "predicate" field containing the predicate configuration.
647
+ */
648
+ export type WhenPredicate =
649
+ /** Tests the viewport width against a breakpoint value. */
650
+ {
210
651
  type: "Breakpoint";
211
652
  predicate: BreakpointPredicate;
212
- } | {
653
+ }
654
+ /** Tests the position index of the current item in a collection. */
655
+ | {
213
656
  type: "Position";
214
657
  predicate: PositionPredicate;
215
- } | {
658
+ }
659
+ /** Tests which offer index is currently visible. */
660
+ | {
216
661
  type: "Progression";
217
662
  predicate: ProgressionPredicate;
218
- } | {
663
+ }
664
+ /** Tests whether dark mode is active. */
665
+ | {
219
666
  type: "DarkMode";
220
667
  predicate: DarkModePredicate;
221
- } | {
668
+ }
669
+ /** Tests whether a creative data attribute exists. */
670
+ | {
222
671
  type: "CreativeCopy";
223
672
  predicate: CreativeCopyPredicate;
224
- } | {
673
+ }
674
+ /** Evaluates a hardcoded boolean value. */
675
+ | {
225
676
  type: "StaticBoolean";
226
677
  predicate: StaticBooleanPredicate;
227
678
  };
679
+ /** Defines a style transition that is applied when the specified predicates evaluate to true. */
228
680
  export interface ConditionalStyleTransition<Styles> {
681
+ /** The list of conditions that must all be true for this transition to apply. */
229
682
  predicates: WhenPredicate[];
683
+ /** The transition duration in milliseconds. */
230
684
  duration: number;
685
+ /** The style properties to apply when all predicates are met. */
231
686
  value: Styles;
232
687
  }
233
- export type ExistenceWhenCondition = "exists" | "not-exists";
688
+ /**
689
+ * Condition operators for checking whether a value exists. Use these to
690
+ * conditionally render content based on whether data is present.
691
+ * Serialized as kebab-case strings: "exists", "not-exists".
692
+ */
693
+ export type ExistenceWhenCondition =
694
+ /** True when the value is present and non-empty. */
695
+ "exists"
696
+ /** True when the value is absent or empty. */
697
+ | "not-exists";
698
+ /**
699
+ * Tests whether a creative data attribute exists. Use to conditionally show
700
+ * content only when specific creative data is available. Do NOT use this for
701
+ * non-creative data checks.
702
+ */
234
703
  export interface CreativeCopyPredicate {
704
+ /** Whether to check for existence or non-existence of the creative attribute. */
235
705
  condition: ExistenceWhenCondition;
706
+ /**
707
+ * The dot-notation path to the creative attribute, e.g.
708
+ * "creative.socialProof.number". MUST use dot notation to reference
709
+ * nested creative data fields.
710
+ */
236
711
  value: string;
237
712
  }
713
+ /**
714
+ * Visual style properties for the CreativeResponse button.
715
+ * Contains the standard style categories: container layout, background colors,
716
+ * border appearance, dimensions, flex child positioning, and spacing.
717
+ */
238
718
  export interface CreativeResponseStyles {
719
+ /** Container layout styles (e.g. flex direction, alignment). */
239
720
  container?: null | ContainerStylingProperties;
721
+ /** Background color and gradient styles. */
240
722
  background?: null | BackgroundStylingProperties;
723
+ /** Border width, color, and radius styles. */
241
724
  border?: null | BorderStylingProperties;
725
+ /** Width and height dimension styles. */
242
726
  dimension?: null | DimensionStylingProperties;
727
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
243
728
  flexChild?: null | FlexChildStylingProperties;
729
+ /** Padding and margin spacing styles. */
244
730
  spacing?: null | SpacingStylingProperties;
245
731
  }
732
+ /**
733
+ * Styling elements for the CreativeResponse button.
734
+ * The `own` array contains state-dependent styling blocks (e.g. default, pressed, disabled)
735
+ * applied to the button itself.
736
+ */
246
737
  export interface CreativeResponseElements {
738
+ /**
739
+ * Array of state-dependent styling blocks for the button.
740
+ * Each block targets a specific interaction state (default, pressed, disabled, etc.).
741
+ */
247
742
  own: BasicStateStylingBlock<CreativeResponseStyles>[];
248
743
  }
744
+ /**
745
+ * Transition styles for animating CreativeResponse style changes.
746
+ * Defines which style properties should animate when the button's conditional styles change.
747
+ */
249
748
  export interface CreativeResponseTransitions {
749
+ /** Transition properties for the button's own styles. */
250
750
  own?: null | CreativeResponseStyles;
251
751
  }
252
- export type LinkOpenTarget = "internally" | "externally";
752
+ /**
753
+ * Controls how links are opened when clicked. MUST be one of the valid
754
+ * kebab-case string values. Determines the navigation behavior when a
755
+ * user activates a link action.
756
+ */
757
+ export type LinkOpenTarget =
758
+ /**
759
+ * Opens the link within the current context (in-app webview or same
760
+ * window). Use for links that should keep the user in the application.
761
+ */
762
+ "internally"
763
+ /**
764
+ * Opens the link in the system browser. Use for external URLs that
765
+ * should leave the application context.
766
+ */
767
+ | "externally";
768
+ /**
769
+ * A button that triggers a creative response (positive or negative).
770
+ * This is the primary call-to-action node for offer interactions.
771
+ * Children inside this node become the button content.
772
+ *
773
+ * MUST have a `responseKey` of either `"positive"` or `"negative"`.
774
+ * Use `"positive"` for accept/CTA buttons and `"negative"` for decline/dismiss buttons.
775
+ * Do NOT use this node for non-response actions like navigation; use StaticLink or ButtonStateTrigger instead.
776
+ */
253
777
  export interface CreativeResponseModel<Children> {
778
+ /**
779
+ * The response type. Use `"positive"` for accept/CTA buttons, `"negative"` for decline/dismiss buttons.
780
+ * Do NOT use arbitrary strings; only `"positive"` and `"negative"` are valid.
781
+ */
254
782
  responseKey: string;
783
+ /** Visual styles for the button. Uses the LayoutStyle wrapper with conditional style transitions. */
255
784
  styles?: null | LayoutStyle<CreativeResponseElements, CreativeResponseTransitions>;
785
+ /**
786
+ * Controls how the response URL is opened when clicked.
787
+ * If omitted, the default link opening behaviour is used.
788
+ */
256
789
  openLinks?: null | LinkOpenTarget;
790
+ /**
791
+ * Child nodes that form the button's visible content.
792
+ * Typically contains a BasicText node with the CTA label.
793
+ * MUST contain at least one child to display button content.
794
+ */
257
795
  children: Children[];
258
796
  }
259
- export type EqualityWhenCondition = "is" | "is-not";
797
+ /**
798
+ * Condition operators for equality comparisons. Use these when you only need
799
+ * to test if two values are equal or not equal.
800
+ * Serialized as kebab-case strings: "is", "is-not".
801
+ */
802
+ export type EqualityWhenCondition =
803
+ /** True when the value equals the specified value. */
804
+ "is"
805
+ /** True when the value does not equal the specified value. */
806
+ | "is-not";
807
+ /**
808
+ * Tests whether dark mode is active. Use to provide different styling or
809
+ * content for light and dark modes.
810
+ */
260
811
  export interface DarkModePredicate {
812
+ /** Use "is" to check if dark mode matches the value, "is-not" for the inverse. */
261
813
  condition: EqualityWhenCondition;
814
+ /**
815
+ * The boolean value to compare against. Set to true to test for dark mode,
816
+ * false to test for light mode.
817
+ */
262
818
  value: boolean;
263
819
  }
820
+ /** Visual styles for the DataIcon node. */
264
821
  export interface DataIconStyles {
822
+ /** Typography properties. */
265
823
  text?: null | TextStylingProperties;
824
+ /** Width, height and rotation properties. */
266
825
  dimension?: null | DimensionStylingProperties;
826
+ /** Properties controlling behaviour as a flex child. */
267
827
  flexChild?: null | FlexChildStylingProperties;
828
+ /** Padding, margin and offset properties. */
268
829
  spacing?: null | SpacingStylingProperties;
830
+ /** Background color and image properties. */
269
831
  background?: null | BackgroundStylingProperties;
832
+ /** Border radius, color, width and style. */
270
833
  border?: null | BorderStylingProperties;
271
834
  }
835
+ /** Style elements for the DataIcon node. */
272
836
  export interface DataIconElements {
837
+ /** Style blocks for the node's primary element. Array represents breakpoint-specific styles. */
273
838
  own: BasicStateStylingBlock<DataIconStyles>[];
274
839
  }
840
+ /** Transition definitions for the DataIcon node. */
275
841
  export interface DataIconTransitions {
842
+ /** Transition properties for the primary element. */
276
843
  own?: null | DataIconStyles;
277
844
  }
845
+ /** Renders an icon from creative data. The icon is resolved from the creative object using the iconKey. */
278
846
  export interface DataIconModel {
847
+ /** Visual styles for the icon. */
279
848
  styles?: null | LayoutStyle<DataIconElements, DataIconTransitions>;
849
+ /** The key identifying which icon from the creative data to display. */
280
850
  iconKey: string;
281
851
  isImportantForAccessibility?: null | boolean;
282
852
  }
853
+ /** Visual styles for the DataImage node. */
283
854
  export interface DataImageStyles {
855
+ /** Background color and image properties. */
284
856
  background?: null | BackgroundStylingProperties;
857
+ /** Border radius, color, width and style. */
285
858
  border?: null | BorderStylingProperties;
859
+ /** Width, height and rotation properties. */
286
860
  dimension?: null | DimensionStylingProperties;
861
+ /** Properties controlling behaviour as a flex child. */
287
862
  flexChild?: null | FlexChildStylingProperties;
863
+ /** Padding, margin and offset properties. */
288
864
  spacing?: null | SpacingStylingProperties;
289
865
  }
866
+ /** Style elements for the DataImage node. */
290
867
  export interface DataImageElements {
868
+ /** Style blocks for the node's primary element. Array represents breakpoint-specific styles. */
291
869
  own: BasicStateStylingBlock<DataImageStyles>[];
292
870
  }
871
+ /** Transition definitions for the DataImage node. */
293
872
  export interface DataImageTransitions {
873
+ /** Transition properties for the primary element. */
294
874
  own?: null | DataImageStyles;
295
875
  }
876
+ /** Renders an image from creative data. The image URL is resolved from the creative object using the imageKey. Use for offer-specific images. */
296
877
  export interface DataImageModel {
878
+ /** Visual styles for the image element. */
297
879
  styles?: null | LayoutStyle<DataImageElements, DataImageTransitions>;
880
+ /** The key identifying which image from the creative data to display. */
298
881
  imageKey: string;
299
882
  isImportantForAccessibility?: null | boolean;
300
883
  }
884
+ /** Settings for a bidirectional fade-in/fade-out transition. */
301
885
  export interface FadeInOutTransitionSettings {
886
+ /**
887
+ * The transition duration in milliseconds. MUST be a positive integer.
888
+ * Common values: 200 for fast, 400 for medium, 1000 for slow.
889
+ */
302
890
  duration: number;
303
891
  }
892
+ /** Settings for a fade-in (enter) transition. */
304
893
  export interface FadeInTransitionSettings {
894
+ /**
895
+ * The transition duration in milliseconds. MUST be a positive integer.
896
+ * Common values: 200 for fast, 400 for medium, 1000 for slow.
897
+ */
305
898
  duration: number;
306
899
  }
900
+ /** Settings for a fade-out (exit) transition. */
307
901
  export interface FadeOutTransitionSettings {
902
+ /**
903
+ * The transition duration in milliseconds. MUST be a positive integer.
904
+ * Common values: 200 for fast, 400 for medium, 1000 for slow.
905
+ */
308
906
  duration: number;
309
907
  }
908
+ /**
909
+ * Visual style properties for the GroupedDistribution container.
910
+ * Contains the standard style categories: container layout, background colors,
911
+ * border appearance, dimensions, flex child positioning, and spacing.
912
+ */
310
913
  export interface GroupedDistributionStyles {
914
+ /** Container layout styles (e.g. flex direction, alignment). */
311
915
  container?: null | ContainerStylingProperties;
916
+ /** Background color and gradient styles. */
312
917
  background?: null | BackgroundStylingProperties;
918
+ /** Border width, color, and radius styles. */
313
919
  border?: null | BorderStylingProperties;
920
+ /** Width and height dimension styles. */
314
921
  dimension?: null | DimensionStylingProperties;
922
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
315
923
  flexChild?: null | FlexChildStylingProperties;
924
+ /** Padding and margin spacing styles. */
316
925
  spacing?: null | SpacingStylingProperties;
317
926
  }
927
+ /**
928
+ * Styling elements for the GroupedDistribution container.
929
+ * The `own` array contains stateless styling blocks applied to the grouped container itself.
930
+ */
318
931
  export interface GroupedDistributionElements {
932
+ /** Array of stateless styling blocks for the grouped container. */
319
933
  own: StatelessStylingBlock<GroupedDistributionStyles>[];
320
934
  }
935
+ /** Transition styles for animating GroupedDistribution style changes. */
321
936
  export interface GroupedDistributionTransitions {
937
+ /** Transition properties for the grouped container's own styles. */
322
938
  own?: null | GroupedDistributionStyles;
323
939
  }
324
- export type Transition = {
940
+ /**
941
+ * A bidirectional transition that applies both when showing and hiding an
942
+ * element. MUST be an object with a "type" field and a "settings" field.
943
+ * Currently only "FadeInOut" is supported.
944
+ */
945
+ export type Transition =
946
+ /**
947
+ * A fade-in/fade-out transition. The element fades in when shown and
948
+ * fades out when hidden, using the specified duration.
949
+ */
950
+ {
325
951
  type: "FadeInOut";
326
952
  settings: FadeInOutTransitionSettings;
327
953
  };
@@ -329,309 +955,859 @@ export interface GroupedSettings {
329
955
  viewableItems: number[];
330
956
  transition: Transition;
331
957
  }
958
+ /**
959
+ * Presents offers in groups, progressing through groups sequentially.
960
+ * Used EXCLUSIVELY in the Outer Layout. This is the container into which offers (Layout Variants) are rendered.
961
+ * Each group shows a fixed number of offers at once, and the user advances through groups.
962
+ *
963
+ * Pair with ProgressControl nodes for group navigation.
964
+ * Use `viewableItems` to control how many offers appear per group at each breakpoint.
965
+ */
332
966
  export interface GroupedDistributionModel {
967
+ /**
968
+ * Visual styles for the grouped container.
969
+ * Uses the LayoutStyle wrapper with conditional style transitions.
970
+ */
333
971
  styles?: null | LayoutStyle<GroupedDistributionElements, GroupedDistributionTransitions>;
334
972
  settings: GroupedSettings;
335
973
  }
974
+ /**
975
+ * Typography styling for inline text elements. A subset of TextStylingProperties
976
+ * without line-level controls (lineHeight, horizontalTextAlign, lineLimit).
977
+ * All fields are optional. Only include the properties you want to override.
978
+ */
336
979
  export interface InlineTextStylingProperties {
980
+ /** The text color. Uses themed values for light/dark mode support. */
337
981
  textColor?: null | ThemeColor;
982
+ /** Font size in platform units (px on Web, pt on iOS, dp on Android). */
338
983
  fontSize?: null | number;
984
+ /** The font family name. Use 'rokt-icons' for icon fonts. */
339
985
  fontFamily?: null | string;
986
+ /** The weight (boldness) of the font. */
340
987
  fontWeight?: null | FontWeight;
988
+ /** Vertical alignment of text relative to the baseline. */
341
989
  baselineTextAlign?: null | FontBaselineAlignment;
990
+ /** Normal or italic text rendering. */
342
991
  fontStyle?: null | FontStyle;
992
+ /** Controls automatic text capitalisation. */
343
993
  textTransform?: null | TextTransform;
994
+ /** Additional spacing between characters in platform units. */
344
995
  letterSpacing?: null | number;
996
+ /** Decorative line applied to text (underline, strikethrough). */
345
997
  textDecoration?: null | TextDecoration;
346
998
  }
999
+ /** Inline text styling for elements like links within rich text. */
347
1000
  export interface InLineTextStyle {
1001
+ /** Typography properties for the inline text element. */
348
1002
  text: InlineTextStylingProperties;
349
1003
  }
1004
+ /**
1005
+ * Visual style properties for individual indicator items (dots, bars, etc.).
1006
+ * Includes text styling for number-based indicators.
1007
+ */
350
1008
  export interface IndicatorStyles {
1009
+ /** Container layout styles (e.g. flex direction, alignment). */
351
1010
  container?: null | ContainerStylingProperties;
1011
+ /** Background color and gradient styles. */
352
1012
  background?: null | BackgroundStylingProperties;
1013
+ /** Border width, color, and radius styles. */
353
1014
  border?: null | BorderStylingProperties;
1015
+ /** Width and height dimension styles. */
354
1016
  dimension?: null | DimensionStylingProperties;
1017
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
355
1018
  flexChild?: null | FlexChildStylingProperties;
1019
+ /** Padding and margin spacing styles. */
356
1020
  spacing?: null | SpacingStylingProperties;
1021
+ /** Text styling for number-based indicators. */
357
1022
  text?: null | TextStylingProperties;
358
1023
  }
1024
+ /** Platform-specific settings for the layout behaviour. */
359
1025
  export interface LayoutSettings {
1026
+ /** Whether to automatically close the layout after the user completes the interaction flow. */
360
1027
  closeOnComplete?: null | boolean;
361
1028
  }
1029
+ /**
1030
+ * Visual style properties for the OneByOneDistribution container.
1031
+ * Contains the standard style categories: container layout, background colors,
1032
+ * border appearance, dimensions, flex child positioning, and spacing.
1033
+ */
362
1034
  export interface OneByOneDistributionStyles {
1035
+ /** Container layout styles (e.g. flex direction, alignment). */
363
1036
  container?: null | ContainerStylingProperties;
1037
+ /** Background color and gradient styles. */
364
1038
  background?: null | BackgroundStylingProperties;
1039
+ /** Border width, color, and radius styles. */
365
1040
  border?: null | BorderStylingProperties;
1041
+ /** Width and height dimension styles. */
366
1042
  dimension?: null | DimensionStylingProperties;
1043
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
367
1044
  flexChild?: null | FlexChildStylingProperties;
1045
+ /** Padding and margin spacing styles. */
368
1046
  spacing?: null | SpacingStylingProperties;
369
1047
  }
1048
+ /**
1049
+ * Styling elements for the OneByOneDistribution container.
1050
+ * The `own` array contains stateless styling blocks applied to the distribution container itself.
1051
+ */
370
1052
  export interface OneByOneDistributionElements {
1053
+ /** Array of stateless styling blocks for the distribution container. */
371
1054
  own: StatelessStylingBlock<OneByOneDistributionStyles>[];
372
1055
  }
1056
+ /** Transition styles for animating OneByOneDistribution style changes. */
373
1057
  export interface OneByOneDistributionTransitions {
1058
+ /** Transition properties for the distribution container's own styles. */
374
1059
  own?: null | OneByOneDistributionStyles;
375
1060
  }
1061
+ /**
1062
+ * Presents offers one at a time, allowing the user to progress through them sequentially.
1063
+ * Used EXCLUSIVELY in the Outer Layout. This is the container into which offers (Layout Variants) are rendered.
1064
+ *
1065
+ * Pair with ProgressControl nodes to enable forward/backward navigation between offers.
1066
+ * Pair with ProgressIndicator to show the user's current position.
1067
+ * Do NOT use this for displaying all offers at once; use StackedDistribution instead.
1068
+ */
376
1069
  export interface OneByOneDistributionModel {
1070
+ /**
1071
+ * Visual styles for the distribution container.
1072
+ * Uses the LayoutStyle wrapper with conditional style transitions.
1073
+ */
377
1074
  styles?: null | LayoutStyle<OneByOneDistributionElements, OneByOneDistributionTransitions>;
1075
+ /**
1076
+ * The animation transition between offers.
1077
+ * Defines how the current offer exits and the next offer enters.
1078
+ */
378
1079
  transition: Transition;
379
1080
  }
1081
+ /**
1082
+ * Available style categories for the Overlay content element. Each optional field enables a
1083
+ * specific category of visual styling. Omit a field to leave that category unstyled.
1084
+ */
380
1085
  export interface OverlayStyles {
1086
+ /**
1087
+ * Layout properties for the flex container (justification, alignment, gap, overflow).
1088
+ * MUST be used to control how children are arranged within the overlay content area.
1089
+ */
381
1090
  container?: null | ContainerStylingProperties;
1091
+ /**
1092
+ * Background color and image properties. Use to set a solid color, gradient, or image
1093
+ * behind the overlay content.
1094
+ */
382
1095
  background?: null | BackgroundStylingProperties;
1096
+ /**
1097
+ * Border radius, color, width and style properties. Use to add visible borders or
1098
+ * rounded corners to the overlay content area.
1099
+ */
383
1100
  border?: null | BorderStylingProperties;
1101
+ /**
1102
+ * Width, height and rotation properties. Use to explicitly size the overlay content area.
1103
+ * Do NOT set width/height if the overlay should size to its content.
1104
+ */
384
1105
  dimension?: null | DimensionStylingProperties;
1106
+ /**
1107
+ * Properties controlling this element's behaviour as a child of a flex container.
1108
+ * Use to set flex-grow, flex-shrink, flex-basis, and align-self.
1109
+ */
385
1110
  flexChild?: null | FlexChildStylingProperties;
1111
+ /**
1112
+ * Padding, margin and offset properties. Use to add spacing inside or outside the
1113
+ * overlay content area.
1114
+ */
386
1115
  spacing?: null | SpacingStylingProperties;
387
1116
  }
1117
+ /**
1118
+ * Style categories for the Overlay wrapper (backdrop) element. Controls the appearance of
1119
+ * the area behind the overlay content.
1120
+ */
388
1121
  export interface OverlayWrapperStyles {
1122
+ /** Layout properties for the wrapper container that positions the overlay content. */
389
1123
  container?: null | ContainerStylingProperties;
1124
+ /**
1125
+ * Background color for the backdrop. Typically a semi-transparent color (using `#AARRGGBB`
1126
+ * format, e.g. `#80000000`) to dim the content behind the overlay.
1127
+ */
390
1128
  background?: null | BackgroundStylingProperties;
391
1129
  }
1130
+ /**
1131
+ * Styleable elements of the Overlay node. The Overlay has two styleable elements: its own
1132
+ * content area and its wrapper (backdrop).
1133
+ */
392
1134
  export interface OverlayElements {
1135
+ /**
1136
+ * Style blocks for the overlay content area. The array represents breakpoint-specific
1137
+ * styles: first item is the default (no breakpoint), subsequent items correspond to
1138
+ * breakpoints in ascending order. MUST contain at least one item for the default style.
1139
+ */
393
1140
  own: BasicStateStylingBlock<OverlayStyles>[];
1141
+ /**
1142
+ * Style blocks for the overlay wrapper (backdrop). The array represents
1143
+ * breakpoint-specific styles: first item is the default, subsequent items correspond
1144
+ * to breakpoints in ascending order.
1145
+ */
394
1146
  wrapper: BasicStateStylingBlock<OverlayWrapperStyles>[];
395
1147
  }
396
1148
  export interface OverlaySettings {
397
1149
  allowBackdropToClose: boolean;
398
1150
  }
1151
+ /** Transition styles for the Overlay node. Use to animate style changes smoothly. */
399
1152
  export interface OverlayTransitions {
1153
+ /**
1154
+ * Transition properties for the overlay content area. Specifies which style properties
1155
+ * should animate and their duration/easing when values change.
1156
+ */
400
1157
  own?: null | OverlayStyles;
1158
+ /** Transition properties for the overlay wrapper (backdrop). */
401
1159
  wrapper?: null | OverlayWrapperStyles;
402
1160
  }
1161
+ /**
1162
+ * A modal overlay that appears on top of the main content with a backdrop. Use for dialogs,
1163
+ * confirmations, and modal interactions that require user attention. The overlay blocks
1164
+ * interaction with the content behind it. Do NOT use Overlay for inline content layering;
1165
+ * use ZStack instead.
1166
+ */
403
1167
  export interface OverlayModel<Children> {
404
1168
  settings: OverlaySettings;
1169
+ /**
1170
+ * Visual styles for this overlay. See styling documentation for the structure. Omit to
1171
+ * use default (unstyled) rendering.
1172
+ */
405
1173
  styles?: null | LayoutStyle<OverlayElements, OverlayTransitions>;
1174
+ /** The content displayed within the overlay. */
406
1175
  children: Children[];
407
1176
  }
1177
+ /**
1178
+ * Tests the position index of the current item within a collection. Use to
1179
+ * style items differently based on their position (e.g. first item, last item).
1180
+ */
408
1181
  export interface PositionPredicate {
1182
+ /** The comparison operator. */
409
1183
  condition: OrderableWhenCondition;
1184
+ /**
1185
+ * The position index to compare against. MUST be a string representation
1186
+ * of a number, e.g. "0" for the first item.
1187
+ */
410
1188
  value: string;
411
1189
  }
1190
+ /**
1191
+ * Visual style properties for the ProgressControl button.
1192
+ * Contains the standard style categories: container layout, background colors,
1193
+ * border appearance, dimensions, flex child positioning, and spacing.
1194
+ */
412
1195
  export interface ProgressControlStyle {
1196
+ /** Container layout styles (e.g. flex direction, alignment). */
413
1197
  container?: null | ContainerStylingProperties;
1198
+ /** Background color and gradient styles. */
414
1199
  background?: null | BackgroundStylingProperties;
1200
+ /** Border width, color, and radius styles. */
415
1201
  border?: null | BorderStylingProperties;
1202
+ /** Width and height dimension styles. */
416
1203
  dimension?: null | DimensionStylingProperties;
1204
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
417
1205
  flexChild?: null | FlexChildStylingProperties;
1206
+ /** Padding and margin spacing styles. */
418
1207
  spacing?: null | SpacingStylingProperties;
419
1208
  }
1209
+ /**
1210
+ * Styling elements for the ProgressControl button.
1211
+ * The `own` array contains state-dependent styling blocks (e.g. default, pressed, disabled)
1212
+ * applied to the control button itself.
1213
+ */
420
1214
  export interface ProgressControlElements {
1215
+ /**
1216
+ * Array of state-dependent styling blocks for the control button.
1217
+ * Each block targets a specific interaction state (default, pressed, disabled, etc.).
1218
+ */
421
1219
  own: BasicStateStylingBlock<ProgressControlStyle>[];
422
1220
  }
1221
+ /** Transition styles for animating ProgressControl style changes. */
423
1222
  export interface ProgressControlTransitions {
1223
+ /** Transition properties for the control button's own styles. */
424
1224
  own?: null | ProgressControlStyle;
425
1225
  }
426
- export type ProgressionDirection = "Forward" | "Backward";
1226
+ /** The direction in which the progress control advances offers. */
1227
+ export type ProgressionDirection =
1228
+ /** Advance to the next offer or group. */
1229
+ "Forward"
1230
+ /** Return to the previous offer or group. */
1231
+ | "Backward";
1232
+ /**
1233
+ * A button that advances or reverses offer progression.
1234
+ * Used with OneByOneDistribution or GroupedDistribution for navigation.
1235
+ *
1236
+ * MUST specify a `direction` (Forward or Backward).
1237
+ * Pair with a distribution node for the control to have an effect.
1238
+ * Typically contains an arrow icon as child content.
1239
+ */
427
1240
  export interface ProgressControlModel<Children> {
1241
+ /** Visual styles for the control. Uses the LayoutStyle wrapper with conditional style transitions. */
428
1242
  styles?: null | LayoutStyle<ProgressControlElements, ProgressControlTransitions>;
1243
+ /** The direction to progress. MUST be either Forward or Backward. */
429
1244
  direction: ProgressionDirection;
1245
+ /**
1246
+ * Child nodes forming the button content (e.g. an arrow icon).
1247
+ * MUST contain at least one child for the control to have visible content.
1248
+ */
430
1249
  children: Children[];
431
1250
  }
1251
+ /**
1252
+ * Visual style properties for the ProgressIndicator container.
1253
+ * Contains the standard style categories for the outer indicator wrapper.
1254
+ */
432
1255
  export interface ProgressIndicatorStyles {
1256
+ /** Container layout styles (e.g. flex direction, alignment). */
433
1257
  container?: null | ContainerStylingProperties;
1258
+ /** Background color and gradient styles. */
434
1259
  background?: null | BackgroundStylingProperties;
1260
+ /** Border width, color, and radius styles. */
435
1261
  border?: null | BorderStylingProperties;
1262
+ /** Width and height dimension styles. */
436
1263
  dimension?: null | DimensionStylingProperties;
1264
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
437
1265
  flexChild?: null | FlexChildStylingProperties;
1266
+ /** Padding and margin spacing styles. */
438
1267
  spacing?: null | SpacingStylingProperties;
439
1268
  }
1269
+ /**
1270
+ * Styling elements for the ProgressIndicator.
1271
+ * Contains styling blocks for the container, individual indicators, and special indicator states.
1272
+ */
440
1273
  export interface ProgressIndicatorElements {
1274
+ /** Array of state-dependent styling blocks for the indicator container. */
441
1275
  own: BasicStateStylingBlock<ProgressIndicatorStyles>[];
1276
+ /** Styling blocks for each individual indicator item (default state). */
442
1277
  indicator: BasicStateStylingBlock<IndicatorStyles>[];
1278
+ /**
1279
+ * Optional styling blocks for the currently active indicator.
1280
+ * If omitted, the default indicator styling is used.
1281
+ */
443
1282
  activeIndicator?: null | BasicStateStylingBlock<IndicatorStyles>[];
1283
+ /**
1284
+ * Optional styling blocks for indicators that have been seen/visited.
1285
+ * If omitted, the default indicator styling is used.
1286
+ */
444
1287
  seenIndicator?: null | BasicStateStylingBlock<IndicatorStyles>[];
445
1288
  }
1289
+ /**
1290
+ * Transition styles for animating ProgressIndicator style changes.
1291
+ * Defines transitions for the container and each indicator state.
1292
+ */
446
1293
  export interface ProgressIndicatorTransitions {
1294
+ /** Transition properties for the indicator container's own styles. */
447
1295
  own?: null | ProgressIndicatorStyles;
1296
+ /** Transition properties for the default indicator styles. */
448
1297
  indicator?: null | IndicatorStyles;
1298
+ /** Transition properties for the active indicator styles. */
449
1299
  activeIndicator?: null | IndicatorStyles;
1300
+ /** Transition properties for the seen indicator styles. */
450
1301
  seenIndicator?: null | IndicatorStyles;
451
1302
  }
452
1303
  export interface ProgressIndicatorSettings {
453
1304
  startPosition?: null | number;
454
1305
  }
1306
+ /**
1307
+ * Displays visual progress indicators (dots, bars) showing the user's position
1308
+ * within a series of offers.
1309
+ *
1310
+ * MUST be paired with a distribution node (OneByOneDistribution, GroupedDistribution, etc.)
1311
+ * to track position. The indicator automatically reflects the current offer position.
1312
+ * Use `indicator` to specify the type (e.g. "dot", "bar", "number").
1313
+ */
455
1314
  export interface ProgressIndicatorModel {
1315
+ /**
1316
+ * Visual styles for the progress indicators.
1317
+ * Uses the LayoutStyle wrapper with conditional style transitions.
1318
+ */
456
1319
  styles?: null | LayoutStyle<ProgressIndicatorElements, ProgressIndicatorTransitions>;
1320
+ /**
1321
+ * The type of indicator to display (e.g. "dot", "bar", "number").
1322
+ * MUST be a valid indicator type string.
1323
+ */
457
1324
  indicator: string;
458
1325
  settings?: null | ProgressIndicatorSettings;
459
1326
  isImportantForAccessibility?: null | boolean;
460
1327
  }
1328
+ /**
1329
+ * Tests which offer index is currently visible in a carousel or progression.
1330
+ * Use 0 for the first offer, -1 for the last offer.
1331
+ */
461
1332
  export interface ProgressionPredicate {
1333
+ /** The comparison operator. */
462
1334
  condition: OrderableWhenCondition;
1335
+ /**
1336
+ * The progression index to compare against. MUST be a string representation
1337
+ * of a number. Use "0" for the first offer, "-1" for the last offer.
1338
+ */
463
1339
  value: string;
464
1340
  }
1341
+ /** Visual styles for the RichText node. */
465
1342
  export interface RichTextStyle {
1343
+ /** Width, height and rotation properties. */
466
1344
  dimension?: null | DimensionStylingProperties;
1345
+ /** Properties controlling behaviour as a flex child. */
467
1346
  flexChild?: null | FlexChildStylingProperties;
1347
+ /** Padding, margin and offset properties. */
468
1348
  spacing?: null | SpacingStylingProperties;
1349
+ /** Background color and image properties. */
469
1350
  background?: null | BackgroundStylingProperties;
1351
+ /** Typography properties. */
470
1352
  text?: null | TextStylingProperties;
471
1353
  }
1354
+ /** Style elements for the RichText node. */
472
1355
  export interface RichTextElements {
1356
+ /** Style blocks for the node's primary element. Array represents breakpoint-specific styles. */
473
1357
  own: BasicStateStylingBlock<RichTextStyle>[];
1358
+ /** Style blocks for link elements within the rich text content. */
474
1359
  link?: null | BasicStateStylingBlock<InLineTextStyle>[];
475
1360
  }
1361
+ /** Transition definitions for the RichText node. */
476
1362
  export interface RichTextTransitions {
1363
+ /** Transition properties for the primary element. */
477
1364
  own?: null | RichTextStyle;
1365
+ /** Transition properties for link elements. */
478
1366
  link?: null | InLineTextStyle;
479
1367
  }
1368
+ /** Renders HTML-formatted text content. Supports `<a>`, `<strong>`, `<em>`, `<br>` and other inline HTML elements. Use BasicText for plain text without HTML. */
480
1369
  export interface RichTextModel {
1370
+ /** Visual styles for the text element. */
481
1371
  styles?: null | LayoutStyle<RichTextElements, RichTextTransitions>;
1372
+ /** Controls how links within the rich text are opened when clicked. */
482
1373
  openLinks?: null | LinkOpenTarget;
1374
+ /** The HTML text content to display. Supports inline HTML tags and data binding placeholders in the format %^DATA.key^% or %^ATTRIBUTE.key^%. */
483
1375
  value: string;
484
1376
  }
1377
+ /**
1378
+ * The top-level schema structure for an outer layout. Contains the layout tree,
1379
+ * breakpoint definitions, settings and display configuration.
1380
+ */
485
1381
  export interface RootSchemaModel<Layout, Display, Settings> {
1382
+ /**
1383
+ * Map of breakpoint names to viewport width thresholds in platform units.
1384
+ * Defines responsive breakpoints for the layout.
1385
+ */
486
1386
  breakpoints: Record<string, number>;
1387
+ /** The root node of the layout tree. */
487
1388
  layout: Layout;
1389
+ /** Platform-specific layout settings. */
488
1390
  settings?: null | Settings;
1391
+ /** Controls how the layout is displayed (fullscreen, embedded, etc). */
489
1392
  display?: null | Display;
490
1393
  }
1394
+ /**
1395
+ * Available style categories for the Row element. Each optional field enables a specific
1396
+ * category of visual styling. Omit a field to leave that category unstyled.
1397
+ */
491
1398
  export interface RowStyle {
1399
+ /**
1400
+ * Layout properties for the flex container (justification, alignment, gap, overflow).
1401
+ * MUST be used to control how children are arranged within the row.
1402
+ */
492
1403
  container?: null | ContainerStylingProperties;
1404
+ /**
1405
+ * Background color and image properties. Use to set a solid color, gradient, or image
1406
+ * behind the row content.
1407
+ */
493
1408
  background?: null | BackgroundStylingProperties;
1409
+ /**
1410
+ * Border radius, color, width and style properties. Use to add visible borders or
1411
+ * rounded corners to the row.
1412
+ */
494
1413
  border?: null | BorderStylingProperties;
1414
+ /**
1415
+ * Width, height and rotation properties. Use to explicitly size the row or apply rotation
1416
+ * transforms. Do NOT set width/height if the row should size to its content.
1417
+ */
495
1418
  dimension?: null | DimensionStylingProperties;
1419
+ /**
1420
+ * Properties controlling this element's behaviour as a child of a flex container.
1421
+ * Use to set flex-grow, flex-shrink, flex-basis, and align-self.
1422
+ */
496
1423
  flexChild?: null | FlexChildStylingProperties;
1424
+ /** Padding, margin and offset properties. Use to add spacing inside or outside the row. */
497
1425
  spacing?: null | SpacingStylingProperties;
498
1426
  }
1427
+ /**
1428
+ * Styleable elements of the Row node. The Row has a single styleable element: its own
1429
+ * container.
1430
+ */
499
1431
  export interface RowElements {
1432
+ /**
1433
+ * Style blocks for the row container itself. The array represents breakpoint-specific
1434
+ * styles: first item is the default (no breakpoint), subsequent items correspond to
1435
+ * breakpoints in ascending order. MUST contain at least one item for the default style.
1436
+ */
500
1437
  own: BasicStateStylingBlock<RowStyle>[];
501
1438
  }
1439
+ /** Transition styles for the Row node. Use to animate style changes smoothly. */
502
1440
  export interface RowTransitions {
1441
+ /**
1442
+ * Transition properties for the row container. Specifies which style properties
1443
+ * should animate and their duration/easing when values change.
1444
+ */
503
1445
  own?: null | RowStyle;
504
1446
  }
1447
+ /**
1448
+ * A horizontal flex container that arranges its children in a row (left to right). Use for
1449
+ * horizontal layouts. Children are laid out along the horizontal axis by default. To control
1450
+ * alignment and distribution, configure the container styles. Do NOT nest Rows unnecessarily
1451
+ * when a single Row with appropriate styling would suffice.
1452
+ */
505
1453
  export interface RowModel<Children> {
1454
+ /**
1455
+ * Visual styles for this row. See styling documentation for the structure. Omit to use
1456
+ * default (unstyled) rendering.
1457
+ */
506
1458
  styles?: null | LayoutStyle<RowElements, RowTransitions>;
1459
+ /**
1460
+ * Child nodes rendered horizontally within this row.
1461
+ * Children are laid out left to right in source order.
1462
+ */
507
1463
  children: Children[];
508
1464
  }
1465
+ /**
1466
+ * Visual style properties for the StackedDistribution container.
1467
+ * Contains the standard style categories: container layout, background colors,
1468
+ * border appearance, dimensions, flex child positioning, and spacing.
1469
+ */
509
1470
  export interface StackedDistributionStyles {
1471
+ /** Container layout styles (e.g. flex direction, alignment). */
510
1472
  container?: null | ContainerStylingProperties;
1473
+ /** Background color and gradient styles. */
511
1474
  background?: null | BackgroundStylingProperties;
1475
+ /** Border width, color, and radius styles. */
512
1476
  border?: null | BorderStylingProperties;
1477
+ /** Width and height dimension styles. */
513
1478
  dimension?: null | DimensionStylingProperties;
1479
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
514
1480
  flexChild?: null | FlexChildStylingProperties;
1481
+ /** Padding and margin spacing styles. */
515
1482
  spacing?: null | SpacingStylingProperties;
516
1483
  }
1484
+ /**
1485
+ * Styling elements for the StackedDistribution container.
1486
+ * The `own` array contains stateless styling blocks applied to the stacked container itself.
1487
+ */
517
1488
  export interface StackedDistributionElements {
1489
+ /** Array of stateless styling blocks for the stacked container. */
518
1490
  own: StatelessStylingBlock<StackedDistributionStyles>[];
519
1491
  }
1492
+ /** Transition styles for animating StackedDistribution style changes. */
520
1493
  export interface StackedDistributionTransitions {
1494
+ /** Transition properties for the stacked container's own styles. */
521
1495
  own?: null | StackedDistributionStyles;
522
1496
  }
1497
+ /**
1498
+ * Presents multiple offers stacked vertically, all visible at once.
1499
+ * Used EXCLUSIVELY in the Outer Layout. This is the container into which offers (Layout Variants) are rendered.
1500
+ *
1501
+ * Use this when all offers should be visible simultaneously.
1502
+ * Do NOT use this for sequential one-at-a-time presentation; use OneByOneDistribution instead.
1503
+ */
523
1504
  export interface StackedDistributionModel {
1505
+ /**
1506
+ * Visual styles for the stacked container.
1507
+ * Uses the LayoutStyle wrapper with conditional style transitions.
1508
+ */
524
1509
  styles?: null | LayoutStyle<StackedDistributionElements, StackedDistributionTransitions>;
525
1510
  }
526
- export type BooleanWhenCondition = "is-true" | "is-false";
1511
+ /**
1512
+ * Condition operators for boolean values. Use these to test boolean flags.
1513
+ * Serialized as kebab-case strings: "is-true", "is-false".
1514
+ */
1515
+ export type BooleanWhenCondition =
1516
+ /** True when the value is true. */
1517
+ "is-true"
1518
+ /** True when the value is false. */
1519
+ | "is-false";
1520
+ /**
1521
+ * A predicate with a hardcoded boolean value. Useful for enabling or disabling
1522
+ * sections during development or for static feature flags.
1523
+ */
527
1524
  export interface StaticBooleanPredicate {
1525
+ /** The boolean condition. Use "is-true" or "is-false". */
528
1526
  condition: BooleanWhenCondition;
1527
+ /** The static boolean value to evaluate against the condition. */
529
1528
  value: boolean;
530
1529
  }
1530
+ /** Visual styles for the StaticIcon node. MUST include text styles with fontFamily set to 'rokt-icons' to render correctly. */
531
1531
  export interface StaticIconStyles {
1532
+ /** Typography properties. MUST include fontFamily set to 'rokt-icons' for the icon to render correctly. */
532
1533
  text?: null | TextStylingProperties;
1534
+ /** Width, height and rotation properties. */
533
1535
  dimension?: null | DimensionStylingProperties;
1536
+ /** Properties controlling behaviour as a flex child. */
534
1537
  flexChild?: null | FlexChildStylingProperties;
1538
+ /** Padding, margin and offset properties. */
535
1539
  spacing?: null | SpacingStylingProperties;
1540
+ /** Background color and image properties. */
536
1541
  background?: null | BackgroundStylingProperties;
1542
+ /** Border radius, color, width and style. */
537
1543
  border?: null | BorderStylingProperties;
538
1544
  }
1545
+ /** Style elements for the StaticIcon node. */
539
1546
  export interface StaticIconElements {
1547
+ /** Style blocks for the node's primary element. Array represents breakpoint-specific styles. */
540
1548
  own: BasicStateStylingBlock<StaticIconStyles>[];
541
1549
  }
1550
+ /** Transition definitions for the StaticIcon node. */
542
1551
  export interface StaticIconTransitions {
1552
+ /** Transition properties for the primary element. */
543
1553
  own?: null | StaticIconStyles;
544
1554
  }
1555
+ /** Renders an SVG icon from the Rokt icon font. The icon is selected by name from the available icon set. */
545
1556
  export interface StaticIconModel {
1557
+ /** Visual styles for the icon. MUST include text styles with fontFamily set to 'rokt-icons' to render correctly. */
546
1558
  styles?: null | LayoutStyle<StaticIconElements, StaticIconTransitions>;
1559
+ /** 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. */
547
1560
  name: string;
1561
+ /** Accessibility description of the icon for screen readers. */
548
1562
  description?: null | string;
549
1563
  isImportantForAccessibility?: null | boolean;
550
1564
  }
1565
+ /** Visual styles for the StaticImage node. */
551
1566
  export interface StaticImageStyles {
1567
+ /** Background color and image properties. */
552
1568
  background?: null | BackgroundStylingProperties;
1569
+ /** Border radius, color, width and style. */
553
1570
  border?: null | BorderStylingProperties;
1571
+ /** Width, height and rotation properties. */
554
1572
  dimension?: null | DimensionStylingProperties;
1573
+ /** Properties controlling behaviour as a flex child. */
555
1574
  flexChild?: null | FlexChildStylingProperties;
1575
+ /** Padding, margin and offset properties. */
556
1576
  spacing?: null | SpacingStylingProperties;
557
1577
  }
1578
+ /** Style elements for the StaticImage node. */
558
1579
  export interface StaticImageElements {
1580
+ /** Style blocks for the node's primary element. Array represents breakpoint-specific styles. */
559
1581
  own: BasicStateStylingBlock<StaticImageStyles>[];
560
1582
  }
1583
+ /** Transition definitions for the StaticImage node. */
561
1584
  export interface StaticImageTransitions {
1585
+ /** Transition properties for the primary element. */
562
1586
  own?: null | StaticImageStyles;
563
1587
  }
1588
+ /** URL configuration for a static image with themed light/dark mode support. */
564
1589
  export interface StaticImageUrl {
1590
+ /** The image URL for light mode. MUST be a valid URL. */
565
1591
  light: string;
1592
+ /** The image URL for dark mode. If not provided, the light URL is used for both modes. */
566
1593
  dark?: null | string;
567
1594
  }
1595
+ /** Renders a static image from a provided URL. Use for images with known URLs (logos, icons, decorative images). */
568
1596
  export interface StaticImageModel {
1597
+ /** Visual styles for the image element. */
569
1598
  styles?: null | LayoutStyle<StaticImageElements, StaticImageTransitions>;
1599
+ /** Alt text for accessibility. Describes the image for screen readers. */
570
1600
  alt?: null | string;
1601
+ /** Title text shown on hover. */
571
1602
  title?: null | string;
1603
+ /** The image URL with themed light/dark mode support. */
572
1604
  url: StaticImageUrl;
573
1605
  isImportantForAccessibility?: null | boolean;
574
1606
  }
1607
+ /**
1608
+ * Visual style properties for the StaticLink.
1609
+ * Contains the standard style categories: container layout, background colors,
1610
+ * border appearance, dimensions, flex child positioning, and spacing.
1611
+ */
575
1612
  export interface StaticLinkStyles {
1613
+ /** Container layout styles (e.g. flex direction, alignment). */
576
1614
  container?: null | ContainerStylingProperties;
1615
+ /** Background color and gradient styles. */
577
1616
  background?: null | BackgroundStylingProperties;
1617
+ /** Border width, color, and radius styles. */
578
1618
  border?: null | BorderStylingProperties;
1619
+ /** Width and height dimension styles. */
579
1620
  dimension?: null | DimensionStylingProperties;
1621
+ /** Flex child sizing and alignment styles (grow, shrink, align-self). */
580
1622
  flexChild?: null | FlexChildStylingProperties;
1623
+ /** Padding and margin spacing styles. */
581
1624
  spacing?: null | SpacingStylingProperties;
582
1625
  }
1626
+ /**
1627
+ * Styling elements for the StaticLink.
1628
+ * The `own` array contains state-dependent styling blocks (e.g. default, pressed)
1629
+ * applied to the link itself.
1630
+ */
583
1631
  export interface StaticLinkElements {
1632
+ /**
1633
+ * Array of state-dependent styling blocks for the link.
1634
+ * Each block targets a specific interaction state (default, pressed, etc.).
1635
+ */
584
1636
  own: BasicStateStylingBlock<StaticLinkStyles>[];
585
1637
  }
1638
+ /**
1639
+ * Transition styles for animating StaticLink style changes.
1640
+ * Defines which style properties should animate when the link's conditional styles change.
1641
+ */
586
1642
  export interface StaticLinkTransitions {
1643
+ /** Transition properties for the link's own styles. */
587
1644
  own?: null | StaticLinkStyles;
588
1645
  }
1646
+ /**
1647
+ * A clickable link that wraps its children. Opens the specified URL when clicked.
1648
+ *
1649
+ * Use this node for navigation to external URLs. Do NOT use CreativeResponse for link navigation;
1650
+ * CreativeResponse is for offer accept/decline actions only.
1651
+ * The `src` field MUST be a valid URL string.
1652
+ */
589
1653
  export interface StaticLinkModel<Children> {
1654
+ /**
1655
+ * The destination URL to open when the link is clicked.
1656
+ * MUST be a valid URL string (e.g. "https://example.com").
1657
+ */
590
1658
  src: string;
1659
+ /** Controls how the link URL is opened (e.g. in-app browser, external browser). */
591
1660
  open: LinkOpenTarget;
1661
+ /** Visual styles for the link. Uses the LayoutStyle wrapper with conditional style transitions. */
592
1662
  styles?: null | LayoutStyle<StaticLinkElements, StaticLinkTransitions>;
1663
+ /**
1664
+ * Child nodes that form the clickable link content.
1665
+ * MUST contain at least one child for the link to have visible, tappable content.
1666
+ */
593
1667
  children: Children[];
594
1668
  }
595
- export type InTransition = {
1669
+ /**
1670
+ * A transition that applies only when an element enters (becomes visible).
1671
+ * MUST be an object with a "type" field and a "settings" field.
1672
+ * Currently only "FadeIn" is supported.
1673
+ */
1674
+ export type InTransition =
1675
+ /**
1676
+ * A fade-in transition. The element gradually becomes visible over the
1677
+ * specified duration.
1678
+ */
1679
+ {
596
1680
  type: "FadeIn";
597
1681
  settings: FadeInTransitionSettings;
598
1682
  };
599
- export type OutTransition = {
1683
+ /**
1684
+ * A transition that applies only when an element exits (becomes hidden).
1685
+ * MUST be an object with a "type" field and a "settings" field.
1686
+ * Currently only "FadeOut" is supported.
1687
+ */
1688
+ export type OutTransition =
1689
+ /**
1690
+ * A fade-out transition. The element gradually becomes invisible over
1691
+ * the specified duration.
1692
+ */
1693
+ {
600
1694
  type: "FadeOut";
601
1695
  settings: FadeOutTransitionSettings;
602
1696
  };
1697
+ /**
1698
+ * Transition configuration for when visibility changes.
1699
+ * Defines enter and exit animations for the When node's children.
1700
+ */
603
1701
  export interface WhenTransition {
604
1702
  in?: null | InTransition[];
605
1703
  out?: null | OutTransition[];
606
1704
  }
1705
+ /**
1706
+ * Conditional rendering node. Shows or hides its children based on predicate conditions.
1707
+ * All predicates MUST evaluate to true for children to be shown (AND logic).
1708
+ *
1709
+ * Use this node to conditionally display content based on custom state, offer count, or other
1710
+ * predicate conditions. Do NOT nest When nodes unnecessarily; combine predicates in a single
1711
+ * When node instead.
1712
+ */
607
1713
  export interface WhenModel<Children> {
1714
+ /**
1715
+ * Array of conditions that MUST ALL be true for children to render.
1716
+ * Uses AND logic: if any predicate is false, children are hidden.
1717
+ * MUST contain at least one predicate.
1718
+ */
608
1719
  predicates: WhenPredicate[];
1720
+ /** Child nodes to conditionally show or hide based on the predicates. */
609
1721
  children: Children[];
1722
+ /**
1723
+ * Optional transition animation configuration for when visibility changes.
1724
+ * Controls how children animate in and out when predicates change.
1725
+ */
610
1726
  transition?: null | WhenTransition;
611
1727
  }
1728
+ /** Styling properties for ZStack container layout. ZStack layers children on top of each other. */
612
1729
  export interface ZStackContainerStylingProperties {
1730
+ /** Controls horizontal positioning of children within the ZStack. */
613
1731
  justifyContent?: null | FlexPosition;
1732
+ /** Controls vertical positioning of children within the ZStack. */
614
1733
  alignItems?: null | FlexPosition;
1734
+ /** Applies a box shadow effect around the container. */
615
1735
  shadow?: null | Shadow;
1736
+ /** Controls whether content overflowing the container bounds is visible or hidden. */
616
1737
  overflow?: null | Overflow;
1738
+ /** Applies a Gaussian blur effect. Value is the blur radius in platform units. */
617
1739
  blur?: null | number;
618
1740
  }
1741
+ /**
1742
+ * Available style categories for the ZStack element. Each optional field enables a specific
1743
+ * category of visual styling. Omit a field to leave that category unstyled.
1744
+ */
619
1745
  export interface ZStackStyle {
1746
+ /**
1747
+ * Layout properties for the ZStack container (alignment of stacked children).
1748
+ * MUST be used to control how children are positioned within the stack.
1749
+ */
620
1750
  container?: null | ZStackContainerStylingProperties;
1751
+ /**
1752
+ * Background color and image properties. Use to set a solid color, gradient, or image
1753
+ * behind the stacked content.
1754
+ */
621
1755
  background?: null | BackgroundStylingProperties;
1756
+ /**
1757
+ * Border radius, color, width and style properties. Use to add visible borders or
1758
+ * rounded corners to the ZStack.
1759
+ */
622
1760
  border?: null | BorderStylingProperties;
1761
+ /**
1762
+ * Width, height and rotation properties. Use to explicitly size the ZStack or apply
1763
+ * rotation transforms. Do NOT set width/height if the ZStack should size to its content.
1764
+ */
623
1765
  dimension?: null | DimensionStylingProperties;
1766
+ /**
1767
+ * Properties controlling this element's behaviour as a child of a flex container.
1768
+ * Use to set flex-grow, flex-shrink, flex-basis, and align-self.
1769
+ */
624
1770
  flexChild?: null | FlexChildStylingProperties;
1771
+ /** Padding, margin and offset properties. Use to add spacing inside or outside the ZStack. */
625
1772
  spacing?: null | SpacingStylingProperties;
626
1773
  }
1774
+ /**
1775
+ * Styleable elements of the ZStack node. The ZStack has a single styleable element: its own
1776
+ * container.
1777
+ */
627
1778
  export interface ZStackElements {
1779
+ /**
1780
+ * Style blocks for the ZStack container itself. The array represents breakpoint-specific
1781
+ * styles: first item is the default (no breakpoint), subsequent items correspond to
1782
+ * breakpoints in ascending order. MUST contain at least one item for the default style.
1783
+ */
628
1784
  own: BasicStateStylingBlock<ZStackStyle>[];
629
1785
  }
1786
+ /** Transition styles for the ZStack node. Use to animate style changes smoothly. */
630
1787
  export interface ZStackTransitions {
1788
+ /**
1789
+ * Transition properties for the ZStack container. Specifies which style properties
1790
+ * should animate and their duration/easing when values change.
1791
+ */
631
1792
  own?: null | ZStackStyle;
632
1793
  }
1794
+ /**
1795
+ * A layered container that stacks children on top of each other along the z-axis. Later
1796
+ * children render on top of earlier ones. Use for overlapping content such as badges on
1797
+ * images, text overlays, or layered decorative elements. Do NOT use ZStack for simple
1798
+ * sequential layouts; use Row or Column instead.
1799
+ */
633
1800
  export interface ZStackModel<Children> {
1801
+ /**
1802
+ * Visual styles for this ZStack. See styling documentation for the structure. Omit to use
1803
+ * default (unstyled) rendering.
1804
+ */
634
1805
  styles?: null | LayoutStyle<ZStackElements, ZStackTransitions>;
1806
+ /**
1807
+ * Child nodes stacked on top of each other within this ZStack. MUST contain at least one
1808
+ * child. Children are rendered in source order, with later children appearing on top of
1809
+ * earlier ones.
1810
+ */
635
1811
  children: Children[];
636
1812
  }
637
1813
  export type CloseButtonChildren = {
@@ -681,9 +1857,36 @@ export type CreativeResponseChildren = {
681
1857
  type: "StaticIcon";
682
1858
  node: StaticIconModel;
683
1859
  };
684
- export type DimensionHeightFitValue = "wrap-content" | "fit-height";
685
- export type DimensionWidthFitValue = "wrap-content" | "fit-width";
686
- export type LayoutDisplayPreset = "FULLSCREEN" | "EMBEDDED" | "ATTACHED";
1860
+ /**
1861
+ * Fit behaviour options for height.
1862
+ * Used as the 'value' inside a {"type": "fit", "value": ...} height specification.
1863
+ */
1864
+ export type DimensionHeightFitValue =
1865
+ /** Shrinks to fit the content height. */
1866
+ "wrap-content"
1867
+ /** Expands to fill the available height. */
1868
+ | "fit-height";
1869
+ /**
1870
+ * Fit behaviour options for width.
1871
+ * Used as the 'value' inside a {"type": "fit", "value": ...} width specification.
1872
+ */
1873
+ export type DimensionWidthFitValue =
1874
+ /** Shrinks to fit the content width. */
1875
+ "wrap-content"
1876
+ /** Expands to fill the available width. */
1877
+ | "fit-width";
1878
+ /** Controls how the layout is displayed on the page. */
1879
+ export type LayoutDisplayPreset =
1880
+ /** Layout covers the full viewport. */
1881
+ "FULLSCREEN"
1882
+ /** Layout is embedded inline within the page content. */
1883
+ | "EMBEDDED"
1884
+ /** Layout is attached/anchored to a specific position. */
1885
+ | "ATTACHED";
1886
+ /**
1887
+ * All node types supported in the web platform schema. This is the union type used by SDKs.
1888
+ * Layouts are authored using OuterLayoutSchemaModel or LayoutVariantSchemaModel instead.
1889
+ */
687
1890
  export type LayoutSchemaModel = {
688
1891
  type: "Row";
689
1892
  node: RowModel<LayoutSchemaModel>;
@@ -745,6 +1948,11 @@ export type LayoutSchemaModel = {
745
1948
  type: "StaticIcon";
746
1949
  node: StaticIconModel;
747
1950
  };
1951
+ /**
1952
+ * Recursive child node types allowed within layout variant containers. Includes all layout
1953
+ * variant nodes such as layout, text, images, data-bound content, interactive triggers,
1954
+ * catalog components, and escape hatches.
1955
+ */
748
1956
  export type LayoutVariantChildren = {
749
1957
  type: "Row";
750
1958
  node: RowModel<LayoutVariantChildren>;
@@ -782,6 +1990,10 @@ export type LayoutVariantChildren = {
782
1990
  type: "StaticIcon";
783
1991
  node: StaticIconModel;
784
1992
  };
1993
+ /**
1994
+ * Node types valid for use in layout variants (offer formats). Layout variants contain the
1995
+ * offer-specific creative content including images, text, response buttons, and catalog components.
1996
+ */
785
1997
  export type LayoutVariantSchemaModel = {
786
1998
  type: "Row";
787
1999
  node: RowModel<LayoutVariantChildren>;
@@ -819,6 +2031,10 @@ export type LayoutVariantSchemaModel = {
819
2031
  type: "StaticIcon";
820
2032
  node: StaticIconModel;
821
2033
  };
2034
+ /**
2035
+ * Recursive child node types allowed within outer layout containers. Includes structural,
2036
+ * distribution, navigation, and presentational nodes scoped to outer layout predicates.
2037
+ */
822
2038
  export type OuterLayoutChildren = {
823
2039
  type: "Row";
824
2040
  node: RowModel<OuterLayoutChildren>;
@@ -868,6 +2084,11 @@ export type OuterLayoutChildren = {
868
2084
  type: "StaticIcon";
869
2085
  node: StaticIconModel;
870
2086
  };
2087
+ /**
2088
+ * Node types valid for use in outer layouts. Outer layouts define the frame and offer
2089
+ * distribution but do not contain offer-specific content. They include structural containers,
2090
+ * distribution nodes, navigation controls, and close buttons.
2091
+ */
871
2092
  export type OuterLayoutSchemaModel = {
872
2093
  type: "Row";
873
2094
  node: RowModel<OuterLayoutChildren>;