feat: remove clearClientSnapshots

Author: tilyupo

packages/next/README.md

@@ -63,7 +63,7 @@ export function ThemeToggle() {
 
 ### Pages Router
 
-**1. Set up ReplaneProvider in _app.tsx:**
+**1. Set up ReplaneProvider in \_app.tsx:**
 
 ```tsx
 // pages/_app.tsx
@@ -258,30 +258,11 @@ Fetches a snapshot of all configs. Use in `getServerSideProps`, `getStaticProps`
 const snapshot = await getReplaneSnapshot<AppConfigs>({
   baseUrl: process.env.REPLANE_BASE_URL!,
   sdkKey: process.env.REPLANE_SDK_KEY!,
-  cacheTtlMs: 60_000, // optional, default 60 seconds
+  // by default, getReplaneSnapshot will reuse the created client for 60 seconds for fast subsequent calls, the client will be syncing with the server in the background during this time
+  keepAliveMs: 60_000,
 });
 ```
 
-#### `clearSnapshotCache(): Promise<void>`
-
-Clears the internal client cache. Useful for testing.
-
-```tsx
-await clearSnapshotCache();
-```
-
-## Environment Variables
-
-```env
-# Server-side only (for SSR/SSG)
-REPLANE_BASE_URL=https://api.replane.io
-REPLANE_SDK_KEY=your-sdk-key
-
-# Client-side (for live updates)
-NEXT_PUBLIC_REPLANE_BASE_URL=https://api.replane.io
-NEXT_PUBLIC_REPLANE_SDK_KEY=your-sdk-key
-```
-
 ## Examples
 
 See the [examples](./examples) directory for complete working examples:

packages/next/src/index.tsx

@@ -86,7 +86,6 @@ export {
   createReplaneHook,
   createConfigHook,
   clearSuspenseCache,
-  clearSnapshotCache,
 } from "@replanejs/react";
 
 export type {

packages/react/src/index.ts

@@ -8,5 +8,5 @@ export type {
 } from "./types";
 
 // Re-export snapshot utilities from SDK
-export { getReplaneSnapshot, clearSnapshotCache } from "@replanejs/sdk";
+export { getReplaneSnapshot } from "@replanejs/sdk";
 export type { GetReplaneSnapshotOptions } from "@replanejs/sdk";

packages/sdk/src/index.ts

@@ -1,11 +1,7 @@
 // Re-export public API
 
 // Client functions
-export {
-  createReplaneClient,
-  createInMemoryReplaneClient,
-  restoreReplaneClient,
-} from "./client";
+export { createReplaneClient, createInMemoryReplaneClient, restoreReplaneClient } from "./client";
 
 // Error types
 export { ReplaneError, ReplaneErrorCode } from "./error";
@@ -22,5 +18,5 @@ export type {
 } from "./client-types";
 
 // Snapshot utilities
-export { getReplaneSnapshot, clearSnapshotCache } from "./snapshot";
+export { getReplaneSnapshot } from "./snapshot";
 export type { GetReplaneSnapshotOptions } from "./snapshot";

packages/sdk/src/snapshot.ts

@@ -10,7 +10,7 @@ export interface GetReplaneSnapshotOptions<T extends object> extends ReplaneClie
    * for instant subsequent calls within this duration.
    * @default 60_000 (1 minute)
    */
-  cacheTtlMs?: number;
+  keepAliveMs?: number;
 }
 
 interface CachedClient {
@@ -27,10 +27,10 @@ function getCacheKey<T extends object>(options: ReplaneClientOptions<T>): string
 
 type TimeoutId = ReturnType<typeof setTimeout>;
 
-function setupCleanupTimeout(cacheKey: string, cacheTtlMs: number): TimeoutId {
+function setupCleanupTimeout(cacheKey: string, keepAliveMs: number): TimeoutId {
   return setTimeout(() => {
     clientCache.delete(cacheKey);
-  }, cacheTtlMs);
+  }, keepAliveMs);
 }
 
 /**
@@ -49,15 +49,15 @@ function setupCleanupTimeout(cacheKey: string, cacheTtlMs: number): TimeoutId {
 export async function getReplaneSnapshot<T extends object>(
   options: GetReplaneSnapshotOptions<T>
 ): Promise<ReplaneSnapshot<T>> {
-  const { cacheTtlMs = 60_000, ...clientOptions } = options;
+  const { keepAliveMs = 60_000, ...clientOptions } = options;
 
   const cacheKey = getCacheKey(clientOptions);
   const cached = clientCache.get(cacheKey);
 
   // Return from cache if valid
   if (cached) {
     clearTimeout(cached.timeoutId);
-    cached.timeoutId = setupCleanupTimeout(cacheKey, cacheTtlMs);
+    cached.timeoutId = setupCleanupTimeout(cacheKey, keepAliveMs);
 
     const client = await cached.clientPromise;
     return client.getSnapshot() as ReplaneSnapshot<T>;
@@ -67,7 +67,7 @@ export async function getReplaneSnapshot<T extends object>(
   const clientPromise = createReplaneClient<T>(clientOptions);
   const entry: CachedClient = {
     clientPromise: clientPromise,
-    timeoutId: setupCleanupTimeout(cacheKey, cacheTtlMs),
+    timeoutId: setupCleanupTimeout(cacheKey, keepAliveMs),
   };
   clientCache.set(cacheKey, entry);
 

packages/sdk/tests/snapshot.spec.ts

@@ -157,10 +157,10 @@ describe("getReplaneSnapshot", () => {
     });
 
     it("should expire cache after TTL", async () => {
-      const cacheTtlMs = 100; // Use short TTL for test
+      const keepAliveMs = 100; // Use short TTL for test
 
       // First call
-      const snapshot1Promise = getSnapshot({ cacheTtlMs });
+      const snapshot1Promise = getSnapshot({ keepAliveMs });
       const connection1 = await mockServer.acceptConnection();
       await connection1.push({
         type: "init",
@@ -170,10 +170,10 @@ describe("getReplaneSnapshot", () => {
       await sync();
 
       // Wait for TTL to expire
-      await delay(cacheTtlMs + 50);
+      await delay(keepAliveMs + 50);
 
       // Second call - should create new client since cache expired
-      const snapshot2Promise = getSnapshot({ cacheTtlMs });
+      const snapshot2Promise = getSnapshot({ keepAliveMs });
       const connection2 = await mockServer.acceptConnection();
       await connection2.push({
         type: "init",
@@ -184,7 +184,6 @@ describe("getReplaneSnapshot", () => {
 
       expect(snapshot2.configs[0].value).toBe("value2");
     });
-
   });
 
   describe("clearSnapshotCache", () => {

packages/svelte/src/index.ts

@@ -13,7 +13,6 @@ export {
   createInMemoryReplaneClient,
   restoreReplaneClient,
   getReplaneSnapshot,
-  clearSnapshotCache,
   ReplaneError,
   ReplaneErrorCode,
 } from "@replanejs/sdk";