@breadstone/archipel-mcp 0.0.13 → 0.0.15

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

@@ -1,248 +0,0 @@
----
-title: 'Class: BlobService'
-generated: true
-editUrl: false
----
-# Class: BlobService
-
-Defined in: [services/BlobService.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/services/BlobService.ts#L26)
-
-Provides a generic abstraction for blob storage operations independent of the underlying provider.
-
-## Constructors
-
-### Constructor
-
-```ts
-new BlobService(
-   blobProvider, 
-   objectPersistence, 
-   variantPersistence): BlobService;
-```
-
-Defined in: [services/BlobService.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/services/BlobService.ts#L45)
-
-Initializes a new instance of the BlobService class.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `blobProvider` | [`IBlobProvider`](Interface.IBlobProvider) | The concrete blob provider implementation. |
-| `objectPersistence` | \| [`BlobObjectPersistencePort`](Class.BlobObjectPersistencePort) \| `null` | Optional port persisting original blob metadata. |
-| `variantPersistence` | \| [`BlobVariantPersistencePort`](Class.BlobVariantPersistencePort) \| `null` | Optional port persisting derived blob metadata. |
-
-#### Returns
-
-`BlobService`
-
-## Methods
-
-### createSignedUrl()
-
-```ts
-createSignedUrl(request): Promise<string>;
-```
-
-Defined in: [services/BlobService.ts:130](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/services/BlobService.ts#L130)
-
-Generates a signed URL for the specified object.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`IBlobSignedUrlRequest`](Interface.IBlobSignedUrlRequest) | The request describing the object. |
-
-#### Returns
-
-`Promise`\<`string`\>
-
-A signed URL that can be used to access the object.
-
-***
-
-### deleteFile()
-
-```ts
-deleteFile(key): Promise<void>;
-```
-
-Defined in: [services/BlobService.ts:183](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/services/BlobService.ts#L183)
-
-Deletes a file by key.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The object key. |
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### deleteObject()
-
-```ts
-deleteObject(request): Promise<void>;
-```
-
-Defined in: [services/BlobService.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/services/BlobService.ts#L112)
-
-Deletes an object from the configured blob provider.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`IBlobDeleteRequest`](Interface.IBlobDeleteRequest) | The delete request describing the object. |
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### downloadFile()
-
-```ts
-downloadFile<TData>(key, responseType?): Promise<IBlobDownloadResult<TData>>;
-```
-
-Defined in: [services/BlobService.ts:165](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/services/BlobService.ts#L165)
-
-Downloads a file by key.
-
-#### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `TData` |
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The object key. |
-| `responseType?` | [`BlobDownloadResponseType`](TypeAlias.BlobDownloadResponseType) | The expected response type. |
-
-#### Returns
-
-`Promise`\<[`IBlobDownloadResult`](Interface.IBlobDownloadResult)\<`TData`\>\>
-
-The downloaded data and related metadata.
-
-***
-
-### downloadObject()
-
-```ts
-downloadObject<TData>(request): Promise<IBlobDownloadResult<TData>>;
-```
-
-Defined in: [services/BlobService.ts:102](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/services/BlobService.ts#L102)
-
-Downloads an object from the configured blob provider.
-
-#### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `TData` |
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`IBlobDownloadRequest`](Interface.IBlobDownloadRequest) | The download request describing the object. |
-
-#### Returns
-
-`Promise`\<[`IBlobDownloadResult`](Interface.IBlobDownloadResult)\<`TData`\>\>
-
-The downloaded data and related metadata.
-
-***
-
-### uploadFile()
-
-```ts
-uploadFile(
-   key, 
-   buffer, 
-contentType?): Promise<IBlobUploadResult>;
-```
-
-Defined in: [services/BlobService.ts:147](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/services/BlobService.ts#L147)
-
-Uploads a buffer using the provided key.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The object key. |
-| `buffer` | `Buffer` | The data to upload. |
-| `contentType?` | `string` | The content type of the upload. |
-
-#### Returns
-
-`Promise`\<[`IBlobUploadResult`](Interface.IBlobUploadResult)\>
-
-The provider specific upload result.
-
-***
-
-### uploadObject()
-
-```ts
-uploadObject(request): Promise<IBlobUploadResult>;
-```
-
-Defined in: [services/BlobService.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/services/BlobService.ts#L66)
-
-Uploads an object to the configured blob provider.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`IBlobUploadRequest`](Interface.IBlobUploadRequest) | The upload request describing the object. |
-
-#### Returns
-
-`Promise`\<[`IBlobUploadResult`](Interface.IBlobUploadResult)\>
-
-The provider specific upload result.
-
-***
-
-### uploadVariant()
-
-```ts
-uploadVariant(
-   originalId, 
-   label, 
-request): Promise<IBlobUploadResult>;
-```
-
-Defined in: [services/BlobService.ts:83](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/services/BlobService.ts#L83)
-
-Uploads a derived variant for an existing blob object.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `originalId` | `string` | The identifier of the original blob object. |
-| `label` | `string` | The variant label identifying the derivative. |
-| `request` | [`IBlobUploadRequest`](Interface.IBlobUploadRequest) | The upload request describing the variant blob. |
-
-#### Returns
-
-`Promise`\<[`IBlobUploadResult`](Interface.IBlobUploadResult)\>
-
-The provider specific upload result.

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

@@ -1,51 +0,0 @@
----
-title: 'Abstract Class: BlobVariantPersistencePort'
-generated: true
-editUrl: false
----
-# Abstract Class: BlobVariantPersistencePort
-
-Defined in: [contracts/BlobVariantPersistencePort.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/contracts/BlobVariantPersistencePort.ts#L14)
-
-Abstract port for persisting blob variant metadata.
-Consuming projects must provide a concrete implementation and register it
-via `BlobModule.forRoot({ variantPersistence: MyAdapter })`.
-
-## Constructors
-
-### Constructor
-
-```ts
-new BlobVariantPersistencePort(): BlobVariantPersistencePort;
-```
-
-#### Returns
-
-`BlobVariantPersistencePort`
-
-## Methods
-
-### createFromMetadata()
-
-```ts
-abstract createFromMetadata(
-   originalId, 
-   label, 
-metadata): Promise<void>;
-```
-
-Defined in: [contracts/BlobVariantPersistencePort.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/contracts/BlobVariantPersistencePort.ts#L25)
-
-Persists metadata for a newly created blob variant.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `originalId` | `string` | The identifier of the original blob object. |
-| `label` | `string` | A label describing the variant (e.g. 'thumbnail', 'preview'). |
-| `metadata` | [`IBlobObjectMetadata`](Interface.IBlobObjectMetadata) | The object metadata returned by the blob provider after upload. |
-
-#### Returns
-
-`Promise`\<`void`\>

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:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L31)
-
-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:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L49)
-
-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:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L81)
-
-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:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L74)
-
-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:173](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L173)
-
-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:155](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L155)
-
-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:129](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L129)
-
-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:96](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L96)
-
-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:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L53)
-
-## Properties
-
-### kind
-
-```ts
-kind: "aws-s3";
-```
-
-Defined in: [BlobModule.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L54)
-
-***
-
-### options?
-
-```ts
-optional options?: Partial<IAwsS3ProviderOptions>;
-```
-
-Defined in: [BlobModule.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L55)

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
-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
-secretAccessKey: string;
-```
-
-Defined in: [providers/AwsS3BlobProvider.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L24)

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

@@ -1,38 +0,0 @@
----
-title: 'Interface: IAzureBlobProviderOptions'
-generated: true
-editUrl: false
----
-# Interface: IAzureBlobProviderOptions
-
-Defined in: [providers/AzureBlobProvider.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L20)
-
-## Properties
-
-### connectionString
-
-```ts
-connectionString: string;
-```
-
-Defined in: [providers/AzureBlobProvider.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L21)
-
-***
-
-### containerName
-
-```ts
-containerName: string;
-```
-
-Defined in: [providers/AzureBlobProvider.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L22)
-
-***
-
-### providerId?
-
-```ts
-optional providerId?: string;
-```
-
-Defined in: [providers/AzureBlobProvider.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L23)

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

@@ -1,28 +0,0 @@
----
-title: 'Interface: IAzureBlobProviderRegistration'
-generated: true
-editUrl: false
----
-# Interface: IAzureBlobProviderRegistration
-
-Defined in: [BlobModule.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L48)
-
-## Properties
-
-### kind
-
-```ts
-kind: "azure";
-```
-
-Defined in: [BlobModule.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L49)
-
-***
-
-### options?
-
-```ts
-optional options?: Partial<IAzureBlobProviderOptions>;
-```
-
-Defined in: [BlobModule.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L50)

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

@@ -1,38 +0,0 @@
----
-title: 'Interface: IBlobDeleteRequest'
-generated: true
-editUrl: false
----
-# Interface: IBlobDeleteRequest
-
-Defined in: [interfaces/IBlobProvider.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L81)
-
-## Properties
-
-### bucket?
-
-```ts
-optional bucket?: string;
-```
-
-Defined in: [interfaces/IBlobProvider.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L84)
-
-***
-
-### key
-
-```ts
-key: string;
-```
-
-Defined in: [interfaces/IBlobProvider.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L82)
-
-***
-
-### versionId?
-
-```ts
-optional versionId?: string;
-```
-
-Defined in: [interfaces/IBlobProvider.ts:83](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L83)