@breadstone/archipel-mcp 0.0.13 → 0.0.14

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:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L58)
-
-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:95](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L95)
-
-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:88](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L88)
-
-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:215](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L215)
-
-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:191](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L191)
-
-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:161](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L161)
-
-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:110](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AwsS3BlobProvider.ts#L110)
-
-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:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L34)
-
-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:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L52)
-
-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:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L81)
-
-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:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.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/AzureBlobProvider.ts:191](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L191)
-
-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:172](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L172)
-
-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:144](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L144)
-
-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:96](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L96)
-
-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.BlobHealthIndicator.md

@@ -1,79 +0,0 @@
----
-title: 'Class: BlobHealthIndicator'
-generated: true
-editUrl: false
----
-# Class: BlobHealthIndicator
-
-Defined in: [terminus/BlobHealthIndicator.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/terminus/BlobHealthIndicator.ts#L16)
-
-Health indicator for blob service.
-
-## Implements
-
-- `IHealthIndicator`
-
-## Constructors
-
-### Constructor
-
-```ts
-new BlobHealthIndicator(configService, httpHealthIndicator): BlobHealthIndicator;
-```
-
-Defined in: [terminus/BlobHealthIndicator.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/terminus/BlobHealthIndicator.ts#L31)
-
-Constructs a new instance of the `BlobHealthIndicator` class.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `configService` | `ConfigService` |
-| `httpHealthIndicator` | `HttpHealthIndicator` |
-
-#### Returns
-
-`BlobHealthIndicator`
-
-## Properties
-
-### key
-
-```ts
-readonly key: "blob" = 'blob';
-```
-
-Defined in: [terminus/BlobHealthIndicator.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/terminus/BlobHealthIndicator.ts#L40)
-
-Unique key identifying the indicator
-
-#### Implementation of
-
-```ts
-IHealthIndicator.key
-```
-
-## Methods
-
-### check()
-
-```ts
-check(): Promise<HealthIndicatorResult<"blob">>;
-```
-
-Defined in: [terminus/BlobHealthIndicator.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/terminus/BlobHealthIndicator.ts#L52)
-
-Checks if the blob configuration is valid.
-
-#### Returns
-
-`Promise`\<`HealthIndicatorResult`\<`"blob"`\>\>
-
-The health indicator result.
-
-#### Implementation of
-
-```ts
-IHealthIndicator.check
-```

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

@@ -1,49 +0,0 @@
----
-title: 'Class: BlobModule'
-generated: true
-editUrl: false
----
-# Class: BlobModule
-
-Defined in: [BlobModule.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L98)
-
-NestJS module responsible for providing blob storage services.
-
-## Constructors
-
-### Constructor
-
-```ts
-new BlobModule(): BlobModule;
-```
-
-#### Returns
-
-`BlobModule`
-
-## Methods
-
-### forRoot()
-
-```ts
-static forRoot(options?): DynamicModule;
-```
-
-Defined in: [BlobModule.ts:109](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L109)
-
-Configures the module with the specified options.
-When `objectPersistence` / `variantPersistence` are provided the
-corresponding adapters are registered as ports. Otherwise the
-service works without metadata tracking.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `options?` | [`IBlobModuleOptions`](Interface.IBlobModuleOptions) | The module configuration options. |
-
-#### Returns
-
-`DynamicModule`
-
-Dynamic module definition

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

@@ -1,75 +0,0 @@
----
-title: 'Abstract Class: BlobObjectPersistencePort'
-generated: true
-editUrl: false
----
-# Abstract Class: BlobObjectPersistencePort
-
-Defined in: [contracts/BlobObjectPersistencePort.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/contracts/BlobObjectPersistencePort.ts#L14)
-
-Abstract port for persisting blob object metadata.
-Consuming projects must provide a concrete implementation (e.g. backed by Prisma, Mongo, etc.)
-and register it via `BlobModule.forRoot({ objectPersistence: MyAdapter })`.
-
-## Constructors
-
-### Constructor
-
-```ts
-new BlobObjectPersistencePort(): BlobObjectPersistencePort;
-```
-
-#### Returns
-
-`BlobObjectPersistencePort`
-
-## Methods
-
-### createFromMetadata()
-
-```ts
-abstract createFromMetadata(metadata): Promise<void>;
-```
-
-Defined in: [contracts/BlobObjectPersistencePort.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/contracts/BlobObjectPersistencePort.ts#L23)
-
-Persists metadata for a newly uploaded blob object.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `metadata` | [`IBlobObjectMetadata`](Interface.IBlobObjectMetadata) | The object metadata returned by the blob provider after upload. |
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### markAsDeleted()
-
-```ts
-abstract markAsDeleted(
-   provider, 
-   bucket, 
-   key, 
-versionId?): Promise<void>;
-```
-
-Defined in: [contracts/BlobObjectPersistencePort.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/contracts/BlobObjectPersistencePort.ts#L34)
-
-Marks an existing blob object as deleted.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `provider` | `string` | The storage provider identifier. |
-| `bucket` | `string` | The bucket name. |
-| `key` | `string` | The object key. |
-| `versionId?` | `string` | Optional version identifier. |
-
-#### Returns
-
-`Promise`\<`void`\>