@breadstone/archipel-mcp 0.0.1

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

@@ -0,0 +1,73 @@
+---
+title: 'Interface: IVercelBlobProviderOptions'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-blob-storage**](../)
+
+---
+
+# Interface: IVercelBlobProviderOptions
+
+Defined in: [providers/VercelBlobProvider.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L14)
+
+## Properties
+
+### accessToken
+
+```ts
+accessToken: string;
+```
+
+Defined in: [providers/VercelBlobProvider.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L16)
+
+---
+
+### apiUrl
+
+```ts
+apiUrl: string;
+```
+
+Defined in: [providers/VercelBlobProvider.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L15)
+
+---
+
+### bucket?
+
+```ts
+optional bucket?: string;
+```
+
+Defined in: [providers/VercelBlobProvider.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L17)
+
+---
+
+### providerId?
+
+```ts
+optional providerId?: string;
+```
+
+Defined in: [providers/VercelBlobProvider.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L20)
+
+---
+
+### publicUrl?
+
+```ts
+optional publicUrl?: string;
+```
+
+Defined in: [providers/VercelBlobProvider.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L19)
+
+---
+
+### region?
+
+```ts
+optional region?: string;
+```
+
+Defined in: [providers/VercelBlobProvider.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L18)

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

@@ -0,0 +1,33 @@
+---
+title: 'Interface: IVercelBlobProviderRegistration'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-blob-storage**](../)
+
+---
+
+# Interface: IVercelBlobProviderRegistration
+
+Defined in: [BlobModule.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L27)
+
+## Properties
+
+### kind
+
+```ts
+kind: 'vercel';
+```
+
+Defined in: [BlobModule.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L28)
+
+---
+
+### options?
+
+```ts
+optional options?: Partial<IVercelBlobProviderOptions>;
+```
+
+Defined in: [BlobModule.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L29)

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

@@ -0,0 +1,17 @@
+---
+title: 'Type Alias: BlobDownloadResponseType'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-blob-storage**](../)
+
+---
+
+# Type Alias: BlobDownloadResponseType
+
+```ts
+type BlobDownloadResponseType = (typeof BlobDownloadResponseTypes)[keyof typeof BlobDownloadResponseTypes];
+```
+
+Defined in: [interfaces/IBlobProvider.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L23)

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

@@ -0,0 +1,17 @@
+---
+title: 'Type Alias: BlobUploadBody'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-blob-storage**](../)
+
+---
+
+# Type Alias: BlobUploadBody
+
+```ts
+type BlobUploadBody = Buffer | Readable;
+```
+
+Defined in: [interfaces/IBlobProvider.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L25)

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

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

package/data/packages/platform-blob-storage/api/index.md

@@ -0,0 +1,111 @@
+---
+title: '@breadstone/archipel-platform-blob-storage'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-blob-storage**](../)
+
+---
+
+# @breadstone/archipel-platform-blob-storage
+
+## Classes
+
+| Class                                                          | Description                                                                                                                                                                                                                   |
+| -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [BlobHealthIndicator](Class.BlobHealthIndicator)               | Health indicator for blob service.                                                                                                                                                                                            |
+| [BlobModule](Class.BlobModule)                                 | NestJS module responsible for providing blob storage services.                                                                                                                                                                |
+| [BlobObjectPersistencePort](Class.BlobObjectPersistencePort)   | 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 })`. |
+| [BlobService](Class.BlobService)                               | Provides a generic abstraction for blob storage operations independent of the underlying provider.                                                                                                                            |
+| [BlobVariantPersistencePort](Class.BlobVariantPersistencePort) | Abstract port for persisting blob variant metadata. Consuming projects must provide a concrete implementation and register it via `BlobModule.forRoot({ variantPersistence: MyAdapter })`.                                    |
+| [VercelBlobProvider](Class.VercelBlobProvider)                 | Provides an implementation of [IBlobProvider](Interface.IBlobProvider) for Vercel Blob storage.                                                                                                                               |
+
+## Interfaces
+
+| Interface                                                                    | Description |
+| ---------------------------------------------------------------------------- | ----------- |
+| [IBlobDeleteRequest](Interface.IBlobDeleteRequest)                           | -           |
+| [IBlobDownloadRequest](Interface.IBlobDownloadRequest)                       | -           |
+| [IBlobDownloadResult](Interface.IBlobDownloadResult)                         | -           |
+| [IBlobModuleOptions](Interface.IBlobModuleOptions)                           | -           |
+| [IBlobObjectMetadata](Interface.IBlobObjectMetadata)                         | -           |
+| [IBlobProvider](Interface.IBlobProvider)                                     | -           |
+| [IBlobSignedUrlRequest](Interface.IBlobSignedUrlRequest)                     | -           |
+| [IBlobUploadRequest](Interface.IBlobUploadRequest)                           | -           |
+| [IBlobUploadResult](Interface.IBlobUploadResult)                             | -           |
+| [ICustomBlobProviderRegistration](Interface.ICustomBlobProviderRegistration) | -           |
+| [IVercelBlobProviderOptions](Interface.IVercelBlobProviderOptions)           | -           |
+| [IVercelBlobProviderRegistration](Interface.IVercelBlobProviderRegistration) | -           |
+
+## Type Aliases
+
+| Type Alias                                                       | Description |
+| ---------------------------------------------------------------- | ----------- |
+| [BlobDownloadResponseType](TypeAlias.BlobDownloadResponseType)   | -           |
+| [BlobUploadBody](TypeAlias.BlobUploadBody)                       | -           |
+| [IBlobProviderRegistration](TypeAlias.IBlobProviderRegistration) | -           |
+
+## Variables
+
+### BLOB_PROVIDER
+
+```ts
+const BLOB_PROVIDER: typeof BLOB_PROVIDER;
+```
+
+Defined in: [tokens.ts:3](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens.ts#L3)
+
+---
+
+### BlobDownloadResponseTypes
+
+```ts
+const BlobDownloadResponseTypes: {
+  ArrayBuffer: 'arraybuffer';
+  Json: 'json';
+  Stream: 'stream';
+  Text: 'text';
+};
+```
+
+Defined in: [interfaces/IBlobProvider.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L16)
+
+#### Type Declaration
+
+| Name                                            | Type            | Default value   | Defined in                                                                                                                                         |
+| ----------------------------------------------- | --------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-arraybuffer"></a> `ArrayBuffer` | `"arraybuffer"` | `'arraybuffer'` | [interfaces/IBlobProvider.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L17) |
+| <a id="property-json"></a> `Json`               | `"json"`        | `'json'`        | [interfaces/IBlobProvider.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L18) |
+| <a id="property-stream"></a> `Stream`           | `"stream"`      | `'stream'`      | [interfaces/IBlobProvider.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L19) |
+| <a id="property-text"></a> `Text`               | `"text"`        | `'text'`        | [interfaces/IBlobProvider.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L20) |
+
+---
+
+### BlobProviderKinds
+
+```ts
+const BlobProviderKinds: {
+  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-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) |
+
+---
+
+### VERCEL_BLOB_PROVIDER_OPTIONS
+
+```ts
+const VERCEL_BLOB_PROVIDER_OPTIONS: typeof VERCEL_BLOB_PROVIDER_OPTIONS;
+```
+
+Defined in: [tokens.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens.ts#L4)

package/data/packages/platform-blob-storage/index.md

@@ -0,0 +1,280 @@
+---
+title: platform-blob-storage
+description: Cloud file storage abstraction with pluggable providers and optional metadata persistence.
+order: 3
+tags: [blob-storage, files, upload, download, vercel, providers, ports-and-adapters]
+package: '@breadstone/archipel-platform-blob-storage'
+---
+
+# platform-blob-storage
+
+Cloud file storage abstraction supporting pluggable providers and optional metadata persistence via ports. Ships with a Vercel Blob provider out of the box.
+
+**Package:** `@breadstone/archipel-platform-blob-storage`
+
+## Quick Start
+
+```typescript
+import { Module } from '@nestjs/common';
+import { BlobModule } from '@breadstone/archipel-platform-blob-storage';
+
+@Module({
+  imports: [
+    // Minimal setup — Vercel Blob, no metadata tracking
+    BlobModule.forRoot(),
+
+    // Full setup — custom provider + metadata tracking
+    BlobModule.forRoot({
+      provider: { kind: 'vercel' },
+      objectPersistence: PrismaBlobObjectAdapter,
+      variantPersistence: PrismaBlobVariantAdapter,
+      isGlobal: true,
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+---
+
+## Module Configuration
+
+### IBlobModuleOptions
+
+| Property             | Type                               | Required | Default     | Description                            |
+| -------------------- | ---------------------------------- | -------- | ----------- | -------------------------------------- |
+| `provider`           | `IBlobProviderRegistration`        | No       | Vercel Blob | Storage backend to use                 |
+| `objectPersistence`  | `Type<BlobObjectPersistencePort>`  | No       | —           | Metadata tracking for uploaded objects |
+| `variantPersistence` | `Type<BlobVariantPersistencePort>` | No       | —           | Metadata tracking for image variants   |
+| `isGlobal`           | `boolean`                          | No       | `true`      | Register as a global module            |
+
+### Provider Registration
+
+```typescript
+// Vercel Blob (default)
+{ kind: 'vercel', options?: { token?: string } }
+
+// Custom provider
+{ kind: 'custom', useClass: MyS3Provider }
+```
+
+---
+
+## BlobService API
+
+The main service for all blob operations. Inject it anywhere:
+
+```typescript
+import { BlobService } from '@breadstone/archipel-platform-blob-storage';
+
+@Injectable()
+export class ImageService {
+  constructor(private readonly _blob: BlobService) {}
+}
+```
+
+### Upload
+
+```typescript
+// Upload from buffer
+const result = await this._blob.uploadFile('avatars/user-123.png', imageBuffer, 'image/png');
+console.log(result.metadata.url);
+
+// Upload with full request
+const result = await this._blob.uploadObject({
+  key: 'documents/report.pdf',
+  body: pdfBuffer,
+  contentType: 'application/pdf',
+  bucket: 'my-bucket',
+});
+```
+
+### Upload Variant
+
+Upload a derived version of an existing blob (e.g., thumbnail):
+
+```typescript
+const thumbnail = await this._blob.uploadVariant(originalBlobId, 'thumbnail-200x200', {
+  key: 'avatars/user-123-thumb.png',
+  body: thumbnailBuffer,
+  contentType: 'image/png',
+});
+```
+
+### Download
+
+```typescript
+// Download as buffer
+const result = await this._blob.downloadFile<Buffer>('avatars/user-123.png', 'arraybuffer');
+const buffer = result.data;
+
+// Download as stream
+const result = await this._blob.downloadFile<ReadableStream>('videos/intro.mp4', 'stream');
+
+// Download as JSON
+const result = await this._blob.downloadFile<Record<string, unknown>>('config/settings.json', 'json');
+```
+
+### Delete
+
+```typescript
+await this._blob.deleteObject({
+  key: 'avatars/user-123.png',
+  bucket: 'my-bucket',
+});
+// If objectPersistence is registered, metadata is also marked as deleted
+```
+
+### Signed URLs
+
+```typescript
+const signedUrl = await this._blob.createSignedUrl({
+  key: 'private/contract.pdf',
+  expiresIn: 3600, // 1 hour
+});
+```
+
+---
+
+## Ports (Contracts)
+
+### BlobObjectPersistencePort
+
+Tracks metadata for uploaded blob objects. Optional — when not provided, uploads still work but metadata is not persisted.
+
+```typescript
+abstract class BlobObjectPersistencePort {
+  abstract createFromMetadata(metadata: IBlobObjectMetadata): Promise<void>;
+  abstract markAsDeleted(provider: string, bucket: string, key: string, versionId?: string): Promise<void>;
+}
+```
+
+### BlobVariantPersistencePort
+
+Tracks metadata for image/document variants.
+
+```typescript
+abstract class BlobVariantPersistencePort {
+  abstract createFromMetadata(originalId: string, label: string, metadata: IBlobObjectMetadata): Promise<void>;
+}
+```
+
+### Real-World Adapter: Prisma
+
+```typescript
+@Injectable()
+export class PrismaBlobObjectAdapter extends BlobObjectPersistencePort {
+  private readonly _prisma: PrismaService;
+
+  constructor(prisma: PrismaService) {
+    super();
+    this._prisma = prisma;
+  }
+
+  public async createFromMetadata(metadata: IBlobObjectMetadata): Promise<void> {
+    await this._prisma.blobObject.create({
+      data: {
+        provider: metadata.provider,
+        bucket: metadata.bucket,
+        key: metadata.key,
+        url: metadata.url,
+        size: metadata.size,
+        contentType: metadata.contentType,
+        versionId: metadata.versionId,
+      },
+    });
+  }
+
+  public async markAsDeleted(provider: string, bucket: string, key: string, versionId?: string): Promise<void> {
+    await this._prisma.blobObject.updateMany({
+      where: { provider, bucket, key, versionId },
+      data: { deletedAt: new Date() },
+    });
+  }
+}
+```
+
+---
+
+## Built-in Providers
+
+### VercelBlobProvider
+
+The default blob provider using Vercel's Blob Storage API.
+
+```typescript
+BlobModule.forRoot({
+  provider: {
+    kind: 'vercel',
+    options: { token: process.env.BLOB_READ_WRITE_TOKEN },
+  },
+});
+```
+
+### Custom Provider
+
+Implement `IBlobProvider` for any storage backend (S3, Azure Blob, GCS, MinIO):
+
+```typescript
+@Injectable()
+export class S3BlobProvider implements IBlobProvider {
+  public readonly providerId = 's3';
+
+  public async uploadObject(request: IBlobUploadRequest): Promise<IBlobUploadResult> {
+    // S3 PutObject implementation
+  }
+
+  public async downloadObject<TData>(request: IBlobDownloadRequest): Promise<IBlobDownloadResult<TData>> {
+    // S3 GetObject implementation
+  }
+
+  public async deleteObject(request: IBlobDeleteRequest): Promise<void> {
+    // S3 DeleteObject implementation
+  }
+
+  public async createSignedUrl(request: IBlobSignedUrlRequest): Promise<string> {
+    // S3 presigned URL
+  }
+}
+
+// Register
+BlobModule.forRoot({
+  provider: { kind: 'custom', useClass: S3BlobProvider },
+});
+```
+
+---
+
+## Health Check
+
+The `BlobHealthIndicator` integrates with NestJS Terminus for health monitoring:
+
+```typescript
+import { BlobHealthIndicator } from '@breadstone/archipel-platform-blob-storage';
+
+@Controller('health')
+export class HealthController {
+  constructor(private readonly _blobHealth: BlobHealthIndicator) {}
+
+  @Get()
+  public async check(): Promise<HealthCheckResult> {
+    return this._blobHealth.isHealthy('blob');
+  }
+}
+```
+
+---
+
+## Exports Summary
+
+| Export                       | Type          | Description                                        |
+| ---------------------------- | ------------- | -------------------------------------------------- |
+| `BlobModule`                 | NestJS Module | Main module with `forRoot()`                       |
+| `BlobService`                | Service       | Upload, download, delete, signed URLs              |
+| `BlobObjectPersistencePort`  | Port          | Object metadata tracking                           |
+| `BlobVariantPersistencePort` | Port          | Variant metadata tracking                          |
+| `VercelBlobProvider`         | Provider      | Vercel Blob implementation                         |
+| `BlobHealthIndicator`        | Health        | Terminus health check                              |
+| `IBlobProvider`              | Interface     | Custom provider contract                           |
+| `BlobProviderKinds`          | Constant      | `'vercel'` / `'custom'`                            |
+| `BlobDownloadResponseTypes`  | Constant      | `'arraybuffer'` / `'json'` / `'stream'` / `'text'` |

package/data/packages/platform-core/api/Class.AppHealthIndicator.md

@@ -0,0 +1,51 @@
+---
+title: 'Class: AppHealthIndicator'
+generated: true
+editUrl: false
+---
+
+# Class: AppHealthIndicator
+
+Defined in: [terminus/AppHealthIndicator.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/terminus/AppHealthIndicator.ts#L15)
+
+Health indicator for the application.
+
+## Constructors
+
+### Constructor
+
+```ts
+new AppHealthIndicator(configService): AppHealthIndicator;
+```
+
+Defined in: [terminus/AppHealthIndicator.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/terminus/AppHealthIndicator.ts#L30)
+
+Constructs a new instance of the `AppHealthIndicator` class.
+
+#### Parameters
+
+| Parameter       | Type                                   |
+| --------------- | -------------------------------------- |
+| `configService` | [`ConfigService`](Class.ConfigService) |
+
+#### Returns
+
+`AppHealthIndicator`
+
+## Methods
+
+### isHealthy()
+
+```ts
+isHealthy(): HealthIndicatorResult<"app">;
+```
+
+Defined in: [terminus/AppHealthIndicator.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/terminus/AppHealthIndicator.ts#L46)
+
+Checks if the Open Food Facts API is reachable.
+
+#### Returns
+
+`HealthIndicatorResult`\<`"app"`\>
+
+The health indicator result.

package/data/packages/platform-core/api/Class.BcryptService.md

@@ -0,0 +1,69 @@
+---
+title: 'Class: BcryptService'
+generated: true
+editUrl: false
+---
+
+# Class: BcryptService
+
+Defined in: [services/BcryptService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/BcryptService.ts#L15)
+
+The `BcryptService` class.
+Represents the service that provides bcrypt operations.
+
+## Constructors
+
+### Constructor
+
+```ts
+new BcryptService(): BcryptService;
+```
+
+#### Returns
+
+`BcryptService`
+
+## Methods
+
+### compare()
+
+```ts
+compare(data, encrypted): Promise<boolean>;
+```
+
+Defined in: [services/BcryptService.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/BcryptService.ts#L37)
+
+Compares the given data with the encrypted data.
+
+#### Parameters
+
+| Parameter   | Type     | Description                       |
+| ----------- | -------- | --------------------------------- |
+| `data`      | `string` | The data to be compared           |
+| `encrypted` | `string` | The encrypted data to be compared |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+---
+
+### hash()
+
+```ts
+hash(data): Promise<string>;
+```
+
+Defined in: [services/BcryptService.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/BcryptService.ts#L25)
+
+Hashes the given data.
+
+#### Parameters
+
+| Parameter | Type     | Description           |
+| --------- | -------- | --------------------- |
+| `data`    | `string` | The data to be hashed |
+
+#### Returns
+
+`Promise`\<`string`\>