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