@breadstone/archipel-mcp 0.0.39 → 0.0.41

package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md

@@ -1,196 +0,0 @@
----
-title: 'Class: AwsS3BlobProvider'
-generated: true
-editUrl: false
----
-# Class: AwsS3BlobProvider
-
-Defined in: [providers/AwsS3BlobProvider.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L38)
-
-Provides an implementation of [IBlobProvider](Interface.IBlobProvider) for Amazon S3.
-
-## Implements
-
-- [`IBlobProvider`](Interface.IBlobProvider)
-
-## Constructors
-
-### Constructor
-
-```ts
-new AwsS3BlobProvider(options): AwsS3BlobProvider;
-```
-
-Defined in: [providers/AwsS3BlobProvider.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L55)
-
-Initializes a new instance of the AwsS3BlobProvider class.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `options` | [`IAwsS3ProviderOptions`](Interface.IAwsS3ProviderOptions) | The provider configuration options. |
-
-#### Returns
-
-`AwsS3BlobProvider`
-
-## Accessors
-
-### defaultBucket
-
-#### Get Signature
-
-```ts
-get defaultBucket(): string;
-```
-
-Defined in: [providers/AwsS3BlobProvider.ts:90](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L90)
-
-Gets the default bucket configured for the provider.
-
-##### Returns
-
-`string`
-
-#### Implementation of
-
-[`IBlobProvider`](Interface.IBlobProvider).[`defaultBucket`](Interface.IBlobProvider#defaultbucket)
-
-***
-
-### providerId
-
-#### Get Signature
-
-```ts
-get providerId(): string;
-```
-
-Defined in: [providers/AwsS3BlobProvider.ts:83](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L83)
-
-Gets the identifier used to persist provider metadata.
-
-##### Returns
-
-`string`
-
-#### Implementation of
-
-[`IBlobProvider`](Interface.IBlobProvider).[`providerId`](Interface.IBlobProvider#providerid)
-
-## Methods
-
-### createSignedUrl()
-
-```ts
-createSignedUrl(request): Promise<string>;
-```
-
-Defined in: [providers/AwsS3BlobProvider.ts:210](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L210)
-
-Creates a pre-signed URL for the specified blob object.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`IBlobSignedUrlRequest`](Interface.IBlobSignedUrlRequest) | The request describing the object to link. |
-
-#### Returns
-
-`Promise`\<`string`\>
-
-The generated pre-signed URL.
-
-#### Implementation of
-
-[`IBlobProvider`](Interface.IBlobProvider).[`createSignedUrl`](Interface.IBlobProvider#createsignedurl)
-
-***
-
-### deleteObject()
-
-```ts
-deleteObject(request): Promise<void>;
-```
-
-Defined in: [providers/AwsS3BlobProvider.ts:186](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L186)
-
-Deletes a blob object from Amazon S3.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`IBlobDeleteRequest`](Interface.IBlobDeleteRequest) | The delete request describing the object to remove. |
-
-#### Returns
-
-`Promise`\<`void`\>
-
-#### Implementation of
-
-[`IBlobProvider`](Interface.IBlobProvider).[`deleteObject`](Interface.IBlobProvider#deleteobject)
-
-***
-
-### downloadObject()
-
-```ts
-downloadObject<TData>(request): Promise<IBlobDownloadResult<TData>>;
-```
-
-Defined in: [providers/AwsS3BlobProvider.ts:156](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L156)
-
-Downloads a blob object from Amazon S3.
-
-#### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `TData` |
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`IBlobDownloadRequest`](Interface.IBlobDownloadRequest) | The download request describing the object to download. |
-
-#### Returns
-
-`Promise`\<[`IBlobDownloadResult`](Interface.IBlobDownloadResult)\<`TData`\>\>
-
-The download result including payload and metadata.
-
-#### Implementation of
-
-[`IBlobProvider`](Interface.IBlobProvider).[`downloadObject`](Interface.IBlobProvider#downloadobject)
-
-***
-
-### uploadObject()
-
-```ts
-uploadObject(request): Promise<IBlobUploadResult>;
-```
-
-Defined in: [providers/AwsS3BlobProvider.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L105)
-
-Uploads a blob object to Amazon S3.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`IBlobUploadRequest`](Interface.IBlobUploadRequest) | The upload request describing the object to upload. |
-
-#### Returns
-
-`Promise`\<[`IBlobUploadResult`](Interface.IBlobUploadResult)\>
-
-The resulting upload metadata.
-
-#### Implementation of
-
-[`IBlobProvider`](Interface.IBlobProvider).[`uploadObject`](Interface.IBlobProvider#uploadobject)

package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md

@@ -1,196 +0,0 @@
----
-title: 'Class: AzureBlobProvider'
-generated: true
-editUrl: false
----
-# Class: AzureBlobProvider
-
-Defined in: [providers/AzureBlobProvider.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L35)
-
-Provides an implementation of [IBlobProvider](Interface.IBlobProvider) for Microsoft Azure Blob Storage.
-
-## Implements
-
-- [`IBlobProvider`](Interface.IBlobProvider)
-
-## Constructors
-
-### Constructor
-
-```ts
-new AzureBlobProvider(options): AzureBlobProvider;
-```
-
-Defined in: [providers/AzureBlobProvider.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L53)
-
-Initializes a new instance of the AzureBlobProvider class.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `options` | [`IAzureBlobProviderOptions`](Interface.IAzureBlobProviderOptions) | The provider configuration options. |
-
-#### Returns
-
-`AzureBlobProvider`
-
-## Accessors
-
-### defaultBucket
-
-#### Get Signature
-
-```ts
-get defaultBucket(): string;
-```
-
-Defined in: [providers/AzureBlobProvider.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L84)
-
-Gets the default bucket (container) configured for the provider.
-
-##### Returns
-
-`string`
-
-#### Implementation of
-
-[`IBlobProvider`](Interface.IBlobProvider).[`defaultBucket`](Interface.IBlobProvider#defaultbucket)
-
-***
-
-### providerId
-
-#### Get Signature
-
-```ts
-get providerId(): string;
-```
-
-Defined in: [providers/AzureBlobProvider.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L77)
-
-Gets the identifier used to persist provider metadata.
-
-##### Returns
-
-`string`
-
-#### Implementation of
-
-[`IBlobProvider`](Interface.IBlobProvider).[`providerId`](Interface.IBlobProvider#providerid)
-
-## Methods
-
-### createSignedUrl()
-
-```ts
-createSignedUrl(request): Promise<string>;
-```
-
-Defined in: [providers/AzureBlobProvider.ts:194](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L194)
-
-Creates a SAS-signed URL for the specified blob object.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`IBlobSignedUrlRequest`](Interface.IBlobSignedUrlRequest) | The request describing the object to link. |
-
-#### Returns
-
-`Promise`\<`string`\>
-
-The generated SAS URL.
-
-#### Implementation of
-
-[`IBlobProvider`](Interface.IBlobProvider).[`createSignedUrl`](Interface.IBlobProvider#createsignedurl)
-
-***
-
-### deleteObject()
-
-```ts
-deleteObject(request): Promise<void>;
-```
-
-Defined in: [providers/AzureBlobProvider.ts:175](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L175)
-
-Deletes a blob object from Azure Blob Storage.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`IBlobDeleteRequest`](Interface.IBlobDeleteRequest) | The delete request describing the object to remove. |
-
-#### Returns
-
-`Promise`\<`void`\>
-
-#### Implementation of
-
-[`IBlobProvider`](Interface.IBlobProvider).[`deleteObject`](Interface.IBlobProvider#deleteobject)
-
-***
-
-### downloadObject()
-
-```ts
-downloadObject<TData>(request): Promise<IBlobDownloadResult<TData>>;
-```
-
-Defined in: [providers/AzureBlobProvider.ts:147](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L147)
-
-Downloads a blob object from Azure Blob Storage.
-
-#### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `TData` |
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`IBlobDownloadRequest`](Interface.IBlobDownloadRequest) | The download request describing the object to download. |
-
-#### Returns
-
-`Promise`\<[`IBlobDownloadResult`](Interface.IBlobDownloadResult)\<`TData`\>\>
-
-The download result including payload and metadata.
-
-#### Implementation of
-
-[`IBlobProvider`](Interface.IBlobProvider).[`downloadObject`](Interface.IBlobProvider#downloadobject)
-
-***
-
-### uploadObject()
-
-```ts
-uploadObject(request): Promise<IBlobUploadResult>;
-```
-
-Defined in: [providers/AzureBlobProvider.ts:99](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L99)
-
-Uploads a blob object to Azure Blob Storage.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`IBlobUploadRequest`](Interface.IBlobUploadRequest) | The upload request describing the object to upload. |
-
-#### Returns
-
-`Promise`\<[`IBlobUploadResult`](Interface.IBlobUploadResult)\>
-
-The resulting upload metadata.
-
-#### Implementation of
-
-[`IBlobProvider`](Interface.IBlobProvider).[`uploadObject`](Interface.IBlobProvider#uploadobject)

package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md

@@ -1,197 +0,0 @@
----
-title: 'Class: VercelBlobProvider'
-generated: true
-editUrl: false
----
-# Class: VercelBlobProvider
-
-Defined in: [providers/VercelBlobProvider.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L44)
-
-Provides an implementation of [IBlobProvider](Interface.IBlobProvider) for Vercel Blob storage.
-
-## Implements
-
-- [`IBlobProvider`](Interface.IBlobProvider)
-
-## Constructors
-
-### Constructor
-
-```ts
-new VercelBlobProvider(httpService, options): VercelBlobProvider;
-```
-
-Defined in: [providers/VercelBlobProvider.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L62)
-
-Initializes a new instance of the VercelBlobProvider class.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `httpService` | `HttpService` | The HTTP service used to communicate with the Vercel Blob API. |
-| `options` | [`IVercelBlobProviderOptions`](Interface.IVercelBlobProviderOptions) | The provider configuration options. |
-
-#### Returns
-
-`VercelBlobProvider`
-
-## Accessors
-
-### defaultBucket
-
-#### Get Signature
-
-```ts
-get defaultBucket(): string | undefined;
-```
-
-Defined in: [providers/VercelBlobProvider.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L97)
-
-Gets the default bucket configured for the provider.
-
-##### Returns
-
-`string` \| `undefined`
-
-#### Implementation of
-
-[`IBlobProvider`](Interface.IBlobProvider).[`defaultBucket`](Interface.IBlobProvider#defaultbucket)
-
-***
-
-### providerId
-
-#### Get Signature
-
-```ts
-get providerId(): string;
-```
-
-Defined in: [providers/VercelBlobProvider.ts:90](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L90)
-
-Gets the identifier used to persist provider metadata.
-
-##### Returns
-
-`string`
-
-#### Implementation of
-
-[`IBlobProvider`](Interface.IBlobProvider).[`providerId`](Interface.IBlobProvider#providerid)
-
-## Methods
-
-### createSignedUrl()
-
-```ts
-createSignedUrl(request): Promise<string>;
-```
-
-Defined in: [providers/VercelBlobProvider.ts:192](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L192)
-
-Creates a signed URL (in this case a public URL) for the specified blob object.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`IBlobSignedUrlRequest`](Interface.IBlobSignedUrlRequest) | The request describing the object to link. |
-
-#### Returns
-
-`Promise`\<`string`\>
-
-The generated URL.
-
-#### Implementation of
-
-[`IBlobProvider`](Interface.IBlobProvider).[`createSignedUrl`](Interface.IBlobProvider#createsignedurl)
-
-***
-
-### deleteObject()
-
-```ts
-deleteObject(request): Promise<void>;
-```
-
-Defined in: [providers/VercelBlobProvider.ts:173](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L173)
-
-Deletes a blob object from Vercel storage.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`IBlobDeleteRequest`](Interface.IBlobDeleteRequest) | The delete request describing the object to remove. |
-
-#### Returns
-
-`Promise`\<`void`\>
-
-#### Implementation of
-
-[`IBlobProvider`](Interface.IBlobProvider).[`deleteObject`](Interface.IBlobProvider#deleteobject)
-
-***
-
-### downloadObject()
-
-```ts
-downloadObject<TData>(request): Promise<IBlobDownloadResult<TData>>;
-```
-
-Defined in: [providers/VercelBlobProvider.ts:146](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L146)
-
-Downloads a blob object from Vercel storage.
-
-#### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `TData` |
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`IBlobDownloadRequest`](Interface.IBlobDownloadRequest) | The download request describing the object to download. |
-
-#### Returns
-
-`Promise`\<[`IBlobDownloadResult`](Interface.IBlobDownloadResult)\<`TData`\>\>
-
-The download result including payload and metadata.
-
-#### Implementation of
-
-[`IBlobProvider`](Interface.IBlobProvider).[`downloadObject`](Interface.IBlobProvider#downloadobject)
-
-***
-
-### uploadObject()
-
-```ts
-uploadObject(request): Promise<IBlobUploadResult>;
-```
-
-Defined in: [providers/VercelBlobProvider.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L112)
-
-Uploads a blob object to Vercel storage.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`IBlobUploadRequest`](Interface.IBlobUploadRequest) | The upload request describing the object to upload. |
-
-#### Returns
-
-`Promise`\<[`IBlobUploadResult`](Interface.IBlobUploadResult)\>
-
-The resulting upload metadata.
-
-#### Implementation of
-
-[`IBlobProvider`](Interface.IBlobProvider).[`uploadObject`](Interface.IBlobProvider#uploadobject)

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

@@ -1,28 +0,0 @@
----
-title: 'Interface: IAwsS3BlobProviderRegistration'
-generated: true
-editUrl: false
----
-# Interface: IAwsS3BlobProviderRegistration
-
-Defined in: [BlobModule.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L51)
-
-## Properties
-
-### kind
-
-```ts
-kind: "aws-s3";
-```
-
-Defined in: [BlobModule.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L52)
-
-***
-
-### options?
-
-```ts
-optional options?: Partial<IAwsS3ProviderOptions>;
-```
-
-Defined in: [BlobModule.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L53)

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

@@ -1,68 +0,0 @@
----
-title: 'Interface: IAwsS3ProviderOptions'
-generated: true
-editUrl: false
----
-# Interface: IAwsS3ProviderOptions
-
-Defined in: [providers/AwsS3BlobProvider.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L21)
-
-## Properties
-
-### accessKeyId?
-
-```ts
-optional accessKeyId?: string;
-```
-
-Defined in: [providers/AwsS3BlobProvider.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L23)
-
-***
-
-### bucket
-
-```ts
-bucket: string;
-```
-
-Defined in: [providers/AwsS3BlobProvider.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L25)
-
-***
-
-### endpoint?
-
-```ts
-optional endpoint?: string;
-```
-
-Defined in: [providers/AwsS3BlobProvider.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L26)
-
-***
-
-### providerId?
-
-```ts
-optional providerId?: string;
-```
-
-Defined in: [providers/AwsS3BlobProvider.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L27)
-
-***
-
-### region
-
-```ts
-region: string;
-```
-
-Defined in: [providers/AwsS3BlobProvider.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L22)
-
-***
-
-### secretAccessKey?
-
-```ts
-optional secretAccessKey?: string;
-```
-
-Defined in: [providers/AwsS3BlobProvider.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L24)