@breadstone/archipel-mcp 0.0.1

package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md

@@ -0,0 +1,53 @@
+---
+title: 'Interface: IBlobDownloadRequest'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-blob-storage**](../)
+
+---
+
+# Interface: IBlobDownloadRequest
+
+Defined in: [interfaces/IBlobProvider.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L64)
+
+## Properties
+
+### bucket?
+
+```ts
+optional bucket?: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L68)
+
+---
+
+### key
+
+```ts
+key: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L65)
+
+---
+
+### responseType?
+
+```ts
+optional responseType?: BlobDownloadResponseType;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L67)
+
+---
+
+### versionId?
+
+```ts
+optional versionId?: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L66)

package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md

@@ -0,0 +1,69 @@
+---
+title: 'Interface: IBlobDownloadResult\<TData\>'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-blob-storage**](../)
+
+---
+
+# Interface: IBlobDownloadResult\<TData\>
+
+Defined in: [interfaces/IBlobProvider.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L71)
+
+## Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `TData`        |
+
+## Properties
+
+### contentLength?
+
+```ts
+optional contentLength?: number;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L74)
+
+---
+
+### contentType?
+
+```ts
+optional contentType?: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L73)
+
+---
+
+### data
+
+```ts
+data: TData;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:72](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L72)
+
+---
+
+### metadata?
+
+```ts
+optional metadata?: Record<string, string>;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L75)
+
+---
+
+### rawResponse?
+
+```ts
+optional rawResponse?: unknown;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:76](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L76)

package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md

@@ -0,0 +1,53 @@
+---
+title: 'Interface: IBlobModuleOptions'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-blob-storage**](../)
+
+---
+
+# Interface: IBlobModuleOptions
+
+Defined in: [BlobModule.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L20)
+
+## Properties
+
+### isGlobal?
+
+```ts
+optional isGlobal?: boolean;
+```
+
+Defined in: [BlobModule.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L24)
+
+---
+
+### objectPersistence?
+
+```ts
+optional objectPersistence?: Type<BlobObjectPersistencePort>;
+```
+
+Defined in: [BlobModule.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L22)
+
+---
+
+### provider?
+
+```ts
+optional provider?: IBlobProviderRegistration;
+```
+
+Defined in: [BlobModule.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L21)
+
+---
+
+### variantPersistence?
+
+```ts
+optional variantPersistence?: Type<BlobVariantPersistencePort>;
+```
+
+Defined in: [BlobModule.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L23)

package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md

@@ -0,0 +1,143 @@
+---
+title: 'Interface: IBlobObjectMetadata'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-blob-storage**](../)
+
+---
+
+# Interface: IBlobObjectMetadata
+
+Defined in: [interfaces/IBlobProvider.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L31)
+
+## Properties
+
+### bucket
+
+```ts
+bucket: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L33)
+
+---
+
+### checksumSha256?
+
+```ts
+optional checksumSha256?: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L40)
+
+---
+
+### contentType
+
+```ts
+contentType: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L38)
+
+---
+
+### etag?
+
+```ts
+optional etag?: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L39)
+
+---
+
+### isLatest
+
+```ts
+isLatest: boolean;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L43)
+
+---
+
+### key
+
+```ts
+key: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L35)
+
+---
+
+### metadata?
+
+```ts
+optional metadata?: Record<string, string>;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L42)
+
+---
+
+### ownerUserId?
+
+```ts
+optional ownerUserId?: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L44)
+
+---
+
+### provider
+
+```ts
+provider: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L32)
+
+---
+
+### region?
+
+```ts
+optional region?: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L34)
+
+---
+
+### size
+
+```ts
+size: number;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L37)
+
+---
+
+### storageClass?
+
+```ts
+optional storageClass?: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L41)
+
+---
+
+### versionId?
+
+```ts
+optional versionId?: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L36)

package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md

@@ -0,0 +1,119 @@
+---
+title: 'Interface: IBlobProvider'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-blob-storage**](../)
+
+---
+
+# Interface: IBlobProvider
+
+Defined in: [interfaces/IBlobProvider.ts:92](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L92)
+
+## Properties
+
+### defaultBucket?
+
+```ts
+readonly optional defaultBucket?: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:94](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L94)
+
+---
+
+### providerId
+
+```ts
+readonly providerId: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:93](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L93)
+
+## Methods
+
+### createSignedUrl()?
+
+```ts
+optional createSignedUrl(request): Promise<string>;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L98)
+
+#### Parameters
+
+| Parameter | Type                                                       |
+| --------- | ---------------------------------------------------------- |
+| `request` | [`IBlobSignedUrlRequest`](Interface.IBlobSignedUrlRequest) |
+
+#### Returns
+
+`Promise`\<`string`\>
+
+---
+
+### deleteObject()
+
+```ts
+deleteObject(request): Promise<void>;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L97)
+
+#### Parameters
+
+| Parameter | Type                                                 |
+| --------- | ---------------------------------------------------- |
+| `request` | [`IBlobDeleteRequest`](Interface.IBlobDeleteRequest) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+---
+
+### downloadObject()
+
+```ts
+downloadObject<TData>(request): Promise<IBlobDownloadResult<TData>>;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:96](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L96)
+
+#### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `TData`        |
+
+#### Parameters
+
+| Parameter | Type                                                     |
+| --------- | -------------------------------------------------------- |
+| `request` | [`IBlobDownloadRequest`](Interface.IBlobDownloadRequest) |
+
+#### Returns
+
+`Promise`\<[`IBlobDownloadResult`](Interface.IBlobDownloadResult)\<`TData`\>\>
+
+---
+
+### uploadObject()
+
+```ts
+uploadObject(request): Promise<IBlobUploadResult>;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:95](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L95)
+
+#### Parameters
+
+| Parameter | Type                                                 |
+| --------- | ---------------------------------------------------- |
+| `request` | [`IBlobUploadRequest`](Interface.IBlobUploadRequest) |
+
+#### Returns
+
+`Promise`\<[`IBlobUploadResult`](Interface.IBlobUploadResult)\>

package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md

@@ -0,0 +1,53 @@
+---
+title: 'Interface: IBlobSignedUrlRequest'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-blob-storage**](../)
+
+---
+
+# Interface: IBlobSignedUrlRequest
+
+Defined in: [interfaces/IBlobProvider.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L85)
+
+## Properties
+
+### bucket?
+
+```ts
+optional bucket?: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:88](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L88)
+
+---
+
+### expiresInSeconds?
+
+```ts
+optional expiresInSeconds?: number;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:87](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L87)
+
+---
+
+### key
+
+```ts
+key: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:86](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L86)
+
+---
+
+### versionId?
+
+```ts
+optional versionId?: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:89](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L89)

package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md

@@ -0,0 +1,103 @@
+---
+title: 'Interface: IBlobUploadRequest'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-blob-storage**](../)
+
+---
+
+# Interface: IBlobUploadRequest
+
+Defined in: [interfaces/IBlobProvider.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L47)
+
+## Properties
+
+### body
+
+```ts
+body: BlobUploadBody;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L49)
+
+---
+
+### bucket?
+
+```ts
+optional bucket?: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L55)
+
+---
+
+### checksumSha256?
+
+```ts
+optional checksumSha256?: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L53)
+
+---
+
+### contentLength?
+
+```ts
+optional contentLength?: number;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L51)
+
+---
+
+### contentType?
+
+```ts
+optional contentType?: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L50)
+
+---
+
+### key
+
+```ts
+key: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L48)
+
+---
+
+### metadata?
+
+```ts
+optional metadata?: Record<string, string>;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L52)
+
+---
+
+### ownerUserId?
+
+```ts
+optional ownerUserId?: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L54)
+
+---
+
+### region?
+
+```ts
+optional region?: string;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L56)

package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md

@@ -0,0 +1,33 @@
+---
+title: 'Interface: IBlobUploadResult'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-blob-storage**](../)
+
+---
+
+# Interface: IBlobUploadResult
+
+Defined in: [interfaces/IBlobProvider.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L59)
+
+## Properties
+
+### metadata
+
+```ts
+metadata: IBlobObjectMetadata;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L60)
+
+---
+
+### rawResponse?
+
+```ts
+optional rawResponse?: unknown;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L61)

package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md

@@ -0,0 +1,33 @@
+---
+title: 'Interface: ICustomBlobProviderRegistration'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-blob-storage**](../)
+
+---
+
+# Interface: ICustomBlobProviderRegistration
+
+Defined in: [BlobModule.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L32)
+
+## Properties
+
+### kind
+
+```ts
+kind: 'custom';
+```
+
+Defined in: [BlobModule.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L33)
+
+---
+
+### useClass
+
+```ts
+useClass: Type<IBlobProvider>;
+```
+
+Defined in: [BlobModule.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L34)