@rage-against-the-pixel/unity-cli 3.0.1 → 4.0.0

package/dist/unity-installer.d.ts

@@ -0,0 +1,134 @@
+import { UnityEditor } from './unity-editor';
+import { UnityVersion } from './unity-version';
+import { UnityCli } from './unity-cli';
+import { UnityRelease } from '@rage-against-the-pixel/unity-releases-api';
+/**
+ * Finds or installs Unity Editors.
+ * - 2017.4 and newer install through the official Unity CLI (`unity install`).
+ * - 5.x installs from Unity's download archive, because the official CLI reads one-digit majors as Unity 6 shorthand.
+ * - 4.x installs from Unity's legacy installers.
+ */
+export declare class UnityInstaller {
+    private readonly logger;
+    private cli;
+    /** The 5.x release being installed from the archive, and its installers' published integrity values. */
+    private archiveVersion;
+    private archiveIntegrity;
+    /**
+     * @param cli The official Unity CLI to use. Installed on demand when omitted.
+     */
+    constructor(cli?: UnityCli | undefined);
+    /**
+     * Gets the official Unity CLI, installing it when needed.
+     */
+    GetCli(): Promise<UnityCli>;
+    /**
+     * Sets the directory editors are installed to.
+     * @param installPath The directory to install editors to.
+     */
+    SetInstallPath(installPath: string): Promise<void>;
+    /**
+     * Gets the directory editors are installed to.
+     */
+    GetInstallPath(): Promise<string>;
+    /**
+     * Finds the requested Unity Editor, installing it and any missing modules when needed.
+     * @param unityVersion The Unity version to find or install. Partial versions such as 2021.3.x resolve to the newest matching release.
+     * @param modules The module ids to install alongside the editor.
+     * @param channels The release channels to accept when resolving a partial version: f, p, b, a or x. Default is ['f'].
+     */
+    GetEditor(unityVersion: UnityVersion, modules?: string[], channels?: string[]): Promise<UnityEditor>;
+    /**
+     * Resolves a partial or changeset-less version to an exact release with its changeset.
+     * 4.x versions are returned as they are, since no release service lists them.
+     * @param unityVersion The requested version.
+     * @param channels The release channels to accept.
+     */
+    resolveVersion(unityVersion: UnityVersion, channels?: string[]): Promise<UnityVersion>;
+    private installCliEditor;
+    private execWithRetry;
+    /**
+     * Drops modules the release does not offer, since `unity install` fails on an unknown module id.
+     */
+    private filterModules;
+    /**
+     * Looks up an installed editor with `unity editors path`, registering one that sits in the install path but that the CLI does not know about yet.
+     */
+    private findCliEditor;
+    private getLegacyInstallPath;
+    /**
+     * Installs Unity 5.x from the download archive.
+     */
+    private installArchiveEditor;
+    /**
+     * Gets the checksum a download must match before it is installed: a pinned SHA-256 for the fixed installers,
+     * or the Unity Releases API integrity value for 5.x archive installers. Fails closed when neither is known.
+     * @param url The download URL.
+     */
+    private getDownloadOptions;
+    /**
+     * Maps each installer URL of a release (editor and modules) to the integrity value the Unity Releases API publishes for it.
+     * @param unityVersion The exact release.
+     */
+    private static getReleaseIntegrity;
+    private getArchiveModuleNames;
+    /**
+     * Runs a Unity NSIS installer silently. NSIS needs `/D=` last and unquoted, so the command line is passed verbatim, without a shell.
+     */
+    private runWindowsInstaller;
+    private installMacPackages;
+    /**
+     * Moves target support that macOS packages installed to /Applications/Unity/PlaybackEngines into an existing versioned editor.
+     */
+    private moveMacPlaybackEngines;
+    /**
+     * Moves an editor that a macOS package installed to /Applications/Unity into its versioned folder.
+     */
+    private moveMacApplicationsUnity;
+    /**
+     * Rejects versions and changesets that are not plain Unity release identifiers before they become URLs and paths.
+     */
+    private static assertArchiveVersion;
+    /**
+     * Installs Unity 4.x from Unity's legacy installers.
+     */
+    private installLegacyEditor;
+    /**
+     * Installs the system packages the Linux editor needs, and the older libssl that 2019.1 to 2021.x link against.
+     */
+    private installLinuxDependencies;
+    /**
+     * 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.
+     */
+    static GetEditorReleaseInfo(unityVersion: UnityVersion, channels?: string[]): Promise<UnityRelease>;
+    private static fallbackVersionLookup;
+    /**
+     * 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;
+    };
+}
+/**
+ * Resolves an install directory, Editor folder, app bundle or executable to the editor executable.
+ * @param location A path the editor may be under.
+ * @returns The editor executable, or undefined when none is found.
+ */
+export declare function resolveEditorExecutable(location: string | undefined): string | undefined;
+/**
+ * Reads the CPU architectures of a macOS editor binary from its Mach-O header.
+ * @param executablePath The editor executable.
+ * @returns The architectures, or undefined off macOS or when the header is not recognized, in which case callers accept the editor.
+ */
+export declare function getExecutableArchitectures(executablePath: string): ('X86_64' | 'ARM64')[] | undefined;