@24i/bigscreen-sdk 1.0.33 → 1.0.34-alpha.2562

package/packages/list/src/utils.ts

@@ -1,142 +1,142 @@
-import { createRef } from '@24i/bigscreen-sdk/jsx';
-import { offsetPosition } from '@24i/bigscreen-sdk/utils/offsetPosition';
-import { forEach, map } from '@24i/bigscreen-sdk/perf-utils/array';
-import { ListBase } from './Base';
-import { AnimationConfiguration, ItemInfo } from './types';
-
-export const configureAnimation = (
-    defaultAnimation: AnimationConfiguration,
-    propsAnimation: Partial<AnimationConfiguration>,
-): AnimationConfiguration => ({
-    normal: {
-        time: propsAnimation.normal?.time || defaultAnimation.normal.time,
-        easing: propsAnimation.normal?.easing || defaultAnimation.normal.easing,
-    },
-    // eslint-disable-next-line no-nested-ternary
-    fastLinear: propsAnimation.fastLinear ? {
-        time: propsAnimation.fastLinear.time,
-        startRatio: propsAnimation.fastLinear.startRatio,
-        endRatio: propsAnimation.fastLinear.endRatio,
-    } : defaultAnimation.fastLinear ? {
-        time: defaultAnimation.fastLinear.time,
-        startRatio: defaultAnimation.fastLinear.startRatio,
-        endRatio: defaultAnimation.fastLinear.endRatio,
-    } : undefined,
-    slowdownRatio: propsAnimation.slowdownRatio || defaultAnimation.slowdownRatio || undefined,
-});
-
-export const getOffsetObject = (horizontal: boolean | undefined, offset: number) => (
-    { [horizontal ? 'x' : 'y']: offset }
-);
-
-export const prepareAnimatedItems = (list: ListBase<any, any>): ItemInfo[] => {
-    const childNodes = Array.prototype.slice.call(
-        list.scroller.current!.scrollRef.current!.childNodes,
-    );
-    return map(childNodes, (element: HTMLElement, dataIndex: number) => ({
-        element: createRef<HTMLElement>(element),
-        dataIndex,
-        offset: 0,
-    }));
-
-};
-
-export const changeItemsOffsetBy = (
-    items: ItemInfo[], offsetDiff: number, horizontal: boolean | undefined,
-) => {
-    forEach(items, (item) => {
-        item.offset += offsetDiff;
-        offsetPosition(item.element, getOffsetObject(horizontal, item.offset));
-    });
-};
-
-/**
- * To determine maximum number of visible items in list's viewport.
- * @param viewportSizePx Size (in pixels) of list's viewport. For vertical list,
- * use height size.
- * @param minItemSizePx Size (in pixels) of item in list. If list can contain
- * items with different size, use the smallest item size.
- */
-export const calcVisibleItemCount = (viewportSizePx: number, minItemSizePx: number) => (
-    // eslint-disable-next-line no-magic-numbers
-    Math.ceil((viewportSizePx / minItemSizePx) + 0.5)
-);
-
-/**
- * Calculates offsets of items based on given item sizes.
- * Offset defines position, to place an item relative to the edge of an root's box.
- * @param itemsSizesPx Sizes in pixels of items
- * @returns Offsets of items
- */
-export const prepareOffsetsPx = (itemsSizesPx: number[]) => {
-    const offsets = [];
-    let offsetAccumulator = 0;
-    for (let i = 0; i < itemsSizesPx.length; i++) {
-        offsets.push(offsetAccumulator);
-        offsetAccumulator += itemsSizesPx[i];
-    }
-    return offsets;
-};
-
-/**
- * Pre-calculates scroll offsets of items based on given item sizes and first scroll step.
- * Offset defines position, to place an item relative to the edge of an root's box.
- * @param itemsSizesPx Sizes in pixels of items
- * @param firstScrollStepPx
- * @returns Scroll offsets of items including first scroll step correction
- */
-export const prepareScrollOffsetsPx = (itemsSizesPx: number[], firstScrollStepPx: number) => {
-    const offsets = [];
-    let offsetAccumulator = 0;
-
-    if (!itemsSizesPx.length) {
-        return [];
-    }
-
-    const visiblePartPx = firstScrollStepPx
-        ? itemsSizesPx[0] - firstScrollStepPx
-        : 0;
-
-    // for first item
-    offsets.push(0);
-    offsetAccumulator += itemsSizesPx[0];
-
-    // for next others
-    for (let i = 1; i < itemsSizesPx.length; i++) {
-        offsets.push(offsetAccumulator - visiblePartPx);
-        offsetAccumulator += itemsSizesPx[i];
-    }
-    return offsets;
-};
-
-/**
- * Convert Scroll position in pixels to Scroll index.
- * @param pixels Scroll position in pixels (expect positive number)
- * @param scrollStep Size in pixels for one step of scroller
- * @param firstScrollStep Size in pixels for first scroller step
- * @returns scroll index
- */
-export const scrollPixelsToIndexForward = (
-    pixels: number, scrollStep: number, firstScrollStep?: number,
-) => {
-    if (pixels === 0) return 0;
-    if (typeof firstScrollStep === 'undefined') return Math.ceil(pixels / scrollStep);
-    if (pixels <= firstScrollStep) return 1;
-    return Math.ceil((pixels - firstScrollStep) / scrollStep) + 1;
-};
-
-/**
- * Convert Scroll position in pixels to Scroll index.
- * @param pixels Scroll position in pixels (expect positive number)
- * @param scrollStep Size in pixels for one step of scroller
- * @param firstScrollStep Size in pixels for first scroller step
- * @returns scroll index
- */
-export const scrollPixelsToIndexBackward = (
-    pixels: number, scrollStep: number, firstScrollStep?: number,
-) => {
-    if (pixels === 0) return 0;
-    if (typeof firstScrollStep === 'undefined') return Math.floor(pixels / scrollStep);
-    if (pixels <= firstScrollStep) return 0;
-    return Math.floor((pixels - firstScrollStep) / scrollStep) + 1;
-};
+import { createRef } from '@24i/bigscreen-sdk/jsx';
+import { offsetPosition } from '@24i/bigscreen-sdk/utils/offsetPosition';
+import { forEach, map } from '@24i/bigscreen-sdk/perf-utils/array';
+import { ListBase } from './Base';
+import { AnimationConfiguration, ItemInfo } from './types';
+
+export const configureAnimation = (
+    defaultAnimation: AnimationConfiguration,
+    propsAnimation: Partial<AnimationConfiguration>,
+): AnimationConfiguration => ({
+    normal: {
+        time: propsAnimation.normal?.time || defaultAnimation.normal.time,
+        easing: propsAnimation.normal?.easing || defaultAnimation.normal.easing,
+    },
+    // eslint-disable-next-line no-nested-ternary
+    fastLinear: propsAnimation.fastLinear ? {
+        time: propsAnimation.fastLinear.time,
+        startRatio: propsAnimation.fastLinear.startRatio,
+        endRatio: propsAnimation.fastLinear.endRatio,
+    } : defaultAnimation.fastLinear ? {
+        time: defaultAnimation.fastLinear.time,
+        startRatio: defaultAnimation.fastLinear.startRatio,
+        endRatio: defaultAnimation.fastLinear.endRatio,
+    } : undefined,
+    slowdownRatio: propsAnimation.slowdownRatio || defaultAnimation.slowdownRatio || undefined,
+});
+
+export const getOffsetObject = (horizontal: boolean | undefined, offset: number) => (
+    { [horizontal ? 'x' : 'y']: offset }
+);
+
+export const prepareAnimatedItems = (list: ListBase<any, any>): ItemInfo[] => {
+    const childNodes = Array.prototype.slice.call(
+        list.scroller.current!.scrollRef.current!.childNodes,
+    );
+    return map(childNodes, (element: HTMLElement, dataIndex: number) => ({
+        element: createRef<HTMLElement>(element),
+        dataIndex,
+        offset: 0,
+    }));
+
+};
+
+export const changeItemsOffsetBy = (
+    items: ItemInfo[], offsetDiff: number, horizontal: boolean | undefined,
+) => {
+    forEach(items, (item) => {
+        item.offset += offsetDiff;
+        offsetPosition(item.element, getOffsetObject(horizontal, item.offset));
+    });
+};
+
+/**
+ * To determine maximum number of visible items in list's viewport.
+ * @param viewportSizePx Size (in pixels) of list's viewport. For vertical list,
+ * use height size.
+ * @param minItemSizePx Size (in pixels) of item in list. If list can contain
+ * items with different size, use the smallest item size.
+ */
+export const calcVisibleItemCount = (viewportSizePx: number, minItemSizePx: number) => (
+    // eslint-disable-next-line no-magic-numbers
+    Math.ceil((viewportSizePx / minItemSizePx) + 0.5)
+);
+
+/**
+ * Calculates offsets of items based on given item sizes.
+ * Offset defines position, to place an item relative to the edge of an root's box.
+ * @param itemsSizesPx Sizes in pixels of items
+ * @returns Offsets of items
+ */
+export const prepareOffsetsPx = (itemsSizesPx: number[]) => {
+    const offsets = [];
+    let offsetAccumulator = 0;
+    for (let i = 0; i < itemsSizesPx.length; i++) {
+        offsets.push(offsetAccumulator);
+        offsetAccumulator += itemsSizesPx[i];
+    }
+    return offsets;
+};
+
+/**
+ * Pre-calculates scroll offsets of items based on given item sizes and first scroll step.
+ * Offset defines position, to place an item relative to the edge of an root's box.
+ * @param itemsSizesPx Sizes in pixels of items
+ * @param firstScrollStepPx
+ * @returns Scroll offsets of items including first scroll step correction
+ */
+export const prepareScrollOffsetsPx = (itemsSizesPx: number[], firstScrollStepPx: number) => {
+    const offsets = [];
+    let offsetAccumulator = 0;
+
+    if (!itemsSizesPx.length) {
+        return [];
+    }
+
+    const visiblePartPx = firstScrollStepPx
+        ? itemsSizesPx[0] - firstScrollStepPx
+        : 0;
+
+    // for first item
+    offsets.push(0);
+    offsetAccumulator += itemsSizesPx[0];
+
+    // for next others
+    for (let i = 1; i < itemsSizesPx.length; i++) {
+        offsets.push(offsetAccumulator - visiblePartPx);
+        offsetAccumulator += itemsSizesPx[i];
+    }
+    return offsets;
+};
+
+/**
+ * Convert Scroll position in pixels to Scroll index.
+ * @param pixels Scroll position in pixels (expect positive number)
+ * @param scrollStep Size in pixels for one step of scroller
+ * @param firstScrollStep Size in pixels for first scroller step
+ * @returns scroll index
+ */
+export const scrollPixelsToIndexForward = (
+    pixels: number, scrollStep: number, firstScrollStep?: number,
+) => {
+    if (pixels === 0) return 0;
+    if (typeof firstScrollStep === 'undefined') return Math.ceil(pixels / scrollStep);
+    if (pixels <= firstScrollStep) return 1;
+    return Math.ceil((pixels - firstScrollStep) / scrollStep) + 1;
+};
+
+/**
+ * Convert Scroll position in pixels to Scroll index.
+ * @param pixels Scroll position in pixels (expect positive number)
+ * @param scrollStep Size in pixels for one step of scroller
+ * @param firstScrollStep Size in pixels for first scroller step
+ * @returns scroll index
+ */
+export const scrollPixelsToIndexBackward = (
+    pixels: number, scrollStep: number, firstScrollStep?: number,
+) => {
+    if (pixels === 0) return 0;
+    if (typeof firstScrollStep === 'undefined') return Math.floor(pixels / scrollStep);
+    if (pixels <= firstScrollStep) return 0;
+    return Math.floor((pixels - firstScrollStep) / scrollStep) + 1;
+};

package/packages/list/utils/index.ts

@@ -1 +1 @@
-export { calcVisibleItemCount } from '../src/utils';
+export { calcVisibleItemCount } from '../src/utils';

package/packages/logger/README.md

@@ -1,117 +1,117 @@
----
-id: README
-title: Logger
-hide_title: true
-sidebar_label: Logger
----
-
-# Logger
-
-Minimal and lightweight logger tools for SmartApps BIGscreen applications.
-
-## Basic Usage
-
-```ts
-import { LoggerManager, ConsoleLogger } from '@24i/bigscreen-sdk/logger';
-
-LoggerManager.add([
-    new ConsoleLogger(),
-]);
-
-const Logger = LoggerManager.getLoggerService();
-
-Logger.debug('debug message');
-Logger.info('info message');
-Logger.warn('warn message');
-Logger.error('error message');
-```
-
-Logging methods also include an options parameter by which we can better specify the context of the message or add additional data.
-Individual Loggers have their own approach to how they handle these options.
-
-```ts
-interface LogOptions {
-    category?: LogCategory;
-    additionalData?: any;
-}
-```
-
-So, for example, in this case:
-
-```ts
-import { LogCategory } from '@24i/bigscreen-sdk/logger';
-
-Logger.warn('Data refresh failed', { category: 'api', additionalData: { statusCode: 401 } });
-```
-
-the output would be:
-
-```ts
-[API] Data refresh failed {
-    "statusCode": 401
-}
-```
-
-## Logger Manager
-
-Logger Manager is used for managing loggers. We are able to add individual loggers to the Logger Manager and perform various operations on them.
-All loggers that we want to add to the Logger Manager should inherit from the [LoggerBase](./src/loggers/LoggerBase/README) abstract class.
-
-### Methods
-
-- `add(loggerInstance: LoggerBase | LoggerBase[]): void` - Adds the logger to the Logger Manager.
-- `setLevels(config: LevelConfig[]): void` - Defines the log levels on which we want to log. Other levels will be ignored.
-
-    ```ts
-    LoggerManager.setLevels([
-        {
-            loggerName: 'ConsoleLogger',
-            levels: ['debug', 'info'],
-        },
-        {
-            loggerName: 'SentryLogger',
-            levels: ['warn', 'error'],
-        },
-    ]);
-    ```
-
-- `getLogger(loggerName: string): LoggerBase | null` - Returns the logger instance by name.
-- `mute(loggerName: string): void` - Mutes the logger by the name.
-- `muteAll(): void` - Mutes all loggers.
-- `getLoggerService(): LoggerService` - Returns the Logger Service.
-
-## Logger Service
-
-Logger Service works as a log trigger. It goes through all the loggers added in LogManager and runs logging methods on them.
-
-```ts
-const Logger = LoggerManager.getLoggerService();
-Logger.info('info message');
-```
-
-If we want to log messages only on some loggers, we can specify them in the log options parameter.
-
-```ts
-const Logger = LoggerManager.getLoggerService();
-Logger.info('info message', { onlyLoggers: ['ConsoleLogger'] });
-```
-
-## Enums
-
-Together with logger tools and individual loggers, this package defines enums for log levels and log categories.
-
-### Log Level
-
-The log message is assigned a level, which determines how urgent it is. The following log levels are defined:
-
-```ts
-type LogLevel = 'debug' | 'info' | 'warn' | 'error';
-```
-
-### Log Category
-
-The log messages should be categorized according to what caused them. The following log categories are defined:
-
-```ts
-type LogCategory = 'ui' | 'api' | 'player' | 'middleware' | 'error' | 'debug';
-```
+---
+id: README
+title: Logger
+hide_title: true
+sidebar_label: Logger
+---
+
+# Logger
+
+Minimal and lightweight logger tools for SmartApps BIGscreen applications.
+
+## Basic Usage
+
+```ts
+import { LoggerManager, ConsoleLogger } from '@24i/bigscreen-sdk/logger';
+
+LoggerManager.add([
+    new ConsoleLogger(),
+]);
+
+const Logger = LoggerManager.getLoggerService();
+
+Logger.debug('debug message');
+Logger.info('info message');
+Logger.warn('warn message');
+Logger.error('error message');
+```
+
+Logging methods also include an options parameter by which we can better specify the context of the message or add additional data.
+Individual Loggers have their own approach to how they handle these options.
+
+```ts
+interface LogOptions {
+    category?: LogCategory;
+    additionalData?: any;
+}
+```
+
+So, for example, in this case:
+
+```ts
+import { LogCategory } from '@24i/bigscreen-sdk/logger';
+
+Logger.warn('Data refresh failed', { category: 'api', additionalData: { statusCode: 401 } });
+```
+
+the output would be:
+
+```ts
+[API] Data refresh failed {
+    "statusCode": 401
+}
+```
+
+## Logger Manager
+
+Logger Manager is used for managing loggers. We are able to add individual loggers to the Logger Manager and perform various operations on them.
+All loggers that we want to add to the Logger Manager should inherit from the [LoggerBase](./src/loggers/LoggerBase/README) abstract class.
+
+### Methods
+
+- `add(loggerInstance: LoggerBase | LoggerBase[]): void` - Adds the logger to the Logger Manager.
+- `setLevels(config: LevelConfig[]): void` - Defines the log levels on which we want to log. Other levels will be ignored.
+
+    ```ts
+    LoggerManager.setLevels([
+        {
+            loggerName: 'ConsoleLogger',
+            levels: ['debug', 'info'],
+        },
+        {
+            loggerName: 'SentryLogger',
+            levels: ['warn', 'error'],
+        },
+    ]);
+    ```
+
+- `getLogger(loggerName: string): LoggerBase | null` - Returns the logger instance by name.
+- `mute(loggerName: string): void` - Mutes the logger by the name.
+- `muteAll(): void` - Mutes all loggers.
+- `getLoggerService(): LoggerService` - Returns the Logger Service.
+
+## Logger Service
+
+Logger Service works as a log trigger. It goes through all the loggers added in LogManager and runs logging methods on them.
+
+```ts
+const Logger = LoggerManager.getLoggerService();
+Logger.info('info message');
+```
+
+If we want to log messages only on some loggers, we can specify them in the log options parameter.
+
+```ts
+const Logger = LoggerManager.getLoggerService();
+Logger.info('info message', { onlyLoggers: ['ConsoleLogger'] });
+```
+
+## Enums
+
+Together with logger tools and individual loggers, this package defines enums for log levels and log categories.
+
+### Log Level
+
+The log message is assigned a level, which determines how urgent it is. The following log levels are defined:
+
+```ts
+type LogLevel = 'debug' | 'info' | 'warn' | 'error';
+```
+
+### Log Category
+
+The log messages should be categorized according to what caused them. The following log categories are defined:
+
+```ts
+type LogCategory = 'ui' | 'api' | 'player' | 'middleware' | 'error' | 'debug';
+```

package/packages/logger/src/LoggerManager.ts

@@ -1,60 +1,60 @@
-import { forEach } from '@24i/bigscreen-sdk/perf-utils/array';
-import { LoggerBase } from './loggers/LoggerBase';
-import { LoggerService } from './LoggerService';
-import { LevelConfig } from './types';
-
-class LoggerManager {
-    private loggers: Record<string, LoggerBase> = {};
-
-    private readonly loggerService: LoggerService = new LoggerService(this.loggers);
-
-    private addOne(loggerInstance: LoggerBase) {
-        const loggerName = loggerInstance.getName();
-        this.loggers[loggerName] = loggerInstance;
-    }
-
-    add(loggerInstance: LoggerBase | LoggerBase[]) {
-        if (loggerInstance instanceof Array) {
-            forEach(loggerInstance, (logger) => {
-                this.addOne(logger);
-            });
-        } else {
-            this.addOne(loggerInstance);
-        }
-    }
-
-    setLevels(config: LevelConfig[]) {
-        forEach(config, (levelConfig) => {
-            const { loggerName, levels } = levelConfig;
-            const loggerInstance = this.getLogger(loggerName);
-            if (loggerInstance) loggerInstance.setLevels(levels);
-        });
-    }
-
-    getLogger(loggerName: string) {
-        const logger = this.loggers[loggerName];
-        if (logger) return logger;
-        return null;
-    }
-
-    mute(loggerName: string) {
-        const loggerInstance = this.getLogger(loggerName);
-        if (loggerInstance) loggerInstance.muteLogger();
-    }
-
-    muteAll() {
-        const { loggers } = this;
-        const loggerNames = Object.keys(loggers);
-
-        forEach(loggerNames, (loggerName) => {
-            const loggerInstance = loggers[loggerName];
-            loggerInstance.muteLogger();
-        });
-    }
-
-    getLoggerService() {
-        return this.loggerService;
-    }
-}
-
-export const loggerManager = new LoggerManager();
+import { forEach } from '@24i/bigscreen-sdk/perf-utils/array';
+import { LoggerBase } from './loggers/LoggerBase';
+import { LoggerService } from './LoggerService';
+import { LevelConfig } from './types';
+
+class LoggerManager {
+    private loggers: Record<string, LoggerBase> = {};
+
+    private readonly loggerService: LoggerService = new LoggerService(this.loggers);
+
+    private addOne(loggerInstance: LoggerBase) {
+        const loggerName = loggerInstance.getName();
+        this.loggers[loggerName] = loggerInstance;
+    }
+
+    add(loggerInstance: LoggerBase | LoggerBase[]) {
+        if (loggerInstance instanceof Array) {
+            forEach(loggerInstance, (logger) => {
+                this.addOne(logger);
+            });
+        } else {
+            this.addOne(loggerInstance);
+        }
+    }
+
+    setLevels(config: LevelConfig[]) {
+        forEach(config, (levelConfig) => {
+            const { loggerName, levels } = levelConfig;
+            const loggerInstance = this.getLogger(loggerName);
+            if (loggerInstance) loggerInstance.setLevels(levels);
+        });
+    }
+
+    getLogger(loggerName: string) {
+        const logger = this.loggers[loggerName];
+        if (logger) return logger;
+        return null;
+    }
+
+    mute(loggerName: string) {
+        const loggerInstance = this.getLogger(loggerName);
+        if (loggerInstance) loggerInstance.muteLogger();
+    }
+
+    muteAll() {
+        const { loggers } = this;
+        const loggerNames = Object.keys(loggers);
+
+        forEach(loggerNames, (loggerName) => {
+            const loggerInstance = loggers[loggerName];
+            loggerInstance.muteLogger();
+        });
+    }
+
+    getLoggerService() {
+        return this.loggerService;
+    }
+}
+
+export const loggerManager = new LoggerManager();