@sandumo/nestjs-storage-module 1.0.0 → 1.0.1
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 +13 -7
- package/dist/storage.module.d.ts +2 -2
- package/dist/storage.module.d.ts.map +1 -1
- package/dist/storage.module.js +3 -3
- package/dist/storage.module.js.map +1 -1
- package/dist/storage.options.d.ts +17 -4
- package/dist/storage.options.d.ts.map +1 -1
- package/dist/storage.options.js.map +1 -1
- package/dist/storage.service.js +4 -4
- package/dist/storage.service.js.map +1 -1
- package/package.json +2 -3
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @sandumo/nestjs-storage-module
|
|
2
2
|
|
|
3
|
-
This package provides a NestJS module for interacting with storage.
|
|
3
|
+
This package provides a NestJS module for interacting with S3 compatible storage.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -14,11 +14,17 @@ npm install @sandumo/nestjs-storage-module
|
|
|
14
14
|
import { StorageModule } from '@sandumo/nestjs-storage-module';
|
|
15
15
|
|
|
16
16
|
@Module({
|
|
17
|
-
imports: [
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
17
|
+
imports: [
|
|
18
|
+
StorageModule.forRootAsync({
|
|
19
|
+
imports: [ConfigModule],
|
|
20
|
+
inject: [ConfigService],
|
|
21
|
+
useFactory: async (configService: ConfigService) => ({
|
|
22
|
+
endpoint: configService.getS3Endpoint(),
|
|
23
|
+
accessKeyId: configService.getS3AccessKeyId(),
|
|
24
|
+
secretAccessKey: configService.getS3SecretAccessKey(),
|
|
25
|
+
bucket: configService.getS3Bucket(),
|
|
26
|
+
}),
|
|
27
|
+
}),
|
|
28
|
+
]
|
|
23
29
|
})
|
|
24
30
|
```
|
package/dist/storage.module.d.ts
CHANGED
|
@@ -2,9 +2,9 @@ import { DynamicModule } from '@nestjs/common';
|
|
|
2
2
|
import { StorageModuleOptions } from './storage.options';
|
|
3
3
|
export declare class StorageModule {
|
|
4
4
|
static forRootAsync(options: {
|
|
5
|
-
useFactory: (...args: any[]) => Promise<StorageModuleOptions> | StorageModuleOptions;
|
|
6
|
-
inject?: any[];
|
|
7
5
|
imports?: any[];
|
|
6
|
+
inject?: any[];
|
|
7
|
+
useFactory: (...args: any[]) => Promise<StorageModuleOptions> | StorageModuleOptions;
|
|
8
8
|
}): DynamicModule;
|
|
9
9
|
}
|
|
10
10
|
//# sourceMappingURL=storage.module.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"storage.module.d.ts","sourceRoot":"","sources":["../src/storage.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAkB,MAAM,gBAAgB,CAAC;AAE/D,OAAO,EAA0B,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAEjF,qBAKa,aAAa;IACxB,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE;QAC3B,
|
|
1
|
+
{"version":3,"file":"storage.module.d.ts","sourceRoot":"","sources":["../src/storage.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAkB,MAAM,gBAAgB,CAAC;AAE/D,OAAO,EAA0B,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAEjF,qBAKa,aAAa;IACxB,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE;QAC3B,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC;QAChB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;QACf,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,oBAAoB,CAAC,GAAG,oBAAoB,CAAC;KACtF,GAAG,aAAa;CAgBlB"}
|
package/dist/storage.module.js
CHANGED
|
@@ -18,13 +18,13 @@ let StorageModule = StorageModule_1 = class StorageModule {
|
|
|
18
18
|
provide: storage_options_1.STORAGE_MODULE_OPTIONS,
|
|
19
19
|
useFactory: options.useFactory,
|
|
20
20
|
inject: options.inject || [],
|
|
21
|
-
imports: options.imports || [],
|
|
22
21
|
},
|
|
23
22
|
];
|
|
24
23
|
return {
|
|
25
|
-
providers: providers,
|
|
26
|
-
exports: providers,
|
|
27
24
|
module: StorageModule_1,
|
|
25
|
+
imports: options.imports || [],
|
|
26
|
+
providers: providers,
|
|
27
|
+
exports: [storage_service_1.StorageService],
|
|
28
28
|
};
|
|
29
29
|
}
|
|
30
30
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"storage.module.js","sourceRoot":"","sources":["../src/storage.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAA+D;AAC/D,uDAAmD;AACnD,uDAAiF;AAO1E,IAAM,aAAa,qBAAnB,MAAM,aAAa;IACxB,MAAM,CAAC,YAAY,CAAC,OAInB;QACC,MAAM,SAAS,GAAG;YAChB;gBACE,OAAO,EAAE,wCAAsB;gBAC/B,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;
|
|
1
|
+
{"version":3,"file":"storage.module.js","sourceRoot":"","sources":["../src/storage.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAA+D;AAC/D,uDAAmD;AACnD,uDAAiF;AAO1E,IAAM,aAAa,qBAAnB,MAAM,aAAa;IACxB,MAAM,CAAC,YAAY,CAAC,OAInB;QACC,MAAM,SAAS,GAAG;YAChB;gBACE,OAAO,EAAE,wCAAsB;gBAC/B,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;aAC7B;SACF,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;YAC9B,SAAS,EAAE,SAAS;YACpB,OAAO,EAAE,CAAC,gCAAc,CAAC;SAC1B,CAAC;IACJ,CAAC;CACF,CAAA;AArBY,aAAa;IALzB,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,SAAS,EAAE,CAAC,gCAAc,CAAC;QAC3B,OAAO,EAAE,CAAC,gCAAc,CAAC;KACxB,CAAC;GACS,aAAa,CAqBzB;AArBY,sCAAa"}
|
|
@@ -1,9 +1,22 @@
|
|
|
1
1
|
export interface StorageModuleOptions {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
endpoint: string;
|
|
3
|
+
accessKeyId: string;
|
|
4
|
+
secretAccessKey: string;
|
|
5
|
+
/**
|
|
6
|
+
* @default 'default'
|
|
7
|
+
*/
|
|
8
|
+
bucket?: string;
|
|
9
|
+
/**
|
|
10
|
+
* @default 'us-east-1'
|
|
11
|
+
*/
|
|
6
12
|
region?: string;
|
|
13
|
+
/**
|
|
14
|
+
* @default true
|
|
15
|
+
*/
|
|
16
|
+
forcePathStyle?: boolean;
|
|
17
|
+
/**
|
|
18
|
+
* @default '/'
|
|
19
|
+
*/
|
|
7
20
|
rootPath?: string;
|
|
8
21
|
}
|
|
9
22
|
export declare const STORAGE_MODULE_OPTIONS: unique symbol;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"storage.options.d.ts","sourceRoot":"","sources":["../src/storage.options.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,oBAAoB;IACnC,
|
|
1
|
+
{"version":3,"file":"storage.options.d.ts","sourceRoot":"","sources":["../src/storage.options.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,eAAO,MAAM,sBAAsB,eAAmC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"storage.options.js","sourceRoot":"","sources":["../src/storage.options.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"storage.options.js","sourceRoot":"","sources":["../src/storage.options.ts"],"names":[],"mappings":";;;AA0Ba,QAAA,sBAAsB,GAAG,MAAM,CAAC,wBAAwB,CAAC,CAAC"}
|
package/dist/storage.service.js
CHANGED
|
@@ -37,14 +37,14 @@ let StorageService = class StorageService {
|
|
|
37
37
|
try {
|
|
38
38
|
this.s3Client = new client_s3_1.S3Client({
|
|
39
39
|
credentials: {
|
|
40
|
-
accessKeyId: this.options.
|
|
41
|
-
secretAccessKey: this.options.
|
|
40
|
+
accessKeyId: this.options.accessKeyId,
|
|
41
|
+
secretAccessKey: this.options.secretAccessKey,
|
|
42
42
|
},
|
|
43
|
-
endpoint: this.options.
|
|
43
|
+
endpoint: this.options.endpoint,
|
|
44
44
|
region: this.options.region || 'us-east-1',
|
|
45
45
|
forcePathStyle: true,
|
|
46
46
|
});
|
|
47
|
-
this.BUCKET = this.options.
|
|
47
|
+
this.BUCKET = this.options.bucket || 'default';
|
|
48
48
|
this.ROOT_PATH = this.options.rootPath ? this.options.rootPath + (this.options.rootPath.endsWith('/') ? '' : '/') : '';
|
|
49
49
|
this.createBucket();
|
|
50
50
|
this._isUp = true;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"storage.service.js","sourceRoot":"","sources":["../src/storage.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,kDAAmK;AACnK,2CAAoD;AAEpD,uDAAiF;AAEjF,mCAAqC;AAG9B,IAAM,cAAc,GAApB,MAAM,cAAc;IAMzB,YAAoD,OAA6B;QAA7B,YAAO,GAAP,OAAO,CAAsB;QAC/E,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QAEjC,IAAI;YACF,IAAI,CAAC,QAAQ,GAAG,IAAI,oBAAQ,CAAC;gBAC3B,WAAW,EAAE;oBACX,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,
|
|
1
|
+
{"version":3,"file":"storage.service.js","sourceRoot":"","sources":["../src/storage.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,kDAAmK;AACnK,2CAAoD;AAEpD,uDAAiF;AAEjF,mCAAqC;AAG9B,IAAM,cAAc,GAApB,MAAM,cAAc;IAMzB,YAAoD,OAA6B;QAA7B,YAAO,GAAP,OAAO,CAAsB;QAC/E,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QAEjC,IAAI;YACF,IAAI,CAAC,QAAQ,GAAG,IAAI,oBAAQ,CAAC;gBAC3B,WAAW,EAAE;oBACX,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW;oBACrC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe;iBAC9C;gBACD,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;gBAC/B,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,WAAW;gBAC1C,cAAc,EAAE,IAAI;aACrB,CAAC,CAAC;YACH,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,SAAS,CAAC;YAC/C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACvH,IAAI,CAAC,YAAY,EAAE,CAAC;YACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;SACnB;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SACtB;IACH,CAAC;IAEO,IAAI;QACV,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAEK,SAAS,CAAC,GAAW;;YACzB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE;gBAChB,OAAO,IAAI,CAAC;aACb;YACD,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;YAElC,MAAM,OAAO,GAAG,IAAI,4BAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;YACxE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACnD,OAAO,QAAQ,CAAC,IAAgB,CAAC;QACnC,CAAC;KAAA;IAEK,SAAS,CAAC,QAAgB,EAAE,IAAY;;YAC5C,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE;gBAChB,OAAO,IAAI,CAAC;aACb;YAED,MAAM,OAAO,GAAG,IAAI,4BAAgB,CAAC;gBACnC,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,GAAG,EAAE,QAAQ;gBACb,IAAI,EAAE,IAAI;aACX,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;KAAA;IAEK,SAAS,CAAC,GAAW;;YACzB,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;YAClC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YAC3C,OAAO,QAAQ,CAAC;QAClB,CAAC;KAAA;IAEK,SAAS,CAAC,GAAW,EAAE,MAAkB;;;;YAC7C,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE;gBAChB,OAAO,IAAI,CAAC;aACb;YAED,MAAM,MAAM,GAAa,EAAE,CAAC;;gBAC5B,KAA0B,WAAA,cAAA,MAAM,CAAA;oBAArB,MAAM,KAAK,mBAAA,CAAA;oBACpB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBACpB;;;;;;;;;YAED,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACzC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;;KACxC;IAEa,YAAY;;;YACxB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE;gBAChB,OAAO,IAAI,CAAC;aACb;YAED,MAAM,OAAO,GAAG,IAAI,8BAAkB,CAAC,EAAE,CAAC,CAAC;YAC3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACnD,MAAM,YAAY,GAAG,MAAA,QAAQ,CAAC,OAAO,0CAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC;YAE3E,IAAI,CAAC,YAAY,EAAE;gBACjB,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;gBAC9C,MAAM,mBAAmB,GAAG,IAAI,+BAAmB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;gBAC7E,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;aAChD;;KACF;IAEK,UAAU,CAAC,OAAe,EAAE,OAAe;;YAC/C,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CACtB,IAAI,6BAAiB,CAAC;gBACpB,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,UAAU,EAAE,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,SAAS,GAAG,OAAO,EAAE;gBACxD,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS,GAAG,OAAO,EAAE;aACnC,CAAC,CACH,CAAC;YAEF,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CACtB,IAAI,+BAAmB,CAAC;gBACtB,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS,GAAG,OAAO,EAAE;aACnC,CAAC,CACH,CAAC;QACJ,CAAC;KAAA;IAED,YAAY;QACV,OAAO,IAAA,oBAAW,EAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,WAAW,CAAC,KAA4B,EAAE,WAAmD;QAC3F,OAAO,OAAO,CAAC,GAAG,CAChB,KAAK,CAAC,GAAG,CAAC,CAAO,IAAI,EAAE,EAAE;YACvB,MAAM,QAAQ,GAAG,GAAG,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,IAAI,CAAC,YAAY,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC;YAChJ,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YAC5C,OAAO;gBACL,IAAI,EAAE,IAAI,CAAC,YAAY;gBACvB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,IAAI,CAAC,QAAQ;gBACnB,IAAI,EAAE,IAAI,CAAC,IAAI;aAChB,CAAC;QACJ,CAAC,CAAA,CAAC,CACH,CAAC;IACJ,CAAC;IAEK,UAAU,CAAC,IAAyB,EAAE,QAAiB;;YAC3D,QAAQ,GAAG,QAAQ;gBACjB,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,GAAG,QAAQ,EAAE;gBAChC,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,WAAW,IAAI,CAAC,YAAY,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC;YAC5F,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YAC5C,OAAO;gBACL,IAAI,EAAE,IAAI,CAAC,YAAY;gBACvB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,IAAI,CAAC,QAAQ;gBACnB,IAAI,EAAE,IAAI,CAAC,IAAI;aAChB,CAAC;QACJ,CAAC;KAAA;CACF,CAAA;AA7IY,cAAc;IAD1B,IAAA,mBAAU,GAAE;IAOE,WAAA,IAAA,eAAM,EAAC,wCAAsB,CAAC,CAAA;GANhC,cAAc,CA6I1B;AA7IY,wCAAc"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sandumo/nestjs-storage-module",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"main": "./dist/index.js",
|
|
5
5
|
"types": "./dist/index.d.ts",
|
|
6
6
|
"files": [
|
|
@@ -20,8 +20,7 @@
|
|
|
20
20
|
},
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-sdk/client-s3": "^3.717.0",
|
|
23
|
-
"@nestjs/common": "^9.0.0"
|
|
24
|
-
"aws-sdk": "^2.1692.0"
|
|
23
|
+
"@nestjs/common": "^9.0.0"
|
|
25
24
|
},
|
|
26
25
|
"description": "This package provides a NestJS module for storage.",
|
|
27
26
|
"keywords": [
|