@flystorage/file-storage 0.1.7 → 1.0.1

package/changelog.md

@@ -0,0 +1,13 @@
+# `@flystorage/file-storage`
+
+## 1.0.1
+
+### Fixes
+
+- Corrected error message for `UnableToGetChecksum` error.
+
+## 1.0.0
+
+### Major Changes
+
+- First 1.0.0 release

package/dist/cjs/checksum-from-stream.js

@@ -2,14 +2,22 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.checksumFromStream = checksumFromStream;
 const crypto_1 = require("crypto");
+const util_1 = require("util");
+const encoder = new util_1.TextEncoder();
 async function checksumFromStream(stream, options) {
-    return new Promise(async (resolve, reject) => {
+    return new Promise((resolve, reject) => {
         const hash = (0, crypto_1.createHash)(options.algo ?? 'md5');
-        stream.on('error', reject);
-        stream.pipe(hash, { end: false });
-        stream.on('end', () => {
-            hash.end();
-            resolve(hash.digest(options.encoding ?? 'hex'));
+        stream.on('error', err => reject(err));
+        stream.on('data', (chunk) => {
+            const type = typeof chunk;
+            if (type === 'string') {
+                chunk = encoder.encode(chunk);
+            }
+            else if (type === 'number') {
+                chunk = new Uint8Array([chunk]);
+            }
+            hash.update(chunk);
         });
+        stream.on('end', () => resolve(hash.digest(options.encoding ?? 'hex')));
     });
 }

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.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 = void 0;
+exports.UnableToListDirectory = exports.UnableToCheckDirectoryExistence = exports.UnableToCheckFileExistence = exports.UnableToDeleteFile = exports.UnableToDeleteDirectory = exports.UnableToCreateDirectory = exports.UnableToGetStat = exports.UnableToMoveFile = exports.UnableToCopyFile = exports.UnableToPrepareUploadRequest = exports.UnableToGetTemporaryUrl = exports.UnableToGetPublicUrl = exports.UnableToGetVisibility = exports.UnableToSetVisibility = exports.UnableToReadFile = exports.UnableToWriteFile = exports.UnableToGetFileSize = exports.UnableToGetLastModified = exports.UnableToGetMimeType = exports.UnableToGetChecksum = exports.ChecksumIsNotAvailable = exports.FlystorageError = void 0;
 exports.errorToMessage = errorToMessage;
 function errorToMessage(error) {
     return error instanceof Error ? error.message : String(error);
@@ -28,11 +28,14 @@ class ChecksumIsNotAvailable extends FlystorageError {
         this.algo = algo;
     }
     static checksumNotSupported = (algo, { context = {}, cause = undefined } = {}) => new ChecksumIsNotAvailable(`Checksum algo "${algo}" is not supported`, algo, { ...context, algo }, cause);
+    static isErrorOfType(error) {
+        return (typeof error === 'object' && error.code === 'flystorage.checksum_not_supported');
+    }
 }
 exports.ChecksumIsNotAvailable = ChecksumIsNotAvailable;
 class UnableToGetChecksum extends FlystorageError {
     code = 'flystorage.unable_to_get_checksum';
-    static because = (reason, { context = {}, cause = undefined }) => new UnableToGetChecksum(`Unable to write the file. Reason: ${reason}`, context, cause);
+    static because = (reason, { context = {}, cause = undefined }) => new UnableToGetChecksum(`Unable to get checksum for file. Reason: ${reason}`, context, cause);
 }
 exports.UnableToGetChecksum = UnableToGetChecksum;
 class UnableToGetMimeType extends FlystorageError {
@@ -80,6 +83,11 @@ 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 UnableToPrepareUploadRequest extends FlystorageError {
+    code = 'flystorage.unable_to_prepare_upload_request';
+    static because = (reason, { context = {}, cause = undefined }) => new UnableToGetTemporaryUrl(`Unable to prepare upload request. Reason: ${reason}`, context, cause);
+}
+exports.UnableToPrepareUploadRequest = UnableToPrepareUploadRequest;
 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);

package/dist/cjs/file-storage.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileStorage = exports.DirectoryListing = void 0;
+exports.PreparedUploadsAreNotSupported = exports.FileStorage = exports.DirectoryListing = void 0;
 exports.isFile = isFile;
 exports.isDirectory = isDirectory;
 exports.toReadable = toReadable;
@@ -11,10 +11,9 @@ exports.readableToString = readableToString;
 exports.readableToUint8Array = readableToUint8Array;
 const stream_1 = require("stream");
 const checksum_from_stream_js_1 = require("./checksum-from-stream.js");
-const errors = require("./errors.js");
-const errors_js_1 = require("./errors.js");
 const path_normalizer_js_1 = require("./path-normalizer.js");
 const util_1 = require("util");
+const errors_js_1 = require("./errors.js");
 function isFile(stat) {
     return stat.isFile;
 }
@@ -55,7 +54,7 @@ class DirectoryListing {
             }
         }
         catch (error) {
-            throw errors.UnableToListDirectory.because(errors.errorToMessage(error), { cause: error, context: { path: this.path, deep: this.deep } });
+            throw errors_js_1.UnableToListDirectory.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path: this.path, deep: this.deep } });
         }
     }
 }
@@ -86,7 +85,7 @@ class FileStorage {
             await closeReadable(body);
         }
         catch (error) {
-            throw errors.UnableToWriteFile.because(errors.errorToMessage(error), { cause: error, context: { path, options } });
+            throw errors_js_1.UnableToWriteFile.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path, options } });
         }
     }
     async read(path) {
@@ -94,7 +93,7 @@ class FileStorage {
             return stream_1.Readable.from(await this.adapter.read(this.pathNormalizer.normalizePath(path)));
         }
         catch (error) {
-            throw errors.UnableToReadFile.because(errors.errorToMessage(error), { cause: error, context: { path } });
+            throw errors_js_1.UnableToReadFile.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path } });
         }
     }
     async readToString(path) {
@@ -111,7 +110,7 @@ class FileStorage {
             await this.adapter.deleteFile(this.pathNormalizer.normalizePath(path));
         }
         catch (error) {
-            throw errors.UnableToDeleteFile.because(errors.errorToMessage(error), { cause: error, context: { path } });
+            throw errors_js_1.UnableToDeleteFile.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path } });
         }
     }
     async createDirectory(path, options = {}) {
@@ -119,7 +118,7 @@ class FileStorage {
             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 } });
+            throw errors_js_1.UnableToCreateDirectory.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path, options } });
         }
     }
     async deleteDirectory(path) {
@@ -127,7 +126,7 @@ class FileStorage {
             return await this.adapter.deleteDirectory(this.pathNormalizer.normalizePath(path));
         }
         catch (error) {
-            throw errors.UnableToDeleteDirectory.because(errors.errorToMessage(error), { cause: error, context: { path } });
+            throw errors_js_1.UnableToDeleteDirectory.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path } });
         }
     }
     async stat(path) {
@@ -135,7 +134,7 @@ class FileStorage {
             return await this.adapter.stat(this.pathNormalizer.normalizePath(path));
         }
         catch (error) {
-            throw errors.UnableToGetStat.because(errors.errorToMessage(error), { cause: error, context: { path } });
+            throw errors_js_1.UnableToGetStat.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path } });
         }
     }
     async moveFile(from, to, options = {}) {
@@ -143,7 +142,7 @@ class FileStorage {
             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 } });
+            throw errors_js_1.UnableToMoveFile.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { from, to } });
         }
     }
     async copyFile(from, to, options = {}) {
@@ -151,7 +150,7 @@ class FileStorage {
             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 } });
+            throw errors_js_1.UnableToCopyFile.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { from, to } });
         }
     }
     /**
@@ -165,7 +164,7 @@ class FileStorage {
             return await this.adapter.changeVisibility(this.pathNormalizer.normalizePath(path), visibility);
         }
         catch (error) {
-            throw errors.UnableToSetVisibility.because(errors.errorToMessage(error), { cause: error, context: { path, visibility } });
+            throw errors_js_1.UnableToSetVisibility.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path, visibility } });
         }
     }
     async visibility(path) {
@@ -173,7 +172,7 @@ class FileStorage {
             return await this.adapter.visibility(this.pathNormalizer.normalizePath(path));
         }
         catch (error) {
-            throw errors.UnableToGetVisibility.because(errors.errorToMessage(error), { cause: error, context: { path } });
+            throw errors_js_1.UnableToGetVisibility.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path } });
         }
     }
     async fileExists(path) {
@@ -181,7 +180,7 @@ class FileStorage {
             return await this.adapter.fileExists(this.pathNormalizer.normalizePath(path));
         }
         catch (error) {
-            throw errors.UnableToCheckFileExistence.because(errors.errorToMessage(error), { cause: error, context: { path } });
+            throw errors_js_1.UnableToCheckFileExistence.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path } });
         }
     }
     list(path, { deep = false } = {}) {
@@ -192,14 +191,14 @@ class FileStorage {
         if (isFile(stat)) {
             return stat;
         }
-        throw errors.UnableToGetStat.noFileStatResolved({ context: { path } });
+        throw errors_js_1.UnableToGetStat.noFileStatResolved({ context: { path } });
     }
     async directoryExists(path) {
         try {
             return await this.adapter.directoryExists(this.pathNormalizer.normalizePath(path));
         }
         catch (error) {
-            throw errors.UnableToCheckDirectoryExistence.because(errors.errorToMessage(error), { cause: error, context: { path } });
+            throw errors_js_1.UnableToCheckDirectoryExistence.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path } });
         }
     }
     async publicUrl(path, options = {}) {
@@ -207,7 +206,7 @@ class FileStorage {
             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 } });
+            throw errors_js_1.UnableToGetPublicUrl.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path, options } });
         }
     }
     async temporaryUrl(path, options) {
@@ -215,7 +214,26 @@ class FileStorage {
             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 } });
+            throw errors_js_1.UnableToGetTemporaryUrl.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path, options } });
+        }
+    }
+    async prepareUpload(path, options) {
+        if (this.options.preparedUploadStrategy !== undefined) {
+            try {
+                return this.options.preparedUploadStrategy.prepareUpload(path, options);
+            }
+            catch (error) {
+                throw errors_js_1.UnableToPrepareUploadRequest.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path, options } });
+            }
+        }
+        if (typeof this.adapter.prepareUpload !== 'function') {
+            throw new Error('The used adapter does not support prepared uploads.');
+        }
+        try {
+            return await this.adapter.prepareUpload(this.pathNormalizer.normalizePath(path), { ...this.options.uploadRequest, ...options });
+        }
+        catch (error) {
+            throw errors_js_1.UnableToPrepareUploadRequest.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path, options } });
         }
     }
     async checksum(path, options = {}) {
@@ -223,10 +241,10 @@ class FileStorage {
             return await this.adapter.checksum(this.pathNormalizer.normalizePath(path), { ...this.options.checksums, ...options });
         }
         catch (error) {
-            if (error instanceof errors_js_1.ChecksumIsNotAvailable) {
+            if (errors_js_1.ChecksumIsNotAvailable.isErrorOfType(error)) {
                 return this.calculateChecksum(path, options);
             }
-            throw errors.UnableToGetChecksum.because(errors.errorToMessage(error), { cause: error, context: { path, options } });
+            throw errors_js_1.UnableToGetChecksum.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path, options } });
         }
     }
     async mimeType(path, options = {}) {
@@ -234,7 +252,7 @@ class FileStorage {
             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 } });
+            throw errors_js_1.UnableToGetMimeType.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path, options } });
         }
     }
     async lastModified(path) {
@@ -242,7 +260,7 @@ class FileStorage {
             return await this.adapter.lastModified(this.pathNormalizer.normalizePath(path));
         }
         catch (error) {
-            throw errors.UnableToGetLastModified.because(errors.errorToMessage(error), { cause: error, context: { path } });
+            throw errors_js_1.UnableToGetLastModified.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path } });
         }
     }
     async fileSize(path) {
@@ -250,7 +268,7 @@ class FileStorage {
             return await this.adapter.fileSize(this.pathNormalizer.normalizePath(path));
         }
         catch (error) {
-            throw errors.UnableToGetFileSize.because(errors.errorToMessage(error), { cause: error, context: { path } });
+            throw errors_js_1.UnableToGetFileSize.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path } });
         }
     }
     async calculateChecksum(path, options) {
@@ -258,7 +276,7 @@ class FileStorage {
             return await (0, checksum_from_stream_js_1.checksumFromStream)(await this.read(path), options);
         }
         catch (error) {
-            throw errors.UnableToGetChecksum.because(errors.errorToMessage(error), { cause: error, context: { path, options } });
+            throw errors_js_1.UnableToGetChecksum.because((0, errors_js_1.errorToMessage)(error), { cause: error, context: { path, options } });
         }
     }
 }
@@ -314,3 +332,9 @@ function concatUint8Arrays(input) {
     });
     return output;
 }
+class PreparedUploadsAreNotSupported {
+    prepareUpload() {
+        throw new Error('The used adapter does not support prepared uploads.');
+    }
+}
+exports.PreparedUploadsAreNotSupported = PreparedUploadsAreNotSupported;

package/dist/esm/checksum-from-stream.js

@@ -1,12 +1,20 @@
 import { createHash } from 'crypto';
+import { TextEncoder } from 'util';
+const encoder = new TextEncoder();
 export async function checksumFromStream(stream, options) {
-    return new Promise(async (resolve, reject) => {
+    return new Promise((resolve, reject) => {
         const hash = createHash(options.algo ?? 'md5');
-        stream.on('error', reject);
-        stream.pipe(hash, { end: false });
-        stream.on('end', () => {
-            hash.end();
-            resolve(hash.digest(options.encoding ?? 'hex'));
+        stream.on('error', err => reject(err));
+        stream.on('data', (chunk) => {
+            const type = typeof chunk;
+            if (type === 'string') {
+                chunk = encoder.encode(chunk);
+            }
+            else if (type === 'number') {
+                chunk = new Uint8Array([chunk]);
+            }
+            hash.update(chunk);
         });
+        stream.on('end', () => resolve(hash.digest(options.encoding ?? 'hex')));
     });
 }

package/dist/esm/errors.js

@@ -23,10 +23,13 @@ export class ChecksumIsNotAvailable extends FlystorageError {
         this.algo = algo;
     }
     static checksumNotSupported = (algo, { context = {}, cause = undefined } = {}) => new ChecksumIsNotAvailable(`Checksum algo "${algo}" is not supported`, algo, { ...context, algo }, cause);
+    static isErrorOfType(error) {
+        return (typeof error === 'object' && error.code === 'flystorage.checksum_not_supported');
+    }
 }
 export class UnableToGetChecksum extends FlystorageError {
     code = 'flystorage.unable_to_get_checksum';
-    static because = (reason, { context = {}, cause = undefined }) => new UnableToGetChecksum(`Unable to write the file. Reason: ${reason}`, context, cause);
+    static because = (reason, { context = {}, cause = undefined }) => new UnableToGetChecksum(`Unable to get checksum for file. Reason: ${reason}`, context, cause);
 }
 export class UnableToGetMimeType extends FlystorageError {
     code = 'flystorage.unable_to_get_mimetype';
@@ -64,6 +67,10 @@ 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 UnableToPrepareUploadRequest extends FlystorageError {
+    code = 'flystorage.unable_to_prepare_upload_request';
+    static because = (reason, { context = {}, cause = undefined }) => new UnableToGetTemporaryUrl(`Unable to prepare upload request. 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);

package/dist/esm/file-storage.js

@@ -1,9 +1,8 @@
 import { Readable } from 'stream';
 import { checksumFromStream } from './checksum-from-stream.js';
-import * as errors from './errors.js';
-import { ChecksumIsNotAvailable } from './errors.js';
 import { PathNormalizerV1 } from './path-normalizer.js';
 import { TextEncoder } from "util";
+import { ChecksumIsNotAvailable, errorToMessage, UnableToCheckDirectoryExistence, UnableToCheckFileExistence, UnableToCopyFile, UnableToCreateDirectory, UnableToDeleteDirectory, UnableToDeleteFile, UnableToGetChecksum, UnableToGetFileSize, UnableToGetLastModified, UnableToGetMimeType, UnableToGetPublicUrl, UnableToGetStat, UnableToGetTemporaryUrl, UnableToGetVisibility, UnableToListDirectory, UnableToMoveFile, UnableToPrepareUploadRequest, UnableToReadFile, UnableToSetVisibility, UnableToWriteFile, } from './errors.js';
 export function isFile(stat) {
     return stat.isFile;
 }
@@ -44,7 +43,7 @@ export class DirectoryListing {
             }
         }
         catch (error) {
-            throw errors.UnableToListDirectory.because(errors.errorToMessage(error), { cause: error, context: { path: this.path, deep: this.deep } });
+            throw UnableToListDirectory.because(errorToMessage(error), { cause: error, context: { path: this.path, deep: this.deep } });
         }
     }
 }
@@ -74,7 +73,7 @@ export class FileStorage {
             await closeReadable(body);
         }
         catch (error) {
-            throw errors.UnableToWriteFile.because(errors.errorToMessage(error), { cause: error, context: { path, options } });
+            throw UnableToWriteFile.because(errorToMessage(error), { cause: error, context: { path, options } });
         }
     }
     async read(path) {
@@ -82,7 +81,7 @@ export class FileStorage {
             return Readable.from(await this.adapter.read(this.pathNormalizer.normalizePath(path)));
         }
         catch (error) {
-            throw errors.UnableToReadFile.because(errors.errorToMessage(error), { cause: error, context: { path } });
+            throw UnableToReadFile.because(errorToMessage(error), { cause: error, context: { path } });
         }
     }
     async readToString(path) {
@@ -99,7 +98,7 @@ export class FileStorage {
             await this.adapter.deleteFile(this.pathNormalizer.normalizePath(path));
         }
         catch (error) {
-            throw errors.UnableToDeleteFile.because(errors.errorToMessage(error), { cause: error, context: { path } });
+            throw UnableToDeleteFile.because(errorToMessage(error), { cause: error, context: { path } });
         }
     }
     async createDirectory(path, options = {}) {
@@ -107,7 +106,7 @@ export class FileStorage {
             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 } });
+            throw UnableToCreateDirectory.because(errorToMessage(error), { cause: error, context: { path, options } });
         }
     }
     async deleteDirectory(path) {
@@ -115,7 +114,7 @@ export class FileStorage {
             return await this.adapter.deleteDirectory(this.pathNormalizer.normalizePath(path));
         }
         catch (error) {
-            throw errors.UnableToDeleteDirectory.because(errors.errorToMessage(error), { cause: error, context: { path } });
+            throw UnableToDeleteDirectory.because(errorToMessage(error), { cause: error, context: { path } });
         }
     }
     async stat(path) {
@@ -123,7 +122,7 @@ export class FileStorage {
             return await this.adapter.stat(this.pathNormalizer.normalizePath(path));
         }
         catch (error) {
-            throw errors.UnableToGetStat.because(errors.errorToMessage(error), { cause: error, context: { path } });
+            throw UnableToGetStat.because(errorToMessage(error), { cause: error, context: { path } });
         }
     }
     async moveFile(from, to, options = {}) {
@@ -131,7 +130,7 @@ export class FileStorage {
             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 } });
+            throw UnableToMoveFile.because(errorToMessage(error), { cause: error, context: { from, to } });
         }
     }
     async copyFile(from, to, options = {}) {
@@ -139,7 +138,7 @@ export class FileStorage {
             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 } });
+            throw UnableToCopyFile.because(errorToMessage(error), { cause: error, context: { from, to } });
         }
     }
     /**
@@ -153,7 +152,7 @@ export class FileStorage {
             return await this.adapter.changeVisibility(this.pathNormalizer.normalizePath(path), visibility);
         }
         catch (error) {
-            throw errors.UnableToSetVisibility.because(errors.errorToMessage(error), { cause: error, context: { path, visibility } });
+            throw UnableToSetVisibility.because(errorToMessage(error), { cause: error, context: { path, visibility } });
         }
     }
     async visibility(path) {
@@ -161,7 +160,7 @@ export class FileStorage {
             return await this.adapter.visibility(this.pathNormalizer.normalizePath(path));
         }
         catch (error) {
-            throw errors.UnableToGetVisibility.because(errors.errorToMessage(error), { cause: error, context: { path } });
+            throw UnableToGetVisibility.because(errorToMessage(error), { cause: error, context: { path } });
         }
     }
     async fileExists(path) {
@@ -169,7 +168,7 @@ export class FileStorage {
             return await this.adapter.fileExists(this.pathNormalizer.normalizePath(path));
         }
         catch (error) {
-            throw errors.UnableToCheckFileExistence.because(errors.errorToMessage(error), { cause: error, context: { path } });
+            throw UnableToCheckFileExistence.because(errorToMessage(error), { cause: error, context: { path } });
         }
     }
     list(path, { deep = false } = {}) {
@@ -180,14 +179,14 @@ export class FileStorage {
         if (isFile(stat)) {
             return stat;
         }
-        throw errors.UnableToGetStat.noFileStatResolved({ context: { path } });
+        throw UnableToGetStat.noFileStatResolved({ context: { path } });
     }
     async directoryExists(path) {
         try {
             return await this.adapter.directoryExists(this.pathNormalizer.normalizePath(path));
         }
         catch (error) {
-            throw errors.UnableToCheckDirectoryExistence.because(errors.errorToMessage(error), { cause: error, context: { path } });
+            throw UnableToCheckDirectoryExistence.because(errorToMessage(error), { cause: error, context: { path } });
         }
     }
     async publicUrl(path, options = {}) {
@@ -195,7 +194,7 @@ export class FileStorage {
             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 } });
+            throw UnableToGetPublicUrl.because(errorToMessage(error), { cause: error, context: { path, options } });
         }
     }
     async temporaryUrl(path, options) {
@@ -203,7 +202,26 @@ export class FileStorage {
             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 } });
+            throw UnableToGetTemporaryUrl.because(errorToMessage(error), { cause: error, context: { path, options } });
+        }
+    }
+    async prepareUpload(path, options) {
+        if (this.options.preparedUploadStrategy !== undefined) {
+            try {
+                return this.options.preparedUploadStrategy.prepareUpload(path, options);
+            }
+            catch (error) {
+                throw UnableToPrepareUploadRequest.because(errorToMessage(error), { cause: error, context: { path, options } });
+            }
+        }
+        if (typeof this.adapter.prepareUpload !== 'function') {
+            throw new Error('The used adapter does not support prepared uploads.');
+        }
+        try {
+            return await this.adapter.prepareUpload(this.pathNormalizer.normalizePath(path), { ...this.options.uploadRequest, ...options });
+        }
+        catch (error) {
+            throw UnableToPrepareUploadRequest.because(errorToMessage(error), { cause: error, context: { path, options } });
         }
     }
     async checksum(path, options = {}) {
@@ -211,10 +229,10 @@ export class FileStorage {
             return await this.adapter.checksum(this.pathNormalizer.normalizePath(path), { ...this.options.checksums, ...options });
         }
         catch (error) {
-            if (error instanceof ChecksumIsNotAvailable) {
+            if (ChecksumIsNotAvailable.isErrorOfType(error)) {
                 return this.calculateChecksum(path, options);
             }
-            throw errors.UnableToGetChecksum.because(errors.errorToMessage(error), { cause: error, context: { path, options } });
+            throw UnableToGetChecksum.because(errorToMessage(error), { cause: error, context: { path, options } });
         }
     }
     async mimeType(path, options = {}) {
@@ -222,7 +240,7 @@ export class FileStorage {
             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 } });
+            throw UnableToGetMimeType.because(errorToMessage(error), { cause: error, context: { path, options } });
         }
     }
     async lastModified(path) {
@@ -230,7 +248,7 @@ export class FileStorage {
             return await this.adapter.lastModified(this.pathNormalizer.normalizePath(path));
         }
         catch (error) {
-            throw errors.UnableToGetLastModified.because(errors.errorToMessage(error), { cause: error, context: { path } });
+            throw UnableToGetLastModified.because(errorToMessage(error), { cause: error, context: { path } });
         }
     }
     async fileSize(path) {
@@ -238,7 +256,7 @@ export class FileStorage {
             return await this.adapter.fileSize(this.pathNormalizer.normalizePath(path));
         }
         catch (error) {
-            throw errors.UnableToGetFileSize.because(errors.errorToMessage(error), { cause: error, context: { path } });
+            throw UnableToGetFileSize.because(errorToMessage(error), { cause: error, context: { path } });
         }
     }
     async calculateChecksum(path, options) {
@@ -246,7 +264,7 @@ export class FileStorage {
             return await checksumFromStream(await this.read(path), options);
         }
         catch (error) {
-            throw errors.UnableToGetChecksum.because(errors.errorToMessage(error), { cause: error, context: { path, options } });
+            throw UnableToGetChecksum.because(errorToMessage(error), { cause: error, context: { path, options } });
         }
     }
 }
@@ -301,3 +319,8 @@ function concatUint8Arrays(input) {
     });
     return output;
 }
+export class PreparedUploadsAreNotSupported {
+    prepareUpload() {
+        throw new Error('The used adapter does not support prepared uploads.');
+    }
+}

package/dist/types/errors.d.ts

@@ -23,6 +23,7 @@ export declare class ChecksumIsNotAvailable extends FlystorageError {
         context?: ErrorContext;
         cause?: unknown;
     }) => ChecksumIsNotAvailable;
+    static isErrorOfType(error: unknown): error is ChecksumIsNotAvailable;
 }
 export declare class UnableToGetChecksum extends FlystorageError {
     readonly code = "flystorage.unable_to_get_checksum";
@@ -94,6 +95,13 @@ export declare class UnableToGetTemporaryUrl extends FlystorageError {
         cause?: unknown;
     }) => UnableToGetTemporaryUrl;
 }
+export declare class UnableToPrepareUploadRequest extends FlystorageError {
+    readonly code = "flystorage.unable_to_prepare_upload_request";
+    static because: (reason: string, { context, cause }: {
+        context?: ErrorContext;
+        cause?: unknown;
+    }) => UnableToGetTemporaryUrl;
+}
 export declare class UnableToCopyFile extends FlystorageError {
     readonly code = "flystorage.unable_to_copy_file";
     static because: (reason: string, { context, cause }: {

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

@@ -39,6 +39,7 @@ export interface StorageAdapter {
     directoryExists(path: string): Promise<boolean>;
     publicUrl(path: string, options: PublicUrlOptions): Promise<string>;
     temporaryUrl(path: string, options: TemporaryUrlOptions): Promise<string>;
+    prepareUpload?(path: string, options: UploadRequestOptions): Promise<UploadRequest>;
     checksum(path: string, options: ChecksumOptions): Promise<string>;
     mimeType(path: string, options: MimeTypeOptions): Promise<string>;
     lastModified(path: string): Promise<number>;
@@ -72,6 +73,11 @@ export type WriteOptions = VisibilityOptions & MiscellaneousOptions & {
 };
 export type CreateDirectoryOptions = MiscellaneousOptions & Pick<VisibilityOptions, 'directoryVisibility'> & {};
 export type PublicUrlOptions = MiscellaneousOptions & {};
+export type UploadRequestOptions = MiscellaneousOptions & {
+    expiresAt: ExpiresAt;
+    contentType?: string;
+    headers?: UploadRequestHeaders;
+};
 export type CopyFileOptions = MiscellaneousOptions & VisibilityOptions & {
     retainVisibility?: boolean;
 };
@@ -98,8 +104,10 @@ export type ConfigurationOptions = {
     copies?: CopyFileOptions;
     publicUrls?: PublicUrlOptions;
     temporaryUrls?: TemporaryUrlOptions;
+    uploadRequest?: UploadRequestOptions;
     checksums?: ChecksumOptions;
     mimeTypes?: MimeTypeOptions;
+    preparedUploadStrategy?: PreparedUploadStrategy;
 };
 export declare function toReadable(contents: FileContents): Readable;
 export declare class FileStorage {
@@ -130,6 +138,7 @@ export declare class FileStorage {
     directoryExists(path: string): Promise<boolean>;
     publicUrl(path: string, options?: PublicUrlOptions): Promise<string>;
     temporaryUrl(path: string, options: TemporaryUrlOptions): Promise<string>;
+    prepareUpload(path: string, options: UploadRequestOptions): Promise<UploadRequest>;
     checksum(path: string, options?: ChecksumOptions): Promise<string>;
     mimeType(path: string, options?: MimeTypeOptions): Promise<string>;
     lastModified(path: string): Promise<number>;
@@ -143,3 +152,16 @@ export declare function normalizeExpiryToMilliseconds(expiresAt: ExpiresAt): num
 export declare function closeReadable(body: Readable): Promise<void>;
 export declare function readableToString(stream: Readable): Promise<string>;
 export declare function readableToUint8Array(stream: Readable): Promise<Uint8Array>;
+export type UploadRequestHeaders = Record<string, string | ReadonlyArray<string>>;
+export type UploadRequest = {
+    url: string;
+    provider?: string;
+    method: 'PUT' | 'POST';
+    headers: UploadRequestHeaders;
+};
+export interface PreparedUploadStrategy {
+    prepareUpload(path: string, options: UploadRequestOptions): Promise<UploadRequest>;
+}
+export declare class PreparedUploadsAreNotSupported implements PreparedUploadStrategy {
+    prepareUpload(): Promise<UploadRequest>;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@flystorage/file-storage",
   "type": "module",
-  "version": "0.1.7",
+  "version": "1.0.1",
   "description": "File-storage abstraction: multiple filesystems, one API.",
   "main": "./dist/cjs/index.js",
   "types": "./dist/types/index.d.ts",