@zthun/romulator-api 1.8.0 → 1.9.0

package/dist/main.js

@@ -5,7 +5,7 @@ import { ZFileSystemModule, ZFileSystemToken } from '@zthun/crumbtrail-nest';
 import { ZLoggerToken, ZLoggerModule } from '@zthun/lumberjacky-nest';
 import { ZDataSourceStaticOptionsBuilder, ZDataSearchFields, ZDataSourceStatic, ZPageBuilder, ZDataRequestBuilder, ZSortBuilder, ZFilterBinaryBuilder, ZFilterLogicBuilder } from '@zthun/helpful-query';
 import { IsDefined, IsObject, IsNotEmptyObject } from 'class-validator';
-import { firstDefined, createError, detokenize, firstTruthy } from '@zthun/helpful-fn';
+import { firstDefined, createError, detokenize, firstTruthy, html } from '@zthun/helpful-fn';
 import { ZLoggerContext, ZLogEntryBuilder } from '@zthun/lumberjacky-log';
 import { ZRomulatorConfigBuilder, ZRomulatorConfigId as ZRomulatorConfigId$1, ZRomulatorConfigGamesMetadata, ZRomulatorSystemBuilder, ZRomulatorSystemId, ZRomulatorConfigGamesBuilder, ZRomulatorGameBuilder, ZRomulatorMediaBuilder, isSystemId } from '@zthun/romulator-client';
 import { find, kebabCase, castArray, trimEnd, first, findIndex } from 'lodash-es';
@@ -17,11 +17,12 @@ import 'reflect-metadata';
 import { ZFileRepository, ZStreamFolder, ZStreamFile } from '@zthun/crumbtrail-fs';
 import { env } from 'node:process';
 import { ZHttpCodeSuccess, ZHttpCodeClient } from '@zthun/webigail-http';
-import { ZMimeTypeApplication } from '@zthun/webigail-url';
+import { ZMimeTypeImage } from '@zthun/webigail-url';
 import { lookup } from 'mime-types';
 import { createReadStream } from 'node:fs';
+import { Readable } from 'node:stream';
 
-function _ts_decorate$g(decorators, target, key, desc) {
+function _ts_decorate$h(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;
@@ -33,7 +34,7 @@ function _ts_metadata$b(k, v) {
 class ZRomulatorConfigUpdateDto {
     contents;
 }
-_ts_decorate$g([
+_ts_decorate$h([
     ApiProperty({
         type: "object",
         properties: {}
@@ -72,7 +73,7 @@ class ZRomulatorConfigKnown {
     }
 }
 
-function _ts_decorate$f(decorators, target, key, desc) {
+function _ts_decorate$g(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;
@@ -163,7 +164,7 @@ class ZRomulatorConfigsService {
         return config;
     }
 }
-ZRomulatorConfigsService = _ts_decorate$f([
+ZRomulatorConfigsService = _ts_decorate$g([
     Injectable(),
     _ts_param$9(0, Inject(ZLoggerToken)),
     _ts_metadata$a("design:type", Function),
@@ -172,7 +173,7 @@ ZRomulatorConfigsService = _ts_decorate$f([
     ])
 ], ZRomulatorConfigsService);
 
-function _ts_decorate$e(decorators, target, key, desc) {
+function _ts_decorate$f(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;
@@ -202,7 +203,7 @@ class ZRomulatorConfigsController {
         return await this._configs.get(identification);
     }
 }
-_ts_decorate$e([
+_ts_decorate$f([
     Get(),
     _ts_param$8(0, Query()),
     _ts_metadata$9("design:type", Function),
@@ -211,7 +212,7 @@ _ts_decorate$e([
     ]),
     _ts_metadata$9("design:returntype", Promise)
 ], ZRomulatorConfigsController.prototype, "list", null);
-_ts_decorate$e([
+_ts_decorate$f([
     ApiParam({
         type: "string",
         name: "identification",
@@ -237,7 +238,7 @@ _ts_decorate$e([
     ]),
     _ts_metadata$9("design:returntype", Promise)
 ], ZRomulatorConfigsController.prototype, "update", null);
-_ts_decorate$e([
+_ts_decorate$f([
     ApiParam({
         type: "string",
         name: "identification",
@@ -251,7 +252,7 @@ _ts_decorate$e([
     ]),
     _ts_metadata$9("design:returntype", Promise)
 ], ZRomulatorConfigsController.prototype, "get", null);
-ZRomulatorConfigsController = _ts_decorate$e([
+ZRomulatorConfigsController = _ts_decorate$f([
     Controller("configs"),
     _ts_param$8(0, Inject(ZRomulatorConfigsToken)),
     _ts_metadata$9("design:type", Function),
@@ -260,7 +261,7 @@ ZRomulatorConfigsController = _ts_decorate$e([
     ])
 ], ZRomulatorConfigsController);
 
-function _ts_decorate$d(decorators, target, key, desc) {
+function _ts_decorate$e(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;
@@ -268,7 +269,7 @@ function _ts_decorate$d(decorators, target, key, desc) {
 }
 class ZRomulatorConfigsModule {
 }
-ZRomulatorConfigsModule = _ts_decorate$d([
+ZRomulatorConfigsModule = _ts_decorate$e([
     Module({
         imports: [
             ZFileSystemModule,
@@ -289,7 +290,7 @@ ZRomulatorConfigsModule = _ts_decorate$d([
     })
 ], ZRomulatorConfigsModule);
 
-function _ts_decorate$c(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;
@@ -391,50 +392,50 @@ const KnownSystem = "@zthunworks/romulator/known-system";
         return null;
     }
 }
-_ts_decorate$c([
+_ts_decorate$d([
     ZTag(KnownSystem),
     _ts_metadata$8("design:type", Function),
     _ts_metadata$8("design:paramtypes", []),
     _ts_metadata$8("design:returntype", void 0)
 ], ZRomulatorSystemKnown, "nes", null);
-_ts_decorate$c([
+_ts_decorate$d([
     ZTag(KnownSystem),
     _ts_metadata$8("design:type", Function),
     _ts_metadata$8("design:paramtypes", []),
     _ts_metadata$8("design:returntype", void 0)
 ], ZRomulatorSystemKnown, "snes", null);
-_ts_decorate$c([
+_ts_decorate$d([
     ZTag(KnownSystem),
     _ts_metadata$8("design:type", Function),
     _ts_metadata$8("design:paramtypes", []),
     _ts_metadata$8("design:returntype", void 0)
 ], ZRomulatorSystemKnown, "n64", null);
-_ts_decorate$c([
+_ts_decorate$d([
     ZTag(KnownSystem),
     _ts_metadata$8("design:type", Function),
     _ts_metadata$8("design:paramtypes", []),
     _ts_metadata$8("design:returntype", void 0)
 ], ZRomulatorSystemKnown, "gc", null);
-_ts_decorate$c([
+_ts_decorate$d([
     ZTag(KnownSystem),
     _ts_metadata$8("design:type", Function),
     _ts_metadata$8("design:paramtypes", []),
     _ts_metadata$8("design:returntype", void 0)
 ], ZRomulatorSystemKnown, "wii", null);
-_ts_decorate$c([
+_ts_decorate$d([
     ZTag(KnownSystem),
     _ts_metadata$8("design:type", Function),
     _ts_metadata$8("design:paramtypes", []),
     _ts_metadata$8("design:returntype", void 0)
 ], ZRomulatorSystemKnown, "wiiu", null);
-_ts_decorate$c([
+_ts_decorate$d([
     ZTag(KnownSystem),
     _ts_metadata$8("design:type", Function),
     _ts_metadata$8("design:paramtypes", []),
     _ts_metadata$8("design:returntype", void 0)
 ], ZRomulatorSystemKnown, "switch", null);
 
-function _ts_decorate$b(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;
@@ -513,7 +514,7 @@ class ZRomulatorGamesService {
         ].filter((s)=>s.length).some((k)=>k.toLowerCase().includes(needle));
     }
 }
-ZRomulatorGamesService = _ts_decorate$b([
+ZRomulatorGamesService = _ts_decorate$c([
     Injectable(),
     _ts_param$7(0, Inject(ZFileSystemToken)),
     _ts_param$7(1, Inject(ZRomulatorConfigsToken)),
@@ -526,7 +527,7 @@ ZRomulatorGamesService = _ts_decorate$b([
     ])
 ], ZRomulatorGamesService);
 
-function _ts_decorate$a(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;
@@ -552,7 +553,7 @@ class ZRomulatorGamesController {
         return this._games.get(identification);
     }
 }
-_ts_decorate$a([
+_ts_decorate$b([
     Get(),
     _ts_param$6(0, Query()),
     _ts_metadata$6("design:type", Function),
@@ -561,7 +562,7 @@ _ts_decorate$a([
     ]),
     _ts_metadata$6("design:returntype", typeof Promise === "undefined" ? Object : Promise)
 ], ZRomulatorGamesController.prototype, "list", null);
-_ts_decorate$a([
+_ts_decorate$b([
     Get(":identification"),
     _ts_param$6(0, Param("identification")),
     _ts_metadata$6("design:type", Function),
@@ -570,7 +571,7 @@ _ts_decorate$a([
     ]),
     _ts_metadata$6("design:returntype", void 0)
 ], ZRomulatorGamesController.prototype, "get", null);
-ZRomulatorGamesController = _ts_decorate$a([
+ZRomulatorGamesController = _ts_decorate$b([
     Controller("games"),
     _ts_param$6(0, Inject(ZRomulatorGamesToken)),
     _ts_metadata$6("design:type", Function),
@@ -579,7 +580,7 @@ ZRomulatorGamesController = _ts_decorate$a([
     ])
 ], ZRomulatorGamesController);
 
-function _ts_decorate$9(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;
@@ -587,7 +588,7 @@ function _ts_decorate$9(decorators, target, key, desc) {
 }
 class ZRomulatorGamesModule {
 }
-ZRomulatorGamesModule = _ts_decorate$9([
+ZRomulatorGamesModule = _ts_decorate$a([
     Module({
         imports: [
             ZRomulatorConfigsModule,
@@ -606,7 +607,7 @@ ZRomulatorGamesModule = _ts_decorate$9([
     })
 ], ZRomulatorGamesModule);
 
-function _ts_decorate$8(decorators, target, key, desc) {
+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;
@@ -715,7 +716,7 @@ class ZRomulatorFilesService {
         return this._fileStream.read(node.path);
     }
 }
-ZRomulatorFilesService = _ts_decorate$8([
+ZRomulatorFilesService = _ts_decorate$9([
     Injectable(),
     _ts_param$5(0, Inject(ZRomulatorConfigsToken)),
     _ts_param$5(1, Inject(ZFileSystemToken)),
@@ -726,7 +727,7 @@ ZRomulatorFilesService = _ts_decorate$8([
     ])
 ], ZRomulatorFilesService);
 
-function _ts_decorate$7(decorators, target, key, desc) {
+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;
@@ -752,7 +753,7 @@ class ZRomulatorFilesModule {
         await this._files.dispose();
     }
 }
-ZRomulatorFilesModule = _ts_decorate$7([
+ZRomulatorFilesModule = _ts_decorate$8([
     Module({
         imports: [
             ZFileSystemModule,
@@ -775,6 +776,52 @@ ZRomulatorFilesModule = _ts_decorate$7([
     ])
 ], ZRomulatorFilesModule);
 
+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;
+}
+/**
+ * The injection token for the media generator.
+ */ const ZRomulatorMediaGeneratorToken = Symbol("media-generator");
+class ZRomulatorMediaGenerator {
+    generate(name) {
+        const width = 373;
+        const height = 187;
+        const fallbackName = name?.trim().length ? name.trim() : "?";
+        const uppercaseName = fallbackName.toUpperCase();
+        const escapedName = this.escapeSvgText(uppercaseName);
+        const svg = html`
+      <svg
+        xmlns="http://www.w3.org/2000/svg"
+        width="${width}"
+        height="${height}"
+        viewBox="0 0 ${width} ${height}"
+      >
+        <text
+          x="50%"
+          y="50%"
+          fill="#fff"
+          font-size="48"
+          text-anchor="middle"
+          textLength="${width}"
+          lengthAdjust="spacingAndGlyphs"
+        >
+          ${escapedName}
+        </text>
+      </svg>
+    `;
+        return Promise.resolve(Buffer.from(svg));
+    }
+    escapeSvgText(value) {
+        return value.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&apos;");
+    }
+}
+ZRomulatorMediaGenerator = _ts_decorate$7([
+    Injectable()
+], ZRomulatorMediaGenerator);
+
 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;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -791,9 +838,11 @@ function _ts_param$3(paramIndex, decorator) {
 }
 const ZRomulatorMediaToken = Symbol("romulator-media-service");
 class ZRomulatorMediaService {
+    _generator;
     _files;
     _logger;
-    constructor(_files, logger){
+    constructor(_generator, _files, logger){
+        this._generator = _generator;
         this._files = _files;
         this._logger = new ZLoggerContext("ZRomulatorMediaService", logger);
     }
@@ -815,31 +864,34 @@ class ZRomulatorMediaService {
         const count = await source.count(req);
         return new ZPageBuilder().data(page).count(count).build();
     }
+    async query(id) {
+        const mediaList = await this.findAllMedia();
+        const index = findIndex(mediaList, (m)=>m.id === id);
+        return firstDefined(null, mediaList[index]);
+    }
     async get(id) {
         const time = new Date();
         let log = `Searching for media with id ${id}.`;
         this._logger.log(new ZLogEntryBuilder().info().message(log).build());
-        const mediaList = await this.findAllMedia();
-        const index = findIndex(mediaList, (m)=>m.id === id);
+        const media = await this.query(id);
         const span = new Date().getTime() - time.getTime();
-        if (index < 0) {
+        if (media == null) {
             const msg = `Could not find any media with id, ${id}.`;
             log = `${msg} Search took ${span} milliseconds`;
             this._logger.log(new ZLogEntryBuilder().warning().message(log).build());
             throw new NotFoundException(msg);
         }
-        const media = mediaList[index];
         log = `Found media, ${media.url} after ${span} milliseconds`;
         this._logger.log(new ZLogEntryBuilder().info().message(log).build());
         return media;
     }
     async download(id, accept) {
-        let log = `Download request received for ${id}`;
+        const log = `Download request received for ${id}`;
         this._logger.log(new ZLogEntryBuilder().info().message(log).build());
-        const fallback = ZMimeTypeApplication.OctetStream;
-        const { fileName, url } = await this.get(id);
-        const lookupResult = lookup(firstDefined("", fileName));
-        const mime = firstTruthy(fallback, lookupResult);
+        const media = await this.query(id);
+        const url = firstDefined("", media?.url);
+        const fileName = firstDefined("", media?.fileName);
+        const mime = firstTruthy(ZMimeTypeImage.SVG, lookup(fileName));
         const accepts = accept.split(",").map((h)=>h.split(";")[0].trim());
         const acceptable = accepts.some((a)=>{
             if (a === "*/*") {
@@ -855,9 +907,20 @@ class ZRomulatorMediaService {
             this._logger.log(new ZLogEntryBuilder().error().message(msg).build());
             throw new NotAcceptableException(msg);
         }
-        log = `Streaming ${url}`;
-        this._logger.log(new ZLogEntryBuilder().info().message(log).build());
-        return new StreamableFile(createReadStream(firstDefined("", url)), {
+        const generate = async ()=>{
+            // Note that this isn't perfect and is just a fallback to a wheel + marquee for now.
+            // When we get to retrieving other media besides wheels, we will generate
+            // everything, but for now, this will be fine enough.
+            const log = `Media, ${id}, does not exist.  Generating one`;
+            this._logger.log(new ZLogEntryBuilder().warning().message(log).build());
+            const parts = id.split("-");
+            parts.pop();
+            const name = parts.join(" ");
+            const buffer = await this._generator.generate(name);
+            return Readable.from(buffer);
+        };
+        const stream = media == null ? await generate() : createReadStream(url);
+        return new StreamableFile(stream, {
             type: mime,
             disposition: `inline; filename=${fileName}`
         });
@@ -880,10 +943,12 @@ class ZRomulatorMediaService {
 }
 ZRomulatorMediaService = _ts_decorate$6([
     Injectable(),
-    _ts_param$3(0, Inject(ZRomulatorFilesToken)),
-    _ts_param$3(1, Inject(ZLoggerToken)),
+    _ts_param$3(0, Inject(ZRomulatorMediaGeneratorToken)),
+    _ts_param$3(1, Inject(ZRomulatorFilesToken)),
+    _ts_param$3(2, Inject(ZLoggerToken)),
     _ts_metadata$3("design:type", Function),
     _ts_metadata$3("design:paramtypes", [
+        typeof IZRomulatorMediaGenerator === "undefined" ? Object : IZRomulatorMediaGenerator,
         typeof IZRomulatorFilesService === "undefined" ? Object : IZRomulatorFilesService,
         typeof IZLogger === "undefined" ? Object : IZLogger
     ])
@@ -1043,6 +1108,10 @@ ZRomulatorMediaModule = _ts_decorate$4([
             ZRomulatorMediaController
         ],
         providers: [
+            {
+                provide: ZRomulatorMediaGeneratorToken,
+                useClass: ZRomulatorMediaGenerator
+            },
             {
                 provide: ZRomulatorMediaToken,
                 useClass: ZRomulatorMediaService