dsh-plugin-workbench 0.0.3 → 0.0.5

package/lib/index.js

@@ -1,10 +1,40 @@
+import { mkdir, rename, rm, writeFile } from "node:fs/promises";
 //#region src/index.ts
 const name = "dsh-plugin-workbench";
-const inject = ["fs", "connection"];
+const inject = [
+	"fs",
+	"connection",
+	"webServer"
+];
 /** Loopback-only logical RPC channel. */
 const CHANNEL = "/dsh-plugin-files";
 /** Files larger than this are never read for preview (client shows size + hint). */
 const MAX_PREVIEW_BYTES = 524288;
+/** Same-origin route serving raw bytes for image files (see module doc). */
+const RAW_PREFIX = "/dsh-plugin-files/raw";
+/** Images larger than this are never served to the preview (browser shows a hint). */
+const MAX_IMAGE_BYTES = 20971520;
+const IMAGE_MIME = {
+	png: "image/png",
+	jpg: "image/jpeg",
+	jpeg: "image/jpeg",
+	gif: "image/gif",
+	webp: "image/webp",
+	avif: "image/avif",
+	bmp: "image/bmp",
+	ico: "image/x-icon",
+	svg: "image/svg+xml"
+};
+/** MIME type for a path's extension when it names a previewable image; undefined otherwise. */
+function imageMimeOf(path) {
+	const idx = path.lastIndexOf(".");
+	if (idx < 0 || idx === path.length - 1) return void 0;
+	return IMAGE_MIME[path.slice(idx + 1).toLowerCase()];
+}
+/** True when the path names a previewable image file. */
+function isImagePath(path) {
+	return imageMimeOf(path) !== void 0;
+}
 /** Map an fs entry type onto the wire `kind` union. */
 function kindOf(type) {
 	if (type === "directory") return "dir";
@@ -42,7 +72,15 @@ const FS_ERROR_MESSAGES = {
 	FS_PERMISSION_DENIED: "permission denied",
 	FS_SANDBOX_DENIED: "sandbox denied",
 	FS_ABORTED: "aborted",
-	FS_IO_ERROR: "io error"
+	FS_IO_ERROR: "io error",
+	EEXIST: "file or folder already exists",
+	ENOENT: "path does not exist",
+	ENOTEMPTY: "folder is not empty",
+	EPERM: "permission denied",
+	EACCES: "permission denied",
+	ENOTDIR: "not a directory",
+	EISDIR: "is a directory",
+	EBUSY: "file is in use"
 };
 /** Human-readable message for a thrown value, honoring the fs error code taxonomy. */
 function mapError(error) {
@@ -80,10 +118,65 @@ function apply(ctx) {
 	const handler = async (endpoint, payload, signal) => {
 		if (endpoint === "list") return listDir(ctx, payload, signal);
 		if (endpoint === "read") return readFile(ctx, payload, signal);
-		if (endpoint === "write") return writeFile(ctx, payload, signal);
+		if (endpoint === "write") return writeFile$1(ctx, payload, signal);
+		if (endpoint === "createFile") return createFile(ctx, payload, signal);
+		if (endpoint === "createDir") return createDir(ctx, payload, signal);
+		if (endpoint === "rename") return renameEntry(ctx, payload, signal);
+		if (endpoint === "delete") return deleteEntry(ctx, payload, signal);
 		return fail(`unknown endpoint: ${endpoint}`);
 	};
-	ctx.connection.rpc.handle(CHANNEL, handler, { authority: "loopback" });
+	ctx.effect(() => ctx.connection.rpc.handle(CHANNEL, handler, { authority: "loopback" }), "dsh-plugin-workbench: files rpc channel");
+	ctx.effect(() => ctx.webServer.register({
+		kind: "prefix",
+		path: RAW_PREFIX,
+		handler: (req, res) => {
+			serveRaw(ctx, req, res);
+		}
+	}), "dsh-plugin-workbench: raw image route");
+}
+async function serveRaw(ctx, req, res) {
+	const text = (code, body) => {
+		res.writeHead(code, { "content-type": "text/plain; charset=utf-8" });
+		res.end(body);
+	};
+	try {
+		if ((req.method ?? "GET").toUpperCase() !== "GET") {
+			text(405, "method not allowed");
+			return;
+		}
+		const rest = new URL(req.url ?? "/", "http://dsh.internal").pathname.slice(21).replace(/^\/+/, "");
+		if (rest.length === 0) {
+			text(404, "not found");
+			return;
+		}
+		const path = decodeURIComponent(rest);
+		const mime = imageMimeOf(path);
+		if (mime === void 0) {
+			text(404, "not an image");
+			return;
+		}
+		const target = await ctx.fs.resolve(path);
+		const info = await ctx.fs.stat(target);
+		if (info === void 0 || info.type !== "file") {
+			text(404, "not found");
+			return;
+		}
+		if ((info.size ?? 0) > 20971520) {
+			text(413, "image too large");
+			return;
+		}
+		const bytes = await ctx.fs.readBytes(target, void 0, MAX_IMAGE_BYTES);
+		res.writeHead(200, {
+			"content-type": mime,
+			"content-length": bytes.byteLength,
+			"cache-control": "private, max-age=300",
+			"x-content-type-options": "nosniff"
+		});
+		res.end(Buffer.from(bytes));
+	} catch (error) {
+		if (!res.headersSent) text(500, "internal error");
+		else res.destroy();
+	}
 }
 async function listDir(ctx, payload, signal) {
 	const path = pathOf(payload);
@@ -153,7 +246,7 @@ async function readFile(ctx, payload, signal) {
 		return fail(mapError(error));
 	}
 }
-async function writeFile(ctx, payload, signal) {
+async function writeFile$1(ctx, payload, signal) {
 	const path = pathOf(payload);
 	const content = typeof payload === "object" && payload !== null ? payload.content : void 0;
 	if (path === void 0) return fail("write: payload.path must be a non-empty string");
@@ -175,5 +268,75 @@ async function writeFile(ctx, payload, signal) {
 		return fail(mapError(error));
 	}
 }
+async function createFile(ctx, payload, signal) {
+	const path = pathOf(payload);
+	if (path === void 0) return fail("createFile: payload.path must be a non-empty string");
+	try {
+		const target = await ctx.fs.resolve(path, { signal });
+		const osPath = ctx.fs.processPath(target);
+		await writeFile(osPath, "", { flag: "wx" });
+		return {
+			ok: true,
+			value: { path: osPath }
+		};
+	} catch (error) {
+		return fail(mapError(error));
+	}
+}
+async function createDir(ctx, payload, signal) {
+	const path = pathOf(payload);
+	if (path === void 0) return fail("createDir: payload.path must be a non-empty string");
+	try {
+		const target = await ctx.fs.resolve(path, { signal });
+		const osPath = ctx.fs.processPath(target);
+		await mkdir(osPath);
+		return {
+			ok: true,
+			value: { path: osPath }
+		};
+	} catch (error) {
+		return fail(mapError(error));
+	}
+}
+async function renameEntry(ctx, payload, signal) {
+	const path = pathOf(payload);
+	const to = typeof payload === "object" && payload !== null ? payload.to : void 0;
+	if (path === void 0) return fail("rename: payload.path must be a non-empty string");
+	if (typeof to !== "string" || to.trim().length === 0) return fail("rename: payload.to must be a non-empty string");
+	try {
+		const target = await ctx.fs.resolve(path, { signal });
+		const osPath = ctx.fs.processPath(target);
+		const toTarget = await ctx.fs.resolve(to, { signal });
+		const toOsPath = ctx.fs.processPath(toTarget);
+		if (await ctx.fs.stat(toTarget, signal) !== void 0) return fail("rename: destination already exists");
+		await rename(osPath, toOsPath);
+		return {
+			ok: true,
+			value: { path: toOsPath }
+		};
+	} catch (error) {
+		return fail(mapError(error));
+	}
+}
+async function deleteEntry(ctx, payload, signal) {
+	const path = pathOf(payload);
+	if (path === void 0) return fail("delete: payload.path must be a non-empty string");
+	try {
+		const target = await ctx.fs.resolve(path, { signal });
+		const osPath = ctx.fs.processPath(target);
+		const info = await ctx.fs.stat(target, signal);
+		if (info === void 0) return fail(`path not found: ${path}`);
+		await rm(osPath, {
+			recursive: info.type === "directory",
+			force: true
+		});
+		return {
+			ok: true,
+			value: { path: osPath }
+		};
+	} catch (error) {
+		return fail(mapError(error));
+	}
+}
 //#endregion
-export { CHANNEL, MAX_PREVIEW_BYTES, apply, inject, kindOf, mapDirEntry, mapError, name, sortEntries };
+export { CHANNEL, MAX_IMAGE_BYTES, MAX_PREVIEW_BYTES, RAW_PREFIX, apply, imageMimeOf, inject, isImagePath, kindOf, mapDirEntry, mapError, name, sortEntries };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dsh-plugin-workbench",
   "description": "VS Code-style workspace file explorer + editable preview for the dsh web GUI",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "type": "module",
   "packageManager": "pnpm@11.21.0",
   "engines": {