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