@settlemint/sdk-minio 2.1.5-prfe9b44ca → 2.2.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.
Files changed (2) hide show
  1. package/README.md +16 -16
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -56,7 +56,7 @@ For detailed information about using MinIO with the SettleMint platform, check o
56
56
 
57
57
  > **createPresignedUploadUrl**(`client`, `fileName`, `path`, `bucket`, `expirySeconds`): `Promise`\<`string`\>
58
58
 
59
- Defined in: [sdk/minio/src/helpers/functions.ts:243](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/minio/src/helpers/functions.ts#L243)
59
+ Defined in: [sdk/minio/src/helpers/functions.ts:243](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/minio/src/helpers/functions.ts#L243)
60
60
 
61
61
  Creates a presigned upload URL for direct browser uploads
62
62
 
@@ -113,7 +113,7 @@ await fetch(uploadUrl, {
113
113
 
114
114
  > **createServerMinioClient**(`options`): `object`
115
115
 
116
- Defined in: [sdk/minio/src/minio.ts:23](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/minio/src/minio.ts#L23)
116
+ Defined in: [sdk/minio/src/minio.ts:23](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/minio/src/minio.ts#L23)
117
117
 
118
118
  Creates a MinIO client for server-side use with authentication.
119
119
 
@@ -134,7 +134,7 @@ An object containing the initialized MinIO client
134
134
 
135
135
  | Name | Type | Defined in |
136
136
  | ------ | ------ | ------ |
137
- | `client` | `Client` | [sdk/minio/src/minio.ts:23](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/minio/src/minio.ts#L23) |
137
+ | `client` | `Client` | [sdk/minio/src/minio.ts:23](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/minio/src/minio.ts#L23) |
138
138
 
139
139
  ##### Throws
140
140
 
@@ -159,7 +159,7 @@ client.listBuckets();
159
159
 
160
160
  > **deleteFile**(`client`, `fileId`, `bucket`): `Promise`\<`boolean`\>
161
161
 
162
- Defined in: [sdk/minio/src/helpers/functions.ts:196](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/minio/src/helpers/functions.ts#L196)
162
+ Defined in: [sdk/minio/src/helpers/functions.ts:196](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/minio/src/helpers/functions.ts#L196)
163
163
 
164
164
  Deletes a file from storage
165
165
 
@@ -201,7 +201,7 @@ await deleteFile(client, "documents/report.pdf");
201
201
 
202
202
  > **getFileById**(`client`, `fileId`, `bucket`): `Promise`\<[`FileMetadata`](#filemetadata)\>
203
203
 
204
- Defined in: [sdk/minio/src/helpers/functions.ts:123](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/minio/src/helpers/functions.ts#L123)
204
+ Defined in: [sdk/minio/src/helpers/functions.ts:123](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/minio/src/helpers/functions.ts#L123)
205
205
 
206
206
  Gets a single file by its object name
207
207
 
@@ -243,7 +243,7 @@ const file = await getFileByObjectName(client, "documents/report.pdf");
243
243
 
244
244
  > **getFilesList**(`client`, `prefix`, `bucket`): `Promise`\<[`FileMetadata`](#filemetadata)[]\>
245
245
 
246
- Defined in: [sdk/minio/src/helpers/functions.ts:62](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/minio/src/helpers/functions.ts#L62)
246
+ Defined in: [sdk/minio/src/helpers/functions.ts:62](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/minio/src/helpers/functions.ts#L62)
247
247
 
248
248
  Gets a list of files with optional prefix filter
249
249
 
@@ -285,7 +285,7 @@ const files = await getFilesList(client, "documents/");
285
285
 
286
286
  > **uploadFile**(`client`, `buffer`, `objectName`, `contentType`, `bucket`): `Promise`\<[`FileMetadata`](#filemetadata)\>
287
287
 
288
- Defined in: [sdk/minio/src/helpers/functions.ts:293](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/minio/src/helpers/functions.ts#L293)
288
+ Defined in: [sdk/minio/src/helpers/functions.ts:293](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/minio/src/helpers/functions.ts#L293)
289
289
 
290
290
  Uploads a buffer directly to storage
291
291
 
@@ -328,7 +328,7 @@ const uploadedFile = await uploadFile(client, buffer, "documents/hello.txt", "te
328
328
 
329
329
  #### FileMetadata
330
330
 
331
- Defined in: [sdk/minio/src/helpers/schema.ts:29](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/minio/src/helpers/schema.ts#L29)
331
+ Defined in: [sdk/minio/src/helpers/schema.ts:29](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/minio/src/helpers/schema.ts#L29)
332
332
 
333
333
  Type representing file metadata after validation.
334
334
 
@@ -336,13 +336,13 @@ Type representing file metadata after validation.
336
336
 
337
337
  | Property | Type | Description | Defined in |
338
338
  | ------ | ------ | ------ | ------ |
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.1.5/sdk/minio/src/helpers/schema.ts#L41) |
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.1.5/sdk/minio/src/helpers/schema.ts#L56) |
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.1.5/sdk/minio/src/helpers/schema.ts#L33) |
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.1.5/sdk/minio/src/helpers/schema.ts#L37) |
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.1.5/sdk/minio/src/helpers/schema.ts#L46) |
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.1.5/sdk/minio/src/helpers/schema.ts#L51) |
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.1.5/sdk/minio/src/helpers/schema.ts#L61) |
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.0/sdk/minio/src/helpers/schema.ts#L41) |
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.0/sdk/minio/src/helpers/schema.ts#L56) |
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.0/sdk/minio/src/helpers/schema.ts#L33) |
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.0/sdk/minio/src/helpers/schema.ts#L37) |
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.0/sdk/minio/src/helpers/schema.ts#L46) |
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.0/sdk/minio/src/helpers/schema.ts#L51) |
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.0/sdk/minio/src/helpers/schema.ts#L61) |
346
346
 
347
347
  ### Variables
348
348
 
@@ -350,7 +350,7 @@ Type representing file metadata after validation.
350
350
 
351
351
  > `const` **DEFAULT\_BUCKET**: `"uploads"` = `"uploads"`
352
352
 
353
- Defined in: [sdk/minio/src/helpers/schema.ts:67](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/minio/src/helpers/schema.ts#L67)
353
+ Defined in: [sdk/minio/src/helpers/schema.ts:67](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/minio/src/helpers/schema.ts#L67)
354
354
 
355
355
  Default bucket name to use for file storage when none is specified.
356
356
 
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.5-prfe9b44ca",
4
+ "version": "2.2.0",
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.5-prfe9b44ca",
54
+ "@settlemint/sdk-utils": "2.2.0",
55
55
  "minio": "^8",
56
56
  "zod": "^3"
57
57
  },