@settlemint/sdk-minio 2.1.2 → 2.1.3-prf97b3d3e
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 +3 -5
- package/dist/minio.cjs +4 -3
- package/dist/minio.cjs.map +1 -1
- package/dist/minio.d.cts +0 -5
- package/dist/minio.d.ts +0 -5
- package/dist/minio.mjs +5 -4
- package/dist/minio.mjs.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -47,7 +47,7 @@ For detailed information about using MinIO with the SettleMint platform, check o
|
|
|
47
47
|
|
|
48
48
|
> **createServerMinioClient**(`options`): `object`
|
|
49
49
|
|
|
50
|
-
Defined in: [sdk/minio/src/minio.ts:
|
|
50
|
+
Defined in: [sdk/minio/src/minio.ts:23](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/minio/src/minio.ts#L23)
|
|
51
51
|
|
|
52
52
|
Creates a MinIO client for server-side use with authentication.
|
|
53
53
|
|
|
@@ -55,9 +55,8 @@ Creates a MinIO client for server-side use with authentication.
|
|
|
55
55
|
|
|
56
56
|
| Parameter | Type | Description |
|
|
57
57
|
| ------ | ------ | ------ |
|
|
58
|
-
| `options` | \{ `accessKey`: `string`; `
|
|
58
|
+
| `options` | \{ `accessKey`: `string`; `instance`: `string`; `secretKey`: `string`; \} | The server client options for configuring the MinIO client |
|
|
59
59
|
| `options.accessKey` | `string` | The MinIO access key used to authenticate with the MinIO server |
|
|
60
|
-
| `options.accessToken` | `string` | The access token used to authenticate with the SettleMint platform |
|
|
61
60
|
| `options.instance` | `string` | The URL of the MinIO instance to connect to |
|
|
62
61
|
| `options.secretKey` | `string` | The MinIO secret key used to authenticate with the MinIO server |
|
|
63
62
|
|
|
@@ -69,7 +68,7 @@ An object containing the initialized MinIO client
|
|
|
69
68
|
|
|
70
69
|
| Name | Type | Defined in |
|
|
71
70
|
| ------ | ------ | ------ |
|
|
72
|
-
| `client` | `Client` | [sdk/minio/src/minio.ts:
|
|
71
|
+
| `client` | `Client` | [sdk/minio/src/minio.ts:23](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/minio/src/minio.ts#L23) |
|
|
73
72
|
|
|
74
73
|
##### Throws
|
|
75
74
|
|
|
@@ -82,7 +81,6 @@ import { createServerMinioClient } from "@settlemint/sdk-minio";
|
|
|
82
81
|
|
|
83
82
|
const { client } = createServerMinioClient({
|
|
84
83
|
instance: process.env.SETTLEMINT_MINIO_ENDPOINT!,
|
|
85
|
-
accessToken: process.env.SETTLEMINT_ACCESS_TOKEN!,
|
|
86
84
|
accessKey: process.env.SETTLEMINT_MINIO_ACCESS_KEY!,
|
|
87
85
|
secretKey: process.env.SETTLEMINT_MINIO_SECRET_KEY!
|
|
88
86
|
});
|
package/dist/minio.cjs
CHANGED
|
@@ -35,8 +35,6 @@ var ClientOptionsSchema = import_zod.z.object({
|
|
|
35
35
|
instance: import_validation.UrlSchema
|
|
36
36
|
});
|
|
37
37
|
var ServerClientOptionsSchema = ClientOptionsSchema.extend({
|
|
38
|
-
/** The access token used to authenticate with the SettleMint platform */
|
|
39
|
-
accessToken: import_validation.ApplicationAccessTokenSchema,
|
|
40
38
|
/** The MinIO access key used to authenticate with the MinIO server */
|
|
41
39
|
accessKey: import_zod.z.string(),
|
|
42
40
|
/** The MinIO secret key used to authenticate with the MinIO server */
|
|
@@ -47,11 +45,14 @@ var ServerClientOptionsSchema = ClientOptionsSchema.extend({
|
|
|
47
45
|
function createServerMinioClient(options) {
|
|
48
46
|
(0, import_runtime.ensureServer)();
|
|
49
47
|
const validatedOptions = (0, import_validation2.validate)(ServerClientOptionsSchema, options);
|
|
48
|
+
const url = new URL(validatedOptions.instance);
|
|
50
49
|
return {
|
|
51
50
|
client: new import_minio.Client({
|
|
52
|
-
endPoint:
|
|
51
|
+
endPoint: url.hostname,
|
|
53
52
|
accessKey: validatedOptions.accessKey,
|
|
54
53
|
secretKey: validatedOptions.secretKey,
|
|
54
|
+
useSSL: url.protocol !== "http:",
|
|
55
|
+
port: url.port ? Number(url.port) : void 0,
|
|
55
56
|
region: "eu-central-1"
|
|
56
57
|
})
|
|
57
58
|
};
|
package/dist/minio.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/minio.ts","../src/helpers/client-options.schema.ts"],"sourcesContent":["import { ensureServer } from \"@settlemint/sdk-utils/runtime\";\nimport { validate } from \"@settlemint/sdk-utils/validation\";\nimport { Client } from \"minio\";\nimport { type ServerClientOptions, ServerClientOptionsSchema } from \"./helpers/client-options.schema.js\";\n\n/**\n * Creates a MinIO client for server-side use with authentication.\n *\n * @param options - The server client options for configuring the MinIO client\n * @returns An object containing the initialized MinIO client\n * @throws Will throw an error if not called on the server or if the options fail validation\n *\n * @example\n * import { createServerMinioClient } from \"@settlemint/sdk-minio\";\n *\n * const { client } = createServerMinioClient({\n * instance: process.env.SETTLEMINT_MINIO_ENDPOINT!,\n *
|
|
1
|
+
{"version":3,"sources":["../src/minio.ts","../src/helpers/client-options.schema.ts"],"sourcesContent":["import { ensureServer } from \"@settlemint/sdk-utils/runtime\";\nimport { validate } from \"@settlemint/sdk-utils/validation\";\nimport { Client } from \"minio\";\nimport { type ServerClientOptions, ServerClientOptionsSchema } from \"./helpers/client-options.schema.js\";\n\n/**\n * Creates a MinIO client for server-side use with authentication.\n *\n * @param options - The server client options for configuring the MinIO client\n * @returns An object containing the initialized MinIO client\n * @throws Will throw an error if not called on the server or if the options fail validation\n *\n * @example\n * import { createServerMinioClient } from \"@settlemint/sdk-minio\";\n *\n * const { client } = createServerMinioClient({\n * instance: process.env.SETTLEMINT_MINIO_ENDPOINT!,\n * accessKey: process.env.SETTLEMINT_MINIO_ACCESS_KEY!,\n * secretKey: process.env.SETTLEMINT_MINIO_SECRET_KEY!\n * });\n * client.listBuckets();\n */\nexport function createServerMinioClient(options: ServerClientOptions): { client: Client } {\n ensureServer();\n const validatedOptions = validate(ServerClientOptionsSchema, options);\n\n const url = new URL(validatedOptions.instance);\n return {\n client: new Client({\n endPoint: url.hostname,\n accessKey: validatedOptions.accessKey,\n secretKey: validatedOptions.secretKey,\n useSSL: url.protocol !== \"http:\",\n port: url.port ? Number(url.port) : undefined,\n region: \"eu-central-1\",\n }),\n };\n}\n","import { UrlSchema } from \"@settlemint/sdk-utils/validation\";\nimport { z } from \"zod\";\n\n/**\n * Schema for validating client options for the Portal client.\n */\nexport const ClientOptionsSchema = z.object({\n /** The URL of the MinIO instance to connect to */\n instance: UrlSchema,\n});\n\n/**\n * Type definition for client options derived from the ClientOptionsSchema.\n */\nexport type ClientOptions = z.infer<typeof ClientOptionsSchema>;\n\n/**\n * Schema for validating server client options for the Portal client.\n * Extends the ClientOptionsSchema with additional server-specific fields.\n */\nexport const ServerClientOptionsSchema = ClientOptionsSchema.extend({\n /** The MinIO access key used to authenticate with the MinIO server */\n accessKey: z.string(),\n /** The MinIO secret key used to authenticate with the MinIO server */\n secretKey: z.string(),\n});\n\n/**\n * Type definition for server client options derived from the ServerClientOptionsSchema.\n */\nexport type ServerClientOptions = z.infer<typeof ServerClientOptionsSchema>;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,qBAA6B;AAC7B,IAAAA,qBAAyB;AACzB,mBAAuB;;;ACFvB,wBAA0B;AAC1B,iBAAkB;AAKX,IAAM,sBAAsB,aAAE,OAAO;AAAA;AAAA,EAE1C,UAAU;AACZ,CAAC;AAWM,IAAM,4BAA4B,oBAAoB,OAAO;AAAA;AAAA,EAElE,WAAW,aAAE,OAAO;AAAA;AAAA,EAEpB,WAAW,aAAE,OAAO;AACtB,CAAC;;;ADHM,SAAS,wBAAwB,SAAkD;AACxF,mCAAa;AACb,QAAM,uBAAmB,6BAAS,2BAA2B,OAAO;AAEpE,QAAM,MAAM,IAAI,IAAI,iBAAiB,QAAQ;AAC7C,SAAO;AAAA,IACL,QAAQ,IAAI,oBAAO;AAAA,MACjB,UAAU,IAAI;AAAA,MACd,WAAW,iBAAiB;AAAA,MAC5B,WAAW,iBAAiB;AAAA,MAC5B,QAAQ,IAAI,aAAa;AAAA,MACzB,MAAM,IAAI,OAAO,OAAO,IAAI,IAAI,IAAI;AAAA,MACpC,QAAQ;AAAA,IACV,CAAC;AAAA,EACH;AACF;","names":["import_validation"]}
|
package/dist/minio.d.cts
CHANGED
|
@@ -9,20 +9,16 @@ declare const ServerClientOptionsSchema: z.ZodObject<z.objectUtil.extendShape<{
|
|
|
9
9
|
/** The URL of the MinIO instance to connect to */
|
|
10
10
|
instance: z.ZodString;
|
|
11
11
|
}, {
|
|
12
|
-
/** The access token used to authenticate with the SettleMint platform */
|
|
13
|
-
accessToken: z.ZodString;
|
|
14
12
|
/** The MinIO access key used to authenticate with the MinIO server */
|
|
15
13
|
accessKey: z.ZodString;
|
|
16
14
|
/** The MinIO secret key used to authenticate with the MinIO server */
|
|
17
15
|
secretKey: z.ZodString;
|
|
18
16
|
}>, "strip", z.ZodTypeAny, {
|
|
19
17
|
instance: string;
|
|
20
|
-
accessToken: string;
|
|
21
18
|
accessKey: string;
|
|
22
19
|
secretKey: string;
|
|
23
20
|
}, {
|
|
24
21
|
instance: string;
|
|
25
|
-
accessToken: string;
|
|
26
22
|
accessKey: string;
|
|
27
23
|
secretKey: string;
|
|
28
24
|
}>;
|
|
@@ -43,7 +39,6 @@ type ServerClientOptions = z.infer<typeof ServerClientOptionsSchema>;
|
|
|
43
39
|
*
|
|
44
40
|
* const { client } = createServerMinioClient({
|
|
45
41
|
* instance: process.env.SETTLEMINT_MINIO_ENDPOINT!,
|
|
46
|
-
* accessToken: process.env.SETTLEMINT_ACCESS_TOKEN!,
|
|
47
42
|
* accessKey: process.env.SETTLEMINT_MINIO_ACCESS_KEY!,
|
|
48
43
|
* secretKey: process.env.SETTLEMINT_MINIO_SECRET_KEY!
|
|
49
44
|
* });
|
package/dist/minio.d.ts
CHANGED
|
@@ -9,20 +9,16 @@ declare const ServerClientOptionsSchema: z.ZodObject<z.objectUtil.extendShape<{
|
|
|
9
9
|
/** The URL of the MinIO instance to connect to */
|
|
10
10
|
instance: z.ZodString;
|
|
11
11
|
}, {
|
|
12
|
-
/** The access token used to authenticate with the SettleMint platform */
|
|
13
|
-
accessToken: z.ZodString;
|
|
14
12
|
/** The MinIO access key used to authenticate with the MinIO server */
|
|
15
13
|
accessKey: z.ZodString;
|
|
16
14
|
/** The MinIO secret key used to authenticate with the MinIO server */
|
|
17
15
|
secretKey: z.ZodString;
|
|
18
16
|
}>, "strip", z.ZodTypeAny, {
|
|
19
17
|
instance: string;
|
|
20
|
-
accessToken: string;
|
|
21
18
|
accessKey: string;
|
|
22
19
|
secretKey: string;
|
|
23
20
|
}, {
|
|
24
21
|
instance: string;
|
|
25
|
-
accessToken: string;
|
|
26
22
|
accessKey: string;
|
|
27
23
|
secretKey: string;
|
|
28
24
|
}>;
|
|
@@ -43,7 +39,6 @@ type ServerClientOptions = z.infer<typeof ServerClientOptionsSchema>;
|
|
|
43
39
|
*
|
|
44
40
|
* const { client } = createServerMinioClient({
|
|
45
41
|
* instance: process.env.SETTLEMINT_MINIO_ENDPOINT!,
|
|
46
|
-
* accessToken: process.env.SETTLEMINT_ACCESS_TOKEN!,
|
|
47
42
|
* accessKey: process.env.SETTLEMINT_MINIO_ACCESS_KEY!,
|
|
48
43
|
* secretKey: process.env.SETTLEMINT_MINIO_SECRET_KEY!
|
|
49
44
|
* });
|
package/dist/minio.mjs
CHANGED
|
@@ -4,15 +4,13 @@ import { validate } from "@settlemint/sdk-utils/validation";
|
|
|
4
4
|
import { Client } from "minio";
|
|
5
5
|
|
|
6
6
|
// src/helpers/client-options.schema.ts
|
|
7
|
-
import {
|
|
7
|
+
import { UrlSchema } from "@settlemint/sdk-utils/validation";
|
|
8
8
|
import { z } from "zod";
|
|
9
9
|
var ClientOptionsSchema = z.object({
|
|
10
10
|
/** The URL of the MinIO instance to connect to */
|
|
11
11
|
instance: UrlSchema
|
|
12
12
|
});
|
|
13
13
|
var ServerClientOptionsSchema = ClientOptionsSchema.extend({
|
|
14
|
-
/** The access token used to authenticate with the SettleMint platform */
|
|
15
|
-
accessToken: ApplicationAccessTokenSchema,
|
|
16
14
|
/** The MinIO access key used to authenticate with the MinIO server */
|
|
17
15
|
accessKey: z.string(),
|
|
18
16
|
/** The MinIO secret key used to authenticate with the MinIO server */
|
|
@@ -23,11 +21,14 @@ var ServerClientOptionsSchema = ClientOptionsSchema.extend({
|
|
|
23
21
|
function createServerMinioClient(options) {
|
|
24
22
|
ensureServer();
|
|
25
23
|
const validatedOptions = validate(ServerClientOptionsSchema, options);
|
|
24
|
+
const url = new URL(validatedOptions.instance);
|
|
26
25
|
return {
|
|
27
26
|
client: new Client({
|
|
28
|
-
endPoint:
|
|
27
|
+
endPoint: url.hostname,
|
|
29
28
|
accessKey: validatedOptions.accessKey,
|
|
30
29
|
secretKey: validatedOptions.secretKey,
|
|
30
|
+
useSSL: url.protocol !== "http:",
|
|
31
|
+
port: url.port ? Number(url.port) : void 0,
|
|
31
32
|
region: "eu-central-1"
|
|
32
33
|
})
|
|
33
34
|
};
|
package/dist/minio.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/minio.ts","../src/helpers/client-options.schema.ts"],"sourcesContent":["import { ensureServer } from \"@settlemint/sdk-utils/runtime\";\nimport { validate } from \"@settlemint/sdk-utils/validation\";\nimport { Client } from \"minio\";\nimport { type ServerClientOptions, ServerClientOptionsSchema } from \"./helpers/client-options.schema.js\";\n\n/**\n * Creates a MinIO client for server-side use with authentication.\n *\n * @param options - The server client options for configuring the MinIO client\n * @returns An object containing the initialized MinIO client\n * @throws Will throw an error if not called on the server or if the options fail validation\n *\n * @example\n * import { createServerMinioClient } from \"@settlemint/sdk-minio\";\n *\n * const { client } = createServerMinioClient({\n * instance: process.env.SETTLEMINT_MINIO_ENDPOINT!,\n *
|
|
1
|
+
{"version":3,"sources":["../src/minio.ts","../src/helpers/client-options.schema.ts"],"sourcesContent":["import { ensureServer } from \"@settlemint/sdk-utils/runtime\";\nimport { validate } from \"@settlemint/sdk-utils/validation\";\nimport { Client } from \"minio\";\nimport { type ServerClientOptions, ServerClientOptionsSchema } from \"./helpers/client-options.schema.js\";\n\n/**\n * Creates a MinIO client for server-side use with authentication.\n *\n * @param options - The server client options for configuring the MinIO client\n * @returns An object containing the initialized MinIO client\n * @throws Will throw an error if not called on the server or if the options fail validation\n *\n * @example\n * import { createServerMinioClient } from \"@settlemint/sdk-minio\";\n *\n * const { client } = createServerMinioClient({\n * instance: process.env.SETTLEMINT_MINIO_ENDPOINT!,\n * accessKey: process.env.SETTLEMINT_MINIO_ACCESS_KEY!,\n * secretKey: process.env.SETTLEMINT_MINIO_SECRET_KEY!\n * });\n * client.listBuckets();\n */\nexport function createServerMinioClient(options: ServerClientOptions): { client: Client } {\n ensureServer();\n const validatedOptions = validate(ServerClientOptionsSchema, options);\n\n const url = new URL(validatedOptions.instance);\n return {\n client: new Client({\n endPoint: url.hostname,\n accessKey: validatedOptions.accessKey,\n secretKey: validatedOptions.secretKey,\n useSSL: url.protocol !== \"http:\",\n port: url.port ? Number(url.port) : undefined,\n region: \"eu-central-1\",\n }),\n };\n}\n","import { UrlSchema } from \"@settlemint/sdk-utils/validation\";\nimport { z } from \"zod\";\n\n/**\n * Schema for validating client options for the Portal client.\n */\nexport const ClientOptionsSchema = z.object({\n /** The URL of the MinIO instance to connect to */\n instance: UrlSchema,\n});\n\n/**\n * Type definition for client options derived from the ClientOptionsSchema.\n */\nexport type ClientOptions = z.infer<typeof ClientOptionsSchema>;\n\n/**\n * Schema for validating server client options for the Portal client.\n * Extends the ClientOptionsSchema with additional server-specific fields.\n */\nexport const ServerClientOptionsSchema = ClientOptionsSchema.extend({\n /** The MinIO access key used to authenticate with the MinIO server */\n accessKey: z.string(),\n /** The MinIO secret key used to authenticate with the MinIO server */\n secretKey: z.string(),\n});\n\n/**\n * Type definition for server client options derived from the ServerClientOptionsSchema.\n */\nexport type ServerClientOptions = z.infer<typeof ServerClientOptionsSchema>;\n"],"mappings":";AAAA,SAAS,oBAAoB;AAC7B,SAAS,gBAAgB;AACzB,SAAS,cAAc;;;ACFvB,SAAS,iBAAiB;AAC1B,SAAS,SAAS;AAKX,IAAM,sBAAsB,EAAE,OAAO;AAAA;AAAA,EAE1C,UAAU;AACZ,CAAC;AAWM,IAAM,4BAA4B,oBAAoB,OAAO;AAAA;AAAA,EAElE,WAAW,EAAE,OAAO;AAAA;AAAA,EAEpB,WAAW,EAAE,OAAO;AACtB,CAAC;;;ADHM,SAAS,wBAAwB,SAAkD;AACxF,eAAa;AACb,QAAM,mBAAmB,SAAS,2BAA2B,OAAO;AAEpE,QAAM,MAAM,IAAI,IAAI,iBAAiB,QAAQ;AAC7C,SAAO;AAAA,IACL,QAAQ,IAAI,OAAO;AAAA,MACjB,UAAU,IAAI;AAAA,MACd,WAAW,iBAAiB;AAAA,MAC5B,WAAW,iBAAiB;AAAA,MAC5B,QAAQ,IAAI,aAAa;AAAA,MACzB,MAAM,IAAI,OAAO,OAAO,IAAI,IAAI,IAAI;AAAA,MACpC,QAAQ;AAAA,IACV,CAAC;AAAA,EACH;AACF;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@settlemint/sdk-minio",
|
|
3
3
|
"description": "MinIO integration module for SettleMint SDK, providing S3-compatible object storage capabilities",
|
|
4
|
-
"version": "2.1.
|
|
4
|
+
"version": "2.1.3-prf97b3d3e",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"private": false,
|
|
7
7
|
"license": "FSL-1.1-MIT",
|
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
},
|
|
52
52
|
"devDependencies": {},
|
|
53
53
|
"dependencies": {
|
|
54
|
-
"@settlemint/sdk-utils": "2.1.
|
|
54
|
+
"@settlemint/sdk-utils": "2.1.3-prf97b3d3e",
|
|
55
55
|
"minio": "^8",
|
|
56
56
|
"zod": "^3"
|
|
57
57
|
},
|