@zthun/romulator-api 1.9.0 → 1.11.0

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

@@ -0,0 +1,27 @@
+import { IZRomulatorGame } from '@zthun/romulator-client';
+import { IZRomulatorFilesRepository } from './files-repository.mjs';
+import { IZRomulatorFilesSystemsRepository } from './files-systems-repository.mjs';
+export declare const ZRomulatorFilesGamesRepositoryToken: unique symbol;
+/**
+ * A repository responsible for joining IZFileSystemNode objects
+ * with the contents of a game list json file.
+ */
+export interface IZRomulatorFilesGamesRepository {
+    /**
+     * Reads all of the games in the games directory.
+     *
+     * Game targets are determined by the extensions in system.json.
+     *
+     * @returns
+     *        A list of all the games that are in the games
+     *        directory decorated with the content data in the matching
+     *        system json file in the .info directory.
+     */
+    games(): Promise<Map<string, IZRomulatorGame>>;
+}
+export declare class ZRomulatorFilesGamesRepository implements IZRomulatorFilesGamesRepository {
+    private readonly _systemsRepository;
+    private readonly _filesRepository;
+    constructor(_systemsRepository: IZRomulatorFilesSystemsRepository, _filesRepository: IZRomulatorFilesRepository);
+    games(): Promise<Map<string, IZRomulatorGame>>;
+}

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,119 @@
+import { IZFileRepository, IZFileSystemNode, IZFileSystemService } from '@zthun/crumbtrail-fs';
+import { ZOptional } from '@zthun/helpful-fn';
+import { IZLogger } from '@zthun/lumberjacky-log';
+import { IZRomulatorSystem, ZRomulatorSystemId } from '@zthun/romulator-client';
+import { IZRomulatorConfigsService } from '../config/configs-service.mjs';
+export declare const ZRomulatorFilesRepositoryToken: unique symbol;
+/**
+ * Represents the repository that you can use to
+ * scan the games folder for media, info, games, and systems.
+ */
+export interface IZRomulatorFilesRepository {
+    /**
+     * The absolute path to the configured games
+     * folder.
+     *
+     * @returns
+     *        The absolute path to the games folder.
+     */
+    gamesFolder(): Promise<string>;
+    /**
+     * The path to the media folder.
+     *
+     * @returns
+     *        The path to the .media folder inside the
+     *        games folder.
+     */
+    mediaFolder(): Promise<string>;
+    /**
+     * The path to the info folder.
+     *
+     * @returns
+     *        The path to the .info folder inside the
+     *        games folder.
+     */
+    infoFolder(): Promise<string>;
+    /**
+     * 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 all games for the given systems list.
+     *
+     * @param systems -
+     *        The list of systems to query games by.
+     *
+     * @returns
+     *        A list of file system nodes that represent a game
+     *        in the system directory.
+     */
+    games(systems: IZRomulatorSystem[]): Promise<IZFileSystemNode[]>;
+    /**
+     * 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>;
+    /**
+     * Reads a file and returns the json representation.
+     *
+     * @param node -
+     *        The node to read.  If this is falsy, then null is returned.
+     *
+     * @returns
+     *        The file contents as json, or null if the contents cannot be read.
+     */
+    json(node: ZOptional<IZFileSystemNode>): Promise<unknown>;
+    /**
+     * 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;
+    readonly logger: IZLogger;
+    private static readonly MediaFolderName;
+    private static readonly InfoFolderName;
+    private _logger;
+    private _repository;
+    private _folderStream;
+    private _fileStream;
+    private _globs;
+    private _systems;
+    constructor(_configs: IZRomulatorConfigsService, _fileSystem: IZFileSystemService, logger: IZLogger);
+    gamesFolder(): Promise<string>;
+    mediaFolder(): Promise<string>;
+    infoFolder(): Promise<string>;
+    dispose(): Promise<void>;
+    init(): Promise<IZFileRepository>;
+    media(): Promise<IZFileSystemNode[]>;
+    info(id?: "systems" | ZRomulatorSystemId): Promise<IZFileSystemNode | null>;
+    json(node: IZFileSystemNode): Promise<unknown>;
+    systems(): Promise<IZFileSystemNode[]>;
+    games(systems: IZRomulatorSystem[]): Promise<IZFileSystemNode[]>;
+}

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

@@ -0,0 +1,27 @@
+import { IZRomulatorSystem, ZRomulatorSystemId } from '@zthun/romulator-client';
+import { IZRomulatorFilesRepository } from './files-repository.mjs';
+export declare const ZRomulatorFilesSystemsRepositoryToken: unique symbol;
+/**
+ * A repository responsible for joining IZFileSystemNode objects
+ * with the contents of system.json.
+ */
+export interface IZRomulatorFilesSystemsRepository {
+    /**
+     * Reads all system entries in the systems.json file and combines
+     * them with the existing system list in the games directory
+     *
+     * @returns
+     *        A list of all the systems that are in the games
+     *        directory decorated with the content data in systems.json
+     *        in the .info directory.
+     */
+    systems(): Promise<Map<ZRomulatorSystemId, IZRomulatorSystem>>;
+}
+export declare class ZRomulatorFilesSystemsRepository implements IZRomulatorFilesSystemsRepository {
+    private _filesRepository;
+    /**
+     * Initializes a new instance of this object.
+     */
+    constructor(_filesRepository: IZRomulatorFilesRepository);
+    systems(): Promise<Map<ZRomulatorSystemId, IZRomulatorSystem>>;
+}

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

@@ -1,19 +1,19 @@
-import { IZFileSystemService } from '@zthun/crumbtrail-fs';
-import { IZDataMatch, IZDataRequest, IZPage } from '@zthun/helpful-query';
+import { IZDataRequest, IZPage } from '@zthun/helpful-query';
 import { IZLogger } from '@zthun/lumberjacky-log';
 import { IZRomulatorGame } from '@zthun/romulator-client';
 import { IZRestfulGet } from '@zthun/webigail-rest';
-import { IZRomulatorConfigsService } from '../config/configs-service.mjs';
+import { IZRomulatorFilesGamesRepository } from '../files/files-games-repository.mjs';
+import { IZRomulatorFilesSystemsRepository } from '../files/files-systems-repository.mjs';
 export declare const ZRomulatorGamesToken: unique symbol;
 export interface IZRomulatorGamesService extends IZRestfulGet<IZRomulatorGame> {
     list(req: IZDataRequest): Promise<IZPage<IZRomulatorGame>>;
 }
-export declare class ZRomulatorGamesService implements IZRomulatorGamesService, IZDataMatch<IZRomulatorGame, string> {
-    private readonly _file;
-    private readonly _config;
+export declare class ZRomulatorGamesService implements IZRomulatorGamesService {
+    private readonly _systemsRepository;
+    private readonly _filesRepository;
+    readonly logger: IZLogger;
     private readonly _logger;
-    constructor(_file: IZFileSystemService, _config: IZRomulatorConfigsService, logger: IZLogger);
+    constructor(_systemsRepository: IZRomulatorFilesSystemsRepository, _filesRepository: IZRomulatorFilesGamesRepository, logger: IZLogger);
     list(req: IZDataRequest): Promise<IZPage<IZRomulatorGame>>;
     get(id: string): Promise<IZRomulatorGame>;
-    match(data: IZRomulatorGame, filter: string): boolean;
 }