@flystorage/file-storage 0.0.9 → 0.1.0

package/README.md

@@ -1,6 +1,6 @@
 <img src="https://avatars.githubusercontent.com/u/151840999" 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:
 
@@ -43,14 +43,10 @@ to, simply because they cannot be abstracted over in a reasonable manner.
 - [x] AWS S3 (using the V3 SDK)
 - [x] Azure Blob Storage
 - [x] Test implementation (in-memory)
+- [x] Google Cloud Storage
+- [x] Chaos adapter decorator
 
 ### 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/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/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/package.json

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