@flystorage/file-storage 0.1.0 → 0.1.2

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2023-2024 Frank de Jonge
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -1,4 +1,4 @@
-<img src="https://avatars.githubusercontent.com/u/151840999" width="50px" height="50px" />
+<img src="https://raw.githubusercontent.com/duna-oss/flystorage/main/flystorage.svg" width="50px" height="50px" />
 
 # Flystorage
 Flystorage is a file storage abstraction for NodeJS and TypeScript. It is an 80/20 solution
@@ -39,12 +39,12 @@ to, simply because they cannot be abstracted over in a reasonable manner.
 ## Implementations / Adapters
 
 ### Implemented
-- [x] Local Filesystem
-- [x] AWS S3 (using the V3 SDK)
-- [x] Azure Blob Storage
-- [x] Test implementation (in-memory)
-- [x] Google Cloud Storage
-- [x] Chaos adapter decorator
+- [x] [Local Filesystem](https://www.npmjs.com/package/@flystorage/local-fs)
+- [x] [AWS S3 (using the V3 SDK)](https://www.npmjs.com/package/@flystorage/aws-s3)
+- [x] [Azure Blob Storage](https://www.npmjs.com/package/@flystorage/azure-storage-blob)
+- [x] [Test implementation (in-memory)](https://www.npmjs.com/package/@flystorage/in-memory)
+- [x] [Google Cloud Storage](https://www.npmjs.com/package/@flystorage/google-cloud-storage)
+- [x] [Chaos adapter decorator](https://www.npmjs.com/package/@flystorage/chaos)
 
 ### Planned
 - [ ] FTP (using `basic-ftp`)
@@ -75,7 +75,7 @@ import {LocalStorageAdapter} from '@flystorage/local-fs';
  **/
 
 const rootDirectory = resolve(process.cwd(), 'my-files');
-const storage = new FileStorage(new LocalFileStorage(rootDirectory));
+const storage = new FileStorage(new LocalStorageAdapter(rootDirectory));
 
 /**
  * USAGE

package/dist/cjs/path-prefixer.js

@@ -3,17 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PathPrefixer = void 0;
 const node_path_1 = require("node:path");
 class PathPrefixer {
+    separator;
+    joinFunc;
     prefix = '';
-    constructor(prefix = '') {
+    constructor(prefix = '', separator = '/', joinFunc = node_path_1.join) {
+        this.separator = separator;
+        this.joinFunc = joinFunc;
         if (prefix.length > 0) {
-            this.prefix = (0, node_path_1.join)(prefix, '/');
+            this.prefix = this.joinFunc(prefix, this.separator);
         }
     }
     prefixFilePath(path) {
-        return this.prefix.length > 0 ? (0, node_path_1.join)(this.prefix, path) : path;
+        return this.prefix.length > 0 ? this.joinFunc(this.prefix, path) : path;
     }
     prefixDirectoryPath(path) {
-        return this.prefix.length > 0 ? (0, node_path_1.join)(this.prefix, path, '/') : (0, node_path_1.join)(path, '/');
+        return this.prefix.length > 0 ? this.joinFunc(this.prefix, path, '/') : this.joinFunc(path, '/');
     }
     stripFilePath(path) {
         return path.substring(this.prefix.length);

package/dist/esm/path-prefixer.js

@@ -1,16 +1,20 @@
 import { join } from 'node:path';
 export class PathPrefixer {
+    separator;
+    joinFunc;
     prefix = '';
-    constructor(prefix = '') {
+    constructor(prefix = '', separator = '/', joinFunc = join) {
+        this.separator = separator;
+        this.joinFunc = joinFunc;
         if (prefix.length > 0) {
-            this.prefix = join(prefix, '/');
+            this.prefix = this.joinFunc(prefix, this.separator);
         }
     }
     prefixFilePath(path) {
-        return this.prefix.length > 0 ? join(this.prefix, path) : path;
+        return this.prefix.length > 0 ? this.joinFunc(this.prefix, path) : path;
     }
     prefixDirectoryPath(path) {
-        return this.prefix.length > 0 ? join(this.prefix, path, '/') : join(path, '/');
+        return this.prefix.length > 0 ? this.joinFunc(this.prefix, path, '/') : this.joinFunc(path, '/');
     }
     stripFilePath(path) {
         return path.substring(this.prefix.length);

package/dist/types/errors.d.ts

@@ -20,144 +20,144 @@ export declare class ChecksumIsNotAvailable extends FlystorageError {
     readonly code = "flystorage.checksum_not_supported";
     constructor(message: string, algo: string, context?: ErrorContext, cause?: unknown);
     static checksumNotSupported: (algo: string, { context, cause }?: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         cause?: unknown;
     }) => ChecksumIsNotAvailable;
 }
 export declare class UnableToGetChecksum extends FlystorageError {
     readonly code = "flystorage.unable_to_get_checksum";
     static because: (reason: string, { context, cause }: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         cause?: unknown;
     }) => UnableToGetChecksum;
 }
 export declare class UnableToGetMimeType extends FlystorageError {
     readonly code = "flystorage.unable_to_get_mimetype";
     static because: (reason: string, { context, cause }: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         cause?: unknown;
     }) => UnableToGetMimeType;
 }
 export declare class UnableToGetLastModified extends FlystorageError {
     readonly code = "flystorage.unable_to_get_last_modified";
     static because: (reason: string, { context, cause }: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         cause?: unknown;
     }) => UnableToGetLastModified;
 }
 export declare class UnableToGetFileSize extends FlystorageError {
     readonly code = "flystorage.unable_to_get_file_size";
     static because: (reason: string, { context, cause }: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         cause?: unknown;
     }) => UnableToGetFileSize;
 }
 export declare class UnableToWriteFile extends FlystorageError {
     readonly code = "flystorage.unable_to_write_file";
     static because: (reason: string, { context, cause }: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         cause?: unknown;
     }) => UnableToWriteFile;
 }
 export declare class UnableToReadFile extends FlystorageError {
     readonly code = "flystorage.unable_to_read_file";
     static because: (reason: string, { context, cause }: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         cause?: unknown;
     }) => UnableToReadFile;
 }
 export declare class UnableToSetVisibility extends FlystorageError {
     readonly code = "flystorage.unable_to_set_visibility";
     static because: (reason: string, { context, cause }: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         cause?: unknown;
     }) => UnableToSetVisibility;
 }
 export declare class UnableToGetVisibility extends FlystorageError {
     readonly code = "flystorage.unable_to_get_visibility";
     static because: (reason: string, { context, cause }: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         cause?: unknown;
     }) => UnableToGetVisibility;
 }
 export declare class UnableToGetPublicUrl extends FlystorageError {
     readonly code = "flystorage.unable_to_get_public_url";
     static because: (reason: string, { context, cause }: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         cause?: unknown;
     }) => UnableToGetPublicUrl;
 }
 export declare class UnableToGetTemporaryUrl extends FlystorageError {
     readonly code = "flystorage.unable_to_get_temporary_url";
     static because: (reason: string, { context, cause }: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         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;
+        context?: ErrorContext;
         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;
+        context?: ErrorContext;
         cause?: unknown;
     }) => UnableToMoveFile;
 }
 export declare class UnableToGetStat extends FlystorageError {
     readonly code = "flystorage.unable_to_get_stat";
     static because: (reason: string, { context, cause }: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         cause?: unknown;
     }) => UnableToGetStat;
     static noFileStatResolved: ({ context, cause }: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         cause?: unknown;
     }) => UnableToGetStat;
 }
 export declare class UnableToCreateDirectory extends FlystorageError {
     readonly code = "flystorage.unable_to_create_directory";
     static because: (reason: string, { context, cause }: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         cause?: unknown;
     }) => UnableToCreateDirectory;
 }
 export declare class UnableToDeleteDirectory extends FlystorageError {
     readonly code = "flystorage.unable_to_delete_directory";
     static because: (reason: string, { context, cause }: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         cause?: unknown;
     }) => UnableToDeleteDirectory;
 }
 export declare class UnableToDeleteFile extends FlystorageError {
     readonly code = "flystorage.unable_to_delete_file";
     static because: (reason: string, { context, cause }: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         cause?: unknown;
     }) => UnableToDeleteFile;
 }
 export declare class UnableToCheckFileExistence extends FlystorageError {
     readonly code = "flystorage.unable_to_check_file_existence";
     static because: (reason: string, { context, cause }: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         cause?: unknown;
     }) => UnableToCheckFileExistence;
 }
 export declare class UnableToCheckDirectoryExistence extends FlystorageError {
     readonly code = "flystorage.unable_to_check_directory_existence";
     static because: (reason: string, { context, cause }: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         cause?: unknown;
     }) => UnableToCheckDirectoryExistence;
 }
 export declare class UnableToListDirectory extends FlystorageError {
     readonly code = "flystorage.unable_to_list_directory_contents";
     static because: (reason: string, { context, cause }: {
-        context?: ErrorContext | undefined;
+        context?: ErrorContext;
         cause?: unknown;
     }) => UnableToListDirectory;
 }

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

@@ -72,6 +72,7 @@ export type VisibilityOptions = {
 export type WriteOptions = VisibilityOptions & MiscellaneousOptions & {
     mimeType?: string;
     size?: number;
+    cacheControl?: string;
 };
 export type CreateDirectoryOptions = MiscellaneousOptions & Pick<VisibilityOptions, 'directoryVisibility'> & {};
 export type PublicUrlOptions = MiscellaneousOptions & {};

package/dist/types/path-prefixer.d.ts

@@ -1,6 +1,10 @@
+/// <reference types="node" resolution-mode="require"/>
+import { join } from 'node:path';
 export declare class PathPrefixer {
+    private readonly separator;
+    private readonly joinFunc;
     private readonly prefix;
-    constructor(prefix?: string);
+    constructor(prefix?: string, separator?: string, joinFunc?: typeof join);
     prefixFilePath(path: string): string;
     prefixDirectoryPath(path: string): string;
     stripFilePath(path: string): string;

package/package.json

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