@devbro/neko-storage 0.1.3 → 0.1.5

package/README.md

@@ -39,22 +39,119 @@ let is_file_deleted = await storage.delete('path/to/file/filename.ext');
 
 ## available drivers
 
-local
+### Local Storage
+
+Store files on the local file system.
 
 ```ts
-import { Storage, StorageFactory } from '@devbro/neko-storage';
+import { LocalStorageProvider, Storage } from '@devbro/neko-storage';
 
 const basePath = path.resolve(os.tmpdir(), `test-storage-${randomUUID()}`);
-const storage: Storage = StorageFactory.create({ engine: 'local', basePath });
+const provider = new LocalStorageProvider({ engine: 'local', basePath });
+const storage = new Storage(provider);
 ```
 
-AWS S3
+### AWS S3
+
+Store files in Amazon S3 buckets.
 
 ```ts
-import { Storage, StorageFactory } from '@devbro/neko-storage';
+import { AWSS3StorageProvider, Storage } from '@devbro/neko-storage';
+
+const provider = new AWSS3StorageProvider({
+  engine: 's3',
+  bucket: 'your-bucket-name',
+  s3Config: {
+    region: 'us-east-1',
+    credentials: {
+      accessKeyId: 'YOUR_ACCESS_KEY',
+      secretAccessKey: 'YOUR_SECRET_KEY',
+    },
+  },
+});
+const storage = new Storage(provider);
+```
+
+### Google Cloud Storage (GCP)
+
+Store files in Google Cloud Storage buckets.
+
+```ts
+import { GCPStorageProvider, Storage } from '@devbro/neko-storage';
+
+const provider = new GCPStorageProvider({
+  engine: 'gcp',
+  bucket: 'your-bucket-name',
+  gcpConfig: {
+    projectId: 'your-project-id',
+    keyFilename: '/path/to/service-account-key.json',
+    // Or use credentials object directly
+    // credentials: {...}
+  },
+});
+const storage = new Storage(provider);
+```
+
+### Azure Blob Storage
+
+Store files in Azure Blob Storage containers.
 
-const s3Config : AWSS3Config = ???;
-const storage: Storage = StorageFactory.create({ engine: 's3', { s3Config } });
+```ts
+import { AzureBlobStorageProvider, Storage } from '@devbro/neko-storage';
+
+const provider = new AzureBlobStorageProvider({
+  engine: 'azure',
+  azureConfig: {
+    accountName: 'your-storage-account',
+    accountKey: 'YOUR_ACCOUNT_KEY', // Or use sasToken instead
+    containerName: 'your-container-name',
+  },
+});
+const storage = new Storage(provider);
+```
+
+### FTP
+
+Store files on FTP servers.
+
+```ts
+import { FTPStorageProvider, Storage } from '@devbro/neko-storage';
+
+const provider = new FTPStorageProvider({
+  engine: 'ftp',
+  basePath: '/remote/path',
+  ftpConfig: {
+    host: 'ftp.example.com',
+    port: 21,
+    user: 'username',
+    password: 'password',
+    secure: false, // Set to true for FTPS
+  },
+});
+const storage = new Storage(provider);
+```
+
+### SFTP
+
+Store files on SFTP servers via SSH.
+
+```ts
+import { SFTPStorageProvider, Storage } from '@devbro/neko-storage';
+
+const provider = new SFTPStorageProvider({
+  engine: 'sftp',
+  basePath: '/remote/path',
+  sftpConfig: {
+    host: 'sftp.example.com',
+    port: 22,
+    username: 'username',
+    password: 'password',
+    // Or use private key authentication
+    // privateKey: fs.readFileSync('/path/to/private-key'),
+    // passphrase: 'key-passphrase',
+  },
+});
+const storage = new Storage(provider);
 ```
 
 More driver available upon request or through PR.

package/dist/Storage.d.mts

@@ -1,20 +1,21 @@
 import { ReadStream } from 'fs';
 import { Stream } from 'stream';
-import { StorageConfig, Metadata } from './types.mjs';
+import { Metadata } from './types.mjs';
+import { StorageProviderInterface } from './StorageProviderInterface.mjs';
 import '@aws-sdk/client-s3';
+import '@google-cloud/storage';
 
-declare abstract class Storage {
-    protected config: StorageConfig;
-    constructor(config: StorageConfig);
-    static canHandle(config: StorageConfig): boolean;
-    abstract exists(path: string): Promise<boolean>;
-    abstract put(path: string, content: string | object | Stream | Buffer): Promise<boolean>;
-    abstract getJson(path: string): Promise<object>;
-    abstract getString(path: string): Promise<string>;
-    abstract getBuffer(path: string): Promise<Buffer>;
-    abstract getStream(path: string): Promise<ReadStream>;
-    abstract delete(path: string): Promise<boolean>;
-    abstract metadata(path: string): Promise<Metadata>;
+declare class Storage {
+    protected provider: StorageProviderInterface;
+    constructor(provider: StorageProviderInterface);
+    exists(path: string): Promise<boolean>;
+    put(path: string, content: string | object | Stream | Buffer): Promise<boolean>;
+    getJson(path: string): Promise<object>;
+    getString(path: string): Promise<string>;
+    getBuffer(path: string): Promise<Buffer>;
+    getStream(path: string): Promise<ReadStream>;
+    delete(path: string): Promise<boolean>;
+    metadata(path: string): Promise<Metadata>;
 }
 
 export { Storage };

package/dist/Storage.mjs

@@ -1,15 +1,37 @@
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-const _Storage = class _Storage {
-  constructor(config) {
-    this.config = config;
+class Storage {
+  constructor(provider) {
+    this.provider = provider;
   }
-  static canHandle(config) {
-    throw new Error("Method not implemented.");
+  static {
+    __name(this, "Storage");
   }
-};
-__name(_Storage, "Storage");
-let Storage = _Storage;
+  exists(path) {
+    return this.provider.exists(path);
+  }
+  put(path, content) {
+    return this.provider.put(path, content);
+  }
+  getJson(path) {
+    return this.provider.getJson(path);
+  }
+  getString(path) {
+    return this.provider.getString(path);
+  }
+  getBuffer(path) {
+    return this.provider.getBuffer(path);
+  }
+  getStream(path) {
+    return this.provider.getStream(path);
+  }
+  delete(path) {
+    return this.provider.delete(path);
+  }
+  metadata(path) {
+    return this.provider.metadata(path);
+  }
+}
 export {
   Storage
 };

package/dist/Storage.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/Storage.mts"],"sourcesContent":["import { ReadStream } from 'fs';\nimport { Stream } from 'stream';\nimport { Metadata } from './types.mjs';\nimport { StorageConfig } from './types.mjs';\n\nexport abstract class Storage {\n  constructor(protected config: StorageConfig) {}\n\n  static canHandle(config: StorageConfig): boolean {\n    throw new Error('Method not implemented.');\n  }\n\n  abstract exists(path: string): Promise<boolean>;\n  abstract put(path: string, content: string | object | Stream | Buffer): Promise<boolean>;\n  abstract getJson(path: string): Promise<object>;\n  abstract getString(path: string): Promise<string>;\n  abstract getBuffer(path: string): Promise<Buffer>;\n  abstract getStream(path: string): Promise<ReadStream>;\n  abstract delete(path: string): Promise<boolean>;\n  abstract metadata(path: string): Promise<Metadata>;\n}\n"],"mappings":";;AAKO,MAAe,WAAf,MAAe,SAAQ;AAAA,EAC5B,YAAsB,QAAuB;AAAvB;AAAA,EAAwB;AAAA,EAE9C,OAAO,UAAU,QAAgC;AAC/C,UAAM,IAAI,MAAM,yBAAyB;AAAA,EAC3C;AAUF;AAf8B;AAAvB,IAAe,UAAf;","names":[]}
+{"version":3,"sources":["../src/Storage.mts"],"sourcesContent":["import { ReadStream } from 'fs';\nimport { Stream } from 'stream';\nimport { Metadata } from './types.mjs';\nimport { StorageConfig } from './types.mjs';\nimport { StorageProviderInterface } from './StorageProviderInterface.mjs';\n\nexport class Storage {\n  constructor(protected provider: StorageProviderInterface) {}\n\n  exists(path: string): Promise<boolean> {\n    return this.provider.exists(path);\n  }\n\n  put(path: string, content: string | object | Stream | Buffer): Promise<boolean> {\n    return this.provider.put(path, content);\n  }\n\n  getJson(path: string): Promise<object> {\n    return this.provider.getJson(path);\n  }\n\n  getString(path: string): Promise<string> {\n    return this.provider.getString(path);\n  }\n\n  getBuffer(path: string): Promise<Buffer> {\n    return this.provider.getBuffer(path);\n  }\n\n  getStream(path: string): Promise<ReadStream> {\n    return this.provider.getStream(path);\n  }\n\n  delete(path: string): Promise<boolean> {\n    return this.provider.delete(path);\n  }\n\n  metadata(path: string): Promise<Metadata> {\n    return this.provider.metadata(path);\n  }\n}\n"],"mappings":";;AAMO,MAAM,QAAQ;AAAA,EACnB,YAAsB,UAAoC;AAApC;AAAA,EAAqC;AAAA,EAP7D,OAMqB;AAAA;AAAA;AAAA,EAGnB,OAAO,MAAgC;AACrC,WAAO,KAAK,SAAS,OAAO,IAAI;AAAA,EAClC;AAAA,EAEA,IAAI,MAAc,SAA8D;AAC9E,WAAO,KAAK,SAAS,IAAI,MAAM,OAAO;AAAA,EACxC;AAAA,EAEA,QAAQ,MAA+B;AACrC,WAAO,KAAK,SAAS,QAAQ,IAAI;AAAA,EACnC;AAAA,EAEA,UAAU,MAA+B;AACvC,WAAO,KAAK,SAAS,UAAU,IAAI;AAAA,EACrC;AAAA,EAEA,UAAU,MAA+B;AACvC,WAAO,KAAK,SAAS,UAAU,IAAI;AAAA,EACrC;AAAA,EAEA,UAAU,MAAmC;AAC3C,WAAO,KAAK,SAAS,UAAU,IAAI;AAAA,EACrC;AAAA,EAEA,OAAO,MAAgC;AACrC,WAAO,KAAK,SAAS,OAAO,IAAI;AAAA,EAClC;AAAA,EAEA,SAAS,MAAiC;AACxC,WAAO,KAAK,SAAS,SAAS,IAAI;AAAA,EACpC;AACF;","names":[]}

package/dist/StorageProviderFactory.d.mts

@@ -0,0 +1,15 @@
+import { FlexibleFactory } from '@devbro/neko-helper';
+import { StorageProviderInterface } from './StorageProviderInterface.mjs';
+import 'fs';
+import 'stream';
+import './types.mjs';
+import '@aws-sdk/client-s3';
+import '@google-cloud/storage';
+
+declare class StorageProviderFactory {
+    static instance: FlexibleFactory<StorageProviderInterface>;
+    static register(key: string, factory: (...args: any[]) => StorageProviderInterface): void;
+    static create<T>(key: string, ...args: any[]): StorageProviderInterface;
+}
+
+export { StorageProviderFactory };

package/dist/StorageProviderFactory.mjs

@@ -0,0 +1,19 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+import { FlexibleFactory } from "@devbro/neko-helper";
+class StorageProviderFactory {
+  static {
+    __name(this, "StorageProviderFactory");
+  }
+  static instance = new FlexibleFactory();
+  static register(key, factory) {
+    StorageProviderFactory.instance.register(key, factory);
+  }
+  static create(key, ...args) {
+    return StorageProviderFactory.instance.create(key, ...args);
+  }
+}
+export {
+  StorageProviderFactory
+};
+//# sourceMappingURL=StorageProviderFactory.mjs.map

package/dist/StorageProviderFactory.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/StorageProviderFactory.mts"],"sourcesContent":["import { Storage } from './Storage.mjs';\nimport { FlexibleFactory } from '@devbro/neko-helper';\nimport { StorageProviderInterface } from './StorageProviderInterface.mjs';\n\nexport class StorageProviderFactory {\n  static instance: FlexibleFactory<StorageProviderInterface> =\n    new FlexibleFactory<StorageProviderInterface>();\n\n  static register(key: string, factory: (...args: any[]) => StorageProviderInterface): void {\n    StorageProviderFactory.instance.register(key, factory);\n  }\n\n  static create<T>(key: string, ...args: any[]): StorageProviderInterface {\n    return StorageProviderFactory.instance.create(key, ...args);\n  }\n}\n"],"mappings":";;AACA,SAAS,uBAAuB;AAGzB,MAAM,uBAAuB;AAAA,EAJpC,OAIoC;AAAA;AAAA;AAAA,EAClC,OAAO,WACL,IAAI,gBAA0C;AAAA,EAEhD,OAAO,SAAS,KAAa,SAA6D;AACxF,2BAAuB,SAAS,SAAS,KAAK,OAAO;AAAA,EACvD;AAAA,EAEA,OAAO,OAAU,QAAgB,MAAuC;AACtE,WAAO,uBAAuB,SAAS,OAAO,KAAK,GAAG,IAAI;AAAA,EAC5D;AACF;","names":[]}

package/dist/StorageProviderInterface.d.mts

@@ -0,0 +1,18 @@
+import { ReadStream } from 'fs';
+import { Stream } from 'stream';
+import { Metadata } from './types.mjs';
+import '@aws-sdk/client-s3';
+import '@google-cloud/storage';
+
+interface StorageProviderInterface {
+    exists(path: string): Promise<boolean>;
+    put(path: string, content: string | object | Stream | Buffer): Promise<boolean>;
+    getJson(path: string): Promise<object>;
+    getString(path: string): Promise<string>;
+    getBuffer(path: string): Promise<Buffer>;
+    getStream(path: string): Promise<ReadStream>;
+    delete(path: string): Promise<boolean>;
+    metadata(path: string): Promise<Metadata>;
+}
+
+export type { StorageProviderInterface };

package/dist/StorageProviderInterface.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=StorageProviderInterface.mjs.map

package/dist/StorageProviderInterface.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/index.d.mts

@@ -1,8 +1,15 @@
-export { Metadata, StorageConfig } from './types.mjs';
+export { AzureStorageConfig, FTPConfig, GCPStorageConfig, LocalStorageConfig, Metadata, S3ClientConfig, SFTPConfig, StorageConfig } from './types.mjs';
 export { Storage } from './Storage.mjs';
-export { AWSS3Storage } from './AWSS3Storage.mjs';
-export { LocalStorage } from './LocalStorage.mjs';
-export { StorageFactory } from './StorageFactory.mjs';
+export { AWSS3StorageProvider } from './providers/AWSS3StorageProvider.mjs';
+export { LocalStorageProvider } from './providers/LocalStorageProvider.mjs';
+export { GCPStorageProvider } from './providers/GCPStorageProvider.mjs';
+export { AzureBlobStorageProvider } from './providers/AzureBlobStorageProvider.mjs';
+export { FTPStorageProvider } from './providers/FTPStorageProvider.mjs';
+export { SFTPStorageProvider } from './providers/SFTPStorageProvider.mjs';
+export { StorageProviderFactory } from './StorageProviderFactory.mjs';
+export { StorageProviderInterface } from './StorageProviderInterface.mjs';
 import '@aws-sdk/client-s3';
+import '@google-cloud/storage';
 import 'fs';
 import 'stream';
+import '@devbro/neko-helper';