npm - @breadstone/archipel-mcp - Versions diffs - 0.0.2 → 0.0.4 - Mend

@breadstone/archipel-mcp 0.0.2 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (548) hide show

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

@@ -3,6 +3,7 @@ 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)
@@ -15,8 +16,8 @@ Provides a generic abstraction for blob storage operations independent of the un
 ```ts
 new BlobService(
-   blobProvider,
-   objectPersistence,
+   blobProvider,
+   objectPersistence,
    variantPersistence): BlobService;
 ```
@@ -26,11 +27,11 @@ 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. |
+| 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
@@ -50,8 +51,8 @@ Generates a signed URL for the specified object.
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
+| Parameter | Type                                                       | Description                        |
+| --------- | ---------------------------------------------------------- | ---------------------------------- |
 | `request` | [`IBlobSignedUrlRequest`](Interface.IBlobSignedUrlRequest) | The request describing the object. |
 #### Returns
@@ -60,7 +61,7 @@ Generates a signed URL for the specified object.
 A signed URL that can be used to access the object.
-***
+---
 ### deleteFile()
@@ -74,15 +75,15 @@ Deletes a file by key.
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The object key. |
+| Parameter | Type     | Description     |
+| --------- | -------- | --------------- |
+| `key`     | `string` | The object key. |
 #### Returns
 `Promise`\<`void`\>
-***
+---
 ### deleteObject()
@@ -96,15 +97,15 @@ Deletes an object from the configured blob provider.
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
+| Parameter | Type                                                 | Description                               |
+| --------- | ---------------------------------------------------- | ----------------------------------------- |
 | `request` | [`IBlobDeleteRequest`](Interface.IBlobDeleteRequest) | The delete request describing the object. |
 #### Returns
 `Promise`\<`void`\>
-***
+---
 ### downloadFile()
@@ -119,14 +120,14 @@ Downloads a file by key.
 #### Type Parameters
 | Type Parameter |
-| ------ |
-| `TData` |
+| -------------- |
+| `TData`        |
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The object key. |
+| Parameter       | Type                                                             | Description                 |
+| --------------- | ---------------------------------------------------------------- | --------------------------- |
+| `key`           | `string`                                                         | The object key.             |
 | `responseType?` | [`BlobDownloadResponseType`](TypeAlias.BlobDownloadResponseType) | The expected response type. |
 #### Returns
@@ -135,7 +136,7 @@ Downloads a file by key.
 The downloaded data and related metadata.
-***
+---
 ### downloadObject()
@@ -150,13 +151,13 @@ Downloads an object from the configured blob provider.
 #### Type Parameters
 | Type Parameter |
-| ------ |
-| `TData` |
+| -------------- |
+| `TData`        |
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
+| Parameter | Type                                                     | Description                                 |
+| --------- | -------------------------------------------------------- | ------------------------------------------- |
 | `request` | [`IBlobDownloadRequest`](Interface.IBlobDownloadRequest) | The download request describing the object. |
 #### Returns
@@ -165,14 +166,14 @@ Downloads an object from the configured blob provider.
 The downloaded data and related metadata.
-***
+---
 ### uploadFile()
 ```ts
 uploadFile(
-   key,
-   buffer,
+   key,
+   buffer,
 contentType?): Promise<IBlobUploadResult>;
 ```
@@ -182,10 +183,10 @@ Uploads a buffer using the provided key.
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The object key. |
-| `buffer` | `Buffer` | The data to upload. |
+| Parameter      | Type     | Description                     |
+| -------------- | -------- | ------------------------------- |
+| `key`          | `string` | The object key.                 |
+| `buffer`       | `Buffer` | The data to upload.             |
 | `contentType?` | `string` | The content type of the upload. |
 #### Returns
@@ -194,7 +195,7 @@ Uploads a buffer using the provided key.
 The provider specific upload result.
-***
+---
 ### uploadObject()
@@ -208,8 +209,8 @@ Uploads an object to the configured blob provider.
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
+| Parameter | Type                                                 | Description                               |
+| --------- | ---------------------------------------------------- | ----------------------------------------- |
 | `request` | [`IBlobUploadRequest`](Interface.IBlobUploadRequest) | The upload request describing the object. |
 #### Returns
@@ -218,14 +219,14 @@ Uploads an object to the configured blob provider.
 The provider specific upload result.
-***
+---
 ### uploadVariant()
 ```ts
 uploadVariant(
-   originalId,
-   label,
+   originalId,
+   label,
 request): Promise<IBlobUploadResult>;
 ```
@@ -235,11 +236,11 @@ 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. |
+| 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

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

@@ -3,6 +3,7 @@ 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)
@@ -29,8 +30,8 @@ new BlobVariantPersistencePort(): BlobVariantPersistencePort;
 ```ts
 abstract createFromMetadata(
-   originalId,
-   label,
+   originalId,
+   label,
 metadata): Promise<void>;
 ```
@@ -40,11 +41,11 @@ 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. |
+| 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

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

@@ -3,6 +3,7 @@ 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)
@@ -27,10 +28,10 @@ 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. |
+| 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
@@ -58,7 +59,7 @@ Gets the default bucket configured for the provider.
 [`IBlobProvider`](Interface.IBlobProvider).[`defaultBucket`](Interface.IBlobProvider#defaultbucket)
-***
+---
 ### providerId
@@ -94,8 +95,8 @@ Creates a signed URL (in this case a public URL) for the specified blob object.
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
+| Parameter | Type                                                       | Description                                |
+| --------- | ---------------------------------------------------------- | ------------------------------------------ |
 | `request` | [`IBlobSignedUrlRequest`](Interface.IBlobSignedUrlRequest) | The request describing the object to link. |
 #### Returns
@@ -108,7 +109,7 @@ The generated URL.
 [`IBlobProvider`](Interface.IBlobProvider).[`createSignedUrl`](Interface.IBlobProvider#createsignedurl)
-***
+---
 ### deleteObject()
@@ -122,8 +123,8 @@ Deletes a blob object from Vercel storage.
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
+| Parameter | Type                                                 | Description                                         |
+| --------- | ---------------------------------------------------- | --------------------------------------------------- |
 | `request` | [`IBlobDeleteRequest`](Interface.IBlobDeleteRequest) | The delete request describing the object to remove. |
 #### Returns
@@ -134,7 +135,7 @@ Deletes a blob object from Vercel storage.
 [`IBlobProvider`](Interface.IBlobProvider).[`deleteObject`](Interface.IBlobProvider#deleteobject)
-***
+---
 ### downloadObject()
@@ -149,13 +150,13 @@ Downloads a blob object from Vercel storage.
 #### Type Parameters
 | Type Parameter |
-| ------ |
-| `TData` |
+| -------------- |
+| `TData`        |
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
+| Parameter | Type                                                     | Description                                             |
+| --------- | -------------------------------------------------------- | ------------------------------------------------------- |
 | `request` | [`IBlobDownloadRequest`](Interface.IBlobDownloadRequest) | The download request describing the object to download. |
 #### Returns
@@ -168,7 +169,7 @@ The download result including payload and metadata.
 [`IBlobProvider`](Interface.IBlobProvider).[`downloadObject`](Interface.IBlobProvider#downloadobject)
-***
+---
 ### uploadObject()
@@ -182,8 +183,8 @@ Uploads a blob object to Vercel storage.
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
+| Parameter | Type                                                 | Description                                         |
+| --------- | ---------------------------------------------------- | --------------------------------------------------- |
 | `request` | [`IBlobUploadRequest`](Interface.IBlobUploadRequest) | The upload request describing the object to upload. |
 #### Returns

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

@@ -3,21 +3,22 @@ title: 'Interface: IAwsS3BlobProviderRegistration'
 generated: true
 editUrl: false
 ---
 # Interface: IAwsS3BlobProviderRegistration
-Defined in: [BlobModule.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L39)
+Defined in: [BlobModule.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L44)
 ## Properties
 ### kind
 ```ts
-kind: "aws-s3";
+kind: 'aws-s3';
 ```
-Defined in: [BlobModule.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L40)
+Defined in: [BlobModule.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L45)
-***
+---
 ### options?
@@ -25,4 +26,4 @@ Defined in: [BlobModule.ts:40](https://github.com/RueDeRennes/archipel/blob/main
 optional options?: Partial<IAwsS3ProviderOptions>;
 ```
-Defined in: [BlobModule.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L41)
+Defined in: [BlobModule.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L46)

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

@@ -3,6 +3,7 @@ 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)
@@ -17,7 +18,7 @@ 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
@@ -27,7 +28,7 @@ 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?
@@ -37,7 +38,7 @@ 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?
@@ -47,7 +48,7 @@ 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
@@ -57,7 +58,7 @@ 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

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

@@ -3,6 +3,7 @@ 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)
@@ -17,7 +18,7 @@ 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
@@ -27,7 +28,7 @@ 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?

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

@@ -3,21 +3,22 @@ title: 'Interface: IAzureBlobProviderRegistration'
 generated: true
 editUrl: false
 ---
 # Interface: IAzureBlobProviderRegistration
-Defined in: [BlobModule.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L34)
+Defined in: [BlobModule.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L39)
 ## Properties
 ### kind
 ```ts
-kind: "azure";
+kind: 'azure';
 ```
-Defined in: [BlobModule.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L35)
+Defined in: [BlobModule.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L40)
-***
+---
 ### options?
@@ -25,4 +26,4 @@ Defined in: [BlobModule.ts:35](https://github.com/RueDeRennes/archipel/blob/main
 optional options?: Partial<IAzureBlobProviderOptions>;
 ```
-Defined in: [BlobModule.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L36)
+Defined in: [BlobModule.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L41)

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

@@ -3,6 +3,7 @@ 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)
@@ -17,7 +18,7 @@ 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
@@ -27,7 +28,7 @@ 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?

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

@@ -3,6 +3,7 @@ title: 'Interface: IBlobDownloadRequest'
 generated: true
 editUrl: false
 ---
 # Interface: IBlobDownloadRequest
 Defined in: [interfaces/IBlobProvider.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L66)
@@ -17,7 +18,7 @@ optional bucket?: string;
 Defined in: [interfaces/IBlobProvider.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L70)
-***
+---
 ### key
@@ -27,7 +28,7 @@ key: string;
 Defined in: [interfaces/IBlobProvider.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L67)
-***
+---
 ### responseType?
@@ -37,7 +38,7 @@ optional responseType?: BlobDownloadResponseType;
 Defined in: [interfaces/IBlobProvider.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L69)
-***
+---
 ### versionId?

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

@@ -3,6 +3,7 @@ title: 'Interface: IBlobDownloadResult\<TData\>'
 generated: true
 editUrl: false
 ---
 # Interface: IBlobDownloadResult\<TData\>
 Defined in: [interfaces/IBlobProvider.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L73)
@@ -10,8 +11,8 @@ Defined in: [interfaces/IBlobProvider.ts:73](https://github.com/RueDeRennes/arch
 ## Type Parameters
 | Type Parameter |
-| ------ |
-| `TData` |
+| -------------- |
+| `TData`        |
 ## Properties
@@ -23,7 +24,7 @@ optional contentLength?: number;
 Defined in: [interfaces/IBlobProvider.ts:76](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L76)
-***
+---
 ### contentType?
@@ -33,7 +34,7 @@ optional contentType?: string;
 Defined in: [interfaces/IBlobProvider.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L75)
-***
+---
 ### data
@@ -43,7 +44,7 @@ data: TData;
 Defined in: [interfaces/IBlobProvider.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L74)
-***
+---
 ### metadata?
@@ -53,7 +54,7 @@ optional metadata?: Record<string, string>;
 Defined in: [interfaces/IBlobProvider.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L77)
-***
+---
 ### rawResponse?