@metamask/snaps-simulation/dist/files.mjs

A simulation framework for MetaMask Snaps, enabling headless testing of Snaps in a controlled environment

function $importDefault(module) {
    if (module?.__esModule) {
        return module.default;
    }
    return module;
}
import { AuxiliaryFileEncoding } from "@metamask/snaps-sdk";
import { encodeAuxiliaryFile, normalizeRelative } from "@metamask/snaps-utils";
import { bytesToBase64 } from "@metamask/utils";
import { readFile, stat } from "fs/promises";
import $mime from "mime/index.js";
const mime = $importDefault($mime);
import { basename, extname, resolve } from "path";
/**
 * Get a statically defined Snap file from an array of files.
 *
 * @param files - The Snap files.
 * @param path - The file path.
 * @param encoding - The requested file encoding.
 * @returns The file in the requested encoding if found, otherwise null.
 */
export async function getSnapFile(files, path, encoding = AuxiliaryFileEncoding.Base64) {
    const normalizedPath = normalizeRelative(path);
    const base64 = files
        .find((file) => file.path === normalizedPath)
        ?.toString('base64');
    if (!base64) {
        return null;
    }
    return await encodeAuxiliaryFile(base64, encoding);
}
/**
 * Get the content type of a file based on its extension.
 *
 * @param extension - The file extension.
 * @returns The content type of the file. If the content type cannot be inferred
 * from the extension, `application/octet-stream` is returned.
 */
export function getContentType(extension) {
    return mime.getType(extension) ?? 'application/octet-stream';
}
/**
 * Get the size of a file, from a file path or a `Uint8Array`.
 *
 * @param file - The file to get the size of. This can be a path to a file or a
 * `Uint8Array` containing the file contents. If this is a path, the file is
 * resolved relative to the current working directory.
 * @returns The size of the file in bytes.
 */
export async function getFileSize(file) {
    if (typeof file === 'string') {
        const { size } = await stat(resolve(process.cwd(), file));
        return size;
    }
    return file.length;
}
/**
 * Get a file object to upload, from a file path or a `Uint8Array`, with an
 * optional file name and content type.
 *
 * @param file - The file to upload. This can be a path to a file or a
 * `Uint8Array` containing the file contents. If this is a path, the file is
 * resolved relative to the current working directory.
 * @param options - The file options.
 * @param options.fileName - The name of the file. By default, this is
 * inferred from the file path if it's a path, and defaults to an empty string
 * if it's a `Uint8Array`.
 * @param options.contentType - The content type of the file. By default, this
 * is inferred from the file name if it's a path, and defaults to
 * `application/octet-stream` if it's a `Uint8Array` or the content type
 * cannot be inferred from the file name.
 * @returns The file object to upload.
 */
export async function getFileToUpload(file, { fileName, contentType } = {}) {
    if (typeof file === 'string') {
        const buffer = await readFile(resolve(process.cwd(), file));
        return {
            name: fileName ?? basename(file),
            size: buffer.byteLength,
            contentType: contentType ?? getContentType(extname(file)),
            contents: bytesToBase64(buffer),
        };
    }
    return {
        name: fileName ?? '',
        size: file.length,
        contentType: contentType ?? 'application/octet-stream',
        contents: bytesToBase64(file),
    };
}
//# sourceMappingURL=files.mjs.map