@xibosignage/xibo-layout-renderer 1.0.25 → 1.0.27

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

@@ -149,6 +149,7 @@ declare 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]): nanoevents.Unsubscribe;
@@ -190,6 +191,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;
@@ -222,6 +225,7 @@ 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;
@@ -257,9 +261,13 @@ declare const vjsDefaultOptions: (opts?: any) => any;
 interface IVideoMediaHandler {
     player: Player | undefined;
     duration: number;
+    init(): void;
+    play(): void;
     stop(disposeOnly?: boolean): void;
 }
+declare const reportToPlayerPlatform: ConsumerPlatform[];
 declare function VideoMedia(media: IMedia, xlr: IXlr): {
+    player: Player | undefined;
     duration: number;
     init: () => void;
     stop: (disposeOnly?: boolean) => void;
@@ -277,6 +285,7 @@ declare class Media implements IMedia {
     enableStat: boolean;
     fileId: string;
     finished: boolean;
+    fromDt: string;
     html: HTMLElement | null;
     id: string;
     idCounter: number;
@@ -300,6 +309,7 @@ declare class Media implements IMedia {
     state: MediaState;
     tempSrc: string;
     timeoutId: ReturnType<typeof setTimeout>;
+    toDt: string;
     type: string;
     uri: string;
     url: string | null;
@@ -307,6 +317,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;
@@ -316,6 +329,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.
@@ -348,6 +362,7 @@ interface IMedia {
     enableStat: boolean;
     fileId: string;
     finished: boolean;
+    fromDt: string;
     html: HTMLElement | null;
     id: string;
     idCounter: number;
@@ -367,12 +382,16 @@ 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;
@@ -381,7 +400,6 @@ interface IMedia {
     videoHandler?: IVideoMediaHandler;
     mediaTimer: ReturnType<typeof setInterval> | undefined;
 }
-declare const initialMedia: IMedia;
 
 interface IRegion {
     complete: boolean;
@@ -415,6 +433,7 @@ interface IRegion {
     };
     playNextMedia(): void;
     playPreviousMedia(): void;
+    prepareMedia(media: IMedia): void;
     prepareMediaObjects(): void;
     prepareRegion(): void;
     ready: boolean;
@@ -530,6 +549,7 @@ interface ILayout {
     finishAllRegions(): Promise<void[]>;
     inLoop: boolean;
     removeLayout(caller?: LayoutPlaybackType): void;
+    discardLayout(caller?: LayoutPlaybackType): void;
     xlfString: string;
     getXlf(): string;
     ad: any;
@@ -592,6 +612,17 @@ declare function getAllAttributes(elem: Element): {
  * @returns JSON string format of date
  */
 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
+ */
+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)
@@ -608,7 +639,11 @@ declare function prepareVideoMedia(media: IMedia, region: IRegion): void;
 declare function prepareImageMedia(media: IMedia, region: IRegion): void;
 declare function prepareAudioMedia(media: IMedia, region: IRegion): void;
 declare function prepareHtmlMedia(media: IMedia, region: IRegion): void;
-declare function playerReportFault(msg: string, media: IMedia): Promise<void>;
+declare enum FaultCodes {
+    FaultVideoSource = 2001,
+    FaultVideoUnexpected = 2099
+}
+declare function playerReportFault(msg: string, media: IMedia, code?: number): Promise<void>;
 
 declare class Region implements IRegion {
     layout: ILayout;
@@ -761,4 +796,4 @@ type flyTransitionParams = {
 };
 declare const flyTransitionKeyframes: (params: flyTransitionParams) => KeyframeOptionsType;
 
-export { Action, ActionsWrapper, AudioMedia, ConsumerPlatform, ELayoutState, ELayoutType, type EventEmitter, type EventUnsubscriber, type GetLayoutParamType, type GetLayoutType, type ILayout, type ILayoutEvents, type IMedia, type IMediaEvents, type IRegion, type IRegionEvents, type ISplashScreen, type IVideoMediaHandler, type IXlr, type IXlrEvents, type IXlrPlayback, type InactOptions, type InputLayoutType, type KeyframeOptionsType, LayoutPlaybackType, Media, MediaState, type MediaTypes, type OptionsType, type PrepareLayoutsType, type PreviewSplashElement, Region, type TransitionElementOptions, type TransitionNameType, VideoMedia, audioFileType, capitalizeStr, type compassPoints, composeBgUrlByPlatform, composeMediaUrl, composeResourceUrl, composeResourceUrlByPlatform, composeVideoSource, createMediaElement, XiboLayoutRenderer as default, defaultTrans, defaultVjsOpts, fadeInElem, fadeOutElem, fetchJSON, fetchText, flyInElem, flyOutElem, flyTransitionKeyframes, type flyTransitionParams, getAllAttributes, getDataBlob, getFileExt, getIndexByLayoutId, getLayout, getLayoutIndexByLayoutId, getMediaId, getXlf, hasDefaultOnly, hasSspLayout, initRenderingDOM, initialLayout, initialMedia, initialRegion, initialXlr, isEmpty, isLayoutValid, nextId, playerReportFault, preloadMediaBlob, prepareAudioMedia, prepareHtmlMedia, prepareImageMedia, prepareVideoMedia, setExpiry, transitionElement, videoFileType, vjsDefaultOptions };
+export { Action, ActionsWrapper, AudioMedia, ConsumerPlatform, ELayoutState, ELayoutType, type EventEmitter, type EventUnsubscriber, FaultCodes, type GetLayoutParamType, type GetLayoutType, type ILayout, type ILayoutEvents, type IMedia, type IMediaEvents, type IRegion, type IRegionEvents, type ISplashScreen, type IVideoMediaHandler, type IXlr, type IXlrEvents, type IXlrPlayback, type InactOptions, type InputLayoutType, type KeyframeOptionsType, LayoutPlaybackType, Media, MediaState, type MediaTypes, type OptionsType, type PrepareLayoutsType, type PreviewSplashElement, Region, type TransitionElementOptions, type TransitionNameType, VideoMedia, audioFileType, capitalizeStr, type compassPoints, composeBgUrlByPlatform, composeMediaUrl, composeResourceUrl, composeResourceUrlByPlatform, composeVideoSource, createMediaElement, XiboLayoutRenderer as default, defaultTrans, defaultVjsOpts, fadeInElem, fadeOutElem, fetchJSON, fetchText, flyInElem, flyOutElem, flyTransitionKeyframes, type flyTransitionParams, getAllAttributes, getDataBlob, getFileExt, getIndexByLayoutId, getLayout, getLayoutIndexByLayoutId, getMediaId, getXlf, hasDefaultOnly, hasSspLayout, initRenderingDOM, initialLayout, initialRegion, initialXlr, isEmpty, isLayoutValid, isMediaActive, nextId, playerReportFault, preloadMediaBlob, prepareAudioMedia, prepareHtmlMedia, prepareImageMedia, prepareVideoMedia, reportToPlayerPlatform, setExpiry, transitionElement, videoFileType, vjsDefaultOptions };