@casfa/storage-memory 0.2.0 → 0.3.0

package/README.md

@@ -0,0 +1,140 @@
+# @casfa/storage-memory
+
+In-memory storage provider for CAS.
+
+## Installation
+
+```bash
+bun add @casfa/storage-memory
+```
+
+## Overview
+
+An in-memory storage provider for CAS (Content-Addressable Storage). Ideal for testing, development, and temporary storage needs.
+
+> ⚠️ **Warning**: Data is not persisted and will be lost when the process exits. Use only for testing and development.
+
+## Usage
+
+### Basic Usage
+
+```typescript
+import { createMemoryStorage } from '@casfa/storage-memory';
+
+const storage = createMemoryStorage();
+
+// Store data
+await storage.put('node:abcd1234...', data);
+
+// Retrieve data
+const data = await storage.get('node:abcd1234...');
+```
+
+### With Inspection (Testing)
+
+```typescript
+import { createMemoryStorageWithInspection } from '@casfa/storage-memory';
+
+const { storage, inspect } = createMemoryStorageWithInspection();
+
+// Use storage normally
+await storage.put('node:abcd1234...', data);
+
+// Inspect internal state (useful for tests)
+console.log(inspect.size());       // Number of items
+console.log(inspect.keys());       // All stored keys
+console.log(inspect.totalBytes()); // Total bytes stored
+inspect.clear();                   // Clear all data
+```
+
+### With Size Limit
+
+```typescript
+import { createMemoryStorage } from '@casfa/storage-memory';
+
+const storage = createMemoryStorage({
+  maxSize: 100 * 1024 * 1024,  // 100MB limit
+});
+```
+
+## Configuration
+
+```typescript
+interface MemoryStorageConfig {
+  // Optional: Maximum storage size in bytes
+  // When exceeded, oldest items may be evicted
+  maxSize?: number;
+  
+  // Optional: Maximum number of items
+  maxItems?: number;
+}
+```
+
+## API Reference
+
+### Functions
+
+- `createMemoryStorage(config?)` - Create basic memory storage
+- `createMemoryStorageWithInspection(config?)` - Create storage with inspection utilities
+
+### StorageProvider Interface
+
+```typescript
+interface StorageProvider {
+  get(key: string): Promise<Uint8Array | null>;
+  put(key: string, data: Uint8Array): Promise<void>;
+}
+```
+
+### Inspection Interface
+
+```typescript
+interface StorageInspection {
+  size(): number;           // Number of items
+  keys(): string[];         // All keys
+  totalBytes(): number;     // Total storage used
+  clear(): void;            // Clear all data
+}
+```
+
+## Use Cases
+
+- **Unit Testing**: Fast, isolated storage for tests
+- **Integration Testing**: Predictable storage behavior
+- **Development**: Quick iteration without file system overhead
+- **Caching Layer**: Combine with persistent storage
+
+## Example: Testing
+
+```typescript
+import { describe, it, expect, beforeEach } from 'bun:test';
+import { createMemoryStorageWithInspection } from '@casfa/storage-memory';
+
+describe('MyService', () => {
+  let storage: StorageProvider;
+  let inspect: StorageInspection;
+
+  beforeEach(() => {
+    const result = createMemoryStorageWithInspection();
+    storage = result.storage;
+    inspect = result.inspect;
+  });
+
+  it('should store data', async () => {
+    const service = new MyService(storage);
+    await service.saveData('test');
+    
+    expect(inspect.size()).toBe(1);
+  });
+});
+```
+
+## Related Packages
+
+- `@casfa/storage-core` - Core types and utilities
+- `@casfa/storage-fs` - File system storage (for production)
+- `@casfa/storage-s3` - S3 storage (for cloud deployment)
+
+## License
+
+MIT

package/README.zh-CN.md

@@ -0,0 +1,140 @@
+# @casfa/storage-memory
+
+基于内存的 CAS 存储提供者。
+
+## 安装
+
+```bash
+bun add @casfa/storage-memory
+```
+
+## 概述
+
+基于内存的 CAS（内容寻址存储）存储提供者。适用于测试、开发和临时存储场景。
+
+> ⚠️ **警告**：数据不会持久化，进程退出后将丢失。仅用于测试和开发。
+
+## 使用方法
+
+### 基本用法
+
+```typescript
+import { createMemoryStorage } from '@casfa/storage-memory';
+
+const storage = createMemoryStorage();
+
+// 存储数据
+await storage.put('node:abcd1234...', data);
+
+// 检索数据
+const data = await storage.get('node:abcd1234...');
+```
+
+### 带检查功能（测试用）
+
+```typescript
+import { createMemoryStorageWithInspection } from '@casfa/storage-memory';
+
+const { storage, inspect } = createMemoryStorageWithInspection();
+
+// 正常使用存储
+await storage.put('node:abcd1234...', data);
+
+// 检查内部状态（测试时很有用）
+console.log(inspect.size());       // 条目数量
+console.log(inspect.keys());       // 所有已存储的键
+console.log(inspect.totalBytes()); // 已存储的总字节数
+inspect.clear();                   // 清除所有数据
+```
+
+### 设置大小限制
+
+```typescript
+import { createMemoryStorage } from '@casfa/storage-memory';
+
+const storage = createMemoryStorage({
+  maxSize: 100 * 1024 * 1024,  // 100MB 限制
+});
+```
+
+## 配置
+
+```typescript
+interface MemoryStorageConfig {
+  // 可选：最大存储字节数
+  // 超出时可能淘汰最旧的条目
+  maxSize?: number;
+  
+  // 可选：最大条目数
+  maxItems?: number;
+}
+```
+
+## API 参考
+
+### 函数
+
+- `createMemoryStorage(config?)` - 创建基本内存存储
+- `createMemoryStorageWithInspection(config?)` - 创建带检查工具的存储
+
+### StorageProvider 接口
+
+```typescript
+interface StorageProvider {
+  get(key: string): Promise<Uint8Array | null>;
+  put(key: string, data: Uint8Array): Promise<void>;
+}
+```
+
+### Inspection 接口
+
+```typescript
+interface StorageInspection {
+  size(): number;           // 条目数量
+  keys(): string[];         // 所有键
+  totalBytes(): number;     // 已使用的总存储量
+  clear(): void;            // 清除所有数据
+}
+```
+
+## 使用场景
+
+- **单元测试**：快速、隔离的测试存储
+- **集成测试**：可预测的存储行为
+- **开发环境**：无需文件系统即可快速迭代
+- **缓存层**：与持久化存储组合使用
+
+## 示例：测试
+
+```typescript
+import { describe, it, expect, beforeEach } from 'bun:test';
+import { createMemoryStorageWithInspection } from '@casfa/storage-memory';
+
+describe('MyService', () => {
+  let storage: StorageProvider;
+  let inspect: StorageInspection;
+
+  beforeEach(() => {
+    const result = createMemoryStorageWithInspection();
+    storage = result.storage;
+    inspect = result.inspect;
+  });
+
+  it('should store data', async () => {
+    const service = new MyService(storage);
+    await service.saveData('test');
+    
+    expect(inspect.size()).toBe(1);
+  });
+});
+```
+
+## 相关包
+
+- `@casfa/storage-core` - 核心类型与工具
+- `@casfa/storage-fs` - 文件系统存储（用于生产环境）
+- `@casfa/storage-s3` - S3 存储（用于云端部署）
+
+## 许可证
+
+MIT

package/dist/index.d.ts

@@ -1,39 +1,7 @@
-import { StorageProvider } from '@casfa/storage-core';
-
 /**
- * In-Memory Storage Provider for CAS
+ * CAS Storage Memory
  *
- * Useful for testing and local development.
+ * In-memory storage provider for CAS (testing and development).
  */
-
-/**
- * Memory Storage configuration
- */
-type MemoryStorageConfig = {
-    /** Optional initial data */
-    initialData?: Map<string, Uint8Array>;
-};
-/**
- * Create an in-memory storage provider
- */
-declare const createMemoryStorage: (config?: MemoryStorageConfig) => StorageProvider;
-/**
- * Create memory storage with inspection methods (for testing)
- */
-declare const createMemoryStorageWithInspection: (config?: MemoryStorageConfig) => {
-    /** Clear all stored data */
-    clear: () => void;
-    /** Get number of stored items */
-    size: () => number;
-    /** Get all stored keys */
-    keys: () => string[];
-    /** Delete a specific key */
-    delete: (key: string) => boolean;
-    /** Get raw data map (for inspection) */
-    getData: () => Map<string, Uint8Array<ArrayBufferLike>>;
-    has: (key: string) => Promise<boolean>;
-    get: (key: string) => Promise<Uint8Array | null>;
-    put: (key: string, value: Uint8Array) => Promise<void>;
-};
-
-export { type MemoryStorageConfig, createMemoryStorage, createMemoryStorageWithInspection };
+export { createMemoryStorage, createMemoryStorageWithInspection, type MemoryStorageConfig, } from "./memory-storage.ts";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,mBAAmB,EACnB,iCAAiC,EACjC,KAAK,mBAAmB,GACzB,MAAM,qBAAqB,CAAC"}

package/dist/index.js

@@ -1,8 +1,7 @@
 // src/memory-storage.ts
 var createMemoryStorage = (config = {}) => {
-  const data = config.initialData ?? /* @__PURE__ */ new Map();
+  const data = config.initialData ?? new Map;
   return {
-    has: async (key) => data.has(key),
     get: async (key) => data.get(key) ?? null,
     put: async (key, value) => {
       data.set(key, value);
@@ -10,9 +9,8 @@ var createMemoryStorage = (config = {}) => {
   };
 };
 var createMemoryStorageWithInspection = (config = {}) => {
-  const data = config.initialData ?? /* @__PURE__ */ new Map();
+  const data = config.initialData ?? new Map;
   const storage = {
-    has: async (key) => data.has(key),
     get: async (key) => data.get(key) ?? null,
     put: async (key, value) => {
       data.set(key, value);
@@ -20,20 +18,16 @@ var createMemoryStorageWithInspection = (config = {}) => {
   };
   return {
     ...storage,
-    /** Clear all stored data */
     clear: () => data.clear(),
-    /** Get number of stored items */
     size: () => data.size,
-    /** Get all stored keys */
     keys: () => Array.from(data.keys()),
-    /** Delete a specific key */
     delete: (key) => data.delete(key),
-    /** Get raw data map (for inspection) */
     getData: () => data
   };
 };
 export {
-  createMemoryStorage,
-  createMemoryStorageWithInspection
+  createMemoryStorageWithInspection,
+  createMemoryStorage
 };
-//# sourceMappingURL=index.js.map
+
+//# debugId=64ED1D2374BB756B64756E2164756E21

package/dist/index.js.map

@@ -1 +1,10 @@
-{"version":3,"sources":["../src/memory-storage.ts"],"sourcesContent":["/**\n * In-Memory Storage Provider for CAS\n *\n * Useful for testing and local development.\n */\n\nimport type { StorageProvider } from \"@casfa/storage-core\";\n\n/**\n * Memory Storage configuration\n */\nexport type MemoryStorageConfig = {\n  /** Optional initial data */\n  initialData?: Map<string, Uint8Array>;\n};\n\n/**\n * Create an in-memory storage provider\n */\nexport const createMemoryStorage = (config: MemoryStorageConfig = {}): StorageProvider => {\n  const data = config.initialData ?? new Map<string, Uint8Array>();\n\n  return {\n    has: async (key) => data.has(key),\n    get: async (key) => data.get(key) ?? null,\n    put: async (key, value) => {\n      data.set(key, value);\n    },\n  };\n};\n\n/**\n * Create memory storage with inspection methods (for testing)\n */\nexport const createMemoryStorageWithInspection = (config: MemoryStorageConfig = {}) => {\n  const data = config.initialData ?? new Map<string, Uint8Array>();\n\n  const storage: StorageProvider = {\n    has: async (key) => data.has(key),\n    get: async (key) => data.get(key) ?? null,\n    put: async (key, value) => {\n      data.set(key, value);\n    },\n  };\n\n  return {\n    ...storage,\n    /** Clear all stored data */\n    clear: () => data.clear(),\n    /** Get number of stored items */\n    size: () => data.size,\n    /** Get all stored keys */\n    keys: () => Array.from(data.keys()),\n    /** Delete a specific key */\n    delete: (key: string) => data.delete(key),\n    /** Get raw data map (for inspection) */\n    getData: () => data,\n  };\n};\n"],"mappings":";AAmBO,IAAM,sBAAsB,CAAC,SAA8B,CAAC,MAAuB;AACxF,QAAM,OAAO,OAAO,eAAe,oBAAI,IAAwB;AAE/D,SAAO;AAAA,IACL,KAAK,OAAO,QAAQ,KAAK,IAAI,GAAG;AAAA,IAChC,KAAK,OAAO,QAAQ,KAAK,IAAI,GAAG,KAAK;AAAA,IACrC,KAAK,OAAO,KAAK,UAAU;AACzB,WAAK,IAAI,KAAK,KAAK;AAAA,IACrB;AAAA,EACF;AACF;AAKO,IAAM,oCAAoC,CAAC,SAA8B,CAAC,MAAM;AACrF,QAAM,OAAO,OAAO,eAAe,oBAAI,IAAwB;AAE/D,QAAM,UAA2B;AAAA,IAC/B,KAAK,OAAO,QAAQ,KAAK,IAAI,GAAG;AAAA,IAChC,KAAK,OAAO,QAAQ,KAAK,IAAI,GAAG,KAAK;AAAA,IACrC,KAAK,OAAO,KAAK,UAAU;AACzB,WAAK,IAAI,KAAK,KAAK;AAAA,IACrB;AAAA,EACF;AAEA,SAAO;AAAA,IACL,GAAG;AAAA;AAAA,IAEH,OAAO,MAAM,KAAK,MAAM;AAAA;AAAA,IAExB,MAAM,MAAM,KAAK;AAAA;AAAA,IAEjB,MAAM,MAAM,MAAM,KAAK,KAAK,KAAK,CAAC;AAAA;AAAA,IAElC,QAAQ,CAAC,QAAgB,KAAK,OAAO,GAAG;AAAA;AAAA,IAExC,SAAS,MAAM;AAAA,EACjB;AACF;","names":[]}
+{
+  "version": 3,
+  "sources": ["../src/memory-storage.ts"],
+  "sourcesContent": [
+    "/**\n * In-Memory Storage Provider for CAS\n *\n * Useful for testing and local development.\n */\n\nimport type { StorageProvider } from \"@casfa/storage-core\";\n\n/**\n * Memory Storage configuration\n */\nexport type MemoryStorageConfig = {\n  /** Optional initial data */\n  initialData?: Map<string, Uint8Array>;\n};\n\n/**\n * Create an in-memory storage provider\n */\nexport const createMemoryStorage = (config: MemoryStorageConfig = {}): StorageProvider => {\n  const data = config.initialData ?? new Map<string, Uint8Array>();\n\n  return {\n    get: async (key) => data.get(key) ?? null,\n    put: async (key, value) => {\n      data.set(key, value);\n    },\n  };\n};\n\n/**\n * Create memory storage with inspection methods (for testing)\n */\nexport const createMemoryStorageWithInspection = (config: MemoryStorageConfig = {}) => {\n  const data = config.initialData ?? new Map<string, Uint8Array>();\n\n  const storage: StorageProvider = {\n    get: async (key) => data.get(key) ?? null,\n    put: async (key, value) => {\n      data.set(key, value);\n    },\n  };\n\n  return {\n    ...storage,\n    /** Clear all stored data */\n    clear: () => data.clear(),\n    /** Get number of stored items */\n    size: () => data.size,\n    /** Get all stored keys */\n    keys: () => Array.from(data.keys()),\n    /** Delete a specific key */\n    delete: (key: string) => data.delete(key),\n    /** Get raw data map (for inspection) */\n    getData: () => data,\n  };\n};\n"
+  ],
+  "mappings": ";AAmBO,IAAM,sBAAsB,CAAC,SAA8B,CAAC,MAAuB;AAAA,EACxF,MAAM,OAAO,OAAO,eAAe,IAAI;AAAA,EAEvC,OAAO;AAAA,IACL,KAAK,OAAO,QAAQ,KAAK,IAAI,GAAG,KAAK;AAAA,IACrC,KAAK,OAAO,KAAK,UAAU;AAAA,MACzB,KAAK,IAAI,KAAK,KAAK;AAAA;AAAA,EAEvB;AAAA;AAMK,IAAM,oCAAoC,CAAC,SAA8B,CAAC,MAAM;AAAA,EACrF,MAAM,OAAO,OAAO,eAAe,IAAI;AAAA,EAEvC,MAAM,UAA2B;AAAA,IAC/B,KAAK,OAAO,QAAQ,KAAK,IAAI,GAAG,KAAK;AAAA,IACrC,KAAK,OAAO,KAAK,UAAU;AAAA,MACzB,KAAK,IAAI,KAAK,KAAK;AAAA;AAAA,EAEvB;AAAA,EAEA,OAAO;AAAA,OACF;AAAA,IAEH,OAAO,MAAM,KAAK,MAAM;AAAA,IAExB,MAAM,MAAM,KAAK;AAAA,IAEjB,MAAM,MAAM,MAAM,KAAK,KAAK,KAAK,CAAC;AAAA,IAElC,QAAQ,CAAC,QAAgB,KAAK,OAAO,GAAG;AAAA,IAExC,SAAS,MAAM;AAAA,EACjB;AAAA;",
+  "debugId": "64ED1D2374BB756B64756E2164756E21",
+  "names": []
+}

package/dist/memory-storage.d.ts

@@ -0,0 +1,35 @@
+/**
+ * In-Memory Storage Provider for CAS
+ *
+ * Useful for testing and local development.
+ */
+import type { StorageProvider } from "@casfa/storage-core";
+/**
+ * Memory Storage configuration
+ */
+export type MemoryStorageConfig = {
+    /** Optional initial data */
+    initialData?: Map<string, Uint8Array>;
+};
+/**
+ * Create an in-memory storage provider
+ */
+export declare const createMemoryStorage: (config?: MemoryStorageConfig) => StorageProvider;
+/**
+ * Create memory storage with inspection methods (for testing)
+ */
+export declare const createMemoryStorageWithInspection: (config?: MemoryStorageConfig) => {
+    /** Clear all stored data */
+    clear: () => void;
+    /** Get number of stored items */
+    size: () => number;
+    /** Get all stored keys */
+    keys: () => string[];
+    /** Delete a specific key */
+    delete: (key: string) => boolean;
+    /** Get raw data map (for inspection) */
+    getData: () => Map<string, Uint8Array<ArrayBufferLike>>;
+    get: (key: string) => Promise<Uint8Array | null>;
+    put: (key: string, value: Uint8Array) => Promise<void>;
+};
+//# sourceMappingURL=memory-storage.d.ts.map

package/dist/memory-storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory-storage.d.ts","sourceRoot":"","sources":["../src/memory-storage.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,4BAA4B;IAC5B,WAAW,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,GAAI,SAAQ,mBAAwB,KAAG,eAStE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iCAAiC,GAAI,SAAQ,mBAAwB;IAY9E,4BAA4B;;IAE5B,iCAAiC;;IAEjC,0BAA0B;;IAE1B,4BAA4B;kBACd,MAAM;IACpB,wCAAwC;;;;CAG3C,CAAC"}

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "@casfa/storage-memory",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "In-memory storage provider for CAS (testing)",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
+      "bun": "./src/index.ts",
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     }
   },
   "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
+    "build": "bun ../../scripts/build-pkg.ts",
     "typecheck": "tsc --noEmit",
     "lint": "biome check .",
     "lint:fix": "biome check --write .",