storage

Files (1)

• SKILL.md

SKILL.md (first lines)

# Storage Skill

## 1. When to Use
Use this skill when uploading, downloading, or managing objects in S3-compatible storage (MinIO/AWS S3).

## 2. StorageService Abstraction
- All object storage operations must use `StorageService` from `@packages/shared`.
- S3 client uses `@aws-sdk/client-s3` and is configured via environment variables (`S3_ENDPOINT`, `S3_REGION`, `S3_BUCKET`, `S3_ACCESS_KEY`, `S3_SECRET_KEY`, `S3_FORCE_PATH_STYLE`).
- Never hardcode MinIO or AWS URLs into business logic.

## 3. Usage Pattern
```typescript
import { StorageService } from '@packages/shared';

const storage = new StorageService({
  endpoint: env.S3_ENDPOINT,
  region: env.S3_REGION,
  bucket: env.S3_BUCKET,
  credentials: {
    accessKeyId: env.S3_ACCESS_KEY,
    secretAccessKey: env.S3_SECRET_KEY,
  },
  forcePathStyle: env.S3_FORCE_PATH_STYLE,
});

// Put object
await storage.putObject('uploads/document.pdf', buffer, 'application/pdf');

// Get object buffer
const data = await storage.getObject('uploads/document.pdf');
```

## 4. Mandatory Testing Expectations
- Test storage client error handling when credentials or configuration are invalid.
- Verify MIME type and size checks before invoking storage writes.
- Do not make unit tests dependent on live remote cloud S3 buckets; use local MinIO or controlled doubles.

From Mihir-Rabari/create-odoo-app, MIT.

More from Mihir-Rabari/create-odoo-app