@xibosignage/xibo-layout-renderer 1.0.27 → 1.0.29

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

@@ -72,20 +72,25 @@ declare class ActionController {
     $actionControllerTitle: HTMLElement | null;
     $actionsContainer: HTMLElement | null;
     translations: any;
+    private keyboardHandler;
     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;
+    /** Change media in region (next/previous) with wrap-around at boundaries. */
+    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;
+    /** Remove the keydown listener registered by initKeyboardActions. Call when the layout ends or is cancelled. */
+    removeKeyboardActions(): void;
 }
 
 declare function initRenderingDOM(targetContainer: Element | null): void;
@@ -221,6 +226,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;
@@ -241,7 +263,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>;
@@ -475,6 +497,7 @@ type InputLayoutType = {
     duration?: number;
     isOverlay?: boolean;
     shareOfVoice?: number;
+    code?: string;
 };
 type OptionsType = {
     xlfUrl: string;