@breadstone/archipel-mcp 0.0.14 → 0.0.16

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

@@ -0,0 +1,196 @@
+---
+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

@@ -0,0 +1,196 @@
+---
+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.BlobHealthIndicator.md

@@ -0,0 +1,79 @@
+---
+title: 'Class: BlobHealthIndicator'
+generated: true
+editUrl: false
+---
+# Class: BlobHealthIndicator
+
+Defined in: [terminus/BlobHealthIndicator.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/terminus/BlobHealthIndicator.ts#L17)
+
+Health indicator for blob service.
+
+## Implements
+
+- `IHealthIndicator`
+
+## Constructors
+
+### Constructor
+
+```ts
+new BlobHealthIndicator(configService, httpHealthIndicator): BlobHealthIndicator;
+```
+
+Defined in: [terminus/BlobHealthIndicator.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/terminus/BlobHealthIndicator.ts#L32)
+
+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:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/terminus/BlobHealthIndicator.ts#L41)
+
+Unique key identifying the indicator
+
+#### Implementation of
+
+```ts
+IHealthIndicator.key
+```
+
+## Methods
+
+### check()
+
+```ts
+check(): Promise<HealthIndicatorResult<"blob">>;
+```
+
+Defined in: [terminus/BlobHealthIndicator.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/terminus/BlobHealthIndicator.ts#L53)
+
+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

@@ -0,0 +1,49 @@
+---
+title: 'Class: BlobModule'
+generated: true
+editUrl: false
+---
+# Class: BlobModule
+
+Defined in: [BlobModule.ts:99](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L99)
+
+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:110](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L110)
+
+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

@@ -0,0 +1,75 @@
+---
+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`\>