@rokt/dcui-orchestrator 1.2.1-rc.6 → 1.2.1-rc.60

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

@@ -9,4 +9,35 @@ export declare function getCartItem(state: {
 }, cartItemId: string): PluginCartItem | null;
 export declare function getOfferCartItems(state: AppState): Array<PluginCartItem>;
 export declare function getOfferCartItemsQuantity(state: AppState): number;
+/**
+ * The offer limit the offer's catalog items carry: the cap on the total
+ * quantity across all the offer's cart items, read as the first positive
+ * whole number across the items, the given item's own attributes first
+ * (readOfferQuantityLimit). Undefined when no item carries one, so 0 and an
+ * absent key mean no additional offer limit.
+ */
+export declare function getOfferQuantityLimit(state: AppState, catalogItem?: Pick<PluginCatalogItem, 'copy'>): number | undefined;
+/**
+ * The cap on the total quantity across the offer's cart items: the smaller
+ * of the offer's existing maxTotalItemsQtyInOffer and the offer limit its
+ * items carry (getOfferQuantityLimit), or Infinity when neither is set. Both
+ * apply, in every path that adds to the offer.
+ */
+export declare function getOfferTotalCap(state: AppState, catalogItem?: Pick<PluginCatalogItem, 'copy'>): number;
+/**
+ * The quantity the ordinary update can still add to this item: the cap the
+ * update keeps (getUpdateCap: the offer capacity left by the other items
+ * under the offer cap, the item's own cap and its existing per-item cap)
+ * less the quantity held. An exact item's own rules do not cap it, so the
+ * ordinary update keeps its existing cap alone for it, as before; the exact
+ * path bypasses that cap and the offer capacity bounds it
+ * (getCartItemApplicableCap).
+ */
 export declare function getCartItemMaxAddableQuantity(state: AppState, catalogItem: PluginCatalogItem): number;
+/**
+ * The cap this item's quantity can reach under its quantity rules beside the
+ * existing item and offer caps, the offer limit the items carry among them.
+ * With no static data the offer's existing cap is unbounded, so the item's
+ * own limit and cap, and an offer limit on the item itself, still apply.
+ */
+export declare function getCartItemApplicableCap(state: AppState, catalogItem: PluginCatalogItem): number;

package/dist/modules/add-to-cart/src/selectors/catalogItems/selectors.d.ts

@@ -4,6 +4,14 @@ export declare function getCatalogItems(state: AppState): Array<PluginCatalogIte
 export declare function getCatalogItem(state: AppState, catalogItemId: string): PluginCatalogItem | null;
 export declare function getCatalogItemByCartItemId(state: AppState, cartItemId: string): PluginCatalogItem | null;
 export declare function getPreselectedCatalogItems(state: AppState): Array<PluginCatalogItem> | null;
+/**
+ * The preselected catalog items the cart does not know yet. An id already in
+ * the cart, as an item or as a null, came from the orchestrator's copy of this
+ * position's cart at mount: what the module published before it was unmounted,
+ * or a partner update retained while it was. Both are newer than the payload,
+ * so the payload's preselection applies to the rest alone.
+ */
+export declare function getPendingPreselectedCatalogItems(state: AppState): Array<PluginCatalogItem> | null;
 export declare function getTotalPreselectedQuantity(state: AppState): number;
 export declare function isCatalogItemForcedUpsell(state: AppState, catalogItemId: string): boolean;
 export declare function isDeliveryDetailsRequired(state: AppState, catalogItemId?: string): boolean;

package/dist/modules/instant-purchase/src/actions/instant-purchase.d.ts

@@ -42,6 +42,8 @@ export interface PushTaxAndShippingPayload {
 }
 export interface MarkTaxAndShippingPendingPayload {
     cacheKey: string;
+    requestId: string;
+    preserveEstimate?: boolean;
 }
 export declare const INITIATE_INSTANT_PURCHASE = "INSTANT_PURCHASE/INITIATE";
 export type InitiateInstantPurchase = {
@@ -92,6 +94,8 @@ export type SetActiveTaxAndShippingKey = {
 };
 export type InitiateTaxAndShippingPayload = {
     catalogItem: PluginCatalogItem;
+    force?: boolean;
+    requestId?: string;
 };
 export declare const INITIATE_TAX_AND_SHIPPING = "INSTANT_PURCHASE/INITIATE_TAX_AND_SHIPPING";
 export type InitiateTaxAndShipping = {

package/dist/modules/instant-purchase/src/components/catalog-device-pay-button/catalog-device-pay-button.d.ts

@@ -112,7 +112,15 @@ export interface CatalogDevicePayButtonProps {
     testId?: string;
 }
 type CatalogDevicePayButtonStyles = NonNullable<CatalogDevicePayButtonProps['schema']['styles']>;
+/**
+ * Whether the backend marked this catalog item as purchasable with PayPal. The
+ * flag rides in the item's `providerData` JSON and is omitted when false, so
+ * anything other than an explicit `true` (absent, malformed, wrong type) means
+ * the item is not PayPal-enabled.
+ */
+export declare function isPayPalEnabled(providerData: string | undefined): boolean;
 export declare function getCatalogDevicePayButtonStyles(styles: CatalogDevicePayButtonProps['schema']['styles']): CatalogDevicePayButtonStyles;
+export declare function getPayPalButtonStyles(styles: CatalogDevicePayButtonProps['schema']['styles']): CatalogDevicePayButtonStyles;
 /**The CatalogDevicePayButton is a button node that generates a Call-to-Action button
  * for initiating a device payment transaction using the associated payment provider.
  * *Where can we use this: __layout variant__*

package/dist/modules/instant-purchase/src/components/catalog-selectors-stacked/catalog-selectors-stacked.d.ts

@@ -1,6 +1,36 @@
 import React from 'react';
 import { CatalogSelectorsStackedModel, LayoutSchemaModel, WhenPredicate } from '@rokt/dcui-layout-schema';
 export interface CatalogSelectorsStackedProps<Template extends LayoutSchemaModel> {
+    /**
+     *  - `default`: the template rendered once per variant dimension.
+     *    `CatalogDropdown` includes its own visible dimension label. Do not add a
+     *    separate label node. Each render also exposes tokens for custom content:
+     *    * `%^DATA.variantAttribute.attributeId^%`: the dimension id, e.g.
+     *      `color`. It comes from the merchant's variant option key and is
+     *      neither normalised nor guaranteed lowercase or single-word, so
+     *      `shoe_size` reaches the shopper verbatim. Apply casing with the node's
+     *      `text.textTransform` rather than transforming the value, so `When`
+     *      comparisons stay stable.
+     *    * `%^DATA.variantAttribute.hasMultipleOptions^%`: `"true"` or `"false"`.
+     *      `CatalogDropdown` renders neither label nor control for a single option,
+     *      and the whole template for that dimension is hidden, so it takes no
+     *      space in the stack.
+     *    Tokens from the enclosing scope stay resolvable alongside these.
+     *
+     *    Keep the dropdown mounted. A `When` that encloses it would stop it mounting, and
+     *    a dropdown that never mounts never registers its validator field key —
+     *    a trigger that then resolves zero keys fails closed, blocking the CTA
+     *    with nothing on screen to explain it.
+     *
+     *    Bind custom text with `BasicText`. `RichText` sends the value through the
+     *    HTML sanitiser, which throws on markup-shaped input; the node is then
+     *    dropped by its error boundary.
+     *  - `dropdown`: accepted by the layout schema, currently ignored — this
+     *    component only ever renders `default`.
+     *  - `styles`:
+     *    * `elements`:
+     *      - `own`
+     */
     schema: CatalogSelectorsStackedModel<Template, WhenPredicate>;
     testId?: string;
 }

package/dist/modules/instant-purchase/src/constants/device-pay-error.d.ts

@@ -1,2 +1,2 @@
-export { DEVICE_PAY_ERROR_STATE_KEY, DEVICE_PAY_ERROR_HIDDEN, DEVICE_PAY_ERROR_RETRYABLE_DECLINE, } from '../../../../libraries/domain/src/behaviors';
+export { DEVICE_PAY_ERROR_STATE_KEY, DEVICE_PAY_PAYPAL_ERROR_STATE_KEY, DEVICE_PAY_ERROR_HIDDEN, DEVICE_PAY_ERROR_RETRYABLE_DECLINE, } from '../../../../libraries/domain/src/behaviors';
 export { RETRYABLE_DEVICE_PAY_ERROR_MESSAGE } from '../../../../libraries/dcui-components/src/index';

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

@@ -1,5 +1,7 @@
 export type DevicePayAvailabilityResponse = {
     applePay?: boolean;
     afterpay?: boolean;
+    paypal?: boolean;
+    googlePay?: boolean;
 };
 export type DevicePayAvailabilityState = DevicePayAvailabilityResponse | null;

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

@@ -24,6 +24,8 @@ export interface TaxAndShippingData {
 }
 export interface TaxAndShippingEntry {
     isPending: boolean;
+    requestId?: string;
+    purchaseId?: string;
     taxAndShippingData?: TaxAndShippingData;
 }
 export interface TaxAndShippingState {
@@ -34,6 +36,7 @@ export declare const INSTANT_PURCHASE_INITIATE_TAX_AND_SHIPPING_EVENT = "INSTANT
 export declare const INSTANT_PURCHASE_TAX_AND_SHIPPING_RESPONSE = "INSTANT_PURCHASE_TAX_AND_SHIPPING_RESPONSE";
 export interface InstantPurchaseInitiateTaxAndShippingEventPayload {
     cacheKey: string;
+    requestId?: string;
     totalUpsellPrice: number;
     currency: string;
     upsellItems: UpsellItem[];
@@ -65,6 +68,7 @@ export interface InstantPurchaseTaxAndShippingResponseEnvelope {
 }
 export interface InstantPurchaseTaxAndShippingResponsePayload {
     cacheKey: string;
+    requestId?: string;
     timestamp: string;
     sessionId: string;
     response?: InstantPurchaseTaxAndShippingResponseEnvelope;

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

@@ -1,6 +1,6 @@
 import { CallEffect, PutEffect, ChannelTakeEffect } from 'redux-saga/effects';
 import { EventChannel } from 'redux-saga';
-import { Log, PaymentMethodType, PluginCatalogItem, ShippingAttributes } from '../../../../../libraries/domain/src/models';
+import { Log, PaymentMethodType, PluginCatalogItem, PrepareDevicePayEventPayload, ShippingAttributes } from '../../../../../libraries/domain/src/models';
 import { GlobalGateway } from '../../../../../libraries/module-connector/src/main';
 import { OfferLifecycle } from '../../../../../libraries/domain/src/behaviors';
 import { DevicePayPurchaseContext, DevicePayInteractionPayload, InitiateDevicePayAction, DevicePayResponsePayload, DevicePayResponse, DevicePayAvailableAction, DevicePayAvailablePayload } from '../../actions';
@@ -120,12 +120,7 @@ export declare function prepareDevicePay(gateway: GlobalGateway, logger: (log: L
     type: string;
     payload: {
         name: string;
-        body: {
-            stripeAccountId: string | undefined;
-            merchantName: string | undefined;
-            countryCode: string | undefined;
-            currency: string | undefined;
-        };
+        body: PrepareDevicePayEventPayload;
     };
 }>, void, AppState | undefined>;
 export declare function processDevicePayResponse(logger: (log: Log) => void, action: DevicePayResponse): Generator<CallEffect<void> | PutEffect<{

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

@@ -1,14 +1,28 @@
 import { CallEffect, ForkEffect, PutEffect, RaceEffect, SelectEffect } from 'redux-saga/effects';
-import { Log } from '../../../../../libraries/domain/src/models';
+import { Log, PluginCatalogItem, ShippingAttributes } from '../../../../../libraries/domain/src/models';
 import { GlobalGateway } from '../../../../../libraries/module-connector/src/main';
 import { StaticData } from '../../../../../libraries/module-utils/src/index';
-import { InitiateInstantPurchase, InstantPurchasePartnerResponse } from '../../actions/instant-purchase';
+import { InitiateInstantPurchase, InstantPurchasePartnerResponse, PushTaxAndShipping } from '../../actions/instant-purchase';
 import { AppState } from '../../reducers';
 import { TriggerSelectItemAction, InstantPurchaseWsdkResponse, UpsellItemInstantPurchasePartnerResponse } from '../../actions';
 export declare const INSTANT_PURCHASE_RESPONSE_TTL = 60000;
 export declare function processSelectDefaultOrOnlyCatalogItem(): Generator<SelectEffect | PutEffect | CallEffect, void, AppState | undefined>;
 export declare function processSelectCatalogItem(action: TriggerSelectItemAction): Generator<SelectEffect | PutEffect | CallEffect, void, never>;
-export declare function processInstantPurchaseCartItem(gateway: GlobalGateway, logger: (log: Log) => void, action: InitiateInstantPurchase): Generator<SelectEffect | CallEffect | PutEffect | ForkEffect, void, AppState | undefined>;
+export declare function processInstantPurchaseCartItem(gateway: GlobalGateway, logger: (log: Log) => void, action: InitiateInstantPurchase): Generator<SelectEffect | CallEffect | PutEffect | ForkEffect, void, AppState | undefined | {
+    result?: PushTaxAndShipping;
+    selectionChanged?: unknown;
+    offerEnd?: unknown;
+}>;
+/** Visible for testing the cancellation conditions while a quote is pending. */
+export declare function waitForPurchaseTaxRetry(cacheKey: string, requestId: string, catalogItem: PluginCatalogItem, shippingAttributes: Partial<ShippingAttributes>): Generator<RaceEffect<import("redux-saga/effects").TakeEffect>, {
+    result?: PushTaxAndShipping;
+    selectionChanged?: unknown;
+    offerEnd?: unknown;
+}, {
+    result?: PushTaxAndShipping;
+    selectionChanged?: unknown;
+    offerEnd?: unknown;
+}>;
 export declare function handleInstantPurchasePartnerResponse(logger: (log: Log) => void, action: InstantPurchasePartnerResponse): Generator<SelectEffect | CallEffect | PutEffect, void, StaticData | undefined>;
 export declare function handleUpsellItemInstantPurchasePartnerResponse(logger: (log: Log) => void, action: UpsellItemInstantPurchasePartnerResponse): Generator<SelectEffect | CallEffect | PutEffect, void, StaticData | undefined>;
 export declare function handleInstantPurchaseWsdkResponse(action: InstantPurchaseWsdkResponse): Generator<PutEffect, void, never>;

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

@@ -14,9 +14,11 @@ type PayPalEventPayload = {
 } | {
     type: 'DEVICE_PAY_FAILURE';
     reason?: string;
+    retryable?: boolean;
 } | {
     type: 'DEVICE_PAY_CANCEL';
 };
+export declare function createPayPalEventChannel(gateway: GlobalGateway, logger: (log: Log) => void): EventChannel<PayPalEventPayload>;
 export declare function listenForPayPalEvents(channel: EventChannel<PayPalEventPayload>, logger: (log: Log) => void, offerPositionIndex: number): Generator<ChannelTakeEffect<PayPalEventPayload> | CallEffect<void> | PutEffect | SelectEffect, void, PayPalEventPayload | (PayPalPurchaseContext | null)>;
 export declare function preparePayPal(gateway: GlobalGateway, logger: (log: Log) => void): Generator<CallEffect<void> | SelectEffect | PutEffect<{
     type: string;

package/dist/modules/instant-purchase/src/sagas/tax-and-shipping/sagas.d.ts

@@ -1,24 +1,28 @@
 import { CallEffect, PutEffect, RaceEffect, SelectEffect, ForkEffect } from 'redux-saga/effects';
-import { InstantPurchaseTaxAndShippingResponsePayload, TaxAndShippingErrors, TaxAndShippingPricing } from '../../models';
+import { InstantPurchaseTaxAndShippingResponsePayload, TaxAndShippingState, TaxAndShippingErrors } from '../../models';
 import { GlobalGateway } from '../../../../../libraries/module-connector/src/main';
 import { Log } from '../../../../../libraries/domain/src/models';
 import { AppState } from '../../reducers';
 import { InitiateTaxAndShipping } from '../../actions';
 export declare const pendingRequestKeys: Set<string>;
+export declare function resetTaxAndShippingRequestTrackingForTest(): void;
+export declare function createTaxAndShippingRequestId(): string;
 export declare function watchTaxAndShippingChannel(gateway: GlobalGateway, logger: (log: Log) => void): Generator<RaceEffect<unknown> | CallEffect, void, {
     response: InstantPurchaseTaxAndShippingResponsePayload | undefined;
     offerEnd: unknown;
 } | undefined>;
-export declare function initiateTaxAndShippingRequest(_gateway: GlobalGateway, logger: (log: Log) => void, action: InitiateTaxAndShipping): Generator<SelectEffect | CallEffect | PutEffect | ForkEffect, void, AppState['fulfillmentDetails'] | boolean>;
-export declare function processTaxAndShippingResponse(payload: InstantPurchaseTaxAndShippingResponsePayload): Generator<PutEffect<{
+export declare function initiateTaxAndShippingRequest(_gateway: GlobalGateway, logger: (log: Log) => void, action: InitiateTaxAndShipping): Generator<SelectEffect | CallEffect | PutEffect | ForkEffect, void, AppState['fulfillmentDetails'] | boolean | string | null>;
+export declare function processTaxAndShippingResponse(payload: InstantPurchaseTaxAndShippingResponsePayload): Generator<SelectEffect | PutEffect, void, unknown>;
+export declare function timeoutPendingCacheEntry(cacheKey: string, requestId: string, logger: (log: Log) => void): Generator<CallEffect<void> | SelectEffect | CallEffect<true> | PutEffect<{
     type: string;
     payload: {
         cacheKey: string;
         taxAndShippingEntry: {
-            isPending: false;
             taxAndShippingData: {
-                error: TaxAndShippingErrors.REQUEST_FAILED;
+                error: TaxAndShippingErrors;
             };
+            requestId?: string | undefined;
+            isPending: false;
         };
     };
 }> | PutEffect<{
@@ -33,18 +37,4 @@ export declare function processTaxAndShippingResponse(payload: InstantPurchaseTa
         key: "offerComplete";
         value: number;
     };
-}> | PutEffect<{
-    type: string;
-    payload: {
-        cacheKey: string;
-        taxAndShippingEntry: {
-            isPending: false;
-            taxAndShippingData: {
-                taxAndShippingPricing: TaxAndShippingPricing;
-            };
-        };
-    };
-}> | PutEffect<{
-    type: string;
-    payload: string | null;
-}>, void, unknown>;
+}>, void, TaxAndShippingState>;

package/dist/modules/instant-purchase/src/selectors/catalog-selection/index.d.ts

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

package/dist/modules/instant-purchase/src/selectors/catalog-selection/selectors.d.ts

@@ -0,0 +1,7 @@
+import { SyncedCatalogSelection } from '../../../../../libraries/domain/src/models';
+import { AppState } from '../../reducers';
+/**
+ * The selection a child layout mirrors. A full-item choice (a dropdown or the
+ * default item) has no recorded attribute choices, so they are derived from it.
+ */
+export declare function getSyncedCatalogSelection(state: AppState): SyncedCatalogSelection;

package/dist/modules/instant-purchase/src/selectors/device-pay-availability/selectors.d.ts

@@ -2,7 +2,9 @@ import { DevicePayAvailabilityState } from '../../models';
 import { AppState } from '../../reducers';
 export declare function getDevicePayAvailability(state: AppState): DevicePayAvailabilityState;
 export declare function isApplePayAvailable(state: AppState): boolean;
+export declare function isGooglePayAvailable(state: AppState): boolean;
 export declare function isAfterpayAvailable(state: AppState): boolean;
+export declare function isPayPalAvailable(state: AppState): boolean;
 /**
  * Gate for the "no remaining usable payment option" branch in
  * processDevicePayAvailable. True when every entry in supportedPaymentMethods

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

@@ -1,3 +1,4 @@
+export * from './catalog-selection';
 export * from './creative';
 export * from './device-pay-availability';
 export * from './paypal-transaction-details';

package/dist/modules/instant-purchase/src/selectors/tax-and-shipping/selectors.d.ts

@@ -1,3 +1,11 @@
+import { PluginCatalogItem } from '../../../../../libraries/domain/src/models';
 import { TaxAndShippingEntry } from '../../models';
 import { AppState } from '../../reducers';
+export type TaxAndShippingDisplayState = 'waitingForSelection' | 'idle' | 'loading' | 'ready' | 'error';
+/** A stacked selector can set a preview item before all visible choices are made. */
+export declare function isCatalogSelectionIncomplete(state: AppState): boolean;
+export declare function getTaxAndShippingDisplayState(state: AppState): TaxAndShippingDisplayState;
 export declare function getActiveTaxAndShipping(state: AppState): TaxAndShippingEntry;
+export declare function isTaxAndShippingDisplayPending(entry: TaxAndShippingEntry): boolean;
+export declare function getTaxAndShippingForCatalogItem(state: AppState, catalogItem: Pick<PluginCatalogItem, 'catalogItemId'> & Partial<Pick<PluginCatalogItem, 'copy'>> & Partial<Pick<PluginCatalogItem, 'price' | 'preSelectedQuantity' | 'currency'>>): TaxAndShippingEntry | undefined;
+export declare function isCatalogItemTaxAndShippingReady(state: AppState, catalogItem: Pick<PluginCatalogItem, 'catalogItemId' | 'copy'> & Partial<Pick<PluginCatalogItem, 'price' | 'preSelectedQuantity' | 'currency'>>): boolean;

package/dist/modules/instant-purchase/src/utils/compute-selections-for-item.d.ts

@@ -0,0 +1,7 @@
+import { CatalogItemGroupAttribute } from '../../../../libraries/domain/src/models';
+/**
+ * Derives the per-attribute option labels that resolve to a catalog item: for
+ * each attribute, the option whose catalogItemIds contains the item. Used to
+ * pre-fill stacked dropdowns and to describe a full-item selection.
+ */
+export declare function computeSelectionsForItem(attributes: CatalogItemGroupAttribute[], catalogItemId: string): Record<string, string>;

package/dist/modules/instant-purchase/src/utils/create-tax-and-shipping-cache-key.d.ts

@@ -1,4 +1,8 @@
 import { ShippingAttributes } from '../../../../libraries/domain/src/models';
 export declare function createTaxAndShippingCacheKey(shippingAttributes: Partial<ShippingAttributes>, catalogItems: {
     catalogItemId: string;
+    price?: number;
+    preSelectedQuantity?: number;
+    currency?: string;
+    copy?: Record<string, string>;
 }[]): string;

package/dist/modules/instant-purchase/src/utils/parse-non-negative-monetary-amount.d.ts

@@ -0,0 +1 @@
+export declare function parseNonNegativeMonetaryAmount(value: unknown): number | null;

package/dist/modules/instant-purchase/src/utils/requires-tax-and-shipping-initialization.d.ts

@@ -0,0 +1,2 @@
+import { PluginCatalogItem } from '../../../../libraries/domain/src/models';
+export declare function requiresTaxAndShippingInitialization(catalogItem: Pick<PluginCatalogItem, 'copy'>): boolean;

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

@@ -12,10 +12,11 @@ export declare function getRealtimeFulfillmentSuccessCallback(gateway: GlobalGat
     payload: {
         name: string;
         body: {
+            rewardHandoff: boolean | undefined;
+            adID?: string;
             rclid: string | undefined;
             accountID: string;
             referralCreativeID: string | undefined;
-            rewardHandoff: boolean | undefined;
         };
     };
 }>, void, unknown>) | undefined;