2.0.1

.gitlab-ci.yml

@@ -100,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

npmextra.json

@@ -5,7 +5,7 @@
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smarts3",
-      "shortDescription": "create an s3 endpoint that maps to a local directory",
+      "description": "create an s3 endpoint that maps to a local directory",
       "npmPackagename": "@pushrocks/smarts3",
       "license": "MIT",
       "projectDomain": "push.rocks"

package.json

@@ -1,10 +1,11 @@
 {
   "name": "@pushrocks/smarts3",
-  "version": "1.0.2",
+  "version": "2.0.1",
   "private": false,
   "description": "create an s3 endpoint that maps to a local directory",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
@@ -12,12 +13,11 @@
     "build": "(tsbuild --web)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tsbundle": "^1.0.78",
-    "@gitzone/tstest": "^1.0.44",
-    "@pushrocks/smartbucket": "^1.0.44",
-    "@pushrocks/tapbundle": "^3.2.9",
-    "@types/node": "^17.0.0",
+    "@gitzone/tsbuild": "^2.1.61",
+    "@gitzone/tsbundle": "^1.0.102",
+    "@gitzone/tstest": "^1.0.70",
+    "@pushrocks/tapbundle": "^5.0.3",
+    "@types/node": "^17.0.24",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.15.0"
   },
@@ -37,7 +37,9 @@
     "readme.md"
   ],
   "dependencies": {
-    "@pushrocks/smartfile": "^9.0.3",
+    "@pushrocks/smartbucket": "^2.0.1",
+    "@pushrocks/smartfile": "^9.0.6",
+    "@pushrocks/smartpath": "^5.0.5",
     "@types/s3rver": "^3.7.0",
     "s3rver": "^3.7.1"
   }

test/plugins.ts

@@ -1,5 +1,3 @@
 import * as smartbucket from '@pushrocks/smartbucket';
 
-export {
-  smartbucket
-};
+export { smartbucket };

test/test.ts

@@ -1,28 +1,23 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import * as plugins from './plugins';
+import * as plugins from './plugins.js';
 
-import * as smarts3 from '../ts/index';
+import * as smarts3 from '../ts/index.js';
 
 let testSmarts3Instance: smarts3.Smarts3;
 
-tap.test('should create a smarts3 instance and run it', async toolsArg => {
-  testSmarts3Instance = new smarts3.Smarts3({
+tap.test('should create a smarts3 instance and run it', async (toolsArg) => {
+  testSmarts3Instance = await smarts3.Smarts3.createAndStart({
     port: 3000,
     cleanSlate: true,
   });
-  await testSmarts3Instance.start();
   console.log(`Let the instance run for 2 seconds`);
   await toolsArg.delayFor(2000);
 });
 
 tap.test('should be able to access buckets', async () => {
-  const smartbucketInstance = new plugins.smartbucket.SmartBucket({
-    endpoint: 'localhost',
-    port: 3000,
-    useSsl: false,
-    accessKey: 'S3RVER',
-    accessSecret: 'S3RVER'
-  });
+  const smartbucketInstance = new plugins.smartbucket.SmartBucket(
+    await testSmarts3Instance.getS3Descriptor()
+  );
   const bucket = await smartbucketInstance.createBucket('testbucket');
   const baseDirectory = await bucket.getBaseDirectory();
   await baseDirectory.fastStore('subdir/hello.txt', 'hi there!');
@@ -30,6 +25,6 @@ tap.test('should be able to access buckets', async () => {
 
 tap.test('should stop the instance', async () => {
   await testSmarts3Instance.stop();
-})
+});
 
 tap.start();

ts/index.ts

@@ -1,5 +1,5 @@
-import * as plugins from './smarts3.plugins';
-import * as paths from './paths';
+import * as plugins from './smarts3.plugins.js';
+import * as paths from './paths.js';
 
 export interface ISmarts3ContructorOptions {
   port?: number;
@@ -7,11 +7,23 @@ export interface ISmarts3ContructorOptions {
 }
 
 export class Smarts3 {
+  // STATIC
+  public static async createAndStart(optionsArg: ConstructorParameters<typeof Smarts3>[0]) {
+    const smartS3Instance = new Smarts3(optionsArg);
+    await smartS3Instance.start();
+    return smartS3Instance;
+  }
+
+  // INSTANCE
   public options: ISmarts3ContructorOptions;
   public s3Instance: plugins.s3rver;
 
   constructor(optionsArg: ISmarts3ContructorOptions) {
     this.options = optionsArg;
+    this.options = {
+      ...this.options,
+      ...optionsArg,
+    };
   }
 
   public async start() {
@@ -25,12 +37,27 @@ export class Smarts3 {
       address: '0.0.0.0',
       silent: false,
       directory: paths.bucketsDir,
-      allowMismatchedSignatures: true,
-    })
+    });
     await this.s3Instance.run();
     console.log('s3 server is running');
   }
 
+  public async getS3Descriptor(): Promise<plugins.smartbucket.ISmartBucketConfig> {
+    return {
+      accessKey: 'S3RVER',
+      accessSecret: 'S3RVER',
+      endpoint: 'localhost',
+      port: this.options.port,
+      useSsl: false,
+    };
+  }
+
+  public async createBucket(bucketNameArg: string) {
+    const smartbucketInstance = new plugins.smartbucket.SmartBucket(await this.getS3Descriptor());
+    const bucket = await smartbucketInstance.createBucket(bucketNameArg);
+    return bucket;
+  }
+
   public async stop() {
     await this.s3Instance.close();
   }

ts/paths.ts

@@ -1,6 +1,9 @@
-import * as plugins from './smarts3.plugins';
+import * as plugins from './smarts3.plugins.js';
 
-export const packageDir = plugins.path.join(__dirname, '../');
+export const packageDir = plugins.path.join(
+  plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
+  '../'
+);
 export const nogitDir = plugins.path.join(packageDir, './.nogit');
 
 export const bucketsDir = plugins.path.join(nogitDir, './bucketsDir');

ts/smarts3.plugins.ts

@@ -1,20 +1,16 @@
 // node native
 import * as path from 'path';
 
-export {
-  path
-}
+export { path };
 
 // pushrocks scope
-import * as samrtfile from '@pushrocks/smartfile';
+import * as smartbucket from '@pushrocks/smartbucket';
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartpath from '@pushrocks/smartpath';
 
-export {
-  samrtfile as smartfile
-}
+export { smartbucket, smartfile, smartpath };
 
 // thirdparty scope
 import s3rver from 's3rver';
 
-export {
-  s3rver
-}
+export { s3rver };

tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext"
+  }
+}