@flystorage/file-storage 0.0.6 → 0.0.8

package/README.md

@@ -33,10 +33,8 @@ to, simply because they cannot be abstracted over in a reasonable manner.
 - [x] Mime-type resolving
 - [x] Last modified fetching
 - [x] File size
-
-### Planned
-- [ ] Moving files
-- [ ] Copying files
+- [x] Moving files
+- [x] Copying files
 
 ## Implementations / Adapters
 

package/dist/cjs/errors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnableToListDirectory = exports.UnableToCheckDirectoryExistence = exports.UnableToCheckFileExistence = exports.UnableToDeleteFile = exports.UnableToDeleteDirectory = exports.UnableToCreateDirectory = exports.UnableToGetStat = exports.UnableToGetTemporaryUrl = exports.UnableToGetPublicUrl = exports.UnableToGetVisibility = exports.UnableToSetVisibility = exports.UnableToReadFile = exports.UnableToWriteFile = exports.UnableToGetFileSize = exports.UnableToGetLastModified = exports.UnableToGetMimeType = exports.UnableToGetChecksum = exports.ChecksumIsNotAvailable = exports.FlystorageError = exports.errorToMessage = void 0;
+exports.UnableToListDirectory = exports.UnableToCheckDirectoryExistence = exports.UnableToCheckFileExistence = exports.UnableToDeleteFile = exports.UnableToDeleteDirectory = exports.UnableToCreateDirectory = exports.UnableToGetStat = exports.UnableToMoveFile = exports.UnableToCopyFile = exports.UnableToGetTemporaryUrl = exports.UnableToGetPublicUrl = exports.UnableToGetVisibility = exports.UnableToSetVisibility = exports.UnableToReadFile = exports.UnableToWriteFile = exports.UnableToGetFileSize = exports.UnableToGetLastModified = exports.UnableToGetMimeType = exports.UnableToGetChecksum = exports.ChecksumIsNotAvailable = exports.FlystorageError = exports.errorToMessage = void 0;
 function errorToMessage(error) {
     return error instanceof Error ? error.message : String(error);
 }
@@ -80,6 +80,16 @@ class UnableToGetTemporaryUrl extends FlystorageError {
     static because = (reason, { context = {}, cause = undefined }) => new UnableToGetTemporaryUrl(`Unable to get temporary URL. Reason: ${reason}`, context, cause);
 }
 exports.UnableToGetTemporaryUrl = UnableToGetTemporaryUrl;
+class UnableToCopyFile extends FlystorageError {
+    code = 'flystorage.unable_to_copy_file';
+    static because = (reason, { context = {}, cause = undefined }) => new UnableToCopyFile(`Unable to copy file. Reason: ${reason}`, context, cause);
+}
+exports.UnableToCopyFile = UnableToCopyFile;
+class UnableToMoveFile extends FlystorageError {
+    code = 'flystorage.unable_to_move_file';
+    static because = (reason, { context = {}, cause = undefined }) => new UnableToMoveFile(`Unable to move file. Reason: ${reason}`, context, cause);
+}
+exports.UnableToMoveFile = UnableToMoveFile;
 class UnableToGetStat extends FlystorageError {
     code = 'flystorage.unable_to_get_stat';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToGetStat(`Unable to get stat. Reason: ${reason}`, context, cause);

package/dist/cjs/file-storage.js

@@ -75,7 +75,7 @@ class FileStorage {
     async write(path, contents, options = {}) {
         try {
             const body = toReadable(contents);
-            await this.adapter.write(this.pathNormalizer.normalizePath(path), body, Object.assign({}, this.options.writes || {}, options));
+            await this.adapter.write(this.pathNormalizer.normalizePath(path), body, { ...this.options.visibility, ...this.options.writes, ...options });
             await closeReadable(body);
         }
         catch (error) {
@@ -109,7 +109,7 @@ class FileStorage {
     }
     async createDirectory(path, options = {}) {
         try {
-            return await this.adapter.createDirectory(this.pathNormalizer.normalizePath(path), options);
+            return await this.adapter.createDirectory(this.pathNormalizer.normalizePath(path), { ...this.options.visibility, ...options });
         }
         catch (error) {
             throw errors.UnableToCreateDirectory.because(errors.errorToMessage(error), { cause: error, context: { path, options } });
@@ -131,6 +131,22 @@ class FileStorage {
             throw errors.UnableToGetStat.because(errors.errorToMessage(error), { cause: error, context: { path } });
         }
     }
+    async moveFile(from, to, options = {}) {
+        try {
+            await this.adapter.moveFile(this.pathNormalizer.normalizePath(from), this.pathNormalizer.normalizePath(to), { ...this.options.visibility, ...this.options.moves, ...options });
+        }
+        catch (error) {
+            throw errors.UnableToMoveFile.because(errors.errorToMessage(error), { cause: error, context: { from, to } });
+        }
+    }
+    async copyFile(from, to, options = {}) {
+        try {
+            await this.adapter.copyFile(this.pathNormalizer.normalizePath(from), this.pathNormalizer.normalizePath(to), { ...this.options.visibility, ...this.options.copies, ...options });
+        }
+        catch (error) {
+            throw errors.UnableToCopyFile.because(errors.errorToMessage(error), { cause: error, context: { from, to } });
+        }
+    }
     async setVisibility(path, visibility) {
         try {
             return await this.adapter.changeVisibility(this.pathNormalizer.normalizePath(path), visibility);
@@ -175,7 +191,7 @@ class FileStorage {
     }
     async publicUrl(path, options = {}) {
         try {
-            return await this.adapter.publicUrl(this.pathNormalizer.normalizePath(path), options);
+            return await this.adapter.publicUrl(this.pathNormalizer.normalizePath(path), { ...this.options.publicUrls, ...options });
         }
         catch (error) {
             throw errors.UnableToGetPublicUrl.because(errors.errorToMessage(error), { cause: error, context: { path, options } });
@@ -183,7 +199,7 @@ class FileStorage {
     }
     async temporaryUrl(path, options) {
         try {
-            return await this.adapter.temporaryUrl(this.pathNormalizer.normalizePath(path), options);
+            return await this.adapter.temporaryUrl(this.pathNormalizer.normalizePath(path), { ...this.options.temporaryUrls, ...options });
         }
         catch (error) {
             throw errors.UnableToGetTemporaryUrl.because(errors.errorToMessage(error), { cause: error, context: { path, options } });
@@ -191,7 +207,7 @@ class FileStorage {
     }
     async checksum(path, options = {}) {
         try {
-            return await this.adapter.checksum(this.pathNormalizer.normalizePath(path), options);
+            return await this.adapter.checksum(this.pathNormalizer.normalizePath(path), { ...this.options.checksums, ...options });
         }
         catch (error) {
             if (error instanceof errors_js_1.ChecksumIsNotAvailable) {
@@ -202,7 +218,7 @@ class FileStorage {
     }
     async mimeType(path, options = {}) {
         try {
-            return await this.adapter.mimeType(this.pathNormalizer.normalizePath(path), options);
+            return await this.adapter.mimeType(this.pathNormalizer.normalizePath(path), { ...this.options.mimeTypes, ...options });
         }
         catch (error) {
             throw errors.UnableToGetMimeType.because(errors.errorToMessage(error), { cause: error, context: { path, options } });

package/dist/esm/errors.js

@@ -64,6 +64,14 @@ export class UnableToGetTemporaryUrl extends FlystorageError {
     code = 'flystorage.unable_to_get_temporary_url';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToGetTemporaryUrl(`Unable to get temporary URL. Reason: ${reason}`, context, cause);
 }
+export class UnableToCopyFile extends FlystorageError {
+    code = 'flystorage.unable_to_copy_file';
+    static because = (reason, { context = {}, cause = undefined }) => new UnableToCopyFile(`Unable to copy file. Reason: ${reason}`, context, cause);
+}
+export class UnableToMoveFile extends FlystorageError {
+    code = 'flystorage.unable_to_move_file';
+    static because = (reason, { context = {}, cause = undefined }) => new UnableToMoveFile(`Unable to move file. Reason: ${reason}`, context, cause);
+}
 export class UnableToGetStat extends FlystorageError {
     code = 'flystorage.unable_to_get_stat';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToGetStat(`Unable to get stat. Reason: ${reason}`, context, cause);

package/dist/esm/file-storage.js

@@ -69,7 +69,7 @@ export class FileStorage {
     async write(path, contents, options = {}) {
         try {
             const body = toReadable(contents);
-            await this.adapter.write(this.pathNormalizer.normalizePath(path), body, Object.assign({}, this.options.writes || {}, options));
+            await this.adapter.write(this.pathNormalizer.normalizePath(path), body, { ...this.options.visibility, ...this.options.writes, ...options });
             await closeReadable(body);
         }
         catch (error) {
@@ -103,7 +103,7 @@ export class FileStorage {
     }
     async createDirectory(path, options = {}) {
         try {
-            return await this.adapter.createDirectory(this.pathNormalizer.normalizePath(path), options);
+            return await this.adapter.createDirectory(this.pathNormalizer.normalizePath(path), { ...this.options.visibility, ...options });
         }
         catch (error) {
             throw errors.UnableToCreateDirectory.because(errors.errorToMessage(error), { cause: error, context: { path, options } });
@@ -125,6 +125,22 @@ export class FileStorage {
             throw errors.UnableToGetStat.because(errors.errorToMessage(error), { cause: error, context: { path } });
         }
     }
+    async moveFile(from, to, options = {}) {
+        try {
+            await this.adapter.moveFile(this.pathNormalizer.normalizePath(from), this.pathNormalizer.normalizePath(to), { ...this.options.visibility, ...this.options.moves, ...options });
+        }
+        catch (error) {
+            throw errors.UnableToMoveFile.because(errors.errorToMessage(error), { cause: error, context: { from, to } });
+        }
+    }
+    async copyFile(from, to, options = {}) {
+        try {
+            await this.adapter.copyFile(this.pathNormalizer.normalizePath(from), this.pathNormalizer.normalizePath(to), { ...this.options.visibility, ...this.options.copies, ...options });
+        }
+        catch (error) {
+            throw errors.UnableToCopyFile.because(errors.errorToMessage(error), { cause: error, context: { from, to } });
+        }
+    }
     async setVisibility(path, visibility) {
         try {
             return await this.adapter.changeVisibility(this.pathNormalizer.normalizePath(path), visibility);
@@ -169,7 +185,7 @@ export class FileStorage {
     }
     async publicUrl(path, options = {}) {
         try {
-            return await this.adapter.publicUrl(this.pathNormalizer.normalizePath(path), options);
+            return await this.adapter.publicUrl(this.pathNormalizer.normalizePath(path), { ...this.options.publicUrls, ...options });
         }
         catch (error) {
             throw errors.UnableToGetPublicUrl.because(errors.errorToMessage(error), { cause: error, context: { path, options } });
@@ -177,7 +193,7 @@ export class FileStorage {
     }
     async temporaryUrl(path, options) {
         try {
-            return await this.adapter.temporaryUrl(this.pathNormalizer.normalizePath(path), options);
+            return await this.adapter.temporaryUrl(this.pathNormalizer.normalizePath(path), { ...this.options.temporaryUrls, ...options });
         }
         catch (error) {
             throw errors.UnableToGetTemporaryUrl.because(errors.errorToMessage(error), { cause: error, context: { path, options } });
@@ -185,7 +201,7 @@ export class FileStorage {
     }
     async checksum(path, options = {}) {
         try {
-            return await this.adapter.checksum(this.pathNormalizer.normalizePath(path), options);
+            return await this.adapter.checksum(this.pathNormalizer.normalizePath(path), { ...this.options.checksums, ...options });
         }
         catch (error) {
             if (error instanceof ChecksumIsNotAvailable) {
@@ -196,7 +212,7 @@ export class FileStorage {
     }
     async mimeType(path, options = {}) {
         try {
-            return await this.adapter.mimeType(this.pathNormalizer.normalizePath(path), options);
+            return await this.adapter.mimeType(this.pathNormalizer.normalizePath(path), { ...this.options.mimeTypes, ...options });
         }
         catch (error) {
             throw errors.UnableToGetMimeType.because(errors.errorToMessage(error), { cause: error, context: { path, options } });

package/dist/types/errors.d.ts

@@ -94,6 +94,20 @@ export declare class UnableToGetTemporaryUrl extends FlystorageError {
         cause?: unknown;
     }) => UnableToGetTemporaryUrl;
 }
+export declare class UnableToCopyFile extends FlystorageError {
+    readonly code = "flystorage.unable_to_copy_file";
+    static because: (reason: string, { context, cause }: {
+        context?: ErrorContext | undefined;
+        cause?: unknown;
+    }) => UnableToCopyFile;
+}
+export declare class UnableToMoveFile extends FlystorageError {
+    readonly code = "flystorage.unable_to_move_file";
+    static because: (reason: string, { context, cause }: {
+        context?: ErrorContext | undefined;
+        cause?: unknown;
+    }) => UnableToMoveFile;
+}
 export declare class UnableToGetStat extends FlystorageError {
     readonly code = "flystorage.unable_to_get_stat";
     static because: (reason: string, { context, cause }: {

package/dist/types/file-storage.d.ts

@@ -30,6 +30,8 @@ export interface StorageAdapter {
     read(path: string): Promise<FileContents>;
     deleteFile(path: string): Promise<void>;
     createDirectory(path: string, options: CreateDirectoryOptions): Promise<void>;
+    copyFile(from: string, to: string, options: CopyFileOptions): Promise<void>;
+    moveFile(from: string, to: string, options: MoveFileOptions): Promise<void>;
     stat(path: string): Promise<StatEntry>;
     list(path: string, options: {
         deep: boolean;
@@ -73,6 +75,15 @@ export type WriteOptions = VisibilityOptions & MiscellaneousOptions & {
 };
 export type CreateDirectoryOptions = MiscellaneousOptions & Pick<VisibilityOptions, 'directoryVisibility'> & {};
 export type PublicUrlOptions = MiscellaneousOptions & {};
+export type CopyFileOptions = MiscellaneousOptions & VisibilityOptions & {
+    retainVisibility?: boolean;
+};
+export type MoveFileOptions = MiscellaneousOptions & VisibilityOptions & {
+    retainVisibility?: boolean;
+};
+export type ListOptions = {
+    deep?: boolean;
+};
 export type TemporaryUrlOptions = MiscellaneousOptions & {
     expiresAt: ExpiresAt;
 };
@@ -81,8 +92,14 @@ export type ChecksumOptions = MiscellaneousOptions & {
     encoding?: BinaryToTextEncoding;
 };
 export type ConfigurationOptions = {
-    defaults?: VisibilityOptions;
+    visibility?: VisibilityOptions;
     writes?: WriteOptions;
+    moves?: MoveFileOptions;
+    copies?: CopyFileOptions;
+    publicUrls?: PublicUrlOptions;
+    temporaryUrls?: TemporaryUrlOptions;
+    checksums?: ChecksumOptions;
+    mimeTypes?: MimeTypeOptions;
 };
 export declare class FileStorage {
     private readonly adapter;
@@ -98,12 +115,12 @@ export declare class FileStorage {
     createDirectory(path: string, options?: CreateDirectoryOptions): Promise<void>;
     deleteDirectory(path: string): Promise<void>;
     stat(path: string): Promise<StatEntry>;
+    moveFile(from: string, to: string, options?: MoveFileOptions): Promise<void>;
+    copyFile(from: string, to: string, options?: CopyFileOptions): Promise<void>;
     setVisibility(path: string, visibility: string): Promise<void>;
     visibility(path: string): Promise<string>;
     fileExists(path: string): Promise<boolean>;
-    list(path: string, { deep }?: {
-        deep?: boolean;
-    }): DirectoryListing;
+    list(path: string, { deep }?: ListOptions): DirectoryListing;
     statFile(path: string): Promise<FileInfo>;
     directoryExists(path: string): Promise<boolean>;
     publicUrl(path: string, options?: PublicUrlOptions): Promise<string>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@flystorage/file-storage",
   "type": "module",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "File-storage abstraction: multiple filesystems, one API.",
   "main": "./dist/cjs/index.js",
   "types": "./dist/types/index.d.ts",
@@ -27,9 +27,16 @@
   "author": "Frank de Jonge (https://frankdejonge.nl)",
   "repository": {
     "type": "git",
-    "url": "https://github.com/flystorage/flystorage.git",
+    "url": "git+https://github.com/flystorage/flystorage.git",
     "directory": "packages/file-storage"
   },
-  "keywords": ["fs", "file", "files", "filesystem", "filesystems", "storage"],
+  "keywords": [
+    "fs",
+    "file",
+    "files",
+    "filesystem",
+    "filesystems",
+    "storage"
+  ],
   "license": "MIT"
 }