🚀 Socket Launch Week Day 5:Introducing Repository Access Permissions and Custom Roles.Learn more →
@fluojs/cache-manager
Advanced tools
@fluojs/cache-manager - npm Package Compare versions
@@ -1,1 +0,1 @@ | ||
| {"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../src/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAEnF,qFAAqF;AACrF,eAAO,MAAM,qBAAqB,eAAoC,CAAC;AAKvE,KAAK,mBAAmB,GAAG,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;AACxD,KAAK,yBAAyB,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,2BAA2B,KAAK,IAAI,CAAC;AAiCjG;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,sBAAsB,GAAG,yBAAyB,CAI/E;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,yBAAyB,CAItE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,wBAAwB,GAAG,yBAAyB,CAIrF;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,mBAAmB,GAAG,sBAAsB,GAAG,SAAS,CAEhG;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,GAAG,SAAS,CAQhF;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,mBAAmB,GAAG,wBAAwB,GAAG,SAAS,CAIpG"} | ||
| {"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../src/decorators.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAEnF,qFAAqF;AACrF,eAAO,MAAM,qBAAqB,eAAoC,CAAC;AAKvE,KAAK,mBAAmB,GAAG,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;AACxD,KAAK,yBAAyB,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,2BAA2B,KAAK,IAAI,CAAC;AAmCjG;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,sBAAsB,GAAG,yBAAyB,CAI/E;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,yBAAyB,CAItE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,wBAAwB,GAAG,yBAAyB,CAIrF;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,mBAAmB,GAAG,sBAAsB,GAAG,SAAS,CAEhG;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,GAAG,SAAS,CAQhF;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,mBAAmB,GAAG,wBAAwB,GAAG,SAAS,CAIpG"} |
@@ -0,1 +1,2 @@ | ||
| import { ensureMetadataSymbol } from '@fluojs/core/internal'; | ||
| /** Shared controller metadata key used to store per-route cache metadata records. */ | ||
@@ -6,2 +7,3 @@ export const cacheRouteMetadataKey = Symbol.for('fluo.standard.route'); | ||
| const cacheEvictMetadataKey = Symbol.for('fluo.cache.evict'); | ||
| ensureMetadataSymbol(); | ||
| function getMetadataBag(metadata) { | ||
@@ -8,0 +10,0 @@ return metadata; |
+4
-4
@@ -13,3 +13,3 @@ { | ||
| ], | ||
| "version": "1.0.0-beta.5", | ||
| "version": "1.0.0-beta.6", | ||
| "private": false, | ||
@@ -41,6 +41,6 @@ "license": "MIT", | ||
| "dependencies": { | ||
| "@fluojs/core": "^1.0.0-beta.3", | ||
| "@fluojs/core": "^1.0.0-beta.4", | ||
| "@fluojs/di": "^1.0.0-beta.6", | ||
| "@fluojs/http": "^1.0.0-beta.9", | ||
| "@fluojs/runtime": "^1.0.0-beta.9" | ||
| "@fluojs/http": "^1.0.0-beta.10", | ||
| "@fluojs/runtime": "^1.0.0-beta.11" | ||
| }, | ||
@@ -47,0 +47,0 @@ "peerDependencies": { |
+16
-6
@@ -5,3 +5,3 @@ # @fluojs/cache-manager | ||
| 메모리(Memory) 및 Redis 저장소 어댑터를 지원하는 fluo 애플리케이션용 범용 캐시 관리 패키지입니다. 데코레이터 기반의 HTTP 응답 캐싱과 프로그래밍 방식의 애플리케이션 레벨 캐시 API를 모두 제공합니다. | ||
| 메모리(Memory), Redis, custom store 어댑터를 지원하는 fluo 애플리케이션용 범용 캐시 관리 패키지입니다. 데코레이터 기반의 HTTP 응답 캐싱과 프로그래밍 방식의 애플리케이션 레벨 캐시 API를 모두 제공합니다. | ||
@@ -131,3 +131,3 @@ ## 목차 | ||
| 기본적으로 캐시 키는 쿼리 매개변수를 무시하고 구체적인 요청 경로만 사용합니다. 검색 조건 등에 따라 다른 응답을 캐싱하려면 `httpKeyStrategy: 'route+query'`를 활성화하세요. 내장 전략에서는 `full`도 동일하게 query-aware 키를 만듭니다. query-aware 키는 매개변수 이름과 반복 값 모두를 정규화하므로 `/products?tag=a&tag=b`와 `/products?tag=b&tag=a`는 같은 캐시 엔트리를 공유합니다. | ||
| 기본적으로 익명 요청은 구체적인 요청 경로만 사용하고 쿼리 매개변수를 무시합니다. 인증된 요청은 principal scope가 있으면 이를 suffix로 덧붙이며, `principalScopeResolver`로 이 suffix를 커스터마이즈할 수 있습니다. 검색 조건 등에 따라 다른 응답을 캐싱하려면 `httpKeyStrategy: 'route+query'`를 활성화하세요. 내장 전략에서는 `full`도 동일하게 query-aware 키를 만듭니다. query-aware 키는 매개변수 이름과 반복 값 모두를 정규화하므로 `/products?tag=a&tag=b`와 `/products?tag=b&tag=a`는 같은 캐시 엔트리를 공유합니다. | ||
@@ -141,2 +141,4 @@ ```typescript | ||
| 완전히 다른 키 전략이 필요하다면 `httpKeyStrategy`에 함수를 전달하거나, literal key 또는 key factory를 받는 `@CacheKey(...)`를 사용하세요. | ||
| ### 캐시 소유권과 reset 범위 | ||
@@ -157,2 +159,4 @@ | ||
| `CacheStore` 계약을 구현한 custom store는 `store` 옵션에 직접 전달할 수 있습니다. in-process LRU store, Redis 외 원격 캐시, 또는 cache operation을 관찰해야 하는 테스트 더블에 적합합니다. | ||
| ### 수동 모듈 조합 | ||
@@ -189,3 +193,3 @@ | ||
| ### 모듈 | ||
| - `CacheModule.forRoot(options)`: 캐시 저장소(memory/redis), 기본 TTL, 키 전략 등을 설정합니다. | ||
| - `CacheModule.forRoot(options)`: 캐시 저장소(memory/redis/custom), 기본 TTL, 키 전략, `isGlobal`, `principalScopeResolver`, `redis.scanCount` 같은 Redis 옵션을 설정합니다. | ||
| 애플리케이션 모듈에서 사용하는 기본 패키지 진입점입니다. | ||
@@ -195,8 +199,8 @@ | ||
| ### 서비스 | ||
| - `CacheService`: 수동 캐시 작업(`get`, `set`, `del`, `remember`, `reset`)을 위한 기본 API입니다. | ||
| - `CacheService`: 수동 캐시 작업(`get`, `set`, `del`, `remember`, `reset`, `close`)을 위한 기본 API입니다. | ||
| ### 데코레이터 | ||
| - `@CacheTTL(seconds)`: 특정 핸들러의 TTL을 설정합니다. | ||
| - `@CacheKey(key)`: 특정 핸들러의 커스텀 캐시 키를 설정합니다. | ||
| - `@CacheEvict(key)`: 성공적인 데이터 변경(POST/PUT/DELETE) 후 특정 캐시 키를 삭제합니다. | ||
| - `@CacheKey(key)`: 특정 핸들러의 custom cache key 또는 key factory를 설정합니다. | ||
| - `@CacheEvict(key)`: 성공적인 non-GET 핸들러가 완료된 뒤 하나 이상의 cache key를 삭제합니다. | ||
@@ -206,2 +210,7 @@ ### 인터셉터 | ||
| ### 저장소와 status helper | ||
| - `MemoryStore`, `RedisStore`: 내장 store 구현입니다. | ||
| - `CACHE_OPTIONS`, `CACHE_STORE`: 패키지 내부와 custom composition에서 사용하는 DI 토큰입니다. | ||
| - `createCacheManagerPlatformStatusSnapshot(...)`, `createCacheManagerPlatformDiagnosticIssues(...)`: 플랫폼 status와 diagnostic helper입니다. | ||
| ## 관련 패키지 | ||
@@ -217,1 +226,2 @@ | ||
| - `packages/cache-manager/src/service.ts`: 코어 `CacheService` 구현. | ||
| - `packages/cache-manager/src/status.test.ts`: status 및 diagnostic helper 테스트. |
+16
-6
@@ -5,3 +5,3 @@ # @fluojs/cache-manager | ||
| General-purpose cache manager for fluo with pluggable memory and Redis stores. Provides both decorator-driven HTTP response caching and a standalone cache API for application-level caching. | ||
| General-purpose cache manager for fluo with pluggable memory, Redis, and custom store adapters. Provides both decorator-driven HTTP response caching and a standalone cache API for application-level caching. | ||
@@ -131,3 +131,3 @@ ## Table of Contents | ||
| By default, the cache key ignores query parameters and uses only the concrete request path. Enable `httpKeyStrategy: 'route+query'` (or `full`, which is equivalent for the built-in strategy set) to cache different responses for different search parameters. Query-aware keys canonicalize both parameter names and repeated values, so `/products?tag=a&tag=b` and `/products?tag=b&tag=a` share one cache entry. | ||
| By default, anonymous requests use the concrete request path and ignore query parameters. Authenticated requests append a principal scope when one is available; use `principalScopeResolver` to customize that suffix. Enable `httpKeyStrategy: 'route+query'` (or `full`, which is equivalent for the built-in strategy set) to cache different responses for different search parameters. Query-aware keys canonicalize both parameter names and repeated values, so `/products?tag=a&tag=b` and `/products?tag=b&tag=a` share one cache entry. | ||
@@ -141,2 +141,4 @@ ```typescript | ||
| For fully custom keying, pass a function as `httpKeyStrategy` or use `@CacheKey(...)` with either a literal key or a key factory. | ||
| ### Cache Ownership and Reset Scope | ||
@@ -157,2 +159,4 @@ | ||
| Custom stores can be passed directly through `store` when they implement the `CacheStore` contract. This is the right option for in-process LRU stores, remote caches other than Redis, or test doubles that need to observe cache operations. | ||
| ### Manual Module Composition | ||
@@ -189,3 +193,3 @@ | ||
| ### Modules | ||
| - `CacheModule.forRoot(options)`: Configures the cache store (memory/redis), default TTL, and key strategies. | ||
| - `CacheModule.forRoot(options)`: Configures the cache store (memory/redis/custom), default TTL, key strategies, `isGlobal`, `principalScopeResolver`, and Redis options such as `redis.scanCount`. | ||
| This is the primary package entrypoint for application modules. | ||
@@ -195,8 +199,8 @@ | ||
| ### Services | ||
| - `CacheService`: Main API for manual cache operations (`get`, `set`, `del`, `remember`, `reset`). | ||
| - `CacheService`: Main API for manual cache operations (`get`, `set`, `del`, `remember`, `reset`, `close`). | ||
| ### Decorators | ||
| - `@CacheTTL(seconds)`: Sets the TTL for a specific handler. | ||
| - `@CacheKey(key)`: Sets a custom cache key for a specific handler. | ||
| - `@CacheEvict(key)`: Clears specific cache keys after a successful mutation (POST/PUT/DELETE). | ||
| - `@CacheKey(key)`: Sets a custom cache key or key factory for a specific handler. | ||
| - `@CacheEvict(key)`: Clears one or more cache keys after a successful non-GET handler completes. | ||
@@ -206,2 +210,7 @@ ### Interceptors | ||
| ### Stores and status helpers | ||
| - `MemoryStore` and `RedisStore`: Built-in store implementations. | ||
| - `CACHE_OPTIONS` and `CACHE_STORE`: DI tokens for package internals and custom composition. | ||
| - `createCacheManagerPlatformStatusSnapshot(...)` and `createCacheManagerPlatformDiagnosticIssues(...)`: Platform status and diagnostic helpers. | ||
| ## Related Packages | ||
@@ -217,1 +226,2 @@ | ||
| - `packages/cache-manager/src/service.ts`: Core `CacheService` implementation. | ||
| - `packages/cache-manager/src/status.test.ts`: Status and diagnostic helper tests. |
No alert changes
Improved metrics
- Total package byte prevSize
87029
2.66%- Lines of code
1395
0.14%- Number of lines in readme file
220
4.76%Dependency changes
Updated
@fluojs/core@^1.0.0-beta.4Updated
@fluojs/http@^1.0.0-beta.10