@xibosignage/xibo-layout-renderer 1.0.24 → 1.0.26

package/README.md

@@ -67,3 +67,52 @@ The library supports multiple platforms via `ConsumerPlatform` enum and the `opt
 | `chromeOS`  | Local file path                | Fault reporting via Service Worker |
 | `electron`  | App host + URL                 | Standard playback                 |
 | PWA         | Proxy/hosted                   | Service Worker caching            |
+
+## CMS Integration — postMessage Protocol
+
+When XLR is embedded in a sandboxed `<iframe>` (e.g. in CMS Preview), it communicates with the parent frame via `window.parent.postMessage` instead of using browser dialogs that require `allow-modals`.
+
+### Iframe requirements
+
+The iframe must include `allow-scripts` in its `sandbox` attribute. `allow-modals` is **not** required.
+
+```html
+<iframe src="..." sandbox="allow-scripts allow-same-origin"></iframe>
+```
+
+### Messages sent by XLR
+
+#### `xlr:navLayout`
+
+Fired when a "Navigate to Layout" touch/webhook action is triggered. The parent frame is responsible for showing a confirmation prompt and opening the layout.
+
+```typescript
+interface XlrNavLayoutMessage {
+  type: 'xlr:navLayout';
+  layoutCode: string;  // The layout code from the action
+  url: string;         // Pre-constructed preview URL (ready to open)
+}
+```
+
+**CMS listener example:**
+
+```javascript
+window.addEventListener('message', (event) => {
+  // In production, validate event.origin against your known CMS origin.
+  if (event.data?.type === 'xlr:navLayout') {
+    if (confirm(`Navigate to layout with code ${event.data.layoutCode}?`)) {
+      window.open(event.data.url, '_blank');
+    }
+  }
+});
+```
+
+### Event API (non-iframe consumers)
+
+The same action also emits a `navLayout` event via the XLR event system, usable by consumers that have direct access to the `IXlr` object:
+
+```typescript
+xlr.on('navLayout', (layoutCode: string, url: string) => {
+  // Show your own confirmation UI and open the URL as needed.
+});
+```

package/dist/src/Modules/Generators/Generators.d.ts

@@ -40,6 +40,17 @@ export declare function getAllAttributes(elem: Element): {
  * @returns JSON string format of date
  */
 export declare function setExpiry(numDays: number): string;
+/**
+ * Check whether a media item is currently within its valid date window.
+ * Returns true when the media should be shown, false when it should be skipped.
+ *
+ * Rules:
+ *  - Empty / invalid fromDt  → treat as "no start restriction"
+ *  - Empty / invalid toDt    → treat as "no expiry"
+ *  - now < fromDt            → not yet active   → skip
+ *  - now > toDt              → expired          → skip
+ */
+export declare function isMediaActive(fromDt: string, toDt: string): boolean;
 /**
  * Check if given layout exists in the loop using layoutId
  * @param layouts Schedule loop unique layouts (uniqueLayouts)
@@ -61,5 +72,10 @@ export declare function prepareVideoMedia(media: IMedia, region: IRegion): void;
 export declare function prepareImageMedia(media: IMedia, region: IRegion): void;
 export declare function prepareAudioMedia(media: IMedia, region: IRegion): void;
 export declare function prepareHtmlMedia(media: IMedia, region: IRegion): void;
-export declare function playerReportFault(msg: string, media: IMedia): Promise<void>;
+export declare enum FaultCodes {
+    FaultVideoSource = 2001,
+    FaultVideoUnexpected = 2099
+}
+export declare function playerReportFault(msg: string, media: IMedia, code?: number): Promise<void>;
+export declare function setLayoutIndex(layout: ILayout | undefined, layoutIndex: number): ILayout | undefined;
 export {};

package/dist/src/Modules/Generators/index.d.ts

@@ -1 +1 @@
-export { getFileExt, nextId, preloadMediaBlob, getMediaId, fetchJSON, capitalizeStr, audioFileType, videoFileType, setExpiry, composeMediaUrl, fetchText, getDataBlob, composeResourceUrl, composeResourceUrlByPlatform, getIndexByLayoutId, isEmpty, composeBgUrlByPlatform, hasDefaultOnly, isLayoutValid, createMediaElement, playerReportFault, getAllAttributes, prepareAudioMedia, prepareHtmlMedia, prepareImageMedia, prepareVideoMedia, getLayoutIndexByLayoutId, hasSspLayout, type MediaTypes, } from './Generators';
+export { getFileExt, nextId, preloadMediaBlob, getMediaId, fetchJSON, capitalizeStr, audioFileType, videoFileType, setExpiry, composeMediaUrl, fetchText, getDataBlob, composeResourceUrl, composeResourceUrlByPlatform, getIndexByLayoutId, isEmpty, composeBgUrlByPlatform, hasDefaultOnly, isLayoutValid, createMediaElement, playerReportFault, getAllAttributes, prepareAudioMedia, prepareHtmlMedia, prepareImageMedia, prepareVideoMedia, getLayoutIndexByLayoutId, hasSspLayout, isMediaActive, type MediaTypes, FaultCodes, } from './Generators';

package/dist/src/Modules/Layout/Layout.d.ts

@@ -67,6 +67,7 @@ export default class Layout implements ILayout {
     resetLayout(): Promise<void>;
     finishAllRegions(): Promise<void[]>;
     removeLayout(caller?: LayoutPlaybackType): void;
+    discardLayout(caller?: LayoutPlaybackType): void;
     getXlf(): string;
     isInterrupt(): boolean;
     on<E extends keyof ILayoutEvents>(event: E, callback: ILayoutEvents[E]): import("nanoevents").Unsubscribe;

package/dist/src/Modules/Media/Media.d.ts

@@ -18,6 +18,7 @@ export declare class Media implements IMedia {
     enableStat: boolean;
     fileId: string;
     finished: boolean;
+    fromDt: string;
     html: HTMLElement | null;
     id: string;
     idCounter: number;
@@ -41,6 +42,7 @@ export declare class Media implements IMedia {
     state: MediaState;
     tempSrc: string;
     timeoutId: ReturnType<typeof setTimeout>;
+    toDt: string;
     type: string;
     uri: string;
     url: string | null;

package/dist/src/Modules/Media/VideoMedia.d.ts

@@ -1,6 +1,6 @@
 import Player from "video.js/dist/types/player";
 import { IMedia } from '../../Types/Media';
-import { IXlr } from '../../types';
+import { ConsumerPlatform, IXlr } from '../../types';
 import './media.css';
 export declare function composeVideoSource($media: HTMLVideoElement, media: IMedia): HTMLVideoElement;
 export declare const defaultVjsOpts: {
@@ -13,9 +13,13 @@ export declare const vjsDefaultOptions: (opts?: any) => any;
 export interface IVideoMediaHandler {
     player: Player | undefined;
     duration: number;
+    init(): void;
+    play(): void;
     stop(disposeOnly?: boolean): void;
 }
+export declare const reportToPlayerPlatform: ConsumerPlatform[];
 export declare function VideoMedia(media: IMedia, xlr: IXlr): {
+    player: Player | undefined;
     duration: number;
     init: () => void;
     stop: (disposeOnly?: boolean) => void;

package/dist/src/Types/Layout/Layout.types.d.ts

@@ -26,6 +26,7 @@ export type InputLayoutType = {
     getXlf?(): string;
     duration?: number;
     isOverlay?: boolean;
+    shareOfVoice?: number;
 };
 export type OptionsType = {
     xlfUrl: string;
@@ -100,6 +101,7 @@ export interface ILayout {
     finishAllRegions(): Promise<void[]>;
     inLoop: boolean;
     removeLayout(caller?: LayoutPlaybackType): void;
+    discardLayout(caller?: LayoutPlaybackType): void;
     xlfString: string;
     getXlf(): string;
     ad: any;

package/dist/src/Types/Media/Media.types.d.ts

@@ -22,6 +22,7 @@ export interface IMedia {
     enableStat: boolean;
     fileId: string;
     finished: boolean;
+    fromDt: string;
     html: HTMLElement | null;
     id: string;
     idCounter: number;
@@ -47,6 +48,7 @@ export interface IMedia {
     stop(): Promise<void>;
     tempSrc: string;
     timeoutId: ReturnType<typeof setTimeout>;
+    toDt: string;
     type: string;
     uri: string;
     url: string | null;
@@ -55,4 +57,3 @@ export interface IMedia {
     videoHandler?: IVideoMediaHandler;
     mediaTimer: ReturnType<typeof setInterval> | undefined;
 }
-export declare const initialMedia: IMedia;

package/dist/src/Types/Media/index.d.ts

@@ -1,2 +1,2 @@
 export type { IMedia, } from './Media.types';
-export { initialMedia, MediaState, } from './Media.types';
+export { MediaState, } from './Media.types';

package/dist/src/Types/XLR/XLR.types.d.ts

@@ -23,6 +23,7 @@ export type IXlrEvents = {
     overlayEnd: (overlay: ILayout) => void;
     commandCodeReceived: (commandCode: string) => void;
     commandStringReceived: (commandString: string) => void;
+    navLayout: (layoutCode: string, url: string) => void;
 };
 export interface IXlrPlayback {
     currentLayout: ILayout | undefined;
@@ -48,6 +49,7 @@ export interface IXlr {
     inputLayouts: InputLayoutType[];
     isInterrupted: boolean;
     isLayoutInDOM(containerName: string, layoutId: number): boolean;
+    cleanupOrphanedLayouts(keepCurrent?: ILayout | null, keepNext?: ILayout | null): void;
     isSspEnabled: boolean;
     isUpdatingLoop: boolean;
     isUpdatingOverlays: boolean;