Storage Adapters

Nextmin Node provides a pluggable file storage system. When initializing the createNextMinRouter, you must pass a fileStorageAdapter.

We provide built-in adapters for AWS S3 (and compatible services) and local file system storage.

Local Filesystem (New)

The LocalFileStorageAdapter stores uploaded files in a local directory. This is ideal for development or simple self-hosted deployments.

Usage

import { LocalFileStorageAdapter } from '@airoom/nextmin-node';
import path from 'path';
 
const fileStorageAdapter = new LocalFileStorageAdapter({
  // Directory where files will be saved
  uploadDir: path.join(__dirname, 'public/uploads'),
  // Base URL for accessing the files
  baseUrl: 'http://localhost:3000/uploads',
});
 
const nextminRouter = createNextMinRouter({
  // ... other options
  fileStorageAdapter,
});

S3 (AWS / MinIO)

The S3FileStorageAdapter allows you to store files in any S3-compatible service.

Usage

import { S3FileStorageAdapter } from '@airoom/nextmin-node';
 
const fileStorageAdapter = new S3FileStorageAdapter({
  bucket: process.env.S3_BUCKET,
  region: process.env.S3_REGION,
  credentials: {
    accessKeyId: process.env.S3_ACCESS_KEY_ID,
    secretAccessKey: process.env.S3_SECRET_ACCESS_KEY,
  },
  // Optional: Custom endpoint (e.g. for MinIO)
  endpoint: process.env.S3_ENDPOINT,
  forcePathStyle: true,
});

Image Proxying & Transformation (New)

Nextmin can automatically transform storage URLs (like S3/R2 links) into proxied URLs served through your own domain. This is essential for SEO and brand consistency.

How it works

1. Transformation: When the API returns a document, it scans all fields for URLs matching your storage base and replaces them with your proxy base (e.g., /images).
2. Proxying: The backend provides a new endpoint GET /rest/files/:key(*) that streams the actual file from storage to the browser.

Automatic Configuration

If you have FRONTEND_URL set in your environment variables, Nextmin will automatically enable a relative proxy at /images.

Manual Configuration

You can also configure this explicitly in your NMAdapter options:

const dbAdapter = new NMAdapter({
  // ... other options
  imageProxy: {
    // The original S3/R2 base URL to look for
    originalBase: 'https://mybucket.s3.us-east-2.amazonaws.com',
    // The new base path to use in API responses
    proxyBase: '/images'
  }
});

Next.js Integration

To make this work seamlessly with Next.js, add a rewrite to your next.config.js:

// next.config.js
module.exports = {
  async rewrites() {
    return [
      {
        source: '/images/:path*',
        destination: 'https://api.yourdomain.com/rest/files/:path*',
      },
    ]
  },
}

This ensures that images like /images/uploads/photo.jpg are transparently proxied through your backend while appearing to come from your main domain.