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

package/dist/libraries/domain/src/behaviors/offer-engagement.d.ts

@@ -19,13 +19,19 @@ export interface OfferEngagementUrlPayload extends PluginCreativeUrlResponseOpti
     referralCreativeID?: string;
     creativeInstanceGuid?: string;
 }
+export interface OfferEngagementProductItemResponsePayload extends OfferEngagementUrlPayload {
+    catalogItemId: string;
+    productSku: string;
+    catalogId: string;
+}
 export type OfferEngagementCaptureOnlyPayload = PluginCreativeCaptureOnlyResponseOption;
 export type OfferEngagementExternalPayload = PluginCreativeExternalResponseOption;
-export type OfferEngagementPayload = OfferEngagementFulfillmentPayload | OfferEngagementUrlPayload | OfferEngagementCaptureOnlyPayload | OfferEngagementExternalPayload;
+export type OfferEngagementPayload = OfferEngagementFulfillmentPayload | OfferEngagementUrlPayload | OfferEngagementCaptureOnlyPayload | OfferEngagementExternalPayload | OfferEngagementProductItemResponsePayload;
 export declare function isFulfillmentPayload(value: unknown): value is OfferEngagementFulfillmentPayload;
 export declare function isExternalPayload(value: unknown): value is OfferEngagementExternalPayload;
 export declare function isUrlPayload(value: unknown): value is OfferEngagementUrlPayload;
 export declare function isCaptureOnlyPayload(value: unknown): value is OfferEngagementCaptureOnlyPayload;
+export declare function isProductItemResponsePayload(value: unknown): value is OfferEngagementProductItemResponsePayload;
 export declare function isRealTimeFulfillmentReferral(response: OfferEngagementPayload | (OfferEngagementPayload & {
     offerPositionIndex: number;
 })): response is OfferEngagementPayload & {

package/dist/libraries/domain/src/models/plugin/plugin-catalog-item.d.ts

@@ -1,3 +1,4 @@
+import { PluginCreativeUrlResponseOption } from './plugin-creative-response-option';
 import { PluginImage } from './plugin-image';
 export interface PluginCatalogItem {
     instanceGuid: string;
@@ -9,6 +10,7 @@ export interface PluginCatalogItem {
     description: string;
     disclaimer?: string;
     images?: Record<string, PluginImage>;
+    responseOptionsMap?: Record<string, PluginCreativeUrlResponseOption>;
     priceFormatted: string;
     price: number;
     providerData?: string;
@@ -22,6 +24,8 @@ export interface PluginCatalogItem {
     positiveResponseText: string;
     negativeResponseText: string;
     url?: string;
+    productSku?: string;
+    catalogId?: string;
 }
 export interface PluginCatalogItemImage {
     url: string;

package/dist/libraries/domain/src/models/plugin/plugin-creative-response-option.d.ts

@@ -2,7 +2,7 @@ import { PluginConversionType } from './plugin-conversion-type';
 import { PluginCreativeResponseActionType } from './plugin-creative-response-action-type';
 import { PluginSignalType } from './plugin-signal-type';
 import { PluginUrlBehavior } from './plugin-url-behavior';
-export type PluginCreativeResponseOption = PluginCreativeFulfillmentResponseOption | PluginCreativeUrlResponseOption | PluginCreativeCaptureOnlyResponseOption | PluginCreativeExternalResponseOption;
+export type PluginCreativeResponseOption = PluginCreativeFulfillmentResponseOption | PluginCreativeUrlResponseOption | PluginCreativeCaptureOnlyResponseOption | PluginCreativeExternalResponseOption | PluginCatalogItemUrlResponseOption;
 export interface PluginCreativeFulfillmentResponseOption {
     id: string;
     action: PluginCreativeResponseActionType.Fulfillment;
@@ -46,6 +46,10 @@ export interface PluginCreativeCaptureOnlyResponseOption {
     urlBehavior?: PluginUrlBehavior;
     creativeInstanceGuid?: string;
 }
+export interface PluginCatalogItemUrlResponseOption extends PluginCreativeUrlResponseOption {
+    catalogItemId: string;
+    externalId: string;
+}
 export interface PluginCreativeExternalResponseOption {
     id: string;
     action: PluginCreativeResponseActionType.External;

package/dist/libraries/domain/src/models/plugin/plugin-signal-type.d.ts

@@ -1,5 +1,6 @@
 export declare const enum PluginSignalType {
     SignalResponse = "SignalResponse",
     SignalGatedResponse = "SignalGatedResponse",
-    SignalSecondaryResponse = "SignalSecondaryResponse"
+    SignalSecondaryResponse = "SignalSecondaryResponse",
+    SignalProductItemResponse = "SignalProductItemResponse"
 }

package/dist/libraries/domain/src/models/signals.d.ts

@@ -2,7 +2,7 @@ import { PluginCreativeResponseActionType } from './plugin';
 export type Signals = (CoreSignals | CartSignals) & {
     creativeInstanceGuid?: string;
 };
-export type CoreSignals = LoadStart | LoadComplete | Activation | Impression | Viewed | Response | Dismissal | UserInteraction | InstantPurchaseDismissal;
+export type CoreSignals = LoadStart | LoadComplete | Activation | Impression | Viewed | Response | Dismissal | UserInteraction | InstantPurchaseDismissal | ProductItemResponse;
 export type ResponseActionPayload = CaptureOnlyAction | UrlAction | ExternalAction | FulfillmentAction;
 export type CartSignals = CartItemInstantPurchaseInitiated | CartItemInstantPurchase | CartItemInstantPurchaseFailure | CartItemQuantitySelected;
 export type UniqueSignal = LoadStart | LoadComplete | Activation | Impression | Viewed | Response | Dismissal | UserInteraction | InstantPurchaseDismissal | CartItemInstantPurchaseInitiated | CartItemInstantPurchase | CartItemInstantPurchaseFailure;
@@ -10,7 +10,7 @@ export declare enum InitiatedBy {
     DCUI = "DCUI",
     Partner = "partner"
 }
-export type RepeatableSignal = CartItemQuantitySelected;
+export type RepeatableSignal = CartItemQuantitySelected | ProductItemResponse;
 export interface LoadComplete {
     name: 'SignalLoadComplete';
     parentGuid: string;
@@ -89,6 +89,16 @@ export interface UserInteraction {
     action: string;
     context: string;
 }
+export interface ProductItemResponse {
+    name: 'SignalProductItemResponse';
+    parentGuid: string;
+    objectData: {
+        catalogItemId: string;
+        productSku: string;
+        catalogId: string;
+        accountId: string;
+    };
+}
 export interface CaptureOnlyAction {
     name: PluginCreativeResponseActionType.CaptureOnly;
     creativeInstanceGuid?: string;

package/dist/libraries/orchestrator/src/sagas/offer-engagement/sagas.d.ts

@@ -6,7 +6,7 @@ import { ContextService, PartnerInteractionService } from '../../../../plugin-ut
 import { WindowRef } from '../../../../layout-renderer-utils/src/index';
 type NextValues = WindowRef | CallEffect | null | undefined;
 type OfferCompletionResult = 'SUCCESS' | 'UNSPECIFIED' | 'ERROR' | 'EXPLICIT_DISMISSAL' | 'IMPLICIT_DISMISSAL' | 'END';
-declare const handleUrlResponse: (args_0: PluginCreativeResponseOption, args_1: ContextService, args_2: import("@rokt/plugin").SenderReceiver) => Generator<TakeEffect | NextValues | PutEffect<RaiseSignal | ClosePlugin | ReportError>, OfferCompletionResult, NextValues>;
+declare const handleUrlResponse: (args_0: PluginCreativeResponseOption, args_1: ContextService, args_2: import("@rokt/plugin").SenderReceiver, args_3: OfferEngagement) => Generator<TakeEffect | NextValues | PutEffect<RaiseSignal | ClosePlugin | ReportError>, OfferCompletionResult, NextValues>;
 export declare function processOfferResponse(dependencies: {
     context: ContextService;
     partner: PartnerInteractionService;

package/dist/libraries/plugin-utils/src/translate-config.d.ts

@@ -1,4 +1,4 @@
-import { PluginCreative, PluginCreativeResponseOption, PluginCreativeResponseActionType, PluginSignalType, PluginUrlBehavior, LayoutCreative, LayoutCreativeResponseOption, PluginConversionType } from '../../domain/src/models';
+import { PluginCreative, PluginCreativeResponseOption, PluginCreativeResponseActionType, PluginSignalType, PluginUrlBehavior, LayoutCreative, LayoutCreativeResponseOption, PluginConversionType, PluginCatalogItemUrlResponseOption } from '../../domain/src/models';
 export declare const CREATIVE_RESPONSE_ENUM_MAP: {
     action: {
         CaptureOnly: PluginCreativeResponseActionType;
@@ -24,6 +24,6 @@ export declare const CREATIVE_RESPONSE_ENUM_MAP: {
 };
 export declare function makeTranslateErrorLogs(configurationName: string, instanceGuid: string, isChildLayout?: boolean): Error;
 export declare function translateLayoutCreative(layoutCreative: LayoutCreative, isChildLayout?: boolean): PluginCreative;
-export declare function translateLayoutResponse(response: LayoutCreativeResponseOption): PluginCreativeResponseOption;
+export declare function translateLayoutResponse(response: LayoutCreativeResponseOption): Exclude<PluginCreativeResponseOption, PluginCatalogItemUrlResponseOption>;
 export type ParseJsonCategory = 'LayoutRootLayoutSchema' | 'LayoutSlotLayoutVariant' | 'ChildLayoutRootSchema';
 export declare function parseLayoutJsonAs<T>(json: string, category: ParseJsonCategory, instanceGuid: string): T;

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

@@ -0,0 +1,64 @@
+import { BackgroundStylingProperties, BorderStylingProperties, ConditionalStyleTransition, ContainerStylingProperties, DimensionStylingProperties, FlexChildStylingProperties, LayoutStyle, NonInteractableChildren, SpacingStylingProperties, StatelessStylingBlock, WhenPredicate } from '@rokt/dcui-layout-schema';
+export interface DismissInstantPurchaseButtonStyles {
+    background?: null | BackgroundStylingProperties;
+    border?: null | BorderStylingProperties;
+    container?: null | ContainerStylingProperties;
+    dimension?: null | DimensionStylingProperties;
+    flexChild?: null | FlexChildStylingProperties;
+    spacing?: null | SpacingStylingProperties;
+}
+export interface DismissInstantPurchaseButtonTransitions {
+    own?: null | DismissInstantPurchaseButtonStyles;
+}
+export interface DismissInstantPurchaseButtonElements {
+    own: StatelessStylingBlock<DismissInstantPurchaseButtonStyles>[];
+}
+export interface DismissInstantPurchaseButtonModel<Children, Predicates> {
+    a11yLabel?: null | string;
+    styles?: null | LayoutStyle<DismissInstantPurchaseButtonElements, ConditionalStyleTransition<DismissInstantPurchaseButtonTransitions, Predicates>>;
+    children: Children[];
+}
+export interface DismissInstantPurchaseButtonProps {
+    /**
+     *  - `a11yLabel`: define a custom accessibility label for a screen reader
+     *  - `targetStep`: Checkout transaction step to transition to when element is clicked
+     *  - `children`: it can accept below nodes,
+     *    * `Row`
+     *    * `Column`
+     *    * `ZStack`
+     *    * `FlowRow`
+     *    * `BasicText`
+     *    * `StaticImage`
+     *    * `StaticIcon`
+     *    * `DataImage`
+     *    * `DataIcon`
+     *    * `When`
+     *    * `InlineContainer`
+     *    * `EscapeHatch`
+     *  - `styles`:
+     *    * `elements`:
+     *      - `own`:
+     *        * `background`
+     *        * `border`
+     *        * `container`
+     *        * `dimension`
+     *        * `flexChild`
+     *        * `spacing`
+     *    * `transitions`:
+     *      - `type`: 'Conditional'
+     *      - `transition`:
+     *        * `predicates`: WhenPredicate[]
+     *        * `duration`: number
+     *        * `value`:
+     *         - `own`:
+     *           * `container`
+     *           * `dimension`
+     *           * `flexChild`
+     *           * `spacing`
+     *           * `background`
+     *           * `border`
+     */
+    schema: DismissInstantPurchaseButtonModel<NonInteractableChildren, WhenPredicate>;
+    testId?: string;
+}
+export declare function DismissInstantPurchaseButton(props: DismissInstantPurchaseButtonProps): import("react/jsx-runtime").JSX.Element;

package/dist/modules/standard-marketing/src/components/catalog-response-button/catalog-response-button.d.ts

@@ -0,0 +1,43 @@
+import { CatalogResponseButtonModel, NonInteractableChildren, WhenPredicate } from '@rokt/dcui-layout-schema';
+export interface CatalogResponseButtonProps {
+    /**
+     *  - `responseKey`: the key of the response option to use.
+     *  - `children`: it can accept below nodes,
+     *    * `Row`
+     *    * `Column`
+     *    * `ZStack`
+     *    * `BasicText`
+     *    * `StaticImage`
+     *    * `DataImage`
+     *    * `When`
+     *  - `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: CatalogResponseButtonModel<NonInteractableChildren, WhenPredicate>;
+    testId?: string;
+}
+/**The CatalogResponse is a button node that generate a Call-to-Action button
+ * for performing response actions for catalog items
+ * *Where can we use this: __layout variant__*
+ */
+export declare function CatalogResponseButton(props: CatalogResponseButtonProps): import("react/jsx-runtime").JSX.Element | undefined;

package/dist/modules/standard-marketing/src/components/catalog-response-button/factory.d.ts

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

package/package.json

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