@xibosignage/xibo-layout-renderer 1.0.19 → 1.0.20

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

@@ -39,4 +39,16 @@ export declare function getAllAttributes(elem: Element): {
  * @returns JSON string format of date
  */
 export declare function setExpiry(numDays: number): string;
+/**
+ * Check if given layout exists in the loop using layoutId
+ * @param layouts Schedule loop unique layouts (uniqueLayouts)
+ * @param layoutId Layout ID of the layout to look for
+ *
+ * @return boolean
+ */
+export declare function isLayoutValid(layouts: {
+    [p: string]: InputLayoutType;
+}, layoutId: number | undefined): boolean;
+export declare function hasDefaultOnly(inputLayouts: InputLayoutType[]): boolean;
+export declare function isDefaultLayout(inputLayout: InputLayoutType): boolean;
 export {};

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

@@ -7,5 +7,6 @@ export interface ISplashScreen {
 }
 export interface PreviewSplashElement extends HTMLDivElement {
     hide: () => void;
+    show: () => void;
 }
 export default function SplashScreen($parent: Element | null, config?: OptionsType): ISplashScreen;

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

@@ -4,8 +4,11 @@ import { ILayoutEvents } from '../../Modules/Layout';
 import { IXlr } from '../XLR';
 import InteractiveActions, { Action } from '../../Modules/ActionController';
 export type InputLayoutType = {
-    layoutId: number | null;
+    response: any;
+    layoutId: number;
     path?: string;
+    index?: number;
+    id?: number;
 };
 export type OptionsType = {
     xlfUrl: string;
@@ -27,10 +30,14 @@ export type OptionsType = {
     previewTranslations?: {
         [k: string]: any;
     };
+    icons?: {
+        splashScreen: string;
+        logo: string;
+    };
 };
 export interface ILayout {
     id: number | null;
-    layoutId: number | null;
+    layoutId: number;
     scheduleId?: number;
     sw: number | null;
     sh: number | null;
@@ -74,6 +81,7 @@ export interface ILayout {
     xlr: IXlr;
     finishAllRegions(): Promise<void[]>;
     inLoop: boolean;
+    removeLayout(): void;
 }
 export declare const initialLayout: ILayout;
 export type GetLayoutParamType = {
@@ -82,6 +90,7 @@ export type GetLayoutParamType = {
 };
 export type GetLayoutType = {
     currentLayoutIndex: number;
+    nextLayoutIndex: number;
     inputLayouts: InputLayoutType[];
     current: ILayout | undefined;
     next: ILayout | undefined;

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

@@ -47,5 +47,6 @@ export interface IRegion {
     on<E extends keyof IRegionEvents>(event: E, callback: IRegionEvents[E]): Unsubscribe;
     prepareMediaObjects(): void;
     reset(): void;
+    html: HTMLDivElement;
 }
 export declare const initialRegion: IRegion;

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

@@ -10,12 +10,22 @@ export declare enum ELayoutType {
 export type IXlrEvents = {
     layoutChange: (layoutId: number) => void;
 };
+export interface IXlrPlayback {
+    currentLayout: ILayout | undefined;
+    nextLayout: ILayout | undefined;
+    currentLayoutIndex: number;
+    nextLayoutIndex: number;
+    isCurrentLayoutValid: boolean;
+    hasDefaultOnly: boolean;
+}
 export interface IXlr {
     inputLayouts: InputLayoutType[];
     config: OptionsType;
-    layouts: ILayout[];
+    layouts: {
+        [key: string]: ILayout;
+    };
     currentLayoutIndex: number;
-    currentLayoutId: number | null;
+    currentLayoutId: number;
     currentLayout: ILayout | undefined;
     nextLayout: ILayout | undefined;
     emitter: Emitter<IXlrEvents>;
@@ -23,10 +33,16 @@ export interface IXlr {
     init(): Promise<IXlr>;
     playSchedules(xlr: IXlr): void;
     prepareLayoutXlf(inputLayout: ILayout | undefined): Promise<ILayout>;
-    prepareLayouts(): Promise<IXlr>;
+    prepareLayouts(playback: IXlrPlayback): Promise<IXlr>;
     updateLayouts(inputLayouts: InputLayoutType[]): void;
-    updateLoop(inputLayouts: InputLayoutType[]): void;
+    updateLoop(inputLayouts: InputLayoutType[]): Promise<void>;
     gotoPrevLayout(): void;
     gotoNextLayout(): void;
+    uniqueLayouts: {
+        [layoutId: string]: InputLayoutType;
+    };
+    getLayout(inputLayout: InputLayoutType): ILayout | undefined;
+    updateScheduleLayouts(scheduleLayouts: InputLayoutType[]): Promise<void>;
+    parseLayouts(loopUpdate?: boolean): IXlrPlayback;
 }
 export declare const initialXlr: IXlr;

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

@@ -1 +1 @@
-export { ELayoutType, IXlr, initialXlr, } from './XLR.types';
+export { ELayoutType, IXlr, initialXlr, IXlrEvents, PrepareLayoutsType, } from './XLR.types';