@24i/bigscreen-sdk 1.0.34 → 1.0.35-alpha.2578

package/packages/time/src/adapters/worldTimeApi.ts

@@ -1,74 +1,74 @@
-import * as WorldTimeApi from '../services/worldTimeApi';
-
-/*
- * Wrappers over WorldTimeApi service to have output data in form required
- * by Time module
- */
-
-type ParamOptions = WorldTimeApi.ParamOptions;
-
-const defaultOptions: ParamOptions = {
-    timeoutInMs: 30000,
-    retryConfig: {
-        retry: 2,
-        shouldRetry: (data) => {
-            const datetime = (data?.response?.dataJson as any)?.datetime;
-            return !datetime;
-        },
-    },
-};
-
-/**
- * Wrapper over "WorldTimeApi.getTimeByTimezone" method requesting the current time
- * based on timezone.
- *
- * @param timezone Timezone in `Area/Location` or `Area/Location/Region` format
- * @param options Options object
- */
-export const getTimeByTimezone = async (timezone: string, options: ParamOptions = {}) => {
-    const opts = { ...defaultOptions, ...options };
-    const resp = await WorldTimeApi.getTimeByTimezone(timezone, opts);
-
-    // return data in form required by Time module
-    if ('datetime' in resp) {
-        return { datetime: resp.datetime };
-    }
-    return null;
-};
-
-/**
- * Wrapper over "WorldTimeApi.getTimeByIp" method requesting the current time
- * based on specific IP.
- *
- * @param ip IPv4 address
- * @param options Options object
- */
-export const getTimeByIp = async (ip: string, options: ParamOptions = {}) => {
-    if (!ip) return null;
-
-    const opts = { ...defaultOptions, ...options };
-    const resp = await WorldTimeApi.getTimeByIp(ip, opts);
-
-    // return data in form required by Time module
-    if ('datetime' in resp) {
-        return { datetime: resp.datetime };
-    }
-    return null;
-};
-
-/**
- * Wrapper over "WorldTimeApi.getTimeByPublicIp" method requesting the current time
- * based on public IP of request.
- *
- * @param options Options object
- */
-export const getTimeByPublicIp = async (options: ParamOptions = {}) => {
-    const opts = { ...defaultOptions, ...options };
-    const resp = await WorldTimeApi.getTimeByPublicIp(opts);
-
-    // return data in form required by Time module
-    if ('datetime' in resp) {
-        return { datetime: resp.datetime };
-    }
-    return null;
-};
+import * as WorldTimeApi from '../services/worldTimeApi';
+
+/*
+ * Wrappers over WorldTimeApi service to have output data in form required
+ * by Time module
+ */
+
+type ParamOptions = WorldTimeApi.ParamOptions;
+
+const defaultOptions: ParamOptions = {
+    timeoutInMs: 30000,
+    retryConfig: {
+        retry: 2,
+        shouldRetry: (data) => {
+            const datetime = (data?.response?.dataJson as any)?.datetime;
+            return !datetime;
+        },
+    },
+};
+
+/**
+ * Wrapper over "WorldTimeApi.getTimeByTimezone" method requesting the current time
+ * based on timezone.
+ *
+ * @param timezone Timezone in `Area/Location` or `Area/Location/Region` format
+ * @param options Options object
+ */
+export const getTimeByTimezone = async (timezone: string, options: ParamOptions = {}) => {
+    const opts = { ...defaultOptions, ...options };
+    const resp = await WorldTimeApi.getTimeByTimezone(timezone, opts);
+
+    // return data in form required by Time module
+    if ('datetime' in resp) {
+        return { datetime: resp.datetime };
+    }
+    return null;
+};
+
+/**
+ * Wrapper over "WorldTimeApi.getTimeByIp" method requesting the current time
+ * based on specific IP.
+ *
+ * @param ip IPv4 address
+ * @param options Options object
+ */
+export const getTimeByIp = async (ip: string, options: ParamOptions = {}) => {
+    if (!ip) return null;
+
+    const opts = { ...defaultOptions, ...options };
+    const resp = await WorldTimeApi.getTimeByIp(ip, opts);
+
+    // return data in form required by Time module
+    if ('datetime' in resp) {
+        return { datetime: resp.datetime };
+    }
+    return null;
+};
+
+/**
+ * Wrapper over "WorldTimeApi.getTimeByPublicIp" method requesting the current time
+ * based on public IP of request.
+ *
+ * @param options Options object
+ */
+export const getTimeByPublicIp = async (options: ParamOptions = {}) => {
+    const opts = { ...defaultOptions, ...options };
+    const resp = await WorldTimeApi.getTimeByPublicIp(opts);
+
+    // return data in form required by Time module
+    if ('datetime' in resp) {
+        return { datetime: resp.datetime };
+    }
+    return null;
+};

package/packages/time/src/constants.ts

@@ -1,14 +1,14 @@
-export type InitStatus = 'system_time' | 'served_synced' | 'undefined';
-
-export const ErrorCode = {
-    DATETIME_PARSING_ERROR: 'DATETIME_PARSING_ERROR',
-    INVALID_REQUEST_SESSION_ID: 'INVALID_REQUEST_SESSION_ID',
-    FORBIDDEN_MULTIPLE_INIT: 'FORBIDDEN_MULTIPLE_INIT',
-    ERROR_SERVER_UNIX_TIME: 'ERROR_SERVER_UNIX_TIME',
-    NOT_INITIALIZED: 'NOT_INITIALIZED',
-    NO_TIME_SERVICE_PROVIDER: 'NO_TIME_SERVICE_PROVIDER',
-};
-
-export const MS_PER_MINUTE = 60000;
-export const MINUTES_PER_HOUR = 60;
-export const HOURS_PER_DAY = 24;
+export type InitStatus = 'system_time' | 'served_synced' | 'undefined';
+
+export const ErrorCode = {
+    DATETIME_PARSING_ERROR: 'DATETIME_PARSING_ERROR',
+    INVALID_REQUEST_SESSION_ID: 'INVALID_REQUEST_SESSION_ID',
+    FORBIDDEN_MULTIPLE_INIT: 'FORBIDDEN_MULTIPLE_INIT',
+    ERROR_SERVER_UNIX_TIME: 'ERROR_SERVER_UNIX_TIME',
+    NOT_INITIALIZED: 'NOT_INITIALIZED',
+    NO_TIME_SERVICE_PROVIDER: 'NO_TIME_SERVICE_PROVIDER',
+};
+
+export const MS_PER_MINUTE = 60000;
+export const MINUTES_PER_HOUR = 60;
+export const HOURS_PER_DAY = 24;

package/packages/time/src/index.ts

@@ -1 +1 @@
-export { time } from './Time';
+export { time } from './Time';

package/packages/time/src/services/24iMediaTimeApi/24iMediaTimeApi.ts

@@ -1,43 +1,43 @@
-/**
- * Package "24iMediaTimeApi" provides a single function to obtain the current time
- * adjusted by local timezone and daylight savings time for use in time package,
- * from 24i time API at https://time.24imedia.tv/
- */
-import {
-    xhrSendRetry, type RetryConfig, type XhrResponse,
-} from '@24i/bigscreen-sdk/utils/xhr';
-
-const API_URL = 'https://time.24imedia.tv/';
-
-export type Options = {
-    /** The request timeout in milliseconds. The value 0 for no timeout */
-    timeoutInMs: number,
-    /** Retry configuration */
-    retryConfig: RetryConfig,
-};
-export type ParamOptions = Partial<Options>;
-
-export type ServiceDataResponse = {
-    /** Is dailight savings time */
-    in_dst: boolean,
-    /** Current time in GMT, in milliseconds */
-    timestamp: number,
-    /** Timezeone offset in milliseconds */
-    timezone_offset: number,
-};
-
-/**
- * Request the current time based on public IP of request.
- *
- * @param options Options object
- */
-export async function getTime(options?: ParamOptions): Promise<ServiceDataResponse> {
-    try {
-        const resp = (await xhrSendRetry(API_URL, options)) as XhrResponse;
-        const data: any = resp.dataJson || {};
-        return data as ServiceDataResponse;
-    } catch (e) {
-        console.error('[24iMediaTimeApi] Failed to get time', e);
-        throw e;
-    }
-}
+/**
+ * Package "24iMediaTimeApi" provides a single function to obtain the current time
+ * adjusted by local timezone and daylight savings time for use in time package,
+ * from 24i time API at https://time.24imedia.tv/
+ */
+import {
+    xhrSendRetry, type RetryConfig, type XhrResponse,
+} from '@24i/bigscreen-sdk/utils/xhr';
+
+const API_URL = 'https://time.24imedia.tv/';
+
+export type Options = {
+    /** The request timeout in milliseconds. The value 0 for no timeout */
+    timeoutInMs: number,
+    /** Retry configuration */
+    retryConfig: RetryConfig,
+};
+export type ParamOptions = Partial<Options>;
+
+export type ServiceDataResponse = {
+    /** Is dailight savings time */
+    in_dst: boolean,
+    /** Current time in GMT, in milliseconds */
+    timestamp: number,
+    /** Timezeone offset in milliseconds */
+    timezone_offset: number,
+};
+
+/**
+ * Request the current time based on public IP of request.
+ *
+ * @param options Options object
+ */
+export async function getTime(options?: ParamOptions): Promise<ServiceDataResponse> {
+    try {
+        const resp = (await xhrSendRetry(API_URL, options)) as XhrResponse;
+        const data: any = resp.dataJson || {};
+        return data as ServiceDataResponse;
+    } catch (e) {
+        console.error('[24iMediaTimeApi] Failed to get time', e);
+        throw e;
+    }
+}

package/packages/time/src/services/24iMediaTimeApi/index.ts

@@ -1,6 +1,6 @@
-export {
-    Options,
-    ParamOptions,
-    ServiceDataResponse,
-    getTime,
-} from './24iMediaTimeApi';
+export {
+    Options,
+    ParamOptions,
+    ServiceDataResponse,
+    getTime,
+} from './24iMediaTimeApi';

package/packages/time/src/services/worldTimeApi/index.ts

@@ -1,7 +1,7 @@
-export {
-    Options,
-    ParamOptions,
-    getTimeByIp,
-    getTimeByPublicIp,
-    getTimeByTimezone,
-} from './worldTimeApi';
+export {
+    Options,
+    ParamOptions,
+    getTimeByIp,
+    getTimeByPublicIp,
+    getTimeByTimezone,
+} from './worldTimeApi';

package/packages/time/src/services/worldTimeApi/types.ts

@@ -1,75 +1,75 @@
-export type DateTimeJsonResponse = {
-    /**
-     * The abbreviated name of the timezone
-     */
-    abbreviation: string,
-    /**
-     * The IP of the client making the request
-     */
-    client_ip: string,
-    /**
-     * An ISO8601-valid string representing the current, local date/time
-     */
-    datetime: string,
-    /**
-     * Current day number of the week, where sunday is 0
-     */
-    day_of_week: number,
-    /**
-     * Ordinal date of the current year
-     */
-    day_of_year: number,
-    /**
-     * Flag indicating whether the local time is in daylight savings
-     */
-    dst: boolean,
-    /**
-     * An ISO8601-valid string representing the datetime when daylight savings
-     * started for this timezone
-     */
-    dst_from?: string,
-    /**
-     * The difference in seconds between the current local time and daylight
-     * saving time for the location
-     */
-    dst_offset: number,
-    /**
-     * An ISO8601-valid string representing the datetime when daylight savings
-     * will end for this timezone
-     */
-    dst_until?: string,
-    /**
-     * The difference in seconds between the current local time and the time in
-     * UTC, excluding any daylight saving difference (see dst_offset)
-     */
-    raw_offset?: number,
-    /**
-     * Timezone in `Area/Location` or `Area/Location/Region` format
-     */
-    timezone: string,
-    /**
-     * Number of seconds since the Epoch
-     */
-    unixtime: number,
-    /**
-     * An ISO8601-valid string representing the current date/time in UTC
-     */
-    utc_datetime: string,
-    /**
-     * An ISO8601-valid string representing the offset from UTC
-     */
-    utc_offset: string,
-    /**
-     * The current week number
-     */
-    week_number: number,
-};
-
-export type ErrorJsonResponse = {
-    /**
-     * Details about the error encountered
-     */
-    error: string,
-};
-
-export type ServiceDataResponse = DateTimeJsonResponse | ErrorJsonResponse;
+export type DateTimeJsonResponse = {
+    /**
+     * The abbreviated name of the timezone
+     */
+    abbreviation: string,
+    /**
+     * The IP of the client making the request
+     */
+    client_ip: string,
+    /**
+     * An ISO8601-valid string representing the current, local date/time
+     */
+    datetime: string,
+    /**
+     * Current day number of the week, where sunday is 0
+     */
+    day_of_week: number,
+    /**
+     * Ordinal date of the current year
+     */
+    day_of_year: number,
+    /**
+     * Flag indicating whether the local time is in daylight savings
+     */
+    dst: boolean,
+    /**
+     * An ISO8601-valid string representing the datetime when daylight savings
+     * started for this timezone
+     */
+    dst_from?: string,
+    /**
+     * The difference in seconds between the current local time and daylight
+     * saving time for the location
+     */
+    dst_offset: number,
+    /**
+     * An ISO8601-valid string representing the datetime when daylight savings
+     * will end for this timezone
+     */
+    dst_until?: string,
+    /**
+     * The difference in seconds between the current local time and the time in
+     * UTC, excluding any daylight saving difference (see dst_offset)
+     */
+    raw_offset?: number,
+    /**
+     * Timezone in `Area/Location` or `Area/Location/Region` format
+     */
+    timezone: string,
+    /**
+     * Number of seconds since the Epoch
+     */
+    unixtime: number,
+    /**
+     * An ISO8601-valid string representing the current date/time in UTC
+     */
+    utc_datetime: string,
+    /**
+     * An ISO8601-valid string representing the offset from UTC
+     */
+    utc_offset: string,
+    /**
+     * The current week number
+     */
+    week_number: number,
+};
+
+export type ErrorJsonResponse = {
+    /**
+     * Details about the error encountered
+     */
+    error: string,
+};
+
+export type ServiceDataResponse = DateTimeJsonResponse | ErrorJsonResponse;

package/packages/time/src/services/worldTimeApi/worldTimeApi.ts

@@ -1,77 +1,77 @@
-/**
- * Package "WorldTimeApi" provides a single function to obtain the current time
- * in, and related data about, a timezone, from the WorldTimeApi service: http://worldtimeapi.org
- */
-import {
-    xhrSendRetry, type RetryConfig, type XhrResponse,
-} from '@24i/bigscreen-sdk/utils/xhr';
-import { ServiceDataResponse } from './types';
-
-const API_URL = 'http://worldtimeapi.org/api';
-
-export type Options = {
-    /** The request timeout in milliseconds. The value 0 for no timeout */
-    timeoutInMs: number,
-    /** Retry configuration */
-    retryConfig: RetryConfig,
-};
-export type ParamOptions = Partial<Options>;
-
-/**
- * Request the current time for a timezone.
- *
- * @param timezone Timezone in `Area/Location` or `Area/Location/Region` format
- * @param options Options object
- */
-async function getTimeByTimezone(timezone: string, options?: ParamOptions):
-Promise<ServiceDataResponse> {
-    const url = `${API_URL}/timezone/${timezone}`;
-
-    try {
-        const resp = (await xhrSendRetry(url, options)) as XhrResponse;
-        const data: any = resp.dataJson || {};
-        return data as ServiceDataResponse;
-    } catch (e) {
-        console.error('[worldtimeapi] Failed to get time by timezone', e);
-        throw e;
-    }
-}
-
-/**
- * Request the current time based on a specific IP.
- *
- * @param ip IPv4 address.
- * @param options Options object
- */
-async function getTimeByIp(ip: string, options?: ParamOptions): Promise<ServiceDataResponse> {
-    const url = `${API_URL}/ip/${ip}`;
-
-    try {
-        const resp = (await xhrSendRetry(url, options)) as XhrResponse;
-        const data: any = resp.dataJson || {};
-        return data as ServiceDataResponse;
-    } catch (e) {
-        console.error('[worldtimeapi] Failed to get time by IP', e);
-        throw e;
-    }
-}
-
-/**
- * Request the current time based on public IP of request.
- *
- * @param options Options object
- */
-async function getTimeByPublicIp(options?: ParamOptions): Promise<ServiceDataResponse> {
-    const url = `${API_URL}/ip`;
-
-    try {
-        const resp = (await xhrSendRetry(url, options)) as XhrResponse;
-        const data: any = resp.dataJson || {};
-        return data as ServiceDataResponse;
-    } catch (e) {
-        console.error('[worldtimeapi] Failed to get time by public IP', e);
-        throw e;
-    }
-}
-
-export { getTimeByTimezone, getTimeByIp, getTimeByPublicIp };
+/**
+ * Package "WorldTimeApi" provides a single function to obtain the current time
+ * in, and related data about, a timezone, from the WorldTimeApi service: http://worldtimeapi.org
+ */
+import {
+    xhrSendRetry, type RetryConfig, type XhrResponse,
+} from '@24i/bigscreen-sdk/utils/xhr';
+import { ServiceDataResponse } from './types';
+
+const API_URL = 'http://worldtimeapi.org/api';
+
+export type Options = {
+    /** The request timeout in milliseconds. The value 0 for no timeout */
+    timeoutInMs: number,
+    /** Retry configuration */
+    retryConfig: RetryConfig,
+};
+export type ParamOptions = Partial<Options>;
+
+/**
+ * Request the current time for a timezone.
+ *
+ * @param timezone Timezone in `Area/Location` or `Area/Location/Region` format
+ * @param options Options object
+ */
+async function getTimeByTimezone(timezone: string, options?: ParamOptions):
+Promise<ServiceDataResponse> {
+    const url = `${API_URL}/timezone/${timezone}`;
+
+    try {
+        const resp = (await xhrSendRetry(url, options)) as XhrResponse;
+        const data: any = resp.dataJson || {};
+        return data as ServiceDataResponse;
+    } catch (e) {
+        console.error('[worldtimeapi] Failed to get time by timezone', e);
+        throw e;
+    }
+}
+
+/**
+ * Request the current time based on a specific IP.
+ *
+ * @param ip IPv4 address.
+ * @param options Options object
+ */
+async function getTimeByIp(ip: string, options?: ParamOptions): Promise<ServiceDataResponse> {
+    const url = `${API_URL}/ip/${ip}`;
+
+    try {
+        const resp = (await xhrSendRetry(url, options)) as XhrResponse;
+        const data: any = resp.dataJson || {};
+        return data as ServiceDataResponse;
+    } catch (e) {
+        console.error('[worldtimeapi] Failed to get time by IP', e);
+        throw e;
+    }
+}
+
+/**
+ * Request the current time based on public IP of request.
+ *
+ * @param options Options object
+ */
+async function getTimeByPublicIp(options?: ParamOptions): Promise<ServiceDataResponse> {
+    const url = `${API_URL}/ip`;
+
+    try {
+        const resp = (await xhrSendRetry(url, options)) as XhrResponse;
+        const data: any = resp.dataJson || {};
+        return data as ServiceDataResponse;
+    } catch (e) {
+        console.error('[worldtimeapi] Failed to get time by public IP', e);
+        throw e;
+    }
+}
+
+export { getTimeByTimezone, getTimeByIp, getTimeByPublicIp };