@vendure/asset-server-plugin 1.4.7 → 1.5.0
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.
|
@@ -75,6 +75,32 @@ export interface S3Config {
|
|
|
75
75
|
* }),
|
|
76
76
|
* ```
|
|
77
77
|
*
|
|
78
|
+
* ## Usage with MinIO
|
|
79
|
+
*
|
|
80
|
+
* Reference: [How to use AWS SDK for Javascript with MinIO Server](https://docs.min.io/docs/how-to-use-aws-sdk-for-javascript-with-minio-server.html)
|
|
81
|
+
*
|
|
82
|
+
* @example
|
|
83
|
+
* ```TypeScript
|
|
84
|
+
* plugins: [
|
|
85
|
+
* AssetServerPlugin.init({
|
|
86
|
+
* route: 'assets',
|
|
87
|
+
* assetUploadDir: path.join(__dirname, 'assets'),
|
|
88
|
+
* port: 5002,
|
|
89
|
+
* namingStrategy: new DefaultAssetNamingStrategy(),
|
|
90
|
+
* storageStrategyFactory: configureS3AssetStorage({
|
|
91
|
+
* bucket: 'my-minio-bucket',
|
|
92
|
+
* credentials: {
|
|
93
|
+
* accessKeyId: process.env.MINIO_ACCESS_KEY_ID,
|
|
94
|
+
* secretAccessKey: process.env.MINIO_SECRET_ACCESS_KEY,
|
|
95
|
+
* },
|
|
96
|
+
* nativeS3Configuration: {
|
|
97
|
+
* endpoint: process.env.MINIO_ENDPOINT ?? 'http://localhost:9000',
|
|
98
|
+
* s3ForcePathStyle: true,
|
|
99
|
+
* signatureVersion: 'v4',
|
|
100
|
+
* },
|
|
101
|
+
* }),
|
|
102
|
+
* }),
|
|
103
|
+
* ```
|
|
78
104
|
* @docsCategory asset-server-plugin
|
|
79
105
|
* @docsPage S3AssetStorageStrategy
|
|
80
106
|
*/
|
|
@@ -93,10 +119,9 @@ export declare function configureS3AssetStorage(s3Config: S3Config): (options: A
|
|
|
93
119
|
*
|
|
94
120
|
* **Note:** Rather than instantiating this manually, use the {@link configureS3AssetStorage} function.
|
|
95
121
|
*
|
|
96
|
-
* ## Use with S3-compatible services
|
|
97
|
-
* This strategy will also work with any S3-compatible object storage solutions, such as [MinIO](https://min.io/)
|
|
98
|
-
*
|
|
99
|
-
* * [How to use AWS SDK for Javascript with MinIO Server](https://docs.min.io/docs/how-to-use-aws-sdk-for-javascript-with-minio-server.html)
|
|
122
|
+
* ## Use with S3-compatible services (MinIO)
|
|
123
|
+
* This strategy will also work with any S3-compatible object storage solutions, such as [MinIO](https://min.io/).
|
|
124
|
+
* See the {@link configureS3AssetStorage} for an example with MinIO.
|
|
100
125
|
*
|
|
101
126
|
* @docsCategory asset-server-plugin
|
|
102
127
|
* @docsPage S3AssetStorageStrategy
|
|
@@ -54,6 +54,32 @@ const constants_1 = require("./constants");
|
|
|
54
54
|
* }),
|
|
55
55
|
* ```
|
|
56
56
|
*
|
|
57
|
+
* ## Usage with MinIO
|
|
58
|
+
*
|
|
59
|
+
* Reference: [How to use AWS SDK for Javascript with MinIO Server](https://docs.min.io/docs/how-to-use-aws-sdk-for-javascript-with-minio-server.html)
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```TypeScript
|
|
63
|
+
* plugins: [
|
|
64
|
+
* AssetServerPlugin.init({
|
|
65
|
+
* route: 'assets',
|
|
66
|
+
* assetUploadDir: path.join(__dirname, 'assets'),
|
|
67
|
+
* port: 5002,
|
|
68
|
+
* namingStrategy: new DefaultAssetNamingStrategy(),
|
|
69
|
+
* storageStrategyFactory: configureS3AssetStorage({
|
|
70
|
+
* bucket: 'my-minio-bucket',
|
|
71
|
+
* credentials: {
|
|
72
|
+
* accessKeyId: process.env.MINIO_ACCESS_KEY_ID,
|
|
73
|
+
* secretAccessKey: process.env.MINIO_SECRET_ACCESS_KEY,
|
|
74
|
+
* },
|
|
75
|
+
* nativeS3Configuration: {
|
|
76
|
+
* endpoint: process.env.MINIO_ENDPOINT ?? 'http://localhost:9000',
|
|
77
|
+
* s3ForcePathStyle: true,
|
|
78
|
+
* signatureVersion: 'v4',
|
|
79
|
+
* },
|
|
80
|
+
* }),
|
|
81
|
+
* }),
|
|
82
|
+
* ```
|
|
57
83
|
* @docsCategory asset-server-plugin
|
|
58
84
|
* @docsPage S3AssetStorageStrategy
|
|
59
85
|
*/
|
|
@@ -86,10 +112,9 @@ exports.configureS3AssetStorage = configureS3AssetStorage;
|
|
|
86
112
|
*
|
|
87
113
|
* **Note:** Rather than instantiating this manually, use the {@link configureS3AssetStorage} function.
|
|
88
114
|
*
|
|
89
|
-
* ## Use with S3-compatible services
|
|
90
|
-
* This strategy will also work with any S3-compatible object storage solutions, such as [MinIO](https://min.io/)
|
|
91
|
-
*
|
|
92
|
-
* * [How to use AWS SDK for Javascript with MinIO Server](https://docs.min.io/docs/how-to-use-aws-sdk-for-javascript-with-minio-server.html)
|
|
115
|
+
* ## Use with S3-compatible services (MinIO)
|
|
116
|
+
* This strategy will also work with any S3-compatible object storage solutions, such as [MinIO](https://min.io/).
|
|
117
|
+
* See the {@link configureS3AssetStorage} for an example with MinIO.
|
|
93
118
|
*
|
|
94
119
|
* @docsCategory asset-server-plugin
|
|
95
120
|
* @docsPage S3AssetStorageStrategy
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"s3-asset-storage-strategy.js","sourceRoot":"","sources":["../../src/s3-asset-storage-strategy.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,wCAA6D;AAE7D,2CAA6B;AAC7B,mCAA0C;AAE1C,qCAA+C;AAC/C,2CAAwC;AAiDxC
|
|
1
|
+
{"version":3,"file":"s3-asset-storage-strategy.js","sourceRoot":"","sources":["../../src/s3-asset-storage-strategy.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,wCAA6D;AAE7D,2CAA6B;AAC7B,mCAA0C;AAE1C,qCAA+C;AAC/C,2CAAwC;AAiDxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,SAAgB,uBAAuB,CAAC,QAAkB;IACtD,OAAO,CAAC,OAA2B,EAAE,EAAE;QACnC,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;QAC1C,MAAM,QAAQ,GAAG,4BAAmB,CAAC,OAAO,CAAC,CAAC;QAC9C,MAAM,eAAe,GAAG,CAAC,OAAgB,EAAE,UAAkB,EAAU,EAAE;YACrE,IAAI,CAAC,UAAU,EAAE;gBACb,OAAO,EAAE,CAAC;aACb;YACD,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YAC7C,OAAO,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,UAAU,EAAE,CAAC;QACjF,CAAC,CAAC;QACF,OAAO,IAAI,sBAAsB,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;IACjE,CAAC,CAAC;AACN,CAAC;AAbD,0DAaC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,sBAAsB;IAG/B,YACY,QAAkB,EACV,aAA+D;QADvE,aAAQ,GAAR,QAAQ,CAAU;QACV,kBAAa,GAAb,aAAa,CAAkD;IAChF,CAAC;IAEJ,KAAK,CAAC,IAAI;QACN,IAAI;YACA,IAAI,CAAC,GAAG,GAAG,wDAAa,SAAS,GAAC,CAAC;SACtC;QAAC,OAAO,CAAC,EAAE;YACR,aAAM,CAAC,KAAK,CACR,iEAAiE,EACjE,qBAAS,EACT,CAAC,CAAC,KAAK,CACV,CAAC;SACL;QAED,MAAM,MAAM,mBACR,WAAW,EAAE,IAAI,CAAC,gBAAgB,EAAE,IACjC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CACzC,CAAC;QACF,IAAI,CAAC,EAAE,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;QAClC,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAID,KAAK,CAAC,mBAAmB,CAAC,QAAgB,EAAE,IAAY;QACpD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,EAAE;aACvB,MAAM,CACH;YACI,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;YAC5B,GAAG,EAAE,QAAQ;YACb,IAAI,EAAE,IAAI;SACb,EACD,IAAI,CAAC,QAAQ,CAAC,2BAA2B,CAC5C;aACA,OAAO,EAAE,CAAC;QACf,OAAO,MAAM,CAAC,GAAG,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,QAAgB,EAAE,IAAY;QACpD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,EAAE;aACvB,MAAM,CACH;YACI,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;YAC5B,GAAG,EAAE,QAAQ;YACb,IAAI,EAAE,IAAI;SACb,EACD,IAAI,CAAC,QAAQ,CAAC,2BAA2B,CAC5C;aACA,OAAO,EAAE,CAAC;QACf,OAAO,MAAM,CAAC,GAAG,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,UAAkB;QACrC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACnF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,IAAI,EAAE;YACP,aAAM,CAAC,KAAK,CAAC,0BAA0B,UAAU,EAAE,EAAE,qBAAS,CAAC,CAAC;YAChE,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SAC1B;QACD,IAAI,IAAI,YAAY,MAAM,EAAE;YACxB,OAAO,IAAI,CAAC;SACf;QACD,IAAI,IAAI,YAAY,UAAU,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YACxD,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC5B;QACD,IAAI,IAAI,YAAY,iBAAQ,EAAE;YAC1B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACnC,MAAM,GAAG,GAAU,EAAE,CAAC;gBACtB,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;gBACxC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;gBACrC,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;oBAChB,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACtC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;gBACvC,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;SACN;QACD,OAAO,MAAM,CAAC,IAAI,CAAC,IAAW,CAAC,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,UAAkB;QACrC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACnF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,CAAC,IAAI,YAAY,eAAM,CAAC,EAAE;YAC3B,MAAM,QAAQ,GAAG,IAAI,iBAAQ,EAAE,CAAC;YAChC,QAAQ,CAAC,KAAK,GAAG,GAAG,EAAE;gBAClB,UAAU;YACd,CAAC,CAAC;YACF,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACpB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACpB,OAAO,QAAQ,CAAC;SACnB;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,UAAkB;QAC/B,MAAM,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC3E,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,QAAgB;QAC7B,IAAI;YACA,MAAM,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YACnE,OAAO,IAAI,CAAC;SACf;QAAC,OAAO,CAAC,EAAE;YACR,OAAO,KAAK,CAAC;SAChB;IACL,CAAC;IAEO,eAAe,CAAC,UAAkB;QACtC,OAAO;YACH,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;YAC5B,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;SAChD,CAAC;IACN,CAAC;IAEO,gBAAgB;QACpB,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;QACtC,IAAI,WAAW,IAAI,IAAI,EAAE;YACrB,OAAO,IAAI,CAAC;SACf;aAAM,IAAI,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,EAAE;YAC/C,OAAO,IAAI,IAAI,CAAC,GAAG,CAAC,wBAAwB,CAAC,WAAW,CAAC,CAAC;SAC7D;QACD,OAAO,IAAI,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,MAAc;QACrC,IAAI,YAAY,GAAG,KAAK,CAAC;QACzB,IAAI;YACA,MAAM,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;YACrE,YAAY,GAAG,IAAI,CAAC;YACpB,aAAM,CAAC,OAAO,CAAC,oBAAoB,MAAM,GAAG,EAAE,qBAAS,CAAC,CAAC;SAC5D;QAAC,OAAO,CAAC,EAAE;YACR,aAAM,CAAC,OAAO,CAAC,0BAA0B,MAAM,4BAA4B,CAAC,CAAC;SAChF;QACD,IAAI,CAAC,YAAY,EAAE;YACf,IAAI;gBACA,MAAM,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;gBACzE,aAAM,CAAC,OAAO,CAAC,sBAAsB,MAAM,GAAG,EAAE,qBAAS,CAAC,CAAC;aAC9D;YAAC,OAAO,CAAC,EAAE;gBACR,aAAM,CAAC,KAAK,CAAC,4CAA4C,MAAM,GAAG,EAAE,qBAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;aAC3F;SACJ;IACL,CAAC;IAEO,oBAAoB,CACxB,WAAiD;QAEjD,OAAO,WAAW,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IACjD,CAAC;CACJ;AAzJD,wDAyJC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vendure/asset-server-plugin",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.5.0",
|
|
4
4
|
"main": "lib/index.js",
|
|
5
5
|
"types": "lib/index.d.ts",
|
|
6
6
|
"files": [
|
|
@@ -24,8 +24,8 @@
|
|
|
24
24
|
"@types/fs-extra": "^9.0.8",
|
|
25
25
|
"@types/node-fetch": "^2.5.8",
|
|
26
26
|
"@types/sharp": "^0.27.1",
|
|
27
|
-
"@vendure/common": "^1.
|
|
28
|
-
"@vendure/core": "^1.
|
|
27
|
+
"@vendure/common": "^1.5.0",
|
|
28
|
+
"@vendure/core": "^1.5.0",
|
|
29
29
|
"aws-sdk": "^2.856.0",
|
|
30
30
|
"express": "^4.17.1",
|
|
31
31
|
"node-fetch": "^2.6.1",
|
|
@@ -37,5 +37,5 @@
|
|
|
37
37
|
"fs-extra": "^10.0.0",
|
|
38
38
|
"sharp": "~0.29.0"
|
|
39
39
|
},
|
|
40
|
-
"gitHead": "
|
|
40
|
+
"gitHead": "50883deb6d02d4b5157abe6fb0c6a8e013ea56a2"
|
|
41
41
|
}
|