strapi-cache 1.6.2 → 1.7.0

package/README.md

@@ -91,10 +91,12 @@ All of these routes are protected by the policies `admin::isAuthenticatedAdmin`
 - [x] **Cache Invalidation**: Automatically invalidate cache on content updates, deletions, or creations.
 - [x] **GraphQL Caching**: Cache GraphQL queries.
 - [x] **Purge Cache Button**: Add a UI option in the Strapi admin panel to manually purge the cache for content-types.
-- [ ] **Purge Whole Cache Button**: Add a UI option in the Strapi admin settings panel to purge the whole cache.
+- [x] **Purge Whole Cache Button**: Add a UI option in the Strapi admin settings panel to purge the whole cache.
 - [x] **Route/Content-Type Specific Caching**: Allow users to define which routes should be cached based.
 - [x] **Switchable Cache Providers**: Explore support for other caching providers like Redis for distributed caching.
 
+If you have any feature requests or suggestions, please open a dedicated issue.
+
 ## 🛑 Problems
 
 If you encounter any issues, please feel free to open an issue on the [GitHub repo](https://github.com/TupiC/strapi-cache/issues/new).

package/dist/_chunks/de-C_gFyhHL.mjs

@@ -0,0 +1,18 @@
+const de = {
+  "strapi-cache.name": "Strapi-Cache",
+  "strapi-cache.cache.purge": "Cache leeren",
+  "strapi-cache.cache.purge.entity": "Entity-Cache leeren",
+  "strapi-cache.cache.cancel": "Nein, abbrechen",
+  "strapi-cache.cache.confirm": "Ja, leeren",
+  "strapi-cache.cache.purge.confirmation": "Dies löscht alle Schlüssel, bei denen {key} Teil des Schlüssels ist. Sind Sie sicher, dass Sie den Cache leeren möchten?",
+  "strapi-cache.cache.purge.confirmation-all": "Dies löscht alle Schlüssel aus dem Cache. Sind Sie sicher, dass Sie den gesamten Cache leeren möchten?",
+  "strapi-cache.cache.purge.success": "Cache erfolgreich für {key} geleert",
+  "strapi-cache.cache.purge.error": "Fehler beim Leeren des Caches für {key}",
+  "strapi-cache.cache.purge.no-content-type": "Kein Inhaltstyp gefunden",
+  "strapi-cache.cache.routes.fetch-error": "Cacheable-Routen konnten nicht abgerufen werden. Die Cache-Löschung funktioniert möglicherweise nicht korrekt.",
+  "strapi-cache.settings.description": "Geben Sie unten einen Cache-Schlüssel ein und klicken Sie auf 'Cache leeren', um bestimmte gecachte Inhalte zu löschen.",
+  "strapi-cache.settings.key-placeholder": "Cache-Schlüssel zum Leeren eingeben"
+};
+export {
+  de as default
+};

package/dist/_chunks/de-l6MDDAXu.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const de = {
+  "strapi-cache.name": "Strapi-Cache",
+  "strapi-cache.cache.purge": "Cache leeren",
+  "strapi-cache.cache.purge.entity": "Entity-Cache leeren",
+  "strapi-cache.cache.cancel": "Nein, abbrechen",
+  "strapi-cache.cache.confirm": "Ja, leeren",
+  "strapi-cache.cache.purge.confirmation": "Dies löscht alle Schlüssel, bei denen {key} Teil des Schlüssels ist. Sind Sie sicher, dass Sie den Cache leeren möchten?",
+  "strapi-cache.cache.purge.confirmation-all": "Dies löscht alle Schlüssel aus dem Cache. Sind Sie sicher, dass Sie den gesamten Cache leeren möchten?",
+  "strapi-cache.cache.purge.success": "Cache erfolgreich für {key} geleert",
+  "strapi-cache.cache.purge.error": "Fehler beim Leeren des Caches für {key}",
+  "strapi-cache.cache.purge.no-content-type": "Kein Inhaltstyp gefunden",
+  "strapi-cache.cache.routes.fetch-error": "Cacheable-Routen konnten nicht abgerufen werden. Die Cache-Löschung funktioniert möglicherweise nicht korrekt.",
+  "strapi-cache.settings.description": "Geben Sie unten einen Cache-Schlüssel ein und klicken Sie auf 'Cache leeren', um bestimmte gecachte Inhalte zu löschen.",
+  "strapi-cache.settings.key-placeholder": "Cache-Schlüssel zum Leeren eingeben"
+};
+exports.default = de;

package/dist/_chunks/en-D9w03LyX.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const en = {
+  "strapi-cache.name": "Strapi-Cache",
+  "strapi-cache.cache.purge": "Purge Cache",
+  "strapi-cache.cache.purge.entity": "Purge Entity Cache",
+  "strapi-cache.cache.cancel": "No, cancel",
+  "strapi-cache.cache.confirm": "Yes, purge",
+  "strapi-cache.cache.purge.confirmation": "This purges all keys where {key} is part of the key. Are you sure you want to purge the cache?",
+  "strapi-cache.cache.purge.confirmation-all": "This purges all items in the cache. Are you sure you want to purge the cache?",
+  "strapi-cache.cache.purge.success": "Cache purged successfully for {key}",
+  "strapi-cache.cache.purge.error": "Error purging cache for {key}",
+  "strapi-cache.cache.purge.no-content-type": "No content type found",
+  "strapi-cache.cache.routes.fetch-error": "Unable to fetch cacheable routes. Cache purge may not work correctly.",
+  "strapi-cache.settings.description": "Enter a cache key below and click 'Purge Cache' to clear specific cached content.",
+  "strapi-cache.settings.key-placeholder": "Enter cache key to purge"
+};
+exports.default = en;

package/dist/_chunks/en-bK2OKwtN.mjs

@@ -0,0 +1,18 @@
+const en = {
+  "strapi-cache.name": "Strapi-Cache",
+  "strapi-cache.cache.purge": "Purge Cache",
+  "strapi-cache.cache.purge.entity": "Purge Entity Cache",
+  "strapi-cache.cache.cancel": "No, cancel",
+  "strapi-cache.cache.confirm": "Yes, purge",
+  "strapi-cache.cache.purge.confirmation": "This purges all keys where {key} is part of the key. Are you sure you want to purge the cache?",
+  "strapi-cache.cache.purge.confirmation-all": "This purges all items in the cache. Are you sure you want to purge the cache?",
+  "strapi-cache.cache.purge.success": "Cache purged successfully for {key}",
+  "strapi-cache.cache.purge.error": "Error purging cache for {key}",
+  "strapi-cache.cache.purge.no-content-type": "No content type found",
+  "strapi-cache.cache.routes.fetch-error": "Unable to fetch cacheable routes. Cache purge may not work correctly.",
+  "strapi-cache.settings.description": "Enter a cache key below and click 'Purge Cache' to clear specific cached content.",
+  "strapi-cache.settings.key-placeholder": "Enter cache key to purge"
+};
+export {
+  en as default
+};

package/dist/_chunks/index-BInrGFOe.mjs

@@ -0,0 +1,52 @@
+import { jsxs, jsx } from "react/jsx-runtime";
+import { Typography, TextInput } from "@strapi/design-system";
+import { useIntl } from "react-intl";
+import { P as PurgeModal } from "./index-BwjcxGep.mjs";
+import { useState } from "react";
+const SettingsPage = () => {
+  const { formatMessage } = useIntl();
+  const [keyToUse, setKeyToUse] = useState("");
+  return /* @__PURE__ */ jsxs("div", { style: { padding: "20px" }, children: [
+    /* @__PURE__ */ jsx(Typography, { variant: "alpha", as: "h1", children: formatMessage({
+      id: "strapi-cache.name",
+      defaultMessage: "Strapi Cache Settings"
+    }) }),
+    /* @__PURE__ */ jsx("div", { style: { marginTop: "16px", marginBottom: "16px" }, children: /* @__PURE__ */ jsx(Typography, { variant: "omega", children: formatMessage({
+      id: "strapi-cache.settings.description",
+      defaultMessage: 'Enter a cache key below and click "Purge Cache" to clear specific cached content.'
+    }) }) }),
+    /* @__PURE__ */ jsxs(
+      "div",
+      {
+        style: {
+          display: "flex",
+          justifyContent: "center",
+          alignItems: "center",
+          gap: "12px",
+          maxWidth: "400px",
+          marginBottom: "16px"
+        },
+        children: [
+          /* @__PURE__ */ jsx("div", { style: { flex: 1 }, children: /* @__PURE__ */ jsx(
+            TextInput,
+            {
+              placeholder: formatMessage({
+                id: "strapi-cache.settings.key-placeholder",
+                defaultMessage: "Enter cache key to purge"
+              }),
+              size: "M",
+              type: "text",
+              value: keyToUse,
+              onChange: (e) => setKeyToUse(e.target.value)
+            }
+          ) }),
+          /* @__PURE__ */ jsx(PurgeModal, { buttonText: "Purge Cache", keyToUse, isSettingsPage: true })
+        ]
+      }
+    ),
+    /* @__PURE__ */ jsx(PurgeModal, { buttonText: "Purge All", isPurgeAll: true, isSettingsPage: true })
+  ] });
+};
+export {
+  SettingsPage as default
+};

package/dist/_chunks/index-BjBoZhpS.js

@@ -0,0 +1,52 @@
+"use strict";
+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-Dwrl1jfJ.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: [
+    /* @__PURE__ */ jsxRuntime.jsx(designSystem.Typography, { variant: "alpha", as: "h1", children: formatMessage({
+      id: "strapi-cache.name",
+      defaultMessage: "Strapi Cache Settings"
+    }) }),
+    /* @__PURE__ */ jsxRuntime.jsx("div", { style: { marginTop: "16px", marginBottom: "16px" }, children: /* @__PURE__ */ jsxRuntime.jsx(designSystem.Typography, { variant: "omega", children: formatMessage({
+      id: "strapi-cache.settings.description",
+      defaultMessage: 'Enter a cache key below and click "Purge Cache" to clear specific cached content.'
+    }) }) }),
+    /* @__PURE__ */ jsxRuntime.jsxs(
+      "div",
+      {
+        style: {
+          display: "flex",
+          justifyContent: "center",
+          alignItems: "center",
+          gap: "12px",
+          maxWidth: "400px",
+          marginBottom: "16px"
+        },
+        children: [
+          /* @__PURE__ */ jsxRuntime.jsx("div", { style: { flex: 1 }, children: /* @__PURE__ */ jsxRuntime.jsx(
+            designSystem.TextInput,
+            {
+              placeholder: formatMessage({
+                id: "strapi-cache.settings.key-placeholder",
+                defaultMessage: "Enter cache key to purge"
+              }),
+              size: "M",
+              type: "text",
+              value: keyToUse,
+              onChange: (e) => setKeyToUse(e.target.value)
+            }
+          ) }),
+          /* @__PURE__ */ jsxRuntime.jsx(index.PurgeModal, { buttonText: "Purge Cache", keyToUse, isSettingsPage: true })
+        ]
+      }
+    ),
+    /* @__PURE__ */ jsxRuntime.jsx(index.PurgeModal, { buttonText: "Purge All", isPurgeAll: true, isSettingsPage: true })
+  ] });
+};
+exports.default = SettingsPage;

package/dist/_chunks/index-BwjcxGep.mjs

@@ -0,0 +1,388 @@
+import { useRef, useEffect, useState } from "react";
+import { jsxs, jsx } from "react/jsx-runtime";
+import { useFetchClient, useRBAC, useNotification, unstable_useContentManagerContext } from "@strapi/strapi/admin";
+import { useIntl } from "react-intl";
+import { Archive } from "@strapi/icons";
+import { Modal, Button, Typography } from "@strapi/design-system";
+const __variableDynamicImportRuntimeHelper = (glob, path, segs) => {
+  const v = glob[path];
+  if (v) {
+    return typeof v === "function" ? v() : Promise.resolve(v);
+  }
+  return new Promise((_, reject) => {
+    (typeof queueMicrotask === "function" ? queueMicrotask : setTimeout)(
+      reject.bind(
+        null,
+        new Error(
+          "Unknown variable dynamic import: " + path + (path.split("/").length !== segs ? ". Note that variables only represent file names one level deep." : "")
+        )
+      )
+    );
+  });
+};
+const PLUGIN_ID = "strapi-cache";
+const Initializer = ({ setPlugin }) => {
+  const ref = useRef(setPlugin);
+  useEffect(() => {
+    ref.current(PLUGIN_ID);
+  }, []);
+  return null;
+};
+const useCacheConfig = (enabled = true) => {
+  const [config, setConfig] = useState();
+  const [isLoading, setIsLoading] = useState(false);
+  const [error, setError] = useState(null);
+  const { get } = useFetchClient();
+  useEffect(() => {
+    if (!enabled) {
+      return;
+    }
+    const fetchConfig = async () => {
+      setIsLoading(true);
+      setError(null);
+      try {
+        const { data } = await get("/strapi-cache/config");
+        setConfig(data);
+      } catch (error2) {
+        setError(error2);
+      } finally {
+        setIsLoading(false);
+      }
+    };
+    fetchConfig();
+  }, [enabled, get]);
+  return {
+    config,
+    isLoading,
+    error,
+    refetch: () => {
+      const fetchConfig = async () => {
+        setIsLoading(true);
+        setError(null);
+        try {
+          const { data } = await get("/strapi-cache/config");
+          setConfig(data);
+        } catch (error2) {
+          setError(error2);
+        } finally {
+          setIsLoading(false);
+        }
+      };
+      fetchConfig();
+    }
+  };
+};
+const pluginPermissions = {
+  purge: [{ action: "plugin::strapi-cache.purge-cache", subject: null }]
+};
+const useCachePermissions = () => {
+  const { allowedActions } = useRBAC(pluginPermissions);
+  return {
+    canPurgeCache: allowedActions.canPurgeCache,
+    allowedActions
+  };
+};
+const useCacheOperations = () => {
+  const { post } = useFetchClient();
+  const isCacheableRoute = (keyToUse, contentTypeName, config) => {
+    if (!keyToUse || !config) {
+      return false;
+    }
+    const { cacheableRoutes } = config;
+    return cacheableRoutes.length === 0 || cacheableRoutes.some((route) => {
+      return route.includes(keyToUse) || contentTypeName && route.includes(contentTypeName);
+    });
+  };
+  const clearCache = async (keyToUse) => {
+    if (!keyToUse) {
+      return {
+        success: false,
+        message: "No content type found"
+      };
+    }
+    try {
+      await post(
+        `/strapi-cache/purge-cache/key`,
+        { key: keyToUse },
+        {
+          headers: {
+            "Content-Type": "application/json"
+          }
+        }
+      );
+      return {
+        success: true,
+        message: `Cache purged successfully for key: "${keyToUse}"`
+      };
+    } catch (error) {
+      return {
+        success: false,
+        message: `Error purging cache for key: "${keyToUse}"`,
+        error
+      };
+    }
+  };
+  const clearAllCache = async () => {
+    try {
+      await post(
+        `/strapi-cache/purge-cache`,
+        {},
+        {
+          headers: {
+            "Content-Type": "application/json"
+          }
+        }
+      );
+      return {
+        success: true,
+        message: "All cache purged successfully"
+      };
+    } catch (error) {
+      return {
+        success: false,
+        message: "Error purging all cache",
+        error
+      };
+    }
+  };
+  return {
+    isCacheableRoute,
+    clearCache,
+    clearAllCache
+  };
+};
+const useCacheNotifications = (config) => {
+  const formatMessage = useIntl().formatMessage;
+  const { toggleNotification } = useNotification();
+  const showConfigFetchError = (error) => {
+    const isPermissionError = error?.response?.status === 403 || error?.response?.status === 401;
+    if (!isPermissionError && !config?.disableAdminPopups) {
+      toggleNotification({
+        type: "warning",
+        message: formatMessage({
+          id: "strapi-cache.cache.routes.fetch-error",
+          defaultMessage: "Unable to fetch cache config. Cache purge may not work correctly."
+        })
+      });
+    }
+  };
+  const showPurgeSuccess = (key) => {
+    if (!config?.disableAdminPopups) {
+      toggleNotification({
+        type: "success",
+        message: formatMessage(
+          {
+            id: "strapi-cache.cache.purge.success",
+            defaultMessage: "Cache purged successfully"
+          },
+          {
+            key: `"${key}"`
+          }
+        )
+      });
+    }
+  };
+  const showPurgeError = (key) => {
+    if (!config?.disableAdminPopups) {
+      toggleNotification({
+        type: "danger",
+        message: formatMessage(
+          {
+            id: "strapi-cache.cache.purge.error",
+            defaultMessage: "Error purging cache"
+          },
+          {
+            key: `"${key}"`
+          }
+        )
+      });
+    }
+  };
+  const showNoContentTypeWarning = () => {
+    if (!config?.disableAdminPopups) {
+      toggleNotification({
+        type: "warning",
+        message: formatMessage({
+          id: "strapi-cache.cache.purge.no-content-type",
+          defaultMessage: "No content type found"
+        })
+      });
+    }
+  };
+  return {
+    showConfigFetchError,
+    showPurgeSuccess,
+    showPurgeError,
+    showNoContentTypeWarning
+  };
+};
+function PurgeModal({
+  buttonText,
+  keyToUse,
+  buttonWidth,
+  contentTypeName,
+  isSettingsPage,
+  isPurgeAll
+}) {
+  const { canPurgeCache } = useCachePermissions();
+  const { config, error: configError } = useCacheConfig(canPurgeCache);
+  const { isCacheableRoute, clearCache, clearAllCache } = useCacheOperations();
+  const { showConfigFetchError, showPurgeSuccess, showPurgeError, showNoContentTypeWarning } = useCacheNotifications(config);
+  const formatMessage = useIntl().formatMessage;
+  useEffect(() => {
+    if (configError) {
+      showConfigFetchError(configError);
+    }
+  }, [configError, showConfigFetchError]);
+  const handleClearCache = async () => {
+    if (isPurgeAll) {
+      const result2 = await clearAllCache();
+      if (result2.success) {
+        showPurgeSuccess("all keys");
+      } else {
+        showPurgeError("all keys");
+      }
+      return;
+    }
+    if (!keyToUse) {
+      showNoContentTypeWarning();
+      return;
+    }
+    const result = await clearCache(keyToUse);
+    if (result.success) {
+      showPurgeSuccess(keyToUse);
+    } else {
+      showPurgeError(keyToUse);
+    }
+  };
+  if (!canPurgeCache || !isPurgeAll && !isSettingsPage && !isCacheableRoute(keyToUse, contentTypeName, config)) {
+    return null;
+  }
+  return /* @__PURE__ */ jsxs(Modal.Root, { children: [
+    /* @__PURE__ */ jsx(Modal.Trigger, { children: /* @__PURE__ */ jsx(
+      Button,
+      {
+        width: buttonWidth,
+        disabled: !isPurgeAll && !keyToUse,
+        startIcon: /* @__PURE__ */ jsx(Archive, {}),
+        variant: "danger",
+        children: buttonText
+      }
+    ) }),
+    /* @__PURE__ */ jsxs(Modal.Content, { children: [
+      /* @__PURE__ */ jsx(Modal.Header, { children: /* @__PURE__ */ jsx(Modal.Title, { children: buttonText }) }),
+      /* @__PURE__ */ jsx(Modal.Body, { children: /* @__PURE__ */ jsx(Typography, { variant: "omega", children: isPurgeAll ? formatMessage({
+        id: "strapi-cache.cache.purge.confirmation-all",
+        defaultMessage: "This purges all items in the cache. Are you sure you want to purge the cache?"
+      }) : formatMessage(
+        {
+          id: "strapi-cache.cache.purge.confirmation",
+          defaultMessage: "Are you sure you want to purge the cache?"
+        },
+        { key: `"${keyToUse}"` }
+      ) }) }),
+      /* @__PURE__ */ jsxs(Modal.Footer, { children: [
+        /* @__PURE__ */ jsx(Modal.Close, { children: /* @__PURE__ */ jsx(Button, { variant: "tertiary", children: formatMessage({
+          id: "strapi-cache.cache.cancel",
+          defaultMessage: "No, cancel"
+        }) }) }),
+        /* @__PURE__ */ jsx(Modal.Close, { children: /* @__PURE__ */ jsx(Button, { onClick: handleClearCache, children: formatMessage({
+          id: "strapi-cache.cache.confirm",
+          defaultMessage: "Yes, confirm"
+        }) }) })
+      ] })
+    ] })
+  ] });
+}
+function PurgeCacheButton() {
+  const { contentType } = unstable_useContentManagerContext();
+  const { formatMessage } = useIntl();
+  const keyToUse = contentType?.info.pluralName;
+  return /* @__PURE__ */ jsx(
+    PurgeModal,
+    {
+      buttonText: formatMessage({
+        id: "strapi-cache.cache.purge",
+        defaultMessage: "Purge Cache"
+      }),
+      keyToUse
+    }
+  );
+}
+function PurgeEntityButton() {
+  const { formatMessage } = useIntl();
+  const { id, isSingleType, contentType } = unstable_useContentManagerContext();
+  const apiPath = isSingleType ? contentType?.info.singularName : id;
+  if (!apiPath) {
+    return null;
+  }
+  const keyToUse = encodeURIComponent(apiPath);
+  const contentTypeName = isSingleType ? contentType?.info.singularName : contentType?.info.pluralName;
+  return /* @__PURE__ */ jsx(
+    PurgeModal,
+    {
+      buttonWidth: "100%",
+      buttonText: formatMessage({
+        id: "strapi-cache.cache.purge.entity",
+        defaultMessage: "Purge Entity Cache"
+      }),
+      keyToUse,
+      contentTypeName
+    }
+  );
+}
+const index = {
+  register(app) {
+    app.registerPlugin({
+      id: PLUGIN_ID,
+      initializer: Initializer,
+      isReady: false,
+      name: PLUGIN_ID
+    });
+    app.getPlugin("content-manager").injectComponent("listView", "actions", {
+      name: PurgeCacheButton,
+      Component: PurgeCacheButton
+    });
+    app.getPlugin("content-manager").injectComponent("editView", "right-links", {
+      name: PurgeEntityButton,
+      Component: PurgeEntityButton
+    });
+    app.createSettingSection(
+      {
+        id: PLUGIN_ID,
+        intlLabel: {
+          id: "strapi-cache.settings.link",
+          defaultMessage: "Strapi Cache"
+        }
+      },
+      [
+        {
+          intlLabel: {
+            id: "strapi-cache.settings.link",
+            defaultMessage: "Strapi Cache"
+          },
+          id: "settings",
+          to: `${PLUGIN_ID}/settings`,
+          Component: () => import("./index-BInrGFOe.mjs"),
+          permissions: []
+        }
+      ]
+    );
+  },
+  async registerTrads({ locales }) {
+    return Promise.all(
+      locales.map(async (locale) => {
+        try {
+          const { default: data } = await __variableDynamicImportRuntimeHelper(/* @__PURE__ */ Object.assign({ "./translations/de.json": () => import("./de-C_gFyhHL.mjs"), "./translations/en.json": () => import("./en-bK2OKwtN.mjs") }), `./translations/${locale}.json`, 3);
+          return { data, locale };
+        } catch {
+          return { data: {}, locale };
+        }
+      })
+    );
+  }
+};
+export {
+  PurgeModal as P,
+  index as i
+};