@rokt/dcui-orchestrator 1.2.1-rc.56 → 1.2.1-rc.57

package/dist/libraries/module-connector/src/models/gateway.d.ts

@@ -21,6 +21,11 @@ export type ModuleEventListener = {
     callback: (...data: Array<unknown>) => void;
 };
 export interface IGateway<State extends object, Action extends object> {
+    /** Latest authoritative cart for this offer during the subscription handoff. */
+    getOfferCart?: () => Array<{
+        cartItemId: string;
+        quantity: number;
+    }>;
     onEvent(...moduleEventListeners: Array<ModuleEventListener>): () => void;
     onGlobalStateChange(callback: (globalState: State) => void): () => void;
     onInteractivityChange(callback: (interactivity: Interactivity) => void): () => void;

package/dist/libraries/orchestrator/src/actions/global-offer-data-state.d.ts

@@ -1,4 +1,5 @@
 export declare const SET_GLOBAL_OFFER_DATA_CART = "GLOBAL_OFFER_DATA_STATE/SET_CART";
+export declare const RETAIN_PARTNER_CART_ITEM = "GLOBAL_OFFER_DATA_STATE/RETAIN_PARTNER_CART_ITEM";
 export interface SetGlobalOfferDataCart {
     type: typeof SET_GLOBAL_OFFER_DATA_CART;
     payload: SetGlobalOfferDataCartPayload;
@@ -10,4 +11,13 @@ export interface SetGlobalOfferDataCartPayload {
         quantity: number;
     }>;
 }
-export type GlobalOfferDataStateActions = SetGlobalOfferDataCart;
+export interface RetainPartnerCartItem {
+    type: typeof RETAIN_PARTNER_CART_ITEM;
+    payload: RetainPartnerCartItemPayload;
+}
+export interface RetainPartnerCartItemPayload {
+    offerPositionIndex: number;
+    cartItemId: string;
+    quantity: number;
+}
+export type GlobalOfferDataStateActions = SetGlobalOfferDataCart | RetainPartnerCartItem;

package/dist/libraries/orchestrator/src/actions/index.d.ts

@@ -29,8 +29,10 @@ export declare const stateActionTypes: {
     readonly UPDATE_GROUP_SIZE: "PROGRESSION/UPDATE_GROUP_SIZE";
     readonly SET_SLOTS: "SLOTS/SET";
     readonly ADD_LOADED_MODULE: "MODULE/ADD_LOADED";
+    readonly UPDATE_CART_LISTENER_COUNT: "MODULE/UPDATE_CART_LISTENER_COUNT";
     readonly SET_DOMAIN_STATE: "DOMAIN_STATES/SET";
     readonly SET_GLOBAL_OFFER_DATA_CART: "GLOBAL_OFFER_DATA_STATE/SET_CART";
+    readonly RETAIN_PARTNER_CART_ITEM: "GLOBAL_OFFER_DATA_STATE/RETAIN_PARTNER_CART_ITEM";
     readonly LAYOUT_UPDATE: "LAYOUT/UPDATE";
     readonly UPDATE_ACTIVE_BREAKPOINT: "BREAKPOINT/UPDATE_ACTIVE";
     readonly INITIALISE_BREAKPOINT: "BREAKPOINT/INITIALISE";

package/dist/libraries/orchestrator/src/actions/module.d.ts

@@ -3,7 +3,15 @@ export type AddLoadedModuleAction = {
     type: typeof ADD_LOADED_MODULE;
     payload: string;
 };
-export type ModuleActions = AddLoadedModuleAction;
+export declare const UPDATE_CART_LISTENER_COUNT = "MODULE/UPDATE_CART_LISTENER_COUNT";
+export type UpdateCartListenerCount = {
+    type: typeof UPDATE_CART_LISTENER_COUNT;
+    payload: {
+        offerPositionIndex: number;
+        delta: 1 | -1;
+    };
+};
+export type ModuleActions = AddLoadedModuleAction | UpdateCartListenerCount;
 export declare const LOAD_MODULES = "MODULE/LOAD";
 export interface LoadModules {
     type: typeof LOAD_MODULES;

package/dist/libraries/orchestrator/src/cart-listener-gateway.d.ts

@@ -0,0 +1,7 @@
+import { GlobalGatewayFactory } from '../../module-connector/src/main';
+import { UpdateCartListenerCount } from './actions';
+/** Track real subscriptions, which outlive DOM collapse, rather than visible slots. */
+export declare function trackCartListeners(factory: GlobalGatewayFactory, dispatch: (action: UpdateCartListenerCount) => void, readCart?: (position: number) => Array<{
+    cartItemId: string;
+    quantity: number;
+}>): GlobalGatewayFactory;

package/dist/libraries/orchestrator/src/models/state/global-offer-data-state.d.ts

@@ -1,3 +1,9 @@
 export type GlobalOfferDataState = {
     [key: string]: unknown;
 };
+export type OfferStateCartItem = {
+    cartItemId: string;
+    quantity: number;
+};
+export declare function offerStateKey(position: number): string;
+export declare function readOfferStateCart(state: GlobalOfferDataState, position: number): Array<OfferStateCartItem>;

package/dist/libraries/orchestrator/src/models/state/module.d.ts

@@ -1,3 +1,4 @@
 export type ModuleState = {
     loadedModules: Array<string>;
+    cartListenerCounts: Record<number, number>;
 };

package/dist/libraries/orchestrator/src/sagas/partner-cart-sync/sagas.d.ts

@@ -1,6 +1,6 @@
 import { CallEffect, ChannelTakeEffect, PutEffect, SelectEffect } from 'redux-saga/effects';
 import { Cart } from '@rokt/partner-integration';
 import { PartnerInteractionService } from '../../../../plugin-utils/src/index';
-import { SlotState } from '../../models';
-export declare function reconcilePartnerCartItem(message: Cart.V2.UpdateCartItemPartnerMessageBody): Generator<SelectEffect | PutEffect, void, SlotState>;
+import { AppState } from '../../models';
+export declare function reconcilePartnerCartItem(message: Cart.V2.UpdateCartItemPartnerMessageBody): Generator<SelectEffect | PutEffect, void, AppState>;
 export declare function listenForPartnerCartItemSync(partner: PartnerInteractionService): Generator<ChannelTakeEffect<Cart.V2.UpdateCartItemPartnerMessageBody> | CallEffect | PutEffect, void, Cart.V2.UpdateCartItemPartnerMessageBody>;

package/dist/libraries/orchestrator/src/selectors/global-offer-data-state/selectors.d.ts

@@ -1,7 +1,14 @@
-import { GlobalOfferDataState } from '../../models';
+import { GlobalOfferDataState, OfferStateCartItem } from '../../models';
 export declare function getTotalCartQty(state: {
     globalOfferDataState: GlobalOfferDataState;
 }): number;
 export declare function getOfferState(state: {
     globalOfferDataState: GlobalOfferDataState;
 }, position: number): unknown;
+/**
+ * The cart held for one position: what its module last published, with
+ * the partner updates retained while it was unmounted.
+ */
+export declare function getOfferStateCart(state: {
+    globalOfferDataState: GlobalOfferDataState;
+}, position: number): Array<OfferStateCartItem>;

package/dist/libraries/saga-utils/src/utils/index.d.ts

@@ -1,4 +1,5 @@
 export * from './catalog-translator';
+export * from './quantity-rules';
 export * from './stringify';
 export * from './take-in-sequence';
 export * from './take-one';

package/dist/{modules/add-to-cart/src/utils/quantity-rules → libraries/saga-utils/src/utils}/quantity-rules.d.ts

@@ -1,4 +1,4 @@
-import { PluginCatalogItem } from '../../../../../libraries/domain/src/models';
+import { PluginCatalogItem } from '../../../domain/src/models';
 /**
  * The keys under which the transport emits the quantity rules on a catalog
  * item's `copy` map, each mapped to the name the plugin uses for it. The
@@ -133,6 +133,16 @@ export declare function getOfferCap(caps: Pick<CapInputs, 'offerCap' | 'offerLim
  * there.
  */
 export declare function getApplicableCap(rules: QuantityRules, caps: CapInputs): number;
+/**
+ * The cap the ordinary update keeps for an item's quantity: the smaller of
+ * the applicable cap (getApplicableCap) and the item's existing per-item cap,
+ * which the ordinary update keeps for an exact item too (the exact path
+ * alone bypasses it). A quantity at or below it can be held, and an increase
+ * above it is refused, wherever a partner update is applied to a cart: the
+ * module's own update and the hold the orchestrator keeps for a module that
+ * is not mounted read this one cap, so the two never disagree on a quantity.
+ */
+export declare function getUpdateCap(rules: QuantityRules, caps: CapInputs): number;
 /**
  * The correction applied to a typed quantity when it is committed and to an
  * existing quantity on the first render. Zero and anything that is not a

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

@@ -1,4 +1,5 @@
 import { PluginCatalogItem } from '../../../../libraries/domain/src/models';
+import { CartState } from '../models';
 export type UpdateCartPayload = {
     catalogItem: PluginCatalogItem;
     quantity: number;
@@ -8,4 +9,9 @@ export type UpdateCart = {
     type: typeof UPDATE_CART;
     payload: UpdateCartPayload;
 };
-export type CartActions = UpdateCart;
+export declare const HYDRATE_RETAINED_CART = "CART/HYDRATE_RETAINED";
+export type HydrateRetainedCart = {
+    type: typeof HYDRATE_RETAINED_CART;
+    payload: CartState;
+};
+export type CartActions = UpdateCart | HydrateRetainedCart;

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

@@ -1,4 +1,5 @@
 import { AnyAction } from '@reduxjs/toolkit';
 import { CartState, AppSettingsCartItemState } from '../../models';
-export declare function makeInitialCartState(cart: Array<AppSettingsCartItemState>): CartState;
+import { PluginCatalogItem } from '../../../../../libraries/domain/src/models';
+export declare function makeInitialCartState(cart: Array<AppSettingsCartItemState>, catalogItems?: Array<PluginCatalogItem>): CartState;
 export declare function cartReducer(state: CartState | undefined, action: AnyAction): CartState;

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

@@ -27,4 +27,4 @@ export declare const sagaActionTypes: {
     readonly VALIDATE_FORM_FIELDS: "GLOBAL/VALIDATE_FORM_FIELDS";
     readonly REPORT_ERROR: "ERROR/REPORT";
 };
-export declare function appSagas(gateway: GlobalGateway, logger: (log: Log) => void): Generator<import("redux-saga/effects").AllEffect<import("redux-saga/effects").ForkEffect<void>>, void, unknown>;
+export declare function appSagas(gateway: GlobalGateway, logger: (log: Log) => void): Generator<import("redux-saga/effects").CallEffect<void> | import("redux-saga/effects").ForkEffect<never> | import("redux-saga/effects").AllEffect<import("redux-saga/effects").ForkEffect<void>>, void, unknown>;

package/dist/modules/add-to-cart/src/sagas/update-cart-item/sagas.d.ts

@@ -1,4 +1,5 @@
-import { CallEffect, CancelledEffect, ChannelTakeEffect, PutEffect, SelectEffect, TakeEffect } from 'redux-saga/effects';
+import { EventChannel } from 'redux-saga';
+import { CallEffect, ChannelTakeEffect, PutEffect, SelectEffect, TakeEffect, FlushEffect, ForkEffect } from 'redux-saga/effects';
 import { GlobalActions } from '../../../../../libraries/domain/src/behaviors';
 import { Log, PluginCartItem, PluginCatalogItem } from '../../../../../libraries/domain/src/models';
 import { GlobalGateway } from '../../../../../libraries/module-connector/src/main';
@@ -7,5 +8,6 @@ import { CatalogItemExactResponse, CatalogItemResponse } from '../../actions';
 export declare function processPreselectedCatalogItems(logger: (log: Log) => void): Generator<SelectEffect | CallEffect | PutEffect, void, PluginCartItem | null | undefined>;
 export declare function processUpdateCartItem(gateway: GlobalGateway, logger: (log: Log) => void, action: CatalogItemResponse): Generator<SelectEffect | CallEffect | PutEffect, void, undefined | GlobalActions | string>;
 export declare function processSetExactCartItem(gateway: GlobalGateway, logger: (log: Log) => void, action: CatalogItemExactResponse): Generator<SelectEffect | CallEffect | PutEffect, void, unknown>;
-export declare function listenForUpdateCartItemPartnerMessage(gateway: GlobalGateway, logger: (log: Log) => void): Generator<TakeEffect | CallEffect | CancelledEffect | ChannelTakeEffect<Cart.V2.UpdateCartItemPartnerMessageBody>, void, Cart.V2.UpdateCartItemPartnerMessageBody>;
+export declare function listenForUpdateCartItemPartnerMessage(gateway: GlobalGateway, logger: (log: Log) => void, preparedChannel?: EventChannel<Cart.V2.UpdateCartItemPartnerMessageBody>): Generator<TakeEffect | CallEffect | PutEffect | SelectEffect | ChannelTakeEffect<Cart.V2.UpdateCartItemPartnerMessageBody>, void, Cart.V2.UpdateCartItemPartnerMessageBody>;
+export declare function initializePartnerCartSync(gateway: GlobalGateway, logger: (log: Log) => void): Generator<CallEffect | FlushEffect<Cart.V2.UpdateCartItemPartnerMessageBody> | ForkEffect, void, Array<Cart.V2.UpdateCartItemPartnerMessageBody>>;
 export declare function processPartnerUpdateCartItem(message: Cart.V2.UpdateCartItemPartnerMessageBody): Generator<SelectEffect | PutEffect, void, PluginCatalogItem | string | number | null | undefined>;

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

@@ -25,14 +25,13 @@ export declare function getOfferQuantityLimit(state: AppState, catalogItem?: Pic
  */
 export declare function getOfferTotalCap(state: AppState, catalogItem?: Pick<PluginCatalogItem, 'copy'>): number;
 /**
- * The quantity the ordinary update can still add to this item: the smaller
- * of the offer capacity left under the offer cap (getOfferTotalCap) and the
- * item's own cap less the quantity held. The own cap is the item's max,
- * where it sets one, beside its existing per-item cap (getItemCap). An item
- * with no max of its own keeps its existing cap alone, as before the rules.
- * 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).
+ * 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;
 /**

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/package.json

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

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

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

package/dist/modules/add-to-cart/src/utils/quantity-rules/index.d.ts

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