@b9g/filesystem 0.1.9 → 0.1.11

package/README.md

@@ -182,6 +182,33 @@ const buffer = await fileData.arrayBuffer();
 const stream = fileData.stream();
 ```
 
+## Shovel Configuration
+
+When used with Shovel, directories are configured in `shovel.json`. The built-in names `server`, `public`, and `tmp` have platform defaults. Custom directory names require an explicit `module`:
+
+```json
+{
+  "directories": {
+    "uploads": {
+      "module": "@b9g/filesystem/node-fs",
+      "path": "./uploads"
+    },
+    "docs": {
+      "module": "@b9g/filesystem/node-fs",
+      "path": "../docs"
+    }
+  }
+}
+```
+
+The `path` field is resolved relative to the project root. Paths outside the project (e.g. `"../docs"`) are supported — the root path itself is unrestricted, while directory traversal within opened directories is blocked at the filesystem level.
+
+Access configured directories via the global `self.directories`:
+
+```typescript
+const uploads = await self.directories.open("uploads");
+```
+
 ## Integration Examples
 
 ### Cache Storage

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@b9g/filesystem",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "description": "Universal File System Access API implementations for all platforms",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/bikeshaving/shovel.git",
+    "url": "git+https://github.com/bikeshaving/shovel.git",
     "directory": "packages/filesystem"
   },
   "dependencies": {

package/src/bun-s3.d.ts

@@ -73,3 +73,4 @@ export declare class S3Directory implements FileSystemDirectoryHandle {
     queryPermission(): Promise<PermissionState>;
     requestPermission(): Promise<PermissionState>;
 }
+export default S3Directory;

package/src/bun-s3.js

@@ -268,7 +268,9 @@ var S3Directory = class _S3Directory {
     return "granted";
   }
 };
+var bun_s3_default = S3Directory;
 export {
   S3Directory,
-  S3FileSystemBackend
+  S3FileSystemBackend,
+  bun_s3_default as default
 };

package/src/memory.d.ts

@@ -76,4 +76,4 @@ export declare class MemoryDirectory implements FileSystemDirectoryHandle {
     queryPermission(): Promise<PermissionState>;
     requestPermission(): Promise<PermissionState>;
 }
-export {};
+export default MemoryDirectory;

package/src/memory.js

@@ -263,7 +263,9 @@ var MemoryDirectory = class _MemoryDirectory {
     return "granted";
   }
 };
+var memory_default = MemoryDirectory;
 export {
   MemoryDirectory,
-  MemoryFileSystemBackend
+  MemoryFileSystemBackend,
+  memory_default as default
 };

package/src/node-fs.d.ts

@@ -43,3 +43,4 @@ export declare class NodeFSDirectory extends ShovelDirectoryHandle {
     });
     get name(): string;
 }
+export default NodeFSDirectory;

package/src/node-fs.js

@@ -156,7 +156,9 @@ var NodeFSDirectory = class extends ShovelDirectoryHandle {
     return Path.basename(this.#rootPath) || "root";
   }
 };
+var node_fs_default = NodeFSDirectory;
 export {
   NodeFSBackend,
-  NodeFSDirectory
+  NodeFSDirectory,
+  node_fs_default as default
 };