@rokt/dcui-orchestrator 0.2.1-rc.83 → 0.2.1-rc.84
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/{libraries/orchestrator → extensions/address-form}/src/sagas/cart-service/sagas.d.ts +5 -12
- 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/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 -36
- package/dist/index.js +100 -39
- 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-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/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 +7 -12
- 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 +15 -1
- package/dist/libraries/domain/src/behaviors/index.d.ts +5 -0
- package/dist/libraries/domain/src/behaviors/layout-events.d.ts +17 -0
- package/dist/libraries/domain/src/behaviors/offer-engagement.d.ts +2 -1
- package/dist/libraries/domain/src/behaviors/report-error.d.ts +26 -0
- package/dist/libraries/domain/src/behaviors/send-partner.d.ts +36 -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 +2 -0
- package/dist/libraries/domain/src/models/layout/index.d.ts +1 -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-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/signals.d.ts +14 -6
- 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 +1 -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 +4 -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/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/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/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 +9 -0
- package/dist/modules/add-to-cart/src/selectors/catalogItems/selectors.d.ts +2 -0
- package/dist/modules/add-to-cart/src/selectors/index.d.ts +1 -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 +47 -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 +1 -1
- 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/checkout-state-button-trigger/checkout-state-button-trigger.d.ts +2 -0
- package/dist/modules/instant-purchase/src/components/{catalog-image-gallery → escapehatch-catalog-image-gallery}/catalog-image-gallery.d.ts +6 -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 +68 -1
- 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 +15 -2
- package/dist/modules/instant-purchase/src/reducers/instant-purchase/index.d.ts +2 -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 +14 -1
- package/dist/modules/instant-purchase/src/sagas/instant-purchase/sagas.d.ts +20 -81
- 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 +9 -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 +9 -0
- 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/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
- /package/dist/modules/instant-purchase/src/components/{catalog-drop-down → escapehatch-catalog-drop-down}/catalog-drop-down.d.ts +0 -0
- /package/dist/modules/instant-purchase/src/components/{catalog-image-gallery → escapehatch-catalog-image-gallery}/constants.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,228 +488,660 @@ 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
|
+
/** Defines a style transition that is applied when the specified predicates evaluate to true. */
|
|
268
787
|
export interface ConditionalStyleTransition<Styles> {
|
|
788
|
+
/** The list of conditions that must all be true for this transition to apply. */
|
|
269
789
|
predicates: WhenPredicate[];
|
|
790
|
+
/** The transition duration in milliseconds. */
|
|
270
791
|
duration: number;
|
|
792
|
+
/** The style properties to apply when all predicates are met. */
|
|
271
793
|
value: Styles;
|
|
272
794
|
}
|
|
273
|
-
|
|
795
|
+
/**
|
|
796
|
+
* Condition operators for checking whether a value exists. Use these to
|
|
797
|
+
* conditionally render content based on whether data is present.
|
|
798
|
+
* Serialized as kebab-case strings: "exists", "not-exists".
|
|
799
|
+
*/
|
|
800
|
+
export type ExistenceWhenCondition =
|
|
801
|
+
/** True when the value is present and non-empty. */
|
|
802
|
+
"exists"
|
|
803
|
+
/** True when the value is absent or empty. */
|
|
804
|
+
| "not-exists";
|
|
805
|
+
/**
|
|
806
|
+
* Tests whether a creative data attribute exists. Use to conditionally show
|
|
807
|
+
* content only when specific creative data is available. Do NOT use this for
|
|
808
|
+
* non-creative data checks.
|
|
809
|
+
*/
|
|
274
810
|
export interface CreativeCopyPredicate {
|
|
811
|
+
/** Whether to check for existence or non-existence of the creative attribute. */
|
|
275
812
|
condition: ExistenceWhenCondition;
|
|
813
|
+
/**
|
|
814
|
+
* The dot-notation path to the creative attribute, e.g.
|
|
815
|
+
* "creative.socialProof.number". MUST use dot notation to reference
|
|
816
|
+
* nested creative data fields.
|
|
817
|
+
*/
|
|
276
818
|
value: string;
|
|
277
819
|
}
|
|
820
|
+
/**
|
|
821
|
+
* Visual style properties for the CreativeResponse button.
|
|
822
|
+
* Contains the standard style categories: container layout, background colors,
|
|
823
|
+
* border appearance, dimensions, flex child positioning, and spacing.
|
|
824
|
+
*/
|
|
278
825
|
export interface CreativeResponseStyles {
|
|
826
|
+
/** Container layout styles (e.g. flex direction, alignment). */
|
|
279
827
|
container?: null | ContainerStylingProperties;
|
|
828
|
+
/** Background color and gradient styles. */
|
|
280
829
|
background?: null | BackgroundStylingProperties;
|
|
830
|
+
/** Border width, color, and radius styles. */
|
|
281
831
|
border?: null | BorderStylingProperties;
|
|
832
|
+
/** Width and height dimension styles. */
|
|
282
833
|
dimension?: null | DimensionStylingProperties;
|
|
834
|
+
/** Flex child sizing and alignment styles (grow, shrink, align-self). */
|
|
283
835
|
flexChild?: null | FlexChildStylingProperties;
|
|
836
|
+
/** Padding and margin spacing styles. */
|
|
284
837
|
spacing?: null | SpacingStylingProperties;
|
|
285
838
|
}
|
|
839
|
+
/**
|
|
840
|
+
* Styling elements for the CreativeResponse button.
|
|
841
|
+
* The `own` array contains state-dependent styling blocks (e.g. default, pressed, disabled)
|
|
842
|
+
* applied to the button itself.
|
|
843
|
+
*/
|
|
286
844
|
export interface CreativeResponseElements {
|
|
845
|
+
/**
|
|
846
|
+
* Array of state-dependent styling blocks for the button.
|
|
847
|
+
* Each block targets a specific interaction state (default, pressed, disabled, etc.).
|
|
848
|
+
*/
|
|
287
849
|
own: BasicStateStylingBlock<CreativeResponseStyles>[];
|
|
288
850
|
}
|
|
851
|
+
/**
|
|
852
|
+
* Transition styles for animating CreativeResponse style changes.
|
|
853
|
+
* Defines which style properties should animate when the button's conditional styles change.
|
|
854
|
+
*/
|
|
289
855
|
export interface CreativeResponseTransitions {
|
|
856
|
+
/** Transition properties for the button's own styles. */
|
|
290
857
|
own?: null | CreativeResponseStyles;
|
|
291
858
|
}
|
|
292
|
-
|
|
859
|
+
/**
|
|
860
|
+
* Controls how links are opened when clicked. MUST be one of the valid
|
|
861
|
+
* kebab-case string values. Determines the navigation behavior when a
|
|
862
|
+
* user activates a link action.
|
|
863
|
+
*/
|
|
864
|
+
export type LinkOpenTarget =
|
|
865
|
+
/**
|
|
866
|
+
* Opens the link within the current context (in-app webview or same
|
|
867
|
+
* window). Use for links that should keep the user in the application.
|
|
868
|
+
*/
|
|
869
|
+
"internally"
|
|
870
|
+
/**
|
|
871
|
+
* Opens the link in the system browser. Use for external URLs that
|
|
872
|
+
* should leave the application context.
|
|
873
|
+
*/
|
|
874
|
+
| "externally";
|
|
875
|
+
/**
|
|
876
|
+
* A button that triggers a creative response (positive or negative).
|
|
877
|
+
* This is the primary call-to-action node for offer interactions.
|
|
878
|
+
* Children inside this node become the button content.
|
|
879
|
+
*
|
|
880
|
+
* MUST have a `responseKey` of either `"positive"` or `"negative"`.
|
|
881
|
+
* Use `"positive"` for accept/CTA buttons and `"negative"` for decline/dismiss buttons.
|
|
882
|
+
* Do NOT use this node for non-response actions like navigation; use StaticLink or ButtonStateTrigger instead.
|
|
883
|
+
*/
|
|
293
884
|
export interface CreativeResponseModel<Children> {
|
|
885
|
+
/**
|
|
886
|
+
* The response type. Use `"positive"` for accept/CTA buttons, `"negative"` for decline/dismiss buttons.
|
|
887
|
+
* Do NOT use arbitrary strings; only `"positive"` and `"negative"` are valid.
|
|
888
|
+
*/
|
|
294
889
|
responseKey: string;
|
|
890
|
+
/** Visual styles for the button. Uses the LayoutStyle wrapper with conditional style transitions. */
|
|
295
891
|
styles?: null | LayoutStyle<CreativeResponseElements, CreativeResponseTransitions>;
|
|
892
|
+
/**
|
|
893
|
+
* Controls how the response URL is opened when clicked.
|
|
894
|
+
* If omitted, the default link opening behaviour is used.
|
|
895
|
+
*/
|
|
296
896
|
openLinks?: null | LinkOpenTarget;
|
|
897
|
+
/**
|
|
898
|
+
* Child nodes that form the button's visible content.
|
|
899
|
+
* Typically contains a BasicText node with the CTA label.
|
|
900
|
+
* MUST contain at least one child to display button content.
|
|
901
|
+
*/
|
|
297
902
|
children: Children[];
|
|
298
903
|
}
|
|
904
|
+
/**
|
|
905
|
+
* Tests a custom state value. Custom states are set by state trigger nodes
|
|
906
|
+
* such as ButtonStateTrigger, ToggleButtonStateTrigger, and similar components.
|
|
907
|
+
* The value is an integer that represents the current state.
|
|
908
|
+
*/
|
|
299
909
|
export interface CustomStatePredicate {
|
|
910
|
+
/**
|
|
911
|
+
* The custom state key to check. MUST match the key used in the
|
|
912
|
+
* corresponding state trigger node.
|
|
913
|
+
*/
|
|
300
914
|
key: string;
|
|
915
|
+
/** The comparison operator. */
|
|
301
916
|
condition: OrderableWhenCondition;
|
|
917
|
+
/** The integer value to compare the custom state against. */
|
|
302
918
|
value: number;
|
|
303
919
|
}
|
|
304
|
-
|
|
920
|
+
/**
|
|
921
|
+
* Condition operators for equality comparisons. Use these when you only need
|
|
922
|
+
* to test if two values are equal or not equal.
|
|
923
|
+
* Serialized as kebab-case strings: "is", "is-not".
|
|
924
|
+
*/
|
|
925
|
+
export type EqualityWhenCondition =
|
|
926
|
+
/** True when the value equals the specified value. */
|
|
927
|
+
"is"
|
|
928
|
+
/** True when the value does not equal the specified value. */
|
|
929
|
+
| "is-not";
|
|
930
|
+
/**
|
|
931
|
+
* Tests whether dark mode is active. Use to provide different styling or
|
|
932
|
+
* content for light and dark modes.
|
|
933
|
+
*/
|
|
305
934
|
export interface DarkModePredicate {
|
|
935
|
+
/** Use "is" to check if dark mode matches the value, "is-not" for the inverse. */
|
|
306
936
|
condition: EqualityWhenCondition;
|
|
937
|
+
/**
|
|
938
|
+
* The boolean value to compare against. Set to true to test for dark mode,
|
|
939
|
+
* false to test for light mode.
|
|
940
|
+
*/
|
|
307
941
|
value: boolean;
|
|
308
942
|
}
|
|
943
|
+
/** Visual styles for the DataIcon node. */
|
|
309
944
|
export interface DataIconStyles {
|
|
945
|
+
/** Typography properties. */
|
|
310
946
|
text?: null | TextStylingProperties;
|
|
947
|
+
/** Width, height and rotation properties. */
|
|
311
948
|
dimension?: null | DimensionStylingProperties;
|
|
949
|
+
/** Properties controlling behaviour as a flex child. */
|
|
312
950
|
flexChild?: null | FlexChildStylingProperties;
|
|
951
|
+
/** Padding, margin and offset properties. */
|
|
313
952
|
spacing?: null | SpacingStylingProperties;
|
|
953
|
+
/** Background color and image properties. */
|
|
314
954
|
background?: null | BackgroundStylingProperties;
|
|
955
|
+
/** Border radius, color, width and style. */
|
|
315
956
|
border?: null | BorderStylingProperties;
|
|
316
957
|
}
|
|
958
|
+
/** Style elements for the DataIcon node. */
|
|
317
959
|
export interface DataIconElements {
|
|
960
|
+
/** Style blocks for the node's primary element. Array represents breakpoint-specific styles. */
|
|
318
961
|
own: BasicStateStylingBlock<DataIconStyles>[];
|
|
319
962
|
}
|
|
963
|
+
/** Transition definitions for the DataIcon node. */
|
|
320
964
|
export interface DataIconTransitions {
|
|
965
|
+
/** Transition properties for the primary element. */
|
|
321
966
|
own?: null | DataIconStyles;
|
|
322
967
|
}
|
|
968
|
+
/** Renders an icon from creative data. The icon is resolved from the creative object using the iconKey. */
|
|
323
969
|
export interface DataIconModel {
|
|
970
|
+
/** Visual styles for the icon. */
|
|
324
971
|
styles?: null | LayoutStyle<DataIconElements, DataIconTransitions>;
|
|
972
|
+
/** The key identifying which icon from the creative data to display. */
|
|
325
973
|
iconKey: string;
|
|
326
974
|
isImportantForAccessibility?: null | boolean;
|
|
327
975
|
}
|
|
976
|
+
/** Visual styles for the DataImage node. */
|
|
328
977
|
export interface DataImageStyles {
|
|
978
|
+
/** Background color and image properties. */
|
|
329
979
|
background?: null | BackgroundStylingProperties;
|
|
980
|
+
/** Border radius, color, width and style. */
|
|
330
981
|
border?: null | BorderStylingProperties;
|
|
982
|
+
/** Width, height and rotation properties. */
|
|
331
983
|
dimension?: null | DimensionStylingProperties;
|
|
984
|
+
/** Properties controlling behaviour as a flex child. */
|
|
332
985
|
flexChild?: null | FlexChildStylingProperties;
|
|
986
|
+
/** Padding, margin and offset properties. */
|
|
333
987
|
spacing?: null | SpacingStylingProperties;
|
|
334
988
|
}
|
|
989
|
+
/** Style elements for the DataImage node. */
|
|
335
990
|
export interface DataImageElements {
|
|
991
|
+
/** Style blocks for the node's primary element. Array represents breakpoint-specific styles. */
|
|
336
992
|
own: BasicStateStylingBlock<DataImageStyles>[];
|
|
337
993
|
}
|
|
994
|
+
/** Transition definitions for the DataImage node. */
|
|
338
995
|
export interface DataImageTransitions {
|
|
996
|
+
/** Transition properties for the primary element. */
|
|
339
997
|
own?: null | DataImageStyles;
|
|
340
998
|
}
|
|
999
|
+
/** Renders an image from creative data. The image URL is resolved from the creative object using the imageKey. Use for offer-specific images. */
|
|
341
1000
|
export interface DataImageModel {
|
|
1001
|
+
/** Visual styles for the image element. */
|
|
342
1002
|
styles?: null | LayoutStyle<DataImageElements, DataImageTransitions>;
|
|
1003
|
+
/** The key identifying which image from the creative data to display. */
|
|
343
1004
|
imageKey: string;
|
|
344
1005
|
isImportantForAccessibility?: null | boolean;
|
|
345
1006
|
}
|
|
1007
|
+
/** Settings for a bidirectional fade-in/fade-out transition. */
|
|
346
1008
|
export interface FadeInOutTransitionSettings {
|
|
1009
|
+
/**
|
|
1010
|
+
* The transition duration in milliseconds. MUST be a positive integer.
|
|
1011
|
+
* Common values: 200 for fast, 400 for medium, 1000 for slow.
|
|
1012
|
+
*/
|
|
347
1013
|
duration: number;
|
|
348
1014
|
}
|
|
1015
|
+
/** Settings for a fade-in (enter) transition. */
|
|
349
1016
|
export interface FadeInTransitionSettings {
|
|
1017
|
+
/**
|
|
1018
|
+
* The transition duration in milliseconds. MUST be a positive integer.
|
|
1019
|
+
* Common values: 200 for fast, 400 for medium, 1000 for slow.
|
|
1020
|
+
*/
|
|
350
1021
|
duration: number;
|
|
351
1022
|
}
|
|
1023
|
+
/** Settings for a fade-out (exit) transition. */
|
|
352
1024
|
export interface FadeOutTransitionSettings {
|
|
1025
|
+
/**
|
|
1026
|
+
* The transition duration in milliseconds. MUST be a positive integer.
|
|
1027
|
+
* Common values: 200 for fast, 400 for medium, 1000 for slow.
|
|
1028
|
+
*/
|
|
353
1029
|
duration: number;
|
|
354
1030
|
}
|
|
1031
|
+
/**
|
|
1032
|
+
* Available style categories for the FlowRow element. Each optional field enables a specific
|
|
1033
|
+
* category of visual styling. Omit a field to leave that category unstyled.
|
|
1034
|
+
*/
|
|
355
1035
|
export interface FlowRowStyle {
|
|
1036
|
+
/**
|
|
1037
|
+
* Layout properties for the flex container (justification, alignment, gap, overflow).
|
|
1038
|
+
* MUST be used to control how children are arranged and wrapped within the flow row.
|
|
1039
|
+
*/
|
|
356
1040
|
container?: null | ContainerStylingProperties;
|
|
1041
|
+
/**
|
|
1042
|
+
* Background color and image properties. Use to set a solid color, gradient, or image
|
|
1043
|
+
* behind the flow row content.
|
|
1044
|
+
*/
|
|
357
1045
|
background?: null | BackgroundStylingProperties;
|
|
1046
|
+
/**
|
|
1047
|
+
* Border radius, color, width and style properties. Use to add visible borders or
|
|
1048
|
+
* rounded corners to the flow row.
|
|
1049
|
+
*/
|
|
358
1050
|
border?: null | BorderStylingProperties;
|
|
1051
|
+
/**
|
|
1052
|
+
* Width, height and rotation properties. Use to explicitly size the flow row or apply
|
|
1053
|
+
* rotation transforms. Do NOT set width/height if the flow row should size to its content.
|
|
1054
|
+
*/
|
|
359
1055
|
dimension?: null | DimensionStylingProperties;
|
|
1056
|
+
/**
|
|
1057
|
+
* Properties controlling this element's behaviour as a child of a flex container.
|
|
1058
|
+
* Use to set flex-grow, flex-shrink, flex-basis, and align-self.
|
|
1059
|
+
*/
|
|
360
1060
|
flexChild?: null | FlexChildStylingProperties;
|
|
1061
|
+
/** Padding, margin and offset properties. Use to add spacing inside or outside the flow row. */
|
|
361
1062
|
spacing?: null | SpacingStylingProperties;
|
|
362
1063
|
}
|
|
1064
|
+
/**
|
|
1065
|
+
* Styleable elements of the FlowRow node. The FlowRow has a single styleable element: its
|
|
1066
|
+
* own container.
|
|
1067
|
+
*/
|
|
363
1068
|
export interface FlowRowElements {
|
|
1069
|
+
/**
|
|
1070
|
+
* Style blocks for the flow row container itself. The array represents breakpoint-specific
|
|
1071
|
+
* styles: first item is the default (no breakpoint), subsequent items correspond to
|
|
1072
|
+
* breakpoints in ascending order. MUST contain at least one item for the default style.
|
|
1073
|
+
*/
|
|
364
1074
|
own: BasicStateStylingBlock<FlowRowStyle>[];
|
|
365
1075
|
}
|
|
1076
|
+
/** Transition styles for the FlowRow node. Use to animate style changes smoothly. */
|
|
366
1077
|
export interface FlowRowTransitions {
|
|
1078
|
+
/**
|
|
1079
|
+
* Transition properties for the flow row container. Specifies which style properties
|
|
1080
|
+
* should animate and their duration/easing when values change.
|
|
1081
|
+
*/
|
|
367
1082
|
own?: null | FlowRowStyle;
|
|
368
1083
|
}
|
|
1084
|
+
/**
|
|
1085
|
+
* A horizontal flex container that wraps children to the next line when they exceed the
|
|
1086
|
+
* container width. Like Row but with line wrapping. Use when you have a dynamic number of
|
|
1087
|
+
* items that should flow naturally across lines (e.g., tags, chips, badges). Do NOT use
|
|
1088
|
+
* FlowRow when you need a single non-wrapping horizontal row; use Row instead.
|
|
1089
|
+
*/
|
|
369
1090
|
export interface FlowRowModel<Children> {
|
|
1091
|
+
/**
|
|
1092
|
+
* Visual styles for this flow row. See styling documentation for the structure. Omit to
|
|
1093
|
+
* use default (unstyled) rendering.
|
|
1094
|
+
*/
|
|
370
1095
|
styles?: null | LayoutStyle<FlowRowElements, FlowRowTransitions>;
|
|
1096
|
+
/**
|
|
1097
|
+
* Child nodes rendered horizontally with wrapping within this flow row. MUST contain at
|
|
1098
|
+
* least one child. Children wrap to the next line when they exceed the container width.
|
|
1099
|
+
*/
|
|
371
1100
|
children: Children[];
|
|
372
1101
|
}
|
|
1102
|
+
/**
|
|
1103
|
+
* Visual style properties for the GroupedDistribution container.
|
|
1104
|
+
* Contains the standard style categories: container layout, background colors,
|
|
1105
|
+
* border appearance, dimensions, flex child positioning, and spacing.
|
|
1106
|
+
*/
|
|
373
1107
|
export interface GroupedDistributionStyles {
|
|
1108
|
+
/** Container layout styles (e.g. flex direction, alignment). */
|
|
374
1109
|
container?: null | ContainerStylingProperties;
|
|
1110
|
+
/** Background color and gradient styles. */
|
|
375
1111
|
background?: null | BackgroundStylingProperties;
|
|
1112
|
+
/** Border width, color, and radius styles. */
|
|
376
1113
|
border?: null | BorderStylingProperties;
|
|
1114
|
+
/** Width and height dimension styles. */
|
|
377
1115
|
dimension?: null | DimensionStylingProperties;
|
|
1116
|
+
/** Flex child sizing and alignment styles (grow, shrink, align-self). */
|
|
378
1117
|
flexChild?: null | FlexChildStylingProperties;
|
|
1118
|
+
/** Padding and margin spacing styles. */
|
|
379
1119
|
spacing?: null | SpacingStylingProperties;
|
|
380
1120
|
}
|
|
1121
|
+
/**
|
|
1122
|
+
* Styling elements for the GroupedDistribution container.
|
|
1123
|
+
* The `own` array contains stateless styling blocks applied to the grouped container itself.
|
|
1124
|
+
*/
|
|
381
1125
|
export interface GroupedDistributionElements {
|
|
1126
|
+
/** Array of stateless styling blocks for the grouped container. */
|
|
382
1127
|
own: StatelessStylingBlock<GroupedDistributionStyles>[];
|
|
383
1128
|
}
|
|
1129
|
+
/** Transition styles for animating GroupedDistribution style changes. */
|
|
384
1130
|
export interface GroupedDistributionTransitions {
|
|
1131
|
+
/** Transition properties for the grouped container's own styles. */
|
|
385
1132
|
own?: null | GroupedDistributionStyles;
|
|
386
1133
|
}
|
|
387
|
-
|
|
1134
|
+
/**
|
|
1135
|
+
* A bidirectional transition that applies both when showing and hiding an
|
|
1136
|
+
* element. MUST be an object with a "type" field and a "settings" field.
|
|
1137
|
+
* Currently only "FadeInOut" is supported.
|
|
1138
|
+
*/
|
|
1139
|
+
export type Transition =
|
|
1140
|
+
/**
|
|
1141
|
+
* A fade-in/fade-out transition. The element fades in when shown and
|
|
1142
|
+
* fades out when hidden, using the specified duration.
|
|
1143
|
+
*/
|
|
1144
|
+
{
|
|
388
1145
|
type: "FadeInOut";
|
|
389
1146
|
settings: FadeInOutTransitionSettings;
|
|
390
1147
|
};
|
|
@@ -392,379 +1149,1041 @@ export interface GroupedSettings {
|
|
|
392
1149
|
viewableItems: number[];
|
|
393
1150
|
transition: Transition;
|
|
394
1151
|
}
|
|
1152
|
+
/**
|
|
1153
|
+
* Presents offers in groups, progressing through groups sequentially.
|
|
1154
|
+
* Used EXCLUSIVELY in the Outer Layout. This is the container into which offers (Layout Variants) are rendered.
|
|
1155
|
+
* Each group shows a fixed number of offers at once, and the user advances through groups.
|
|
1156
|
+
*
|
|
1157
|
+
* Pair with ProgressControl nodes for group navigation.
|
|
1158
|
+
* Use `viewableItems` to control how many offers appear per group at each breakpoint.
|
|
1159
|
+
*/
|
|
395
1160
|
export interface GroupedDistributionModel {
|
|
1161
|
+
/**
|
|
1162
|
+
* Visual styles for the grouped container.
|
|
1163
|
+
* Uses the LayoutStyle wrapper with conditional style transitions.
|
|
1164
|
+
*/
|
|
396
1165
|
styles?: null | LayoutStyle<GroupedDistributionElements, GroupedDistributionTransitions>;
|
|
397
1166
|
settings: GroupedSettings;
|
|
398
1167
|
}
|
|
1168
|
+
/**
|
|
1169
|
+
* Typography styling for inline text elements. A subset of TextStylingProperties
|
|
1170
|
+
* without line-level controls (lineHeight, horizontalTextAlign, lineLimit).
|
|
1171
|
+
* All fields are optional. Only include the properties you want to override.
|
|
1172
|
+
*/
|
|
399
1173
|
export interface InlineTextStylingProperties {
|
|
1174
|
+
/** The text color. Uses themed values for light/dark mode support. */
|
|
400
1175
|
textColor?: null | ThemeColor;
|
|
1176
|
+
/** Font size in platform units (px on Web, pt on iOS, dp on Android). */
|
|
401
1177
|
fontSize?: null | number;
|
|
1178
|
+
/** The font family name. Use 'rokt-icons' for icon fonts. */
|
|
402
1179
|
fontFamily?: null | string;
|
|
1180
|
+
/** The weight (boldness) of the font. */
|
|
403
1181
|
fontWeight?: null | FontWeight;
|
|
1182
|
+
/** Vertical alignment of text relative to the baseline. */
|
|
404
1183
|
baselineTextAlign?: null | FontBaselineAlignment;
|
|
1184
|
+
/** Normal or italic text rendering. */
|
|
405
1185
|
fontStyle?: null | FontStyle;
|
|
1186
|
+
/** Controls automatic text capitalisation. */
|
|
406
1187
|
textTransform?: null | TextTransform;
|
|
1188
|
+
/** Additional spacing between characters in platform units. */
|
|
407
1189
|
letterSpacing?: null | number;
|
|
1190
|
+
/** Decorative line applied to text (underline, strikethrough). */
|
|
408
1191
|
textDecoration?: null | TextDecoration;
|
|
409
1192
|
}
|
|
1193
|
+
/** Inline text styling for elements like links within rich text. */
|
|
410
1194
|
export interface InLineTextStyle {
|
|
1195
|
+
/** Typography properties for the inline text element. */
|
|
411
1196
|
text: InlineTextStylingProperties;
|
|
412
1197
|
}
|
|
1198
|
+
/**
|
|
1199
|
+
* Visual style properties for individual indicator items (dots, bars, etc.).
|
|
1200
|
+
* Includes text styling for number-based indicators.
|
|
1201
|
+
*/
|
|
413
1202
|
export interface IndicatorStyles {
|
|
1203
|
+
/** Container layout styles (e.g. flex direction, alignment). */
|
|
414
1204
|
container?: null | ContainerStylingProperties;
|
|
1205
|
+
/** Background color and gradient styles. */
|
|
415
1206
|
background?: null | BackgroundStylingProperties;
|
|
1207
|
+
/** Border width, color, and radius styles. */
|
|
416
1208
|
border?: null | BorderStylingProperties;
|
|
1209
|
+
/** Width and height dimension styles. */
|
|
417
1210
|
dimension?: null | DimensionStylingProperties;
|
|
1211
|
+
/** Flex child sizing and alignment styles (grow, shrink, align-self). */
|
|
418
1212
|
flexChild?: null | FlexChildStylingProperties;
|
|
1213
|
+
/** Padding and margin spacing styles. */
|
|
419
1214
|
spacing?: null | SpacingStylingProperties;
|
|
1215
|
+
/** Text styling for number-based indicators. */
|
|
420
1216
|
text?: null | TextStylingProperties;
|
|
421
1217
|
}
|
|
1218
|
+
/** Platform-specific settings for the layout behaviour. */
|
|
422
1219
|
export interface LayoutSettings {
|
|
1220
|
+
/** Whether to automatically close the layout after the user completes the interaction flow. */
|
|
423
1221
|
closeOnComplete?: null | boolean;
|
|
424
1222
|
}
|
|
1223
|
+
/**
|
|
1224
|
+
* Visual style properties for the OneByOneDistribution container.
|
|
1225
|
+
* Contains the standard style categories: container layout, background colors,
|
|
1226
|
+
* border appearance, dimensions, flex child positioning, and spacing.
|
|
1227
|
+
*/
|
|
425
1228
|
export interface OneByOneDistributionStyles {
|
|
1229
|
+
/** Container layout styles (e.g. flex direction, alignment). */
|
|
426
1230
|
container?: null | ContainerStylingProperties;
|
|
1231
|
+
/** Background color and gradient styles. */
|
|
427
1232
|
background?: null | BackgroundStylingProperties;
|
|
1233
|
+
/** Border width, color, and radius styles. */
|
|
428
1234
|
border?: null | BorderStylingProperties;
|
|
1235
|
+
/** Width and height dimension styles. */
|
|
429
1236
|
dimension?: null | DimensionStylingProperties;
|
|
1237
|
+
/** Flex child sizing and alignment styles (grow, shrink, align-self). */
|
|
430
1238
|
flexChild?: null | FlexChildStylingProperties;
|
|
1239
|
+
/** Padding and margin spacing styles. */
|
|
431
1240
|
spacing?: null | SpacingStylingProperties;
|
|
432
1241
|
}
|
|
1242
|
+
/**
|
|
1243
|
+
* Styling elements for the OneByOneDistribution container.
|
|
1244
|
+
* The `own` array contains stateless styling blocks applied to the distribution container itself.
|
|
1245
|
+
*/
|
|
433
1246
|
export interface OneByOneDistributionElements {
|
|
1247
|
+
/** Array of stateless styling blocks for the distribution container. */
|
|
434
1248
|
own: StatelessStylingBlock<OneByOneDistributionStyles>[];
|
|
435
1249
|
}
|
|
1250
|
+
/** Transition styles for animating OneByOneDistribution style changes. */
|
|
436
1251
|
export interface OneByOneDistributionTransitions {
|
|
1252
|
+
/** Transition properties for the distribution container's own styles. */
|
|
437
1253
|
own?: null | OneByOneDistributionStyles;
|
|
438
1254
|
}
|
|
1255
|
+
/**
|
|
1256
|
+
* Presents offers one at a time, allowing the user to progress through them sequentially.
|
|
1257
|
+
* Used EXCLUSIVELY in the Outer Layout. This is the container into which offers (Layout Variants) are rendered.
|
|
1258
|
+
*
|
|
1259
|
+
* Pair with ProgressControl nodes to enable forward/backward navigation between offers.
|
|
1260
|
+
* Pair with ProgressIndicator to show the user's current position.
|
|
1261
|
+
* Do NOT use this for displaying all offers at once; use StackedDistribution instead.
|
|
1262
|
+
*/
|
|
439
1263
|
export interface OneByOneDistributionModel {
|
|
1264
|
+
/**
|
|
1265
|
+
* Visual styles for the distribution container.
|
|
1266
|
+
* Uses the LayoutStyle wrapper with conditional style transitions.
|
|
1267
|
+
*/
|
|
440
1268
|
styles?: null | LayoutStyle<OneByOneDistributionElements, OneByOneDistributionTransitions>;
|
|
1269
|
+
/**
|
|
1270
|
+
* The animation transition between offers.
|
|
1271
|
+
* Defines how the current offer exits and the next offer enters.
|
|
1272
|
+
*/
|
|
441
1273
|
transition: Transition;
|
|
442
1274
|
}
|
|
1275
|
+
/**
|
|
1276
|
+
* Available style categories for the Overlay content element. Each optional field enables a
|
|
1277
|
+
* specific category of visual styling. Omit a field to leave that category unstyled.
|
|
1278
|
+
*/
|
|
443
1279
|
export interface OverlayStyles {
|
|
1280
|
+
/**
|
|
1281
|
+
* Layout properties for the flex container (justification, alignment, gap, overflow).
|
|
1282
|
+
* MUST be used to control how children are arranged within the overlay content area.
|
|
1283
|
+
*/
|
|
444
1284
|
container?: null | ContainerStylingProperties;
|
|
1285
|
+
/**
|
|
1286
|
+
* Background color and image properties. Use to set a solid color, gradient, or image
|
|
1287
|
+
* behind the overlay content.
|
|
1288
|
+
*/
|
|
445
1289
|
background?: null | BackgroundStylingProperties;
|
|
1290
|
+
/**
|
|
1291
|
+
* Border radius, color, width and style properties. Use to add visible borders or
|
|
1292
|
+
* rounded corners to the overlay content area.
|
|
1293
|
+
*/
|
|
446
1294
|
border?: null | BorderStylingProperties;
|
|
1295
|
+
/**
|
|
1296
|
+
* Width, height and rotation properties. Use to explicitly size the overlay content area.
|
|
1297
|
+
* Do NOT set width/height if the overlay should size to its content.
|
|
1298
|
+
*/
|
|
447
1299
|
dimension?: null | DimensionStylingProperties;
|
|
1300
|
+
/**
|
|
1301
|
+
* Properties controlling this element's behaviour as a child of a flex container.
|
|
1302
|
+
* Use to set flex-grow, flex-shrink, flex-basis, and align-self.
|
|
1303
|
+
*/
|
|
448
1304
|
flexChild?: null | FlexChildStylingProperties;
|
|
1305
|
+
/**
|
|
1306
|
+
* Padding, margin and offset properties. Use to add spacing inside or outside the
|
|
1307
|
+
* overlay content area.
|
|
1308
|
+
*/
|
|
449
1309
|
spacing?: null | SpacingStylingProperties;
|
|
450
1310
|
}
|
|
1311
|
+
/**
|
|
1312
|
+
* Style categories for the Overlay wrapper (backdrop) element. Controls the appearance of
|
|
1313
|
+
* the area behind the overlay content.
|
|
1314
|
+
*/
|
|
451
1315
|
export interface OverlayWrapperStyles {
|
|
1316
|
+
/** Layout properties for the wrapper container that positions the overlay content. */
|
|
452
1317
|
container?: null | ContainerStylingProperties;
|
|
1318
|
+
/**
|
|
1319
|
+
* Background color for the backdrop. Typically a semi-transparent color (using `#AARRGGBB`
|
|
1320
|
+
* format, e.g. `#80000000`) to dim the content behind the overlay.
|
|
1321
|
+
*/
|
|
453
1322
|
background?: null | BackgroundStylingProperties;
|
|
454
1323
|
}
|
|
1324
|
+
/**
|
|
1325
|
+
* Styleable elements of the Overlay node. The Overlay has two styleable elements: its own
|
|
1326
|
+
* content area and its wrapper (backdrop).
|
|
1327
|
+
*/
|
|
455
1328
|
export interface OverlayElements {
|
|
1329
|
+
/**
|
|
1330
|
+
* Style blocks for the overlay content area. The array represents breakpoint-specific
|
|
1331
|
+
* styles: first item is the default (no breakpoint), subsequent items correspond to
|
|
1332
|
+
* breakpoints in ascending order. MUST contain at least one item for the default style.
|
|
1333
|
+
*/
|
|
456
1334
|
own: BasicStateStylingBlock<OverlayStyles>[];
|
|
1335
|
+
/**
|
|
1336
|
+
* Style blocks for the overlay wrapper (backdrop). The array represents
|
|
1337
|
+
* breakpoint-specific styles: first item is the default, subsequent items correspond
|
|
1338
|
+
* to breakpoints in ascending order.
|
|
1339
|
+
*/
|
|
457
1340
|
wrapper: BasicStateStylingBlock<OverlayWrapperStyles>[];
|
|
458
1341
|
}
|
|
459
1342
|
export interface OverlaySettings {
|
|
460
1343
|
allowBackdropToClose: boolean;
|
|
461
1344
|
}
|
|
1345
|
+
/** Transition styles for the Overlay node. Use to animate style changes smoothly. */
|
|
462
1346
|
export interface OverlayTransitions {
|
|
1347
|
+
/**
|
|
1348
|
+
* Transition properties for the overlay content area. Specifies which style properties
|
|
1349
|
+
* should animate and their duration/easing when values change.
|
|
1350
|
+
*/
|
|
463
1351
|
own?: null | OverlayStyles;
|
|
1352
|
+
/** Transition properties for the overlay wrapper (backdrop). */
|
|
464
1353
|
wrapper?: null | OverlayWrapperStyles;
|
|
465
1354
|
}
|
|
1355
|
+
/**
|
|
1356
|
+
* A modal overlay that appears on top of the main content with a backdrop. Use for dialogs,
|
|
1357
|
+
* confirmations, and modal interactions that require user attention. The overlay blocks
|
|
1358
|
+
* interaction with the content behind it. Do NOT use Overlay for inline content layering;
|
|
1359
|
+
* use ZStack instead.
|
|
1360
|
+
*/
|
|
466
1361
|
export interface OverlayModel<Children> {
|
|
467
1362
|
settings: OverlaySettings;
|
|
1363
|
+
/**
|
|
1364
|
+
* Visual styles for this overlay. See styling documentation for the structure. Omit to
|
|
1365
|
+
* use default (unstyled) rendering.
|
|
1366
|
+
*/
|
|
468
1367
|
styles?: null | LayoutStyle<OverlayElements, OverlayTransitions>;
|
|
1368
|
+
/** The content displayed within the overlay. */
|
|
469
1369
|
children: Children[];
|
|
470
1370
|
}
|
|
1371
|
+
/**
|
|
1372
|
+
* Tests the position index of the current item within a collection. Use to
|
|
1373
|
+
* style items differently based on their position (e.g. first item, last item).
|
|
1374
|
+
*/
|
|
471
1375
|
export interface PositionPredicate {
|
|
1376
|
+
/** The comparison operator. */
|
|
472
1377
|
condition: OrderableWhenCondition;
|
|
1378
|
+
/**
|
|
1379
|
+
* The position index to compare against. MUST be a string representation
|
|
1380
|
+
* of a number, e.g. "0" for the first item.
|
|
1381
|
+
*/
|
|
473
1382
|
value: string;
|
|
474
1383
|
}
|
|
1384
|
+
/**
|
|
1385
|
+
* Visual style properties for the ProgressControl button.
|
|
1386
|
+
* Contains the standard style categories: container layout, background colors,
|
|
1387
|
+
* border appearance, dimensions, flex child positioning, and spacing.
|
|
1388
|
+
*/
|
|
475
1389
|
export interface ProgressControlStyle {
|
|
1390
|
+
/** Container layout styles (e.g. flex direction, alignment). */
|
|
476
1391
|
container?: null | ContainerStylingProperties;
|
|
1392
|
+
/** Background color and gradient styles. */
|
|
477
1393
|
background?: null | BackgroundStylingProperties;
|
|
1394
|
+
/** Border width, color, and radius styles. */
|
|
478
1395
|
border?: null | BorderStylingProperties;
|
|
1396
|
+
/** Width and height dimension styles. */
|
|
479
1397
|
dimension?: null | DimensionStylingProperties;
|
|
1398
|
+
/** Flex child sizing and alignment styles (grow, shrink, align-self). */
|
|
480
1399
|
flexChild?: null | FlexChildStylingProperties;
|
|
1400
|
+
/** Padding and margin spacing styles. */
|
|
481
1401
|
spacing?: null | SpacingStylingProperties;
|
|
482
1402
|
}
|
|
1403
|
+
/**
|
|
1404
|
+
* Styling elements for the ProgressControl button.
|
|
1405
|
+
* The `own` array contains state-dependent styling blocks (e.g. default, pressed, disabled)
|
|
1406
|
+
* applied to the control button itself.
|
|
1407
|
+
*/
|
|
483
1408
|
export interface ProgressControlElements {
|
|
1409
|
+
/**
|
|
1410
|
+
* Array of state-dependent styling blocks for the control button.
|
|
1411
|
+
* Each block targets a specific interaction state (default, pressed, disabled, etc.).
|
|
1412
|
+
*/
|
|
484
1413
|
own: BasicStateStylingBlock<ProgressControlStyle>[];
|
|
485
1414
|
}
|
|
1415
|
+
/** Transition styles for animating ProgressControl style changes. */
|
|
486
1416
|
export interface ProgressControlTransitions {
|
|
1417
|
+
/** Transition properties for the control button's own styles. */
|
|
487
1418
|
own?: null | ProgressControlStyle;
|
|
488
1419
|
}
|
|
489
|
-
|
|
1420
|
+
/** The direction in which the progress control advances offers. */
|
|
1421
|
+
export type ProgressionDirection =
|
|
1422
|
+
/** Advance to the next offer or group. */
|
|
1423
|
+
"Forward"
|
|
1424
|
+
/** Return to the previous offer or group. */
|
|
1425
|
+
| "Backward";
|
|
1426
|
+
/**
|
|
1427
|
+
* A button that advances or reverses offer progression.
|
|
1428
|
+
* Used with OneByOneDistribution or GroupedDistribution for navigation.
|
|
1429
|
+
*
|
|
1430
|
+
* MUST specify a `direction` (Forward or Backward).
|
|
1431
|
+
* Pair with a distribution node for the control to have an effect.
|
|
1432
|
+
* Typically contains an arrow icon as child content.
|
|
1433
|
+
*/
|
|
490
1434
|
export interface ProgressControlModel<Children> {
|
|
1435
|
+
/** Visual styles for the control. Uses the LayoutStyle wrapper with conditional style transitions. */
|
|
491
1436
|
styles?: null | LayoutStyle<ProgressControlElements, ProgressControlTransitions>;
|
|
1437
|
+
/** The direction to progress. MUST be either Forward or Backward. */
|
|
492
1438
|
direction: ProgressionDirection;
|
|
1439
|
+
/**
|
|
1440
|
+
* Child nodes forming the button content (e.g. an arrow icon).
|
|
1441
|
+
* MUST contain at least one child for the control to have visible content.
|
|
1442
|
+
*/
|
|
493
1443
|
children: Children[];
|
|
494
1444
|
}
|
|
1445
|
+
/**
|
|
1446
|
+
* Visual style properties for the ProgressIndicator container.
|
|
1447
|
+
* Contains the standard style categories for the outer indicator wrapper.
|
|
1448
|
+
*/
|
|
495
1449
|
export interface ProgressIndicatorStyles {
|
|
1450
|
+
/** Container layout styles (e.g. flex direction, alignment). */
|
|
496
1451
|
container?: null | ContainerStylingProperties;
|
|
1452
|
+
/** Background color and gradient styles. */
|
|
497
1453
|
background?: null | BackgroundStylingProperties;
|
|
1454
|
+
/** Border width, color, and radius styles. */
|
|
498
1455
|
border?: null | BorderStylingProperties;
|
|
1456
|
+
/** Width and height dimension styles. */
|
|
499
1457
|
dimension?: null | DimensionStylingProperties;
|
|
1458
|
+
/** Flex child sizing and alignment styles (grow, shrink, align-self). */
|
|
500
1459
|
flexChild?: null | FlexChildStylingProperties;
|
|
1460
|
+
/** Padding and margin spacing styles. */
|
|
501
1461
|
spacing?: null | SpacingStylingProperties;
|
|
502
1462
|
}
|
|
1463
|
+
/**
|
|
1464
|
+
* Styling elements for the ProgressIndicator.
|
|
1465
|
+
* Contains styling blocks for the container, individual indicators, and special indicator states.
|
|
1466
|
+
*/
|
|
503
1467
|
export interface ProgressIndicatorElements {
|
|
1468
|
+
/** Array of state-dependent styling blocks for the indicator container. */
|
|
504
1469
|
own: BasicStateStylingBlock<ProgressIndicatorStyles>[];
|
|
1470
|
+
/** Styling blocks for each individual indicator item (default state). */
|
|
505
1471
|
indicator: BasicStateStylingBlock<IndicatorStyles>[];
|
|
1472
|
+
/**
|
|
1473
|
+
* Optional styling blocks for the currently active indicator.
|
|
1474
|
+
* If omitted, the default indicator styling is used.
|
|
1475
|
+
*/
|
|
506
1476
|
activeIndicator?: null | BasicStateStylingBlock<IndicatorStyles>[];
|
|
1477
|
+
/**
|
|
1478
|
+
* Optional styling blocks for indicators that have been seen/visited.
|
|
1479
|
+
* If omitted, the default indicator styling is used.
|
|
1480
|
+
*/
|
|
507
1481
|
seenIndicator?: null | BasicStateStylingBlock<IndicatorStyles>[];
|
|
508
1482
|
}
|
|
1483
|
+
/**
|
|
1484
|
+
* Transition styles for animating ProgressIndicator style changes.
|
|
1485
|
+
* Defines transitions for the container and each indicator state.
|
|
1486
|
+
*/
|
|
509
1487
|
export interface ProgressIndicatorTransitions {
|
|
1488
|
+
/** Transition properties for the indicator container's own styles. */
|
|
510
1489
|
own?: null | ProgressIndicatorStyles;
|
|
1490
|
+
/** Transition properties for the default indicator styles. */
|
|
511
1491
|
indicator?: null | IndicatorStyles;
|
|
1492
|
+
/** Transition properties for the active indicator styles. */
|
|
512
1493
|
activeIndicator?: null | IndicatorStyles;
|
|
1494
|
+
/** Transition properties for the seen indicator styles. */
|
|
513
1495
|
seenIndicator?: null | IndicatorStyles;
|
|
514
1496
|
}
|
|
515
1497
|
export interface ProgressIndicatorSettings {
|
|
516
1498
|
startPosition?: null | number;
|
|
517
1499
|
}
|
|
1500
|
+
/**
|
|
1501
|
+
* Displays visual progress indicators (dots, bars) showing the user's position
|
|
1502
|
+
* within a series of offers.
|
|
1503
|
+
*
|
|
1504
|
+
* MUST be paired with a distribution node (OneByOneDistribution, GroupedDistribution, etc.)
|
|
1505
|
+
* to track position. The indicator automatically reflects the current offer position.
|
|
1506
|
+
* Use `indicator` to specify the type (e.g. "dot", "bar", "number").
|
|
1507
|
+
*/
|
|
518
1508
|
export interface ProgressIndicatorModel {
|
|
1509
|
+
/**
|
|
1510
|
+
* Visual styles for the progress indicators.
|
|
1511
|
+
* Uses the LayoutStyle wrapper with conditional style transitions.
|
|
1512
|
+
*/
|
|
519
1513
|
styles?: null | LayoutStyle<ProgressIndicatorElements, ProgressIndicatorTransitions>;
|
|
1514
|
+
/**
|
|
1515
|
+
* The type of indicator to display (e.g. "dot", "bar", "number").
|
|
1516
|
+
* MUST be a valid indicator type string.
|
|
1517
|
+
*/
|
|
520
1518
|
indicator: string;
|
|
521
1519
|
settings?: null | ProgressIndicatorSettings;
|
|
522
1520
|
isImportantForAccessibility?: null | boolean;
|
|
523
1521
|
}
|
|
1522
|
+
/**
|
|
1523
|
+
* Tests which offer index is currently visible in a carousel or progression.
|
|
1524
|
+
* Use 0 for the first offer, -1 for the last offer.
|
|
1525
|
+
*/
|
|
524
1526
|
export interface ProgressionPredicate {
|
|
1527
|
+
/** The comparison operator. */
|
|
525
1528
|
condition: OrderableWhenCondition;
|
|
1529
|
+
/**
|
|
1530
|
+
* The progression index to compare against. MUST be a string representation
|
|
1531
|
+
* of a number. Use "0" for the first offer, "-1" for the last offer.
|
|
1532
|
+
*/
|
|
526
1533
|
value: string;
|
|
527
1534
|
}
|
|
1535
|
+
/** Visual styles for the RichText node. */
|
|
528
1536
|
export interface RichTextStyle {
|
|
1537
|
+
/** Width, height and rotation properties. */
|
|
529
1538
|
dimension?: null | DimensionStylingProperties;
|
|
1539
|
+
/** Properties controlling behaviour as a flex child. */
|
|
530
1540
|
flexChild?: null | FlexChildStylingProperties;
|
|
1541
|
+
/** Padding, margin and offset properties. */
|
|
531
1542
|
spacing?: null | SpacingStylingProperties;
|
|
1543
|
+
/** Background color and image properties. */
|
|
532
1544
|
background?: null | BackgroundStylingProperties;
|
|
1545
|
+
/** Typography properties. */
|
|
533
1546
|
text?: null | TextStylingProperties;
|
|
534
1547
|
}
|
|
1548
|
+
/** Style elements for the RichText node. */
|
|
535
1549
|
export interface RichTextElements {
|
|
1550
|
+
/** Style blocks for the node's primary element. Array represents breakpoint-specific styles. */
|
|
536
1551
|
own: BasicStateStylingBlock<RichTextStyle>[];
|
|
1552
|
+
/** Style blocks for link elements within the rich text content. */
|
|
537
1553
|
link?: null | BasicStateStylingBlock<InLineTextStyle>[];
|
|
538
1554
|
}
|
|
1555
|
+
/** Transition definitions for the RichText node. */
|
|
539
1556
|
export interface RichTextTransitions {
|
|
1557
|
+
/** Transition properties for the primary element. */
|
|
540
1558
|
own?: null | RichTextStyle;
|
|
1559
|
+
/** Transition properties for link elements. */
|
|
541
1560
|
link?: null | InLineTextStyle;
|
|
542
1561
|
}
|
|
1562
|
+
/** Renders HTML-formatted text content. Supports `<a>`, `<strong>`, `<em>`, `<br>` and other inline HTML elements. Use BasicText for plain text without HTML. */
|
|
543
1563
|
export interface RichTextModel {
|
|
1564
|
+
/** Visual styles for the text element. */
|
|
544
1565
|
styles?: null | LayoutStyle<RichTextElements, RichTextTransitions>;
|
|
1566
|
+
/** Controls how links within the rich text are opened when clicked. */
|
|
545
1567
|
openLinks?: null | LinkOpenTarget;
|
|
1568
|
+
/** The HTML text content to display. Supports inline HTML tags and data binding placeholders in the format %^DATA.key^% or %^ATTRIBUTE.key^%. */
|
|
546
1569
|
value: string;
|
|
547
1570
|
}
|
|
1571
|
+
/**
|
|
1572
|
+
* The top-level schema structure for an outer layout. Contains the layout tree,
|
|
1573
|
+
* breakpoint definitions, settings and display configuration.
|
|
1574
|
+
*/
|
|
548
1575
|
export interface RootSchemaModel<Layout, Display, Settings> {
|
|
1576
|
+
/**
|
|
1577
|
+
* Map of breakpoint names to viewport width thresholds in platform units.
|
|
1578
|
+
* Defines responsive breakpoints for the layout.
|
|
1579
|
+
*/
|
|
549
1580
|
breakpoints: Record<string, number>;
|
|
1581
|
+
/** The root node of the layout tree. */
|
|
550
1582
|
layout: Layout;
|
|
1583
|
+
/** Platform-specific layout settings. */
|
|
551
1584
|
settings?: null | Settings;
|
|
1585
|
+
/** Controls how the layout is displayed (fullscreen, embedded, etc). */
|
|
552
1586
|
display?: null | Display;
|
|
553
1587
|
}
|
|
1588
|
+
/**
|
|
1589
|
+
* Available style categories for the Row element. Each optional field enables a specific
|
|
1590
|
+
* category of visual styling. Omit a field to leave that category unstyled.
|
|
1591
|
+
*/
|
|
554
1592
|
export interface RowStyle {
|
|
1593
|
+
/**
|
|
1594
|
+
* Layout properties for the flex container (justification, alignment, gap, overflow).
|
|
1595
|
+
* MUST be used to control how children are arranged within the row.
|
|
1596
|
+
*/
|
|
555
1597
|
container?: null | ContainerStylingProperties;
|
|
1598
|
+
/**
|
|
1599
|
+
* Background color and image properties. Use to set a solid color, gradient, or image
|
|
1600
|
+
* behind the row content.
|
|
1601
|
+
*/
|
|
556
1602
|
background?: null | BackgroundStylingProperties;
|
|
1603
|
+
/**
|
|
1604
|
+
* Border radius, color, width and style properties. Use to add visible borders or
|
|
1605
|
+
* rounded corners to the row.
|
|
1606
|
+
*/
|
|
557
1607
|
border?: null | BorderStylingProperties;
|
|
1608
|
+
/**
|
|
1609
|
+
* Width, height and rotation properties. Use to explicitly size the row or apply rotation
|
|
1610
|
+
* transforms. Do NOT set width/height if the row should size to its content.
|
|
1611
|
+
*/
|
|
558
1612
|
dimension?: null | DimensionStylingProperties;
|
|
1613
|
+
/**
|
|
1614
|
+
* Properties controlling this element's behaviour as a child of a flex container.
|
|
1615
|
+
* Use to set flex-grow, flex-shrink, flex-basis, and align-self.
|
|
1616
|
+
*/
|
|
559
1617
|
flexChild?: null | FlexChildStylingProperties;
|
|
1618
|
+
/** Padding, margin and offset properties. Use to add spacing inside or outside the row. */
|
|
560
1619
|
spacing?: null | SpacingStylingProperties;
|
|
561
1620
|
}
|
|
1621
|
+
/**
|
|
1622
|
+
* Styleable elements of the Row node. The Row has a single styleable element: its own
|
|
1623
|
+
* container.
|
|
1624
|
+
*/
|
|
562
1625
|
export interface RowElements {
|
|
1626
|
+
/**
|
|
1627
|
+
* Style blocks for the row container itself. The array represents breakpoint-specific
|
|
1628
|
+
* styles: first item is the default (no breakpoint), subsequent items correspond to
|
|
1629
|
+
* breakpoints in ascending order. MUST contain at least one item for the default style.
|
|
1630
|
+
*/
|
|
563
1631
|
own: BasicStateStylingBlock<RowStyle>[];
|
|
564
1632
|
}
|
|
1633
|
+
/** Transition styles for the Row node. Use to animate style changes smoothly. */
|
|
565
1634
|
export interface RowTransitions {
|
|
1635
|
+
/**
|
|
1636
|
+
* Transition properties for the row container. Specifies which style properties
|
|
1637
|
+
* should animate and their duration/easing when values change.
|
|
1638
|
+
*/
|
|
566
1639
|
own?: null | RowStyle;
|
|
567
1640
|
}
|
|
1641
|
+
/**
|
|
1642
|
+
* A horizontal flex container that arranges its children in a row (left to right). Use for
|
|
1643
|
+
* horizontal layouts. Children are laid out along the horizontal axis by default. To control
|
|
1644
|
+
* alignment and distribution, configure the container styles. Do NOT nest Rows unnecessarily
|
|
1645
|
+
* when a single Row with appropriate styling would suffice.
|
|
1646
|
+
*/
|
|
568
1647
|
export interface RowModel<Children> {
|
|
1648
|
+
/**
|
|
1649
|
+
* Visual styles for this row. See styling documentation for the structure. Omit to use
|
|
1650
|
+
* default (unstyled) rendering.
|
|
1651
|
+
*/
|
|
569
1652
|
styles?: null | LayoutStyle<RowElements, RowTransitions>;
|
|
1653
|
+
/**
|
|
1654
|
+
* Child nodes rendered horizontally within this row.
|
|
1655
|
+
* Children are laid out left to right in source order.
|
|
1656
|
+
*/
|
|
570
1657
|
children: Children[];
|
|
571
1658
|
}
|
|
1659
|
+
/**
|
|
1660
|
+
* Visual style properties for the SlideStateTrigger container.
|
|
1661
|
+
* Contains the standard style categories for the slider's outer container.
|
|
1662
|
+
*/
|
|
572
1663
|
export interface SlideStateTriggerOwnStyles {
|
|
1664
|
+
/** Container layout styles (e.g. flex direction, alignment). */
|
|
573
1665
|
container?: null | ContainerStylingProperties;
|
|
1666
|
+
/** Background color and gradient styles. */
|
|
574
1667
|
background?: null | BackgroundStylingProperties;
|
|
1668
|
+
/** Border width, color, and radius styles. */
|
|
575
1669
|
border?: null | BorderStylingProperties;
|
|
1670
|
+
/** Width and height dimension styles. */
|
|
576
1671
|
dimension?: null | DimensionStylingProperties;
|
|
1672
|
+
/** Flex child sizing and alignment styles (grow, shrink, align-self). */
|
|
577
1673
|
flexChild?: null | FlexChildStylingProperties;
|
|
1674
|
+
/** Padding and margin spacing styles. */
|
|
578
1675
|
spacing?: null | SpacingStylingProperties;
|
|
579
1676
|
}
|
|
1677
|
+
/** Visual style properties for the slider thumb (the draggable handle). */
|
|
580
1678
|
export interface SlideStateTriggerThumbStyles {
|
|
1679
|
+
/** Text styling for the thumb label. */
|
|
581
1680
|
text?: null | TextStylingProperties;
|
|
1681
|
+
/** Background color and gradient styles for the thumb. */
|
|
582
1682
|
background?: null | BackgroundStylingProperties;
|
|
1683
|
+
/** Border width, color, and radius styles for the thumb. */
|
|
583
1684
|
border?: null | BorderStylingProperties;
|
|
1685
|
+
/** Width and height dimension styles for the thumb. */
|
|
584
1686
|
dimension?: null | DimensionStylingProperties;
|
|
1687
|
+
/** Flex child sizing and alignment styles for the thumb. */
|
|
585
1688
|
flexChild?: null | FlexChildStylingProperties;
|
|
1689
|
+
/** Padding and margin spacing styles for the thumb. */
|
|
586
1690
|
spacing?: null | SpacingStylingProperties;
|
|
587
1691
|
}
|
|
1692
|
+
/** Visual style properties for the slider label. */
|
|
588
1693
|
export interface SlideStateTriggerLabelStyles {
|
|
1694
|
+
/** Text styling for the label. */
|
|
589
1695
|
text?: null | TextStylingProperties;
|
|
1696
|
+
/** Padding and margin spacing styles for the label. */
|
|
590
1697
|
spacing?: null | SpacingStylingProperties;
|
|
591
1698
|
}
|
|
1699
|
+
/** Visual style properties for the slider fill (the filled portion of the track). */
|
|
592
1700
|
export interface SlideStateTriggerFillStyles {
|
|
1701
|
+
/** Background color and gradient styles for the fill. */
|
|
593
1702
|
background?: null | BackgroundStylingProperties;
|
|
1703
|
+
/** Border width, color, and radius styles for the fill. */
|
|
594
1704
|
border?: null | BorderStylingProperties;
|
|
595
1705
|
}
|
|
1706
|
+
/**
|
|
1707
|
+
* Styling elements for the SlideStateTrigger.
|
|
1708
|
+
* Contains styling blocks for the container, thumb, label, and fill sub-elements.
|
|
1709
|
+
*/
|
|
596
1710
|
export interface SlideStateTriggerElements {
|
|
1711
|
+
/** Array of stateless styling blocks for the slider container. */
|
|
597
1712
|
own: StatelessStylingBlock<SlideStateTriggerOwnStyles>[];
|
|
1713
|
+
/** Optional styling blocks for the slider thumb (draggable handle). */
|
|
598
1714
|
thumb?: null | StatelessStylingBlock<SlideStateTriggerThumbStyles>[];
|
|
1715
|
+
/** Optional styling blocks for the slider label. */
|
|
599
1716
|
label?: null | StatelessStylingBlock<SlideStateTriggerLabelStyles>[];
|
|
1717
|
+
/** Optional styling blocks for the slider fill (filled track portion). */
|
|
600
1718
|
fill?: null | StatelessStylingBlock<SlideStateTriggerFillStyles>[];
|
|
601
1719
|
}
|
|
1720
|
+
/** Configuration for the slider label. */
|
|
602
1721
|
export interface SlideStateTriggerLabel {
|
|
1722
|
+
/** Optional text value to display as the slider label. */
|
|
603
1723
|
value?: null | string;
|
|
604
1724
|
}
|
|
1725
|
+
/**
|
|
1726
|
+
* Transition styles for animating SlideStateTrigger style changes.
|
|
1727
|
+
* Defines transitions for all slider sub-elements.
|
|
1728
|
+
*/
|
|
605
1729
|
export interface SlideStateTriggerTransitions {
|
|
1730
|
+
/** Transition properties for the slider container's own styles. */
|
|
606
1731
|
own?: null | SlideStateTriggerOwnStyles;
|
|
1732
|
+
/** Transition properties for the thumb styles. */
|
|
607
1733
|
thumb?: null | SlideStateTriggerThumbStyles;
|
|
1734
|
+
/** Transition properties for the label styles. */
|
|
608
1735
|
label?: null | SlideStateTriggerLabelStyles;
|
|
1736
|
+
/** Transition properties for the fill styles. */
|
|
609
1737
|
fill?: null | SlideStateTriggerFillStyles;
|
|
610
1738
|
}
|
|
1739
|
+
/** Configuration for the slider thumb (draggable handle). */
|
|
611
1740
|
export interface SlideStateTriggerThumb {
|
|
1741
|
+
/** Optional icon name to display inside the thumb. */
|
|
612
1742
|
icon?: null | string;
|
|
613
1743
|
}
|
|
1744
|
+
/**
|
|
1745
|
+
* A slider control that updates a custom state value as the user drags.
|
|
1746
|
+
* The slider thumb can be dragged to set the state to a value proportional to the position.
|
|
1747
|
+
* Use with When nodes to conditionally show/hide content based on the slider state.
|
|
1748
|
+
*
|
|
1749
|
+
* MUST provide a `customStateKey` that matches the key in When predicates.
|
|
1750
|
+
* Optionally provide `customStateValue` to set the slider's initial position.
|
|
1751
|
+
*/
|
|
614
1752
|
export interface SlideStateTriggerModel {
|
|
1753
|
+
/** Visual styles for the slider. Uses the LayoutStyle wrapper with conditional style transitions. */
|
|
615
1754
|
styles?: null | LayoutStyle<SlideStateTriggerElements, SlideStateTriggerTransitions>;
|
|
1755
|
+
/** Configuration for the slider thumb (draggable handle). */
|
|
616
1756
|
thumb?: null | SlideStateTriggerThumb;
|
|
1757
|
+
/** Configuration for the slider label. */
|
|
617
1758
|
label?: null | SlideStateTriggerLabel;
|
|
1759
|
+
/**
|
|
1760
|
+
* The custom state key to update as the slider is dragged.
|
|
1761
|
+
* MUST match the key referenced in When node predicates.
|
|
1762
|
+
*/
|
|
618
1763
|
customStateKey: string;
|
|
1764
|
+
/**
|
|
1765
|
+
* The initial value of the custom state (slider position).
|
|
1766
|
+
* If omitted, defaults to the minimum position.
|
|
1767
|
+
*/
|
|
619
1768
|
customStateValue?: null | number;
|
|
620
1769
|
}
|
|
1770
|
+
/**
|
|
1771
|
+
* Visual style properties for the StackedDistribution container.
|
|
1772
|
+
* Contains the standard style categories: container layout, background colors,
|
|
1773
|
+
* border appearance, dimensions, flex child positioning, and spacing.
|
|
1774
|
+
*/
|
|
621
1775
|
export interface StackedDistributionStyles {
|
|
1776
|
+
/** Container layout styles (e.g. flex direction, alignment). */
|
|
622
1777
|
container?: null | ContainerStylingProperties;
|
|
1778
|
+
/** Background color and gradient styles. */
|
|
623
1779
|
background?: null | BackgroundStylingProperties;
|
|
1780
|
+
/** Border width, color, and radius styles. */
|
|
624
1781
|
border?: null | BorderStylingProperties;
|
|
1782
|
+
/** Width and height dimension styles. */
|
|
625
1783
|
dimension?: null | DimensionStylingProperties;
|
|
1784
|
+
/** Flex child sizing and alignment styles (grow, shrink, align-self). */
|
|
626
1785
|
flexChild?: null | FlexChildStylingProperties;
|
|
1786
|
+
/** Padding and margin spacing styles. */
|
|
627
1787
|
spacing?: null | SpacingStylingProperties;
|
|
628
1788
|
}
|
|
1789
|
+
/**
|
|
1790
|
+
* Styling elements for the StackedDistribution container.
|
|
1791
|
+
* The `own` array contains stateless styling blocks applied to the stacked container itself.
|
|
1792
|
+
*/
|
|
629
1793
|
export interface StackedDistributionElements {
|
|
1794
|
+
/** Array of stateless styling blocks for the stacked container. */
|
|
630
1795
|
own: StatelessStylingBlock<StackedDistributionStyles>[];
|
|
631
1796
|
}
|
|
1797
|
+
/** Transition styles for animating StackedDistribution style changes. */
|
|
632
1798
|
export interface StackedDistributionTransitions {
|
|
1799
|
+
/** Transition properties for the stacked container's own styles. */
|
|
633
1800
|
own?: null | StackedDistributionStyles;
|
|
634
1801
|
}
|
|
1802
|
+
/**
|
|
1803
|
+
* Presents multiple offers stacked vertically, all visible at once.
|
|
1804
|
+
* Used EXCLUSIVELY in the Outer Layout. This is the container into which offers (Layout Variants) are rendered.
|
|
1805
|
+
*
|
|
1806
|
+
* Use this when all offers should be visible simultaneously.
|
|
1807
|
+
* Do NOT use this for sequential one-at-a-time presentation; use OneByOneDistribution instead.
|
|
1808
|
+
*/
|
|
635
1809
|
export interface StackedDistributionModel {
|
|
1810
|
+
/**
|
|
1811
|
+
* Visual styles for the stacked container.
|
|
1812
|
+
* Uses the LayoutStyle wrapper with conditional style transitions.
|
|
1813
|
+
*/
|
|
636
1814
|
styles?: null | LayoutStyle<StackedDistributionElements, StackedDistributionTransitions>;
|
|
637
1815
|
}
|
|
638
|
-
|
|
1816
|
+
/**
|
|
1817
|
+
* Condition operators for boolean values. Use these to test boolean flags.
|
|
1818
|
+
* Serialized as kebab-case strings: "is-true", "is-false".
|
|
1819
|
+
*/
|
|
1820
|
+
export type BooleanWhenCondition =
|
|
1821
|
+
/** True when the value is true. */
|
|
1822
|
+
"is-true"
|
|
1823
|
+
/** True when the value is false. */
|
|
1824
|
+
| "is-false";
|
|
1825
|
+
/**
|
|
1826
|
+
* A predicate with a hardcoded boolean value. Useful for enabling or disabling
|
|
1827
|
+
* sections during development or for static feature flags.
|
|
1828
|
+
*/
|
|
639
1829
|
export interface StaticBooleanPredicate {
|
|
1830
|
+
/** The boolean condition. Use "is-true" or "is-false". */
|
|
640
1831
|
condition: BooleanWhenCondition;
|
|
1832
|
+
/** The static boolean value to evaluate against the condition. */
|
|
641
1833
|
value: boolean;
|
|
642
1834
|
}
|
|
1835
|
+
/** Visual styles for the StaticIcon node. MUST include text styles with fontFamily set to 'rokt-icons' to render correctly. */
|
|
643
1836
|
export interface StaticIconStyles {
|
|
1837
|
+
/** Typography properties. MUST include fontFamily set to 'rokt-icons' for the icon to render correctly. */
|
|
644
1838
|
text?: null | TextStylingProperties;
|
|
1839
|
+
/** Width, height and rotation properties. */
|
|
645
1840
|
dimension?: null | DimensionStylingProperties;
|
|
1841
|
+
/** Properties controlling behaviour as a flex child. */
|
|
646
1842
|
flexChild?: null | FlexChildStylingProperties;
|
|
1843
|
+
/** Padding, margin and offset properties. */
|
|
647
1844
|
spacing?: null | SpacingStylingProperties;
|
|
1845
|
+
/** Background color and image properties. */
|
|
648
1846
|
background?: null | BackgroundStylingProperties;
|
|
1847
|
+
/** Border radius, color, width and style. */
|
|
649
1848
|
border?: null | BorderStylingProperties;
|
|
650
1849
|
}
|
|
1850
|
+
/** Style elements for the StaticIcon node. */
|
|
651
1851
|
export interface StaticIconElements {
|
|
1852
|
+
/** Style blocks for the node's primary element. Array represents breakpoint-specific styles. */
|
|
652
1853
|
own: BasicStateStylingBlock<StaticIconStyles>[];
|
|
653
1854
|
}
|
|
1855
|
+
/** Transition definitions for the StaticIcon node. */
|
|
654
1856
|
export interface StaticIconTransitions {
|
|
1857
|
+
/** Transition properties for the primary element. */
|
|
655
1858
|
own?: null | StaticIconStyles;
|
|
656
1859
|
}
|
|
1860
|
+
/** Renders an SVG icon from the Rokt icon font. The icon is selected by name from the available icon set. */
|
|
657
1861
|
export interface StaticIconModel {
|
|
1862
|
+
/** Visual styles for the icon. MUST include text styles with fontFamily set to 'rokt-icons' to render correctly. */
|
|
658
1863
|
styles?: null | LayoutStyle<StaticIconElements, StaticIconTransitions>;
|
|
1864
|
+
/** 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. */
|
|
659
1865
|
name: string;
|
|
1866
|
+
/** Accessibility description of the icon for screen readers. */
|
|
660
1867
|
description?: null | string;
|
|
661
1868
|
isImportantForAccessibility?: null | boolean;
|
|
662
1869
|
}
|
|
1870
|
+
/** Visual styles for the StaticImage node. */
|
|
663
1871
|
export interface StaticImageStyles {
|
|
1872
|
+
/** Background color and image properties. */
|
|
664
1873
|
background?: null | BackgroundStylingProperties;
|
|
1874
|
+
/** Border radius, color, width and style. */
|
|
665
1875
|
border?: null | BorderStylingProperties;
|
|
1876
|
+
/** Width, height and rotation properties. */
|
|
666
1877
|
dimension?: null | DimensionStylingProperties;
|
|
1878
|
+
/** Properties controlling behaviour as a flex child. */
|
|
667
1879
|
flexChild?: null | FlexChildStylingProperties;
|
|
1880
|
+
/** Padding, margin and offset properties. */
|
|
668
1881
|
spacing?: null | SpacingStylingProperties;
|
|
669
1882
|
}
|
|
1883
|
+
/** Style elements for the StaticImage node. */
|
|
670
1884
|
export interface StaticImageElements {
|
|
1885
|
+
/** Style blocks for the node's primary element. Array represents breakpoint-specific styles. */
|
|
671
1886
|
own: BasicStateStylingBlock<StaticImageStyles>[];
|
|
672
1887
|
}
|
|
1888
|
+
/** Transition definitions for the StaticImage node. */
|
|
673
1889
|
export interface StaticImageTransitions {
|
|
1890
|
+
/** Transition properties for the primary element. */
|
|
674
1891
|
own?: null | StaticImageStyles;
|
|
675
1892
|
}
|
|
1893
|
+
/** URL configuration for a static image with themed light/dark mode support. */
|
|
676
1894
|
export interface StaticImageUrl {
|
|
1895
|
+
/** The image URL for light mode. MUST be a valid URL. */
|
|
677
1896
|
light: string;
|
|
1897
|
+
/** The image URL for dark mode. If not provided, the light URL is used for both modes. */
|
|
678
1898
|
dark?: null | string;
|
|
679
1899
|
}
|
|
1900
|
+
/** Renders a static image from a provided URL. Use for images with known URLs (logos, icons, decorative images). */
|
|
680
1901
|
export interface StaticImageModel {
|
|
1902
|
+
/** Visual styles for the image element. */
|
|
681
1903
|
styles?: null | LayoutStyle<StaticImageElements, StaticImageTransitions>;
|
|
1904
|
+
/** Alt text for accessibility. Describes the image for screen readers. */
|
|
682
1905
|
alt?: null | string;
|
|
1906
|
+
/** Title text shown on hover. */
|
|
683
1907
|
title?: null | string;
|
|
1908
|
+
/** The image URL with themed light/dark mode support. */
|
|
684
1909
|
url: StaticImageUrl;
|
|
685
1910
|
isImportantForAccessibility?: null | boolean;
|
|
686
1911
|
}
|
|
1912
|
+
/**
|
|
1913
|
+
* Visual style properties for the StaticLink.
|
|
1914
|
+
* Contains the standard style categories: container layout, background colors,
|
|
1915
|
+
* border appearance, dimensions, flex child positioning, and spacing.
|
|
1916
|
+
*/
|
|
687
1917
|
export interface StaticLinkStyles {
|
|
1918
|
+
/** Container layout styles (e.g. flex direction, alignment). */
|
|
688
1919
|
container?: null | ContainerStylingProperties;
|
|
1920
|
+
/** Background color and gradient styles. */
|
|
689
1921
|
background?: null | BackgroundStylingProperties;
|
|
1922
|
+
/** Border width, color, and radius styles. */
|
|
690
1923
|
border?: null | BorderStylingProperties;
|
|
1924
|
+
/** Width and height dimension styles. */
|
|
691
1925
|
dimension?: null | DimensionStylingProperties;
|
|
1926
|
+
/** Flex child sizing and alignment styles (grow, shrink, align-self). */
|
|
692
1927
|
flexChild?: null | FlexChildStylingProperties;
|
|
1928
|
+
/** Padding and margin spacing styles. */
|
|
693
1929
|
spacing?: null | SpacingStylingProperties;
|
|
694
1930
|
}
|
|
1931
|
+
/**
|
|
1932
|
+
* Styling elements for the StaticLink.
|
|
1933
|
+
* The `own` array contains state-dependent styling blocks (e.g. default, pressed)
|
|
1934
|
+
* applied to the link itself.
|
|
1935
|
+
*/
|
|
695
1936
|
export interface StaticLinkElements {
|
|
1937
|
+
/**
|
|
1938
|
+
* Array of state-dependent styling blocks for the link.
|
|
1939
|
+
* Each block targets a specific interaction state (default, pressed, etc.).
|
|
1940
|
+
*/
|
|
696
1941
|
own: BasicStateStylingBlock<StaticLinkStyles>[];
|
|
697
1942
|
}
|
|
1943
|
+
/**
|
|
1944
|
+
* Transition styles for animating StaticLink style changes.
|
|
1945
|
+
* Defines which style properties should animate when the link's conditional styles change.
|
|
1946
|
+
*/
|
|
698
1947
|
export interface StaticLinkTransitions {
|
|
1948
|
+
/** Transition properties for the link's own styles. */
|
|
699
1949
|
own?: null | StaticLinkStyles;
|
|
700
1950
|
}
|
|
1951
|
+
/**
|
|
1952
|
+
* A clickable link that wraps its children. Opens the specified URL when clicked.
|
|
1953
|
+
*
|
|
1954
|
+
* Use this node for navigation to external URLs. Do NOT use CreativeResponse for link navigation;
|
|
1955
|
+
* CreativeResponse is for offer accept/decline actions only.
|
|
1956
|
+
* The `src` field MUST be a valid URL string.
|
|
1957
|
+
*/
|
|
701
1958
|
export interface StaticLinkModel<Children> {
|
|
1959
|
+
/**
|
|
1960
|
+
* The destination URL to open when the link is clicked.
|
|
1961
|
+
* MUST be a valid URL string (e.g. "https://example.com").
|
|
1962
|
+
*/
|
|
702
1963
|
src: string;
|
|
1964
|
+
/** Controls how the link URL is opened (e.g. in-app browser, external browser). */
|
|
703
1965
|
open: LinkOpenTarget;
|
|
1966
|
+
/** Visual styles for the link. Uses the LayoutStyle wrapper with conditional style transitions. */
|
|
704
1967
|
styles?: null | LayoutStyle<StaticLinkElements, StaticLinkTransitions>;
|
|
1968
|
+
/**
|
|
1969
|
+
* Child nodes that form the clickable link content.
|
|
1970
|
+
* MUST contain at least one child for the link to have visible, tappable content.
|
|
1971
|
+
*/
|
|
705
1972
|
children: Children[];
|
|
706
1973
|
}
|
|
1974
|
+
/**
|
|
1975
|
+
* Visual style properties for the ToggleButtonStateTrigger.
|
|
1976
|
+
* Contains the standard style categories: container layout, background colors,
|
|
1977
|
+
* border appearance, dimensions, flex child positioning, and spacing.
|
|
1978
|
+
*/
|
|
707
1979
|
export interface ToggleButtonStateTriggerStyle {
|
|
1980
|
+
/** Container layout styles (e.g. flex direction, alignment). */
|
|
708
1981
|
container?: null | ContainerStylingProperties;
|
|
1982
|
+
/** Background color and gradient styles. */
|
|
709
1983
|
background?: null | BackgroundStylingProperties;
|
|
1984
|
+
/** Border width, color, and radius styles. */
|
|
710
1985
|
border?: null | BorderStylingProperties;
|
|
1986
|
+
/** Width and height dimension styles. */
|
|
711
1987
|
dimension?: null | DimensionStylingProperties;
|
|
1988
|
+
/** Flex child sizing and alignment styles (grow, shrink, align-self). */
|
|
712
1989
|
flexChild?: null | FlexChildStylingProperties;
|
|
1990
|
+
/** Padding and margin spacing styles. */
|
|
713
1991
|
spacing?: null | SpacingStylingProperties;
|
|
714
1992
|
}
|
|
1993
|
+
/**
|
|
1994
|
+
* Styling elements for the ToggleButtonStateTrigger.
|
|
1995
|
+
* The `own` array contains state-dependent styling blocks applied to the toggle button itself.
|
|
1996
|
+
*/
|
|
715
1997
|
export interface ToggleButtonStateTriggerElements {
|
|
1998
|
+
/** Array of state-dependent styling blocks for the toggle button. */
|
|
716
1999
|
own: BasicStateStylingBlock<ToggleButtonStateTriggerStyle>[];
|
|
717
2000
|
}
|
|
2001
|
+
/** Transition styles for animating ToggleButtonStateTrigger style changes. */
|
|
718
2002
|
export interface ToggleButtonStateTriggerTransitions {
|
|
2003
|
+
/** Transition properties for the toggle button's own styles. */
|
|
719
2004
|
own?: null | ToggleButtonStateTriggerStyle;
|
|
720
2005
|
}
|
|
2006
|
+
/**
|
|
2007
|
+
* A toggle button that cycles a custom state between values when clicked.
|
|
2008
|
+
* Each click toggles the state value, typically between 0 and 1.
|
|
2009
|
+
* Use with When nodes to conditionally show/hide content based on the toggled state.
|
|
2010
|
+
*
|
|
2011
|
+
* MUST provide a `customStateKey` that matches the key in When predicates.
|
|
2012
|
+
* Unlike ButtonStateTrigger, this does NOT require a `value` field; it toggles automatically.
|
|
2013
|
+
*/
|
|
721
2014
|
export interface ToggleButtonStateTriggerModel<Children> {
|
|
2015
|
+
/** Visual styles for the toggle button. */
|
|
722
2016
|
styles?: null | LayoutStyle<ToggleButtonStateTriggerElements, ToggleButtonStateTriggerTransitions>;
|
|
2017
|
+
/** Child nodes forming the toggle button content. */
|
|
723
2018
|
children: Children[];
|
|
2019
|
+
/**
|
|
2020
|
+
* The custom state key to toggle when the button is pressed.
|
|
2021
|
+
* MUST match the key referenced in When node predicates.
|
|
2022
|
+
*/
|
|
724
2023
|
customStateKey: string;
|
|
725
2024
|
}
|
|
726
|
-
|
|
2025
|
+
/**
|
|
2026
|
+
* A transition that applies only when an element enters (becomes visible).
|
|
2027
|
+
* MUST be an object with a "type" field and a "settings" field.
|
|
2028
|
+
* Currently only "FadeIn" is supported.
|
|
2029
|
+
*/
|
|
2030
|
+
export type InTransition =
|
|
2031
|
+
/**
|
|
2032
|
+
* A fade-in transition. The element gradually becomes visible over the
|
|
2033
|
+
* specified duration.
|
|
2034
|
+
*/
|
|
2035
|
+
{
|
|
727
2036
|
type: "FadeIn";
|
|
728
2037
|
settings: FadeInTransitionSettings;
|
|
729
2038
|
};
|
|
730
|
-
|
|
2039
|
+
/**
|
|
2040
|
+
* A transition that applies only when an element exits (becomes hidden).
|
|
2041
|
+
* MUST be an object with a "type" field and a "settings" field.
|
|
2042
|
+
* Currently only "FadeOut" is supported.
|
|
2043
|
+
*/
|
|
2044
|
+
export type OutTransition =
|
|
2045
|
+
/**
|
|
2046
|
+
* A fade-out transition. The element gradually becomes invisible over
|
|
2047
|
+
* the specified duration.
|
|
2048
|
+
*/
|
|
2049
|
+
{
|
|
731
2050
|
type: "FadeOut";
|
|
732
2051
|
settings: FadeOutTransitionSettings;
|
|
733
2052
|
};
|
|
2053
|
+
/**
|
|
2054
|
+
* Transition configuration for when visibility changes.
|
|
2055
|
+
* Defines enter and exit animations for the When node's children.
|
|
2056
|
+
*/
|
|
734
2057
|
export interface WhenTransition {
|
|
735
2058
|
in?: null | InTransition[];
|
|
736
2059
|
out?: null | OutTransition[];
|
|
737
2060
|
}
|
|
738
|
-
|
|
2061
|
+
/**
|
|
2062
|
+
* Controls the hiding behaviour of When children.
|
|
2063
|
+
* Determines whether hidden children still occupy space in the layout.
|
|
2064
|
+
*/
|
|
2065
|
+
export type WhenHidden =
|
|
2066
|
+
/**
|
|
2067
|
+
* Children are visually hidden but remain in the layout (take up space).
|
|
2068
|
+
* Use this when you need to preserve layout dimensions even when content is hidden.
|
|
2069
|
+
*/
|
|
2070
|
+
"visually"
|
|
2071
|
+
/**
|
|
2072
|
+
* Children are fully removed from the layout.
|
|
2073
|
+
* They take up no space and do not affect sibling positioning.
|
|
2074
|
+
*/
|
|
2075
|
+
| "functionally";
|
|
2076
|
+
/**
|
|
2077
|
+
* Conditional rendering node. Shows or hides its children based on predicate conditions.
|
|
2078
|
+
* All predicates MUST evaluate to true for children to be shown (AND logic).
|
|
2079
|
+
*
|
|
2080
|
+
* Use this node to conditionally display content based on custom state, offer count, or other
|
|
2081
|
+
* predicate conditions. Do NOT nest When nodes unnecessarily; combine predicates in a single
|
|
2082
|
+
* When node instead.
|
|
2083
|
+
*/
|
|
739
2084
|
export interface WhenModel<Children> {
|
|
2085
|
+
/**
|
|
2086
|
+
* Array of conditions that MUST ALL be true for children to render.
|
|
2087
|
+
* Uses AND logic: if any predicate is false, children are hidden.
|
|
2088
|
+
* MUST contain at least one predicate.
|
|
2089
|
+
*/
|
|
740
2090
|
predicates: WhenPredicate[];
|
|
2091
|
+
/** Child nodes to conditionally show or hide based on the predicates. */
|
|
741
2092
|
children: Children[];
|
|
2093
|
+
/**
|
|
2094
|
+
* Optional transition animation configuration for when visibility changes.
|
|
2095
|
+
* Controls how children animate in and out when predicates change.
|
|
2096
|
+
*/
|
|
742
2097
|
transition?: null | WhenTransition;
|
|
2098
|
+
/**
|
|
2099
|
+
* Controls how hidden children are treated in the layout.
|
|
2100
|
+
* If omitted, defaults to functionally hiding (fully removed from layout).
|
|
2101
|
+
*/
|
|
743
2102
|
hide?: null | WhenHidden;
|
|
744
2103
|
}
|
|
2104
|
+
/** Styling properties for ZStack container layout. ZStack layers children on top of each other. */
|
|
745
2105
|
export interface ZStackContainerStylingProperties {
|
|
2106
|
+
/** Controls horizontal positioning of children within the ZStack. */
|
|
746
2107
|
justifyContent?: null | FlexPosition;
|
|
2108
|
+
/** Controls vertical positioning of children within the ZStack. */
|
|
747
2109
|
alignItems?: null | FlexPosition;
|
|
2110
|
+
/** Applies a box shadow effect around the container. */
|
|
748
2111
|
shadow?: null | Shadow;
|
|
2112
|
+
/** Controls whether content overflowing the container bounds is visible or hidden. */
|
|
749
2113
|
overflow?: null | Overflow;
|
|
2114
|
+
/** Applies a Gaussian blur effect. Value is the blur radius in platform units. */
|
|
750
2115
|
blur?: null | number;
|
|
751
2116
|
}
|
|
2117
|
+
/**
|
|
2118
|
+
* Available style categories for the ZStack element. Each optional field enables a specific
|
|
2119
|
+
* category of visual styling. Omit a field to leave that category unstyled.
|
|
2120
|
+
*/
|
|
752
2121
|
export interface ZStackStyle {
|
|
2122
|
+
/**
|
|
2123
|
+
* Layout properties for the ZStack container (alignment of stacked children).
|
|
2124
|
+
* MUST be used to control how children are positioned within the stack.
|
|
2125
|
+
*/
|
|
753
2126
|
container?: null | ZStackContainerStylingProperties;
|
|
2127
|
+
/**
|
|
2128
|
+
* Background color and image properties. Use to set a solid color, gradient, or image
|
|
2129
|
+
* behind the stacked content.
|
|
2130
|
+
*/
|
|
754
2131
|
background?: null | BackgroundStylingProperties;
|
|
2132
|
+
/**
|
|
2133
|
+
* Border radius, color, width and style properties. Use to add visible borders or
|
|
2134
|
+
* rounded corners to the ZStack.
|
|
2135
|
+
*/
|
|
755
2136
|
border?: null | BorderStylingProperties;
|
|
2137
|
+
/**
|
|
2138
|
+
* Width, height and rotation properties. Use to explicitly size the ZStack or apply
|
|
2139
|
+
* rotation transforms. Do NOT set width/height if the ZStack should size to its content.
|
|
2140
|
+
*/
|
|
756
2141
|
dimension?: null | DimensionStylingProperties;
|
|
2142
|
+
/**
|
|
2143
|
+
* Properties controlling this element's behaviour as a child of a flex container.
|
|
2144
|
+
* Use to set flex-grow, flex-shrink, flex-basis, and align-self.
|
|
2145
|
+
*/
|
|
757
2146
|
flexChild?: null | FlexChildStylingProperties;
|
|
2147
|
+
/** Padding, margin and offset properties. Use to add spacing inside or outside the ZStack. */
|
|
758
2148
|
spacing?: null | SpacingStylingProperties;
|
|
759
2149
|
}
|
|
2150
|
+
/**
|
|
2151
|
+
* Styleable elements of the ZStack node. The ZStack has a single styleable element: its own
|
|
2152
|
+
* container.
|
|
2153
|
+
*/
|
|
760
2154
|
export interface ZStackElements {
|
|
2155
|
+
/**
|
|
2156
|
+
* Style blocks for the ZStack container itself. The array represents breakpoint-specific
|
|
2157
|
+
* styles: first item is the default (no breakpoint), subsequent items correspond to
|
|
2158
|
+
* breakpoints in ascending order. MUST contain at least one item for the default style.
|
|
2159
|
+
*/
|
|
761
2160
|
own: BasicStateStylingBlock<ZStackStyle>[];
|
|
762
2161
|
}
|
|
2162
|
+
/** Transition styles for the ZStack node. Use to animate style changes smoothly. */
|
|
763
2163
|
export interface ZStackTransitions {
|
|
2164
|
+
/**
|
|
2165
|
+
* Transition properties for the ZStack container. Specifies which style properties
|
|
2166
|
+
* should animate and their duration/easing when values change.
|
|
2167
|
+
*/
|
|
764
2168
|
own?: null | ZStackStyle;
|
|
765
2169
|
}
|
|
2170
|
+
/**
|
|
2171
|
+
* A layered container that stacks children on top of each other along the z-axis. Later
|
|
2172
|
+
* children render on top of earlier ones. Use for overlapping content such as badges on
|
|
2173
|
+
* images, text overlays, or layered decorative elements. Do NOT use ZStack for simple
|
|
2174
|
+
* sequential layouts; use Row or Column instead.
|
|
2175
|
+
*/
|
|
766
2176
|
export interface ZStackModel<Children> {
|
|
2177
|
+
/**
|
|
2178
|
+
* Visual styles for this ZStack. See styling documentation for the structure. Omit to use
|
|
2179
|
+
* default (unstyled) rendering.
|
|
2180
|
+
*/
|
|
767
2181
|
styles?: null | LayoutStyle<ZStackElements, ZStackTransitions>;
|
|
2182
|
+
/**
|
|
2183
|
+
* Child nodes stacked on top of each other within this ZStack. MUST contain at least one
|
|
2184
|
+
* child. Children are rendered in source order, with later children appearing on top of
|
|
2185
|
+
* earlier ones.
|
|
2186
|
+
*/
|
|
768
2187
|
children: Children[];
|
|
769
2188
|
}
|
|
770
2189
|
export type CatalogResponseButtonChildren = {
|
|
@@ -798,6 +2217,10 @@ export type CatalogResponseButtonChildren = {
|
|
|
798
2217
|
type: "StaticIcon";
|
|
799
2218
|
node: StaticIconModel;
|
|
800
2219
|
};
|
|
2220
|
+
/**
|
|
2221
|
+
* Root node types for a catalog stacked collection item template. Must be a Row or Column
|
|
2222
|
+
* that contains CatalogStackedCollectionTemplateNodeChildren.
|
|
2223
|
+
*/
|
|
801
2224
|
export type CatalogStackedCollectionTemplateNode = {
|
|
802
2225
|
type: "Row";
|
|
803
2226
|
node: RowModel<CatalogStackedCollectionTemplateNodeChildren>;
|
|
@@ -805,6 +2228,11 @@ export type CatalogStackedCollectionTemplateNode = {
|
|
|
805
2228
|
type: "Column";
|
|
806
2229
|
node: ColumnModel<CatalogStackedCollectionTemplateNodeChildren>;
|
|
807
2230
|
};
|
|
2231
|
+
/**
|
|
2232
|
+
* Child node types allowed inside a catalog stacked collection template row or column.
|
|
2233
|
+
* Includes layout containers, text, images, icons, data-bound content, interactive triggers,
|
|
2234
|
+
* catalog response buttons, radio groups, and quantity counters.
|
|
2235
|
+
*/
|
|
808
2236
|
export type CatalogStackedCollectionTemplateNodeChildren = {
|
|
809
2237
|
type: "Row";
|
|
810
2238
|
node: RowModel<CatalogStackedCollectionTemplateNodeChildren>;
|
|
@@ -907,9 +2335,36 @@ export type CreativeResponseChildren = {
|
|
|
907
2335
|
type: "StaticIcon";
|
|
908
2336
|
node: StaticIconModel;
|
|
909
2337
|
};
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
2338
|
+
/**
|
|
2339
|
+
* Fit behaviour options for height.
|
|
2340
|
+
* Used as the 'value' inside a {"type": "fit", "value": ...} height specification.
|
|
2341
|
+
*/
|
|
2342
|
+
export type DimensionHeightFitValue =
|
|
2343
|
+
/** Shrinks to fit the content height. */
|
|
2344
|
+
"wrap-content"
|
|
2345
|
+
/** Expands to fill the available height. */
|
|
2346
|
+
| "fit-height";
|
|
2347
|
+
/**
|
|
2348
|
+
* Fit behaviour options for width.
|
|
2349
|
+
* Used as the 'value' inside a {"type": "fit", "value": ...} width specification.
|
|
2350
|
+
*/
|
|
2351
|
+
export type DimensionWidthFitValue =
|
|
2352
|
+
/** Shrinks to fit the content width. */
|
|
2353
|
+
"wrap-content"
|
|
2354
|
+
/** Expands to fill the available width. */
|
|
2355
|
+
| "fit-width";
|
|
2356
|
+
/** Controls how the layout is displayed on the page. */
|
|
2357
|
+
export type LayoutDisplayPreset =
|
|
2358
|
+
/** Layout covers the full viewport. */
|
|
2359
|
+
"FULLSCREEN"
|
|
2360
|
+
/** Layout is embedded inline within the page content. */
|
|
2361
|
+
| "EMBEDDED"
|
|
2362
|
+
/** Layout is attached/anchored to a specific position. */
|
|
2363
|
+
| "ATTACHED";
|
|
2364
|
+
/**
|
|
2365
|
+
* All node types supported in the web platform schema. This is the union type used by SDKs.
|
|
2366
|
+
* Layouts are authored using OuterLayoutSchemaModel or LayoutVariantSchemaModel instead.
|
|
2367
|
+
*/
|
|
913
2368
|
export type LayoutSchemaModel = {
|
|
914
2369
|
type: "Row";
|
|
915
2370
|
node: RowModel<LayoutSchemaModel>;
|
|
@@ -986,6 +2441,11 @@ export type LayoutSchemaModel = {
|
|
|
986
2441
|
type: "CatalogResponseButton";
|
|
987
2442
|
node: CatalogResponseButtonModel<CatalogResponseButtonChildren>;
|
|
988
2443
|
};
|
|
2444
|
+
/**
|
|
2445
|
+
* Recursive child node types allowed within layout variant containers. Includes all layout
|
|
2446
|
+
* variant nodes such as layout, text, images, data-bound content, interactive triggers,
|
|
2447
|
+
* catalog components, and escape hatches.
|
|
2448
|
+
*/
|
|
989
2449
|
export type LayoutVariantChildren = {
|
|
990
2450
|
type: "Row";
|
|
991
2451
|
node: RowModel<LayoutVariantChildren>;
|
|
@@ -1035,6 +2495,10 @@ export type LayoutVariantChildren = {
|
|
|
1035
2495
|
type: "CatalogStackedCollection";
|
|
1036
2496
|
node: CatalogStackedCollectionModel<CatalogStackedCollectionTemplateNode>;
|
|
1037
2497
|
};
|
|
2498
|
+
/**
|
|
2499
|
+
* Node types valid for use in layout variants (offer formats). Layout variants contain the
|
|
2500
|
+
* offer-specific creative content including images, text, response buttons, and catalog components.
|
|
2501
|
+
*/
|
|
1038
2502
|
export type LayoutVariantSchemaModel = {
|
|
1039
2503
|
type: "Row";
|
|
1040
2504
|
node: RowModel<LayoutVariantChildren>;
|
|
@@ -1084,6 +2548,10 @@ export type LayoutVariantSchemaModel = {
|
|
|
1084
2548
|
type: "CatalogStackedCollection";
|
|
1085
2549
|
node: CatalogStackedCollectionModel<CatalogStackedCollectionTemplateNode>;
|
|
1086
2550
|
};
|
|
2551
|
+
/**
|
|
2552
|
+
* Recursive child node types allowed within outer layout containers. Includes structural,
|
|
2553
|
+
* distribution, navigation, and presentational nodes scoped to outer layout predicates.
|
|
2554
|
+
*/
|
|
1087
2555
|
export type OuterLayoutChildren = {
|
|
1088
2556
|
type: "Row";
|
|
1089
2557
|
node: RowModel<OuterLayoutChildren>;
|
|
@@ -1142,6 +2610,11 @@ export type OuterLayoutChildren = {
|
|
|
1142
2610
|
type: "ToggleButtonStateTrigger";
|
|
1143
2611
|
node: ToggleButtonStateTriggerModel<ToggleButtonStateTriggerOuterLayoutChildren>;
|
|
1144
2612
|
};
|
|
2613
|
+
/**
|
|
2614
|
+
* Node types valid for use in outer layouts. Outer layouts define the frame and offer
|
|
2615
|
+
* distribution but do not contain offer-specific content. They include structural containers,
|
|
2616
|
+
* distribution nodes, navigation controls, and close buttons.
|
|
2617
|
+
*/
|
|
1145
2618
|
export type OuterLayoutSchemaModel = {
|
|
1146
2619
|
type: "Row";
|
|
1147
2620
|
node: RowModel<OuterLayoutChildren>;
|