@statewalker/webrun-files-s3 0.5.0 → 0.9.0

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 /**
- * webrun-files-s3 - S3-backed IFilesApi implementation
+ * webrun-files-s3 - S3-backed FilesApi implementation
  */
 export { S3FilesApi, type S3FilesApiOptions } from "./s3-files-api.js";
-export { S3FileHandle, type S3FileHandleOptions } from "./s3-file-handle.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,KAAK,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,KAAK,iBAAiB,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/s3-files-api.d.ts

@@ -1,15 +1,13 @@
 /**
- * S3 implementation of IFilesApi
+ * S3 implementation of FilesApi
  *
  * Provides a filesystem-like interface over S3 object storage.
- * Supports all IFilesApi methods including the optional move, copy, and mkdir.
  */
 import type { S3Client } from "@aws-sdk/client-s3";
-import type { CopyOptions, FileHandle, FileInfo, FileRef, IFilesApi, ListOptions } from "@statewalker/webrun-files";
+import type { FileInfo, FileStats, FilesApi, ListOptions, ReadOptions } from "@statewalker/webrun-files";
 export interface S3FilesApiOptions {
     /**
      * Pre-configured S3Client instance.
-     * Allows full control over credentials, region, endpoint.
      */
     client: S3Client;
     /**
@@ -18,67 +16,38 @@ export interface S3FilesApiOptions {
     bucket: string;
     /**
      * Optional key prefix (acts as root directory).
-     * All paths will be relative to this prefix.
      * @example "projects/my-app/data"
      */
     prefix?: string;
     /**
-     * Minimum part size for multipart uploads (5MB minimum for S3).
-     * @default 5 * 1024 * 1024 (5MB)
+     * Part size for multipart uploads in bytes.
+     * S3 requires minimum 5MB for all parts except the last.
+     * @default 5242880 (5MB)
      */
     multipartPartSize?: number;
 }
-export declare class S3FilesApi implements IFilesApi {
+/**
+ * S3 filesystem implementation of FilesApi.
+ *
+ * Provides a filesystem-like interface over S3 object storage.
+ * Works with AWS S3 and S3-compatible services.
+ */
+export declare class S3FilesApi implements FilesApi {
     private client;
     private bucket;
     private prefix;
-    private multipartPartSize;
+    private partSize;
     constructor(options: S3FilesApiOptions);
-    /**
-     * Converts a virtual path to an S3 key.
-     * @example resolveKey("/docs/file.txt") => "prefix/docs/file.txt"
-     */
     private resolveKey;
-    /**
-     * Converts an S3 key back to a virtual path.
-     */
     private keyToPath;
-    /**
-     * Lists objects in a virtual directory.
-     *
-     * Uses S3's delimiter feature to simulate directory listing.
-     * CommonPrefixes represent subdirectories.
-     */
-    list(file: FileRef, options?: ListOptions): AsyncGenerator<FileInfo>;
-    /**
-     * Gets object metadata using HEAD request.
-     */
-    stats(file: FileRef): Promise<FileInfo | undefined>;
-    /**
-     * Deletes an object or all objects under a prefix (directory).
-     */
-    remove(file: FileRef): Promise<boolean>;
-    /**
-     * Opens an S3 object for random access.
-     * Creates the object if it doesn't exist.
-     */
-    open(file: FileRef): Promise<FileHandle>;
-    /**
-     * Moves an object using Copy + Delete.
-     */
-    move(source: FileRef, target: FileRef): Promise<boolean>;
-    /**
-     * Copies an object or directory using S3 CopyObject.
-     */
-    copy(source: FileRef, target: FileRef, options?: CopyOptions): Promise<boolean>;
-    /**
-     * Creates a directory marker in S3.
-     *
-     * S3 doesn't have real directories, but some tools expect
-     * a zero-byte object with trailing slash as a directory marker.
-     * However, for our purposes we don't actually need to create markers
-     * since directories are implied by files within them.
-     */
-    mkdir(file: FileRef): Promise<void>;
+    read(path: string, options?: ReadOptions): AsyncIterable<Uint8Array>;
+    write(path: string, content: Iterable<Uint8Array> | AsyncIterable<Uint8Array>): Promise<void>;
+    mkdir(path: string): Promise<void>;
+    list(path: string, options?: ListOptions): AsyncIterable<FileInfo>;
+    stats(path: string): Promise<FileStats | undefined>;
+    exists(path: string): Promise<boolean>;
+    remove(path: string): Promise<boolean>;
+    move(source: string, target: string): Promise<boolean>;
+    copy(source: string, target: string): Promise<boolean>;
 }
 //# sourceMappingURL=s3-files-api.d.ts.map

package/dist/s3-files-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"s3-files-api.d.ts","sourceRoot":"","sources":["../src/s3-files-api.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAQnD,OAAO,KAAK,EACV,WAAW,EACX,UAAU,EACV,QAAQ,EACR,OAAO,EACP,SAAS,EACT,WAAW,EACZ,MAAM,2BAA2B,CAAC;AAInC,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,qBAAa,UAAW,YAAW,SAAS;IAC1C,OAAO,CAAC,MAAM,CAAW;IACzB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,iBAAiB,CAAS;gBAEtB,OAAO,EAAE,iBAAiB;IAQtC;;;OAGG;IACH,OAAO,CAAC,UAAU;IAalB;;OAEG;IACH,OAAO,CAAC,SAAS;IAWjB;;;;;OAKG;IACI,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,GAAE,WAAgB,GAAG,cAAc,CAAC,QAAQ,CAAC;IAqE/E;;OAEG;IACG,KAAK,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;IA+DzD;;OAEG;IACG,MAAM,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAwE7C;;;OAGG;IACG,IAAI,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC;IA+B9C;;OAEG;IACG,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAO9D;;OAEG;IACG,IAAI,CACR,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,OAAO,EACf,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,OAAO,CAAC;IAiEnB;;;;;;;OAOG;IACG,KAAK,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAgB1C"}
+{"version":3,"file":"s3-files-api.d.ts","sourceRoot":"","sources":["../src/s3-files-api.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAanD,OAAO,KAAK,EACV,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,WAAW,EACX,WAAW,EACZ,MAAM,2BAA2B,CAAC;AASnC,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;;;GAKG;AACH,qBAAa,UAAW,YAAW,QAAQ;IACzC,OAAO,CAAC,MAAM,CAAW;IACzB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,QAAQ,CAAS;IAEzB,YAAY,OAAO,EAAE,iBAAiB,EAKrC;IAED,OAAO,CAAC,UAAU;IAUlB,OAAO,CAAC,SAAS;IAWV,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,aAAa,CAAC,UAAU,CAAC,CA6C1E;IAEK,KAAK,CACT,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,aAAa,CAAC,UAAU,CAAC,GACxD,OAAO,CAAC,IAAI,CAAC,CAkHf;IAEK,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAYvC;IAEM,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,aAAa,CAAC,QAAQ,CAAC,CAiExE;IAEK,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CA+CxD;IAEK,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAG3C;IAEK,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAkE3C;IAEK,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAI3D;IAEK,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAwD3D;CACF"}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@statewalker/webrun-files-s3",
-  "version": "0.5.0",
+  "version": "0.9.0",
   "private": false,
   "type": "module",
-  "description": "S3-backed IFilesApi implementation for webrun-files",
+  "description": "S3-backed FilesApi implementation for webrun-files",
   "homepage": "https://github.com/statewalker/webrun-files",
   "author": {
     "name": "Mikhail Kotelnikov",
@@ -29,21 +29,20 @@
     "src"
   ],
   "dependencies": {
-    "@statewalker/webrun-files": "0.5.0"
+    "@statewalker/webrun-files": "0.9.0"
   },
   "peerDependencies": {
-    "@aws-sdk/client-s3": "^3.0.0"
+    "@aws-sdk/client-s3": "^3.1032.0"
   },
   "devDependencies": {
-    "@aws-sdk/client-s3": "^3.0.0",
-    "@testcontainers/minio": "^10.0.0",
-    "@types/node": "^24.10.1",
-    "rimraf": "^6.1.2",
-    "rolldown": "^1.0.0-beta.53",
-    "testcontainers": "^10.0.0",
-    "typescript": "^5.6.0",
-    "vitest": "^4.0.12",
-    "@statewalker/webrun-files-tests": "1.0.0"
+    "@aws-sdk/client-s3": "^3.1110.0",
+    "@types/node": "^26.2.0",
+    "rimraf": "^6.1.3",
+    "rolldown": "^1.2.4",
+    "testcontainers": "^12.1.0",
+    "typescript": "^7.0.2",
+    "vitest": "^4.1.10",
+    "@statewalker/webrun-files-tests": "2.0.0"
   },
   "sideEffects": false,
   "publishConfig": {
@@ -51,7 +50,8 @@
   },
   "scripts": {
     "build": "rimraf dist && rolldown -c && tsc --emitDeclarationOnly --declaration",
-    "test": "vitest run",
-    "lint": "biome lint src tests"
+    "lint": "biome lint src tests",
+    "test": "vitest run --passWithNoTests",
+    "test:integration": "vitest run --config vitest.integration.config.ts"
   }
 }

package/src/index.ts

@@ -1,6 +1,5 @@
 /**
- * webrun-files-s3 - S3-backed IFilesApi implementation
+ * webrun-files-s3 - S3-backed FilesApi implementation
  */
 
 export { S3FilesApi, type S3FilesApiOptions } from "./s3-files-api.js";
-export { S3FileHandle, type S3FileHandleOptions } from "./s3-file-handle.js";