@core / storage

1.0.1 ▾

1.0.1

verifiedMIT

GitHub

File storage for S3-compatible buckets (R2, S3, MinIO) and local disk, with signed direct uploads

Code11 filesContext~697 tokensscan passed

~697 tokens→ src/lib/storage/AGENTS.md→ .cursor/rules/genpm-core-storage.mdc

This is exactly what your AI reads when it works in src/lib/storage. Nothing else is added to its context.

@core/storage — rules for AI agents

Purpose

One StorageProvider interface to store and serve files: S3-compatible buckets (Cloudflare R2, AWS S3, MinIO, B2) signed with SigV4 (aws4fetch, works on Node and Workers), plus local (disk) and memory drivers for development and tests. Signed direct uploads from the browser with the exact size and content type signed. No media library, no image processing (that is @core/media). No tables.

Map

index.ts — public API: getStorage(), setStorage(), generateKey(), assertSafeKey(), s3Storage(), types.
s3.ts — S3 driver. memory.ts — local/memory drivers and signed tokens. local-routes.ts — handlers for them.
adapters/hono.ts, adapters/next.ts — upload/download route, only needed with local/memory.

Integration

Env for S3/R2 (default driver): STORAGE_ENDPOINT (R2: https://<account>.r2.cloudflarestorage.com), STORAGE_BUCKET, STORAGE_ACCESS_KEY_ID, STORAGE_SECRET_ACCESS_KEY, optional STORAGE_REGION (default auto) and STORAGE_PUBLIC_URL (CDN/custom domain serving the public/ prefix). Local dev: STORAGE_DRIVER=local, STORAGE_SECRET (≥ 32 chars), STORAGE_PUBLIC_URL=http://localhost:3000 (files go to STORAGE_LOCAL_DIR, default .storage/: add it to .gitignore), and mount the route: Hono app.route('/api/storage', localStorageRoutes()); Next.js app/api/storage/[[...key]]/route.ts with export { localStoragePut as PUT, localStorageGet as GET } from '@/lib/storage/adapters/next'.
Bucket CORS (S3/R2): allow PUT from your origin with header content-type.
Direct upload: server creates const key = generateKey('public/media', file.name) and await getStorage().presignUpload(key, { contentType, size, maxBytes: 10_000_000 }); the browser does fetch(url, { method: 'PUT', headers, body: file }).
Verify: upload a small file, then getStorage().head(key) returns its size.

Conventions

Keys are generated by the server (generateKey); never use the user's filename or path as the key.
Everything is private unless its key starts with public/; serve private files with presignDownload after an authorization check.
Store the key in your table, not the URL (URLs change with the CDN or driver).
A presigned upload URL can be reused until it expires. If the server validates or transforms the file after upload, presign a private key (e.g. uploads/pending/…) and have the server copy the validated bytes to the final public/ key.

Don't

Don't make the whole bucket public or proxy private files without checking permissions.
Don't trust the client's content type for security decisions; @core/media sniffs the real type after upload.
Don't log storage credentials or presigned URLs.

# @core/storage — rules for AI agents

## Purpose
One `StorageProvider` interface to store and serve files: S3-compatible buckets (Cloudflare R2, AWS S3, MinIO, B2)
signed with SigV4 (`aws4fetch`, works on Node and Workers), plus `local` (disk) and `memory` drivers for development
and tests. Signed direct uploads from the browser with the exact size and content type signed. No media library,
no image processing (that is @core/media). No tables.

## Map
- `index.ts` — public API: `getStorage()`, `setStorage()`, `generateKey()`, `assertSafeKey()`, `s3Storage()`, types.
- `s3.ts` — S3 driver. `memory.ts` — local/memory drivers and signed tokens. `local-routes.ts` — handlers for them.
- `adapters/hono.ts`, `adapters/next.ts` — upload/download route, only needed with `local`/`memory`.

## Integration
1. Env for S3/R2 (default driver): `STORAGE_ENDPOINT` (R2: `https://<account>.r2.cloudflarestorage.com`),
   `STORAGE_BUCKET`, `STORAGE_ACCESS_KEY_ID`, `STORAGE_SECRET_ACCESS_KEY`, optional `STORAGE_REGION` (default `auto`)
   and `STORAGE_PUBLIC_URL` (CDN/custom domain serving the `public/` prefix).
   Local dev: `STORAGE_DRIVER=local`, `STORAGE_SECRET` (≥ 32 chars), `STORAGE_PUBLIC_URL=http://localhost:3000`
   (files go to `STORAGE_LOCAL_DIR`, default `.storage/`: add it to `.gitignore`), and
   mount the route: Hono `app.route('/api/storage', localStorageRoutes())`; Next.js
   `app/api/storage/[[...key]]/route.ts` with `export { localStoragePut as PUT, localStorageGet as GET } from '@/lib/storage/adapters/next'`.
2. Bucket CORS (S3/R2): allow `PUT` from your origin with header `content-type`.
3. Direct upload: server creates `const key = generateKey('public/media', file.name)` and
   `await getStorage().presignUpload(key, { contentType, size, maxBytes: 10_000_000 })`; the browser does
   `fetch(url, { method: 'PUT', headers, body: file })`.
4. Verify: upload a small file, then `getStorage().head(key)` returns its size.

## Conventions
- Keys are generated by the server (`generateKey`); never use the user's filename or path as the key.
- Everything is private unless its key starts with `public/`; serve private files with `presignDownload` after an authorization check.
- Store the key in your table, not the URL (URLs change with the CDN or driver).
- A presigned upload URL can be reused until it expires. If the server validates or transforms the file after upload,
  presign a private key (e.g. `uploads/pending/…`) and have the server copy the validated bytes to the final `public/` key.

## Don't
- Don't make the whole bucket public or proxy private files without checking permissions.
- Don't trust the client's content type for security decisions; @core/media sniffs the real type after upload.
- Don't log storage credentials or presigned URLs.

The exact tree that will be injected, after .genpmignore. Pinned to

src/lib/storage/adapters/next.tsread-only · 5b6a9cc

// Adaptador Next.js (solo drivers `local`/`memory`): `app/api/storage/[[...key]]/route.ts` →
//   export { localStoragePut as PUT, localStorageGet as GET } from '@/lib/storage/adapters/next';
import { getStorage, handleLocalDownload, handleLocalUpload } from '../index.ts';

const secret = () => process.env.STORAGE_SECRET ?? '';

export const localStoragePut = (req: Request) => handleLocalUpload(req, getStorage(), secret());
export const localStorageGet = (req: Request) => handleLocalDownload(req, getStorage(), secret());