# Minio Module
```Minio``` module for the Hapiness framework.
## Table of contents
* [Using your module inside Hapiness application](#using-your-module-inside-hapiness-application)
* [`yarn` or `npm` it in your `package.json`](#yarn-or-npm-it-in-your-package)
* [Importing `MinioModule` from the library](#importing-miniomodule-from-the-library)
* [Using `Minio` inside your application](#using-minio-inside-your-application)
## Using your module inside Hapiness application
### `yarn` or `npm` it in your `package.json`
```bash
$ npm install --save @hapiness/minio
or
$ yarn add @hapiness/redis
```
```javascript
"dependencies": {
"@hapiness/core": "^1.0.0-rc.6",
"@hapiness/minio": "^1.0.0-rc.7",
//...
}
//...
```
[Back to top](#table-of-contents)
### Importing `MinioModule` from the library
This module provide an Hapiness extension for Minio.
To use it, simply register it during the ```bootstrap``` step of your project and provide the ```MinioExt``` with its config
```javascript
@HapinessModule({
version: '1.0.0',
providers: [],
declarations: [],
imports: [MinioModule]
})
class MyApp implements OnStart {
constructor() {}
onStart() {}
}
Hapiness
.bootstrap(
MyApp,
[
/* ... */
MinioExt.setConfig(
{
connection: {
endPoint: 'minio.mydomain.com',
port: 443,
secure: true,
accessKey: 'access_key',
secretKey: 'secret_key'
},
default_region: 'us-east-1'
}
)
]
)
.catch(err => {
/* ... */
});
```
You need to provide the connection information under the ```connection``` key in the config object. You are also able to determine a default region for your buckets under the key ```default_region```. If you dont provide a ```default_region```, every functions using a region will use the value ```us-east-1``` if you dont give any to the function.
Allowed region values are:
- us-east-1
- us-west-1
- us-west-2
- eu-west-1
- eu-central-1
- ap-southeast-1
- ap-southeast-2
- ap-northeast-1
- sa-east-1
- cn-north-1
[Back to top](#table-of-contents)
### Using `Minio` inside your application
To use minio, you need to inject inside your providers the ```MinioService```.
**NOTE:** all functions in the api return ```rxjs``` Observable
```javascript
class FooProvider {
constructor(private _minio: MinioService) {}
createBucketIfNotExists(bucket_name: string): Observable {
return this
._minio
.bucketExists(bucket_name)
.switchMap(
_ => !!_ ?
Observable.of(false) :
this._minio.makeBucket(bucket_name)
);
}
}
```
[Back to top](#table-of-contents)
## ```MinioService``` documentation
**NOTES:**
- All functions in the api return ```rxjs``` Observable
- We followed the minio nodejs lib, so for more information, please refer to [the official documentation](https://docs.minio.io/docs/javascript-client-api-reference)
```javascript
/* Get a new Copy Condition instance */
public newMinioCopyCondition(): MinioCopyCondition;
/* Get a new Post Policy instance */
public newMinioPostPolicy(): MinioPostPolicy;
/* Create a bucket */
public makeBucket(bucketName: string, region?: MinioBucketRegion): Observable;
/* Check if a bucket already exists */
public bucketExists(bucketName: string): Observable;
/* List all buckets */
public listBuckets(): Observable;
/* Lists all objects in a bucket */
public listObjects(bucketName: string, prefix: string = '', recursive: boolean = false): Observable;
/* Lists all objects in a bucket using S3 listing objects V2 API */
public listObjectsV2(bucketName: string, prefix: string = '', recursive: boolean = false): Observable;
/* Lists partially uploaded objects in a bucket */
public listIncompleteUploads(bucketName: string, prefix: string = '', recursive: boolean = false): Observable;
/* Downloads an object as a stream */
public getObject(bucketName: string, objectName: string): Observable;
/* Downloads the specified range bytes of an object as a stream */
public getPartialObject(bucketName: string, objectName: string, offset: number, length: number = 0): Observable;
/* Downloads and saves the object as a file in the local filesystem */
public fGetObject(bucketName: string, objectName: string, filePath: string): Observable;
/* Uploads an object from a stream/Buffer */
public putObject(bucketName: string, objectName: string, stream: ReadStream | string | Buffer, size?: number, contentType: string = 'application/octet-stream'): Observable;
/* Uploads contents from a file to objectName */
public fPutObject(bucketName: string, objectName: string, filePath: string, contentType: string = 'application/octet-stream'): Observable;
/* Copy a source object into a new object in the specied bucket */
public copyObject(bucketName: string, objectName: string, sourceObject: string, conditions: MinioCopyCondition): Observable;
/* Gets metadata of an object */
public statObject(bucketName: string, objectName: string): Observable;
/* Removes an object */
public removeObject(bucketName: string, objectName: string): Observable;
/* Removes a partially uploaded object */
public removeIncompleteUpload(bucketName: string, objectName: string): Observable;
/*
* Generates a presigned URL for HTTP GET operations.
* Browsers/Mobile clients may point to this URL to directly download objects even if the bucket is private.
* This presigned URL can have an associated expiration time in seconds after which the URL is no longer valid.
* The default expiry is set to 7 days
*/
public presignedGetObject(bucketName: string, objectName: string, expiry: number = 604800): Observable;
/*
* Generates a presigned URL for HTTP PUT operations.
* Browsers/Mobile clients may point to this URL to upload objects directly to a bucket even if it is private.
* This presigned URL can have an associated expiration time in seconds after which the URL is no longer valid.
* The default expiry is set to 7 days
*/
public presignedPutObject(bucketName: string, objectName: string, expiry: number = 604800): Observable;
/*
* Allows setting policy conditions to a presigned URL for POST operations.
* Policies such as bucket name to receive object uploads, key name prefixes, expiry policy may be set
*/
public presignedPostPolicy(policy: MinioPostPolicy): Observable;
/*
* Fetch the notification configuration stored in the S3 provider and that belongs to
* the specified bucket name
*/
public getBucketNotification(bucketName: string): Observable;
/*
* Upload a user-created notification configuration and associate it to the specified bucket name
*/
public setBucketNotification(bucketName: string, bucketNotificationConfig: any): Observable;
/*
* Remove the bucket notification configuration associated to the specified bucket
*/
public removeAllBucketNotification(bucketName: string): Observable;
/*
* Listen for notifications on a bucket.
* Additionally one can provider filters for prefix, suffix and events.
* There is no prior set bucket notification needed to use this API.
* This is an Minio extension API where unique identifiers are regitered and unregistered
* by the server automatically based on incoming requests
*/
public listenBucketNotification(bucketName: string, prefix: string, suffix: string, events: string[]): EventEmitter;
/*
* Get the bucket policy associated with the specified bucket.
* If objectPrefix is not empty, the bucket policy will be filtered based on object permissions as well.
*/
public getBucketPolicy(bucketName: string, objectPrefix: string = ''): Observable;
/*
* Set the bucket policy associated with the specified bucket.
* If objectPrefix is not empty, the bucket policy will only be assigned to objects that fit the given prefix
*/
public setBucketPolicy(bucketName: string, bucketPolicy: MinioPolicy, objectPrefix: string = ''): Observable;
```
[Back to top](#table-of-contents)
## Maintainers
[Back to top](#table-of-contents)
## License
Copyright (c) 2017 **Hapiness** Licensed under the [MIT license](https://github.com/hapinessjs/minio-module/blob/master/LICENSE.md).
[Back to top](#table-of-contents)
