@devframes/service-open 0.9.7 → 0.9.9

package/dist/index.d.mts

@@ -5,21 +5,21 @@ declare const OPEN_SERVICE_PACKAGE = "@devframes/service-open";
 declare const OPEN_SERVICE_SCOPE = "devframes:service:open";
 interface OpenServiceOptions {
   /**
-   * Preferred editor command — one of the `KNOWN_EDITORS` `launch-editor`
+   * Preferred editor command, one of the `KNOWN_EDITORS` `launch-editor`
    * recognizes. Auto-detected (via `LAUNCH_EDITOR` and common defaults)
    * when omitted. On merge, the later installer's choice wins.
    */
   editor?: KnownEditor;
   /**
    * Additional directories files may be opened from, on top of the
-   * context's `workspaceRoot` — e.g. a plugin's managed storage dir that
+   * context's `workspaceRoot`, e.g. a plugin's managed storage dir that
    * lives outside the workspace. Merged as a union across installers.
    */
   roots?: string[];
 }
 interface OpenInEditorInput {
   /**
-   * File to open — absolute, or relative to the service's `workspaceRoot`
+   * File to open, absolute or relative to the service's `workspaceRoot`
    * (so a client with only a workspace-relative path, e.g. a message's file
    * position, can call this directly without a server-side bridge).
    */
@@ -52,7 +52,7 @@ declare module 'devframe' {
   }
 }
 /**
- * The open wire service — `open-in-editor` / `open-in-finder` RPC shared by
+ * The open wire service: `open-in-editor` / `open-in-finder` RPC shared by
  * every plugin on the host, replacing per-plugin registrations of the
  * (deprecated) `devframe/recipes/common-rpc-functions` recipes. Paths may be
  * absolute or relative to the `workspaceRoot`; the service refuses paths

package/dist/index.mjs

@@ -1,12 +1,18 @@
+import { realpath } from "node:fs/promises";
 import { defineRpcFunction } from "devframe";
 import { KNOWN_EDITORS } from "devframe/recipes/common-rpc-functions";
 import { s } from "devframe/utils/simple-schema";
-import { isAbsolute, relative, resolve } from "pathe";
+import { dirname, isAbsolute, normalize, relative, resolve } from "pathe";
 import { defineDiagnostics } from "devframe/utils/nostics";
 //#region package.json
-var version = "0.9.7";
+var version = "0.9.9";
 //#endregion
 //#region src/diagnostics.ts
+/**
+* Uses the service's own `DS_OPEN_` prefix per the built-in convention,
+* keeping it collision-free with devframe core (`DF00xx`), the hub
+* (`DF8xxx`), and the plugins (`DP_<SLUG>_`).
+*/
 const diagnostics = defineDiagnostics({
 	docsBase: "https://devfra.me/errors",
 	codes: { DS_OPEN_0002: {
@@ -16,10 +22,21 @@ const diagnostics = defineDiagnostics({
 });
 //#endregion
 //#region src/index.ts
+/** Canonical path of the nearest existing ancestor of `absolute`. */
+async function nearestExistingCanonical(absolute) {
+	let current = absolute;
+	for (;;) try {
+		return normalize(await realpath(current));
+	} catch {
+		const parent = dirname(current);
+		if (parent === current) return current;
+		current = parent;
+	}
+}
 const OPEN_SERVICE_PACKAGE = "@devframes/service-open";
 const OPEN_SERVICE_SCOPE = "devframes:service:open";
 /**
-* The open wire service — `open-in-editor` / `open-in-finder` RPC shared by
+* The open wire service: `open-in-editor` / `open-in-finder` RPC shared by
 * every plugin on the host, replacing per-plugin registrations of the
 * (deprecated) `devframe/recipes/common-rpc-functions` recipes. Paths may be
 * absolute or relative to the `workspaceRoot`; the service refuses paths
@@ -34,29 +51,38 @@ function createOpenService(options) {
 		version,
 		scope: OPEN_SERVICE_SCOPE,
 		options,
+		/**
+		* Option sets from multiple installers merge via devframe's default
+		* deep-merge: `roots` union, `editor` last-wins.
+		*/
 		setup(ctx, { options }) {
-			const allowedRoots = [ctx.workspaceRoot, ...options?.roots ?? []].map((root) => resolve(root));
+			const allowedRoots = [ctx.workspaceRoot, ...options?.roots ?? []].map((r) => resolve(r));
+			const canonicalRoots = Promise.all(allowedRoots.map((r) => nearestExistingCanonical(r)));
+			const within = (roots, p) => roots.some((root) => {
+				const rel = relative(root, p);
+				return rel === "" || !rel.startsWith("..") && !isAbsolute(rel);
+			});
 			/**
 			* Resolve `path` (relative paths against `workspaceRoot`) and assert it
-			* lands inside one of the allowed roots, or throw.
+			* lands inside one of the allowed roots, or throw. The lexical pass
+			* rejects plain `..`/absolute escapes; the canonical pass rejects a
+			* symlink that would redirect the open outside every root, while still
+			* allowing not-yet-existing files under a root.
 			*/
-			function assertAllowedPath(path) {
+			async function assertAllowedPath(path) {
 				const resolved = isAbsolute(path) ? resolve(path) : resolve(ctx.workspaceRoot, path);
-				if (!allowedRoots.some((root) => {
-					const rel = relative(root, resolved);
-					return rel === "" || !rel.startsWith("..") && !isAbsolute(rel);
-				})) throw diagnostics.DS_OPEN_0002({ path });
+				if (!within(allowedRoots, resolved) || !within(await canonicalRoots, await nearestExistingCanonical(resolved))) throw diagnostics.DS_OPEN_0002({ path });
 				return resolved;
 			}
 			const api = {
 				async openInEditor(input) {
-					const path = assertAllowedPath(input.path);
+					const path = await assertAllowedPath(input.path);
 					const target = input.line != null ? `${path}:${input.line}${input.column != null ? `:${input.column}` : ""}` : path;
 					const { launchEditor } = await import("devframe/utils/launch-editor");
 					launchEditor(target, input.editor ?? options?.editor);
 				},
 				async openInFinder(input) {
-					const path = assertAllowedPath(input.path);
+					const path = await assertAllowedPath(input.path);
 					const { open } = await import("devframe/utils/open");
 					await open(path);
 				}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@devframes/service-open",
   "type": "module",
-  "version": "0.9.7",
+  "version": "0.9.9",
   "description": "Devframe wire service that opens files in the user's editor or reveals them in the OS file explorer.",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -28,16 +28,16 @@
     "dist"
   ],
   "peerDependencies": {
-    "devframe": "0.9.7"
+    "devframe": "0.9.9"
   },
   "dependencies": {
     "pathe": "^2.0.3"
   },
   "devDependencies": {
-    "@types/node": "^26.2.0",
+    "@types/node": "^26.4.0",
+    "devframe": "0.9.9",
     "tsdown": "^0.22.14",
-    "vitest": "^4.1.10",
-    "devframe": "0.9.7"
+    "vitest": "^4.1.11"
   },
   "scripts": {
     "build": "tsdown",