@24i/smartapps-bigscreen-rnv-build-engine 0.8.6-alpha.1394 → 0.8.6-alpha.1403

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/scripts/release/notifySlack/generateWebhoook.js

@@ -0,0 +1,66 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const https = __importStar(require("https"));
+const querystring = __importStar(require("querystring"));
+const path = __importStar(require("path"));
+const fs = __importStar(require("fs"));
+const replaceWebhookUrl = (newWebhookUrl, channelName) => {
+    const filePath = path.resolve(process.cwd(), 'renative.json');
+    const parsedFile = JSON.parse(fs.readFileSync(filePath).toString());
+    const jsonIndentSpaces = 4;
+    parsedFile.common.deploy.slack.webhookUrl = newWebhookUrl;
+    fs.writeFileSync(filePath, JSON.stringify(parsedFile, null, jsonIndentSpaces));
+    console.log(`Webhook for "${channelName}" channel successfully written into ${filePath}.`);
+};
+const postRequestCallback = (receivedData) => {
+    const parsedData = JSON.parse(receivedData);
+    if (parsedData.ok === false)
+        throw parsedData;
+    const { channel, url } = parsedData.incoming_webhook;
+    console.log(`\nGenerated slack webhook: ${url}`);
+    replaceWebhookUrl(url, channel);
+};
+const { redirect_uri, client_id, client_secret, code } = process.env;
+const formData = querystring.stringify({ redirect_uri, client_id, client_secret, code });
+const requestOptions = {
+    hostname: 'slack.com',
+    path: '/api/oauth.v2.access',
+    method: 'POST',
+    headers: {
+        'Content-Type': 'application/x-www-form-urlencoded',
+        'Content-Length': formData.length,
+    },
+};
+const request = https.request(requestOptions, (response) => {
+    let receivedData = '';
+    response.on('data', (d) => {
+        receivedData += d;
+    });
+    response.on('end', () => {
+        postRequestCallback(receivedData);
+    });
+});
+request.on('error', (error) => {
+    throw error;
+});
+request.write(formData);
+request.end();

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/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.6-alpha.1394+0fca2ad5",
+	"version": "0.8.6-alpha.1403+d577658f",
 	"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": "0fca2ad5a9cc12107cb5c33ccbe1fdb1340d1704"
+	"gitHead": "d577658f9d7a498f73f013be66b7115268a398d7"
 }