@breadstone/archipel-mcp 0.0.40 → 0.0.42

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)

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

@@ -1,48 +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
-
-### accountName?
-
-```ts
-optional accountName?: string;
-```
-
-Defined in: [providers/AzureBlobProvider.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L22)
-
-***
-
-### connectionString?
-
-```ts
-optional 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:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L23)
-
-***
-
-### providerId?
-
-```ts
-optional providerId?: string;
-```
-
-Defined in: [providers/AzureBlobProvider.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L24)

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:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L46)
-
-## Properties
-
-### kind
-
-```ts
-kind: "azure";
-```
-
-Defined in: [BlobModule.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L47)
-
-***
-
-### options?
-
-```ts
-optional options?: Partial<IAzureBlobProviderOptions>;
-```
-
-Defined in: [BlobModule.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L48)

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

@@ -1,114 +0,0 @@
----
-title: 'Interface: IBlobProvider'
-generated: true
-editUrl: false
----
-# Interface: IBlobProvider
-
-Defined in: [interfaces/IBlobProvider.ts:94](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L94)
-
-## Properties
-
-### defaultBucket?
-
-```ts
-readonly optional defaultBucket?: string;
-```
-
-Defined in: [interfaces/IBlobProvider.ts:96](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L96)
-
-***
-
-### providerId
-
-```ts
-readonly providerId: string;
-```
-
-Defined in: [interfaces/IBlobProvider.ts:95](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L95)
-
-## Methods
-
-### createSignedUrl()?
-
-```ts
-optional createSignedUrl(request): Promise<string>;
-```
-
-Defined in: [interfaces/IBlobProvider.ts:100](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L100)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `request` | [`IBlobSignedUrlRequest`](Interface.IBlobSignedUrlRequest) |
-
-#### Returns
-
-`Promise`\<`string`\>
-
-***
-
-### deleteObject()
-
-```ts
-deleteObject(request): Promise<void>;
-```
-
-Defined in: [interfaces/IBlobProvider.ts:99](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L99)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `request` | [`IBlobDeleteRequest`](Interface.IBlobDeleteRequest) |
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### downloadObject()
-
-```ts
-downloadObject<TData>(request): Promise<IBlobDownloadResult<TData>>;
-```
-
-Defined in: [interfaces/IBlobProvider.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L98)
-
-#### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `TData` |
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `request` | [`IBlobDownloadRequest`](Interface.IBlobDownloadRequest) |
-
-#### Returns
-
-`Promise`\<[`IBlobDownloadResult`](Interface.IBlobDownloadResult)\<`TData`\>\>
-
-***
-
-### uploadObject()
-
-```ts
-uploadObject(request): Promise<IBlobUploadResult>;
-```
-
-Defined in: [interfaces/IBlobProvider.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L97)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `request` | [`IBlobUploadRequest`](Interface.IBlobUploadRequest) |
-
-#### Returns
-
-`Promise`\<[`IBlobUploadResult`](Interface.IBlobUploadResult)\>

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

@@ -1,28 +0,0 @@
----
-title: 'Interface: ICustomBlobProviderRegistration'
-generated: true
-editUrl: false
----
-# Interface: ICustomBlobProviderRegistration
-
-Defined in: [BlobModule.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L56)
-
-## Properties
-
-### kind
-
-```ts
-kind: "custom";
-```
-
-Defined in: [BlobModule.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L57)
-
-***
-
-### useClass
-
-```ts
-useClass: Type<IBlobProvider>;
-```
-
-Defined in: [BlobModule.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L58)

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

@@ -1,80 +0,0 @@
----
-title: 'Interface: IVercelBlobProviderOptions'
-generated: true
-editUrl: false
----
-# Interface: IVercelBlobProviderOptions
-
-Defined in: [providers/VercelBlobProvider.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L25)
-
-## Properties
-
-### accessToken
-
-```ts
-accessToken: string;
-```
-
-Defined in: [providers/VercelBlobProvider.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L27)
-
-***
-
-### apiUrl
-
-```ts
-apiUrl: string;
-```
-
-Defined in: [providers/VercelBlobProvider.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L26)
-
-***
-
-### bucket?
-
-```ts
-optional bucket?: string;
-```
-
-Defined in: [providers/VercelBlobProvider.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L28)
-
-***
-
-### providerId?
-
-```ts
-optional providerId?: string;
-```
-
-Defined in: [providers/VercelBlobProvider.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L31)
-
-***
-
-### publicUrl?
-
-```ts
-optional publicUrl?: string;
-```
-
-Defined in: [providers/VercelBlobProvider.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L30)
-
-***
-
-### region?
-
-```ts
-optional region?: string;
-```
-
-Defined in: [providers/VercelBlobProvider.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L29)
-
-***
-
-### timeoutMs?
-
-```ts
-optional timeoutMs?: number;
-```
-
-Defined in: [providers/VercelBlobProvider.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L33)
-
-HTTP request timeout in milliseconds. Defaults to 30000.

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

@@ -1,28 +0,0 @@
----
-title: 'Interface: IVercelBlobProviderRegistration'
-generated: true
-editUrl: false
----
-# Interface: IVercelBlobProviderRegistration
-
-Defined in: [BlobModule.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L41)
-
-## Properties
-
-### kind
-
-```ts
-kind: "vercel";
-```
-
-Defined in: [BlobModule.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L42)
-
-***
-
-### options?
-
-```ts
-optional options?: Partial<IVercelBlobProviderOptions>;
-```
-
-Defined in: [BlobModule.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L43)

package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md

@@ -1,16 +0,0 @@
----
-title: 'Type Alias: IBlobProviderRegistration'
-generated: true
-editUrl: false
----
-# Type Alias: IBlobProviderRegistration
-
-```ts
-type IBlobProviderRegistration = 
-  | IVercelBlobProviderRegistration
-  | IAzureBlobProviderRegistration
-  | IAwsS3BlobProviderRegistration
-  | ICustomBlobProviderRegistration;
-```
-
-Defined in: [BlobModule.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L61)

package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md

@@ -1,12 +0,0 @@
----
-title: 'Variable: AWS\_S3\_PROVIDER\_OPTIONS'
-generated: true
-editUrl: false
----
-# Variable: AWS\_S3\_PROVIDER\_OPTIONS
-
-```ts
-const AWS_S3_PROVIDER_OPTIONS: typeof AWS_S3_PROVIDER_OPTIONS;
-```
-
-Defined in: [tokens/BlobStorageTokens.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens/BlobStorageTokens.ts#L6)

package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md

@@ -1,12 +0,0 @@
----
-title: 'Variable: AZURE\_BLOB\_PROVIDER\_OPTIONS'
-generated: true
-editUrl: false
----
-# Variable: AZURE\_BLOB\_PROVIDER\_OPTIONS
-
-```ts
-const AZURE_BLOB_PROVIDER_OPTIONS: typeof AZURE_BLOB_PROVIDER_OPTIONS;
-```
-
-Defined in: [tokens/BlobStorageTokens.ts:5](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens/BlobStorageTokens.ts#L5)

package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md

@@ -1,26 +0,0 @@
----
-title: 'Variable: BlobProviderKinds'
-generated: true
-editUrl: false
----
-# Variable: BlobProviderKinds
-
-```ts
-const BlobProviderKinds: {
-  AwsS3: "aws-s3";
-  Azure: "azure";
-  Custom: "custom";
-  Vercel: "vercel";
-};
-```
-
-Defined in: [interfaces/IBlobProvider.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L9)
-
-## Type Declaration
-
-| Name | Type | Default value | Defined in |
-| ------ | ------ | ------ | ------ |
-| <a id="property-awss3"></a> `AwsS3` | `"aws-s3"` | `'aws-s3'` | [interfaces/IBlobProvider.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L13) |
-| <a id="property-azure"></a> `Azure` | `"azure"` | `'azure'` | [interfaces/IBlobProvider.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L12) |
-| <a id="property-custom"></a> `Custom` | `"custom"` | `'custom'` | [interfaces/IBlobProvider.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L10) |
-| <a id="property-vercel"></a> `Vercel` | `"vercel"` | `'vercel'` | [interfaces/IBlobProvider.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L11) |