@24i/smartapps-bigscreen-rnv-build-engine 0.8.5 → 0.8.6-alpha.1402

package/README.md

@@ -18,6 +18,7 @@ sidebar_label: Rnv Build Engine
 - [Available Webpack Injections](#available-webpack-injections)
 - [Package content](#package-content)
 - [How to set up new project with SmartApps BIGscreen build engine](#how-to-set-up-new-project-with-smartapps-bigscreen-build-engine)
+- [How to add new platform](#how-to-add-new-platform)
 
 ---
 ## About the package
@@ -46,7 +47,7 @@ it
 | **webOS**  | LG       | `webos`  | `.ipk`                 | `*.webos.tv.{js,jsx,ts,tsx,json}` |                                  |
 | **WebTV**  | N/A      | `webtv`  | `.zip`                 | `*.webtv.{js,jsx,ts,tsx,json}`    | for previewing builds in browser |
 
-When building the application with ReNative, if file with ***registered platform extensinon*** is found,
+When building the application with ReNative, if file with ***registered platform extension*** is found,
 it takes precedence and is bundled instead of file without registered file extension (such as `index.ts`).  
 For instance, this approach is useful (and is used) for platform drivers - only concrete driver can be bundled into the final package for selected platform:
 
@@ -107,11 +108,12 @@ Currently, following variable names are configured for replacing:
 | :-------------------------------------------- | :----: | ------------------------------------------------------- | :-----------------------------------------: |
 | **WEBPACK_INJECTION_APP_CONFIG_ID**           | string | flavour id  *(value of rnv CLI `-c` param value)*       | `'animated_1080'`, `'basic_720'`            |
 | **WEBPACK_INJECTION_APP_CREATED**             | string | build time in ISO 8601 format                           | `'2021-07-30T09:18:26.014Z'`                |
+| **WEBPACK_INJECTION_APP_SCHEME**              | string | scheme used during the build                            | `'debug'`, `'rc:latest'`, `'release:dist'`  |
 | **WEBPACK_INJECTION_APP_RESOLUTION**          | string | app resolution in `<WIDTH>x<HEIGHT>` format (in pixels) | `'1920x1080'`, `'1280x720'`                 |
 | **WEBPACK_INJECTION_APP_VERSION**             | string | app version                                             | `'v0.0.1.dev'`, `'v0.0.1.rc-1'`, `'v0.0.1'` |
 | **WEBPACK_INJECTION_APP_ENVIRONMENT**         | string | environment used during the build                       | `'development'`, `'production'`             |
 | **WEBPACK_INJECTION_APP_PLATFORM**            | string | platform id  *(value of rnv CLI `-p` param value)*      | `'webtv'`, `'webos'`, `'tizen'`, `'entone'` |
-| **WEBPACK_INJECTION_APP_RUNTIME_CONFIG_PATH** | string | path to JSON app config, imported when app is starting  | `'./public/content/conf/config.json'`       |
+| **WEBPACK_INJECTION_APP_CONTENT_PATH**        | string | path to content directory                               | `'./public/content'`                        |
 
 An example:
 ```typescript
@@ -210,3 +212,7 @@ and `.travis.yml`config file (related to Travis CI).
 > To **start a new project** with usage of our build process,
 > please use [SmartApps BIGscreen Template repository](https://github.com/24i/smartapps-bigscreen-template),
 > it uses this package and contains other required configuration files as well.
+
+---
+## How to add new platform
+To see how to add new platform, click [here](docs/PLATFORM_ADD.md).

package/dist/src/index.js

@@ -51,26 +51,32 @@ exports.default = {
         [constants_1.Platforms.ENTONE]: {
             extenstions: generateEngineExtensions(['entone']),
             defaultPort: 8094,
+            isWebHosted: true,
         },
         [constants_1.Platforms.HBBTV]: {
             extenstions: generateEngineExtensions(['hbbtv.tv']),
             defaultPort: 8095,
+            isWebHosted: true,
         },
         [constants_1.Platforms.SAPHI]: {
             extenstions: generateEngineExtensions(['saphi.tv']),
             defaultPort: 8096,
+            isWebHosted: true,
         },
         [constants_1.Platforms.TIZEN]: {
             extenstions: generateEngineExtensions(['tizen.tv']),
             defaultPort: 8087,
+            isWebHosted: true,
         },
         [constants_1.Platforms.WEBOS]: {
             extenstions: generateEngineExtensions(['webos.tv']),
             defaultPort: 8088,
+            isWebHosted: true,
         },
         [constants_1.Platforms.WEBTV]: {
             extenstions: generateEngineExtensions(['webtv']),
             defaultPort: 8080,
+            isWebHosted: true,
         },
     },
 };

package/dist/src/scripts/gitReleaser/beforeVersionBump.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const strict_1 = require("assert/strict");
+const assert_1 = require("assert");
 const resolvers_1 = require("../../resolvers");
 const gitUtils_1 = require("../utils/gitUtils");
 const c = resolvers_1.getBaseConfig();
 const { branchNames, commitTitles } = c.buildConfig.common.git;
-strict_1.ok(branchNames.dev);
-strict_1.ok(branchNames.rc);
-strict_1.ok(commitTitles.versionBump);
+assert_1.ok(branchNames.dev);
+assert_1.ok(branchNames.rc);
+assert_1.ok(commitTitles.versionBump);
 gitUtils_1.assertCurrentBranch(branchNames.dev);
 gitUtils_1.assertEmptyStatusList();

package/dist/src/scripts/gitReleaser/checkReleaseNotes.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.checkReleaseNotes = void 0;
-const strict_1 = require("assert/strict");
+const assert_1 = require("assert");
 const utils_1 = require("../utils");
 const checkReleaseNotes = (c) => {
     const { relativePath, requiredRows = [] } = c.buildConfig.common.releaseNotes;
@@ -9,7 +9,7 @@ const checkReleaseNotes = (c) => {
     const fileContent = utils_1.fsUtils.getFileContentAsString(relativePath);
     const assertFileContentRow = (expectedRowContent) => {
         const errorMsg = `${relativePath} should contain following row: "${expectedRowContent}"`;
-        strict_1.ok(fileContent.includes(expectedRowContent), errorMsg);
+        assert_1.ok(fileContent.includes(expectedRowContent), errorMsg);
     };
     requiredRows.forEach(assertFileContentRow);
 };

package/dist/src/scripts/gitReleaser/pushRelease.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const strict_1 = require("assert/strict");
+const assert_1 = require("assert");
 const resolvers_1 = require("../../resolvers");
 const utils_1 = require("../utils");
 const checkReleaseNotes_1 = require("./checkReleaseNotes");
@@ -9,17 +9,17 @@ const { branchNames, pullRequestTitles } = c.buildConfig.common.git || {};
 const rcBranchName = branchNames.rc;
 const distBranchName = branchNames.dist;
 const devBranchName = branchNames.dev;
-strict_1.ok(rcBranchName);
-strict_1.ok(distBranchName);
-strict_1.ok(devBranchName);
+assert_1.ok(rcBranchName);
+assert_1.ok(distBranchName);
+assert_1.ok(devBranchName);
 utils_1.gitUtils.assertCurrentBranch(rcBranchName);
 utils_1.gitUtils.assertEmptyStatusList();
 utils_1.gitUtils.assertRemoteBranch(rcBranchName);
 utils_1.gitUtils.assertRemoteBranch(distBranchName);
 const distributionPrTitle = pullRequestTitles.rcToDist;
 const developmentPrTitle = pullRequestTitles.rcToDev;
-strict_1.ok(distributionPrTitle);
-strict_1.ok(developmentPrTitle);
+assert_1.ok(distributionPrTitle);
+assert_1.ok(developmentPrTitle);
 utils_1.gitUtils.pull();
 checkReleaseNotes_1.checkReleaseNotes(c);
 console.log(`Creating Pull Request from ${rcBranchName} branch to ${distBranchName} branch...`);

package/dist/src/scripts/gitReleaser/pushReleaseNotes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const strict_1 = require("assert/strict");
+const assert_1 = require("assert");
 const resolvers_1 = require("../../resolvers");
 const utils_1 = require("../utils");
 const checkReleaseNotes_1 = require("./checkReleaseNotes");
@@ -11,10 +11,10 @@ const rcBranchName = branchNames.rc;
 const releaseNotesBranchName = branchNames.rcReleaseNotes;
 const commitTitle = commitTitles.rcReleaseNotes;
 const prTitle = pullRequestTitles.releaseNotesToRc;
-strict_1.ok(relativePath);
-strict_1.ok(releaseNotesBranchName);
-strict_1.ok(commitTitle);
-strict_1.ok(prTitle);
+assert_1.ok(relativePath);
+assert_1.ok(releaseNotesBranchName);
+assert_1.ok(commitTitle);
+assert_1.ok(prTitle);
 utils_1.gitUtils.assertCurrentBranch(rcBranchName);
 utils_1.gitUtils.assertRemoteBranch(rcBranchName);
 checkReleaseNotes_1.checkReleaseNotes(c);
@@ -25,7 +25,7 @@ if (changedFilesCount === 0) {
     console.log('Skipping making a commit, if needed, please continue on your own (manually).');
 }
 else {
-    strict_1.ok(changedFilesCount === 1, `Only ${relativePath} should contain changes!`);
+    assert_1.ok(changedFilesCount === 1, `Only ${relativePath} should contain changes!`);
     utils_1.gitUtils.createBranch(releaseNotesBranchName);
     utils_1.gitUtils.checkout(releaseNotesBranchName);
     utils_1.gitUtils.add([relativePath]);

package/dist/src/scripts/release/githubRelease.js

@@ -22,7 +22,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.githubRelease = void 0;
 const child_process_1 = require("child_process");
 const fs = __importStar(require("fs"));
-const strict_1 = require("assert/strict");
+const assert_1 = require("assert");
 const path_1 = require("path");
 const resolvers_1 = require("../../resolvers");
 const urlsMarkdown_1 = require("./urlsMarkdown");
@@ -58,7 +58,7 @@ const deleteFileIfExists = (filePath) => {
 };
 const makeGitHubReleaseNotes = (c) => {
     const releaseNotesPath = getReleaseNotesPath(c);
-    strict_1.ok(releaseNotesPath, 'The path to the file with release notes is missing!');
+    assert_1.ok(releaseNotesPath, 'The path to the file with release notes is missing!');
     deleteFileIfExists(githubReleaseNotesPath);
     child_process_1.execSync(`sed '1d;2d' ${releaseNotesPath} >> ${githubReleaseNotesPath}`);
     const textToAppend = urlsMarkdown_1.getUrlsMarkdown(c);
@@ -67,11 +67,11 @@ const makeGitHubReleaseNotes = (c) => {
 const createRelease = (c) => {
     const { packageVersion, git } = c.buildConfig.common;
     const versionLabel = `v${packageVersion}`;
-    strict_1.ok(token, 'process.env.GITHUB_TOKEN is not set!');
-    strict_1.ok(targetCommit, 'process.env.TRAVIS_COMMIT is not set!');
-    strict_1.ok(git.owner, 'Missing value for rnv config prop: common.git.owner');
-    strict_1.ok(git.repo, 'Missing value for rnv config prop: common.git.repo');
-    strict_1.ok(packageVersion);
+    assert_1.ok(token, 'process.env.GITHUB_TOKEN is not set!');
+    assert_1.ok(targetCommit, 'process.env.TRAVIS_COMMIT is not set!');
+    assert_1.ok(git.owner, 'Missing value for rnv config prop: common.git.owner');
+    assert_1.ok(git.repo, 'Missing value for rnv config prop: common.git.repo');
+    assert_1.ok(packageVersion);
     makeGitHubReleaseNotes(c);
     const releaseNotesContent = fs.readFileSync(githubReleaseNotesPath).toString();
     const data = {
@@ -119,7 +119,7 @@ const uploadZipWithPlatformBuilds = (c, platformName, githubUploadUrl) => {
 const githubRelease = (c) => {
     const releaseResponse = createRelease(c) || {};
     const uploadUrl = releaseResponse.upload_url;
-    strict_1.ok(uploadUrl, 'Missing "upload_url" in release response!');
+    assert_1.ok(uploadUrl, 'Missing "upload_url" in release response!');
     c.buildConfig.defaults.supportedPlatforms.forEach((platformName) => {
         uploadZipWithPlatformBuilds(c, platformName, uploadUrl);
     });

package/dist/src/scripts/utils/fsUtils.js

@@ -21,11 +21,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.assertPath = exports.getFileContentAsString = void 0;
 const fs = __importStar(require("fs"));
-const strict_1 = require("assert/strict");
+const assert_1 = require("assert");
 const getFileContentAsString = (filePath) => fs.readFileSync(filePath).toString();
 exports.getFileContentAsString = getFileContentAsString;
 const assertPath = (path) => {
     const errorMsg = `File or path ${path} does not exist!`;
-    strict_1.ok(fs.existsSync(path), errorMsg);
+    assert_1.ok(fs.existsSync(path), errorMsg);
 };
 exports.assertPath = assertPath;

package/dist/src/scripts/utils/gitUtils.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.assertRemoteBranch = exports.assertCurrentBranch = exports.assertEmptyStatusList = exports.push = exports.commit = exports.createBranch = exports.checkout = exports.add = exports.addAll = exports.pull = exports.remoteBranchExists = exports.pullRequest = exports.getCurrentBranchName = exports.statusList = void 0;
-const strict_1 = require("assert/strict");
+const assert_1 = require("assert");
 const cmdUtils_1 = require("./cmdUtils");
 const stringUtils_1 = require("./stringUtils");
 const statusList = () => {
@@ -25,7 +25,7 @@ const pullRequest = (fromBranch, toBranch, prTitle) => {
     const errorMsg = `${cmdTool} is not installed! See ${installDocUrl}\n`;
     try {
         const toolPath = cmdUtils_1.cmdSyncTrimOut(`${cmdTool} --version`);
-        strict_1.ok(toolPath, errorMsg);
+        assert_1.ok(toolPath, errorMsg);
     }
     catch (error) {
         throw new Error(errorMsg);
@@ -62,17 +62,17 @@ const push = (branchName, noVerify) => {
 };
 exports.push = push;
 const assertEmptyStatusList = () => {
-    strict_1.ok(statusList().length === 0, 'An empty GIT stage is expected!');
+    assert_1.ok(statusList().length === 0, 'An empty GIT stage is expected!');
 };
 exports.assertEmptyStatusList = assertEmptyStatusList;
 const assertCurrentBranch = (expectedBranchName) => {
     const currentGitBranchName = getCurrentBranchName();
     const errorMsg = `The ${expectedBranchName} branch is expected to be active, not "${currentGitBranchName}"`;
-    strict_1.ok(currentGitBranchName === expectedBranchName, errorMsg);
+    assert_1.ok(currentGitBranchName === expectedBranchName, errorMsg);
 };
 exports.assertCurrentBranch = assertCurrentBranch;
 const assertRemoteBranch = (expectedBranchName) => {
     const errorMsg = `Remote branch ${expectedBranchName} does not exist!`;
-    strict_1.ok(remoteBranchExists(expectedBranchName), errorMsg);
+    assert_1.ok(remoteBranchExists(expectedBranchName), errorMsg);
 };
 exports.assertRemoteBranch = assertRemoteBranch;

package/dist/src/sdks/sdk-webos/index.js

@@ -22,13 +22,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.handleWebosSdk = exports.configureWebOSProject = exports.buildWebOSProject = exports.runWebOS = void 0;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
-const semver = __importStar(require("semver"));
 const os_1 = require("os");
 const rnv_1 = require("rnv");
 const sdkUtils_1 = require("../sdkUtils");
 const { writeCleanFile } = rnv_1.FileUtils;
 const { execCLI } = rnv_1.Exec;
-const { getPlatformProjectDir, getTemplateProjectDir, getPlatformBuildDir, getAppVersion, getAppTitle, getAppId, getAppDescription, getConfigProp, checkPortInUse, confirmActiveBundler, addSystemInjects, } = rnv_1.Common;
+const { getPlatformProjectDir, getTemplateProjectDir, getPlatformBuildDir, getConfigProp, checkPortInUse, confirmActiveBundler, } = rnv_1.Common;
 const { buildCoreWebpackProject, runWebpackServer, configureCoreWebProject, waitForWebpack, } = rnv_1.WebpackUtils;
 const { isPlatformActive } = rnv_1.PlatformManager;
 const { chalk, logTask, logInfo, logSuccess, logError } = rnv_1.Logger;
@@ -94,40 +93,14 @@ const buildWebOSProject = async (c) => {
 exports.buildWebOSProject = buildWebOSProject;
 const configureProject = async (c) => {
     logTask('configureProject');
-    const { platform } = c;
     const configFile = 'appinfo.json';
-    const injects = [
-        {
-            pattern: '{{APPLICATION_ID}}',
-            override: getAppId(c, platform).toLowerCase(),
-        },
-        {
-            pattern: '{{APP_TITLE}}',
-            override: getAppTitle(c, platform),
-        },
-        {
-            pattern: '{{APP_VERSION}}',
-            override: semver.coerce(getAppVersion(c, platform)),
-        },
-        {
-            pattern: '{{APP_DESCRIPTION}}',
-            override: getAppDescription(c, platform),
-        },
-        {
-            pattern: '{{APP_BG_COLOR}}',
-            override: getConfigProp(c, platform, 'bgColor', '#fff'),
-        },
-        {
-            pattern: '{{APP_ICON_COLOR}}',
-            override: getConfigProp(c, platform, 'iconColor', '#000'),
-        },
-        {
-            pattern: '{{APP_VENDOR}}',
-            override: getConfigProp(c, platform, 'vendor', '24i'),
-        },
-    ];
-    addSystemInjects(c, injects);
-    writeCleanFile(path.join(getTemplateProjectDir(c), configFile), path.join(getPlatformProjectDir(c), configFile), injects, null, c);
+    const configFileSource = path.join(getTemplateProjectDir(c), configFile);
+    const configFileDest = path.join(getPlatformProjectDir(c), configFile);
+    writeCleanFile(configFileSource, configFileDest, [], null, c);
+    let fileContent = fs.readFileSync(configFileDest).toString();
+    fileContent = fileContent.replace(/"true"/g, 'true');
+    fileContent = fileContent.replace(/"false"/g, 'false');
+    fs.writeFileSync(configFileDest, fileContent);
     return true;
 };
 const configureWebOSProject = async (c) => {
@@ -139,7 +112,7 @@ const configureWebOSProject = async (c) => {
     await copyAssetsFolder(c, platform);
     await configureCoreWebProject(c);
     await configureProject(c);
-    copyBuildsFolder(c, platform);
+    await copyBuildsFolder(c, platform);
 };
 exports.configureWebOSProject = configureWebOSProject;
 const sdkInstallerUUrl = 'https://s3.amazonaws.com/tools.nxg-bigscreen.24imedia.com/sdks/webos/ares_webos_builder_v1.10.4_multiplatform.zip';

package/dist/templates/platforms/_shared/webpack.base.js

@@ -50,10 +50,9 @@ const includeRtlFiles = ({ shouldIncludeRtlFiles }) => (content, loaderContext)
     }
     return content;
 };
-const relativePathToAppRuntimeCfg = path_1.default.join('conf', 'config.json');
-const getAppRuntimeConfigPath = (baseUrl, isBuildHosted = false) => {
+const getAppContentPath = (baseUrl, isBuildHosted = false) => {
     const isBuildHostedAndHasBaseUrl = isBuildHosted && !!baseUrl;
-    const relativePath = path_1.default.join(isBuildHostedAndHasBaseUrl ? './public' : '', 'content', relativePathToAppRuntimeCfg);
+    const relativePath = path_1.default.join(isBuildHostedAndHasBaseUrl ? './public' : '', 'content');
     return isBuildHostedAndHasBaseUrl
         ? `${baseUrl}/${relativePath}`
         : relativePath;
@@ -151,7 +150,7 @@ function generateConfig(config) {
             }
         });
     }
-    const appRuntimeConfigPath = getAppRuntimeConfigPath(baseUrl, isBuildHosted);
+    const appContentPath = getAppContentPath(baseUrl, isBuildHosted);
     const copiedDirWithPublicContentPath = path_1.default.join(appBuildDir, `../${path_1.default.parse(appBuildDir).name}-public`);
     const plugins = {
         forkTsChecker: new fork_ts_checker_webpack_plugin_1.default({
@@ -163,11 +162,12 @@ function generateConfig(config) {
         webpack: new webpack_1.default.DefinePlugin({
             WEBPACK_INJECTION_APP_CONFIG_ID: JSON.stringify(config.appConfigId || ''),
             WEBPACK_INJECTION_APP_CREATED: JSON.stringify(new Date().toISOString()),
+            WEBPACK_INJECTION_APP_SCHEME: JSON.stringify(config.scheme || ''),
             WEBPACK_INJECTION_APP_RESOLUTION: JSON.stringify(getResolutionString(config)),
             WEBPACK_INJECTION_APP_VERSION: JSON.stringify(buildVersion || ''),
             WEBPACK_INJECTION_APP_ENVIRONMENT: JSON.stringify(config.environment || ''),
             WEBPACK_INJECTION_APP_PLATFORM: JSON.stringify(PLATFORM || ''),
-            WEBPACK_INJECTION_APP_RUNTIME_CONFIG_PATH: JSON.stringify(appRuntimeConfigPath),
+            WEBPACK_INJECTION_APP_CONTENT_PATH: JSON.stringify(appContentPath),
         }),
         html: new html_webpack_plugin_1.default({
             alwaysWriteToDisk: true,
@@ -201,8 +201,8 @@ function generateConfig(config) {
                     isDevServer ? {
                         move: [
                             {
-                                source: path_1.default.join(appBuildDir, 'project', 'public', 'content', relativePathToAppRuntimeCfg),
-                                destination: path_1.default.join(appBuildEngineProjectDir, 'content', relativePathToAppRuntimeCfg),
+                                source: path_1.default.join(appBuildDir, 'project', 'public', 'content'),
+                                destination: path_1.default.join(appBuildEngineProjectDir, 'content'),
                             },
                         ],
                     } : null,

package/dist/templates/platforms/webos/project/appinfo.json

@@ -1,12 +1,19 @@
 {
-    "vendor": "24i",
-    "largeIcon": "app_icon_130x130.png",
     "icon": "app_icon_80x80.png",
-    "main": "public/index.html",
     "id": "{{configProps.id}}",
+    "largeIcon": "app_icon_130x130.png",
+    "main": "public/index.html",
+    "splashBackground": "splash_background_1920x1080.png",
     "title": "{{configProps.title}}",
     "type": "web",
-    "resolution": "{{configProps.webpackConfig.resolution.width}}x{{configProps.webpackConfig.resolution.height}}",
+    "vendor": "{{configProps.author.name}}",
+    "version": "{{configProps.packageVersion}}",
+    "appDescription": "{{configProps.description}}",
+    "bgColor": "{{configProps.backgroundColor}}",
+    "bgImage": "{{configProps.appinfo.bgImage}}",
     "disableBackHistoryAPI": true,
-    "version": "{{APP_VERSION}}"
+    "handlesRelaunch": "{{configProps.appinfo.handlesRelaunch}}",
+    "iconColor": "{{configProps.appinfo.iconColor}}",
+    "resolution": "{{configProps.webpackConfig.resolution.width}}x{{configProps.webpackConfig.resolution.height}}",
+    "transparent": "{{configProps.appinfo.transparent}}"
 }

package/docs/PLATFORM_ADD.md

@@ -0,0 +1,60 @@
+# rnv-build-engine
+## How to add new platform
+
+---
+### Choose platform ID
+To see actual list of platform IDs, see table in [Supported platforms](../README.md#supported-platforms) section.
+
+Platform ID is needed for ReNative CLI - to specify requested platform for build or for example for deploy:
+
+`rnv build -c <flavour> -s <scheme> -p <platform_id>`
+
+`rnv deploy -c <flavour> -s <scheme> -p <platform_id>`
+
+---
+### Choose file extension for new platform
+Please read [Supported platforms](../README.md#supported-platforms) section,
+where platform file extensions and their usage are described.
+
+---
+### Prepare driver for new platform
+#### 1. Implement new platform driver
+- Use [packages/create-package](../../create-package) to create a new package with driver for requested platform.
+Name the new package `driver-<platform_id>` and implement the platform driver inside it.
+Have a look at other driver packages to inspire.
+
+#### 2. Include new platform driver into `device` package
+- In [packages/device/src/resolver/index.ts](../../device/src/resolver/index.ts),
+import driver for new platform from just created package with platform driver (previous step)
+by the same way as other platform drivers.
+- According to [Choose file extension for new platform](#choose-file-extension-for-new-platform) section,
+in [packages/device/src/driver/](../../device/src/driver) dir,
+add `index.<platform_extension>.ts` file and inside it, export new driver by the same way as other drivers.
+
+---
+### How to extend build engine with new platform
+- in [package.json](../package.json), in `peerDependencies`, update version of `@24i/smartapps-bigscreen-device` package to new version (created in step above)
+- add requested platform record into [renative.engine.json](../renative.engine.json)
+- add requested platform record into [src/constants/platforms.ts](../src/constants/platforms.ts)
+- add requested platform record into [src/index.ts](../src/index.ts):
+  - set file extension(s) for requested platform *(see [Choose file extension for new platform](#choose-file-extension-for-new-platform) section)*
+  - set value for `defaultPort`
+  - set `isWebHosted` to `true`
+- add following webpack configs into `templates/platforms/<platform_id>/` dir *(you can copy them from `webtv` platform and edit as you need)*:
+  - `webpack.config.dev.ts`
+  - `webpack.config.prod.ts`
+- add record for new platform into [src/scripts/release/urlsMarkdown.ts](../src/scripts/release/urlsMarkdown.ts) file, in `beautifyPlatformName` function
+- extend build engine [tasks](../src/tasks) with new platform:
+  - extend `buildFn` in [src/tasks/task.rnv.build.ts](../src/tasks/task.rnv.build.ts) file with new platform
+  - extend `configureFn` in [src/tasks/task.rnv.configure.ts](../src/tasks/task.rnv.configure.ts) file with new platform
+  - extend `deployFn` in [src/tasks/task.rnv.deploy.ts](../src/tasks/task.rnv.deploy.ts) file with new platform
+  - extend `startFn` in [src/tasks/task.rnv.start.ts](../src/tasks/task.rnv.start.ts) file with new platform
+- add info about new platform into [Supported platforms](../README.md#supported-platforms) section
+- if needed, do other custom modifications / extends
+- create alpha version of the package
+  (tutorial [here](https://24imedia.atlassian.net/wiki/spaces/PRDNGBIGSCR/pages/1183481960/Preparing+Alpha+Builds+After+Merged+PR+and+Before+Full+Publish))
+
+---
+### How to extend SmartApps Template repository with new platform
+The last step is updating [SmartApps Template repository](https://github.com/24i/smartapps-bigscreen-template),
+see its [documentation](https://github.com/24i/smartapps-bigscreen-template/blob/development/docs/PLATFORM_ADD.md) about adding a new platform.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@24i/smartapps-bigscreen-rnv-build-engine",
-	"version": "0.8.5",
+	"version": "0.8.6-alpha.1402+fdefc217",
 	"description": "Package with build engine for SmartApps BIGscreen projects...",
 	"main": "dist/src/index.js",
 	"scripts": {
@@ -61,5 +61,5 @@
 	"keywords": [],
 	"author": "24i",
 	"license": "ISC",
-	"gitHead": "d7a6600d9d06a70defedf4be6e2a5648a620c9ca"
+	"gitHead": "fdefc21765850532808963bb3756f6399010354e"
 }