openfin-cli 4.0.0 → 5.42.2

package/LICENSE.md

@@ -1 +1,3 @@
-Please refer to the [OpenFin Developer License Agreement](https://www.openfin.co/developer-agreement/).
+Learn more about OpenFin licensing at the links listed below or email us at support@openfin.co with questions.
+
+- [Developer agreement](https://openfin.co/developer-agreement/)

package/README.md

@@ -1,15 +1,102 @@
-# OpenFin CLI
-
-The OpenFin CLI tool will allow you to launch the OpenFin runtime given a url or a configuration file, it will also allow you to create configuration files by giving only name and url.
-
-For more information please refer to the [developer guide](https://developers.openfin.co/of-docs/docs/openfin-cli-tool).
-
-## Install
-
-With npm:
-
-> npm i -g openfin-cli
-
-With yarn:
-
-> yarn global add openfin-cli
+# OpenFin CLI
+
+[![CI](https://github.com/openfin/openfin-cli/actions/workflows/CI.yml/badge.svg)](https://github.com/openfin/openfin-cli/actions/workflows/ci.yml) ![NPM](https://img.shields.io/npm/v/openfin-cli?color=red&logo=npm) ![Known Vulnerabilities](https://snyk.io/test/npm/openfin-cli/badge.svg)
+
+## Overview
+
+Repo for OpenFin’s [CLI tool](https://www.npmjs.com/package/openfin-cli).
+
+## Prerequisites
+
+### Node
+
+Node LTS can be downloaded [here](https://nodejs.org/en/download/).
+
+## Installation
+
+Run the following command to install the required dependencies:
+
+```
+npm install
+```
+
+## Development
+
+Build and run the CLI by running:
+
+```bash
+$ npm start
+```
+
+This will display the default help text. To pass CLI arguments an extra double dash is required. For example, to launch the OpenFin runtime with the `--config` flag, you would run:
+
+```bash
+$ npm start -- --config
+```
+
+This is because the first set of options gets passed to npm, the second to the actual command that is being invoked `npm run start <NPM OPTIONS> -- <CLI OPTIONS>`. By way of another example, to launch Process Manager you would run:
+
+```bash
+$ npm start -- --launch --config https://cdn.openfin.co/release/apps/openfin/processmanager/app.json
+```
+
+## Versioning & Releasing
+
+The release process does the following:
+
+-   The package and published to [NPM](https://www.npmjs.com/package/openfin-cli).
+
+To run a new release, follow this process:
+
+### 1. Create a release branch
+
+Note the new release version and create a new branch from main:
+
+```
+# Fetch and merge latest main branch
+$ git checkout main && git pull
+
+# Create new release branch
+$ git checkout -b release/v<new-version-number>
+
+# Commit new API version
+$ npm version <new-version-number>
+
+# Push release branch remotely
+$ git push -u origin release/v<new-version-number>
+
+```
+
+### 3. Create a pull request
+
+You should now be able to open a pull request with release/<new-version-number> against main. Get that approved and merged.
+
+### 4. Create a new release on GitHub
+
+Once your release branch is merged into main, you should now create a release through GitHub:
+
+-   Click Create a New Release
+-   Enter `v<new-version-number>` (e.g. v2.1.0) as both the tag and the release title. Enter release notes in the description field.
+-   If the release is a pre-release, check the pre-release box.
+-   Click "Publish release"
+
+Once the release is published, the production release workflow is triggered which will:
+
+-   Build the CLI tool and create the NPM package
+-   Publish the NPM package
+-   Attach the NPM package to the GitHub release
+
+### Pre-releases
+
+For pre-releases, follow the save process as above, but check the pre-release box when creating the release on GitHub.
+
+Similarly, pre-releases should be versioned with a pre-release tag (e.g. 2.1.0-beta.1). This will ensure that the pre-release is published to NPM as a pre-release.
+
+## VS Code Extensions
+
+The following VS Code extensions are used with this project:
+
+-   [Code Spell Checker](https://open-vsx.org/vscode/item?streetsidesoftware.code-spell-checker)
+-   [Debugger for Chrome](https://open-vsx.org/vscode/item?itemName=msjsdiag.debugger-for-chrome)
+-   [ESLint](https://open-vsx.org/vscode/item?itemName=dbaeumer.vscode-eslint)
+-   [Prettier - Code formatter](https://open-vsx.org/vscode/item?itemName=esbenp.prettier-vscode)

package/npm.README.md

@@ -0,0 +1,15 @@
+# OpenFin CLI
+
+The OpenFin CLI tool will allow you to launch the OpenFin runtime given a url or a configuration file, it will also allow you to create configuration files by giving only name and url.
+
+For more information please refer to the [developer guide](https://developers.openfin.co/of-docs/docs/openfin-cli-tool).
+
+## Install
+
+With npm:
+
+> npm i -g openfin-cli
+
+With yarn:
+
+> yarn global add openfin-cli

package/{dist → out}/cli.js

@@ -1,74 +1,72 @@
-#!/usr/bin/env node
-import { hideBin } from 'yargs/helpers';
-import yargs from 'yargs/yargs';
-import { openfinCli } from './index.js';
-import { Logger } from './logger.js';
-import { API_VERSION } from './version.js';
-global.logger = new Logger();
-const yargsParser = yargs(hideBin(process.argv))
-    .scriptName('OpenFin Runtime CLI tool')
-    .option('config', {
-    alias: 'c',
-    type: 'string',
-    description: 'path to config file',
-})
-    .option('url', {
-    alias: 'u',
-    type: 'string',
-    description: 'application url or comma separated list of urls',
-})
-    .option('launch', {
-    alias: 'l',
-    type: 'boolean',
-    description: 'launch this configuration',
-})
-    .option('devtools-port', {
-    alias: 'p',
-    type: 'number',
-    description: 'devtools port number',
-    defaultDescription: '9090',
-})
-    .option('runtime-version', {
-    alias: 'r',
-    type: 'string',
-    description: 'runtime version',
-    defaultDescription: 'stable',
-})
-    .option('platform', {
-    alias: 't',
-    type: 'boolean',
-    default: false,
-    description: 'launch as a platform window with multiple URLs',
-})
-    .option('save', {
-    alias: 's',
-    type: 'string',
-    description: 'save the manifest to the current directory <manifest name>',
-})
-    .option('log-level', {
-    type: 'string',
-    description: 'Run with custom log level',
-    choices: ['DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'],
-    default: 'INFO',
-})
-    .check((argv) => {
-    if (argv.config && argv.url) {
-        throw new Error('Cannot use both config and url options at the same time');
-    }
-    // These options have no effect when using the config option
-    if (argv.config && (argv.platform || argv['devtools-port'] || argv['runtime-version'] || argv.save)) {
-        throw new Error('While using the config option, you cannot use the platform, devtools-port, runtime-version, or save options.');
-    }
-    return true;
-})
-    .command('*', 'OpenFin CLI', () => ({}), (v) => {
-    // TODO: Validate commands + show help
-    if (!v.url && !v.launch) {
-        yargsParser.showHelp();
-    }
-    global.logger.setLogLevelString(v.logLevel);
-    openfinCli(v);
-})
-    .example('openfin --launch --config https://cdn.openfin.co/release/apps/openfin/processmanager/app.json', "Launches OpenFin's Process Manager app hosted on the OpenFin CDN")
-    .version(API_VERSION);
-yargsParser.parse();
+#!/usr/bin/env node
+import { hideBin } from 'yargs/helpers';
+import yargs from 'yargs/yargs';
+import { openfinCli } from './index.js';
+import { Logger } from './logger.js';
+global.logger = new Logger();
+const yargsParser = yargs(hideBin(process.argv))
+    .scriptName('OpenFin Runtime CLI tool')
+    .option('config', {
+    alias: 'c',
+    type: 'string',
+    description: 'path to config file'
+})
+    .option('url', {
+    alias: 'u',
+    type: 'string',
+    description: 'application url or comma separated list of urls'
+})
+    .option('launch', {
+    alias: 'l',
+    type: 'boolean',
+    description: 'launch this configuration'
+})
+    .option('devtools-port', {
+    alias: 'p',
+    type: 'number',
+    description: 'devtools port number',
+    defaultDescription: '9090'
+})
+    .option('runtime-version', {
+    alias: 'r',
+    type: 'string',
+    description: 'runtime version',
+    defaultDescription: 'stable'
+})
+    .option('platform', {
+    alias: 't',
+    type: 'boolean',
+    default: false,
+    description: 'launch as a platform window with multiple URLs'
+})
+    .option('save', {
+    alias: 's',
+    type: 'string',
+    description: 'save the manifest to the current directory <manifest name>'
+})
+    .option('log-level', {
+    type: 'string',
+    description: 'Run with custom log level',
+    choices: ['DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'],
+    default: 'INFO'
+})
+    .check((argv) => {
+    if (argv.config && argv.url) {
+        throw new Error('Cannot use both config and url options at the same time');
+    }
+    // These options have no effect when using the config option
+    if (argv.config && (argv.platform || argv['devtools-port'] || argv['runtime-version'] || argv.save)) {
+        throw new Error('While using the config option, you cannot use the platform, devtools-port, runtime-version, or save options.');
+    }
+    return true;
+})
+    .command('*', 'OpenFin CLI', () => ({}), (v) => {
+    // TODO: Validate commands + show help
+    if (!v.url && !v.launch) {
+        yargsParser.showHelp();
+    }
+    global.logger.setLogLevelString(v.logLevel);
+    openfinCli(v);
+})
+    .example('openfin --launch --config https://cdn.openfin.co/release/apps/openfin/processmanager/app.json', "Launches OpenFin's Process Manager app hosted on the OpenFin CDN");
+yargsParser.parse();

package/{dist → out}/index.js

@@ -1,201 +1,209 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import crypto from 'crypto';
-import dns from 'dns';
-import fs from 'fs/promises';
-import { connect, launch as launchOpenFinFromAdapter } from 'openfin-adapter';
-import os from 'os';
-import path from 'path';
-import { reportUsage } from './report-usage.js';
-import { fetch, formatTimeFromMs, isURL } from './utils.js';
-import { manifestSchema } from './validateManifest.js';
-if (typeof dns.setDefaultResultOrder === 'function') {
-    dns.setDefaultResultOrder('ipv4first');
-}
-let launchTime;
-export const openfinCli = (cli) => __awaiter(void 0, void 0, void 0, function* () {
-    const { config, url, launch, devtoolsPort = 9090, runtimeVersion = 'stable', save, platform } = cli;
-    let manifestUrl = config;
-    let buildConfig;
-    let configObject;
-    try {
-        if (url) {
-            buildConfig = true;
-            const manifestInfo = yield writeManifest(url.split(','), platform, devtoolsPort, runtimeVersion, save);
-            manifestUrl = manifestInfo.filepath;
-            configObject = manifestInfo.manifest;
-        }
-        if (launch) {
-            if (!buildConfig && manifestUrl) {
-                if (manifestUrl && isURL(manifestUrl)) {
-                    try {
-                        global.logger.debug(`Fetching manifest from: ${manifestUrl}`);
-                        const fetchedConfig = yield fetch(manifestUrl);
-                        configObject = manifestSchema.parse(fetchedConfig);
-                        global.logger.debug('Manifest', JSON.stringify(config));
-                    }
-                    catch (error) {
-                        if (error instanceof Error) {
-                            global.logger.error(`Failed to fetch manifest from ${manifestUrl} with error: ${error.message}`);
-                            global.logger.debug(JSON.stringify(error));
-                            process.exit(1);
-                        }
-                        else {
-                            throw error;
-                        }
-                    }
-                }
-                else {
-                    manifestUrl = path.resolve(manifestUrl);
-                    try {
-                        global.logger.debug(`Reading manifest from: ${manifestUrl}`);
-                        const configBuffer = yield fs.readFile(manifestUrl);
-                        configObject = JSON.parse(configBuffer.toString());
-                        global.logger.debug('Manifest:', JSON.stringify(config));
-                    }
-                    catch (error) {
-                        if (error instanceof Error) {
-                            global.logger.error(`Failed to get manifest from ${manifestUrl} with error: ${error.message}`);
-                            global.logger.debug(JSON.stringify(error));
-                            process.exit(1);
-                        }
-                        else {
-                            throw error;
-                        }
-                    }
-                }
-            }
-            if (!configObject) {
-                throw new Error('No config object found');
-            }
-            if (!manifestUrl) {
-                throw new Error('No manifest url found');
-            }
-            reportUsage('START', manifestUrl, configObject);
-            launchOpenfin(manifestUrl, config, configObject);
-        }
-    }
-    catch (error) {
-        globalThis.logger.error('Failed:', JSON.stringify(error));
-    }
-});
-const launchOpenfin = (manifestUrl, config, configObject) => __awaiter(void 0, void 0, void 0, function* () {
-    try {
-        global.logger.info(`Launching OpenFin with manifest: ${manifestUrl}`);
-        launchTime = Date.now();
-        const port = yield launchOpenFinFromAdapter({ manifestUrl });
-        global.logger.debug('Application Launched');
-        global.logger.debug(`Connecting to devtool port: ${port}`);
-        const fin = yield connect({
-            uuid: `adapter-connection-${crypto.randomUUID()}`,
-            address: `ws://localhost:${port}`,
-            nonPersistent: true,
-        });
-        global.logger.debug(`Connected to devtool port: ${port}`);
-        fin.once('disconnected', () => {
-            global.logger.info(`Disconnected from application, exiting after ${formatTimeFromMs(Date.now() - launchTime)}`);
-            process.exit();
-        });
-        global.logger.debug('Disconnect Listener Added');
-    }
-    catch (error) {
-        const err = error instanceof Error || error instanceof String ? error.toString() : JSON.stringify(error);
-        reportUsage(err.toString(), config, configObject);
-        // Maybe check what the error is and decide log level on that
-        // Sometimes errors are thrown when they shouldn't be
-        global.logger.warn('Error thrown launching/connecting to application instance', JSON.stringify(err));
-    }
-});
-const writeManifest = (urls, isPlatform, devtoolsPort, runtime, manifestName) => __awaiter(void 0, void 0, void 0, function* () {
-    const uuid = `app-${crypto.randomUUID()}`;
-    const version = runtime;
-    let manifest;
-    const generateViewObjWithUrl = (url) => ({
-        type: 'component',
-        componentName: 'view',
-        componentState: {
-            name: `view-${crypto.randomUUID()}`,
-            url,
-        },
-    });
-    const buildContent = () => {
-        const content = [];
-        urls.forEach((url) => {
-            content.push(generateViewObjWithUrl(url));
-        });
-        return content;
-    };
-    if (isPlatform) {
-        const content = buildContent();
-        manifest = {
-            runtime: {
-                version,
-            },
-            platform: {
-                uuid,
-                autoShow: false,
-            },
-            snapshot: {
-                windows: [
-                    {
-                        saveWindowState: false,
-                        backgroundThrottling: true,
-                        layout: {
-                            content: [
-                                {
-                                    type: 'row',
-                                    id: 'no-drop-target',
-                                    content,
-                                },
-                            ],
-                        },
-                    },
-                ],
-            },
-        };
-    }
-    else {
-        manifest = {
-            devtools_port: devtoolsPort,
-            startup_app: {
-                name: uuid,
-                url: urls[0],
-                uuid,
-                saveWindowState: false,
-                autoShow: true,
-            },
-            runtime: {
-                version,
-            },
-        };
-    }
-    global.logger.debug('Stringifying manifest');
-    const manifestJson = JSON.stringify(manifest, null, 4);
-    global.logger.debug(`Manifest stringified successfully ${manifestJson}`);
-    let filepath;
-    if (manifestName) {
-        filepath = path.join(process.cwd(), manifestName);
-    }
-    else {
-        filepath = path.join(os.tmpdir(), `${uuid}.json`);
-    }
-    try {
-        global.logger.debug(`Writing manifest to: ${path.resolve(filepath)}`);
-        yield fs.writeFile(filepath, manifestJson);
-        global.logger.info(`Manifest written to: ${path.resolve(filepath)}`);
-    }
-    catch (error) {
-        global.logger.error(`Failed to write manifest ${JSON.stringify(error)}`);
-    }
-    return {
-        manifest,
-        filepath,
-    };
-});
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { connect, launch as launchOpenFinFromAdapter } from '@openfin/node-adapter';
+import crypto from 'crypto';
+import dns from 'dns';
+import fs from 'fs/promises';
+import os from 'os';
+import path from 'path';
+import { reportUsage } from './report-usage.js';
+import { fetch, formatTimeFromMs, isURL } from './utils.js';
+import { manifestSchema } from './validateManifest.js';
+if (typeof dns.setDefaultResultOrder === 'function') {
+    dns.setDefaultResultOrder('ipv4first');
+}
+let launchTime;
+export const openfinCli = (cli) => __awaiter(void 0, void 0, void 0, function* () {
+    const { config, url, launch, devtoolsPort = 9090, runtimeVersion = 'stable', save, platform } = cli;
+    let manifestUrl = config;
+    let buildConfig;
+    let configObject;
+    try {
+        if (url) {
+            buildConfig = true;
+            const manifestInfo = yield writeManifest(url.split(','), platform, devtoolsPort, runtimeVersion, save);
+            manifestUrl = manifestInfo.filepath;
+            configObject = manifestInfo.manifest;
+        }
+        if (launch) {
+            if (!buildConfig && manifestUrl) {
+                let fetchedManifest;
+                if (manifestUrl && isURL(manifestUrl)) {
+                    try {
+                        global.logger.debug(`Fetching manifest from: ${manifestUrl}`);
+                        fetchedManifest = yield fetch(manifestUrl);
+                    }
+                    catch (error) {
+                        if (error instanceof Error) {
+                            global.logger.error(`Failed to fetch manifest from ${manifestUrl} with error: ${error.message}`);
+                            global.logger.debug(JSON.stringify(error));
+                            process.exit(1);
+                        }
+                        else {
+                            throw error;
+                        }
+                    }
+                }
+                else {
+                    manifestUrl = path.resolve(manifestUrl);
+                    try {
+                        global.logger.debug(`Reading manifest from: ${manifestUrl}`);
+                        const configBuffer = yield fs.readFile(manifestUrl);
+                        fetchedManifest = JSON.parse(configBuffer.toString());
+                    }
+                    catch (error) {
+                        if (error instanceof Error) {
+                            global.logger.error(`Failed to get manifest from ${manifestUrl} with error: ${error.message}`);
+                            global.logger.debug(JSON.stringify(error));
+                            process.exit(1);
+                        }
+                        else {
+                            throw error;
+                        }
+                    }
+                }
+                global.logger.debug('Manifest', JSON.stringify(config));
+                global.logger.debug('Validating manifest');
+                const parsedManifest = manifestSchema.safeParse(fetchedManifest);
+                if (!parsedManifest.success) {
+                    global.logger.error(`Failed to validate manifest with error: ${parsedManifest.error.message}`);
+                    global.logger.debug(JSON.stringify(parsedManifest.error));
+                    process.exit(1);
+                }
+                configObject = parsedManifest.data;
+                global.logger.debug('Manifest validated');
+            }
+            if (!configObject) {
+                throw new Error('No config object found');
+            }
+            if (!manifestUrl) {
+                throw new Error('No manifest url found');
+            }
+            reportUsage('START', manifestUrl, configObject);
+            launchOpenfin(manifestUrl, config, configObject);
+        }
+    }
+    catch (error) {
+        globalThis.logger.error('Failed:', JSON.stringify(error));
+    }
+});
+const launchOpenfin = (manifestUrl, config, configObject) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        global.logger.info(`Launching OpenFin with manifest: ${manifestUrl}`);
+        launchTime = Date.now();
+        const port = yield launchOpenFinFromAdapter({ manifestUrl });
+        global.logger.debug('Application Launched');
+        global.logger.debug(`Connecting to devtool port: ${port}`);
+        const fin = yield connect({
+            uuid: `adapter-connection-${crypto.randomUUID()}`,
+            address: `ws://localhost:${port}`,
+            nonPersistent: true
+        });
+        global.logger.debug(`Connected to devtool port: ${port}`);
+        fin.once('disconnected', () => {
+            global.logger.info(`Disconnected from application, exiting after ${formatTimeFromMs(Date.now() - launchTime)}`);
+            process.exit();
+        });
+        global.logger.debug('Disconnect Listener Added');
+    }
+    catch (error) {
+        const err = error instanceof Error || error instanceof String ? error.toString() : JSON.stringify(error);
+        reportUsage(err.toString(), config, configObject);
+        // Maybe check what the error is and decide log level on that
+        // Sometimes errors are thrown when they shouldn't be
+        global.logger.warn('Error thrown launching/connecting to application instance', JSON.stringify(err));
+    }
+});
+const writeManifest = (urls, isPlatform, devtoolsPort, runtime, manifestName) => __awaiter(void 0, void 0, void 0, function* () {
+    const uuid = `app-${crypto.randomUUID()}`;
+    const version = runtime;
+    let manifest;
+    const generateViewObjWithUrl = (url) => ({
+        type: 'component',
+        componentName: 'view',
+        componentState: {
+            name: `view-${crypto.randomUUID()}`,
+            url
+        }
+    });
+    const buildContent = () => {
+        const content = [];
+        urls.forEach((url) => {
+            content.push(generateViewObjWithUrl(url));
+        });
+        return content;
+    };
+    if (isPlatform) {
+        const content = buildContent();
+        manifest = {
+            runtime: {
+                version
+            },
+            platform: {
+                uuid,
+                autoShow: false
+            },
+            snapshot: {
+                windows: [
+                    {
+                        saveWindowState: false,
+                        backgroundThrottling: true,
+                        layout: {
+                            content: [
+                                {
+                                    type: 'row',
+                                    id: 'no-drop-target',
+                                    content
+                                }
+                            ]
+                        }
+                    }
+                ]
+            }
+        };
+    }
+    else {
+        manifest = {
+            devtools_port: devtoolsPort,
+            startup_app: {
+                name: uuid,
+                url: urls[0],
+                uuid,
+                saveWindowState: false,
+                autoShow: true
+            },
+            runtime: {
+                version
+            }
+        };
+    }
+    global.logger.debug('Stringifying manifest');
+    const manifestJson = JSON.stringify(manifest, null, 4);
+    global.logger.debug(`Manifest stringified successfully ${manifestJson}`);
+    let filepath;
+    if (manifestName) {
+        filepath = path.join(process.cwd(), manifestName);
+    }
+    else {
+        filepath = path.join(os.tmpdir(), `${uuid}.json`);
+    }
+    try {
+        global.logger.debug(`Writing manifest to: ${path.resolve(filepath)}`);
+        yield fs.writeFile(filepath, manifestJson);
+        global.logger.info(`Manifest written to: ${path.resolve(filepath)}`);
+    }
+    catch (error) {
+        global.logger.error(`Failed to write manifest ${JSON.stringify(error)}`);
+    }
+    return {
+        manifest,
+        filepath
+    };
+});

package/{dist → out}/logger.js

@@ -1,50 +1,50 @@
-export class Logger {
-    constructor(logLevel = 1 /* LogLevel.INFO */) {
-        this._logLevel = logLevel;
-    }
-    setLogLevel(logLevel) {
-        this._logLevel = logLevel;
-    }
-    setLogLevelString(logLevel) {
-        switch (logLevel.toLowerCase()) {
-            case 'debug':
-                this._logLevel = 0 /* LogLevel.DEBUG */;
-                break;
-            case 'info':
-                this._logLevel = 1 /* LogLevel.INFO */;
-                break;
-            case 'warn':
-                this._logLevel = 2 /* LogLevel.WARN */;
-                break;
-            case 'error':
-                this._logLevel = 3 /* LogLevel.ERROR */;
-                break;
-            case 'none':
-                this._logLevel = 4 /* LogLevel.NONE */;
-                break;
-            default:
-                this._logLevel = 1 /* LogLevel.INFO */;
-                break;
-        }
-    }
-    debug(message, ...args) {
-        if (this._logLevel <= 0 /* LogLevel.DEBUG */) {
-            console.log(`[DEBUG] ${message}`, ...args);
-        }
-    }
-    info(message, ...args) {
-        if (this._logLevel <= 1 /* LogLevel.INFO */) {
-            console.log(`[INFO] ${message}`, ...args);
-        }
-    }
-    warn(message, ...args) {
-        if (this._logLevel <= 2 /* LogLevel.WARN */) {
-            console.log(`[WARN] ${message}`, ...args);
-        }
-    }
-    error(message, ...args) {
-        if (this._logLevel <= 3 /* LogLevel.ERROR */) {
-            console.log(`[ERROR] ${message}`, ...args);
-        }
-    }
-}
+export class Logger {
+    constructor(logLevel = 1 /* LogLevel.INFO */) {
+        this._logLevel = logLevel;
+    }
+    setLogLevel(logLevel) {
+        this._logLevel = logLevel;
+    }
+    setLogLevelString(logLevel) {
+        switch (logLevel.toLowerCase()) {
+            case 'debug':
+                this._logLevel = 0 /* LogLevel.DEBUG */;
+                break;
+            case 'info':
+                this._logLevel = 1 /* LogLevel.INFO */;
+                break;
+            case 'warn':
+                this._logLevel = 2 /* LogLevel.WARN */;
+                break;
+            case 'error':
+                this._logLevel = 3 /* LogLevel.ERROR */;
+                break;
+            case 'none':
+                this._logLevel = 4 /* LogLevel.NONE */;
+                break;
+            default:
+                this._logLevel = 1 /* LogLevel.INFO */;
+                break;
+        }
+    }
+    debug(message, ...args) {
+        if (this._logLevel <= 0 /* LogLevel.DEBUG */) {
+            console.log(`[DEBUG] ${message}`, ...args);
+        }
+    }
+    info(message, ...args) {
+        if (this._logLevel <= 1 /* LogLevel.INFO */) {
+            console.log(`[INFO] ${message}`, ...args);
+        }
+    }
+    warn(message, ...args) {
+        if (this._logLevel <= 2 /* LogLevel.WARN */) {
+            console.log(`[WARN] ${message}`, ...args);
+        }
+    }
+    error(message, ...args) {
+        if (this._logLevel <= 3 /* LogLevel.ERROR */) {
+            console.log(`[ERROR] ${message}`, ...args);
+        }
+    }
+}

package/{dist → out}/report-usage.js

@@ -1,50 +1,50 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import axios from 'axios';
-import machineId from 'node-machine-id';
-import os from 'os';
-const getAppName = (configObject) => {
-    var _a, _b, _c, _d, _e, _f, _g, _h;
-    return ((_h = (_f = (_d = (_b = (_a = configObject.startup_app) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : (_c = configObject.startup_app) === null || _c === void 0 ? void 0 : _c.uuid) !== null && _d !== void 0 ? _d : (_e = configObject.platform) === null || _e === void 0 ? void 0 : _e.name) !== null && _f !== void 0 ? _f : (_g = configObject.platform) === null || _g === void 0 ? void 0 : _g.uuid) !== null && _h !== void 0 ? _h : 'no-app-name-or-uuid');
-};
-export const reportUsage = (status, config, configObject) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b, _c;
-    if (process.platform === 'win32')
-        return;
-    const reportUrl = new URL('https://install.openfin.co/installer-usage?');
-    const reportUrlParams = new URLSearchParams({
-        appName: getAppName(configObject),
-        appLocation: typeof __dirname !== 'undefined' ? __dirname : 'unknown',
-        version: (_b = (_a = configObject === null || configObject === void 0 ? void 0 : configObject.runtime) === null || _a === void 0 ? void 0 : _a.version) !== null && _b !== void 0 ? _b : 'undefined',
-        machineId: yield machineId.machineId(true),
-        manifestUrl: config !== null && config !== void 0 ? config : 'undefined',
-        platform: `${os.platform()}-${os.release()})`,
-        licenseKey: (_c = configObject === null || configObject === void 0 ? void 0 : configObject.licenseKey) !== null && _c !== void 0 ? _c : 'contract_identifier',
-        launchMethod: 'openfin-cli',
-        launchStatus: status || 'SUCCESS',
-    });
-    reportUrl.search = reportUrlParams.toString();
-    try {
-        const reportUrlString = reportUrl.toString();
-        global.logger.debug(`OpenFin Reporting Usage Data: ${reportUrlString}`);
-        const response = yield axios.get(reportUrlString);
-        if (response.status !== 200) {
-            global.logger.error('OpenFin Report Usage Data Failed');
-        }
-        else {
-            global.logger.debug(`OpenFin Report Usage Data: Status:   ${response.status}`);
-            global.logger.debug(`OpenFin Report Usage Data: Response: ${response.data.toString()}`);
-        }
-    }
-    catch (error) {
-        const err = error instanceof Error || error instanceof String ? error.toString() : JSON.stringify(error);
-        global.logger.warn('OpenFin Report Usage Data Failed:', err);
-    }
-});
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import axios from 'axios';
+import machineId from 'node-machine-id';
+import os from 'os';
+const getAppName = (configObject) => {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    return ((_h = (_f = (_d = (_b = (_a = configObject.startup_app) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : (_c = configObject.startup_app) === null || _c === void 0 ? void 0 : _c.uuid) !== null && _d !== void 0 ? _d : (_e = configObject.platform) === null || _e === void 0 ? void 0 : _e.name) !== null && _f !== void 0 ? _f : (_g = configObject.platform) === null || _g === void 0 ? void 0 : _g.uuid) !== null && _h !== void 0 ? _h : 'no-app-name-or-uuid');
+};
+export const reportUsage = (status, config, configObject) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c;
+    if (process.platform === 'win32')
+        return;
+    const reportUrl = new URL('https://install.openfin.co/installer-usage?');
+    const reportUrlParams = new URLSearchParams({
+        appName: getAppName(configObject),
+        appLocation: typeof __dirname !== 'undefined' ? __dirname : 'unknown',
+        version: (_b = (_a = configObject === null || configObject === void 0 ? void 0 : configObject.runtime) === null || _a === void 0 ? void 0 : _a.version) !== null && _b !== void 0 ? _b : 'undefined',
+        machineId: yield machineId.machineId(true),
+        manifestUrl: config !== null && config !== void 0 ? config : 'undefined',
+        platform: `${os.platform()}-${os.release()})`,
+        licenseKey: (_c = configObject === null || configObject === void 0 ? void 0 : configObject.licenseKey) !== null && _c !== void 0 ? _c : 'contract_identifier',
+        launchMethod: 'openfin-cli',
+        launchStatus: status || 'SUCCESS'
+    });
+    reportUrl.search = reportUrlParams.toString();
+    try {
+        const reportUrlString = reportUrl.toString();
+        global.logger.debug(`OpenFin Reporting Usage Data: ${reportUrlString}`);
+        const response = yield axios.get(reportUrlString);
+        if (response.status !== 200) {
+            global.logger.error('OpenFin Report Usage Data Failed');
+        }
+        else {
+            global.logger.debug(`OpenFin Report Usage Data: Status:   ${response.status}`);
+            global.logger.debug(`OpenFin Report Usage Data: Response: ${response.data.toString()}`);
+        }
+    }
+    catch (error) {
+        const err = error instanceof Error || error instanceof String ? error.toString() : JSON.stringify(error);
+        global.logger.warn('OpenFin Report Usage Data Failed:', err);
+    }
+});

package/{dist → out}/utils.js

@@ -1,28 +1,28 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import axios from 'axios';
-export const fetch = (url) => __awaiter(void 0, void 0, void 0, function* () {
-    const response = yield axios.get(url);
-    if (response.status < 200 || response.status > 399) {
-        throw new Error(`Failed to load url: ${url}, status code:${response.status}`);
-    }
-    return response.data;
-});
-export const isURL = (str) => {
-    return str.lastIndexOf('http') >= 0;
-};
-export const formatTimeFromMs = (ms) => {
-    const seconds = Math.floor(ms / 1000);
-    const minutes = Math.floor(seconds / 60);
-    const hours = Math.floor(minutes / 60);
-    const secondsRemainder = seconds % 60;
-    const minutesRemainder = minutes % 60;
-    return `${hours ? `${hours}h ` : ''}${minutesRemainder ? `${minutesRemainder}m ` : ''}${secondsRemainder ? `${secondsRemainder}s` : ''}`;
-};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import axios from 'axios';
+export const fetch = (url) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield axios.get(url);
+    if (response.status < 200 || response.status > 399) {
+        throw new Error(`Failed to load url: ${url}, status code:${response.status}`);
+    }
+    return response.data;
+});
+export const isURL = (str) => {
+    return str.lastIndexOf('http') >= 0;
+};
+export const formatTimeFromMs = (ms) => {
+    const seconds = Math.floor(ms / 1000);
+    const minutes = Math.floor(seconds / 60);
+    const hours = Math.floor(minutes / 60);
+    const secondsRemainder = seconds % 60;
+    const minutesRemainder = minutes % 60;
+    return `${hours ? `${hours}h ` : ''}${minutesRemainder ? `${minutesRemainder}m ` : ''}${secondsRemainder ? `${secondsRemainder}s` : ''}`;
+};

package/out/validateManifest.js

@@ -0,0 +1,31 @@
+import * as z from 'zod';
+// TODO: Maybe add all manifest options, then add a CLI feature to
+// verify the manifest against the schema.
+export const manifestSchema = z.object({
+    startup_app: z
+        .optional(z.object({
+        name: z.optional(z.string()).nullable(),
+        uuid: z.optional(z.string()).nullable(),
+        url: z.optional(z.string()).nullable(),
+        saveWindowState: z.optional(z.boolean()).nullable(),
+        autoShow: z.optional(z.boolean()).nullable()
+    }))
+        .nullable(),
+    platform: z
+        .optional(z.object({
+        uuid: z.optional(z.string()).nullable(),
+        name: z.optional(z.string()).nullable(),
+        autoShow: z.optional(z.boolean()).nullable()
+    }))
+        .nullable(),
+    runtime: z
+        .optional(z
+        .object({
+        version: z.optional(z.string()).nullable()
+    })
+        .nullable())
+        .nullable(),
+    snapshot: z.optional(z.any()).nullable(),
+    licenseKey: z.optional(z.string()).nullable(),
+    devtools_port: z.optional(z.number()).nullable()
+});

package/package.json

@@ -1,26 +1,40 @@
 {
-  "name": "openfin-cli",
-  "version": "4.0.0",
-  "description": "Supports command line development in the OpenFin environment.",
-  "type": "module",
-  "homepage": "http://www.openfin.co",
-  "author": "OpenFin Inc.",
-  "engines": {
-    "node": ">=16"
-  },
-  "license": "SEE LICENSE IN LICENSE.MD",
-  "keywords": [
-    "openfin",
-    "cli"
-  ],
-  "dependencies": {
-    "axios": "^1.1.3",
-    "node-machine-id": "^1.1.12",
-    "openfin-adapter": "^27.71.21",
-    "yargs": "^17.6.2",
-    "zod": "^3.19.1"
-  },
-  "bin": {
-    "openfin": "./dist/cli.js"
-  }
+    "name": "openfin-cli",
+    "version": "5.42.2",
+    "description": "Supports command line development in the OpenFin environment.",
+    "type": "module",
+    "homepage": "http://www.here.io",
+    "author": "Here™️",
+    "engines": {
+        "node": ">=20"
+    },
+    "license": "SEE LICENSE IN LICENSE.MD",
+    "scripts": {
+        "build": "npm run clean && npx tsc",
+        "clean": "rimraf ./dist",
+        "ci:prepublish": "of-npm prepublish",
+        "ci:postpublish": "of-npm postpublish",
+        "ci:publish": "npm publish",
+        "version:update": "of-npm version --bump patch '$MAJOR.$RMAJOR.$PATCH'"
+    },
+    "files": [
+        "out/**/*",
+        "LICENSE.md",
+        "README.md",
+        "npm.README.md"
+    ],
+    "keywords": [
+        "openfin",
+        "cli",
+        "Here™️"
+    ],
+    "dependencies": {
+        "axios": "1.7.2",
+        "node-machine-id": "1.1.12",
+        "yargs": "17.7.2",
+        "zod": "3.24.1"
+    },
+    "bin": {
+        "openfin": "./out/cli.js"
+    }
 }

package/dist/validateManifest.js

@@ -1,23 +0,0 @@
-import * as z from 'zod';
-// TODO: Maybe add all manifest options, then add a CLI feature to
-// verify the manifest against the schema.
-export const manifestSchema = z.object({
-    startup_app: z.optional(z.object({
-        name: z.optional(z.string()),
-        uuid: z.optional(z.string()),
-        url: z.optional(z.string()),
-        saveWindowState: z.optional(z.boolean()),
-        autoShow: z.optional(z.boolean()),
-    })),
-    platform: z.optional(z.object({
-        uuid: z.optional(z.string()),
-        name: z.optional(z.string()),
-        autoShow: z.optional(z.boolean()),
-    })),
-    runtime: z.optional(z.object({
-        version: z.optional(z.string()),
-    })),
-    snapshot: z.optional(z.any()),
-    licenseKey: z.optional(z.string()),
-    devtools_port: z.optional(z.number()),
-});

package/dist/version.js

@@ -1 +0,0 @@
-export const API_VERSION = '4.0.0';