jsmdcui 0.11.1 → 0.12.0

package/src/index.js

@@ -94,17 +94,17 @@ import { accessSync, closeSync, constants, existsSync, openSync, readSync, readd
 import { mkdir } from "node:fs/promises";
 import { dirname, basename, join, resolve, sep } from "node:path";
 import { fileURLToPath, pathToFileURL } from "node:url";
-import process from "node:process";
 import { toggleTaskCheckboxBeforeColumn, updateAnsiTaskCheckbox } from "./cui/task-checkbox.mjs";
 import { fenceEventMap, inlineFenceEventCode } from "./cui/fence-events.mjs";
 import { checkMarkdownIdCollisions, formatMarkdownIdCheckAnsi } from "./cui/id-collision.mjs";
 import { fitKittyImageToWidth, prepareKittyImages } from "./cui/kitty-images.mjs";
+import { kittyModeFromEnvironment } from "./cui/kitty-mode.mjs";
 import { logKittyPlacement } from "./cui/kitty-debug.mjs";
 import { Config } from "./config/config.js";
 import { defaultAllSettings, OPTION_CHOICES, LOCAL_SETTINGS } from "./config/defaults.js";
 import { cleanConfig } from "./config/clean.js";
 import { RuntimeRegistry, RTColorscheme, RTHelp } from "./runtime/registry.js";
-import { assetPath, hasInternalAssets, listInternalAssetDirs, listInternalAssetPaths, readInternalAssetText } from "./runtime/assets.js";
+import { assetPath, buildHtmlBundleImageMap, hasInternalAssets, listInternalAssetDirs, listInternalAssetPaths, readInternalAssetText } from "../single-exe/assetsHelper.js";
 //import { PluginManager } from "./plugins/manager.js";
 import { JsPluginManager, buildMicroGlobal, buildTuiBlockIndex, findTuiBlockInIndex, insertTuiTextareaNewline, mergeTuiTextareaBackward, mergeTuiTextareaForward, runAction, listActions } from "./plugins/js-bridge.js";
 import { Colorscheme } from "./config/colorscheme.js";
@@ -124,16 +124,25 @@ import { writeBackup, removeBackup, applyBackup } from "./buffer/backup.js";
 let kittyImageMode = "off";
 let allowRemoteKittyImages = false;
 const remoteMarkdownSources = new Map();
+let bundledImageMapPromise = null;
 import { isHex3Encoding, isMdcuiEncoding } from "./runtime/encodings.js";
 import { createInterface } from "node:readline/promises";
 
 import pkg from "../package.json" with { type: "json" };
 import { REPO_ROOT,IS_COMPILED, buildExecutable,buildEarlyExit,stringifyNonPrimitiveDefineValues } from "../single-exe/compiled.js";
+import { expandBuildMdAliases } from "./build-args.js";
 
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
+function getBundledImageMap() {
+  if (!IS_COMPILED || !global.MDCUI_MAIN) return null;
+  bundledImageMapPromise ??= import(global.MDCUI_MAIN + "-server.js")
+    .then((module) => buildHtmlBundleImageMap(module.homepage));
+  return bundledImageMapPromise;
+}
+
 
 if(!globalThis.Bun)
 {
@@ -379,6 +388,7 @@ async function renderMdcui(markdown, width = process.stdout.columns || 80, mdpat
     : await prepareKittyImages(tui, resolvedImageBasePath, width, {
       allowUrl: allowRemoteKittyImages,
       kittyMode: kittyImageMode,
+      getBundledImageMap,
     });
   return {
     rendered: prepared.rendered,
@@ -1118,7 +1128,7 @@ function parseArgs(argv) {
     cdpMaze: false,
     cdpPort: 0,
     cdpAddress: "",
-    kittyMode: "off",
+    kittyMode: kittyModeFromEnvironment(process.env.JSMDCUI_KITTY_MODE),
     settings: new Map(),
   };
   const files = [];
@@ -1268,6 +1278,9 @@ Modes:
     Display Markdown images with Kitty graphics and the jsgotty MIME extension
   --kitty-compat
     Display Markdown images with Kitty graphics without the non-standard MIME U field
+
+  JSMDCUI_KITTY_MODE=off|compat|extended
+    Set the Kitty image mode without command-line flags; explicit Kitty flags override it
       
   --edit
     Open files as editable UTF-8 text
@@ -1349,14 +1362,20 @@ Remote Markdown:
       Download HTTP(S) Markdown and, with Kitty mode, its HTTP(S) images; allow its code to run
 
 Experimental single-exe:
+  --build-md-exe <file.md> [BUN_ARGS...]
+      Build with <file.md> embedded as global.MDCUI_MAIN & exit
+  --build-md-for <platform> <file.md> [BUN_ARGS...]
+      Build for <platform> with <file.md> embedded & exit
+      
   --build-exe [BUN_ARGS...]
       Build a Bun single-file executable & exit
   --build-for <target> [BUN_ARGS...]
       Build a Bun single-file executable for target & exit
   
   [BUN_ARGS...]
-      --define MDCUI_XXX=1
-        More info in --readme
+      --define MDCUI_OVERWRITE_DEMO=1 
+      --define global.MDCUI_MAIN=myapp.md
+      More info in --readme
       https://bun.com/docs/bundler/executables
 `
   ].join("\n");
@@ -5024,7 +5043,7 @@ class App {
         const name = buf?.name ?? "No name";
         const filename = /^[^\s"'\\]+$/.test(name) ? name : JSON.stringify(name);
         this.openCommandMode(`save ${filename}`);
-        break;
+        break; //"
       }
       case "row":
         if (isTerm) {
@@ -8257,6 +8276,8 @@ function stringDefineFromArgv(argv, name) {
 async function main() {
   addCheckpoint("Argument Parsing");
 
+  expandBuildMdAliases(process.argv);
+  stringifyNonPrimitiveDefineValues(process.argv, "process.env.JSMDCUI_KITTY_MODE");
   stringifyNonPrimitiveDefineValues(process.argv, "global.MDCUI_MAIN");
   const argvMdcuiMain = stringDefineFromArgv(
     process.argv,

package/src/lua/engine.js

@@ -1,5 +1,5 @@
 import { existsSync } from "node:fs";
-import { readInternalAssetBytes } from "../runtime/assets.js";
+import { readInternalAssetBytes } from "../../single-exe/assetsHelper.js";
 import { join } from "node:path";
 import { tmpdir } from "node:os";
 import { REPO_ROOT } from "../../single-exe/compiled.js";

package/src/plugins/js-bridge.js

@@ -3,7 +3,7 @@ import { readdir } from "node:fs/promises";
 import { dirname, join, basename, extname } from "node:path";
 import { pathToFileURL } from "node:url";
 import { tmpdir } from "node:os";
-import { assetPath, hasInternalAssets, listInternalAssetDirs, listInternalAssetPaths, readInternalAssetBytes } from "../runtime/assets.js";
+import { assetPath, hasInternalAssets, listInternalAssetDirs, listInternalAssetPaths, readInternalAssetBytes } from "../../single-exe/assetsHelper.js";
 import { isMdcuiEncoding } from "../runtime/encodings.js";
 import { newMessage, newMessageAtLine, MTError, MTWarning, MTInfo } from "../buffer/message.js";
 import { Loc } from "../buffer/loc.js";

package/src/plugins/manager.js

@@ -4,7 +4,7 @@ import { basename, dirname, extname, join, sep } from "node:path";
 import { fetchHttp, downloadFile } from "../platform/commands.js";
 import { extractAndStrip } from "../platform/archive.js";
 import { createLuaEngine } from "../lua/engine.js";
-import { assetPath, hasInternalAssets, internalAssetSource, listInternalAssetDirs, listInternalAssetPaths, readInternalAssetText } from "../runtime/assets.js";
+import { assetPath, hasInternalAssets, internalAssetSource, listInternalAssetDirs, listInternalAssetPaths, readInternalAssetText } from "../../single-exe/assetsHelper.js";
 import { execCommand, runBackgroundShell, runCommand } from "../shell/shell.js";
 import { Loc } from "../buffer/loc.js";
 import { BTDefault, BTHelp, BTInfo, BTLog, BTRaw, BTScratch, byteOffset, BufferCore } from "../buffer/buffer.js";

package/src/runtime/registry.js

@@ -1,7 +1,7 @@
 import { existsSync } from "node:fs";
 import { readdir, readFile } from "node:fs/promises";
 import { basename, extname, join } from "node:path";
-import { assetPath, hasInternalAssets, listInternalAssetPaths, readInternalAssetBytes } from "./assets.js";
+import { assetPath, hasInternalAssets, listInternalAssetPaths, readInternalAssetBytes } from "../../single-exe/assetsHelper.js";
 
 export const RTColorscheme = 0;
 export const RTSyntax = 1;

package/tests/assets-helper.test.js

@@ -0,0 +1,116 @@
+import { expect, test } from "bun:test";
+import { mkdtemp, writeFile } from "node:fs/promises";
+import { join } from "node:path";
+import { tmpdir } from "node:os";
+import {
+  buildHtmlBundleImageMap,
+  canonicalHtmlBundleImageHref,
+  decodeHtmlAttribute,
+  findHtmlBundleAsset,
+  findHtmlBundleImageAsset,
+  htmlBundleImageAssetPath,
+} from "../single-exe/assetsHelper.js";
+
+const homepage = {
+  files: [
+    {
+      input: "../../images/pixel.png",
+      path: "/$bunfs/root/pixel-abc123.png",
+      loader: "file",
+      headers: { "content-type": "image/png" },
+    },
+    {
+      input: "scripts/app.js",
+      path: "/$bunfs/root/app-test.js",
+      loader: "file",
+      headers: { "content-type": "text/javascript" },
+    },
+  ],
+};
+
+test("HTML bundle asset lookup matches the compiled public asset path", () => {
+  expect(findHtmlBundleAsset(homepage, "/pixel-abc123.png"))
+    .toBe(homepage.files[0]);
+  expect(htmlBundleImageAssetPath(homepage, "/pixel-abc123.png?version=2"))
+    .toBe("/$bunfs/root/pixel-abc123.png");
+});
+
+test("HTML bundle image lookup rejects non-images and unavailable development bundles", () => {
+  expect(findHtmlBundleImageAsset(homepage, "/app-test.js")).toBeNull();
+  expect(findHtmlBundleAsset({}, "/pixel-abc123.png")).toBeNull();
+  expect(findHtmlBundleAsset(null, "/pixel-abc123.png")).toBeNull();
+});
+
+test("HTML bundle image map joins preserved Markdown hrefs to compiled bunfs assets", async () => {
+  const directory = await mkdtemp(join(tmpdir(), "jsmdcui-html-assets-"));
+  const htmlPath = join(directory, "app.html");
+  await writeFile(htmlPath, [
+    '<img src="/dms-ajghf5bd.jpg" data-mdcui-src="jsmdcui/single-exe/dms.jpg">',
+    '<img src="/unicode-xyz.png" data-mdcui-src="%E5%9C%96%E7%89%87/%E6%B8%AC%E8%A9%A6%20%E5%9C%96.png">',
+    '<img src="/query-qwe.png" data-mdcui-src="./query.png?x=1&amp;y=2#preview">',
+  ].join("\n"));
+  const compiledHomepage = {
+    index: htmlPath,
+    files: [
+      {
+        input: "dms.jpg",
+        path: "/$bunfs/root/dms-ajghf5bd.jpg",
+        loader: "file",
+        headers: { "content-type": "image/jpeg" },
+      },
+      {
+        input: "../../unicode.png",
+        path: "/$bunfs/root/unicode-xyz.png",
+        loader: "file",
+        headers: { "content-type": "image/png" },
+      },
+      {
+        input: "../query.png",
+        path: "/$bunfs/root/query-qwe.png",
+        loader: "file",
+        headers: { "content-type": "image/png" },
+      },
+    ],
+  };
+
+  const images = await buildHtmlBundleImageMap(compiledHomepage);
+  expect(images.get("jsmdcui/single-exe/dms.jpg"))
+    .toBe("/$bunfs/root/dms-ajghf5bd.jpg");
+  expect(images.get("圖片/測試 圖.png"))
+    .toBe("/$bunfs/root/unicode-xyz.png");
+  expect(images.get("./query.png?x=1&y=2#preview"))
+    .toBe("/$bunfs/root/query-qwe.png");
+});
+
+test("HTML bundle href canonicalization decodes serialization without resolving paths", () => {
+  expect(decodeHtmlAttribute("./a.png?x=1&amp;y=2")).toBe("./a.png?x=1&y=2");
+  expect(canonicalHtmlBundleImageHref("%E5%9C%96%E7%89%87/a%20b.png"))
+    .toBe("圖片/a b.png");
+  expect(canonicalHtmlBundleImageHref("./a.png?x=1&amp;y=2", { htmlAttribute: true }))
+    .toBe("./a.png?x=1&y=2");
+});
+
+test("HTML bundle image map accepts a custom source attribute", async () => {
+  const directory = await mkdtemp(join(tmpdir(), "jsmdcui-html-assets-custom-"));
+  const htmlPath = join(directory, "custom.html");
+  await writeFile(
+    htmlPath,
+    '<img src="/photo-custom123.jpg" data-original-image="./photos/a.jpg">',
+  );
+  const customHomepage = {
+    index: htmlPath,
+    files: [{
+      input: "../../photos/a.jpg",
+      path: "/$bunfs/root/photo-custom123.jpg",
+      loader: "file",
+      headers: { "content-type": "image/jpeg" },
+    }],
+  };
+
+  const images = await buildHtmlBundleImageMap(
+    customHomepage,
+    "data-original-image",
+  );
+  expect(images.get("./photos/a.jpg"))
+    .toBe("/$bunfs/root/photo-custom123.jpg");
+});

package/tests/compiled-runtime.test.js

@@ -1,4 +1,5 @@
 import { expect, test } from "bun:test";
+import { expandBuildMdAliases } from "../src/build-args.js";
 import {
   isCompiledBinary as isSingleExeCompiled,
   stringifyNonPrimitiveDefineValues,
@@ -10,6 +11,69 @@ test("single-exe recognizes Bun compiled virtual paths", () => {
   expect(isSingleExeCompiled(["bun", "/project/src/index.js"])).toBe(false);
 });
 
+test("--build-md-exe expands before the existing build flow", () => {
+  const argv = [
+    "bun",
+    "src/index.js",
+    "--build-md-exe",
+    "../中文工具.md",
+    "--sourcemap",
+  ];
+  expect(expandBuildMdAliases(argv)).toBe(true);
+  expect(argv).toEqual([
+    "bun",
+    "src/index.js",
+    "--build-exe",
+    "--define",
+    "global.MDCUI_MAIN=../中文工具.md",
+    "--sourcemap",
+  ]);
+  expect(expandBuildMdAliases(argv)).toBe(false);
+});
+
+test("--build-md-exe requires a Markdown path", () => {
+  expect(() => expandBuildMdAliases(["bun", "index.js", "--build-md-exe"]))
+    .toThrow("Missing Markdown path for --build-md-exe");
+  expect(() => expandBuildMdAliases([
+    "bun",
+    "index.js",
+    "--build-md-exe",
+    "--sourcemap",
+  ])).toThrow("Missing Markdown path for --build-md-exe");
+});
+
+test("--build-md-for expands before the existing cross-build flow", () => {
+  const argv = [
+    "bun",
+    "src/index.js",
+    "--build-md-for",
+    "bun-linux-x64",
+    "../中文工具.md",
+    "--sourcemap",
+  ];
+  expect(expandBuildMdAliases(argv)).toBe(true);
+  expect(argv).toEqual([
+    "bun",
+    "src/index.js",
+    "--build-for",
+    "bun-linux-x64",
+    "--define",
+    "global.MDCUI_MAIN=../中文工具.md",
+    "--sourcemap",
+  ]);
+});
+
+test("--build-md-for requires a platform and Markdown path", () => {
+  expect(() => expandBuildMdAliases(["bun", "index.js", "--build-md-for"]))
+    .toThrow("Missing platform for --build-md-for");
+  expect(() => expandBuildMdAliases([
+    "bun",
+    "index.js",
+    "--build-md-for",
+    "bun-linux-x64",
+  ])).toThrow("Missing Markdown path for --build-md-for");
+});
+
 test("non-primitive MDCUI_MAIN define values become strings", () => {
   const split = [
     "bun",

package/tests/kitty-images.test.js

@@ -26,6 +26,28 @@ test("Bun-rendered Markdown image links reserve rows and retain Kitty data", asy
   expect(Bun.stripANSI(result.rendered)).toContain("📷 pixel");
 });
 
+test("Kitty images prefer lazily supplied compiled HTML bundle assets", async () => {
+  const dir = await mkdtemp(join(tmpdir(), "jsmdcui-kitty-bundled-"));
+  const bundledPath = join(dir, "pixel-bundled.png");
+  await writeFile(bundledPath, ONE_PIXEL_PNG);
+  const ansi = Bun.markdown.ansi("![pixel](./images/pixel.png?version=2#preview)", {
+    hyperlinks: true,
+    columns: 40,
+  });
+  let imageMapRequests = 0;
+  const result = await prepareKittyImages(ansi, join(dir, "missing-app.md"), 40, {
+    getBundledImageMap: async () => {
+      imageMapRequests++;
+      return new Map([["./images/pixel.png?version=2#preview", bundledPath]]);
+    },
+  });
+
+  expect(imageMapRequests).toBe(1);
+  expect(result.images).toHaveLength(1);
+  expect(result.images[0].path).toBe(bundledPath);
+  expect(result.images[0].data.equals(ONE_PIXEL_PNG)).toBe(true);
+});
+
 test("Kitty compat converts compressed images to standard PNG payloads", async () => {
   const dir = await mkdtemp(join(tmpdir(), "jsmdcui-kitty-compat-"));
   const markdownPath = join(dir, "app.md");

package/tests/kitty-mode.test.js

@@ -0,0 +1,14 @@
+import { expect, test } from "bun:test";
+import { kittyModeFromEnvironment } from "../src/cui/kitty-mode.mjs";
+
+test("Kitty mode accepts supported environment values case-insensitively", () => {
+  expect(kittyModeFromEnvironment("compat")).toBe("compat");
+  expect(kittyModeFromEnvironment(" EXTENDED ")).toBe("extended");
+  expect(kittyModeFromEnvironment("off")).toBe("off");
+});
+
+test("Kitty mode defaults invalid or missing environment values to off", () => {
+  expect(kittyModeFromEnvironment()).toBe("off");
+  expect(kittyModeFromEnvironment("yes")).toBe("off");
+  expect(kittyModeFromEnvironment("")).toBe("off");
+});

package/tests/wui-responsive-images.test.js

@@ -19,6 +19,7 @@ test("createWui constrains images to their content width", async () => {
   const html = await createWui("![wide](wide.png)", markdownPath);
 
   expect(html).toContain("img {\n  max-width: 100%;\n  height: auto;\n}");
+  expect(html).toContain('src="wide.png" alt="wide" data-mdcui-src="wide.png"');
   expect(html.match(/max-width: 100%/g)).toHaveLength(1);
   expect(html.match(/image\.md\.front\.js/g)).toHaveLength(1);
 });
@@ -31,6 +32,7 @@ test("createWui injects the image rule into an existing document head", async ()
   const html = await createWui(source, markdownPath);
 
   expect(html.indexOf("max-width: 100%")).toBeLessThan(html.indexOf("</head>"));
+  expect(html).toContain('src="wide.png" data-mdcui-src="wide.png"');
   expect(html.match(/document\.md\.front\.js/g)).toHaveLength(1);
 });