@zthun/romulator-api 1.3.4 → 1.4.0

package/dist/main.js

@@ -3,36 +3,36 @@ import { ApiProperty, ApiParam, ApiBody, ApiResponse, DocumentBuilder, SwaggerMo
 import { InternalServerErrorException, NotFoundException, Injectable, Inject, Get, Query, Patch, UsePipes, ValidationPipe, Param, Body, Controller, Module, NotAcceptableException, StreamableFile, ForbiddenException, Req, Delete } from '@nestjs/common';
 import { ZFileSystemModule, ZFileSystemToken } from '@zthun/crumbtrail-nest';
 import { ZLoggerToken, ZLoggerModule } from '@zthun/lumberjacky-nest';
-import { ZDataSourceStaticOptionsBuilder, ZDataSearchFields, ZDataSourceStatic, ZPageBuilder, ZDataRequestBuilder } from '@zthun/helpful-query';
+import { ZDataSourceStaticOptionsBuilder, ZDataSearchFields, ZDataSourceStatic, ZPageBuilder, ZDataRequestBuilder, ZSortBuilder } from '@zthun/helpful-query';
 import { IsDefined, IsObject, IsNotEmptyObject } from 'class-validator';
-import { firstDefined, createError, detokenize, firstTruthy } from '@zthun/helpful-fn';
+import { firstDefined, createError, firstTruthy, detokenize } from '@zthun/helpful-fn';
 import { ZLoggerContext, ZLogEntryBuilder } from '@zthun/lumberjacky-log';
-import { ZRomulatorConfigBuilder, ZRomulatorConfigId as ZRomulatorConfigId$1, ZRomulatorConfigGamesMetadata, ZRomulatorConfigMediaMetadata, ZRomulatorSystemBuilder, ZRomulatorSystemId, ZRomulatorConfigMediaBuilder, ZRomulatorMediaBuilder } from '@zthun/romulator-client';
-import { find, findIndex } from 'lodash-es';
+import { ZRomulatorConfigBuilder, ZRomulatorConfigId as ZRomulatorConfigId$1, ZRomulatorConfigGamesMetadata, ZRomulatorConfigMediaMetadata, ZRomulatorSystemBuilder, ZRomulatorSystemId, ZRomulatorConfigGamesBuilder, ZRomulatorGameBuilder, ZRomulatorConfigMediaBuilder, ZRomulatorMediaBuilder } from '@zthun/romulator-client';
+import { find, kebabCase, findIndex } from 'lodash-es';
 import { readFile, mkdir, writeFile, unlink } from 'node:fs/promises';
-import { resolve, dirname, basename } from 'node:path';
+import { resolve, dirname, basename, parse } from 'node:path';
 import { homedir } from 'node:os';
+import { isTagged, ZTag } from '@zthun/helpful-reflection';
+import 'reflect-metadata';
 import { ZHttpCodeSuccess, ZHttpCodeClient } from '@zthun/webigail-http';
 import { ZMimeTypeApplication } from '@zthun/webigail-url';
 import { lookup } from 'mime-types';
 import { createReadStream } from 'node:fs';
 import { env } from 'node:process';
-import { isTagged, ZTag } from '@zthun/helpful-reflection';
-import 'reflect-metadata';
 
-function _ts_decorate$b(decorators, target, key, desc) {
+function _ts_decorate$e(decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc, d;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
     else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
-function _ts_metadata$7(k, v) {
+function _ts_metadata$9(k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 }
 class ZRomulatorConfigUpdateDto {
     contents;
 }
-_ts_decorate$b([
+_ts_decorate$e([
     ApiProperty({
         type: "object",
         properties: {}
@@ -44,7 +44,7 @@ _ts_decorate$b([
         message: "The contents of the config must be an object "
     }),
     IsNotEmptyObject(),
-    _ts_metadata$7("design:type", typeof T === "undefined" ? Object : T)
+    _ts_metadata$9("design:type", typeof T === "undefined" ? Object : T)
 ], ZRomulatorConfigUpdateDto.prototype, "contents", void 0);
 
 class ZDir {
@@ -75,16 +75,16 @@ class ZRomulatorConfigKnown {
     }
 }
 
-function _ts_decorate$a(decorators, target, key, desc) {
+function _ts_decorate$d(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);
     else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
-function _ts_metadata$6(k, v) {
+function _ts_metadata$8(k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 }
-function _ts_param$5(paramIndex, decorator) {
+function _ts_param$7(paramIndex, decorator) {
     return function(target, key) {
         decorator(target, key, paramIndex);
     };
@@ -166,25 +166,25 @@ class ZRomulatorConfigsService {
         return config;
     }
 }
-ZRomulatorConfigsService = _ts_decorate$a([
+ZRomulatorConfigsService = _ts_decorate$d([
     Injectable(),
-    _ts_param$5(0, Inject(ZLoggerToken)),
-    _ts_metadata$6("design:type", Function),
-    _ts_metadata$6("design:paramtypes", [
+    _ts_param$7(0, Inject(ZLoggerToken)),
+    _ts_metadata$8("design:type", Function),
+    _ts_metadata$8("design:paramtypes", [
         typeof IZLogger === "undefined" ? Object : IZLogger
     ])
 ], ZRomulatorConfigsService);
 
-function _ts_decorate$9(decorators, target, key, desc) {
+function _ts_decorate$c(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);
     else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
-function _ts_metadata$5(k, v) {
+function _ts_metadata$7(k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 }
-function _ts_param$4(paramIndex, decorator) {
+function _ts_param$6(paramIndex, decorator) {
     return function(target, key) {
         decorator(target, key, paramIndex);
     };
@@ -205,16 +205,16 @@ class ZRomulatorConfigsController {
         return await this._configs.get(identification);
     }
 }
-_ts_decorate$9([
+_ts_decorate$c([
     Get(),
-    _ts_param$4(0, Query()),
-    _ts_metadata$5("design:type", Function),
-    _ts_metadata$5("design:paramtypes", [
+    _ts_param$6(0, Query()),
+    _ts_metadata$7("design:type", Function),
+    _ts_metadata$7("design:paramtypes", [
         typeof IZDataRequestQuery === "undefined" ? Object : IZDataRequestQuery
     ]),
-    _ts_metadata$5("design:returntype", Promise)
+    _ts_metadata$7("design:returntype", Promise)
 ], ZRomulatorConfigsController.prototype, "list", null);
-_ts_decorate$9([
+_ts_decorate$c([
     ApiParam({
         type: "string",
         name: "identification",
@@ -231,39 +231,39 @@ _ts_decorate$9([
         skipNullProperties: false,
         skipUndefinedProperties: false
     })),
-    _ts_param$4(0, Param("identification")),
-    _ts_param$4(1, Body()),
-    _ts_metadata$5("design:type", Function),
-    _ts_metadata$5("design:paramtypes", [
+    _ts_param$6(0, Param("identification")),
+    _ts_param$6(1, Body()),
+    _ts_metadata$7("design:type", Function),
+    _ts_metadata$7("design:paramtypes", [
         typeof ZRomulatorConfigId === "undefined" ? Object : ZRomulatorConfigId,
         typeof ZRomulatorConfigUpdateDto === "undefined" ? Object : ZRomulatorConfigUpdateDto
     ]),
-    _ts_metadata$5("design:returntype", Promise)
+    _ts_metadata$7("design:returntype", Promise)
 ], ZRomulatorConfigsController.prototype, "update", null);
-_ts_decorate$9([
+_ts_decorate$c([
     ApiParam({
         type: "string",
         name: "identification",
         description: "The id of the config"
     }),
     Get(":identification"),
-    _ts_param$4(0, Param("identification")),
-    _ts_metadata$5("design:type", Function),
-    _ts_metadata$5("design:paramtypes", [
+    _ts_param$6(0, Param("identification")),
+    _ts_metadata$7("design:type", Function),
+    _ts_metadata$7("design:paramtypes", [
         typeof ZRomulatorConfigId === "undefined" ? Object : ZRomulatorConfigId
     ]),
-    _ts_metadata$5("design:returntype", Promise)
+    _ts_metadata$7("design:returntype", Promise)
 ], ZRomulatorConfigsController.prototype, "get", null);
-ZRomulatorConfigsController = _ts_decorate$9([
+ZRomulatorConfigsController = _ts_decorate$c([
     Controller("configs"),
-    _ts_param$4(0, Inject(ZRomulatorConfigsToken)),
-    _ts_metadata$5("design:type", Function),
-    _ts_metadata$5("design:paramtypes", [
+    _ts_param$6(0, Inject(ZRomulatorConfigsToken)),
+    _ts_metadata$7("design:type", Function),
+    _ts_metadata$7("design:paramtypes", [
         typeof IZRomulatorConfigsService === "undefined" ? Object : IZRomulatorConfigsService
     ])
 ], ZRomulatorConfigsController);
 
-function _ts_decorate$8(decorators, target, key, desc) {
+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);
     else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
@@ -271,7 +271,7 @@ function _ts_decorate$8(decorators, target, key, desc) {
 }
 class ZRomulatorConfigsModule {
 }
-ZRomulatorConfigsModule = _ts_decorate$8([
+ZRomulatorConfigsModule = _ts_decorate$b([
     Module({
         imports: [
             ZFileSystemModule,
@@ -292,13 +292,13 @@ ZRomulatorConfigsModule = _ts_decorate$8([
     })
 ], ZRomulatorConfigsModule);
 
-function _ts_decorate$7(decorators, target, key, desc) {
+function _ts_decorate$a(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);
     else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
-function _ts_metadata$4(k, v) {
+function _ts_metadata$6(k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 }
 const KnownSystem = "@zthunworks/romulator/known-system";
@@ -394,48 +394,225 @@ const KnownSystem = "@zthunworks/romulator/known-system";
         return null;
     }
 }
-_ts_decorate$7([
+_ts_decorate$a([
     ZTag(KnownSystem),
-    _ts_metadata$4("design:type", Function),
-    _ts_metadata$4("design:paramtypes", []),
-    _ts_metadata$4("design:returntype", void 0)
+    _ts_metadata$6("design:type", Function),
+    _ts_metadata$6("design:paramtypes", []),
+    _ts_metadata$6("design:returntype", void 0)
 ], ZRomulatorSystemKnown, "nes", null);
-_ts_decorate$7([
+_ts_decorate$a([
     ZTag(KnownSystem),
-    _ts_metadata$4("design:type", Function),
-    _ts_metadata$4("design:paramtypes", []),
-    _ts_metadata$4("design:returntype", void 0)
+    _ts_metadata$6("design:type", Function),
+    _ts_metadata$6("design:paramtypes", []),
+    _ts_metadata$6("design:returntype", void 0)
 ], ZRomulatorSystemKnown, "snes", null);
-_ts_decorate$7([
+_ts_decorate$a([
     ZTag(KnownSystem),
-    _ts_metadata$4("design:type", Function),
-    _ts_metadata$4("design:paramtypes", []),
-    _ts_metadata$4("design:returntype", void 0)
+    _ts_metadata$6("design:type", Function),
+    _ts_metadata$6("design:paramtypes", []),
+    _ts_metadata$6("design:returntype", void 0)
 ], ZRomulatorSystemKnown, "n64", null);
-_ts_decorate$7([
+_ts_decorate$a([
     ZTag(KnownSystem),
-    _ts_metadata$4("design:type", Function),
-    _ts_metadata$4("design:paramtypes", []),
-    _ts_metadata$4("design:returntype", void 0)
+    _ts_metadata$6("design:type", Function),
+    _ts_metadata$6("design:paramtypes", []),
+    _ts_metadata$6("design:returntype", void 0)
 ], ZRomulatorSystemKnown, "gc", null);
-_ts_decorate$7([
+_ts_decorate$a([
     ZTag(KnownSystem),
-    _ts_metadata$4("design:type", Function),
-    _ts_metadata$4("design:paramtypes", []),
-    _ts_metadata$4("design:returntype", void 0)
+    _ts_metadata$6("design:type", Function),
+    _ts_metadata$6("design:paramtypes", []),
+    _ts_metadata$6("design:returntype", void 0)
 ], ZRomulatorSystemKnown, "wii", null);
-_ts_decorate$7([
+_ts_decorate$a([
     ZTag(KnownSystem),
-    _ts_metadata$4("design:type", Function),
-    _ts_metadata$4("design:paramtypes", []),
-    _ts_metadata$4("design:returntype", void 0)
+    _ts_metadata$6("design:type", Function),
+    _ts_metadata$6("design:paramtypes", []),
+    _ts_metadata$6("design:returntype", void 0)
 ], ZRomulatorSystemKnown, "wiiu", null);
-_ts_decorate$7([
+_ts_decorate$a([
     ZTag(KnownSystem),
+    _ts_metadata$6("design:type", Function),
+    _ts_metadata$6("design:paramtypes", []),
+    _ts_metadata$6("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 = 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$9(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);
+    else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+function _ts_metadata$5(k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+function _ts_param$5(paramIndex, decorator) {
+    return function(target, key) {
+        decorator(target, key, paramIndex);
+    };
+}
+const ZRomulatorGamesToken = Symbol("romulator-games-service");
+class ZRomulatorGamesService {
+    _file;
+    _config;
+    _logger;
+    constructor(_file, _config, logger){
+        this._file = _file;
+        this._config = _config;
+        this._logger = new ZLoggerContext("ZRomulatorGamesService", logger);
+    }
+    async list(req) {
+        const config = ZRomulatorConfigKnown.games();
+        const { contents } = await this._config.get(config.id);
+        const { gamesFolder } = new ZRomulatorConfigGamesBuilder().copy(contents).build();
+        const { fallback } = ZRomulatorConfigGamesMetadata.gamesFolder();
+        const cwd = detokenize(firstDefined(fallback, gamesFolder), process.env);
+        const time = new Date();
+        let msg = `Searching for games in ${cwd}`;
+        this._logger.log(new ZLogEntryBuilder().info().message(msg).build());
+        const systems = ZRomulatorSystemKnown.all().map((system)=>system.id);
+        const glob = `{${systems.join(",")}}/**/*.zip`;
+        const nodes = await this._file.search(glob, {
+            cwd,
+            stat: false
+        });
+        const span = new Date().getTime() - time.getTime();
+        msg = `Found ${nodes.length} games. Search took ${span} milliseconds.`;
+        this._logger.log(new ZLogEntryBuilder().info().message(msg).build());
+        const games = nodes.map(({ path })=>{
+            const dir = basename(dirname(path));
+            const { name: file } = parse(path);
+            const id = `${dir}-${kebabCase(file)}`;
+            return new ZRomulatorGameBuilder().id(id).system(dir).file(path).name(file).build();
+        });
+        const options = new ZDataSourceStaticOptionsBuilder().search(new ZRomulatorDataMatchGame()).build();
+        const source = new ZDataSourceStatic(games, options);
+        const $sort = new ZSortBuilder().sorts(firstDefined([], req.sort)).ascending("system").ascending("name").build();
+        const $request = new ZDataRequestBuilder().copy(req).sort($sort).build();
+        const data = await source.retrieve($request);
+        return data;
+    }
+    async get(id) {
+        const games = await this.list(new ZDataRequestBuilder().build());
+        const match = games.find((game)=>game.id === id);
+        if (!match) {
+            throw new NotFoundException(`Unable to find game with id, ${id}.`);
+        }
+        return match;
+    }
+}
+ZRomulatorGamesService = _ts_decorate$9([
+    Injectable(),
+    _ts_param$5(0, Inject(ZFileSystemToken)),
+    _ts_param$5(1, Inject(ZRomulatorConfigsToken)),
+    _ts_param$5(2, Inject(ZLoggerToken)),
+    _ts_metadata$5("design:type", Function),
+    _ts_metadata$5("design:paramtypes", [
+        typeof IZFileSystemService === "undefined" ? Object : IZFileSystemService,
+        typeof IZRomulatorConfigsService === "undefined" ? Object : IZRomulatorConfigsService,
+        typeof IZLogger === "undefined" ? Object : IZLogger
+    ])
+], ZRomulatorGamesService);
+
+function _ts_decorate$8(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);
+    else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+function _ts_metadata$4(k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+function _ts_param$4(paramIndex, decorator) {
+    return function(target, key) {
+        decorator(target, key, paramIndex);
+    };
+}
+class ZRomulatorGamesController {
+    _games;
+    constructor(_games){
+        this._games = _games;
+    }
+    list(query) {
+        return this._games.list(new ZDataRequestBuilder().query(query).build());
+    }
+    get(identification) {
+        return this._games.get(identification);
+    }
+}
+_ts_decorate$8([
+    Get(),
+    _ts_param$4(0, Query()),
     _ts_metadata$4("design:type", Function),
-    _ts_metadata$4("design:paramtypes", []),
+    _ts_metadata$4("design:paramtypes", [
+        typeof IZDataRequestQuery === "undefined" ? Object : IZDataRequestQuery
+    ]),
+    _ts_metadata$4("design:returntype", typeof Promise === "undefined" ? Object : Promise)
+], ZRomulatorGamesController.prototype, "list", null);
+_ts_decorate$8([
+    Get(":identification"),
+    _ts_param$4(0, Param("identification")),
+    _ts_metadata$4("design:type", Function),
+    _ts_metadata$4("design:paramtypes", [
+        String
+    ]),
     _ts_metadata$4("design:returntype", void 0)
-], ZRomulatorSystemKnown, "switch", null);
+], ZRomulatorGamesController.prototype, "get", null);
+ZRomulatorGamesController = _ts_decorate$8([
+    Controller("games"),
+    _ts_param$4(0, Inject(ZRomulatorGamesToken)),
+    _ts_metadata$4("design:type", Function),
+    _ts_metadata$4("design:paramtypes", [
+        typeof IZRomulatorGamesService === "undefined" ? Object : IZRomulatorGamesService
+    ])
+], ZRomulatorGamesController);
+
+function _ts_decorate$7(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);
+    else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+class ZRomulatorGamesModule {
+}
+ZRomulatorGamesModule = _ts_decorate$7([
+    Module({
+        imports: [
+            ZRomulatorConfigsModule,
+            ZFileSystemModule,
+            ZLoggerModule
+        ],
+        controllers: [
+            ZRomulatorGamesController
+        ],
+        providers: [
+            {
+                provide: ZRomulatorGamesToken,
+                useClass: ZRomulatorGamesService
+            }
+        ]
+    })
+], ZRomulatorGamesModule);
 
 function _ts_decorate$6(decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
@@ -868,7 +1045,8 @@ ZRomulatorModule = _ts_decorate([
         imports: [
             ZRomulatorSystemsModule,
             ZRomulatorConfigsModule,
-            ZRomulatorMediaModule
+            ZRomulatorMediaModule,
+            ZRomulatorGamesModule
         ]
     })
 ], ZRomulatorModule);