2.0.3

.gitlab-ci.yml

@@ -12,6 +12,9 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
@@ -36,6 +39,7 @@ auditProductionDependencies:
     - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
+  allow_failure: true
 
 auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
@@ -96,10 +100,9 @@ codequality:
   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:
     - lossless
     - docker
@@ -120,7 +123,7 @@ 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

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
-        "${relativeFile}"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
-    },
-    {
-      "name": "test.ts",
-      "type": "node",
-      "request": "launch",
-      "args": [
-        "test/test.ts"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
+      "type": "node-terminal"
     }
   ]
 }

npmextra.json

@@ -6,10 +6,10 @@
     "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
-      "gitscope": "pushrocks",
+      "gitscope": "push.rocks",
       "gitrepo": "smartbucket",
-      "shortDescription": "simple cloud independent object storage",
-      "npmPackagename": "@pushrocks/smartbucket",
+      "description": "simple cloud independent object storage",
+      "npmPackagename": "@push.rocks/smartbucket",
       "license": "MIT"
     }
   }

package.json

@@ -1,31 +1,30 @@
 {
-  "name": "@pushrocks/smartbucket",
-  "version": "1.0.35",
+  "name": "@push.rocks/smartbucket",
+  "version": "2.0.3",
   "description": "simple cloud independent object storage",
   "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": "(tsbuild --web)"
+    "build": "(tsbuild --web --allowimplicitany)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tstest": "^1.0.52",
-    "@pushrocks/tapbundle": "^3.2.9",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0"
+    "@git.zone/tsrun": "^1.2.46",
+    "@git.zone/tsbuild": "^2.1.63",
+    "@git.zone/tstest": "^1.0.71",
+    "@push.rocks/qenv": "^6.0.4",
+    "@push.rocks/tapbundle": "^5.0.3"
   },
   "dependencies": {
-    "@pushrocks/qenv": "^4.0.10",
-    "@pushrocks/smartpath": "^4.0.3",
-    "@pushrocks/smartpromise": "^3.0.6",
-    "@pushrocks/smartrx": "^2.0.19",
-    "@pushrocks/streamfunction": "^2.0.1",
-    "@types/minio": "^7.0.6",
-    "minio": "^7.0.16"
+    "@push.rocks/smartpath": "^5.0.5",
+    "@push.rocks/smartpromise": "^4.0.3",
+    "@push.rocks/smartrx": "^3.0.7",
+    "@push.rocks/smartstream": "^2.0.2",
+    "@types/minio": "^7.0.13",
+    "minio": "^7.0.28"
   },
   "private": false,
   "files": [

readme.md

@@ -1,8 +1,8 @@
-# @pushrocks/smartbucket
+# @push.rocks/smartbucket
 simple cloud independent object storage
 
 ## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartbucket)
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/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/)
@@ -13,14 +13,14 @@ Status Category | Status Badge
 -- | --
 GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartbucket/badges/master/pipeline.svg)](https://lossless.cloud)
 GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartbucket/badges/master/coverage.svg)](https://lossless.cloud)
-npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartbucket)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartbucket)](https://lossless.cloud)
 Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartbucket)](https://lossless.cloud)
 TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
 node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
 Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
-PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartbucket)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartbucket)](https://lossless.cloud)
-BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartbucket)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/smartbucket)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartbucket)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smartbucket)](https://lossless.cloud)
 Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## Usage

test/test.ts

@@ -1,7 +1,7 @@
-import { expect, tap } from '@pushrocks/tapbundle';
-import { Qenv } from '@pushrocks/qenv';
+import { expect, expectAsync, tap } from '@push.rocks/tapbundle';
+import { Qenv } from '@push.rocks/qenv';
 
-import * as smartbucket from '../ts/index';
+import * as smartbucket from '../ts/index.js';
 
 const testQenv = new Qenv('./', './.nogit/');
 
@@ -11,24 +11,24 @@ let baseDirectory: smartbucket.Directory;
 
 tap.test('should create a valid smartbucket', async () => {
   testSmartbucket = new smartbucket.SmartBucket({
-    accessKey: testQenv.getEnvVarOnDemand('S3_KEY'),
-    accessSecret: testQenv.getEnvVarOnDemand('S3_SECRET'),
-    endpoint: 'fra1.digitaloceanspaces.com',
+    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');
+  // await testSmartbucket.createBucket('testzone');
 });
 
 tap.skip.test('should remove testbucket', async () => {
-  await testSmartbucket.removeBucket('testzone');
+  // await testSmartbucket.removeBucket('testzone');
 });
 
 tap.test('should get a bucket', async () => {
   myBucket = await testSmartbucket.getBucketByName('testzone');
-  expect(myBucket).to.be.instanceOf(smartbucket.Bucket);
-  expect(myBucket.name).to.equal('testzone');
+  expect(myBucket).toBeInstanceOf(smartbucket.Bucket);
+  expect(myBucket.name).toEqual('testzone');
 });
 
 // Fast operations
@@ -62,32 +62,20 @@ tap.test('should get base directory', async () => {
   const directories = await baseDirectory.listDirectories();
   console.log('Found the following directories:');
   console.log(directories);
-  expect(directories.length).to.equal(3);
+  expect(directories.length).toEqual(3);
   const files = await baseDirectory.listFiles();
   console.log('Found the following files:');
   console.log(files);
-  expect(files.length).to.equal(1);
+  expect(files.length).toEqual(1);
 });
 
 tap.test('should correctly build paths for sub directories', async () => {
   const dir4 = await baseDirectory.getSubDirectoryByName('dir3/dir4');
-  expect(dir4).to.be.instanceOf(smartbucket.Directory);
+  expect(dir4).toBeInstanceOf(smartbucket.Directory);
   const dir4BasePath = dir4.getBasePath();
   console.log(dir4BasePath);
 });
 
-tap.test('should list huge file directory', async () => {
-  const servezoneBucket = await smartbucket.Bucket.getBucketByName(testSmartbucket, 'servezone');
-  const servezoneBaseDirectory = await servezoneBucket.getBaseDirectory();
-  const brandfileDirectory = await servezoneBaseDirectory.getSubDirectoryByName(
-    'public/brandfiles'
-  );
-  const files = await brandfileDirectory.listFiles();
-  const directories = await brandfileDirectory.listDirectories();
-  console.log(files);
-  console.log(directories);
-});
-
 tap.test('clean up directory style tests', async () => {
   await myBucket.fastRemove('dir1/file1.txt');
   await myBucket.fastRemove('dir1/file2.txt');

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/smartbucket',
+  version: '2.0.3',
+  description: 'simple cloud independent object storage'
+}

ts/index.ts

@@ -1,4 +1,4 @@
-export * from './smartbucket.classes.smartbucket';
-export * from './smartbucket.classes.bucket';
-export * from './smartbucket.classes.directory';
-export * from './smartbucket.classes.file';
+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,7 +1,6 @@
-import * as plugins from './smartbucket.plugins';
-import { SmartBucket } from './smartbucket.classes.smartbucket';
-import { Directory } from './smartbucket.classes.directory';
-import { Observable } from 'rxjs';
+import * as plugins from './smartbucket.plugins.js';
+import { SmartBucket } from './smartbucket.classes.smartbucket.js';
+import { Directory } from './smartbucket.classes.directory.js';
 
 export class Bucket {
   public static async getBucketByName(smartbucketRef: SmartBucket, bucketNameArg: string) {
@@ -50,8 +49,8 @@ export class Bucket {
   /**
    * store file
    */
-  public async fastStore(pathArg: string, fileContent: string) {
-    const streamIntake = new plugins.streamfunction.Intake();
+  public async fastStore(pathArg: string, fileContent: string | Buffer): Promise<void> {
+    const streamIntake = new plugins.smartstream.StreamIntake();
     const putPromise = this.smartbucketRef.minioClient
       .putObject(this.name, pathArg, streamIntake.getReadable())
       .catch((e) => console.log(e));
@@ -63,14 +62,16 @@ export class Bucket {
   /**
    * get file
    */
-  public async fastGet(pathArg: string) {
+  public async fastGet(pathArg: string): Promise<Buffer> {
     const done = plugins.smartpromise.defer();
     let completeFile: Buffer;
     const replaySubject = await this.fastGetStream(pathArg);
-    replaySubject.subscribe(
+    const subscription = replaySubject.subscribe(
       (chunk) => {
         if (completeFile) {
           completeFile = Buffer.concat([completeFile, chunk]);
+        } else {
+          completeFile = chunk;
         }
       },
       (err) => {
@@ -78,6 +79,7 @@ export class Bucket {
       },
       () => {
         done.resolve();
+        subscription.unsubscribe();
       }
     );
     await done.promise;
@@ -89,13 +91,12 @@ export class Bucket {
       .getObject(this.name, pathArg)
       .catch((e) => console.log(e));
     const replaySubject = new plugins.smartrx.rxjs.ReplaySubject<Buffer>();
-    const duplexStream = plugins.streamfunction.createDuplexStream<Buffer, Buffer>(
+    const duplexStream = plugins.smartstream.createDuplexStream<Buffer, Buffer>(
       async (chunk) => {
         replaySubject.next(chunk);
         return chunk;
       },
       async (cb) => {
-        console.log('stream ended');
         replaySubject.complete();
         return Buffer.from('');
       }
@@ -105,7 +106,12 @@ export class Bucket {
       return null;
     }
 
-    fileStream.pipe(duplexStream);
+    const smartstream = new plugins.smartstream.StreamWrapper([
+      fileStream,
+      duplexStream,
+      plugins.smartstream.cleanPipe(),
+    ]);
+    smartstream.run();
     return replaySubject;
   }
 

ts/smartbucket.classes.directory.ts

@@ -1,6 +1,6 @@
-import * as plugins from './smartbucket.plugins';
-import { Bucket } from './smartbucket.classes.bucket';
-import { File } from './smartbucket.classes.file';
+import * as plugins from './smartbucket.plugins.js';
+import { Bucket } from './smartbucket.classes.bucket.js';
+import { File } from './smartbucket.classes.file.js';
 
 export class Directory {
   public bucketRef: Bucket;
@@ -70,7 +70,7 @@ export class Directory {
       false
     );
     const fileArray: File[] = [];
-    const duplexStream = plugins.streamfunction.createDuplexStream<plugins.minio.BucketItem, void>(
+    const duplexStream = plugins.smartstream.createDuplexStream<plugins.minio.BucketItem, void>(
       async (bucketItem) => {
         if (bucketItem.prefix) {
           return;
@@ -107,7 +107,7 @@ export class Directory {
       false
     );
     const directoryArray: Directory[] = [];
-    const duplexStream = plugins.streamfunction.createDuplexStream<plugins.minio.BucketItem, void>(
+    const duplexStream = plugins.smartstream.createDuplexStream<plugins.minio.BucketItem, void>(
       async (bucketItem) => {
         if (bucketItem.name) {
           return;
@@ -169,18 +169,19 @@ export class 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 createFile(relativePathArg) {
-    let completeFilePath: string = '';
+  public async createEmptyFile(relativePathArg: string) {
+    const emtpyFile = await File.createFileFromString(this, relativePathArg, '');
   }
 
   // file operations
-  public async fastStore(pathArg: string, contentArg: string) {
+  public async fastStore(pathArg: string, contentArg: string | Buffer) {
     const path = plugins.path.join(this.getBasePath(), pathArg);
     await this.bucketRef.fastStore(path, contentArg);
   }
@@ -201,4 +202,25 @@ export class Directory {
     const path = plugins.path.join(this.getBasePath(), pathArg);
     await this.bucketRef.fastRemove(path);
   }
+
+  /**
+   * deletes the directory with all its contents
+   */
+  public async deleteWithAllContents() {
+    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(file.name);
+      }
+    };
+    await deleteDirectory(this);
+  }
 }

ts/smartbucket.classes.file.ts

@@ -1,5 +1,5 @@
-import * as plugins from './smartbucket.plugins';
-import { Directory } from './smartbucket.classes.directory';
+import * as plugins from './smartbucket.plugins.js';
+import { Directory } from './smartbucket.classes.directory.js';
 
 export interface IFileMetaData {
   name: string;
@@ -23,7 +23,7 @@ export class File {
     fileContent: Buffer
   ) {
     const filePath = plugins.path.join(directoryRef.getBasePath(), fileName);
-    const streamIntake = new plugins.streamfunction.Intake();
+    const streamIntake = new plugins.smartstream.StreamIntake();
     const putPromise = directoryRef.bucketRef.smartbucketRef.minioClient
       .putObject(this.name, filePath, streamIntake.getReadable())
       .catch((e) => console.log(e));
@@ -54,8 +54,8 @@ export class File {
     const fileStream = await this.parentDirectoryRef.bucketRef.smartbucketRef.minioClient
       .getObject(this.parentDirectoryRef.bucketRef.name, this.path)
       .catch((e) => console.log(e));
-    let completeFile = new Buffer('');
-    const duplexStream = plugins.streamfunction.createDuplexStream<Buffer, Buffer>(
+    let completeFile = Buffer.from('');
+    const duplexStream = plugins.smartstream.createDuplexStream<Buffer, Buffer>(
       async (chunk) => {
         completeFile = Buffer.concat([chunk]);
         return chunk;
@@ -76,8 +76,8 @@ export class File {
   }
 
   public async streamContent() {
-    throw new Error('not yet implemented');
     // TODO
+    throw new Error('not yet implemented');
   }
 
   /**

ts/smartbucket.classes.smartbucket.ts

@@ -1,8 +1,10 @@
-import * as plugins from './smartbucket.plugins';
-import { Bucket } from './smartbucket.classes.bucket';
+import * as plugins from './smartbucket.plugins.js';
+import { Bucket } from './smartbucket.classes.bucket.js';
 
 export interface ISmartBucketConfig {
   endpoint: string;
+  port?: number;
+  useSsl?: boolean;
   accessKey: string;
   accessSecret: string;
 }
@@ -19,8 +21,8 @@ export class SmartBucket {
     this.config = configArg;
     this.minioClient = new plugins.minio.Client({
       endPoint: this.config.endpoint,
-      port: 443,
-      useSSL: true,
+      port: configArg.port || 443,
+      useSSL: configArg.useSsl !== undefined ? configArg.useSsl : true,
       accessKey: this.config.accessKey,
       secretKey: this.config.accessSecret,
     });

ts/smartbucket.plugins.ts

@@ -3,12 +3,12 @@ import * as path from 'path';
 
 export { path };
 
-import * as smartpath from '@pushrocks/smartpath';
-import * as smartpromise from '@pushrocks/smartpromise';
-import * as smartrx from '@pushrocks/smartrx';
-import * as streamfunction from '@pushrocks/streamfunction';
+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, streamfunction };
+export { smartpath, smartpromise, smartrx, smartstream };
 
 // third party scope
 import * as minio from '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"
-}