@zthun/romulator-api 1.7.1 → 1.8.0

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

@@ -71,6 +71,16 @@ export interface IZRomulatorFilesService {
      *        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.
      */
@@ -87,6 +97,7 @@ export declare class ZRomulatorFilesService implements IZRomulatorFilesService {
     private static readonly InfoFolderName;
     private _repository;
     private _folderStream;
+    private _fileStream;
     private _globs;
     private _systems;
     constructor(_configs: IZRomulatorConfigsService, _fileSystem: IZFileSystemService);
@@ -103,4 +114,7 @@ export declare class ZRomulatorFilesService implements IZRomulatorFilesService {
     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/games/games-service.d.mts

@@ -1,5 +1,5 @@
 import { IZFileSystemService } from '@zthun/crumbtrail-fs';
-import { IZDataRequest, IZPage } from '@zthun/helpful-query';
+import { IZDataMatch, IZDataRequest, IZPage } from '@zthun/helpful-query';
 import { IZLogger } from '@zthun/lumberjacky-log';
 import { IZRomulatorGame } from '@zthun/romulator-client';
 import { IZRestfulGet } from '@zthun/webigail-rest';
@@ -8,11 +8,12 @@ export declare const ZRomulatorGamesToken: unique symbol;
 export interface IZRomulatorGamesService extends IZRestfulGet<IZRomulatorGame> {
     list(req: IZDataRequest): Promise<IZPage<IZRomulatorGame>>;
 }
-export declare class ZRomulatorGamesService implements IZRomulatorGamesService {
+export declare class ZRomulatorGamesService implements IZRomulatorGamesService, IZDataMatch<IZRomulatorGame, string> {
     private readonly _file;
     private readonly _config;
     private readonly _logger;
     constructor(_file: IZFileSystemService, _config: IZRomulatorConfigsService, logger: IZLogger);
     list(req: IZDataRequest): Promise<IZPage<IZRomulatorGame>>;
     get(id: string): Promise<IZRomulatorGame>;
+    match(data: IZRomulatorGame, filter: string): boolean;
 }

package/dist/main.cjs

@@ -322,7 +322,7 @@ const KnownSystem = "@zthunworks/romulator/known-system";
    *        A {@link ZRomulatorSystemBuilder} instance that has
    *        built the nes.
    */ static nes() {
-        return new romulatorClient.ZRomulatorSystemBuilder().id(romulatorClient.ZRomulatorSystemId.Nintendo).console().name("Nintendo Entertainment System").generation(3).build();
+        return new romulatorClient.ZRomulatorSystemBuilder().id(romulatorClient.ZRomulatorSystemId.Nintendo).name("Nintendo Entertainment System").build();
     }
     /**
    * Creates a system that represents the Super
@@ -331,7 +331,7 @@ const KnownSystem = "@zthunworks/romulator/known-system";
    * @returns
    *        This instance.
    */ static snes() {
-        return new romulatorClient.ZRomulatorSystemBuilder().id(romulatorClient.ZRomulatorSystemId.SuperNintendo).console().name("Super Nintendo Entertainment System").generation(4).build();
+        return new romulatorClient.ZRomulatorSystemBuilder().id(romulatorClient.ZRomulatorSystemId.SuperNintendo).name("Super Nintendo Entertainment System").build();
     }
     /**
    * Creates a system that represents the Nintendo
@@ -340,7 +340,7 @@ const KnownSystem = "@zthunworks/romulator/known-system";
    * @returns
    *        This instance.
    */ static n64() {
-        return new romulatorClient.ZRomulatorSystemBuilder().id(romulatorClient.ZRomulatorSystemId.Nintendo64).console().name("Nintendo 64").generation(5).build();
+        return new romulatorClient.ZRomulatorSystemBuilder().id(romulatorClient.ZRomulatorSystemId.Nintendo64).name("Nintendo 64").build();
     }
     /**
    * Creates a system that represents the Nintendo
@@ -349,7 +349,7 @@ const KnownSystem = "@zthunworks/romulator/known-system";
    * @returns
    *        This instance.
    */ static gc() {
-        return new romulatorClient.ZRomulatorSystemBuilder().id(romulatorClient.ZRomulatorSystemId.GameCube).console().name("Nintendo GameCube").generation(6).build();
+        return new romulatorClient.ZRomulatorSystemBuilder().id(romulatorClient.ZRomulatorSystemId.GameCube).name("Nintendo GameCube").build();
     }
     /**
    * Creates a system that represents the Nintendo
@@ -358,7 +358,7 @@ const KnownSystem = "@zthunworks/romulator/known-system";
    * @returns
    *        This instance.
    */ static wii() {
-        return new romulatorClient.ZRomulatorSystemBuilder().id(romulatorClient.ZRomulatorSystemId.Wii).console().name("Nintendo Wii").generation(7).build();
+        return new romulatorClient.ZRomulatorSystemBuilder().id(romulatorClient.ZRomulatorSystemId.Wii).name("Nintendo Wii").build();
     }
     /**
    * Creates a system that represents the Nintendo
@@ -367,7 +367,7 @@ const KnownSystem = "@zthunworks/romulator/known-system";
    * @returns
    *        This instance.
    */ static wiiu() {
-        return new romulatorClient.ZRomulatorSystemBuilder().id(romulatorClient.ZRomulatorSystemId.WiiU).console().name("Nintendo Wii U").generation(8).build();
+        return new romulatorClient.ZRomulatorSystemBuilder().id(romulatorClient.ZRomulatorSystemId.WiiU).name("Nintendo Wii U").build();
     }
     /**
    * Creates a system that represents the Nintendo
@@ -376,7 +376,7 @@ const KnownSystem = "@zthunworks/romulator/known-system";
    * @returns
    *        This instance.
    */ static switch() {
-        return new romulatorClient.ZRomulatorSystemBuilder().id(romulatorClient.ZRomulatorSystemId.Switch).console().name("Nintendo Switch").generation(9).build();
+        return new romulatorClient.ZRomulatorSystemBuilder().id(romulatorClient.ZRomulatorSystemId.Switch).name("Nintendo Switch").build();
     }
     /**
    * Creates a system from an id slug.
@@ -436,26 +436,6 @@ _ts_decorate$c([
     _ts_metadata$8("design:returntype", void 0)
 ], ZRomulatorSystemKnown, "switch", null);
 
-/**
- * A data match function which matches a string (search) filter
- * to a game's name, system slug, or system name.
- */ class ZRomulatorDataMatchGame {
-    match(data, filter) {
-        const needle = filter?.trim().toLowerCase();
-        const { name = "", system = "" } = data;
-        const target = ZRomulatorSystemKnown.from(system);
-        const systemName = helpfulFn.firstTruthy("", target?.name);
-        if (!needle?.length) {
-            return true;
-        }
-        return [
-            name,
-            system,
-            systemName
-        ].filter((s)=>s.length).some((k)=>k.toLowerCase().includes(needle));
-    }
-}
-
 function _ts_decorate$b(decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -504,7 +484,7 @@ class ZRomulatorGamesService {
             const id = `${dir}-${lodashEs.kebabCase(file)}`;
             return new romulatorClient.ZRomulatorGameBuilder().id(id).system(dir).file(path).name(file).build();
         });
-        const options = new helpfulQuery.ZDataSourceStaticOptionsBuilder().search(new ZRomulatorDataMatchGame()).build();
+        const options = new helpfulQuery.ZDataSourceStaticOptionsBuilder().search(this).build();
         const source = new helpfulQuery.ZDataSourceStatic(games, options);
         const $sort = new helpfulQuery.ZSortBuilder().sorts(helpfulFn.firstDefined([], req.sort)).ascending("system").ascending("name").build();
         const $request = new helpfulQuery.ZDataRequestBuilder().copy(req).sort($sort).build();
@@ -520,6 +500,20 @@ class ZRomulatorGamesService {
         }
         return match;
     }
+    match(data, filter) {
+        const needle = filter?.trim().toLowerCase();
+        const { name = "", system = "" } = data;
+        const target = ZRomulatorSystemKnown.from(system);
+        const systemName = helpfulFn.firstTruthy("", target?.name);
+        if (!needle?.length) {
+            return true;
+        }
+        return [
+            name,
+            system,
+            systemName
+        ].filter((s)=>s.length).some((k)=>k.toLowerCase().includes(needle));
+    }
 }
 ZRomulatorGamesService = _ts_decorate$b([
     common.Injectable(),
@@ -636,6 +630,7 @@ class ZRomulatorFilesService {
     static InfoFolderName = ".info";
     _repository = new crumbtrailFs.ZFileRepository();
     _folderStream = new crumbtrailFs.ZStreamFolder();
+    _fileStream = new crumbtrailFs.ZStreamFile();
     _globs;
     _systems;
     constructor(_configs, _fileSystem){
@@ -664,14 +659,17 @@ class ZRomulatorFilesService {
         const gamesFolder = await this.gamesFolder();
         return node_path.resolve(gamesFolder, ZRomulatorFilesService.InfoFolderName);
     }
-    async contents(root, path) {
+    async contents(roots, path) {
         const repository = await this.seed();
-        const prefix = lodashEs.trimEnd(root, "/");
-        const folder = `${prefix}${node_path.sep}`;
-        let filter = new helpfulQuery.ZFilterBinaryBuilder().subject("path");
-        filter = path == null ? filter.startsWith().value(folder) : filter.equal().value(node_path.resolve(folder, path));
+        const folders = lodashEs.castArray(roots).map((root)=>`${lodashEs.trimEnd(root, "/")}/`);
+        const byPaths = folders.map((folder)=>{
+            const byPath = new helpfulQuery.ZFilterBinaryBuilder().subject("path");
+            const pathFilter = path == null ? byPath.startsWith().value(folder) : byPath.equal().value(node_path.resolve(folder, path));
+            return pathFilter.build();
+        });
+        const filter = byPaths.length > 1 ? new helpfulQuery.ZFilterLogicBuilder().or().clauses(byPaths).build() : lodashEs.first(byPaths);
         const sort = new helpfulQuery.ZSortBuilder().ascending("path").build();
-        const request = new helpfulQuery.ZDataRequestBuilder().filter(filter.build()).sort(sort).build();
+        const request = new helpfulQuery.ZDataRequestBuilder().filter(filter).sort(sort).build();
         const nodes = await repository.retrieve(request);
         return path == null ? nodes : helpfulFn.firstDefined(null, lodashEs.first(nodes));
     }
@@ -703,13 +701,21 @@ class ZRomulatorFilesService {
         const games = await this.gamesFolder();
         const folders = path == null ? this._systems.map((s)=>`${s}/`) : node_path.resolve(games, path);
         const items = await this._fileSystem.search(folders, {
-            cwd: games
+            cwd: games,
+            stat: false
         });
         return path == null ? items : helpfulFn.firstDefined(null, lodashEs.first(items));
     }
     async info(path) {
         return this.contents(await this.infoFolder(), path);
     }
+    async games(path) {
+        const root = await this.gamesFolder();
+        return this.contents(this._systems.map((s)=>node_path.resolve(root, s)), path);
+    }
+    read(node) {
+        return this._fileStream.read(node.path);
+    }
 }
 ZRomulatorFilesService = _ts_decorate$8([
     common.Injectable(),
@@ -1066,11 +1072,6 @@ class ZRomulatorSystemsService {
     _files;
     logger;
     _logger;
-    _fileStream = new crumbtrailFs.ZStreamFile({
-        cache: {
-            maxFiles: Object.keys(romulatorClient.ZRomulatorSystemId).length + 1
-        }
-    });
     constructor(_files, logger){
         this._files = _files;
         this.logger = logger;
@@ -1117,7 +1118,7 @@ class ZRomulatorSystemsService {
             return system.build();
         }
         try {
-            const contents = await this._fileStream.read(info.path);
+            const contents = await this._files.read(info);
             const json = JSON.parse(contents.toString());
             return system.assign(json).redact().build();
         } catch (e) {