@breadstone/archipel-mcp 0.0.13 → 0.0.14

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:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L43)
-
-## Properties
-
-### kind
-
-```ts
-kind: "vercel";
-```
-
-Defined in: [BlobModule.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L44)
-
-***
-
-### options?
-
-```ts
-optional options?: Partial<IVercelBlobProviderOptions>;
-```
-
-Defined in: [BlobModule.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L45)

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

@@ -1,12 +0,0 @@
----
-title: 'Type Alias: BlobDownloadResponseType'
-generated: true
-editUrl: false
----
-# Type Alias: BlobDownloadResponseType
-
-```ts
-type BlobDownloadResponseType = typeof BlobDownloadResponseTypes[keyof typeof BlobDownloadResponseTypes];
-```
-
-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.BlobUploadBody.md

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

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:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L63)

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.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens.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.ts:5](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens.ts#L5)

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

@@ -1,12 +0,0 @@
----
-title: 'Variable: BLOB\_PROVIDER'
-generated: true
-editUrl: false
----
-# Variable: 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)

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

@@ -1,26 +0,0 @@
----
-title: 'Variable: BlobDownloadResponseTypes'
-generated: true
-editUrl: false
----
-# Variable: BlobDownloadResponseTypes
-
-```ts
-const BlobDownloadResponseTypes: {
-  ArrayBuffer: "arraybuffer";
-  Json: "json";
-  Stream: "stream";
-  Text: "text";
-};
-```
-
-Defined in: [interfaces/IBlobProvider.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L18)
-
-## Type Declaration
-
-| Name | Type | Default value | Defined in |
-| ------ | ------ | ------ | ------ |
-| <a id="property-arraybuffer"></a> `ArrayBuffer` | `"arraybuffer"` | `'arraybuffer'` | [interfaces/IBlobProvider.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L19) |
-| <a id="property-json"></a> `Json` | `"json"` | `'json'` | [interfaces/IBlobProvider.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L20) |
-| <a id="property-stream"></a> `Stream` | `"stream"` | `'stream'` | [interfaces/IBlobProvider.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L21) |
-| <a id="property-text"></a> `Text` | `"text"` | `'text'` | [interfaces/IBlobProvider.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L22) |

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) |

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

@@ -1,12 +0,0 @@
----
-title: 'Variable: VERCEL\_BLOB\_PROVIDER\_OPTIONS'
-generated: true
-editUrl: false
----
-# Variable: 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/api/index.md

@@ -1,59 +0,0 @@
----
-title: '@breadstone/archipel-platform-blob-storage'
-generated: true
-editUrl: false
----
-# @breadstone/archipel-platform-blob-storage
-
-## Classes
-
-| Class | Description |
-| ------ | ------ |
-| [AwsS3BlobProvider](Class.AwsS3BlobProvider) | Provides an implementation of [IBlobProvider](Interface.IBlobProvider) for Amazon S3. |
-| [AzureBlobProvider](Class.AzureBlobProvider) | Provides an implementation of [IBlobProvider](Interface.IBlobProvider) for Microsoft Azure Blob Storage. |
-| [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 |
-| ------ | ------ |
-| [IAwsS3BlobProviderRegistration](Interface.IAwsS3BlobProviderRegistration) | - |
-| [IAwsS3ProviderOptions](Interface.IAwsS3ProviderOptions) | - |
-| [IAzureBlobProviderOptions](Interface.IAzureBlobProviderOptions) | - |
-| [IAzureBlobProviderRegistration](Interface.IAzureBlobProviderRegistration) | - |
-| [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
-
-| Variable | Description |
-| ------ | ------ |
-| [AWS\_S3\_PROVIDER\_OPTIONS](Variable.AWS_S3_PROVIDER_OPTIONS) | - |
-| [AZURE\_BLOB\_PROVIDER\_OPTIONS](Variable.AZURE_BLOB_PROVIDER_OPTIONS) | - |
-| [BLOB\_PROVIDER](Variable.BLOB_PROVIDER) | - |
-| [BlobDownloadResponseTypes](Variable.BlobDownloadResponseTypes) | - |
-| [BlobProviderKinds](Variable.BlobProviderKinds) | - |
-| [VERCEL\_BLOB\_PROVIDER\_OPTIONS](Variable.VERCEL_BLOB_PROVIDER_OPTIONS) | - |

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

@@ -1,335 +0,0 @@
----
-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, azure, aws, s3, 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 Vercel Blob, Azure Blob Storage, and AWS S3 providers 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 } }
-
-// Azure Blob Storage
-{ kind: 'azure', options?: { connectionString?: string; containerName?: string } }
-
-// AWS S3
-{ kind: 'aws-s3', options?: { region?: string; accessKeyId?: string; secretAccessKey?: string; bucket?: string; endpoint?: string } }
-
-// Custom provider
-{ kind: 'custom', useClass: MyBlobProvider }
-```
-
----
-
-## 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 },
-  },
-});
-```
-
-**Environment variables:** `BLOB_READ_WRITE_TOKEN`, `BLOB_API_URL`, `BLOB_PUBLIC_URL`
-
-### AzureBlobProvider
-
-Microsoft Azure Blob Storage integration using `@azure/storage-blob`.
-
-```typescript
-import { AzureBlobProvider } from '@breadstone/archipel-platform-blob-storage/azure';
-
-BlobModule.forRoot({
-  provider: { kind: 'azure' },
-});
-```
-
-**Environment variables:** `AZURE_BLOB_CONNECTION_STRING`, `AZURE_BLOB_CONTAINER_NAME`
-
-The provider supports SAS token generation for signed URLs and lazy-loads the Azure SDK for tree-shaking.
-
-### AwsS3BlobProvider
-
-Amazon S3 integration using `@aws-sdk/client-s3` and `@aws-sdk/s3-request-presigner`.
-
-```typescript
-import { AwsS3BlobProvider } from '@breadstone/archipel-platform-blob-storage/aws-s3';
-
-BlobModule.forRoot({
-  provider: { kind: 'aws-s3' },
-});
-```
-
-**Environment variables:** `AWS_S3_REGION`, `AWS_S3_ACCESS_KEY_ID`, `AWS_S3_SECRET_ACCESS_KEY`, `AWS_S3_BUCKET`, `AWS_S3_ENDPOINT` (optional, for S3-compatible services like MinIO)
-
-The provider supports pre-signed URLs and lazy-loads the AWS SDK for tree-shaking.
-
-### Custom Provider
-
-Implement `IBlobProvider` for any other storage backend (GCS, MinIO, etc.):
-
-```typescript
-@Injectable()
-export class GcsBlobProvider implements IBlobProvider {
-  public readonly providerId = 'gcs';
-
-  public async uploadObject(request: IBlobUploadRequest): Promise<IBlobUploadResult> {
-    // GCS upload implementation
-  }
-
-  public async downloadObject<TData>(request: IBlobDownloadRequest): Promise<IBlobDownloadResult<TData>> {
-    // GCS download implementation
-  }
-
-  public async deleteObject(request: IBlobDeleteRequest): Promise<void> {
-    // GCS delete implementation
-  }
-
-  public async createSignedUrl(request: IBlobSignedUrlRequest): Promise<string> {
-    // GCS signed URL
-  }
-}
-
-// Register
-BlobModule.forRoot({
-  provider: { kind: 'custom', useClass: GcsBlobProvider },
-});
-```
-
----
-
-## 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');
-  }
-}
-```
-
----
-
-## Sub-path Imports
-
-Each provider is tree-shakeable via sub-path imports:
-
-| Import Path                                         | Contents                                              |
-| --------------------------------------------------- | ----------------------------------------------------- |
-| `@breadstone/archipel-platform-blob-storage`        | Core module, service, ports, health check, interfaces |
-| `@breadstone/archipel-platform-blob-storage/vercel` | VercelBlobProvider, VERCEL_BLOB_PROVIDER_OPTIONS      |
-| `@breadstone/archipel-platform-blob-storage/azure`  | AzureBlobProvider, AZURE_BLOB_PROVIDER_OPTIONS        |
-| `@breadstone/archipel-platform-blob-storage/aws-s3` | AwsS3BlobProvider, AWS_S3_PROVIDER_OPTIONS            |
-
----
-
-## 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 (sub-path)                 |
-| `AzureBlobProvider`          | Provider      | Azure Blob Storage implementation (sub-path)          |
-| `AwsS3BlobProvider`          | Provider      | AWS S3 implementation (sub-path)                      |
-| `BlobHealthIndicator`        | Health        | Terminus health check                                 |
-| `IBlobProvider`              | Interface     | Custom provider contract                              |
-| `BlobProviderKinds`          | Constant      | `'vercel'` \| `'azure'` \| `'aws-s3'` \| `'custom'`   |
-| `BlobDownloadResponseTypes`  | Constant      | `'arraybuffer'` \| `'json'` \| `'stream'` \| `'text'` |