@hazeljs/cache 0.2.0-alpha.1

package/LICENSE

@@ -0,0 +1,192 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   Copyright 2024 HazelJS Team
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+---
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+   Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+   stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+   that You distribute, all copyright, patent, trademark, and
+   attribution notices from the Source form of the Work,
+   excluding those notices that do not pertain to any part of
+   the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+   distribution, then any Derivative Works that You distribute must
+   include a readable copy of the attribution notices contained
+   within such NOTICE file, excluding those notices that do not
+   pertain to any part of the Derivative Works, in at least one
+   of the following places: within a NOTICE text file distributed
+   as part of the Derivative Works; within the Source form or
+   documentation, if provided along with the Derivative Works; or,
+   within a display generated by the Derivative Works, if and
+   wherever such third-party notices normally appear. The contents
+   of the NOTICE file are for informational purposes only and
+   do not modify the License. You may add Your own attribution
+   notices within Derivative Works that You distribute, alongside
+   or as an addendum to the NOTICE text from the Work, provided
+   that such additional attribution notices cannot be construed
+   as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,524 @@
+# @hazeljs/cache
+
+**Cache with one decorator. Invalidate with another.**
+
+Memory, Redis, or hybrid. `@Cache` for results, `@CacheEvict` for invalidation. Tag-based, TTL, warming, stats. Stop writing cache logic by hand.
+
+[![npm version](https://img.shields.io/npm/v/@hazeljs/cache.svg)](https://www.npmjs.com/package/@hazeljs/cache)
+[![npm downloads](https://img.shields.io/npm/dm/@hazeljs/cache)](https://www.npmjs.com/package/@hazeljs/cache)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+## Features
+
+- 💾 **Multiple Strategies** - Memory, Redis, and CDN caching
+- 🎨 **Decorator-Based API** - `@Cache`, `@CacheEvict`, `@CacheTTL`
+- 🏷️ **Tag-Based Management** - Group and invalidate related caches
+- ⏰ **TTL Support** - Automatic expiration
+- 🔄 **Cache Warming** - Pre-populate cache on startup
+- 📊 **Statistics** - Hit/miss rates and performance metrics
+- 🔑 **Key Generation** - Automatic and custom key generation
+- 🧹 **Auto Cleanup** - Automatic removal of expired entries
+
+## Installation
+
+```bash
+npm install @hazeljs/cache
+```
+
+### Optional Dependencies
+
+```bash
+# For Redis caching
+npm install ioredis
+```
+
+## Quick Start
+
+### Memory Cache
+
+```typescript
+import { CacheModule } from '@hazeljs/cache';
+
+@HazelModule({
+  imports: [
+    CacheModule.forRoot({
+      strategy: 'memory',
+      ttl: 3600, // 1 hour
+      max: 1000, // Max 1000 entries
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+### Using Cache Decorator
+
+```typescript
+import { Injectable } from '@hazeljs/core';
+import { Cache, CacheEvict } from '@hazeljs/cache';
+
+@Injectable()
+export class ProductService {
+  @Cache({
+    key: 'product-{id}',
+    ttl: 3600,
+  })
+  async findOne(id: string) {
+    // Expensive database query - cached for 1 hour
+    return await this.db.product.findUnique({ where: { id } });
+  }
+
+  @Cache({
+    key: 'products-all',
+    ttl: 1800,
+  })
+  async findAll() {
+    return await this.db.product.findMany();
+  }
+
+  @CacheEvict({
+    keys: ['product-{id}', 'products-all'],
+  })
+  async update(id: string, data: any) {
+    return await this.db.product.update({
+      where: { id },
+      data,
+    });
+  }
+
+  @CacheEvict({
+    keys: ['product-*'], // Wildcard pattern
+  })
+  async deleteAll() {
+    return await this.db.product.deleteMany();
+  }
+}
+```
+
+## Cache Strategies
+
+### Memory Cache (Development)
+
+```typescript
+CacheModule.forRoot({
+  strategy: 'memory',
+  ttl: 3600,
+  max: 1000,
+  updateAgeOnGet: true,
+})
+```
+
+**Best for:** Development, testing, single-instance applications
+
+### Redis Cache (Production)
+
+```typescript
+import Redis from 'ioredis';
+
+const redis = new Redis({
+  host: 'localhost',
+  port: 6379,
+  password: 'your-password',
+  db: 0,
+});
+
+CacheModule.forRoot({
+  strategy: 'redis',
+  redis: redis,
+  ttl: 3600,
+  keyPrefix: 'myapp:',
+})
+```
+
+**Best for:** Production, distributed systems, shared cache
+
+### Hybrid Cache
+
+```typescript
+CacheModule.forRoot({
+  strategy: 'hybrid',
+  memory: {
+    ttl: 300, // 5 minutes in memory
+    max: 100,
+  },
+  redis: {
+    client: redis,
+    ttl: 3600, // 1 hour in Redis
+    keyPrefix: 'myapp:',
+  },
+})
+```
+
+**Best for:** High-performance applications, frequently accessed data
+
+## Decorators
+
+### @Cache()
+
+Cache method results:
+
+```typescript
+@Cache({
+  key: 'user-{id}',
+  ttl: 3600,
+  strategy: 'redis',
+})
+async getUser(id: string) {
+  return await this.userService.findOne(id);
+}
+
+// Dynamic key generation
+@Cache({
+  key: (args) => `search-${args[0]}-${args[1]}`,
+  ttl: 1800,
+})
+async search(query: string, page: number) {
+  return await this.searchService.search(query, page);
+}
+```
+
+### @CacheEvict()
+
+Invalidate cache entries:
+
+```typescript
+// Evict specific keys
+@CacheEvict({
+  keys: ['user-{id}'],
+})
+async updateUser(id: string, data: any) {
+  return await this.userService.update(id, data);
+}
+
+// Evict multiple keys
+@CacheEvict({
+  keys: ['user-{id}', 'users-all', 'users-active'],
+})
+async deleteUser(id: string) {
+  return await this.userService.delete(id);
+}
+
+// Evict by pattern
+@CacheEvict({
+  keys: ['user-*'],
+})
+async clearAllUsers() {
+  return await this.userService.deleteAll();
+}
+
+// Evict by tags
+@CacheEvict({
+  tags: ['users', 'profiles'],
+})
+async updateUserProfile(id: string, data: any) {
+  return await this.userService.updateProfile(id, data);
+}
+```
+
+### @CacheTTL()
+
+Set TTL dynamically:
+
+```typescript
+@Cache({ key: 'data-{id}' })
+@CacheTTL((result) => {
+  // Cache premium users for 1 hour, others for 5 minutes
+  return result.isPremium ? 3600 : 300;
+})
+async getData(id: string) {
+  return await this.dataService.find(id);
+}
+```
+
+## Tag-Based Caching
+
+Group related cache entries with tags:
+
+```typescript
+@Injectable()
+export class ProductService {
+  @Cache({
+    key: 'product-{id}',
+    tags: ['products', 'catalog'],
+    ttl: 3600,
+  })
+  async findOne(id: string) {
+    return await this.db.product.findUnique({ where: { id } });
+  }
+
+  @Cache({
+    key: 'products-featured',
+    tags: ['products', 'featured'],
+    ttl: 1800,
+  })
+  async findFeatured() {
+    return await this.db.product.findMany({ where: { featured: true } });
+  }
+
+  // Invalidate all product-related caches
+  @CacheEvict({
+    tags: ['products'],
+  })
+  async updateProduct(id: string, data: any) {
+    return await this.db.product.update({ where: { id }, data });
+  }
+}
+```
+
+## Direct Cache Service Usage
+
+```typescript
+import { Injectable } from '@hazeljs/core';
+import { CacheService } from '@hazeljs/cache';
+
+@Injectable()
+export class MyService {
+  constructor(private cacheService: CacheService) {}
+
+  async getData(key: string) {
+    // Get from cache
+    const cached = await this.cacheService.get(key);
+    if (cached) return cached;
+
+    // Fetch data
+    const data = await this.fetchData(key);
+
+    // Store in cache
+    await this.cacheService.set(key, data, 3600);
+
+    return data;
+  }
+
+  async invalidate(key: string) {
+    await this.cacheService.del(key);
+  }
+
+  async invalidatePattern(pattern: string) {
+    await this.cacheService.delPattern(pattern);
+  }
+
+  async invalidateTags(tags: string[]) {
+    await this.cacheService.delByTags(tags);
+  }
+}
+```
+
+## Cache Warming
+
+Pre-populate cache on application startup:
+
+```typescript
+import { Injectable, OnModuleInit } from '@hazeljs/core';
+import { CacheService } from '@hazeljs/cache';
+
+@Injectable()
+export class CacheWarmer implements OnModuleInit {
+  constructor(
+    private cacheService: CacheService,
+    private productService: ProductService
+  ) {}
+
+  async onModuleInit() {
+    // Warm up featured products cache
+    const featured = await this.productService.findFeatured();
+    await this.cacheService.set('products-featured', featured, 3600);
+
+    // Warm up categories cache
+    const categories = await this.productService.findCategories();
+    await this.cacheService.set('categories-all', categories, 7200);
+
+    console.log('Cache warmed up successfully');
+  }
+}
+```
+
+## Statistics
+
+Monitor cache performance:
+
+```typescript
+const stats = await cacheService.getStats();
+
+console.log('Hits:', stats.hits);
+console.log('Misses:', stats.misses);
+console.log('Hit Rate:', stats.hitRate);
+console.log('Total Keys:', stats.keys);
+console.log('Memory Usage:', stats.memoryUsage);
+```
+
+## Advanced Configuration
+
+### Custom Key Generator
+
+```typescript
+CacheModule.forRoot({
+  strategy: 'redis',
+  redis: redis,
+  keyGenerator: (target, methodName, args) => {
+    return `${target.constructor.name}:${methodName}:${JSON.stringify(args)}`;
+  },
+})
+```
+
+### Conditional Caching
+
+```typescript
+@Cache({
+  key: 'user-{id}',
+  condition: (args, result) => {
+    // Only cache if user is active
+    return result?.status === 'active';
+  },
+})
+async getUser(id: string) {
+  return await this.userService.findOne(id);
+}
+```
+
+### Cache Compression
+
+```typescript
+CacheModule.forRoot({
+  strategy: 'redis',
+  redis: redis,
+  compression: {
+    enabled: true,
+    threshold: 1024, // Compress if > 1KB
+  },
+})
+```
+
+## API Reference
+
+### CacheService
+
+```typescript
+class CacheService {
+  get<T>(key: string): Promise<T | null>;
+  set(key: string, value: any, ttl?: number): Promise<void>;
+  del(key: string): Promise<void>;
+  delPattern(pattern: string): Promise<void>;
+  delByTags(tags: string[]): Promise<void>;
+  has(key: string): Promise<boolean>;
+  clear(): Promise<void>;
+  getStats(): Promise<CacheStats>;
+  keys(pattern?: string): Promise<string[]>;
+}
+```
+
+### Decorators
+
+```typescript
+@Cache({
+  key: string | ((args: any[]) => string);
+  ttl?: number;
+  strategy?: 'memory' | 'redis' | 'hybrid';
+  tags?: string[];
+  condition?: (args: any[], result: any) => boolean;
+})
+
+@CacheEvict({
+  keys?: string[];
+  tags?: string[];
+  allEntries?: boolean;
+})
+
+@CacheTTL((result: any) => number)
+```
+
+## Use Cases
+
+### API Response Caching
+
+```typescript
+@Controller('/api')
+export class ApiController {
+  @Get('/products')
+  @Cache({
+    key: 'api-products-{page}-{limit}',
+    ttl: 300,
+    tags: ['api', 'products'],
+  })
+  async getProducts(
+    @Query('page') page: number,
+    @Query('limit') limit: number
+  ) {
+    return await this.productService.findAll(page, limit);
+  }
+}
+```
+
+### Database Query Caching
+
+```typescript
+@Injectable()
+export class UserRepository {
+  @Cache({
+    key: 'db-user-{id}',
+    ttl: 3600,
+    tags: ['database', 'users'],
+  })
+  async findById(id: string) {
+    return await this.prisma.user.findUnique({ where: { id } });
+  }
+
+  @CacheEvict({
+    keys: ['db-user-{id}'],
+    tags: ['users'],
+  })
+  async update(id: string, data: any) {
+    return await this.prisma.user.update({ where: { id }, data });
+  }
+}
+```
+
+### Computed Results Caching
+
+```typescript
+@Injectable()
+export class AnalyticsService {
+  @Cache({
+    key: 'analytics-{startDate}-{endDate}',
+    ttl: 7200, // 2 hours
+    tags: ['analytics'],
+  })
+  async getReport(startDate: string, endDate: string) {
+    // Expensive computation
+    return await this.computeAnalytics(startDate, endDate);
+  }
+}
+```
+
+## Best Practices
+
+- **Use appropriate TTL** - Short TTL for frequently changing data, long TTL for static data
+- **Tag related caches** - Group caches that should be invalidated together
+- **Monitor hit rates** - Adjust caching strategy based on statistics
+- **Use Redis for production** - Memory cache is only for development
+- **Invalidate proactively** - Clear cache when data changes
+- **Avoid caching user-specific data** - Unless using user-specific keys
+
+## Examples
+
+See the [examples](../../example/src/cache) directory for complete working examples.
+
+## Testing
+
+```bash
+npm test
+```
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](../../CONTRIBUTING.md) for details.
+
+## License
+
+Apache 2.0 © [HazelJS](https://hazeljs.com)
+
+## Links
+
+- [Documentation](https://hazeljs.com/docs/packages/cache)
+- [GitHub](https://github.com/hazel-js/hazeljs)
+- [Issues](https://github.com/hazel-js/hazeljs/issues)
+- [Discord](https://discord.com/channels/1448263814238965833/1448263814859456575)