cspell-io 10.3.5 → 10.4.0-alpha.1

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 import { isFileURL, isUrlLike, toFileURL, toURL, urlBasename, urlParent as urlDirname } from "@cspell/url";
-import { Buffer } from "node:buffer";
 import { ServiceBus } from "@cspell/cspell-service-bus";
 //#region src/async/asyncIterable.d.ts
 /**
@@ -502,6 +501,9 @@ interface RedirectOptions {
  * Create a provider that will redirect requests from the publicRoot to the privateRoot.
  * This is useful for creating a virtual file system that is a subset of another file system.
  *
+ * A request under the publicRoot is only passed on if it maps to a URL under the privateRoot.
+ * Other requests are rejected with a `VFSErrorUnsupportedRequest`.
+ *
  * Example:
  * ```ts
  * const vfs = createVirtualFS();

package/dist/index.js

@@ -108,15 +108,17 @@ function assert$1(value, message) {
 	if (!value) throw new AssertionError(message ?? "Assertion failed");
 }
 //#endregion
+//#region src/common/nodeBuffer.ts
+function arrayBufferViewToBuffer(data) {
+	if (data instanceof Buffer) return data;
+	return Buffer.from(data.buffer, data.byteOffset, data.byteLength);
+}
+//#endregion
 //#region src/common/arrayBuffers.ts
 function toUint8Array(data) {
 	if (data instanceof Uint8Array) return data;
 	return new Uint8Array(data.buffer, data.byteOffset, data.byteLength);
 }
-function arrayBufferViewToBuffer(data) {
-	if (data instanceof Buffer) return data;
-	return Buffer.from(data.buffer, data.byteOffset, data.byteLength);
-}
 function copyArrayBufferView(data) {
 	return new Uint8Array(data.buffer.slice(data.byteOffset, data.byteOffset + data.byteLength));
 }
@@ -1492,6 +1494,9 @@ var RedirectProvider = class {
 * Create a provider that will redirect requests from the publicRoot to the privateRoot.
 * This is useful for creating a virtual file system that is a subset of another file system.
 *
+* A request under the publicRoot is only passed on if it maps to a URL under the privateRoot.
+* Other requests are rejected with a `VFSErrorUnsupportedRequest`.
+*
 * Example:
 * ```ts
 * const vfs = createVirtualFS();
@@ -1524,31 +1529,25 @@ function createRedirectProvider(name, publicRoot, privateRoot, options) {
 */
 function remapFS(name, fs, shadowFs, publicRoot, privateRoot, options) {
 	const { capabilitiesMask = -1, capabilities } = options;
-	function mapToPrivate(url) {
-		const relativePath = url.pathname.slice(publicRoot.pathname.length);
-		return new URL(relativePath, privateRoot);
-	}
-	function mapToPublic(url) {
-		const relativePath = url.pathname.slice(privateRoot.pathname.length);
-		return new URL(relativePath, publicRoot);
-	}
-	const mapFileReferenceToPrivate = (ref) => {
-		return renameFileReference(ref, mapToPrivate(ref.url));
+	const mapToPrivate = (url, request) => mapUrl(url, publicRoot, privateRoot, request);
+	const mapToPublic = (url, request) => mapUrl(url, privateRoot, publicRoot, request);
+	const mapFileReferenceToPrivate = (ref, request) => {
+		return renameFileReference(ref, mapToPrivate(ref.url, request));
 	};
-	const mapFileReferenceToPublic = (ref) => {
-		return renameFileReference(ref, mapToPublic(ref.url));
+	const mapFileReferenceToPublic = (ref, request) => {
+		return renameFileReference(ref, mapToPublic(ref.url, request));
 	};
-	const mapUrlOrReferenceToPrivate = (urlOrRef) => {
-		return urlOrRef instanceof URL ? mapToPrivate(urlOrRef) : mapFileReferenceToPrivate(urlOrRef);
+	const mapUrlOrReferenceToPrivate = (urlOrRef, request) => {
+		return urlOrRef instanceof URL ? mapToPrivate(urlOrRef, request) : mapFileReferenceToPrivate(urlOrRef, request);
 	};
-	const mapFileResourceToPublic = (res) => {
-		return renameFileResource(res, mapToPublic(res.url));
+	const mapFileResourceToPublic = (res, request) => {
+		return renameFileResource(res, mapToPublic(res.url, request));
 	};
-	const mapFileResourceToPrivate = (res) => {
-		return renameFileResource(res, mapToPrivate(res.url));
+	const mapFileResourceToPrivate = (res, request) => {
+		return renameFileResource(res, mapToPrivate(res.url, request));
 	};
-	const mapDirEntryToPublic = (de) => {
-		const dir = mapToPublic(de.dir);
+	const mapDirEntryToPublic = (de, request) => {
+		const dir = mapToPublic(de.dir, request);
 		return {
 			...de,
 			dir
@@ -1557,22 +1556,22 @@ function remapFS(name, fs, shadowFs, publicRoot, privateRoot, options) {
 	const dispose = () => fs.dispose();
 	return fsPassThrough({
 		stat: async (url) => {
-			const url2 = mapUrlOrReferenceToPrivate(url);
+			const url2 = mapUrlOrReferenceToPrivate(url, "stat");
 			return await fs.stat(url2);
 		},
 		readFile: async (url, options) => {
-			const url2 = mapUrlOrReferenceToPrivate(url);
+			const url2 = mapUrlOrReferenceToPrivate(url, "readFile");
 			const file = await fs.readFile(url2, options);
-			return mapFileResourceToPublic(file);
+			return mapFileResourceToPublic(file, "readFile");
 		},
 		readDirectory: async (url) => {
-			const url2 = mapToPrivate(url);
-			return (await fs.readDirectory(url2)).map(mapDirEntryToPublic);
+			const url2 = mapToPrivate(url, "readDirectory");
+			return (await fs.readDirectory(url2)).map((de) => mapDirEntryToPublic(de, "readDirectory"));
 		},
 		writeFile: async (file) => {
-			const fileRef2 = mapFileResourceToPrivate(file);
+			const fileRef2 = mapFileResourceToPrivate(file, "writeFile");
 			const fileRef3 = await fs.writeFile(fileRef2);
-			return mapFileReferenceToPublic(fileRef3);
+			return mapFileReferenceToPublic(fileRef3, "writeFile");
 		},
 		providerInfo: {
 			...fs.providerInfo,
@@ -1583,6 +1582,22 @@ function remapFS(name, fs, shadowFs, publicRoot, privateRoot, options) {
 		[Symbol.dispose]: dispose
 	}, shadowFs, publicRoot);
 }
+/**
+* Map a URL under `fromRoot` to the same relative path under `toRoot`.
+* Throws if the URL is not under `fromRoot` or the result is not under `toRoot`.
+*/
+function mapUrl(url, fromRoot, toRoot, request) {
+	const unsupported = () => new VFSErrorUnsupportedRequest(request, url);
+	if (!isUrlUnderRoot(url, fromRoot)) throw unsupported();
+	const relativePath = url.pathname.slice(fromRoot.pathname.length);
+	if (/^(?:[/\\]|%2f|%5c)/i.test(relativePath)) throw unsupported();
+	const mapped = new URL("./" + relativePath, toRoot);
+	if (!isUrlUnderRoot(mapped, toRoot)) throw unsupported();
+	return mapped;
+}
+function isUrlUnderRoot(url, root) {
+	return url.protocol === root.protocol && url.host === root.host && url.pathname.startsWith(root.pathname);
+}
 function fsPassThrough(fs, shadowFs, root) {
 	function gfs(ur, name) {
 		const url = urlOrReferenceToUrl(ur);

package/package.json

@@ -1,19 +1,33 @@
 {
   "name": "cspell-io",
+  "version": "10.4.0-alpha.1",
+  "description": "A library of useful I/O functions used across various cspell tools.",
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
-  "version": "10.3.5",
-  "description": "A library of useful I/O functions used across various cspell tools.",
-  "type": "module",
+  "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-io#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/streetsidesoftware/cspell.git",
+    "directory": "packages/cspell-io"
+  },
+  "bugs": {
+    "url": "https://github.com/streetsidesoftware/cspell/issues?q=is%3Aissue%20state%3Aopen%20label%3Acspell-io"
+  },
+  "keywords": [
+    "cspell"
+  ],
+  "license": "MIT",
+  "author": "Jason Dent",
   "sideEffects": false,
-  "module": "dist/index.js",
+  "type": "module",
   "exports": {
     ".": {
       "import": "./dist/index.js"
     }
   },
+  "module": "dist/index.js",
   "files": [
     "dist",
     "!**/*.tsbuildInfo",
@@ -26,38 +40,24 @@
     "build": "tsdown && pnpm build:tsc",
     "build:tsc": "tsc -p .",
     "build:watch": "tsdown --watch",
-    "watch": "pnpm build:watch",
     "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
     "clean-build": "pnpm run clean && pnpm run build",
     "coverage": "vitest run --coverage --pool=forks",
+    "test": "vitest run --pool=forks",
     "test-watch": "vitest",
-    "test": "vitest run --pool=forks"
+    "watch": "pnpm build:watch"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/streetsidesoftware/cspell.git",
-    "directory": "packages/cspell-io"
-  },
-  "keywords": [
-    "cspell"
-  ],
-  "author": "Jason Dent",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/streetsidesoftware/cspell/labels/cspell-io"
-  },
-  "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-io#readme",
-  "engines": {
-    "node": ">=22.18.0"
+  "dependencies": {
+    "@cspell/cspell-service-bus": "10.4.0-alpha.1",
+    "@cspell/url": "10.4.0-alpha.1"
   },
   "devDependencies": {
     "lorem-ipsum": "^3.0.0",
     "typescript": "~6.0.3",
     "vitest-fetch-mock": "^0.4.5"
   },
-  "dependencies": {
-    "@cspell/cspell-service-bus": "10.3.5",
-    "@cspell/url": "10.3.5"
+  "engines": {
+    "node": ">=22.18.0"
   },
-  "gitHead": "f37a244a54b686fc1ac11272d6019b9a059b062a"
+  "gitHead": "628768a6e62b792e628189b41e63e12e5d3d8fe3"
 }