@casfa/storage-fs 0.1.0 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@casfa/storage-fs",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "File system storage provider for CAS",
   "type": "module",
   "main": "./dist/index.js",

package/README.md

@@ -1,127 +0,0 @@
-# @casfa/storage-fs
-
-File system storage provider for CAS.
-
-## Installation
-
-```bash
-bun add @casfa/storage-fs
-```
-
-## Overview
-
-A file system-backed storage provider for CAS (Content-Addressable Storage). Stores content in a sharded directory structure for efficient file system performance.
-
-### Storage Structure
-
-```
-{basePath}/
-├── ab/
-│   └── cd/
-│       └── abcd1234...  (full hash)
-├── ef/
-│   └── 01/
-│       └── ef012345...
-└── ...
-```
-
-## Usage
-
-### Basic Usage
-
-```typescript
-import { createFsStorage } from '@casfa/storage-fs';
-
-const storage = createFsStorage({
-  basePath: '/var/cas/data',
-});
-
-// Store data
-await storage.put('node:abcd1234...', data);
-
-// Retrieve data
-const data = await storage.get('node:abcd1234...');
-
-// Check existence
-const exists = await storage.has('node:abcd1234...');
-
-// Delete
-const deleted = await storage.delete('node:abcd1234...');
-```
-
-### With LRU Cache
-
-```typescript
-import { createFsStorageWithCache } from '@casfa/storage-fs';
-
-const storage = createFsStorageWithCache({
-  basePath: '/var/cas/data',
-  cacheSize: 1000,      // Max items in cache
-  cacheMaxAge: 60000,   // TTL in milliseconds
-});
-
-// Cache is automatically managed
-const data = await storage.get('node:abcd1234...');  // May hit cache
-```
-
-## Configuration
-
-```typescript
-interface FsStorageConfig {
-  // Required: Base directory for storage
-  basePath: string;
-  
-  // Optional: File permissions (default: 0o644)
-  fileMode?: number;
-  
-  // Optional: Directory permissions (default: 0o755)
-  dirMode?: number;
-}
-```
-
-### Cache Options
-
-```typescript
-interface FsStorageWithCacheConfig extends FsStorageConfig {
-  // Max items in LRU cache (default: 1000)
-  cacheSize?: number;
-  
-  // Cache TTL in milliseconds (default: 60000)
-  cacheMaxAge?: number;
-}
-```
-
-## API Reference
-
-### Functions
-
-- `createFsStorage(config)` - Create storage without cache
-- `createFsStorageWithCache(config)` - Create storage with LRU cache
-
-### StorageProvider Interface
-
-```typescript
-interface StorageProvider {
-  get(key: string): Promise<Uint8Array | null>;
-  put(key: string, data: Uint8Array): Promise<void>;
-  has(key: string): Promise<boolean>;
-  delete(key: string): Promise<boolean>;
-}
-```
-
-## Performance Tips
-
-1. **Use caching** for read-heavy workloads
-2. **Use SSD storage** for better random access performance
-3. **Monitor disk space** as CAS data is append-only by nature
-4. Consider **separate partitions** for CAS data to prevent filling system disk
-
-## Related Packages
-
-- `@casfa/storage-core` - Core types and utilities
-- `@casfa/storage-memory` - In-memory storage (for testing)
-- `@casfa/storage-s3` - S3 storage (for cloud deployment)
-
-## License
-
-MIT

package/README.zh-CN.md

@@ -1,127 +0,0 @@
-# @casfa/storage-fs
-
-基于文件系统的 CAS 存储提供者。
-
-## 安装
-
-```bash
-bun add @casfa/storage-fs
-```
-
-## 概述
-
-基于文件系统的 CAS（内容寻址存储）存储提供者。采用分片目录结构存储内容，以获得更好的文件系统性能。
-
-### 存储结构
-
-```
-{basePath}/
-├── ab/
-│   └── cd/
-│       └── abcd1234...  (full hash)
-├── ef/
-│   └── 01/
-│       └── ef012345...
-└── ...
-```
-
-## 使用方法
-
-### 基本用法
-
-```typescript
-import { createFsStorage } from '@casfa/storage-fs';
-
-const storage = createFsStorage({
-  basePath: '/var/cas/data',
-});
-
-// 存储数据
-await storage.put('node:abcd1234...', data);
-
-// 检索数据
-const data = await storage.get('node:abcd1234...');
-
-// 检查是否存在
-const exists = await storage.has('node:abcd1234...');
-
-// 删除
-const deleted = await storage.delete('node:abcd1234...');
-```
-
-### 带 LRU 缓存
-
-```typescript
-import { createFsStorageWithCache } from '@casfa/storage-fs';
-
-const storage = createFsStorageWithCache({
-  basePath: '/var/cas/data',
-  cacheSize: 1000,      // 缓存最大条目数
-  cacheMaxAge: 60000,   // TTL（毫秒）
-});
-
-// 缓存自动管理
-const data = await storage.get('node:abcd1234...');  // 可能命中缓存
-```
-
-## 配置
-
-```typescript
-interface FsStorageConfig {
-  // 必需：存储基础目录
-  basePath: string;
-  
-  // 可选：文件权限（默认: 0o644）
-  fileMode?: number;
-  
-  // 可选：目录权限（默认: 0o755）
-  dirMode?: number;
-}
-```
-
-### 缓存选项
-
-```typescript
-interface FsStorageWithCacheConfig extends FsStorageConfig {
-  // LRU 缓存最大条目数（默认: 1000）
-  cacheSize?: number;
-  
-  // 缓存 TTL，单位毫秒（默认: 60000）
-  cacheMaxAge?: number;
-}
-```
-
-## API 参考
-
-### 函数
-
-- `createFsStorage(config)` - 创建不带缓存的存储
-- `createFsStorageWithCache(config)` - 创建带 LRU 缓存的存储
-
-### StorageProvider 接口
-
-```typescript
-interface StorageProvider {
-  get(key: string): Promise<Uint8Array | null>;
-  put(key: string, data: Uint8Array): Promise<void>;
-  has(key: string): Promise<boolean>;
-  delete(key: string): Promise<boolean>;
-}
-```
-
-## 性能建议
-
-1. **使用缓存** 以应对读密集型工作负载
-2. **使用 SSD 存储** 以获得更好的随机访问性能
-3. **监控磁盘空间**，因为 CAS 数据本质上是只追加的
-4. 考虑为 CAS 数据使用**独立分区**，防止占满系统磁盘
-
-## 相关包
-
-- `@casfa/storage-core` - 核心类型与工具
-- `@casfa/storage-memory` - 内存存储（用于测试）
-- `@casfa/storage-s3` - S3 存储（用于云端部署）
-
-## 许可证
-
-MIT