@realtimex/node-llama-cpp 0.1.0

package/dist/utils/cmake.js

@@ -0,0 +1,146 @@
+import path from "path";
+import fs from "fs-extra";
+import which from "which";
+import chalk from "chalk";
+import { chmodr } from "chmodrp";
+import { defaultXpacksCacheDirectory, defaultXpacksStoreDirectory, llamaDirectory, localXpacksCacheDirectory, localXpacksStoreDirectory, xpackDirectory, xpmVersion } from "../config.js";
+import { logDistroInstallInstruction } from "../bindings/utils/logDistroInstallInstruction.js";
+import { getPlatform } from "../bindings/utils/getPlatform.js";
+import { getWindowsVisualStudioEditionPaths } from "../bindings/utils/detectBuildTools.js";
+import { spawnCommand } from "./spawnCommand.js";
+import withStatusLogs from "./withStatusLogs.js";
+import { withLockfile } from "./withLockfile.js";
+export async function hasBuiltinCmake() {
+    try {
+        const resolvedPath = await which("cmake");
+        return resolvedPath !== "";
+    }
+    catch (err) {
+        return false;
+    }
+}
+export async function getCmakePath() {
+    try {
+        const resolvedPath = await which("cmake", {
+            nothrow: true
+        });
+        if (resolvedPath !== "" && resolvedPath != null)
+            return resolvedPath;
+    }
+    catch (err) { }
+    try {
+        const existingCmake = await findExistingCmake();
+        if (existingCmake != null)
+            return existingCmake;
+    }
+    catch (err) { }
+    try {
+        let resolvedPath = (await which("cmake", {
+            path: path.join(llamaDirectory, "xpack", "xpacks", ".bin"),
+            nothrow: true
+        })) || (await which("cmake", {
+            path: path.join(llamaDirectory, "xpack", "xpacks", "@xpack-dev-tools", "cmake", ".content", "bin")
+        }));
+        if (resolvedPath.toLowerCase().endsWith(".cmd"))
+            resolvedPath = (await getBinFromWindowCmd(resolvedPath, "cmake.exe")) ?? "";
+        else if (resolvedPath.toLowerCase().endsWith(".ps1")) {
+            const cmdFilePath = resolvedPath.slice(0, -".ps1".length) + ".cmd";
+            if (await fs.pathExists(cmdFilePath))
+                resolvedPath = (await getBinFromWindowCmd(cmdFilePath, "cmake.exe")) ?? "";
+        }
+        if (resolvedPath !== "")
+            return resolvedPath;
+    }
+    catch (err) { }
+    throw new Error("cmake not found");
+}
+export async function downloadCmakeIfNeeded(wrapWithStatusLogs = false) {
+    try {
+        await getCmakePath();
+        return;
+    }
+    catch (err) { }
+    if (!wrapWithStatusLogs)
+        await downloadCmake({ progressLogs: wrapWithStatusLogs });
+    else {
+        try {
+            await withStatusLogs({
+                loading: chalk.blue("Downloading cmake"),
+                success: chalk.blue("Downloaded cmake"),
+                fail: chalk.blue("Failed to download cmake")
+            }, async () => {
+                await downloadCmake({ progressLogs: wrapWithStatusLogs });
+            });
+        }
+        catch (err) {
+            await logDistroInstallInstruction('To install "cmake", ', {
+                linuxPackages: { apt: ["cmake"], apk: ["cmake"] },
+                macOsPackages: { brew: ["cmake"] }
+            });
+            throw err;
+        }
+    }
+}
+export async function clearLocalCmake() {
+    await fs.remove(localXpacksStoreDirectory);
+    await fs.remove(localXpacksCacheDirectory);
+    await fs.remove(path.join(xpackDirectory, "xpacks"));
+}
+/**
+ * There's an issue where after a compilation, the cmake binaries have permissions that don't allow them to be deleted.
+ * This function fixes that.
+ * It should be run after each compilation.
+ */
+export async function fixXpackPermissions() {
+    try {
+        await chmodr(localXpacksStoreDirectory, 0o777);
+        await chmodr(localXpacksCacheDirectory, 0o777);
+        await chmodr(path.join(xpackDirectory, "xpacks"), 0o777);
+    }
+    catch (err) { }
+}
+async function findExistingCmake() {
+    const platform = getPlatform();
+    if (platform === "win") {
+        const { vsEditionPaths } = await getWindowsVisualStudioEditionPaths();
+        const potentialCmakePaths = vsEditionPaths.map((editionPath) => (path.join(editionPath, "Common7", "IDE", "CommonExtensions", "Microsoft", "CMake", "CMake", "bin", "cmake.exe")));
+        const cmakePaths = (await Promise.all(potentialCmakePaths.map(async (cmakePath) => {
+            if (await fs.pathExists(cmakePath))
+                return cmakePath;
+            return null;
+        })))
+            .filter((cmakePath) => cmakePath != null);
+        return cmakePaths[0];
+    }
+    return undefined;
+}
+async function downloadCmake({ progressLogs = true } = {}) {
+    await withLockfile({
+        resourcePath: path.join(xpackDirectory, "cmakeInstall")
+    }, async () => {
+        const xpmEnv = {
+            ...process.env,
+            XPACKS_STORE_FOLDER: defaultXpacksStoreDirectory,
+            XPACKS_CACHE_FOLDER: defaultXpacksCacheDirectory
+        };
+        await spawnCommand("npm", ["exec", "--yes", "--", `xpm@${xpmVersion}`, "install", "@xpack-dev-tools/cmake@latest", "--no-save"], xpackDirectory, xpmEnv, progressLogs);
+        await fs.remove(localXpacksCacheDirectory);
+        await fixXpackPermissions();
+    });
+}
+async function getBinFromWindowCmd(cmdFilePath, binName) {
+    const fileContent = await fs.readFile(cmdFilePath, "utf8");
+    const lowercaseFileContent = fileContent.toLowerCase();
+    if (!lowercaseFileContent.includes(binName))
+        return null;
+    const lastIndexOfBinName = lowercaseFileContent.lastIndexOf(binName);
+    const characterAfterBinName = fileContent[lastIndexOfBinName + binName.length];
+    if (characterAfterBinName !== '"' && characterAfterBinName !== "'")
+        return null;
+    const startStringCharacter = fileContent.lastIndexOf(characterAfterBinName, lastIndexOfBinName);
+    const binPath = fileContent.slice(startStringCharacter + 1, lastIndexOfBinName + binName.length);
+    if (!await fs.pathExists(binPath))
+        return null;
+    return binPath;
+}
+//# sourceMappingURL=cmake.js.map

package/dist/utils/cmake.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cmake.js","sourceRoot":"","sources":["../../src/utils/cmake.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAC,MAAM,EAAC,MAAM,SAAS,CAAC;AAC/B,OAAO,EACH,2BAA2B,EAAE,2BAA2B,EAAE,cAAc,EAAE,yBAAyB,EAAE,yBAAyB,EAC9H,cAAc,EAAE,UAAU,EAC7B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAC,2BAA2B,EAAC,MAAM,kDAAkD,CAAC;AAC7F,OAAO,EAAC,WAAW,EAAC,MAAM,kCAAkC,CAAC;AAC7D,OAAO,EAAC,kCAAkC,EAAC,MAAM,uCAAuC,CAAC;AACzF,OAAO,EAAC,YAAY,EAAC,MAAM,mBAAmB,CAAC;AAC/C,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAC,YAAY,EAAC,MAAM,mBAAmB,CAAC;AAG/C,MAAM,CAAC,KAAK,UAAU,eAAe;IACjC,IAAI,CAAC;QACD,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,CAAC;QAC1C,OAAO,YAAY,KAAK,EAAE,CAAC;IAC/B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACX,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY;IAC9B,IAAI,CAAC;QACD,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE;YACtC,OAAO,EAAE,IAAI;SAChB,CAAC,CAAC;QAEH,IAAI,YAAY,KAAK,EAAE,IAAI,YAAY,IAAI,IAAI;YAC3C,OAAO,YAAY,CAAC;IAC5B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC,CAAA,CAAC;IAEhB,IAAI,CAAC;QACD,MAAM,aAAa,GAAG,MAAM,iBAAiB,EAAE,CAAC;QAChD,IAAI,aAAa,IAAI,IAAI;YACrB,OAAO,aAAa,CAAC;IAC7B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC,CAAA,CAAC;IAEhB,IAAI,CAAC;QACD,IAAI,YAAY,GAAG,CACf,MAAM,KAAK,CAAC,OAAO,EAAE;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC;YAC1D,OAAO,EAAE,IAAI;SAChB,CAAC,CACL,IAAI,CACD,MAAM,KAAK,CAAC,OAAO,EAAE;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC;SACrG,CAAC,CACL,CAAC;QAEF,IAAI,YAAY,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC;YAC3C,YAAY,GAAG,CAAC,MAAM,mBAAmB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC,IAAI,EAAE,CAAC;aAC3E,IAAI,YAAY,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACnD,MAAM,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;YAEnE,IAAI,MAAM,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC;gBAChC,YAAY,GAAG,CAAC,MAAM,mBAAmB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,IAAI,EAAE,CAAC;QACnF,CAAC;QAED,IAAI,YAAY,KAAK,EAAE;YACnB,OAAO,YAAY,CAAC;IAC5B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC,CAAA,CAAC;IAEhB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;AACvC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,qBAA8B,KAAK;IAC3E,IAAI,CAAC;QACD,MAAM,YAAY,EAAE,CAAC;QACrB,OAAO;IACX,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC,CAAA,CAAC;IAEhB,IAAI,CAAC,kBAAkB;QACnB,MAAM,aAAa,CAAC,EAAC,YAAY,EAAE,kBAAkB,EAAC,CAAC,CAAC;SACvD,CAAC;QACF,IAAI,CAAC;YACD,MAAM,cAAc,CAAC;gBACjB,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC;gBACxC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC;gBACvC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,0BAA0B,CAAC;aAC/C,EAAE,KAAK,IAAI,EAAE;gBACV,MAAM,aAAa,CAAC,EAAC,YAAY,EAAE,kBAAkB,EAAC,CAAC,CAAC;YAC5D,CAAC,CAAC,CAAC;QACP,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,MAAM,2BAA2B,CAAC,sBAAsB,EAAE;gBACtD,aAAa,EAAE,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,EAAC;gBAC/C,aAAa,EAAE,EAAC,IAAI,EAAE,CAAC,OAAO,CAAC,EAAC;aACnC,CAAC,CAAC;YACH,MAAM,GAAG,CAAC;QACd,CAAC;IACL,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe;IACjC,MAAM,EAAE,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC;IAC3C,MAAM,EAAE,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC;IAC3C,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC;AACzD,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB;IACrC,IAAI,CAAC;QACD,MAAM,MAAM,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;QAC/C,MAAM,MAAM,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;QAC/C,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC,CAAA,CAAC;AACpB,CAAC;AAED,KAAK,UAAU,iBAAiB;IAC5B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAE/B,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;QACrB,MAAM,EAAC,cAAc,EAAC,GAAG,MAAM,kCAAkC,EAAE,CAAC;QAEpE,MAAM,mBAAmB,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAC5D,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE,kBAAkB,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,CAAC,CAClH,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,CAAC,MAAM,OAAO,CAAC,GAAG,CACjC,mBAAmB,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;YACxC,IAAI,MAAM,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC;gBAC9B,OAAO,SAAS,CAAC;YAErB,OAAO,IAAI,CAAC;QAChB,CAAC,CAAC,CACL,CAAC;aACG,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC;QAE9C,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;IACzB,CAAC;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,EAAC,YAAY,GAAG,IAAI,KAA8B,EAAE;IAC7E,MAAM,YAAY,CAAC;QACf,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC;KAC1D,EAAE,KAAK,IAAI,EAAE;QACV,MAAM,MAAM,GAAsB;YAC9B,GAAG,OAAO,CAAC,GAAG;YACd,mBAAmB,EAAE,2BAA2B;YAChD,mBAAmB,EAAE,2BAA2B;SACnD,CAAC;QAEF,MAAM,YAAY,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,UAAU,EAAE,EAAE,SAAS,EAAE,+BAA+B,EAAE,WAAW,CAAC,EAAE,cAAc,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;QAEvK,MAAM,EAAE,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC;QAC3C,MAAM,mBAAmB,EAAE,CAAC;IAChC,CAAC,CAAC,CAAC;AACP,CAAC;AAED,KAAK,UAAU,mBAAmB,CAAC,WAAmB,EAAE,OAAe;IACnE,MAAM,WAAW,GAAW,MAAM,EAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACnE,MAAM,oBAAoB,GAAG,WAAW,CAAC,WAAW,EAAE,CAAC;IAEvD,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,OAAO,CAAC;QACvC,OAAO,IAAI,CAAC;IAEhB,MAAM,kBAAkB,GAAG,oBAAoB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IACrE,MAAM,qBAAqB,GAAG,WAAW,CAAC,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE/E,IAAI,qBAAqB,KAAK,GAAG,IAAI,qBAAqB,KAAK,GAAG;QAC9D,OAAO,IAAI,CAAC;IAEhB,MAAM,oBAAoB,GAAG,WAAW,CAAC,WAAW,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,CAAC;IAEhG,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,oBAAoB,GAAG,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjG,IAAI,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC;QAC7B,OAAO,IAAI,CAAC;IAEhB,OAAO,OAAO,CAAC;AACnB,CAAC"}

package/dist/utils/compareTokens.d.ts

@@ -0,0 +1,2 @@
+import { Token } from "../types.js";
+export declare function compareTokens(token1?: Token, token2?: Token): boolean;

package/dist/utils/compareTokens.js

@@ -0,0 +1,4 @@
+export function compareTokens(token1, token2) {
+    return token1 === token2;
+}
+//# sourceMappingURL=compareTokens.js.map

package/dist/utils/compareTokens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compareTokens.js","sourceRoot":"","sources":["../../src/utils/compareTokens.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,aAAa,CAAC,MAAc,EAAE,MAAc;IACxD,OAAO,MAAM,KAAK,MAAM,CAAC;AAC7B,CAAC"}

package/dist/utils/createModelDownloader.d.ts

@@ -0,0 +1,262 @@
+import { ModelFileAccessTokens } from "./modelFileAccessTokens.js";
+import { ModelDownloadEndpoints } from "./modelDownloadEndpoints.js";
+export type ModelDownloaderOptions = ({
+    /**
+     * The URI to download the model from.
+     *
+     * The supported URI schemes are:
+     * - **HTTP:** `https://`, `http://`
+     * - **Hugging Face:** `hf:<user>/<model>:<quant>` (`:<quant>` is optional, but recommended)
+     * - **Hugging Face:** `hf:<user>/<model>/<file-path>#<branch>` (`#<branch>` is optional)
+     */
+    modelUri: string;
+} | {
+    /**
+     * @hidden
+     * @deprecated Use `modelUri` instead.
+     */
+    modelUrl: string;
+}) & {
+    /**
+     * The directory to save the model file to.
+     * Default to `node-llama-cpp`'s default global models directory (`~/.node-llama-cpp/models`).
+     */
+    dirPath?: string;
+    fileName?: string;
+    headers?: Record<string, string>;
+    /**
+     * Defaults to `false`.
+     */
+    showCliProgress?: boolean;
+    onProgress?: (status: {
+        totalSize: number;
+        downloadedSize: number;
+    }) => void;
+    /**
+     * If true, the downloader will skip the download if the file already exists, and its size matches the size of the remote file.
+     *
+     * Defaults to `true`.
+     */
+    skipExisting?: boolean;
+    /**
+     * If true, the temporary file will be deleted when the download is canceled.
+     *
+     * Defaults to `true`.
+     */
+    deleteTempFileOnCancel?: boolean;
+    /**
+     * The number of parallel downloads to use when downloading split files.
+     *
+     * Defaults to `4`.
+     */
+    parallelDownloads?: number;
+    /**
+     * Tokens to use to access the remote model file when downloading.
+     */
+    tokens?: ModelFileAccessTokens;
+    /**
+     * Configure the URLs used for resolving model URIs.
+     * @see [Model URIs](https://node-llama-cpp.withcat.ai/guide/downloading-models#model-uris)
+     */
+    endpoints?: ModelDownloadEndpoints;
+};
+/**
+ * Create a model downloader to download a model from a URI.
+ * Uses [`ipull`](https://github.com/ido-pluto/ipull) to download a model file as fast as possible with parallel connections
+ * and other optimizations.
+ *
+ * If the uri points to a `.gguf` file that is split into multiple parts (for example, `model-00001-of-00009.gguf`),
+ * all the parts will be downloaded to the specified directory.
+ *
+ * If the uri points to a `.gguf` file that is binary split into multiple parts (for example, `model.gguf.part1of9`),
+ * all the parts will be spliced into a single file and be downloaded to the specified directory.
+ *
+ * If the uri points to a `.gguf` file that is not split or binary spliced (for example, `model.gguf`),
+ * the file will be downloaded to the specified directory.
+ *
+ * The supported URI schemes are:
+ * - **HTTP:** `https://`, `http://`
+ * - **Hugging Face:** `hf:<user>/<model>:<quant>` (`:<quant>` is optional, but recommended)
+ * - **Hugging Face:** `hf:<user>/<model>/<file-path>#<branch>` (`#<branch>` is optional)
+ * @example
+ * ```typescript
+ * import {fileURLToPath} from "url";
+ * import path from "path";
+ * import {createModelDownloader, getLlama} from "node-llama-cpp";
+ *
+ * const __dirname = path.dirname(fileURLToPath(import.meta.url));
+ *
+ * const downloader = await createModelDownloader({
+ *     modelUri: "https://example.com/model.gguf",
+ *     dirPath: path.join(__dirname, "models")
+ * });
+ * const modelPath = await downloader.download();
+ *
+ * const llama = await getLlama();
+ * const model = await llama.loadModel({
+ *     modelPath
+ * });
+ * ```
+ * @example
+ * ```typescript
+ * import {fileURLToPath} from "url";
+ * import path from "path";
+ * import {createModelDownloader, getLlama} from "node-llama-cpp";
+ *
+ * const __dirname = path.dirname(fileURLToPath(import.meta.url));
+ *
+ * const downloader = await createModelDownloader({
+ *     modelUri: "hf:user/model:quant",
+ *     dirPath: path.join(__dirname, "models")
+ * });
+ * const modelPath = await downloader.download();
+ *
+ * const llama = await getLlama();
+ * const model = await llama.loadModel({
+ *     modelPath
+ * });
+ * ```
+ */
+export declare function createModelDownloader(options: ModelDownloaderOptions): Promise<ModelDownloader>;
+/**
+ * Combine multiple models downloaders to a single downloader to download everything using as much parallelism as possible.
+ *
+ * You can check each individual model downloader for its download progress,
+ * but only the `onProgress` passed to the combined downloader will be called during the download.
+ *
+ * When combining `ModelDownloader` instances, the following options on each individual `ModelDownloader` are ignored:
+ * - `showCliProgress`
+ * - `onProgress`
+ * - `parallelDownloads`
+ *
+ * To set any of those options for the combined downloader, you have to pass them to the combined downloader instance.
+ * @example
+ * ```typescript
+ * import {fileURLToPath} from "url";
+ * import path from "path";
+ * import {createModelDownloader, combineModelDownloaders, getLlama} from "node-llama-cpp";
+ *
+ * const __dirname = path.dirname(fileURLToPath(import.meta.url));
+ *
+ * const downloaders = [
+ *     createModelDownloader({
+ *         modelUri: "https://example.com/model1.gguf",
+ *         dirPath: path.join(__dirname, "models")
+ *     }),
+ *     createModelDownloader({
+ *         modelUri: "hf:user/model2:quant",
+ *         dirPath: path.join(__dirname, "models")
+ *     }),
+ *     createModelDownloader({
+ *         modelUri: "hf:user/model/model3.gguf",
+ *         dirPath: path.join(__dirname, "models")
+ *     })
+ * ];
+ * const combinedDownloader = await combineModelDownloaders(downloaders, {
+ *     showCliProgress: true // show download progress in the CLI
+ * });
+ * const [
+ *     model1Path,
+ *     model2Path,
+ *     model3Path
+ * ] = await combinedDownloader.download();
+ *
+ * const llama = await getLlama();
+ * const model1 = await llama.loadModel({
+ *     modelPath: model1Path!
+ * });
+ * const model2 = await llama.loadModel({
+ *     modelPath: model2Path!
+ * });
+ * const model3 = await llama.loadModel({
+ *     modelPath: model3Path!
+ * });
+ * ```
+ */
+export declare function combineModelDownloaders(downloaders: (ModelDownloader | Promise<ModelDownloader>)[], options?: CombinedModelDownloaderOptions): Promise<CombinedModelDownloader>;
+export declare class ModelDownloader {
+    private constructor();
+    /**
+     * The filename of the entrypoint file that should be used to load the model.
+     */
+    get entrypointFilename(): string;
+    /**
+     * The full path to the entrypoint file that should be used to load the model.
+     */
+    get entrypointFilePath(): string;
+    /**
+     * If the model is binary spliced from multiple parts, this will return the number of those binary parts.
+     */
+    get splitBinaryParts(): number | undefined;
+    /**
+     * The total number of files that will be saved to the directory.
+     * For split files, this will be the number of split parts, as multiple files will be saved.
+     * For binary-split files, this will be 1, as the parts will be spliced into a single file.
+     */
+    get totalFiles(): number;
+    get totalSize(): number;
+    get downloadedSize(): number;
+    /**
+     * @returns The path to the entrypoint file that should be used to load the model
+     */
+    download({ signal }?: {
+        signal?: AbortSignal;
+    }): Promise<string>;
+    cancel({ deleteTempFile }?: {
+        /**
+         * Delete the temporary file that was created during the download.
+         *
+         * Defaults to the value of `deleteTempFileOnCancel` in the constructor.
+         */
+        deleteTempFile?: boolean;
+    }): Promise<void>;
+}
+export type CombinedModelDownloaderOptions = {
+    /**
+     * Defaults to `false`.
+     */
+    showCliProgress?: boolean;
+    onProgress?: (status: {
+        totalSize: number;
+        downloadedSize: number;
+    }) => void;
+    /**
+     * The number of parallel downloads to use fo files.
+     *
+     * Defaults to `4`.
+     */
+    parallelDownloads?: number;
+};
+export declare class CombinedModelDownloader {
+    /**
+     * When combining `ModelDownloader` instances, the following options on each individual `ModelDownloader` are ignored:
+     * - `showCliProgress`
+     * - `onProgress`
+     * - `parallelDownloads`
+     *
+     * To set any of those options for the combined downloader, you have to pass them to the combined downloader instance
+     */
+    private constructor();
+    cancel(): Promise<void>;
+    /**
+     * @returns The paths to the entrypoint files that should be used to load the models
+     */
+    download({ signal }?: {
+        signal?: AbortSignal;
+    }): Promise<string[]>;
+    get modelDownloaders(): readonly ModelDownloader[];
+    /**
+     * The filename of the entrypoint files that should be used to load the models.
+     */
+    get entrypointFilenames(): string[];
+    /**
+     * The full paths to the entrypoint files that should be used to load the models.
+     */
+    get entrypointFilePaths(): string[];
+    /**
+     * The accumulation of `totalFiles` of all the model downloaders
+     */
+    get totalFiles(): number;
+    get totalSize(): number;
+    get downloadedSize(): number;
+}