Update README and documentation to reflect Next.js version compatibil…

…ity and default expire age calculation adjustments

.changeset/flat-boxes-build.md

@@ -0,0 +1,5 @@
+---
+'@neshca/cache-handler': minor
+---
+
+Updated the documentation and peer dependencies to explicitly state that only Next.js versions `13.5.x` and `14.x.x` are supported. Modified the default `estimateExpireAge` function to perform the calculation as `(staleAge) => staleAge * 1.5`.

README.md

@@ -27,7 +27,7 @@ Explore the versatility of `@neshca/cache-handler` in our [Examples Section](htt
 
 ## Requirements
 
-- **Next.js**: 13.5.1 or newer.
+- **Next.js**: 13.5.x or 14.x.x.
 - **Node.js**: 18.17.0 or newer.
 
 ## Documentation

docs/cache-handler-docs/src/pages/api-reference/ttl-parameters.mdx

@@ -17,7 +17,7 @@ Stale age is the time after which the cache entry is considered stale, can be se
 
 ### `estimateExpireAge`
 
-Estimates the expiration age based on the stale age.
+Estimates the expiration age based on the stale age. Defaults to `(staleAge) => staleAge * 1.5`.
 
 Expire age is the time after which the cache entry is considered expired and should be removed from the cache and must not be served.
 

docs/cache-handler-docs/src/pages/installation.mdx

@@ -7,7 +7,7 @@ This section guides you through the initial setup and basic usage of `@neshca/ca
 ### Prerequisites
 
 - **Node.js:** Version 18.17 or newer.
-- **Next.js:** Version 13.5.1 or newer.
+- **Next.js:** Version 13.5.x or 14.x.x.
 - **Redis (optional):** Version 4.6.0 or newer.
 
 ### Quick Start Installation
@@ -100,7 +100,7 @@ pnpm create next-app --example cache-handler-redis cache-handler-redis-app
    ```js filename="next.config.js" copy
    const nextConfig = {
      cacheHandler: process.env.NODE_ENV === 'production' ? require.resolve('./cache-handler.mjs') : undefined,
-     // Use `experimental` option instead of the `cacheHandler` property when using Next.js versions from 13.5.1 to 14.0.4
+     // Use `experimental` option instead of the `cacheHandler` property when using Next.js versions from 13.5.x to 14.0.4
      /* experimental: {
            incrementalCacheHandlerPath:
                process.env.NODE_ENV === 'production' ? require.resolve('./cache-handler.mjs') : undefined,

docs/cache-handler-docs/src/pages/usage/development-environment.mdx

@@ -7,7 +7,7 @@ The easiest way to turn off the cache handler in a development environment is to
 ```js filename="next.config.js" copy
 const nextConfig = {
   cacheHandler: process.env.NODE_ENV === 'production' ? require.resolve('./cache-handler.mjs') : undefined,
-  // Use `experimental` option instead of the `cacheHandler` property when using Next.js versions from 13.5.1 to 14.0.4
+  // Use `experimental` option instead of the `cacheHandler` property when using Next.js versions from 13.5.x to 14.0.4
   /* experimental: {
             incrementalCacheHandlerPath:
                 process.env.NODE_ENV === 'production' ? require.resolve('./cache-handler.mjs') : undefined,

packages/cache-handler/README.md

@@ -50,7 +50,7 @@ Explore the versatility of `@neshca/cache-handler` in our [Examples Section](htt
 
 ## Requirements
 
-- **Next.js**: 13.5.1 or newer.
+- **Next.js**: 13.5.x or 14.x.x.
 - **Node.js**: 18.17.0 or newer.
 
 ## Documentation

packages/cache-handler/package.json

@@ -92,7 +92,7 @@
         "typescript": "5.7.2"
     },
     "peerDependencies": {
-        "next": ">= 13.5.1",
+        "next": ">= 13.5.1 < 15",
         "redis": ">= 4.6"
     },
     "distTags": [

packages/cache-handler/src/cache-handler.ts

@@ -168,7 +168,7 @@ export type TTLParameters = {
      * After the stale age, the cache entry is considered stale, can be served from the cache, and should be revalidated.
      * Revalidation is handled by the `CacheHandler` class.
      *
-     * @default (staleAge) => staleAge
+     * @default (staleAge) => staleAge * 1.5
      *
      * @returns The expiration age in seconds.
      *

packages/cache-handler/src/helpers/create-validated-age-estimation-function.ts

@@ -11,7 +11,7 @@ type EstimateExpireAgeFunction = typeof getInitialExpireAge;
  * @returns The initial expire age.
  */
 export function getInitialExpireAge(staleAge: number): number {
-    return staleAge;
+    return staleAge * 1.5;
 }
 
 /**