@settlemint/sdk-minio 2.2.0 → 2.2.1-maina13447c3

package/README.md

@@ -46,8 +46,6 @@
 
 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.
 
-For detailed information about using MinIO with the SettleMint platform, check out our [official documentation](https://console.settlemint.com/documentation).
-
 ## API Reference
 
 ### Functions
@@ -56,7 +54,7 @@ For detailed information about using MinIO with the SettleMint platform, check o
 
 > **createPresignedUploadUrl**(`client`, `fileName`, `path`, `bucket`, `expirySeconds`): `Promise`\<`string`\>
 
-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)
+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)
 
 Creates a presigned upload URL for direct browser uploads
 
@@ -113,7 +111,7 @@ await fetch(uploadUrl, {
 
 > **createServerMinioClient**(`options`): `object`
 
-Defined in: [sdk/minio/src/minio.ts:23](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/minio/src/minio.ts#L23)
+Defined in: [sdk/minio/src/minio.ts:23](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/minio/src/minio.ts#L23)
 
 Creates a MinIO client for server-side use with authentication.
 
@@ -134,7 +132,7 @@ An object containing the initialized MinIO client
 
 | Name | Type | Defined in |
 | ------ | ------ | ------ |
-| `client` | `Client` | [sdk/minio/src/minio.ts:23](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/minio/src/minio.ts#L23) |
+| `client` | `Client` | [sdk/minio/src/minio.ts:23](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/minio/src/minio.ts#L23) |
 
 ##### Throws
 
@@ -159,7 +157,7 @@ client.listBuckets();
 
 > **deleteFile**(`client`, `fileId`, `bucket`): `Promise`\<`boolean`\>
 
-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)
+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)
 
 Deletes a file from storage
 
@@ -201,7 +199,7 @@ await deleteFile(client, "documents/report.pdf");
 
 > **getFileById**(`client`, `fileId`, `bucket`): `Promise`\<[`FileMetadata`](#filemetadata)\>
 
-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)
+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)
 
 Gets a single file by its object name
 
@@ -243,7 +241,7 @@ const file = await getFileByObjectName(client, "documents/report.pdf");
 
 > **getFilesList**(`client`, `prefix`, `bucket`): `Promise`\<[`FileMetadata`](#filemetadata)[]\>
 
-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)
+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)
 
 Gets a list of files with optional prefix filter
 
@@ -285,7 +283,7 @@ const files = await getFilesList(client, "documents/");
 
 > **uploadFile**(`client`, `buffer`, `objectName`, `contentType`, `bucket`): `Promise`\<[`FileMetadata`](#filemetadata)\>
 
-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)
+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)
 
 Uploads a buffer directly to storage
 
@@ -328,7 +326,7 @@ const uploadedFile = await uploadFile(client, buffer, "documents/hello.txt", "te
 
 #### FileMetadata
 
-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)
+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)
 
 Type representing file metadata after validation.
 
@@ -336,13 +334,13 @@ Type representing file metadata after validation.
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <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) |
-| <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) |
-| <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) |
-| <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) |
-| <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) |
-| <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) |
-| <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) |
+| <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) |
+| <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) |
+| <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) |
+| <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) |
+| <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) |
+| <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) |
+| <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) |
 
 ### Variables
 
@@ -350,7 +348,7 @@ Type representing file metadata after validation.
 
 > `const` **DEFAULT\_BUCKET**: `"uploads"` = `"uploads"`
 
-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)
+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)
 
 Default bucket name to use for file storage when none is specified.
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@settlemint/sdk-minio",
   "description": "MinIO integration module for SettleMint SDK, providing S3-compatible object storage capabilities",
-  "version": "2.2.0",
+  "version": "2.2.1-maina13447c3",
   "type": "module",
   "private": false,
   "license": "FSL-1.1-MIT",
@@ -51,7 +51,7 @@
   },
   "devDependencies": {},
   "dependencies": {
-    "@settlemint/sdk-utils": "2.2.0",
+    "@settlemint/sdk-utils": "2.2.1-maina13447c3",
     "minio": "^8",
     "zod": "^3"
   },