@zthun/romulator-api 1.5.0 → 1.7.0

package/dist/config/config-known.d.mts

@@ -2,5 +2,4 @@ export declare abstract class ZRomulatorConfigKnown {
     static all(): import('@zthun/romulator-client').IZRomulatorConfig<any>[];
     private static create;
     static games(): import('@zthun/romulator-client').IZRomulatorConfig<any>;
-    static media(): import('@zthun/romulator-client').IZRomulatorConfig<any>;
 }

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

@@ -0,0 +1,2 @@
+export declare class ZRomulatorFilesModule {
+}

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

@@ -0,0 +1,96 @@
+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>;
+}
+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 _globs;
+    private _systems;
+    constructor(_configs: IZRomulatorConfigsService, _fileSystem: IZFileSystemService);
+    private gamesFolder;
+    private mediaFolder;
+    private infoFolder;
+    private contents;
+    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>;
+}