@core / storage

1.0.1 ▾

1.0.1

認証済みMIT

GitHub

S3 互換バケット（R2、S3、MinIO）とローカルディスクのファイル保存、署名付き直接アップロード対応

コード11 ファイルコンテキスト約 697 トークンスキャン合格

約 697 トークン→ src/lib/storage/AGENTS.md→ .cursor/rules/genpm-core-storage.mdc

これは AI が src/lib/storage で作業するときに読む内容そのものです。それ以外はコンテキストに追加されません。

@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.

.genpmignore 適用後に組み込まれる正確なツリーです。固定先:

src/lib/storage/adapters/hono.ts読み取り専用 · 5b6a9cc

// Adaptador Hono (solo drivers `local`/`memory`): `app.route('/api/storage', localStorageRoutes())`.
import { Hono } from 'hono';
import { getStorage, handleLocalDownload, handleLocalUpload } from '../index.ts';

export function localStorageRoutes(secret = process.env.STORAGE_SECRET ?? '', routePath = '/api/storage') {
  return new Hono()
    .put('/', (c) => handleLocalUpload(c.req.raw, getStorage(), secret))
    .get('/*', (c) => handleLocalDownload(c.req.raw, getStorage(), secret, routePath));
}

バージョン	コミット	公開日	スキャン
1.0.1	5b6a9cc	4 時間前	スキャン合格

$genpm add @core/storage

組み込み先: src/lib/storage
コミット
タグ: v1.0.1
npm: aws4fetch ^1.0.20
Env: STORAGE_DRIVER STORAGE_BUCKET STORAGE_ENDPOINT STORAGE_ACCESS_KEY_ID STORAGE_SECRET_ACCESS_KEY STORAGE_PUBLIC_URL STORAGE_SECRET STORAGE_LOCAL_DIR
品質: 100/100
利用元: 1
インストール数: 0 / 30日
公開日: 4 時間前 · genpm-system

README バッジ

[![genpm](https://api.genpm.net/v1/badge/@core/storage.svg)](https://genpm.net/p/@core/storage)