@zthun/romulator-api 1.9.0 → 1.11.0

package/dist/files/files-service.d.mts

@@ -1,120 +0,0 @@
-import { IZFileRepository, IZFileSystemNode, IZFileSystemService } from '@zthun/crumbtrail-fs';
-import { IZRomulatorConfigsService } from '../config/configs-service.mjs';
-export declare const ZRomulatorFilesToken: unique symbol;
-/**
- * Represents the service that you can use to
- * scan the games folder for media, info, games, and systems.
- */
-export interface IZRomulatorFilesService {
-    /**
-     * Retrieves all media found in the games .media folder.
-     *
-     * @returns
-     *        A list of all media found in the game media folder.
-     */
-    media(): Promise<IZFileSystemNode[]>;
-    /**
-     * Retrieves a single media node found in the .media folder.
-     *
-     * @param path -
-     *        The path of the media node to retrieve.  This will
-     *        be relative to the configured games directory.  If this
-     *        starts with a root OS folder, then the path by itself
-     *        is used.
-     *
-     * @returns
-     *        The node with the given path or null if no such
-     *        file exists.
-     */
-    media(path: string): Promise<IZFileSystemNode | null>;
-    /**
-     * Retrieves all systems found in the games folder.
-     *
-     * A system is a root folder that is a slug of a supported
-     * system.
-     *
-     * @returns
-     *        A list of all systems found in the games folder.
-     */
-    systems(): Promise<IZFileSystemNode[]>;
-    /**
-     * Retrieves a single system found in the games folder.
-     *
-     * @param path -
-     *        The id of the system, which is also the name of the folder.
-     *
-     * @returns
-     *        The node that represents the system slug.  Returns null if
-     *        the folder does not exist or is not supported.  Note
-     *        that the path is relative to the configured games folder. If you
-     *        want to supply a fully qualified absolute path, then this string
-     *        should start with the root of an OS drive (not recommended).
-     */
-    systems(path: string): Promise<IZFileSystemNode | null>;
-    /**
-     * Retrieves all info found in the games .info folder.
-     *
-     * Info is the metadata scraped from a scraper service.
-     * The data format is stored in json.
-     *
-     * @returns
-     *        A list of all info found in the games folder.
-     */
-    info(): Promise<IZFileSystemNode[]>;
-    /**
-     * Retrieves specific information found in the games .info folder.
-     *
-     * @param path -
-     *        The path of the info node to retrieve.
-     *
-     * @returns
-     *        The node with the given path or null if no such file exists.
-     */
-    info(path: string): Promise<IZFileSystemNode | null>;
-    /**
-     * Gets the contents of the file.
-     *
-     * @param info -
-     *        The file to read and store.
-     *
-     * @returns
-     *        The buffer of data that the file contained.
-     */
-    read(info: IZFileSystemNode): Promise<Buffer>;
-    /**
-     * Initializes the file repository.
-     */
-    init(): Promise<void>;
-    /**
-     * Cleans up internal resources.
-     */
-    dispose(): Promise<void>;
-}
-export declare class ZRomulatorFilesService implements IZRomulatorFilesService {
-    private readonly _configs;
-    private readonly _fileSystem;
-    private static readonly MediaFolderName;
-    private static readonly InfoFolderName;
-    private _repository;
-    private _folderStream;
-    private _fileStream;
-    private _globs;
-    private _systems;
-    constructor(_configs: IZRomulatorConfigsService, _fileSystem: IZFileSystemService);
-    private gamesFolder;
-    private mediaFolder;
-    private infoFolder;
-    private contents;
-    init(): Promise<void>;
-    dispose(): Promise<void>;
-    seed(): Promise<IZFileRepository>;
-    media(): Promise<IZFileSystemNode[]>;
-    media(path: string): Promise<IZFileSystemNode | null>;
-    systems(): Promise<IZFileSystemNode[]>;
-    systems(path: string): Promise<IZFileSystemNode | null>;
-    info(): Promise<IZFileSystemNode[]>;
-    info(path: string): Promise<IZFileSystemNode | null>;
-    games(): Promise<IZFileSystemNode[]>;
-    games(path: string): Promise<IZFileSystemNode | null>;
-    read(node: IZFileSystemNode): Promise<Buffer>;
-}

package/dist/systems/system-known.d.mts

@@ -1,80 +0,0 @@
-import { IZRomulatorSystem } from '@zthun/romulator-client';
-/**
- * A helper factory class for creating supported systems.
- */
-export declare abstract class ZRomulatorSystemKnown {
-    /**
-     * Returns all known systems.
-     *
-     * @returns
-     *        All supported systems.
-     */
-    static all(): IZRomulatorSystem[];
-    /**
-     * Creates a system that represents the Nintendo
-     * Entertainment System (NES).
-     *
-     * @returns
-     *        A {@link ZRomulatorSystemBuilder} instance that has
-     *        built the nes.
-     */
-    static nes(): IZRomulatorSystem;
-    /**
-     * Creates a system that represents the Super
-     * Nintendo Entertainment System (SNES).
-     *
-     * @returns
-     *        This instance.
-     */
-    static snes(): IZRomulatorSystem;
-    /**
-     * Creates a system that represents the Nintendo
-     * 64 (N64).
-     *
-     * @returns
-     *        This instance.
-     */
-    static n64(): IZRomulatorSystem;
-    /**
-     * Creates a system that represents the Nintendo
-     * GameCube (GC).
-     *
-     * @returns
-     *        This instance.
-     */
-    static gc(): IZRomulatorSystem;
-    /**
-     * Creates a system that represents the Nintendo
-     * Wii (Wii).
-     *
-     * @returns
-     *        This instance.
-     */
-    static wii(): IZRomulatorSystem;
-    /**
-     * Creates a system that represents the Nintendo
-     * Wii U (WiiU).
-     *
-     * @returns
-     *        This instance.
-     */
-    static wiiu(): IZRomulatorSystem;
-    /**
-     * Creates a system that represents the Nintendo
-     * Switch (Switch).
-     *
-     * @returns
-     *        This instance.
-     */
-    static switch(): IZRomulatorSystem;
-    /**
-     * Creates a system from an id slug.
-     *
-     * @param id -
-     *        The id slug of the system to create.
-     *
-     * @return
-     *        The system, or null if the id is not known.
-     */
-    static from(id: string): IZRomulatorSystem | null;
-}