@xibosignage/xibo-layout-renderer 1.0.26 → 1.0.28

package/dist/xibo-layout-renderer.d.ts

@@ -75,16 +75,18 @@ declare class ActionController {
     constructor(parent: ILayout, actions: Action[], options: InactOptions);
     init(): void;
     openLayoutInNewTab(layoutCode: string, options: InactOptions): void;
-    openLayoutInPlayer(layoutCode: string, options: InactOptions): void;
+    openLayoutInPlayer(layoutCode: string, _options: InactOptions): void;
     prevOrNextLayout(targetId: string, actionType: string): void;
     /** Change media in region (next/previous) */
-    nextMediaInRegion(regionId: string, actionType: string): void;
+    gotoMediaInRegion(regionId: string, actionType: string): void;
     loadMediaInRegion(regionId: string, widgetId: string): void;
     /** Run action based on action data */
     runAction(actionData: {
         [k: string]: any;
     }, options: InactOptions): void;
     initTouchActions(): void;
+    /** Dispatch an incoming webhook trigger to any matching actions on this layout. */
+    handleWebhookTrigger(triggerCode: string, widgetId?: string): void;
     initKeyboardActions(): void;
 }
 
@@ -191,6 +193,8 @@ type IXlrEvents = {
     widgetEnd: (widgetId: number) => void;
     widgetError: (widgetId: number) => void;
     adRequest: (sspLayoutIndex: number) => void;
+    sspWidgetRequest: (media: IMedia) => void;
+    sspWidgetEnd: (impressionUrls: string[], errorUrls: string[], duration: number) => void;
     updateLoop: (inputLayouts: InputLayoutType[]) => void;
     updateOverlays: (overlays: InputLayoutType[]) => void;
     overlayStart: (overlay: ILayout) => void;
@@ -219,6 +223,23 @@ interface IXlr {
     getLayoutById(layoutId: number, layoutIndex?: number): ILayout | undefined;
     gotoNextLayout(): void;
     gotoPrevLayout(): void;
+    /**
+     * Navigate directly to a layout identified by its CMS code string.
+     * Searches parsed layouts first, then fetches unparsed XLF files via appHost.
+     * No-ops silently if the code is not found in the current loop.
+     */
+    gotoLayoutByCode(layoutCode: string): Promise<void>;
+    /**
+     * Play the given layout once as an interrupt, then resume the current loop.
+     * Used by non-CMS platforms for Navigate to Layout interactive actions.
+     * The interrupt is not part of inputLayouts and is spliced in temporarily.
+     */
+    playInterruptLayout(inputLayout: InputLayoutType): Promise<void>;
+    /**
+     * Dispatch an incoming webhook trigger code to the current layout's
+     * action controller. Pass an optional widgetId to narrow the match.
+     */
+    triggerAction(triggerCode: string, widgetId?: string): void;
     init(): Promise<IXlr>;
     inputLayouts: InputLayoutType[];
     isInterrupted: boolean;
@@ -239,7 +260,7 @@ interface IXlr {
     prepareLayoutXlf(inputLayout: ILayout | undefined): Promise<ILayout>;
     prepareLayouts(): Promise<IXlr>;
     renderOverlayLayouts(): Promise<void>;
-    uniqueLayouts: Record<string, InputLayoutType>;
+    uniqueLayouts: Map<string, InputLayoutType>;
     updateInputLayout(layoutIndex: number, layout: InputLayoutType): void;
     updateLayouts(inputLayouts: InputLayoutType[]): void;
     updateLoop(inputLayouts: InputLayoutType[]): Promise<void>;
@@ -315,6 +336,9 @@ declare class Media implements IMedia {
     xml: Element | null;
     videoHandler?: IVideoMediaHandler;
     mediaTimer: ReturnType<typeof setInterval> | undefined;
+    sspImpressionUrls: string[] | undefined;
+    sspErrorUrls: string[] | undefined;
+    private isSspWidget;
     private mediaTimeCount;
     private xlr;
     private readonly statsBC;
@@ -324,6 +348,7 @@ declare class Media implements IMedia {
     private on;
     private init;
     run(): void;
+    setSspAdUrl(url: string, adMediaType: 'image' | 'video', impressionUrls?: string[], errorUrls?: string[]): void;
     stop(): Promise<void>;
     /**
      * Emits a command from the shell command widget.
@@ -376,6 +401,9 @@ interface IMedia {
     region: IRegion;
     render: string;
     run(): void;
+    setSspAdUrl(url: string, adMediaType: 'image' | 'video', impressionUrls?: string[], errorUrls?: string[]): void;
+    sspImpressionUrls: string[] | undefined;
+    sspErrorUrls: string[] | undefined;
     schemaVersion: string;
     singlePlay: boolean;
     state: MediaState;
@@ -424,6 +452,7 @@ interface IRegion {
     };
     playNextMedia(): void;
     playPreviousMedia(): void;
+    prepareMedia(media: IMedia): void;
     prepareMediaObjects(): void;
     prepareRegion(): void;
     ready: boolean;
@@ -465,6 +494,7 @@ type InputLayoutType = {
     duration?: number;
     isOverlay?: boolean;
     shareOfVoice?: number;
+    code?: string;
 };
 type OptionsType = {
     xlfUrl: string;