@breadstone/archipel-platform-resources

Multi-strategy resource management for NestJS applications. Loads files from the file system, embedded buffers, or blob storage with MIME type detection and optional caching.

Quick Start

import { ResourceModule, ResourceManager } from '@breadstone/archipel-platform-resources';
import { FileResourceStrategy } from '@breadstone/archipel-platform-resources';

// Register the module
@Module({
  imports: [
    ResourceModule.forRoot({
      strategies: [new FileResourceStrategy({ basePath: './assets' })],
    }),
  ],
})
export class AppModule {}

// Use in a service
const result = await resourceManager.get('logo.png');
// result.buffer — file content
// result.metadata.mimeType — 'image/png'

Strategies

Features

• Pluggable strategies — file system, blob storage, or embedded buffers
• MIME type detection — automatic via the mime-types library
• Optional caching — integrates with @breadstone/archipel-platform-caching
• NestJS integration — global ResourceModule.forRoot() with injectable ResourceManager

Documentation

📖 Package Docs: .docs/packages/platform-resources/index.md

Development

# Build
yarn nx build platform-resources

# Test
yarn nx test platform-resources

# Lint
yarn nx lint platform-resources