strapi-cache 1.8.1 → 1.8.2-rc.2

package/README.md

@@ -17,7 +17,7 @@ Boost your API performance with automatic in-memory or Redis caching for REST an
 - ♻️ **LRU (Least Recently Used) caching strategy**
 - 🔧 Simple integration with Strapi config
 - 📦 Lightweight with zero overhead
-- 🗄️ **Supports in-memory and Redis caching**
+- 🗄️ **Supports in-memory, Redis and Valkey caching**
 
 ---
 
@@ -52,9 +52,9 @@ In your Strapi project, navigate to `config/plugins.js` and add the following co
     cacheableRoutes: ['/api/products', '/api/categories'], // Caches routes which start with these paths (if empty array, all '/api' routes are cached)
     // cacheableEntities: ['products', 'categories'], // (Optional) Specify which entities to cache. When set, only these entities will be cached (ignores cacheableRoutes). If not set (undefined), cacheableRoutes logic is used
     excludeRoutes: ['/api/products/private'], // (NEW) Exclude routes which start with these paths from being cached (takes precedence over cacheableRoutes). **Note:** `excludeRoutes` takes precedence over `cacheableRoutes`.
-    provider: 'memory', // Cache provider ('memory' or 'redis')
-    redisConfig: env('REDIS_URL', 'redis://localhost:6379'), // Redis config takes either a string or an object see https://github.com/redis/ioredis for references to what object is available, the object or string is passed directly to ioredis client (if using Redis)
-    redisClusterNodes: [], // If provided any cluster node (this list is not empty), initialize ioredis redis cluster client. Each object must have keys 'host' and 'port'. See https://github.com/redis/ioredis for references
+    provider: 'memory', // Cache provider ('memory', 'redis' or 'valkey')
+    redisConfig: env('REDIS_URL', 'redis://localhost:6379'), // Redis/Valkey config: string or object. See https://github.com/redis/ioredis (Redis) or https://github.com/valkey-io/iovalkey (Valkey)
+    redisClusterNodes: [], // If provided any cluster node (this list is not empty), initialize cluster client. Each object must have keys 'host' and 'port'
     redisClusterOptions: {}, // Options for ioredis redis cluster client. redisOptions key is taken from redisConfig parameter above if not set here. See https://github.com/redis/ioredis for references
     cacheHeaders: true, // Plugin also stores response headers in the cache (set to false if you don't want to cache headers)
     cacheHeadersDenyList: ['access-control-allow-origin', 'content-encoding'], // Headers to exclude from the cache (must be lowercase, if empty array, no headers are excluded, cacheHeaders must be true)
@@ -83,8 +83,8 @@ All of these routes are protected by the policies `admin::isAuthenticatedAdmin`
 
 ## 🗂️ How It Works
 
-- **Storage**: The plugin keeps cached data in memory or Redis, depending on the configuration.
-- **Packages**: Uses [lru-cache](https://github.com/isaacs/node-lru-cache) for in-memory cache. Uses [ioredis](https://github.com/redis/ioredis) for Redis caching.
+- **Storage**: The plugin keeps cached data in memory, Redis or Valkey, depending on the configuration.
+- **Packages**: Uses [lru-cache](https://github.com/isaacs/node-lru-cache) for in-memory cache. Uses [ioredis](https://github.com/redis/ioredis) for Redis and [iovalkey](https://github.com/valkey-io/iovalkey) for Valkey caching.
 - **Automatic Invalidation**: Cache is cleared automatically when content is updated, deleted, or created. (GraphQL cache clears on any content update.)
 - **`no-cache` Header Support**: Respects the `no-cache` header, letting you skip the cache by setting `Cache-Control: no-cache` in your request.
 - **Default Cached Requests**: By default, caches all GET requests to `/api` (or whatever prefix you defined) and POST requests to `/graphql`. You can customize which routes or entities to cache using `cacheableRoutes` or `cacheableEntities` config options.

package/dist/_chunks/{index-B_MAAg0W.js → index-Bdo3ZcJs.js}

@@ -3,12 +3,13 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const jsxRuntime = require("react/jsx-runtime");
 const designSystem = require("@strapi/design-system");
 const reactIntl = require("react-intl");
-const index = require("./index-D_ssKKxu.js");
+const admin = require("@strapi/strapi/admin");
+const index = require("./index-EMYe2zF8.js");
 const react = require("react");
 const SettingsPage = () => {
   const { formatMessage } = reactIntl.useIntl();
   const [keyToUse, setKeyToUse] = react.useState("");
-  return /* @__PURE__ */ jsxRuntime.jsxs("div", { style: { padding: "20px" }, children: [
+  return /* @__PURE__ */ jsxRuntime.jsx(admin.Page.Protect, { permissions: index.pluginPermissions.viewSettings, children: /* @__PURE__ */ jsxRuntime.jsxs("div", { style: { padding: "20px" }, children: [
     /* @__PURE__ */ jsxRuntime.jsx(designSystem.Typography, { variant: "alpha", as: "h1", children: formatMessage({
       id: "strapi-cache.name",
       defaultMessage: "Strapi Cache Settings"
@@ -47,6 +48,6 @@ const SettingsPage = () => {
       }
     ),
     /* @__PURE__ */ jsxRuntime.jsx(index.PurgeModal, { buttonText: "Purge All", isPurgeAll: true, isSettingsPage: true })
-  ] });
+  ] }) });
 };
 exports.default = SettingsPage;

package/dist/_chunks/{index-BwuX8jJl.mjs → index-BovuTRdq.mjs}

@@ -73,12 +73,14 @@ const useCacheConfig = (enabled = true) => {
   };
 };
 const pluginPermissions = {
-  purge: [{ action: "plugin::strapi-cache.purge-cache", subject: null }]
+  purge: [{ action: "plugin::strapi-cache.purge-cache", subject: null }],
+  viewSettings: [{ action: "plugin::strapi-cache.view-settings", subject: null }]
 };
 const useCachePermissions = () => {
   const { allowedActions } = useRBAC(pluginPermissions);
   return {
     canPurgeCache: allowedActions.canPurgeCache,
+    canViewSettings: allowedActions.canViewSettings,
     allowedActions
   };
 };
@@ -371,8 +373,8 @@ const index = {
           },
           id: "settings",
           to: `${PLUGIN_ID}/settings`,
-          Component: () => import("./index-CkLhx2ik.mjs"),
-          permissions: []
+          Component: () => import("./index-DLoQ9I8J.mjs"),
+          permissions: pluginPermissions.viewSettings
         }
       ]
     );
@@ -392,5 +394,6 @@ const index = {
 };
 export {
   PurgeModal as P,
-  index as i
+  index as i,
+  pluginPermissions as p
 };

package/dist/_chunks/{index-CkLhx2ik.mjs → index-DLoQ9I8J.mjs}

@@ -1,12 +1,13 @@
-import { jsxs, jsx } from "react/jsx-runtime";
+import { jsx, jsxs } from "react/jsx-runtime";
 import { Typography, TextInput } from "@strapi/design-system";
 import { useIntl } from "react-intl";
-import { P as PurgeModal } from "./index-BwuX8jJl.mjs";
+import { Page } from "@strapi/strapi/admin";
+import { p as pluginPermissions, P as PurgeModal } from "./index-BovuTRdq.mjs";
 import { useState } from "react";
 const SettingsPage = () => {
   const { formatMessage } = useIntl();
   const [keyToUse, setKeyToUse] = useState("");
-  return /* @__PURE__ */ jsxs("div", { style: { padding: "20px" }, children: [
+  return /* @__PURE__ */ jsx(Page.Protect, { permissions: pluginPermissions.viewSettings, children: /* @__PURE__ */ jsxs("div", { style: { padding: "20px" }, children: [
     /* @__PURE__ */ jsx(Typography, { variant: "alpha", as: "h1", children: formatMessage({
       id: "strapi-cache.name",
       defaultMessage: "Strapi Cache Settings"
@@ -45,7 +46,7 @@ const SettingsPage = () => {
       }
     ),
     /* @__PURE__ */ jsx(PurgeModal, { buttonText: "Purge All", isPurgeAll: true, isSettingsPage: true })
-  ] });
+  ] }) });
 };
 export {
   SettingsPage as default

package/dist/_chunks/{index-D_ssKKxu.js → index-EMYe2zF8.js}

@@ -74,12 +74,14 @@ const useCacheConfig = (enabled = true) => {
   };
 };
 const pluginPermissions = {
-  purge: [{ action: "plugin::strapi-cache.purge-cache", subject: null }]
+  purge: [{ action: "plugin::strapi-cache.purge-cache", subject: null }],
+  viewSettings: [{ action: "plugin::strapi-cache.view-settings", subject: null }]
 };
 const useCachePermissions = () => {
   const { allowedActions } = admin.useRBAC(pluginPermissions);
   return {
     canPurgeCache: allowedActions.canPurgeCache,
+    canViewSettings: allowedActions.canViewSettings,
     allowedActions
   };
 };
@@ -372,8 +374,8 @@ const index = {
           },
           id: "settings",
           to: `${PLUGIN_ID}/settings`,
-          Component: () => Promise.resolve().then(() => require("./index-B_MAAg0W.js")),
-          permissions: []
+          Component: () => Promise.resolve().then(() => require("./index-Bdo3ZcJs.js")),
+          permissions: pluginPermissions.viewSettings
         }
       ]
     );
@@ -393,3 +395,4 @@ const index = {
 };
 exports.PurgeModal = PurgeModal;
 exports.index = index;
+exports.pluginPermissions = pluginPermissions;

package/dist/admin/index.js

@@ -1,3 +1,3 @@
 "use strict";
-const index = require("../_chunks/index-D_ssKKxu.js");
+const index = require("../_chunks/index-EMYe2zF8.js");
 module.exports = index.index;

package/dist/admin/index.mjs

@@ -1,4 +1,4 @@
-import { i } from "../_chunks/index-BwuX8jJl.mjs";
+import { i } from "../_chunks/index-BovuTRdq.mjs";
 export {
   i as default
 };

package/dist/admin/src/hooks/useCachePermissions.d.ts

@@ -1,4 +1,5 @@
 export declare const useCachePermissions: () => {
     canPurgeCache: boolean;
+    canViewSettings: boolean;
     allowedActions: import("@strapi/strapi/admin").AllowedActions;
 };

package/dist/admin/src/permission.d.ts

@@ -3,4 +3,8 @@ export declare const pluginPermissions: {
         action: string;
         subject: null;
     }[];
+    viewSettings: {
+        action: string;
+        subject: null;
+    }[];
 };

package/dist/server/index.js

@@ -5,6 +5,7 @@ const zlib = require("zlib");
 const rawBody = require("raw-body");
 const lruCache = require("lru-cache");
 const ioredis = require("ioredis");
+const iovalkey = require("iovalkey");
 const _interopDefault = (e) => e && e.__esModule ? e : { default: e };
 const Stream__default = /* @__PURE__ */ _interopDefault(Stream);
 const rawBody__default = /* @__PURE__ */ _interopDefault(rawBody);
@@ -91,6 +92,12 @@ const actions = [
     displayName: "Purge Cache",
     uid: "purge-cache",
     pluginName: "strapi-cache"
+  },
+  {
+    section: "plugins",
+    displayName: "View settings",
+    uid: "view-settings",
+    pluginName: "strapi-cache"
   }
 ];
 const bootstrap = ({ strapi: strapi2 }) => {
@@ -567,16 +574,18 @@ const config = {
     if (typeof config2.provider !== "string") {
       throw new Error(`Invalid config: provider must be a string`);
     }
-    if (config2.provider !== "memory" && config2.provider !== "redis") {
-      throw new Error(`Invalid config: provider must be 'memory' or 'redis'`);
+    if (config2.provider !== "memory" && config2.provider !== "redis" && config2.provider !== "valkey") {
+      throw new Error(`Invalid config: provider must be 'memory', 'redis' or 'valkey'`);
     }
-    if (config2.provider === "redis") {
+    if (config2.provider === "redis" || config2.provider === "valkey") {
       if (!config2.redisConfig) {
-        throw new Error(`Invalid config: redisConfig must be set when using redis provider`);
+        throw new Error(
+          `Invalid config: redisConfig must be set when using redis or valkey provider`
+        );
       }
       if (typeof config2.redisConfig !== "string" && typeof config2.redisConfig !== "object") {
         throw new Error(
-          `Invalid config: redisConfig must be a string or object when using redis provider`
+          `Invalid config: redisConfig must be a string or object when using redis or valkey provider`
         );
       }
       if (!Array.isArray(config2.redisClusterNodes) || config2.redisClusterNodes.some((item) => !("host" in item && "port" in item))) {
@@ -705,7 +714,10 @@ const purgeRoute = [
         {
           name: "plugin::content-manager.hasPermissions",
           config: {
-            actions: ["plugin::strapi-cache.purge-cache"]
+            actions: [
+              "plugin::strapi-cache.purge-cache",
+              "plugin::strapi-cache.view-settings"
+            ]
           }
         }
       ]
@@ -840,23 +852,41 @@ class RedisCacheProvider {
       return;
     }
     try {
+      const provider = this.strapi.plugin("strapi-cache").config("provider") || "redis";
       const redisConfig = this.strapi.plugin("strapi-cache").config("redisConfig") || "redis://localhost:6379";
       const redisClusterNodes = this.strapi.plugin("strapi-cache").config("redisClusterNodes");
       this.cacheGetTimeoutInMs = Number(
         this.strapi.plugin("strapi-cache").config("cacheGetTimeoutInMs")
       );
       this.keyPrefix = this.strapi.plugin("strapi-cache").config("redisConfig")?.["keyPrefix"] ?? "";
-      if (redisClusterNodes.length) {
-        const redisClusterOptions = this.strapi.plugin("strapi-cache").config("redisClusterOptions");
-        if (!redisClusterOptions["redisOptions"]) {
-          redisClusterOptions.redisOptions = redisConfig;
+      if (provider === "valkey") {
+        if (redisClusterNodes.length) {
+          const redisClusterOptions = this.strapi.plugin("strapi-cache").config("redisClusterOptions") ?? {};
+          const clusterOptions = { ...redisClusterOptions };
+          if (!clusterOptions["redisOptions"]) {
+            clusterOptions["redisOptions"] = redisConfig;
+          }
+          this.client = new iovalkey.Cluster(
+            redisClusterNodes,
+            clusterOptions
+          );
+        } else {
+          this.client = new iovalkey.Redis(redisConfig);
         }
-        this.client = new ioredis.Redis.Cluster(redisClusterNodes, redisClusterOptions);
+        loggy.info("Valkey provider initialized");
       } else {
-        this.client = new ioredis.Redis(redisConfig);
+        if (redisClusterNodes.length) {
+          const redisClusterOptions = this.strapi.plugin("strapi-cache").config("redisClusterOptions");
+          if (!redisClusterOptions["redisOptions"]) {
+            redisClusterOptions.redisOptions = redisConfig;
+          }
+          this.client = new ioredis.Redis.Cluster(redisClusterNodes, redisClusterOptions);
+        } else {
+          this.client = new ioredis.Redis(redisConfig);
+        }
+        loggy.info("Redis provider initialized");
       }
       this.initialized = true;
-      loggy.info("Redis provider initialized");
     } catch (error) {
       loggy.error(error);
     }
@@ -960,6 +990,7 @@ const resolveCacheProvider = (strapi2) => {
   let instance;
   switch (providerType) {
     case "redis":
+    case "valkey":
       instance = new RedisCacheProvider(strapi2);
       break;
     default:

package/dist/server/index.mjs

@@ -3,7 +3,8 @@ import Stream, { Readable } from "stream";
 import { createInflate, createBrotliDecompress, createGunzip } from "zlib";
 import rawBody from "raw-body";
 import { LRUCache } from "lru-cache";
-import { Redis } from "ioredis";
+import { Redis as Redis$1 } from "ioredis";
+import { Cluster, Redis } from "iovalkey";
 const loggy = {
   info: (msg) => {
     const shouldDebug = strapi.plugin("strapi-cache").config("debug") ?? false;
@@ -87,6 +88,12 @@ const actions = [
     displayName: "Purge Cache",
     uid: "purge-cache",
     pluginName: "strapi-cache"
+  },
+  {
+    section: "plugins",
+    displayName: "View settings",
+    uid: "view-settings",
+    pluginName: "strapi-cache"
   }
 ];
 const bootstrap = ({ strapi: strapi2 }) => {
@@ -563,16 +570,18 @@ const config = {
     if (typeof config2.provider !== "string") {
       throw new Error(`Invalid config: provider must be a string`);
     }
-    if (config2.provider !== "memory" && config2.provider !== "redis") {
-      throw new Error(`Invalid config: provider must be 'memory' or 'redis'`);
+    if (config2.provider !== "memory" && config2.provider !== "redis" && config2.provider !== "valkey") {
+      throw new Error(`Invalid config: provider must be 'memory', 'redis' or 'valkey'`);
     }
-    if (config2.provider === "redis") {
+    if (config2.provider === "redis" || config2.provider === "valkey") {
       if (!config2.redisConfig) {
-        throw new Error(`Invalid config: redisConfig must be set when using redis provider`);
+        throw new Error(
+          `Invalid config: redisConfig must be set when using redis or valkey provider`
+        );
       }
       if (typeof config2.redisConfig !== "string" && typeof config2.redisConfig !== "object") {
         throw new Error(
-          `Invalid config: redisConfig must be a string or object when using redis provider`
+          `Invalid config: redisConfig must be a string or object when using redis or valkey provider`
         );
       }
       if (!Array.isArray(config2.redisClusterNodes) || config2.redisClusterNodes.some((item) => !("host" in item && "port" in item))) {
@@ -701,7 +710,10 @@ const purgeRoute = [
         {
           name: "plugin::content-manager.hasPermissions",
           config: {
-            actions: ["plugin::strapi-cache.purge-cache"]
+            actions: [
+              "plugin::strapi-cache.purge-cache",
+              "plugin::strapi-cache.view-settings"
+            ]
           }
         }
       ]
@@ -836,23 +848,41 @@ class RedisCacheProvider {
       return;
     }
     try {
+      const provider = this.strapi.plugin("strapi-cache").config("provider") || "redis";
       const redisConfig = this.strapi.plugin("strapi-cache").config("redisConfig") || "redis://localhost:6379";
       const redisClusterNodes = this.strapi.plugin("strapi-cache").config("redisClusterNodes");
       this.cacheGetTimeoutInMs = Number(
         this.strapi.plugin("strapi-cache").config("cacheGetTimeoutInMs")
       );
       this.keyPrefix = this.strapi.plugin("strapi-cache").config("redisConfig")?.["keyPrefix"] ?? "";
-      if (redisClusterNodes.length) {
-        const redisClusterOptions = this.strapi.plugin("strapi-cache").config("redisClusterOptions");
-        if (!redisClusterOptions["redisOptions"]) {
-          redisClusterOptions.redisOptions = redisConfig;
+      if (provider === "valkey") {
+        if (redisClusterNodes.length) {
+          const redisClusterOptions = this.strapi.plugin("strapi-cache").config("redisClusterOptions") ?? {};
+          const clusterOptions = { ...redisClusterOptions };
+          if (!clusterOptions["redisOptions"]) {
+            clusterOptions["redisOptions"] = redisConfig;
+          }
+          this.client = new Cluster(
+            redisClusterNodes,
+            clusterOptions
+          );
+        } else {
+          this.client = new Redis(redisConfig);
         }
-        this.client = new Redis.Cluster(redisClusterNodes, redisClusterOptions);
+        loggy.info("Valkey provider initialized");
       } else {
-        this.client = new Redis(redisConfig);
+        if (redisClusterNodes.length) {
+          const redisClusterOptions = this.strapi.plugin("strapi-cache").config("redisClusterOptions");
+          if (!redisClusterOptions["redisOptions"]) {
+            redisClusterOptions.redisOptions = redisConfig;
+          }
+          this.client = new Redis$1.Cluster(redisClusterNodes, redisClusterOptions);
+        } else {
+          this.client = new Redis$1(redisConfig);
+        }
+        loggy.info("Redis provider initialized");
       }
       this.initialized = true;
-      loggy.info("Redis provider initialized");
     } catch (error) {
       loggy.error(error);
     }
@@ -956,6 +986,7 @@ const resolveCacheProvider = (strapi2) => {
   let instance;
   switch (providerType) {
     case "redis":
+    case "valkey":
       instance = new RedisCacheProvider(strapi2);
       break;
     default:

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.8.1",
+  "version": "1.8.2-rc.2",
   "keywords": [
     "strapi cache",
     "strapi rest cache",
@@ -42,6 +42,7 @@
     "@strapi/design-system": "^2.0.1",
     "@strapi/icons": "^2.0.1",
     "ioredis": "^5.6.1",
+    "iovalkey": "^0.3.3",
     "lru-cache": "^11.1.0",
     "raw-body": "^3.0.0",
     "react-intl": "^7.1.10"