@rokt/dcui-orchestrator 0.2.1-rc.13 → 0.2.1-rc.15

package/dist/libraries/dcui-components/src/components/data-image-carousel/carousel-indicators.d.ts

@@ -0,0 +1,20 @@
+import { DataImageCarouselModel, CarouselActiveIndicatorMode, WhenPredicate } from '@rokt/dcui-layout-schema';
+type CarouselIndicatorsProps = {
+    indicatorClasses?: {
+        progressIndicatorContainer?: string;
+        indicator?: string;
+        activeIndicator?: string;
+        seenIndicator?: string;
+    };
+    activeIndicatorMode?: CarouselActiveIndicatorMode | null;
+    activeIndicatorStyles?: NonNullable<NonNullable<DataImageCarouselModel<WhenPredicate>['styles']>['elements']>['activeIndicator'];
+    activeIndex: number;
+    count: number;
+    transitionDuration?: number;
+    testId?: string;
+};
+export declare const defaultIndicatorContainerStyles: NonNullable<NonNullable<NonNullable<DataImageCarouselModel<WhenPredicate>['styles']>['elements']>['progressIndicatorContainer']>;
+export declare const defaultIndicatorStyles: NonNullable<NonNullable<NonNullable<DataImageCarouselModel<WhenPredicate>['styles']>['elements']>['indicator']>;
+export declare const defaultActiveIndicatorStyles: NonNullable<NonNullable<NonNullable<DataImageCarouselModel<WhenPredicate>['styles']>['elements']>['activeIndicator']>;
+export declare function CarouselIndicators(props: CarouselIndicatorsProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/libraries/dcui-components/src/components/data-image-carousel/data-image-carousel.d.ts

@@ -0,0 +1,100 @@
+import { DataImageCarouselModel, WhenPredicate } from '@rokt/dcui-layout-schema';
+export interface DataImageCarouselProps {
+    /**
+     *  - `imageKey`: the key prefix for the image objects of the creative images contexts.
+     *  - `indicators`:
+     *    * `show`: boolean
+     *    * `activeIndicatorMode`: 'Progress' | 'Seen'
+     *  - `duration`: number - Time in milliseconds before changing to the next image.
+     *  - `transition`:
+     *    * `type`: 'SlideInOut' | 'FadeInOut' - Transition type.
+     *    * `settings`:
+     *      * `speed`: 'fast' | 'medium' | 'slow' - Speed of the transition.
+     *  - `a11yLabel`: string
+     *  - `styles`:
+     *    * `elements`:
+     *      * `own`:
+     *        - `container`
+     *        - `background`
+     *        - `border`
+     *        - `dimension`
+     *        - `flexChild`
+     *        - `spacing`
+     *      * `progressIndicatorContainer`:
+     *        - `container`
+     *        - `background`
+     *        - `border`
+     *        - `dimension`
+     *        - `flexChild`
+     *        - `spacing`
+     *      * `indicator`:
+     *        - `container`
+     *        - `background`
+     *        - `border`
+     *        - `dimension`
+     *        - `flexChild`
+     *        - `spacing`
+     *      * `seenIndicator`:
+     *        - `container`
+     *        - `background`
+     *        - `border`
+     *        - `dimension`
+     *        - `flexChild`
+     *        - `spacing`
+     *      * `activeIndicator`:
+     *        - `container`
+     *        - `background`
+     *        - `border`
+     *        - `dimension`
+     *        - `flexChild`
+     *        - `spacing`
+     *    * `transitions`:
+     *      - `type`: 'Conditional'
+     *      - `transition`:
+     *        * `predicates`: WhenPredicate[]
+     *        * `duration`: number
+     *        * `value`:
+     *          * `own`:
+     *            - `container`
+     *            - `background`
+     *            - `border`
+     *            - `dimension`
+     *            - `flexChild`
+     *            - `spacing`
+     *          * `progressIndicatorContainer`:
+     *            - `container`
+     *            - `background`
+     *            - `border`
+     *            - `dimension`
+     *            - `flexChild`
+     *            - `spacing`
+     *          * `indicator`:
+     *            - `container`
+     *            - `background`
+     *            - `border`
+     *            - `dimension`
+     *            - `flexChild`
+     *            - `spacing`
+     *          * `seenIndicator`:
+     *            - `container`
+     *            - `background`
+     *            - `border`
+     *            - `dimension`
+     *            - `flexChild`
+     *            - `spacing`
+     *          * `activeIndicator`:
+     *            - `container`
+     *            - `background`
+     *            - `border`
+     *            - `dimension`
+     *            - `flexChild`
+     *            - `spacing`
+     */
+    schema: DataImageCarouselModel<WhenPredicate>;
+    testId?: string;
+}
+/** The DataImageCarousel is an image node that displays all images prefixed with the given key in the creative images contexts. <br>
+ * It supports various formats and sizes.<br>
+ * *Where can we use this: __layout variant__*
+ * */
+export declare function DataImageCarousel(props: DataImageCarouselProps): import("react/jsx-runtime").JSX.Element | null;

package/dist/libraries/dcui-components/src/components/data-image-carousel/factory.d.ts

@@ -0,0 +1,2 @@
+import { LayoutSchemaModel } from '@rokt/dcui-layout-schema';
+export declare function tryMakeDataImageCarousel(schema: LayoutSchemaModel, testId?: string): JSX.Element | void;

package/dist/libraries/dcui-components/src/components/data-image-carousel/index.d.ts

@@ -0,0 +1,2 @@
+export * from './data-image-carousel';
+export * from './factory';

package/dist/modules/add-to-cart/src/components/escape-hatch/factory.d.ts

@@ -1,2 +1,2 @@
 import { LayoutSchemaModel } from '@rokt/dcui-layout-schema';
-export declare function tryMakeEscapeHatch(schema: LayoutSchemaModel): JSX.Element | undefined;
+export declare function tryMakeEscapeHatch(schema: LayoutSchemaModel, testId?: string): JSX.Element | undefined;

package/dist/modules/add-to-cart/src/components/scroll-to-target/scroll-to-target.d.ts

@@ -0,0 +1,56 @@
+import { LayoutStyle, BasicStateStylingBlock, BasicTextStyle } from '@rokt/dcui-layout-schema';
+export interface ScrollToTargetElements {
+    own: BasicStateStylingBlock<BasicTextStyle>[];
+    text: BasicStateStylingBlock<BasicTextStyle>[];
+    highlighted: BasicStateStylingBlock<BasicTextStyle>[];
+}
+export interface ScrollToTargetTarget {
+    key: string;
+    value: string;
+}
+export interface ScrollToTargetModel {
+    target: ScrollToTargetTarget;
+    text: string;
+    highlightedText: string;
+    styles?: null | LayoutStyle<ScrollToTargetElements, never>;
+    a11yLabel?: string;
+}
+export interface ScrollToTargetProps {
+    /**
+     * - `target`: object with key and value to identify the target element
+     *   - `key`: the attribute name (e.g., 'aria-label', 'data-testid', 'id')
+     *   - `value`: the attribute value to search for
+     * - `text`: the full text content (supports data mapping)
+     * - `highlightedText`: the portion of text that should be highlighted and clickable (supports data mapping)
+     * - `styles`:
+     *   * `elements`:
+     *     - `own`: styles for container
+     *       * `dimension`
+     *       * `flexChild`
+     *       * `spacing`
+     *       * `background`
+     *       * `text`
+     *     - `highlighted`: styles for highlighted (clickable) text
+     *       * `dimension`
+     *       * `flexChild`
+     *       * `spacing`
+     *       * `background`
+     *       * `text`
+     *     - `text`: styles for regular (non-highlighted) text
+     *       * `dimension`
+     *       * `flexChild`
+     *       * `spacing`
+     *       * `background`
+     *       * `text`
+     * - `a11yLabel`: optional accessibility label for screen readers
+     */
+    schema: ScrollToTargetModel;
+    testId?: string;
+}
+/**
+ * The ScrollToTarget is a specialized text component that displays text with a highlighted portion.
+ * Only the highlighted text is clickable and triggers smooth scrolling to a target element.
+ * The component supports separate styling for regular text and highlighted text portions.
+ * Target elements are identified by a configurable attribute key-value pair.
+ */
+export declare function ScrollToTarget({ schema, testId }: ScrollToTargetProps): import("react/jsx-runtime").JSX.Element;

package/dist/modules/add-to-cart/src/components/tooltip/tooltip.d.ts

@@ -0,0 +1,42 @@
+import { LayoutStyle, BasicStateStylingBlock, LayoutSchemaModel, DimensionStylingProperties, SpacingStylingProperties, BackgroundStylingProperties, BorderStylingProperties, ContainerStylingProperties } from '@rokt/dcui-layout-schema';
+export interface TooltipStyle {
+    container?: null | ContainerStylingProperties;
+    dimension?: null | DimensionStylingProperties;
+    spacing?: null | SpacingStylingProperties;
+    background?: null | BackgroundStylingProperties;
+    border?: null | BorderStylingProperties;
+}
+export interface TooltipElements {
+    own: BasicStateStylingBlock<TooltipStyle>[];
+}
+export interface TooltipModel {
+    children: LayoutSchemaModel[];
+    anchor: LayoutSchemaModel;
+    background?: LayoutSchemaModel;
+    styles?: null | LayoutStyle<TooltipElements, never>;
+    a11yLabel?: string;
+}
+export interface TooltipProps {
+    /**
+     * Tooltip component that displays rich content above an anchor element on hover/click
+     * - `children`: array of components to render as tooltip content (text, images, etc.)
+     * - `anchor`: single component to render as tooltip trigger (typically an info icon)
+     * - `background`: optional arrow/background component (no arrow if not provided)
+     * - `styles`:
+     *   * `elements`:
+     *     - `own`: styles for tooltip container
+     *       * `dimension`
+     *       * `spacing`
+     *       * `background`
+     *       * `container`
+     *       * `border`
+     * - `a11yLabel`: optional accessibility label for screen readers
+     */
+    schema: TooltipModel;
+    testId?: string;
+}
+/**
+ * The Tooltip is a specialized component that displays informational content above a trigger element.
+ * It supports both hover and click interactions for showing/hiding the tooltip content.
+ */
+export declare function Tooltip({ schema, testId }: TooltipProps): import("react/jsx-runtime").JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rokt/dcui-orchestrator",
-  "version": "0.2.1-rc.13",
+  "version": "0.2.1-rc.15",
   "description": "Rokt's DCUI rendering process",
   "main": "dist/index.cjs",
   "module": "dist/index.js",