@morgan-stanley/composeui-node-launcher 0.1.0-alpha.1

package/README.md

@@ -0,0 +1,108 @@
+<!-- Morgan Stanley makes this available to you under the Apache License, Version 2.0 (the "License"). You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0. See the NOTICE file distributed with this work for additional information regarding copyright ownership. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->
+
+# @morgan-stanley/composeui-node-launcher
+
+## Library
+
+The library enables you to dynamically set properties for your window in your javascript code.
+
+```
+function windowOpenExample() {
+    const window = new BrowserWindow(
+        {
+            url: "https://github.com/morganstanley/composeui",
+            title: "My Web App",
+            width: 1600,
+            height: 800
+        });
+
+    window.open();
+}
+
+
+windowOpenExample();
+```
+
+Or with loadUrl
+
+```
+function loadUrlExample() {
+    const window = new BrowserWindow(
+        {
+            width: 1600,
+            height: 800
+        });
+
+    window.loadUrl("https://github.com/morganstanley/composeui");
+}
+
+loadUrlExample();
+```
+
+In order to set an icon for your application, set the _icon_ property when creating a new _BrowserWindow_. The url set for the icon must either be relative to the app url, or an http or https url. If the host part of the icon url is different from the app url, you must set the _COMPOSE_ALLOWED_IMAGE_SOURCES_ environment value to contain the allowed icon host(s). You may separate multiple allowed hosts with semicolons (;).
+
+## CLI
+
+The CLI enables you to execute your app with compose by executing the following command:
+
+```
+composeui myapp.js
+```
+### Install.js
+
+This script is downloading and extracting the necessary binaries from CDN during `npm install`.
+By default it's downloading the binaries from the github tagged releases but the following variables can be overridden by setting an environment variable or including an .npmrc file:
+
+CDN URL: `COMPOSEUI_CDN_URL` (or `npm_config_composeui_cdn_url`)
+
+```
+COMPOSEUI_CDN_URL='http://127.0.0.1:8080'
+```
+
+version: `COMPOSEUI_VERSION` (or `npm_config_composeui_version`)
+
+```
+COMPOSEUI_VERSION='0.1.0'
+```
+
+skip download: `COMPOSEUI_SKIP_DOWNLOAD` (or `npm_config_composeui_skip_download`)
+
+```
+COMPOSEUI_SKIP_DOWNLOAD='true'
+```
+
+location of the binary: `COMPOSEUI_BINARY_FILE_PATH` (or `npm_config_composeui_binary_file_path`)
+
+```
+COMPOSEUI_BINARY_FILE_PATH='path\to\binary\ComposeUI-Shell.exe'
+```
+
+### Local Development
+
+#### Developing the CLI
+
+If you're developing the CLI itself you need to execute the following command
+
+```
+npm link
+```
+
+in the `./src/shell/js/composeui-node-launcher/` folder.
+
+#### Developing the install.js script
+
+If you're developing the install.js script and would like to test if the binaries downloading and extracting as expected you can serve a folder with a name of the version containing a zip with the binaries locally (e.g with http-server), and set that link for the `COMPOSEUI_CDN_URL` environment variable.
+
+For example:
+
+```
+COMPOSEUI_CDN_URL='http://127.0.0.1:8080'
+```
+
+#### Working with the locally compiled shell binary:
+
+To achieve this you can set the `COMPOSEUI_BINARY_FILE_PATH` variable to point to the exe compiled by Visual Studio:
+
+```
+COMPOSEUI_BINARY_FILE_PATH='path\to\your\project\folder\ComposeUI\src\shell\dotnet\Shell\bin\Debug\net6.0-windows\ComposeUI-Shell.exe'
+```

package/jest.config.ts

@@ -0,0 +1,21 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+export default {
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A preset that is used as a base for Jest's configuration
+  preset: "ts-jest"
+};

package/output/browserWindow.d.ts

@@ -0,0 +1,8 @@
+import { WindowConfig } from './windowConfig';
+export declare class BrowserWindow {
+    private config;
+    private launcher;
+    constructor(config: WindowConfig);
+    open(): void;
+    loadUrl(url: string): void;
+}

package/output/browserWindow.js

@@ -0,0 +1,16 @@
+import { Launcher } from './launcher.js';
+export class BrowserWindow {
+    config;
+    launcher;
+    constructor(config) {
+        this.config = config;
+        this.launcher = new Launcher();
+    }
+    open() {
+        this.launcher.launch(this.config);
+    }
+    loadUrl(url) {
+        this.config.url = url;
+        this.launcher.launch(this.config);
+    }
+}

package/output/cli/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/output/cli/cli.js

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+"use strict";
+import { executeScriptFile } from './executeScrtiptFile.js';
+let fileName = process.argv[2];
+try {
+    executeScriptFile(fileName);
+}
+catch (error) {
+    console.error(error);
+}

package/output/cli/executeScrtiptFile.d.ts

@@ -0,0 +1 @@
+export declare function executeScriptFile(fileName: string): void;

package/output/cli/executeScrtiptFile.js

@@ -0,0 +1,12 @@
+import { fork } from 'child_process';
+import { resolve } from 'path';
+"use strict";
+export function executeScriptFile(fileName) {
+    if (fileName) {
+        let filePath = resolve(fileName);
+        const child = fork(filePath);
+    }
+    else {
+        throw new Error("Specify filename.");
+    }
+}

package/output/index.d.ts

@@ -0,0 +1,5 @@
+export { BrowserWindow } from './browserWindow.js';
+export { Launcher } from './launcher.js';
+export { WindowConfig } from './windowConfig.js';
+export * from './cli/cli.js';
+export { executeScriptFile } from './cli/executeScrtiptFile.js';

package/output/index.js

@@ -0,0 +1,4 @@
+export { BrowserWindow } from './browserWindow.js';
+export { Launcher } from './launcher.js';
+export * from './cli/cli.js';
+export { executeScriptFile } from './cli/executeScrtiptFile.js';

package/output/launcher.d.ts

@@ -0,0 +1,7 @@
+import { WindowConfig } from './windowConfig';
+export declare class Launcher {
+    private composeuiBinaryFileName;
+    private composeuiBinaryFilePath;
+    private processArgs;
+    launch(config?: WindowConfig): void;
+}

package/output/launcher.js

@@ -0,0 +1,29 @@
+import { execFile } from 'child_process';
+import { fileURLToPath } from "node:url";
+export class Launcher {
+    composeuiBinaryFileName = process.platform === 'win32' ? 'ComposeUI-Shell.exe' : 'ComposeUI-Shell';
+    composeuiBinaryFilePath = process.env.npm_config_composeui_binary_file_path || process.env.COMPOSEUI_BINARY_FILE_PATH || fileURLToPath(new URL(`./../dist/${this.composeuiBinaryFileName}`, import.meta.url));
+    processArgs(config) {
+        let argsArray = [];
+        if (config) {
+            for (const [key, value] of Object.entries(config)) {
+                argsArray.push(`--${key}=${value}`);
+            }
+        }
+        return argsArray;
+    }
+    launch(config) {
+        let argsArray = this.processArgs(config);
+        if (!config?.url) {
+            throw new Error("At least the url must be specified!");
+        }
+        const child = execFile(this.composeuiBinaryFilePath, argsArray, (error, stdout, stderr) => {
+            console.log(stdout);
+            if (error) {
+                throw error;
+            }
+        });
+        let exithandler = function () { process.exit(); };
+        child.on('close', exithandler);
+    }
+}

package/output/windowConfig.d.ts

@@ -0,0 +1,7 @@
+export interface WindowConfig {
+    title?: string;
+    icon?: string;
+    url?: string;
+    width?: number;
+    height?: number;
+}

package/output/windowConfig.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@morgan-stanley/composeui-node-launcher",
+  "version": "0.1.0-alpha.1",
+  "private": false,
+  "description": "Package to launch ComposeUI from Node.js",
+  "main": "output/index.js",
+  "module": "output/index.js",
+  "type": "module",
+  "author": "Morgan Stanley",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/morganstanley/ComposeUI.git#main"
+  },
+  "scripts": {
+    "clean": "rimraf output",
+    "build": "npm run clean && tsc",
+    "install": "node ./src/cli/install.js",
+    "test": "jest"
+  },
+  "bin": {
+    "composeui": "./output/cli/cli.js"
+  },
+  "devDependencies": {
+    "@types/jest": "29.4.0",
+    "@types/node": "^18.11.18",
+    "@deranged/unzipper": "^0.10.14",
+    "axios": "^1.3.4",
+    "jest": "29.4.3",
+    "rimraf": "^4.4.0",
+    "ts-jest": "29.0.5",
+    "ts-node": "10.9.1",
+    "tslib": "^2.4.0",
+    "typescript": "^4.7.4"
+  }
+}

package/src/browserWindow.ts

@@ -0,0 +1,19 @@
+import { WindowConfig } from './windowConfig';
+import { Launcher } from './launcher.js';
+
+export class BrowserWindow {
+    private launcher: Launcher;
+  
+    constructor(private config: WindowConfig) {
+        this.launcher = new Launcher();
+    }
+
+    public open() {
+        this.launcher.launch(this.config);
+    }
+
+    public loadUrl(url: string) {
+        this.config.url = url
+        this.launcher.launch(this.config);
+    }
+}

package/src/cli/cli.ts

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+
+"use strict";
+
+import { executeScriptFile } from './executeScrtiptFile.js';
+
+let fileName = process.argv[2];
+
+try {
+    executeScriptFile(fileName);
+} catch (error) {
+    console.error(error);
+}

package/src/cli/executeScriptFile.spec.ts

@@ -0,0 +1,11 @@
+import { executeScriptFile } from './executeScrtiptFile';
+
+describe('CLI', () => {
+  let testFileName: string;
+
+  test('executeScriptFile() - No filename specified', () => {
+    expect(() => {
+      executeScriptFile(testFileName);
+    }).toThrow("Specify filename.");
+  });
+});

package/src/cli/executeScrtiptFile.ts

@@ -0,0 +1,13 @@
+import { fork } from 'child_process';
+import { resolve } from 'path';
+
+"use strict";
+
+export function executeScriptFile(fileName: string){
+    if (fileName) {
+        let filePath: string = resolve(fileName);
+        const child = fork(filePath);
+    } else {
+        throw new Error("Specify filename.");
+    }
+}

package/src/cli/install.js

@@ -0,0 +1,116 @@
+#!/usr/bin/env node
+
+"use strict";
+
+import path from 'path';
+import fs from 'fs';
+import os from 'os';
+
+import axios from 'axios';
+import unzipper from '@deranged/unzipper';
+
+import pkg from './../../package.json' assert { type: "json" };
+
+const DEFAULT_CDN_URL = 'https://github.com/morganstanley/ComposeUI/releases/download';
+
+let cdnUrl = process.env.npm_config_composeui_cdn_url || process.env.COMPOSEUI_CDN_URL || DEFAULT_CDN_URL;
+let downloadedFile = '';
+
+let platform = validatePlatform();
+
+const composeui_version = process.env.npm_config_composeui_version || process.env.COMPOSEUI_VERSION || pkg.version;
+const skipDownload = process.env.npm_config_composeui_skip_download || process.env.COMPOSEUI_SKIP_DOWNLOAD;
+
+const fileName = `composeui-v${composeui_version}-${platform}.zip`;
+let composeuiBinaryFilePath = '';
+
+if (skipDownload === 'true') {
+    console.log('Found COMPOSEUI_SKIP_DOWNLOAD variable, skipping installation.');
+    process.exit(0);
+}
+
+function validatePlatform() {
+    let platform = process.platform;
+
+    if (platform !== 'win32') {
+      console.log('Unexpected platform or architecture:', process.platform, process.arch);
+      process.exit(1);
+    }
+  
+    return platform;
+}
+
+function ensureDirectoryExistence(filePath) {
+    let dirname = path.dirname(filePath);
+    if (fs.existsSync(dirname)) {
+      return true;
+    }
+    ensureDirectoryExistence(dirname);
+    fs.mkdirSync(dirname);
+  }
+
+async function downloadFile(dirToLoadTo) {
+    const tempDownloadedFile = path.resolve(dirToLoadTo, fileName);
+    downloadedFile = tempDownloadedFile;
+    const formattedDownloadUrl =`${cdnUrl}/v${composeui_version}/${fileName}`;
+    
+    console.log('Downloading from file: ', formattedDownloadUrl);
+    console.log('Saving to file:', downloadedFile);
+
+    ensureDirectoryExistence(downloadedFile);
+    await axios.request({
+        method: 'get',
+        url: formattedDownloadUrl,
+        responseType: 'stream'
+    }).then(function (response) {
+        response.data.pipe(fs.createWriteStream(downloadedFile))
+    });
+}
+
+async function extractFile(zipPath, outPath) {
+    let zipFile = `${zipPath}/${fileName}`;
+
+    if (path.extname(zipFile) !== '.zip') {
+        console.log('Skipping zip extraction - binary file found.');
+        return;
+      }
+      console.log(`Extracting zip contents to ${outPath}.`);
+      try {
+        fs.createReadStream(zipFile).pipe(unzipper.Extract({ path: outPath }));
+      } catch (error) {
+        throw new Error('Error extracting archive: ' + error);
+      }
+}
+
+function createTempFolder(){
+    let tempFolderPath
+    try {
+        tempFolderPath = fs.mkdtempSync(path.join(os.tmpdir(), 'composeui-'));
+      } catch (err) {
+        console.error(err);
+      }
+
+      return tempFolderPath;
+}
+
+function isInstalled (outPath) {
+  let composeuiBinaryFileName = process.platform === 'win32' ? 'ComposeUI-Shell.exe' : 'ComposeUI-Shell';
+  composeuiBinaryFilePath = path.resolve(outPath, composeuiBinaryFileName);
+  
+  return fs.existsSync(composeuiBinaryFilePath);
+}
+
+async function install() {
+    const tmpPath = createTempFolder();
+    const outPath = process.cwd() + "/dist";
+
+    if (isInstalled(outPath)){
+      console.log('ComposeUI is already installed.');
+      process.exit(0);
+    }
+    
+    await downloadFile(tmpPath);
+    await extractFile(tmpPath, outPath);
+}
+
+install();

package/src/index.ts

@@ -0,0 +1,5 @@
+export { BrowserWindow } from './browserWindow.js';
+export { Launcher } from './launcher.js';
+export { WindowConfig } from './windowConfig.js';
+export * from './cli/cli.js';
+export { executeScriptFile } from './cli/executeScrtiptFile.js';

package/src/launcher.spec.ts

@@ -0,0 +1,38 @@
+import { mocked } from 'jest-mock'
+import { jest } from '@jest/globals';
+
+import { Launcher } from './launcher';
+import { WindowConfig } from './windowConfig';
+
+
+jest.mock('./launcher', () => {
+  return {
+    Launcher: jest.fn().mockImplementation(() => {
+      return {
+        launch: () => {throw new Error("At least the url must be specified!")},
+      };
+    })
+  };
+});
+
+describe('Launcher', () => {
+  const MockedLauncher = mocked(Launcher, { shallow:true });
+
+  beforeEach(() => {
+     MockedLauncher.mockClear();
+  });
+
+  it('constructor was called', () => {
+    const testLauncher = new Launcher();
+    expect(MockedLauncher).toHaveBeenCalledTimes(1);
+  });
+
+  it('throws if Window config has no parameters', () => {
+    let testWindowConfig: WindowConfig = {};
+
+    expect(() => {
+      const testLauncher = new Launcher();
+      testLauncher.launch(testWindowConfig);
+    }).toThrow("At least the url must be specified!");
+  });
+});

package/src/launcher.ts

@@ -0,0 +1,37 @@
+import { execFile } from 'child_process';
+import { WindowConfig } from './windowConfig';
+import { fileURLToPath } from "node:url";
+
+export class Launcher {
+    private composeuiBinaryFileName = process.platform === 'win32' ? 'ComposeUI-Shell.exe' : 'ComposeUI-Shell'; 
+    private composeuiBinaryFilePath = process.env.npm_config_composeui_binary_file_path || process.env.COMPOSEUI_BINARY_FILE_PATH || fileURLToPath(new URL(`./../dist/${this.composeuiBinaryFileName}`, import.meta.url));   
+
+    private processArgs(config?: WindowConfig) {
+        let argsArray = [];
+        if (config) {
+            for (const [key, value] of Object.entries(config)) {
+                argsArray.push(`--${key}=${value}`);
+            }
+        }
+
+        return argsArray;
+    }
+
+    public launch(config?: WindowConfig) {
+        let argsArray = this.processArgs(config);
+
+        if (!config?.url) {
+            throw new Error("At least the url must be specified!");
+        } 
+            
+        const child = execFile(this.composeuiBinaryFilePath, argsArray, (error, stdout, stderr) => {
+            console.log(stdout);
+            if (error) {
+                throw error;
+            }
+        });
+    
+        let exithandler = function() { process.exit() };
+        child.on('close', exithandler);
+    }
+}

package/src/windowConfig.ts

@@ -0,0 +1,7 @@
+export interface WindowConfig {
+    title?: string;
+    icon?: string;
+    url?: string;
+    width?: number;
+    height?: number;
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "moduleResolution": "node",
+    "types": [ "node", "jest" ],
+    "experimentalDecorators": true,
+    "module": "es2022",
+    "esModuleInterop": true,
+    "target": "es2022",
+    "declaration": true,
+    "outDir": "output",
+    "lib": [ "es2022", "DOM" ],
+    "strict": true
+  },
+  "files": [ "src/index.ts" ]
+}