@zola_do/minio 0.2.15 → 0.2.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -9
- package/dist/min-io.module.js +18 -11
- package/dist/min-io.module.js.map +1 -1
- package/dist/min-io.service.d.ts +3 -3
- package/dist/min-io.service.js +15 -10
- package/dist/min-io.service.js.map +1 -1
- package/dist/min-io.tokens.d.ts +1 -0
- package/dist/min-io.tokens.js +5 -0
- package/dist/min-io.tokens.js.map +1 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -14,6 +14,28 @@ MinIO object storage integration for NestJS applications.
|
|
|
14
14
|
- **Presigned URLs** — Secure upload/download links
|
|
15
15
|
- **Bucket Management** — Multiple predefined buckets
|
|
16
16
|
- **Streaming** — Efficient file streaming
|
|
17
|
+
- **Storage contract types** — `ZolaObjectStorage` and `ZolaStoredFileRef` for swappable backends
|
|
18
|
+
|
|
19
|
+
## Storage contract types
|
|
20
|
+
|
|
21
|
+
Use these interfaces when abstracting object storage in your domain layer (same shapes are exported from `@zola_do/seaweed`):
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import {
|
|
25
|
+
ZolaObjectStorage,
|
|
26
|
+
ZolaStoredFileRef,
|
|
27
|
+
} from '@zola_do/minio';
|
|
28
|
+
|
|
29
|
+
// ZolaStoredFileRef — normalized file pointer after upload
|
|
30
|
+
// { bucket, key, url?, etag?, contentType?, size? }
|
|
31
|
+
|
|
32
|
+
// ZolaObjectStorage — minimal upload/read/delete surface
|
|
33
|
+
class MyService {
|
|
34
|
+
constructor(private readonly storage: ZolaObjectStorage) {}
|
|
35
|
+
}
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Implement `ZolaObjectStorage` against MinIO in this package or against Seaweed/S3 via `@zola_do/seaweed` without cross-package imports.
|
|
17
39
|
|
|
18
40
|
## Installation
|
|
19
41
|
|
|
@@ -25,17 +47,9 @@ npm install @zola_do/minio
|
|
|
25
47
|
npm install @zola_do/nestjs-shared
|
|
26
48
|
```
|
|
27
49
|
|
|
28
|
-
**Note:** If installation fails due to `nestjs-minio-client` postinstall script, use:
|
|
29
|
-
|
|
30
|
-
```bash
|
|
31
|
-
npm install @zola_do/minio --ignore-scripts
|
|
32
|
-
```
|
|
33
|
-
|
|
34
50
|
### Dependencies
|
|
35
51
|
|
|
36
|
-
|
|
37
|
-
npm install nestjs-minio-client
|
|
38
|
-
```
|
|
52
|
+
`@zola_do/minio` bundles the official [`minio`](https://www.npmjs.com/package/minio) client (no install scripts). No extra storage wrapper package is required.
|
|
39
53
|
|
|
40
54
|
## Quick Start
|
|
41
55
|
|
package/dist/min-io.module.js
CHANGED
|
@@ -5,29 +5,36 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
|
|
|
5
5
|
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
6
|
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
7
|
};
|
|
8
|
-
var _a, _b;
|
|
9
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
10
9
|
exports.MinIOModule = void 0;
|
|
11
10
|
const common_1 = require("@nestjs/common");
|
|
12
|
-
const
|
|
11
|
+
const Minio = require("minio");
|
|
13
12
|
const min_io_service_1 = require("./min-io.service");
|
|
14
13
|
const min_io_zola_object_storage_1 = require("./min-io.zola-object-storage");
|
|
14
|
+
const min_io_tokens_1 = require("./min-io.tokens");
|
|
15
15
|
let MinIOModule = class MinIOModule {
|
|
16
16
|
};
|
|
17
17
|
exports.MinIOModule = MinIOModule;
|
|
18
18
|
exports.MinIOModule = MinIOModule = __decorate([
|
|
19
19
|
(0, common_1.Module)({
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
20
|
+
providers: [
|
|
21
|
+
{
|
|
22
|
+
provide: min_io_tokens_1.MINIO_CLIENT,
|
|
23
|
+
useFactory: () => {
|
|
24
|
+
var _a, _b;
|
|
25
|
+
return new Minio.Client({
|
|
26
|
+
endPoint: process.env.MINIO_ENDPOINT,
|
|
27
|
+
port: Number((_a = process.env.MINIO_PORT) !== null && _a !== void 0 ? _a : 443),
|
|
28
|
+
useSSL: Boolean((_b = process.env.MINIO_USESSL) !== null && _b !== void 0 ? _b : true),
|
|
29
|
+
accessKey: process.env.MINIO_ACCESSKEY,
|
|
30
|
+
secretKey: process.env.MINIO_SECRETKEY,
|
|
31
|
+
});
|
|
32
|
+
},
|
|
33
|
+
},
|
|
34
|
+
min_io_service_1.MinIOService,
|
|
35
|
+
min_io_zola_object_storage_1.MinioZolaObjectStorage,
|
|
28
36
|
],
|
|
29
37
|
controllers: [],
|
|
30
|
-
providers: [min_io_service_1.MinIOService, min_io_zola_object_storage_1.MinioZolaObjectStorage],
|
|
31
38
|
exports: [min_io_service_1.MinIOService, min_io_zola_object_storage_1.MinioZolaObjectStorage],
|
|
32
39
|
})
|
|
33
40
|
], MinIOModule);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"min-io.module.js","sourceRoot":"","sources":["../src/min-io.module.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"min-io.module.js","sourceRoot":"","sources":["../src/min-io.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AACxC,+BAA+B;AAC/B,qDAAgD;AAChD,6EAAsE;AACtE,mDAA+C;AAqBxC,IAAM,WAAW,GAAjB,MAAM,WAAW;CAAG,CAAA;AAAd,kCAAW;sBAAX,WAAW;IAnBvB,IAAA,eAAM,EAAC;QACN,SAAS,EAAE;YACT;gBACE,OAAO,EAAE,4BAAY;gBACrB,UAAU,EAAE,GAAG,EAAE;;oBACf,OAAA,IAAI,KAAK,CAAC,MAAM,CAAC;wBACf,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,cAAc;wBACpC,IAAI,EAAE,MAAM,CAAC,MAAA,OAAO,CAAC,GAAG,CAAC,UAAU,mCAAI,GAAG,CAAC;wBAC3C,MAAM,EAAE,OAAO,CAAC,MAAA,OAAO,CAAC,GAAG,CAAC,YAAY,mCAAI,IAAI,CAAC;wBACjD,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,eAAe;wBACtC,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,eAAe;qBACvC,CAAC,CAAA;iBAAA;aACL;YACD,6BAAY;YACZ,mDAAsB;SACvB;QACD,WAAW,EAAE,EAAE;QACf,OAAO,EAAE,CAAC,6BAAY,EAAE,mDAAsB,CAAC;KAChD,CAAC;GACW,WAAW,CAAG"}
|
package/dist/min-io.service.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { Response } from 'express';
|
|
2
|
-
import
|
|
2
|
+
import * as Minio from 'minio';
|
|
3
3
|
export declare class MinIOService {
|
|
4
|
-
private readonly
|
|
5
|
-
constructor(
|
|
4
|
+
private readonly client;
|
|
5
|
+
constructor(client: Minio.Client);
|
|
6
6
|
upload(file: Express.Multer.File, bucketName: string, metaData?: {}): Promise<any>;
|
|
7
7
|
generatePresignedUploadUrl(fileInfo: {
|
|
8
8
|
originalname: string;
|
package/dist/min-io.service.js
CHANGED
|
@@ -8,21 +8,25 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
|
|
|
8
8
|
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
9
|
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
10
|
};
|
|
11
|
+
var __param = (this && this.__param) || function (paramIndex, decorator) {
|
|
12
|
+
return function (target, key) { decorator(target, key, paramIndex); }
|
|
13
|
+
};
|
|
11
14
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
15
|
exports.MinIOService = void 0;
|
|
13
16
|
const common_1 = require("@nestjs/common");
|
|
14
|
-
const
|
|
17
|
+
const Minio = require("minio");
|
|
15
18
|
const path_1 = require("path");
|
|
16
19
|
const crypto_1 = require("crypto");
|
|
17
20
|
const bucket_name_enum_1 = require("./bucket-name.enum");
|
|
21
|
+
const min_io_tokens_1 = require("./min-io.tokens");
|
|
18
22
|
let MinIOService = class MinIOService {
|
|
19
|
-
constructor(
|
|
20
|
-
this.
|
|
23
|
+
constructor(client) {
|
|
24
|
+
this.client = client;
|
|
21
25
|
}
|
|
22
26
|
async upload(file, bucketName, metaData = {}) {
|
|
23
27
|
try {
|
|
24
28
|
const filepath = (0, crypto_1.randomUUID)() + (0, path_1.extname)(file.originalname);
|
|
25
|
-
await this.
|
|
29
|
+
await this.client.putObject(bucket_name_enum_1.BucketNameEnum.MEGP, bucketName ? bucketName + filepath : filepath, file.buffer, file.size, Object.assign(Object.assign({}, metaData), { 'Content-Type': file.mimetype }));
|
|
26
30
|
return {
|
|
27
31
|
filepath,
|
|
28
32
|
bucketName,
|
|
@@ -38,7 +42,7 @@ let MinIOService = class MinIOService {
|
|
|
38
42
|
var _a;
|
|
39
43
|
const filepath = (0, crypto_1.randomUUID)() + (0, path_1.extname)(fileInfo.originalname);
|
|
40
44
|
const duration = Number((_a = process.env.DURATION_OF_PRE_SIGNED_DOCUMENT) !== null && _a !== void 0 ? _a : 120);
|
|
41
|
-
const presignedUrl = await this.
|
|
45
|
+
const presignedUrl = await this.client.presignedPutObject(bucket_name_enum_1.BucketNameEnum.MEGP, bucketName ? bucketName + filepath : filepath, duration);
|
|
42
46
|
const file = {
|
|
43
47
|
filepath,
|
|
44
48
|
bucketName: bucketName,
|
|
@@ -50,7 +54,7 @@ let MinIOService = class MinIOService {
|
|
|
50
54
|
async uploadBuffer(buffer, originalname, mimetype, bucketName, metaData = {}) {
|
|
51
55
|
try {
|
|
52
56
|
const filepath = (0, crypto_1.randomUUID)() + (0, path_1.extname)(originalname);
|
|
53
|
-
await this.
|
|
57
|
+
await this.client.putObject(bucket_name_enum_1.BucketNameEnum.MEGP, bucketName ? bucketName + filepath : filepath, buffer, Buffer.byteLength(buffer), Object.assign(Object.assign({}, metaData), { 'Content-Type': mimetype }));
|
|
54
58
|
return {
|
|
55
59
|
filepath,
|
|
56
60
|
bucketName,
|
|
@@ -63,7 +67,7 @@ let MinIOService = class MinIOService {
|
|
|
63
67
|
}
|
|
64
68
|
}
|
|
65
69
|
async download(fileInfo, response) {
|
|
66
|
-
const result = await this.
|
|
70
|
+
const result = await this.client.getObject(bucket_name_enum_1.BucketNameEnum.MEGP, fileInfo.bucketName
|
|
67
71
|
? fileInfo.bucketName + fileInfo.filepath
|
|
68
72
|
: fileInfo.filepath);
|
|
69
73
|
response.setHeader('Content-Type', fileInfo.contentType);
|
|
@@ -74,13 +78,13 @@ let MinIOService = class MinIOService {
|
|
|
74
78
|
async generatePresignedDownloadUrl(fileInfo) {
|
|
75
79
|
var _a;
|
|
76
80
|
const duration = Number((_a = process.env.DURATION_OF_PRE_SIGNED_DOCUMENT) !== null && _a !== void 0 ? _a : 120);
|
|
77
|
-
const presignedUrl = await this.
|
|
81
|
+
const presignedUrl = await this.client.presignedGetObject(bucket_name_enum_1.BucketNameEnum.MEGP, fileInfo.bucketName
|
|
78
82
|
? fileInfo.bucketName + fileInfo.filepath
|
|
79
83
|
: fileInfo.filepath, duration);
|
|
80
84
|
return presignedUrl;
|
|
81
85
|
}
|
|
82
86
|
async downloadBuffer(fileInfo) {
|
|
83
|
-
const result = await this.
|
|
87
|
+
const result = await this.client.getObject(bucket_name_enum_1.BucketNameEnum.MEGP, fileInfo.bucketName
|
|
84
88
|
? fileInfo.bucketName + fileInfo.filepath
|
|
85
89
|
: fileInfo.filepath);
|
|
86
90
|
return result;
|
|
@@ -89,6 +93,7 @@ let MinIOService = class MinIOService {
|
|
|
89
93
|
exports.MinIOService = MinIOService;
|
|
90
94
|
exports.MinIOService = MinIOService = __decorate([
|
|
91
95
|
(0, common_1.Injectable)(),
|
|
92
|
-
|
|
96
|
+
__param(0, (0, common_1.Inject)(min_io_tokens_1.MINIO_CLIENT)),
|
|
97
|
+
__metadata("design:paramtypes", [Minio.Client])
|
|
93
98
|
], MinIOService);
|
|
94
99
|
//# sourceMappingURL=min-io.service.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"min-io.service.js","sourceRoot":"","sources":["../src/min-io.service.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"min-io.service.js","sourceRoot":"","sources":["../src/min-io.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAoD;AAEpD,+BAA+B;AAC/B,+BAA+B;AAC/B,mCAAoC;AACpC,yDAAoD;AACpD,mDAA+C;AAGxC,IAAM,YAAY,GAAlB,MAAM,YAAY;IACvB,YAAmD,MAAoB;QAApB,WAAM,GAAN,MAAM,CAAc;IAAG,CAAC;IAE3E,KAAK,CAAC,MAAM,CACV,IAAyB,EACzB,UAAkB,EAClB,QAAQ,GAAG,EAAE;QAEb,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,IAAA,mBAAU,GAAE,GAAG,IAAA,cAAO,EAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC3D,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CACzB,iCAAc,CAAC,IAAI,EACnB,UAAU,CAAC,CAAC,CAAC,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAC7C,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,IAAI,kCACJ,QAAQ,KAAE,cAAc,EAAE,IAAI,CAAC,QAAQ,IAC7C,CAAC;YACF,OAAO;gBACL,QAAQ;gBACR,UAAU;gBACV,WAAW,EAAE,IAAI,CAAC,QAAQ;gBAC1B,YAAY,EAAE,IAAI,CAAC,YAAY;aAChC,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,KAAK,CAAC,0BAA0B,CAC9B,QAGC,EACD,UAAU,GAAG,EAAE;;QAEf,MAAM,QAAQ,GAAG,IAAA,mBAAU,GAAE,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAE/D,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAA,OAAO,CAAC,GAAG,CAAC,+BAA+B,mCAAI,GAAG,CAAC,CAAC;QAC5E,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,kBAAkB,CACvD,iCAAc,CAAC,IAAI,EACnB,UAAU,CAAC,CAAC,CAAC,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAC7C,QAAQ,CACT,CAAC;QAEF,MAAM,IAAI,GAAG;YACX,QAAQ;YACR,UAAU,EAAE,UAAU;YACtB,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,YAAY,EAAE,QAAQ,CAAC,YAAY;SACpC,CAAC;QAEF,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,MAAW,EACX,YAAoB,EACpB,QAAgB,EAChB,UAAkB,EAClB,QAAQ,GAAG,EAAE;QAOb,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,IAAA,mBAAU,GAAE,GAAG,IAAA,cAAO,EAAC,YAAY,CAAC,CAAC;YACtD,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CACzB,iCAAc,CAAC,IAAI,EACnB,UAAU,CAAC,CAAC,CAAC,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAC7C,MAAM,EACN,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,kCACpB,QAAQ,KAAE,cAAc,EAAE,QAAQ,IACxC,CAAC;YACF,OAAO;gBACL,QAAQ;gBACR,UAAU;gBACV,WAAW,EAAE,QAAQ;gBACrB,YAAY,EAAE,YAAY;aAC3B,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,QAAwE,EACxE,QAAkB;QAElB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CACxC,iCAAc,CAAC,IAAI,EACnB,QAAQ,CAAC,UAAU;YACjB,CAAC,CAAC,QAAQ,CAAC,UAAU,GAAG,QAAQ,CAAC,QAAQ;YACzC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CACtB,CAAC;QAEF,QAAQ,CAAC,SAAS,CAAC,cAAc,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;QACzD,QAAQ,CAAC,SAAS,CAChB,qBAAqB,EACrB,wBAAwB,QAAQ,CAAC,QAAQ,EAAE,CAC5C,CAAC;QACF,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEtB,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,4BAA4B,CAAC,QAIlC;;QACC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAA,OAAO,CAAC,GAAG,CAAC,+BAA+B,mCAAI,GAAG,CAAC,CAAC;QAC5E,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,kBAAkB,CACvD,iCAAc,CAAC,IAAI,EACnB,QAAQ,CAAC,UAAU;YACjB,CAAC,CAAC,QAAQ,CAAC,UAAU,GAAG,QAAQ,CAAC,QAAQ;YACzC,CAAC,CAAC,QAAQ,CAAC,QAAQ,EACrB,QAAQ,CACT,CAAC;QACF,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,QAIpB;QACC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CACxC,iCAAc,CAAC,IAAI,EACnB,QAAQ,CAAC,UAAU;YACjB,CAAC,CAAC,QAAQ,CAAC,UAAU,GAAG,QAAQ,CAAC,QAAQ;YACzC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CACtB,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;CACF,CAAA;AAzIY,oCAAY;uBAAZ,YAAY;IADxB,IAAA,mBAAU,GAAE;IAEE,WAAA,IAAA,eAAM,EAAC,4BAAY,CAAC,CAAA;qCAA0B,KAAK,CAAC,MAAM;GAD5D,YAAY,CAyIxB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const MINIO_CLIENT: unique symbol;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"min-io.tokens.js","sourceRoot":"","sources":["../src/min-io.tokens.ts"],"names":[],"mappings":";;;AAAa,QAAA,YAAY,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zola_do/minio",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.17",
|
|
4
4
|
"description": "MinIO object storage for NestJS",
|
|
5
5
|
"author": "zolaDO",
|
|
6
6
|
"license": "ISC",
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"rxjs": "^7.0.0 || ^8.0.0"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"
|
|
39
|
+
"minio": "^8.0.6"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
42
|
"rimraf": "^6.1.3",
|