@flystorage/file-storage 0.0.9 → 0.1.1

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,6 +1,6 @@
-<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 (work in progress)
+# Flystorage
 Flystorage is a file storage abstraction for NodeJS and TypeScript. It is an 80/20 solution
 that is built around a set of goals:
 
@@ -39,18 +39,14 @@ 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] [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/file-storage)
+- [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
-
-#### Prio 1
-- [ ] Failure decorator (stage errors for tests)
-- [ ] Google Cloud Storage
-
-### Prio 2
 - [ ] FTP (using `basic-ftp`)
 - [ ] SFTP (?)
 
@@ -72,7 +68,7 @@ npm i -S @flystorage/local-fs
 import {resolve} from 'node:path';
 import {createReadStream} from 'node:fs';
 import {FileStorage, Visibility} from '@flystorage/file-storage';
-import {LocalFileStorage} from '@flystorage/local-fs';
+import {LocalStorageAdapter} from '@flystorage/local-fs';
 
 /**
  * SETUP
@@ -122,6 +118,5 @@ await storage.deleteDirectory('some-directory');
 
 ## Author
 Flystorage is built by the maintainer of [Flysystem](https://flysystem.thephpleague.com), a
-filesystem abstraction for PHP. This brings along more than
-a decade of smoothing over filesystem implementation differences
-and weighing trade-offs to make a usable API.
+filesystem abstraction for PHP. This brings along over
+a decade of filesystem abstraction experience.

package/dist/cjs/file-storage.js

@@ -149,7 +149,13 @@ class FileStorage {
             throw errors.UnableToCopyFile.because(errors.errorToMessage(error), { cause: error, context: { from, to } });
         }
     }
+    /**
+     * @deprecated use changeVisibility instead
+     */
     async setVisibility(path, visibility) {
+        return this.changeVisibility(path, visibility);
+    }
+    async changeVisibility(path, visibility) {
         try {
             return await this.adapter.changeVisibility(this.pathNormalizer.normalizePath(path), visibility);
         }

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/file-storage.js

@@ -142,7 +142,13 @@ export class FileStorage {
             throw errors.UnableToCopyFile.because(errors.errorToMessage(error), { cause: error, context: { from, to } });
         }
     }
+    /**
+     * @deprecated use changeVisibility instead
+     */
     async setVisibility(path, visibility) {
+        return this.changeVisibility(path, visibility);
+    }
+    async changeVisibility(path, visibility) {
         try {
             return await this.adapter.changeVisibility(this.pathNormalizer.normalizePath(path), visibility);
         }

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/file-storage.d.ts

@@ -118,7 +118,11 @@ export declare class FileStorage {
     stat(path: string): Promise<StatEntry>;
     moveFile(from: string, to: string, options?: MoveFileOptions): Promise<void>;
     copyFile(from: string, to: string, options?: CopyFileOptions): Promise<void>;
+    /**
+     * @deprecated use changeVisibility instead
+     */
     setVisibility(path: string, visibility: string): Promise<void>;
+    changeVisibility(path: string, visibility: string): Promise<void>;
     visibility(path: string): Promise<string>;
     fileExists(path: string): Promise<boolean>;
     list(path: string, { deep }?: ListOptions): DirectoryListing;

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.0.9",
+  "version": "0.1.1",
   "description": "File-storage abstraction: multiple filesystems, one API.",
   "main": "./dist/cjs/index.js",
   "types": "./dist/types/index.d.ts",