@harperfast/harper 5.0.0-alpha.10

package/dist/bin/status.js

@@ -0,0 +1,56 @@
+'use strict';
+const fs = require('fs-extra');
+const path = require('path');
+const YAML = require('yaml');
+const hdbTerms = require("../utility/hdbTerms.js");
+const hdbLog = require('../utility/logging/harper_logger.js');
+const sysInfo = require('../utility/environment/systemInformation.js');
+const envMgr = require('../utility/environment/environmentManager.js');
+const installation = require("../utility/installation.js");
+envMgr.initSync();
+const STATUSES = {
+    RUNNING: 'running',
+    STOPPED: 'stopped',
+    ERRORED: 'errored',
+    NOT_INSTALLED: 'not installed',
+};
+let hdbRoot;
+module.exports = status;
+async function status() {
+    let status = {
+        harperdb: {
+            status: STATUSES.STOPPED,
+        },
+    };
+    if (!installation.isHdbInstalled(envMgr, hdbLog)) {
+        status.harperdb.status = STATUSES.NOT_INSTALLED;
+        console.log(YAML.stringify(status));
+        return;
+    }
+    hdbRoot = envMgr.get(hdbTerms.CONFIG_PARAMS.ROOTPATH);
+    let hdbPid;
+    try {
+        hdbPid = Number.parseInt(await fs.readFile(path.join(hdbRoot, hdbTerms.HDB_PID_FILE), 'utf8'));
+    }
+    catch (err) {
+        if (err.code === hdbTerms.NODE_ERROR_CODES.ENOENT) {
+            hdbLog.info('`harperdb status` did not find a hdb.pid file');
+            status.harperdb.status = STATUSES.STOPPED;
+            console.log(YAML.stringify(status));
+            return;
+        }
+        throw err;
+    }
+    // Check the saved pid against any running hdb processes
+    const hdbSysInfo = await sysInfo.getHDBProcessInfo();
+    for (const proc of hdbSysInfo.core) {
+        if (proc.pid === hdbPid) {
+            status.harperdb.status = STATUSES.RUNNING;
+            status.harperdb.pid = hdbPid;
+            break;
+        }
+    }
+    console.log(YAML.stringify(status));
+    process.exit();
+}
+//# sourceMappingURL=status.js.map

package/dist/bin/status.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"status.js","sourceRoot":"","sources":["../../bin/status.js"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAC/B,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAC7B,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAE7B,MAAM,QAAQ,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;AACnD,MAAM,MAAM,GAAG,OAAO,CAAC,qCAAqC,CAAC,CAAC;AAC9D,MAAM,OAAO,GAAG,OAAO,CAAC,6CAA6C,CAAC,CAAC;AACvE,MAAM,MAAM,GAAG,OAAO,CAAC,8CAA8C,CAAC,CAAC;AACvE,MAAM,YAAY,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;AAC3D,MAAM,CAAC,QAAQ,EAAE,CAAC;AAElB,MAAM,QAAQ,GAAG;IAChB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,aAAa,EAAE,eAAe;CAC9B,CAAC;AAEF,IAAI,OAAO,CAAC;AAEZ,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC;AAExB,KAAK,UAAU,MAAM;IACpB,IAAI,MAAM,GAAG;QACZ,QAAQ,EAAE;YACT,MAAM,EAAE,QAAQ,CAAC,OAAO;SACxB;KACD,CAAC;IAEF,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;QAClD,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC;QAChD,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QACpC,OAAO;IACR,CAAC;IAED,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACtD,IAAI,MAAM,CAAC;IACX,IAAI,CAAC;QACJ,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IAChG,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACd,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC;YACnD,MAAM,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;YAC7D,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC;YAC1C,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;YACpC,OAAO;QACR,CAAC;QAED,MAAM,GAAG,CAAC;IACX,CAAC;IAED,wDAAwD;IACxD,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,iBAAiB,EAAE,CAAC;IACrD,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC;QACpC,IAAI,IAAI,CAAC,GAAG,KAAK,MAAM,EAAE,CAAC;YACzB,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC;YAC1C,MAAM,CAAC,QAAQ,CAAC,GAAG,GAAG,MAAM,CAAC;YAC7B,MAAM;QACP,CAAC;IACF,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;IACpC,OAAO,CAAC,IAAI,EAAE,CAAC;AAChB,CAAC"}

package/dist/bin/stop.d.ts

@@ -0,0 +1,2 @@
+export = stop;
+declare function stop(): Promise<void>;

package/dist/bin/stop.js

@@ -0,0 +1,17 @@
+'use strict';
+const hdbLogger = require('../utility/logging/harper_logger.js');
+const util = require('util');
+const childProcess = require('child_process');
+const exec = util.promisify(childProcess.exec);
+const sysInfo = require('../utility/environment/systemInformation.js');
+const STOP_MSG = 'Stopping Harper.';
+module.exports = stop;
+async function stop() {
+    console.log(STOP_MSG);
+    hdbLogger.notify(STOP_MSG);
+    const processes = await sysInfo.getHDBProcessInfo();
+    processes.core.forEach((p) => {
+        exec(`kill ${p.pid}`);
+    });
+}
+//# sourceMappingURL=stop.js.map

package/dist/bin/stop.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stop.js","sourceRoot":"","sources":["../../bin/stop.js"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,MAAM,SAAS,GAAG,OAAO,CAAC,qCAAqC,CAAC,CAAC;AACjE,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAC7B,MAAM,YAAY,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;AAC/C,MAAM,OAAO,GAAG,OAAO,CAAC,6CAA6C,CAAC,CAAC;AAEvE,MAAM,QAAQ,GAAG,kBAAkB,CAAC;AAEpC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;AAEtB,KAAK,UAAU,IAAI;IAClB,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACtB,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAE3B,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAEpD,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QAC5B,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;AACJ,CAAC"}

package/dist/bin/upgrade.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Runs the upgrade directives, if needed, for an updated version of Harper.
+ *
+ * @param upgradeObj - optional
+ * @returns {Promise<void>}
+ */
+export function upgrade(upgradeObj: any): Promise<void>;

package/dist/bin/upgrade.js

@@ -0,0 +1,111 @@
+'use strict';
+/**
+ * The upgrade module is used to facilitate the upgrade process for existing instances of HDB that pull down a new version
+ * of HDB from NPM that requires a specific upgrade script be run - e.g. there are changes required for the settings.js
+ * config file, a data model change requires a re-indexing script is run, etc.
+ */
+const env = require('../utility/environment/environmentManager.js');
+env.initSync();
+const chalk = require('chalk');
+const hdbLogger = require('../utility/logging/harper_logger.js');
+const hdbTerms = require("../utility/hdbTerms.js");
+const directivesManager = require('../upgrade/directivesManager.js');
+const installation = require("../utility/installation.js");
+const hdbInfoController = require('../dataLayer/hdbInfoController.js');
+const upgradePrompt = require('../upgrade/upgradePrompt.js');
+const globalSchema = require('../utility/globalSchema.js');
+const { packageJson } = require('../utility/packageUtils.js');
+const promisify = require('util').promisify;
+const pSchemaToGlobal = promisify(globalSchema.setSchemaDataToGlobal);
+let pm2Utils;
+const { UPGRADE_VERSION } = hdbTerms.UPGRADE_JSON_FIELD_NAMES_ENUM;
+module.exports = {
+    upgrade,
+};
+/**
+ * Runs the upgrade directives, if needed, for an updated version of Harper.
+ *
+ * @param upgradeObj - optional
+ * @returns {Promise<void>}
+ */
+async function upgrade(upgradeObj) {
+    await pSchemaToGlobal();
+    // Requiring the processManagement mod will create the .pm2 dir. This code is here to allow install to set
+    // pm2 env vars before that is done.
+    if (pm2Utils === undefined)
+        pm2Utils = require('../utility/processManagement/processManagement.js');
+    //We have to make sure HDB is installed before doing anything else
+    const installed = installation.isHdbInstalled(env, hdbLogger);
+    if (!installed) {
+        const hdbNotInstalledMsg = 'Harper is not installed. Harper must be installed before running an upgrade.';
+        printToLogAndConsole(hdbNotInstalledMsg, hdbTerms.LOG_LEVELS.ERROR);
+        process.exit(1);
+    }
+    let hdbUpgradeInfo = upgradeObj;
+    if (!hdbUpgradeInfo) {
+        hdbUpgradeInfo = await hdbInfoController.getVersionUpdateInfo();
+        if (!hdbUpgradeInfo) {
+            console.log('Harper version is current');
+            process.exit(0);
+        }
+    }
+    printToLogAndConsole(`This version of Harper is ${packageJson.version}`, hdbTerms.LOG_LEVELS.INFO);
+    //The upgrade version should always be included in the hdbUpgradeInfo object returned from the getVersion function
+    // above but testing for it and using the version from package.json just in case it is not
+    const currentHdbVersion = hdbUpgradeInfo[UPGRADE_VERSION] ?? packageJson.version;
+    if (!currentHdbVersion) {
+        console.log(`Current Version field missing from the package.json file.  Cannot continue with upgrade.  If you need support, please contact ${hdbTerms.HDB_SUPPORT_ADDRESS}`);
+        hdbLogger.notify('Missing new version field from upgrade info object');
+        process.exit(1);
+    }
+    let startUpgrade;
+    let exitCode = 0;
+    try {
+        startUpgrade = await upgradePrompt.forceUpdatePrompt(hdbUpgradeInfo);
+    }
+    catch (err) {
+        hdbLogger.error('There was an error when prompting user about upgrade.');
+        hdbLogger.error(err);
+        startUpgrade = false;
+        exitCode = 1;
+    }
+    if (!startUpgrade) {
+        console.log('Cancelled upgrade, closing Harper');
+        process.exit(exitCode);
+    }
+    hdbLogger.info(`Starting upgrade to version ${currentHdbVersion}`);
+    await runUpgrade(hdbUpgradeInfo);
+    printToLogAndConsole(`Harper was successfully upgraded to version ${hdbUpgradeInfo[UPGRADE_VERSION]}`, hdbTerms.LOG_LEVELS.INFO);
+}
+/**
+ * This function is called during an upgrade to execute the applicable upgrade directives based on the data and current
+ * version info passed within the `upgradeObj` argument.  After the upgrade is completed, a new record is inserted into
+ * the hdbInfo table to track the version info for the instance's data and software.
+ *
+ * @param upgradeObj
+ * @returns {Promise<void>}
+ */
+async function runUpgrade(upgradeObj) {
+    try {
+        await directivesManager.processDirectives(upgradeObj);
+    }
+    catch (err) {
+        printToLogAndConsole('There was an error during the data upgrade.  Please check the logs.', hdbTerms.LOG_LEVELS.ERROR);
+        throw err;
+    }
+    try {
+        await hdbInfoController.insertHdbUpgradeInfo(upgradeObj[UPGRADE_VERSION]);
+    }
+    catch (err) {
+        hdbLogger.error("Error updating the 'hdb_info' system table.");
+        hdbLogger.error(err);
+    }
+}
+function printToLogAndConsole(msg, logLevel = undefined) {
+    if (!logLevel) {
+        logLevel = hdbLogger.info;
+    }
+    hdbLogger[logLevel](msg);
+    console.log(chalk.magenta(msg));
+}
+//# sourceMappingURL=upgrade.js.map

package/dist/bin/upgrade.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upgrade.js","sourceRoot":"","sources":["../../bin/upgrade.js"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb;;;;GAIG;AAEH,MAAM,GAAG,GAAG,OAAO,CAAC,8CAA8C,CAAC,CAAC;AACpE,GAAG,CAAC,QAAQ,EAAE,CAAC;AAEf,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAC/B,MAAM,SAAS,GAAG,OAAO,CAAC,qCAAqC,CAAC,CAAC;AACjE,MAAM,QAAQ,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;AACnD,MAAM,iBAAiB,GAAG,OAAO,CAAC,iCAAiC,CAAC,CAAC;AACrE,MAAM,YAAY,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;AAC3D,MAAM,iBAAiB,GAAG,OAAO,CAAC,mCAAmC,CAAC,CAAC;AACvE,MAAM,aAAa,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAC;AAC7D,MAAM,YAAY,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;AAC3D,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;AAC9D,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC;AAC5C,MAAM,eAAe,GAAG,SAAS,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC;AACtE,IAAI,QAAQ,CAAC;AAEb,MAAM,EAAE,eAAe,EAAE,GAAG,QAAQ,CAAC,6BAA6B,CAAC;AAEnE,MAAM,CAAC,OAAO,GAAG;IAChB,OAAO;CACP,CAAC;AAEF;;;;;GAKG;AACH,KAAK,UAAU,OAAO,CAAC,UAAU;IAChC,MAAM,eAAe,EAAE,CAAC;IAExB,0GAA0G;IAC1G,oCAAoC;IACpC,IAAI,QAAQ,KAAK,SAAS;QAAE,QAAQ,GAAG,OAAO,CAAC,mDAAmD,CAAC,CAAC;IAEpG,kEAAkE;IAClE,MAAM,SAAS,GAAG,YAAY,CAAC,cAAc,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IAC9D,IAAI,CAAC,SAAS,EAAE,CAAC;QAChB,MAAM,kBAAkB,GAAG,8EAA8E,CAAC;QAC1G,oBAAoB,CAAC,kBAAkB,EAAE,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACpE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,cAAc,GAAG,UAAU,CAAC;IAChC,IAAI,CAAC,cAAc,EAAE,CAAC;QACrB,cAAc,GAAG,MAAM,iBAAiB,CAAC,oBAAoB,EAAE,CAAC;QAChE,IAAI,CAAC,cAAc,EAAE,CAAC;YACrB,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;YACzC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjB,CAAC;IACF,CAAC;IAED,oBAAoB,CAAC,6BAA6B,WAAW,CAAC,OAAO,EAAE,EAAE,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAEnG,kHAAkH;IAClH,0FAA0F;IAC1F,MAAM,iBAAiB,GAAG,cAAc,CAAC,eAAe,CAAC,IAAI,WAAW,CAAC,OAAO,CAAC;IACjF,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACxB,OAAO,CAAC,GAAG,CACV,iIAAiI,QAAQ,CAAC,mBAAmB,EAAE,CAC/J,CAAC;QACF,SAAS,CAAC,MAAM,CAAC,oDAAoD,CAAC,CAAC;QACvE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,YAAY,CAAC;IAEjB,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,IAAI,CAAC;QACJ,YAAY,GAAG,MAAM,aAAa,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;IACtE,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACd,SAAS,CAAC,KAAK,CAAC,uDAAuD,CAAC,CAAC;QACzE,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrB,YAAY,GAAG,KAAK,CAAC;QACrB,QAAQ,GAAG,CAAC,CAAC;IACd,CAAC;IAED,IAAI,CAAC,YAAY,EAAE,CAAC;QACnB,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;QACjD,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED,SAAS,CAAC,IAAI,CAAC,+BAA+B,iBAAiB,EAAE,CAAC,CAAC;IAEnE,MAAM,UAAU,CAAC,cAAc,CAAC,CAAC;IAEjC,oBAAoB,CACnB,+CAA+C,cAAc,CAAC,eAAe,CAAC,EAAE,EAChF,QAAQ,CAAC,UAAU,CAAC,IAAI,CACxB,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,UAAU,CAAC,UAAU;IACnC,IAAI,CAAC;QACJ,MAAM,iBAAiB,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IACvD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACd,oBAAoB,CACnB,qEAAqE,EACrE,QAAQ,CAAC,UAAU,CAAC,KAAK,CACzB,CAAC;QACF,MAAM,GAAG,CAAC;IACX,CAAC;IAED,IAAI,CAAC;QACJ,MAAM,iBAAiB,CAAC,oBAAoB,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC;IAC3E,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACd,SAAS,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAC;QAC/D,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtB,CAAC;AACF,CAAC;AAED,SAAS,oBAAoB,CAAC,GAAG,EAAE,QAAQ,GAAG,SAAS;IACtD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACf,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC;IAC3B,CAAC;IACD,SAAS,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC;IACzB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;AACjC,CAAC"}

package/dist/components/Application.d.ts

@@ -0,0 +1,110 @@
+import { type Logger } from '../utility/logging/logger.ts';
+interface ApplicationConfig {
+    package: string;
+    install?: {
+        command?: string;
+        timeout?: number;
+    };
+    [key: string]: unknown;
+}
+export declare class InvalidPackageIdentifierError extends TypeError {
+    constructor(applicationName: string, packageIdentifier: unknown);
+}
+export declare class InvalidInstallPropertyError extends TypeError {
+    constructor(applicationName: string, installProperty: unknown);
+}
+export declare class InvalidInstallCommandError extends TypeError {
+    constructor(applicationName: string, command: unknown);
+}
+export declare class InvalidInstallTimeoutError extends TypeError {
+    constructor(applicationName: string, timeout: unknown);
+}
+export declare function assertApplicationConfig(applicationName: string, applicationConfig: Record<'package', unknown> & Record<string, unknown>): asserts applicationConfig is ApplicationConfig;
+/**
+ * Extract an application given payload (content of the application) or package (npm-compatible identifier to the application).
+ *
+ * Only one of `application.payload` or `application.package` should be specified; otherwise, an error is thrown.
+ *
+ * Writes the application to the configured components root directory using the `application.name` and overwrites any existing directory.
+ *
+ * This method should only be called from the main thread
+ */
+export declare function extractApplication(application: Application): Promise<void>;
+/**
+ * Install an application to its relative `application.dirPath` using either a
+ * configured `application.install` command, a derived package manager from the
+ * application's `package.json#devEngines`, or falling back to the default
+ * package manager, `npm`.
+ *
+ * Will return early if `node_modules` already exists within the `application.dirPath`
+ *
+ * This method should only be called from the main thread
+ */
+export declare function installApplication(application: Application): Promise<void>;
+interface ApplicationOptions {
+    name: string;
+    payload?: Buffer | string;
+    packageIdentifier?: string;
+    install?: {
+        command?: string;
+        timeout?: number;
+    };
+}
+export declare class Application {
+    name: string;
+    payload?: Buffer | string;
+    packageIdentifier?: string;
+    install?: {
+        command?: string;
+        timeout?: number;
+    };
+    dirPath: string;
+    logger: Logger;
+    packageManagerPrefix: string;
+    constructor({ name, payload, packageIdentifier, install }: ApplicationOptions);
+}
+/**
+ * Based on an old implementation for a method called `getPkgPrefix()` that was used
+ * during the installation process in order to actually resolve what the user specifies for a
+ * component matching some of npm's package resolution rules.
+ */
+export declare function derivePackageIdentifier(packageIdentifier: string): string;
+/**
+ * Extract and install the specified application.
+ *
+ * This method should only be called from the main thread
+ *
+ * @param application The application to prepare.
+ * @returns A promise that resolves when all preparation steps complete.
+ */
+export declare function prepareApplication(application: Application): Promise<void>;
+/**
+ * Install all applications specified in the root config.
+ *
+ * This method should only be called from the main thread otherwise certain
+ * operations may conflict with each other (such as writing to the same directory).
+ */
+export declare function installApplications(): Promise<void>;
+/**
+ * Execute a command (using `spawn`) with stdin ignored.
+ *
+ * Stdout is logged chunk-by-chunk. Stderr is buffered and then logged line-by-line.
+ *
+ * Rejects with an error if the command fails or times out.
+ *
+ * @param command The command to run.
+ * @param args The arguments to pass to the command.
+ * @param cwd The working directory for the command.
+ * @param timeoutMs The timeout for the command in milliseconds. Defaults to 5 minutes.
+ * @returns A promise that resolves when the command completes.
+ */
+export declare function nonInteractiveSpawn(applicationName: string, command: string, args: string[], cwd: string, timeoutMs?: number): Promise<{
+    stdout: string;
+    stderr: string;
+    code: number;
+}>;
+export declare function getEnvBuiltInComponents(): {
+    name: string;
+    packageIdentifier: string;
+}[];
+export {};