@rokt/dcui-orchestrator 0.3.1-rc.7 → 0.3.1-rc.9

package/dist/libraries/domain/src/behaviors/child-layout-bridge.d.ts

@@ -0,0 +1,36 @@
+import { SyncedGlobalState } from '../models';
+import { GlobalActions } from './global-actions';
+export * from './safe-state-key';
+/**
+ * Wire protocol between a child layout plugin and its launching host module,
+ * carried over the WSDK parent-interaction channel. Receivers ignore unknown
+ * event names and envelope versions so a version-skewed bundle pair degrades
+ * to pre-bridge behavior.
+ */
+export declare const CHILD_LAYOUT_BRIDGE_EVENTS: {
+    /** child → host: a GlobalAction to re-dispatch in the launching module */
+    readonly DISPATCH_BEHAVIOR: "CHILD_LAYOUT/DISPATCH_BEHAVIOR";
+    /** host → child: the offer-scoped synced GlobalState slices */
+    readonly STATE_SYNC: "CHILD_LAYOUT/STATE_SYNC";
+    /** child → host: bridge sagas are subscribed; reply with a fresh snapshot */
+    readonly READY: "CHILD_LAYOUT/READY";
+};
+export declare const CHILD_LAYOUT_BRIDGE_VERSION = 1;
+export interface ChildBridgeEnvelope<Payload> {
+    version: typeof CHILD_LAYOUT_BRIDGE_VERSION;
+    payload: Payload;
+}
+export type DispatchBehaviorEnvelope = ChildBridgeEnvelope<GlobalActions>;
+export type StateSyncEnvelope = ChildBridgeEnvelope<SyncedGlobalState>;
+export type ReadyEnvelope = ChildBridgeEnvelope<null>;
+export declare function makeBridgeEnvelope<Payload>(payload: Payload): ChildBridgeEnvelope<Payload>;
+/**
+ * The behaviors a child layout may dispatch into its host (keys) and their
+ * structural gates (values, co-located with each behavior's definition). The
+ * host warns-and-drops anything unknown or malformed — skew degradation and
+ * bug detection, not a security boundary. To add a forwardable behavior:
+ * write its gate next to its type, add one entry here.
+ */
+export declare const FORWARDABLE_BEHAVIOR_GUARDS: Readonly<Record<string, (payload: unknown) => boolean>>;
+/** Version gate for anything read off the wire. */
+export declare function isBridgeEnvelope(value: unknown): value is ChildBridgeEnvelope<unknown>;

package/dist/libraries/domain/src/behaviors/custom-states.d.ts

@@ -7,3 +7,4 @@ export interface SetCustomStatePayload {
     key: string;
     value: number;
 }
+export declare function isValidSetCustomStatePayload(payload: unknown): payload is SetCustomStatePayload;

package/dist/libraries/domain/src/behaviors/form-state.d.ts

@@ -64,3 +64,8 @@ export interface ValidateFormFields {
     payload: ValidateFormFieldsPayload;
 }
 export type FormStateBehaviors = RegisterFormField | UnregisterFormField | SetFormFieldValue | SetFormFieldTouched | ValidateFormFields;
+export declare function isValidRegisterFormFieldPayload(payload: unknown): payload is RegisterFormFieldPayload;
+export declare function isValidSetFormFieldValuePayload(payload: unknown): payload is SetFormFieldValuePayload;
+/** Shared by UNREGISTER_FORM_FIELD and SET_FORM_FIELD_TOUCHED. */
+export declare function isValidFormFieldRefPayload(payload: unknown): payload is UnregisterFormFieldPayload;
+export declare function isValidValidateFormFieldsPayload(payload: unknown): payload is ValidateFormFieldsPayload;

package/dist/libraries/domain/src/behaviors/index.d.ts

@@ -12,6 +12,7 @@ export * from './open-link';
 export * from './partner-validation';
 export * from './global-offer-data-state';
 export * from './child-layout';
+export * from './child-layout-bridge';
 export * from './cart-item-event';
 export * from './dismiss-overlay';
 export * from './trigger-action';

package/dist/libraries/domain/src/behaviors/safe-state-key.d.ts

@@ -0,0 +1,3 @@
+/** Unsafe in dynamic object-path writes: `__proto__` assignment walks the prototype chain. */
+export declare const FORBIDDEN_STATE_KEYS: ReadonlySet<string>;
+export declare function isSafeStateKey(key: unknown): key is string;

package/dist/libraries/domain/src/behaviors/trigger-action.d.ts

@@ -17,3 +17,4 @@ export interface TriggerAction {
         offerPositionIndex?: number;
     };
 }
+export declare function isValidTriggerActionPayload(payload: unknown): payload is TriggerAction['payload'];

package/dist/libraries/domain/src/models/global-state.d.ts

@@ -16,4 +16,10 @@ export interface GlobalState {
     firedEvents: Partial<Record<LayoutEvent, boolean>>;
     formStates: FormStatesState;
 }
+/**
+ * The GlobalState slices a host syncs down to a child layout; `breakpoint`
+ * is absent because the child computes its own from its iframe width.
+ */
+export type SyncedGlobalState = Pick<GlobalState, 'progression' | 'customStates' | 'domainStates' | 'firedEvents' | 'formStates'>;
+export declare function makeSyncedGlobalState(state?: Partial<SyncedGlobalState>): SyncedGlobalState;
 export declare function makeGlobalState(state?: Partial<GlobalState>): GlobalState;

package/dist/libraries/domain/src/models/plugin/plugin-child-layout-model.d.ts

@@ -1,5 +1,6 @@
 import { LayoutSchemaModel, LayoutDisplayPreset, LayoutSettings, ChildRootSchemaModel, WhenPredicate } from '@rokt/dcui-layout-schema';
 import { Fonts } from '@rokt/plugin';
+import { SyncedGlobalState } from '../global-state';
 import { PluginOffer } from './plugin-offer';
 export interface PluginChildLayoutModel<ChildRootLayoutSchema = ChildRootSchemaModel<LayoutSchemaModel, LayoutDisplayPreset, LayoutSettings, WhenPredicate>> {
     instanceGuid: string;
@@ -11,6 +12,13 @@ export interface PluginChildLayoutModel<ChildRootLayoutSchema = ChildRootSchemaM
         text?: Record<string, string>;
     };
     fonts?: Fonts;
+    /**
+     * Offer-scoped state snapshot at launch time, hydrating the child's synced
+     * slices so its first render is correct before the first STATE_SYNC push.
+     * Absent when the host predates the child-layout bridge — the child then
+     * renders from its own local state (pre-bridge behavior).
+     */
+    globalState?: SyncedGlobalState;
 }
 export declare function makeChildLayoutRootSchemaModel(data?: Partial<ChildRootSchemaModel<LayoutSchemaModel, LayoutDisplayPreset, LayoutSettings, WhenPredicate>>): ChildRootSchemaModel<LayoutSchemaModel, LayoutDisplayPreset, LayoutSettings, WhenPredicate>;
 export declare function makePluginChildLayoutModel(data?: Partial<PluginChildLayoutModel>): PluginChildLayoutModel;

package/dist/libraries/layout-renderer-utils/src/sagas/index.d.ts

@@ -7,7 +7,6 @@ export * from './signal';
 export * from './error';
 export * from './custom-states';
 export * from './form-states';
-export * from './trigger-action';
 export * from './metric';
 export * from './open-link';
 export * from './overlay';

package/dist/libraries/module-utils/src/sagas/child-layouts/sagas.d.ts

@@ -1,5 +1,17 @@
 import { LaunchChildLayout } from '../../../../domain/src/behaviors';
-import { CallEffect, PutEffect, SelectEffect } from 'redux-saga/effects';
+import { CallEffect, CancelledEffect, ChannelTakeEffect, ForkEffect, PutEffect, RaceEffect, SelectEffect } from 'redux-saga/effects';
 import { GlobalGateway } from '../../../../module-connector/src/main';
-import { Log } from '../../../../domain/src/models';
-export declare function launchChildLayout(gateway: GlobalGateway, logger: (log: Log) => void, action: LaunchChildLayout): Generator<PutEffect | CallEffect | SelectEffect, void, never>;
+import { Log, PluginOffer } from '../../../../domain/src/models';
+import { BasicObject, ChildPluginInterface } from '@rokt/plugin';
+export declare function launchChildLayout(gateway: GlobalGateway, logger: (log: Log) => void, action: LaunchChildLayout): Generator<PutEffect | CallEffect | SelectEffect | ForkEffect, void, never>;
+type BridgeChannelMessage = {
+    kind: 'ready';
+} | {
+    kind: 'behavior';
+    envelope: unknown;
+};
+export declare function childLayoutBridge(gateway: GlobalGateway, logger: (log: Log) => void, childPlugin: ChildPluginInterface<BasicObject>, offerContext: {
+    offer: PluginOffer;
+    offerPositionIndex: number | undefined;
+}): Generator<PutEffect | CallEffect | CancelledEffect | RaceEffect<ChannelTakeEffect<BridgeChannelMessage> | CallEffect>, void, never>;
+export {};

package/dist/libraries/module-utils/src/sagas/error-codes.d.ts

@@ -1 +1,2 @@
 export declare const FAILED_TO_LAUNCH_CHILD_LAYOUT = "FAILED_TO_LAUNCH_CHILD_LAYOUT";
+export declare const DROPPED_CHILD_BEHAVIOR = "DROPPED_CHILD_BEHAVIOR";

package/dist/libraries/module-utils/src/selectors/static-data/selectors.d.ts

@@ -5,3 +5,6 @@ export declare function getOfferData(state: {
 export declare function getSchemaVersion(state: {
     staticData: StaticData;
 }): string | undefined;
+export declare function getOfferPositionIndex(state: {
+    staticData: StaticData;
+}): number | undefined;

package/dist/libraries/plugin-utils/src/plugin-service/index.d.ts

@@ -3,13 +3,15 @@ import { ContextService } from './context';
 import { MetricsService } from './metrics';
 import { DisplayService } from './display';
 import { PartnerInteractionService } from './partner-interaction';
+import { ParentInteractionService } from './parent-interaction';
 import { ConfigService } from './config';
 import { ChildPluginService } from './child-plugin';
-export { ContextService, MetricsService, DisplayService, PartnerInteractionService, ConfigService, ChildPluginService, };
+export { ContextService, MetricsService, DisplayService, PartnerInteractionService, ParentInteractionService, ConfigService, ChildPluginService, };
 export interface PluginService<T> {
     contextService: ContextService;
     configService: ConfigService<T>;
     partnerInteractionService: PartnerInteractionService;
+    parentInteractionService: ParentInteractionService;
     rdnService: RDNInterface;
     metricsService: MetricsService;
     errorService: ErrorInterface;

package/dist/libraries/plugin-utils/src/plugin-service/parent-interaction.d.ts

@@ -0,0 +1,3 @@
+import { ParentInteractionInterface, PluginInterface } from '@rokt/plugin';
+export type ParentInteractionService = ParentInteractionInterface;
+export declare const makeParentInteractionService: (pluginInterface: Pick<PluginInterface, 'parentInteraction'>) => ParentInteractionService;

package/package.json

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

package/dist/libraries/layout-renderer-utils/src/sagas/trigger-action/index.d.ts

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

package/dist/libraries/layout-renderer-utils/src/sagas/trigger-action/sagas.d.ts

@@ -1,12 +0,0 @@
-import { PutEffect } from 'redux-saga/effects';
-import { TriggerAction } from '../../../../domain/src/behaviors';
-/**
- * Handles TRIGGER_ACTION in a root-scoped store (the child layout renderer)
- * where no offer/module gateway exists. The general actions (Close,
- * SetCustomState) resolve to their root behaviors; offer-specific actions
- * (CreativeResponse, CatalogResponse, AddToCart, InitiateTax) have no meaning
- * without a module gateway, so they surface a warning instead of silently
- * dropping — a layout author wiring one of those into a child layout gets a
- * diagnosable signal rather than a dead button.
- */
-export declare function handleRootLayoutAction(action: TriggerAction): Generator<PutEffect, void, never>;