@zuplo/runtime 6.55.0 → 6.55.2

package/out/types/index.d.ts

@@ -4801,19 +4801,46 @@ export declare type McpToolHandler<TArgs = any> = (
   context: ZuploContext
 ) => Promise<CallToolResult> | CallToolResult;
 
+declare interface MemoryCacheOptions {
+  maxSize: number;
+}
+
 /**
  * A two-tier cache that combines in-memory caching with zone-level caching.
  * Data is first checked in memory cache for fastest access, then falls back to
  * zone cache if not found. Writes update both cache tiers.
  *
+ * The in memory cache is an LRU cache that will evict the least recently used items
+ * when the cache is full. The in memory cache is also periodically purged of
+ * expired items.
+ *
+ * In the event that two MemoryZoneReadThroughCache instances are created
+ * with the same name, they will share the same underlying in-memory cache. This
+ * allows for multiple instances to be created in different parts of the codebase
+ * without having to pass the cache instance around. If two instances are created
+ * with the same name, but different memory cache options, the options of the
+ * first instance created will be used.
+ *
+ *
+ *
  * @public
  * @example
  * ```typescript
  * import { MemoryZoneReadThroughCache, ZuploContext } from "@zuplo/runtime";
  *
  * export async function myHandler(request: ZuploRequest, context: ZuploContext) {
+ *   // Create cache with default memory size (1000 items)
  *   const cache = new MemoryZoneReadThroughCache<UserData>("user-cache", context);
  *
+ *   // Or create cache with custom memory size (500 items max)
+ *   // Note that maxSize controls the number of items in the in-memory cache,
+ *   // but does not limit the number of items in the zone cache.
+ *   const limitedCache = new MemoryZoneReadThroughCache<UserData>(
+ *     "limited-cache",
+ *     context,
+ *     { maxSize: 500 }
+ *   );
+ *
  *   // Try to get cached data
  *   const cachedUser = await cache.get("user-123");
  *   if (cachedUser) {
@@ -4836,8 +4863,13 @@ export declare class MemoryZoneReadThroughCache<T = unknown> {
    * Creates a new MemoryZoneReadThroughCache instance.
    * @param name - A unique name for this cache instance
    * @param context - The ZuploContext from the current request
+   * @param options - Optional configuration for the memory cache
    */
-  constructor(name: string, context: ZuploContext);
+  constructor(
+    name: string,
+    context: ZuploContext,
+    options?: MemoryCacheOptions
+  );
   /**
    * Retrieves a value from the cache by key. First checks memory cache,
    * then falls back to zone cache if not found in memory.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zuplo/runtime",
   "type": "module",
-  "version": "6.55.0",
+  "version": "6.55.2",
   "repository": "https://github.com/zuplo/zuplo",
   "author": "Zuplo, Inc.",
   "exports": {