@j0hanz/superfetch 2.5.2 → 2.6.0

package/dist/cache.d.ts

@@ -1,5 +1,12 @@
 import type { ServerResponse } from 'node:http';
+import { z } from 'zod';
 import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+declare const CachedPayloadSchema: z.ZodObject<{
+    content: z.ZodOptional<z.ZodString>;
+    markdown: z.ZodOptional<z.ZodString>;
+    title: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type CachedPayload = z.infer<typeof CachedPayloadSchema>;
 export interface CacheEntry {
     url: string;
     title?: string;
@@ -7,38 +14,39 @@ export interface CacheEntry {
     fetchedAt: string;
     expiresAt: string;
 }
-export interface CachedPayload {
-    content?: string;
-    markdown?: string;
-    title?: string;
-}
-export interface CacheKeyParts {
-    namespace: string;
-    urlHash: string;
-}
 export interface McpIcon {
     src: string;
     mimeType: string;
-    sizes: string[];
+    sizes?: string[];
 }
-export declare function parseCachedPayload(raw: string): CachedPayload | null;
-export declare function resolveCachedPayloadContent(payload: CachedPayload): string | null;
-export declare function createCacheKey(namespace: string, url: string, vary?: Record<string, unknown> | string): string | null;
-export declare function parseCacheKey(cacheKey: string): CacheKeyParts | null;
-export declare function toResourceUri(cacheKey: string): string | null;
-interface CacheUpdateEvent {
-    cacheKey: string;
+export interface CacheKeyParts {
     namespace: string;
     urlHash: string;
 }
-type CacheUpdateListener = (event: CacheUpdateEvent) => void;
+export interface CacheSetOptions {
+    force?: boolean;
+}
+export interface CacheGetOptions {
+    force?: boolean;
+}
 interface CacheEntryMetadata {
     url: string;
     title?: string;
 }
+interface CacheUpdateEvent {
+    cacheKey: string;
+    namespace: string;
+    urlHash: string;
+}
+type CacheUpdateListener = (event: CacheUpdateEvent) => unknown;
+export declare function parseCachedPayload(raw: string): CachedPayload | null;
+export declare function resolveCachedPayloadContent(payload: CachedPayload): string | null;
+export declare function createCacheKey(namespace: string, url: string, vary?: Record<string, unknown> | string): string | null;
+export declare function parseCacheKey(cacheKey: string): CacheKeyParts | null;
+export declare function toResourceUri(cacheKey: string): string | null;
 export declare function onCacheUpdate(listener: CacheUpdateListener): () => void;
-export declare function get(cacheKey: string | null): CacheEntry | undefined;
-export declare function set(cacheKey: string | null, content: string, metadata: CacheEntryMetadata): void;
+export declare function get(cacheKey: string | null, options?: CacheGetOptions): CacheEntry | undefined;
+export declare function set(cacheKey: string | null, content: string, metadata: CacheEntryMetadata, options?: CacheSetOptions): void;
 export declare function keys(): readonly string[];
 export declare function isEnabled(): boolean;
 export declare function registerCachedContentResource(server: McpServer, serverIcons?: McpIcon[]): void;