@maestro-js/file-storage 1.0.0-alpha.1 → 1.0.0-alpha.11

package/dist/index.d.ts

@@ -1,7 +1,6 @@
 import { Iso } from 'iso-fns2';
 import { Readable } from 'node:stream';
 import { ReadableStream } from 'node:stream/web';
-import { File } from 'node:buffer';
 import { S3Client } from '@aws-sdk/client-s3';
 
 interface Driver<TemporaryUrlParams> {
@@ -31,8 +30,9 @@ interface Driver<TemporaryUrlParams> {
     removeDirectory(directory: string): Promise<void>;
 }
 
-declare function createLocalDriver<TemporaryUrlParams>({ pathPrefix, buildTemporaryUrlsUsing }: {
+declare function createLocalDriver<TemporaryUrlParams>({ pathPrefix, urlPrefix, buildTemporaryUrlsUsing }: {
     pathPrefix?: string;
+    urlPrefix?: string;
     buildTemporaryUrlsUsing?(path: string, expiration: Iso.Instant, params?: TemporaryUrlParams): string | Promise<string>;
 }): Driver<TemporaryUrlParams>;
 
@@ -43,6 +43,12 @@ declare function createS3Driver({ client, bucket, prefix, url: baseUrl }: {
     url?: string;
 }): Driver<void>;
 
+interface FileInput {
+    name: string;
+    type: string;
+    stream(): ReadableStream | globalThis.ReadableStream;
+}
+
 declare function create(config: FileStorage.Provider.FileStorageServiceConfig): FileStorage.FileStorageService;
 type KeysWithFallback = keyof FileStorage.Provider.Keys extends never ? {
     default: unknown;
@@ -69,8 +75,8 @@ declare function provider(key: FileStorage.Provider.Key): {
     append: (path: string, contents: string | Buffer | Readable | ReadableStream) => Promise<void>;
     copy: (source: string, destination: string) => Promise<void>;
     move: (source: string, destination: string) => Promise<void>;
-    putFileAs: (dir: string, file: File, filename: string) => Promise<string>;
-    putFile: (dir: string, file: File) => Promise<string>;
+    putFileAs: (dir: string, file: FileInput, filename: string) => Promise<string>;
+    putFile: (dir: string, file: FileInput) => Promise<string>;
     remove: (...paths: string[]) => Promise<void>;
     files: (directory: string) => Promise<string[]>;
     allFiles: (directory: string) => Promise<string[]>;
@@ -106,8 +112,8 @@ declare const FileStorage: {
     append: (path: string, contents: string | Buffer | Readable | ReadableStream) => Promise<void>;
     copy: (source: string, destination: string) => Promise<void>;
     move: (source: string, destination: string) => Promise<void>;
-    putFileAs: (dir: string, file: File, filename: string) => Promise<string>;
-    putFile: (dir: string, file: File) => Promise<string>;
+    putFileAs: (dir: string, file: FileInput, filename: string) => Promise<string>;
+    putFile: (dir: string, file: FileInput) => Promise<string>;
     remove: (...paths: string[]) => Promise<void>;
     files: (directory: string) => Promise<string[]>;
     allFiles: (directory: string) => Promise<string[]>;
@@ -144,8 +150,8 @@ declare namespace FileStorage {
         append(path: string, contents: string | Buffer | Readable | ReadableStream): Promise<void>;
         copy(source: string, destination: string): Promise<void>;
         move(source: string, destination: string): Promise<void>;
-        putFileAs(dir: string, file: File, filename: string): Promise<string>;
-        putFile(dir: string, file: File): Promise<string>;
+        putFileAs(dir: string, file: FileInput, filename: string): Promise<string>;
+        putFile(dir: string, file: FileInput): Promise<string>;
         remove(...paths: string[]): Promise<void>;
         files(directory: string): Promise<string[]>;
         allFiles(directory: string): Promise<string[]>;

package/dist/index.js

@@ -9,7 +9,6 @@ import "stream";
 import "stream/web";
 
 // src/index.ts
-import "buffer";
 import { randomUUID as randomUUID2 } from "crypto";
 import mimeTypes from "mime-types";
 
@@ -73,6 +72,7 @@ import stream from "stream";
 import { lookup } from "mime-types";
 function createLocalDriver({
   pathPrefix = "storage",
+  urlPrefix = "/files",
   buildTemporaryUrlsUsing
 }) {
   return {
@@ -88,7 +88,7 @@ function createLocalDriver({
       }
     },
     url(path) {
-      return nodePath.join(pathPrefix, path);
+      return `${urlPrefix}/${path}`;
     },
     async temporaryUrl(path, expiration, params) {
       if (buildTemporaryUrlsUsing) {
@@ -115,24 +115,32 @@ function createLocalDriver({
       return nodePath.resolve(nodePath.join(pathPrefix, path));
     },
     async put(path, contents) {
-      await fs.writeFile(nodePath.join(pathPrefix, path), contents);
+      const fullPath = nodePath.join(pathPrefix, path);
+      await fs.mkdir(nodePath.dirname(fullPath), { recursive: true });
+      await fs.writeFile(fullPath, contents);
     },
     async prepend(path, contents) {
       await prepend(nodePath.join(pathPrefix, path), contents);
     },
     async append(path, contents) {
+      const fullPath = nodePath.join(pathPrefix, path);
+      await fs.mkdir(nodePath.dirname(fullPath), { recursive: true });
       if (Buffer.isBuffer(contents) || typeof contents == "string") {
-        await fs.appendFile(nodePath.join(pathPrefix, path), contents);
+        await fs.appendFile(fullPath, contents);
       } else {
-        const writeStream2 = createWriteStream(nodePath.join(pathPrefix, path), { flags: "a" });
+        const writeStream2 = createWriteStream(fullPath, { flags: "a" });
         await promiseStream.pipeline(contents, writeStream2);
       }
     },
     async copy(source, destination) {
-      await fs.copyFile(nodePath.join(pathPrefix, source), nodePath.join(pathPrefix, destination));
+      const destPath = nodePath.join(pathPrefix, destination);
+      await fs.mkdir(nodePath.dirname(destPath), { recursive: true });
+      await fs.copyFile(nodePath.join(pathPrefix, source), destPath);
     },
     async move(source, destination) {
-      await fs.rename(nodePath.join(pathPrefix, source), nodePath.join(pathPrefix, destination));
+      const destPath = nodePath.join(pathPrefix, destination);
+      await fs.mkdir(nodePath.dirname(destPath), { recursive: true });
+      await fs.rename(nodePath.join(pathPrefix, source), destPath);
     },
     async remove(...paths) {
       await Promise.all(paths.map((p) => fs.rm(nodePath.join(pathPrefix, p))));

package/package.json

@@ -7,7 +7,7 @@
       "default": "./dist/index.js"
     }
   },
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.11",
   "publishConfig": {
     "access": "restricted"
   },
@@ -15,14 +15,17 @@
     "dist"
   ],
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.750.0",
-    "@aws-sdk/s3-request-presigner": "^3.750.0",
     "iso-fns2": "npm:iso-fns@2.0.0-alpha.26",
     "mime-types": "^2.1.35",
-    "@maestro-js/service-registry": "1.0.0-alpha.1",
-    "@maestro-js/crypt": "1.0.0-alpha.1"
+    "@maestro-js/service-registry": "1.0.0-alpha.11"
+  },
+  "peerDependencies": {
+    "@aws-sdk/client-s3": "^3.750.0",
+    "@aws-sdk/s3-request-presigner": "^3.750.0"
   },
   "devDependencies": {
+    "@aws-sdk/client-s3": "^3.750.0",
+    "@aws-sdk/s3-request-presigner": "^3.750.0",
     "@types/node": "^22.19.11",
     "@types/mime-types": "^2.1.4"
   },