@xibosignage/xibo-layout-renderer 1.0.25 → 1.0.27

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,6 +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;
@@ -48,6 +50,9 @@ export 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;
@@ -57,6 +62,7 @@ export 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.

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

@@ -101,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;
@@ -41,12 +42,16 @@ export 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;
     stop(): Promise<void>;
     tempSrc: string;
     timeoutId: ReturnType<typeof setTimeout>;
+    toDt: string;
     type: string;
     uri: string;
     url: string | null;
@@ -55,4 +60,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/Region/Region.types.d.ts

@@ -35,6 +35,7 @@ export interface IRegion {
     };
     playNextMedia(): void;
     playPreviousMedia(): void;
+    prepareMedia(media: IMedia): void;
     prepareMediaObjects(): void;
     prepareRegion(): void;
     ready: boolean;

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

@@ -1,5 +1,6 @@
 import { Emitter, Unsubscribe } from 'nanoevents';
 import { ILayout, InputLayoutType, OptionsType } from '../Layout';
+import { IMedia } from '../Media';
 import { OverlayLayoutManager } from "../../Modules/Layout/OverlayLayoutManager";
 export type PrepareLayoutsType = {
     moveNext?: boolean;
@@ -17,6 +18,8 @@ export 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;
@@ -49,6 +52,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;