retold-remote 0.0.26 → 0.0.27

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "retold-remote",
-    "version": "0.0.26",
+    "version": "0.0.27",
     "description": "Retold Remote - NAS media browser with gallery views and keyboard navigation",
     "main": "source/Pict-RetoldRemote-Bundle.js",
     "bin": {
@@ -29,6 +29,58 @@
         "docs": "npx quack prepare-docs ./docs -d ./modules",
         "docs-serve": "npx quack docs-serve ./docs"
     },
+    "retoldBeacon": {
+        "displayName": "Retold Remote",
+        "description": "NAS media browser with gallery views and keyboard navigation; serves a content folder over HTTP and registers as a beacon.",
+        "category": "content",
+        "mode": "standalone-service",
+        "bin": "source/cli/RetoldRemote-CLI-Run.js",
+        "argTemplate": [
+            "serve",
+            {
+                "fromLabPath": "ContentPath"
+            },
+            "-p",
+            {
+                "fromLabPath": "Port"
+            },
+            "-u",
+            {
+                "fromLabPath": "UltravisorURL"
+            }
+        ],
+        "healthCheck": {
+            "path": "/"
+        },
+        "defaultPort": 7777,
+        "requiresUltravisor": true,
+        "configForm": {
+            "Fields": [
+                {
+                    "Name": "HostContentPath",
+                    "Label": "Host folder to serve",
+                    "Type": "text",
+                    "Required": true,
+                    "Help": "Absolute path on the host whose contents will be served; bind-mounted read-only into the container at /app/content."
+                }
+            ]
+        },
+        "docker": {
+            "image": "retold-remote",
+            "dockerfile": "retold-remote.Dockerfile",
+            "dataMountPath": "/app/data",
+            "configMountPath": "/app/data/config.json",
+            "contentMountPath": "/app/content",
+            "exposedPort": 7777,
+            "configMounts": [
+                {
+                    "ConfigField": "HostContentPath",
+                    "Target": "/app/content",
+                    "ReadOnly": true
+                }
+            ]
+        }
+    },
     "author": "steven velozo <steven@velozo.com>",
     "license": "MIT",
     "dependencies": {

package/source/cli/RetoldRemote-Server-Setup.js

@@ -212,10 +212,25 @@ function setupRetoldRemoteServer(pOptions, fCallback)
 			});
 
 			// Set up the large-image preview and DZI tile service
-			let tmpImageService = new libRetoldRemoteImageService(tmpFable,
+			let tmpImageServiceOptions = { ContentPath: tmpContentPath };
+			let tmpDirectMaxBytes = null;
+			if (typeof pOptions.DirectDisplayMaxFileSize === 'number' && pOptions.DirectDisplayMaxFileSize >= 0)
 			{
-				ContentPath: tmpContentPath
-			});
+				tmpDirectMaxBytes = pOptions.DirectDisplayMaxFileSize;
+			}
+			else if (process.env.RETOLD_DIRECT_IMAGE_MAX_BYTES)
+			{
+				let tmpParsed = parseInt(process.env.RETOLD_DIRECT_IMAGE_MAX_BYTES, 10);
+				if (!isNaN(tmpParsed) && tmpParsed >= 0)
+				{
+					tmpDirectMaxBytes = tmpParsed;
+				}
+			}
+			if (tmpDirectMaxBytes !== null)
+			{
+				tmpImageServiceOptions.DirectDisplayMaxFileSize = tmpDirectMaxBytes;
+			}
+			let tmpImageService = new libRetoldRemoteImageService(tmpFable, tmpImageServiceOptions);
 
 			// Set up the subimage region service
 			let tmpSubimageService = new libRetoldRemoteSubimageService(tmpFable,
@@ -1957,6 +1972,26 @@ function setupRetoldRemoteServer(pOptions, fCallback)
 									return fNext();
 								}
 
+								// Always surface the original file size (the manifest's FileSize
+								// field gets overwritten with the generated preview's size when
+								// NeedsPreview=true). The client uses OrigFileSize against
+								// DirectDisplayMaxFileSize to decide whether to bypass the
+								// OpenSeadragon explorer / downscaled preview and load the
+								// source image directly.
+								if (pResult && typeof pResult === 'object')
+								{
+									try
+									{
+										let tmpStat = libFs.statSync(tmpAbsPath);
+										pResult.OrigFileSize = tmpStat.size;
+									}
+									catch (pStatError)
+									{
+										// Non-fatal — client will fall through to existing logic
+									}
+									pResult.DirectDisplayMaxFileSize = tmpImageService.options.DirectDisplayMaxFileSize;
+								}
+
 								pResponse.send(pResult);
 								return fNext();
 							});

package/source/cli/commands/RetoldRemote-Command-Serve.js

@@ -35,6 +35,9 @@ class RetoldRemoteCommandServe extends libCommandLineCommand
 		this.options.CommandOptions.push(
 			{ Name: '-l, --logfile [path]', Description: 'Write logs to a file (auto-generates timestamped name if path omitted).', Default: '' });
 
+		this.options.CommandOptions.push(
+			{ Name: '--direct-image-max-mb [mb]', Description: 'Max original-file size (MB) to display an image directly instead of via OpenSeadragon. Set to 0 to always use the explorer. Default 15.', Default: '' });
+
 		this.addCommand();
 	}
 
@@ -127,16 +130,29 @@ class RetoldRemoteCommandServe extends libCommandLineCommand
 		{
 			let tmpSetupServer = require('../RetoldRemote-Server-Setup.js');
 
-			tmpSetupServer(
+			let tmpSetupOptions =
+			{
+				ContentPath: tmpContentPath,
+				DistPath: tmpDistPath,
+				Port: tmpPort,
+				HashedFilenames: tmpHashedFilenames,
+				CacheRoot: tmpCacheRoot,
+				CacheServer: tmpCacheServer,
+				UltravisorURL: tmpUltravisorURL
+			};
+
+			let tmpDirectMaxMB = this.CommandOptions.directImageMaxMb;
+			if (typeof tmpDirectMaxMB === 'string' && tmpDirectMaxMB.length > 0)
+			{
+				let tmpMB = parseFloat(tmpDirectMaxMB);
+				if (!isNaN(tmpMB) && tmpMB >= 0)
 				{
-					ContentPath: tmpContentPath,
-					DistPath: tmpDistPath,
-					Port: tmpPort,
-					HashedFilenames: tmpHashedFilenames,
-					CacheRoot: tmpCacheRoot,
-					CacheServer: tmpCacheServer,
-					UltravisorURL: tmpUltravisorURL
-				},
+					tmpSetupOptions.DirectDisplayMaxFileSize = Math.round(tmpMB * 1024 * 1024);
+				}
+			}
+
+			tmpSetupServer(
+				tmpSetupOptions,
 				function (pError, pServerInfo)
 				{
 					if (pError)

package/source/server/RetoldRemote-ImageService.js

@@ -49,7 +49,12 @@ const _DefaultServiceConfiguration =
 	"DziQuality": 80,
 	"PreviewQuality": 85,
 	// Only generate preview/tiles for images larger than this (pixels on longest side)
-	"LargeImageThreshold": 4096
+	"LargeImageThreshold": 4096,
+	// Original-file-size (bytes) at or below which the viewer will load the
+	// image directly instead of routing through the OpenSeadragon explorer or
+	// server-side downscaled preview. Raw camera formats always go through the
+	// preview pipeline regardless of size (browsers can't decode raw). 15 MiB.
+	"DirectDisplayMaxFileSize": 15 * 1024 * 1024
 };
 
 class RetoldRemoteImageService extends libFableServiceProviderBase

package/source/views/PictView-Remote-MediaViewer.js

@@ -470,6 +470,7 @@ class RetoldRemoteMediaViewerView extends libPictView
 
 	/**
 	 * Probe image dimensions, then decide how to display it:
+	 *   - File ≤ DirectDisplayMaxFileSize (default 15 MiB, non-raw): direct content URL
 	 *   - ≤4096px: load direct content URL in the normal viewer
 	 *   - 4096–8192px: load a server preview in the normal viewer, show Explore button
 	 *   - >8192px: auto-launch the OpenSeadragon image explorer
@@ -495,6 +496,20 @@ class RetoldRemoteMediaViewerView extends libPictView
 					return;
 				}
 
+				// Small-file short-circuit: if the original is within the configured
+				// direct-display budget and the browser can decode it natively,
+				// skip both the server preview and the OpenSeadragon explorer.
+				// Raw camera formats always go through the preview pipeline.
+				if (!pResult.IsRawFormat
+					&& typeof pResult.OrigFileSize === 'number'
+					&& typeof pResult.DirectDisplayMaxFileSize === 'number'
+					&& pResult.DirectDisplayMaxFileSize > 0
+					&& pResult.OrigFileSize <= pResult.DirectDisplayMaxFileSize)
+				{
+					tmpSelf._insertImageTag(pContentURL, pFileName, false);
+					return;
+				}
+
 				let tmpLongest = Math.max(pResult.OrigWidth || 0, pResult.OrigHeight || 0);
 
 				// >8192px: auto-launch the OpenSeadragon image explorer

package/web-application/retold-remote.js

@@ -16128,6 +16128,7 @@ let tmpLastTap=0;let tmpOnTouchEnd=function(pEvent){let tmpNow=Date.now();if(tmp
 	 * Build a lightweight placeholder while probing image dimensions.
 	 */_buildImagePlaceholderHTML(pFileName){let tmpEscapedName=this.pict.providers['RetoldRemote-FormattingUtilities'].escapeHTML(pFileName);return'<div id="RetoldRemote-ImagePlaceholder" style="display:flex;align-items:center;justify-content:center;height:100%;color:var(--retold-text-dim);font-size:0.85rem;">'+'Loading '+tmpEscapedName+'\u2026</div>';}/**
 	 * Probe image dimensions, then decide how to display it:
+	 *   - File ≤ DirectDisplayMaxFileSize (default 15 MiB, non-raw): direct content URL
 	 *   - ≤4096px: load direct content URL in the normal viewer
 	 *   - 4096–8192px: load a server preview in the normal viewer, show Explore button
 	 *   - >8192px: auto-launch the OpenSeadragon image explorer
@@ -16136,7 +16137,11 @@ let tmpLastTap=0;let tmpOnTouchEnd=function(pEvent){let tmpNow=Date.now();if(tmp
 	 * @param {string} pContentURL - Direct content URL (fallback)
 	 * @param {string} pFileName   - Display name
 	 */_probeAndShowImage(pFilePath,pContentURL,pFileName){let tmpSelf=this;let tmpProvider=this.pict.providers['RetoldRemote-Provider'];let tmpPathParam=tmpProvider?tmpProvider._getPathParam(pFilePath):encodeURIComponent(pFilePath);fetch('/api/media/image-preview?path='+tmpPathParam).then(pResponse=>pResponse.json()).then(pResult=>{// If the probe failed or sharp isn't available, fall back to direct load
-if(!pResult||!pResult.Success){tmpSelf._insertImageTag(pContentURL,pFileName,false);return;}let tmpLongest=Math.max(pResult.OrigWidth||0,pResult.OrigHeight||0);// >8192px: auto-launch the OpenSeadragon image explorer
+if(!pResult||!pResult.Success){tmpSelf._insertImageTag(pContentURL,pFileName,false);return;}// Small-file short-circuit: if the original is within the configured
+// direct-display budget and the browser can decode it natively,
+// skip both the server preview and the OpenSeadragon explorer.
+// Raw camera formats always go through the preview pipeline.
+if(!pResult.IsRawFormat&&typeof pResult.OrigFileSize==='number'&&typeof pResult.DirectDisplayMaxFileSize==='number'&&pResult.DirectDisplayMaxFileSize>0&&pResult.OrigFileSize<=pResult.DirectDisplayMaxFileSize){tmpSelf._insertImageTag(pContentURL,pFileName,false);return;}let tmpLongest=Math.max(pResult.OrigWidth||0,pResult.OrigHeight||0);// >8192px: auto-launch the OpenSeadragon image explorer
 if(tmpLongest>8192){let tmpIEX=tmpSelf.pict.views['RetoldRemote-ImageExplorer'];if(tmpIEX){tmpIEX.showExplorer(pFilePath);return;}// Fall through if explorer view isn't available
 }// 4096–8192px: use the server preview
 if(pResult.NeedsPreview&&pResult.CacheKey){let tmpPreviewURL='/api/media/image-preview-file/'+encodeURIComponent(pResult.CacheKey)+'/'+encodeURIComponent(pResult.OutputFilename);tmpSelf._insertImageTag(tmpPreviewURL,pFileName,true,pResult.OrigWidth,pResult.OrigHeight);return;}// ≤4096px: load the direct content URL