@24i/bigscreen-sdk 1.1.0 → 2.1.1-alpha.2133

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

@@ -1,43 +0,0 @@
-/**
- * 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 +0,0 @@
-export {
-    Options,
-    ParamOptions,
-    ServiceDataResponse,
-    getTime,
-} from './24iMediaTimeApi';

package/packages/utils/src/forceReflow.ts

@@ -1,14 +0,0 @@
-import { Reference, unwrapReference } from '@24i/bigscreen-sdk/jsx';
-
-/**
- * To force a DOM reflow on given DOM element. It can be needed for transitions
- * or other purposes.
- * @param elementOrReference DOM element or reference to element on which reflow is called.
- */
-export const forceReflow = (
-    elementOrReference: HTMLElement | Reference<HTMLElement>,
-) => {
-    const element = unwrapReference(elementOrReference);
-    if (!element) return;
-    void element.offsetHeight; // eslint-disable-line no-void
-};

package/packages/utils/src/keyPress/index.ts

@@ -1,6 +0,0 @@
-export {
-    registerKeyPressSimulator,
-    unregisterKeyPressSimulator,
-    dispatchKeyboardEvent,
-} from './keyPressSimulator';
-export { simulateKeyPress } from './simulateKeyPress';

package/packages/utils/src/keyPress/keyPressSimulator.ts

@@ -1,74 +0,0 @@
-import { Key } from '@24i/bigscreen-sdk/driver-base/keymap';
-import { stopEvent } from '@24i/bigscreen-sdk/utils';
-
-let keysPressed: Record<number, boolean>;
-
-interface CustomKeyboardEvent extends KeyboardEvent {
-    skipKeyPressSimulation: boolean;
-}
-
-const shouldSkipEvent = (e: KeyboardEvent) => (
-    Boolean((e as CustomKeyboardEvent).skipKeyPressSimulation)
-);
-
-const onKeyDown = (e: KeyboardEvent) => {
-    if (shouldSkipEvent(e)) return;
-    const { keyCode } = e;
-    if (keysPressed[keyCode] === true) {
-        console.warn(`Key ${e.code} (${e.keyCode}) is skipped by the key press simulator`);
-        stopEvent(e);
-    } else if (typeof keysPressed[keyCode] !== 'undefined') {
-        keysPressed[keyCode] = true;
-    }
-};
-
-const onKeyUp = (e: KeyboardEvent) => {
-    const { keyCode } = e;
-    if (keysPressed[keyCode] === true) keysPressed[keyCode] = false;
-};
-
-/**
- * Modifies `keydown` event behavior to similar to `keypress` and causes
- * triggering `keydown` event only once before the key is released. This is
- * because `keypress` event is deprecated and it is not implemented with the same
- * behavior on all platforms. This functionality is applied across the board for
- * all provided keys globally. To use in one specific handler only
- * use `simulateKeyPress` util.
- * @param keys array with keys to behave as keypress
- */
-export const registerKeyPressSimulator = (keys: Key[]) => {
-    keysPressed = {};
-    keys.forEach((key) => {
-        keysPressed[key.keyCode] = false;
-    });
-    window.document.addEventListener('keydown', onKeyDown, true);
-    window.document.addEventListener('keyup', onKeyUp, true);
-};
-
-/**
- * Unregister key press simulator events, turn off the functionality.
- */
-export const unregisterKeyPressSimulator = () => {
-    window.document.removeEventListener('keydown', onKeyDown, true);
-    window.document.removeEventListener('keyup', onKeyUp, true);
-};
-
-/**
- * This should be the main method for manually dispatching keyboard events when the
- * key press simulator is registered in the app. When parameter `skipKeyPressSimulation`
- * is `true`, those event's won't be caught by the key press simulator and
- * are no longer under it's influence. Key press simulator should work only with events
- * generated from input device.
- * @param target element target to dispatch event
- * @param event dispatching event
- * @param skipKeyPressSimulation default value is `true`, when false, the event
- * will be caught by the simulator and other dispatched events will be stopped.
- */
-export const dispatchKeyboardEvent = (
-    target: HTMLElement,
-    event: KeyboardEvent,
-    skipKeyPressSimulation = true,
-) => {
-    (event as CustomKeyboardEvent).skipKeyPressSimulation = skipKeyPressSimulation;
-    target.dispatchEvent(event);
-};

package/packages/utils/src/keyPress/simulateKeyPress.ts

@@ -1,25 +0,0 @@
-const NO_KEY = -1;
-
-/**
- * Returns a new `keydown` handler wrapped with the simulated key press functionality.
- * Modifies `keydown` event behavior to similar to `keypress` and causes triggering keydown
- * event only once before the key is released. This is because `keypress` event is deprecated
- * and it is not implemented with the same behavior on all platforms. Apply this globally for
- * the specific keys by using `keyPressSimulator` util.
- * @param onKeyDown original handler for keydown event
- * @returns decorated handler with key press functionality
- */
-export const simulateKeyPress = (onKeyDown: (e: KeyboardEvent) => void) => {
-    let keyPressed = NO_KEY;
-    const onKeyUp = (e: KeyboardEvent) => {
-        if (e.keyCode !== keyPressed) return;
-        window.document.removeEventListener('keyup', onKeyUp);
-        keyPressed = NO_KEY;
-    };
-    return (e: KeyboardEvent) => {
-        if (keyPressed !== NO_KEY) return;
-        keyPressed = e.keyCode;
-        window.document.addEventListener('keyup', onKeyUp);
-        onKeyDown(e);
-    };
-};

package/utils/release/release.ts

@@ -1,154 +0,0 @@
-import { ok } from 'assert';
-import { execSync, ExecSyncOptions } from 'child_process';
-
-const branchNames = {
-    dev: 'development',
-    main: 'master',
-    release: 'release',
-};
-
-const cmdSync = (command: string, options?: ExecSyncOptions) => execSync(command, options);
-const cmdSyncInheritOut = (command: string) => cmdSync(command, { stdio: 'inherit' });
-const cmdSyncPipeOut = (command: string) => cmdSync(command, { stdio: 'pipe' });
-const cmdSyncTrimOut = (command: string) => cmdSync(command).toString().trim();
-
-const splitByNewLine = (string = '') => string.split(/\r?\n/);
-
-const statusList = () => {
-    const gitCmd = 'git status --porcelain';
-    const outputString = cmdSyncTrimOut(gitCmd);
-
-    if (!outputString) return [];
-    const handleMultipleWhitespaces = (rowString: string) => {
-        const spaceChar = ' ';
-        const parts = rowString.split(spaceChar);
-        return parts.filter(Boolean).join(spaceChar);
-    };
-
-    return splitByNewLine(outputString).map(handleMultipleWhitespaces);
-};
-const createBranch = (branchName: string) => cmdSyncPipeOut(`git branch ${branchName}`);
-const checkout = (branchName: string) => cmdSyncPipeOut(`git checkout ${branchName}`);
-const addAll = () => cmdSyncPipeOut('git add --all');
-
-const commit = (commitMessage: string, noVerify = false) => {
-    const maybeNoVerifyParam = noVerify ? '--no-verify' : '';
-    return cmdSyncPipeOut(`git commit -m "${commitMessage}" ${maybeNoVerifyParam}`.trimEnd());
-};
-
-const push = (branchName: string, noVerify = false) => {
-    const maybeNoVerifyParam = noVerify ? '--no-verify' : '';
-    const cmd = `git push --set-upstream origin ${branchName} ${maybeNoVerifyParam}`.trimEnd();
-    return cmdSyncPipeOut(cmd);
-};
-
-const pushTag = (version: string) => {
-    const cmd = `git push origin v${version}`;
-    return cmdSyncPipeOut(cmd);
-};
-
-const assertEmptyStatusList = () => {
-    ok(statusList().length === 0, 'An empty GIT stage is expected!');
-};
-
-const getCurrentBranchName = () => cmdSyncTrimOut('git branch --show-current');
-
-const remoteBranchExists = (expectedBranchName: string) => {
-    const gitCmd = `git ls-remote --heads origin ${expectedBranchName}`;
-    const output = cmdSyncTrimOut(gitCmd);
-    return Boolean(output);
-};
-
-// only for GitHub
-const pullRequest = (fromBranch: string, toBranch: string, prTitle: string) => {
-    const cmdTool = 'hub';
-    const installDocUrl = 'https://github.com/github/hub#installation';
-    const errorMsg = `${cmdTool} is not installed! See ${installDocUrl}\n`;
-
-    try {
-        const toolPath = cmdSyncTrimOut(`${cmdTool} --version`);
-        ok(toolPath, errorMsg);
-    } catch (error) {
-        throw new Error(errorMsg);
-    }
-
-    const cmd = `${cmdTool} pull-request -m "${prTitle}" --head ${fromBranch} --base ${toBranch}`;
-    cmdSyncInheritOut(cmd);
-};
-
-const assertCurrentBranch = (expectedBranchName: string) => {
-    const currentGitBranchName = getCurrentBranchName();
-    // eslint-disable-next-line max-len
-    const errorMsg = `The ${expectedBranchName} branch is expected to be active, not "${currentGitBranchName}"`;
-    ok(currentGitBranchName === expectedBranchName, errorMsg);
-};
-
-const bumpVersion = (version: string | 'major' | 'minor' | 'patch') => {
-    // it bumps version, creates commit and GIT tag
-    execSync(`npm version ${version}`, { stdio: 'inherit' });
-};
-
-const getNewReleaseBranchName = () => {
-    const date = new Date();
-    const yyyy = date.getFullYear();
-    const mm = String(date.getMonth() + 1).padStart(2, '0');
-    const dd = String(date.getDate()).padStart(2, '0');
-    let bod = 0;
-    const dateString = `${yyyy}-${mm}-${dd}`;
-    while (true) {
-        bod += 1;
-        const bodString = String(bod).padStart(2, '0');
-        const branchName = `${branchNames.release}/${dateString}-${bodString}`;
-        if (!remoteBranchExists(branchName)) {
-            return branchName;
-        }
-    }
-};
-
-/**
- * Release process.
- * @param versionType Version type one of 'major', 'minor', 'patch' or specific
- * version like '0.0.2'.
- */
-const release = (versionType: string | 'major' | 'minor' | 'patch') => {
-    console.log(`Start release with version: ${versionType}`);
-    assertCurrentBranch(branchNames.dev);
-    assertEmptyStatusList();
-    const newReleaseBranchName = getNewReleaseBranchName();
-
-    console.log(`Creating "${newReleaseBranchName}" branch ...`);
-    createBranch(newReleaseBranchName);
-    checkout(newReleaseBranchName);
-
-    console.log(`Bumping version with "${versionType}" ...`);
-    bumpVersion(versionType);
-    const version = cmdSyncTrimOut('npm pkg get version').replace(/"/g, '');
-    ok(version, 'Oops, cannot get current version from package.json');
-
-    console.log(`Publishing package version: ${version} ...`);
-    cmdSyncInheritOut('npm publish');
-
-    console.log(`Generating changelog: ${version} ...`);
-    cmdSyncInheritOut('npm run generate-changelog');
-    addAll(); // add version changes (changelog) into a git stage
-
-    console.log('Creating commit with changed version and changelog ...');
-    commit('chore(CHANGELOG): generated changelog', true);
-
-    console.log(`Pushing ${newReleaseBranchName} branch ...`);
-    push(newReleaseBranchName, true);
-
-    console.log(`Pushing ${version} tag ...`);
-    pushTag(version);
-
-    const prTitle = `Release: ${newReleaseBranchName.split('/')[1]}`;
-    // eslint-disable-next-line max-len
-    console.log(`Creating Pull Request from ${newReleaseBranchName} branch to ${branchNames.main} branch...`);
-    console.log(`Applied PR title: "${prTitle}"`);
-    pullRequest(newReleaseBranchName, branchNames.main, prTitle);
-
-    console.log('Done!');
-};
-
-const version = process.argv[2] || 'patch'; // 'major' | 'minor' | 'patch'
-release(version);