@parsrun/cache 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,140 @@
+import { CacheServiceConfig, CacheGetOptions, CacheSetOptions } from './types.js';
+export { CacheAdapter, CacheAdapterType, CacheDeleteOptions, CacheEntry, CacheError, CacheErrorCodes, CloudflareKVCacheConfig, KVNamespace, MemoryCacheConfig, RedisCacheConfig, UpstashCacheConfig } from './types.js';
+export { MemoryCacheAdapter, createMemoryCacheAdapter } from './adapters/memory.js';
+export { RedisCacheAdapter, createRedisCacheAdapter } from './adapters/redis.js';
+export { UpstashCacheAdapter, createUpstashCacheAdapter } from './adapters/upstash.js';
+export { CloudflareKVCacheAdapter, createCloudflareKVCacheAdapter } from './adapters/cloudflare-kv.js';
+export { CacheConfig, CacheGetResult, CacheStats, MultiTierCacheConfig, CacheSetOptions as ParsCacheSetOptions, CloudflareKvConfig as ParsCloudflareKvConfig, MemoryCacheConfig as ParsMemoryCacheConfig, RedisCacheConfig as ParsRedisCacheConfig, UpstashCacheConfig as ParsUpstashCacheConfig, cacheConfig, cacheGetResult, cacheStats, cloudflareKvConfig, memoryCacheConfig, multiTierCacheConfig, cacheSetOptions as parsCacheSetOptions, redisCacheConfig, type, upstashCacheConfig } from '@parsrun/types';
+
+/**
+ * @parsrun/cache
+ * Edge-compatible caching for Pars
+ *
+ * Supports multiple adapters:
+ * - Memory (development)
+ * - Redis/ioredis (Node.js)
+ * - Upstash (Edge)
+ * - Cloudflare KV (Workers)
+ *
+ * @example
+ * ```typescript
+ * import { createCacheService, createMemoryCacheAdapter } from '@parsrun/cache';
+ *
+ * const cache = createCacheService({
+ *   adapter: createMemoryCacheAdapter(),
+ *   defaultTtl: 3600,
+ *   keyPrefix: 'myapp',
+ * });
+ *
+ * await cache.set('user:123', { name: 'John' });
+ * const user = await cache.get('user:123');
+ * ```
+ */
+
+/**
+ * Cache Service
+ * High-level cache service with prefix and default TTL support
+ */
+declare class CacheService {
+    private adapter;
+    private defaultTtl;
+    private keyPrefix;
+    private debug;
+    constructor(config: CacheServiceConfig);
+    private prefixKey;
+    /**
+     * Get adapter type
+     */
+    get adapterType(): string;
+    /**
+     * Get a value from cache
+     */
+    get<T = unknown>(key: string, options?: CacheGetOptions): Promise<T | null>;
+    /**
+     * Set a value in cache
+     */
+    set<T = unknown>(key: string, value: T, options?: CacheSetOptions): Promise<void>;
+    /**
+     * Delete a value from cache
+     */
+    delete(key: string): Promise<void>;
+    /**
+     * Check if a key exists in cache
+     */
+    has(key: string): Promise<boolean>;
+    /**
+     * Clear all entries from cache
+     */
+    clear(): Promise<void>;
+    /**
+     * Get multiple values at once
+     */
+    getMany<T = unknown>(keys: string[]): Promise<Map<string, T | null>>;
+    /**
+     * Set multiple values at once
+     */
+    setMany<T = unknown>(entries: Map<string, T>, options?: CacheSetOptions): Promise<void>;
+    /**
+     * Delete multiple keys
+     */
+    deleteMany(keys: string[]): Promise<void>;
+    /**
+     * Invalidate entries by tags
+     */
+    invalidateByTags(tags: string[]): Promise<void>;
+    /**
+     * Get TTL for a key (in seconds)
+     * @returns TTL in seconds, -1 if no expiry, -2 if key doesn't exist
+     */
+    ttl(key: string): Promise<number>;
+    /**
+     * Get or set a value with callback
+     * @param key Cache key
+     * @param fn Function to compute value if not cached
+     * @param options Set options (applied if value is computed)
+     */
+    getOrSet<T>(key: string, fn: () => T | Promise<T>, options?: CacheSetOptions): Promise<T>;
+    /**
+     * Wrap a function with caching
+     */
+    wrap<TArgs extends unknown[], TReturn>(fn: (...args: TArgs) => Promise<TReturn>, keyFn: (...args: TArgs) => string, options?: CacheSetOptions): (...args: TArgs) => Promise<TReturn>;
+    /**
+     * Close/cleanup cache resources
+     */
+    close(): Promise<void>;
+}
+/**
+ * Create a cache service
+ *
+ * @example
+ * ```typescript
+ * // With Memory (development)
+ * const cache = createCacheService({
+ *   adapter: createMemoryCacheAdapter(),
+ *   defaultTtl: 3600,
+ * });
+ *
+ * // With Upstash (Edge)
+ * const cache = createCacheService({
+ *   adapter: createUpstashCacheAdapter({
+ *     url: process.env.UPSTASH_REDIS_REST_URL,
+ *     token: process.env.UPSTASH_REDIS_REST_TOKEN,
+ *   }),
+ *   defaultTtl: 3600,
+ * });
+ *
+ * // With Cloudflare KV (Workers)
+ * const cache = createCacheService({
+ *   adapter: createCloudflareKVCacheAdapter({
+ *     namespace: env.CACHE_KV,
+ *   }),
+ * });
+ * ```
+ */
+declare function createCacheService(config: CacheServiceConfig): CacheService;
+declare const _default: {
+    CacheService: typeof CacheService;
+    createCacheService: typeof createCacheService;
+};
+
+export { CacheGetOptions, CacheService, CacheServiceConfig, CacheSetOptions, createCacheService, _default as default };