@flystorage/file-storage 0.0.8 → 0.1.0

package/README.md

@@ -41,15 +41,12 @@ to, simply because they cannot be abstracted over in a reasonable manner.
 ### 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
 
 ### Planned
-
-#### Prio 1
-- [ ] Azure Blob Storage
-- [ ] Test implementation (in-memory, with staged errors)
-- [ ] Google Cloud Storage
-
-### Prio 2
 - [ ] FTP (using `basic-ftp`)
 - [ ] SFTP (?)
 
@@ -71,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
@@ -121,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

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readableToUint8Array = exports.readableToString = exports.closeReadable = exports.normalizeExpiryToMilliseconds = exports.normalizeExpiryToDate = exports.FileStorage = exports.DirectoryListing = exports.isDirectory = exports.isFile = void 0;
+exports.readableToUint8Array = exports.readableToString = exports.closeReadable = exports.normalizeExpiryToMilliseconds = exports.normalizeExpiryToDate = exports.FileStorage = exports.toReadable = exports.DirectoryListing = exports.isDirectory = exports.isFile = void 0;
 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");
 function isFile(stat) {
     return stat.isFile;
 }
@@ -59,6 +60,7 @@ function toReadable(contents) {
     }
     return stream_1.Readable.from(contents);
 }
+exports.toReadable = toReadable;
 const naturalSorting = new Intl.Collator(undefined, {
     numeric: true,
     sensitivity: 'base'
@@ -147,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);
         }
@@ -272,13 +280,23 @@ async function closeReadable(body) {
 exports.closeReadable = closeReadable;
 const decoder = new TextDecoder();
 async function readableToString(stream) {
-    return decoder.decode(await readableToUint8Array(stream));
+    const contents = decoder.decode(await readableToUint8Array(stream));
+    await closeReadable(stream);
+    return contents;
 }
 exports.readableToString = readableToString;
+const encoder = new util_1.TextEncoder();
 function readableToUint8Array(stream) {
     return new Promise((resolve, reject) => {
         const parts = [];
         stream.on('data', (chunk) => {
+            const type = typeof chunk;
+            if (type === 'string') {
+                chunk = encoder.encode(chunk);
+            }
+            else if (type === 'number') {
+                chunk = new Uint8Array([chunk]);
+            }
             parts.push(chunk);
         });
         stream.on('error', reject);
@@ -287,7 +305,7 @@ function readableToUint8Array(stream) {
 }
 exports.readableToUint8Array = readableToUint8Array;
 function concatUint8Arrays(input) {
-    const length = input.reduce((l, a) => l + a.byteLength, 0);
+    const length = input.reduce((l, a) => l + (a.byteLength), 0);
     const output = new Uint8Array(length);
     let position = 0;
     input.forEach(i => {

package/dist/esm/file-storage.js

@@ -3,6 +3,7 @@ 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";
 export function isFile(stat) {
     return stat.isFile;
 }
@@ -47,7 +48,7 @@ export class DirectoryListing {
         }
     }
 }
-function toReadable(contents) {
+export function toReadable(contents) {
     if (contents instanceof Readable) {
         return contents;
     }
@@ -141,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);
         }
@@ -262,12 +269,22 @@ export async function closeReadable(body) {
 }
 const decoder = new TextDecoder();
 export async function readableToString(stream) {
-    return decoder.decode(await readableToUint8Array(stream));
+    const contents = decoder.decode(await readableToUint8Array(stream));
+    await closeReadable(stream);
+    return contents;
 }
+const encoder = new TextEncoder();
 export function readableToUint8Array(stream) {
     return new Promise((resolve, reject) => {
         const parts = [];
         stream.on('data', (chunk) => {
+            const type = typeof chunk;
+            if (type === 'string') {
+                chunk = encoder.encode(chunk);
+            }
+            else if (type === 'number') {
+                chunk = new Uint8Array([chunk]);
+            }
             parts.push(chunk);
         });
         stream.on('error', reject);
@@ -275,7 +292,7 @@ export function readableToUint8Array(stream) {
     });
 }
 function concatUint8Arrays(input) {
-    const length = input.reduce((l, a) => l + a.byteLength, 0);
+    const length = input.reduce((l, a) => l + (a.byteLength), 0);
     const output = new Uint8Array(length);
     let position = 0;
     input.forEach(i => {

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

@@ -57,7 +57,7 @@ export declare class DirectoryListing implements AsyncIterable<StatEntry> {
     filter(filter: (entry: StatEntry) => boolean): DirectoryListing;
     [Symbol.asyncIterator](): AsyncGenerator<StatEntry, void, unknown>;
 }
-export type FileContents = Iterable<any> | AsyncIterable<any> | NodeJS.ReadableStream | Readable;
+export type FileContents = Iterable<any> | AsyncIterable<any> | NodeJS.ReadableStream | Readable | string;
 export type MiscellaneousOptions = {
     [option: string]: any;
 };
@@ -101,6 +101,7 @@ export type ConfigurationOptions = {
     checksums?: ChecksumOptions;
     mimeTypes?: MimeTypeOptions;
 };
+export declare function toReadable(contents: FileContents): Readable;
 export declare class FileStorage {
     private readonly adapter;
     private readonly pathNormalizer;
@@ -117,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.8",
+  "version": "0.1.0",
   "description": "File-storage abstraction: multiple filesystems, one API.",
   "main": "./dist/cjs/index.js",
   "types": "./dist/types/index.d.ts",
@@ -18,7 +18,7 @@
     }
   },
   "scripts": {
-    "compile": "concurrently npm:compile:* && echo '{\"type\": \"commonjs\"}' > ./dist/cjs/package.json",
+    "compile": "rm -rf ./dist/ && concurrently npm:compile:* && echo '{\"type\": \"commonjs\"}' > ./dist/cjs/package.json",
     "compile:esm": "tsc --outDir ./dist/esm/ --declaration false",
     "compile:cjs": "tsc --outDir ./dist/cjs/ --declaration false --module commonjs --moduleResolution node",
     "compile:types": "tsc --outDir ./dist/types/ --declaration --emitDeclarationOnly",
@@ -27,7 +27,7 @@
   "author": "Frank de Jonge (https://frankdejonge.nl)",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/flystorage/flystorage.git",
+    "url": "git+https://github.com/duna-oss/flystorage.git",
     "directory": "packages/file-storage"
   },
   "keywords": [