3.0.1

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/
 
 # custom

.gitlab-ci.yml

@@ -3,14 +3,17 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
+
+before_script:
+  - npm install -g @shipzone/npmci
 
 # ====================
 # security stage
@@ -18,21 +21,37 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
+  only:
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
-  - docker
-  - notpriv
+    - docker
+  allow_failure: true
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
+  tags:
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
@@ -41,37 +60,36 @@ snyk:
 testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - priv
+    - docker
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci command npm run build
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - docker
 
 release:
   stage: release
   script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -79,34 +97,38 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
   stage: metadata
   script:
     - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
+    - npmci command npm install -g @git.zone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -114,5 +136,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -3,13 +3,31 @@
     "npmGlobalTools": []
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
-      "githost": "gitlab.com",
-      "gitscope": "pushrocks",
+      "githost": "code.foss.global",
+      "gitscope": "push.rocks",
       "gitrepo": "smartbucket",
-      "shortDescription": "simple cloud independent object storage",
-      "npmPackagename": "@pushrocks/smartbucket",
-      "license": "MIT"
+      "description": "A TypeScript library for simple cloud independent object storage with support for buckets, directories, and files.",
+      "npmPackagename": "@push.rocks/smartbucket",
+      "license": "MIT",
+      "keywords": [
+        "cloud storage",
+        "object storage",
+        "minio",
+        "S3",
+        "TypeScript",
+        "smartstream",
+        "smartpromise",
+        "smartpath",
+        "smartrx",
+        "buckets",
+        "files management",
+        "directories management"
+      ]
     }
+  },
+  "tsdoc": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
   }
 }

package.json

@@ -1,38 +1,59 @@
 {
-  "name": "@pushrocks/smartbucket",
-  "version": "1.0.6",
-  "description": "simple cloud independent object storage",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "name": "@push.rocks/smartbucket",
+  "version": "3.0.1",
+  "description": "A TypeScript library for simple cloud independent object storage with support for buckets, directories, and files.",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "UNLICENSED",
   "scripts": {
-    "test": "tstest test/",
-    "format": "(gitzone format)",
-    "build": "echo \"Not needed for now\""
+    "test": "(tstest test/)",
+    "build": "(tsbuild --web --allowimplicitany)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "tslint": "^5.20.0",
-    "tslint-config-prettier": "^1.18.0"
+    "@git.zone/tsbuild": "^2.1.76",
+    "@git.zone/tsrun": "^1.2.46",
+    "@git.zone/tstest": "^1.0.90",
+    "@push.rocks/qenv": "^6.0.5",
+    "@push.rocks/tapbundle": "^5.0.23"
   },
   "dependencies": {
-    "@pushrocks/smartpromise": "^3.0.6",
-    "@types/minio": "^7.0.3",
-    "minio": "^7.0.12"
+    "@push.rocks/smartpath": "^5.0.18",
+    "@push.rocks/smartpromise": "^4.0.3",
+    "@push.rocks/smartrx": "^3.0.7",
+    "@push.rocks/smartstream": "^3.0.37",
+    "@tsclass/tsclass": "^4.0.54",
+    "minio": "^8.0.0"
   },
-  "private": true,
+  "private": false,
   "files": [
     "ts/**/*",
     "ts_web/**/*",
     "dist/**/*",
-    "dist_web/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
     "dist_ts_web/**/*",
     "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ],
+  "keywords": [
+    "cloud storage",
+    "object storage",
+    "minio",
+    "S3",
+    "TypeScript",
+    "smartstream",
+    "smartpromise",
+    "smartpath",
+    "smartrx",
+    "buckets",
+    "files management",
+    "directories management"
   ]
 }

qenv.yml

@@ -0,0 +1,3 @@
+required:
+  - S3_KEY
+  - S3_SECRET

readme.hints.md

@@ -0,0 +1 @@
+ 

readme.md

@@ -1,26 +1,155 @@
-# @pushrocks/smartbucket
+# @push.rocks/smartbucket
 simple cloud independent object storage
 
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartbucket)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/smartbucket)
-* [github.com (source mirror)](https://github.com/pushrocks/smartbucket)
-* [docs (typedoc)](https://pushrocks.gitlab.io/smartbucket/)
+## Install
 
-## Status for master
-[![build status](https://gitlab.com/pushrocks/smartbucket/badges/master/build.svg)](https://gitlab.com/pushrocks/smartbucket/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartbucket/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartbucket/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartbucket.svg)](https://www.npmjs.com/package/@pushrocks/smartbucket)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartbucket/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartbucket)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+To install `@push.rocks/smartbucket`, you need to have Node.js and npm (Node Package Manager) installed on your system. If you have them installed, you can add `@push.rocks/smartbucket` to your project by running the following command in your project's root directory:
+
+```bash
+npm install @push.rocks/smartbucket --save
+```
+
+This command will download and install `@push.rocks/smartbucket` along with its required dependencies into your project's `node_modules` directory and save it as a dependency in your project's `package.json` file.
 
 ## Usage
 
-For further information read the linked docs at the top of this readme.
+`@push.rocks/smartbucket` is a module designed to provide simple cloud-independent object storage functionality. It wraps various cloud storage providers such as AWS S3, Google Cloud Storage, and others, offering a unified API to manage storage buckets and objects within those buckets.
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+To use `@push.rocks/smartbucket` in your project, you'll need to follow these general steps:
 
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
+### Setting Up
+
+First, ensure you are using ECMAScript modules (ESM) and TypeScript in your project for best compatibility. 
+
+Here's how to import and initialize smartbucket in a TypeScript file:
+
+```typescript
+import {
+  SmartBucket,
+  Bucket,
+  Directory,
+  File
+} from '@push.rocks/smartbucket';
+
+const mySmartBucket = new SmartBucket({
+  accessKey: "yourAccessKey",
+  accessSecret: "yourSecretKey",
+  endpoint: "yourEndpointURL",
+});
+```
+
+Make sure to replace `"yourAccessKey"`, `"yourSecretKey"`, and `"yourEndpointURL"` with your actual credentials and endpoint URL.
+
+### Creating a New Bucket
+
+To create a new bucket:
+
+```typescript
+async function createBucket(bucketName: string) {
+  try {
+    const myBucket: Bucket = await mySmartBucket.createBucket(bucketName);
+    console.log(`Bucket ${bucketName} created successfully.`);
+  } catch (error) {
+    console.error("Error creating bucket:", error);
+  }
+}
+
+// Use the function
+createBucket("exampleBucket");
+```
+
+**Important:** Bucket names must be unique across the storage service.
+
+### Listing Buckets
+
+To list all buckets:
+
+```typescript
+// Currently, SmartBucket does not include a direct method to list all buckets,
+// but you can access the underlying client provided by the cloud storage SDK
+// to perform such operations, depending on the SDK's capabilities.
+```
+
+### Uploading Objects to a Bucket
+
+To upload an object to a bucket:
+
+```typescript
+async function uploadFile(bucketName: string, filePath: string, fileContent: Buffer | string) {
+  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  if (myBucket) {
+    await myBucket.fastStore(filePath, fileContent);
+    console.log(`File uploaded to ${bucketName} at ${filePath}`);
+  }
+}
+
+// Use the function
+uploadFile("exampleBucket", "path/to/object.txt", "Hello, world!");
+```
+
+### Downloading Objects from a Bucket
+
+To download an object:
+
+```typescript
+async function downloadFile(bucketName: string, filePath: string) {
+  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  if (myBucket) {
+    const fileContent: Buffer = await myBucket.fastGet(filePath);
+    console.log("Downloaded file content:", fileContent.toString());
+  }
+}
+
+// Use the function
+downloadFile("exampleBucket", "path/to/object.txt");
+```
+
+### Deleting Objects
+
+To delete an object from a bucket:
+
+```typescript
+async function deleteFile(bucketName: string, filePath: string) {
+  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  if (myBucket) {
+    await myBucket.fastRemove(filePath);
+    console.log(`File at ${filePath} deleted from ${bucketName}.`);
+  }
+}
+
+// Use the function
+deleteFile("exampleBucket", "path/to/object.txt");
+```
+
+### Working with Directories
+
+`@push.rocks/smartbucket` abstracts directories within buckets for easier object management. You can create, list, and delete directories using the `Directory` class.
+
+### Additional Features
+
+- **Bucket Policies:** Manage bucket policies to control access permissions.
+- **Object Metadata:** Retrieve and modify object metadata.
+- **Cloud-Agnostic:** Designed to work with multiple cloud providers, allowing for easier migration or multi-cloud strategies.
+
+Remember, each cloud provider has specific features and limitations. `@push.rocks/smartbucket` aims to abstract common functionalities, but always refer to the specific cloud provider's documentation for advanced features or limitations.
+
+> **Note:** This document focuses on basic operations to get you started with `@push.rocks/smartbucket`. For advanced usage, including streaming data, managing bucket policies, and handling large file uploads, refer to the detailed API documentation and examples.
+
+## License and Legal Information
+
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

test/test.ts

@@ -1,8 +1,121 @@
-import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartbucket from '../ts/index';
+import { expect, expectAsync, tap } from '@push.rocks/tapbundle';
+import { Qenv } from '@push.rocks/qenv';
 
-tap.test('first test', async () => {
-  console.log('hi');
+import * as smartbucket from '../ts/index.js';
+
+const testQenv = new Qenv('./', './.nogit/');
+
+let testSmartbucket: smartbucket.SmartBucket;
+let myBucket: smartbucket.Bucket;
+let baseDirectory: smartbucket.Directory;
+
+tap.test('should create a valid smartbucket', async () => {
+  testSmartbucket = new smartbucket.SmartBucket({
+    accessKey: await testQenv.getEnvVarOnDemand('S3_KEY'),
+    accessSecret: await testQenv.getEnvVarOnDemand('S3_SECRET'),
+    endpoint: 's3.eu-central-1.wasabisys.com',
+  });
+});
+
+tap.skip.test('should create testbucket', async () => {
+  // await testSmartbucket.createBucket('testzone');
+});
+
+tap.skip.test('should remove testbucket', async () => {
+  // await testSmartbucket.removeBucket('testzone');
+});
+
+tap.test('should get a bucket', async () => {
+  myBucket = await testSmartbucket.getBucketByName('testzone');
+  expect(myBucket).toBeInstanceOf(smartbucket.Bucket);
+  expect(myBucket.name).toEqual('testzone');
+});
+
+// Fast operations
+tap.test('should store data in bucket fast', async () => {
+  await myBucket.fastPut({
+    path: 'hithere/socool.txt',
+    contents: 'hi there!',
+  });
+});
+
+tap.test('should get data in bucket', async () => {
+  const fileString = await myBucket.fastGet({
+    path: 'hithere/socool.txt',
+  });
+  const fileStringStream = await myBucket.fastGetStream({
+    path: 'hithere/socool.txt',
+  });
+  console.log(fileString);
+});
+
+tap.test('should delete data in bucket', async () => {
+  await myBucket.fastRemove({
+    path: 'hithere/socool.txt',
+  });
+});
+
+// fs operations
+
+tap.test('prepare for directory style tests', async () => {
+  await myBucket.fastPut({
+    path: 'dir1/file1.txt',
+    contents: 'dir1/file1.txt content',
+  });
+  await myBucket.fastPut({
+    path: 'dir1/file2.txt',
+    contents: 'dir1/file2.txt content',
+  });
+  await myBucket.fastPut({
+    path: 'dir2/file1.txt',
+    contents: 'dir2/file1.txt content',
+  });
+  await myBucket.fastPut({
+    path: 'dir3/file1.txt',
+    contents: 'dir3/file1.txt content',
+  });
+  await myBucket.fastPut({
+    path: 'dir3/dir4/file1.txt',
+    contents: 'dir3/dir4/file1.txt content',
+  });
+  await myBucket.fastPut({
+    path: 'file1.txt',
+    contents: 'file1 content',
+  });
+});
+
+tap.test('should get base directory', async () => {
+  baseDirectory = await myBucket.getBaseDirectory();
+  const directories = await baseDirectory.listDirectories();
+  console.log('Found the following directories:');
+  console.log(directories);
+  expect(directories.length).toEqual(3);
+  const files = await baseDirectory.listFiles();
+  console.log('Found the following files:');
+  console.log(files);
+  expect(files.length).toEqual(1);
+});
+
+tap.test('should correctly build paths for sub directories', async () => {
+  const dir4 = await baseDirectory.getSubDirectoryByName('dir3/dir4');
+  expect(dir4).toBeInstanceOf(smartbucket.Directory);
+  const dir4BasePath = dir4.getBasePath();
+  console.log(dir4BasePath);
+});
+
+tap.test('clean up directory style tests', async () => {
+  await myBucket.fastRemove({
+    path: 'dir1/file1.txt',
+  });
+  await myBucket.fastRemove({
+    path: 'dir1/file2.txt',
+  });
+  await myBucket.fastRemove({
+    path: 'dir2/file1.txt',
+  });
+  await myBucket.fastRemove({ path: 'dir3/file1.txt' });
+  await myBucket.fastRemove({ path: 'dir3/dir4/file1.txt' });
+  await myBucket.fastRemove({ path: 'file1.txt' });
 });
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/smartbucket',
+  version: '3.0.1',
+  description: 'A TypeScript library for simple cloud independent object storage with support for buckets, directories, and files.'
+}

ts/index.ts

@@ -1 +1,4 @@
-import * as plugins from './smartbucket.plugins';
+export * from './smartbucket.classes.smartbucket.js';
+export * from './smartbucket.classes.bucket.js';
+export * from './smartbucket.classes.directory.js';
+export * from './smartbucket.classes.file.js';

ts/smartbucket.classes.bucket.ts

@@ -1,3 +1,218 @@
-import * as plugins from './smartbucket.plugins';
+import * as plugins from './smartbucket.plugins.js';
+import { SmartBucket } from './smartbucket.classes.smartbucket.js';
+import { Directory } from './smartbucket.classes.directory.js';
 
-export class Bucket {}
+export class Bucket {
+  public static async getBucketByName(smartbucketRef: SmartBucket, bucketNameArg: string) {
+    const buckets = await smartbucketRef.minioClient.listBuckets();
+    const foundBucket = buckets.find((bucket) => {
+      return bucket.name === bucketNameArg;
+    });
+
+    if (foundBucket) {
+      console.log(`bucket with name ${bucketNameArg} exists.`);
+      console.log(`Taking this as base for new Bucket instance`);
+      return new this(smartbucketRef, bucketNameArg);
+    } else {
+      return null;
+    }
+  }
+
+  public static async createBucketByName(smartbucketRef: SmartBucket, bucketName: string) {
+    await smartbucketRef.minioClient.makeBucket(bucketName, 'ams3').catch((e) => console.log(e));
+    return new Bucket(smartbucketRef, bucketName);
+  }
+
+  public static async removeBucketByName(smartbucketRef: SmartBucket, bucketName: string) {
+    await smartbucketRef.minioClient.removeBucket(bucketName).catch((e) => console.log(e));
+  }
+
+  public smartbucketRef: SmartBucket;
+  public name: string;
+
+  constructor(smartbucketRef: SmartBucket, bucketName: string) {
+    this.smartbucketRef = smartbucketRef;
+    this.name = bucketName;
+  }
+
+  /**
+   * gets the base directory of the bucket
+   */
+  public async getBaseDirectory() {
+    return new Directory(this, null, '');
+  }
+
+  // ===============
+  // Fast Operations
+  // ===============
+
+  /**
+   * store file
+   */
+  public async fastPut(optionsArg: {
+    path: string;
+    contents: string | Buffer;
+  }): Promise<void> {
+    const streamIntake = new plugins.smartstream.StreamIntake();
+    const putPromise = this.smartbucketRef.minioClient
+      .putObject(this.name, optionsArg.path, streamIntake)
+      .catch((e) => console.log(e));
+    streamIntake.pushData(optionsArg.contents);
+    streamIntake.signalEnd();
+    const response = await putPromise;
+  }
+
+  /**
+   * get file
+   */
+  public async fastGet(optionsArg: Parameters<typeof this.fastGetStream>[0]): Promise<Buffer> {
+    const done = plugins.smartpromise.defer();
+    let completeFile: Buffer;
+    const replaySubject = await this.fastGetStream(optionsArg);
+    const subscription = replaySubject.subscribe({
+      next: (chunk) => {
+        if (completeFile) {
+          completeFile = Buffer.concat([completeFile, chunk]);
+        } else {
+          completeFile = chunk;
+        }
+      },
+      complete: () => {
+        done.resolve();
+        subscription.unsubscribe();
+      },
+      error: (err) => {
+        console.log(err);
+      },
+    });
+    await done.promise;
+    return completeFile;
+  }
+
+  public async fastGetStream(optionsArg: {
+    path: string;
+  }): Promise<plugins.smartrx.rxjs.ReplaySubject<Buffer>> {
+    const fileStream = await this.smartbucketRef.minioClient
+      .getObject(this.name, optionsArg.path)
+      .catch((e) => console.log(e));
+    const replaySubject = new plugins.smartrx.rxjs.ReplaySubject<Buffer>();
+    const duplexStream = new plugins.smartstream.SmartDuplex<Buffer, void>({
+      writeFunction: async (chunk) => {
+        replaySubject.next(chunk);
+        return;
+      },
+      finalFunction: async (cb) => {
+        replaySubject.complete();
+        return;
+      }
+    });
+
+    if (!fileStream) {
+      return null;
+    }
+
+    const smartstream = new plugins.smartstream.StreamWrapper([
+      fileStream,
+      duplexStream,
+    ]);
+    smartstream.run();
+    return replaySubject;
+  }
+
+  /**
+   * store file as stream
+   */
+  public async fastPutStream(optionsArg: {
+    path: string;
+    dataStream: plugins.stream.Readable;
+    nativeMetadata?: { [key: string]: string };
+  }): Promise<void> {
+    await this.smartbucketRef.minioClient.putObject(
+      this.name,
+      optionsArg.path,
+      optionsArg.dataStream,
+      null,
+      ...(optionsArg.nativeMetadata
+        ? (() => {
+            const returnObject: any = {};
+            return returnObject;
+          })()
+        : {})
+    );
+  }
+
+  public async copyObject(optionsArg: {
+    /**
+     * the
+     */
+    objectKey: string;
+    /**
+     * in case you want to copy to another bucket specify it here
+     */
+    targetBucket?: Bucket;
+    targetBucketKey?: string;
+    /**
+     * metadata will be merged with existing metadata
+     */
+    nativeMetadata?: { [key: string]: string };
+    deleteExistingNativeMetadata?: boolean;
+  }): Promise<void> {
+    try {
+      const targetBucketName = optionsArg.targetBucket ? optionsArg.targetBucket.name : this.name;
+
+      // Retrieve current object information to use in copy conditions
+      const currentObjInfo = await this.smartbucketRef.minioClient.statObject(
+        targetBucketName,
+        optionsArg.objectKey
+      );
+
+      // Setting up copy conditions
+      const copyConditions = new plugins.minio.CopyConditions();
+
+      // Prepare new metadata
+      const newNativeMetadata = {
+        ...(optionsArg.deleteExistingNativeMetadata ? {} : currentObjInfo.metaData),
+        ...optionsArg.nativeMetadata,
+      };
+
+      // Define the copy operation as a Promise
+      // TODO: check on issue here: https://github.com/minio/minio-js/issues/1286
+      await this.smartbucketRef.minioClient.copyObject(
+        this.name,
+        optionsArg.objectKey,
+        `/${targetBucketName}/${optionsArg.objectKey}`,
+        copyConditions
+      );
+    } catch (err) {
+      console.error('Error updating metadata:', err);
+      throw err; // rethrow to allow caller to handle
+    }
+  }
+
+  /**
+   * removeObject
+   */
+  public async fastRemove(optionsArg: {
+    path: string;
+  }) {
+    await this.smartbucketRef.minioClient.removeObject(this.name, optionsArg.path);
+  }
+
+  public async doesObjectExist(optionsArg: {
+    path: string;
+  }): Promise<boolean> {
+    try {
+      await this.smartbucketRef.minioClient.statObject(this.name, optionsArg.path);
+      console.log(`Object '${optionsArg.path}' exists in bucket '${this.name}'.`);
+      return true;
+    } catch (error) {
+      if (error.code === 'NotFound') {
+        console.log(`Object '${optionsArg.path}' does not exist in bucket '${this.name}'.`);
+        return false;
+      } else {
+        console.error('Error checking object existence:', error);
+        throw error; // Rethrow if it's not a NotFound error to handle unexpected issues
+      }
+    }
+  }
+}

ts/smartbucket.classes.directory.ts

@@ -1,3 +1,248 @@
-import * as plugins from './smartbucket.plugins';
+import * as plugins from './smartbucket.plugins.js';
+import { Bucket } from './smartbucket.classes.bucket.js';
+import { File } from './smartbucket.classes.file.js';
 
-export class Directory {}
+export class Directory {
+  public bucketRef: Bucket;
+  public parentDirectoryRef: Directory;
+  public name: string;
+
+  public tree: string[];
+  public files: string[];
+  public folders: string[];
+
+  constructor(bucketRefArg: Bucket, parentDiretory: Directory, name: string) {
+    this.bucketRef = bucketRefArg;
+    this.parentDirectoryRef = parentDiretory;
+    this.name = name;
+  }
+
+  /**
+   * returns an array of parent directories
+   */
+  public getParentDirectories(): Directory[] {
+    let parentDirectories: Directory[] = [];
+    if (this.parentDirectoryRef) {
+      parentDirectories.push(this.parentDirectoryRef);
+      parentDirectories = parentDirectories.concat(this.parentDirectoryRef.getParentDirectories());
+    }
+    return parentDirectories;
+  }
+
+  /**
+   * returns the directory level
+   */
+  public getDirectoryLevel(): number {
+    return this.getParentDirectories().length;
+  }
+
+  /**
+   * updates the base path
+   */
+  public getBasePath(): string {
+    const parentDirectories = this.getParentDirectories();
+    let basePath = '';
+    for (const parentDir of parentDirectories) {
+      if (!parentDir.name && !basePath) {
+        basePath = this.name + '/';
+        continue;
+      }
+      if (parentDir.name && !basePath) {
+        basePath = parentDir.name + '/' + this.name + '/';
+        continue;
+      }
+      if (parentDir.name && basePath) {
+        basePath = parentDir.name + '/' + basePath;
+        continue;
+      }
+    }
+    return basePath;
+  }
+
+  /**
+   * lists all files
+   */
+  public async listFiles(): Promise<File[]> {
+    const done = plugins.smartpromise.defer();
+    const fileNameStream = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2(
+      this.bucketRef.name,
+      this.getBasePath(),
+      false
+    );
+    const fileArray: File[] = [];
+    const duplexStream = new plugins.smartstream.SmartDuplex<plugins.minio.BucketItem, void>({
+      objectMode: true,
+      writeFunction: async (bucketItem) => {
+        if (bucketItem.prefix) {
+          return;
+        }
+        if (!bucketItem.name) {
+          return;
+        }
+        let subtractedPath = bucketItem.name.replace(this.getBasePath(), '');
+        if (subtractedPath.startsWith('/')) {
+          subtractedPath = subtractedPath.substr(1);
+        }
+        if (!subtractedPath.includes('/')) {
+          fileArray.push(
+            new File({
+              directoryRefArg: this,
+              fileName: subtractedPath,
+            })
+          );
+        }
+      },
+      finalFunction: async (tools) => {
+        done.resolve();
+      }
+    });
+    fileNameStream.pipe(duplexStream);
+    await done.promise;
+    return fileArray;
+  }
+
+  /**
+   * lists all folders
+   */
+  public async listDirectories(): Promise<Directory[]> {
+    const done = plugins.smartpromise.defer();
+    const basePath = this.getBasePath();
+    const completeDirStream = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2(
+      this.bucketRef.name,
+      this.getBasePath(),
+      false
+    );
+    const directoryArray: Directory[] = [];
+    const duplexStream = new plugins.smartstream.SmartDuplex<plugins.minio.BucketItem, void>({
+      objectMode: true,
+      writeFunction: async (bucketItem) => {
+        if (bucketItem.name) {
+          return;
+        }
+        let subtractedPath = bucketItem.prefix.replace(this.getBasePath(), '');
+        if (subtractedPath.startsWith('/')) {
+          subtractedPath = subtractedPath.substr(1);
+        }
+        if (subtractedPath.includes('/')) {
+          const dirName = subtractedPath.split('/')[0];
+          if (directoryArray.find((directory) => directory.name === dirName)) {
+            return;
+          }
+          directoryArray.push(new Directory(this.bucketRef, this, dirName));
+        }
+      },
+      finalFunction: async (tools) => {
+        done.resolve();
+      }
+    });
+    completeDirStream.pipe(duplexStream);
+    await done.promise;
+    return directoryArray;
+  }
+
+  /**
+   * gets an array that has all objects with a certain prefix;
+   */
+  public async getTreeArray() {
+    const treeArray = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2(
+      this.bucketRef.name,
+      this.getBasePath(),
+      true
+    );
+  }
+
+  /**
+   * gets a sub directory
+   */
+  public async getSubDirectoryByName(dirNameArg: string): Promise<Directory> {
+    const dirNameArray = dirNameArg.split('/');
+
+    const getDirectory = async (directoryArg: Directory, dirNameToSearch: string) => {
+      const directories = await directoryArg.listDirectories();
+      return directories.find((directory) => {
+        return directory.name === dirNameToSearch;
+      });
+    };
+    let wantedDirectory: Directory;
+    for (const dirNameToSearch of dirNameArray) {
+      const directoryToSearchIn = wantedDirectory ? wantedDirectory : this;
+      wantedDirectory = await getDirectory(directoryToSearchIn, dirNameToSearch);
+    }
+    return wantedDirectory;
+  }
+
+  /**
+   * moves the directory
+   */
+  public async move() {
+    // TODO
+    throw new Error('moving a directory is not yet implemented');
+  }
+
+  /**
+   * creates a file within this directory
+   * @param relativePathArg
+   */
+  public async createEmptyFile(relativePathArg: string) {
+    const emtpyFile = await File.create({
+      directory: this,
+      name: relativePathArg,
+      contents: '',
+    });
+  }
+
+  // file operations
+  public async fastPut(optionsArg: { path: string; contents: string | Buffer }) {
+    const path = plugins.path.join(this.getBasePath(), optionsArg.path);
+    await this.bucketRef.fastPut({
+      path,
+      contents: optionsArg.contents,
+    });
+  }
+
+  public async fastGet(optionsArg: { path: string }) {
+    const path = plugins.path.join(this.getBasePath(), optionsArg.path);
+    const result = await this.bucketRef.fastGet({
+      path,
+    });
+    return result;
+  }
+
+  public async fastGetStream(pathArg: string): Promise<plugins.smartrx.rxjs.ReplaySubject<Buffer>> {
+    const path = plugins.path.join(this.getBasePath(), pathArg);
+    const result = await this.bucketRef.fastGetStream({
+      path,
+    });
+    return result;
+  }
+
+  public async fastRemove(optionsArg: { path: string }) {
+    const path = plugins.path.join(this.getBasePath(), optionsArg.path);
+    await this.bucketRef.fastRemove({
+      path,
+    });
+  }
+
+  /**
+   * deletes the directory with all its contents
+   */
+  public async delete() {
+    const deleteDirectory = async (directoryArg: Directory) => {
+      const childDirectories = await directoryArg.listDirectories();
+      if (childDirectories.length === 0) {
+        console.log('directory empty! Path complete!');
+      } else {
+        for (const childDir of childDirectories) {
+          await deleteDirectory(childDir);
+        }
+      }
+      const files = await directoryArg.listFiles();
+      for (const file of files) {
+        await directoryArg.fastRemove({
+          path: file.name,
+        });
+      }
+    };
+    await deleteDirectory(this);
+  }
+}

ts/smartbucket.classes.file.ts

@@ -1,3 +1,140 @@
-import * as plugins from './smartbucket.plugins';
+import * as plugins from './smartbucket.plugins.js';
+import { Directory } from './smartbucket.classes.directory.js';
 
-export class File {}
+export interface IFileMetaData {
+  name: string;
+  fileType: string;
+  size: string;
+}
+
+/**
+ * represents a file in a directory
+ */
+export class File {
+  // STATIC
+
+  /**
+   * creates a file in draft mode
+   * you need to call .save() to store it in s3
+   * @param optionsArg
+   */
+  public static async create(optionsArg: {
+    directory: Directory;
+    name: string;
+    contents: Buffer | string | plugins.stream.Readable;
+    /**
+     * if contents are of type string, you can specify the encoding here
+     */
+    encoding?: 'utf8' | 'binary';
+  }): Promise<File> {
+    const contents =
+      typeof optionsArg.contents === 'string'
+        ? Buffer.from(optionsArg.contents, optionsArg.encoding)
+        : optionsArg.contents;
+    const file = new File({
+      directoryRefArg: optionsArg.directory,
+      fileName: optionsArg.name,
+    });
+    if (contents instanceof plugins.stream.Readable) {} else {
+      await optionsArg.directory.fastPut({
+        path: optionsArg.name,
+        contents: contents,
+      });
+    }
+    return file;
+  }
+
+  // INSTANCE
+  public parentDirectoryRef: Directory;
+  public name: string;
+
+  public path: string;
+  public metaData: IFileMetaData;
+
+  constructor(optionsArg: { directoryRefArg: Directory; fileName: string }) {
+    this.parentDirectoryRef = optionsArg.directoryRefArg;
+    this.name = optionsArg.fileName;
+  }
+
+  public async getContentAsString() {
+    const fileBuffer = await this.getContentAsBuffer();
+    return fileBuffer.toString();
+  }
+
+  public async getContentAsBuffer() {
+    const done = plugins.smartpromise.defer();
+    const fileStream = await this.parentDirectoryRef.bucketRef.smartbucketRef.minioClient
+      .getObject(this.parentDirectoryRef.bucketRef.name, this.path)
+      .catch((e) => console.log(e));
+    let completeFile = Buffer.from('');
+    const duplexStream = new plugins.smartstream.SmartDuplex<Buffer, Buffer>(
+      {
+        writeFunction: async (chunk) => {
+          completeFile = Buffer.concat([chunk]);
+          return chunk;
+        },
+        finalFunction: async (cb) => {
+          done.resolve();
+          return Buffer.from('');
+        },
+      }
+    );
+
+    if (!fileStream) {
+      return null;
+    }
+
+    fileStream.pipe(duplexStream);
+    await done.promise;
+    return completeFile;
+  }
+
+  public async readStreaming() {
+    // TODO
+    throw new Error('not yet implemented');
+  }
+
+  /**
+   * removes this file
+   */
+  public async remove() {
+    await this.parentDirectoryRef.bucketRef.smartbucketRef.minioClient.removeObject(
+      this.parentDirectoryRef.bucketRef.name,
+      this.path
+    );
+    await this.parentDirectoryRef.listFiles();
+  }
+
+  /**
+   * deletes the file
+   */
+  public async delete() {}
+
+  /**
+   * allows locking the file
+   * @param optionsArg
+   */
+  public async lock(optionsArg?: { timeoutMillis?: number }) {}
+
+  /**
+   * actively unlocks a file
+   *
+   */
+  public async unlock(optionsArg?: {
+    /**
+     * unlock the file even if not locked from this instance
+     */
+    force?: boolean;
+  }) {}
+
+  public async updateWithContents(optionsArg: {
+    contents: Buffer | string | plugins.stream.Readable;
+    encoding?: 'utf8' | 'binary';
+  }) {}
+
+  /**
+   * allows updating the metadata of a file
+   * @param updatedMetadata
+   */
+  public async updateMetaData(updatedMetadata: any) {}
+}

ts/smartbucket.classes.smartbucket.ts

@@ -1,23 +1,35 @@
-import * as plugins from './smartbucket.plugins';
-
-export interface ISmartBucketConfig {
-  provider: 'digitalocean';
-  projectId: string;
-  bucketName: string;
-}
+import * as plugins from './smartbucket.plugins.js';
+import { Bucket } from './smartbucket.classes.bucket.js';
 
 export class SmartBucket {
-  public config: ISmartBucketConfig;
+  public config: plugins.tsclass.storage.IS3Descriptor;
+
+  public minioClient: plugins.minio.Client;
 
   /**
    * the constructor of SmartBucket
    */
-  constructor(configArg: ISmartBucketConfig) {
+  constructor(configArg: plugins.tsclass.storage.IS3Descriptor) {
     this.config = configArg;
+    this.minioClient = new plugins.minio.Client({
+      endPoint: this.config.endpoint,
+      port: configArg.port || 443,
+      useSSL: configArg.useSsl !== undefined ? configArg.useSsl : true,
+      accessKey: this.config.accessKey,
+      secretKey: this.config.accessSecret,
+    });
   }
 
-  /**
-   * initializes the Smartbucket
-   */
-  public async init() {}
+  public async createBucket(bucketNameArg: string) {
+    const bucket = await Bucket.createBucketByName(this, bucketNameArg);
+    return bucket;
+  }
+
+  public async removeBucket(bucketName: string) {
+    await Bucket.removeBucketByName(this, bucketName);
+  }
+
+  public async getBucketByName(bucketName: string) {
+    return Bucket.getBucketByName(this, bucketName);
+  }
 }

ts/smartbucket.plugins.ts

@@ -1,6 +1,25 @@
-import * as smartpromise from '@pushrocks/smartpromise';
+// node native
+import * as path from 'path';
+import * as stream from 'stream';
 
-export { smartpromise };
+export { path, stream };
+
+// @push.rocks scope
+import * as smartpath from '@push.rocks/smartpath';
+import * as smartpromise from '@push.rocks/smartpromise';
+import * as smartrx from '@push.rocks/smartrx';
+import * as smartstream from '@push.rocks/smartstream';
+
+export { smartpath, smartpromise, smartrx, smartstream };
+
+// @tsclass
+import * as tsclass from '@tsclass/tsclass';
+
+export {
+  tsclass,
+}
 
 // third party scope
 import * as minio from 'minio';
+
+export { minio };

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}