@rokt/dcui-orchestrator 1.2.1-rc.32 → 1.2.1-rc.34

package/dist/libraries/dcui-components/src/components/index.d.ts

@@ -32,3 +32,5 @@ export * from './text-input';
 export * from './action-button';
 export * from './apple-pay-button';
 export * from './paypal-button';
+export * from './progress-indicator';
+export * from './progress-control';

package/dist/libraries/dcui-components/src/components/progress-control/index.d.ts

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

package/dist/libraries/dcui-components/src/components/progress-control/progress-control.d.ts

@@ -0,0 +1,49 @@
+import React from 'react';
+import { ProgressControlModel, NonInteractableChildren, WhenPredicate } from '@rokt/dcui-layout-schema';
+export interface ProgressControlProps {
+    /**
+     *  - `a11yLabel`: the aria-label for the button
+     *  - `direction`: 'Forward' | 'Backward'.
+     *  - `children`: it can accept below nodes,
+     *    * `Row`
+     *    * `Column`
+     *    * `ZStack`
+     *    * `BasicText`
+     *    * `StaticImage`
+     *    * `When`
+     *    * `InlineContainer`
+     *  - `styles`:
+     *    * `elements`:
+     *      * `own`:
+     *        - `container`
+     *        - `background`
+     *        - `border`
+     *        - `dimension`
+     *        - `flexChild`
+     *        - `spacing`
+     *    * `transitions`:
+     *      - `type`: 'Conditional'
+     *      - `transition`:
+     *        * `predicates`: WhenPredicate[]
+     *        * `duration`: number
+     *        * `value`:
+     *          * `own`:
+     *            - `container`
+     *            - `background`
+     *            - `border`
+     *            - `dimension`
+     *            - `flexChild`
+     *            - `spacing`
+     */
+    schema: ProgressControlModel<NonInteractableChildren, WhenPredicate>;
+    testId?: string;
+    onClick: () => void;
+    /** Additional navigation boundary imposed by the owning renderer. */
+    disabled?: boolean;
+}
+/**The ProgressControl is a progress node that facilitates navigation
+ * through sequential steps or stages of a process or content.<br>
+ * It offers users the ability to move both forward and backward
+ * within a linear progression, allowing them to review and control their journey.<br>
+ * */
+export declare function ProgressControl(props: ProgressControlProps): React.JSX.Element;

package/dist/libraries/dcui-components/src/components/progress-indicator/get-progress-indicator-state.d.ts

@@ -0,0 +1,3 @@
+import { ProgressIndicatorStateProps } from './types';
+/** Resolve the schema's one-based (or end-relative) start position. */
+export declare function getProgressIndicatorState(numberOfGroups: number, activeIndex: number, startPosition?: number | null): ProgressIndicatorStateProps;

package/dist/libraries/dcui-components/src/components/progress-indicator/index.d.ts

@@ -0,0 +1,3 @@
+export * from './progress-indicator';
+export * from './types';
+export * from './get-progress-indicator-state';

package/dist/libraries/dcui-components/src/components/progress-indicator/progress-indicator.d.ts

@@ -0,0 +1,8 @@
+import * as React from 'react';
+import { ProgressIndicatorProps } from './types';
+/** The ProgressIndicator is a progress node that provides users with real-time
+ * feedback on the status of ongoing processes or actions.<br>
+ * It's a visual representation of progress, often displayed as a bar,
+ * circle, or numerical percentage.<br>
+ * */
+export declare function ProgressIndicator({ activeIndex, startIndex, numOfIndicators, schema, ariaLabel, }: ProgressIndicatorProps): React.JSX.Element | null;

package/dist/libraries/dcui-components/src/components/progress-indicator/types.d.ts

@@ -0,0 +1,88 @@
+import { ProgressIndicatorModel, WhenPredicate } from '@rokt/dcui-layout-schema';
+export interface ProgressIndicatorStateProps {
+    /** The number of indicators */
+    numOfIndicators: number;
+    /** The currently active index. */
+    activeIndex: number;
+    /** The index of the indicator to start displaying from **/
+    startIndex: number;
+}
+export interface ProgressIndicatorSchemaProps {
+    /**
+     *  - `indicator`: The string content of the indicator.
+     *  - `styles`:
+     *    * `elements`:
+     *      * `own`:
+     *        - `container`
+     *        - `background`
+     *        - `border`
+     *        - `dimension`
+     *        - `flexChild`
+     *        - `spacing`
+     *      * `indicator`:
+     *        - `container`
+     *        - `background`
+     *        - `border`
+     *        - `dimension`
+     *        - `flexChild`
+     *        - `spacing`
+     *        - `text`
+     *      * `activeIndicator`:
+     *        - `container`
+     *        - `background`
+     *        - `border`
+     *        - `dimension`
+     *        - `flexChild`
+     *        - `spacing`
+     *        - `text`
+     *      * `seenIndicator`:
+     *        - `container`
+     *        - `background`
+     *        - `border`
+     *        - `dimension`
+     *        - `flexChild`
+     *        - `spacing`
+     *        - `text`
+     *    * `transitions`:
+     *      - `type`: 'Conditional'
+     *      - `transition`:
+     *        * `predicates`: WhenPredicate[]
+     *        * `duration`: number
+     *        * `value`:
+     *          * `own`:
+     *            - `container`
+     *            - `background`
+     *            - `border`
+     *            - `dimension`
+     *            - `flexChild`
+     *            - `spacing`
+     *          * `indicator`:
+     *            - `container`
+     *            - `background`
+     *            - `border`
+     *            - `dimension`
+     *            - `flexChild`
+     *            - `spacing`
+     *            - `text`
+     *          * `activeIndicator`:
+     *            - `container`
+     *            - `background`
+     *            - `border`
+     *            - `dimension`
+     *            - `flexChild`
+     *            - `spacing`
+     *            - `text`
+     *          * `seenIndicator`:
+     *            - `container`
+     *            - `background`
+     *            - `border`
+     *            - `dimension`
+     *            - `flexChild`
+     *            - `spacing`
+     *            - `text`
+     */
+    schema: ProgressIndicatorModel<WhenPredicate>;
+}
+export interface ProgressIndicatorProps extends ProgressIndicatorSchemaProps, ProgressIndicatorStateProps {
+    ariaLabel?: string;
+}

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

@@ -1,7 +1,8 @@
 import { LinkOpenTarget } from '@rokt/dcui-layout-schema';
 import { PluginChildLayoutModel } from '../models';
-/** Deliberately off until measurement and the SDK persistence proof are approved. */
-export declare const CONTINUOUS_CHILD_CAPABILITY_ENABLED = false;
+/** Plugin builds support explicit continuationKey opt-in; standalone consumers stay off. */
+export declare function isContinuousChildEnabled(environment: string | undefined): boolean;
+export declare const CONTINUOUS_CHILD_CAPABILITY_ENABLED: boolean;
 export declare const CONTINUOUS_CHILD_VERSION = 1;
 export declare const CONTINUOUS_CHILD_EVENTS: {
     readonly READY: "CONTINUOUS_CHILD/READY";
@@ -10,17 +11,15 @@ export declare const CONTINUOUS_CHILD_EVENTS: {
     readonly REQUEST: "CONTINUOUS_CHILD/REQUEST";
     readonly EXPOSURE: "CONTINUOUS_CHILD/EXPOSURE";
 };
-/** Temporary additive types until the stable schema package is published. */
-export type ContinuousChildSchema = PluginChildLayoutModel['childLayoutSchema'] & {
-    continuationKey?: string | null;
-    ownsViewability?: boolean | null;
-};
+/** Generated Web 1.30 child schema contract. */
+export type ContinuousChildSchema = PluginChildLayoutModel['childLayoutSchema'];
 export interface ContinuousIdentity {
     sessionId: string;
     revision: number;
     position: number;
     creativeInstanceGuid: string;
-    childInstanceGuid: string;
+    /** Optional serving tracking metadata; session/revision and creative identity remain required. */
+    childInstanceGuid?: string;
 }
 export interface ContinuousPresentationInput {
     config: PluginChildLayoutModel;
@@ -35,6 +34,10 @@ export interface ContinuousRequest {
     identity: ContinuousIdentity;
     actionId: string;
     openLinks?: LinkOpenTarget;
+    dismissalMethod?: string;
+    inferredView?: {
+        supportedByBrowser: boolean;
+    };
     action: 'next' | 'previous' | 'positive' | 'negative' | 'close';
 }
 export interface ContinuousExposure {

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

@@ -1,4 +1,6 @@
 import { PluginOffer } from './plugin/plugin-offer';
-import { PluginCreativeUrlResponseOption } from './plugin/plugin-creative-response-option';
+import { PluginCreativeCaptureOnlyResponseOption, PluginCreativeUrlResponseOption } from './plugin/plugin-creative-response-option';
 /** Child acceptance supports ordinary positive URLs, not deferred fulfillment. */
 export declare function getChildPositiveResponse(offer: PluginOffer | null, responseKey: string): PluginCreativeUrlResponseOption | undefined;
+/** Persistent children dispatch ordinary responses through the current parent module. */
+export declare function getContinuousChildResponse(offer: PluginOffer | null, responseKey: 'positive' | 'negative'): PluginCreativeUrlResponseOption | PluginCreativeCaptureOnlyResponseOption | undefined;

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

@@ -7,6 +7,9 @@ export interface ModuleAttributes {
     childLayouts: string;
     schemaVersion: string;
     visible: 'true' | 'false';
+    'continuous-measurement'?: string;
+    'expanded-owns-viewability'?: string;
+    'measurement-occluded'?: string;
     container: 'row' | 'column';
     interactivity: Interactivity;
     offerState: string;

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

@@ -19,6 +19,7 @@ export interface IModuleConnector extends HTMLElement {
     getOfferPositionAttr(): number;
     getJSONAttr<Result>(att: string, defaultValue?: string): Result;
     connectedCallback(): void;
+    disconnectedCallback(): void;
 }
 export declare class ModuleConnectorBuilder {
     logger: (log: Log) => void;

package/dist/libraries/orchestrator/src/components/progress-control/progress-control.d.ts

@@ -1,47 +1,4 @@
 import React from 'react';
-import { ProgressControlModel, NonInteractableChildren, WhenPredicate } from '@rokt/dcui-layout-schema';
-export interface ProgressControlProps {
-    /**
-     *  - `a11yLabel`: the aria-label for the button
-     *  - `direction`: 'Forward' | 'Backward'.
-     *  - `children`: it can accept below nodes,
-     *    * `Row`
-     *    * `Column`
-     *    * `ZStack`
-     *    * `BasicText`
-     *    * `StaticImage`
-     *    * `When`
-     *    * `InlineContainer`
-     *  - `styles`:
-     *    * `elements`:
-     *      * `own`:
-     *        - `container`
-     *        - `background`
-     *        - `border`
-     *        - `dimension`
-     *        - `flexChild`
-     *        - `spacing`
-     *    * `transitions`:
-     *      - `type`: 'Conditional'
-     *      - `transition`:
-     *        * `predicates`: WhenPredicate[]
-     *        * `duration`: number
-     *        * `value`:
-     *          * `own`:
-     *            - `container`
-     *            - `background`
-     *            - `border`
-     *            - `dimension`
-     *            - `flexChild`
-     *            - `spacing`
-     */
-    schema: ProgressControlModel<NonInteractableChildren, WhenPredicate>;
-    testId?: string;
-}
-/**The ProgressControl is a progress node that facilitates navigation
- * through sequential steps or stages of a process or content.<br>
- * It offers users the ability to move both forward and backward
- * within a linear progression, allowing them to review and control their journey.<br>
- * *Where can we use this: __outer layout__*
- * */
+import { ProgressControlProps as SharedProgressControlProps } from '../../../../dcui-components/src/index';
+export type ProgressControlProps = Omit<SharedProgressControlProps, 'onClick' | 'disabled'>;
 export declare function ProgressControl(props: ProgressControlProps): React.JSX.Element;

package/dist/libraries/orchestrator/src/components/progress-indicator/progress-indicator.d.ts

@@ -1,9 +1 @@
-import * as React from 'react';
-import { ProgressIndicatorProps } from './types';
-/** The ProgressIndicator is a progress node that provides users with real-time
- * feedback on the status of ongoing processes or actions.<br>
- * It's a visual representation of progress, often displayed as a bar,
- * circle, or numerical percentage.<br>
- * *Where can we use this: __outer layout__*
- * */
-export declare function ProgressIndicator({ activeIndex, startIndex, numOfIndicators, schema, }: ProgressIndicatorProps): React.JSX.Element | null;
+export { ProgressIndicator } from '../../../../dcui-components/src/index';

package/dist/libraries/orchestrator/src/components/progress-indicator/types.d.ts

@@ -1,87 +1 @@
-import { ProgressIndicatorModel, WhenPredicate } from '@rokt/dcui-layout-schema';
-export interface StateProps {
-    /** The number of indicators */
-    numOfIndicators: number;
-    /** The currently active index. */
-    activeIndex: number;
-    /** The index of the indicator to start displaying from **/
-    startIndex: number;
-}
-export interface OwnProps {
-    /**
-     *  - `indicator`: The string content of the indicator.
-     *  - `styles`:
-     *    * `elements`:
-     *      * `own`:
-     *        - `container`
-     *        - `background`
-     *        - `border`
-     *        - `dimension`
-     *        - `flexChild`
-     *        - `spacing`
-     *      * `indicator`:
-     *        - `container`
-     *        - `background`
-     *        - `border`
-     *        - `dimension`
-     *        - `flexChild`
-     *        - `spacing`
-     *        - `text`
-     *      * `activeIndicator`:
-     *        - `container`
-     *        - `background`
-     *        - `border`
-     *        - `dimension`
-     *        - `flexChild`
-     *        - `spacing`
-     *        - `text`
-     *      * `seenIndicator`:
-     *        - `container`
-     *        - `background`
-     *        - `border`
-     *        - `dimension`
-     *        - `flexChild`
-     *        - `spacing`
-     *        - `text`
-     *    * `transitions`:
-     *      - `type`: 'Conditional'
-     *      - `transition`:
-     *        * `predicates`: WhenPredicate[]
-     *        * `duration`: number
-     *        * `value`:
-     *          * `own`:
-     *            - `container`
-     *            - `background`
-     *            - `border`
-     *            - `dimension`
-     *            - `flexChild`
-     *            - `spacing`
-     *          * `indicator`:
-     *            - `container`
-     *            - `background`
-     *            - `border`
-     *            - `dimension`
-     *            - `flexChild`
-     *            - `spacing`
-     *            - `text`
-     *          * `activeIndicator`:
-     *            - `container`
-     *            - `background`
-     *            - `border`
-     *            - `dimension`
-     *            - `flexChild`
-     *            - `spacing`
-     *            - `text`
-     *          * `seenIndicator`:
-     *            - `container`
-     *            - `background`
-     *            - `border`
-     *            - `dimension`
-     *            - `flexChild`
-     *            - `spacing`
-     *            - `text`
-     */
-    schema: ProgressIndicatorModel<WhenPredicate>;
-}
-export interface ProgressIndicatorProps extends OwnProps, StateProps {
-}
+export type { ProgressIndicatorProps, ProgressIndicatorStateProps as StateProps, ProgressIndicatorSchemaProps as OwnProps, } from '../../../../dcui-components/src/index';

package/dist/libraries/orchestrator/src/measurement/creative-measurement.d.ts

@@ -0,0 +1,54 @@
+import { RaiseSignal } from '../../../domain/src/behaviors';
+import { Impression, Viewed } from '../../../domain/src/models';
+export interface CreativeIdentity {
+    creativeInstanceGuid: string;
+    offerPositionIndex: number;
+}
+export interface PresentationIdentity extends CreativeIdentity {
+    sessionId: string;
+    revision: number;
+}
+export type Qualification = Pick<Viewed, 'supportedByBrowser' | 'inferred'>;
+type MeasurementStore = {
+    dispatch(action: RaiseSignal): void;
+};
+/** One registry per parent store/selection, never one per child session. */
+export declare function getContinuousMeasurement(store: MeasurementStore): CreativeMeasurement;
+/**
+ * Parent-owned creative signals. Layout/slot signals deliberately bypass this
+ * ledger. Registration is explicit: the disabled capability and ordinary layouts
+ * must never change their existing measurement just because a child exists.
+ */
+export declare class CreativeMeasurement {
+    private readonly emit;
+    private readonly creatives;
+    private readonly presentations;
+    private sessionId;
+    private highestRevision;
+    private occluded;
+    private readonly listeners;
+    constructor(emit: (action: RaiseSignal) => void);
+    /** A new served selection is a new lifetime; reopening the child is not. */
+    resetSelection(): void;
+    registerCreative(identity: CreativeIdentity, ownsViewability: boolean): void;
+    getEmbeddedPolicy(identity: CreativeIdentity): {
+        registered: boolean;
+        ownsViewability: boolean;
+        occluded: boolean;
+    };
+    subscribe(listener: () => void): () => void;
+    setOccluded(occluded: boolean): void;
+    /** Consumes only opted-in CREATIVE signals; false means use the legacy path. */
+    reportEmbedded(identity: CreativeIdentity, signal: Impression | Viewed): boolean;
+    /** Called after the child applied the snapshot, not when it was configured. */
+    acknowledge(identity: PresentationIdentity): boolean;
+    beginSession(sessionId: string): void;
+    endSession(): void;
+    reportExpanded(identity: PresentationIdentity, qualification?: Qualification): boolean;
+    private getCreative;
+    private matchesAcknowledged;
+    private render;
+    private qualify;
+    private notify;
+}
+export {};

package/dist/libraries/orchestrator/src/sagas/child-layouts/continuous-child-host.d.ts

@@ -8,7 +8,7 @@ export declare function isContinuousEngagement(action: unknown): boolean;
 export declare function makeContinuousChildHost(store: Pick<AppStore, 'getState' | 'dispatch' | 'subscribe'>, service: PluginService, enabled?: boolean): {
     gateway: ContinuousGatewayService | undefined;
     coordinator: ContinuousChildCoordinator;
-    getSequence: (key: string) => ContinuousPresentationInput[] | undefined;
+    getSequence: (key: string, onRejected?: (reason: string) => void) => ContinuousPresentationInput[] | undefined;
     transformAction(action: unknown): unknown;
     observeAction(action: unknown): void;
     close(): Promise<void>;

package/dist/libraries/orchestrator/src/sagas/child-layouts/continuous-child.d.ts

@@ -16,7 +16,7 @@ export interface ContinuousChildDependencies {
     getActivePosition(): number;
     navigate(position: number): void;
     respond(position: number, key: 'positive' | 'negative', openLinks?: LinkOpenTarget): Promise<void>;
-    dismiss(position: number): Promise<void>;
+    dismiss(position: number, dismissalMethod?: string): Promise<void>;
     onApplied?(presentation: ContinuousPresentation): void;
     onExposure?(presentation: ContinuousPresentation, report: ContinuousExposure): void;
     onOcclusion?(occluded: boolean): void;