Compare commits

...

25 Commits

Author SHA1 Message Date
dab74572b8 2.0.5 2024-05-05 19:52:51 +02:00
b871e23052 fix(core): update 2024-05-05 19:52:50 +02:00
caa69ae6ba update tsconfig 2024-04-14 17:22:27 +02:00
f1ee2f096c update npmextra.json: githost 2024-04-01 21:33:55 +02:00
32e574197b update npmextra.json: githost 2024-04-01 19:57:43 +02:00
f13db18b00 update npmextra.json: githost 2024-03-30 21:46:39 +01:00
6e1ff8ed22 2.0.4 2024-02-10 04:36:35 +01:00
150bf944de fix(core): update 2024-02-10 04:36:34 +01:00
f3a0ff1f63 2.0.3 2023-11-03 01:36:12 +01:00
8bc939173a fix(core): update 2023-11-03 01:36:11 +01:00
410c16a717 switch to new org scheme 2023-07-11 00:16:08 +02:00
f809631451 switch to new org scheme 2023-07-10 02:42:17 +02:00
226bf990b9 2.0.2 2022-06-07 17:15:37 +02:00
f3e2a8a4f2 fix(core): update 2022-06-07 17:15:36 +02:00
0430a35873 2.0.1 2022-04-04 13:42:18 +02:00
a074a9558d update 2022-04-04 13:42:15 +02:00
e8cc232fa1 2.0.0 2022-04-02 18:04:57 +02:00
89f48cea21 1.0.45 2022-03-31 01:45:46 +02:00
784e54f021 fix(core): update 2022-03-31 01:45:46 +02:00
95065de1b5 1.0.44 2021-12-18 01:28:22 +01:00
ea9d0f58e9 fix(core): update 2021-12-18 01:28:22 +01:00
9592ab863a 1.0.43 2021-12-18 01:13:02 +01:00
b60ece389c fix(core): update 2021-12-18 01:13:02 +01:00
121c71102a 1.0.42 2021-12-18 01:00:08 +01:00
ec8f320317 fix(core): update 2021-12-18 01:00:07 +01:00
18 changed files with 10734 additions and 18016 deletions

View File

@ -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
View File

@ -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"
}
]
}

View File

@ -5,12 +5,29 @@
"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"
}
}

22117
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,31 +1,31 @@
{
"name": "@pushrocks/smartbucket",
"version": "1.0.41",
"description": "simple cloud independent object storage",
"name": "@push.rocks/smartbucket",
"version": "2.0.5",
"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": "(tsbuild --web)"
"build": "(tsbuild --web --allowimplicitany)"
},
"devDependencies": {
"@gitzone/tsbuild": "^2.1.25",
"@gitzone/tstest": "^1.0.54",
"@pushrocks/tapbundle": "^3.2.14",
"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.7",
"minio": "^7.0.18"
"@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": [
@ -42,5 +42,19 @@
],
"browserslist": [
"last 1 chrome versions"
],
"keywords": [
"cloud storage",
"object storage",
"minio",
"S3",
"TypeScript",
"smartstream",
"smartpromise",
"smartpath",
"smartrx",
"buckets",
"files management",
"directories management"
]
}

6103
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

1
readme.hints.md Normal file
View File

@ -0,0 +1 @@

170
readme.md
View File

@ -1,39 +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
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:
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)
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)
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)
```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
Use TypeScript for best in class intellisense.
`@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.
## Contribution
To use `@push.rocks/smartbucket` in your project, you'll need to follow these general steps:
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
### Setting Up
For further information read the linked docs at the top of this readme.
First, ensure you are using ECMAScript modules (ESM) and TypeScript in your project for best compatibility.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
Here's how to import and initialize smartbucket in a TypeScript file:
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
```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.

View File

@ -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,29 +11,29 @@ 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
tap.test('should store data in bucket fast', async () => {
await myBucket.fastStore('hithere/socool.txt', 'hi there!');
await myBucket.fastPut('hithere/socool.txt', 'hi there!');
});
tap.test('should get data in bucket', async () => {
@ -49,12 +49,12 @@ tap.test('should delete data in bucket', async () => {
// fs operations
tap.test('prepare for directory style tests', async () => {
await myBucket.fastStore('dir1/file1.txt', 'dir1/file1.txt content');
await myBucket.fastStore('dir1/file2.txt', 'dir1/file2.txt content');
await myBucket.fastStore('dir2/file1.txt', 'dir2/file1.txt content');
await myBucket.fastStore('dir3/file1.txt', 'dir3/file1.txt content');
await myBucket.fastStore('dir3/dir4/file1.txt', 'dir3/dir4/file1.txt content');
await myBucket.fastStore('file1.txt', 'file1 content');
await myBucket.fastPut('dir1/file1.txt', 'dir1/file1.txt content');
await myBucket.fastPut('dir1/file2.txt', 'dir1/file2.txt content');
await myBucket.fastPut('dir2/file1.txt', 'dir2/file1.txt content');
await myBucket.fastPut('dir3/file1.txt', 'dir3/file1.txt content');
await myBucket.fastPut('dir3/dir4/file1.txt', 'dir3/dir4/file1.txt content');
await myBucket.fastPut('file1.txt', 'file1 content');
});
tap.test('should get base directory', async () => {
@ -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');

8
ts/00_commitinfo_data.ts Normal file
View File

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

View File

@ -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';

View File

@ -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 | Buffer): Promise<void> {
const streamIntake = new plugins.streamfunction.Intake();
public async fastPut(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));
@ -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,10 +106,68 @@ export class Bucket {
return null;
}
fileStream.pipe(duplexStream);
const smartstream = new plugins.smartstream.StreamWrapper([
fileStream,
duplexStream,
plugins.smartstream.cleanPipe(),
]);
smartstream.run();
return replaySubject;
}
/**
* store file as stream
*/
public async fastPutStream(optionsArg: {
pathArg: string;
dataStream: plugins.stream.Readable;
metadata?: { [key: string]: string };
}): Promise<void> {
await this.smartbucketRef.minioClient.putObject(
this.name,
optionsArg.pathArg,
optionsArg.dataStream,
null,
...(optionsArg.metadata
? (() => {
const returnObject: any = {};
return returnObject;
})()
: {})
);
}
public async updateMetadata(
bucket: string,
objectKey: string,
metadata: { [key: string]: string }
): Promise<void> {
try {
// Retrieve current object information to use in copy conditions
const currentObjInfo = await this.smartbucketRef.minioClient.statObject(bucket, objectKey);
// Setting up copy conditions
const copyConditions = new plugins.minio.CopyConditions();
// Prepare new metadata, merging current and new metadata
const newMetadata = {
...currentObjInfo.metaData,
...metadata,
};
// Define the copy operation as a Promise
await this.smartbucketRef.minioClient.copyObject(
bucket,
objectKey,
`/${bucket}/${objectKey}`,
copyConditions,
);
} catch (err) {
console.error('Error updating metadata:', err);
throw err; // rethrow to allow caller to handle
}
}
/**
* removeObject
*/

View File

@ -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');
}
/**
@ -183,7 +183,7 @@ export class Directory {
// file operations
public async fastStore(pathArg: string, contentArg: string | Buffer) {
const path = plugins.path.join(this.getBasePath(), pathArg);
await this.bucketRef.fastStore(path, contentArg);
await this.bucketRef.fastPut(path, contentArg);
}
public async fastGet(pathArg: string) {

View File

@ -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;

View File

@ -1,26 +1,20 @@
import * as plugins from './smartbucket.plugins';
import { Bucket } from './smartbucket.classes.bucket';
export interface ISmartBucketConfig {
endpoint: string;
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: 443,
useSSL: true,
port: configArg.port || 443,
useSSL: configArg.useSsl !== undefined ? configArg.useSsl : true,
accessKey: this.config.accessKey,
secretKey: this.config.accessSecret,
});

View File

@ -1,14 +1,23 @@
// node native
import * as path from 'path';
import * as stream from 'stream';
export { path };
export { path, stream };
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
View File

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

View File

@ -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"
}