@zthun/romulator-api 1.8.0 → 1.9.0

package/dist/main.cjs

@@ -22,8 +22,9 @@ const webigailHttp = require('@zthun/webigail-http');
 const webigailUrl = require('@zthun/webigail-url');
 const mimeTypes = require('mime-types');
 const node_fs = require('node:fs');
+const node_stream = require('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;
@@ -35,7 +36,7 @@ function _ts_metadata$b(k, v) {
 class ZRomulatorConfigUpdateDto {
     contents;
 }
-_ts_decorate$g([
+_ts_decorate$h([
     swagger.ApiProperty({
         type: "object",
         properties: {}
@@ -74,7 +75,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;
@@ -165,7 +166,7 @@ class ZRomulatorConfigsService {
         return config;
     }
 }
-ZRomulatorConfigsService = _ts_decorate$f([
+ZRomulatorConfigsService = _ts_decorate$g([
     common.Injectable(),
     _ts_param$9(0, common.Inject(lumberjackyNest.ZLoggerToken)),
     _ts_metadata$a("design:type", Function),
@@ -174,7 +175,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;
@@ -204,7 +205,7 @@ class ZRomulatorConfigsController {
         return await this._configs.get(identification);
     }
 }
-_ts_decorate$e([
+_ts_decorate$f([
     common.Get(),
     _ts_param$8(0, common.Query()),
     _ts_metadata$9("design:type", Function),
@@ -213,7 +214,7 @@ _ts_decorate$e([
     ]),
     _ts_metadata$9("design:returntype", Promise)
 ], ZRomulatorConfigsController.prototype, "list", null);
-_ts_decorate$e([
+_ts_decorate$f([
     swagger.ApiParam({
         type: "string",
         name: "identification",
@@ -239,7 +240,7 @@ _ts_decorate$e([
     ]),
     _ts_metadata$9("design:returntype", Promise)
 ], ZRomulatorConfigsController.prototype, "update", null);
-_ts_decorate$e([
+_ts_decorate$f([
     swagger.ApiParam({
         type: "string",
         name: "identification",
@@ -253,7 +254,7 @@ _ts_decorate$e([
     ]),
     _ts_metadata$9("design:returntype", Promise)
 ], ZRomulatorConfigsController.prototype, "get", null);
-ZRomulatorConfigsController = _ts_decorate$e([
+ZRomulatorConfigsController = _ts_decorate$f([
     common.Controller("configs"),
     _ts_param$8(0, common.Inject(ZRomulatorConfigsToken)),
     _ts_metadata$9("design:type", Function),
@@ -262,7 +263,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;
@@ -270,7 +271,7 @@ function _ts_decorate$d(decorators, target, key, desc) {
 }
 class ZRomulatorConfigsModule {
 }
-ZRomulatorConfigsModule = _ts_decorate$d([
+ZRomulatorConfigsModule = _ts_decorate$e([
     common.Module({
         imports: [
             crumbtrailNest.ZFileSystemModule,
@@ -291,7 +292,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;
@@ -393,50 +394,50 @@ const KnownSystem = "@zthunworks/romulator/known-system";
         return null;
     }
 }
-_ts_decorate$c([
+_ts_decorate$d([
     helpfulReflection.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([
     helpfulReflection.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([
     helpfulReflection.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([
     helpfulReflection.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([
     helpfulReflection.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([
     helpfulReflection.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([
     helpfulReflection.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;
@@ -515,7 +516,7 @@ class ZRomulatorGamesService {
         ].filter((s)=>s.length).some((k)=>k.toLowerCase().includes(needle));
     }
 }
-ZRomulatorGamesService = _ts_decorate$b([
+ZRomulatorGamesService = _ts_decorate$c([
     common.Injectable(),
     _ts_param$7(0, common.Inject(crumbtrailNest.ZFileSystemToken)),
     _ts_param$7(1, common.Inject(ZRomulatorConfigsToken)),
@@ -528,7 +529,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;
@@ -554,7 +555,7 @@ class ZRomulatorGamesController {
         return this._games.get(identification);
     }
 }
-_ts_decorate$a([
+_ts_decorate$b([
     common.Get(),
     _ts_param$6(0, common.Query()),
     _ts_metadata$6("design:type", Function),
@@ -563,7 +564,7 @@ _ts_decorate$a([
     ]),
     _ts_metadata$6("design:returntype", typeof Promise === "undefined" ? Object : Promise)
 ], ZRomulatorGamesController.prototype, "list", null);
-_ts_decorate$a([
+_ts_decorate$b([
     common.Get(":identification"),
     _ts_param$6(0, common.Param("identification")),
     _ts_metadata$6("design:type", Function),
@@ -572,7 +573,7 @@ _ts_decorate$a([
     ]),
     _ts_metadata$6("design:returntype", void 0)
 ], ZRomulatorGamesController.prototype, "get", null);
-ZRomulatorGamesController = _ts_decorate$a([
+ZRomulatorGamesController = _ts_decorate$b([
     common.Controller("games"),
     _ts_param$6(0, common.Inject(ZRomulatorGamesToken)),
     _ts_metadata$6("design:type", Function),
@@ -581,7 +582,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;
@@ -589,7 +590,7 @@ function _ts_decorate$9(decorators, target, key, desc) {
 }
 class ZRomulatorGamesModule {
 }
-ZRomulatorGamesModule = _ts_decorate$9([
+ZRomulatorGamesModule = _ts_decorate$a([
     common.Module({
         imports: [
             ZRomulatorConfigsModule,
@@ -608,7 +609,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;
@@ -717,7 +718,7 @@ class ZRomulatorFilesService {
         return this._fileStream.read(node.path);
     }
 }
-ZRomulatorFilesService = _ts_decorate$8([
+ZRomulatorFilesService = _ts_decorate$9([
     common.Injectable(),
     _ts_param$5(0, common.Inject(ZRomulatorConfigsToken)),
     _ts_param$5(1, common.Inject(crumbtrailNest.ZFileSystemToken)),
@@ -728,7 +729,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;
@@ -754,7 +755,7 @@ class ZRomulatorFilesModule {
         await this._files.dispose();
     }
 }
-ZRomulatorFilesModule = _ts_decorate$7([
+ZRomulatorFilesModule = _ts_decorate$8([
     common.Module({
         imports: [
             crumbtrailNest.ZFileSystemModule,
@@ -777,6 +778,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 = helpfulFn.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([
+    common.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);
@@ -793,9 +840,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 lumberjackyLog.ZLoggerContext("ZRomulatorMediaService", logger);
     }
@@ -817,31 +866,34 @@ class ZRomulatorMediaService {
         const count = await source.count(req);
         return new helpfulQuery.ZPageBuilder().data(page).count(count).build();
     }
+    async query(id) {
+        const mediaList = await this.findAllMedia();
+        const index = lodashEs.findIndex(mediaList, (m)=>m.id === id);
+        return helpfulFn.firstDefined(null, mediaList[index]);
+    }
     async get(id) {
         const time = new Date();
         let log = `Searching for media with id ${id}.`;
         this._logger.log(new lumberjackyLog.ZLogEntryBuilder().info().message(log).build());
-        const mediaList = await this.findAllMedia();
-        const index = lodashEs.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 lumberjackyLog.ZLogEntryBuilder().warning().message(log).build());
             throw new common.NotFoundException(msg);
         }
-        const media = mediaList[index];
         log = `Found media, ${media.url} after ${span} milliseconds`;
         this._logger.log(new lumberjackyLog.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 lumberjackyLog.ZLogEntryBuilder().info().message(log).build());
-        const fallback = webigailUrl.ZMimeTypeApplication.OctetStream;
-        const { fileName, url } = await this.get(id);
-        const lookupResult = mimeTypes.lookup(helpfulFn.firstDefined("", fileName));
-        const mime = helpfulFn.firstTruthy(fallback, lookupResult);
+        const media = await this.query(id);
+        const url = helpfulFn.firstDefined("", media?.url);
+        const fileName = helpfulFn.firstDefined("", media?.fileName);
+        const mime = helpfulFn.firstTruthy(webigailUrl.ZMimeTypeImage.SVG, mimeTypes.lookup(fileName));
         const accepts = accept.split(",").map((h)=>h.split(";")[0].trim());
         const acceptable = accepts.some((a)=>{
             if (a === "*/*") {
@@ -857,9 +909,20 @@ class ZRomulatorMediaService {
             this._logger.log(new lumberjackyLog.ZLogEntryBuilder().error().message(msg).build());
             throw new common.NotAcceptableException(msg);
         }
-        log = `Streaming ${url}`;
-        this._logger.log(new lumberjackyLog.ZLogEntryBuilder().info().message(log).build());
-        return new common.StreamableFile(node_fs.createReadStream(helpfulFn.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 lumberjackyLog.ZLogEntryBuilder().warning().message(log).build());
+            const parts = id.split("-");
+            parts.pop();
+            const name = parts.join(" ");
+            const buffer = await this._generator.generate(name);
+            return node_stream.Readable.from(buffer);
+        };
+        const stream = media == null ? await generate() : node_fs.createReadStream(url);
+        return new common.StreamableFile(stream, {
             type: mime,
             disposition: `inline; filename=${fileName}`
         });
@@ -882,10 +945,12 @@ class ZRomulatorMediaService {
 }
 ZRomulatorMediaService = _ts_decorate$6([
     common.Injectable(),
-    _ts_param$3(0, common.Inject(ZRomulatorFilesToken)),
-    _ts_param$3(1, common.Inject(lumberjackyNest.ZLoggerToken)),
+    _ts_param$3(0, common.Inject(ZRomulatorMediaGeneratorToken)),
+    _ts_param$3(1, common.Inject(ZRomulatorFilesToken)),
+    _ts_param$3(2, common.Inject(lumberjackyNest.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
     ])
@@ -1045,6 +1110,10 @@ ZRomulatorMediaModule = _ts_decorate$4([
             ZRomulatorMediaController
         ],
         providers: [
+            {
+                provide: ZRomulatorMediaGeneratorToken,
+                useClass: ZRomulatorMediaGenerator
+            },
             {
                 provide: ZRomulatorMediaToken,
                 useClass: ZRomulatorMediaService