@flystorage/file-storage 0.1.3 → 0.1.5

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

@@ -1,7 +1,10 @@
-import { createHash } from 'crypto';
-export async function checksumFromStream(stream, options) {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checksumFromStream = checksumFromStream;
+const crypto_1 = require("crypto");
+async function checksumFromStream(stream, options) {
     return new Promise(async (resolve, reject) => {
-        const hash = createHash(options.algo ?? 'md5');
+        const hash = (0, crypto_1.createHash)(options.algo ?? 'md5');
         stream.on('error', reject);
         stream.pipe(hash, { end: false });
         stream.on('end', () => {

package/dist/cjs/errors.js

@@ -1,7 +1,11 @@
-export function errorToMessage(error) {
+"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.errorToMessage = errorToMessage;
+function errorToMessage(error) {
     return error instanceof Error ? error.message : String(error);
 }
-export class FlystorageError extends Error {
+class FlystorageError extends Error {
     context;
     code = 'unknown_error';
     constructor(message, context = {}, cause = undefined) {
@@ -11,11 +15,12 @@ export class FlystorageError extends Error {
         this.context = context;
     }
 }
+exports.FlystorageError = FlystorageError;
 /**
  * Thrown when the checksum algo is not supported or not pre-computed. This error
  * is thrown with the intention of falling back to computing it based on a file read.
  */
-export class ChecksumIsNotAvailable extends FlystorageError {
+class ChecksumIsNotAvailable extends FlystorageError {
     algo;
     code = 'flystorage.checksum_not_supported';
     constructor(message, algo, context = {}, cause = undefined) {
@@ -24,80 +29,100 @@ export class ChecksumIsNotAvailable extends FlystorageError {
     }
     static checksumNotSupported = (algo, { context = {}, cause = undefined } = {}) => new ChecksumIsNotAvailable(`Checksum algo "${algo}" is not supported`, algo, { ...context, algo }, cause);
 }
-export class UnableToGetChecksum extends FlystorageError {
+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);
 }
-export class UnableToGetMimeType extends FlystorageError {
+exports.UnableToGetChecksum = UnableToGetChecksum;
+class UnableToGetMimeType extends FlystorageError {
     code = 'flystorage.unable_to_get_mimetype';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToGetMimeType(`Unable to get mime-type. Reason: ${reason}`, context, cause);
 }
-export class UnableToGetLastModified extends FlystorageError {
+exports.UnableToGetMimeType = UnableToGetMimeType;
+class UnableToGetLastModified extends FlystorageError {
     code = 'flystorage.unable_to_get_last_modified';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToGetLastModified(`Unable to get last modified. Reason: ${reason}`, context, cause);
 }
-export class UnableToGetFileSize extends FlystorageError {
+exports.UnableToGetLastModified = UnableToGetLastModified;
+class UnableToGetFileSize extends FlystorageError {
     code = 'flystorage.unable_to_get_file_size';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToGetFileSize(`Unable to get file size. Reason: ${reason}`, context, cause);
 }
-export class UnableToWriteFile extends FlystorageError {
+exports.UnableToGetFileSize = UnableToGetFileSize;
+class UnableToWriteFile extends FlystorageError {
     code = 'flystorage.unable_to_write_file';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToWriteFile(`Unable to write the file. Reason: ${reason}`, context, cause);
 }
-export class UnableToReadFile extends FlystorageError {
+exports.UnableToWriteFile = UnableToWriteFile;
+class UnableToReadFile extends FlystorageError {
     code = 'flystorage.unable_to_read_file';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToReadFile(`Unable to read the file. Reason: ${reason}`, context, cause);
 }
-export class UnableToSetVisibility extends FlystorageError {
+exports.UnableToReadFile = UnableToReadFile;
+class UnableToSetVisibility extends FlystorageError {
     code = 'flystorage.unable_to_set_visibility';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToSetVisibility(`Unable to set visibility. Reason: ${reason}`, context, cause);
 }
-export class UnableToGetVisibility extends FlystorageError {
+exports.UnableToSetVisibility = UnableToSetVisibility;
+class UnableToGetVisibility extends FlystorageError {
     code = 'flystorage.unable_to_get_visibility';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToGetVisibility(`Unable to get visibility. Reason: ${reason}`, context, cause);
 }
-export class UnableToGetPublicUrl extends FlystorageError {
+exports.UnableToGetVisibility = UnableToGetVisibility;
+class UnableToGetPublicUrl extends FlystorageError {
     code = 'flystorage.unable_to_get_public_url';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToGetPublicUrl(`Unable to get public URL. Reason: ${reason}`, context, cause);
 }
-export class UnableToGetTemporaryUrl extends FlystorageError {
+exports.UnableToGetPublicUrl = UnableToGetPublicUrl;
+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 UnableToCopyFile extends FlystorageError {
+exports.UnableToGetTemporaryUrl = UnableToGetTemporaryUrl;
+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);
 }
-export class UnableToMoveFile extends FlystorageError {
+exports.UnableToCopyFile = UnableToCopyFile;
+class UnableToMoveFile extends FlystorageError {
     code = 'flystorage.unable_to_move_file';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToMoveFile(`Unable to move file. Reason: ${reason}`, context, cause);
 }
-export class UnableToGetStat extends FlystorageError {
+exports.UnableToMoveFile = UnableToMoveFile;
+class UnableToGetStat extends FlystorageError {
     code = 'flystorage.unable_to_get_stat';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToGetStat(`Unable to get stat. Reason: ${reason}`, context, cause);
     static noFileStatResolved = ({ context = {}, cause = undefined }) => new UnableToGetStat(`Stat was not a file.`, context, cause);
 }
-export class UnableToCreateDirectory extends FlystorageError {
+exports.UnableToGetStat = UnableToGetStat;
+class UnableToCreateDirectory extends FlystorageError {
     code = 'flystorage.unable_to_create_directory';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToCreateDirectory(`Unable to create directory. Reason: ${reason}`, context, cause);
 }
-export class UnableToDeleteDirectory extends FlystorageError {
+exports.UnableToCreateDirectory = UnableToCreateDirectory;
+class UnableToDeleteDirectory extends FlystorageError {
     code = 'flystorage.unable_to_delete_directory';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToDeleteDirectory(`Unable to delete directory. Reason: ${reason}`, context, cause);
 }
-export class UnableToDeleteFile extends FlystorageError {
+exports.UnableToDeleteDirectory = UnableToDeleteDirectory;
+class UnableToDeleteFile extends FlystorageError {
     code = 'flystorage.unable_to_delete_file';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToDeleteFile(`Unable to delete file. Reason: ${reason}`, context, cause);
 }
-export class UnableToCheckFileExistence extends FlystorageError {
+exports.UnableToDeleteFile = UnableToDeleteFile;
+class UnableToCheckFileExistence extends FlystorageError {
     code = 'flystorage.unable_to_check_file_existence';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToCheckFileExistence(`Unable to check file existence. Reason: ${reason}`, context, cause);
 }
-export class UnableToCheckDirectoryExistence extends FlystorageError {
+exports.UnableToCheckFileExistence = UnableToCheckFileExistence;
+class UnableToCheckDirectoryExistence extends FlystorageError {
     code = 'flystorage.unable_to_check_directory_existence';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToCheckDirectoryExistence(`Unable to check directory existence. Reason: ${reason}`, context, cause);
 }
-export class UnableToListDirectory extends FlystorageError {
+exports.UnableToCheckDirectoryExistence = UnableToCheckDirectoryExistence;
+class UnableToListDirectory extends FlystorageError {
     code = 'flystorage.unable_to_list_directory_contents';
     static because = (reason, { context = {}, cause = undefined }) => new UnableToListDirectory(`Unable to list directory contents. Reason: ${reason}`, context, cause);
 }
+exports.UnableToListDirectory = UnableToListDirectory;

package/dist/cjs/file-storage.js

@@ -1,16 +1,27 @@
-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";
-export function isFile(stat) {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileStorage = exports.DirectoryListing = void 0;
+exports.isFile = isFile;
+exports.isDirectory = isDirectory;
+exports.toReadable = toReadable;
+exports.normalizeExpiryToDate = normalizeExpiryToDate;
+exports.normalizeExpiryToMilliseconds = normalizeExpiryToMilliseconds;
+exports.closeReadable = closeReadable;
+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");
+function isFile(stat) {
     return stat.isFile;
 }
-export function isDirectory(stat) {
+function isDirectory(stat) {
     return stat.isDirectory;
 }
-export class DirectoryListing {
+class DirectoryListing {
     listing;
     path;
     deep;
@@ -48,21 +59,22 @@ export class DirectoryListing {
         }
     }
 }
-export function toReadable(contents) {
-    if (contents instanceof Readable) {
+exports.DirectoryListing = DirectoryListing;
+function toReadable(contents) {
+    if (contents instanceof stream_1.Readable) {
         return contents;
     }
-    return Readable.from(contents);
+    return stream_1.Readable.from(contents);
 }
 const naturalSorting = new Intl.Collator(undefined, {
     numeric: true,
     sensitivity: 'base'
 });
-export class FileStorage {
+class FileStorage {
     adapter;
     pathNormalizer;
     options;
-    constructor(adapter, pathNormalizer = new PathNormalizerV1(), options = {}) {
+    constructor(adapter, pathNormalizer = new path_normalizer_js_1.PathNormalizerV1(), options = {}) {
         this.adapter = adapter;
         this.pathNormalizer = pathNormalizer;
         this.options = options;
@@ -79,7 +91,7 @@ export class FileStorage {
     }
     async read(path) {
         try {
-            return Readable.from(await this.adapter.read(this.pathNormalizer.normalizePath(path)));
+            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 } });
@@ -211,7 +223,7 @@ export class FileStorage {
             return await this.adapter.checksum(this.pathNormalizer.normalizePath(path), { ...this.options.checksums, ...options });
         }
         catch (error) {
-            if (error instanceof ChecksumIsNotAvailable) {
+            if (error instanceof errors_js_1.ChecksumIsNotAvailable) {
                 return this.calculateChecksum(path, options);
             }
             throw errors.UnableToGetChecksum.because(errors.errorToMessage(error), { cause: error, context: { path, options } });
@@ -243,20 +255,21 @@ export class FileStorage {
     }
     async calculateChecksum(path, options) {
         try {
-            return await checksumFromStream(await this.read(path), options);
+            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 } });
         }
     }
 }
-export function normalizeExpiryToDate(expiresAt) {
+exports.FileStorage = FileStorage;
+function normalizeExpiryToDate(expiresAt) {
     return expiresAt instanceof Date ? expiresAt : new Date(expiresAt);
 }
-export function normalizeExpiryToMilliseconds(expiresAt) {
+function normalizeExpiryToMilliseconds(expiresAt) {
     return expiresAt instanceof Date ? expiresAt.getTime() : expiresAt;
 }
-export async function closeReadable(body) {
+async function closeReadable(body) {
     if (body.closed) {
         return;
     }
@@ -268,13 +281,13 @@ export async function closeReadable(body) {
     });
 }
 const decoder = new TextDecoder();
-export async function readableToString(stream) {
+async function readableToString(stream) {
     const contents = decoder.decode(await readableToUint8Array(stream));
     await closeReadable(stream);
     return contents;
 }
-const encoder = new TextEncoder();
-export function readableToUint8Array(stream) {
+const encoder = new util_1.TextEncoder();
+function readableToUint8Array(stream) {
     return new Promise((resolve, reject) => {
         const parts = [];
         stream.on('data', (chunk) => {

package/dist/cjs/index.js

@@ -1,6 +1,22 @@
-export * from './checksum-from-stream.js';
-export * from './file-storage.js';
-export * from './errors.js';
-export * from './path-normalizer.js';
-export * from './path-prefixer.js';
-export * from './portable-visibility.js';
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./checksum-from-stream.js"), exports);
+__exportStar(require("./file-storage.js"), exports);
+__exportStar(require("./errors.js"), exports);
+__exportStar(require("./path-normalizer.js"), exports);
+__exportStar(require("./path-prefixer.js"), exports);
+__exportStar(require("./portable-visibility.js"), exports);

package/dist/cjs/path-normalizer.js

@@ -1,20 +1,26 @@
-import { join } from 'node:path';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PathTraversalDetected = exports.CorruptedPathDetected = exports.PathNormalizerV1 = void 0;
+const node_path_1 = require("node:path");
 const funkyWhiteSpaceRegex = new RegExp('\\p{C}+', 'u');
-export class PathNormalizerV1 {
+class PathNormalizerV1 {
     normalizePath(path) {
         if (funkyWhiteSpaceRegex.test(path)) {
             throw CorruptedPathDetected.unexpectedWhitespace(path);
         }
-        const normalized = join(...(path.split('/')));
+        const normalized = (0, node_path_1.join)(...(path.split('/')));
         if (normalized.indexOf('../') !== -1 || normalized == '..') {
             throw PathTraversalDetected.forPath(path);
         }
         return normalized === '.' ? '' : normalized;
     }
 }
-export class CorruptedPathDetected extends Error {
+exports.PathNormalizerV1 = PathNormalizerV1;
+class CorruptedPathDetected extends Error {
     static unexpectedWhitespace = (path) => new CorruptedPathDetected(`Corrupted path detected with unexpected whitespace: ${path}`);
 }
-export class PathTraversalDetected extends Error {
+exports.CorruptedPathDetected = CorruptedPathDetected;
+class PathTraversalDetected extends Error {
     static forPath = (path) => new PathTraversalDetected(`Path traversal detected for: ${path}`);
 }
+exports.PathTraversalDetected = PathTraversalDetected;

package/dist/cjs/path-prefixer.js

@@ -1,9 +1,12 @@
-import { join } from 'node:path';
-export class PathPrefixer {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PathPrefixer = void 0;
+const node_path_1 = require("node:path");
+class PathPrefixer {
     separator;
     joinFunc;
     prefix = '';
-    constructor(prefix = '', separator = '/', joinFunc = join) {
+    constructor(prefix = '', separator = '/', joinFunc = node_path_1.join) {
         this.separator = separator;
         this.joinFunc = joinFunc;
         if (prefix.length > 0) {
@@ -23,3 +26,4 @@ export class PathPrefixer {
         return this.stripFilePath(path).replace(/\/+$/g, '');
     }
 }
+exports.PathPrefixer = PathPrefixer;

package/dist/cjs/portable-visibility.js

@@ -1,5 +1,8 @@
-export var Visibility;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Visibility = void 0;
+var Visibility;
 (function (Visibility) {
     Visibility["PUBLIC"] = "public";
     Visibility["PRIVATE"] = "private";
-})(Visibility || (Visibility = {}));
+})(Visibility || (exports.Visibility = Visibility = {}));

package/dist/types/checksum-from-stream.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
 import { BinaryToTextEncoding } from 'crypto';
 import { Readable } from 'node:stream';
 export declare function checksumFromStream(stream: Readable, options: {

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

@@ -1,7 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
 import { BinaryToTextEncoding } from 'crypto';
 import { Readable } from 'stream';
 import { PathNormalizer } from './path-normalizer.js';
@@ -87,6 +83,9 @@ export type ListOptions = {
 };
 export type TemporaryUrlOptions = MiscellaneousOptions & {
     expiresAt: ExpiresAt;
+    responseHeaders?: {
+        [header: string]: string;
+    };
 };
 export type ChecksumOptions = MiscellaneousOptions & {
     algo?: string;

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

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import { join } from 'node:path';
 export declare class PathPrefixer {
     private readonly separator;

package/package.json

@@ -1,26 +1,26 @@
 {
   "name": "@flystorage/file-storage",
   "type": "module",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "File-storage abstraction: multiple filesystems, one API.",
   "main": "./dist/cjs/index.js",
   "types": "./dist/types/index.d.ts",
   "exports": {
     ".": {
       "import": {
-        "default": "./dist/esm/index.js",
-        "types": "./dist/types/index.d.ts"
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/esm/index.js"
       },
       "require": {
-        "default": "./dist/cjs/index.js",
-        "types": "./dist/types/index.d.ts"
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/cjs/index.js"
       }
     }
   },
   "scripts": {
     "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 node16 --moduleResolution node16",
+    "compile:cjs": "tsc --outDir ./dist/cjs/ --declaration false --module commonjs --moduleResolution node",
     "compile:types": "tsc --outDir ./dist/types/ --declaration --emitDeclarationOnly",
     "watch": "tsc --watch"
   },
@@ -39,4 +39,4 @@
     "storage"
   ],
   "license": "MIT"
-}
+}