Compare commits
15 Commits
Author | SHA1 | Date | |
---|---|---|---|
6e1ff8ed22 | |||
150bf944de | |||
f3a0ff1f63 | |||
8bc939173a | |||
410c16a717 | |||
f809631451 | |||
226bf990b9 | |||
f3e2a8a4f2 | |||
0430a35873 | |||
a074a9558d | |||
e8cc232fa1 | |||
89f48cea21 | |||
784e54f021 | |||
95065de1b5 | |||
ea9d0f58e9 |
@ -12,6 +12,9 @@ stages:
|
||||
- release
|
||||
- metadata
|
||||
|
||||
before_script:
|
||||
- npm install -g @shipzone/npmci
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
@ -38,7 +41,6 @@ auditProductionDependencies:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
|
||||
auditDevDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
@ -98,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
|
||||
@ -122,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
|
||||
|
24
.vscode/launch.json
vendored
24
.vscode/launch.json
vendored
@ -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"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
@ -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"
|
||||
}
|
||||
}
|
||||
|
20678
package-lock.json
generated
20678
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
32
package.json
32
package.json
@ -1,31 +1,31 @@
|
||||
{
|
||||
"name": "@pushrocks/smartbucket",
|
||||
"version": "1.0.43",
|
||||
"name": "@push.rocks/smartbucket",
|
||||
"version": "2.0.4",
|
||||
"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.28",
|
||||
"@gitzone/tstest": "^1.0.60",
|
||||
"@pushrocks/tapbundle": "^3.2.15",
|
||||
"tslint": "^6.1.3",
|
||||
"tslint-config-prettier": "^1.18.0"
|
||||
"@git.zone/tsbuild": "^2.1.63",
|
||||
"@git.zone/tsrun": "^1.2.46",
|
||||
"@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.1.6",
|
||||
"@pushrocks/smartrx": "^2.0.19",
|
||||
"@pushrocks/streamfunction": "^2.0.1",
|
||||
"@types/minio": "^7.0.11",
|
||||
"minio": "^7.0.25"
|
||||
"@push.rocks/smartpath": "^5.0.5",
|
||||
"@push.rocks/smartpromise": "^4.0.3",
|
||||
"@push.rocks/smartrx": "^3.0.7",
|
||||
"@push.rocks/smartstream": "^2.0.2",
|
||||
"@tsclass/tsclass": "^4.0.50",
|
||||
"@types/minio": "^7.0.13",
|
||||
"minio": "^7.0.28"
|
||||
},
|
||||
"private": false,
|
||||
"files": [
|
||||
|
6103
pnpm-lock.yaml
generated
Normal file
6103
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
12
readme.md
12
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 | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||
|
||||
## Usage
|
||||
|
20
test/test.ts
20
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,8 +11,8 @@ 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'),
|
||||
accessKey: await testQenv.getEnvVarOnDemand('S3_KEY'),
|
||||
accessSecret: await testQenv.getEnvVarOnDemand('S3_SECRET'),
|
||||
endpoint: 's3.eu-central-1.wasabisys.com',
|
||||
});
|
||||
});
|
||||
@ -27,8 +27,8 @@ tap.skip.test('should remove testbucket', async () => {
|
||||
|
||||
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,16 +62,16 @@ 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);
|
||||
});
|
||||
|
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@ -0,0 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartbucket',
|
||||
version: '2.0.4',
|
||||
description: 'simple cloud independent object storage'
|
||||
}
|
@ -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';
|
||||
|
@ -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) {
|
||||
@ -51,7 +50,7 @@ export class Bucket {
|
||||
* store file
|
||||
*/
|
||||
public async fastStore(pathArg: string, fileContent: string | Buffer): Promise<void> {
|
||||
const streamIntake = new plugins.streamfunction.Intake();
|
||||
const streamIntake = new plugins.smartstream.StreamIntake();
|
||||
const putPromise = this.smartbucketRef.minioClient
|
||||
.putObject(this.name, pathArg, streamIntake.getReadable())
|
||||
.catch((e) => console.log(e));
|
||||
@ -92,7 +91,7 @@ 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;
|
||||
@ -107,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;
|
||||
}
|
||||
|
||||
|
@ -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,7 +169,7 @@ export class Directory {
|
||||
*/
|
||||
public async move() {
|
||||
// TODO
|
||||
throw new Error('moving a directory is not yet implemented')
|
||||
throw new Error('moving a directory is not yet implemented');
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -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;
|
||||
|
@ -1,28 +1,20 @@
|
||||
import * as plugins from './smartbucket.plugins';
|
||||
import { Bucket } from './smartbucket.classes.bucket';
|
||||
|
||||
export interface ISmartBucketConfig {
|
||||
endpoint: string;
|
||||
port?: number;
|
||||
useSsl?: boolean;
|
||||
accessKey: string;
|
||||
accessSecret: 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 || true,
|
||||
useSSL: configArg.useSsl !== undefined ? configArg.useSsl : true,
|
||||
accessKey: this.config.accessKey,
|
||||
secretKey: this.config.accessSecret,
|
||||
});
|
||||
|
@ -3,12 +3,20 @@ 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';
|
||||
// @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, streamfunction };
|
||||
export { smartpath, smartpromise, smartrx, smartstream };
|
||||
|
||||
// @tsclass
|
||||
import * as tsclass from '@tsclass/tsclass';
|
||||
|
||||
export {
|
||||
tsclass,
|
||||
}
|
||||
|
||||
// third party scope
|
||||
import * as minio from 'minio';
|
||||
|
14
tsconfig.json
Normal file
14
tsconfig.json
Normal file
@ -0,0 +1,14 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
}
|
17
tslint.json
17
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"
|
||||
}
|
Reference in New Issue
Block a user