@theshelf/filestore 0.1.0 → 0.2.1

package/README.md

@@ -9,64 +9,57 @@ The file store package provides a universal interaction layer with an actual fil
 npm install @theshelf/filestore
 ```
 
-## Implementations
+## Drivers
 
-Currently, there are two implementations:
+Currently, there are two drivers available:
 
 * **Memory** - non-persistent in memory storage (suited for testing).
 * **Minio** - persistent S3 compatible object storage.
 
-## Configuration
+## How to use
 
-The used implementation needs to be configured in the `.env` file.
+The basic set up looks like this.
 
-```env
-FILE_STORE_IMPLEMENTATION="minio" # (memory | minio)
-```
+```ts
+import FileStore, { MemoryDriver | MinioDriver as SelectedDriver } from '@theshelf/fileStore';
 
-In case of Minio, additional configuration is required.
+const driver = new SelectedDriver(/* configuration */);
+const fileStore = new FileStore(driver);
 
-```env
-MINIO_END_POINT="address"
-MINIO_PORT_NUMBER=9000
-MINIO_USE_SSL=true
-MINIO_ACCESS_KEY="development"
-MINIO_SECRET_KEY="secret"
+// Perform operations with the fileStore instance
 ```
 
-## How to use
+### Configuration
 
-An instance of the configured file storage implementation can be imported for performing file operations.
+#### Memory driver
 
-```ts
-import fileStorage from '@theshelf/filestorage';
+No configuration options.
 
-// Perform operations with the fileStorage instance
-```
+#### Minio driver
+
+The `ClientOptions` from the 'minio' package.
 
 ### Operations
 
 ```ts
-import fileStorage from '@theshelf/filestorage';
-
 // Open connection
-await fileStorage.connect();
+await fileStore.connect();
 
 // Close connection
-await fileStorage.disconnect();
+await fileStore.disconnect();
 
 // Check if a file exists
-const exists: boolean = await fileStorage.hasFile('path/to/file.txt');
+const exists: boolean = await fileStore.hasFile('path/to/file.txt');
 
 // Write a file to the storage
 const data: Buffer = Buffer.from('Something interesting');
-await fileStorage.writeFile('path/to/file.txt', data);
+await fileStore.writeFile('path/to/file.txt', data);
 
 // Read a file from storage
 // Throws FileNotFound if not found
-const data: Buffer = await fileStorage.readFile('path/to/file.txt');
+const data: Buffer = await fileStore.readFile('path/to/file.txt');
 
 // Delete a file from storage
 // Throws FileNotFound if not found
-await fileStorage.deleteFile('path/to/file.txt');
+await fileStore.deleteFile('path/to/file.txt');
 ```

package/dist/ConnectionManager.d.ts

@@ -0,0 +1,9 @@
+import type { ConnectionState } from './definitions/constants.js';
+import type { Driver } from './definitions/interfaces.js';
+export default class ConnectionManager {
+    #private;
+    constructor(driver: Driver);
+    get state(): ConnectionState;
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+}

package/dist/ConnectionManager.js

@@ -0,0 +1,53 @@
+import { ConnectionStates } from './definitions/constants.js';
+export default class ConnectionManager {
+    #driver;
+    #state = ConnectionStates.DISCONNECTED;
+    #connectPromise;
+    #disconnectPromise;
+    constructor(driver) {
+        this.#driver = driver;
+    }
+    get state() { return this.#state; }
+    async connect() {
+        if (this.#connectPromise !== undefined) {
+            return this.#connectPromise;
+        }
+        if (this.#state !== ConnectionStates.DISCONNECTED) {
+            return;
+        }
+        this.#state = ConnectionStates.CONNECTING;
+        try {
+            this.#connectPromise = this.#driver.connect();
+            await this.#connectPromise;
+            this.#state = ConnectionStates.CONNECTED;
+        }
+        catch (error) {
+            this.#state = ConnectionStates.DISCONNECTED;
+            throw error;
+        }
+        finally {
+            this.#connectPromise = undefined;
+        }
+    }
+    async disconnect() {
+        if (this.#disconnectPromise !== undefined) {
+            return this.#disconnectPromise;
+        }
+        if (this.#state !== ConnectionStates.CONNECTED) {
+            return;
+        }
+        this.#state = ConnectionStates.DISCONNECTING;
+        try {
+            this.#disconnectPromise = this.#driver.disconnect();
+            await this.#disconnectPromise;
+            this.#state = ConnectionStates.DISCONNECTED;
+        }
+        catch (error) {
+            this.#state = ConnectionStates.CONNECTED;
+            throw error;
+        }
+        finally {
+            this.#disconnectPromise = undefined;
+        }
+    }
+}

package/dist/FileStore.d.ts

@@ -0,0 +1,14 @@
+import type { ConnectionState } from './definitions/constants.js';
+import type { Driver } from './definitions/interfaces.js';
+export default class FileStore implements Driver {
+    #private;
+    constructor(driver: Driver);
+    get connectionState(): ConnectionState;
+    get connected(): boolean;
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    hasFile(path: string): Promise<boolean>;
+    writeFile(path: string, data: Buffer): Promise<void>;
+    readFile(path: string): Promise<Buffer>;
+    deleteFile(path: string): Promise<void>;
+}

package/dist/FileStore.js

@@ -0,0 +1,34 @@
+import { ConnectionStates } from './definitions/constants.js';
+import ConnectionManager from './ConnectionManager.js';
+export default class FileStore {
+    #driver;
+    #connectionManager;
+    constructor(driver) {
+        this.#driver = driver;
+        this.#connectionManager = new ConnectionManager(driver);
+    }
+    get connectionState() {
+        return this.#connectionManager.state;
+    }
+    get connected() {
+        return this.connectionState === ConnectionStates.CONNECTED;
+    }
+    connect() {
+        return this.#connectionManager.connect();
+    }
+    disconnect() {
+        return this.#connectionManager.disconnect();
+    }
+    hasFile(path) {
+        return this.#driver.hasFile(path);
+    }
+    writeFile(path, data) {
+        return this.#driver.writeFile(path, data);
+    }
+    readFile(path) {
+        return this.#driver.readFile(path);
+    }
+    deleteFile(path) {
+        return this.#driver.deleteFile(path);
+    }
+}

package/dist/definitions/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const ConnectionStates: {
+    readonly DISCONNECTED: "DISCONNECTED";
+    readonly DISCONNECTING: "DISCONNECTING";
+    readonly CONNECTING: "CONNECTING";
+    readonly CONNECTED: "CONNECTED";
+};
+export type ConnectionState = typeof ConnectionStates[keyof typeof ConnectionStates];

package/dist/definitions/constants.js

@@ -0,0 +1,6 @@
+export const ConnectionStates = {
+    DISCONNECTED: 'DISCONNECTED',
+    DISCONNECTING: 'DISCONNECTING',
+    CONNECTING: 'CONNECTING',
+    CONNECTED: 'CONNECTED'
+};

package/dist/definitions/interfaces.d.ts

@@ -1,4 +1,4 @@
-export interface FileStore {
+export interface Driver {
     get connected(): boolean;
     connect(): Promise<void>;
     disconnect(): Promise<void>;
@@ -6,5 +6,4 @@ export interface FileStore {
     writeFile(path: string, data: Buffer): Promise<void>;
     readFile(path: string): Promise<Buffer>;
     deleteFile(path: string): Promise<void>;
-    clear(): Promise<void>;
 }

package/dist/{implementations/memory → drivers}/Memory.d.ts

@@ -1,12 +1,13 @@
-import type { FileStore } from '../../definitions/interfaces.js';
-export default class Memory implements FileStore {
+import type { Driver } from '../definitions/interfaces.js';
+export default class Memory implements Driver {
     #private;
     get connected(): boolean;
+    get files(): Map<string, Buffer>;
     connect(): Promise<void>;
     disconnect(): Promise<void>;
     hasFile(path: string): Promise<boolean>;
     writeFile(path: string, data: Buffer): Promise<void>;
     readFile(path: string): Promise<Buffer>;
     deleteFile(path: string): Promise<void>;
-    clear(): Promise<void>;
+    clear(): void;
 }

package/dist/{implementations/memory → drivers}/Memory.js

@@ -1,45 +1,42 @@
-import FileNotFound from '../../errors/FileNotFound.js';
-import NotConnected from '../../errors/NotConnected.js';
+import NotConnected from '../errors/NotConnected.js';
+import FileNotFound from '../errors/FileNotFound.js';
 export default class Memory {
     #files = new Map();
     #connected = false;
     get connected() { return this.#connected; }
+    get files() {
+        if (this.#connected === false) {
+            throw new NotConnected();
+        }
+        return this.#files;
+    }
     async connect() {
         this.#connected = true;
     }
     async disconnect() {
         this.#connected = false;
+        this.#files.clear();
     }
     async hasFile(path) {
-        const files = this.#getFiles();
-        return files.has(path);
+        return this.files.has(path);
     }
     async writeFile(path, data) {
-        const files = this.#getFiles();
-        files.set(path, data);
+        this.files.set(path, data);
     }
     async readFile(path) {
-        const files = this.#getFiles();
-        const data = files.get(path);
+        const data = this.files.get(path);
         if (data === undefined) {
             throw new FileNotFound(path);
         }
         return data;
     }
     async deleteFile(path) {
-        const files = this.#getFiles();
-        if (files.has(path) === false) {
+        if (this.files.has(path) === false) {
             throw new FileNotFound(path);
         }
-        files.delete(path);
+        this.files.delete(path);
     }
-    #getFiles() {
-        if (this.#files === undefined) {
-            throw new NotConnected();
-        }
-        return this.#files;
-    }
-    async clear() {
-        this.#files.clear();
+    clear() {
+        this.files.clear();
     }
 }

package/dist/{implementations/minio/MinioFS.d.ts → drivers/Minio.d.ts}

@@ -1,6 +1,6 @@
 import type { ClientOptions } from 'minio';
-import type { FileStore } from '../../definitions/interfaces.js';
-export default class MinioFS implements FileStore {
+import type { Driver } from '../definitions/interfaces.js';
+export default class Minio implements Driver {
     #private;
     constructor(configuration: ClientOptions);
     get connected(): boolean;
@@ -10,5 +10,4 @@ export default class MinioFS implements FileStore {
     writeFile(path: string, data: Buffer): Promise<void>;
     readFile(path: string): Promise<Buffer>;
     deleteFile(path: string): Promise<void>;
-    clear(): Promise<void>;
 }

package/dist/{implementations/minio/MinioFS.js → drivers/Minio.js}

@@ -1,8 +1,8 @@
 import { Client } from 'minio';
-import FileNotFound from '../../errors/FileNotFound.js';
-import NotConnected from '../../errors/NotConnected.js';
+import FileNotFound from '../errors/FileNotFound.js';
+import NotConnected from '../errors/NotConnected.js';
 const BUCKET_NAME = 'comify';
-export default class MinioFS {
+export default class Minio {
     #configuration;
     #client;
     constructor(configuration) {
@@ -66,9 +66,6 @@ export default class MinioFS {
             throw this.#handleError(error, path);
         }
     }
-    async clear() {
-        return; // Deliberately not implemented
-    }
     #getClient() {
         if (this.#client === undefined) {
             throw new NotConnected();

package/dist/errors/FileNotFound.d.ts

@@ -1,4 +1,4 @@
-import FileSystemError from './FileSystemError.js';
-export default class FileNotFound extends FileSystemError {
+import FileStoreError from './FileStoreError.js';
+export default class FileNotFound extends FileStoreError {
     constructor(path?: string);
 }

package/dist/errors/FileNotFound.js

@@ -1,5 +1,5 @@
-import FileSystemError from './FileSystemError.js';
-export default class FileNotFound extends FileSystemError {
+import FileStoreError from './FileStoreError.js';
+export default class FileNotFound extends FileStoreError {
     constructor(path) {
         super(path ? `File not found: ${path}` : 'File not found');
     }

package/dist/errors/FileStoreError.d.ts

@@ -0,0 +1,3 @@
+export default class FileStoreError extends Error {
+    constructor(message?: string);
+}

package/dist/errors/FileStoreError.js

@@ -0,0 +1,9 @@
+export default class FileStoreError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = this.constructor.name;
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+    }
+}

package/dist/errors/NotConnected.d.ts

@@ -1,4 +1,4 @@
-import FileSystemError from './FileSystemError.js';
-export default class NotConnected extends FileSystemError {
-    constructor(message?: string);
+import FileStoreError from './FileStoreError.js';
+export default class NotConnected extends FileStoreError {
+    constructor();
 }

package/dist/errors/NotConnected.js

@@ -1,6 +1,6 @@
-import FileSystemError from './FileSystemError.js';
-export default class NotConnected extends FileSystemError {
-    constructor(message) {
-        super(message ?? 'File system not connected');
+import FileStoreError from './FileStoreError.js';
+export default class NotConnected extends FileStoreError {
+    constructor() {
+        super('File store not connected');
     }
 }

package/dist/index.d.ts

@@ -1,6 +1,7 @@
-export type { FileStore } from './definitions/interfaces.js';
+export type * from './definitions/interfaces.js';
 export { default as FileNotFound } from './errors/FileNotFound.js';
-export { default as FileSystemError } from './errors/FileSystemError.js';
+export { default as FileSystemError } from './errors/FileStoreError.js';
 export { default as NotConnected } from './errors/NotConnected.js';
-export { default as UnknownImplementation } from './errors/UnknownImplementation.js';
-export { default } from './implementation.js';
+export { default as MemoryDriver } from './drivers/Memory.js';
+export { default as MinioDriver } from './drivers/Minio.js';
+export { default } from './FileStore.js';

package/dist/index.js

@@ -1,5 +1,6 @@
 export { default as FileNotFound } from './errors/FileNotFound.js';
-export { default as FileSystemError } from './errors/FileSystemError.js';
+export { default as FileSystemError } from './errors/FileStoreError.js';
 export { default as NotConnected } from './errors/NotConnected.js';
-export { default as UnknownImplementation } from './errors/UnknownImplementation.js';
-export { default } from './implementation.js';
+export { default as MemoryDriver } from './drivers/Memory.js';
+export { default as MinioDriver } from './drivers/Minio.js';
+export { default } from './FileStore.js';

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@theshelf/filestore",
   "private": false,
-  "version": "0.1.0",
+  "version": "0.2.1",
   "type": "module",
   "repository": {
-    "url": "https://github.com/MaskingTechnology/theshelf"
+    "url": "git+https://github.com/MaskingTechnology/theshelf.git"
   },
   "scripts": {
     "build": "tsc",

package/dist/errors/FileSystemError.d.ts

@@ -1,2 +0,0 @@
-export default class FileSystemError extends Error {
-}

package/dist/errors/FileSystemError.js

@@ -1,2 +0,0 @@
-export default class FileSystemError extends Error {
-}

package/dist/errors/UnknownImplementation.d.ts

@@ -1,4 +0,0 @@
-import FileSystemError from './FileSystemError.js';
-export default class UnknownImplementation extends FileSystemError {
-    constructor(name: string);
-}

package/dist/errors/UnknownImplementation.js

@@ -1,6 +0,0 @@
-import FileSystemError from './FileSystemError.js';
-export default class UnknownImplementation extends FileSystemError {
-    constructor(name) {
-        super(`Unknown file system implementation: ${name}`);
-    }
-}

package/dist/implementation.d.ts

@@ -1,3 +0,0 @@
-import type { FileStore } from './definitions/interfaces.js';
-declare const _default: FileStore;
-export default _default;

package/dist/implementation.js

@@ -1,14 +0,0 @@
-import UnknownImplementation from './errors/UnknownImplementation.js';
-import createMemoryFS from './implementations/memory/create.js';
-import createMinioFS from './implementations/minio/create.js';
-const implementations = new Map([
-    ['memory', createMemoryFS],
-    ['minio', createMinioFS],
-]);
-const DEFAULT_FILE_STORE_IMPLEMENTATION = 'memory';
-const implementationName = process.env.FILE_STORE_IMPLEMENTATION ?? DEFAULT_FILE_STORE_IMPLEMENTATION;
-const creator = implementations.get(implementationName.toLowerCase());
-if (creator === undefined) {
-    throw new UnknownImplementation(implementationName);
-}
-export default creator();

package/dist/implementations/memory/create.d.ts

@@ -1,2 +0,0 @@
-import Memory from './Memory.js';
-export default function create(): Memory;

package/dist/implementations/memory/create.js

@@ -1,4 +0,0 @@
-import Memory from './Memory.js';
-export default function create() {
-    return new Memory();
-}

package/dist/implementations/minio/create.d.ts

@@ -1,2 +0,0 @@
-import MinioFS from './MinioFS.js';
-export default function create(): MinioFS;

package/dist/implementations/minio/create.js

@@ -1,9 +0,0 @@
-import MinioFS from './MinioFS.js';
-export default function create() {
-    const endPoint = process.env.MINIO_END_POINT ?? 'undefined';
-    const port = Number(process.env.MINIO_PORT_NUMBER ?? 9000);
-    const useSSL = process.env.MINIO_USE_SSL === 'true';
-    const accessKey = process.env.MINIO_ROOT_USER ?? 'undefined';
-    const secretKey = process.env.MINIO_ROOT_PASSWORD ?? 'undefined';
-    return new MinioFS({ endPoint, port, useSSL, accessKey, secretKey });
-}