@headless-lms/adapter-storage-minio 0.2.1 → 0.2.3
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 +6 -2
- package/dist/index.d.ts +7 -0
- package/dist/index.js +34 -0
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
# @headless-lms/adapter-storage-minio
|
|
2
2
|
|
|
3
3
|
MinIO (S3-compatible) implementation of the `ObjectStorage` port from
|
|
4
|
-
`@headless-lms/core/types`. Works against MinIO or any S3-compatible store
|
|
5
|
-
|
|
4
|
+
`@headless-lms/core/types`. Works against MinIO or any S3-compatible store. The bucket
|
|
5
|
+
is private except the `public/` prefix: on startup the adapter sets a bucket policy that
|
|
6
|
+
lets anyone read `public/*`, where the API publishes profile photos and the thumbnails
|
|
7
|
+
and covers of published items with `Cache-Control: public, max-age=31536000, immutable`.
|
|
8
|
+
Private files are reached through short-lived presigned URLs.
|
|
6
9
|
|
|
7
10
|
The adapter reads no environment itself — the installation's `config.ts` parses
|
|
8
11
|
env into a `MinioStorageConfig` and injects the constructed adapter:
|
|
@@ -28,3 +31,4 @@ const container = await createContainer(config, {
|
|
|
28
31
|
| `STORAGE_BUCKET` | yes | `bucket` | Created private if missing. |
|
|
29
32
|
| `STORAGE_UPLOAD_EXPIRY` | no | `uploadExpirySeconds` | Default 300. Stray member uploads older than this are swept. |
|
|
30
33
|
| `STORAGE_DOWNLOAD_EXPIRY` | no | `downloadExpirySeconds` | Download lifetime when the caller names none. Default 300. The API names `DELIVERY_URL_EXPIRY` on every URL it serves. |
|
|
34
|
+
| `STORAGE_PUBLIC_URL` | no | `publicUrl` | Origin serving `public/*`, such as a CDN. Default `http(s)://<endpoint>:<port>/<bucket>`. |
|
package/dist/index.d.ts
CHANGED
|
@@ -8,6 +8,7 @@ interface MinioStorageConfig {
|
|
|
8
8
|
secretKey: string;
|
|
9
9
|
region: string;
|
|
10
10
|
bucket: string;
|
|
11
|
+
publicUrl?: string;
|
|
11
12
|
uploadExpirySeconds: number;
|
|
12
13
|
downloadExpirySeconds: number;
|
|
13
14
|
}
|
|
@@ -16,6 +17,7 @@ declare class MinioStorageAdapter implements ObjectStorage {
|
|
|
16
17
|
private readonly client;
|
|
17
18
|
private readonly bucket;
|
|
18
19
|
private readonly region;
|
|
20
|
+
private readonly publicBase;
|
|
19
21
|
readonly uploadExpirySeconds: number;
|
|
20
22
|
private readonly downloadExpiry;
|
|
21
23
|
private ensured;
|
|
@@ -34,6 +36,11 @@ declare class MinioStorageAdapter implements ObjectStorage {
|
|
|
34
36
|
from: string;
|
|
35
37
|
to: string;
|
|
36
38
|
}): Promise<void>;
|
|
39
|
+
publish(input: {
|
|
40
|
+
from: string;
|
|
41
|
+
to: string;
|
|
42
|
+
}): Promise<void>;
|
|
43
|
+
publicUrl(key: string): string;
|
|
37
44
|
remove(key: string): Promise<void>;
|
|
38
45
|
}
|
|
39
46
|
//#endregion
|
package/dist/index.js
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { Client, CopyDestinationOptions, CopySourceOptions } from "minio";
|
|
2
|
+
import { PUBLIC_CACHE_CONTROL, PUBLIC_PREFIX } from "@headless-lms/core/types";
|
|
2
3
|
//#region src/index.ts
|
|
3
4
|
var MinioStorageAdapter = class {
|
|
4
5
|
logger;
|
|
5
6
|
client;
|
|
6
7
|
bucket;
|
|
7
8
|
region;
|
|
9
|
+
publicBase;
|
|
8
10
|
uploadExpirySeconds;
|
|
9
11
|
downloadExpiry;
|
|
10
12
|
ensured = false;
|
|
@@ -20,6 +22,7 @@ var MinioStorageAdapter = class {
|
|
|
20
22
|
});
|
|
21
23
|
this.bucket = config.bucket;
|
|
22
24
|
this.region = config.region;
|
|
25
|
+
this.publicBase = (config.publicUrl ?? `${config.useSSL ? "https" : "http"}://${config.endPoint}:${config.port}/${config.bucket}`).replace(/\/+$/, "");
|
|
23
26
|
this.uploadExpirySeconds = config.uploadExpirySeconds;
|
|
24
27
|
this.downloadExpiry = config.downloadExpirySeconds;
|
|
25
28
|
}
|
|
@@ -27,6 +30,7 @@ var MinioStorageAdapter = class {
|
|
|
27
30
|
async ensureBucket() {
|
|
28
31
|
if (this.ensured) return;
|
|
29
32
|
if (!await this.client.bucketExists(this.bucket).catch(() => false)) await this.client.makeBucket(this.bucket, this.region);
|
|
33
|
+
await this.client.setBucketPolicy(this.bucket, publicReadPolicy(this.bucket));
|
|
30
34
|
this.ensured = true;
|
|
31
35
|
}
|
|
32
36
|
async presignUpload(input) {
|
|
@@ -84,10 +88,40 @@ var MinioStorageAdapter = class {
|
|
|
84
88
|
Object: input.to
|
|
85
89
|
}));
|
|
86
90
|
}
|
|
91
|
+
async publish(input) {
|
|
92
|
+
await this.ensureBucket();
|
|
93
|
+
const contentType = (await this.client.statObject(this.bucket, input.from)).metaData?.["content-type"];
|
|
94
|
+
await this.client.copyObject(new CopySourceOptions({
|
|
95
|
+
Bucket: this.bucket,
|
|
96
|
+
Object: input.from
|
|
97
|
+
}), new CopyDestinationOptions({
|
|
98
|
+
Bucket: this.bucket,
|
|
99
|
+
Object: input.to,
|
|
100
|
+
MetadataDirective: "REPLACE",
|
|
101
|
+
Headers: {
|
|
102
|
+
"Cache-Control": PUBLIC_CACHE_CONTROL,
|
|
103
|
+
...contentType ? { "Content-Type": contentType } : {}
|
|
104
|
+
}
|
|
105
|
+
}));
|
|
106
|
+
}
|
|
107
|
+
publicUrl(key) {
|
|
108
|
+
return `${this.publicBase}/${key.split("/").map(encodeURIComponent).join("/")}`;
|
|
109
|
+
}
|
|
87
110
|
async remove(key) {
|
|
88
111
|
await this.client.removeObject(this.bucket, key);
|
|
89
112
|
}
|
|
90
113
|
};
|
|
114
|
+
function publicReadPolicy(bucket) {
|
|
115
|
+
return JSON.stringify({
|
|
116
|
+
Version: "2012-10-17",
|
|
117
|
+
Statement: [{
|
|
118
|
+
Effect: "Allow",
|
|
119
|
+
Principal: { AWS: ["*"] },
|
|
120
|
+
Action: ["s3:GetObject"],
|
|
121
|
+
Resource: [`arn:aws:s3:::${bucket}/${PUBLIC_PREFIX}*`]
|
|
122
|
+
}]
|
|
123
|
+
});
|
|
124
|
+
}
|
|
91
125
|
//#endregion
|
|
92
126
|
export { MinioStorageAdapter };
|
|
93
127
|
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["// MinIO (S3-compatible) implementation of the ObjectStorage port. Private\n// buckets
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["// MinIO (S3-compatible) implementation of the ObjectStorage port. Private\n// buckets, except the public/ prefix, which anyone may read.\nimport { Client, CopyDestinationOptions, CopySourceOptions } from \"minio\";\nimport {\n PUBLIC_CACHE_CONTROL,\n PUBLIC_PREFIX,\n type Logger,\n type ObjectStorage,\n type PresignDownloadInput,\n type PresignedUpload,\n type StoredObjectInfo,\n} from \"@headless-lms/core/types\";\n\nexport interface MinioStorageConfig {\n endPoint: string;\n port: number;\n useSSL: boolean;\n accessKey: string;\n secretKey: string;\n region: string;\n bucket: string;\n publicUrl?: string;\n uploadExpirySeconds: number;\n downloadExpirySeconds: number;\n}\n\nexport class MinioStorageAdapter implements ObjectStorage {\n private readonly client: Client;\n private readonly bucket: string;\n private readonly region: string;\n private readonly publicBase: string;\n readonly uploadExpirySeconds: number;\n private readonly downloadExpiry: number;\n private ensured = false;\n\n constructor(\n config: MinioStorageConfig,\n private readonly logger?: Logger,\n ) {\n this.client = new Client({\n endPoint: config.endPoint,\n port: config.port,\n useSSL: config.useSSL,\n accessKey: config.accessKey,\n secretKey: config.secretKey,\n region: config.region,\n });\n this.bucket = config.bucket;\n this.region = config.region;\n this.publicBase = (\n config.publicUrl ??\n `${config.useSSL ? \"https\" : \"http\"}://${config.endPoint}:${config.port}/${config.bucket}`\n ).replace(/\\/+$/, \"\");\n this.uploadExpirySeconds = config.uploadExpirySeconds;\n this.downloadExpiry = config.downloadExpirySeconds;\n }\n\n /** Create the (private) bucket if it does not exist. Call once at startup. */\n async ensureBucket(): Promise<void> {\n if (this.ensured) {\n return;\n }\n const exists = await this.client.bucketExists(this.bucket).catch(() => false);\n if (!exists) {\n await this.client.makeBucket(this.bucket, this.region);\n }\n await this.client.setBucketPolicy(this.bucket, publicReadPolicy(this.bucket));\n this.ensured = true;\n }\n\n async presignUpload(input: {\n key: string;\n contentType?: string;\n expiresInSeconds?: number;\n }): Promise<PresignedUpload> {\n await this.ensureBucket();\n const expiresInSeconds = input.expiresInSeconds ?? this.uploadExpirySeconds;\n const url = await this.client.presignedPutObject(this.bucket, input.key, expiresInSeconds);\n return {\n url,\n method: \"PUT\",\n key: input.key,\n expiresInSeconds,\n headers: input.contentType ? { \"Content-Type\": input.contentType } : {},\n };\n }\n\n async presignDownload(input: PresignDownloadInput): Promise<string> {\n await this.ensureBucket();\n const expiresInSeconds = input.expiresInSeconds ?? this.downloadExpiry;\n const respHeaders: Record<string, string> = {};\n if (input.downloadFilename) {\n respHeaders[\"response-content-disposition\"] =\n `attachment; filename=\"${input.downloadFilename.replace(/\"/g, \"\")}\"`;\n }\n return this.client.presignedGetObject(this.bucket, input.key, expiresInSeconds, respHeaders);\n }\n\n async stat(key: string): Promise<StoredObjectInfo | null> {\n try {\n const s = await this.client.statObject(this.bucket, key);\n const contentType = s.metaData?.[\"content-type\"];\n return {\n key,\n size: s.size,\n ...(contentType ? { contentType } : {}),\n ...(s.lastModified ? { lastModified: s.lastModified.toISOString() } : {}),\n };\n } catch {\n return null;\n }\n }\n\n async list(prefix: string): Promise<StoredObjectInfo[]> {\n await this.ensureBucket();\n const objects: StoredObjectInfo[] = [];\n for await (const item of this.client.listObjectsV2(this.bucket, prefix, true)) {\n if (!item.name) {\n continue;\n }\n objects.push({\n key: item.name,\n size: item.size,\n ...(item.lastModified ? { lastModified: item.lastModified.toISOString() } : {}),\n });\n }\n return objects;\n }\n\n async copy(input: { from: string; to: string }): Promise<void> {\n await this.ensureBucket();\n await this.client.copyObject(\n new CopySourceOptions({ Bucket: this.bucket, Object: input.from }),\n new CopyDestinationOptions({ Bucket: this.bucket, Object: input.to }),\n );\n }\n\n async publish(input: { from: string; to: string }): Promise<void> {\n await this.ensureBucket();\n const source = await this.client.statObject(this.bucket, input.from);\n const contentType = source.metaData?.[\"content-type\"];\n await this.client.copyObject(\n new CopySourceOptions({ Bucket: this.bucket, Object: input.from }),\n new CopyDestinationOptions({\n Bucket: this.bucket,\n Object: input.to,\n MetadataDirective: \"REPLACE\",\n Headers: {\n \"Cache-Control\": PUBLIC_CACHE_CONTROL,\n ...(contentType ? { \"Content-Type\": contentType } : {}),\n },\n }),\n );\n }\n\n publicUrl(key: string): string {\n return `${this.publicBase}/${key.split(\"/\").map(encodeURIComponent).join(\"/\")}`;\n }\n\n async remove(key: string): Promise<void> {\n await this.client.removeObject(this.bucket, key);\n }\n}\n\nfunction publicReadPolicy(bucket: string): string {\n return JSON.stringify({\n Version: \"2012-10-17\",\n Statement: [\n {\n Effect: \"Allow\",\n Principal: { AWS: [\"*\"] },\n Action: [\"s3:GetObject\"],\n Resource: [`arn:aws:s3:::${bucket}/${PUBLIC_PREFIX}*`],\n },\n ],\n });\n}\n"],"mappings":";;;AA0BA,IAAa,sBAAb,MAA0D;CAWrC;CAVnB;CACA;CACA;CACA;CACA;CACA;CACA,UAAkB;CAElB,YACE,QACA,QACA;EADiB,KAAA,SAAA;EAEjB,KAAK,SAAS,IAAI,OAAO;GACvB,UAAU,OAAO;GACjB,MAAM,OAAO;GACb,QAAQ,OAAO;GACf,WAAW,OAAO;GAClB,WAAW,OAAO;GAClB,QAAQ,OAAO;EACjB,CAAC;EACD,KAAK,SAAS,OAAO;EACrB,KAAK,SAAS,OAAO;EACrB,KAAK,cACH,OAAO,aACP,GAAG,OAAO,SAAS,UAAU,OAAO,KAAK,OAAO,SAAS,GAAG,OAAO,KAAK,GAAG,OAAO,SAAA,CAClF,QAAQ,QAAQ,EAAE;EACpB,KAAK,sBAAsB,OAAO;EAClC,KAAK,iBAAiB,OAAO;CAC/B;;CAGA,MAAM,eAA8B;EAClC,IAAI,KAAK,SACP;EAGF,IAAI,CAAC,MADgB,KAAK,OAAO,aAAa,KAAK,MAAM,CAAC,CAAC,YAAY,KAAK,GAE1E,MAAM,KAAK,OAAO,WAAW,KAAK,QAAQ,KAAK,MAAM;EAEvD,MAAM,KAAK,OAAO,gBAAgB,KAAK,QAAQ,iBAAiB,KAAK,MAAM,CAAC;EAC5E,KAAK,UAAU;CACjB;CAEA,MAAM,cAAc,OAIS;EAC3B,MAAM,KAAK,aAAa;EACxB,MAAM,mBAAmB,MAAM,oBAAoB,KAAK;EAExD,OAAO;GACL,KAAA,MAFgB,KAAK,OAAO,mBAAmB,KAAK,QAAQ,MAAM,KAAK,gBAAgB;GAGvF,QAAQ;GACR,KAAK,MAAM;GACX;GACA,SAAS,MAAM,cAAc,EAAE,gBAAgB,MAAM,YAAY,IAAI,CAAC;EACxE;CACF;CAEA,MAAM,gBAAgB,OAA8C;EAClE,MAAM,KAAK,aAAa;EACxB,MAAM,mBAAmB,MAAM,oBAAoB,KAAK;EACxD,MAAM,cAAsC,CAAC;EAC7C,IAAI,MAAM,kBACR,YAAY,kCACV,yBAAyB,MAAM,iBAAiB,QAAQ,MAAM,EAAE,EAAE;EAEtE,OAAO,KAAK,OAAO,mBAAmB,KAAK,QAAQ,MAAM,KAAK,kBAAkB,WAAW;CAC7F;CAEA,MAAM,KAAK,KAA+C;EACxD,IAAI;GACF,MAAM,IAAI,MAAM,KAAK,OAAO,WAAW,KAAK,QAAQ,GAAG;GACvD,MAAM,cAAc,EAAE,WAAW;GACjC,OAAO;IACL;IACA,MAAM,EAAE;IACR,GAAI,cAAc,EAAE,YAAY,IAAI,CAAC;IACrC,GAAI,EAAE,eAAe,EAAE,cAAc,EAAE,aAAa,YAAY,EAAE,IAAI,CAAC;GACzE;EACF,QAAQ;GACN,OAAO;EACT;CACF;CAEA,MAAM,KAAK,QAA6C;EACtD,MAAM,KAAK,aAAa;EACxB,MAAM,UAA8B,CAAC;EACrC,WAAW,MAAM,QAAQ,KAAK,OAAO,cAAc,KAAK,QAAQ,QAAQ,IAAI,GAAG;GAC7E,IAAI,CAAC,KAAK,MACR;GAEF,QAAQ,KAAK;IACX,KAAK,KAAK;IACV,MAAM,KAAK;IACX,GAAI,KAAK,eAAe,EAAE,cAAc,KAAK,aAAa,YAAY,EAAE,IAAI,CAAC;GAC/E,CAAC;EACH;EACA,OAAO;CACT;CAEA,MAAM,KAAK,OAAoD;EAC7D,MAAM,KAAK,aAAa;EACxB,MAAM,KAAK,OAAO,WAChB,IAAI,kBAAkB;GAAE,QAAQ,KAAK;GAAQ,QAAQ,MAAM;EAAK,CAAC,GACjE,IAAI,uBAAuB;GAAE,QAAQ,KAAK;GAAQ,QAAQ,MAAM;EAAG,CAAC,CACtE;CACF;CAEA,MAAM,QAAQ,OAAoD;EAChE,MAAM,KAAK,aAAa;EAExB,MAAM,eAAc,MADC,KAAK,OAAO,WAAW,KAAK,QAAQ,MAAM,IAAI,EAAA,CACxC,WAAW;EACtC,MAAM,KAAK,OAAO,WAChB,IAAI,kBAAkB;GAAE,QAAQ,KAAK;GAAQ,QAAQ,MAAM;EAAK,CAAC,GACjE,IAAI,uBAAuB;GACzB,QAAQ,KAAK;GACb,QAAQ,MAAM;GACd,mBAAmB;GACnB,SAAS;IACP,iBAAiB;IACjB,GAAI,cAAc,EAAE,gBAAgB,YAAY,IAAI,CAAC;GACvD;EACF,CAAC,CACH;CACF;CAEA,UAAU,KAAqB;EAC7B,OAAO,GAAG,KAAK,WAAW,GAAG,IAAI,MAAM,GAAG,CAAC,CAAC,IAAI,kBAAkB,CAAC,CAAC,KAAK,GAAG;CAC9E;CAEA,MAAM,OAAO,KAA4B;EACvC,MAAM,KAAK,OAAO,aAAa,KAAK,QAAQ,GAAG;CACjD;AACF;AAEA,SAAS,iBAAiB,QAAwB;CAChD,OAAO,KAAK,UAAU;EACpB,SAAS;EACT,WAAW,CACT;GACE,QAAQ;GACR,WAAW,EAAE,KAAK,CAAC,GAAG,EAAE;GACxB,QAAQ,CAAC,cAAc;GACvB,UAAU,CAAC,gBAAgB,OAAO,GAAG,cAAc,EAAE;EACvD,CACF;CACF,CAAC;AACH"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@headless-lms/adapter-storage-minio",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.3",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
14
|
"minio": "^8.0.7",
|
|
15
|
-
"@headless-lms/core": "0.
|
|
15
|
+
"@headless-lms/core": "0.5.0"
|
|
16
16
|
},
|
|
17
17
|
"devDependencies": {
|
|
18
18
|
"@types/node": "^22.10.2",
|