@zthun/romulator-api 1.8.0 → 1.10.0

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

@@ -1,7 +1,7 @@
-import { IZRomulatorFilesService } from './files-service.mjs';
+import { IZRomulatorFilesRepository } from './files-repository.mjs';
 export declare class ZRomulatorFilesModule {
     private readonly _files;
-    constructor(_files: IZRomulatorFilesService);
+    constructor(_files: IZRomulatorFilesRepository);
     onModuleInit(): Promise<void>;
     onModuleDestroy(): Promise<void>;
 }

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

@@ -0,0 +1,82 @@
+import { IZFileRepository, IZFileSystemNode, IZFileSystemService } from '@zthun/crumbtrail-fs';
+import { ZRomulatorSystemId } from '@zthun/romulator-client';
+import { IZRomulatorConfigsService } from '../config/configs-service.mjs';
+export declare const ZRomulatorFilesToken: unique symbol;
+/**
+ * Represents the repository that you can use to
+ * scan the games folder for media, info, games, and systems.
+ */
+export interface IZRomulatorFilesRepository {
+    /**
+     * 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 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 system folders found in the games folder.
+     */
+    systems(): Promise<IZFileSystemNode[]>;
+    /**
+     * Retrieves a single system found in the games folder.
+     *
+     * @param id -
+     *        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(id: ZRomulatorSystemId): Promise<IZFileSystemNode | null>;
+    /**
+     * Retrieves the file that represents the systems info or games info
+     * for a given system.
+     *
+     * @param id -
+     *        Which info item you want to receive - the root system information
+     *        or the information for a given game list for an individual system.
+     *
+     * @returns
+     *        The node that represents the info json, or null if no such file
+     *        exists.
+     */
+    info(id: "systems" | ZRomulatorSystemId): Promise<IZFileSystemNode | null>;
+    /**
+     * Initializes the file repository.
+     */
+    init(): Promise<any>;
+    /**
+     * Cleans up internal resources.
+     */
+    dispose(): Promise<void>;
+}
+export declare class ZRomulatorFilesRepository implements IZRomulatorFilesRepository {
+    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;
+    dispose(): Promise<void>;
+    init(): Promise<IZFileRepository>;
+    media(): Promise<IZFileSystemNode[]>;
+    info(id?: "systems" | ZRomulatorSystemId): Promise<IZFileSystemNode | null>;
+    systems(): Promise<IZFileSystemNode[]>;
+    systems(id: ZRomulatorSystemId): Promise<IZFileSystemNode | null>;
+}

package/dist/files/files-system-json-repository.d.mts

@@ -0,0 +1,28 @@
+import { IZLogger } from '@zthun/lumberjacky-log';
+import { ZRomulatorSystemId } from '@zthun/romulator-client';
+import { IZRomulatorFilesRepository } from './files-repository.mjs';
+export declare const ZRomulatorFilesSystemsJsonRepositoryToken: unique symbol;
+/**
+ * A repository responsible for reading systems.json from the games info directory.
+ */
+export interface IZRomulatorFilesSystemsJsonRepository {
+    /**
+     * Reads all system entries in the systems.json file and returns a mapping.
+     *
+     * @returns
+     *        A mapping of system ids to system entries.  Any corrupted entries
+     *        or entries that are not supported will be excluded from this map.
+     */
+    systems(): Promise<Map<ZRomulatorSystemId, unknown>>;
+}
+export declare class ZRomulatorFilesSystemsJsonRepository implements IZRomulatorFilesSystemsJsonRepository {
+    private _files;
+    private _logger;
+    private _stream;
+    /**
+     * Initializes a new instance of this object.
+     */
+    constructor(_files: IZRomulatorFilesRepository, logger: IZLogger);
+    private _read;
+    systems(): Promise<Map<ZRomulatorSystemId, unknown>>;
+}