@settlemint/sdk-minio 2.2.0 → 2.2.1-mainfa37c298
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 +16 -18
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -46,8 +46,6 @@
|
|
|
46
46
|
|
|
47
47
|
The SettleMint MinIO SDK provides a simple way to interact with MinIO object storage through the SettleMint platform. It enables you to easily store and retrieve files using MinIO's S3-compatible API in a secure and scalable manner.
|
|
48
48
|
|
|
49
|
-
For detailed information about using MinIO with the SettleMint platform, check out our [official documentation](https://console.settlemint.com/documentation).
|
|
50
|
-
|
|
51
49
|
## API Reference
|
|
52
50
|
|
|
53
51
|
### Functions
|
|
@@ -56,7 +54,7 @@ For detailed information about using MinIO with the SettleMint platform, check o
|
|
|
56
54
|
|
|
57
55
|
> **createPresignedUploadUrl**(`client`, `fileName`, `path`, `bucket`, `expirySeconds`): `Promise`\<`string`\>
|
|
58
56
|
|
|
59
|
-
Defined in: [sdk/minio/src/helpers/functions.ts:243](https://github.com/settlemint/sdk/blob/v2.2.
|
|
57
|
+
Defined in: [sdk/minio/src/helpers/functions.ts:243](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/minio/src/helpers/functions.ts#L243)
|
|
60
58
|
|
|
61
59
|
Creates a presigned upload URL for direct browser uploads
|
|
62
60
|
|
|
@@ -113,7 +111,7 @@ await fetch(uploadUrl, {
|
|
|
113
111
|
|
|
114
112
|
> **createServerMinioClient**(`options`): `object`
|
|
115
113
|
|
|
116
|
-
Defined in: [sdk/minio/src/minio.ts:23](https://github.com/settlemint/sdk/blob/v2.2.
|
|
114
|
+
Defined in: [sdk/minio/src/minio.ts:23](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/minio/src/minio.ts#L23)
|
|
117
115
|
|
|
118
116
|
Creates a MinIO client for server-side use with authentication.
|
|
119
117
|
|
|
@@ -134,7 +132,7 @@ An object containing the initialized MinIO client
|
|
|
134
132
|
|
|
135
133
|
| Name | Type | Defined in |
|
|
136
134
|
| ------ | ------ | ------ |
|
|
137
|
-
| `client` | `Client` | [sdk/minio/src/minio.ts:23](https://github.com/settlemint/sdk/blob/v2.2.
|
|
135
|
+
| `client` | `Client` | [sdk/minio/src/minio.ts:23](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/minio/src/minio.ts#L23) |
|
|
138
136
|
|
|
139
137
|
##### Throws
|
|
140
138
|
|
|
@@ -159,7 +157,7 @@ client.listBuckets();
|
|
|
159
157
|
|
|
160
158
|
> **deleteFile**(`client`, `fileId`, `bucket`): `Promise`\<`boolean`\>
|
|
161
159
|
|
|
162
|
-
Defined in: [sdk/minio/src/helpers/functions.ts:196](https://github.com/settlemint/sdk/blob/v2.2.
|
|
160
|
+
Defined in: [sdk/minio/src/helpers/functions.ts:196](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/minio/src/helpers/functions.ts#L196)
|
|
163
161
|
|
|
164
162
|
Deletes a file from storage
|
|
165
163
|
|
|
@@ -201,7 +199,7 @@ await deleteFile(client, "documents/report.pdf");
|
|
|
201
199
|
|
|
202
200
|
> **getFileById**(`client`, `fileId`, `bucket`): `Promise`\<[`FileMetadata`](#filemetadata)\>
|
|
203
201
|
|
|
204
|
-
Defined in: [sdk/minio/src/helpers/functions.ts:123](https://github.com/settlemint/sdk/blob/v2.2.
|
|
202
|
+
Defined in: [sdk/minio/src/helpers/functions.ts:123](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/minio/src/helpers/functions.ts#L123)
|
|
205
203
|
|
|
206
204
|
Gets a single file by its object name
|
|
207
205
|
|
|
@@ -243,7 +241,7 @@ const file = await getFileByObjectName(client, "documents/report.pdf");
|
|
|
243
241
|
|
|
244
242
|
> **getFilesList**(`client`, `prefix`, `bucket`): `Promise`\<[`FileMetadata`](#filemetadata)[]\>
|
|
245
243
|
|
|
246
|
-
Defined in: [sdk/minio/src/helpers/functions.ts:62](https://github.com/settlemint/sdk/blob/v2.2.
|
|
244
|
+
Defined in: [sdk/minio/src/helpers/functions.ts:62](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/minio/src/helpers/functions.ts#L62)
|
|
247
245
|
|
|
248
246
|
Gets a list of files with optional prefix filter
|
|
249
247
|
|
|
@@ -285,7 +283,7 @@ const files = await getFilesList(client, "documents/");
|
|
|
285
283
|
|
|
286
284
|
> **uploadFile**(`client`, `buffer`, `objectName`, `contentType`, `bucket`): `Promise`\<[`FileMetadata`](#filemetadata)\>
|
|
287
285
|
|
|
288
|
-
Defined in: [sdk/minio/src/helpers/functions.ts:293](https://github.com/settlemint/sdk/blob/v2.2.
|
|
286
|
+
Defined in: [sdk/minio/src/helpers/functions.ts:293](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/minio/src/helpers/functions.ts#L293)
|
|
289
287
|
|
|
290
288
|
Uploads a buffer directly to storage
|
|
291
289
|
|
|
@@ -328,7 +326,7 @@ const uploadedFile = await uploadFile(client, buffer, "documents/hello.txt", "te
|
|
|
328
326
|
|
|
329
327
|
#### FileMetadata
|
|
330
328
|
|
|
331
|
-
Defined in: [sdk/minio/src/helpers/schema.ts:29](https://github.com/settlemint/sdk/blob/v2.2.
|
|
329
|
+
Defined in: [sdk/minio/src/helpers/schema.ts:29](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/minio/src/helpers/schema.ts#L29)
|
|
332
330
|
|
|
333
331
|
Type representing file metadata after validation.
|
|
334
332
|
|
|
@@ -336,13 +334,13 @@ Type representing file metadata after validation.
|
|
|
336
334
|
|
|
337
335
|
| Property | Type | Description | Defined in |
|
|
338
336
|
| ------ | ------ | ------ | ------ |
|
|
339
|
-
| <a id="contenttype"></a> `contentType` | `string` | The content type of the file. | [sdk/minio/src/helpers/schema.ts:41](https://github.com/settlemint/sdk/blob/v2.2.
|
|
340
|
-
| <a id="etag"></a> `etag` | `string` | The ETag of the file. | [sdk/minio/src/helpers/schema.ts:56](https://github.com/settlemint/sdk/blob/v2.2.
|
|
341
|
-
| <a id="id"></a> `id` | `string` | The unique identifier for the file. | [sdk/minio/src/helpers/schema.ts:33](https://github.com/settlemint/sdk/blob/v2.2.
|
|
342
|
-
| <a id="name"></a> `name` | `string` | The name of the file. | [sdk/minio/src/helpers/schema.ts:37](https://github.com/settlemint/sdk/blob/v2.2.
|
|
343
|
-
| <a id="size"></a> `size` | `number` | The size of the file in bytes. | [sdk/minio/src/helpers/schema.ts:46](https://github.com/settlemint/sdk/blob/v2.2.
|
|
344
|
-
| <a id="uploadedat"></a> `uploadedAt` | `string` | The date and time the file was uploaded. | [sdk/minio/src/helpers/schema.ts:51](https://github.com/settlemint/sdk/blob/v2.2.
|
|
345
|
-
| <a id="url"></a> `url?` | `string` | The URL of the file. | [sdk/minio/src/helpers/schema.ts:61](https://github.com/settlemint/sdk/blob/v2.2.
|
|
337
|
+
| <a id="contenttype"></a> `contentType` | `string` | The content type of the file. | [sdk/minio/src/helpers/schema.ts:41](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/minio/src/helpers/schema.ts#L41) |
|
|
338
|
+
| <a id="etag"></a> `etag` | `string` | The ETag of the file. | [sdk/minio/src/helpers/schema.ts:56](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/minio/src/helpers/schema.ts#L56) |
|
|
339
|
+
| <a id="id"></a> `id` | `string` | The unique identifier for the file. | [sdk/minio/src/helpers/schema.ts:33](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/minio/src/helpers/schema.ts#L33) |
|
|
340
|
+
| <a id="name"></a> `name` | `string` | The name of the file. | [sdk/minio/src/helpers/schema.ts:37](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/minio/src/helpers/schema.ts#L37) |
|
|
341
|
+
| <a id="size"></a> `size` | `number` | The size of the file in bytes. | [sdk/minio/src/helpers/schema.ts:46](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/minio/src/helpers/schema.ts#L46) |
|
|
342
|
+
| <a id="uploadedat"></a> `uploadedAt` | `string` | The date and time the file was uploaded. | [sdk/minio/src/helpers/schema.ts:51](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/minio/src/helpers/schema.ts#L51) |
|
|
343
|
+
| <a id="url"></a> `url?` | `string` | The URL of the file. | [sdk/minio/src/helpers/schema.ts:61](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/minio/src/helpers/schema.ts#L61) |
|
|
346
344
|
|
|
347
345
|
### Variables
|
|
348
346
|
|
|
@@ -350,7 +348,7 @@ Type representing file metadata after validation.
|
|
|
350
348
|
|
|
351
349
|
> `const` **DEFAULT\_BUCKET**: `"uploads"` = `"uploads"`
|
|
352
350
|
|
|
353
|
-
Defined in: [sdk/minio/src/helpers/schema.ts:67](https://github.com/settlemint/sdk/blob/v2.2.
|
|
351
|
+
Defined in: [sdk/minio/src/helpers/schema.ts:67](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/minio/src/helpers/schema.ts#L67)
|
|
354
352
|
|
|
355
353
|
Default bucket name to use for file storage when none is specified.
|
|
356
354
|
|
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.2.
|
|
4
|
+
"version": "2.2.1-mainfa37c298",
|
|
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.2.
|
|
54
|
+
"@settlemint/sdk-utils": "2.2.1-mainfa37c298",
|
|
55
55
|
"minio": "^8",
|
|
56
56
|
"zod": "^3"
|
|
57
57
|
},
|