@rage-against-the-pixel/unity-cli 3.0.2 → 4.0.1

package/dist/unity-hub.d.ts

@@ -1,140 +0,0 @@
-import { UnityEditor } from './unity-editor';
-import { UnityVersion } from './unity-version';
-import { ExecOptions } from './utilities';
-import { UnityRelease } from '@rage-against-the-pixel/unity-releases-api';
-/** Hub 3.20+ Electron Forge deb layout. */
-export declare const LINUX_HUB_EXECUTABLE_MODERN = "/usr/lib/unityhub/unityhub";
-/** Hub ≤3.19 fpm / electron-builder layout. */
-export declare const LINUX_HUB_EXECUTABLE_LEGACY = "/opt/unityhub/unityhub";
-/**
- * Resolves the Unity Hub binary on Linux.
- * Prefers UNITY_HUB_PATH, then the Hub 3.20+ path, then the legacy /opt path.
- * When neither is present (pre-install), defaults to the modern path.
- */
-export declare function resolveLinuxHubExecutable(envPath?: string | undefined, existsSync?: (p: string) => boolean): string;
-export declare class UnityHub {
-    /** The path to the Unity Hub executable. */
-    executable: string;
-    /** The root directory of the Unity Hub installation. */
-    rootDirectory: string;
-    /** The file extension for the Unity editor executable. */
-    readonly editorFileExtension: string;
-    private readonly logger;
-    constructor();
-    /** Re-resolve Linux Hub executable + root after install/upgrade (Hub 3.20 moved under /usr/lib). */
-    private refreshLinuxHubPaths;
-    /**
-     * Some Hub builds (notably Windows headless) occasionally exit non-zero after streaming usable
-     * `editors --releases` / `editors -i` data. Tolerate only when the captured output parses the same
-     * way {@link ListAvailableReleases} / {@link ListInstalledEditors} would (avoids regex false positives).
-     */
-    private hubListingExitTolerable;
-    private isHubEditorListingArgs;
-    private delayMs;
-    /** Same parsing rules as {@link ListAvailableReleases}; must stay in sync. */
-    private parseAvailableReleasesFromHubText;
-    /** Same parsing rules as {@link ListInstalledEditors}; must stay in sync. */
-    private parseInstalledEditorsFromHubText;
-    /**
-     * Executes the Unity Hub command with the specified arguments.
-     * @param args Arguments to pass to the Unity Hub executable.
-     * @param options Logging and spawn options for this invocation.
-     * @returns The output from the command.
-     */
-    Exec(args: string[], options?: ExecOptions): Promise<string>;
-    /**
-     * @param listingRetryDepth 0 on first attempt; 1 after one listing-only retry (flaky Hub exits on Windows CI).
-     */
-    private execImpl;
-    /**
-     * Prints the installed Unity Hub version.
-     * @returns The installed Unity Hub version.
-     */
-    Version(): Promise<string>;
-    /**
-     * Installs or updates the Unity Hub.
-     * If the Unity Hub is already installed, it will be updated to the latest version.
-     * @param autoUpdate If true, automatically updates the Unity Hub if it is already installed. Default is true.
-     * @returns The path to the Unity Hub executable.
-     */
-    Install(autoUpdate: boolean | undefined, version: string | undefined): Promise<string>;
-    /**
-     * APT package spec for unityhub (e.g. `unityhub` or `unityhub=3.6.0`). Validated; passed as argv, not shell-embedded.
-     */
-    private unityHubAptPackageSpec;
-    private installHub;
-    private getInstalledHubVersion;
-    private getLatestHubVersion;
-    /**
-     * Returns the path where the Unity editors will be installed.
-     * @returns The editor install path.
-     */
-    GetInstallPath(): Promise<string>;
-    /**
-     * Sets the path where Unity editors will be installed.
-     * @param installPath The install path to set when installing Unity editors.
-     */
-    SetInstallPath(installPath: string): Promise<void>;
-    /**
-     * Locate and associate an installed editor from a stipulated path.
-     * @param editorPath The path to the Unity Editor installation.
-     */
-    AddEditor(editorPath: string): Promise<void>;
-    /**
-     * Attempts to find or install the specified Unity Editor version with the requested modules.
-     * @param unityVersion The Unity version to find or install.
-     * @param modules The modules to install alongside the editor.
-     * @param channels The channels to consider when searching for the editor. Can be 'f' (final), 'p' (patch), 'b' (beta), 'a' (alpha), or 'x' (experimental). Default is ['f'].
-     * @returns The path to the Unity Editor executable.
-     */
-    GetEditor(unityVersion: UnityVersion, modules?: string[], channels?: string[]): Promise<UnityEditor>;
-    /**
-     * Lists the installed Unity Editors.
-     * @returns A list of installed Unity Editor versions and their paths.
-     */
-    ListInstalledEditors(): Promise<UnityEditor[]>;
-    /**
-     * Lists the available Unity releases.
-     * @returns A list of available Unity release versions.
-     */
-    ListAvailableReleases(): Promise<UnityVersion[]>;
-    private checkInstalledEditors;
-    /**
-     * Patches the Bee Backend for Unity Linux Editor.
-     * https://discussions.unity.com/t/linux-editor-stuck-on-loading-because-of-bee-backend-w-workaround/854480
-     * @param editorPath The path to the Unity Editor executable.
-     */
-    private patchBeeBackend;
-    /**
-     * Gets the specified Unity release info from the Unity Releases API.
-     * Supports querying by exact version or by prefix (e.g., "2020", "2020.1", "2021.x", "2021.3.x").
-     * @param unityVersion The Unity version to get the release info for.
-     * @param channels Letter channels to accept (`f`, `p`, `b`, `a`, `x`). Default stable-only.
-     * @returns The Unity release info.
-     */
-    GetEditorReleaseInfo(unityVersion: UnityVersion, channels?: string[]): Promise<UnityRelease>;
-    private fallbackVersionLookup;
-    private checkEditorModules;
-    private getModulesContent;
-    private installUnity;
-    private installUnity4x;
-    /**
-     * Get the mapping of Unity platform targets to their corresponding module identifiers for the current OS.
-     * @returns A map of Unity platform targets to their corresponding module identifiers for the current OS.
-     */
-    static GetPlatformTargetModuleMap(): {
-        [key: string]: string;
-    };
-    /**
-     * Returns the path to the Unity Hub log file.
-     * @see https://docs.unity.com/en-us/licensing-server/troubleshooting-client#logs
-     * @returns The Unity Hub log file path.
-     */
-    static LogPath(): string;
-    /**
-     * Returns the path to the Unity Package Manager log file.
-     * @see https://docs.unity3d.com/Manual/LogFiles.html
-     * @returns The Unity Package Manager log file path.
-     */
-    static PackageManagerLogsPath(): string;
-}