@rokt/dcui-orchestrator 0.2.1-rc.4 → 0.2.1-rc.40

package/dist/modules/instant-purchase/src/components/checkbox/checkbox.d.ts

@@ -0,0 +1,78 @@
+import { BackgroundStylingProperties, BasicStateStylingBlock, BorderStylingProperties, ConditionalStyleTransition, DimensionStylingProperties, ContainerStylingProperties, FlexChildStylingProperties, LayoutStyle, SpacingStylingProperties, WhenPredicate, NonInteractableChildren } from '@rokt/dcui-layout-schema';
+import { ValidatorFieldConfig } from '../../validators';
+export type CheckboxValidators = 'required';
+export interface CheckboxStyles {
+    container?: null | ContainerStylingProperties;
+    background?: null | BackgroundStylingProperties;
+    border?: null | BorderStylingProperties;
+    dimension?: null | DimensionStylingProperties;
+    flexChild?: null | FlexChildStylingProperties;
+    spacing?: null | SpacingStylingProperties;
+}
+export interface CheckboxTransitions {
+    own?: null | CheckboxStyles;
+}
+export interface CheckboxElements {
+    own: BasicStateStylingBlock<CheckboxStyles>[];
+    checkbox?: BasicStateStylingBlock<CheckboxStyles>[];
+    label?: BasicStateStylingBlock<CheckboxStyles>[];
+    checkboxContainerError?: BasicStateStylingBlock<CheckboxStyles>[];
+    checkboxError?: BasicStateStylingBlock<CheckboxStyles>[];
+    labelError?: BasicStateStylingBlock<CheckboxStyles>[];
+    errorContent?: BasicStateStylingBlock<CheckboxStyles>[];
+}
+export interface CheckboxModel<Predicates> {
+    styles?: null | LayoutStyle<CheckboxElements, ConditionalStyleTransition<CheckboxTransitions, Predicates>>;
+    checkboxColor?: string;
+    value?: boolean;
+    labelTemplate?: NonInteractableChildren[];
+    errorContentTemplate?: NonInteractableChildren[];
+    validatorFieldConfig?: ValidatorFieldConfig<CheckboxValidators>;
+}
+export interface CheckboxProps {
+    /**
+     *  - `labelTemplate`, `errorContentTemplate`: it can accept below nodes,
+     *    * `Row`
+     *    * `FlowRow
+     *    * `Column`
+     *    * `ZStack`
+     *    * `BasicText`
+     *    * `StaticImage`
+     *    * `DataImage`
+     *    * `When`
+     *    * `DataIcon`
+     *    * `StaticIcon`
+     *    * `EscapeHatch`
+     *  - `checkboxColor`:
+     *    * `string`
+     *  - `value`:
+     *    * `boolean`
+     *  - `styles`:
+     *    * `elements`:
+     *      * `own`, `checkbox`, `label`, `checkboxContainerError`,
+     *        `checkboxError`, `labelError`, `errorContent`:
+     *        - `container`
+     *        - `background`
+     *        - `border`
+     *        - `dimension`
+     *        - `flexChild`
+     *        - `spacing`
+     *    * `transitions`:
+     *      - `type`: 'Conditional'
+     *      - `transition`:
+     *        * `predicates`: WhenPredicate[]
+     *        * `duration`: number
+     *        * `value`:
+     *          * `own`, `checkbox`, `label`, `checkboxContainerError`,
+     *            `checkboxError`, `labelError`, `errorContent`:
+     *            - `container`
+     *            - `background`
+     *            - `border`
+     *            - `dimension`
+     *            - `flexChild`
+     *            - `spacing`
+     */
+    schema: CheckboxModel<WhenPredicate>;
+    testId?: string;
+}
+export declare function Checkbox(props: CheckboxProps): import("react/jsx-runtime").JSX.Element;

package/dist/modules/instant-purchase/src/components/custom-state-validation-trigger-button/custom-state-validation-trigger-button.d.ts

@@ -0,0 +1,28 @@
+import { ContainerStylingProperties, BorderStylingProperties, DimensionStylingProperties, FlexChildStylingProperties, SpacingStylingProperties, BasicStateStylingBlock, LayoutStyle, ConditionalStyleTransition, WhenPredicate, NonInteractableChildren } from '@rokt/dcui-layout-schema';
+import { ValidatorTriggerConfig } from '../../validators';
+export interface CustomStateValidationTriggerButtonStyles {
+    container?: null | ContainerStylingProperties;
+    border?: null | BorderStylingProperties;
+    dimension?: null | DimensionStylingProperties;
+    flexChild?: null | FlexChildStylingProperties;
+    spacing?: null | SpacingStylingProperties;
+}
+export interface CustomStateValidationTriggerButtonElements {
+    own: BasicStateStylingBlock<CustomStateValidationTriggerButtonStyles>[];
+}
+export interface CustomStateValidationTriggerButtonTransitions {
+    own?: null | CustomStateValidationTriggerButtonStyles;
+}
+export interface CustomStateValidationTriggerButtonModel<Children, Predicates> {
+    styles?: null | LayoutStyle<CustomStateValidationTriggerButtonElements, ConditionalStyleTransition<CustomStateValidationTriggerButtonTransitions, Predicates>>;
+    children: Children[];
+    customStateKey: string;
+    customStateValue: number;
+    validatorTriggerConfig?: ValidatorTriggerConfig;
+    a11yLabel?: null | string;
+}
+export interface CustomStateValidationTriggerButtonProps {
+    schema: CustomStateValidationTriggerButtonModel<NonInteractableChildren, WhenPredicate>;
+    testId?: string;
+}
+export declare function CustomStateValidationTriggerButton(props: CustomStateValidationTriggerButtonProps): import("react/jsx-runtime").JSX.Element;

package/dist/modules/instant-purchase/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, isInline?: boolean): JSX.Element | undefined;

package/dist/modules/instant-purchase/src/components/escape-hatch/index.d.ts

@@ -0,0 +1 @@
+export * from './factory';

package/dist/modules/instant-purchase/src/components/inline-container/factory.d.ts

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

package/dist/modules/instant-purchase/src/components/inline-container/inline-container.d.ts

@@ -0,0 +1,55 @@
+import { BasicStateStylingBlock, LayoutSchemaModel, LayoutStyle, ConditionalStyleTransition, TextStylingProperties, WhenPredicate } from '@rokt/dcui-layout-schema';
+import { InlineContainerStyles } from '@rokt/dcui-layout-schema';
+interface InlineContainerTextStyles extends InlineContainerStyles {
+    text?: TextStylingProperties;
+}
+export interface InlineContainerTextElements {
+    own: BasicStateStylingBlock<InlineContainerTextStyles>[];
+}
+export interface InlineContainerTextTransitions {
+    own?: null | InlineContainerTextStyles;
+}
+export interface InlineContainerTextModel<Children, Predicates> {
+    a11yLabel?: null | string;
+    styles?: null | LayoutStyle<InlineContainerTextElements, ConditionalStyleTransition<InlineContainerTextTransitions, Predicates>>;
+    children: Children[];
+}
+interface InlineContainerProps<Children extends LayoutSchemaModel> {
+    /**
+     *  - `a11yLabel`: define a custom accessibility label for the screen reader
+     *  - `children`: it can accept below nodes,
+     *    * `BasicText (with inline styles only)`
+     *    * `StaticLink (with inline styles only)`
+     *    * `ToggleButtonStateTrigger (with inline styles only)`
+     *  - `styles`:
+     *    * `elements`:
+     *      - `own`:
+     *        * `container`
+     *        * `dimension`
+     *        * `flexChild`
+     *        * `spacing`
+     *        * `background`
+     *        * `border`
+     *    * `transitions`:
+     *      - `type`: 'Conditional'
+     *      - `transition`:
+     *        * `predicates`: WhenPredicate[]
+     *        * `duration`: number
+     *        * `value`:
+     *         - `own`:
+     *           * `container`
+     *           * `dimension`
+     *           * `flexChild`
+     *           * `spacing`
+     *           * `background`
+     *           * `border`
+     */
+    schema: InlineContainerTextModel<Children, WhenPredicate>;
+    testId?: string;
+}
+/** The Inline Container is a layout node that organises and aligns content horizontally,
+ * treating every child as an inline element.<br>
+ * *Where can we use this: __outer layout__, __layout variant__*
+ * */
+export declare function InlineContainer<Children extends LayoutSchemaModel>(props: InlineContainerProps<Children>): JSX.Element;
+export {};

package/dist/modules/instant-purchase/src/components/loading-spinner/loading-spinner.d.ts

@@ -20,9 +20,10 @@ export interface LoadingSpinnerConfig {
     stroke?: number;
     primaryColor?: string;
     secondaryColor?: string | null;
+    duration?: number;
+    mode?: 'dashed' | 'segmented';
     primaryRotation?: number;
     secondaryRotation?: number;
-    duration?: number;
     arcFraction?: number;
 }
 export interface LoadingSpinnerModel<Predicates> {

package/dist/modules/instant-purchase/src/components/offer-lifecycle-timer/offer-lifecycle-timer.d.ts

@@ -14,11 +14,13 @@ export interface OfferLifecycleTimerTransitions {
 }
 export interface OfferLifecycleTimerModel<Predicates> {
     durationInSeconds: number;
+    key: string;
     format?: 'M:SS' | 'S';
     styles?: LayoutStyle<OfferLifecycleTimerElements, ConditionalStyleTransition<OfferLifecycleTimerTransitions, Predicates>>;
 }
 export interface OfferLifecycleTimerProps {
     schema: OfferLifecycleTimerModel<WhenPredicate>;
+    isInline?: boolean;
     testId?: string;
 }
 export declare function OfferLifecycleTimer(props: OfferLifecycleTimerProps): import("react/jsx-runtime").JSX.Element;

package/dist/modules/instant-purchase/src/components/rich-text/factory.d.ts

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

package/dist/modules/instant-purchase/src/components/rich-text/rich-text.d.ts

@@ -0,0 +1,63 @@
+import { BasicStateStylingBlock, InLineTextStyle, RichTextStyle, ConditionalStyleTransition, RichTextTransitions, LayoutStyle, LinkOpenTarget, WhenPredicate } from '@rokt/dcui-layout-schema';
+export interface RichTextElements {
+    own: BasicStateStylingBlock<RichTextStyle>[];
+    link?: null | BasicStateStylingBlock<InLineTextStyle>[];
+}
+interface RichTextModel<Predicates> {
+    styles?: null | LayoutStyle<RichTextElements, ConditionalStyleTransition<RichTextTransitions, Predicates>>;
+    openLinks?: null | LinkOpenTarget;
+    value: string;
+}
+export interface RichTextProps {
+    /**
+     *  - `openLinks`: 'internally' | 'externally'
+     *  - `value`: the textual content. It supports:
+     *      * plain text;
+     *      * html:  `<em>`, `<strong>`, `<a>`, '<br>', '<u>';
+     *      * data expansion placeholder: e.g `%^DATA.creativeCopy.creative.title|^%`,
+     *         `%^DATA.creativeCopy.creative.copy|^%`,
+     *         `%^DATA.creativeLink.termsAndConditions|^%`,
+     *         `%^DATA.creativeLink.privacyPolicy|^%`.
+     *  - `styles`:
+     *    * `elements`:
+     *      - `own`:
+     *        * `dimension`
+     *        * `flexChild`
+     *        * `spacing`
+     *        * `background`
+     *        * `text`
+     *      - `link`:
+     *        * `text`
+     */
+    schema: RichTextModel<WhenPredicate>;
+    isInline?: boolean;
+    testId?: string;
+}
+export declare const sanitiseOptions: {
+    allowedTags: string[];
+    allowedAttributes: {
+        a: string[];
+        strong: never[];
+        em: never[];
+        br: never[];
+        u: never[];
+        p: never[];
+        ol: never[];
+        ul: never[];
+        li: never[];
+        span: never[];
+        h3: never[];
+        div: never[];
+        b: never[];
+    };
+    allowedSchemes: string[];
+};
+export declare const insaneExceptionCharacters: Map<string, string>;
+export declare const breaklinePattern: RegExp;
+/**The RichText override-Node is meant to be used for testing new element-styling only.<br>
+ * If no additional functionality is required for an instance of RichText, it is recommended to use the base node in plugin.<br>
+ * It also supports data expansion with namespace 'creativeCopy'.<br>
+ * *Where can we use this: __outer layout__, __layout variant__*
+ * */
+export declare function RichText(props: RichTextProps): import("react/jsx-runtime").JSX.Element | null;
+export {};

package/dist/modules/instant-purchase/src/models/state/instant-purchase.d.ts

@@ -1,6 +1,3 @@
 import { RequestFulfillmentDetails, PaymentRequestDetails } from '../../../../../libraries/domain/src/models';
 export type FulfillmentDetailsState = Partial<RequestFulfillmentDetails> | null;
 export type PaymentDetailsState = Partial<PaymentRequestDetails> | null;
-export type VariationSelectionTypes = 'variationColor' | 'variationSize' | 'variationUnits' | 'variationCount';
-export type VariationSelectionRequiredType = VariationSelectionTypes | 'default';
-export type VariationSelectionRequiredState = VariationSelectionRequiredType | null;

package/dist/modules/instant-purchase/src/reducers/index.d.ts

@@ -1,13 +1,12 @@
 import { GlobalActions } from '../../../../libraries/domain/src/behaviors';
 import { ChildLayoutActions, childLayoutsReducer, ChildLayoutsState, StaticData, staticDataReducer, DynamicData, dynamicDataReducer } from '@rokt/module-utils';
-import { CatalogSelectionState, FulfillmentDetailsState, VariationSelectionRequiredState } from '../models';
+import { CatalogSelectionState, FulfillmentDetailsState } from '../models';
 export type AppState = {
     staticData: StaticData;
     selectedItem: CatalogSelectionState;
     dynamicData: DynamicData;
     childLayouts: ChildLayoutsState;
     fulfillmentDetails: FulfillmentDetailsState;
-    variationSelectionRequired: VariationSelectionRequiredState;
 };
 export type StateActions = GlobalActions | ChildLayoutActions;
 export declare const appReducers: {
@@ -16,6 +15,5 @@ export declare const appReducers: {
     dynamicData: typeof dynamicDataReducer;
     childLayouts: typeof childLayoutsReducer;
     fulfillmentDetails: (state: FulfillmentDetailsState | undefined, action: import("redux").AnyAction) => FulfillmentDetailsState;
-    variationSelectionRequired: (state: VariationSelectionRequiredState | undefined, action: import("redux").AnyAction) => VariationSelectionRequiredState;
 };
 export declare function makeAppInitialState(data?: Partial<AppState>): AppState;

package/dist/modules/instant-purchase/src/reducers/instant-purchase/index.d.ts

@@ -1,3 +1,2 @@
 export * from './fulfillment-details';
 export * from './utils';
-export * from './variation-selection-required';

package/dist/modules/instant-purchase/src/sagas/index.d.ts

@@ -16,5 +16,7 @@ export declare const sagaActionTypes: {
     readonly SET_PARTNER_VALIDATION_STATUS: "GLOBAL/SET_PARTNER_VALIDATION_STATUS";
     readonly SET_GLOBAL_OFFER_DATA_CART: "GLOBAL/SET_GLOBAL_OFFER_DATA_CART";
     readonly LAUNCH_CHILD_LAYOUT: "GLOBAL/LAUNCH_CHILD_LAYOUT";
+    readonly INITIATE_CART_ITEM_EVENT: "GLOBAL/CART_ITEM_EVENT/INITIATE";
+    readonly CART_ITEM_RESPONSE: "GLOBAL/CART_ITEM_EVENT/RESPONSE";
 };
 export declare function appSagas(gateway: GlobalGateway, logger: (log: Log) => void): Generator<import("redux-saga/effects").AllEffect<import("redux-saga/effects").ForkEffect<void>>, void, unknown>;

package/dist/modules/instant-purchase/src/validators/index.d.ts

@@ -0,0 +1,3 @@
+export * from './validator-provider';
+export * from './types';
+export * from './utils';

package/dist/modules/instant-purchase/src/validators/types.d.ts

@@ -0,0 +1,8 @@
+export interface ValidatorTriggerConfig {
+    validatorFieldKeys: string[];
+}
+export interface ValidatorFieldConfig<Validators extends string> {
+    validationFieldKey: string;
+    validators: Validators[];
+    validateOnChange?: boolean;
+}

package/dist/modules/instant-purchase/src/validators/utils.d.ts

@@ -0,0 +1,3 @@
+import { Validator } from './validator-provider';
+import { ValidatorFieldConfig } from './types';
+export declare function getActiveValidators<ValidatorType extends string>(validatorFunctions: Record<ValidatorType, Validator>, validatorFieldConfig: ValidatorFieldConfig<ValidatorType> | undefined): Validator[];

package/dist/modules/instant-purchase/src/validators/validator-provider.d.ts

@@ -0,0 +1,24 @@
+import { ReactNode } from 'react';
+export type Validator = () => boolean;
+export interface ValidatorFieldData {
+    validators: Validator[];
+    isValid: boolean;
+}
+export type ValidatorMap = Record<string, ValidatorFieldData>;
+export interface ValidatorContextType {
+    registerValidators: (validatorFieldKey: string, validators: Validator[]) => void;
+    validateFieldKeys: (validatorFieldKey: string[]) => boolean;
+    getFieldKeyValidity: (validatorFieldKey: string) => boolean;
+}
+export declare const ValidatorContext: import("react").Context<ValidatorContextType | null>;
+/**
+ * React context provider that manages validation across multiple nodes.
+ * Stores a map of validator functions keyed by identifiers, tracks
+ * each node's validity, and exposes methods to register validators,
+ * validate nodes, and check validity.
+ */
+export declare function ValidatorProvider(props: {
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function useValidator(): ValidatorContextType;
+export declare function useRegisterValidators(validationFieldKey: string | undefined, validators: Validator[]): void;

package/dist/modules/layouts-xp-sandbox/src/sagas/index.d.ts

@@ -13,5 +13,7 @@ export declare const sagaActionTypes: {
     readonly SET_PARTNER_VALIDATION_STATUS: "GLOBAL/SET_PARTNER_VALIDATION_STATUS";
     readonly SET_GLOBAL_OFFER_DATA_CART: "GLOBAL/SET_GLOBAL_OFFER_DATA_CART";
     readonly LAUNCH_CHILD_LAYOUT: "GLOBAL/LAUNCH_CHILD_LAYOUT";
+    readonly INITIATE_CART_ITEM_EVENT: "GLOBAL/CART_ITEM_EVENT/INITIATE";
+    readonly CART_ITEM_RESPONSE: "GLOBAL/CART_ITEM_EVENT/RESPONSE";
 };
 export declare function appSagas(gateway: GlobalGateway, logger: (log: Log) => void): Generator<import("redux-saga/effects").AllEffect<import("redux-saga/effects").ForkEffect<never>>, void, unknown>;

package/dist/modules/standard-marketing/src/sagas/index.d.ts

@@ -13,5 +13,7 @@ export declare const sagaActionTypes: {
     readonly SET_PARTNER_VALIDATION_STATUS: "GLOBAL/SET_PARTNER_VALIDATION_STATUS";
     readonly SET_GLOBAL_OFFER_DATA_CART: "GLOBAL/SET_GLOBAL_OFFER_DATA_CART";
     readonly LAUNCH_CHILD_LAYOUT: "GLOBAL/LAUNCH_CHILD_LAYOUT";
+    readonly INITIATE_CART_ITEM_EVENT: "GLOBAL/CART_ITEM_EVENT/INITIATE";
+    readonly CART_ITEM_RESPONSE: "GLOBAL/CART_ITEM_EVENT/RESPONSE";
 };
 export declare function appSagas(gateway: GlobalGateway, logger: (log: Log) => void): Generator<import("redux-saga/effects").AllEffect<import("redux-saga/effects").ForkEffect<never>>, void, unknown>;

package/dist/modules/standard-marketing/src/sagas/offer-engagement/channels.d.ts

@@ -6,7 +6,10 @@ export type ChildPluginResult = 'SUCCESS' | 'UNSPECIFIED' | 'CLOSED';
 export declare function createChildPluginChannel(childPlugin: Pick<ChildPlugin, 'onClose' | 'onEvent'>): EventChannel<ChildPluginResult>;
 export type RealtimeFulfillmentEvent = {
     eventName: string;
-    data: Record<string, string>;
+    data: NestedStringRecord;
 };
 export declare function makeRealtimeFulfillmentEventMessageChannel(gateway: Pick<GlobalGateway, 'onEvent'>): EventChannel<RealtimeFulfillmentEvent>;
+export type NestedStringRecord = {
+    [key: string]: string | NestedStringRecord;
+};
 export {};

package/package.json

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

package/dist/modules/instant-purchase/src/reducers/instant-purchase/variation-selection-required/index.d.ts

@@ -1 +0,0 @@
-export * from './reducer';

package/dist/modules/instant-purchase/src/reducers/instant-purchase/variation-selection-required/reducer.d.ts

@@ -1,4 +0,0 @@
-import { AnyAction } from '@reduxjs/toolkit';
-import { VariationSelectionRequiredState } from '../../../models';
-export declare function makeInitialVariationSelectionRequiredState(): VariationSelectionRequiredState;
-export declare const variationSelectionRequiredReducer: (state: VariationSelectionRequiredState | undefined, action: AnyAction) => VariationSelectionRequiredState;